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 Events</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);
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__event__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="#define-members">Macros</a> </div>
132 <div class="headertitle"><div class="title">MCI Events<div class="ingroups"><a class="el" href="group__mci__interface__gr.html">MCI Interface</a></div></div></div>
134 <div class="contents">
136 <p>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>.
137 <a href="#details">More...</a></p>
138 <table class="memberdecls">
139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
140 Macros</h2></td></tr>
141 <tr class="memitem:gae2cf8ef238c092e94e96a01602f3a23c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#gae2cf8ef238c092e94e96a01602f3a23c">ARM_MCI_EVENT_CARD_INSERTED</a>   (1UL << 0)</td></tr>
142 <tr class="memdesc:gae2cf8ef238c092e94e96a01602f3a23c"><td class="mdescLeft"> </td><td class="mdescRight">Memory Card inserted. <br /></td></tr>
143 <tr class="separator:gae2cf8ef238c092e94e96a01602f3a23c"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:ga92ba748f9324ec13898f10456f17c8cc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#ga92ba748f9324ec13898f10456f17c8cc">ARM_MCI_EVENT_CARD_REMOVED</a>   (1UL << 1)</td></tr>
145 <tr class="memdesc:ga92ba748f9324ec13898f10456f17c8cc"><td class="mdescLeft"> </td><td class="mdescRight">Memory Card removed. <br /></td></tr>
146 <tr class="separator:ga92ba748f9324ec13898f10456f17c8cc"><td class="memSeparator" colspan="2"> </td></tr>
147 <tr class="memitem:gae69356c75d55103d93ef91ac1bc02b49"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#gae69356c75d55103d93ef91ac1bc02b49">ARM_MCI_EVENT_COMMAND_COMPLETE</a>   (1UL << 2)</td></tr>
148 <tr class="memdesc:gae69356c75d55103d93ef91ac1bc02b49"><td class="mdescLeft"> </td><td class="mdescRight">Command completed. <br /></td></tr>
149 <tr class="separator:gae69356c75d55103d93ef91ac1bc02b49"><td class="memSeparator" colspan="2"> </td></tr>
150 <tr class="memitem:gab79b3ab4dcd03c38df1e173fa903d822"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#gab79b3ab4dcd03c38df1e173fa903d822">ARM_MCI_EVENT_COMMAND_TIMEOUT</a>   (1UL << 3)</td></tr>
151 <tr class="memdesc:gab79b3ab4dcd03c38df1e173fa903d822"><td class="mdescLeft"> </td><td class="mdescRight">Command timeout. <br /></td></tr>
152 <tr class="separator:gab79b3ab4dcd03c38df1e173fa903d822"><td class="memSeparator" colspan="2"> </td></tr>
153 <tr class="memitem:ga373aeb3eca0e4c6d159312488a130442"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#ga373aeb3eca0e4c6d159312488a130442">ARM_MCI_EVENT_COMMAND_ERROR</a>   (1UL << 4)</td></tr>
154 <tr class="memdesc:ga373aeb3eca0e4c6d159312488a130442"><td class="mdescLeft"> </td><td class="mdescRight">Command response error (CRC error or invalid response) <br /></td></tr>
155 <tr class="separator:ga373aeb3eca0e4c6d159312488a130442"><td class="memSeparator" colspan="2"> </td></tr>
156 <tr class="memitem:gabc3c468dedaed890683360f2c5c65bea"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#gabc3c468dedaed890683360f2c5c65bea">ARM_MCI_EVENT_TRANSFER_COMPLETE</a>   (1UL << 5)</td></tr>
157 <tr class="memdesc:gabc3c468dedaed890683360f2c5c65bea"><td class="mdescLeft"> </td><td class="mdescRight">Data transfer completed. <br /></td></tr>
158 <tr class="separator:gabc3c468dedaed890683360f2c5c65bea"><td class="memSeparator" colspan="2"> </td></tr>
159 <tr class="memitem:ga614e7c7226adbaa8ec4165bf8b87ef27"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#ga614e7c7226adbaa8ec4165bf8b87ef27">ARM_MCI_EVENT_TRANSFER_TIMEOUT</a>   (1UL << 6)</td></tr>
160 <tr class="memdesc:ga614e7c7226adbaa8ec4165bf8b87ef27"><td class="mdescLeft"> </td><td class="mdescRight">Data transfer timeout. <br /></td></tr>
161 <tr class="separator:ga614e7c7226adbaa8ec4165bf8b87ef27"><td class="memSeparator" colspan="2"> </td></tr>
162 <tr class="memitem:ga5d2cee5ba6d0e40ad505983155706c29"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#ga5d2cee5ba6d0e40ad505983155706c29">ARM_MCI_EVENT_TRANSFER_ERROR</a>   (1UL << 7)</td></tr>
163 <tr class="memdesc:ga5d2cee5ba6d0e40ad505983155706c29"><td class="mdescLeft"> </td><td class="mdescRight">Data transfer CRC failed. <br /></td></tr>
164 <tr class="separator:ga5d2cee5ba6d0e40ad505983155706c29"><td class="memSeparator" colspan="2"> </td></tr>
165 <tr class="memitem:ga75a050fdfe04e6816e96c938d6a6c197"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#ga75a050fdfe04e6816e96c938d6a6c197">ARM_MCI_EVENT_SDIO_INTERRUPT</a>   (1UL << 8)</td></tr>
166 <tr class="memdesc:ga75a050fdfe04e6816e96c938d6a6c197"><td class="mdescLeft"> </td><td class="mdescRight">SD I/O Interrupt. <br /></td></tr>
167 <tr class="separator:ga75a050fdfe04e6816e96c938d6a6c197"><td class="memSeparator" colspan="2"> </td></tr>
168 <tr class="memitem:ga8161f3960ddf2a3cdc3c4c83148c6099"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#ga8161f3960ddf2a3cdc3c4c83148c6099">ARM_MCI_EVENT_CCS</a>   (1UL << 9)</td></tr>
169 <tr class="memdesc:ga8161f3960ddf2a3cdc3c4c83148c6099"><td class="mdescLeft"> </td><td class="mdescRight">Command Completion Signal (CCS) <br /></td></tr>
170 <tr class="separator:ga8161f3960ddf2a3cdc3c4c83148c6099"><td class="memSeparator" colspan="2"> </td></tr>
171 <tr class="memitem:gafa8cbcd597a05c64901eeb777cc0b74f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__event__gr.html#gafa8cbcd597a05c64901eeb777cc0b74f">ARM_MCI_EVENT_CCS_TIMEOUT</a>   (1UL << 10)</td></tr>
172 <tr class="memdesc:gafa8cbcd597a05c64901eeb777cc0b74f"><td class="mdescLeft"> </td><td class="mdescRight">Command Completion Signal (CCS) Timeout. <br /></td></tr>
173 <tr class="separator:gafa8cbcd597a05c64901eeb777cc0b74f"><td class="memSeparator" colspan="2"> </td></tr>
175 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
176 <p>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>. </p>
177 <p>This section provides the event values for the <a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> callback function.</p>
178 <p>The following call back notification events are generated: </p>
179 <h2 class="groupheader">Macro Definition Documentation</h2>
180 <a id="gae2cf8ef238c092e94e96a01602f3a23c" name="gae2cf8ef238c092e94e96a01602f3a23c"></a>
181 <h2 class="memtitle"><span class="permalink"><a href="#gae2cf8ef238c092e94e96a01602f3a23c">◆ </a></span>ARM_MCI_EVENT_CARD_INSERTED</h2>
183 <div class="memitem">
184 <div class="memproto">
185 <table class="memname">
187 <td class="memname">#define ARM_MCI_EVENT_CARD_INSERTED   (1UL << 0)</td>
190 </div><div class="memdoc">
192 <p>Memory Card inserted. </p>
193 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
197 <a id="ga92ba748f9324ec13898f10456f17c8cc" name="ga92ba748f9324ec13898f10456f17c8cc"></a>
198 <h2 class="memtitle"><span class="permalink"><a href="#ga92ba748f9324ec13898f10456f17c8cc">◆ </a></span>ARM_MCI_EVENT_CARD_REMOVED</h2>
200 <div class="memitem">
201 <div class="memproto">
202 <table class="memname">
204 <td class="memname">#define ARM_MCI_EVENT_CARD_REMOVED   (1UL << 1)</td>
207 </div><div class="memdoc">
209 <p>Memory Card removed. </p>
210 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
214 <a id="gae69356c75d55103d93ef91ac1bc02b49" name="gae69356c75d55103d93ef91ac1bc02b49"></a>
215 <h2 class="memtitle"><span class="permalink"><a href="#gae69356c75d55103d93ef91ac1bc02b49">◆ </a></span>ARM_MCI_EVENT_COMMAND_COMPLETE</h2>
217 <div class="memitem">
218 <div class="memproto">
219 <table class="memname">
221 <td class="memname">#define ARM_MCI_EVENT_COMMAND_COMPLETE   (1UL << 2)</td>
224 </div><div class="memdoc">
226 <p>Command completed. </p>
227 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
231 <a id="gab79b3ab4dcd03c38df1e173fa903d822" name="gab79b3ab4dcd03c38df1e173fa903d822"></a>
232 <h2 class="memtitle"><span class="permalink"><a href="#gab79b3ab4dcd03c38df1e173fa903d822">◆ </a></span>ARM_MCI_EVENT_COMMAND_TIMEOUT</h2>
234 <div class="memitem">
235 <div class="memproto">
236 <table class="memname">
238 <td class="memname">#define ARM_MCI_EVENT_COMMAND_TIMEOUT   (1UL << 3)</td>
241 </div><div class="memdoc">
243 <p>Command timeout. </p>
244 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
248 <a id="ga373aeb3eca0e4c6d159312488a130442" name="ga373aeb3eca0e4c6d159312488a130442"></a>
249 <h2 class="memtitle"><span class="permalink"><a href="#ga373aeb3eca0e4c6d159312488a130442">◆ </a></span>ARM_MCI_EVENT_COMMAND_ERROR</h2>
251 <div class="memitem">
252 <div class="memproto">
253 <table class="memname">
255 <td class="memname">#define ARM_MCI_EVENT_COMMAND_ERROR   (1UL << 4)</td>
258 </div><div class="memdoc">
260 <p>Command response error (CRC error or invalid response) </p>
261 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
265 <a id="gabc3c468dedaed890683360f2c5c65bea" name="gabc3c468dedaed890683360f2c5c65bea"></a>
266 <h2 class="memtitle"><span class="permalink"><a href="#gabc3c468dedaed890683360f2c5c65bea">◆ </a></span>ARM_MCI_EVENT_TRANSFER_COMPLETE</h2>
268 <div class="memitem">
269 <div class="memproto">
270 <table class="memname">
272 <td class="memname">#define ARM_MCI_EVENT_TRANSFER_COMPLETE   (1UL << 5)</td>
275 </div><div class="memdoc">
277 <p>Data transfer completed. </p>
278 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
282 <a id="ga614e7c7226adbaa8ec4165bf8b87ef27" name="ga614e7c7226adbaa8ec4165bf8b87ef27"></a>
283 <h2 class="memtitle"><span class="permalink"><a href="#ga614e7c7226adbaa8ec4165bf8b87ef27">◆ </a></span>ARM_MCI_EVENT_TRANSFER_TIMEOUT</h2>
285 <div class="memitem">
286 <div class="memproto">
287 <table class="memname">
289 <td class="memname">#define ARM_MCI_EVENT_TRANSFER_TIMEOUT   (1UL << 6)</td>
292 </div><div class="memdoc">
294 <p>Data transfer timeout. </p>
295 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
299 <a id="ga5d2cee5ba6d0e40ad505983155706c29" name="ga5d2cee5ba6d0e40ad505983155706c29"></a>
300 <h2 class="memtitle"><span class="permalink"><a href="#ga5d2cee5ba6d0e40ad505983155706c29">◆ </a></span>ARM_MCI_EVENT_TRANSFER_ERROR</h2>
302 <div class="memitem">
303 <div class="memproto">
304 <table class="memname">
306 <td class="memname">#define ARM_MCI_EVENT_TRANSFER_ERROR   (1UL << 7)</td>
309 </div><div class="memdoc">
311 <p>Data transfer CRC failed. </p>
312 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
316 <a id="ga75a050fdfe04e6816e96c938d6a6c197" name="ga75a050fdfe04e6816e96c938d6a6c197"></a>
317 <h2 class="memtitle"><span class="permalink"><a href="#ga75a050fdfe04e6816e96c938d6a6c197">◆ </a></span>ARM_MCI_EVENT_SDIO_INTERRUPT</h2>
319 <div class="memitem">
320 <div class="memproto">
321 <table class="memname">
323 <td class="memname">#define ARM_MCI_EVENT_SDIO_INTERRUPT   (1UL << 8)</td>
326 </div><div class="memdoc">
328 <p>SD I/O Interrupt. </p>
329 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
333 <a id="ga8161f3960ddf2a3cdc3c4c83148c6099" name="ga8161f3960ddf2a3cdc3c4c83148c6099"></a>
334 <h2 class="memtitle"><span class="permalink"><a href="#ga8161f3960ddf2a3cdc3c4c83148c6099">◆ </a></span>ARM_MCI_EVENT_CCS</h2>
336 <div class="memitem">
337 <div class="memproto">
338 <table class="memname">
340 <td class="memname">#define ARM_MCI_EVENT_CCS   (1UL << 9)</td>
343 </div><div class="memdoc">
345 <p>Command Completion Signal (CCS) </p>
346 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
350 <a id="gafa8cbcd597a05c64901eeb777cc0b74f" name="gafa8cbcd597a05c64901eeb777cc0b74f"></a>
351 <h2 class="memtitle"><span class="permalink"><a href="#gafa8cbcd597a05c64901eeb777cc0b74f">◆ </a></span>ARM_MCI_EVENT_CCS_TIMEOUT</h2>
353 <div class="memitem">
354 <div class="memproto">
355 <table class="memname">
357 <td class="memname">#define ARM_MCI_EVENT_CCS_TIMEOUT   (1UL << 10)</td>
360 </div><div class="memdoc">
362 <p>Command Completion Signal (CCS) Timeout. </p>
363 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__mci__interface__gr.html#gaac2dbd1c1a98436938c5d0d6248cb700">ARM_MCI_SignalEvent</a> </dd></dl>
367 </div><!-- contents -->
368 </div><!-- doc-content -->
369 <!-- start footer part -->
370 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
373 <script type="text/javascript">
375 writeFooter.call(this);