You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

class_sdio_card.html 47KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.16"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>SdFat: SdioCard Class Reference</title>
  9. <link href="tabs.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. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">SdFat
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.16 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="class_sdio_card-members.html">List of all members</a> </div>
  65. <div class="headertitle">
  66. <div class="title">SdioCard Class Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>Raw SDIO access to SD and SDHC flash memory cards.
  70. <a href="class_sdio_card.html#details">More...</a></p>
  71. <p><code>#include &lt;SdioCard.h&gt;</code></p>
  72. <div class="dynheader">
  73. Inheritance diagram for SdioCard:</div>
  74. <div class="dyncontent">
  75. <div class="center"><img src="class_sdio_card__inherit__graph.png" border="0" usemap="#_sdio_card_inherit__map" alt="Inheritance graph"/></div>
  76. <map name="_sdio_card_inherit__map" id="_sdio_card_inherit__map">
  77. <area shape="rect" title="Raw SDIO access to SD and SDHC flash memory cards." alt="" coords="39,155,114,181"/>
  78. <area shape="rect" href="class_sd_card_interface.html" title="Abstract interface for an SD card." alt="" coords="19,80,134,107"/>
  79. <area shape="rect" href="class_block_device_interface.html" title="BlockDeviceInterface class." alt="" coords="5,5,148,32"/>
  80. </map>
  81. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  82. <div class="dynheader">
  83. Collaboration diagram for SdioCard:</div>
  84. <div class="dyncontent">
  85. <div class="center"><img src="class_sdio_card__coll__graph.png" border="0" usemap="#_sdio_card_coll__map" alt="Collaboration graph"/></div>
  86. <map name="_sdio_card_coll__map" id="_sdio_card_coll__map">
  87. <area shape="rect" title="Raw SDIO access to SD and SDHC flash memory cards." alt="" coords="39,155,114,181"/>
  88. <area shape="rect" href="class_sd_card_interface.html" title="Abstract interface for an SD card." alt="" coords="19,80,134,107"/>
  89. <area shape="rect" href="class_block_device_interface.html" title="BlockDeviceInterface class." alt="" coords="5,5,148,32"/>
  90. </map>
  91. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  92. <table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  94. Public Member Functions</h2></td></tr>
  95. <tr class="memitem:afbb5ab075dfd16ceebfcba5a20e70434"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#afbb5ab075dfd16ceebfcba5a20e70434">begin</a> (<a class="el" href="class_sdio_config.html">SdioConfig</a> sdioConfig)</td></tr>
  96. <tr class="separator:afbb5ab075dfd16ceebfcba5a20e70434"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:aef8e287f0e2033d4afe5e7051c293334"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#aef8e287f0e2033d4afe5e7051c293334">end</a> ()</td></tr>
  98. <tr class="separator:aef8e287f0e2033d4afe5e7051c293334"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a03b1cdcf988acbdee91bfa8974be50f9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a03b1cdcf988acbdee91bfa8974be50f9">erase</a> (uint32_t firstSector, uint32_t lastSector)</td></tr>
  100. <tr class="separator:a03b1cdcf988acbdee91bfa8974be50f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a1d505c4fb461bb7103692054ef6f7f1f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a1d505c4fb461bb7103692054ef6f7f1f">errorCode</a> () const</td></tr>
  102. <tr class="separator:a1d505c4fb461bb7103692054ef6f7f1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a9c2da202da95162d2eb694363fbe8654"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a9c2da202da95162d2eb694363fbe8654">errorData</a> () const</td></tr>
  104. <tr class="separator:a9c2da202da95162d2eb694363fbe8654"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a37e477b39d2a9c874fd338b4f7ef6b0e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a37e477b39d2a9c874fd338b4f7ef6b0e">errorLine</a> () const</td></tr>
  106. <tr class="separator:a37e477b39d2a9c874fd338b4f7ef6b0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a560bdfc96932d073c2b0610600560f78"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a560bdfc96932d073c2b0610600560f78">isBusy</a> ()</td></tr>
  108. <tr class="separator:a560bdfc96932d073c2b0610600560f78"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a3532a1a4b8a43a51ed9b5853186203cb"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a3532a1a4b8a43a51ed9b5853186203cb">kHzSdClk</a> ()</td></tr>
  110. <tr class="separator:a3532a1a4b8a43a51ed9b5853186203cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a2490b07ee400aaf799ea5c37052041bf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a2490b07ee400aaf799ea5c37052041bf">readCID</a> (<a class="el" href="struct_c_i_d.html">cid_t</a> *cid)</td></tr>
  112. <tr class="separator:a2490b07ee400aaf799ea5c37052041bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a72bbb4fda29fb6313981a63ea2f43d5f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a72bbb4fda29fb6313981a63ea2f43d5f">readCSD</a> (csd_t *csd)</td></tr>
  114. <tr class="separator:a72bbb4fda29fb6313981a63ea2f43d5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a9dc1cd99d0136e514faaecf56a6318d2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a9dc1cd99d0136e514faaecf56a6318d2">readData</a> (uint8_t *dst)</td></tr>
  116. <tr class="separator:a9dc1cd99d0136e514faaecf56a6318d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:adc583f7a27f57ce55ce474b1379b9303"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#adc583f7a27f57ce55ce474b1379b9303">readOCR</a> (uint32_t *ocr)</td></tr>
  118. <tr class="separator:adc583f7a27f57ce55ce474b1379b9303"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a77ae4fbe24bb04b74af5d388d4139dde"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a77ae4fbe24bb04b74af5d388d4139dde">readSector</a> (uint32_t sector, uint8_t *dst)</td></tr>
  120. <tr class="separator:a77ae4fbe24bb04b74af5d388d4139dde"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a1ed4229446a5a2fe815d460b027243b9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a1ed4229446a5a2fe815d460b027243b9">readSectors</a> (uint32_t sector, uint8_t *dst, size_t ns)</td></tr>
  122. <tr class="separator:a1ed4229446a5a2fe815d460b027243b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a9fde1fb0e6603e7140cac16395815df0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a9fde1fb0e6603e7140cac16395815df0">readStart</a> (uint32_t sector)</td></tr>
  124. <tr class="separator:a9fde1fb0e6603e7140cac16395815df0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a54732c9d38998ddd42b72b720e0ee54c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a54732c9d38998ddd42b72b720e0ee54c">readStart</a> (uint32_t sector, uint32_t count)</td></tr>
  126. <tr class="separator:a54732c9d38998ddd42b72b720e0ee54c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a5bd3f206d790149340783135d08eb701"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a5bd3f206d790149340783135d08eb701">readStop</a> ()</td></tr>
  128. <tr class="separator:a5bd3f206d790149340783135d08eb701"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a49a502cf7b59dc559a6c75a3285e6c1a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a49a502cf7b59dc559a6c75a3285e6c1a">sectorCount</a> ()</td></tr>
  130. <tr class="separator:a49a502cf7b59dc559a6c75a3285e6c1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a58880a055e58410f8b22658b88622f63"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a58880a055e58410f8b22658b88622f63">status</a> ()</td></tr>
  132. <tr class="separator:a58880a055e58410f8b22658b88622f63"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a1201ec7a6fa91b73a1daa584a1b055f7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a1201ec7a6fa91b73a1daa584a1b055f7">syncDevice</a> ()</td></tr>
  134. <tr class="separator:a1201ec7a6fa91b73a1daa584a1b055f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a22451464dba5275838908c2d19392850"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a22451464dba5275838908c2d19392850">type</a> () const</td></tr>
  136. <tr class="separator:a22451464dba5275838908c2d19392850"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a8467e7ffafa45ff930b38a6f18e9547a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a8467e7ffafa45ff930b38a6f18e9547a">writeData</a> (const uint8_t *src)</td></tr>
  138. <tr class="separator:a8467e7ffafa45ff930b38a6f18e9547a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a74919a168bac68028ce62222500cf238"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a74919a168bac68028ce62222500cf238">writeSector</a> (uint32_t sector, const uint8_t *src)</td></tr>
  140. <tr class="separator:a74919a168bac68028ce62222500cf238"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a55e2fc82ef9ecf7272a94b565c50303b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a55e2fc82ef9ecf7272a94b565c50303b">writeSectors</a> (uint32_t sector, const uint8_t *src, size_t ns)</td></tr>
  142. <tr class="separator:a55e2fc82ef9ecf7272a94b565c50303b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a1edd70537e2d7fa556532790cf413b5c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a1edd70537e2d7fa556532790cf413b5c">writeStart</a> (uint32_t sector)</td></tr>
  144. <tr class="separator:a1edd70537e2d7fa556532790cf413b5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a82fe097fdbae26b3c8f92f215499cdf3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#a82fe097fdbae26b3c8f92f215499cdf3">writeStart</a> (uint32_t sector, uint32_t count)</td></tr>
  146. <tr class="separator:a82fe097fdbae26b3c8f92f215499cdf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:acb560c2ea1f30c646b96f02e728b0fe1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sdio_card.html#acb560c2ea1f30c646b96f02e728b0fe1">writeStop</a> ()</td></tr>
  148. <tr class="separator:acb560c2ea1f30c646b96f02e728b0fe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. </table>
  150. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  151. <div class="textblock"><p>Raw SDIO access to SD and SDHC flash memory cards. </p>
  152. </div><h2 class="groupheader">Member Function Documentation</h2>
  153. <a id="afbb5ab075dfd16ceebfcba5a20e70434"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#afbb5ab075dfd16ceebfcba5a20e70434">&#9670;&nbsp;</a></span>begin()</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">bool SdioCard::begin </td>
  160. <td>(</td>
  161. <td class="paramtype"><a class="el" href="class_sdio_config.html">SdioConfig</a>&#160;</td>
  162. <td class="paramname"><em>sdioConfig</em></td><td>)</td>
  163. <td></td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <p>Initialize the SD card. </p><dl class="params"><dt>Parameters</dt><dd>
  168. <table class="params">
  169. <tr><td class="paramdir">[in]</td><td class="paramname">sdioConfig</td><td>SDIO card configuration. </td></tr>
  170. </table>
  171. </dd>
  172. </dl>
  173. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  174. </div>
  175. </div>
  176. <a id="aef8e287f0e2033d4afe5e7051c293334"></a>
  177. <h2 class="memtitle"><span class="permalink"><a href="#aef8e287f0e2033d4afe5e7051c293334">&#9670;&nbsp;</a></span>end()</h2>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="mlabels">
  181. <tr>
  182. <td class="mlabels-left">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">bool SdioCard::end </td>
  186. <td>(</td>
  187. <td class="paramname"></td><td>)</td>
  188. <td></td>
  189. </tr>
  190. </table>
  191. </td>
  192. <td class="mlabels-right">
  193. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>Disable an SDIO card. </p><dl class="section return"><dt>Returns</dt><dd>false - not implemented. </dd></dl>
  198. </div>
  199. </div>
  200. <a id="a03b1cdcf988acbdee91bfa8974be50f9"></a>
  201. <h2 class="memtitle"><span class="permalink"><a href="#a03b1cdcf988acbdee91bfa8974be50f9">&#9670;&nbsp;</a></span>erase()</h2>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="mlabels">
  205. <tr>
  206. <td class="mlabels-left">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">bool SdioCard::erase </td>
  210. <td>(</td>
  211. <td class="paramtype">uint32_t&#160;</td>
  212. <td class="paramname"><em>firstSector</em>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype">uint32_t&#160;</td>
  218. <td class="paramname"><em>lastSector</em>&#160;</td>
  219. </tr>
  220. <tr>
  221. <td></td>
  222. <td>)</td>
  223. <td></td><td></td>
  224. </tr>
  225. </table>
  226. </td>
  227. <td class="mlabels-right">
  228. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  229. </tr>
  230. </table>
  231. </div><div class="memdoc">
  232. <p>Erase a range of sectors.</p>
  233. <dl class="params"><dt>Parameters</dt><dd>
  234. <table class="params">
  235. <tr><td class="paramdir">[in]</td><td class="paramname">firstSector</td><td>The address of the first sector in the range. </td></tr>
  236. <tr><td class="paramdir">[in]</td><td class="paramname">lastSector</td><td>The address of the last sector in the range.</td></tr>
  237. </table>
  238. </dd>
  239. </dl>
  240. <dl class="section note"><dt>Note</dt><dd>This function requests the SD card to do a flash erase for a range of sectors. The data on the card after an erase operation is either 0 or 1, depends on the card vendor. The card must support single sector erase.</dd></dl>
  241. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  242. <p>Implements <a class="el" href="class_sd_card_interface.html#a6a57c5bced670759b7c278c7a5988fd1">SdCardInterface</a>.</p>
  243. </div>
  244. </div>
  245. <a id="a1d505c4fb461bb7103692054ef6f7f1f"></a>
  246. <h2 class="memtitle"><span class="permalink"><a href="#a1d505c4fb461bb7103692054ef6f7f1f">&#9670;&nbsp;</a></span>errorCode()</h2>
  247. <div class="memitem">
  248. <div class="memproto">
  249. <table class="mlabels">
  250. <tr>
  251. <td class="mlabels-left">
  252. <table class="memname">
  253. <tr>
  254. <td class="memname">uint8_t SdioCard::errorCode </td>
  255. <td>(</td>
  256. <td class="paramname"></td><td>)</td>
  257. <td> const</td>
  258. </tr>
  259. </table>
  260. </td>
  261. <td class="mlabels-right">
  262. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <dl class="section return"><dt>Returns</dt><dd>code for the last error. See SdCardInfo.h for a list of error codes. </dd></dl>
  267. <p>Implements <a class="el" href="class_sd_card_interface.html#af83618545960af2f1ceec84927c12fc9">SdCardInterface</a>.</p>
  268. </div>
  269. </div>
  270. <a id="a9c2da202da95162d2eb694363fbe8654"></a>
  271. <h2 class="memtitle"><span class="permalink"><a href="#a9c2da202da95162d2eb694363fbe8654">&#9670;&nbsp;</a></span>errorData()</h2>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="mlabels">
  275. <tr>
  276. <td class="mlabels-left">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname">uint32_t SdioCard::errorData </td>
  280. <td>(</td>
  281. <td class="paramname"></td><td>)</td>
  282. <td> const</td>
  283. </tr>
  284. </table>
  285. </td>
  286. <td class="mlabels-right">
  287. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  288. </tr>
  289. </table>
  290. </div><div class="memdoc">
  291. <dl class="section return"><dt>Returns</dt><dd>error data for last error. </dd></dl>
  292. <p>Implements <a class="el" href="class_sd_card_interface.html#ab84d7a9506d49366d8ec105e239ab0e1">SdCardInterface</a>.</p>
  293. </div>
  294. </div>
  295. <a id="a37e477b39d2a9c874fd338b4f7ef6b0e"></a>
  296. <h2 class="memtitle"><span class="permalink"><a href="#a37e477b39d2a9c874fd338b4f7ef6b0e">&#9670;&nbsp;</a></span>errorLine()</h2>
  297. <div class="memitem">
  298. <div class="memproto">
  299. <table class="memname">
  300. <tr>
  301. <td class="memname">uint32_t SdioCard::errorLine </td>
  302. <td>(</td>
  303. <td class="paramname"></td><td>)</td>
  304. <td> const</td>
  305. </tr>
  306. </table>
  307. </div><div class="memdoc">
  308. <dl class="section return"><dt>Returns</dt><dd>error line for last error. Tmp function for debug. </dd></dl>
  309. </div>
  310. </div>
  311. <a id="a560bdfc96932d073c2b0610600560f78"></a>
  312. <h2 class="memtitle"><span class="permalink"><a href="#a560bdfc96932d073c2b0610600560f78">&#9670;&nbsp;</a></span>isBusy()</h2>
  313. <div class="memitem">
  314. <div class="memproto">
  315. <table class="mlabels">
  316. <tr>
  317. <td class="mlabels-left">
  318. <table class="memname">
  319. <tr>
  320. <td class="memname">bool SdioCard::isBusy </td>
  321. <td>(</td>
  322. <td class="paramname"></td><td>)</td>
  323. <td></td>
  324. </tr>
  325. </table>
  326. </td>
  327. <td class="mlabels-right">
  328. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  329. </tr>
  330. </table>
  331. </div><div class="memdoc">
  332. <p>Check for busy with CMD13.</p>
  333. <dl class="section return"><dt>Returns</dt><dd>true if busy else false. </dd></dl>
  334. <p>Implements <a class="el" href="class_sd_card_interface.html#a26c31b07a866469098d702fed54f51b2">SdCardInterface</a>.</p>
  335. </div>
  336. </div>
  337. <a id="a3532a1a4b8a43a51ed9b5853186203cb"></a>
  338. <h2 class="memtitle"><span class="permalink"><a href="#a3532a1a4b8a43a51ed9b5853186203cb">&#9670;&nbsp;</a></span>kHzSdClk()</h2>
  339. <div class="memitem">
  340. <div class="memproto">
  341. <table class="memname">
  342. <tr>
  343. <td class="memname">uint32_t SdioCard::kHzSdClk </td>
  344. <td>(</td>
  345. <td class="paramname"></td><td>)</td>
  346. <td></td>
  347. </tr>
  348. </table>
  349. </div><div class="memdoc">
  350. <dl class="section return"><dt>Returns</dt><dd>the SD clock frequency in kHz. </dd></dl>
  351. </div>
  352. </div>
  353. <a id="a2490b07ee400aaf799ea5c37052041bf"></a>
  354. <h2 class="memtitle"><span class="permalink"><a href="#a2490b07ee400aaf799ea5c37052041bf">&#9670;&nbsp;</a></span>readCID()</h2>
  355. <div class="memitem">
  356. <div class="memproto">
  357. <table class="mlabels">
  358. <tr>
  359. <td class="mlabels-left">
  360. <table class="memname">
  361. <tr>
  362. <td class="memname">bool SdioCard::readCID </td>
  363. <td>(</td>
  364. <td class="paramtype"><a class="el" href="struct_c_i_d.html">cid_t</a> *&#160;</td>
  365. <td class="paramname"><em>cid</em></td><td>)</td>
  366. <td></td>
  367. </tr>
  368. </table>
  369. </td>
  370. <td class="mlabels-right">
  371. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  372. </tr>
  373. </table>
  374. </div><div class="memdoc">
  375. <p>Read a card's <a class="el" href="struct_c_i_d.html" title="Card IDentification (CID) register.">CID</a> register. The <a class="el" href="struct_c_i_d.html" title="Card IDentification (CID) register.">CID</a> contains card identification information such as Manufacturer ID, Product name, Product serial number and Manufacturing date.</p>
  376. <dl class="params"><dt>Parameters</dt><dd>
  377. <table class="params">
  378. <tr><td class="paramdir">[out]</td><td class="paramname">cid</td><td>pointer to area for returned data.</td></tr>
  379. </table>
  380. </dd>
  381. </dl>
  382. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  383. <p>Implements <a class="el" href="class_sd_card_interface.html#ab61ea0c742074271de0552c46be8ae51">SdCardInterface</a>.</p>
  384. </div>
  385. </div>
  386. <a id="a72bbb4fda29fb6313981a63ea2f43d5f"></a>
  387. <h2 class="memtitle"><span class="permalink"><a href="#a72bbb4fda29fb6313981a63ea2f43d5f">&#9670;&nbsp;</a></span>readCSD()</h2>
  388. <div class="memitem">
  389. <div class="memproto">
  390. <table class="mlabels">
  391. <tr>
  392. <td class="mlabels-left">
  393. <table class="memname">
  394. <tr>
  395. <td class="memname">bool SdioCard::readCSD </td>
  396. <td>(</td>
  397. <td class="paramtype">csd_t *&#160;</td>
  398. <td class="paramname"><em>csd</em></td><td>)</td>
  399. <td></td>
  400. </tr>
  401. </table>
  402. </td>
  403. <td class="mlabels-right">
  404. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  405. </tr>
  406. </table>
  407. </div><div class="memdoc">
  408. <p>Read a card's CSD register. The CSD contains Card-Specific Data that provides information regarding access to the card's contents.</p>
  409. <dl class="params"><dt>Parameters</dt><dd>
  410. <table class="params">
  411. <tr><td class="paramdir">[out]</td><td class="paramname">csd</td><td>pointer to area for returned data.</td></tr>
  412. </table>
  413. </dd>
  414. </dl>
  415. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  416. <p>Implements <a class="el" href="class_sd_card_interface.html#a8aaf7a014423034652f2a1ded1aaa127">SdCardInterface</a>.</p>
  417. </div>
  418. </div>
  419. <a id="a9dc1cd99d0136e514faaecf56a6318d2"></a>
  420. <h2 class="memtitle"><span class="permalink"><a href="#a9dc1cd99d0136e514faaecf56a6318d2">&#9670;&nbsp;</a></span>readData()</h2>
  421. <div class="memitem">
  422. <div class="memproto">
  423. <table class="memname">
  424. <tr>
  425. <td class="memname">bool SdioCard::readData </td>
  426. <td>(</td>
  427. <td class="paramtype">uint8_t *&#160;</td>
  428. <td class="paramname"><em>dst</em></td><td>)</td>
  429. <td></td>
  430. </tr>
  431. </table>
  432. </div><div class="memdoc">
  433. <p>Read one data sector in a multiple sector read sequence</p>
  434. <dl class="params"><dt>Parameters</dt><dd>
  435. <table class="params">
  436. <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Pointer to the location for the data to be read.</td></tr>
  437. </table>
  438. </dd>
  439. </dl>
  440. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  441. </div>
  442. </div>
  443. <a id="adc583f7a27f57ce55ce474b1379b9303"></a>
  444. <h2 class="memtitle"><span class="permalink"><a href="#adc583f7a27f57ce55ce474b1379b9303">&#9670;&nbsp;</a></span>readOCR()</h2>
  445. <div class="memitem">
  446. <div class="memproto">
  447. <table class="mlabels">
  448. <tr>
  449. <td class="mlabels-left">
  450. <table class="memname">
  451. <tr>
  452. <td class="memname">bool SdioCard::readOCR </td>
  453. <td>(</td>
  454. <td class="paramtype">uint32_t *&#160;</td>
  455. <td class="paramname"><em>ocr</em></td><td>)</td>
  456. <td></td>
  457. </tr>
  458. </table>
  459. </td>
  460. <td class="mlabels-right">
  461. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  462. </tr>
  463. </table>
  464. </div><div class="memdoc">
  465. <p>Read OCR register.</p>
  466. <dl class="params"><dt>Parameters</dt><dd>
  467. <table class="params">
  468. <tr><td class="paramdir">[out]</td><td class="paramname">ocr</td><td>Value of OCR register. </td></tr>
  469. </table>
  470. </dd>
  471. </dl>
  472. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  473. <p>Implements <a class="el" href="class_sd_card_interface.html#abb2742e6e81d18552308519a0dfb72a6">SdCardInterface</a>.</p>
  474. </div>
  475. </div>
  476. <a id="a77ae4fbe24bb04b74af5d388d4139dde"></a>
  477. <h2 class="memtitle"><span class="permalink"><a href="#a77ae4fbe24bb04b74af5d388d4139dde">&#9670;&nbsp;</a></span>readSector()</h2>
  478. <div class="memitem">
  479. <div class="memproto">
  480. <table class="mlabels">
  481. <tr>
  482. <td class="mlabels-left">
  483. <table class="memname">
  484. <tr>
  485. <td class="memname">bool SdioCard::readSector </td>
  486. <td>(</td>
  487. <td class="paramtype">uint32_t&#160;</td>
  488. <td class="paramname"><em>sector</em>, </td>
  489. </tr>
  490. <tr>
  491. <td class="paramkey"></td>
  492. <td></td>
  493. <td class="paramtype">uint8_t *&#160;</td>
  494. <td class="paramname"><em>dst</em>&#160;</td>
  495. </tr>
  496. <tr>
  497. <td></td>
  498. <td>)</td>
  499. <td></td><td></td>
  500. </tr>
  501. </table>
  502. </td>
  503. <td class="mlabels-right">
  504. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  505. </tr>
  506. </table>
  507. </div><div class="memdoc">
  508. <p>Read a 512 byte sector from an SD card.</p>
  509. <dl class="params"><dt>Parameters</dt><dd>
  510. <table class="params">
  511. <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Logical sector to be read. </td></tr>
  512. <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Pointer to the location that will receive the data. </td></tr>
  513. </table>
  514. </dd>
  515. </dl>
  516. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  517. <p>Implements <a class="el" href="class_block_device_interface.html#a537ffdf8645666ee60d9bee0d7e3d17e">BlockDeviceInterface</a>.</p>
  518. </div>
  519. </div>
  520. <a id="a1ed4229446a5a2fe815d460b027243b9"></a>
  521. <h2 class="memtitle"><span class="permalink"><a href="#a1ed4229446a5a2fe815d460b027243b9">&#9670;&nbsp;</a></span>readSectors()</h2>
  522. <div class="memitem">
  523. <div class="memproto">
  524. <table class="mlabels">
  525. <tr>
  526. <td class="mlabels-left">
  527. <table class="memname">
  528. <tr>
  529. <td class="memname">bool SdioCard::readSectors </td>
  530. <td>(</td>
  531. <td class="paramtype">uint32_t&#160;</td>
  532. <td class="paramname"><em>sector</em>, </td>
  533. </tr>
  534. <tr>
  535. <td class="paramkey"></td>
  536. <td></td>
  537. <td class="paramtype">uint8_t *&#160;</td>
  538. <td class="paramname"><em>dst</em>, </td>
  539. </tr>
  540. <tr>
  541. <td class="paramkey"></td>
  542. <td></td>
  543. <td class="paramtype">size_t&#160;</td>
  544. <td class="paramname"><em>ns</em>&#160;</td>
  545. </tr>
  546. <tr>
  547. <td></td>
  548. <td>)</td>
  549. <td></td><td></td>
  550. </tr>
  551. </table>
  552. </td>
  553. <td class="mlabels-right">
  554. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  555. </tr>
  556. </table>
  557. </div><div class="memdoc">
  558. <p>Read multiple 512 byte sectors from an SD card.</p>
  559. <dl class="params"><dt>Parameters</dt><dd>
  560. <table class="params">
  561. <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Logical sector to be read. </td></tr>
  562. <tr><td class="paramdir">[in]</td><td class="paramname">ns</td><td>Number of sectors to be read. </td></tr>
  563. <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Pointer to the location that will receive the data. </td></tr>
  564. </table>
  565. </dd>
  566. </dl>
  567. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  568. <p>Implements <a class="el" href="class_block_device_interface.html#aeee2944296d4aaabd00ee7be90596c5c">BlockDeviceInterface</a>.</p>
  569. </div>
  570. </div>
  571. <a id="a9fde1fb0e6603e7140cac16395815df0"></a>
  572. <h2 class="memtitle"><span class="permalink"><a href="#a9fde1fb0e6603e7140cac16395815df0">&#9670;&nbsp;</a></span>readStart() <span class="overload">[1/2]</span></h2>
  573. <div class="memitem">
  574. <div class="memproto">
  575. <table class="memname">
  576. <tr>
  577. <td class="memname">bool SdioCard::readStart </td>
  578. <td>(</td>
  579. <td class="paramtype">uint32_t&#160;</td>
  580. <td class="paramname"><em>sector</em></td><td>)</td>
  581. <td></td>
  582. </tr>
  583. </table>
  584. </div><div class="memdoc">
  585. <p>Start a read multiple sectors sequence.</p>
  586. <dl class="params"><dt>Parameters</dt><dd>
  587. <table class="params">
  588. <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Address of first sector in sequence.</td></tr>
  589. </table>
  590. </dd>
  591. </dl>
  592. <dl class="section note"><dt>Note</dt><dd>This function is used with <a class="el" href="class_sdio_card.html#a9dc1cd99d0136e514faaecf56a6318d2">readData()</a> and <a class="el" href="class_sdio_card.html#a5bd3f206d790149340783135d08eb701">readStop()</a> for optimized multiple sector reads. SPI chipSelect must be low for the entire sequence.</dd></dl>
  593. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  594. </div>
  595. </div>
  596. <a id="a54732c9d38998ddd42b72b720e0ee54c"></a>
  597. <h2 class="memtitle"><span class="permalink"><a href="#a54732c9d38998ddd42b72b720e0ee54c">&#9670;&nbsp;</a></span>readStart() <span class="overload">[2/2]</span></h2>
  598. <div class="memitem">
  599. <div class="memproto">
  600. <table class="memname">
  601. <tr>
  602. <td class="memname">bool SdioCard::readStart </td>
  603. <td>(</td>
  604. <td class="paramtype">uint32_t&#160;</td>
  605. <td class="paramname"><em>sector</em>, </td>
  606. </tr>
  607. <tr>
  608. <td class="paramkey"></td>
  609. <td></td>
  610. <td class="paramtype">uint32_t&#160;</td>
  611. <td class="paramname"><em>count</em>&#160;</td>
  612. </tr>
  613. <tr>
  614. <td></td>
  615. <td>)</td>
  616. <td></td><td></td>
  617. </tr>
  618. </table>
  619. </div><div class="memdoc">
  620. <p>Start a read multiple sectors sequence.</p>
  621. <dl class="params"><dt>Parameters</dt><dd>
  622. <table class="params">
  623. <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Address of first sector in sequence. </td></tr>
  624. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum sector count. </td></tr>
  625. </table>
  626. </dd>
  627. </dl>
  628. <dl class="section note"><dt>Note</dt><dd>This function is used with <a class="el" href="class_sdio_card.html#a9dc1cd99d0136e514faaecf56a6318d2">readData()</a> and <a class="el" href="class_sdio_card.html#a5bd3f206d790149340783135d08eb701">readStop()</a> for optimized multiple sector reads. SPI chipSelect must be low for the entire sequence.</dd></dl>
  629. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  630. </div>
  631. </div>
  632. <a id="a5bd3f206d790149340783135d08eb701"></a>
  633. <h2 class="memtitle"><span class="permalink"><a href="#a5bd3f206d790149340783135d08eb701">&#9670;&nbsp;</a></span>readStop()</h2>
  634. <div class="memitem">
  635. <div class="memproto">
  636. <table class="memname">
  637. <tr>
  638. <td class="memname">bool SdioCard::readStop </td>
  639. <td>(</td>
  640. <td class="paramname"></td><td>)</td>
  641. <td></td>
  642. </tr>
  643. </table>
  644. </div><div class="memdoc">
  645. <p>End a read multiple sectors sequence.</p>
  646. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  647. </div>
  648. </div>
  649. <a id="a49a502cf7b59dc559a6c75a3285e6c1a"></a>
  650. <h2 class="memtitle"><span class="permalink"><a href="#a49a502cf7b59dc559a6c75a3285e6c1a">&#9670;&nbsp;</a></span>sectorCount()</h2>
  651. <div class="memitem">
  652. <div class="memproto">
  653. <table class="mlabels">
  654. <tr>
  655. <td class="mlabels-left">
  656. <table class="memname">
  657. <tr>
  658. <td class="memname">uint32_t SdioCard::sectorCount </td>
  659. <td>(</td>
  660. <td class="paramname"></td><td>)</td>
  661. <td></td>
  662. </tr>
  663. </table>
  664. </td>
  665. <td class="mlabels-right">
  666. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  667. </tr>
  668. </table>
  669. </div><div class="memdoc">
  670. <p>Determine the size of an SD flash memory card.</p>
  671. <dl class="section return"><dt>Returns</dt><dd>The number of 512 byte data sectors in the card or zero if an error occurs. </dd></dl>
  672. <p>Implements <a class="el" href="class_sd_card_interface.html#a1a8c37709b578bffc556240f6f03a8da">SdCardInterface</a>.</p>
  673. </div>
  674. </div>
  675. <a id="a58880a055e58410f8b22658b88622f63"></a>
  676. <h2 class="memtitle"><span class="permalink"><a href="#a58880a055e58410f8b22658b88622f63">&#9670;&nbsp;</a></span>status()</h2>
  677. <div class="memitem">
  678. <div class="memproto">
  679. <table class="mlabels">
  680. <tr>
  681. <td class="mlabels-left">
  682. <table class="memname">
  683. <tr>
  684. <td class="memname">uint32_t SdioCard::status </td>
  685. <td>(</td>
  686. <td class="paramname"></td><td>)</td>
  687. <td></td>
  688. </tr>
  689. </table>
  690. </td>
  691. <td class="mlabels-right">
  692. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  693. </tr>
  694. </table>
  695. </div><div class="memdoc">
  696. <dl class="section return"><dt>Returns</dt><dd>SDIO card status. </dd></dl>
  697. <p>Reimplemented from <a class="el" href="class_sd_card_interface.html#a6315bf0d5852bc24563b7977f7c7e5b4">SdCardInterface</a>.</p>
  698. </div>
  699. </div>
  700. <a id="a1201ec7a6fa91b73a1daa584a1b055f7"></a>
  701. <h2 class="memtitle"><span class="permalink"><a href="#a1201ec7a6fa91b73a1daa584a1b055f7">&#9670;&nbsp;</a></span>syncDevice()</h2>
  702. <div class="memitem">
  703. <div class="memproto">
  704. <table class="mlabels">
  705. <tr>
  706. <td class="mlabels-left">
  707. <table class="memname">
  708. <tr>
  709. <td class="memname">bool SdioCard::syncDevice </td>
  710. <td>(</td>
  711. <td class="paramname"></td><td>)</td>
  712. <td></td>
  713. </tr>
  714. </table>
  715. </td>
  716. <td class="mlabels-right">
  717. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  718. </tr>
  719. </table>
  720. </div><div class="memdoc">
  721. <dl class="section return"><dt>Returns</dt><dd>success if sync successful. Not for user apps. </dd></dl>
  722. <p>Implements <a class="el" href="class_block_device_interface.html#a23e30999f1cc03da99e285cf180dbbb7">BlockDeviceInterface</a>.</p>
  723. </div>
  724. </div>
  725. <a id="a22451464dba5275838908c2d19392850"></a>
  726. <h2 class="memtitle"><span class="permalink"><a href="#a22451464dba5275838908c2d19392850">&#9670;&nbsp;</a></span>type()</h2>
  727. <div class="memitem">
  728. <div class="memproto">
  729. <table class="mlabels">
  730. <tr>
  731. <td class="mlabels-left">
  732. <table class="memname">
  733. <tr>
  734. <td class="memname">uint8_t SdioCard::type </td>
  735. <td>(</td>
  736. <td class="paramname"></td><td>)</td>
  737. <td> const</td>
  738. </tr>
  739. </table>
  740. </td>
  741. <td class="mlabels-right">
  742. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  743. </tr>
  744. </table>
  745. </div><div class="memdoc">
  746. <p>Return the card type: SD V1, SD V2 or SDHC </p><dl class="section return"><dt>Returns</dt><dd>0 - SD V1, 1 - SD V2, or 3 - SDHC. </dd></dl>
  747. <p>Implements <a class="el" href="class_sd_card_interface.html#a80796bc06b4090c15b3d46e651dd38c8">SdCardInterface</a>.</p>
  748. </div>
  749. </div>
  750. <a id="a8467e7ffafa45ff930b38a6f18e9547a"></a>
  751. <h2 class="memtitle"><span class="permalink"><a href="#a8467e7ffafa45ff930b38a6f18e9547a">&#9670;&nbsp;</a></span>writeData()</h2>
  752. <div class="memitem">
  753. <div class="memproto">
  754. <table class="mlabels">
  755. <tr>
  756. <td class="mlabels-left">
  757. <table class="memname">
  758. <tr>
  759. <td class="memname">bool SdioCard::writeData </td>
  760. <td>(</td>
  761. <td class="paramtype">const uint8_t *&#160;</td>
  762. <td class="paramname"><em>src</em></td><td>)</td>
  763. <td></td>
  764. </tr>
  765. </table>
  766. </td>
  767. <td class="mlabels-right">
  768. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  769. </tr>
  770. </table>
  771. </div><div class="memdoc">
  772. <p>Write one data sector in a multiple sector write sequence. </p><dl class="params"><dt>Parameters</dt><dd>
  773. <table class="params">
  774. <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Pointer to the location of the data to be written. </td></tr>
  775. </table>
  776. </dd>
  777. </dl>
  778. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  779. <p>Implements <a class="el" href="class_sd_card_interface.html#ad12a0053d3e832da694bd8d3d66adbc1">SdCardInterface</a>.</p>
  780. </div>
  781. </div>
  782. <a id="a74919a168bac68028ce62222500cf238"></a>
  783. <h2 class="memtitle"><span class="permalink"><a href="#a74919a168bac68028ce62222500cf238">&#9670;&nbsp;</a></span>writeSector()</h2>
  784. <div class="memitem">
  785. <div class="memproto">
  786. <table class="mlabels">
  787. <tr>
  788. <td class="mlabels-left">
  789. <table class="memname">
  790. <tr>
  791. <td class="memname">bool SdioCard::writeSector </td>
  792. <td>(</td>
  793. <td class="paramtype">uint32_t&#160;</td>
  794. <td class="paramname"><em>sector</em>, </td>
  795. </tr>
  796. <tr>
  797. <td class="paramkey"></td>
  798. <td></td>
  799. <td class="paramtype">const uint8_t *&#160;</td>
  800. <td class="paramname"><em>src</em>&#160;</td>
  801. </tr>
  802. <tr>
  803. <td></td>
  804. <td>)</td>
  805. <td></td><td></td>
  806. </tr>
  807. </table>
  808. </td>
  809. <td class="mlabels-right">
  810. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  811. </tr>
  812. </table>
  813. </div><div class="memdoc">
  814. <p>Writes a 512 byte sector to an SD card.</p>
  815. <dl class="params"><dt>Parameters</dt><dd>
  816. <table class="params">
  817. <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Logical sector to be written. </td></tr>
  818. <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Pointer to the location of the data to be written. </td></tr>
  819. </table>
  820. </dd>
  821. </dl>
  822. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  823. <p>Implements <a class="el" href="class_block_device_interface.html#a8a4be0a85c3771c705617fad98303e49">BlockDeviceInterface</a>.</p>
  824. </div>
  825. </div>
  826. <a id="a55e2fc82ef9ecf7272a94b565c50303b"></a>
  827. <h2 class="memtitle"><span class="permalink"><a href="#a55e2fc82ef9ecf7272a94b565c50303b">&#9670;&nbsp;</a></span>writeSectors()</h2>
  828. <div class="memitem">
  829. <div class="memproto">
  830. <table class="mlabels">
  831. <tr>
  832. <td class="mlabels-left">
  833. <table class="memname">
  834. <tr>
  835. <td class="memname">bool SdioCard::writeSectors </td>
  836. <td>(</td>
  837. <td class="paramtype">uint32_t&#160;</td>
  838. <td class="paramname"><em>sector</em>, </td>
  839. </tr>
  840. <tr>
  841. <td class="paramkey"></td>
  842. <td></td>
  843. <td class="paramtype">const uint8_t *&#160;</td>
  844. <td class="paramname"><em>src</em>, </td>
  845. </tr>
  846. <tr>
  847. <td class="paramkey"></td>
  848. <td></td>
  849. <td class="paramtype">size_t&#160;</td>
  850. <td class="paramname"><em>ns</em>&#160;</td>
  851. </tr>
  852. <tr>
  853. <td></td>
  854. <td>)</td>
  855. <td></td><td></td>
  856. </tr>
  857. </table>
  858. </td>
  859. <td class="mlabels-right">
  860. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  861. </tr>
  862. </table>
  863. </div><div class="memdoc">
  864. <p>Write multiple 512 byte sectors to an SD card.</p>
  865. <dl class="params"><dt>Parameters</dt><dd>
  866. <table class="params">
  867. <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Logical sector to be written. </td></tr>
  868. <tr><td class="paramdir">[in]</td><td class="paramname">ns</td><td>Number of sectors to be written. </td></tr>
  869. <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Pointer to the location of the data to be written. </td></tr>
  870. </table>
  871. </dd>
  872. </dl>
  873. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  874. <p>Implements <a class="el" href="class_block_device_interface.html#a5cb063692a65f092ccdfd14f8700b58a">BlockDeviceInterface</a>.</p>
  875. </div>
  876. </div>
  877. <a id="a1edd70537e2d7fa556532790cf413b5c"></a>
  878. <h2 class="memtitle"><span class="permalink"><a href="#a1edd70537e2d7fa556532790cf413b5c">&#9670;&nbsp;</a></span>writeStart() <span class="overload">[1/2]</span></h2>
  879. <div class="memitem">
  880. <div class="memproto">
  881. <table class="mlabels">
  882. <tr>
  883. <td class="mlabels-left">
  884. <table class="memname">
  885. <tr>
  886. <td class="memname">bool SdioCard::writeStart </td>
  887. <td>(</td>
  888. <td class="paramtype">uint32_t&#160;</td>
  889. <td class="paramname"><em>sector</em></td><td>)</td>
  890. <td></td>
  891. </tr>
  892. </table>
  893. </td>
  894. <td class="mlabels-right">
  895. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  896. </tr>
  897. </table>
  898. </div><div class="memdoc">
  899. <p>Start a write multiple sectors sequence.</p>
  900. <dl class="params"><dt>Parameters</dt><dd>
  901. <table class="params">
  902. <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Address of first sector in sequence.</td></tr>
  903. </table>
  904. </dd>
  905. </dl>
  906. <dl class="section note"><dt>Note</dt><dd>This function is used with <a class="el" href="class_sdio_card.html#a8467e7ffafa45ff930b38a6f18e9547a">writeData()</a> and <a class="el" href="class_sdio_card.html#acb560c2ea1f30c646b96f02e728b0fe1">writeStop()</a> for optimized multiple sector writes.</dd></dl>
  907. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  908. <p>Implements <a class="el" href="class_sd_card_interface.html#abf04f87ec5c49fe6d9e23c8ac4cf482d">SdCardInterface</a>.</p>
  909. </div>
  910. </div>
  911. <a id="a82fe097fdbae26b3c8f92f215499cdf3"></a>
  912. <h2 class="memtitle"><span class="permalink"><a href="#a82fe097fdbae26b3c8f92f215499cdf3">&#9670;&nbsp;</a></span>writeStart() <span class="overload">[2/2]</span></h2>
  913. <div class="memitem">
  914. <div class="memproto">
  915. <table class="memname">
  916. <tr>
  917. <td class="memname">bool SdioCard::writeStart </td>
  918. <td>(</td>
  919. <td class="paramtype">uint32_t&#160;</td>
  920. <td class="paramname"><em>sector</em>, </td>
  921. </tr>
  922. <tr>
  923. <td class="paramkey"></td>
  924. <td></td>
  925. <td class="paramtype">uint32_t&#160;</td>
  926. <td class="paramname"><em>count</em>&#160;</td>
  927. </tr>
  928. <tr>
  929. <td></td>
  930. <td>)</td>
  931. <td></td><td></td>
  932. </tr>
  933. </table>
  934. </div><div class="memdoc">
  935. <p>Start a write multiple sectors sequence.</p>
  936. <dl class="params"><dt>Parameters</dt><dd>
  937. <table class="params">
  938. <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Address of first sector in sequence. </td></tr>
  939. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum sector count. </td></tr>
  940. </table>
  941. </dd>
  942. </dl>
  943. <dl class="section note"><dt>Note</dt><dd>This function is used with <a class="el" href="class_sdio_card.html#a8467e7ffafa45ff930b38a6f18e9547a">writeData()</a> and <a class="el" href="class_sdio_card.html#acb560c2ea1f30c646b96f02e728b0fe1">writeStop()</a> for optimized multiple sector writes.</dd></dl>
  944. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  945. </div>
  946. </div>
  947. <a id="acb560c2ea1f30c646b96f02e728b0fe1"></a>
  948. <h2 class="memtitle"><span class="permalink"><a href="#acb560c2ea1f30c646b96f02e728b0fe1">&#9670;&nbsp;</a></span>writeStop()</h2>
  949. <div class="memitem">
  950. <div class="memproto">
  951. <table class="mlabels">
  952. <tr>
  953. <td class="mlabels-left">
  954. <table class="memname">
  955. <tr>
  956. <td class="memname">bool SdioCard::writeStop </td>
  957. <td>(</td>
  958. <td class="paramname"></td><td>)</td>
  959. <td></td>
  960. </tr>
  961. </table>
  962. </td>
  963. <td class="mlabels-right">
  964. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  965. </tr>
  966. </table>
  967. </div><div class="memdoc">
  968. <p>End a write multiple sectors sequence.</p>
  969. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  970. <p>Implements <a class="el" href="class_sd_card_interface.html#a2eac04896a05bd57730e96708934970f">SdCardInterface</a>.</p>
  971. </div>
  972. </div>
  973. <hr/>The documentation for this class was generated from the following file:<ul>
  974. <li>ArduinoSdFat/libraries/SdFat/src/SdCard/SdioCard.h</li>
  975. </ul>
  976. </div><!-- contents -->
  977. <!-- start footer part -->
  978. <hr class="footer"/><address class="footer"><small>
  979. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  980. <img class="footer" src="doxygen.png" alt="doxygen"/>
  981. </a> 1.8.16
  982. </small></address>
  983. </body>
  984. </html>