New upstream version 1.0.3
[sven/exfatprogs.git] / include / exfat_ondisk.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  *  Copyright (C) 2019 Namjae Jeon <linkinjeon@kernel.org>
4  */
5
6 #ifndef _EXFAT_H
7 #define _EXFAT_H
8
9 #include <stdint.h>
10 #include <linux/fs.h>
11
12 #ifdef HAVE_CONFIG_H
13 #include <config.h>
14 #endif
15
16 #ifdef WORDS_BIGENDIAN
17 #define cpu_to_le16(x)  ((((x) >> 8) & 0xffu) | (((x) & 0xffu) << 8))
18 #define cpu_to_le32(x)  \
19         ((((x) & 0xff000000u) >> 24) | (((x) & 0x00ff0000u) >>  8) | \
20          (((x) & 0x0000ff00u) <<  8) | (((x) & 0x000000ffu) << 24))
21 #define cpu_to_le64(x)  (cpu_to_le32((uint64_t)(x)) << 32 | \
22                         cpu_to_le32((uint64_t)(x) >> 32))
23 #else
24 #define cpu_to_le16(x)  (x)
25 #define cpu_to_le32(x)  (x)
26 #define cpu_to_le64(x)  (x)
27 #endif
28
29 #define le64_to_cpu(x)  ((uint64_t)cpu_to_le64(x))
30 #define le32_to_cpu(x)  ((uint32_t)cpu_to_le32(x))
31 #define le16_to_cpu(x)  ((uint16_t)cpu_to_le16(x))
32
33 #define PBR_SIGNATURE           0xAA55
34
35 #define VOL_CLEAN               0x0000
36 #define VOL_DIRTY               0x0002
37
38 #define DENTRY_SIZE             32 /* directory entry size */
39 #define DENTRY_SIZE_BITS        5
40 /* exFAT allows 8388608(256MB) directory entries */
41 #define MAX_EXFAT_DENTRIES      8388608
42
43 /* dentry types */
44 #define MSDOS_DELETED           0xE5    /* deleted mark */
45 #define MSDOS_UNUSED            0x00    /* end of directory */
46
47 #define EXFAT_UNUSED            0x00    /* end of directory */
48 #define EXFAT_DELETE            ~(0x80)
49 #define IS_EXFAT_DELETED(x)     ((x) < 0x80) /* deleted file (0x01~0x7F) */
50 #define EXFAT_INVAL             0x80    /* invalid value */
51 #define EXFAT_BITMAP            0x81    /* allocation bitmap */
52 #define EXFAT_UPCASE            0x82    /* upcase table */
53 #define EXFAT_VOLUME            0x83    /* volume label */
54 #define EXFAT_FILE              0x85    /* file or dir */
55 #define EXFAT_GUID              0xA0
56 #define EXFAT_PADDING           0xA1
57 #define EXFAT_ACLTAB            0xA2
58 #define EXFAT_STREAM            0xC0    /* stream entry */
59 #define EXFAT_NAME              0xC1    /* file name entry */
60 #define EXFAT_ACL               0xC2    /* stream entry */
61
62 /* checksum types */
63 #define CS_DIR_ENTRY            0
64 #define CS_PBR_SECTOR           1
65 #define CS_DEFAULT              2
66
67 /* file attributes */
68 #define ATTR_READONLY           0x0001
69 #define ATTR_HIDDEN             0x0002
70 #define ATTR_SYSTEM             0x0004
71 #define ATTR_VOLUME             0x0008
72 #define ATTR_SUBDIR             0x0010
73 #define ATTR_ARCHIVE            0x0020
74 #define ATTR_EXTEND             (ATTR_READONLY | ATTR_HIDDEN | ATTR_SYSTEM | \
75                                  ATTR_VOLUME) /* 0x000F */
76
77 #define ATTR_EXTEND_MASK        (ATTR_EXTEND | ATTR_SUBDIR | ATTR_ARCHIVE)
78 #define ATTR_RWMASK             (ATTR_HIDDEN | ATTR_SYSTEM | ATTR_VOLUME | \
79                                  ATTR_SUBDIR | ATTR_ARCHIVE)
80
81 #define ATTR_READONLY_LE        cpu_to_le16(0x0001)
82 #define ATTR_HIDDEN_LE          cpu_to_le16(0x0002)
83 #define ATTR_SYSTEM_LE          cpu_to_le16(0x0004)
84 #define ATTR_VOLUME_LE          cpu_to_le16(0x0008)
85 #define ATTR_SUBDIR_LE          cpu_to_le16(0x0010)
86 #define ATTR_ARCHIVE_LE         cpu_to_le16(0x0020)
87
88 /* stream flags */
89 #define EXFAT_SF_CONTIGUOUS             0x02
90
91 #define CLUSTER_32(x)                   ((unsigned int)((x) & 0xFFFFFFFFU))
92 #define EXFAT_EOF_CLUSTER               CLUSTER_32(~0)
93 #define EXFAT_BAD_CLUSTER               (0xFFFFFFF7U)
94 #define EXFAT_FREE_CLUSTER              (0)
95 #define EXFAT_FIRST_CLUSTER             (2)
96 #define EXFAT_REVERVED_CLUSTERS         (2)
97
98
99 /* EXFAT BIOS parameter block (64 bytes) */
100 struct bpb64 {
101         __u8 jmp_boot[3];
102         __u8 oem_name[8];
103         __u8 res_zero[53];
104 };
105
106 /* EXFAT EXTEND BIOS parameter block (56 bytes) */
107 struct bsx64 {
108         __le64 vol_offset;
109         __le64 vol_length;
110         __le32 fat_offset;
111         __le32 fat_length;
112         __le32 clu_offset;
113         __le32 clu_count;
114         __le32 root_cluster;
115         __le32 vol_serial;
116         __u8 fs_version[2];
117         __le16 vol_flags;
118         __u8 sect_size_bits;
119         __u8 sect_per_clus_bits;
120         __u8 num_fats;
121         __u8 phy_drv_no;
122         __u8 perc_in_use;
123         __u8 reserved2[7];
124 };
125
126 /* Common PBR[Partition Boot Record] (512 bytes) */
127 struct pbr {
128         struct bpb64 bpb;
129         struct bsx64 bsx;
130         __u8 boot_code[390];
131         __le16 signature;
132 };
133
134 /* Extended Boot Sector */
135 struct exbs {
136         __u8 zero[510];
137         __le16 signature;
138 };
139
140 /* Extended Boot Record (8 sectors) */
141 struct expbr {
142         struct exbs eb[8];
143 };
144
145 #define VOLUME_LABEL_MAX_LEN    11
146 #define ENTRY_NAME_MAX          15
147
148 struct exfat_dentry {
149         __u8 type;
150         union {
151                 struct {
152                         __u8 character_count;
153                         __le16 volume_label[VOLUME_LABEL_MAX_LEN];
154                         __u8 reserved[8];
155                 } __attribute__((packed)) vol; /* file directory entry */
156
157                 struct {
158                         __u8 num_ext;
159                         __le16 checksum;
160                         __le16 attr;
161                         __le16 reserved1;
162                         __le16 create_time;
163                         __le16 create_date;
164                         __le16 modify_time;
165                         __le16 modify_date;
166                         __le16 access_time;
167                         __le16 access_date;
168                         __u8 create_time_ms;
169                         __u8 modify_time_ms;
170                         __u8 access_time_ms;
171                         __u8 reserved2[9];
172                 } __attribute__((packed)) file; /* file directory entry */
173                 struct {
174                         __u8 flags;
175                         __u8 reserved1;
176                         __u8 name_len;
177                         __le16 name_hash;
178                         __le16 reserved2;
179                         __le64 valid_size;
180                         __le32 reserved3;
181                         __le32 start_clu;
182                         __le64 size;
183                 } __attribute__((packed)) stream; /* stream extension directory entry */
184                 struct {
185                         __u8 flags;
186                         __le16 unicode_0_14[15];
187                 } __attribute__((packed)) name; /* file name directory entry */
188                 struct {
189                         __u8 flags;
190                         __u8 reserved[18];
191                         __le32 start_clu;
192                         __le64 size;
193                 } __attribute__((packed)) bitmap; /* allocation bitmap directory entry */
194                 struct {
195                         __u8 reserved1[3];
196                         __le32 checksum;
197                         __u8 reserved2[12];
198                         __le32 start_clu;
199                         __le64 size;
200                 } __attribute__((packed)) upcase; /* up-case table directory entry */
201         } __attribute__((packed)) dentry;
202 } __attribute__((packed));
203
204 #define vol_char_cnt                    dentry.vol.character_count
205 #define vol_label                       dentry.vol.volume_label
206 #define file_num_ext                    dentry.file.num_ext
207 #define file_checksum                   dentry.file.checksum
208 #define file_attr                       dentry.file.attr
209 #define file_create_time                dentry.file.create_time
210 #define file_create_date                dentry.file.create_date
211 #define file_modify_time                dentry.file.modify_time
212 #define file_modify_date                dentry.file.modify_date
213 #define file_access_time                dentry.file.access_time
214 #define file_access_date                dentry.file.access_date
215 #define file_create_time_ms             dentry.file.create_time_ms
216 #define file_modify_time_ms             dentry.file.modify_time_ms
217 #define file_access_time_ms             dentry.file.access_time_ms
218 #define stream_flags                    dentry.stream.flags
219 #define stream_name_len                 dentry.stream.name_len
220 #define stream_name_hash                dentry.stream.name_hash
221 #define stream_start_clu                dentry.stream.start_clu
222 #define stream_valid_size               dentry.stream.valid_size
223 #define stream_size                     dentry.stream.size
224 #define name_flags                      dentry.name.flags
225 #define name_unicode                    dentry.name.unicode_0_14
226 #define bitmap_flags                    dentry.bitmap.flags
227 #define bitmap_start_clu                dentry.bitmap.start_clu
228 #define bitmap_size                     dentry.bitmap.size
229 #define upcase_start_clu                dentry.upcase.start_clu
230 #define upcase_size                     dentry.upcase.size
231 #define upcase_checksum                 dentry.upcase.checksum
232
233 #endif /* !_EXFAT_H */