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