sys/geom/geom_disk.h

   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$
  35  */
  36
  37 #ifndef _GEOM_GEOM_DISK_H_
  38 #define _GEOM_GEOM_DISK_H_
  39
  40 #ifdef _KERNEL
  41
  42 #include <sys/queue.h>
  43 #include <sys/_lock.h>
  44 #include <sys/_mutex.h>
  45 #include <sys/disk.h>
  46
  47 #define G_DISK_CLASS_NAME       "DISK"
  48
  49 struct disk;
  50
  51 typedef int     disk_open_t(struct disk *);
  52 typedef int     disk_close_t(struct disk *);
  53 typedef void    disk_strategy_t(struct bio *bp);
  54 typedef int     disk_getattr_t(struct bio *bp);
  55 typedef void    disk_gone_t(struct disk *);
  56 typedef int     disk_ioctl_t(struct disk *, u_long cmd, void *data,
  57                         int fflag, struct thread *td);
  58                 /* NB: disk_ioctl_t SHALL be cast'able to d_ioctl_t */
  59
  60 struct g_geom;
  61 struct devstat;
  62
  63 struct disk {
  64         /* Fields which are private to geom_disk */
  65         struct g_geom           *d_geom;
  66         struct devstat          *d_devstat;
  67         int                     d_destroyed;
  68
  69         /* Shared fields */
  70         u_int                   d_flags;
  71         const char              *d_name;
  72         u_int                   d_unit;
  73         struct bio_queue_head   *d_queue;
  74         struct mtx              *d_lock;
  75
  76         /* Disk methods  */
  77         disk_open_t             *d_open;
  78         disk_close_t            *d_close;
  79         disk_strategy_t         *d_strategy;
  80         disk_ioctl_t            *d_ioctl;
  81         dumper_t                *d_dump;
  82         disk_getattr_t          *d_getattr;
  83         disk_gone_t             *d_gone;
  84
  85         /* Info fields from driver to geom_disk.c. Valid when open */
  86         u_int                   d_sectorsize;
  87         off_t                   d_mediasize;
  88         u_int                   d_fwsectors;
  89         u_int                   d_fwheads;
  90         u_int                   d_maxsize;
  91         off_t                   d_delmaxsize;
  92         u_int                   d_stripeoffset;
  93         u_int                   d_stripesize;
  94         char                    d_ident[DISK_IDENT_SIZE];
  95         char                    d_descr[DISK_IDENT_SIZE];
  96         uint16_t                d_hba_vendor;
  97         uint16_t                d_hba_device;
  98         uint16_t                d_hba_subvendor;
  99         uint16_t                d_hba_subdevice;
 100
 101         /* Fields private to the driver */
 102         void                    *d_drv1;
 103 };
 104
 105 #define DISKFLAG_NEEDSGIANT     0x1
 106 #define DISKFLAG_OPEN           0x2
 107 #define DISKFLAG_CANDELETE      0x4
 108 #define DISKFLAG_CANFLUSHCACHE  0x8
 109 #define DISKFLAG_UNMAPPED_BIO   0x10
 110
 111 struct disk *disk_alloc(void);
 112 void disk_create(struct disk *disk, int version);
 113 void disk_destroy(struct disk *disk);
 114 void disk_gone(struct disk *disk);
 115 void disk_attr_changed(struct disk *dp, const char *attr, int flag);
 116 void disk_media_changed(struct disk *dp, int flag);
 117 void disk_media_gone(struct disk *dp, int flag);
 118 int disk_resize(struct disk *dp, int flag);
 119
 120 #define DISK_VERSION_00         0x58561059
 121 #define DISK_VERSION_01         0x5856105a
 122 #define DISK_VERSION_02         0x5856105b
 123 #define DISK_VERSION_03         0x5856105c
 124 #define DISK_VERSION            DISK_VERSION_03
 125
 126 #endif /* _KERNEL */
 127 #endif /* _GEOM_GEOM_DISK_H_ */