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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
|
<!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/boards element</title>
<title>CMSIS-Pack: /package/boards 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('pdsc_boards_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/boards element </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>The level <b><boards></b> describes a development board that is the subject of a Board Support Pack (BSP). It contains information about the board vendor and name, a brief description, images to be displayed on web pages, and different types of documentation. The microcontroller devices that are mounted on the board or that are compatible with the ones mounted are also specified. A list of features concludes the <boards> section.</p>
<p>A development board is described by the following properties:</p>
<ul>
<li>description: a brief description of the development board</li>
<li><a class="el" href="pdsc_boards_pg.html#element_board_book">book</a>: documentation about the board (user manuals, schematics, etc.)</li>
<li><a class="el" href="pdsc_boards_pg.html#element_board_mountedDevice">mountedDevice</a>: the microcontroller device mounted on the development board.</li>
<li><a class="el" href="pdsc_boards_pg.html#element_board_compatibleDevice">compatibleDevice</a>: compatible microcontroller devices.</li>
<li><a class="el" href="pdsc_boards_pg.html#element_board_image">image</a>: pictures of the board to be displayed on web pages.</li>
<li><a class="el" href="pdsc_boards_pg.html#element_board_feature">feature</a>: categorized list of the development board's features and peripherals.</li>
<li><a class="el" href="pdsc_boards_pg.html#element_board_debugInterface">debugInterface</a>: describing the debug capabilities.</li>
</ul>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><boards></div>
<div class="line"> <board vendor=<span class="stringliteral">"STMicroelectronics"</span> name=<span class="stringliteral">"32F429IDISCOVERY"</span> revision=<span class="stringliteral">"Rev.1"</span> salesContact=<span class="stringliteral">"http://www.st.com/stonline/contactus/contacts/index.php"</span> orderForm=<span class="stringliteral">"https://my.st.com/esample/app?page=basket&amp;pn=STM32F429I-DISCO"</span>></div>
<div class="line"> </div>
<div class="line"> <description>STMicroelectronics STM32F429I Discovery Board Support and Examples</description></div>
<div class="line"> </div>
<div class="line"> <image small=<span class="stringliteral">"Images/stm32f429i-disco_small.png"</span> large=<span class="stringliteral">"Images/stm32f429i-disco.png"</span>/></div>
<div class="line"> </div>
<div class="line"> <book category=<span class="stringliteral">"overview"</span> name=<span class="stringliteral">"http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1199/PF259090"</span> title=<span class="stringliteral">"32F429IDISCOVERY Web Page"</span>/></div>
<div class="line"> <book category=<span class="stringliteral">"setup"</span> name=<span class="stringliteral">"Documents/UM1662.pdf"</span> title=<span class="stringliteral">"Getting Started"</span>/></div>
<div class="line"> <book category=<span class="stringliteral">"schematic"</span> name=<span class="stringliteral">"Documents/UM1670.pdf"</span> title=<span class="stringliteral">"Schematics"</span>/></div>
<div class="line"> <book category=<span class="stringliteral">"manual"</span> name=<span class="stringliteral">"Documents/UM1670.pdf"</span> title=<span class="stringliteral">"User Manual"</span>/></div>
<div class="line"> </div>
<div class="line"> <mountedDevice deviceIndex=<span class="stringliteral">"0"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span> Dname=<span class="stringliteral">"STM32F429ZI"</span>/></div>
<div class="line"> </div>
<div class="line"> <compatibleDevice deviceIndex=<span class="stringliteral">"0"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span> Dfamily=<span class="stringliteral">"STM32F4 Series"</span> DsubFamily=<span class="stringliteral">"STM32F429 Line"</span>/></div>
<div class="line"> </div>
<div class="line"> <feature type=<span class="stringliteral">"ODbg"</span> n=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"On-board ST-LINK/V2 with selection mode switch to use the kit as a standalone"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"XTAL"</span> n=<span class="stringliteral">"80000000"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"PWR"</span> n=<span class="stringliteral">"5"</span> name=<span class="stringliteral">"USB Powered"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"PWR"</span> n=<span class="stringliteral">"3"</span> m=<span class="stringliteral">"5"</span> name=<span class="stringliteral">"External Supply"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"RAM"</span> n=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"64 MBit SDRAM"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"DIO"</span> n=<span class="stringliteral">"4"</span> m=<span class="stringliteral">"32"</span> name=<span class="stringliteral">"Extension header for LQFP144 with 2.54 mm Pitch"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"USB"</span> n=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"High-Speed USB OTG with micro-AB Connector"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"ConnOther"</span> n=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"JP3 (Idd) for current measurement"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"Button"</span> n=<span class="stringliteral">"2"</span> name=<span class="stringliteral">"Push-buttons: User and Reset"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"Gyro"</span> n=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"L3GD20, ST MEMS motion sensor, 3-axis digital output gyroscope"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"LED"</span> n=<span class="stringliteral">"6"</span> name=<span class="stringliteral">"Com, 3.3 V Power, Two user, Two USB OTG LEDs"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"CustomFF"</span> n=<span class="stringliteral">"66"</span> m=<span class="stringliteral">"119.3"</span> name=<span class="stringliteral">"Discovery Board Formfactor"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"GLCD"</span> n=<span class="stringliteral">"1"</span> m=<span class="stringliteral">"240.320"</span> name=<span class="stringliteral">"2.4 inch QVGA TFT LCD"</span>/></div>
<div class="line"> </div>
<div class="line"> <debugInterface adapter=<span class="stringliteral">"ST-Link"</span> connector=<span class="stringliteral">"Mini-USB"</span>/></div>
<div class="line"> </div>
<div class="line"> </board></div>
<div class="line"></boards></div>
</div><!-- fragment --><p> </p>
<hr/>
<h1><a class="anchor" id="element_boards"></a>
/package/boards</h1>
<p>Grouping element for boards. No more than one such group can exist in a Pack. None is required.</p>
<table class="cmtable" summary="Element: Boards">
<tr>
<th>Parent </th><th colspan="3">Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_package_pg.html">package</a> </td><td colspan="3"><a class="el" href="pdsc_package_pg.html">/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="pdsc_boards_pg.html#element_board">board</a> </td><td>Description of the board </td><td>BoardType </td><td>1..* </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_board"></a>
/package/boards/board</h1>
<p>This element provides information to specify the <a class="el" href="createPackBoard.html">Board Support Package (BSP)</a>. At least one board must be defined.</p>
<table class="cmtable" summary="Element: Board">
<tr>
<th>Parent </th><th colspan="3">Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_boards_pg.html#element_boards">boards</a> </td><td colspan="3"><a class="el" href="pdsc_boards_pg.html#element_boards">/package/boards</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>vendor </td><td>name of the board vendor </td><td>xs:string </td><td>required </td></tr>
<tr>
<td>name </td><td>name of the development board </td><td>xs:string </td><td>required </td></tr>
<tr>
<td>revision </td><td>Revision of the board that is suited to be used with the <a class="el" href="createPackBoard.html">BSP</a>. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td>salesContact </td><td>Either an email address or web page to contact the sales department. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td>orderForm </td><td>Link to a web page for ordering the development board. </td><td>xs:anyURI </td><td>optional </td></tr>
<tr>
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
<tr>
<td>description </td><td>Brief summary of the board </td><td>xs:string </td><td>1 </td></tr>
<tr>
<td><a class="el" href="pdsc_boards_pg.html#element_board_feature">feature</a> </td><td>Describes the features of the development board. </td><td>BoardsFeatureType </td><td>1..* </td></tr>
<tr>
<td><a class="el" href="pdsc_boards_pg.html#element_board_mountedDevice">mountedDevice</a> </td><td>Specifies the microcontroller device mounted on the development board. </td><td>BoardsDeviceType </td><td>1..* </td></tr>
<tr>
<td><a class="el" href="pdsc_boards_pg.html#element_board_compatibleDevice">compatibleDevice</a> </td><td>Specifies compatible microcontroller devices. </td><td>CompatibleDeviceType </td><td>1..* </td></tr>
<tr>
<td><a class="el" href="pdsc_boards_pg.html#element_board_image">image</a> </td><td>Carries pictures of the boards to be displayed on web pages. Directory and file names are case-sensitive. </td><td>ComplexType </td><td>0..1 </td></tr>
<tr>
<td><a class="el" href="pdsc_boards_pg.html#element_board_debugInterface">debugInterface</a> </td><td>Describes the debug interface of the development board. </td><td>DebugInterfaceType </td><td>1..* </td></tr>
<tr>
<td><a class="el" href="pdsc_boards_pg.html#element_board_book">book</a> </td><td>Describes the documentation files (user manuals, schematics, etc.). Directory and file names are case-sensitive. </td><td>BoardsBookType </td><td>1..* </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_board_feature"></a>
/package/boards/board/feature</h1>
<p>This element contains information about the features and capabilities of a board. A list of pre-defined features exists.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><feature type=<span class="stringliteral">"PWR"</span> n=<span class="stringliteral">"3"</span> m=<span class="stringliteral">"5"</span> name=<span class="stringliteral">"Element: Board feature"</span>/></div>
</div><!-- fragment --> <p> </p>
<table class="cmtable" summary="BoardFeature">
<tr>
<th>Parent </th><th colspan="3">Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_boards_pg.html#element_board">board</a> </td><td colspan="3"><a class="el" href="pdsc_boards_pg.html#element_board">/package/boards/board</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>type </td><td>Defines board features. Select predefined values from the table <a class="el" href="pdsc_boards_pg.html#BoardFeatureTypeEnum">Board Features</a>. </td><td>BoardFeatureTypeEnum </td><td>required </td></tr>
<tr>
<td>n </td><td>Depends on attribute <em><b>type</b>.</em> Check table <a class="el" href="pdsc_boards_pg.html#BoardFeatureTypeEnum">Board Features</a> for details. </td><td>xs:decimal </td><td>optional </td></tr>
<tr>
<td>m </td><td>Depends on attribute <em><b>type</b>.</em> Check table <a class="el" href="pdsc_boards_pg.html#BoardFeatureTypeEnum">Board Features</a> for details. </td><td>xs:decimal </td><td>optional </td></tr>
<tr>
<td>name </td><td>Descriptive name of the feature. If omitted, a <b>Default Name</b> is used (refer to table <a class="el" href="pdsc_boards_pg.html#BoardFeatureTypeEnum">Board Feature Types</a>). <b>Do not repeat</b> the <span class="XML-Token">n</span> or <span class="XML-Token">m</span> values in the name. This will lead to duplicate entries on web sites (they show <span class="XML-Token">n</span> x <span class="XML-Token">name</span>). </td><td>xs:string </td><td>optional </td></tr>
</table>
<p> </p>
<p><a class="anchor" id="BoardFeatureTypeEnum"></a><b>Table: Board Features</b></p>
<p>The table below lists predefined board features.</p>
<dl class="section note"><dt>Note</dt><dd><ul>
<li>The attribute <em>name</em> of the element <a class="el" href="pdsc_boards_pg.html#element_board_feature">/package/boards/board/feature</a> is a descriptive text for a feature. If <em>name</em> is omitted, the <b>Default Name</b> (listed below) is used.</li>
<li><b>Do not repeat</b> the <em>n</em> or <em>m</em> values in the <em>name</em>. Display on websites follows the rule to show <em>n</em> x <em>name</em>.</li>
</ul>
</dd></dl>
<table class="doxtable">
<tr>
<th>type=</th><th>n=</th><th>m=</th><th>Default Name</th><th>Example</th><th>Example shown as </th></tr>
<tr>
<td>ODbg</td><td>Number of Debug Adapters</td><td>N/A</td><td>Integrated Debug Adapter</td><td><feature type="ODbg" n="1" name="Integrated ST-Link on USB Connector J13"/></td><td>1 x Integrated ST-Link on USB Connector J13 </td></tr>
<tr>
<td>XTAL</td><td>Oscillator Frequency</td><td>N/A</td><td>Crystal Oscillator</td><td><feature type="XTAL" n="8000000"/></td><td>8 MHz Crystal Oscillator </td></tr>
<tr>
<td>PWR</td><td>Minimum Input Voltage</td><td>Maximum Input Voltage</td><td>Power Supply</td><td><feature type="PWR" n="8" m="12"/></td><td>8 V - 12 V Power Supply </td></tr>
<tr>
<td>PWRSock</td><td>Number of Power Sockets</td><td>N/A</td><td>Power Socket</td><td><feature type="PWRSock" n="1" name="Coaxial Power Receptacle"/></td><td>1 x Coaxial Power Receptacle </td></tr>
<tr>
<td>Batt</td><td>Number of Batteries</td><td>N/A</td><td>Battery</td><td><feature type="Batt" n="1" name="CR2032 Battery for RTC"/></td><td>1 x CR2032 Battery for RTC </td></tr>
<tr>
<td>Curr</td><td>Typical Current</td><td>Maximum Current</td><td>Current</td><td><feature type="Curr" n="0.320" m="0.375"/></td><td>320 mA (typ), 375 mA (max) Current </td></tr>
<tr>
<td>CoreOther</td><td>Number of Features</td><td>N/A</td><td>Other Core Feature</td><td><feature type="CoreOther" n=1 name="My Other Core Feature"/></td><td>1 x My Other Core Feature </td></tr>
<tr>
<td>RAM</td><td>Number of RAMs</td><td>N/A</td><td>RAM</td><td><feature type="RAM" n="1" name="512 kB Static RAM"/></td><td>1 x 512 kB Static RAM </td></tr>
<tr>
<td>ROM</td><td>Number of ROMs</td><td>N/A</td><td>Flash</td><td><feature type="ROM" n="1" name="4 MB NAND-Flash"/></td><td>1 x 4 MB NAND-Flash </td></tr>
<tr>
<td>Memory</td><td>Number of Additional Memory</td><td>N/A</td><td>Memory</td><td><feature type="Memory" n="128" name="EEPROM"/></td><td>128 byte EEPROM </td></tr>
<tr>
<td>MemCard</td><td>Number of Card Holders</td><td>N/A</td><td>SD/microSD/MMC Card Holder</td><td><feature type="MemCard" n="2" name="SD Card Holder"/></td><td>2 x SD Card Holder </td></tr>
<tr>
<td>MemoryOther</td><td>Number of Other Memory</td><td>N/A</td><td>Other Memory Type</td><td><feature type="MemoryOther" n="1" name="1 kB MRAM"/></td><td>1 x 1 kB MRAM </td></tr>
<tr>
<td>DIO</td><td>Number of Digital I/Os</td><td>N/A</td><td>Digital I/Os</td><td><feature type="DIO" n="26" name="Digital IOs on 2 x 13 pin header (1.27 mm pitch)"/></td><td>26 x Digital IOs on 2 x 13 pin header (1.27 mm pitch) </td></tr>
<tr>
<td>AIO</td><td>Number of Analog I/Os</td><td>N/A</td><td>Analog I/Os</td><td><feature type="AIO" n="4" name="Analog Inputs on 4 pin header (1.27 mm pitch)"/></td><td>4 x Analog Inputs on 4 pin header (1.27 mm pitch) </td></tr>
<tr>
<td>Proto</td><td>n Rows</td><td>m Columns</td><td>Prototyping Area</td><td><feature type="Proto" n="4" m="7" name="Prototyping Area with 1.00 mm pitch"/></td><td>4 x 7 Prototyping Area with 1.00 mm pitch </td></tr>
<tr>
<td>USB</td><td>Number of USB Connectors</td><td>N/A</td><td>USB</td><td><feature type="USB" n="2" name="Full-Speed USB Device, Micro-B receptacle"/></td><td>2 x Full-Speed USB Device, Micro-B receptacle </td></tr>
<tr>
<td>ETH</td><td>Number of Ethernet Connectors</td><td>Data Rate in Bit/s</td><td>Ethernet</td><td><feature type="ETH" n="1" m="10000000" name="RJ45 Receptacle"/></td><td>1 x 10 Mbit/s RJ45 Receptacle </td></tr>
<tr>
<td>SPI</td><td>Number of SPI Connectors</td><td>N/A</td><td>SPI</td><td><feature type="SPI" n="1" name="4-Pin Header, 1.27 mm Pitch"/></td><td>1 x 4-Pin Header, 1.27 mm Pitch </td></tr>
<tr>
<td>I2C</td><td>Number of I2C Connectors</td><td>N/A</td><td>I2C</td><td><feature type="I2C" n="1" name="2-Pin Header, 1.27 mm Pitch"/></td><td>1 x 2-Pin Header, 1.27 mm Pitch </td></tr>
<tr>
<td>RS232</td><td>Number of RS232 Connectors</td><td>N/A</td><td>RS232</td><td><feature type="RS232" n="1" name="DB9 Male Connector"/></td><td>1 x DB9 Male Connector </td></tr>
<tr>
<td>RS422</td><td>Number of RS422 Connectors</td><td>N/A</td><td>RS422</td><td><feature type="RS422" n="1" name="4-Pin Header, 1.27 mm Pitch"/></td><td>1 x 4-Pin Header, 1.27 mm Pitch </td></tr>
<tr>
<td>RS485</td><td>Number of RS485 Connectors</td><td>N/A</td><td>RS485</td><td><feature type="RS485" n="1" name="DB9 Male Connector"/></td><td>1 x DB9 Male Connector </td></tr>
<tr>
<td>CAN</td><td>Number of CAN Connectors</td><td>N/A</td><td>CAN</td><td><feature type="CAN" n="1" name="DB9 Male Connector"/></td><td>1 x DB9 Male Connector </td></tr>
<tr>
<td>IrDA</td><td>Number of IrDA Diodes</td><td>N/A</td><td>Diode</td><td><feature type="IrDA" n="1" name="Diode Transceiver"/></td><td>1 x Diode Transceiver </td></tr>
<tr>
<td>LineIn</td><td>Number of Line In Jacks</td><td>N/A</td><td>Line In</td><td><feature type="LineIn" n="1" name="TRS Audio Jack"/></td><td>1 x TRS Audio Jack </td></tr>
<tr>
<td>LineOut</td><td>Number of Line Out Jacks</td><td>N/A</td><td>Line Out</td><td><feature type="LineOut" n="1" name="TRS Audio Jack"/></td><td>1 x TRS Audio Jack </td></tr>
<tr>
<td>MIC</td><td>Number of Microphone Jacks</td><td>N/A</td><td>Microphone</td><td><feature type="MIC" n="1" name="TS Audio Jack (Mono)"/></td><td>1 x TS Audio Jack (Mono) </td></tr>
<tr>
<td>Edge</td><td>n Rows</td><td>m Columns</td><td>Edge</td><td><feature type="Edge" n="2" m="24"/></td><td>2 x 24 Pin Edge </td></tr>
<tr>
<td>ConnOther</td><td>Number of Other Connectors</td><td>N/A</td><td>Other Connector Type</td><td><feature type="ConnOther" n="1" name="My Other Connector"/></td><td>1 x My Other Connector </td></tr>
<tr>
<td>Button</td><td>Number of Push-Buttons</td><td>N/A</td><td>Push-buttons</td><td><feature type="Button" n="3" name="Push-buttons: Reset, Wake Up, User"/></td><td>3 Push-buttons: Reset, Wake Up, User </td></tr>
<tr>
<td>Poti</td><td>Number of Potentiometer</td><td>N/A</td><td>Potentiometer</td><td><feature type="Poti" n="1"/></td><td>1 x Potentiometer </td></tr>
<tr>
<td>Joystick</td><td>Number of Joysticks</td><td>N/A</td><td>Joystick</td><td><feature type="Joystick" n="1" name="5-position Joystick"/></td><td>1 x 5-position Joystick </td></tr>
<tr>
<td>Touch</td><td>Number of Touch Keys</td><td>N/A</td><td>Touch Keys/Area</td><td><feature type="Touch" n="1"/></td><td>1 x Touch Keys/Area </td></tr>
<tr>
<td>ContOther</td><td>Number of Other Controls</td><td>N/A</td><td>Other Control</td><td><feature type="ContOther" n=1 name="My Other Control Feature"/></td><td>1 x My Other Control Feature </td></tr>
<tr>
<td>Accelerometer</td><td>Number of Accelerometer</td><td>N/A</td><td>Accelerometer</td><td><feature type="Accelerometer" n="1" name="3-axis digital Accelerometer"/></td><td>1 x 3-axis digital Accelerometer </td></tr>
<tr>
<td>Gyro</td><td>Number of Gyroscopes</td><td>N/A</td><td>Gyroscope</td><td><feature type="Gyro" n="1" name="3-axis digital Gyroscope"/></td><td>1 x 3-axis digital Gyroscope </td></tr>
<tr>
<td>Compass</td><td>Number of Compass</td><td>N/A</td><td>Digital Compass</td><td><feature type="Compass" n="1" name="High-Precision Digital Compass"/></td><td>1 x High-Precision Digital Compass </td></tr>
<tr>
<td>TempSens</td><td>Number of Temperature Sensors</td><td>N/A</td><td>Temperature Sensor</td><td><feature type="TempSens" n="1"/></td><td>1 x Temperature Sensor </td></tr>
<tr>
<td>PressSens</td><td>Number of Pressure Sensors</td><td>N/A</td><td>Pressure Sensor</td><td><feature type="PressSens" n="1"/></td><td>1 x Pressure Sensor </td></tr>
<tr>
<td>LightSens</td><td>Number of Light Sensors</td><td>N/A</td><td>Ambient Light Sensor</td><td><feature type="LightSens" n="1"/></td><td>1 x Ambient Light Sensor </td></tr>
<tr>
<td>SensOther</td><td>Number of Other Sensors</td><td>N/A</td><td>Other Sensor</td><td><feature type="SensOther" n=1 name="My Other Sensor Feature"/></td><td>1 x My Other Sensor Feature </td></tr>
<tr>
<td>CustomFF</td><td>x [mm]</td><td>y [mm]</td><td>Custom Formfactor</td><td><feature type="CustomFF" n="54" m="26" name="40-Pin DIP with 0.1-inch Pitch"/></td><td>54 mm x 26 mm, 40-Pin DIP with 0.1-inch Pitch </td></tr>
<tr>
<td>ArduinoFF</td><td>1</td><td>N/A</td><td>Arduino Formfactor</td><td><feature type="ArduinoFF" n="1"/></td><td>Arduino Formfactor </td></tr>
<tr>
<td>FreedomFF</td><td>1</td><td>N/A</td><td>Freedom Formfactor</td><td><feature type="FreedomFF" n="1"/></td><td>Freedom Formfactor </td></tr>
<tr>
<td>TowerFF</td><td>1</td><td>N/A</td><td>Tower Formfactor</td><td><feature type="TowerFF" n="1"/></td><td>Tower Formfactor </td></tr>
<tr>
<td>LED</td><td>Number of LEDs</td><td>N/A</td><td>LEDs</td><td><feature type="LED" n="3" name="Multicolor LEDs"/></td><td>3 x Multicolor LEDs </td></tr>
<tr>
<td>Camera</td><td>Number of Camera Interfaces</td><td>N/A</td><td>Camera</td><td><feature type="Camera" n="1" name="Digital VGA Camera"/></td><td>1 x Digital VGA Camera </td></tr>
<tr>
<td>LCD</td><td>Number of Segment LCD Controller</td><td>Com.Seg as a decimal number (see example)</td><td>LCD</td><td><feature type="LCD" n="1" m="16.40" name="Segment LCD Controller"/></td><td>1 x 16 x 40 Segment LCD Controller </td></tr>
<tr>
<td>GLCD</td><td>Number of Graphic LCD Controller</td><td>Maximum Resolution as a decimal number (see example)</td><td>GLCD</td><td><feature type="GLCD" n="1" m="320.240" name="2.4 inch Color TFT LCD with resistive touchscreen"/></td><td>320 x 240 Pixel 2.4 inch Color TFT LCD with resistive touchscreen </td></tr>
<tr>
<td>Speaker</td><td>Number of Speakers</td><td>N/A</td><td>Speaker</td><td><feature type="Speaker" n="1"/></td><td>1 x Speaker </td></tr>
<tr>
<td>Other</td><td>Number of Other Features</td><td>N/A</td><td>Other Feature</td><td><feature type="Other" n=1 name="My Other Feature"/></td><td>1 x My Other Feature </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_board_mountedDevice"></a>
/package/boards/board/mountedDevice</h1>
<p>The element specifies the devices mounted on the board. At least one device must be specified.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><mountedDevice deviceIndex=<span class="stringliteral">"0"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span> Dname=<span class="stringliteral">"STM32F429ZI"</span>/></div>
</div><!-- fragment --> <p> </p>
<table class="cmtable" summary="Element: Boards mountedDevice">
<tr>
<th>Parent </th><th colspan="3">Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_boards_pg.html#element_board">board</a> </td><td colspan="3"><a class="el" href="pdsc_boards_pg.html#element_board">/package/boards/board</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>deviceIndex </td><td>Index number of the device (in case more than one device is present on the board). </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td>Dvendor </td><td>Is the name of vendor of the device specified by <span class="XML-Token">Dname</span>. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DeviceVendorEnum">Device Vendor</a>. </td><td>DeviceVendorEnum </td><td>required </td></tr>
<tr>
<td>Dfamily </td><td>Is the name of the target device family used on the board. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td>DsubFamily </td><td>Is the name of the target device sub family used on the board. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td>Dname </td><td>Is the name of the target device used on the board. </td><td>xs:string </td><td>optional </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_board_compatibleDevice"></a>
/package/boards/board/compatibleDevice</h1>
<p>This element contains information about devices that are compatible to the device used on the board. Compatible means that the user is able to generate code for compatible devices and test it on the development board. At least one compatible device must be specified.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><compatibleDevice deviceIndex=<span class="stringliteral">"0"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span> Dfamily=<span class="stringliteral">"STM32F4 Series"</span> DsubFamily=<span class="stringliteral">"STM32F429 Line"</span>/></div>
</div><!-- fragment --> <p> </p>
<table class="cmtable" summary="Element: Board compatibleDevice">
<tr>
<th>Parent </th><th colspan="3">Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_boards_pg.html#element_board">board</a> </td><td colspan="3"><a class="el" href="pdsc_boards_pg.html#element_board">/package/boards/board</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>deviceIndex </td><td>Index number of the device (in case more than one device is present on the board). </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td>Dvendor </td><td>Vendor name of the target device specified by <b>Dname</b>. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DeviceVendorEnum">Device Vendor</a>. This element is required if at least one of the following attributs is defined: <b>Dname</b>, <b>DsubFamily</b>, <b>Dfamily</b>. </td><td>DeviceVendorEnum </td><td>optional </td></tr>
<tr>
<td>Dfamily </td><td>Name of the target device family used on the board. Requires <b>Dvendor</b> to be specified. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td>DsubFamily </td><td>Name of the target device sub-family used on the board. Requires <b>Dvendor</b> to be specified. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td>Dname </td><td>Name of the target device used on the board. Requires <b>Dvendor</b> to be specified. </td><td>xs:string </td><td>optional </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_board_image"></a>
/package/boards/board/image</h1>
<p>This element specifies the picture of a development board. Maximum one image element can be specified. None must be specified. Two different picture types (<span class="XML-Token">small</span> and <span class="XML-Token">large</span>) can be specified for the same image element at the same time.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><image small=<span class="stringliteral">"Images\board_image_small.png"</span> large=<span class="stringliteral">"Images\board_image.png"</span>/></div>
</div><!-- fragment --> <p> </p>
<table class="cmtable" summary="Element: Board Image">
<tr>
<th>Parent </th><th colspan="3">Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_boards_pg.html#element_board">board</a> </td><td colspan="3"><a class="el" href="pdsc_boards_pg.html#element_board">/package/boards/board</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>small </td><td>Specifies the path to a small image. The path is relative to the Pack base directory. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td>large </td><td>Specifies the path to a large image. The path is relative to the Pack base directory. </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>
<hr/>
<h1><a class="anchor" id="element_board_debugInterface"></a>
/package/boards/board/debugInterface</h1>
<p>This element describes the debug interface of a board. At least debug interface must be specified.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><debugInterface adapter=<span class="stringliteral">"JTAG/SW"</span> connector=<span class="stringliteral">"20-pin Arm Standard JTAG Connector (0.1 inch connector)"</span>/></div>
<div class="line"><debugInterface adapter=<span class="stringliteral">"JTAG/SW"</span> connector=<span class="stringliteral">"10-pin Cortex Debug Connector (0.05 inch connector)"</span>/></div>
<div class="line"><debugInterface adapter=<span class="stringliteral">"JTAG/SW"</span> connector=<span class="stringliteral">"20-pin Cortex Debug + ETM Connector (0.05 inch connector)"</span>/></div>
<div class="line"><debugInterface adapter=<span class="stringliteral">"ST-Link"</span> connector=<span class="stringliteral">"Mini-USB"</span>/></div>
</div><!-- fragment --> <p> </p>
<table class="cmtable" summary="Element: BoardDebugInterface">
<tr>
<th>Parent </th><th colspan="3">Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_boards_pg.html#element_board">board</a> </td><td colspan="3"><a class="el" href="pdsc_boards_pg.html#element_board">/package/boards/board</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>adapter </td><td>String describing the debug adapter. Common adapters are: <span class="XML-Token">JTAG/SW</span> (for all adapters supporting JTAG and Serial-Wire Debug), <span class="XML-Token">CMSIS-DAP</span>, <span class="XML-Token">OpenSDA</span>, <span class="XML-Token">J-Link</span>, <span class="XML-Token">ST-Link</span>, <span class="XML-Token">Nu-Link</span>. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td>connector </td><td>String describing the debug connector. Usually one of these: <span class="XML-Token">10-pin Cortex Debug Connector</span>, <span class="XML-Token">20-pin Arm Standard JTAG Connector</span>, <span class="XML-Token">20-pin Cortex Debug + ETM Connector</span>, <span class="XML-Token">Mini-USB</span>, <span class="XML-Token">Micro-USB</span>. </td><td>xs:string </td><td>optional </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_board_book"></a>
/package/boards/board/book</h1>
<p>The element provides information about documentation parts related to a development board. At least one book must be defined.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><book category=<span class="stringliteral">"setup"</span> name=<span class="stringliteral">"Documents/UM1662.pdf"</span> title=<span class="stringliteral">"Getting Started"</span>/></div>
</div><!-- fragment --> <p> </p>
<table class="cmtable" summary="Element: Books">
<tr>
<th>Parent </th><th colspan="3">Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_boards_pg.html#element_board">board</a> </td><td colspan="3"><a class="el" href="pdsc_boards_pg.html#element_board">/package/boards/board</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>category </td><td>Describes the type of documentation. Use predefined values as defined in the table <a class="el" href="pdsc_boards_pg.html#BoardBookCategoryEnum">Board Book Categories</a>. </td><td>BoardBookCategoryEnum </td><td>optional </td></tr>
<tr>
<td>name </td><td>Is the name of the document (including the path within the Pack). </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td>title </td><td>Is the title of the document to be displayed in the <b>Books</b> window of uVision. </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="BoardBookCategoryEnum"></a><b>Table: Board Book Categories</b></p>
<p>The table lists values to identify a specific type of documentation for development boards. </p>
<table class="cmtable" summary="Type: BoardBookCategoryEnum">
<tr>
<th>category= </th><th>Description </th></tr>
<tr>
<td class="XML-Token">setup </td><td>Documentation about how to setup the development board. </td></tr>
<tr>
<td class="XML-Token">schematic </td><td>Schematics of the development board. </td></tr>
<tr>
<td class="XML-Token">overview </td><td>Overview/data sheet of the development board. </td></tr>
<tr>
<td class="XML-Token">manual </td><td>User manual of the development board </td></tr>
<tr>
<td class="XML-Token">layout </td><td>PCB layout file of the board (e.g. in Gerber format) </td></tr>
<tr>
<td class="XML-Token">other </td><td>All other documentation. </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:01 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>
|
