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 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <script type="text/javascript" src="tabs.js"></script>
13 <script type="text/javascript" src="footer.js"></script>
14 <script type="text/javascript" src="navtree.js"></script>
15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
16 <script type="text/javascript" src="resize.js"></script>
17 <script type="text/javascript" src="navtreedata.js"></script>
18 <script type="text/javascript" src="navtree.js"></script>
19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="search/searchdata.js"></script>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
24 $(document).ready(function() { init_search(); });
27 <script type="text/javascript" src="darkmode_toggle.js"></script>
28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
32 <link href="version.css" rel="stylesheet" type="text/css"/>
33 <script type="text/javascript" src="../../version.js"></script>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 55px;">
41 <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
42 <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
43 <div id="projectname">CMSIS-Driver
44  <span id="projectnumber"><script type="text/javascript">
46 writeHeader.call(this);
47 writeVersionDropdown.call(this, "CMSIS-Driver");
52 <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
54 <td> <div id="MSearchBox" class="MSearchBoxInactive">
56 <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
57 <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
58 onfocus="searchBox.OnSearchFieldFocus(true)"
59 onblur="searchBox.OnSearchFieldFocus(false)"
60 onkeyup="searchBox.OnSearchFieldChange(event)"/>
61 </span><span class="right">
62 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
66 <!--END !PROJECT_NAME-->
71 <!-- end header part -->
72 <div id="CMSISnav" class="tabs1">
74 <script type="text/javascript">
75 writeComponentTabs.call(this);
79 <script type="text/javascript">
80 writeSubComponentTabs.call(this);
82 <!-- Generated by Doxygen 1.9.6 -->
83 <script type="text/javascript">
84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
85 var searchBox = new SearchBox("searchBox", "search/",'.html');
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
91 <div id="nav-tree-contents">
92 <div id="nav-sync" class="sync"></div>
95 <div id="splitbar" style="-moz-user-select:none;"
96 class="ui-resizable-handle">
99 <script type="text/javascript">
100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
101 $(document).ready(function(){initNavTree('group__mci__event__gr.html',''); initResizable(); });
104 <div id="doc-content">
105 <!-- window showing the filter options -->
106 <div id="MSearchSelectWindow"
107 onmouseover="return searchBox.OnSearchSelectShow()"
108 onmouseout="return searchBox.OnSearchSelectHide()"
109 onkeydown="return searchBox.OnSearchSelectKey(event)">
112 <!-- iframe showing the search results (closed by default) -->
113 <div id="MSearchResultsWindow">
114 <div id="MSearchResults">
117 <div id="SRResults"></div>
118 <div class="SRStatus" id="Loading">Loading...</div>
119 <div class="SRStatus" id="Searching">Searching...</div>
120 <div class="SRStatus" id="NoMatches">No Matches</div>
127 <div class="summary">
128 <a href="#define-members">Macros</a> </div>
129 <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>
131 <div class="contents">
133 <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>.
134 <a href="#details">More...</a></p>
135 <table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
137 Macros</h2></td></tr>
138 <tr class="memitem: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>
139 <tr class="memdesc:gae2cf8ef238c092e94e96a01602f3a23c"><td class="mdescLeft"> </td><td class="mdescRight">Memory Card inserted. <br /></td></tr>
140 <tr class="separator:gae2cf8ef238c092e94e96a01602f3a23c"><td class="memSeparator" colspan="2"> </td></tr>
141 <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>
142 <tr class="memdesc:ga92ba748f9324ec13898f10456f17c8cc"><td class="mdescLeft"> </td><td class="mdescRight">Memory Card removed. <br /></td></tr>
143 <tr class="separator:ga92ba748f9324ec13898f10456f17c8cc"><td class="memSeparator" colspan="2"> </td></tr>
144 <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>
145 <tr class="memdesc:gae69356c75d55103d93ef91ac1bc02b49"><td class="mdescLeft"> </td><td class="mdescRight">Command completed. <br /></td></tr>
146 <tr class="separator:gae69356c75d55103d93ef91ac1bc02b49"><td class="memSeparator" colspan="2"> </td></tr>
147 <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>
148 <tr class="memdesc:gab79b3ab4dcd03c38df1e173fa903d822"><td class="mdescLeft"> </td><td class="mdescRight">Command timeout. <br /></td></tr>
149 <tr class="separator:gab79b3ab4dcd03c38df1e173fa903d822"><td class="memSeparator" colspan="2"> </td></tr>
150 <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>
151 <tr class="memdesc:ga373aeb3eca0e4c6d159312488a130442"><td class="mdescLeft"> </td><td class="mdescRight">Command response error (CRC error or invalid response) <br /></td></tr>
152 <tr class="separator:ga373aeb3eca0e4c6d159312488a130442"><td class="memSeparator" colspan="2"> </td></tr>
153 <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>
154 <tr class="memdesc:gabc3c468dedaed890683360f2c5c65bea"><td class="mdescLeft"> </td><td class="mdescRight">Data transfer completed. <br /></td></tr>
155 <tr class="separator:gabc3c468dedaed890683360f2c5c65bea"><td class="memSeparator" colspan="2"> </td></tr>
156 <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>
157 <tr class="memdesc:ga614e7c7226adbaa8ec4165bf8b87ef27"><td class="mdescLeft"> </td><td class="mdescRight">Data transfer timeout. <br /></td></tr>
158 <tr class="separator:ga614e7c7226adbaa8ec4165bf8b87ef27"><td class="memSeparator" colspan="2"> </td></tr>
159 <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>
160 <tr class="memdesc:ga5d2cee5ba6d0e40ad505983155706c29"><td class="mdescLeft"> </td><td class="mdescRight">Data transfer CRC failed. <br /></td></tr>
161 <tr class="separator:ga5d2cee5ba6d0e40ad505983155706c29"><td class="memSeparator" colspan="2"> </td></tr>
162 <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>
163 <tr class="memdesc:ga75a050fdfe04e6816e96c938d6a6c197"><td class="mdescLeft"> </td><td class="mdescRight">SD I/O Interrupt. <br /></td></tr>
164 <tr class="separator:ga75a050fdfe04e6816e96c938d6a6c197"><td class="memSeparator" colspan="2"> </td></tr>
165 <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>
166 <tr class="memdesc:ga8161f3960ddf2a3cdc3c4c83148c6099"><td class="mdescLeft"> </td><td class="mdescRight">Command Completion Signal (CCS) <br /></td></tr>
167 <tr class="separator:ga8161f3960ddf2a3cdc3c4c83148c6099"><td class="memSeparator" colspan="2"> </td></tr>
168 <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>
169 <tr class="memdesc:gafa8cbcd597a05c64901eeb777cc0b74f"><td class="mdescLeft"> </td><td class="mdescRight">Command Completion Signal (CCS) Timeout. <br /></td></tr>
170 <tr class="separator:gafa8cbcd597a05c64901eeb777cc0b74f"><td class="memSeparator" colspan="2"> </td></tr>
172 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
173 <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>
174 <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>
175 <p>The following call back notification events are generated: </p>
176 <h2 class="groupheader">Macro Definition Documentation</h2>
177 <a id="gae2cf8ef238c092e94e96a01602f3a23c" name="gae2cf8ef238c092e94e96a01602f3a23c"></a>
178 <h2 class="memtitle"><span class="permalink"><a href="#gae2cf8ef238c092e94e96a01602f3a23c">◆ </a></span>ARM_MCI_EVENT_CARD_INSERTED</h2>
180 <div class="memitem">
181 <div class="memproto">
182 <table class="memname">
184 <td class="memname">#define ARM_MCI_EVENT_CARD_INSERTED   (1UL << 0)</td>
187 </div><div class="memdoc">
189 <p>Memory Card inserted. </p>
190 <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>
194 <a id="ga92ba748f9324ec13898f10456f17c8cc" name="ga92ba748f9324ec13898f10456f17c8cc"></a>
195 <h2 class="memtitle"><span class="permalink"><a href="#ga92ba748f9324ec13898f10456f17c8cc">◆ </a></span>ARM_MCI_EVENT_CARD_REMOVED</h2>
197 <div class="memitem">
198 <div class="memproto">
199 <table class="memname">
201 <td class="memname">#define ARM_MCI_EVENT_CARD_REMOVED   (1UL << 1)</td>
204 </div><div class="memdoc">
206 <p>Memory Card removed. </p>
207 <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>
211 <a id="gae69356c75d55103d93ef91ac1bc02b49" name="gae69356c75d55103d93ef91ac1bc02b49"></a>
212 <h2 class="memtitle"><span class="permalink"><a href="#gae69356c75d55103d93ef91ac1bc02b49">◆ </a></span>ARM_MCI_EVENT_COMMAND_COMPLETE</h2>
214 <div class="memitem">
215 <div class="memproto">
216 <table class="memname">
218 <td class="memname">#define ARM_MCI_EVENT_COMMAND_COMPLETE   (1UL << 2)</td>
221 </div><div class="memdoc">
223 <p>Command completed. </p>
224 <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>
228 <a id="gab79b3ab4dcd03c38df1e173fa903d822" name="gab79b3ab4dcd03c38df1e173fa903d822"></a>
229 <h2 class="memtitle"><span class="permalink"><a href="#gab79b3ab4dcd03c38df1e173fa903d822">◆ </a></span>ARM_MCI_EVENT_COMMAND_TIMEOUT</h2>
231 <div class="memitem">
232 <div class="memproto">
233 <table class="memname">
235 <td class="memname">#define ARM_MCI_EVENT_COMMAND_TIMEOUT   (1UL << 3)</td>
238 </div><div class="memdoc">
240 <p>Command timeout. </p>
241 <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>
245 <a id="ga373aeb3eca0e4c6d159312488a130442" name="ga373aeb3eca0e4c6d159312488a130442"></a>
246 <h2 class="memtitle"><span class="permalink"><a href="#ga373aeb3eca0e4c6d159312488a130442">◆ </a></span>ARM_MCI_EVENT_COMMAND_ERROR</h2>
248 <div class="memitem">
249 <div class="memproto">
250 <table class="memname">
252 <td class="memname">#define ARM_MCI_EVENT_COMMAND_ERROR   (1UL << 4)</td>
255 </div><div class="memdoc">
257 <p>Command response error (CRC error or invalid response) </p>
258 <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>
262 <a id="gabc3c468dedaed890683360f2c5c65bea" name="gabc3c468dedaed890683360f2c5c65bea"></a>
263 <h2 class="memtitle"><span class="permalink"><a href="#gabc3c468dedaed890683360f2c5c65bea">◆ </a></span>ARM_MCI_EVENT_TRANSFER_COMPLETE</h2>
265 <div class="memitem">
266 <div class="memproto">
267 <table class="memname">
269 <td class="memname">#define ARM_MCI_EVENT_TRANSFER_COMPLETE   (1UL << 5)</td>
272 </div><div class="memdoc">
274 <p>Data transfer completed. </p>
275 <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>
279 <a id="ga614e7c7226adbaa8ec4165bf8b87ef27" name="ga614e7c7226adbaa8ec4165bf8b87ef27"></a>
280 <h2 class="memtitle"><span class="permalink"><a href="#ga614e7c7226adbaa8ec4165bf8b87ef27">◆ </a></span>ARM_MCI_EVENT_TRANSFER_TIMEOUT</h2>
282 <div class="memitem">
283 <div class="memproto">
284 <table class="memname">
286 <td class="memname">#define ARM_MCI_EVENT_TRANSFER_TIMEOUT   (1UL << 6)</td>
289 </div><div class="memdoc">
291 <p>Data transfer timeout. </p>
292 <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>
296 <a id="ga5d2cee5ba6d0e40ad505983155706c29" name="ga5d2cee5ba6d0e40ad505983155706c29"></a>
297 <h2 class="memtitle"><span class="permalink"><a href="#ga5d2cee5ba6d0e40ad505983155706c29">◆ </a></span>ARM_MCI_EVENT_TRANSFER_ERROR</h2>
299 <div class="memitem">
300 <div class="memproto">
301 <table class="memname">
303 <td class="memname">#define ARM_MCI_EVENT_TRANSFER_ERROR   (1UL << 7)</td>
306 </div><div class="memdoc">
308 <p>Data transfer CRC failed. </p>
309 <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>
313 <a id="ga75a050fdfe04e6816e96c938d6a6c197" name="ga75a050fdfe04e6816e96c938d6a6c197"></a>
314 <h2 class="memtitle"><span class="permalink"><a href="#ga75a050fdfe04e6816e96c938d6a6c197">◆ </a></span>ARM_MCI_EVENT_SDIO_INTERRUPT</h2>
316 <div class="memitem">
317 <div class="memproto">
318 <table class="memname">
320 <td class="memname">#define ARM_MCI_EVENT_SDIO_INTERRUPT   (1UL << 8)</td>
323 </div><div class="memdoc">
325 <p>SD I/O Interrupt. </p>
326 <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>
330 <a id="ga8161f3960ddf2a3cdc3c4c83148c6099" name="ga8161f3960ddf2a3cdc3c4c83148c6099"></a>
331 <h2 class="memtitle"><span class="permalink"><a href="#ga8161f3960ddf2a3cdc3c4c83148c6099">◆ </a></span>ARM_MCI_EVENT_CCS</h2>
333 <div class="memitem">
334 <div class="memproto">
335 <table class="memname">
337 <td class="memname">#define ARM_MCI_EVENT_CCS   (1UL << 9)</td>
340 </div><div class="memdoc">
342 <p>Command Completion Signal (CCS) </p>
343 <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>
347 <a id="gafa8cbcd597a05c64901eeb777cc0b74f" name="gafa8cbcd597a05c64901eeb777cc0b74f"></a>
348 <h2 class="memtitle"><span class="permalink"><a href="#gafa8cbcd597a05c64901eeb777cc0b74f">◆ </a></span>ARM_MCI_EVENT_CCS_TIMEOUT</h2>
350 <div class="memitem">
351 <div class="memproto">
352 <table class="memname">
354 <td class="memname">#define ARM_MCI_EVENT_CCS_TIMEOUT   (1UL << 10)</td>
357 </div><div class="memdoc">
359 <p>Command Completion Signal (CCS) Timeout. </p>
360 <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>
364 </div><!-- contents -->
365 </div><!-- doc-content -->
366 <!-- start footer part -->
367 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
370 <script type="text/javascript">
372 writeFooter.call(this);