Ви не можете вибрати більше 25 тем Теми мають розпочинатися з літери або цифри, можуть містити дефіси (-) і не повинні перевищувати 35 символів.

441 lines
26KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.10"/>
  7. <title>SdFat: Arduino/libraries/SdFat/src/SdFatConfig.h File Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">SdFat
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.10 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li><a href="annotated.html"><span>Classes</span></a></li>
  43. <li class="current"><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="files.html"><span>File&#160;List</span></a></li>
  65. <li><a href="globals.html"><span>File&#160;Members</span></a></li>
  66. </ul>
  67. </div>
  68. <!-- window showing the filter options -->
  69. <div id="MSearchSelectWindow"
  70. onmouseover="return searchBox.OnSearchSelectShow()"
  71. onmouseout="return searchBox.OnSearchSelectHide()"
  72. onkeydown="return searchBox.OnSearchSelectKey(event)">
  73. </div>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. <div id="nav-path" class="navpath">
  81. <ul>
  82. <li class="navelem"><a class="el" href="dir_a991eec27578c865874ede3d8ec657c2.html">Arduino</a></li><li class="navelem"><a class="el" href="dir_481cc946b8a81b8d9363a4aad6201160.html">libraries</a></li><li class="navelem"><a class="el" href="dir_1281b15c327061056ab3b326e90c50cf.html">SdFat</a></li><li class="navelem"><a class="el" href="dir_c18d6c86f7b0afecac5c3a8a9885031e.html">src</a></li> </ul>
  83. </div>
  84. </div><!-- top -->
  85. <div class="header">
  86. <div class="summary">
  87. <a href="#define-members">Macros</a> &#124;
  88. <a href="#var-members">Variables</a> </div>
  89. <div class="headertitle">
  90. <div class="title">SdFatConfig.h File Reference</div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <p>configuration definitions
  94. <a href="#details">More...</a></p>
  95. <div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
  96. </div><div class="textblock"><div class="dynheader">
  97. Include dependency graph for SdFatConfig.h:</div>
  98. <div class="dyncontent">
  99. <div class="center"><img src="_sd_fat_config_8h__incl.png" border="0" usemap="#_arduino_2libraries_2_sd_fat_2src_2_sd_fat_config_8h" alt=""/></div>
  100. <map name="_arduino_2libraries_2_sd_fat_2src_2_sd_fat_config_8h" id="_arduino_2libraries_2_sd_fat_2src_2_sd_fat_config_8h">
  101. </map>
  102. </div>
  103. </div><div class="textblock"><div class="dynheader">
  104. This graph shows which files directly or indirectly include this file:</div>
  105. <div class="dyncontent">
  106. <div class="center"><img src="_sd_fat_config_8h__dep__incl.png" border="0" usemap="#_arduino_2libraries_2_sd_fat_2src_2_sd_fat_config_8hdep" alt=""/></div>
  107. <map name="_arduino_2libraries_2_sd_fat_2src_2_sd_fat_config_8hdep" id="_arduino_2libraries_2_sd_fat_2src_2_sd_fat_config_8hdep">
  108. <area shape="rect" id="node2" href="_fat_lib_config_8h.html" title="configuration definitions " alt="" coords="506,95,677,136"/>
  109. <area shape="rect" id="node15" href="_sd_spi_8h.html" title="SdSpi class for V2 SD/SDHC cards. " alt="" coords="712,95,872,136"/>
  110. <area shape="rect" id="node16" href="_sd_spi_card_8h.html" title="SdSpiCard class for V2 SD/SDHC cards. " alt="" coords="816,184,1002,225"/>
  111. <area shape="rect" id="node3" href="_arduino_files_8h.html" title="PrintFile class. " alt="" coords="550,363,721,404"/>
  112. <area shape="rect" id="node5" href="_fat_file_8h.html" title="FatFile class. " alt="" coords="400,273,554,315"/>
  113. <area shape="rect" id="node10" href="_arduino_stream_8h.html" title="ArduinoInStream and ArduinoOutStream classes. " alt="" coords="60,720,246,761"/>
  114. <area shape="rect" id="node14" href="_fat_volume_8h.html" title="FatVolume class. " alt="" coords="629,184,792,225"/>
  115. <area shape="rect" id="node4" href="_fat_file_system_8h.html" title="FatFileSystem class. " alt="" coords="544,452,728,493"/>
  116. <area shape="rect" id="node6" href="ios_8h.html" title="ios_base and ios classes " alt="" coords="321,363,476,404"/>
  117. <area shape="rect" id="node11" href="fstream_8h.html" title="fstream, ifstream, and ofstream classes " alt="" coords="44,631,198,672"/>
  118. <area shape="rect" id="node13" href="_stdio_stream_8h.html" title="StdioStream class. " alt="" coords="126,363,297,404"/>
  119. <area shape="rect" id="node7" href="istream_8h.html" title="istream class " alt="" coords="164,452,318,493"/>
  120. <area shape="rect" id="node12" href="ostream_8h.html" title="ostream class " alt="" coords="342,452,497,493"/>
  121. <area shape="rect" id="node8" href="iostream_8h.html" title="iostream class " alt="" coords="193,541,348,583"/>
  122. <area shape="rect" id="node9" href="bufstream_8h.html" title="ibufstream and obufstream classes " alt="" coords="223,631,379,672"/>
  123. <area shape="rect" id="node17" href="_sd_fat_8h.html" title="SdFat class. " alt="" coords="832,273,986,315"/>
  124. <area shape="rect" id="node18" href="_sd_fat_util_8h.html" title="Useful utility functions. " alt="" coords="832,363,986,404"/>
  125. </map>
  126. </div>
  127. </div><table class="memberdecls">
  128. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  129. Macros</h2></td></tr>
  130. <tr class="memitem:aa918e5b1946ba4be891b081607e8193f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#aa918e5b1946ba4be891b081607e8193f">ARDUINO_FILE_USES_STREAM</a>&#160;&#160;&#160;1</td></tr>
  131. <tr class="separator:aa918e5b1946ba4be891b081607e8193f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <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>
  133. <tr class="separator:a9a2b1ca4d91cff876f48deeaacbc33da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a0c1ace70ac452b3af13a00950551b3df"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a0c1ace70ac452b3af13a00950551b3df">ENABLE_SPI_TRANSACTIONS</a>&#160;&#160;&#160;0</td></tr>
  135. <tr class="separator:a0c1ace70ac452b3af13a00950551b3df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <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>
  137. <tr class="separator:a270eefdaec4778f2a491658f34f61b17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <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>
  139. <tr class="separator:a28998c5daf4bd038f4f93172698320b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a84c504fb619d92d3af2e4445f4c004e1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a84c504fb619d92d3af2e4445f4c004e1">IMPLEMENT_SPI_INTERFACE_SELECTION</a>&#160;&#160;&#160;0</td></tr>
  141. <tr class="separator:a84c504fb619d92d3af2e4445f4c004e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <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>
  143. <tr class="separator:ac2865dac8fdbb4fff47105db32ddf05b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <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;1</td></tr>
  145. <tr class="separator:a838861a01379e94361148d22e62b1977"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a89b43e6b5c76008d9596494cf64e54fb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a89b43e6b5c76008d9596494cf64e54fb">SD_SPI_CONFIGURATION</a>&#160;&#160;&#160;0</td></tr>
  147. <tr class="separator:a89b43e6b5c76008d9596494cf64e54fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:adb1987ec2f011af56fcb7a5eac4242fb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#adb1987ec2f011af56fcb7a5eac4242fb">SPI_INTERFACE_COUNT</a>&#160;&#160;&#160;1</td></tr>
  149. <tr class="separator:adb1987ec2f011af56fcb7a5eac4242fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <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>
  151. <tr class="separator:a2536b194b3b007604a39e8526e108b52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:afc3ef382d3ab8d7e6f8fc134ef21d487"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#afc3ef382d3ab8d7e6f8fc134ef21d487">USE_MULTI_BLOCK_IO</a>&#160;&#160;&#160;1</td></tr>
  153. <tr class="separator:afc3ef382d3ab8d7e6f8fc134ef21d487"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <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>
  155. <tr class="separator:af2e76ffb2fdb830175abf513dd640fdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <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>
  157. <tr class="separator:a23f662882413dcb017ebd8107473b8c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. </table><table class="memberdecls">
  159. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
  160. Variables</h2></td></tr>
  161. <tr class="memitem:af12e3a0d80cb8c7c9e3841887c508f3f"><td class="memItemLeft" align="right" valign="top">uint8_t const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#af12e3a0d80cb8c7c9e3841887c508f3f">SOFT_SPI_MISO_PIN</a> = 12</td></tr>
  162. <tr class="separator:af12e3a0d80cb8c7c9e3841887c508f3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:ac2f492b4970ffbbea92d5d3e3f8aa2f0"><td class="memItemLeft" align="right" valign="top">uint8_t const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#ac2f492b4970ffbbea92d5d3e3f8aa2f0">SOFT_SPI_MOSI_PIN</a> = 11</td></tr>
  164. <tr class="separator:ac2f492b4970ffbbea92d5d3e3f8aa2f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:add7db7df22669e60cddd5698113d6327"><td class="memItemLeft" align="right" valign="top">uint8_t const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#add7db7df22669e60cddd5698113d6327">SOFT_SPI_SCK_PIN</a> = 13</td></tr>
  166. <tr class="separator:add7db7df22669e60cddd5698113d6327"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:af3fc94b8e56959250e83b791cdd678d1"><td class="memItemLeft" align="right" valign="top">const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#af3fc94b8e56959250e83b791cdd678d1">SPI_SCK_INIT_DIVISOR</a> = 128</td></tr>
  168. <tr class="separator:af3fc94b8e56959250e83b791cdd678d1"><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. </div><h2 class="groupheader">Macro Definition Documentation</h2>
  173. <a class="anchor" id="aa918e5b1946ba4be891b081607e8193f"></a>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname">#define ARDUINO_FILE_USES_STREAM&#160;&#160;&#160;1</td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Set ARDUINO_FILE_USES_STREAM nonzero to use Stream as the base class for the Arduino <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> class. If ARDUINO_FILE_USES_STREAM is zero, Print will be used as the base class for the Arduino <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> class.</p>
  183. <p>You can save some flash if you do not use Stream input functions such as find(), findUntil(), readBytesUntil(), readString(), readStringUntil(), parseInt(), and parseFloat(). </p>
  184. </div>
  185. </div>
  186. <a class="anchor" id="a9a2b1ca4d91cff876f48deeaacbc33da"></a>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">#define DESTRUCTOR_CLOSES_FILE&#160;&#160;&#160;0</td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. <p>Set DESTRUCTOR_CLOSES_FILE nonzero to close a file in its destructor.</p>
  196. <p>Causes use of lots of heap in ARM. </p>
  197. </div>
  198. </div>
  199. <a class="anchor" id="a0c1ace70ac452b3af13a00950551b3df"></a>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">#define ENABLE_SPI_TRANSACTIONS&#160;&#160;&#160;0</td>
  205. </tr>
  206. </table>
  207. </div><div class="memdoc">
  208. <p>Set ENABLE_SPI_TRANSACTIONS nonzero to enable the SPI transaction feature of the standard Arduino SPI library. You must include SPI.h in your programs when ENABLE_SPI_TRANSACTIONS is nonzero. </p>
  209. </div>
  210. </div>
  211. <a class="anchor" id="a270eefdaec4778f2a491658f34f61b17"></a>
  212. <div class="memitem">
  213. <div class="memproto">
  214. <table class="memname">
  215. <tr>
  216. <td class="memname">#define ENDL_CALLS_FLUSH&#160;&#160;&#160;0</td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. <p>Call flush for endl if ENDL_CALLS_FLUSH is nonzero</p>
  221. <p>The standard for iostreams is to call flush. This is very costly for <a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a>. Each call to flush causes 2048 bytes of I/O to the SD.</p>
  222. <p><a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a> has a single 512 byte buffer for SD I/O so it must write the current data block to the SD, read the directory block from the SD, update the directory entry, write the directory block to the SD and read the data block back into the buffer.</p>
  223. <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>
  224. <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>
  225. </div>
  226. </div>
  227. <a class="anchor" id="a28998c5daf4bd038f4f93172698320b1"></a>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">#define FAT12_SUPPORT&#160;&#160;&#160;0</td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <p>Set FAT12_SUPPORT nonzero to enable use if FAT12 volumes. FAT12 has not been well tested and requires additional flash. </p>
  237. </div>
  238. </div>
  239. <a class="anchor" id="a84c504fb619d92d3af2e4445f4c004e1"></a>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">#define IMPLEMENT_SPI_INTERFACE_SELECTION&#160;&#160;&#160;0</td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. <p>Check if API to select HW SPI interface is needed. </p>
  249. </div>
  250. </div>
  251. <a class="anchor" id="ac2865dac8fdbb4fff47105db32ddf05b"></a>
  252. <div class="memitem">
  253. <div class="memproto">
  254. <table class="memname">
  255. <tr>
  256. <td class="memname">#define MAINTAIN_FREE_CLUSTER_COUNT&#160;&#160;&#160;0</td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. <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>
  261. </div>
  262. </div>
  263. <a class="anchor" id="a838861a01379e94361148d22e62b1977"></a>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="memname">
  267. <tr>
  268. <td class="memname">#define SD_HAS_CUSTOM_SPI&#160;&#160;&#160;1</td>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. <p>Determine the default SPI configuration. </p>
  273. </div>
  274. </div>
  275. <a class="anchor" id="a89b43e6b5c76008d9596494cf64e54fb"></a>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">#define SD_SPI_CONFIGURATION&#160;&#160;&#160;0</td>
  281. </tr>
  282. </table>
  283. </div><div class="memdoc">
  284. <p>The symbol SD_SPI_CONFIGURATION defines SPI access to the SD card.</p>
  285. <p>IF SD_SPI_CONFIGUTATION is define to be zero, only the <a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a> class is define and <a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a> uses a fast custom SPI implementation if avaiable. If SD_HAS_CUSTOM_SPI is zero, the standard SPI library is used.</p>
  286. <p>If SD_SPI_CONFIGURATION is define to be one, only the <a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a> class is define and <a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a> uses the standard Arduino SPI.h library.</p>
  287. <p>If SD_SPI_CONFIGURATION is define to be two, only the <a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a> class is define and <a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a> uses software SPI on the pins defined below.</p>
  288. <p>If SD_SPI_CONFIGURATION is define to be three, the three classes, <a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a>, <a class="el" href="class_sd_fat_lib_spi.html" title="SdFat class using the standard Arduino SPI library. ">SdFatLibSpi</a>, and <a class="el" href="class_sd_fat_soft_spi.html" title="SdFat class using software SPI. ">SdFatSoftSpi</a> are defined. <a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a> uses the fast custom SPI implementation. <a class="el" href="class_sd_fat_lib_spi.html" title="SdFat class using the standard Arduino SPI library. ">SdFatLibSpi</a> uses the standard Arduino SPI library. <a class="el" href="class_sd_fat_soft_spi.html" title="SdFat class using software SPI. ">SdFatSoftSpi</a> is a template class that uses Software SPI. The template parameters define the software SPI pins. See the ThreeCard example for simultaneous use of all three classes. </p>
  289. </div>
  290. </div>
  291. <a class="anchor" id="adb1987ec2f011af56fcb7a5eac4242fb"></a>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <table class="memname">
  295. <tr>
  296. <td class="memname">#define SPI_INTERFACE_COUNT&#160;&#160;&#160;1</td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <p>Number of hardware interfaces. </p>
  301. </div>
  302. </div>
  303. <a class="anchor" id="a2536b194b3b007604a39e8526e108b52"></a>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname">#define USE_LONG_FILE_NAMES&#160;&#160;&#160;1</td>
  309. </tr>
  310. </table>
  311. </div><div class="memdoc">
  312. <p>Set USE_LONG_FILE_NAMES nonzero to use long file names (LFN). Long <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name are limited to a maximum length of 255 characters.</p>
  313. <p>This implementation allows 7-bit characters in the range 0X20 to 0X7E except the following characters are not allowed:</p>
  314. <p>&lt; (less than) </p><blockquote class="doxtable">
  315. <p>(greater than) </p>
  316. </blockquote>
  317. <p>: (colon) " (double quote) / (forward slash) \ (backslash) | (vertical bar or pipe) ? (question mark)</p><ul>
  318. <li>(asterisk) </li>
  319. </ul>
  320. </div>
  321. </div>
  322. <a class="anchor" id="afc3ef382d3ab8d7e6f8fc134ef21d487"></a>
  323. <div class="memitem">
  324. <div class="memproto">
  325. <table class="memname">
  326. <tr>
  327. <td class="memname">#define USE_MULTI_BLOCK_IO&#160;&#160;&#160;1</td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <p>Set USE_MULTI_BLOCK_IO nonzero to use multi-block SD read/write.</p>
  332. <p>Don't use mult-block read/write on small AVR boards. </p>
  333. </div>
  334. </div>
  335. <a class="anchor" id="af2e76ffb2fdb830175abf513dd640fdd"></a>
  336. <div class="memitem">
  337. <div class="memproto">
  338. <table class="memname">
  339. <tr>
  340. <td class="memname">#define USE_SD_CRC&#160;&#160;&#160;0</td>
  341. </tr>
  342. </table>
  343. </div><div class="memdoc">
  344. <p>To enable SD card CRC checking set USE_SD_CRC nonzero.</p>
  345. <p>Set USE_SD_CRC to 1 to use a smaller slower CRC-CCITT function.</p>
  346. <p>Set USE_SD_CRC to 2 to used a larger faster table driven CRC-CCITT function. </p>
  347. </div>
  348. </div>
  349. <a class="anchor" id="a23f662882413dcb017ebd8107473b8c3"></a>
  350. <div class="memitem">
  351. <div class="memproto">
  352. <table class="memname">
  353. <tr>
  354. <td class="memname">#define USE_SEPARATE_FAT_CACHE&#160;&#160;&#160;0</td>
  355. </tr>
  356. </table>
  357. </div><div class="memdoc">
  358. <p>Set USE_SEPARATE_FAT_CACHE nonzero to use a second 512 byte cache for FAT table entries. This improves performance for large writes that are not a multiple of 512 bytes. </p>
  359. </div>
  360. </div>
  361. <h2 class="groupheader">Variable Documentation</h2>
  362. <a class="anchor" id="af12e3a0d80cb8c7c9e3841887c508f3f"></a>
  363. <div class="memitem">
  364. <div class="memproto">
  365. <table class="memname">
  366. <tr>
  367. <td class="memname">uint8_t const SOFT_SPI_MISO_PIN = 12</td>
  368. </tr>
  369. </table>
  370. </div><div class="memdoc">
  371. <p>Software SPI Master In Slave Out pin </p>
  372. </div>
  373. </div>
  374. <a class="anchor" id="ac2f492b4970ffbbea92d5d3e3f8aa2f0"></a>
  375. <div class="memitem">
  376. <div class="memproto">
  377. <table class="memname">
  378. <tr>
  379. <td class="memname">uint8_t const SOFT_SPI_MOSI_PIN = 11</td>
  380. </tr>
  381. </table>
  382. </div><div class="memdoc">
  383. <p>If SD_SPI_CONFIGURATION is defined to be two, these definitions will define the pins used for software SPI.</p>
  384. <p>The default definition allows Uno shields to be used on other boards.Software SPI Master Out Slave In pin </p>
  385. </div>
  386. </div>
  387. <a class="anchor" id="add7db7df22669e60cddd5698113d6327"></a>
  388. <div class="memitem">
  389. <div class="memproto">
  390. <table class="memname">
  391. <tr>
  392. <td class="memname">uint8_t const SOFT_SPI_SCK_PIN = 13</td>
  393. </tr>
  394. </table>
  395. </div><div class="memdoc">
  396. <p>Software SPI Clock pin </p>
  397. </div>
  398. </div>
  399. <a class="anchor" id="af3fc94b8e56959250e83b791cdd678d1"></a>
  400. <div class="memitem">
  401. <div class="memproto">
  402. <table class="memname">
  403. <tr>
  404. <td class="memname">const uint8_t SPI_SCK_INIT_DIVISOR = 128</td>
  405. </tr>
  406. </table>
  407. </div><div class="memdoc">
  408. <p>SPI SCK divisor for SD initialization commands. or greater </p>
  409. </div>
  410. </div>
  411. </div><!-- contents -->
  412. <!-- start footer part -->
  413. <hr class="footer"/><address class="footer"><small>
  414. Generated on Fri Feb 12 2016 13:43:49 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  415. <img class="footer" src="doxygen.png" alt="doxygen"/>
  416. </a> 1.8.10
  417. </small></address>
  418. </body>
  419. </html>