class_sd_spi_card.html 43 KB

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