begriffs open source - cmsis/blob - dev/v6.0.0-dev84/Driver/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 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <script type="text/javascript" src="tabs.js"></script>
  13 <script type="text/javascript" src="footer.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="resize.js"></script>
  17 <script type="text/javascript" src="navtreedata.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="search/searchdata.js"></script>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  24   $(document).ready(function() { init_search(); });
  25 /* @license-end */
  26 </script>
  27 <script type="text/javascript" src="darkmode_toggle.js"></script>
  28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  32 <link href="version.css" rel="stylesheet" type="text/css"/>
  33 <script type="text/javascript" src="../../version.js"></script>
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 55px;">
  41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  43    <div id="projectname">CMSIS-Driver
  44    &#160;<span id="projectnumber"><script type="text/javascript">
  45      <!--
  46      writeHeader.call(this);
  47      writeVersionDropdown.call(this, "CMSIS-Driver");
  48      //-->
  49     </script>
  50    </span>
  51    </div>
  52    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  53   </td>
  54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  58                onfocus="searchBox.OnSearchFieldFocus(true)"
  59                onblur="searchBox.OnSearchFieldFocus(false)"
  60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  61           </span><span class="right">
  62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  63           </span>
  64         </div>
  65 </td>
  66   <!--END !PROJECT_NAME-->
  67  </tr>
  68  </tbody>
  69 </table>
  70 </div>
  71 <!-- end header part -->
  72 <div id="CMSISnav" class="tabs1">
  73   <ul class="tablist">
  74     <script type="text/javascript">
  75       writeComponentTabs.call(this);
  76     </script>
  77   </ul>
  78 </div>
  79 <script type="text/javascript">
  80   writeSubComponentTabs.call(this);
  81 </script>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div><div class="header">
 127   <div class="headertitle"><div class="title">Overview </div></div>
 128 </div><!--header-->
 129 <div class="contents">
 130 <div class="textblock"><p><a class="anchor" id="mainpage"></a> <b>CMSIS-Driver</b> specifies generic driver interfaces for peripherals commonly used in embedded systems with Arm® Cortex® processors.</p>
 131 <p>User applications and middleware components can control such peripherals using the <a href="modules.html"><b>CMSIS-Driver API</b></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>
 132 <p>The following block diagram shows an exemplary set up for various drivers.</p>
 133 <div class="image">
 134 <img src="driver.png" alt=""/>
 135 <div class="caption">
 136 Example use of CMSIS-Drivers with Middleware</div></div>
 137     <p>The standard CMSIS-Driver interfaces connect microcontroller peripherals with middleware that implements communication stacks, file system and graphic user interfaces.</p>
 138 <h1><a class="anchor" id="cmsis_drv_benefits"></a>
 139 Benefits</h1>
 140 <p>Using CMSIS-Driver provides great benefits to the embedded developers and software vendors:</p>
 141 <ul>
 142 <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>
 143 <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>
 144 <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>
 145 <li>Support for multiple driver instances with <a class="el" href="theoryOperation.html#AccessStruct">Access Struct</a>.</li>
 146 <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>
 147 </ul>
 148 <h1><a class="anchor" id="cmsis_drv_interfaces"></a>
 149 Covered Interfaces</h1>
 150 <p>CMSIS-Driver APIs are defined for the following driver interfaces:</p>
 151 <ul>
 152 <li><a class="el" href="group__can__interface__gr.html">CAN</a>: Interface to CAN bus peripheral.</li>
 153 <li><a class="el" href="group__eth__interface__gr.html">Ethernet</a>: Interface to Ethernet MAC and PHY peripheral.</li>
 154 <li><a class="el" href="group__i2c__interface__gr.html">I2C</a>: Multi-master Serial Single-Ended Bus interface driver.</li>
 155 <li><a class="el" href="group__mci__interface__gr.html">MCI</a>: Memory Card Interface for SD/MMC memory.</li>
 156 <li><a class="el" href="group__nand__interface__gr.html">NAND</a>: NAND Flash Memory interface driver.</li>
 157 <li><a class="el" href="group__flash__interface__gr.html">Flash</a>: Flash Memory interface driver.</li>
 158 <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>
 159 <li><a class="el" href="group__spi__interface__gr.html">SPI</a>: Serial Peripheral Interface Bus driver.</li>
 160 <li><a class="el" href="group__storage__interface__gr.html">Storage</a>: Storage device interface driver.</li>
 161 <li><a class="el" href="group__usart__interface__gr.html">USART</a>: Universal Synchronous and Asynchronous Receiver/Transmitter interface driver.</li>
 162 <li><a class="el" href="group__usb__interface__gr.html">USB</a>: Interface driver for USB Host and USB Device communication.</li>
 163 <li><a class="el" href="group__gpio__interface__gr.html">GPIO</a>: General-purpose Input/Output driver.</li>
 164 <li><a class="el" href="group__vio__interface__gr.html">VIO</a>: API for virtual I/Os (VIO).</li>
 165 <li><a class="el" href="group__wifi__interface__gr.html">WiFi</a>: Interface driver for wireless communication.</li>
 166 </ul>
 167 <p>A list of current CMSIS-Driver implementations is available <a class="el" href="listOfImplementations.html">here</a>.</p>
 168 <h1><a class="anchor" id="cmsis_driver_pack"></a>
 169 Access to CMSIS-Driver</h1>
 170 <p>CMSIS-Driver intefaces are actively maintained in the <a href="https://github.com/ARM-software/CMSIS_6"><b>CMSIS 6 GitHub repository</b></a> and released as part of the <a href="../General/cmsis_pack.html"><b>CMSIS Software Pack</b></a>.</p>
 171 <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>
 172 <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>
 173 <p>The following directories and files relevant to CMSIS-Driver are present in the <b>ARM::CMSIS</b> Pack:</p>
 174 <table class="markdownTable">
 175 <tr class="markdownTableHead">
 176 <th class="markdownTableHeadLeft">Directory   </th><th class="markdownTableHeadLeft">Content    </th></tr>
 177 <tr class="markdownTableRowOdd">
 178 <td class="markdownTableBodyLeft">📂 CMSIS   </td><td class="markdownTableBodyLeft">CMSIS Base software components folder    </td></tr>
 179 <tr class="markdownTableRowEven">
 180 <td class="markdownTableBodyLeft">┣ 📂 Documentation/html/Driver   </td><td class="markdownTableBodyLeft">A local copy of this CMSIS-Driver documentation    </td></tr>
 181 <tr class="markdownTableRowOdd">
 182 <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>
 183 <tr class="markdownTableRowEven">
 184 <td class="markdownTableBodyLeft">&emsp;&#160; ┣ 📂 DriverTemplates   </td><td class="markdownTableBodyLeft">Driver Template files (Driver_<em>interface</em>.c)    </td></tr>
 185 <tr class="markdownTableRowOdd">
 186 <td class="markdownTableBodyLeft">&emsp;&#160; ┣ 📂 Include   </td><td class="markdownTableBodyLeft">API header files (Driver_<em>interface</em>.h, Driver_Common.h)    </td></tr>
 187 <tr class="markdownTableRowEven">
 188 <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>
 189 </table>
 190 </div></div><!-- PageDoc -->
 191 </div><!-- contents -->
 192 </div><!-- doc-content -->
 193 <!-- start footer part -->
 194 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 195   <ul>
 196     <li class="footer">
 197       <script type="text/javascript">
 198         <!--
 199         writeFooter.call(this);
 200         //-->
 201       </script>
 202     </li>
 203   </ul>
 204 </div>
 205 </body>
 206 </html>