begriffs open source - cmsis/blob - main/Driver/html/referenceImplementation.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: Reference Implementation</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('referenceImplementation.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">Reference Implementation </div></div>
 131 </div><!--header-->
 132 <div class="contents">
 133 <div class="textblock"><p>The API of the CMSIS-Drivers is published in the <a class="el" href="referenceImplementation.html#DriverHeaderFiles">Driver Header Files</a>.</p>
 134 <p>To simplify the development of a CMSIS-Driver both <a class="el" href="referenceImplementation.html#DriverTemplates">Driver Template Files</a> and <a class="el" href="referenceImplementation.html#DriverExamples">Driver Examples</a> are provided.</p>
 135 <p>ARM offers also a Software Pack for CMSIS-Driver Validation as described in <a class="el" href="driverValidation.html">Driver Validation</a>.</p>
 136 <h1><a class="anchor" id="DriverHeaderFiles"></a>
 137 Driver Header Files</h1>
 138 <p>The API of each CMSIS-Driver is published in a header file. It is recommended to include the header file that is part of the CMSIS specification in the implementation file of the CMSIS-Driver.</p>
 139 <p>The following header files are available in the directory <b>.\CMSIS\Driver\Include</b>.</p>
 140 <table class="markdownTable">
 141 <tr class="markdownTableHead">
 142 <th class="markdownTableHeadNone">Header File   </th><th class="markdownTableHeadNone">Description    </th></tr>
 143 <tr class="markdownTableRowOdd">
 144 <td class="markdownTableBodyNone">Driver_Common.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__common__drv__gr.html">Common Driver Definitions</a>    </td></tr>
 145 <tr class="markdownTableRowEven">
 146 <td class="markdownTableBodyNone">Driver_CAN.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__can__interface__gr.html">CAN Interface</a>    </td></tr>
 147 <tr class="markdownTableRowOdd">
 148 <td class="markdownTableBodyNone">Driver_ETH.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a>    </td></tr>
 149 <tr class="markdownTableRowEven">
 150 <td class="markdownTableBodyNone">Driver_ETH_MAC.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a>    </td></tr>
 151 <tr class="markdownTableRowOdd">
 152 <td class="markdownTableBodyNone">Driver_ETH_PHY.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__eth__phy__interface__gr.html">Ethernet PHY Interface</a>    </td></tr>
 153 <tr class="markdownTableRowEven">
 154 <td class="markdownTableBodyNone">Driver_Flash.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__flash__interface__gr.html">Flash Interface</a>    </td></tr>
 155 <tr class="markdownTableRowOdd">
 156 <td class="markdownTableBodyNone">Driver_GPIO.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__gpio__interface__gr.html">GPIO Interface</a>    </td></tr>
 157 <tr class="markdownTableRowEven">
 158 <td class="markdownTableBodyNone">Driver_I2C.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a>    </td></tr>
 159 <tr class="markdownTableRowOdd">
 160 <td class="markdownTableBodyNone">Driver_MCI.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__mci__interface__gr.html">MCI Interface</a>    </td></tr>
 161 <tr class="markdownTableRowEven">
 162 <td class="markdownTableBodyNone">Driver_NAND.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__nand__interface__gr.html">NAND Interface</a>    </td></tr>
 163 <tr class="markdownTableRowOdd">
 164 <td class="markdownTableBodyNone">Driver_SPI.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__spi__interface__gr.html">SPI Interface</a>    </td></tr>
 165 <tr class="markdownTableRowEven">
 166 <td class="markdownTableBodyNone">Driver_Storage.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__storage__interface__gr.html">Storage Interface</a>    </td></tr>
 167 <tr class="markdownTableRowOdd">
 168 <td class="markdownTableBodyNone">Driver_SAI.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__sai__interface__gr.html">SAI Interface</a>    </td></tr>
 169 <tr class="markdownTableRowEven">
 170 <td class="markdownTableBodyNone">Driver_USART.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__usart__interface__gr.html">USART Interface</a>    </td></tr>
 171 <tr class="markdownTableRowOdd">
 172 <td class="markdownTableBodyNone">Driver_USB.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__usb__interface__gr.html">USB Interface</a>    </td></tr>
 173 <tr class="markdownTableRowEven">
 174 <td class="markdownTableBodyNone">Driver_USBD.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a>    </td></tr>
 175 <tr class="markdownTableRowOdd">
 176 <td class="markdownTableBodyNone">Driver_USBH.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a>    </td></tr>
 177 <tr class="markdownTableRowEven">
 178 <td class="markdownTableBodyNone">Driver_WiFi.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__wifi__interface__gr.html">WiFi Interface</a>   </td></tr>
 179 </table>
 180 <h1><a class="anchor" id="DriverTemplates"></a>
 181 Driver Template Files</h1>
 182 <p>Driver template files are code skeletons that provide the structure of a CMSIS-Driver. The following templates are available in the directory <b>.\CMSIS\Driver\DriverTemplates</b>.</p>
 183 <table class="markdownTable">
 184 <tr class="markdownTableHead">
 185 <th class="markdownTableHeadNone">Source File   </th><th class="markdownTableHeadNone">Description    </th></tr>
 186 <tr class="markdownTableRowOdd">
 187 <td class="markdownTableBodyNone">Driver_CAN.c   </td><td class="markdownTableBodyNone"><a class="el" href="group__can__interface__gr.html">CAN Interface</a>    </td></tr>
 188 <tr class="markdownTableRowEven">
 189 <td class="markdownTableBodyNone">Driver_ETH_MAC.c   </td><td class="markdownTableBodyNone"><a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a>    </td></tr>
 190 <tr class="markdownTableRowOdd">
 191 <td class="markdownTableBodyNone">Driver_ETH_PHY.c   </td><td class="markdownTableBodyNone"><a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a>    </td></tr>
 192 <tr class="markdownTableRowEven">
 193 <td class="markdownTableBodyNone">Driver_Flash.c   </td><td class="markdownTableBodyNone"><a class="el" href="group__flash__interface__gr.html">Flash Interface</a>    </td></tr>
 194 <tr class="markdownTableRowOdd">
 195 <td class="markdownTableBodyNone">Driver_GPIO.c   </td><td class="markdownTableBodyNone"><a class="el" href="group__gpio__interface__gr.html">GPIO Interface</a>    </td></tr>
 196 <tr class="markdownTableRowEven">
 197 <td class="markdownTableBodyNone">Driver_I2C.c   </td><td class="markdownTableBodyNone"><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a>    </td></tr>
 198 <tr class="markdownTableRowOdd">
 199 <td class="markdownTableBodyNone">Driver_MCI.c   </td><td class="markdownTableBodyNone"><a class="el" href="group__mci__interface__gr.html">MCI Interface</a>    </td></tr>
 200 <tr class="markdownTableRowEven">
 201 <td class="markdownTableBodyNone">Driver_SAI.c   </td><td class="markdownTableBodyNone"><a class="el" href="group__sai__interface__gr.html">SAI Interface</a>    </td></tr>
 202 <tr class="markdownTableRowOdd">
 203 <td class="markdownTableBodyNone">Driver_SPI.c   </td><td class="markdownTableBodyNone"><a class="el" href="group__spi__interface__gr.html">SPI Interface</a>    </td></tr>
 204 <tr class="markdownTableRowEven">
 205 <td class="markdownTableBodyNone">Driver_Storage.c   </td><td class="markdownTableBodyNone"><a class="el" href="group__storage__interface__gr.html">Storage Interface</a>    </td></tr>
 206 <tr class="markdownTableRowOdd">
 207 <td class="markdownTableBodyNone">Driver_USART.c   </td><td class="markdownTableBodyNone"><a class="el" href="group__usart__interface__gr.html">USART Interface</a>    </td></tr>
 208 <tr class="markdownTableRowEven">
 209 <td class="markdownTableBodyNone">Driver_USBD.c   </td><td class="markdownTableBodyNone"><a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a>    </td></tr>
 210 <tr class="markdownTableRowOdd">
 211 <td class="markdownTableBodyNone">Driver_USBH.c   </td><td class="markdownTableBodyNone"><a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a>   </td></tr>
 212 </table>
 213 <h1><a class="anchor" id="DriverExamples"></a>
 214 Driver Examples</h1>
 215 <p>The driver examples are full working CMSIS-Drivers that may be adapted to a different hardware. Examples are currently available for the NXP LPC1800 series and provide the implementation of a complete CMSIS-Driver. The following examples are available in the directory <b>.\CMSIS\Pack\Example\CMSIS_Driver</b>.</p>
 216 <table class="markdownTable">
 217 <tr class="markdownTableHead">
 218 <th class="markdownTableHeadNone">Source File   </th><th class="markdownTableHeadNone">Header File   </th><th class="markdownTableHeadNone">Description    </th></tr>
 219 <tr class="markdownTableRowOdd">
 220 <td class="markdownTableBodyNone">EMAC_LPC18xx.c   </td><td class="markdownTableBodyNone">EMAC_LPC18xx.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a>    </td></tr>
 221 <tr class="markdownTableRowEven">
 222 <td class="markdownTableBodyNone">SSP_LPC18xx.c   </td><td class="markdownTableBodyNone">SSP_LPC18xx.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__spi__interface__gr.html">SPI Interface</a>    </td></tr>
 223 <tr class="markdownTableRowOdd">
 224 <td class="markdownTableBodyNone">I2C_LPC18xx.c   </td><td class="markdownTableBodyNone">I2C_LPC18xx.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a>    </td></tr>
 225 <tr class="markdownTableRowEven">
 226 <td class="markdownTableBodyNone">I2S_LPC18xx.c   </td><td class="markdownTableBodyNone">I2S_LPC18xx.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__sai__interface__gr.html">SAI Interface</a>    </td></tr>
 227 <tr class="markdownTableRowOdd">
 228 <td class="markdownTableBodyNone">MCI_LPC18xx.c   </td><td class="markdownTableBodyNone">MCI_LPC18xx.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__mci__interface__gr.html">MCI Interface</a>    </td></tr>
 229 <tr class="markdownTableRowEven">
 230 <td class="markdownTableBodyNone">USART_LPC18xx.c   </td><td class="markdownTableBodyNone">USART_LPC18xx.h   </td><td class="markdownTableBodyNone"><a class="el" href="group__usart__interface__gr.html">USART Interface</a>    </td></tr>
 231 <tr class="markdownTableRowOdd">
 232 <td class="markdownTableBodyNone">USBn_LPC18xx.c   </td><td class="markdownTableBodyNone">USB_LPC18xx.h   </td><td class="markdownTableBodyNone">common files for <a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a> and <a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a>    </td></tr>
 233 <tr class="markdownTableRowEven">
 234 <td class="markdownTableBodyNone">USBDn_LPC18xx.c   </td><td class="markdownTableBodyNone"><em>none</em>   </td><td class="markdownTableBodyNone"><a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a>    </td></tr>
 235 <tr class="markdownTableRowOdd">
 236 <td class="markdownTableBodyNone">USBHn_LPC18xx.c   </td><td class="markdownTableBodyNone"><em>none</em>   </td><td class="markdownTableBodyNone"><a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a>   </td></tr>
 237 </table>
 238 <p>These CMSIS-Drivers use additional modules for GPIO and DMA control:</p>
 239 <table class="markdownTable">
 240 <tr class="markdownTableHead">
 241 <th class="markdownTableHeadNone">Source File   </th><th class="markdownTableHeadNone">Header File   </th><th class="markdownTableHeadNone">Description    </th></tr>
 242 <tr class="markdownTableRowOdd">
 243 <td class="markdownTableBodyNone">GPIO_LPC18xx.c   </td><td class="markdownTableBodyNone">GPIO_LPC18xx.h   </td><td class="markdownTableBodyNone">GPIO Interface for LPC1800 series    </td></tr>
 244 <tr class="markdownTableRowEven">
 245 <td class="markdownTableBodyNone">GPDMA_LPC18xx.c   </td><td class="markdownTableBodyNone"><em>none</em>   </td><td class="markdownTableBodyNone">DMA Interface for LPC1800 series    </td></tr>
 246 <tr class="markdownTableRowOdd">
 247 <td class="markdownTableBodyNone">SCU_LPC18xx.c   </td><td class="markdownTableBodyNone">SCU_LPC18xx.h   </td><td class="markdownTableBodyNone">SCU Interface for LPC1800 series   </td></tr>
 248 </table>
 249 <p>The CMSIS-Drivers for the LPC1800 device have also many configuration options that are controls using #define statements in the file <b>.\CMSIS\Pack\Example\CMSIS_Driver\Config\RTE_Device.h</b>. Using this file, the I/O pin and DMA assignment can be set among other parameters such as USB speed and PHY interfaces.</p>
 250 <p>Further driver reference implementations are available in Device Family Packs (DFP) labeled with version 2.0.0 or higher. </p>
 251 </div></div><!-- contents -->
 252 </div><!-- PageDoc -->
 253 </div><!-- doc-content -->
 254 <!-- start footer part -->
 255 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 256   <ul>
 257     <li class="footer">
 258       <script type="text/javascript">
 259         <!--
 260         writeFooter.call(this);
 261         //-->
 262       </script>
 263     </li>
 264   </ul>
 265 </div>
 266 </body>
 267 </html>