ffconf.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307
  1. #ifdef __LUATOS__
  2. #include "luat_conf_bsp.h"
  3. #endif
  4. /*---------------------------------------------------------------------------/
  5. / Configurations of FatFs Module
  6. /---------------------------------------------------------------------------*/
  7. #define FFCONF_DEF 80286 /* Revision ID */
  8. /*---------------------------------------------------------------------------/
  9. / Function Configurations
  10. /---------------------------------------------------------------------------*/
  11. #define FF_FS_READONLY 0
  12. /* This option switches read-only configuration. (0:Read/Write or 1:Read-only)
  13. / Read-only configuration removes writing API functions, f_write(), f_sync(),
  14. / f_unlink(), f_mkdir(), f_chmod(), f_rename(), f_truncate(), f_getfree()
  15. / and optional writing functions as well. */
  16. #define FF_FS_MINIMIZE 0
  17. /* This option defines minimization level to remove some basic API functions.
  18. /
  19. / 0: Basic functions are fully enabled.
  20. / 1: f_stat(), f_getfree(), f_unlink(), f_mkdir(), f_truncate() and f_rename()
  21. / are removed.
  22. / 2: f_opendir(), f_readdir() and f_closedir() are removed in addition to 1.
  23. / 3: f_lseek() function is removed in addition to 2. */
  24. #define FF_USE_FIND 0
  25. /* This option switches filtered directory read functions, f_findfirst() and
  26. / f_findnext(). (0:Disable, 1:Enable 2:Enable with matching altname[] too) */
  27. #define FF_USE_MKFS 1
  28. /* This option switches f_mkfs() function. (0:Disable or 1:Enable) */
  29. #define FF_USE_FASTSEEK 0
  30. /* This option switches fast seek function. (0:Disable or 1:Enable) */
  31. #define FF_USE_EXPAND 0
  32. /* This option switches f_expand function. (0:Disable or 1:Enable) */
  33. #define FF_USE_CHMOD 0
  34. /* This option switches attribute manipulation functions, f_chmod() and f_utime().
  35. / (0:Disable or 1:Enable) Also FF_FS_READONLY needs to be 0 to enable this option. */
  36. #define FF_USE_LABEL 0
  37. /* This option switches volume label functions, f_getlabel() and f_setlabel().
  38. / (0:Disable or 1:Enable) */
  39. #define FF_USE_FORWARD 0
  40. /* This option switches f_forward() function. (0:Disable or 1:Enable) */
  41. #define FF_USE_STRFUNC 0
  42. #define FF_PRINT_LLI 0
  43. #define FF_PRINT_FLOAT 0
  44. #define FF_STRF_ENCODE 0
  45. /* FF_USE_STRFUNC switches string functions, f_gets(), f_putc(), f_puts() and
  46. / f_printf().
  47. /
  48. / 0: Disable. FF_PRINT_LLI, FF_PRINT_FLOAT and FF_STRF_ENCODE have no effect.
  49. / 1: Enable without LF-CRLF conversion.
  50. / 2: Enable with LF-CRLF conversion.
  51. /
  52. / FF_PRINT_LLI = 1 makes f_printf() support long long argument and FF_PRINT_FLOAT = 1/2
  53. / makes f_printf() support floating point argument. These features want C99 or later.
  54. / When FF_LFN_UNICODE >= 1 with LFN enabled, string functions convert the character
  55. / encoding in it. FF_STRF_ENCODE selects assumption of character encoding ON THE FILE
  56. / to be read/written via those functions.
  57. /
  58. / 0: ANSI/OEM in current CP
  59. / 1: Unicode in UTF-16LE
  60. / 2: Unicode in UTF-16BE
  61. / 3: Unicode in UTF-8
  62. */
  63. /*---------------------------------------------------------------------------/
  64. / Locale and Namespace Configurations
  65. /---------------------------------------------------------------------------*/
  66. #define FF_CODE_PAGE 936
  67. /* This option specifies the OEM code page to be used on the target system.
  68. / Incorrect code page setting can cause a file open failure.
  69. /
  70. / 437 - U.S.
  71. / 720 - Arabic
  72. / 737 - Greek
  73. / 771 - KBL
  74. / 775 - Baltic
  75. / 850 - Latin 1
  76. / 852 - Latin 2
  77. / 855 - Cyrillic
  78. / 857 - Turkish
  79. / 860 - Portuguese
  80. / 861 - Icelandic
  81. / 862 - Hebrew
  82. / 863 - Canadian French
  83. / 864 - Arabic
  84. / 865 - Nordic
  85. / 866 - Russian
  86. / 869 - Greek 2
  87. / 932 - Japanese (DBCS)
  88. / 936 - Simplified Chinese (DBCS)
  89. / 949 - Korean (DBCS)
  90. / 950 - Traditional Chinese (DBCS)
  91. / 0 - Include all code pages above and configured by f_setcp()
  92. */
  93. #ifdef LUAT_USE_FATFS_CHINESE
  94. #define FF_USE_LFN 2
  95. #else
  96. #define FF_USE_LFN 2
  97. #undef FF_CODE_PAGE
  98. #define FF_CODE_PAGE 437
  99. #endif
  100. #define FF_MAX_LFN 255
  101. /* The FF_USE_LFN switches the support for LFN (long file name).
  102. /
  103. / 0: Disable LFN. FF_MAX_LFN has no effect.
  104. / 1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe.
  105. / 2: Enable LFN with dynamic working buffer on the STACK.
  106. / 3: Enable LFN with dynamic working buffer on the HEAP.
  107. /
  108. / To enable the LFN, ffunicode.c needs to be added to the project. The LFN function
  109. / requiers certain internal working buffer occupies (FF_MAX_LFN + 1) * 2 bytes and
  110. / additional (FF_MAX_LFN + 44) / 15 * 32 bytes when exFAT is enabled.
  111. / The FF_MAX_LFN defines size of the working buffer in UTF-16 code unit and it can
  112. / be in range of 12 to 255. It is recommended to be set it 255 to fully support LFN
  113. / specification.
  114. / When use stack for the working buffer, take care on stack overflow. When use heap
  115. / memory for the working buffer, memory management functions, ff_memalloc() and
  116. / ff_memfree() exemplified in ffsystem.c, need to be added to the project. */
  117. #ifdef LUAT_USE_FATFS_CHINESE
  118. #define FF_LFN_UNICODE 2
  119. #else
  120. #define FF_LFN_UNICODE 0
  121. #endif
  122. /* This option switches the character encoding on the API when LFN is enabled.
  123. /
  124. / 0: ANSI/OEM in current CP (TCHAR = char)
  125. / 1: Unicode in UTF-16 (TCHAR = WCHAR)
  126. / 2: Unicode in UTF-8 (TCHAR = char)
  127. / 3: Unicode in UTF-32 (TCHAR = DWORD)
  128. /
  129. / Also behavior of string I/O functions will be affected by this option.
  130. / When LFN is not enabled, this option has no effect. */
  131. #define FF_LFN_BUF 255
  132. #define FF_SFN_BUF 12
  133. /* This set of options defines size of file name members in the FILINFO structure
  134. / which is used to read out directory items. These values should be suffcient for
  135. / the file names to read. The maximum possible length of the read file name depends
  136. / on character encoding. When LFN is not enabled, these options have no effect. */
  137. #define FF_FS_RPATH 0
  138. /* This option configures support for relative path.
  139. /
  140. / 0: Disable relative path and remove related functions.
  141. / 1: Enable relative path. f_chdir() and f_chdrive() are available.
  142. / 2: f_getcwd() function is available in addition to 1.
  143. */
  144. /*---------------------------------------------------------------------------/
  145. / Drive/Volume Configurations
  146. /---------------------------------------------------------------------------*/
  147. #define FF_VOLUMES 1
  148. /* Number of volumes (logical drives) to be used. (1-10) */
  149. #define FF_STR_VOLUME_ID 0
  150. #define FF_VOLUME_STRS "RAM","NAND","CF","SD","SD2","USB","USB2","USB3"
  151. /* FF_STR_VOLUME_ID switches support for volume ID in arbitrary strings.
  152. / When FF_STR_VOLUME_ID is set to 1 or 2, arbitrary strings can be used as drive
  153. / number in the path name. FF_VOLUME_STRS defines the volume ID strings for each
  154. / logical drives. Number of items must not be less than FF_VOLUMES. Valid
  155. / characters for the volume ID strings are A-Z, a-z and 0-9, however, they are
  156. / compared in case-insensitive. If FF_STR_VOLUME_ID >= 1 and FF_VOLUME_STRS is
  157. / not defined, a user defined volume string table is needed as:
  158. /
  159. / const char* VolumeStr[FF_VOLUMES] = {"ram","flash","sd","usb",...
  160. */
  161. #define FF_MULTI_PARTITION 0
  162. /* This option switches support for multiple volumes on the physical drive.
  163. / By default (0), each logical drive number is bound to the same physical drive
  164. / number and only an FAT volume found on the physical drive will be mounted.
  165. / When this function is enabled (1), each logical drive number can be bound to
  166. / arbitrary physical drive and partition listed in the VolToPart[]. Also f_fdisk()
  167. / function will be available. */
  168. #define FF_MIN_SS 512
  169. #define FF_MAX_SS 512
  170. /* This set of options configures the range of sector size to be supported. (512,
  171. / 1024, 2048 or 4096) Always set both 512 for most systems, generic memory card and
  172. / harddisk, but a larger value may be required for on-board flash memory and some
  173. / type of optical media. When FF_MAX_SS is larger than FF_MIN_SS, FatFs is configured
  174. / for variable sector size mode and disk_ioctl() function needs to implement
  175. / GET_SECTOR_SIZE command. */
  176. #define FF_LBA64 0
  177. /* This option switches support for 64-bit LBA. (0:Disable or 1:Enable)
  178. / To enable the 64-bit LBA, also exFAT needs to be enabled. (FF_FS_EXFAT == 1) */
  179. #define FF_MIN_GPT 0x10000000
  180. /* Minimum number of sectors to switch GPT as partitioning format in f_mkfs and
  181. / f_fdisk function. 0x100000000 max. This option has no effect when FF_LBA64 == 0. */
  182. #define FF_USE_TRIM 0
  183. /* This option switches support for ATA-TRIM. (0:Disable or 1:Enable)
  184. / To enable Trim function, also CTRL_TRIM command should be implemented to the
  185. / disk_ioctl() function. */
  186. /*---------------------------------------------------------------------------/
  187. / System Configurations
  188. /---------------------------------------------------------------------------*/
  189. #define FF_FS_TINY 0
  190. /* This option switches tiny buffer configuration. (0:Normal or 1:Tiny)
  191. / At the tiny configuration, size of file object (FIL) is shrinked FF_MAX_SS bytes.
  192. / Instead of private sector buffer eliminated from the file object, common sector
  193. / buffer in the filesystem object (FATFS) is used for the file data transfer. */
  194. #define FF_FS_EXFAT 0
  195. /* This option switches support for exFAT filesystem. (0:Disable or 1:Enable)
  196. / To enable exFAT, also LFN needs to be enabled. (FF_USE_LFN >= 1)
  197. / Note that enabling exFAT discards ANSI C (C89) compatibility. */
  198. #define FF_FS_NORTC 0
  199. #define FF_NORTC_MON 1
  200. #define FF_NORTC_MDAY 1
  201. #define FF_NORTC_YEAR 2022
  202. /* The option FF_FS_NORTC switches timestamp feature. If the system does not have
  203. / an RTC or valid timestamp is not needed, set FF_FS_NORTC = 1 to disable the
  204. / timestamp feature. Every object modified by FatFs will have a fixed timestamp
  205. / defined by FF_NORTC_MON, FF_NORTC_MDAY and FF_NORTC_YEAR in local time.
  206. / To enable timestamp function (FF_FS_NORTC = 0), get_fattime() function need to be
  207. / added to the project to read current time form real-time clock. FF_NORTC_MON,
  208. / FF_NORTC_MDAY and FF_NORTC_YEAR have no effect.
  209. / These options have no effect in read-only configuration (FF_FS_READONLY = 1). */
  210. #define FF_FS_NOFSINFO 0
  211. /* If you need to know correct free space on the FAT32 volume, set bit 0 of this
  212. / option, and f_getfree() function at the first time after volume mount will force
  213. / a full FAT scan. Bit 1 controls the use of last allocated cluster number.
  214. /
  215. / bit0=0: Use free cluster count in the FSINFO if available.
  216. / bit0=1: Do not trust free cluster count in the FSINFO.
  217. / bit1=0: Use last allocated cluster number in the FSINFO if available.
  218. / bit1=1: Do not trust last allocated cluster number in the FSINFO.
  219. */
  220. #define FF_FS_LOCK 0
  221. /* The option FF_FS_LOCK switches file lock function to control duplicated file open
  222. / and illegal operation to open objects. This option must be 0 when FF_FS_READONLY
  223. / is 1.
  224. /
  225. / 0: Disable file lock function. To avoid volume corruption, application program
  226. / should avoid illegal open, remove and rename to the open objects.
  227. / >0: Enable file lock function. The value defines how many files/sub-directories
  228. / can be opened simultaneously under file lock control. Note that the file
  229. / lock control is independent of re-entrancy. */
  230. #define FF_FS_REENTRANT 0
  231. #define FF_FS_TIMEOUT 1000
  232. /* The option FF_FS_REENTRANT switches the re-entrancy (thread safe) of the FatFs
  233. / module itself. Note that regardless of this option, file access to different
  234. / volume is always re-entrant and volume control functions, f_mount(), f_mkfs()
  235. / and f_fdisk() function, are always not re-entrant. Only file/directory access
  236. / to the same volume is under control of this featuer.
  237. /
  238. / 0: Disable re-entrancy. FF_FS_TIMEOUT have no effect.
  239. / 1: Enable re-entrancy. Also user provided synchronization handlers,
  240. / ff_mutex_create(), ff_mutex_delete(), ff_mutex_take() and ff_mutex_give()
  241. / function, must be added to the project. Samples are available in ffsystem.c.
  242. /
  243. / The FF_FS_TIMEOUT defines timeout period in unit of O/S time tick.
  244. */
  245. /*--- End of configuration options ---*/