xref: /dragonfly/sys/sys/disk.h (revision 650094e1)
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 #ifndef _SYS_MSGPORT_H_
59 #include <sys/msgport.h>
60 #endif
61 
62 /*
63  * Media information structure - filled in by the media driver.
64  *
65  * NOTE: d_serialno is copied on the call to setdiskinfo and need
66  *	 not be valid after that.
67  */
68 struct disk_info {
69 	/*
70 	 * These fields are required.  Most drivers will load a disk_info
71 	 * structure in the device open function with the media parameters
72 	 * and call disk_setdiskinfo().
73 	 *
74 	 * Note that only one of d_media_size or d_media_blocks should be
75 	 * filled in.
76 	 *
77 	 * d_media_size		media size in bytes
78 	 * d_media_blocks	media size in blocks (e.g. total sectors)
79 	 * d_media_blksize	media block size / sector size
80 	 * d_dsflags		disklabel management flags
81 	 */
82 	u_int64_t		d_media_size;
83 	u_int64_t		d_media_blocks;
84 	int			d_media_blksize;
85 	u_int			d_dsflags;
86 
87 	/*
88 	 * Optional fields, leave 0 if not known
89 	 */
90 	u_int			d_type;		/* DTYPE_xxx */
91 	u_int			d_nheads;
92 	u_int			d_ncylinders;
93 	u_int			d_secpertrack;
94 	u_int			d_secpercyl;
95 	u_int			d_trimflag;
96 	char			*d_serialno;
97 };
98 
99 /*
100  * d_dsflags, also used for dsopen() - control disklabel processing
101  *
102  * COMPATPARTA	- used by scsi devices to allow CDs to boot from cd0a.
103  *		  cd's don't have disklabels and the default compat label
104  *		  does not implement an 'a' partition.
105  *
106  * COMPATMBR	- used by the vn device to request that one sector be
107  *		  reserved as if an MBR were present even when one isn't.
108  *
109  * MBRQUIET	- silently ignore MBR probe if unable to read sector 0.
110  *		  used by VN.
111  *
112  * DEVICEMAPPER	- used by the device mapper (dm). Adds a '.' between the
113  *		  device name and the slice/part stuff (i.e. foo.s0).
114  */
115 #define DSO_NOLABELS		0x0001
116 #define DSO_ONESLICE		0x0002
117 #define DSO_COMPATLABEL		0x0004
118 #define DSO_COMPATPARTA		0x0008
119 #define DSO_COMPATMBR		0x0010
120 #define DSO_RAWEXTENSIONS	0x0020
121 #define DSO_MBRQUIET		0x0040
122 #define DSO_DEVICEMAPPER	0x0080
123 
124 /*
125  * Disk management structure - automated disklabel support.
126  */
127 struct disk {
128 	struct dev_ops		*d_dev_ops;	/* our device switch */
129 	struct dev_ops		*d_raw_ops;	/* the raw device switch */
130 	u_int			d_flags;
131 	int			d_opencount;	/* The current open count */
132 	cdev_t			d_rawdev;	/* backing raw device */
133 	cdev_t			d_cdev;		/* special whole-disk part */
134 	struct diskslices	*d_slice;
135 	struct disk_info	d_info;		/* info structure for media */
136 	void			*d_dsched_priv1;/* I/O scheduler priv. data */
137 	void			*d_dsched_priv2;/* I/O scheduler priv. data */
138 	struct dsched_policy	*d_sched_policy;/* I/O scheduler policy */
139 	const char		*d_disktype;	/* Disk type information */
140 	LIST_ENTRY(disk)	d_list;
141 };
142 
143 /*
144  * d_flags
145  */
146 #define DISKFLAG_LOCK		0x1
147 #define DISKFLAG_WANTED		0x2
148 
149 #ifdef _KERNEL
150 cdev_t disk_create (int unit, struct disk *disk, struct dev_ops *raw_ops);
151 cdev_t disk_create_clone (int unit, struct disk *disk, struct dev_ops *raw_ops);
152 cdev_t disk_create_named(const char *name, int unit, struct disk *dp, struct dev_ops *raw_ops);
153 cdev_t disk_create_named_clone(const char *name, int unit, struct disk *dp, struct dev_ops *raw_ops);
154 cdev_t disk_locate (const char *devname);
155 void disk_destroy (struct disk *disk);
156 void disk_setdiskinfo (struct disk *disk, struct disk_info *info);
157 int disk_setdisktype(struct disk *disk, const char *type);
158 int disk_getopencount(struct disk *disk);
159 void disk_setdiskinfo_sync(struct disk *disk, struct disk_info *info);
160 int disk_dumpcheck (cdev_t dev, u_int64_t *count, u_int64_t *blkno, u_int *secsize);
161 int disk_dumpconf(cdev_t dev, u_int onoff);
162 struct disk *disk_enumerate (struct disk *disk);
163 void disk_invalidate (struct disk *disk);
164 void disk_unprobe(struct disk *disk);
165 
166 void disk_msg_send(uint32_t cmd, void *load, void *load2);
167 void disk_msg_send_sync(uint32_t cmd, void *load, void *load2);
168 void disk_config(void *);
169 
170 int bounds_check_with_mediasize(struct bio *bio, int secsize, uint64_t mediasize);
171 
172 typedef struct disk_msg {
173 	struct lwkt_msg hdr;
174 	void	*load;
175 	void	*load2;
176 } *disk_msg_t;
177 
178 #define DISK_DISK_PROBE		0x01
179 #define DISK_DISK_DESTROY	0x02
180 #define DISK_SLICE_REPROBE	0x03
181 #define DISK_DISK_REPROBE	0x04
182 #define DISK_UNPROBE		0x05
183 #define DISK_SYNC			0x99
184 
185 
186 #endif /* _KERNEL */
187 
188 #endif /* _SYS_DISK_H_ */
189