Skip to content

Commit 481be69

Browse files
committed
Incorporated the review comments
1 parent 2db1ed7 commit 481be69

File tree

2 files changed

+26
-46
lines changed

2 files changed

+26
-46
lines changed

docs/api/api.md

Lines changed: 21 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,13 @@ Most of the Mbed OS APIs are also supported with the Mbed OS bare metal profile.
1515
<td><a href="semaphore.html">Semaphore</a></td>
1616
<td><a href="userallocatedevent.html">UserAllocatedEvent</a></td>
1717
<td><a href="eventflags.html">EventFlags</a></td>
18-
<td><a href="kernel-interface-functions.html">Kernel interface functions</a></td>
18+
<td><a href="kernel-interface-functions.html">Kernel interface functions<br><i>(Only get_ms_count API)<i></a></td>
1919
</tr>
2020
<tr>
2121
<td><a href="thisthread.html">ThisThread</a></td>
2222
<td><a href="event.html">Event</a></td>
2323
<td><a href="eventqueue.html">EventQueue</a></td>
24+
<td><a href="mutex.html">Mutex</a></td>
2425
</tr>
2526
</tbody>
2627
</table>
@@ -29,8 +30,8 @@ Most of the Mbed OS APIs are also supported with the Mbed OS bare metal profile.
2930
<table>
3031
<tbody>
3132
<tr>
33+
<td><a href="kernel-interface-functions.html">Kernel interface functions</a></td>
3234
<td><a href="rtos-apis.html">Thread</a></td>
33-
<td><a href="mutex.html">Mutex</a></td>
3435
<td><a href="queue.html">Queue</a></td>
3536
</tr>
3637
<tr>
@@ -148,32 +149,7 @@ The data storage APIs include file system APIs, for file system operations, and
148149

149150
## Connectivity
150151

151-
### Common APIs
152-
<table>
153-
<tbody>
154-
<tr>
155-
<td><a href="#ble">BLE</a></td>
156-
<td><a href="#nfc">NFC</a></td>
157-
<td><a href="#lorawan">LoRaWAN</a></td>
158-
</tr>
159-
</tbody>
160-
</table>
161-
162-
### RTOS only supported APIs
163-
<table>
164-
<tbody>
165-
<tr>
166-
<td><a href="#network-interface">Network interface</a></td>
167-
<td><a href="#socket">Socket</a></td>
168-
</tr>
169-
<tr>
170-
<td><a href="#secure-socket">Secure socket</a></td>
171-
<td><a href="#dns">DNS</a></td>
172-
</tr>
173-
</tbody>
174-
</table>
175-
176-
#### Network interface
152+
### Network interface (*RTOS only*)
177153

178154
Network interfaces are the application level APIs where users choose the driver, connectivity method and IP stack. These include ethernet, Wi-Fi, cellular and mesh interfaces.
179155

@@ -195,7 +171,7 @@ Network interfaces are the application level APIs where users choose the driver,
195171
</tbody>
196172
</table>
197173

198-
#### Socket
174+
### Socket (*RTOS only*)
199175

200176
Socket APIs include the application programming interface for IP networking. In Mbed OS, this API supports both TCP and UDP protocols.
201177

@@ -211,7 +187,7 @@ Socket APIs include the application programming interface for IP networking. In
211187
</tbody>
212188
</table>
213189

214-
#### Secure socket
190+
### Secure socket (*RTOS only*)
215191

216192
<table>
217193
<tbody>
@@ -222,7 +198,7 @@ Socket APIs include the application programming interface for IP networking. In
222198
</tbody>
223199
</table>
224200

225-
#### DNS
201+
### DNS (*RTOS only*)
226202

227203
<table>
228204
<tbody>
@@ -232,7 +208,7 @@ Socket APIs include the application programming interface for IP networking. In
232208
</tbody>
233209
</table>
234210

235-
#### BLE
211+
### BLE
236212

237213
Bluetooth low energy (BLE) is a low power wireless technology standard for building personal area networks. Typical applications of BLE are health care, fitness trackers, beacons, smart home, security, entertainment, proximity sensors, industrial and automotive.
238214

@@ -252,7 +228,7 @@ Bluetooth low energy (BLE) is a low power wireless technology standard for build
252228
</tbody>
253229
</table>
254230

255-
#### NFC
231+
### NFC
256232

257233
You can use Near-Field Communication (NFC), a short-range radio technology, for use cases such as contactless payments, access control and device pairing.
258234

@@ -265,7 +241,7 @@ You can use Near-Field Communication (NFC), a short-range radio technology, for
265241
</tbody>
266242
</table>
267243

268-
#### LoRaWAN
244+
### LoRaWAN
269245

270246
Arm Mbed OS provides a native network stack for LoRaWAN. LoRaWAN is a technology designed for low-power battery-powered devices. These devices operate in an unlicensed spectrum, creating high density wide-area networks.
271247

@@ -313,21 +289,26 @@ The Mbed OS classes providing USB peripheral functionality, also known as USB co
313289

314290
With [Arm Mbed TLS](security.html), a comprehensive SSL/TLS solution, you can include cryptographic and SSL/TLS capabilities in your code.
315291

316-
### RTOS only supported APIs
317292
<table>
318293
<tbody>
319294
<tr>
320-
<td><a href="security-apis.html">PSA initial attestation</a></td>
321-
<td><a href="psa-lifecycle.html">PSA lifecycle</a></td>
322295
<td><a href="mbed-crypto.html">Mbed Crypto</a></td>
323-
</tr>
324-
<tr>
325296
<td><a href="tls.html">TLS</a></td>
326297
<td><a href="devicekey.html">DeviceKey</a></td>
327298
</tr>
328299
</tbody>
329300
</table>
330301

302+
### RTOS only supported APIs
303+
<table>
304+
<tbody>
305+
<tr>
306+
<td><a href="security-apis.html">PSA initial attestation</a></td>
307+
<td><a href="psa-lifecycle.html">PSA lifecycle</a></td>
308+
</tr>
309+
</tbody>
310+
</table>
311+
331312
## Power
332313

333314
<table>
@@ -415,5 +396,4 @@ If you're moving your program from Mbed OS 5 to 6, you will need to replace depr
415396
| Serial | [BufferedSerial](../apis/bufferedserial.html), [UnbufferedSerial](../apis/unbufferedserial.html) |
416397

417398
**_Note_**
418-
- The components webpage is linked here most probably shows an example based on RTOS.
419-
- When the component is listed only "RTOS only supported APIs" then it likely to work only on RTOS.
399+
- When you click, any component from the table it takes to its description webpage, but it mostly shows an example based on RTOS.

docs/program-setup/bare_metal/bare_metal.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ The Mbed OS bare metal profile is a compact profile of Mbed OS without an RTOS.
1010
<thead>
1111
<tr>
1212
<th colspan="2">Features/Components</th>
13-
<th>Mbed OS bare metal</th>
14-
<th> Mbed OS RTOS</th>
13+
<th>Mbed OS bare metal profile</th>
14+
<th> Mbed OS full profile</th>
1515
</tr>
1616
</thead>
1717
<tbody>
1818
<tr>
19-
<td rowspan="8">Mbed OS Core</td>
19+
<td rowspan="8">Core</td>
2020
<td >Drivers</td>
2121
<td>Available (Except USBCDC_ECM)</td>
2222
<td>Available</td>
@@ -110,12 +110,12 @@ The Mbed OS bare metal profile is a compact profile of Mbed OS without an RTOS.
110110
<td>Available</td>
111111
</tr>
112112
<tr>
113-
<td>Cryptocell</td>
113+
<td>Mbed Crypto</td>
114114
<td>Available</td>
115115
<td>Available</td>
116116
</tr>
117117
<tr>
118-
<td>Device key</td>
118+
<td>Devicekey</td>
119119
<td>Available</td>
120120
<td>Available</td>
121121
</tr>

0 commit comments

Comments
 (0)