423 lines
25 KiB
HTML
423 lines
25 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<title>Algorithm Functions</title>
|
||
|
|
<title>CMSIS-Pack: Algorithm Functions</title>
|
||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<link href="cmsis.css" rel="stylesheet" type="text/css" />
|
||
|
|
<script type="text/javascript" src="jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
||
|
|
<script type="text/javascript" src="printComponentTabs.js"></script>
|
||
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="resize.js"></script>
|
||
|
|
<script type="text/javascript" src="navtree.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(initResizable);
|
||
|
|
$(window).load(resizeHeight);
|
||
|
|
</script>
|
||
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="search/search.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
||
|
|
</script>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
|
|
<div id="titlearea">
|
||
|
|
<table cellspacing="0" cellpadding="0">
|
||
|
|
<tbody>
|
||
|
|
<tr style="height: 46px;">
|
||
|
|
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
|
||
|
|
<td style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">CMSIS-Pack
|
||
|
|
 <span id="projectnumber">Version 1.4.9</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">Delivery Mechanism for Software Packs</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<div id="CMSISnav" class="tabs1">
|
||
|
|
<ul class="tablist">
|
||
|
|
<script type="text/javascript">
|
||
|
|
<!--
|
||
|
|
writeComponentTabs.call(this);
|
||
|
|
//-->
|
||
|
|
</script>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
|
|
</script>
|
||
|
|
<div id="navrow1" class="tabs">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
|
<li class="current"><a href="pages.html"><span>Usage and Description</span></a></li>
|
||
|
|
<li>
|
||
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||
|
|
<span class="left">
|
||
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
alt=""/>
|
||
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||
|
|
</span><span class="right">
|
||
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||
|
|
</span>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||
|
|
<div id="nav-tree">
|
||
|
|
<div id="nav-tree-contents">
|
||
|
|
<div id="nav-sync" class="sync"></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
||
|
|
class="ui-resizable-handle">
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(function(){initNavTree('algorithmFunc.html','');});
|
||
|
|
</script>
|
||
|
|
<div id="doc-content">
|
||
|
|
<!-- window showing the filter options -->
|
||
|
|
<div id="MSearchSelectWindow"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Pages</a></div>
|
||
|
|
|
||
|
|
<!-- iframe showing the search results (closed by default) -->
|
||
|
|
<div id="MSearchResultsWindow">
|
||
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
||
|
|
name="MSearchResults" id="MSearchResults">
|
||
|
|
</iframe>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Algorithm Functions </div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="textblock"><p>Blank Check</p>
|
||
|
|
<p>The following functions are available for creating new Flash programming algorithms: </p>
|
||
|
|
<table class="doxtable">
|
||
|
|
<tr>
|
||
|
|
<th>Function Name </th><th>Indication </th><th>Description </th></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a class="el" href="algorithmFunc.html#BlankCheck">BlankCheck</a> </td><td>optional </td><td>Check and compare patterns. </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a class="el" href="algorithmFunc.html#EraseChip">EraseChip</a> </td><td>optional </td><td>Delete entire Flash memory content. </td></tr>
|
||
|
|
<tr>
|
||
|
|
<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>
|
||
|
|
<tr>
|
||
|
|
<td><a class="el" href="algorithmFunc.html#Init">Init</a> </td><td>mandatory </td><td>Initialize and prepare device for Flash programming. </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a class="el" href="algorithmFunc.html#ProgramPage">ProgramPage</a> </td><td>mandatory </td><td>Write the application into the Flash memory. </td></tr>
|
||
|
|
<tr>
|
||
|
|
<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>
|
||
|
|
<tr>
|
||
|
|
<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>
|
||
|
|
</table>
|
||
|
|
<p> </p>
|
||
|
|
<hr/>
|
||
|
|
<h1><a class="anchor" id="BlankCheck"></a>
|
||
|
|
BlankCheck</h1>
|
||
|
|
<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>
|
||
|
|
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">adr</td><td>Block start address </td></tr>
|
||
|
|
<tr><td class="paramname">sz</td><td>Block size in bytes </td></tr>
|
||
|
|
<tr><td class="paramname">pat</td><td>Pattern to compare </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>status information:<ul>
|
||
|
|
<li>0 when the block content is equal to the pattern pat.</li>
|
||
|
|
<li>1 when the block content differs from the pattern pat.</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
<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>
|
||
|
|
<p>The argument <em>adr</em> specifies the start address of the block that is to be verified.</p>
|
||
|
|
<p>The argument <em>sz</em> specifies the size of the block that is to be verified.</p>
|
||
|
|
<p><b>Code Example</b> </p>
|
||
|
|
<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>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> i, j, k;</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Recalculate address for External SDRAM addresses</span></div>
|
||
|
|
<div class="line"> <span class="keywordflow">if</span> (adr >= SDRAM_START)</div>
|
||
|
|
<div class="line"> adr = adr - SDRAM_START + USER_OFFSET;</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">for</span> (i = 0; i < sz; i += 256) {</div>
|
||
|
|
<div class="line"> <span class="comment">// Read 256 bytes</span></div>
|
||
|
|
<div class="line"> ReadPage_HW (adr+i, 256, &rd_buf[0]);</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Determine size to compare</span></div>
|
||
|
|
<div class="line"> <span class="keywordflow">if</span> ((sz-i) >= 256) k = 256;</div>
|
||
|
|
<div class="line"> <span class="keywordflow">else</span> k = (sz-i);</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Check up to 256 bytes if equal to pattern "pat"</span></div>
|
||
|
|
<div class="line"> <span class="keywordflow">for</span> (j = 0; j < k; j++)</div>
|
||
|
|
<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>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> (0); <span class="comment">// Memory is blank</span></div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --><p> </p>
|
||
|
|
<hr/>
|
||
|
|
<h1><a class="anchor" id="EraseChip"></a>
|
||
|
|
EraseChip</h1>
|
||
|
|
<div class="fragment"><div class="line"><span class="keywordtype">int</span> EraseChip (<span class="keywordtype">void</span>);</div>
|
||
|
|
</div><!-- fragment --> <dl class="section return"><dt>Returns</dt><dd>status information:<ul>
|
||
|
|
<li>0 on success.</li>
|
||
|
|
<li>1 on failure.</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
<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>
|
||
|
|
<p><b>Code Example</b> </p>
|
||
|
|
<div class="fragment"><div class="line"><span class="keywordtype">int</span> EraseChip (<span class="keywordtype">void</span>) {</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> FLASH->CR |= FLASH_MER; <span class="comment">// Mass Erase Enabled</span></div>
|
||
|
|
<div class="line"> FLASH->CR |= FLASH_STRT; <span class="comment">// Start Erase</span></div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">while</span> (FLASH->SR & FLASH_BSY) {</div>
|
||
|
|
<div class="line"> IWDG->KR = 0xAAAA; <span class="comment">// Reload IWDG</span></div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> FLASH->CR &= ~FLASH_MER; <span class="comment">// Mass Erase Disabled</span></div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> (0); <span class="comment">// Done</span></div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --><p> </p>
|
||
|
|
<hr/>
|
||
|
|
<h1><a class="anchor" id="EraseSector"></a>
|
||
|
|
EraseSector</h1>
|
||
|
|
<div class="fragment"><div class="line"><span class="keywordtype">int</span> EraseSector (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> adr);</div>
|
||
|
|
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">adr</td><td>Sector address </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>status information:<ul>
|
||
|
|
<li>0 on success.</li>
|
||
|
|
<li>1 on failure.</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
<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>
|
||
|
|
<p><b>Code Example</b> </p>
|
||
|
|
<div class="fragment"><div class="line"><span class="keywordtype">int</span> EraseSector (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> adr) {</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> FLASH->CR |= FLASH_PER; <span class="comment">// Page Erase Enabled</span></div>
|
||
|
|
<div class="line"> FLASH->AR = adr; <span class="comment">// Page Address</span></div>
|
||
|
|
<div class="line"> FLASH->CR |= FLASH_STRT; <span class="comment">// Start Erase</span></div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">while</span> (FLASH->SR & FLASH_BSY) {</div>
|
||
|
|
<div class="line"> IWDG->KR = 0xAAAA; <span class="comment">// Reload IWDG</span></div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> FLASH->CR &= ~FLASH_PER; <span class="comment">// Page Erase Disabled</span></div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> (0); <span class="comment">// Done</span></div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --><p> </p>
|
||
|
|
<hr/>
|
||
|
|
<h1><a class="anchor" id="Init"></a>
|
||
|
|
Init</h1>
|
||
|
|
<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>
|
||
|
|
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">adr</td><td>Device base address </td></tr>
|
||
|
|
<tr><td class="paramname">clk</td><td>Clock frequency (Hz) </td></tr>
|
||
|
|
<tr><td class="paramname">fnc</td><td>Function code </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>status information:<ul>
|
||
|
|
<li>0 on success.</li>
|
||
|
|
<li>1 on failure.</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
<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>
|
||
|
|
<p>The argument <em>adr</em> specifies the base address of the device.</p>
|
||
|
|
<p>The argument <em>clk</em> specifies the clock frequency for prgramming the device.</p>
|
||
|
|
<p>The argument <em>fnc</em> is a number:</p>
|
||
|
|
<ul>
|
||
|
|
<li>1 stands for Erase.</li>
|
||
|
|
<li>2 stands for Program.</li>
|
||
|
|
<li>3 stands for Verify.</li>
|
||
|
|
</ul>
|
||
|
|
<p>Thus, different initialization sections can be implemented for each individual Flash programming step.</p>
|
||
|
|
<p><b>Code Example</b> </p>
|
||
|
|
<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>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Zero Wait State</span></div>
|
||
|
|
<div class="line"> FLASH->ACR = 0x00000000;</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Unlock Flash</span></div>
|
||
|
|
<div class="line"> FLASH->KEYR = FLASH_KEY1;</div>
|
||
|
|
<div class="line"> FLASH->KEYR = FLASH_KEY2;</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Test if IWDG is running (IWDG in HW mode)</span></div>
|
||
|
|
<div class="line"> <span class="keywordflow">if</span> ((FLASH->OBR & 0x04) == 0x00) {</div>
|
||
|
|
<div class="line"> <span class="comment">// Set IWDG time out to ~32.768 second</span></div>
|
||
|
|
<div class="line"> IWDG->KR = 0x5555; <span class="comment">// Enable write access to IWDG_PR and IWDG_RLR</span></div>
|
||
|
|
<div class="line"> IWDG->PR = 0x06; <span class="comment">// Set prescaler to 256</span></div>
|
||
|
|
<div class="line"> IWDG->RLR = 4095; <span class="comment">// Set reload value to 4095</span></div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> (0);</div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --><p> </p>
|
||
|
|
<hr/>
|
||
|
|
<h1><a class="anchor" id="ProgramPage"></a>
|
||
|
|
ProgramPage</h1>
|
||
|
|
<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>
|
||
|
|
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">adr</td><td>Page start address </td></tr>
|
||
|
|
<tr><td class="paramname">sz</td><td>Page size </td></tr>
|
||
|
|
<tr><td class="paramname">buf</td><td>Data to be written </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>status information:<ul>
|
||
|
|
<li>0 on success.</li>
|
||
|
|
<li>1 on failure.</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
<p>The function <b>ProgramPage</b> is used to write code into the Flash memory. It is invoked whenever an attempt is made to download a program to Flash.</p>
|
||
|
|
<p>The argument <em>adr</em> specifies the start address of the page that is to be programmed.</p>
|
||
|
|
<p>The argument <em>sz</em> specifies the size of the page that is to be programmed.</p>
|
||
|
|
<p>The argument <em>buf</em> points to the buffer containing the data to be programmed.</p>
|
||
|
|
<p><b>Code Example</b> </p>
|
||
|
|
<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>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> sz = (sz + 1) & ~1; <span class="comment">// Adjust size for Half Words</span></div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">while</span> (sz) {</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> FLASH->CR |= FLASH_PG; <span class="comment">// Programming Enabled</span></div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> M16(adr) = *((<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> *)buf); <span class="comment">// Program Half Word</span></div>
|
||
|
|
<div class="line"> <span class="keywordflow">while</span> (FLASH->SR & FLASH_BSY);</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> FLASH->CR &= ~FLASH_PG; <span class="comment">// Programming Disabled</span></div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Check for Errors</span></div>
|
||
|
|
<div class="line"> <span class="keywordflow">if</span> (FLASH->SR & (FLASH_PGERR | FLASH_WRPRTERR)) {</div>
|
||
|
|
<div class="line"> FLASH->SR |= FLASH_PGERR | FLASH_WRPRTERR;</div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> (1); <span class="comment">// Failed</span></div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Go to next Half Word</span></div>
|
||
|
|
<div class="line"> adr += 2;</div>
|
||
|
|
<div class="line"> buf += 2;</div>
|
||
|
|
<div class="line"> sz -= 2;</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> (0); <span class="comment">// Done</span></div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --><p> </p>
|
||
|
|
<hr/>
|
||
|
|
<h1><a class="anchor" id="UnInit"></a>
|
||
|
|
UnInit</h1>
|
||
|
|
<div class="fragment"><div class="line"><span class="keywordtype">int</span> UnInit (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> fnc);</div>
|
||
|
|
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">fnc</td><td>Function code </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>status information:<ul>
|
||
|
|
<li>0 on success.</li>
|
||
|
|
<li>1 on failure.</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
<p>The function <b>UnInit</b> de-initializes the microcontroller and is invoked at the end of an erasing, programming, or verifying step.</p>
|
||
|
|
<p>The argument <em>fnc</em> is a number:</p>
|
||
|
|
<ul>
|
||
|
|
<li>1 stands for Erase.</li>
|
||
|
|
<li>2 stands for Program.</li>
|
||
|
|
<li>3 stands for Verify.</li>
|
||
|
|
</ul>
|
||
|
|
<p>Thus, different de-initialization sections can be implemented for each individual Flash programming step.</p>
|
||
|
|
<p><b>Code Example</b> </p>
|
||
|
|
<div class="fragment"><div class="line"><span class="keywordtype">int</span> UnInit (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> fnc) {</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Lock Flash</span></div>
|
||
|
|
<div class="line"> FLASH->CR |= FLASH_LOCK;</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> (0);</div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --><p> </p>
|
||
|
|
<hr/>
|
||
|
|
<h1><a class="anchor" id="Verify"></a>
|
||
|
|
Verify</h1>
|
||
|
|
<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>
|
||
|
|
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">adr</td><td>Start address </td></tr>
|
||
|
|
<tr><td class="paramname">sz</td><td>Size in bytes </td></tr>
|
||
|
|
<tr><td class="paramname">buf</td><td>Data to be compared </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>status information:<ul>
|
||
|
|
<li>the sum of (adr+sz) - on success.</li>
|
||
|
|
<li>any other number - on failure, and represents the failing address.</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
<p>The function <b>Verify</b> compares the content of the Flash memory with the program code <em>*buf</em>.</p>
|
||
|
|
<p>The argument <em>adr</em> specifies the start address for the verification.</p>
|
||
|
|
<p>The argument <em>sz</em> specifies the size of the verification.</p>
|
||
|
|
<p>The argument <em>buf</em> points to the buffer containing the data to be verified.</p>
|
||
|
|
<p><b>Code Example</b> </p>
|
||
|
|
<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>
|
||
|
|
<div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> i, adr_dest, in_page_ofs;</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">if</span> (adr < block_size) { <span class="comment">// Verifying 2-nd level bootloader data</span></div>
|
||
|
|
<div class="line"> adr_dest = adr + page_usr_size; <span class="comment">// skip page 0 of block 0</span></div>
|
||
|
|
<div class="line"> } <span class="keywordflow">else</span> { <span class="comment">// Verifying program data</span></div>
|
||
|
|
<div class="line"> FindBlock(adr, 0);</div>
|
||
|
|
<div class="line"> adr_dest = nand_block_offset + (adr & (block_size-1));</div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> in_page_ofs = adr_dest & (page_usr_size-1);</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">if</span> (ReadPage_HW(adr_dest, page_usr_size, data_buf)) <span class="keywordflow">return</span> (1);</div>
|
||
|
|
<div class="line"> <span class="keywordflow">for</span> (i=0; i<sz; i++)</div>
|
||
|
|
<div class="line"> <span class="keywordflow">if</span> (buf[i] != data_buf[i+in_page_ofs])</div>
|
||
|
|
<div class="line"> <span class="keywordflow">break</span>;</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> (adr+i);</div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --> </div></div><!-- contents -->
|
||
|
|
</div><!-- doc-content -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="flashAlgorithm.html">Flash Programming Algorithms</a></li>
|
||
|
|
<li class="footer">Generated on Wed Feb 8 2017 10:21:01 for CMSIS-Pack by ARM Ltd. All rights reserved.
|
||
|
|
<!--
|
||
|
|
<a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
|
||
|
|
-->
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|