aaron/discoverpixy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added doxygen output of current emulator branch.

Browse Source
This commit is contained in:
Timo Lang
2015-05-12 11:12:43 +02:00
commit 57aa160278
9205 changed files with 511443 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

644
group___f_l_a_s_h___group2.html Normal file
View File

@@ -0,0 +1,644 @@
<!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"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>discoverpixy: FLASH Memory Programming functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</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: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">discoverpixy
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</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 -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">FLASH Memory Programming functions<div class="ingroups"><a class="el" href="group___s_t_m32_f4xx___std_periph___driver.html">STM32F4xx_StdPeriph_Driver</a> &raquo; <a class="el" href="group___f_l_a_s_h.html">RAMFUNC</a> &raquo; <a class="el" href="group___f_l_a_s_h___private___functions.html">FLASH_Private_Functions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>FLASH Memory Programming functions.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for FLASH Memory Programming functions:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group___f_l_a_s_h___group2.png" border="0" alt="" usemap="#group______f__l__a__s__h______group2"/>
<map name="group______f__l__a__s__h______group2" id="group______f__l__a__s__h______group2">
<area shape="rect" id="node2" href="group___f_l_a_s_h___private___functions.html" title="FLASH_Private_Functions" alt="" coords="5,13,180,39"/></map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga4084d0184bab463a1579271bf474aaef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_l_a_s_h___group2.html#ga4084d0184bab463a1579271bf474aaef">FLASH_Unlock</a> (void)</td></tr>
<tr class="memdesc:ga4084d0184bab463a1579271bf474aaef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unlocks the FLASH control register access. <a href="#ga4084d0184bab463a1579271bf474aaef">More...</a><br /></td></tr>
<tr class="separator:ga4084d0184bab463a1579271bf474aaef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga46899557353c4312ddbe3f25e65df1d8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_l_a_s_h___group2.html#ga46899557353c4312ddbe3f25e65df1d8">FLASH_Lock</a> (void)</td></tr>
<tr class="memdesc:ga46899557353c4312ddbe3f25e65df1d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locks the FLASH control register access. <a href="#ga46899557353c4312ddbe3f25e65df1d8">More...</a><br /></td></tr>
<tr class="separator:ga46899557353c4312ddbe3f25e65df1d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga48f408290b32a3aebbcad83a00fc447c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_l_a_s_h___group2.html#ga48f408290b32a3aebbcad83a00fc447c">FLASH_EraseSector</a> (uint32_t FLASH_Sector, uint8_t VoltageRange)</td></tr>
<tr class="memdesc:ga48f408290b32a3aebbcad83a00fc447c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Erases a specified FLASH Sector. <a href="#ga48f408290b32a3aebbcad83a00fc447c">More...</a><br /></td></tr>
<tr class="separator:ga48f408290b32a3aebbcad83a00fc447c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2aee006e5f4db4280bdedd401dfa50f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_l_a_s_h___group2.html#ga2aee006e5f4db4280bdedd401dfa50f9">FLASH_EraseAllSectors</a> (uint8_t VoltageRange)</td></tr>
<tr class="memdesc:ga2aee006e5f4db4280bdedd401dfa50f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Erases all FLASH Sectors. <a href="#ga2aee006e5f4db4280bdedd401dfa50f9">More...</a><br /></td></tr>
<tr class="separator:ga2aee006e5f4db4280bdedd401dfa50f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac297cb140218ab3fd6afa9c53087473c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_l_a_s_h___group2.html#gac297cb140218ab3fd6afa9c53087473c">FLASH_EraseAllBank1Sectors</a> (uint8_t VoltageRange)</td></tr>
<tr class="memdesc:gac297cb140218ab3fd6afa9c53087473c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Erases all FLASH Sectors in Bank 1. <a href="#gac297cb140218ab3fd6afa9c53087473c">More...</a><br /></td></tr>
<tr class="separator:gac297cb140218ab3fd6afa9c53087473c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0d841f874ee2cd6dcb3b5d08a39f28e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_l_a_s_h___group2.html#ga0d841f874ee2cd6dcb3b5d08a39f28e2">FLASH_EraseAllBank2Sectors</a> (uint8_t VoltageRange)</td></tr>
<tr class="memdesc:ga0d841f874ee2cd6dcb3b5d08a39f28e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Erases all FLASH Sectors in Bank 2. <a href="#ga0d841f874ee2cd6dcb3b5d08a39f28e2">More...</a><br /></td></tr>
<tr class="separator:ga0d841f874ee2cd6dcb3b5d08a39f28e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab84b52121e58d0dbc8ff2a92145d20f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_l_a_s_h___group2.html#gab84b52121e58d0dbc8ff2a92145d20f2">FLASH_ProgramDoubleWord</a> (uint32_t Address, uint64_t Data)</td></tr>
<tr class="memdesc:gab84b52121e58d0dbc8ff2a92145d20f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Programs a double word (64-bit) at a specified address. <a href="#gab84b52121e58d0dbc8ff2a92145d20f2">More...</a><br /></td></tr>
<tr class="separator:gab84b52121e58d0dbc8ff2a92145d20f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaac9a2f400b92537bd42a6bd7cc237b11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_l_a_s_h___group2.html#gaac9a2f400b92537bd42a6bd7cc237b11">FLASH_ProgramWord</a> (uint32_t Address, uint32_t Data)</td></tr>
<tr class="memdesc:gaac9a2f400b92537bd42a6bd7cc237b11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Programs a word (32-bit) at a specified address. <a href="#gaac9a2f400b92537bd42a6bd7cc237b11">More...</a><br /></td></tr>
<tr class="separator:gaac9a2f400b92537bd42a6bd7cc237b11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5c1336f667950a8765887228f1d0d501"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_l_a_s_h___group2.html#ga5c1336f667950a8765887228f1d0d501">FLASH_ProgramHalfWord</a> (uint32_t Address, uint16_t Data)</td></tr>
<tr class="memdesc:ga5c1336f667950a8765887228f1d0d501"><td class="mdescLeft">&#160;</td><td class="mdescRight">Programs a half word (16-bit) at a specified address. <a href="#ga5c1336f667950a8765887228f1d0d501">More...</a><br /></td></tr>
<tr class="separator:ga5c1336f667950a8765887228f1d0d501"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac425adf52fe7f229ef6bb893fe386848"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_l_a_s_h___group2.html#gac425adf52fe7f229ef6bb893fe386848">FLASH_ProgramByte</a> (uint32_t Address, uint8_t Data)</td></tr>
<tr class="memdesc:gac425adf52fe7f229ef6bb893fe386848"><td class="mdescLeft">&#160;</td><td class="mdescRight">Programs a byte (8-bit) at a specified address. <a href="#gac425adf52fe7f229ef6bb893fe386848">More...</a><br /></td></tr>
<tr class="separator:gac425adf52fe7f229ef6bb893fe386848"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>FLASH Memory Programming functions. </p>
<pre class="fragment"> ===============================================================================
##### FLASH Memory Programming functions #####
===============================================================================
[..]
This group includes the following functions:
(+) void FLASH_Unlock(void)
(+) void FLASH_Lock(void)
(+) FLASH_Status FLASH_EraseSector(uint32_t FLASH_Sector, uint8_t VoltageRange)
(+) FLASH_Status FLASH_EraseAllSectors(uint8_t VoltageRange)
(+) FLASH_Status FLASH_ProgramDoubleWord(uint32_t Address, uint64_t Data)
(+) FLASH_Status FLASH_ProgramWord(uint32_t Address, uint32_t Data)
(+) FLASH_Status FLASH_ProgramHalfWord(uint32_t Address, uint16_t Data)
(+) FLASH_Status FLASH_ProgramByte(uint32_t Address, uint8_t Data)
The following functions can be used only for STM32F42xxx/43xxx devices.
(+) FLASH_Status FLASH_EraseAllBank1Sectors(uint8_t VoltageRange)
(+) FLASH_Status FLASH_EraseAllBank2Sectors(uint8_t VoltageRange)
[..]
Any operation of erase or program should follow these steps:
(#) Call the FLASH_Unlock() function to enable the FLASH control register access
(#) Call the desired function to erase sector(s) or program data
(#) Call the FLASH_Lock() function to disable the FLASH control register access
(recommended to protect the FLASH memory against possible unwanted operation)</pre> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gac297cb140218ab3fd6afa9c53087473c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a> FLASH_EraseAllBank1Sectors </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>VoltageRange</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Erases all FLASH Sectors in Bank 1. </p>
<dl class="section note"><dt>Note</dt><dd>This function can be used only for STM32F42xxx/43xxx devices.</dd>
<dd>
If an erase and a program operations are requested simultaneously, the erase operation is performed before the program one.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">VoltageRange</td><td>The device voltage range which defines the erase parallelism. This parameter can be one of the following values: <ul>
<li>VoltageRange_1: when the device voltage range is 1.8V to 2.1V, the operation will be done by byte (8-bit) </li>
<li>VoltageRange_2: when the device voltage range is 2.1V to 2.7V, the operation will be done by half word (16-bit) </li>
<li>VoltageRange_3: when the device voltage range is 2.7V to 3.6V, the operation will be done by word (32-bit) </li>
<li>VoltageRange_4: when the device voltage range is 2.7V to 3.6V + External Vpp, the operation will be done by double word (64-bit)</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLASH</td><td>Status: The returned value can be: FLASH_BUSY, FLASH_ERROR_PROGRAM, FLASH_ERROR_WRP, FLASH_ERROR_OPERATION or FLASH_COMPLETE. </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___f_l_a_s_h___group2_gac297cb140218ab3fd6afa9c53087473c_cgraph.png" border="0" usemap="#group___f_l_a_s_h___group2_gac297cb140218ab3fd6afa9c53087473c_cgraph" alt=""/></div>
<map name="group___f_l_a_s_h___group2_gac297cb140218ab3fd6afa9c53087473c_cgraph" id="group___f_l_a_s_h___group2_gac297cb140218ab3fd6afa9c53087473c_cgraph">
<area shape="rect" id="node2" href="group___f_l_a_s_h___group4.html#gaaf8ea3b00c9a5f5eca0df9a795b83f22" title="Waits for a FLASH operation to complete. " alt="" coords="256,5,455,32"/><area shape="rect" id="node3" href="group___f_l_a_s_h___group4.html#gac265b8d1e7ea11e44ceee28797c3debb" title="Returns the FLASH Status. " alt="" coords="503,5,633,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga0d841f874ee2cd6dcb3b5d08a39f28e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a> FLASH_EraseAllBank2Sectors </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>VoltageRange</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Erases all FLASH Sectors in Bank 2. </p>
<dl class="section note"><dt>Note</dt><dd>This function can be used only for STM32F42xxx/43xxx devices.</dd>
<dd>
If an erase and a program operations are requested simultaneously, the erase operation is performed before the program one.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">VoltageRange</td><td>The device voltage range which defines the erase parallelism. This parameter can be one of the following values: <ul>
<li>VoltageRange_1: when the device voltage range is 1.8V to 2.1V, the operation will be done by byte (8-bit) </li>
<li>VoltageRange_2: when the device voltage range is 2.1V to 2.7V, the operation will be done by half word (16-bit) </li>
<li>VoltageRange_3: when the device voltage range is 2.7V to 3.6V, the operation will be done by word (32-bit) </li>
<li>VoltageRange_4: when the device voltage range is 2.7V to 3.6V + External Vpp, the operation will be done by double word (64-bit)</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLASH</td><td>Status: The returned value can be: FLASH_BUSY, FLASH_ERROR_PROGRAM, FLASH_ERROR_WRP, FLASH_ERROR_OPERATION or FLASH_COMPLETE. </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___f_l_a_s_h___group2_ga0d841f874ee2cd6dcb3b5d08a39f28e2_cgraph.png" border="0" usemap="#group___f_l_a_s_h___group2_ga0d841f874ee2cd6dcb3b5d08a39f28e2_cgraph" alt=""/></div>
<map name="group___f_l_a_s_h___group2_ga0d841f874ee2cd6dcb3b5d08a39f28e2_cgraph" id="group___f_l_a_s_h___group2_ga0d841f874ee2cd6dcb3b5d08a39f28e2_cgraph">
<area shape="rect" id="node2" href="group___f_l_a_s_h___group4.html#gaaf8ea3b00c9a5f5eca0df9a795b83f22" title="Waits for a FLASH operation to complete. " alt="" coords="256,5,455,32"/><area shape="rect" id="node3" href="group___f_l_a_s_h___group4.html#gac265b8d1e7ea11e44ceee28797c3debb" title="Returns the FLASH Status. " alt="" coords="503,5,633,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga2aee006e5f4db4280bdedd401dfa50f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a> FLASH_EraseAllSectors </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>VoltageRange</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Erases all FLASH Sectors. </p>
<dl class="section note"><dt>Note</dt><dd>If an erase and a program operations are requested simustaneously, the erase operation is performed before the program one.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">VoltageRange</td><td>The device voltage range which defines the erase parallelism. This parameter can be one of the following values: <ul>
<li>VoltageRange_1: when the device voltage range is 1.8V to 2.1V, the operation will be done by byte (8-bit) </li>
<li>VoltageRange_2: when the device voltage range is 2.1V to 2.7V, the operation will be done by half word (16-bit) </li>
<li>VoltageRange_3: when the device voltage range is 2.7V to 3.6V, the operation will be done by word (32-bit) </li>
<li>VoltageRange_4: when the device voltage range is 2.7V to 3.6V + External Vpp, the operation will be done by double word (64-bit)</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLASH</td><td>Status: The returned value can be: FLASH_BUSY, FLASH_ERROR_PROGRAM, FLASH_ERROR_WRP, FLASH_ERROR_OPERATION or FLASH_COMPLETE. </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___f_l_a_s_h___group2_ga2aee006e5f4db4280bdedd401dfa50f9_cgraph.png" border="0" usemap="#group___f_l_a_s_h___group2_ga2aee006e5f4db4280bdedd401dfa50f9_cgraph" alt=""/></div>
<map name="group___f_l_a_s_h___group2_ga2aee006e5f4db4280bdedd401dfa50f9_cgraph" id="group___f_l_a_s_h___group2_ga2aee006e5f4db4280bdedd401dfa50f9_cgraph">
<area shape="rect" id="node2" href="group___f_l_a_s_h___group4.html#gaaf8ea3b00c9a5f5eca0df9a795b83f22" title="Waits for a FLASH operation to complete. " alt="" coords="219,5,417,32"/><area shape="rect" id="node3" href="group___f_l_a_s_h___group4.html#gac265b8d1e7ea11e44ceee28797c3debb" title="Returns the FLASH Status. " alt="" coords="465,5,596,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga48f408290b32a3aebbcad83a00fc447c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a> FLASH_EraseSector </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>FLASH_Sector</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>VoltageRange</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Erases a specified FLASH Sector. </p>
<dl class="section note"><dt>Note</dt><dd>If an erase and a program operations are requested simustaneously, the erase operation is performed before the program one.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">FLASH_Sector</td><td>The Sector number to be erased.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>For STM32F405xx/407xx and STM32F415xx/417xx devices this parameter can be a value between FLASH_Sector_0 and FLASH_Sector_11.</dd></dl>
<p>For STM32F42xxx/43xxx devices this parameter can be a value between FLASH_Sector_0 and FLASH_Sector_23.</p>
<p>For STM32F401xx devices this parameter can be a value between FLASH_Sector_0 and FLASH_Sector_5.</p>
<p>For STM32F411xE devices this parameter can be a value between FLASH_Sector_0 and FLASH_Sector_7.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">VoltageRange</td><td>The device voltage range which defines the erase parallelism. This parameter can be one of the following values: <ul>
<li>VoltageRange_1: when the device voltage range is 1.8V to 2.1V, the operation will be done by byte (8-bit) </li>
<li>VoltageRange_2: when the device voltage range is 2.1V to 2.7V, the operation will be done by half word (16-bit) </li>
<li>VoltageRange_3: when the device voltage range is 2.7V to 3.6V, the operation will be done by word (32-bit) </li>
<li>VoltageRange_4: when the device voltage range is 2.7V to 3.6V + External Vpp, the operation will be done by double word (64-bit)</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLASH</td><td>Status: The returned value can be: FLASH_BUSY, FLASH_ERROR_PROGRAM, FLASH_ERROR_WRP, FLASH_ERROR_OPERATION or FLASH_COMPLETE. </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___f_l_a_s_h___group2_ga48f408290b32a3aebbcad83a00fc447c_cgraph.png" border="0" usemap="#group___f_l_a_s_h___group2_ga48f408290b32a3aebbcad83a00fc447c_cgraph" alt=""/></div>
<map name="group___f_l_a_s_h___group2_ga48f408290b32a3aebbcad83a00fc447c_cgraph" id="group___f_l_a_s_h___group2_ga48f408290b32a3aebbcad83a00fc447c_cgraph">
<area shape="rect" id="node2" href="group___f_l_a_s_h___group4.html#gaaf8ea3b00c9a5f5eca0df9a795b83f22" title="Waits for a FLASH operation to complete. " alt="" coords="196,5,395,32"/><area shape="rect" id="node3" href="group___f_l_a_s_h___group4.html#gac265b8d1e7ea11e44ceee28797c3debb" title="Returns the FLASH Status. " alt="" coords="443,5,573,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga46899557353c4312ddbe3f25e65df1d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FLASH_Lock </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Locks the FLASH control register access. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gac425adf52fe7f229ef6bb893fe386848"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a> FLASH_ProgramByte </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>Address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>Data</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Programs a byte (8-bit) at a specified address. </p>
<dl class="section note"><dt>Note</dt><dd>This function can be used within all the device supply voltage ranges.</dd>
<dd>
If an erase and a program operations are requested simustaneously, the erase operation is performed before the program one.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Address</td><td>specifies the address to be programmed. This parameter can be any address in Program memory zone or in OTP zone. </td></tr>
<tr><td class="paramname">Data</td><td>specifies the data to be programmed. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLASH</td><td>Status: The returned value can be: FLASH_BUSY, FLASH_ERROR_PROGRAM, FLASH_ERROR_WRP, FLASH_ERROR_OPERATION or FLASH_COMPLETE. </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___f_l_a_s_h___group2_gac425adf52fe7f229ef6bb893fe386848_cgraph.png" border="0" usemap="#group___f_l_a_s_h___group2_gac425adf52fe7f229ef6bb893fe386848_cgraph" alt=""/></div>
<map name="group___f_l_a_s_h___group2_gac425adf52fe7f229ef6bb893fe386848_cgraph" id="group___f_l_a_s_h___group2_gac425adf52fe7f229ef6bb893fe386848_cgraph">
<area shape="rect" id="node2" href="group___f_l_a_s_h___group4.html#gaaf8ea3b00c9a5f5eca0df9a795b83f22" title="Waits for a FLASH operation to complete. " alt="" coords="200,5,399,32"/><area shape="rect" id="node3" href="group___f_l_a_s_h___group4.html#gac265b8d1e7ea11e44ceee28797c3debb" title="Returns the FLASH Status. " alt="" coords="447,5,577,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="gab84b52121e58d0dbc8ff2a92145d20f2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a> FLASH_ProgramDoubleWord </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>Address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>Data</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Programs a double word (64-bit) at a specified address. </p>
<dl class="section note"><dt>Note</dt><dd>This function must be used when the device voltage range is from 2.7V to 3.6V and an External Vpp is present.</dd>
<dd>
If an erase and a program operations are requested simustaneously, the erase operation is performed before the program one.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Address</td><td>specifies the address to be programmed. </td></tr>
<tr><td class="paramname">Data</td><td>specifies the data to be programmed. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLASH</td><td>Status: The returned value can be: FLASH_BUSY, FLASH_ERROR_PROGRAM, FLASH_ERROR_WRP, FLASH_ERROR_OPERATION or FLASH_COMPLETE. </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___f_l_a_s_h___group2_gab84b52121e58d0dbc8ff2a92145d20f2_cgraph.png" border="0" usemap="#group___f_l_a_s_h___group2_gab84b52121e58d0dbc8ff2a92145d20f2_cgraph" alt=""/></div>
<map name="group___f_l_a_s_h___group2_gab84b52121e58d0dbc8ff2a92145d20f2_cgraph" id="group___f_l_a_s_h___group2_gab84b52121e58d0dbc8ff2a92145d20f2_cgraph">
<area shape="rect" id="node2" href="group___f_l_a_s_h___group4.html#gaaf8ea3b00c9a5f5eca0df9a795b83f22" title="Waits for a FLASH operation to complete. " alt="" coords="244,5,443,32"/><area shape="rect" id="node3" href="group___f_l_a_s_h___group4.html#gac265b8d1e7ea11e44ceee28797c3debb" title="Returns the FLASH Status. " alt="" coords="491,5,621,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga5c1336f667950a8765887228f1d0d501"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a> FLASH_ProgramHalfWord </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>Address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>Data</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Programs a half word (16-bit) at a specified address. </p>
<dl class="section note"><dt>Note</dt><dd>This function must be used when the device voltage range is from 2.1V to 3.6V.</dd>
<dd>
If an erase and a program operations are requested simustaneously, the erase operation is performed before the program one.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Address</td><td>specifies the address to be programmed. This parameter can be any address in Program memory zone or in OTP zone. </td></tr>
<tr><td class="paramname">Data</td><td>specifies the data to be programmed. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLASH</td><td>Status: The returned value can be: FLASH_BUSY, FLASH_ERROR_PROGRAM, FLASH_ERROR_WRP, FLASH_ERROR_OPERATION or FLASH_COMPLETE. </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___f_l_a_s_h___group2_ga5c1336f667950a8765887228f1d0d501_cgraph.png" border="0" usemap="#group___f_l_a_s_h___group2_ga5c1336f667950a8765887228f1d0d501_cgraph" alt=""/></div>
<map name="group___f_l_a_s_h___group2_ga5c1336f667950a8765887228f1d0d501_cgraph" id="group___f_l_a_s_h___group2_ga5c1336f667950a8765887228f1d0d501_cgraph">
<area shape="rect" id="node2" href="group___f_l_a_s_h___group4.html#gaaf8ea3b00c9a5f5eca0df9a795b83f22" title="Waits for a FLASH operation to complete. " alt="" coords="227,5,425,32"/><area shape="rect" id="node3" href="group___f_l_a_s_h___group4.html#gac265b8d1e7ea11e44ceee28797c3debb" title="Returns the FLASH Status. " alt="" coords="473,5,604,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="gaac9a2f400b92537bd42a6bd7cc237b11"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___f_l_a_s_h.html#gadc63a6f3404ff1f71229a66915e9cdc0">FLASH_Status</a> FLASH_ProgramWord </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>Address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>Data</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Programs a word (32-bit) at a specified address. </p>
<dl class="section note"><dt>Note</dt><dd>This function must be used when the device voltage range is from 2.7V to 3.6V.</dd>
<dd>
If an erase and a program operations are requested simustaneously, the erase operation is performed before the program one.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Address</td><td>specifies the address to be programmed. This parameter can be any address in Program memory zone or in OTP zone. </td></tr>
<tr><td class="paramname">Data</td><td>specifies the data to be programmed. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLASH</td><td>Status: The returned value can be: FLASH_BUSY, FLASH_ERROR_PROGRAM, FLASH_ERROR_WRP, FLASH_ERROR_OPERATION or FLASH_COMPLETE. </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___f_l_a_s_h___group2_gaac9a2f400b92537bd42a6bd7cc237b11_cgraph.png" border="0" usemap="#group___f_l_a_s_h___group2_gaac9a2f400b92537bd42a6bd7cc237b11_cgraph" alt=""/></div>
<map name="group___f_l_a_s_h___group2_gaac9a2f400b92537bd42a6bd7cc237b11_cgraph" id="group___f_l_a_s_h___group2_gaac9a2f400b92537bd42a6bd7cc237b11_cgraph">
<area shape="rect" id="node2" href="group___f_l_a_s_h___group4.html#gaaf8ea3b00c9a5f5eca0df9a795b83f22" title="Waits for a FLASH operation to complete. " alt="" coords="204,5,403,32"/><area shape="rect" id="node3" href="group___f_l_a_s_h___group4.html#gac265b8d1e7ea11e44ceee28797c3debb" title="Returns the FLASH Status. " alt="" coords="451,5,581,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga4084d0184bab463a1579271bf474aaef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FLASH_Unlock </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unlocks the FLASH control register access. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun May 10 2015 15:15:19 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>