diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index dee837cd7b..77d274b65f 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -867,7 +867,7 @@ below and discussed in the following paragraphs:

diff --git a/Documentation/NuttxUserGuide.html b/Documentation/NuttxUserGuide.html index 134a46dbcd..09bad280c8 100644 --- a/Documentation/NuttxUserGuide.html +++ b/Documentation/NuttxUserGuide.html @@ -21,7 +21,7 @@ User's Manual

Gregory Nutt

-Last Update: January 28, 2007 +Last Update: March 21, 2007

1.0 Introduction

@@ -37,7 +37,7 @@ perspective of the firmware developer. This section is divided into several paragraphs that describe different groups of OS interfaces:

2.6.1 wd_create

@@ -2017,6 +2018,30 @@ VxWorks provides the following comparable interface: STATUS wdCancel (WDOG_ID wdog); +

2.6.5 wd_gettime

+

+ Function Prototype: +

+
+    #include <wdog.h>
+    Sint wd_gettime(WDOG_ID wdog);
+
+

+ Description: + This function returns the time remaining before the the specified watchdog expires. +

+

+ Input Parameters: +

+

+

+ Returned Value: + The time in system ticks remaining until the watchdog time expires. Zero + means either that wdog is not valid or that the wdog has already expired. +

+

2.7 Clocks and Timers

@@ -2217,7 +2242,8 @@ VxWorks provides the following comparable interface: Input Parameters:

+

+ POSIX Compatibility: + Comparable to the POSIX interface of the same name. Differences from the full POSIX implementation include: +

+

2.7.8 timer_delete

@@ -2275,6 +2308,10 @@ VxWorks provides the following comparable interface:

+

+ POSIX Compatibility: + Comparable to the POSIX interface of the same name. +

2.7.9 timer_settime

@@ -2326,6 +2363,8 @@ VxWorks provides the following comparable interface: amount of time before the timer would have expired, or zero if the timer was disarmed, together with the previous timer reload value. Timers will not expire before their scheduled time. +

+ NOTE:At present, the ovalue argument is ignored.

Input Parameters: @@ -2334,7 +2373,7 @@ VxWorks provides the following comparable interface:

  • timerid. The pre-thread timer, previously created by the call to timer_create(), to be be set.
  • flags. Specifie characteristics of the timer (see above)
  • value. Specifies the timer value to set
  • -
  • ovalue. A location in which to return the time remaining from the previous timer setting.
  • +
  • ovalue. A location in which to return the time remaining from the previous timer setting (ignored).
  • Returned Values: @@ -2348,6 +2387,13 @@ VxWorks provides the following comparable interface:

  • EINVAL. A value structure specified a nanosecond value less than zero or greater than or equal to 1000 million, and the it_value member of that structure did not specify zero seconds and nanoseconds.
  • +

    + POSIX Compatibility: + Comparable to the POSIX interface of the same name. Differences from the full POSIX implementation include: +

    +

    2.7.10 timer_gettime

    @@ -2367,6 +2413,11 @@ VxWorks provides the following comparable interface: even if the timer was armed with absolute time. The it_interval member of value will contain the reload value last set by timer_settime().

    +

    + Due to the asynchronous operation of this function, the time reported + by this function could be significantly more than that actual time + remaining on the timer at any time. +

    Input Parameters:

    @@ -2386,6 +2437,10 @@ VxWorks provides the following comparable interface: The timerid argument does not correspond to an ID returned by timer_create() but not yet deleted by timer_delete(). +

    + POSIX Compatibility: + Comparable to the POSIX interface of the same name. +

    2.7.11 timer_getoverrun

    @@ -2414,6 +2469,9 @@ VxWorks provides the following comparable interface: for the timer, or if the Realtime Signals Extension is not supported, the return value of timer_getoverrun() is unspecified.

    +

    + NOTE: This interface is not currently implemented in NuttX. +

    Input Parameters:

    @@ -2431,6 +2489,13 @@ VxWorks provides the following comparable interface: The timerid argument does not correspond to an ID returned by timer_create() but not yet deleted by timer_delete(). +

    + POSIX Compatibility: + Comparable to the POSIX interface of the same name. Differences from the full POSIX implementation include: +

    + Assumptions/Limitations:

    @@ -4925,6 +4990,7 @@ notify a task when a message is available on a queue.

  • wd_cancel
  • wd_create
  • wd_delete
  • +
  • wd_gettime
  • wd_start