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:
CONFIG_DISABLE_CLOCK
, CONFIG_DISABLE_PTHREAD
,
+ CONFIG_DISABLE_CLOCK
, CONFI_DISABLE_POSIX_TIMERS
, CONFIG_DISABLE_PTHREAD
,
CONFIG_DISABLE_SIGNALS
, CONFIG_DISABLE_MQUEUE
,
Gregory Nutt
-Last Update: January 28, 2007 +Last Update: March 21, 2007
+ 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: +
wdog
. Identifies the watchdog that the request is for.+ 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. +
+clockid
. Specifies the clock to use as the timing base.clockid
. Specifies the clock to use as the timing base.
+ Must be CLOCK_REALTIME
.evp
. Refers to a user allocated sigevent structure that defines the
asynchronous notification. evp may be NULL (see above).timerid
. The pre-thread timer created by the call to timer_create().+ POSIX Compatibility: + Comparable to the POSIX interface of the same name. Differences from the full POSIX implementation include: +
+CLOCK_REALTIME
is supported for the clockid
argument.@@ -2275,6 +2308,10 @@ VxWorks provides the following comparable interface:
EINVAL
. The timer specified timerid is not valid.+ POSIX Compatibility: + Comparable to the POSIX interface of the same name. +
@@ -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, theovalue
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 setovalue
. 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: +
+ovalue
argument is ignored.
@@ -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: Thetimerid
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. +
@@ -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: Thetimerid
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: +
+@@ -4925,6 +4990,7 @@ notify a task when a message is available on a queue.