<!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>/package/requirements</title> <title>CMSIS-Pack: /package/requirements</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.4.9</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('element_requirements_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">/package/requirements </div> </div> </div><!--header--> <div class="contents"> <div class="textblock"><p><a class="anchor" id="element_requirements"></a> There are three different requirement types:</p> <ul> <li>The <code><packages></code> section lists CMSIS Packs that have been used to configure the project. This includes the specification of a <code>version</code> range to ensure compatibility. If no version is provided, the latest installed version is used. If not yet installed, the latest available version will be installed before resolving the configuration.</li> <li>The <code><compilers></code> section specifies the toolchains that are supported by this example. The required compiler version is specified using the <code>version</code> element. If no compiler is specified, it is assumed that any toolchain will work.</li> <li>The <code><languages></code> section allows to specify requirements regarding the programming language, for example C99 standard. If no language requirements are set, ANSI C is assumed.</li> </ul> <p><b>Example</b> requirements 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"> <requirements></div> <div class="line"> <packages></div> <div class="line"> <package name="STM32F4xx_DFP" vendor="Keil" version="2.8.0:2.8.0"/></div> <div class="line"> </packages></div> <div class="line"> <compilers></div> <div class="line"> <compiler name="ARMCC" version="5.0.0:5.99.0"/></div> <div class="line"> </compilers></div> <div class="line"> <languages></div> <div class="line"> <language name="C" version="99"/></div> <div class="line"> </languages></div> <div class="line"> </requirements></div> <div class="line"> ...</div> <div class="line"></package></div> </div><!-- fragment --><p><b>/requirements</b> </p> <table class="cmtable" summary="Element: package"> <tr> <th>Parents </th><th colspan="3">Element Chain </th></tr> <tr> <td><a class="el" href="pdsc_package_pg.html#element_package">package</a> </td><td colspan="3"><a class="el" href="pdsc_package_pg.html#element_package">/package</a> </td></tr> <tr> <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> <tr> <th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> <tr> <td><a class="el" href="element_requirements_pg.html#element_packages">packages</a> </td><td>List of software packs required for the project to build. </td><td><a class="el" href="element_requirements_pg.html#element_packages">PackagesType</a> </td><td><0..1> </td></tr> <tr> <td><a class="el" href="element_requirements_pg.html#element_compilers">compilers</a> </td><td>List of compilers required for the project to build. Support for all compilers is assumed when not specified. </td><td><a class="el" href="element_requirements_pg.html#element_compilers">CompilersType</a> </td><td><0..1> </td></tr> <tr> <td><a class="el" href="element_requirements_pg.html#element_languages">languages</a> </td><td>List of language standards required for the project to build. Assuming ANSI C if not set. </td><td><a class="el" href="element_requirements_pg.html#element_languages">LanguagesType</a> </td><td><0..1> </td></tr> </table> <p> </p> <hr/> <h1><a class="anchor" id="element_packages"></a> /package/requirements/packages</h1> <p><b>Example</b> packages 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"> <requirements></div> <div class="line"> <packages></div> <div class="line"> <package name="STM32F4xx_DFP" vendor="Keil" version="2.8.0:2.8.0"/></div> <div class="line"> </packages></div> <div class="line"> </requirements></div> <div class="line"> ...</div> <div class="line"></package></div> </div><!-- fragment --><p><b>/package</b> </p> <table class="cmtable" summary="Element: package"> <tr> <th>Parents </th><th colspan="3">Element Chain </th></tr> <tr> <td><a class="el" href="element_requirements_pg.html#element_packages">packages</a> </td><td colspan="3"><a class="el" href="element_requirements_pg.html#element_packages">/package/requirements/packages</a> </td></tr> <tr> <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> <tr> <td>vendor </td><td>specify vendor of the package (e.g. "ARM") </td><td>RestrictedString </td><td>required </td></tr> <tr> <td>name </td><td>Name of the pack </td><td>RestrictedString </td><td>required </td></tr> <tr> <td>version </td><td><a class="el" href="pdsc_package_pg.html#VersionType">Version</a> of the required software pack which can be:<ul> <li>Minimum version (higher versions are accepted).</li> <li>Version range specified with <em>min_version</em><b>:</b><em>max_version</em>. <em>min_version</em> must be lower or equal than <em>max_version</em>. If <em>min_version</em> and <em>max_version</em> are equal, the version must match.</li> <li>If no version is specified, the latest available version is assumed. </li> </ul> </td><td><a class="el" href="pdsc_package_pg.html#VersionType">VersionType</a> </td><td>optional </td></tr> </table> <p> </p> <hr/> <h1><a class="anchor" id="element_compilers"></a> /package/requirements/compilers</h1> <p><b>Example</b> compilers 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"> <requirements></div> <div class="line"> <compilers></div> <div class="line"> <compiler name="ARMCC" version="5.0.0:5.99.0"/></div> <div class="line"> </compilers></div> <div class="line"> </requirements></div> <div class="line"> ...</div> <div class="line"></package></div> </div><!-- fragment --><p><b>/compiler</b> </p> <table class="cmtable" summary="Element: compiler"> <tr> <th>Parents </th><th colspan="3">Element Chain </th></tr> <tr> <td><a class="el" href="element_requirements_pg.html#element_requirements">requirements</a> </td><td colspan="3"><a class="el" href="element_requirements_pg.html#element_requirements">element_requirements</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 required <a class="el" href="pdsc_conditions_pg.html#CompilerEnumType">compiler</a> (i.e. "ARMCC", "IAR") </td><td><a class="el" href="pdsc_conditions_pg.html#CompilerEnumType">CompilerEnumType</a> </td><td>required </td></tr> <tr> <td>version </td><td><a class="el" href="pdsc_package_pg.html#VersionType">Version</a> of the required compiler which can be:<ul> <li>Minimum version (higher versions are accepted).</li> <li>Version range specified with <em>min_version</em><b>:</b><em>max_version</em>. <em>min_version</em> must be lower or equal than <em>max_version</em>. If <em>min_version</em> and <em>max_version</em> are equal, the version must match. <br/> </li> </ul> </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="element_languages"></a> /package/requirements/languages</h1> <p><b>Example</b> languages 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"> <requirements></div> <div class="line"> <languages></div> <div class="line"> <language name="C" version="99"/></div> <div class="line"> <languages></div> <div class="line"> </requirements></div> <div class="line"> ...</div> <div class="line"></package></div> </div><!-- fragment --><p><b>/language</b> </p> <table class="cmtable" summary="Element: language"> <tr> <th>Parents </th><th colspan="3">Element Chain </th></tr> <tr> <td><a class="el" href="element_requirements_pg.html#element_requirements">requirements</a> </td><td colspan="3"><a class="el" href="element_requirements_pg.html#element_requirements">element_requirements</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 programming language (i.e. "C", "C++") </td><td>xs:string </td><td>required </td></tr> <tr> <td>version </td><td>Version of the language standard (i.e. 90, 99, etc.). The setting will be reflected in the compiler commandline. </td><td>xs:string </td><td>required </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="navelem"><a class="el" href="packFormat.html">Pack Description (*.PDSC) Format</a></li> <li class="footer">Generated on Wed Feb 8 2017 10:21:01 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>