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