Documentation update

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3503 42af7a65-404d-4744-a932-0658087f49c3

ChangeLog

@@ -1689,8 +1689,9 @@
 	  UART2 and UART3.
 	* nuttx/clock.h: Replace all references to the global variable g_system_timer
 	  with clock_systemtimer() (currently just a macro that that returns g_system_timer).
-	* lin/string/strrch.c: Would fail if the searched-for character were the first
+	* lib/string/strrch.c: Would fail if the searched-for character were the first
 	  character in the string.
-
+	* tools/version.sh and mkversion.c: Tools to manage a NuttX version number
+	  file
 
 

Documentation/NuttX.html

@@ -8,7 +8,7 @@
   <tr align="center" bgcolor="#e4e4e4">
     <td>
       <h1><big><font color="#3c34ec"><i>NuttX RTOS</i></font></big></h1>
-      <p>Last Updated: April 13, 2011</p>
+      <p>Last Updated: April 14, 2011</p>
     </td>
   </tr>
 </table>
@@ -2222,8 +2222,10 @@ nuttx-6.2 2011-xx-xx Gregory Nutt &lt;spudmonkey@racsa.co.cr&gt;
       UART2 and UART3.
     * nuttx/clock.h: Replace all references to the global variable g_system_timer
       with clock_systemtimer() (currently just a macro that that returns g_system_timer).
-    * lin/string/strrch.c: Would fail if the searched-for character were the first
+=   * lib/string/strrch.c: Would fail if the searched-for character were the first
       character in the string.
+    * tools/version.sh and mkversion.c: Tools to manage a NuttX version number
+      file
 
 apps-6.1 2011-xx-xx Gregory Nutt &lt;spudmonkey@racsa.co.cr&gt;
 
@@ -2246,6 +2248,7 @@ buildroot-1.10 2011-xx-xx &lt;spudmonkey@racsa.co.cr&gt;
     * toolchain/nxflat/nxflat.mk and Makefile - Fix include paths.
     * toolchain/gcc/3.3.6 - Added a patch to fixed compilation error on Ubuntu
       9.10.
+    * toolchain/nxflat/Makefile - Correct static library link order.
 
 </pre></ul>
 

include/nuttx/rtc.h

+/****************************************************************************
+ * include/nuttx/rtc.h
+ *
+ *   Copyright(C) 2011 Uros Platise. All rights reserved.
+ *   Author: Uros Platise <uros.platise@isotel.eu>
+ *
+ * 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.
+ *
+ ****************************************************************************/
+
+#ifndef __INCLUDE_NUTTX_RTC_H
+#define __INCLUDE_NUTTX_RTC_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+
+#include <sys/types.h>
+
+#include <time.h>
+#include <stdint.h>
+#include <stdbool.h>
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+/* Configuration ************************************************************/
+
+/* Access macros ************************************************************/
+
+/* Clock manipulation macros ************************************************/
+
+/****************************************************************************
+ * Public Types
+ ****************************************************************************/
+
+/* The type of the RTC callback function */
+
+typedef void (*rtc_handler_t)(FAR void *arg);
+
+/* The RTC vtable */
+
+struct rtc_dev_s;
+struct rtc_ops_s
+{
+  int (*trigger)(FAR struct rtc_dev_s *dev, FAR void *arg);
+  int (*add)(FAR struct rtc_dev_s *dev, FAR void *arg, clock_t period);
+  int (*set)(FAR struct rtc_dev_s *dev, FAR void *arg, clock_t period);
+  int (*clear)(FAR struct rtc_dev_s *dev, FAR void *arg);
+  clock_t (*remainder)(FAR struct rtc_dev_s *dev, FAR void *arg);
+  clock_t (*overrun)(FAR struct rtc_dev_s *dev, FAR void *arg);
+  int (*exec)(FAR struct rtc_dev_s *dev, clock_t timeout);
+};
+
+/* RTC private data.  This structure only defines the initial fields of the
+ * structure visible to the SPI client.  The specific implementation may 
+ * add additional, device specific fields
+ */
+
+struct rtc_dev_s
+{
+  FAR const struct rtc_ops_s *ops;
+};
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+#undef EXTERN
+#if defined(__cplusplus)
+#define EXTERN extern "C"
+extern "C" {
+#else
+#define EXTERN extern
+#endif
+
+/****************************************************************************
+ * Name: up_rtcinitialize
+ *
+ * Description:
+ *   Initialize the RTC interface. This function may be called to obtain
+ *   multiple instances of the interface
+ *
+ * Returned Value:
+ *   Valid RTC device structre reference on succcess; a NULL on failure
+ *
+ ****************************************************************************/
+
+EXTERN FAR struct rtc_dev_s *up_rtcinitialize(void);
+
+
+#undef EXTERN
+#if defined(__cplusplus)
+}
+#endif
+#endif /* __INCLUDE_NUTTX_RTC_H */