begriffs open source - cmsis/blob - v6.1.0-rc0/Driver/Driver__Flash_8h.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: Driver_Flash.h File Reference</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('Driver__Flash_8h.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 class="header">
 127   <div class="summary">
 128 <a href="#nested-classes">Data Structures</a> &#124;
 129 <a href="#define-members">Macros</a> &#124;
 130 <a href="#typedef-members">Typedefs</a>  </div>
 131   <div class="headertitle"><div class="title">Driver_Flash.h File Reference</div></div>
 132 </div><!--header-->
 133 <div class="contents">
 134 <table class="memberdecls">
 135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 136 Data Structures</h2></td></tr>
 137 <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>
 138 <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>
 139 <tr class="separator:structARM__FLASH__SECTOR"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <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>
 141 <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>
 142 <tr class="separator:structARM__FLASH__INFO"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <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>
 144 <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>
 145 <tr class="separator:structARM__FLASH__STATUS"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <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>
 147 <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>
 148 <tr class="separator:structARM__FLASH__CAPABILITIES"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <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>
 150 <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>
 151 <tr class="separator:structARM__DRIVER__FLASH"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 </table><table class="memberdecls">
 153 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 154 Macros</h2></td></tr>
 155 <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,3)  /* API version */</td></tr>
 156 <tr class="separator:a16e58dce04f3f65d5183c973c9189fa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <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>
 158 <tr class="separator:a0955bb54d18c78992e20395e32c537e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <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>
 160 <tr class="separator:afda179843b93526222e15d61f226ac8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <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>
 162 <tr class="separator:aaeb2830d80f8aca0eaf72e3718537a60"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 <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>
 164 <tr class="memdesc:gaf7a9c4ad125ee90df35907d861151e23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flash Ready.  <br /></td></tr>
 165 <tr class="separator:gaf7a9c4ad125ee90df35907d861151e23"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 <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>
 167 <tr class="memdesc:ga0dfea52761c0eed83e5d73e7a7f69962"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read/Program/Erase Error.  <br /></td></tr>
 168 <tr class="separator:ga0dfea52761c0eed83e5d73e7a7f69962"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 </table><table class="memberdecls">
 170 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 171 Typedefs</h2></td></tr>
 172 <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>
 173 <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.  <br /></td></tr>
 174 <tr class="separator:gabeb4ad43b1e6fa4ed956cd5c9371d327"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 </table>
 176 <h2 class="groupheader">Macro Definition Documentation</h2>
 177 <a id="a16e58dce04f3f65d5183c973c9189fa4" name="a16e58dce04f3f65d5183c973c9189fa4"></a>
 178 <h2 class="memtitle"><span class="permalink"><a href="#a16e58dce04f3f65d5183c973c9189fa4">&#9670;&#160;</a></span>ARM_FLASH_API_VERSION</h2>
 179
 180 <div class="memitem">
 181 <div class="memproto">
 182       <table class="memname">
 183         <tr>
 184           <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,3)  /* API version */</td>
 185         </tr>
 186       </table>
 187 </div><div class="memdoc">
 188
 189 </div>
 190 </div>
 191 <a id="a0955bb54d18c78992e20395e32c537e6" name="a0955bb54d18c78992e20395e32c537e6"></a>
 192 <h2 class="memtitle"><span class="permalink"><a href="#a0955bb54d18c78992e20395e32c537e6">&#9670;&#160;</a></span>_ARM_Driver_Flash_</h2>
 193
 194 <div class="memitem">
 195 <div class="memproto">
 196       <table class="memname">
 197         <tr>
 198           <td class="memname">#define _ARM_Driver_Flash_</td>
 199           <td>(</td>
 200           <td class="paramtype">&#160;</td>
 201           <td class="paramname">n</td><td>)</td>
 202           <td>&#160;&#160;&#160;Driver_Flash##n</td>
 203         </tr>
 204       </table>
 205 </div><div class="memdoc">
 206
 207 </div>
 208 </div>
 209 <a id="afda179843b93526222e15d61f226ac8f" name="afda179843b93526222e15d61f226ac8f"></a>
 210 <h2 class="memtitle"><span class="permalink"><a href="#afda179843b93526222e15d61f226ac8f">&#9670;&#160;</a></span>ARM_Driver_Flash_</h2>
 211
 212 <div class="memitem">
 213 <div class="memproto">
 214       <table class="memname">
 215         <tr>
 216           <td class="memname">#define ARM_Driver_Flash_</td>
 217           <td>(</td>
 218           <td class="paramtype">&#160;</td>
 219           <td class="paramname">n</td><td>)</td>
 220           <td>&#160;&#160;&#160;<a class="el" href="Driver__Flash_8h.html#a0955bb54d18c78992e20395e32c537e6">_ARM_Driver_Flash_</a>(n)</td>
 221         </tr>
 222       </table>
 223 </div><div class="memdoc">
 224
 225 </div>
 226 </div>
 227 <a id="aaeb2830d80f8aca0eaf72e3718537a60" name="aaeb2830d80f8aca0eaf72e3718537a60"></a>
 228 <h2 class="memtitle"><span class="permalink"><a href="#aaeb2830d80f8aca0eaf72e3718537a60">&#9670;&#160;</a></span>ARM_FLASH_SECTOR_INFO</h2>
 229
 230 <div class="memitem">
 231 <div class="memproto">
 232       <table class="memname">
 233         <tr>
 234           <td class="memname">#define ARM_FLASH_SECTOR_INFO</td>
 235           <td>(</td>
 236           <td class="paramtype">&#160;</td>
 237           <td class="paramname">addr, </td>
 238         </tr>
 239         <tr>
 240           <td class="paramkey"></td>
 241           <td></td>
 242           <td class="paramtype">&#160;</td>
 243           <td class="paramname">size&#160;</td>
 244         </tr>
 245         <tr>
 246           <td></td>
 247           <td>)</td>
 248           <td></td><td>&#160;&#160;&#160;{ (addr), (addr)+(size)-1 }</td>
 249         </tr>
 250       </table>
 251 </div><div class="memdoc">
 252
 253 </div>
 254 </div>
 255 </div><!-- contents -->
 256 </div><!-- doc-content -->
 257 <!-- start footer part -->
 258 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 259   <ul>
 260     <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>
 261     <li class="footer">
 262       <script type="text/javascript">
 263         <!--
 264         writeFooter.call(this);
 265         //-->
 266       </script>
 267     </li>
 268   </ul>
 269 </div>
 270 </body>
 271 </html>