element_requirements_pg.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>/package/requirements</title>
  7. <title>CMSIS-Pack: /package/requirements</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="printComponentTabs.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="resize.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-Pack
  35. &#160;<span id="projectnumber">Version 1.6.3</span>
  36. </div>
  37. <div id="projectbrief">Delivery Mechanism for Software Packs</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li>
  62. <div id="MSearchBox" class="MSearchBoxInactive">
  63. <span class="left">
  64. <img id="MSearchSelect" src="search/mag_sel.png"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. alt=""/>
  68. <input type="text" id="MSearchField" value="Search" accesskey="S"
  69. onfocus="searchBox.OnSearchFieldFocus(true)"
  70. onblur="searchBox.OnSearchFieldFocus(false)"
  71. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  72. </span><span class="right">
  73. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  74. </span>
  75. </div>
  76. </li>
  77. </ul>
  78. </div>
  79. </div><!-- top -->
  80. <div id="side-nav" class="ui-resizable side-nav-resizable">
  81. <div id="nav-tree">
  82. <div id="nav-tree-contents">
  83. <div id="nav-sync" class="sync"></div>
  84. </div>
  85. </div>
  86. <div id="splitbar" style="-moz-user-select:none;"
  87. class="ui-resizable-handle">
  88. </div>
  89. </div>
  90. <script type="text/javascript">
  91. $(document).ready(function(){initNavTree('element_requirements_pg.html','');});
  92. </script>
  93. <div id="doc-content">
  94. <!-- window showing the filter options -->
  95. <div id="MSearchSelectWindow"
  96. onmouseover="return searchBox.OnSearchSelectShow()"
  97. onmouseout="return searchBox.OnSearchSelectHide()"
  98. onkeydown="return searchBox.OnSearchSelectKey(event)">
  99. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  100. <!-- iframe showing the search results (closed by default) -->
  101. <div id="MSearchResultsWindow">
  102. <iframe src="javascript:void(0)" frameborder="0"
  103. name="MSearchResults" id="MSearchResults">
  104. </iframe>
  105. </div>
  106. <div class="header">
  107. <div class="headertitle">
  108. <div class="title">/package/requirements </div> </div>
  109. </div><!--header-->
  110. <div class="contents">
  111. <div class="textblock"><p><a class="anchor" id="element_requirements"></a> There are three different requirement types:</p>
  112. <ul>
  113. <li>The <code>&lt;packages&gt;</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>
  114. <li>The <code>&lt;compilers&gt;</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>
  115. <li>The <code>&lt;languages&gt;</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>
  116. </ul>
  117. <p><b>Example</b> requirements section: </p>
  118. <div class="fragment"><div class="line">&lt;<span class="keyword">package </span>xmlns:xsi=&quot;http:<span class="comment">//www.w3.org/2001/XMLSchema-instance&quot; xsi:noNamespaceSchemaLocation=&quot;PACK.xsd&quot;/&gt;</span></div>
  119. <div class="line"> ...</div>
  120. <div class="line"> &lt;requirements&gt;</div>
  121. <div class="line"> &lt;packages&gt;</div>
  122. <div class="line"> &lt;package name=&quot;STM32F4xx_DFP&quot; vendor=&quot;Keil&quot; version=&quot;2.8.0:2.8.0&quot;/&gt;</div>
  123. <div class="line"> &lt;/packages&gt;</div>
  124. <div class="line"> &lt;compilers&gt;</div>
  125. <div class="line"> &lt;compiler name=&quot;ARMCC&quot; version=&quot;5.0.0:5.99.0&quot;/&gt;</div>
  126. <div class="line"> &lt;/compilers&gt;</div>
  127. <div class="line"> &lt;languages&gt;</div>
  128. <div class="line"> &lt;language name=&quot;C&quot; version=&quot;99&quot;/&gt;</div>
  129. <div class="line"> &lt;/languages&gt;</div>
  130. <div class="line"> &lt;/requirements&gt;</div>
  131. <div class="line"> ...</div>
  132. <div class="line">&lt;/package&gt;</div>
  133. </div><!-- fragment --><p><b>/requirements</b> </p>
  134. <table class="cmtable" summary="Element: package">
  135. <tr>
  136. <th>Parents </th><th colspan="3">Element Chain </th></tr>
  137. <tr>
  138. <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>
  139. <tr>
  140. <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
  141. <tr>
  142. <th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
  143. <tr>
  144. <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>&lt;0..1&gt; </td></tr>
  145. <tr>
  146. <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>&lt;0..1&gt; </td></tr>
  147. <tr>
  148. <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>&lt;0..1&gt; </td></tr>
  149. </table>
  150. <p>&#160;</p>
  151. <hr/>
  152. <h1><a class="anchor" id="element_packages"></a>
  153. /package/requirements/packages</h1>
  154. <p><b>Example</b> packages section: </p>
  155. <div class="fragment"><div class="line">&lt;<span class="keyword">package </span>xmlns:xsi=&quot;http:<span class="comment">//www.w3.org/2001/XMLSchema-instance&quot; xsi:noNamespaceSchemaLocation=&quot;PACK.xsd&quot;/&gt;</span></div>
  156. <div class="line"> ...</div>
  157. <div class="line"> &lt;requirements&gt;</div>
  158. <div class="line"> &lt;packages&gt;</div>
  159. <div class="line"> &lt;package name=&quot;STM32F4xx_DFP&quot; vendor=&quot;Keil&quot; version=&quot;2.8.0:2.8.0&quot;/&gt;</div>
  160. <div class="line"> &lt;/packages&gt;</div>
  161. <div class="line"> &lt;/requirements&gt;</div>
  162. <div class="line"> ...</div>
  163. <div class="line">&lt;/package&gt;</div>
  164. </div><!-- fragment --><p><b>/package</b> </p>
  165. <table class="cmtable" summary="Element: package">
  166. <tr>
  167. <th>Parents </th><th colspan="3">Element Chain </th></tr>
  168. <tr>
  169. <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>
  170. <tr>
  171. <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
  172. <tr>
  173. <td>vendor </td><td>specify vendor of the package (e.g. "ARM") </td><td>RestrictedString </td><td>required </td></tr>
  174. <tr>
  175. <td>name </td><td>Name of the pack </td><td>RestrictedString </td><td>required </td></tr>
  176. <tr>
  177. <td>version </td><td><a class="el" href="pdsc_package_pg.html#VersionType">Version</a> of the required software pack which can be:<ul>
  178. <li>Minimum version (higher versions are accepted).</li>
  179. <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>
  180. <li>If no version is specified, the latest available version is assumed. </li>
  181. </ul>
  182. </td><td><a class="el" href="pdsc_package_pg.html#VersionType">VersionType</a> </td><td>optional </td></tr>
  183. </table>
  184. <p>&#160;</p>
  185. <hr/>
  186. <h1><a class="anchor" id="element_compilers"></a>
  187. /package/requirements/compilers</h1>
  188. <p><b>Example</b> compilers section: </p>
  189. <div class="fragment"><div class="line">&lt;<span class="keyword">package </span>xmlns:xsi=&quot;http:<span class="comment">//www.w3.org/2001/XMLSchema-instance&quot; xsi:noNamespaceSchemaLocation=&quot;PACK.xsd&quot;/&gt;</span></div>
  190. <div class="line"> ...</div>
  191. <div class="line"> &lt;requirements&gt;</div>
  192. <div class="line"> &lt;compilers&gt;</div>
  193. <div class="line"> &lt;compiler name=&quot;ARMCC&quot; version=&quot;5.0.0:5.99.0&quot;/&gt;</div>
  194. <div class="line"> &lt;/compilers&gt;</div>
  195. <div class="line"> &lt;/requirements&gt;</div>
  196. <div class="line"> ...</div>
  197. <div class="line">&lt;/package&gt;</div>
  198. </div><!-- fragment --><p><b>/compiler</b> </p>
  199. <table class="cmtable" summary="Element: compiler">
  200. <tr>
  201. <th>Parents </th><th colspan="3">Element Chain </th></tr>
  202. <tr>
  203. <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>
  204. <tr>
  205. <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
  206. <tr>
  207. <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>
  208. <tr>
  209. <td>version </td><td><a class="el" href="pdsc_package_pg.html#VersionType">Version</a> of the required compiler which can be:<ul>
  210. <li>Minimum version (higher versions are accepted).</li>
  211. <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/>
  212. </li>
  213. </ul>
  214. </td><td><a class="el" href="pdsc_package_pg.html#VersionType">VersionType</a> </td><td>required </td></tr>
  215. </table>
  216. <p>&#160;</p>
  217. <hr/>
  218. <h1><a class="anchor" id="element_languages"></a>
  219. /package/requirements/languages</h1>
  220. <p><b>Example</b> languages section: </p>
  221. <div class="fragment"><div class="line">&lt;<span class="keyword">package </span>xmlns:xsi=&quot;http:<span class="comment">//www.w3.org/2001/XMLSchema-instance&quot; xsi:noNamespaceSchemaLocation=&quot;PACK.xsd&quot;/&gt;</span></div>
  222. <div class="line"> ...</div>
  223. <div class="line"> &lt;requirements&gt;</div>
  224. <div class="line"> &lt;languages&gt;</div>
  225. <div class="line"> &lt;language name=&quot;C&quot; version=&quot;99&quot;/&gt;</div>
  226. <div class="line"> &lt;languages&gt;</div>
  227. <div class="line"> &lt;/requirements&gt;</div>
  228. <div class="line"> ...</div>
  229. <div class="line">&lt;/package&gt;</div>
  230. </div><!-- fragment --><p><b>/language</b> </p>
  231. <table class="cmtable" summary="Element: language">
  232. <tr>
  233. <th>Parents </th><th colspan="3">Element Chain </th></tr>
  234. <tr>
  235. <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>
  236. <tr>
  237. <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
  238. <tr>
  239. <td>name </td><td>Name of the programming language (i.e. "C", "C++") </td><td>xs:string </td><td>required </td></tr>
  240. <tr>
  241. <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>
  242. </table>
  243. <p>&#160;</p>
  244. <hr/>
  245. </div></div><!-- contents -->
  246. </div><!-- doc-content -->
  247. <!-- start footer part -->
  248. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  249. <ul>
  250. <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li>
  251. <li class="footer">Generated on Thu Apr 9 2020 15:49:54 for CMSIS-Pack Version 1.6.3 by Arm Ltd. All rights reserved.
  252. <!--
  253. <a href="http://www.doxygen.org/index.html">
  254. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  255. -->
  256. </li>
  257. </ul>
  258. </div>
  259. </body>
  260. </html>