1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
<!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
 <span id="projectnumber">Version 1.6.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('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"> </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/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"><package></div>
<div class="line"> ...</div>
<div class="line"> <taxonomy></div>
<div class="line"> ...</div>
<div class="line"> </taxonomy></div>
<div class="line"> ...</div>
<div class="line"></package></div>
</div><!-- fragment --><p> </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> </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> </p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><taxonomy></div>
<div class="line"> <description Cclass=<span class="stringliteral">"Board Support"</span>>Generic Interfaces <span class="keywordflow">for</span> Evaluation and Development Boards</description></div>
<div class="line"> <description Cclass=<span class="stringliteral">"CMSIS"</span> doc=<span class="stringliteral">"CMSIS/Documentation/General/html/index.html"</span>>Cortex Microcontroller Software Interface Components</description></div>
<div class="line"> <description Cclass=<span class="stringliteral">"Device"</span> doc=<span class="stringliteral">"CMSIS/Documentation/Core/html/index.html"</span>>Startup, System Setup</description></div>
<div class="line"> <description Cclass=<span class="stringliteral">"CMSIS Driver"</span> doc=<span class="stringliteral">"CMSIS/Documentation/Driver/html/index.html"</span>>Unified Device Drivers compliant to CMSIS-Driver Specifications</description></div>
<div class="line"> <description Cclass=<span class="stringliteral">"File System"</span>>File Drive Support and File System</description></div>
<div class="line"> <description Cclass=<span class="stringliteral">"Graphics"</span>>Graphical User Interface</description></div>
<div class="line"> <description Cclass=<span class="stringliteral">"Network"</span>>Network Stack <span class="keyword">using</span> Internet Protocols</description></div>
<div class="line"> <description Cclass=<span class="stringliteral">"USB"</span>>Universal Serial Bus Stack</description></div>
<div class="line"> <description Cclass=<span class="stringliteral">"RTOS"</span>>Realtime Operating System</description></div>
<div class="line"></taxonomy></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">< (less than)
> (greater than)
: (colon)
" (double quote)
/ (forward slash)
\ (backslash)
| (vertical bar or pipe)
? (question mark)
* (asterisk)
</pre></dd></dl>
<p> </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><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>
</table>
<p> </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>
<li><a class="el" href="cpdsc_pg.html#element_project_component">/package/create/project/select/component</a></li>
</ul>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><... Cclass=<span class="stringliteral">"CMSIS"</span> ...></div>
</div><!-- fragment --> <p> </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> </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"><... Cgroup=<span class="stringliteral">"RTOS"</span> Cclass=<span class="stringliteral">"CMSIS"</span>...></div>
</div><!-- fragment --> <p> </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>
<li><a class="el" href="cpdsc_pg.html#element_project_component">/package/create/project/select/component</a></li>
</ul>
<p>The table lists predefined values for the Component Class <b>Cclass="CMSIS"</b>. No other Component Groups have been defined so far. </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 device 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 (startup, system and device files) </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> </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 Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 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>
|
