diff options
Diffstat (limited to 'docs/RTOS2/html/group__rtx__evr__thread.html')
| -rw-r--r-- | docs/RTOS2/html/group__rtx__evr__thread.html | 155 |
1 files changed, 48 insertions, 107 deletions
diff --git a/docs/RTOS2/html/group__rtx__evr__thread.html b/docs/RTOS2/html/group__rtx__evr__thread.html index 52b7242..ba7dbec 100644 --- a/docs/RTOS2/html/group__rtx__evr__thread.html +++ b/docs/RTOS2/html/group__rtx__evr__thread.html @@ -146,6 +146,9 @@ Functions</h2></td></tr> <tr class="memitem:gabf4a015bd3fb2a33c0d105a871aaba72"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread.html#gabf4a015bd3fb2a33c0d105a871aaba72">EvrRtxThreadSetPriority</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id, <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gad4e3e0971b41f2d17584a8c6837342ec">osPriority_t</a> priority)</td></tr> <tr class="memdesc:gabf4a015bd3fb2a33c0d105a871aaba72"><td class="mdescLeft"> </td><td class="mdescRight">Event on thread priority set (API) <a href="#gabf4a015bd3fb2a33c0d105a871aaba72">More...</a><br/></td></tr> <tr class="separator:gabf4a015bd3fb2a33c0d105a871aaba72"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga831b3e64d459a325fbc13033caa39f05"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread.html#ga831b3e64d459a325fbc13033caa39f05">EvrRtxThreadPriorityUpdated</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id, <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gad4e3e0971b41f2d17584a8c6837342ec">osPriority_t</a> priority)</td></tr> +<tr class="memdesc:ga831b3e64d459a325fbc13033caa39f05"><td class="mdescLeft"> </td><td class="mdescRight">Event on thread priority updated (Op) <a href="#ga831b3e64d459a325fbc13033caa39f05">More...</a><br/></td></tr> +<tr class="separator:ga831b3e64d459a325fbc13033caa39f05"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gada73306deca99987b104aa9840fdd4e2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread.html#gada73306deca99987b104aa9840fdd4e2">EvrRtxThreadGetPriority</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id, <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gad4e3e0971b41f2d17584a8c6837342ec">osPriority_t</a> priority)</td></tr> <tr class="memdesc:gada73306deca99987b104aa9840fdd4e2"><td class="mdescLeft"> </td><td class="mdescRight">Event on thread priority retrieve (API) <a href="#gada73306deca99987b104aa9840fdd4e2">More...</a><br/></td></tr> <tr class="separator:gada73306deca99987b104aa9840fdd4e2"><td class="memSeparator" colspan="2"> </td></tr> @@ -180,13 +183,13 @@ Functions</h2></td></tr> <tr class="memdesc:ga86ac910ac88d8fe54206a12d7ed69a27"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful thread join (Op) <a href="#ga86ac910ac88d8fe54206a12d7ed69a27">More...</a><br/></td></tr> <tr class="separator:ga86ac910ac88d8fe54206a12d7ed69a27"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab9efd66ed2edb439c5081806c9b63cf9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread.html#gab9efd66ed2edb439c5081806c9b63cf9">EvrRtxThreadBlocked</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id, uint32_t timeout)</td></tr> -<tr class="memdesc:gab9efd66ed2edb439c5081806c9b63cf9"><td class="mdescLeft"> </td><td class="mdescRight">Event on thread execution block (Op) <a href="#gab9efd66ed2edb439c5081806c9b63cf9">More...</a><br/></td></tr> +<tr class="memdesc:gab9efd66ed2edb439c5081806c9b63cf9"><td class="mdescLeft"> </td><td class="mdescRight">Event on thread execution block (Detail) <a href="#gab9efd66ed2edb439c5081806c9b63cf9">More...</a><br/></td></tr> <tr class="separator:gab9efd66ed2edb439c5081806c9b63cf9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga3faae4d941ddecfe773ef9f3efe8b901"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread.html#ga3faae4d941ddecfe773ef9f3efe8b901">EvrRtxThreadUnblocked</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id, uint32_t ret_val)</td></tr> -<tr class="memdesc:ga3faae4d941ddecfe773ef9f3efe8b901"><td class="mdescLeft"> </td><td class="mdescRight">Event on thread execution unblock (Op) <a href="#ga3faae4d941ddecfe773ef9f3efe8b901">More...</a><br/></td></tr> +<tr class="memdesc:ga3faae4d941ddecfe773ef9f3efe8b901"><td class="mdescLeft"> </td><td class="mdescRight">Event on thread execution unblock (Detail) <a href="#ga3faae4d941ddecfe773ef9f3efe8b901">More...</a><br/></td></tr> <tr class="separator:ga3faae4d941ddecfe773ef9f3efe8b901"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gabe470d5bb1373c59c51470fd20b55bcb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread.html#gabe470d5bb1373c59c51470fd20b55bcb">EvrRtxThreadPreempted</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id)</td></tr> -<tr class="memdesc:gabe470d5bb1373c59c51470fd20b55bcb"><td class="mdescLeft"> </td><td class="mdescRight">Event on running thread pre-emption (Op) <a href="#gabe470d5bb1373c59c51470fd20b55bcb">More...</a><br/></td></tr> +<tr class="memdesc:gabe470d5bb1373c59c51470fd20b55bcb"><td class="mdescLeft"> </td><td class="mdescRight">Event on running thread pre-emption (Detail) <a href="#gabe470d5bb1373c59c51470fd20b55bcb">More...</a><br/></td></tr> <tr class="separator:gabe470d5bb1373c59c51470fd20b55bcb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae3bc50d5f154463c7f6647544bb5ecab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread.html#gae3bc50d5f154463c7f6647544bb5ecab">EvrRtxThreadSwitched</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id)</td></tr> <tr class="memdesc:gae3bc50d5f154463c7f6647544bb5ecab"><td class="mdescLeft"> </td><td class="mdescRight">Event on running thread switch (Op) <a href="#gae3bc50d5f154463c7f6647544bb5ecab">More...</a><br/></td></tr> @@ -206,18 +209,6 @@ Functions</h2></td></tr> <tr class="memitem:ga1999d77992b03347abdca7ec17f91cca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread.html#ga1999d77992b03347abdca7ec17f91cca">EvrRtxThreadEnumerate</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> *thread_array, uint32_t array_items, uint32_t count)</td></tr> <tr class="memdesc:ga1999d77992b03347abdca7ec17f91cca"><td class="mdescLeft"> </td><td class="mdescRight">Event on active threads enumerate (API) <a href="#ga1999d77992b03347abdca7ec17f91cca">More...</a><br/></td></tr> <tr class="separator:ga1999d77992b03347abdca7ec17f91cca"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gadbbee398f4fab418c9b8115fc7392ff8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread.html#gadbbee398f4fab418c9b8115fc7392ff8">EvrRtxThreadFlagsWaitTimeout</a> (void)</td></tr> -<tr class="memdesc:gadbbee398f4fab418c9b8115fc7392ff8"><td class="mdescLeft"> </td><td class="mdescRight">Event on wait timeout for thread flags (Op) <a href="#gadbbee398f4fab418c9b8115fc7392ff8">More...</a><br/></td></tr> -<tr class="separator:gadbbee398f4fab418c9b8115fc7392ff8"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gadd45d32305aa45668a36f2c9f0f4c758"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread.html#gadd45d32305aa45668a36f2c9f0f4c758">EvrRtxThreadDelay</a> (uint32_t ticks)</td></tr> -<tr class="memdesc:gadd45d32305aa45668a36f2c9f0f4c758"><td class="mdescLeft"> </td><td class="mdescRight">Event on wait for timeout (API) <a href="#gadd45d32305aa45668a36f2c9f0f4c758">More...</a><br/></td></tr> -<tr class="separator:gadd45d32305aa45668a36f2c9f0f4c758"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaf59defd6c171d2c3d3508e7136278db2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread.html#gaf59defd6c171d2c3d3508e7136278db2">EvrRtxThreadDelayUntil</a> (uint32_t ticks)</td></tr> -<tr class="memdesc:gaf59defd6c171d2c3d3508e7136278db2"><td class="mdescLeft"> </td><td class="mdescRight">Event on wait until specified time (API) <a href="#gaf59defd6c171d2c3d3508e7136278db2">More...</a><br/></td></tr> -<tr class="separator:gaf59defd6c171d2c3d3508e7136278db2"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gab46562848142ce5ea806d629fd000168"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread.html#gab46562848142ce5ea806d629fd000168">EvrRtxThreadDelayCompleted</a> (void)</td></tr> -<tr class="memdesc:gab46562848142ce5ea806d629fd000168"><td class="mdescLeft"> </td><td class="mdescRight">Event on completed wait (Op) <a href="#gab46562848142ce5ea806d629fd000168">More...</a><br/></td></tr> -<tr class="separator:gab46562848142ce5ea806d629fd000168"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <h2 class="groupheader">Function Documentation</h2> @@ -251,7 +242,7 @@ Functions</h2></td></tr> </table> </dd> </dl> -<p>The event <b>ThreadError</b> is generated when <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html">Thread Flags</a> and <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html">Thread Management</a> routines complete their execution due to an error.</p> +<p>The event <b>ThreadError</b> is generated when <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html">Thread Management</a> routines complete their execution due to an error.</p> <p>The status parameter indicates the execution status and can be one of the <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t codes</a> or one of the extended execution status codes which are summarized in the table below.</p> <table class="doxtable"> <tr> @@ -339,9 +330,8 @@ Functions</h2></td></tr> <ul> <li><b>func</b> : memory address of thread function.</li> <li><b>argument</b> : memory address of thread function start argument.</li> -<li><b>attr</b> : memory address of Thread attributes or 0 when they are not specified.</li> +<li><b>attr</b> : memory address of Thread attributes or 0 when they are not specified. </li> </ul> -<p>In case when <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#structosThreadAttr__t">thread attributes</a> are provided in the API call they are also detailed in the Event Recorder. </p> </div> </div> @@ -612,6 +602,45 @@ Functions</h2></td></tr> </div> </div> +<a class="anchor" id="ga831b3e64d459a325fbc13033caa39f05"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxThreadPriorityUpdated </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> </td> + <td class="paramname"><em>thread_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gad4e3e0971b41f2d17584a8c6837342ec">osPriority_t</a> </td> + <td class="paramname"><em>priority</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">thread_id</td><td>thread ID obtained by <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a> or <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga8df03548e89fbc56402a5cd584a505da">osThreadGetId</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">priority</td><td>new priority value for the thread function.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>ThreadPriorityUpdated</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga861a420fb2d643115b06622903fb3bfb">osThreadSetPriority</a> successfully updated the specified thread priority.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>thread_id</b> : thread ID.</li> +<li><b>priority</b> : new priority value for the thread function. </li> +</ul> + +</div> +</div> <a class="anchor" id="gada73306deca99987b104aa9840fdd4e2"></a> <div class="memitem"> <div class="memproto"> @@ -1188,100 +1217,12 @@ Functions</h2></td></tr> </div> </div> -<a class="anchor" id="gadbbee398f4fab418c9b8115fc7392ff8"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void EvrRtxThreadFlagsWaitTimeout </td> - <td>(</td> - <td class="paramtype">void </td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>The event <b>ThreadFlagsWaitTimeout</b> is generated when wait for thread flags to become signaled is aborted due to expired wait timeout. </p> - -</div> -</div> -<a class="anchor" id="gadd45d32305aa45668a36f2c9f0f4c758"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void EvrRtxThreadDelay </td> - <td>(</td> - <td class="paramtype">uint32_t </td> - <td class="paramname"><em>ticks</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">ticks</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">time ticks</a> value.</td></tr> - </table> - </dd> -</dl> -<p>The event <b>ThreadDelay</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a> is called.</p> -<p><b>Value</b> in the Event Recorder shows:</p> -<ul> -<li><b>ticks</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">time ticks</a> value. </li> -</ul> - -</div> -</div> -<a class="anchor" id="gaf59defd6c171d2c3d3508e7136278db2"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void EvrRtxThreadDelayUntil </td> - <td>(</td> - <td class="paramtype">uint32_t </td> - <td class="paramname"><em>ticks</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">ticks</td><td>absolute time in ticks.</td></tr> - </table> - </dd> -</dl> -<p>The event <b>ThreadDelayUntil</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Wait.html#ga3c807924c2d6d43bc2ffb49da3f7f3a1">osDelayUntil</a> is called.</p> -<p><b>Value</b> in the Event Recorder shows:</p> -<ul> -<li><b>ticks</b> : absolute delay time in ticks. </li> -</ul> - -</div> -</div> -<a class="anchor" id="gab46562848142ce5ea806d629fd000168"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void EvrRtxThreadDelayCompleted </td> - <td>(</td> - <td class="paramtype">void </td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>The event <b>ThreadDelayCompleted</b> is generated when thread delay expires. </p> - -</div> -</div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:45 for CMSIS-RTOS2 by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:04 for CMSIS-RTOS2 Version 2.1.3 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 |