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.
60 Commits
1 Branch
Branch: main
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'main'
${ noResults }
teensy-sdfat/extras/html/class_sd_spi_arduino_driver...

400 lines
16KB
Raw Permalink Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.16"/>

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

  8. <title>SdFat: SdSpiArduinoDriver 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.16 -->

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

  67.   <div class="headertitle">

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

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

  70. <div class="contents">

  71. 

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

  73.  <a href="class_sd_spi_arduino_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:abb6b88c5c8b87fc344a69f23f6eab3d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_arduino_driver.html#abb6b88c5c8b87fc344a69f23f6eab3d9">activate</a> ()</td></tr>

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

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

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

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

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

  85. <tr class="memitem:a7f94ce98855bb3d1781bbad77741e494"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_arduino_driver.html#a7f94ce98855bb3d1781bbad77741e494">end</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

  95. <tr class="memitem:acf0cc41d2bd80479237aa2799e119973"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_arduino_driver.html#acf0cc41d2bd80479237aa2799e119973">setSckSpeed</a> (uint32_t maxSck)</td></tr>

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

  97. </table>

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

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

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

  101. <a id="abb6b88c5c8b87fc344a69f23f6eab3d9"></a>

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

  103. 

  104. <div class="memitem">

  105. <div class="memproto">

  106. <table class="mlabels">

  107.   <tr>

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

  109.       <table class="memname">

  110.         <tr>

  111.           <td class="memname">void SdSpiArduinoDriver::activate </td>

  112.           <td>(</td>

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

  114.           <td></td>

  115.         </tr>

  116.       </table>

  117.   </td>

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

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

  120.   </tr>

  121. </table>

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

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

  124. 

  125. </div>

  126. </div>

  127. <a id="ae837a6d51bfe5518cb4744581824db88"></a>

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

  129. 

  130. <div class="memitem">

  131. <div class="memproto">

  132. <table class="mlabels">

  133.   <tr>

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

  135.       <table class="memname">

  136.         <tr>

  137.           <td class="memname">void SdSpiArduinoDriver::begin </td>

  138.           <td>(</td>

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

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

  141.           <td></td>

  142.         </tr>

  143.       </table>

  144.   </td>

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

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

  147.   </tr>

  148. </table>

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

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

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

  152.   <table class="params">

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

  154.   </table>

  155.   </dd>

  156. </dl>

  157. 

  158. </div>

  159. </div>

  160. <a id="ae88a255f533e3acb41d1221025a69b55"></a>

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

  162. 

  163. <div class="memitem">

  164. <div class="memproto">

  165. <table class="mlabels">

  166.   <tr>

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

  168.       <table class="memname">

  169.         <tr>

  170.           <td class="memname">void SdSpiArduinoDriver::deactivate </td>

  171.           <td>(</td>

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

  173.           <td></td>

  174.         </tr>

  175.       </table>

  176.   </td>

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

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

  179.   </tr>

  180. </table>

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

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

  183. 

  184. </div>

  185. </div>

  186. <a id="a7f94ce98855bb3d1781bbad77741e494"></a>

  187. <h2 class="memtitle"><span class="permalink"><a href="#a7f94ce98855bb3d1781bbad77741e494">&#9670;&nbsp;</a></span>end()</h2>

  188. 

  189. <div class="memitem">

  190. <div class="memproto">

  191.       <table class="memname">

  192.         <tr>

  193.           <td class="memname">void SdSpiArduinoDriver::end </td>

  194.           <td>(</td>

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

  196.           <td></td>

  197.         </tr>

  198.       </table>

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

  200. <p>End use of SPI driver after <a class="el" href="class_sd_spi_arduino_driver.html#ae837a6d51bfe5518cb4744581824db88">begin()</a> call. </p>

  201. 

  202. </div>

  203. </div>

  204. <a id="a8d6bc852a52e9d69c4b1e48ee062e8d1"></a>

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

  206. 

  207. <div class="memitem">

  208. <div class="memproto">

  209. <table class="mlabels">

  210.   <tr>

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

  212.       <table class="memname">

  213.         <tr>

  214.           <td class="memname">uint8_t SdSpiArduinoDriver::receive </td>

  215.           <td>(</td>

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

  217.           <td></td>

  218.         </tr>

  219.       </table>

  220.   </td>

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

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

  223.   </tr>

  224. </table>

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

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

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

  228. 

  229. </div>

  230. </div>

  231. <a id="a4f5be313b836ca937a5b5be6432987ec"></a>

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

  233. 

  234. <div class="memitem">

  235. <div class="memproto">

  236. <table class="mlabels">

  237.   <tr>

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

  239.       <table class="memname">

  240.         <tr>

  241.           <td class="memname">uint8_t SdSpiArduinoDriver::receive </td>

  242.           <td>(</td>

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

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

  245.         </tr>

  246.         <tr>

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

  248.           <td></td>

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

  250.           <td class="paramname"><em>count</em>&#160;</td>

  251.         </tr>

  252.         <tr>

  253.           <td></td>

  254.           <td>)</td>

  255.           <td></td><td></td>

  256.         </tr>

  257.       </table>

  258.   </td>

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

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

  261.   </tr>

  262. </table>

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

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

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

  266.   <table class="params">

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

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

  269.   </table>

  270.   </dd>

  271. </dl>

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

  273. 

  274. </div>

  275. </div>

  276. <a id="a0516f7cd20263f90f83c57c4c6ce14e4"></a>

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

  278. 

  279. <div class="memitem">

  280. <div class="memproto">

  281. <table class="mlabels">

  282.   <tr>

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

  284.       <table class="memname">

  285.         <tr>

  286.           <td class="memname">void SdSpiArduinoDriver::send </td>

  287.           <td>(</td>

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

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

  290.         </tr>

  291.         <tr>

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

  293.           <td></td>

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

  295.           <td class="paramname"><em>count</em>&#160;</td>

  296.         </tr>

  297.         <tr>

  298.           <td></td>

  299.           <td>)</td>

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

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

  311.   <table class="params">

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

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

  314.   </table>

  315.   </dd>

  316. </dl>

  317. 

  318. </div>

  319. </div>

  320. <a id="a3c4842e47f98fe5d3799cd6028778ab5"></a>

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

  322. 

  323. <div class="memitem">

  324. <div class="memproto">

  325. <table class="mlabels">

  326.   <tr>

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

  328.       <table class="memname">

  329.         <tr>

  330.           <td class="memname">void SdSpiArduinoDriver::send </td>

  331.           <td>(</td>

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

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

  334.           <td></td>

  335.         </tr>

  336.       </table>

  337.   </td>

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

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

  340.   </tr>

  341. </table>

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

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

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

  345.   <table class="params">

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

  347.   </table>

  348.   </dd>

  349. </dl>

  350. 

  351. </div>

  352. </div>

  353. <a id="acf0cc41d2bd80479237aa2799e119973"></a>

  354. <h2 class="memtitle"><span class="permalink"><a href="#acf0cc41d2bd80479237aa2799e119973">&#9670;&nbsp;</a></span>setSckSpeed()</h2>

  355. 

  356. <div class="memitem">

  357. <div class="memproto">

  358. <table class="mlabels">

  359.   <tr>

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

  361.       <table class="memname">

  362.         <tr>

  363.           <td class="memname">void SdSpiArduinoDriver::setSckSpeed </td>

  364.           <td>(</td>

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

  366.           <td class="paramname"><em>maxSck</em></td><td>)</td>

  367.           <td></td>

  368.         </tr>

  369.       </table>

  370.   </td>

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

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

  373.   </tr>

  374. </table>

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

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

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

  378.   <table class="params">

  379.     <tr><td class="paramdir">[in]</td><td class="paramname">maxSck</td><td>Maximum SCK frequency. </td></tr>

  380.   </table>

  381.   </dd>

  382. </dl>

  383. 

  384. </div>

  385. </div>

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

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

  388. <li>ArduinoSdFat/libraries/SdFat/src/SpiDriver/SdSpiAvr.h</li>

  389. <li>ArduinoSdFat/libraries/SdFat/src/SpiDriver/<a class="el" href="_sd_spi_lib_driver_8h.html">SdSpiLibDriver.h</a></li>

  390. </ul>

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

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

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

  394. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  396. </a> 1.8.16

  397. </small></address>

  398. </body>

  399. </html>