class_sd_spi_card.html 47 KB

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