|
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. |
5 | 5 | // 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. |
8 | 8 | // Each feature is defined here before it can be used in targets.json5.
|
9 | 9 | // The contents of this file are not used during the build, but are used
|
10 | 10 | // when generating documentation.
|
|
252 | 252 | },
|
253 | 253 | "Peripheral": {
|
254 | 254 | "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)", |
256 | 256 | "friendly_name": "802.15.4 Radio"
|
257 | 257 | },
|
258 | 258 | // Mystery ARM feature, used only on ARM FPGA reference designs
|
|
262 | 262 | "hidden_from_docs": true
|
263 | 263 | },
|
264 | 264 | "DEVICE_ANALOGIN": {
|
265 |
| - "description": "Analog input (ADC) peripheral", |
| 265 | + "description": "Analog input (ADC) peripheral driver", |
266 | 266 | "friendly_name": "Analog Inputs"
|
267 | 267 | },
|
268 | 268 | "DEVICE_ANALOGOUT": {
|
269 |
| - "description": "Analog output (DAC) peripheral", |
| 269 | + "description": "Analog output (DAC) peripheral driver", |
270 | 270 | "friendly_name": "Analog Outputs"
|
271 | 271 | },
|
272 | 272 | "DEVICE_CAN": {
|
273 |
| - "description": "Controller Area Network (CAN) peripheral", |
| 273 | + "description": "Controller Area Network (CAN) peripheral driver", |
274 | 274 | "friendly_name": "CAN"
|
275 | 275 | },
|
276 | 276 | // mystery ARM feature, used only on reference designs (SPI related?)
|
|
280 | 280 | "hidden_from_docs": true
|
281 | 281 | },
|
282 | 282 | "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.", |
284 | 284 | "friendly_name": "Hardware CRC"
|
285 | 285 | },
|
286 | 286 | "DEVICE_DEBUG_AWARENESS": {
|
287 | 287 | "description": "Target supports awareness of whether semihost is attached",
|
288 | 288 | "friendly_name": "Semihost Debug Aware"
|
289 | 289 | },
|
290 | 290 | "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.", |
292 | 292 | "friendly_name": "Ethernet MAC"
|
293 | 293 | },
|
294 | 294 | "DEVICE_FLASH": {
|
295 | 295 | "description": "Driver allowing In-Application Programming (IAP) of the MCU flash memory.",
|
296 | 296 | "friendly_name": "Flash IAP"
|
297 | 297 | },
|
298 | 298 | "DEVICE_I2C": {
|
299 |
| - "description": "I2C in controller/master mode", |
| 299 | + "description": "I2C driver for synchronous (blocking) controller/master mode", |
300 | 300 | "friendly_name": "I2C Controller/Master"
|
301 | 301 | },
|
302 | 302 | "DEVICE_I2CSLAVE": {
|
303 |
| - "description": "I2C in peripheral/slave mode", |
| 303 | + "description": "I2C for interrupt-based peripheral/slave mode", |
304 | 304 | "friendly_name": "I2C Peripheral/Slave"
|
305 | 305 | },
|
306 | 306 | "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.", |
308 | 308 | "friendly_name": "Async I2C Controller/Master"
|
309 | 309 | },
|
310 | 310 | "DEVICE_INTERRUPTIN": {
|
311 | 311 | "description": "GPIO input pin interrupt support",
|
312 | 312 | "friendly_name": "GPIO Interrupts"
|
313 | 313 | },
|
314 | 314 | "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.", |
316 | 316 | "friendly_name": "ITM"
|
317 | 317 | },
|
318 | 318 | "DEVICE_LPTICKER": {
|
|
321 | 321 | },
|
322 | 322 | "DEVICE_MPU": {
|
323 | 323 | "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" |
325 | 325 | },
|
326 | 326 | "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.", |
328 | 328 | "friendly_name": "Octal SPI"
|
329 | 329 | },
|
330 | 330 | "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", |
332 | 332 | "friendly_name": "GPIO Port Input"
|
333 | 333 | },
|
334 | 334 | "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.", |
336 | 336 | "friendly_name": "GPIO Port I/O"
|
337 | 337 | },
|
338 | 338 | "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", |
340 | 340 | "friendly_name": "GPIO Port Output"
|
341 | 341 | },
|
342 | 342 | "DEVICE_PWMOUT": {
|
343 |
| - "description": "Pulse Width Modulation (PWM) generator peripheral", |
| 343 | + "description": "Pulse Width Modulation (PWM) generator peripheral driver", |
344 | 344 | "friendly_name": "PWM Out"
|
345 | 345 | },
|
346 | 346 | "DEVICE_QSPI": {
|
|
0 commit comments