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