Skip to content

Commit 5d435ec

Browse files
committed
PlatformMutex docs update
1 parent bdc8e09 commit 5d435ec

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

docs/api/platform/PlatformMutex.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,31 @@
22

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

5-
The PlarformMutex class provides mutex stub functions in the absence of RTOS. This class enables you to use driver/application code when the RTOS is not present.
5+
The PlatformMutex class is used to synchronize the execution of threads.
6+
7+
The PlatformMutex class is used by the Mbed OS drivers instead of [Mutex](mutex.html).
8+
This enables the use of drivers when the Mbed OS is compiled without the RTOS.
9+
For example, please see [AnalogIn](analogin.html), [BusOut](busout.html),
10+
[SPI](spi.html), [Serial](serial.html) and [I2C](i2c.html).
11+
12+
<span class="notes">**Note:**
13+
For the standard use of RTOS mutexes, please see [Mutex](mutex.html).</span>
614

715
### PlatformMutex class reference
816

917
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_platform_mutex.html)
1018

1119
### PlatformMutex example
1220

13-
The code below demonstrates usage of PlatformMutex.
21+
PlatformMutex usage example for Mbed OS compiled with the RTOS.
1422

1523
[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed_example/code/mbed-os-example-platform-mutex/)](https://os.mbed.com/teams/mbed_example/code/mbed-os-example-platform-mutex/file/2084d9e90526/main.cpp)
1624

17-
Mbed OS uses the PlatformMutex class instead of the RTOS mutex for all drivers. For example, please see [AnalogIn](analogin.html), [BusOut](busout.html), [SPI](spi.html), [Serial](serial.html) and [I2C](i2c.html).
18-
1925
### Related content
2026

21-
- [AnalogIn](analogin.html).
22-
- [BusOut](busout.html).
23-
- [SPI](spi.html).
24-
- [Serial](serial.html).
27+
- [Mutex](mutex.html),
28+
- [AnalogIn](analogin.html),
29+
- [BusOut](busout.html),
30+
- [SPI](spi.html),
31+
- [Serial](serial.html),
2532
- [I2C](i2c.html).

0 commit comments

Comments
 (0)