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.

236 satır
9.4KB

  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.8"/>
  7. <title>SdFat: SdSpi 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.8 -->
  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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
  33. <li><a href="files.html"><span>Files</span></a></li>
  34. </ul>
  35. </div>
  36. <div id="navrow2" class="tabs2">
  37. <ul class="tablist">
  38. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  39. <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  40. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  41. </ul>
  42. </div>
  43. </div><!-- top -->
  44. <div class="header">
  45. <div class="summary">
  46. <a href="#pub-methods">Public Member Functions</a> &#124;
  47. <a href="class_sd_spi-members.html">List of all members</a> </div>
  48. <div class="headertitle">
  49. <div class="title">SdSpi Class Reference</div> </div>
  50. </div><!--header-->
  51. <div class="contents">
  52. <p>SPI class for access to SD and SDHC flash memory cards.
  53. <a href="class_sd_spi.html#details">More...</a></p>
  54. <p><code>#include &lt;SdSpi.h&gt;</code></p>
  55. <table class="memberdecls">
  56. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  57. Public Member Functions</h2></td></tr>
  58. <tr class="memitem:a607aa7e4655f29bb16ed75b66ffc2c20"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi.html#a607aa7e4655f29bb16ed75b66ffc2c20">begin</a> ()</td></tr>
  59. <tr class="separator:a607aa7e4655f29bb16ed75b66ffc2c20"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:a94af33b695f52bba5fc2c6435e676096"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi.html#a94af33b695f52bba5fc2c6435e676096">init</a> (uint8_t spiDivisor)</td></tr>
  61. <tr class="separator:a94af33b695f52bba5fc2c6435e676096"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:aa017fd1d2bd196d1cbc4b845f6a72a40"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi.html#aa017fd1d2bd196d1cbc4b845f6a72a40">receive</a> ()</td></tr>
  63. <tr class="separator:aa017fd1d2bd196d1cbc4b845f6a72a40"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:a223c3b67496b7a05035060d68e8b7e0e"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi.html#a223c3b67496b7a05035060d68e8b7e0e">receive</a> (uint8_t *buf, size_t n)</td></tr>
  65. <tr class="separator:a223c3b67496b7a05035060d68e8b7e0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a3c6369cd5cc2e1631bcc24e9194eb09a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi.html#a3c6369cd5cc2e1631bcc24e9194eb09a">send</a> (uint8_t data)</td></tr>
  67. <tr class="separator:a3c6369cd5cc2e1631bcc24e9194eb09a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a97ef912cdc43e0800e0184160581f89e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi.html#a97ef912cdc43e0800e0184160581f89e">send</a> (const uint8_t *buf, size_t n)</td></tr>
  69. <tr class="separator:a97ef912cdc43e0800e0184160581f89e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. </table>
  71. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  72. <div class="textblock"><p>SPI class for access to SD and SDHC flash memory cards. </p>
  73. </div><h2 class="groupheader">Member Function Documentation</h2>
  74. <a class="anchor" id="a607aa7e4655f29bb16ed75b66ffc2c20"></a>
  75. <div class="memitem">
  76. <div class="memproto">
  77. <table class="memname">
  78. <tr>
  79. <td class="memname">void SdSpi::begin </td>
  80. <td>(</td>
  81. <td class="paramname"></td><td>)</td>
  82. <td></td>
  83. </tr>
  84. </table>
  85. </div><div class="memdoc">
  86. <p>Initialize the SPI bus </p>
  87. </div>
  88. </div>
  89. <a class="anchor" id="a94af33b695f52bba5fc2c6435e676096"></a>
  90. <div class="memitem">
  91. <div class="memproto">
  92. <table class="memname">
  93. <tr>
  94. <td class="memname">void SdSpi::init </td>
  95. <td>(</td>
  96. <td class="paramtype">uint8_t&#160;</td>
  97. <td class="paramname"><em>spiDivisor</em></td><td>)</td>
  98. <td></td>
  99. </tr>
  100. </table>
  101. </div><div class="memdoc">
  102. <p>Set SPI options for access to SD/SDHC cards.</p>
  103. <dl class="params"><dt>Parameters</dt><dd>
  104. <table class="params">
  105. <tr><td class="paramdir">[in]</td><td class="paramname">spiDivisor</td><td>SCK clock divider relative to the system clock. </td></tr>
  106. </table>
  107. </dd>
  108. </dl>
  109. </div>
  110. </div>
  111. <a class="anchor" id="aa017fd1d2bd196d1cbc4b845f6a72a40"></a>
  112. <div class="memitem">
  113. <div class="memproto">
  114. <table class="memname">
  115. <tr>
  116. <td class="memname">uint8_t SdSpi::receive </td>
  117. <td>(</td>
  118. <td class="paramname"></td><td>)</td>
  119. <td></td>
  120. </tr>
  121. </table>
  122. </div><div class="memdoc">
  123. <p>Receive a byte.</p>
  124. <dl class="section return"><dt>Returns</dt><dd>The byte. </dd></dl>
  125. </div>
  126. </div>
  127. <a class="anchor" id="a223c3b67496b7a05035060d68e8b7e0e"></a>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="memname">
  131. <tr>
  132. <td class="memname">uint8_t SdSpi::receive </td>
  133. <td>(</td>
  134. <td class="paramtype">uint8_t *&#160;</td>
  135. <td class="paramname"><em>buf</em>, </td>
  136. </tr>
  137. <tr>
  138. <td class="paramkey"></td>
  139. <td></td>
  140. <td class="paramtype">size_t&#160;</td>
  141. <td class="paramname"><em>n</em>&#160;</td>
  142. </tr>
  143. <tr>
  144. <td></td>
  145. <td>)</td>
  146. <td></td><td></td>
  147. </tr>
  148. </table>
  149. </div><div class="memdoc">
  150. <p>Receive multiple bytes.</p>
  151. <dl class="params"><dt>Parameters</dt><dd>
  152. <table class="params">
  153. <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer to receive the data. </td></tr>
  154. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes to receive.</td></tr>
  155. </table>
  156. </dd>
  157. </dl>
  158. <dl class="section return"><dt>Returns</dt><dd>Zero for no error or nonzero error code. </dd></dl>
  159. </div>
  160. </div>
  161. <a class="anchor" id="a3c6369cd5cc2e1631bcc24e9194eb09a"></a>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">void SdSpi::send </td>
  167. <td>(</td>
  168. <td class="paramtype">uint8_t&#160;</td>
  169. <td class="paramname"><em>data</em></td><td>)</td>
  170. <td></td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>Send a byte.</p>
  175. <dl class="params"><dt>Parameters</dt><dd>
  176. <table class="params">
  177. <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Byte to send </td></tr>
  178. </table>
  179. </dd>
  180. </dl>
  181. </div>
  182. </div>
  183. <a class="anchor" id="a97ef912cdc43e0800e0184160581f89e"></a>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">void SdSpi::send </td>
  189. <td>(</td>
  190. <td class="paramtype">const uint8_t *&#160;</td>
  191. <td class="paramname"><em>buf</em>, </td>
  192. </tr>
  193. <tr>
  194. <td class="paramkey"></td>
  195. <td></td>
  196. <td class="paramtype">size_t&#160;</td>
  197. <td class="paramname"><em>n</em>&#160;</td>
  198. </tr>
  199. <tr>
  200. <td></td>
  201. <td>)</td>
  202. <td></td><td></td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <p>Send multiple bytes.</p>
  207. <dl class="params"><dt>Parameters</dt><dd>
  208. <table class="params">
  209. <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Buffer for data to be sent. </td></tr>
  210. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes to send. </td></tr>
  211. </table>
  212. </dd>
  213. </dl>
  214. </div>
  215. </div>
  216. <hr/>The documentation for this class was generated from the following file:<ul>
  217. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_spi_8h.html">SdSpi.h</a></li>
  218. </ul>
  219. </div><!-- contents -->
  220. <!-- start footer part -->
  221. <hr class="footer"/><address class="footer"><small>
  222. Generated on Sat Oct 25 2014 07:56:23 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  223. <img class="footer" src="doxygen.png" alt="doxygen"/>
  224. </a> 1.8.8
  225. </small></address>
  226. </body>
  227. </html>