Skip to content

Commit a320614

Browse files
committed
Fix ConditionVariable docs and otehr changes
1 parent f1f5a27 commit a320614

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/reference/api/rtos/ConditionVariable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<span class="images">![](https://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/classrtos_1_1_condition_variable.png)<span>ConditionVariable class hierarchy</span></span>
44

5-
The ConditionVariable class provides a mechanism to safely wait for or signal state changes. A common scenario when writing multithreaded code is to protect shared resources with a mutex and then release that mutex to wait for a change of that data. If you do not do this carefully, this can lead to a race condition in the code. A condition variable provides a safe solution to this problem by handling the wait for a state change, along with releasing and acquiring the mutex automatically during this waiting period.
5+
The ConditionVariable class provides a mechanism to safely wait for or signal state changes. A common scenario when writing multithreaded code is to protect shared resources with a mutex and then release that mutex to wait for a change of that data. If you do not do this carefully, this can lead to a race condition in the code. A condition variable provides a safe solution to this problem by handling the wait for a state change, along with releasing and acquiring the mutex automatically during this waiting period. Note that you cannot make wait or notify calls on a condition variable from ISR context. Unlike EventFlags, ConditionVariable does not let you wait on multiple events at the same time.
66

77
### ConditionVariable class reference
88

docs/reference/api/rtos/rtos.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<h2 id="rtos-api">RTOS overview</h2>
22

3-
The Arm Mbed RTOS APIs provides C++ APIs to manage RTOS objects like thread, synchronization objects and timer. It also provides interfaces for attaching application
4-
specific idle hook function and to read the tick count from OS. The Arm Mbed RTOS layer also handles RTOS errors and report them into Mbed-OS error handling system.
3+
Mbed-OS RTOS provide C++ APIs to manage objects like thread, synchronization objects and timer. It also provides interfaces for attaching application
4+
specific idle hook function, read the OS tick count and implements functionality to report RTOS errors.
55

66
The code of the Mbed RTOS can be found in the [`mbed-os`](https://github.com/ARMmbed/mbed-os) repository, in the [RTOS subdirectory](https://github.com/ARMmbed/mbed-os/tree/master/rtos). See [the Doxygen](https://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/group__rtos.html) for more information.
77

@@ -25,9 +25,9 @@ The RTOS APIs handle creation and destruction of threads in Arm Mbed OS 5, as we
2525
- [MemoryPool](/docs/development/reference/memorypool.html): This class that you can use to define and manage fixed-size memory pools
2626
- [Mail](/docs/development/reference/mail.html): The API that provides a queue combined with a memory pool for allocating messages.
2727
- [RtosTimer](/docs/development/reference/rtostimer.html): A deprecated class used to control timer functions in the system.
28-
- [EventFlags](/docs/development/reference/eventflags.html): An event channel that provides a generic way of notifying other threads about conditions or events.
28+
- [EventFlags](/docs/development/reference/eventflags.html): An event channel that provides a generic way of notifying other threads about conditions or events. Some EventFlags functions are callable from ISR context and each EventFlags objects can support up to 31 flags.
2929
- [Event](/docs/development/reference/event.html): The queue to store events, extract them and excute them later.
30-
- [ConditionVariable](/docs/development/reference/conditionvariable.html): The ConditionVariable class provides a mechanism to safely wait for or signal state changes.
30+
- [ConditionVariable](/docs/development/reference/conditionvariable.html): The ConditionVariable class provides a mechanism to safely wait for or signal a single state change. ConditionVariable functions are not callable from ISR context.
3131
- [Kernel](/docs/development/reference/kernel.html): Kernel namespace implements functions to control or read RTOS information like tick count.
3232

3333
##### Default timeouts
@@ -58,5 +58,5 @@ Each `Thread` can wait for signals and be notified of events:
5858
[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed_example/code/rtos_signals/)](https://os.mbed.com/teams/mbed_example/code/rtos_signals/file/476186ff82cf/main.cpp)
5959

6060
##### Status and Error codes
61-
The Arm Mbed RTOS layer handles RTOS errors and report them using Mbed-OS error handling system. See the list of error codes in [Error Handling](/docs/development/reference/error-handling.html)
61+
Mbed OS error handling system assigns specific error codes for RTOS related erros. See [Error Handling](/docs/development/reference/error-handling.html)
6262
for more information on RTOS errors reported.

0 commit comments

Comments
 (0)