begriffs open source - cmsis/blob - dev/v6.0.0-dev53/Driver/html/index.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-Driver: Overview</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-Driver
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this);
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div><div class="header">
 130   <div class="headertitle"><div class="title">Overview </div></div>
 131 </div><!--header-->
 132 <div class="contents">
 133 <div class="textblock"><p><a class="anchor" id="mainpage"></a> The <b>CMSIS-Driver</b> specifies generic driver interfaces for peripherals commonly used in embedded systems with Arm® Cortex® processors.</p>
 134 <p>User applications and middleware components can control such peripherals using the <a href="modules.html">CMSIS-Driver API</a> and so achieve better code reuse and simpler integration in various ecosystems. The API is designed to be generic and independent of a specific RTOS making it reusable across a wide range of supported microcontroller devices.</p>
 135 <p>The following block diagram shows an exemplary set up for various drivers.</p>
 136 <div class="image">
 137 <img src="driver.png" alt=""/>
 138 <div class="caption">
 139 Example use of CMSIS-Drivers with Middleware</div></div>
 140     <p>The standard CMSIS-Driver interfaces connect microcontroller peripherals with middleware that implements communication stacks, file system and graphic user interfaces.</p>
 141 <h1><a class="anchor" id="cmsis_drv_benefits"></a>
 142 Benefits</h1>
 143 <p>Using CMSIS-Driver provides great benefits to the embedded developers and software vendors:</p>
 144 <ul>
 145 <li>The CMSIS-Driver API covers <a class="el" href="index.html#cmsis_drv_interfaces">many common peripherals</a> present in modern embedded systems for sensor interaction, data storage, communication and graphics.</li>
 146 <li>The unified API follows the similar design principles across all peripherals. This reduces learning efforts and increases developers' productivity. See <a class="el" href="theoryOperation.html">Theory of Operation</a> for details.</li>
 147 <li>Driver templates files provide code sceletons that help to get started with implementations for specific peripherals. See <a class="el" href="theoryOperation.html#cmsis_driver_files">CMSIS-Driver Files</a>.</li>
 148 <li>Support for multiple driver instances with <a class="el" href="theoryOperation.html#AccessStruct">Access Struct</a>.</li>
 149 <li><a class="el" href="driverValidation.html">Driver-Validation Suite</a> provides a set of tests to verify compatibility to CMSIS-Driver API definitions.</li>
 150 </ul>
 151 <h1><a class="anchor" id="cmsis_drv_interfaces"></a>
 152 Covered Interfaces</h1>
 153 <p>CMSIS-Driver APIs are defined for the following driver interfaces:</p>
 154 <ul>
 155 <li><a class="el" href="group__can__interface__gr.html">CAN</a>: Interface to CAN bus peripheral.</li>
 156 <li><a class="el" href="group__eth__interface__gr.html">Ethernet</a>: Interface to Ethernet MAC and PHY peripheral.</li>
 157 <li><a class="el" href="group__i2c__interface__gr.html">I2C</a>: Multi-master Serial Single-Ended Bus interface driver.</li>
 158 <li><a class="el" href="group__mci__interface__gr.html">MCI</a>: Memory Card Interface for SD/MMC memory.</li>
 159 <li><a class="el" href="group__nand__interface__gr.html">NAND</a>: NAND Flash Memory interface driver.</li>
 160 <li><a class="el" href="group__flash__interface__gr.html">Flash</a>: Flash Memory interface driver.</li>
 161 <li><a class="el" href="group__sai__interface__gr.html">SAI</a>: Serial audio interface driver (I2s, PCM, AC'97, TDM, MSB/LSB Justified).</li>
 162 <li><a class="el" href="group__spi__interface__gr.html">SPI</a>: Serial Peripheral Interface Bus driver.</li>
 163 <li><a class="el" href="group__storage__interface__gr.html">Storage</a>: Storage device interface driver.</li>
 164 <li><a class="el" href="group__usart__interface__gr.html">USART</a>: Universal Synchronous and Asynchronous Receiver/Transmitter interface driver.</li>
 165 <li><a class="el" href="group__usb__interface__gr.html">USB</a>: Interface driver for USB Host and USB Device communication.</li>
 166 <li><a class="el" href="group__gpio__interface__gr.html">GPIO</a>: General-purpose Input/Output driver.</li>
 167 <li><a class="el" href="group__vio__interface__gr.html">VIO</a>: API for virtual I/Os (VIO).</li>
 168 <li><a class="el" href="group__wifi__interface__gr.html">WiFi</a>: Interface driver for wireless communication.</li>
 169 </ul>
 170 <p>A list of current CMSIS-Driver implementations is available <a class="el" href="listOfImplementations.html">here</a>.</p>
 171 <h1><a class="anchor" id="cmsis_driver_pack"></a>
 172 Access to CMSIS-Driver</h1>
 173 <p>CMSIS-Driver intefaces are actively maintained in <a href="https://github.com/ARM-software/CMSIS_6">CMSIS 6 GitHub repository</a> and released as part of the <a href="../../General/html/cmsis_pack.html">CMSIS Software Pack</a>.</p>
 174 <p>The CMSIS Software Pack publishes the API Interface under the Component Class <b>CMSIS Driver</b> with header files and a documentation. These header files are the reference for the implementation of the standardized peripheral driver interfaces.</p>
 175 <p>These implementations are published typically in the Device Family Pack of a related microcontroller family under the Component Class <b>CMSIS Driver</b>. A Device Family Pack may contain additional interfaces in the Component Class <b>Device</b> to extend the standard Peripheral Drivers covered by this CMSIS-Driver specification with additional device specific interfaces for example for Memory BUS, GPIO, or DMA.</p>
 176 <p>The following directories and files relevant to CMSIS-Driver are present in the <b>ARM::CMSIS</b> Pack:</p>
 177 <table class="markdownTable">
 178 <tr class="markdownTableHead">
 179 <th class="markdownTableHeadLeft">Directory   </th><th class="markdownTableHeadLeft">Content    </th></tr>
 180 <tr class="markdownTableRowOdd">
 181 <td class="markdownTableBodyLeft">📂 CMSIS   </td><td class="markdownTableBodyLeft">CMSIS Base software components folder    </td></tr>
 182 <tr class="markdownTableRowEven">
 183 <td class="markdownTableBodyLeft">┣ 📂 Documentation/Driver   </td><td class="markdownTableBodyLeft">A local copy of this CMSIS-Driver documentation    </td></tr>
 184 <tr class="markdownTableRowOdd">
 185 <td class="markdownTableBodyLeft">┣ 📂 Driver   </td><td class="markdownTableBodyLeft">Directory with CMSIS-Driver component, see <a class="el" href="theoryOperation.html#cmsis_driver_files">CMSIS-Driver Files</a>    </td></tr>
 186 <tr class="markdownTableRowEven">
 187 <td class="markdownTableBodyLeft">&emsp;&#160; ┣ 📂 DriverTemplates   </td><td class="markdownTableBodyLeft">Driver Template files (Driver_<em>interface</em>.c)    </td></tr>
 188 <tr class="markdownTableRowOdd">
 189 <td class="markdownTableBodyLeft">&emsp;&#160; ┣ 📂 Include   </td><td class="markdownTableBodyLeft">API header files (Driver_<em>interface</em>.h, Driver_Common.h)    </td></tr>
 190 <tr class="markdownTableRowEven">
 191 <td class="markdownTableBodyLeft">&emsp;&#160; ┗ 📂 VIO   </td><td class="markdownTableBodyLeft">Implementation of virtual Input/Output interface (<a class="el" href="group__vio__interface__gr.html">VIO</a>)   </td></tr>
 192 </table>
 193 </div></div><!-- PageDoc -->
 194 </div><!-- contents -->
 195 </div><!-- doc-content -->
 196 <!-- start footer part -->
 197 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 198   <ul>
 199     <li class="footer">
 200       <script type="text/javascript">
 201         <!--
 202         writeFooter.call(this);
 203         //-->
 204       </script>
 205     </li>
 206   </ul>
 207 </div>
 208 </body>
 209 </html>