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