diff options
| author | Ali Labbene <ali.labbene@st.com> | 2019-12-11 08:59:21 +0100 |
|---|---|---|
| committer | Ali Labbene <ali.labbene@st.com> | 2019-12-16 16:35:24 +0100 |
| commit | 9f95ff5b6ba01db09552b84a0ab79607060a2666 (patch) | |
| tree | 8a6e0dda832555c692307869aed49d07ee7facfe /docs/Pack/html/cpdsc_pg.html | |
| parent | 76177aa280494bb36d7a0bcbda1078d4db717020 (diff) | |
| download | st-cmsis-core-lowfat-9f95ff5b6ba01db09552b84a0ab79607060a2666.tar.gz st-cmsis-core-lowfat-9f95ff5b6ba01db09552b84a0ab79607060a2666.tar.bz2 st-cmsis-core-lowfat-9f95ff5b6ba01db09552b84a0ab79607060a2666.zip | |
Official ARM version: v5.4.0
Add CMSIS V5.4.0, please refer to index.html available under \docs folder.
Note: content of \CMSIS\Core\Include has been copied under \Include to keep the same structure
used in existing projects, and thus avoid projects mass update
Note: the following components have been removed from ARM original delivery (as not used in ST packages)
- CMSIS_EW2018.pdf
- .gitattributes
- .gitignore
- \Device
- \CMSIS
- \CoreValidation
- \DAP
- \Documentation
- \DoxyGen
- \Driver
- \Pack
- \RTOS\CMSIS_RTOS_Tutorial.pdf
- \RTOS\RTX
- \RTOS\Template
- \RTOS2\RTX
- \Utilities
- All ARM/GCC projects files are deleted from \DSP, \RTOS and \RTOS2
Change-Id: Ia026c3f0f0d016627a4fb5a9032852c33d24b4d3
Diffstat (limited to 'docs/Pack/html/cpdsc_pg.html')
| -rw-r--r-- | docs/Pack/html/cpdsc_pg.html | 753 |
1 files changed, 753 insertions, 0 deletions
diff --git a/docs/Pack/html/cpdsc_pg.html b/docs/Pack/html/cpdsc_pg.html new file mode 100644 index 0000000..d650397 --- /dev/null +++ b/docs/Pack/html/cpdsc_pg.html @@ -0,0 +1,753 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<title>Project Description (*.cpdsc) Format</title> +<title>CMSIS-Pack: Project Description (*.cpdsc) Format</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="cmsis.css" rel="stylesheet" type="text/css" /> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<script type="text/javascript" src="printComponentTabs.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 46px;"> + <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">CMSIS-Pack +  <span id="projectnumber">Version 1.5.0</span> + </div> + <div id="projectbrief">Delivery Mechanism for Software Packs</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<div id="CMSISnav" class="tabs1"> + <ul class="tablist"> + <script type="text/javascript"> + <!-- + writeComponentTabs.call(this); + //--> + </script> + </ul> +</div> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and Description</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('cpdsc_pg.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="headertitle"> +<div class="title">Project Description (*.cpdsc) Format </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The CPDSC format provides the XML elements for defining CMSIS software projects. The CPDSC file content is considered static, so you do not have to keep the projects synchronized.</p> +<p>The scope of the description includes:</p> +<ul> +<li>CMSIS Run-Time Environment configuration (RTE)</li> +<li>Project build, including linker script generation</li> +<li>Flash programming</li> +<li>Basic configuration of debug probs</li> +</ul> +<p>The project format creates a basic project configuration and does not reflect tool-specific features or configurations. The import and conversion from the CPDSC format into a toolchain-specific format is the responsibility of the tool vendor.</p> +<h1><a class="anchor" id="cpdsc_definition"></a> +Definition of CMSIS project</h1> +<p>A CMSIS software project is a collection of files in a directory structure. The CPDSC file is located in the base folder of the directory structure. Only one CPDSC file is allowed. A CPDSC file can describe one or more projects.</p> +<p><b>Example</b> CMSIS Project Description File (*.cpdsc): </p> +<div class="fragment"><div class="line"><?xml version=<span class="stringliteral">"1.0"</span> encoding=<span class="stringliteral">"UTF-8"</span> standalone=<span class="stringliteral">"no"</span> ?></div> +<div class="line"><<span class="keyword">package </span>xmlns:xsi="http:<span class="comment">//www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="PACK.xsd"></span></div> +<div class="line"> <vendor>Keil</vendor></div> +<div class="line"> <name>STM32F407_Flash</name></div> +<div class="line"> <description>CMSIS RTOS Blinky for STM32F407 microcontroller using Keil 'MCBSTM32F400 Evaluation Board.</description></div> +<div class="line"> <url>www.keil.com/pack/Keil.STM32F4xx_DFP.pdsc</url></div> +<div class="line"></div> +<div class="line"> <releases></div> +<div class="line"> <release version="5.25.1">Generated 2018-02-20T09:10:26</release></div> +<div class="line"> </releases></div> +<div class="line"></div> +<div class="line"> <requirements></div> +<div class="line"> <packages></div> +<div class="line"> <package name="CMSIS" vendor="ARM"/></div> +<div class="line"> <package name="MDK-Middleware" vendor="Keil"/> </div> +<div class="line"> <package name="STM32F4xx_DFP" vendor="Keil"/></div> +<div class="line"> </packages></div> +<div class="line"> </requirements></div> +<div class="line"></div> +<div class="line"> <create></div> +<div class="line"> <project></div> +<div class="line"> <target Ddsp="NO_DSP" Dendian="Little-endian" Dfpu="SP_FPU" Dname="STM32F407IGHx" Dtz="NO_TZ" Dvendor="STMicroelectronics:13"></div> +<div class="line"> <output debug="1" name="Blinky" type="exe"/></div> +<div class="line"> <debugProbe coreClock="10000000" name="ULINK2" protocol="swd"/></div> +<div class="line"> <memory access="rx" default="1" name="IROM1" size="0x100000" start="0x8000000" startup="1"/></div> +<div class="line"> <memory access="rw" default="1" init="1" name="IRAM1" size="0x20000" start="0x20000000"/></div> +<div class="line"> <memory access="rw" default="0" init="1" name="IRAM2" size="0x10000" start="0x10000000"/></div> +<div class="line"> </target></div> +<div class="line"> <select></div> +<div class="line"> <component Cclass="CMSIS" Cgroup="CORE" Cvendor="ARM"/></div> +<div class="line"> <component Cclass="CMSIS" Cgroup="RTOS" Csub="Keil RTX" Cvendor="ARM"></div> +<div class="line"> <file attr="config" category="source" name="CMSIS/RTOS/RTX/Templates/RTX_Conf_CM.c" version="4.70.1"/></div> +<div class="line"> </component></div> +<div class="line"> <component Cbundle="MCBSTM32F400" Cclass="Board Support" Cgroup="A/D Converter" Cvendor="Keil"/></div> +<div class="line"> <component Cbundle="MCBSTM32F400" Cclass="Board Support" Cgroup="Buttons" Cvendor="Keil"/></div> +<div class="line"> <component Cbundle="MCBSTM32F400" Cclass="Board Support" Cgroup="LED" Cvendor="Keil"/></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube Framework" Csub="Classic" Cvendor="Keil"></div> +<div class="line"> <file attr="config" category="header" name="CMSIS/Driver/Config/RTE_Device.h" version="2.4.4"/></div> +<div class="line"> <file attr="config" category="header" name="MDK/Templates/Inc/stm32f4xx_hal_conf.h" version="1.6.0"/></div> +<div class="line"> </component></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube HAL" Csub="ADC" Cvendor="Keil"/></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube HAL" Csub="Common" Cvendor="Keil"/></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube HAL" Csub="Cortex" Cvendor="Keil"/></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube HAL" Csub="DMA" Cvendor="Keil"/></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube HAL" Csub="GPIO" Cvendor="Keil"/></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube HAL" Csub="PWR" Cvendor="Keil"/></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube HAL" Csub="RCC" Cvendor="Keil"/></div> +<div class="line"> <component Cclass="Device" Cgroup="Startup" Cvendor="Keil"></div> +<div class="line"> <file attr="config" category="source" condition="STM32F407xx_ARMCC" name="Drivers/CMSIS/Device/ST/STM32F4xx/Source/Templates/arm/startup_stm32f407xx.s" version="2.6.0"/></div> +<div class="line"> <file attr="config" category="source" name="Drivers/CMSIS/Device/ST/STM32F4xx/Source/Templates/system_stm32f4xx.c" version="2.6.0"/></div> +<div class="line"> </component></div> +<div class="line"> </select></div> +<div class="line"> <files></div> +<div class="line"> <group name="Source Files"></div> +<div class="line"> <file category="sourceC" name="./Blinky.c"/></div> +<div class="line"> <file category="sourceC" name="./Thread_LED.c"/></div> +<div class="line"> <file category="sourceC" name="./Thread_ADC.c"/></div> +<div class="line"> </group></div> +<div class="line"> <group name="Documentation"></div> +<div class="line"> <file category="doc" name="./Abstract.txt"/></div> +<div class="line"> </group></div> +<div class="line"> </files></div> +<div class="line"> </project></div> +<div class="line"> </create></div> +<div class="line"></package></div> +</div><!-- fragment --><h1><a class="anchor" id="cpdsc_structure"></a> +CPDSC top level structure</h1> +<p>The CPDSC file format shares the schema file (PACK.xsd) with the PDSC and GPDSC format. However, a CPDSC file can only contain the top level elements listed in this table.</p> +<h1><a class="anchor" id="element_package_cpdsc"></a> +/package (for CPDSC)</h1> +<table class="cmtable" summary="Element: CPDSC package"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td>root </td><td colspan="3">description root point for CPDSC </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>schemaVersion </td><td>Version of PACK.xsd the description is compatible with </td><td>VersionType </td><td>required </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td>name </td><td>Name of the CPDSC <a class="el" href="cp_SWComponents.html">Software Pack</a> file. Could be displayed by an installer. </td><td>RestrictedString </td><td>1..1 </td></tr> +<tr> +<td>vendor </td><td>Creator or owner of the CPDSC file. </td><td>RestrictedString </td><td>1..1 </td></tr> +<tr> +<td>description </td><td>High level description of the projects. </td><td>xs:string </td><td>1..1 </td></tr> +<tr> +<td>url </td><td>File location if generated, link to the Pack this file belongs to. If left empty, the Pack cannot be updated automatically from a server location. </td><td>xs:anyURI </td><td>1..1 </td></tr> +<tr> +<td>supportContact </td><td>Email or web page for reporting errors or problems related to this project. </td><td>xs:string </td><td>0..1 </td></tr> +<tr> +<td>license </td><td>Reference to a license file relative to this CPDSC. </td><td>xs:string </td><td>0..1 </td></tr> +<tr> +<td><a class="el" href="element_requirements_pg.html#element_requirements">requirements</a> </td><td>Specify required packs, compiler, and programming languages for the project. </td><td>RequirementsType </td><td>1..1 </td></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#cpdsc_create_pg">create</a> </td><td>Section capturing the project configuration. </td><td>CreateType </td><td>1..1 </td></tr> +<tr> +<td><a class="el" href="element_releases.html">releases</a> </td><td>Release history and release notes for tracking changes to this project. The attributes <b><deprecated></b> and <b><replacement></b> are not supported in the context of CPDSC files. </td><td>ReleasesType </td><td>1..1 </td></tr> +</table> +<p>You can refer to <a class="el" href="pdsc_package_pg.html#element_package">/package</a> for more details.</p> +<p> </p> +<hr/> +<h1><a class="anchor" id="cpdsc_create_pg"></a> +/package/create</h1> +<p>This element groups one or more projects, which should be related. For example, the Secure and Non-secure part of an application, or a set of library projects and the final application project. We recommend to use different CPDSC files for each individual project.</p> +<table class="cmtable" summary="Element: create"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_package_cpdsc">package</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#element_package_cpdsc">/package</a> </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_project">project</a> </td><td>Grouping element to add project descriptions </td><td>ProjectType </td><td>1..* </td></tr> +</table> +<p> </p> +<hr/> +<h1><a class="anchor" id="element_project"></a> +/package/create/project</h1> +<p>This element bundles one project.</p> +<p><b>Example</b> <em>project</em> section: </p> +<div class="fragment"><div class="line"><?xml version=<span class="stringliteral">"1.0"</span> encoding=<span class="stringliteral">"UTF-8"</span> standalone=<span class="stringliteral">"no"</span> ?></div> +<div class="line"><<span class="keyword">package </span>xmlns:xsi="http:<span class="comment">//www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="PACK.xsd"></span></div> +<div class="line"> ...</div> +<div class="line"> <create></div> +<div class="line"> <project name="STM32F429_Flash" documentation="./Abstract.txt"></div> +<div class="line"> <target Dendian="Little-endian" Dfpu="SP_FPU" Dname="STM32F429ZITx" Dvendor="STMicroelectronics:13"></div> +<div class="line"> ...</div> +<div class="line"> </target></div> +<div class="line"> <select></div> +<div class="line"> ...</div> +<div class="line"> </select></div> +<div class="line"> <files></div> +<div class="line"> ...</div> +<div class="line"> </files></div> +<div class="line"> </project></div> +<div class="line"> </create></div> +<div class="line"></package></div> +</div><!-- fragment --><p> <br/> +</p> +<table class="cmtable" summary="Element: project"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#cpdsc_create_pg">create</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#cpdsc_create_pg">/package/create</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>Name of the project. Will be used as file name as well. If not specified, then the name on the package level is used. </td><td>RestrictedString </td><td>optional </td></tr> +<tr> +<td>documentation </td><td>Path and file name of a document relative to the CPDSC file, or an url providing detailed information about the software project. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>public </td><td>Set publishing permissions for the documentation. If <em><public></em> is <span class="XML-Token">true</span>, then the vendor gives permission to extract the documentation from the pack and publish it on a web-page. Links to web pages are assumed to be public. The default value is <span class="XML-Token">false</span>. </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#cpdsc_target_pg">target</a> </td><td>Section containing details, for example about the board, device, memory, debug, or algorithms. </td><td>TargetType </td><td>1..1 </td></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#cpdsc_select_pg">select</a> </td><td>Specify the software components selected in the Run-Time Environment (RTE). </td><td>SelectType </td><td>0..1 </td></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#cpdsc_files_pg">files</a> </td><td>List all files used for the project build, which are not configured using components. </td><td>ProjectFilesType </td><td>0..1 </td></tr> +</table> +<p> </p> +<hr/> +<h1><a class="anchor" id="cpdsc_target_pg"></a> +/package/create/project/target</h1> +<p>This element describes the hardware target, including memory layout, debug probes, or flash programming algorithms.</p> +<p><b>Example</b> <em>target</em> section:</p> +<div class="fragment"><div class="line"><<span class="keyword">package </span>xmlns:xsi="http:<span class="comment">//www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="PACK.xsd"/></span></div> +<div class="line"> ...</div> +<div class="line"> <create></div> +<div class="line"> <project></div> +<div class="line"> ...</div> +<div class="line"> <target Dendian="Little-endian" Dfpu="SP_FPU" Dname="STM32F429ZITx" Dvendor="STMicroelectronics:13"></div> +<div class="line"> <output debug="1" name="Blinky" type="exe"/></div> +<div class="line"> <debugProbe coreClock="10000000" name="ST-Link" protocol="swd"/></div> +<div class="line"> <memory access="rx" default="1" name="IROM1" size="0x200000" start="0x8000000" startup="1"/></div> +<div class="line"> <memory access="rw" default="1" init="1" name="IRAM1" size="0x30000" start="0x20000000"/></div> +<div class="line"> <memory access="rw" default="0" init="1" name="IRAM2" size="0x10000" start="0x10000000"/></div> +<div class="line"> </target></div> +<div class="line"> ...</div> +<div class="line"> </project></div> +<div class="line"> </create></div> +<div class="line"></package></div> +</div><!-- fragment --><p> <br/> +</p> +<table class="cmtable" summary="Element: target"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_project">project</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#element_project">/package/create/project</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>Bvendor </td><td>Board vendor name. Either a board vendor and board name with optional board revision, or a device vendor and a device name. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>Bname </td><td>SPecify the board name. Either a board vendor and board name with optional board revision, or a device vendor and a device name. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>Bversion </td><td>Board version. Either a board vendor and board name with optional board revision, or a device vendor and a device name. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>Dvendor </td><td>Device vendor name. Either a board vendor and board name with optional board revision, or a device vendor and a device name. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>Dname </td><td>Device name. Either a board vendor and board name with optional board revision, or a device vendor and a device name. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>Pname </td><td>Processor instance name. In case of multi-processor devices, this processor ID is required. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>Dfpu </td><td>Selects the floating point unit option that is active for the project. <b>Note</b>, even if the device implements an FPU, setting <span class="XML-Token">Dfpu=0</span> here, will disable FPU code generation. Use predefined values from the table <a class="el" href="pdsc_family_pg.html#DfpuEnum">Device FPU</a>. </td><td>DfpuEnum </td><td>optional </td></tr> +<tr> +<td><p class="starttd">Dendian</p> +<p class="endtd"></p> +</td><td>Selects the endianness to be used for the project. Note that selecting an endianness that is not supported by the device, will result in a build that will not run on the device. Use predefined values from the table <a class="el" href="pdsc_family_pg.html#DendianEnum">DendianEnum</a>. </td><td>DendianEnum </td><td>optional </td></tr> +<tr> +<td>Dmpu </td><td>Selects the memory protection unit to be enabled or disabled for the project. Use predefined values from the table <a class="el" href="pdsc_family_pg.html#DmpuEnum">Device MPU</a>. </td><td>DmpuEnum </td><td>optional </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_output">output</a> </td><td>Configure the build output name and type, and specify whether to include debug information. </td><td>OutputType </td><td>1..1 </td></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_target_memory">memory</a> </td><td>Specify the memory configuration for this application. Based on the memory layout, the linker script will be generated by the toolchain. </td><td>TargetMemoryType </td><td>0..* </td></tr> +<tr> +<td>stack </td><td>Specify the stack size in bytes allocated by the linker to the application. This element consists of one attribute named <em><size></em>. Set the value for this attribute. Only positive numbers are allowed. </td><td>StackType </td><td>1..1 </td></tr> +<tr> +<td>heap </td><td>Specify the heap size in bytes allocated by the linker to the application. This element consists of one attribute named <em><size></em>. Set the value for this attribute. Only positive numbers are allowed. </td><td>HeapType </td><td>1 </td></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_target_algorithm">algorithm</a> </td><td>Selects from the list of available flash programming algorithms specified for this device in the corresponding Device Family Pack. Target and RAM memory ranges can be reconfigured from the defaults specified in the device description. </td><td>TargetAlgorithmType </td><td>0..* </td></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_debugProbe">debugProbe</a> </td><td>Selects and configures the debug probe to be used for this project. </td><td>DebugProbeType </td><td>0..* </td></tr> +</table> +<p> </p> +<hr/> +<h1><a class="anchor" id="element_target_algorithm"></a> +/package/create/project/target/algorithm</h1> +<p><b>Example</b> <em>algorithm</em> element </p> +<div class="fragment"><div class="line">...</div> +<div class="line"> <project name=<span class="stringliteral">"STM32F429_Flash"</span> documentation=<span class="stringliteral">"./Abstract.txt"</span>></div> +<div class="line"> <target Dendian=<span class="stringliteral">"Little-endian"</span> Dfpu=<span class="stringliteral">"SP_FPU"</span> Dname=<span class="stringliteral">"STM32F429ZITx"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div> +<div class="line"> ...</div> +<div class="line"> <algorithm name=<span class="stringliteral">"CMSIS/Flash/STM32F4xx_1024.FLM"</span> start=<span class="stringliteral">"0x08000000"</span> size=<span class="stringliteral">"0x100000"</span> RAMstart=0x20000000 RAMsize=0x1000/></div> +<div class="line"> ...</div> +<div class="line"> </target></div> +<div class="line"> </project></div> +<div class="line">...</div> +</div><!-- fragment --><p> <br/> +</p> +<table class="cmtable" summary="Element: algorithm"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#cpdsc_target_pg">target</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#cpdsc_target_pg">/package/create/project/target</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>Pname </td><td>Processor name </td><td>xs:string </td><td>RestrictedString </td></tr> +<tr> +<td>name </td><td>References the name (without path) of the flash programming algorithm as defined by the DFP. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>start </td><td>Overrides the predefined programming start address of the flash programming algorithm as specified in the DFP. </td><td>NonNegativeInteger </td><td>optional </td></tr> +<tr> +<td>size </td><td>Overrides the predefined programming size of the flash programming algorithm as specified in the DFP. </td><td>NonNegativeInteger </td><td>optional </td></tr> +<tr> +<td>RAMstart </td><td>Overrides the predefined start address in RAM where the flash programming algorithm is loaded as specified in the DFP. </td><td>NonNegativeInteger </td><td>optional </td></tr> +<tr> +<td>RAMsize </td><td>Overrides the predefined RAM size in RAM where the flash programming algorithm is loaded as specified in the DFP. </td><td>NonNegativeInteger </td><td>optional </td></tr> +<tr> +<td>default </td><td>Sets this algorithm as the default algorithm for flash programming when the value is set to <span class="XML-Token">1</span>. The defualt value is <span class="XML-Token">0</span> - false. </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>style </td><td>Sets flash programming format. The default value is <span class="XML-Token">Keil</span>. Use the predefinde values as listed in the table <a class="el" href="pdsc_family_pg.html#AlgorithmStyleEnum">Algorithm Styles</a>. </td><td>AlgorithmStyleType </td><td>optional </td></tr> +<tr> +<td>parameter </td><td>Parameter string passed when invoking the algorithm. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>endian </td><td>Specify the endianness of the algorithm. Default value is <span class="XML-Token">Little-endian</span>. Use the predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DendianEnum">Endinaness</a>. </td><td>DendianEnum </td><td>optional </td></tr> +</table> +<p> </p> +<hr/> +<h1><a class="anchor" id="element_debugProbe"></a> +/package/create/project/target/debugProbe</h1> +<p>Specify the attributes of a debug probe.</p> +<p><b>Example</b> <em>debugProbe</em> element </p> +<div class="fragment"><div class="line">...</div> +<div class="line"> <project name=<span class="stringliteral">"STM32F429_Flash"</span> documentation=<span class="stringliteral">"./Abstract.txt"</span>></div> +<div class="line"> <target Dendian=<span class="stringliteral">"Little-endian"</span> Dfpu=<span class="stringliteral">"SP_FPU"</span> Dname=<span class="stringliteral">"STM32F429ZITx"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div> +<div class="line"> ...</div> +<div class="line"> <debugProbe coreClock=<span class="stringliteral">"10000000"</span> name=<span class="stringliteral">"ST-Link"</span> protocol=<span class="stringliteral">"swd"</span>/></div> +<div class="line"> ...</div> +<div class="line"> </target></div> +<div class="line"> </project></div> +<div class="line">...</div> +</div><!-- fragment --><p> <br/> +</p> +<table class="cmtable" summary="Element: debugProbe"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#cpdsc_target_pg">target</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#cpdsc_target_pg">/package/create/project/target</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>Name of of the debug probe, for example <span class="XML-Token">JLink</span>, <span class="XML-Token">ULink2</span>, <span class="XML-Token">ULinkPro</span>, <span class="XML-Token">CMSIS-DAP</span>, or <span class="XML-Token">ST-Link</span>. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>protocol </td><td>Select the debug protocol, for example, <span class="XML-Token">swd</span>. Use the predefined values listed in the table <a class="el" href="pdsc_family_pg.html#DebugProtocolEnum">Debug Protocol Type</a>. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>coreClock </td><td>Clock frequency of the core once the system is initialized. </td><td>NonNegativeInteger </td><td>required </td></tr> +<tr> +<td>tpiuClock </td><td>Clock frequency of the TPIU block of the CoreSight debug logic. Only relevant for tracing. </td><td>NonNegativeInteger </td><td>optional </td></tr> +</table> +<p> </p> +<hr/> +<h1><a class="anchor" id="element_target_memory"></a> +/package/create/project/target/memory</h1> +<p>Specify the memory layout. The linker script file will be genereted according to these settings.</p> +<p><b>Example</b> <em>memory</em> element </p> +<div class="fragment"><div class="line">...</div> +<div class="line"> <project name=<span class="stringliteral">"STM32F429_Flash"</span> documentation=<span class="stringliteral">"./Abstract.txt"</span>></div> +<div class="line"> <target Dendian=<span class="stringliteral">"Little-endian"</span> Dfpu=<span class="stringliteral">"SP_FPU"</span> Dname=<span class="stringliteral">"STM32F429ZITx"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div> +<div class="line"> ...</div> +<div class="line"> <memory access=<span class="stringliteral">"rx"</span> <span class="keywordflow">default</span>=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"IROM1"</span> size=<span class="stringliteral">"0x200000"</span> start=<span class="stringliteral">"0x8000000"</span> startup=<span class="stringliteral">"1"</span>/></div> +<div class="line"> <memory access=<span class="stringliteral">"rw"</span> <span class="keywordflow">default</span>=<span class="stringliteral">"1"</span> init=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"IRAM1"</span> size=<span class="stringliteral">"0x30000"</span> start=<span class="stringliteral">"0x20000000"</span>/></div> +<div class="line"> <memory access=<span class="stringliteral">"rw"</span> <span class="keywordflow">default</span>=<span class="stringliteral">"0"</span> init=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"IRAM2"</span> size=<span class="stringliteral">"0x10000"</span> start=<span class="stringliteral">"0x10000000"</span>/></div> +<div class="line"> ...</div> +<div class="line"> </target></div> +<div class="line"> </project></div> +<div class="line">...</div> +</div><!-- fragment --><p><br/> + </p> +<table class="cmtable" summary="Element: memory"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#cpdsc_target_pg">target</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#cpdsc_target_pg">/package/create/project/target</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>Pname </td><td>Identifies the processor. </td><td>RestrictedString </td><td>optional </td></tr> +<tr> +<td>id </td><td>Eunmerated ID of memory. <span class="XML-Token">Deprecated since version 1.4.4</span> </td><td>MemoryIDTypeEnum </td><td>optional </td></tr> +<tr> +<td>name </td><td>Reference to the name of the memory as defined by the DFP. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>start </td><td>Overrides the predefined memory start address. </td><td>NonNegativeInteger </td><td>optional </td></tr> +<tr> +<td>size </td><td>Overrides the predefined memory size. </td><td>NonNegativeInteger </td><td>optional </td></tr> +<tr> +<td>access </td><td>Overrides the predefined access permissions for the memory as specified in the DFP. The default value is <span class="XML-Token">r</span>, for 'read' permission. Use the predefined values defined in the table <a class="el" href="pdsc_family_pg.html#MemoryAccessTypeString">MemoryAccessTypeString</a>. </td><td>AccessType </td><td>optional </td></tr> +<tr> +<td>alias </td><td>Reference by 'name' to another memory to express that the same physical memory is mapped at another address. </td><td>AccessType </td><td>optional </td></tr> +<tr> +<td>init </td><td><span class="XML-Token">Deprecated; do not use! Ignore!!!</span>. </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>default </td><td>Use to define the default memory for the linker. </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>startup </td><td>Specify whether the memory is used by the linker for the startup. The default value is <span class="XML-Token">0</span> - false. </td><td>xs:boolean </td><td>optional </td></tr> +</table> +<p> </p> +<hr/> +<h1><a class="anchor" id="element_output"></a> +/package/create/project/target/output</h1> +<p>Specify the characteristics for the build output file.</p> +<p><b>Example</b> <em>output</em> element </p> +<div class="fragment"><div class="line"><project name=<span class="stringliteral">"STM32F429_Flash"</span> documentation=<span class="stringliteral">"./Abstract.txt"</span>></div> +<div class="line"> <target Dendian=<span class="stringliteral">"Little-endian"</span> Dfpu=<span class="stringliteral">"SP_FPU"</span> Dname=<span class="stringliteral">"STM32F429ZITx"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div> +<div class="line"> <output debug=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"Blinky"</span> type=<span class="stringliteral">"exe"</span>/></div> +<div class="line"> ...</div> +<div class="line"> </target></div> +<div class="line"> ...</div> +<div class="line"></project></div> +</div><!-- fragment --><p><br/> + </p> +<table class="cmtable" summary="Element: output"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#cpdsc_target_pg">target</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#cpdsc_target_pg">/package/create/project/target</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>Name of the build output file. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>type </td><td>Select the build target to be <span class="XML-Token">lib</span> - library or <span class="XML-Token">exe</span> - executable. You can use the wildcard <span class="XML-Token">*</span> for </td><td>CompilerOutputType </td><td>required </td></tr> +<tr> +<td>debug </td><td>Select whether the output will contain debug information. Use the values <span class="XML-Token">1;0</span> for true and false. </td><td>xs:boolean </td><td>required </td></tr> +</table> +<p> </p> +<hr/> +<h1><a class="anchor" id="cpdsc_select_pg"></a> +/package/create/project/select</h1> +<p>This element lists all software components that are selected within the Manage Run-Time Environment.</p> +<p><b>Example</b> <em>select</em> section: </p> +<div class="fragment"><div class="line"><<span class="keyword">package </span>xmlns:xsi="http:<span class="comment">//www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="PACK.xsd"/></span></div> +<div class="line"> ...</div> +<div class="line"> <create></div> +<div class="line"> <project></div> +<div class="line"> ...</div> +<div class="line"> <select></div> +<div class="line"> <component Cclass="CMSIS" Cgroup="Core" Cvendor="ARM" Cversion="4.1.0"/></div> +<div class="line"> <component Cclass="CMSIS" Cgroup="RTOS" Csub="Keil RTX" Cvendor="ARM" Cversion="4.78.0"></div> +<div class="line"> <file attr="config" category="source" name="CMSIS/RTOS/RTX/Templates/RTX_Conf_CM.c" version="4.70.1"/></div> +<div class="line"> </component></div> +<div class="line"> <component Cbundle="STM32F429I-Discovery" Cclass="Board Support" Cgroup="Buttons" Cvendor="Keil" Cversion="1.0.0"/></div> +<div class="line"> <component Cbundle="STM32F429I-Discovery" Cclass="Board Support" Cgroup="LED" Cvendor="Keil" Cversion="1.0.0"/></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube Framework" Csub="Classic" Cvendor="Keil" Cversion="1.4.0"></div> +<div class="line"> <file attr="config" category="header" name="CMSIS/Driver/Config/RTE_Device.h" version="2.3.1"/></div> +<div class="line"> <file attr="config" category="header" name="MDK/Templates/Inc/stm32f4xx_hal_conf.h" version="1.4.2"/></div> +<div class="line"> </component></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube HAL" Csub="Common" Cvendor="Keil" Cversion="1.4.0"/></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube HAL" Csub="Cortex" Cvendor="Keil" Cversion="1.4.0"/></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube HAL" Csub="GPIO" Cvendor="Keil" Cversion="1.4.0"/></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube HAL" Csub="PWR" Cvendor="Keil" Cversion="1.4.0"/></div> +<div class="line"> <component Cclass="Device" Cgroup="STM32Cube HAL" Csub="RCC" Cvendor="Keil" Cversion="1.4.0"/></div> +<div class="line"> <component Cclass="Device" Cgroup="Startup" Cvendor="Keil" Cversion="2.4.0"></div> +<div class="line"> <file attr="config" category="source" condition="STM32F429xx_ARMCC" name="Drivers/CMSIS/Device/ST/STM32F4xx/Source/Templates/arm/startup_stm32f429xx.s" version="2.4.2"/></div> +<div class="line"> <file attr="config" category="source" name="Drivers/CMSIS/Device/ST/STM32F4xx/Source/Templates/system_stm32f4xx.c" version="2.4.2"/></div> +<div class="line"> </component></div> +<div class="line"> </select></div> +<div class="line"> ...</div> +<div class="line"> </project></div> +<div class="line"> </create></div> +<div class="line"></package></div> +</div><!-- fragment --><p> <br/> +</p> +<table class="cmtable" summary="Element: select"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_project">project</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#element_project">/package/create/project</a> </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_project_component">component</a> </td><td>Group element for defining the selected software components. </td><td>ComponentSelectType </td><td>1..* </td></tr> +</table> +<p> </p> +<hr/> +<h1><a class="anchor" id="element_project_component"></a> +/package/create/project/select/component</h1> +<p>Specify the software components.</p> +<p><b>Example</b> <em>component</em> element </p> +<div class="fragment"><div class="line">...</div> +<div class="line"> <select></div> +<div class="line"> <component Cclass=<span class="stringliteral">"CMSIS"</span> Cgroup=<span class="stringliteral">"Core"</span> Cvendor=<span class="stringliteral">"ARM"</span> Cversion=<span class="stringliteral">"4.1.0"</span>/></div> +<div class="line"> <component Cclass=<span class="stringliteral">"Device"</span> Cgroup=<span class="stringliteral">"STM32Cube Framework"</span> Csub=<span class="stringliteral">"Classic"</span> Cvendor=<span class="stringliteral">"Keil"</span> Cversion=<span class="stringliteral">"1.4.0"</span>></div> +<div class="line"> <file attr=<span class="stringliteral">"config"</span> category=<span class="stringliteral">"header"</span> name=<span class="stringliteral">"CMSIS/Driver/Config/RTE_Device.h"</span> version=<span class="stringliteral">"2.3.1"</span>/></div> +<div class="line"> <file attr=<span class="stringliteral">"config"</span> category=<span class="stringliteral">"header"</span> name=<span class="stringliteral">"MDK/Templates/Inc/stm32f4xx_hal_conf.h"</span> version=<span class="stringliteral">"1.4.2"</span>/></div> +<div class="line"> </component></div> +<div class="line"> </select></div> +<div class="line">...</div> +</div><!-- fragment --><p> <br/> +</p> +<table class="cmtable" summary="Element: component"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#cpdsc_select_pg">select</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#cpdsc_select_pg">/package/create/project/select</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>Cvendor </td><td>Vendor name of the component. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>Cbundle </td><td>Name of bundle to which the selected component belongs. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>Cclass </td><td>Component class name. Predefined values can be used as listed in the table <a class="el" href="element_taxonomy.html#CclassType">Component Classes</a>. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>Cgroup </td><td>Component group name following the taxonomy. Predefined values can be used as listed in the table <a class="el" href="element_taxonomy.html#CgroupType">Component Groups</a>. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>Csub </td><td>Component sub group name following the taxonomy (string may be empty) </td><td>CsubType </td><td>optional </td></tr> +<tr> +<td>Cvariant </td><td>Name of the variant of the selected component. </td><td>CvariantType </td><td>optional </td></tr> +<tr> +<td>Cversion </td><td>Version of the selected component. Note, a higher version number can be entered in case the matching version is not available. </td><td>ComponentVersionType </td><td>optional </td></tr> +<tr> +<td>Capiversion </td><td>Implemented api version defined for the corresponding Cclass:Cgroup:Csub. Set the value only for components that have an associated <em><api></em>. </td><td>ComponentVersionType </td><td>optional </td></tr> +<tr> +<td>instances </td><td>Number of instances created for the component. Set the value only for components that are multi-instance capable. Defaults to <span class="XML-Token">1</span> if not set. </td><td>InstancesType </td><td>optional </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_component_file">file</a> </td><td>Specify configuration files from the selected component. </td><td>ComponentSelectType </td><td>0..* </td></tr> +</table> +<p> </p> +<hr/> +<h1><a class="anchor" id="element_component_file"></a> +/package/create/project/select/component/file</h1> +<p>Specify the configuration files for the selected component. These files must already exist in the project folder structure and contain a configuration setup specifically for the project.</p> +<p><b>Example</b> <em>file</em> element </p> +<div class="fragment"><div class="line">...</div> +<div class="line"> <component Cclass=<span class="stringliteral">"Device"</span> Cgroup=<span class="stringliteral">"STM32Cube Framework"</span> Csub=<span class="stringliteral">"Classic"</span> Cvendor=<span class="stringliteral">"Keil"</span> Cversion=<span class="stringliteral">"1.4.0"</span>></div> +<div class="line"> <file attr=<span class="stringliteral">"config"</span> category=<span class="stringliteral">"header"</span> name=<span class="stringliteral">"CMSIS/Driver/Config/RTE_Device.h"</span> version=<span class="stringliteral">"2.3.1"</span>/></div> +<div class="line"> <file attr=<span class="stringliteral">"config"</span> category=<span class="stringliteral">"header"</span> name=<span class="stringliteral">"MDK/Templates/Inc/stm32f4xx_hal_conf.h"</span> version=<span class="stringliteral">"1.4.2"</span>/></div> +<div class="line"> </component></div> +<div class="line">...</div> +</div><!-- fragment --><p> <br/> +</p> +<table class="cmtable" summary="Element: file"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_project_component">component</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#element_project_component">/package/create/project/select/component</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>condition </td><td>Condition id being used at the time of runtime configuration. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>category </td><td>File type, for example <span class="XML-Token">header</span>. Use predefined values from the table <a class="el" href="pdsc_components_pg.html#FileCategoryEnum">File Category</a>. </td><td>FileCategoryType </td><td>required </td></tr> +<tr> +<td>attr </td><td>File action attribute, for example <span class="XML-Token">copy</span>. Use predefined values from the table <a class="el" href="pdsc_components_pg.html#FileCategoryEnum">File Category</a>. </td><td><a class="el" href="pdsc_components_pg.html#FileAttributeEnum">FileAttributeType</a> </td><td>optional </td></tr> +<tr> +<td>name </td><td>File path and name within pack it originates from. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>version </td><td>Version of the configuration file being used in the example. </td><td><a class="el" href="pdsc_package_pg.html#VersionType">VersionType</a> </td><td>required </td></tr> +</table> +<p> </p> +<hr/> +<h1><a class="anchor" id="cpdsc_files_pg"></a> +/package/create/project/files</h1> +<p>The files section specifies files to be included into the project build that are not managed through software components. Files can be sorted into named groups.</p> +<p><b>Example</b> <em>files</em> section: </p> +<div class="fragment"><div class="line"><<span class="keyword">package </span>xmlns:xsi="http:<span class="comment">//www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="PACK.xsd"/></span></div> +<div class="line"> ...</div> +<div class="line"> <create></div> +<div class="line"> <project></div> +<div class="line"> <files></div> +<div class="line"> <group name="Source Files"></div> +<div class="line"> <file category="sourceC" name="./Blinky.c"/></div> +<div class="line"> <file category="sourceC" name="./Thread_LED.c"/></div> +<div class="line"> </group></div> +<div class="line"> <group name="Documentation"></div> +<div class="line"> <file category="doc" name="./Abstract.txt"/></div> +<div class="line"> </group></div> +<div class="line"> </files></div> +<div class="line"> </project></div> +<div class="line"> </create></div> +<div class="line"></package></div> +</div><!-- fragment --><p> <br/> +</p> +<table class="cmtable" summary="Element: files"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_project">project</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#element_project">/package/create/project</a> </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_project_file">file</a> </td><td>Specify a file. </td><td>ProjectFileType </td><td>0..* </td></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_project_group">group</a> </td><td>Specify a group of files. </td><td>GroupType </td><td>0..* </td></tr> +</table> +<p> </p> +<hr/> +<h1><a class="anchor" id="element_project_file"></a> +/package/project/create/files/.../file</h1> +<p>Specify files that are not included through software components.</p> +<table class="cmtable" summary="Element: file"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#cpdsc_files_pg">files</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#cpdsc_files_pg">/package/create/project/files</a> </td></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_project_group">group</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#element_project_group">/package/create/project/files/.../group</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>Path and name of the file, relative to CPDSC location. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>category </td><td>Type of file, for example, whether the file is a C or assembler file. Use the predefined values from the table <a class="el" href="pdsc_components_pg.html#FileCategoryEnum">File Categories</a>. </td><td>FileCategoryType </td><td>required </td></tr> +<tr> +<td>src </td><td>Folder specifying the source code location for a library. </td><td>xs:string </td><td>optional </td></tr> +</table> +<p> </p> +<hr/> +<h1><a class="anchor" id="element_project_group"></a> +/package/create/project/files/.../group</h1> +<p>Nesting of groups is supported. It is tool dependent how grouping is represented in the tool, because the grouping of files has no impact on the build by default.</p> +<p><b>Example</b> <em>files</em> section: </p> +<div class="fragment"><div class="line"><<span class="keyword">package </span>xmlns:xsi="http:<span class="comment">//www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="PACK.xsd"/></span></div> +<div class="line"> ...</div> +<div class="line"> <create></div> +<div class="line"> <project></div> +<div class="line"> <files></div> +<div class="line"> <group name="Source"></div> +<div class="line"> <group name="C"></div> +<div class="line"> <file category="sourceC" name="./Blinky.c"/></div> +<div class="line"> <file category="sourceC" name="./Thread_LED.c"/></div> +<div class="line"> </group></div> +<div class="line"> <group name="ASM"></div> +<div class="line"> <file category="sourceAsm" name="./startup_add.s"/></div> +<div class="line"> </group></div> +<div class="line"> </group></div> +<div class="line"> <group name="Documentation"></div> +<div class="line"> <file category="doc" name="./Abstract.txt"/></div> +<div class="line"> </group></div> +<div class="line"> </files></div> +<div class="line"> </project></div> +<div class="line"> </create></div> +<div class="line"></package></div> +</div><!-- fragment --><p> <br/> +</p> +<table class="cmtable" summary="Element: group"> +<tr> +<th>Parents </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#cpdsc_files_pg">files</a> </td><td colspan="3"><a class="el" href="cpdsc_pg.html#cpdsc_files_pg">/package/create/project/files</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>name of the group of files </td><td>RestrictedString </td><td>required </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_project_file">file</a> </td><td>Specify a file. </td><td>ProjectFileType </td><td>0..* </td></tr> +<tr> +<td><a class="el" href="cpdsc_pg.html#element_project_group">group</a> </td><td>Specify a group (nesting). </td><td>GroupType </td><td>0..* </td></tr> +</table> +<p> </p> +<hr/> + </div></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <!-- + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 + --> + </li> + </ul> +</div> +</body> +</html> |