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