xref: /dragonfly/sys/sys/disk.h (revision c03f08f3)
1 /*
2  * Copyright (c) 2003,2004 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * ----------------------------------------------------------------------------
35  * "THE BEER-WARE LICENSE" (Revision 42):
36  * <phk@FreeBSD.ORG> wrote this file.  As long as you retain this notice you
37  * can do whatever you want with this stuff. If we meet some day, and you think
38  * this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
39  * ----------------------------------------------------------------------------
40  *
41  * $FreeBSD: src/sys/sys/disk.h,v 1.16.2.3 2001/06/20 16:11:01 scottl Exp $
42  * $DragonFly: src/sys/sys/disk.h,v 1.18 2007/07/30 08:02:40 dillon Exp $
43  */
44 
45 #ifndef _SYS_DISK_H_
46 #define	_SYS_DISK_H_
47 
48 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
49 #error "This file should not be included by userland programs."
50 #endif
51 
52 #ifndef _SYS_DISKSLICE_H_
53 #include <sys/diskslice.h>
54 #endif
55 #ifndef _SYS_QUEUE_H_
56 #include <sys/queue.h>
57 #endif
58 
59 /*
60  * Media information structure - filled in by the media driver.
61  */
62 struct disk_info {
63 	/*
64 	 * These fields are required.  Most drivers will load a disk_info
65 	 * structure in the device open function with the media parameters
66 	 * and call disk_setdiskinfo().
67 	 *
68 	 * Note that only one of d_media_size or d_media_blocks should be
69 	 * filled in.
70 	 *
71 	 * d_media_size		media size in bytes
72 	 * d_media_blocks	media size in blocks (e.g. total sectors)
73 	 * d_media_blksize	media block size / sector size
74 	 * d_dsflags		disklabel management flags
75 	 */
76 	u_int64_t		d_media_size;
77 	u_int64_t		d_media_blocks;
78 	int			d_media_blksize;
79 	u_int			d_dsflags;
80 
81 	/*
82 	 * Optional fields, leave 0 if not known
83 	 */
84 	u_int			d_type;		/* DTYPE_xxx */
85 	u_int			d_nheads;
86 	u_int			d_ncylinders;
87 	u_int			d_secpertrack;
88 	u_int			d_secpercyl;
89 };
90 
91 /*
92  * d_dsflags, also used for dsopen() - control disklabel processing
93  *
94  * COMPATPARTA	- used by scsi devices to allow CDs to boot from cd0a.
95  *		  cd's don't have disklabels and the default compat label
96  *		  does not implement an 'a' partition.
97  *
98  * COMPARTMBR	- used by the vn device to request that one sector be
99  *		  reserved as if an MBR were present even when one isn't.
100  */
101 #define DSO_NOLABELS		0x0001
102 #define DSO_ONESLICE		0x0002
103 #define DSO_COMPATLABEL		0x0004
104 #define DSO_COMPATPARTA		0x0008
105 #define DSO_COMPATMBR		0x0010
106 #define DSO_RAWEXTENSIONS	0x0020
107 
108 /*
109  * Disk management structure - automated disklabel support.
110  */
111 struct disk {
112 	struct dev_ops		*d_dev_ops;	/* our device switch */
113 	struct dev_ops		*d_raw_ops;	/* the raw device switch */
114 	u_int			d_flags;
115 	cdev_t			d_rawdev;	/* backing raw device */
116 	cdev_t			d_cdev;		/* special whole-disk part */
117 	struct diskslices	*d_slice;
118 	struct disk_info	d_info;		/* info structure for media */
119 	LIST_ENTRY(disk)	d_list;
120 };
121 
122 /*
123  * d_flags
124  */
125 #define DISKFLAG_LOCK		0x1
126 #define DISKFLAG_WANTED		0x2
127 
128 #ifdef _KERNEL
129 cdev_t disk_create (int unit, struct disk *disk, struct dev_ops *raw_ops);
130 cdev_t disk_locate (const char *devname);
131 void disk_destroy (struct disk *disk);
132 void disk_setdiskinfo (struct disk *disk, struct disk_info *info);
133 int disk_dumpcheck (cdev_t dev, u_int64_t *count, u_int64_t *blkno, u_int *secsize);
134 struct disk *disk_enumerate (struct disk *disk);
135 void disk_invalidate (struct disk *disk);
136 #endif /* _KERNEL */
137 
138 #endif /* _SYS_DISK_H_ */
139