]>
cloudbase.mooo.com Git - z180-stamp.git/blob - fatfs/source/ff.h
1 /*----------------------------------------------------------------------------/
2 / FatFs - Generic FAT Filesystem module R0.15 /
3 /-----------------------------------------------------------------------------/
5 / Copyright (C) 2022, ChaN, all right reserved.
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:
11 / 1. Redistributions of source code must retain the above copyright notice,
12 / this condition and the following disclaimer.
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.
19 /----------------------------------------------------------------------------*/
23 #define FF_DEFINED 80286 /* Revision ID */
29 #include "ffconf.h" /* FatFs configuration options */
31 #if FF_DEFINED != FFCONF_DEF
32 #error Wrong configuration file (ffconf.h).
36 /* Integer types used for FatFs API */
38 #if defined(_WIN32) /* Windows VC++ (for development only) */
41 typedef unsigned __int64 QWORD
;
43 #define isnan(v) _isnan(v)
44 #define isinf(v) (!_finite(v))
46 #elif (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || defined(__cplusplus) /* C99 or later */
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 */
56 #else /* Earlier than C99 */
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 */
66 /* Type of file size and LBA variables */
70 #error exFAT feature wants C99 or later
72 typedef QWORD FSIZE_t
;
80 #error exFAT needs to be enabled when enable 64-bit LBA
82 typedef DWORD FSIZE_t
;
88 /* Type of path name strings on FatFs API (TCHAR) */
90 #if FF_USE_LFN && FF_LFN_UNICODE == 1 /* Unicode in UTF-16 encoding */
93 #define _TEXT(x) L ## x
94 #elif FF_USE_LFN && FF_LFN_UNICODE == 2 /* Unicode in UTF-8 encoding */
97 #define _TEXT(x) u8 ## x
98 #elif FF_USE_LFN && FF_LFN_UNICODE == 3 /* Unicode in UTF-32 encoding */
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 */
112 /* Definitions of volume management */
114 #if FF_MULTI_PARTITION /* Multiple partition configuration */
116 BYTE pd
; /* Physical drive number */
117 BYTE pt
; /* Partition: 0:Auto detect, 1-4:Forced partition) */
119 extern PARTITION VolToPart
[]; /* Volume - Partition mapping table */
123 #ifndef FF_VOLUME_STRS
124 extern const char* VolumeStr
[FF_VOLUMES
]; /* User defied volume ID */
130 /* Filesystem object structure (FATFS) */
133 BYTE fs_type
; /* Filesystem type (0:not mounted) */
134 BYTE pdrv
; /* Volume hosting physical drive */
135 BYTE ldrv
; /* Logical drive number (used only when FF_FS_REENTRANT) */
136 BYTE n_fats
; /* Number of FATs (1 or 2) */
137 BYTE wflag
; /* win[] status (b0:dirty) */
138 BYTE fsi_flag
; /* FSINFO status (b7:disabled, b0:dirty) */
139 WORD id
; /* Volume mount ID */
140 WORD n_rootdir
; /* Number of root directory entries (FAT12/16) */
141 WORD csize
; /* Cluster size [sectors] */
142 #if FF_MAX_SS != FF_MIN_SS
143 WORD ssize
; /* Sector size (512, 1024, 2048 or 4096) */
146 WCHAR
* lfnbuf
; /* LFN working buffer */
149 BYTE
* dirbuf
; /* Directory entry block scratchpad buffer for exFAT */
152 DWORD last_clst
; /* Last allocated cluster */
153 DWORD free_clst
; /* Number of free clusters */
156 DWORD cdir
; /* Current directory start cluster (0:root) */
158 DWORD cdc_scl
; /* Containing directory start cluster (invalid when cdir is 0) */
159 DWORD cdc_size
; /* b31-b8:Size of containing directory, b7-b0: Chain status */
160 DWORD cdc_ofs
; /* Offset in the containing directory (invalid when cdir is 0) */
163 DWORD n_fatent
; /* Number of FAT entries (number of clusters + 2) */
164 DWORD fsize
; /* Number of sectors per FAT */
165 LBA_t volbase
; /* Volume base sector */
166 LBA_t fatbase
; /* FAT base sector */
167 LBA_t dirbase
; /* Root directory base sector (FAT12/16) or cluster (FAT32/exFAT) */
168 LBA_t database
; /* Data base sector */
170 LBA_t bitbase
; /* Allocation bitmap base sector */
172 LBA_t winsect
; /* Current sector appearing in the win[] */
173 BYTE win
[FF_MAX_SS
]; /* Disk access window for Directory, FAT (and file data at tiny cfg) */
178 /* Object ID and allocation information (FFOBJID) */
181 FATFS
* fs
; /* Pointer to the hosting volume of this object */
182 WORD id
; /* Hosting volume's mount ID */
183 BYTE attr
; /* Object attribute */
184 BYTE stat
; /* Object chain status (b1-0: =0:not contiguous, =2:contiguous, =3:fragmented in this session, b2:sub-directory stretched) */
185 DWORD sclust
; /* Object data start cluster (0:no cluster or root directory) */
186 FSIZE_t objsize
; /* Object size (valid when sclust != 0) */
188 DWORD n_cont
; /* Size of first fragment - 1 (valid when stat == 3) */
189 DWORD n_frag
; /* Size of last fragment needs to be written to FAT (valid when not zero) */
190 DWORD c_scl
; /* Containing directory start cluster (valid when sclust != 0) */
191 DWORD c_size
; /* b31-b8:Size of containing directory, b7-b0: Chain status (valid when c_scl != 0) */
192 DWORD c_ofs
; /* Offset in the containing directory (valid when file object and sclust != 0) */
195 UINT lockid
; /* File lock ID origin from 1 (index of file semaphore table Files[]) */
201 /* File object structure (FIL) */
204 FFOBJID obj
; /* Object identifier (must be the 1st member to detect invalid object pointer) */
205 BYTE flag
; /* File status flags */
206 BYTE err
; /* Abort flag (error code) */
207 FSIZE_t fptr
; /* File read/write pointer (Zeroed on file open) */
208 DWORD clust
; /* Current cluster of fpter (invalid when fptr is 0) */
209 LBA_t sect
; /* Sector number appearing in buf[] (0:invalid) */
211 LBA_t dir_sect
; /* Sector number containing the directory entry (not used at exFAT) */
212 BYTE
* dir_ptr
; /* Pointer to the directory entry in the win[] (not used at exFAT) */
215 DWORD
* cltbl
; /* Pointer to the cluster link map table (nulled on open, set by application) */
218 BYTE buf
[FF_MAX_SS
]; /* File private data read/write window */
224 /* Directory object structure (DIR) */
227 FFOBJID obj
; /* Object identifier */
228 DWORD dptr
; /* Current read/write offset */
229 DWORD clust
; /* Current cluster */
230 LBA_t sect
; /* Current sector (0:Read operation has terminated) */
231 BYTE
* dir
; /* Pointer to the directory item in the win[] */
232 BYTE fn
[12]; /* SFN (in/out) {body[8],ext[3],status[1]} */
234 DWORD blk_ofs
; /* Offset of current entry block being processed (0xFFFFFFFF:Invalid) */
237 const TCHAR
* pat
; /* Pointer to the name matching pattern */
243 /* File information structure (FILINFO) */
246 FSIZE_t fsize
; /* File size */
247 WORD fdate
; /* Modified date */
248 WORD ftime
; /* Modified time */
249 BYTE fattrib
; /* File attribute */
251 TCHAR altname
[FF_SFN_BUF
+ 1];/* Alternative file name */
252 TCHAR fname
[FF_LFN_BUF
+ 1]; /* Primary file name */
254 TCHAR fname
[12 + 1]; /* File name */
260 /* Format parameter structure (MKFS_PARM) */
263 BYTE fmt
; /* Format option (FM_FAT, FM_FAT32, FM_EXFAT and FM_SFD) */
264 BYTE n_fat
; /* Number of FATs */
265 UINT align
; /* Data area alignment (sector) */
266 UINT n_root
; /* Number of root directory entries */
267 DWORD au_size
; /* Cluster size (byte) */
272 /* File function return code (FRESULT) */
275 FR_OK
= 0, /* (0) Succeeded */
276 FR_DISK_ERR
, /* (1) A hard error occurred in the low level disk I/O layer */
277 FR_INT_ERR
, /* (2) Assertion failed */
278 FR_NOT_READY
, /* (3) The physical drive cannot work */
279 FR_NO_FILE
, /* (4) Could not find the file */
280 FR_NO_PATH
, /* (5) Could not find the path */
281 FR_INVALID_NAME
, /* (6) The path name format is invalid */
282 FR_DENIED
, /* (7) Access denied due to prohibited access or directory full */
283 FR_EXIST
, /* (8) Access denied due to prohibited access */
284 FR_INVALID_OBJECT
, /* (9) The file/directory object is invalid */
285 FR_WRITE_PROTECTED
, /* (10) The physical drive is write protected */
286 FR_INVALID_DRIVE
, /* (11) The logical drive number is invalid */
287 FR_NOT_ENABLED
, /* (12) The volume has no work area */
288 FR_NO_FILESYSTEM
, /* (13) There is no valid FAT volume */
289 FR_MKFS_ABORTED
, /* (14) The f_mkfs() aborted due to any problem */
290 FR_TIMEOUT
, /* (15) Could not get a grant to access the volume within defined period */
291 FR_LOCKED
, /* (16) The operation is rejected according to the file sharing policy */
292 FR_NOT_ENOUGH_CORE
, /* (17) LFN working buffer could not be allocated */
293 FR_TOO_MANY_OPEN_FILES
, /* (18) Number of open files > FF_FS_LOCK */
294 FR_INVALID_PARAMETER
/* (19) Given parameter is invalid */
300 /*--------------------------------------------------------------*/
301 /* FatFs Module Application Interface */
302 /*--------------------------------------------------------------*/
304 FRESULT
f_open (FIL
* fp
, const TCHAR
* path
, BYTE mode
); /* Open or create a file */
305 FRESULT
f_close (FIL
* fp
); /* Close an open file object */
306 FRESULT
f_read (FIL
* fp
, void* buff
, UINT btr
, UINT
* br
); /* Read data from the file */
307 FRESULT
f_write (FIL
* fp
, const void* buff
, UINT btw
, UINT
* bw
); /* Write data to the file */
308 FRESULT
f_lseek (FIL
* fp
, FSIZE_t ofs
); /* Move file pointer of the file object */
309 FRESULT
f_truncate (FIL
* fp
); /* Truncate the file */
310 FRESULT
f_sync (FIL
* fp
); /* Flush cached data of the writing file */
311 FRESULT
f_opendir (DIR* dp
, const TCHAR
* path
); /* Open a directory */
312 FRESULT
f_closedir (DIR* dp
); /* Close an open directory */
313 FRESULT
f_readdir (DIR* dp
, FILINFO
* fno
); /* Read a directory item */
314 FRESULT
f_findfirst (DIR* dp
, FILINFO
* fno
, const TCHAR
* path
, const TCHAR
* pattern
); /* Find first file */
315 FRESULT
f_findnext (DIR* dp
, FILINFO
* fno
); /* Find next file */
316 FRESULT
f_mkdir (const TCHAR
* path
); /* Create a sub directory */
317 FRESULT
f_unlink (const TCHAR
* path
); /* Delete an existing file or directory */
318 FRESULT
f_rename (const TCHAR
* path_old
, const TCHAR
* path_new
); /* Rename/Move a file or directory */
319 FRESULT
f_stat (const TCHAR
* path
, FILINFO
* fno
); /* Get file status */
320 FRESULT
f_chmod (const TCHAR
* path
, BYTE attr
, BYTE mask
); /* Change attribute of a file/dir */
321 FRESULT
f_utime (const TCHAR
* path
, const FILINFO
* fno
); /* Change timestamp of a file/dir */
322 FRESULT
f_chdir (const TCHAR
* path
); /* Change current directory */
323 FRESULT
f_chdrive (const TCHAR
* path
); /* Change current drive */
324 FRESULT
f_getcwd (TCHAR
* buff
, UINT len
); /* Get current directory */
325 FRESULT
f_getfree (const TCHAR
* path
, DWORD
* nclst
, FATFS
** fatfs
); /* Get number of free clusters on the drive */
326 FRESULT
f_getlabel (const TCHAR
* path
, TCHAR
* label
, DWORD
* vsn
); /* Get volume label */
327 FRESULT
f_setlabel (const TCHAR
* label
); /* Set volume label */
328 FRESULT
f_forward (FIL
* fp
, UINT(*func
)(const BYTE
*,UINT
), UINT btf
, UINT
* bf
); /* Forward data to the stream */
329 FRESULT
f_expand (FIL
* fp
, FSIZE_t fsz
, BYTE opt
); /* Allocate a contiguous block to the file */
330 FRESULT
f_mount (FATFS
* fs
, const TCHAR
* path
, BYTE opt
); /* Mount/Unmount a logical drive */
331 FRESULT
f_mkfs (const TCHAR
* path
, const MKFS_PARM
* opt
, void* work
, UINT len
); /* Create a FAT volume */
332 FRESULT
f_fdisk (BYTE pdrv
, const LBA_t ptbl
[], void* work
); /* Divide a physical drive into some partitions */
333 FRESULT
f_setcp (WORD cp
); /* Set current code page */
334 int f_putc (TCHAR c
, FIL
* fp
); /* Put a character to the file */
335 int f_puts (const TCHAR
* str
, FIL
* cp
); /* Put a string to the file */
336 int f_printf (FIL
* fp
, const TCHAR
* str
, ...); /* Put a formatted string to the file */
337 TCHAR
* f_gets (TCHAR
* buff
, int len
, FIL
* fp
); /* Get a string from the file */
339 /* Some API fucntions are implemented as macro */
341 #define f_eof(fp) ((int)((fp)->fptr == (fp)->obj.objsize))
342 #define f_error(fp) ((fp)->err)
343 #define f_tell(fp) ((fp)->fptr)
344 #define f_size(fp) ((fp)->obj.objsize)
345 #define f_rewind(fp) f_lseek((fp), 0)
346 #define f_rewinddir(dp) f_readdir((dp), 0)
347 #define f_rmdir(path) f_unlink(path)
348 #define f_unmount(path) f_mount(0, path, 0)
353 /*--------------------------------------------------------------*/
354 /* Additional Functions */
355 /*--------------------------------------------------------------*/
357 /* RTC function (provided by user) */
358 #if !FF_FS_READONLY && !FF_FS_NORTC
359 DWORD
get_fattime (void); /* Get current time */
363 /* LFN support functions (defined in ffunicode.c) */
366 WCHAR
ff_oem2uni (WCHAR oem
, WORD cp
); /* OEM code to Unicode conversion */
367 WCHAR
ff_uni2oem (DWORD uni
, WORD cp
); /* Unicode to OEM code conversion */
368 DWORD
ff_wtoupper (DWORD uni
); /* Unicode upper-case conversion */
372 /* O/S dependent functions (samples available in ffsystem.c) */
374 #if FF_USE_LFN == 3 /* Dynamic memory allocation */
375 void* ff_memalloc (UINT msize
); /* Allocate memory block */
376 void ff_memfree (void* mblock
); /* Free memory block */
378 #if FF_FS_REENTRANT /* Sync functions */
379 int ff_mutex_create (int vol
); /* Create a sync object */
380 void ff_mutex_delete (int vol
); /* Delete a sync object */
381 int ff_mutex_take (int vol
); /* Lock sync object */
382 void ff_mutex_give (int vol
); /* Unlock sync object */
388 /*--------------------------------------------------------------*/
389 /* Flags and Offset Address */
390 /*--------------------------------------------------------------*/
392 /* File access mode and open method flags (3rd argument of f_open) */
394 #define FA_WRITE 0x02
395 #define FA_OPEN_EXISTING 0x00
396 #define FA_CREATE_NEW 0x04
397 #define FA_CREATE_ALWAYS 0x08
398 #define FA_OPEN_ALWAYS 0x10
399 #define FA_OPEN_APPEND 0x30
401 /* Fast seek controls (2nd argument of f_lseek) */
402 #define CREATE_LINKMAP ((FSIZE_t)0 - 1)
404 /* Format options (2nd argument of f_mkfs) */
406 #define FM_FAT32 0x02
407 #define FM_EXFAT 0x04
411 /* Filesystem type (FATFS.fs_type) */
417 /* File attribute bits for directory entry (FILINFO.fattrib) */
418 #define AM_RDO 0x01 /* Read only */
419 #define AM_HID 0x02 /* Hidden */
420 #define AM_SYS 0x04 /* System */
421 #define AM_DIR 0x10 /* Directory */
422 #define AM_ARC 0x20 /* Archive */
429 #endif /* FF_DEFINED */