Imported Upstream version 0.9.5
[sven/exfat-utils.git] / libexfat / exfatfs.h
1 /*
2         exfatfs.h (29.08.09)
3         Definitions of structures and constants used in exFAT file system.
4
5         Copyright (C) 2009, 2010  Andrew Nayenko
6
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.
11
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.
16
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/>.
19 */
20
21 #ifndef EXFATFS_H_INCLUDED
22 #define EXFATFS_H_INCLUDED
23
24 #include "byteorder.h"
25
26 typedef uint32_t cluster_t;             /* cluster number */
27
28 #define EXFAT_FIRST_DATA_CLUSTER 2
29
30 #define EXFAT_CLUSTER_FREE         0 /* free cluster */
31 #define EXFAT_CLUSTER_BAD 0xfffffff7 /* cluster contains bad sector */
32 #define EXFAT_CLUSTER_END 0xffffffff /* final cluster of file or directory */
33
34 struct exfat_super_block
35 {
36         uint8_t jump[3];                                /* 0x00 jmp and nop instructions */
37         uint8_t oem_name[8];                    /* 0x03 "EXFAT   " */
38         uint8_t __unused1[53];                  /* 0x0B always 0 */
39         le64_t sector_start;                    /* 0x40 partition first sector */
40         le64_t sector_count;                    /* 0x48 partition sectors count */
41         le32_t fat_sector_start;                /* 0x50 FAT first sector */
42         le32_t fat_sector_count;                /* 0x54 FAT sectors count */
43         le32_t cluster_sector_start;    /* 0x58 first cluster sector */
44         le32_t cluster_count;                   /* 0x5C total clusters count */
45         le32_t rootdir_cluster;                 /* 0x60 first cluster of the root dir */
46         le32_t volume_serial;                   /* 0x64 volume serial number */
47         struct                                                  /* 0x68 FS version */
48         {
49                 uint8_t minor;
50                 uint8_t major;
51         }
52         version;
53         le16_t volume_state;                    /* 0x6A volume state flags */
54         uint8_t sector_bits;                    /* 0x6C sector size as (1 << n) */
55         uint8_t spc_bits;                               /* 0x6D sectors per cluster as (1 << n) */
56         uint8_t fat_count;                              /* 0x6E always 1 */
57         uint8_t drive_no;                               /* 0x6F always 0x80 */
58         uint8_t allocated_percent;              /* 0x70 percentage of allocated space */
59         uint8_t __unused2[397];                 /* 0x71 always 0 */
60         le16_t boot_signature;                  /* the value of 0xAA55 */
61 }
62 __attribute__((__packed__));
63
64 #define EXFAT_ENTRY_VALID     0x80
65 #define EXFAT_ENTRY_CONTINUED 0x40
66
67 #define EXFAT_ENTRY_EOD       (0x00)
68 #define EXFAT_ENTRY_BITMAP    (0x01 | EXFAT_ENTRY_VALID)
69 #define EXFAT_ENTRY_UPCASE    (0x02 | EXFAT_ENTRY_VALID)
70 #define EXFAT_ENTRY_LABEL     (0x03 | EXFAT_ENTRY_VALID)
71 #define EXFAT_ENTRY_FILE      (0x05 | EXFAT_ENTRY_VALID)
72 #define EXFAT_ENTRY_FILE_INFO (0x00 | EXFAT_ENTRY_VALID | EXFAT_ENTRY_CONTINUED)
73 #define EXFAT_ENTRY_FILE_NAME (0x01 | EXFAT_ENTRY_VALID | EXFAT_ENTRY_CONTINUED)
74
75 struct exfat_entry                                      /* common container for all entries */
76 {
77         uint8_t type;                                   /* any of EXFAT_ENTRY_xxx */
78         uint8_t data[31];
79 }
80 __attribute__((__packed__));
81
82 #define EXFAT_ENAME_MAX 15
83
84 struct exfat_entry_bitmap                       /* allocated clusters bitmap */
85 {
86         uint8_t type;                                   /* EXFAT_ENTRY_BITMAP */
87         uint8_t __unknown1[19];
88         le32_t start_cluster;
89         le64_t size;                                    /* in bytes */
90 }
91 __attribute__((__packed__));
92
93 struct exfat_entry_upcase                       /* upper case translation table */
94 {
95         uint8_t type;                                   /* EXFAT_ENTRY_UPCASE */
96         uint8_t __unknown1[3];
97         le32_t checksum;
98         uint8_t __unknown2[12];
99         le32_t start_cluster;
100         le64_t size;                                    /* in bytes */
101 }
102 __attribute__((__packed__));
103
104 struct exfat_entry_label                        /* volume label */
105 {
106         uint8_t type;                                   /* EXFAT_ENTRY_LABEL */
107         uint8_t length;                                 /* number of characters */
108         le16_t name[EXFAT_ENAME_MAX];   /* in UTF-16LE */
109 }
110 __attribute__((__packed__));
111
112 #define EXFAT_ATTRIB_RO     0x01
113 #define EXFAT_ATTRIB_HIDDEN 0x02
114 #define EXFAT_ATTRIB_SYSTEM 0x04
115 #define EXFAT_ATTRIB_VOLUME 0x08
116 #define EXFAT_ATTRIB_DIR    0x10
117 #define EXFAT_ATTRIB_ARCH   0x20
118
119 struct exfat_entry_meta1                        /* file or directory info (part 1) */
120 {
121         uint8_t type;                                   /* EXFAT_ENTRY_FILE */
122         uint8_t continuations;
123         le16_t checksum;
124         le16_t attrib;                                  /* combination of EXFAT_ATTRIB_xxx */
125         le16_t __unknown1;
126         le16_t crtime, crdate;                  /* creation date and time */
127         le16_t mtime, mdate;                    /* latest modification date and time */
128         le16_t atime, adate;                    /* latest access date and time */
129         uint8_t crtime_cs;                              /* creation time in cs (centiseconds) */
130         uint8_t mtime_cs;                               /* latest modification time in cs */
131         uint8_t __unknown2[10];
132 }
133 __attribute__((__packed__));
134
135 #define EXFAT_FLAG_ALWAYS1              (1u << 0)
136 #define EXFAT_FLAG_CONTIGUOUS   (1u << 1)
137
138 struct exfat_entry_meta2                        /* file or directory info (part 2) */
139 {
140         uint8_t type;                                   /* EXFAT_ENTRY_FILE_INFO */
141         uint8_t flags;                                  /* combination of EXFAT_FLAG_xxx */
142         uint8_t __unknown1;
143         uint8_t name_length;
144         le16_t name_hash;
145         le16_t __unknown2;
146         le64_t real_size;                               /* in bytes, equals to size */
147         uint8_t __unknown3[4];
148         le32_t start_cluster;
149         le64_t size;                                    /* in bytes, equals to real_size */
150 }
151 __attribute__((__packed__));
152
153 struct exfat_entry_name                         /* file or directory name */
154 {
155         uint8_t type;                                   /* EXFAT_ENTRY_FILE_NAME */
156         uint8_t __unknown;
157         le16_t name[EXFAT_ENAME_MAX];   /* in UTF-16LE */
158 }
159 __attribute__((__packed__));
160
161 #endif /* ifndef EXFATFS_H_INCLUDED */