class_sd_spi_card.html 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959
  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: SdSpiCard 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_sd_spi_card-members.html">List of all members</a> </div>
  65. <div class="headertitle">
  66. <div class="title">SdSpiCard Class Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>Raw access to SD and SDHC flash memory cards via SPI protocol.
  70. <a href="class_sd_spi_card.html#details">More...</a></p>
  71. <p><code>#include &lt;SdSpiCard.h&gt;</code></p>
  72. <div class="dynheader">
  73. Inheritance diagram for SdSpiCard:</div>
  74. <div class="dyncontent">
  75. <div class="center"><img src="class_sd_spi_card__inherit__graph.png" border="0" usemap="#_sd_spi_card_inherit__map" alt="Inheritance graph"/></div>
  76. <map name="_sd_spi_card_inherit__map" id="_sd_spi_card_inherit__map">
  77. <area shape="rect" id="node2" href="class_sd2_card.html" title="Raw access to SD and SDHC card using default SPI library. " alt="" coords="5,80,77,107"/>
  78. <area shape="rect" id="node3" href="class_sd_spi_card_e_x.html" title="Extended SD I/O block driver. " alt="" coords="102,80,202,107"/>
  79. </map>
  80. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  81. <table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  83. Public Member Functions</h2></td></tr>
  84. <tr class="memitem:a824cd60ef8ac2b06262597d6f30a4ea7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a824cd60ef8ac2b06262597d6f30a4ea7">begin</a> (SdSpiDriver *spi, uint8_t csPin, SPISettings spiSettings)</td></tr>
  85. <tr class="separator:a824cd60ef8ac2b06262597d6f30a4ea7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <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>
  87. <tr class="separator:afca8bd6b7e465bf9c475ba375c4deec8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <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>
  89. <tr class="separator:a1caa13d19df6596b2c0dd62365c75362"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <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>
  91. <tr class="separator:aed4591884254c9f58daa8738d7c1ccdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <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>
  93. <tr class="separator:aa12ad53111abcb187d3c6119a3a77592"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a4c736fb8d6d9d734d5e262875c74f054"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a4c736fb8d6d9d734d5e262875c74f054">errorCode</a> () const</td></tr>
  95. <tr class="separator:a4c736fb8d6d9d734d5e262875c74f054"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a10bb2f65b1ca85ad14de19e61a283262"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a10bb2f65b1ca85ad14de19e61a283262">errorData</a> () const</td></tr>
  97. <tr class="separator:a10bb2f65b1ca85ad14de19e61a283262"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <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>
  99. <tr class="separator:aa3cb9139dbc1e6596c6717da2b486328"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a4393634a82c6683ee94d1fefe0be332a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a4393634a82c6683ee94d1fefe0be332a">readBlock</a> (uint32_t lba, uint8_t *dst)</td></tr>
  101. <tr class="separator:a4393634a82c6683ee94d1fefe0be332a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ac630f77c3137923b47c1bd12a9bbfadf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#ac630f77c3137923b47c1bd12a9bbfadf">readBlocks</a> (uint32_t lba, uint8_t *dst, size_t nb)</td></tr>
  103. <tr class="separator:ac630f77c3137923b47c1bd12a9bbfadf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <tr class="separator:aa073dc42828164883db1b9faeff909ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <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>
  107. <tr class="separator:a9fbea9525e70f6e3602fe5153a5a1290"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <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>
  109. <tr class="separator:a3a1d1b4b4ceb42fcd41aaf6649482770"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <tr class="separator:ab446e49338b3ce834a750ac6dae35f61"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <tr class="separator:a3b1710d11496c32ba4323831e00ac6d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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>
  115. <tr class="separator:a91d0413599efe0d63c8c2dfe4a12d9ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <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>
  117. <tr class="separator:afdac7c399fa1ba3f904cf503526e007e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a0441c5da53bd3bd72fb833fc940f25e8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a0441c5da53bd3bd72fb833fc940f25e8">SdSpiCard</a> ()</td></tr>
  119. <tr class="separator:a0441c5da53bd3bd72fb833fc940f25e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <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>
  121. <tr class="separator:aa39feb6ebb269071ac6843a424ac311c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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>
  123. <tr class="separator:a1033a4a68d38f52dddf6a1764fcca3e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a1b6d5f412c4ad75c2f575ca75c56c095"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a1b6d5f412c4ad75c2f575ca75c56c095">syncBlocks</a> ()</td></tr>
  125. <tr class="separator:a1b6d5f412c4ad75c2f575ca75c56c095"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a48f1e3f107d7242518bdfed78acb46bc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a48f1e3f107d7242518bdfed78acb46bc">type</a> () const</td></tr>
  127. <tr class="separator:a48f1e3f107d7242518bdfed78acb46bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a03a0bdb0f37a88076f24a2133cf5b4ed"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a03a0bdb0f37a88076f24a2133cf5b4ed">writeBlock</a> (uint32_t lba, const uint8_t *src)</td></tr>
  129. <tr class="separator:a03a0bdb0f37a88076f24a2133cf5b4ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a181d96fe44891b7caabcd47dd29ac913"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a181d96fe44891b7caabcd47dd29ac913">writeBlocks</a> (uint32_t lba, const uint8_t *src, size_t nb)</td></tr>
  131. <tr class="separator:a181d96fe44891b7caabcd47dd29ac913"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <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>
  133. <tr class="separator:a9495c0b148eb380358bb4a9721c0dffa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <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>
  135. <tr class="separator:a56d4750a5d2f693943eec985cb61ffe2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <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>
  137. <tr class="separator:a8bf0dc991308dcd2a7427bad89a9e2ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <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>
  139. <tr class="separator:aef9154785a4de5560fb807e4f9316fb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. </table>
  141. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  142. <div class="textblock"><p>Raw access to SD and SDHC flash memory cards via SPI protocol. </p>
  143. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  144. <a id="a0441c5da53bd3bd72fb833fc940f25e8"></a>
  145. <h2 class="memtitle"><span class="permalink"><a href="#a0441c5da53bd3bd72fb833fc940f25e8">&#9670;&nbsp;</a></span>SdSpiCard()</h2>
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="mlabels">
  149. <tr>
  150. <td class="mlabels-left">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">SdSpiCard::SdSpiCard </td>
  154. <td>(</td>
  155. <td class="paramname"></td><td>)</td>
  156. <td></td>
  157. </tr>
  158. </table>
  159. </td>
  160. <td class="mlabels-right">
  161. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  162. </tr>
  163. </table>
  164. </div><div class="memdoc">
  165. <p>Construct an instance of <a class="el" href="class_sd_spi_card.html" title="Raw access to SD and SDHC flash memory cards via SPI protocol. ">SdSpiCard</a>. </p>
  166. </div>
  167. </div>
  168. <h2 class="groupheader">Member Function Documentation</h2>
  169. <a id="a824cd60ef8ac2b06262597d6f30a4ea7"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#a824cd60ef8ac2b06262597d6f30a4ea7">&#9670;&nbsp;</a></span>begin()</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">bool SdSpiCard::begin </td>
  176. <td>(</td>
  177. <td class="paramtype">SdSpiDriver *&#160;</td>
  178. <td class="paramname"><em>spi</em>, </td>
  179. </tr>
  180. <tr>
  181. <td class="paramkey"></td>
  182. <td></td>
  183. <td class="paramtype">uint8_t&#160;</td>
  184. <td class="paramname"><em>csPin</em>, </td>
  185. </tr>
  186. <tr>
  187. <td class="paramkey"></td>
  188. <td></td>
  189. <td class="paramtype">SPISettings&#160;</td>
  190. <td class="paramname"><em>spiSettings</em>&#160;</td>
  191. </tr>
  192. <tr>
  193. <td></td>
  194. <td>)</td>
  195. <td></td><td></td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. <p>Initialize the SD card. </p><dl class="params"><dt>Parameters</dt><dd>
  200. <table class="params">
  201. <tr><td class="paramdir">[in]</td><td class="paramname">spi</td><td>SPI driver for card. </td></tr>
  202. <tr><td class="paramdir">[in]</td><td class="paramname">csPin</td><td>card chip select pin. </td></tr>
  203. <tr><td class="paramdir">[in]</td><td class="paramname">spiSettings</td><td>SPI speed, mode, and bit order. </td></tr>
  204. </table>
  205. </dd>
  206. </dl>
  207. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  208. </div>
  209. </div>
  210. <a id="afca8bd6b7e465bf9c475ba375c4deec8"></a>
  211. <h2 class="memtitle"><span class="permalink"><a href="#afca8bd6b7e465bf9c475ba375c4deec8">&#9670;&nbsp;</a></span>cardSize()</h2>
  212. <div class="memitem">
  213. <div class="memproto">
  214. <table class="memname">
  215. <tr>
  216. <td class="memname">uint32_t SdSpiCard::cardSize </td>
  217. <td>(</td>
  218. <td class="paramname"></td><td>)</td>
  219. <td></td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. <p>Determine the size of an SD flash memory card.</p>
  224. <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>
  225. </div>
  226. </div>
  227. <a id="a1caa13d19df6596b2c0dd62365c75362"></a>
  228. <h2 class="memtitle"><span class="permalink"><a href="#a1caa13d19df6596b2c0dd62365c75362">&#9670;&nbsp;</a></span>erase()</h2>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">bool SdSpiCard::erase </td>
  234. <td>(</td>
  235. <td class="paramtype">uint32_t&#160;</td>
  236. <td class="paramname"><em>firstBlock</em>, </td>
  237. </tr>
  238. <tr>
  239. <td class="paramkey"></td>
  240. <td></td>
  241. <td class="paramtype">uint32_t&#160;</td>
  242. <td class="paramname"><em>lastBlock</em>&#160;</td>
  243. </tr>
  244. <tr>
  245. <td></td>
  246. <td>)</td>
  247. <td></td><td></td>
  248. </tr>
  249. </table>
  250. </div><div class="memdoc">
  251. <p>Erase a range of blocks.</p>
  252. <dl class="params"><dt>Parameters</dt><dd>
  253. <table class="params">
  254. <tr><td class="paramdir">[in]</td><td class="paramname">firstBlock</td><td>The address of the first block in the range. </td></tr>
  255. <tr><td class="paramdir">[in]</td><td class="paramname">lastBlock</td><td>The address of the last block in the range.</td></tr>
  256. </table>
  257. </dd>
  258. </dl>
  259. <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>
  260. <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>
  261. </div>
  262. </div>
  263. <a id="aed4591884254c9f58daa8738d7c1ccdd"></a>
  264. <h2 class="memtitle"><span class="permalink"><a href="#aed4591884254c9f58daa8738d7c1ccdd">&#9670;&nbsp;</a></span>eraseSingleBlockEnable()</h2>
  265. <div class="memitem">
  266. <div class="memproto">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">bool SdSpiCard::eraseSingleBlockEnable </td>
  270. <td>(</td>
  271. <td class="paramname"></td><td>)</td>
  272. <td></td>
  273. </tr>
  274. </table>
  275. </div><div class="memdoc">
  276. <p>Determine if card supports single block erase.</p>
  277. <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>
  278. </div>
  279. </div>
  280. <a id="aa12ad53111abcb187d3c6119a3a77592"></a>
  281. <h2 class="memtitle"><span class="permalink"><a href="#aa12ad53111abcb187d3c6119a3a77592">&#9670;&nbsp;</a></span>error()</h2>
  282. <div class="memitem">
  283. <div class="memproto">
  284. <table class="mlabels">
  285. <tr>
  286. <td class="mlabels-left">
  287. <table class="memname">
  288. <tr>
  289. <td class="memname">void SdSpiCard::error </td>
  290. <td>(</td>
  291. <td class="paramtype">uint8_t&#160;</td>
  292. <td class="paramname"><em>code</em></td><td>)</td>
  293. <td></td>
  294. </tr>
  295. </table>
  296. </td>
  297. <td class="mlabels-right">
  298. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. <p>Set SD error code. </p><dl class="params"><dt>Parameters</dt><dd>
  303. <table class="params">
  304. <tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>value for error code. </td></tr>
  305. </table>
  306. </dd>
  307. </dl>
  308. </div>
  309. </div>
  310. <a id="a4c736fb8d6d9d734d5e262875c74f054"></a>
  311. <h2 class="memtitle"><span class="permalink"><a href="#a4c736fb8d6d9d734d5e262875c74f054">&#9670;&nbsp;</a></span>errorCode()</h2>
  312. <div class="memitem">
  313. <div class="memproto">
  314. <table class="mlabels">
  315. <tr>
  316. <td class="mlabels-left">
  317. <table class="memname">
  318. <tr>
  319. <td class="memname">int SdSpiCard::errorCode </td>
  320. <td>(</td>
  321. <td class="paramname"></td><td>)</td>
  322. <td> const</td>
  323. </tr>
  324. </table>
  325. </td>
  326. <td class="mlabels-right">
  327. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <dl class="section return"><dt>Returns</dt><dd>code for the last error. See SdInfo.h for a list of error codes. </dd></dl>
  332. </div>
  333. </div>
  334. <a id="a10bb2f65b1ca85ad14de19e61a283262"></a>
  335. <h2 class="memtitle"><span class="permalink"><a href="#a10bb2f65b1ca85ad14de19e61a283262">&#9670;&nbsp;</a></span>errorData()</h2>
  336. <div class="memitem">
  337. <div class="memproto">
  338. <table class="mlabels">
  339. <tr>
  340. <td class="mlabels-left">
  341. <table class="memname">
  342. <tr>
  343. <td class="memname">int SdSpiCard::errorData </td>
  344. <td>(</td>
  345. <td class="paramname"></td><td>)</td>
  346. <td> const</td>
  347. </tr>
  348. </table>
  349. </td>
  350. <td class="mlabels-right">
  351. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  352. </tr>
  353. </table>
  354. </div><div class="memdoc">
  355. <dl class="section return"><dt>Returns</dt><dd>error data for last error. </dd></dl>
  356. </div>
  357. </div>
  358. <a id="aa3cb9139dbc1e6596c6717da2b486328"></a>
  359. <h2 class="memtitle"><span class="permalink"><a href="#aa3cb9139dbc1e6596c6717da2b486328">&#9670;&nbsp;</a></span>isBusy()</h2>
  360. <div class="memitem">
  361. <div class="memproto">
  362. <table class="memname">
  363. <tr>
  364. <td class="memname">bool SdSpiCard::isBusy </td>
  365. <td>(</td>
  366. <td class="paramname"></td><td>)</td>
  367. <td></td>
  368. </tr>
  369. </table>
  370. </div><div class="memdoc">
  371. <p>Check for busy. MISO low indicates the card is busy.</p>
  372. <dl class="section return"><dt>Returns</dt><dd>true if busy else false. </dd></dl>
  373. </div>
  374. </div>
  375. <a id="a4393634a82c6683ee94d1fefe0be332a"></a>
  376. <h2 class="memtitle"><span class="permalink"><a href="#a4393634a82c6683ee94d1fefe0be332a">&#9670;&nbsp;</a></span>readBlock()</h2>
  377. <div class="memitem">
  378. <div class="memproto">
  379. <table class="memname">
  380. <tr>
  381. <td class="memname">bool SdSpiCard::readBlock </td>
  382. <td>(</td>
  383. <td class="paramtype">uint32_t&#160;</td>
  384. <td class="paramname"><em>lba</em>, </td>
  385. </tr>
  386. <tr>
  387. <td class="paramkey"></td>
  388. <td></td>
  389. <td class="paramtype">uint8_t *&#160;</td>
  390. <td class="paramname"><em>dst</em>&#160;</td>
  391. </tr>
  392. <tr>
  393. <td></td>
  394. <td>)</td>
  395. <td></td><td></td>
  396. </tr>
  397. </table>
  398. </div><div class="memdoc">
  399. <p>Read a 512 byte block from an SD card.</p>
  400. <dl class="params"><dt>Parameters</dt><dd>
  401. <table class="params">
  402. <tr><td class="paramdir">[in]</td><td class="paramname">lba</td><td>Logical block to be read. </td></tr>
  403. <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Pointer to the location that will receive the data. </td></tr>
  404. </table>
  405. </dd>
  406. </dl>
  407. <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>
  408. </div>
  409. </div>
  410. <a id="ac630f77c3137923b47c1bd12a9bbfadf"></a>
  411. <h2 class="memtitle"><span class="permalink"><a href="#ac630f77c3137923b47c1bd12a9bbfadf">&#9670;&nbsp;</a></span>readBlocks()</h2>
  412. <div class="memitem">
  413. <div class="memproto">
  414. <table class="memname">
  415. <tr>
  416. <td class="memname">bool SdSpiCard::readBlocks </td>
  417. <td>(</td>
  418. <td class="paramtype">uint32_t&#160;</td>
  419. <td class="paramname"><em>lba</em>, </td>
  420. </tr>
  421. <tr>
  422. <td class="paramkey"></td>
  423. <td></td>
  424. <td class="paramtype">uint8_t *&#160;</td>
  425. <td class="paramname"><em>dst</em>, </td>
  426. </tr>
  427. <tr>
  428. <td class="paramkey"></td>
  429. <td></td>
  430. <td class="paramtype">size_t&#160;</td>
  431. <td class="paramname"><em>nb</em>&#160;</td>
  432. </tr>
  433. <tr>
  434. <td></td>
  435. <td>)</td>
  436. <td></td><td></td>
  437. </tr>
  438. </table>
  439. </div><div class="memdoc">
  440. <p>Read multiple 512 byte blocks from an SD card.</p>
  441. <dl class="params"><dt>Parameters</dt><dd>
  442. <table class="params">
  443. <tr><td class="paramdir">[in]</td><td class="paramname">lba</td><td>Logical block to be read. </td></tr>
  444. <tr><td class="paramdir">[in]</td><td class="paramname">nb</td><td>Number of blocks to be read. </td></tr>
  445. <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Pointer to the location that will receive the data. </td></tr>
  446. </table>
  447. </dd>
  448. </dl>
  449. <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>
  450. </div>
  451. </div>
  452. <a id="aa073dc42828164883db1b9faeff909ea"></a>
  453. <h2 class="memtitle"><span class="permalink"><a href="#aa073dc42828164883db1b9faeff909ea">&#9670;&nbsp;</a></span>readCID()</h2>
  454. <div class="memitem">
  455. <div class="memproto">
  456. <table class="mlabels">
  457. <tr>
  458. <td class="mlabels-left">
  459. <table class="memname">
  460. <tr>
  461. <td class="memname">bool SdSpiCard::readCID </td>
  462. <td>(</td>
  463. <td class="paramtype">cid_t *&#160;</td>
  464. <td class="paramname"><em>cid</em></td><td>)</td>
  465. <td></td>
  466. </tr>
  467. </table>
  468. </td>
  469. <td class="mlabels-right">
  470. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  471. </tr>
  472. </table>
  473. </div><div class="memdoc">
  474. <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>
  475. <dl class="params"><dt>Parameters</dt><dd>
  476. <table class="params">
  477. <tr><td class="paramdir">[out]</td><td class="paramname">cid</td><td>pointer to area for returned data.</td></tr>
  478. </table>
  479. </dd>
  480. </dl>
  481. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  482. </div>
  483. </div>
  484. <a id="a9fbea9525e70f6e3602fe5153a5a1290"></a>
  485. <h2 class="memtitle"><span class="permalink"><a href="#a9fbea9525e70f6e3602fe5153a5a1290">&#9670;&nbsp;</a></span>readCSD()</h2>
  486. <div class="memitem">
  487. <div class="memproto">
  488. <table class="mlabels">
  489. <tr>
  490. <td class="mlabels-left">
  491. <table class="memname">
  492. <tr>
  493. <td class="memname">bool SdSpiCard::readCSD </td>
  494. <td>(</td>
  495. <td class="paramtype">csd_t *&#160;</td>
  496. <td class="paramname"><em>csd</em></td><td>)</td>
  497. <td></td>
  498. </tr>
  499. </table>
  500. </td>
  501. <td class="mlabels-right">
  502. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  503. </tr>
  504. </table>
  505. </div><div class="memdoc">
  506. <p>Read a card's CSD register. The CSD contains Card-Specific Data that provides information regarding access to the card's contents.</p>
  507. <dl class="params"><dt>Parameters</dt><dd>
  508. <table class="params">
  509. <tr><td class="paramdir">[out]</td><td class="paramname">csd</td><td>pointer to area for returned data.</td></tr>
  510. </table>
  511. </dd>
  512. </dl>
  513. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  514. </div>
  515. </div>
  516. <a id="a3a1d1b4b4ceb42fcd41aaf6649482770"></a>
  517. <h2 class="memtitle"><span class="permalink"><a href="#a3a1d1b4b4ceb42fcd41aaf6649482770">&#9670;&nbsp;</a></span>readData()</h2>
  518. <div class="memitem">
  519. <div class="memproto">
  520. <table class="memname">
  521. <tr>
  522. <td class="memname">bool SdSpiCard::readData </td>
  523. <td>(</td>
  524. <td class="paramtype">uint8_t *&#160;</td>
  525. <td class="paramname"><em>dst</em></td><td>)</td>
  526. <td></td>
  527. </tr>
  528. </table>
  529. </div><div class="memdoc">
  530. <p>Read one data block in a multiple block read sequence</p>
  531. <dl class="params"><dt>Parameters</dt><dd>
  532. <table class="params">
  533. <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Pointer to the location for the data to be read.</td></tr>
  534. </table>
  535. </dd>
  536. </dl>
  537. <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>
  538. </div>
  539. </div>
  540. <a id="ab446e49338b3ce834a750ac6dae35f61"></a>
  541. <h2 class="memtitle"><span class="permalink"><a href="#ab446e49338b3ce834a750ac6dae35f61">&#9670;&nbsp;</a></span>readOCR()</h2>
  542. <div class="memitem">
  543. <div class="memproto">
  544. <table class="memname">
  545. <tr>
  546. <td class="memname">bool SdSpiCard::readOCR </td>
  547. <td>(</td>
  548. <td class="paramtype">uint32_t *&#160;</td>
  549. <td class="paramname"><em>ocr</em></td><td>)</td>
  550. <td></td>
  551. </tr>
  552. </table>
  553. </div><div class="memdoc">
  554. <p>Read OCR register.</p>
  555. <dl class="params"><dt>Parameters</dt><dd>
  556. <table class="params">
  557. <tr><td class="paramdir">[out]</td><td class="paramname">ocr</td><td>Value of OCR register. </td></tr>
  558. </table>
  559. </dd>
  560. </dl>
  561. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  562. </div>
  563. </div>
  564. <a id="a3b1710d11496c32ba4323831e00ac6d1"></a>
  565. <h2 class="memtitle"><span class="permalink"><a href="#a3b1710d11496c32ba4323831e00ac6d1">&#9670;&nbsp;</a></span>readStart()</h2>
  566. <div class="memitem">
  567. <div class="memproto">
  568. <table class="memname">
  569. <tr>
  570. <td class="memname">bool SdSpiCard::readStart </td>
  571. <td>(</td>
  572. <td class="paramtype">uint32_t&#160;</td>
  573. <td class="paramname"><em>blockNumber</em></td><td>)</td>
  574. <td></td>
  575. </tr>
  576. </table>
  577. </div><div class="memdoc">
  578. <p>Start a read multiple blocks sequence.</p>
  579. <dl class="params"><dt>Parameters</dt><dd>
  580. <table class="params">
  581. <tr><td class="paramdir">[in]</td><td class="paramname">blockNumber</td><td>Address of first block in sequence.</td></tr>
  582. </table>
  583. </dd>
  584. </dl>
  585. <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>
  586. <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>
  587. </div>
  588. </div>
  589. <a id="a91d0413599efe0d63c8c2dfe4a12d9ae"></a>
  590. <h2 class="memtitle"><span class="permalink"><a href="#a91d0413599efe0d63c8c2dfe4a12d9ae">&#9670;&nbsp;</a></span>readStatus()</h2>
  591. <div class="memitem">
  592. <div class="memproto">
  593. <table class="memname">
  594. <tr>
  595. <td class="memname">bool SdSpiCard::readStatus </td>
  596. <td>(</td>
  597. <td class="paramtype">uint8_t *&#160;</td>
  598. <td class="paramname"><em>status</em></td><td>)</td>
  599. <td></td>
  600. </tr>
  601. </table>
  602. </div><div class="memdoc">
  603. <p>Return the 64 byte card status </p><dl class="params"><dt>Parameters</dt><dd>
  604. <table class="params">
  605. <tr><td class="paramdir">[out]</td><td class="paramname">status</td><td>location for 64 status bytes. </td></tr>
  606. </table>
  607. </dd>
  608. </dl>
  609. <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>
  610. </div>
  611. </div>
  612. <a id="afdac7c399fa1ba3f904cf503526e007e"></a>
  613. <h2 class="memtitle"><span class="permalink"><a href="#afdac7c399fa1ba3f904cf503526e007e">&#9670;&nbsp;</a></span>readStop()</h2>
  614. <div class="memitem">
  615. <div class="memproto">
  616. <table class="memname">
  617. <tr>
  618. <td class="memname">bool SdSpiCard::readStop </td>
  619. <td>(</td>
  620. <td class="paramname"></td><td>)</td>
  621. <td></td>
  622. </tr>
  623. </table>
  624. </div><div class="memdoc">
  625. <p>End a read multiple blocks sequence.</p>
  626. <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>
  627. </div>
  628. </div>
  629. <a id="aa39feb6ebb269071ac6843a424ac311c"></a>
  630. <h2 class="memtitle"><span class="permalink"><a href="#aa39feb6ebb269071ac6843a424ac311c">&#9670;&nbsp;</a></span>spiStart()</h2>
  631. <div class="memitem">
  632. <div class="memproto">
  633. <table class="memname">
  634. <tr>
  635. <td class="memname">void SdSpiCard::spiStart </td>
  636. <td>(</td>
  637. <td class="paramname"></td><td>)</td>
  638. <td></td>
  639. </tr>
  640. </table>
  641. </div><div class="memdoc">
  642. <p>Set CS low and activate the card. </p>
  643. </div>
  644. </div>
  645. <a id="a1033a4a68d38f52dddf6a1764fcca3e1"></a>
  646. <h2 class="memtitle"><span class="permalink"><a href="#a1033a4a68d38f52dddf6a1764fcca3e1">&#9670;&nbsp;</a></span>spiStop()</h2>
  647. <div class="memitem">
  648. <div class="memproto">
  649. <table class="memname">
  650. <tr>
  651. <td class="memname">void SdSpiCard::spiStop </td>
  652. <td>(</td>
  653. <td class="paramname"></td><td>)</td>
  654. <td></td>
  655. </tr>
  656. </table>
  657. </div><div class="memdoc">
  658. <p>Set CS high and deactivate the card. </p>
  659. </div>
  660. </div>
  661. <a id="a1b6d5f412c4ad75c2f575ca75c56c095"></a>
  662. <h2 class="memtitle"><span class="permalink"><a href="#a1b6d5f412c4ad75c2f575ca75c56c095">&#9670;&nbsp;</a></span>syncBlocks()</h2>
  663. <div class="memitem">
  664. <div class="memproto">
  665. <table class="mlabels">
  666. <tr>
  667. <td class="mlabels-left">
  668. <table class="memname">
  669. <tr>
  670. <td class="memname">bool SdSpiCard::syncBlocks </td>
  671. <td>(</td>
  672. <td class="paramname"></td><td>)</td>
  673. <td></td>
  674. </tr>
  675. </table>
  676. </td>
  677. <td class="mlabels-right">
  678. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  679. </tr>
  680. </table>
  681. </div><div class="memdoc">
  682. <dl class="section return"><dt>Returns</dt><dd>success if sync successful. Not for user apps. </dd></dl>
  683. </div>
  684. </div>
  685. <a id="a48f1e3f107d7242518bdfed78acb46bc"></a>
  686. <h2 class="memtitle"><span class="permalink"><a href="#a48f1e3f107d7242518bdfed78acb46bc">&#9670;&nbsp;</a></span>type()</h2>
  687. <div class="memitem">
  688. <div class="memproto">
  689. <table class="mlabels">
  690. <tr>
  691. <td class="mlabels-left">
  692. <table class="memname">
  693. <tr>
  694. <td class="memname">int SdSpiCard::type </td>
  695. <td>(</td>
  696. <td class="paramname"></td><td>)</td>
  697. <td> const</td>
  698. </tr>
  699. </table>
  700. </td>
  701. <td class="mlabels-right">
  702. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  703. </tr>
  704. </table>
  705. </div><div class="memdoc">
  706. <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>
  707. </div>
  708. </div>
  709. <a id="a03a0bdb0f37a88076f24a2133cf5b4ed"></a>
  710. <h2 class="memtitle"><span class="permalink"><a href="#a03a0bdb0f37a88076f24a2133cf5b4ed">&#9670;&nbsp;</a></span>writeBlock()</h2>
  711. <div class="memitem">
  712. <div class="memproto">
  713. <table class="memname">
  714. <tr>
  715. <td class="memname">bool SdSpiCard::writeBlock </td>
  716. <td>(</td>
  717. <td class="paramtype">uint32_t&#160;</td>
  718. <td class="paramname"><em>lba</em>, </td>
  719. </tr>
  720. <tr>
  721. <td class="paramkey"></td>
  722. <td></td>
  723. <td class="paramtype">const uint8_t *&#160;</td>
  724. <td class="paramname"><em>src</em>&#160;</td>
  725. </tr>
  726. <tr>
  727. <td></td>
  728. <td>)</td>
  729. <td></td><td></td>
  730. </tr>
  731. </table>
  732. </div><div class="memdoc">
  733. <p>Writes a 512 byte block to an SD card.</p>
  734. <dl class="params"><dt>Parameters</dt><dd>
  735. <table class="params">
  736. <tr><td class="paramdir">[in]</td><td class="paramname">lba</td><td>Logical block to be written. </td></tr>
  737. <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Pointer to the location of the data to be written. </td></tr>
  738. </table>
  739. </dd>
  740. </dl>
  741. <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>
  742. </div>
  743. </div>
  744. <a id="a181d96fe44891b7caabcd47dd29ac913"></a>
  745. <h2 class="memtitle"><span class="permalink"><a href="#a181d96fe44891b7caabcd47dd29ac913">&#9670;&nbsp;</a></span>writeBlocks()</h2>
  746. <div class="memitem">
  747. <div class="memproto">
  748. <table class="memname">
  749. <tr>
  750. <td class="memname">bool SdSpiCard::writeBlocks </td>
  751. <td>(</td>
  752. <td class="paramtype">uint32_t&#160;</td>
  753. <td class="paramname"><em>lba</em>, </td>
  754. </tr>
  755. <tr>
  756. <td class="paramkey"></td>
  757. <td></td>
  758. <td class="paramtype">const uint8_t *&#160;</td>
  759. <td class="paramname"><em>src</em>, </td>
  760. </tr>
  761. <tr>
  762. <td class="paramkey"></td>
  763. <td></td>
  764. <td class="paramtype">size_t&#160;</td>
  765. <td class="paramname"><em>nb</em>&#160;</td>
  766. </tr>
  767. <tr>
  768. <td></td>
  769. <td>)</td>
  770. <td></td><td></td>
  771. </tr>
  772. </table>
  773. </div><div class="memdoc">
  774. <p>Write multiple 512 byte blocks to an SD card.</p>
  775. <dl class="params"><dt>Parameters</dt><dd>
  776. <table class="params">
  777. <tr><td class="paramdir">[in]</td><td class="paramname">lba</td><td>Logical block to be written. </td></tr>
  778. <tr><td class="paramdir">[in]</td><td class="paramname">nb</td><td>Number of blocks to be written. </td></tr>
  779. <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Pointer to the location of the data to be written. </td></tr>
  780. </table>
  781. </dd>
  782. </dl>
  783. <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>
  784. </div>
  785. </div>
  786. <a id="a9495c0b148eb380358bb4a9721c0dffa"></a>
  787. <h2 class="memtitle"><span class="permalink"><a href="#a9495c0b148eb380358bb4a9721c0dffa">&#9670;&nbsp;</a></span>writeData()</h2>
  788. <div class="memitem">
  789. <div class="memproto">
  790. <table class="memname">
  791. <tr>
  792. <td class="memname">bool SdSpiCard::writeData </td>
  793. <td>(</td>
  794. <td class="paramtype">const uint8_t *&#160;</td>
  795. <td class="paramname"><em>src</em></td><td>)</td>
  796. <td></td>
  797. </tr>
  798. </table>
  799. </div><div class="memdoc">
  800. <p>Write one data block in a multiple block write sequence. </p><dl class="params"><dt>Parameters</dt><dd>
  801. <table class="params">
  802. <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Pointer to the location of the data to be written. </td></tr>
  803. </table>
  804. </dd>
  805. </dl>
  806. <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>
  807. </div>
  808. </div>
  809. <a id="a56d4750a5d2f693943eec985cb61ffe2"></a>
  810. <h2 class="memtitle"><span class="permalink"><a href="#a56d4750a5d2f693943eec985cb61ffe2">&#9670;&nbsp;</a></span>writeStart() <span class="overload">[1/2]</span></h2>
  811. <div class="memitem">
  812. <div class="memproto">
  813. <table class="memname">
  814. <tr>
  815. <td class="memname">bool SdSpiCard::writeStart </td>
  816. <td>(</td>
  817. <td class="paramtype">uint32_t&#160;</td>
  818. <td class="paramname"><em>blockNumber</em></td><td>)</td>
  819. <td></td>
  820. </tr>
  821. </table>
  822. </div><div class="memdoc">
  823. <p>Start a write multiple blocks sequence.</p>
  824. <dl class="params"><dt>Parameters</dt><dd>
  825. <table class="params">
  826. <tr><td class="paramdir">[in]</td><td class="paramname">blockNumber</td><td>Address of first block in sequence.</td></tr>
  827. </table>
  828. </dd>
  829. </dl>
  830. <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>
  831. <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>
  832. </div>
  833. </div>
  834. <a id="a8bf0dc991308dcd2a7427bad89a9e2ba"></a>
  835. <h2 class="memtitle"><span class="permalink"><a href="#a8bf0dc991308dcd2a7427bad89a9e2ba">&#9670;&nbsp;</a></span>writeStart() <span class="overload">[2/2]</span></h2>
  836. <div class="memitem">
  837. <div class="memproto">
  838. <table class="memname">
  839. <tr>
  840. <td class="memname">bool SdSpiCard::writeStart </td>
  841. <td>(</td>
  842. <td class="paramtype">uint32_t&#160;</td>
  843. <td class="paramname"><em>blockNumber</em>, </td>
  844. </tr>
  845. <tr>
  846. <td class="paramkey"></td>
  847. <td></td>
  848. <td class="paramtype">uint32_t&#160;</td>
  849. <td class="paramname"><em>eraseCount</em>&#160;</td>
  850. </tr>
  851. <tr>
  852. <td></td>
  853. <td>)</td>
  854. <td></td><td></td>
  855. </tr>
  856. </table>
  857. </div><div class="memdoc">
  858. <p>Start a write multiple blocks sequence with pre-erase.</p>
  859. <dl class="params"><dt>Parameters</dt><dd>
  860. <table class="params">
  861. <tr><td class="paramdir">[in]</td><td class="paramname">blockNumber</td><td>Address of first block in sequence. </td></tr>
  862. <tr><td class="paramdir">[in]</td><td class="paramname">eraseCount</td><td>The number of blocks to be pre-erased.</td></tr>
  863. </table>
  864. </dd>
  865. </dl>
  866. <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>
  867. <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>
  868. </div>
  869. </div>
  870. <a id="aef9154785a4de5560fb807e4f9316fb0"></a>
  871. <h2 class="memtitle"><span class="permalink"><a href="#aef9154785a4de5560fb807e4f9316fb0">&#9670;&nbsp;</a></span>writeStop()</h2>
  872. <div class="memitem">
  873. <div class="memproto">
  874. <table class="memname">
  875. <tr>
  876. <td class="memname">bool SdSpiCard::writeStop </td>
  877. <td>(</td>
  878. <td class="paramname"></td><td>)</td>
  879. <td></td>
  880. </tr>
  881. </table>
  882. </div><div class="memdoc">
  883. <p>End a write multiple blocks sequence.</p>
  884. <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>
  885. </div>
  886. </div>
  887. <hr/>The documentation for this class was generated from the following files:<ul>
  888. <li>Arduino/libraries/SdFat/src/SdCard/<a class="el" href="_sd_spi_card_8h.html">SdSpiCard.h</a></li>
  889. <li>Arduino/libraries/SdFat/src/SdCard/SdSpiCard.cpp</li>
  890. </ul>
  891. </div><!-- contents -->
  892. <!-- start footer part -->
  893. <hr class="footer"/><address class="footer"><small>
  894. Generated on Fri Dec 28 2018 06:38:31 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  895. <img class="footer" src="doxygen.png" alt="doxygen"/>
  896. </a> 1.8.14
  897. </small></address>
  898. </body>
  899. </html>