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