Michael Spencer
/
LaOS
Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
FATFileSystem/ff.h@1:f5ac63519541, 2014-03-05 (annotated)
- Committer:
- Michael J. Spencer
- Date:
- Wed Mar 05 06:14:02 2014 -0800
- Revision:
- 1:f5ac63519541
Initial commit.
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| Michael J. Spencer |
1:f5ac63519541 | 1 | /*---------------------------------------------------------------------------/ |
| Michael J. Spencer |
1:f5ac63519541 | 2 | / FatFs - FAT file system module include file R0.09 (C)ChaN, 2011 |
| Michael J. Spencer |
1:f5ac63519541 | 3 | /----------------------------------------------------------------------------/ |
| Michael J. Spencer |
1:f5ac63519541 | 4 | / FatFs module is a generic FAT file system module for small embedded systems. |
| Michael J. Spencer |
1:f5ac63519541 | 5 | / This is a free software that opened for education, research and commercial |
| Michael J. Spencer |
1:f5ac63519541 | 6 | / developments under license policy of following trems. |
| Michael J. Spencer |
1:f5ac63519541 | 7 | / |
| Michael J. Spencer |
1:f5ac63519541 | 8 | / Copyright (C) 2011, ChaN, all right reserved. |
| Michael J. Spencer |
1:f5ac63519541 | 9 | / |
| Michael J. Spencer |
1:f5ac63519541 | 10 | / * The FatFs module is a free software and there is NO WARRANTY. |
| Michael J. Spencer |
1:f5ac63519541 | 11 | / * No restriction on use. You can use, modify and redistribute it for |
| Michael J. Spencer |
1:f5ac63519541 | 12 | / personal, non-profit or commercial product UNDER YOUR RESPONSIBILITY. |
| Michael J. Spencer |
1:f5ac63519541 | 13 | / * Redistributions of source code must retain the above copyright notice. |
| Michael J. Spencer |
1:f5ac63519541 | 14 | / |
| Michael J. Spencer |
1:f5ac63519541 | 15 | /----------------------------------------------------------------------------*/ |
| Michael J. Spencer |
1:f5ac63519541 | 16 | |
| Michael J. Spencer |
1:f5ac63519541 | 17 | #ifndef _FATFS |
| Michael J. Spencer |
1:f5ac63519541 | 18 | #define _FATFS 6502 /* Revision ID */ |
| Michael J. Spencer |
1:f5ac63519541 | 19 | |
| Michael J. Spencer |
1:f5ac63519541 | 20 | #ifdef __cplusplus |
| Michael J. Spencer |
1:f5ac63519541 | 21 | extern "C" { |
| Michael J. Spencer |
1:f5ac63519541 | 22 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 23 | |
| Michael J. Spencer |
1:f5ac63519541 | 24 | #include "integer.h" /* Basic integer types */ |
| Michael J. Spencer |
1:f5ac63519541 | 25 | #include "ffconf.h" /* FatFs configuration options */ |
| Michael J. Spencer |
1:f5ac63519541 | 26 | |
| Michael J. Spencer |
1:f5ac63519541 | 27 | #if _FATFS != _FFCONF |
| Michael J. Spencer |
1:f5ac63519541 | 28 | #error Wrong configuration file (ffconf.h). |
| Michael J. Spencer |
1:f5ac63519541 | 29 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 30 | |
| Michael J. Spencer |
1:f5ac63519541 | 31 | |
| Michael J. Spencer |
1:f5ac63519541 | 32 | |
| Michael J. Spencer |
1:f5ac63519541 | 33 | /* Definitions of volume management */ |
| Michael J. Spencer |
1:f5ac63519541 | 34 | |
| Michael J. Spencer |
1:f5ac63519541 | 35 | #if _MULTI_PARTITION /* Multiple partition configuration */ |
| Michael J. Spencer |
1:f5ac63519541 | 36 | typedef struct { |
| Michael J. Spencer |
1:f5ac63519541 | 37 | BYTE pd; /* Physical drive number */ |
| Michael J. Spencer |
1:f5ac63519541 | 38 | BYTE pt; /* Partition: 0:Auto detect, 1-4:Forced partition) */ |
| Michael J. Spencer |
1:f5ac63519541 | 39 | } PARTITION; |
| Michael J. Spencer |
1:f5ac63519541 | 40 | extern PARTITION VolToPart[]; /* Volume - Partition resolution table */ |
| Michael J. Spencer |
1:f5ac63519541 | 41 | #define LD2PD(vol) (VolToPart[vol].pd) /* Get physical drive number */ |
| Michael J. Spencer |
1:f5ac63519541 | 42 | #define LD2PT(vol) (VolToPart[vol].pt) /* Get partition index */ |
| Michael J. Spencer |
1:f5ac63519541 | 43 | |
| Michael J. Spencer |
1:f5ac63519541 | 44 | #else /* Single partition configuration */ |
| Michael J. Spencer |
1:f5ac63519541 | 45 | #define LD2PD(vol) (vol) /* Each logical drive is bound to the same physical drive number */ |
| Michael J. Spencer |
1:f5ac63519541 | 46 | #define LD2PT(vol) 0 /* Always mounts the 1st partition or in SFD */ |
| Michael J. Spencer |
1:f5ac63519541 | 47 | |
| Michael J. Spencer |
1:f5ac63519541 | 48 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 49 | |
| Michael J. Spencer |
1:f5ac63519541 | 50 | |
| Michael J. Spencer |
1:f5ac63519541 | 51 | |
| Michael J. Spencer |
1:f5ac63519541 | 52 | /* Type of path name strings on FatFs API */ |
| Michael J. Spencer |
1:f5ac63519541 | 53 | |
| Michael J. Spencer |
1:f5ac63519541 | 54 | #if _LFN_UNICODE /* Unicode string */ |
| Michael J. Spencer |
1:f5ac63519541 | 55 | #if !_USE_LFN |
| Michael J. Spencer |
1:f5ac63519541 | 56 | #error _LFN_UNICODE must be 0 in non-LFN cfg. |
| Michael J. Spencer |
1:f5ac63519541 | 57 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 58 | #ifndef _INC_TCHAR |
| Michael J. Spencer |
1:f5ac63519541 | 59 | typedef WCHAR TCHAR; |
| Michael J. Spencer |
1:f5ac63519541 | 60 | #define _T(x) L ## x |
| Michael J. Spencer |
1:f5ac63519541 | 61 | #define _TEXT(x) L ## x |
| Michael J. Spencer |
1:f5ac63519541 | 62 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 63 | |
| Michael J. Spencer |
1:f5ac63519541 | 64 | #else /* ANSI/OEM string */ |
| Michael J. Spencer |
1:f5ac63519541 | 65 | #ifndef _INC_TCHAR |
| Michael J. Spencer |
1:f5ac63519541 | 66 | typedef char TCHAR; |
| Michael J. Spencer |
1:f5ac63519541 | 67 | #define _T(x) x |
| Michael J. Spencer |
1:f5ac63519541 | 68 | #define _TEXT(x) x |
| Michael J. Spencer |
1:f5ac63519541 | 69 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 70 | |
| Michael J. Spencer |
1:f5ac63519541 | 71 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 72 | |
| Michael J. Spencer |
1:f5ac63519541 | 73 | |
| Michael J. Spencer |
1:f5ac63519541 | 74 | |
| Michael J. Spencer |
1:f5ac63519541 | 75 | /* File system object structure (FATFS) */ |
| Michael J. Spencer |
1:f5ac63519541 | 76 | |
| Michael J. Spencer |
1:f5ac63519541 | 77 | typedef struct { |
| Michael J. Spencer |
1:f5ac63519541 | 78 | BYTE fs_type; /* FAT sub-type (0:Not mounted) */ |
| Michael J. Spencer |
1:f5ac63519541 | 79 | BYTE drv; /* Physical drive number */ |
| Michael J. Spencer |
1:f5ac63519541 | 80 | BYTE csize; /* Sectors per cluster (1,2,4...128) */ |
| Michael J. Spencer |
1:f5ac63519541 | 81 | BYTE n_fats; /* Number of FAT copies (1,2) */ |
| Michael J. Spencer |
1:f5ac63519541 | 82 | BYTE wflag; /* win[] dirty flag (1:must be written back) */ |
| Michael J. Spencer |
1:f5ac63519541 | 83 | BYTE fsi_flag; /* fsinfo dirty flag (1:must be written back) */ |
| Michael J. Spencer |
1:f5ac63519541 | 84 | WORD id; /* File system mount ID */ |
| Michael J. Spencer |
1:f5ac63519541 | 85 | WORD n_rootdir; /* Number of root directory entries (FAT12/16) */ |
| Michael J. Spencer |
1:f5ac63519541 | 86 | #if _MAX_SS != 512 |
| Michael J. Spencer |
1:f5ac63519541 | 87 | WORD ssize; /* Bytes per sector (512, 1024, 2048 or 4096) */ |
| Michael J. Spencer |
1:f5ac63519541 | 88 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 89 | #if _FS_REENTRANT |
| Michael J. Spencer |
1:f5ac63519541 | 90 | _SYNC_t sobj; /* Identifier of sync object */ |
| Michael J. Spencer |
1:f5ac63519541 | 91 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 92 | #if !_FS_READONLY |
| Michael J. Spencer |
1:f5ac63519541 | 93 | DWORD last_clust; /* Last allocated cluster */ |
| Michael J. Spencer |
1:f5ac63519541 | 94 | DWORD free_clust; /* Number of free clusters */ |
| Michael J. Spencer |
1:f5ac63519541 | 95 | DWORD fsi_sector; /* fsinfo sector (FAT32) */ |
| Michael J. Spencer |
1:f5ac63519541 | 96 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 97 | #if _FS_RPATH |
| Michael J. Spencer |
1:f5ac63519541 | 98 | DWORD cdir; /* Current directory start cluster (0:root) */ |
| Michael J. Spencer |
1:f5ac63519541 | 99 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 100 | DWORD n_fatent; /* Number of FAT entries (= number of clusters + 2) */ |
| Michael J. Spencer |
1:f5ac63519541 | 101 | DWORD fsize; /* Sectors per FAT */ |
| Michael J. Spencer |
1:f5ac63519541 | 102 | DWORD fatbase; /* FAT start sector */ |
| Michael J. Spencer |
1:f5ac63519541 | 103 | DWORD dirbase; /* Root directory start sector (FAT32:Cluster#) */ |
| Michael J. Spencer |
1:f5ac63519541 | 104 | DWORD database; /* Data start sector */ |
| Michael J. Spencer |
1:f5ac63519541 | 105 | DWORD winsect; /* Current sector appearing in the win[] */ |
| Michael J. Spencer |
1:f5ac63519541 | 106 | BYTE win[_MAX_SS]; /* Disk access window for Directory, FAT (and Data on tiny cfg) */ |
| Michael J. Spencer |
1:f5ac63519541 | 107 | } FATFS; |
| Michael J. Spencer |
1:f5ac63519541 | 108 | |
| Michael J. Spencer |
1:f5ac63519541 | 109 | |
| Michael J. Spencer |
1:f5ac63519541 | 110 | |
| Michael J. Spencer |
1:f5ac63519541 | 111 | /* File object structure (FIL) */ |
| Michael J. Spencer |
1:f5ac63519541 | 112 | |
| Michael J. Spencer |
1:f5ac63519541 | 113 | typedef struct { |
| Michael J. Spencer |
1:f5ac63519541 | 114 | FATFS* fs; /* Pointer to the owner file system object */ |
| Michael J. Spencer |
1:f5ac63519541 | 115 | WORD id; /* Owner file system mount ID */ |
| Michael J. Spencer |
1:f5ac63519541 | 116 | BYTE flag; /* File status flags */ |
| Michael J. Spencer |
1:f5ac63519541 | 117 | BYTE pad1; |
| Michael J. Spencer |
1:f5ac63519541 | 118 | DWORD fptr; /* File read/write pointer (0 on file open) */ |
| Michael J. Spencer |
1:f5ac63519541 | 119 | DWORD fsize; /* File size */ |
| Michael J. Spencer |
1:f5ac63519541 | 120 | DWORD sclust; /* File start cluster (0 when fsize==0) */ |
| Michael J. Spencer |
1:f5ac63519541 | 121 | DWORD clust; /* Current cluster */ |
| Michael J. Spencer |
1:f5ac63519541 | 122 | DWORD dsect; /* Current data sector */ |
| Michael J. Spencer |
1:f5ac63519541 | 123 | #if !_FS_READONLY |
| Michael J. Spencer |
1:f5ac63519541 | 124 | DWORD dir_sect; /* Sector containing the directory entry */ |
| Michael J. Spencer |
1:f5ac63519541 | 125 | BYTE* dir_ptr; /* Ponter to the directory entry in the window */ |
| Michael J. Spencer |
1:f5ac63519541 | 126 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 127 | #if _USE_FASTSEEK |
| Michael J. Spencer |
1:f5ac63519541 | 128 | DWORD* cltbl; /* Pointer to the cluster link map table (null on file open) */ |
| Michael J. Spencer |
1:f5ac63519541 | 129 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 130 | #if _FS_SHARE |
| Michael J. Spencer |
1:f5ac63519541 | 131 | UINT lockid; /* File lock ID (index of file semaphore table) */ |
| Michael J. Spencer |
1:f5ac63519541 | 132 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 133 | #if !_FS_TINY |
| Michael J. Spencer |
1:f5ac63519541 | 134 | BYTE buf[_MAX_SS]; /* File data read/write buffer */ |
| Michael J. Spencer |
1:f5ac63519541 | 135 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 136 | } FIL; |
| Michael J. Spencer |
1:f5ac63519541 | 137 | |
| Michael J. Spencer |
1:f5ac63519541 | 138 | |
| Michael J. Spencer |
1:f5ac63519541 | 139 | |
| Michael J. Spencer |
1:f5ac63519541 | 140 | /* Directory object structure (FATFS_DIR) */ |
| Michael J. Spencer |
1:f5ac63519541 | 141 | |
| Michael J. Spencer |
1:f5ac63519541 | 142 | typedef struct { |
| Michael J. Spencer |
1:f5ac63519541 | 143 | FATFS* fs; /* Pointer to the owner file system object */ |
| Michael J. Spencer |
1:f5ac63519541 | 144 | WORD id; /* Owner file system mount ID */ |
| Michael J. Spencer |
1:f5ac63519541 | 145 | WORD index; /* Current read/write index number */ |
| Michael J. Spencer |
1:f5ac63519541 | 146 | DWORD sclust; /* Table start cluster (0:Root dir) */ |
| Michael J. Spencer |
1:f5ac63519541 | 147 | DWORD clust; /* Current cluster */ |
| Michael J. Spencer |
1:f5ac63519541 | 148 | DWORD sect; /* Current sector */ |
| Michael J. Spencer |
1:f5ac63519541 | 149 | BYTE* dir; /* Pointer to the current SFN entry in the win[] */ |
| Michael J. Spencer |
1:f5ac63519541 | 150 | BYTE* fn; /* Pointer to the SFN (in/out) {file[8],ext[3],status[1]} */ |
| Michael J. Spencer |
1:f5ac63519541 | 151 | #if _USE_LFN |
| Michael J. Spencer |
1:f5ac63519541 | 152 | WCHAR* lfn; /* Pointer to the LFN working buffer */ |
| Michael J. Spencer |
1:f5ac63519541 | 153 | WORD lfn_idx; /* Last matched LFN index number (0xFFFF:No LFN) */ |
| Michael J. Spencer |
1:f5ac63519541 | 154 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 155 | } FATFS_DIR; |
| Michael J. Spencer |
1:f5ac63519541 | 156 | |
| Michael J. Spencer |
1:f5ac63519541 | 157 | |
| Michael J. Spencer |
1:f5ac63519541 | 158 | |
| Michael J. Spencer |
1:f5ac63519541 | 159 | /* File status structure (FILINFO) */ |
| Michael J. Spencer |
1:f5ac63519541 | 160 | |
| Michael J. Spencer |
1:f5ac63519541 | 161 | typedef struct { |
| Michael J. Spencer |
1:f5ac63519541 | 162 | DWORD fsize; /* File size */ |
| Michael J. Spencer |
1:f5ac63519541 | 163 | WORD fdate; /* Last modified date */ |
| Michael J. Spencer |
1:f5ac63519541 | 164 | WORD ftime; /* Last modified time */ |
| Michael J. Spencer |
1:f5ac63519541 | 165 | BYTE fattrib; /* Attribute */ |
| Michael J. Spencer |
1:f5ac63519541 | 166 | TCHAR fname[13]; /* Short file name (8.3 format) */ |
| Michael J. Spencer |
1:f5ac63519541 | 167 | #if _USE_LFN |
| Michael J. Spencer |
1:f5ac63519541 | 168 | TCHAR* lfname; /* Pointer to the LFN buffer */ |
| Michael J. Spencer |
1:f5ac63519541 | 169 | UINT lfsize; /* Size of LFN buffer in TCHAR */ |
| Michael J. Spencer |
1:f5ac63519541 | 170 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 171 | } FILINFO; |
| Michael J. Spencer |
1:f5ac63519541 | 172 | |
| Michael J. Spencer |
1:f5ac63519541 | 173 | |
| Michael J. Spencer |
1:f5ac63519541 | 174 | |
| Michael J. Spencer |
1:f5ac63519541 | 175 | /* File function return code (FRESULT) */ |
| Michael J. Spencer |
1:f5ac63519541 | 176 | |
| Michael J. Spencer |
1:f5ac63519541 | 177 | typedef enum { |
| Michael J. Spencer |
1:f5ac63519541 | 178 | FR_OK = 0, /* (0) Succeeded */ |
| Michael J. Spencer |
1:f5ac63519541 | 179 | FR_DISK_ERR, /* (1) A hard error occured in the low level disk I/O layer */ |
| Michael J. Spencer |
1:f5ac63519541 | 180 | FR_INT_ERR, /* (2) Assertion failed */ |
| Michael J. Spencer |
1:f5ac63519541 | 181 | FR_NOT_READY, /* (3) The physical drive cannot work */ |
| Michael J. Spencer |
1:f5ac63519541 | 182 | FR_NO_FILE, /* (4) Could not find the file */ |
| Michael J. Spencer |
1:f5ac63519541 | 183 | FR_NO_PATH, /* (5) Could not find the path */ |
| Michael J. Spencer |
1:f5ac63519541 | 184 | FR_INVALID_NAME, /* (6) The path name format is invalid */ |
| Michael J. Spencer |
1:f5ac63519541 | 185 | FR_DENIED, /* (7) Acces denied due to prohibited access or directory full */ |
| Michael J. Spencer |
1:f5ac63519541 | 186 | FR_EXIST, /* (8) Acces denied due to prohibited access */ |
| Michael J. Spencer |
1:f5ac63519541 | 187 | FR_INVALID_OBJECT, /* (9) The file/directory object is invalid */ |
| Michael J. Spencer |
1:f5ac63519541 | 188 | FR_WRITE_PROTECTED, /* (10) The physical drive is write protected */ |
| Michael J. Spencer |
1:f5ac63519541 | 189 | FR_INVALID_DRIVE, /* (11) The logical drive number is invalid */ |
| Michael J. Spencer |
1:f5ac63519541 | 190 | FR_NOT_ENABLED, /* (12) The volume has no work area */ |
| Michael J. Spencer |
1:f5ac63519541 | 191 | FR_NO_FILESYSTEM, /* (13) There is no valid FAT volume */ |
| Michael J. Spencer |
1:f5ac63519541 | 192 | FR_MKFS_ABORTED, /* (14) The f_mkfs() aborted due to any parameter error */ |
| Michael J. Spencer |
1:f5ac63519541 | 193 | FR_TIMEOUT, /* (15) Could not get a grant to access the volume within defined period */ |
| Michael J. Spencer |
1:f5ac63519541 | 194 | FR_LOCKED, /* (16) The operation is rejected according to the file shareing policy */ |
| Michael J. Spencer |
1:f5ac63519541 | 195 | FR_NOT_ENOUGH_CORE, /* (17) LFN working buffer could not be allocated */ |
| Michael J. Spencer |
1:f5ac63519541 | 196 | FR_TOO_MANY_OPEN_FILES, /* (18) Number of open files > _FS_SHARE */ |
| Michael J. Spencer |
1:f5ac63519541 | 197 | FR_INVALID_PARAMETER /* (19) Given parameter is invalid */ |
| Michael J. Spencer |
1:f5ac63519541 | 198 | } FRESULT; |
| Michael J. Spencer |
1:f5ac63519541 | 199 | |
| Michael J. Spencer |
1:f5ac63519541 | 200 | |
| Michael J. Spencer |
1:f5ac63519541 | 201 | |
| Michael J. Spencer |
1:f5ac63519541 | 202 | /*--------------------------------------------------------------*/ |
| Michael J. Spencer |
1:f5ac63519541 | 203 | /* FatFs module application interface */ |
| Michael J. Spencer |
1:f5ac63519541 | 204 | |
| Michael J. Spencer |
1:f5ac63519541 | 205 | FRESULT f_mount (BYTE, FATFS*); /* Mount/Unmount a logical drive */ |
| Michael J. Spencer |
1:f5ac63519541 | 206 | FRESULT f_open (FIL*, const TCHAR*, BYTE); /* Open or create a file */ |
| Michael J. Spencer |
1:f5ac63519541 | 207 | FRESULT f_read (FIL*, void*, UINT, UINT*); /* Read data from a file */ |
| Michael J. Spencer |
1:f5ac63519541 | 208 | FRESULT f_lseek (FIL*, DWORD); /* Move file pointer of a file object */ |
| Michael J. Spencer |
1:f5ac63519541 | 209 | FRESULT f_close (FIL*); /* Close an open file object */ |
| Michael J. Spencer |
1:f5ac63519541 | 210 | FRESULT f_opendir (FATFS_DIR*, const TCHAR*); /* Open an existing directory */ |
| Michael J. Spencer |
1:f5ac63519541 | 211 | FRESULT f_readdir (FATFS_DIR*, FILINFO*); /* Read a directory item */ |
| Michael J. Spencer |
1:f5ac63519541 | 212 | FRESULT f_stat (const TCHAR*, FILINFO*); /* Get file status */ |
| Michael J. Spencer |
1:f5ac63519541 | 213 | FRESULT f_write (FIL*, const void*, UINT, UINT*); /* Write data to a file */ |
| Michael J. Spencer |
1:f5ac63519541 | 214 | FRESULT f_getfree (const TCHAR*, DWORD*, FATFS**); /* Get number of free clusters on the drive */ |
| Michael J. Spencer |
1:f5ac63519541 | 215 | FRESULT f_truncate (FIL*); /* Truncate file */ |
| Michael J. Spencer |
1:f5ac63519541 | 216 | FRESULT f_sync (FIL*); /* Flush cached data of a writing file */ |
| Michael J. Spencer |
1:f5ac63519541 | 217 | FRESULT f_unlink (const TCHAR*); /* Delete an existing file or directory */ |
| Michael J. Spencer |
1:f5ac63519541 | 218 | FRESULT f_mkdir (const TCHAR*); /* Create a new directory */ |
| Michael J. Spencer |
1:f5ac63519541 | 219 | FRESULT f_chmod (const TCHAR*, BYTE, BYTE); /* Change attriburte of the file/dir */ |
| Michael J. Spencer |
1:f5ac63519541 | 220 | FRESULT f_utime (const TCHAR*, const FILINFO*); /* Change timestamp of the file/dir */ |
| Michael J. Spencer |
1:f5ac63519541 | 221 | FRESULT f_rename (const TCHAR*, const TCHAR*); /* Rename/Move a file or directory */ |
| Michael J. Spencer |
1:f5ac63519541 | 222 | FRESULT f_chdrive (BYTE); /* Change current drive */ |
| Michael J. Spencer |
1:f5ac63519541 | 223 | FRESULT f_chdir (const TCHAR*); /* Change current directory */ |
| Michael J. Spencer |
1:f5ac63519541 | 224 | FRESULT f_getcwd (TCHAR*, UINT); /* Get current directory */ |
| Michael J. Spencer |
1:f5ac63519541 | 225 | FRESULT f_forward (FIL*, UINT(*)(const BYTE*,UINT), UINT, UINT*); /* Forward data to the stream */ |
| Michael J. Spencer |
1:f5ac63519541 | 226 | FRESULT f_mkfs (BYTE, BYTE, UINT); /* Create a file system on the drive */ |
| Michael J. Spencer |
1:f5ac63519541 | 227 | FRESULT f_fdisk (BYTE, const DWORD[], void*); /* Divide a physical drive into some partitions */ |
| Michael J. Spencer |
1:f5ac63519541 | 228 | int f_putc (TCHAR, FIL*); /* Put a character to the file */ |
| Michael J. Spencer |
1:f5ac63519541 | 229 | int f_puts (const TCHAR*, FIL*); /* Put a string to the file */ |
| Michael J. Spencer |
1:f5ac63519541 | 230 | int f_printf (FIL*, const TCHAR*, ...); /* Put a formatted string to the file */ |
| Michael J. Spencer |
1:f5ac63519541 | 231 | TCHAR* f_gets (TCHAR*, int, FIL*); /* Get a string from the file */ |
| Michael J. Spencer |
1:f5ac63519541 | 232 | |
| Michael J. Spencer |
1:f5ac63519541 | 233 | #define f_eof(fp) (((fp)->fptr == (fp)->fsize) ? 1 : 0) |
| Michael J. Spencer |
1:f5ac63519541 | 234 | #define f_error(fp) (((fp)->flag & FA__ERROR) ? 1 : 0) |
| Michael J. Spencer |
1:f5ac63519541 | 235 | #define f_tell(fp) ((fp)->fptr) |
| Michael J. Spencer |
1:f5ac63519541 | 236 | #define f_size(fp) ((fp)->fsize) |
| Michael J. Spencer |
1:f5ac63519541 | 237 | |
| Michael J. Spencer |
1:f5ac63519541 | 238 | #ifndef EOF |
| Michael J. Spencer |
1:f5ac63519541 | 239 | #define EOF (-1) |
| Michael J. Spencer |
1:f5ac63519541 | 240 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 241 | |
| Michael J. Spencer |
1:f5ac63519541 | 242 | |
| Michael J. Spencer |
1:f5ac63519541 | 243 | |
| Michael J. Spencer |
1:f5ac63519541 | 244 | |
| Michael J. Spencer |
1:f5ac63519541 | 245 | /*--------------------------------------------------------------*/ |
| Michael J. Spencer |
1:f5ac63519541 | 246 | /* Additional user defined functions */ |
| Michael J. Spencer |
1:f5ac63519541 | 247 | |
| Michael J. Spencer |
1:f5ac63519541 | 248 | /* RTC function */ |
| Michael J. Spencer |
1:f5ac63519541 | 249 | #if !_FS_READONLY |
| Michael J. Spencer |
1:f5ac63519541 | 250 | DWORD get_fattime (void); |
| Michael J. Spencer |
1:f5ac63519541 | 251 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 252 | |
| Michael J. Spencer |
1:f5ac63519541 | 253 | /* Unicode support functions */ |
| Michael J. Spencer |
1:f5ac63519541 | 254 | #if _USE_LFN /* Unicode - OEM code conversion */ |
| Michael J. Spencer |
1:f5ac63519541 | 255 | WCHAR ff_convert (WCHAR, UINT); /* OEM-Unicode bidirectional conversion */ |
| Michael J. Spencer |
1:f5ac63519541 | 256 | WCHAR ff_wtoupper (WCHAR); /* Unicode upper-case conversion */ |
| Michael J. Spencer |
1:f5ac63519541 | 257 | #if _USE_LFN == 3 /* Memory functions */ |
| Michael J. Spencer |
1:f5ac63519541 | 258 | void* ff_memalloc (UINT); /* Allocate memory block */ |
| Michael J. Spencer |
1:f5ac63519541 | 259 | void ff_memfree (void*); /* Free memory block */ |
| Michael J. Spencer |
1:f5ac63519541 | 260 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 261 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 262 | |
| Michael J. Spencer |
1:f5ac63519541 | 263 | /* Sync functions */ |
| Michael J. Spencer |
1:f5ac63519541 | 264 | #if _FS_REENTRANT |
| Michael J. Spencer |
1:f5ac63519541 | 265 | int ff_cre_syncobj (BYTE, _SYNC_t*);/* Create a sync object */ |
| Michael J. Spencer |
1:f5ac63519541 | 266 | int ff_req_grant (_SYNC_t); /* Lock sync object */ |
| Michael J. Spencer |
1:f5ac63519541 | 267 | void ff_rel_grant (_SYNC_t); /* Unlock sync object */ |
| Michael J. Spencer |
1:f5ac63519541 | 268 | int ff_del_syncobj (_SYNC_t); /* Delete a sync object */ |
| Michael J. Spencer |
1:f5ac63519541 | 269 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 270 | |
| Michael J. Spencer |
1:f5ac63519541 | 271 | |
| Michael J. Spencer |
1:f5ac63519541 | 272 | |
| Michael J. Spencer |
1:f5ac63519541 | 273 | |
| Michael J. Spencer |
1:f5ac63519541 | 274 | /*--------------------------------------------------------------*/ |
| Michael J. Spencer |
1:f5ac63519541 | 275 | /* Flags and offset address */ |
| Michael J. Spencer |
1:f5ac63519541 | 276 | |
| Michael J. Spencer |
1:f5ac63519541 | 277 | |
| Michael J. Spencer |
1:f5ac63519541 | 278 | /* File access control and file status flags (FIL.flag) */ |
| Michael J. Spencer |
1:f5ac63519541 | 279 | |
| Michael J. Spencer |
1:f5ac63519541 | 280 | #define FA_READ 0x01 |
| Michael J. Spencer |
1:f5ac63519541 | 281 | #define FA_OPEN_EXISTING 0x00 |
| Michael J. Spencer |
1:f5ac63519541 | 282 | #define FA__ERROR 0x80 |
| Michael J. Spencer |
1:f5ac63519541 | 283 | |
| Michael J. Spencer |
1:f5ac63519541 | 284 | #if !_FS_READONLY |
| Michael J. Spencer |
1:f5ac63519541 | 285 | #define FA_WRITE 0x02 |
| Michael J. Spencer |
1:f5ac63519541 | 286 | #define FA_CREATE_NEW 0x04 |
| Michael J. Spencer |
1:f5ac63519541 | 287 | #define FA_CREATE_ALWAYS 0x08 |
| Michael J. Spencer |
1:f5ac63519541 | 288 | #define FA_OPEN_ALWAYS 0x10 |
| Michael J. Spencer |
1:f5ac63519541 | 289 | #define FA__WRITTEN 0x20 |
| Michael J. Spencer |
1:f5ac63519541 | 290 | #define FA__DIRTY 0x40 |
| Michael J. Spencer |
1:f5ac63519541 | 291 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 292 | |
| Michael J. Spencer |
1:f5ac63519541 | 293 | |
| Michael J. Spencer |
1:f5ac63519541 | 294 | /* FAT sub type (FATFS.fs_type) */ |
| Michael J. Spencer |
1:f5ac63519541 | 295 | |
| Michael J. Spencer |
1:f5ac63519541 | 296 | #define FS_FAT12 1 |
| Michael J. Spencer |
1:f5ac63519541 | 297 | #define FS_FAT16 2 |
| Michael J. Spencer |
1:f5ac63519541 | 298 | #define FS_FAT32 3 |
| Michael J. Spencer |
1:f5ac63519541 | 299 | |
| Michael J. Spencer |
1:f5ac63519541 | 300 | |
| Michael J. Spencer |
1:f5ac63519541 | 301 | /* File attribute bits for directory entry */ |
| Michael J. Spencer |
1:f5ac63519541 | 302 | |
| Michael J. Spencer |
1:f5ac63519541 | 303 | #define AM_RDO 0x01 /* Read only */ |
| Michael J. Spencer |
1:f5ac63519541 | 304 | #define AM_HID 0x02 /* Hidden */ |
| Michael J. Spencer |
1:f5ac63519541 | 305 | #define AM_SYS 0x04 /* System */ |
| Michael J. Spencer |
1:f5ac63519541 | 306 | #define AM_VOL 0x08 /* Volume label */ |
| Michael J. Spencer |
1:f5ac63519541 | 307 | #define AM_LFN 0x0F /* LFN entry */ |
| Michael J. Spencer |
1:f5ac63519541 | 308 | #define AM_DIR 0x10 /* Directory */ |
| Michael J. Spencer |
1:f5ac63519541 | 309 | #define AM_ARC 0x20 /* Archive */ |
| Michael J. Spencer |
1:f5ac63519541 | 310 | #define AM_MASK 0x3F /* Mask of defined bits */ |
| Michael J. Spencer |
1:f5ac63519541 | 311 | |
| Michael J. Spencer |
1:f5ac63519541 | 312 | |
| Michael J. Spencer |
1:f5ac63519541 | 313 | /* Fast seek feature */ |
| Michael J. Spencer |
1:f5ac63519541 | 314 | #define CREATE_LINKMAP 0xFFFFFFFF |
| Michael J. Spencer |
1:f5ac63519541 | 315 | |
| Michael J. Spencer |
1:f5ac63519541 | 316 | |
| Michael J. Spencer |
1:f5ac63519541 | 317 | |
| Michael J. Spencer |
1:f5ac63519541 | 318 | /*--------------------------------*/ |
| Michael J. Spencer |
1:f5ac63519541 | 319 | /* Multi-byte word access macros */ |
| Michael J. Spencer |
1:f5ac63519541 | 320 | |
| Michael J. Spencer |
1:f5ac63519541 | 321 | #if _WORD_ACCESS == 1 /* Enable word access to the FAT structure */ |
| Michael J. Spencer |
1:f5ac63519541 | 322 | #define LD_WORD(ptr) (WORD)(*(WORD*)(BYTE*)(ptr)) |
| Michael J. Spencer |
1:f5ac63519541 | 323 | #define LD_DWORD(ptr) (DWORD)(*(DWORD*)(BYTE*)(ptr)) |
| Michael J. Spencer |
1:f5ac63519541 | 324 | #define ST_WORD(ptr,val) *(WORD*)(BYTE*)(ptr)=(WORD)(val) |
| Michael J. Spencer |
1:f5ac63519541 | 325 | #define ST_DWORD(ptr,val) *(DWORD*)(BYTE*)(ptr)=(DWORD)(val) |
| Michael J. Spencer |
1:f5ac63519541 | 326 | #else /* Use byte-by-byte access to the FAT structure */ |
| Michael J. Spencer |
1:f5ac63519541 | 327 | #define LD_WORD(ptr) (WORD)(((WORD)*((BYTE*)(ptr)+1)<<8)|(WORD)*(BYTE*)(ptr)) |
| Michael J. Spencer |
1:f5ac63519541 | 328 | #define LD_DWORD(ptr) (DWORD)(((DWORD)*((BYTE*)(ptr)+3)<<24)|((DWORD)*((BYTE*)(ptr)+2)<<16)|((WORD)*((BYTE*)(ptr)+1)<<8)|*(BYTE*)(ptr)) |
| Michael J. Spencer |
1:f5ac63519541 | 329 | #define ST_WORD(ptr,val) *(BYTE*)(ptr)=(BYTE)(val); *((BYTE*)(ptr)+1)=(BYTE)((WORD)(val)>>8) |
| Michael J. Spencer |
1:f5ac63519541 | 330 | #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) |
| Michael J. Spencer |
1:f5ac63519541 | 331 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 332 | |
| Michael J. Spencer |
1:f5ac63519541 | 333 | #ifdef __cplusplus |
| Michael J. Spencer |
1:f5ac63519541 | 334 | } |
| Michael J. Spencer |
1:f5ac63519541 | 335 | #endif |
| Michael J. Spencer |
1:f5ac63519541 | 336 | |
| Michael J. Spencer |
1:f5ac63519541 | 337 | #endif /* _FATFS */ |