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_external_spi_drive...

378 lines
15KB
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: SdExternalSpiDriver 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_external_spi_driver-members.html">List of all members</a>  </div>

  67.   <div class="headertitle">

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

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

  70. <div class="contents">

  71. 

  72. <p>Class for external SPI.  

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

  74. 

  75. <p><code>#include &lt;SdSpiExternalDriver.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:a7fe3d482ed3fc9118b335ac6b6e4f165"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_external_spi_driver.html#a7fe3d482ed3fc9118b335ac6b6e4f165">activate</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  95. </table>

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

  97. <div class="textblock"><p>Class for external SPI. </p>

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

  99. <a id="a7fe3d482ed3fc9118b335ac6b6e4f165"></a>

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

  101. 

  102. <div class="memitem">

  103. <div class="memproto">

  104. <table class="mlabels">

  105.   <tr>

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

  107.       <table class="memname">

  108.         <tr>

  109.           <td class="memname">void SdExternalSpiDriver::activate </td>

  110.           <td>(</td>

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

  112.           <td></td>

  113.         </tr>

  114.       </table>

  115.   </td>

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

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

  118.   </tr>

  119. </table>

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

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

  122. 

  123. </div>

  124. </div>

  125. <a id="acd422cb20a0332bbb51360f94bf1ca27"></a>

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

  127. 

  128. <div class="memitem">

  129. <div class="memproto">

  130. <table class="mlabels">

  131.   <tr>

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

  133.       <table class="memname">

  134.         <tr>

  135.           <td class="memname">void SdExternalSpiDriver::begin </td>

  136.           <td>(</td>

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

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

  139.           <td></td>

  140.         </tr>

  141.       </table>

  142.   </td>

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

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

  145.   </tr>

  146. </table>

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

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

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

  150.   <table class="params">

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

  152.   </table>

  153.   </dd>

  154. </dl>

  155. 

  156. </div>

  157. </div>

  158. <a id="a783102fbe3037d0b992d47ca04728522"></a>

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

  160. 

  161. <div class="memitem">

  162. <div class="memproto">

  163. <table class="mlabels">

  164.   <tr>

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

  166.       <table class="memname">

  167.         <tr>

  168.           <td class="memname">void SdExternalSpiDriver::deactivate </td>

  169.           <td>(</td>

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

  171.           <td></td>

  172.         </tr>

  173.       </table>

  174.   </td>

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

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

  177.   </tr>

  178. </table>

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

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

  181. 

  182. </div>

  183. </div>

  184. <a id="ab6947d1fc227c4eea9234e88f2844a50"></a>

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

  186. 

  187. <div class="memitem">

  188. <div class="memproto">

  189. <table class="mlabels">

  190.   <tr>

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

  192.       <table class="memname">

  193.         <tr>

  194.           <td class="memname">uint8_t SdExternalSpiDriver::receive </td>

  195.           <td>(</td>

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

  197.           <td></td>

  198.         </tr>

  199.       </table>

  200.   </td>

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

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

  203.   </tr>

  204. </table>

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

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

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

  208. 

  209. </div>

  210. </div>

  211. <a id="a67b526ccd30d288d58a62b1d3d71b8ba"></a>

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

  213. 

  214. <div class="memitem">

  215. <div class="memproto">

  216. <table class="mlabels">

  217.   <tr>

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

  219.       <table class="memname">

  220.         <tr>

  221.           <td class="memname">uint8_t SdExternalSpiDriver::receive </td>

  222.           <td>(</td>

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

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

  225.         </tr>

  226.         <tr>

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

  228.           <td></td>

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

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

  231.         </tr>

  232.         <tr>

  233.           <td></td>

  234.           <td>)</td>

  235.           <td></td><td></td>

  236.         </tr>

  237.       </table>

  238.   </td>

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

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

  241.   </tr>

  242. </table>

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

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

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

  246.   <table class="params">

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

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

  249.   </table>

  250.   </dd>

  251. </dl>

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

  253. 

  254. </div>

  255. </div>

  256. <a id="aacb112a6813cc814299630b9badcc214"></a>

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

  258. 

  259. <div class="memitem">

  260. <div class="memproto">

  261. <table class="mlabels">

  262.   <tr>

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

  264.       <table class="memname">

  265.         <tr>

  266.           <td class="memname">void SdExternalSpiDriver::send </td>

  267.           <td>(</td>

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

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

  270.         </tr>

  271.         <tr>

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

  273.           <td></td>

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

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

  276.         </tr>

  277.         <tr>

  278.           <td></td>

  279.           <td>)</td>

  280.           <td></td><td></td>

  281.         </tr>

  282.       </table>

  283.   </td>

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

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

  286.   </tr>

  287. </table>

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

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

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

  291.   <table class="params">

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

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

  294.   </table>

  295.   </dd>

  296. </dl>

  297. 

  298. </div>

  299. </div>

  300. <a id="a120314cd14d219c6c0695803c0c20ced"></a>

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

  302. 

  303. <div class="memitem">

  304. <div class="memproto">

  305. <table class="mlabels">

  306.   <tr>

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

  308.       <table class="memname">

  309.         <tr>

  310.           <td class="memname">void SdExternalSpiDriver::send </td>

  311.           <td>(</td>

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

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

  314.           <td></td>

  315.         </tr>

  316.       </table>

  317.   </td>

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

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

  320.   </tr>

  321. </table>

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

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

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

  325.   <table class="params">

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

  327.   </table>

  328.   </dd>

  329. </dl>

  330. 

  331. </div>

  332. </div>

  333. <a id="abd72db6a6af5f7c108cb109b515e847f"></a>

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

  335. 

  336. <div class="memitem">

  337. <div class="memproto">

  338. <table class="mlabels">

  339.   <tr>

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

  341.       <table class="memname">

  342.         <tr>

  343.           <td class="memname">void SdExternalSpiDriver::setSckSpeed </td>

  344.           <td>(</td>

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

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

  347.           <td></td>

  348.         </tr>

  349.       </table>

  350.   </td>

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

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

  353.   </tr>

  354. </table>

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

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

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

  358.   <table class="params">

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

  360.   </table>

  361.   </dd>

  362. </dl>

  363. 

  364. </div>

  365. </div>

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

  367. <li>ArduinoSdFat/libraries/SdFat/src/SpiDriver/<a class="el" href="_sd_spi_external_driver_8h.html">SdSpiExternalDriver.h</a></li>

  368. </ul>

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

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

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

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

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

  374. </a> 1.8.16

  375. </small></address>

  376. </body>

  377. </html>