1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 2003 Poul-Henning Kamp
5 * All rights reserved.
6 *
7 * This software was developed for the FreeBSD Project by Poul-Henning Kamp
8 * and NAI Labs, the Security Research Division of Network Associates, Inc.
9 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
10 * DARPA CHATS research program.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. The names of the authors may not be used to endorse or promote
21 * products derived from this software without specific prior written
22 * permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
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_CREATE,
71 DISK_INIT_START,
72 DISK_INIT_DONE
73} disk_init_level;
74
75struct disk_alias {
76 LIST_ENTRY(disk_alias) da_next;
77 const char *da_alias;
78};
79
80struct disk {
81 /* Fields which are private to geom_disk */
82 struct g_geom *d_geom;
83 struct devstat *d_devstat;
84 int d_goneflag;
85 int d_destroyed;
86 disk_init_level d_init_level;
87
88 /* Shared fields */
89 u_int d_flags;
90 const char *d_name;
91 u_int d_unit;
92 struct bio_queue_head *d_queue;
93 struct mtx *d_lock;
94
95 /* Disk methods */
96 disk_open_t *d_open;
97 disk_close_t *d_close;
98 disk_strategy_t *d_strategy;
99 disk_ioctl_t *d_ioctl;
100 dumper_t *d_dump;
101 disk_getattr_t *d_getattr;
102 disk_gone_t *d_gone;
103
104 /* Info fields from driver to geom_disk.c. Valid when open */
105 u_int d_sectorsize;
106 off_t d_mediasize;
107 u_int d_fwsectors;
108 u_int d_fwheads;
109 u_int d_maxsize;
110 off_t d_delmaxsize;
111 off_t d_stripeoffset;
112 off_t d_stripesize;
113 char d_ident[DISK_IDENT_SIZE];
114 char d_descr[DISK_IDENT_SIZE];
115 uint16_t d_hba_vendor;
116 uint16_t d_hba_device;
117 uint16_t d_hba_subvendor;
118 uint16_t d_hba_subdevice;
119 uint16_t d_rotation_rate;
120 char d_attachment[DISK_IDENT_SIZE];
121
122 /* Fields private to the driver */
123 void *d_drv1;
124
125 /* Fields private to geom_disk, to be moved on next version bump */
126 LIST_HEAD(,disk_alias) d_aliases;
127 struct g_event *d_cevent;
128 struct g_event *d_devent;
129};
130
131#define DISKFLAG_RESERVED 0x0001 /* Was NEEDSGIANT */
132#define DISKFLAG_OPEN 0x0002
133#define DISKFLAG_CANDELETE 0x0004
134#define DISKFLAG_CANFLUSHCACHE 0x0008
135#define DISKFLAG_UNMAPPED_BIO 0x0010
136#define DISKFLAG_DIRECT_COMPLETION 0x0020
137#define DISKFLAG_CANZONE 0x0080
138#define DISKFLAG_WRITE_PROTECT 0x0100
139
140struct disk *disk_alloc(void);
141void disk_create(struct disk *disk, int version);
142void disk_destroy(struct disk *disk);
143void disk_gone(struct disk *disk);
144void disk_attr_changed(struct disk *dp, const char *attr, int flag);
145void disk_media_changed(struct disk *dp, int flag);
146void disk_media_gone(struct disk *dp, int flag);
147int disk_resize(struct disk *dp, int flag);
148void disk_add_alias(struct disk *disk, const char *);
149
150#define DISK_VERSION_00 0x58561059
151#define DISK_VERSION_01 0x5856105a
152#define DISK_VERSION_02 0x5856105b
153#define DISK_VERSION_03 0x5856105c
154#define DISK_VERSION_04 0x5856105d
155#define DISK_VERSION_05 0x5856105e
156#define DISK_VERSION_06 0x5856105f
157#define DISK_VERSION DISK_VERSION_06
158
159#endif /* _KERNEL */
160#endif /* _GEOM_GEOM_DISK_H_ */