]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/source/ff.h
Import fatfs R0.13b
[z180-stamp.git] / fatfs / source / ff.h
similarity index 69%
rename from fatfs/src/ff.h
rename to fatfs/source/ff.h
index 981a88634fa0f1c9f53738fceac6fdb68587f3a6..9fa117869bdceb52018198e5575eaff4fc23f0ba 100644 (file)
@@ -1,8 +1,8 @@
 /*----------------------------------------------------------------------------/\r
-/  FatFs - Generic FAT file system module  R0.12b                             /\r
+/  FatFs - Generic FAT Filesystem module  R0.13b                              /\r
 /-----------------------------------------------------------------------------/\r
 /\r
-/ Copyright (C) 2016, ChaN, all right reserved.\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
 / 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 _FATFS\r
-#define _FATFS 68020   /* Revision ID */\r
+#ifndef FF_DEFINED\r
+#define FF_DEFINED     63463   /* Revision ID */\r
 \r
 #ifdef __cplusplus\r
 extern "C" {\r
@@ -28,7 +29,7 @@ extern "C" {
 #include "integer.h"   /* Basic integer types */\r
 #include "ffconf.h"            /* FatFs configuration options */\r
 \r
-#if _FATFS != _FFCONF\r
+#if FF_DEFINED != FFCONF_DEF\r
 #error Wrong configuration file (ffconf.h).\r
 #endif\r
 \r
@@ -36,50 +37,54 @@ extern "C" {
 \r
 /* Definitions of volume management */\r
 \r
-#if _MULTI_PARTITION           /* Multiple partition configuration */\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
-#define LD2PD(vol) (VolToPart[vol].pd) /* Get physical drive number */\r
-#define LD2PT(vol) (VolToPart[vol].pt) /* Get partition index */\r
-\r
-#else                                                  /* Single partition configuration */\r
-#define LD2PD(vol) (BYTE)(vol) /* Each logical drive is bound to the same physical drive number */\r
-#define LD2PT(vol) 0                   /* Find first valid partition or in SFD */\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
-#if _LFN_UNICODE                       /* Unicode (UTF-16) string */\r
-#if _USE_LFN == 0\r
-#error _LFN_UNICODE must be 0 at non-LFN cfg.\r
-#endif\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
-#endif\r
-#else                                          /* ANSI/OEM string */\r
-#ifndef _INC_TCHAR\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 _FS_EXFAT\r
-#if _USE_LFN == 0\r
-#error LFN must be enabled when enable exFAT\r
-#endif\r
+#if FF_FS_EXFAT\r
 typedef QWORD FSIZE_t;\r
 #else\r
 typedef DWORD FSIZE_t;\r
@@ -87,36 +92,36 @@ typedef DWORD FSIZE_t;
 \r
 \r
 \r
-/* File system object structure (FATFS) */\r
+/* Filesystem object structure (FATFS) */\r
 \r
 typedef struct {\r
-       BYTE    fs_type;                /* File system type (0:N/A) */\r
-       BYTE    drv;                    /* Physical drive number */\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;                             /* File system mount ID */\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 _MAX_SS != _MIN_SS\r
+#if FF_MAX_SS != FF_MIN_SS\r
        WORD    ssize;                  /* Sector size (512, 1024, 2048 or 4096) */\r
 #endif\r
-#if _USE_LFN != 0\r
+#if FF_USE_LFN\r
        WCHAR*  lfnbuf;                 /* LFN working buffer */\r
 #endif\r
-#if _FS_EXFAT\r
-       BYTE*   dirbuf;                 /* Directory entry block scratchpad buffer */\r
+#if FF_FS_EXFAT\r
+       BYTE*   dirbuf;                 /* Directory entry block scratchpad buffer for exFAT */\r
 #endif\r
-#if _FS_REENTRANT\r
-       _SYNC_t sobj;                   /* Identifier of sync object */\r
+#if FF_FS_REENTRANT\r
+       FF_SYNC_t       sobj;           /* Identifier of sync object */\r
 #endif\r
-#if !_FS_READONLY\r
+#if !FF_FS_READONLY\r
        DWORD   last_clst;              /* Last allocated cluster */\r
        DWORD   free_clst;              /* Number of free clusters */\r
 #endif\r
-#if _FS_RPATH != 0\r
+#if FF_FS_RPATH\r
        DWORD   cdir;                   /* Current directory start cluster (0:root) */\r
-#if _FS_EXFAT\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
@@ -129,51 +134,52 @@ typedef struct {
        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[_MAX_SS];   /* Disk access window for Directory, FAT (and file data at tiny cfg) */\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 (_FDID) */\r
+/* Object ID and allocation information (FFOBJID) */\r
 \r
 typedef struct {\r
-       FATFS*  fs;                     /* Pointer to the owner file system object */\r
-       WORD    id;                     /* Owner file system mount ID */\r
-       BYTE    attr;           /* Object attribute */\r
-       BYTE    stat;           /* Object chain status (b1-0: =0:not contiguous, =2:contiguous (no data on FAT), =3:got flagmented, b2:sub-directory stretched) */\r
-       DWORD   sclust;         /* Object start cluster (0:no cluster or root directory) */\r
-       FSIZE_t objsize;        /* Object size (valid when sclust != 0) */\r
-#if _FS_EXFAT\r
-       DWORD   n_cont;         /* Size of coutiguous part, clusters - 1 (valid when stat == 3) */\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 sclust != 0) */\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 _FS_LOCK != 0\r
-       UINT    lockid;         /* File lock ID origin from 1 (index of file semaphore table Files[]) */\r
+#if FF_FS_LOCK\r
+       UINT    lockid;                 /* File lock ID origin from 1 (index of file semaphore table Files[]) */\r
 #endif\r
-} _FDID;\r
+} FFOBJID;\r
 \r
 \r
 \r
 /* File object structure (FIL) */\r
 \r
 typedef struct {\r
-       _FDID   obj;                    /* Object identifier (must be the 1st member to detect invalid object pointer) */\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 fprt is 0) */\r
+       DWORD   clust;                  /* Current cluster of fpter (invalid when fptr is 0) */\r
        DWORD   sect;                   /* Sector number appearing in buf[] (0:invalid) */\r
-#if !_FS_READONLY\r
-       DWORD   dir_sect;               /* Sector number containing the directory entry */\r
-       BYTE*   dir_ptr;                /* Pointer to the directory entry in the win[] */\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 _USE_FASTSEEK\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 !_FS_TINY\r
-       BYTE    buf[_MAX_SS];   /* File private data read/write window */\r
+#if !FF_FS_TINY\r
+       BYTE    buf[FF_MAX_SS]; /* File private data read/write window */\r
 #endif\r
 } FIL;\r
 \r
@@ -182,16 +188,16 @@ typedef struct {
 /* Directory object structure (DIR) */\r
 \r
 typedef struct {\r
-       _FDID   obj;                    /* Object identifier */\r
+       FFOBJID obj;                    /* Object identifier */\r
        DWORD   dptr;                   /* Current read/write offset */\r
        DWORD   clust;                  /* Current cluster */\r
-       DWORD   sect;                   /* Current sector */\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 _USE_LFN != 0\r
+#if FF_USE_LFN\r
        DWORD   blk_ofs;                /* Offset of current entry block being processed (0xFFFFFFFF:Invalid) */\r
 #endif\r
-#if _USE_FIND\r
+#if FF_USE_FIND\r
        const TCHAR* pat;               /* Pointer to the name matching pattern */\r
 #endif\r
 } DIR;\r
@@ -205,11 +211,11 @@ typedef struct {
        WORD    fdate;                  /* Modified date */\r
        WORD    ftime;                  /* Modified time */\r
        BYTE    fattrib;                /* File attribute */\r
-#if _USE_LFN != 0\r
-       TCHAR   altname[13];                    /* Altenative file name */\r
-       TCHAR   fname[_MAX_LFN + 1];    /* Primary file name */\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[13];              /* File name */\r
+       TCHAR   fname[12 + 1];  /* File name */\r
 #endif\r
 } FILINFO;\r
 \r
@@ -236,7 +242,7 @@ typedef enum {
        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 > _FS_LOCK */\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
@@ -274,6 +280,7 @@ FRESULT f_expand (FIL* fp, FSIZE_t szf, BYTE opt);                                  /* Allocate a contiguous
 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
@@ -285,6 +292,8 @@ TCHAR* f_gets (TCHAR* buff, int len, FIL* fp);                                              /* Get a string from the fil
 #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
@@ -297,26 +306,27 @@ TCHAR* f_gets (TCHAR* buff, int len, FIL* fp);                                            /* Get a string from the fil
 /* Additional user defined functions                            */\r
 \r
 /* RTC function */\r
-#if !_FS_READONLY && !_FS_NORTC\r
+#if !FF_FS_READONLY && !FF_FS_NORTC\r
 DWORD get_fattime (void);\r
 #endif\r
 \r
-/* Unicode support functions */\r
-#if _USE_LFN != 0                                              /* Unicode - OEM code conversion */\r
-WCHAR ff_convert (WCHAR chr, UINT dir);        /* OEM-Unicode bidirectional conversion */\r
-WCHAR ff_wtoupper (WCHAR chr);                 /* Unicode upper-case conversion */\r
-#if _USE_LFN == 3                                              /* Memory functions */\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
-#endif\r
 \r
 /* Sync functions */\r
-#if _FS_REENTRANT\r
-int ff_cre_syncobj (BYTE vol, _SYNC_t* sobj);  /* Create a sync object */\r
-int ff_req_grant (_SYNC_t sobj);                               /* Lock sync object */\r
-void ff_rel_grant (_SYNC_t sobj);                              /* Unlock sync object */\r
-int ff_del_syncobj (_SYNC_t sobj);                             /* Delete a sync object */\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
@@ -363,4 +373,4 @@ int ff_del_syncobj (_SYNC_t sobj);                          /* Delete a sync object */
 }\r
 #endif\r
 \r
-#endif /* _FATFS */\r
+#endif /* FF_DEFINED */\r