1/*-
2 * Copyright (c) 2003 Poul-Henning Kamp
3 * All rights reserved.
4 *
5 * This software was developed for the FreeBSD Project by Poul-Henning Kamp
6 * and NAI Labs, the Security Research Division of Network Associates, Inc.
7 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
8 * DARPA CHATS research program.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. The names of the authors may not be used to endorse or promote
19 *    products derived from this software without specific prior written
20 *    permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * $FreeBSD: stable/11/sys/geom/geom_disk.h 329316 2018-02-15 15:33:17Z avg $
35 */
36
37#ifndef _GEOM_GEOM_DISK_H_
38#define _GEOM_GEOM_DISK_H_
39
40#define	DISK_RR_UNKNOWN		0
41#define	DISK_RR_NON_ROTATING	1
42#define	DISK_RR_MIN		0x0401
43#define	DISK_RR_MAX		0xfffe
44
45#ifdef _KERNEL
46
47#include <sys/queue.h>
48#include <sys/_lock.h>
49#include <sys/_mutex.h>
50#include <sys/disk.h>
51
52#define G_DISK_CLASS_NAME	"DISK"
53
54struct disk;
55
56typedef	int	disk_open_t(struct disk *);
57typedef	int	disk_close_t(struct disk *);
58typedef	void	disk_strategy_t(struct bio *bp);
59typedef	int	disk_getattr_t(struct bio *bp);
60typedef	void	disk_gone_t(struct disk *);
61typedef	int	disk_ioctl_t(struct disk *, u_long cmd, void *data,
62			int fflag, struct thread *td);
63		/* NB: disk_ioctl_t SHALL be cast'able to d_ioctl_t */
64
65struct g_geom;
66struct devstat;
67
68typedef enum {
69	DISK_INIT_NONE,
70	DISK_INIT_START,
71	DISK_INIT_DONE
72} disk_init_level;
73
74struct disk {
75	/* Fields which are private to geom_disk */
76	struct g_geom		*d_geom;
77	struct devstat		*d_devstat;
78	int			d_goneflag;
79	int			d_destroyed;
80	disk_init_level		d_init_level;
81
82	/* Shared fields */
83	u_int			d_flags;
84	const char		*d_name;
85	u_int			d_unit;
86	struct bio_queue_head	*d_queue;
87	struct mtx		*d_lock;
88
89	/* Disk methods  */
90	disk_open_t		*d_open;
91	disk_close_t		*d_close;
92	disk_strategy_t		*d_strategy;
93	disk_ioctl_t		*d_ioctl;
94	dumper_t		*d_dump;
95	disk_getattr_t		*d_getattr;
96	disk_gone_t		*d_gone;
97
98	/* Info fields from driver to geom_disk.c. Valid when open */
99	u_int			d_sectorsize;
100	off_t			d_mediasize;
101	u_int			d_fwsectors;
102	u_int			d_fwheads;
103	u_int			d_maxsize;
104	off_t			d_delmaxsize;
105	u_int			d_stripeoffset;
106	u_int			d_stripesize;
107	char			d_ident[DISK_IDENT_SIZE];
108	char			d_descr[DISK_IDENT_SIZE];
109	uint16_t		d_hba_vendor;
110	uint16_t		d_hba_device;
111	uint16_t		d_hba_subvendor;
112	uint16_t		d_hba_subdevice;
113	uint16_t		d_rotation_rate;
114
115	/* Fields private to the driver */
116	void			*d_drv1;
117};
118
119#define	DISKFLAG_RESERVED		0x0001	/* Was NEEDSGIANT */
120#define	DISKFLAG_OPEN			0x0002
121#define	DISKFLAG_CANDELETE		0x0004
122#define	DISKFLAG_CANFLUSHCACHE		0x0008
123#define	DISKFLAG_UNMAPPED_BIO		0x0010
124#define	DISKFLAG_DIRECT_COMPLETION	0x0020
125#define	DISKFLAG_CANZONE		0x0080
126#define	DISKFLAG_WRITE_PROTECT		0x0100
127
128struct disk *disk_alloc(void);
129void disk_create(struct disk *disk, int version);
130void disk_destroy(struct disk *disk);
131void disk_gone(struct disk *disk);
132void disk_attr_changed(struct disk *dp, const char *attr, int flag);
133void disk_media_changed(struct disk *dp, int flag);
134void disk_media_gone(struct disk *dp, int flag);
135int disk_resize(struct disk *dp, int flag);
136
137#define DISK_VERSION_00		0x58561059
138#define DISK_VERSION_01		0x5856105a
139#define DISK_VERSION_02		0x5856105b
140#define DISK_VERSION_03		0x5856105c
141#define DISK_VERSION_04		0x5856105d
142#define DISK_VERSION_05		0x5856105e
143#define DISK_VERSION		DISK_VERSION_05
144
145#endif /* _KERNEL */
146#endif /* _GEOM_GEOM_DISK_H_ */
147