ccdvar.h revision 1.16 1 /* $NetBSD: ccdvar.h,v 1.16 1999/01/12 00:21:47 thorpej Exp $ */
2
3 /*-
4 * Copyright (c) 1996, 1997, 1998 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe.
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. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the NetBSD
21 * Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39 /*
40 * Copyright (c) 1988 University of Utah.
41 * Copyright (c) 1990, 1993
42 * The Regents of the University of California. All rights reserved.
43 *
44 * This code is derived from software contributed to Berkeley by
45 * the Systems Programming Group of the University of Utah Computer
46 * Science Department.
47 *
48 * Redistribution and use in source and binary forms, with or without
49 * modification, are permitted provided that the following conditions
50 * are met:
51 * 1. Redistributions of source code must retain the above copyright
52 * notice, this list of conditions and the following disclaimer.
53 * 2. Redistributions in binary form must reproduce the above copyright
54 * notice, this list of conditions and the following disclaimer in the
55 * documentation and/or other materials provided with the distribution.
56 * 3. All advertising materials mentioning features or use of this software
57 * must display the following acknowledgement:
58 * This product includes software developed by the University of
59 * California, Berkeley and its contributors.
60 * 4. Neither the name of the University nor the names of its contributors
61 * may be used to endorse or promote products derived from this software
62 * without specific prior written permission.
63 *
64 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
65 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
66 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
67 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
68 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
69 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
70 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
71 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
72 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
73 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
74 * SUCH DAMAGE.
75 *
76 * from: Utah $Hdr: cdvar.h 1.1 90/07/09$
77 *
78 * @(#)cdvar.h 8.1 (Berkeley) 6/10/93
79 */
80
81 #include <sys/lock.h>
82 #include <sys/pool.h>
83 #include <sys/queue.h>
84
85 /*
86 * Dynamic configuration and disklabel support by:
87 * Jason R. Thorpe <thorpej (at) nas.nasa.gov>
88 * Numerical Aerodynamic Simulation Facility
89 * Mail Stop 258-6
90 * NASA Ames Research Center
91 * Moffett Field, CA 94035
92 */
93
94 /*
95 * This structure is used to configure a ccd via ioctl(2).
96 */
97 struct ccd_ioctl {
98 char **ccio_disks; /* pointer to component paths */
99 int ccio_ndisks; /* number of disks to concatenate */
100 int ccio_ileave; /* interleave (DEV_BSIZE blocks) */
101 int ccio_flags; /* see sc_flags below */
102 int ccio_unit; /* unit number: use varies */
103 size_t ccio_size; /* (returned) size of ccd */
104 };
105
106 /*
107 * Component info table.
108 * Describes a single component of a concatenated disk.
109 */
110 struct ccdcinfo {
111 struct vnode *ci_vp; /* device's vnode */
112 dev_t ci_dev; /* XXX: device's dev_t */
113 size_t ci_size; /* size */
114 char *ci_path; /* path to component */
115 size_t ci_pathlen; /* length of component path */
116 };
117
118 /*
119 * Interleave description table.
120 * Computed at boot time to speed irregular-interleave lookups.
121 * The idea is that we interleave in "groups". First we interleave
122 * evenly over all component disks up to the size of the smallest
123 * component (the first group), then we interleave evenly over all
124 * remaining disks up to the size of the next-smallest (second group),
125 * and so on.
126 *
127 * Each table entry describes the interleave characteristics of one
128 * of these groups. For example if a concatenated disk consisted of
129 * three components of 5, 3, and 7 DEV_BSIZE blocks interleaved at
130 * DEV_BSIZE (1), the table would have three entries:
131 *
132 * ndisk startblk startoff dev
133 * 3 0 0 0, 1, 2
134 * 2 9 3 0, 2
135 * 1 13 5 2
136 * 0 - - -
137 *
138 * which says that the first nine blocks (0-8) are interleaved over
139 * 3 disks (0, 1, 2) starting at block offset 0 on any component disk,
140 * the next 4 blocks (9-12) are interleaved over 2 disks (0, 2) starting
141 * at component block 3, and the remaining blocks (13-14) are on disk
142 * 2 starting at offset 5.
143 */
144 struct ccdiinfo {
145 int ii_ndisk; /* # of disks range is interleaved over */
146 daddr_t ii_startblk; /* starting scaled block # for range */
147 daddr_t ii_startoff; /* starting component offset (block #) */
148 int *ii_index; /* ordered list of components in range */
149 };
150
151 /*
152 * Concatenated disk pseudo-geometry information.
153 */
154 struct ccdgeom {
155 u_int32_t ccg_secsize; /* # bytes per sector */
156 u_int32_t ccg_nsectors; /* # data sectors per track */
157 u_int32_t ccg_ntracks; /* # tracks per cylinder */
158 u_int32_t ccg_ncylinders; /* # cylinders per unit */
159 };
160
161 struct ccdbuf;
162
163 /*
164 * A concatenated disk is described after initialization by this structure.
165 */
166 struct ccd_softc {
167 int sc_unit; /* logical unit number */
168 int sc_flags; /* flags */
169 size_t sc_size; /* size of ccd */
170 int sc_ileave; /* interleave */
171 int sc_nccdisks; /* number of components */
172 struct ccdcinfo *sc_cinfo; /* component info */
173 struct ccdiinfo *sc_itable; /* interleave table */
174 struct ccdgeom sc_geom; /* pseudo geometry info */
175 char sc_xname[8]; /* XXX external name */
176 struct disk sc_dkdev; /* generic disk device info */
177 struct pool sc_cbufpool; /* component buffer pool */
178 struct lock sc_lock; /* lock on this structure */
179 };
180
181 /* sc_flags */
182 #define CCDF_SWAP 0x01 /* interleave should be dmmax */
183 #define CCDF_UNIFORM 0x02 /* use LCCD of sizes for uniform interleave */
184 #define CCDF_INITED 0x10 /* unit has been initialized */
185 #define CCDF_WLABEL 0x20 /* label area is writable */
186 #define CCDF_LABELLING 0x40 /* unit is currently being labelled */
187
188 /* Mask of user-settable ccd flags. */
189 #define CCDF_USERMASK (CCDF_SWAP|CCDF_UNIFORM)
190
191 /*
192 * Before you can use a unit, it must be configured with CCDIOCSET.
193 * The configuration persists across opens and closes of the device;
194 * a CCDIOCCLR must be used to reset a configuration. An attempt to
195 * CCDIOCSET an already active unit will return EBUSY. Attempts to
196 * CCDIOCCLR an inactive unit will return ENXIO.
197 */
198 #define CCDIOCSET _IOWR('F', 16, struct ccd_ioctl) /* enable ccd */
199 #define CCDIOCCLR _IOW('F', 17, struct ccd_ioctl) /* disable ccd */
200