Jordan Beason / FATDirHandle1

Final

ffconf.h@0:e126ae11d20b, 2019-11-06 (annotated)

Committer:
jbeason3
Date:
Wed Nov 06 04:53:44 2019 +0000
Revision:
0:e126ae11d20b
Final

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jbeason3 0:e126ae11d20b 1 /*---------------------------------------------------------------------------/
jbeason3 0:e126ae11d20b 2 / FatFs - FAT file system module configuration file R0.11a (C)ChaN, 2015
jbeason3 0:e126ae11d20b 3 /---------------------------------------------------------------------------*/
jbeason3 0:e126ae11d20b 4
jbeason3 0:e126ae11d20b 5 #define _FFCONF 64180 /* Revision ID */
jbeason3 0:e126ae11d20b 6
jbeason3 0:e126ae11d20b 7 #define FFS_DBG 0
jbeason3 0:e126ae11d20b 8
jbeason3 0:e126ae11d20b 9 /*---------------------------------------------------------------------------/
jbeason3 0:e126ae11d20b 10 / Function Configurations
jbeason3 0:e126ae11d20b 11 /---------------------------------------------------------------------------*/
jbeason3 0:e126ae11d20b 12
jbeason3 0:e126ae11d20b 13 #define _FS_READONLY 0
jbeason3 0:e126ae11d20b 14 /* This option switches read-only configuration. (0:Read/Write or 1:Read-only)
jbeason3 0:e126ae11d20b 15 / Read-only configuration removes writing API functions, f_write(), f_sync(),
jbeason3 0:e126ae11d20b 16 / f_unlink(), f_mkdir(), f_chmod(), f_rename(), f_truncate(), f_getfree()
jbeason3 0:e126ae11d20b 17 / and optional writing functions as well. */
jbeason3 0:e126ae11d20b 18
jbeason3 0:e126ae11d20b 19
jbeason3 0:e126ae11d20b 20 #define _FS_MINIMIZE 0
jbeason3 0:e126ae11d20b 21 /* This option defines minimization level to remove some basic API functions.
jbeason3 0:e126ae11d20b 22 /
jbeason3 0:e126ae11d20b 23 / 0: All basic functions are enabled.
jbeason3 0:e126ae11d20b 24 / 1: f_stat(), f_getfree(), f_unlink(), f_mkdir(), f_chmod(), f_utime(),
jbeason3 0:e126ae11d20b 25 / f_truncate() and f_rename() function are removed.
jbeason3 0:e126ae11d20b 26 / 2: f_opendir(), f_readdir() and f_closedir() are removed in addition to 1.
jbeason3 0:e126ae11d20b 27 / 3: f_lseek() function is removed in addition to 2. */
jbeason3 0:e126ae11d20b 28
jbeason3 0:e126ae11d20b 29
jbeason3 0:e126ae11d20b 30 #define _USE_STRFUNC 0
jbeason3 0:e126ae11d20b 31 /* This option switches string functions, f_gets(), f_putc(), f_puts() and
jbeason3 0:e126ae11d20b 32 / f_printf().
jbeason3 0:e126ae11d20b 33 /
jbeason3 0:e126ae11d20b 34 / 0: Disable string functions.
jbeason3 0:e126ae11d20b 35 / 1: Enable without LF-CRLF conversion.
jbeason3 0:e126ae11d20b 36 / 2: Enable with LF-CRLF conversion. */
jbeason3 0:e126ae11d20b 37
jbeason3 0:e126ae11d20b 38
jbeason3 0:e126ae11d20b 39 #define _USE_FIND 0
jbeason3 0:e126ae11d20b 40 /* This option switches filtered directory read feature and related functions,
jbeason3 0:e126ae11d20b 41 / f_findfirst() and f_findnext(). (0:Disable or 1:Enable) */
jbeason3 0:e126ae11d20b 42
jbeason3 0:e126ae11d20b 43
jbeason3 0:e126ae11d20b 44 #define _USE_MKFS 1
jbeason3 0:e126ae11d20b 45 /* This option switches f_mkfs() function. (0:Disable or 1:Enable) */
jbeason3 0:e126ae11d20b 46
jbeason3 0:e126ae11d20b 47
jbeason3 0:e126ae11d20b 48 #define _USE_FASTSEEK 0
jbeason3 0:e126ae11d20b 49 /* This option switches fast seek feature. (0:Disable or 1:Enable) */
jbeason3 0:e126ae11d20b 50
jbeason3 0:e126ae11d20b 51
jbeason3 0:e126ae11d20b 52 #define _USE_LABEL 0
jbeason3 0:e126ae11d20b 53 /* This option switches volume label functions, f_getlabel() and f_setlabel().
jbeason3 0:e126ae11d20b 54 / (0:Disable or 1:Enable) */
jbeason3 0:e126ae11d20b 55
jbeason3 0:e126ae11d20b 56
jbeason3 0:e126ae11d20b 57 #define _USE_FORWARD 0
jbeason3 0:e126ae11d20b 58 /* This option switches f_forward() function. (0:Disable or 1:Enable)
jbeason3 0:e126ae11d20b 59 / To enable it, also _FS_TINY need to be set to 1. */
jbeason3 0:e126ae11d20b 60
jbeason3 0:e126ae11d20b 61
jbeason3 0:e126ae11d20b 62 /*---------------------------------------------------------------------------/
jbeason3 0:e126ae11d20b 63 / Locale and Namespace Configurations
jbeason3 0:e126ae11d20b 64 /---------------------------------------------------------------------------*/
jbeason3 0:e126ae11d20b 65
jbeason3 0:e126ae11d20b 66 #define _CODE_PAGE 850
jbeason3 0:e126ae11d20b 67 /* This option specifies the OEM code page to be used on the target system.
jbeason3 0:e126ae11d20b 68 / Incorrect setting of the code page can cause a file open failure.
jbeason3 0:e126ae11d20b 69 /
jbeason3 0:e126ae11d20b 70 / 1 - ASCII (No extended character. Non-LFN cfg. only)
jbeason3 0:e126ae11d20b 71 / 437 - U.S.
jbeason3 0:e126ae11d20b 72 / 720 - Arabic
jbeason3 0:e126ae11d20b 73 / 737 - Greek
jbeason3 0:e126ae11d20b 74 / 771 - KBL
jbeason3 0:e126ae11d20b 75 / 775 - Baltic
jbeason3 0:e126ae11d20b 76 / 850 - Latin 1
jbeason3 0:e126ae11d20b 77 / 852 - Latin 2
jbeason3 0:e126ae11d20b 78 / 855 - Cyrillic
jbeason3 0:e126ae11d20b 79 / 857 - Turkish
jbeason3 0:e126ae11d20b 80 / 860 - Portuguese
jbeason3 0:e126ae11d20b 81 / 861 - Icelandic
jbeason3 0:e126ae11d20b 82 / 862 - Hebrew
jbeason3 0:e126ae11d20b 83 / 863 - Canadian French
jbeason3 0:e126ae11d20b 84 / 864 - Arabic
jbeason3 0:e126ae11d20b 85 / 865 - Nordic
jbeason3 0:e126ae11d20b 86 / 866 - Russian
jbeason3 0:e126ae11d20b 87 / 869 - Greek 2
jbeason3 0:e126ae11d20b 88 / 932 - Japanese (DBCS)
jbeason3 0:e126ae11d20b 89 / 936 - Simplified Chinese (DBCS)
jbeason3 0:e126ae11d20b 90 / 949 - Korean (DBCS)
jbeason3 0:e126ae11d20b 91 / 950 - Traditional Chinese (DBCS)
jbeason3 0:e126ae11d20b 92 */
jbeason3 0:e126ae11d20b 93
jbeason3 0:e126ae11d20b 94
jbeason3 0:e126ae11d20b 95 #define _USE_LFN 1
jbeason3 0:e126ae11d20b 96 #define _MAX_LFN 255
jbeason3 0:e126ae11d20b 97 /* The _USE_LFN option switches the LFN feature.
jbeason3 0:e126ae11d20b 98 /
jbeason3 0:e126ae11d20b 99 / 0: Disable LFN feature. _MAX_LFN has no effect.
jbeason3 0:e126ae11d20b 100 / 1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe.
jbeason3 0:e126ae11d20b 101 / 2: Enable LFN with dynamic working buffer on the STACK.
jbeason3 0:e126ae11d20b 102 / 3: Enable LFN with dynamic working buffer on the HEAP.
jbeason3 0:e126ae11d20b 103 /
jbeason3 0:e126ae11d20b 104 / When enable the LFN feature, Unicode handling functions (option/unicode.c) must
jbeason3 0:e126ae11d20b 105 / be added to the project. The LFN working buffer occupies (_MAX_LFN + 1) * 2 bytes.
jbeason3 0:e126ae11d20b 106 / When use stack for the working buffer, take care on stack overflow. When use heap
jbeason3 0:e126ae11d20b 107 / memory for the working buffer, memory management functions, ff_memalloc() and
jbeason3 0:e126ae11d20b 108 / ff_memfree(), must be added to the project. */
jbeason3 0:e126ae11d20b 109
jbeason3 0:e126ae11d20b 110
jbeason3 0:e126ae11d20b 111 #define _LFN_UNICODE 0
jbeason3 0:e126ae11d20b 112 /* This option switches character encoding on the API. (0:ANSI/OEM or 1:Unicode)
jbeason3 0:e126ae11d20b 113 / To use Unicode string for the path name, enable LFN feature and set _LFN_UNICODE
jbeason3 0:e126ae11d20b 114 / to 1. This option also affects behavior of string I/O functions. */
jbeason3 0:e126ae11d20b 115
jbeason3 0:e126ae11d20b 116
jbeason3 0:e126ae11d20b 117 #define _STRF_ENCODE 3
jbeason3 0:e126ae11d20b 118 /* When _LFN_UNICODE is 1, this option selects the character encoding on the file to
jbeason3 0:e126ae11d20b 119 / be read/written via string I/O functions, f_gets(), f_putc(), f_puts and f_printf().
jbeason3 0:e126ae11d20b 120 /
jbeason3 0:e126ae11d20b 121 / 0: ANSI/OEM
jbeason3 0:e126ae11d20b 122 / 1: UTF-16LE
jbeason3 0:e126ae11d20b 123 / 2: UTF-16BE
jbeason3 0:e126ae11d20b 124 / 3: UTF-8
jbeason3 0:e126ae11d20b 125 /
jbeason3 0:e126ae11d20b 126 / When _LFN_UNICODE is 0, this option has no effect. */
jbeason3 0:e126ae11d20b 127
jbeason3 0:e126ae11d20b 128
jbeason3 0:e126ae11d20b 129 #define _FS_RPATH 0
jbeason3 0:e126ae11d20b 130 /* This option configures relative path feature.
jbeason3 0:e126ae11d20b 131 /
jbeason3 0:e126ae11d20b 132 / 0: Disable relative path feature and remove related functions.
jbeason3 0:e126ae11d20b 133 / 1: Enable relative path feature. f_chdir() and f_chdrive() are available.
jbeason3 0:e126ae11d20b 134 / 2: f_getcwd() function is available in addition to 1.
jbeason3 0:e126ae11d20b 135 /
jbeason3 0:e126ae11d20b 136 / Note that directory items read via f_readdir() are affected by this option. */
jbeason3 0:e126ae11d20b 137
jbeason3 0:e126ae11d20b 138
jbeason3 0:e126ae11d20b 139 /*---------------------------------------------------------------------------/
jbeason3 0:e126ae11d20b 140 / Drive/Volume Configurations
jbeason3 0:e126ae11d20b 141 /---------------------------------------------------------------------------*/
jbeason3 0:e126ae11d20b 142
jbeason3 0:e126ae11d20b 143 #define _VOLUMES 1
jbeason3 0:e126ae11d20b 144 /* Number of volumes (logical drives) to be used. */
jbeason3 0:e126ae11d20b 145
jbeason3 0:e126ae11d20b 146
jbeason3 0:e126ae11d20b 147 #define _STR_VOLUME_ID 0
jbeason3 0:e126ae11d20b 148 #define _VOLUME_STRS "RAM","NAND","CF","SD1","SD2","USB1","USB2","USB3"
jbeason3 0:e126ae11d20b 149 /* _STR_VOLUME_ID option switches string volume ID feature.
jbeason3 0:e126ae11d20b 150 / When _STR_VOLUME_ID is set to 1, also pre-defined strings can be used as drive
jbeason3 0:e126ae11d20b 151 / number in the path name. _VOLUME_STRS defines the drive ID strings for each
jbeason3 0:e126ae11d20b 152 / logical drives. Number of items must be equal to _VOLUMES. Valid characters for
jbeason3 0:e126ae11d20b 153 / the drive ID strings are: A-Z and 0-9. */
jbeason3 0:e126ae11d20b 154
jbeason3 0:e126ae11d20b 155
jbeason3 0:e126ae11d20b 156 #define _MULTI_PARTITION 0
jbeason3 0:e126ae11d20b 157 /* This option switches multi-partition feature. By default (0), each logical drive
jbeason3 0:e126ae11d20b 158 / number is bound to the same physical drive number and only an FAT volume found on
jbeason3 0:e126ae11d20b 159 / the physical drive will be mounted. When multi-partition feature is enabled (1),
jbeason3 0:e126ae11d20b 160 / each logical drive number is bound to arbitrary physical drive and partition
jbeason3 0:e126ae11d20b 161 / listed in the VolToPart[]. Also f_fdisk() funciton will be available. */
jbeason3 0:e126ae11d20b 162
jbeason3 0:e126ae11d20b 163
jbeason3 0:e126ae11d20b 164 #define _MIN_SS 512
jbeason3 0:e126ae11d20b 165 #define _MAX_SS 512
jbeason3 0:e126ae11d20b 166 /* These options configure the range of sector size to be supported. (512, 1024,
jbeason3 0:e126ae11d20b 167 / 2048 or 4096) Always set both 512 for most systems, all type of memory cards and
jbeason3 0:e126ae11d20b 168 / harddisk. But a larger value may be required for on-board flash memory and some
jbeason3 0:e126ae11d20b 169 / type of optical media. When _MAX_SS is larger than _MIN_SS, FatFs is configured
jbeason3 0:e126ae11d20b 170 / to variable sector size and GET_SECTOR_SIZE command must be implemented to the
jbeason3 0:e126ae11d20b 171 / disk_ioctl() function. */
jbeason3 0:e126ae11d20b 172
jbeason3 0:e126ae11d20b 173
jbeason3 0:e126ae11d20b 174 #define _USE_TRIM 0
jbeason3 0:e126ae11d20b 175 /* This option switches ATA-TRIM feature. (0:Disable or 1:Enable)
jbeason3 0:e126ae11d20b 176 / To enable Trim feature, also CTRL_TRIM command should be implemented to the
jbeason3 0:e126ae11d20b 177 / disk_ioctl() function. */
jbeason3 0:e126ae11d20b 178
jbeason3 0:e126ae11d20b 179
jbeason3 0:e126ae11d20b 180 #define _FS_NOFSINFO 0
jbeason3 0:e126ae11d20b 181 /* If you need to know correct free space on the FAT32 volume, set bit 0 of this
jbeason3 0:e126ae11d20b 182 / option, and f_getfree() function at first time after volume mount will force
jbeason3 0:e126ae11d20b 183 / a full FAT scan. Bit 1 controls the use of last allocated cluster number.
jbeason3 0:e126ae11d20b 184 /
jbeason3 0:e126ae11d20b 185 / bit0=0: Use free cluster count in the FSINFO if available.
jbeason3 0:e126ae11d20b 186 / bit0=1: Do not trust free cluster count in the FSINFO.
jbeason3 0:e126ae11d20b 187 / bit1=0: Use last allocated cluster number in the FSINFO if available.
jbeason3 0:e126ae11d20b 188 / bit1=1: Do not trust last allocated cluster number in the FSINFO.
jbeason3 0:e126ae11d20b 189 */
jbeason3 0:e126ae11d20b 190
jbeason3 0:e126ae11d20b 191
jbeason3 0:e126ae11d20b 192
jbeason3 0:e126ae11d20b 193 /*---------------------------------------------------------------------------/
jbeason3 0:e126ae11d20b 194 / System Configurations
jbeason3 0:e126ae11d20b 195 /---------------------------------------------------------------------------*/
jbeason3 0:e126ae11d20b 196
jbeason3 0:e126ae11d20b 197 #define _FS_TINY 0
jbeason3 0:e126ae11d20b 198 /* This option switches tiny buffer configuration. (0:Normal or 1:Tiny)
jbeason3 0:e126ae11d20b 199 / At the tiny configuration, size of the file object (FIL) is reduced _MAX_SS
jbeason3 0:e126ae11d20b 200 / bytes. Instead of private sector buffer eliminated from the file object,
jbeason3 0:e126ae11d20b 201 / common sector buffer in the file system object (FATFS) is used for the file
jbeason3 0:e126ae11d20b 202 / data transfer. */
jbeason3 0:e126ae11d20b 203
jbeason3 0:e126ae11d20b 204
jbeason3 0:e126ae11d20b 205 #define _FS_NORTC 0
jbeason3 0:e126ae11d20b 206 #define _NORTC_MON 1
jbeason3 0:e126ae11d20b 207 #define _NORTC_MDAY 1
jbeason3 0:e126ae11d20b 208 #define _NORTC_YEAR 2015
jbeason3 0:e126ae11d20b 209 /* The _FS_NORTC option switches timestamp feature. If the system does not have
jbeason3 0:e126ae11d20b 210 / an RTC function or valid timestamp is not needed, set _FS_NORTC to 1 to disable
jbeason3 0:e126ae11d20b 211 / the timestamp feature. All objects modified by FatFs will have a fixed timestamp
jbeason3 0:e126ae11d20b 212 / defined by _NORTC_MON, _NORTC_MDAY and _NORTC_YEAR.
jbeason3 0:e126ae11d20b 213 / When timestamp feature is enabled (_FS_NORTC == 0), get_fattime() function need
jbeason3 0:e126ae11d20b 214 / to be added to the project to read current time form RTC. _NORTC_MON,
jbeason3 0:e126ae11d20b 215 / _NORTC_MDAY and _NORTC_YEAR have no effect.
jbeason3 0:e126ae11d20b 216 / These options have no effect at read-only configuration (_FS_READONLY == 1). */
jbeason3 0:e126ae11d20b 217
jbeason3 0:e126ae11d20b 218
jbeason3 0:e126ae11d20b 219 #define _FS_LOCK 0
jbeason3 0:e126ae11d20b 220 /* The _FS_LOCK option switches file lock feature to control duplicated file open
jbeason3 0:e126ae11d20b 221 / and illegal operation to open objects. This option must be 0 when _FS_READONLY
jbeason3 0:e126ae11d20b 222 / is 1.
jbeason3 0:e126ae11d20b 223 /
jbeason3 0:e126ae11d20b 224 / 0: Disable file lock feature. To avoid volume corruption, application program
jbeason3 0:e126ae11d20b 225 / should avoid illegal open, remove and rename to the open objects.
jbeason3 0:e126ae11d20b 226 / >0: Enable file lock feature. The value defines how many files/sub-directories
jbeason3 0:e126ae11d20b 227 / can be opened simultaneously under file lock control. Note that the file
jbeason3 0:e126ae11d20b 228 / lock feature is independent of re-entrancy. */
jbeason3 0:e126ae11d20b 229
jbeason3 0:e126ae11d20b 230
jbeason3 0:e126ae11d20b 231 #define _FS_REENTRANT 0
jbeason3 0:e126ae11d20b 232 #define _FS_TIMEOUT 1000
jbeason3 0:e126ae11d20b 233 #define _SYNC_t HANDLE
jbeason3 0:e126ae11d20b 234 /* The _FS_REENTRANT option switches the re-entrancy (thread safe) of the FatFs
jbeason3 0:e126ae11d20b 235 / module itself. Note that regardless of this option, file access to different
jbeason3 0:e126ae11d20b 236 / volume is always re-entrant and volume control functions, f_mount(), f_mkfs()
jbeason3 0:e126ae11d20b 237 / and f_fdisk() function, are always not re-entrant. Only file/directory access
jbeason3 0:e126ae11d20b 238 / to the same volume is under control of this feature.
jbeason3 0:e126ae11d20b 239 /
jbeason3 0:e126ae11d20b 240 / 0: Disable re-entrancy. _FS_TIMEOUT and _SYNC_t have no effect.
jbeason3 0:e126ae11d20b 241 / 1: Enable re-entrancy. Also user provided synchronization handlers,
jbeason3 0:e126ae11d20b 242 / ff_req_grant(), ff_rel_grant(), ff_del_syncobj() and ff_cre_syncobj()
jbeason3 0:e126ae11d20b 243 / function, must be added to the project. Samples are available in
jbeason3 0:e126ae11d20b 244 / option/syscall.c.
jbeason3 0:e126ae11d20b 245 /
jbeason3 0:e126ae11d20b 246 / The _FS_TIMEOUT defines timeout period in unit of time tick.
jbeason3 0:e126ae11d20b 247 / The _SYNC_t defines O/S dependent sync object type. e.g. HANDLE, ID, OS_EVENT*,
jbeason3 0:e126ae11d20b 248 / SemaphoreHandle_t and etc.. A header file for O/S definitions needs to be
jbeason3 0:e126ae11d20b 249 / included somewhere in the scope of ff.c. */
jbeason3 0:e126ae11d20b 250
jbeason3 0:e126ae11d20b 251
jbeason3 0:e126ae11d20b 252 #define _WORD_ACCESS 0
jbeason3 0:e126ae11d20b 253 /* The _WORD_ACCESS option is an only platform dependent option. It defines
jbeason3 0:e126ae11d20b 254 / which access method is used to the word data on the FAT volume.
jbeason3 0:e126ae11d20b 255 /
jbeason3 0:e126ae11d20b 256 / 0: Byte-by-byte access. Always compatible with all platforms.
jbeason3 0:e126ae11d20b 257 / 1: Word access. Do not choose this unless under both the following conditions.
jbeason3 0:e126ae11d20b 258 /
jbeason3 0:e126ae11d20b 259 / * Address misaligned memory access is always allowed to ALL instructions.
jbeason3 0:e126ae11d20b 260 / * Byte order on the memory is little-endian.
jbeason3 0:e126ae11d20b 261 /
jbeason3 0:e126ae11d20b 262 / If it is the case, _WORD_ACCESS can also be set to 1 to reduce code size.
jbeason3 0:e126ae11d20b 263 / Following table shows allowable settings of some type of processors.
jbeason3 0:e126ae11d20b 264 /
jbeason3 0:e126ae11d20b 265 / ARM7TDMI 0 *2 ColdFire 0 *1 V850E 0 *2
jbeason3 0:e126ae11d20b 266 / Cortex-M3 0 *3 Z80 0/1 V850ES 0/1
jbeason3 0:e126ae11d20b 267 / Cortex-M0 0 *2 x86 0/1 TLCS-870 0/1
jbeason3 0:e126ae11d20b 268 / AVR 0/1 RX600(LE) 0/1 TLCS-900 0/1
jbeason3 0:e126ae11d20b 269 / AVR32 0 *1 RL78 0 *2 R32C 0 *2
jbeason3 0:e126ae11d20b 270 / PIC18 0/1 SH-2 0 *1 M16C 0/1
jbeason3 0:e126ae11d20b 271 / PIC24 0 *2 H8S 0 *1 MSP430 0 *2
jbeason3 0:e126ae11d20b 272 / PIC32 0 *1 H8/300H 0 *1 8051 0/1
jbeason3 0:e126ae11d20b 273 /
jbeason3 0:e126ae11d20b 274 / *1:Big-endian.
jbeason3 0:e126ae11d20b 275 / *2:Unaligned memory access is not supported.
jbeason3 0:e126ae11d20b 276 / *3:Some compilers generate LDM/STM for mem_cpy function.
jbeason3 0:e126ae11d20b 277 */
jbeason3 0:e126ae11d20b 278
jbeason3 0:e126ae11d20b 279 #define FLUSH_ON_NEW_CLUSTER 0 /* Sync the file on every new cluster */
jbeason3 0:e126ae11d20b 280 #define FLUSH_ON_NEW_SECTOR 1 /* Sync the file on every new sector */
jbeason3 0:e126ae11d20b 281 /* Only one of these two defines needs to be set to 1. If both are set to 0
jbeason3 0:e126ae11d20b 282 the file is only sync when closed.
jbeason3 0:e126ae11d20b 283 Clusters are group of sectors (eg: 8 sectors). Flushing on new cluster means
jbeason3 0:e126ae11d20b 284 it would be less often than flushing on new sector. Sectors are generally
jbeason3 0:e126ae11d20b 285 512 Bytes long. */