Get an mbed!  
Blog | Forum | Handbook | Cookbook | Notebooks | Compiler
Projects » libraries

svn / FATFileSystem / trunk / ff.h

Revision 16, 11.6 kB (checked in by rolf.meyer@…, 3 years ago)

Finaly the FATFileSystem works on both targets ;-)
Sorry for the delay.

Line 
1/*--------------------------------------------------------------------------/
2/  FatFs - FAT file system module include file  R0.06        (C)ChaN, 2008
3/---------------------------------------------------------------------------/
4/ FatFs module is an experimenal project to implement FAT file system to
5/ cheap microcontrollers. This is a free software and is opened for education,
6/ research and development under license policy of following trems.
7/
8/  Copyright (C) 2008, ChaN, all right reserved.
9/
10/ * The FatFs module is a free software and there is no warranty.
11/ * You can use, modify and/or redistribute it for personal, non-profit or
12/   commercial use without any restriction under your responsibility.
13/ * Redistributions of source code must retain the above copyright notice.
14/
15/---------------------------------------------------------------------------*/
16
17#ifndef _FATFS
18
19#define _MCU_ENDIAN     2
20/* The _MCU_ENDIAN defines which access method is used to the FAT structure.
21/  1: Enable word access.
22/  2: Disable word access and use byte-by-byte access instead.
23/  When the architectural byte order of the MCU is big-endian and/or address
24/  miss-aligned access results incorrect behavior, the _MCU_ENDIAN must be set to 2.
25/  If it is not the case, it can also be set to 1 for good code efficiency. */
26
27#define _FS_READONLY    0
28/* Setting _FS_READONLY to 1 defines read only configuration. This removes
29/  writing functions, f_write, f_sync, f_unlink, f_mkdir, f_chmod, f_rename,
30/  f_truncate and useless f_getfree. */
31
32#define _FS_MINIMIZE    0
33/* The _FS_MINIMIZE option defines minimization level to remove some functions.
34/  0: Full function.
35/  1: f_stat, f_getfree, f_unlink, f_mkdir, f_chmod, f_truncate and f_rename are removed.
36/  2: f_opendir and f_readdir are removed in addition to level 1.
37/  3: f_lseek is removed in addition to level 2. */
38
39#define _USE_STRFUNC    0
40/* To enable string functions, set _USE_STRFUNC to 1 or 2. */
41
42#define _USE_MKFS   1
43/* When _USE_MKFS is set to 1 and _FS_READONLY is set to 0, f_mkfs function is
44/  enabled. */
45
46#define _DRIVES     4
47/* Number of logical drives to be used. This affects the size of internal table. */
48
49#define _MULTI_PARTITION    0
50/* When _MULTI_PARTITION is set to 0, each logical drive is bound to same
51/  physical drive number and can mount only 1st primaly partition. When it is
52/  set to 1, each logical drive can mount a partition listed in Drives[]. */
53
54#define _USE_FSINFO 0
55/* To enable FSInfo support on FAT32 volume, set _USE_FSINFO to 1. */
56
57#define _USE_SJIS   1
58/* When _USE_SJIS is set to 1, Shift-JIS code transparency is enabled, otherwise
59/  only US-ASCII(7bit) code can be accepted as file/directory name. */
60
61#define _USE_NTFLAG 1
62/* When _USE_NTFLAG is set to 1, upper/lower case of the file name is preserved.
63/  Note that the files are always accessed in case insensitive. */
64
65
66#include "integer.h"
67
68#ifdef __cplusplus
69extern "C" {
70#endif
71
72/* Definitions corresponds to multiple sector size (not tested) */
73#define S_MAX_SIZ   512U            /* Do not change */
74#if S_MAX_SIZ > 512U
75#define SS(fs)  ((fs)->s_size)
76#else
77#define SS(fs)  512U
78#endif
79
80
81/* File system object structure */
82typedef struct _FATFS {
83    WORD    id;             /* File system mount ID */
84    WORD    n_rootdir;      /* Number of root directory entries */
85    DWORD   winsect;        /* Current sector appearing in the win[] */
86    DWORD   sects_fat;      /* Sectors per fat */
87    DWORD   max_clust;      /* Maximum cluster# + 1 */
88    DWORD   fatbase;        /* FAT start sector */
89    DWORD   dirbase;        /* Root directory start sector (cluster# for FAT32) */
90    DWORD   database;       /* Data start sector */
91#if !_FS_READONLY
92    DWORD   last_clust;     /* Last allocated cluster */
93    DWORD   free_clust;     /* Number of free clusters */
94#if _USE_FSINFO
95    DWORD   fsi_sector;     /* fsinfo sector */
96    BYTE    fsi_flag;       /* fsinfo dirty flag (1:must be written back) */
97    BYTE    pad2;
98#endif
99#endif
100    BYTE    fs_type;        /* FAT sub type */
101    BYTE    csize;          /* Number of sectors per cluster */
102#if S_MAX_SIZ > 512U
103    WORD    s_size;         /* Sector size */
104#endif
105    BYTE    n_fats;         /* Number of FAT copies */
106    BYTE    drive;          /* Physical drive number */
107    BYTE    winflag;        /* win[] dirty flag (1:must be written back) */
108    BYTE    pad1;
109    BYTE    win[S_MAX_SIZ]; /* Disk access window for Directory/FAT */
110} FATFS;
111
112
113/* Directory object structure */
114typedef struct _DIR {
115    WORD    id;         /* Owner file system mount ID */
116    WORD    index;      /* Current index */
117    FATFS*  fs;         /* Pointer to the owner file system object */
118    DWORD   sclust;     /* Start cluster */
119    DWORD   clust;      /* Current cluster */
120    DWORD   sect;       /* Current sector */
121} FATFS_DIR;
122
123
124/* File object structure */
125typedef struct _FIL {
126    WORD    id;             /* Owner file system mount ID */
127    BYTE    flag;           /* File status flags */
128    BYTE    csect;          /* Sector address in the cluster */
129    FATFS*  fs;             /* Pointer to the owner file system object */
130    DWORD   fptr;           /* File R/W pointer */
131    DWORD   fsize;          /* File size */
132    DWORD   org_clust;      /* File start cluster */
133    DWORD   curr_clust;     /* Current cluster */
134    DWORD   curr_sect;      /* Current sector */
135#if _FS_READONLY == 0
136    DWORD   dir_sect;       /* Sector containing the directory entry */
137    BYTE*   dir_ptr;        /* Ponter to the directory entry in the window */
138#endif
139    BYTE    buffer[S_MAX_SIZ];  /* File R/W buffer */
140} FIL;
141
142
143/* File status structure */
144typedef struct _FILINFO {
145    DWORD fsize;            /* Size */
146    WORD fdate;             /* Date */
147    WORD ftime;             /* Time */
148    BYTE fattrib;           /* Attribute */
149    char fname[8+1+3+1];    /* Name (8.3 format) */
150} FILINFO;
151
152
153
154/* Definitions corresponds to multi partition */
155
156#if _MULTI_PARTITION != 0   /* Multiple partition cfg */
157
158typedef struct _PARTITION {
159    BYTE pd;    /* Physical drive # (0-255) */
160    BYTE pt;    /* Partition # (0-3) */
161} PARTITION;
162extern
163const PARTITION Drives[];           /* Logical drive# to physical location conversion table */
164#define LD2PD(drv) (Drives[drv].pd) /* Get physical drive# */
165#define LD2PT(drv) (Drives[drv].pt) /* Get partition# */
166
167#else                       /* Single partition cfg */
168
169#define LD2PD(drv) (drv)        /* Physical drive# is equal to logical drive# */
170#define LD2PT(drv) 0            /* Always mounts the 1st partition */
171
172#endif
173
174
175/* File function return code (FRESULT) */
176
177typedef enum {
178    FR_OK = 0,          /* 0 */
179    FR_NOT_READY,       /* 1 */
180    FR_NO_FILE,         /* 2 */
181    FR_NO_PATH,         /* 3 */
182    FR_INVALID_NAME,    /* 4 */
183    FR_INVALID_DRIVE,   /* 5 */
184    FR_DENIED,          /* 6 */
185    FR_EXIST,           /* 7 */
186    FR_RW_ERROR,        /* 8 */
187    FR_WRITE_PROTECTED, /* 9 */
188    FR_NOT_ENABLED,     /* 10 */
189    FR_NO_FILESYSTEM,   /* 11 */
190    FR_INVALID_OBJECT,  /* 12 */
191    FR_MKFS_ABORTED     /* 13 */
192} FRESULT;
193
194
195
196/*-----------------------------------------------------*/
197/* FatFs module application interface                  */
198
199FRESULT f_mount (BYTE, FATFS*);                     /* Mount/Unmount a logical drive */
200FRESULT f_open (FIL*, const char*, BYTE);           /* Open or create a file */
201FRESULT f_read (FIL*, void*, UINT, UINT*);          /* Read data from a file */
202FRESULT f_write (FIL*, const void*, UINT, UINT*);   /* Write data to a file */
203FRESULT f_lseek (FIL*, DWORD);                      /* Move file pointer of a file object */
204FRESULT f_close (FIL*);                             /* Close an open file object */
205FRESULT f_opendir (FATFS_DIR*, const char*);                /* Open an existing directory */
206FRESULT f_readdir (FATFS_DIR*, FILINFO*);                   /* Read a directory item */
207FRESULT f_stat (const char*, FILINFO*);             /* Get file status */
208FRESULT f_getfree (const char*, DWORD*, FATFS**);   /* Get number of free clusters on the drive */
209FRESULT f_truncate (FIL*);                          /* Truncate file */
210FRESULT f_sync (FIL*);                              /* Flush cached data of a writing file */
211FRESULT f_unlink (const char*);                     /* Delete an existing file or directory */
212FRESULT f_mkdir (const char*);                      /* Create a new directory */
213FRESULT f_chmod (const char*, BYTE, BYTE);          /* Change file/dir attriburte */
214FRESULT f_utime (const char*, const FILINFO*);      /* Change file/dir timestamp */
215FRESULT f_rename (const char*, const char*);        /* Rename/Move a file or directory */
216FRESULT f_mkfs (BYTE, BYTE, WORD);                  /* Create a file system on the drive */
217#if _USE_STRFUNC
218#define feof(fp) ((fp)->fptr == (fp)->fsize)
219#define EOF -1
220int fputc (int, FIL*);                              /* Put a character to the file */
221int fputs (const char*, FIL*);                      /* Put a string to the file */
222int fprintf (FIL*, const char*, ...);               /* Put a formatted string to the file */
223char* fgets (char*, int, FIL*);                     /* Get a string from the file */
224#endif
225
226/* User defined function to give a current time to fatfs module */
227
228DWORD get_fattime (void);   /* 31-25: Year(0-127 org.1980), 24-21: Month(1-12), 20-16: Day(1-31) */
229                            /* 15-11: Hour(0-23), 10-5: Minute(0-59), 4-0: Second(0-29 *2) */
230
231
232
233/* File access control and file status flags (FIL.flag) */
234
235#define FA_READ             0x01
236#define FA_OPEN_EXISTING    0x00
237#if _FS_READONLY == 0
238#define FA_WRITE            0x02
239#define FA_CREATE_NEW       0x04
240#define FA_CREATE_ALWAYS    0x08
241#define FA_OPEN_ALWAYS      0x10
242#define FA__WRITTEN         0x20
243#define FA__DIRTY           0x40
244#endif
245#define FA__ERROR           0x80
246
247
248/* FAT sub type (FATFS.fs_type) */
249
250#define FS_FAT12    1
251#define FS_FAT16    2
252#define FS_FAT32    3
253
254
255/* File attribute bits for directory entry */
256
257#define AM_RDO  0x01    /* Read only */
258#define AM_HID  0x02    /* Hidden */
259#define AM_SYS  0x04    /* System */
260#define AM_VOL  0x08    /* Volume label */
261#define AM_LFN  0x0F    /* LFN entry */
262#define AM_DIR  0x10    /* Directory */
263#define AM_ARC  0x20    /* Archive */
264
265
266
267/* Offset of FAT structure members */
268
269#define BS_jmpBoot          0
270#define BS_OEMName          3
271#define BPB_BytsPerSec      11
272#define BPB_SecPerClus      13
273#define BPB_RsvdSecCnt      14
274#define BPB_NumFATs         16
275#define BPB_RootEntCnt      17
276#define BPB_TotSec16        19
277#define BPB_Media           21
278#define BPB_FATSz16         22
279#define BPB_SecPerTrk       24
280#define BPB_NumHeads        26
281#define BPB_HiddSec         28
282#define BPB_TotSec32        32
283#define BS_55AA             510
284
285#define BS_DrvNum           36
286#define BS_BootSig          38
287#define BS_VolID            39
288#define BS_VolLab           43
289#define BS_FilSysType       54
290
291#define BPB_FATSz32         36
292#define BPB_ExtFlags        40
293#define BPB_FSVer           42
294#define BPB_RootClus        44
295#define BPB_FSInfo          48
296#define BPB_BkBootSec       50
297#define BS_DrvNum32         64
298#define BS_BootSig32        66
299#define BS_VolID32          67
300#define BS_VolLab32         71
301#define BS_FilSysType32     82
302
303#define FSI_LeadSig         0
304#define FSI_StrucSig        484
305#define FSI_Free_Count      488
306#define FSI_Nxt_Free        492
307
308#define MBR_Table           446
309
310#define DIR_Name            0
311#define DIR_Attr            11
312#define DIR_NTres           12
313#define DIR_CrtTime         14
314#define DIR_CrtDate         16
315#define DIR_FstClusHI       20
316#define DIR_WrtTime         22
317#define DIR_WrtDate         24
318#define DIR_FstClusLO       26
319#define DIR_FileSize        28
320
321
322
323/* Multi-byte word access macros  */
324
325#if _MCU_ENDIAN == 1    /* Use word access */
326#define LD_WORD(ptr)        (WORD)(*(WORD*)(BYTE*)(ptr))
327#define LD_DWORD(ptr)       (DWORD)(*(DWORD*)(BYTE*)(ptr))
328#define ST_WORD(ptr,val)    *(WORD*)(BYTE*)(ptr)=(WORD)(val)
329#define ST_DWORD(ptr,val)   *(DWORD*)(BYTE*)(ptr)=(DWORD)(val)
330#elif _MCU_ENDIAN == 2  /* Use byte-by-byte access */
331#define LD_WORD(ptr)        (WORD)(((WORD)*(volatile BYTE*)((ptr)+1)<<8)|(WORD)*(volatile BYTE*)(ptr))
332#define LD_DWORD(ptr)       (DWORD)(((DWORD)*(volatile BYTE*)((ptr)+3)<<24)|((DWORD)*(volatile BYTE*)((ptr)+2)<<16)|((WORD)*(volatile BYTE*)((ptr)+1)<<8)|*(volatile BYTE*)(ptr))
333#define ST_WORD(ptr,val)    *(volatile BYTE*)(ptr)=(BYTE)(val); *(volatile BYTE*)((ptr)+1)=(BYTE)((WORD)(val)>>8)
334#define ST_DWORD(ptr,val)   *(volatile BYTE*)(ptr)=(BYTE)(val); *(volatile BYTE*)((ptr)+1)=(BYTE)((WORD)(val)>>8); *(volatile BYTE*)((ptr)+2)=(BYTE)((DWORD)(val)>>16); *(volatile BYTE*)((ptr)+3)=(BYTE)((DWORD)(val)>>24)
335#else
336#error Do not forget to set _MCU_ENDIAN properly!
337#endif
338
339#ifdef __cplusplus
340};
341#endif
342
343#define _FATFS
344#endif /* _FATFS */
Note: See TracBrowser for help on using the browser.