visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
60 Commits
1 Branch
Branch: main
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'main'
${ noResults }
teensy-sdfat/extras/html/class_sd_spi_card.html

1070 lines
48KB
Raw Permalink Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.16"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>SdFat: SdSpiCard Class Reference</title>

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  10. <script type="text/javascript" src="jquery.js"></script>

  11. <script type="text/javascript" src="dynsections.js"></script>

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  13. <script type="text/javascript" src="search/searchdata.js"></script>

  14. <script type="text/javascript" src="search/search.js"></script>

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  16. </head>

  17. <body>

  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  19. <div id="titlearea">

  20. <table cellspacing="0" cellpadding="0">

  21.  <tbody>

  22.  <tr style="height: 56px;">

  23.   <td id="projectalign" style="padding-left: 0.5em;">

  24.    <div id="projectname">SdFat

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

  31. <!-- end header part -->

  32. <!-- Generated by Doxygen 1.8.16 -->

  33. <script type="text/javascript">

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

  40. <script type="text/javascript">

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

  44.   $(document).ready(function() { init_search(); });

  45. });

  46. /* @license-end */</script>

  47. <div id="main-nav"></div>

  48. <!-- window showing the filter options -->

  49. <div id="MSearchSelectWindow"

  50.      onmouseover="return searchBox.OnSearchSelectShow()"

  51.      onmouseout="return searchBox.OnSearchSelectHide()"

  52.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  53. </div>

  54. 

  55. <!-- iframe showing the search results (closed by default) -->

  56. <div id="MSearchResultsWindow">

  57. <iframe src="javascript:void(0)" frameborder="0" 

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

  62. </div><!-- top -->

  63. <div class="header">

  64.   <div class="summary">

  65. <a href="#pub-methods">Public Member Functions</a> &#124;

  66. <a href="class_sd_spi_card-members.html">List of all members</a>  </div>

  67.   <div class="headertitle">

  68. <div class="title">SdSpiCard Class Reference</div>  </div>

  69. </div><!--header-->

  70. <div class="contents">

  71. 

  72. <p>Raw access to SD and SDHC flash memory cards via SPI protocol.  

  73.  <a href="class_sd_spi_card.html#details">More...</a></p>

  74. 

  75. <p><code>#include &lt;SdSpiCard.h&gt;</code></p>

  76. <table class="memberdecls">

  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  78. Public Member Functions</h2></td></tr>

  79. <tr class="memitem:acb1d0d8b9c5452cffdd5b3ae46e3eafe"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#acb1d0d8b9c5452cffdd5b3ae46e3eafe">begin</a> (<a class="el" href="_sd_spi_arduino_driver_8h.html#a737a41f87fd0d1824d87d83a1f976c14">SdSpiDriver</a> *spi, <a class="el" href="class_sd_spi_config.html">SdSpiConfig</a> spiConfig)</td></tr>

  80. <tr class="separator:acb1d0d8b9c5452cffdd5b3ae46e3eafe"><td class="memSeparator" colspan="2">&#160;</td></tr>

  81. <tr class="memitem:ab6cf8283dee415d9217eb758e75a98ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#ab6cf8283dee415d9217eb758e75a98ef">dbgClearStats</a> ()</td></tr>

  82. <tr class="separator:ab6cf8283dee415d9217eb758e75a98ef"><td class="memSeparator" colspan="2">&#160;</td></tr>

  83. <tr class="memitem:abdb02df511072aefb465a22858d92e06"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#abdb02df511072aefb465a22858d92e06">dbgPrintStats</a> ()</td></tr>

  84. <tr class="separator:abdb02df511072aefb465a22858d92e06"><td class="memSeparator" colspan="2">&#160;</td></tr>

  85. <tr class="memitem:a904d56312d7a9cfc8bf33e3ad041c9eb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a904d56312d7a9cfc8bf33e3ad041c9eb">erase</a> (uint32_t firstSector, uint32_t lastSector)</td></tr>

  86. <tr class="separator:a904d56312d7a9cfc8bf33e3ad041c9eb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  87. <tr class="memitem:a1b137a1ab76da21379bc59efeac90e1f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a1b137a1ab76da21379bc59efeac90e1f">eraseSingleSectorEnable</a> ()</td></tr>

  88. <tr class="separator:a1b137a1ab76da21379bc59efeac90e1f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  89. <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>

  90. <tr class="separator:aa12ad53111abcb187d3c6119a3a77592"><td class="memSeparator" colspan="2">&#160;</td></tr>

  91. <tr class="memitem:ad14f9be4d9087db44309fdc6597c949e"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#ad14f9be4d9087db44309fdc6597c949e">errorCode</a> () const</td></tr>

  92. <tr class="separator:ad14f9be4d9087db44309fdc6597c949e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  93. <tr class="memitem:aae2cc2a741646bb2aaabaf0547298de8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#aae2cc2a741646bb2aaabaf0547298de8">errorData</a> () const</td></tr>

  94. <tr class="separator:aae2cc2a741646bb2aaabaf0547298de8"><td class="memSeparator" colspan="2">&#160;</td></tr>

  95. <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>

  96. <tr class="separator:aa3cb9139dbc1e6596c6717da2b486328"><td class="memSeparator" colspan="2">&#160;</td></tr>

  97. <tr class="memitem:aa073dc42828164883db1b9faeff909ea"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#aa073dc42828164883db1b9faeff909ea">readCID</a> (<a class="el" href="struct_c_i_d.html">cid_t</a> *cid)</td></tr>

  98. <tr class="separator:aa073dc42828164883db1b9faeff909ea"><td class="memSeparator" colspan="2">&#160;</td></tr>

  99. <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>

  100. <tr class="separator:a9fbea9525e70f6e3602fe5153a5a1290"><td class="memSeparator" colspan="2">&#160;</td></tr>

  101. <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>

  102. <tr class="separator:a3a1d1b4b4ceb42fcd41aaf6649482770"><td class="memSeparator" colspan="2">&#160;</td></tr>

  103. <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>

  104. <tr class="separator:ab446e49338b3ce834a750ac6dae35f61"><td class="memSeparator" colspan="2">&#160;</td></tr>

  105. <tr class="memitem:adbdb4df6d74ffa21df7f19a46c781f17"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#adbdb4df6d74ffa21df7f19a46c781f17">readSector</a> (uint32_t sector, uint8_t *dst)</td></tr>

  106. <tr class="separator:adbdb4df6d74ffa21df7f19a46c781f17"><td class="memSeparator" colspan="2">&#160;</td></tr>

  107. <tr class="memitem:a248a56a6b15182c4d558f497c99fbf15"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a248a56a6b15182c4d558f497c99fbf15">readSectors</a> (uint32_t sector, uint8_t *dst, size_t ns)</td></tr>

  108. <tr class="separator:a248a56a6b15182c4d558f497c99fbf15"><td class="memSeparator" colspan="2">&#160;</td></tr>

  109. <tr class="memitem:a6eb6241369637ca07c0d1c3fe303750d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a6eb6241369637ca07c0d1c3fe303750d">readSingle</a> (uint32_t sector, uint8_t *dst)</td></tr>

  110. <tr class="separator:a6eb6241369637ca07c0d1c3fe303750d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  111. <tr class="memitem:a6f10180a070fa01834cef47e70649a8e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a6f10180a070fa01834cef47e70649a8e">readStart</a> (uint32_t sector)</td></tr>

  112. <tr class="separator:a6f10180a070fa01834cef47e70649a8e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  113. <tr class="memitem:a91d0413599efe0d63c8c2dfe4a12d9ae"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a91d0413599efe0d63c8c2dfe4a12d9ae">readStatus</a> (uint8_t *status)</td></tr>

  114. <tr class="separator:a91d0413599efe0d63c8c2dfe4a12d9ae"><td class="memSeparator" colspan="2">&#160;</td></tr>

  115. <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>

  116. <tr class="separator:afdac7c399fa1ba3f904cf503526e007e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  117. <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>

  118. <tr class="separator:a0441c5da53bd3bd72fb833fc940f25e8"><td class="memSeparator" colspan="2">&#160;</td></tr>

  119. <tr class="memitem:a463ee796cf57c7e3e93f7817895fc492"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a463ee796cf57c7e3e93f7817895fc492">sectorCount</a> ()</td></tr>

  120. <tr class="separator:a463ee796cf57c7e3e93f7817895fc492"><td class="memSeparator" colspan="2">&#160;</td></tr>

  121. <tr class="memitem:aa39feb6ebb269071ac6843a424ac311c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#aa39feb6ebb269071ac6843a424ac311c">spiStart</a> ()</td></tr>

  122. <tr class="separator:aa39feb6ebb269071ac6843a424ac311c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  123. <tr class="memitem:a1033a4a68d38f52dddf6a1764fcca3e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a1033a4a68d38f52dddf6a1764fcca3e1">spiStop</a> ()</td></tr>

  124. <tr class="separator:a1033a4a68d38f52dddf6a1764fcca3e1"><td class="memSeparator" colspan="2">&#160;</td></tr>

  125. <tr class="memitem:ac9f3bfbfc5029f93da1fa233cbe617c4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#ac9f3bfbfc5029f93da1fa233cbe617c4">syncDevice</a> ()</td></tr>

  126. <tr class="separator:ac9f3bfbfc5029f93da1fa233cbe617c4"><td class="memSeparator" colspan="2">&#160;</td></tr>

  127. <tr class="memitem:ac53e0f3575db5be26dcba825bab3ca12"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#ac53e0f3575db5be26dcba825bab3ca12">type</a> () const</td></tr>

  128. <tr class="separator:ac53e0f3575db5be26dcba825bab3ca12"><td class="memSeparator" colspan="2">&#160;</td></tr>

  129. <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>

  130. <tr class="separator:a9495c0b148eb380358bb4a9721c0dffa"><td class="memSeparator" colspan="2">&#160;</td></tr>

  131. <tr class="memitem:a9a230924d82c5df07df592c571bc3fa5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a9a230924d82c5df07df592c571bc3fa5">writeSector</a> (uint32_t sector, const uint8_t *src)</td></tr>

  132. <tr class="separator:a9a230924d82c5df07df592c571bc3fa5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  133. <tr class="memitem:a4165166d5d038c8f1c00c5a04e9f8a63"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a4165166d5d038c8f1c00c5a04e9f8a63">writeSectors</a> (uint32_t sector, const uint8_t *src, size_t ns)</td></tr>

  134. <tr class="separator:a4165166d5d038c8f1c00c5a04e9f8a63"><td class="memSeparator" colspan="2">&#160;</td></tr>

  135. <tr class="memitem:a3172d671447410f19447b78b856a9689"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a3172d671447410f19447b78b856a9689">writeSingle</a> (uint32_t sector, const uint8_t *src)</td></tr>

  136. <tr class="separator:a3172d671447410f19447b78b856a9689"><td class="memSeparator" colspan="2">&#160;</td></tr>

  137. <tr class="memitem:ae46068850a0cb9f142d5b0b0147716fa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#ae46068850a0cb9f142d5b0b0147716fa">writeStart</a> (uint32_t sector)</td></tr>

  138. <tr class="separator:ae46068850a0cb9f142d5b0b0147716fa"><td class="memSeparator" colspan="2">&#160;</td></tr>

  139. <tr class="memitem:a785250ef0281fbb1cbe5078de9e80be3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_card.html#a785250ef0281fbb1cbe5078de9e80be3">writeStart</a> (uint32_t sector, uint32_t eraseCount)</td></tr>

  140. <tr class="separator:a785250ef0281fbb1cbe5078de9e80be3"><td class="memSeparator" colspan="2">&#160;</td></tr>

  141. <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>

  142. <tr class="separator:aef9154785a4de5560fb807e4f9316fb0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  143. </table>

  144. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  145. <div class="textblock"><p>Raw access to SD and SDHC flash memory cards via SPI protocol. </p>

  146. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  147. <a id="a0441c5da53bd3bd72fb833fc940f25e8"></a>

  148. <h2 class="memtitle"><span class="permalink"><a href="#a0441c5da53bd3bd72fb833fc940f25e8">&#9670;&nbsp;</a></span>SdSpiCard()</h2>

  149. 

  150. <div class="memitem">

  151. <div class="memproto">

  152. <table class="mlabels">

  153.   <tr>

  154.   <td class="mlabels-left">

  155.       <table class="memname">

  156.         <tr>

  157.           <td class="memname">SdSpiCard::SdSpiCard </td>

  158.           <td>(</td>

  159.           <td class="paramname"></td><td>)</td>

  160.           <td></td>

  161.         </tr>

  162.       </table>

  163.   </td>

  164.   <td class="mlabels-right">

  165. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  166.   </tr>

  167. </table>

  168. </div><div class="memdoc">

  169. <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>

  170. 

  171. </div>

  172. </div>

  173. <h2 class="groupheader">Member Function Documentation</h2>

  174. <a id="acb1d0d8b9c5452cffdd5b3ae46e3eafe"></a>

  175. <h2 class="memtitle"><span class="permalink"><a href="#acb1d0d8b9c5452cffdd5b3ae46e3eafe">&#9670;&nbsp;</a></span>begin()</h2>

  176. 

  177. <div class="memitem">

  178. <div class="memproto">

  179.       <table class="memname">

  180.         <tr>

  181.           <td class="memname">bool SdSpiCard::begin </td>

  182.           <td>(</td>

  183.           <td class="paramtype"><a class="el" href="_sd_spi_arduino_driver_8h.html#a737a41f87fd0d1824d87d83a1f976c14">SdSpiDriver</a> *&#160;</td>

  184.           <td class="paramname"><em>spi</em>, </td>

  185.         </tr>

  186.         <tr>

  187.           <td class="paramkey"></td>

  188.           <td></td>

  189.           <td class="paramtype"><a class="el" href="class_sd_spi_config.html">SdSpiConfig</a>&#160;</td>

  190.           <td class="paramname"><em>spiConfig</em>&#160;</td>

  191.         </tr>

  192.         <tr>

  193.           <td></td>

  194.           <td>)</td>

  195.           <td></td><td></td>

  196.         </tr>

  197.       </table>

  198. </div><div class="memdoc">

  199. <p>Initialize the SD card. </p><dl class="params"><dt>Parameters</dt><dd>

  200.   <table class="params">

  201.     <tr><td class="paramdir">[in]</td><td class="paramname">spi</td><td>SPI driver for card. </td></tr>

  202.     <tr><td class="paramdir">[in]</td><td class="paramname">spiConfig</td><td>SPI card configuration. </td></tr>

  203.   </table>

  204.   </dd>

  205. </dl>

  206. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  207. 

  208. </div>

  209. </div>

  210. <a id="ab6cf8283dee415d9217eb758e75a98ef"></a>

  211. <h2 class="memtitle"><span class="permalink"><a href="#ab6cf8283dee415d9217eb758e75a98ef">&#9670;&nbsp;</a></span>dbgClearStats()</h2>

  212. 

  213. <div class="memitem">

  214. <div class="memproto">

  215.       <table class="memname">

  216.         <tr>

  217.           <td class="memname">void SdSpiCard::dbgClearStats </td>

  218.           <td>(</td>

  219.           <td class="paramname"></td><td>)</td>

  220.           <td></td>

  221.         </tr>

  222.       </table>

  223. </div><div class="memdoc">

  224. <p>Clear debug stats. </p>

  225. 

  226. </div>

  227. </div>

  228. <a id="abdb02df511072aefb465a22858d92e06"></a>

  229. <h2 class="memtitle"><span class="permalink"><a href="#abdb02df511072aefb465a22858d92e06">&#9670;&nbsp;</a></span>dbgPrintStats()</h2>

  230. 

  231. <div class="memitem">

  232. <div class="memproto">

  233.       <table class="memname">

  234.         <tr>

  235.           <td class="memname">void SdSpiCard::dbgPrintStats </td>

  236.           <td>(</td>

  237.           <td class="paramname"></td><td>)</td>

  238.           <td></td>

  239.         </tr>

  240.       </table>

  241. </div><div class="memdoc">

  242. <p>Print debug stats. </p>

  243. 

  244. </div>

  245. </div>

  246. <a id="a904d56312d7a9cfc8bf33e3ad041c9eb"></a>

  247. <h2 class="memtitle"><span class="permalink"><a href="#a904d56312d7a9cfc8bf33e3ad041c9eb">&#9670;&nbsp;</a></span>erase()</h2>

  248. 

  249. <div class="memitem">

  250. <div class="memproto">

  251.       <table class="memname">

  252.         <tr>

  253.           <td class="memname">bool SdSpiCard::erase </td>

  254.           <td>(</td>

  255.           <td class="paramtype">uint32_t&#160;</td>

  256.           <td class="paramname"><em>firstSector</em>, </td>

  257.         </tr>

  258.         <tr>

  259.           <td class="paramkey"></td>

  260.           <td></td>

  261.           <td class="paramtype">uint32_t&#160;</td>

  262.           <td class="paramname"><em>lastSector</em>&#160;</td>

  263.         </tr>

  264.         <tr>

  265.           <td></td>

  266.           <td>)</td>

  267.           <td></td><td></td>

  268.         </tr>

  269.       </table>

  270. </div><div class="memdoc">

  271. <p>Erase a range of sectors.</p>

  272. <dl class="params"><dt>Parameters</dt><dd>

  273.   <table class="params">

  274.     <tr><td class="paramdir">[in]</td><td class="paramname">firstSector</td><td>The address of the first sector in the range. </td></tr>

  275.     <tr><td class="paramdir">[in]</td><td class="paramname">lastSector</td><td>The address of the last sector in the range.</td></tr>

  276.   </table>

  277.   </dd>

  278. </dl>

  279. <dl class="section note"><dt>Note</dt><dd>This function requests the SD card to do a flash erase for a range of sectors. The data on the card after an erase operation is either 0 or 1, depends on the card vendor. The card must support single sector erase.</dd></dl>

  280. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  281. 

  282. </div>

  283. </div>

  284. <a id="a1b137a1ab76da21379bc59efeac90e1f"></a>

  285. <h2 class="memtitle"><span class="permalink"><a href="#a1b137a1ab76da21379bc59efeac90e1f">&#9670;&nbsp;</a></span>eraseSingleSectorEnable()</h2>

  286. 

  287. <div class="memitem">

  288. <div class="memproto">

  289.       <table class="memname">

  290.         <tr>

  291.           <td class="memname">bool SdSpiCard::eraseSingleSectorEnable </td>

  292.           <td>(</td>

  293.           <td class="paramname"></td><td>)</td>

  294.           <td></td>

  295.         </tr>

  296.       </table>

  297. </div><div class="memdoc">

  298. <p>Determine if card supports single sector erase.</p>

  299. <dl class="section return"><dt>Returns</dt><dd>true is returned if single sector erase is supported. false is returned if single sector erase is not supported. </dd></dl>

  300. 

  301. </div>

  302. </div>

  303. <a id="aa12ad53111abcb187d3c6119a3a77592"></a>

  304. <h2 class="memtitle"><span class="permalink"><a href="#aa12ad53111abcb187d3c6119a3a77592">&#9670;&nbsp;</a></span>error()</h2>

  305. 

  306. <div class="memitem">

  307. <div class="memproto">

  308. <table class="mlabels">

  309.   <tr>

  310.   <td class="mlabels-left">

  311.       <table class="memname">

  312.         <tr>

  313.           <td class="memname">void SdSpiCard::error </td>

  314.           <td>(</td>

  315.           <td class="paramtype">uint8_t&#160;</td>

  316.           <td class="paramname"><em>code</em></td><td>)</td>

  317.           <td></td>

  318.         </tr>

  319.       </table>

  320.   </td>

  321.   <td class="mlabels-right">

  322. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  323.   </tr>

  324. </table>

  325. </div><div class="memdoc">

  326. <p>Set SD error code. </p><dl class="params"><dt>Parameters</dt><dd>

  327.   <table class="params">

  328.     <tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>value for error code. </td></tr>

  329.   </table>

  330.   </dd>

  331. </dl>

  332. 

  333. </div>

  334. </div>

  335. <a id="ad14f9be4d9087db44309fdc6597c949e"></a>

  336. <h2 class="memtitle"><span class="permalink"><a href="#ad14f9be4d9087db44309fdc6597c949e">&#9670;&nbsp;</a></span>errorCode()</h2>

  337. 

  338. <div class="memitem">

  339. <div class="memproto">

  340. <table class="mlabels">

  341.   <tr>

  342.   <td class="mlabels-left">

  343.       <table class="memname">

  344.         <tr>

  345.           <td class="memname">uint8_t SdSpiCard::errorCode </td>

  346.           <td>(</td>

  347.           <td class="paramname"></td><td>)</td>

  348.           <td> const</td>

  349.         </tr>

  350.       </table>

  351.   </td>

  352.   <td class="mlabels-right">

  353. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  354.   </tr>

  355. </table>

  356. </div><div class="memdoc">

  357. <dl class="section return"><dt>Returns</dt><dd>code for the last error. See SdCardInfo.h for a list of error codes. </dd></dl>

  358. 

  359. </div>

  360. </div>

  361. <a id="aae2cc2a741646bb2aaabaf0547298de8"></a>

  362. <h2 class="memtitle"><span class="permalink"><a href="#aae2cc2a741646bb2aaabaf0547298de8">&#9670;&nbsp;</a></span>errorData()</h2>

  363. 

  364. <div class="memitem">

  365. <div class="memproto">

  366. <table class="mlabels">

  367.   <tr>

  368.   <td class="mlabels-left">

  369.       <table class="memname">

  370.         <tr>

  371.           <td class="memname">uint32_t SdSpiCard::errorData </td>

  372.           <td>(</td>

  373.           <td class="paramname"></td><td>)</td>

  374.           <td> const</td>

  375.         </tr>

  376.       </table>

  377.   </td>

  378.   <td class="mlabels-right">

  379. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  380.   </tr>

  381. </table>

  382. </div><div class="memdoc">

  383. <dl class="section return"><dt>Returns</dt><dd>error data for last error. </dd></dl>

  384. 

  385. </div>

  386. </div>

  387. <a id="aa3cb9139dbc1e6596c6717da2b486328"></a>

  388. <h2 class="memtitle"><span class="permalink"><a href="#aa3cb9139dbc1e6596c6717da2b486328">&#9670;&nbsp;</a></span>isBusy()</h2>

  389. 

  390. <div class="memitem">

  391. <div class="memproto">

  392.       <table class="memname">

  393.         <tr>

  394.           <td class="memname">bool SdSpiCard::isBusy </td>

  395.           <td>(</td>

  396.           <td class="paramname"></td><td>)</td>

  397.           <td></td>

  398.         </tr>

  399.       </table>

  400. </div><div class="memdoc">

  401. <p>Check for busy. MISO low indicates the card is busy.</p>

  402. <dl class="section return"><dt>Returns</dt><dd>true if busy else false. </dd></dl>

  403. 

  404. </div>

  405. </div>

  406. <a id="aa073dc42828164883db1b9faeff909ea"></a>

  407. <h2 class="memtitle"><span class="permalink"><a href="#aa073dc42828164883db1b9faeff909ea">&#9670;&nbsp;</a></span>readCID()</h2>

  408. 

  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">bool SdSpiCard::readCID </td>

  417.           <td>(</td>

  418.           <td class="paramtype"><a class="el" href="struct_c_i_d.html">cid_t</a> *&#160;</td>

  419.           <td class="paramname"><em>cid</em></td><td>)</td>

  420.           <td></td>

  421.         </tr>

  422.       </table>

  423.   </td>

  424.   <td class="mlabels-right">

  425. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  426.   </tr>

  427. </table>

  428. </div><div class="memdoc">

  429. <p>Read a card's <a class="el" href="struct_c_i_d.html" title="Card IDentification (CID) register.">CID</a> register. The <a class="el" href="struct_c_i_d.html" title="Card IDentification (CID) register.">CID</a> contains card identification information such as Manufacturer ID, Product name, Product serial number and Manufacturing date.</p>

  430. <dl class="params"><dt>Parameters</dt><dd>

  431.   <table class="params">

  432.     <tr><td class="paramdir">[out]</td><td class="paramname">cid</td><td>pointer to area for returned data.</td></tr>

  433.   </table>

  434.   </dd>

  435. </dl>

  436. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  437. 

  438. </div>

  439. </div>

  440. <a id="a9fbea9525e70f6e3602fe5153a5a1290"></a>

  441. <h2 class="memtitle"><span class="permalink"><a href="#a9fbea9525e70f6e3602fe5153a5a1290">&#9670;&nbsp;</a></span>readCSD()</h2>

  442. 

  443. <div class="memitem">

  444. <div class="memproto">

  445. <table class="mlabels">

  446.   <tr>

  447.   <td class="mlabels-left">

  448.       <table class="memname">

  449.         <tr>

  450.           <td class="memname">bool SdSpiCard::readCSD </td>

  451.           <td>(</td>

  452.           <td class="paramtype">csd_t *&#160;</td>

  453.           <td class="paramname"><em>csd</em></td><td>)</td>

  454.           <td></td>

  455.         </tr>

  456.       </table>

  457.   </td>

  458.   <td class="mlabels-right">

  459. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  460.   </tr>

  461. </table>

  462. </div><div class="memdoc">

  463. <p>Read a card's CSD register. The CSD contains Card-Specific Data that provides information regarding access to the card's contents.</p>

  464. <dl class="params"><dt>Parameters</dt><dd>

  465.   <table class="params">

  466.     <tr><td class="paramdir">[out]</td><td class="paramname">csd</td><td>pointer to area for returned data.</td></tr>

  467.   </table>

  468.   </dd>

  469. </dl>

  470. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  471. 

  472. </div>

  473. </div>

  474. <a id="a3a1d1b4b4ceb42fcd41aaf6649482770"></a>

  475. <h2 class="memtitle"><span class="permalink"><a href="#a3a1d1b4b4ceb42fcd41aaf6649482770">&#9670;&nbsp;</a></span>readData()</h2>

  476. 

  477. <div class="memitem">

  478. <div class="memproto">

  479.       <table class="memname">

  480.         <tr>

  481.           <td class="memname">bool SdSpiCard::readData </td>

  482.           <td>(</td>

  483.           <td class="paramtype">uint8_t *&#160;</td>

  484.           <td class="paramname"><em>dst</em></td><td>)</td>

  485.           <td></td>

  486.         </tr>

  487.       </table>

  488. </div><div class="memdoc">

  489. <p>Read one data sector in a multiple sector read sequence</p>

  490. <dl class="params"><dt>Parameters</dt><dd>

  491.   <table class="params">

  492.     <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Pointer to the location for the data to be read.</td></tr>

  493.   </table>

  494.   </dd>

  495. </dl>

  496. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  497. 

  498. </div>

  499. </div>

  500. <a id="ab446e49338b3ce834a750ac6dae35f61"></a>

  501. <h2 class="memtitle"><span class="permalink"><a href="#ab446e49338b3ce834a750ac6dae35f61">&#9670;&nbsp;</a></span>readOCR()</h2>

  502. 

  503. <div class="memitem">

  504. <div class="memproto">

  505.       <table class="memname">

  506.         <tr>

  507.           <td class="memname">bool SdSpiCard::readOCR </td>

  508.           <td>(</td>

  509.           <td class="paramtype">uint32_t *&#160;</td>

  510.           <td class="paramname"><em>ocr</em></td><td>)</td>

  511.           <td></td>

  512.         </tr>

  513.       </table>

  514. </div><div class="memdoc">

  515. <p>Read OCR register.</p>

  516. <dl class="params"><dt>Parameters</dt><dd>

  517.   <table class="params">

  518.     <tr><td class="paramdir">[out]</td><td class="paramname">ocr</td><td>Value of OCR register. </td></tr>

  519.   </table>

  520.   </dd>

  521. </dl>

  522. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  523. 

  524. </div>

  525. </div>

  526. <a id="adbdb4df6d74ffa21df7f19a46c781f17"></a>

  527. <h2 class="memtitle"><span class="permalink"><a href="#adbdb4df6d74ffa21df7f19a46c781f17">&#9670;&nbsp;</a></span>readSector()</h2>

  528. 

  529. <div class="memitem">

  530. <div class="memproto">

  531. <table class="mlabels">

  532.   <tr>

  533.   <td class="mlabels-left">

  534.       <table class="memname">

  535.         <tr>

  536.           <td class="memname">bool SdSpiCard::readSector </td>

  537.           <td>(</td>

  538.           <td class="paramtype">uint32_t&#160;</td>

  539.           <td class="paramname"><em>sector</em>, </td>

  540.         </tr>

  541.         <tr>

  542.           <td class="paramkey"></td>

  543.           <td></td>

  544.           <td class="paramtype">uint8_t *&#160;</td>

  545.           <td class="paramname"><em>dst</em>&#160;</td>

  546.         </tr>

  547.         <tr>

  548.           <td></td>

  549.           <td>)</td>

  550.           <td></td><td></td>

  551.         </tr>

  552.       </table>

  553.   </td>

  554.   <td class="mlabels-right">

  555. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  556.   </tr>

  557. </table>

  558. </div><div class="memdoc">

  559. <p>Read a 512 byte sector from an SD card.</p>

  560. <dl class="params"><dt>Parameters</dt><dd>

  561.   <table class="params">

  562.     <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Logical sector to be read. </td></tr>

  563.     <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Pointer to the location that will receive the data. </td></tr>

  564.   </table>

  565.   </dd>

  566. </dl>

  567. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  568. 

  569. </div>

  570. </div>

  571. <a id="a248a56a6b15182c4d558f497c99fbf15"></a>

  572. <h2 class="memtitle"><span class="permalink"><a href="#a248a56a6b15182c4d558f497c99fbf15">&#9670;&nbsp;</a></span>readSectors()</h2>

  573. 

  574. <div class="memitem">

  575. <div class="memproto">

  576.       <table class="memname">

  577.         <tr>

  578.           <td class="memname">bool SdSpiCard::readSectors </td>

  579.           <td>(</td>

  580.           <td class="paramtype">uint32_t&#160;</td>

  581.           <td class="paramname"><em>sector</em>, </td>

  582.         </tr>

  583.         <tr>

  584.           <td class="paramkey"></td>

  585.           <td></td>

  586.           <td class="paramtype">uint8_t *&#160;</td>

  587.           <td class="paramname"><em>dst</em>, </td>

  588.         </tr>

  589.         <tr>

  590.           <td class="paramkey"></td>

  591.           <td></td>

  592.           <td class="paramtype">size_t&#160;</td>

  593.           <td class="paramname"><em>ns</em>&#160;</td>

  594.         </tr>

  595.         <tr>

  596.           <td></td>

  597.           <td>)</td>

  598.           <td></td><td></td>

  599.         </tr>

  600.       </table>

  601. </div><div class="memdoc">

  602. <p>Read multiple 512 byte sectors from an SD card.</p>

  603. <dl class="params"><dt>Parameters</dt><dd>

  604.   <table class="params">

  605.     <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Logical sector to be read. </td></tr>

  606.     <tr><td class="paramdir">[in]</td><td class="paramname">ns</td><td>Number of sectors to be read. </td></tr>

  607.     <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Pointer to the location that will receive the data. </td></tr>

  608.   </table>

  609.   </dd>

  610. </dl>

  611. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  612. 

  613. </div>

  614. </div>

  615. <a id="a6eb6241369637ca07c0d1c3fe303750d"></a>

  616. <h2 class="memtitle"><span class="permalink"><a href="#a6eb6241369637ca07c0d1c3fe303750d">&#9670;&nbsp;</a></span>readSingle()</h2>

  617. 

  618. <div class="memitem">

  619. <div class="memproto">

  620.       <table class="memname">

  621.         <tr>

  622.           <td class="memname">bool SdSpiCard::readSingle </td>

  623.           <td>(</td>

  624.           <td class="paramtype">uint32_t&#160;</td>

  625.           <td class="paramname"><em>sector</em>, </td>

  626.         </tr>

  627.         <tr>

  628.           <td class="paramkey"></td>

  629.           <td></td>

  630.           <td class="paramtype">uint8_t *&#160;</td>

  631.           <td class="paramname"><em>dst</em>&#160;</td>

  632.         </tr>

  633.         <tr>

  634.           <td></td>

  635.           <td>)</td>

  636.           <td></td><td></td>

  637.         </tr>

  638.       </table>

  639. </div><div class="memdoc">

  640. <p>Read a 512 byte sector from an SD card.</p>

  641. <dl class="params"><dt>Parameters</dt><dd>

  642.   <table class="params">

  643.     <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Logical sector to be read. </td></tr>

  644.     <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Pointer to the location that will receive the data. </td></tr>

  645.   </table>

  646.   </dd>

  647. </dl>

  648. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  649. 

  650. </div>

  651. </div>

  652. <a id="a6f10180a070fa01834cef47e70649a8e"></a>

  653. <h2 class="memtitle"><span class="permalink"><a href="#a6f10180a070fa01834cef47e70649a8e">&#9670;&nbsp;</a></span>readStart()</h2>

  654. 

  655. <div class="memitem">

  656. <div class="memproto">

  657.       <table class="memname">

  658.         <tr>

  659.           <td class="memname">bool SdSpiCard::readStart </td>

  660.           <td>(</td>

  661.           <td class="paramtype">uint32_t&#160;</td>

  662.           <td class="paramname"><em>sector</em></td><td>)</td>

  663.           <td></td>

  664.         </tr>

  665.       </table>

  666. </div><div class="memdoc">

  667. <p>Start a read multiple sector sequence.</p>

  668. <dl class="params"><dt>Parameters</dt><dd>

  669.   <table class="params">

  670.     <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Address of first sector in sequence.</td></tr>

  671.   </table>

  672.   </dd>

  673. </dl>

  674. <dl class="section note"><dt>Note</dt><dd>This function is used with <a class="el" href="class_sd_spi_card.html#a3a1d1b4b4ceb42fcd41aaf6649482770">readData()</a> and <a class="el" href="class_sd_spi_card.html#afdac7c399fa1ba3f904cf503526e007e">readStop()</a> for optimized multiple sector reads. SPI chipSelect must be low for the entire sequence.</dd></dl>

  675. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  676. 

  677. </div>

  678. </div>

  679. <a id="a91d0413599efe0d63c8c2dfe4a12d9ae"></a>

  680. <h2 class="memtitle"><span class="permalink"><a href="#a91d0413599efe0d63c8c2dfe4a12d9ae">&#9670;&nbsp;</a></span>readStatus()</h2>

  681. 

  682. <div class="memitem">

  683. <div class="memproto">

  684.       <table class="memname">

  685.         <tr>

  686.           <td class="memname">bool SdSpiCard::readStatus </td>

  687.           <td>(</td>

  688.           <td class="paramtype">uint8_t *&#160;</td>

  689.           <td class="paramname"><em>status</em></td><td>)</td>

  690.           <td></td>

  691.         </tr>

  692.       </table>

  693. </div><div class="memdoc">

  694. <p>Return the 64 byte card status </p><dl class="params"><dt>Parameters</dt><dd>

  695.   <table class="params">

  696.     <tr><td class="paramdir">[out]</td><td class="paramname">status</td><td>location for 64 status bytes. </td></tr>

  697.   </table>

  698.   </dd>

  699. </dl>

  700. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  701. 

  702. </div>

  703. </div>

  704. <a id="afdac7c399fa1ba3f904cf503526e007e"></a>

  705. <h2 class="memtitle"><span class="permalink"><a href="#afdac7c399fa1ba3f904cf503526e007e">&#9670;&nbsp;</a></span>readStop()</h2>

  706. 

  707. <div class="memitem">

  708. <div class="memproto">

  709.       <table class="memname">

  710.         <tr>

  711.           <td class="memname">bool SdSpiCard::readStop </td>

  712.           <td>(</td>

  713.           <td class="paramname"></td><td>)</td>

  714.           <td></td>

  715.         </tr>

  716.       </table>

  717. </div><div class="memdoc">

  718. <p>End a read multiple sectors sequence.</p>

  719. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  720. 

  721. </div>

  722. </div>

  723. <a id="a463ee796cf57c7e3e93f7817895fc492"></a>

  724. <h2 class="memtitle"><span class="permalink"><a href="#a463ee796cf57c7e3e93f7817895fc492">&#9670;&nbsp;</a></span>sectorCount()</h2>

  725. 

  726. <div class="memitem">

  727. <div class="memproto">

  728.       <table class="memname">

  729.         <tr>

  730.           <td class="memname">uint32_t SdSpiCard::sectorCount </td>

  731.           <td>(</td>

  732.           <td class="paramname"></td><td>)</td>

  733.           <td></td>

  734.         </tr>

  735.       </table>

  736. </div><div class="memdoc">

  737. <p>Determine the size of an SD flash memory card.</p>

  738. <dl class="section return"><dt>Returns</dt><dd>The number of 512 byte data sectors in the card or zero if an error occurs. </dd></dl>

  739. 

  740. </div>

  741. </div>

  742. <a id="aa39feb6ebb269071ac6843a424ac311c"></a>

  743. <h2 class="memtitle"><span class="permalink"><a href="#aa39feb6ebb269071ac6843a424ac311c">&#9670;&nbsp;</a></span>spiStart()</h2>

  744. 

  745. <div class="memitem">

  746. <div class="memproto">

  747.       <table class="memname">

  748.         <tr>

  749.           <td class="memname">void SdSpiCard::spiStart </td>

  750.           <td>(</td>

  751.           <td class="paramname"></td><td>)</td>

  752.           <td></td>

  753.         </tr>

  754.       </table>

  755. </div><div class="memdoc">

  756. <p>Set CS low and activate the card. </p>

  757. 

  758. </div>

  759. </div>

  760. <a id="a1033a4a68d38f52dddf6a1764fcca3e1"></a>

  761. <h2 class="memtitle"><span class="permalink"><a href="#a1033a4a68d38f52dddf6a1764fcca3e1">&#9670;&nbsp;</a></span>spiStop()</h2>

  762. 

  763. <div class="memitem">

  764. <div class="memproto">

  765.       <table class="memname">

  766.         <tr>

  767.           <td class="memname">void SdSpiCard::spiStop </td>

  768.           <td>(</td>

  769.           <td class="paramname"></td><td>)</td>

  770.           <td></td>

  771.         </tr>

  772.       </table>

  773. </div><div class="memdoc">

  774. <p>Set CS high and deactivate the card. </p>

  775. 

  776. </div>

  777. </div>

  778. <a id="ac9f3bfbfc5029f93da1fa233cbe617c4"></a>

  779. <h2 class="memtitle"><span class="permalink"><a href="#ac9f3bfbfc5029f93da1fa233cbe617c4">&#9670;&nbsp;</a></span>syncDevice()</h2>

  780. 

  781. <div class="memitem">

  782. <div class="memproto">

  783.       <table class="memname">

  784.         <tr>

  785.           <td class="memname">bool SdSpiCard::syncDevice </td>

  786.           <td>(</td>

  787.           <td class="paramname"></td><td>)</td>

  788.           <td></td>

  789.         </tr>

  790.       </table>

  791. </div><div class="memdoc">

  792. <dl class="section return"><dt>Returns</dt><dd>success if sync successful. Not for user apps. </dd></dl>

  793. 

  794. </div>

  795. </div>

  796. <a id="ac53e0f3575db5be26dcba825bab3ca12"></a>

  797. <h2 class="memtitle"><span class="permalink"><a href="#ac53e0f3575db5be26dcba825bab3ca12">&#9670;&nbsp;</a></span>type()</h2>

  798. 

  799. <div class="memitem">

  800. <div class="memproto">

  801. <table class="mlabels">

  802.   <tr>

  803.   <td class="mlabels-left">

  804.       <table class="memname">

  805.         <tr>

  806.           <td class="memname">uint8_t SdSpiCard::type </td>

  807.           <td>(</td>

  808.           <td class="paramname"></td><td>)</td>

  809.           <td> const</td>

  810.         </tr>

  811.       </table>

  812.   </td>

  813.   <td class="mlabels-right">

  814. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  815.   </tr>

  816. </table>

  817. </div><div class="memdoc">

  818. <p>Return the card type: SD V1, SD V2 or SDHC/SDXC </p><dl class="section return"><dt>Returns</dt><dd>0 - SD V1, 1 - SD V2, or 3 - SDHC/SDXC. </dd></dl>

  819. 

  820. </div>

  821. </div>

  822. <a id="a9495c0b148eb380358bb4a9721c0dffa"></a>

  823. <h2 class="memtitle"><span class="permalink"><a href="#a9495c0b148eb380358bb4a9721c0dffa">&#9670;&nbsp;</a></span>writeData()</h2>

  824. 

  825. <div class="memitem">

  826. <div class="memproto">

  827.       <table class="memname">

  828.         <tr>

  829.           <td class="memname">bool SdSpiCard::writeData </td>

  830.           <td>(</td>

  831.           <td class="paramtype">const uint8_t *&#160;</td>

  832.           <td class="paramname"><em>src</em></td><td>)</td>

  833.           <td></td>

  834.         </tr>

  835.       </table>

  836. </div><div class="memdoc">

  837. <p>Write one data sector in a multiple sector write sequence. </p><dl class="params"><dt>Parameters</dt><dd>

  838.   <table class="params">

  839.     <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Pointer to the location of the data to be written. </td></tr>

  840.   </table>

  841.   </dd>

  842. </dl>

  843. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  844. 

  845. </div>

  846. </div>

  847. <a id="a9a230924d82c5df07df592c571bc3fa5"></a>

  848. <h2 class="memtitle"><span class="permalink"><a href="#a9a230924d82c5df07df592c571bc3fa5">&#9670;&nbsp;</a></span>writeSector()</h2>

  849. 

  850. <div class="memitem">

  851. <div class="memproto">

  852. <table class="mlabels">

  853.   <tr>

  854.   <td class="mlabels-left">

  855.       <table class="memname">

  856.         <tr>

  857.           <td class="memname">bool SdSpiCard::writeSector </td>

  858.           <td>(</td>

  859.           <td class="paramtype">uint32_t&#160;</td>

  860.           <td class="paramname"><em>sector</em>, </td>

  861.         </tr>

  862.         <tr>

  863.           <td class="paramkey"></td>

  864.           <td></td>

  865.           <td class="paramtype">const uint8_t *&#160;</td>

  866.           <td class="paramname"><em>src</em>&#160;</td>

  867.         </tr>

  868.         <tr>

  869.           <td></td>

  870.           <td>)</td>

  871.           <td></td><td></td>

  872.         </tr>

  873.       </table>

  874.   </td>

  875.   <td class="mlabels-right">

  876. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  877.   </tr>

  878. </table>

  879. </div><div class="memdoc">

  880. <p>Writes a 512 byte sector to an SD card.</p>

  881. <dl class="params"><dt>Parameters</dt><dd>

  882.   <table class="params">

  883.     <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Logical sector to be written. </td></tr>

  884.     <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Pointer to the location of the data to be written. </td></tr>

  885.   </table>

  886.   </dd>

  887. </dl>

  888. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  889. 

  890. </div>

  891. </div>

  892. <a id="a4165166d5d038c8f1c00c5a04e9f8a63"></a>

  893. <h2 class="memtitle"><span class="permalink"><a href="#a4165166d5d038c8f1c00c5a04e9f8a63">&#9670;&nbsp;</a></span>writeSectors()</h2>

  894. 

  895. <div class="memitem">

  896. <div class="memproto">

  897.       <table class="memname">

  898.         <tr>

  899.           <td class="memname">bool SdSpiCard::writeSectors </td>

  900.           <td>(</td>

  901.           <td class="paramtype">uint32_t&#160;</td>

  902.           <td class="paramname"><em>sector</em>, </td>

  903.         </tr>

  904.         <tr>

  905.           <td class="paramkey"></td>

  906.           <td></td>

  907.           <td class="paramtype">const uint8_t *&#160;</td>

  908.           <td class="paramname"><em>src</em>, </td>

  909.         </tr>

  910.         <tr>

  911.           <td class="paramkey"></td>

  912.           <td></td>

  913.           <td class="paramtype">size_t&#160;</td>

  914.           <td class="paramname"><em>ns</em>&#160;</td>

  915.         </tr>

  916.         <tr>

  917.           <td></td>

  918.           <td>)</td>

  919.           <td></td><td></td>

  920.         </tr>

  921.       </table>

  922. </div><div class="memdoc">

  923. <p>Write multiple 512 byte sectors to an SD card.</p>

  924. <dl class="params"><dt>Parameters</dt><dd>

  925.   <table class="params">

  926.     <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Logical sector to be written. </td></tr>

  927.     <tr><td class="paramdir">[in]</td><td class="paramname">ns</td><td>Number of sectors to be written. </td></tr>

  928.     <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Pointer to the location of the data to be written. </td></tr>

  929.   </table>

  930.   </dd>

  931. </dl>

  932. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  933. 

  934. </div>

  935. </div>

  936. <a id="a3172d671447410f19447b78b856a9689"></a>

  937. <h2 class="memtitle"><span class="permalink"><a href="#a3172d671447410f19447b78b856a9689">&#9670;&nbsp;</a></span>writeSingle()</h2>

  938. 

  939. <div class="memitem">

  940. <div class="memproto">

  941.       <table class="memname">

  942.         <tr>

  943.           <td class="memname">bool SdSpiCard::writeSingle </td>

  944.           <td>(</td>

  945.           <td class="paramtype">uint32_t&#160;</td>

  946.           <td class="paramname"><em>sector</em>, </td>

  947.         </tr>

  948.         <tr>

  949.           <td class="paramkey"></td>

  950.           <td></td>

  951.           <td class="paramtype">const uint8_t *&#160;</td>

  952.           <td class="paramname"><em>src</em>&#160;</td>

  953.         </tr>

  954.         <tr>

  955.           <td></td>

  956.           <td>)</td>

  957.           <td></td><td></td>

  958.         </tr>

  959.       </table>

  960. </div><div class="memdoc">

  961. <p>Writes a 512 byte sector to an SD card.</p>

  962. <dl class="params"><dt>Parameters</dt><dd>

  963.   <table class="params">

  964.     <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Logical sector to be written. </td></tr>

  965.     <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Pointer to the location of the data to be written. </td></tr>

  966.   </table>

  967.   </dd>

  968. </dl>

  969. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  970. 

  971. </div>

  972. </div>

  973. <a id="ae46068850a0cb9f142d5b0b0147716fa"></a>

  974. <h2 class="memtitle"><span class="permalink"><a href="#ae46068850a0cb9f142d5b0b0147716fa">&#9670;&nbsp;</a></span>writeStart() <span class="overload">[1/2]</span></h2>

  975. 

  976. <div class="memitem">

  977. <div class="memproto">

  978.       <table class="memname">

  979.         <tr>

  980.           <td class="memname">bool SdSpiCard::writeStart </td>

  981.           <td>(</td>

  982.           <td class="paramtype">uint32_t&#160;</td>

  983.           <td class="paramname"><em>sector</em></td><td>)</td>

  984.           <td></td>

  985.         </tr>

  986.       </table>

  987. </div><div class="memdoc">

  988. <p>Start a write multiple sectors sequence.</p>

  989. <dl class="params"><dt>Parameters</dt><dd>

  990.   <table class="params">

  991.     <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Address of first sector in sequence.</td></tr>

  992.   </table>

  993.   </dd>

  994. </dl>

  995. <dl class="section note"><dt>Note</dt><dd>This function is used with <a class="el" href="class_sd_spi_card.html#a9495c0b148eb380358bb4a9721c0dffa">writeData()</a> and <a class="el" href="class_sd_spi_card.html#aef9154785a4de5560fb807e4f9316fb0">writeStop()</a> for optimized multiple sector writes.</dd></dl>

  996. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  997. 

  998. </div>

  999. </div>

  1000. <a id="a785250ef0281fbb1cbe5078de9e80be3"></a>

  1001. <h2 class="memtitle"><span class="permalink"><a href="#a785250ef0281fbb1cbe5078de9e80be3">&#9670;&nbsp;</a></span>writeStart() <span class="overload">[2/2]</span></h2>

  1002. 

  1003. <div class="memitem">

  1004. <div class="memproto">

  1005.       <table class="memname">

  1006.         <tr>

  1007.           <td class="memname">bool SdSpiCard::writeStart </td>

  1008.           <td>(</td>

  1009.           <td class="paramtype">uint32_t&#160;</td>

  1010.           <td class="paramname"><em>sector</em>, </td>

  1011.         </tr>

  1012.         <tr>

  1013.           <td class="paramkey"></td>

  1014.           <td></td>

  1015.           <td class="paramtype">uint32_t&#160;</td>

  1016.           <td class="paramname"><em>eraseCount</em>&#160;</td>

  1017.         </tr>

  1018.         <tr>

  1019.           <td></td>

  1020.           <td>)</td>

  1021.           <td></td><td></td>

  1022.         </tr>

  1023.       </table>

  1024. </div><div class="memdoc">

  1025. <p>Start a write multiple sector sequence with pre-erase.</p>

  1026. <dl class="params"><dt>Parameters</dt><dd>

  1027.   <table class="params">

  1028.     <tr><td class="paramdir">[in]</td><td class="paramname">sector</td><td>Address of first sector in sequence. </td></tr>

  1029.     <tr><td class="paramdir">[in]</td><td class="paramname">eraseCount</td><td>The number of sectors to be pre-erased.</td></tr>

  1030.   </table>

  1031.   </dd>

  1032. </dl>

  1033. <dl class="section note"><dt>Note</dt><dd>This function is used with <a class="el" href="class_sd_spi_card.html#a9495c0b148eb380358bb4a9721c0dffa">writeData()</a> and <a class="el" href="class_sd_spi_card.html#aef9154785a4de5560fb807e4f9316fb0">writeStop()</a> for optimized multiple sector writes.</dd></dl>

  1034. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1035. 

  1036. </div>

  1037. </div>

  1038. <a id="aef9154785a4de5560fb807e4f9316fb0"></a>

  1039. <h2 class="memtitle"><span class="permalink"><a href="#aef9154785a4de5560fb807e4f9316fb0">&#9670;&nbsp;</a></span>writeStop()</h2>

  1040. 

  1041. <div class="memitem">

  1042. <div class="memproto">

  1043.       <table class="memname">

  1044.         <tr>

  1045.           <td class="memname">bool SdSpiCard::writeStop </td>

  1046.           <td>(</td>

  1047.           <td class="paramname"></td><td>)</td>

  1048.           <td></td>

  1049.         </tr>

  1050.       </table>

  1051. </div><div class="memdoc">

  1052. <p>End a write multiple sectors sequence.</p>

  1053. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1054. 

  1055. </div>

  1056. </div>

  1057. <hr/>The documentation for this class was generated from the following files:<ul>

  1058. <li>ArduinoSdFat/libraries/SdFat/src/SdCard/<a class="el" href="_sd_spi_card_8h.html">SdSpiCard.h</a></li>

  1059. <li>ArduinoSdFat/libraries/SdFat/src/SdCard/SdSpiCard.cpp</li>

  1060. </ul>

  1061. </div><!-- contents -->

  1062. <!-- start footer part -->

  1063. <hr class="footer"/><address class="footer"><small>

  1064. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  1065. <img class="footer" src="doxygen.png" alt="doxygen"/>

  1066. </a> 1.8.16

  1067. </small></address>

  1068. </body>

  1069. </html>