source: S-port/trunk/Middlewares/Third_Party/FatFs/src/ffconf_template.h

Last change on this file was 1, checked in by AlexLir, 3 years ago
File size: 12.4 KB
Line 
1/*----------------------------------------------------------------------------/
2/ FatFs - Generic FAT file system module R0.12c /
3/-----------------------------------------------------------------------------/
4/
5/ Copyright (C) 2017, ChaN, all right reserved.
6/ Portions Copyright (C) STMicroelectronics, all right reserved.
7/
8/ FatFs module is an open source software. Redistribution and use of FatFs in
9/ source and binary forms, with or without modification, are permitted provided
10/ that the following condition is met:
11
12/ 1. Redistributions of source code must retain the above copyright notice,
13/ this condition and the following disclaimer.
14/
15/ This software is provided by the copyright holder and contributors "AS IS"
16/ and any warranties related to this software are DISCLAIMED.
17/ The copyright owner or contributors be NOT LIABLE for any damages caused
18/ by use of this software.
19/----------------------------------------------------------------------------*/
20
21
22/*---------------------------------------------------------------------------/
23/ FatFs - FAT file system module configuration file
24/---------------------------------------------------------------------------*/
25
26#define _FFCONF 68300 /* Revision ID */
27
28/*---------------------------------------------------------------------------/
29/ Function Configurations
30/---------------------------------------------------------------------------*/
31
32#define _FS_READONLY 0
33/* This option switches read-only configuration. (0:Read/Write or 1:Read-only)
34/ Read-only configuration removes writing API functions, f_write(), f_sync(),
35/ f_unlink(), f_mkdir(), f_chmod(), f_rename(), f_truncate(), f_getfree()
36/ and optional writing functions as well. */
37
38
39#define _FS_MINIMIZE 0
40/* This option defines minimization level to remove some basic API functions.
41/
42/ 0: All basic functions are enabled.
43/ 1: f_stat(), f_getfree(), f_unlink(), f_mkdir(), f_truncate() and f_rename()
44/ are removed.
45/ 2: f_opendir(), f_readdir() and f_closedir() are removed in addition to 1.
46/ 3: f_lseek() function is removed in addition to 2. */
47
48
49#define _USE_STRFUNC 0
50/* This option switches string functions, f_gets(), f_putc(), f_puts() and
51/ f_printf().
52/
53/ 0: Disable string functions.
54/ 1: Enable without LF-CRLF conversion.
55/ 2: Enable with LF-CRLF conversion. */
56
57
58#define _USE_FIND 0
59/* This option switches filtered directory read functions, f_findfirst() and
60/ f_findnext(). (0:Disable, 1:Enable 2:Enable with matching altname[] too) */
61
62
63#define _USE_MKFS 1
64/* This option switches f_mkfs() function. (0:Disable or 1:Enable) */
65
66
67#define _USE_FASTSEEK 1
68/* This option switches fast seek function. (0:Disable or 1:Enable) */
69
70
71#define _USE_EXPAND 0
72/* This option switches f_expand function. (0:Disable or 1:Enable) */
73
74
75#define _USE_CHMOD 0
76/* This option switches attribute manipulation functions, f_chmod() and f_utime().
77/ (0:Disable or 1:Enable) Also _FS_READONLY needs to be 0 to enable this option. */
78
79
80#define _USE_LABEL 0
81/* This option switches volume label functions, f_getlabel() and f_setlabel().
82/ (0:Disable or 1:Enable) */
83
84
85#define _USE_FORWARD 0
86/* This option switches f_forward() function. (0:Disable or 1:Enable) */
87
88
89/*---------------------------------------------------------------------------/
90/ Locale and Namespace Configurations
91/---------------------------------------------------------------------------*/
92
93#define _CODE_PAGE 850
94/* This option specifies the OEM code page to be used on the target system.
95/ Incorrect setting of the code page can cause a file open failure.
96/
97/ 1 - ASCII (No extended character. Non-LFN cfg. only)
98/ 437 - U.S.
99/ 720 - Arabic
100/ 737 - Greek
101/ 771 - KBL
102/ 775 - Baltic
103/ 850 - Latin 1
104/ 852 - Latin 2
105/ 855 - Cyrillic
106/ 857 - Turkish
107/ 860 - Portuguese
108/ 861 - Icelandic
109/ 862 - Hebrew
110/ 863 - Canadian French
111/ 864 - Arabic
112/ 865 - Nordic
113/ 866 - Russian
114/ 869 - Greek 2
115/ 932 - Japanese (DBCS)
116/ 936 - Simplified Chinese (DBCS)
117/ 949 - Korean (DBCS)
118/ 950 - Traditional Chinese (DBCS)
119*/
120
121
122#define _USE_LFN 3
123#define _MAX_LFN 255
124/* The _USE_LFN switches the support of long file name (LFN).
125/
126/ 0: Disable support of LFN. _MAX_LFN has no effect.
127/ 1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe.
128/ 2: Enable LFN with dynamic working buffer on the STACK.
129/ 3: Enable LFN with dynamic working buffer on the HEAP.
130/
131/ To enable the LFN, Unicode handling functions (option/unicode.c) must be added
132/ to the project. The working buffer occupies (_MAX_LFN + 1) * 2 bytes and
133/ additional 608 bytes at exFAT enabled. _MAX_LFN can be in range from 12 to 255.
134/ It should be set 255 to support full featured LFN operations.
135/ When use stack for the working buffer, take care on stack overflow. When use heap
136/ memory for the working buffer, memory management functions, ff_memalloc() and
137/ ff_memfree(), must be added to the project. */
138
139
140#define _LFN_UNICODE 0
141/* This option switches character encoding on the API. (0:ANSI/OEM or 1:UTF-16)
142/ To use Unicode string for the path name, enable LFN and set _LFN_UNICODE = 1.
143/ This option also affects behavior of string I/O functions. */
144
145
146#define _STRF_ENCODE 3
147/* When _LFN_UNICODE == 1, this option selects the character encoding ON THE FILE to
148/ be read/written via string I/O functions, f_gets(), f_putc(), f_puts and f_printf().
149/
150/ 0: ANSI/OEM
151/ 1: UTF-16LE
152/ 2: UTF-16BE
153/ 3: UTF-8
154/
155/ This option has no effect when _LFN_UNICODE == 0. */
156
157
158#define _FS_RPATH 0
159/* This option configures support of relative path.
160/
161/ 0: Disable relative path and remove related functions.
162/ 1: Enable relative path. f_chdir() and f_chdrive() are available.
163/ 2: f_getcwd() function is available in addition to 1.
164*/
165
166
167/*---------------------------------------------------------------------------/
168/ Drive/Volume Configurations
169/---------------------------------------------------------------------------*/
170
171#define _VOLUMES 2
172/* Number of volumes (logical drives) to be used. */
173
174
175#define _STR_VOLUME_ID 0
176#define _VOLUME_STRS "RAM","NAND","CF","SD","SD2","USB","USB2","USB3"
177/* _STR_VOLUME_ID switches string support of volume ID.
178/ When _STR_VOLUME_ID is set to 1, also pre-defined strings can be used as drive
179/ number in the path name. _VOLUME_STRS defines the drive ID strings for each
180/ logical drives. Number of items must be equal to _VOLUMES. Valid characters for
181/ the drive ID strings are: A-Z and 0-9. */
182
183
184#define _MULTI_PARTITION 0
185/* This option switches support of multi-partition on a physical drive.
186/ By default (0), each logical drive number is bound to the same physical drive
187/ number and only an FAT volume found on the physical drive will be mounted.
188/ When multi-partition is enabled (1), each logical drive number can be bound to
189/ arbitrary physical drive and partition listed in the VolToPart[]. Also f_fdisk()
190/ funciton will be available. */
191
192
193#define _MIN_SS 512
194#define _MAX_SS 512
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
233#define _FS_EXFAT 0
234/* This option switches support of exFAT file system. (0:Disable or 1:Enable)
235/ When enable exFAT, also LFN needs to be enabled. (_USE_LFN >= 1)
236/ Note that enabling exFAT discards C89 compatibility. */
237
238
239#define _FS_NORTC 0
240#define _NORTC_MON 1
241#define _NORTC_MDAY 1
242#define _NORTC_YEAR 2016
243/* The option _FS_NORTC switches timestamp functiton. If the system does not have
244/ any RTC function or valid timestamp is not needed, set _FS_NORTC = 1 to disable
245/ the timestamp function. All objects modified by FatFs will have a fixed timestamp
246/ defined by _NORTC_MON, _NORTC_MDAY and _NORTC_YEAR in local time.
247/ To enable timestamp function (_FS_NORTC = 0), get_fattime() function need to be
248/ added to the project to get current time form real-time clock. _NORTC_MON,
249/ _NORTC_MDAY and _NORTC_YEAR have no effect.
250/ These options have no effect at read-only configuration (_FS_READONLY = 1). */
251
252
253#define _FS_LOCK 2
254/* The option _FS_LOCK switches file lock function to control duplicated file open
255/ and illegal operation to open objects. This option must be 0 when _FS_READONLY
256/ is 1.
257/
258/ 0: Disable file lock function. To avoid volume corruption, application program
259/ should avoid illegal open, remove and rename to the open objects.
260/ >0: Enable file lock function. The value defines how many files/sub-directories
261/ can be opened simultaneously under file lock control. Note that the file
262/ lock control is independent of re-entrancy. */
263
264#define _FS_REENTRANT 0
265#define _USE_MUTEX 0
266/* Use CMSIS-OS mutexes as _SYNC_t object instead of Semaphores */
267
268#if _FS_REENTRANT
269
270#include "cmsis_os.h"
271#define _FS_TIMEOUT 1000
272
273#if _USE_MUTEX
274
275#if (osCMSIS < 0x20000U)
276#define _SYNC_t osMutexId
277#else
278#define _SYNC_t osMutexId_t
279#endif
280
281#else
282#if (osCMSIS < 0x20000U)
283#define _SYNC_t osSemaphoreId
284#else
285#define _SYNC_t osSemaphoreId_t
286#endif
287
288#endif
289#endif //_FS_REENTRANT
290/* The option _FS_REENTRANT switches the re-entrancy (thread safe) of the FatFs
291/ module itself. Note that regardless of this option, file access to different
292/ volume is always re-entrant and volume control functions, f_mount(), f_mkfs()
293/ and f_fdisk() function, are always not re-entrant. Only file/directory access
294/ to the same volume is under control of this function.
295/
296/ 0: Disable re-entrancy. _FS_TIMEOUT and _SYNC_t have no effect.
297/ 1: Enable re-entrancy. Also user provided synchronization handlers,
298/ ff_req_grant(), ff_rel_grant(), ff_del_syncobj() and ff_cre_syncobj()
299/ function, must be added to the project. Samples are available in
300/ option/syscall.c.
301/
302/ The _FS_TIMEOUT defines timeout period in unit of time tick.
303/ The _SYNC_t defines O/S dependent sync object type. e.g. HANDLE, ID, OS_EVENT*,
304/ SemaphoreHandle_t and etc.. A header file for O/S definitions needs to be
305/ included somewhere in the scope of ff.h. */
306
307/* #include <windows.h> // O/S definitions */
308
309#if _USE_LFN == 3
310
311#if !defined(ff_malloc) || !defined(ff_free)
312#include <stdlib.h>
313#endif
314
315#if !defined(ff_malloc)
316#define ff_malloc malloc
317#endif
318
319#if !defined(ff_free)
320#define ff_free free
321#endif
322
323/* by default the system malloc/free are used, but when the FreeRTOS is enabled
324/ the macros pvPortMalloc()/vportFree() to be used thus uncomment the code below
325/
326*/
327/*
328#if !defined(ff_malloc) || !defined(ff_free)
329#include "cmsis_os.h"
330#endif
331
332#if !defined(ff_malloc)
333#define ff_malloc pvPortMalloc
334#endif
335
336#if !defined(ff_free)
337#define ff_free vPortFree
338#endif
339*/
340#endif
341/*--- End of configuration options ---*/
Note: See TracBrowser for help on using the repository browser.