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_base_class.html

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

  67.   <div class="headertitle">

  68. <div class="title">SdSpiBaseClass Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>

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

  70. <div class="contents">

  71. 

  72. <p>Base class for external SPI drivers.  

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

  74. 

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

  76. <div class="dynheader">

  77. Inheritance diagram for SdSpiBaseClass:</div>

  78. <div class="dyncontent">

  79. <div class="center"><img src="class_sd_spi_base_class__inherit__graph.png" border="0" usemap="#_sd_spi_base_class_inherit__map" alt="Inheritance graph"/></div>

  80. <map name="_sd_spi_base_class_inherit__map" id="_sd_spi_base_class_inherit__map">

  81. <area shape="rect" title="Base class for external SPI drivers." alt="" coords="5,5,125,32"/>

  82. <area shape="rect" href="class_my_spi_class.html" title="Sample external SPI class." alt="" coords="19,80,111,107"/>

  83. </map>

  84. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

  85. <table class="memberdecls">

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

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

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

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

  90. <tr class="memitem:ae186fa647e8e332a9e87d765f92047a5"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_class.html#ae186fa647e8e332a9e87d765f92047a5">begin</a> ()=0</td></tr>

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

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

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

  94. <tr class="memitem:a537c71fb2cdb8a825215c0faeb6f7dbd"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_class.html#a537c71fb2cdb8a825215c0faeb6f7dbd">receive</a> ()=0</td></tr>

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

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

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

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

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

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

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

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

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

  104. </table>

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

  106. <div class="textblock"><p>Base class for external SPI drivers. </p>

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

  108. <a id="ace7d46253efcaaab8b6be50cc17233e4"></a>

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

  110. 

  111. <div class="memitem">

  112. <div class="memproto">

  113. <table class="mlabels">

  114.   <tr>

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

  116.       <table class="memname">

  117.         <tr>

  118.           <td class="memname">virtual void SdSpiBaseClass::activate </td>

  119.           <td>(</td>

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

  121.           <td></td>

  122.         </tr>

  123.       </table>

  124.   </td>

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

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

  127.   </tr>

  128. </table>

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

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

  131. 

  132. <p>Reimplemented in <a class="el" href="class_my_spi_class.html#a906649904dde5b504bdc12d5b125cdce">MySpiClass</a>.</p>

  133. 

  134. </div>

  135. </div>

  136. <a id="ae186fa647e8e332a9e87d765f92047a5"></a>

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

  138. 

  139. <div class="memitem">

  140. <div class="memproto">

  141. <table class="mlabels">

  142.   <tr>

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

  144.       <table class="memname">

  145.         <tr>

  146.           <td class="memname">virtual void SdSpiBaseClass::begin </td>

  147.           <td>(</td>

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

  149.           <td></td>

  150.         </tr>

  151.       </table>

  152.   </td>

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

  154. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  155.   </tr>

  156. </table>

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

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

  159. 

  160. <p>Implemented in <a class="el" href="class_my_spi_class.html#a62201e250cb0a71d71c9bd00bfaabe4d">MySpiClass</a>.</p>

  161. 

  162. </div>

  163. </div>

  164. <a id="ae3a5ede781e390263382fcf7765d665d"></a>

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

  166. 

  167. <div class="memitem">

  168. <div class="memproto">

  169. <table class="mlabels">

  170.   <tr>

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

  172.       <table class="memname">

  173.         <tr>

  174.           <td class="memname">virtual void SdSpiBaseClass::deactivate </td>

  175.           <td>(</td>

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

  177.           <td></td>

  178.         </tr>

  179.       </table>

  180.   </td>

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

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

  183.   </tr>

  184. </table>

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

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

  187. 

  188. <p>Reimplemented in <a class="el" href="class_my_spi_class.html#a35e19b66e25678ba3928e047270e45c4">MySpiClass</a>.</p>

  189. 

  190. </div>

  191. </div>

  192. <a id="a537c71fb2cdb8a825215c0faeb6f7dbd"></a>

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

  194. 

  195. <div class="memitem">

  196. <div class="memproto">

  197. <table class="mlabels">

  198.   <tr>

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

  200.       <table class="memname">

  201.         <tr>

  202.           <td class="memname">virtual uint8_t SdSpiBaseClass::receive </td>

  203.           <td>(</td>

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

  205.           <td></td>

  206.         </tr>

  207.       </table>

  208.   </td>

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

  210. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  211.   </tr>

  212. </table>

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

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

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

  216. 

  217. <p>Implemented in <a class="el" href="class_my_spi_class.html#ab7a11bf55dba84c8437e29940ee72276">MySpiClass</a>.</p>

  218. 

  219. </div>

  220. </div>

  221. <a id="a45693c18a8bb44ec9e5b9b1dee39b393"></a>

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

  223. 

  224. <div class="memitem">

  225. <div class="memproto">

  226. <table class="mlabels">

  227.   <tr>

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

  229.       <table class="memname">

  230.         <tr>

  231.           <td class="memname">virtual uint8_t SdSpiBaseClass::receive </td>

  232.           <td>(</td>

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

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

  235.         </tr>

  236.         <tr>

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

  238.           <td></td>

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

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

  241.         </tr>

  242.         <tr>

  243.           <td></td>

  244.           <td>)</td>

  245.           <td></td><td></td>

  246.         </tr>

  247.       </table>

  248.   </td>

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

  250. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  251.   </tr>

  252. </table>

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

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

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

  256.   <table class="params">

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

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

  259.   </table>

  260.   </dd>

  261. </dl>

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

  263. 

  264. <p>Implemented in <a class="el" href="class_my_spi_class.html#a14913993cfaf4a48805cdddbdf883e4f">MySpiClass</a>.</p>

  265. 

  266. </div>

  267. </div>

  268. <a id="a51923b03f35af4bac7c3bb7c8d13303d"></a>

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

  270. 

  271. <div class="memitem">

  272. <div class="memproto">

  273. <table class="mlabels">

  274.   <tr>

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

  276.       <table class="memname">

  277.         <tr>

  278.           <td class="memname">virtual void SdSpiBaseClass::send </td>

  279.           <td>(</td>

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

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

  282.         </tr>

  283.         <tr>

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

  285.           <td></td>

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

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

  288.         </tr>

  289.         <tr>

  290.           <td></td>

  291.           <td>)</td>

  292.           <td></td><td></td>

  293.         </tr>

  294.       </table>

  295.   </td>

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

  297. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  298.   </tr>

  299. </table>

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

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

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

  303.   <table class="params">

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

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

  306.   </table>

  307.   </dd>

  308. </dl>

  309. 

  310. <p>Implemented in <a class="el" href="class_my_spi_class.html#a27a8048d69b6715afdbe8c58d8a08bb6">MySpiClass</a>.</p>

  311. 

  312. </div>

  313. </div>

  314. <a id="a28001200e3d464f5c6e910837924c577"></a>

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

  316. 

  317. <div class="memitem">

  318. <div class="memproto">

  319. <table class="mlabels">

  320.   <tr>

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

  322.       <table class="memname">

  323.         <tr>

  324.           <td class="memname">virtual void SdSpiBaseClass::send </td>

  325.           <td>(</td>

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

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

  328.           <td></td>

  329.         </tr>

  330.       </table>

  331.   </td>

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

  333. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  334.   </tr>

  335. </table>

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

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

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

  339.   <table class="params">

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

  341.   </table>

  342.   </dd>

  343. </dl>

  344. 

  345. <p>Implemented in <a class="el" href="class_my_spi_class.html#a7f7369452d8a82f0dc24be00bba9c962">MySpiClass</a>.</p>

  346. 

  347. </div>

  348. </div>

  349. <a id="a937215f1dc238285bd140c11ab82bbc9"></a>

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

  351. 

  352. <div class="memitem">

  353. <div class="memproto">

  354. <table class="mlabels">

  355.   <tr>

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

  357.       <table class="memname">

  358.         <tr>

  359.           <td class="memname">virtual void SdSpiBaseClass::setSckSpeed </td>

  360.           <td>(</td>

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

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

  363.           <td></td>

  364.         </tr>

  365.       </table>

  366.   </td>

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

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

  369.   </tr>

  370. </table>

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

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

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

  374.   <table class="params">

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

  376.   </table>

  377.   </dd>

  378. </dl>

  379. 

  380. <p>Reimplemented in <a class="el" href="class_my_spi_class.html#a82e307da53a6d5d1003426c1ac30a915">MySpiClass</a>.</p>

  381. 

  382. </div>

  383. </div>

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

  385. <li>ArduinoSdFat/libraries/SdFat/src/SpiDriver/<a class="el" href="_sd_spi_base_class_8h.html">SdSpiBaseClass.h</a></li>

  386. </ul>

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

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

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

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

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

  392. </a> 1.8.16

  393. </small></address>

  394. </body>

  395. </html>