Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-05-27 11:26:12 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Documentation: document nxsched_abstick_sleep()

Browse Source 
Document nxsched_abstick_sleep().

Signed-off-by: Chengdong Wang <wangchengdong@lixiang.com>
This commit is contained in:
wangchengdong
2026-02-26 10:46:34 +08:00
committed by archer
parent 23d48da4bd
commit c7b2313cdd
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/reference/os/sleep.rst
+12 -6
View File
@@ -2,7 +2,7 @@
Sleep Sleep
===== =====
NuttX provides three different types of sleep interfaces. NuttX provides three different types of sleep interfaces.
Common Sleep Interfaces Common Sleep Interfaces
======================= =======================
@@ -13,8 +13,14 @@ Scheduled Sleep Interfaces (tick-based)
Suspend the calling thread for a specified amount of time until the time expires Suspend the calling thread for a specified amount of time until the time expires
or the thread is explicitly woken up through scheduler operations. or the thread is explicitly woken up through scheduler operations.
.. c:function:: void nxsched_abstick_sleep(clock_t ticks)
Suspends the calling thread from execution until the specified absolute time in clock ticks.
:param ticks: Absolute time in clock ticks.
.. c:function:: void nxsched_ticksleep(unsigned int ticks) .. c:function:: void nxsched_ticksleep(unsigned int ticks)
Suspends the calling thread from execution for the specified number of system ticks. Suspends the calling thread from execution for the specified number of system ticks.
:param ticks: The number of system ticks to sleep. :param ticks: The number of system ticks to sleep.
@@ -46,7 +52,7 @@ or the thread is explicitly woken up through scheduler operations.
:param rqtp: The amount of time to be suspended from execution. :param rqtp: The amount of time to be suspended from execution.
:param rmtp: If the rmtp argument is non-NULL, the timespec structure referenced :param rmtp: If the rmtp argument is non-NULL, the timespec structure referenced
by it is updated to contain the amount of time remaining. by it is updated to contain the amount of time remaining.
:return: 0 (OK), or negated errno if unsuccessful. :return: 0 (OK), or negated errno if unsuccessful.
.. c:function:: void nxsched_wakeup(struct tcb_s *tcb) .. c:function:: void nxsched_wakeup(struct tcb_s *tcb)
@@ -60,14 +66,14 @@ Signal-based Sleep Interfaces (timespec-based)
---------------------------------------------- ----------------------------------------------
Suspend the calling thread for a specified amount of time until the Suspend the calling thread for a specified amount of time until the
time expires or a signal is delivered to the calling thread. time expires or a signal is delivered to the calling thread.
.. note:: .. note::
Implementations are dependent on the signal framework and based on standard Implementations are dependent on the signal framework and based on standard
timespec conversion. timespec conversion.
.. c:function:: void nxsig_usleep(useconds_t usec) .. c:function:: void nxsig_usleep(useconds_t usec)
Suspends the calling thread from execution for the specified number of microseconds. Suspends the calling thread from execution for the specified number of microseconds.
:param usec: The number of microseconds to sleep. :param usec: The number of microseconds to sleep.
@@ -87,7 +93,7 @@ time expires or a signal is delivered to the calling thread.
:param rqtp: The amount of time to be suspended from execution. :param rqtp: The amount of time to be suspended from execution.
:param rmtp: If the rmtp argument is non-NULL, the timespec structure referenced :param rmtp: If the rmtp argument is non-NULL, the timespec structure referenced
by it is updated to contain the amount of time remaining. by it is updated to contain the amount of time remaining.
:return: 0 (OK), or negated errno if unsuccessful. :return: 0 (OK), or negated errno if unsuccessful.
Busy Sleep Interfaces Busy Sleep Interfaces