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