xmclib/CMSIS/Documentation/Pack/html/pdsc_family_pg.html

2611 lines
194 KiB
HTML
Raw Permalink Normal View History

2024-10-17 17:09:59 +02:00
<!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);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Pack
&#160;<span id="projectnumber">Version 1.4.9</span>
</div>
<div id="projectbrief">Delivery Mechanism for Software Packs</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">/package/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 &lt;family&gt; groups can be defined.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line">&lt;devices&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;family Dfamily=<span class="stringliteral">&quot;STM32F2&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>&gt;</div>
<div class="line"> &lt;processor .../&gt;</div>
<div class="line"> &lt;debugconfig .../&gt;</div>
<div class="line"> &lt;debugvars .../&gt;</div>
<div class="line"> &lt;sequences .../&gt;</div>
<div class="line"> &lt;compile .../&gt;</div>
<div class="line"> &lt;memory .../&gt;</div>
<div class="line"> &lt;algorithm .../&gt;</div>
<div class="line"> &lt;book .../&gt;</div>
<div class="line"> &lt;description&gt; Write texte here &lt;/description&gt;</div>
<div class="line"> &lt;environment&gt; ... &lt;/environment&gt;</div>
<div class="line"> &lt;feature .../&gt;</div>
<div class="line"> &lt;debugport .../&gt;</div>
<div class="line"> &lt;debug .../&gt;</div>
<div class="line"> &lt;trace .../&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;subFamily DsubFamily=<span class="stringliteral">&quot;...&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;device Dname=<span class="stringliteral">&quot;...&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/device&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/subFamily&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/family&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/devices&gt;</div>
</div><!-- fragment --><p>&#160;</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_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_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_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>&#160;</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 &lt;subFamily&gt; groups can be defined.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line">&lt;family Dfamily=<span class="stringliteral">&quot;STM32F2&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>&gt;</div>
<div class="line"> ... </div>
<div class="line"> &lt;subFamily DsubFamily=<span class="stringliteral">&quot;...&quot;</span>&gt;</div>
<div class="line"> &lt;processor .../&gt;</div>
<div class="line"> &lt;debugconfig .../&gt;</div>
<div class="line"> &lt;debugvars .../&gt;</div>
<div class="line"> &lt;sequences .../&gt;</div>
<div class="line"> &lt;compile .../&gt;</div>
<div class="line"> &lt;memory .../&gt;</div>
<div class="line"> &lt;algorithm .../&gt;</div>
<div class="line"> &lt;book .../&gt;</div>
<div class="line"> &lt;description&gt; Write texte here &lt;/description&gt;</div>
<div class="line"> &lt;feature .../&gt;</div>
<div class="line"> &lt;debugport .../&gt;</div>
<div class="line"> &lt;debug .../&gt;</div>
<div class="line"> &lt;trace .../&gt;</div>
<div class="line"> &lt;device Dname=<span class="stringliteral">&quot;...&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/device&gt;</div>
<div class="line"> &lt;/subFamily&gt;</div>
<div class="line"></div>
<div class="line"> &lt;subFamily DsubFamily=<span class="stringliteral">&quot;STM32F2xx&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/subFamily&gt;</div>
<div class="line"></div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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>&#160;</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 &lt;device&gt; elements can be defined.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line">&lt;subFamily DsubFamily=<span class="stringliteral">&quot;STM32F405&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;device Dname=<span class="stringliteral">&quot;STM32F405OE&quot;</span>&gt;</div>
<div class="line"> &lt;memory name=<span class="stringliteral">&quot;Flash&quot;</span> access=<span class="stringliteral">&quot;rx&quot;</span> start=<span class="stringliteral">&quot;0x08000000&quot;</span> size=<span class="stringliteral">&quot;0x80000&quot;</span> startup=<span class="stringliteral">&quot;1&quot;</span> <span class="keywordflow">default</span>=<span class="stringliteral">&quot;1&quot;</span>/&gt;</div>
<div class="line"> &lt;algorithm name=<span class="stringliteral">&quot;Flash/STM32F4xx_1024.flm&quot;</span> start=<span class="stringliteral">&quot;0x08000000&quot;</span> size=<span class="stringliteral">&quot;0x80000&quot;</span> <span class="keywordflow">default</span>=<span class="stringliteral">&quot;1&quot;</span> style=<span class="stringliteral">&quot;Keil&quot;</span>/&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;IOs&quot;</span> n=<span class="stringliteral">&quot;72&quot;</span> name=<span class="stringliteral">&quot;Input and Output Ports&quot;</span>/&gt;</div>
<div class="line"> &lt;/device&gt;</div>
<div class="line"></div>
<div class="line"> &lt;device Dname=<span class="stringliteral">&quot;STM32F405OG&quot;</span>&gt;</div>
<div class="line"> &lt;memory name=<span class="stringliteral">&quot;Flash&quot;</span> access=<span class="stringliteral">&quot;rx&quot;</span> start=<span class="stringliteral">&quot;0x08000000&quot;</span> size=<span class="stringliteral">&quot;0x100000&quot;</span> startup=<span class="stringliteral">&quot;1&quot;</span> <span class="keywordflow">default</span>=<span class="stringliteral">&quot;1&quot;</span>/&gt;</div>
<div class="line"> &lt;algorithm name=<span class="stringliteral">&quot;Flash/STM32F4xx_1024.flm&quot;</span> start=<span class="stringliteral">&quot;0x08000000&quot;</span> size=<span class="stringliteral">&quot;0x100000&quot;</span> <span class="keywordflow">default</span>=<span class="stringliteral">&quot;1&quot;</span> style=<span class="stringliteral">&quot;Keil&quot;</span>/&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;IOs&quot;</span> n=<span class="stringliteral">&quot;72&quot;</span> name=<span class="stringliteral">&quot;Input and Output Ports&quot;</span>/&gt;</div>
<div class="line"> &lt;/device&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/subFamily&gt;</div>
</div><!-- fragment --><p>&#160;</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_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_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_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 the features of this device. </td><td>FeatureType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_feature">environment</a> </td><td>Specify tool options. </td><td>EnvironmentType </td><td>0..* </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_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_variant">variant</a> </td><td>Complex element specifying a variant of a device. </td><td>xs:ComplexType </td><td>0..* </td></tr>
</table>
<p>&#160;</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 &lt;default&gt; 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 &lt;algorithm&gt; 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">&lt;family Dfamily=<span class="stringliteral">&quot;STM32F4&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;!-- use <span class="keywordflow">for</span> all devices of the family --&gt;</div>
<div class="line"> &lt;algorithm name=<span class="stringliteral">&quot;Flash\STM32F2xx_512.flm&quot;</span> start=0x08000000 size=0x10000 <span class="keywordflow">default</span>=<span class="stringliteral">&quot;1&quot;</span> style=<span class="stringliteral">&quot;Keil&quot;</span>/&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;subFamily DsubFamily=<span class="stringliteral">&quot;STM32F405&quot;</span>&gt;</div>
<div class="line"> &lt;!-- use <span class="keywordflow">for</span> all devices of a subFamily --&gt;</div>
<div class="line"> &lt;algorithm name=<span class="stringliteral">&quot;Flash/STM32F2xx_1024.flm&quot;</span> start=0x08000000 size=0x20000 <span class="keywordflow">default</span>=<span class="stringliteral">&quot;1&quot;</span> style=<span class="stringliteral">&quot;Keil&quot;</span>/&gt; </div>
<div class="line"></div>
<div class="line"> &lt;device Dname=<span class="stringliteral">&quot;STM32F405OE&quot;</span>&gt;</div>
<div class="line"> &lt;!-- <span class="keywordflow">finally</span>, <span class="keyword">this</span> is the <span class="keywordflow">default</span> <span class="keywordflow">for</span> the device --&gt;</div>
<div class="line"> &lt;algorithm name=<span class="stringliteral">&quot;Flash/STM32F2xx_2048.flm&quot;</span> start=0x08000000 size=0x40000 <span class="keywordflow">default</span>=<span class="stringliteral">&quot;1&quot;</span> style=<span class="stringliteral">&quot;Keil&quot;</span>/&gt;</div>
<div class="line"> &lt;/device&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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="cp_SWComponents.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 toolchains 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 <span class="XML-Token">Keil</span>. 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>&#160;</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">&lt;family Dfamily=<span class="stringliteral">&quot;STM32F4&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;book name=<span class="stringliteral">&quot;Documents/STM32F40x_DS.PDF&quot;</span> title=<span class="stringliteral">&quot;STM32F40x Data Sheet&quot;</span>/&gt; &lt;!-- valid <span class="keywordflow">for</span> all devices of the family --&gt;</div>
<div class="line"></div>
<div class="line"> &lt;subFamily DsubFamily=<span class="stringliteral">&quot;STM32F405&quot;</span>&gt;</div>
<div class="line"> &lt;book name=<span class="stringliteral">&quot;Documents/STM32F4xx_RM.pdf&quot;</span> title=<span class="stringliteral">&quot;STM32F4 Series Reference Manual&quot;</span>/&gt; &lt;!-- valid <span class="keywordflow">for</span> all devices of a subFamily --&gt;</div>
<div class="line"></div>
<div class="line"> &lt;device Dname=<span class="stringliteral">&quot;STM32F405OE&quot;</span>&gt;</div>
<div class="line"> &lt;book name=<span class="stringliteral">&quot;Documents/STM32F405OE_DS.PDF&quot;</span> title=<span class="stringliteral">&quot;STM32F405OE - Data Sheet&quot;</span>/&gt; &lt;!-- valid <span class="keywordflow">for</span> <span class="keyword">this</span> device; Inherits all above --&gt;</div>
<div class="line"> &lt;/device&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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>&#160;</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>
<li>The name of the header file should be exported by the IDE to the <a class="el" href="pdsc_components_pg.html#RTE_Components_h">RTE_Components.h</a> file using the #define CMSIS_device_header.</li>
</ul>
</dd></dl>
<p><b>Example</b> </p>
<div class="fragment"><div class="line">&lt;family Dfamily=<span class="stringliteral">&quot;STM32F4&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;compile header=<span class="stringliteral">&quot;Device/Include/stm32f4xx.h&quot;</span>/&gt;</div>
<div class="line"></div>
<div class="line"> &lt;subFamily DsubFamily=<span class="stringliteral">&quot;STM32F407&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;compile header=<span class="stringliteral">&quot;Device/Include/stm32f4xx.h&quot;</span> define=<span class="stringliteral">&quot;STM32F40XX&quot;</span>/&gt;</div>
<div class="line"></div>
<div class="line"> &lt;device Dname=<span class="stringliteral">&quot;STM32F407IG&quot;</span>&gt;</div>
<div class="line"> &lt;compile header=<span class="stringliteral">&quot;Device/Include/stm32f4xx.h&quot;</span> define=<span class="stringliteral">&quot;STM32F407IG&quot;</span>/&gt;</div>
<div class="line"> &lt;/device&gt;</div>
<div class="line"> &lt;/subFamily&gt;</div>
<div class="line">&lt;/family&gt;</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>&#160;</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">&lt;package&gt;</div>
<div class="line"> &lt;devices&gt;</div>
<div class="line"> &lt;family Dfamily=<span class="stringliteral">&quot;STM32F2&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;description&gt;</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"> &lt;/description&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;/family&gt;</div>
<div class="line"> &lt;/devices&gt;</div>
<div class="line">&lt;/package&gt;</div>
</div><!-- fragment --><p>&#160;</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>&#160;</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">&lt;package&gt;</div>
<div class="line"> &lt;devices&gt;</div>
<div class="line"> &lt;family Dfamily=<span class="stringliteral">&quot;MySeries&quot;</span> Dvendor=<span class="stringliteral">&quot;Generic:5&quot;</span>&gt;</div>
<div class="line"> ... </div>
<div class="line"> &lt;environment name=<span class="stringliteral">&quot;MyConfigTool&quot;</span>&gt;</div>
<div class="line"> &lt;file&gt;MyConfigFile.cfg&lt;/file&gt;</div>
<div class="line"> &lt;control&gt;MyControlString&lt;/control&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/environment&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/family&gt;</div>
<div class="line"> &lt;/devices&gt;</div>
<div class="line">&lt;/package&gt;</div>
</div><!-- fragment --><div class="fragment"><div class="line">&lt;package&gt;</div>
<div class="line"> &lt;devices&gt;</div>
<div class="line"> &lt;family Dfamily=<span class="stringliteral">&quot;XMC1000 Series&quot;</span> Dvendor=<span class="stringliteral">&quot;Infineon:7&quot;</span>&gt;</div>
<div class="line"> ... </div>
<div class="line"> &lt;environment name=<span class="stringliteral">&quot;uv&quot;</span> Pname=<span class="stringliteral">&quot;M0&quot;</span>&gt;</div>
<div class="line"> &lt;CMisc&gt;--C99&lt;/CMisc&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/environment&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/family&gt;</div>
<div class="line"> &lt;/devices&gt;</div>
<div class="line">&lt;/package&gt;</div>
</div><!-- fragment --><p><br/>
</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 (for example, "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: &lt;CMisc&gt;, &lt;AMisc&gt;, &lt;LMisc&gt;, &lt;preBuild1&gt;, &lt;preBuild2&gt;, &lt;preRun1&gt;, &lt;preRun2&gt;, &lt;postBuild1&gt;, &lt;postBuild2&gt;, &lt;postRun1&gt;, &lt;postRun&gt;. </td><td>xs:anyAttribute </td><td>0..* </td></tr>
</table>
<p>&#160;</p>
<hr/>
<h1><a class="anchor" id="element_feature"></a>
/package/devices/family/.../feature</h1>
<p>This element specifies peripherals that devices can have. This can be used on <b>web</b> <b>sites</b> for the display of device features.</p>
<p>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">&lt;package&gt;</div>
<div class="line"> &lt;devices&gt;</div>
<div class="line"> &lt;family Dfamily=<span class="stringliteral">&quot;STM32F4&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;!-- Features that are in common to <span class="keyword">this</span> device family. --&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;TimerOther&quot;</span> n=<span class="stringliteral">&quot;1&quot;</span> name=<span class="stringliteral">&quot;Independent Watchdog Timer&quot;</span>/&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;TimerOther&quot;</span> n=<span class="stringliteral">&quot;1&quot;</span> name=<span class="stringliteral">&quot;Window Watchdog Timer&quot;</span>/&gt; &lt;!-- The same feature type can be specified multiple times --&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;Other&quot;</span> n=<span class="stringliteral">&quot;1&quot;</span> name=<span class="stringliteral">&quot;Temperature Sensor&quot;</span>/&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;CoreOther&quot;</span> n=<span class="stringliteral">&quot;1&quot;</span> name=<span class="stringliteral">&quot;96-bit Unique Identifier&quot;</span>/&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;CoreOther&quot;</span> n=<span class="stringliteral">&quot;1&quot;</span> name=<span class="stringliteral">&quot;CRC Calculation Unit&quot;</span>/&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;DMA&quot;</span> n=<span class="stringliteral">&quot;16&quot;</span> name=<span class="stringliteral">&quot;General Purpose DMA with Centralized FIFO and Burst Support&quot;</span>/&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;PowerOther&quot;</span> n=<span class="stringliteral">&quot;1&quot;</span> name=<span class="stringliteral">&quot;POR, PDR, PVD, and BOR&quot;</span>/&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;XTAL&quot;</span> n=<span class="stringliteral">&quot;4000000&quot;</span> m=<span class="stringliteral">&quot;26000000&quot;</span> name=<span class="stringliteral">&quot;Crystal Oscillator&quot;</span>/&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;IntRC&quot;</span> n=<span class="stringliteral">&quot;16000000&quot;</span> name=<span class="stringliteral">&quot;Internal Factory-Trimmed RC&quot;</span>/&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;IntRC&quot;</span> n=<span class="stringliteral">&quot;32000&quot;</span> name=<span class="stringliteral">&quot;Internal RC with Calibration&quot;</span>/&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;RTC&quot;</span> n=<span class="stringliteral">&quot;32000&quot;</span> name=<span class="stringliteral">&quot;RTC with 32 kHz calibrated Oscillator and Battery Backup&quot;</span>/&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;PowerMode&quot;</span> n=<span class="stringliteral">&quot;3&quot;</span> name=<span class="stringliteral">&quot;Run, Stop, Standby&quot;</span>/&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;Temp&quot;</span> n=<span class="stringliteral">&quot;-40&quot;</span> m=<span class="stringliteral">&quot;85&quot;</span>/&gt; </div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;Temp&quot;</span> n=<span class="stringliteral">&quot;-40&quot;</span> m=<span class="stringliteral">&quot;105&quot;</span>/&gt; </div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;Timer&quot;</span> n=<span class="stringliteral">&quot;4&quot;</span> m=<span class="stringliteral">&quot;16&quot;</span> name=<span class="stringliteral">&quot;General Purpose Timer&quot;</span>/&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;subFamily DsubFamily=<span class="stringliteral">&quot;STM32F407&quot;</span>&gt;</div>
<div class="line"> &lt;!-- Features that are in common to <span class="keyword">this</span> subFamily. --&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;IOs&quot;</span> n=<span class="stringliteral">&quot;36&quot;</span>/&gt; &lt;!-- Adds <span class="keyword">new</span> feature to subFamily --&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;Timer&quot;</span> n=<span class="stringliteral">&quot;7&quot;</span> m=<span class="stringliteral">&quot;32&quot;</span> name=<span class="stringliteral">&quot;General Purpose Timer&quot;</span>/&gt; &lt;!-- Adds to settings from &lt;family&gt; --&gt;</div>
<div class="line"></div>
<div class="line"> </div>
<div class="line"> &lt;device Dname=<span class="stringliteral">&quot;STM32F407IE&quot;</span>&gt;</div>
<div class="line"> &lt;!-- Feature specific to <span class="keyword">this</span> device. All above features are inherited. --&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;QFP&quot;</span> n=<span class="stringliteral">&quot;176&quot;</span> name=<span class="stringliteral">&quot;LQFP 176 24x24x1.4&quot;</span>/&gt;</div>
<div class="line"> &lt;/device&gt;</div>
<div class="line"> &lt;/subFamily&gt;</div>
<div class="line"> &lt;/family&gt;</div>
<div class="line"> &lt;/devices&gt;</div>
<div class="line">&lt;/package&gt;</div>
</div><!-- fragment --><p><br/>
</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><br/>
</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>&lt;feature type="NVIC" n="120" name="NVIC"/&gt;</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>&lt;feature type="DMA" n="16" name="High-Speed DMA"/&gt;</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>&lt;feature type="Crypto" n="128.256" name="HW accelerated AES Encryption Engine"/&gt;</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>&lt;feature type="RNG" name="True Random Number Generator"/&gt;</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>&lt;feature type="CoreOther" n=1 name="96-bit Unique Identifier"/&gt;</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>&lt;feature type="Memory" n="128" name="EEPROM"/&gt;</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>&lt;feature type="MemoryOther" n="1" name="1 kB MRAM"/&gt;</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>&lt;feature type="ExtBus" n="16" name="External Bus Interface for SRAM Communication"/&gt;</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>&lt;feature type="XTAL" n="4000000" m="25000000" name="External Crystal Oscillator"/&gt;</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>&lt;feature type="IntRC" n="16000000" name="Internal RC Oscillator with +/- 1% accuracy"/&gt;</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>&lt;feature type="PLL" n="3" name="Internal PLL"/&gt;</td><td>3 Internal PLL </td></tr>
<tr>
<td>RTC</td><td>RTC Frequency</td><td>N/A</td><td>RTC</td><td>&lt;feature type="RTC" n="32000" name="Internal RTC"/&gt;</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>&lt;feature type="ClockOther" name="My special clock feature"/&gt;</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>&lt;feature type="Mode" n="3" name="Run, Sleep, Deep-Sleep"/&gt;</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>&lt;feature type="VCC" n="1.8" m="3.6"/&gt;</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>&lt;feature type="Consumption" n="0.00004" m="0.002" name="Ultra-Low Power Consumption"/&gt;</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>&lt;feature type="PowerOther" n="1" name="POR"/&gt;</td><td>1 x POR </td></tr>
<tr>
<td>BGA</td><td>Number of Balls</td><td>N/A</td><td>BGA</td><td>&lt;feature type="BGA" n="256" name="Plastic Ball Grid Array"/&gt;</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>&lt;feature type="CSP" n="28" name="Wafer-Level Chip-Scale Package"/&gt;</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>&lt;feature type="PLCC" n="20" name="PLCC Package"/&gt;</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>&lt;feature type="QFN" n="33" name="QFN Package"/&gt;</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>&lt;feature type="QFP" n="128" name="Low-Profile QFP Package"/&gt;</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>&lt;feature type="SOP" n="16" name="SSOP Package"/&gt;</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>&lt;feature type="DIP" n="16" name="Dual In-Line Package"/&gt;</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>&lt;feature type="PackageOther" n="44" name="My other Package"/&gt;</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>&lt;feature type="IOs" n="112" name="General Purpose I/Os, 5V tolerant"/&gt;</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>&lt;feature type="ExtInt" n="12"/&gt;</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>&lt;feature type="Temp" n="-40" m="105" name="Extended Operating Temperature Range"/&gt;</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>&lt;feature type="ADC" n="5" m="12" name="High-Performance ADC"/&gt;</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>&lt;feature type="DAC" n="2" m="10"/&gt;</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>&lt;feature type="TempSens" n="1"/&gt;</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>&lt;feature type="AnalogOther" n="1" name="My Analog"/&gt;</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>&lt;feature type="Timer" n="2" m="32" name="Timer Module with Quadrature Encoding"/&gt;</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>&lt;feature type="PWM" n="2" m="16" name="Pulse Width Modulation"/&gt;</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>&lt;feature type="WDT" n="1"/&gt;</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>&lt;feature type="TimerOther" n="1" name="Quadrature En-/Decoder"/&gt;</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>&lt;feature type="MPSerial" n="4" name="Multi-Purpose Serial Interface Module: I2C, I2S, SPI, UART"/&gt;</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>&lt;feature type="CAN" n="2" name="CAN 2.0b Controller"/&gt;</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>&lt;feature type="ETH" n="1" m="10000000" name="Integrated Ethernet MAC with PHY"/&gt;</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>&lt;feature type="I2C" n="2"name="Low-Power I2C"/&gt;</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>&lt;feature type="I2S" n="3"/&gt;</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>&lt;feature type="LIN" n="4"/&gt;</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>&lt;feature type="SDIO" n="1" m="4" name="SDIO Interface"/&gt;</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>&lt;feature type="SPI" n="2" m="20000000" name="SPI Interface"/&gt;</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>&lt;feature type="UART" n="4" m="3000000" name="High-Speed UART Interface"/&gt;</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>&lt;feature type="USART" n="2" m="1000000" name="High-Speed USART Interface"/&gt;</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>&lt;feature type="USBD" n="2" name="Full-Speed USB Device"/&gt;</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>&lt;feature type="USBH" n="2" name="High-Speed USB Host"/&gt;</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>&lt;feature type="USBOTG" n="1" name="High-Speed USB OTG with PHY"/&gt;</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>&lt;feature type="ComOther" n="1" name="ZigBee"/&gt;</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>&lt;feature type="Camera" n="1" m="8" name="Digital Camera Interface"/&gt;</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>&lt;feature type="GLCD" n="1" m="320.240" name="TFT LCD Controller"/&gt;</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>&lt;feature type="LCD" n="1" m="16.40" name="Segment LCD Controller"/&gt;</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>&lt;feature type="Touch" n="10" name="Capacitive Touch Inputs"/&gt;</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>&lt;feature type="Other" n="2" name="My other Interface"/&gt;</td><td>2 x My other Interface </td></tr>
</table>
<p>&#160;</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">&lt;/package&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;devices&gt;</div>
<div class="line"> &lt;family Dfamily=<span class="stringliteral">&quot;STM32F4&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>&gt;</div>
<div class="line"> &lt;memory name=<span class="stringliteral">&quot;SRAM&quot;</span> access=<span class="stringliteral">&quot;rwx&quot;</span> start=<span class="stringliteral">&quot;0x20000000&quot;</span> size=<span class="stringliteral">&quot;0x20000&quot;</span> <span class="keywordflow">default</span>=<span class="stringliteral">&quot;1&quot;</span>/&gt;</div>
<div class="line"></div>
<div class="line"> &lt;subFamily DsubFamily=<span class="stringliteral">&quot;STM32F407&quot;</span>&gt;</div>
<div class="line"> &lt;debug __dp=<span class="stringliteral">&quot;0&quot;</span> __ap=<span class="stringliteral">&quot;0&quot;</span> svd=<span class="stringliteral">&quot;SVD/STM32F40x.svd&quot;</span>/&gt;</div>
<div class="line"> &lt;memory name=<span class="stringliteral">&quot;SRAM1&quot;</span> access=<span class="stringliteral">&quot;rwx&quot;</span> start=<span class="stringliteral">&quot;0x20020000&quot;</span> size=<span class="stringliteral">&quot;0x20000&quot;</span> <span class="keywordflow">default</span>=<span class="stringliteral">&quot;1&quot;</span>/&gt;</div>
<div class="line"> &lt;memory name=<span class="stringliteral">&quot;SRAM2&quot;</span> access=<span class="stringliteral">&quot;rwx&quot;</span> start=<span class="stringliteral">&quot;0x10000000&quot;</span> size=<span class="stringliteral">&quot;0x10000&quot;</span> <span class="keywordflow">default</span>=<span class="stringliteral">&quot;1&quot;</span>/&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;device Dname=<span class="stringliteral">&quot;STM32F407IE&quot;</span>&gt;</div>
<div class="line"> &lt;memory name=<span class="stringliteral">&quot;Flash&quot;</span> access=<span class="stringliteral">&quot;rx&quot;</span> start=<span class="stringliteral">&quot;0x08000000&quot;</span> size=<span class="stringliteral">&quot;0x80000&quot;</span> startup=<span class="stringliteral">&quot;1&quot;</span> <span class="keywordflow">default</span>=<span class="stringliteral">&quot;1&quot;</span>/&gt;</div>
<div class="line"> &lt;/device&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;/subFamily&gt;</div>
<div class="line"> &lt;/family&gt;</div>
<div class="line"> &lt;/devices&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/package&gt;</div>
</div><!-- fragment --><p><br/>
</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 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, for example, 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><br/>
<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>&#160;</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. The values can be used in:</p>
<ul>
<li><a class="el" href="pdsc_family_pg.html#element_memory">/package/devices/family/.../memory</a></li>
<li><a class="el" href="cpdsc_pg.html#element_target_memory">/package/create/project/target/memory</a></li>
</ul>
<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>&#160;</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>&lt;Pname&gt;</b>. If the information is relevant to all processors, no processor must be specified in <b>&lt;Pname&gt;</b>.</p>
<p><b>Example</b> <b>1</b> </p>
<div class="fragment"><div class="line">&lt;package&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;devices&gt;</div>
<div class="line"> &lt;family Dfamily=<span class="stringliteral">&quot;STM32F4&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>&gt;</div>
<div class="line"> &lt;processor Dcore=<span class="stringliteral">&quot;Cortex-M4&quot;</span> DcoreVersion=<span class="stringliteral">&quot;r0p1&quot;</span></div>
<div class="line"> Dfpu=<span class="stringliteral">&quot;FPU&quot;</span> Dmpu=<span class="stringliteral">&quot;MPU&quot;</span> Dendian=<span class="stringliteral">&quot;Little-endian&quot;</span> Dclock=<span class="stringliteral">&quot;168000000&quot;</span>/&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/family&gt;</div>
<div class="line"> &lt;/devices&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/package&gt;</div>
</div><!-- fragment --><p><b>Example</b> <b>2</b> </p>
<div class="fragment"><div class="line">&lt;device name=<span class="stringliteral">&quot;MCIMX7D&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;processor Dcore=<span class="stringliteral">&quot;Cortex-A7&quot;</span> DcoreVersion=<span class="stringliteral">&quot;r0p5&quot;</span> Pname=<span class="stringliteral">&quot;Cortex-A7&quot;</span> Punits=<span class="stringliteral">&quot;2&quot;</span> /&gt;</div>
<div class="line"> &lt;processor Dcore=<span class="stringliteral">&quot;Cortex-M4&quot;</span> DcoreVersion=<span class="stringliteral">&quot;r0p1&quot;</span> Pname=<span class="stringliteral">&quot;Cortex-M4&quot;</span>/&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;debug Pname=<span class="stringliteral">&quot;Cortex-A7&quot;</span> Punit=<span class="stringliteral">&quot;0&quot;</span> svd=<span class="stringliteral">&quot;SVD/iMX7D_A7.svd&quot;</span> __dp=<span class="stringliteral">&quot;0&quot;</span> __ap=<span class="stringliteral">&quot;1&quot;</span> address=<span class="stringliteral">&quot;0x80070000&quot;</span>/&gt; </div>
<div class="line"> &lt;debug Pname=<span class="stringliteral">&quot;Cortex-A7&quot;</span> Punit=<span class="stringliteral">&quot;1&quot;</span> svd=<span class="stringliteral">&quot;SVD/iMX7D_A7.svd&quot;</span> __dp=<span class="stringliteral">&quot;0&quot;</span> __ap=<span class="stringliteral">&quot;1&quot;</span> address=<span class="stringliteral">&quot;0x80072000&quot;</span>/&gt;</div>
<div class="line"> &lt;debug Pname=<span class="stringliteral">&quot;Cortex-M4&quot;</span> svd=<span class="stringliteral">&quot;SVD/iMX7D_M4.svd&quot;</span> __dp=<span class="stringliteral">&quot;0&quot;</span> __ap=<span class="stringliteral">&quot;4&quot;</span>/&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/device&gt;</div>
</div><!-- fragment --><p>&#160;</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>Punits </td><td>Specifies the number of processor units in a symmetric multi-processor core (MPCore). Defaults to single-core CPU (<span class="XML-Token">1</span>) when left empty. </td><td>InstancesType </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>Dtz </td><td>Specifies whether an ARMv8M based device implements TrustZone. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DtzEnum">Device TZ</a>. </td><td>DtzEnum </td><td>optional </td></tr>
<tr>
<td>Ddsp </td><td>Specifies whether an ARMv8M based device supports the DSP instructions set. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DdspEnum">Device DSP</a>. </td><td>DdspEnum </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>&#160;</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">ABOV Semiconductor:126 </td><td>ABOV Semiconductor </td><td><a href="http://www.abov.co.kr/en/">http://www.abov.co.kr/en/</a> </td></tr>
<tr>
<td class="XML-Token">Active-Semi:140 </td><td>Active-Semi </td><td><a href="http://www.active-semi.com">http://www.active-semi.com</a> </td></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">Elmos Semiconductor AG:138 </td><td>Elmos Semiconductor AG </td><td><a href="http://www.elmos.com">http://www.elmos.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">Linear Technolgy:136 </td><td>Linear Technolgy </td><td><a href="http://www.linear.com/">http://www.linear.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">MediaTek:129 </td><td>MediaTek </td><td><a href="http://www.mediatek.com">http://www.mediatek.com</a> </td></tr>
<tr>
<td class="XML-Token">MegaChips:128 </td><td>MegaChips </td><td><a href="http://www.megachips.com">http://www.megachips.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">MindMotion:132 </td><td>MindMotion </td><td><a href="http://www.mindmotion.com.cn">http://www.mindmotion.com.cn</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">Panasonic:131 </td><td>Panasonic </td><td><a href="http://www.panasonic.com/industrial">http://www.panasonic.com/industrial</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">Silergy Corp:139 </td><td>Silergy Corporation </td><td><a href="http://silergy.com/">http://silergy.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>
<tr>
<td class="XML-Token">Xinnova:135 </td><td>Xinnova Technology </td><td><a href="http://www.xinnovatech.com/en">http://www.xinnovatech.com/en</a> </td></tr>
<tr>
<td class="XML-Token">Zilog:89 </td><td>Zilog </td><td><a href="https://zilog.com/">https://zilog.com/</a> </td></tr>
</table>
<p>&#160;</p>
<p><a class="anchor" id="AlgorithmStyleEnum"></a><b>Table: Algorithm Styles</b></p>
<p>The table lists the predefined Flash algorithm style. These values can be used in:</p>
<ul>
<li><a class="el" href="pdsc_family_pg.html#element_algorithm">/package/devices/family/.../algorithm</a></li>
<li><a class="el" href="cpdsc_pg.html#element_target_algorithm">/package/create/project/target/algorithm</a></li>
</ul>
<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>&#160;</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">Cortex-M23 </td><td><a href="http://www.arm.com/products/processors/cortex-m/cortex-m23-processor.php" target="_blank">ARM Cortex-M23</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-M33 </td><td><a href="http://www.arm.com/products/processors/cortex-m/cortex-m33-processor.php" target="_blank">ARM Cortex-M33</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">ARMV8MBL </td><td>Processor <a href="http://www.arm.com/products/processors/instruction-set-architectures/armv8-m-architecture.php" target="_blank">ARMV8MBL</a> compliant with the ARMv8-M Baseline Architecture. </td></tr>
<tr>
<td class="XML-Token">ARMV8MML </td><td>Processor <a href="http://www.arm.com/products/processors/instruction-set-architectures/armv8-m-architecture.php" target="_blank">ARMV8MML</a> compliant with the ARMv8-M Mainline Architecture. </td></tr>
<tr>
<td class="XML-Token">Cortex-R4 </td><td><a href="http://www.arm.com/products/processors/cortex-r/cortex-r4.php" target="_blank">ARM Cortex-R4</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-R5 </td><td><a href="http://www.arm.com/products/processors/cortex-r/cortex-r5.php" target="_blank">ARM Cortex-R5</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-R7 </td><td><a href="http://www.arm.com/products/processors/cortex-r/cortex-r7.php" target="_blank">ARM Cortex-R7</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-R8 </td><td><a href="http://www.arm.com/products/processors/cortex-r/cortex-r8.php" target="_blank">ARM Cortex-R8</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A5 </td><td><a href="http://www.arm.com/products/processors/cortex-a/cortex-a5.php" target="_blank">ARM Cortex-A5</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A7 </td><td><a href="http://www.arm.com/products/processors/cortex-a/cortex-a7.php" target="_blank">ARM Cortex-A7</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A8 </td><td><a href="http://www.arm.com/products/processors/cortex-a/cortex-a8.php" target="_blank">ARM Cortex-A8</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A9 </td><td><a href="http://www.arm.com/products/processors/cortex-a/cortex-a9.php" target="_blank">ARM Cortex-A9</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A15 </td><td><a href="http://www.arm.com/products/processors/cortex-a/cortex-a15.php" target="_blank">ARM Cortex-A15</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A17 </td><td><a href="http://www.arm.com/products/processors/cortex-a/cortex-a17.php" target="_blank">ARM Cortex-A17</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A32 </td><td><a href="http://www.arm.com/products/processors/cortex-a/cortex-a32.php" target="_blank">ARM Cortex-A32</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A35 </td><td><a href="http://www.arm.com/products/processors/cortex-a/cortex-a35.php" target="_blank">ARM Cortex-A35</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A53 </td><td><a href="http://www.arm.com/products/processors/cortex-a/cortex-a53.php" target="_blank">ARM Cortex-A53</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A57 </td><td><a href="http://www.arm.com/products/processors/cortex-a/cortex-a57.php" target="_blank">ARM Cortex-A57</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A72 </td><td><a href="http://www.arm.com/products/processors/cortex-a/cortex-a72.php" target="_blank">ARM Cortex-A72</a> processor based device </td></tr>
<tr>
<td class="XML-Token">Cortex-A73 </td><td><a href="http://www.arm.com/products/processors/cortex-a/cortex-a73.php" target="_blank">ARM Cortex-A73</a> processor based device </td></tr>
<tr>
<td class="XML-Token">* </td><td>Device based on any processor </td></tr>
</table>
<p>&#160;</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>
<li><a class="el" href="cpdsc_pg.html#cpdsc_target_pg">/package/create/project/target</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>&#160;</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>
<li><a class="el" href="cpdsc_pg.html#cpdsc_target_pg">/package/create/project/target</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>&#160;</p>
<p><a class="anchor" id="DtzEnum"></a><b>Table: Device Trust Zone </b></p>
<p>The table shows predefined values that identify whether a CPU implements TrustZone(TZ). 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: DtzEnum">
<tr>
<th>Dtz= </th><th>Description </th></tr>
<tr>
<td class="XML-Token">TZ </td><td>TrustZone is present </td></tr>
<tr>
<td class="XML-Token">NO_TZ </td><td>No TrustZone is present </td></tr>
</table>
<p>&#160;</p>
<p><a class="anchor" id="DsecureEnum"></a><b>Table: Software Model Secure </b></p>
<p>The table shows predefined values that identify whether an application will run in secure mode. 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: DsecureEnum">
<tr>
<th>Dsecure= </th><th>Description </th></tr>
<tr>
<td class="XML-Token">Secure </td><td>Application is built to run in secure mode </td></tr>
<tr>
<td class="XML-Token">Non-secure </td><td>Application is built to run in non-secure mode </td></tr>
</table>
<p>&#160;</p>
<p><a class="anchor" id="DdspEnum"></a><b>Table: Device implements DSP Instructions</b></p>
<p>The table shows predefined values that identify whether a CPU implements DSP instructions (DSP). 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: DdspEnum">
<tr>
<th>Ddsp= </th><th>Description </th></tr>
<tr>
<td class="XML-Token">DSP </td><td>DSP instructions supported </td></tr>
<tr>
<td class="XML-Token">NO_DSP </td><td>No DSP instructions supported </td></tr>
</table>
<p>&#160;</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>
<li><a class="el" href="cpdsc_pg.html#cpdsc_target_pg">/package/create/project/target</a></li>
<li><a class="el" href="cpdsc_pg.html#element_target_algorithm">/package/create/project/target/algorithm</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>&#160;</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">&lt;family Dfamily=<span class="stringliteral">&quot;LPC4300 Series&quot;</span> Dvendor=<span class="stringliteral">&quot;NXP:11&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;debugconfig <span class="keywordflow">default</span>=<span class="stringliteral">&quot;jtag&quot;</span> clock=<span class="stringliteral">&quot;10000000&quot;</span> swj=<span class="stringliteral">&quot;1&quot;</span> sdf=<span class="stringliteral">&quot;Debug/SDF/lpc4300.sdf&quot;</span>/&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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>
<tr>
<td>sdf </td><td>This attribute specifies the filename and path of the system description file (SFD). The system description file contains information about CoreSight components, there versions and how they are interconnected and hooked to debug and access ports. If not specified an autodetection needs to be initiated by the debugger at connection time. </td><td>xs:string </td><td>optional </td></tr>
</table>
<p>&#160;</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. The values can be used in</p>
<ul>
<li><a class="el" href="pdsc_family_pg.html#element_debugconfig">/package/devices/family/.../debugconfig</a></li>
<li><a class="el" href="cpdsc_pg.html#element_debugProbe">/package/create/project/target/debugProbe</a></li>
</ul>
<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>&#160;</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 &quot;uservar&quot; and initialize to &quot;value&quot;</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">&lt;family Dfamily=<span class="stringliteral">&quot;EFM32WG Series&quot;</span> Dvendor=<span class="stringliteral">&quot;Energy Micro:97&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;debugvars configfile=<span class="stringliteral">&quot;Debug/EFM32WGxxx.dbgconf&quot;</span> version=<span class="stringliteral">&quot;1.0&quot;</span>&gt;</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"> &lt;/debugvars&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;sequences&gt;</div>
<div class="line"> &lt;sequence name=<span class="stringliteral">&quot;TraceStart&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;block <span class="keywordflow">if</span>=<span class="stringliteral">&quot;__TPIU_pinlocation == 2&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;!-- Configure device to use pins as defined <span class="keywordflow">for</span> TPIU pin location 2 --&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/block&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/sequence&gt;</div>
<div class="line"> &lt;/sequences&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;debug __dp=<span class="stringliteral">&quot;0&quot;</span> __ap=<span class="stringliteral">&quot;0&quot;</span>/&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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="configWizard.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>&#160;</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">// &lt;&lt;&lt; Use Configuration Wizard in Context Menu &gt;&gt;&gt;</span></div>
<div class="line"><span class="comment">// &lt;h&gt;Trace Pin Setup</span></div>
<div class="line"> <span class="comment">// &lt;o&gt; TPIU Pin Location</span></div>
<div class="line"><span class="comment">// &lt;0=&gt; Pin Location 0</span></div>
<div class="line"><span class="comment">// &lt;1=&gt; Pin Location 1</span></div>
<div class="line"><span class="comment">// &lt;2=&gt; Pin Location 2</span></div>
<div class="line"><span class="comment">// &lt;3=&gt; Pin Location 3</span></div>
<div class="line"><span class="comment">// &lt;i&gt; Select TPIU pin location for your board configuration:</span></div>
<div class="line"><span class="comment">// &lt;i&gt; - Pin Location 0 (TRACECLK: PD7, TRACEDATA0: PD6, TRACEDATA1: PD3, TRACEDATA2: PD4, TRACEDATA3: PD5)</span></div>
<div class="line"><span class="comment">// &lt;i&gt; - Pin Location 1 (TRACECLK: PF8, TRACEDATA0: PF9, TRACEDATA1: PD13, TRACEDATA2: PB15, TRACEDATA3: PF3)</span></div>
<div class="line"><span class="comment">// &lt;i&gt; - Pin Location 2 (TRACECLK: PC6, TRACEDATA0: PC7, TRACEDATA1: PD3, TRACEDATA2: PD4, TRACEDATA3: PD5)</span></div>
<div class="line"><span class="comment">// &lt;i&gt; - Pin Location 3 (TRACECLK: PA6, TRACEDATA0: PA2, TRACEDATA1: PA3, TRACEDATA2: PA4, TRACEDATA3: PA5)</span></div>
<div class="line"><span class="comment">// &lt;i&gt; Default: Pin Location 0</span></div>
<div class="line">__TPIU_pinlocation = 0;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// &lt;o&gt; SWO Pin Location</span></div>
<div class="line"><span class="comment">// &lt;0=&gt; Pin Location 0</span></div>
<div class="line"><span class="comment">// &lt;1=&gt; Pin Location 1</span></div>
<div class="line"><span class="comment">// &lt;2=&gt; Pin Location 2</span></div>
<div class="line"><span class="comment">// &lt;3=&gt; Pin Location 3</span></div>
<div class="line"><span class="comment">// &lt;i&gt; Select SWO pin location for your board configuration:</span></div>
<div class="line"><span class="comment">// &lt;i&gt; - Pin Location 0 (SWO: PF2)</span></div>
<div class="line"><span class="comment">// &lt;i&gt; - Pin Location 1 (SWO: PC15)</span></div>
<div class="line"><span class="comment">// &lt;i&gt; - Pin Location 2 (SWO: PD1)</span></div>
<div class="line"><span class="comment">// &lt;i&gt; - Pin Location 3 (SWO: PD2)</span></div>
<div class="line"><span class="comment">// &lt;i&gt; Default: Pin Location 0</span></div>
<div class="line">__SWO_pinlocation = 0;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// &lt;/h&gt;</span></div>
<div class="line"><span class="comment">// &lt;&lt;&lt; end of configuration section &gt;&gt;&gt;</span></div>
</div><!-- fragment --><p>&#160;</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 on 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 on 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>&#160;</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.</p>
<p><b>debugport</b> elements are required for targets with multiple debug ports. These elements can be omitted for devices with a single debug port. If no <b>debugport</b> element exists, then 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">&lt;family Dfamily=<span class="stringliteral">&quot;LPC4300 Series&quot;</span> Dvendor=<span class="stringliteral">&quot;NXP:11&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;debugconfig <span class="keywordflow">default</span>=<span class="stringliteral">&quot;jtag&quot;</span> clock=<span class="stringliteral">&quot;10000000&quot;</span> swj=<span class="stringliteral">&quot;1&quot;</span>/&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;debugport __dp=<span class="stringliteral">&quot;0&quot;</span>&gt;</div>
<div class="line"> &lt;jtag tapindex=<span class="stringliteral">&quot;0&quot;</span>/&gt;</div>
<div class="line"> &lt;swd/&gt;</div>
<div class="line"> &lt;/debugport&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;debugport __dp=<span class="stringliteral">&quot;1&quot;</span>&gt;</div>
<div class="line"> &lt;jtag tapindex=<span class="stringliteral">&quot;1&quot;</span>/&gt; </div>
<div class="line"> &lt;/debugport&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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&#160;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>&#160;</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">&lt;family Dfamily=<span class="stringliteral">&quot;STM32F4&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;debugconfig <span class="keywordflow">default</span>=<span class="stringliteral">&quot;swd&quot;</span> clock=<span class="stringliteral">&quot;10000000&quot;</span> swj=<span class="stringliteral">&quot;1&quot;</span>/&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;debugport __dp=<span class="stringliteral">&quot;0&quot;</span>&gt;</div>
<div class="line"> &lt;jtag tapindex=<span class="stringliteral">&quot;0&quot;</span> idcode=<span class="stringliteral">&quot;0x4BA00477&quot;</span> irlen=<span class="stringliteral">&quot;4&quot;</span>/&gt;</div>
<div class="line"> &lt;swd idcode=<span class="stringliteral">&quot;0x2BA01477&quot;</span>/&gt;</div>
<div class="line"> &lt;/debugport&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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>&#160;</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">&lt;family Dfamily=<span class="stringliteral">&quot;STM32F4&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;debugconfig <span class="keywordflow">default</span>=<span class="stringliteral">&quot;swd&quot;</span> clock=<span class="stringliteral">&quot;10000000&quot;</span> swj=<span class="stringliteral">&quot;1&quot;</span>/&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;debugport __dp=<span class="stringliteral">&quot;0&quot;</span>&gt;</div>
<div class="line"> &lt;jtag tapindex=<span class="stringliteral">&quot;0&quot;</span> idcode=<span class="stringliteral">&quot;0x4BA00477&quot;</span> irlen=<span class="stringliteral">&quot;4&quot;</span>/&gt;</div>
<div class="line"> &lt;swd idcode=<span class="stringliteral">&quot;0x2BA01477&quot;</span>/&gt;</div>
<div class="line"> &lt;/debugport&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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>&#160;</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">&lt;family Dfamily=<span class="stringliteral">&quot;STM32F4&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;debugconfig <span class="keywordflow">default</span>=<span class="stringliteral">&quot;swd&quot;</span> clock=<span class="stringliteral">&quot;10000000&quot;</span> swj=<span class="stringliteral">&quot;1&quot;</span>/&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;debugport __dp=<span class="stringliteral">&quot;0&quot;</span>&gt;</div>
<div class="line"> &lt;cjtag tapindex=<span class="stringliteral">&quot;0&quot;</span> idcode=<span class="stringliteral">&quot;0x4BA00477&quot;</span> irlen=<span class="stringliteral">&quot;4&quot;</span>/&gt;</div>
<div class="line"> &lt;swd idcode=<span class="stringliteral">&quot;0x2BA01477&quot;</span>/&gt;</div>
<div class="line"> &lt;/debugport&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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>&#160;</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">&lt;family Dfamily=<span class="stringliteral">&quot;LPC4300 Series&quot;</span> Dvendor=<span class="stringliteral">&quot;NXP:11&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;sequences&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;sequence name=<span class="stringliteral">&quot;DebugCoreStart&quot;</span> Pname=<span class="stringliteral">&quot;Cortex-M0&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/sequence&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;sequence name=<span class="stringliteral">&quot;ResetSystem&quot;</span> Pname=<span class="stringliteral">&quot;Cortex-M4&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/sequence&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;sequence name=<span class="stringliteral">&quot;TraceStart&quot;</span> Pname=<span class="stringliteral">&quot;Cortex-M4&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/sequence&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/sequences&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --> <p>&#160;</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&#160;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>&#160;</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_SequenceNameEnum_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_SequenceNameEnum_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">&lt;family Dfamily=<span class="stringliteral">&quot;Generic Family&quot;</span> Dvendor=<span class="stringliteral">&quot;Generic:5&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;sequences&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;sequence name=<span class="stringliteral">&quot;UserSequence&quot;</span>&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;block info=<span class="stringliteral">&quot;Define variables and do debug accesses&quot;</span>&gt;</div>
<div class="line"> __var tpWidth = (__traceout &amp;amp; 0x003F0000) &gt;&gt; 16;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/block&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;control <span class="keywordflow">if</span>=<span class="stringliteral">&quot;__traceout &amp;amp; 0x2&quot;</span> info=<span class="stringliteral">&quot;Parallel Trace Port enabled&quot;</span>&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;block&gt;</div>
<div class="line"> <span class="comment">// Do something generic for parallel trace port trace</span></div>
<div class="line"> ...</div>
<div class="line"> &lt;/block&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;control <span class="keywordflow">if</span>=<span class="stringliteral">&quot;tpWidth == 1&quot;</span> info=<span class="stringliteral">&quot;Configure device for 1-bit TPIU trace.&quot;</span>&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;block&gt;</div>
<div class="line"> <span class="comment">// Do debug accesses</span></div>
<div class="line"> ...</div>
<div class="line"> &lt;/block&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;/control&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;control <span class="keywordflow">if</span>=<span class="stringliteral">&quot;tpWidth == 2&quot;</span> info=<span class="stringliteral">&quot;Configure device for 2-bit TPIU trace.&quot;</span>&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;block&gt;</div>
<div class="line"> <span class="comment">// Do debug accesses</span></div>
<div class="line"> ...</div>
<div class="line"> &lt;/block&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;/control&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;control <span class="keywordflow">if</span>=<span class="stringliteral">&quot;tpWidth == 4&quot;</span> info=<span class="stringliteral">&quot;Configure device for 4-bit TPIU trace.&quot;</span>&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;block&gt;</div>
<div class="line"> <span class="comment">// Do debug accesses</span></div>
<div class="line"> ...</div>
<div class="line"> &lt;/block&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;/control&gt;</div>
<div class="line"></div>
<div class="line"> &lt;/control&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/sequence&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/sequences&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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_SequenceNameEnum_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_SequenceNameEnum_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_SequenceNameEnum_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&#160;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>
<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">&lt;family Dfamily=<span class="stringliteral">&quot;Generic Family&quot;</span> Dvendor=<span class="stringliteral">&quot;Generic:5&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;sequences&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;sequence name=<span class="stringliteral">&quot;UserSequence&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;block info=<span class="stringliteral">&quot;Define variables and do debug accesses&quot;</span>&gt;</div>
<div class="line"> __var doIfBlock = 1;</div>
<div class="line"> __var whileCondition = 1;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/block&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;control <span class="keywordflow">if</span>=<span class="stringliteral">&quot;doIfBlock&quot;</span>&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;block&gt;</div>
<div class="line"> <span class="comment">// Do debug accesses</span></div>
<div class="line"> ...</div>
<div class="line"> &lt;/block&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;/control&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;control <span class="keywordflow">while</span>=<span class="stringliteral">&quot;whileCondition&quot;</span> timeout=<span class="stringliteral">&quot;5000&quot;</span>&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;block&gt;</div>
<div class="line"> <span class="comment">// Execute while &quot;whileCondition&quot; different from &#39;0&#39; with a timeout of 5ms</span></div>
<div class="line"> whileCondition = 0;</div>
<div class="line"> &lt;/block&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;/control&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/sequence&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/sequences&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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_SequenceNameEnum_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_SequenceNameEnum_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&#160;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>&#160;</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_SequenceNameEnum_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">&lt;family Dfamily=<span class="stringliteral">&quot;Generic Family&quot;</span> Dvendor=<span class="stringliteral">&quot;Generic:5&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;sequences&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;sequence name=<span class="stringliteral">&quot;UserSequence&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;block info=<span class="stringliteral">&quot;Define condition variales for later use in block elements.&quot;</span>&gt;</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"> &lt;/block&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/sequence&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/sequences&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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>Within an atomic block a variable must no longer be used as an r-value after a result from a target access has been assigned to it.</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>&#160;</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_SequenceNameEnum_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_SequenceNameEnum_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">&lt;sequence name=<span class="stringliteral">&quot;MySequence&quot;</span>&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;block info=<span class="stringliteral">&quot;Block 1&quot;</span>&gt;</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"> &lt;/block&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;control <span class="keywordflow">if</span>=<span class="stringliteral">&quot;condvar&quot;</span>&gt;</div>
<div class="line"> &lt;block&gt;</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"> &lt;/block&gt;</div>
<div class="line"> &lt;/control&gt;</div>
<div class="line"> </div>
<div class="line"> &lt;block info=<span class="stringliteral">&quot;Block 2&quot;</span>&gt;</div>
<div class="line"> myvar1 = myvar2 + 1; <span class="comment">// Variable myvar1 holds the value &#39;8&#39; 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"> &lt;/block&gt;</div>
<div class="line"> </div>
<div class="line">&lt;/sequence&gt;</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_SequenceNameEnum_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">&amp;</span>, <span class="XML-Token">|</span>, <span class="XML-Token">~</span>, <span class="XML-Token">^</span>, <span class="XML-Token">&gt;&gt;</span>, and <span class="XML-Token">&lt;&lt;</span>.</li>
<li>Comparison-operators such as <span class="XML-Token">==</span>, <span class="XML-Token">!=</span>, <span class="XML-Token">&lt;</span>, <span class="XML-Token">&gt;</span>, <span class="XML-Token">&lt;=</span>, and <span class="XML-Token">&gt;=</span>.</li>
<li>Logic operators such as <span class="XML-Token">!</span>, <span class="XML-Token">&amp;&amp;</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 &lt; 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_SequenceNameEnum_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">&amp;</span>, <span class="XML-Token">&lt;</span>, and <span class="XML-Token">&gt;</span>. Use the corresponding XML entity names instead: <span class="XML-Token">&amp;amp;</span>, <span class="XML-Token">&amp;lt;</span>, and <span class="XML-Token">&amp;gt;</span>.</li>
</ul>
</dd></dl>
<p>&#160;</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, for example, for SWD/JTAG Reset, SWD&lt;-&gt;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>
<tr>
<td style="white-space: nowrap"><pre>QueryValue("message", default)</pre> </td><td><p class="starttd">Query input value from user. The sequence execution stalls until the user has entered a value or canceled the query. This function returns the <b>default</b> value if the user canceled the query or if the debugger runs in a batch mode.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<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 user cancels the query or if the debugger runs in batch mode.</li>
</ul>
<p><b>Return Value:</b><br/>
The queried value.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>Message(type, "format", ...)</pre> </td><td><p class="starttd">Outputs a message to a log window.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>type: Message type. Can be one of:<ul>
<li><span class="XML-Token">0</span> : <b>Info</b>, outputs an informative message.</li>
<li><span class="XML-Token">1</span> : <b>Warning</b>, outputs a warning.</li>
<li><span class="XML-Token">2</span> : <b>Error</b>, outputs an error. Sequence execution aborts.</li>
</ul>
</li>
<li>format: A constant string with the message format. It must not be an expression and it must be enclosed by quotes. The string has the following format:<br/>
<div class="fragment"><div class="line">%[flags][width][.precision]specifier</div>
</div><!-- fragment --><ul>
<li>Specifiers:<ul>
<li><span class="XML-Token">%u</span>: 32-bit unsigned decimal integer.</li>
<li><span class="XML-Token">%llu</span>: 64-bit unsigned decimal integer.</li>
<li><span class="XML-Token">%x</span>: 32-bit unsigned hexadecimal integer, lower case letters.</li>
<li><span class="XML-Token">%llx</span>: 64-bit unsigned hexadecimal integer, lower case letters.</li>
<li><span class="XML-Token">%X</span>: 32-bit unsigned hexadecimal integer, upper case letters.</li>
<li><span class="XML-Token">%llX</span>: 64-bit unsigned hexadecimal integer, upper case letters.</li>
<li><span class="XML-Token">%o</span>: 32-bit unsigned octal integer.</li>
<li><span class="XML-Token">%llo</span>: 64-bit unsigned octal integer.</li>
<li><span class="XML-Token">%b</span>: 32-bit unsigned binary integer.</li>
<li><span class="XML-Token">%llb</span>: 64-bit unsigned binary integer.</li>
<li><span class="XML-Token">%f</span>: Single-precision (32-bit) floating point value.</li>
<li><span class="XML-Token">%Lf</span>: Double-precision (64-bit) floating point value.</li>
<li><span class="XML-Token">%s</span>: Constant character string. Must not be an expression.</li>
<li><span class="XML-Token">%%</span>: Print <span class="XML-Token">%</span> character.</li>
</ul>
</li>
<li>Flags:<ul>
<li><span class="XML-Token">0</span>: Pad the displayed value with zeros instead of spaces if padding is required by the <span class="XML-Token">width</span> option.</li>
</ul>
</li>
<li>Width: Minimum number of displayed characters. If <span class="XML-Token">width</span> is less than the number of characters of the value, then the value is padded with spaces to the left.</li>
<li>.Precision:<ul>
<li><b>Integer</b>: Minimum number of displayed digits. Padded with zeros to the left if the value has less digits than specified with <span class="XML-Token">.precision</span>.</li>
<li><b>Floating Point</b>: Number of displayed digits after decimal point. Defaults to <span class="XML-Token">6</span> if not specified.</li>
<li><b>Constant String</b>: Maximum number of displayed characters.</li>
</ul>
</li>
</ul>
</li>
<li>... : Additional function parameters to replace format string specifiers. Each parameter can be a constant string, or an expression that resolves to an unsigned 64-bit integer. A parameter type must match the corresponding specifier type.</li>
</ul>
<p><b>Return Value:</b><br/>
Always returns <span class="XML-Token">0</span>.</p>
<dl class="section note"><dt>Note</dt><dd>For 32-bit specifiers the <b>Message</b> command must print the lower 32 Bit of a 64 Bit debug access variable.</dd></dl>
</td></tr>
<tr>
<td style="white-space: nowrap"><pre>LoadDebugInfo("file")</pre> </td><td><p class="starttd">Loads DWARF debug information from an application executable.<br/>
<br/>
<b>Parameters:</b><br/>
</p>
<ul>
<li>file: A constant string with the path to the executable. The path must be relative to the root folder of the pack and use the format <b>path/name.extension</b>. It must not be an expression and it must be enclosed by quotes.</li>
</ul>
<p><b>Return Value:</b><br/>
Returns <span class="XML-Token">0</span> after successful debug information load.<br/>
Returns <span class="XML-Token">1</span> if debug information load failed.</p>
<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>&#160;</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> <b>1</b> </p>
<div class="fragment"><div class="line">&lt;family Dfamily=<span class="stringliteral">&quot;LPC4300 Series&quot;</span> Dvendor=<span class="stringliteral">&quot;NXP:11&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;debug Pname=<span class="stringliteral">&quot;Cortex-M4&quot;</span> __dp=<span class="stringliteral">&quot;0&quot;</span> __ap=<span class="stringliteral">&quot;0&quot;</span> svd=<span class="stringliteral">&quot;SVD/LPC43xx.svd&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/debug&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;debug Pname=<span class="stringliteral">&quot;Cortex-M0&quot;</span> __dp=<span class="stringliteral">&quot;1&quot;</span> __ap=<span class="stringliteral">&quot;0&quot;</span> svd=<span class="stringliteral">&quot;SVD/LPC43xx.svd&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/debug&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p><b>Example</b> <b>2</b> </p>
<div class="fragment"><div class="line">&lt;device name=<span class="stringliteral">&quot;MCIMX7D&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;processor Dcore=<span class="stringliteral">&quot;Cortex-A7&quot;</span> DcoreVersion=<span class="stringliteral">&quot;r0p5&quot;</span> Pname=<span class="stringliteral">&quot;Cortex-A7&quot;</span> Punits=<span class="stringliteral">&quot;2&quot;</span> /&gt;</div>
<div class="line"> &lt;processor Dcore=<span class="stringliteral">&quot;Cortex-M4&quot;</span> DcoreVersion=<span class="stringliteral">&quot;r0p1&quot;</span> Pname=<span class="stringliteral">&quot;Cortex-M4&quot;</span>/&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;debug Pname=<span class="stringliteral">&quot;Cortex-A7&quot;</span> Punit=<span class="stringliteral">&quot;0&quot;</span> svd=<span class="stringliteral">&quot;SVD/iMX7D_A7.svd&quot;</span> __dp=<span class="stringliteral">&quot;0&quot;</span> __ap=<span class="stringliteral">&quot;1&quot;</span> address=<span class="stringliteral">&quot;0x80070000&quot;</span>/&gt; </div>
<div class="line"> &lt;debug Pname=<span class="stringliteral">&quot;Cortex-A7&quot;</span> Punit=<span class="stringliteral">&quot;1&quot;</span> svd=<span class="stringliteral">&quot;SVD/iMX7D_A7.svd&quot;</span> __dp=<span class="stringliteral">&quot;0&quot;</span> __ap=<span class="stringliteral">&quot;1&quot;</span> address=<span class="stringliteral">&quot;0x80072000&quot;</span>/&gt;</div>
<div class="line"> &lt;debug Pname=<span class="stringliteral">&quot;Cortex-M4&quot;</span> svd=<span class="stringliteral">&quot;SVD/iMX7D_M4.svd&quot;</span> __dp=<span class="stringliteral">&quot;0&quot;</span> __ap=<span class="stringliteral">&quot;4&quot;</span>/&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/device&gt;</div>
</div><!-- fragment --><p>&#160;</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>__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>address </td><td>Base "address" of the CPU debug block referenced by "Pname" (and "Punit" in an MPCore system). Use in combination with attributes "_dp" and "_ap". Mandatory if multiple CPU debug blocks are accessible via a single AP. Optional if an AP hosts a single CPU debug block. Then a debugger can determine its base address in by analyzing the ROM table behind __dp and __ap. </td><td>NonNegativeInteger </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>
<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>Punit </td><td>Use "Punit" in addition to "Pname" to select a specific processor unit of a symmetric MPCore that the &lt;debug&gt; configuration applies to. "Punit" is a '0'-based index and must be less than "Punits" of &lt;processor&gt;. If "Punit" is not specified, the &lt;debug&gt; configuration applies to all processor units of the MPCore. </td><td>xs:unsignedInt </td><td>optional </td></tr>
<tr>
<td>defaultResetSequence </td><td>Specifies the debug sequence that is to be used for the device. Refer to <a class="el" href="pdsc_SequenceNameEnum_pg.html#writing_sequences">Writing debug access sequences</a> for more information. </td><td>xs:string </td><td>optional </td></tr>
<tr>
<th>Child&#160;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>0..* </td></tr>
</table>
<p>&#160;</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">&lt;family Dfamily=<span class="stringliteral">&quot;LPC800 Series&quot;</span> Dvendor=<span class="stringliteral">&quot;NXP:11&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;debug svd=<span class="stringliteral">&quot;SVD\LPC800.svd&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;datapatch type=<span class="stringliteral">&quot;Mem&quot;</span> __ap=<span class="stringliteral">&quot;0&quot;</span> address=<span class="stringliteral">&quot;0x1400000C&quot;</span> value=<span class="stringliteral">&quot;0x10000000&quot;</span> mask=<span class="stringliteral">&quot;0xFFFFFFFF&quot;</span> info=<span class="stringliteral">&quot;Patch MTB BASE register&quot;</span>/&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/debug&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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>address </td><td>The address for which to apply the patch. </td><td>NonNegativeInteger </td><td>required </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>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>&#160;</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>&#160;</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">&lt;family Dfamily=<span class="stringliteral">&quot;LPC4300 Series&quot;</span> Dvendor=<span class="stringliteral">&quot;NXP:11&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;trace Pname=<span class="stringliteral">&quot;Cortex-M4&quot;</span>&gt;</div>
<div class="line"> &lt;serialwire/&gt;</div>
<div class="line"> &lt;traceport width=<span class="stringliteral">&quot;0x0000000B&quot;</span>/&gt; &lt;!-- support <span class="keywordflow">for</span> port widths 1, 2, and 4 --&gt;</div>
<div class="line"> &lt;tracebuffer start=<span class="stringliteral">&quot;0x2000C000&quot;</span> size=<span class="stringliteral">&quot;0x4000&quot;</span>/&gt;</div>
<div class="line"> &lt;/trace&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;trace Pname=<span class="stringliteral">&quot;Cortex-M0&quot;</span>&gt;</div>
<div class="line"> &lt;!-- Empty trace section <span class="keywordflow">for</span> Cortex-M0, no trace capabilities --&gt;</div>
<div class="line"> &lt;/trace&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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&#160;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>&#160;</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">&lt;family Dfamily=<span class="stringliteral">&quot;LPC4300 Series&quot;</span> Dvendor=<span class="stringliteral">&quot;NXP:11&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;trace Pname=<span class="stringliteral">&quot;Cortex-M4&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;serialwire/&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/trace&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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>&#160;</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">&lt;family Dfamily=<span class="stringliteral">&quot;LPC4300 Series&quot;</span> Dvendor=<span class="stringliteral">&quot;NXP:11&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;trace Pname=<span class="stringliteral">&quot;Cortex-M4&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;traceport width=<span class="stringliteral">&quot;0x0000000B&quot;</span>/&gt; &lt;!-- support <span class="keywordflow">for</span> port widths 1, 2, and 4 --&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/trace&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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>&#160;</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">&lt;family Dfamily=<span class="stringliteral">&quot;LPC4300 Series&quot;</span> Dvendor=<span class="stringliteral">&quot;NXP:11&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;trace Pname=<span class="stringliteral">&quot;CoreCM4&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;tracebuffer start=<span class="stringliteral">&quot;0x2000C000&quot;</span> size=<span class="stringliteral">&quot;0x4000&quot;</span>/&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;/trace&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/family&gt;</div>
</div><!-- fragment --><p>&#160;</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>&#160;</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">&lt;device Dname=<span class="stringliteral">&quot;STM32F205RB&quot;</span>&gt;</div>
<div class="line"> ...</div>
<div class="line"> &lt;variant Dvariant=<span class="stringliteral">&quot;STM32F205RBT6&quot;</span>&gt;</div>
<div class="line"> &lt;book name=<span class="stringliteral">&quot;doc\STM32F2_RM.PDF&quot;</span> title=<span class="stringliteral">&quot;STM32F2 Reference Manual&quot;</span>/&gt;</div>
<div class="line"> &lt;description&gt;Use <span class="keyword">this</span> device as an alternative.&lt;/description&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;QFP&quot;</span> count=<span class="stringliteral">&quot;64&quot;</span> name=<span class="stringliteral">&quot;LQFP 64 10x10x1.4&quot;</span> /&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;Temp&quot;</span> n=<span class="stringliteral">&quot;-40&quot;</span> m=<span class="stringliteral">&quot;85&quot;</span> name=<span class="stringliteral">&quot;Industrial Temperature Range&quot;</span>/&gt;</div>
<div class="line"> &lt;/variant&gt;</div>
<div class="line"> &lt;variant Dvariant=<span class="stringliteral">&quot;STM32F205RBT7&quot;</span>&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;QFP&quot;</span> count=<span class="stringliteral">&quot;64&quot;</span> name=<span class="stringliteral">&quot;LQFP 64 10x10x1.4&quot;</span> /&gt;</div>
<div class="line"> &lt;feature type=<span class="stringliteral">&quot;Temp&quot;</span> n=<span class="stringliteral">&quot;-40&quot;</span> m=<span class="stringliteral">&quot;105&quot;</span> name=<span class="stringliteral">&quot;Extended Temperature Range&quot;</span>/&gt;</div>
<div class="line"> &lt;/variant&gt;</div>
<div class="line"> ...</div>
<div class="line">&lt;/device&gt;</div>
</div><!-- fragment --><p><br/>
</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>RestrictedStringDname </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_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_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_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 the features of this device. </td><td>FeatureType </td><td>0..* </td></tr>
<tr>
<td><a class="el" href="pdsc_family_pg.html#element_feature">environment</a> </td><td>Specify tool options. </td><td>EnvironmentType </td><td>0..* </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_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>
</table>
<p>&#160;</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="packFormat.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 Wed Feb 8 2017 10:21:01 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.6
-->
</li>
</ul>
</div>
</body>
</html>