1 | /*----------------------------------------------------------------------------/
|
2 | / FatFs - Generic FAT Filesystem module R0.13a /
|
3 | /-----------------------------------------------------------------------------/
|
4 | /
|
5 | / Copyright (C) 2017, ChaN, all right reserved.
|
6 | /
|
7 | / FatFs module is an open source software. Redistribution and use of FatFs in
|
8 | / source and binary forms, with or without modification, are permitted provided
|
9 | / that the following condition is met:
|
10 |
|
11 | / 1. Redistributions of source code must retain the above copyright notice,
|
12 | / this condition and the following disclaimer.
|
13 | /
|
14 | / This software is provided by the copyright holder and contributors "AS IS"
|
15 | / and any warranties related to this software are DISCLAIMED.
|
16 | / The copyright owner or contributors be NOT LIABLE for any damages caused
|
17 | / by use of this software.
|
18 | /
|
19 | /----------------------------------------------------------------------------*/
|
20 |
|
21 |
|
22 | #ifndef FF_DEFINED
|
23 | #define FF_DEFINED 89352 /* Revision ID */
|
24 |
|
25 | #ifdef __cplusplus
|
26 | extern "C" {
|
27 | #endif
|
28 |
|
29 | #include "integer.h" /* Basic integer types */
|
30 | #include "ffconf.h" /* FatFs configuration options */
|
31 |
|
32 | #if FF_DEFINED != FFCONF_DEF
|
33 | #error Wrong configuration file (ffconf.h).
|
34 | #endif
|
35 |
|
36 |
|
37 |
|
38 | /* Definitions of volume management */
|
39 |
|
40 | #if FF_MULTI_PARTITION /* Multiple partition configuration */
|
41 | typedef struct {
|
42 | BYTE pd; /* Physical drive number */
|
43 | BYTE pt; /* Partition: 0:Auto detect, 1-4:Forced partition) */
|
44 | } PARTITION;
|
45 | extern PARTITION VolToPart[]; /* Volume - Partition resolution table */
|
46 | #endif
|
47 |
|
48 |
|
49 |
|
50 | /* Type of path name strings on FatFs API */
|
51 |
|
52 | #ifndef _INC_TCHAR
|
53 | #define _INC_TCHAR
|
54 |
|
55 | #if FF_USE_LFN && FF_LFN_UNICODE == 1 /* Unicode in UTF-16 encoding */
|
56 | typedef WCHAR TCHAR;
|
57 | #define _T(x) L ## x
|
58 | #define _TEXT(x) L ## x
|
59 | #elif FF_USE_LFN && FF_LFN_UNICODE == 2 /* Unicode in UTF-8 encoding */
|
60 | typedef char TCHAR;
|
61 | #define _T(x) u8 ## x
|
62 | #define _TEXT(x) u8 ## x
|
63 | #elif FF_USE_LFN && (FF_LFN_UNICODE < 0 || FF_LFN_UNICODE > 2)
|
64 | #error Wrong FF_LFN_UNICODE setting
|
65 | #else /* ANSI/OEM code in SBCS/DBCS */
|
66 | typedef char TCHAR;
|
67 | #define _T(x) x
|
68 | #define _TEXT(x) x
|
69 | #endif
|
70 |
|
71 | #endif
|
72 |
|
73 |
|
74 |
|
75 | /* Type of file size variables */
|
76 |
|
77 | #if FF_FS_EXFAT
|
78 | typedef QWORD FSIZE_t;
|
79 | #else
|
80 | typedef DWORD FSIZE_t;
|
81 | #endif
|
82 |
|
83 |
|
84 |
|
85 | /* Filesystem object structure (FATFS) */
|
86 |
|
87 | typedef struct {
|
88 | BYTE fs_type; /* Filesystem type (0:N/A) */
|
89 | BYTE pdrv; /* Physical drive number */
|
90 | BYTE n_fats; /* Number of FATs (1 or 2) */
|
91 | BYTE wflag; /* win[] flag (b0:dirty) */
|
92 | BYTE fsi_flag; /* FSINFO flags (b7:disabled, b0:dirty) */
|
93 | WORD id; /* Volume mount ID */
|
94 | WORD n_rootdir; /* Number of root directory entries (FAT12/16) */
|
95 | WORD csize; /* Cluster size [sectors] */
|
96 | #if FF_MAX_SS != FF_MIN_SS
|
97 | WORD ssize; /* Sector size (512, 1024, 2048 or 4096) */
|
98 | #endif
|
99 | #if FF_USE_LFN
|
100 | WCHAR* lfnbuf; /* LFN working buffer */
|
101 | #endif
|
102 | #if FF_FS_EXFAT
|
103 | BYTE* dirbuf; /* Directory entry block scratchpad buffer for exFAT */
|
104 | #endif
|
105 | #if FF_FS_REENTRANT
|
106 | FF_SYNC_t sobj; /* Identifier of sync object */
|
107 | #endif
|
108 | #if !FF_FS_READONLY
|
109 | DWORD last_clst; /* Last allocated cluster */
|
110 | DWORD free_clst; /* Number of free clusters */
|
111 | #endif
|
112 | #if FF_FS_RPATH
|
113 | DWORD cdir; /* Current directory start cluster (0:root) */
|
114 | #if FF_FS_EXFAT
|
115 | DWORD cdc_scl; /* Containing directory start cluster (invalid when cdir is 0) */
|
116 | DWORD cdc_size; /* b31-b8:Size of containing directory, b7-b0: Chain status */
|
117 | DWORD cdc_ofs; /* Offset in the containing directory (invalid when cdir is 0) */
|
118 | #endif
|
119 | #endif
|
120 | DWORD n_fatent; /* Number of FAT entries (number of clusters + 2) */
|
121 | DWORD fsize; /* Size of an FAT [sectors] */
|
122 | DWORD volbase; /* Volume base sector */
|
123 | DWORD fatbase; /* FAT base sector */
|
124 | DWORD dirbase; /* Root directory base sector/cluster */
|
125 | DWORD database; /* Data base sector */
|
126 | DWORD winsect; /* Current sector appearing in the win[] */
|
127 | BYTE win[FF_MAX_SS]; /* Disk access window for Directory, FAT (and file data at tiny cfg) */
|
128 | } FATFS;
|
129 |
|
130 |
|
131 |
|
132 | /* Object ID and allocation information (FFOBJID) */
|
133 |
|
134 | typedef struct {
|
135 | FATFS* fs; /* Pointer to the hosting volume of this object */
|
136 | WORD id; /* Hosting volume mount ID */
|
137 | BYTE attr; /* Object attribute */
|
138 | BYTE stat; /* Object chain status (b1-0: =0:not contiguous, =2:contiguous, =3:flagmented in this session, b2:sub-directory stretched) */
|
139 | DWORD sclust; /* Object data start cluster (0:no cluster or root directory) */
|
140 | FSIZE_t objsize; /* Object size (valid when sclust != 0) */
|
141 | #if FF_FS_EXFAT
|
142 | DWORD n_cont; /* Size of first fragment - 1 (valid when stat == 3) */
|
143 | DWORD n_frag; /* Size of last fragment needs to be written to FAT (valid when not zero) */
|
144 | DWORD c_scl; /* Containing directory start cluster (valid when sclust != 0) */
|
145 | DWORD c_size; /* b31-b8:Size of containing directory, b7-b0: Chain status (valid when c_scl != 0) */
|
146 | DWORD c_ofs; /* Offset in the containing directory (valid when file object and sclust != 0) */
|
147 | #endif
|
148 | #if FF_FS_LOCK
|
149 | UINT lockid; /* File lock ID origin from 1 (index of file semaphore table Files[]) */
|
150 | #endif
|
151 | } FFOBJID;
|
152 |
|
153 |
|
154 |
|
155 | /* File object structure (FIL) */
|
156 |
|
157 | typedef struct {
|
158 | FFOBJID obj; /* Object identifier (must be the 1st member to detect invalid object pointer) */
|
159 | BYTE flag; /* File status flags */
|
160 | BYTE err; /* Abort flag (error code) */
|
161 | FSIZE_t fptr; /* File read/write pointer (Zeroed on file open) */
|
162 | DWORD clust; /* Current cluster of fpter (invalid when fptr is 0) */
|
163 | DWORD sect; /* Sector number appearing in buf[] (0:invalid) */
|
164 | #if !FF_FS_READONLY
|
165 | DWORD dir_sect; /* Sector number containing the directory entry (not used at exFAT) */
|
166 | BYTE* dir_ptr; /* Pointer to the directory entry in the win[] (not used at exFAT) */
|
167 | #endif
|
168 | #if FF_USE_FASTSEEK
|
169 | DWORD* cltbl; /* Pointer to the cluster link map table (nulled on open, set by application) */
|
170 | #endif
|
171 | #if !FF_FS_TINY
|
172 | BYTE buf[FF_MAX_SS]; /* File private data read/write window */
|
173 | #endif
|
174 | } FIL;
|
175 |
|
176 |
|
177 |
|
178 | /* Directory object structure (DIR) */
|
179 |
|
180 | typedef struct {
|
181 | FFOBJID obj; /* Object identifier */
|
182 | DWORD dptr; /* Current read/write offset */
|
183 | DWORD clust; /* Current cluster */
|
184 | DWORD sect; /* Current sector (0:Read operation has terminated) */
|
185 | BYTE* dir; /* Pointer to the directory item in the win[] */
|
186 | BYTE fn[12]; /* SFN (in/out) {body[8],ext[3],status[1]} */
|
187 | #if FF_USE_LFN
|
188 | DWORD blk_ofs; /* Offset of current entry block being processed (0xFFFFFFFF:Invalid) */
|
189 | #endif
|
190 | #if FF_USE_FIND
|
191 | const TCHAR* pat; /* Pointer to the name matching pattern */
|
192 | #endif
|
193 | } DIR;
|
194 |
|
195 |
|
196 |
|
197 | /* File information structure (FILINFO) */
|
198 |
|
199 | typedef struct {
|
200 | FSIZE_t fsize; /* File size */
|
201 | WORD fdate; /* Modified date */
|
202 | WORD ftime; /* Modified time */
|
203 | BYTE fattrib; /* File attribute */
|
204 | #if FF_USE_LFN
|
205 | TCHAR altname[FF_SFN_BUF + 1];/* Altenative file name */
|
206 | TCHAR fname[FF_LFN_BUF + 1]; /* Primary file name */
|
207 | #else
|
208 | TCHAR fname[12 + 1]; /* File name */
|
209 | #endif
|
210 | } FILINFO;
|
211 |
|
212 |
|
213 |
|
214 | /* File function return code (FRESULT) */
|
215 |
|
216 | typedef enum {
|
217 | FR_OK = 0, /* (0) Succeeded */
|
218 | FR_DISK_ERR, /* (1) A hard error occurred in the low level disk I/O layer */
|
219 | FR_INT_ERR, /* (2) Assertion failed */
|
220 | FR_NOT_READY, /* (3) The physical drive cannot work */
|
221 | FR_NO_FILE, /* (4) Could not find the file */
|
222 | FR_NO_PATH, /* (5) Could not find the path */
|
223 | FR_INVALID_NAME, /* (6) The path name format is invalid */
|
224 | FR_DENIED, /* (7) Access denied due to prohibited access or directory full */
|
225 | FR_EXIST, /* (8) Access denied due to prohibited access */
|
226 | FR_INVALID_OBJECT, /* (9) The file/directory object is invalid */
|
227 | FR_WRITE_PROTECTED, /* (10) The physical drive is write protected */
|
228 | FR_INVALID_DRIVE, /* (11) The logical drive number is invalid */
|
229 | FR_NOT_ENABLED, /* (12) The volume has no work area */
|
230 | FR_NO_FILESYSTEM, /* (13) There is no valid FAT volume */
|
231 | FR_MKFS_ABORTED, /* (14) The f_mkfs() aborted due to any problem */
|
232 | FR_TIMEOUT, /* (15) Could not get a grant to access the volume within defined period */
|
233 | FR_LOCKED, /* (16) The operation is rejected according to the file sharing policy */
|
234 | FR_NOT_ENOUGH_CORE, /* (17) LFN working buffer could not be allocated */
|
235 | FR_TOO_MANY_OPEN_FILES, /* (18) Number of open files > FF_FS_LOCK */
|
236 | FR_INVALID_PARAMETER /* (19) Given parameter is invalid */
|
237 | } FRESULT;
|
238 |
|
239 |
|
240 |
|
241 | /*--------------------------------------------------------------*/
|
242 | /* FatFs module application interface */
|
243 |
|
244 | FRESULT f_open (FIL* fp, const TCHAR* path, BYTE mode); /* Open or create a file */
|
245 | FRESULT f_close (FIL* fp); /* Close an open file object */
|
246 | FRESULT f_read (FIL* fp, void* buff, UINT btr, UINT* br); /* Read data from the file */
|
247 | FRESULT f_write (FIL* fp, const void* buff, UINT btw, UINT* bw); /* Write data to the file */
|
248 | FRESULT f_lseek (FIL* fp, FSIZE_t ofs); /* Move file pointer of the file object */
|
249 | FRESULT f_truncate (FIL* fp); /* Truncate the file */
|
250 | FRESULT f_sync (FIL* fp); /* Flush cached data of the writing file */
|
251 | FRESULT f_opendir (DIR* dp, const TCHAR* path); /* Open a directory */
|
252 | FRESULT f_closedir (DIR* dp); /* Close an open directory */
|
253 | FRESULT f_readdir (DIR* dp, FILINFO* fno); /* Read a directory item */
|
254 | FRESULT f_findfirst (DIR* dp, FILINFO* fno, const TCHAR* path, const TCHAR* pattern); /* Find first file */
|
255 | FRESULT f_findnext (DIR* dp, FILINFO* fno); /* Find next file */
|
256 | FRESULT f_mkdir (const TCHAR* path); /* Create a sub directory */
|
257 | FRESULT f_unlink (const TCHAR* path); /* Delete an existing file or directory */
|
258 | FRESULT f_rename (const TCHAR* path_old, const TCHAR* path_new); /* Rename/Move a file or directory */
|
259 | FRESULT f_stat (const TCHAR* path, FILINFO* fno); /* Get file status */
|
260 | FRESULT f_chmod (const TCHAR* path, BYTE attr, BYTE mask); /* Change attribute of a file/dir */
|
261 | FRESULT f_utime (const TCHAR* path, const FILINFO* fno); /* Change timestamp of a file/dir */
|
262 | FRESULT f_chdir (const TCHAR* path); /* Change current directory */
|
263 | FRESULT f_chdrive (const TCHAR* path); /* Change current drive */
|
264 | FRESULT f_getcwd (TCHAR* buff, UINT len); /* Get current directory */
|
265 | FRESULT f_getfree (const TCHAR* path, DWORD* nclst, FATFS** fatfs); /* Get number of free clusters on the drive */
|
266 | FRESULT f_getlabel (const TCHAR* path, TCHAR* label, DWORD* vsn); /* Get volume label */
|
267 | FRESULT f_setlabel (const TCHAR* label); /* Set volume label */
|
268 | FRESULT f_forward (FIL* fp, UINT(*func)(const BYTE*,UINT), UINT btf, UINT* bf); /* Forward data to the stream */
|
269 | FRESULT f_expand (FIL* fp, FSIZE_t szf, BYTE opt); /* Allocate a contiguous block to the file */
|
270 | FRESULT f_mount (FATFS* fs, const TCHAR* path, BYTE opt); /* Mount/Unmount a logical drive */
|
271 | FRESULT f_mkfs (const TCHAR* path, BYTE opt, DWORD au, void* work, UINT len); /* Create a FAT volume */
|
272 | FRESULT f_fdisk (BYTE pdrv, const DWORD* szt, void* work); /* Divide a physical drive into some partitions */
|
273 | FRESULT f_setcp (WORD cp); /* Set current code page */
|
274 | int f_putc (TCHAR c, FIL* fp); /* Put a character to the file */
|
275 | int f_puts (const TCHAR* str, FIL* cp); /* Put a string to the file */
|
276 | int f_printf (FIL* fp, const TCHAR* str, ...); /* Put a formatted string to the file */
|
277 | TCHAR* f_gets (TCHAR* buff, int len, FIL* fp); /* Get a string from the file */
|
278 |
|
279 | #define f_eof(fp) ((int)((fp)->fptr == (fp)->obj.objsize))
|
280 | #define f_error(fp) ((fp)->err)
|
281 | #define f_tell(fp) ((fp)->fptr)
|
282 | #define f_size(fp) ((fp)->obj.objsize)
|
283 | #define f_rewind(fp) f_lseek((fp), 0)
|
284 | #define f_rewinddir(dp) f_readdir((dp), 0)
|
285 | #define f_rmdir(path) f_unlink(path)
|
286 | #define f_unmount(path) f_mount(0, path, 0)
|
287 |
|
288 | #ifndef EOF
|
289 | #define EOF (-1)
|
290 | #endif
|
291 |
|
292 |
|
293 |
|
294 |
|
295 | /*--------------------------------------------------------------*/
|
296 | /* Additional user defined functions */
|
297 |
|
298 | /* RTC function */
|
299 | #if !FF_FS_READONLY && !FF_FS_NORTC
|
300 | DWORD get_fattime (void);
|
301 | #endif
|
302 |
|
303 | /* LFN support functions */
|
304 | #if FF_USE_LFN >= 1 /* Code conversion (defined in unicode.c) */
|
305 | WCHAR ff_oem2uni (WCHAR oem, WORD cp); /* OEM code to Unicode conversion */
|
306 | WCHAR ff_uni2oem (DWORD uni, WORD cp); /* Unicode to OEM code conversion */
|
307 | DWORD ff_wtoupper (DWORD uni); /* Unicode upper-case conversion */
|
308 | #endif
|
309 | #if FF_USE_LFN == 3 /* Dynamic memory allocation */
|
310 | void* ff_memalloc (UINT msize); /* Allocate memory block */
|
311 | void ff_memfree (void* mblock); /* Free memory block */
|
312 | #endif
|
313 |
|
314 | /* Sync functions */
|
315 | #if FF_FS_REENTRANT
|
316 | int ff_cre_syncobj (BYTE vol, FF_SYNC_t* sobj); /* Create a sync object */
|
317 | int ff_req_grant (FF_SYNC_t sobj); /* Lock sync object */
|
318 | void ff_rel_grant (FF_SYNC_t sobj); /* Unlock sync object */
|
319 | int ff_del_syncobj (FF_SYNC_t sobj); /* Delete a sync object */
|
320 | #endif
|
321 |
|
322 |
|
323 |
|
324 |
|
325 | /*--------------------------------------------------------------*/
|
326 | /* Flags and offset address */
|
327 |
|
328 |
|
329 | /* File access mode and open method flags (3rd argument of f_open) */
|
330 | #define FA_READ 0x01
|
331 | #define FA_WRITE 0x02
|
332 | #define FA_OPEN_EXISTING 0x00
|
333 | #define FA_CREATE_NEW 0x04
|
334 | #define FA_CREATE_ALWAYS 0x08
|
335 | #define FA_OPEN_ALWAYS 0x10
|
336 | #define FA_OPEN_APPEND 0x30
|
337 |
|
338 | /* Fast seek controls (2nd argument of f_lseek) */
|
339 | #define CREATE_LINKMAP ((FSIZE_t)0 - 1)
|
340 |
|
341 | /* Format options (2nd argument of f_mkfs) */
|
342 | #define FM_FAT 0x01
|
343 | #define FM_FAT32 0x02
|
344 | #define FM_EXFAT 0x04
|
345 | #define FM_ANY 0x07
|
346 | #define FM_SFD 0x08
|
347 |
|
348 | /* Filesystem type (FATFS.fs_type) */
|
349 | #define FS_FAT12 1
|
350 | #define FS_FAT16 2
|
351 | #define FS_FAT32 3
|
352 | #define FS_EXFAT 4
|
353 |
|
354 | /* File attribute bits for directory entry (FILINFO.fattrib) */
|
355 | #define AM_RDO 0x01 /* Read only */
|
356 | #define AM_HID 0x02 /* Hidden */
|
357 | #define AM_SYS 0x04 /* System */
|
358 | #define AM_DIR 0x10 /* Directory */
|
359 | #define AM_ARC 0x20 /* Archive */
|
360 |
|
361 |
|
362 | #ifdef __cplusplus
|
363 | }
|
364 | #endif
|
365 |
|
366 | #endif /* FF_DEFINED */
|