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