ARM-software
/
CMSIS_5
kopia lustrzana https://github-proxy.rt-thread.io/ARM-software/CMSIS_5.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
							<!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/taxonomy element</title>
<title>CMSIS-Pack: /package/taxonomy element</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
   &#160;<span id="projectnumber">Version 1.6.3</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&#160;Page</span></a></li>
      <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;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_taxonomy.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</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/taxonomy element </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Group to list description elements that define component classes and component group names used within a package description. This element is optional.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line">&lt;package&gt;</div>
<div class="line">  ...</div>
<div class="line">  &lt;taxonomy&gt;</div>
<div class="line">    ...</div>
<div class="line">  &lt;/taxonomy&gt;</div>
<div class="line">  ...</div>
<div class="line">&lt;/package&gt;</div>
</div><!-- fragment --><p>&#160;</p>
<table  class="cmtable" summary="Element: Taxonomy">
<tr>
<th>Parent Element </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>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence  </th></tr>
<tr>
<td><a class="el" href="element_taxonomy.html#element_taxonomyDescription">description</a> </td><td>Describes or defines a component class or class-group combination. </td><td>TaxonomyDescriptionType </td><td>1..*   </td></tr>
</table>
<p>&#160;</p>
<hr/>
<h1><a class="anchor" id="element_taxonomyDescription"></a>
/package/taxonomy/description</h1>
<p>This element describes a component class or the combination between a component class and a component group. Components are categorized by <em>Cclass</em> and <em>Cgroup</em>. The creator of a package can define names for <em>Cclass</em> and <em>Cgroup</em>. Thus, configuration tools can display the set of available components. A document can be referenced using the attribute <em>doc</em>. The attribute <em>generator</em> can be used to reference to a generator tool. The <em>id</em> of the generator needs to be the same as specified in the element <a class="el" href="pdsc_generators_pg.html#element_generator">/package/generators/generator</a>. The description itself is a string entered between the opening and closing tags of the element <b>description</b>.</p>
<p>It is recommended to use an already agreed taxonomy for interchangeable components. For example, the combination of class <span class="XML-Token">CMSIS</span> and group <span class="XML-Token">Startup</span> is defined for the device-specific CMSIS-Core (Cortex-M) files.</p>
<p>&#160;</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line">&lt;taxonomy&gt;</div>
<div class="line">  &lt;description Cclass=<span class="stringliteral">&quot;Board Support&quot;</span>&gt;Generic Interfaces <span class="keywordflow">for</span> Evaluation and Development Boards&lt;/description&gt;</div>
<div class="line">  &lt;description Cclass=<span class="stringliteral">&quot;CMSIS&quot;</span> doc=<span class="stringliteral">&quot;CMSIS/Documentation/General/html/index.html&quot;</span>&gt;Cortex Microcontroller Software Interface Components&lt;/description&gt;</div>
<div class="line">  &lt;description Cclass=<span class="stringliteral">&quot;Device&quot;</span> doc=<span class="stringliteral">&quot;CMSIS/Documentation/Core/html/index.html&quot;</span>&gt;Startup, System Setup&lt;/description&gt;</div>
<div class="line">  &lt;description Cclass=<span class="stringliteral">&quot;CMSIS Driver&quot;</span> doc=<span class="stringliteral">&quot;CMSIS/Documentation/Driver/html/index.html&quot;</span>&gt;Unified Device Drivers compliant to CMSIS-Driver Specifications&lt;/description&gt;</div>
<div class="line">  &lt;description Cclass=<span class="stringliteral">&quot;File System&quot;</span>&gt;File Drive Support and File System&lt;/description&gt;</div>
<div class="line">  &lt;description Cclass=<span class="stringliteral">&quot;Graphics&quot;</span>&gt;Graphical User Interface&lt;/description&gt;</div>
<div class="line">  &lt;description Cclass=<span class="stringliteral">&quot;Network&quot;</span>&gt;Network Stack <span class="keyword">using</span> Internet Protocols&lt;/description&gt;</div>
<div class="line">  &lt;description Cclass=<span class="stringliteral">&quot;USB&quot;</span>&gt;Universal Serial Bus Stack&lt;/description&gt;</div>
<div class="line">  &lt;description Cclass=<span class="stringliteral">&quot;RTOS&quot;</span>&gt;Realtime Operating System&lt;/description&gt;</div>
<div class="line">&lt;/taxonomy&gt;</div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>You <b>must</b> <b>not</b> use Windows or Linux <a href="http://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words" target="_blank">reserved characters</a> for <em>Cclass</em>, <em>Cgrouop</em>, and <em>Csub</em> names! Some development tools use these names to create a directory structure for the software components in projects. Reserved characters are: <pre class="fragment">&lt; (less than)
&gt; (greater than)
: (colon)
" (double quote)
/ (forward slash)
\ (backslash)
| (vertical bar or pipe)
? (question mark)
* (asterisk)
</pre></dd></dl>
<p>&#160;</p>
<table  class="cmtable" summary="Element: Taxonomy">
<tr>
<th>Parent Element </th><th colspan="3">Element Chain  </th></tr>
<tr>
<td><a class="el" href="element_taxonomy.html">taxonomy</a> </td><td colspan="3"><a class="el" href="element_taxonomy.html">/package/taxonomy element</a>  </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use  </th></tr>
<tr>
<td>Cclass </td><td>Component Class Name. Can be defined by the creator of the package. Predefined values can be used as listed in the table <a class="el" href="element_taxonomy.html#CclassType">Component Classes</a>. </td><td>Cclass </td><td>required  </td></tr>
<tr>
<td>Cgroup </td><td>Component Group Name. Can be defined by the creator of the package. Predefined values can be used as listed in the table <a class="el" href="element_taxonomy.html#CgroupType">Component Groups</a>. </td><td>CgroupType </td><td>optional  </td></tr>
<tr>
<td>doc </td><td>Reference to documentation. </td><td>xs:string  </td><td>optional  </td></tr>
<tr>
<td>generator </td><td>Reference to a generator. Enter the <b>id</b> value of the element <a class="el" href="pdsc_generators_pg.html#element_generator">/package/generators/generator</a>. </td><td>xs:string  </td><td>optional  </td></tr>
<tr>
<td>public </td><td>Set publishing permissions for the documentation. If <em>&lt;public&gt;</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>
</table>
<p>&#160;</p>
<p><a class="anchor" id="CclassType"></a><b>Table: Component Classes</b></p>
<p>Component Class names are strings with a minimum length of 3 characters and a maximum length of 32 characters. Component class names are specified in the section <a class="el" href="element_taxonomy.html#element_taxonomyDescription">/package/taxonomy/description</a>.</p>
<p>These values can be used in the elements:</p>
<ul>
<li><a class="el" href="pdsc_conditions_pg.html#element_accept">/package/conditions/condition/accept</a></li>
<li><a class="el" href="pdsc_conditions_pg.html#element_require">/package/conditions/condition/require</a></li>
<li><a class="el" href="pdsc_conditions_pg.html#element_deny">/package/conditions/condition/deny</a></li>
<li><a class="el" href="pdsc_examples_pg.html#element_example_attribute_component">/package/examples/example/attributes/component</a></li>
<li><a class="el" href="pdsc_components_pg.html#element_component">/package/components/.../component</a></li>
<li><a class="el" href="pdsc_components_pg.html#element_bundle">/package/components/bundle</a></li>
<li><a class="el" href="pdsc_apis_pg.html#element_api">/package/apis/api</a></li>
<li><a class="el" href="element_taxonomy.html#element_taxonomyDescription">/package/taxonomy/description</a></li>
</ul>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line">&lt;... Cclass=<span class="stringliteral">&quot;CMSIS&quot;</span> ...&gt;</div>
</div><!-- fragment --> <p>&#160;</p>
<p>The table lists predefined Component Classes. </p>
<table  class="cmtable" summary="Predefined Cclass names">
<tr>
<th>Cclass= </th><th>Description  </th></tr>
<tr>
<td class="XML-Token">Audio </td><td>Software components for audio processing  </td></tr>
<tr>
<td class="XML-Token">Board Support </td><td>Components providing interfaces for Evaluation and Development Boards  </td></tr>
<tr>
<td class="XML-Token">Board Part </td><td>Drivers that support an external component available on an evaluation board  </td></tr>
<tr>
<td class="XML-Token">Compiler </td><td>Components implementing compiler specific interfaces (e.g. Retargeting)  </td></tr>
<tr>
<td class="XML-Token">CMSIS </td><td>Components defined by Cortex Microcontroller Software Interface Standard (e.g. <a href="../../Core/html/index.html" class="el">CMSIS-Core(M)</a>, <a href="../../Core_A/html/index.html" class="el">CMSIS-Core(A)</a>, <a href="../../DSP/html/index.html" class="el">CMSIS-DSP</a> and <a href="../../RTOS/html/index.html" class="el">CMSIS-RTOS</a>)  </td></tr>
<tr>
<td class="XML-Token">CMSIS Driver </td><td>Components implementing unified device drivers compliant to <a href="../../Driver/html/index.html" class="el">CMSIS-Driver</a> (e.g. UART, SPI, USB, etc.)   </td></tr>
<tr>
<td class="XML-Token">Device </td><td>Components containing device specific implementations of non-standard APIs (e.g. HAL drivers, CMSIS Startup files)  </td></tr>
<tr>
<td class="XML-Token">Data Exchange </td><td>Components implementing some kind of data exchange or data formatter  </td></tr>
<tr>
<td class="XML-Token">Extension Board </td><td>Drivers that support an extension board or shield  </td></tr>
<tr>
<td class="XML-Token">File System </td><td>Components implementing some kind of File Systems (e.g. Flash or RAM based file systems)  </td></tr>
<tr>
<td class="XML-Token">Graphics </td><td>Components implementing some kind of Display and Graphics Software  </td></tr>
<tr>
<td class="XML-Token">IoT Client </td><td>Components implementing some kind of IoT cloud client connector  </td></tr>
<tr>
<td class="XML-Token">IoT Utility </td><td>IoT specific software utility  </td></tr>
<tr>
<td class="XML-Token">Network </td><td>Components implementing some kind of network communications (e.g. TCP/IP Stack)  </td></tr>
<tr>
<td class="XML-Token">RTOS </td><td>Components implementing some kind of real-time operating system (e.g. FreeRTOS, Micrium Real Time Kernel)  </td></tr>
<tr>
<td class="XML-Token">Security </td><td>Components implementing some kind of encryption for secure communication or storage  </td></tr>
<tr>
<td class="XML-Token">USB </td><td>Components implementing some kind of USB interfaces (e.g. Host and Device interfaces)  </td></tr>
<tr>
<td class="XML-Token">Utility </td><td>Generic software utility components  </td></tr>
</table>
<p>&#160;</p>
<p><a class="anchor" id="CgroupType"></a><b>Table: Component Groups</b></p>
<p>Component Group names are specified by the element <b>Cgroup</b> and create categories within a Component Class specified by the element <b>Cclass</b>. The creator of the Pack can define the names in the element <a class="el" href="element_taxonomy.html#element_taxonomyDescription">/package/taxonomy/description</a>. A Component Group name is string with a length between 3 and 32 characters.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line">&lt;... Cgroup=<span class="stringliteral">&quot;RTOS&quot;</span> Cclass=<span class="stringliteral">&quot;CMSIS&quot;</span>...&gt;</div>
</div><!-- fragment --> <p>&#160;</p>
<p>Component Groups can be used in the elements:</p>
<ul>
<li><a class="el" href="pdsc_conditions_pg.html#element_accept">/package/conditions/condition/accept</a></li>
<li><a class="el" href="pdsc_conditions_pg.html#element_require">/package/conditions/condition/require</a></li>
<li><a class="el" href="pdsc_conditions_pg.html#element_deny">/package/conditions/condition/deny</a></li>
<li><a class="el" href="pdsc_examples_pg.html#element_example_attribute_component">/package/examples/example/attributes/component</a></li>
<li><a class="el" href="pdsc_components_pg.html#element_component">/package/components/.../component</a></li>
<li><a class="el" href="pdsc_apis_pg.html#element_api">/package/apis/api</a></li>
<li><a class="el" href="element_taxonomy.html#element_taxonomyDescription">/package/taxonomy/description</a></li>
</ul>
<p>The following table lists predefined values for the Component Class <b>Cclass="CMSIS"</b>. </p>
<table  class="cmtable" summary="Predefined Cgroup names for Component Class CMSIS">
<tr>
<th>Cgroup= </th><th>Description  </th></tr>
<tr>
<td class="XML-Token">CORE </td><td>A component containing core support in accordance to the <a href="../../Core/html/index.html" class="el">CMSIS-Core(M)</a> or <a href="../../Core_A/html/index.html" class="el">CMSIS-Core(A)</a> specifications.  </td></tr>
<tr>
<td class="XML-Token">DSP </td><td>A component implementing the <a href="../../DSP/html/index.html" class="el">CMSIS-DSP</a> API specification.  </td></tr>
<tr>
<td class="XML-Token">NN Lib </td><td>A component implementing the <a href="../../NN/html/index.html" class="el">CMSIS-NN</a> API specification.  </td></tr>
<tr>
<td class="XML-Token">RTOS </td><td>A component implementing the <a href="../../RTOS/html/index.html" class="el">CMSIS-RTOS</a> API specification.  </td></tr>
<tr>
<td class="XML-Token">RTOS2 </td><td>A component implementing the <a href="../../RTOS2/html/index.html" class="el">CMSIS-RTOS v2</a> API specification.  </td></tr>
</table>
<p>The following table lists predefined values for the Component Class <b>Cclass="Device"</b>. </p>
<table  class="cmtable" summary="Predefined Cgroup names for Component Class Device">
<tr>
<th>Cgroup= </th><th>Description  </th></tr>
<tr>
<td class="XML-Token">Startup </td><td>A component containing the device support files system_device.c and startup_device.s/c in accordance to the <a href="../../Core/html/index.html" class="el">CMSIS-Core(M)</a> or <a href="../../Core_A/html/index.html" class="el">CMSIS-Core(A)</a> specifications (startup, system and device files).  </td></tr>
</table>
<p>&#160;</p>
</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 Thu Apr 9 2020 15:49:54 for CMSIS-Pack Version 1.6.3 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>