fatfs/source/ffconf.h

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