]> begriffs open source - cmsis/blob - dev/v6.0.0-dev84/Driver/group__nand__driver__ecc__codes.html
Update documentation for release v6.1.0
[cmsis] / dev / v6.0.0-dev84 / Driver / group__nand__driver__ecc__codes.html
1 <!-- HTML header for doxygen 1.9.6-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>CMSIS-Driver: NAND ECC Codes</title>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <script type="text/javascript" src="tabs.js"></script>
13 <script type="text/javascript" src="footer.js"></script>
14 <script type="text/javascript" src="navtree.js"></script>
15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
16 <script type="text/javascript" src="resize.js"></script>
17 <script type="text/javascript" src="navtreedata.js"></script>
18 <script type="text/javascript" src="navtree.js"></script>
19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="search/searchdata.js"></script>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
24   $(document).ready(function() { init_search(); });
25 /* @license-end */
26 </script>
27 <script type="text/javascript" src="darkmode_toggle.js"></script>
28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
32 <link href="version.css" rel="stylesheet" type="text/css"/>
33 <script type="text/javascript" src="../../version.js"></script>
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 55px;">
41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
43    <div id="projectname">CMSIS-Driver
44    &#160;<span id="projectnumber"><script type="text/javascript">
45      <!--
46      writeHeader.call(this);
47      writeVersionDropdown.call(this, "CMSIS-Driver");
48      //-->
49     </script>
50    </span>
51    </div>
52    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
53   </td>
54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
55         <span class="left">
56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
58                onfocus="searchBox.OnSearchFieldFocus(true)" 
59                onblur="searchBox.OnSearchFieldFocus(false)" 
60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
61           </span><span class="right">
62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
63           </span>
64         </div>
65 </td>
66   <!--END !PROJECT_NAME-->
67  </tr>
68  </tbody>
69 </table>
70 </div>
71 <!-- end header part -->
72 <div id="CMSISnav" class="tabs1">
73   <ul class="tablist">
74     <script type="text/javascript">
75       writeComponentTabs.call(this);
76     </script>
77   </ul>
78 </div>
79 <script type="text/javascript">
80   writeSubComponentTabs.call(this);
81 </script>
82 <!-- Generated by Doxygen 1.9.6 -->
83 <script type="text/javascript">
84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
85 var searchBox = new SearchBox("searchBox", "search/",'.html');
86 /* @license-end */
87 </script>
88 </div><!-- top -->
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
90   <div id="nav-tree">
91     <div id="nav-tree-contents">
92       <div id="nav-sync" class="sync"></div>
93     </div>
94   </div>
95   <div id="splitbar" style="-moz-user-select:none;" 
96        class="ui-resizable-handle">
97   </div>
98 </div>
99 <script type="text/javascript">
100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
101 $(document).ready(function(){initNavTree('group__nand__driver__ecc__codes.html',''); initResizable(); });
102 /* @license-end */
103 </script>
104 <div id="doc-content">
105 <!-- window showing the filter options -->
106 <div id="MSearchSelectWindow"
107      onmouseover="return searchBox.OnSearchSelectShow()"
108      onmouseout="return searchBox.OnSearchSelectHide()"
109      onkeydown="return searchBox.OnSearchSelectKey(event)">
110 </div>
111
112 <!-- iframe showing the search results (closed by default) -->
113 <div id="MSearchResultsWindow">
114 <div id="MSearchResults">
115 <div class="SRPage">
116 <div id="SRIndex">
117 <div id="SRResults"></div>
118 <div class="SRStatus" id="Loading">Loading...</div>
119 <div class="SRStatus" id="Searching">Searching...</div>
120 <div class="SRStatus" id="NoMatches">No Matches</div>
121 </div>
122 </div>
123 </div>
124 </div>
125
126 <div class="header">
127   <div class="summary">
128 <a href="#define-members">Macros</a>  </div>
129   <div class="headertitle"><div class="title">NAND ECC Codes<div class="ingroups"><a class="el" href="group__nand__interface__gr.html">NAND Interface</a></div></div></div>
130 </div><!--header-->
131 <div class="contents">
132
133 <p>Specify ECC codes.  
134 <a href="#details">More...</a></p>
135 <table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
137 Macros</h2></td></tr>
138 <tr class="memitem:gac2eb4475f12a443209165d29fe200030"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__ecc__codes.html#gac2eb4475f12a443209165d29fe200030">ARM_NAND_ECC</a>(n)&#160;&#160;&#160;((n) &amp; <a class="el" href="Driver__NAND_8h.html#a656537439264ab495c86e4c36051a3c1">ARM_NAND_ECC_INDEX_Msk</a>)</td></tr>
139 <tr class="memdesc:gac2eb4475f12a443209165d29fe200030"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select ECC.  <br /></td></tr>
140 <tr class="separator:gac2eb4475f12a443209165d29fe200030"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:ga15c79a12200c16f953936635f930df1d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__ecc__codes.html#ga15c79a12200c16f953936635f930df1d">ARM_NAND_ECC0</a>&#160;&#160;&#160;(1UL &lt;&lt; 8)</td></tr>
142 <tr class="memdesc:ga15c79a12200c16f953936635f930df1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use ECC0 of selected ECC.  <br /></td></tr>
143 <tr class="separator:ga15c79a12200c16f953936635f930df1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:gaee653288a88318ee33d1db81baa69bbc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nand__driver__ecc__codes.html#gaee653288a88318ee33d1db81baa69bbc">ARM_NAND_ECC1</a>&#160;&#160;&#160;(1UL &lt;&lt; 9)</td></tr>
145 <tr class="memdesc:gaee653288a88318ee33d1db81baa69bbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use ECC1 of selected ECC.  <br /></td></tr>
146 <tr class="separator:gaee653288a88318ee33d1db81baa69bbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 </table>
148 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
149 <p>Specify ECC codes. </p>
150 <p>The defines can be used in the function <a class="el" href="group__nand__interface__gr.html#gae1899a20ef107400c8bf84fad477a8ce">ARM_NAND_ReadData</a> and <a class="el" href="group__nand__interface__gr.html#ga1fa497dd51a86fc308e946b4419fd006">ARM_NAND_WriteData</a> for the parameter <em>mode</em> and in the function <a class="el" href="group__nand__interface__gr.html#ga8a0108dba757a4610475151144b52825">ARM_NAND_ExecuteSequence</a> for the parameter <em>code</em>. </p>
151 <h2 class="groupheader">Macro Definition Documentation</h2>
152 <a id="gac2eb4475f12a443209165d29fe200030" name="gac2eb4475f12a443209165d29fe200030"></a>
153 <h2 class="memtitle"><span class="permalink"><a href="#gac2eb4475f12a443209165d29fe200030">&#9670;&#160;</a></span>ARM_NAND_ECC</h2>
154
155 <div class="memitem">
156 <div class="memproto">
157       <table class="memname">
158         <tr>
159           <td class="memname">#define ARM_NAND_ECC</td>
160           <td>(</td>
161           <td class="paramtype">&#160;</td>
162           <td class="paramname">n</td><td>)</td>
163           <td>&#160;&#160;&#160;((n) &amp; <a class="el" href="Driver__NAND_8h.html#a656537439264ab495c86e4c36051a3c1">ARM_NAND_ECC_INDEX_Msk</a>)</td>
164         </tr>
165       </table>
166 </div><div class="memdoc">
167
168 <p>Select ECC. </p>
169
170 </div>
171 </div>
172 <a id="ga15c79a12200c16f953936635f930df1d" name="ga15c79a12200c16f953936635f930df1d"></a>
173 <h2 class="memtitle"><span class="permalink"><a href="#ga15c79a12200c16f953936635f930df1d">&#9670;&#160;</a></span>ARM_NAND_ECC0</h2>
174
175 <div class="memitem">
176 <div class="memproto">
177       <table class="memname">
178         <tr>
179           <td class="memname">#define ARM_NAND_ECC0&#160;&#160;&#160;(1UL &lt;&lt; 8)</td>
180         </tr>
181       </table>
182 </div><div class="memdoc">
183
184 <p>Use ECC0 of selected ECC. </p>
185
186 </div>
187 </div>
188 <a id="gaee653288a88318ee33d1db81baa69bbc" name="gaee653288a88318ee33d1db81baa69bbc"></a>
189 <h2 class="memtitle"><span class="permalink"><a href="#gaee653288a88318ee33d1db81baa69bbc">&#9670;&#160;</a></span>ARM_NAND_ECC1</h2>
190
191 <div class="memitem">
192 <div class="memproto">
193       <table class="memname">
194         <tr>
195           <td class="memname">#define ARM_NAND_ECC1&#160;&#160;&#160;(1UL &lt;&lt; 9)</td>
196         </tr>
197       </table>
198 </div><div class="memdoc">
199
200 <p>Use ECC1 of selected ECC. </p>
201
202 </div>
203 </div>
204 </div><!-- contents -->
205 </div><!-- doc-content -->
206 <!-- start footer part -->
207 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
208   <ul>
209     <li class="footer">
210       <script type="text/javascript">
211         <!--
212         writeFooter.call(this);
213         //-->
214       </script> 
215     </li>
216   </ul>
217 </div>
218 </body>
219 </html>