ff.h
1 /*----------------------------------------------------------------------------/ 2 / FatFs - Generic FAT Filesystem module R0.14 / 3 /-----------------------------------------------------------------------------/ 4 / 5 / Copyright (C) 2019, 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 86606 /* 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) /* Main development platform */ 39 #define FF_INTDEF 2 40 #include <windows.h> 41 typedef unsigned __int64 QWORD; 42 #elif (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || defined(__cplusplus) /* C99 or later */ 43 #define FF_INTDEF 2 44 #include <stdint.h> 45 typedef unsigned int UINT; /* int must be 16-bit or 32-bit */ 46 typedef unsigned char BYTE; /* char must be 8-bit */ 47 typedef uint16_t WORD; /* 16-bit unsigned integer */ 48 typedef uint32_t DWORD; /* 32-bit unsigned integer */ 49 typedef uint64_t QWORD; /* 64-bit unsigned integer */ 50 typedef WORD WCHAR; /* UTF-16 character type */ 51 #else /* Earlier than C99 */ 52 #define FF_INTDEF 1 53 typedef unsigned int UINT; /* int must be 16-bit or 32-bit */ 54 typedef unsigned char BYTE; /* char must be 8-bit */ 55 typedef unsigned short WORD; /* 16-bit unsigned integer */ 56 typedef unsigned long DWORD; /* 32-bit unsigned integer */ 57 typedef WORD WCHAR; /* UTF-16 character type */ 58 #endif 59 60 61 /* Definitions of volume management */ 62 63 #if FF_MULTI_PARTITION /* Multiple partition configuration */ 64 typedef struct { 65 BYTE pd; /* Physical drive number */ 66 BYTE pt; /* Partition: 0:Auto detect, 1-4:Forced partition) */ 67 } PARTITION; 68 extern PARTITION VolToPart[]; /* Volume - Partition mapping table */ 69 #endif 70 71 #if FF_STR_VOLUME_ID 72 #ifndef FF_VOLUME_STRS 73 extern const char* VolumeStr[FF_VOLUMES]; /* User defied volume ID */ 74 #endif 75 #endif 76 77 78 79 /* Type of path name strings on FatFs API */ 80 81 #ifndef _INC_TCHAR 82 #define _INC_TCHAR 83 84 #if FF_USE_LFN && FF_LFN_UNICODE == 1 /* Unicode in UTF-16 encoding */ 85 typedef WCHAR TCHAR; 86 #define _T(x) L ## x 87 #define _TEXT(x) L ## x 88 #elif FF_USE_LFN && FF_LFN_UNICODE == 2 /* Unicode in UTF-8 encoding */ 89 typedef char TCHAR; 90 #define _T(x) u8 ## x 91 #define _TEXT(x) u8 ## x 92 #elif FF_USE_LFN && FF_LFN_UNICODE == 3 /* Unicode in UTF-32 encoding */ 93 typedef DWORD TCHAR; 94 #define _T(x) U ## x 95 #define _TEXT(x) U ## x 96 #elif FF_USE_LFN && (FF_LFN_UNICODE < 0 || FF_LFN_UNICODE > 3) 97 #error Wrong FF_LFN_UNICODE setting 98 #else /* ANSI/OEM code in SBCS/DBCS */ 99 typedef char TCHAR; 100 #define _T(x) x 101 #define _TEXT(x) x 102 #endif 103 104 #endif 105 106 107 108 /* Type of file size and LBA variables */ 109 110 #if FF_FS_EXFAT 111 #if FF_INTDEF != 2 112 #error exFAT feature wants C99 or later 113 #endif 114 typedef QWORD FSIZE_t; 115 #if FF_LBA64 116 typedef QWORD LBA_t; 117 #else 118 typedef DWORD LBA_t; 119 #endif 120 #else 121 #if FF_LBA64 122 #error exFAT needs to be enabled when enable 64-bit LBA 123 #endif 124 typedef DWORD FSIZE_t; 125 typedef DWORD LBA_t; 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 BYTE win[FF_MAX_SS]; /* Disk access window for Directory, FAT (and file data at tiny cfg) */ 176 } FATFS; 177 178 179 180 /* Object ID and allocation information (FFOBJID) */ 181 182 typedef struct { 183 FATFS* fs; /* Pointer to the hosting volume of this object */ 184 WORD id; /* Hosting volume mount ID */ 185 BYTE attr; /* Object attribute */ 186 BYTE stat; /* Object chain status (b1-0: =0:not contiguous, =2:contiguous, =3:fragmented in this session, b2:sub-directory stretched) */ 187 DWORD sclust; /* Object data start cluster (0:no cluster or root directory) */ 188 FSIZE_t objsize; /* Object size (valid when sclust != 0) */ 189 #if FF_FS_EXFAT 190 DWORD n_cont; /* Size of first fragment - 1 (valid when stat == 3) */ 191 DWORD n_frag; /* Size of last fragment needs to be written to FAT (valid when not zero) */ 192 DWORD c_scl; /* Containing directory start cluster (valid when sclust != 0) */ 193 DWORD c_size; /* b31-b8:Size of containing directory, b7-b0: Chain status (valid when c_scl != 0) */ 194 DWORD c_ofs; /* Offset in the containing directory (valid when file object and sclust != 0) */ 195 #endif 196 #if FF_FS_LOCK 197 UINT lockid; /* File lock ID origin from 1 (index of file semaphore table Files[]) */ 198 #endif 199 } FFOBJID; 200 201 202 203 /* File object structure (FIL) */ 204 205 typedef struct { 206 FFOBJID obj; /* Object identifier (must be the 1st member to detect invalid object pointer) */ 207 BYTE flag; /* File status flags */ 208 BYTE err; /* Abort flag (error code) */ 209 FSIZE_t fptr; /* File read/write pointer (Zeroed on file open) */ 210 DWORD clust; /* Current cluster of fpter (invalid when fptr is 0) */ 211 LBA_t sect; /* Sector number appearing in buf[] (0:invalid) */ 212 #if !FF_FS_READONLY 213 LBA_t dir_sect; /* Sector number containing the directory entry (not used at exFAT) */ 214 BYTE* dir_ptr; /* Pointer to the directory entry in the win[] (not used at exFAT) */ 215 #endif 216 #if FF_USE_FASTSEEK 217 DWORD* cltbl; /* Pointer to the cluster link map table (nulled on open, set by application) */ 218 #endif 219 #if !FF_FS_TINY 220 BYTE buf[FF_MAX_SS]; /* File private data read/write window */ 221 #endif 222 } FIL; 223 224 225 226 /* Directory object structure (DIR) */ 227 228 typedef struct { 229 FFOBJID obj; /* Object identifier */ 230 DWORD dptr; /* Current read/write offset */ 231 DWORD clust; /* Current cluster */ 232 LBA_t sect; /* Current sector (0:Read operation has terminated) */ 233 BYTE* dir; /* Pointer to the directory item in the win[] */ 234 BYTE fn[12]; /* SFN (in/out) {body[8],ext[3],status[1]} */ 235 #if FF_USE_LFN 236 DWORD blk_ofs; /* Offset of current entry block being processed (0xFFFFFFFF:Invalid) */ 237 #endif 238 #if FF_USE_FIND 239 const TCHAR* pat; /* Pointer to the name matching pattern */ 240 #endif 241 } DIR; 242 243 244 245 /* File information structure (FILINFO) */ 246 247 typedef struct { 248 FSIZE_t fsize; /* File size */ 249 WORD fdate; /* Modified date */ 250 WORD ftime; /* Modified time */ 251 BYTE fattrib; /* File attribute */ 252 #if FF_USE_LFN 253 TCHAR altname[FF_SFN_BUF + 1];/* Altenative file name */ 254 TCHAR fname[FF_LFN_BUF + 1]; /* Primary file name */ 255 #else 256 TCHAR fname[12 + 1]; /* File name */ 257 #endif 258 } FILINFO; 259 260 261 262 /* Format parameter structure (MKFS_PARM) */ 263 264 typedef struct { 265 BYTE fmt; /* Format option (FM_FAT, FM_FAT32, FM_EXFAT and FM_SFD) */ 266 BYTE n_fat; /* Number of FATs */ 267 UINT align; /* Data area alignment (sector) */ 268 UINT n_root; /* Number of root directory entries */ 269 DWORD au_size; /* Cluster size (byte) */ 270 } MKFS_PARM; 271 272 273 274 /* File function return code (FRESULT) */ 275 276 typedef enum { 277 FR_OK = 0, /* (0) Succeeded */ 278 FR_DISK_ERR, /* (1) A hard error occurred in the low level disk I/O layer */ 279 FR_INT_ERR, /* (2) Assertion failed */ 280 FR_NOT_READY, /* (3) The physical drive cannot work */ 281 FR_NO_FILE, /* (4) Could not find the file */ 282 FR_NO_PATH, /* (5) Could not find the path */ 283 FR_INVALID_NAME, /* (6) The path name format is invalid */ 284 FR_DENIED, /* (7) Access denied due to prohibited access or directory full */ 285 FR_EXIST, /* (8) Access denied due to prohibited access */ 286 FR_INVALID_OBJECT, /* (9) The file/directory object is invalid */ 287 FR_WRITE_PROTECTED, /* (10) The physical drive is write protected */ 288 FR_INVALID_DRIVE, /* (11) The logical drive number is invalid */ 289 FR_NOT_ENABLED, /* (12) The volume has no work area */ 290 FR_NO_FILESYSTEM, /* (13) There is no valid FAT volume */ 291 FR_MKFS_ABORTED, /* (14) The f_mkfs() aborted due to any problem */ 292 FR_TIMEOUT, /* (15) Could not get a grant to access the volume within defined period */ 293 FR_LOCKED, /* (16) The operation is rejected according to the file sharing policy */ 294 FR_NOT_ENOUGH_CORE, /* (17) LFN working buffer could not be allocated */ 295 FR_TOO_MANY_OPEN_FILES, /* (18) Number of open files > FF_FS_LOCK */ 296 FR_INVALID_PARAMETER /* (19) Given parameter is invalid */ 297 } FRESULT; 298 299 300 301 /*--------------------------------------------------------------*/ 302 /* FatFs module application interface */ 303 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 */ 338 339 #define f_eof(fp) ((int)((fp)->fptr == (fp)->obj.objsize)) 340 #define f_error(fp) ((fp)->err) 341 #define f_tell(fp) ((fp)->fptr) 342 #define f_size(fp) ((fp)->obj.objsize) 343 #define f_rewind(fp) f_lseek((fp), 0) 344 #define f_rewinddir(dp) f_readdir((dp), 0) 345 #define f_rmdir(path) f_unlink(path) 346 #define f_unmount(path) f_mount(0, path, 0) 347 348 #ifndef EOF 349 #define EOF (-1) 350 #endif 351 352 353 354 355 /*--------------------------------------------------------------*/ 356 /* Additional user defined functions */ 357 358 /* RTC function */ 359 #if !FF_FS_READONLY && !FF_FS_NORTC 360 DWORD get_fattime (void); 361 #endif 362 363 /* LFN support functions */ 364 #if FF_USE_LFN >= 1 /* Code conversion (defined in unicode.c) */ 365 WCHAR ff_oem2uni (WCHAR oem, WORD cp); /* OEM code to Unicode conversion */ 366 WCHAR ff_uni2oem (DWORD uni, WORD cp); /* Unicode to OEM code conversion */ 367 DWORD ff_wtoupper (DWORD uni); /* Unicode upper-case conversion */ 368 #endif 369 #if FF_USE_LFN == 3 /* Dynamic memory allocation */ 370 void* ff_memalloc (UINT msize); /* Allocate memory block */ 371 void ff_memfree (void* mblock); /* Free memory block */ 372 #endif 373 374 /* Sync functions */ 375 #if FF_FS_REENTRANT 376 int ff_cre_syncobj (BYTE vol, FF_SYNC_t* sobj); /* Create a sync object */ 377 int ff_req_grant (FF_SYNC_t sobj); /* Lock sync object */ 378 void ff_rel_grant (FF_SYNC_t sobj); /* Unlock sync object */ 379 int ff_del_syncobj (FF_SYNC_t sobj); /* Delete a sync object */ 380 #endif 381 382 383 384 385 /*--------------------------------------------------------------*/ 386 /* Flags and offset address */ 387 388 389 /* File access mode and open method flags (3rd argument of f_open) */ 390 #define FA_READ 0x01 391 #define FA_WRITE 0x02 392 #define FA_OPEN_EXISTING 0x00 393 #define FA_CREATE_NEW 0x04 394 #define FA_CREATE_ALWAYS 0x08 395 #define FA_OPEN_ALWAYS 0x10 396 #define FA_OPEN_APPEND 0x30 397 398 /* Fast seek controls (2nd argument of f_lseek) */ 399 #define CREATE_LINKMAP ((FSIZE_t)0 - 1) 400 401 /* Format options (2nd argument of f_mkfs) */ 402 #define FM_FAT 0x01 403 #define FM_FAT32 0x02 404 #define FM_EXFAT 0x04 405 #define FM_ANY 0x07 406 #define FM_SFD 0x08 407 408 /* Filesystem type (FATFS.fs_type) */ 409 #define FS_FAT12 1 410 #define FS_FAT16 2 411 #define FS_FAT32 3 412 #define FS_EXFAT 4 413 414 /* File attribute bits for directory entry (FILINFO.fattrib) */ 415 #define AM_RDO 0x01 /* Read only */ 416 #define AM_HID 0x02 /* Hidden */ 417 #define AM_SYS 0x04 /* System */ 418 #define AM_DIR 0x10 /* Directory */ 419 #define AM_ARC 0x20 /* Archive */ 420 421 422 #ifdef __cplusplus 423 } 424 #endif 425 426 #endif /* FF_DEFINED */