CMSIS-Pack  Version 1.5.0
Delivery Mechanism for Software Packs
 All Pages
/package/boards element

The level <boards> describes a development board that is the subject of a Board Support Pack (BSP). It contains information about the board vendor and name, a brief description, images to be displayed on web pages, and different types of documentation. The microcontroller devices that are mounted on the board or that are compatible with the ones mounted are also specified. A list of features concludes the <boards> section.

A development board is described by the following properties:

  • description: a brief description of the development board
  • book: documentation about the board (user manuals, schematics, etc.)
  • mountedDevice: the microcontroller device mounted on the development board.
  • compatibleDevice: compatible microcontroller devices.
  • image: pictures of the board to be displayed on web pages.
  • feature: categorized list of the development board's features and peripherals.
  • debugInterface: describing the debug capabilities.

Example

<boards>
<board vendor="STMicroelectronics" name="32F429IDISCOVERY" revision="Rev.1" salesContact="http://www.st.com/stonline/contactus/contacts/index.php" orderForm="https://my.st.com/esample/app?page=basket&amp;pn=STM32F429I-DISCO">
<description>STMicroelectronics STM32F429I Discovery Board Support and Examples</description>
<image small="Images/stm32f429i-disco_small.png" large="Images/stm32f429i-disco.png"/>
<book category="overview" name="http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1199/PF259090" title="32F429IDISCOVERY Web Page"/>
<book category="setup" name="Documents/UM1662.pdf" title="Getting Started"/>
<book category="schematic" name="Documents/UM1670.pdf" title="Schematics"/>
<book category="manual" name="Documents/UM1670.pdf" title="User Manual"/>
<mountedDevice deviceIndex="0" Dvendor="STMicroelectronics:13" Dname="STM32F429ZI"/>
<compatibleDevice deviceIndex="0" Dvendor="STMicroelectronics:13" Dfamily="STM32F4 Series" DsubFamily="STM32F429 Line"/>
<feature type="ODbg" n="1" name="On-board ST-LINK/V2 with selection mode switch to use the kit as a standalone"/>
<feature type="XTAL" n="80000000"/>
<feature type="PWR" n="5" name="USB Powered"/>
<feature type="PWR" n="3" m="5" name="External Supply"/>
<feature type="RAM" n="1" name="64 MBit SDRAM"/>
<feature type="DIO" n="4" m="32" name="Extension header for LQFP144 with 2.54 mm Pitch"/>
<feature type="USB" n="1" name="High-Speed USB OTG with micro-AB Connector"/>
<feature type="ConnOther" n="1" name="JP3 (Idd) for current measurement"/>
<feature type="Button" n="2" name="Push-buttons: User and Reset"/>
<feature type="Gyro" n="1" name="L3GD20, ST MEMS motion sensor, 3-axis digital output gyroscope"/>
<feature type="LED" n="6" name="Com, 3.3 V Power, Two user, Two USB OTG LEDs"/>
<feature type="CustomFF" n="66" m="119.3" name="Discovery Board Formfactor"/>
<feature type="GLCD" n="1" m="240.320" name="2.4 inch QVGA TFT LCD"/>
<debugInterface adapter="ST-Link" connector="Mini-USB"/>
</board>
</boards>

 


/package/boards

Grouping element for boards. No more than one such group can exist in a PACK. None is required.

Parent Chain
package /package
Child Elements Description Type Occurrence
board Description of the board BoardType 1..*

 


/package/boards/board

This element provides information to specify the Board Support Package (BSP). At least one board must be defined.

Parent Chain
boards /package/boards
Attributes Description Type Use
vendor name of the board vendor xs:string required
name name of the development board xs:string required
revision Revision of the board that is suited to be used with the BSP. xs:string optional
salesContact Either an email address or web page to contact the sales department. xs:string optional
orderForm Link to a web page for ordering the development board. xs:anyURI optional
Child Elements Description Type Occurrence
description Brief summary of the board xs:string 1
feature Describes the features of the development board. BoardsFeatureType 1..*
mountedDevice Specifies the microcontroller device mounted on the development board. BoardsDeviceType 1..*
compatibleDevice Specifies compatible microcontroller devices. CompatibleDeviceType 1..*
image Carries pictures of the boards to be displayed on web pages. Directory and file names are case-sensitive. ComplexType 0..1
debugInterface Describes the debug interface of the development board. DebugInterfaceType 1..*
book Describes the documentation files (user manuals, schematics, etc.). Directory and file names are case-sensitive. BoardsBookType 1..*

 


/package/boards/board/feature

This element contains information about the features and capabilities of a board. A list of pre-defined features exists.

Example

<feature type="PWR" n="3" m="5" name="Element: Board feature"/>

 

Parent Chain
board /package/boards/board
Attributes Description Type Use
type Defines board features. Select predefined values from the table Board Features. BoardFeatureTypeEnum required
n Depends on attribute type. Check table Board Features for details. xs:decimal optional
m Depends on attribute type. Check table Board Features for details. xs:decimal optional
name Descriptive name of the feature. If omitted, a Default Name is used (refer to table Board Feature Types). Do not repeat the n or m values in the name. This will lead to duplicate entries on web sites (they show n x name). xs:string optional

 

Table: Board Features

The table below lists predefined board features.

Note
  • The attribute name of the element /package/boards/board/feature is a descriptive text for a feature. If name is omitted, the Default Name (listed below) is used.
  • Do not repeat the n or m values in the name. Display on websites follows the rule to show n x name.
type=n=m=Default NameExampleExample shown as
ODbgNumber of Debug AdaptersN/AIntegrated Debug Adapter<feature type="ODbg" n="1" name="Integrated ST-Link on USB Connector J13"/>1 x Integrated ST-Link on USB Connector J13
XTALOscillator FrequencyN/ACrystal Oscillator<feature type="XTAL" n="8000000"/>8 MHz Crystal Oscillator
PWRMinimum Input VoltageMaximum Input VoltagePower Supply<feature type="PWR" n="8" m="12"/>8 V - 12 V Power Supply
PWRSockNumber of Power SocketsN/APower Socket<feature type="PWRSock" n="1" name="Coaxial Power Receptacle"/>1 x Coaxial Power Receptacle
BattNumber of BatteriesN/ABattery<feature type="Batt" n="1" name="CR2032 Battery for RTC"/>1 x CR2032 Battery for RTC
CurrTypical CurrentMaximum CurrentCurrent<feature type="Curr" n="0.320" m="0.375"/>320 mA (typ), 375 mA (max) Current
CoreOtherNumber of FeaturesN/AOther Core Feature<feature type="CoreOther" n=1 name="My Other Core Feature"/>1 x My Other Core Feature
RAMNumber of RAMsN/ARAM<feature type="RAM" n="1" name="512 kB Static RAM"/>1 x 512 kB Static RAM
ROMNumber of ROMsN/AFlash<feature type="ROM" n="1" name="4 MB NAND-Flash"/>1 x 4 MB NAND-Flash
MemoryNumber of Additional MemoryN/AMemory<feature type="Memory" n="128" name="EEPROM"/>128 byte EEPROM
MemCardNumber of Card HoldersN/ASD/microSD/MMC Card Holder<feature type="MemCard" n="2" name="SD Card Holder"/>2 x SD Card Holder
MemoryOtherNumber of Other MemoryN/AOther Memory Type<feature type="MemoryOther" n="1" name="1 kB MRAM"/>1 x 1 kB MRAM
DIONumber of Digital I/OsN/ADigital I/Os<feature type="DIO" n="26" name="Digital IOs on 2 x 13 pin header (1.27 mm pitch)"/>26 x Digital IOs on 2 x 13 pin header (1.27 mm pitch)
AIONumber of Analog I/OsN/AAnalog I/Os<feature type="AIO" n="4" name="Analog Inputs on 4 pin header (1.27 mm pitch)"/>4 x Analog Inputs on 4 pin header (1.27 mm pitch)
Proton Rowsm ColumnsPrototyping Area<feature type="Proto" n="4" m="7" name="Prototyping Area with 1.00 mm pitch"/>4 x 7 Prototyping Area with 1.00 mm pitch
USBNumber of USB ConnectorsN/AUSB<feature type="USB" n="2" name="Full-Speed USB Device, Micro-B receptacle"/>2 x Full-Speed USB Device, Micro-B receptacle
ETHNumber of Ethernet ConnectorsData Rate in Bit/sEthernet<feature type="ETH" n="1" m="10000000" name="RJ45 Receptacle"/>1 x 10 Mbit/s RJ45 Receptacle
SPINumber of SPI ConnectorsN/ASPI<feature type="SPI" n="1" name="4-Pin Header, 1.27 mm Pitch"/>1 x 4-Pin Header, 1.27 mm Pitch
I2CNumber of I2C ConnectorsN/AI2C<feature type="I2C" n="1" name="2-Pin Header, 1.27 mm Pitch"/>1 x 2-Pin Header, 1.27 mm Pitch
RS232Number of RS232 ConnectorsN/ARS232<feature type="RS232" n="1" name="DB9 Male Connector"/>1 x DB9 Male Connector
RS422Number of RS422 ConnectorsN/ARS422<feature type="RS422" n="1" name="4-Pin Header, 1.27 mm Pitch"/>1 x 4-Pin Header, 1.27 mm Pitch
RS485Number of RS485 ConnectorsN/ARS485<feature type="RS485" n="1" name="DB9 Male Connector"/>1 x DB9 Male Connector
CANNumber of CAN ConnectorsN/ACAN<feature type="CAN" n="1" name="DB9 Male Connector"/>1 x DB9 Male Connector
IrDANumber of IrDA DiodesN/ADiode<feature type="IrDA" n="1" name="Diode Transceiver"/>1 x Diode Transceiver
LineInNumber of Line In JacksN/ALine In<feature type="LineIn" n="1" name="TRS Audio Jack"/>1 x TRS Audio Jack
LineOutNumber of Line Out JacksN/ALine Out<feature type="LineOut" n="1" name="TRS Audio Jack"/>1 x TRS Audio Jack
MICNumber of Microphone JacksN/AMicrophone<feature type="MIC" n="1" name="TS Audio Jack (Mono)"/>1 x TS Audio Jack (Mono)
Edgen Rowsm ColumnsEdge<feature type="Edge" n="2" m="24"/>2 x 24 Pin Edge
ConnOtherNumber of Other ConnectorsN/AOther Connector Type<feature type="ConnOther" n="1" name="My Other Connector"/>1 x My Other Connector
ButtonNumber of Push-ButtonsN/APush-buttons<feature type="Button" n="3" name="Push-buttons: Reset, Wake Up, User"/>3 Push-buttons: Reset, Wake Up, User
PotiNumber of PotentiometerN/APotentiometer<feature type="Poti" n="1"/>1 x Potentiometer
JoystickNumber of JoysticksN/AJoystick<feature type="Joystick" n="1" name="5-position Joystick"/>1 x 5-position Joystick
TouchNumber of Touch KeysN/ATouch Keys/Area<feature type="Touch" n="1"/>1 x Touch Keys/Area
ContOtherNumber of Other ControlsN/AOther Control<feature type="ContOther" n=1 name="My Other Control Feature"/>1 x My Other Control Feature
AccelerometerNumber of AccelerometerN/AAccelerometer<feature type="Accelerometer" n="1" name="3-axis digital Accelerometer"/>1 x 3-axis digital Accelerometer
GyroNumber of GyroscopesN/AGyroscope<feature type="Gyro" n="1" name="3-axis digital Gyroscope"/>1 x 3-axis digital Gyroscope
CompassNumber of CompassN/ADigital Compass<feature type="Compass" n="1" name="High-Precision Digital Compass"/>1 x High-Precision Digital Compass
TempSensNumber of Temperature SensorsN/ATemperature Sensor<feature type="TempSens" n="1"/>1 x Temperature Sensor
PressSensNumber of Pressure SensorsN/APressure Sensor<feature type="PressSens" n="1"/>1 x Pressure Sensor
LightSensNumber of Light SensorsN/AAmbient Light Sensor<feature type="LightSens" n="1"/>1 x Ambient Light Sensor
SensOtherNumber of Other SensorsN/AOther Sensor<feature type="SensOther" n=1 name="My Other Sensor Feature"/>1 x My Other Sensor Feature
CustomFFx [mm]y [mm]Custom Formfactor<feature type="CustomFF" n="54" m="26" name="40-Pin DIP with 0.1-inch Pitch"/>54 mm x 26 mm, 40-Pin DIP with 0.1-inch Pitch
ArduinoFF1N/AArduino Formfactor<feature type="ArduinoFF" n="1"/>Arduino Formfactor
FreedomFF1N/AFreedom Formfactor<feature type="FreedomFF" n="1"/>Freedom Formfactor
TowerFF1N/ATower Formfactor<feature type="TowerFF" n="1"/>Tower Formfactor
LEDNumber of LEDsN/ALEDs<feature type="LED" n="3" name="Multicolor LEDs"/>3 x Multicolor LEDs
CameraNumber of Camera InterfacesN/ACamera<feature type="Camera" n="1" name="Digital VGA Camera"/>1 x Digital VGA Camera
LCDNumber of Segment LCD ControllerCom.Seg as a decimal number (see example)LCD<feature type="LCD" n="1" m="16.40" name="Segment LCD Controller"/>1 x 16 x 40 Segment LCD Controller
GLCDNumber of Graphic LCD ControllerMaximum Resolution as a decimal number (see example)GLCD<feature type="GLCD" n="1" m="320.240" name="2.4 inch Color TFT LCD with resistive touchscreen"/>320 x 240 Pixel 2.4 inch Color TFT LCD with resistive touchscreen
SpeakerNumber of SpeakersN/ASpeaker<feature type="Speaker" n="1"/>1 x Speaker
OtherNumber of Other FeaturesN/AOther Feature<feature type="Other" n=1 name="My Other Feature"/>1 x My Other Feature

 


/package/boards/board/mountedDevice

The element specifies the devices mounted on the board. At least one device must be specified.

Example

<mountedDevice deviceIndex="0" Dvendor="STMicroelectronics:13" Dname="STM32F429ZI"/>

 

Parent Chain
board /package/boards/board
Attributes Description Type Use
deviceIndex Index number of the device (in case more than one device is present on the board). xs:string optional
Dvendor Is the name of vendor of the device specified by Dname. Use predefined values as listed in the table Device Vendor. DeviceVendorEnum required
Dfamily Is the name of the target device family used on the board. xs:string optional
DsubFamily Is the name of the target device sub family used on the board. xs:string optional
Dname Is the name of the target device used on the board. xs:string optional

 


/package/boards/board/compatibleDevice

This element contains information about devices that are compatible to the device used on the board. Compatible means that the user is able to generate code for compatible devices and test it on the development board. At least one compatible device must be specified.

Example

<compatibleDevice deviceIndex="0" Dvendor="STMicroelectronics:13" Dfamily="STM32F4 Series" DsubFamily="STM32F429 Line"/>

 

Parent Chain
board /package/boards/board
Attributes Description Type Use
deviceIndex Index number of the device (in case more than one device is present on the board). xs:string optional
Dvendor Vendor name of the target device specified by Dname. Use predefined values as listed in the table Device Vendor. This element is required if at least one of the following attributs is defined: Dname, DsubFamily, Dfamily. DeviceVendorEnum optional
Dfamily Name of the target device family used on the board. Requires Dvendor to be specified. xs:string optional
DsubFamily Name of the target device sub-family used on the board. Requires Dvendor to be specified. xs:string optional
Dname Name of the target device used on the board. Requires Dvendor to be specified. xs:string optional

 


/package/boards/board/image

This element specifies the picture of a development board. Maximum one image element can be specified. None must be specified. Two different picture types (small and large) can be specified for the same image element at the same time.

Example:

<image small="Images\board_image_small.png" large="Images\board_image.png"/>

 

Parent Chain
board /package/boards/board
Attributes Description Type Use
small Specifies the path to a small image. The path is relative to the PACK base directory. xs:string optional
large Specifies the path to a large image. The path is relative to the PACK base directory. xs:string optional

 


/package/boards/board/debugInterface

This element describes the debug interface of a board. At least debug interface must be specified.

Example

<debugInterface adapter="JTAG/SW" connector="20-pin ARM Standard JTAG Connector (0.1 inch connector)"/>
<debugInterface adapter="JTAG/SW" connector="10-pin Cortex Debug Connector (0.05 inch connector)"/>
<debugInterface adapter="JTAG/SW" connector="20-pin Cortex Debug + ETM Connector (0.05 inch connector)"/>
<debugInterface adapter="ST-Link" connector="Mini-USB"/>

 

Parent Chain
board /package/boards/board
Attributes Description Type Use
adapter String describing the debug adapter. Common adapters are: JTAG/SW (for all adapters supporting JTAG and Serial-Wire Debug), CMSIS-DAP, OpenSDA, J-Link, ST-Link, Nu-Link. xs:string optional
connector String describing the debug connector. Usually one of these: 10-pin Cortex Debug Connector, 20-pin ARM Standard JTAG Connector, 20-pin Cortex Debug + ETM Connector, Mini-USB, Micro-USB. xs:string optional

 


/package/boards/board/book

The element provides information about documentation parts related to a development board. At least one book must be defined.

Example

<book category="setup" name="Documents/UM1662.pdf" title="Getting Started"/>

 

Parent Chain
board /package/boards/board
Attributes Description Type Use
category Describes the type of documentation. Use predefined values as defined in the table Board Book Categories. BoardBookCategoryEnum optional
name Is the name of the document (including the path within the Pack). xs:string optional
title Is the title of the document to be displayed in the Books window of uVision. xs:string optional

 

Table: Board Book Categories

The table lists values to identify a specific type of documentation for development boards.

category= Description
setup Documentation about how to setup the development board.
schematic Schematics of the development board.
overview Overview/data sheet of the development board.
manual User manual of the development board
layout PCB layout file of the board (e.g. in Gerber format)
other All other documentation.