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

362 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: SdSpiConfig 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="#pub-attribs">Public Attributes</a> &#124;

  67. <a href="class_sd_spi_config-members.html">List of all members</a>  </div>

  68.   <div class="headertitle">

  69. <div class="title">SdSpiConfig Class Reference</div>  </div>

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

  71. <div class="contents">

  72. 

  73. <p>SPI card configuration.  

  74.  <a href="class_sd_spi_config.html#details">More...</a></p>

  75. 

  76. <p><code>#include &lt;SdSpiDriver.h&gt;</code></p>

  77. <table class="memberdecls">

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

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

  80. <tr class="memitem:a038e3578396f4682f1b8cd0b934f42f1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_config.html#a038e3578396f4682f1b8cd0b934f42f1">SdSpiConfig</a> (<a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a> cs)</td></tr>

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

  82. <tr class="memitem:a30087e90e8c4043aed90693c3be5855b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_config.html#a30087e90e8c4043aed90693c3be5855b">SdSpiConfig</a> (<a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a> cs, uint8_t opt)</td></tr>

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

  84. <tr class="memitem:adb0a2a3d7dc801305fef5167d538abe1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_config.html#adb0a2a3d7dc801305fef5167d538abe1">SdSpiConfig</a> (<a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a> cs, uint8_t opt, uint32_t maxSpeed)</td></tr>

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

  86. <tr class="memitem:a3c68a4b6ddc549abfb62fa662b59ef10"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_config.html#a3c68a4b6ddc549abfb62fa662b59ef10">SdSpiConfig</a> (<a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a> cs, uint8_t opt, uint32_t maxSpeed, <a class="el" href="_sd_spi_driver_8h.html#a472d56ea7cb52ec5d68b3067baa000c3">SpiPort_t</a> *port)</td></tr>

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

  88. </table><table class="memberdecls">

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

  90. Public Attributes</h2></td></tr>

  91. <tr class="memitem:a0c1797197fbd4e4c4499daf4b51628e6"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_config.html#a0c1797197fbd4e4c4499daf4b51628e6">csPin</a></td></tr>

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

  93. <tr class="memitem:ac1afd080e2baa2b6eb81331ed5180f37"><td class="memItemLeft" align="right" valign="top">const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_config.html#ac1afd080e2baa2b6eb81331ed5180f37">maxSck</a></td></tr>

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

  95. <tr class="memitem:a6292855eeea89636ad2b4da9675dbc96"><td class="memItemLeft" align="right" valign="top">const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_config.html#a6292855eeea89636ad2b4da9675dbc96">options</a></td></tr>

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

  97. <tr class="memitem:aedaada290c35b55d36671ca377620480"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_sd_spi_driver_8h.html#a472d56ea7cb52ec5d68b3067baa000c3">SpiPort_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_config.html#aedaada290c35b55d36671ca377620480">spiPort</a></td></tr>

  98. <tr class="separator:aedaada290c35b55d36671ca377620480"><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>SPI card configuration. </p>

  102. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

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

  104. <h2 class="memtitle"><span class="permalink"><a href="#a3c68a4b6ddc549abfb62fa662b59ef10">&#9670;&nbsp;</a></span>SdSpiConfig() <span class="overload">[1/4]</span></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">SdSpiConfig::SdSpiConfig </td>

  114.           <td>(</td>

  115.           <td class="paramtype"><a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a>&#160;</td>

  116.           <td class="paramname"><em>cs</em>, </td>

  117.         </tr>

  118.         <tr>

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

  120.           <td></td>

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

  122.           <td class="paramname"><em>opt</em>, </td>

  123.         </tr>

  124.         <tr>

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

  126.           <td></td>

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

  128.           <td class="paramname"><em>maxSpeed</em>, </td>

  129.         </tr>

  130.         <tr>

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

  132.           <td></td>

  133.           <td class="paramtype"><a class="el" href="_sd_spi_driver_8h.html#a472d56ea7cb52ec5d68b3067baa000c3">SpiPort_t</a> *&#160;</td>

  134.           <td class="paramname"><em>port</em>&#160;</td>

  135.         </tr>

  136.         <tr>

  137.           <td></td>

  138.           <td>)</td>

  139.           <td></td><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><a class="el" href="class_sd_spi_config.html" title="SPI card configuration.">SdSpiConfig</a> constructor.</p>

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

  150.   <table class="params">

  151.     <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>Chip select pin. </td></tr>

  152.     <tr><td class="paramdir">[in]</td><td class="paramname">opt</td><td>Options. </td></tr>

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

  154.     <tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>The SPI port to use. </td></tr>

  155.   </table>

  156.   </dd>

  157. </dl>

  158. 

  159. </div>

  160. </div>

  161. <a id="adb0a2a3d7dc801305fef5167d538abe1"></a>

  162. <h2 class="memtitle"><span class="permalink"><a href="#adb0a2a3d7dc801305fef5167d538abe1">&#9670;&nbsp;</a></span>SdSpiConfig() <span class="overload">[2/4]</span></h2>

  163. 

  164. <div class="memitem">

  165. <div class="memproto">

  166. <table class="mlabels">

  167.   <tr>

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

  169.       <table class="memname">

  170.         <tr>

  171.           <td class="memname">SdSpiConfig::SdSpiConfig </td>

  172.           <td>(</td>

  173.           <td class="paramtype"><a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a>&#160;</td>

  174.           <td class="paramname"><em>cs</em>, </td>

  175.         </tr>

  176.         <tr>

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

  178.           <td></td>

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

  180.           <td class="paramname"><em>opt</em>, </td>

  181.         </tr>

  182.         <tr>

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

  184.           <td></td>

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

  186.           <td class="paramname"><em>maxSpeed</em>&#160;</td>

  187.         </tr>

  188.         <tr>

  189.           <td></td>

  190.           <td>)</td>

  191.           <td></td><td></td>

  192.         </tr>

  193.       </table>

  194.   </td>

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

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

  197.   </tr>

  198. </table>

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

  200. <p><a class="el" href="class_sd_spi_config.html" title="SPI card configuration.">SdSpiConfig</a> constructor.</p>

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

  202.   <table class="params">

  203.     <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>Chip select pin. </td></tr>

  204.     <tr><td class="paramdir">[in]</td><td class="paramname">opt</td><td>Options. </td></tr>

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

  206.   </table>

  207.   </dd>

  208. </dl>

  209. 

  210. </div>

  211. </div>

  212. <a id="a30087e90e8c4043aed90693c3be5855b"></a>

  213. <h2 class="memtitle"><span class="permalink"><a href="#a30087e90e8c4043aed90693c3be5855b">&#9670;&nbsp;</a></span>SdSpiConfig() <span class="overload">[3/4]</span></h2>

  214. 

  215. <div class="memitem">

  216. <div class="memproto">

  217. <table class="mlabels">

  218.   <tr>

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

  220.       <table class="memname">

  221.         <tr>

  222.           <td class="memname">SdSpiConfig::SdSpiConfig </td>

  223.           <td>(</td>

  224.           <td class="paramtype"><a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a>&#160;</td>

  225.           <td class="paramname"><em>cs</em>, </td>

  226.         </tr>

  227.         <tr>

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

  229.           <td></td>

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

  231.           <td class="paramname"><em>opt</em>&#160;</td>

  232.         </tr>

  233.         <tr>

  234.           <td></td>

  235.           <td>)</td>

  236.           <td></td><td></td>

  237.         </tr>

  238.       </table>

  239.   </td>

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

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

  242.   </tr>

  243. </table>

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

  245. <p><a class="el" href="class_sd_spi_config.html" title="SPI card configuration.">SdSpiConfig</a> constructor.</p>

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

  247.   <table class="params">

  248.     <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>Chip select pin. </td></tr>

  249.     <tr><td class="paramdir">[in]</td><td class="paramname">opt</td><td>Options. </td></tr>

  250.   </table>

  251.   </dd>

  252. </dl>

  253. 

  254. </div>

  255. </div>

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

  257. <h2 class="memtitle"><span class="permalink"><a href="#a038e3578396f4682f1b8cd0b934f42f1">&#9670;&nbsp;</a></span>SdSpiConfig() <span class="overload">[4/4]</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">SdSpiConfig::SdSpiConfig </td>

  267.           <td>(</td>

  268.           <td class="paramtype"><a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a>&#160;</td>

  269.           <td class="paramname"><em>cs</em></td><td>)</td>

  270.           <td></td>

  271.         </tr>

  272.       </table>

  273.   </td>

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

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

  276.   </tr>

  277. </table>

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

  279. <p><a class="el" href="class_sd_spi_config.html" title="SPI card configuration.">SdSpiConfig</a> constructor.</p>

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

  281.   <table class="params">

  282.     <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>Chip select pin. </td></tr>

  283.   </table>

  284.   </dd>

  285. </dl>

  286. 

  287. </div>

  288. </div>

  289. <h2 class="groupheader">Member Data Documentation</h2>

  290. <a id="a0c1797197fbd4e4c4499daf4b51628e6"></a>

  291. <h2 class="memtitle"><span class="permalink"><a href="#a0c1797197fbd4e4c4499daf4b51628e6">&#9670;&nbsp;</a></span>csPin</h2>

  292. 

  293. <div class="memitem">

  294. <div class="memproto">

  295.       <table class="memname">

  296.         <tr>

  297.           <td class="memname">const <a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a> SdSpiConfig::csPin</td>

  298.         </tr>

  299.       </table>

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

  301. <p>Chip select pin. </p>

  302. 

  303. </div>

  304. </div>

  305. <a id="ac1afd080e2baa2b6eb81331ed5180f37"></a>

  306. <h2 class="memtitle"><span class="permalink"><a href="#ac1afd080e2baa2b6eb81331ed5180f37">&#9670;&nbsp;</a></span>maxSck</h2>

  307. 

  308. <div class="memitem">

  309. <div class="memproto">

  310.       <table class="memname">

  311.         <tr>

  312.           <td class="memname">const uint32_t SdSpiConfig::maxSck</td>

  313.         </tr>

  314.       </table>

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

  316. <p>Max SCK frequency </p>

  317. 

  318. </div>

  319. </div>

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

  321. <h2 class="memtitle"><span class="permalink"><a href="#a6292855eeea89636ad2b4da9675dbc96">&#9670;&nbsp;</a></span>options</h2>

  322. 

  323. <div class="memitem">

  324. <div class="memproto">

  325.       <table class="memname">

  326.         <tr>

  327.           <td class="memname">const uint8_t SdSpiConfig::options</td>

  328.         </tr>

  329.       </table>

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

  331. <p>Options </p>

  332. 

  333. </div>

  334. </div>

  335. <a id="aedaada290c35b55d36671ca377620480"></a>

  336. <h2 class="memtitle"><span class="permalink"><a href="#aedaada290c35b55d36671ca377620480">&#9670;&nbsp;</a></span>spiPort</h2>

  337. 

  338. <div class="memitem">

  339. <div class="memproto">

  340.       <table class="memname">

  341.         <tr>

  342.           <td class="memname"><a class="el" href="_sd_spi_driver_8h.html#a472d56ea7cb52ec5d68b3067baa000c3">SpiPort_t</a>* SdSpiConfig::spiPort</td>

  343.         </tr>

  344.       </table>

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

  346. <p>SPI port </p>

  347. 

  348. </div>

  349. </div>

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

  351. <li>ArduinoSdFat/libraries/SdFat/src/SpiDriver/<a class="el" href="_sd_spi_driver_8h.html">SdSpiDriver.h</a></li>

  352. </ul>

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

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

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

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

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

  358. </a> 1.8.16

  359. </small></address>

  360. </body>

  361. </html>