Merge branch 'chan-fatfs' into fatfs-integration

[z180-stamp.git] / fatfs / doc / en / sfatfs.html

diff --git a/fatfs/doc/en/sfatfs.html b/fatfs/doc/en/sfatfs.html
index b420850e195657b1fc15ab7409156643cd2c369c..e701f441fd61ff746d8090dde2472e913bd90c99 100644 (file)
--- a/fatfs/doc/en/sfatfs.html
+++ b/fatfs/doc/en/sfatfs.html
@@ -13,37 +13,45 @@
 \r
 <div class="para">\r
 <h2>FATFS</h2>\r
-<p>The <tt>FATFS</tt> structure (file system object) holds dynamic work area of individual logical drives. It is given by application program and registerd/unregisterd to the FatFs module with <tt>f_mount()</tt> function. Initialization is done on first API call after <tt>f_mount()</tt> function or media change. Application program must not modify any member in this structure.</p>\r
+<p>The <tt>FATFS</tt> structure (file system object) holds dynamic work area of individual logical drives. It is given by application program and registerd/unregisterd to the FatFs module with <tt>f_mount</tt> function. Initialization is done on first API call after <tt>f_mount</tt> function or media change. Application program must not modify any member in this structure, or any data on the FAT volume can be collapsed.</p>\r
 <pre>\r
 <span class="k">typedef</span> <span class="k">struct</span> {\r
-    BYTE    fs_type;      <span class="c">/* FAT sub-type (0:Not mounted) */</span>\r
+    BYTE    fs_type;      <span class="c">/* File system type (0, FS_FAT12, FS_FAT16, FS_FAT32 or FS_EXFAT) */</span>\r
     BYTE    drv;          <span class="c">/* Physical drive number */</span>\r
-    BYTE    csize;        <span class="c">/* Sectors per cluster (1,2,4,...,128) */</span>\r
     BYTE    n_fats;       <span class="c">/* Number of FAT copies (1,2) */</span>\r
     BYTE    wflag;        <span class="c">/* win[] flag (b0:win[] is dirty) */</span>\r
     BYTE    fsi_flag;     <span class="c">/* FSINFO flags (b7:Disabled, b0:Dirty) */</span>\r
     WORD    id;           <span class="c">/* File system mount ID */</span>\r
     WORD    n_rootdir;    <span class="c">/* Number of root directory entries (FAT12/16) */</span>\r
+    WORD    csize;        <span class="c">/* Sectors per cluster */</span>\r
 <span class="k">#if</span> _MAX_SS != _MIN_SS\r
     WORD    ssize;        <span class="c">/* Sector size (512,1024,2048 or 4096) */</span>\r
 <span class="k">#endif</span>\r
+<span class="k">#if _FS_EXFAT</span>\r
+    BYTE*   dirbuf;       <span class="c">/* Directory entry block scratchpad buffer */</span>\r
+<span class="k">#endif</span>\r
 <span class="k">#if</span> _FS_REENTRANT\r
     _SYNC_t sobj;         <span class="c">/* Identifier of sync object */</span>\r
 <span class="k">#endif</span>\r
 <span class="k">#if</span> !_FS_READONLY\r
-    DWORD   last_clust;   <span class="c">/* FSINFO: Last allocated cluster */</span>\r
-    DWORD   free_clust;   <span class="c">/* FSINFO: Number of free clusters */</span>\r
+    DWORD   last_clust;   <span class="c">/* FSINFO: Last allocated cluster (0xFFFFFFFF if invalid) */</span>\r
+    DWORD   free_clust;   <span class="c">/* FSINFO: Number of free clusters (0xFFFFFFFF if invalid) */</span>\r
 <span class="k">#endif</span>\r
 <span class="k">#if</span> _FS_RPATH\r
-    DWORD   cdir;         <span class="c">/* Current directory start cluster (0:root) */</span>\r
+    DWORD   cdir;         <span class="c">/* Cluster number of current directory (0:root) */</span>\r
+<span class="k">#if _FS_EXFAT</span>\r
+    DWORD   cdc_scl;      <span class="c">/* Containing directory start cluster (invalid when cdir is 0) */</span>\r
+    DWORD   cdc_size;     <span class="c">/* b31-b8:Size of containing directory, b7-b0: Chain status */</span>\r
+    DWORD   cdc_ofs;      <span class="c">/* Offset in the containing directory (invalid when cdir is 0) */</span>\r
+<span class="k">#endif</span>\r
 <span class="k">#endif</span>\r
-    DWORD   n_fatent;     <span class="c">/* Number of FAT entries (== Number of clusters + 2) */</span>\r
+    DWORD   n_fatent;     <span class="c">/* Number of FAT entries (Number of clusters + 2) */</span>\r
     DWORD   fsize;        <span class="c">/* Sectors per FAT */</span>\r
-    DWORD   volbase;      <span class="c">/* Volume start sector */</span>\r
-    DWORD   fatbase;      <span class="c">/* FAT area start sector */</span>\r
-    DWORD   dirbase;      <span class="c">/* Root directory area start sector (FAT32: Cluster#) */</span>\r
-    DWORD   database;     <span class="c">/* Data area start sector */</span>\r
-    DWORD   winsect;      <span class="c">/* Current sector appearing in the win[] */</span>\r
+    DWORD   volbase;      <span class="c">/* Volume base LBA */</span>\r
+    DWORD   fatbase;      <span class="c">/* FAT base LBA */</span>\r
+    DWORD   dirbase;      <span class="c">/* Root directory base (LBA|Cluster) */</span>\r
+    DWORD   database;     <span class="c">/* Data base LBA */</span>\r
+    DWORD   winsect;      <span class="c">/* Sector LBA appearing in the win[] */</span>\r
     BYTE    win[_MAX_SS]; <span class="c">/* Disk access window for directory, FAT (and file data at tiny cfg) */</span>\r
 } FATFS;\r
 </pre>\r