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