GNU Linux-libre 4.9.332-gnu1
[releases.git] / include / uapi / linux / msdos_fs.h
1 #ifndef _UAPI_LINUX_MSDOS_FS_H
2 #define _UAPI_LINUX_MSDOS_FS_H
3
4 #include <linux/types.h>
5 #include <linux/magic.h>
6 #include <asm/byteorder.h>
7
8 /*
9  * The MS-DOS filesystem constants/structures
10  */
11
12 #ifndef SECTOR_SIZE
13 #define SECTOR_SIZE     512             /* sector size (bytes) */
14 #endif
15 #define SECTOR_BITS     9               /* log2(SECTOR_SIZE) */
16 #define MSDOS_DPB       (MSDOS_DPS)     /* dir entries per block */
17 #define MSDOS_DPB_BITS  4               /* log2(MSDOS_DPB) */
18 #define MSDOS_DPS       (SECTOR_SIZE / sizeof(struct msdos_dir_entry))
19 #define MSDOS_DPS_BITS  4               /* log2(MSDOS_DPS) */
20 #define MSDOS_LONGNAME  256             /* maximum name length */
21 #define CF_LE_W(v)      le16_to_cpu(v)
22 #define CF_LE_L(v)      le32_to_cpu(v)
23 #define CT_LE_W(v)      cpu_to_le16(v)
24 #define CT_LE_L(v)      cpu_to_le32(v)
25
26 #define MSDOS_ROOT_INO   1      /* The root inode number */
27 #define MSDOS_FSINFO_INO 2      /* Used for managing the FSINFO block */
28
29 #define MSDOS_DIR_BITS  5       /* log2(sizeof(struct msdos_dir_entry)) */
30
31 /* directory limit */
32 #define FAT_MAX_DIR_ENTRIES     (65536)
33 #define FAT_MAX_DIR_SIZE        (FAT_MAX_DIR_ENTRIES << MSDOS_DIR_BITS)
34
35 #define ATTR_NONE       0       /* no attribute bits */
36 #define ATTR_RO         1       /* read-only */
37 #define ATTR_HIDDEN     2       /* hidden */
38 #define ATTR_SYS        4       /* system */
39 #define ATTR_VOLUME     8       /* volume label */
40 #define ATTR_DIR        16      /* directory */
41 #define ATTR_ARCH       32      /* archived */
42
43 /* attribute bits that are copied "as is" */
44 #define ATTR_UNUSED     (ATTR_VOLUME | ATTR_ARCH | ATTR_SYS | ATTR_HIDDEN)
45 /* bits that are used by the Windows 95/Windows NT extended FAT */
46 #define ATTR_EXT        (ATTR_RO | ATTR_HIDDEN | ATTR_SYS | ATTR_VOLUME)
47
48 #define CASE_LOWER_BASE 8       /* base is lower case */
49 #define CASE_LOWER_EXT  16      /* extension is lower case */
50
51 #define DELETED_FLAG    0xe5    /* marks file as deleted when in name[0] */
52 #define IS_FREE(n)      (!*(n) || *(n) == DELETED_FLAG)
53
54 #define FAT_LFN_LEN     255     /* maximum long name length */
55 #define MSDOS_NAME      11      /* maximum name length */
56 #define MSDOS_SLOTS     21      /* max # of slots for short and long names */
57 #define MSDOS_DOT       ".          "   /* ".", padded to MSDOS_NAME chars */
58 #define MSDOS_DOTDOT    "..         "   /* "..", padded to MSDOS_NAME chars */
59
60 #define FAT_FIRST_ENT(s, x)     ((MSDOS_SB(s)->fat_bits == 32 ? 0x0FFFFF00 : \
61         MSDOS_SB(s)->fat_bits == 16 ? 0xFF00 : 0xF00) | (x))
62
63 /* start of data cluster's entry (number of reserved clusters) */
64 #define FAT_START_ENT   2
65
66 /* maximum number of clusters */
67 #define MAX_FAT12       0xFF4
68 #define MAX_FAT16       0xFFF4
69 #define MAX_FAT32       0x0FFFFFF6
70 #define MAX_FAT(s)      (MSDOS_SB(s)->fat_bits == 32 ? MAX_FAT32 : \
71         MSDOS_SB(s)->fat_bits == 16 ? MAX_FAT16 : MAX_FAT12)
72
73 /* bad cluster mark */
74 #define BAD_FAT12       0xFF7
75 #define BAD_FAT16       0xFFF7
76 #define BAD_FAT32       0x0FFFFFF7
77
78 /* standard EOF */
79 #define EOF_FAT12       0xFFF
80 #define EOF_FAT16       0xFFFF
81 #define EOF_FAT32       0x0FFFFFFF
82
83 #define FAT_ENT_FREE    (0)
84 #define FAT_ENT_BAD     (BAD_FAT32)
85 #define FAT_ENT_EOF     (EOF_FAT32)
86
87 #define FAT_FSINFO_SIG1 0x41615252
88 #define FAT_FSINFO_SIG2 0x61417272
89 #define IS_FSINFO(x)    (le32_to_cpu((x)->signature1) == FAT_FSINFO_SIG1 \
90                          && le32_to_cpu((x)->signature2) == FAT_FSINFO_SIG2)
91
92 #define FAT_STATE_DIRTY 0x01
93
94 struct __fat_dirent {
95         long            d_ino;
96         __kernel_off_t  d_off;
97         unsigned short  d_reclen;
98         char            d_name[256]; /* We must not include limits.h! */
99 };
100
101 /*
102  * ioctl commands
103  */
104 #define VFAT_IOCTL_READDIR_BOTH         _IOR('r', 1, struct __fat_dirent[2])
105 #define VFAT_IOCTL_READDIR_SHORT        _IOR('r', 2, struct __fat_dirent[2])
106 /* <linux/videotext.h> has used 0x72 ('r') in collision, so skip a few */
107 #define FAT_IOCTL_GET_ATTRIBUTES        _IOR('r', 0x10, __u32)
108 #define FAT_IOCTL_SET_ATTRIBUTES        _IOW('r', 0x11, __u32)
109 /*Android kernel has used 0x12, so we use 0x13*/
110 #define FAT_IOCTL_GET_VOLUME_ID         _IOR('r', 0x13, __u32)
111
112 struct fat_boot_sector {
113         __u8    ignored[3];     /* Boot strap short or near jump */
114         __u8    system_id[8];   /* Name - can be used to special case
115                                    partition manager volumes */
116         __u8    sector_size[2]; /* bytes per logical sector */
117         __u8    sec_per_clus;   /* sectors/cluster */
118         __le16  reserved;       /* reserved sectors */
119         __u8    fats;           /* number of FATs */
120         __u8    dir_entries[2]; /* root directory entries */
121         __u8    sectors[2];     /* number of sectors */
122         __u8    media;          /* media code */
123         __le16  fat_length;     /* sectors/FAT */
124         __le16  secs_track;     /* sectors per track */
125         __le16  heads;          /* number of heads */
126         __le32  hidden;         /* hidden sectors (unused) */
127         __le32  total_sect;     /* number of sectors (if sectors == 0) */
128
129         union {
130                 struct {
131                         /*  Extended BPB Fields for FAT16 */
132                         __u8    drive_number;   /* Physical drive number */
133                         __u8    state;          /* undocumented, but used
134                                                    for mount state. */
135                         __u8    signature;  /* extended boot signature */
136                         __u8    vol_id[4];      /* volume ID */
137                         __u8    vol_label[11];  /* volume label */
138                         __u8    fs_type[8];             /* file system type */
139                         /* other fields are not added here */
140                 } fat16;
141
142                 struct {
143                         /* only used by FAT32 */
144                         __le32  length;         /* sectors/FAT */
145                         __le16  flags;          /* bit 8: fat mirroring,
146                                                    low 4: active fat */
147                         __u8    version[2];     /* major, minor filesystem
148                                                    version */
149                         __le32  root_cluster;   /* first cluster in
150                                                    root directory */
151                         __le16  info_sector;    /* filesystem info sector */
152                         __le16  backup_boot;    /* backup boot sector */
153                         __le16  reserved2[6];   /* Unused */
154                         /* Extended BPB Fields for FAT32 */
155                         __u8    drive_number;   /* Physical drive number */
156                         __u8    state;          /* undocumented, but used
157                                                    for mount state. */
158                         __u8    signature;  /* extended boot signature */
159                         __u8    vol_id[4];      /* volume ID */
160                         __u8    vol_label[11];  /* volume label */
161                         __u8    fs_type[8];             /* file system type */
162                         /* other fields are not added here */
163                 } fat32;
164         };
165 };
166
167 struct fat_boot_fsinfo {
168         __le32   signature1;    /* 0x41615252L */
169         __le32   reserved1[120];        /* Nothing as far as I can tell */
170         __le32   signature2;    /* 0x61417272L */
171         __le32   free_clusters; /* Free cluster count.  -1 if unknown */
172         __le32   next_cluster;  /* Most recently allocated cluster */
173         __le32   reserved2[4];
174 };
175
176 struct msdos_dir_entry {
177         __u8    name[MSDOS_NAME];/* name and extension */
178         __u8    attr;           /* attribute bits */
179         __u8    lcase;          /* Case for base and extension */
180         __u8    ctime_cs;       /* Creation time, centiseconds (0-199) */
181         __le16  ctime;          /* Creation time */
182         __le16  cdate;          /* Creation date */
183         __le16  adate;          /* Last access date */
184         __le16  starthi;        /* High 16 bits of cluster in FAT32 */
185         __le16  time,date,start;/* time, date and first cluster */
186         __le32  size;           /* file size (in bytes) */
187 };
188
189 /* Up to 13 characters of the name */
190 struct msdos_dir_slot {
191         __u8    id;             /* sequence number for slot */
192         __u8    name0_4[10];    /* first 5 characters in name */
193         __u8    attr;           /* attribute byte */
194         __u8    reserved;       /* always 0 */
195         __u8    alias_checksum; /* checksum for 8.3 alias */
196         __u8    name5_10[12];   /* 6 more characters in name */
197         __le16   start;         /* starting cluster number, 0 in long slots */
198         __u8    name11_12[4];   /* last 2 characters in name */
199 };
200
201 #endif /* _UAPI_LINUX_MSDOS_FS_H */