]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/source/ff.h
Merge branch 'chan-fatfs' into fatfs-integration
[z180-stamp.git] / fatfs / source / ff.h
diff --git a/fatfs/source/ff.h b/fatfs/source/ff.h
new file mode 100644 (file)
index 0000000..9fa1178
--- /dev/null
@@ -0,0 +1,376 @@
+/*----------------------------------------------------------------------------/\r
+/  FatFs - Generic FAT Filesystem module  R0.13b                              /\r
+/-----------------------------------------------------------------------------/\r
+/\r
+/ Copyright (C) 2018, ChaN, all right reserved.\r
+/\r
+/ FatFs module is an open source software. Redistribution and use of FatFs in\r
+/ source and binary forms, with or without modification, are permitted provided\r
+/ that the following condition is met:\r
+\r
+/ 1. Redistributions of source code must retain the above copyright notice,\r
+/    this condition and the following disclaimer.\r
+/\r
+/ This software is provided by the copyright holder and contributors "AS IS"\r
+/ and any warranties related to this software are DISCLAIMED.\r
+/ The copyright owner or contributors be NOT LIABLE for any damages caused\r
+/ by use of this software.\r
+/\r
+/----------------------------------------------------------------------------*/\r
+\r
+\r
+#ifndef FF_DEFINED\r
+#define FF_DEFINED     63463   /* Revision ID */\r
+\r
+#ifdef __cplusplus\r
+extern "C" {\r
+#endif\r
+\r
+#include "integer.h"   /* Basic integer types */\r
+#include "ffconf.h"            /* FatFs configuration options */\r
+\r
+#if FF_DEFINED != FFCONF_DEF\r
+#error Wrong configuration file (ffconf.h).\r
+#endif\r
+\r
+\r
+\r
+/* Definitions of volume management */\r
+\r
+#if FF_MULTI_PARTITION         /* Multiple partition configuration */\r
+typedef struct {\r
+       BYTE pd;        /* Physical drive number */\r
+       BYTE pt;        /* Partition: 0:Auto detect, 1-4:Forced partition) */\r
+} PARTITION;\r
+extern PARTITION VolToPart[];  /* Volume - Partition resolution table */\r
+#endif\r
+\r
+#if FF_STR_VOLUME_ID\r
+#ifndef FF_VOLUME_STRS\r
+extern const char* VolumeStr[FF_VOLUMES];      /* User defied volume ID */\r
+#endif\r
+#endif\r
+\r
+\r
+\r
+/* Type of path name strings on FatFs API */\r
+\r
+#ifndef _INC_TCHAR\r
+#define _INC_TCHAR\r
+\r
+#if FF_USE_LFN && FF_LFN_UNICODE == 1  /* Unicode in UTF-16 encoding */\r
+typedef WCHAR TCHAR;\r
+#define _T(x) L ## x\r
+#define _TEXT(x) L ## x\r
+#elif FF_USE_LFN && FF_LFN_UNICODE == 2        /* Unicode in UTF-8 encoding */\r
+typedef char TCHAR;\r
+#define _T(x) u8 ## x\r
+#define _TEXT(x) u8 ## x\r
+#elif FF_USE_LFN && FF_LFN_UNICODE == 3        /* Unicode in UTF-32 encoding */\r
+typedef DWORD TCHAR;\r
+#define _T(x) U ## x\r
+#define _TEXT(x) U ## x\r
+#elif FF_USE_LFN && (FF_LFN_UNICODE < 0 || FF_LFN_UNICODE > 3)\r
+#error Wrong FF_LFN_UNICODE setting\r
+#else                                                                  /* ANSI/OEM code in SBCS/DBCS */\r
+typedef char TCHAR;\r
+#define _T(x) x\r
+#define _TEXT(x) x\r
+#endif\r
+\r
+#endif\r
+\r
+\r
+\r
+/* Type of file size variables */\r
+\r
+#if FF_FS_EXFAT\r
+typedef QWORD FSIZE_t;\r
+#else\r
+typedef DWORD FSIZE_t;\r
+#endif\r
+\r
+\r
+\r
+/* Filesystem object structure (FATFS) */\r
+\r
+typedef struct {\r
+       BYTE    fs_type;                /* Filesystem type (0:N/A) */\r
+       BYTE    pdrv;                   /* Physical drive number */\r
+       BYTE    n_fats;                 /* Number of FATs (1 or 2) */\r
+       BYTE    wflag;                  /* win[] flag (b0:dirty) */\r
+       BYTE    fsi_flag;               /* FSINFO flags (b7:disabled, b0:dirty) */\r
+       WORD    id;                             /* Volume mount ID */\r
+       WORD    n_rootdir;              /* Number of root directory entries (FAT12/16) */\r
+       WORD    csize;                  /* Cluster size [sectors] */\r
+#if FF_MAX_SS != FF_MIN_SS\r
+       WORD    ssize;                  /* Sector size (512, 1024, 2048 or 4096) */\r
+#endif\r
+#if FF_USE_LFN\r
+       WCHAR*  lfnbuf;                 /* LFN working buffer */\r
+#endif\r
+#if FF_FS_EXFAT\r
+       BYTE*   dirbuf;                 /* Directory entry block scratchpad buffer for exFAT */\r
+#endif\r
+#if FF_FS_REENTRANT\r
+       FF_SYNC_t       sobj;           /* Identifier of sync object */\r
+#endif\r
+#if !FF_FS_READONLY\r
+       DWORD   last_clst;              /* Last allocated cluster */\r
+       DWORD   free_clst;              /* Number of free clusters */\r
+#endif\r
+#if FF_FS_RPATH\r
+       DWORD   cdir;                   /* Current directory start cluster (0:root) */\r
+#if FF_FS_EXFAT\r
+       DWORD   cdc_scl;                /* Containing directory start cluster (invalid when cdir is 0) */\r
+       DWORD   cdc_size;               /* b31-b8:Size of containing directory, b7-b0: Chain status */\r
+       DWORD   cdc_ofs;                /* Offset in the containing directory (invalid when cdir is 0) */\r
+#endif\r
+#endif\r
+       DWORD   n_fatent;               /* Number of FAT entries (number of clusters + 2) */\r
+       DWORD   fsize;                  /* Size of an FAT [sectors] */\r
+       DWORD   volbase;                /* Volume base sector */\r
+       DWORD   fatbase;                /* FAT base sector */\r
+       DWORD   dirbase;                /* Root directory base sector/cluster */\r
+       DWORD   database;               /* Data base sector */\r
+       DWORD   winsect;                /* Current sector appearing in the win[] */\r
+       BYTE    win[FF_MAX_SS]; /* Disk access window for Directory, FAT (and file data at tiny cfg) */\r
+} FATFS;\r
+\r
+\r
+\r
+/* Object ID and allocation information (FFOBJID) */\r
+\r
+typedef struct {\r
+       FATFS*  fs;                             /* Pointer to the hosting volume of this object */\r
+       WORD    id;                             /* Hosting volume mount ID */\r
+       BYTE    attr;                   /* Object attribute */\r
+       BYTE    stat;                   /* Object chain status (b1-0: =0:not contiguous, =2:contiguous, =3:flagmented in this session, b2:sub-directory stretched) */\r
+       DWORD   sclust;                 /* Object data start cluster (0:no cluster or root directory) */\r
+       FSIZE_t objsize;                /* Object size (valid when sclust != 0) */\r
+#if FF_FS_EXFAT\r
+       DWORD   n_cont;                 /* Size of first fragment - 1 (valid when stat == 3) */\r
+       DWORD   n_frag;                 /* Size of last fragment needs to be written to FAT (valid when not zero) */\r
+       DWORD   c_scl;                  /* Containing directory start cluster (valid when sclust != 0) */\r
+       DWORD   c_size;                 /* b31-b8:Size of containing directory, b7-b0: Chain status (valid when c_scl != 0) */\r
+       DWORD   c_ofs;                  /* Offset in the containing directory (valid when file object and sclust != 0) */\r
+#endif\r
+#if FF_FS_LOCK\r
+       UINT    lockid;                 /* File lock ID origin from 1 (index of file semaphore table Files[]) */\r
+#endif\r
+} FFOBJID;\r
+\r
+\r
+\r
+/* File object structure (FIL) */\r
+\r
+typedef struct {\r
+       FFOBJID obj;                    /* Object identifier (must be the 1st member to detect invalid object pointer) */\r
+       BYTE    flag;                   /* File status flags */\r
+       BYTE    err;                    /* Abort flag (error code) */\r
+       FSIZE_t fptr;                   /* File read/write pointer (Zeroed on file open) */\r
+       DWORD   clust;                  /* Current cluster of fpter (invalid when fptr is 0) */\r
+       DWORD   sect;                   /* Sector number appearing in buf[] (0:invalid) */\r
+#if !FF_FS_READONLY\r
+       DWORD   dir_sect;               /* Sector number containing the directory entry (not used at exFAT) */\r
+       BYTE*   dir_ptr;                /* Pointer to the directory entry in the win[] (not used at exFAT) */\r
+#endif\r
+#if FF_USE_FASTSEEK\r
+       DWORD*  cltbl;                  /* Pointer to the cluster link map table (nulled on open, set by application) */\r
+#endif\r
+#if !FF_FS_TINY\r
+       BYTE    buf[FF_MAX_SS]; /* File private data read/write window */\r
+#endif\r
+} FIL;\r
+\r
+\r
+\r
+/* Directory object structure (DIR) */\r
+\r
+typedef struct {\r
+       FFOBJID obj;                    /* Object identifier */\r
+       DWORD   dptr;                   /* Current read/write offset */\r
+       DWORD   clust;                  /* Current cluster */\r
+       DWORD   sect;                   /* Current sector (0:Read operation has terminated) */\r
+       BYTE*   dir;                    /* Pointer to the directory item in the win[] */\r
+       BYTE    fn[12];                 /* SFN (in/out) {body[8],ext[3],status[1]} */\r
+#if FF_USE_LFN\r
+       DWORD   blk_ofs;                /* Offset of current entry block being processed (0xFFFFFFFF:Invalid) */\r
+#endif\r
+#if FF_USE_FIND\r
+       const TCHAR* pat;               /* Pointer to the name matching pattern */\r
+#endif\r
+} DIR;\r
+\r
+\r
+\r
+/* File information structure (FILINFO) */\r
+\r
+typedef struct {\r
+       FSIZE_t fsize;                  /* File size */\r
+       WORD    fdate;                  /* Modified date */\r
+       WORD    ftime;                  /* Modified time */\r
+       BYTE    fattrib;                /* File attribute */\r
+#if FF_USE_LFN\r
+       TCHAR   altname[FF_SFN_BUF + 1];/* Altenative file name */\r
+       TCHAR   fname[FF_LFN_BUF + 1];  /* Primary file name */\r
+#else\r
+       TCHAR   fname[12 + 1];  /* File name */\r
+#endif\r
+} FILINFO;\r
+\r
+\r
+\r
+/* File function return code (FRESULT) */\r
+\r
+typedef enum {\r
+       FR_OK = 0,                              /* (0) Succeeded */\r
+       FR_DISK_ERR,                    /* (1) A hard error occurred in the low level disk I/O layer */\r
+       FR_INT_ERR,                             /* (2) Assertion failed */\r
+       FR_NOT_READY,                   /* (3) The physical drive cannot work */\r
+       FR_NO_FILE,                             /* (4) Could not find the file */\r
+       FR_NO_PATH,                             /* (5) Could not find the path */\r
+       FR_INVALID_NAME,                /* (6) The path name format is invalid */\r
+       FR_DENIED,                              /* (7) Access denied due to prohibited access or directory full */\r
+       FR_EXIST,                               /* (8) Access denied due to prohibited access */\r
+       FR_INVALID_OBJECT,              /* (9) The file/directory object is invalid */\r
+       FR_WRITE_PROTECTED,             /* (10) The physical drive is write protected */\r
+       FR_INVALID_DRIVE,               /* (11) The logical drive number is invalid */\r
+       FR_NOT_ENABLED,                 /* (12) The volume has no work area */\r
+       FR_NO_FILESYSTEM,               /* (13) There is no valid FAT volume */\r
+       FR_MKFS_ABORTED,                /* (14) The f_mkfs() aborted due to any problem */\r
+       FR_TIMEOUT,                             /* (15) Could not get a grant to access the volume within defined period */\r
+       FR_LOCKED,                              /* (16) The operation is rejected according to the file sharing policy */\r
+       FR_NOT_ENOUGH_CORE,             /* (17) LFN working buffer could not be allocated */\r
+       FR_TOO_MANY_OPEN_FILES, /* (18) Number of open files > FF_FS_LOCK */\r
+       FR_INVALID_PARAMETER    /* (19) Given parameter is invalid */\r
+} FRESULT;\r
+\r
+\r
+\r
+/*--------------------------------------------------------------*/\r
+/* FatFs module application interface                           */\r
+\r
+FRESULT f_open (FIL* fp, const TCHAR* path, BYTE mode);                                /* Open or create a file */\r
+FRESULT f_close (FIL* fp);                                                                                     /* Close an open file object */\r
+FRESULT f_read (FIL* fp, void* buff, UINT btr, UINT* br);                      /* Read data from the file */\r
+FRESULT f_write (FIL* fp, const void* buff, UINT btw, UINT* bw);       /* Write data to the file */\r
+FRESULT f_lseek (FIL* fp, FSIZE_t ofs);                                                                /* Move file pointer of the file object */\r
+FRESULT f_truncate (FIL* fp);                                                                          /* Truncate the file */\r
+FRESULT f_sync (FIL* fp);                                                                                      /* Flush cached data of the writing file */\r
+FRESULT f_opendir (DIR* dp, const TCHAR* path);                                                /* Open a directory */\r
+FRESULT f_closedir (DIR* dp);                                                                          /* Close an open directory */\r
+FRESULT f_readdir (DIR* dp, FILINFO* fno);                                                     /* Read a directory item */\r
+FRESULT f_findfirst (DIR* dp, FILINFO* fno, const TCHAR* path, const TCHAR* pattern);  /* Find first file */\r
+FRESULT f_findnext (DIR* dp, FILINFO* fno);                                                    /* Find next file */\r
+FRESULT f_mkdir (const TCHAR* path);                                                           /* Create a sub directory */\r
+FRESULT f_unlink (const TCHAR* path);                                                          /* Delete an existing file or directory */\r
+FRESULT f_rename (const TCHAR* path_old, const TCHAR* path_new);       /* Rename/Move a file or directory */\r
+FRESULT f_stat (const TCHAR* path, FILINFO* fno);                                      /* Get file status */\r
+FRESULT f_chmod (const TCHAR* path, BYTE attr, BYTE mask);                     /* Change attribute of a file/dir */\r
+FRESULT f_utime (const TCHAR* path, const FILINFO* fno);                       /* Change timestamp of a file/dir */\r
+FRESULT f_chdir (const TCHAR* path);                                                           /* Change current directory */\r
+FRESULT f_chdrive (const TCHAR* path);                                                         /* Change current drive */\r
+FRESULT f_getcwd (TCHAR* buff, UINT len);                                                      /* Get current directory */\r
+FRESULT f_getfree (const TCHAR* path, DWORD* nclst, FATFS** fatfs);    /* Get number of free clusters on the drive */\r
+FRESULT f_getlabel (const TCHAR* path, TCHAR* label, DWORD* vsn);      /* Get volume label */\r
+FRESULT f_setlabel (const TCHAR* label);                                                       /* Set volume label */\r
+FRESULT f_forward (FIL* fp, UINT(*func)(const BYTE*,UINT), UINT btf, UINT* bf);        /* Forward data to the stream */\r
+FRESULT f_expand (FIL* fp, FSIZE_t szf, BYTE opt);                                     /* Allocate a contiguous block to the file */\r
+FRESULT f_mount (FATFS* fs, const TCHAR* path, BYTE opt);                      /* Mount/Unmount a logical drive */\r
+FRESULT f_mkfs (const TCHAR* path, BYTE opt, DWORD au, void* work, UINT len);  /* Create a FAT volume */\r
+FRESULT f_fdisk (BYTE pdrv, const DWORD* szt, void* work);                     /* Divide a physical drive into some partitions */\r
+FRESULT f_setcp (WORD cp);                                                                                     /* Set current code page */\r
+int f_putc (TCHAR c, FIL* fp);                                                                         /* Put a character to the file */\r
+int f_puts (const TCHAR* str, FIL* cp);                                                                /* Put a string to the file */\r
+int f_printf (FIL* fp, const TCHAR* str, ...);                                         /* Put a formatted string to the file */\r
+TCHAR* f_gets (TCHAR* buff, int len, FIL* fp);                                         /* Get a string from the file */\r
+\r
+#define f_eof(fp) ((int)((fp)->fptr == (fp)->obj.objsize))\r
+#define f_error(fp) ((fp)->err)\r
+#define f_tell(fp) ((fp)->fptr)\r
+#define f_size(fp) ((fp)->obj.objsize)\r
+#define f_rewind(fp) f_lseek((fp), 0)\r
+#define f_rewinddir(dp) f_readdir((dp), 0)\r
+#define f_rmdir(path) f_unlink(path)\r
+#define f_unmount(path) f_mount(0, path, 0)\r
+\r
+#ifndef EOF\r
+#define EOF (-1)\r
+#endif\r
+\r
+\r
+\r
+\r
+/*--------------------------------------------------------------*/\r
+/* Additional user defined functions                            */\r
+\r
+/* RTC function */\r
+#if !FF_FS_READONLY && !FF_FS_NORTC\r
+DWORD get_fattime (void);\r
+#endif\r
+\r
+/* LFN support functions */\r
+#if FF_USE_LFN >= 1                                            /* Code conversion (defined in unicode.c) */\r
+WCHAR ff_oem2uni (WCHAR oem, WORD cp); /* OEM code to Unicode conversion */\r
+WCHAR ff_uni2oem (DWORD uni, WORD cp); /* Unicode to OEM code conversion */\r
+DWORD ff_wtoupper (DWORD uni);                 /* Unicode upper-case conversion */\r
+#endif\r
+#if FF_USE_LFN == 3                                            /* Dynamic memory allocation */\r
+void* ff_memalloc (UINT msize);                        /* Allocate memory block */\r
+void ff_memfree (void* mblock);                        /* Free memory block */\r
+#endif\r
+\r
+/* Sync functions */\r
+#if FF_FS_REENTRANT\r
+int ff_cre_syncobj (BYTE vol, FF_SYNC_t* sobj);        /* Create a sync object */\r
+int ff_req_grant (FF_SYNC_t sobj);             /* Lock sync object */\r
+void ff_rel_grant (FF_SYNC_t sobj);            /* Unlock sync object */\r
+int ff_del_syncobj (FF_SYNC_t sobj);   /* Delete a sync object */\r
+#endif\r
+\r
+\r
+\r
+\r
+/*--------------------------------------------------------------*/\r
+/* Flags and offset address                                     */\r
+\r
+\r
+/* File access mode and open method flags (3rd argument of f_open) */\r
+#define        FA_READ                         0x01\r
+#define        FA_WRITE                        0x02\r
+#define        FA_OPEN_EXISTING        0x00\r
+#define        FA_CREATE_NEW           0x04\r
+#define        FA_CREATE_ALWAYS        0x08\r
+#define        FA_OPEN_ALWAYS          0x10\r
+#define        FA_OPEN_APPEND          0x30\r
+\r
+/* Fast seek controls (2nd argument of f_lseek) */\r
+#define CREATE_LINKMAP ((FSIZE_t)0 - 1)\r
+\r
+/* Format options (2nd argument of f_mkfs) */\r
+#define FM_FAT         0x01\r
+#define FM_FAT32       0x02\r
+#define FM_EXFAT       0x04\r
+#define FM_ANY         0x07\r
+#define FM_SFD         0x08\r
+\r
+/* Filesystem type (FATFS.fs_type) */\r
+#define FS_FAT12       1\r
+#define FS_FAT16       2\r
+#define FS_FAT32       3\r
+#define FS_EXFAT       4\r
+\r
+/* File attribute bits for directory entry (FILINFO.fattrib) */\r
+#define        AM_RDO  0x01    /* Read only */\r
+#define        AM_HID  0x02    /* Hidden */\r
+#define        AM_SYS  0x04    /* System */\r
+#define AM_DIR 0x10    /* Directory */\r
+#define AM_ARC 0x20    /* Archive */\r
+\r
+\r
+#ifdef __cplusplus\r
+}\r
+#endif\r
+\r
+#endif /* FF_DEFINED */\r