michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Add documentation for sys_thread_busy_wait()

Browse source 
Change-Id: I71f405448f141ae02c28889afd3fc03ddef55ecd
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
This commit is contained in:
Allan Stephens 2015-10-07 14:26:18 -04:00 • committed by Anas Nashif
commit 843f8a6224
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
doc/kernel/common/common_contexts.rst
View file

@ -20,6 +20,11 @@ task or fiber is zero.
The custom data value is not available to ISRs, which operate in the shared The custom data value is not available to ISRs, which operate in the shared
kernel interrupt handling context. kernel interrupt handling context.
The kernel allows a task or fiber to delay its processing for a specified time
period by performing a busy wait. This allows the delay to occur without
requiring the kernel to perform the context switching that occurs with its
more typical timer and timeout services.
Purpose Purpose
******* *******
@ -27,6 +32,11 @@ Purpose
Use the kernel execution context services when writing code that needs to Use the kernel execution context services when writing code that needs to
operate differently when executed by different contexts. operate differently when executed by different contexts.
Use the busy wait service when the required delay is too short to warrant
context switching to another task or fiber, or when performing a delay
as part of the nanokernel's background task (which is not allowed to
volutarily relinquish the CPU).
Usage Usage
***** *****
@ -92,3 +102,6 @@ The following kernel execution context APIs are provided by
| :c:func:`sys_thread_custom_data_get()` | Reads custom data for currently | | :c:func:`sys_thread_custom_data_get()` | Reads custom data for currently |
| | executing task or fiber. | | | executing task or fiber. |
+--------------------------------------------+---------------------------------------+ +--------------------------------------------+---------------------------------------+
| :c:func:`sys_thread_busy_wait()` | Performs a busy wait for the |
| | specified time period. |
+--------------------------------------------+---------------------------------------+