class_sd2_card.html 49 KB

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