677 lines
35 KiB
HTML
677 lines
35 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.5"/>
|
|
<title>MCUXpresso SDK API Reference Manual: Nor Flash Component</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="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>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="customdoxygen.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="projectlogo"><img alt="Logo" src="fs_logo.gif"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">MCUXpresso SDK API Reference Manual
|
|
 <span id="projectnumber">Rev 2.15.000</span>
|
|
</div>
|
|
<div id="projectbrief">NXP Semiconductors</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<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="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>API Reference</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('a00041.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>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><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="summary">
|
|
<a href="#groups">Modules</a> |
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#typedef-members">Typedefs</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Nor Flash Component<div class="ingroups"><a class="el" href="a00282.html">Flash_Adapter</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
|
|
Modules</h2></td></tr>
|
|
<tr class="memitem:a00287"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00287.html">Old Nor Flash</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00286"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00286.html">Spifi Nor Flash</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="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:a00374"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#a00374">_nor_config</a></td></tr>
|
|
<tr class="memdesc:a00374"><td class="mdescLeft"> </td><td class="mdescRight">NOR Flash Config block structure. <a href="a00041.html#a00374">More...</a><br/></td></tr>
|
|
<tr class="separator:a00374"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00375"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#a00375">_nor_handle</a></td></tr>
|
|
<tr class="memdesc:a00375"><td class="mdescLeft"> </td><td class="mdescRight">NOR Flash handle info. <a href="a00041.html#a00375">More...</a><br/></td></tr>
|
|
<tr class="separator:a00375"><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:gae6b53d081f19dc7dfbfc1ea3f1a44ab6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae6b53d081f19dc7dfbfc1ea3f1a44ab6"></a>
|
|
typedef struct <a class="el" href="a00041.html#a00374">_nor_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#gae6b53d081f19dc7dfbfc1ea3f1a44ab6">nor_config_t</a></td></tr>
|
|
<tr class="memdesc:gae6b53d081f19dc7dfbfc1ea3f1a44ab6"><td class="mdescLeft"> </td><td class="mdescRight">NOR Flash Config block structure. <br/></td></tr>
|
|
<tr class="separator:gae6b53d081f19dc7dfbfc1ea3f1a44ab6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5cf0755e523bb79ff9edfb32de6619b7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5cf0755e523bb79ff9edfb32de6619b7"></a>
|
|
typedef struct <a class="el" href="a00041.html#a00375">_nor_handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a></td></tr>
|
|
<tr class="memdesc:ga5cf0755e523bb79ff9edfb32de6619b7"><td class="mdescLeft"> </td><td class="mdescRight">NOR Flash handle info. <br/></td></tr>
|
|
<tr class="separator:ga5cf0755e523bb79ff9edfb32de6619b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
NOR FLASH Driver</h2></td></tr>
|
|
<tr class="memitem:ga9a202340c787129bb3daa181e0f5101d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#ga9a202340c787129bb3daa181e0f5101d">Nor_Flash_Init</a> (<a class="el" href="a00041.html#gae6b53d081f19dc7dfbfc1ea3f1a44ab6">nor_config_t</a> *config, <a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:ga9a202340c787129bb3daa181e0f5101d"><td class="mdescLeft"> </td><td class="mdescRight">Initialize NOR FLASH devices. <a href="#ga9a202340c787129bb3daa181e0f5101d">More...</a><br/></td></tr>
|
|
<tr class="separator:ga9a202340c787129bb3daa181e0f5101d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga17a80712fcf69e2b51c7943d8409a631"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#ga17a80712fcf69e2b51c7943d8409a631">Nor_Flash_Read</a> (<a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> *handle, uint32_t address, uint8_t *buffer, uint32_t length)</td></tr>
|
|
<tr class="memdesc:ga17a80712fcf69e2b51c7943d8409a631"><td class="mdescLeft"> </td><td class="mdescRight">Read page data from NOR Flash. <a href="#ga17a80712fcf69e2b51c7943d8409a631">More...</a><br/></td></tr>
|
|
<tr class="separator:ga17a80712fcf69e2b51c7943d8409a631"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad7c37a782e5c1f97611d91e86c456c1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#gad7c37a782e5c1f97611d91e86c456c1c">Nor_Flash_Page_Program</a> (<a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> *handle, uint32_t address, uint8_t *buffer)</td></tr>
|
|
<tr class="memdesc:gad7c37a782e5c1f97611d91e86c456c1c"><td class="mdescLeft"> </td><td class="mdescRight">Program page data to NOR Flash. <a href="#gad7c37a782e5c1f97611d91e86c456c1c">More...</a><br/></td></tr>
|
|
<tr class="separator:gad7c37a782e5c1f97611d91e86c456c1c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga29bb9d49d082a0e84e239661d209c5a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#ga29bb9d49d082a0e84e239661d209c5a2">Nor_Flash_Program</a> (<a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> *handle, uint32_t address, uint8_t *buffer, uint32_t length)</td></tr>
|
|
<tr class="memdesc:ga29bb9d49d082a0e84e239661d209c5a2"><td class="mdescLeft"> </td><td class="mdescRight">Program data to NOR Flash. <a href="#ga29bb9d49d082a0e84e239661d209c5a2">More...</a><br/></td></tr>
|
|
<tr class="separator:ga29bb9d49d082a0e84e239661d209c5a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga85dab0640e60b378edfa3ef5398010cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#ga85dab0640e60b378edfa3ef5398010cc">Nor_Flash_Erase_Sector</a> (<a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> *handle, uint32_t address)</td></tr>
|
|
<tr class="memdesc:ga85dab0640e60b378edfa3ef5398010cc"><td class="mdescLeft"> </td><td class="mdescRight">Erase sector. <a href="#ga85dab0640e60b378edfa3ef5398010cc">More...</a><br/></td></tr>
|
|
<tr class="separator:ga85dab0640e60b378edfa3ef5398010cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga87fc2e3ecaf45a2c8670784969a83329"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#ga87fc2e3ecaf45a2c8670784969a83329">Nor_Flash_Erase_Block</a> (<a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> *handle, uint32_t address)</td></tr>
|
|
<tr class="memdesc:ga87fc2e3ecaf45a2c8670784969a83329"><td class="mdescLeft"> </td><td class="mdescRight">Erase block. <a href="#ga87fc2e3ecaf45a2c8670784969a83329">More...</a><br/></td></tr>
|
|
<tr class="separator:ga87fc2e3ecaf45a2c8670784969a83329"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa6109d3d6fb6e7fa0a7d04e4dd519c7b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#gaa6109d3d6fb6e7fa0a7d04e4dd519c7b">Nor_Flash_Erase</a> (<a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> *handle, uint32_t address, uint32_t size_Byte)</td></tr>
|
|
<tr class="memdesc:gaa6109d3d6fb6e7fa0a7d04e4dd519c7b"><td class="mdescLeft"> </td><td class="mdescRight">Erase flash with any size. <a href="#gaa6109d3d6fb6e7fa0a7d04e4dd519c7b">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa6109d3d6fb6e7fa0a7d04e4dd519c7b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac4c64eaab5a630924d5b58c4b5d988b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#gac4c64eaab5a630924d5b58c4b5d988b3">Nor_Flash_Erase_Chip</a> (<a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:gac4c64eaab5a630924d5b58c4b5d988b3"><td class="mdescLeft"> </td><td class="mdescRight">Erase Chip NOR Flash . <a href="#gac4c64eaab5a630924d5b58c4b5d988b3">More...</a><br/></td></tr>
|
|
<tr class="separator:gac4c64eaab5a630924d5b58c4b5d988b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga39fc37e62c54caea4d09596d28aac00c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#ga39fc37e62c54caea4d09596d28aac00c">Nor_Flash_Is_Busy</a> (<a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> *handle, bool *isBusy)</td></tr>
|
|
<tr class="memdesc:ga39fc37e62c54caea4d09596d28aac00c"><td class="mdescLeft"> </td><td class="mdescRight">Get the busy status of the NOR Flash. <a href="#ga39fc37e62c54caea4d09596d28aac00c">More...</a><br/></td></tr>
|
|
<tr class="separator:ga39fc37e62c54caea4d09596d28aac00c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4c9eb7defeca9f3e162f23321fdacfd2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#ga4c9eb7defeca9f3e162f23321fdacfd2">Nor_Flash_DeInit</a> (<a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:ga4c9eb7defeca9f3e162f23321fdacfd2"><td class="mdescLeft"> </td><td class="mdescRight">Deinitialize NOR FLASH devices. <a href="#ga4c9eb7defeca9f3e162f23321fdacfd2">More...</a><br/></td></tr>
|
|
<tr class="separator:ga4c9eb7defeca9f3e162f23321fdacfd2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00374" id="a00374"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _nor_config</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a2e414a9550e802834cfab0554392269d"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#a2e414a9550e802834cfab0554392269d">memControlConfig</a></td></tr>
|
|
<tr class="memdesc:a2e414a9550e802834cfab0554392269d"><td class="mdescLeft"> </td><td class="mdescRight">memory controller configuration, should be assigned to specific controller configuration structure pointer. <a href="#a2e414a9550e802834cfab0554392269d">More...</a><br/></td></tr>
|
|
<tr class="separator:a2e414a9550e802834cfab0554392269d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a2e414a9550e802834cfab0554392269d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* _nor_config::memControlConfig</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="a00375" id="a00375"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _nor_handle</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a3d22766aa34f4e950da5a4a8f9b36097"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#a3d22766aa34f4e950da5a4a8f9b36097">bytesInPageSize</a></td></tr>
|
|
<tr class="memdesc:a3d22766aa34f4e950da5a4a8f9b36097"><td class="mdescLeft"> </td><td class="mdescRight">Driver Base address. <a href="#a3d22766aa34f4e950da5a4a8f9b36097">More...</a><br/></td></tr>
|
|
<tr class="separator:a3d22766aa34f4e950da5a4a8f9b36097"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5fea00c9a4949b1553d56b4bcc7c47bf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5fea00c9a4949b1553d56b4bcc7c47bf"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#a5fea00c9a4949b1553d56b4bcc7c47bf">bytesInSectorSize</a></td></tr>
|
|
<tr class="memdesc:a5fea00c9a4949b1553d56b4bcc7c47bf"><td class="mdescLeft"> </td><td class="mdescRight">Minimun Sector size in byte supported by Serial NOR. <br/></td></tr>
|
|
<tr class="separator:a5fea00c9a4949b1553d56b4bcc7c47bf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acefe9be65372fd4575e1fe2ccd7f3f6e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acefe9be65372fd4575e1fe2ccd7f3f6e"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#acefe9be65372fd4575e1fe2ccd7f3f6e">bytesInMemorySize</a></td></tr>
|
|
<tr class="memdesc:acefe9be65372fd4575e1fe2ccd7f3f6e"><td class="mdescLeft"> </td><td class="mdescRight">Memory size in byte of Serial NOR. <br/></td></tr>
|
|
<tr class="separator:acefe9be65372fd4575e1fe2ccd7f3f6e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a332dca9d485105080c8e4c2eb1da06cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a332dca9d485105080c8e4c2eb1da06cc"></a>
|
|
void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00041.html#a332dca9d485105080c8e4c2eb1da06cc">deviceSpecific</a></td></tr>
|
|
<tr class="memdesc:a332dca9d485105080c8e4c2eb1da06cc"><td class="mdescLeft"> </td><td class="mdescRight">Device specific control parameter. <br/></td></tr>
|
|
<tr class="separator:a332dca9d485105080c8e4c2eb1da06cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a3d22766aa34f4e950da5a4a8f9b36097"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t _nor_handle::bytesInPageSize</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Page size in byte of Serial NOR </p>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga9a202340c787129bb3daa181e0f5101d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> Nor_Flash_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00041.html#gae6b53d081f19dc7dfbfc1ea3f1a44ab6">nor_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function initialize NOR Flash controller and NOR Flash.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>NOR flash configuration. The "memControlConfig" and "driverBaseAddr" are controller specific structure. please set those two parameter with your Nand controller configuration structure type pointer. such as for SEMC:</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>spifi_mem_nor_config_t spifiNorconfig = { ..... } nor_config_t config = { .memControlConfig = (void *)&spifiNorconfig; .driverBaseAddr = (void *)SPIFI0; } </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">handle</td><td>The NOR Flash handler. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">execution</td><td>status </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga17a80712fcf69e2b51c7943d8409a631"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> Nor_Flash_Read </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>address</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">handle</td><td>The NOR Flash handler. </td></tr>
|
|
<tr><td class="paramname">address</td><td>NOR flash start address to read data from. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>NOR flash buffer to read data to. </td></tr>
|
|
<tr><td class="paramname">length</td><td>NOR flash read length. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">execution</td><td>status </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad7c37a782e5c1f97611d91e86c456c1c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> Nor_Flash_Page_Program </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>address</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>buffer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">handle</td><td>The NOR Flash handler. </td></tr>
|
|
<tr><td class="paramname">address</td><td>The address to be programed. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>The buffer to be programed to the page. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">execution</td><td>status </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga29bb9d49d082a0e84e239661d209c5a2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> Nor_Flash_Program </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>address</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">handle</td><td>The NOR Flash handler. </td></tr>
|
|
<tr><td class="paramname">address</td><td>The address to be programed. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>The buffer to be programed to the page. </td></tr>
|
|
<tr><td class="paramname">length</td><td>The data length to be programed to the page. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">execution</td><td>status </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga85dab0640e60b378edfa3ef5398010cc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> Nor_Flash_Erase_Sector </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>address</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">handle</td><td>The NOR Flash handler. </td></tr>
|
|
<tr><td class="paramname">address</td><td>The start address to be erased. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">execution</td><td>status </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga87fc2e3ecaf45a2c8670784969a83329"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> Nor_Flash_Erase_Block </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>address</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">handle</td><td>The NOR Flash handler. </td></tr>
|
|
<tr><td class="paramname">address</td><td>The start address to be erased. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">execution</td><td>status </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa6109d3d6fb6e7fa0a7d04e4dd519c7b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> Nor_Flash_Erase </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>address</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>size_Byte</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">handle</td><td>The NOR Flash handler. </td></tr>
|
|
<tr><td class="paramname">address</td><td>The start address to be erased. </td></tr>
|
|
<tr><td class="paramname">size_Byte</td><td>Erase flash size. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">execution</td><td>status </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac4c64eaab5a630924d5b58c4b5d988b3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> Nor_Flash_Erase_Chip </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">handle</td><td>The NOR Flash handler. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">execution</td><td>status </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga39fc37e62c54caea4d09596d28aac00c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> Nor_Flash_Is_Busy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool * </td>
|
|
<td class="paramname"><em>isBusy</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">handle</td><td>The NOR Flash handler. </td></tr>
|
|
<tr><td class="paramname">isBusy</td><td>Pointer of the variable which has the busy status of the NOR flash. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">execution</td><td>status </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga4c9eb7defeca9f3e162f23321fdacfd2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> Nor_Flash_DeInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00041.html#ga5cf0755e523bb79ff9edfb32de6619b7">nor_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">handle</td><td>The NOR Flash handler. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">execution</td><td>status </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.5-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul class="foot">
|
|
<li class="footer">© 2016 NXP Semiconductors. All rights reserved.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|