Home | History | Annotate | Line # | Download | only in dev
dkvar.h revision 1.21 
      1 /* $NetBSD: dkvar.h,v 1.21 2015/08/16 18:00:03 mlelstv 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 /* literally this is not a softc, but is intended to be included in
     35  * the pseudo-disk's softc and passed to calls in dksubr.c.  It
     36  * should include the common elements of the pseudo-disk's softc.
     37  * All elements that are included here should describe the external
     38  * representation of the disk to the higher layers, and flags that
     39  * are common to each of the pseudo-disk drivers.
     40  */
     41 struct dk_softc {
     42 	device_t		 sc_dev;
     43 	u_int32_t		 sc_flags;	/* flags */
     44 #define DK_XNAME_SIZE 8
     45 	char			 sc_xname[DK_XNAME_SIZE]; /* external name */
     46 	struct disk		 sc_dkdev;	/* generic disk info */
     47 	kmutex_t		 sc_iolock;	/* protects buffer queue */
     48 	struct bufq_state	*sc_bufq;	/* buffer queue */
     49 	int			 sc_dtype;	/* disk type */
     50 };
     51 
     52 /* sc_flags:
     53  *   We separate the flags into two varieties, those that dksubr.c
     54  *   understands and manipulates and those that it does not.
     55  */
     56 
     57 #define DKF_INITED	0x00010000 /* unit has been initialised */
     58 #define DKF_WLABEL	0x00020000 /* label area is writable */
     59 #define DKF_LABELLING	0x00040000 /* unit is currently being labeled */
     60 #define DKF_WARNLABEL	0x00080000 /* warn if disklabel not present */
     61 #define DKF_LABELSANITY	0x00100000 /* warn if disklabel not sane */
     62 #define DKF_TAKEDUMP	0x00200000 /* allow dumping */
     63 #define DKF_KLABEL      0x00400000 /* keep label on close */
     64 #define DKF_VLABEL      0x00800000 /* label is valid */
     65 
     66 /* Mask of flags that dksubr.c understands, other flags are fair game */
     67 #define DK_FLAGMASK	0xffff0000
     68 
     69 #define DK_ATTACHED(_dksc) ((_dksc)->sc_flags & DKF_INITED)
     70 
     71 #define DK_BUSY(_dksc, _pmask)				\
     72 	(((_dksc)->sc_dkdev.dk_openmask & ~(_pmask)) ||	\
     73 	((_dksc)->sc_dkdev.dk_bopenmask & (_pmask)  &&	\
     74 	((_dksc)->sc_dkdev.dk_copenmask & (_pmask))))
     75 
     76 /*
     77  * Functions that are exported to the pseudo disk implementations:
     78  */
     79 
     80 void	dk_init(struct dk_softc *, device_t, int);
     81 void	dk_attach(struct dk_softc *);
     82 void	dk_detach(struct dk_softc *);
     83 
     84 int	dk_open(struct dk_softc *, dev_t,
     85 		int, int, struct lwp *);
     86 int	dk_close(struct dk_softc *, dev_t,
     87 		 int, int, struct lwp *);
     88 void	dk_strategy(struct dk_softc *, struct buf *);
     89 int	dk_discard(struct dk_softc *, dev_t, off_t, off_t);
     90 void	dk_start(struct dk_softc *, struct buf *);
     91 void	dk_done(struct dk_softc *, struct buf *);
     92 int	dk_size(struct dk_softc *, dev_t);
     93 int	dk_ioctl(struct dk_softc *, dev_t,
     94 		 u_long, void *, int, struct lwp *);
     95 int	dk_dump(struct dk_softc *, dev_t,
     96 		daddr_t, void *, size_t);
     97 void	dk_getdisklabel(struct dk_softc *, dev_t);
     98 void	dk_getdefaultlabel(struct dk_softc *, struct disklabel *);
     99 
    100 int	dk_lookup(struct pathbuf *, struct lwp *, struct vnode **);
    101