xref: /linux/fs/exfat/exfat_raw.h (revision 4129a3a2751cba8511cee5d13145223662a8e019)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Copyright (C) 2012-2013 Samsung Electronics Co., Ltd.
4  */
5 
6 #ifndef _EXFAT_RAW_H
7 #define _EXFAT_RAW_H
8 
9 #include <linux/types.h>
10 
11 #define BOOT_SIGNATURE		0xAA55
12 #define EXBOOT_SIGNATURE	0xAA550000
13 #define STR_EXFAT		"EXFAT   "	/* size should be 8 */
14 
15 #define EXFAT_MAX_FILE_LEN	255
16 
17 #define VOLUME_DIRTY		0x0002
18 #define MEDIA_FAILURE		0x0004
19 
20 #define EXFAT_EOF_CLUSTER	0xFFFFFFFFu
21 #define EXFAT_BAD_CLUSTER	0xFFFFFFF7u
22 #define EXFAT_FREE_CLUSTER	0
23 /* Cluster 0, 1 are reserved, the first cluster is 2 in the cluster heap. */
24 #define EXFAT_RESERVED_CLUSTERS	2
25 #define EXFAT_FIRST_CLUSTER	2
26 #define EXFAT_DATA_CLUSTER_COUNT(sbi)	\
27 	((sbi)->num_clusters - EXFAT_RESERVED_CLUSTERS)
28 #define EXFAT_MAX_NUM_CLUSTER		(0xFFFFFFF5)
29 
30 /* AllocationPossible and NoFatChain field in GeneralSecondaryFlags Field */
31 #define ALLOC_POSSIBLE		0x01
32 #define ALLOC_FAT_CHAIN		0x01
33 #define ALLOC_NO_FAT_CHAIN	0x03
34 
35 #define DENTRY_SIZE		32 /* directory entry size */
36 #define DENTRY_SIZE_BITS	5
37 /* exFAT allows 8388608(256MB) directory entries */
38 #define MAX_EXFAT_DENTRIES	8388608
39 
40 /* dentry types */
41 #define EXFAT_UNUSED		0x00	/* end of directory */
42 #define EXFAT_DELETE		(~0x80)
43 #define IS_EXFAT_DELETED(x)	((x) < 0x80) /* deleted file (0x01~0x7F) */
44 #define EXFAT_INVAL		0x80	/* invalid value */
45 #define EXFAT_BITMAP		0x81	/* allocation bitmap */
46 #define EXFAT_UPCASE		0x82	/* upcase table */
47 #define EXFAT_VOLUME		0x83	/* volume label */
48 #define EXFAT_FILE		0x85	/* file or dir */
49 #define EXFAT_GUID		0xA0
50 #define EXFAT_PADDING		0xA1
51 #define EXFAT_ACLTAB		0xA2
52 #define EXFAT_STREAM		0xC0	/* stream entry */
53 #define EXFAT_NAME		0xC1	/* file name entry */
54 #define EXFAT_ACL		0xC2	/* stream entry */
55 #define EXFAT_VENDOR_EXT	0xE0	/* vendor extension entry */
56 #define EXFAT_VENDOR_ALLOC	0xE1	/* vendor allocation entry */
57 
58 #define IS_EXFAT_CRITICAL_PRI(x)	(x < 0xA0)
59 #define IS_EXFAT_BENIGN_PRI(x)		(x < 0xC0)
60 #define IS_EXFAT_CRITICAL_SEC(x)	(x < 0xE0)
61 
62 /* checksum types */
63 #define CS_DIR_ENTRY		0
64 #define CS_BOOT_SECTOR		1
65 #define CS_DEFAULT		2
66 
67 /* file attributes */
68 #define EXFAT_ATTR_READONLY	0x0001
69 #define EXFAT_ATTR_HIDDEN	0x0002
70 #define EXFAT_ATTR_SYSTEM	0x0004
71 #define EXFAT_ATTR_VOLUME	0x0008
72 #define EXFAT_ATTR_SUBDIR	0x0010
73 #define EXFAT_ATTR_ARCHIVE	0x0020
74 
75 #define EXFAT_ATTR_RWMASK	(EXFAT_ATTR_HIDDEN | EXFAT_ATTR_SYSTEM | \
76 				 EXFAT_ATTR_VOLUME | EXFAT_ATTR_SUBDIR | \
77 				 EXFAT_ATTR_ARCHIVE)
78 
79 #define BOOTSEC_JUMP_BOOT_LEN		3
80 #define BOOTSEC_FS_NAME_LEN		8
81 #define BOOTSEC_OLDBPB_LEN		53
82 
83 #define EXFAT_FILE_NAME_LEN		15
84 #define EXFAT_VOLUME_LABEL_LEN		11
85 
86 #define EXFAT_MIN_SECT_SIZE_BITS		9
87 #define EXFAT_MAX_SECT_SIZE_BITS		12
88 #define EXFAT_MAX_SECT_PER_CLUS_BITS(x)		(25 - (x)->sect_size_bits)
89 
90 /* EXFAT: Main and Backup Boot Sector (512 bytes) */
91 struct boot_sector {
92 	__u8	jmp_boot[BOOTSEC_JUMP_BOOT_LEN];
93 	__u8	fs_name[BOOTSEC_FS_NAME_LEN];
94 	__u8	must_be_zero[BOOTSEC_OLDBPB_LEN];
95 	__le64	partition_offset;
96 	__le64	vol_length;
97 	__le32	fat_offset;
98 	__le32	fat_length;
99 	__le32	clu_offset;
100 	__le32	clu_count;
101 	__le32	root_cluster;
102 	__le32	vol_serial;
103 	__u8	fs_revision[2];
104 	__le16	vol_flags;
105 	__u8	sect_size_bits;
106 	__u8	sect_per_clus_bits;
107 	__u8	num_fats;
108 	__u8	drv_sel;
109 	__u8	percent_in_use;
110 	__u8	reserved[7];
111 	__u8	boot_code[390];
112 	__le16	signature;
113 } __packed;
114 
115 struct exfat_dentry {
116 	__u8 type;
117 	union {
118 		struct {
119 			__u8 num_ext;
120 			__le16 checksum;
121 			__le16 attr;
122 			__le16 reserved1;
123 			__le16 create_time;
124 			__le16 create_date;
125 			__le16 modify_time;
126 			__le16 modify_date;
127 			__le16 access_time;
128 			__le16 access_date;
129 			__u8 create_time_cs;
130 			__u8 modify_time_cs;
131 			__u8 create_tz;
132 			__u8 modify_tz;
133 			__u8 access_tz;
134 			__u8 reserved2[7];
135 		} __packed file; /* file directory entry */
136 		struct {
137 			__u8 flags;
138 			__u8 reserved1;
139 			__u8 name_len;
140 			__le16 name_hash;
141 			__le16 reserved2;
142 			__le64 valid_size;
143 			__le32 reserved3;
144 			__le32 start_clu;
145 			__le64 size;
146 		} __packed stream; /* stream extension directory entry */
147 		struct {
148 			__u8 flags;
149 			__le16 unicode_0_14[EXFAT_FILE_NAME_LEN];
150 		} __packed name; /* file name directory entry */
151 		struct {
152 			__u8 flags;
153 			__u8 reserved[18];
154 			__le32 start_clu;
155 			__le64 size;
156 		} __packed bitmap; /* allocation bitmap directory entry */
157 		struct {
158 			__u8 reserved1[3];
159 			__le32 checksum;
160 			__u8 reserved2[12];
161 			__le32 start_clu;
162 			__le64 size;
163 		} __packed upcase; /* up-case table directory entry */
164 		struct {
165 			__u8 char_count;
166 			__le16 volume_label[EXFAT_VOLUME_LABEL_LEN];
167 			__u8 reserved[8];
168 		} __packed volume_label; /* volume label directory entry */
169 		struct {
170 			__u8 flags;
171 			__u8 vendor_guid[16];
172 			__u8 vendor_defined[14];
173 		} __packed vendor_ext; /* vendor extension directory entry */
174 		struct {
175 			__u8 flags;
176 			__u8 vendor_guid[16];
177 			__u8 vendor_defined[2];
178 			__le32 start_clu;
179 			__le64 size;
180 		} __packed vendor_alloc; /* vendor allocation directory entry */
181 		struct {
182 			__u8 flags;
183 			__u8 custom_defined[18];
184 			__le32 start_clu;
185 			__le64 size;
186 		} __packed generic_secondary; /* generic secondary directory entry */
187 	} __packed dentry;
188 } __packed;
189 
190 #define EXFAT_TZ_VALID		(1 << 7)
191 
192 /* Jan 1 GMT 00:00:00 1980 */
193 #define EXFAT_MIN_TIMESTAMP_SECS    315532800LL
194 /* Dec 31 GMT 23:59:59 2107 */
195 #define EXFAT_MAX_TIMESTAMP_SECS    4354819199LL
196 
197 #endif /* !_EXFAT_RAW_H */
198