dkvar.h revision 1.17 
1/* $NetBSD: dkvar.h,v 1.17 2013/05/29 00:47:48 christos 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
32struct pathbuf; /* from namei.h */
33
34
35/* XXX: GC */
36struct dk_geom {
37	u_int32_t	pdg_secsize;
38	u_int32_t	pdg_nsectors;
39	u_int32_t	pdg_ntracks;
40	u_int32_t	pdg_ncylinders;
41};
42
43/* literally this is not a softc, but is intended to be included in
44 * the pseudo-disk's softc and passed to calls in dksubr.c.  It
45 * should include the common elements of the pseudo-disk's softc.
46 * All elements that are included here should describe the external
47 * representation of the disk to the higher layers, and flags that
48 * are common to each of the pseudo-disk drivers.
49 */
50struct dk_softc {
51	device_t		 sc_dev;
52	u_int32_t		 sc_flags;	/* flags */
53	size_t			 sc_size;	/* size of disk */
54	struct dk_geom		 sc_geom;	/* geometry info */
55#define DK_XNAME_SIZE 8
56	char			 sc_xname[DK_XNAME_SIZE]; /* external name */
57	struct disk		 sc_dkdev;	/* generic disk info */
58	struct bufq_state	*sc_bufq;	/* buffer queue */
59};
60
61/* sc_flags:
62 *   We separate the flags into two varieties, those that dksubr.c
63 *   understands and manipulates and those that it does not.
64 */
65
66#define DKF_INITED	0x00010000 /* unit has been initialised */
67#define DKF_WLABEL	0x00020000 /* label area is writable */
68#define DKF_LABELLING	0x00040000 /* unit is currently being labeled */
69#define DKF_WARNLABEL	0x00080000 /* warn if disklabel not present */
70#define DKF_LABELSANITY	0x00100000 /* warn if disklabel not sane */
71#define DKF_TAKEDUMP	0x00200000 /* allow dumping */
72
73/* Mask of flags that dksubr.c understands, other flags are fair game */
74#define DK_FLAGMASK	0xffff0000
75
76/*
77 * This defines the interface to the routines in dksubr.c.  This
78 * should be a single static structure per pseudo-disk driver.
79 * We only define the functions that we currently need.
80 */
81struct dk_intf {
82	int	  di_dtype;			/* disk type */
83	const char *di_dkname;			/* disk type name */
84	int	(*di_open)(dev_t, int, int, struct lwp *);
85	int	(*di_close)(dev_t, int, int, struct lwp *);
86	void	(*di_strategy)(struct buf *);
87	int	(*di_diskstart)(struct dk_softc *, struct buf *);
88};
89
90#define DK_BUSY(_dksc, _pmask)				\
91	(((_dksc)->sc_dkdev.dk_openmask & ~(_pmask)) ||	\
92	((_dksc)->sc_dkdev.dk_bopenmask & (_pmask)  &&	\
93	((_dksc)->sc_dkdev.dk_copenmask & (_pmask))))
94
95/*
96 * Functions that are exported to the pseudo disk implementations:
97 */
98
99void	dk_sc_init(struct dk_softc *, const char *);
100
101int	dk_open(struct dk_intf *, struct dk_softc *, dev_t,
102		int, int, struct lwp *);
103int	dk_close(struct dk_intf *, struct dk_softc *, dev_t,
104		 int, int, struct lwp *);
105void	dk_strategy(struct dk_intf *, struct dk_softc *, struct buf *);
106void	dk_start(struct dk_intf *, struct dk_softc *);
107void	dk_iodone(struct dk_intf *, struct dk_softc *);
108int	dk_size(struct dk_intf *, struct dk_softc *, dev_t);
109int	dk_ioctl(struct dk_intf *, struct dk_softc *, dev_t,
110		 u_long, void *, int, struct lwp *);
111int	dk_dump(struct dk_intf *, struct dk_softc *, dev_t,
112		daddr_t, void *, size_t);
113void	dk_getdisklabel(struct dk_intf *, struct dk_softc *, dev_t);
114void	dk_getdefaultlabel(struct dk_intf *, struct dk_softc *,
115			   struct disklabel *);
116/* XXX: GC use disk_set_info() */
117void	dk_set_geometry(struct dk_intf *, struct dk_softc *);
118
119int	dk_lookup(struct pathbuf *, struct lwp *, struct vnode **);
120