ffconf.h 12 KB

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