diskmbr.h revision 15571
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 * $Id: disklabel.h,v 1.20 1996/03/11 02:06:30 hsu Exp $
35 */
36
37#ifndef _SYS_DISKLABEL_H_
38#define	_SYS_DISKLABEL_H_
39
40/*
41 * Disk description table, see disktab(5)
42 */
43#define	_PATH_DISKTAB	"/etc/disktab"
44#define	DISKTAB		"/etc/disktab"		/* deprecated */
45
46/*
47 * Each disk has a label which includes information about the hardware
48 * disk geometry, filesystem partitions, and drive specific information.
49 * The label is in block 0 or 1, possibly offset from the beginning
50 * to leave room for a bootstrap, etc.
51 */
52
53/* XXX these should be defined per controller (or drive) elsewhere, not here! */
54#ifdef __i386__
55#define LABELSECTOR	1			/* sector containing label */
56#define LABELOFFSET	0			/* offset of label in sector */
57#endif
58
59#ifndef	LABELSECTOR
60#define LABELSECTOR	0			/* sector containing label */
61#endif
62
63#ifndef	LABELOFFSET
64#define LABELOFFSET	64			/* offset of label in sector */
65#endif
66
67#define DISKMAGIC	((u_int32_t)0x82564557)	/* The disk magic number */
68#ifndef MAXPARTITIONS
69#define	MAXPARTITIONS	8
70#endif
71
72#define	LABEL_PART	2		/* partition containing label */
73#define	RAW_PART	2		/* partition containing whole disk */
74#define	SWAP_PART	1		/* partition normally containing swap */
75
76#ifndef LOCORE
77struct disklabel {
78	u_int32_t d_magic;		/* the magic number */
79	u_int16_t d_type;		/* drive type */
80	u_int16_t d_subtype;		/* controller/d_type specific */
81	char	  d_typename[16];	/* type name, e.g. "eagle" */
82
83	/*
84	 * d_packname contains the pack identifier and is returned when
85	 * the disklabel is read off the disk or in-core copy.
86	 * d_boot0 and d_boot1 are the (optional) names of the
87	 * primary (block 0) and secondary (block 1-15) bootstraps
88	 * as found in /usr/mdec.  These are returned when using
89	 * getdiskbyname(3) to retrieve the values from /etc/disktab.
90	 */
91#if defined(KERNEL) || defined(STANDALONE)
92	char	  d_packname[16];		/* pack identifier */
93#else
94	union {
95		char	un_d_packname[16];	/* pack identifier */
96		struct {
97			char *un_d_boot0;	/* primary bootstrap name */
98			char *un_d_boot1;	/* secondary bootstrap name */
99		} un_b;
100	} d_un;
101#define d_packname	d_un.un_d_packname
102#define d_boot0		d_un.un_b.un_d_boot0
103#define d_boot1		d_un.un_b.un_d_boot1
104#endif	/* ! KERNEL or STANDALONE */
105
106			/* disk geometry: */
107	u_int32_t d_secsize;		/* # of bytes per sector */
108	u_int32_t d_nsectors;		/* # of data sectors per track */
109	u_int32_t d_ntracks;		/* # of tracks per cylinder */
110	u_int32_t d_ncylinders;		/* # of data cylinders per unit */
111	u_int32_t d_secpercyl;		/* # of data sectors per cylinder */
112	u_int32_t d_secperunit;		/* # of data sectors per unit */
113
114	/*
115	 * Spares (bad sector replacements) below are not counted in
116	 * d_nsectors or d_secpercyl.  Spare sectors are assumed to
117	 * be physical sectors which occupy space at the end of each
118	 * track and/or cylinder.
119	 */
120	u_int16_t d_sparespertrack;	/* # of spare sectors per track */
121	u_int16_t d_sparespercyl;	/* # of spare sectors per cylinder */
122	/*
123	 * Alternate cylinders include maintenance, replacement, configuration
124	 * description areas, etc.
125	 */
126	u_int32_t d_acylinders;		/* # of alt. cylinders per unit */
127
128			/* hardware characteristics: */
129	/*
130	 * d_interleave, d_trackskew and d_cylskew describe perturbations
131	 * in the media format used to compensate for a slow controller.
132	 * Interleave is physical sector interleave, set up by the
133	 * formatter or controller when formatting.  When interleaving is
134	 * in use, logically adjacent sectors are not physically
135	 * contiguous, but instead are separated by some number of
136	 * sectors.  It is specified as the ratio of physical sectors
137	 * traversed per logical sector.  Thus an interleave of 1:1
138	 * implies contiguous layout, while 2:1 implies that logical
139	 * sector 0 is separated by one sector from logical sector 1.
140	 * d_trackskew is the offset of sector 0 on track N relative to
141	 * sector 0 on track N-1 on the same cylinder.  Finally, d_cylskew
142	 * is the offset of sector 0 on cylinder N relative to sector 0
143	 * on cylinder N-1.
144	 */
145	u_int16_t d_rpm;		/* rotational speed */
146	u_int16_t d_interleave;		/* hardware sector interleave */
147	u_int16_t d_trackskew;		/* sector 0 skew, per track */
148	u_int16_t d_cylskew;		/* sector 0 skew, per cylinder */
149	u_int32_t d_headswitch;		/* head switch time, usec */
150	u_int32_t d_trkseek;		/* track-to-track seek, usec */
151	u_int32_t d_flags;		/* generic flags */
152#define NDDATA 5
153	u_int32_t d_drivedata[NDDATA];	/* drive-type specific information */
154#define NSPARE 5
155	u_int32_t d_spare[NSPARE];	/* reserved for future use */
156	u_int32_t d_magic2;		/* the magic number (again) */
157	u_int16_t d_checksum;		/* xor of data incl. partitions */
158
159			/* filesystem and partition information: */
160	u_int16_t d_npartitions;	/* number of partitions in following */
161	u_int32_t d_bbsize;		/* size of boot area at sn0, bytes */
162	u_int32_t d_sbsize;		/* max size of fs superblock, bytes */
163	struct	partition {		/* the partition table */
164		u_int32_t p_size;	/* number of sectors in partition */
165		u_int32_t p_offset;	/* starting sector */
166		u_int32_t p_fsize;	/* filesystem basic fragment size */
167		u_int8_t p_fstype;	/* filesystem type, see below */
168		u_int8_t p_frag;	/* filesystem fragments per block */
169		union {
170			u_int16_t cpg;	/* UFS: FS cylinders per group */
171			u_int16_t sgs;	/* LFS: FS segment shift */
172		} __partition_u1;
173#define	p_cpg	__partition_u1.cpg
174#define	p_sgs	__partition_u1.sgs
175	} d_partitions[MAXPARTITIONS];	/* actually may be more */
176};
177#else /* LOCORE */
178	/*
179	 * offsets for asm boot files.
180	 */
181	.set	d_secsize,40
182	.set	d_nsectors,44
183	.set	d_ntracks,48
184	.set	d_ncylinders,52
185	.set	d_secpercyl,56
186	.set	d_secperunit,60
187	.set	d_end_,276		/* size of disk label */
188#endif /* LOCORE */
189
190/* d_type values: */
191#define	DTYPE_SMD		1		/* SMD, XSMD; VAX hp/up */
192#define	DTYPE_MSCP		2		/* MSCP */
193#define	DTYPE_DEC		3		/* other DEC (rk, rl) */
194#define	DTYPE_SCSI		4		/* SCSI */
195#define	DTYPE_ESDI		5		/* ESDI interface */
196#define	DTYPE_ST506		6		/* ST506 etc. */
197#define	DTYPE_HPIB		7		/* CS/80 on HP-IB */
198#define	DTYPE_HPFL		8		/* HP Fiber-link */
199#define	DTYPE_FLOPPY		10		/* floppy */
200#define	DTYPE_CCD		11		/* concatenated disk */
201
202#ifdef DKTYPENAMES
203static char *dktypenames[] = {
204	"unknown",
205	"SMD",
206	"MSCP",
207	"old DEC",
208	"SCSI",
209	"ESDI",
210	"ST506",
211	"HP-IB",
212	"HP-FL",
213	"type 9",
214	"floppy",
215	"CCD",
216	NULL
217};
218#define DKMAXTYPES	(sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
219#endif
220
221/*
222 * Filesystem type and version.
223 * Used to interpret other filesystem-specific
224 * per-partition information.
225 */
226#define	FS_UNUSED	0		/* unused */
227#define	FS_SWAP		1		/* swap */
228#define	FS_V6		2		/* Sixth Edition */
229#define	FS_V7		3		/* Seventh Edition */
230#define	FS_SYSV		4		/* System V */
231#define	FS_V71K		5		/* V7 with 1K blocks (4.1, 2.9) */
232#define	FS_V8		6		/* Eighth Edition, 4K blocks */
233#define	FS_BSDFFS	7		/* 4.2BSD fast file system */
234#define	FS_MSDOS	8		/* MSDOS file system */
235#define	FS_BSDLFS	9		/* 4.4BSD log-structured file system */
236#define	FS_OTHER	10		/* in use, but unknown/unsupported */
237#define	FS_HPFS		11		/* OS/2 high-performance file system */
238#define	FS_ISO9660	12		/* ISO 9660, normally CD-ROM */
239#define	FS_BOOT		13		/* partition contains bootstrap */
240
241#ifdef	DKTYPENAMES
242static char *fstypenames[] = {
243	"unused",
244	"swap",
245	"Version 6",
246	"Version 7",
247	"System V",
248	"4.1BSD",
249	"Eighth Edition",
250	"4.2BSD",
251	"MSDOS",
252	"4.4LFS",
253	"unknown",
254	"HPFS",
255	"ISO9660",
256	"boot",
257	NULL
258};
259#define FSMAXTYPES	(sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
260#endif
261
262/*
263 * flags shared by various drives:
264 */
265#define		D_REMOVABLE	0x01		/* removable media */
266#define		D_ECC		0x02		/* supports ECC */
267#define		D_BADSECT	0x04		/* supports bad sector forw. */
268#define		D_RAMDISK	0x08		/* disk emulator */
269#define		D_CHAIN		0x10		/* can do back-back transfers */
270
271/*
272 * Drive data for SMD.
273 */
274#define	d_smdflags	d_drivedata[0]
275#define		D_SSE		0x1		/* supports skip sectoring */
276#define	d_mindist	d_drivedata[1]
277#define	d_maxdist	d_drivedata[2]
278#define	d_sdist		d_drivedata[3]
279
280/*
281 * Drive data for ST506.
282 */
283#define d_precompcyl	d_drivedata[0]
284#define d_gap3		d_drivedata[1]		/* used only when formatting */
285
286/*
287 * Drive data for SCSI.
288 */
289#define	d_blind		d_drivedata[0]
290
291#ifndef LOCORE
292/*
293 * Structure used to perform a format or other raw operation, returning
294 * data and/or register values.  Register identification and format
295 * are device- and driver-dependent.
296 */
297struct format_op {
298	char	*df_buf;
299	int	df_count;		/* value-result */
300	daddr_t	df_startblk;
301	int	df_reg[8];		/* result */
302};
303
304/*
305 * Structure used internally to retrieve information about a partition
306 * on a disk.
307 */
308struct partinfo {
309	struct disklabel *disklab;
310	struct partition *part;
311};
312
313/* DOS partition table -- located in boot block */
314
315#define DOSBBSECTOR	0	/* DOS boot block relative sector number */
316#define DOSPARTOFF	446
317#define NDOSPART	4
318#define	DOSPTYP_386BSD	0xa5	/* 386BSD partition type */
319
320struct dos_partition {
321	unsigned char	dp_flag;	/* bootstrap flags */
322	unsigned char	dp_shd;		/* starting head */
323	unsigned char	dp_ssect;	/* starting sector */
324	unsigned char	dp_scyl;	/* starting cylinder */
325	unsigned char	dp_typ;		/* partition type */
326	unsigned char	dp_ehd;		/* end head */
327	unsigned char	dp_esect;	/* end sector */
328	unsigned char	dp_ecyl;	/* end cylinder */
329	unsigned long	dp_start;	/* absolute starting sector number */
330	unsigned long	dp_size;	/* partition size in sectors */
331};
332
333#define DPSECT(s) ((s) & 0x3f)		/* isolate relevant bits of sector */
334#define DPCYL(c, s) ((c) + (((s) & 0xc0)<<2)) /* and those that are cylinder */
335
336/*
337 * Disk-specific ioctls.
338 */
339		/* get and set disklabel; DIOCGPART used internally */
340#define DIOCGDINFO	_IOR('d', 101, struct disklabel)/* get */
341#define DIOCSDINFO	_IOW('d', 102, struct disklabel)/* set */
342#define DIOCWDINFO	_IOW('d', 103, struct disklabel)/* set, update disk */
343#define DIOCGPART	_IOW('d', 104, struct partinfo)	/* get partition */
344
345/* do format operation, read or write */
346#define DIOCRFORMAT	_IOWR('d', 105, struct format_op)
347#define DIOCWFORMAT	_IOWR('d', 106, struct format_op)
348
349#define DIOCSSTEP	_IOW('d', 107, int)	/* set step rate */
350#define DIOCSRETRIES	_IOW('d', 108, int)	/* set # of retries */
351#define DIOCWLABEL	_IOW('d', 109, int)	/* write en/disable label */
352
353#define DIOCSBAD	_IOW('d', 110, struct dkbad)	/* set kernel dkbad */
354#define DIOCSBADSCAN	_IOW('d', 111, int)	/* set badscan mode */
355
356/*
357 * XXX encoding of disk minor numbers, should be elsewhere.
358 *
359 * See <sys/reboot.h> for a possibly better encoding.
360 *
361 * "cpio -H newc" can be used to back up device files with large minor
362 * numbers (but not ones >= 2^31).  Old cpio formats and all tar formats
363 * don't have enough bits, and cpio and tar don't notice the lossage.
364 * There are also some sign extension bugs.
365 */
366
367/*
368       3                   2                   1                   0
369     1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
370    _________________________________________________________________
371    | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
372    -----------------------------------------------------------------
373    |      TYPE           | SLICE   |  MAJOR?       |  UNIT   |PART |
374    -----------------------------------------------------------------
375    |      TYPE     |PART2| SLICE   |  MAJOR?       |  UNIT   |PART | <-soon
376    -----------------------------------------------------------------
377
378	I want 3 more part bits (taken from 'TYPE' (useless as it is) (JRE)
379*/
380#define	dkmakeminor(unit, slice, part) \
381				(((slice) << 16) | ((unit) << 3) | (part))
382#define	dkmodpart(dev, part)	(((dev) & ~(dev_t)7) | (part))
383#define	dkmodslice(dev, slice)	(((dev) & ~(dev_t)0x1f0000) | ((slice) << 16))
384#define	dkpart(dev)		(minor(dev) & 7)
385#define	dkslice(dev)		((minor(dev) >> 16) & 0x1f)
386#define	dktype(dev)       	((minor(dev) >> 21) & 0x7ff)
387#define	dkunit(dev)		((minor(dev) >> 3) & 0x1f)
388
389#ifdef KERNEL
390/*
391 * We're not ready to use <sys/disk.h>.
392 */
393#include <sys/conf.h>
394
395struct	buf_queue_head;
396
397int	bounds_check_with_label __P((struct buf *bp, struct disklabel *lp,
398				     int wlabel));
399void	diskerr __P((struct buf *bp, char *dname, char *what, int pri,
400		     int blkdone, struct disklabel *lp));
401void	disksort __P((struct buf *ap, struct buf *bp));
402u_int	dkcksum __P((struct disklabel *lp));
403char	*readdisklabel __P((dev_t dev, d_strategy_t *strat,
404			    struct disklabel *lp));
405void	tqdisksort __P((struct buf_queue_head *ap, struct buf *bp));
406int	setdisklabel __P((struct disklabel *olp, struct disklabel *nlp,
407			  u_long openmask));
408int	writedisklabel __P((dev_t dev, d_strategy_t *strat,
409			    struct disklabel *lp));
410
411#endif /* KERNEL */
412
413#endif /* LOCORE */
414
415#if !defined(KERNEL) && !defined(LOCORE)
416
417#include <sys/cdefs.h>
418
419__BEGIN_DECLS
420struct disklabel *getdiskbyname __P((const char *));
421__END_DECLS
422
423#endif
424
425#endif /* !_SYS_DISKLABEL_H_ */
426