xref: /netbsd/sys/dev/pci/ld_twe.c (revision ddfcdc4f)
1 /*	$NetBSD: ld_twe.c,v 1.16 2003/09/22 18:31:10 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 2000, 2001, 2002, 2003 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Andrew Doran; and by Jason R. Thorpe of Wasabi Systems, Inc.
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  * 3ware "Escalade" RAID controller front-end for ld(4) driver.
41  */
42 
43 #include <sys/cdefs.h>
44 __KERNEL_RCSID(0, "$NetBSD: ld_twe.c,v 1.16 2003/09/22 18:31:10 thorpej Exp $");
45 
46 #include "rnd.h"
47 
48 #include <sys/param.h>
49 #include <sys/systm.h>
50 #include <sys/kernel.h>
51 #include <sys/device.h>
52 #include <sys/buf.h>
53 #include <sys/endian.h>
54 #include <sys/dkio.h>
55 #include <sys/disk.h>
56 #if NRND > 0
57 #include <sys/rnd.h>
58 #endif
59 
60 #include <machine/bus.h>
61 
62 #include <uvm/uvm_extern.h>
63 
64 #include <dev/ldvar.h>
65 
66 #include <dev/pci/twereg.h>
67 #include <dev/pci/twevar.h>
68 
69 struct ld_twe_softc {
70 	struct	ld_softc sc_ld;
71 	int	sc_hwunit;
72 };
73 
74 static void	ld_twe_attach(struct device *, struct device *, void *);
75 static int	ld_twe_detach(struct device *, int);
76 static int	ld_twe_dobio(struct ld_twe_softc *, void *, int, int, int,
77 			     struct buf *);
78 static int	ld_twe_dump(struct ld_softc *, void *, int, int);
79 static void	ld_twe_handler(struct twe_ccb *, int);
80 static int	ld_twe_match(struct device *, struct cfdata *, void *);
81 static int	ld_twe_start(struct ld_softc *, struct buf *);
82 
83 static void	ld_twe_adjqparam(struct device *, int);
84 
85 CFATTACH_DECL(ld_twe, sizeof(struct ld_twe_softc),
86     ld_twe_match, ld_twe_attach, ld_twe_detach, NULL);
87 
88 static const struct twe_callbacks ld_twe_callbacks = {
89 	ld_twe_adjqparam,
90 };
91 
92 static int
93 ld_twe_match(struct device *parent, struct cfdata *match, void *aux)
94 {
95 
96 	return (1);
97 }
98 
99 static void
100 ld_twe_attach(struct device *parent, struct device *self, void *aux)
101 {
102 	struct twe_attach_args *twea;
103 	struct ld_twe_softc *sc;
104 	struct ld_softc *ld;
105 	struct twe_softc *twe;
106 	struct twe_drive *td;
107 	const char *typestr, *stripestr, *statstr;
108 	char unktype[16], stripebuf[32], unkstat[32];
109 	int error;
110 	uint8_t status;
111 
112 	sc = (struct ld_twe_softc *)self;
113 	ld = &sc->sc_ld;
114 	twe = (struct twe_softc *)parent;
115 	twea = aux;
116 	td = &twe->sc_units[twea->twea_unit];
117 
118 	twe_register_callbacks(twe, twea->twea_unit, &ld_twe_callbacks);
119 
120 	sc->sc_hwunit = twea->twea_unit;
121 	ld->sc_flags = LDF_ENABLED;
122 	ld->sc_maxxfer = twe_get_maxxfer(twe_get_maxsegs());
123 	ld->sc_secperunit = td->td_size;
124 	ld->sc_secsize = TWE_SECTOR_SIZE;
125 	ld->sc_maxqueuecnt = twe->sc_openings;
126 	ld->sc_start = ld_twe_start;
127 	ld->sc_dump = ld_twe_dump;
128 
129 	typestr = twe_describe_code(twe_table_unittype, td->td_type);
130 	if (typestr == NULL) {
131 		sprintf(unktype, "<0x%02x>", td->td_type);
132 		typestr = unktype;
133 	}
134 	switch (td->td_type) {
135 	case TWE_AD_CONFIG_RAID0:
136 	/* XXX TWE_AD_CONFIG_TwinStor? */
137 	case TWE_AD_CONFIG_RAID5:
138 	case TWE_AD_CONFIG_RAID10:
139 		stripestr = twe_describe_code(twe_table_stripedepth,
140 		    td->td_stripe);
141 		if (stripestr == NULL)
142 			sprintf(stripebuf, "<stripe code 0x%02x> ",
143 			    td->td_stripe);
144 		else
145 			sprintf(stripebuf, "%s stripe ", stripestr);
146 		break;
147 	default:
148 		stripebuf[0] = '\0';
149 	}
150 
151 	error = twe_param_get_1(twe, TWE_PARAM_UNITINFO + twea->twea_unit,
152 	    TWE_PARAM_UNITINFO_Status, &status);
153 	status &= TWE_PARAM_UNITSTATUS_MASK;
154 	if (error) {
155 		sprintf(unkstat, "<unknown>");
156 		statstr = unkstat;
157 	} else if ((statstr =
158 		    twe_describe_code(twe_table_unitstate, status)) == NULL) {
159 		sprintf(unkstat, "<status code 0x%02x>", status);
160 		statstr = unkstat;
161 	}
162 
163 	printf(": %s%s, status: %s\n", stripebuf, typestr, statstr);
164 	ldattach(ld);
165 }
166 
167 static int
168 ld_twe_detach(struct device *self, int flags)
169 {
170 	int rv;
171 
172 	if ((rv = ldbegindetach((struct ld_softc *)self, flags)) != 0)
173 		return (rv);
174 	ldenddetach((struct ld_softc *)self);
175 
176 	return (0);
177 }
178 
179 static int
180 ld_twe_dobio(struct ld_twe_softc *sc, void *data, int datasize, int blkno,
181 	     int dowrite, struct buf *bp)
182 {
183 	struct twe_ccb *ccb;
184 	struct twe_cmd *tc;
185 	struct twe_softc *twe;
186 	int s, rv, flags;
187 
188 	twe = (struct twe_softc *)sc->sc_ld.sc_dv.dv_parent;
189 
190 	flags = (dowrite ? TWE_CCB_DATA_OUT : TWE_CCB_DATA_IN);
191 	if ((rv = twe_ccb_alloc(twe, &ccb, flags)) != 0)
192 		return (rv);
193 
194 	ccb->ccb_data = data;
195 	ccb->ccb_datasize = datasize;
196 	tc = ccb->ccb_cmd;
197 
198 	/* Build the command. */
199 	tc->tc_size = 3;
200 	tc->tc_unit = sc->sc_hwunit;
201 	tc->tc_count = htole16(datasize / TWE_SECTOR_SIZE);
202 	tc->tc_args.io.lba = htole32(blkno);
203 
204 	if (dowrite)
205 		tc->tc_opcode = TWE_OP_WRITE | (tc->tc_size << 5);
206 	else
207 		tc->tc_opcode = TWE_OP_READ | (tc->tc_size << 5);
208 
209 	/* Map the data transfer. */
210 	if ((rv = twe_ccb_map(twe, ccb)) != 0) {
211 		twe_ccb_free(twe, ccb);
212 		return (rv);
213 	}
214 
215 	if (bp == NULL) {
216 		/*
217 		 * Polled commands must not sit on the software queue.  Wait
218 		 * up to 2 seconds for the command to complete.
219 		 */
220 		s = splbio();
221 		rv = twe_ccb_poll(twe, ccb, 2000);
222 		twe_ccb_unmap(twe, ccb);
223 		twe_ccb_free(twe, ccb);
224 		splx(s);
225 	} else {
226 		ccb->ccb_tx.tx_handler = ld_twe_handler;
227 		ccb->ccb_tx.tx_context = bp;
228 		ccb->ccb_tx.tx_dv = (struct device *)sc;
229 		twe_ccb_enqueue(twe, ccb);
230 		rv = 0;
231 	}
232 
233 	return (rv);
234 }
235 
236 static int
237 ld_twe_start(struct ld_softc *ld, struct buf *bp)
238 {
239 
240 	return (ld_twe_dobio((struct ld_twe_softc *)ld, bp->b_data,
241 	    bp->b_bcount, bp->b_rawblkno, (bp->b_flags & B_READ) == 0, bp));
242 }
243 
244 static void
245 ld_twe_handler(struct twe_ccb *ccb, int error)
246 {
247 	struct buf *bp;
248 	struct twe_context *tx;
249 	struct ld_twe_softc *sc;
250 	struct twe_softc *twe;
251 
252 	tx = &ccb->ccb_tx;
253 	bp = tx->tx_context;
254 	sc = (struct ld_twe_softc *)tx->tx_dv;
255 	twe = (struct twe_softc *)sc->sc_ld.sc_dv.dv_parent;
256 
257 	twe_ccb_unmap(twe, ccb);
258 	twe_ccb_free(twe, ccb);
259 
260 	if (error) {
261 		bp->b_flags |= B_ERROR;
262 		bp->b_error = error;
263 		bp->b_resid = bp->b_bcount;
264 	} else
265 		bp->b_resid = 0;
266 
267 	lddone(&sc->sc_ld, bp);
268 }
269 
270 static int
271 ld_twe_dump(struct ld_softc *ld, void *data, int blkno, int blkcnt)
272 {
273 
274 	return (ld_twe_dobio((struct ld_twe_softc *)ld, data,
275 	    blkcnt * ld->sc_secsize, blkno, 1, NULL));
276 }
277 
278 static void
279 ld_twe_adjqparam(struct device *self, int openings)
280 {
281 
282 	ldadjqparam((struct ld_softc *)self, openings);
283 }
284