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

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.