fs/exfat/exfat_raw.h

   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
  29 /* AllocationPossible and NoFatChain field in GeneralSecondaryFlags Field */
  30 #define ALLOC_POSSIBLE          0x01
  31 #define ALLOC_FAT_CHAIN         0x01
  32 #define ALLOC_NO_FAT_CHAIN      0x03
  33
  34 #define DENTRY_SIZE             32 /* directory entry size */
  35 #define DENTRY_SIZE_BITS        5
  36 /* exFAT allows 8388608(256MB) directory entries */
  37 #define MAX_EXFAT_DENTRIES      8388608
  38
  39 /* dentry types */
  40 #define EXFAT_UNUSED            0x00    /* end of directory */
  41 #define EXFAT_DELETE            (~0x80)
  42 #define IS_EXFAT_DELETED(x)     ((x) < 0x80) /* deleted file (0x01~0x7F) */
  43 #define EXFAT_INVAL             0x80    /* invalid value */
  44 #define EXFAT_BITMAP            0x81    /* allocation bitmap */
  45 #define EXFAT_UPCASE            0x82    /* upcase table */
  46 #define EXFAT_VOLUME            0x83    /* volume label */
  47 #define EXFAT_FILE              0x85    /* file or dir */
  48 #define EXFAT_GUID              0xA0
  49 #define EXFAT_PADDING           0xA1
  50 #define EXFAT_ACLTAB            0xA2
  51 #define EXFAT_STREAM            0xC0    /* stream entry */
  52 #define EXFAT_NAME              0xC1    /* file name entry */
  53 #define EXFAT_ACL               0xC2    /* stream entry */
  54 #define EXFAT_VENDOR_EXT        0xE0    /* vendor extension entry */
  55 #define EXFAT_VENDOR_ALLOC      0xE1    /* vendor allocation entry */
  56
  57 #define IS_EXFAT_CRITICAL_PRI(x)        (x < 0xA0)
  58 #define IS_EXFAT_BENIGN_PRI(x)          (x < 0xC0)
  59 #define IS_EXFAT_CRITICAL_SEC(x)        (x < 0xE0)
  60
  61 /* checksum types */
  62 #define CS_DIR_ENTRY            0
  63 #define CS_BOOT_SECTOR          1
  64 #define CS_DEFAULT              2
  65
  66 /* file attributes */
  67 #define ATTR_READONLY           0x0001
  68 #define ATTR_HIDDEN             0x0002
  69 #define ATTR_SYSTEM             0x0004
  70 #define ATTR_VOLUME             0x0008
  71 #define ATTR_SUBDIR             0x0010
  72 #define ATTR_ARCHIVE            0x0020
  73
  74 #define ATTR_RWMASK             (ATTR_HIDDEN | ATTR_SYSTEM | ATTR_VOLUME | \
  75                                  ATTR_SUBDIR | ATTR_ARCHIVE)
  76
  77 #define BOOTSEC_JUMP_BOOT_LEN           3
  78 #define BOOTSEC_FS_NAME_LEN             8
  79 #define BOOTSEC_OLDBPB_LEN              53
  80
  81 #define EXFAT_FILE_NAME_LEN             15
  82
  83 #define EXFAT_MIN_SECT_SIZE_BITS                9
  84 #define EXFAT_MAX_SECT_SIZE_BITS                12
  85 #define EXFAT_MAX_SECT_PER_CLUS_BITS(x)         (25 - (x)->sect_size_bits)
  86
  87 /* EXFAT: Main and Backup Boot Sector (512 bytes) */
  88 struct boot_sector {
  89         __u8    jmp_boot[BOOTSEC_JUMP_BOOT_LEN];
  90         __u8    fs_name[BOOTSEC_FS_NAME_LEN];
  91         __u8    must_be_zero[BOOTSEC_OLDBPB_LEN];
  92         __le64  partition_offset;
  93         __le64  vol_length;
  94         __le32  fat_offset;
  95         __le32  fat_length;
  96         __le32  clu_offset;
  97         __le32  clu_count;
  98         __le32  root_cluster;
  99         __le32  vol_serial;
 100         __u8    fs_revision[2];
 101         __le16  vol_flags;
 102         __u8    sect_size_bits;
 103         __u8    sect_per_clus_bits;
 104         __u8    num_fats;
 105         __u8    drv_sel;
 106         __u8    percent_in_use;
 107         __u8    reserved[7];
 108         __u8    boot_code[390];
 109         __le16  signature;
 110 } __packed;
 111
 112 struct exfat_dentry {
 113         __u8 type;
 114         union {
 115                 struct {
 116                         __u8 num_ext;
 117                         __le16 checksum;
 118                         __le16 attr;
 119                         __le16 reserved1;
 120                         __le16 create_time;
 121                         __le16 create_date;
 122                         __le16 modify_time;
 123                         __le16 modify_date;
 124                         __le16 access_time;
 125                         __le16 access_date;
 126                         __u8 create_time_cs;
 127                         __u8 modify_time_cs;
 128                         __u8 create_tz;
 129                         __u8 modify_tz;
 130                         __u8 access_tz;
 131                         __u8 reserved2[7];
 132                 } __packed file; /* file directory entry */
 133                 struct {
 134                         __u8 flags;
 135                         __u8 reserved1;
 136                         __u8 name_len;
 137                         __le16 name_hash;
 138                         __le16 reserved2;
 139                         __le64 valid_size;
 140                         __le32 reserved3;
 141                         __le32 start_clu;
 142                         __le64 size;
 143                 } __packed stream; /* stream extension directory entry */
 144                 struct {
 145                         __u8 flags;
 146                         __le16 unicode_0_14[EXFAT_FILE_NAME_LEN];
 147                 } __packed name; /* file name directory entry */
 148                 struct {
 149                         __u8 flags;
 150                         __u8 reserved[18];
 151                         __le32 start_clu;
 152                         __le64 size;
 153                 } __packed bitmap; /* allocation bitmap directory entry */
 154                 struct {
 155                         __u8 reserved1[3];
 156                         __le32 checksum;
 157                         __u8 reserved2[12];
 158                         __le32 start_clu;
 159                         __le64 size;
 160                 } __packed upcase; /* up-case table directory entry */
 161                 struct {
 162                         __u8 flags;
 163                         __u8 vendor_guid[16];
 164                         __u8 vendor_defined[14];
 165                 } __packed vendor_ext; /* vendor extension directory entry */
 166                 struct {
 167                         __u8 flags;
 168                         __u8 vendor_guid[16];
 169                         __u8 vendor_defined[2];
 170                         __le32 start_clu;
 171                         __le64 size;
 172                 } __packed vendor_alloc; /* vendor allocation directory entry */
 173                 struct {
 174                         __u8 flags;
 175                         __u8 custom_defined[18];
 176                         __le32 start_clu;
 177                         __le64 size;
 178                 } __packed generic_secondary; /* generic secondary directory entry */
 179         } __packed dentry;
 180 } __packed;
 181
 182 #define EXFAT_TZ_VALID          (1 << 7)
 183
 184 /* Jan 1 GMT 00:00:00 1980 */
 185 #define EXFAT_MIN_TIMESTAMP_SECS    315532800LL
 186 /* Dec 31 GMT 23:59:59 2107 */
 187 #define EXFAT_MAX_TIMESTAMP_SECS    4354819199LL
 188
 189 #endif /* !_EXFAT_RAW_H */