1 /*---------------------------------------------------------------------------/
2 / FatFs - FAT file system module include file R0.07a (C)ChaN, 2009
3 /----------------------------------------------------------------------------/
4 / FatFs module is an open source software to implement FAT file system to
5 / small embedded systems. This is a free software and is opened for education,
6 / research and commercial developments under license policy of following trems.
8 / Copyright (C) 2009, ChaN, all right reserved.
10 / * The FatFs module is a free software and there is NO WARRANTY.
11 / * No restriction on use. You can use, modify and redistribute it for
12 / personal, non-profit or commercial use UNDER YOUR RESPONSIBILITY.
13 / * Redistributions of source code must retain the above copyright notice.
14 /----------------------------------------------------------------------------*/
18 /*---------------------------------------------------------------------------/
19 / FatFs Configuration Options
21 / CAUTION! Do not forget to make clean the project after any changes to
22 / the configuration options.
24 /----------------------------------------------------------------------------*/
29 #define _WORD_ACCESS 0
31 /* The _WORD_ACCESS option defines which access method is used to the word
32 / data in the FAT structure.
34 / 0: Byte-by-byte access. Always compatible with all platforms.
35 / 1: Word access. Do not choose this unless following condition is met.
37 / When the byte order on the memory is big-endian or address miss-aligned
38 / word access results incorrect behavior, the _WORD_ACCESS must be set to 0.
39 / If it is not the case, the value can also be set to 1 to improve the
40 / performance and code efficiency. */
43 #define _FS_READONLY 0
45 /* Setting _FS_READONLY to 1 defines read only configuration. This removes
46 / writing functions, f_write, f_sync, f_unlink, f_mkdir, f_chmod, f_rename,
47 / f_truncate and useless f_getfree. */
50 #define _FS_MINIMIZE 0
52 /* The _FS_MINIMIZE option defines minimization level to remove some functions.
55 / 1: f_stat, f_getfree, f_unlink, f_mkdir, f_chmod, f_truncate and f_rename
57 / 2: f_opendir and f_readdir are removed in addition to level 1.
58 / 3: f_lseek is removed in addition to level 2. */
63 /* When _FS_TINY is set to 1, FatFs uses the sector buffer in the file system
64 / object instead of the sector buffer in the individual file object for file
65 / data transfer. This reduces memory consumption 512 bytes each file object. */
68 #define _USE_STRFUNC 0
70 /* To enable string functions, set _USE_STRFUNC to 1 or 2. */
75 /* To enable f_mkfs function, set _USE_MKFS to 1 and set _FS_READONLY to 0 */
79 #define _USE_FORWARD 0
81 /* To enable f_forward function, set _USE_FORWARD to 1 and set _FS_TINY to 1. */
87 /* Number of volumes (logical drives) to be used. */
92 /* Maximum sector size to be handled. (512/1024/2048/4096) */
93 /* 512 for memroy card and hard disk, 1024 for floppy disk, 2048 for MO disk */
95 #ifndef _MULTI_PARTITION
96 #define _MULTI_PARTITION 0
98 /* When _MULTI_PARTITION is set to 0, each volume is bound to the same physical
99 / drive number and can mount only first primaly partition. When it is set to 1,
100 / each volume is tied to the partitions listed in Drives[]. */
103 #define _CODE_PAGE 932
105 /* The _CODE_PAGE specifies the OEM code page to be used on the target system.
106 / When it is non LFN configuration, there is no difference between SBCS code
107 / pages. When LFN is enabled, the code page must always be set correctly.
112 / 850 - Multilingual Latin 1
116 / 858 - Multilingual Latin 1 + Euro
120 / 932 - Japanese Shift-JIS (DBCS)
121 / 936 - Simplified Chinese GBK (DBCS)
122 / 949 - Korean (DBCS)
123 / 950 - Traditional Chinese Big5 (DBCS)
131 #define _MAX_LFN 255 /* Maximum LFN length to handle (max:255) */
133 /* The _USE_LFN option switches the LFN support.
136 / 1: Enable LFN with static working buffer on the bss. NOT REENTRANT.
137 / 2: Enable LFN with dynamic working buffer on the caller's STACK.
139 / The working buffer occupies (_MAX_LFN + 1) * 2 bytes. When enable LFN,
140 / a Unicode - OEM code conversion function ff_convert() must be added to
143 #ifndef _FS_REENTRANT
144 #define _FS_REENTRANT 0
147 #define _TIMEOUT 1000 /* Timeout period in unit of time ticks */
150 #define _SYNC_t HANDLE /* Type of sync object used on the OS. */
151 /* e.g. HANDLE, OS_EVENT*, ID and etc.. */
153 /* To make the FatFs module re-entrant, set _FS_REENTRANT to 1 and add user
154 / provided synchronization handlers, ff_req_grant, ff_rel_grant,
155 / ff_del_syncobj and ff_cre_syncobj function to the project. */
159 /* End of configuration options. Do not change followings without care. */
160 /*--------------------------------------------------------------------------*/
164 /* Definitions corresponds to multiple sector size */
169 #if _MAX_SS == 1024 || _MAX_SS == 2048 || _MAX_SS == 4096
170 #define SS(fs) ((fs)->s_size)
172 #error Sector size must be 512, 1024, 2048 or 4096.
178 /* File system object structure */
180 typedef struct _FATFS {
181 BYTE fs_type; /* FAT sub type */
182 BYTE drive; /* Physical drive number */
183 BYTE csize; /* Number of sectors per cluster */
184 BYTE n_fats; /* Number of FAT copies */
185 BYTE wflag; /* win[] dirty flag (1:must be written back) */
187 WORD id; /* File system mount ID */
188 WORD n_rootdir; /* Number of root directory entries (0 on FAT32) */
190 _SYNC_t sobj; /* Identifier of sync object */
193 WORD s_size; /* Sector size */
196 BYTE fsi_flag; /* fsinfo dirty flag (1:must be written back) */
198 DWORD last_clust; /* Last allocated cluster */
199 DWORD free_clust; /* Number of free clusters */
200 DWORD fsi_sector; /* fsinfo sector */
202 DWORD sects_fat; /* Sectors per fat */
203 DWORD max_clust; /* Maximum cluster# + 1. Number of clusters is max_clust - 2 */
204 DWORD fatbase; /* FAT start sector */
205 DWORD dirbase; /* Root directory start sector (Cluster# on FAT32) */
206 DWORD database; /* Data start sector */
207 DWORD winsect; /* Current sector appearing in the win[] */
208 BYTE win[_MAX_SS];/* Disk access window for Directory/FAT */
213 /* Directory object structure */
215 typedef struct _DIR {
216 WORD id; /* Owner file system mount ID */
217 WORD index; /* Current index number */
218 FATFS* fs; /* Pointer to the owner file system object */
219 DWORD sclust; /* Table start cluster (0:Static table) */
220 DWORD clust; /* Current cluster */
221 DWORD sect; /* Current sector */
222 BYTE* dir; /* Pointer to the current SFN entry in the win[] */
223 BYTE* fn; /* Pointer to the SFN (in/out) {file[8],ext[3],status[1]} */
225 WCHAR* lfn; /* Pointer to the LFN working buffer */
226 WORD lfn_idx; /* Last matched LFN index (0xFFFF:No LFN) */
232 /* File object structure */
234 typedef struct _FIL {
235 FATFS* fs; /* Pointer to the owner file system object */
236 WORD id; /* Owner file system mount ID */
237 BYTE flag; /* File status flags */
238 BYTE csect; /* Sector address in the cluster */
239 DWORD fptr; /* File R/W pointer */
240 DWORD fsize; /* File size */
241 DWORD org_clust; /* File start cluster */
242 DWORD curr_clust; /* Current cluster */
243 DWORD dsect; /* Current data sector */
245 DWORD dir_sect; /* Sector containing the directory entry */
246 BYTE* dir_ptr; /* Ponter to the directory entry in the window */
249 BYTE buf[_MAX_SS];/* File R/W buffer */
255 /* File status structure */
257 typedef struct _FILINFO {
258 DWORD fsize; /* File size */
259 WORD fdate; /* Last modified date */
260 WORD ftime; /* Last modified time */
261 BYTE fattrib; /* Attribute */
262 char fname[13]; /* Short file name (8.3 format) */
264 char *lfname; /* Pointer to the LFN buffer */
265 int lfsize; /* Size of LFN buffer [bytes] */
271 /* DBCS code ranges */
273 #if _CODE_PAGE == 932 /* CP932 (Japanese Shift-JIS) */
274 #define _DF1S 0x81 /* DBC 1st byte range 1 start */
275 #define _DF1E 0x9F /* DBC 1st byte range 1 end */
276 #define _DF2S 0xE0 /* DBC 1st byte range 2 start */
277 #define _DF2E 0xFC /* DBC 1st byte range 2 end */
278 #define _DS1S 0x40 /* DBC 2nd byte range 1 start */
279 #define _DS1E 0x7E /* DBC 2nd byte range 1 end */
280 #define _DS2S 0x80 /* DBC 2nd byte range 2 start */
281 #define _DS2E 0xFC /* DBC 2nd byte range 2 end */
283 #elif _CODE_PAGE == 936 /* CP936 (Simplified Chinese GBK) */
291 #elif _CODE_PAGE == 949 /* CP949 (Korean) */
301 #elif _CODE_PAGE == 950 /* CP950 (Traditional Chinese Big5) */
309 #else /* SBCS code pages */
316 /* Character code support macros */
318 #define IsUpper(c) (((c)>='A')&&((c)<='Z'))
319 #define IsLower(c) (((c)>='a')&&((c)<='z'))
320 #define IsDigit(c) (((c)>='0')&&((c)<='9'))
322 #if _DF1S /* DBCS configuration */
324 #if _DF2S /* Two 1st byte areas */
325 #define IsDBCS1(c) (((BYTE)(c) >= _DF1S && (BYTE)(c) <= _DF1E) || ((BYTE)(c) >= _DF2S && (BYTE)(c) <= _DF2E))
326 #else /* One 1st byte area */
327 #define IsDBCS1(c) ((BYTE)(c) >= _DF1S && (BYTE)(c) <= _DF1E)
330 #if _DS3S /* Three 2nd byte areas */
331 #define IsDBCS2(c) (((BYTE)(c) >= _DS1S && (BYTE)(c) <= _DS1E) || ((BYTE)(c) >= _DS2S && (BYTE)(c) <= _DS2E) || ((BYTE)(c) >= _DS3S && (BYTE)(c) <= _DS3E))
332 #else /* Two 2nd byte areas */
333 #define IsDBCS2(c) (((BYTE)(c) >= _DS1S && (BYTE)(c) <= _DS1E) || ((BYTE)(c) >= _DS2S && (BYTE)(c) <= _DS2E))
336 #else /* SBCS configuration */
345 /* Definitions corresponds to multi partition */
347 #if _MULTI_PARTITION /* Multiple partition configuration */
349 typedef struct _PARTITION {
350 BYTE pd; /* Physical drive# */
351 BYTE pt; /* Partition # (0-3) */
355 const PARTITION Drives[]; /* Logical drive# to physical location conversion table */
356 #define LD2PD(drv) (Drives[drv].pd) /* Get physical drive# */
357 #define LD2PT(drv) (Drives[drv].pt) /* Get partition# */
359 #else /* Single partition configuration */
361 #define LD2PD(drv) (drv) /* Physical drive# is equal to the logical drive# */
362 #define LD2PT(drv) 0 /* Always mounts the 1st partition */
368 /* File function return code (FRESULT) */
374 FR_NOT_READY, /* 3 */
377 FR_INVALID_NAME, /* 6 */
380 FR_INVALID_OBJECT, /* 9 */
381 FR_WRITE_PROTECTED, /* 10 */
382 FR_INVALID_DRIVE, /* 11 */
383 FR_NOT_ENABLED, /* 12 */
384 FR_NO_FILESYSTEM, /* 13 */
385 FR_MKFS_ABORTED, /* 14 */
391 /*--------------------------------------------------------------*/
392 /* FatFs module application interface */
394 FRESULT f_mount (BYTE, FATFS*); /* Mount/Unmount a logical drive */
395 FRESULT f_open (FIL*, const char*, BYTE); /* Open or create a file */
396 FRESULT f_read (FIL*, void*, UINT, UINT*); /* Read data from a file */
397 FRESULT f_write (FIL*, const void*, UINT, UINT*); /* Write data to a file */
398 FRESULT f_lseek (FIL*, DWORD); /* Move file pointer of a file object */
399 FRESULT f_close (FIL*); /* Close an open file object */
400 FRESULT f_opendir (DIR*, const char*); /* Open an existing directory */
401 FRESULT f_readdir (DIR*, FILINFO*); /* Read a directory item */
402 FRESULT f_stat (const char*, FILINFO*); /* Get file status */
403 FRESULT f_getfree (const char*, DWORD*, FATFS**); /* Get number of free clusters on the drive */
404 FRESULT f_truncate (FIL*); /* Truncate file */
405 FRESULT f_sync (FIL*); /* Flush cached data of a writing file */
406 FRESULT f_unlink (const char*); /* Delete an existing file or directory */
407 FRESULT f_mkdir (const char*); /* Create a new directory */
408 FRESULT f_chmod (const char*, BYTE, BYTE); /* Change attriburte of the file/dir */
409 FRESULT f_utime (const char*, const FILINFO*); /* Change timestamp of the file/dir */
410 FRESULT f_rename (const char*, const char*); /* Rename/Move a file or directory */
411 FRESULT f_forward (FIL*, UINT(*)(const BYTE*,UINT), UINT, UINT*); /* Forward data to the stream */
412 FRESULT f_mkfs (BYTE, BYTE, WORD); /* Create a file system on the drive */
415 int f_putc (int, FIL*); /* Put a character to the file */
416 int f_puts (const char*, FIL*); /* Put a string to the file */
417 int f_printf (FIL*, const char*, ...); /* Put a formatted string to the file */
418 char* f_gets (char*, int, FIL*); /* Get a string from the file */
419 #define f_eof(fp) (((fp)->fptr == (fp)->fsize) ? 1 : 0)
420 #define f_error(fp) (((fp)->flag & FA__ERROR) ? 1 : 0)
428 /*--------------------------------------------------------------*/
429 /* User defined functions */
431 /* Real time clock */
433 DWORD get_fattime (void); /* 31-25: Year(0-127 org.1980), 24-21: Month(1-12), 20-16: Day(1-31) */
434 /* 15-11: Hour(0-23), 10-5: Minute(0-59), 4-0: Second(0-29 *2) */
437 /* Unicode - OEM code conversion */
439 WCHAR ff_convert (WCHAR, UINT);
444 BOOL ff_cre_syncobj(BYTE, _SYNC_t*);
445 BOOL ff_del_syncobj(_SYNC_t);
446 BOOL ff_req_grant(_SYNC_t);
447 void ff_rel_grant(_SYNC_t);
452 /*--------------------------------------------------------------*/
453 /* Flags and offset address */
456 /* File access control and file status flags (FIL.flag) */
459 #define FA_OPEN_EXISTING 0x00
460 #if _FS_READONLY == 0
461 #define FA_WRITE 0x02
462 #define FA_CREATE_NEW 0x04
463 #define FA_CREATE_ALWAYS 0x08
464 #define FA_OPEN_ALWAYS 0x10
465 #define FA__WRITTEN 0x20
466 #define FA__DIRTY 0x40
468 #define FA__ERROR 0x80
471 /* FAT sub type (FATFS.fs_type) */
478 /* File attribute bits for directory entry */
480 #define AM_RDO 0x01 /* Read only */
481 #define AM_HID 0x02 /* Hidden */
482 #define AM_SYS 0x04 /* System */
483 #define AM_VOL 0x08 /* Volume label */
484 #define AM_LFN 0x0F /* LFN entry */
485 #define AM_DIR 0x10 /* Directory */
486 #define AM_ARC 0x20 /* Archive */
487 #define AM_MASK 0x3F /* Mask of defined bits */
490 /* FatFs refers the members in the FAT structures with byte offset instead
491 / of structure member because there are incompatibility of the packing option
492 / between various compilers. */
496 #define BPB_BytsPerSec 11
497 #define BPB_SecPerClus 13
498 #define BPB_RsvdSecCnt 14
499 #define BPB_NumFATs 16
500 #define BPB_RootEntCnt 17
501 #define BPB_TotSec16 19
503 #define BPB_FATSz16 22
504 #define BPB_SecPerTrk 24
505 #define BPB_NumHeads 26
506 #define BPB_HiddSec 28
507 #define BPB_TotSec32 32
511 #define BS_BootSig 38
514 #define BS_FilSysType 54
516 #define BPB_FATSz32 36
517 #define BPB_ExtFlags 40
519 #define BPB_RootClus 44
520 #define BPB_FSInfo 48
521 #define BPB_BkBootSec 50
522 #define BS_DrvNum32 64
523 #define BS_BootSig32 66
524 #define BS_VolID32 67
525 #define BS_VolLab32 71
526 #define BS_FilSysType32 82
528 #define FSI_LeadSig 0
529 #define FSI_StrucSig 484
530 #define FSI_Free_Count 488
531 #define FSI_Nxt_Free 492
533 #define MBR_Table 446
538 #define DIR_CrtTime 14
539 #define DIR_CrtDate 16
540 #define DIR_FstClusHI 20
541 #define DIR_WrtTime 22
542 #define DIR_WrtDate 24
543 #define DIR_FstClusLO 26
544 #define DIR_FileSize 28
548 #define LDIR_Chksum 13
549 #define LDIR_FstClusLO 26
553 /*--------------------------------*/
554 /* Multi-byte word access macros */
556 #if _WORD_ACCESS == 1 /* Enable word access to the FAT structure */
557 #define LD_WORD(ptr) (WORD)(*(WORD*)(BYTE*)(ptr))
558 #define LD_DWORD(ptr) (DWORD)(*(DWORD*)(BYTE*)(ptr))
559 #define ST_WORD(ptr,val) *(WORD*)(BYTE*)(ptr)=(WORD)(val)
560 #define ST_DWORD(ptr,val) *(DWORD*)(BYTE*)(ptr)=(DWORD)(val)
561 #else /* Use byte-by-byte access to the FAT structure */
562 #define LD_WORD(ptr) (WORD)(((WORD)*(BYTE*)((ptr)+1)<<8)|(WORD)*(BYTE*)(ptr))
563 #define LD_DWORD(ptr) (DWORD)(((DWORD)*(BYTE*)((ptr)+3)<<24)|((DWORD)*(BYTE*)((ptr)+2)<<16)|((WORD)*(BYTE*)((ptr)+1)<<8)|*(BYTE*)(ptr))
564 #define ST_WORD(ptr,val) *(BYTE*)(ptr)=(BYTE)(val); *(BYTE*)((ptr)+1)=(BYTE)((WORD)(val)>>8)
565 #define ST_DWORD(ptr,val) *(BYTE*)(ptr)=(BYTE)(val); *(BYTE*)((ptr)+1)=(BYTE)((WORD)(val)>>8); *(BYTE*)((ptr)+2)=(BYTE)((DWORD)(val)>>16); *(BYTE*)((ptr)+3)=(BYTE)((DWORD)(val)>>24)