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