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