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.

424 lines
27KB

  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.6"/>
  7. <title>SdFat: Arduino/libraries/SdFat/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="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">SdFat
  21. </div>
  22. </td>
  23. </tr>
  24. </tbody>
  25. </table>
  26. </div>
  27. <!-- end header part -->
  28. <!-- Generated by Doxygen 1.8.6 -->
  29. <div id="navrow1" class="tabs">
  30. <ul class="tablist">
  31. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  33. <li><a href="annotated.html"><span>Classes</span></a></li>
  34. <li class="current"><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. <div id="navrow2" class="tabs2">
  38. <ul class="tablist">
  39. <li><a href="files.html"><span>File&#160;List</span></a></li>
  40. <li><a href="globals.html"><span>File&#160;Members</span></a></li>
  41. </ul>
  42. </div>
  43. <div id="nav-path" class="navpath">
  44. <ul>
  45. <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> </ul>
  46. </div>
  47. </div><!-- top -->
  48. <div class="header">
  49. <div class="summary">
  50. <a href="#define-members">Macros</a> &#124;
  51. <a href="#var-members">Variables</a> </div>
  52. <div class="headertitle">
  53. <div class="title">SdFatConfig.h File Reference</div> </div>
  54. </div><!--header-->
  55. <div class="contents">
  56. <p>configuration definitions
  57. <a href="#details">More...</a></p>
  58. <div class="textblock"><code>#include &lt;stdint.h&gt;</code><br/>
  59. </div><div class="textblock"><div class="dynheader">
  60. Include dependency graph for SdFatConfig.h:</div>
  61. <div class="dyncontent">
  62. <div class="center"><img src="_sd_fat_config_8h__incl.png" border="0" usemap="#_arduino_2libraries_2_sd_fat_2_sd_fat_config_8h" alt=""/></div>
  63. <map name="_arduino_2libraries_2_sd_fat_2_sd_fat_config_8h" id="_arduino_2libraries_2_sd_fat_2_sd_fat_config_8h">
  64. </map>
  65. </div>
  66. </div><div class="textblock"><div class="dynheader">
  67. This graph shows which files directly or indirectly include this file:</div>
  68. <div class="dyncontent">
  69. <div class="center"><img src="_sd_fat_config_8h__dep__incl.png" border="0" usemap="#_arduino_2libraries_2_sd_fat_2_sd_fat_config_8hdep" alt=""/></div>
  70. <map name="_arduino_2libraries_2_sd_fat_2_sd_fat_config_8hdep" id="_arduino_2libraries_2_sd_fat_2_sd_fat_config_8hdep">
  71. <area shape="rect" id="node3" href="_sd2_card_8h.html" title="Sd2Card class for V2 SD/SDHC cards. " alt="" coords="1056,187,1211,229"/> <area shape="rect" id="node7" href="_sd_volume_8h.html" title="SdVolume class. " alt="" coords="1005,278,1160,319"/> <area shape="rect" id="node9" href="_sd_base_file_8h.html" title="SdBaseFile class. " alt="" coords="948,369,1103,410"/> <area shape="rect" id="node62" href="_sd_spi_8h.html" title="SdSpi class for V2 SD/SDHC cards. " alt="" coords="1503,97,1657,138"/> <area shape="rect" id="node5" href="_sd2_card_8cpp.html" title="Arduino/libraries/SdFat\l/Sd2Card.cpp" alt="" coords="1445,278,1600,319"/> <area shape="rect" id="node11" href="ios_8h.html" title="ios_base and ios classes " alt="" coords="859,459,1013,501"/> <area shape="rect" id="node40" href="_stdio_stream_8h.html" title="Arduino/libraries/SdFat\l/StdioStream.h" alt="" coords="1307,1003,1461,1045"/> <area shape="rect" id="node44" href="_sd_stream_8h.html" title="fstream, ifstream, and ofstream classes " alt="" coords="533,731,688,773"/> <area shape="rect" id="node54" href="_sd_file_8h.html" title="SdFile class. " alt="" coords="1037,459,1192,501"/> <area shape="rect" id="node13" href="istream_8h.html" title="istream class " alt="" coords="696,550,851,591"/> <area shape="rect" id="node49" href="ostream_8h.html" title="ostream class " alt="" coords="875,550,1029,591"/> <area shape="rect" id="node15" href="iostream_8h.html" title="iostream class " alt="" coords="712,641,867,682"/> <area shape="rect" id="node47" href="istream_8cpp.html" title="Arduino/libraries/SdFat\l/istream.cpp" alt="" coords="533,641,688,682"/> <area shape="rect" id="node17" href="bufstream_8h.html" title="ibufstream and obufstream classes " alt="" coords="712,731,867,773"/> <area shape="rect" id="node19" href="_arduino_stream_8h.html" title="ArduinoInStream and ArduinoOutStream classes. " alt="" coords="680,822,835,863"/> <area shape="rect" id="node21" href="_sd_fat_8h.html" title="SdFat class. " alt="" coords="664,913,819,954"/> <area shape="rect" id="node23" href="_sd_base_file_8cpp.html" title="Arduino/libraries/SdFat\l/SdBaseFile.cpp" alt="" coords="1128,1003,1283,1045"/> <area shape="rect" id="node25" href="_sd_base_file_print_8cpp.html" title="Arduino/libraries/SdFat\l/SdBaseFilePrint.cpp" alt="" coords="5,1003,160,1045"/> <area shape="rect" id="node27" href="_sd_fat_8cpp.html" title="Arduino/libraries/SdFat\l/SdFat.cpp" alt="" coords="184,1003,339,1045"/> <area shape="rect" id="node29" href="_sd_fat_error_print_8cpp.html" title="Arduino/libraries/SdFat\l/SdFatErrorPrint.cpp" alt="" coords="363,1003,517,1045"/> <area shape="rect" id="node31" href="_sd_fat_util_8cpp.html" title="Arduino/libraries/SdFat\l/SdFatUtil.cpp" alt="" coords="599,1094,753,1135"/> <area shape="rect" id="node33" href="_sd_fat_util_8h.html" title="Useful utility functions. " alt="" coords="541,1003,696,1045"/> <area shape="rect" id="node36" href="_sd_stream_8cpp.html" title="Arduino/libraries/SdFat\l/SdStream.cpp" alt="" coords="771,1003,925,1045"/> <area shape="rect" id="node38" href="_sd_volume_8cpp.html" title="Arduino/libraries/SdFat\l/SdVolume.cpp" alt="" coords="949,1003,1104,1045"/> <area shape="rect" id="node42" href="_stdio_stream_8cpp.html" title="Arduino/libraries/SdFat\l/StdioStream.cpp" alt="" coords="1307,1094,1461,1135"/> <area shape="rect" id="node52" href="ostream_8cpp.html" title="Arduino/libraries/SdFat\l/ostream.cpp" alt="" coords="891,641,1045,682"/> <area shape="rect" id="node57" href="_sd_file_8cpp.html" title="Arduino/libraries/SdFat\l/SdFile.cpp" alt="" coords="1120,550,1275,591"/> <area shape="rect" id="node66" href="_sd_spi_arduino_8cpp.html" title="Arduino/libraries/SdFat\l/SdSpiArduino.cpp" alt="" coords="1821,187,1976,229"/> <area shape="rect" id="node68" href="_sd_spi_a_v_r_8cpp.html" title="Arduino/libraries/SdFat\l/SdSpiAVR.cpp" alt="" coords="2000,187,2155,229"/> <area shape="rect" id="node70" href="_sd_spi_s_a_m3_x_8cpp.html" title="Arduino/libraries/SdFat\l/SdSpiSAM3X.cpp" alt="" coords="1235,187,1389,229"/> <area shape="rect" id="node72" href="_sd_spi_soft_8cpp.html" title="Arduino/libraries/SdFat\l/SdSpiSoft.cpp" alt="" coords="1413,187,1568,229"/> <area shape="rect" id="node74" href="_sd_spi_teensy3_8cpp.html" title="Arduino/libraries/SdFat\l/SdSpiTeensy3.cpp" alt="" coords="1592,187,1747,229"/> </map>
  72. </div>
  73. </div><table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  75. Macros</h2></td></tr>
  76. <tr class="memitem:a9b2b6f07bfc371ed5b9c1e305cd8ac07"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a9b2b6f07bfc371ed5b9c1e305cd8ac07">AVR_SOFT_SPI</a>&#160;&#160;&#160;0</td></tr>
  77. <tr class="separator:a9b2b6f07bfc371ed5b9c1e305cd8ac07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <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>
  79. <tr class="separator:a9a2b1ca4d91cff876f48deeaacbc33da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a6aa3b31a011653ee9e194fc1c270fb84"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a6aa3b31a011653ee9e194fc1c270fb84">DUE_SOFT_SPI</a>&#160;&#160;&#160;0</td></tr>
  81. <tr class="separator:a6aa3b31a011653ee9e194fc1c270fb84"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a5fa85e013e8661465ff4bc2395d77dd1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a5fa85e013e8661465ff4bc2395d77dd1">ENABLE_SPI_TRANSACTION</a>&#160;&#160;&#160;0</td></tr>
  83. <tr class="separator:a5fa85e013e8661465ff4bc2395d77dd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a360adabab0d776df344efa2f8cd34b83"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a360adabab0d776df344efa2f8cd34b83">ENABLE_SPI_YIELD</a>&#160;&#160;&#160;0</td></tr>
  85. <tr class="separator:a360adabab0d776df344efa2f8cd34b83"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <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>
  87. <tr class="separator:a270eefdaec4778f2a491658f34f61b17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <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>
  89. <tr class="separator:a28998c5daf4bd038f4f93172698320b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a60a162fdb06d182b5cefc271d67ea765"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a60a162fdb06d182b5cefc271d67ea765">LEONARDO_SOFT_SPI</a>&#160;&#160;&#160;0</td></tr>
  91. <tr class="separator:a60a162fdb06d182b5cefc271d67ea765"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ad3a00a466d2b81cff13c5447a09d704b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#ad3a00a466d2b81cff13c5447a09d704b">MEGA_SOFT_SPI</a>&#160;&#160;&#160;0</td></tr>
  93. <tr class="separator:ad3a00a466d2b81cff13c5447a09d704b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a7e12956d7ec38c1dd9a27b9208e98fb8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a7e12956d7ec38c1dd9a27b9208e98fb8">TEENSY3_SOFT_SPI</a>&#160;&#160;&#160;0</td></tr>
  95. <tr class="separator:a7e12956d7ec38c1dd9a27b9208e98fb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a8dfff1c0ff6919b9eeaa17120834c23d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#a8dfff1c0ff6919b9eeaa17120834c23d">USE_ARDUINO_SPI_LIBRARY</a>&#160;&#160;&#160;0</td></tr>
  97. <tr class="separator:a8dfff1c0ff6919b9eeaa17120834c23d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ac551245b3e5d757ea6d3f4867b939f5b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#ac551245b3e5d757ea6d3f4867b939f5b">USE_MULTI_BLOCK_SD_IO</a>&#160;&#160;&#160;1</td></tr>
  99. <tr class="separator:ac551245b3e5d757ea6d3f4867b939f5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ac6b66d035a552c981ab0db9006bdfb7b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#ac6b66d035a552c981ab0db9006bdfb7b">USE_MULTIPLE_CARDS</a>&#160;&#160;&#160;0</td></tr>
  101. <tr class="separator:ac6b66d035a552c981ab0db9006bdfb7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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>
  103. <tr class="separator:af2e76ffb2fdb830175abf513dd640fdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <tr class="separator:a23f662882413dcb017ebd8107473b8c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:ab4b647a03aa38c5fcc2d6f8301410fce"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_config_8h.html#ab4b647a03aa38c5fcc2d6f8301410fce">USE_SERIAL_FOR_STD_OUT</a>&#160;&#160;&#160;0</td></tr>
  107. <tr class="separator:ab4b647a03aa38c5fcc2d6f8301410fce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. </table><table class="memberdecls">
  109. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
  110. Variables</h2></td></tr>
  111. <tr class="memitem:a5e0307dbc42b2444deedd558bcdd8933"><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#a5e0307dbc42b2444deedd558bcdd8933">SOFT_SPI_CS_PIN</a> = 10</td></tr>
  112. <tr class="separator:a5e0307dbc42b2444deedd558bcdd8933"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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>
  114. <tr class="separator:af12e3a0d80cb8c7c9e3841887c508f3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <tr class="separator:ac2f492b4970ffbbea92d5d3e3f8aa2f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <tr class="separator:add7db7df22669e60cddd5698113d6327"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <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>
  120. <tr class="separator:af3fc94b8e56959250e83b791cdd678d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table>
  122. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  123. <div class="textblock"><p>configuration definitions </p>
  124. </div><h2 class="groupheader">Macro Definition Documentation</h2>
  125. <a class="anchor" id="a9b2b6f07bfc371ed5b9c1e305cd8ac07"></a>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">#define AVR_SOFT_SPI&#160;&#160;&#160;0</td>
  131. </tr>
  132. </table>
  133. </div><div class="memdoc">
  134. <p>Define AVR_SOF_SPI nonzero to use software SPI on all AVR Arduinos. </p>
  135. </div>
  136. </div>
  137. <a class="anchor" id="a9a2b1ca4d91cff876f48deeaacbc33da"></a>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">#define DESTRUCTOR_CLOSES_FILE&#160;&#160;&#160;0</td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. <p>Set DESTRUCTOR_CLOSES_FILE nonzero to close a file in its destructor.</p>
  147. <p>Causes use of lots of heap in ARM. </p>
  148. </div>
  149. </div>
  150. <a class="anchor" id="a6aa3b31a011653ee9e194fc1c270fb84"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">#define DUE_SOFT_SPI&#160;&#160;&#160;0</td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. <p>Define DUE_SOFT_SPI nonzero to use software SPI on Due Arduinos. </p>
  160. </div>
  161. </div>
  162. <a class="anchor" id="a5fa85e013e8661465ff4bc2395d77dd1"></a>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname">#define ENABLE_SPI_TRANSACTION&#160;&#160;&#160;0</td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. <p>Set ENABLE_SPI_TRANSACTION nonzero to enable the SPI transaction feature of the standard Arduino SPI library. You must include SPI.h in your sketches when ENABLE_SPI_TRANSACTION is nonzero. </p>
  172. </div>
  173. </div>
  174. <a class="anchor" id="a360adabab0d776df344efa2f8cd34b83"></a>
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">#define ENABLE_SPI_YIELD&#160;&#160;&#160;0</td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. <p>Set ENABLE_SPI_YIELD nonzero to enable release of the SPI bus during SD card busy waits.</p>
  184. <p>This will allow interrupt routines to access the SPI bus if ENABLE_SPI_TRANSACTION is nonzero.</p>
  185. <p>Setting ENABLE_SPI_YIELD will introduce some extra overhead and will slightly slow transfer rates. A few older SD cards may fail when ENABLE_SPI_YIELD is nonzero. </p>
  186. </div>
  187. </div>
  188. <a class="anchor" id="a270eefdaec4778f2a491658f34f61b17"></a>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">#define ENDL_CALLS_FLUSH&#160;&#160;&#160;0</td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>Call flush for endl if ENDL_CALLS_FLUSH is nonzero</p>
  198. <p>The standard for iostreams is to call flush. This is very costly for <a class="el" href="class_sd_fat.html" title="Integration class for the SdFat library. ">SdFat</a>. Each call to flush causes 2048 bytes of I/O to the SD.</p>
  199. <p><a class="el" href="class_sd_fat.html" title="Integration class for the 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>
  200. <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>
  201. <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>
  202. </div>
  203. </div>
  204. <a class="anchor" id="a28998c5daf4bd038f4f93172698320b1"></a>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">#define FAT12_SUPPORT&#160;&#160;&#160;0</td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <p>Allow FAT12 volumes if FAT12_SUPPORT is nonzero. FAT12 has not been well tested. </p>
  214. </div>
  215. </div>
  216. <a class="anchor" id="a60a162fdb06d182b5cefc271d67ea765"></a>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="memname">
  220. <tr>
  221. <td class="memname">#define LEONARDO_SOFT_SPI&#160;&#160;&#160;0</td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. <p>Define LEONARDO_SOFT_SPI nonzero to use software SPI on Leonardo Arduinos. LEONARDO_SOFT_SPI allows an unmodified 328 Shield to be used on Leonardo Arduinos. </p>
  226. </div>
  227. </div>
  228. <a class="anchor" id="ad3a00a466d2b81cff13c5447a09d704b"></a>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">#define MEGA_SOFT_SPI&#160;&#160;&#160;0</td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. <p>Define MEGA_SOFT_SPI nonzero to use software SPI on Mega Arduinos. MEGA_SOFT_SPI allows an unmodified 328 Shield to be used on Mega Arduinos. </p>
  238. </div>
  239. </div>
  240. <a class="anchor" id="a7e12956d7ec38c1dd9a27b9208e98fb8"></a>
  241. <div class="memitem">
  242. <div class="memproto">
  243. <table class="memname">
  244. <tr>
  245. <td class="memname">#define TEENSY3_SOFT_SPI&#160;&#160;&#160;0</td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>Set TEENSY3_SOFT_SPI nonzero to use software SPI on Teensy 3.x boards. </p>
  250. </div>
  251. </div>
  252. <a class="anchor" id="a8dfff1c0ff6919b9eeaa17120834c23d"></a>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname">#define USE_ARDUINO_SPI_LIBRARY&#160;&#160;&#160;0</td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. <p>Force use of Arduino Standard SPI library if USE_ARDUINO_SPI_LIBRARY is nonzero. This will override native and software SPI for all boards. </p>
  262. </div>
  263. </div>
  264. <a class="anchor" id="ac551245b3e5d757ea6d3f4867b939f5b"></a>
  265. <div class="memitem">
  266. <div class="memproto">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">#define USE_MULTI_BLOCK_SD_IO&#160;&#160;&#160;1</td>
  270. </tr>
  271. </table>
  272. </div><div class="memdoc">
  273. <p>Set USE_MULTI_BLOCK_SD_IO nonzero to use multi-block SD read/write.</p>
  274. <p>Don't use mult-block read/write on small AVR boards. </p>
  275. </div>
  276. </div>
  277. <a class="anchor" id="ac6b66d035a552c981ab0db9006bdfb7b"></a>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">#define USE_MULTIPLE_CARDS&#160;&#160;&#160;0</td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <p>To use multiple SD cards set USE_MULTIPLE_CARDS nonzero.</p>
  287. <p>Using multiple cards costs about 200 bytes of flash.</p>
  288. <p>Each card requires about 550 bytes of SRAM so use of a Mega is recommended. </p>
  289. </div>
  290. </div>
  291. <a class="anchor" id="af2e76ffb2fdb830175abf513dd640fdd"></a>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <table class="memname">
  295. <tr>
  296. <td class="memname">#define USE_SD_CRC&#160;&#160;&#160;0</td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <p>To enable SD card CRC checking set USE_SD_CRC nonzero.</p>
  301. <p>Set USE_SD_CRC to 1 to use a smaller slower CRC-CCITT function.</p>
  302. <p>Set USE_SD_CRC to 2 to used a larger faster table driven CRC-CCITT function. </p>
  303. </div>
  304. </div>
  305. <a class="anchor" id="a23f662882413dcb017ebd8107473b8c3"></a>
  306. <div class="memitem">
  307. <div class="memproto">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">#define USE_SEPARATE_FAT_CACHE&#160;&#160;&#160;0</td>
  311. </tr>
  312. </table>
  313. </div><div class="memdoc">
  314. <p>Set USE_SEPARATE_FAT_CACHE nonzero to use a second 512 byte cache for FAT table entries. Improves performance for large writes that are not a multiple of 512 bytes. </p>
  315. </div>
  316. </div>
  317. <a class="anchor" id="ab4b647a03aa38c5fcc2d6f8301410fce"></a>
  318. <div class="memitem">
  319. <div class="memproto">
  320. <table class="memname">
  321. <tr>
  322. <td class="memname">#define USE_SERIAL_FOR_STD_OUT&#160;&#160;&#160;0</td>
  323. </tr>
  324. </table>
  325. </div><div class="memdoc">
  326. <p>For AVR</p>
  327. <p>Set USE_SERIAL_FOR_STD_OUT nonzero to use Serial (the HardwareSerial class) for error messages and output from print functions like ls().</p>
  328. <p>If USE_SERIAL_FOR_STD_OUT is zero, a small non-interrupt driven class is used to output messages to serial port zero. This allows an alternate Serial library like SerialPort to be used with <a class="el" href="class_sd_fat.html" title="Integration class for the SdFat library. ">SdFat</a>.</p>
  329. <p>You can redirect stdOut with <a class="el" href="class_sd_fat.html#a87c53828b0ccd33c77d2a8175c4cdf82">SdFat::setStdOut(Print* stream)</a> and get the current stream with <a class="el" href="class_sd_fat.html#ae5f0467524c70b7a85840c291710d7ca">SdFat::stdOut()</a>. </p>
  330. </div>
  331. </div>
  332. <h2 class="groupheader">Variable Documentation</h2>
  333. <a class="anchor" id="a5e0307dbc42b2444deedd558bcdd8933"></a>
  334. <div class="memitem">
  335. <div class="memproto">
  336. <table class="memname">
  337. <tr>
  338. <td class="memname">uint8_t const SOFT_SPI_CS_PIN = 10</td>
  339. </tr>
  340. </table>
  341. </div><div class="memdoc">
  342. <p>Define software SPI pins. Default allows Uno shields to be used on other boards.Default Software SPI chip select pin </p>
  343. </div>
  344. </div>
  345. <a class="anchor" id="af12e3a0d80cb8c7c9e3841887c508f3f"></a>
  346. <div class="memitem">
  347. <div class="memproto">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname">uint8_t const SOFT_SPI_MISO_PIN = 12</td>
  351. </tr>
  352. </table>
  353. </div><div class="memdoc">
  354. <p>Software SPI Master In Slave Out pin </p>
  355. </div>
  356. </div>
  357. <a class="anchor" id="ac2f492b4970ffbbea92d5d3e3f8aa2f0"></a>
  358. <div class="memitem">
  359. <div class="memproto">
  360. <table class="memname">
  361. <tr>
  362. <td class="memname">uint8_t const SOFT_SPI_MOSI_PIN = 11</td>
  363. </tr>
  364. </table>
  365. </div><div class="memdoc">
  366. <p>Software SPI Master Out Slave In pin </p>
  367. </div>
  368. </div>
  369. <a class="anchor" id="add7db7df22669e60cddd5698113d6327"></a>
  370. <div class="memitem">
  371. <div class="memproto">
  372. <table class="memname">
  373. <tr>
  374. <td class="memname">uint8_t const SOFT_SPI_SCK_PIN = 13</td>
  375. </tr>
  376. </table>
  377. </div><div class="memdoc">
  378. <p>Software SPI Clock pin </p>
  379. </div>
  380. </div>
  381. <a class="anchor" id="af3fc94b8e56959250e83b791cdd678d1"></a>
  382. <div class="memitem">
  383. <div class="memproto">
  384. <table class="memname">
  385. <tr>
  386. <td class="memname">const uint8_t SPI_SCK_INIT_DIVISOR = 128</td>
  387. </tr>
  388. </table>
  389. </div><div class="memdoc">
  390. <p>SPI SCK divisor for SD initialization commands. or greater </p>
  391. </div>
  392. </div>
  393. </div><!-- contents -->
  394. <!-- start footer part -->
  395. <hr class="footer"/><address class="footer"><small>
  396. Generated on Fri Sep 5 2014 13:07:45 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  397. <img class="footer" src="doxygen.png" alt="doxygen"/>
  398. </a> 1.8.6
  399. </small></address>
  400. </body>
  401. </html>