Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
CTCaer
GitHub Repository: CTCaer/hekate
Path: blob/master/bdk/fatfs_conf.h
1471 views
1
/*---------------------------------------------------------------------------/
2
/ FatFs Functional Configurations
3
/---------------------------------------------------------------------------*/
4
5
#define FFCONF_DEF 86604 /* 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_STRFUNC 2
29
/* This option switches string functions, f_gets(), f_putc(), f_puts() and f_printf().
30
/
31
/ 0: Disable string functions.
32
/ 1: Enable without LF-CRLF conversion.
33
/ 2: Enable with LF-CRLF conversion. */
34
35
36
#define FF_USE_FIND 1
37
/* This option switches filtered directory read functions, f_findfirst() and
38
/ f_findnext(). (0:Disable, 1:Enable 2:Enable with matching altname[] too) */
39
40
41
#define FF_USE_MKFS 0
42
/* This option switches f_mkfs() function. (0:Disable or 1:Enable) */
43
44
#if FF_USE_MKFS
45
#define FF_MKFS_LABEL "SWITCH SD "
46
#endif
47
/* This sets FAT/FAT32 label. Exactly 11 characters, all caps. */
48
49
50
#define FF_USE_FASTSEEK 0
51
/* This option switches fast seek function. (0:Disable or 1:Enable) */
52
53
#define FF_FASTFS 0
54
#if FF_FASTFS
55
#undef FF_USE_FASTSEEK
56
#define FF_USE_FASTSEEK 1
57
#endif
58
/* This option switches fast access to chained clusters. (0:Disable or 1:Enable) */
59
60
61
#define FF_SIMPLE_GPT 1
62
/* This option switches support for the first GPT partition. (0:Disable or 1:Enable) */
63
64
65
#define FF_USE_EXPAND 0
66
/* This option switches f_expand function. (0:Disable or 1:Enable) */
67
68
69
#define FF_USE_CHMOD 1
70
/* This option switches attribute manipulation functions, f_chmod() and f_utime().
71
/ (0:Disable or 1:Enable) Also FF_FS_READONLY needs to be 0 to enable this option. */
72
73
74
#define FF_USE_LABEL 0
75
/* This option switches volume label functions, f_getlabel() and f_setlabel().
76
/ (0:Disable or 1:Enable) */
77
78
79
#define FF_USE_FORWARD 0
80
/* This option switches f_forward() function. (0:Disable or 1:Enable) */
81
82
83
/*---------------------------------------------------------------------------/
84
/ Locale and Namespace Configurations
85
/---------------------------------------------------------------------------*/
86
87
#define FF_CODE_PAGE 850
88
/* This option specifies the OEM code page to be used on the target system.
89
/ Incorrect code page setting can cause a file open failure.
90
/
91
/ 437 - U.S.
92
/ 720 - Arabic
93
/ 737 - Greek
94
/ 771 - KBL
95
/ 775 - Baltic
96
/ 850 - Latin 1
97
/ 852 - Latin 2
98
/ 855 - Cyrillic
99
/ 857 - Turkish
100
/ 860 - Portuguese
101
/ 861 - Icelandic
102
/ 862 - Hebrew
103
/ 863 - Canadian French
104
/ 864 - Arabic
105
/ 865 - Nordic
106
/ 866 - Russian
107
/ 869 - Greek 2
108
/ 932 - Japanese (DBCS)
109
/ 936 - Simplified Chinese (DBCS)
110
/ 949 - Korean (DBCS)
111
/ 950 - Traditional Chinese (DBCS)
112
/ 0 - Include all code pages above and configured by f_setcp()
113
*/
114
115
116
#define FF_USE_LFN 3
117
#define FF_MAX_LFN 255
118
/* The FF_USE_LFN switches the support for LFN (long file name).
119
/
120
/ 0: Disable LFN. FF_MAX_LFN has no effect.
121
/ 1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe.
122
/ 2: Enable LFN with dynamic working buffer on the STACK.
123
/ 3: Enable LFN with dynamic working buffer on the HEAP.
124
/
125
/ To enable the LFN, ffunicode.c needs to be added to the project. The LFN function
126
/ requiers certain internal working buffer occupies (FF_MAX_LFN + 1) * 2 bytes and
127
/ additional (FF_MAX_LFN + 44) / 15 * 32 bytes when exFAT is enabled.
128
/ The FF_MAX_LFN defines size of the working buffer in UTF-16 code unit and it can
129
/ be in range of 12 to 255. It is recommended to be set 255 to fully support LFN
130
/ specification.
131
/ When use stack for the working buffer, take care on stack overflow. When use heap
132
/ memory for the working buffer, memory management functions, ff_memalloc() and
133
/ ff_memfree() in ffsystem.c, need to be added to the project. */
134
135
136
#define FF_LFN_UNICODE 0
137
/* This option switches the character encoding on the API when LFN is enabled.
138
/
139
/ 0: ANSI/OEM in current CP (TCHAR = char)
140
/ 1: Unicode in UTF-16 (TCHAR = WCHAR)
141
/ 2: Unicode in UTF-8 (TCHAR = char)
142
/ 3: Unicode in UTF-32 (TCHAR = DWORD)
143
/
144
/ Also behavior of string I/O functions will be affected by this option.
145
/ When LFN is not enabled, this option has no effect. */
146
147
148
#define FF_LFN_BUF 255
149
#define FF_SFN_BUF 12
150
/* This set of options defines size of file name members in the FILINFO structure
151
/ which is used to read out directory items. These values should be suffcient for
152
/ the file names to read. The maximum possible length of the read file name depends
153
/ on character encoding. When LFN is not enabled, these options have no effect. */
154
155
156
#define FF_STRF_ENCODE 0
157
/* When FF_LFN_UNICODE >= 1 with LFN enabled, string I/O functions, f_gets(),
158
/ f_putc(), f_puts and f_printf() convert the character encoding in it.
159
/ This option selects assumption of character encoding ON THE FILE to be
160
/ read/written via those functions.
161
/
162
/ 0: ANSI/OEM in current CP
163
/ 1: Unicode in UTF-16LE
164
/ 2: Unicode in UTF-16BE
165
/ 3: Unicode in UTF-8
166
*/
167
168
169
#define FF_FS_RPATH 0
170
/* This option configures support for relative path.
171
/
172
/ 0: Disable relative path and remove related functions.
173
/ 1: Enable relative path. f_chdir() and f_chdrive() are available.
174
/ 2: f_getcwd() function is available in addition to 1.
175
*/
176
177
178
/*---------------------------------------------------------------------------/
179
/ Drive/Volume Configurations
180
/---------------------------------------------------------------------------*/
181
182
#define FF_VOLUMES 1
183
/* Number of volumes (logical drives) to be used. (1-10) */
184
185
186
#define FF_STR_VOLUME_ID 0
187
#define FF_VOLUME_STRS "sd"
188
/* FF_STR_VOLUME_ID switches support for volume ID in arbitrary strings.
189
/ When FF_STR_VOLUME_ID is set to 1 or 2, arbitrary strings can be used as drive
190
/ number in the path name. FF_VOLUME_STRS defines the volume ID strings for each
191
/ logical drives. Number of items must not be less than FF_VOLUMES. Valid
192
/ characters for the volume ID strings are A-Z, a-z and 0-9, however, they are
193
/ compared in case-insensitive. If FF_STR_VOLUME_ID >= 1 and FF_VOLUME_STRS is
194
/ not defined, a user defined volume string table needs to be defined as:
195
/
196
/ const char* VolumeStr[FF_VOLUMES] = {"ram","flash","sd","usb",...
197
/ Order is important. Any change to order, must also be reflected to diskio drive enum.
198
*/
199
200
201
#define FF_MULTI_PARTITION 0
202
/* This option switches support for multiple volumes on the physical drive.
203
/ By default (0), each logical drive number is bound to the same physical drive
204
/ number and only an FAT volume found on the physical drive will be mounted.
205
/ When this function is enabled (1), each logical drive number can be bound to
206
/ arbitrary physical drive and partition listed in the VolToPart[]. Also f_fdisk()
207
/ funciton will be available. */
208
209
210
#define FF_MIN_SS 512
211
#define FF_MAX_SS 512
212
/* This set of options configures the range of sector size to be supported. (512,
213
/ 1024, 2048 or 4096) Always set both 512 for most systems, generic memory card and
214
/ harddisk. But a larger value may be required for on-board flash memory and some
215
/ type of optical media. When FF_MAX_SS is larger than FF_MIN_SS, FatFs is configured
216
/ for variable sector size mode and disk_ioctl() function needs to implement
217
/ GET_SECTOR_SIZE command. */
218
219
220
#define FF_USE_TRIM 0
221
/* This option switches support for ATA-TRIM. (0:Disable or 1:Enable)
222
/ To enable Trim function, also CTRL_TRIM command should be implemented to the
223
/ disk_ioctl() function. */
224
225
226
#define FF_FS_NOFSINFO 1
227
/* If you need to know correct free space on the FAT32 volume, set bit 0 of this
228
/ option, and f_getfree() function at first time after volume mount will force
229
/ a full FAT scan. Bit 1 controls the use of last allocated cluster number.
230
/
231
/ bit0=0: Use free cluster count in the FSINFO if available.
232
/ bit0=1: Do not trust free cluster count in the FSINFO.
233
/ bit1=0: Use last allocated cluster number in the FSINFO if available.
234
/ bit1=1: Do not trust last allocated cluster number in the FSINFO.
235
*/
236
237
238
239
/*---------------------------------------------------------------------------/
240
/ System Configurations
241
/---------------------------------------------------------------------------*/
242
243
#define FF_FS_TINY 0
244
/* This option switches tiny buffer configuration. (0:Normal or 1:Tiny)
245
/ At the tiny configuration, size of file object (FIL) is shrinked FF_MAX_SS bytes.
246
/ Instead of private sector buffer eliminated from the file object, common sector
247
/ buffer in the filesystem object (FATFS) is used for the file data transfer. */
248
249
250
#define FF_FS_EXFAT 1
251
/* This option switches support for exFAT filesystem. (0:Disable or 1:Enable)
252
/ To enable exFAT, also LFN needs to be enabled. (FF_USE_LFN >= 1)
253
/ Note that enabling exFAT discards ANSI C (C89) compatibility. */
254
255
256
#define FF_FS_NORTC 1
257
#define FF_NORTC_MON 1
258
#define FF_NORTC_MDAY 1
259
#define FF_NORTC_YEAR 2022
260
/* The option FF_FS_NORTC switches timestamp function. If the system does not have
261
/ any RTC function or valid timestamp is not needed, set FF_FS_NORTC = 1 to disable
262
/ the timestamp function. Every object modified by FatFs will have a fixed timestamp
263
/ defined by FF_NORTC_MON, FF_NORTC_MDAY and FF_NORTC_YEAR in local time.
264
/ To enable timestamp function (FF_FS_NORTC = 0), get_fattime() function need to be
265
/ added to the project to read current time form real-time clock. FF_NORTC_MON,
266
/ FF_NORTC_MDAY and FF_NORTC_YEAR have no effect.
267
/ These options have no effect at read-only configuration (FF_FS_READONLY = 1). */
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 ---*/
306
307