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.

624 lines
36KB

  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: ArduinoSdFat/libraries/SdFat/src/SdFatConfig.h File 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 id="nav-path" class="navpath">
  61. <ul>
  62. <li class="navelem"><a class="el" href="dir_bd3b508a448b79faa7486a2af0c5c4a2.html">ArduinoSdFat</a></li><li class="navelem"><a class="el" href="dir_d7cdc5eb6907b67ec8d6facf0ac28083.html">libraries</a></li><li class="navelem"><a class="el" href="dir_30f4e013e11264f0426cd7e4f10b230b.html">SdFat</a></li><li class="navelem"><a class="el" href="dir_ffa9b8a1695a52c2b9469cb7873a40f4.html">src</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="summary">
  67. <a href="#define-members">Macros</a> &#124;
  68. <a href="#typedef-members">Typedefs</a> </div>
  69. <div class="headertitle">
  70. <div class="title">SdFatConfig.h File Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>configuration definitions
  74. <a href="#details">More...</a></p>
  75. <div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
  76. <code>#include &quot;Arduino.h&quot;</code><br />
  77. </div><div class="textblock"><div class="dynheader">
  78. Include dependency graph for SdFatConfig.h:</div>
  79. <div class="dyncontent">
  80. <div class="center"><img src="_sd_fat_config_8h__incl.png" border="0" usemap="#_arduino_sd_fat_2libraries_2_sd_fat_2src_2_sd_fat_config_8h" alt=""/></div>
  81. <map name="_arduino_sd_fat_2libraries_2_sd_fat_2src_2_sd_fat_config_8h" id="_arduino_sd_fat_2libraries_2_sd_fat_2src_2_sd_fat_config_8h">
  82. <area shape="rect" title="configuration definitions" alt="" coords="5,5,175,47"/>
  83. <area shape="rect" title=" " alt="" coords="9,95,75,121"/>
  84. <area shape="rect" title=" " alt="" coords="99,95,177,121"/>
  85. </map>
  86. </div>
  87. </div><div class="textblock"><div class="dynheader">
  88. This graph shows which files directly or indirectly include this file:</div>
  89. <div class="dyncontent">
  90. <div class="center"><img src="_sd_fat_config_8h__dep__incl.png" border="0" usemap="#_arduino_sd_fat_2libraries_2_sd_fat_2src_2_sd_fat_config_8hdep" alt=""/></div>
  91. <map name="_arduino_sd_fat_2libraries_2_sd_fat_2src_2_sd_fat_config_8hdep" id="_arduino_sd_fat_2libraries_2_sd_fat_2src_2_sd_fat_config_8hdep">
  92. <area shape="rect" title="configuration definitions" alt="" coords="847,5,1017,47"/>
  93. <area shape="rect" href="_sys_call_8h.html" title="SysCall class." alt="" coords="452,102,649,143"/>
  94. <area shape="rect" href="_block_device_interface_8h.html" title="BlockDeviceInterface include file." alt="" coords="709,95,921,151"/>
  95. <area shape="rect" href="_fat_lib_config_8h.html" title="configuration definitions" alt="" coords="945,102,1156,143"/>
  96. <area shape="rect" href="_arduino_stream_8h.html" title="ArduinoInStream and ArduinoOutStream classes." alt="" coords="1182,102,1421,143"/>
  97. <area shape="rect" href="_minimum_serial_8h.html" title="Minimal AVR Serial driver." alt="" coords="5,199,189,240"/>
  98. <area shape="rect" href="_sd_fat_8h.html" title="main SdFs include file." alt="" coords="214,199,365,240"/>
  99. <area shape="rect" href="_sd_spi_card_8h.html" title="SdSpiCard class for V2 SD/SDHC cards." alt="" coords="374,288,581,329"/>
  100. <area shape="rect" href="_sd_spi_driver_8h.html" title="SpiDriver classes." alt="" coords="441,199,661,240"/>
  101. <area shape="rect" href="_ex_fat_partition_8h.html" title="ExFatPartition include file." alt="" coords="685,199,923,240"/>
  102. <area shape="rect" href="_fat_partition_8h.html" title="FatPartition class." alt="" coords="947,199,1152,240"/>
  103. <area shape="rect" href="_ex_fat_file_8h.html" title="ExFatFile class." alt="" coords="699,288,909,329"/>
  104. <area shape="rect" href="_fat_volume_8h.html" title="FatVolume class." alt="" coords="1011,377,1213,419"/>
  105. <area shape="rect" href="_fat_file_8h.html" title="FatFile class." alt="" coords="1087,288,1265,329"/>
  106. <area shape="rect" href="sdios_8h.html" title="C++ IO Streams features." alt="" coords="1227,199,1378,240"/>
  107. </map>
  108. </div>
  109. </div><table class="memberdecls">
  110. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  111. Macros</h2></td></tr>
  112. <tr class="memitem:a63747c9ac4e3d78579690cf9eb38c4df"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a63747c9ac4e3d78579690cf9eb38c4df">CHECK_FLASH_PROGRAMMING</a>&#160;&#160;&#160;1</td></tr>
  113. <tr class="separator:a63747c9ac4e3d78579690cf9eb38c4df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a9a2b1ca4d91cff876f48deeaacbc33da"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a9a2b1ca4d91cff876f48deeaacbc33da">DESTRUCTOR_CLOSES_FILE</a>&#160;&#160;&#160;0</td></tr>
  115. <tr class="separator:a9a2b1ca4d91cff876f48deeaacbc33da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a9a8c1ea8596f35f7f33a24b642567206"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a9a8c1ea8596f35f7f33a24b642567206">ENABLE_ARDUINO_FEATURES</a>&#160;&#160;&#160;1</td></tr>
  117. <tr class="separator:a9a8c1ea8596f35f7f33a24b642567206"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:aa0a95c918e41f5cb3850231fc41fdcd0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#aa0a95c918e41f5cb3850231fc41fdcd0">ENABLE_ARDUINO_SERIAL</a>&#160;&#160;&#160;1</td></tr>
  119. <tr class="separator:aa0a95c918e41f5cb3850231fc41fdcd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:aae353ccb45df7772d8022763a57410d9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#aae353ccb45df7772d8022763a57410d9">ENABLE_ARDUINO_STRING</a>&#160;&#160;&#160;1</td></tr>
  121. <tr class="separator:aae353ccb45df7772d8022763a57410d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a3ceb23f14263a17c56eac40e484cbbbb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a3ceb23f14263a17c56eac40e484cbbbb">ENABLE_DEDICATED_SPI</a>&#160;&#160;&#160;1</td></tr>
  123. <tr class="separator:a3ceb23f14263a17c56eac40e484cbbbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a270eefdaec4778f2a491658f34f61b17"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a270eefdaec4778f2a491658f34f61b17">ENDL_CALLS_FLUSH</a>&#160;&#160;&#160;0</td></tr>
  125. <tr class="separator:a270eefdaec4778f2a491658f34f61b17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a28998c5daf4bd038f4f93172698320b1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a28998c5daf4bd038f4f93172698320b1">FAT12_SUPPORT</a>&#160;&#160;&#160;0</td></tr>
  127. <tr class="separator:a28998c5daf4bd038f4f93172698320b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a356309f8e0bad852d7a07ad0b9326a27"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a356309f8e0bad852d7a07ad0b9326a27">HAS_SDIO_CLASS</a>&#160;&#160;&#160;0</td></tr>
  129. <tr class="separator:a356309f8e0bad852d7a07ad0b9326a27"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a7cc6c9647297d65f8e823de70740630b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a7cc6c9647297d65f8e823de70740630b">INCLUDE_SDIOS</a>&#160;&#160;&#160;0</td></tr>
  131. <tr class="separator:a7cc6c9647297d65f8e823de70740630b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ac2865dac8fdbb4fff47105db32ddf05b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#ac2865dac8fdbb4fff47105db32ddf05b">MAINTAIN_FREE_CLUSTER_COUNT</a>&#160;&#160;&#160;0</td></tr>
  133. <tr class="separator:ac2865dac8fdbb4fff47105db32ddf05b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:ab81c0135853c34b24c8314849950f6ab"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#ab81c0135853c34b24c8314849950f6ab">SD_CHIP_SELECT_MODE</a>&#160;&#160;&#160;0</td></tr>
  135. <tr class="separator:ab81c0135853c34b24c8314849950f6ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a838861a01379e94361148d22e62b1977"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a838861a01379e94361148d22e62b1977">SD_HAS_CUSTOM_SPI</a>&#160;&#160;&#160;0</td></tr>
  137. <tr class="separator:a838861a01379e94361148d22e62b1977"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:adb969469c422c2da5438963623bdfbd3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#adb969469c422c2da5438963623bdfbd3">SD_MAX_INIT_RATE_KHZ</a>&#160;&#160;&#160;400</td></tr>
  139. <tr class="separator:adb969469c422c2da5438963623bdfbd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:acdbec9ae1f12e4154878ac10672103fb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#acdbec9ae1f12e4154878ac10672103fb">SDFAT_FILE_TYPE</a>&#160;&#160;&#160;1</td></tr>
  141. <tr class="separator:acdbec9ae1f12e4154878ac10672103fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a6761799c8dffafbf5b7dd914772be28c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a6761799c8dffafbf5b7dd914772be28c">SPI_DRIVER_SELECT</a>&#160;&#160;&#160;0</td></tr>
  143. <tr class="separator:a6761799c8dffafbf5b7dd914772be28c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:ae92cc0fb2a31925cfc5694feb048dca2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#ae92cc0fb2a31925cfc5694feb048dca2">USE_BLOCK_DEVICE_INTERFACE</a>&#160;&#160;&#160;0</td></tr>
  145. <tr class="separator:ae92cc0fb2a31925cfc5694feb048dca2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a8d3fca2607182c1ba389dd61c283a3e2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a8d3fca2607182c1ba389dd61c283a3e2">USE_EXFAT_BITMAP_CACHE</a>&#160;&#160;&#160;0</td></tr>
  147. <tr class="separator:a8d3fca2607182c1ba389dd61c283a3e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:ad42a354208ecb245adfc238266a612e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#ad42a354208ecb245adfc238266a612e5">USE_FAT_FILE_FLAG_CONTIGUOUS</a>&#160;&#160;&#160;1</td></tr>
  149. <tr class="separator:ad42a354208ecb245adfc238266a612e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:ab4b7255422e65730612f1f6af1a26752"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#ab4b7255422e65730612f1f6af1a26752">USE_FCNTL_H</a>&#160;&#160;&#160;0</td></tr>
  151. <tr class="separator:ab4b7255422e65730612f1f6af1a26752"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a2536b194b3b007604a39e8526e108b52"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a2536b194b3b007604a39e8526e108b52">USE_LONG_FILE_NAMES</a>&#160;&#160;&#160;1</td></tr>
  153. <tr class="separator:a2536b194b3b007604a39e8526e108b52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:ae477a983188d4370faff32b07a5cfacb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#ae477a983188d4370faff32b07a5cfacb">USE_MULTI_SECTOR_IO</a>&#160;&#160;&#160;1</td></tr>
  155. <tr class="separator:ae477a983188d4370faff32b07a5cfacb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:af2e76ffb2fdb830175abf513dd640fdd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#af2e76ffb2fdb830175abf513dd640fdd">USE_SD_CRC</a>&#160;&#160;&#160;0</td></tr>
  157. <tr class="separator:af2e76ffb2fdb830175abf513dd640fdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a23f662882413dcb017ebd8107473b8c3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a23f662882413dcb017ebd8107473b8c3">USE_SEPARATE_FAT_CACHE</a>&#160;&#160;&#160;0</td></tr>
  159. <tr class="separator:a23f662882413dcb017ebd8107473b8c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a9d4fac424e31b4383a10211f0489d93b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a9d4fac424e31b4383a10211f0489d93b">USE_SIMPLE_LITTLE_ENDIAN</a>&#160;&#160;&#160;1</td></tr>
  161. <tr class="separator:a9d4fac424e31b4383a10211f0489d93b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a03b3cad4ee9ca6915330f41b2924bca1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a03b3cad4ee9ca6915330f41b2924bca1">WDT_YIELD_TIME_MILLIS</a>&#160;&#160;&#160;0</td></tr>
  163. <tr class="separator:a03b3cad4ee9ca6915330f41b2924bca1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. </table><table class="memberdecls">
  165. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  166. Typedefs</h2></td></tr>
  167. <tr class="memitem:a7a489fb14a59adf251794342604fc5ea"><td class="memItemLeft" align="right" valign="top">typedef uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a></td></tr>
  168. <tr class="separator:a7a489fb14a59adf251794342604fc5ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. </table>
  170. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  171. <div class="textblock"><p>configuration definitions </p>
  172. <p>Copyright (c) 2011-2019 Bill Greiman This file is part of the SdFat library for SD memory cards.</p>
  173. <p>MIT License</p>
  174. <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
  175. <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
  176. <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </p>
  177. </div><h2 class="groupheader">Macro Definition Documentation</h2>
  178. <a id="a63747c9ac4e3d78579690cf9eb38c4df"></a>
  179. <h2 class="memtitle"><span class="permalink"><a href="#a63747c9ac4e3d78579690cf9eb38c4df">&#9670;&nbsp;</a></span>CHECK_FLASH_PROGRAMMING</h2>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">#define CHECK_FLASH_PROGRAMMING&#160;&#160;&#160;1</td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. <p>If CHECK_FLASH_PROGRAMMING is zero, overlap of single sector flash programming and other operations will be allowed for faster write performance.</p>
  189. <p>Some cards will not sleep in low power mode unless CHECK_FLASH_PROGRAMMING is non-zero. </p>
  190. </div>
  191. </div>
  192. <a id="a9a2b1ca4d91cff876f48deeaacbc33da"></a>
  193. <h2 class="memtitle"><span class="permalink"><a href="#a9a2b1ca4d91cff876f48deeaacbc33da">&#9670;&nbsp;</a></span>DESTRUCTOR_CLOSES_FILE</h2>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname">#define DESTRUCTOR_CLOSES_FILE&#160;&#160;&#160;0</td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>Set DESTRUCTOR_CLOSES_FILE nonzero to close a file in its destructor.</p>
  203. <p>Causes use of lots of heap in ARM. </p>
  204. </div>
  205. </div>
  206. <a id="a9a8c1ea8596f35f7f33a24b642567206"></a>
  207. <h2 class="memtitle"><span class="permalink"><a href="#a9a8c1ea8596f35f7f33a24b642567206">&#9670;&nbsp;</a></span>ENABLE_ARDUINO_FEATURES</h2>
  208. <div class="memitem">
  209. <div class="memproto">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">#define ENABLE_ARDUINO_FEATURES&#160;&#160;&#160;1</td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>For Debug - must be one </p>
  217. </div>
  218. </div>
  219. <a id="aa0a95c918e41f5cb3850231fc41fdcd0"></a>
  220. <h2 class="memtitle"><span class="permalink"><a href="#aa0a95c918e41f5cb3850231fc41fdcd0">&#9670;&nbsp;</a></span>ENABLE_ARDUINO_SERIAL</h2>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">#define ENABLE_ARDUINO_SERIAL&#160;&#160;&#160;1</td>
  226. </tr>
  227. </table>
  228. </div><div class="memdoc">
  229. <p>For Debug - must be one </p>
  230. </div>
  231. </div>
  232. <a id="aae353ccb45df7772d8022763a57410d9"></a>
  233. <h2 class="memtitle"><span class="permalink"><a href="#aae353ccb45df7772d8022763a57410d9">&#9670;&nbsp;</a></span>ENABLE_ARDUINO_STRING</h2>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">#define ENABLE_ARDUINO_STRING&#160;&#160;&#160;1</td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>For Debug - must be one </p>
  243. </div>
  244. </div>
  245. <a id="a3ceb23f14263a17c56eac40e484cbbbb"></a>
  246. <h2 class="memtitle"><span class="permalink"><a href="#a3ceb23f14263a17c56eac40e484cbbbb">&#9670;&nbsp;</a></span>ENABLE_DEDICATED_SPI</h2>
  247. <div class="memitem">
  248. <div class="memproto">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname">#define ENABLE_DEDICATED_SPI&#160;&#160;&#160;1</td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Set ENABLE_DEDICATED_SPI to enable dedicated use of the SPI bus. Selecting dedicated SPI in <a class="el" href="class_sd_spi_config.html" title="SPI card configuration.">SdSpiConfig()</a> will produce better performance by using very large multi-block transfers to and from the SD card.</p>
  256. <p>Enabling dedicated SPI will cost some extra flash and RAM. </p>
  257. </div>
  258. </div>
  259. <a id="a270eefdaec4778f2a491658f34f61b17"></a>
  260. <h2 class="memtitle"><span class="permalink"><a href="#a270eefdaec4778f2a491658f34f61b17">&#9670;&nbsp;</a></span>ENDL_CALLS_FLUSH</h2>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <table class="memname">
  264. <tr>
  265. <td class="memname">#define ENDL_CALLS_FLUSH&#160;&#160;&#160;0</td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. <p>Call flush for endl if ENDL_CALLS_FLUSH is nonzero</p>
  270. <p>The standard for iostreams is to call flush. This is very costly for SdFat. Each call to flush causes 2048 bytes of I/O to the SD.</p>
  271. <p>SdFat has a single 512 byte buffer for SD I/O so it must write the current data sector to the SD, read the directory sector from the SD, update the directory entry, write the directory sector to the SD and read the data sector back into the buffer.</p>
  272. <p>The SD flash memory controller is not designed for this many rewrites so performance may be reduced by more than a factor of 100.</p>
  273. <p>If ENDL_CALLS_FLUSH is zero, you must call flush and/or close to force all data to be written to the SD. </p>
  274. </div>
  275. </div>
  276. <a id="a28998c5daf4bd038f4f93172698320b1"></a>
  277. <h2 class="memtitle"><span class="permalink"><a href="#a28998c5daf4bd038f4f93172698320b1">&#9670;&nbsp;</a></span>FAT12_SUPPORT</h2>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">#define FAT12_SUPPORT&#160;&#160;&#160;0</td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <p>Set FAT12_SUPPORT nonzero to enable use if FAT12 volumes. FAT12 has not been well tested and requires additional flash. </p>
  287. </div>
  288. </div>
  289. <a id="a356309f8e0bad852d7a07ad0b9326a27"></a>
  290. <h2 class="memtitle"><span class="permalink"><a href="#a356309f8e0bad852d7a07ad0b9326a27">&#9670;&nbsp;</a></span>HAS_SDIO_CLASS</h2>
  291. <div class="memitem">
  292. <div class="memproto">
  293. <table class="memname">
  294. <tr>
  295. <td class="memname">#define HAS_SDIO_CLASS&#160;&#160;&#160;0</td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. <p>Default is no SDIO. </p>
  300. </div>
  301. </div>
  302. <a id="a7cc6c9647297d65f8e823de70740630b"></a>
  303. <h2 class="memtitle"><span class="permalink"><a href="#a7cc6c9647297d65f8e823de70740630b">&#9670;&nbsp;</a></span>INCLUDE_SDIOS</h2>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname">#define INCLUDE_SDIOS&#160;&#160;&#160;0</td>
  309. </tr>
  310. </table>
  311. </div><div class="memdoc">
  312. <p>Set INCLUDE_SDIOS nonzero to include <a class="el" href="sdios_8h.html" title="C++ IO Streams features.">sdios.h</a> in <a class="el" href="_sd_fat_8h.html" title="main SdFs include file.">SdFat.h</a>. <a class="el" href="sdios_8h.html" title="C++ IO Streams features.">sdios.h</a> provides C++ style IO Streams. </p>
  313. </div>
  314. </div>
  315. <a id="ac2865dac8fdbb4fff47105db32ddf05b"></a>
  316. <h2 class="memtitle"><span class="permalink"><a href="#ac2865dac8fdbb4fff47105db32ddf05b">&#9670;&nbsp;</a></span>MAINTAIN_FREE_CLUSTER_COUNT</h2>
  317. <div class="memitem">
  318. <div class="memproto">
  319. <table class="memname">
  320. <tr>
  321. <td class="memname">#define MAINTAIN_FREE_CLUSTER_COUNT&#160;&#160;&#160;0</td>
  322. </tr>
  323. </table>
  324. </div><div class="memdoc">
  325. <p>Set MAINTAIN_FREE_CLUSTER_COUNT nonzero to keep the count of free clusters updated. This will increase the speed of the freeClusterCount() call after the first call. Extra flash will be required. </p>
  326. </div>
  327. </div>
  328. <a id="ab81c0135853c34b24c8314849950f6ab"></a>
  329. <h2 class="memtitle"><span class="permalink"><a href="#ab81c0135853c34b24c8314849950f6ab">&#9670;&nbsp;</a></span>SD_CHIP_SELECT_MODE</h2>
  330. <div class="memitem">
  331. <div class="memproto">
  332. <table class="memname">
  333. <tr>
  334. <td class="memname">#define SD_CHIP_SELECT_MODE&#160;&#160;&#160;0</td>
  335. </tr>
  336. </table>
  337. </div><div class="memdoc">
  338. <p>SD_CHIP_SELECT_MODE defines how the functions void <a class="el" href="_sd_spi_driver_8h.html#ad4854101780daaa378827ecb62ef86d9">sdCsInit(SdCsPin_t pin)</a> {pinMode(pin, OUTPUT);} and void <a class="el" href="_sd_spi_driver_8h.html#ac469bbe2d31ffde9b00ffc68258d7428">sdCsWrite(SdCsPin_t pin, bool level)</a> {digitalWrite(pin, level);} are defined.</p>
  339. <p>0 - Internal definition is a strong symbol and can't be replaced.</p>
  340. <p>1 - Internal definition is a weak symbol and can be replaced.</p>
  341. <p>2 - No internal definition and must be defined in the application. </p>
  342. </div>
  343. </div>
  344. <a id="a838861a01379e94361148d22e62b1977"></a>
  345. <h2 class="memtitle"><span class="permalink"><a href="#a838861a01379e94361148d22e62b1977">&#9670;&nbsp;</a></span>SD_HAS_CUSTOM_SPI</h2>
  346. <div class="memitem">
  347. <div class="memproto">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname">#define SD_HAS_CUSTOM_SPI&#160;&#160;&#160;0</td>
  351. </tr>
  352. </table>
  353. </div><div class="memdoc">
  354. <p>Enable SDIO driver if available. Determine the default SPI configuration. </p>
  355. </div>
  356. </div>
  357. <a id="adb969469c422c2da5438963623bdfbd3"></a>
  358. <h2 class="memtitle"><span class="permalink"><a href="#adb969469c422c2da5438963623bdfbd3">&#9670;&nbsp;</a></span>SD_MAX_INIT_RATE_KHZ</h2>
  359. <div class="memitem">
  360. <div class="memproto">
  361. <table class="memname">
  362. <tr>
  363. <td class="memname">#define SD_MAX_INIT_RATE_KHZ&#160;&#160;&#160;400</td>
  364. </tr>
  365. </table>
  366. </div><div class="memdoc">
  367. <p>SD maximum initialization clock rate. </p>
  368. </div>
  369. </div>
  370. <a id="acdbec9ae1f12e4154878ac10672103fb"></a>
  371. <h2 class="memtitle"><span class="permalink"><a href="#acdbec9ae1f12e4154878ac10672103fb">&#9670;&nbsp;</a></span>SDFAT_FILE_TYPE</h2>
  372. <div class="memitem">
  373. <div class="memproto">
  374. <table class="memname">
  375. <tr>
  376. <td class="memname">#define SDFAT_FILE_TYPE&#160;&#160;&#160;1</td>
  377. </tr>
  378. </table>
  379. </div><div class="memdoc">
  380. <p>File types for SdFat, File, <a class="el" href="class_sd_file.html" title="FAT16/FAT32 file with Print.">SdFile</a>, SdBaseFile, fstream, ifstream, and ofstream.</p>
  381. <p>Set SDFAT_FILE_TYPE to:</p>
  382. <p>1 for FAT16/FAT32, 2 for exFAT, 3 for FAT16/FAT32 and exFAT. </p>
  383. </div>
  384. </div>
  385. <a id="a6761799c8dffafbf5b7dd914772be28c"></a>
  386. <h2 class="memtitle"><span class="permalink"><a href="#a6761799c8dffafbf5b7dd914772be28c">&#9670;&nbsp;</a></span>SPI_DRIVER_SELECT</h2>
  387. <div class="memitem">
  388. <div class="memproto">
  389. <table class="memname">
  390. <tr>
  391. <td class="memname">#define SPI_DRIVER_SELECT&#160;&#160;&#160;0</td>
  392. </tr>
  393. </table>
  394. </div><div class="memdoc">
  395. <p>If the symbol SPI_DRIVER_SELECT is:</p>
  396. <p>0 - An optimized custom SPI driver is used if it exists else the standard library driver is used.</p>
  397. <p>1 - The standard library driver is always used.</p>
  398. <p>2 - The software SPI driver is always used.</p>
  399. <p>3 - Experimental external SPI driver hook. </p>
  400. </div>
  401. </div>
  402. <a id="ae92cc0fb2a31925cfc5694feb048dca2"></a>
  403. <h2 class="memtitle"><span class="permalink"><a href="#ae92cc0fb2a31925cfc5694feb048dca2">&#9670;&nbsp;</a></span>USE_BLOCK_DEVICE_INTERFACE</h2>
  404. <div class="memitem">
  405. <div class="memproto">
  406. <table class="memname">
  407. <tr>
  408. <td class="memname">#define USE_BLOCK_DEVICE_INTERFACE&#160;&#160;&#160;0</td>
  409. </tr>
  410. </table>
  411. </div><div class="memdoc">
  412. <p>Set USE_BLOCK_DEVICE_INTERFACE nonzero to use generic of block device </p>
  413. </div>
  414. </div>
  415. <a id="a8d3fca2607182c1ba389dd61c283a3e2"></a>
  416. <h2 class="memtitle"><span class="permalink"><a href="#a8d3fca2607182c1ba389dd61c283a3e2">&#9670;&nbsp;</a></span>USE_EXFAT_BITMAP_CACHE</h2>
  417. <div class="memitem">
  418. <div class="memproto">
  419. <table class="memname">
  420. <tr>
  421. <td class="memname">#define USE_EXFAT_BITMAP_CACHE&#160;&#160;&#160;0</td>
  422. </tr>
  423. </table>
  424. </div><div class="memdoc">
  425. <p>Set USE_EXFAT_BITMAP_CACHE nonzero to use a second 512 byte cache for exFAT bitmap entries. This improves performance for large writes that are not a multiple of 512 bytes. </p>
  426. </div>
  427. </div>
  428. <a id="ad42a354208ecb245adfc238266a612e5"></a>
  429. <h2 class="memtitle"><span class="permalink"><a href="#ad42a354208ecb245adfc238266a612e5">&#9670;&nbsp;</a></span>USE_FAT_FILE_FLAG_CONTIGUOUS</h2>
  430. <div class="memitem">
  431. <div class="memproto">
  432. <table class="memname">
  433. <tr>
  434. <td class="memname">#define USE_FAT_FILE_FLAG_CONTIGUOUS&#160;&#160;&#160;1</td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>Optimize access to contiguous files. Experimental - set nonzero to enable. </p>
  439. </div>
  440. </div>
  441. <a id="ab4b7255422e65730612f1f6af1a26752"></a>
  442. <h2 class="memtitle"><span class="permalink"><a href="#ab4b7255422e65730612f1f6af1a26752">&#9670;&nbsp;</a></span>USE_FCNTL_H</h2>
  443. <div class="memitem">
  444. <div class="memproto">
  445. <table class="memname">
  446. <tr>
  447. <td class="memname">#define USE_FCNTL_H&#160;&#160;&#160;0</td>
  448. </tr>
  449. </table>
  450. </div><div class="memdoc">
  451. <p>If the symbol USE_FCNTL_H is nonzero, open flags for access modes O_RDONLY, O_WRONLY, O_RDWR and the open modifiers O_APPEND, O_CREAT, O_EXCL, O_SYNC will be defined by including the system file fcntl.h. </p>
  452. </div>
  453. </div>
  454. <a id="a2536b194b3b007604a39e8526e108b52"></a>
  455. <h2 class="memtitle"><span class="permalink"><a href="#a2536b194b3b007604a39e8526e108b52">&#9670;&nbsp;</a></span>USE_LONG_FILE_NAMES</h2>
  456. <div class="memitem">
  457. <div class="memproto">
  458. <table class="memname">
  459. <tr>
  460. <td class="memname">#define USE_LONG_FILE_NAMES&#160;&#160;&#160;1</td>
  461. </tr>
  462. </table>
  463. </div><div class="memdoc">
  464. <p>Set USE_LONG_FILE_NAMES nonzero to use long file names (LFN) in FAT16/FAT32. exFAT always uses long file names.</p>
  465. <p>Long File Name are limited to a maximum length of 255 characters.</p>
  466. <p>This implementation allows 7-bit characters in the range 0X20 to 0X7E except the following characters are not allowed:</p>
  467. <p>&lt; (less than) </p><blockquote class="doxtable">
  468. <p>(greater than) </p>
  469. </blockquote>
  470. <p>: (colon) " (double quote) / (forward slash) \ (backslash) | (vertical bar or pipe) ? (question mark)</p><ul>
  471. <li>(asterisk) </li>
  472. </ul>
  473. </div>
  474. </div>
  475. <a id="ae477a983188d4370faff32b07a5cfacb"></a>
  476. <h2 class="memtitle"><span class="permalink"><a href="#ae477a983188d4370faff32b07a5cfacb">&#9670;&nbsp;</a></span>USE_MULTI_SECTOR_IO</h2>
  477. <div class="memitem">
  478. <div class="memproto">
  479. <table class="memname">
  480. <tr>
  481. <td class="memname">#define USE_MULTI_SECTOR_IO&#160;&#160;&#160;1</td>
  482. </tr>
  483. </table>
  484. </div><div class="memdoc">
  485. <p>Set USE_MULTI_SECTOR_IO nonzero to use multi-sector SD read/write.</p>
  486. <p>Don't use mult-sector read/write on small AVR boards. </p>
  487. </div>
  488. </div>
  489. <a id="af2e76ffb2fdb830175abf513dd640fdd"></a>
  490. <h2 class="memtitle"><span class="permalink"><a href="#af2e76ffb2fdb830175abf513dd640fdd">&#9670;&nbsp;</a></span>USE_SD_CRC</h2>
  491. <div class="memitem">
  492. <div class="memproto">
  493. <table class="memname">
  494. <tr>
  495. <td class="memname">#define USE_SD_CRC&#160;&#160;&#160;0</td>
  496. </tr>
  497. </table>
  498. </div><div class="memdoc">
  499. <p>To enable SD card CRC checking for SPI, set USE_SD_CRC nonzero.</p>
  500. <p>Set USE_SD_CRC to 1 to use a smaller CRC-CCITT function. This function is slower for AVR but may be fast for ARM and other processors.</p>
  501. <p>Set USE_SD_CRC to 2 to used a larger table driven CRC-CCITT function. This function is faster for AVR but may be slower for ARM and other processors. </p>
  502. </div>
  503. </div>
  504. <a id="a23f662882413dcb017ebd8107473b8c3"></a>
  505. <h2 class="memtitle"><span class="permalink"><a href="#a23f662882413dcb017ebd8107473b8c3">&#9670;&nbsp;</a></span>USE_SEPARATE_FAT_CACHE</h2>
  506. <div class="memitem">
  507. <div class="memproto">
  508. <table class="memname">
  509. <tr>
  510. <td class="memname">#define USE_SEPARATE_FAT_CACHE&#160;&#160;&#160;0</td>
  511. </tr>
  512. </table>
  513. </div><div class="memdoc">
  514. <p>Set USE_SEPARATE_FAT_CACHE nonzero to use a second 512 byte cache for FAT16/FAT32 table entries. This improves performance for large writes that are not a multiple of 512 bytes. </p>
  515. </div>
  516. </div>
  517. <a id="a9d4fac424e31b4383a10211f0489d93b"></a>
  518. <h2 class="memtitle"><span class="permalink"><a href="#a9d4fac424e31b4383a10211f0489d93b">&#9670;&nbsp;</a></span>USE_SIMPLE_LITTLE_ENDIAN</h2>
  519. <div class="memitem">
  520. <div class="memproto">
  521. <table class="memname">
  522. <tr>
  523. <td class="memname">#define USE_SIMPLE_LITTLE_ENDIAN&#160;&#160;&#160;1</td>
  524. </tr>
  525. </table>
  526. </div><div class="memdoc">
  527. <p>Set USE_SIMPLE_LITTLE_ENDIAN nonzero for little endian processors with no memory alignment restrictions. </p>
  528. </div>
  529. </div>
  530. <a id="a03b3cad4ee9ca6915330f41b2924bca1"></a>
  531. <h2 class="memtitle"><span class="permalink"><a href="#a03b3cad4ee9ca6915330f41b2924bca1">&#9670;&nbsp;</a></span>WDT_YIELD_TIME_MILLIS</h2>
  532. <div class="memitem">
  533. <div class="memproto">
  534. <table class="memname">
  535. <tr>
  536. <td class="memname">#define WDT_YIELD_TIME_MILLIS&#160;&#160;&#160;0</td>
  537. </tr>
  538. </table>
  539. </div><div class="memdoc">
  540. <p>Handle Watchdog Timer for WiFi modules.</p>
  541. <p>Yield will be called before accessing the SPI bus if it has been more than WDT_YIELD_TIME_MILLIS milliseconds since the last yield call by SdFat. </p>
  542. </div>
  543. </div>
  544. <h2 class="groupheader">Typedef Documentation</h2>
  545. <a id="a7a489fb14a59adf251794342604fc5ea"></a>
  546. <h2 class="memtitle"><span class="permalink"><a href="#a7a489fb14a59adf251794342604fc5ea">&#9670;&nbsp;</a></span>SdCsPin_t</h2>
  547. <div class="memitem">
  548. <div class="memproto">
  549. <table class="memname">
  550. <tr>
  551. <td class="memname">typedef uint8_t <a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a></td>
  552. </tr>
  553. </table>
  554. </div><div class="memdoc">
  555. <p>Type for card chip select pin. </p>
  556. </div>
  557. </div>
  558. </div><!-- contents -->
  559. <!-- start footer part -->
  560. <hr class="footer"/><address class="footer"><small>
  561. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  562. <img class="footer" src="doxygen.png" alt="doxygen"/>
  563. </a> 1.8.16
  564. </small></address>
  565. </body>
  566. </html>