Skip to content

Commit acfd341

Browse files
author
Jamie Smith
authored
Updates to targets JSON and related stuff for the website generator (#265)
* Various updates to support targets & drivers site generation * Add regression test for python code, add links to README * Don't need to duplicate device_name * Fix typo and some extra commas * Rephrase docs
1 parent fbaec0c commit acfd341

File tree

7 files changed

+151
-91
lines changed

7 files changed

+151
-91
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,13 @@ Additionally, the [discussions page](https://github.com/mbed-ce/mbed-os/discussi
3636

3737
## Documentation
3838

39+
### Mbed CE Docs
40+
For the Mbed CE code-level documentation (Doxygen), see [here](https://mbed-ce.github.io/mbed-os/group__mbed-os-public.html). For an auto-generated listing of target boards supported by Mbed, and the drivers & features each target supports, see the [targets index here](https://mbed-ce.github.io/mbed-ce-test-tools/targets/) and the [drivers index here](https://mbed-ce.github.io/mbed-ce-test-tools/drivers/).
41+
42+
Mbed CE is still working on more complete documentation infrastructure. Eventually, we hope to migrate all of the docs and examples as well. However, for now, see below to access those on the original Mbed OS docs site.
43+
44+
### Original ARM Mbed OS Docs
3945
For more information about Mbed OS, please see [the published Mbed OS documentation](https://os.mbed.com/docs/latest). It includes general overview information, step-by-step tutorials, porting information and background reference materials about our architecture and tools.
4046

41-
For the Mbed OS CE code-level documentation (Doxygen), see [here](https://mbed-ce.github.io/mbed-os/group__mbed-os-public.html)
4247

4348

targets/features.json5 renamed to targets/drivers.json5

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
// This JSON5 file contains a list of all the features used in Mbed.
2-
// There are three types of features:
3-
// Peripherals - Represents a peripheral present on this target and supported by Mbed CE.
4-
// Peripherals have names starting with DEVICE.
1+
// This JSON5 file contains a list of all the drivers used in Mbed.
2+
// There are three types of drivers:
3+
// Peripherals - Drives a peripheral present on this target MCU and supported by Mbed CE.
4+
// Peripheral drivers have names starting with DEVICE.
55
// Feature - A larger Mbed OS optional feature supported for this target.
6-
// Component - An external component present on a given board. This is commonly
7-
// used to mark a given eval board as having flash support, etc.
6+
// Component - A driver for an external component present on a given board. This is commonly
7+
// used to set up a given eval board as having flash support, etc.
88
// Each feature is defined here before it can be used in targets.json5.
99
// The contents of this file are not used during the build, but are used
1010
// when generating documentation.
@@ -252,7 +252,7 @@
252252
},
253253
"Peripheral": {
254254
"DEVICE_802_15_4_PHY": {
255-
"description": "802.15.4 radio peripheral, used to implement mesh networking (Wi-SUN, Thread, LoWPAN)",
255+
"description": "802.15.4 radio driver, used to implement mesh networking (Wi-SUN, Thread, LoWPAN)",
256256
"friendly_name": "802.15.4 Radio"
257257
},
258258
// Mystery ARM feature, used only on ARM FPGA reference designs
@@ -262,15 +262,15 @@
262262
"hidden_from_docs": true
263263
},
264264
"DEVICE_ANALOGIN": {
265-
"description": "Analog input (ADC) peripheral",
265+
"description": "Analog input (ADC) peripheral driver",
266266
"friendly_name": "Analog Inputs"
267267
},
268268
"DEVICE_ANALOGOUT": {
269-
"description": "Analog output (DAC) peripheral",
269+
"description": "Analog output (DAC) peripheral driver",
270270
"friendly_name": "Analog Outputs"
271271
},
272272
"DEVICE_CAN": {
273-
"description": "Controller Area Network (CAN) peripheral",
273+
"description": "Controller Area Network (CAN) peripheral driver",
274274
"friendly_name": "CAN"
275275
},
276276
// mystery ARM feature, used only on reference designs (SPI related?)
@@ -280,39 +280,39 @@
280280
"hidden_from_docs": true
281281
},
282282
"DEVICE_CRC": {
283-
"description": "CRC Acclerator peripheral, used to accelerate certain CRC computations.",
283+
"description": "Driver for CRC Accelerator peripheral, used to accelerate certain CRC computations.",
284284
"friendly_name": "Hardware CRC"
285285
},
286286
"DEVICE_DEBUG_AWARENESS": {
287287
"description": "Target supports awareness of whether semihost is attached",
288288
"friendly_name": "Semihost Debug Aware"
289289
},
290290
"DEVICE_EMAC": {
291-
"description": "Ethernet MAC peripheral. Combine with a PHY chip to connect to Ethernet networks.",
291+
"description": "Ethernet MAC peripheral driver. Combine the MAC with a PHY chip to connect to Ethernet networks.",
292292
"friendly_name": "Ethernet MAC"
293293
},
294294
"DEVICE_FLASH": {
295295
"description": "Driver allowing In-Application Programming (IAP) of the MCU flash memory.",
296296
"friendly_name": "Flash IAP"
297297
},
298298
"DEVICE_I2C": {
299-
"description": "I2C in controller/master mode",
299+
"description": "I2C driver for synchronous (blocking) controller/master mode",
300300
"friendly_name": "I2C Controller/Master"
301301
},
302302
"DEVICE_I2CSLAVE": {
303-
"description": "I2C in peripheral/slave mode",
303+
"description": "I2C for interrupt-based peripheral/slave mode",
304304
"friendly_name": "I2C Peripheral/Slave"
305305
},
306306
"DEVICE_I2C_ASYNCH": {
307-
"description": "Allows use of I2C controller mode in the background via interrupts and/or DMA.",
307+
"description": "Driver allowing I2C controller mode to be used in the background via interrupts and/or DMA.",
308308
"friendly_name": "Async I2C Controller/Master"
309309
},
310310
"DEVICE_INTERRUPTIN": {
311311
"description": "GPIO input pin interrupt support",
312312
"friendly_name": "GPIO Interrupts"
313313
},
314314
"DEVICE_ITM": {
315-
"description": "Support for ARM Instrumentation Trace Macrocell (ITM). Basically a fast serial port designed for application logging and tracing that runs over the SWO pin.",
315+
"description": "Driver for for ARM Instrumentation Trace Macrocell (ITM). Basically a fast serial port designed for application logging and tracing that runs over the SWO pin.",
316316
"friendly_name": "ITM"
317317
},
318318
"DEVICE_LPTICKER": {
@@ -321,26 +321,26 @@
321321
},
322322
"DEVICE_MPU": {
323323
"description": "Mbed supports configuring the MPU on this device to disable writing to ROM and executing from RAM.",
324-
"friendly_name": "Mempoy Protection Unit"
324+
"friendly_name": "Memory Protection Unit"
325325
},
326326
"DEVICE_OSPI": {
327-
"description": "Octal SPI peripheral, usually used to communicate with flash memory chips. Has 8 bidirectional data lines and one clock line, plus optionally a CS line and a DQS line.",
327+
"description": "Octal SPI peripheral driver, usually used to communicate with flash memory chips. OSPI uses 8 bidirectional data lines and one clock line, plus optionally a CS line and a DQS line.",
328328
"friendly_name": "Octal SPI"
329329
},
330330
"DEVICE_PORTIN": {
331-
"description": "Support for reading from an entire GPIO port at a time",
331+
"description": "Driver for reading from an entire GPIO port at a time",
332332
"friendly_name": "GPIO Port Input"
333333
},
334334
"DEVICE_PORTINOUT": {
335-
"description": "Support for using an entire GPIO port as a bidirectional I/O port.",
335+
"description": "Driver for using an entire GPIO port as a bidirectional I/O port.",
336336
"friendly_name": "GPIO Port I/O"
337337
},
338338
"DEVICE_PORTOUT": {
339-
"description": "Support for writing to an entire GPIO port at a time",
339+
"description": "Driver for writing to an entire GPIO port at a time",
340340
"friendly_name": "GPIO Port Output"
341341
},
342342
"DEVICE_PWMOUT": {
343-
"description": "Pulse Width Modulation (PWM) generator peripheral",
343+
"description": "Pulse Width Modulation (PWM) generator peripheral driver",
344344
"friendly_name": "PWM Out"
345345
},
346346
"DEVICE_QSPI": {

0 commit comments

Comments
 (0)