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