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

357 lines
14KB
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.10"/>

  7. <title>SdFat: SdSpiLib 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="search/search.css" rel="stylesheet" type="text/css"/>

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

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

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

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

  16. </script>

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

  18. </head>

  19. <body>

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

  21. <div id="titlearea">

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

  23.  <tbody>

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

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

  26.    <div id="projectname">SdFat

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

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

  34. <!-- Generated by Doxygen 1.8.10 -->

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

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

  37. </script>

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

  39.     <ul class="tablist">

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

  41.       <li><a href="modules.html"><span>Modules</span></a></li>

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

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

  44.       <li>

  45.         <div id="MSearchBox" class="MSearchBoxInactive">

  46.         <span class="left">

  47.           <img id="MSearchSelect" src="search/mag_sel.png"

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

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

  50.                alt=""/>

  51.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  52.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  53.                onblur="searchBox.OnSearchFieldFocus(false)" 

  54.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  55.           </span><span class="right">

  56.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

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

  63.     <ul class="tablist">

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

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

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

  67.     </ul>

  68.   </div>

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

  70. <div id="MSearchSelectWindow"

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

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

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

  74. </div>

  75. 

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

  77. <div id="MSearchResultsWindow">

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

  79.         name="MSearchResults" id="MSearchResults">

  80. </iframe>

  81. </div>

  82. 

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

  84. <div class="header">

  85.   <div class="summary">

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

  87. <a href="class_sd_spi_lib-members.html">List of all members</a>  </div>

  88.   <div class="headertitle">

  89. <div class="title">SdSpiLib Class Reference</div>  </div>

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

  91. <div class="contents">

  92. 

  93. <p>Arduino SPI library class for access to SD and SDHC flash memory cards.  

  94.  <a href="class_sd_spi_lib.html#details">More...</a></p>

  95. 

  96. <p><code>#include &lt;SdSpi.h&gt;</code></p>

  97. <table class="memberdecls">

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

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

  100. <tr class="memitem:aa924fd665bd8598d325e44ff10607bd9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#aa924fd665bd8598d325e44ff10607bd9">begin</a> (uint8_t chipSelectPin)</td></tr>

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

  102. <tr class="memitem:afecc9a75f05a7f3c9d74cd40b310c343"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#afecc9a75f05a7f3c9d74cd40b310c343">beginTransaction</a> (uint8_t divisor)</td></tr>

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

  104. <tr class="memitem:a8e9bf91c47f1923abeb14d338aaae569"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#a8e9bf91c47f1923abeb14d338aaae569">endTransaction</a> ()</td></tr>

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

  106. <tr class="memitem:ac3c8027243a2fef5894809cbb7bed837"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#ac3c8027243a2fef5894809cbb7bed837">receive</a> ()</td></tr>

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

  108. <tr class="memitem:ad835adf6990e6368ec577f00edf365b0"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#ad835adf6990e6368ec577f00edf365b0">receive</a> (uint8_t *buf, size_t n)</td></tr>

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

  110. <tr class="memitem:a070de2435f58f4f98c224c4b1b4be888"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#a070de2435f58f4f98c224c4b1b4be888">send</a> (uint8_t b)</td></tr>

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

  112. <tr class="memitem:a58af4700449aadc2b418fac59fda6e1b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib.html#a58af4700449aadc2b418fac59fda6e1b">send</a> (const uint8_t *buf, size_t n)</td></tr>

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

  114. </table>

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

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

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

  118. <a class="anchor" id="aa924fd665bd8598d325e44ff10607bd9"></a>

  119. <div class="memitem">

  120. <div class="memproto">

  121. <table class="mlabels">

  122.   <tr>

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

  124.       <table class="memname">

  125.         <tr>

  126.           <td class="memname">void SdSpiLib::begin </td>

  127.           <td>(</td>

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

  129.           <td class="paramname"><em>chipSelectPin</em></td><td>)</td>

  130.           <td></td>

  131.         </tr>

  132.       </table>

  133.   </td>

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

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

  136.   </tr>

  137. </table>

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

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

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

  141.   <table class="params">

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

  143.   </table>

  144.   </dd>

  145. </dl>

  146. 

  147. </div>

  148. </div>

  149. <a class="anchor" id="afecc9a75f05a7f3c9d74cd40b310c343"></a>

  150. <div class="memitem">

  151. <div class="memproto">

  152. <table class="mlabels">

  153.   <tr>

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

  155.       <table class="memname">

  156.         <tr>

  157.           <td class="memname">void SdSpiLib::beginTransaction </td>

  158.           <td>(</td>

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

  160.           <td class="paramname"><em>divisor</em></td><td>)</td>

  161.           <td></td>

  162.         </tr>

  163.       </table>

  164.   </td>

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

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

  167.   </tr>

  168. </table>

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

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

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

  172.   <table class="params">

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

  174.   </table>

  175.   </dd>

  176. </dl>

  177. 

  178. </div>

  179. </div>

  180. <a class="anchor" id="a8e9bf91c47f1923abeb14d338aaae569"></a>

  181. <div class="memitem">

  182. <div class="memproto">

  183. <table class="mlabels">

  184.   <tr>

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

  186.       <table class="memname">

  187.         <tr>

  188.           <td class="memname">void SdSpiLib::endTransaction </td>

  189.           <td>(</td>

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

  191.           <td></td>

  192.         </tr>

  193.       </table>

  194.   </td>

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

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

  197.   </tr>

  198. </table>

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

  200. <p>End SPI transaction. </p>

  201. 

  202. </div>

  203. </div>

  204. <a class="anchor" id="ac3c8027243a2fef5894809cbb7bed837"></a>

  205. <div class="memitem">

  206. <div class="memproto">

  207. <table class="mlabels">

  208.   <tr>

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

  210.       <table class="memname">

  211.         <tr>

  212.           <td class="memname">uint8_t SdSpiLib::receive </td>

  213.           <td>(</td>

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

  215.           <td></td>

  216.         </tr>

  217.       </table>

  218.   </td>

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

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

  221.   </tr>

  222. </table>

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

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

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

  226. 

  227. </div>

  228. </div>

  229. <a class="anchor" id="ad835adf6990e6368ec577f00edf365b0"></a>

  230. <div class="memitem">

  231. <div class="memproto">

  232. <table class="mlabels">

  233.   <tr>

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

  235.       <table class="memname">

  236.         <tr>

  237.           <td class="memname">uint8_t SdSpiLib::receive </td>

  238.           <td>(</td>

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

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

  241.         </tr>

  242.         <tr>

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

  244.           <td></td>

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

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

  247.         </tr>

  248.         <tr>

  249.           <td></td>

  250.           <td>)</td>

  251.           <td></td><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>Receive multiple bytes.</p>

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

  262.   <table class="params">

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

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

  265.   </table>

  266.   </dd>

  267. </dl>

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

  269. 

  270. </div>

  271. </div>

  272. <a class="anchor" id="a070de2435f58f4f98c224c4b1b4be888"></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">void SdSpiLib::send </td>

  281.           <td>(</td>

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

  283.           <td class="paramname"><em>b</em></td><td>)</td>

  284.           <td></td>

  285.         </tr>

  286.       </table>

  287.   </td>

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

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

  290.   </tr>

  291. </table>

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

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

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

  295.   <table class="params">

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

  297.   </table>

  298.   </dd>

  299. </dl>

  300. 

  301. </div>

  302. </div>

  303. <a class="anchor" id="a58af4700449aadc2b418fac59fda6e1b"></a>

  304. <div class="memitem">

  305. <div class="memproto">

  306. <table class="mlabels">

  307.   <tr>

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

  309.       <table class="memname">

  310.         <tr>

  311.           <td class="memname">void SdSpiLib::send </td>

  312.           <td>(</td>

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

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

  315.         </tr>

  316.         <tr>

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

  318.           <td></td>

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

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

  321.         </tr>

  322.         <tr>

  323.           <td></td>

  324.           <td>)</td>

  325.           <td></td><td></td>

  326.         </tr>

  327.       </table>

  328.   </td>

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

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

  331.   </tr>

  332. </table>

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

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

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

  336.   <table class="params">

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

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

  339.   </table>

  340.   </dd>

  341. </dl>

  342. 

  343. </div>

  344. </div>

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

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

  347. </ul>

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

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

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

  351. Generated on Fri Feb 12 2016 13:43:49 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  353. </a> 1.8.10

  354. </small></address>

  355. </body>

  356. </html>