]> begriffs open source - cmsis/blob - main/Driver/html/group__mci__card__power__ctrls.html
Update documentation for branch main
[cmsis] / main / Driver / html / group__mci__card__power__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 Card Power 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__card__power__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 Card Power 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 Memory Card Power supply voltage.  
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:ga288fbd80b384739a80e8f3ec31205cf5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#ga288fbd80b384739a80e8f3ec31205cf5">ARM_MCI_POWER_VDD_OFF</a>&#160;&#160;&#160;(0x01UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#a8de1e84f879b741ed1e13a0aac93a246">ARM_MCI_POWER_VDD_Pos</a>)</td></tr>
139 <tr class="memdesc:ga288fbd80b384739a80e8f3ec31205cf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">VDD (VCC) turned off.  <br /></td></tr>
140 <tr class="separator:ga288fbd80b384739a80e8f3ec31205cf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:ga565ecd36c8d0379fb4172da577cc540d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#ga565ecd36c8d0379fb4172da577cc540d">ARM_MCI_POWER_VDD_3V3</a>&#160;&#160;&#160;(0x02UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#a8de1e84f879b741ed1e13a0aac93a246">ARM_MCI_POWER_VDD_Pos</a>)</td></tr>
142 <tr class="memdesc:ga565ecd36c8d0379fb4172da577cc540d"><td class="mdescLeft">&#160;</td><td class="mdescRight">VDD (VCC) = 3.3V.  <br /></td></tr>
143 <tr class="separator:ga565ecd36c8d0379fb4172da577cc540d"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:ga2ce8e379c3691da3b51c9c97d61770ef"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#ga2ce8e379c3691da3b51c9c97d61770ef">ARM_MCI_POWER_VDD_1V8</a>&#160;&#160;&#160;(0x03UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#a8de1e84f879b741ed1e13a0aac93a246">ARM_MCI_POWER_VDD_Pos</a>)</td></tr>
145 <tr class="memdesc:ga2ce8e379c3691da3b51c9c97d61770ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">VDD (VCC) = 1.8V.  <br /></td></tr>
146 <tr class="separator:ga2ce8e379c3691da3b51c9c97d61770ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:ga6929c98a6bc8d898939a95111509220b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#ga6929c98a6bc8d898939a95111509220b">ARM_MCI_POWER_VCCQ_OFF</a>&#160;&#160;&#160;(0x01UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#ae2de0ecc2d5d73b134c18b80bedb23a7">ARM_MCI_POWER_VCCQ_Pos</a>)</td></tr>
148 <tr class="memdesc:ga6929c98a6bc8d898939a95111509220b"><td class="mdescLeft">&#160;</td><td class="mdescRight">eMMC VCCQ turned off  <br /></td></tr>
149 <tr class="separator:ga6929c98a6bc8d898939a95111509220b"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:ga91a7201173cc092eaf7f0bcee028871e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#ga91a7201173cc092eaf7f0bcee028871e">ARM_MCI_POWER_VCCQ_3V3</a>&#160;&#160;&#160;(0x02UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#ae2de0ecc2d5d73b134c18b80bedb23a7">ARM_MCI_POWER_VCCQ_Pos</a>)</td></tr>
151 <tr class="memdesc:ga91a7201173cc092eaf7f0bcee028871e"><td class="mdescLeft">&#160;</td><td class="mdescRight">eMMC VCCQ = 3.3V  <br /></td></tr>
152 <tr class="separator:ga91a7201173cc092eaf7f0bcee028871e"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:gaaf389e0a139d5808dff8ebb6897d4c7b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#gaaf389e0a139d5808dff8ebb6897d4c7b">ARM_MCI_POWER_VCCQ_1V8</a>&#160;&#160;&#160;(0x03UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#ae2de0ecc2d5d73b134c18b80bedb23a7">ARM_MCI_POWER_VCCQ_Pos</a>)</td></tr>
154 <tr class="memdesc:gaaf389e0a139d5808dff8ebb6897d4c7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">eMMC VCCQ = 1.8V  <br /></td></tr>
155 <tr class="separator:gaaf389e0a139d5808dff8ebb6897d4c7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:ga5304b3b6cadc5113f841c3d526ab5db6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__card__power__ctrls.html#ga5304b3b6cadc5113f841c3d526ab5db6">ARM_MCI_POWER_VCCQ_1V2</a>&#160;&#160;&#160;(0x04UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#ae2de0ecc2d5d73b134c18b80bedb23a7">ARM_MCI_POWER_VCCQ_Pos</a>)</td></tr>
157 <tr class="memdesc:ga5304b3b6cadc5113f841c3d526ab5db6"><td class="mdescLeft">&#160;</td><td class="mdescRight">eMMC VCCQ = 1.2V  <br /></td></tr>
158 <tr class="separator:ga5304b3b6cadc5113f841c3d526ab5db6"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 </table>
160 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
161 <p>Specify Memory Card Power supply voltage. </p>
162 <p>Specifies the power supply volatge for a memory card. Used with the function <a class="el" href="group__mci__interface__gr.html#gab161f80e0eda2815f3e0ebbba1314ff0">ARM_MCI_CardPower</a> as the parameter <em>voltage</em>.</p>
163 <p>The following codes are defined: </p>
164 <h2 class="groupheader">Macro Definition Documentation</h2>
165 <a id="ga288fbd80b384739a80e8f3ec31205cf5" name="ga288fbd80b384739a80e8f3ec31205cf5"></a>
166 <h2 class="memtitle"><span class="permalink"><a href="#ga288fbd80b384739a80e8f3ec31205cf5">&#9670;&#160;</a></span>ARM_MCI_POWER_VDD_OFF</h2>
167
168 <div class="memitem">
169 <div class="memproto">
170       <table class="memname">
171         <tr>
172           <td class="memname">#define ARM_MCI_POWER_VDD_OFF&#160;&#160;&#160;(0x01UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#a8de1e84f879b741ed1e13a0aac93a246">ARM_MCI_POWER_VDD_Pos</a>)</td>
173         </tr>
174       </table>
175 </div><div class="memdoc">
176
177 <p>VDD (VCC) turned off. </p>
178
179 </div>
180 </div>
181 <a id="ga565ecd36c8d0379fb4172da577cc540d" name="ga565ecd36c8d0379fb4172da577cc540d"></a>
182 <h2 class="memtitle"><span class="permalink"><a href="#ga565ecd36c8d0379fb4172da577cc540d">&#9670;&#160;</a></span>ARM_MCI_POWER_VDD_3V3</h2>
183
184 <div class="memitem">
185 <div class="memproto">
186       <table class="memname">
187         <tr>
188           <td class="memname">#define ARM_MCI_POWER_VDD_3V3&#160;&#160;&#160;(0x02UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#a8de1e84f879b741ed1e13a0aac93a246">ARM_MCI_POWER_VDD_Pos</a>)</td>
189         </tr>
190       </table>
191 </div><div class="memdoc">
192
193 <p>VDD (VCC) = 3.3V. </p>
194
195 </div>
196 </div>
197 <a id="ga2ce8e379c3691da3b51c9c97d61770ef" name="ga2ce8e379c3691da3b51c9c97d61770ef"></a>
198 <h2 class="memtitle"><span class="permalink"><a href="#ga2ce8e379c3691da3b51c9c97d61770ef">&#9670;&#160;</a></span>ARM_MCI_POWER_VDD_1V8</h2>
199
200 <div class="memitem">
201 <div class="memproto">
202       <table class="memname">
203         <tr>
204           <td class="memname">#define ARM_MCI_POWER_VDD_1V8&#160;&#160;&#160;(0x03UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#a8de1e84f879b741ed1e13a0aac93a246">ARM_MCI_POWER_VDD_Pos</a>)</td>
205         </tr>
206       </table>
207 </div><div class="memdoc">
208
209 <p>VDD (VCC) = 1.8V. </p>
210
211 </div>
212 </div>
213 <a id="ga6929c98a6bc8d898939a95111509220b" name="ga6929c98a6bc8d898939a95111509220b"></a>
214 <h2 class="memtitle"><span class="permalink"><a href="#ga6929c98a6bc8d898939a95111509220b">&#9670;&#160;</a></span>ARM_MCI_POWER_VCCQ_OFF</h2>
215
216 <div class="memitem">
217 <div class="memproto">
218       <table class="memname">
219         <tr>
220           <td class="memname">#define ARM_MCI_POWER_VCCQ_OFF&#160;&#160;&#160;(0x01UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#ae2de0ecc2d5d73b134c18b80bedb23a7">ARM_MCI_POWER_VCCQ_Pos</a>)</td>
221         </tr>
222       </table>
223 </div><div class="memdoc">
224
225 <p>eMMC VCCQ turned off </p>
226
227 </div>
228 </div>
229 <a id="ga91a7201173cc092eaf7f0bcee028871e" name="ga91a7201173cc092eaf7f0bcee028871e"></a>
230 <h2 class="memtitle"><span class="permalink"><a href="#ga91a7201173cc092eaf7f0bcee028871e">&#9670;&#160;</a></span>ARM_MCI_POWER_VCCQ_3V3</h2>
231
232 <div class="memitem">
233 <div class="memproto">
234       <table class="memname">
235         <tr>
236           <td class="memname">#define ARM_MCI_POWER_VCCQ_3V3&#160;&#160;&#160;(0x02UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#ae2de0ecc2d5d73b134c18b80bedb23a7">ARM_MCI_POWER_VCCQ_Pos</a>)</td>
237         </tr>
238       </table>
239 </div><div class="memdoc">
240
241 <p>eMMC VCCQ = 3.3V </p>
242
243 </div>
244 </div>
245 <a id="gaaf389e0a139d5808dff8ebb6897d4c7b" name="gaaf389e0a139d5808dff8ebb6897d4c7b"></a>
246 <h2 class="memtitle"><span class="permalink"><a href="#gaaf389e0a139d5808dff8ebb6897d4c7b">&#9670;&#160;</a></span>ARM_MCI_POWER_VCCQ_1V8</h2>
247
248 <div class="memitem">
249 <div class="memproto">
250       <table class="memname">
251         <tr>
252           <td class="memname">#define ARM_MCI_POWER_VCCQ_1V8&#160;&#160;&#160;(0x03UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#ae2de0ecc2d5d73b134c18b80bedb23a7">ARM_MCI_POWER_VCCQ_Pos</a>)</td>
253         </tr>
254       </table>
255 </div><div class="memdoc">
256
257 <p>eMMC VCCQ = 1.8V </p>
258
259 </div>
260 </div>
261 <a id="ga5304b3b6cadc5113f841c3d526ab5db6" name="ga5304b3b6cadc5113f841c3d526ab5db6"></a>
262 <h2 class="memtitle"><span class="permalink"><a href="#ga5304b3b6cadc5113f841c3d526ab5db6">&#9670;&#160;</a></span>ARM_MCI_POWER_VCCQ_1V2</h2>
263
264 <div class="memitem">
265 <div class="memproto">
266       <table class="memname">
267         <tr>
268           <td class="memname">#define ARM_MCI_POWER_VCCQ_1V2&#160;&#160;&#160;(0x04UL &lt;&lt; <a class="el" href="Driver__MCI_8h.html#ae2de0ecc2d5d73b134c18b80bedb23a7">ARM_MCI_POWER_VCCQ_Pos</a>)</td>
269         </tr>
270       </table>
271 </div><div class="memdoc">
272
273 <p>eMMC VCCQ = 1.2V </p>
274
275 </div>
276 </div>
277 </div><!-- contents -->
278 </div><!-- doc-content -->
279 <!-- start footer part -->
280 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
281   <ul>
282     <li class="footer">
283       <script type="text/javascript">
284         <!--
285         writeFooter.call(this);
286         //-->
287       </script> 
288     </li>
289   </ul>
290 </div>
291 </body>
292 </html>