![]() |
CMSIS-Pack
Version 1.3
Delivery Mechanism for Software Packs
|
The element /package/generators/generator specifies a generator tool that has been used to create a Generator PDSC (GPDSC) file. A description of the tool is supplied together with the device vendor and the device name that is required for the GPDSC to work. The command to launch the generator that created the GPDSC is given. All project files that have been generated by the tool are also included. The description can also specify generated components. Such components are mandatory for the project and conditions can be used to mandate other components to be selected as well.
Example Generator Section
Example Generator Package Description File (gpdsc)
Grouping element for generators. No more than one such group can exist in a PACK. None such group must exist.
Parent | Chain | ||
---|---|---|---|
package | /package | ||
Child Elements | Description | Type | Occurrence |
generator | Description of the generator and the related files | GeneratorType | 1..* |
The generator section is used to provide the details about the tool that has been used to create the GPDSC file. At least one generator element must exist.
Parent | Chain | ||
---|---|---|---|
generators | /package/generators | ||
Attributes | Description | Type | Use |
id | Identifier of the generator tool. Can be used by other elements to determine the generator. | xs:string | required |
Gvendor | Vendor name of the generator tool. | xs:string | optional |
Gtool | Plain text name of the generator. | xs:string | optional |
Gversion | Version of the generator tool. | xs:string | optional |
Child Elements | Description | Type | Occurrence |
description | Briefly describes the generator tool. | xs:string | 0..1 |
select | Complex type describing a device specifying device name, vendor, and variant. | GeneratorSelectType | 0..1 |
command | Invocation command for the generator tool. (see examples on top of the page) | xs:string | 0..1 |
project_files | Grouping element for all project files generated by the tool. | group | 0..1 |
files | Grouping element for generator tool files. | group | 0..1 |
extensions | Generator vendor specific section ignored by other tools | N/A | 0..1 |
This element contains information about the device and vendor that has been used to generate the GPDSC file. Maximum one such element can exist.
Example:
Parent | Chain | ||
---|---|---|---|
generator | /package/generators/generator | ||
Attributes | Description | Type | Use |
Dvendor | Vendor name of the target device. Use predefined values as listed in the table Device Vendor. | DeviceVendorEnum | required |
Dname | Name of the target device. | xs:string | optional |
Dvariant | Name of a device variant. | xs:string | optional |
The group project_files specifies all files that are required for the project setup. Maximum one such group can exist.
Example
Parent | Element Chain | ||
---|---|---|---|
generator | /package/generators/generator | ||
Child Elements | Description | Type | Occurrence |
file | Frame for files created by the generator and used in a project. | group | 0..1 |
The group files specifies files that are required by the generator tool. Maximum one such group can exist.
Example
Parent | Element Chain | ||
---|---|---|---|
generator | /package/generators/generator | ||
Child Elements | Description | Type | Occurrence |
file | Frame for files used by the generator. | group | 0..1 |
This element contains information about files used by a generator.
Example
Parent | Element Chain | ||
---|---|---|---|
files | /package/generators/generator/files | ||
Attributes | Description | Type | Use |
condition | Reference using the name of the respective condition specified in the conditions section of this package (/package/conditions). If the condition resolves to false, then the element will be ignored and treated as if not present. | xs:string | optional |
category | Describes the file type (for example: doc, header, library). You can use predefined values as listed in the table File Categories, however, this is not mandatory. | xs:string | required |
name | Can consist of the path (relative to the PACK base directory) and the file name with extension. | xs:string | required |
version | File-specific version information. The version format is described in Version Type. | VersionType | optional |