µGFX  2.9
version 2.9
ffconf.h
1 /*---------------------------------------------------------------------------/
2 / FatFs - Configuration file
3 /---------------------------------------------------------------------------*/
4 
5 #define FFCONF_DEF 87030 /* Revision ID */
6 
7 /*---------------------------------------------------------------------------/
8 / Function Configurations
9 /---------------------------------------------------------------------------*/
10 
11 #define FF_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 FF_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 FF_USE_STRFUNC 0
29 /* This option switches string functions, f_gets(), f_putc(), f_puts() and f_printf().
30 /
31 / 0: Disable string functions.
32 / 1: Enable without LF-CRLF conversion.
33 / 2: Enable with LF-CRLF conversion. */
34 
35 
36 #define FF_USE_FIND 0
37 /* This option switches filtered directory read functions, f_findfirst() and
38 / f_findnext(). (0:Disable, 1:Enable 2:Enable with matching altname[] too) */
39 
40 
41 #define FF_USE_MKFS 0
42 /* This option switches f_mkfs() function. (0:Disable or 1:Enable) */
43 
44 
45 #define FF_USE_FASTSEEK 0
46 /* This option switches fast seek function. (0:Disable or 1:Enable) */
47 
48 
49 #define FF_USE_EXPAND 0
50 /* This option switches f_expand function. (0:Disable or 1:Enable) */
51 
52 
53 #define FF_USE_CHMOD 0
54 /* This option switches attribute manipulation functions, f_chmod() and f_utime().
55 / (0:Disable or 1:Enable) Also FF_FS_READONLY needs to be 0 to enable this option. */
56 
57 
58 #define FF_USE_LABEL 0
59 /* This option switches volume label functions, f_getlabel() and f_setlabel().
60 / (0:Disable or 1:Enable) */
61 
62 
63 #define FF_USE_FORWARD 0
64 /* This option switches f_forward() function. (0:Disable or 1:Enable) */
65 
66 
67 /*---------------------------------------------------------------------------/
68 / Locale and Namespace Configurations
69 /---------------------------------------------------------------------------*/
70 
71 #define FF_CODE_PAGE 437
72 /* This option specifies the OEM code page to be used on the target system.
73 / Incorrect code page setting can cause a file open failure.
74 /
75 / 437 - U.S.
76 / 720 - Arabic
77 / 737 - Greek
78 / 771 - KBL
79 / 775 - Baltic
80 / 850 - Latin 1
81 / 852 - Latin 2
82 / 855 - Cyrillic
83 / 857 - Turkish
84 / 860 - Portuguese
85 / 861 - Icelandic
86 / 862 - Hebrew
87 / 863 - Canadian French
88 / 864 - Arabic
89 / 865 - Nordic
90 / 866 - Russian
91 / 869 - Greek 2
92 / 932 - Japanese (DBCS)
93 / 936 - Simplified Chinese (DBCS)
94 / 949 - Korean (DBCS)
95 / 950 - Traditional Chinese (DBCS)
96 / 0 - Include all code pages above and configured by f_setcp()
97 */
98 
99 
100 #define FF_USE_LFN 3
101 #define FF_MAX_LFN 255
102 /* The FF_USE_LFN switches the support for LFN (long file name).
103 /
104 / 0: Disable LFN. FF_MAX_LFN has no effect.
105 / 1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe.
106 / 2: Enable LFN with dynamic working buffer on the STACK.
107 / 3: Enable LFN with dynamic working buffer on the HEAP.
108 /
109 / To enable the LFN, Unicode handling functions (option/unicode.c) must be added
110 / to the project. The working buffer occupies (FF_MAX_LFN + 1) * 2 bytes and
111 / additional 608 bytes at exFAT enabled. FF_MAX_LFN can be in range from 12 to 255.
112 / It should be set 255 to support full featured LFN operations.
113 / When use stack for the working buffer, take care on stack overflow. When use heap
114 / memory for the working buffer, memory management functions, ff_memalloc() and
115 / ff_memfree(), must be added to the project. */
116 
117 
118 #define FF_LFN_UNICODE 0
119 /* This option switches character encoding on the API, 0:ANSI/OEM or 1:UTF-16,
120 / when LFN is enabled. Also behavior of string I/O functions will be affected by
121 / this option. When LFN is not enabled, this option has no effect.
122 */
123 
124 
125 #define FF_STRF_ENCODE 3
126 /* When FF_LFN_UNICODE = 1 with LFN enabled, string I/O functions, f_gets(),
127 / f_putc(), f_puts and f_printf() convert the character encoding in it.
128 / This option selects assumption of character encoding ON THE FILE to be
129 / read/written via those functions.
130 /
131 / 0: ANSI/OEM
132 / 1: UTF-16LE
133 / 2: UTF-16BE
134 / 3: UTF-8
135 */
136 
137 
138 #define FF_FS_RPATH 0
139 /* This option configures support for 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 FF_VOLUMES 1
152 /* Number of volumes (logical drives) to be used. (1-10) */
153 
154 
155 #define FF_STR_VOLUME_ID 0
156 #define FF_VOLUME_STRS "RAM","NAND","CF","SD","SD2","USB","USB2","USB3"
157 /* FF_STR_VOLUME_ID switches string support for volume ID.
158 / When FF_STR_VOLUME_ID is set to 1, also pre-defined strings can be used as drive
159 / number in the path name. FF_VOLUME_STRS defines the drive ID strings for each
160 / logical drives. Number of items must be equal to FF_VOLUMES. Valid characters for
161 / the drive ID strings are: A-Z and 0-9. */
162 
163 
164 #define FF_MULTI_PARTITION 0
165 /* This option switches support for multiple volumes on the 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 this function 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 FF_MIN_SS 512
174 #define FF_MAX_SS 512
175 /* This set of options configures the range of sector size to be supported. (512,
176 / 1024, 2048 or 4096) Always set both 512 for most systems, generic memory card and
177 / harddisk. But a larger value may be required for on-board flash memory and some
178 / type of optical media. When FF_MAX_SS is larger than FF_MIN_SS, FatFs is configured
179 / for variable sector size mode and disk_ioctl() function needs to implement
180 / GET_SECTOR_SIZE command. */
181 
182 
183 #define FF_USE_TRIM 0
184 /* This option switches support for 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 FF_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 FF_FS_TINY 0
207 /* This option switches tiny buffer configuration. (0:Normal or 1:Tiny)
208 / At the tiny configuration, size of file object (FIL) is shrinked FF_MAX_SS bytes.
209 / Instead of private sector buffer eliminated from the file object, common sector
210 / buffer in the filesystem object (FATFS) is used for the file data transfer. */
211 
212 
213 #define FF_FS_EXFAT 0
214 /* This option switches support for exFAT filesystem. (0:Disable or 1:Enable)
215 / When enable exFAT, also LFN needs to be enabled.
216 / Note that enabling exFAT discards ANSI C (C89) compatibility. */
217 
218 
219 #define FF_FS_NORTC 1
220 #define FF_NORTC_MON 5
221 #define FF_NORTC_MDAY 1
222 #define FF_NORTC_YEAR 2017
223 /* The option FF_FS_NORTC switches timestamp functiton. If the system does not have
224 / any RTC function or valid timestamp is not needed, set FF_FS_NORTC = 1 to disable
225 / the timestamp function. All objects modified by FatFs will have a fixed timestamp
226 / defined by FF_NORTC_MON, FF_NORTC_MDAY and FF_NORTC_YEAR in local time.
227 / To enable timestamp function (FF_FS_NORTC = 0), get_fattime() function need to be
228 / added to the project to read current time form real-time clock. FF_NORTC_MON,
229 / FF_NORTC_MDAY and FF_NORTC_YEAR have no effect.
230 / These options have no effect at read-only configuration (FF_FS_READONLY = 1). */
231 
232 
233 #define FF_FS_LOCK 0
234 /* The option FF_FS_LOCK switches file lock function to control duplicated file open
235 / and illegal operation to open objects. This option must be 0 when FF_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 FF_FS_REENTRANT 0
246 #define FF_FS_TIMEOUT 1000
247 #define FF_SYNC_t gSem
248 /* The option FF_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. FF_FS_TIMEOUT and FF_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 FF_FS_TIMEOUT defines timeout period in unit of time tick.
261 / The FF_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.h. */
264 
265 #if FF_FS_REENTRANT
266  #include "gfx.h"
267 #endif
268 
269 
270 /*--- End of configuration options ---*/