diff options
Diffstat (limited to 'CMSIS/Documentation/SVD/html/index.html')
| -rw-r--r-- | CMSIS/Documentation/SVD/html/index.html | 161 |
1 files changed, 161 insertions, 0 deletions
diff --git a/CMSIS/Documentation/SVD/html/index.html b/CMSIS/Documentation/SVD/html/index.html new file mode 100644 index 0000000..e922398 --- /dev/null +++ b/CMSIS/Documentation/SVD/html/index.html @@ -0,0 +1,161 @@ +<!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>System View Description</title> +<title>CMSIS-SVD: System View Description</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 class="current"><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('index.html','');}); +</script> +<div id="doc-content"> +<div class="header"> + <div class="headertitle"> +<div class="title">System View Description </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><h2>Introduction</h2> +<p>The CMSIS System View Description format(CMSIS-SVD) formalizes the description of the system contained in ARM Cortex-M processor-based microcontrollers, in particular, the memory mapped registers of peripherals. The detail contained in system view descriptions is comparable to the data in device reference manuals. The information ranges from high level functional descriptions of a peripheral all the way down to the definition and purpose of an individual bit field in a memory mapped register.</p> +<p>CMSIS-SVD files are developed and maintained by silicon vendors. Silicon vendors manage their descriptions in a central, web-based Device Database. The CMSIS-SVD files are down-loadable via a public web interface once they have been released by the silicon vendor. Tool vendors use CMSIS-SVD files for providing device-specific debug views of peripherals in their debugger. Last but not least, CMSIS-compliant device header files are generated from CMSIS-SVD files.</p> +<h2>CMSIS-SVD Benefits</h2> +<ul> +<li>For Software Developers:<ul> +<li>Consistency between device header file and what is being displayed by the debugger.</li> +<li>Detailed information about peripherals, registers, fields, and bit values from within the debugger, without the need to reference device documentation.</li> +<li>Public access via a web interface to new and updated descriptions as they become available from silicon vendors.</li> +<li>Improved software development efficiency.</li> +</ul> +</li> +</ul> +<ul> +<li>For Silicon Vendors:<ul> +<li>A tool vendor independent file format enables early device support by a wide range of toolchains with limited effort.</li> +<li>The XML-based format helps ease the integration into in-house design flows.</li> +<li>Automated generation of CMSIS compliant device header files.</li> +<li>Full control throughout the life cycle of the CMSIS-SVD files from creation to maintenance via the web-based Device Database.</li> +</ul> +</li> +</ul> +<ul> +<li>For Tool Vendors:<ul> +<li>Unified file format across silicon vendors helps the efficiency of supporting a wide range of new devices in a timely manner.</li> +<li>Silicon vendors provide early review access to individuals ahead of the publishing date.</li> +<li>Updated descriptions are available over the web simplifying the maintenance of device support.</li> +</ul> +</li> +</ul> +<h2>The Web Infrastructure</h2> +<div class="image"> +<img src="CMSIS_SVD_WEB_DATABASE.png" alt="CMSIS_SVD_WEB_DATABASE.png"/> +<div class="caption"> +CMSIS-SVD Management Processes</div></div> +<p> The diagram illustrates the management process steps for uploading, validating, reviewing, publishing, and downloading CMSIS-SVD files.</p> +<ul> +<li><b>Managing Files:</b> A CMSIS-SVD file is uploaded by a silicon vendor via the web interface (<a href="https://cmsis.arm.com/user/index.php" target="_blank"><b>Device Database</b></a>). The system performs a check against the CMSIS-SVD Schema and runs the SVDConv consistency checker. Only if both checks were successful the file will be stored in the SVD Storage. Files can be added, replaced, and deleted.</li> +</ul> +<ul> +<li><b>Managing Devices:</b> The silicon vendor creates an entry for each of his devices in the database by defining a name and associating it with a CMSIS-SVD file from the SVD Storage. The publishing date set forth for a device is used by the system to determine when this device becomes visible in the public device database. Prior to the publishing date, the silicon vendor can grant review access to individuals for an individual device. Reviewers get notified by e-mail about a device being made available for review.</li> +</ul> +<ul> +<li><b>Public Download:</b> Public access to the silicon vendor specific CMSIS-SVD download pages is provided from <a href="http://cmsis.arm.com" target="_blank">cmsis.arm.com</a> or <a href="http://www.arm.com/cmsis" target="_blank">www.arm.com/cmsis</a>. Select the CMSIS-SVD tab and select the Silicon Vendor of interest from the list. For the public download of the CMSIS-SVD files of published devices it is mandatory to:<ul> +<li>Be logged in on the ARM web site.</li> +<li>Have accepted a silicon vendor specific End Users License Agreement (EULA).</li> +</ul> +</li> +</ul> +<p>More information about the web infrastructure can be found in the <a class="el" href="svd_web_pg.html">CMSIS-SVD Web Interface User Guide</a></p> +<h2>Language Outline</h2> +<ul> +<li><a class="el" href="svd__outline_pg.html">SVD File Format</a></li> +</ul> +<h2>Language Specification</h2> +<ul> +<li><a class="el" href="group__svd___format__gr.html">SVD File Schema Levels</a></li> +<li><a class="el" href="group__svd___format__1__1__gr.html">SVD Extensions</a></li> +</ul> +<h2>CMSIS-SVD in ARM::CMSIS Pack</h2> +<p>The following files relevant to CMSIS-SVD are present in the <b>ARM::CMSIS</b> Pack directories:</p> +<table class="doxtable"> +<tr> +<th>File/Folder </th><th>Content</th></tr> +<tr> +<td><b>CMSIS\Documentation\SVD</b> </td><td>This documentation </td></tr> +<tr> +<td><b>CMSIS\SVD</b> </td><td>Exemplary SVD file (<a class="el" href="svd__example_pg.html">ARM_Example.svd</a>) and generated header file (ARM_Example.h). </td></tr> +</table> +<p> </p> +<hr/> + </div></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="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> |