ffconf.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. /*---------------------------------------------------------------------------/
  2. / FatFs Functional Configurations
  3. /---------------------------------------------------------------------------*/
  4. #define FFCONF_DEF 86604 /* Revision ID */
  5. #include "user_config.h"
  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_STRFUNC 0
  23. /* This option switches string functions, f_gets(), f_putc(), f_puts() and f_printf().
  24. /
  25. / 0: Disable string functions.
  26. / 1: Enable without LF-CRLF conversion.
  27. / 2: Enable with LF-CRLF conversion. */
  28. #define FF_USE_FIND 0
  29. /* This option switches filtered directory read functions, f_findfirst() and
  30. / f_findnext(). (0:Disable, 1:Enable 2:Enable with matching altname[] too) */
  31. #define FF_USE_MKFS 0
  32. /* This option switches f_mkfs() function. (0:Disable or 1:Enable) */
  33. #define FF_USE_FASTSEEK 0
  34. /* This option switches fast seek function. (0:Disable or 1:Enable) */
  35. #define FF_USE_EXPAND 0
  36. /* This option switches f_expand function. (0:Disable or 1:Enable) */
  37. #define FF_USE_CHMOD 1
  38. /* This option switches attribute manipulation functions, f_chmod() and f_utime().
  39. / (0:Disable or 1:Enable) Also FF_FS_READONLY needs to be 0 to enable this option. */
  40. #define FF_USE_LABEL 1
  41. /* This option switches volume label functions, f_getlabel() and f_setlabel().
  42. / (0:Disable or 1:Enable) */
  43. #define FF_USE_FORWARD 0
  44. /* This option switches f_forward() function. (0:Disable or 1:Enable) */
  45. /*---------------------------------------------------------------------------/
  46. / Locale and Namespace Configurations
  47. /---------------------------------------------------------------------------*/
  48. #define FF_CODE_PAGE 932
  49. /* This option specifies the OEM code page to be used on the target system.
  50. / Incorrect code page setting can cause a file open failure.
  51. /
  52. / 437 - U.S.
  53. / 720 - Arabic
  54. / 737 - Greek
  55. / 771 - KBL
  56. / 775 - Baltic
  57. / 850 - Latin 1
  58. / 852 - Latin 2
  59. / 855 - Cyrillic
  60. / 857 - Turkish
  61. / 860 - Portuguese
  62. / 861 - Icelandic
  63. / 862 - Hebrew
  64. / 863 - Canadian French
  65. / 864 - Arabic
  66. / 865 - Nordic
  67. / 866 - Russian
  68. / 869 - Greek 2
  69. / 932 - Japanese (DBCS)
  70. / 936 - Simplified Chinese (DBCS)
  71. / 949 - Korean (DBCS)
  72. / 950 - Traditional Chinese (DBCS)
  73. / 0 - Include all code pages above and configured by f_setcp()
  74. */
  75. #define FF_USE_LFN 3
  76. #define FF_MAX_LFN (FS_OBJ_NAME_LEN+1+1)
  77. /* The FF_USE_LFN switches the support for LFN (long file name).
  78. /
  79. / 0: Disable LFN. FF_MAX_LFN has no effect.
  80. / 1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe.
  81. / 2: Enable LFN with dynamic working buffer on the STACK.
  82. / 3: Enable LFN with dynamic working buffer on the HEAP.
  83. /
  84. / To enable the LFN, ffunicode.c needs to be added to the project. The LFN function
  85. / requiers certain internal working buffer occupies (FF_MAX_LFN + 1) * 2 bytes and
  86. / additional (FF_MAX_LFN + 44) / 15 * 32 bytes when exFAT is enabled.
  87. / The FF_MAX_LFN defines size of the working buffer in UTF-16 code unit and it can
  88. / be in range of 12 to 255. It is recommended to be set 255 to fully support LFN
  89. / specification.
  90. / When use stack for the working buffer, take care on stack overflow. When use heap
  91. / memory for the working buffer, memory management functions, ff_memalloc() and
  92. / ff_memfree() in ffsystem.c, need to be added to the project. */
  93. #define FF_LFN_UNICODE 0
  94. /* This option switches the character encoding on the API when LFN is enabled.
  95. /
  96. / 0: ANSI/OEM in current CP (TCHAR = char)
  97. / 1: Unicode in UTF-16 (TCHAR = WCHAR)
  98. / 2: Unicode in UTF-8 (TCHAR = char)
  99. / 3: Unicode in UTF-32 (TCHAR = DWORD)
  100. /
  101. / Also behavior of string I/O functions will be affected by this option.
  102. / When LFN is not enabled, this option has no effect. */
  103. #define FF_LFN_BUF 255
  104. #define FF_SFN_BUF 12
  105. /* This set of options defines size of file name members in the FILINFO structure
  106. / which is used to read out directory items. These values should be suffcient for
  107. / the file names to read. The maximum possible length of the read file name depends
  108. / on character encoding. When LFN is not enabled, these options have no effect. */
  109. #define FF_STRF_ENCODE 3
  110. /* When FF_LFN_UNICODE >= 1 with LFN enabled, string I/O functions, f_gets(),
  111. / f_putc(), f_puts and f_printf() convert the character encoding in it.
  112. / This option selects assumption of character encoding ON THE FILE to be
  113. / read/written via those functions.
  114. /
  115. / 0: ANSI/OEM in current CP
  116. / 1: Unicode in UTF-16LE
  117. / 2: Unicode in UTF-16BE
  118. / 3: Unicode in UTF-8
  119. */
  120. #define FF_FS_RPATH 2
  121. /* This option configures support for relative path.
  122. /
  123. / 0: Disable relative path and remove related functions.
  124. / 1: Enable relative path. f_chdir() and f_chdrive() are available.
  125. / 2: f_getcwd() function is available in addition to 1.
  126. */
  127. /*---------------------------------------------------------------------------/
  128. / Drive/Volume Configurations
  129. /---------------------------------------------------------------------------*/
  130. #define FF_VOLUMES 4
  131. /* Number of volumes (logical drives) to be used. (1-10) */
  132. #define FF_STR_VOLUME_ID 1
  133. #define FF_VOLUME_STRS "SD0","SD1","SD2","SD3"
  134. /* FF_STR_VOLUME_ID switches support for volume ID in arbitrary strings.
  135. / When FF_STR_VOLUME_ID is set to 1 or 2, arbitrary strings can be used as drive
  136. / number in the path name. FF_VOLUME_STRS defines the volume ID strings for each
  137. / logical drives. Number of items must not be less than FF_VOLUMES. Valid
  138. / characters for the volume ID strings are A-Z, a-z and 0-9, however, they are
  139. / compared in case-insensitive. If FF_STR_VOLUME_ID >= 1 and FF_VOLUME_STRS is
  140. / not defined, a user defined volume string table needs to be defined as:
  141. /
  142. / const char* VolumeStr[FF_VOLUMES] = {"ram","flash","sd","usb",...
  143. */
  144. #define FF_MULTI_PARTITION 1
  145. /* This option switches support for multiple volumes on the physical drive.
  146. / By default (0), each logical drive number is bound to the same physical drive
  147. / number and only an FAT volume found on the physical drive will be mounted.
  148. / When this function is enabled (1), each logical drive number can be bound to
  149. / arbitrary physical drive and partition listed in the VolToPart[]. Also f_fdisk()
  150. / funciton will be available. */
  151. #define FF_MIN_SS 512
  152. #define FF_MAX_SS 512
  153. /* This set of options configures the range of sector size to be supported. (512,
  154. / 1024, 2048 or 4096) Always set both 512 for most systems, generic memory card and
  155. / harddisk. But a larger value may be required for on-board flash memory and some
  156. / type of optical media. When FF_MAX_SS is larger than FF_MIN_SS, FatFs is configured
  157. / for variable sector size mode and disk_ioctl() function needs to implement
  158. / GET_SECTOR_SIZE command. */
  159. #define FF_USE_TRIM 0
  160. /* This option switches support for ATA-TRIM. (0:Disable or 1:Enable)
  161. / To enable Trim function, also CTRL_TRIM command should be implemented to the
  162. / disk_ioctl() function. */
  163. #define FF_FS_NOFSINFO 0
  164. /* If you need to know correct free space on the FAT32 volume, set bit 0 of this
  165. / option, and f_getfree() function at first time after volume mount will force
  166. / a full FAT scan. Bit 1 controls the use of last allocated cluster number.
  167. /
  168. / bit0=0: Use free cluster count in the FSINFO if available.
  169. / bit0=1: Do not trust free cluster count in the FSINFO.
  170. / bit1=0: Use last allocated cluster number in the FSINFO if available.
  171. / bit1=1: Do not trust last allocated cluster number in the FSINFO.
  172. */
  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 0
  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 2018
  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 at read-only configuration (FF_FS_READONLY = 1). */
  197. #define FF_FS_LOCK 0
  198. /* The option FF_FS_LOCK switches file lock function to control duplicated file open
  199. / and illegal operation to open objects. This option must be 0 when FF_FS_READONLY
  200. / is 1.
  201. /
  202. / 0: Disable file lock function. To avoid volume corruption, application program
  203. / should avoid illegal open, remove and rename to the open objects.
  204. / >0: Enable file lock function. The value defines how many files/sub-directories
  205. / can be opened simultaneously under file lock control. Note that the file
  206. / lock control is independent of re-entrancy. */
  207. /* #include <somertos.h> // O/S definitions */
  208. #define FF_FS_REENTRANT 0
  209. #define FF_FS_TIMEOUT 1000
  210. #define FF_SYNC_t HANDLE
  211. /* The option FF_FS_REENTRANT switches the re-entrancy (thread safe) of the FatFs
  212. / module itself. Note that regardless of this option, file access to different
  213. / volume is always re-entrant and volume control functions, f_mount(), f_mkfs()
  214. / and f_fdisk() function, are always not re-entrant. Only file/directory access
  215. / to the same volume is under control of this function.
  216. /
  217. / 0: Disable re-entrancy. FF_FS_TIMEOUT and FF_SYNC_t have no effect.
  218. / 1: Enable re-entrancy. Also user provided synchronization handlers,
  219. / ff_req_grant(), ff_rel_grant(), ff_del_syncobj() and ff_cre_syncobj()
  220. / function, must be added to the project. Samples are available in
  221. / option/syscall.c.
  222. /
  223. / The FF_FS_TIMEOUT defines timeout period in unit of time tick.
  224. / The FF_SYNC_t defines O/S dependent sync object type. e.g. HANDLE, ID, OS_EVENT*,
  225. / SemaphoreHandle_t and etc. A header file for O/S definitions needs to be
  226. / included somewhere in the scope of ff.h. */
  227. /*--- End of configuration options ---*/