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