Devices data


Devices data - schema (devices data model)

root anyOf item 0
Type: object

root anyOf item 0 version
Type: enum (of string)

Devices data - schema version (recommended 2.0.0)

Must be one of:

  • "2.0.0"

root anyOf item 0 fragments
Type: object

Separate device/board definitions

root anyOf item 0 fragments devices
Type: array of object

Device fragments

 No Additional Items

Each item of this array must be:

root anyOf item 0 fragments devices devices items
Type: object

root anyOf item 0 fragments devices devices items device
Type: object

Device specific information

 No Additional Properties

root anyOf item 0 fragments devices devices items device anyOf item 0
Type: object

The following properties are required:

  • id
root anyOf item 0 fragments devices devices items device anyOf item 1
Type: object

The following properties are required:

  • name

root anyOf item 0 fragments devices devices items device id
Type: string

Device id

root anyOf item 0 fragments devices devices items device name
Type: string

User-friendly device name

root anyOf item 0 fragments devices devices items device family
Type: string

Device family

root anyOf item 0 fragments devices devices items device memory
Type: array of object

Device memory map - flash/ram regions

 No Additional Items

Each item of this array must be:

root anyOf item 0 fragments devices devices items device memory memory items
Type: object

Memory region info

 No Additional Properties

root anyOf item 0 fragments devices devices items device memory memory items location
Type: string

Start address (format: hex)

Must match regular expression: ^0x([a-fA-F0-9])+$

root anyOf item 0 fragments devices devices items device memory memory items size
Type: string

Region size (format: hex)

Must match regular expression: ^0x([a-fA-F0-9])+$

root anyOf item 0 fragments devices devices items device memory memory items type
Type: enum (of string)

Memory type

Must be one of:

  • "Flash"
  • "ExtFlash"
  • "RAM"

root anyOf item 0 fragments devices devices items device memory memory items flash-driver
Type: string

Flash driver file name (*.cfx)

root anyOf item 0 fragments devices devices items device memory memory items core-names
Type: array of string

Cores specific memory region. If needed, must be one of the keys from devices.cores

 No Additional Items

Each item of this array must be:

root anyOf item 0 fragments devices devices items device memory memory items core-names core-names items
Type: string

root anyOf item 0 fragments devices devices items device cores
Type: array of object

Cores topology (ordered by access port or TAP)

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root anyOf item 0 fragments devices devices items device cores cores items
Type: object

Core information

 No Additional Properties

root anyOf item 0 fragments devices devices items device cores cores items name
Type: stringFormat: ^[A-Za-z0-9_\-]$

Core name, unique per device

root anyOf item 0 fragments devices devices items device cores cores items primary
Type: boolean

Is primary boot core. Only one core is allowed to be a primary boot core.

root anyOf item 0 fragments devices devices items device cores cores items index
Type: string

Core index, used to specify a custom value or to change the default index. (format: n or nap:ntap. Where nap = n divided by 16, ntap = nt modulo 16. n, nap, n_tap are decimal numbers.)
Examples:

"1"

"1:2"

root anyOf item 0 fragments devices devices items debug
Type: object

Debug specific information

 No Additional Properties

root anyOf item 0 fragments devices devices items debug core-options
Type: object or null

Debug specific core options. The key must be a core name from device.cores

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Za-z0-9_\-]$
root anyOf item 0 fragments devices devices items debug core-options ^[A-Za-z0-9_\-]$
Type: object

Debug information for this core

 No Additional Properties

root anyOf item 0 fragments devices devices items debug core-options ^[A-Za-z0-9_\-]$ cachelib
Type: string

I-Cache/D-Cache handler library

root anyOf item 0 fragments devices devices items debug connect-reset
Type: enum (of null or string)

Reset method on initial connection

Must be one of:

  • "system"
  • "core"
  • "default"
  • null

root anyOf item 0 fragments devices devices items debug flash-driver-reset
Type: enum (of null or string)

Reset method before running the RAM-loaded flash driver

Must be one of:

  • "system"
  • "core"
  • "soft"
  • null

root anyOf item 0 fragments devices devices items debug reset
Type: enum (of null or string)

Reset method used to start the image loaded into flash memory

Must be one of:

  • "system"
  • "core"
  • "soft"
  • null

root anyOf item 0 fragments devices devices items debug preattach-script
Type: string or null

Pre-attach script

root anyOf item 0 fragments devices devices items debug preconnect-script
Type: string or null

Pre-connect script

root anyOf item 0 fragments devices devices items debug connect-script
Type: string or null

Connect script

root anyOf item 0 fragments devices devices items debug reset-script
Type: string or null

Reset script

root anyOf item 0 fragments devices devices items debug masserase-script
Type: string or null

Mass erase script

root anyOf item 0 fragments devices devices items debug bootromstall
Type: string or null

BootROM stall address (format: hex)

Must match regular expression: ^0x([a-fA-F0-9])+$

root anyOf item 0 fragments devices devices items debug romstalldelay
Type: integer or null

BootROM stall delay in milliseconds
Example:

200

root anyOf item 0 fragments devices devices items debug no-flash-hashing
Type: boolean or null Default: false

Disable flash hashing (enabled by default)

root anyOf item 0 fragments devices devices items debug no-packed
Type: boolean or null Default: false

Debug Access Port (DAP) does not support packed transfers

root anyOf item 0 fragments devices devices items debug dapstride
Type: enum (of null or string)

DAP stride

Must be one of:

  • "auto"
  • "standard"
  • "long"
  • "short"
  • null

root anyOf item 0 fragments devices devices items debug apindex-limit
Type: integer or null

DAP AP index limit

root anyOf item 0 fragments devices devices items debug apindex-min
Type: integer or null

DAP AP index minimum value (start)

root anyOf item 0 fragments devices devices items debug apindexes-allowed
Type: array of integer or null

A list of DAP AP indexes allowed

Must contain a minimum of 1 items

Must contain a maximum of 256 items

No Additional Items

Each item of this array must be:

root anyOf item 0 fragments devices devices items debug apindexes-allowed apindexes-allowed items
Type: integer

DAP AP index

Value must be greater or equal to 0 and lesser or equal to 255

root anyOf item 0 fragments devices devices items debug jtag-taps-irlen
Type: array of integer or null

A list of custom JTAG TAPs IR length

Must contain a minimum of 1 items

Must contain a maximum of 8 items

No Additional Items

Each item of this array must be:

root anyOf item 0 fragments devices devices items debug jtag-taps-irlen jtag-taps-irlen items
Type: integer

TAP IR length

Value must be greater or equal to 1 and lesser or equal to 255

root anyOf item 0 fragments devices devices items debug unlock-keys
Type: array of string or null

A list of debug 32-bit unlock keys

Must contain a minimum of 1 items

Must contain a maximum of 8 items

No Additional Items

Each item of this array must be:

root anyOf item 0 fragments devices devices items debug unlock-keys unlock-keys items
Type: string

32-bit unlock key (format: hex)

Must match regular expression: ^0x([a-fA-F0-9]{1,8})$

root anyOf item 0 fragments devices devices items debug no-uninit-on-close
Type: boolean or null

Don't shutdown DAP when closing the probe

root anyOf item 0 fragments devices devices items debug protocol
Type: enum (of null or string) Default: "swd"

Debug protocol

Must be one of:

  • "swd"
  • "jtag"
  • null

root anyOf item 0 fragments devices devices items debug swo
Type: boolean or null

Has SWO

root anyOf item 0 fragments devices devices items debug wirespeed
Type: integer or null

Wire speed in Hz

root anyOf item 0 fragments devices devices items debug bootconfigs
Type: object or null

Boot configurations (name:<data> pairs) aimed to be used with MCU-Link on-board probes. <data> is a string of 4 characters ('x', '1' or '0') describing how each ISP_CTRL[3..0] pin should be handled.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Za-z0-9_-]*$
root anyOf item 0 fragments devices devices items debug bootconfigs ^[A-Za-z0-9_-]*$
Type: string

<data> for this boot configuration name

Must match regular expression: ^[x01]{4}$

root anyOf item 0 fragments boards
Type: array of object

Board fragments

 No Additional Items

Each item of this array must be:

root anyOf item 0 fragments boards boards items
Type: object

root anyOf item 0 fragments boards boards items board
Type: object

Board data

 No Additional Properties

root anyOf item 0 fragments boards boards items board id
Type: string

Board id. It can be an empty string if board id is not needed.

root anyOf item 0 fragments boards boards items board memory
Type: array of object

Device memory map - flash/ram regions

Same definition as memory

root anyOf item 0 fragments boards boards items compatible-devices
Type: array of object

List of devices that can be paired with this board

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root anyOf item 0 fragments boards boards items compatible-devices compatible-devices items
Type: object

root anyOf item 0 device-dataset
Type: array of object

List of standalone device & board pairs

 No Additional Items

Each item of this array must be:

root anyOf item 0 device-dataset device-dataset items
Type: object

Device-Board data

 No Additional Properties

root anyOf item 0 device-dataset device-dataset items device
Type: object

Device specific information

Same definition as device

root anyOf item 0 device-dataset device-dataset items debug
Type: object

Debug specific information

Same definition as debug
root anyOf item 1
Type: object

Deprecated

root anyOf item 1 version
Type: enum (of string)

Devices data - schema version (recommended 1.1.2)

Must be one of:

  • "1.1.2"
  • "1.1.1"
  • "1.1.0"
  • "1.0.0"
  • "0.0.1"

root anyOf item 1 devices
Type: array of object

List of devices

 No Additional Items

Each item of this array must be:

root anyOf item 1 devices devices items
Type: object

Device data

 No Additional Properties

root anyOf item 1 devices devices items board
Type: string

Board name. It can be an empty string if board name is not needed.

root anyOf item 1 devices devices items device

Device specific information

 No Additional Properties

root anyOf item 1 devices devices items device anyOf item 0
Type: object

The following properties are required:

  • id
root anyOf item 1 devices devices items device anyOf item 1
Type: object

The following properties are required:

  • name

root anyOf item 1 devices devices items device id
Type: string

Device id

root anyOf item 1 devices devices items device name
Type: string

User-friendly device name

root anyOf item 1 devices devices items device family
Type: string

Device family

root anyOf item 1 devices devices items device memory
Type: array of object

Device memory map - flash/ram regions

 No Additional Items

Each item of this array must be:

root anyOf item 1 devices devices items device memory memory items
Type: object

Memory region info

 No Additional Properties

root anyOf item 1 devices devices items device memory memory items location
Type: string

Start address (format: hex)

Must match regular expression: ^0x([a-fA-F0-9])+$

root anyOf item 1 devices devices items device memory memory items size
Type: string

Region size (format: hex)

Must match regular expression: ^0x([a-fA-F0-9])+$

root anyOf item 1 devices devices items device memory memory items type
Type: enum (of string)

Memory type

Must be one of:

  • "Flash"
  • "ExtFlash"
  • "RAM"

root anyOf item 1 devices devices items device memory memory items flash-driver
Type: string

Flash driver file name (*.cfx)

root anyOf item 1 devices devices items device memory memory items core-name
Type: string

Cores specific memory region. If needed, must be one of the keys from devices.cores

root anyOf item 1 devices devices items device cores
Type: array of object

Cores topology (ordered by access port or TAP)

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root anyOf item 1 devices devices items device cores cores items
Type: object

Core information

 No Additional Properties

root anyOf item 1 devices devices items device cores cores items name
Type: stringFormat: ^[A-Za-z0-9_\-]$

Core name, unique per device

root anyOf item 1 devices devices items device cores cores items primary
Type: boolean

Is primary boot core. Only one core is allowed to be a primary boot core.

root anyOf item 1 devices devices items device cores cores items index
Type: string

Core index, used to specify a custom value or to change the default index. (format: n or nap:ntap. Where nap = n divided by 16, ntap = nt modulo 16. n, nap, n_tap are decimal numbers.)
Examples:

"1"

"1:2"

root anyOf item 1 devices devices items debug
Type: object

Debug specific information

Same definition as debug

The following properties are required:

root license
Type: string

Devices data - SPDX-License-Identifier: BSD-3-Clause

root vendor
Type: string

Devices data - vendor