visus
/
teensy-sdfat
Tarkkaile 1
Äänestä 0
Fork 0
Koodi Ongelmat 0 Pull-pyynnöt 0 Julkaisut 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.
3 Commitit
1 Haara
Puu: 546fec6fe1
Branchit Tagit
${ item.name }
Create branch ${ searchTerm }
from '546fec6fe1'
${ noResults }
teensy-sdfat/html/class_sd2_card.html

718 lines
33KB
Raaka Blame Historia 

  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.6"/>

  7. <title>SdFat: Sd2Card Class Reference</title>

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

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

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

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

  12. </head>

  13. <body>

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

  15. <div id="titlearea">

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

  17.  <tbody>

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

  19.   <td style="padding-left: 0.5em;">

  20.    <div id="projectname">SdFat

  21.    </div>

  22.   </td>

  23.  </tr>

  24.  </tbody>

  25. </table>

  26. </div>

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

  28. <!-- Generated by Doxygen 1.8.6 -->

  29.   <div id="navrow1" class="tabs">

  30.     <ul class="tablist">

  31.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  32.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>

  33.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  34.       <li><a href="files.html"><span>Files</span></a></li>

  35.     </ul>

  36.   </div>

  37.   <div id="navrow2" class="tabs2">

  38.     <ul class="tablist">

  39.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  40.       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>

  41.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  42.     </ul>

  43.   </div>

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

  45. <div class="header">

  46.   <div class="summary">

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

  48. <a href="class_sd2_card-members.html">List of all members</a>  </div>

  49.   <div class="headertitle">

  50. <div class="title">Sd2Card Class Reference</div>  </div>

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

  52. <div class="contents">

  53. 

  54. <p>Raw access to SD and SDHC flash memory cards.  

  55.  <a href="class_sd2_card.html#details">More...</a></p>

  56. 

  57. <p><code>#include &lt;Sd2Card.h&gt;</code></p>

  58. <table class="memberdecls">

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

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

  61. <tr class="memitem:a4e55e83403be452b10b0564ca63896f1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a4e55e83403be452b10b0564ca63896f1">begin</a> (uint8_t chipSelectPin=<a class="el" href="_sd_spi_8h.html#ae6b17538c14ba6c91ccb513db2c4c29c">SD_CHIP_SELECT_PIN</a>, uint8_t <a class="el" href="class_sd2_card.html#a6bcfd1bf665bf4ff88a46c07741fac43">sckDivisor</a>=SPI_FULL_SPEED)</td></tr>

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

  63. <tr class="memitem:a21ef1c5321041d4d73107b84e2db5189"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a21ef1c5321041d4d73107b84e2db5189">cardSize</a> ()</td></tr>

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

  65. <tr class="memitem:a2d73473118c5692e0f7d13db7da3570f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a2d73473118c5692e0f7d13db7da3570f">erase</a> (uint32_t firstBlock, uint32_t lastBlock)</td></tr>

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

  67. <tr class="memitem:aceacbe30077e41ab84a34e629a03bb33"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#aceacbe30077e41ab84a34e629a03bb33">eraseSingleBlockEnable</a> ()</td></tr>

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

  69. <tr class="memitem:af03e574590524f93a61641604e02f79f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#af03e574590524f93a61641604e02f79f">error</a> (uint8_t code)</td></tr>

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

  71. <tr class="memitem:a3549d1878c0134171e399fd2d60b96f7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a3549d1878c0134171e399fd2d60b96f7">errorCode</a> () const </td></tr>

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

  73. <tr class="memitem:a1736acdbf194c6a2fd923c0a5049c016"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a1736acdbf194c6a2fd923c0a5049c016">errorData</a> () const </td></tr>

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

  75. <tr class="memitem:a71523097165fce957c7f65b033471fc7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a71523097165fce957c7f65b033471fc7">init</a> (uint8_t <a class="el" href="class_sd2_card.html#a6bcfd1bf665bf4ff88a46c07741fac43">sckDivisor</a>=SPI_FULL_SPEED, uint8_t chipSelectPin=<a class="el" href="_sd_spi_8h.html#ae6b17538c14ba6c91ccb513db2c4c29c">SD_CHIP_SELECT_PIN</a>)</td></tr>

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

  77. <tr class="memitem:a28eafda720598dcb2923955776199e19"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a28eafda720598dcb2923955776199e19">isBusy</a> ()</td></tr>

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

  79. <tr class="memitem:a6b015ee1c94004b8b16639910e5a3466"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a6b015ee1c94004b8b16639910e5a3466">readBlock</a> (uint32_t block, uint8_t *dst)</td></tr>

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

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

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

  83. <tr class="memitem:a1b0c68df7f508f876d56fc1270536c87"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a1b0c68df7f508f876d56fc1270536c87">readCSD</a> (csd_t *csd)</td></tr>

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

  85. <tr class="memitem:a7d6e8a504f8525afd6d36a22ee5b8cc0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a7d6e8a504f8525afd6d36a22ee5b8cc0">readData</a> (uint8_t *dst)</td></tr>

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

  87. <tr class="memitem:a3259be9721e14a2edf8b549e4aeb2e40"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a3259be9721e14a2edf8b549e4aeb2e40">readStart</a> (uint32_t blockNumber)</td></tr>

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

  89. <tr class="memitem:ae133ad5a80c2652a964afd2320cc7c94"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#ae133ad5a80c2652a964afd2320cc7c94">readStop</a> ()</td></tr>

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

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

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

  93. <tr class="memitem:a17c8713ae610106567679a8685696375"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a17c8713ae610106567679a8685696375">Sd2Card</a> ()</td></tr>

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

  95. <tr class="memitem:adcee026d613619414e2b6d3eca2c6537"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#adcee026d613619414e2b6d3eca2c6537">type</a> () const </td></tr>

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

  97. <tr class="memitem:ad5eecc3e1e68b9e5a43edfb8e4205469"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#ad5eecc3e1e68b9e5a43edfb8e4205469">writeBlock</a> (uint32_t blockNumber, const uint8_t *src)</td></tr>

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

  99. <tr class="memitem:afb96025babf92878213dd691263d93ef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#afb96025babf92878213dd691263d93ef">writeData</a> (const uint8_t *src)</td></tr>

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

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

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

  103. <tr class="memitem:a7e1ec48b0a83d13415841da870290f64"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a7e1ec48b0a83d13415841da870290f64">writeStop</a> ()</td></tr>

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

  105. </table>

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

  107. <div class="textblock"><p>Raw access to SD and SDHC flash memory cards. </p>

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

  109. <a class="anchor" id="a17c8713ae610106567679a8685696375"></a>

  110. <div class="memitem">

  111. <div class="memproto">

  112. <table class="mlabels">

  113.   <tr>

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

  115.       <table class="memname">

  116.         <tr>

  117.           <td class="memname">Sd2Card::Sd2Card </td>

  118.           <td>(</td>

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

  120.           <td></td>

  121.         </tr>

  122.       </table>

  123.   </td>

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

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

  126.   </tr>

  127. </table>

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

  129. <p>Construct an instance of <a class="el" href="class_sd2_card.html" title="Raw access to SD and SDHC flash memory cards. ">Sd2Card</a>. </p>

  130. 

  131. </div>

  132. </div>

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

  134. <a class="anchor" id="a4e55e83403be452b10b0564ca63896f1"></a>

  135. <div class="memitem">

  136. <div class="memproto">

  137.       <table class="memname">

  138.         <tr>

  139.           <td class="memname">bool Sd2Card::begin </td>

  140.           <td>(</td>

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

  142.           <td class="paramname"><em>chipSelectPin</em> = <code><a class="el" href="_sd_spi_8h.html#ae6b17538c14ba6c91ccb513db2c4c29c">SD_CHIP_SELECT_PIN</a></code>, </td>

  143.         </tr>

  144.         <tr>

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

  146.           <td></td>

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

  148.           <td class="paramname"><em>sckDivisor</em> = <code>SPI_FULL_SPEED</code>&#160;</td>

  149.         </tr>

  150.         <tr>

  151.           <td></td>

  152.           <td>)</td>

  153.           <td></td><td></td>

  154.         </tr>

  155.       </table>

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

  157. <p>Initialize an SD flash memory card.</p>

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

  159.   <table class="params">

  160.     <tr><td class="paramdir">[in]</td><td class="paramname">chipSelectPin</td><td>SD chip select pin number. </td></tr>

  161.     <tr><td class="paramdir">[in]</td><td class="paramname">sckDivisor</td><td>SPI SCK clock rate divisor.</td></tr>

  162.   </table>

  163.   </dd>

  164. </dl>

  165. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. The reason for failure can be determined by calling <a class="el" href="class_sd2_card.html#a3549d1878c0134171e399fd2d60b96f7">errorCode()</a> and <a class="el" href="class_sd2_card.html#a1736acdbf194c6a2fd923c0a5049c016">errorData()</a>. </dd></dl>

  166. 

  167. </div>

  168. </div>

  169. <a class="anchor" id="a21ef1c5321041d4d73107b84e2db5189"></a>

  170. <div class="memitem">

  171. <div class="memproto">

  172.       <table class="memname">

  173.         <tr>

  174.           <td class="memname">uint32_t Sd2Card::cardSize </td>

  175.           <td>(</td>

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

  177.           <td></td>

  178.         </tr>

  179.       </table>

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

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

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

  183. 

  184. </div>

  185. </div>

  186. <a class="anchor" id="a2d73473118c5692e0f7d13db7da3570f"></a>

  187. <div class="memitem">

  188. <div class="memproto">

  189.       <table class="memname">

  190.         <tr>

  191.           <td class="memname">bool Sd2Card::erase </td>

  192.           <td>(</td>

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

  194.           <td class="paramname"><em>firstBlock</em>, </td>

  195.         </tr>

  196.         <tr>

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

  198.           <td></td>

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

  200.           <td class="paramname"><em>lastBlock</em>&#160;</td>

  201.         </tr>

  202.         <tr>

  203.           <td></td>

  204.           <td>)</td>

  205.           <td></td><td></td>

  206.         </tr>

  207.       </table>

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

  209. <p>Erase a range of blocks.</p>

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

  211.   <table class="params">

  212.     <tr><td class="paramdir">[in]</td><td class="paramname">firstBlock</td><td>The address of the first block in the range. </td></tr>

  213.     <tr><td class="paramdir">[in]</td><td class="paramname">lastBlock</td><td>The address of the last block in the range.</td></tr>

  214.   </table>

  215.   </dd>

  216. </dl>

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

  218. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>

  219. 

  220. </div>

  221. </div>

  222. <a class="anchor" id="aceacbe30077e41ab84a34e629a03bb33"></a>

  223. <div class="memitem">

  224. <div class="memproto">

  225.       <table class="memname">

  226.         <tr>

  227.           <td class="memname">bool Sd2Card::eraseSingleBlockEnable </td>

  228.           <td>(</td>

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

  230.           <td></td>

  231.         </tr>

  232.       </table>

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

  234. <p>Determine if card supports single block erase.</p>

  235. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned if single block erase is supported. The value zero, false, is returned if single block erase is not supported. </dd></dl>

  236. 

  237. </div>

  238. </div>

  239. <a class="anchor" id="af03e574590524f93a61641604e02f79f"></a>

  240. <div class="memitem">

  241. <div class="memproto">

  242. <table class="mlabels">

  243.   <tr>

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

  245.       <table class="memname">

  246.         <tr>

  247.           <td class="memname">void Sd2Card::error </td>

  248.           <td>(</td>

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

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

  251.           <td></td>

  252.         </tr>

  253.       </table>

  254.   </td>

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

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

  257.   </tr>

  258. </table>

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

  260. <p>Set SD error code. </p>

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

  262.   <table class="params">

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

  264.   </table>

  265.   </dd>

  266. </dl>

  267. 

  268. </div>

  269. </div>

  270. <a class="anchor" id="a3549d1878c0134171e399fd2d60b96f7"></a>

  271. <div class="memitem">

  272. <div class="memproto">

  273. <table class="mlabels">

  274.   <tr>

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

  276.       <table class="memname">

  277.         <tr>

  278.           <td class="memname">int Sd2Card::errorCode </td>

  279.           <td>(</td>

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

  281.           <td> const</td>

  282.         </tr>

  283.       </table>

  284.   </td>

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

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

  287.   </tr>

  288. </table>

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

  290. <dl class="section return"><dt>Returns</dt><dd>error code for last error. See <a class="el" href="_sd2_card_8h.html" title="Sd2Card class for V2 SD/SDHC cards. ">Sd2Card.h</a> for a list of error codes. </dd></dl>

  291. 

  292. </div>

  293. </div>

  294. <a class="anchor" id="a1736acdbf194c6a2fd923c0a5049c016"></a>

  295. <div class="memitem">

  296. <div class="memproto">

  297. <table class="mlabels">

  298.   <tr>

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

  300.       <table class="memname">

  301.         <tr>

  302.           <td class="memname">int Sd2Card::errorData </td>

  303.           <td>(</td>

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

  305.           <td> const</td>

  306.         </tr>

  307.       </table>

  308.   </td>

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

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

  311.   </tr>

  312. </table>

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

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

  315. 

  316. </div>

  317. </div>

  318. <a class="anchor" id="a71523097165fce957c7f65b033471fc7"></a>

  319. <div class="memitem">

  320. <div class="memproto">

  321. <table class="mlabels">

  322.   <tr>

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

  324.       <table class="memname">

  325.         <tr>

  326.           <td class="memname">bool Sd2Card::init </td>

  327.           <td>(</td>

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

  329.           <td class="paramname"><em>sckDivisor</em> = <code>SPI_FULL_SPEED</code>, </td>

  330.         </tr>

  331.         <tr>

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

  333.           <td></td>

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

  335.           <td class="paramname"><em>chipSelectPin</em> = <code><a class="el" href="_sd_spi_8h.html#ae6b17538c14ba6c91ccb513db2c4c29c">SD_CHIP_SELECT_PIN</a></code>&#160;</td>

  336.         </tr>

  337.         <tr>

  338.           <td></td>

  339.           <td>)</td>

  340.           <td></td><td></td>

  341.         </tr>

  342.       </table>

  343.   </td>

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

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

  346.   </tr>

  347. </table>

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

  349. <p>Initialize an SD flash memory card.</p>

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

  351.   <table class="params">

  352.     <tr><td class="paramdir">[in]</td><td class="paramname">chipSelectPin</td><td>SD chip select pin number. </td></tr>

  353.     <tr><td class="paramdir">[in]</td><td class="paramname">sckDivisor</td><td>SPI SCK clock rate divisor.</td></tr>

  354.   </table>

  355.   </dd>

  356. </dl>

  357. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. The reason for failure can be determined by calling <a class="el" href="class_sd2_card.html#a3549d1878c0134171e399fd2d60b96f7">errorCode()</a> and <a class="el" href="class_sd2_card.html#a1736acdbf194c6a2fd923c0a5049c016">errorData()</a>. </dd></dl>

  358. 

  359. </div>

  360. </div>

  361. <a class="anchor" id="a28eafda720598dcb2923955776199e19"></a>

  362. <div class="memitem">

  363. <div class="memproto">

  364.       <table class="memname">

  365.         <tr>

  366.           <td class="memname">bool Sd2Card::isBusy </td>

  367.           <td>(</td>

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

  369.           <td></td>

  370.         </tr>

  371.       </table>

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

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

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

  375. 

  376. </div>

  377. </div>

  378. <a class="anchor" id="a6b015ee1c94004b8b16639910e5a3466"></a>

  379. <div class="memitem">

  380. <div class="memproto">

  381.       <table class="memname">

  382.         <tr>

  383.           <td class="memname">bool Sd2Card::readBlock </td>

  384.           <td>(</td>

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

  386.           <td class="paramname"><em>blockNumber</em>, </td>

  387.         </tr>

  388.         <tr>

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

  390.           <td></td>

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

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

  393.         </tr>

  394.         <tr>

  395.           <td></td>

  396.           <td>)</td>

  397.           <td></td><td></td>

  398.         </tr>

  399.       </table>

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

  401. <p>Read a 512 byte block from an SD card.</p>

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

  403.   <table class="params">

  404.     <tr><td class="paramdir">[in]</td><td class="paramname">blockNumber</td><td>Logical block to be read. </td></tr>

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

  406.   </table>

  407.   </dd>

  408. </dl>

  409. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>

  410. 

  411. </div>

  412. </div>

  413. <a class="anchor" id="abaf488d56f653efa8e3349bf803ce2b0"></a>

  414. <div class="memitem">

  415. <div class="memproto">

  416. <table class="mlabels">

  417.   <tr>

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

  419.       <table class="memname">

  420.         <tr>

  421.           <td class="memname">bool Sd2Card::readCID </td>

  422.           <td>(</td>

  423.           <td class="paramtype">cid_t *&#160;</td>

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

  425.           <td></td>

  426.         </tr>

  427.       </table>

  428.   </td>

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

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

  431.   </tr>

  432. </table>

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

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

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

  436.   <table class="params">

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

  438.   </table>

  439.   </dd>

  440. </dl>

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

  442. 

  443. </div>

  444. </div>

  445. <a class="anchor" id="a1b0c68df7f508f876d56fc1270536c87"></a>

  446. <div class="memitem">

  447. <div class="memproto">

  448. <table class="mlabels">

  449.   <tr>

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

  451.       <table class="memname">

  452.         <tr>

  453.           <td class="memname">bool Sd2Card::readCSD </td>

  454.           <td>(</td>

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

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

  457.           <td></td>

  458.         </tr>

  459.       </table>

  460.   </td>

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

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

  463.   </tr>

  464. </table>

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

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

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

  468.   <table class="params">

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

  470.   </table>

  471.   </dd>

  472. </dl>

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

  474. 

  475. </div>

  476. </div>

  477. <a class="anchor" id="a7d6e8a504f8525afd6d36a22ee5b8cc0"></a>

  478. <div class="memitem">

  479. <div class="memproto">

  480.       <table class="memname">

  481.         <tr>

  482.           <td class="memname">bool Sd2Card::readData </td>

  483.           <td>(</td>

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

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

  486.           <td></td>

  487.         </tr>

  488.       </table>

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

  490. <p>Read one data block in a multiple block read sequence</p>

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

  492.   <table class="params">

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

  494.   </table>

  495.   </dd>

  496. </dl>

  497. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>

  498. 

  499. </div>

  500. </div>

  501. <a class="anchor" id="a3259be9721e14a2edf8b549e4aeb2e40"></a>

  502. <div class="memitem">

  503. <div class="memproto">

  504.       <table class="memname">

  505.         <tr>

  506.           <td class="memname">bool Sd2Card::readStart </td>

  507.           <td>(</td>

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

  509.           <td class="paramname"><em>blockNumber</em></td><td>)</td>

  510.           <td></td>

  511.         </tr>

  512.       </table>

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

  514. <p>Start a read multiple blocks sequence.</p>

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

  516.   <table class="params">

  517.     <tr><td class="paramdir">[in]</td><td class="paramname">blockNumber</td><td>Address of first block in sequence.</td></tr>

  518.   </table>

  519.   </dd>

  520. </dl>

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

  522. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>

  523. 

  524. </div>

  525. </div>

  526. <a class="anchor" id="ae133ad5a80c2652a964afd2320cc7c94"></a>

  527. <div class="memitem">

  528. <div class="memproto">

  529.       <table class="memname">

  530.         <tr>

  531.           <td class="memname">bool Sd2Card::readStop </td>

  532.           <td>(</td>

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

  534.           <td></td>

  535.         </tr>

  536.       </table>

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

  538. <p>End a read multiple blocks sequence.</p>

  539. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>

  540. 

  541. </div>

  542. </div>

  543. <a class="anchor" id="a6bcfd1bf665bf4ff88a46c07741fac43"></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">uint8_t Sd2Card::sckDivisor </td>

  552.           <td>(</td>

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

  554.           <td></td>

  555.         </tr>

  556.       </table>

  557.   </td>

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

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

  560.   </tr>

  561. </table>

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

  563. <p>Return SCK divisor.</p>

  564. <dl class="section return"><dt>Returns</dt><dd>Requested SCK divisor. </dd></dl>

  565. 

  566. </div>

  567. </div>

  568. <a class="anchor" id="adcee026d613619414e2b6d3eca2c6537"></a>

  569. <div class="memitem">

  570. <div class="memproto">

  571. <table class="mlabels">

  572.   <tr>

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

  574.       <table class="memname">

  575.         <tr>

  576.           <td class="memname">int Sd2Card::type </td>

  577.           <td>(</td>

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

  579.           <td> const</td>

  580.         </tr>

  581.       </table>

  582.   </td>

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

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

  585.   </tr>

  586. </table>

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

  588. <p>Return the card type: SD V1, SD V2 or SDHC </p>

  589. <dl class="section return"><dt>Returns</dt><dd>0 - SD V1, 1 - SD V2, or 3 - SDHC. </dd></dl>

  590. 

  591. </div>

  592. </div>

  593. <a class="anchor" id="ad5eecc3e1e68b9e5a43edfb8e4205469"></a>

  594. <div class="memitem">

  595. <div class="memproto">

  596.       <table class="memname">

  597.         <tr>

  598.           <td class="memname">bool Sd2Card::writeBlock </td>

  599.           <td>(</td>

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

  601.           <td class="paramname"><em>blockNumber</em>, </td>

  602.         </tr>

  603.         <tr>

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

  605.           <td></td>

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

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

  608.         </tr>

  609.         <tr>

  610.           <td></td>

  611.           <td>)</td>

  612.           <td></td><td></td>

  613.         </tr>

  614.       </table>

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

  616. <p>Writes a 512 byte block to an SD card.</p>

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

  618.   <table class="params">

  619.     <tr><td class="paramdir">[in]</td><td class="paramname">blockNumber</td><td>Logical block to be written. </td></tr>

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

  621.   </table>

  622.   </dd>

  623. </dl>

  624. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>

  625. 

  626. </div>

  627. </div>

  628. <a class="anchor" id="afb96025babf92878213dd691263d93ef"></a>

  629. <div class="memitem">

  630. <div class="memproto">

  631.       <table class="memname">

  632.         <tr>

  633.           <td class="memname">bool Sd2Card::writeData </td>

  634.           <td>(</td>

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

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

  637.           <td></td>

  638.         </tr>

  639.       </table>

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

  641. <p>Write one data block in a multiple block write sequence </p>

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

  643.   <table class="params">

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

  645.   </table>

  646.   </dd>

  647. </dl>

  648. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>

  649. 

  650. </div>

  651. </div>

  652. <a class="anchor" id="a1039df4f6620213a98b317d11da2014e"></a>

  653. <div class="memitem">

  654. <div class="memproto">

  655.       <table class="memname">

  656.         <tr>

  657.           <td class="memname">bool Sd2Card::writeStart </td>

  658.           <td>(</td>

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

  660.           <td class="paramname"><em>blockNumber</em>, </td>

  661.         </tr>

  662.         <tr>

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

  664.           <td></td>

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

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

  667.         </tr>

  668.         <tr>

  669.           <td></td>

  670.           <td>)</td>

  671.           <td></td><td></td>

  672.         </tr>

  673.       </table>

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

  675. <p>Start a write multiple blocks sequence.</p>

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

  677.   <table class="params">

  678.     <tr><td class="paramdir">[in]</td><td class="paramname">blockNumber</td><td>Address of first block in sequence. </td></tr>

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

  680.   </table>

  681.   </dd>

  682. </dl>

  683. <dl class="section note"><dt>Note</dt><dd>This function is used with <a class="el" href="class_sd2_card.html#afb96025babf92878213dd691263d93ef">writeData()</a> and <a class="el" href="class_sd2_card.html#a7e1ec48b0a83d13415841da870290f64">writeStop()</a> for optimized multiple block writes.</dd></dl>

  684. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>

  685. 

  686. </div>

  687. </div>

  688. <a class="anchor" id="a7e1ec48b0a83d13415841da870290f64"></a>

  689. <div class="memitem">

  690. <div class="memproto">

  691.       <table class="memname">

  692.         <tr>

  693.           <td class="memname">bool Sd2Card::writeStop </td>

  694.           <td>(</td>

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

  696.           <td></td>

  697.         </tr>

  698.       </table>

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

  700. <p>End a write multiple blocks sequence.</p>

  701. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>

  702. 

  703. </div>

  704. </div>

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

  706. <li>Arduino/libraries/SdFat/<a class="el" href="_sd2_card_8h.html">Sd2Card.h</a></li>

  707. <li>Arduino/libraries/SdFat/<a class="el" href="_sd2_card_8cpp.html">Sd2Card.cpp</a></li>

  708. </ul>

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

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

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

  712. Generated on Sun Aug 24 2014 09:37:38 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  714. </a> 1.8.6

  715. </small></address>

  716. </body>

  717. </html>