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