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
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
|
<!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/devices/family element</title>
<title>CMSIS-Pack: /package/devices/family 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);
</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>
<link href="stylsheetf" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Pack
 <span id="projectnumber">Version 1.4.1</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.2 -->
<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_family_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/devices/family element </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="element_family"></a>
/package/devices/family</h1>
<p>Define properties that are in common to all devices of a family. These properties are inherited by subgroups or elements. This is a mechanism of granulation to reduce redundancy. Multiple <family> groups can be defined.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><devices></div>
<div class="line"> ...</div>
<div class="line"> <family Dfamily=<span class="stringliteral">"STM32F2"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div>
<div class="line"> <processor .../></div>
<div class="line"> <debugconfig .../></div>
<div class="line"> <debugvars .../></div>
<div class="line"> <sequences .../></div>
<div class="line"> <compile .../></div>
<div class="line"> <memory .../></div>
<div class="line"> <algorithm .../></div>
<div class="line"> <book .../></div>
<div class="line"> <description> Write texte here </description></div>
<div class="line"> <environment> ... </environment></div>
<div class="line"> <feature .../></div>
<div class="line"> <debugport .../></div>
<div class="line"> <debug .../></div>
<div class="line"> <trace .../></div>
<div class="line"> </div>
<div class="line"> <subFamily DsubFamily=<span class="stringliteral">"..."</span>></div>
<div class="line"> ...</div>
<div class="line"> <device Dname=<span class="stringliteral">"..."</span>></div>
<div class="line"> ...</div>
<div class="line"> </device></div>
<div class="line"> ...</div>
<div class="line"> </subFamily></div>
<div class="line"> ...</div>
<div class="line"> </family></div>
<div class="line"> ...</div>
<div class="line"></devices></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: family">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_devices_pg.html#element_devices">devices</a> </td><td colspan="3"><a class="el" href="pdsc_devices_pg.html#element_devices">/package/devices</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>Dfamily </td><td>Name of the device family. </td><td>xs:string </td><td>required </td></tr>
<tr>
<td>Dvendor </td><td>Device vendor name. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DeviceVendorEnum">Device Vendor</a>. </td><td><a class="el" href="pdsc_family_pg.html#DeviceVendorEnum">DeviceVendorEnum</a> </td><td>required </td></tr>
<tr>
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_processor">processor</a> </td><td>List all processors that are in common to devices of the family. </td><td>ProcessorType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_compile">compile</a> </td><td>Specify compile or translate options that are relevant to all devices of the family. </td><td>CompileType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debugconfig">debugconfig</a> </td><td>Specify default settings for the debug connection relevant to all devices of the family. </td><td>DebugConfigType </td><td>0..1 </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debugvars">debugvars</a> </td><td>Define global debug access variables for settings relevant to all devices of the family unless replaced by debugvars on subFamily, device or variant level </td><td>DebugVarsType </td><td>0..1 </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_sequences">sequences</a> </td><td>Describe debug access sequences relevant to all devices of the family. </td><td>SequencesType </td><td>0..1 </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debugport">debugport</a> </td><td>Describe a debug port relevant to all devices of the family. </td><td>DebugPortType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debug">debug</a> </td><td>Specify debug options that are relevant to all devices of the family. </td><td>DebugType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_trace">trace</a> </td><td>Specify trace options that are relevant to all devices of the family. </td><td>TraceType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_memory">memory</a> </td><td>Specify memory areas that are available for all devices of the family. </td><td>MemoryType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_algorithm">algorithm</a> </td><td>Specify Flash programming algorithms that are suitable for all devices. </td><td>AlgorithmType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_book">book</a> </td><td>Specify documents that are relevant for all devices of a family. </td><td>BookType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_description">description</a> </td><td>Describe the device family. </td><td>DescriptionType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_environment">environment</a> </td><td>Specify tool specific settings. </td><td>EnvironmentType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_feature">feature</a> </td><td>Specify features that are available in all members of the device family. </td><td>FeatureType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td>A optional sub-family that is used to group devices. </td><td>group </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td>Individual devices that belong to the device family. </td><td>DeviceType </td><td>0..* </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_subFamily"></a>
/package/devices/family/subFamily</h1>
<p>Define properties that are in common to all devices of a subFamily. This is another mechanism of granulation to reduce redundancy. These properties are inherited by subgroups or elements. Multiple <subFamily> groups can be defined.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"STM32F2"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div>
<div class="line"> ... </div>
<div class="line"> <subFamily DsubFamily=<span class="stringliteral">"..."</span>></div>
<div class="line"> <processor .../></div>
<div class="line"> <debugconfig .../></div>
<div class="line"> <debugvars .../></div>
<div class="line"> <sequences .../></div>
<div class="line"> <compile .../></div>
<div class="line"> <memory .../></div>
<div class="line"> <algorithm .../></div>
<div class="line"> <book .../></div>
<div class="line"> <description> Write texte here </description></div>
<div class="line"> <feature .../></div>
<div class="line"> <debugport .../></div>
<div class="line"> <debug .../></div>
<div class="line"> <trace .../></div>
<div class="line"> <device Dname=<span class="stringliteral">"..."</span>></div>
<div class="line"> ...</div>
<div class="line"> </device></div>
<div class="line"> </subFamily></div>
<div class="line"></div>
<div class="line"> <subFamily DsubFamily=<span class="stringliteral">"STM32F2xx"</span>></div>
<div class="line"> ...</div>
<div class="line"> </subFamily></div>
<div class="line"></div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: subFamily">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>DsubFamily </td><td>Name of the device sub family. </td><td>xs:string </td><td>required </td></tr>
<tr>
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_processor">processor</a> </td><td>Specify processors that are available in all devices of the sub-family. </td><td>ProcessorType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_compile">compile</a> </td><td>Specify compile or translate options that are relevant to all devices of the sub-family. </td><td>CompileType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debugconfig">debugconfig</a> </td><td>Specify default settings for the debug connection relevant to all devices of the sub-family. </td><td>DebugConfigType </td><td>0..1 </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debugvars">debugvars</a> </td><td>Define global debug access variables for user-defined settings relevant to all devices of the sub-family. </td><td>DebugVarsType </td><td>0..1 </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_sequences">sequences</a> </td><td>Describe debug access sequences relevant to all devices of the sub-family. </td><td>SequencesType </td><td>0..1 </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debugport">debugport</a> </td><td>Describe a debug port relevant to all devices of the sub-family. </td><td>DebugPortType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debug">debug</a> </td><td>Specify debug options that are relevant to all devices of the sub-family. </td><td>DebugType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_trace">trace</a> </td><td>Specify trace options that are relevant to all devices of the sub-family. </td><td>TraceType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_memory">memory</a> </td><td>Specify memory areas that are available in all device of the sub-family. </td><td>MemoryType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_algorithm">algorithm</a> </td><td>Specify Flash programming algorithms that can be used by all device of the sub-family. </td><td>AlgorithmType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_book">book</a> </td><td>Specify documents relevant for all device of the sub-family. </td><td>BookType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_description">description</a> </td><td>Description of the device family. </td><td>DescriptionType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_feature">feature</a> </td><td>Specify features available in devices of the sub-family. </td><td>FeatureType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td>List individual devices that belong to the device sub-family. </td><td>DeviceType </td><td>0..* </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_device"></a>
/package/devices/family/../device</h1>
<p>Define properties that are specific to a device. Properties defined on upper levels get inherited, unless they can be overwritten. Multiple <device> elements can be defined.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><subFamily DsubFamily=<span class="stringliteral">"STM32F405"</span>></div>
<div class="line"> ...</div>
<div class="line"> <device Dname=<span class="stringliteral">"STM32F405OE"</span>></div>
<div class="line"> <memory name=<span class="stringliteral">"Flash"</span> access=<span class="stringliteral">"rx"</span> start=<span class="stringliteral">"0x08000000"</span> size=<span class="stringliteral">"0x80000"</span> startup=<span class="stringliteral">"1"</span> <span class="keywordflow">default</span>=<span class="stringliteral">"1"</span>/></div>
<div class="line"> <algorithm name=<span class="stringliteral">"Flash/STM32F4xx_1024.flm"</span> start=<span class="stringliteral">"0x08000000"</span> size=<span class="stringliteral">"0x80000"</span> <span class="keywordflow">default</span>=<span class="stringliteral">"1"</span> style=<span class="stringliteral">"Keil"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"IOs"</span> n=<span class="stringliteral">"72"</span> name=<span class="stringliteral">"Input and Output Ports"</span>/></div>
<div class="line"> </device></div>
<div class="line"></div>
<div class="line"> <device Dname=<span class="stringliteral">"STM32F405OG"</span>></div>
<div class="line"> <memory name=<span class="stringliteral">"Flash"</span> access=<span class="stringliteral">"rx"</span> start=<span class="stringliteral">"0x08000000"</span> size=<span class="stringliteral">"0x100000"</span> startup=<span class="stringliteral">"1"</span> <span class="keywordflow">default</span>=<span class="stringliteral">"1"</span>/></div>
<div class="line"> <algorithm name=<span class="stringliteral">"Flash/STM32F4xx_1024.flm"</span> start=<span class="stringliteral">"0x08000000"</span> size=<span class="stringliteral">"0x100000"</span> <span class="keywordflow">default</span>=<span class="stringliteral">"1"</span> style=<span class="stringliteral">"Keil"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"IOs"</span> n=<span class="stringliteral">"72"</span> name=<span class="stringliteral">"Input and Output Ports"</span>/></div>
<div class="line"> </device></div>
<div class="line"> ...</div>
<div class="line"></subFamily></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: device">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>Dname </td><td>Specifies the name of the device. Only alphabetical characters, decimal digits, '-' and '_' are allowed </td><td>RestrictedString </td><td>required </td></tr>
<tr>
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_processor">processor</a> </td><td>Specify processors that are specific to this device. </td><td>ProcessorType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_compile">compile</a> </td><td>Specify compile or translate options specific to this device. </td><td>CompileType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debugconfig">debugconfig</a> </td><td>Specify default settings for the debug connection specific to this device. </td><td>DebugConfigType </td><td>0..1 </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debugvars">debugvars</a> </td><td>Define debug access variables for user-defined settings specific to this device. </td><td>DebugVarsType </td><td>0..1 </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_sequences">sequences</a> </td><td>Describe debug access sequences specific to this device. </td><td>SequencesType </td><td>0..1 </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debugport">debugport</a> </td><td>Describe a debug port specific to this device. </td><td>DebugPortType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debug">debug</a> </td><td>Specify debug options specific to this device. </td><td>DebugType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_trace">trace</a> </td><td>Specify trace options specific to this device. </td><td>TraceType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_memory">memory</a> </td><td>Specify memory areas that specific to this device. </td><td>MemoryType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_algorithm">algorithm</a> </td><td>Specify Flash programming algorithms that can be used by this device. </td><td>AlgorithmType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_book">book</a> </td><td>Specify documents specific to this device. </td><td>BookType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_description">description</a> </td><td>Description specific to this device. </td><td>DescriptionType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_feature">feature</a> </td><td>Specify features specific to this device. </td><td>FeatureType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_variant">variant</a> </td><td>Complex element specifying a variant of a device. </td><td>xs:string </td><td>0..* </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_algorithm"></a>
/package/devices/family/.../algorithm</h1>
<p>Specify Flash programming algorithms with the address range and its size. An algorithm with <default> set to <span class="XML-Token">true</span> gets configured automatically to the download options of the project. Algorithms can be defined on various levels. Multiple <algorithm> elements are possible. If the memory range and style are identical, the one on the lower level takes precedence.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"STM32F4"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div>
<div class="line"> ...</div>
<div class="line"> <!-- use <span class="keywordflow">for</span> all devices of the family --></div>
<div class="line"> <algorithm name=<span class="stringliteral">"Flash\STM32F2xx_512.flm"</span> start=0x08000000 size=0x10000 <span class="keywordflow">default</span>=<span class="stringliteral">"1"</span> style=<span class="stringliteral">"Keil"</span>/></div>
<div class="line"> </div>
<div class="line"> <subFamily DsubFamily=<span class="stringliteral">"STM32F405"</span>></div>
<div class="line"> <!-- use <span class="keywordflow">for</span> all devices of a subFamily --></div>
<div class="line"> <algorithm name=<span class="stringliteral">"Flash/STM32F2xx_1024.flm"</span> start=0x08000000 size=0x20000 <span class="keywordflow">default</span>=<span class="stringliteral">"1"</span> style=<span class="stringliteral">"Keil"</span>/> </div>
<div class="line"></div>
<div class="line"> <device Dname=<span class="stringliteral">"STM32F405OE"</span>></div>
<div class="line"> <!-- <span class="keywordflow">finally</span>, <span class="keyword">this</span> is the <span class="keywordflow">default</span> <span class="keywordflow">for</span> the device --></div>
<div class="line"> <algorithm name=<span class="stringliteral">"Flash/STM32F2xx_2048.flm"</span> start=0x08000000 size=0x40000 <span class="keywordflow">default</span>=<span class="stringliteral">"1"</span>/> style=<span class="stringliteral">"Keil"</span>/></div>
<div class="line"> </device></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Type: AlgorithmType">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>Pname </td><td>Processor identifier. This attribute <b>is mandatory for devices that embed multiple processors that require different algorithms</b>. Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>optional </td></tr>
<tr>
<td>name </td><td>Flash Programming Algorithm file including the path, which is relative to the root folder of the <a class="el" href="_c_p__s_w_components.html">Software Pack</a>. </td><td>xs:string </td><td>required </td></tr>
<tr>
<td>start </td><td>Base address for the Flash programming algorithm. </td><td>NonNegativeInteger </td><td>required </td></tr>
<tr>
<td>size </td><td>Size covered by the Flash programming algorithm. End address = start + size - 1 </td><td>NonNegativeInteger </td><td>required </td></tr>
<tr>
<td>RAMstart </td><td>Base address for the RAM where the Flash programming algorithm will be executed from. If specified, the <a class="el" href="pdsc_family_pg.html#element_memory">memory</a> element does not require a <code>default</code> attribute. </td><td>NonNegativeInteger </td><td>optional </td></tr>
<tr>
<td>RAMsize </td><td>Maximum size of RAM available for the execution of the Flash programming algorithm. End address = start + size - 1 is used for the Stack. If specified, the <a class="el" href="pdsc_family_pg.html#element_memory">memory</a> element does not require a <code>default</code> attribute. </td><td>NonNegativeInteger </td><td>optional </td></tr>
<tr>
<td>default </td><td>If <span class="XML-Token">true</span>, then this is the default Flash programming algorithm that gets configured in a project. If not specified or set to <span class="XML-Token">false</span>, then the Flash programming algorithm can be configured on a lower level. However, the Flash programming algorithm of a project can be changed manually at any time during development. </td><td>xs:boolean </td><td>optional </td></tr>
<tr>
<td>style </td><td>[Version 1.4.0] Today different tool-chains support different styles of incompatible flash programming algorithms. The attribute specifies the style of the specified flash programming algorithm. For backward compatibility the default value is "Keil". The aim is to converge to the <em>CMSIS</em> style. </td><td><a class="el" href="pdsc_family_pg.html#AlgorithmStyleEnum">AlgorithmStyleEnum</a> </td><td><p class="starttd">optional </p>
<p class="endtd"></p>
</td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_book"></a>
/package/devices/family/.../book</h1>
<p>Specifies documents related to a device. Books can be entered on various levels. The book element contains the location, filename, and extension of the file. The title is used for display purposes.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"STM32F4"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div>
<div class="line"> ...</div>
<div class="line"> <book name=<span class="stringliteral">"Documents/STM32F40x_DS.PDF"</span> title=<span class="stringliteral">"STM32F40x Data Sheet"</span>/> <!-- valid <span class="keywordflow">for</span> all devices of the family --></div>
<div class="line"></div>
<div class="line"> <subFamily DsubFamily=<span class="stringliteral">"STM32F405"</span>></div>
<div class="line"> <book name=<span class="stringliteral">"Documents/STM32F4xx_RM.pdf"</span> title=<span class="stringliteral">"STM32F4 Series Reference Manual"</span>/> <!-- valid <span class="keywordflow">for</span> all devices of a subFamily --></div>
<div class="line"></div>
<div class="line"> <device Dname=<span class="stringliteral">"STM32F405OE"</span>></div>
<div class="line"> <book name=<span class="stringliteral">"Documents/STM32F405OE_DS.PDF"</span> title=<span class="stringliteral">"STM32F405OE - Data Sheet"</span>/> <!-- valid <span class="keywordflow">for</span> <span class="keyword">this</span> device; Inherits all above --></div>
<div class="line"> </device></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Type: BookType">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>Pname </td><td>Processor identifier. This attribute <b>is mandatory for devices that embed multiple processors and where the book refers to a single processor only</b>. Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>optional </td></tr>
<tr>
<td>name </td><td>File name of the document including the extension. The document path is relative to the package base folder. Directory/file names are case-sensitive. </td><td>xs:string </td><td>required </td></tr>
<tr>
<td>title </td><td>Book title. Can be used for being displayed in various environments. </td><td>xs:string </td><td>required </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_compile"></a>
/package/devices/family/.../compile</h1>
<p>Specify header files and preprocessor defines for programming. This element can occur on various levels. Multiple elements are allowed. The last occurrence in the hierarchy determines the actual define.</p>
<dl class="section note"><dt>Note</dt><dd><ul>
<li>In the example below, the device <b>STM32F407IG</b> will have a define <code>STM32F407IG</code>. Previous defines are overridden.</li>
<li>It is good practice to add both attributes (<code>header</code> and <code>define</code>) in the attributes list of the <code>compile</code> element together. This clarifies the relationship between header file and define.</li>
</ul>
</dd></dl>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"STM32F4"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div>
<div class="line"> ...</div>
<div class="line"> <compile header=<span class="stringliteral">"Device/Include/stm32f4xx.h"</span>/></div>
<div class="line"></div>
<div class="line"> <subFamily DsubFamily=<span class="stringliteral">"STM32F407"</span>></div>
<div class="line"> ...</div>
<div class="line"> <compile header=<span class="stringliteral">"Device/Include/stm32f4xx.h"</span> define=<span class="stringliteral">"STM32F40XX"</span>/></div>
<div class="line"></div>
<div class="line"> <device Dname=<span class="stringliteral">"STM32F407IG"</span>></div>
<div class="line"> <compile header=<span class="stringliteral">"Device/Include/stm32f4xx.h"</span> define=<span class="stringliteral">"STM32F407IG"</span>/></div>
<div class="line"> </device></div>
<div class="line"> </subFamily></div>
<div class="line"></family></div>
</div><!-- fragment --><table class="cmtable" summary="Element: compile">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>Pname </td><td>Processor identifier. This attribute <b>is mandatory for devices that embed multiple processors if the header and define is different for each processor</b>. Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>optional </td></tr>
<tr>
<td>header </td><td>C-header file with path relative to the installation. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td>define </td><td>C-file name with device specific preprocessor defines. The path is relative to the installation. </td><td>xs:string </td><td>optional </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_description"></a>
/package/devices/family/.../description</h1>
<p>Brief description of the element. Can occur on various levels. Should only contain the unique features of the device. Number of bullet points should not exceed ten. To create a detailed feature list use the <a class="el" href="pdsc_family_pg.html#element_feature">/package/devices/family/.../feature</a> instead.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><package></div>
<div class="line"> <devices></div>
<div class="line"> <family Dfamily=<span class="stringliteral">"STM32F2"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div>
<div class="line"> </div>
<div class="line"> <description></div>
<div class="line"> STM32F2 devices are designed <span class="keywordflow">for</span> medical, industrial and consumer</div>
<div class="line"> applications and provide rich connectivity peripherals.</div>
<div class="line"> - At 120 MHz CPU clock: 150 DMIPS executing from Flash memory </div>
<div class="line"> - ART Accelerator <span class="keywordflow">for</span> low-power Flash execution (175 µA/MHz @ 120 MHz)</div>
<div class="line"> - Flexible Memory Controller supports Compact Flash, SRAM, PSRAM, NOR and NAND</div>
<div class="line"> </description></div>
<div class="line"> </div>
<div class="line"> </family></div>
<div class="line"> </devices></div>
<div class="line"></package></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: description">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>Pname </td><td>Processor Identifier. This attribute <b>is mandatory for devices that embed multiple processors and where the description is specific to a single processor</b>. Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>optional </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_environment"></a>
/package/devices/family/.../environment</h1>
<p>Tool-specific elements for a device.</p>
<p>Can occur on various levels.</p>
<p>Contains information that is specific for a <b>development tool</b> identified by the <em>name</em> attribute. The structure of the <em>element</em> is not specified in the schema file which gives the <b>development tool</b> full control of the <em>element</em> usage.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><package></div>
<div class="line"> <devices></div>
<div class="line"> <family Dfamily=<span class="stringliteral">"MySeries"</span> Dvendor=<span class="stringliteral">"Generic:5"</span>></div>
<div class="line"> ... </div>
<div class="line"> <environment name=<span class="stringliteral">"MyConfigTool"</span>></div>
<div class="line"> <file>MyConfigFile.cfg</file></div>
<div class="line"> <control>MyControlString</control></div>
<div class="line"> ...</div>
<div class="line"> </environment></div>
<div class="line"> ...</div>
<div class="line"> </family></div>
<div class="line"> </devices></div>
<div class="line"></package></div>
</div><!-- fragment --><div class="fragment"><div class="line"><package></div>
<div class="line"> <devices></div>
<div class="line"> <family Dfamily=<span class="stringliteral">"XMC1000 Series"</span> Dvendor=<span class="stringliteral">"Infineon:7"</span>></div>
<div class="line"> ... </div>
<div class="line"> <environment name=<span class="stringliteral">"uv"</span> Pname=<span class="stringliteral">"M0"</span>></div>
<div class="line"> <CMisc>--C99</CMisc></div>
<div class="line"> ...</div>
<div class="line"> </environment></div>
<div class="line"> ...</div>
<div class="line"> </family></div>
<div class="line"> </devices></div>
<div class="line"></package></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: description">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>name </td><td>Name of the development tool (e.g. "uv" for uVision) </td><td>xs:string </td><td>required </td></tr>
<tr>
<td>Pname </td><td>Identifies the processor the setting belongs to. Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>optional </td></tr>
<tr>
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
<tr>
<td>any </td><td>Any element that is available for the specified development tool.<br/>
For uVision, the following elements are available: <CMisc>, <AMisc>, <LMisc>, <preBuild1>, <preBuild2>, <preRun1>, <preRun2>, <postBuild1>, <postBuild2>, <postRun1>, <postRun>. </td><td>xs:anyAttribute </td><td>0..* </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_feature"></a>
/package/devices/family/.../feature</h1>
<p>This element specifies the peripherals that devices can have. Many device feature types are already predefined, such as timers, converters, Ethernet, USB, etc (for a complete list refer to table <a class="el" href="pdsc_family_pg.html#DeviceFeatureTypeEnum">Device Feature Types</a>). Features can be defined on various levels. Inner elements supersede outer elements.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><package></div>
<div class="line"> <devices></div>
<div class="line"> <family Dfamily=<span class="stringliteral">"STM32F4"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div>
<div class="line"> ...</div>
<div class="line"> <!-- Features that are in common to <span class="keyword">this</span> device family. --></div>
<div class="line"> <feature type=<span class="stringliteral">"TimerOther"</span> n=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"Independent Watchdog Timer"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"TimerOther"</span> n=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"Window Watchdog Timer"</span>/> <!-- The same feature type can be specified multiple times --></div>
<div class="line"> <feature type=<span class="stringliteral">"Other"</span> n=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"Temperature Sensor"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"CoreOther"</span> n=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"96-bit Unique Identifier"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"CoreOther"</span> n=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"CRC Calculation Unit"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"DMA"</span> n=<span class="stringliteral">"16"</span> name=<span class="stringliteral">"General Purpose DMA with Centralized FIFO and Burst Support"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"PowerOther"</span> n=<span class="stringliteral">"1"</span> name=<span class="stringliteral">"POR, PDR, PVD, and BOR"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"XTAL"</span> n=<span class="stringliteral">"4000000"</span> m=<span class="stringliteral">"26000000"</span> name=<span class="stringliteral">"Crystal Oscillator"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"IntRC"</span> n=<span class="stringliteral">"16000000"</span> name=<span class="stringliteral">"Internal Factory-Trimmed RC"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"IntRC"</span> n=<span class="stringliteral">"32000"</span> name=<span class="stringliteral">"Internal RC with Calibration"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"RTC"</span> n=<span class="stringliteral">"32000"</span> name=<span class="stringliteral">"RTC with 32 kHz calibrated Oscillator and Battery Backup"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"PowerMode"</span> n=<span class="stringliteral">"3"</span> name=<span class="stringliteral">"Run, Stop, Standby"</span>/></div>
<div class="line"> <feature type=<span class="stringliteral">"Temp"</span> n=<span class="stringliteral">"-40"</span> m=<span class="stringliteral">"85"</span>/> </div>
<div class="line"> <feature type=<span class="stringliteral">"Temp"</span> n=<span class="stringliteral">"-40"</span> m=<span class="stringliteral">"105"</span>/> </div>
<div class="line"> <feature type=<span class="stringliteral">"Timer"</span> n=<span class="stringliteral">"4"</span> m=<span class="stringliteral">"16"</span> name=<span class="stringliteral">"General Purpose Timer"</span>/></div>
<div class="line"> ...</div>
<div class="line"> <subFamily DsubFamily=<span class="stringliteral">"STM32F407"</span>></div>
<div class="line"> <!-- Features that are in common to <span class="keyword">this</span> subFamily. --></div>
<div class="line"> <feature type=<span class="stringliteral">"IOs"</span> n=<span class="stringliteral">"36"</span>/> <!-- Adds <span class="keyword">new</span> feature to subFamily --></div>
<div class="line"> <feature type=<span class="stringliteral">"Timer"</span> n=<span class="stringliteral">"7"</span> m=<span class="stringliteral">"32"</span> name=<span class="stringliteral">"General Purpose Timer"</span>/> <!-- Adds to settings from <family> --></div>
<div class="line"></div>
<div class="line"> </div>
<div class="line"> <device Dname=<span class="stringliteral">"STM32F407IE"</span>></div>
<div class="line"> <!-- Feature specific to <span class="keyword">this</span> device. All above features are inherited. --></div>
<div class="line"> <feature type=<span class="stringliteral">"QFP"</span> n=<span class="stringliteral">"176"</span> name=<span class="stringliteral">"LQFP 176 24x24x1.4"</span>/></div>
<div class="line"> </device></div>
<div class="line"> </subFamily></div>
<div class="line"> </family></div>
<div class="line"> </devices></div>
<div class="line"></package></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: feature">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>Pname </td><td>Processor Identifier. This attribute <b>is mandatory for devices that embed multiple processors</b>. Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>optional </td></tr>
<tr>
<td>type </td><td>A feature (peripheral), such as <span class="XML-Token">CAN</span>, <span class="XML-Token">DMA</span>, <span class="XML-Token">I/O</span>, <span class="XML-Token">LCD</span>, etc. Predefined values must be used as listed in the table <a class="el" href="pdsc_family_pg.html#DeviceFeatureTypeEnum">Device Feature Types</a>. </td><td>DeviceFeatureTypeEnum </td><td>required </td></tr>
<tr>
<td>n </td><td>Depends on the element <em><b>type</b>.</em> Check table <a class="el" href="pdsc_family_pg.html#DeviceFeatureTypeEnum">Device Feature Types</a>. </td><td>xs:decimal </td><td>optional </td></tr>
<tr>
<td>m </td><td>Depends on the elemen <em><b>type</b>.</em> Check table <a class="el" href="pdsc_family_pg.html#DeviceFeatureTypeEnum">Device Feature Types</a>. </td><td>xs:decimal </td><td>optional </td></tr>
<tr>
<td>name </td><td>Descriptive name of the feature. For example, "16-bit down counting timer". If omitted, the <b>Default Name</b> is used as described in the table <a class="el" href="pdsc_family_pg.html#DeviceFeatureTypeEnum">Device Feature Types</a>. </td><td>xs:string </td><td>optional </td></tr>
</table>
<p> </p>
<p><a class="anchor" id="DeviceFeatureTypeEnum"></a><b>Table: Device Feature Types</b></p>
<p>The table lists predefined device features (peripherals). </p>
<dl class="section note"><dt>Note</dt><dd>The attribute <em>name</em> of the element <a class="el" href="pdsc_family_pg.html#element_feature">/package/devices/family/.../feature</a> is a descriptive text for a feature. If <em>name</em> is omitted, then the <b>Default Name</b> is used.</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>NVIC</td><td>Number of NVIC Interrupts</td><td>N/A</td><td>NVIC</td><td><feature type="NVIC" n="120" name="NVIC"/></td><td>NVIC with 120 interrupt sources </td></tr>
<tr>
<td>DMA</td><td>Number of DMA Channels</td><td>N/A</td><td>DMA</td><td><feature type="DMA" n="16" name="High-Speed DMA"/></td><td>16-channel High-Speed DMA </td></tr>
<tr>
<td>Crypto</td><td>Bitwidth, given as decimal Number (see example)</td><td>N/A</td><td>Cryptographic Engine</td><td><feature type="Crypto" n="128.256" name="HW accelerated AES Encryption Engine"/></td><td>128/256-bit HW accelerated AES Encryption Engine </td></tr>
<tr>
<td>RNG</td><td>Number of RNGs</td><td>N/A</td><td>Random Number Generator</td><td><feature type="RNG" name="True Random Number Generator"/></td><td>True Random Number Generator </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="96-bit Unique Identifier"/></td><td>1 x 96-bit Unique Identifier </td></tr>
<tr>
<td>Memory</td><td>Number of Bytes</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>MemoryOther</td><td>Number of Memories</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>ExtBus</td><td>Bitwidth of Bus Interface</td><td>N/A</td><td>External Bus Interface</td><td><feature type="ExtBus" n="16" name="External Bus Interface for SRAM Communication"/></td><td>16-bit External Bus Interface for SRAM Communication </td></tr>
<tr>
<td>XTAL</td><td>Minimum Frequency in Hz</td><td>Maximum Frequency in Hz</td><td>External Crystal Oscillator</td><td><feature type="XTAL" n="4000000" m="25000000" name="External Crystal Oscillator"/></td><td>4 MHz .. 25 MHz External Crystal Oscillator </td></tr>
<tr>
<td>IntRC</td><td>Minimum Frequency in Hz</td><td>Maximum Frequency in Hz</td><td>Internal RC Oscillator</td><td><feature type="IntRC" n="16000000" name="Internal RC Oscillator with +/- 1% accuracy"/></td><td>16 MHz Internal RC Oscillator with +/- 1% accuracy </td></tr>
<tr>
<td>PLL</td><td>Number of PLLs</td><td>N/A</td><td>PLL</td><td><feature type="PLL" n="3" name="Internal PLL"/></td><td>3 Internal PLL </td></tr>
<tr>
<td>RTC</td><td>RTC Frequency</td><td>N/A</td><td>RTC</td><td><feature type="RTC" n="32000" name="Internal RTC"/></td><td>32 kHz Internal RTC </td></tr>
<tr>
<td>ClockOther</td><td>Number of Peripherals</td><td>N/A</td><td>Other Clock Peripheral</td><td><feature type="ClockOther" name="My special clock feature"/></td><td>My special clock feature </td></tr>
<tr>
<td>PowerMode</td><td>Number of Power Modes</td><td>N/A</td><td>Power Modes</td><td><feature type="Mode" n="3" name="Run, Sleep, Deep-Sleep"/></td><td>3 Power Modes: Run, Sleep, Deep-Sleep </td></tr>
<tr>
<td>VCC</td><td>Minimum Supply Voltage</td><td>Maximum Supply Voltage</td><td>Operating Voltage</td><td><feature type="VCC" n="1.8" m="3.6"/></td><td>1.8 V .. 3.6 V </td></tr>
<tr>
<td>Consumption</td><td>Minimum Power Consumption</td><td>Typical Power Consumption</td><td>Power Consumption</td><td><feature type="Consumption" n="0.00004" m="0.002" name="Ultra-Low Power Consumption"/></td><td>40 uW/MHz .. 2 mW/MHz Ultra-Low Power Consumption </td></tr>
<tr>
<td>PowerOther</td><td>Number of Features</td><td>N/A</td><td>Other Power Feature</td><td><feature type="PowerOther" n="1" name="POR"/></td><td>1 x POR </td></tr>
<tr>
<td>BGA</td><td>Number of Balls</td><td>N/A</td><td>BGA</td><td><feature type="BGA" n="256" name="Plastic Ball Grid Array"/></td><td>256-ball Plastic Ball Grid Array </td></tr>
<tr>
<td>CSP</td><td>Number of Leads</td><td>N/A</td><td>CSP</td><td><feature type="CSP" n="28" name="Wafer-Level Chip-Scale Package"/></td><td>28-ball Wafer-Level Chip-Scale Package </td></tr>
<tr>
<td>PLCC</td><td>Number of Leads</td><td>N/A</td><td>PLCC</td><td><feature type="PLCC" n="20" name="PLCC Package"/></td><td>20-lead PLCC Package </td></tr>
<tr>
<td>QFN</td><td>Number of Leads</td><td>N/A</td><td>QFN</td><td><feature type="QFN" n="33" name="QFN Package"/></td><td>33-pad QFN Package </td></tr>
<tr>
<td>QFP</td><td>Number of Leads</td><td>N/A</td><td>QFP</td><td><feature type="QFP" n="128" name="Low-Profile QFP Package"/></td><td>128-lead Low-Profile QFP Package </td></tr>
<tr>
<td>SOP</td><td>Number of Leads</td><td>N/A</td><td>SOP</td><td><feature type="SOP" n="16" name="SSOP Package"/></td><td>16-lead SSOP Package </td></tr>
<tr>
<td>DIP</td><td>Number of Leads</td><td>N/A</td><td>SOP</td><td><feature type="DIP" n="16" name="Dual In-Line Package"/></td><td>16-lead Dual In-Line Package </td></tr>
<tr>
<td>PackageOther</td><td>Number of Pins</td><td>N/A</td><td>Other Package Type</td><td><feature type="PackageOther" n="44" name="My other Package"/></td><td>44-contacts My other Package </td></tr>
<tr>
<td>IOs</td><td>Number of I/Os</td><td>N/A</td><td>Inputs/Outputs</td><td><feature type="IOs" n="112" name="General Purpose I/Os, 5V tolerant"/></td><td>112 General Purpose I/Os, 5V tolerant </td></tr>
<tr>
<td>ExtInt</td><td>Number of External Interrupts</td><td>N/A</td><td>External Interrupts</td><td><feature type="ExtInt" n="12"/></td><td>12 External Interrupts </td></tr>
<tr>
<td>Temp</td><td>Minimum Operating Temperature</td><td>Maximum Operating Temperature</td><td>Operating Temperature Range</td><td><feature type="Temp" n="-40" m="105" name="Extended Operating Temperature Range"/></td><td>-40 °C .. +105 °C Extended Operating Temperature Range </td></tr>
<tr>
<td>ADC</td><td>Number of Channels</td><td>Resolution in Bit</td><td>ADC</td><td><feature type="ADC" n="5" m="12" name="High-Performance ADC"/></td><td>5-channel x 12-bit High-Performance ADC </td></tr>
<tr>
<td>DAC</td><td>Number of Channels</td><td>Resolution in Bit</td><td>DAC</td><td><feature type="DAC" n="2" m="10"/></td><td>2 x 12-bit DAC </td></tr>
<tr>
<td>TempSens</td><td>Number of 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>AnalogOther</td><td>Number of Features</td><td>N/A</td><td>Other Analog Peripheral</td><td><feature type="AnalogOther" n="1" name="My Analog"/></td><td>1 x My Analog </td></tr>
<tr>
<td>Timer</td><td>Number of Channels</td><td>Resolution in Bit</td><td>Timer/Counter Module</td><td><feature type="Timer" n="2" m="32" name="Timer Module with Quadrature Encoding"/></td><td>2 x 32-bit Timer Module with Quadrature Encoding </td></tr>
<tr>
<td>PWM</td><td>Number of Channels</td><td>Resolution in Bit</td><td>PWM</td><td><feature type="PWM" n="2" m="16" name="Pulse Width Modulation"/></td><td>2 x 16-bit Pulse Width Modulation </td></tr>
<tr>
<td>WDT</td><td>Number of Watchdogs</td><td>N/A</td><td>Watchdog</td><td><feature type="WDT" n="1"/></td><td>1 x Watchdog Timer </td></tr>
<tr>
<td>TimerOther</td><td>Number of Features</td><td>N/A</td><td>Other Timer Peripheral</td><td><feature type="TimerOther" n="1" name="Quadrature En-/Decoder"/></td><td>1 x Quadrature En-/Decoder </td></tr>
<tr>
<td>MPSerial</td><td>Number of Serial Peripherals</td><td>N/A</td><td>Multi-Purpose Serial Peripheral</td><td><feature type="MPSerial" n="4" name="Multi-Purpose Serial Interface Module: I2C, I2S, SPI, UART"/></td><td>4 x Multi-Purpose Serial Interface Module: I2C, I2S, SPI, UART </td></tr>
<tr>
<td>CAN</td><td>Number of CAN Interfaces</td><td>N/A</td><td>CAN</td><td><feature type="CAN" n="2" name="CAN 2.0b Controller"/></td><td>2 x CAN 2.0b Controller </td></tr>
<tr>
<td>ETH</td><td>Number of Ethernet Interfaces</td><td>Data Rate in Bit/s</td><td>Ethernet</td><td><feature type="ETH" n="1" m="10000000" name="Integrated Ethernet MAC with PHY"/></td><td>1 x 10 Mbit/s Integrated Ethernet MAC with PHY </td></tr>
<tr>
<td>I2C</td><td>Number of I2C Interfaces</td><td>N/A</td><td>I2C</td><td><feature type="I2C" n="2"name="Low-Power I2C"/></td><td>2 x Low-Power I2C </td></tr>
<tr>
<td>I2S</td><td>Number of I2S Interfaces</td><td>N/A</td><td>I2S</td><td><feature type="I2S" n="3"/></td><td>3 x I2S </td></tr>
<tr>
<td>LIN</td><td>Number of LIN Interfaces</td><td>N/A</td><td>LIN</td><td><feature type="LIN" n="4"/></td><td>4 x LIN </td></tr>
<tr>
<td>SDIO</td><td>Number of SDIO Interfaces</td><td>Bitwidth of SDIO Interface</td><td>SDIO</td><td><feature type="SDIO" n="1" m="4" name="SDIO Interface"/></td><td>1 x 4-bit SDIO Interface </td></tr>
<tr>
<td>SPI</td><td>Number of SPI Interfaces</td><td>Data Rate in Bit/s</td><td>SPI</td><td><feature type="SPI" n="2" m="20000000" name="SPI Interface"/></td><td>2 x 20 Mbit/s SPI Interface </td></tr>
<tr>
<td>UART</td><td>Number of UART Interfaces</td><td>Data Rate in Bit/s</td><td>UART</td><td><feature type="UART" n="4" m="3000000" name="High-Speed UART Interface"/></td><td>4 x 3 Mbit/s High-Speed UART Interface </td></tr>
<tr>
<td>USART</td><td>Number of USART Interfaces</td><td>Data Rate in Bit/s</td><td>USART</td><td><feature type="USART" n="2" m="1000000" name="High-Speed USART Interface"/></td><td>2 x 1 Mbit/s High-Speed USART Interface </td></tr>
<tr>
<td>USBD</td><td>Number of USB Dvice Interfaces</td><td>N/A</td><td>USB Device</td><td><feature type="USBD" n="2" name="Full-Speed USB Device"/></td><td>2 x Full-Speed USB Device </td></tr>
<tr>
<td>USBH</td><td>Number of USB Host Interfaces</td><td>N/A</td><td>USB Host</td><td><feature type="USBH" n="2" name="High-Speed USB Host"/></td><td>2 x High-Speed USB Host </td></tr>
<tr>
<td>USBOTG</td><td>Number of USB OTG Interfaces</td><td>N/A</td><td>USB OTG</td><td><feature type="USBOTG" n="1" name="High-Speed USB OTG with PHY"/></td><td>1 x High-Speed USB OTG with PHY </td></tr>
<tr>
<td>ComOther</td><td>Number of other Communication Peripherals</td><td>N/A</td><td>Other Communication Peripheral</td><td><feature type="ComOther" n="1" name="ZigBee"/></td><td>1 x ZigBee </td></tr>
<tr>
<td>Camera</td><td>Number of Camera Interface</td><td>Resolution in Bit</td><td>Camera Interface</td><td><feature type="Camera" n="1" m="8" name="Digital Camera Interface"/></td><td>1 x 8-bit Digital Camera Interface </td></tr>
<tr>
<td>GLCD</td><td>Number of Graphic LCD Controller</td><td>Maximum Resolution as a decimal number (see example)</td><td>Graphic LCD Controller</td><td><feature type="GLCD" n="1" m="320.240" name="TFT LCD Controller"/></td><td>1 x 320 x 480 pixel TFT LCD Controller </td></tr>
<tr>
<td>LCD</td><td>Number of Segment LCD Controller</td><td>Com.Seg as a decimal number (see example)</td><td>Segment LCD Controller</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>Touch</td><td>Number of Touch Channels</td><td>N/A</td><td>Capacitive Touch Inputs</td><td><feature type="Touch" n="10" name="Capacitive Touch Inputs"/></td><td>10 x Capacitive Touch Inputs </td></tr>
<tr>
<td>Other</td><td>Number of Features</td><td>N/A</td><td>Other Feature</td><td><feature type="Other" n="2" name="My other Interface"/></td><td>2 x My other Interface </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_memory"></a>
/package/devices/family/.../memory</h1>
<p>This element specifies memory regions that devices can have. Memory types are predefined and can be selected. This element can be defined on various levels. Inner memory elements supersede outer elements.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"></package></div>
<div class="line"> ...</div>
<div class="line"> <devices></div>
<div class="line"> <family Dfamily=<span class="stringliteral">"STM32F4"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div>
<div class="line"> <memory name=<span class="stringliteral">"SRAM"</span> access=<span class="stringliteral">"rwx"</span> start=<span class="stringliteral">"0x20000000"</span> size=<span class="stringliteral">"0x20000"</span> <span class="keywordflow">default</span>=<span class="stringliteral">"1"</span>/></div>
<div class="line"></div>
<div class="line"> <subFamily DsubFamily=<span class="stringliteral">"STM32F407"</span>></div>
<div class="line"> <debug __dp=<span class="stringliteral">"0"</span> __ap=<span class="stringliteral">"0"</span> svd=<span class="stringliteral">"SVD/STM32F40x.svd"</span>/></div>
<div class="line"> <memory name=<span class="stringliteral">"SRAM1"</span> access=<span class="stringliteral">"rwx"</span> start=<span class="stringliteral">"0x20020000"</span> size=<span class="stringliteral">"0x20000"</span> <span class="keywordflow">default</span>=<span class="stringliteral">"1"</span>/></div>
<div class="line"> <memory name=<span class="stringliteral">"SRAM2"</span> access=<span class="stringliteral">"rwx"</span> start=<span class="stringliteral">"0x10000000"</span> size=<span class="stringliteral">"0x10000"</span> <span class="keywordflow">default</span>=<span class="stringliteral">"1"</span>/></div>
<div class="line"> </div>
<div class="line"> <device Dname=<span class="stringliteral">"STM32F407IE"</span>></div>
<div class="line"> <memory name=<span class="stringliteral">"Flash"</span> access=<span class="stringliteral">"rx"</span> start=<span class="stringliteral">"0x08000000"</span> size=<span class="stringliteral">"0x80000"</span> startup=<span class="stringliteral">"1"</span> <span class="keywordflow">default</span>=<span class="stringliteral">"1"</span>/></div>
<div class="line"> </device></div>
<div class="line"> </div>
<div class="line"> </subFamily></div>
<div class="line"> </family></div>
<div class="line"> </devices></div>
<div class="line"> ...</div>
<div class="line"></package></div>
</div><!-- fragment --> <p> </p>
<table class="cmtable" summary="Element: memory">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>Pname </td><td>Processor identifier. This attribute <b>is mandatory for devices that embed multiple processors</b>. Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>optional </td></tr>
<tr>
<td>id (deprecated in Version 1.4.0) </td><td>(deprecated Version 1.4.0) Identifier of the memory region consisting of a type indicator and an index (for example, <span class="XML-Token">IRAM1</span>). Predefind values can be selected as defined in <a class="el" href="pdsc_family_pg.html#MemoryIDTypeEnum">MemoryIDTypeEnum</a>. </td><td>MemoryIDTypeEnum </td><td>optional </td></tr>
<tr>
<td>name (new in Version 1.4.0) </td><td>unique name of the memory (new in Version 1.4.0) to be used in conjunction with <em>access</em> </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td>access (new in Version 1.4.0) </td><td>access permission attributes of the memory. See MemoryAccessTypeString for details (new in Version 1.4.0). </td><td><a class="el" href="pdsc_family_pg.html#MemoryAccessTypeString">MemoryAccessTypeString</a> </td><td>optional </td></tr>
<tr>
<td>start </td><td>Base address of the memory using a hexadecimal value. </td><td>NonNegativeInteger </td><td>required </td></tr>
<tr>
<td>size </td><td>Size of the memory in bytes using a hexadecimal value. </td><td>NonNegativeInteger </td><td>required </td></tr>
<tr>
<td>default </td><td>Indicates a general purpose memory region, that does not require any special considerations (access speed, remapping, protection, etc.). If <span class="XML-Token">true</span>, then an IRAM memory region will be used by the linker for locating any data and an IROM memory region will for locating any code. Every device needs at least one default IRAM region. If an <a class="el" href="pdsc_family_pg.html#element_algorithm">algorithm</a> element is specified (without <code>RAMstart</code> and <code>RAMsize</code> attributes), the first listed IRAM region with default="1" will also be used for executing the flash programming algorithm. Default value is <span class="XML-Token">false</span>. </td><td>xs:boolean </td><td>optional </td></tr>
<tr>
<td>startup </td><td>If <span class="XML-Token">true</span>, the startup code of the application will be placed into this memory region. Default value is <span class="XML-Token">false</span>. </td><td>xs:boolean </td><td>optional </td></tr>
<tr>
<td>alias(new in Version 1.4.0) </td><td>reference to another memory description which shares the same physical memory. Some physical memory is made accessible via different addresses, e.g. chached vs. non-cached accesses. This avoids the impression that the device has twice as much memory available. </td><td>xs:string </td><td>optional </td></tr>
</table>
<p> </p>
<p><a class="anchor" id="MemoryIDTypeEnum"></a><b>Table: Memory ID Types</b></p>
<p>The table lists identifiers for memory types. </p>
<table class="cmtable" summary="Enumeration: MemoryIDTypeEnum">
<tr>
<th>id= </th><th>Description </th></tr>
<tr>
<td class="XML-Token">RAM<em>x</em> </td><td>External RAM. <em>x</em> can have a value between 1..8 </td></tr>
<tr>
<td class="XML-Token">ROM<em>x</em> </td><td>External ROM. <em>x</em> can have a value between 1..8 </td></tr>
<tr>
<td class="XML-Token">IRAM<em>x</em> </td><td>Internal RAM. <em>x</em> can have a value between 1..8 </td></tr>
<tr>
<td class="XML-Token">IROM<em>x</em> </td><td>Internal ROM. <em>x</em> can have a value between 1..8 </td></tr>
</table>
<p> </p>
<hr/>
<p><a class="anchor" id="MemoryAccessTypeString"></a><b>Table: Memory Access Attribute String</b></p>
<p>The table lists the letters and their meaning for use in the access attribute string. </p>
<table class="cmtable" summary="Memory Access Permission Attributes">
<tr>
<th>access= </th><th>Description </th></tr>
<tr>
<td class="XML-Token">r </td><td><em>R</em>eadable </td></tr>
<tr>
<td class="XML-Token">w </td><td><em>W</em>ritable </td></tr>
<tr>
<td class="XML-Token">x </td><td>e<em>X</em>ecutable </td></tr>
<tr>
<td class="XML-Token">p </td><td><em>P</em>eripheral area. Details described in SVD. </td></tr>
<tr>
<td class="XML-Token">s </td><td><em>S</em>ecure attribute </td></tr>
<tr>
<td class="XML-Token">n </td><td><em>N</em>on-secure attribute </td></tr>
<tr>
<td class="XML-Token">c </td><td>non-secure <em>C</em>allable attribute </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_processor"></a>
/package/devices/family/.../processor</h1>
<p>Specifies attributes of the device processor. The element can occur on various levels. Elements of multi-processor devices can be associated with a specific processor using the attribute <b><Pname></b>. If the information is relevant to all processors, no processor must be specified in <b><Pname></b>.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><package></div>
<div class="line"> ...</div>
<div class="line"> <devices></div>
<div class="line"> <family Dfamily=<span class="stringliteral">"STM32F4"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div>
<div class="line"> <processor Dcore=<span class="stringliteral">"Cortex-M4"</span> DcoreVersion=<span class="stringliteral">"r0p1"</span></div>
<div class="line"> Dfpu=<span class="stringliteral">"1"</span> Dmpu=<span class="stringliteral">"1"</span> Dendian=<span class="stringliteral">"Little-endian"</span> Dclock=<span class="stringliteral">"168000000"</span>/></div>
<div class="line"> ...</div>
<div class="line"> </family></div>
<div class="line"> </devices></div>
<div class="line"> ...</div>
<div class="line"></package></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: processor">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>Pname </td><td>Processor identifier. This attribute <b>is mandatory for devices that embed multiple processors</b>. Each processor needs a unique identifier and must be used consistently in the <b>Pname</b> attribute of the elements within the scope of the current device family section. Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>optional </td></tr>
<tr>
<td>Dvendor </td><td>Specfies the device vendor using a predefined string. 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>optional </td></tr>
<tr>
<td>Dcore </td><td>Specifies the processor core. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DcoreEnum">Device Cores</a>. </td><td>DcoreEnum </td><td>optional </td></tr>
<tr>
<td>Dfpu </td><td>Specifies whether a hardware Floating Point Unit is present in the processor. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DfpuEnum">Device FPU</a>. </td><td>DfpuEnum </td><td>optional </td></tr>
<tr>
<td>Dmpu </td><td>Specifies whether a Memory Protection Unit is present in the processor. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DmpuEnum">Device MPU</a>. </td><td>DmpuEnum </td><td>optional </td></tr>
<tr>
<td>Dendian </td><td>Specifies the endianess of the processor. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DendianEnum">Endinaness</a>. </td><td>DendianEnum </td><td>optional </td></tr>
<tr>
<td>Dclock </td><td>Specifies the max clock frequency of the processor subsystem </td><td>xs:unsignedInt </td><td>optional </td></tr>
<tr>
<td>DcoreVersion </td><td>Hardware revision of the processor core </td><td>xs:string </td><td>required </td></tr>
</table>
<p> </p>
<p><a class="anchor" id="DeviceVendorEnum"></a><b>Table: Device Vendors</b></p>
<p>The table lists predefined values representing device vendors. The list is extended from time to time (on request by new vendors). Contact <a href="#" onclick="location.href='mai'+'lto:'+'cms'+'is'+'@ar'+'m.'+'com'; return false;">cmsis<span style="display: none;">.nosp@m.</span>@arm<span style="display: none;">.nosp@m.</span>.com</a> to ask for an extension. These values can be used in the elements:</p>
<ul>
<li><a class="el" href="pdsc_boards_pg.html#element_board_mountedDevice">/package/boards/board/mountedDevice</a></li>
<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_board">/package/examples/example/board</a></li>
<li><a class="el" href="pdsc_boards_pg.html#element_board_compatibleDevice">/package/boards/board/compatibleDevice</a></li>
<li><a class="el" href="pdsc_generators_pg.html#element_gen_select">/package/generators/generator/select</a></li>
</ul>
<table class="cmtable" summary="Enumeration: DeviceVendorEnum">
<tr>
<th>Dvendor </th><th>Description </th><th>Web Link </th></tr>
<tr>
<td class="XML-Token">Ambiq Micro:120 </td><td>Ambiq Micro </td><td><a href="http://www.ambiqmicro.com">http://www.ambiqmicro.com</a> </td></tr>
<tr>
<td class="XML-Token">Analog Devices:1 </td><td>Analog Devices </td><td><a href="http://www.analog.com">http://www.analog.com</a> </td></tr>
<tr>
<td class="XML-Token">ARM:82 </td><td>ARM Ltd. </td><td><a href="http://www.arm.com">http://www.arm.com</a> </td></tr>
<tr>
<td class="XML-Token">Atmel:3 </td><td>Atmel Corporation </td><td><a href="http://www.atmel.com">http://www.atmel.com</a> </td></tr>
<tr>
<td class="XML-Token">CSR:118 </td><td>CSR: </td><td><a href="http://www.csr.com">http://www.csr.com</a> </td></tr>
<tr>
<td class="XML-Token">Cypress:19 </td><td>Cypress Semiconductor </td><td><a href="http://www.cypress.com">http://www.cypress.com</a> </td></tr>
<tr>
<td class="XML-Token">Dialog Semiconductor:113 </td><td>Dialog Semiconductor </td><td><a href="http://www.dialog-semiconductor.com">http://www.dialog-semiconductor.com</a> </td></tr>
<tr>
<td class="XML-Token">Freescale:78 </td><td>Freescale </td><td><a href="http://www.freescale.com">http://www.freescale.com</a> </td></tr>
<tr>
<td class="XML-Token">Generic:5 </td><td>Generic: Not a vendor specific device </td><td></td></tr>
<tr>
<td class="XML-Token">GigaDevice:123 </td><td>GigaDevice </td><td><a href="http://www.gigadevice.com">http://www.gigadevice.com</a> </td></tr>
<tr>
<td class="XML-Token">Holtek:106 </td><td>Holtek Microelectronics </td><td><a href="http://www.holtek.com.tw">http://www.holtek.com.tw</a> </td></tr>
<tr>
<td class="XML-Token">Infineon:7 </td><td>Infineon Technologies </td><td><a href="http://www.infineon.com">http://www.infineon.com</a> </td></tr>
<tr>
<td class="XML-Token">Lapis Semiconductor:10 </td><td>Lapis Semiconductor </td><td><a href="http://www.lapis-semi.com">http://www.lapis-semi.com</a> </td></tr>
<tr>
<td class="XML-Token">Maxim:23 </td><td>Maxim Integrated </td><td><a href="http://www.maximintegrated.com">http://www.maximintegrated.com</a> </td></tr>
<tr>
<td class="XML-Token">MicroSemi:112 </td><td>Microsemi </td><td><a href="http://www.microsemi.com">http://www.microsemi.com</a> </td></tr>
<tr>
<td class="XML-Token">Milandr:99 </td><td>Milandr </td><td><a href="http://www.milandr.ru">http://www.milandr.ru</a> </td></tr>
<tr>
<td class="XML-Token">Nordic Semiconductor:54 </td><td>Nordic Semiconductor </td><td><a href="http://www.nordicsemi.com">http://www.nordicsemi.com</a> </td></tr>
<tr>
<td class="XML-Token">Nuvoton:18 </td><td>Nuvoton Technolgy Corp. </td><td><a href="http://www.nuvoton.com">http://www.nuvoton.com</a> </td></tr>
<tr>
<td class="XML-Token">NXP:11 </td><td>NXP </td><td><a href="http://www.nxp.com">http://www.nxp.com</a> </td></tr>
<tr>
<td class="XML-Token">Realtek Semiconductor:124 </td><td>Realtek Semiconductor </td><td><a href="http://www.realtek.com.tw">http://www.realtek.com.tw</a> </td></tr>
<tr>
<td class="XML-Token">Redpine Signals:125 </td><td>Repine Signals </td><td><a href="http://www.redpinesignals.com">http://www.redpinesignals.com</a> </td></tr>
<tr>
<td class="XML-Token">Renesas:117 </td><td>Renesas </td><td><a href="http://www.renesas.com">http://www.renesas.com</a> </td></tr>
<tr>
<td class="XML-Token">ROHM:103 </td><td>ROHM </td><td><a href="http://www.rohm.com">http://www.rohm.com</a> </td></tr>
<tr>
<td class="XML-Token">Samsung:47 </td><td>Samsung Semiconductor </td><td><a href="http://www.samsung.com">http://www.samsung.com</a> </td></tr>
<tr>
<td class="XML-Token">Silicon Labs:21 </td><td>Silicon Labs </td><td><a href="http://www.silabs.com">http://www.silabs.com</a> </td></tr>
<tr>
<td class="XML-Token">Spansion:100 </td><td>Spansion (previously Fujitsu) </td><td><a href="http://www.spansion.com">http://www.spansion.com</a> </td></tr>
<tr>
<td class="XML-Token">STMicroelectronics:13 </td><td>STMicroelectronics </td><td><a href="http://www.st.com">http://www.st.com</a> </td></tr>
<tr>
<td class="XML-Token">Texas Instruments:16 </td><td>Texas Instruments </td><td><a href="http://www.ti.com">http://www.ti.com</a> </td></tr>
<tr>
<td class="XML-Token">Toshiba:92 </td><td>Toshiba Semiconductor </td><td><a href="http://www.toshiba-components.com">http://www.toshiba-components.com</a> </td></tr>
<tr>
<td class="XML-Token">Triad Semiconductor:104 </td><td>Triad Semiconductor </td><td><a href="http://www.triadsemi.com">http://www.triadsemi.com</a> </td></tr>
<tr>
<td class="XML-Token">WIZnet:122 </td><td>WIZnet </td><td><a href="http://www.wiznet.co.kr">http://www.wiznet.co.kr</a> </td></tr>
</table>
<p> </p>
<p><a class="anchor" id="AlgorithmStyleEnum"></a><b>Table: Algorithm Styles</b> </p>
<table class="cmtable" summary="Enumeration: AlgorithmStyleEnum">
<tr>
<th>style= </th><th>Description </th></tr>
<tr>
<td class="XML-Token">Keil </td><td><a href="http://www.keil.com/pack/doc/CMSIS/Pack/html/_flash_algorithm.html" target="_blank">Flash Programming Algorithm</a> as defined by ARM/Keil </td></tr>
<tr>
<td class="XML-Token">IAR </td><td>Flash Programming Algorithm as defined by IAR </td></tr>
<tr>
<td class="XML-Token">CMSIS </td><td><p class="starttd">To be agreed under CMSIS </p>
<p class="endtd"></p>
</td></tr>
</table>
<p> </p>
<p><a class="anchor" id="DcoreEnum"></a><b>Table: Device Cores</b></p>
<p>The table lists available device cores. The list is extended from time to time to reflect new processor cores. 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_family_pg.html#element_processor">/package/devices/family/.../processor</a></li>
</ul>
<table class="cmtable" summary="Enumeration: DcoreEnum">
<tr>
<th>Dcore= </th><th>Description </th></tr>
<tr>
<td class="XML-Token">Cortex-M0 </td><td><a href="http://www.arm.com/products/processors/cortex-m/cortex-m0.php" target="_blank">ARM Cortex-M0</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-M0+ </td><td><a href="http://www.arm.com/products/processors/cortex-m/cortex-m0plus.php" target="_blank">ARM Cortex-M0+</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-M1 </td><td><a href="http://www.arm.com/products/processors/cortex-m/cortex-m1.php" target="_blank">ARM Cortex-M1</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-M3 </td><td><a href="http://www.arm.com/products/processors/cortex-m/cortex-m3.php" target="_blank">ARM Cortex-M3</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-M4 </td><td><a href="http://www.arm.com/products/processors/cortex-m/cortex-m4-processor.php" target="_blank">ARM Cortex-M4</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-M7 </td><td><a href="http://www.arm.com/products/processors/cortex-m/cortex-m7-processor.php" target="_blank">ARM Cortex-M7</a> processor based device </td></tr>
<tr>
<td class="XML-Token">SC000 </td><td>SecurCore <a href="http://www.arm.com/products/processors/securcore/sc000.php" target="_blank">SC000</a> based on technology of Cortex-M0. </td></tr>
<tr>
<td class="XML-Token">SC300 </td><td>SecurCore <a href="http://www.arm.com/products/processors/securcore/sc300.php" target="_blank">SC300</a> based on technology of Cortex-M3. </td></tr>
<tr>
<td class="XML-Token">Cortex-R4 </td><td>ARM Cortex-R4 processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-R5 </td><td>ARM Cortex-R5 processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A8 </td><td>ARM Cortex-A8 processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A9 </td><td>ARM Cortex-A9 processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A15 </td><td>ARM Cortex-A15 processor based device </td></tr>
<tr>
<td class="XML-Token">* </td><td>Device based on any processor </td></tr>
</table>
<p> </p>
<p><a class="anchor" id="DfpuEnum"></a><b>Table: Device FPU</b></p>
<p>The table lists values that identicate whether a CPU has an Floating Point Unit (FPU). The tokens 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_family_pg.html#element_processor">/package/devices/family/.../processor</a></li>
</ul>
<table class="cmtable" summary="Enumeration: DfpuEnum">
<tr>
<th>Dfpu= </th><th>Description </th></tr>
<tr>
<td class="XML-Token">NO_FPU </td><td>Hardware Floating Point Unit not present </td></tr>
<tr>
<td class="XML-Token">FPU </td><td>Hardware Floating Point Unit present </td></tr>
<tr>
<td class="XML-Token">SP_FPU </td><td>Single Precision Hardware Floating Point Unit present </td></tr>
<tr>
<td class="XML-Token">DP_FPU </td><td>Double Precision Hardware Floating Point Unit present </td></tr>
</table>
<p> </p>
<p><a class="anchor" id="DmpuEnum"></a><b>Table: Device MPU</b></p>
<p>The table shows predefined values that identify whether a CPU has an Memory Protection Unit (MPU). The 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_family_pg.html#element_processor">/package/devices/family/.../processor</a></li>
</ul>
<table class="cmtable" summary="Enumeration: DmpuEnum">
<tr>
<th>Dmpu= </th><th>Description </th></tr>
<tr>
<td class="XML-Token">MPU </td><td>Memory Protection Unit is present </td></tr>
<tr>
<td class="XML-Token">NO_MPU </td><td>No Memory Protection Unit is present </td></tr>
</table>
<p> </p>
<p><a class="anchor" id="DendianEnum"></a><b>Table: Endianness</b></p>
<p>The table lists values representing the endianness of a device. The 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_family_pg.html#element_processor">/package/devices/family/.../processor</a></li>
</ul>
<table class="cmtable" summary="Enumeration: DendianEnum">
<tr>
<th>Dendian= </th><th>Description </th></tr>
<tr>
<td class="XML-Token">Little-endian </td><td>The least significant byte of a multi-byte access is located at the specified address. </td></tr>
<tr>
<td class="XML-Token">Big-endian </td><td>The most significant byte of a multi-byte access is located at the specified address. </td></tr>
<tr>
<td class="XML-Token">Configurable </td><td>The byte ordering of multi-byte accesses is configurable. </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_debugconfig"></a>
/package/devices/family/.../debugconfig</h1>
<p>Default debugger configuration for a target connection.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"LPC4300 Series"</span> Dvendor=<span class="stringliteral">"NXP:11"</span>></div>
<div class="line"> ...</div>
<div class="line"> <debugconfig <span class="keywordflow">default</span>=<span class="stringliteral">"jtag"</span> clock=<span class="stringliteral">"10000000"</span> swj=<span class="stringliteral">"1"</span>/></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: debugconfig">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>default </td><td>Specifies the default debug protocol to use for target connections. Predefined tokens must be used as defined in <a class="el" href="pdsc_family_pg.html#DebugProtocolEnum">Table: Debug Protocol Type</a>. Default value is <span class="XML-Token">swd</span>. </td><td>DebugProtocolEnum </td><td>optional </td></tr>
<tr>
<td>clock </td><td>Specifies the default debug clock setting in Hz for a target connection. Default value is <span class="XML-Token">10000000</span>. </td><td>xs:unsignedInt </td><td>optional </td></tr>
<tr>
<td>swj </td><td>The device is accessed via a CoreSight SWJ-DP capable of switching between Serial Wire Debug (SWD) and JTAG protocols. Default value is <span class="XML-Token">true</span>. </td><td>xs:bool </td><td>optional </td></tr>
</table>
<p> </p>
<p><a class="anchor" id="DebugProtocolEnum"></a><b>Table: Debug Protocol Type</b></p>
<p>The table lists the values for debug protocol types. </p>
<table class="cmtable" summary="Enumeration: DataPatchAccessTypeEnum">
<tr>
<th>type= </th><th>Description </th></tr>
<tr>
<td class="XML-Token">jtag </td><td>JTAG debug protocol. </td></tr>
<tr>
<td class="XML-Token">swd </td><td>ARM Serial Wire Debug (SWD) protocol. </td></tr>
<tr>
<td class="XML-Token">cjtag </td><td>CJTAG concurrent jtag debug protocol. </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_debugvars"></a>
/package/devices/family/.../debugvars</h1>
<p>Specify <a class="el" href="pdsc_family_pg.html#DebugVars">global debug access variables</a>. Use these in addition to the <a class="el" href="pdsc_family_pg.html#PredefinedDebugVars">pre-defined variables</a> in order to query settings from a debug access sequences.<br/>
<br/>
Define debug access variables with statements of the following form. </p>
<div class="fragment"><div class="line">__var uservar = value; <span class="comment">// Comment: Define "uservar" and initialize to "value"</span></div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd><ul>
<li>Initialization values must be constant unsigned numbers. No expressions are allowed.</li>
<li>User-defined debug access variables are <b>read-only</b> in a debug access sequence.</li>
<li>Pre-defined debug access variables cannot be set in this element.</li>
</ul>
</dd></dl>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"EFM32WG Series"</span> Dvendor=<span class="stringliteral">"Energy Micro:97"</span>></div>
<div class="line"> ...</div>
<div class="line"> <debugvars configfile=<span class="stringliteral">"Debug/EFM32WGxxx.dbgconf"</span> version=<span class="stringliteral">"1.0"</span>></div>
<div class="line"> </div>
<div class="line"> __var __TPIU_pinlocation = 0; <span class="comment">// Select one of four possible TPIU pin locations</span></div>
<div class="line"> </div>
<div class="line"> __var __SWO_pinlocation = 0; <span class="comment">// Select one of four possible SWO pin locations</span></div>
<div class="line"> </div>
<div class="line"> </debugvars></div>
<div class="line"> ...</div>
<div class="line"> <sequences></div>
<div class="line"> <sequence name=<span class="stringliteral">"TraceStart"</span>></div>
<div class="line"> ...</div>
<div class="line"> <block <span class="keywordflow">if</span>=<span class="stringliteral">"__TPIU_pinlocation == 2"</span>></div>
<div class="line"> ...</div>
<div class="line"> <!-- Configure device to use pins as defined <span class="keywordflow">for</span> TPIU pin location 2 --></div>
<div class="line"> ...</div>
<div class="line"> </block></div>
<div class="line"> ...</div>
<div class="line"> </sequence></div>
<div class="line"> </sequences></div>
<div class="line"> ...</div>
<div class="line"> <debug __dp=<span class="stringliteral">"0"</span> __ap=<span class="stringliteral">"0"</span>/></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: debugvars">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>configfile </td><td>Configuration file with path relative to the package base folder (extension *.DBGCONF). This file contains assignments of a default value to global debug access variables. This file gets copied to the project folder and is editable by the end-user. This file is read by the debugger after processing the global debug access variables. By editing the values of the debug access variables, the end-user effectively controls the behavior of sequences. The file can only assign new values but must not specify any new debug access variables. <a class="el" href="_config_wizard.html">Configuration Wizard Annotations</a> shall be used within the file to provide a graphical user interface for editing configuration options. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<td><a class="el" href="pdsc_package_pg.html#VersionType">version</a> </td><td>Version refers to the file version of the configfile attribute. If a configfile is specified the version attribute becomes mandatory. The version shall be incremented if any changes have been made to the global debug access variable names or default values. Based on the version information the tool environment will load a configfile with the version required by the debug description. The end-user may be required to update the settings after updating to a new version. </td><td><a class="el" href="pdsc_package_pg.html#VersionType">VersionType</a> </td><td>optional </td></tr>
<tr>
<td>Pname </td><td>Reference to a processor identifier as specified for a <b>processor</b> element. If <b>Pname</b> is set for this <b>debugvars</b> element, the debug access variables and <b>configfile</b> of this element are only valid for a debug connection to the referenced processor. Otherwise, they are valid for all processors. <b>This attribute must be set if defining multiple <em>debugvars</em> sections for a device.</b> Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>optional </td></tr>
</table>
<p> </p>
<p><b>Example:</b> Configuration File </p>
<div class="fragment"><div class="line"><span class="comment">// File: EFM32WGxxx.dbgconf </span></div>
<div class="line"><span class="comment">// Version: 1.0</span></div>
<div class="line"><span class="comment">// <<< Use Configuration Wizard in Context Menu >>></span></div>
<div class="line"><span class="comment">// <h>Trace Pin Setup</span></div>
<div class="line"> <span class="comment">// <o> TPIU Pin Location</span></div>
<div class="line"><span class="comment">// <0=> Pin Location 0</span></div>
<div class="line"><span class="comment">// <1=> Pin Location 1</span></div>
<div class="line"><span class="comment">// <2=> Pin Location 2</span></div>
<div class="line"><span class="comment">// <3=> Pin Location 3</span></div>
<div class="line"><span class="comment">// <i> Select TPIU pin location for your board configuration:</span></div>
<div class="line"><span class="comment">// <i> - Pin Location 0 (TRACECLK: PD7, TRACEDATA0: PD6, TRACEDATA1: PD3, TRACEDATA2: PD4, TRACEDATA3: PD5)</span></div>
<div class="line"><span class="comment">// <i> - Pin Location 1 (TRACECLK: PF8, TRACEDATA0: PF9, TRACEDATA1: PD13, TRACEDATA2: PB15, TRACEDATA3: PF3)</span></div>
<div class="line"><span class="comment">// <i> - Pin Location 2 (TRACECLK: PC6, TRACEDATA0: PC7, TRACEDATA1: PD3, TRACEDATA2: PD4, TRACEDATA3: PD5)</span></div>
<div class="line"><span class="comment">// <i> - Pin Location 3 (TRACECLK: PA6, TRACEDATA0: PA2, TRACEDATA1: PA3, TRACEDATA2: PA4, TRACEDATA3: PA5)</span></div>
<div class="line"><span class="comment">// <i> Default: Pin Location 0</span></div>
<div class="line">__TPIU_pinlocation = 0;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// <o> SWO Pin Location</span></div>
<div class="line"><span class="comment">// <0=> Pin Location 0</span></div>
<div class="line"><span class="comment">// <1=> Pin Location 1</span></div>
<div class="line"><span class="comment">// <2=> Pin Location 2</span></div>
<div class="line"><span class="comment">// <3=> Pin Location 3</span></div>
<div class="line"><span class="comment">// <i> Select SWO pin location for your board configuration:</span></div>
<div class="line"><span class="comment">// <i> - Pin Location 0 (SWO: PF2)</span></div>
<div class="line"><span class="comment">// <i> - Pin Location 1 (SWO: PC15)</span></div>
<div class="line"><span class="comment">// <i> - Pin Location 2 (SWO: PD1)</span></div>
<div class="line"><span class="comment">// <i> - Pin Location 3 (SWO: PD2)</span></div>
<div class="line"><span class="comment">// <i> Default: Pin Location 0</span></div>
<div class="line">__SWO_pinlocation = 0;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// </h></span></div>
<div class="line"><span class="comment">// <<< end of configuration section >>></span></div>
</div><!-- fragment --><p> </p>
<p><a class="anchor" id="DebugVars"></a><b>Debug Access Variables</b></p>
<p>Debug access variables hold 64-bit unsigned integer values and are used in debug access sequences to query debugger settings and states. They are <b>read-only</b> within a sequence except from a limited set of the <a class="el" href="pdsc_family_pg.html#PredefinedDebugVars">pre-defined debug access variables</a>. Use the <b>debugvars</b> element to specify additional user-defined debug access variables.</p>
<p><a class="anchor" id="PredefinedDebugVars"></a><b>Table: Pre-defined Debug Access Variables</b><br/>
A debugger needs to support a set of pre-defined debug access variables. These are described in the following table.</p>
<table class="cmtable" summary="ExpressionType: Pre-defined Debug Access Variables">
<tr>
<th>Variable </th><th>Access </th><th>Description </th><th>Value= </th></tr>
<tr>
<td style="white-space: nowrap"><pre>__protocol</pre> </td><td>Read-Only </td><td>Debug protocol selection and parameters for target connection. </td><td>The following bit map applies:<br/>
<ul>
<li>Bit 0..15: Type<ul>
<li><span class="XML-Token">0</span>: Error<br/>
</li>
<li><span class="XML-Token">1</span>: JTAG<br/>
</li>
<li><span class="XML-Token">2</span>: Serial Wire Debug (SWD)<br/>
</li>
<li><span class="XML-Token">3</span>: CJTAG<br/>
</li>
</ul>
</li>
<li>Bit 16: SWJ-DP</li>
<li>Bit 17..63: Reserved </li>
</ul>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>__connection</pre> </td><td>Read-Only </td><td>Target connection configuration. </td><td>The following bit map applies:<br/>
<ul>
<li>Bit 0..7: Connection type<ul>
<li><span class="XML-Token">0</span>: Error or target is disconnected.</li>
<li><span class="XML-Token">1</span>: Connection for target debug.</li>
<li><span class="XML-Token">2</span>: Connection for downloading application to flash.</li>
</ul>
</li>
<li>Bit 8..15: Reset type.<ul>
<li><span class="XML-Token">0</span>: Error.</li>
<li><span class="XML-Token">1</span>: Hardware Reset (debugger reset line).</li>
<li><span class="XML-Token">2</span>: System Reset Request.</li>
<li><span class="XML-Token">3</span>: Processor Reset Request ("Vector Reset").</li>
</ul>
</li>
<li>Bit 16..63: Reserved </li>
</ul>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>__dp</pre> </td><td>Read/Write </td><td>Debug Port selected for target accesses.<br/>
This variable is initialized when entering a pre-defined debug access sequence because of a debug event. The initialization value is the <b>__dp</b> as defined for the used <b>debug</b> element. </td><td>Debug port ID as specified in a <b>debugport</b> element or <span class="XML-Token">0</span> if no <b>debugport</b> element exists. </td></tr>
<tr>
<td style="white-space: nowrap"><pre>__ap</pre> </td><td>Read/Write </td><td>Access Port selected for target accesses.<br/>
This variable is initialized when entering a pre-defined debug access sequence because of a debug event. The initialization value is the <b>__ap</b> as defined for the used <b>debug</b> element. </td><td>Access Port index. </td></tr>
<tr>
<td style="white-space: nowrap"><pre>__traceout</pre> </td><td>Read-Only </td><td>Activated trace outputs (sinks). Additionally holds information on the selected port width if a parallel trace port is enabled. </td><td style="white-space: nowrap">The following bit map applies:<br/>
<ul>
<li>Bit 0: Serial Wire Output (SWO) Trace enabled.</li>
<li>Bit 1: Parallel Trace Port enabled.</li>
<li>Bit 2: Trace Buffer enabled.</li>
<li>Bit 3..15: Reserved.</li>
<li>Bit 16..21: Selected Parallel Trace Port size.</li>
<li>Bit 22..63: Reserved. </li>
</ul>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>__errorcontrol</pre> </td><td>Read/Write </td><td>Control variable for debug access error handling. All of its bit fields are intialized to <span class="XML-Token">0</span> when entering a pre-defined debug access sequence because of a debug event. </td><td>The following bit map applies:<br/>
<ul>
<li>Bit 0: Skip errors if set to <span class="XML-Token">1</span>. A debugger must continue the sequence execution.</li>
<li>Bit 1..63: Reserved </li>
</ul>
</td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_debugport"></a>
/package/devices/family/.../debugport</h1>
<p>Describes a CoreSight debug port of the device and its capabilities. The element can occur on various levels. Use unique ID values for the attribute <b>__dp</b> to distinguish multiple <b>debugport</b> elements in later references.<br/>
<br/>
<b>debugport</b> elements are required for targets with multiple debug ports. For devices with a single debug port these elements can be omitted. If no <b>debugport</b> element exists the only allowed <b>__dp</b> ID in later references is <span class="XML-Token">0</span>.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"LPC4300 Series"</span> Dvendor=<span class="stringliteral">"NXP:11"</span>></div>
<div class="line"> ...</div>
<div class="line"> <debugconfig <span class="keywordflow">default</span>=<span class="stringliteral">"jtag"</span> clock=<span class="stringliteral">"10000000"</span> swj=<span class="stringliteral">"1"</span>/></div>
<div class="line"> </div>
<div class="line"> <debugport __dp=<span class="stringliteral">"0"</span>></div>
<div class="line"> <jtag tapindex=<span class="stringliteral">"0"</span>/></div>
<div class="line"> <swd/></div>
<div class="line"> </debugport></div>
<div class="line"> </div>
<div class="line"> <debugport __dp=<span class="stringliteral">"1"</span>></div>
<div class="line"> <jtag tapindex=<span class="stringliteral">"1"</span>/> </div>
<div class="line"> </debugport></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: debugport">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>__dp </td><td>Unique ID of this <b>debugport</b>. It must be used consistently in references within the scope of the parent section. </td><td>xs:unsignedInt </td><td>required </td></tr>
<tr>
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_dp_jtag">jtag</a> </td><td>Describe JTAG Test Access Port (TAP) properties of this debug port. </td><td>JtagType </td><td>0..1 </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_dp_swd">swd</a> </td><td>Describe CoreSight Serial Wire Debug Port (SW-DP) properties of this debug port. </td><td>SwdType </td><td>0..1 </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_dp_cjtag">cjtag</a> </td><td>Describe CJTAG Test Access Port (TAP) properties of this debug port. </td><td>CjtagType </td><td>0..1 </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_dp_jtag"></a>
/package/devices/family/.../debugport/jtag</h1>
<p>Indicates availability of a JTAG interface for the <b>debugport</b> parent element. Its attributes allow the manual override of a debugger's automatic JTAG Test Access Port (TAP) detection.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"STM32F4"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div>
<div class="line"> ...</div>
<div class="line"> <debugconfig <span class="keywordflow">default</span>=<span class="stringliteral">"swd"</span> clock=<span class="stringliteral">"10000000"</span> swj=<span class="stringliteral">"1"</span>/></div>
<div class="line"> </div>
<div class="line"> <debugport __dp=<span class="stringliteral">"0"</span>></div>
<div class="line"> <jtag tapindex=<span class="stringliteral">"0"</span> idcode=<span class="stringliteral">"0x4BA00477"</span> irlen=<span class="stringliteral">"4"</span>/></div>
<div class="line"> <swd idcode=<span class="stringliteral">"0x2BA01477"</span>/></div>
<div class="line"> </debugport></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: jtag">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debugport">debugport</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_debugport">/package/devices/family/.../debugport</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>tapindex </td><td>Specifies the TAP index relative to the JTAG scan chain of this device. A debugger needs to determine the absolute index if the device is part of an extended scan chain. Default value is <span class="XML-Token">0</span>. </td><td>NonNegativeInteger </td><td>optional </td></tr>
<tr>
<td>idcode </td><td>Specifies the IDCODE of the JTAG TAP. This value overrides the IDCODE read from the target. </td><td>NonNegativeInteger </td><td><p class="starttd">optional </p>
<p class="endtd"></p>
</td></tr>
<tr>
<td>irlen </td><td>Specifies the instruction register length of the JTAG TAP. This value overrides the instruction register length detected by a debugger. </td><td>xs:unsignedInt </td><td>optional </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_dp_swd"></a>
/package/devices/family/.../debugport/swd</h1>
<p>Indicates availability of an ARM Serial Wire Debug (SWD) interface for the <b>debugport</b> parent element. Its attributes allow the manual override of SWD port characteristics as read from the target and provide information for the port selection in a system with multi-drop SWD support.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"STM32F4"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div>
<div class="line"> ...</div>
<div class="line"> <debugconfig <span class="keywordflow">default</span>=<span class="stringliteral">"swd"</span> clock=<span class="stringliteral">"10000000"</span> swj=<span class="stringliteral">"1"</span>/></div>
<div class="line"> </div>
<div class="line"> <debugport __dp=<span class="stringliteral">"0"</span>></div>
<div class="line"> <jtag tapindex=<span class="stringliteral">"0"</span> idcode=<span class="stringliteral">"0x4BA00477"</span> irlen=<span class="stringliteral">"4"</span>/></div>
<div class="line"> <swd idcode=<span class="stringliteral">"0x2BA01477"</span>/></div>
<div class="line"> </debugport></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: swd">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debugport">debugport</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_debugport">/package/devices/family/.../debugport</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>idcode </td><td>Specifies the IDCODE of the SWD port. It overrides the value read from the port's IDCODE register. </td><td>NonNegativeInteger </td><td><p class="starttd">optional </p>
<p class="endtd"></p>
</td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_dp_cjtag"></a>
/package/devices/family/.../debugport/cjtag</h1>
<p>Indicates availability of a CJTAG interface for the <b>debugport</b> parent element. Its attributes allow the manual override of a debugger's automatic CJTAG Test Access Port (TAP) detection.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"STM32F4"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>></div>
<div class="line"> ...</div>
<div class="line"> <debugconfig <span class="keywordflow">default</span>=<span class="stringliteral">"swd"</span> clock=<span class="stringliteral">"10000000"</span> swj=<span class="stringliteral">"1"</span>/></div>
<div class="line"> </div>
<div class="line"> <debugport __dp=<span class="stringliteral">"0"</span>></div>
<div class="line"> <cjtag tapindex=<span class="stringliteral">"0"</span> idcode=<span class="stringliteral">"0x4BA00477"</span> irlen=<span class="stringliteral">"4"</span>/></div>
<div class="line"> <swd idcode=<span class="stringliteral">"0x2BA01477"</span>/></div>
<div class="line"> </debugport></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: cjtag">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debugport">debugport</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_debugport">/package/devices/family/.../debugport</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>tapindex </td><td>Specifies the TAP index relative to the JTAG scan chain of this device. A debugger needs to determine the absolute index if the device is part of an extended scan chain. Default value is <span class="XML-Token">0</span>. </td><td>NonNegativeInteger </td><td>optional </td></tr>
<tr>
<td>idcode </td><td>Specifies the IDCODE of the JTAG TAP. This value overrides the IDCODE read from the target. </td><td>NonNegativeInteger </td><td>optional </td></tr>
<tr>
<td>irlen </td><td>Specifies the instruction register length of the JTAG TAP. This value overrides the instruction register length detected by a debugger. </td><td>xs:unsignedInt </td><td>optional </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_sequences"></a>
/package/devices/family/.../sequences</h1>
<p>Container for debug access sequences for this device.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"LPC4300 Series"</span> Dvendor=<span class="stringliteral">"NXP:11"</span>></div>
<div class="line"> ...</div>
<div class="line"> <sequences></div>
<div class="line"> ...</div>
<div class="line"> <sequence name=<span class="stringliteral">"DebugCoreStart"</span> Pname=<span class="stringliteral">"Cortex-M0"</span>></div>
<div class="line"> ...</div>
<div class="line"> </sequence></div>
<div class="line"> ...</div>
<div class="line"> <sequence name=<span class="stringliteral">"ResetSystem"</span> Pname=<span class="stringliteral">"Cortex-M4"</span>></div>
<div class="line"> ...</div>
<div class="line"> </sequence></div>
<div class="line"> ...</div>
<div class="line"> <sequence name=<span class="stringliteral">"TraceStart"</span> Pname=<span class="stringliteral">"Cortex-M4"</span>></div>
<div class="line"> ...</div>
<div class="line"> </sequence></div>
<div class="line"> ...</div>
<div class="line"> </sequences></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --> <p> </p>
<table class="cmtable" summary="Element: sequences">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</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_family_pg.html#element_sequence">sequence</a> </td><td>Describe a debug access sequence. </td><td>SequenceType </td><td>1..* </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_sequence"></a>
/package/devices/family/.../sequences/sequence</h1>
<p>Describes a Debug Access Sequence which contains <b>control</b> and <b>block</b> elements. <b>block</b> elements contains statements including calls to <a class="el" href="pdsc_family_pg.html#DebugFunctions">Debug Access Functions</a>. A Debug Access Sequence overrides or extends the default functionality of a development tool. Refer to <a class="el" href="pdsc__sequence_name_enum_pg.html#usage_of_sequences">Usage of Debug Access Sequences</a> for details.<br/>
</p>
<dl class="section note"><dt>Note</dt><dd><ul>
<li><b>control</b> elements can contain other <b>control</b> and <b>block</b> elements. <b>The maximum nesting of <em>control</em> elements is 10.</b></li>
</ul>
</dd></dl>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"Generic Family"</span> Dvendor=<span class="stringliteral">"Generic:5"</span>></div>
<div class="line"> ...</div>
<div class="line"> <sequences></div>
<div class="line"> ...</div>
<div class="line"> <sequence name=<span class="stringliteral">"UserSequence"</span>></div>
<div class="line"> </div>
<div class="line"> <block info=<span class="stringliteral">"Define variables and do debug accesses"</span>></div>
<div class="line"> __var tpWidth = (__traceout &amp; 0x003F0000) >> 16;</div>
<div class="line"> ...</div>
<div class="line"> </block></div>
<div class="line"> </div>
<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"__traceout &amp; 0x2"</span> info=<span class="stringliteral">"Parallel Trace Port enabled"</span>></div>
<div class="line"> </div>
<div class="line"> <block></div>
<div class="line"> <span class="comment">// Do something generic for parallel trace port trace</span></div>
<div class="line"> ...</div>
<div class="line"> </block></div>
<div class="line"> </div>
<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"tpWidth == 1"</span> info=<span class="stringliteral">"Configure device for 1-bit TPIU trace."</span>></div>
<div class="line"> </div>
<div class="line"> <block></div>
<div class="line"> <span class="comment">// Do debug accesses</span></div>
<div class="line"> ...</div>
<div class="line"> </block></div>
<div class="line"> </div>
<div class="line"> </control></div>
<div class="line"> </div>
<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"tpWidth == 2"</span> info=<span class="stringliteral">"Configure device for 2-bit TPIU trace."</span>></div>
<div class="line"> </div>
<div class="line"> <block></div>
<div class="line"> <span class="comment">// Do debug accesses</span></div>
<div class="line"> ...</div>
<div class="line"> </block></div>
<div class="line"> </div>
<div class="line"> </control></div>
<div class="line"> </div>
<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"tpWidth == 4"</span> info=<span class="stringliteral">"Configure device for 4-bit TPIU trace."</span>></div>
<div class="line"> </div>
<div class="line"> <block></div>
<div class="line"> <span class="comment">// Do debug accesses</span></div>
<div class="line"> ...</div>
<div class="line"> </block></div>
<div class="line"> </div>
<div class="line"> </control></div>
<div class="line"></div>
<div class="line"> </control></div>
<div class="line"> ...</div>
<div class="line"> </sequence></div>
<div class="line"> ...</div>
<div class="line"> </sequences></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: sequence">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_sequences">sequences</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_sequences">/package/devices/family/.../sequences</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>name </td><td>Name of the Debug Access Sequence:<br/>
<ul>
<li>Pre-defined names are executed by the development tool described under <a class="el" href="pdsc__sequence_name_enum_pg.html#usage_of_sequences">Usage of Debug Access Sequences</a>.</li>
<li>Any Debug Access Sequence can be executed the <a class="el" href="pdsc_family_pg.html#DebugFunctions">debug access function</a> <b>Sequence</b>. </li>
</ul>
</td><td>xs:string </td><td>required </td></tr>
<tr>
<td>Pname </td><td>Reference to a processor identifier as specified for a <b>processor</b> element. If <b>Pname</b> is set for this <b>sequence</b> element, a debugger executes the debug access sequence only for a debug connection to the referenced processor. Otherwise, it is executed for all processors. <b>This attribute must be set if defining multiple implementations of the same debug access sequence.</b> Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>optional </td></tr>
<tr>
<td>disable </td><td>Disables execution of the <a class="el" href="pdsc__sequence_name_enum_pg.html#default_sequences">Default Debug Access Sequence</a>. </td><td>xs:boolean </td><td>optional </td></tr>
<tr>
<td>info </td><td>Descriptive text to display for example for error diagnostics. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_seq_control">control</a> </td><td>Describe a debug access sequence flow control element. </td><td>SequenceControlType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_seq_block">block</a> </td><td>Describe a block of debug accesses. </td><td>SequenceBlockType </td><td>0..* </td></tr>
</table>
<p> </p>
<p><a class="anchor" id="sequences_names"></a><b>Table: Pre-defined Debug Access Sequences</b></p>
<p>The following table list the Pre-defined Debug Access Sequences. For sequences that are not specified in a <b>sequence</b> element <a class="el" href="pdsc__sequence_name_enum_pg.html#default_sequences">Default Debug Access Sequences</a> are executed. Refer to <a class="el" href="pdsc__sequence_name_enum_pg.html#usage_of_sequences">Usage of Debug Access Sequences</a> Usage for more information about the execution of these sequences.</p>
<table class="cmtable" summary="Enumeration: SequenceNameEnum">
<tr>
<th>name= </th><th>Description </th></tr>
<tr>
<td class="XML-Token"><a class="el" href="pdsc__sequence_name_enum_pg.html#DebugPortSetup">DebugPortSetup</a> </td><td>Prepare the target debug port for connection; is executed before acquiring access to the debug port.<br/>
May include for example an SWJ-DP switch sequence as defined in the ARM Debug Interface (ADI) Architecture Specification.<br/>
<b>This sequence must not contain debug port/access port register and target memory accesses other than:</b><ul>
<li><b>Reading the <em>DPIDR</em> debug port register to release an SWD connection from its line reset.</b></li>
<li><b>Writing the <em>TARGETSEL</em> debug port register (SWD protocol v2).</b> </li>
</ul>
</td></tr>
<tr>
<td class="XML-Token"><a class="el" href="pdsc__sequence_name_enum_pg.html#DebugPortStart">DebugPortStart</a> </td><td>Connect to the target debug port and power it up; is executed after DebugPortSetup.<br/>
The parent <b>debugport</b> is default debug port for this sequence.<br/>
<b>This sequence must not contain access port register and target memory accesses.</b> </td></tr>
<tr>
<td class="XML-Token"><a class="el" href="pdsc__sequence_name_enum_pg.html#DebugPortStop">DebugPortStop</a> </td><td>Power down and disconnect from target debug port.<br/>
Executed as last step during target disconnect unless another debugger connection to this port is active. The parent <b>debugport</b> is default debug port for this sequence.<br/>
<b>This sequence must not contain access port register and target memory accesses.</b> </td></tr>
<tr>
<td class="XML-Token">DebugDeviceUnlock </td><td>Check if the device is in a locked state and unlock it. Use <b>query</b> command elements for user confirmation.<br/>
Executed after having powered up the debug port. </td></tr>
<tr>
<td class="XML-Token"><a class="el" href="pdsc__sequence_name_enum_pg.html#DebugCoreStart">DebugCoreStart</a> </td><td>Initialize core debug system.<br/>
Executed after having connected and powered up the default debug port for the connection. </td></tr>
<tr>
<td class="XML-Token"><a class="el" href="pdsc__sequence_name_enum_pg.html#DebugCoreStop">DebugCoreStop</a> </td><td>Uninitialize core debug system.<br/>
Executed as last step during disconnect before powering down any debug ports no longer required for concurrent connections. </td></tr>
<tr>
<td class="XML-Token">DebugCodeMemRemap </td><td>Remap memory to execution location.<br/>
Executed before verifying memory content after flash programming. This is required to replicate a memory remap of a device bootloader (that is not executed during debug connection). </td></tr>
<tr>
<td class="XML-Token"><a class="el" href="pdsc__sequence_name_enum_pg.html#ResetSystem">ResetSystem</a> </td><td>Execute a system-wide reset via software mechanisms. </td></tr>
<tr>
<td class="XML-Token"><a class="el" href="pdsc__sequence_name_enum_pg.html#ResetProcessor">ResetProcessor</a> </td><td>Execute a processor reset via software mechanisms. </td></tr>
<tr>
<td class="XML-Token"><a class="el" href="pdsc__sequence_name_enum_pg.html#ResetHardware">ResetHardware</a> </td><td>Execute a system-wide reset via the dedicated debugger reset line, e.g. nRST. </td></tr>
<tr>
<td class="XML-Token"><a class="el" href="pdsc__sequence_name_enum_pg.html#ResetHardwareAssert">ResetHardwareAssert</a> </td><td>Assert a system-wide reset via the dedicated debugger reset line, e.g. nRST. </td></tr>
<tr>
<td class="XML-Token"><a class="el" href="pdsc__sequence_name_enum_pg.html#ResetHardwareDeassert">ResetHardwareDeassert</a> </td><td>Deassert a system-wide reset via the dedicated debugger reset line, e.g. nRST. </td></tr>
<tr>
<td class="XML-Token"><a class="el" href="pdsc__sequence_name_enum_pg.html#ResetCatchSet">ResetCatchSet</a> </td><td>Executed before a target reset to configure the vector catch to stop code execution after the reset.<br/>
The implementation of <b>ResetCatchSet</b> requires an implementation of <b>ResetCatchClear</b> to free any hardware resources used for stopping the core. </td></tr>
<tr>
<td class="XML-Token"><a class="el" href="pdsc__sequence_name_enum_pg.html#ResetCatchClear">ResetCatchClear</a> </td><td>Executed after a target reset to free hardware resources allocated by <b>ResetCatchSet</b>. </td></tr>
<tr>
<td class="XML-Token">FlashEraseDone </td><td>Executed after erasing flash memory. </td></tr>
<tr>
<td class="XML-Token">FlashProgramDone </td><td>Eexecuted after programming flash memory. </td></tr>
<tr>
<td class="XML-Token">TraceStart </td><td>Enable target trace capture.<br/>
Executed before the debugger powers up and configures standard CoreSight trace components, e.g. after the initial target connection as well as after a system-wide reset. </td></tr>
<tr>
<td class="XML-Token">TraceStop </td><td>Disable target trace capture.<br/>
Executed after the debugger disabled and powered down standard CoreSight trace components. </td></tr>
<tr>
<td class="XML-Token">RecoverySupportStart </td><td>Executed before step or run command to support recovery from a lost target connection, e.g. after a low power mode. </td></tr>
<tr>
<td class="XML-Token">RecoverySupportStop </td><td>Executed after step or run command in context of the <b>RecoverySupportStart</b> sequence. </td></tr>
<tr>
<td class="XML-Token">RecoveryAcknowledge </td><td>Debugger acknowledge after recovering from a lost target connection. Can be executed independently from a <b>RecoverySupportStart</b> sequence. </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_seq_control"></a>
/package/devices/family/.../sequences/sequence/control</h1>
<p>Describes flow control like <b>if</b> and <b>while</b> blocks for debug access sequences.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"Generic Family"</span> Dvendor=<span class="stringliteral">"Generic:5"</span>></div>
<div class="line"> ...</div>
<div class="line"> <sequences></div>
<div class="line"> ...</div>
<div class="line"> <sequence name=<span class="stringliteral">"UserSequence"</span>></div>
<div class="line"> ...</div>
<div class="line"> <block info=<span class="stringliteral">"Define variables and do debug accesses"</span>></div>
<div class="line"> __var doIfBlock = 1;</div>
<div class="line"> __var whileCondition = 1;</div>
<div class="line"> ...</div>
<div class="line"> </block></div>
<div class="line"> ...</div>
<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"doIfBlock"</span>></div>
<div class="line"> </div>
<div class="line"> <block></div>
<div class="line"> <span class="comment">// Do debug accesses</span></div>
<div class="line"> ...</div>
<div class="line"> </block></div>
<div class="line"> </div>
<div class="line"> </control></div>
<div class="line"> ...</div>
<div class="line"> <control <span class="keywordflow">while</span>=<span class="stringliteral">"whileCondition"</span> timeout=<span class="stringliteral">"5000"</span>></div>
<div class="line"> </div>
<div class="line"> <block></div>
<div class="line"> <span class="comment">// Execute while "whileCondition" different from '0' with a timeout of 5ms</span></div>
<div class="line"> whileCondition = 0;</div>
<div class="line"> </block></div>
<div class="line"> </div>
<div class="line"> </control></div>
<div class="line"> ...</div>
<div class="line"> </sequence></div>
<div class="line"> ...</div>
<div class="line"> </sequences></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: control">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_sequence">sequence</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_sequence">/package/devices/family/.../sequences/sequence</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_seq_control">control</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_seq_control">/package/devices/family/.../sequences/sequence/control</a> </td></tr>
<tr>
<th>Attribute </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>if </td><td>Expression describing the condition under which to execute this sequence block. The block is skipped if the condition resolved to <span class="XML-Token">false</span>. Defaults to <span class="XML-Token">true</span> if not set. Refer to <a class="el" href="pdsc_family_pg.html#ExpressionType">Expression Rules</a> for the syntax. </td><td>ExpressionType </td><td>optional </td></tr>
<tr>
<td>while </td><td>Expression describing a while-condition. The execution of the block contents is repeated while the condition resolves to <span class="XML-Token">true</span>, or until an optional <b>timeout</b> is reached. Refer to <a class="el" href="pdsc_family_pg.html#ExpressionType">Expression Rules</a> for the syntax. </td><td>ExpressionType </td><td>optional </td></tr>
<tr>
<td>timeout </td><td>Timeout in microseconds for a <b>block</b> with a <b>while</b> condition. A debugger must extend the timeout to the closest possible time granularity. If the timeout is reached, the current iteration including a last evaluation of the <b>while</b> condition must finish. A value of <span class="XML-Token">0</span> disables the timeout.<br/>
This attribute defaults to <span class="XML-Token">0</span>. </td><td>xs:unsignedInt </td><td>optional </td></tr>
<tr>
<td>info </td><td>Descriptive text to display for example for error diagnostics. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_seq_control">control</a> </td><td>Describe a debug access sequence flow control element. </td><td>SequenceControlType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_seq_block">block</a> </td><td>Describe a block of debug accesses. </td><td>SequenceBlockType </td><td>0..* </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_seq_block"></a>
/package/devices/family/.../sequences/sequence/block</h1>
<p>Describes a block of debug accesses. See <a class="el" href="pdsc_family_pg.html#DebugSyntaxRules">Debug Access Syntax Rules</a> for details on the allowed syntax of the block contents.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"Generic Family"</span> Dvendor=<span class="stringliteral">"Generic:5"</span>></div>
<div class="line"> ...</div>
<div class="line"> <sequences></div>
<div class="line"> ...</div>
<div class="line"> <sequence name=<span class="stringliteral">"UserSequence"</span>></div>
<div class="line"> ...</div>
<div class="line"> <block info=<span class="stringliteral">"Define condition variales for later use in block elements."</span>></div>
<div class="line"> <span class="comment">// Variable definition by __var keyword</span></div>
<div class="line"> __var doIfBlock = 1;</div>
<div class="line"> __var whileCondition = 1;</div>
<div class="line"> </block></div>
<div class="line"> ...</div>
<div class="line"> </sequence></div>
<div class="line"> ...</div>
<div class="line"> </sequences></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: block">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_sequence">sequence</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_sequence">/package/devices/family/.../sequences/sequence</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_seq_control">control</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_seq_control">/package/devices/family/.../sequences/sequence/control</a> </td></tr>
<tr>
<th>Attribute </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>atomic </td><td>Instruct the debugger to execute the block contents atomically; a debugger needs to download and buffer all debug accesses to the debug probe and finish the execution without further communication to the host PC. If a debugger cannot support an atomic block it must abort the execution of the debug access sequence.<br/>
</td><td>xs:boolean </td><td>optional </td></tr>
<tr>
<td>info </td><td>Descriptive text to display for example for error diagnostics. </td><td>xs:string </td><td>optional </td></tr>
</table>
<p><b>Atomic Blocks:</b></p>
<ul>
<li>Do not use debug access results for subsequent accesses in the same atomic block.</li>
<li>Support for atomic blocks is highly debugger dependent. Keep them as short and simple as possible to address a wide range of debuggers.</li>
<li><b>Query</b> and <b>Sequence</b> debug access functions must not be used in an atomic block.</li>
</ul>
<p> </p>
<p><a class="anchor" id="DebugSyntaxRules"></a><b>Debug Access Syntax Rules</b></p>
<p>Debug accesses are described in <b>block</b> elements of a debug access sequence (<b>sequence</b> element). The following syntax is used for this purpose:</p>
<ul>
<li>The contents of a <b>block</b> element is a series of statements.</li>
<li>Each statement must begin in a new line and is terminated by a <span class="XML-Token">;</span> character.</li>
<li>A typical statement consists of variable, followed by a <span class="XML-Token">=</span> character and an expression, where the <span class="XML-Token">=</span> character is an assignment of the <a class="el" href="pdsc_family_pg.html#ExpressionType">expression</a> result to the variable: <div class="fragment"><div class="line">variable = expression;</div>
</div><!-- fragment --></li>
<li>Alternatively, a statement can be a sole <a class="el" href="pdsc_family_pg.html#ExpressionType">expression</a> without storing its result to a variable. <div class="fragment"><div class="line">expression;</div>
</div><!-- fragment --></li>
<li>Comments begin with two slashes (<span class="XML-Token">//</span>) and end with a linebreak: <div class="fragment"><div class="line"><span class="comment">// Whole line is a comment</span></div>
<div class="line">variable = expression; <span class="comment">// Comment appended to statement</span></div>
</div><!-- fragment --></li>
<li>Variables must be defined using the keyword <span class="XML-Token">__var</span>. The definition must include an initalization of the variable: <div class="fragment"><div class="line">__var variable = 0;</div>
</div><!-- fragment --></li>
<li>Variables can be defined only once within a scope. Scopes beging with entering a debug access sequence or a <b>control</b> element. They are extended to child <b>control</b> elements. Variables of a parent scope can be modified. Leaving a scope destroys all variables defined in it.<br/>
<b><em>block</em> elements do not begin a new scope.</b> <div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"MySequence"</span>></div>
<div class="line"> </div>
<div class="line"> <block info=<span class="stringliteral">"Block 1"</span>></div>
<div class="line"> __var condvar = 1;</div>
<div class="line"> __var myvar1 = 5;</div>
<div class="line"> __var myvar2 = 0;</div>
<div class="line"> </block></div>
<div class="line"> </div>
<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"condvar"</span>></div>
<div class="line"> <block></div>
<div class="line"> <span class="comment">// __var myvar1 = 2; // Redefinition, not allowed!</span></div>
<div class="line"> __var myvar3 = 2;</div>
<div class="line"> myvar2 = myvar1 + myvar3; <span class="comment">// Assign value (5+2) = 7</span></div>
<div class="line"> </block></div>
<div class="line"> </control></div>
<div class="line"> </div>
<div class="line"> <block info=<span class="stringliteral">"Block 2"</span>></div>
<div class="line"> myvar1 = myvar2 + 1; <span class="comment">// Variable myvar1 holds the value '8' after this statement</span></div>
<div class="line"> <span class="comment">// myvar2 = myvar3; // myvar3 does not exist in this scope, not allowed!</span></div>
<div class="line"> </block></div>
<div class="line"> </div>
<div class="line"></sequence></div>
</div><!-- fragment --></li>
<li>The debug access variables <b>__dp</b>, <b>__ap</b>, and <b>__errorcontrol</b> can be modified within a debug access sequence. An assigned value is held until leaving the sequence. Calling another sequence by the <b>Sequence</b> debug access function will push their values on a sequence execution stack. The values are restored when returning from such a call.</li>
</ul>
<p><a class="anchor" id="ExpressionType"></a><b>Expression Rules</b></p>
<p>Expressions are used in various places to describe one of the following:</p>
<ul>
<li>A value as assigned in a <a class="el" href="pdsc_family_pg.html#DebugSyntaxRules">debug access statement</a>.</li>
<li>A condition to use in the <b>if</b> attribute of a <b>control</b> element.</li>
<li>A condition to use in the <b>while</b> attribute of a <b>control</b> element.</li>
<li>A parameter to a debug access function as described below.</li>
</ul>
<p>An expression may consist of the following:</p>
<ul>
<li>Constant numbers in decimal and hexadecimal representation (prefix <span class="XML-Token">0x</span>).</li>
<li>Arithmetic operators such as <span class="XML-Token">+</span>, <span class="XML-Token">-</span>, <span class="XML-Token">*</span>, <span class="XML-Token">/</span>, and <span class="XML-Token">%</span>.</li>
<li>Bit-arithmetic operators such as <span class="XML-Token">&</span>, <span class="XML-Token">|</span>, <span class="XML-Token">~</span>, <span class="XML-Token">^</span>, <span class="XML-Token">>></span>, and <span class="XML-Token"><<</span>.</li>
<li>Comparison-operators such as <span class="XML-Token">==</span>, <span class="XML-Token">!=</span>, <span class="XML-Token"><</span>, <span class="XML-Token">></span>, <span class="XML-Token"><=</span>, and <span class="XML-Token">>=</span>.</li>
<li>Logic operators such as <span class="XML-Token">!</span>, <span class="XML-Token">&&</span>, <span class="XML-Token">||</span>, and <span class="XML-Token">==</span>.</li>
<li>Conditional expression operations like: <div class="fragment"><div class="line">(x < y) ? a : b </div>
</div><!-- fragment --></li>
<li>Precedence of sub-expressions is indicated by brackets (<span class="XML-Token">(</span>, <span class="XML-Token">)</span>). C-like precedence applies if brackets are omitted.</li>
<li>References to <a class="el" href="pdsc_family_pg.html#DebugVars">debug access variables</a> for evaluating debug settings.</li>
<li>Calls to <a class="el" href="pdsc_family_pg.html#DebugFunctions">debug access functions</a>.</li>
</ul>
<dl class="section note"><dt>Note</dt><dd><ul>
<li>All values used in expressions resolve to 64-bit unsigned integer values.</li>
<li>All logic-operations and comparisons resolve to the value <span class="XML-Token">1</span> if true, to <span class="XML-Token">0</span> otherwise.</li>
<li>XML prohibits the use of the characters <span class="XML-Token">&</span>, <span class="XML-Token"><</span>, and <span class="XML-Token">></span>. Use the corresponding XML entity names instead: <span class="XML-Token">&amp;</span>, <span class="XML-Token">&lt;</span>, and <span class="XML-Token">&gt;</span>.</li>
</ul>
</dd></dl>
<p> </p>
<p><a class="anchor" id="DebugFunctions"></a><b>Table: Debug Access Functions</b></p>
<p>Debug access functions can be called in expressions in order to interact with the target device and the user. Parameters to functions can again be expressions.<br/>
By default, a debugger must abort the execution of a debug access sequence if a function call fails. However, this behavior can be controlled from a sequence by the <b>__errorcontrol</b> <a class="el" href="pdsc_family_pg.html#DebugVars">debug access variable</a>.<br/>
<br/>
The following table describes the existing debug access functions, their parameters and the debug access variables which are evaluated for the function call.</p>
<table class="cmtable" summary="ExpressionType: debug access functions">
<tr>
<th>Function </th><th>Description </th></tr>
<tr>
<td style="white-space: nowrap"><pre>Sequence("name")</pre> </td><td><p class="starttd">Execute a debug access sequence. Calling a sequence by this function causes the modifiable debug access variables <b>__dp</b>, <b>__ap</b>, and <b>__errorcontrol</b> to be pushed on a sequence execution stack. Returning from such a call will restore the state of these variables.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>name: Name of the sequence to execute. It must be enclosed by quotes.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
Always returns <span class="XML-Token">0</span>. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>Read8(addr)</pre> </td><td><p class="starttd">Read an 8-bit value from target memory. <b>A device must support native 8-bit memory accesses for this function to succeed.</b><br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>addr: Memory address to read from.</li>
</ul>
<p><b>Debug Access Variables:</b><br/>
</p>
<ul>
<li>__dp: The debug port to use for this memory access.</li>
<li>__ap: The access port to use for this memory access.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
The 8-bit value as read from target memory. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>Read16(addr)</pre> </td><td><p class="starttd">Read an 16-bit value from target memory. <b>A device must support native 16-bit memory accesses for this function to succeed.</b><br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>addr: Memory address to read from.</li>
</ul>
<p><b>Debug Access Variables:</b><br/>
</p>
<ul>
<li>__dp: The debug port to use for this memory access.</li>
<li>__ap: The access port to use for this memory access.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
The 16-bit value as read from target memory. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>Read32(addr)</pre> </td><td><p class="starttd">Read an 32-bit value from target memory. <b>A device must support native 32-bit memory accesses for this function to succeed.</b><br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>addr: Memory address to read from.</li>
</ul>
<p><b>Debug Access Variables:</b><br/>
</p>
<ul>
<li>__dp: The debug port to use for this memory access.</li>
<li>__ap: The access port to use for this memory access.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
The 32-bit value as read from target memory. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>Read64(addr)</pre> </td><td><p class="starttd">Read an 64-bit value from target memory. <b>A device must support native 64-bit memory accesses for this function to succeed.</b><br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>addr: Memory address to read from.</li>
</ul>
<p><b>Debug Access Variables:</b><br/>
</p>
<ul>
<li>__dp: The debug port to use for this memory access.</li>
<li>__ap: The access port to use for this memory access.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
The 64-bit value as read from target memory. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>ReadAP(addr)</pre> </td><td><p class="starttd">Read a 32-bit value from an access port register.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>addr: AP register address to read from. Addresses larger than <span class="XML-Token">0xF</span> automatically cause an AP register bank switch.</li>
</ul>
<p><b>Debug Access Variables:</b><br/>
</p>
<ul>
<li>__dp: The debug port to use for this memory access.</li>
<li>__ap: The access port to use for this memory access.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
The 32-bit value as read from the AP register. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>ReadDP(addr)</pre> </td><td><p class="starttd">Read a 32-bit value from a debug port register.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>addr: DP register address to read from.</li>
</ul>
<p><b>Debug Access Variables:</b><br/>
</p>
<ul>
<li>__dp: The debug port to use for this memory access.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
The 32-bit value as read from the DP register. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>Write8(addr, val)</pre> </td><td><p class="starttd">Write an 8-bit value to target memory. <b>A device must support native 8-bit memory accesses for this function to succeed.</b><br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>addr: Memory address to write to.</li>
<li>val: Value to write.</li>
</ul>
<p><b>Debug Access Variables:</b><br/>
</p>
<ul>
<li>__dp: The debug port to use for this memory access.</li>
<li>__ap: The access port to use for this memory access.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
Always returns <span class="XML-Token">0</span>. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>Write16(addr, val)</pre> </td><td><p class="starttd">Write a 16-bit value to target memory. <b>A device must support native 16-bit memory accesses for this function to succeed.</b><br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>addr: Memory address to write to.</li>
<li>val: Value to write.</li>
</ul>
<p><b>Debug Access Variables:</b><br/>
</p>
<ul>
<li>__dp: The debug port to use for this memory access.</li>
<li>__ap: The access port to use for this memory access.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
Always returns <span class="XML-Token">0</span>. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>Write32(addr, val)</pre> </td><td><p class="starttd">Write a 32-bit value to target memory. <b>A device must support native 32-bit memory accesses for this function to succeed.</b><br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>addr: Memory address to write to.</li>
<li>val: Value to write.</li>
</ul>
<p><b>Debug Access Variables:</b><br/>
</p>
<ul>
<li>__dp: The debug port to use for this memory access.</li>
<li>__ap: The access port to use for this memory access.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
Always returns <span class="XML-Token">0</span>. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>Write64(addr, val)</pre> </td><td><p class="starttd">Write a 64-bit value to target memory. <b>A device must support native 64-bit memory accesses for this function to succeed.</b><br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>addr: Memory address to write to.</li>
<li>val: Value to write.</li>
</ul>
<p><b>Debug Access Variables:</b><br/>
</p>
<ul>
<li>__dp: The debug port to use for this memory access.</li>
<li>__ap: The access port to use for this memory access.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
Always returns <span class="XML-Token">0</span>. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>WriteAP(addr, val)</pre> </td><td><p class="starttd">Write a 32-bit value to an access port register. Addresses larger than 0xF automatically cause an AP register bank switch.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>addr: Memory address to write to.</li>
<li>val: Value to write.</li>
</ul>
<p><b>Debug Access Variables:</b><br/>
</p>
<ul>
<li>__dp: The debug port to use for this memory access.</li>
<li>__ap: The access port to use for this memory access.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
Always returns <span class="XML-Token">0</span>. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>WriteDP(addr, val)</pre> </td><td><p class="starttd">Write a 32-bit value to a debug port register.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>addr: Memory address to write to.</li>
<li>val: Value to write.</li>
</ul>
<p><b>Debug Access Variables:</b><br/>
</p>
<ul>
<li>__dp: The debug port to use for this memory access.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
Always returns <span class="XML-Token">0</span>. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>DAP_Delay(delay)</pre> </td><td><p class="starttd">Debug probe command to wait for a specific delay.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>delay: Wait time in microseconds.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
Always returns <span class="XML-Token">0</span>. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>DAP_WriteABORT(value)</pre> </td><td><p class="starttd">Debug probe command to write an abort request to the CoreSight ABORT register of the target debug port.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>value: 32-bit value to write into the CoreSight ABORT register.</li>
</ul>
<p><b>Debug Access Variables:</b><br/>
</p>
<ul>
<li>__dp: The debug port to use for this memory access.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
Always returns <span class="XML-Token">0</span>. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>DAP_SWJ_Pins(pinout, pinselect, pinwait)</pre> </td><td><p class="starttd">Debug proble command to monitor and control the I/O Pins including the nRESET device reset line.<br/>
<b>I/O Pin Mapping</b> for <b>pinout</b>, <b>pinselect</b>, and <b>pinwait</b>:</p>
<ul>
<li>Bit 0: SWCLK/TCK</li>
<li>Bit 1: SWDIO/TMS</li>
<li>Bit 2: TDI</li>
<li>Bit 3: TDO</li>
<li>Bit 5: nTRST</li>
<li>Bit 7: nRESET</li>
</ul>
<p><br/>
The <b>pinwait</b> time is useful in systems where the nRESET pin is implemented as open-drain output. After nRESET is de-asserted by the debugger, external circuit may still hold the target Device under reset for a time. Using the <b>pinwait</b> time, the debugger may monitor selected I/O Pins and wait until they the expected value appears or a timeout expires.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>pinout: Value for selected output pins.</li>
<li>pinselect: Selects which output pins will be modified.</li>
<li>pinwait: Wait timeout for the selected output to stabilize. A debugger must extend this timeout to the closest possible time granularity.<ul>
<li>0 = no wait</li>
<li>1 .. 3000000 = time in microseconds (max 3s)</li>
</ul>
</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
The state of the I/O Pins at the end of this operation. If a debugger is not capable of monitoring the I/O Pins, it must return a value of <span class="XML-Token">0xFFFFFFFF</span>. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>DAP_SWJ_Clock(val)</pre> </td><td><p class="starttd">Debug probe command to set the clock frequency for JTAG and SWD communication mode.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>val: Maximum SWD/JTAG Clock (SWCLK/TCK) value in Hz.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
Always returns <span class="XML-Token">0</span>. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>DAP_SWJ_Sequence(cnt, val)</pre> </td><td><p class="starttd">Debug probe command to generate required SWJ sequences, e.g. for SWD/JTAG Reset, SWD<->JTAG switch and Dormant operation.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>cnt: Number of bits in sequence: 1..64. Larger sequences need to be implemented by multiple subsequent <b>DAP_SWJ_Sequence</b> calls. Such a sequence of <b>DAP_SWJ_Sequence</b> commands must be encapsulated in an atomic <b>block</b> to ensure correct execution.</li>
<li>val: Sequence generated on SWDIO/TMS (with clock @SWCLK/TCK), LSB transmitted first.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
Always returns <span class="XML-Token">0</span>. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>DAP_JTAG_Sequence(cnt, tms, tdi)</pre> </td><td><p class="starttd">Debug probe command to generate a JTAG sequence with fixed TMS value and capture TDO.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>cnt: Length of the JTAG sequence (number of TCK cycles and TDI bits): 1..64</li>
<li>tms: Fixed TMS value: 0..1</li>
<li>tdi: Data generated on TDI with one bit per TCK cycle, LSB transmitted first.</li>
</ul>
<p class="endtd"><b>Return Value:</b><br/>
Data captured from TDO with one bit per TCK cycle, LSB captured first and padded with <span class="XML-Token">0</span>s. </p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>Query(type, "message", default)</pre> </td><td><p class="starttd">Query user input. The sequence execution stalls depending on the used <b>type</b>. If the debugger runs in a batch mode, this function returns the value <b>default</b>.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>type: Query type. Can be one of:<ul>
<li><span class="XML-Token">0</span> : <b>Query_Ok</b>, displays an informative message which has to be confirmed by the user. This type allows the result <b>OK</b>.</li>
<li><span class="XML-Token">1</span> : <b>Query_YesNo</b>, displays a query with the allowed results <b>Yes</b> and <b>No</b>.</li>
<li><span class="XML-Token">2</span> : <b>Query_YesNoCancel</b>, displays a query with the allowed results <b>Yes</b>, <b>No</b>, and <b>Cancel</b>.</li>
<li><span class="XML-Token">3</span> : <b>Query_OkCancel</b>, displays a query with the allowed results <b>OK</b> and <b>Cancel</b>.</li>
</ul>
</li>
<li>message: A constant string with the query message to display. It must not be an expression and it must be enclosed by quotes.</li>
<li>default: The default value to return if the debugger runs in batch mode. See <b>Return Values</b> for a list of allowed values.</li>
</ul>
<p><b>Return Value:</b><br/>
The result of the query. The user input maps to the following numbers:</p>
<ul>
<li>Error : <span class="XML-Token">0</span></li>
<li>OK : <span class="XML-Token">1</span></li>
<li>Cancel : <span class="XML-Token">2</span></li>
<li>Yes : <span class="XML-Token">3</span></li>
<li>No : <span class="XML-Token">4</span></li>
</ul>
<p class="endtd"></p>
</td></tr>
</table>
<dl class="section note"><dt>Note</dt><dd><ul>
<li>Target memory access functions must perform a debug access of the size indicated by their name. The target system must support debug accesses of this size.</li>
<li>Results of all functions are casted to 64-bit unsigned integer values.</li>
<li>Some target access functions determine the used debug and access port by the current values of the <b>__dp</b> and <b>__ap</b> debug access variables. If a target access requires a different debug or access port than the default ones, it must change these values. This change is held until finishing the sequence the change has occurred in.</li>
</ul>
</dd></dl>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_debug"></a>
/package/devices/family/.../debug</h1>
<p>Describes configuration settings, default values, and patches for data accesses for a debug connection. Multiple <b>debug</b> elements can be defined which are either specific to a processor identified by attribute <b>Pname</b>, or which apply to all connections.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"LPC4300 Series"</span> Dvendor=<span class="stringliteral">"NXP:11"</span>></div>
<div class="line"> ...</div>
<div class="line"> <debug Pname=<span class="stringliteral">"Cortex-M4"</span> __dp=<span class="stringliteral">"0"</span> __ap=<span class="stringliteral">"0"</span> svd=<span class="stringliteral">"SVD/LPC43xx.svd"</span>></div>
<div class="line"> ...</div>
<div class="line"> </debug></div>
<div class="line"> ...</div>
<div class="line"> <debug Pname=<span class="stringliteral">"Cortex-M0"</span> __dp=<span class="stringliteral">"1"</span> __ap=<span class="stringliteral">"0"</span> svd=<span class="stringliteral">"SVD/LPC43xx.svd"</span>></div>
<div class="line"> ...</div>
<div class="line"> </debug></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: debug">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>Pname </td><td>Reference to a processor identifier as specified for a <b>processor</b> element. If <b>Pname</b> is set this <b>debug</b> element's settings and data patches only apply for target connections to the referenced processor. Otherwise, they apply for all processors. <b>This attribute must be set if defining multiple <em>debug</em> elements within the same section.</b> Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>optional </td></tr>
<tr>
<td>__dp </td><td>Default debug port ID to use for target accesses in this debug connection. The allowed values are defined in <b>debugport</b> elements for this device. If no <b>debugport</b> element exists, the only allowed value is <span class="XML-Token">0</span>.<br/>
The debug access variable <b>__dp</b> is initialized to this value when entering a pre-defined debug access sequence because of a debug event.<br/>
This attribute defaults to <span class="XML-Token">0</span> if not set. </td><td>xs:unsignedInt </td><td>optional </td></tr>
<tr>
<td>__ap </td><td>Default access port index to use for target accesses in this debug connection.<br/>
The debug access variable <b>__ap</b> is initialized to this value when entering a pre-defined debug access sequence because of a debug event.<br/>
This attribute defaults to <span class="XML-Token">0</span> if not set. </td><td>xs:unsignedInt </td><td>optional </td></tr>
<tr>
<td>svd </td><td>The system viewer description (*.SVD) file to load for this debug connection. The file path is relative to the package base folder. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_dbg_datapatch">datapatch</a> </td><td>Define a patch to apply for data reads in this debug connection. </td><td>DataPatchType </td><td><p class="starttd">0..* </p>
<p class="endtd"></p>
</td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_dbg_datapatch"></a>
/package/devices/family/.../debug/datapatch</h1>
<p>Describes a patch a debugger shall apply when reading data from the device.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"LPC800 Series"</span> Dvendor=<span class="stringliteral">"NXP:11"</span>></div>
<div class="line"> ...</div>
<div class="line"> <debug svd=<span class="stringliteral">"SVD\LPC800.svd"</span>></div>
<div class="line"> ...</div>
<div class="line"> <datapatch type=<span class="stringliteral">"Mem"</span> __ap=<span class="stringliteral">"0"</span> address=<span class="stringliteral">"0x1400000C"</span> value=<span class="stringliteral">"0x10000000"</span> mask=<span class="stringliteral">"0xFFFFFFFF"</span> info=<span class="stringliteral">"Patch MTB BASE register"</span>/></div>
<div class="line"> ...</div>
<div class="line"> </debug></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: datapatch">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_debug">debug</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_debug">/package/devices/family/.../debug</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>type </td><td>The type of data access to patch. Predefined tokens must be used as defined in <a class="el" href="pdsc_family_pg.html#DataPatchAccessTypeEnum">Table: Data Patch Access Type</a>. This attribute defaults to <span class="XML-Token">Mem</span> if not set. </td><td>DataPatchAccessTypeEnum </td><td>optional </td></tr>
<tr>
<td>__dp </td><td>The debug port ID to apply the patch for. The allowed values are defined by the <b>__dp</b> attribute of <b>debugport</b> elements for this device. If no debugport element exists, the only allowed value is 0. If this attribute is not set, the debug port ID for the data patch is set to the default <b>__dp</b> of this <b>debug</b> section. </td><td>xs:unsignedInt </td><td>optional </td></tr>
<tr>
<td>__ap </td><td>The CoreSight access port index to apply the patch for. If this attribute is not set, the access port index for the data patch is set to the default <b>__ap</b> of this <b>debug</b> section. </td><td>xs:unsignedInt </td><td>optional </td></tr>
<tr>
<td>address </td><td>The address for which to apply the patch. </td><td>NonNegativeInteger </td><td>required </td></tr>
<tr>
<td>value </td><td>The value with which the debugger patches the data access. <b>value</b> is specified in little-endian format. </td><td>NonNegativeInteger </td><td>required </td></tr>
<tr>
<td>mask </td><td>The bits of the data access to patch. The mask value is specified in little-endian format. </td><td>NonNegativeInteger </td><td>optional </td></tr>
<tr>
<td>info </td><td>Descriptive text to display for example for error diagnostics. </td><td>xs:string </td><td>optional </td></tr>
</table>
<p> </p>
<p><a class="anchor" id="DataPatchAccessTypeEnum"></a><b>Table: Data Patch Access Type</b></p>
<p>The table lists the allowed values for data patch access types. </p>
<table class="cmtable" summary="Enumeration: DataPatchAccessTypeEnum">
<tr>
<th>type= </th><th>Description </th></tr>
<tr>
<td class="XML-Token">DP </td><td>CoreSight Debug Port register access.<br/>
<b>Note:</b> This type refers to accesses via the <b>DPACC</b> instruction for <b>CoreSight JTAG-DPs</b>. Please refer to the corresponding documentation for differences in the register interface between JTAG and Serial Wire debug ports. </td></tr>
<tr>
<td class="XML-Token">AP </td><td>CoreSight Access Port register access. </td></tr>
<tr>
<td class="XML-Token">Mem </td><td>Memory access. </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_trace"></a>
/package/devices/family/.../trace</h1>
<p>Describes device capabilities and possible configuration settings for capturing trace. Multiple <b>trace</b> elements can be defined which are either specific to a processor identified by attribute <b>Pname</b>, or which apply to all connections.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"LPC4300 Series"</span> Dvendor=<span class="stringliteral">"NXP:11"</span>></div>
<div class="line"> ...</div>
<div class="line"> <trace Pname=<span class="stringliteral">"Cortex-M4"</span>></div>
<div class="line"> <serialwire/></div>
<div class="line"> <traceport width=<span class="stringliteral">"0x0000000B"</span>/> <!-- support <span class="keywordflow">for</span> port widths 1, 2, and 4 --></div>
<div class="line"> <tracebuffer start=<span class="stringliteral">"0x2000C000"</span> size=<span class="stringliteral">"0x4000"</span>/></div>
<div class="line"> </trace></div>
<div class="line"> ...</div>
<div class="line"> <trace Pname=<span class="stringliteral">"Cortex-M0"</span>></div>
<div class="line"> <!-- Empty trace section <span class="keywordflow">for</span> Cortex-M0, no trace capabilities --></div>
<div class="line"> </trace></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: trace">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_family">family</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_family">/package/devices/family</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_subFamily">subFamily</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_subFamily">/package/devices/family/subFamily</a> </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>Pname </td><td>Reference to a processor identifier as specified for a <b>processor</b> element. If <b>Pname</b> is set this <b>trace</b> section only applies for target connections to the referenced processor. Otherwise, it applies for all processors. <b>This attribute must be set if defining multiple <em>trace</em> elements within the same section.</b> Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>optional </td></tr>
<tr>
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_trace_serialwire">serialwire</a> </td><td>Describe the serial wire trace output capabilities of the processor. </td><td>SerialWireType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_trace_traceport">traceport</a> </td><td>Describe the parallel trace port output capabilities of the processor. </td><td>TracePortType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_trace_tracebuffer">tracebuffer</a> </td><td>Describe the on-device trace buffer capabilities of the processor. </td><td>TraceBufferType </td><td>0..* </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_trace_serialwire"></a>
/package/devices/family/.../trace/serialwire</h1>
<p>Indicates serial wire trace output capabilities of the specified processor.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"LPC4300 Series"</span> Dvendor=<span class="stringliteral">"NXP:11"</span>></div>
<div class="line"> ...</div>
<div class="line"> <trace Pname=<span class="stringliteral">"Cortex-M4"</span>></div>
<div class="line"> ...</div>
<div class="line"> <serialwire/></div>
<div class="line"> ...</div>
<div class="line"> </trace></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: serialwire">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_trace">trace</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_trace">/package/devices/family/.../trace</a> </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_trace_traceport"></a>
/package/devices/family/.../trace/traceport</h1>
<p>Indicates parallel trace port output capabilities of the specified processor. This element describes possible configuration settings for capturing trace.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"LPC4300 Series"</span> Dvendor=<span class="stringliteral">"NXP:11"</span>></div>
<div class="line"> ...</div>
<div class="line"> <trace Pname=<span class="stringliteral">"Cortex-M4"</span>></div>
<div class="line"> ...</div>
<div class="line"> <traceport width=<span class="stringliteral">"0x0000000B"</span>/> <!-- support <span class="keywordflow">for</span> port widths 1, 2, and 4 --></div>
<div class="line"> ...</div>
<div class="line"> </trace></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: traceport">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_trace">trace</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_trace">/package/devices/family/.../trace</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>width </td><td>Parallel trace port widths supported for the processor connection (see table below). </td><td>NonNegativeInteger </td><td>optional </td></tr>
</table>
<p>The attribute <b>width</b> specifies the available trace port width that is supported by the device. Each bit of this value represents an available trace port size. If bit <span class="XML-Token">n</span> is set a trace port width of <span class="XML-Token">n+1</span> is supported. The value <b>width=0x00008088</b> (as shown in the table) indicates that three port sizes (16-bit, 8-bit, and 4-bit) are supported by the device.</p>
<table class="cmtable" summary="Element: traceportwidth">
<tr>
<th>Bit </th><th>31 </th><th>30 </th><th>29 </th><th>28 </th><th>27 </th><th>26 </th><th>25 </th><th>24 </th><th>23 </th><th>22 </th><th>21 </th><th>20 </th><th>19 </th><th>18 </th><th>17 </th><th>16 </th><th>15 </th><th>14 </th><th>13 </th><th>12 </th><th>11 </th><th>10 </th><th>9 </th><th>8 </th><th>7 </th><th>6 </th><th>5 </th><th>4 </th><th>3 </th><th>2 </th><th>1 </th><th>0 </th></tr>
<tr>
<td>width </td><td>32 </td><td>31 </td><td>30 </td><td>29 </td><td>28 </td><td>27 </td><td>26 </td><td>25 </td><td>24 </td><td>23 </td><td>22 </td><td>21 </td><td>20 </td><td>19 </td><td>18 </td><td>17 </td><td>16 </td><td>15 </td><td>14 </td><td>13 </td><td>12 </td><td>11 </td><td>10 </td><td>9 </td><td>8 </td><td>7 </td><td>6 </td><td>5 </td><td>4 </td><td>3 </td><td>2 </td><td>1 </td></tr>
<tr>
<td>Value </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>1 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>0 </td><td>1 </td><td>0 </td><td>0 </td><td>0 </td><td>1 </td><td>0 </td><td>0 </td><td>0 </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_trace_tracebuffer"></a>
/package/devices/family/.../trace/tracebuffer</h1>
<p>Indicates on-device trace buffer capabilities of the specified processor. This element describes possible configuration settings for capturing trace and reading it from the buffer.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><family Dfamily=<span class="stringliteral">"LPC4300 Series"</span> Dvendor=<span class="stringliteral">"NXP:11"</span>></div>
<div class="line"> ...</div>
<div class="line"> <trace Pname=<span class="stringliteral">"CoreCM4"</span>></div>
<div class="line"> ...</div>
<div class="line"> <tracebuffer start=<span class="stringliteral">"0x2000C000"</span> size=<span class="stringliteral">"0x4000"</span>/></div>
<div class="line"> ...</div>
<div class="line"> </trace></div>
<div class="line"> ...</div>
<div class="line"></family></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: tracebuffer">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_trace">trace</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_trace">/package/devices/family/.../trace</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>start </td><td>Start address of the on-chip memory used as trace buffer for a supported configuration. </td><td>NonNegativeInteger </td><td>optional </td></tr>
<tr>
<td>size </td><td>Size of the on-chip memory used as trace buffer in bytes for a supported configuration. </td><td>NonNegativeInteger </td><td>optional </td></tr>
</table>
<p> </p>
<hr/>
<h1><a class="anchor" id="element_variant"></a>
/package/devices/family/.../device/variant</h1>
<p>Defines a device variant. The element is optional. Can exist multiple times.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><device Dname=<span class="stringliteral">"STM32F205RB"</span>></div>
<div class="line"> ...</div>
<div class="line"> <variant Dvariant=<span class="stringliteral">"STM32F205RBT6"</span>></div>
<div class="line"> <book name=<span class="stringliteral">"doc\STM32F2_RM.PDF"</span> title=<span class="stringliteral">"STM32F2 Reference Manual"</span>/></div>
<div class="line"> <description>Use <span class="keyword">this</span> device as an alternative.</description></div>
<div class="line"> <feature type=<span class="stringliteral">"QFP"</span> count=<span class="stringliteral">"64"</span> name=<span class="stringliteral">"LQFP 64 10x10x1.4"</span> /></div>
<div class="line"> <feature type=<span class="stringliteral">"Temp"</span> n=<span class="stringliteral">"-40"</span> m=<span class="stringliteral">"85"</span> name=<span class="stringliteral">"Industrial Temperature Range"</span>/></div>
<div class="line"> </variant></div>
<div class="line"> <variant Dvariant=<span class="stringliteral">"STM32F205RBT7"</span>></div>
<div class="line"> <feature type=<span class="stringliteral">"QFP"</span> count=<span class="stringliteral">"64"</span> name=<span class="stringliteral">"LQFP 64 10x10x1.4"</span> /></div>
<div class="line"> <feature type=<span class="stringliteral">"Temp"</span> n=<span class="stringliteral">"-40"</span> m=<span class="stringliteral">"105"</span> name=<span class="stringliteral">"Extended Temperature Range"</span>/></div>
<div class="line"> </variant></div>
<div class="line"> ...</div>
<div class="line"></device></div>
</div><!-- fragment --><p> </p>
<table class="cmtable" summary="Element: variant">
<tr>
<th>Parents </th><th colspan="3">Element Chain </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_device">device</a> </td><td colspan="3"><a class="el" href="pdsc_family_pg.html#element_device">/package/devices/family/../device</a> </td></tr>
<tr>
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
<tr>
<td>Dvariant </td><td>Name of the device variant. Only alphabetical characters, decimal digits, '-' and '_' are allowed </td><td>RestrictedString </td><td>required </td></tr>
<tr>
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_book">book</a> </td><td>List books that are specific to this variant. </td><td>BookType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_description">description</a> </td><td>Device description. </td><td>DescriptionType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_feature">feature</a> </td><td>Define features for this device variant. </td><td>FeatureType </td><td>0..* </td></tr>
</table>
<p> </p>
<hr/>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="_pack_format.html">Pack Description (*.PDSC) Format</a></li><li class="navelem"><a class="el" href="pdsc_devices_pg.html">/package/devices element</a></li>
<li class="footer">Generated on Tue Oct 27 2015 14:35:43 for CMSIS-Pack by ARM Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.2
-->
</li>
</ul>
</div>
</body>
</html>
|
