visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
42 Commits
1 Branch
Tree: 7871875f5c
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '7871875f5c'
${ noResults }
teensy-sdfat/extras/html/_fat_lib_config_8h.html

275 lines
15KB
Raw Blame History 

  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/FatLib/FatLibConfig.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="annotated.html"><span>Classes</span></a></li>

  42.       <li class="current"><a href="files.html"><span>Files</span></a></li>

  43.       <li>

  44.         <div id="MSearchBox" class="MSearchBoxInactive">

  45.         <span class="left">

  46.           <img id="MSearchSelect" src="search/mag_sel.png"

  47.                onmouseover="return searchBox.OnSearchSelectShow()"

  48.                onmouseout="return searchBox.OnSearchSelectHide()"

  49.                alt=""/>

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  54.           </span><span class="right">

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

  61.   <div id="navrow2" class="tabs2">

  62.     <ul class="tablist">

  63.       <li><a href="files.html"><span>File&#160;List</span></a></li>

  64.       <li><a href="globals.html"><span>File&#160;Members</span></a></li>

  65.     </ul>

  66.   </div>

  67. <!-- window showing the filter options -->

  68. <div id="MSearchSelectWindow"

  69.      onmouseover="return searchBox.OnSearchSelectShow()"

  70.      onmouseout="return searchBox.OnSearchSelectHide()"

  71.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  72. </div>

  73. 

  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. 

  81. <div id="nav-path" class="navpath">

  82.   <ul>

  83. <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><li class="navelem"><a class="el" href="dir_7e472674a7b7d2590a789f197241f95f.html">FatLib</a></li>  </ul>

  84. </div>

  85. </div><!-- top -->

  86. <div class="header">

  87.   <div class="summary">

  88. <a href="#define-members">Macros</a>  </div>

  89.   <div class="headertitle">

  90. <div class="title">FatLibConfig.h File Reference</div>  </div>

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

  92. <div class="contents">

  93. 

  94. <p>configuration definitions  

  95. <a href="#details">More...</a></p>

  96. <div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />

  97. <code>#include &quot;<a class="el" href="_sd_fat_config_8h.html">SdFatConfig.h</a>&quot;</code><br />

  98. <code>#include &lt;Arduino.h&gt;</code><br />

  99. </div><div class="textblock"><div class="dynheader">

  100. Include dependency graph for FatLibConfig.h:</div>

  101. <div class="dyncontent">

  102. <div class="center"><img src="_fat_lib_config_8h__incl.png" border="0" usemap="#_arduino_2libraries_2_sd_fat_2src_2_fat_lib_2_fat_lib_config_8h" alt=""/></div>

  103. <map name="_arduino_2libraries_2_sd_fat_2src_2_fat_lib_2_fat_lib_config_8h" id="_arduino_2libraries_2_sd_fat_2src_2_fat_lib_2_fat_lib_config_8h">

  104. <area shape="rect" id="node3" href="_sd_fat_config_8h.html" title="configuration definitions " alt="" coords="39,95,143,121"/>

  105. </map>

  106. </div>

  107. </div><div class="textblock"><div class="dynheader">

  108. This graph shows which files directly or indirectly include this file:</div>

  109. <div class="dyncontent">

  110. <div class="center"><img src="_fat_lib_config_8h__dep__incl.png" border="0" usemap="#_arduino_2libraries_2_sd_fat_2src_2_fat_lib_2_fat_lib_config_8hdep" alt=""/></div>

  111. <map name="_arduino_2libraries_2_sd_fat_2src_2_fat_lib_2_fat_lib_config_8hdep" id="_arduino_2libraries_2_sd_fat_2src_2_fat_lib_2_fat_lib_config_8hdep">

  112. <area shape="rect" id="node2" href="_arduino_files_8h.html" title="PrintFile class. " alt="" coords="55,273,225,315"/>

  113. <area shape="rect" id="node4" href="_fat_file_8h.html" title="FatFile class. " alt="" coords="243,184,397,225"/>

  114. <area shape="rect" id="node9" href="_arduino_stream_8h.html" title="ArduinoInStream and ArduinoOutStream classes. " alt="" coords="326,631,511,672"/>

  115. <area shape="rect" id="node13" href="_fat_volume_8h.html" title="FatVolume class. " alt="" coords="5,95,168,136"/>

  116. <area shape="rect" id="node3" href="_fat_file_system_8h.html" title="FatFileSystem class. " alt="" coords="73,720,257,761"/>

  117. <area shape="rect" id="node5" href="ios_8h.html" title="ios_base and ios classes " alt="" coords="300,273,455,315"/>

  118. <area shape="rect" id="node10" href="fstream_8h.html" title="fstream, ifstream, and ofstream classes " alt="" coords="521,541,676,583"/>

  119. <area shape="rect" id="node12" href="_stdio_stream_8h.html" title="StdioStream class. " alt="" coords="583,273,753,315"/>

  120. <area shape="rect" id="node6" href="istream_8h.html" title="istream class " alt="" coords="407,363,561,404"/>

  121. <area shape="rect" id="node11" href="ostream_8h.html" title="ostream class " alt="" coords="228,363,383,404"/>

  122. <area shape="rect" id="node7" href="iostream_8h.html" title="iostream class " alt="" coords="373,452,528,493"/>

  123. <area shape="rect" id="node8" href="bufstream_8h.html" title="ibufstream and obufstream classes " alt="" coords="341,541,497,583"/>

  124. </map>

  125. </div>

  126. </div><table class="memberdecls">

  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>

  128. Macros</h2></td></tr>

  129. <tr class="memitem:a9a2b1ca4d91cff876f48deeaacbc33da"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fat_lib_config_8h.html#a9a2b1ca4d91cff876f48deeaacbc33da">DESTRUCTOR_CLOSES_FILE</a>&#160;&#160;&#160;0</td></tr>

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

  131. <tr class="memitem:a9a8c1ea8596f35f7f33a24b642567206"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fat_lib_config_8h.html#a9a8c1ea8596f35f7f33a24b642567206">ENABLE_ARDUINO_FEATURES</a>&#160;&#160;&#160;1</td></tr>

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

  133. <tr class="memitem:a270eefdaec4778f2a491658f34f61b17"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fat_lib_config_8h.html#a270eefdaec4778f2a491658f34f61b17">ENDL_CALLS_FLUSH</a>&#160;&#160;&#160;0</td></tr>

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

  135. <tr class="memitem:a28998c5daf4bd038f4f93172698320b1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fat_lib_config_8h.html#a28998c5daf4bd038f4f93172698320b1">FAT12_SUPPORT</a>&#160;&#160;&#160;0</td></tr>

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

  137. <tr class="memitem:ac2865dac8fdbb4fff47105db32ddf05b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fat_lib_config_8h.html#ac2865dac8fdbb4fff47105db32ddf05b">MAINTAIN_FREE_CLUSTER_COUNT</a>&#160;&#160;&#160;0</td></tr>

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

  139. <tr class="memitem:a2536b194b3b007604a39e8526e108b52"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fat_lib_config_8h.html#a2536b194b3b007604a39e8526e108b52">USE_LONG_FILE_NAMES</a>&#160;&#160;&#160;1</td></tr>

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

  141. <tr class="memitem:afc3ef382d3ab8d7e6f8fc134ef21d487"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fat_lib_config_8h.html#afc3ef382d3ab8d7e6f8fc134ef21d487">USE_MULTI_BLOCK_IO</a>&#160;&#160;&#160;1</td></tr>

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

  143. <tr class="memitem:a23f662882413dcb017ebd8107473b8c3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fat_lib_config_8h.html#a23f662882413dcb017ebd8107473b8c3">USE_SEPARATE_FAT_CACHE</a>&#160;&#160;&#160;0</td></tr>

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

  145. </table>

  146. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  147. <div class="textblock"><p>configuration definitions </p>

  148. </div><h2 class="groupheader">Macro Definition Documentation</h2>

  149. <a class="anchor" id="a9a2b1ca4d91cff876f48deeaacbc33da"></a>

  150. <div class="memitem">

  151. <div class="memproto">

  152.       <table class="memname">

  153.         <tr>

  154.           <td class="memname">#define DESTRUCTOR_CLOSES_FILE&#160;&#160;&#160;0</td>

  155.         </tr>

  156.       </table>

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

  158. <p>Set DESTRUCTOR_CLOSES_FILE non-zero to close a file in its destructor.</p>

  159. <p>Causes use of lots of heap in ARM. </p>

  160. 

  161. </div>

  162. </div>

  163. <a class="anchor" id="a9a8c1ea8596f35f7f33a24b642567206"></a>

  164. <div class="memitem">

  165. <div class="memproto">

  166.       <table class="memname">

  167.         <tr>

  168.           <td class="memname">#define ENABLE_ARDUINO_FEATURES&#160;&#160;&#160;1</td>

  169.         </tr>

  170.       </table>

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

  172. <p>Enable Extra features for Arduino. </p>

  173. 

  174. </div>

  175. </div>

  176. <a class="anchor" id="a270eefdaec4778f2a491658f34f61b17"></a>

  177. <div class="memitem">

  178. <div class="memproto">

  179.       <table class="memname">

  180.         <tr>

  181.           <td class="memname">#define ENDL_CALLS_FLUSH&#160;&#160;&#160;0</td>

  182.         </tr>

  183.       </table>

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

  185. <p>Call flush for endl if ENDL_CALLS_FLUSH is non-zero</p>

  186. <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>

  187. <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 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>

  188. <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>

  189. <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>

  190. 

  191. </div>

  192. </div>

  193. <a class="anchor" id="a28998c5daf4bd038f4f93172698320b1"></a>

  194. <div class="memitem">

  195. <div class="memproto">

  196.       <table class="memname">

  197.         <tr>

  198.           <td class="memname">#define FAT12_SUPPORT&#160;&#160;&#160;0</td>

  199.         </tr>

  200.       </table>

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

  202. <p>Allow FAT12 volumes if FAT12_SUPPORT is non-zero. FAT12 has not been well tested. </p>

  203. 

  204. </div>

  205. </div>

  206. <a class="anchor" id="ac2865dac8fdbb4fff47105db32ddf05b"></a>

  207. <div class="memitem">

  208. <div class="memproto">

  209.       <table class="memname">

  210.         <tr>

  211.           <td class="memname">#define MAINTAIN_FREE_CLUSTER_COUNT&#160;&#160;&#160;0</td>

  212.         </tr>

  213.       </table>

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

  215. <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>

  216. 

  217. </div>

  218. </div>

  219. <a class="anchor" id="a2536b194b3b007604a39e8526e108b52"></a>

  220. <div class="memitem">

  221. <div class="memproto">

  222.       <table class="memname">

  223.         <tr>

  224.           <td class="memname">#define USE_LONG_FILE_NAMES&#160;&#160;&#160;1</td>

  225.         </tr>

  226.       </table>

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

  228. <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>

  229. <p>This implementation allows 7-bit characters in the range 0X20 to 0X7E. The following characters are not allowed:</p>

  230. <p>&lt; (less than) </p><blockquote class="doxtable">

  231. <p>(greater than) </p>

  232. </blockquote>

  233. <p>: (colon) " (double quote) / (forward slash) \ (backslash) | (vertical bar or pipe) ? (question mark)</p><ul>

  234. <li>(asterisk) </li>

  235. </ul>

  236. 

  237. </div>

  238. </div>

  239. <a class="anchor" id="afc3ef382d3ab8d7e6f8fc134ef21d487"></a>

  240. <div class="memitem">

  241. <div class="memproto">

  242.       <table class="memname">

  243.         <tr>

  244.           <td class="memname">#define USE_MULTI_BLOCK_IO&#160;&#160;&#160;1</td>

  245.         </tr>

  246.       </table>

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

  248. <p>Set USE_MULTI_BLOCK_IO non-zero to use multi-block SD read/write.</p>

  249. <p>Don't use mult-block read/write on small AVR boards. </p>

  250. 

  251. </div>

  252. </div>

  253. <a class="anchor" id="a23f662882413dcb017ebd8107473b8c3"></a>

  254. <div class="memitem">

  255. <div class="memproto">

  256.       <table class="memname">

  257.         <tr>

  258.           <td class="memname">#define USE_SEPARATE_FAT_CACHE&#160;&#160;&#160;0</td>

  259.         </tr>

  260.       </table>

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

  262. <p>Set USE_SEPARATE_FAT_CACHE non-zero 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>

  263. 

  264. </div>

  265. </div>

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

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

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

  269. Generated on Mon Sep 5 2016 10:18:52 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  271. </a> 1.8.10

  272. </small></address>

  273. </body>

  274. </html>