]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/documents/doc/sfatfs.html
Import fatfs R0.13b
[z180-stamp.git] / fatfs / documents / doc / sfatfs.html
diff --git a/fatfs/documents/doc/sfatfs.html b/fatfs/documents/doc/sfatfs.html
new file mode 100644 (file)
index 0000000..e5207cb
--- /dev/null
@@ -0,0 +1,62 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
+<html lang="en">\r
+<head>\r
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r
+<meta http-equiv="Content-Style-Type" content="text/css">\r
+<link rel="up" title="FatFs" href="../00index_e.html">\r
+<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/sfatfs.html">\r
+<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
+<title>FatFs - FATFS</title>\r
+</head>\r
+\r
+<body>\r
+\r
+<div class="para">\r
+<h2>FATFS</h2>\r
+<p>The <tt>FATFS</tt> structure (filesystem 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 of the structure is done by volume mount process whenever necessary. Application program <em>must not</em> modify any member in this structure, or the FAT volume will be collapsed.</p>\r
+<pre>\r
+<span class="k">typedef</span> <span class="k">struct</span> {\r
+    BYTE    fs_type;      <span class="c">/* FAT type (0, FS_FAT12, FS_FAT16, FS_FAT32 or FS_EXFAT) */</span>\r
+    BYTE    pdrv;         <span class="c">/* Hosting physical drive of this volume */</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">/* Volume 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> FF_MAX_SS != FF_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</span> FF_FS_EXFAT\r
+    BYTE*   dirbuf;       <span class="c">/* Directory entry block scratchpad buffer */</span>\r
+<span class="k">#endif</span>\r
+<span class="k">#if</span> FF_FS_REENTRANT\r
+    FF_SYNC_t sobj;         <span class="c">/* Identifier of sync object */</span>\r
+<span class="k">#endif</span>\r
+<span class="k">#if</span> !FF_FS_READONLY\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> FF_FS_RPATH\r
+    DWORD   cdir;         <span class="c">/* Cluster number of current directory (0:root) */</span>\r
+<span class="k">#if</span> FF_FS_EXFAT\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   fsize;        <span class="c">/* Sectors per FAT */</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[FF_MAX_SS]; <span class="c">/* Disk access window for directory, FAT (and file data at tiny cfg) */</span>\r
+} FATFS;\r
+</pre>\r
+</div>\r
+\r
+<p class="foot"><a href="../00index_e.html">Return</a></p>\r
+</body>\r
+</html>\r