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.

class_sd_spi_config.html 16KB

5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361
  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. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="#pub-attribs">Public Attributes</a> &#124;
  65. <a href="class_sd_spi_config-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">SdSpiConfig Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>SPI card configuration.
  71. <a href="class_sd_spi_config.html#details">More...</a></p>
  72. <p><code>#include &lt;SdSpiDriver.h&gt;</code></p>
  73. <table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  75. Public Member Functions</h2></td></tr>
  76. <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>
  77. <tr class="separator:a038e3578396f4682f1b8cd0b934f42f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <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>
  79. <tr class="separator:a30087e90e8c4043aed90693c3be5855b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <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>
  81. <tr class="separator:adb0a2a3d7dc801305fef5167d538abe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <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>
  83. <tr class="separator:a3c68a4b6ddc549abfb62fa662b59ef10"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table><table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  86. Public Attributes</h2></td></tr>
  87. <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>
  88. <tr class="separator:a0c1797197fbd4e4c4499daf4b51628e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <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>
  90. <tr class="separator:ac1afd080e2baa2b6eb81331ed5180f37"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <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>
  92. <tr class="separator:a6292855eeea89636ad2b4da9675dbc96"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <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>
  94. <tr class="separator:aedaada290c35b55d36671ca377620480"><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>SPI card configuration. </p>
  98. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  99. <a id="a3c68a4b6ddc549abfb62fa662b59ef10"></a>
  100. <h2 class="memtitle"><span class="permalink"><a href="#a3c68a4b6ddc549abfb62fa662b59ef10">&#9670;&nbsp;</a></span>SdSpiConfig() <span class="overload">[1/4]</span></h2>
  101. <div class="memitem">
  102. <div class="memproto">
  103. <table class="mlabels">
  104. <tr>
  105. <td class="mlabels-left">
  106. <table class="memname">
  107. <tr>
  108. <td class="memname">SdSpiConfig::SdSpiConfig </td>
  109. <td>(</td>
  110. <td class="paramtype"><a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a>&#160;</td>
  111. <td class="paramname"><em>cs</em>, </td>
  112. </tr>
  113. <tr>
  114. <td class="paramkey"></td>
  115. <td></td>
  116. <td class="paramtype">uint8_t&#160;</td>
  117. <td class="paramname"><em>opt</em>, </td>
  118. </tr>
  119. <tr>
  120. <td class="paramkey"></td>
  121. <td></td>
  122. <td class="paramtype">uint32_t&#160;</td>
  123. <td class="paramname"><em>maxSpeed</em>, </td>
  124. </tr>
  125. <tr>
  126. <td class="paramkey"></td>
  127. <td></td>
  128. <td class="paramtype"><a class="el" href="_sd_spi_driver_8h.html#a472d56ea7cb52ec5d68b3067baa000c3">SpiPort_t</a> *&#160;</td>
  129. <td class="paramname"><em>port</em>&#160;</td>
  130. </tr>
  131. <tr>
  132. <td></td>
  133. <td>)</td>
  134. <td></td><td></td>
  135. </tr>
  136. </table>
  137. </td>
  138. <td class="mlabels-right">
  139. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. <p><a class="el" href="class_sd_spi_config.html" title="SPI card configuration.">SdSpiConfig</a> constructor.</p>
  144. <dl class="params"><dt>Parameters</dt><dd>
  145. <table class="params">
  146. <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>Chip select pin. </td></tr>
  147. <tr><td class="paramdir">[in]</td><td class="paramname">opt</td><td>Options. </td></tr>
  148. <tr><td class="paramdir">[in]</td><td class="paramname">maxSpeed</td><td>Maximum SCK frequency. </td></tr>
  149. <tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>The SPI port to use. </td></tr>
  150. </table>
  151. </dd>
  152. </dl>
  153. </div>
  154. </div>
  155. <a id="adb0a2a3d7dc801305fef5167d538abe1"></a>
  156. <h2 class="memtitle"><span class="permalink"><a href="#adb0a2a3d7dc801305fef5167d538abe1">&#9670;&nbsp;</a></span>SdSpiConfig() <span class="overload">[2/4]</span></h2>
  157. <div class="memitem">
  158. <div class="memproto">
  159. <table class="mlabels">
  160. <tr>
  161. <td class="mlabels-left">
  162. <table class="memname">
  163. <tr>
  164. <td class="memname">SdSpiConfig::SdSpiConfig </td>
  165. <td>(</td>
  166. <td class="paramtype"><a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a>&#160;</td>
  167. <td class="paramname"><em>cs</em>, </td>
  168. </tr>
  169. <tr>
  170. <td class="paramkey"></td>
  171. <td></td>
  172. <td class="paramtype">uint8_t&#160;</td>
  173. <td class="paramname"><em>opt</em>, </td>
  174. </tr>
  175. <tr>
  176. <td class="paramkey"></td>
  177. <td></td>
  178. <td class="paramtype">uint32_t&#160;</td>
  179. <td class="paramname"><em>maxSpeed</em>&#160;</td>
  180. </tr>
  181. <tr>
  182. <td></td>
  183. <td>)</td>
  184. <td></td><td></td>
  185. </tr>
  186. </table>
  187. </td>
  188. <td class="mlabels-right">
  189. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p><a class="el" href="class_sd_spi_config.html" title="SPI card configuration.">SdSpiConfig</a> constructor.</p>
  194. <dl class="params"><dt>Parameters</dt><dd>
  195. <table class="params">
  196. <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>Chip select pin. </td></tr>
  197. <tr><td class="paramdir">[in]</td><td class="paramname">opt</td><td>Options. </td></tr>
  198. <tr><td class="paramdir">[in]</td><td class="paramname">maxSpeed</td><td>Maximum SCK frequency. </td></tr>
  199. </table>
  200. </dd>
  201. </dl>
  202. </div>
  203. </div>
  204. <a id="a30087e90e8c4043aed90693c3be5855b"></a>
  205. <h2 class="memtitle"><span class="permalink"><a href="#a30087e90e8c4043aed90693c3be5855b">&#9670;&nbsp;</a></span>SdSpiConfig() <span class="overload">[3/4]</span></h2>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="mlabels">
  209. <tr>
  210. <td class="mlabels-left">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname">SdSpiConfig::SdSpiConfig </td>
  214. <td>(</td>
  215. <td class="paramtype"><a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a>&#160;</td>
  216. <td class="paramname"><em>cs</em>, </td>
  217. </tr>
  218. <tr>
  219. <td class="paramkey"></td>
  220. <td></td>
  221. <td class="paramtype">uint8_t&#160;</td>
  222. <td class="paramname"><em>opt</em>&#160;</td>
  223. </tr>
  224. <tr>
  225. <td></td>
  226. <td>)</td>
  227. <td></td><td></td>
  228. </tr>
  229. </table>
  230. </td>
  231. <td class="mlabels-right">
  232. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <p><a class="el" href="class_sd_spi_config.html" title="SPI card configuration.">SdSpiConfig</a> constructor.</p>
  237. <dl class="params"><dt>Parameters</dt><dd>
  238. <table class="params">
  239. <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>Chip select pin. </td></tr>
  240. <tr><td class="paramdir">[in]</td><td class="paramname">opt</td><td>Options. </td></tr>
  241. </table>
  242. </dd>
  243. </dl>
  244. </div>
  245. </div>
  246. <a id="a038e3578396f4682f1b8cd0b934f42f1"></a>
  247. <h2 class="memtitle"><span class="permalink"><a href="#a038e3578396f4682f1b8cd0b934f42f1">&#9670;&nbsp;</a></span>SdSpiConfig() <span class="overload">[4/4]</span></h2>
  248. <div class="memitem">
  249. <div class="memproto">
  250. <table class="mlabels">
  251. <tr>
  252. <td class="mlabels-left">
  253. <table class="memname">
  254. <tr>
  255. <td class="memname">SdSpiConfig::SdSpiConfig </td>
  256. <td>(</td>
  257. <td class="paramtype"><a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a>&#160;</td>
  258. <td class="paramname"><em>cs</em></td><td>)</td>
  259. <td></td>
  260. </tr>
  261. </table>
  262. </td>
  263. <td class="mlabels-right">
  264. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  265. </tr>
  266. </table>
  267. </div><div class="memdoc">
  268. <p><a class="el" href="class_sd_spi_config.html" title="SPI card configuration.">SdSpiConfig</a> constructor.</p>
  269. <dl class="params"><dt>Parameters</dt><dd>
  270. <table class="params">
  271. <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>Chip select pin. </td></tr>
  272. </table>
  273. </dd>
  274. </dl>
  275. </div>
  276. </div>
  277. <h2 class="groupheader">Member Data Documentation</h2>
  278. <a id="a0c1797197fbd4e4c4499daf4b51628e6"></a>
  279. <h2 class="memtitle"><span class="permalink"><a href="#a0c1797197fbd4e4c4499daf4b51628e6">&#9670;&nbsp;</a></span>csPin</h2>
  280. <div class="memitem">
  281. <div class="memproto">
  282. <table class="memname">
  283. <tr>
  284. <td class="memname">const <a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a> SdSpiConfig::csPin</td>
  285. </tr>
  286. </table>
  287. </div><div class="memdoc">
  288. <p>Chip select pin. </p>
  289. </div>
  290. </div>
  291. <a id="ac1afd080e2baa2b6eb81331ed5180f37"></a>
  292. <h2 class="memtitle"><span class="permalink"><a href="#ac1afd080e2baa2b6eb81331ed5180f37">&#9670;&nbsp;</a></span>maxSck</h2>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">const uint32_t SdSpiConfig::maxSck</td>
  298. </tr>
  299. </table>
  300. </div><div class="memdoc">
  301. <p>Max SCK frequency </p>
  302. </div>
  303. </div>
  304. <a id="a6292855eeea89636ad2b4da9675dbc96"></a>
  305. <h2 class="memtitle"><span class="permalink"><a href="#a6292855eeea89636ad2b4da9675dbc96">&#9670;&nbsp;</a></span>options</h2>
  306. <div class="memitem">
  307. <div class="memproto">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">const uint8_t SdSpiConfig::options</td>
  311. </tr>
  312. </table>
  313. </div><div class="memdoc">
  314. <p>Options </p>
  315. </div>
  316. </div>
  317. <a id="aedaada290c35b55d36671ca377620480"></a>
  318. <h2 class="memtitle"><span class="permalink"><a href="#aedaada290c35b55d36671ca377620480">&#9670;&nbsp;</a></span>spiPort</h2>
  319. <div class="memitem">
  320. <div class="memproto">
  321. <table class="memname">
  322. <tr>
  323. <td class="memname"><a class="el" href="_sd_spi_driver_8h.html#a472d56ea7cb52ec5d68b3067baa000c3">SpiPort_t</a>* SdSpiConfig::spiPort</td>
  324. </tr>
  325. </table>
  326. </div><div class="memdoc">
  327. <p>SPI port </p>
  328. </div>
  329. </div>
  330. <hr/>The documentation for this class was generated from the following file:<ul>
  331. <li>ArduinoSdFat/libraries/SdFat/src/SpiDriver/<a class="el" href="_sd_spi_driver_8h.html">SdSpiDriver.h</a></li>
  332. </ul>
  333. </div><!-- contents -->
  334. <!-- start footer part -->
  335. <hr class="footer"/><address class="footer"><small>
  336. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  337. <img class="footer" src="doxygen.png" alt="doxygen"/>
  338. </a> 1.8.16
  339. </small></address>
  340. </body>
  341. </html>