class_sd2_card.html 47 KB

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