ffconf.h 12 KB

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