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

405 lines
17KB
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: MySpiClass 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_my_spi_class-members.html">List of all members</a>  </div>

  67.   <div class="headertitle">

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

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

  70. <div class="contents">

  71. 

  72. <p>Sample external SPI class.  

  73.  <a href="class_my_spi_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 MySpiClass:</div>

  78. <div class="dyncontent">

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

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

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

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

  83. </map>

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

  85. <div class="dynheader">

  86. Collaboration diagram for MySpiClass:</div>

  87. <div class="dyncontent">

  88. <div class="center"><img src="class_my_spi_class__coll__graph.png" border="0" usemap="#_my_spi_class_coll__map" alt="Collaboration graph"/></div>

  89. <map name="_my_spi_class_coll__map" id="_my_spi_class_coll__map">

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

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

  92. </map>

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

  94. <table class="memberdecls">

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

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

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

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

  99. <tr class="memitem:a62201e250cb0a71d71c9bd00bfaabe4d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_my_spi_class.html#a62201e250cb0a71d71c9bd00bfaabe4d">begin</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

  113. </table>

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

  115. <div class="textblock"><p>Sample external SPI class. </p>

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

  117. <a id="a906649904dde5b504bdc12d5b125cdce"></a>

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

  119. 

  120. <div class="memitem">

  121. <div class="memproto">

  122. <table class="mlabels">

  123.   <tr>

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

  125.       <table class="memname">

  126.         <tr>

  127.           <td class="memname">void MySpiClass::activate </td>

  128.           <td>(</td>

  129.           <td class="paramname"></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 class="mlabel">virtual</span></span>  </td>

  136.   </tr>

  137. </table>

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

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

  140. 

  141. <p>Reimplemented from <a class="el" href="class_sd_spi_base_class.html#ace7d46253efcaaab8b6be50cc17233e4">SdSpiBaseClass</a>.</p>

  142. 

  143. </div>

  144. </div>

  145. <a id="a62201e250cb0a71d71c9bd00bfaabe4d"></a>

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

  147. 

  148. <div class="memitem">

  149. <div class="memproto">

  150. <table class="mlabels">

  151.   <tr>

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

  153.       <table class="memname">

  154.         <tr>

  155.           <td class="memname">void MySpiClass::begin </td>

  156.           <td>(</td>

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

  158.           <td></td>

  159.         </tr>

  160.       </table>

  161.   </td>

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

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

  164.   </tr>

  165. </table>

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

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

  168. 

  169. <p>Implements <a class="el" href="class_sd_spi_base_class.html#ae186fa647e8e332a9e87d765f92047a5">SdSpiBaseClass</a>.</p>

  170. 

  171. </div>

  172. </div>

  173. <a id="a35e19b66e25678ba3928e047270e45c4"></a>

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

  175. 

  176. <div class="memitem">

  177. <div class="memproto">

  178. <table class="mlabels">

  179.   <tr>

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

  181.       <table class="memname">

  182.         <tr>

  183.           <td class="memname">void MySpiClass::deactivate </td>

  184.           <td>(</td>

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

  186.           <td></td>

  187.         </tr>

  188.       </table>

  189.   </td>

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

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

  192.   </tr>

  193. </table>

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

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

  196. 

  197. <p>Reimplemented from <a class="el" href="class_sd_spi_base_class.html#ae3a5ede781e390263382fcf7765d665d">SdSpiBaseClass</a>.</p>

  198. 

  199. </div>

  200. </div>

  201. <a id="ab7a11bf55dba84c8437e29940ee72276"></a>

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

  203. 

  204. <div class="memitem">

  205. <div class="memproto">

  206. <table class="mlabels">

  207.   <tr>

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

  209.       <table class="memname">

  210.         <tr>

  211.           <td class="memname">uint8_t MySpiClass::receive </td>

  212.           <td>(</td>

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

  214.           <td></td>

  215.         </tr>

  216.       </table>

  217.   </td>

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

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

  220.   </tr>

  221. </table>

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

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

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

  225. 

  226. <p>Implements <a class="el" href="class_sd_spi_base_class.html#a537c71fb2cdb8a825215c0faeb6f7dbd">SdSpiBaseClass</a>.</p>

  227. 

  228. </div>

  229. </div>

  230. <a id="a14913993cfaf4a48805cdddbdf883e4f"></a>

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

  232. 

  233. <div class="memitem">

  234. <div class="memproto">

  235. <table class="mlabels">

  236.   <tr>

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

  238.       <table class="memname">

  239.         <tr>

  240.           <td class="memname">uint8_t MySpiClass::receive </td>

  241.           <td>(</td>

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

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

  244.         </tr>

  245.         <tr>

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

  247.           <td></td>

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

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

  250.         </tr>

  251.         <tr>

  252.           <td></td>

  253.           <td>)</td>

  254.           <td></td><td></td>

  255.         </tr>

  256.       </table>

  257.   </td>

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

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

  260.   </tr>

  261. </table>

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

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

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

  265.   <table class="params">

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

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

  268.   </table>

  269.   </dd>

  270. </dl>

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

  272. 

  273. <p>Implements <a class="el" href="class_sd_spi_base_class.html#a45693c18a8bb44ec9e5b9b1dee39b393">SdSpiBaseClass</a>.</p>

  274. 

  275. </div>

  276. </div>

  277. <a id="a27a8048d69b6715afdbe8c58d8a08bb6"></a>

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

  279. 

  280. <div class="memitem">

  281. <div class="memproto">

  282. <table class="mlabels">

  283.   <tr>

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

  285.       <table class="memname">

  286.         <tr>

  287.           <td class="memname">void MySpiClass::send </td>

  288.           <td>(</td>

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

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

  291.         </tr>

  292.         <tr>

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

  294.           <td></td>

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

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

  297.         </tr>

  298.         <tr>

  299.           <td></td>

  300.           <td>)</td>

  301.           <td></td><td></td>

  302.         </tr>

  303.       </table>

  304.   </td>

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

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

  307.   </tr>

  308. </table>

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

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

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

  312.   <table class="params">

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

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

  315.   </table>

  316.   </dd>

  317. </dl>

  318. 

  319. <p>Implements <a class="el" href="class_sd_spi_base_class.html#a51923b03f35af4bac7c3bb7c8d13303d">SdSpiBaseClass</a>.</p>

  320. 

  321. </div>

  322. </div>

  323. <a id="a7f7369452d8a82f0dc24be00bba9c962"></a>

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

  325. 

  326. <div class="memitem">

  327. <div class="memproto">

  328. <table class="mlabels">

  329.   <tr>

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

  331.       <table class="memname">

  332.         <tr>

  333.           <td class="memname">void MySpiClass::send </td>

  334.           <td>(</td>

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

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

  337.           <td></td>

  338.         </tr>

  339.       </table>

  340.   </td>

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

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

  343.   </tr>

  344. </table>

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

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

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

  348.   <table class="params">

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

  350.   </table>

  351.   </dd>

  352. </dl>

  353. 

  354. <p>Implements <a class="el" href="class_sd_spi_base_class.html#a28001200e3d464f5c6e910837924c577">SdSpiBaseClass</a>.</p>

  355. 

  356. </div>

  357. </div>

  358. <a id="a82e307da53a6d5d1003426c1ac30a915"></a>

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

  360. 

  361. <div class="memitem">

  362. <div class="memproto">

  363. <table class="mlabels">

  364.   <tr>

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

  366.       <table class="memname">

  367.         <tr>

  368.           <td class="memname">void MySpiClass::setSckSpeed </td>

  369.           <td>(</td>

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

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

  372.           <td></td>

  373.         </tr>

  374.       </table>

  375.   </td>

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

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

  378.   </tr>

  379. </table>

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

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

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

  383.   <table class="params">

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

  385.   </table>

  386.   </dd>

  387. </dl>

  388. 

  389. <p>Reimplemented from <a class="el" href="class_sd_spi_base_class.html#a937215f1dc238285bd140c11ab82bbc9">SdSpiBaseClass</a>.</p>

  390. 

  391. </div>

  392. </div>

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

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

  395. </ul>

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

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

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

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

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

  401. </a> 1.8.16

  402. </small></address>

  403. </body>

  404. </html>