diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index 20f6778ca8f..d05eea2396c 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -12,7 +12,7 @@
Last Updated: September 13, 2011
+Last Updated: October 1, 2011
@@ -1989,18 +1989,30 @@ CONFIG_SYSTEM_UTC=y- To enable hardware module use option: + To enable hardware module use the following configuration options:
-
-CONFIG_RTC=y -+
CONFIG_RTC
+ CONFIG_RTC_HIRES
+ 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 timer for purpose of date and time.
+ CONFIG_RTC_FREQUENCY
+ CONFIG_RTC_HIRES is defined, then the frequency of the high resolution RTC must be provided.
+ If CONFIG_RTC_HIRES is not defined, CONFIG_RTC_FREQUENCY is assumed to be one.
+ CONFIG_RTC_ALARM
+ which requires the following three base functions to read time:
up_rtcinitialize()up_rtc_gettime(). UTC time in seconds.up_rtc_getclock(). Replacement for g_system_tickup_rtc_time(). UTC time in seconds.up_rtc_gettime(). Replacement for g_system_tick
This module depends on CONFIG_SYSTEM_UTC=y.
@@ -2024,15 +2036,17 @@ CONFIG_RTC=y
Running at rate of system base timer, used for time-slicing, and so forth.
- If hardware RTC is present (CONFIG_RTC) and enabled, then after successful
- initiliazation variables are overriden by calls to up_rtc_getclock() which is
+ If hardware RTC is present (CONFIG_RTC) and and high-resolution timeing
+ is enabled (CONFIG_RTC_HIRES), then after successful
+ initiliazation variables are overriden by calls to up_rtc_gettime() which is
running continously even in power-down modes.
- In the case of CONFIG_RTC is set the g_tickcount and g_system_utc keep
- counting at rate of a system timer, which however, is disabled in power-down
- mode. By comparing this time and RTC (actual time) one may determine the
- actual system active time. To retrieve that variable use:
+ In the case of CONFIG_RTC_HIRES is set the g_tickcount and
+ g_system_utc keep counting at rate of a system timer, which however, is
+ disabled in power-down mode.
+ By comparing this time and RTC (actual time) one may determine the actual system active time.
+ To retrieve that variable use:
clock_gettime(CLOCK_ACTIVETIME, tp)
@@ -4239,10 +4253,35 @@ build
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.
+ If CONFIG_RTC_HIRES 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.
+ CONFIG_RTC_FREQUENCY:
+ If CONFIG_RTC_HIRES is defined, then the frequency of the high resolution RTC must be provided.
+ If CONFIG_RTC_HIRES is not defined, CONFIG_RTC_FREQUENCY is assumed to be one.
+ CONFIG_RTC_ALARM:
+ Enable if the RTC hardware supports setting of an alarm.
+ A callback function will be executed when the alarm goes off
+ CONFIG_SPI_OWNBUS - Set if there is only one active device
+ CONFIG_SPI_OWNBUS: Set if there is only one active device
on the SPI bus. No locking or SPI configuration will be performed.
It is not necessary for clients to lock, re-configure, etc..