exfat_raw.h
Go to the documentation of this file.
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 #define BOOT_SIGNATURE 0xAA55
10 #define EXBOOT_SIGNATURE 0xAA550000
11 #define STR_EXFAT "EXFAT " /* size should be 8 */
12 
13 #define EXFAT_MAX_FILE_LEN 255
14 
15 #define VOLUME_DIRTY 0x0002
16 #define MEDIA_FAILURE 0x0004
17 
18 #define EXFAT_EOF_CLUSTER 0xFFFFFFFFu
19 #define EXFAT_BAD_CLUSTER 0xFFFFFFF7u
20 #define EXFAT_FREE_CLUSTER 0
21 /* Cluster 0, 1 are reserved, the first cluster is 2 in the cluster heap. */
22 #define EXFAT_RESERVED_CLUSTERS 2
23 #define EXFAT_FIRST_CLUSTER 2
24 #define EXFAT_DATA_CLUSTER_COUNT(sbi) ((sbi)->num_clusters - EXFAT_RESERVED_CLUSTERS)
25 
26 /* AllocationPossible and NoFatChain field in GeneralSecondaryFlags Field */
27 #define ALLOC_FAT_CHAIN 0x01
28 #define ALLOC_NO_FAT_CHAIN 0x03
29 
30 #define DENTRY_SIZE 32 /* directory entry size */
31 #define DENTRY_SIZE_BITS 5
32 /* exFAT allows 8388608(256MB) directory entries */
33 #define MAX_EXFAT_DENTRIES 8388608
34 
35 /* dentry types */
36 #define EXFAT_UNUSED 0x00 /* end of directory */
37 #define EXFAT_DELETE (~0x80)
38 #define IS_EXFAT_DELETED(x) ((x) < 0x80) /* deleted file (0x01~0x7F) */
39 #define EXFAT_INVAL 0x80 /* invalid value */
40 #define EXFAT_BITMAP 0x81 /* allocation bitmap */
41 #define EXFAT_UPCASE 0x82 /* upcase table */
42 #define EXFAT_VOLUME 0x83 /* volume label */
43 #define EXFAT_FILE 0x85 /* file or dir */
44 #define EXFAT_GUID 0xA0
45 #define EXFAT_PADDING 0xA1
46 #define EXFAT_ACLTAB 0xA2
47 #define EXFAT_STREAM 0xC0 /* stream entry */
48 #define EXFAT_NAME 0xC1 /* file name entry */
49 #define EXFAT_ACL 0xC2 /* stream entry */
50 
51 #define IS_EXFAT_CRITICAL_PRI(x) (x < 0xA0)
52 #define IS_EXFAT_BENIGN_PRI(x) (x < 0xC0)
53 #define IS_EXFAT_CRITICAL_SEC(x) (x < 0xE0)
54 
55 /* checksum types */
56 #define CS_DIR_ENTRY 0
57 #define CS_BOOT_SECTOR 1
58 #define CS_DEFAULT 2
59 
60 /* file attributes */
61 #define ATTR_READONLY 0x0001
62 #define ATTR_HIDDEN 0x0002
63 #define ATTR_SYSTEM 0x0004
64 #define ATTR_VOLUME 0x0008
65 #define ATTR_SUBDIR 0x0010
66 #define ATTR_ARCHIVE 0x0020
67 
68 #define ATTR_RWMASK (ATTR_HIDDEN | ATTR_SYSTEM | ATTR_VOLUME | ATTR_SUBDIR | ATTR_ARCHIVE)
69 
70 #define BOOTSEC_JUMP_BOOT_LEN 3
71 #define BOOTSEC_OLDBPB_LEN 53
72 
73 #define EXFAT_FILE_NAME_LEN 15
74 
75 #define EXFAT_MIN_SECT_SIZE_BITS 9
76 #define EXFAT_MAX_SECT_SIZE_BITS 12
77 #define EXFAT_MAX_SECT_PER_CLUS_BITS(x) (25 - (x)->sect_size_bits)
78 
79 /* EXFAT: Main and Backup Boot Sector (512 bytes) */
80 struct __attribute__((packed)) boot_sector_t {
82  uint64_t fs_type;
83  uint8_t must_be_zero[BOOTSEC_OLDBPB_LEN];
84  uint64_t partition_offset;
85  uint64_t vol_length;
86  uint32_t fat_offset;
87  uint32_t fat_length;
88  uint32_t clu_offset;
89  uint32_t clu_count;
90  uint32_t root_cluster;
91  uint32_t vol_serial;
99  uint8_t reserved[7];
100  uint8_t boot_code[390];
102 };
103 
104 struct __attribute__((packed)) exfat_dentry_t {
106  union {
107  struct __attribute__((packed)) {
109  uint16_t label[11];
111  } volume_label;
112  /* file directory entry */
113  struct __attribute__((packed)) {
129  uint8_t reserved2[7];
130  } file;
131  /* stream extension directory entry */
132  struct __attribute__((packed)) {
138  uint64_t valid_size;
139  uint32_t reserved3;
140  uint32_t start_clu;
141  uint64_t size;
142  } stream;
143  /* file name directory entry */
144  struct __attribute__((packed)) {
145  uint8_t flags;
147  } name;
148  /* allocation bitmap directory entry */
149  struct __attribute__((packed)) {
150  uint8_t flags;
151  uint8_t reserved[18];
152  uint32_t start_clu;
153  uint64_t size;
154  } bitmap;
155  /* up-case table directory entry */
156  struct __attribute__((packed)) {
157  uint8_t reserved1[3];
158  uint32_t checksum;
159  uint8_t reserved2[12];
160  uint32_t start_clu;
161  uint64_t size;
162  } upcase;
163  };
164 };
165 
166 static_assert(sizeof(exfat_dentry_t) == 32, "Bad exfat_dentry_t");
167 
168 #define EXFAT_TZ_VALID (1 << 7)
169 
170 /* Jan 1 GMT 00:00:00 1980 */
171 #define EXFAT_MIN_TIMESTAMP_SECS 315532800LL
172 /* Dec 31 GMT 23:59:59 2107 */
173 #define EXFAT_MAX_TIMESTAMP_SECS 4354819199LL
174 
175 #endif /* !_EXFAT_RAW_H */
uint32_t clu_count
Definition: exfat_raw.h:89
uint16_t create_date
Definition: exfat_raw.h:119
uint16_t name_hash
Definition: exfat_raw.h:136
uint8_t reserved1
Definition: exfat_raw.h:134
#define BOOTSEC_OLDBPB_LEN
Definition: exfat_raw.h:71
uint8_t flags
Definition: exfat_raw.h:133
uint64_t size
Definition: exfat_raw.h:141
uint8_t drv_sel
Definition: exfat_raw.h:97
uint8_t type
Definition: exfat_raw.h:105
uint64_t valid_size
Definition: exfat_raw.h:138
uint16_t checksum
Definition: exfat_raw.h:115
uint16_t reserved1
Definition: exfat_raw.h:117
uint16_t access_date
Definition: exfat_raw.h:123
uint32_t reserved3
Definition: exfat_raw.h:139
#define EXFAT_FILE_NAME_LEN
Definition: exfat_raw.h:73
uint16_t attr
Definition: exfat_raw.h:116
uint16_t modify_time
Definition: exfat_raw.h:120
uint16_t modify_date
Definition: exfat_raw.h:121
uint32_t clu_offset
Definition: exfat_raw.h:88
uint8_t modify_time_cs
Definition: exfat_raw.h:125
uint32_t checksum
Definition: exfat_raw.h:158
uint8_t access_tz
Definition: exfat_raw.h:128
uint8_t reserved
Definition: exfat_raw.h:110
uint32_t fat_length
Definition: exfat_raw.h:87
uint8_t sect_size_bits
Definition: exfat_raw.h:94
uint8_t num_chars
Definition: exfat_raw.h:108
Definition: exfat_raw.h:104
uint32_t vol_serial
Definition: exfat_raw.h:91
uint16_t create_time
Definition: exfat_raw.h:118
uint8_t num_ext
Definition: exfat_raw.h:114
uint16_t reserved2
Definition: exfat_raw.h:137
uint16_t signature
Definition: exfat_raw.h:101
uint32_t root_cluster
Definition: exfat_raw.h:90
uint16_t vol_flags
Definition: exfat_raw.h:93
uint32_t fat_offset
Definition: exfat_raw.h:86
uint8_t percent_in_use
Definition: exfat_raw.h:98
uint64_t fs_type
Definition: exfat_raw.h:82
uint8_t num_fats
Definition: exfat_raw.h:96
uint64_t partition_offset
Definition: exfat_raw.h:84
uint16_t access_time
Definition: exfat_raw.h:122
uint32_t start_clu
Definition: exfat_raw.h:140
uint64_t vol_length
Definition: exfat_raw.h:85
#define BOOTSEC_JUMP_BOOT_LEN
Definition: exfat_raw.h:70
uint8_t modify_tz
Definition: exfat_raw.h:127
uint8_t name_len
Definition: exfat_raw.h:135
uint8_t create_time_cs
Definition: exfat_raw.h:124
uint8_t create_tz
Definition: exfat_raw.h:126
Definition: exfat_raw.h:80
uint8_t sect_per_clus_bits
Definition: exfat_raw.h:95
uint16_t fs_revision
Definition: exfat_raw.h:92