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">
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 Interface</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&dn=expat.txt MIT */
28 $(document).ready(function() { init_search(); });
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>
39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
41 <table cellspacing="0" cellpadding="0">
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  <span id="projectnumber"><script type="text/javascript">
49 writeHeader.call(this);
50 writeVersionDropdown.call(this, "CMSIS-Driver");
55 <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
57 <td> <div id="MSearchBox" class="MSearchBoxInactive">
59 <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </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>
69 <!--END !PROJECT_NAME-->
74 <!-- end header part -->
75 <div id="CMSISnav" class="tabs1">
77 <script type="text/javascript">
78 writeComponentTabs.call(this);
82 <script type="text/javascript">
83 writeSubComponentTabs.call(this);
85 <!-- Generated by Doxygen 1.9.6 -->
86 <script type="text/javascript">
87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
88 var searchBox = new SearchBox("searchBox", "search/",'.html');
92 <div id="side-nav" class="ui-resizable side-nav-resizable">
94 <div id="nav-tree-contents">
95 <div id="nav-sync" class="sync"></div>
98 <div id="splitbar" style="-moz-user-select:none;"
99 class="ui-resizable-handle">
102 <script type="text/javascript">
103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
104 $(document).ready(function(){initNavTree('group__mci__interface__gr.html',''); initResizable(); });
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)">
115 <!-- iframe showing the search results (closed by default) -->
116 <div id="MSearchResultsWindow">
117 <div id="MSearchResults">
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>
130 <div class="summary">
131 <a href="#groups">Content</a> |
132 <a href="#nested-classes">Data Structures</a> |
133 <a href="#typedef-members">Typedefs</a> |
134 <a href="#func-members">Functions</a> </div>
135 <div class="headertitle"><div class="title">MCI Interface</div></div>
137 <div class="contents">
139 <p>Driver API for Memory Card Interface using SD/MMC interface (Driver_MCI.h)
140 <a href="#details">More...</a></p>
141 <table class="memberdecls">
142 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
143 Content</h2></td></tr>
144 <tr class="memitem:group__mci__event__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html">MCI Events</a></td></tr>
145 <tr class="memdesc:group__mci__event__gr"><td class="mdescLeft"> </td><td class="mdescRight">The MCI driver generates call back events that are notified via the function <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a>. <br /></td></tr>
146 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
147 <tr class="memitem:group__mci__control__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__control__gr.html">MCI Control Codes</a></td></tr>
148 <tr class="memdesc:group__mci__control__gr"><td class="mdescLeft"> </td><td class="mdescRight">Configure and control the MCI using the <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a>. <br /></td></tr>
149 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
150 <tr class="memitem:group__mci__send__command__flags__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__send__command__flags__ctrls.html">MCI Send Command Flags</a></td></tr>
151 <tr class="memdesc:group__mci__send__command__flags__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify various options for sending commands to the card and the expected response. <br /></td></tr>
152 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
153 <tr class="memitem:group__mci__transfer__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__transfer__ctrls.html">MCI Transfer Controls</a></td></tr>
154 <tr class="memdesc:group__mci__transfer__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify data transfer mode. <br /></td></tr>
155 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
156 <tr class="memitem:group__mci__card__power__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html">MCI Card Power Controls</a></td></tr>
157 <tr class="memdesc:group__mci__card__power__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify Memory Card Power supply voltage. <br /></td></tr>
158 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
159 </table><table class="memberdecls">
160 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
161 Data Structures</h2></td></tr>
162 <tr class="memitem:structARM__DRIVER__MCI"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a></td></tr>
163 <tr class="memdesc:structARM__DRIVER__MCI"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the MCI Driver. <a href="group__mci__interface__gr.html#structARM__DRIVER__MCI">More...</a><br /></td></tr>
164 <tr class="separator:structARM__DRIVER__MCI"><td class="memSeparator" colspan="2"> </td></tr>
165 <tr class="memitem:structARM__MCI__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a></td></tr>
166 <tr class="memdesc:structARM__MCI__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">MCI Driver Capabilities. <a href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">More...</a><br /></td></tr>
167 <tr class="separator:structARM__MCI__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
168 <tr class="memitem:structARM__MCI__STATUS"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a></td></tr>
169 <tr class="memdesc:structARM__MCI__STATUS"><td class="mdescLeft"> </td><td class="mdescRight">MCI Status. <a href="group__mci__interface__gr.html#structARM__MCI__STATUS">More...</a><br /></td></tr>
170 <tr class="separator:structARM__MCI__STATUS"><td class="memSeparator" colspan="2"> </td></tr>
171 </table><table class="memberdecls">
172 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
173 Typedefs</h2></td></tr>
174 <tr class="memitem:ga0d14651f6788c1ffd81544602565faf1"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga0d14651f6788c1ffd81544602565faf1">ARM_MCI_SignalEvent_t</a>) (uint32_t event)</td></tr>
175 <tr class="memdesc:ga0d14651f6788c1ffd81544602565faf1"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> : Signal MCI Card Event. <br /></td></tr>
176 <tr class="separator:ga0d14651f6788c1ffd81544602565faf1"><td class="memSeparator" colspan="2"> </td></tr>
177 </table><table class="memberdecls">
178 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
179 Functions</h2></td></tr>
180 <tr class="memitem:ga3418183015dbf3025b94eebaedb00ab1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga3418183015dbf3025b94eebaedb00ab1">ARM_MCI_GetVersion</a> (void)</td></tr>
181 <tr class="memdesc:ga3418183015dbf3025b94eebaedb00ab1"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <br /></td></tr>
182 <tr class="separator:ga3418183015dbf3025b94eebaedb00ab1"><td class="memSeparator" colspan="2"> </td></tr>
183 <tr class="memitem:ga7e5a78b6e6409189833a0b72a0a3c48a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a">ARM_MCI_GetCapabilities</a> (void)</td></tr>
184 <tr class="memdesc:ga7e5a78b6e6409189833a0b72a0a3c48a"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <br /></td></tr>
185 <tr class="separator:ga7e5a78b6e6409189833a0b72a0a3c48a"><td class="memSeparator" colspan="2"> </td></tr>
186 <tr class="memitem:ga6f34d4ab362e596ddaf23aac093268cf"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga6f34d4ab362e596ddaf23aac093268cf">ARM_MCI_Initialize</a> (<a class="el" href="group__mci__interface__gr.html#ga0d14651f6788c1ffd81544602565faf1">ARM_MCI_SignalEvent_t</a> cb_event)</td></tr>
187 <tr class="memdesc:ga6f34d4ab362e596ddaf23aac093268cf"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the Memory Card Interface. <br /></td></tr>
188 <tr class="separator:ga6f34d4ab362e596ddaf23aac093268cf"><td class="memSeparator" colspan="2"> </td></tr>
189 <tr class="memitem:gaef8183e77797e74997551d03646d42c2"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#gaef8183e77797e74997551d03646d42c2">ARM_MCI_Uninitialize</a> (void)</td></tr>
190 <tr class="memdesc:gaef8183e77797e74997551d03646d42c2"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize Memory Card Interface. <br /></td></tr>
191 <tr class="separator:gaef8183e77797e74997551d03646d42c2"><td class="memSeparator" colspan="2"> </td></tr>
192 <tr class="memitem:ga19752749d04ed22dc91c4294645e0244"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga19752749d04ed22dc91c4294645e0244">ARM_MCI_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
193 <tr class="memdesc:ga19752749d04ed22dc91c4294645e0244"><td class="mdescLeft"> </td><td class="mdescRight">Control Memory Card Interface Power. <br /></td></tr>
194 <tr class="separator:ga19752749d04ed22dc91c4294645e0244"><td class="memSeparator" colspan="2"> </td></tr>
195 <tr class="memitem:gab161f80e0eda2815f3e0ebbba1314ff0"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#gab161f80e0eda2815f3e0ebbba1314ff0">ARM_MCI_CardPower</a> (uint32_t voltage)</td></tr>
196 <tr class="memdesc:gab161f80e0eda2815f3e0ebbba1314ff0"><td class="mdescLeft"> </td><td class="mdescRight">Set Memory Card Power supply voltage. <br /></td></tr>
197 <tr class="separator:gab161f80e0eda2815f3e0ebbba1314ff0"><td class="memSeparator" colspan="2"> </td></tr>
198 <tr class="memitem:ga012fca8f1ce5366fce14b708c771c635"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga012fca8f1ce5366fce14b708c771c635">ARM_MCI_ReadCD</a> (void)</td></tr>
199 <tr class="memdesc:ga012fca8f1ce5366fce14b708c771c635"><td class="mdescLeft"> </td><td class="mdescRight">Read Card Detect (CD) state. <br /></td></tr>
200 <tr class="separator:ga012fca8f1ce5366fce14b708c771c635"><td class="memSeparator" colspan="2"> </td></tr>
201 <tr class="memitem:ga3d70286918405ac81fa795c7d09dc6fd"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga3d70286918405ac81fa795c7d09dc6fd">ARM_MCI_ReadWP</a> (void)</td></tr>
202 <tr class="memdesc:ga3d70286918405ac81fa795c7d09dc6fd"><td class="mdescLeft"> </td><td class="mdescRight">Read Write Protect (WP) state. <br /></td></tr>
203 <tr class="separator:ga3d70286918405ac81fa795c7d09dc6fd"><td class="memSeparator" colspan="2"> </td></tr>
204 <tr class="memitem:ga5a431da89feabc2b4bc0c27943dff6f2"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand</a> (uint32_t cmd, uint32_t arg, uint32_t flags, uint32_t *response)</td></tr>
205 <tr class="memdesc:ga5a431da89feabc2b4bc0c27943dff6f2"><td class="mdescLeft"> </td><td class="mdescRight">Send Command to card and get the response. <br /></td></tr>
206 <tr class="separator:ga5a431da89feabc2b4bc0c27943dff6f2"><td class="memSeparator" colspan="2"> </td></tr>
207 <tr class="memitem:gaaec681bcd8e6811c5743e33ee0f35ed1"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#gaaec681bcd8e6811c5743e33ee0f35ed1">ARM_MCI_SetupTransfer</a> (uint8_t *data, uint32_t block_count, uint32_t block_size, uint32_t mode)</td></tr>
208 <tr class="memdesc:gaaec681bcd8e6811c5743e33ee0f35ed1"><td class="mdescLeft"> </td><td class="mdescRight">Setup read or write transfer operation. <br /></td></tr>
209 <tr class="separator:gaaec681bcd8e6811c5743e33ee0f35ed1"><td class="memSeparator" colspan="2"> </td></tr>
210 <tr class="memitem:ga3dfcf7b7186b711f9b63a096be816fe5"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga3dfcf7b7186b711f9b63a096be816fe5">ARM_MCI_AbortTransfer</a> (void)</td></tr>
211 <tr class="memdesc:ga3dfcf7b7186b711f9b63a096be816fe5"><td class="mdescLeft"> </td><td class="mdescRight">Abort current read/write data transfer. <br /></td></tr>
212 <tr class="separator:ga3dfcf7b7186b711f9b63a096be816fe5"><td class="memSeparator" colspan="2"> </td></tr>
213 <tr class="memitem:gaec0506a2aa4ae75cf6bc02528f36fe30"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> (uint32_t control, uint32_t arg)</td></tr>
214 <tr class="memdesc:gaec0506a2aa4ae75cf6bc02528f36fe30"><td class="mdescLeft"> </td><td class="mdescRight">Control MCI Interface. <br /></td></tr>
215 <tr class="separator:gaec0506a2aa4ae75cf6bc02528f36fe30"><td class="memSeparator" colspan="2"> </td></tr>
216 <tr class="memitem:ga8d61aa42ce78d1864fa928c1f273cbd9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9">ARM_MCI_GetStatus</a> (void)</td></tr>
217 <tr class="memdesc:ga8d61aa42ce78d1864fa928c1f273cbd9"><td class="mdescLeft"> </td><td class="mdescRight">Get MCI status. <br /></td></tr>
218 <tr class="separator:ga8d61aa42ce78d1864fa928c1f273cbd9"><td class="memSeparator" colspan="2"> </td></tr>
219 <tr class="memitem:gaac2dbd1c1a98436938c5d0d6248cb700"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> (uint32_t event)</td></tr>
220 <tr class="memdesc:gaac2dbd1c1a98436938c5d0d6248cb700"><td class="mdescLeft"> </td><td class="mdescRight">Callback function that signals a MCI Card Event. <br /></td></tr>
221 <tr class="separator:gaac2dbd1c1a98436938c5d0d6248cb700"><td class="memSeparator" colspan="2"> </td></tr>
223 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
224 <p>Driver API for Memory Card Interface using SD/MMC interface (Driver_MCI.h) </p>
225 <p>The <b>Memory Card Interface</b> (MCI) implements the hardware abstraction layer for Secure Digital (SD) and Multi Media Card (MMC) memory that is typically used as file storage. For embedded systems, SD/MMC devices are available as memory cards in several forms (SD, miniSD, microSD, MMC, MMCmicro) or as non-removable device es that are directly soldered to the PCB (eMMC). <br />
227 <p><b>References:</b> </p><ul>
228 <li>Wikipedia offers more information about the <a href="https://en.wikipedia.org/wiki/SD_card" target="_blank"><b>Secure Digital</b> memory</a>.</li>
229 <li>Wikipedia offers more information about the <a href="https://en.wikipedia.org/wiki/MultiMediaCard" target="_blank"><b>MultiMediaCard</b></a>.</li>
230 <li>The SD Association provides detailed documentation under <a href="https://www.sdcard.org">www.sdcard.org</a>.</li>
231 <li>The MultiMediaCard Association (merged with JEDEC) provides detailed documentation under <a href="https://www.jedec.org">www.jedec.org</a>.</li>
233 <p><b>Block Diagram</b></p>
234 <p>The MCI driver allows you to exchange data of the SD/MMC memory via SD/MMC interface.</p>
235 <p>The following modes are supported by SD/MMC memory cards:</p>
237 <li>SPI bus mode: Serial Peripheral Interface Bus supported by most microcontrollers.</li>
238 <li>1-bit SD/MMC Bus mode: proprietary data transfer protocol supported by SD/MMC interfaces.</li>
239 <li>4-bit SD/MMC Bus mode: high-speed version of the SD/MMC interface using 4 data I/O pins.</li>
240 <li>8-bit SD/MMC Bus mode: high-speed version of the SD/MMC interface using 8 data I/O pins.</li>
243 <img src="SPI_BusMode.png" alt=""/>
244 <div class="caption">
245 SD memory connected via SPI interface</div></div>
248 <img src="SD_1BitBusMode.png" alt=""/>
249 <div class="caption">
250 SD memory connected via 1-bit SD Bus Mode</div></div>
253 <img src="SD_4BitBusMode.png" alt=""/>
254 <div class="caption">
255 SD memory connected via 4-bit SD Bus Mode</div></div>
256 <p><b>MCI API</b></p>
257 <p>The following header files define the Application Programming Interface (API) for the MCI interface:</p><ul>
258 <li><b>Driver_MCI.h</b> : Driver API for Memory Card Interface using SD/MMC interface</li>
260 <p>The driver implementation is a typical part of the Device Family Pack (DFP) that supports the peripherals of the microcontroller family.</p>
261 <dl class="section note"><dt>Note</dt><dd>For parameters, the value marked with (default) is the setting after the driver initialization.</dd></dl>
262 <p><b>Driver Functions</b></p>
263 <p>The driver functions are published in the access struct as explained in <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a></p><ul>
264 <li><a class="el" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> : access struct for MCI driver functions</li>
266 <p><b>Example Code</b></p>
267 <p>The following example code shows the usage of the MCI interface.</p>
268 <div class="fragment"><div class="line"> </div>
269 <div class="line"><span class="preprocessor">#include "<a class="code" href="Driver__MCI_8h.html">Driver_MCI.h</a>"</span></div>
270 <div class="line"> </div>
271 <div class="line"> </div>
272 <div class="line"><span class="comment">/* Usage example: ARM_MCI_Initialize ----------------------------------------*/</span></div>
273 <div class="line"> </div>
274 <div class="line"><span class="comment">// ARM_MCI_SignalEvent callback function prototype</span></div>
275 <div class="line"><span class="keywordtype">void</span> MCI_SignalEvent_Callback (uint32_t event);</div>
276 <div class="line"> </div>
277 <div class="line"><span class="keywordtype">void</span> init_driver (<a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
278 <div class="line"> int32_t status;</div>
279 <div class="line"> </div>
280 <div class="line"> status = drv-><a class="code hl_variable" href="group__mci__interface__gr.html#a85b30bcbe4c9747c19cce2000d5684d3">Initialize</a> (&MCI_SignalEvent_Callback);</div>
281 <div class="line"> </div>
282 <div class="line"> <span class="keywordflow">if</span> (status != <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
283 <div class="line"> <span class="comment">// Initialization and event callback registration failed</span></div>
284 <div class="line"> }</div>
285 <div class="line">}</div>
286 <div class="line"> </div>
287 <div class="line"><span class="comment">/* Usage example: ARM_MCI_Uninitialize --------------------------------------*/</span></div>
288 <div class="line"> </div>
289 <div class="line"><span class="keywordtype">void</span> uninit_driver (<a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
290 <div class="line"> int32_t status;</div>
291 <div class="line"> </div>
292 <div class="line"> status = drv-><a class="code hl_variable" href="group__mci__interface__gr.html#a5ce2b3d7a3a07099bf07d1eb253e92e3">Uninitialize</a> ();</div>
293 <div class="line"> </div>
294 <div class="line"> <span class="keywordflow">if</span> (status == <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
295 <div class="line"> <span class="comment">// Driver successfully uninitialized</span></div>
296 <div class="line"> }</div>
297 <div class="line">}</div>
298 <div class="line"> </div>
299 <div class="line"><span class="comment">/* Usage example: ARM_MCI_PowerControl --------------------------------------*/</span></div>
300 <div class="line"> </div>
301 <div class="line"><span class="keywordtype">void</span> control_driver_power (<a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv, <span class="keywordtype">bool</span> enable) {</div>
302 <div class="line"> int32_t status;</div>
303 <div class="line"> </div>
304 <div class="line"> <span class="keywordflow">if</span> (enable == <span class="keyword">true</span>) {</div>
305 <div class="line"> status = drv-><a class="code hl_variable" href="group__mci__interface__gr.html#a24ebae5c6011631f76027f9a16eaf5ce">PowerControl</a> (<a class="code hl_enumvalue" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>);</div>
306 <div class="line"> }</div>
307 <div class="line"> <span class="keywordflow">else</span> {</div>
308 <div class="line"> status = drv-><a class="code hl_variable" href="group__mci__interface__gr.html#a24ebae5c6011631f76027f9a16eaf5ce">PowerControl</a> (<a class="code hl_enumvalue" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a>);</div>
309 <div class="line"> }</div>
310 <div class="line"> </div>
311 <div class="line"> <span class="keywordflow">if</span> (status == <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
312 <div class="line"> <span class="comment">// Driver power enabled/disabled</span></div>
313 <div class="line"> }</div>
314 <div class="line">}</div>
315 <div class="line"> </div>
316 <div class="line"><span class="comment">/* Usage example: ARM_MCI_CardPower -----------------------------------------*/</span></div>
317 <div class="line"> </div>
318 <div class="line"><a class="code hl_struct" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a> drv_capabilities;</div>
319 <div class="line"> </div>
320 <div class="line"><span class="keywordtype">void</span> set_card_vdd_3v3 (<a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
321 <div class="line"> int32_t status;</div>
322 <div class="line"> </div>
323 <div class="line"> <span class="keywordflow">if</span> (drv_capabilities.<a class="code hl_variable" href="group__mci__interface__gr.html#a414baec222a72be862e262f02b821dce">vdd</a> == 1U) {</div>
324 <div class="line"> <span class="comment">// Power switching to 3.3V supported</span></div>
325 <div class="line"> status = drv-><a class="code hl_variable" href="group__mci__interface__gr.html#ac5f226aab1d575a4d6c4eca71cdd4a5b">CardPower</a> (<a class="code hl_define" href="group__mci__card__power__ctrls.html#ga565ecd36c8d0379fb4172da577cc540d">ARM_MCI_POWER_VDD_3V3</a>);</div>
326 <div class="line"> </div>
327 <div class="line"> <span class="keywordflow">if</span> (status == <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
328 <div class="line"> <span class="comment">// Card power set to 3.3V</span></div>
329 <div class="line"> }</div>
330 <div class="line"> }</div>
331 <div class="line">}</div>
332 <div class="line"> </div>
333 <div class="line"><span class="comment">/* Usage example: ARM_MCI_ReadCD --------------------------------------------*/</span></div>
334 <div class="line"> </div>
335 <div class="line"><span class="keywordtype">void</span> read_card_detect_state (<a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
336 <div class="line"> int32_t status;</div>
337 <div class="line"> </div>
338 <div class="line"> status = drv-><a class="code hl_variable" href="group__mci__interface__gr.html#ae00aa7cf8f0c0c7e2225b3048cbded13">ReadCD</a>();</div>
339 <div class="line"> </div>
340 <div class="line"> <span class="keywordflow">if</span> (status == 1) {</div>
341 <div class="line"> <span class="comment">// Memory card is detected</span></div>
342 <div class="line"> }</div>
343 <div class="line"> <span class="keywordflow">else</span> {</div>
344 <div class="line"> <span class="keywordflow">if</span> (status == 0) {</div>
345 <div class="line"> <span class="comment">// Memory card is not detected</span></div>
346 <div class="line"> }</div>
347 <div class="line"> <span class="keywordflow">else</span> {</div>
348 <div class="line"> <span class="comment">// Error reading card detect pin state</span></div>
349 <div class="line"> }</div>
350 <div class="line"> }</div>
351 <div class="line">}</div>
352 <div class="line"> </div>
353 <div class="line"><span class="comment">/* Usage example: ARM_MCI_ReadWP --------------------------------------------*/</span></div>
354 <div class="line"> </div>
355 <div class="line"><span class="keywordtype">void</span> read_write_protect_state (<a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
356 <div class="line"> int32_t status;</div>
357 <div class="line"> </div>
358 <div class="line"> status = drv-><a class="code hl_variable" href="group__mci__interface__gr.html#ab023e8ec9252d65026c21ee84b573890">ReadWP</a>();</div>
359 <div class="line"> </div>
360 <div class="line"> <span class="keywordflow">if</span> (status == 1) {</div>
361 <div class="line"> <span class="comment">// Memory card write protection is enabled</span></div>
362 <div class="line"> }</div>
363 <div class="line"> <span class="keywordflow">else</span> {</div>
364 <div class="line"> <span class="keywordflow">if</span> (status == 0) {</div>
365 <div class="line"> <span class="comment">// Memory card write protection is disabled</span></div>
366 <div class="line"> }</div>
367 <div class="line"> <span class="keywordflow">else</span> {</div>
368 <div class="line"> <span class="comment">// Error reading write protect pin state</span></div>
369 <div class="line"> }</div>
370 <div class="line"> }</div>
371 <div class="line">}</div>
372 <div class="line"> </div>
373 <div class="line"><span class="comment">/* Usage example: ARM_MCI_SendCommand ---------------------------------------*/</span></div>
374 <div class="line"> </div>
375 <div class="line"><span class="keyword">volatile</span> uint32_t MCI_Events;</div>
376 <div class="line"> </div>
377 <div class="line"><span class="keywordtype">void</span> MCI_SignalEvent_Callback (uint32_t event) {</div>
378 <div class="line"> <span class="comment">// Save current event</span></div>
379 <div class="line"> MCI_Events |= event;</div>
380 <div class="line">}</div>
381 <div class="line"> </div>
382 <div class="line"><span class="keywordtype">void</span> send_CMD0 (<a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
383 <div class="line"> int32_t status;</div>
384 <div class="line"> uint32_t cmd;</div>
385 <div class="line"> </div>
386 <div class="line"> MCI_Events = 0U; <span class="comment">//Clear MCI driver event flags</span></div>
387 <div class="line"> cmd = 0U; <span class="comment">// Set GO_IDLE_STATE command code</span></div>
388 <div class="line"> </div>
389 <div class="line"> status = drv-><a class="code hl_variable" href="group__mci__interface__gr.html#a607f96af38f877b34a937427ebc675de">SendCommand</a> (cmd, 0U, <a class="code hl_define" href="group__mci__send__command__flags__ctrls.html#ga81606bd94ce782e2c3764b913f929f60">ARM_MCI_CARD_INITIALIZE</a> | <a class="code hl_define" href="group__mci__send__command__flags__ctrls.html#ga70934cef80884e8c75fb4eebf8452118">ARM_MCI_RESPONSE_NONE</a>, NULL);</div>
390 <div class="line"> </div>
391 <div class="line"> <span class="keywordflow">if</span> (status == <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
392 <div class="line"> <span class="comment">/* Wait for event */</span></div>
393 <div class="line"> <span class="keywordflow">while</span> ((MCI_Events & <a class="code hl_define" href="group__mci__event__gr.html#gae69356c75d55103d93ef91ac1bc02b49">ARM_MCI_EVENT_COMMAND_COMPLETE</a>) == 0U);</div>
394 <div class="line"> <span class="comment">// Command was successfully sent to memory card</span></div>
395 <div class="line"> <span class="comment">// ..</span></div>
396 <div class="line"> }</div>
397 <div class="line"> <span class="keywordflow">else</span> {</div>
398 <div class="line"> <span class="comment">// Error</span></div>
399 <div class="line"> }</div>
400 <div class="line">}</div>
401 <div class="line"> </div>
402 <div class="line"><span class="comment">/* Usage example: ARM_MCI_SetupTransfer -------------------------------------*/</span></div>
403 <div class="line"> </div>
404 <div class="line"><span class="keyword">volatile</span> uint32_t MCI_Events;</div>
405 <div class="line"> </div>
406 <div class="line"><span class="keywordtype">void</span> MCI_SignalEvent_Callback (uint32_t event) {</div>
407 <div class="line"> MCI_Events |= event; <span class="comment">// Save current event</span></div>
408 <div class="line">}</div>
409 <div class="line"> </div>
410 <div class="line"><span class="keywordtype">void</span> read_sector (<a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv, uint8_t *buf, uint32_t sz) {</div>
411 <div class="line"> int32_t status;</div>
412 <div class="line"> uint32_t cmd, arg;</div>
413 <div class="line"> uint32_t resp;</div>
414 <div class="line"> </div>
415 <div class="line"> <span class="keywordflow">if</span> (sz < 512U) {</div>
416 <div class="line"> <span class="comment">// Invalid buffer size, sector consists of 512 bytes</span></div>
417 <div class="line"> <span class="comment">//...</span></div>
418 <div class="line"> }</div>
419 <div class="line"> </div>
420 <div class="line"> status = drv-><a class="code hl_variable" href="group__mci__interface__gr.html#ac28f754289ae6d3783e7c18a965ee3f8">SetupTransfer</a> (buf, 1U, 512U, <a class="code hl_define" href="group__mci__transfer__ctrls.html#gaa6f3be235a9dce5c66be8fe64f399846">ARM_MCI_TRANSFER_READ</a> | <a class="code hl_define" href="group__mci__transfer__ctrls.html#ga4ced782e7c0c70d5f0edbddd1e48323b">ARM_MCI_TRANSFER_BLOCK</a>);</div>
421 <div class="line"> </div>
422 <div class="line"> <span class="keywordflow">if</span> (status == <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
423 <div class="line"> MCI_Events = 0U; <span class="comment">//Clear MCI driver event flags</span></div>
424 <div class="line"> </div>
425 <div class="line"> cmd = 17U; <span class="comment">// Set READ_SINGLE_BLOCK command</span></div>
426 <div class="line"> arg = 0U; <span class="comment">// Set sector number</span></div>
427 <div class="line"> </div>
428 <div class="line"> status = drv-><a class="code hl_variable" href="group__mci__interface__gr.html#a607f96af38f877b34a937427ebc675de">SendCommand</a> (cmd, arg, <a class="code hl_define" href="group__mci__send__command__flags__ctrls.html#gaa5ddf1cf772b234e3c247039effd0e7b">ARM_MCI_RESPONSE_SHORT</a> | <a class="code hl_define" href="group__mci__send__command__flags__ctrls.html#ga6ab3f4c1a2bf0fdb81fbcf7a5698f2de">ARM_MCI_RESPONSE_CRC</a> | <a class="code hl_define" href="group__mci__send__command__flags__ctrls.html#ga8aa566f69aa74ed416213df6ca3267bd">ARM_MCI_TRANSFER_DATA</a>, &resp);</div>
429 <div class="line"> </div>
430 <div class="line"> <span class="keywordflow">if</span> (status == <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
431 <div class="line"> <span class="comment">/* Wait for event */</span></div>
432 <div class="line"> <span class="keywordflow">while</span> ((MCI_Events & <a class="code hl_define" href="group__mci__event__gr.html#gae69356c75d55103d93ef91ac1bc02b49">ARM_MCI_EVENT_COMMAND_COMPLETE</a>) == 0U);</div>
433 <div class="line"> <span class="comment">// Command was successfully sent to memory card</span></div>
434 <div class="line"> <span class="keywordflow">if</span> ((resp & 0x03U) == 0U) {</div>
435 <div class="line"> <span class="comment">// Sector number is valid, wait until data transfer completes</span></div>
436 <div class="line"> <span class="keywordflow">while</span> ((MCI_Events & <a class="code hl_define" href="group__mci__event__gr.html#gabc3c468dedaed890683360f2c5c65bea">ARM_MCI_EVENT_TRANSFER_COMPLETE</a>) == 0U);</div>
437 <div class="line"> <span class="comment">// Data was successfully read from memory card</span></div>
438 <div class="line"> <span class="comment">// ...</span></div>
439 <div class="line"> }</div>
440 <div class="line"> }</div>
441 <div class="line"> }</div>
442 <div class="line">}</div>
443 <div class="line"> </div>
444 <div class="line"><span class="comment">/* Usage example: ARM_MCI_AbortTransfer -------------------------------------*/</span></div>
445 <div class="line"> </div>
446 <div class="line"><span class="keywordtype">void</span> abort_data_transfer (<a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
447 <div class="line"> <a class="code hl_struct" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a> drv_status;</div>
448 <div class="line"> </div>
449 <div class="line"> drv_status = drv-><a class="code hl_variable" href="group__mci__interface__gr.html#a8e6e71480a5ec1575b6471ce3d32117d">GetStatus</a>();</div>
450 <div class="line"> </div>
451 <div class="line"> <span class="keywordflow">if</span> (drv_status.<a class="code hl_variable" href="group__mci__interface__gr.html#a2655d3422b720097b091a28e8bbcea8f">transfer_active</a> == 1U) {</div>
452 <div class="line"> <span class="comment">// Data transfer is active, abort the transfer</span></div>
453 <div class="line"> <span class="keywordflow">if</span> (drv-><a class="code hl_variable" href="group__mci__interface__gr.html#a941fb6d191be477582c21d1f6757ab1f">AbortTransfer</a>() == <a class="code hl_define" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
454 <div class="line"> <span class="comment">// Transfer aborted</span></div>
455 <div class="line"> <span class="comment">// ...</span></div>
456 <div class="line"> }</div>
457 <div class="line"> }</div>
458 <div class="line">}</div>
459 <div class="line"> </div>
460 <div class="line"><span class="comment">/* Usage example: ARM_MCI_GetStatus -----------------------------------------*/</span></div>
461 <div class="line"> </div>
462 <div class="line"><span class="keywordtype">void</span> check_transfer_status (<a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv) {</div>
463 <div class="line"> <a class="code hl_struct" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a> drv_status;</div>
464 <div class="line"> </div>
465 <div class="line"> drv_status = drv-><a class="code hl_variable" href="group__mci__interface__gr.html#a8e6e71480a5ec1575b6471ce3d32117d">GetStatus</a>();</div>
466 <div class="line"> </div>
467 <div class="line"> <span class="keywordflow">if</span> (drv_status.<a class="code hl_variable" href="group__mci__interface__gr.html#a2655d3422b720097b091a28e8bbcea8f">transfer_active</a> == 1U) {</div>
468 <div class="line"> <span class="comment">// Data transfer is active</span></div>
469 <div class="line"> }</div>
470 <div class="line"> </div>
471 <div class="line"> <span class="keywordflow">if</span> (drv_status.<a class="code hl_variable" href="group__mci__interface__gr.html#a598ae4a196316d6dcb97d07fd337ecdd">transfer_timeout</a> == 1U) {</div>
472 <div class="line"> <span class="comment">// Data not received, timeout expired</span></div>
473 <div class="line"> }</div>
474 <div class="line"> </div>
475 <div class="line"> <span class="keywordflow">if</span> (drv_status.<a class="code hl_variable" href="group__mci__interface__gr.html#a21d4bc1a03e161bd33693619039a6afa">transfer_error</a> == 1U) {</div>
476 <div class="line"> <span class="comment">// Data transfer ended with error</span></div>
477 <div class="line"> }</div>
478 <div class="line">}</div>
479 <div class="line"> </div>
480 <div class="line"><span class="comment">/* Usage example: ARM_MCI_SignalEvent ---------------------------------------*/</span></div>
481 <div class="line"> </div>
482 <div class="line"><span class="keywordtype">void</span> MCI_SignalEvent_Callback (uint32_t event) {</div>
483 <div class="line"> <span class="keywordflow">if</span> ((event & <a class="code hl_define" href="group__mci__event__gr.html#gae2cf8ef238c092e94e96a01602f3a23c">ARM_MCI_EVENT_CARD_INSERTED</a>) != 0U) {</div>
484 <div class="line"> <span class="comment">// Memory card was inserted into socket</span></div>
485 <div class="line"> }</div>
486 <div class="line"> <span class="keywordflow">if</span> ((event & <a class="code hl_define" href="group__mci__event__gr.html#ga92ba748f9324ec13898f10456f17c8cc">ARM_MCI_EVENT_CARD_REMOVED</a>) != 0U) {</div>
487 <div class="line"> <span class="comment">// Memory card was removed from socket</span></div>
488 <div class="line"> }</div>
489 <div class="line"> </div>
490 <div class="line"> <span class="keywordflow">if</span> ((event & <a class="code hl_define" href="group__mci__event__gr.html#gae69356c75d55103d93ef91ac1bc02b49">ARM_MCI_EVENT_COMMAND_COMPLETE</a>) != 0U) {</div>
491 <div class="line"> <span class="comment">// Command was successfully sent to memory card</span></div>
492 <div class="line"> }</div>
493 <div class="line"> <span class="keywordflow">if</span> ((event & <a class="code hl_define" href="group__mci__event__gr.html#gab79b3ab4dcd03c38df1e173fa903d822">ARM_MCI_EVENT_COMMAND_TIMEOUT</a>) != 0U) {</div>
494 <div class="line"> <span class="comment">// Command response was not received in time</span></div>
495 <div class="line"> }</div>
496 <div class="line"> <span class="keywordflow">if</span> ((event & <a class="code hl_define" href="group__mci__event__gr.html#ga373aeb3eca0e4c6d159312488a130442">ARM_MCI_EVENT_COMMAND_ERROR</a>) != 0U) {</div>
497 <div class="line"> <span class="comment">// Command response was invalid</span></div>
498 <div class="line"> }</div>
499 <div class="line"> </div>
500 <div class="line"> <span class="keywordflow">if</span> ((event & <a class="code hl_define" href="group__mci__event__gr.html#gabc3c468dedaed890683360f2c5c65bea">ARM_MCI_EVENT_TRANSFER_COMPLETE</a>) != 0U) {</div>
501 <div class="line"> <span class="comment">// Data successfully transferred from/to memory card</span></div>
502 <div class="line"> }</div>
503 <div class="line"> <span class="keywordflow">if</span> ((event & <a class="code hl_define" href="group__mci__event__gr.html#ga614e7c7226adbaa8ec4165bf8b87ef27">ARM_MCI_EVENT_TRANSFER_TIMEOUT</a>) != 0U) {</div>
504 <div class="line"> <span class="comment">// Data not transferred from/to memory card, timeout expired</span></div>
505 <div class="line"> }</div>
506 <div class="line"> <span class="keywordflow">if</span> ((event & <a class="code hl_define" href="group__mci__event__gr.html#ga5d2cee5ba6d0e40ad505983155706c29">ARM_MCI_EVENT_TRANSFER_ERROR</a>) != 0U) {</div>
507 <div class="line"> <span class="comment">// Data transfer ended with errors</span></div>
508 <div class="line"> }</div>
509 <div class="line"> </div>
510 <div class="line"> <span class="keywordflow">if</span> ((event & <a class="code hl_define" href="group__mci__event__gr.html#ga75a050fdfe04e6816e96c938d6a6c197">ARM_MCI_EVENT_SDIO_INTERRUPT</a>) != 0U) {</div>
511 <div class="line"> <span class="comment">// SD I/O card sent interrupt request</span></div>
512 <div class="line"> }</div>
513 <div class="line"> </div>
514 <div class="line"> <span class="keywordflow">if</span> ((event & <a class="code hl_define" href="group__mci__event__gr.html#ga8161f3960ddf2a3cdc3c4c83148c6099">ARM_MCI_EVENT_CCS</a>) != 0U) {</div>
515 <div class="line"> <span class="comment">// CE-ATA command completion signal received</span></div>
516 <div class="line"> }</div>
517 <div class="line"> <span class="keywordflow">if</span> ((event & <a class="code hl_define" href="group__mci__event__gr.html#gafa8cbcd597a05c64901eeb777cc0b74f">ARM_MCI_EVENT_CCS_TIMEOUT</a>) != 0U) {</div>
518 <div class="line"> <span class="comment">// CE-ATA command completion signal wait timeout expired</span></div>
519 <div class="line"> }</div>
520 <div class="line">}</div>
521 <div class="ttc" id="aDriver__Common_8h_html_ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35"><div class="ttname"><a href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a></div><div class="ttdeci">@ ARM_POWER_OFF</div><div class="ttdoc">Power off: no operation possible.</div><div class="ttdef"><b>Definition:</b> Driver_Common.h:64</div></div>
522 <div class="ttc" id="aDriver__Common_8h_html_ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e"><div class="ttname"><a href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a></div><div class="ttdeci">@ ARM_POWER_FULL</div><div class="ttdoc">Power on: full operation at maximum performance.</div><div class="ttdef"><b>Definition:</b> Driver_Common.h:66</div></div>
523 <div class="ttc" id="aDriver__MCI_8h_html"><div class="ttname"><a href="Driver__MCI_8h.html">Driver_MCI.h</a></div></div>
524 <div class="ttc" id="agroup__execution__status_html_ga85752c5de59e8adeb001e35ff5be6be7"><div class="ttname"><a href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a></div><div class="ttdeci">#define ARM_DRIVER_OK</div><div class="ttdoc">Operation succeeded.</div></div>
525 <div class="ttc" id="agroup__mci__card__power__ctrls_html_ga565ecd36c8d0379fb4172da577cc540d"><div class="ttname"><a href="group__mci__card__power__ctrls.html#ga565ecd36c8d0379fb4172da577cc540d">ARM_MCI_POWER_VDD_3V3</a></div><div class="ttdeci">#define ARM_MCI_POWER_VDD_3V3</div><div class="ttdoc">VDD (VCC) = 3.3V.</div></div>
526 <div class="ttc" id="agroup__mci__event__gr_html_ga373aeb3eca0e4c6d159312488a130442"><div class="ttname"><a href="group__mci__event__gr.html#ga373aeb3eca0e4c6d159312488a130442">ARM_MCI_EVENT_COMMAND_ERROR</a></div><div class="ttdeci">#define ARM_MCI_EVENT_COMMAND_ERROR</div><div class="ttdoc">Command response error (CRC error or invalid response)</div></div>
527 <div class="ttc" id="agroup__mci__event__gr_html_ga5d2cee5ba6d0e40ad505983155706c29"><div class="ttname"><a href="group__mci__event__gr.html#ga5d2cee5ba6d0e40ad505983155706c29">ARM_MCI_EVENT_TRANSFER_ERROR</a></div><div class="ttdeci">#define ARM_MCI_EVENT_TRANSFER_ERROR</div><div class="ttdoc">Data transfer CRC failed.</div></div>
528 <div class="ttc" id="agroup__mci__event__gr_html_ga614e7c7226adbaa8ec4165bf8b87ef27"><div class="ttname"><a href="group__mci__event__gr.html#ga614e7c7226adbaa8ec4165bf8b87ef27">ARM_MCI_EVENT_TRANSFER_TIMEOUT</a></div><div class="ttdeci">#define ARM_MCI_EVENT_TRANSFER_TIMEOUT</div><div class="ttdoc">Data transfer timeout.</div></div>
529 <div class="ttc" id="agroup__mci__event__gr_html_ga75a050fdfe04e6816e96c938d6a6c197"><div class="ttname"><a href="group__mci__event__gr.html#ga75a050fdfe04e6816e96c938d6a6c197">ARM_MCI_EVENT_SDIO_INTERRUPT</a></div><div class="ttdeci">#define ARM_MCI_EVENT_SDIO_INTERRUPT</div><div class="ttdoc">SD I/O Interrupt.</div></div>
530 <div class="ttc" id="agroup__mci__event__gr_html_ga8161f3960ddf2a3cdc3c4c83148c6099"><div class="ttname"><a href="group__mci__event__gr.html#ga8161f3960ddf2a3cdc3c4c83148c6099">ARM_MCI_EVENT_CCS</a></div><div class="ttdeci">#define ARM_MCI_EVENT_CCS</div><div class="ttdoc">Command Completion Signal (CCS)</div></div>
531 <div class="ttc" id="agroup__mci__event__gr_html_ga92ba748f9324ec13898f10456f17c8cc"><div class="ttname"><a href="group__mci__event__gr.html#ga92ba748f9324ec13898f10456f17c8cc">ARM_MCI_EVENT_CARD_REMOVED</a></div><div class="ttdeci">#define ARM_MCI_EVENT_CARD_REMOVED</div><div class="ttdoc">Memory Card removed.</div></div>
532 <div class="ttc" id="agroup__mci__event__gr_html_gab79b3ab4dcd03c38df1e173fa903d822"><div class="ttname"><a href="group__mci__event__gr.html#gab79b3ab4dcd03c38df1e173fa903d822">ARM_MCI_EVENT_COMMAND_TIMEOUT</a></div><div class="ttdeci">#define ARM_MCI_EVENT_COMMAND_TIMEOUT</div><div class="ttdoc">Command timeout.</div></div>
533 <div class="ttc" id="agroup__mci__event__gr_html_gabc3c468dedaed890683360f2c5c65bea"><div class="ttname"><a href="group__mci__event__gr.html#gabc3c468dedaed890683360f2c5c65bea">ARM_MCI_EVENT_TRANSFER_COMPLETE</a></div><div class="ttdeci">#define ARM_MCI_EVENT_TRANSFER_COMPLETE</div><div class="ttdoc">Data transfer completed.</div></div>
534 <div class="ttc" id="agroup__mci__event__gr_html_gae2cf8ef238c092e94e96a01602f3a23c"><div class="ttname"><a href="group__mci__event__gr.html#gae2cf8ef238c092e94e96a01602f3a23c">ARM_MCI_EVENT_CARD_INSERTED</a></div><div class="ttdeci">#define ARM_MCI_EVENT_CARD_INSERTED</div><div class="ttdoc">Memory Card inserted.</div></div>
535 <div class="ttc" id="agroup__mci__event__gr_html_gae69356c75d55103d93ef91ac1bc02b49"><div class="ttname"><a href="group__mci__event__gr.html#gae69356c75d55103d93ef91ac1bc02b49">ARM_MCI_EVENT_COMMAND_COMPLETE</a></div><div class="ttdeci">#define ARM_MCI_EVENT_COMMAND_COMPLETE</div><div class="ttdoc">Command completed.</div></div>
536 <div class="ttc" id="agroup__mci__event__gr_html_gafa8cbcd597a05c64901eeb777cc0b74f"><div class="ttname"><a href="group__mci__event__gr.html#gafa8cbcd597a05c64901eeb777cc0b74f">ARM_MCI_EVENT_CCS_TIMEOUT</a></div><div class="ttdeci">#define ARM_MCI_EVENT_CCS_TIMEOUT</div><div class="ttdoc">Command Completion Signal (CCS) Timeout.</div></div>
537 <div class="ttc" id="agroup__mci__interface__gr_html_a21d4bc1a03e161bd33693619039a6afa"><div class="ttname"><a href="group__mci__interface__gr.html#a21d4bc1a03e161bd33693619039a6afa">ARM_MCI_STATUS::transfer_error</a></div><div class="ttdeci">uint32_t transfer_error</div><div class="ttdoc">Transfer error flag (cleared on start of next command)</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:183</div></div>
538 <div class="ttc" id="agroup__mci__interface__gr_html_a24ebae5c6011631f76027f9a16eaf5ce"><div class="ttname"><a href="group__mci__interface__gr.html#a24ebae5c6011631f76027f9a16eaf5ce">ARM_DRIVER_MCI::PowerControl</a></div><div class="ttdeci">int32_t(* PowerControl)(ARM_POWER_STATE state)</div><div class="ttdoc">Pointer to ARM_MCI_PowerControl : Control MCI Interface Power.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:345</div></div>
539 <div class="ttc" id="agroup__mci__interface__gr_html_a2655d3422b720097b091a28e8bbcea8f"><div class="ttname"><a href="group__mci__interface__gr.html#a2655d3422b720097b091a28e8bbcea8f">ARM_MCI_STATUS::transfer_active</a></div><div class="ttdeci">uint32_t transfer_active</div><div class="ttdoc">Transfer active flag.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:181</div></div>
540 <div class="ttc" id="agroup__mci__interface__gr_html_a414baec222a72be862e262f02b821dce"><div class="ttname"><a href="group__mci__interface__gr.html#a414baec222a72be862e262f02b821dce">ARM_MCI_CAPABILITIES::vdd</a></div><div class="ttdeci">uint32_t vdd</div><div class="ttdoc">Supports VDD Card Power Supply Control.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:307</div></div>
541 <div class="ttc" id="agroup__mci__interface__gr_html_a598ae4a196316d6dcb97d07fd337ecdd"><div class="ttname"><a href="group__mci__interface__gr.html#a598ae4a196316d6dcb97d07fd337ecdd">ARM_MCI_STATUS::transfer_timeout</a></div><div class="ttdeci">uint32_t transfer_timeout</div><div class="ttdoc">Transfer timeout flag (cleared on start of next command)</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:182</div></div>
542 <div class="ttc" id="agroup__mci__interface__gr_html_a5ce2b3d7a3a07099bf07d1eb253e92e3"><div class="ttname"><a href="group__mci__interface__gr.html#a5ce2b3d7a3a07099bf07d1eb253e92e3">ARM_DRIVER_MCI::Uninitialize</a></div><div class="ttdeci">int32_t(* Uninitialize)(void)</div><div class="ttdoc">Pointer to ARM_MCI_Uninitialize : De-initialize MCI Interface.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:344</div></div>
543 <div class="ttc" id="agroup__mci__interface__gr_html_a607f96af38f877b34a937427ebc675de"><div class="ttname"><a href="group__mci__interface__gr.html#a607f96af38f877b34a937427ebc675de">ARM_DRIVER_MCI::SendCommand</a></div><div class="ttdeci">int32_t(* SendCommand)(uint32_t cmd, uint32_t arg, uint32_t flags, uint32_t *response)</div><div class="ttdoc">Pointer to ARM_MCI_SendCommand : Send Command to card and get the response.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:349</div></div>
544 <div class="ttc" id="agroup__mci__interface__gr_html_a85b30bcbe4c9747c19cce2000d5684d3"><div class="ttname"><a href="group__mci__interface__gr.html#a85b30bcbe4c9747c19cce2000d5684d3">ARM_DRIVER_MCI::Initialize</a></div><div class="ttdeci">int32_t(* Initialize)(ARM_MCI_SignalEvent_t cb_event)</div><div class="ttdoc">Pointer to ARM_MCI_Initialize : Initialize MCI Interface.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:343</div></div>
545 <div class="ttc" id="agroup__mci__interface__gr_html_a8e6e71480a5ec1575b6471ce3d32117d"><div class="ttname"><a href="group__mci__interface__gr.html#a8e6e71480a5ec1575b6471ce3d32117d">ARM_DRIVER_MCI::GetStatus</a></div><div class="ttdeci">ARM_MCI_STATUS(* GetStatus)(void)</div><div class="ttdoc">Pointer to ARM_MCI_GetStatus : Get MCI status.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:359</div></div>
546 <div class="ttc" id="agroup__mci__interface__gr_html_a941fb6d191be477582c21d1f6757ab1f"><div class="ttname"><a href="group__mci__interface__gr.html#a941fb6d191be477582c21d1f6757ab1f">ARM_DRIVER_MCI::AbortTransfer</a></div><div class="ttdeci">int32_t(* AbortTransfer)(void)</div><div class="ttdoc">Pointer to ARM_MCI_AbortTransfer : Abort current data transfer.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:357</div></div>
547 <div class="ttc" id="agroup__mci__interface__gr_html_ab023e8ec9252d65026c21ee84b573890"><div class="ttname"><a href="group__mci__interface__gr.html#ab023e8ec9252d65026c21ee84b573890">ARM_DRIVER_MCI::ReadWP</a></div><div class="ttdeci">int32_t(* ReadWP)(void)</div><div class="ttdoc">Pointer to ARM_MCI_ReadWP : Read Write Protect (WP) state.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:348</div></div>
548 <div class="ttc" id="agroup__mci__interface__gr_html_ac28f754289ae6d3783e7c18a965ee3f8"><div class="ttname"><a href="group__mci__interface__gr.html#ac28f754289ae6d3783e7c18a965ee3f8">ARM_DRIVER_MCI::SetupTransfer</a></div><div class="ttdeci">int32_t(* SetupTransfer)(uint8_t *data, uint32_t block_count, uint32_t block_size, uint32_t mode)</div><div class="ttdoc">Pointer to ARM_MCI_SetupTransfer : Setup data transfer operation.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:353</div></div>
549 <div class="ttc" id="agroup__mci__interface__gr_html_ac5f226aab1d575a4d6c4eca71cdd4a5b"><div class="ttname"><a href="group__mci__interface__gr.html#ac5f226aab1d575a4d6c4eca71cdd4a5b">ARM_DRIVER_MCI::CardPower</a></div><div class="ttdeci">int32_t(* CardPower)(uint32_t voltage)</div><div class="ttdoc">Pointer to ARM_MCI_CardPower : Set card power supply voltage.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:346</div></div>
550 <div class="ttc" id="agroup__mci__interface__gr_html_ae00aa7cf8f0c0c7e2225b3048cbded13"><div class="ttname"><a href="group__mci__interface__gr.html#ae00aa7cf8f0c0c7e2225b3048cbded13">ARM_DRIVER_MCI::ReadCD</a></div><div class="ttdeci">int32_t(* ReadCD)(void)</div><div class="ttdoc">Pointer to ARM_MCI_ReadCD : Read Card Detect (CD) state.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:347</div></div>
551 <div class="ttc" id="agroup__mci__interface__gr_html_structARM__DRIVER__MCI"><div class="ttname"><a href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a></div><div class="ttdoc">Access structure of the MCI Driver.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:340</div></div>
552 <div class="ttc" id="agroup__mci__interface__gr_html_structARM__MCI__CAPABILITIES"><div class="ttname"><a href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a></div><div class="ttdoc">MCI Driver Capabilities.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:303</div></div>
553 <div class="ttc" id="agroup__mci__interface__gr_html_structARM__MCI__STATUS"><div class="ttname"><a href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a></div><div class="ttdoc">MCI Status.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:177</div></div>
554 <div class="ttc" id="agroup__mci__send__command__flags__ctrls_html_ga6ab3f4c1a2bf0fdb81fbcf7a5698f2de"><div class="ttname"><a href="group__mci__send__command__flags__ctrls.html#ga6ab3f4c1a2bf0fdb81fbcf7a5698f2de">ARM_MCI_RESPONSE_CRC</a></div><div class="ttdeci">#define ARM_MCI_RESPONSE_CRC</div><div class="ttdoc">Check CRC in response.</div></div>
555 <div class="ttc" id="agroup__mci__send__command__flags__ctrls_html_ga70934cef80884e8c75fb4eebf8452118"><div class="ttname"><a href="group__mci__send__command__flags__ctrls.html#ga70934cef80884e8c75fb4eebf8452118">ARM_MCI_RESPONSE_NONE</a></div><div class="ttdeci">#define ARM_MCI_RESPONSE_NONE</div><div class="ttdoc">No response expected (default)</div></div>
556 <div class="ttc" id="agroup__mci__send__command__flags__ctrls_html_ga81606bd94ce782e2c3764b913f929f60"><div class="ttname"><a href="group__mci__send__command__flags__ctrls.html#ga81606bd94ce782e2c3764b913f929f60">ARM_MCI_CARD_INITIALIZE</a></div><div class="ttdeci">#define ARM_MCI_CARD_INITIALIZE</div><div class="ttdoc">Execute Memory Card initialization sequence.</div></div>
557 <div class="ttc" id="agroup__mci__send__command__flags__ctrls_html_ga8aa566f69aa74ed416213df6ca3267bd"><div class="ttname"><a href="group__mci__send__command__flags__ctrls.html#ga8aa566f69aa74ed416213df6ca3267bd">ARM_MCI_TRANSFER_DATA</a></div><div class="ttdeci">#define ARM_MCI_TRANSFER_DATA</div><div class="ttdoc">Activate Data transfer.</div></div>
558 <div class="ttc" id="agroup__mci__send__command__flags__ctrls_html_gaa5ddf1cf772b234e3c247039effd0e7b"><div class="ttname"><a href="group__mci__send__command__flags__ctrls.html#gaa5ddf1cf772b234e3c247039effd0e7b">ARM_MCI_RESPONSE_SHORT</a></div><div class="ttdeci">#define ARM_MCI_RESPONSE_SHORT</div><div class="ttdoc">Short response (48-bit)</div></div>
559 <div class="ttc" id="agroup__mci__transfer__ctrls_html_ga4ced782e7c0c70d5f0edbddd1e48323b"><div class="ttname"><a href="group__mci__transfer__ctrls.html#ga4ced782e7c0c70d5f0edbddd1e48323b">ARM_MCI_TRANSFER_BLOCK</a></div><div class="ttdeci">#define ARM_MCI_TRANSFER_BLOCK</div><div class="ttdoc">Block Data transfer (default)</div></div>
560 <div class="ttc" id="agroup__mci__transfer__ctrls_html_gaa6f3be235a9dce5c66be8fe64f399846"><div class="ttname"><a href="group__mci__transfer__ctrls.html#gaa6f3be235a9dce5c66be8fe64f399846">ARM_MCI_TRANSFER_READ</a></div><div class="ttdeci">#define ARM_MCI_TRANSFER_READ</div><div class="ttdoc">Data Read Transfer (from MCI)</div></div>
561 </div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
562 <a name="structARM__DRIVER__MCI" id="structARM__DRIVER__MCI"></a>
563 <h2 class="memtitle"><span class="permalink"><a href="#structARM__DRIVER__MCI">◆ </a></span>ARM_DRIVER_MCI</h2>
565 <div class="memitem">
566 <div class="memproto">
567 <table class="memname">
569 <td class="memname">struct ARM_DRIVER_MCI</td>
572 </div><div class="memdoc">
573 <div class="textblock"><p>Access structure of the MCI Driver. </p>
574 <p>The functions of the MCI are accessed by function pointers exposed by this structure. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
575 <p>Each instance of an MCI provides such an access structure. The instance is identified by a postfix number in the symbol name of the access structure, for example:</p><ul>
576 <li><b>Driver_MCI0</b> is the name of the access struct of the first instance (no. 0).</li>
577 <li><b>Driver_MCI1</b> is the name of the access struct of the second instance (no. 1).</li>
579 <p>A configuration setting in the middleware allows connecting the middleware to a specific driver instance <b>Driver_MCI<em>n</em></b>. The default is <span class="XML-Token">0</span>, which connects a middleware to the first instance of a driver. </p>
580 </div><table class="memberdecls">
581 <tr><td colspan="2"><h3>Data Fields</h3></td></tr>
582 <tr class="memitem:a30afd9cb3113c037b5f1926f5ef93b59"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a> )(void)</td></tr>
583 <tr class="memdesc:a30afd9cb3113c037b5f1926f5ef93b59"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga3418183015dbf3025b94eebaedb00ab1">ARM_MCI_GetVersion</a> : Get driver version. <br /></td></tr>
584 <tr class="separator:a30afd9cb3113c037b5f1926f5ef93b59"><td class="memSeparator" colspan="2"> </td></tr>
585 <tr class="memitem:afa1d379bd4972549e60e99b129284c43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#afa1d379bd4972549e60e99b129284c43">GetCapabilities</a> )(void)</td></tr>
586 <tr class="memdesc:afa1d379bd4972549e60e99b129284c43"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a">ARM_MCI_GetCapabilities</a> : Get driver capabilities. <br /></td></tr>
587 <tr class="separator:afa1d379bd4972549e60e99b129284c43"><td class="memSeparator" colspan="2"> </td></tr>
588 <tr class="memitem:a85b30bcbe4c9747c19cce2000d5684d3"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#a85b30bcbe4c9747c19cce2000d5684d3">Initialize</a> )(<a class="el" href="group__mci__interface__gr.html#ga0d14651f6788c1ffd81544602565faf1">ARM_MCI_SignalEvent_t</a> cb_event)</td></tr>
589 <tr class="memdesc:a85b30bcbe4c9747c19cce2000d5684d3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga6f34d4ab362e596ddaf23aac093268cf">ARM_MCI_Initialize</a> : Initialize MCI Interface. <br /></td></tr>
590 <tr class="separator:a85b30bcbe4c9747c19cce2000d5684d3"><td class="memSeparator" colspan="2"> </td></tr>
591 <tr class="memitem:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#a5ce2b3d7a3a07099bf07d1eb253e92e3">Uninitialize</a> )(void)</td></tr>
592 <tr class="memdesc:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#gaef8183e77797e74997551d03646d42c2">ARM_MCI_Uninitialize</a> : De-initialize MCI Interface. <br /></td></tr>
593 <tr class="separator:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="memSeparator" colspan="2"> </td></tr>
594 <tr class="memitem:a24ebae5c6011631f76027f9a16eaf5ce"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#a24ebae5c6011631f76027f9a16eaf5ce">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
595 <tr class="memdesc:a24ebae5c6011631f76027f9a16eaf5ce"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga19752749d04ed22dc91c4294645e0244">ARM_MCI_PowerControl</a> : Control MCI Interface Power. <br /></td></tr>
596 <tr class="separator:a24ebae5c6011631f76027f9a16eaf5ce"><td class="memSeparator" colspan="2"> </td></tr>
597 <tr class="memitem:ac5f226aab1d575a4d6c4eca71cdd4a5b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ac5f226aab1d575a4d6c4eca71cdd4a5b">CardPower</a> )(uint32_t voltage)</td></tr>
598 <tr class="memdesc:ac5f226aab1d575a4d6c4eca71cdd4a5b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#gab161f80e0eda2815f3e0ebbba1314ff0">ARM_MCI_CardPower</a> : Set card power supply voltage. <br /></td></tr>
599 <tr class="separator:ac5f226aab1d575a4d6c4eca71cdd4a5b"><td class="memSeparator" colspan="2"> </td></tr>
600 <tr class="memitem:ae00aa7cf8f0c0c7e2225b3048cbded13"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ae00aa7cf8f0c0c7e2225b3048cbded13">ReadCD</a> )(void)</td></tr>
601 <tr class="memdesc:ae00aa7cf8f0c0c7e2225b3048cbded13"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga012fca8f1ce5366fce14b708c771c635">ARM_MCI_ReadCD</a> : Read Card Detect (CD) state. <br /></td></tr>
602 <tr class="separator:ae00aa7cf8f0c0c7e2225b3048cbded13"><td class="memSeparator" colspan="2"> </td></tr>
603 <tr class="memitem:ab023e8ec9252d65026c21ee84b573890"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ab023e8ec9252d65026c21ee84b573890">ReadWP</a> )(void)</td></tr>
604 <tr class="memdesc:ab023e8ec9252d65026c21ee84b573890"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga3d70286918405ac81fa795c7d09dc6fd">ARM_MCI_ReadWP</a> : Read Write Protect (WP) state. <br /></td></tr>
605 <tr class="separator:ab023e8ec9252d65026c21ee84b573890"><td class="memSeparator" colspan="2"> </td></tr>
606 <tr class="memitem:a607f96af38f877b34a937427ebc675de"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#a607f96af38f877b34a937427ebc675de">SendCommand</a> )(uint32_t cmd, uint32_t arg, uint32_t flags, uint32_t *response)</td></tr>
607 <tr class="memdesc:a607f96af38f877b34a937427ebc675de"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand</a> : Send Command to card and get the response. <br /></td></tr>
608 <tr class="separator:a607f96af38f877b34a937427ebc675de"><td class="memSeparator" colspan="2"> </td></tr>
609 <tr class="memitem:ac28f754289ae6d3783e7c18a965ee3f8"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#ac28f754289ae6d3783e7c18a965ee3f8">SetupTransfer</a> )(uint8_t *data, uint32_t block_count, uint32_t block_size, uint32_t mode)</td></tr>
610 <tr class="memdesc:ac28f754289ae6d3783e7c18a965ee3f8"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#gaaec681bcd8e6811c5743e33ee0f35ed1">ARM_MCI_SetupTransfer</a> : Setup data transfer operation. <br /></td></tr>
611 <tr class="separator:ac28f754289ae6d3783e7c18a965ee3f8"><td class="memSeparator" colspan="2"> </td></tr>
612 <tr class="memitem:a941fb6d191be477582c21d1f6757ab1f"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#a941fb6d191be477582c21d1f6757ab1f">AbortTransfer</a> )(void)</td></tr>
613 <tr class="memdesc:a941fb6d191be477582c21d1f6757ab1f"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga3dfcf7b7186b711f9b63a096be816fe5">ARM_MCI_AbortTransfer</a> : Abort current data transfer. <br /></td></tr>
614 <tr class="separator:a941fb6d191be477582c21d1f6757ab1f"><td class="memSeparator" colspan="2"> </td></tr>
615 <tr class="memitem:a5e96d73d3a3c366aba50bf5304edb029"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#a5e96d73d3a3c366aba50bf5304edb029">Control</a> )(uint32_t control, uint32_t arg)</td></tr>
616 <tr class="memdesc:a5e96d73d3a3c366aba50bf5304edb029"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> : Control MCI Interface. <br /></td></tr>
617 <tr class="separator:a5e96d73d3a3c366aba50bf5304edb029"><td class="memSeparator" colspan="2"> </td></tr>
618 <tr class="memitem:a8e6e71480a5ec1575b6471ce3d32117d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__interface__gr.html#a8e6e71480a5ec1575b6471ce3d32117d">GetStatus</a> )(void)</td></tr>
619 <tr class="memdesc:a8e6e71480a5ec1575b6471ce3d32117d"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9">ARM_MCI_GetStatus</a> : Get MCI status. <br /></td></tr>
620 <tr class="separator:a8e6e71480a5ec1575b6471ce3d32117d"><td class="memSeparator" colspan="2"> </td></tr>
622 <h4 class="groupheader">Field Documentation</h4>
623 <a id="a30afd9cb3113c037b5f1926f5ef93b59" name="a30afd9cb3113c037b5f1926f5ef93b59"></a>
624 <h2 class="memtitle"><span class="permalink"><a href="#a30afd9cb3113c037b5f1926f5ef93b59">◆ </a></span>GetVersion</h2>
626 <div class="memitem">
627 <div class="memproto">
628 <table class="memname">
630 <td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion) (void)</td>
633 </div><div class="memdoc">
635 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga3418183015dbf3025b94eebaedb00ab1">ARM_MCI_GetVersion</a> : Get driver version. </p>
639 <a id="afa1d379bd4972549e60e99b129284c43" name="afa1d379bd4972549e60e99b129284c43"></a>
640 <h2 class="memtitle"><span class="permalink"><a href="#afa1d379bd4972549e60e99b129284c43">◆ </a></span>GetCapabilities</h2>
642 <div class="memitem">
643 <div class="memproto">
644 <table class="memname">
646 <td class="memname"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a>(* GetCapabilities) (void)</td>
649 </div><div class="memdoc">
651 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a">ARM_MCI_GetCapabilities</a> : Get driver capabilities. </p>
655 <a id="a85b30bcbe4c9747c19cce2000d5684d3" name="a85b30bcbe4c9747c19cce2000d5684d3"></a>
656 <h2 class="memtitle"><span class="permalink"><a href="#a85b30bcbe4c9747c19cce2000d5684d3">◆ </a></span>Initialize</h2>
658 <div class="memitem">
659 <div class="memproto">
660 <table class="memname">
662 <td class="memname">int32_t(* Initialize) (<a class="el" href="group__mci__interface__gr.html#ga0d14651f6788c1ffd81544602565faf1">ARM_MCI_SignalEvent_t</a> cb_event)</td>
665 </div><div class="memdoc">
667 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga6f34d4ab362e596ddaf23aac093268cf">ARM_MCI_Initialize</a> : Initialize MCI Interface. </p>
671 <a id="a5ce2b3d7a3a07099bf07d1eb253e92e3" name="a5ce2b3d7a3a07099bf07d1eb253e92e3"></a>
672 <h2 class="memtitle"><span class="permalink"><a href="#a5ce2b3d7a3a07099bf07d1eb253e92e3">◆ </a></span>Uninitialize</h2>
674 <div class="memitem">
675 <div class="memproto">
676 <table class="memname">
678 <td class="memname">int32_t(* Uninitialize) (void)</td>
681 </div><div class="memdoc">
683 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#gaef8183e77797e74997551d03646d42c2">ARM_MCI_Uninitialize</a> : De-initialize MCI Interface. </p>
687 <a id="a24ebae5c6011631f76027f9a16eaf5ce" name="a24ebae5c6011631f76027f9a16eaf5ce"></a>
688 <h2 class="memtitle"><span class="permalink"><a href="#a24ebae5c6011631f76027f9a16eaf5ce">◆ </a></span>PowerControl</h2>
690 <div class="memitem">
691 <div class="memproto">
692 <table class="memname">
694 <td class="memname">int32_t(* PowerControl) (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
697 </div><div class="memdoc">
699 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga19752749d04ed22dc91c4294645e0244">ARM_MCI_PowerControl</a> : Control MCI Interface Power. </p>
703 <a id="ac5f226aab1d575a4d6c4eca71cdd4a5b" name="ac5f226aab1d575a4d6c4eca71cdd4a5b"></a>
704 <h2 class="memtitle"><span class="permalink"><a href="#ac5f226aab1d575a4d6c4eca71cdd4a5b">◆ </a></span>CardPower</h2>
706 <div class="memitem">
707 <div class="memproto">
708 <table class="memname">
710 <td class="memname">int32_t(* CardPower) (uint32_t voltage)</td>
713 </div><div class="memdoc">
715 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#gab161f80e0eda2815f3e0ebbba1314ff0">ARM_MCI_CardPower</a> : Set card power supply voltage. </p>
719 <a id="ae00aa7cf8f0c0c7e2225b3048cbded13" name="ae00aa7cf8f0c0c7e2225b3048cbded13"></a>
720 <h2 class="memtitle"><span class="permalink"><a href="#ae00aa7cf8f0c0c7e2225b3048cbded13">◆ </a></span>ReadCD</h2>
722 <div class="memitem">
723 <div class="memproto">
724 <table class="memname">
726 <td class="memname">int32_t(* ReadCD) (void)</td>
729 </div><div class="memdoc">
731 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga012fca8f1ce5366fce14b708c771c635">ARM_MCI_ReadCD</a> : Read Card Detect (CD) state. </p>
735 <a id="ab023e8ec9252d65026c21ee84b573890" name="ab023e8ec9252d65026c21ee84b573890"></a>
736 <h2 class="memtitle"><span class="permalink"><a href="#ab023e8ec9252d65026c21ee84b573890">◆ </a></span>ReadWP</h2>
738 <div class="memitem">
739 <div class="memproto">
740 <table class="memname">
742 <td class="memname">int32_t(* ReadWP) (void)</td>
745 </div><div class="memdoc">
747 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga3d70286918405ac81fa795c7d09dc6fd">ARM_MCI_ReadWP</a> : Read Write Protect (WP) state. </p>
751 <a id="a607f96af38f877b34a937427ebc675de" name="a607f96af38f877b34a937427ebc675de"></a>
752 <h2 class="memtitle"><span class="permalink"><a href="#a607f96af38f877b34a937427ebc675de">◆ </a></span>SendCommand</h2>
754 <div class="memitem">
755 <div class="memproto">
756 <table class="memname">
758 <td class="memname">int32_t(* SendCommand) (uint32_t cmd, uint32_t arg, uint32_t flags, uint32_t *response)</td>
761 </div><div class="memdoc">
763 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand</a> : Send Command to card and get the response. </p>
767 <a id="ac28f754289ae6d3783e7c18a965ee3f8" name="ac28f754289ae6d3783e7c18a965ee3f8"></a>
768 <h2 class="memtitle"><span class="permalink"><a href="#ac28f754289ae6d3783e7c18a965ee3f8">◆ </a></span>SetupTransfer</h2>
770 <div class="memitem">
771 <div class="memproto">
772 <table class="memname">
774 <td class="memname">int32_t(* SetupTransfer) (uint8_t *data, uint32_t block_count, uint32_t block_size, uint32_t mode)</td>
777 </div><div class="memdoc">
779 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#gaaec681bcd8e6811c5743e33ee0f35ed1">ARM_MCI_SetupTransfer</a> : Setup data transfer operation. </p>
783 <a id="a941fb6d191be477582c21d1f6757ab1f" name="a941fb6d191be477582c21d1f6757ab1f"></a>
784 <h2 class="memtitle"><span class="permalink"><a href="#a941fb6d191be477582c21d1f6757ab1f">◆ </a></span>AbortTransfer</h2>
786 <div class="memitem">
787 <div class="memproto">
788 <table class="memname">
790 <td class="memname">int32_t(* AbortTransfer) (void)</td>
793 </div><div class="memdoc">
795 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga3dfcf7b7186b711f9b63a096be816fe5">ARM_MCI_AbortTransfer</a> : Abort current data transfer. </p>
799 <a id="a5e96d73d3a3c366aba50bf5304edb029" name="a5e96d73d3a3c366aba50bf5304edb029"></a>
800 <h2 class="memtitle"><span class="permalink"><a href="#a5e96d73d3a3c366aba50bf5304edb029">◆ </a></span>Control</h2>
802 <div class="memitem">
803 <div class="memproto">
804 <table class="memname">
806 <td class="memname">int32_t(* Control) (uint32_t control, uint32_t arg)</td>
809 </div><div class="memdoc">
811 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control</a> : Control MCI Interface. </p>
815 <a id="a8e6e71480a5ec1575b6471ce3d32117d" name="a8e6e71480a5ec1575b6471ce3d32117d"></a>
816 <h2 class="memtitle"><span class="permalink"><a href="#a8e6e71480a5ec1575b6471ce3d32117d">◆ </a></span>GetStatus</h2>
818 <div class="memitem">
819 <div class="memproto">
820 <table class="memname">
822 <td class="memname"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a>(* GetStatus) (void)</td>
825 </div><div class="memdoc">
827 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9">ARM_MCI_GetStatus</a> : Get MCI status. </p>
834 <a name="structARM__MCI__CAPABILITIES" id="structARM__MCI__CAPABILITIES"></a>
835 <h2 class="memtitle"><span class="permalink"><a href="#structARM__MCI__CAPABILITIES">◆ </a></span>ARM_MCI_CAPABILITIES</h2>
837 <div class="memitem">
838 <div class="memproto">
839 <table class="memname">
841 <td class="memname">struct ARM_MCI_CAPABILITIES</td>
844 </div><div class="memdoc">
845 <div class="textblock"><p>MCI Driver Capabilities. </p>
846 <p>A MCI driver can be implemented with different capabilities. <br />
847 The data fields of this struct encode the capabilities implemented by this driver.</p>
848 <p><b>Returned by:</b></p><ul>
849 <li><a class="el" href="group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a">ARM_MCI_GetCapabilities</a> </li>
851 </div><table class="fieldtable">
852 <tr><th colspan="3">Data Fields</th></tr>
853 <tr><td class="fieldtype">
854 <a id="af47e73979b028c86c7c1fbe39b095140" name="af47e73979b028c86c7c1fbe39b095140"></a>uint32_t</td>
855 <td class="fieldname">
857 <td class="fielddoc">
858 Card Detect State available. </td></tr>
859 <tr><td class="fieldtype">
860 <a id="abcabfa504d3226c723d9bf5debe2f164" name="abcabfa504d3226c723d9bf5debe2f164"></a>uint32_t</td>
861 <td class="fieldname">
863 <td class="fielddoc">
864 Signal Card Detect change event. </td></tr>
865 <tr><td class="fieldtype">
866 <a id="a02df0162d3a653c36158a7b6a76f6175" name="a02df0162d3a653c36158a7b6a76f6175"></a>uint32_t</td>
867 <td class="fieldname">
869 <td class="fielddoc">
870 Write Protect State available. </td></tr>
871 <tr><td class="fieldtype">
872 <a id="a414baec222a72be862e262f02b821dce" name="a414baec222a72be862e262f02b821dce"></a>uint32_t</td>
873 <td class="fieldname">
875 <td class="fielddoc">
876 Supports VDD Card Power Supply Control. </td></tr>
877 <tr><td class="fieldtype">
878 <a id="abeb0330f882ebed8cabde782652233dd" name="abeb0330f882ebed8cabde782652233dd"></a>uint32_t</td>
879 <td class="fieldname">
881 <td class="fielddoc">
882 Supports 1.8 VDD Card Power Supply. </td></tr>
883 <tr><td class="fieldtype">
884 <a id="ab1cdfce6eb051bed7b904e0fd1719afa" name="ab1cdfce6eb051bed7b904e0fd1719afa"></a>uint32_t</td>
885 <td class="fieldname">
887 <td class="fielddoc">
888 Supports VCCQ Card Power Supply Control (eMMC) </td></tr>
889 <tr><td class="fieldtype">
890 <a id="a1896a7548bb6fab285f23cc0d0b23d7d" name="a1896a7548bb6fab285f23cc0d0b23d7d"></a>uint32_t</td>
891 <td class="fieldname">
893 <td class="fielddoc">
894 Supports 1.8 VCCQ Card Power Supply (eMMC) </td></tr>
895 <tr><td class="fieldtype">
896 <a id="af4f95215005e38700ef527714932b361" name="af4f95215005e38700ef527714932b361"></a>uint32_t</td>
897 <td class="fieldname">
899 <td class="fielddoc">
900 Supports 1.2 VCCQ Card Power Supply (eMMC) </td></tr>
901 <tr><td class="fieldtype">
902 <a id="a950669a8c88b49c8da4c56163b45a79d" name="a950669a8c88b49c8da4c56163b45a79d"></a>uint32_t</td>
903 <td class="fieldname">
905 <td class="fielddoc">
906 Supports 4-bit data. </td></tr>
907 <tr><td class="fieldtype">
908 <a id="a808703d6c70a501464e156e55f5cabd2" name="a808703d6c70a501464e156e55f5cabd2"></a>uint32_t</td>
909 <td class="fieldname">
911 <td class="fielddoc">
912 Supports 8-bit data. </td></tr>
913 <tr><td class="fieldtype">
914 <a id="abb1a604b0ee4f7e3510409747890e41e" name="abb1a604b0ee4f7e3510409747890e41e"></a>uint32_t</td>
915 <td class="fieldname">
916 data_width_4_ddr: 1</td>
917 <td class="fielddoc">
918 Supports 4-bit data, DDR (Dual Data Rate) - MMC only. </td></tr>
919 <tr><td class="fieldtype">
920 <a id="acd5f6dce3a548d12c292e8cd17e4e9e2" name="acd5f6dce3a548d12c292e8cd17e4e9e2"></a>uint32_t</td>
921 <td class="fieldname">
922 data_width_8_ddr: 1</td>
923 <td class="fielddoc">
924 Supports 8-bit data, DDR (Dual Data Rate) - MMC only. </td></tr>
925 <tr><td class="fieldtype">
926 <a id="a83ecf7d4472c55362750ef72d8f8f47d" name="a83ecf7d4472c55362750ef72d8f8f47d"></a>uint32_t</td>
927 <td class="fieldname">
929 <td class="fielddoc">
930 Supports SD/MMC High Speed Mode. </td></tr>
931 <tr><td class="fieldtype">
932 <a id="a084188480d589cdc8d3e164b9f41bea9" name="a084188480d589cdc8d3e164b9f41bea9"></a>uint32_t</td>
933 <td class="fieldname">
934 uhs_signaling: 1</td>
935 <td class="fielddoc">
936 Supports SD UHS-I (Ultra High Speed) 1.8V signaling. </td></tr>
937 <tr><td class="fieldtype">
938 <a id="a617bf7fb73b49a20398b90098ecc3ec0" name="a617bf7fb73b49a20398b90098ecc3ec0"></a>uint32_t</td>
939 <td class="fieldname">
941 <td class="fielddoc">
942 Supports SD UHS-I tuning. </td></tr>
943 <tr><td class="fieldtype">
944 <a id="a5c3dcb2f8aa6f65408d9a6741abb7b3e" name="a5c3dcb2f8aa6f65408d9a6741abb7b3e"></a>uint32_t</td>
945 <td class="fieldname">
947 <td class="fielddoc">
948 Supports SD UHS-I SDR50 (Single Data Rate) up to 50MB/s. </td></tr>
949 <tr><td class="fieldtype">
950 <a id="ae07ceef1800252495a79f225142740e7" name="ae07ceef1800252495a79f225142740e7"></a>uint32_t</td>
951 <td class="fieldname">
953 <td class="fielddoc">
954 Supports SD UHS-I SDR104 (Single Data Rate) up to 104MB/s. </td></tr>
955 <tr><td class="fieldtype">
956 <a id="a1ee73c19020d5f1bedf7c013d0e5f730" name="a1ee73c19020d5f1bedf7c013d0e5f730"></a>uint32_t</td>
957 <td class="fieldname">
959 <td class="fielddoc">
960 Supports SD UHS-I DDR50 (Dual Data Rate) up to 50MB/s. </td></tr>
961 <tr><td class="fieldtype">
962 <a id="afe5de4fdc6657aa19fa87577a8d460e5" name="afe5de4fdc6657aa19fa87577a8d460e5"></a>uint32_t</td>
963 <td class="fieldname">
964 uhs_driver_type_a: 1</td>
965 <td class="fielddoc">
966 Supports SD UHS-I Driver Type A. </td></tr>
967 <tr><td class="fieldtype">
968 <a id="a3c3df9641e7216dd20d3bc395dc4948f" name="a3c3df9641e7216dd20d3bc395dc4948f"></a>uint32_t</td>
969 <td class="fieldname">
970 uhs_driver_type_c: 1</td>
971 <td class="fielddoc">
972 Supports SD UHS-I Driver Type C. </td></tr>
973 <tr><td class="fieldtype">
974 <a id="a639bebbcb9a3a743f4f232fec82e2bfc" name="a639bebbcb9a3a743f4f232fec82e2bfc"></a>uint32_t</td>
975 <td class="fieldname">
976 uhs_driver_type_d: 1</td>
977 <td class="fielddoc">
978 Supports SD UHS-I Driver Type D. </td></tr>
979 <tr><td class="fieldtype">
980 <a id="a61e2a440b27d7d22c866ad4427f4b825" name="a61e2a440b27d7d22c866ad4427f4b825"></a>uint32_t</td>
981 <td class="fieldname">
982 sdio_interrupt: 1</td>
983 <td class="fielddoc">
984 Supports SD I/O Interrupt. </td></tr>
985 <tr><td class="fieldtype">
986 <a id="a5e38e4ee9cebcc99904e287adc8e6217" name="a5e38e4ee9cebcc99904e287adc8e6217"></a>uint32_t</td>
987 <td class="fieldname">
989 <td class="fielddoc">
990 Supports Read Wait (SD I/O) </td></tr>
991 <tr><td class="fieldtype">
992 <a id="abb03f0187e4658f417b5a24cac33eed9" name="abb03f0187e4658f417b5a24cac33eed9"></a>uint32_t</td>
993 <td class="fieldname">
994 suspend_resume: 1</td>
995 <td class="fielddoc">
996 Supports Suspend/Resume (SD I/O) </td></tr>
997 <tr><td class="fieldtype">
998 <a id="a3303194ea68bd1094841d4f958f6dbbf" name="a3303194ea68bd1094841d4f958f6dbbf"></a>uint32_t</td>
999 <td class="fieldname">
1000 mmc_interrupt: 1</td>
1001 <td class="fielddoc">
1002 Supports MMC Interrupt. </td></tr>
1003 <tr><td class="fieldtype">
1004 <a id="a072a194948489d4dbd2409b94fdca56b" name="a072a194948489d4dbd2409b94fdca56b"></a>uint32_t</td>
1005 <td class="fieldname">
1007 <td class="fielddoc">
1008 Supports MMC Boot. </td></tr>
1009 <tr><td class="fieldtype">
1010 <a id="a2e8bd27f2c5c3093c4fec557890b97d4" name="a2e8bd27f2c5c3093c4fec557890b97d4"></a>uint32_t</td>
1011 <td class="fieldname">
1013 <td class="fielddoc">
1014 Supports RST_n Pin Control (eMMC) </td></tr>
1015 <tr><td class="fieldtype">
1016 <a id="a13c956ba993083f1e59379968e2badbe" name="a13c956ba993083f1e59379968e2badbe"></a>uint32_t</td>
1017 <td class="fieldname">
1019 <td class="fielddoc">
1020 Supports Command Completion Signal (CCS) for CE-ATA. </td></tr>
1021 <tr><td class="fieldtype">
1022 <a id="a9739c230a13b46482feb5475d257e482" name="a9739c230a13b46482feb5475d257e482"></a>uint32_t</td>
1023 <td class="fieldname">
1025 <td class="fielddoc">
1026 Supports Command Completion Signal (CCS) timeout for CE-ATA. </td></tr>
1027 <tr><td class="fieldtype">
1028 <a id="aa43c4c21b173ada1b6b7568956f0d650" name="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
1029 <td class="fieldname">
1031 <td class="fielddoc">
1032 Reserved (must be zero) </td></tr>
1037 <a name="structARM__MCI__STATUS" id="structARM__MCI__STATUS"></a>
1038 <h2 class="memtitle"><span class="permalink"><a href="#structARM__MCI__STATUS">◆ </a></span>ARM_MCI_STATUS</h2>
1040 <div class="memitem">
1041 <div class="memproto">
1042 <table class="memname">
1044 <td class="memname">struct ARM_MCI_STATUS</td>
1047 </div><div class="memdoc">
1048 <div class="textblock"><p>MCI Status. </p>
1049 <p>Structure with information about the status of the MCI.</p>
1050 <p><b>Returned by:</b></p><ul>
1051 <li><a class="el" href="group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9">ARM_MCI_GetStatus</a> </li>
1053 </div><table class="fieldtable">
1054 <tr><th colspan="3">Data Fields</th></tr>
1055 <tr><td class="fieldtype">
1056 <a id="aa22ef7c7597e90835bd67d5795ba757e" name="aa22ef7c7597e90835bd67d5795ba757e"></a>uint32_t</td>
1057 <td class="fieldname">
1058 command_active: 1</td>
1059 <td class="fielddoc">
1060 Command active flag. </td></tr>
1061 <tr><td class="fieldtype">
1062 <a id="a56e426979c3872254c156e9ae7eead5b" name="a56e426979c3872254c156e9ae7eead5b"></a>uint32_t</td>
1063 <td class="fieldname">
1064 command_timeout: 1</td>
1065 <td class="fielddoc">
1066 Command timeout flag (cleared on start of next command) </td></tr>
1067 <tr><td class="fieldtype">
1068 <a id="afca11cd2ce661c67455a6d75328848cc" name="afca11cd2ce661c67455a6d75328848cc"></a>uint32_t</td>
1069 <td class="fieldname">
1070 command_error: 1</td>
1071 <td class="fielddoc">
1072 Command error flag (cleared on start of next command) </td></tr>
1073 <tr><td class="fieldtype">
1074 <a id="a2655d3422b720097b091a28e8bbcea8f" name="a2655d3422b720097b091a28e8bbcea8f"></a>uint32_t</td>
1075 <td class="fieldname">
1076 transfer_active: 1</td>
1077 <td class="fielddoc">
1078 Transfer active flag. </td></tr>
1079 <tr><td class="fieldtype">
1080 <a id="a598ae4a196316d6dcb97d07fd337ecdd" name="a598ae4a196316d6dcb97d07fd337ecdd"></a>uint32_t</td>
1081 <td class="fieldname">
1082 transfer_timeout: 1</td>
1083 <td class="fielddoc">
1084 Transfer timeout flag (cleared on start of next command) </td></tr>
1085 <tr><td class="fieldtype">
1086 <a id="a21d4bc1a03e161bd33693619039a6afa" name="a21d4bc1a03e161bd33693619039a6afa"></a>uint32_t</td>
1087 <td class="fieldname">
1088 transfer_error: 1</td>
1089 <td class="fielddoc">
1090 Transfer error flag (cleared on start of next command) </td></tr>
1091 <tr><td class="fieldtype">
1092 <a id="a61e2a440b27d7d22c866ad4427f4b825" name="a61e2a440b27d7d22c866ad4427f4b825"></a>uint32_t</td>
1093 <td class="fieldname">
1094 sdio_interrupt: 1</td>
1095 <td class="fielddoc">
1096 SD I/O Interrupt flag (cleared on start of monitoring) </td></tr>
1097 <tr><td class="fieldtype">
1098 <a id="a13c956ba993083f1e59379968e2badbe" name="a13c956ba993083f1e59379968e2badbe"></a>uint32_t</td>
1099 <td class="fieldname">
1101 <td class="fielddoc">
1102 CCS flag (cleared on start of next command) </td></tr>
1103 <tr><td class="fieldtype">
1104 <a id="aa43c4c21b173ada1b6b7568956f0d650" name="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
1105 <td class="fieldname">
1107 <td class="fielddoc">
1113 <h2 class="groupheader">Typedef Documentation</h2>
1114 <a id="ga0d14651f6788c1ffd81544602565faf1" name="ga0d14651f6788c1ffd81544602565faf1"></a>
1115 <h2 class="memtitle"><span class="permalink"><a href="#ga0d14651f6788c1ffd81544602565faf1">◆ </a></span>ARM_MCI_SignalEvent_t</h2>
1117 <div class="memitem">
1118 <div class="memproto">
1119 <table class="memname">
1121 <td class="memname">ARM_MCI_SignalEvent_t</td>
1124 </div><div class="memdoc">
1126 <p>Pointer to <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> : Signal MCI Card Event. </p>
1127 <p>Provides the typedef for the callback function <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a>.</p>
1128 <p><b>Parameter for:</b></p><ul>
1129 <li><a class="el" href="group__mci__interface__gr.html#ga6f34d4ab362e596ddaf23aac093268cf">ARM_MCI_Initialize</a> </li>
1134 <h2 class="groupheader">Function Documentation</h2>
1135 <a id="ga3418183015dbf3025b94eebaedb00ab1" name="ga3418183015dbf3025b94eebaedb00ab1"></a>
1136 <h2 class="memtitle"><span class="permalink"><a href="#ga3418183015dbf3025b94eebaedb00ab1">◆ </a></span>ARM_MCI_GetVersion()</h2>
1138 <div class="memitem">
1139 <div class="memproto">
1140 <table class="memname">
1142 <td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_MCI_GetVersion </td>
1144 <td class="paramtype">void </td>
1145 <td class="paramname"></td><td>)</td>
1149 </div><div class="memdoc">
1151 <p>Get driver version. </p>
1152 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></dd></dl>
1153 <p>The function <b>ARM_MCI_GetVersion</b> returns version information of the driver implementation in <a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></p><ul>
1154 <li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
1155 <li>Driver version is source code version of the actual driver implementation.</li>
1157 <p>Example: </p><div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> Driver_MCI0;</div>
1158 <div class="line"><a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv_info;</div>
1159 <div class="line"> </div>
1160 <div class="line"><span class="keywordtype">void</span> setup_mci (<span class="keywordtype">void</span>) {</div>
1161 <div class="line"> <a class="code hl_struct" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> version;</div>
1162 <div class="line"> </div>
1163 <div class="line"> drv_info = &Driver_MCI0;</div>
1164 <div class="line"> version = drv_info-><a class="code hl_variable" href="group__mci__interface__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a> ();</div>
1165 <div class="line"> <span class="keywordflow">if</span> (version.<a class="code hl_variable" href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">api</a> < 0x10A) { <span class="comment">// requires at minimum API version 1.10 or higher</span></div>
1166 <div class="line"> <span class="comment">// error handling</span></div>
1167 <div class="line"> <span class="keywordflow">return</span>;</div>
1168 <div class="line"> }</div>
1169 <div class="line">}</div>
1170 <div class="ttc" id="agroup__common__drv__gr_html_ad180da20fbde1d3dafc074af87c19540"><div class="ttname"><a href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">ARM_DRIVER_VERSION::api</a></div><div class="ttdeci">uint16_t api</div><div class="ttdoc">API version.</div><div class="ttdef"><b>Definition:</b> Driver_Common.h:47</div></div>
1171 <div class="ttc" id="agroup__common__drv__gr_html_structARM__DRIVER__VERSION"><div class="ttname"><a href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></div><div class="ttdoc">Driver Version.</div><div class="ttdef"><b>Definition:</b> Driver_Common.h:46</div></div>
1172 <div class="ttc" id="agroup__mci__interface__gr_html_a30afd9cb3113c037b5f1926f5ef93b59"><div class="ttname"><a href="group__mci__interface__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">ARM_DRIVER_MCI::GetVersion</a></div><div class="ttdeci">ARM_DRIVER_VERSION(* GetVersion)(void)</div><div class="ttdoc">Pointer to ARM_MCI_GetVersion : Get driver version.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:341</div></div>
1173 </div><!-- fragment -->
1176 <a id="ga7e5a78b6e6409189833a0b72a0a3c48a" name="ga7e5a78b6e6409189833a0b72a0a3c48a"></a>
1177 <h2 class="memtitle"><span class="permalink"><a href="#ga7e5a78b6e6409189833a0b72a0a3c48a">◆ </a></span>ARM_MCI_GetCapabilities()</h2>
1179 <div class="memitem">
1180 <div class="memproto">
1181 <table class="memname">
1183 <td class="memname"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a> ARM_MCI_GetCapabilities </td>
1185 <td class="paramtype">void </td>
1186 <td class="paramname"></td><td>)</td>
1190 </div><div class="memdoc">
1192 <p>Get driver capabilities. </p>
1193 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a></dd></dl>
1194 <p>The function <b>ARM_MCI_GetCapabilities</b> returns information about capabilities in this driver implementation. The data fields of the structure <a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a> encode various capabilities, for example supported bus modes ...</p>
1195 <p>Example: </p><div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> Driver_MCI0;</div>
1196 <div class="line"><a class="code hl_struct" href="group__mci__interface__gr.html#structARM__DRIVER__MCI">ARM_DRIVER_MCI</a> *drv_info;</div>
1197 <div class="line"> </div>
1198 <div class="line"><span class="keywordtype">void</span> read_capabilities (<span class="keywordtype">void</span>) {</div>
1199 <div class="line"> <a class="code hl_struct" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a> drv_capabilities;</div>
1200 <div class="line"> </div>
1201 <div class="line"> drv_info = &Driver_MCI0; </div>
1202 <div class="line"> drv_capabilities = drv_info-><a class="code hl_variable" href="group__mci__interface__gr.html#afa1d379bd4972549e60e99b129284c43">GetCapabilities</a> ();</div>
1203 <div class="line"> <span class="comment">// interrogate capabilities</span></div>
1204 <div class="line"> </div>
1205 <div class="line">}</div>
1206 <div class="ttc" id="agroup__mci__interface__gr_html_afa1d379bd4972549e60e99b129284c43"><div class="ttname"><a href="group__mci__interface__gr.html#afa1d379bd4972549e60e99b129284c43">ARM_DRIVER_MCI::GetCapabilities</a></div><div class="ttdeci">ARM_MCI_CAPABILITIES(* GetCapabilities)(void)</div><div class="ttdoc">Pointer to ARM_MCI_GetCapabilities : Get driver capabilities.</div><div class="ttdef"><b>Definition:</b> Driver_MCI.h:342</div></div>
1207 </div><!-- fragment -->
1210 <a id="ga6f34d4ab362e596ddaf23aac093268cf" name="ga6f34d4ab362e596ddaf23aac093268cf"></a>
1211 <h2 class="memtitle"><span class="permalink"><a href="#ga6f34d4ab362e596ddaf23aac093268cf">◆ </a></span>ARM_MCI_Initialize()</h2>
1213 <div class="memitem">
1214 <div class="memproto">
1215 <table class="memname">
1217 <td class="memname">int32_t ARM_MCI_Initialize </td>
1219 <td class="paramtype"><a class="el" href="group__mci__interface__gr.html#ga0d14651f6788c1ffd81544602565faf1">ARM_MCI_SignalEvent_t</a> </td>
1220 <td class="paramname"><em>cb_event</em></td><td>)</td>
1224 </div><div class="memdoc">
1226 <p>Initialize the Memory Card Interface. </p>
1227 <dl class="params"><dt>Parameters</dt><dd>
1228 <table class="params">
1229 <tr><td class="paramdir">[in]</td><td class="paramname">cb_event</td><td>Pointer to <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </td></tr>
1233 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1234 <p>The function <b>ARM_MCI_Initialize</b> initializes the MCI interface. It is called when the middleware component starts operation.</p>
1235 <p>The function performs the following operations:</p><ul>
1236 <li>Initializes the resources needed for the MCI interface.</li>
1237 <li>Registers the <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> callback function.</li>
1239 <p>The parameter <em>cb_event</em> is a pointer to the <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> callback function; use a NULL pointer when no callback signals are required.</p>
1240 <p><b>Example:</b> </p><ul>
1241 <li>see <a class="el" href="group__mci__interface__gr.html">MCI Interface</a> - Driver Functions </li>
1246 <a id="gaef8183e77797e74997551d03646d42c2" name="gaef8183e77797e74997551d03646d42c2"></a>
1247 <h2 class="memtitle"><span class="permalink"><a href="#gaef8183e77797e74997551d03646d42c2">◆ </a></span>ARM_MCI_Uninitialize()</h2>
1249 <div class="memitem">
1250 <div class="memproto">
1251 <table class="memname">
1253 <td class="memname">int32_t ARM_MCI_Uninitialize </td>
1255 <td class="paramtype">void </td>
1256 <td class="paramname"></td><td>)</td>
1260 </div><div class="memdoc">
1262 <p>De-initialize Memory Card Interface. </p>
1263 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1264 <p>The function <b>ARM_MCI_Uninitialize</b> de-initializes the resources of I2C interface.</p>
1265 <p>It is called when the middleware component stops operation and releases the software resources used by the interface. </p>
1269 <a id="ga19752749d04ed22dc91c4294645e0244" name="ga19752749d04ed22dc91c4294645e0244"></a>
1270 <h2 class="memtitle"><span class="permalink"><a href="#ga19752749d04ed22dc91c4294645e0244">◆ </a></span>ARM_MCI_PowerControl()</h2>
1272 <div class="memitem">
1273 <div class="memproto">
1274 <table class="memname">
1276 <td class="memname">int32_t ARM_MCI_PowerControl </td>
1278 <td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> </td>
1279 <td class="paramname"><em>state</em></td><td>)</td>
1283 </div><div class="memdoc">
1285 <p>Control Memory Card Interface Power. </p>
1286 <dl class="params"><dt>Parameters</dt><dd>
1287 <table class="params">
1288 <tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state <a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> </td></tr>
1292 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1294 The function <b>ARM_MCI_PowerControl</b> operates the power modes of the MCI interface. <br />
1296 <p>The parameter <em>state</em> can have the following values:</p><ul>
1297 <li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a> : set-up peripheral for data transfers, enable interrupts (NVIC) and optionally DMA. Can be called multiple times. If the peripheral is already in this mode, then the function performs no operation and returns with <a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>.</li>
1298 <li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434">ARM_POWER_LOW</a> : may use power saving. Returns <a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> when not implemented.</li>
1299 <li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a> : terminates any pending data transfers, disables peripheral, disables related interrupts and DMA.</li>
1301 <p>Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information. </p>
1305 <a id="gab161f80e0eda2815f3e0ebbba1314ff0" name="gab161f80e0eda2815f3e0ebbba1314ff0"></a>
1306 <h2 class="memtitle"><span class="permalink"><a href="#gab161f80e0eda2815f3e0ebbba1314ff0">◆ </a></span>ARM_MCI_CardPower()</h2>
1308 <div class="memitem">
1309 <div class="memproto">
1310 <table class="memname">
1312 <td class="memname">int32_t ARM_MCI_CardPower </td>
1314 <td class="paramtype">uint32_t </td>
1315 <td class="paramname"><em>voltage</em></td><td>)</td>
1319 </div><div class="memdoc">
1321 <p>Set Memory Card Power supply voltage. </p>
1322 <dl class="params"><dt>Parameters</dt><dd>
1323 <table class="params">
1324 <tr><td class="paramdir">[in]</td><td class="paramname">voltage</td><td>Memory Card Power supply voltage </td></tr>
1328 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1329 <p>The function <b>ARM_MCI_CardPower</b> operates the memory card power supply voltage.</p>
1330 <p>The parameter <em>voltage</em> sets the voltage. Not every voltage might be supported by the driver implementation. The structure <a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES">ARM_MCI_CAPABILITIES</a> encodes the supported voltage. Retrieve the information with the function <a class="el" href="group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a">ARM_MCI_GetCapabilities</a> and verify the data fields.</p>
1331 <p>The following values:</p>
1332 <table class="markdownTable">
1333 <tr class="markdownTableHead">
1334 <th class="markdownTableHeadLeft">Parameter <em>voltage</em> </th><th class="markdownTableHeadLeft">Description </th><th class="markdownTableHeadNone">supported when <a class="el" href="group__mci__interface__gr.html#structARM__MCI__CAPABILITIES" title="MCI Driver Capabilities.">ARM_MCI_CAPABILITIES</a> </th></tr>
1335 <tr class="markdownTableRowOdd">
1336 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__card__power__ctrls.html#ga288fbd80b384739a80e8f3ec31205cf5">ARM_MCI_POWER_VDD_OFF</a> </td><td class="markdownTableBodyLeft">VDD (VCC) turned off </td><td class="markdownTableBodyNone"><em>always supported</em> </td></tr>
1337 <tr class="markdownTableRowEven">
1338 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__card__power__ctrls.html#ga565ecd36c8d0379fb4172da577cc540d">ARM_MCI_POWER_VDD_3V3</a> </td><td class="markdownTableBodyLeft">VDD (VCC) = <span class="XML-Token">3.3V</span> </td><td class="markdownTableBodyNone">data field <em>vdd</em> = <span class="XML-Token">1</span> </td></tr>
1339 <tr class="markdownTableRowOdd">
1340 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__card__power__ctrls.html#ga2ce8e379c3691da3b51c9c97d61770ef">ARM_MCI_POWER_VDD_1V8</a> </td><td class="markdownTableBodyLeft">VDD (VCC) = <span class="XML-Token">1.8V</span> </td><td class="markdownTableBodyNone">data field <em>vdd_1v8</em> = <span class="XML-Token">1</span> </td></tr>
1341 <tr class="markdownTableRowEven">
1342 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__card__power__ctrls.html#ga6929c98a6bc8d898939a95111509220b">ARM_MCI_POWER_VCCQ_OFF</a> </td><td class="markdownTableBodyLeft">eMMC VCCQ turned off </td><td class="markdownTableBodyNone"><em>always supported</em> </td></tr>
1343 <tr class="markdownTableRowOdd">
1344 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__card__power__ctrls.html#ga91a7201173cc092eaf7f0bcee028871e">ARM_MCI_POWER_VCCQ_3V3</a> </td><td class="markdownTableBodyLeft">eMMC VCCQ = <span class="XML-Token">3.3V</span> </td><td class="markdownTableBodyNone">data field <em>vccq</em> = <span class="XML-Token">1</span> </td></tr>
1345 <tr class="markdownTableRowEven">
1346 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__card__power__ctrls.html#gaaf389e0a139d5808dff8ebb6897d4c7b">ARM_MCI_POWER_VCCQ_1V8</a> </td><td class="markdownTableBodyLeft">eMMC VCCQ = <span class="XML-Token">1.8V</span> </td><td class="markdownTableBodyNone">data field <em>vccq_1v8</em> = <span class="XML-Token">1</span> </td></tr>
1347 <tr class="markdownTableRowOdd">
1348 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__card__power__ctrls.html#ga5304b3b6cadc5113f841c3d526ab5db6">ARM_MCI_POWER_VCCQ_1V2</a> </td><td class="markdownTableBodyLeft">eMMC VCCQ = <span class="XML-Token">1.2V</span> </td><td class="markdownTableBodyNone">data field <em>vccq_1v2</em> = <span class="XML-Token">1</span> </td></tr>
1353 <a id="ga012fca8f1ce5366fce14b708c771c635" name="ga012fca8f1ce5366fce14b708c771c635"></a>
1354 <h2 class="memtitle"><span class="permalink"><a href="#ga012fca8f1ce5366fce14b708c771c635">◆ </a></span>ARM_MCI_ReadCD()</h2>
1356 <div class="memitem">
1357 <div class="memproto">
1358 <table class="memname">
1360 <td class="memname">int32_t ARM_MCI_ReadCD </td>
1362 <td class="paramtype">void </td>
1363 <td class="paramname"></td><td>)</td>
1367 </div><div class="memdoc">
1369 <p>Read Card Detect (CD) state. </p>
1370 <dl class="section return"><dt>Returns</dt><dd>1:card detected, 0:card not detected, or error</dd></dl>
1371 <p>The function <b>ARM_MCI_ReadCD</b> reads the status of the Card Detect (CD) pin. </p>
1375 <a id="ga3d70286918405ac81fa795c7d09dc6fd" name="ga3d70286918405ac81fa795c7d09dc6fd"></a>
1376 <h2 class="memtitle"><span class="permalink"><a href="#ga3d70286918405ac81fa795c7d09dc6fd">◆ </a></span>ARM_MCI_ReadWP()</h2>
1378 <div class="memitem">
1379 <div class="memproto">
1380 <table class="memname">
1382 <td class="memname">int32_t ARM_MCI_ReadWP </td>
1384 <td class="paramtype">void </td>
1385 <td class="paramname"></td><td>)</td>
1389 </div><div class="memdoc">
1391 <p>Read Write Protect (WP) state. </p>
1392 <dl class="section return"><dt>Returns</dt><dd>1:write protected, 0:not write protected, or error</dd></dl>
1393 <p>The function <b>ARM_MCI_ReadWP</b> reads the status of the Write Protect (WP) pin. </p>
1397 <a id="ga5a431da89feabc2b4bc0c27943dff6f2" name="ga5a431da89feabc2b4bc0c27943dff6f2"></a>
1398 <h2 class="memtitle"><span class="permalink"><a href="#ga5a431da89feabc2b4bc0c27943dff6f2">◆ </a></span>ARM_MCI_SendCommand()</h2>
1400 <div class="memitem">
1401 <div class="memproto">
1402 <table class="memname">
1404 <td class="memname">int32_t ARM_MCI_SendCommand </td>
1406 <td class="paramtype">uint32_t </td>
1407 <td class="paramname"><em>cmd</em>, </td>
1410 <td class="paramkey"></td>
1412 <td class="paramtype">uint32_t </td>
1413 <td class="paramname"><em>arg</em>, </td>
1416 <td class="paramkey"></td>
1418 <td class="paramtype">uint32_t </td>
1419 <td class="paramname"><em>flags</em>, </td>
1422 <td class="paramkey"></td>
1424 <td class="paramtype">uint32_t * </td>
1425 <td class="paramname"><em>response</em> </td>
1433 </div><div class="memdoc">
1435 <p>Send Command to card and get the response. </p>
1436 <dl class="params"><dt>Parameters</dt><dd>
1437 <table class="params">
1438 <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>Memory Card command </td></tr>
1439 <tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Command argument </td></tr>
1440 <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Command flags </td></tr>
1441 <tr><td class="paramdir">[out]</td><td class="paramname">response</td><td>Pointer to buffer for response </td></tr>
1445 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1446 <p>The function <b>ARM_MCI_SendCommand</b> </p><ul>
1447 <li>sends commands to the memory card</li>
1448 <li>retrieve the response from the card</li>
1449 <li>optionally, start the data transfer.</li>
1451 <p>The parameter <em>cmd</em> is the command sent to the card. <br />
1452 The parameter <em>arg</em> contains arguments for the command <em>cmd</em>. <br />
1453 The parameter <em>flags</em> controls the behavior of the operation and takes predefined values listed in the table below. <br />
1454 The parameter <em>response</em> is a pointer to receive data.</p>
1455 <p>The parameter <em>flags</em> can have the following values:</p>
1456 <table class="markdownTable">
1457 <tr class="markdownTableHead">
1458 <th class="markdownTableHeadLeft">Parameter <em>flags</em> </th><th class="markdownTableHeadLeft">Description </th></tr>
1459 <tr class="markdownTableRowOdd">
1460 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga70934cef80884e8c75fb4eebf8452118">ARM_MCI_RESPONSE_NONE</a> </td><td class="markdownTableBodyLeft">No response expected (default) </td></tr>
1461 <tr class="markdownTableRowEven">
1462 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#gaa5ddf1cf772b234e3c247039effd0e7b">ARM_MCI_RESPONSE_SHORT</a> </td><td class="markdownTableBodyLeft">Short response (<span class="XML-Token">48</span>-bit) expected </td></tr>
1463 <tr class="markdownTableRowOdd">
1464 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#gaa1d541b0edf32ec05e68d623c727ef9c">ARM_MCI_RESPONSE_SHORT_BUSY</a> </td><td class="markdownTableBodyLeft">Short response with busy signal (<span class="XML-Token">48</span>-bit) expected </td></tr>
1465 <tr class="markdownTableRowEven">
1466 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#gac49c7b39a7c51bd2193e048835bec2fb">ARM_MCI_RESPONSE_LONG</a> </td><td class="markdownTableBodyLeft">Long response (<span class="XML-Token">136</span>-bit) expected </td></tr>
1467 <tr class="markdownTableRowOdd">
1468 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga497abf878c6e12f54cc7ddb92da76c4a">ARM_MCI_RESPONSE_INDEX</a> </td><td class="markdownTableBodyLeft">Check command index in response </td></tr>
1469 <tr class="markdownTableRowEven">
1470 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga6ab3f4c1a2bf0fdb81fbcf7a5698f2de">ARM_MCI_RESPONSE_CRC</a> </td><td class="markdownTableBodyLeft">Check CRC in response </td></tr>
1471 <tr class="markdownTableRowOdd">
1472 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga68e879799bb27a1b13baf57ed19d719d">ARM_MCI_WAIT_BUSY</a> </td><td class="markdownTableBodyLeft">Wait until busy before sending the command </td></tr>
1473 <tr class="markdownTableRowEven">
1474 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga8aa566f69aa74ed416213df6ca3267bd">ARM_MCI_TRANSFER_DATA</a> </td><td class="markdownTableBodyLeft">Activate Data transfer </td></tr>
1475 <tr class="markdownTableRowOdd">
1476 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga81606bd94ce782e2c3764b913f929f60">ARM_MCI_CARD_INITIALIZE</a> </td><td class="markdownTableBodyLeft">Execute Memory Card initialization sequence </td></tr>
1477 <tr class="markdownTableRowEven">
1478 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#gab2bfeedf1dc2df1872ebbcc559a7385a">ARM_MCI_INTERRUPT_COMMAND</a> </td><td class="markdownTableBodyLeft">Send Interrupt command (CMD40 - MMC only) </td></tr>
1479 <tr class="markdownTableRowOdd">
1480 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#gabc31b6b26988998c84c92a9a698fd5dc">ARM_MCI_INTERRUPT_RESPONSE</a> </td><td class="markdownTableBodyLeft">Send Interrupt response (CMD40 - MMC only) </td></tr>
1481 <tr class="markdownTableRowEven">
1482 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#gae04254f51dfd9838583206cae0a5f8f7">ARM_MCI_BOOT_OPERATION</a> </td><td class="markdownTableBodyLeft">Execute Boot operation (MMC only) </td></tr>
1483 <tr class="markdownTableRowOdd">
1484 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga30bd304652d4f870ee7ce61c266a9348">ARM_MCI_BOOT_ALTERNATIVE</a> </td><td class="markdownTableBodyLeft">Execute Alternative Boot operation (MMC only) </td></tr>
1485 <tr class="markdownTableRowEven">
1486 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#ga8c55bc0a310630d49810802ccd1bb10d">ARM_MCI_BOOT_ACK</a> </td><td class="markdownTableBodyLeft">Expect Boot Acknowledge (MMC only) </td></tr>
1487 <tr class="markdownTableRowOdd">
1488 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#gab9df5169b37621764f8bb0f93db5281a">ARM_MCI_CCSD</a> </td><td class="markdownTableBodyLeft">Send Command Completion Signal Disable (CCSD) for CE-ATA device </td></tr>
1489 <tr class="markdownTableRowEven">
1490 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__send__command__flags__ctrls.html#gab82c472e4ca3fca12ae3291e25997f00">ARM_MCI_CCS</a> </td><td class="markdownTableBodyLeft">Expect Command Completion Signal (CCS) for CE-ATA device </td></tr>
1492 <p>Calling the function <b>ARM_MCI_SendCommand</b> only starts the operation. The function is non-blocking and returns as soon as the driver has started the operation. It is not allowed to call this function again until the operation is in progress.</p>
1493 <p>After the command is sent the response is retrieved if specified with <b>ARM_MCI_RESPONSE_xxx</b> flags. When the command completes successfully (requested response is received without errors) the <a class="el" href="group__mci__event__gr.html#gae69356c75d55103d93ef91ac1bc02b49">ARM_MCI_EVENT_COMMAND_COMPLETE</a> event is generated. In case that response is requested but not received the <a class="el" href="group__mci__event__gr.html#gab79b3ab4dcd03c38df1e173fa903d822">ARM_MCI_EVENT_COMMAND_TIMEOUT</a> event is generated instead. In case of invalid response (or CRC error) the <a class="el" href="group__mci__event__gr.html#ga373aeb3eca0e4c6d159312488a130442">ARM_MCI_EVENT_COMMAND_ERROR</a> event is generated instead. Progress of command operation can be monitored by calling the <a class="el" href="group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9">ARM_MCI_GetStatus</a> and checking the <em>command_active</em> flag.</p>
1494 <p>After the command operation the data transfer operation is started if specified with <b>ARM_MCI_TRANSFER_DATA</b> flag. The data transfer needs to be configured before that by calling the <a class="el" href="group__mci__interface__gr.html#gaaec681bcd8e6811c5743e33ee0f35ed1">ARM_MCI_SetupTransfer</a>. When the data transfer completes successfully the <a class="el" href="group__mci__event__gr.html#gabc3c468dedaed890683360f2c5c65bea">ARM_MCI_EVENT_TRANSFER_COMPLETE</a> event is generated. In case that data transfer is not completed in-time (specified by <a class="el" href="group__mci__mode__ctrls.html#ga09a58821e42595f0c2e55f8cc2d32ceb">ARM_MCI_DATA_TIMEOUT</a>) the <a class="el" href="group__mci__event__gr.html#ga614e7c7226adbaa8ec4165bf8b87ef27">ARM_MCI_EVENT_TRANSFER_TIMEOUT</a> event is generated instead. In case of CRC errors the <a class="el" href="group__mci__event__gr.html#ga5d2cee5ba6d0e40ad505983155706c29">ARM_MCI_EVENT_TRANSFER_ERROR</a> event is generated instead. Progress of data transfer operation can be monitored by calling the <a class="el" href="group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9">ARM_MCI_GetStatus</a> and checking the <em>transfer_active</em> flag.</p>
1495 <p><b>See also:</b></p><ul>
1496 <li><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </li>
1501 <a id="gaaec681bcd8e6811c5743e33ee0f35ed1" name="gaaec681bcd8e6811c5743e33ee0f35ed1"></a>
1502 <h2 class="memtitle"><span class="permalink"><a href="#gaaec681bcd8e6811c5743e33ee0f35ed1">◆ </a></span>ARM_MCI_SetupTransfer()</h2>
1504 <div class="memitem">
1505 <div class="memproto">
1506 <table class="memname">
1508 <td class="memname">int32_t ARM_MCI_SetupTransfer </td>
1510 <td class="paramtype">uint8_t * </td>
1511 <td class="paramname"><em>data</em>, </td>
1514 <td class="paramkey"></td>
1516 <td class="paramtype">uint32_t </td>
1517 <td class="paramname"><em>block_count</em>, </td>
1520 <td class="paramkey"></td>
1522 <td class="paramtype">uint32_t </td>
1523 <td class="paramname"><em>block_size</em>, </td>
1526 <td class="paramkey"></td>
1528 <td class="paramtype">uint32_t </td>
1529 <td class="paramname"><em>mode</em> </td>
1537 </div><div class="memdoc">
1539 <p>Setup read or write transfer operation. </p>
1540 <dl class="params"><dt>Parameters</dt><dd>
1541 <table class="params">
1542 <tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>Pointer to data block(s) to be written or read </td></tr>
1543 <tr><td class="paramdir">[in]</td><td class="paramname">block_count</td><td>Number of blocks </td></tr>
1544 <tr><td class="paramdir">[in]</td><td class="paramname">block_size</td><td>Size of a block in bytes </td></tr>
1545 <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>Transfer mode </td></tr>
1549 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1550 <p>The function <b>ARM_MCI_SetupTransfer</b> prepares the data transfer operation that is initiated by calling the function <a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand</a> with the parameter <em>flags</em> = <a class="el" href="group__mci__send__command__flags__ctrls.html#ga8aa566f69aa74ed416213df6ca3267bd">ARM_MCI_TRANSFER_DATA</a>.</p>
1551 <p>The parameter <em>data</em> is a pointer to the data to transfer. <br />
1552 The parameter <em>block_count</em> is the number of blocks to transfer. <br />
1553 The parameter <em>block_size</em> is the size of a block. <br />
1554 The parameter <em>mode</em> sets the transfer mode and can have the values liste in the table below:</p>
1555 <table class="markdownTable">
1556 <tr class="markdownTableHead">
1557 <th class="markdownTableHeadLeft">Transfer Directions </th><th class="markdownTableHeadLeft">Description </th></tr>
1558 <tr class="markdownTableRowOdd">
1559 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__transfer__ctrls.html#gaa6f3be235a9dce5c66be8fe64f399846">ARM_MCI_TRANSFER_READ</a> </td><td class="markdownTableBodyLeft">Read data from MCI </td></tr>
1560 <tr class="markdownTableRowEven">
1561 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__transfer__ctrls.html#gaddc60aab15f75993a99f98f71ddbd50c">ARM_MCI_TRANSFER_WRITE</a> </td><td class="markdownTableBodyLeft">Write data to MCI </td></tr>
1562 <tr class="markdownTableRowOdd">
1563 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__transfer__ctrls.html#ga4ced782e7c0c70d5f0edbddd1e48323b">ARM_MCI_TRANSFER_BLOCK</a> (default) </td><td class="markdownTableBodyLeft">Block Data transfer </td></tr>
1564 <tr class="markdownTableRowEven">
1565 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__transfer__ctrls.html#gac7db0cffd571e60758627d889ba7a432">ARM_MCI_TRANSFER_STREAM</a> </td><td class="markdownTableBodyLeft">Stream Data transfer (MMC only) </td></tr>
1570 <a id="ga3dfcf7b7186b711f9b63a096be816fe5" name="ga3dfcf7b7186b711f9b63a096be816fe5"></a>
1571 <h2 class="memtitle"><span class="permalink"><a href="#ga3dfcf7b7186b711f9b63a096be816fe5">◆ </a></span>ARM_MCI_AbortTransfer()</h2>
1573 <div class="memitem">
1574 <div class="memproto">
1575 <table class="memname">
1577 <td class="memname">int32_t ARM_MCI_AbortTransfer </td>
1579 <td class="paramtype">void </td>
1580 <td class="paramname"></td><td>)</td>
1584 </div><div class="memdoc">
1586 <p>Abort current read/write data transfer. </p>
1587 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1588 <p>The function <b>ARM_MCI_AbortTransfer</b> aborts the active data transfer operation initiated with <a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand</a>. </p>
1592 <a id="gaec0506a2aa4ae75cf6bc02528f36fe30" name="gaec0506a2aa4ae75cf6bc02528f36fe30"></a>
1593 <h2 class="memtitle"><span class="permalink"><a href="#gaec0506a2aa4ae75cf6bc02528f36fe30">◆ </a></span>ARM_MCI_Control()</h2>
1595 <div class="memitem">
1596 <div class="memproto">
1597 <table class="memname">
1599 <td class="memname">int32_t ARM_MCI_Control </td>
1601 <td class="paramtype">uint32_t </td>
1602 <td class="paramname"><em>control</em>, </td>
1605 <td class="paramkey"></td>
1607 <td class="paramtype">uint32_t </td>
1608 <td class="paramname"><em>arg</em> </td>
1616 </div><div class="memdoc">
1618 <p>Control MCI Interface. </p>
1619 <dl class="params"><dt>Parameters</dt><dd>
1620 <table class="params">
1621 <tr><td class="paramdir">[in]</td><td class="paramname">control</td><td>Operation </td></tr>
1622 <tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Argument of operation (optional) </td></tr>
1626 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1627 <p>Th function <b>ARM_MCI_Control</b> controls the MCI interface and executes various operations.</p>
1628 <p>The parameter <em>control</em> specifies the operation. <br />
1629 Values for <em>control</em> cannot be ORed, but must be called separately in the code. <br />
1630 The parameter <em>arg</em> provides, depending on the operation, additional information or sets values.</p>
1631 <dl class="section note"><dt>Note</dt><dd>For parameters, the values marked with (default) are the setting after the driver initialization.</dd></dl>
1632 <p>The table lists values for the parameter <em>control</em>.</p>
1633 <table class="markdownTable">
1634 <tr class="markdownTableHead">
1635 <th class="markdownTableHeadLeft">Parameter <em>control</em> </th><th class="markdownTableHeadLeft">Operation </th></tr>
1636 <tr class="markdownTableRowOdd">
1637 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#ga7f982d2e5aec768307d35a83c65fb3ef">ARM_MCI_BUS_SPEED</a> </td><td class="markdownTableBodyLeft">Set the Bus Speed. The parameter <em>arg</em> specifies the speed in bits/s; The function returns the bus speed configured in bits/s. </td></tr>
1638 <tr class="markdownTableRowEven">
1639 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#gaf7ede525eabc618fbbb9f7a294c8ed96">ARM_MCI_BUS_SPEED_MODE</a> </td><td class="markdownTableBodyLeft">Set the Bus Speed Mode. Predefined values for <em>arg</em> are listed in the table <b>Bus Speed Mode</b>. </td></tr>
1640 <tr class="markdownTableRowOdd">
1641 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#ga8b7571e37520c07d8ef4f697f3886715">ARM_MCI_BUS_CMD_MODE</a> </td><td class="markdownTableBodyLeft">Set the CMD Line Mode. Predefined values for <em>arg</em> are listed in the table <b>Bus CMD Line Mode</b>. </td></tr>
1642 <tr class="markdownTableRowEven">
1643 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#ga876d964d0eeacdb16e93f7558a544587">ARM_MCI_BUS_DATA_WIDTH</a> </td><td class="markdownTableBodyLeft">Set data bus width. Predefined values for <em>arg</em> are encoded in <b>Bus Data Width</b>. </td></tr>
1644 <tr class="markdownTableRowOdd">
1645 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#ga78068f519139f2ae7b09e0608070aaf6">ARM_MCI_DRIVER_STRENGTH</a> </td><td class="markdownTableBodyLeft">Set driver strength. Predefined values for <em>arg</em> are listed in the table <b>Driver Type</b> </td></tr>
1646 <tr class="markdownTableRowEven">
1647 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#ga21e403e8c3fa8cc75431a513813f0a16">ARM_MCI_CONTROL_RESET</a> </td><td class="markdownTableBodyLeft">Control optional RST_n Pin (eMMC). The parameter <em>arg</em> can have the values <span class="XML-Token">[0:inactive(default); 1:active]</span> </td></tr>
1648 <tr class="markdownTableRowOdd">
1649 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#ga889473fbfbdcb89aab4d53cc8a13f615">ARM_MCI_CONTROL_CLOCK_IDLE</a> </td><td class="markdownTableBodyLeft">Control clock generation on CLK Pin when idle. The parameter <em>arg</em> can have the values <span class="XML-Token">[0:disabled; 1:enabled]</span> </td></tr>
1650 <tr class="markdownTableRowEven">
1651 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#ga98853f60bdc085aeeccd66f7bdf22d3d">ARM_MCI_UHS_TUNING_OPERATION</a> </td><td class="markdownTableBodyLeft">Sampling clock Tuning operation (SD UHS-I). The parameter <em>arg</em> can have the values <span class="XML-Token">[0:reset; 1:execute]</span> </td></tr>
1652 <tr class="markdownTableRowOdd">
1653 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#gabd3af448e26da5657c1c5a03330476b7">ARM_MCI_UHS_TUNING_RESULT</a> </td><td class="markdownTableBodyLeft">Sampling clock Tuning result (SD UHS-I). Returns <span class="XML-Token">[0:done; 1:in progress; -1:error]</span> </td></tr>
1654 <tr class="markdownTableRowEven">
1655 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#ga09a58821e42595f0c2e55f8cc2d32ceb">ARM_MCI_DATA_TIMEOUT</a> </td><td class="markdownTableBodyLeft">Set Data timeout; The parameter <em>arg</em> sets the timeout in bus cycles. </td></tr>
1656 <tr class="markdownTableRowOdd">
1657 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#gae97b1a819a5d326b1f1009b0d6d48b5a">ARM_MCI_CSS_TIMEOUT</a> </td><td class="markdownTableBodyLeft">Set Command Completion Signal (CCS) timeout. The parameter <em>arg</em> sets timeout in bus cycles. </td></tr>
1658 <tr class="markdownTableRowEven">
1659 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#ga19fd7d3b74ac48ca74a2e138b3ee9963">ARM_MCI_MONITOR_SDIO_INTERRUPT</a> </td><td class="markdownTableBodyLeft">Monitor SD I/O interrupt. The parameter <em>arg</em> can have the values <span class="XML-Token">[0:disabled(default); 1:enabled]</span>. Monitoring is automatically disabled when an interrupt is recognized. </td></tr>
1660 <tr class="markdownTableRowOdd">
1661 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#gaaa10c5aa7a8108aa59c3734b3eec2e3a">ARM_MCI_CONTROL_READ_WAIT</a> </td><td class="markdownTableBodyLeft">Control Read/Wait states for SD I/O. The parameter <em>arg</em> can have the values <span class="XML-Token">[0:disabled(default); 1:enabled]</span>. </td></tr>
1662 <tr class="markdownTableRowEven">
1663 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#ga04cf174b0ef13240f26225bf8e45a4a0">ARM_MCI_SUSPEND_TRANSFER</a> </td><td class="markdownTableBodyLeft">Suspend Data transfer (SD I/O). Returns the number of remaining bytes to transfer. </td></tr>
1664 <tr class="markdownTableRowOdd">
1665 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__mode__ctrls.html#gac4907319499072fddf61f2f83b0dd966">ARM_MCI_RESUME_TRANSFER</a> </td><td class="markdownTableBodyLeft">Resume Data transfer (SD I/O). </td></tr>
1667 <p><b>Bus Speed Mode</b></p>
1668 <p>The function <a class="el" href="group__mci__interface__gr.html#ga7e5a78b6e6409189833a0b72a0a3c48a">ARM_MCI_GetCapabilities</a> lists the supported bus speed modes. Initially, all SD cards use a 3.3 volt electrical interface. Some SD cards can switch to 1.8 volt operation. For example, the use of ultra-high-speed (UHS) SD cards requires 1.8 volt operation and a 4-bit bus data width. The bit field <a class="el" href="group__mci__interface__gr.html#a084188480d589cdc8d3e164b9f41bea9" title="Supports SD UHS-I (Ultra High Speed) 1.8V signaling.">ARM_MCI_CAPABILITIES.uhs_signaling</a> encodes whether the driver supports 1.8 volt UHS signaling.</p>
1669 <p>The <em>control</em> operation <b>ARM_MCI_BUS_SPEED_MODE</b> sets the bus speed mode using the parameter <em>arg</em>.</p>
1670 <table class="markdownTable">
1671 <tr class="markdownTableHead">
1672 <th class="markdownTableHeadLeft">Parameter <em>arg</em> </th><th class="markdownTableHeadLeft">Bus Speed Mode </th></tr>
1673 <tr class="markdownTableRowOdd">
1674 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__bus__speed__ctrls.html#ga601fa8b27ab2e5f6d90c93d54c8f412d">ARM_MCI_BUS_DEFAULT_SPEED</a> (default) </td><td class="markdownTableBodyLeft">Set the bus speed for SD/MMC cards: Default Speed mode up to <span class="XML-Token">[25;26]MHz</span> </td></tr>
1675 <tr class="markdownTableRowEven">
1676 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__bus__speed__ctrls.html#gaabda746ac7d6b4497358ff655a8ea6be">ARM_MCI_BUS_HIGH_SPEED</a> </td><td class="markdownTableBodyLeft">Set the bus speed for SD/MMC: High Speed mode up to <span class="XML-Token">[50;52]MHz</span> </td></tr>
1677 <tr class="markdownTableRowOdd">
1678 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__bus__speed__ctrls.html#ga0473c44a7b65044b3c6a8e7012009a4a">ARM_MCI_BUS_UHS_SDR12</a> </td><td class="markdownTableBodyLeft">Set the bus speed for SD: SDR12 (Single Data Rate) up to <span class="XML-Token">25MHz, 12.5MB/s: UHS-I (Ultra High Speed) 1.8V signalling</span> </td></tr>
1679 <tr class="markdownTableRowEven">
1680 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__bus__speed__ctrls.html#gae32422631052307b3c4d269b25415907">ARM_MCI_BUS_UHS_SDR25</a> </td><td class="markdownTableBodyLeft">Set the bus speed for SD: SDR25 (Single Data Rate) up to <span class="XML-Token">50MHz, 25 MB/s: UHS-I (Ultra High Speed) 1.8V signalling</span> </td></tr>
1681 <tr class="markdownTableRowOdd">
1682 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__bus__speed__ctrls.html#ga9f326c02391d965918ae619b912b81e7">ARM_MCI_BUS_UHS_SDR50</a> </td><td class="markdownTableBodyLeft">Set the bus speed for SD: SDR50 (Single Data Rate) up to <span class="XML-Token">100MHz, 50 MB/s: UHS-I (Ultra High Speed) 1.8V signalling</span> </td></tr>
1683 <tr class="markdownTableRowEven">
1684 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__bus__speed__ctrls.html#gad2bab563e7bbb4bcf6bdabe6a13dadf4">ARM_MCI_BUS_UHS_SDR104</a> </td><td class="markdownTableBodyLeft">Set the bus speed for SD: SDR104 (Single Data Rate) up to <span class="XML-Token">208MHz, 104 MB/s: UHS-I (Ultra High Speed) 1.8V signalling</span> </td></tr>
1685 <tr class="markdownTableRowOdd">
1686 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__bus__speed__ctrls.html#ga04da920a5cac99eab9784527057f1b9c">ARM_MCI_BUS_UHS_DDR50</a> </td><td class="markdownTableBodyLeft">Set the bus speed for SD: DDR50 (Dual Data Rate) up to <span class="XML-Token">50MHz, 50 MB/s: UHS-I (Ultra High Speed) 1.8V signalling</span> </td></tr>
1688 <p><b>Bus CMD Line Mode</b></p>
1689 <p>The <em>control</em> operation <b>ARM_MCI_BUS_CMD_MODE</b> sets the bus command line mode using the parameter <em>arg</em>.</p>
1690 <table class="markdownTable">
1691 <tr class="markdownTableHead">
1692 <th class="markdownTableHeadLeft">Parameter <em>arg</em> </th><th class="markdownTableHeadLeft">Bus CMD Line Mode </th></tr>
1693 <tr class="markdownTableRowOdd">
1694 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__cmd__line__ctrls.html#gaaed404312d9bc073e3489779a911c7dc">ARM_MCI_BUS_CMD_PUSH_PULL</a> (default) </td><td class="markdownTableBodyLeft">Set the Push-Pull CMD line </td></tr>
1695 <tr class="markdownTableRowEven">
1696 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__cmd__line__ctrls.html#gaadf8667985731964d57d1ed672e90fd3">ARM_MCI_BUS_CMD_OPEN_DRAIN</a> </td><td class="markdownTableBodyLeft">Set the Open Drain CMD line (MMC only) </td></tr>
1698 <p><b>Bus Data Width</b></p>
1699 <p>Specifies the bus data width (the number of data I/O pins on the SD/MMC interface).</p>
1700 <p>For high speed memory cards, a 4-bit bus data width should be used (or 8-bit for eMMC). The bit fields <a class="el" href="group__mci__interface__gr.html#a950669a8c88b49c8da4c56163b45a79d" title="Supports 4-bit data.">ARM_MCI_CAPABILITIES.data_width_4</a> and <a class="el" href="group__mci__interface__gr.html#a808703d6c70a501464e156e55f5cabd2" title="Supports 8-bit data.">ARM_MCI_CAPABILITIES.data_width_8</a> encode whether the driver supports a specific bus data with.</p>
1701 <p>The <em>control</em> operation <b>ARM_MCI_BUS_DATA_WIDTH</b> sets the bus data width using the parameter <em>arg</em>.</p>
1702 <table class="markdownTable">
1703 <tr class="markdownTableHead">
1704 <th class="markdownTableHeadLeft">Parameter <em>arg</em> </th><th class="markdownTableHeadLeft">Bus Data Width </th></tr>
1705 <tr class="markdownTableRowOdd">
1706 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__bus__data__width__ctrls.html#gaa09a00d810a4dfd1d1824311ee290585">ARM_MCI_BUS_DATA_WIDTH_1</a> (default) </td><td class="markdownTableBodyLeft">Set the Bus data width to <span class="XML-Token">1 bit</span> </td></tr>
1707 <tr class="markdownTableRowEven">
1708 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__bus__data__width__ctrls.html#gaa28150d8c3789e8cf1bcda318f74a28c">ARM_MCI_BUS_DATA_WIDTH_4</a> </td><td class="markdownTableBodyLeft">Set the Bus data width to <span class="XML-Token">4 bits</span> </td></tr>
1709 <tr class="markdownTableRowOdd">
1710 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__bus__data__width__ctrls.html#ga3bb99a2d98ba9fb8c5bc97fa2b8ef469">ARM_MCI_BUS_DATA_WIDTH_8</a> </td><td class="markdownTableBodyLeft">Set the Bus data width to <span class="XML-Token">8 bits</span> </td></tr>
1711 <tr class="markdownTableRowEven">
1712 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__bus__data__width__ctrls.html#gaccb174bd131f8fd8cd9a56439a8ebb60">ARM_MCI_BUS_DATA_WIDTH_4_DDR</a> </td><td class="markdownTableBodyLeft">Set the Bus data width to <span class="XML-Token">4 bits</span>, DDR (Dual Data Rate) - MMC only </td></tr>
1713 <tr class="markdownTableRowOdd">
1714 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__bus__data__width__ctrls.html#ga7b31f81ae703229095fe9efcfbe80b47">ARM_MCI_BUS_DATA_WIDTH_8_DDR</a> </td><td class="markdownTableBodyLeft">Set the Bus data width to <span class="XML-Token">8 bits</span>, DDR (Dual Data Rate) - MMC only </td></tr>
1716 <p><b>Driver Type</b></p>
1717 <p>Specifies the interface driver type.</p>
1718 <p>The <em>control</em> operation <b>ARM_MCI_DRIVER_STRENGTH</b> sets the interface driver type using the parameter <em>arg</em>.</p>
1719 <table class="markdownTable">
1720 <tr class="markdownTableHead">
1721 <th class="markdownTableHeadLeft">Parameter <em>arg</em> </th><th class="markdownTableHeadLeft">Driver Type </th></tr>
1722 <tr class="markdownTableRowOdd">
1723 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__driver__strength__ctrls.html#ga64eb1c4847711a262f084c361b60a912">ARM_MCI_DRIVER_TYPE_A</a> </td><td class="markdownTableBodyLeft">Set the interface to SD UHS-I Driver Type A </td></tr>
1724 <tr class="markdownTableRowEven">
1725 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__driver__strength__ctrls.html#ga078d3c3bc7c9335b92e6445a0abafc46">ARM_MCI_DRIVER_TYPE_B</a> (default) </td><td class="markdownTableBodyLeft">Set the interface to SD UHS-I Driver Type B </td></tr>
1726 <tr class="markdownTableRowOdd">
1727 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__driver__strength__ctrls.html#ga3da11696d1fcd3930eb7e70fe097d747">ARM_MCI_DRIVER_TYPE_C</a> </td><td class="markdownTableBodyLeft">Set the interface to SD UHS-I Driver Type C </td></tr>
1728 <tr class="markdownTableRowEven">
1729 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__driver__strength__ctrls.html#ga8185f82b1d8857a3f0eb461d664f2b3d">ARM_MCI_DRIVER_TYPE_D</a> </td><td class="markdownTableBodyLeft">Set the interface to SD UHS-I Driver Type D </td></tr>
1731 <p><b>Examples:</b> </p><div class="fragment"><div class="line"><span class="comment">// Set Bus Speed to 25MHz</span></div>
1732 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#ga7f982d2e5aec768307d35a83c65fb3ef">ARM_MCI_BUS_SPEED</a>, 25000000);</div>
1733 <div class="line"> </div>
1734 <div class="line"><span class="comment">// Set High Speed mode</span></div>
1735 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#gaf7ede525eabc618fbbb9f7a294c8ed96">ARM_MCI_BUS_SPEED_MODE</a>, <a class="code hl_define" href="group__mci__bus__speed__ctrls.html#gaabda746ac7d6b4497358ff655a8ea6be">ARM_MCI_BUS_HIGH_SPEED</a>);</div>
1736 <div class="line"> </div>
1737 <div class="line"><span class="comment">// Configure CMD line as Open Drain (MMC only)</span></div>
1738 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#ga8b7571e37520c07d8ef4f697f3886715">ARM_MCI_BUS_CMD_MODE</a>, <a class="code hl_define" href="group__mci__cmd__line__ctrls.html#gaadf8667985731964d57d1ed672e90fd3">ARM_MCI_BUS_CMD_OPEN_DRAIN</a>);</div>
1739 <div class="line"> </div>
1740 <div class="line"><span class="comment">// Set Bus Data Width = 4bits</span></div>
1741 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#ga876d964d0eeacdb16e93f7558a544587">ARM_MCI_BUS_DATA_WIDTH</a>, <a class="code hl_define" href="group__mci__bus__data__width__ctrls.html#gaa28150d8c3789e8cf1bcda318f74a28c">ARM_MCI_BUS_DATA_WIDTH_4</a>);</div>
1742 <div class="line"> </div>
1743 <div class="line"><span class="comment">// Set SD UHS-I Driver Type B</span></div>
1744 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#ga78068f519139f2ae7b09e0608070aaf6">ARM_MCI_DRIVER_STRENGTH</a>, <a class="code hl_define" href="group__mci__driver__strength__ctrls.html#ga078d3c3bc7c9335b92e6445a0abafc46">ARM_MCI_DRIVER_TYPE_B</a>);</div>
1745 <div class="line"> </div>
1746 <div class="line"><span class="comment">// RTS_n Pin is not active by default</span></div>
1747 <div class="line"><span class="comment">// Assert RTS_n Pin (eMMC)</span></div>
1748 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#ga21e403e8c3fa8cc75431a513813f0a16">ARM_MCI_CONTROL_RESET</a>, 1);</div>
1749 <div class="line"><span class="comment">// De-assert RTS_n Pin (eMMC)</span></div>
1750 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#ga21e403e8c3fa8cc75431a513813f0a16">ARM_MCI_CONTROL_RESET</a>, 0);</div>
1751 <div class="line"> </div>
1752 <div class="line"><span class="comment">// Clock generation on CLK when Idle: hardware specific default behavior</span></div>
1753 <div class="line"><span class="comment">// Enable Clock generation on CLK when Idle</span></div>
1754 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#ga889473fbfbdcb89aab4d53cc8a13f615">ARM_MCI_CONTROL_CLOCK_IDLE</a>, 1);</div>
1755 <div class="line"><span class="comment">// Disable Clock generation on CLK when Idle</span></div>
1756 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#ga889473fbfbdcb89aab4d53cc8a13f615">ARM_MCI_CONTROL_CLOCK_IDLE</a>, 0);</div>
1757 <div class="line"> </div>
1758 <div class="line"><span class="comment">// UHS Tuning</span></div>
1759 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#ga98853f60bdc085aeeccd66f7bdf22d3d">ARM_MCI_UHS_TUNING_OPERATION</a>, 1); <span class="comment">// start tuning</span></div>
1760 <div class="line"><span class="keywordflow">do</span> {</div>
1761 <div class="line"> status = MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#gabd3af448e26da5657c1c5a03330476b7">ARM_MCI_UHS_TUNING_RESULT</a>, 0<span class="comment">/*argument not used*/</span>);</div>
1762 <div class="line"> <span class="keywordflow">if</span> (status == -1) { <span class="keywordflow">break</span>; <span class="comment">/* tuning failed */</span> }</div>
1763 <div class="line">} <span class="keywordflow">while</span> (status == 1);</div>
1764 <div class="line"> </div>
1765 <div class="line"><span class="comment">// Set Data Timeout to 12500000 bus cycles (0.5s @25MHz Bus Speed)</span></div>
1766 <div class="line"><span class="comment">// Default value is hardware specific (typically 2^32-1)</span></div>
1767 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#ga09a58821e42595f0c2e55f8cc2d32ceb">ARM_MCI_DATA_TIMEOUT</a>, 12500000);</div>
1768 <div class="line"> </div>
1769 <div class="line"><span class="comment">// Set CSS Timeout to 1000000 bus cycles</span></div>
1770 <div class="line"><span class="comment">// Default value is hardware specific</span></div>
1771 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#gae97b1a819a5d326b1f1009b0d6d48b5a">ARM_MCI_CSS_TIMEOUT</a>, 1000000);</div>
1772 <div class="line"> </div>
1773 <div class="line"><span class="comment">// SD I/O Interrupt Monitoring is disabled by default</span></div>
1774 <div class="line"><span class="comment">// Enable SD I/O Interrupt Monitoring</span></div>
1775 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#ga19fd7d3b74ac48ca74a2e138b3ee9963">ARM_MCI_MONITOR_SDIO_INTERRUPT</a>, 1);</div>
1776 <div class="line"><span class="comment">// Disable SD I/O Interrupt Monitoring</span></div>
1777 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#ga19fd7d3b74ac48ca74a2e138b3ee9963">ARM_MCI_MONITOR_SDIO_INTERRUPT</a>, 0);</div>
1778 <div class="line"> </div>
1779 <div class="line"><span class="comment">// Read/Wait for SD I/O is disabled by default</span></div>
1780 <div class="line"><span class="comment">// Enable Read/Wait for SD I/O</span></div>
1781 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#gaaa10c5aa7a8108aa59c3734b3eec2e3a">ARM_MCI_CONTROL_READ_WAIT</a>, 1);</div>
1782 <div class="line"><span class="comment">// Disable Read/Wait for SD I/O</span></div>
1783 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#gaaa10c5aa7a8108aa59c3734b3eec2e3a">ARM_MCI_CONTROL_READ_WAIT</a>, 0);</div>
1784 <div class="line"> </div>
1785 <div class="line"><span class="comment">// Suspend Data transfer (SD I/O)</span></div>
1786 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#ga04cf174b0ef13240f26225bf8e45a4a0">ARM_MCI_SUSPEND_TRANSFER</a>, 0<span class="comment">/*argument not used*/</span>);</div>
1787 <div class="line"> </div>
1788 <div class="line"><span class="comment">// Resume Data transfer (SD I/O)</span></div>
1789 <div class="line">MCIdrv->Control(<a class="code hl_define" href="group__mci__mode__ctrls.html#gac4907319499072fddf61f2f83b0dd966">ARM_MCI_RESUME_TRANSFER</a>, 0<span class="comment">/*argument not used*/</span>);</div>
1790 <div class="ttc" id="agroup__mci__bus__data__width__ctrls_html_gaa28150d8c3789e8cf1bcda318f74a28c"><div class="ttname"><a href="group__mci__bus__data__width__ctrls.html#gaa28150d8c3789e8cf1bcda318f74a28c">ARM_MCI_BUS_DATA_WIDTH_4</a></div><div class="ttdeci">#define ARM_MCI_BUS_DATA_WIDTH_4</div><div class="ttdoc">Bus data width: 4 bits.</div></div>
1791 <div class="ttc" id="agroup__mci__bus__speed__ctrls_html_gaabda746ac7d6b4497358ff655a8ea6be"><div class="ttname"><a href="group__mci__bus__speed__ctrls.html#gaabda746ac7d6b4497358ff655a8ea6be">ARM_MCI_BUS_HIGH_SPEED</a></div><div class="ttdeci">#define ARM_MCI_BUS_HIGH_SPEED</div><div class="ttdoc">SD/MMC: High Speed mode up to 50/52MHz.</div></div>
1792 <div class="ttc" id="agroup__mci__cmd__line__ctrls_html_gaadf8667985731964d57d1ed672e90fd3"><div class="ttname"><a href="group__mci__cmd__line__ctrls.html#gaadf8667985731964d57d1ed672e90fd3">ARM_MCI_BUS_CMD_OPEN_DRAIN</a></div><div class="ttdeci">#define ARM_MCI_BUS_CMD_OPEN_DRAIN</div><div class="ttdoc">Open Drain CMD line (MMC only)</div></div>
1793 <div class="ttc" id="agroup__mci__driver__strength__ctrls_html_ga078d3c3bc7c9335b92e6445a0abafc46"><div class="ttname"><a href="group__mci__driver__strength__ctrls.html#ga078d3c3bc7c9335b92e6445a0abafc46">ARM_MCI_DRIVER_TYPE_B</a></div><div class="ttdeci">#define ARM_MCI_DRIVER_TYPE_B</div><div class="ttdoc">SD UHS-I Driver Type B (default)</div></div>
1794 <div class="ttc" id="agroup__mci__mode__ctrls_html_ga04cf174b0ef13240f26225bf8e45a4a0"><div class="ttname"><a href="group__mci__mode__ctrls.html#ga04cf174b0ef13240f26225bf8e45a4a0">ARM_MCI_SUSPEND_TRANSFER</a></div><div class="ttdeci">#define ARM_MCI_SUSPEND_TRANSFER</div><div class="ttdoc">Suspend Data transfer (SD I/O); returns number of remaining bytes to transfer.</div></div>
1795 <div class="ttc" id="agroup__mci__mode__ctrls_html_ga09a58821e42595f0c2e55f8cc2d32ceb"><div class="ttname"><a href="group__mci__mode__ctrls.html#ga09a58821e42595f0c2e55f8cc2d32ceb">ARM_MCI_DATA_TIMEOUT</a></div><div class="ttdeci">#define ARM_MCI_DATA_TIMEOUT</div><div class="ttdoc">Set Data timeout; arg = timeout in bus cycles.</div></div>
1796 <div class="ttc" id="agroup__mci__mode__ctrls_html_ga19fd7d3b74ac48ca74a2e138b3ee9963"><div class="ttname"><a href="group__mci__mode__ctrls.html#ga19fd7d3b74ac48ca74a2e138b3ee9963">ARM_MCI_MONITOR_SDIO_INTERRUPT</a></div><div class="ttdeci">#define ARM_MCI_MONITOR_SDIO_INTERRUPT</div><div class="ttdoc">Monitor SD I/O interrupt: arg: 0=disabled, 1=enabled.</div></div>
1797 <div class="ttc" id="agroup__mci__mode__ctrls_html_ga21e403e8c3fa8cc75431a513813f0a16"><div class="ttname"><a href="group__mci__mode__ctrls.html#ga21e403e8c3fa8cc75431a513813f0a16">ARM_MCI_CONTROL_RESET</a></div><div class="ttdeci">#define ARM_MCI_CONTROL_RESET</div><div class="ttdoc">Control optional RST_n Pin (eMMC); arg: 0=inactive, 1=active.</div></div>
1798 <div class="ttc" id="agroup__mci__mode__ctrls_html_ga78068f519139f2ae7b09e0608070aaf6"><div class="ttname"><a href="group__mci__mode__ctrls.html#ga78068f519139f2ae7b09e0608070aaf6">ARM_MCI_DRIVER_STRENGTH</a></div><div class="ttdeci">#define ARM_MCI_DRIVER_STRENGTH</div><div class="ttdoc">Set SD UHS-I Driver Strength as specified with arg.</div></div>
1799 <div class="ttc" id="agroup__mci__mode__ctrls_html_ga7f982d2e5aec768307d35a83c65fb3ef"><div class="ttname"><a href="group__mci__mode__ctrls.html#ga7f982d2e5aec768307d35a83c65fb3ef">ARM_MCI_BUS_SPEED</a></div><div class="ttdeci">#define ARM_MCI_BUS_SPEED</div><div class="ttdoc">Set Bus Speed; arg = requested speed in bits/s; returns configured speed in bits/s.</div></div>
1800 <div class="ttc" id="agroup__mci__mode__ctrls_html_ga876d964d0eeacdb16e93f7558a544587"><div class="ttname"><a href="group__mci__mode__ctrls.html#ga876d964d0eeacdb16e93f7558a544587">ARM_MCI_BUS_DATA_WIDTH</a></div><div class="ttdeci">#define ARM_MCI_BUS_DATA_WIDTH</div><div class="ttdoc">Set Bus Data Width as specified with arg.</div></div>
1801 <div class="ttc" id="agroup__mci__mode__ctrls_html_ga889473fbfbdcb89aab4d53cc8a13f615"><div class="ttname"><a href="group__mci__mode__ctrls.html#ga889473fbfbdcb89aab4d53cc8a13f615">ARM_MCI_CONTROL_CLOCK_IDLE</a></div><div class="ttdeci">#define ARM_MCI_CONTROL_CLOCK_IDLE</div><div class="ttdoc">Control Clock generation on CLK Pin when idle; arg: 0=disabled, 1=enabled.</div></div>
1802 <div class="ttc" id="agroup__mci__mode__ctrls_html_ga8b7571e37520c07d8ef4f697f3886715"><div class="ttname"><a href="group__mci__mode__ctrls.html#ga8b7571e37520c07d8ef4f697f3886715">ARM_MCI_BUS_CMD_MODE</a></div><div class="ttdeci">#define ARM_MCI_BUS_CMD_MODE</div><div class="ttdoc">Set CMD Line Mode as specified with arg.</div></div>
1803 <div class="ttc" id="agroup__mci__mode__ctrls_html_ga98853f60bdc085aeeccd66f7bdf22d3d"><div class="ttname"><a href="group__mci__mode__ctrls.html#ga98853f60bdc085aeeccd66f7bdf22d3d">ARM_MCI_UHS_TUNING_OPERATION</a></div><div class="ttdeci">#define ARM_MCI_UHS_TUNING_OPERATION</div><div class="ttdoc">Sampling clock Tuning operation (SD UHS-I); arg: 0=reset, 1=execute.</div></div>
1804 <div class="ttc" id="agroup__mci__mode__ctrls_html_gaaa10c5aa7a8108aa59c3734b3eec2e3a"><div class="ttname"><a href="group__mci__mode__ctrls.html#gaaa10c5aa7a8108aa59c3734b3eec2e3a">ARM_MCI_CONTROL_READ_WAIT</a></div><div class="ttdeci">#define ARM_MCI_CONTROL_READ_WAIT</div><div class="ttdoc">Control Read/Wait for SD I/O; arg: 0=disabled, 1=enabled.</div></div>
1805 <div class="ttc" id="agroup__mci__mode__ctrls_html_gabd3af448e26da5657c1c5a03330476b7"><div class="ttname"><a href="group__mci__mode__ctrls.html#gabd3af448e26da5657c1c5a03330476b7">ARM_MCI_UHS_TUNING_RESULT</a></div><div class="ttdeci">#define ARM_MCI_UHS_TUNING_RESULT</div><div class="ttdoc">Sampling clock Tuning result (SD UHS-I); returns: 0=done, 1=in progress, -1=error.</div></div>
1806 <div class="ttc" id="agroup__mci__mode__ctrls_html_gac4907319499072fddf61f2f83b0dd966"><div class="ttname"><a href="group__mci__mode__ctrls.html#gac4907319499072fddf61f2f83b0dd966">ARM_MCI_RESUME_TRANSFER</a></div><div class="ttdeci">#define ARM_MCI_RESUME_TRANSFER</div><div class="ttdoc">Resume Data transfer (SD I/O)</div></div>
1807 <div class="ttc" id="agroup__mci__mode__ctrls_html_gae97b1a819a5d326b1f1009b0d6d48b5a"><div class="ttname"><a href="group__mci__mode__ctrls.html#gae97b1a819a5d326b1f1009b0d6d48b5a">ARM_MCI_CSS_TIMEOUT</a></div><div class="ttdeci">#define ARM_MCI_CSS_TIMEOUT</div><div class="ttdoc">Set Command Completion Signal (CCS) timeout; arg = timeout in bus cycles.</div></div>
1808 <div class="ttc" id="agroup__mci__mode__ctrls_html_gaf7ede525eabc618fbbb9f7a294c8ed96"><div class="ttname"><a href="group__mci__mode__ctrls.html#gaf7ede525eabc618fbbb9f7a294c8ed96">ARM_MCI_BUS_SPEED_MODE</a></div><div class="ttdeci">#define ARM_MCI_BUS_SPEED_MODE</div><div class="ttdoc">Set Bus Speed Mode as specified with arg.</div></div>
1809 </div><!-- fragment -->
1812 <a id="ga8d61aa42ce78d1864fa928c1f273cbd9" name="ga8d61aa42ce78d1864fa928c1f273cbd9"></a>
1813 <h2 class="memtitle"><span class="permalink"><a href="#ga8d61aa42ce78d1864fa928c1f273cbd9">◆ </a></span>ARM_MCI_GetStatus()</h2>
1815 <div class="memitem">
1816 <div class="memproto">
1817 <table class="memname">
1819 <td class="memname"><a class="el" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a> ARM_MCI_GetStatus </td>
1821 <td class="paramtype">void </td>
1822 <td class="paramname"></td><td>)</td>
1826 </div><div class="memdoc">
1828 <p>Get MCI status. </p>
1829 <dl class="section return"><dt>Returns</dt><dd>MCI status <a class="el" href="group__mci__interface__gr.html#structARM__MCI__STATUS">ARM_MCI_STATUS</a></dd></dl>
1830 <p>The function <b>ARM_MCI_GetStatus</b> returns the current MCI interface status. </p>
1834 <a id="gaac2dbd1c1a98436938c5d0d6248cb700" name="gaac2dbd1c1a98436938c5d0d6248cb700"></a>
1835 <h2 class="memtitle"><span class="permalink"><a href="#gaac2dbd1c1a98436938c5d0d6248cb700">◆ </a></span>ARM_MCI_SignalEvent()</h2>
1837 <div class="memitem">
1838 <div class="memproto">
1839 <table class="memname">
1841 <td class="memname">void ARM_MCI_SignalEvent </td>
1843 <td class="paramtype">uint32_t </td>
1844 <td class="paramname"><em>event</em></td><td>)</td>
1848 </div><div class="memdoc">
1850 <p>Callback function that signals a MCI Card Event. </p>
1851 <dl class="params"><dt>Parameters</dt><dd>
1852 <table class="params">
1853 <tr><td class="paramdir">[in]</td><td class="paramname">event</td><td><a class="el" href="group__mci__event__gr.html">MCI Events</a> </td></tr>
1857 <dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
1858 <p>The function <b>ARM_MCI_SignalEvent</b> is a callback function registered by the function <a class="el" href="group__mci__interface__gr.html#ga6f34d4ab362e596ddaf23aac093268cf">ARM_MCI_Initialize</a>.</p>
1859 <p>The parameter <em>event</em> indicates one or more events that occurred during driver operation. Each event is encoded in a separate bit and therefore it is possible to signal multiple events within the same call.</p>
1860 <p>Not every event is necessarily generated by the driver. This depends on the implemented capabilities stored in the data fields of the structure <a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a>, which can be retrieved with the function <a class="el" href="group__nand__interface__gr.html#ga9f2609975c2008d21b9ae28f15daf147">ARM_NAND_GetCapabilities</a>.</p>
1861 <p>The following events can be generated:</p>
1862 <table class="markdownTable">
1863 <tr class="markdownTableHead">
1864 <th class="markdownTableHeadLeft">Parameter <em>event</em> </th><th class="markdownTableHeadRight">Bit </th><th class="markdownTableHeadLeft">Description </th><th class="markdownTableHeadLeft">supported when <a class="el" href="group__nand__interface__gr.html#structARM__NAND__CAPABILITIES">ARM_NAND_CAPABILITIES</a> </th></tr>
1865 <tr class="markdownTableRowOdd">
1866 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__event__gr.html#gae2cf8ef238c092e94e96a01602f3a23c">ARM_MCI_EVENT_CARD_INSERTED</a> </td><td class="markdownTableBodyRight">0 </td><td class="markdownTableBodyLeft">Occurs after Memory Card inserted </td><td class="markdownTableBodyLeft"><em>always supported</em> </td></tr>
1867 <tr class="markdownTableRowEven">
1868 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__event__gr.html#ga92ba748f9324ec13898f10456f17c8cc">ARM_MCI_EVENT_CARD_REMOVED</a> </td><td class="markdownTableBodyRight">1 </td><td class="markdownTableBodyLeft">Occurs after Memory Card removal </td><td class="markdownTableBodyLeft"><em>always supported</em> </td></tr>
1869 <tr class="markdownTableRowOdd">
1870 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__event__gr.html#gae69356c75d55103d93ef91ac1bc02b49">ARM_MCI_EVENT_COMMAND_COMPLETE</a> </td><td class="markdownTableBodyRight">2 </td><td class="markdownTableBodyLeft">Occurs after command completed successfully </td><td class="markdownTableBodyLeft"><em>always supported</em> </td></tr>
1871 <tr class="markdownTableRowEven">
1872 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__event__gr.html#gab79b3ab4dcd03c38df1e173fa903d822">ARM_MCI_EVENT_COMMAND_TIMEOUT</a> </td><td class="markdownTableBodyRight">3 </td><td class="markdownTableBodyLeft">Occurs after command timeout </td><td class="markdownTableBodyLeft"><em>always supported</em> </td></tr>
1873 <tr class="markdownTableRowOdd">
1874 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__event__gr.html#ga373aeb3eca0e4c6d159312488a130442">ARM_MCI_EVENT_COMMAND_ERROR</a> </td><td class="markdownTableBodyRight">4 </td><td class="markdownTableBodyLeft">Occurs after command response error (CRC error or invalid response) </td><td class="markdownTableBodyLeft"><em>always supported</em> </td></tr>
1875 <tr class="markdownTableRowEven">
1876 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__event__gr.html#gabc3c468dedaed890683360f2c5c65bea">ARM_MCI_EVENT_TRANSFER_COMPLETE</a> </td><td class="markdownTableBodyRight">5 </td><td class="markdownTableBodyLeft">Occurs after data transfer completed successfully </td><td class="markdownTableBodyLeft"><em>always supported</em> </td></tr>
1877 <tr class="markdownTableRowOdd">
1878 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__event__gr.html#ga614e7c7226adbaa8ec4165bf8b87ef27">ARM_MCI_EVENT_TRANSFER_TIMEOUT</a> </td><td class="markdownTableBodyRight">6 </td><td class="markdownTableBodyLeft">Occurs after data transfer timeout </td><td class="markdownTableBodyLeft"><em>always supported</em> </td></tr>
1879 <tr class="markdownTableRowEven">
1880 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__event__gr.html#ga5d2cee5ba6d0e40ad505983155706c29">ARM_MCI_EVENT_TRANSFER_ERROR</a> </td><td class="markdownTableBodyRight">7 </td><td class="markdownTableBodyLeft">Occurs after data transfer error (CRC failed) </td><td class="markdownTableBodyLeft"><em>always supported</em> </td></tr>
1881 <tr class="markdownTableRowOdd">
1882 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__event__gr.html#ga75a050fdfe04e6816e96c938d6a6c197">ARM_MCI_EVENT_SDIO_INTERRUPT</a> </td><td class="markdownTableBodyRight">8 </td><td class="markdownTableBodyLeft">Indicates SD I/O Interrupt </td><td class="markdownTableBodyLeft">data field <em>sdio_interrupt</em> = <span class="XML-Token">1</span> </td></tr>
1883 <tr class="markdownTableRowEven">
1884 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__event__gr.html#ga8161f3960ddf2a3cdc3c4c83148c6099">ARM_MCI_EVENT_CCS</a> </td><td class="markdownTableBodyRight">9 </td><td class="markdownTableBodyLeft">Indicates a Command Completion Signal (CCS) </td><td class="markdownTableBodyLeft">data field <em>ccs</em> = <span class="XML-Token">1</span> </td></tr>
1885 <tr class="markdownTableRowOdd">
1886 <td class="markdownTableBodyLeft"><a class="el" href="group__mci__event__gr.html#gafa8cbcd597a05c64901eeb777cc0b74f">ARM_MCI_EVENT_CCS_TIMEOUT</a> </td><td class="markdownTableBodyRight">10 </td><td class="markdownTableBodyLeft">Indicates a Command Completion Signal (CCS) Timeout </td><td class="markdownTableBodyLeft">data field <em>css_timeout</em> = <span class="XML-Token">1</span> </td></tr>
1888 <p><b>See also:</b></p><ul>
1889 <li><a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand</a> </li>
1894 </div><!-- contents -->
1895 </div><!-- doc-content -->
1896 <!-- start footer part -->
1897 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1900 <script type="text/javascript">
1902 writeFooter.call(this);