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.
7 Commits
1 Branch
Tree: 2e8eeb8434
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '2e8eeb8434'
${ noResults }
teensy-sdfat/html/class_sd_spi.html

237 lines
9.4KB
Raw Blame History 

  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: 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.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_sd_spi-members.html">List of all members</a>  </div>

  49.   <div class="headertitle">

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

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

  52. <div class="contents">

  53. 

  54. <p>SPI class for access to SD and SDHC flash memory cards.  

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

  56. 

  57. <p><code>#include &lt;SdSpi.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: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>

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

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

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

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

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

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

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

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

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

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

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

  73. </table>

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

  75. <div class="textblock"><p>SPI class for access to SD and SDHC flash memory cards. </p>

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

  77. <a class="anchor" id="a607aa7e4655f29bb16ed75b66ffc2c20"></a>

  78. <div class="memitem">

  79. <div class="memproto">

  80.       <table class="memname">

  81.         <tr>

  82.           <td class="memname">void SdSpi::begin </td>

  83.           <td>(</td>

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

  85.           <td></td>

  86.         </tr>

  87.       </table>

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

  89. <p>Initialize the SPI bus </p>

  90. 

  91. </div>

  92. </div>

  93. <a class="anchor" id="a94af33b695f52bba5fc2c6435e676096"></a>

  94. <div class="memitem">

  95. <div class="memproto">

  96.       <table class="memname">

  97.         <tr>

  98.           <td class="memname">void SdSpi::init </td>

  99.           <td>(</td>

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

  101.           <td class="paramname"><em>spiDivisor</em></td><td>)</td>

  102.           <td></td>

  103.         </tr>

  104.       </table>

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

  106. <p>Set SPI options for access to SD/SDHC cards.</p>

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

  108.   <table class="params">

  109.     <tr><td class="paramdir">[in]</td><td class="paramname">spiDivisor</td><td>SCK clock divider relative to the system clock. </td></tr>

  110.   </table>

  111.   </dd>

  112. </dl>

  113. 

  114. </div>

  115. </div>

  116. <a class="anchor" id="aa017fd1d2bd196d1cbc4b845f6a72a40"></a>

  117. <div class="memitem">

  118. <div class="memproto">

  119.       <table class="memname">

  120.         <tr>

  121.           <td class="memname">uint8_t SdSpi::receive </td>

  122.           <td>(</td>

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

  124.           <td></td>

  125.         </tr>

  126.       </table>

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

  128. <p>Receive a byte.</p>

  129. <dl class="section return"><dt>Returns</dt><dd>The byte. </dd></dl>

  130. 

  131. </div>

  132. </div>

  133. <a class="anchor" id="a223c3b67496b7a05035060d68e8b7e0e"></a>

  134. <div class="memitem">

  135. <div class="memproto">

  136.       <table class="memname">

  137.         <tr>

  138.           <td class="memname">uint8_t SdSpi::receive </td>

  139.           <td>(</td>

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

  141.           <td class="paramname"><em>buf</em>, </td>

  142.         </tr>

  143.         <tr>

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

  145.           <td></td>

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

  147.           <td class="paramname"><em>n</em>&#160;</td>

  148.         </tr>

  149.         <tr>

  150.           <td></td>

  151.           <td>)</td>

  152.           <td></td><td></td>

  153.         </tr>

  154.       </table>

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

  156. <p>Receive multiple bytes.</p>

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

  158.   <table class="params">

  159.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer to receive the data. </td></tr>

  160.     <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes to receive.</td></tr>

  161.   </table>

  162.   </dd>

  163. </dl>

  164. <dl class="section return"><dt>Returns</dt><dd>Zero for no error or nonzero error code. </dd></dl>

  165. 

  166. </div>

  167. </div>

  168. <a class="anchor" id="a3c6369cd5cc2e1631bcc24e9194eb09a"></a>

  169. <div class="memitem">

  170. <div class="memproto">

  171.       <table class="memname">

  172.         <tr>

  173.           <td class="memname">void SdSpi::send </td>

  174.           <td>(</td>

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

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

  177.           <td></td>

  178.         </tr>

  179.       </table>

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

  181. <p>Send a byte.</p>

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

  183.   <table class="params">

  184.     <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Byte to send </td></tr>

  185.   </table>

  186.   </dd>

  187. </dl>

  188. 

  189. </div>

  190. </div>

  191. <a class="anchor" id="a97ef912cdc43e0800e0184160581f89e"></a>

  192. <div class="memitem">

  193. <div class="memproto">

  194.       <table class="memname">

  195.         <tr>

  196.           <td class="memname">void SdSpi::send </td>

  197.           <td>(</td>

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

  199.           <td class="paramname"><em>buf</em>, </td>

  200.         </tr>

  201.         <tr>

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

  203.           <td></td>

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

  205.           <td class="paramname"><em>n</em>&#160;</td>

  206.         </tr>

  207.         <tr>

  208.           <td></td>

  209.           <td>)</td>

  210.           <td></td><td></td>

  211.         </tr>

  212.       </table>

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

  214. <p>Send multiple bytes.</p>

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

  216.   <table class="params">

  217.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Buffer for data to be sent. </td></tr>

  218.     <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes to send. </td></tr>

  219.   </table>

  220.   </dd>

  221. </dl>

  222. 

  223. </div>

  224. </div>

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

  226. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_spi_8h.html">SdSpi.h</a></li>

  227. </ul>

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

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

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

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

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

  233. </a> 1.8.6

  234. </small></address>

  235. </body>

  236. </html>