CMSIS-Pack: Pack Description (*.pdsc) Format

| CMSIS-Pack Version 1.5.0 Delivery Mechanism for Software Packs

- Main Page
- Usage and Description

All Pages
Pack Description (*.pdsc) Format

The Pack Description (*.pdsc) Format uses standard XML annotations and is defined in the schema file PACK.xsd. Software components are distributed through Software Packs. A Software Pack is a zip file containing a single Pack Description file that describes dependencies to devices, processors, tool chains, or other software components.

A descriptive text of the Software Packalong the text information for devices, components, and examples is part of each a Pack Description (*.pdsc) file. In addition, information is provided which facilitates downloading, updating, and versioning of of a Software Pack. The *.pdsc file contains also the complete version history of the Software Pack with a brief list of the most significant changes.

# Filename Conventions

A Software Pack must have a unique filename which uses the following format: <vendor>.<name>.<version>.pack.

Where:

- <vendor>: name of the supplier or vendor of the Software Pack.
- <name>: name of the Software Pack. It is the vendor's responsibility to ensure unique package names.
- <release version="X.Y.Z">: version number of the Software Pack.
- .pack: file extension identifying a Software Pack.

Note
  <vendor> and <name> must not contain spaces.

The Pack Description (*.pdsc) file belonging to such a Software Pack file (<vendor>.<name>.<version>.pack) is version independent and has the format: <vendor>.<name>.pdsc.

Where:

- <vendor>: name of the supplier or vendor of the Software Pack.
- <name>: name of the Software Pack that is described by this *.pdsc file.
- .pack: file extension identifying a Software Pack.

Note
  <vendor> and <name> must not contain spaces.

Example filenames for software packs:

Software Pack for CMSIS Version 4.0 released by Arm.

- ARM.CMSIS.4.0.0.pack: filename of the Software Pack.
- ARM.CMSIS.pdsc: filename of the Pack Description (*.pdsc) file.

Device Family Pack for STM32F4 Version 1.0.0 released by ST Microelectronics.

- ST.STM32F4xx_DFP.1.0.0.pack: filename of the Software Pack.
- ST.STM32F4xx.pdsc: filename of the Pack Description (*.pdsc) file.

Note
  All elements are case sensitive and must be consistently spelled in all places, i.e. the definition in the PDSC file must match the filenames of the *.pdsc and *.pack files. The file extensions (*.pdsc and *.pack) must be lower case.

# Pack Schema

The XML schema file PACK.xsd defines the sections used in a *.pdsc file. The current PACK.xsd can be found in the ARM.CMSIS pack in the directory .\CMSIS\Utilities.

The Pack Description (*.pdsc) Format is structured using grouping elements and contains the following top level elements:

- <package>: describes package related information like vendor, package name, description, version. Is the root element.
- <keywords>: lists keywords to search for packages. Can be used for search engines.
- <repository>: specifies the URL and repository type of a public repository where the pack originates from.
- <releases>: lists release versions with descriptions.
- <requirements>: lists required packs, compiler, programming language standards and their version or version range.
- <taxonomy>: lists description elements that define component classes and component group names.
- <apis>: describes Application Programming Interfaces (API) Specifications contained in the Software Pack.
- <generators>: specifies the tools that have been used to generate the PDSC file.
- <devices>: lists the devices supported by this Software Pack. It specifies the device attributes and files like flash programming algorithms, CMSIS device header files, CMSIS System View Descriptions, etc.
- <boards>: lists the development boards supported by the Software Pack.
- <conditions>: defines dependencies to devices, processors, components, and tools that are used within the Software Pack. It allows making components and files conditional.
- <components>: lists the software components contained in the Software Pack.
- <examples>: specifies example projects contained in the PACK.

# Example of a *.pdsc File

This example of a *.pdsc File explains the sections, particularly how dependencies are used to identify individual files of Software Components.

Example of a *.pdsc File