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