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