Startseite Erkunden Hilfe
Anmelden
ARM-software
/
CMSIS_5
Mirror von https://github-proxy.rt-thread.io/ARM-software/CMSIS_5.git
2
0
Fork 0
Dateien Issues 0 Wiki
Struktur: c5ff98f525
Branches Tags
CMSIS_5
/
docs
/
Pack
/
html
/
algorithmFunc.html

algorithmFunc.html 26 KB
Verlauf Originalformat

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439 
  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>Algorithm Functions</title>
    7. 

  7. <title>CMSIS-Pack: Algorithm Functions</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-Pack
    35. 

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

  36.    </div>
    37. 

  37.    <div id="projectbrief">Delivery Mechanism for Software Packs</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>
    62. 

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

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

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

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

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

  67.                alt=""/>
    68. 

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

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

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

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

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

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

  74.           </span>
    75. 

  75.         </div>
    76. 

  76.       </li>
    77. 

  77.     </ul>
    78. 

  78.   </div>
    79. 

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

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

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

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

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

  84.     </div>
    85. 

  85.   </div>
    86. 

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

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

  88.   </div>
    89. 

  89. </div>
    90. 

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

  91. $(document).ready(function(){initNavTree('algorithmFunc.html','');});
    92. 

  92. </script>
    93. 

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

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

  95. <div id="MSearchSelectWindow"
    96. 

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

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

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

  99. <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>Pages</a></div>
    100. 

  100. 

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

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

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

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

  105. </iframe>
    106. 

  106. </div>
    107. 

  107. 

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

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

  110. <div class="title">Algorithm Functions </div>  </div>
    111. 

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

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

  113. <div class="textblock"><p>Blank Check</p>
    114. 

  114. <p>The following functions are available for creating new Flash programming algorithms: </p>
    115. 

  115. <table class="doxtable">
    116. 

  116. <tr>
    117. 

  117. <th>Function Name </th><th>Indication </th><th>Description  </th></tr>
    118. 

  118. <tr>
    119. 

  119. <td><a class="el" href="algorithmFunc.html#BlankCheck">BlankCheck</a> </td><td>optional </td><td>Check and compare patterns. </td></tr>
    120. 

  120. <tr>
    121. 

  121. <td><a class="el" href="algorithmFunc.html#EraseChip">EraseChip</a> </td><td>optional </td><td>Delete entire Flash memory content. </td></tr>
    122. 

  122. <tr>
    123. 

  123. <td><a class="el" href="algorithmFunc.html#EraseSector">EraseSector</a> </td><td>mandatory </td><td>Delete Flash memory content of a specific sector. </td></tr>
    124. 

  124. <tr>
    125. 

  125. <td><a class="el" href="algorithmFunc.html#Init">Init</a> </td><td>mandatory </td><td>Initialize and prepare device for Flash programming. </td></tr>
    126. 

  126. <tr>
    127. 

  127. <td><a class="el" href="algorithmFunc.html#ProgramPage">ProgramPage</a> </td><td>mandatory </td><td>Write the application into the Flash memory. </td></tr>
    128. 

  128. <tr>
    129. 

  129. <td><a class="el" href="algorithmFunc.html#UnInit">UnInit</a> </td><td>mandatory </td><td>De-initialize the microcontroller after one of the Flash programming steps. </td></tr>
    130. 

  130. <tr>
    131. 

  131. <td><a class="el" href="algorithmFunc.html#Verify">Verify</a> </td><td>optional </td><td>Compare Flash memory content with the program code. </td></tr>
    132. 

  132. </table>
    133. 

  133. <p>The following diagrams show how the functions of the <b>Flash Programming Algorithms</b> are executed by a development tool.</p>
    134. 

  134. <p>The <b>Flash Erase</b> sequence is executed to erase the Flash content.</p>
    135. 

  135. <div class="image">
    136. 

  136. <img src="FlashErase.png" alt="FlashErase.png"/>
    137. 

  137. <div class="caption">
    138. 

  138. Flash Erase</div></div>
    139. 

  139. <p> The <b>Flash Program</b> sequence is executed to program the Flash memory.</p>
    140. 

  140. <div class="image">
    141. 

  141. <img src="FlashProgram.png" alt="FlashProgram.png"/>
    142. 

  142. <div class="caption">
    143. 

  143. Flash Program</div></div>
    144. 

  144. <p> The <b>Flash Verify</b> sequence is executed to verify the content after flash programming.</p>
    145. 

  145. <div class="image">
    146. 

  146. <img src="FlashVerify.png" alt="FlashVerify.png"/>
    147. 

  147. <div class="caption">
    148. 

  148. Flash Verify</div></div>
    149. 

  149.  <p>&#160;</p>
    150. 

  150. <hr/>
    151. 

  151. <h1><a class="anchor" id="BlankCheck"></a>
    152. 

  152. BlankCheck</h1>
    153. 

  153. <div class="fragment"><div class="line"><span class="keywordtype">int</span> BlankCheck (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> adr, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> sz, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> pat);</div>
    154. 

  154. </div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
    155. 

  155.   <table class="params">
    156. 

  156.     <tr><td class="paramname">adr</td><td>Block start address </td></tr>
    157. 

  157.     <tr><td class="paramname">sz</td><td>Block size in bytes </td></tr>
    158. 

  158.     <tr><td class="paramname">pat</td><td>Pattern to compare </td></tr>
    159. 

  159.   </table>
    160. 

  160.   </dd>
    161. 

  161. </dl>
    162. 

  162. <dl class="section return"><dt>Returns</dt><dd>status information:<ul>
    163. 

  163. <li>0 when the block content is equal to the pattern pat.</li>
    164. 

  164. <li>1 when the block content differs from the pattern pat.</li>
    165. 

  165. </ul>
    166. 

  166. </dd></dl>
    167. 

  167. <p>The function <b>BlankCheck</b> can be used to check whether the specified block is empty, or whether the content is equal to a specific pattern defined in the argument <em>pat</em>.</p>
    168. 

  168. <p>The argument <em>adr</em> specifies the start address of the block that is to be verified.</p>
    169. 

  169. <p>The argument <em>sz</em> specifies the size of the block that is to be verified.</p>
    170. 

  170. <p><b>Code Example</b> </p>
    171. 

  171. <div class="fragment"><div class="line"><span class="keywordtype">int</span> BlankCheck (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> adr, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> sz, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> pat) {</div>
    172. 

  172. <div class="line"> </div>
    173. 

  173. <div class="line">  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> i, j, k;</div>
    174. 

  174. <div class="line"> </div>
    175. 

  175. <div class="line">  <span class="comment">// Recalculate address for External SDRAM addresses</span></div>
    176. 

  176. <div class="line">  <span class="keywordflow">if</span> (adr &gt;= SDRAM_START)</div>
    177. 

  177. <div class="line">    adr = adr - SDRAM_START + USER_OFFSET;</div>
    178. 

  178. <div class="line"> </div>
    179. 

  179. <div class="line">  <span class="keywordflow">for</span> (i = 0; i &lt; sz; i += 256) {</div>
    180. 

  180. <div class="line">    <span class="comment">// Read 256 bytes</span></div>
    181. 

  181. <div class="line">    ReadPage_HW (adr+i, 256, &amp;rd_buf[0]);</div>
    182. 

  182. <div class="line"> </div>
    183. 

  183. <div class="line">    <span class="comment">// Determine size to compare</span></div>
    184. 

  184. <div class="line">    <span class="keywordflow">if</span> ((sz-i) &gt;= 256) k = 256;</div>
    185. 

  185. <div class="line">    <span class="keywordflow">else</span>               k = (sz-i);</div>
    186. 

  186. <div class="line"> </div>
    187. 

  187. <div class="line">    <span class="comment">// Check up to 256 bytes if equal to pattern &quot;pat&quot;</span></div>
    188. 

  188. <div class="line">    <span class="keywordflow">for</span> (j = 0; j &lt; k; j++)</div>
    189. 

  189. <div class="line">      <span class="keywordflow">if</span> (rd_buf[j] != pat) <span class="keywordflow">return</span> (1); <span class="comment">// Memory is not blank</span></div>
    190. 

  190. <div class="line">  }</div>
    191. 

  191. <div class="line"> </div>
    192. 

  192. <div class="line">  <span class="keywordflow">return</span> (0);                           <span class="comment">// Memory is blank</span></div>
    193. 

  193. <div class="line">}</div>
    194. 

  194. </div><!-- fragment --><p>&#160;</p>
    195. 

  195. <hr/>
    196. 

  196. <h1><a class="anchor" id="EraseChip"></a>
    197. 

  197. EraseChip</h1>
    198. 

  198. <div class="fragment"><div class="line"><span class="keywordtype">int</span> EraseChip (<span class="keywordtype">void</span>);</div>
    199. 

  199. </div><!-- fragment --> <dl class="section return"><dt>Returns</dt><dd>status information:<ul>
    200. 

  200. <li>0 on success.</li>
    201. 

  201. <li>1 on failure.</li>
    202. 

  202. </ul>
    203. 

  203. </dd></dl>
    204. 

  204. <p>The function <b>EraseChip</b> deletes the content of the entire Flash memory. It is invoked whenever the uVision menu <b>Flash</b> - <b>Erase</b> is used, or whenever an attempt is made to download the program to Flash and the option <b>Erase Full Chip</b> has been set in the <b>Flash Download Setup</b> dialog. If this function is missing in the Flash Programming Algorithm, the <a class="el" href="algorithmFunc.html#EraseSector">EraseSector</a> function is executed until the entire content of the Flash memory area has been deleted.</p>
    205. 

  205. <p><b>Code Example</b> </p>
    206. 

  206. <div class="fragment"><div class="line"><span class="keywordtype">int</span> EraseChip (<span class="keywordtype">void</span>) {</div>
    207. 

  207. <div class="line"> </div>
    208. 

  208. <div class="line">  FLASH-&gt;CR |=  FLASH_MER;                      <span class="comment">// Mass Erase Enabled</span></div>
    209. 

  209. <div class="line">  FLASH-&gt;CR |=  FLASH_STRT;                     <span class="comment">// Start Erase</span></div>
    210. 

  210. <div class="line"> </div>
    211. 

  211. <div class="line">  <span class="keywordflow">while</span> (FLASH-&gt;SR &amp; FLASH_BSY) {</div>
    212. 

  212. <div class="line">    IWDG-&gt;KR = 0xAAAA;                          <span class="comment">// Reload IWDG</span></div>
    213. 

  213. <div class="line">  }</div>
    214. 

  214. <div class="line"> </div>
    215. 

  215. <div class="line">  FLASH-&gt;CR &amp;= ~FLASH_MER;                      <span class="comment">// Mass Erase Disabled</span></div>
    216. 

  216. <div class="line"> </div>
    217. 

  217. <div class="line">  <span class="keywordflow">return</span> (0);                                   <span class="comment">// Done</span></div>
    218. 

  218. <div class="line">}</div>
    219. 

  219. </div><!-- fragment --><p>&#160;</p>
    220. 

  220. <hr/>
    221. 

  221. <h1><a class="anchor" id="EraseSector"></a>
    222. 

  222. EraseSector</h1>
    223. 

  223. <div class="fragment"><div class="line"><span class="keywordtype">int</span> EraseSector (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> adr);</div>
    224. 

  224. </div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
    225. 

  225.   <table class="params">
    226. 

  226.     <tr><td class="paramname">adr</td><td>Sector address </td></tr>
    227. 

  227.   </table>
    228. 

  228.   </dd>
    229. 

  229. </dl>
    230. 

  230. <dl class="section return"><dt>Returns</dt><dd>status information:<ul>
    231. 

  231. <li>0 on success.</li>
    232. 

  232. <li>1 on failure.</li>
    233. 

  233. </ul>
    234. 

  234. </dd></dl>
    235. 

  235. <p>The function <b>EraseSector</b> deletes the content of the sector starting at the address specified by the argument <em>adr</em>. The function is invoked whenever the uVision menu <b>Flash</b> - <b>Erase</b> is used, or whenever an attempt is made to download the program to Flash and the option <b>Erase Sectors</b> has been set in the <b>Flash Download Setup</b> dialog.</p>
    236. 

  236. <p><b>Code Example</b> </p>
    237. 

  237. <div class="fragment"><div class="line"><span class="keywordtype">int</span> EraseSector (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> adr) {</div>
    238. 

  238. <div class="line"> </div>
    239. 

  239. <div class="line">  FLASH-&gt;CR |=  FLASH_PER;                      <span class="comment">// Page Erase Enabled</span></div>
    240. 

  240. <div class="line">  FLASH-&gt;AR  =  adr;                            <span class="comment">// Page Address</span></div>
    241. 

  241. <div class="line">  FLASH-&gt;CR |=  FLASH_STRT;                     <span class="comment">// Start Erase</span></div>
    242. 

  242. <div class="line"> </div>
    243. 

  243. <div class="line">  <span class="keywordflow">while</span> (FLASH-&gt;SR &amp; FLASH_BSY) {</div>
    244. 

  244. <div class="line">    IWDG-&gt;KR = 0xAAAA;                          <span class="comment">// Reload IWDG</span></div>
    245. 

  245. <div class="line">  }</div>
    246. 

  246. <div class="line"> </div>
    247. 

  247. <div class="line">  FLASH-&gt;CR &amp;= ~FLASH_PER;                      <span class="comment">// Page Erase Disabled</span></div>
    248. 

  248. <div class="line"> </div>
    249. 

  249. <div class="line">  <span class="keywordflow">return</span> (0);                                   <span class="comment">// Done</span></div>
    250. 

  250. <div class="line">}</div>
    251. 

  251. </div><!-- fragment --><p>&#160;</p>
    252. 

  252. <hr/>
    253. 

  253. <h1><a class="anchor" id="Init"></a>
    254. 

  254. Init</h1>
    255. 

  255. <div class="fragment"><div class="line"><span class="keywordtype">int</span> Init (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> adr, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> clk, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> fnc);</div>
    256. 

  256. </div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
    257. 

  257.   <table class="params">
    258. 

  258.     <tr><td class="paramname">adr</td><td>Device base address </td></tr>
    259. 

  259.     <tr><td class="paramname">clk</td><td>Clock frequency (Hz) </td></tr>
    260. 

  260.     <tr><td class="paramname">fnc</td><td>Function code </td></tr>
    261. 

  261.   </table>
    262. 

  262.   </dd>
    263. 

  263. </dl>
    264. 

  264. <dl class="section return"><dt>Returns</dt><dd>status information:<ul>
    265. 

  265. <li>0 on success.</li>
    266. 

  266. <li>1 on failure.</li>
    267. 

  267. </ul>
    268. 

  268. </dd></dl>
    269. 

  269. <p>The function <b>Init</b> initializes the microcontroller for Flash programming. It is invoked whenever an attempt is made to download the program to Flash.</p>
    270. 

  270. <p>The argument <em>adr</em> specifies the base address of the device.</p>
    271. 

  271. <p>The argument <em>clk</em> specifies the clock frequency for prgramming the device.</p>
    272. 

  272. <p>The argument <em>fnc</em> is a number:</p>
    273. 

  273. <ul>
    274. 

  274. <li>1 stands for Erase.</li>
    275. 

  275. <li>2 stands for Program.</li>
    276. 

  276. <li>3 stands for Verify.</li>
    277. 

  277. </ul>
    278. 

  278. <p>Thus, different initialization sections can be implemented for each individual Flash programming step.</p>
    279. 

  279. <p><b>Code Example</b> </p>
    280. 

  280. <div class="fragment"><div class="line"><span class="keywordtype">int</span> Init (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> adr, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> clk, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> fnc) {</div>
    281. 

  281. <div class="line"> </div>
    282. 

  282. <div class="line">  <span class="comment">// Zero Wait State</span></div>
    283. 

  283. <div class="line">  FLASH-&gt;ACR  = 0x00000000;</div>
    284. 

  284. <div class="line"> </div>
    285. 

  285. <div class="line">  <span class="comment">// Unlock Flash</span></div>
    286. 

  286. <div class="line">  FLASH-&gt;KEYR = FLASH_KEY1;</div>
    287. 

  287. <div class="line">  FLASH-&gt;KEYR = FLASH_KEY2;</div>
    288. 

  288. <div class="line"> </div>
    289. 

  289. <div class="line">  <span class="comment">// Test if IWDG is running (IWDG in HW mode)</span></div>
    290. 

  290. <div class="line">  <span class="keywordflow">if</span> ((FLASH-&gt;OBR &amp; 0x04) == 0x00) {</div>
    291. 

  291. <div class="line">    <span class="comment">// Set IWDG time out to ~32.768 second</span></div>
    292. 

  292. <div class="line">    IWDG-&gt;KR  = 0x5555; <span class="comment">// Enable write access to IWDG_PR and IWDG_RLR</span></div>
    293. 

  293. <div class="line">    IWDG-&gt;PR  = 0x06;   <span class="comment">// Set prescaler to 256</span></div>
    294. 

  294. <div class="line">    IWDG-&gt;RLR = 4095;   <span class="comment">// Set reload value to 4095</span></div>
    295. 

  295. <div class="line">  }</div>
    296. 

  296. <div class="line"> </div>
    297. 

  297. <div class="line">  <span class="keywordflow">return</span> (0);</div>
    298. 

  298. <div class="line">}</div>
    299. 

  299. </div><!-- fragment --><p>&#160;</p>
    300. 

  300. <hr/>
    301. 

  301. <h1><a class="anchor" id="ProgramPage"></a>
    302. 

  302. ProgramPage</h1>
    303. 

  303. <div class="fragment"><div class="line"><span class="keywordtype">int</span> ProgramPage (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> adr, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> sz, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf);</div>
    304. 

  304. </div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
    305. 

  305.   <table class="params">
    306. 

  306.     <tr><td class="paramname">adr</td><td>Page start address </td></tr>
    307. 

  307.     <tr><td class="paramname">sz</td><td>Page size </td></tr>
    308. 

  308.     <tr><td class="paramname">buf</td><td>Data to be written </td></tr>
    309. 

  309.   </table>
    310. 

  310.   </dd>
    311. 

  311. </dl>
    312. 

  312. <dl class="section return"><dt>Returns</dt><dd>status information:<ul>
    313. 

  313. <li>0 on success.</li>
    314. 

  314. <li>1 on failure.</li>
    315. 

  315. </ul>
    316. 

  316. </dd></dl>
    317. 

  317. <p>The function <b>ProgramPage</b> is used to write code into the Flash memory. It is invoked to download a program to Flash. As Flash memory is typically organized in blocks or pages, the parameters to the function <b>ProgramPage</b> must not cross alignment boundaries of these flash pages. The page size is specified in the struct FlashDevice with the value <b>Program Page Size</b>.</p>
    318. 

  318. <p>The argument <em>adr</em> specifies the start address of the page that is to be programmed. It is aligned by the host programming system to a start address of a flash page.</p>
    319. 

  319. <p>The argument <em>sz</em> specifies the data size in the data buffer. The host programming system ensures that page boundaries are not crossed.</p>
    320. 

  320. <p>The argument <em>buf</em> points to the data buffer containing the data to be programmed.</p>
    321. 

  321. <dl class="section note"><dt>Note</dt><dd>The host programming system ensures that the argument <em>adr</em> + <em>sz</em> never crosses any page boundary. The function <b>ProgramPage</b> does therefore not require any provisions for that.</dd></dl>
    322. 

  322. <p><b>Code Example</b> </p>
    323. 

  323. <div class="fragment"><div class="line"><span class="keywordtype">int</span> ProgramPage (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> adr, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> sz, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf) {</div>
    324. 

  324. <div class="line"> </div>
    325. 

  325. <div class="line">  sz = (sz + 1) &amp; ~1;                           <span class="comment">// Adjust size for Half Words</span></div>
    326. 

  326. <div class="line"> </div>
    327. 

  327. <div class="line">  <span class="keywordflow">while</span> (sz) {</div>
    328. 

  328. <div class="line"> </div>
    329. 

  329. <div class="line">    FLASH-&gt;CR |=  FLASH_PG;                     <span class="comment">// Programming Enabled</span></div>
    330. 

  330. <div class="line"> </div>
    331. 

  331. <div class="line">    M16(adr) = *((<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> *)buf);        <span class="comment">// Program Half Word</span></div>
    332. 

  332. <div class="line">    <span class="keywordflow">while</span> (FLASH-&gt;SR &amp; FLASH_BSY);</div>
    333. 

  333. <div class="line"> </div>
    334. 

  334. <div class="line">    FLASH-&gt;CR &amp;= ~FLASH_PG;                     <span class="comment">// Programming Disabled</span></div>
    335. 

  335. <div class="line"> </div>
    336. 

  336. <div class="line">    <span class="comment">// Check for Errors</span></div>
    337. 

  337. <div class="line">    <span class="keywordflow">if</span> (FLASH-&gt;SR &amp; (FLASH_PGERR | FLASH_WRPRTERR)) {</div>
    338. 

  338. <div class="line">      FLASH-&gt;SR |= FLASH_PGERR | FLASH_WRPRTERR;</div>
    339. 

  339. <div class="line">      <span class="keywordflow">return</span> (1);                               <span class="comment">// Failed</span></div>
    340. 

  340. <div class="line">    }</div>
    341. 

  341. <div class="line"> </div>
    342. 

  342. <div class="line">    <span class="comment">// Go to next Half Word</span></div>
    343. 

  343. <div class="line">    adr += 2;</div>
    344. 

  344. <div class="line">    buf += 2;</div>
    345. 

  345. <div class="line">    sz  -= 2;</div>
    346. 

  346. <div class="line"> </div>
    347. 

  347. <div class="line">  }</div>
    348. 

  348. <div class="line"> </div>
    349. 

  349. <div class="line">  <span class="keywordflow">return</span> (0);                                   <span class="comment">// Done</span></div>
    350. 

  350. <div class="line">}</div>
    351. 

  351. </div><!-- fragment --><p>&#160;</p>
    352. 

  352. <hr/>
    353. 

  353. <h1><a class="anchor" id="UnInit"></a>
    354. 

  354. UnInit</h1>
    355. 

  355. <div class="fragment"><div class="line"><span class="keywordtype">int</span> UnInit (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> fnc);</div>
    356. 

  356. </div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
    357. 

  357.   <table class="params">
    358. 

  358.     <tr><td class="paramname">fnc</td><td>Function code </td></tr>
    359. 

  359.   </table>
    360. 

  360.   </dd>
    361. 

  361. </dl>
    362. 

  362. <dl class="section return"><dt>Returns</dt><dd>status information:<ul>
    363. 

  363. <li>0 on success.</li>
    364. 

  364. <li>1 on failure.</li>
    365. 

  365. </ul>
    366. 

  366. </dd></dl>
    367. 

  367. <p>The function <b>UnInit</b> de-initializes the microcontroller and is invoked at the end of an erasing, programming, or verifying step.</p>
    368. 

  368. <p>The argument <em>fnc</em> is a number:</p>
    369. 

  369. <ul>
    370. 

  370. <li>1 stands for Erase.</li>
    371. 

  371. <li>2 stands for Program.</li>
    372. 

  372. <li>3 stands for Verify.</li>
    373. 

  373. </ul>
    374. 

  374. <p>Thus, different de-initialization sections can be implemented for each individual Flash programming step.</p>
    375. 

  375. <p><b>Code Example</b> </p>
    376. 

  376. <div class="fragment"><div class="line"><span class="keywordtype">int</span> UnInit (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> fnc) {</div>
    377. 

  377. <div class="line"> </div>
    378. 

  378. <div class="line">  <span class="comment">// Lock Flash</span></div>
    379. 

  379. <div class="line">  FLASH-&gt;CR |=  FLASH_LOCK;</div>
    380. 

  380. <div class="line"> </div>
    381. 

  381. <div class="line">  <span class="keywordflow">return</span> (0);</div>
    382. 

  382. <div class="line">}</div>
    383. 

  383. </div><!-- fragment --><p>&#160;</p>
    384. 

  384. <hr/>
    385. 

  385. <h1><a class="anchor" id="Verify"></a>
    386. 

  386. Verify</h1>
    387. 

  387. <div class="fragment"><div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> Verify (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> adr, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> sz, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf);</div>
    388. 

  388. </div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
    389. 

  389.   <table class="params">
    390. 

  390.     <tr><td class="paramname">adr</td><td>Start address </td></tr>
    391. 

  391.     <tr><td class="paramname">sz</td><td>Size in bytes </td></tr>
    392. 

  392.     <tr><td class="paramname">buf</td><td>Data to be compared </td></tr>
    393. 

  393.   </table>
    394. 

  394.   </dd>
    395. 

  395. </dl>
    396. 

  396. <dl class="section return"><dt>Returns</dt><dd>status information:<ul>
    397. 

  397. <li>the sum of (adr+sz) - on success.</li>
    398. 

  398. <li>any other number - on failure, and represents the failing address.</li>
    399. 

  399. </ul>
    400. 

  400. </dd></dl>
    401. 

  401. <p>The function <b>Verify</b> compares the content of the Flash memory with the program code <em>*buf</em>.</p>
    402. 

  402. <p>The argument <em>adr</em> specifies the start address for the verification.</p>
    403. 

  403. <p>The argument <em>sz</em> specifies the size of the verification.</p>
    404. 

  404. <p>The argument <em>buf</em> points to the buffer containing the data to be verified.</p>
    405. 

  405. <p><b>Code Example</b> </p>
    406. 

  406. <div class="fragment"><div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> Verify (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> adr, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> sz, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf) {</div>
    407. 

  407. <div class="line">  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> i, adr_dest, in_page_ofs;</div>
    408. 

  408. <div class="line"> </div>
    409. 

  409. <div class="line">  <span class="keywordflow">if</span> (adr &lt; block_size) {               <span class="comment">// Verifying 2-nd level bootloader data</span></div>
    410. 

  410. <div class="line">    adr_dest = adr + page_usr_size;     <span class="comment">// skip page 0 of block 0</span></div>
    411. 

  411. <div class="line">  } <span class="keywordflow">else</span> {                              <span class="comment">// Verifying program data</span></div>
    412. 

  412. <div class="line">    FindBlock(adr, 0);</div>
    413. 

  413. <div class="line">    adr_dest  = nand_block_offset + (adr &amp; (block_size-1));</div>
    414. 

  414. <div class="line">  }</div>
    415. 

  415. <div class="line">  in_page_ofs = adr_dest &amp; (page_usr_size-1);</div>
    416. 

  416. <div class="line"> </div>
    417. 

  417. <div class="line">  <span class="keywordflow">if</span> (ReadPage_HW(adr_dest, page_usr_size, data_buf)) <span class="keywordflow">return</span> (1);</div>
    418. 

  418. <div class="line">  <span class="keywordflow">for</span> (i=0; i&lt;sz; i++)</div>
    419. 

  419. <div class="line">    <span class="keywordflow">if</span> (buf[i] != data_buf[i+in_page_ofs])</div>
    420. 

  420. <div class="line">      <span class="keywordflow">break</span>;</div>
    421. 

  421. <div class="line"> </div>
    422. 

  422. <div class="line">  <span class="keywordflow">return</span> (adr+i);</div>
    423. 

  423. <div class="line">}</div>
    424. 

  424. </div><!-- fragment --> </div></div><!-- contents -->
    425. 

  425. </div><!-- doc-content -->
    426. 

  426. <!-- start footer part -->
    427. 

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

  428.   <ul>
    429. 

  429.     <li class="navelem"><a class="el" href="flashAlgorithm.html">Flash Programming</a></li>
    430. 

  430.     <li class="footer">Generated on Thu Apr 9 2020 15:49:54 for CMSIS-Pack Version 1.6.3 by Arm Ltd. All rights reserved.
    431. 

  431. 	<!--
    432. 

  432.     <a href="http://www.doxygen.org/index.html">
    433. 

  433.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
    434. 

  434. 	-->
    435. 

  435. 	</li>
    436. 

  436.   </ul>
    437. 

  437. </div>
    438. 

  438. </body>
    439. 

  439. </html>
    440.