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.

1059 lines
47KB

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