mirror of
https://github.com/apache/nuttx.git
synced 2026-05-20 04:16:35 +08:00
Re-arrange some files and interfaces to support the STM32 F4 date/time RTC
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4175 42af7a65-404d-4744-a932-0658087f49c3
This commit is contained in:
patacongo
@@ -2263,3 +2263,6 @@
|
||||
STM3240G-EVAL board.
|
||||
* configs/stm3240g-eval/nettest: Add a network test configuration for the
|
||||
STM3240G-EVAL board.
|
||||
* arch/arm/srcm/stm32/stm32_rtc.c, stm32f10xxx_rtc.c, and stm32f40xxx_rtc:
|
||||
Broke out separate drivers to handle the very different RTC implementations
|
||||
in the STM32 F1 and F4 family.
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
<h1><big><font color="#3c34ec">
|
||||
<i>NuttX RTOS Porting Guide</i>
|
||||
</font></big></h1>
|
||||
<p>Last Updated: December 1, 2011</p>
|
||||
<p>Last Updated: December 14, 2011</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -1971,8 +1971,16 @@ else
|
||||
<dt><code>CONFIG_RTC</code>
|
||||
<dd>Enables general support for a hardware RTC.
|
||||
Specific architectures may require other specific settings.
|
||||
<dt><code>CONFIG_RTC_DATETIME</code>
|
||||
<dd>There are two general types of RTC: (1) A simple battery backed counter that keeps the time when power
|
||||
is down, and (2) A full date / time RTC the provides the date and time information, often in BCD format.
|
||||
If <code>CONFIG_RTC_DATETIME</code> is selected, it specifies this second kind of RTC.
|
||||
In this case, the RTC is used to "seed"" the normal NuttX timer and the NuttX system timer
|
||||
provides for higher resoution time.
|
||||
<dt><code>CONFIG_RTC_HIRES</code>
|
||||
<dd>The typical RTC keeps time to resolution of 1 second, usually supporting a 32-bit <code>time_t</code> value.
|
||||
<dd>If <code>CONFIG_RTC_DATETIME</code> not selected, then the simple, battery backed counter is used.
|
||||
There are two different implementations of such simple counters based on the time resolution of the counter:
|
||||
The typical RTC keeps time to resolution of 1 second, usually supporting a 32-bit <code>time_t</code> value.
|
||||
In this case, the RTC is used to "seed" the normal NuttX timer and the NuttX timer provides for higher resoution time.
|
||||
If <code>CONFIG_RTC_HIRES</code> is enabled in the NuttX configuration, then the RTC provides higher resolution time and completely replaces the system timer for purpose of date and time.
|
||||
<dt><code>CONFIG_RTC_FREQUENCY</code>
|
||||
@@ -1983,12 +1991,31 @@ else
|
||||
A callback function will be executed when the alarm goes off
|
||||
</dl></ul>
|
||||
<p>
|
||||
which requires the following three base functions to read time:
|
||||
which requires the following base functions to read and set time:
|
||||
</p>
|
||||
<ul>
|
||||
<li><code>up_rtcinitialize()</code></li>
|
||||
<li><code>up_rtc_time()</code>. UTC time in seconds.</li>
|
||||
<li><code>up_rtc_gettime()</code>. Replacement for <code>g_system_tick</code></li>
|
||||
<li><code>up_rtcinitialize()</code>.
|
||||
Initialize the hardware RTC per the selected configuration.
|
||||
This function is called once during the OS initialization sequence
|
||||
</li>
|
||||
<li><code>up_rtc_time()</code>.
|
||||
Get the current time in seconds. This is similar to the standard <code>time()</code> function.
|
||||
This interface is only required if the low-resolution RTC/counter hardware implementation selected.
|
||||
It is only used by the RTOS during intialization to set up the system time when <code>CONFIG_RTC</code> is set
|
||||
but neither <code>CONFIG_RTC_HIRES</code> nor <code>CONFIG_RTC_DATETIME</code> are set.
|
||||
</li>
|
||||
<li><code>up_rtc_gettime()</code>.
|
||||
Get the current time from the high resolution RTC clock/counter.
|
||||
This interface is only supported by the hight-resolution RTC/counter hardware implementation.
|
||||
It is used to replace the system timer (<code>g_system_tick</code>).
|
||||
</li>
|
||||
<li><code>up_rtc_settime()</code>.
|
||||
Set the RTC to the provided time.
|
||||
All RTC implementations must be able to set their time based on a standard timespec.
|
||||
</li>
|
||||
<li><code>up_rtc_setalarm()</code>.
|
||||
Set up an alarm.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>4.1.20.2 System Tick and Time</h4>
|
||||
@@ -4229,8 +4256,18 @@ build
|
||||
Enables general support for a hardware RTC.
|
||||
Specific architectures may require other specific settings.
|
||||
</li>
|
||||
<li>
|
||||
<code>CONFIG_RTC_DATETIME</code>:
|
||||
There are two general types of RTC: (1) A simple battery backed counter that keeps the time when power
|
||||
is down, and (2) A full date / time RTC the provides the date and time information, often in BCD format.
|
||||
If <code>CONFIG_RTC_DATETIME</code> is selected, it specifies this second kind of RTC.
|
||||
In this case, the RTC is used to "seed"" the normal NuttX timer and the NuttX system timer
|
||||
provides for higher resoution time.
|
||||
</li>
|
||||
<li>
|
||||
<code>CONFIG_RTC_HIRES</code>:
|
||||
If <code>CONFIG_RTC_DATETIME</code> not selected, then the simple, battery backed counter is used.
|
||||
There are two different implementations of such simple counters based on the time resolution of the counter:
|
||||
The typical RTC keeps time to resolution of 1 second, usually supporting a 32-bit <code>time_t</code> value.
|
||||
In this case, the RTC is used to "seed" the normal NuttX timer and the NuttX timer provides for higher resoution time.
|
||||
If <code>CONFIG_RTC_HIRES</code> is enabled in the NuttX configuration, then the RTC provides higher resolution time and completely replaces the system timer for purpose of date and time.
|
||||
|
||||
+30
-590
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,249 @@
|
||||
/************************************************************************************
|
||||
* arch/arm/src/stm32/stm32f40xxx_rtc.c
|
||||
*
|
||||
* Copyright (C) 2011 Gregory Nutt. All rights reserved.
|
||||
* Author: Gregory Nutt <gnutt@nuttx.org>
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
* 2. Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in
|
||||
* the documentation and/or other materials provided with the
|
||||
* distribution.
|
||||
* 3. Neither the name NuttX nor the names of its contributors may be
|
||||
* used to endorse or promote products derived from this software
|
||||
* without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
||||
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
||||
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||||
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||||
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
||||
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
||||
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
||||
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
* POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
************************************************************************************/
|
||||
|
||||
/************************************************************************************
|
||||
* Included Files
|
||||
************************************************************************************/
|
||||
|
||||
#include <nuttx/config.h>
|
||||
|
||||
#include <nuttx/arch.h>
|
||||
#include <nuttx/irq.h>
|
||||
#include <nuttx/rtc.h>
|
||||
|
||||
#include <arch/board/board.h>
|
||||
|
||||
#include "up_arch.h"
|
||||
|
||||
#include "stm32_rtc.h"
|
||||
|
||||
#ifdef CONFIG_RTC
|
||||
|
||||
/************************************************************************************
|
||||
* Pre-processor Definitions
|
||||
************************************************************************************/
|
||||
/* Configuration ********************************************************************/
|
||||
/* This RTC implementation supports only date/time RTC hardware */
|
||||
|
||||
#ifndef CONFIG_RTC_DATETIME
|
||||
# error "CONFIG_RTC_DATETIME must be set to use this driver"
|
||||
#endif
|
||||
|
||||
#ifndef CONFIG_RTC_HIRES
|
||||
# error "CONFIG_RTC_HIRES must NOT be set with this driver"
|
||||
#endif
|
||||
|
||||
/************************************************************************************
|
||||
* Private Types
|
||||
************************************************************************************/
|
||||
|
||||
/************************************************************************************
|
||||
* Private Data
|
||||
************************************************************************************/
|
||||
|
||||
/* Callback to use when the alarm expires */
|
||||
|
||||
#ifdef CONFIG_RTC_ALARM
|
||||
static alarmcb_t g_alarmcb;
|
||||
#endif
|
||||
|
||||
/************************************************************************************
|
||||
* Public Data
|
||||
************************************************************************************/
|
||||
|
||||
/* g_rtc_enabled is set true after the RTC has successfully initialized */
|
||||
|
||||
volatile bool g_rtc_enabled = false;
|
||||
|
||||
/************************************************************************************
|
||||
* Private Functions
|
||||
************************************************************************************/
|
||||
|
||||
/************************************************************************************
|
||||
* Name: stm32_rtc_interrupt
|
||||
*
|
||||
* Description:
|
||||
* RTC interrupt service routine
|
||||
*
|
||||
* Input Parameters:
|
||||
* irq - The IRQ number that generated the interrupt
|
||||
* context - Architecture specific register save information.
|
||||
*
|
||||
* Returned Value:
|
||||
* Zero (OK) on success; A negated errno value on failure.
|
||||
*
|
||||
************************************************************************************/
|
||||
|
||||
#if CONFIG_RTC_ALARM
|
||||
static int stm32_rtc_interrupt(int irq, void *context)
|
||||
{
|
||||
#warning "Missing logic"
|
||||
return OK;
|
||||
}
|
||||
#endif
|
||||
|
||||
/************************************************************************************
|
||||
* Public Functions
|
||||
************************************************************************************/
|
||||
|
||||
/************************************************************************************
|
||||
* Name: up_rtcinitialize
|
||||
*
|
||||
* Description:
|
||||
* Initialize the hardware RTC per the selected configuration. This function is
|
||||
* called once during the OS initialization sequence
|
||||
*
|
||||
* Input Parameters:
|
||||
* None
|
||||
*
|
||||
* Returned Value:
|
||||
* Zero (OK) on success; a negated errno on failure
|
||||
*
|
||||
************************************************************************************/
|
||||
|
||||
int up_rtcinitialize(void)
|
||||
{
|
||||
/* Initialize the RTC */
|
||||
#warning "Missing logic"
|
||||
|
||||
/* Configure RTC interrupt to catch alarm interrupts. */
|
||||
|
||||
#ifdef CONFIG_RTC_ALARM
|
||||
irq_attach(STM32_IRQ_RTC, stm32_rtc_interrupt);
|
||||
up_enable_irq(STM32_IRQ_RTC);
|
||||
#endif
|
||||
|
||||
g_rtc_enabled = true;
|
||||
return OK;
|
||||
}
|
||||
|
||||
/************************************************************************************
|
||||
* Name: up_rtc_getdatetime
|
||||
*
|
||||
* Description:
|
||||
* Get the current date and time from the date/time RTC. This interface
|
||||
* is only supported by the date/time RTC hardware implementation.
|
||||
* It is used to replace the system timer. It is only used by the RTOS during
|
||||
* intialization to set up the system time when CONFIG_RTC and CONFIG_RTC_DATETIME
|
||||
* are selected (and CONFIG_RTC_HIRES is not).
|
||||
*
|
||||
* NOTE: Some date/time RTC hardware is capability of sub-second accuracy. That
|
||||
* sub-second accuracy is lost in this interface. However, since the system time
|
||||
* is reinitialized on each power-up/reset, there will be no timing inaccuracy in
|
||||
* the long run.
|
||||
*
|
||||
* Input Parameters:
|
||||
* tp - The location to return the high resolution time value.
|
||||
*
|
||||
* Returned Value:
|
||||
* Zero (OK) on success; a negated errno on failure
|
||||
*
|
||||
************************************************************************************/
|
||||
|
||||
int up_rtc_getdatetime(FAR const struct tm *tp)
|
||||
{
|
||||
#warning "Missing logic"
|
||||
return OK;
|
||||
}
|
||||
|
||||
/************************************************************************************
|
||||
* Name: up_rtc_settime
|
||||
*
|
||||
* Description:
|
||||
* Set the RTC to the provided time. All RTC implementations must be able to
|
||||
* set their time based on a standard timespec.
|
||||
*
|
||||
* Input Parameters:
|
||||
* tp - the time to use
|
||||
*
|
||||
* Returned Value:
|
||||
* Zero (OK) on success; a negated errno on failure
|
||||
*
|
||||
************************************************************************************/
|
||||
|
||||
int up_rtc_settime(FAR const struct timespec *tp)
|
||||
{
|
||||
/* Break out the time values */
|
||||
#warning "Missing logic"
|
||||
|
||||
/* Then write the broken out values to the RTC */
|
||||
#warning "Missing logic"
|
||||
|
||||
return OK;
|
||||
}
|
||||
|
||||
/************************************************************************************
|
||||
* Name: up_rtc_setalarm
|
||||
*
|
||||
* Description:
|
||||
* Set up an alarm.
|
||||
*
|
||||
* Input Parameters:
|
||||
* tp - the time to set the alarm
|
||||
* callback - the function to call when the alarm expires.
|
||||
*
|
||||
* Returned Value:
|
||||
* Zero (OK) on success; a negated errno on failure
|
||||
*
|
||||
************************************************************************************/
|
||||
|
||||
#ifdef CONFIG_RTC_ALARM
|
||||
int up_rtc_setalarm(FAR const struct timespec *tp, alarmcb_t callback);
|
||||
{
|
||||
irqstate_t flags;
|
||||
int ret = -EBUSY;
|
||||
|
||||
/* Is there already something waiting on the ALARM? */
|
||||
|
||||
if (g_alarmcb == NULL)
|
||||
{
|
||||
/* No.. Save the callback function pointer */
|
||||
|
||||
g_alarmcb = callback;
|
||||
|
||||
/* Break out the time values */
|
||||
#warning "Missing logic"
|
||||
|
||||
/* The set the alarm */
|
||||
#warning "Missing logic"
|
||||
|
||||
ret = OK;
|
||||
}
|
||||
return ret;
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* CONFIG_RTC */
|
||||
|
||||
+58
-9
@@ -58,10 +58,21 @@
|
||||
/* CONFIG_RTC - Enables general support for a hardware RTC. Specific
|
||||
* architectures may require other specific settings.
|
||||
*
|
||||
* CONFIG_RTC_HIRES - The typical RTC keeps time to resolution of 1 second,
|
||||
* usually supporting a 32-bit time_t value. In this case, the RTC is
|
||||
* used to "seed" the normal NuttX timer and the NuttX timer provides
|
||||
* for higher resoution time.
|
||||
* CONFIG_RTC_DATETIME - There are two general types of RTC: (1) A simple
|
||||
* battery backed counter that keeps the time when power is down, and (2)
|
||||
* A full date / time RTC the provides the date and time information, often
|
||||
* in BCD format. If CONFIG_RTC_DATETIME is selected, it specifies this
|
||||
* second kind of RTC. In this case, the RTC is used to "seed" the normal
|
||||
* NuttX timer and the NuttX system timer provides for higher resoution
|
||||
* time.
|
||||
*
|
||||
* CONFIG_RTC_HIRES - If CONFIG_RTC_DATETIME not selected, then the simple,
|
||||
* battery backed counter is used. There are two different implementations
|
||||
* of such simple counters based on the time resolution of the counter:
|
||||
* The typical RTC keeps time to resolution of 1 second, usually
|
||||
* supporting a 32-bit time_t value. In this case, the RTC is used to
|
||||
* "seed" the normal NuttX timer and the NuttX timer provides for higher
|
||||
* resoution time.
|
||||
*
|
||||
* If CONFIG_RTC_HIRES is enabled in the NuttX configuration, then the
|
||||
* RTC provides higher resolution time and completely replaces the system
|
||||
@@ -76,6 +87,9 @@
|
||||
*/
|
||||
|
||||
#ifdef CONFIG_RTC_HIRES
|
||||
# ifdef CONFIG_RTC_DATETIME
|
||||
# error "CONFIG_RTC_HIRES and CONFIG_RTC_DATETIME are both defined"
|
||||
# endif
|
||||
# ifndef CONFIG_RTC_FREQUENCY
|
||||
# error "CONFIG_RTC_FREQUENCY is required for CONFIG_RTC_HIRES"
|
||||
# endif
|
||||
@@ -124,7 +138,7 @@ extern "C" {
|
||||
* Name: up_rtcinitialize
|
||||
*
|
||||
* Description:
|
||||
* Initialize the hardware RTC per the select configuration. This function is
|
||||
* Initialize the hardware RTC per the selected configuration. This function is
|
||||
* called once during the OS initialization sequence
|
||||
*
|
||||
* Input Parameters:
|
||||
@@ -142,7 +156,10 @@ EXTERN int up_rtcinitialize(void);
|
||||
*
|
||||
* Description:
|
||||
* Get the current time in seconds. This is similar to the standard time()
|
||||
* function.
|
||||
* function. This interface is only required if the low-resolution RTC/counter
|
||||
* hardware implementation selected. It is only used by the RTOS during
|
||||
* intialization to set up the system time when CONFIG_RTC is set but neither
|
||||
* CONFIG_RTC_HIRES nor CONFIG_RTC_DATETIME are set.
|
||||
*
|
||||
* Input Parameters:
|
||||
* None
|
||||
@@ -152,13 +169,17 @@ EXTERN int up_rtcinitialize(void);
|
||||
*
|
||||
************************************************************************************/
|
||||
|
||||
#ifndef CONFIG_RTC_HIRES
|
||||
EXTERN time_t up_rtc_time(void);
|
||||
#endif
|
||||
|
||||
/************************************************************************************
|
||||
* Name: up_rtc_gettime
|
||||
*
|
||||
* Description:
|
||||
* Get the current time from the high resolution RTC clock.
|
||||
* Get the current time from the high resolution RTC clock/counter. This interface
|
||||
* is only supported by the high-resolution RTC/counter hardware implementation.
|
||||
* It is used to replace the system timer.
|
||||
*
|
||||
* Input Parameters:
|
||||
* tp - The location to return the high resolution time value.
|
||||
@@ -172,11 +193,39 @@ EXTERN time_t up_rtc_time(void);
|
||||
EXTERN int up_rtc_gettime(FAR struct timespec *tp);
|
||||
#endif
|
||||
|
||||
/************************************************************************************
|
||||
* Name: up_rtc_getdatetime
|
||||
*
|
||||
* Description:
|
||||
* Get the current date and time from the date/time RTC. This interface
|
||||
* is only supported by the date/time RTC hardware implementation.
|
||||
* It is used to replace the system timer. It is only used by the RTOS during
|
||||
* intialization to set up the system time when CONFIG_RTC and CONFIG_RTC_DATETIME
|
||||
* are selected (and CONFIG_RTC_HIRES is not).
|
||||
*
|
||||
* NOTE: Some date/time RTC hardware is capability of sub-second accuracy. That
|
||||
* sub-second accuracy is lost in this interface. However, since the system time
|
||||
* is reinitialized on each power-up/reset, there will be no timing inaccuracy in
|
||||
* the long run.
|
||||
*
|
||||
* Input Parameters:
|
||||
* tp - The location to return the high resolution time value.
|
||||
*
|
||||
* Returned Value:
|
||||
* Zero (OK) on success; a negated errno on failure
|
||||
*
|
||||
************************************************************************************/
|
||||
|
||||
#ifdef CONFIG_RTC_DATETIME
|
||||
EXTERN int up_rtc_getdatetime(FAR const struct tm *tp);
|
||||
#endif
|
||||
|
||||
/************************************************************************************
|
||||
* Name: up_rtc_settime
|
||||
*
|
||||
* Description:
|
||||
* Set the RTC to the provided time.
|
||||
* Set the RTC to the provided time. All RTC implementations must be able to
|
||||
* set their time based on a standard timespec.
|
||||
*
|
||||
* Input Parameters:
|
||||
* tp - the time to use
|
||||
@@ -192,7 +241,7 @@ EXTERN int up_rtc_settime(FAR const struct timespec *tp);
|
||||
* Name: up_rtc_setalarm
|
||||
*
|
||||
* Description:
|
||||
* Set up a alarm.
|
||||
* Set up an alarm.
|
||||
*
|
||||
* Input Parameters:
|
||||
* tp - the time to set the alarm
|
||||
|
||||
@@ -103,7 +103,26 @@ struct timespec g_basetime;
|
||||
****************************************************************************/
|
||||
|
||||
#ifdef CONFIG_RTC
|
||||
#ifdef CONFIG_RTC_HIRES
|
||||
#if defined(CONFIG_RTC_DATETIME)
|
||||
/* Initialize the system time using a broken out date/time structure */
|
||||
|
||||
static inline void clock_inittime(FAR struct timespec *tp)
|
||||
{
|
||||
struct tm rtctime;
|
||||
|
||||
/* Get the broken-out time from the date/time RTC. */
|
||||
|
||||
(void)up_rtc_getdatetime(&rtctime);
|
||||
|
||||
/* And use the broken-out time to initialize the system time */
|
||||
|
||||
tp->tv_sec = mktime(&rtctime);
|
||||
tp->tv_nsec = 0;
|
||||
}
|
||||
|
||||
#elif defined(CONFIG_RTC_HIRES)
|
||||
|
||||
/* Initialize the system time using a high-resolution structure */
|
||||
|
||||
static inline void clock_inittime(FAR struct timespec *tp)
|
||||
{
|
||||
@@ -114,9 +133,11 @@ static inline void clock_inittime(FAR struct timespec *tp)
|
||||
|
||||
#else
|
||||
|
||||
/* Initialize the system time using seconds only */
|
||||
|
||||
static inline void clock_inittime(FAR struct timespec *tp)
|
||||
{
|
||||
/* Get the seconds (only) from the lo-res RTC */
|
||||
/* Get the seconds (only) from the lo-resolution RTC */
|
||||
|
||||
tp->tv_sec = up_rtc_time();
|
||||
tp->tv_nsec = 0;
|
||||
|
||||
Reference in New Issue
Block a user