Driver__Flash_8h.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>Driver_Flash.h File Reference</title>
  7. <title>CMSIS-Driver: Driver_Flash.h File Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.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="printComponentTabs.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="resize.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-Driver
  35. &#160;<span id="projectnumber">Version 2.7.0</span>
  36. </div>
  37. <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('Driver__Flash_8h.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  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. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#nested-classes">Data Structures</a> &#124;
  110. <a href="#define-members">Macros</a> &#124;
  111. <a href="#typedef-members">Typedefs</a> </div>
  112. <div class="headertitle">
  113. <div class="title">Driver_Flash.h File Reference</div> </div>
  114. </div><!--header-->
  115. <div class="contents">
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  118. Data Structures</h2></td></tr>
  119. <tr class="memitem:structARM__FLASH__SECTOR"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__SECTOR">ARM_FLASH_SECTOR</a></td></tr>
  120. <tr class="memdesc:structARM__FLASH__SECTOR"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flash Sector information. <a href="group__flash__interface__gr.html#structARM__FLASH__SECTOR">More...</a><br/></td></tr>
  121. <tr class="separator:structARM__FLASH__SECTOR"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:structARM__FLASH__INFO"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__INFO">ARM_FLASH_INFO</a></td></tr>
  123. <tr class="memdesc:structARM__FLASH__INFO"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flash information. <a href="group__flash__interface__gr.html#structARM__FLASH__INFO">More...</a><br/></td></tr>
  124. <tr class="separator:structARM__FLASH__INFO"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:structARM__FLASH__STATUS"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__STATUS">ARM_FLASH_STATUS</a></td></tr>
  126. <tr class="memdesc:structARM__FLASH__STATUS"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flash Status. <a href="group__flash__interface__gr.html#structARM__FLASH__STATUS">More...</a><br/></td></tr>
  127. <tr class="separator:structARM__FLASH__STATUS"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:structARM__FLASH__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">ARM_FLASH_CAPABILITIES</a></td></tr>
  129. <tr class="memdesc:structARM__FLASH__CAPABILITIES"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flash Driver Capabilities. <a href="group__flash__interface__gr.html#structARM__FLASH__CAPABILITIES">More...</a><br/></td></tr>
  130. <tr class="separator:structARM__FLASH__CAPABILITIES"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:structARM__DRIVER__FLASH"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#structARM__DRIVER__FLASH">ARM_DRIVER_FLASH</a></td></tr>
  132. <tr class="memdesc:structARM__DRIVER__FLASH"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access structure of the Flash Driver. <a href="group__flash__interface__gr.html#structARM__DRIVER__FLASH">More...</a><br/></td></tr>
  133. <tr class="separator:structARM__DRIVER__FLASH"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table><table class="memberdecls">
  135. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  136. Macros</h2></td></tr>
  137. <tr class="memitem:a16e58dce04f3f65d5183c973c9189fa4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Flash_8h.html#a16e58dce04f3f65d5183c973c9189fa4">ARM_FLASH_API_VERSION</a>&#160;&#160;&#160;<a class="el" href="Driver__Common_8h.html#a43c7ca1eb0786d818624246c09932a74">ARM_DRIVER_VERSION_MAJOR_MINOR</a>(2,2) /* API version */</td></tr>
  138. <tr class="separator:a16e58dce04f3f65d5183c973c9189fa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a0955bb54d18c78992e20395e32c537e6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Flash_8h.html#a0955bb54d18c78992e20395e32c537e6">_ARM_Driver_Flash_</a>(n)&#160;&#160;&#160;Driver_Flash##n</td></tr>
  140. <tr class="separator:a0955bb54d18c78992e20395e32c537e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:afda179843b93526222e15d61f226ac8f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Flash_8h.html#afda179843b93526222e15d61f226ac8f">ARM_Driver_Flash_</a>(n)&#160;&#160;&#160;<a class="el" href="Driver__Flash_8h.html#a0955bb54d18c78992e20395e32c537e6">_ARM_Driver_Flash_</a>(n)</td></tr>
  142. <tr class="separator:afda179843b93526222e15d61f226ac8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:aaeb2830d80f8aca0eaf72e3718537a60"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__Flash_8h.html#aaeb2830d80f8aca0eaf72e3718537a60">ARM_FLASH_SECTOR_INFO</a>(addr, size)&#160;&#160;&#160;{ (addr), (addr)+(size)-1 }</td></tr>
  144. <tr class="separator:aaeb2830d80f8aca0eaf72e3718537a60"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:gaf7a9c4ad125ee90df35907d861151e23"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Flash__events.html#gaf7a9c4ad125ee90df35907d861151e23">ARM_FLASH_EVENT_READY</a>&#160;&#160;&#160;(1UL &lt;&lt; 0)</td></tr>
  146. <tr class="memdesc:gaf7a9c4ad125ee90df35907d861151e23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flash Ready. <a href="group__Flash__events.html#gaf7a9c4ad125ee90df35907d861151e23">More...</a><br/></td></tr>
  147. <tr class="separator:gaf7a9c4ad125ee90df35907d861151e23"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:ga0dfea52761c0eed83e5d73e7a7f69962"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Flash__events.html#ga0dfea52761c0eed83e5d73e7a7f69962">ARM_FLASH_EVENT_ERROR</a>&#160;&#160;&#160;(1UL &lt;&lt; 1)</td></tr>
  149. <tr class="memdesc:ga0dfea52761c0eed83e5d73e7a7f69962"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read/Program/Erase Error. <a href="group__Flash__events.html#ga0dfea52761c0eed83e5d73e7a7f69962">More...</a><br/></td></tr>
  150. <tr class="separator:ga0dfea52761c0eed83e5d73e7a7f69962"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. </table><table class="memberdecls">
  152. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  153. Typedefs</h2></td></tr>
  154. <tr class="memitem:gabeb4ad43b1e6fa4ed956cd5c9371d327"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flash__interface__gr.html#gabeb4ad43b1e6fa4ed956cd5c9371d327">ARM_Flash_SignalEvent_t</a> )(uint32_t event)</td></tr>
  155. <tr class="memdesc:gabeb4ad43b1e6fa4ed956cd5c9371d327"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a">ARM_Flash_SignalEvent</a> : Signal Flash Event. <a href="group__flash__interface__gr.html#gabeb4ad43b1e6fa4ed956cd5c9371d327">More...</a><br/></td></tr>
  156. <tr class="separator:gabeb4ad43b1e6fa4ed956cd5c9371d327"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. </table>
  158. <h2 class="groupheader">Macro Definition Documentation</h2>
  159. <a class="anchor" id="a16e58dce04f3f65d5183c973c9189fa4"></a>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <table class="memname">
  163. <tr>
  164. <td class="memname">#define ARM_FLASH_API_VERSION&#160;&#160;&#160;<a class="el" href="Driver__Common_8h.html#a43c7ca1eb0786d818624246c09932a74">ARM_DRIVER_VERSION_MAJOR_MINOR</a>(2,2) /* API version */</td>
  165. </tr>
  166. </table>
  167. </div><div class="memdoc">
  168. </div>
  169. </div>
  170. <a class="anchor" id="a0955bb54d18c78992e20395e32c537e6"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">#define _ARM_Driver_Flash_</td>
  176. <td>(</td>
  177. <td class="paramtype">&#160;</td>
  178. <td class="paramname">n</td><td>)</td>
  179. <td>&#160;&#160;&#160;Driver_Flash##n</td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. </div>
  184. </div>
  185. <a class="anchor" id="afda179843b93526222e15d61f226ac8f"></a>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">#define ARM_Driver_Flash_</td>
  191. <td>(</td>
  192. <td class="paramtype">&#160;</td>
  193. <td class="paramname">n</td><td>)</td>
  194. <td>&#160;&#160;&#160;<a class="el" href="Driver__Flash_8h.html#a0955bb54d18c78992e20395e32c537e6">_ARM_Driver_Flash_</a>(n)</td>
  195. </tr>
  196. </table>
  197. </div><div class="memdoc">
  198. </div>
  199. </div>
  200. <a class="anchor" id="aaeb2830d80f8aca0eaf72e3718537a60"></a>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">#define ARM_FLASH_SECTOR_INFO</td>
  206. <td>(</td>
  207. <td class="paramtype">&#160;</td>
  208. <td class="paramname">addr, </td>
  209. </tr>
  210. <tr>
  211. <td class="paramkey"></td>
  212. <td></td>
  213. <td class="paramtype">&#160;</td>
  214. <td class="paramname">size&#160;</td>
  215. </tr>
  216. <tr>
  217. <td></td>
  218. <td>)</td>
  219. <td></td><td>&#160;&#160;&#160;{ (addr), (addr)+(size)-1 }</td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. </div>
  224. </div>
  225. </div><!-- contents -->
  226. </div><!-- doc-content -->
  227. <!-- start footer part -->
  228. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  229. <ul>
  230. <li class="navelem"><a class="el" href="dir_7151b3cc910409bb744bd274374c738d.html">Driver</a></li><li class="navelem"><a class="el" href="dir_9c39448ea46a8e15f1aabc7dec307fcf.html">Include</a></li><li class="navelem"><a class="el" href="Driver__Flash_8h.html">Driver_Flash.h</a></li>
  231. <li class="footer">Generated on Mon Mar 18 2019 16:05:34 for CMSIS-Driver by Arm Ltd. All rights reserved.
  232. <!--
  233. <a href="http://www.doxygen.org/index.html">
  234. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  235. -->
  236. </li>
  237. </ul>
  238. </div>
  239. </body>
  240. </html>