visus
/
teensy-sdfat
Слідкувати 1
В обрані 0
Форк 0
Код Проблеми 0 Запити на злиття 0 Релізи 0 Вікі Активність
Ви не можете вибрати більше 25 тем Теми мають розпочинатися з літери або цифри, можуть містити дефіси (-) і не повинні перевищувати 35 символів.
7 Коміти
1 Гілка
Дерево: 2e8eeb8434
Гілки Теги
${ item.name }
Створити гілку ${ searchTerm }
з '2e8eeb8434'
${ noResults }
teensy-sdfat/html/class_sd2_card.html

744 lines
34KB
Неформатований Blame Історія 

  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:a9198517574578064a48f8f2b1874aae5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd2_card.html#a9198517574578064a48f8f2b1874aae5">readOCR</a> (uint32_t *ocr)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  107. </table>

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

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

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

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

  112. <div class="memitem">

  113. <div class="memproto">

  114. <table class="mlabels">

  115.   <tr>

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

  117.       <table class="memname">

  118.         <tr>

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

  120.           <td>(</td>

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

  122.           <td></td>

  123.         </tr>

  124.       </table>

  125.   </td>

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

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

  128.   </tr>

  129. </table>

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

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

  132. 

  133. </div>

  134. </div>

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

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

  137. <div class="memitem">

  138. <div class="memproto">

  139.       <table class="memname">

  140.         <tr>

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

  142.           <td>(</td>

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

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

  145.         </tr>

  146.         <tr>

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

  148.           <td></td>

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

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

  151.         </tr>

  152.         <tr>

  153.           <td></td>

  154.           <td>)</td>

  155.           <td></td><td></td>

  156.         </tr>

  157.       </table>

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

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

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

  161.   <table class="params">

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

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

  164.   </table>

  165.   </dd>

  166. </dl>

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

  168. 

  169. </div>

  170. </div>

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

  172. <div class="memitem">

  173. <div class="memproto">

  174.       <table class="memname">

  175.         <tr>

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

  177.           <td>(</td>

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

  179.           <td></td>

  180.         </tr>

  181.       </table>

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

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

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

  185. 

  186. </div>

  187. </div>

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

  189. <div class="memitem">

  190. <div class="memproto">

  191.       <table class="memname">

  192.         <tr>

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

  194.           <td>(</td>

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

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

  197.         </tr>

  198.         <tr>

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

  200.           <td></td>

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

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

  203.         </tr>

  204.         <tr>

  205.           <td></td>

  206.           <td>)</td>

  207.           <td></td><td></td>

  208.         </tr>

  209.       </table>

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

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

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

  213.   <table class="params">

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

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

  216.   </table>

  217.   </dd>

  218. </dl>

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

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

  221. 

  222. </div>

  223. </div>

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

  225. <div class="memitem">

  226. <div class="memproto">

  227.       <table class="memname">

  228.         <tr>

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

  230.           <td>(</td>

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

  232.           <td></td>

  233.         </tr>

  234.       </table>

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

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

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

  238. 

  239. </div>

  240. </div>

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

  242. <div class="memitem">

  243. <div class="memproto">

  244. <table class="mlabels">

  245.   <tr>

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

  247.       <table class="memname">

  248.         <tr>

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

  250.           <td>(</td>

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

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

  253.           <td></td>

  254.         </tr>

  255.       </table>

  256.   </td>

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

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

  259.   </tr>

  260. </table>

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

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

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

  264.   <table class="params">

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

  266.   </table>

  267.   </dd>

  268. </dl>

  269. 

  270. </div>

  271. </div>

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

  273. <div class="memitem">

  274. <div class="memproto">

  275. <table class="mlabels">

  276.   <tr>

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

  278.       <table class="memname">

  279.         <tr>

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

  281.           <td>(</td>

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

  283.           <td> const</td>

  284.         </tr>

  285.       </table>

  286.   </td>

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

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

  289.   </tr>

  290. </table>

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

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

  293. 

  294. </div>

  295. </div>

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

  297. <div class="memitem">

  298. <div class="memproto">

  299. <table class="mlabels">

  300.   <tr>

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

  302.       <table class="memname">

  303.         <tr>

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

  305.           <td>(</td>

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

  307.           <td> const</td>

  308.         </tr>

  309.       </table>

  310.   </td>

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

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

  313.   </tr>

  314. </table>

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

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

  317. 

  318. </div>

  319. </div>

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

  321. <div class="memitem">

  322. <div class="memproto">

  323. <table class="mlabels">

  324.   <tr>

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

  326.       <table class="memname">

  327.         <tr>

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

  329.           <td>(</td>

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

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

  332.         </tr>

  333.         <tr>

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

  335.           <td></td>

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

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

  338.         </tr>

  339.         <tr>

  340.           <td></td>

  341.           <td>)</td>

  342.           <td></td><td></td>

  343.         </tr>

  344.       </table>

  345.   </td>

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

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

  348.   </tr>

  349. </table>

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

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

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

  353.   <table class="params">

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

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

  356.   </table>

  357.   </dd>

  358. </dl>

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

  360. 

  361. </div>

  362. </div>

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

  364. <div class="memitem">

  365. <div class="memproto">

  366.       <table class="memname">

  367.         <tr>

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

  369.           <td>(</td>

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

  371.           <td></td>

  372.         </tr>

  373.       </table>

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

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

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

  377. 

  378. </div>

  379. </div>

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

  381. <div class="memitem">

  382. <div class="memproto">

  383.       <table class="memname">

  384.         <tr>

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

  386.           <td>(</td>

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

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

  389.         </tr>

  390.         <tr>

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

  392.           <td></td>

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

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

  395.         </tr>

  396.         <tr>

  397.           <td></td>

  398.           <td>)</td>

  399.           <td></td><td></td>

  400.         </tr>

  401.       </table>

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

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

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

  405.   <table class="params">

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

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

  408.   </table>

  409.   </dd>

  410. </dl>

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

  412. 

  413. </div>

  414. </div>

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

  416. <div class="memitem">

  417. <div class="memproto">

  418. <table class="mlabels">

  419.   <tr>

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

  421.       <table class="memname">

  422.         <tr>

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

  424.           <td>(</td>

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

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

  427.           <td></td>

  428.         </tr>

  429.       </table>

  430.   </td>

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

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

  433.   </tr>

  434. </table>

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

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

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

  438.   <table class="params">

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

  440.   </table>

  441.   </dd>

  442. </dl>

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

  444. 

  445. </div>

  446. </div>

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

  448. <div class="memitem">

  449. <div class="memproto">

  450. <table class="mlabels">

  451.   <tr>

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

  453.       <table class="memname">

  454.         <tr>

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

  456.           <td>(</td>

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

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

  459.           <td></td>

  460.         </tr>

  461.       </table>

  462.   </td>

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

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

  465.   </tr>

  466. </table>

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

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

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

  470.   <table class="params">

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

  472.   </table>

  473.   </dd>

  474. </dl>

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

  476. 

  477. </div>

  478. </div>

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

  480. <div class="memitem">

  481. <div class="memproto">

  482.       <table class="memname">

  483.         <tr>

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

  485.           <td>(</td>

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

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

  488.           <td></td>

  489.         </tr>

  490.       </table>

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

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

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

  494.   <table class="params">

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

  496.   </table>

  497.   </dd>

  498. </dl>

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

  500. 

  501. </div>

  502. </div>

  503. <a class="anchor" id="a9198517574578064a48f8f2b1874aae5"></a>

  504. <div class="memitem">

  505. <div class="memproto">

  506.       <table class="memname">

  507.         <tr>

  508.           <td class="memname">bool Sd2Card::readOCR </td>

  509.           <td>(</td>

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

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

  512.           <td></td>

  513.         </tr>

  514.       </table>

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

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

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

  518.   <table class="params">

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

  520.   </table>

  521.   </dd>

  522. </dl>

  523. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  524. 

  525. </div>

  526. </div>

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

  528. <div class="memitem">

  529. <div class="memproto">

  530.       <table class="memname">

  531.         <tr>

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

  533.           <td>(</td>

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

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

  536.           <td></td>

  537.         </tr>

  538.       </table>

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

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

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

  542.   <table class="params">

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

  544.   </table>

  545.   </dd>

  546. </dl>

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

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

  549. 

  550. </div>

  551. </div>

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

  553. <div class="memitem">

  554. <div class="memproto">

  555.       <table class="memname">

  556.         <tr>

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

  558.           <td>(</td>

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

  560.           <td></td>

  561.         </tr>

  562.       </table>

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

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

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

  566. 

  567. </div>

  568. </div>

  569. <a class="anchor" id="a6bcfd1bf665bf4ff88a46c07741fac43"></a>

  570. <div class="memitem">

  571. <div class="memproto">

  572. <table class="mlabels">

  573.   <tr>

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

  575.       <table class="memname">

  576.         <tr>

  577.           <td class="memname">uint8_t Sd2Card::sckDivisor </td>

  578.           <td>(</td>

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

  580.           <td></td>

  581.         </tr>

  582.       </table>

  583.   </td>

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

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

  586.   </tr>

  587. </table>

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

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

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

  591. 

  592. </div>

  593. </div>

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

  595. <div class="memitem">

  596. <div class="memproto">

  597. <table class="mlabels">

  598.   <tr>

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

  600.       <table class="memname">

  601.         <tr>

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

  603.           <td>(</td>

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

  605.           <td> const</td>

  606.         </tr>

  607.       </table>

  608.   </td>

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

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

  611.   </tr>

  612. </table>

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

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

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

  616. 

  617. </div>

  618. </div>

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

  620. <div class="memitem">

  621. <div class="memproto">

  622.       <table class="memname">

  623.         <tr>

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

  625.           <td>(</td>

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

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

  628.         </tr>

  629.         <tr>

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

  631.           <td></td>

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

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

  634.         </tr>

  635.         <tr>

  636.           <td></td>

  637.           <td>)</td>

  638.           <td></td><td></td>

  639.         </tr>

  640.       </table>

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

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

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

  644.   <table class="params">

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

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

  647.   </table>

  648.   </dd>

  649. </dl>

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

  651. 

  652. </div>

  653. </div>

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

  655. <div class="memitem">

  656. <div class="memproto">

  657.       <table class="memname">

  658.         <tr>

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

  660.           <td>(</td>

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

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

  663.           <td></td>

  664.         </tr>

  665.       </table>

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

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

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

  669.   <table class="params">

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

  671.   </table>

  672.   </dd>

  673. </dl>

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

  675. 

  676. </div>

  677. </div>

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

  679. <div class="memitem">

  680. <div class="memproto">

  681.       <table class="memname">

  682.         <tr>

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

  684.           <td>(</td>

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

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

  687.         </tr>

  688.         <tr>

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

  690.           <td></td>

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

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

  693.         </tr>

  694.         <tr>

  695.           <td></td>

  696.           <td>)</td>

  697.           <td></td><td></td>

  698.         </tr>

  699.       </table>

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

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

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

  703.   <table class="params">

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

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

  706.   </table>

  707.   </dd>

  708. </dl>

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

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

  711. 

  712. </div>

  713. </div>

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

  715. <div class="memitem">

  716. <div class="memproto">

  717.       <table class="memname">

  718.         <tr>

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

  720.           <td>(</td>

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

  722.           <td></td>

  723.         </tr>

  724.       </table>

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

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

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

  728. 

  729. </div>

  730. </div>

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

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

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

  734. </ul>

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

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

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

  738. Generated on Fri Oct 24 2014 05:45:13 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  740. </a> 1.8.6

  741. </small></address>

  742. </body>

  743. </html>