ff.h 15 KB

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