f7ed786866ef0b4273b46db3161e73274da7e1d2
[dragonfly.git] / sys / sys / disklabel32.h
1 /*
2  * Copyright (c) 1987, 1988, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by the University of
16  *      California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *      @(#)disklabel.h 8.2 (Berkeley) 7/10/94
34  * $FreeBSD: src/sys/sys/disklabel.h,v 1.49.2.7 2001/05/27 05:58:26 jkh Exp $
35  * $DragonFly: src/sys/sys/disklabel32.h,v 1.25 2007/06/13 20:58:38 dillon Exp $
36  */
37
38 #ifndef _SYS_DISKLABEL_H_
39 #define _SYS_DISKLABEL_H_
40
41 #ifndef _SYS_TYPES_H_
42 #include <sys/types.h>
43 #endif
44 #if defined(_KERNEL) && !defined(_SYS_SYSTM_H_)
45 #include <sys/systm.h>
46 #endif
47 #ifndef _SYS_IOCCOM_H_
48 #include <sys/ioccom.h>
49 #endif
50
51 /*
52  * Each disk has a label which includes information about the hardware
53  * disk geometry, filesystem partitions, and drive specific information.
54  * The label is in block 0 or 1, possibly offset from the beginning
55  * to leave room for a bootstrap, etc.
56  */
57
58 /* XXX these should be defined per controller (or drive) elsewhere, not here! */
59 #ifdef __i386__
60 #define LABELSECTOR     1                       /* sector containing label */
61 #define LABELOFFSET     0                       /* offset of label in sector */
62 #endif
63
64 #define DISKMAGIC       ((u_int32_t)0x82564557) /* The disk magic number */
65 #ifndef MAXPARTITIONS
66 #define MAXPARTITIONS   16
67 #endif
68
69 #define LABEL_PART      2               /* partition containing label */
70 #define RAW_PART        2               /* partition containing whole disk */
71 #define SWAP_PART       1               /* partition normally containing swap */
72
73 #ifndef LOCORE
74 struct disklabel {
75         u_int32_t d_magic;              /* the magic number */
76         u_int16_t d_type;               /* drive type */
77         u_int16_t d_subtype;            /* controller/d_type specific */
78         char      d_typename[16];       /* type name, e.g. "eagle" */
79
80         char    d_packname[16];         /* pack identifier */
81
82         /* disk geometry: */
83         u_int32_t d_secsize;            /* # of bytes per sector */
84         u_int32_t d_nsectors;           /* # of data sectors per track */
85         u_int32_t d_ntracks;            /* # of tracks per cylinder */
86         u_int32_t d_ncylinders;         /* # of data cylinders per unit */
87         u_int32_t d_secpercyl;          /* # of data sectors per cylinder */
88         u_int32_t d_secperunit;         /* # of data sectors per unit */
89
90         /*
91          * Spares (bad sector replacements) below are not counted in
92          * d_nsectors or d_secpercyl.  Spare sectors are assumed to
93          * be physical sectors which occupy space at the end of each
94          * track and/or cylinder.
95          */
96         u_int16_t d_sparespertrack;     /* # of spare sectors per track */
97         u_int16_t d_sparespercyl;       /* # of spare sectors per cylinder */
98         /*
99          * Alternate cylinders include maintenance, replacement, configuration
100          * description areas, etc.
101          */
102         u_int32_t d_acylinders;         /* # of alt. cylinders per unit */
103
104                         /* hardware characteristics: */
105         /*
106          * d_interleave, d_trackskew and d_cylskew describe perturbations
107          * in the media format used to compensate for a slow controller.
108          * Interleave is physical sector interleave, set up by the
109          * formatter or controller when formatting.  When interleaving is
110          * in use, logically adjacent sectors are not physically
111          * contiguous, but instead are separated by some number of
112          * sectors.  It is specified as the ratio of physical sectors
113          * traversed per logical sector.  Thus an interleave of 1:1
114          * implies contiguous layout, while 2:1 implies that logical
115          * sector 0 is separated by one sector from logical sector 1.
116          * d_trackskew is the offset of sector 0 on track N relative to
117          * sector 0 on track N-1 on the same cylinder.  Finally, d_cylskew
118          * is the offset of sector 0 on cylinder N relative to sector 0
119          * on cylinder N-1.
120          */
121         u_int16_t d_rpm;                /* rotational speed */
122         u_int16_t d_interleave;         /* hardware sector interleave */
123         u_int16_t d_trackskew;          /* sector 0 skew, per track */
124         u_int16_t d_cylskew;            /* sector 0 skew, per cylinder */
125         u_int32_t d_headswitch;         /* head switch time, usec */
126         u_int32_t d_trkseek;            /* track-to-track seek, usec */
127         u_int32_t d_flags;              /* generic flags (now unused) */
128 #define NDDATA 5
129         u_int32_t d_drivedata[NDDATA];  /* drive-type specific information */
130 #define NSPARE 5
131         u_int32_t d_spare[NSPARE];      /* reserved for future use */
132         u_int32_t d_magic2;             /* the magic number (again) */
133         u_int16_t d_checksum;           /* xor of data incl. partitions */
134
135                         /* filesystem and partition information: */
136         u_int16_t d_npartitions;        /* number of partitions in following */
137         u_int32_t d_bbsize;             /* size of boot area at sn0, bytes */
138         u_int32_t d_sbsize;             /* max size of fs superblock, bytes */
139         struct  partition {             /* the partition table */
140                 u_int32_t p_size;       /* number of sectors in partition */
141                 u_int32_t p_offset;     /* starting sector */
142                 u_int32_t p_fsize;      /* filesystem basic fragment size */
143                 u_int8_t p_fstype;      /* filesystem type, see below */
144                 u_int8_t p_frag;        /* filesystem fragments per block */
145                 union {
146                         u_int16_t cpg;  /* UFS: FS cylinders per group */
147                         u_int16_t sgs;  /* LFS: FS segment shift */
148                 } __partition_u1;
149 #define p_cpg   __partition_u1.cpg
150 #define p_sgs   __partition_u1.sgs
151         } d_partitions[MAXPARTITIONS];  /* actually may be more */
152 };
153
154 static u_int16_t dkcksum(struct disklabel *lp);
155
156 static __inline u_int16_t
157 dkcksum(struct disklabel *lp)
158 {
159         u_int16_t *start, *end;
160         u_int16_t sum = 0;
161
162         start = (u_int16_t *)lp;
163         end = (u_int16_t *)&lp->d_partitions[lp->d_npartitions];
164         while (start < end)
165                 sum ^= *start++;
166         return (sum);
167 }
168
169 #else /* LOCORE */
170         /*
171          * offsets for asm boot files.
172          */
173         .set    d_secsize,40
174         .set    d_nsectors,44
175         .set    d_ntracks,48
176         .set    d_ncylinders,52
177         .set    d_secpercyl,56
178         .set    d_secperunit,60
179         .set    d_end_,276              /* size of disk label */
180 #endif /* LOCORE */
181
182 /* d_type values: */
183 #define DTYPE_SMD               1               /* SMD, XSMD; VAX hp/up */
184 #define DTYPE_MSCP              2               /* MSCP */
185 #define DTYPE_DEC               3               /* other DEC (rk, rl) */
186 #define DTYPE_SCSI              4               /* SCSI */
187 #define DTYPE_ESDI              5               /* ESDI interface */
188 #define DTYPE_ST506             6               /* ST506 etc. */
189 #define DTYPE_HPIB              7               /* CS/80 on HP-IB */
190 #define DTYPE_HPFL              8               /* HP Fiber-link */
191 #define DTYPE_FLOPPY            10              /* floppy */
192 #define DTYPE_CCD               11              /* concatenated disk */
193 #define DTYPE_VINUM             12              /* vinum volume */
194 #define DTYPE_DOC2K             13              /* Msys DiskOnChip */
195
196 #ifdef DKTYPENAMES
197 static const char *dktypenames[] = {
198         "unknown",
199         "SMD",
200         "MSCP",
201         "old DEC",
202         "SCSI",
203         "ESDI",
204         "ST506",
205         "HP-IB",
206         "HP-FL",
207         "type 9",
208         "floppy",
209         "CCD",
210         "Vinum",
211         "DOC2K",
212         NULL
213 };
214 #define DKMAXTYPES      (sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
215 #endif
216
217 /*
218  * Filesystem type and version.
219  * Used to interpret other filesystem-specific
220  * per-partition information.
221  */
222 #define FS_UNUSED       0               /* unused */
223 #define FS_SWAP         1               /* swap */
224 #define FS_V6           2               /* Sixth Edition */
225 #define FS_V7           3               /* Seventh Edition */
226 #define FS_SYSV         4               /* System V */
227 #define FS_V71K         5               /* V7 with 1K blocks (4.1, 2.9) */
228 #define FS_V8           6               /* Eighth Edition, 4K blocks */
229 #define FS_BSDFFS       7               /* 4.2BSD fast file system */
230 #define FS_MSDOS        8               /* MSDOS file system */
231 #define FS_BSDLFS       9               /* 4.4BSD log-structured file system */
232 #define FS_OTHER        10              /* in use, but unknown/unsupported */
233 #define FS_HPFS         11              /* OS/2 high-performance file system */
234 #define FS_ISO9660      12              /* ISO 9660, normally CD-ROM */
235 #define FS_BOOT         13              /* partition contains bootstrap */
236 #define FS_VINUM        14              /* Vinum drive partition */
237 #define FS_RAID         15
238 #define FS_RESERVED16   16
239 #define FS_RESERVED17   17
240 #define FS_RESERVED18   18
241 #define FS_CCD          19              /* CCD drive partition */
242 #define FS_RESERVED20   20
243 #define FS_JFS2         21
244
245 #ifdef  DKTYPENAMES
246 static const char *fstypenames[] = {
247         "unused",
248         "swap",
249         "Version 6",
250         "Version 7",
251         "System V",
252         "4.1BSD",
253         "Eighth Edition",
254         "4.2BSD",
255         "MSDOS",
256         "4.4LFS",
257         "unknown",
258         "HPFS",
259         "ISO9660",
260         "boot",
261         "vinum",
262         "raid",
263         "?",
264         "?",
265         "?",
266         "ccd",
267         "?",    /* don't use in case freebsd reassigns jfs / bug in freebsd */
268         "jfs",
269         NULL
270 };
271 #define FSMAXTYPES      (sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
272 #endif
273
274 #ifndef LOCORE
275
276 /*
277  * Disk-specific ioctls.
278  */
279 #define DIOCGDINFO      _IOR('d', 101, struct disklabel)/* get */
280 #define DIOCSDINFO      _IOW('d', 102, struct disklabel)/* set */
281 #define DIOCWDINFO      _IOW('d', 103, struct disklabel)/* set, update disk */
282 #define DIOCGDVIRGIN    _IOR('d', 105, struct disklabel) /* get virgin label */
283
284 #ifdef _KERNEL
285
286 char    *readdisklabel (cdev_t dev, struct disklabel *lp);
287 int     setdisklabel (struct disklabel *olp, struct disklabel *nlp,
288                           u_int32_t *openmask);
289 int     writedisklabel (cdev_t dev, struct disklabel *lp);
290
291 #endif /* _KERNEL */
292
293 #endif /* LOCORE */
294
295 #endif /* !_SYS_DISKLABEL_H_ */