blob: eede543b2937435d8e88836c710ab56cb5e3185f [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>NAND Sequence Execution Codes</title>
<title>CMSIS-Driver: NAND Sequence Execution Codes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
&#160;<span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
<li><a href="modules.html"><span>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('group__nand__driver__seq__exec__codes.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">NAND Sequence Execution Codes<div class="ingroups"><a class="el" href="group__nand__interface__gr.html">NAND Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify execution codes.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaef90c96cd4f2309044d7d438c6b0930a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#gaef90c96cd4f2309044d7d438c6b0930a">ARM_NAND_CODE_SEND_CMD1</a>&#160;&#160;&#160;(1UL &lt;&lt; 17)</td></tr>
<tr class="memdesc:gaef90c96cd4f2309044d7d438c6b0930a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send Command 1. <a href="#gaef90c96cd4f2309044d7d438c6b0930a">More...</a><br/></td></tr>
<tr class="separator:gaef90c96cd4f2309044d7d438c6b0930a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga891bcba60ebb1195ec80c00c9bec748a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga891bcba60ebb1195ec80c00c9bec748a">ARM_NAND_CODE_SEND_ADDR_COL1</a>&#160;&#160;&#160;(1UL &lt;&lt; 18)</td></tr>
<tr class="memdesc:ga891bcba60ebb1195ec80c00c9bec748a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send Column Address 1. <a href="#ga891bcba60ebb1195ec80c00c9bec748a">More...</a><br/></td></tr>
<tr class="separator:ga891bcba60ebb1195ec80c00c9bec748a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga62a3f6ddcfb9ee317655bbec9e09bc10"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga62a3f6ddcfb9ee317655bbec9e09bc10">ARM_NAND_CODE_SEND_ADDR_COL2</a>&#160;&#160;&#160;(1UL &lt;&lt; 19)</td></tr>
<tr class="memdesc:ga62a3f6ddcfb9ee317655bbec9e09bc10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send Column Address 2. <a href="#ga62a3f6ddcfb9ee317655bbec9e09bc10">More...</a><br/></td></tr>
<tr class="separator:ga62a3f6ddcfb9ee317655bbec9e09bc10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadc001e69d1e81dc28a542237c6fe11ff"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#gadc001e69d1e81dc28a542237c6fe11ff">ARM_NAND_CODE_SEND_ADDR_ROW1</a>&#160;&#160;&#160;(1UL &lt;&lt; 20)</td></tr>
<tr class="memdesc:gadc001e69d1e81dc28a542237c6fe11ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send Row Address 1. <a href="#gadc001e69d1e81dc28a542237c6fe11ff">More...</a><br/></td></tr>
<tr class="separator:gadc001e69d1e81dc28a542237c6fe11ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5e55628cb59f5d7d35c529f04ebfcd10"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga5e55628cb59f5d7d35c529f04ebfcd10">ARM_NAND_CODE_SEND_ADDR_ROW2</a>&#160;&#160;&#160;(1UL &lt;&lt; 21)</td></tr>
<tr class="memdesc:ga5e55628cb59f5d7d35c529f04ebfcd10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send Row Address 2. <a href="#ga5e55628cb59f5d7d35c529f04ebfcd10">More...</a><br/></td></tr>
<tr class="separator:ga5e55628cb59f5d7d35c529f04ebfcd10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeb5d1be9c13b7ad2ad246d5db10cd419"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#gaeb5d1be9c13b7ad2ad246d5db10cd419">ARM_NAND_CODE_SEND_ADDR_ROW3</a>&#160;&#160;&#160;(1UL &lt;&lt; 22)</td></tr>
<tr class="memdesc:gaeb5d1be9c13b7ad2ad246d5db10cd419"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send Row Address 3. <a href="#gaeb5d1be9c13b7ad2ad246d5db10cd419">More...</a><br/></td></tr>
<tr class="separator:gaeb5d1be9c13b7ad2ad246d5db10cd419"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga959522c98183036da32984dd5e07979b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga959522c98183036da32984dd5e07979b">ARM_NAND_CODE_INC_ADDR_ROW</a>&#160;&#160;&#160;(1UL &lt;&lt; 23)</td></tr>
<tr class="memdesc:ga959522c98183036da32984dd5e07979b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Auto-increment Row Address. <a href="#ga959522c98183036da32984dd5e07979b">More...</a><br/></td></tr>
<tr class="separator:ga959522c98183036da32984dd5e07979b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1b40fc5fbf22dc4fa8130f5836e30d12"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga1b40fc5fbf22dc4fa8130f5836e30d12">ARM_NAND_CODE_WRITE_DATA</a>&#160;&#160;&#160;(1UL &lt;&lt; 24)</td></tr>
<tr class="memdesc:ga1b40fc5fbf22dc4fa8130f5836e30d12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write Data. <a href="#ga1b40fc5fbf22dc4fa8130f5836e30d12">More...</a><br/></td></tr>
<tr class="separator:ga1b40fc5fbf22dc4fa8130f5836e30d12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacffafbbbca74f7ffa4cd3bb6b067c4ef"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#gacffafbbbca74f7ffa4cd3bb6b067c4ef">ARM_NAND_CODE_SEND_CMD2</a>&#160;&#160;&#160;(1UL &lt;&lt; 25)</td></tr>
<tr class="memdesc:gacffafbbbca74f7ffa4cd3bb6b067c4ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send Command 2. <a href="#gacffafbbbca74f7ffa4cd3bb6b067c4ef">More...</a><br/></td></tr>
<tr class="separator:gacffafbbbca74f7ffa4cd3bb6b067c4ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0f4a8b1e97656e09f1c383852f290a37"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga0f4a8b1e97656e09f1c383852f290a37">ARM_NAND_CODE_WAIT_BUSY</a>&#160;&#160;&#160;(1UL &lt;&lt; 26)</td></tr>
<tr class="memdesc:ga0f4a8b1e97656e09f1c383852f290a37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait while R/Bn busy. <a href="#ga0f4a8b1e97656e09f1c383852f290a37">More...</a><br/></td></tr>
<tr class="separator:ga0f4a8b1e97656e09f1c383852f290a37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab524d840ab57c720ce8560144651dc9d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#gab524d840ab57c720ce8560144651dc9d">ARM_NAND_CODE_READ_DATA</a>&#160;&#160;&#160;(1UL &lt;&lt; 27)</td></tr>
<tr class="memdesc:gab524d840ab57c720ce8560144651dc9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read Data. <a href="#gab524d840ab57c720ce8560144651dc9d">More...</a><br/></td></tr>
<tr class="separator:gab524d840ab57c720ce8560144651dc9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga20f96743ab77bda14ba391dc0c3cdba5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga20f96743ab77bda14ba391dc0c3cdba5">ARM_NAND_CODE_SEND_CMD3</a>&#160;&#160;&#160;(1UL &lt;&lt; 28)</td></tr>
<tr class="memdesc:ga20f96743ab77bda14ba391dc0c3cdba5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send Command 3. <a href="#ga20f96743ab77bda14ba391dc0c3cdba5">More...</a><br/></td></tr>
<tr class="separator:ga20f96743ab77bda14ba391dc0c3cdba5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2250f6a532d2c0834bfdc618761ddc86"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__seq__exec__codes.html#ga2250f6a532d2c0834bfdc618761ddc86">ARM_NAND_CODE_READ_STATUS</a>&#160;&#160;&#160;(1UL &lt;&lt; 29)</td></tr>
<tr class="memdesc:ga2250f6a532d2c0834bfdc618761ddc86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read Status byte and check FAIL bit (bit 0) <a href="#ga2250f6a532d2c0834bfdc618761ddc86">More...</a><br/></td></tr>
<tr class="separator:ga2250f6a532d2c0834bfdc618761ddc86"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify execution codes. </p>
<p>The defines can be used in the function <a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a> for the parameter <em>code</em>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaef90c96cd4f2309044d7d438c6b0930a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_CMD1&#160;&#160;&#160;(1UL &lt;&lt; 17)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Command 1. </p>
</div>
</div>
<a class="anchor" id="ga891bcba60ebb1195ec80c00c9bec748a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_ADDR_COL1&#160;&#160;&#160;(1UL &lt;&lt; 18)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Column Address 1. </p>
</div>
</div>
<a class="anchor" id="ga62a3f6ddcfb9ee317655bbec9e09bc10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_ADDR_COL2&#160;&#160;&#160;(1UL &lt;&lt; 19)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Column Address 2. </p>
</div>
</div>
<a class="anchor" id="gadc001e69d1e81dc28a542237c6fe11ff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_ADDR_ROW1&#160;&#160;&#160;(1UL &lt;&lt; 20)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Row Address 1. </p>
</div>
</div>
<a class="anchor" id="ga5e55628cb59f5d7d35c529f04ebfcd10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_ADDR_ROW2&#160;&#160;&#160;(1UL &lt;&lt; 21)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Row Address 2. </p>
</div>
</div>
<a class="anchor" id="gaeb5d1be9c13b7ad2ad246d5db10cd419"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_ADDR_ROW3&#160;&#160;&#160;(1UL &lt;&lt; 22)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Row Address 3. </p>
</div>
</div>
<a class="anchor" id="ga959522c98183036da32984dd5e07979b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_INC_ADDR_ROW&#160;&#160;&#160;(1UL &lt;&lt; 23)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Auto-increment Row Address. </p>
</div>
</div>
<a class="anchor" id="ga1b40fc5fbf22dc4fa8130f5836e30d12"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_WRITE_DATA&#160;&#160;&#160;(1UL &lt;&lt; 24)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Write Data. </p>
</div>
</div>
<a class="anchor" id="gacffafbbbca74f7ffa4cd3bb6b067c4ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_CMD2&#160;&#160;&#160;(1UL &lt;&lt; 25)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Command 2. </p>
</div>
</div>
<a class="anchor" id="ga0f4a8b1e97656e09f1c383852f290a37"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_WAIT_BUSY&#160;&#160;&#160;(1UL &lt;&lt; 26)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait while R/Bn busy. </p>
</div>
</div>
<a class="anchor" id="gab524d840ab57c720ce8560144651dc9d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_READ_DATA&#160;&#160;&#160;(1UL &lt;&lt; 27)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read Data. </p>
</div>
</div>
<a class="anchor" id="ga20f96743ab77bda14ba391dc0c3cdba5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_SEND_CMD3&#160;&#160;&#160;(1UL &lt;&lt; 28)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Command 3. </p>
</div>
</div>
<a class="anchor" id="ga2250f6a532d2c0834bfdc618761ddc86"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_CODE_READ_STATUS&#160;&#160;&#160;(1UL &lt;&lt; 29)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read Status byte and check FAIL bit (bit 0) </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>