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.
48 Commits
1 Branch
Tree: 40b41c8764
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '40b41c8764'
${ noResults }
teensy-sdfat/extras/html/class_sd_lib_spi_driver.html

434 lines
17KB
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.14"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>SdFat: SdLibSpiDriver Class Reference</title>

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

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

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

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

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

  24.    <div id="projectname">SdFat

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

  32. <!-- Generated by Doxygen 1.8.14 -->

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

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

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

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

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

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

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

  45. });

  46. /* @license-end */</script>

  47. <div id="main-nav"></div>

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

  66. <a href="class_sd_lib_spi_driver-members.html">List of all members</a>  </div>

  67.   <div class="headertitle">

  68. <div class="title">SdLibSpiDriver Class Reference</div>  </div>

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

  70. <div class="contents">

  71. 

  72. <p><a class="el" href="class_sd_lib_spi_driver.html" title="SdLibSpiDriver - use standard SPI library. ">SdLibSpiDriver</a> - use standard SPI library.  

  73.  <a href="class_sd_lib_spi_driver.html#details">More...</a></p>

  74. 

  75. <p><code>#include &lt;SdSpiArduinoDriver.h&gt;</code></p>

  76. <table class="memberdecls">

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

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

  79. <tr class="memitem:a6110352e94291ef173dd6078b891b4b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_lib_spi_driver.html#a6110352e94291ef173dd6078b891b4b2">activate</a> ()</td></tr>

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

  81. <tr class="memitem:a8c16fc5f2003f4405f2dd8f518ed41fa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_lib_spi_driver.html#a8c16fc5f2003f4405f2dd8f518ed41fa">begin</a> (<a class="el" href="class_sd_spi_config.html">SdSpiConfig</a> spiConfig)</td></tr>

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

  83. <tr class="memitem:a4347a13e11e1fe5760f11f3bf229d3ce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_lib_spi_driver.html#a4347a13e11e1fe5760f11f3bf229d3ce">deactivate</a> ()</td></tr>

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

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

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

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

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

  89. <tr class="memitem:a57f9fd00a241e400b86531de7bda14fc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_lib_spi_driver.html#a57f9fd00a241e400b86531de7bda14fc">select</a> ()</td></tr>

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

  91. <tr class="memitem:ae230d2b5c33ec1d70d05b484d3646927"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_lib_spi_driver.html#ae230d2b5c33ec1d70d05b484d3646927">send</a> (uint8_t data)</td></tr>

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

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

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

  95. <tr class="memitem:a3b2729f466d0c334e9627c8a011555c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_lib_spi_driver.html#a3b2729f466d0c334e9627c8a011555c4">setHighSpeed</a> (<a class="el" href="class_sd_spi_config.html">SdSpiConfig</a> spiConfig)</td></tr>

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

  97. <tr class="memitem:a57af8105e517abe4fb93b671b571eedf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_lib_spi_driver.html#a57af8105e517abe4fb93b671b571eedf">unselect</a> ()</td></tr>

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

  99. </table>

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

  101. <div class="textblock"><p><a class="el" href="class_sd_lib_spi_driver.html" title="SdLibSpiDriver - use standard SPI library. ">SdLibSpiDriver</a> - use standard SPI library. </p>

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

  103. <a id="a6110352e94291ef173dd6078b891b4b2"></a>

  104. <h2 class="memtitle"><span class="permalink"><a href="#a6110352e94291ef173dd6078b891b4b2">&#9670;&nbsp;</a></span>activate()</h2>

  105. 

  106. <div class="memitem">

  107. <div class="memproto">

  108. <table class="mlabels">

  109.   <tr>

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

  111.       <table class="memname">

  112.         <tr>

  113.           <td class="memname">void SdLibSpiDriver::activate </td>

  114.           <td>(</td>

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

  116.           <td></td>

  117.         </tr>

  118.       </table>

  119.   </td>

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

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

  122.   </tr>

  123. </table>

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

  125. <p>Activate SPI hardware. </p>

  126. 

  127. </div>

  128. </div>

  129. <a id="a8c16fc5f2003f4405f2dd8f518ed41fa"></a>

  130. <h2 class="memtitle"><span class="permalink"><a href="#a8c16fc5f2003f4405f2dd8f518ed41fa">&#9670;&nbsp;</a></span>begin()</h2>

  131. 

  132. <div class="memitem">

  133. <div class="memproto">

  134. <table class="mlabels">

  135.   <tr>

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

  137.       <table class="memname">

  138.         <tr>

  139.           <td class="memname">void SdLibSpiDriver::begin </td>

  140.           <td>(</td>

  141.           <td class="paramtype"><a class="el" href="class_sd_spi_config.html">SdSpiConfig</a>&#160;</td>

  142.           <td class="paramname"><em>spiConfig</em></td><td>)</td>

  143.           <td></td>

  144.         </tr>

  145.       </table>

  146.   </td>

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

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

  149.   </tr>

  150. </table>

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

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

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

  154.   <table class="params">

  155.     <tr><td class="paramdir">[in]</td><td class="paramname">spiConfig</td><td>SD card configuration. </td></tr>

  156.   </table>

  157.   </dd>

  158. </dl>

  159. 

  160. </div>

  161. </div>

  162. <a id="a4347a13e11e1fe5760f11f3bf229d3ce"></a>

  163. <h2 class="memtitle"><span class="permalink"><a href="#a4347a13e11e1fe5760f11f3bf229d3ce">&#9670;&nbsp;</a></span>deactivate()</h2>

  164. 

  165. <div class="memitem">

  166. <div class="memproto">

  167. <table class="mlabels">

  168.   <tr>

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

  170.       <table class="memname">

  171.         <tr>

  172.           <td class="memname">void SdLibSpiDriver::deactivate </td>

  173.           <td>(</td>

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

  175.           <td></td>

  176.         </tr>

  177.       </table>

  178.   </td>

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

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

  181.   </tr>

  182. </table>

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

  184. <p>Deactivate SPI hardware. </p>

  185. 

  186. </div>

  187. </div>

  188. <a id="af0852fab95dff181466bcd741cbfb180"></a>

  189. <h2 class="memtitle"><span class="permalink"><a href="#af0852fab95dff181466bcd741cbfb180">&#9670;&nbsp;</a></span>receive() <span class="overload">[1/2]</span></h2>

  190. 

  191. <div class="memitem">

  192. <div class="memproto">

  193. <table class="mlabels">

  194.   <tr>

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

  196.       <table class="memname">

  197.         <tr>

  198.           <td class="memname">uint8_t SdLibSpiDriver::receive </td>

  199.           <td>(</td>

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

  201.           <td></td>

  202.         </tr>

  203.       </table>

  204.   </td>

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

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

  207.   </tr>

  208. </table>

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

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

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

  212. 

  213. </div>

  214. </div>

  215. <a id="a88d3d8aa37df991a469e0246a167b39d"></a>

  216. <h2 class="memtitle"><span class="permalink"><a href="#a88d3d8aa37df991a469e0246a167b39d">&#9670;&nbsp;</a></span>receive() <span class="overload">[2/2]</span></h2>

  217. 

  218. <div class="memitem">

  219. <div class="memproto">

  220. <table class="mlabels">

  221.   <tr>

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

  223.       <table class="memname">

  224.         <tr>

  225.           <td class="memname">uint8_t SdLibSpiDriver::receive </td>

  226.           <td>(</td>

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

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

  229.         </tr>

  230.         <tr>

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

  232.           <td></td>

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

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

  235.         </tr>

  236.         <tr>

  237.           <td></td>

  238.           <td>)</td>

  239.           <td></td><td></td>

  240.         </tr>

  241.       </table>

  242.   </td>

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

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

  245.   </tr>

  246. </table>

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

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

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

  250.   <table class="params">

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

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

  253.   </table>

  254.   </dd>

  255. </dl>

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

  257. 

  258. </div>

  259. </div>

  260. <a id="a57f9fd00a241e400b86531de7bda14fc"></a>

  261. <h2 class="memtitle"><span class="permalink"><a href="#a57f9fd00a241e400b86531de7bda14fc">&#9670;&nbsp;</a></span>select()</h2>

  262. 

  263. <div class="memitem">

  264. <div class="memproto">

  265. <table class="mlabels">

  266.   <tr>

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

  268.       <table class="memname">

  269.         <tr>

  270.           <td class="memname">void SdLibSpiDriver::select </td>

  271.           <td>(</td>

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

  273.           <td></td>

  274.         </tr>

  275.       </table>

  276.   </td>

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

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

  279.   </tr>

  280. </table>

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

  282. <p>Set CS low. </p>

  283. 

  284. </div>

  285. </div>

  286. <a id="ae230d2b5c33ec1d70d05b484d3646927"></a>

  287. <h2 class="memtitle"><span class="permalink"><a href="#ae230d2b5c33ec1d70d05b484d3646927">&#9670;&nbsp;</a></span>send() <span class="overload">[1/2]</span></h2>

  288. 

  289. <div class="memitem">

  290. <div class="memproto">

  291. <table class="mlabels">

  292.   <tr>

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

  294.       <table class="memname">

  295.         <tr>

  296.           <td class="memname">void SdLibSpiDriver::send </td>

  297.           <td>(</td>

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

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

  300.           <td></td>

  301.         </tr>

  302.       </table>

  303.   </td>

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

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

  306.   </tr>

  307. </table>

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

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

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

  311.   <table class="params">

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

  313.   </table>

  314.   </dd>

  315. </dl>

  316. 

  317. </div>

  318. </div>

  319. <a id="a55c733d8dafab2272889431d20001419"></a>

  320. <h2 class="memtitle"><span class="permalink"><a href="#a55c733d8dafab2272889431d20001419">&#9670;&nbsp;</a></span>send() <span class="overload">[2/2]</span></h2>

  321. 

  322. <div class="memitem">

  323. <div class="memproto">

  324. <table class="mlabels">

  325.   <tr>

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

  327.       <table class="memname">

  328.         <tr>

  329.           <td class="memname">void SdLibSpiDriver::send </td>

  330.           <td>(</td>

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

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

  333.         </tr>

  334.         <tr>

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

  336.           <td></td>

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

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

  339.         </tr>

  340.         <tr>

  341.           <td></td>

  342.           <td>)</td>

  343.           <td></td><td></td>

  344.         </tr>

  345.       </table>

  346.   </td>

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

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

  349.   </tr>

  350. </table>

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

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

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

  354.   <table class="params">

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

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

  357.   </table>

  358.   </dd>

  359. </dl>

  360. 

  361. </div>

  362. </div>

  363. <a id="a3b2729f466d0c334e9627c8a011555c4"></a>

  364. <h2 class="memtitle"><span class="permalink"><a href="#a3b2729f466d0c334e9627c8a011555c4">&#9670;&nbsp;</a></span>setHighSpeed()</h2>

  365. 

  366. <div class="memitem">

  367. <div class="memproto">

  368. <table class="mlabels">

  369.   <tr>

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

  371.       <table class="memname">

  372.         <tr>

  373.           <td class="memname">void SdLibSpiDriver::setHighSpeed </td>

  374.           <td>(</td>

  375.           <td class="paramtype"><a class="el" href="class_sd_spi_config.html">SdSpiConfig</a>&#160;</td>

  376.           <td class="paramname"><em>spiConfig</em></td><td>)</td>

  377.           <td></td>

  378.         </tr>

  379.       </table>

  380.   </td>

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

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

  383.   </tr>

  384. </table>

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

  386. <p>Save high speed SPISettings after SD initialization.</p>

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

  388.   <table class="params">

  389.     <tr><td class="paramdir">[in]</td><td class="paramname">spiConfig</td><td>SPI options. </td></tr>

  390.   </table>

  391.   </dd>

  392. </dl>

  393. 

  394. </div>

  395. </div>

  396. <a id="a57af8105e517abe4fb93b671b571eedf"></a>

  397. <h2 class="memtitle"><span class="permalink"><a href="#a57af8105e517abe4fb93b671b571eedf">&#9670;&nbsp;</a></span>unselect()</h2>

  398. 

  399. <div class="memitem">

  400. <div class="memproto">

  401. <table class="mlabels">

  402.   <tr>

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

  404.       <table class="memname">

  405.         <tr>

  406.           <td class="memname">void SdLibSpiDriver::unselect </td>

  407.           <td>(</td>

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

  409.           <td></td>

  410.         </tr>

  411.       </table>

  412.   </td>

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

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

  415.   </tr>

  416. </table>

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

  418. <p>Set CS high. </p>

  419. 

  420. </div>

  421. </div>

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

  423. <li>ArduinoSdFat/libraries/SdFat/src/SpiDriver/<a class="el" href="_sd_spi_arduino_driver_8h.html">SdSpiArduinoDriver.h</a></li>

  424. </ul>

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

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

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

  428. Generated on Thu May 9 2019 06:51:29 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  430. </a> 1.8.14

  431. </small></address>

  432. </body>

  433. </html>