diff options
Diffstat (limited to 'CMSIS/Documentation/SVD/html/group__svd__xml__peripherals__gr.html')
| -rw-r--r-- | CMSIS/Documentation/SVD/html/group__svd__xml__peripherals__gr.html | 225 |
1 files changed, 225 insertions, 0 deletions
diff --git a/CMSIS/Documentation/SVD/html/group__svd__xml__peripherals__gr.html b/CMSIS/Documentation/SVD/html/group__svd__xml__peripherals__gr.html new file mode 100644 index 0000000..14407ea --- /dev/null +++ b/CMSIS/Documentation/SVD/html/group__svd__xml__peripherals__gr.html @@ -0,0 +1,225 @@ +<!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>Peripherals Level</title> +<title>CMSIS-SVD: Peripherals Level</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="cmsis.css" rel="stylesheet" type="text/css" /> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<script type="text/javascript" src="printComponentTabs.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="stylsheetf" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 46px;"> + <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">CMSIS-SVD +  <span id="projectnumber">Version 1.3.1</span> + </div> + <div id="projectbrief">CMSIS System View Description</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<div id="CMSISnav" class="tabs1"> + <ul class="tablist"> + <script type="text/javascript"> + <!-- + writeComponentTabs.call(this); + //--> + </script> + </ul> +</div> +<!-- Generated by Doxygen 1.8.2 --> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Usage and Description</span></a></li> + <li><a href="modules.html"><span>Reference</span></a></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('group__svd__xml__peripherals__gr.html','');}); +</script> +<div id="doc-content"> +<div class="header"> + <div class="headertitle"> +<div class="title">Peripherals Level</div> </div> +<div class="ingroups"><a class="el" href="group__svd___format__gr.html">SVD File Schema Levels</a></div></div><!--header--> +<div class="contents"> +<p>All peripherals of a device are enclosed within the tag <b><peripherals></b>. At least one peripheral has to be defined. Each peripheral is enclosed in the tag <b><peripheral></b>.</p> +<ul> +<li>Each peripheral describes all registers belonging to that peripheral.</li> +<li>The address range allocated by a peripheral is defined through one or more address blocks.</li> +<li>An address block and register addresses are specified relative to the base address of a peripheral. The address block information can be used for constructing a memory map for the device peripherals.</li> +</ul> +<p>Starting version 1.3 of the SVD specification arrays of peripherals can be specified. The single peripheral description gets duplicated automatically into an array. The number of array elements is specified by the <dim> element. The peripheral name needs to be of the format <em>myPeripheral[s]</em>. The <em><dimIncrement></em> specifies the address offset between two peripherals. The <dimIndex> is ignored. If you want to create copies of a peripheral using different names, please use the derivedFrom attribute.</p> +<dl class="section remark"><dt>Remarks</dt><dd>The memory map does not contain any information about physical memory. The memories of a device are described as part of the CMSIS-PACK device description.</dd></dl> +<hr/> +<pre> +<span class="mand"> <b><peripherals></b> </span></pre><pre><span class="mand"> <b><peripheral <span class="opt">derivedFrom=<em>identifierType</em></span>></b></span></pre><pre><span class="mand"> <name><em>identifierType</em></name> + <version><em>xs:string</em></version> + <description><em>xs:string</em></description> + <span class="opt"> + <groupName><em>identifierType</em></groupName> + <prependToName><em>identifierType</em></prependToName> + <appendToName><em>identifierType</em></appendToName> + <disableCondition><em>xs:string</em></disableCondition> + </span> + <baseAddress><em>scaledNonNegativeInteger</em></baseAddress> + <span class="opt"> + <em> <!-- registerPropertiesGroup --></em> + <size><em>scaledNonNegativeInteger</em></size> + <access><em>accessType</em></access> + <resetValue><em>scaledNonNegativeInteger</em></resetValue> + <resetMask><em>scaledNonNegativeInteger</em></resetMask> + <em> <!-- end of registerPropertiesGroup --></em> + </span> + <addressBlock> + <offset><em>scaledNonNegativeInteger</em></offset> + <size><em>scaledNonNegativeInteger</em></size> + <usage><em>usageType</em></usage> + <protection><em>protectionStringType</em></protection> + </addressBlock><span class="opt"> + ... + <addressBlock><span class="mand"> + <offset><em>scaledNonNegativeInteger</em></offset> + <size><em>scaledNonNegativeInteger</em></size> + <usage><em>usageType</em></usage></span><span class="opt"> + <protection><em>protectionStringType</em></protection> + </addressBlock></span> + <span class="opt"> + <interrupt></span><span class="mand"> + <name><em>identifierType</em></name> + <value><em>scaledNonNegativeInteger</em></value></span> + </interrupt></span></span></pre><pre><span class="mand"><span class="opt"> <registers> + ... + </registers></span></span></pre><pre><span class="mand"> <b></peripheral></b> + <span class="opt">... + <peripheral> + ... + </peripheral> + </span> +<b></peripherals></b> +</span> +</pre><table class="cmtable" summary="Peripheral Level Schema"> +<tr> +<th nowrap="nowrap">Attribute Name </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td>derivedFrom </td><td>Specifies the name of a peripheral from which this peripheral will be derived. Values are inherit. Elements specified underneath will override inherited values. </td><td>xs:Name </td><td>0..1 </td></tr> +<tr> +<th nowrap="nowrap">Element Name </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td>name </td><td>The name string is used to identify the peripheral. Peripheral names are required to be unique for a device. The name needs to be an ANSI C identifier to allow header file generation. </td><td>xs:Name </td><td>1..1 </td></tr> +<tr> +<td>version </td><td>The string specifies the version of this peripheral description. </td><td>xs:string </td><td>0..1 </td></tr> +<tr> +<td>description </td><td>The string provides an overview of the purpose and functionality of the peripheral. </td><td>xs:string </td><td>0..1 </td></tr> +<tr> +<td>groupName </td><td></td><td>xs:string </td><td>0..1 </td></tr> +<tr> +<td>prependToName </td><td>All register names of this peripheral have their names prefixed with this string. </td><td>xs:string </td><td>0..1 </td></tr> +<tr> +<td>appendToName </td><td>All register names of this peripheral have their names suffixed with this string. </td><td>xs:string </td><td>0..1 </td></tr> +<tr> +<td>disableCondition </td><td>Is a C-language compliant logical expression returning a TRUE or FALSE result. If TRUE, refreshing the display for this peripheral is disabled and related accesses by the debugger are suppressed. <br/> + <br/> + Only constants and references to other registers contained in the description are allowed: <em><peripheral>-><register>-><field></em>, for example, (System->ClockControl->apbEnable == 0). The following operators are allowed in the expression [&&,||, ==, !=, >>, <<, &, |]. <dl class="section attention"><dt>Attention</dt><dd>Use this feature only in cases where accesses from the debugger to registers of un-clocked peripherals result in severe debugging failures. SVD is intended to provide static information and does not include any run-time computation or functions. Such capabilities can be added by the tools, and is beyond the scope of this description language. </dd></dl> +</td><td>xs:string </td><td>0..1 </td></tr> +<tr> +<td>baseAddress </td><td>Lowest address reserved or used by the peripheral. </td><td>scaledNonNegativeInteger </td><td>1..1 </td></tr> +<tr class="group1"> +<td colspan="4">See <a class="el" href="group__register_properties_group__gr.html">registerPropertiesGroup</a> for details. </td></tr> +<tr class="group1"> +<td align="right">size </td><td>Defines the default bit-width of any register contained in the device (implicit inheritance). </td><td>scaledNonNegativeInteger </td><td>0..1 </td></tr> +<tr class="group1"> +<td align="right">access </td><td>Defines the default access rights for all registers. </td><td>accessType </td><td>0..1 </td></tr> +<tr class="group1"> +<td align="right">protection </td><td>Defines the protection rights for all registers. </td><td>protectionStringType </td><td>0..1 </td></tr> +<tr class="group1"> +<td align="right">resetValue </td><td>Defines the default value for all registers at RESET. </td><td>scaledNonNegativeInteger </td><td>0..1 </td></tr> +<tr class="group1"> +<td align="right">resetMask </td><td>Identifies which register bits have a defined reset value. </td><td>scaledNonNegativeInteger </td><td>0..1 </td></tr> +<tr class="group2"> +<td>addressBlock </td><td>Specifies an address range uniquely mapped to this peripheral. A peripheral must have at least one address block, but may allocate multiple distinct address ranges. If a peripheral is derived form another peripheral, the addressBlock is not mandatory. </td><td>addressBlockType </td><td>1..* </td></tr> +<tr class="group2"> +<td align="right">offset </td><td>Specifies the start address of an address block relative to the peripheral <em>baseAddress</em>. </td><td>scaledNonNegativeInteger </td><td>1..1 </td></tr> +<tr class="group2"> +<td align="right">size </td><td>Specifies the number of addressUnitBits being covered by this address block. The end address of an address block results from the sum of baseAddress, offset, and (size - 1). </td><td>scaledNonNegativeInteger </td><td>1..1 </td></tr> +<tr class="group2"> +<td align="right">usage </td><td>The following predefined values can be used: <span class="XML-Token">registers<em>, </em> buffer<em>, or</em> reserved</span>. </td><td>scaledNonNegativeInteger </td><td>1..1 </td></tr> +<tr class="group1"> +<td>interrupt </td><td>A peripheral can have multiple associated interrupts. This entry allows the debugger to show interrupt names instead of interrupt numbers. </td><td>interruptType </td><td>0..* </td></tr> +<tr class="group1"> +<td align="right">name </td><td>The string represents the interrupt name. </td><td>XS:string </td><td>1..1 </td></tr> +<tr class="group1"> +<td align="right">value </td><td>Is the enumeration index value associated to the interrupt. </td><td>xs:integer </td><td>1..1 </td></tr> +<tr> +<td>registers </td><td>See <a class="el" href="group__svd__xml__registers__gr.html">Registers Level</a> for details. </td><td>  </td><td>0..1 </td></tr> +</table> +<h1><a class="anchor" id="periph_ex"></a> +Example:</h1> +<div class="fragment"><div class="line">...</div> +<div class="line"><peripheral></div> +<div class="line"> <name>Timer0</name></div> +<div class="line"> <version>1.0.32</version></div> +<div class="line"> <description>Timer 0 is a simple 16 bit timer counting down ... </description></div> +<div class="line"> <baseAddress>0x40000000</baseAddress></div> +<div class="line"> <addressBlock></div> +<div class="line"> <offset>0x0</offset></div> +<div class="line"> <size>0x400</size></div> +<div class="line"> <usage>registers</usage></div> +<div class="line"> <protection>s</protection></div> +<div class="line"> </addressBlock></div> +<div class="line"> <interrupt><name>TIM0_INT</name><value>34</value></interrupt></div> +<div class="line"> <registers></div> +<div class="line"> ...</div> +<div class="line"> </registers></div> +<div class="line"></peripheral></div> +<div class="line"></div> +<div class="line"><peripheral derivedFrom=<span class="stringliteral">"Timer0"</span>></div> +<div class="line"> <name>Timer1</name></div> +<div class="line"> <baseAddress>0x40000400</baseAddress></div> +<div class="line"></peripheral></div> +<div class="line">...</div> +</div><!-- fragment --> </div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated on Tue Oct 27 2015 14:35:46 for CMSIS-SVD by ARM Ltd. All rights reserved. + <!-- + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.2 + --> + </li> + </ul> +</div> +</body> +</html> |