429 lines
22 KiB
HTML
429 lines
22 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"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.8.10"/>
|
||
|
|
<title>ESP8266_RTOS_SDK: SPI Driver APIs</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 id="projectalign" style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">ESP8266_RTOS_SDK
|
||
|
|
 <span id="projectnumber">v1.4.0</span>
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
||
|
|
<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><a href="modules.html"><span>Modules</span></a></li>
|
||
|
|
<li><a href="annotated.html"><span>Data Structures</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="#nested-classes">Data Structures</a> |
|
||
|
|
<a href="#define-members">Macros</a> |
|
||
|
|
<a href="#typedef-members">Typedefs</a> |
|
||
|
|
<a href="#enum-members">Enumerations</a> |
|
||
|
|
<a href="#func-members">Functions</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">SPI Driver APIs<div class="ingroups"><a class="el" href="group__Driver__APIs.html">Driver APIs</a></div></div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>SPI Flash APIs.
|
||
|
|
<a href="#details">More...</a></p>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
||
|
|
Data Structures</h2></td></tr>
|
||
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpiFlashChip.html">SpiFlashChip</a></td></tr>
|
||
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
||
|
|
Macros</h2></td></tr>
|
||
|
|
<tr class="memitem:ga518257817c69fec25290c1bebad544b0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__Driver__APIs.html#ga518257817c69fec25290c1bebad544b0">SPI_FLASH_SEC_SIZE</a>   4096</td></tr>
|
||
|
|
<tr class="separator:ga518257817c69fec25290c1bebad544b0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
||
|
|
Typedefs</h2></td></tr>
|
||
|
|
<tr class="memitem:gacda8d0eb9ddb859ea21726108d825f17"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__Driver__APIs.html#gacda8d0eb9ddb859ea21726108d825f17">user_spi_flash_read</a>) (<a class="el" href="structSpiFlashChip.html">SpiFlashChip</a> *spi, uint32 src_addr, uint32 *des_addr, uint32 size)</td></tr>
|
||
|
|
<tr class="memdesc:gacda8d0eb9ddb859ea21726108d825f17"><td class="mdescLeft"> </td><td class="mdescRight">Registered function for spi_flash_set_read_func. <a href="#gacda8d0eb9ddb859ea21726108d825f17">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gacda8d0eb9ddb859ea21726108d825f17"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
||
|
|
Enumerations</h2></td></tr>
|
||
|
|
<tr class="memitem:ga7546515bb162fd2bb252ebe20fd92dbe"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a> { <a class="el" href="group__SPI__Driver__APIs.html#gga7546515bb162fd2bb252ebe20fd92dbea8c0e5ba08fbb8fbe8f5f1a6eac6e01cc">SPI_FLASH_RESULT_OK</a>,
|
||
|
|
<a class="el" href="group__SPI__Driver__APIs.html#gga7546515bb162fd2bb252ebe20fd92dbea6a7e104b6106ddf6a7fa6e2fbe93edca">SPI_FLASH_RESULT_ERR</a>,
|
||
|
|
<a class="el" href="group__SPI__Driver__APIs.html#gga7546515bb162fd2bb252ebe20fd92dbea266272773eeee7e649575a8ad4f5d119">SPI_FLASH_RESULT_TIMEOUT</a>
|
||
|
|
}<tr class="separator:ga7546515bb162fd2bb252ebe20fd92dbe"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||
|
|
Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:ga9ffc628fbfc74b51a78ed0a03c3f8dd0"><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__Driver__APIs.html#ga9ffc628fbfc74b51a78ed0a03c3f8dd0">spi_flash_get_id</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:ga9ffc628fbfc74b51a78ed0a03c3f8dd0"><td class="mdescLeft"> </td><td class="mdescRight">Get ID info of SPI Flash. <a href="#ga9ffc628fbfc74b51a78ed0a03c3f8dd0">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga9ffc628fbfc74b51a78ed0a03c3f8dd0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga8bd9176a0db21f8a04c0ab8792b74fec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__Driver__APIs.html#ga8bd9176a0db21f8a04c0ab8792b74fec">spi_flash_read_status</a> (uint32 *status)</td></tr>
|
||
|
|
<tr class="memdesc:ga8bd9176a0db21f8a04c0ab8792b74fec"><td class="mdescLeft"> </td><td class="mdescRight">Read state register of SPI Flash. <a href="#ga8bd9176a0db21f8a04c0ab8792b74fec">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga8bd9176a0db21f8a04c0ab8792b74fec"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga0e1358b06ac94b1e94c6aec83d034c56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__Driver__APIs.html#ga0e1358b06ac94b1e94c6aec83d034c56">spi_flash_write_status</a> (uint32 status_value)</td></tr>
|
||
|
|
<tr class="memdesc:ga0e1358b06ac94b1e94c6aec83d034c56"><td class="mdescLeft"> </td><td class="mdescRight">Write state register of SPI Flash. <a href="#ga0e1358b06ac94b1e94c6aec83d034c56">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga0e1358b06ac94b1e94c6aec83d034c56"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga3210ddd52247977cff3d018bf34f9048"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__Driver__APIs.html#ga3210ddd52247977cff3d018bf34f9048">spi_flash_erase_sector</a> (uint16 sec)</td></tr>
|
||
|
|
<tr class="memdesc:ga3210ddd52247977cff3d018bf34f9048"><td class="mdescLeft"> </td><td class="mdescRight">Erase the Flash sector. <a href="#ga3210ddd52247977cff3d018bf34f9048">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga3210ddd52247977cff3d018bf34f9048"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga97906813255238cdb0da4d21040abf90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__Driver__APIs.html#ga97906813255238cdb0da4d21040abf90">spi_flash_write</a> (uint32 des_addr, uint32 *src_addr, uint32 size)</td></tr>
|
||
|
|
<tr class="memdesc:ga97906813255238cdb0da4d21040abf90"><td class="mdescLeft"> </td><td class="mdescRight">Write data to Flash. <a href="#ga97906813255238cdb0da4d21040abf90">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga97906813255238cdb0da4d21040abf90"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gacfd871ce143884d5c3dfb456024b0096"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__Driver__APIs.html#gacfd871ce143884d5c3dfb456024b0096">spi_flash_read</a> (uint32 src_addr, uint32 *des_addr, uint32 size)</td></tr>
|
||
|
|
<tr class="memdesc:gacfd871ce143884d5c3dfb456024b0096"><td class="mdescLeft"> </td><td class="mdescRight">Read data from Flash. <a href="#gacfd871ce143884d5c3dfb456024b0096">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gacfd871ce143884d5c3dfb456024b0096"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga826a3caeec9fd019d6a30c3113d1547e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__Driver__APIs.html#ga826a3caeec9fd019d6a30c3113d1547e">spi_flash_set_read_func</a> (<a class="el" href="group__SPI__Driver__APIs.html#gacda8d0eb9ddb859ea21726108d825f17">user_spi_flash_read</a> read)</td></tr>
|
||
|
|
<tr class="memdesc:ga826a3caeec9fd019d6a30c3113d1547e"><td class="mdescLeft"> </td><td class="mdescRight">Register user-define SPI flash read API. <a href="#ga826a3caeec9fd019d6a30c3113d1547e">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga826a3caeec9fd019d6a30c3113d1547e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<p>SPI Flash APIs. </p>
|
||
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
||
|
|
<a class="anchor" id="ga518257817c69fec25290c1bebad544b0"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define SPI_FLASH_SEC_SIZE   4096</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>SPI Flash sector size </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
||
|
|
<a class="anchor" id="gacda8d0eb9ddb859ea21726108d825f17"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">typedef <a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a>(* user_spi_flash_read) (<a class="el" href="structSpiFlashChip.html">SpiFlashChip</a> *spi, uint32 src_addr, uint32 *des_addr, uint32 size)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Registered function for spi_flash_set_read_func. </p>
|
||
|
|
<dl class="section attention"><dt>Attention</dt><dd>used for sdk internal, don't need to care about params</dd></dl>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname"><a class="el" href="structSpiFlashChip.html">SpiFlashChip</a></td><td>*spi : spi flash struct pointer. </td></tr>
|
||
|
|
<tr><td class="paramname">uint32</td><td>src_addr : source address of the data. </td></tr>
|
||
|
|
<tr><td class="paramname">uint32</td><td>*des_addr : destination address in Flash. </td></tr>
|
||
|
|
<tr><td class="paramname">uint32</td><td>size : length of data</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>SpiFlashOpResult </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
||
|
|
<a class="anchor" id="ga7546515bb162fd2bb252ebe20fd92dbe"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">enum <a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<table class="fieldtable">
|
||
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga7546515bb162fd2bb252ebe20fd92dbea8c0e5ba08fbb8fbe8f5f1a6eac6e01cc"></a>SPI_FLASH_RESULT_OK </td><td class="fielddoc">
|
||
|
|
<p>SPI Flash operating OK </p>
|
||
|
|
</td></tr>
|
||
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7546515bb162fd2bb252ebe20fd92dbea6a7e104b6106ddf6a7fa6e2fbe93edca"></a>SPI_FLASH_RESULT_ERR </td><td class="fielddoc">
|
||
|
|
<p>SPI Flash operating fail </p>
|
||
|
|
</td></tr>
|
||
|
|
<tr><td class="fieldname"><a class="anchor" id="gga7546515bb162fd2bb252ebe20fd92dbea266272773eeee7e649575a8ad4f5d119"></a>SPI_FLASH_RESULT_TIMEOUT </td><td class="fielddoc">
|
||
|
|
<p>SPI Flash operating time out </p>
|
||
|
|
</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Function Documentation</h2>
|
||
|
|
<a class="anchor" id="ga3210ddd52247977cff3d018bf34f9048"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a> spi_flash_erase_sector </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint16 </td>
|
||
|
|
<td class="paramname"><em>sec</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Erase the Flash sector. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">uint16</td><td>sec : Sector number, the count starts at sector 0, 4KB per sector.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>SpiFlashOpResult </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ga9ffc628fbfc74b51a78ed0a03c3f8dd0"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint32 spi_flash_get_id </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get ID info of SPI Flash. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">null</td><td></td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>SPI Flash ID </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="gacfd871ce143884d5c3dfb456024b0096"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a> spi_flash_read </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint32 </td>
|
||
|
|
<td class="paramname"><em>src_addr</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">uint32 * </td>
|
||
|
|
<td class="paramname"><em>des_addr</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">uint32 </td>
|
||
|
|
<td class="paramname"><em>size</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Read data from Flash. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">uint32</td><td>src_addr : source address of the data. </td></tr>
|
||
|
|
<tr><td class="paramname">uint32</td><td>*des_addr : destination address in Flash. </td></tr>
|
||
|
|
<tr><td class="paramname">uint32</td><td>size : length of data</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>SpiFlashOpResult </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ga8bd9176a0db21f8a04c0ab8792b74fec"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a> spi_flash_read_status </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint32 * </td>
|
||
|
|
<td class="paramname"><em>status</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Read state register of SPI Flash. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">uint32</td><td>*status : the read value (pointer) of state register.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>SpiFlashOpResult </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ga826a3caeec9fd019d6a30c3113d1547e"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void spi_flash_set_read_func </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="group__SPI__Driver__APIs.html#gacda8d0eb9ddb859ea21726108d825f17">user_spi_flash_read</a> </td>
|
||
|
|
<td class="paramname"><em>read</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Register user-define SPI flash read API. </p>
|
||
|
|
<dl class="section attention"><dt>Attention</dt><dd>This API can be only used in SPI overlap mode, please refer to ESP8266_RTOS_SDK .c</dd></dl>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">user_spi_flash_read</td><td>read : user-define SPI flash read API .</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ga97906813255238cdb0da4d21040abf90"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a> spi_flash_write </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint32 </td>
|
||
|
|
<td class="paramname"><em>des_addr</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">uint32 * </td>
|
||
|
|
<td class="paramname"><em>src_addr</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">uint32 </td>
|
||
|
|
<td class="paramname"><em>size</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Write data to Flash. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">uint32</td><td>des_addr : destination address in Flash. </td></tr>
|
||
|
|
<tr><td class="paramname">uint32</td><td>*src_addr : source address of the data. </td></tr>
|
||
|
|
<tr><td class="paramname">uint32</td><td>size : length of data</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>SpiFlashOpResult </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ga0e1358b06ac94b1e94c6aec83d034c56"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="group__SPI__Driver__APIs.html#ga7546515bb162fd2bb252ebe20fd92dbe">SpiFlashOpResult</a> spi_flash_write_status </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint32 </td>
|
||
|
|
<td class="paramname"><em>status_value</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Write state register of SPI Flash. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">uint32</td><td>status_value : Write state register value.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>SpiFlashOpResult </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><!-- contents -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated on Tue Mar 1 2016 10:19:26 for ESP8266_RTOS_SDK by  <a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||
|
|
</a> 1.8.10
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|