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 * $FreeBSD$ 37 */ 38 39 #ifndef _GEOM_GEOM_DISK_H_ 40 #define _GEOM_GEOM_DISK_H_ 41 42 #define DISK_RR_UNKNOWN 0 43 #define DISK_RR_NON_ROTATING 1 44 #define DISK_RR_MIN 0x0401 45 #define DISK_RR_MAX 0xfffe 46 47 #ifdef _KERNEL 48 49 #include <sys/queue.h> 50 #include <sys/_lock.h> 51 #include <sys/_mutex.h> 52 #include <sys/disk.h> 53 54 #define G_DISK_CLASS_NAME "DISK" 55 56 struct disk; 57 58 typedef int disk_open_t(struct disk *); 59 typedef int disk_close_t(struct disk *); 60 typedef void disk_strategy_t(struct bio *bp); 61 typedef int disk_getattr_t(struct bio *bp); 62 typedef void disk_gone_t(struct disk *); 63 typedef int disk_ioctl_t(struct disk *, u_long cmd, void *data, 64 int fflag, struct thread *td); 65 /* NB: disk_ioctl_t SHALL be cast'able to d_ioctl_t */ 66 67 struct g_geom; 68 struct devstat; 69 70 typedef enum { 71 DISK_INIT_NONE, 72 DISK_INIT_CREATE, 73 DISK_INIT_START, 74 DISK_INIT_DONE 75 } disk_init_level; 76 77 struct disk_alias { 78 LIST_ENTRY(disk_alias) da_next; 79 const char *da_alias; 80 }; 81 82 struct disk { 83 /* Fields which are private to geom_disk */ 84 struct g_geom *d_geom; 85 struct devstat *d_devstat; 86 int d_goneflag; 87 int d_destroyed; 88 disk_init_level d_init_level; 89 90 /* Shared fields */ 91 u_int d_flags; 92 const char *d_name; 93 u_int d_unit; 94 struct bio_queue_head *d_queue; 95 struct mtx *d_lock; 96 97 /* Disk methods */ 98 disk_open_t *d_open; 99 disk_close_t *d_close; 100 disk_strategy_t *d_strategy; 101 disk_ioctl_t *d_ioctl; 102 dumper_t *d_dump; 103 disk_getattr_t *d_getattr; 104 disk_gone_t *d_gone; 105 106 /* Info fields from driver to geom_disk.c. Valid when open */ 107 u_int d_sectorsize; 108 off_t d_mediasize; 109 u_int d_fwsectors; 110 u_int d_fwheads; 111 u_int d_maxsize; 112 off_t d_delmaxsize; 113 off_t d_stripeoffset; 114 off_t d_stripesize; 115 char d_ident[DISK_IDENT_SIZE]; 116 char d_descr[DISK_IDENT_SIZE]; 117 uint16_t d_hba_vendor; 118 uint16_t d_hba_device; 119 uint16_t d_hba_subvendor; 120 uint16_t d_hba_subdevice; 121 uint16_t d_rotation_rate; 122 char d_attachment[DISK_IDENT_SIZE]; 123 124 /* Fields private to the driver */ 125 void *d_drv1; 126 127 /* Fields private to geom_disk, to be moved on next version bump */ 128 LIST_HEAD(,disk_alias) d_aliases; 129 struct g_event *d_cevent; 130 struct g_event *d_devent; 131 }; 132 133 #define DISKFLAG_RESERVED 0x0001 /* Was NEEDSGIANT */ 134 #define DISKFLAG_OPEN 0x0002 135 #define DISKFLAG_CANDELETE 0x0004 136 #define DISKFLAG_CANFLUSHCACHE 0x0008 137 #define DISKFLAG_UNMAPPED_BIO 0x0010 138 #define DISKFLAG_DIRECT_COMPLETION 0x0020 139 #define DISKFLAG_CANZONE 0x0080 140 #define DISKFLAG_WRITE_PROTECT 0x0100 141 142 struct disk *disk_alloc(void); 143 void disk_create(struct disk *disk, int version); 144 void disk_destroy(struct disk *disk); 145 void disk_gone(struct disk *disk); 146 void disk_attr_changed(struct disk *dp, const char *attr, int flag); 147 void disk_media_changed(struct disk *dp, int flag); 148 void disk_media_gone(struct disk *dp, int flag); 149 int disk_resize(struct disk *dp, int flag); 150 void disk_add_alias(struct disk *disk, const char *); 151 152 #define DISK_VERSION_00 0x58561059 153 #define DISK_VERSION_01 0x5856105a 154 #define DISK_VERSION_02 0x5856105b 155 #define DISK_VERSION_03 0x5856105c 156 #define DISK_VERSION_04 0x5856105d 157 #define DISK_VERSION_05 0x5856105e 158 #define DISK_VERSION_06 0x5856105f 159 #define DISK_VERSION DISK_VERSION_06 160 161 #endif /* _KERNEL */ 162 #endif /* _GEOM_GEOM_DISK_H_ */ 163