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