metadata¶
Required: No
Type: Map of metadata information
Condition: No
Metadata about the component provided to tooling to assist in filtering, etc.
Allowed keys include
device- Information about a device described by this componentboard- Information about a board described by this componenthardware- Information about hardware described by this componenttoolchain- Informatoion about a build tool described by this componentpin_tool- Pin Tool metadata for this componentzap- ZAP metadata for this component
The SLC specification does not require these keys to have any specific content, as this is left up to the implementation.
Simplicity Studio Metadata Schema¶
The Simplicity Studio and SLC-CLI implementations of the SLC specification require the following metadata content for proper operation:
device¶
| Key | Required | Type | Description |
|---|---|---|---|
opn |
Yes | String | Orderable Part Name of the device |
memory |
Yes | List of maps | Definition of memory sections of the device. Each entry has a name, start, size, type and optionally a page_size. |
board¶
| Key | Required | Type | Description |
|---|---|---|---|
pn |
Yes | String | Product Name of the board |
variant |
Yes | String | Variant of the board |
revision |
Yes | String | Revision number of the board |
kit¶
| Key | Required | Type | Description |
|---|---|---|---|
opn |
Yes | String | Orderable Part Name of the development kit |
pn |
Yes | String | Product Number of the development kit |
variant |
Yes | String | Variant of the development kit |
revision |
Yes | String | Revision number of the development kit |
toolchain¶
| Key | Required | Type | Description |
|---|---|---|---|
id |
No | String | ID of the toolchain. gcc or iar. |
variant |
No | String | Variant of the toolchain. arm or host. |
pin_tool¶
| Key | Required | Type | Description |
|---|---|---|---|
peripheral |
Yes | List of strings | Peripherals configurable by this component. Used to list compatible components for a hardware peripheral selected in the Pin Tool. |