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.

1025 lines
44KB

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