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