sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update some comments

Browse Source
This commit is contained in:
Gregory Nutt 2015-11-17 16:24:09 -06:00
parent d4b7f6e7e0
commit 25c4ff8285
2 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
drivers/timers/ds3231.c
View File

@ -220,7 +220,14 @@ static int rtc_bcd2bin(uint8_t value)
*
* Description:
* Initialize the hardware RTC per the selected configuration. This function is
* called once during the OS initialization sequence
* called once during the OS initialization sequence by board-specific logic.
*
* After ds3231_rtc_initialize() is called, the OS function clock_synchronize()
* should also be called to synchronize the system timer to a hardware RTC. That
* operation is normally performed automatically by the system during clock
* initialization. However, when an external RTC is used, the board logic will
* need to explicitly re-synchronize the system timer to the RTC when the RTC
* becomes available.
*
* Input Parameters:
* None

9
include/nuttx/timers/ds3231.h
View File

@ -61,7 +61,14 @@ extern "C"
*
* Description:
* Initialize the hardware RTC per the selected configuration. This function is
* called once during the OS initialization sequence
* called once during the OS initialization sequence by board-specific logic.
*
* After ds3231_rtc_initialize() is called, the OS function clock_synchronize()
* should also be called to synchronize the system timer to a hardware RTC. That
* operation is normally performed automatically by the system during clock
* initialization. However, when an external RTC is used, the board logic will
* need to explicitly re-synchronize the system timer to the RTC when the RTC
* becomes available.
*
* Input Parameters:
* None