You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/api.md
+38-38Lines changed: 38 additions & 38 deletions
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,10 @@
1
1
# Full API list
2
2
3
-
This is the full list of APIs Mbed OS offers. The list indicates which of the APIs the [bare metal profile](../bare-metal/index.html) supports, and which of those are enabled by default. For consistency, we also show the full profile's API support, although that is - and is expected to remain - all APIs.
3
+
This is the full list of APIs Mbed OS offers. The list indicates which of the APIs the [bare metal profile](../bare-metal/index.html) supports, and which of those are manually enabled (as opposed to enabled by default). For consistency, we also show the full profile's API support, although that is - and is expected to remain - all APIs.
4
4
5
5
For a list of APIs that were removed in Mbed OS 6, see [the deprecated APIs list at the bottom of this page](#deprecated-apis-moving-from-mbed-os-5-to-6).
6
-
<!--This list does not include the internal APIs, which are not intended for use by application code.-->
6
+
7
+
This list does not include the internal APIs, which are not intended for use by application code.
7
8
8
9
## Scheduling
9
10
@@ -28,9 +29,9 @@ The Mbed OS RTOS capabilities include managing objects such as threads, synchron
28
29
29
30
| API | Full profile | Bare metal profile |
30
31
| - | - | - |
31
-
|[Event](../apis/event-handling-apis.html)|✔|✓ (can be manually enabled) |
32
-
|[EventQueue](../apis/eventqueue.html)|✔|✓ (can be manually enabled) |
33
-
|[UserAllocatedEvent](../apis/userallocatedevent.html)|✔|✓ (can be manually enabled) |
32
+
|[Event](../apis/event-handling-apis.html)|✔|✔ (can be manually enabled) |
33
+
|[EventQueue](../apis/eventqueue.html)|✔|✔ (can be manually enabled) |
34
+
|[UserAllocatedEvent](../apis/userallocatedevent.html)|✔|✔ (can be manually enabled) |
34
35
35
36
## Drivers
36
37
@@ -166,31 +167,31 @@ The data storage APIs include file system APIs, for file system operations, and
166
167
167
168
| API | Full profile | Bare metal profile |
168
169
| - | - | - |
169
-
|[Dir](../apis/dir.html)|✔|✓ (can be manually enabled)|
170
-
|[FATFileSystem](../apis/fatfilesystem.html)|✔|✓ (can be manually enabled) |
171
-
|[File](../apis/file.html)|✔|✓ (can be manually enabled) |
172
-
|[FileSystem](../apis/filesystem.html)|✔|✓ (can be manually enabled) |
173
-
|[KVStore](../apis/data-apis)|✔|✓ (can be manually enabled) |
174
-
|[LittleFileSystem](../apis/littlefilesystem.html)|✔|✓ (can be manually enabled) |
175
-
|[Static Global API](../apis/static-global-api.html)|✔|✓ (can be manually enabled) |
170
+
|[Dir](../apis/dir.html)|✔|✔ (can be manually enabled)|
171
+
|[FATFileSystem](../apis/fatfilesystem.html)|✔|✔ (can be manually enabled) |
172
+
|[File](../apis/file.html)|✔|✔ (can be manually enabled) |
173
+
|[FileSystem](../apis/filesystem.html)|✔|✔ (can be manually enabled) |
174
+
|[KVStore](../apis/data-apis)|✔|✔ (can be manually enabled) |
175
+
|[LittleFileSystem](../apis/littlefilesystem.html)|✔|✔ (can be manually enabled) |
176
+
|[Static Global API](../apis/static-global-api.html)|✔|✔ (can be manually enabled) |
176
177
177
178
### BlockDevice (block-based storage) APIs
178
179
179
180
| API | Full profile | Bare metal profile |
180
181
| - | - | - |
181
-
|[BlockDevice](../apis/blockdevice.html)|✔|✓ (can be manually enabled) |
182
-
|[BufferedBlockDevice](../apis/bufferedblockdevice.html)|✔|✓ (can be manually enabled) |
183
-
|[ChainingBlockDevice](../apis/chainingblockdevice.html)|✔|✓ (can be manually enabled) |
184
-
|[DataFlashBlockDevice](../apis/dataflashblockdevice.html)|✔|✓ (can be manually enabled) |
185
-
|[FlashIAPBlockDevice](../apis/flashiapblockdevice.html)|✔|✓ (can be manually enabled) |
186
-
|[FlashSimBlockDevice](../apis/flashsimblockdevice.html)|✔|✓ (can be manually enabled) |
187
-
|[HeapBlockDevice](../apis/heapblockdevice.html)|✔|✓ (can be manually enabled) |
188
-
|[MBRBlockDevice](../apis/mbrblockdevice.html)|✔|✓ (can be manually enabled) |
189
-
|[ProfilingBlockDevice](../apis/profilingblockdevice.htm)|✔|✓ (can be manually enabled) |
190
-
|[QSPIFBlockDevice](../apis/qspifblockdevice.html)|✔|✓ (can be manually enabled) |
191
-
|[SDBlockDevice](../apis/sdblockdevice.html)|✔|✓ (can be manually enabled) |
192
-
|[SlicingBlockDevice](../apis/slicingblockdevice.html)|✔|✓ (can be manually enabled) |
193
-
|[SPI Flash block device](../apis/spi-flash-block-device.html)|✔|✓ (can be manually enabled) |
182
+
|[BlockDevice](../apis/blockdevice.html)|✔|✔ (can be manually enabled) |
183
+
|[BufferedBlockDevice](../apis/bufferedblockdevice.html)|✔|✔ (can be manually enabled) |
184
+
|[ChainingBlockDevice](../apis/chainingblockdevice.html)|✔|✔ (can be manually enabled) |
185
+
|[DataFlashBlockDevice](../apis/dataflashblockdevice.html)|✔|✔ (can be manually enabled) |
186
+
|[FlashIAPBlockDevice](../apis/flashiapblockdevice.html)|✔|✔ (can be manually enabled) |
187
+
|[FlashSimBlockDevice](../apis/flashsimblockdevice.html)|✔|✔ (can be manually enabled) |
188
+
|[HeapBlockDevice](../apis/heapblockdevice.html)|✔|✔ (can be manually enabled) |
189
+
|[MBRBlockDevice](../apis/mbrblockdevice.html)|✔|✔ (can be manually enabled) |
190
+
|[ProfilingBlockDevice](../apis/profilingblockdevice.htm)|✔|✔ (can be manually enabled) |
191
+
|[QSPIFBlockDevice](../apis/qspifblockdevice.html)|✔|✔ (can be manually enabled) |
192
+
|[SDBlockDevice](../apis/sdblockdevice.html)|✔|✔ (can be manually enabled) |
193
+
|[SlicingBlockDevice](../apis/slicingblockdevice.html)|✔|✔ (can be manually enabled) |
194
+
|[SPI Flash block device](../apis/spi-flash-block-device.html)|✔|✔ (can be manually enabled) |
194
195
195
196
### PSA compliant
196
197
@@ -248,22 +249,22 @@ Bluetooth low energy (BLE) is a low power wireless technology standard for build
248
249
249
250
| API | Full profile | Bare metal profile |
250
251
| - | - | - |
251
-
|[BatteryService](../apis/batteryservice.html)|✔|✓ (can be manually enabled) |
252
-
|[BLE](../apis/ble.html)|✔|✓ (can be manually enabled) |
253
-
|[GAP](../apis/gap.html)|✔|✓ (can be manually enabled) |
254
-
|[GattClient](../apis/gattclient.html)|✔|✓ (can be manually enabled) |
255
-
|[GattServer](../apis/gattserver.html)|✔|✓ (can be manually enabled) |
256
-
|[HeartRateService](../apis/heartrateservice.html)|✔|✓ (can be manually enabled) |
257
-
|[SecurityManager](../apis/SecurityManager.html)|✔|✓ (can be manually enabled) |
252
+
|[BatteryService](../apis/batteryservice.html)|✔|✔ (can be manually enabled) |
253
+
|[BLE](../apis/ble.html)|✔|✔ (can be manually enabled) |
254
+
|[GAP](../apis/gap.html)|✔|✔ (can be manually enabled) |
255
+
|[GattClient](../apis/gattclient.html)|✔|✔ (can be manually enabled) |
256
+
|[GattServer](../apis/gattserver.html)|✔|✔ (can be manually enabled) |
257
+
|[HeartRateService](../apis/heartrateservice.html)|✔|✔ (can be manually enabled) |
258
+
|[SecurityManager](../apis/SecurityManager.html)|✔|✔ (can be manually enabled) |
258
259
259
260
### NFC
260
261
261
262
You can use Near-Field Communication (NFC), a short-range radio technology, for use cases such as contactless payments, access control and device pairing.
262
263
263
264
| API | Full profile | Bare metal profile |
264
265
| - | - | - |
265
-
|[NFCController](../apis/nfccontroller.html)|✔|✓ (can be manually enabled) |
266
-
|[NFC EEPROM](../apis/nfc-eeprom.html)|✔|✓ (can be manually enabled) |
266
+
|[NFCController](../apis/nfccontroller.html)|✔|✔ (can be manually enabled) |
267
+
|[NFC EEPROM](../apis/nfc-eeprom.html)|✔|✔ (can be manually enabled) |
267
268
268
269
### LoRaWAN
269
270
@@ -282,11 +283,11 @@ With [Arm Mbed TLS](security.html), a comprehensive SSL/TLS solution, you can in
282
283
283
284
| API | Full profile | Bare metal profile |
284
285
| - | - | - |
285
-
|[DeviceKey](../apis/devicekey.html)|✔|✓ (can be manually enabled) |
286
-
|[Mbed Crypto](../apis/mbed-crypto.html)|✔|✓ (can be manually enabled) |
286
+
|[DeviceKey](../apis/devicekey.html)|✔|✔ (can be manually enabled) |
287
+
|[Mbed Crypto](../apis/mbed-crypto.html)|✔|✔ (can be manually enabled) |
Copy file name to clipboardExpand all lines: docs/api/platform/Wait.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Wait
2
2
3
-
<spanclass="tips">**Tip:**`wait` is deprecated in favor of explicit sleep functions. To sleep, replace `wait` with `ThisThread::sleep_for` (C++) or `thread_sleep_for` (C). To wait (without sleeping), call `wait_us`. `wait_us` is safe to call from ISR context.</span>
3
+
<spanclass="notes">**Note:** The function`wait` is deprecated in favor of explicit sleep functions. To sleep, replace `wait` with `ThisThread::sleep_for` (C++) or `thread_sleep_for` (C). To wait (without sleeping), call `wait_us`. `wait_us` is safe to call from ISR context.</span>
4
4
5
5
The wait_us and wait_ns functions provide precise wait capabilities. These functions spin the CPU to produce a small delay so they should only be used for short delays. Any delay larger than a millisecond will affect power and multithread performance, and block the platform deep sleep for the entire duration. Therefore, spinning for millisecond wait is not recommended, and ThisThread::sleep_for should be used instead.
Copy file name to clipboardExpand all lines: docs/bare_metal/bare_metal.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ For a breakdown of supported APIs, please see [the full API list](../apis/index.
10
10
11
11
<spanclass="notes">**Note:** Because bare metal uses some APIs that Mbed OS classifies as RTOS APIs, some class names that traditionally belong in RTOS programming are used in bare metal. For example, bare metal uses the class `ThisThread` despite not using threads.</span>
12
12
13
-
✔ : Enabled by default | △ : Can be manually enabled | ✗ : Not supported
13
+
✔ : Supported - by default or manually | ✗ : Not supported
14
14
15
15
<table>
16
16
<thead>
@@ -27,11 +27,11 @@ For a breakdown of supported APIs, please see [the full API list](../apis/index.
27
27
</tr>
28
28
<tr>
29
29
<td>Events</td>
30
-
<td>△</td>
30
+
<td>✔ (can be manually enabled)</td>
31
31
</tr>
32
32
<tr>
33
33
<td>HAL</td>
34
-
<td>△</td>
34
+
<td>✔ (can be manually enabled)</td>
35
35
</tr>
36
36
<tr>
37
37
<td>Platform</td>
@@ -43,7 +43,7 @@ For a breakdown of supported APIs, please see [the full API list](../apis/index.
43
43
</tr>
44
44
<tr>
45
45
<td>Storage</td>
46
-
<td>△</td>
46
+
<td>✔ (can be manually enabled)</td>
47
47
<tr>
48
48
<td rowspan="8">Connectivity</td>
49
49
<td>802.15.4_RF</td>
@@ -72,11 +72,11 @@ For a breakdown of supported APIs, please see [the full API list](../apis/index.
72
72
</tr>
73
73
<tr>
74
74
<td>BLE</td>
75
-
<td>△<br>Except `COMPONENT_BlueNRG_MS` and `TARGET_NORDIC_CORDIO`</td>
75
+
<td>✔ (can be manually enabled)<br>Except `COMPONENT_BlueNRG_MS` and `TARGET_NORDIC_CORDIO`</td>
76
76
</tr>
77
77
<tr>
78
78
<td>NFC</td>
79
-
<td>△</td>
79
+
<td>✔ (can be manually enabled)</td>
80
80
</tr>
81
81
<tr>
82
82
<td rowspan="4">Security</td>
@@ -85,15 +85,15 @@ For a breakdown of supported APIs, please see [the full API list](../apis/index.
0 commit comments