Home Explore Help
Sign In
ARM-software
/
CMSIS_5
mirror of https://github-proxy.rt-thread.io/ARM-software/CMSIS_5.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: a82c293bfb
Branches Tags
CMSIS_5
/
docs
/
Driver
/
html
/
referenceImplementation.html

referenceImplementation.html 14 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <title>Reference Implementation</title>
    7. 

  7. <title>CMSIS-Driver: Reference Implementation</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <script type="text/javascript" src="printComponentTabs.js"></script>
    13. 

  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    14. 

  14. <script type="text/javascript" src="resize.js"></script>
    15. 

  15. <script type="text/javascript" src="navtree.js"></script>
    16. 

  16. <script type="text/javascript">
    17. 

  17.   $(document).ready(initResizable);
    18. 

  18.   $(window).load(resizeHeight);
    19. 

  19. </script>
    20. 

  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    21. 

  21. <script type="text/javascript" src="search/search.js"></script>
    22. 

  22. <script type="text/javascript">
    23. 

  23.   $(document).ready(function() { searchBox.OnSelectItem(0); });
    24. 

  24. </script>
    25. 

  25. </head>
    26. 

  26. <body>
    27. 

  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    28. 

  28. <div id="titlearea">
    29. 

  29. <table cellspacing="0" cellpadding="0">
    30. 

  30.  <tbody>
    31. 

  31.  <tr style="height: 46px;">
    32. 

  32.   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
    33. 

  33.   <td style="padding-left: 0.5em;">
    34. 

  34.    <div id="projectname">CMSIS-Driver
    35. 

  35.    &#160;<span id="projectnumber">Version 2.7.0</span>
    36. 

  36.    </div>
    37. 

  37.    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
    38. 

  38.   </td>
    39. 

  39.  </tr>
    40. 

  40.  </tbody>
    41. 

  41. </table>
    42. 

  42. </div>
    43. 

  43. <!-- end header part -->
    44. 

  44. <div id="CMSISnav" class="tabs1">
    45. 

  45.     <ul class="tablist">
    46. 

  46.       <script type="text/javascript">
    47. 

  47. 		<!--
    48. 

  48. 		writeComponentTabs.call(this);
    49. 

  49. 		//-->
    50. 

  50.       </script>
    51. 

  51. 	  </ul>
    52. 

  52. </div>
    53. 

  53. <!-- Generated by Doxygen 1.8.6 -->
    54. 

  54. <script type="text/javascript">
    55. 

  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    56. 

  56. </script>
    57. 

  57.   <div id="navrow1" class="tabs">
    58. 

  58.     <ul class="tablist">
    59. 

  59.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    60. 

  60.       <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
    61. 

  61.       <li><a href="modules.html"><span>Reference</span></a></li>
    62. 

  62.       <li>
    63. 

  63.         <div id="MSearchBox" class="MSearchBoxInactive">
    64. 

  64.         <span class="left">
    65. 

  65.           <img id="MSearchSelect" src="search/mag_sel.png"
    66. 

  66.                onmouseover="return searchBox.OnSearchSelectShow()"
    67. 

  67.                onmouseout="return searchBox.OnSearchSelectHide()"
    68. 

  68.                alt=""/>
    69. 

  69.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    70. 

  70.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    71. 

  71.                onblur="searchBox.OnSearchFieldFocus(false)" 
    72. 

  72.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    73. 

  73.           </span><span class="right">
    74. 

  74.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
    75. 

  75.           </span>
    76. 

  76.         </div>
    77. 

  77.       </li>
    78. 

  78.     </ul>
    79. 

  79.   </div>
    80. 

  80. </div><!-- top -->
    81. 

  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
    82. 

  82.   <div id="nav-tree">
    83. 

  83.     <div id="nav-tree-contents">
    84. 

  84.       <div id="nav-sync" class="sync"></div>
    85. 

  85.     </div>
    86. 

  86.   </div>
    87. 

  87.   <div id="splitbar" style="-moz-user-select:none;" 
    88. 

  88.        class="ui-resizable-handle">
    89. 

  89.   </div>
    90. 

  90. </div>
    91. 

  91. <script type="text/javascript">
    92. 

  92. $(document).ready(function(){initNavTree('referenceImplementation.html','');});
    93. 

  93. </script>
    94. 

  94. <div id="doc-content">
    95. 

  95. <!-- window showing the filter options -->
    96. 

  96. <div id="MSearchSelectWindow"
    97. 

  97.      onmouseover="return searchBox.OnSearchSelectShow()"
    98. 

  98.      onmouseout="return searchBox.OnSearchSelectHide()"
    99. 

  99.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    100. 

  100. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
    101. 

  101. 

  102. <!-- iframe showing the search results (closed by default) -->
    103. 

  103. <div id="MSearchResultsWindow">
    104. 

  104. <iframe src="javascript:void(0)" frameborder="0" 
    105. 

  105.         name="MSearchResults" id="MSearchResults">
    106. 

  106. </iframe>
    107. 

  107. </div>
    108. 

  108. 

  109. <div class="header">
    110. 

  110.   <div class="headertitle">
    111. 

  111. <div class="title">Reference Implementation </div>  </div>
    112. 

  112. </div><!--header-->
    113. 

  113. <div class="contents">
    114. 

  114. <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>
    115. 

  115. <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>
    116. 

  116. <p>ARM offers also a Software Pack for CMSIS-Driver Validation as described in <a class="el" href="driverValidation.html">Driver Validation</a>.</p>
    117. 

  117. <h1><a class="anchor" id="DriverHeaderFiles"></a>
    118. 

  118. Driver Header Files</h1>
    119. 

  119. <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>
    120. 

  120. <p>The following header files are available in the directory <b>.\CMSIS\Driver\Include</b>.</p>
    121. 

  121. <table class="doxtable">
    122. 

  122. <tr>
    123. 

  123. <th>Header File </th><th>Description  </th></tr>
    124. 

  124. <tr>
    125. 

  125. <td>Driver_Common.h </td><td><a class="el" href="group__common__drv__gr.html">Common Driver Definitions</a> </td></tr>
    126. 

  126. <tr>
    127. 

  127. <td>Driver_CAN.h </td><td><a class="el" href="group__can__interface__gr.html">CAN Interface</a> </td></tr>
    128. 

  128. <tr>
    129. 

  129. <td>Driver_ETH.h </td><td><a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> </td></tr>
    130. 

  130. <tr>
    131. 

  131. <td>Driver_ETH_MAC.h </td><td><a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a> </td></tr>
    132. 

  132. <tr>
    133. 

  133. <td>Driver_ETH_PHY.h </td><td><a class="el" href="group__eth__phy__interface__gr.html">Ethernet PHY Interface</a> </td></tr>
    134. 

  134. <tr>
    135. 

  135. <td>Driver_Flash.h </td><td><a class="el" href="group__flash__interface__gr.html">Flash Interface</a> </td></tr>
    136. 

  136. <tr>
    137. 

  137. <td>Driver_I2C.h </td><td><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a> </td></tr>
    138. 

  138. <tr>
    139. 

  139. <td>Driver_MCI.h </td><td><a class="el" href="group__mci__interface__gr.html">MCI Interface</a> </td></tr>
    140. 

  140. <tr>
    141. 

  141. <td>Driver_NAND.h </td><td><a class="el" href="group__nand__interface__gr.html">NAND Interface</a> </td></tr>
    142. 

  142. <tr>
    143. 

  143. <td>Driver_SPI.h </td><td><a class="el" href="group__spi__interface__gr.html">SPI Interface</a> </td></tr>
    144. 

  144. <tr>
    145. 

  145. <td>Driver_Storage.h </td><td><a class="el" href="group__storage__interface__gr.html">Storage Interface</a> </td></tr>
    146. 

  146. <tr>
    147. 

  147. <td>Driver_SAI.h </td><td><a class="el" href="group__sai__interface__gr.html">SAI Interface</a> </td></tr>
    148. 

  148. <tr>
    149. 

  149. <td>Driver_USART.h </td><td><a class="el" href="group__usart__interface__gr.html">USART Interface</a> </td></tr>
    150. 

  150. <tr>
    151. 

  151. <td>Driver_USB.h </td><td><a class="el" href="group__usb__interface__gr.html">USB Interface</a> </td></tr>
    152. 

  152. <tr>
    153. 

  153. <td>Driver_USBD.h </td><td><a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a> </td></tr>
    154. 

  154. <tr>
    155. 

  155. <td>Driver_USBH.h </td><td><a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a> </td></tr>
    156. 

  156. <tr>
    157. 

  157. <td>Driver_WiFi.h </td><td><a class="el" href="group__wifi__interface__gr.html">WiFi Interface</a> </td></tr>
    158. 

  158. </table>
    159. 

  159. <h1><a class="anchor" id="DriverTemplates"></a>
    160. 

  160. Driver Template Files</h1>
    161. 

  161. <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>
    162. 

  162. <table class="doxtable">
    163. 

  163. <tr>
    164. 

  164. <th>Source File </th><th>Description  </th></tr>
    165. 

  165. <tr>
    166. 

  166. <td>Driver_CAN.c </td><td><a class="el" href="group__can__interface__gr.html">CAN Interface</a> </td></tr>
    167. 

  167. <tr>
    168. 

  168. <td>Driver_ETH_MAC.c </td><td><a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a> </td></tr>
    169. 

  169. <tr>
    170. 

  170. <td>Driver_ETH_PHY.c </td><td><a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a> </td></tr>
    171. 

  171. <tr>
    172. 

  172. <td>Driver_Flash.c </td><td><a class="el" href="group__flash__interface__gr.html">Flash Interface</a> </td></tr>
    173. 

  173. <tr>
    174. 

  174. <td>Driver_I2C.c </td><td><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a> </td></tr>
    175. 

  175. <tr>
    176. 

  176. <td>Driver_MCI.c </td><td><a class="el" href="group__mci__interface__gr.html">MCI Interface</a> </td></tr>
    177. 

  177. <tr>
    178. 

  178. <td>Driver_SAI.c </td><td><a class="el" href="group__sai__interface__gr.html">SAI Interface</a> </td></tr>
    179. 

  179. <tr>
    180. 

  180. <td>Driver_SPI.c </td><td><a class="el" href="group__spi__interface__gr.html">SPI Interface</a> </td></tr>
    181. 

  181. <tr>
    182. 

  182. <td>Driver_Storage.c </td><td><a class="el" href="group__storage__interface__gr.html">Storage Interface</a> </td></tr>
    183. 

  183. <tr>
    184. 

  184. <td>Driver_USART.c </td><td><a class="el" href="group__usart__interface__gr.html">USART Interface</a> </td></tr>
    185. 

  185. <tr>
    186. 

  186. <td>Driver_USBD.c </td><td><a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a> </td></tr>
    187. 

  187. <tr>
    188. 

  188. <td>Driver_USBH.c </td><td><a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a> </td></tr>
    189. 

  189. </table>
    190. 

  190. <h1><a class="anchor" id="DriverExamples"></a>
    191. 

  191. Driver Examples</h1>
    192. 

  192. <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>
    193. 

  193. <table class="doxtable">
    194. 

  194. <tr>
    195. 

  195. <th>Source File </th><th>Header File </th><th>Description  </th></tr>
    196. 

  196. <tr>
    197. 

  197. <td>EMAC_LPC18xx.c </td><td>EMAC_LPC18xx.h </td><td><a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a> </td></tr>
    198. 

  198. <tr>
    199. 

  199. <td>SSP_LPC18xx.c </td><td>SSP_LPC18xx.h </td><td><a class="el" href="group__spi__interface__gr.html">SPI Interface</a> </td></tr>
    200. 

  200. <tr>
    201. 

  201. <td>I2C_LPC18xx.c </td><td>I2C_LPC18xx.h </td><td><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a> </td></tr>
    202. 

  202. <tr>
    203. 

  203. <td>I2S_LPC18xx.c </td><td>I2S_LPC18xx.h </td><td><a class="el" href="group__sai__interface__gr.html">SAI Interface</a> </td></tr>
    204. 

  204. <tr>
    205. 

  205. <td>MCI_LPC18xx.c </td><td>MCI_LPC18xx.h </td><td><a class="el" href="group__mci__interface__gr.html">MCI Interface</a> </td></tr>
    206. 

  206. <tr>
    207. 

  207. <td>USART_LPC18xx.c </td><td>USART_LPC18xx.h </td><td><a class="el" href="group__usart__interface__gr.html">USART Interface</a> </td></tr>
    208. 

  208. <tr>
    209. 

  209. <td>USBn_LPC18xx.c </td><td>USB_LPC18xx.h </td><td>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>
    210. 

  210. <tr>
    211. 

  211. <td>USBDn_LPC18xx.c </td><td><em>none</em> </td><td><a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a> </td></tr>
    212. 

  212. <tr>
    213. 

  213. <td>USBHn_LPC18xx.c </td><td><em>none</em> </td><td><a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a> </td></tr>
    214. 

  214. </table>
    215. 

  215. <p>These CMSIS-Drivers use additional modules for GPIO and DMA control:</p>
    216. 

  216. <table class="doxtable">
    217. 

  217. <tr>
    218. 

  218. <th>Source File </th><th>Header File </th><th>Description  </th></tr>
    219. 

  219. <tr>
    220. 

  220. <td>GPIO_LPC18xx.c </td><td>GPIO_LPC18xx.h </td><td>GPIO Interface for LPC1800 series </td></tr>
    221. 

  221. <tr>
    222. 

  222. <td>GPDMA_LPC18xx.c </td><td><em>none</em> </td><td>DMA Interface for LPC1800 series </td></tr>
    223. 

  223. <tr>
    224. 

  224. <td>SCU_LPC18xx.c </td><td>SCU_LPC18xx.h </td><td>SCU Interface for LPC1800 series </td></tr>
    225. 

  225. </table>
    226. 

  226. <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>
    227. 

  227. <p>Further driver reference implementations are available in Device Family Packs (DFP) labeled with version 2.0.0 or higher. </p>
    228. 

  228. </div></div><!-- contents -->
    229. 

  229. </div><!-- doc-content -->
    230. 

  230. <!-- start footer part -->
    231. 

  231. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    232. 

  232.   <ul>
    233. 

  233.     <li class="footer">Generated on Mon Mar 18 2019 16:05:35 for CMSIS-Driver by Arm Ltd. All rights reserved.
    234. 

  234. 	<!--
    235. 

  235.     <a href="http://www.doxygen.org/index.html">
    236. 

  236.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
    237. 

  237. 	-->
    238. 

  238. 	</li>
    239. 

  239.   </ul>
    240. 

  240. </div>
    241. 

  241. </body>
    242. 

  242. </html>
    243.