[dragonfly.git] / sys / sys / disk.h

/*
 * Copyright (c) 2003,2004 The DragonFly Project.  All rights reserved.
 * 
 * This code is derived from software contributed to The DragonFly Project
 * by Matthew Dillon <dillon@backplane.com>
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of The DragonFly Project nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific, prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * 
 * ----------------------------------------------------------------------------
 * "THE BEER-WARE LICENSE" (Revision 42):
 * <phk@FreeBSD.ORG> wrote this file.  As long as you retain this notice you
 * can do whatever you want with this stuff. If we meet some day, and you think
 * this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
 * ----------------------------------------------------------------------------
 *
 * $FreeBSD: src/sys/sys/disk.h,v 1.16.2.3 2001/06/20 16:11:01 scottl Exp $
 * $DragonFly: src/sys/sys/disk.h,v 1.18 2007/07/30 08:02:40 dillon Exp $
 */

#ifndef _SYS_DISK_H_
#define	_SYS_DISK_H_

#if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
#error "This file should not be included by userland programs."
#endif

#ifndef _SYS_DISKSLICE_H_
#include <sys/diskslice.h>
#endif
#ifndef _SYS_QUEUE_H_
#include <sys/queue.h>
#endif
#ifndef _SYS_MSGPORT_H_
#include <sys/msgport.h>
#endif

/*
 * Media information structure - filled in by the media driver.
 *
 * NOTE: d_serialno is copied on the call to setdiskinfo and need
 *	 not be valid after that.
 */
struct disk_info {
	/*
	 * These fields are required.  Most drivers will load a disk_info
	 * structure in the device open function with the media parameters
	 * and call disk_setdiskinfo().
	 *
	 * Note that only one of d_media_size or d_media_blocks should be
	 * filled in.
	 *
	 * d_media_size		media size in bytes
	 * d_media_blocks	media size in blocks (e.g. total sectors)
	 * d_media_blksize	media block size / sector size
	 * d_dsflags		disklabel management flags
	 */
	u_int64_t		d_media_size;
	u_int64_t		d_media_blocks;
	int			d_media_blksize;
	u_int			d_dsflags;

	/*
	 * Optional fields, leave 0 if not known
	 */
	u_int			d_type;		/* DTYPE_xxx */
	u_int			d_nheads;
	u_int			d_ncylinders;
	u_int			d_secpertrack;
	u_int			d_secpercyl;
	u_int			d_trimflag;
	char			*d_serialno;
};

/*
 * d_dsflags, also used for dsopen() - control disklabel processing
 *
 * COMPATPARTA	- used by scsi devices to allow CDs to boot from cd0a.
 *		  cd's don't have disklabels and the default compat label
 *		  does not implement an 'a' partition.
 *
 * COMPATMBR	- used by the vn device to request that one sector be
 *		  reserved as if an MBR were present even when one isn't.
 *
 * MBRQUIET	- silently ignore MBR probe if unable to read sector 0.
 *		  used by VN.
 *
 * DEVICEMAPPER	- used by the device mapper (dm). Adds a '.' between the
 *		  device name and the slice/part stuff (i.e. foo.s0).
 */
#define DSO_NOLABELS		0x0001
#define DSO_ONESLICE		0x0002
#define DSO_COMPATLABEL		0x0004
#define DSO_COMPATPARTA		0x0008
#define DSO_COMPATMBR		0x0010
#define DSO_RAWEXTENSIONS	0x0020
#define DSO_MBRQUIET		0x0040
#define DSO_DEVICEMAPPER	0x0080

/*
 * Disk management structure - automated disklabel support.
 */
struct disk {
	struct dev_ops		*d_dev_ops;	/* our device switch */
	struct dev_ops		*d_raw_ops;	/* the raw device switch */
	u_int			d_flags;
	int			d_opencount;	/* The current open count */
	cdev_t			d_rawdev;	/* backing raw device */
	cdev_t			d_cdev;		/* special whole-disk part */
	struct diskslices	*d_slice;
	struct disk_info	d_info;		/* info structure for media */
	void			*d_dsched_priv1;/* I/O scheduler priv. data */
	void			*d_dsched_priv2;/* I/O scheduler priv. data */
	struct dsched_policy	*d_sched_policy;/* I/O scheduler policy */
	const char		*d_disktype;	/* Disk type information */
	LIST_ENTRY(disk)	d_list;
};

/*
 * d_flags
 */
#define DISKFLAG_LOCK		0x1
#define DISKFLAG_WANTED		0x2

#ifdef _KERNEL
cdev_t disk_create (int unit, struct disk *disk, struct dev_ops *raw_ops);
cdev_t disk_create_clone (int unit, struct disk *disk, struct dev_ops *raw_ops);
cdev_t disk_create_named(const char *name, int unit, struct disk *dp, struct dev_ops *raw_ops);
cdev_t disk_create_named_clone(const char *name, int unit, struct disk *dp, struct dev_ops *raw_ops);
cdev_t disk_locate (const char *devname);
void disk_destroy (struct disk *disk);
void disk_setdiskinfo (struct disk *disk, struct disk_info *info);
int disk_setdisktype(struct disk *disk, const char *type);
int disk_getopencount(struct disk *disk);
void disk_setdiskinfo_sync(struct disk *disk, struct disk_info *info);
int disk_dumpcheck (cdev_t dev, u_int64_t *count, u_int64_t *blkno, u_int *secsize);
int disk_dumpconf(cdev_t dev, u_int onoff);
struct disk *disk_enumerate (struct disk *disk);
void disk_invalidate (struct disk *disk);
void disk_unprobe(struct disk *disk);

void disk_msg_send(uint32_t cmd, void *load, void *load2);
void disk_msg_send_sync(uint32_t cmd, void *load, void *load2);
void disk_config(void *);

int bounds_check_with_mediasize(struct bio *bio, int secsize, uint64_t mediasize);

typedef struct disk_msg {
	struct lwkt_msg hdr;
	void	*load;
	void	*load2;
} *disk_msg_t;

#define DISK_DISK_PROBE		0x01
#define DISK_DISK_DESTROY	0x02
#define DISK_SLICE_REPROBE	0x03
#define DISK_DISK_REPROBE	0x04
#define DISK_UNPROBE		0x05
#define DISK_SYNC			0x99


#endif /* _KERNEL */

#endif /* _SYS_DISK_H_ */
Commit	Line	Data
984263bc	1	/*
8c10bfcf MD	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	*
e4c9c0c8 MD	7	* Redistribution and use in source and binary forms, with or without
	8	* modification, are permitted provided that the following conditions
	9	* are met:
8c10bfcf	10	*
e4c9c0c8 MD	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
8c10bfcf MD	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
e4c9c0c8	32	* SUCH DAMAGE.
8c10bfcf	33	*
984263bc MD	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 $
a8873631	42	* $DragonFly: src/sys/sys/disk.h,v 1.18 2007/07/30 08:02:40 dillon Exp $
984263bc MD	43	*/
	44
	45	#ifndef _SYS_DISK_H_
	46	#define _SYS_DISK_H_
	47
d9f3f6fa CP	48	#if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
	49	#error "This file should not be included by userland programs."
	50	#endif
	51
984263bc MD	52	#ifndef _SYS_DISKSLICE_H_
984263bc MD	53	#include <sys/diskslice.h>
335dda38	54	#endif
5350e1e9 MD	55	#ifndef _SYS_QUEUE_H_
	56	#include <sys/queue.h>
	57	#endif
cd29885a MD	58	#ifndef _SYS_MSGPORT_H_
	59	#include <sys/msgport.h>
	60	#endif
335dda38	61
a688b15c MD	62	/*
a688b15c MD	63	* Media information structure - filled in by the media driver.
55230951 MD	64	*
	65	* NOTE: d_serialno is copied on the call to setdiskinfo and need
	66	* not be valid after that.
a688b15c MD	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;
e0fb398b	95	u_int d_trimflag;
55230951	96	char *d_serialno;
a688b15c MD	97	};
	98
	99	/*
	100	* d_dsflags, also used for dsopen() - control disklabel processing
7dc62e37 MD	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	*
3af01d56	106	* COMPATMBR - used by the vn device to request that one sector be
7dc62e37	107	* reserved as if an MBR were present even when one isn't.
aec8eea4 MD	108	*
	109	* MBRQUIET - silently ignore MBR probe if unable to read sector 0.
	110	* used by VN.
3af01d56 AH	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).
a688b15c MD	114	*/
	115	#define DSO_NOLABELS 0x0001
	116	#define DSO_ONESLICE 0x0002
	117	#define DSO_COMPATLABEL 0x0004
	118	#define DSO_COMPATPARTA 0x0008
7dc62e37	119	#define DSO_COMPATMBR 0x0010
8a88e0d0	120	#define DSO_RAWEXTENSIONS 0x0020
aec8eea4	121	#define DSO_MBRQUIET 0x0040
3af01d56	122	#define DSO_DEVICEMAPPER 0x0080
a688b15c MD	123
	124	/*
	125	* Disk management structure - automated disklabel support.
	126	*/
984263bc	127	struct disk {
fef8985e MD	128	struct dev_ops d_dev_ops; / our device switch */
fef8985e MD	129	struct dev_ops d_raw_ops; / the raw device switch */
984263bc	130	u_int d_flags;
8d51c2a2	131	int d_opencount; /* The current open count */
b13267a5 MD	132	cdev_t d_rawdev; /* backing raw device */
b13267a5 MD	133	cdev_t d_cdev; /* special whole-disk part */
984263bc	134	struct diskslices *d_slice;
a688b15c	135	struct disk_info d_info; /* info structure for media */
8c72e3d5 AH	136	void d_dsched_priv1;/ I/O scheduler priv. data */
8c72e3d5 AH	137	void d_dsched_priv2;/ I/O scheduler priv. data */
0160356d	138	struct dsched_policy d_sched_policy;/ I/O scheduler policy */
f5d8307c	139	const char d_disktype; / Disk type information */
984263bc MD	140	LIST_ENTRY(disk) d_list;
	141	};
	142
a688b15c MD	143	/*
	144	* d_flags
	145	*/
984263bc MD	146	#define DISKFLAG_LOCK 0x1
	147	#define DISKFLAG_WANTED 0x2
	148
d9f3f6fa	149	#ifdef _KERNEL
a688b15c	150	cdev_t disk_create (int unit, struct disk disk, struct dev_ops raw_ops);
4064300e	151	cdev_t disk_create_clone (int unit, struct disk disk, struct dev_ops raw_ops);
c6ef65ea	152	cdev_t disk_create_named(const char name, int unit, struct disk dp, struct dev_ops *raw_ops);
4064300e	153	cdev_t disk_create_named_clone(const char name, int unit, struct disk dp, struct dev_ops *raw_ops);
a8873631	154	cdev_t disk_locate (const char *devname);
b153f746	155	void disk_destroy (struct disk *disk);
a688b15c	156	void disk_setdiskinfo (struct disk disk, struct disk_info info);
f5d8307c	157	int disk_setdisktype(struct disk disk, const char type);
8d51c2a2	158	int disk_getopencount(struct disk *disk);
aec8eea4	159	void disk_setdiskinfo_sync(struct disk disk, struct disk_info info);
e0fc5693	160	int disk_dumpcheck (cdev_t dev, u_int64_t count, u_int64_t blkno, u_int *secsize);
b24cd69c	161	int disk_dumpconf(cdev_t dev, u_int onoff);
b153f746 RG	162	struct disk disk_enumerate (struct disk disk);
b153f746 RG	163	void disk_invalidate (struct disk *disk);
aec8eea4	164	void disk_unprobe(struct disk *disk);
cd29885a MD	165
cd29885a MD	166	void disk_msg_send(uint32_t cmd, void load, void load2);
aec8eea4	167	void disk_msg_send_sync(uint32_t cmd, void load, void load2);
cd29885a MD	168	void disk_config(void *);
cd29885a MD	169
c6ef65ea AH	170	int bounds_check_with_mediasize(struct bio *bio, int secsize, uint64_t mediasize);
c6ef65ea AH	171
cd29885a MD	172	typedef struct disk_msg {
cd29885a MD	173	struct lwkt_msg hdr;
cd29885a MD	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
aec8eea4	182	#define DISK_UNPROBE 0x05
cd29885a MD	183	#define DISK_SYNC 0x99
	184
	185
d9f3f6fa	186	#endif /* _KERNEL */
984263bc MD	187
984263bc MD	188	#endif /* _SYS_DISK_H_ */