ReactOS 0.4.16-dev-306-g647d351
ffconf.h
Go to the documentation of this file.
1/*---------------------------------------------------------------------------/
2/ FatFs - FAT file system module configuration file R0.11a (C)ChaN, 2015
3/---------------------------------------------------------------------------*/
4
5#define _FFCONF 64180 /* Revision ID */
6
7/*---------------------------------------------------------------------------/
8/ Function Configurations
9/---------------------------------------------------------------------------*/
10
11#define _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 _FS_MINIMIZE 0
19/* This option defines minimization level to remove some basic API functions.
20/
21/ 0: All basic functions are enabled.
22/ 1: f_stat(), f_getfree(), f_unlink(), f_mkdir(), f_chmod(), f_utime(),
23/ f_truncate() and f_rename() function 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 _USE_STRFUNC 0
29/* This option switches string functions, f_gets(), f_putc(), f_puts() and
30/ f_printf().
31/
32/ 0: Disable string functions.
33/ 1: Enable without LF-CRLF conversion.
34/ 2: Enable with LF-CRLF conversion. */
35
36
37#define _USE_FIND 0
38/* This option switches filtered directory read feature and related functions,
39/ f_findfirst() and f_findnext(). (0:Disable or 1:Enable) */
40
41
42#define _USE_MKFS 1
43/* This option switches f_mkfs() function. (0:Disable or 1:Enable) */
44
45
46#define _USE_FASTSEEK 0
47/* This option switches fast seek feature. (0:Disable or 1:Enable) */
48
49
50#define _USE_LABEL 1
51/* This option switches volume label functions, f_getlabel() and f_setlabel().
52/ (0:Disable or 1:Enable) */
53
54
55#define _USE_FORWARD 0
56/* This option switches f_forward() function. (0:Disable or 1:Enable)
57/ To enable it, also _FS_TINY need to be set to 1. */
58
59
60/*---------------------------------------------------------------------------/
61/ Locale and Namespace Configurations
62/---------------------------------------------------------------------------*/
63
64#define _CODE_PAGE 437
65/* This option specifies the OEM code page to be used on the target system.
66/ Incorrect setting of the code page can cause a file open failure.
67/
68/ 1 - ASCII (No extended character. Non-LFN cfg. only)
69/ 437 - U.S.
70/ 720 - Arabic
71/ 737 - Greek
72/ 771 - KBL
73/ 775 - Baltic
74/ 850 - Latin 1
75/ 852 - Latin 2
76/ 855 - Cyrillic
77/ 857 - Turkish
78/ 860 - Portuguese
79/ 861 - Icelandic
80/ 862 - Hebrew
81/ 863 - Canadian French
82/ 864 - Arabic
83/ 865 - Nordic
84/ 866 - Russian
85/ 869 - Greek 2
86/ 932 - Japanese (DBCS)
87/ 936 - Simplified Chinese (DBCS)
88/ 949 - Korean (DBCS)
89/ 950 - Traditional Chinese (DBCS)
90*/
91
92
93#define _USE_LFN 2
94#define _MAX_LFN 255
95/* The _USE_LFN option switches the LFN feature.
96/
97/ 0: Disable LFN feature. _MAX_LFN has no effect.
98/ 1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe.
99/ 2: Enable LFN with dynamic working buffer on the STACK.
100/ 3: Enable LFN with dynamic working buffer on the HEAP.
101/
102/ When enable the LFN feature, Unicode handling functions (option/unicode.c) must
103/ be added to the project. The LFN working buffer occupies (_MAX_LFN + 1) * 2 bytes.
104/ When use stack for the working buffer, take care on stack overflow. When use heap
105/ memory for the working buffer, memory management functions, ff_memalloc() and
106/ ff_memfree(), must be added to the project. */
107
108
109#define _LFN_UNICODE 0
110/* This option switches character encoding on the API. (0:ANSI/OEM or 1:Unicode)
111/ To use Unicode string for the path name, enable LFN feature and set _LFN_UNICODE
112/ to 1. This option also affects behavior of string I/O functions. */
113
114
115#define _STRF_ENCODE 3
116/* When _LFN_UNICODE is 1, this option selects the character encoding on the file to
117/ be read/written via string I/O functions, f_gets(), f_putc(), f_puts and f_printf().
118/
119/ 0: ANSI/OEM
120/ 1: UTF-16LE
121/ 2: UTF-16BE
122/ 3: UTF-8
123/
124/ When _LFN_UNICODE is 0, this option has no effect. */
125
126
127#define _FS_RPATH 0
128/* This option configures relative path feature.
129/
130/ 0: Disable relative path feature and remove related functions.
131/ 1: Enable relative path feature. f_chdir() and f_chdrive() are available.
132/ 2: f_getcwd() function is available in addition to 1.
133/
134/ Note that directory items read via f_readdir() are affected by this option. */
135
136
137/*---------------------------------------------------------------------------/
138/ Drive/Volume Configurations
139/---------------------------------------------------------------------------*/
140
141#define _VOLUMES 1
142/* Number of volumes (logical drives) to be used. */
143
144
145#define _STR_VOLUME_ID 0
146#define _VOLUME_STRS "RAM","NAND","CF","SD1","SD2","USB1","USB2","USB3"
147/* _STR_VOLUME_ID option switches string volume ID feature.
148/ When _STR_VOLUME_ID is set to 1, also pre-defined strings can be used as drive
149/ number in the path name. _VOLUME_STRS defines the drive ID strings for each
150/ logical drives. Number of items must be equal to _VOLUMES. Valid characters for
151/ the drive ID strings are: A-Z and 0-9. */
152
153
154#define _MULTI_PARTITION 0
155/* This option switches multi-partition feature. By default (0), each logical drive
156/ number is bound to the same physical drive number and only an FAT volume found on
157/ the physical drive will be mounted. When multi-partition feature is enabled (1),
158/ each logical drive number is bound to arbitrary physical drive and partition
159/ listed in the VolToPart[]. Also f_fdisk() funciton will be available. */
160
161
162#define _MIN_SS 512
163#define _MAX_SS 512
164/* These options configure the range of sector size to be supported. (512, 1024,
165/ 2048 or 4096) Always set both 512 for most systems, all type of memory cards and
166/ harddisk. But a larger value may be required for on-board flash memory and some
167/ type of optical media. When _MAX_SS is larger than _MIN_SS, FatFs is configured
168/ to variable sector size and GET_SECTOR_SIZE command must be implemented to the
169/ disk_ioctl() function. */
170
171
172#define _USE_TRIM 0
173/* This option switches ATA-TRIM feature. (0:Disable or 1:Enable)
174/ To enable Trim feature, also CTRL_TRIM command should be implemented to the
175/ disk_ioctl() function. */
176
177
178#define _FS_NOFSINFO 0
179/* If you need to know correct free space on the FAT32 volume, set bit 0 of this
180/ option, and f_getfree() function at first time after volume mount will force
181/ a full FAT scan. Bit 1 controls the use of last allocated cluster number.
182/
183/ bit0=0: Use free cluster count in the FSINFO if available.
184/ bit0=1: Do not trust free cluster count in the FSINFO.
185/ bit1=0: Use last allocated cluster number in the FSINFO if available.
186/ bit1=1: Do not trust last allocated cluster number in the FSINFO.
187*/
188
189
190
191/*---------------------------------------------------------------------------/
192/ System Configurations
193/---------------------------------------------------------------------------*/
194
195#define _FS_TINY 0
196/* This option switches tiny buffer configuration. (0:Normal or 1:Tiny)
197/ At the tiny configuration, size of the file object (FIL) is reduced _MAX_SS
198/ bytes. Instead of private sector buffer eliminated from the file object,
199/ common sector buffer in the file system object (FATFS) is used for the file
200/ data transfer. */
201
202
203#define _FS_NORTC 0
204#define _NORTC_MON 1
205#define _NORTC_MDAY 1
206#define _NORTC_YEAR 2015
207/* The _FS_NORTC option switches timestamp feature. If the system does not have
208/ an RTC function or valid timestamp is not needed, set _FS_NORTC to 1 to disable
209/ the timestamp feature. All objects modified by FatFs will have a fixed timestamp
210/ defined by _NORTC_MON, _NORTC_MDAY and _NORTC_YEAR.
211/ When timestamp feature is enabled (_FS_NORTC == 0), get_fattime() function need
212/ to be added to the project to read current time form RTC. _NORTC_MON,
213/ _NORTC_MDAY and _NORTC_YEAR have no effect.
214/ These options have no effect at read-only configuration (_FS_READONLY == 1). */
215
216
217#define _FS_LOCK 0
218/* The _FS_LOCK option switches file lock feature to control duplicated file open
219/ and illegal operation to open objects. This option must be 0 when _FS_READONLY
220/ is 1.
221/
222/ 0: Disable file lock feature. To avoid volume corruption, application program
223/ should avoid illegal open, remove and rename to the open objects.
224/ >0: Enable file lock feature. The value defines how many files/sub-directories
225/ can be opened simultaneously under file lock control. Note that the file
226/ lock feature is independent of re-entrancy. */
227
228
229#define _FS_REENTRANT 0
230#define _FS_TIMEOUT 1000
231#define _SYNC_t HANDLE
232/* The _FS_REENTRANT option switches the re-entrancy (thread safe) of the FatFs
233/ module itself. Note that regardless of this option, file access to different
234/ volume is always re-entrant and volume control functions, f_mount(), f_mkfs()
235/ and f_fdisk() function, are always not re-entrant. Only file/directory access
236/ to the same volume is under control of this feature.
237/
238/ 0: Disable re-entrancy. _FS_TIMEOUT and _SYNC_t have no effect.
239/ 1: Enable re-entrancy. Also user provided synchronization handlers,
240/ ff_req_grant(), ff_rel_grant(), ff_del_syncobj() and ff_cre_syncobj()
241/ function, must be added to the project. Samples are available in
242/ option/syscall.c.
243/
244/ The _FS_TIMEOUT defines timeout period in unit of time tick.
245/ The _SYNC_t defines O/S dependent sync object type. e.g. HANDLE, ID, OS_EVENT*,
246/ SemaphoreHandle_t and etc.. A header file for O/S definitions needs to be
247/ included somewhere in the scope of ff.c. */
248
249
250#define _WORD_ACCESS 0
251/* The _WORD_ACCESS option is an only platform dependent option. It defines
252/ which access method is used to the word data on the FAT volume.
253/
254/ 0: Byte-by-byte access. Always compatible with all platforms.
255/ 1: Word access. Do not choose this unless under both the following conditions.
256/
257/ * Address misaligned memory access is always allowed to ALL instructions.
258/ * Byte order on the memory is little-endian.
259/
260/ If it is the case, _WORD_ACCESS can also be set to 1 to reduce code size.
261/ Following table shows allowable settings of some type of processors.
262/
263/ ARM7TDMI 0 *2 ColdFire 0 *1 V850E 0 *2
264/ Cortex-M3 0 *3 Z80 0/1 V850ES 0/1
265/ Cortex-M0 0 *2 x86 0/1 TLCS-870 0/1
266/ AVR 0/1 RX600(LE) 0/1 TLCS-900 0/1
267/ AVR32 0 *1 RL78 0 *2 R32C 0 *2
268/ PIC18 0/1 SH-2 0 *1 M16C 0/1
269/ PIC24 0 *2 H8S 0 *1 MSP430 0 *2
270/ PIC32 0 *1 H8/300H 0 *1 8051 0/1
271/
272/ *1:Big-endian.
273/ *2:Unaligned memory access is not supported.
274/ *3:Some compilers generate LDM/STM for mem_cpy function.
275*/
276