Skip to content

Commit 095a1fe

Browse files
author
github-actions
committed
Update develop documentation
1 parent e516e35 commit 095a1fe

17 files changed

+24
-24
lines changed

‎develop/Core/html/cmsis_footer.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
function writeFooter() {
2-
document.write('Generated on Thu Mar 28 2024 08:03:20 for CMSIS-Core (Cortex-M) Version 5.7.0 by Arm Ltd. All rights reserved.');
2+
document.write('Generated on Mon Jul 29 2024 10:52:21 for CMSIS-Core (Cortex-M) Version 5.7.0 by Arm Ltd. All rights reserved.');
33
};

‎develop/Core_A/html/cmsis_footer.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
function writeFooter() {
2-
document.write('Generated on Thu Mar 28 2024 08:03:20 for CMSIS-Core (Cortex-A) Version 1.2.1 by Arm Ltd. All rights reserved.');
2+
document.write('Generated on Mon Jul 29 2024 10:52:22 for CMSIS-Core (Cortex-A) Version 1.2.1 by Arm Ltd. All rights reserved.');
33
};

‎develop/DAP/html/cmsis_footer.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
function writeFooter() {
2-
document.write('Generated on Thu Mar 28 2024 08:03:21 for CMSIS-DAP Version 2.1.2 by Arm Ltd. All rights reserved.');
2+
document.write('Generated on Mon Jul 29 2024 10:52:23 for CMSIS-DAP Version 2.1.2 by Arm Ltd. All rights reserved.');
33
};

‎develop/Driver/html/cmsis_footer.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
function writeFooter() {
2-
document.write('Generated on Thu Mar 28 2024 08:03:21 for CMSIS-Driver Version 2.8.0 by Arm Ltd. All rights reserved.');
2+
document.write('Generated on Mon Jul 29 2024 10:52:23 for CMSIS-Driver Version 2.8.0 by Arm Ltd. All rights reserved.');
33
};

‎develop/Driver/html/group__usbd__interface__gr.html

+12-12
Original file line numberDiff line numberDiff line change
@@ -223,18 +223,18 @@
223223
<p>To use the USBD driver invoke the API functions in the following order:</p>
224224
<div align="center">
225225
<img src="msc_inline_mscgraph_2.png" alt="msc_inline_mscgraph_2" border="0" usemap="#msc_inline_mscgraph_2.map"/>
226-
<map name="msc_inline_mscgraph_2.map" id="msc_inline_mscgraph_2.map"><area href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81" shape="rect" coords="229,50,371,61" alt=""/>
227-
<area href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81" shape="rect" coords="134,78,467,89" alt=""/>
228-
<area href="group__usbd__interface__gr.html#ga99207f7ff5e97a7f65754eab7f775fca" shape="rect" coords="206,106,395,117" alt=""/>
229-
<area href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5" shape="rect" coords="88,134,512,145" alt=""/>
230-
<area href="group__usbd__interface__gr.html#ga7624d6b2cbe5e6ab5016206ce641eee2" shape="rect" coords="204,162,397,173" alt=""/>
231-
<area href="group__usbd__interface__gr.html#ga62d7d5bdcf9ca7bf7e6d8434368abad8" shape="rect" coords="194,190,406,201" alt=""/>
232-
<area href="group__usbd__interface__gr.html#ga6e69ad097553125bb01a22dc719e0d30" shape="rect" coords="199,235,401,246" alt=""/>
233-
<area href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575" shape="rect" coords="187,263,414,274" alt=""/>
234-
<area href="group__usbd__interface__gr.html#gab81fac01522a4d504edcb7b7d3abba6c" shape="rect" coords="166,291,434,302" alt=""/>
235-
<area href="group__usbd__interface__gr.html#ga37234abecbb63e4e739f9676e489d2d1" shape="rect" coords="197,336,404,347" alt=""/>
236-
<area href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81" shape="rect" coords="137,364,464,375" alt=""/>
237-
<area href="group__usbd__interface__gr.html#gafaead6713f141be1734de0110eda966b" shape="rect" coords="220,392,380,403" alt=""/>
226+
<map name="msc_inline_mscgraph_2.map" id="msc_inline_mscgraph_2.map"><area href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81" shape="rect" coords="230,50,371,61" alt=""/>
227+
<area href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81" shape="rect" coords="135,78,466,89" alt=""/>
228+
<area href="group__usbd__interface__gr.html#ga99207f7ff5e97a7f65754eab7f775fca" shape="rect" coords="206,106,394,117" alt=""/>
229+
<area href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5" shape="rect" coords="90,134,511,145" alt=""/>
230+
<area href="group__usbd__interface__gr.html#ga7624d6b2cbe5e6ab5016206ce641eee2" shape="rect" coords="205,162,396,173" alt=""/>
231+
<area href="group__usbd__interface__gr.html#ga62d7d5bdcf9ca7bf7e6d8434368abad8" shape="rect" coords="195,190,405,201" alt=""/>
232+
<area href="group__usbd__interface__gr.html#ga6e69ad097553125bb01a22dc719e0d30" shape="rect" coords="200,235,400,246" alt=""/>
233+
<area href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575" shape="rect" coords="188,263,412,274" alt=""/>
234+
<area href="group__usbd__interface__gr.html#gab81fac01522a4d504edcb7b7d3abba6c" shape="rect" coords="168,291,433,302" alt=""/>
235+
<area href="group__usbd__interface__gr.html#ga37234abecbb63e4e739f9676e489d2d1" shape="rect" coords="197,336,403,347" alt=""/>
236+
<area href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81" shape="rect" coords="138,364,462,375" alt=""/>
237+
<area href="group__usbd__interface__gr.html#gafaead6713f141be1734de0110eda966b" shape="rect" coords="221,392,380,403" alt=""/>
238238
</map>
239239
</div>
240240
<hr/><h2 class="groupheader">Data Structure Documentation</h2>

‎develop/Driver/html/msc_inline_mscgraph_1.png

-91 Bytes
Loading

‎develop/Driver/html/msc_inline_mscgraph_2.png

11 Bytes
Loading

‎develop/General/html/cmsis_footer.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
function writeFooter() {
2-
document.write('Generated on Thu Mar 28 2024 08:03:21 for CMSIS Version 5.9.0 by Arm Ltd. All rights reserved.');
2+
document.write('Generated on Mon Jul 29 2024 10:52:23 for CMSIS Version 5.9.0 by Arm Ltd. All rights reserved.');
33
};

‎develop/RTOS/html/cmsis_footer.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
function writeFooter() {
2-
document.write('Generated on Thu Mar 28 2024 08:03:21 for CMSIS-RTOS Version 1.03 by Arm Ltd. All rights reserved.');
2+
document.write('Generated on Mon Jul 29 2024 10:52:23 for CMSIS-RTOS Version 1.03 by Arm Ltd. All rights reserved.');
33
};

‎develop/RTOS2/html/cmsis_footer.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
function writeFooter() {
2-
document.write('Generated on Thu Mar 28 2024 08:03:22 for CMSIS-RTOS2 Version 2.2.0 by Arm Ltd. All rights reserved.');
2+
document.write('Generated on Mon Jul 29 2024 10:52:24 for CMSIS-RTOS2 Version 2.2.0 by Arm Ltd. All rights reserved.');
33
};

‎develop/RTOS2/html/group__CMSIS__RTOS__EventFlags.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ <h2>Working with Events </h2>
175175
Simple event communication</div></div>
176176
<p> The following steps are required to use event flags:</p>
177177
<ol type="1">
178-
<li>In the thread that is supposed to send a event with id sig1_id, call the set function: <div class="fragment"><div class="line"><a class="code" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a>(1000U); <span class="comment">// wait for 1 second</span></div>
178+
<li>In the thread that is supposed to send an event with id sig1_id, call the set function: <div class="fragment"><div class="line"><a class="code" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a>(1000U); <span class="comment">// wait for 1 second</span></div>
179179
<div class="line"><a class="code" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a>(sig1_id, 0x0001U); <span class="comment">// set the flag 0x0001U for event sig1_id</span></div>
180180
</div><!-- fragment --></li>
181181
<li>In another thread (or threads) that are supposed to wait for the event, call the wait function: <div class="fragment"><div class="line"><a class="code" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a>(sig1_id, 0x0001U, NULL, <a class="code" href="group__CMSIS__RTOS__Definitions.html#ga9eb9a7a797a42e4b55eb171ecc609ddb">osWaitForever</a>); <span class="comment">// wait forever for any flag</span></div>

‎develop/RTOS2/html/group__CMSIS__RTOS__Message.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@
159159
<tr class="separator:gaba987f665444e0d83fa6a3a68bc72abe"><td class="memSeparator" colspan="2">&#160;</td></tr>
160160
</table>
161161
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
162-
<p><b>Message</b> <b>passing</b> is another basic communication model between threads. In the message passing model, one thread sends data explicitly, while another thread receives it. The operation is more like some kind of I/O rather than a direct access to information to be shared. In CMSIS-RTOS, this mechanism is called s <b>message</b> <b>queue</b>. The data is passed from one thread to another in a FIFO-like operation. Using message queue functions, you can control, send, receive, or wait for messages. The data to be passed can be of integer or pointer type:</p>
162+
<p><b>Message</b> <b>passing</b> is another basic communication model between threads. In the message passing model, one thread sends data explicitly, while another thread receives it. The operation is more like some kind of I/O rather than a direct access to information to be shared. In CMSIS-RTOS, this mechanism is called a <b>message</b> <b>queue</b>. The data is passed from one thread to another in a FIFO-like operation. Using message queue functions, you can control, send, receive, or wait for messages. The data to be passed can be of integer or pointer type:</p>
163163
<div class="image">
164164
<img src="MessageQueue.png" alt="MessageQueue.png"/>
165165
<div class="caption">

‎develop/RTOS2/html/group__CMSIS__RTOS__ThreadFlagsMgmt.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@
134134
<tr class="separator:gac11542ad6300b600f872fc96e340ec2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
135135
</table>
136136
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
137-
<p>Thread Flags are a more specialized version of the Event Flags. See <a class="el" href="group__CMSIS__RTOS__EventFlags.html">Event Flags</a>. While Event Flags can be used to globally signal a number of threads, thread flags are only send to a single specific thread. Every thread instance can receive thread flags without any additional allocation of a thread flags object.</p>
137+
<p>Thread Flags are a more specialized version of the Event Flags. See <a class="el" href="group__CMSIS__RTOS__EventFlags.html">Event Flags</a>. While Event Flags can be used to globally signal a number of threads, thread flags are only sent to a single specific thread. Every thread instance can receive thread flags without any additional allocation of a thread flags object.</p>
138138
<dl class="section note"><dt>Note</dt><dd>Thread flag management functions cannot be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>, except for <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a>.</dd></dl>
139139
<p><b>Usage Example</b></p>
140140
<p>The following (incomplete) code excerpt sketches the usage principals for <b>Thread Flags</b>.</p>

‎develop/RTOS2/html/msc_inline_mscgraph_1.png

-20 Bytes
Loading

‎develop/RTOS2/html/msc_inline_mscgraph_2.png

-76 Bytes
Loading

‎develop/SVD/html/cmsis_footer.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
function writeFooter() {
2-
document.write('Generated on Thu Mar 28 2024 08:03:22 for CMSIS-SVD Version 1.3.9 by Arm Ltd. All rights reserved.');
2+
document.write('Generated on Mon Jul 29 2024 10:52:24 for CMSIS-SVD Version 1.3.9 by Arm Ltd. All rights reserved.');
33
};

‎develop/Zone/html/cmsis_footer.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
function writeFooter() {
2-
document.write('Generated on Thu Mar 28 2024 08:03:22 for CMSIS-Zone Version 1.2.0-alpha by Arm Ltd. All rights reserved.');
2+
document.write('Generated on Mon Jul 29 2024 10:52:24 for CMSIS-Zone Version 1.2.0-alpha by Arm Ltd. All rights reserved.');
33
};

0 commit comments

Comments
 (0)