]> begriffs open source - cmsis/blob - dev/v6.0.0-dev53/Driver/html/group__mci__bus__data__width__ctrls.html
Update documentation for release dev/v6.0.0-dev53
[cmsis] / dev / v6.0.0-dev53 / Driver / html / group__mci__bus__data__width__ctrls.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: MCI Bus Data Width</title>
9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="jquery.js"></script>
15 <script type="text/javascript" src="dynsections.js"></script>
16 <script type="text/javascript" src="printComponentTabs.js"></script>
17 <script type="text/javascript" src="footer.js"></script>
18 <script type="text/javascript" src="navtree.js"></script>
19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="resize.js"></script>
21 <script type="text/javascript" src="navtreedata.js"></script>
22 <script type="text/javascript" src="navtree.js"></script>
23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
24 <script type="text/javascript" src="search/searchdata.js"></script>
25 <script type="text/javascript" src="search/search.js"></script>
26 <script type="text/javascript">
27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
28   $(document).ready(function() { init_search(); });
29 /* @license-end */
30 </script>
31 <script type="text/javascript" src="darkmode_toggle.js"></script>
32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
35 <link href="version.css" rel="stylesheet" type="text/css" />
36 <script type="text/javascript" src="../../../version.js"></script>
37 </head>
38 <body>
39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
40 <div id="titlearea">
41 <table cellspacing="0" cellpadding="0">
42  <tbody>
43  <tr style="height: 55px;">
44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
46    <div id="projectname">CMSIS-Driver
47    &#160;<span id="projectnumber"><script type="text/javascript">
48      <!--
49      writeHeader.call(this);
50      writeVersionDropdown.call(this);
51      //-->
52     </script>
53    </span>
54    </div>
55    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
56   </td>
57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
58         <span class="left">
59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
61                onfocus="searchBox.OnSearchFieldFocus(true)" 
62                onblur="searchBox.OnSearchFieldFocus(false)" 
63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
64           </span><span class="right">
65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
66           </span>
67         </div>
68 </td>
69   <!--END !PROJECT_NAME-->
70  </tr>
71  </tbody>
72 </table>
73 </div>
74 <!-- end header part -->
75 <div id="CMSISnav" class="tabs1">
76   <ul class="tablist">
77     <script type="text/javascript">
78       writeComponentTabs.call(this);
79     </script>
80   </ul>
81 </div>
82 <script type="text/javascript">
83   writeSubComponentTabs.call(this);
84 </script>
85 <!-- Generated by Doxygen 1.9.6 -->
86 <script type="text/javascript">
87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
88 var searchBox = new SearchBox("searchBox", "search/",'.html');
89 /* @license-end */
90 </script>
91 </div><!-- top -->
92 <div id="side-nav" class="ui-resizable side-nav-resizable">
93   <div id="nav-tree">
94     <div id="nav-tree-contents">
95       <div id="nav-sync" class="sync"></div>
96     </div>
97   </div>
98   <div id="splitbar" style="-moz-user-select:none;" 
99        class="ui-resizable-handle">
100   </div>
101 </div>
102 <script type="text/javascript">
103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
104 $(document).ready(function(){initNavTree('group__mci__bus__data__width__ctrls.html',''); initResizable(); });
105 /* @license-end */
106 </script>
107 <div id="doc-content">
108 <!-- window showing the filter options -->
109 <div id="MSearchSelectWindow"
110      onmouseover="return searchBox.OnSearchSelectShow()"
111      onmouseout="return searchBox.OnSearchSelectHide()"
112      onkeydown="return searchBox.OnSearchSelectKey(event)">
113 </div>
114
115 <!-- iframe showing the search results (closed by default) -->
116 <div id="MSearchResultsWindow">
117 <div id="MSearchResults">
118 <div class="SRPage">
119 <div id="SRIndex">
120 <div id="SRResults"></div>
121 <div class="SRStatus" id="Loading">Loading...</div>
122 <div class="SRStatus" id="Searching">Searching...</div>
123 <div class="SRStatus" id="NoMatches">No Matches</div>
124 </div>
125 </div>
126 </div>
127 </div>
128
129 <div class="header">
130   <div class="summary">
131 <a href="#define-members">Macros</a>  </div>
132   <div class="headertitle"><div class="title">MCI Bus Data Width<div class="ingroups"><a class="el" href="group__mci__interface__gr.html">MCI Interface</a> &raquo; <a class="el" href="group__mci__control__gr.html">MCI Control Codes</a></div></div></div>
133 </div><!--header-->
134 <div class="contents">
135
136 <p>Specify the data bus width.  
137 <a href="#details">More...</a></p>
138 <table class="memberdecls">
139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
140 Macros</h2></td></tr>
141 <tr class="memitem:gaa09a00d810a4dfd1d1824311ee290585"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__data__width__ctrls.html#gaa09a00d810a4dfd1d1824311ee290585">ARM_MCI_BUS_DATA_WIDTH_1</a>&#160;&#160;&#160;(0x00UL)</td></tr>
142 <tr class="memdesc:gaa09a00d810a4dfd1d1824311ee290585"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bus data width: 1 bit (default)  <br /></td></tr>
143 <tr class="separator:gaa09a00d810a4dfd1d1824311ee290585"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:gaa28150d8c3789e8cf1bcda318f74a28c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__data__width__ctrls.html#gaa28150d8c3789e8cf1bcda318f74a28c">ARM_MCI_BUS_DATA_WIDTH_4</a>&#160;&#160;&#160;(0x01UL)</td></tr>
145 <tr class="memdesc:gaa28150d8c3789e8cf1bcda318f74a28c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bus data width: 4 bits.  <br /></td></tr>
146 <tr class="separator:gaa28150d8c3789e8cf1bcda318f74a28c"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:ga3bb99a2d98ba9fb8c5bc97fa2b8ef469"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__data__width__ctrls.html#ga3bb99a2d98ba9fb8c5bc97fa2b8ef469">ARM_MCI_BUS_DATA_WIDTH_8</a>&#160;&#160;&#160;(0x02UL)</td></tr>
148 <tr class="memdesc:ga3bb99a2d98ba9fb8c5bc97fa2b8ef469"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bus data width: 8 bits.  <br /></td></tr>
149 <tr class="separator:ga3bb99a2d98ba9fb8c5bc97fa2b8ef469"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:gaccb174bd131f8fd8cd9a56439a8ebb60"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__data__width__ctrls.html#gaccb174bd131f8fd8cd9a56439a8ebb60">ARM_MCI_BUS_DATA_WIDTH_4_DDR</a>&#160;&#160;&#160;(0x03UL)</td></tr>
151 <tr class="memdesc:gaccb174bd131f8fd8cd9a56439a8ebb60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bus data width: 4 bits, DDR (Dual Data Rate) - MMC only.  <br /></td></tr>
152 <tr class="separator:gaccb174bd131f8fd8cd9a56439a8ebb60"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:ga7b31f81ae703229095fe9efcfbe80b47"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__bus__data__width__ctrls.html#ga7b31f81ae703229095fe9efcfbe80b47">ARM_MCI_BUS_DATA_WIDTH_8_DDR</a>&#160;&#160;&#160;(0x04UL)</td></tr>
154 <tr class="memdesc:ga7b31f81ae703229095fe9efcfbe80b47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bus data width: 8 bits, DDR (Dual Data Rate) - MMC only.  <br /></td></tr>
155 <tr class="separator:ga7b31f81ae703229095fe9efcfbe80b47"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 </table>
157 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
158 <p>Specify the data bus width. </p>
159 <p>The function <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> with <em>control</em> = <a class="el" href="group__mci__mode__ctrls.html#ga876d964d0eeacdb16e93f7558a544587">ARM_MCI_BUS_DATA_WIDTH</a> specifies with <em>arg</em> the number of data I/O pins on the SD/MMC interface.</p>
160 <p>For high-speed memory cards, a 4-bit bus data width should be used (or 8-bit for eMMC). The data fields <em>data_width_4</em> and <em>data_width_8</em> of the structure <a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES" title="MCI Driver Capabilities.">ARM_MCI_CAPABILITIES</a> encode whether the driver supports a specific bus data with.</p>
161 <p>The following codes are defined: </p>
162 <h2 class="groupheader">Macro Definition Documentation</h2>
163 <a id="gaa09a00d810a4dfd1d1824311ee290585" name="gaa09a00d810a4dfd1d1824311ee290585"></a>
164 <h2 class="memtitle"><span class="permalink"><a href="#gaa09a00d810a4dfd1d1824311ee290585">&#9670;&#160;</a></span>ARM_MCI_BUS_DATA_WIDTH_1</h2>
165
166 <div class="memitem">
167 <div class="memproto">
168       <table class="memname">
169         <tr>
170           <td class="memname">#define ARM_MCI_BUS_DATA_WIDTH_1&#160;&#160;&#160;(0x00UL)</td>
171         </tr>
172       </table>
173 </div><div class="memdoc">
174
175 <p>Bus data width: 1 bit (default) </p>
176
177 </div>
178 </div>
179 <a id="gaa28150d8c3789e8cf1bcda318f74a28c" name="gaa28150d8c3789e8cf1bcda318f74a28c"></a>
180 <h2 class="memtitle"><span class="permalink"><a href="#gaa28150d8c3789e8cf1bcda318f74a28c">&#9670;&#160;</a></span>ARM_MCI_BUS_DATA_WIDTH_4</h2>
181
182 <div class="memitem">
183 <div class="memproto">
184       <table class="memname">
185         <tr>
186           <td class="memname">#define ARM_MCI_BUS_DATA_WIDTH_4&#160;&#160;&#160;(0x01UL)</td>
187         </tr>
188       </table>
189 </div><div class="memdoc">
190
191 <p>Bus data width: 4 bits. </p>
192
193 </div>
194 </div>
195 <a id="ga3bb99a2d98ba9fb8c5bc97fa2b8ef469" name="ga3bb99a2d98ba9fb8c5bc97fa2b8ef469"></a>
196 <h2 class="memtitle"><span class="permalink"><a href="#ga3bb99a2d98ba9fb8c5bc97fa2b8ef469">&#9670;&#160;</a></span>ARM_MCI_BUS_DATA_WIDTH_8</h2>
197
198 <div class="memitem">
199 <div class="memproto">
200       <table class="memname">
201         <tr>
202           <td class="memname">#define ARM_MCI_BUS_DATA_WIDTH_8&#160;&#160;&#160;(0x02UL)</td>
203         </tr>
204       </table>
205 </div><div class="memdoc">
206
207 <p>Bus data width: 8 bits. </p>
208
209 </div>
210 </div>
211 <a id="gaccb174bd131f8fd8cd9a56439a8ebb60" name="gaccb174bd131f8fd8cd9a56439a8ebb60"></a>
212 <h2 class="memtitle"><span class="permalink"><a href="#gaccb174bd131f8fd8cd9a56439a8ebb60">&#9670;&#160;</a></span>ARM_MCI_BUS_DATA_WIDTH_4_DDR</h2>
213
214 <div class="memitem">
215 <div class="memproto">
216       <table class="memname">
217         <tr>
218           <td class="memname">#define ARM_MCI_BUS_DATA_WIDTH_4_DDR&#160;&#160;&#160;(0x03UL)</td>
219         </tr>
220       </table>
221 </div><div class="memdoc">
222
223 <p>Bus data width: 4 bits, DDR (Dual Data Rate) - MMC only. </p>
224
225 </div>
226 </div>
227 <a id="ga7b31f81ae703229095fe9efcfbe80b47" name="ga7b31f81ae703229095fe9efcfbe80b47"></a>
228 <h2 class="memtitle"><span class="permalink"><a href="#ga7b31f81ae703229095fe9efcfbe80b47">&#9670;&#160;</a></span>ARM_MCI_BUS_DATA_WIDTH_8_DDR</h2>
229
230 <div class="memitem">
231 <div class="memproto">
232       <table class="memname">
233         <tr>
234           <td class="memname">#define ARM_MCI_BUS_DATA_WIDTH_8_DDR&#160;&#160;&#160;(0x04UL)</td>
235         </tr>
236       </table>
237 </div><div class="memdoc">
238
239 <p>Bus data width: 8 bits, DDR (Dual Data Rate) - MMC only. </p>
240
241 </div>
242 </div>
243 </div><!-- contents -->
244 </div><!-- doc-content -->
245 <!-- start footer part -->
246 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
247   <ul>
248     <li class="footer">
249       <script type="text/javascript">
250         <!--
251         writeFooter.call(this);
252         //-->
253       </script> 
254     </li>
255   </ul>
256 </div>
257 </body>
258 </html>