|
2 | 2 |
|
3 | 3 | <span class="images"><span>PlatformMutex class hierarchy</span></span>
|
4 | 4 |
|
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> |
6 | 14 |
|
7 | 15 | ### PlatformMutex class reference
|
8 | 16 |
|
9 | 17 | [](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_platform_mutex.html)
|
10 | 18 |
|
11 | 19 | ### PlatformMutex example
|
12 | 20 |
|
13 |
| -The code below demonstrates usage of PlatformMutex. |
| 21 | +PlatformMutex usage example for Mbed OS compiled with the RTOS. |
14 | 22 |
|
15 | 23 | [](https://os.mbed.com/teams/mbed_example/code/mbed-os-example-platform-mutex/file/2084d9e90526/main.cpp)
|
16 | 24 |
|
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 |
| - |
19 | 25 | ### Related content
|
20 | 26 |
|
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), |
25 | 32 | - [I2C](i2c.html).
|
0 commit comments