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