Vladimir Nemera / FATFileSystem

microCD

Fork of FATFileSystem by mbed official

ChaN/ffconf.h@10:e2ab678eb692, 2016-07-30 (annotated)

Committer:
p3p
Date:
Sat Jul 30 20:47:51 2016 +0000
Revision:
10:e2ab678eb692
Parent:
6:a5fcdbf92056
Child:
8:0345cdc7efa5
_name is now private, use supplied getter

Who changed what in which revision?

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