deploy: edf39e4

Author: kmilo17pet

_quark_t_s_8h_source.html

@@ -170,7 +170,7 @@
 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="preprocessor">    #define QuarkTS_H</span></div>
 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span> </div>
 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="preprocessor">    #define QUARKTS_VERSION         &quot;7.3.3&quot;</span></div>
-<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="preprocessor">    #define QUARKTS_VERNUM          ( 733u )</span></div>
+<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="preprocessor">    #define QUARKTS_VERNUM          ( 733U )</span></div>
 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="preprocessor">    #define QUARKTS_CAPTION         &quot;QuarkTS OS &quot;</span> QUARKTS_VERSION</div>
 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span> </div>
 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="preprocessor">    #include &quot;qtypes.h&quot;</span></div>

group__qioutils.html

@@ -343,7 +343,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0ed0793f44f3cdc6ef61f6c
 </div><!-- fragment --> Example 2: Ouput operation <div class="fragment"><div class="line"><span class="keywordtype">char</span> BSP_GetChar( <span class="keywordtype">void</span> *sp, <span class="keywordtype">char</span> in ) {</div>
 <div class="line">      (void)sp;</div>
 <div class="line">      HAL_UARTPutByte( in );</div>
-<div class="line">      <span class="keywordflow">return</span> 0u;</div>
+<div class="line">      <span class="keywordflow">return</span> 0U;</div>
 <div class="line">}</div>
 </div><!-- fragment --> </dd></dl>
 <dl class="params"><dt>Parameters</dt><dd>

q_atcli.html

@@ -336,7 +336,7 @@ <h1><a class="anchor" id="q_atcli_example1"></a>
 <div class="ttc" id="agroup__qatcli_html_ga3a268bc78e828ca17067f89614f61756"><div class="ttname"><a href="group__qatcli.html#ga3a268bc78e828ca17067f89614f61756">qATCLI_Setup</a></div><div class="ttdeci">qBool_t qATCLI_Setup(qATCLI_t *const cli, const qPutChar_t outFcn, char *pInput, const size_t sizeInput, char *pOutput, const size_t sizeOutput)</div><div class="ttdoc">Setup an instance of the AT Command Line Interface.</div><div class="ttdef"><b>Definition:</b> qatcli.c:112</div></div>
 <div class="ttc" id="agroup__qatcli_html_gadc4fd0e693b7a1c36fb5c3b7f4f42c33"><div class="ttname"><a href="group__qatcli.html#gadc4fd0e693b7a1c36fb5c3b7f4f42c33">qATCLI_CmdSubscribe</a></div><div class="ttdeci">qBool_t qATCLI_CmdSubscribe(qATCLI_t *const cli, qATCLI_Command_t *const cmd, char *textCommand, const qATCLI_CommandCallback_t cFcn, qATCLI_Options_t cmdOpt, void *param)</div><div class="ttdoc">This function subscribes the CLI instance to a specific command with an associated Callback function,...</div><div class="ttdef"><b>Definition:</b> qatcli.c:154</div></div>
 <div class="ttc" id="agroup__qtaskcreation_html_ga33bd7afc6bdd5e8a995d2cb50e006e3a"><div class="ttname"><a href="group__qtaskcreation.html#ga33bd7afc6bdd5e8a995d2cb50e006e3a">qLowest_Priority</a></div><div class="ttdeci">#define qLowest_Priority</div><div class="ttdoc">A macro directive to indicate the lowest priority level.</div><div class="ttdef"><b>Definition:</b> qkernel.h:71</div></div>
-<div class="ttc" id="agroup__qtaskcreation_html_gabd4b43371d39c5eb82b87f0900f2895a"><div class="ttname"><a href="group__qtaskcreation.html#gabd4b43371d39c5eb82b87f0900f2895a">qOS_Run</a></div><div class="ttdeci">qBool_t qOS_Run(void)</div><div class="ttdoc">Executes the scheduling scheme. It must be called once after the task pool has been defined.</div><div class="ttdef"><b>Definition:</b> qkernel.c:683</div></div>
+<div class="ttc" id="agroup__qtaskcreation_html_gabd4b43371d39c5eb82b87f0900f2895a"><div class="ttname"><a href="group__qtaskcreation.html#gabd4b43371d39c5eb82b87f0900f2895a">qOS_Run</a></div><div class="ttdeci">qBool_t qOS_Run(void)</div><div class="ttdoc">Executes the scheduling scheme. It must be called once after the task pool has been defined.</div><div class="ttdef"><b>Definition:</b> qkernel.c:686</div></div>
 <div class="ttc" id="agroup__qtaskcreation_html_gac97ca3bd669135e0adcf07fcc2852313"><div class="ttname"><a href="group__qtaskcreation.html#gac97ca3bd669135e0adcf07fcc2852313">qOS_Setup</a></div><div class="ttdeci">qBool_t qOS_Setup(const qGetTickFcn_t tFcn, const qTimingBase_t t, qTaskFcn_t idleCallback)</div><div class="ttdoc">Task Scheduler Setup. This function is required and must be called once in the application main threa...</div><div class="ttdef"><b>Definition:</b> qkernel.c:126</div></div>
 <div class="ttc" id="agroup__qtaskcreation_html_gaf0b51d7213c21c0afbfd4dbce865c6e2"><div class="ttname"><a href="group__qtaskcreation.html#gaf0b51d7213c21c0afbfd4dbce865c6e2">qOS_Add_ATCLITask</a></div><div class="ttdeci">qBool_t qOS_Add_ATCLITask(qTask_t *const Task, qATCLI_t *cli, const qPriority_t p, void *arg)</div><div class="ttdoc">Add a task to the scheduling scheme running an AT Command Line Interface. Task will be scheduled as e...</div><div class="ttdef"><b>Definition:</b> qkernel.c:546</div></div>
 </div><!-- fragment --><p >The CLI input is feeded from the interrupt context by using the UART receive ISR:</p>

q_events.html

@@ -360,7 +360,7 @@ <h3><a class="anchor" id="q_notificationsend"></a>
 <div class="ttc" id="agroup__qnot_html_gaa0897bb00bc0e8b090397e7632f61f7b"><div class="ttname"><a href="group__qnot.html#gaa0897bb00bc0e8b090397e7632f61f7b">qTask_Notification_Queue</a></div><div class="ttdeci">qBool_t qTask_Notification_Queue(qTask_t *const Task, void *eventData)</div><div class="ttdoc">Insert a notification in the FIFO priority queue. The scheduler get this notification as an asynchron...</div><div class="ttdef"><b>Definition:</b> qtasks.c:31</div></div>
 <div class="ttc" id="agroup__qnot_html_gab793f72b9f447c74fbabb876fd7aea4c"><div class="ttname"><a href="group__qnot.html#gab793f72b9f447c74fbabb876fd7aea4c">qTask_Notification_Send</a></div><div class="ttdeci">qBool_t qTask_Notification_Send(qTask_t *const Task, void *eventData)</div><div class="ttdoc">Sends a simple notification generating an asynchronous event. This method marks the task as ready for...</div><div class="ttdef"><b>Definition:</b> qtasks.c:12</div></div>
 <div class="ttc" id="agroup__qtaskcreation_html_ga33bd7afc6bdd5e8a995d2cb50e006e3a"><div class="ttname"><a href="group__qtaskcreation.html#ga33bd7afc6bdd5e8a995d2cb50e006e3a">qLowest_Priority</a></div><div class="ttdeci">#define qLowest_Priority</div><div class="ttdoc">A macro directive to indicate the lowest priority level.</div><div class="ttdef"><b>Definition:</b> qkernel.h:71</div></div>
-<div class="ttc" id="agroup__qtaskcreation_html_gabd4b43371d39c5eb82b87f0900f2895a"><div class="ttname"><a href="group__qtaskcreation.html#gabd4b43371d39c5eb82b87f0900f2895a">qOS_Run</a></div><div class="ttdeci">qBool_t qOS_Run(void)</div><div class="ttdoc">Executes the scheduling scheme. It must be called once after the task pool has been defined.</div><div class="ttdef"><b>Definition:</b> qkernel.c:683</div></div>
+<div class="ttc" id="agroup__qtaskcreation_html_gabd4b43371d39c5eb82b87f0900f2895a"><div class="ttname"><a href="group__qtaskcreation.html#gabd4b43371d39c5eb82b87f0900f2895a">qOS_Run</a></div><div class="ttdeci">qBool_t qOS_Run(void)</div><div class="ttdoc">Executes the scheduling scheme. It must be called once after the task pool has been defined.</div><div class="ttdef"><b>Definition:</b> qkernel.c:686</div></div>
 <div class="ttc" id="agroup__qtaskcreation_html_gac97ca3bd669135e0adcf07fcc2852313"><div class="ttname"><a href="group__qtaskcreation.html#gac97ca3bd669135e0adcf07fcc2852313">qOS_Setup</a></div><div class="ttdeci">qBool_t qOS_Setup(const qGetTickFcn_t tFcn, const qTimingBase_t t, qTaskFcn_t idleCallback)</div><div class="ttdoc">Task Scheduler Setup. This function is required and must be called once in the application main threa...</div><div class="ttdef"><b>Definition:</b> qkernel.c:126</div></div>
 <div class="ttc" id="agroup__qtaskcreation_html_gae296358ea4dd26df7018155eef0cb456"><div class="ttname"><a href="group__qtaskcreation.html#gae296358ea4dd26df7018155eef0cb456">qOS_Add_EventTask</a></div><div class="ttdeci">qBool_t qOS_Add_EventTask(qTask_t *const Task, qTaskFcn_t callbackFcn, const qPriority_t p, void *arg)</div><div class="ttdoc">Add a task to the scheduling scheme. This API creates a task with a qDisabled state by default,...</div><div class="ttdef"><b>Definition:</b> qkernel.c:475</div></div>
 <div class="ttc" id="agroup__qtaskmanip_html_ggaf68e9306308b42db48932211e1c40334a6da5ef837be1720e34c9e16200c92002"><div class="ttname"><a href="group__qtaskmanip.html#ggaf68e9306308b42db48932211e1c40334a6da5ef837be1720e34c9e16200c92002">byNotificationQueued</a></div><div class="ttdeci">@ byNotificationQueued</div><div class="ttdoc">When there is a queued notification in the FIFO priority queue. For this trigger, the dispatcher perf...</div><div class="ttdef"><b>Definition:</b> qtasks.h:58</div></div>

q_fsm.html

@@ -611,8 +611,8 @@ <h2><a class="anchor" id="q_fsm_example2"></a>
 <div class="ttc" id="agroup__qfsm_html_ga07476c08b51bd61cdb87e161ae717d6c"><div class="ttname"><a href="group__qfsm.html#ga07476c08b51bd61cdb87e161ae717d6c">QSM_STATE_TOP</a></div><div class="ttdeci">#define QSM_STATE_TOP</div><div class="ttdoc">This macro can be used to reference the top state when using the qStateMachine_StateSubscribe() API.</div><div class="ttdef"><b>Definition:</b> qfsm.h:57</div></div>
 <div class="ttc" id="agroup__qfsm_html_ga238feabe2db7825556f716c6a403a556"><div class="ttname"><a href="group__qfsm.html#ga238feabe2db7825556f716c6a403a556">qStateMachine_InstallSignalQueue</a></div><div class="ttdeci">qBool_t qStateMachine_InstallSignalQueue(qSM_t *const m, qQueue_t *q)</div><div class="ttdoc">Install a signal queue to the provided Finite State Machine (FSM).</div><div class="ttdef"><b>Definition:</b> qfsm.c:607</div></div>
 <div class="ttc" id="agroup__qfsm_html_ga243c71753d0b5d1a402c9bda5c7bc727"><div class="ttname"><a href="group__qfsm.html#ga243c71753d0b5d1a402c9bda5c7bc727">qStateMachine_Set_StateTransitions</a></div><div class="ttdeci">qBool_t qStateMachine_Set_StateTransitions(qSM_State_t *const s, qSM_Transition_t *const table, const size_t n)</div><div class="ttdoc">Installs a table with the outgoing transitions for the supplied state.</div><div class="ttdef"><b>Definition:</b> qfsm.c:592</div></div>
-<div class="ttc" id="agroup__qfsm_html_ga81a3c55cd5811420bdbb4383eabd542a"><div class="ttname"><a href="group__qfsm.html#ga81a3c55cd5811420bdbb4383eabd542a">qStateMachine_InstallTimeoutSpec</a></div><div class="ttdeci">qBool_t qStateMachine_InstallTimeoutSpec(qSM_t *const m, qSM_TimeoutSpec_t *const ts)</div><div class="ttdoc">Install the Timeout-specification object to target FSM to allow timed signals within states ( See the...</div><div class="ttdef"><b>Definition:</b> qfsm.c:797</div></div>
-<div class="ttc" id="agroup__qfsm_html_gacb92e74ae8f68e2535a81860600f876f"><div class="ttname"><a href="group__qfsm.html#gacb92e74ae8f68e2535a81860600f876f">qStateMachine_Set_StateTimeouts</a></div><div class="ttdeci">qBool_t qStateMachine_Set_StateTimeouts(qSM_State_t *const s, qSM_TimeoutStateDefinition_t *tdef, const size_t n)</div><div class="ttdoc">Setup fixed timeouts for the specified state using a lookup-table.</div><div class="ttdef"><b>Definition:</b> qfsm.c:816</div></div>
+<div class="ttc" id="agroup__qfsm_html_ga81a3c55cd5811420bdbb4383eabd542a"><div class="ttname"><a href="group__qfsm.html#ga81a3c55cd5811420bdbb4383eabd542a">qStateMachine_InstallTimeoutSpec</a></div><div class="ttdeci">qBool_t qStateMachine_InstallTimeoutSpec(qSM_t *const m, qSM_TimeoutSpec_t *const ts)</div><div class="ttdoc">Install the Timeout-specification object to target FSM to allow timed signals within states ( See the...</div><div class="ttdef"><b>Definition:</b> qfsm.c:799</div></div>
+<div class="ttc" id="agroup__qfsm_html_gacb92e74ae8f68e2535a81860600f876f"><div class="ttname"><a href="group__qfsm.html#gacb92e74ae8f68e2535a81860600f876f">qStateMachine_Set_StateTimeouts</a></div><div class="ttdeci">qBool_t qStateMachine_Set_StateTimeouts(qSM_State_t *const s, qSM_TimeoutStateDefinition_t *tdef, const size_t n)</div><div class="ttdoc">Setup fixed timeouts for the specified state using a lookup-table.</div><div class="ttdef"><b>Definition:</b> qfsm.c:818</div></div>
 <div class="ttc" id="agroup__qqueues_html_gac7b44df16c76bdf45d82f3b7621eec63"><div class="ttname"><a href="group__qqueues.html#gac7b44df16c76bdf45d82f3b7621eec63">qQueue_Setup</a></div><div class="ttdeci">qBool_t qQueue_Setup(qQueue_t *const q, void *pData, const size_t itemSize, const size_t itemsCount)</div><div class="ttdoc">Configures a Queue. Here, the RAM used to hold the queue data pData is statically allocated at compil...</div><div class="ttdef"><b>Definition:</b> qqueues.c:32</div></div>
 <div class="ttc" id="agroup__qtaskcreation_html_ga13bec7f4284d45c97f512c83ed9b7744"><div class="ttname"><a href="group__qtaskcreation.html#ga13bec7f4284d45c97f512c83ed9b7744">qMedium_Priority</a></div><div class="ttdeci">#define qMedium_Priority</div><div class="ttdoc">A macro directive to indicate the medium priority level.</div><div class="ttdef"><b>Definition:</b> qkernel.h:74</div></div>
 </div><!-- fragment --><h1><a class="anchor" id="qfsm_happroach"></a>

q_gettingstarted.html

@@ -239,7 +239,7 @@ <h2><a class="anchor" id="q_os_example1"></a>
 <div class="line">}</div>
 <div class="ttc" id="agroup__qclock_html_gacdc3d27983dcc08e28d9eb9844a55c53"><div class="ttname"><a href="group__qclock.html#gacdc3d27983dcc08e28d9eb9844a55c53">qClock_SysTick</a></div><div class="ttdeci">void qClock_SysTick(void)</div><div class="ttdoc">Feed the system tick.</div><div class="ttdef"><b>Definition:</b> qclock.c:94</div></div>
 <div class="ttc" id="agroup__qtaskcreation_html_ga261c858990773b834e8129940ceef1e2"><div class="ttname"><a href="group__qtaskcreation.html#ga261c858990773b834e8129940ceef1e2">qOS_Add_Task</a></div><div class="ttdeci">qBool_t qOS_Add_Task(qTask_t *const Task, qTaskFcn_t callbackFcn, const qPriority_t p, const qTime_t t, const qIteration_t n, const qState_t init, void *arg)</div><div class="ttdoc">Add a task to the scheduling scheme. The task is scheduled to run every t seconds,...</div><div class="ttdef"><b>Definition:</b> qkernel.c:416</div></div>
-<div class="ttc" id="agroup__qtaskcreation_html_gabd4b43371d39c5eb82b87f0900f2895a"><div class="ttname"><a href="group__qtaskcreation.html#gabd4b43371d39c5eb82b87f0900f2895a">qOS_Run</a></div><div class="ttdeci">qBool_t qOS_Run(void)</div><div class="ttdoc">Executes the scheduling scheme. It must be called once after the task pool has been defined.</div><div class="ttdef"><b>Definition:</b> qkernel.c:683</div></div>
+<div class="ttc" id="agroup__qtaskcreation_html_gabd4b43371d39c5eb82b87f0900f2895a"><div class="ttname"><a href="group__qtaskcreation.html#gabd4b43371d39c5eb82b87f0900f2895a">qOS_Run</a></div><div class="ttdeci">qBool_t qOS_Run(void)</div><div class="ttdoc">Executes the scheduling scheme. It must be called once after the task pool has been defined.</div><div class="ttdef"><b>Definition:</b> qkernel.c:686</div></div>
 <div class="ttc" id="agroup__qtaskcreation_html_gae3758e719245db560b090d90fce96301"><div class="ttname"><a href="group__qtaskcreation.html#gae3758e719245db560b090d90fce96301">qPeriodic</a></div><div class="ttdeci">#define qPeriodic</div><div class="ttdoc">A directive indicating that the task will run every time its timeout has expired.</div><div class="ttdef"><b>Definition:</b> qkernel.h:80</div></div>
 <div class="ttc" id="agroup__qtaskmanip_html_ga1211609f7dba8749ae31aa73a8b072e6"><div class="ttname"><a href="group__qtaskmanip.html#ga1211609f7dba8749ae31aa73a8b072e6">qTask_Suspend</a></div><div class="ttdeci">#define qTask_Suspend(Task)</div><div class="ttdoc">Put the task into a disabled state.</div><div class="ttdef"><b>Definition:</b> qtasks.h:533</div></div>
 <div class="ttc" id="agroup__qtaskmanip_html_ga27aa23ec76dae5afb4c1a4d8b8d8e256"><div class="ttname"><a href="group__qtaskmanip.html#ga27aa23ec76dae5afb4c1a4d8b8d8e256">qTask_Set_Time</a></div><div class="ttdeci">qBool_t qTask_Set_Time(qTask_t *const Task, const qTime_t tValue)</div><div class="ttdoc">Set/Change the Task execution interval.</div><div class="ttdef"><b>Definition:</b> qtasks.c:95</div></div>

q_memmang.html

@@ -226,7 +226,7 @@ <h1><a class="anchor" id="q_memmang_usage"></a>
 <div class="ttc" id="agroup__qmemmang_html_gab6eda783bf043945f75582f1ad580209"><div class="ttname"><a href="group__qmemmang.html#gab6eda783bf043945f75582f1ad580209">qMemMang_Pool_Setup</a></div><div class="ttdeci">qBool_t qMemMang_Pool_Setup(qMemMang_Pool_t *const mPool, void *pArea, const size_t pSize)</div><div class="ttdoc">Initializes a memory pool instance. This function should be called once before any heap memory reques...</div></div>
 <div class="ttc" id="agroup__qtaskcreation_html_ga261c858990773b834e8129940ceef1e2"><div class="ttname"><a href="group__qtaskcreation.html#ga261c858990773b834e8129940ceef1e2">qOS_Add_Task</a></div><div class="ttdeci">qBool_t qOS_Add_Task(qTask_t *const Task, qTaskFcn_t callbackFcn, const qPriority_t p, const qTime_t t, const qIteration_t n, const qState_t init, void *arg)</div><div class="ttdoc">Add a task to the scheduling scheme. The task is scheduled to run every t seconds,...</div><div class="ttdef"><b>Definition:</b> qkernel.c:416</div></div>
 <div class="ttc" id="agroup__qtaskcreation_html_ga33bd7afc6bdd5e8a995d2cb50e006e3a"><div class="ttname"><a href="group__qtaskcreation.html#ga33bd7afc6bdd5e8a995d2cb50e006e3a">qLowest_Priority</a></div><div class="ttdeci">#define qLowest_Priority</div><div class="ttdoc">A macro directive to indicate the lowest priority level.</div><div class="ttdef"><b>Definition:</b> qkernel.h:71</div></div>
-<div class="ttc" id="agroup__qtaskcreation_html_gabd4b43371d39c5eb82b87f0900f2895a"><div class="ttname"><a href="group__qtaskcreation.html#gabd4b43371d39c5eb82b87f0900f2895a">qOS_Run</a></div><div class="ttdeci">qBool_t qOS_Run(void)</div><div class="ttdoc">Executes the scheduling scheme. It must be called once after the task pool has been defined.</div><div class="ttdef"><b>Definition:</b> qkernel.c:683</div></div>
+<div class="ttc" id="agroup__qtaskcreation_html_gabd4b43371d39c5eb82b87f0900f2895a"><div class="ttname"><a href="group__qtaskcreation.html#gabd4b43371d39c5eb82b87f0900f2895a">qOS_Run</a></div><div class="ttdeci">qBool_t qOS_Run(void)</div><div class="ttdoc">Executes the scheduling scheme. It must be called once after the task pool has been defined.</div><div class="ttdef"><b>Definition:</b> qkernel.c:686</div></div>
 <div class="ttc" id="agroup__qtaskcreation_html_gac97ca3bd669135e0adcf07fcc2852313"><div class="ttname"><a href="group__qtaskcreation.html#gac97ca3bd669135e0adcf07fcc2852313">qOS_Setup</a></div><div class="ttdeci">qBool_t qOS_Setup(const qGetTickFcn_t tFcn, const qTimingBase_t t, qTaskFcn_t idleCallback)</div><div class="ttdoc">Task Scheduler Setup. This function is required and must be called once in the application main threa...</div><div class="ttdef"><b>Definition:</b> qkernel.c:126</div></div>
 <div class="ttc" id="agroup__qtaskcreation_html_gae3758e719245db560b090d90fce96301"><div class="ttname"><a href="group__qtaskcreation.html#gae3758e719245db560b090d90fce96301">qPeriodic</a></div><div class="ttdeci">#define qPeriodic</div><div class="ttdoc">A directive indicating that the task will run every time its timeout has expired.</div><div class="ttdef"><b>Definition:</b> qkernel.h:80</div></div>
 <div class="ttc" id="agroup__qtrace_html_ga88f22f8c295a457f692adc670fcc391f"><div class="ttname"><a href="group__qtrace.html#ga88f22f8c295a457f692adc670fcc391f">qTrace_Set_OutputFcn</a></div><div class="ttdeci">void qTrace_Set_OutputFcn(qPutChar_t fcn)</div><div class="ttdoc">This API set the output method for debug/trace messages.</div></div>