1 /* $NetBSD: dkvar.h,v 1.19 2014/05/25 19:23:49 bouyer Exp $ */ 2 3 /*- 4 * Copyright (c) 2002 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Roland C. Dowdeswell. 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 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 struct pathbuf; /* from namei.h */ 33 34 35 /* literally this is not a softc, but is intended to be included in 36 * the pseudo-disk's softc and passed to calls in dksubr.c. It 37 * should include the common elements of the pseudo-disk's softc. 38 * All elements that are included here should describe the external 39 * representation of the disk to the higher layers, and flags that 40 * are common to each of the pseudo-disk drivers. 41 */ 42 struct dk_softc { 43 device_t sc_dev; 44 u_int32_t sc_flags; /* flags */ 45 #define DK_XNAME_SIZE 8 46 char sc_xname[DK_XNAME_SIZE]; /* external name */ 47 struct disk sc_dkdev; /* generic disk info */ 48 struct bufq_state *sc_bufq; /* buffer queue */ 49 }; 50 51 /* sc_flags: 52 * We separate the flags into two varieties, those that dksubr.c 53 * understands and manipulates and those that it does not. 54 */ 55 56 #define DKF_INITED 0x00010000 /* unit has been initialised */ 57 #define DKF_WLABEL 0x00020000 /* label area is writable */ 58 #define DKF_LABELLING 0x00040000 /* unit is currently being labeled */ 59 #define DKF_WARNLABEL 0x00080000 /* warn if disklabel not present */ 60 #define DKF_LABELSANITY 0x00100000 /* warn if disklabel not sane */ 61 #define DKF_TAKEDUMP 0x00200000 /* allow dumping */ 62 63 /* Mask of flags that dksubr.c understands, other flags are fair game */ 64 #define DK_FLAGMASK 0xffff0000 65 66 /* 67 * This defines the interface to the routines in dksubr.c. This 68 * should be a single static structure per pseudo-disk driver. 69 * We only define the functions that we currently need. 70 */ 71 struct dk_intf { 72 int di_dtype; /* disk type */ 73 const char *di_dkname; /* disk type name */ 74 int (*di_open)(dev_t, int, int, struct lwp *); 75 int (*di_close)(dev_t, int, int, struct lwp *); 76 void (*di_strategy)(struct buf *); 77 void (*di_diskstart)(struct dk_softc *); 78 }; 79 80 #define DK_BUSY(_dksc, _pmask) \ 81 (((_dksc)->sc_dkdev.dk_openmask & ~(_pmask)) || \ 82 ((_dksc)->sc_dkdev.dk_bopenmask & (_pmask) && \ 83 ((_dksc)->sc_dkdev.dk_copenmask & (_pmask)))) 84 85 /* 86 * Functions that are exported to the pseudo disk implementations: 87 */ 88 89 void dk_sc_init(struct dk_softc *, const char *); 90 91 int dk_open(struct dk_intf *, struct dk_softc *, dev_t, 92 int, int, struct lwp *); 93 int dk_close(struct dk_intf *, struct dk_softc *, dev_t, 94 int, int, struct lwp *); 95 void dk_strategy(struct dk_intf *, struct dk_softc *, struct buf *); 96 int dk_size(struct dk_intf *, struct dk_softc *, dev_t); 97 int dk_ioctl(struct dk_intf *, struct dk_softc *, dev_t, 98 u_long, void *, int, struct lwp *); 99 int dk_dump(struct dk_intf *, struct dk_softc *, dev_t, 100 daddr_t, void *, size_t); 101 void dk_getdisklabel(struct dk_intf *, struct dk_softc *, dev_t); 102 void dk_getdefaultlabel(struct dk_intf *, struct dk_softc *, 103 struct disklabel *); 104 105 int dk_lookup(struct pathbuf *, struct lwp *, struct vnode **); 106