3 Definitions of structures and constants used in exFAT file system.
5 Copyright (C) 2010-2013 Andrew Nayenko
7 This program is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #ifndef EXFATFS_H_INCLUDED
22 #define EXFATFS_H_INCLUDED
24 #include "byteorder.h"
26 typedef uint32_t cluster_t; /* cluster number */
28 #define EXFAT_FIRST_DATA_CLUSTER 2
29 #define EXFAT_LAST_DATA_CLUSTER 0xfffffff6
31 #define EXFAT_CLUSTER_FREE 0 /* free cluster */
32 #define EXFAT_CLUSTER_BAD 0xfffffff7 /* cluster contains bad sector */
33 #define EXFAT_CLUSTER_END 0xffffffff /* final cluster of file or directory */
35 #define EXFAT_STATE_MOUNTED 2
37 struct exfat_super_block
39 uint8_t jump[3]; /* 0x00 jmp and nop instructions */
40 uint8_t oem_name[8]; /* 0x03 "EXFAT " */
41 uint8_t __unused1[53]; /* 0x0B always 0 */
42 le64_t sector_start; /* 0x40 partition first sector */
43 le64_t sector_count; /* 0x48 partition sectors count */
44 le32_t fat_sector_start; /* 0x50 FAT first sector */
45 le32_t fat_sector_count; /* 0x54 FAT sectors count */
46 le32_t cluster_sector_start; /* 0x58 first cluster sector */
47 le32_t cluster_count; /* 0x5C total clusters count */
48 le32_t rootdir_cluster; /* 0x60 first cluster of the root dir */
49 le32_t volume_serial; /* 0x64 volume serial number */
50 struct /* 0x68 FS version */
56 le16_t volume_state; /* 0x6A volume state flags */
57 uint8_t sector_bits; /* 0x6C sector size as (1 << n) */
58 uint8_t spc_bits; /* 0x6D sectors per cluster as (1 << n) */
59 uint8_t fat_count; /* 0x6E always 1 */
60 uint8_t drive_no; /* 0x6F always 0x80 */
61 uint8_t allocated_percent; /* 0x70 percentage of allocated space */
62 uint8_t __unused2[397]; /* 0x71 always 0 */
63 le16_t boot_signature; /* the value of 0xAA55 */
66 STATIC_ASSERT(sizeof(struct exfat_super_block) == 512);
68 #define EXFAT_ENTRY_VALID 0x80
69 #define EXFAT_ENTRY_CONTINUED 0x40
71 #define EXFAT_ENTRY_BITMAP (0x01 | EXFAT_ENTRY_VALID)
72 #define EXFAT_ENTRY_UPCASE (0x02 | EXFAT_ENTRY_VALID)
73 #define EXFAT_ENTRY_LABEL (0x03 | EXFAT_ENTRY_VALID)
74 #define EXFAT_ENTRY_FILE (0x05 | EXFAT_ENTRY_VALID)
75 #define EXFAT_ENTRY_FILE_INFO (0x00 | EXFAT_ENTRY_VALID | EXFAT_ENTRY_CONTINUED)
76 #define EXFAT_ENTRY_FILE_NAME (0x01 | EXFAT_ENTRY_VALID | EXFAT_ENTRY_CONTINUED)
78 struct exfat_entry /* common container for all entries */
80 uint8_t type; /* any of EXFAT_ENTRY_xxx */
84 STATIC_ASSERT(sizeof(struct exfat_entry) == 32);
86 #define EXFAT_ENAME_MAX 15
88 struct exfat_entry_bitmap /* allocated clusters bitmap */
90 uint8_t type; /* EXFAT_ENTRY_BITMAP */
91 uint8_t __unknown1[19];
93 le64_t size; /* in bytes */
96 STATIC_ASSERT(sizeof(struct exfat_entry_bitmap) == 32);
98 struct exfat_entry_upcase /* upper case translation table */
100 uint8_t type; /* EXFAT_ENTRY_UPCASE */
101 uint8_t __unknown1[3];
103 uint8_t __unknown2[12];
104 le32_t start_cluster;
105 le64_t size; /* in bytes */
108 STATIC_ASSERT(sizeof(struct exfat_entry_upcase) == 32);
110 struct exfat_entry_label /* volume label */
112 uint8_t type; /* EXFAT_ENTRY_LABEL */
113 uint8_t length; /* number of characters */
114 le16_t name[EXFAT_ENAME_MAX]; /* in UTF-16LE */
117 STATIC_ASSERT(sizeof(struct exfat_entry_label) == 32);
119 #define EXFAT_ATTRIB_RO 0x01
120 #define EXFAT_ATTRIB_HIDDEN 0x02
121 #define EXFAT_ATTRIB_SYSTEM 0x04
122 #define EXFAT_ATTRIB_VOLUME 0x08
123 #define EXFAT_ATTRIB_DIR 0x10
124 #define EXFAT_ATTRIB_ARCH 0x20
126 struct exfat_entry_meta1 /* file or directory info (part 1) */
128 uint8_t type; /* EXFAT_ENTRY_FILE */
129 uint8_t continuations;
131 le16_t attrib; /* combination of EXFAT_ATTRIB_xxx */
133 le16_t crtime, crdate; /* creation date and time */
134 le16_t mtime, mdate; /* latest modification date and time */
135 le16_t atime, adate; /* latest access date and time */
136 uint8_t crtime_cs; /* creation time in cs (centiseconds) */
137 uint8_t mtime_cs; /* latest modification time in cs */
138 uint8_t __unknown2[10];
141 STATIC_ASSERT(sizeof(struct exfat_entry_meta1) == 32);
143 #define EXFAT_FLAG_ALWAYS1 (1u << 0)
144 #define EXFAT_FLAG_CONTIGUOUS (1u << 1)
146 struct exfat_entry_meta2 /* file or directory info (part 2) */
148 uint8_t type; /* EXFAT_ENTRY_FILE_INFO */
149 uint8_t flags; /* combination of EXFAT_FLAG_xxx */
154 le64_t real_size; /* in bytes, equals to size */
155 uint8_t __unknown3[4];
156 le32_t start_cluster;
157 le64_t size; /* in bytes, equals to real_size */
160 STATIC_ASSERT(sizeof(struct exfat_entry_meta2) == 32);
162 struct exfat_entry_name /* file or directory name */
164 uint8_t type; /* EXFAT_ENTRY_FILE_NAME */
166 le16_t name[EXFAT_ENAME_MAX]; /* in UTF-16LE */
169 STATIC_ASSERT(sizeof(struct exfat_entry_name) == 32);
171 #endif /* ifndef EXFATFS_H_INCLUDED */