mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-05-23 05:47:35 +08:00
jgoppert
183 lines
8.6 KiB
HTML
183 lines
8.6 KiB
HTML
<!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"/>
|
|
<title>Cluster Level (New)</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="cmsis.css" rel="stylesheet" type="text/css" />
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</script>
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div! -->
|
|
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 46px;">
|
|
<td id="proglogo"><img alt="CMSIS Logo" src="CMSIS_Logo_Final.png"></td>
|
|
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">CMSIS-SVD
|
|
 <span id="projectnumber">Version 1.10</span>
|
|
</div>
|
|
<div id="projectbrief">CMSIS System View Description</div>
|
|
</td>
|
|
|
|
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div id="CMSISnav" class="tabs1">
|
|
<ul class="tablist">
|
|
<li><a href="../../General/html/index.html"><span>CMSIS</span></a></li>
|
|
<li><a href="../../Core/html/index.html"><span>CORE</span></a></li>
|
|
<li><a href="../../DSP/html/index.html"><span>DSP</span></a></li>
|
|
<li><a href="../../RTOS/html/index.html"><span>RTOS API</span></a></li>
|
|
<li class="current"><a href="../../SVD/html/index.html"><span>SVD</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- Generated by Doxygen 1.7.5.1 -->
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<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>
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
initNavTree('group__cluster_level__gr.html','');
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Cluster Level (New)</div> </div>
|
|
<div class="ingroups"><a class="el" href="group__svd___format__1__1__gr.html">SVD Extension in Version 1.1</a></div></div>
|
|
<div class="contents">
|
|
<p><b>Cluster</b> adds a new and optional sub-level to the CMSIS SVD <em>registers</em> level. A cluster describes a sequence of registers within a peripheral. A cluster has an base offset relative to the base address of the peripheral. All registers within a cluster specify their address offset relative to the cluster base address. <em>Register</em> and <em>cluster</em> sections can occur in an arbitrary order. This feature, targeted at the generation of device header files, is useful to create a C data structure within the peripheral structure type, rather than describing all registers of a peripheral in a flat structure.</p>
|
|
<hr/>
|
|
<pre>
|
|
<span class="mand"><b><registers></b> </span></pre><pre><span class="mand"> <b><cluster <span class="opt">derivedFrom=<em>identifierType</em></span>></b>
|
|
<span class="opt">
|
|
<em><!-- dimElementGroup --> </em>
|
|
<dim><em>scaledNonNegativeInteger</em></dim>
|
|
<dimIncrement><em>scaledNonNegativeInteger</em></dimIncrement>
|
|
<dimIndex><em>dimIndexType</em></dimIndex>
|
|
<em><!-- end of dimElementGroup --> </em>
|
|
</span>
|
|
<name><em>identifierType</em></name>
|
|
<description><em>xs:string</em></description>
|
|
<span class="opt">
|
|
<headerStructName><em>identifierType</em></headerStructName>
|
|
<alternateCluster><em>identifierType</em></alternateCluster>
|
|
</span>
|
|
<addressOffset><em>scaledNonNegativeInteger</em></addressOffset></span></pre><pre><span class="mand"> <register>
|
|
...
|
|
</register>
|
|
<b></cluster></b>
|
|
<span class="opt">...
|
|
<register>
|
|
...
|
|
</register>
|
|
<cluster>
|
|
...
|
|
</cluster>
|
|
</span>
|
|
<b><registers></b> </span>
|
|
</pre><table class="cmtable" summary="Cluster Level Schema">
|
|
<tr>
|
|
<th>Attribute Name </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
|
|
<tr>
|
|
<td>derivedFrom </td><td>Specifies the name of the cluster from which to inherit the data. Elements being specified underneath will override the inherited values. <br/>
|
|
<b>Remarks:</b> When deriving a cluster, it is mandatory to specify at least the name, the description, and the addressOffset. </td><td>registerType </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<th>Element Name </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
|
|
<tr class="group1">
|
|
<td colspan="4">See <a class="el" href="group__dim_element_group__gr.html">dimElementGroup</a> for details. </td></tr>
|
|
<tr class="group1">
|
|
<td align="left">dimIncrement </td><td>The value defines the number of elements in an array of clusters. </td><td>scaledNonNegativeInteger </td><td>1..1 </td></tr>
|
|
<tr class="group1">
|
|
<td align="left">dimIncrement </td><td>If <em>dim</em> is specified, this element becomes mandatory. The element specifies the address increment in between two neighboring clusters of the cluster array in the address map. </td><td>scaledNonNegativeInteger </td><td>1..1 </td></tr>
|
|
<tr class="group1">
|
|
<td align="left">dimIndex </td><td>Specifies the substrings that replaces the <em>[%s]</em> placeholder within the cluster name. By default, the index is a decimal value starting with 0 for the first cluster element. </td><td>dimIndexType </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td>name </td><td>String that identifies the cluster. Register names are required to be unique within the scope of a peripheral. Specify <em>[%s]</em> for generating an array in the device header file. </td><td>identifierType </td><td>1..1 </td></tr>
|
|
<tr>
|
|
<td>description </td><td>String describing the details of the register. </td><td>xs:string </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td>alternateCluster </td><td>This tag needs to specify the name of the original description of the register sequence if this cluster provides an alternative description. Otherwise the SVDConv will issue errors. </td><td>identifierType </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td>headerStructName </td><td>This tag specifies the struct type name in the device header file. If not specified, then the name of the cluster will be used. </td><td>identifierType </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td>addressOffset </td><td>Value defining the cluster address relative to the <em>baseAddress</em> defined by the peripheral of the register. </td><td>scaledNonNegativeInteger </td><td>1..1 </td></tr>
|
|
</table>
|
|
<h2><a class="anchor" id="clusterSection_ex"></a>
|
|
Example:</h2>
|
|
<div class="fragment"><pre class="fragment"><cluster>
|
|
<dim>4</dim>
|
|
<dimIncrement>8</dimIncrement>
|
|
<dimIndex>0-3</dimIndex>
|
|
<name>TX[%s]</name>
|
|
<description>Grouping of Transfer data and address</description>
|
|
<addressOffset>0x40</addressOffset>
|
|
<<span class="keyword">register</span>>
|
|
<name>TX_DATA</name>
|
|
...
|
|
<addressOffset>0x0</addressOffset>
|
|
...
|
|
</<span class="keyword">register</span>>
|
|
<<span class="keyword">register</span>>
|
|
<name>TX_ADDR</name>
|
|
...
|
|
<addressOffset>0x4</addressOffset>
|
|
...
|
|
</<span class="keyword">register</span>>
|
|
</cluster>
|
|
</pre></div><p>The example above describes an array of type TX with 4 elements. TX is a cluster of two consecutive registers with 4 elements. The device header file looks like this:</p>
|
|
<div class="fragment"><pre class="fragment"><span class="keyword">typedef</span> <span class="keyword">struct </span>{
|
|
...
|
|
<span class="keyword">struct </span>{
|
|
__IO uint32_t TX_DATA;
|
|
__IO uint32_t TX_ADDR;
|
|
} TX[4];
|
|
...
|
|
} ..._Type;
|
|
</pre></div> </div>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
|
|
<li class="footer">Generated on Wed Mar 28 2012 15:38:11 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.7.5.1 </li>
|
|
-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</body>
|
|
</html>
|