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 /----------------------------------------------------------------------------*/
28 #define _WORD_ACCESS 0
29 /* The _WORD_ACCESS option defines which access method is used to the word
30 / data in the FAT structure.
32 / 0: Byte-by-byte access. Always compatible with all platforms.
33 / 1: Word access. Do not choose this unless following condition is met.
35 / When the byte order on the memory is big-endian or address miss-aligned
36 / word access results incorrect behavior, the _WORD_ACCESS must be set to 0.
37 / If it is not the case, the value can also be set to 1 to improve the
38 / performance and code efficiency. */
41 #define _FS_READONLY 0
42 /* Setting _FS_READONLY to 1 defines read only configuration. This removes
43 / writing functions, f_write, f_sync, f_unlink, f_mkdir, f_chmod, f_rename,
44 / f_truncate and useless f_getfree. */
47 #define _FS_MINIMIZE 0
48 /* The _FS_MINIMIZE option defines minimization level to remove some functions.
51 / 1: f_stat, f_getfree, f_unlink, f_mkdir, f_chmod, f_truncate and f_rename
53 / 2: f_opendir and f_readdir are removed in addition to level 1.
54 / 3: f_lseek is removed in addition to level 2. */
58 /* When _FS_TINY is set to 1, FatFs uses the sector buffer in the file system
59 / object instead of the sector buffer in the individual file object for file
60 / data transfer. This reduces memory consumption 512 bytes each file object. */
63 #define _USE_STRFUNC 0
64 /* To enable string functions, set _USE_STRFUNC to 1 or 2. */
68 /* To enable f_mkfs function, set _USE_MKFS to 1 and set _FS_READONLY to 0 */
71 #define _USE_FORWARD 0
72 /* To enable f_forward function, set _USE_FORWARD to 1 and set _FS_TINY to 1. */
76 /* Number of volumes (logical drives) to be used. */
80 /* Maximum sector size to be handled. (512/1024/2048/4096) */
81 /* 512 for memroy card and hard disk, 1024 for floppy disk, 2048 for MO disk */
84 #define _MULTI_PARTITION 0
85 /* When _MULTI_PARTITION is set to 0, each volume is bound to the same physical
86 / drive number and can mount only first primaly partition. When it is set to 1,
87 / each volume is tied to the partitions listed in Drives[]. */
90 #define _CODE_PAGE 932
91 /* The _CODE_PAGE specifies the OEM code page to be used on the target system.
92 / When it is non LFN configuration, there is no difference between SBCS code
93 / pages. When LFN is enabled, the code page must always be set correctly.
98 / 850 - Multilingual Latin 1
102 / 858 - Multilingual Latin 1 + Euro
106 / 932 - Japanese Shift-JIS (DBCS)
107 / 936 - Simplified Chinese GBK (DBCS)
108 / 949 - Korean (DBCS)
109 / 950 - Traditional Chinese Big5 (DBCS)
115 #define _MAX_LFN 255 /* Maximum LFN length to handle (max:255) */
116 /* The _USE_LFN option switches the LFN support.
119 / 1: Enable LFN with static working buffer on the bss. NOT REENTRANT.
120 / 2: Enable LFN with dynamic working buffer on the caller's STACK.
122 / The working buffer occupies (_MAX_LFN + 1) * 2 bytes. When enable LFN,
123 / a Unicode - OEM code conversion function ff_convert() must be added to
127 #define _FS_REENTRANT 0
128 #define _TIMEOUT 1000 /* Timeout period in unit of time ticks */
129 #define _SYNC_t HANDLE /* Type of sync object used on the OS. */
130 /* e.g. HANDLE, OS_EVENT*, ID and etc.. */
131 /* To make the FatFs module re-entrant, set _FS_REENTRANT to 1 and add user
132 / provided synchronization handlers, ff_req_grant, ff_rel_grant,
133 / ff_del_syncobj and ff_cre_syncobj function to the project. */
137 /* End of configuration options. Do not change followings without care. */
138 /*--------------------------------------------------------------------------*/
142 /* Definitions corresponds to multiple sector size */
147 #if _MAX_SS == 1024 || _MAX_SS == 2048 || _MAX_SS == 4096
148 #define SS(fs) ((fs)->s_size)
150 #error Sector size must be 512, 1024, 2048 or 4096.
156 /* File system object structure */
158 typedef struct _FATFS {
159 BYTE fs_type; /* FAT sub type */
160 BYTE drive; /* Physical drive number */
161 BYTE csize; /* Number of sectors per cluster */
162 BYTE n_fats; /* Number of FAT copies */
163 BYTE wflag; /* win[] dirty flag (1:must be written back) */
165 WORD id; /* File system mount ID */
166 WORD n_rootdir; /* Number of root directory entries (0 on FAT32) */
168 _SYNC_t sobj; /* Identifier of sync object */
171 WORD s_size; /* Sector size */
174 BYTE fsi_flag; /* fsinfo dirty flag (1:must be written back) */
176 DWORD last_clust; /* Last allocated cluster */
177 DWORD free_clust; /* Number of free clusters */
178 DWORD fsi_sector; /* fsinfo sector */
180 DWORD sects_fat; /* Sectors per fat */
181 DWORD max_clust; /* Maximum cluster# + 1. Number of clusters is max_clust - 2 */
182 DWORD fatbase; /* FAT start sector */
183 DWORD dirbase; /* Root directory start sector (Cluster# on FAT32) */
184 DWORD database; /* Data start sector */
185 DWORD winsect; /* Current sector appearing in the win[] */
186 BYTE win[_MAX_SS];/* Disk access window for Directory/FAT */
191 /* Directory object structure */
193 typedef struct _DIR {
194 WORD id; /* Owner file system mount ID */
195 WORD index; /* Current index number */
196 FATFS* fs; /* Pointer to the owner file system object */
197 DWORD sclust; /* Table start cluster (0:Static table) */
198 DWORD clust; /* Current cluster */
199 DWORD sect; /* Current sector */
200 BYTE* dir; /* Pointer to the current SFN entry in the win[] */
201 BYTE* fn; /* Pointer to the SFN (in/out) {file[8],ext[3],status[1]} */
203 WCHAR* lfn; /* Pointer to the LFN working buffer */
204 WORD lfn_idx; /* Last matched LFN index (0xFFFF:No LFN) */
210 /* File object structure */
212 typedef struct _FIL {
213 FATFS* fs; /* Pointer to the owner file system object */
214 WORD id; /* Owner file system mount ID */
215 BYTE flag; /* File status flags */
216 BYTE csect; /* Sector address in the cluster */
217 DWORD fptr; /* File R/W pointer */
218 DWORD fsize; /* File size */
219 DWORD org_clust; /* File start cluster */
220 DWORD curr_clust; /* Current cluster */
221 DWORD dsect; /* Current data sector */
223 DWORD dir_sect; /* Sector containing the directory entry */
224 BYTE* dir_ptr; /* Ponter to the directory entry in the window */
227 BYTE buf[_MAX_SS];/* File R/W buffer */
233 /* File status structure */
235 typedef struct _FILINFO {
236 DWORD fsize; /* File size */
237 WORD fdate; /* Last modified date */
238 WORD ftime; /* Last modified time */
239 BYTE fattrib; /* Attribute */
240 char fname[13]; /* Short file name (8.3 format) */
242 char *lfname; /* Pointer to the LFN buffer */
243 int lfsize; /* Size of LFN buffer [bytes] */
249 /* DBCS code ranges */
251 #if _CODE_PAGE == 932 /* CP932 (Japanese Shift-JIS) */
252 #define _DF1S 0x81 /* DBC 1st byte range 1 start */
253 #define _DF1E 0x9F /* DBC 1st byte range 1 end */
254 #define _DF2S 0xE0 /* DBC 1st byte range 2 start */
255 #define _DF2E 0xFC /* DBC 1st byte range 2 end */
256 #define _DS1S 0x40 /* DBC 2nd byte range 1 start */
257 #define _DS1E 0x7E /* DBC 2nd byte range 1 end */
258 #define _DS2S 0x80 /* DBC 2nd byte range 2 start */
259 #define _DS2E 0xFC /* DBC 2nd byte range 2 end */
261 #elif _CODE_PAGE == 936 /* CP936 (Simplified Chinese GBK) */
269 #elif _CODE_PAGE == 949 /* CP949 (Korean) */
279 #elif _CODE_PAGE == 950 /* CP950 (Traditional Chinese Big5) */
287 #else /* SBCS code pages */
294 /* Character code support macros */
296 #define IsUpper(c) (((c)>='A')&&((c)<='Z'))
297 #define IsLower(c) (((c)>='a')&&((c)<='z'))
298 #define IsDigit(c) (((c)>='0')&&((c)<='9'))
300 #if _DF1S /* DBCS configuration */
302 #if _DF2S /* Two 1st byte areas */
303 #define IsDBCS1(c) (((BYTE)(c) >= _DF1S && (BYTE)(c) <= _DF1E) || ((BYTE)(c) >= _DF2S && (BYTE)(c) <= _DF2E))
304 #else /* One 1st byte area */
305 #define IsDBCS1(c) ((BYTE)(c) >= _DF1S && (BYTE)(c) <= _DF1E)
308 #if _DS3S /* Three 2nd byte areas */
309 #define IsDBCS2(c) (((BYTE)(c) >= _DS1S && (BYTE)(c) <= _DS1E) || ((BYTE)(c) >= _DS2S && (BYTE)(c) <= _DS2E) || ((BYTE)(c) >= _DS3S && (BYTE)(c) <= _DS3E))
310 #else /* Two 2nd byte areas */
311 #define IsDBCS2(c) (((BYTE)(c) >= _DS1S && (BYTE)(c) <= _DS1E) || ((BYTE)(c) >= _DS2S && (BYTE)(c) <= _DS2E))
314 #else /* SBCS configuration */
323 /* Definitions corresponds to multi partition */
325 #if _MULTI_PARTITION /* Multiple partition configuration */
327 typedef struct _PARTITION {
328 BYTE pd; /* Physical drive# */
329 BYTE pt; /* Partition # (0-3) */
333 const PARTITION Drives[]; /* Logical drive# to physical location conversion table */
334 #define LD2PD(drv) (Drives[drv].pd) /* Get physical drive# */
335 #define LD2PT(drv) (Drives[drv].pt) /* Get partition# */
337 #else /* Single partition configuration */
339 #define LD2PD(drv) (drv) /* Physical drive# is equal to the logical drive# */
340 #define LD2PT(drv) 0 /* Always mounts the 1st partition */
346 /* File function return code (FRESULT) */
352 FR_NOT_READY, /* 3 */
355 FR_INVALID_NAME, /* 6 */
358 FR_INVALID_OBJECT, /* 9 */
359 FR_WRITE_PROTECTED, /* 10 */
360 FR_INVALID_DRIVE, /* 11 */
361 FR_NOT_ENABLED, /* 12 */
362 FR_NO_FILESYSTEM, /* 13 */
363 FR_MKFS_ABORTED, /* 14 */
369 /*--------------------------------------------------------------*/
370 /* FatFs module application interface */
372 FRESULT f_mount (BYTE, FATFS*); /* Mount/Unmount a logical drive */
373 FRESULT f_open (FIL*, const char*, BYTE); /* Open or create a file */
374 FRESULT f_read (FIL*, void*, UINT, UINT*); /* Read data from a file */
375 FRESULT f_write (FIL*, const void*, UINT, UINT*); /* Write data to a file */
376 FRESULT f_lseek (FIL*, DWORD); /* Move file pointer of a file object */
377 FRESULT f_close (FIL*); /* Close an open file object */
378 FRESULT f_opendir (DIR*, const char*); /* Open an existing directory */
379 FRESULT f_readdir (DIR*, FILINFO*); /* Read a directory item */
380 FRESULT f_stat (const char*, FILINFO*); /* Get file status */
381 FRESULT f_getfree (const char*, DWORD*, FATFS**); /* Get number of free clusters on the drive */
382 FRESULT f_truncate (FIL*); /* Truncate file */
383 FRESULT f_sync (FIL*); /* Flush cached data of a writing file */
384 FRESULT f_unlink (const char*); /* Delete an existing file or directory */
385 FRESULT f_mkdir (const char*); /* Create a new directory */
386 FRESULT f_chmod (const char*, BYTE, BYTE); /* Change attriburte of the file/dir */
387 FRESULT f_utime (const char*, const FILINFO*); /* Change timestamp of the file/dir */
388 FRESULT f_rename (const char*, const char*); /* Rename/Move a file or directory */
389 FRESULT f_forward (FIL*, UINT(*)(const BYTE*,UINT), UINT, UINT*); /* Forward data to the stream */
390 FRESULT f_mkfs (BYTE, BYTE, WORD); /* Create a file system on the drive */
393 int f_putc (int, FIL*); /* Put a character to the file */
394 int f_puts (const char*, FIL*); /* Put a string to the file */
395 int f_printf (FIL*, const char*, ...); /* Put a formatted string to the file */
396 char* f_gets (char*, int, FIL*); /* Get a string from the file */
397 #define f_eof(fp) (((fp)->fptr == (fp)->fsize) ? 1 : 0)
398 #define f_error(fp) (((fp)->flag & FA__ERROR) ? 1 : 0)
406 /*--------------------------------------------------------------*/
407 /* User defined functions */
409 /* Real time clock */
411 DWORD get_fattime (void); /* 31-25: Year(0-127 org.1980), 24-21: Month(1-12), 20-16: Day(1-31) */
412 /* 15-11: Hour(0-23), 10-5: Minute(0-59), 4-0: Second(0-29 *2) */
415 /* Unicode - OEM code conversion */
417 WCHAR ff_convert (WCHAR, UINT);
422 BOOL ff_cre_syncobj(BYTE, _SYNC_t*);
423 BOOL ff_del_syncobj(_SYNC_t);
424 BOOL ff_req_grant(_SYNC_t);
425 void ff_rel_grant(_SYNC_t);
430 /*--------------------------------------------------------------*/
431 /* Flags and offset address */
434 /* File access control and file status flags (FIL.flag) */
437 #define FA_OPEN_EXISTING 0x00
438 #if _FS_READONLY == 0
439 #define FA_WRITE 0x02
440 #define FA_CREATE_NEW 0x04
441 #define FA_CREATE_ALWAYS 0x08
442 #define FA_OPEN_ALWAYS 0x10
443 #define FA__WRITTEN 0x20
444 #define FA__DIRTY 0x40
446 #define FA__ERROR 0x80
449 /* FAT sub type (FATFS.fs_type) */
456 /* File attribute bits for directory entry */
458 #define AM_RDO 0x01 /* Read only */
459 #define AM_HID 0x02 /* Hidden */
460 #define AM_SYS 0x04 /* System */
461 #define AM_VOL 0x08 /* Volume label */
462 #define AM_LFN 0x0F /* LFN entry */
463 #define AM_DIR 0x10 /* Directory */
464 #define AM_ARC 0x20 /* Archive */
465 #define AM_MASK 0x3F /* Mask of defined bits */
468 /* FatFs refers the members in the FAT structures with byte offset instead
469 / of structure member because there are incompatibility of the packing option
470 / between various compilers. */
474 #define BPB_BytsPerSec 11
475 #define BPB_SecPerClus 13
476 #define BPB_RsvdSecCnt 14
477 #define BPB_NumFATs 16
478 #define BPB_RootEntCnt 17
479 #define BPB_TotSec16 19
481 #define BPB_FATSz16 22
482 #define BPB_SecPerTrk 24
483 #define BPB_NumHeads 26
484 #define BPB_HiddSec 28
485 #define BPB_TotSec32 32
489 #define BS_BootSig 38
492 #define BS_FilSysType 54
494 #define BPB_FATSz32 36
495 #define BPB_ExtFlags 40
497 #define BPB_RootClus 44
498 #define BPB_FSInfo 48
499 #define BPB_BkBootSec 50
500 #define BS_DrvNum32 64
501 #define BS_BootSig32 66
502 #define BS_VolID32 67
503 #define BS_VolLab32 71
504 #define BS_FilSysType32 82
506 #define FSI_LeadSig 0
507 #define FSI_StrucSig 484
508 #define FSI_Free_Count 488
509 #define FSI_Nxt_Free 492
511 #define MBR_Table 446
516 #define DIR_CrtTime 14
517 #define DIR_CrtDate 16
518 #define DIR_FstClusHI 20
519 #define DIR_WrtTime 22
520 #define DIR_WrtDate 24
521 #define DIR_FstClusLO 26
522 #define DIR_FileSize 28
526 #define LDIR_Chksum 13
527 #define LDIR_FstClusLO 26
531 /*--------------------------------*/
532 /* Multi-byte word access macros */
534 #if _WORD_ACCESS == 1 /* Enable word access to the FAT structure */
535 #define LD_WORD(ptr) (WORD)(*(WORD*)(BYTE*)(ptr))
536 #define LD_DWORD(ptr) (DWORD)(*(DWORD*)(BYTE*)(ptr))
537 #define ST_WORD(ptr,val) *(WORD*)(BYTE*)(ptr)=(WORD)(val)
538 #define ST_DWORD(ptr,val) *(DWORD*)(BYTE*)(ptr)=(DWORD)(val)
539 #else /* Use byte-by-byte access to the FAT structure */
540 #define LD_WORD(ptr) (WORD)(((WORD)*(BYTE*)((ptr)+1)<<8)|(WORD)*(BYTE*)(ptr))
541 #define LD_DWORD(ptr) (DWORD)(((DWORD)*(BYTE*)((ptr)+3)<<24)|((DWORD)*(BYTE*)((ptr)+2)<<16)|((WORD)*(BYTE*)((ptr)+1)<<8)|*(BYTE*)(ptr))
542 #define ST_WORD(ptr,val) *(BYTE*)(ptr)=(BYTE)(val); *(BYTE*)((ptr)+1)=(BYTE)((WORD)(val)>>8)
543 #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)