Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sys / vfs / msdosfs / bpb.h
1 /* $FreeBSD: src/sys/msdosfs/bpb.h,v 1.7.2.1 2000/10/27 09:45:07 bde Exp $ */
2 /*      $NetBSD: bpb.h,v 1.7 1997/11/17 15:36:24 ws Exp $       */
3
4 /*
5  * Written by Paul Popelka (paulp@uts.amdahl.com)
6  *
7  * You can do anything you want with this software, just don't say you wrote
8  * it, and don't remove this notice.
9  *
10  * This software is provided "as is".
11  *
12  * The author supplies this software to be publicly redistributed on the
13  * understanding that the author is not responsible for the correct
14  * functioning of this software in any circumstances and is not liable for
15  * any damages caused by this software.
16  *
17  * October 1992
18  */
19
20 /*
21  * BIOS Parameter Block (BPB) for DOS 3.3
22  */
23 struct bpb33 {
24         u_int16_t       bpbBytesPerSec; /* bytes per sector */
25         u_int8_t        bpbSecPerClust; /* sectors per cluster */
26         u_int16_t       bpbResSectors;  /* number of reserved sectors */
27         u_int8_t        bpbFATs;        /* number of FATs */
28         u_int16_t       bpbRootDirEnts; /* number of root directory entries */
29         u_int16_t       bpbSectors;     /* total number of sectors */
30         u_int8_t        bpbMedia;       /* media descriptor */
31         u_int16_t       bpbFATsecs;     /* number of sectors per FAT */
32         u_int16_t       bpbSecPerTrack; /* sectors per track */
33         u_int16_t       bpbHeads;       /* number of heads */
34         u_int16_t       bpbHiddenSecs;  /* number of hidden sectors */
35 };
36
37 /*
38  * BPB for DOS 5.0 The difference is bpbHiddenSecs is a short for DOS 3.3,
39  * and bpbHugeSectors is not in the 3.3 bpb.
40  */
41 struct bpb50 {
42         u_int16_t       bpbBytesPerSec; /* bytes per sector */
43         u_int8_t        bpbSecPerClust; /* sectors per cluster */
44         u_int16_t       bpbResSectors;  /* number of reserved sectors */
45         u_int8_t        bpbFATs;        /* number of FATs */
46         u_int16_t       bpbRootDirEnts; /* number of root directory entries */
47         u_int16_t       bpbSectors;     /* total number of sectors */
48         u_int8_t        bpbMedia;       /* media descriptor */
49         u_int16_t       bpbFATsecs;     /* number of sectors per FAT */
50         u_int16_t       bpbSecPerTrack; /* sectors per track */
51         u_int16_t       bpbHeads;       /* number of heads */
52         u_int32_t       bpbHiddenSecs;  /* # of hidden sectors */
53         u_int32_t       bpbHugeSectors; /* # of sectors if bpbSectors == 0 */
54 };
55
56 /*
57  * BPB for DOS 7.10 (FAT32).  This one has a few extensions to bpb50.
58  */
59 struct bpb710 {
60         u_int16_t       bpbBytesPerSec; /* bytes per sector */
61         u_int8_t        bpbSecPerClust; /* sectors per cluster */
62         u_int16_t       bpbResSectors;  /* number of reserved sectors */
63         u_int8_t        bpbFATs;        /* number of FATs */
64         u_int16_t       bpbRootDirEnts; /* number of root directory entries */
65         u_int16_t       bpbSectors;     /* total number of sectors */
66         u_int8_t        bpbMedia;       /* media descriptor */
67         u_int16_t       bpbFATsecs;     /* number of sectors per FAT */
68         u_int16_t       bpbSecPerTrack; /* sectors per track */
69         u_int16_t       bpbHeads;       /* number of heads */
70         u_int32_t       bpbHiddenSecs;  /* # of hidden sectors */
71         u_int32_t       bpbHugeSectors; /* # of sectors if bpbSectors == 0 */
72         u_int32_t       bpbBigFATsecs;  /* like bpbFATsecs for FAT32 */
73         u_int16_t       bpbExtFlags;    /* extended flags: */
74 #define FATNUM          0xf             /* mask for numbering active FAT */
75 #define FATMIRROR       0x80            /* FAT is mirrored (like it always was) */
76         u_int16_t       bpbFSVers;      /* filesystem version */
77 #define FSVERS          0               /* currently only 0 is understood */
78         u_int32_t       bpbRootClust;   /* start cluster for root directory */
79         u_int16_t       bpbFSInfo;      /* filesystem info structure sector */
80         u_int16_t       bpbBackup;      /* backup boot sector */
81         /* There is a 12 byte filler here, but we ignore it */
82 };
83
84 #ifdef  atari
85 /*
86  * BPB for gemdos filesystems. Atari leaves the obsolete stuff undefined.
87  * Currently there is no need for a separate BPB structure.
88  */
89 #if 0
90 struct bpb_a {
91         u_int16_t       bpbBytesPerSec; /* bytes per sector             */
92         u_int8_t        bpbSecPerClust; /* sectors per cluster          */
93         u_int16_t       bpbResSectors;  /* number of reserved sectors   */
94         u_int8_t        bpbFATs;        /* number of FATs               */
95         u_int16_t       bpbRootDirEnts; /* number of root directory entries */
96         u_int16_t       bpbSectors;     /* total number of sectors      */
97         u_int8_t        bpbUseless1;    /* meaningless on gemdos fs     */
98         u_int16_t       bpbFATsecs;     /* number of sectors per FAT    */
99         u_int16_t       bpbUseless2;    /* meaningless for harddisk fs  */
100         u_int16_t       bpbUseless3;    /* meaningless for harddisk fs  */
101         u_int16_t       bpbHiddenSecs;  /* the TOS-BIOS ignores this    */
102 };
103 #endif
104 #endif  /* atari */
105
106 /*
107  * The following structures represent how the bpb's look on disk.  shorts
108  * and longs are just character arrays of the appropriate length.  This is
109  * because the compiler forces shorts and longs to align on word or
110  * halfword boundaries.
111  *
112  * XXX The little-endian code here assumes that the processor can access
113  * 16-bit and 32-bit quantities on byte boundaries.  If this is not true,
114  * use the macros for the big-endian case.
115  */
116
117 #include <machine/endian.h>
118
119 #ifdef __i386__
120 #define UNLALIGNED_ACCESS
121 #endif
122
123 #if (BYTE_ORDER == LITTLE_ENDIAN) && defined(UNALIGNED_ACCESS)
124 #define getushort(x)    *((u_int16_t *)(x))
125 #define getulong(x)     *((u_int32_t *)(x))
126 #define putushort(p, v) (*((u_int16_t *)(p)) = (v))
127 #define putulong(p, v)  (*((u_int32_t *)(p)) = (v))
128 #else
129 #define getushort(x)    (((u_int8_t *)(x))[0] + (((u_int8_t *)(x))[1] << 8))
130 #define getulong(x)     (((u_int8_t *)(x))[0] + (((u_int8_t *)(x))[1] << 8) \
131                          + (((u_int8_t *)(x))[2] << 16) \
132                          + (((u_int8_t *)(x))[3] << 24))
133 #define putushort(p, v) (((u_int8_t *)(p))[0] = (v),    \
134                          ((u_int8_t *)(p))[1] = (v) >> 8)
135 #define putulong(p, v)  (((u_int8_t *)(p))[0] = (v),    \
136                          ((u_int8_t *)(p))[1] = (v) >> 8, \
137                          ((u_int8_t *)(p))[2] = (v) >> 16,\
138                          ((u_int8_t *)(p))[3] = (v) >> 24)
139 #endif
140
141 /*
142  * BIOS Parameter Block (BPB) for DOS 3.3
143  */
144 struct byte_bpb33 {
145         int8_t bpbBytesPerSec[2];       /* bytes per sector */
146         int8_t bpbSecPerClust;          /* sectors per cluster */
147         int8_t bpbResSectors[2];        /* number of reserved sectors */
148         int8_t bpbFATs;                 /* number of FATs */
149         int8_t bpbRootDirEnts[2];       /* number of root directory entries */
150         int8_t bpbSectors[2];           /* total number of sectors */
151         int8_t bpbMedia;                /* media descriptor */
152         int8_t bpbFATsecs[2];           /* number of sectors per FAT */
153         int8_t bpbSecPerTrack[2];       /* sectors per track */
154         int8_t bpbHeads[2];             /* number of heads */
155         int8_t bpbHiddenSecs[2];        /* number of hidden sectors */
156 };
157
158 /*
159  * BPB for DOS 5.0 The difference is bpbHiddenSecs is a short for DOS 3.3,
160  * and bpbHugeSectors is not in the 3.3 bpb.
161  */
162 struct byte_bpb50 {
163         int8_t bpbBytesPerSec[2];       /* bytes per sector */
164         int8_t bpbSecPerClust;          /* sectors per cluster */
165         int8_t bpbResSectors[2];        /* number of reserved sectors */
166         int8_t bpbFATs;                 /* number of FATs */
167         int8_t bpbRootDirEnts[2];       /* number of root directory entries */
168         int8_t bpbSectors[2];           /* total number of sectors */
169         int8_t bpbMedia;                /* media descriptor */
170         int8_t bpbFATsecs[2];           /* number of sectors per FAT */
171         int8_t bpbSecPerTrack[2];       /* sectors per track */
172         int8_t bpbHeads[2];             /* number of heads */
173         int8_t bpbHiddenSecs[4];        /* number of hidden sectors */
174         int8_t bpbHugeSectors[4];       /* # of sectors if bpbSectors == 0 */
175 };
176
177 /*
178  * BPB for DOS 7.10 (FAT32).  This one has a few extensions to bpb50.
179  */
180 struct byte_bpb710 {
181         u_int8_t bpbBytesPerSec[2];     /* bytes per sector */
182         u_int8_t bpbSecPerClust;        /* sectors per cluster */
183         u_int8_t bpbResSectors[2];      /* number of reserved sectors */
184         u_int8_t bpbFATs;               /* number of FATs */
185         u_int8_t bpbRootDirEnts[2];     /* number of root directory entries */
186         u_int8_t bpbSectors[2];         /* total number of sectors */
187         u_int8_t bpbMedia;              /* media descriptor */
188         u_int8_t bpbFATsecs[2];         /* number of sectors per FAT */
189         u_int8_t bpbSecPerTrack[2];     /* sectors per track */
190         u_int8_t bpbHeads[2];           /* number of heads */
191         u_int8_t bpbHiddenSecs[4];      /* # of hidden sectors */
192         u_int8_t bpbHugeSectors[4];     /* # of sectors if bpbSectors == 0 */
193         u_int8_t bpbBigFATsecs[4];      /* like bpbFATsecs for FAT32 */
194         u_int8_t bpbExtFlags[2];        /* extended flags: */
195         u_int8_t bpbFSVers[2];          /* filesystem version */
196         u_int8_t bpbRootClust[4];       /* start cluster for root directory */
197         u_int8_t bpbFSInfo[2];          /* filesystem info structure sector */
198         u_int8_t bpbBackup[2];          /* backup boot sector */
199         /* There is a 12 byte filler here, but we ignore it */
200 };
201
202 /*
203  * FAT32 FSInfo block.
204  */
205 struct fsinfo {
206         u_int8_t fsisig1[4];
207         u_int8_t fsifill1[480];
208         u_int8_t fsisig2[4];
209         u_int8_t fsinfree[4];
210         u_int8_t fsinxtfree[4];
211         u_int8_t fsifill2[12];
212         u_int8_t fsisig3[4];
213         u_int8_t fsifill3[508];
214         u_int8_t fsisig4[4];
215 };