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