From 5648c55d5319fb32b9cc1dfe1f104392b36ff453 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Sun, 15 Feb 2015 10:31:11 -0600 Subject: [PATCH] Add some trivial documentation for the RTC driver --- Documentation/NuttxPortingGuide.html | 74 +++++++++++++++++++++++++--- 1 file changed, 67 insertions(+), 7 deletions(-) diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index ddd2086bf0..762d12b6bd 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -12,7 +12,7 @@

NuttX RTOS Porting Guide

-

Last Updated: November 15, 2014

+

Last Updated: February 15, 2014

@@ -190,8 +190,10 @@ 6.3.12 PWM Drivers
6.3.13 CAN Drivers
6.3.14 Quadrature Encoder Drivers
- 6.3.15 Watchdog Timer Drivers
- 6.3.16 Keyboard/Keypad Drivers
+ 6.3.15 Timer Drivers
+ 6.3.16 RTC Drivers
+ 6.3.17 Watchdog Timer Drivers
+ 6.3.18 Keyboard/Keypad Drivers
6.4 Power Management -

6.3.15 Watchdog Timer Drivers

+

6.3.15 Timer Drivers

+

+ NuttX supports a low-level, two-part timer driver. +

+
    +
  1. + An "upper half", generic driver that provides the common timer interface to application level code, and +
    2. +
  2. + A "lower half", platform-specific driver that implements the low-level timer controls to implement the timer functionality. +
    3. +
+

+ Files supporting the timer driver can be found in the following locations: +

+ + +

6.3.16 RTC Drivers

+

+ NuttX supports a low-level, two-part RealTime Clock (RTC) driver. +

+
    +
  1. + An "upper half", generic driver that provides the common RTC interface to application level code, and +
    2. +
  2. + A "lower half", platform-specific driver that implements the low-level timer controls to implement the RTC functionality. +
    3. +
+

+ Files supporting the RTC driver can be found in the following locations: +

+ + +

6.3.17 Watchdog Timer Drivers

NuttX supports a low-level, two-part watchdog timer driver.

@@ -5197,7 +5257,7 @@ void board_led_off(int led);

- Files supporting the watchdog timer can be found in the following locations: + Files supporting the watchdog timer driver can be found in the following locations:

-

6.3.16 Keyboard/Keypad Drivers

+

6.3.18 Keyboard/Keypad Drivers

Keypads vs. Keyboards Keyboards and keypads are really the same devices for NuttX.