]> cloudbase.mooo.com Git - z180-stamp.git/blame - fatfs/doc/en/sfatfs.html
Merge branch 'chan-fatfs' into fatfs-integration
[z180-stamp.git] / fatfs / doc / en / sfatfs.html
CommitLineData
53668523
L
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
2<html lang="en">\r
3<head>\r
4<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
5<meta http-equiv="Content-Style-Type" content="text/css">\r
6<link rel="up" title="FatFs" href="../00index_e.html">\r
7<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/sfatfs.html">\r
8<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
9<title>FatFs - FATFS</title>\r
10</head>\r
11\r
12<body>\r
13\r
14<div class="para">\r
15<h2>FATFS</h2>\r
70702af1 16<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
53668523
L
17<pre>\r
18<span class="k">typedef</span> <span class="k">struct</span> {\r
70702af1 19 BYTE fs_type; <span class="c">/* File system type (0, FS_FAT12, FS_FAT16, FS_FAT32 or FS_EXFAT) */</span>\r
53668523 20 BYTE drv; <span class="c">/* Physical drive number */</span>\r
53668523
L
21 BYTE n_fats; <span class="c">/* Number of FAT copies (1,2) */</span>\r
22 BYTE wflag; <span class="c">/* win[] flag (b0:win[] is dirty) */</span>\r
23 BYTE fsi_flag; <span class="c">/* FSINFO flags (b7:Disabled, b0:Dirty) */</span>\r
24 WORD id; <span class="c">/* File system mount ID */</span>\r
25 WORD n_rootdir; <span class="c">/* Number of root directory entries (FAT12/16) */</span>\r
70702af1 26 WORD csize; <span class="c">/* Sectors per cluster */</span>\r
53668523
L
27<span class="k">#if</span> _MAX_SS != _MIN_SS\r
28 WORD ssize; <span class="c">/* Sector size (512,1024,2048 or 4096) */</span>\r
29<span class="k">#endif</span>\r
70702af1
L
30<span class="k">#if _FS_EXFAT</span>\r
31 BYTE* dirbuf; <span class="c">/* Directory entry block scratchpad buffer */</span>\r
32<span class="k">#endif</span>\r
53668523
L
33<span class="k">#if</span> _FS_REENTRANT\r
34 _SYNC_t sobj; <span class="c">/* Identifier of sync object */</span>\r
35<span class="k">#endif</span>\r
36<span class="k">#if</span> !_FS_READONLY\r
70702af1
L
37 DWORD last_clust; <span class="c">/* FSINFO: Last allocated cluster (0xFFFFFFFF if invalid) */</span>\r
38 DWORD free_clust; <span class="c">/* FSINFO: Number of free clusters (0xFFFFFFFF if invalid) */</span>\r
53668523
L
39<span class="k">#endif</span>\r
40<span class="k">#if</span> _FS_RPATH\r
70702af1
L
41 DWORD cdir; <span class="c">/* Cluster number of current directory (0:root) */</span>\r
42<span class="k">#if _FS_EXFAT</span>\r
43 DWORD cdc_scl; <span class="c">/* Containing directory start cluster (invalid when cdir is 0) */</span>\r
44 DWORD cdc_size; <span class="c">/* b31-b8:Size of containing directory, b7-b0: Chain status */</span>\r
45 DWORD cdc_ofs; <span class="c">/* Offset in the containing directory (invalid when cdir is 0) */</span>\r
46<span class="k">#endif</span>\r
53668523 47<span class="k">#endif</span>\r
70702af1 48 DWORD n_fatent; <span class="c">/* Number of FAT entries (Number of clusters + 2) */</span>\r
53668523 49 DWORD fsize; <span class="c">/* Sectors per FAT */</span>\r
70702af1
L
50 DWORD volbase; <span class="c">/* Volume base LBA */</span>\r
51 DWORD fatbase; <span class="c">/* FAT base LBA */</span>\r
52 DWORD dirbase; <span class="c">/* Root directory base (LBA|Cluster) */</span>\r
53 DWORD database; <span class="c">/* Data base LBA */</span>\r
54 DWORD winsect; <span class="c">/* Sector LBA appearing in the win[] */</span>\r
53668523
L
55 BYTE win[_MAX_SS]; <span class="c">/* Disk access window for directory, FAT (and file data at tiny cfg) */</span>\r
56} FATFS;\r
57</pre>\r
58</div>\r
59\r
60<p class="foot"><a href="../00index_e.html">Return</a></p>\r
61</body>\r
62</html>\r