xref: /netbsd-src/sys/dev/pci/twa.c (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1 /*	$NetBSD: twa.c,v 1.58 2019/11/10 21:16:36 chs Exp $ */
2 /*	$wasabi: twa.c,v 1.27 2006/07/28 18:17:21 wrstuden Exp $	*/
3 
4 /*-
5  * Copyright (c) 2004 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Jordan Rhody of Wasabi Systems, Inc.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*-
34  * Copyright (c) 2003-04 3ware, Inc.
35  * Copyright (c) 2000 Michael Smith
36  * Copyright (c) 2000 BSDi
37  * All rights reserved.
38  *
39  * Redistribution and use in source and binary forms, with or without
40  * modification, are permitted provided that the following conditions
41  * are met:
42  * 1. Redistributions of source code must retain the above copyright
43  *    notice, this list of conditions and the following disclaimer.
44  * 2. Redistributions in binary form must reproduce the above copyright
45  *    notice, this list of conditions and the following disclaimer in the
46  *    documentation and/or other materials provided with the distribution.
47  *
48  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58  * SUCH DAMAGE.
59  *
60  *	$FreeBSD: src/sys/dev/twa/twa.c,v 1.2 2004/04/02 15:09:57 des Exp $
61  */
62 
63 /*
64  * 3ware driver for 9000 series storage controllers.
65  *
66  * Author: Vinod Kashyap
67  */
68 
69 #include <sys/cdefs.h>
70 __KERNEL_RCSID(0, "$NetBSD: twa.c,v 1.58 2019/11/10 21:16:36 chs Exp $");
71 
72 //#define TWA_DEBUG
73 
74 #include <sys/param.h>
75 #include <sys/systm.h>
76 #include <sys/kernel.h>
77 #include <sys/device.h>
78 #include <sys/queue.h>
79 #include <sys/proc.h>
80 #include <sys/bswap.h>
81 #include <sys/buf.h>
82 #include <sys/bufq.h>
83 #include <sys/endian.h>
84 #include <sys/malloc.h>
85 #include <sys/conf.h>
86 #include <sys/disk.h>
87 #include <sys/sysctl.h>
88 #include <sys/syslog.h>
89 #include <sys/module.h>
90 #include <sys/bus.h>
91 
92 #include <dev/pci/pcireg.h>
93 #include <dev/pci/pcivar.h>
94 #include <dev/pci/pcidevs.h>
95 #include <dev/pci/twareg.h>
96 #include <dev/pci/twavar.h>
97 #include <dev/pci/twaio.h>
98 
99 #include <dev/scsipi/scsipi_all.h>
100 #include <dev/scsipi/scsipi_disk.h>
101 #include <dev/scsipi/scsipiconf.h>
102 #include <dev/scsipi/scsi_spc.h>
103 
104 #include <dev/ldvar.h>
105 
106 #include "locators.h"
107 #include "ioconf.h"
108 
109 #define	PCI_CBIO	0x10
110 
111 static int	twa_fetch_aen(struct twa_softc *);
112 static void	twa_aen_callback(struct twa_request *);
113 static int	twa_find_aen(struct twa_softc *sc, uint16_t);
114 static uint16_t	twa_enqueue_aen(struct twa_softc *sc,
115 			struct twa_command_header *);
116 
117 static void	twa_attach(device_t, device_t, void *);
118 static int	twa_request_bus_scan(device_t, const char *, const int *);
119 static void	twa_shutdown(void *);
120 static int	twa_init_connection(struct twa_softc *, uint16_t, uint32_t,
121 					uint16_t, uint16_t, uint16_t, uint16_t,
122 					uint16_t *, uint16_t *, uint16_t *,
123 					uint16_t *, uint32_t *);
124 static int	twa_intr(void *);
125 static int 	twa_match(device_t, cfdata_t, void *);
126 static int	twa_reset(struct twa_softc *);
127 
128 static int	twa_print(void *, const char *);
129 static int	twa_soft_reset(struct twa_softc *);
130 
131 static int	twa_check_ctlr_state(struct twa_softc *, uint32_t);
132 static int	twa_get_param(struct twa_softc *, int, int, size_t,
133 				void (* callback)(struct twa_request *),
134 				struct twa_param_9k **);
135 static int 	twa_set_param(struct twa_softc *, int, int, int, void *,
136 				void (* callback)(struct twa_request *));
137 static void	twa_describe_controller(struct twa_softc *);
138 static int	twa_wait_status(struct twa_softc *, uint32_t, uint32_t);
139 static int	twa_done(struct twa_softc *);
140 
141 extern struct	cfdriver twa_cd;
142 extern uint32_t twa_fw_img_size;
143 extern uint8_t	twa_fw_img[];
144 
145 CFATTACH_DECL3_NEW(twa, sizeof(struct twa_softc),
146     twa_match, twa_attach, NULL, NULL, twa_request_bus_scan, NULL, 0);
147 
148 /* FreeBSD driver revision for sysctl expected by the 3ware cli */
149 const char twaver[] = "1.50.01.002";
150 
151 /* AEN messages. */
152 static const struct twa_message	twa_aen_table[] = {
153 	{0x0000, "AEN queue empty"},
154 	{0x0001, "Controller reset occurred"},
155 	{0x0002, "Degraded unit detected"},
156 	{0x0003, "Controller error occured"},
157 	{0x0004, "Background rebuild failed"},
158 	{0x0005, "Background rebuild done"},
159 	{0x0006, "Incomplete unit detected"},
160 	{0x0007, "Background initialize done"},
161 	{0x0008, "Unclean shutdown detected"},
162 	{0x0009, "Drive timeout detected"},
163 	{0x000A, "Drive error detected"},
164 	{0x000B, "Rebuild started"},
165 	{0x000C, "Background initialize started"},
166 	{0x000D, "Entire logical unit was deleted"},
167 	{0x000E, "Background initialize failed"},
168 	{0x000F, "SMART attribute exceeded threshold"},
169 	{0x0010, "Power supply reported AC under range"},
170 	{0x0011, "Power supply reported DC out of range"},
171 	{0x0012, "Power supply reported a malfunction"},
172 	{0x0013, "Power supply predicted malfunction"},
173 	{0x0014, "Battery charge is below threshold"},
174 	{0x0015, "Fan speed is below threshold"},
175 	{0x0016, "Temperature sensor is above threshold"},
176 	{0x0017, "Power supply was removed"},
177 	{0x0018, "Power supply was inserted"},
178 	{0x0019, "Drive was removed from a bay"},
179 	{0x001A, "Drive was inserted into a bay"},
180 	{0x001B, "Drive bay cover door was opened"},
181 	{0x001C, "Drive bay cover door was closed"},
182 	{0x001D, "Product case was opened"},
183 	{0x0020, "Prepare for shutdown (power-off)"},
184 	{0x0021, "Downgrade UDMA mode to lower speed"},
185 	{0x0022, "Upgrade UDMA mode to higher speed"},
186 	{0x0023, "Sector repair completed"},
187 	{0x0024, "Sbuf memory test failed"},
188 	{0x0025, "Error flushing cached write data to disk"},
189 	{0x0026, "Drive reported data ECC error"},
190 	{0x0027, "DCB has checksum error"},
191 	{0x0028, "DCB version is unsupported"},
192 	{0x0029, "Background verify started"},
193 	{0x002A, "Background verify failed"},
194 	{0x002B, "Background verify done"},
195 	{0x002C, "Bad sector overwritten during rebuild"},
196 	{0x002D, "Source drive error occurred"},
197 	{0x002E, "Replace failed because replacement drive too small"},
198 	{0x002F, "Verify failed because array was never initialized"},
199 	{0x0030, "Unsupported ATA drive"},
200 	{0x0031, "Synchronize host/controller time"},
201 	{0x0032, "Spare capacity is inadequate for some units"},
202 	{0x0033, "Background migration started"},
203 	{0x0034, "Background migration failed"},
204 	{0x0035, "Background migration done"},
205 	{0x0036, "Verify detected and fixed data/parity mismatch"},
206 	{0x0037, "SO-DIMM incompatible"},
207 	{0x0038, "SO-DIMM not detected"},
208 	{0x0039, "Corrected Sbuf ECC error"},
209 	{0x003A, "Drive power on reset detected"},
210 	{0x003B, "Background rebuild paused"},
211 	{0x003C, "Background initialize paused"},
212 	{0x003D, "Background verify paused"},
213 	{0x003E, "Background migration paused"},
214 	{0x003F, "Corrupt flash file system detected"},
215 	{0x0040, "Flash file system repaired"},
216 	{0x0041, "Unit number assignments were lost"},
217 	{0x0042, "Error during read of primary DCB"},
218 	{0x0043, "Latent error found in backup DCB"},
219 	{0x0044, "Battery voltage is normal"},
220 	{0x0045, "Battery voltage is low"},
221 	{0x0046, "Battery voltage is high"},
222 	{0x0047, "Battery voltage is too low"},
223 	{0x0048, "Battery voltage is too high"},
224 	{0x0049, "Battery temperature is normal"},
225 	{0x004A, "Battery temperature is low"},
226 	{0x004B, "Battery temperature is high"},
227 	{0x004C, "Battery temperature is too low"},
228 	{0x004D, "Battery temperature is too high"},
229 	{0x004E, "Battery capacity test started"},
230 	{0x004F, "Cache synchronization skipped"},
231 	{0x0050, "Battery capacity test completed"},
232 	{0x0051, "Battery health check started"},
233 	{0x0052, "Battery health check completed"},
234 	{0x0053, "Battery capacity test needed"},
235 	{0x0054, "Battery charge termination voltage is at high level"},
236 	{0x0055, "Battery charging started"},
237 	{0x0056, "Battery charging completed"},
238 	{0x0057, "Battery charging fault"},
239 	{0x0058, "Battery capacity is below warning level"},
240 	{0x0059, "Battery capacity is below error level"},
241 	{0x005A, "Battery is present"},
242 	{0x005B, "Battery is not present"},
243 	{0x005C, "Battery is weak"},
244 	{0x005D, "Battery health check failed"},
245 	{0x005E, "Cache synchronized after power fail"},
246 	{0x005F, "Cache synchronization failed; some data lost"},
247 	{0x0060, "Bad cache meta data checksum"},
248 	{0x0061, "Bad cache meta data signature"},
249 	{0x0062, "Cache meta data restore failed"},
250 	{0x0063, "BBU not found after power fail"},
251 	{0x00FC, "Recovered/finished array membership update"},
252 	{0x00FD, "Handler lockup"},
253 	{0x00FE, "Retrying PCI transfer"},
254 	{0x00FF, "AEN queue is full"},
255 	{0xFFFFFFFF, NULL}
256 };
257 
258 /* AEN severity table. */
259 static const char	*twa_aen_severity_table[] = {
260 	"None",
261 	"ERROR",
262 	"WARNING",
263 	"INFO",
264 	"DEBUG",
265 	NULL
266 };
267 
268 #if 0
269 /* Error messages. */
270 static const struct twa_message	twa_error_table[] = {
271 	{0x0100, "SGL entry contains zero data"},
272 	{0x0101, "Invalid command opcode"},
273 	{0x0102, "SGL entry has unaligned address"},
274 	{0x0103, "SGL size does not match command"},
275 	{0x0104, "SGL entry has illegal length"},
276 	{0x0105, "Command packet is not aligned"},
277 	{0x0106, "Invalid request ID"},
278 	{0x0107, "Duplicate request ID"},
279 	{0x0108, "ID not locked"},
280 	{0x0109, "LBA out of range"},
281 	{0x010A, "Logical unit not supported"},
282 	{0x010B, "Parameter table does not exist"},
283 	{0x010C, "Parameter index does not exist"},
284 	{0x010D, "Invalid field in CDB"},
285 	{0x010E, "Specified port has invalid drive"},
286 	{0x010F, "Parameter item size mismatch"},
287 	{0x0110, "Failed memory allocation"},
288 	{0x0111, "Memory request too large"},
289 	{0x0112, "Out of memory segments"},
290 	{0x0113, "Invalid address to deallocate"},
291 	{0x0114, "Out of memory"},
292 	{0x0115, "Out of heap"},
293 	{0x0120, "Double degrade"},
294 	{0x0121, "Drive not degraded"},
295 	{0x0122, "Reconstruct error"},
296 	{0x0123, "Replace not accepted"},
297 	{0x0124, "Replace drive capacity too small"},
298 	{0x0125, "Sector count not allowed"},
299 	{0x0126, "No spares left"},
300 	{0x0127, "Reconstruct error"},
301 	{0x0128, "Unit is offline"},
302 	{0x0129, "Cannot update status to DCB"},
303 	{0x0130, "Invalid stripe handle"},
304 	{0x0131, "Handle that was not locked"},
305 	{0x0132, "Handle that was not empy"},
306 	{0x0133, "Handle has different owner"},
307 	{0x0140, "IPR has parent"},
308 	{0x0150, "Illegal Pbuf address alignment"},
309 	{0x0151, "Illegal Pbuf transfer length"},
310 	{0x0152, "Illegal Sbuf address alignment"},
311 	{0x0153, "Illegal Sbuf transfer length"},
312 	{0x0160, "Command packet too large"},
313 	{0x0161, "SGL exceeds maximum length"},
314 	{0x0162, "SGL has too many entries"},
315 	{0x0170, "Insufficient resources for rebuilder"},
316 	{0x0171, "Verify error (data != parity)"},
317 	{0x0180, "Requested segment not in directory of this DCB"},
318 	{0x0181, "DCB segment has unsupported version"},
319 	{0x0182, "DCB segment has checksum error"},
320 	{0x0183, "DCB support (settings) segment invalid"},
321 	{0x0184, "DCB UDB (unit descriptor block) segment invalid"},
322 	{0x0185, "DCB GUID (globally unique identifier) segment invalid"},
323 	{0x01A0, "Could not clear Sbuf"},
324 	{0x01C0, "Flash identify failed"},
325 	{0x01C1, "Flash out of bounds"},
326 	{0x01C2, "Flash verify error"},
327 	{0x01C3, "Flash file object not found"},
328 	{0x01C4, "Flash file already present"},
329 	{0x01C5, "Flash file system full"},
330 	{0x01C6, "Flash file not present"},
331 	{0x01C7, "Flash file size error"},
332 	{0x01C8, "Bad flash file checksum"},
333 	{0x01CA, "Corrupt flash file system detected"},
334 	{0x01D0, "Invalid field in parameter list"},
335 	{0x01D1, "Parameter list length error"},
336 	{0x01D2, "Parameter item is not changeable"},
337 	{0x01D3, "Parameter item is not saveable"},
338 	{0x0200, "UDMA CRC error"},
339 	{0x0201, "Internal CRC error"},
340 	{0x0202, "Data ECC error"},
341 	{0x0203, "ADP level 1 error"},
342 	{0x0204, "Port timeout"},
343 	{0x0205, "Drive power on reset"},
344 	{0x0206, "ADP level 2 error"},
345 	{0x0207, "Soft reset failed"},
346 	{0x0208, "Drive not ready"},
347 	{0x0209, "Unclassified port error"},
348 	{0x020A, "Drive aborted command"},
349 	{0x0210, "Internal CRC error"},
350 	{0x0211, "Host PCI bus abort"},
351 	{0x0212, "Host PCI parity error"},
352 	{0x0213, "Port handler error"},
353 	{0x0214, "Token interrupt count error"},
354 	{0x0215, "Timeout waiting for PCI transfer"},
355 	{0x0216, "Corrected buffer ECC"},
356 	{0x0217, "Uncorrected buffer ECC"},
357 	{0x0230, "Unsupported command during flash recovery"},
358 	{0x0231, "Next image buffer expected"},
359 	{0x0232, "Binary image architecture incompatible"},
360 	{0x0233, "Binary image has no signature"},
361 	{0x0234, "Binary image has bad checksum"},
362 	{0x0235, "Image downloaded overflowed buffer"},
363 	{0x0240, "I2C device not found"},
364 	{0x0241, "I2C transaction aborted"},
365 	{0x0242, "SO-DIMM parameter(s) incompatible using defaults"},
366 	{0x0243, "SO-DIMM unsupported"},
367 	{0x0248, "SPI transfer status error"},
368 	{0x0249, "SPI transfer timeout error"},
369 	{0x0250, "Invalid unit descriptor size in CreateUnit"},
370 	{0x0251, "Unit descriptor size exceeds data buffer in CreateUnit"},
371 	{0x0252, "Invalid value in CreateUnit descriptor"},
372 	{0x0253, "Inadequate disk space to support descriptor in CreateUnit"},
373 	{0x0254, "Unable to create data channel for this unit descriptor"},
374 	{0x0255, "CreateUnit descriptor specifies a drive already in use"},
375 	{0x0256, "Unable to write configuration to all disks during CreateUnit"},
376 	{0x0257, "CreateUnit does not support this descriptor version"},
377 	{0x0258, "Invalid subunit for RAID 0 or 5 in CreateUnit"},
378 	{0x0259, "Too many descriptors in CreateUnit"},
379 	{0x025A, "Invalid configuration specified in CreateUnit descriptor"},
380 	{0x025B, "Invalid LBA offset specified in CreateUnit descriptor"},
381 	{0x025C, "Invalid stripelet size specified in CreateUnit descriptor"},
382 	{0x0260, "SMART attribute exceeded threshold"},
383 	{0xFFFFFFFF, NULL}
384 };
385 #endif
386 
387 struct twa_pci_identity {
388 	uint32_t	vendor_id;
389 	uint32_t	product_id;
390 	const char	*name;
391 };
392 
393 static const struct twa_pci_identity twa_pci_products[] = {
394 	{ PCI_VENDOR_3WARE,
395 	  PCI_PRODUCT_3WARE_9000,
396 	  "3ware 9000 series",
397 	},
398 	{ PCI_VENDOR_3WARE,
399 	  PCI_PRODUCT_3WARE_9550,
400 	  "3ware 9550SX series",
401 	},
402 	{ PCI_VENDOR_3WARE,
403 	  PCI_PRODUCT_3WARE_9650,
404 	  "3ware 9650SE series",
405 	},
406 	{ PCI_VENDOR_3WARE,
407 	  PCI_PRODUCT_3WARE_9690,
408 	  "3ware 9690 series",
409 	},
410 	{ 0,
411 	  0,
412 	  NULL,
413 	},
414 };
415 
416 
417 static inline void
418 twa_outl(struct twa_softc *sc, int off, uint32_t val)
419 {
420 
421 	bus_space_write_4(sc->twa_bus_iot, sc->twa_bus_ioh, off, val);
422 	bus_space_barrier(sc->twa_bus_iot, sc->twa_bus_ioh, off, 4,
423 	    BUS_SPACE_BARRIER_WRITE);
424 }
425 
426 static inline uint32_t	twa_inl(struct twa_softc *sc, int off)
427 {
428 
429 	bus_space_barrier(sc->twa_bus_iot, sc->twa_bus_ioh, off, 4,
430 	    BUS_SPACE_BARRIER_WRITE | BUS_SPACE_BARRIER_READ);
431 	return (bus_space_read_4(sc->twa_bus_iot, sc->twa_bus_ioh, off));
432 }
433 
434 void
435 twa_request_wait_handler(struct twa_request *tr)
436 {
437 
438 	wakeup(tr);
439 }
440 
441 static const struct twa_pci_identity *
442 twa_lookup(pcireg_t id)
443 {
444 	const struct twa_pci_identity *entry;
445 	int i;
446 
447 	for (i = 0; i < __arraycount(twa_pci_products); i++) {
448 		entry = &twa_pci_products[i];
449 		if (entry->vendor_id == PCI_VENDOR(id) &&
450 		    entry->product_id == PCI_PRODUCT(id)) {
451 			return entry;
452 		}
453 	}
454 	return NULL;
455 }
456 
457 static int
458 twa_match(device_t parent, cfdata_t cfdata, void *aux)
459 {
460 	struct pci_attach_args *pa = aux;
461 	const struct twa_pci_identity *entry;
462 
463 	entry = twa_lookup(pa->pa_id);
464 	if (entry != NULL) {
465 		return 1;
466 	}
467 	return (0);
468 }
469 
470 static const char *
471 twa_find_msg_string(const struct twa_message *table, uint16_t code)
472 {
473 	int	i;
474 
475 	for (i = 0; table[i].message != NULL; i++)
476 		if (table[i].code == code)
477 			return(table[i].message);
478 
479 	return(table[i].message);
480 }
481 
482 void
483 twa_release_request(struct twa_request *tr)
484 {
485 	int s;
486 	struct twa_softc *sc;
487 
488 	sc = tr->tr_sc;
489 
490 	if ((tr->tr_flags & TWA_CMD_AEN) == 0) {
491 		s = splbio();
492 		TAILQ_INSERT_TAIL(&tr->tr_sc->twa_free, tr, tr_link);
493 		splx(s);
494 		if (__predict_false((tr->tr_sc->twa_sc_flags &
495 		    TWA_STATE_REQUEST_WAIT) != 0)) {
496 			tr->tr_sc->twa_sc_flags &= ~TWA_STATE_REQUEST_WAIT;
497 			wakeup(&sc->twa_free);
498 		}
499 	} else
500 		tr->tr_flags &= ~TWA_CMD_AEN_BUSY;
501 }
502 
503 static void
504 twa_unmap_request(struct twa_request *tr)
505 {
506 	struct twa_softc	*sc = tr->tr_sc;
507 	uint8_t			cmd_status;
508 	int s;
509 
510 	/* If the command involved data, unmap that too. */
511 	if (tr->tr_data != NULL) {
512 		if (tr->tr_cmd_pkt_type & TWA_CMD_PKT_TYPE_9K)
513 			cmd_status = tr->tr_command->command.cmd_pkt_9k.status;
514 		else
515 			cmd_status =
516 			      tr->tr_command->command.cmd_pkt_7k.generic.status;
517 
518 		if (tr->tr_flags & TWA_CMD_DATA_OUT) {
519 			bus_dmamap_sync(tr->tr_sc->twa_dma_tag, tr->tr_dma_map,
520 				0, tr->tr_length, BUS_DMASYNC_POSTREAD);
521 			/*
522 			 * If we are using a bounce buffer, and we are reading
523 			 * data, copy the real data in.
524 			 */
525 			if (tr->tr_flags & TWA_CMD_DATA_COPY_NEEDED)
526 				if (cmd_status == 0)
527 					memcpy(tr->tr_real_data, tr->tr_data,
528 						tr->tr_real_length);
529 		}
530 		if (tr->tr_flags & TWA_CMD_DATA_IN)
531 			bus_dmamap_sync(tr->tr_sc->twa_dma_tag, tr->tr_dma_map,
532 				0, tr->tr_length, BUS_DMASYNC_POSTWRITE);
533 
534 		bus_dmamap_unload(sc->twa_dma_tag, tr->tr_dma_map);
535 	}
536 
537 	/* Free alignment buffer if it was used. */
538 	if (tr->tr_flags & TWA_CMD_DATA_COPY_NEEDED) {
539 		s = splvm();
540 		uvm_km_kmem_free(kmem_va_arena, (vaddr_t)tr->tr_data,
541 		    tr->tr_length);
542 		splx(s);
543 		tr->tr_data = tr->tr_real_data;
544 		tr->tr_length = tr->tr_real_length;
545 	}
546 }
547 
548 /*
549  * Function name:	twa_wait_request
550  * Description:		Sends down a firmware cmd, and waits for the completion,
551  *			but NOT in a tight loop.
552  *
553  * Input:		tr	-- ptr to request pkt
554  *			timeout -- max # of seconds to wait before giving up
555  * Output:		None
556  * Return value:	0	-- success
557  *			non-zero-- failure
558  */
559 static int
560 twa_wait_request(struct twa_request *tr, uint32_t timeout)
561 {
562 	time_t	end_time;
563 	struct timeval	t1;
564 	int	s, rv;
565 
566 	tr->tr_flags |= TWA_CMD_SLEEP_ON_REQUEST;
567 	tr->tr_callback = twa_request_wait_handler;
568 	tr->tr_status = TWA_CMD_BUSY;
569 
570 	rv = twa_map_request(tr);
571 
572 	if (rv != 0)
573 		return (rv);
574 
575 	microtime(&t1);
576 	end_time = t1.tv_usec +
577 		(timeout * 1000 * 100);
578 
579 	while (tr->tr_status != TWA_CMD_COMPLETE) {
580 		rv = tr->tr_error;
581 		if (rv != 0)
582 			return(rv);
583 		if ((rv = tsleep(tr, PRIBIO, "twawait", timeout * hz)) == 0)
584 			break;
585 
586 		if (rv == EWOULDBLOCK) {
587 			/*
588 			 * We will reset the controller only if the request has
589 			 * already been submitted, so as to not lose the
590 			 * request packet.  If a busy request timed out, the
591 			 * reset will take care of freeing resources.  If a
592 			 * pending request timed out, we will free resources
593 			 * for that request, right here.  So, the caller is
594 			 * expected to NOT cleanup when ETIMEDOUT is returned.
595 			 */
596 			if (tr->tr_status == TWA_CMD_BUSY)
597 				twa_reset(tr->tr_sc);
598 			else {
599 				/* Request was never submitted.  Clean up. */
600 				s = splbio();
601 				TAILQ_REMOVE(&tr->tr_sc->twa_pending, tr,
602 				    tr_link);
603 				splx(s);
604 
605 				twa_unmap_request(tr);
606 				if (tr->tr_data)
607 					free(tr->tr_data, M_DEVBUF);
608 
609 				twa_release_request(tr);
610 			}
611 			return(ETIMEDOUT);
612 		}
613 		/*
614 		 * Either the request got completed, or we were woken up by a
615 		 * signal. Calculate the new timeout, in case it was the
616 		 * latter.
617 		 */
618 		microtime(&t1);
619 
620 		timeout = (end_time - t1.tv_usec) / (1000 * 100);
621 	}
622 	return(rv);
623 }
624 
625 /*
626  * Function name:	twa_immediate_request
627  * Description:		Sends down a firmware cmd, and waits for the completion
628  *			in a tight loop.
629  *
630  * Input:		tr	-- ptr to request pkt
631  *			timeout -- max # of seconds to wait before giving up
632  * Output:		None
633  * Return value:	0	-- success
634  *			non-zero-- failure
635  */
636 static int
637 twa_immediate_request(struct twa_request *tr, uint32_t timeout)
638 {
639 	struct timeval t1;
640 	int	s = 0, rv = 0;
641 
642 	rv = twa_map_request(tr);
643 
644 	if (rv != 0)
645 		return(rv);
646 
647 	timeout = (timeout * 10000 * 10);
648 
649 	microtime(&t1);
650 
651 	timeout += t1.tv_usec;
652 
653 	do {
654 		rv = tr->tr_error;
655 		if (rv != 0)
656 			return(rv);
657 		s = splbio();
658 		twa_done(tr->tr_sc);
659 		splx(s);
660 		if (tr->tr_status == TWA_CMD_COMPLETE)
661 			return(rv);
662 		microtime(&t1);
663 	} while (t1.tv_usec <= timeout);
664 
665 	/*
666 	 * We will reset the controller only if the request has
667 	 * already been submitted, so as to not lose the
668 	 * request packet.  If a busy request timed out, the
669 	 * reset will take care of freeing resources.  If a
670 	 * pending request timed out, we will free resources
671 	 * for that request, right here.  So, the caller is
672 	 * expected to NOT cleanup when ETIMEDOUT is returned.
673 	 */
674 	rv = ETIMEDOUT;
675 
676 	if (tr->tr_status == TWA_CMD_BUSY)
677 		twa_reset(tr->tr_sc);
678 	else {
679 		/* Request was never submitted.  Clean up. */
680 		s = splbio();
681 		TAILQ_REMOVE(&tr->tr_sc->twa_pending, tr, tr_link);
682 		splx(s);
683 		twa_unmap_request(tr);
684 		if (tr->tr_data)
685 			free(tr->tr_data, M_DEVBUF);
686 
687 		twa_release_request(tr);
688 	}
689 	return (rv);
690 }
691 
692 static int
693 twa_inquiry(struct twa_request *tr, int lunid)
694 {
695 	int error;
696 	struct twa_command_9k *tr_9k_cmd;
697 
698 	if (tr->tr_data == NULL)
699 		return (ENOMEM);
700 
701 	memset(tr->tr_data, 0, TWA_SECTOR_SIZE);
702 
703 	tr->tr_length = TWA_SECTOR_SIZE;
704 	tr->tr_cmd_pkt_type = TWA_CMD_PKT_TYPE_9K;
705 	tr->tr_flags |= TWA_CMD_DATA_IN | TWA_CMD_DATA_OUT;
706 
707 	tr_9k_cmd = &tr->tr_command->command.cmd_pkt_9k;
708 
709 	tr_9k_cmd->command.opcode = TWA_OP_EXECUTE_SCSI_COMMAND;
710 	tr_9k_cmd->unit = lunid;
711 	tr_9k_cmd->request_id = tr->tr_request_id;
712 	tr_9k_cmd->status = 0;
713 	tr_9k_cmd->sgl_offset = 16;
714 	tr_9k_cmd->sgl_entries = 1;
715 	/* create the CDB here */
716 	tr_9k_cmd->cdb[0] = INQUIRY;
717 	tr_9k_cmd->cdb[1] = ((lunid << 5) & 0x0e);
718 	tr_9k_cmd->cdb[4] = 255;
719 
720 	/* XXXX setup page data no lun device
721 	 * it seems 9000 series does not indicate
722 	 * NOTPRESENT - need more investigation
723 	 */
724 	((struct scsipi_inquiry_data *)tr->tr_data)->device =
725 		SID_QUAL_LU_NOTPRESENT;
726 
727 	error = twa_immediate_request(tr, TWA_REQUEST_TIMEOUT_PERIOD);
728 	if (error != 0)
729 		return (error);
730 
731 	if (((struct scsipi_inquiry_data *)tr->tr_data)->device ==
732 		SID_QUAL_LU_NOTPRESENT)
733 		error = 1;
734 
735 	return (error);
736 }
737 
738 static int
739 twa_print_inquiry_data(struct twa_softc *sc, struct scsipi_inquiry_data *scsipi)
740 {
741 
742     printf("%s: %s\n", device_xname(sc->twa_dv), scsipi->vendor);
743 
744     return (1);
745 }
746 
747 
748 static uint64_t
749 twa_read_capacity(struct twa_request *tr, int lunid)
750 {
751 	int error;
752 	struct twa_command_9k *tr_9k_cmd;
753 	uint64_t array_size = 0LL;
754 
755 	if (tr->tr_data == NULL)
756 		return (ENOMEM);
757 
758 	memset(tr->tr_data, 0, TWA_SECTOR_SIZE);
759 
760 	tr->tr_length = TWA_SECTOR_SIZE;
761 	tr->tr_cmd_pkt_type = TWA_CMD_PKT_TYPE_9K;
762 	tr->tr_flags |= TWA_CMD_DATA_OUT;
763 
764 	tr_9k_cmd = &tr->tr_command->command.cmd_pkt_9k;
765 
766 	tr_9k_cmd->command.opcode = TWA_OP_EXECUTE_SCSI_COMMAND;
767 	tr_9k_cmd->unit = lunid;
768 	tr_9k_cmd->request_id = tr->tr_request_id;
769 	tr_9k_cmd->status = 0;
770 	tr_9k_cmd->sgl_offset = 16;
771 	tr_9k_cmd->sgl_entries = 1;
772 	/* create the CDB here */
773 	tr_9k_cmd->cdb[0] = READ_CAPACITY_16;
774 	tr_9k_cmd->cdb[1] = ((lunid << 5) & 0x0e) | SRC16_SERVICE_ACTION;
775 
776 	error = twa_immediate_request(tr, TWA_REQUEST_TIMEOUT_PERIOD);
777 
778 	if (error == 0) {
779 #if BYTE_ORDER == BIG_ENDIAN
780 		array_size = bswap64(_8btol(
781 		    ((struct scsipi_read_capacity_16_data *)tr->tr_data)->addr) + 1);
782 #else
783 		array_size = _8btol(((struct scsipi_read_capacity_16_data *)
784 				tr->tr_data)->addr) + 1;
785 #endif
786 	}
787 	return (array_size);
788 }
789 
790 static int
791 twa_request_sense(struct twa_request *tr, int lunid)
792 {
793 	int error = 1;
794 	struct twa_command_9k *tr_9k_cmd;
795 
796 	if (tr->tr_data == NULL)
797 		return (error);
798 
799 	memset(tr->tr_data, 0, TWA_SECTOR_SIZE);
800 
801 	tr->tr_length = TWA_SECTOR_SIZE;
802 	tr->tr_cmd_pkt_type = TWA_CMD_PKT_TYPE_9K;
803 	tr->tr_flags |= TWA_CMD_DATA_OUT;
804 
805 	tr_9k_cmd = &tr->tr_command->command.cmd_pkt_9k;
806 
807 	tr_9k_cmd->command.opcode = TWA_OP_EXECUTE_SCSI_COMMAND;
808 	tr_9k_cmd->unit = lunid;
809 	tr_9k_cmd->request_id = tr->tr_request_id;
810 	tr_9k_cmd->status = 0;
811 	tr_9k_cmd->sgl_offset = 16;
812 	tr_9k_cmd->sgl_entries = 1;
813 	/* create the CDB here */
814 	tr_9k_cmd->cdb[0] = SCSI_REQUEST_SENSE;
815 	tr_9k_cmd->cdb[1] = ((lunid << 5) & 0x0e);
816 	tr_9k_cmd->cdb[4] = 255;
817 
818 	/*XXX AEN notification called in interrupt context
819 	 * so just queue the request. Return as quickly
820 	 * as possible from interrupt
821 	 */
822 	if ((tr->tr_flags & TWA_CMD_AEN) != 0)
823 		error = twa_map_request(tr);
824  	else
825 		error = twa_immediate_request(tr, TWA_REQUEST_TIMEOUT_PERIOD);
826 
827 	return (error);
828 }
829 
830 static int
831 twa_alloc_req_pkts(struct twa_softc *sc, int num_reqs)
832 {
833 	struct twa_request	*tr;
834 	struct twa_command_packet *tc;
835 	bus_dma_segment_t	seg;
836 	size_t max_segs, max_xfer;
837 	int	i, rv, rseg, size;
838 
839 	sc->sc_units = malloc(sc->sc_nunits *
840 	    sizeof(struct twa_drive), M_DEVBUF, M_WAITOK | M_ZERO);
841 	sc->twa_req_buf = malloc(num_reqs * sizeof(struct twa_request),
842 	    M_DEVBUF, M_WAITOK);
843 
844 	size = num_reqs * sizeof(struct twa_command_packet);
845 
846 	/* Allocate memory for cmd pkts. */
847 	if ((rv = bus_dmamem_alloc(sc->twa_dma_tag,
848 		size, PAGE_SIZE, 0, &seg,
849 		1, &rseg, BUS_DMA_NOWAIT)) != 0){
850 			aprint_error_dev(sc->twa_dv, "unable to allocate "
851 				"command packets, rv = %d\n", rv);
852 			return (ENOMEM);
853 	}
854 
855 	if ((rv = bus_dmamem_map(sc->twa_dma_tag,
856 		&seg, rseg, size, (void **)&sc->twa_cmds,
857 		BUS_DMA_NOWAIT | BUS_DMA_COHERENT)) != 0) {
858 			aprint_error_dev(sc->twa_dv,
859 			    "unable to map commands, rv = %d\n", rv);
860 			return (1);
861 	}
862 
863 	if ((rv = bus_dmamap_create(sc->twa_dma_tag,
864 		size, num_reqs, size,
865 		0, BUS_DMA_NOWAIT, &sc->twa_cmd_map)) != 0) {
866 			aprint_error_dev(sc->twa_dv,
867 			    "unable to create command DMA map, "
868 				"rv = %d\n", rv);
869 			return (ENOMEM);
870 	}
871 
872 	if ((rv = bus_dmamap_load(sc->twa_dma_tag, sc->twa_cmd_map,
873 		sc->twa_cmds, size, NULL,
874 		BUS_DMA_NOWAIT)) != 0) {
875 			aprint_error_dev(sc->twa_dv,
876 			    "unable to load command DMA map, rv = %d\n", rv);
877 			return (1);
878 	}
879 
880 	if ((uintptr_t)sc->twa_cmds % TWA_ALIGNMENT) {
881 		aprint_error_dev(sc->twa_dv,
882 		    "DMA map memory not aligned on %d boundary\n",
883 		    TWA_ALIGNMENT);
884 
885 		return (1);
886 	}
887 	tc = sc->twa_cmd_pkt_buf = (struct twa_command_packet *)sc->twa_cmds;
888 	sc->twa_cmd_pkt_phys = sc->twa_cmd_map->dm_segs[0].ds_addr;
889 
890 	memset(sc->twa_req_buf, 0, num_reqs * sizeof(struct twa_request));
891 	memset(sc->twa_cmd_pkt_buf, 0,
892 		num_reqs * sizeof(struct twa_command_packet));
893 
894 	sc->sc_twa_request = sc->twa_req_buf;
895 	max_segs = twa_get_maxsegs();
896 	max_xfer = twa_get_maxxfer(max_segs);
897 
898 	for (i = 0; i < num_reqs; i++, tc++) {
899 		tr = &(sc->twa_req_buf[i]);
900 		tr->tr_command = tc;
901 		tr->tr_cmd_phys = sc->twa_cmd_pkt_phys +
902 				(i * sizeof(struct twa_command_packet));
903 		tr->tr_request_id = i;
904 		tr->tr_sc = sc;
905 
906 		/*
907 		 * Create a map for data buffers.  maxsize (256 * 1024) used in
908 		 * bus_dma_tag_create above should suffice the bounce page needs
909 		 * for data buffers, since the max I/O size we support is 128KB.
910 		 * If we supported I/O's bigger than 256KB, we would have to
911 		 * create a second dma_tag, with the appropriate maxsize.
912 		 */
913 		if ((rv = bus_dmamap_create(sc->twa_dma_tag,
914 			max_xfer, max_segs, 1, 0, BUS_DMA_NOWAIT,
915 			&tr->tr_dma_map)) != 0) {
916 				aprint_error_dev(sc->twa_dv,
917 				    "unable to create command DMA map, "
918 				    "rv = %d\n", rv);
919 				return (ENOMEM);
920 		}
921 		/* Insert request into the free queue. */
922 		if (i != 0) {
923 			sc->twa_lookup[i] = tr;
924 			twa_release_request(tr);
925 		} else
926 			tr->tr_flags |= TWA_CMD_AEN;
927 	}
928 	return(0);
929 }
930 
931 static void
932 twa_recompute_openings(struct twa_softc *sc)
933 {
934 	struct twa_drive *td;
935 	int unit;
936 	int openings;
937 	uint64_t total_size;
938 
939 	total_size = 0;
940 	for (unit = 0; unit < sc->sc_nunits; unit++) {
941 		td = &sc->sc_units[unit];
942 		total_size += td->td_size;
943 	}
944 
945 	for (unit = 0; unit < sc->sc_nunits; unit++) {
946 		td = &sc->sc_units[unit];
947 		/*
948 		 * In theory, TWA_Q_LENGTH - 1 should be usable, but
949 		 * keep one additional ccb for internal commands.
950 		 * This makes the controller more reliable under load.
951 		 */
952 		if (total_size > 0) {
953 			openings = (TWA_Q_LENGTH - 2) * td->td_size
954 			    / total_size;
955 		} else
956 			openings = 0;
957 
958 		if (openings == td->td_openings)
959 			continue;
960 		td->td_openings = openings;
961 
962 #ifdef TWA_DEBUG
963 		printf("%s: unit %d openings %d\n",
964 				device_xname(sc->twa_dv), unit, openings);
965 #endif
966 		if (td->td_dev != NULL)
967 			(*td->td_callbacks->tcb_openings)(td->td_dev,
968 			    td->td_openings);
969 	}
970 }
971 
972 /* ARGSUSED */
973 static int
974 twa_request_bus_scan(device_t self, const char *attr, const int *flags)
975 {
976 	struct twa_softc *sc = device_private(self);
977 	struct twa_drive *td;
978 	struct twa_request *tr;
979 	struct twa_attach_args twaa;
980 	int locs[TWACF_NLOCS];
981 	int s, unit;
982 
983 	s = splbio();
984 	for (unit = 0; unit < sc->sc_nunits; unit++) {
985 
986 		if ((tr = twa_get_request(sc, 0)) == NULL) {
987 			splx(s);
988 			return (EIO);
989 		}
990 
991 		tr->tr_cmd_pkt_type |= TWA_CMD_PKT_TYPE_INTERNAL;
992 
993 		tr->tr_data = malloc(TWA_SECTOR_SIZE, M_DEVBUF, M_WAITOK);
994 
995 		td = &sc->sc_units[unit];
996 
997 		if (twa_inquiry(tr, unit) == 0) {
998 			if (td->td_dev == NULL) {
999 	    			twa_print_inquiry_data(sc,
1000 				   ((struct scsipi_inquiry_data *)tr->tr_data));
1001 
1002 				sc->sc_units[unit].td_size =
1003 					twa_read_capacity(tr, unit);
1004 
1005 				twaa.twaa_unit = unit;
1006 
1007 				twa_recompute_openings(sc);
1008 
1009 				locs[TWACF_UNIT] = unit;
1010 
1011 				sc->sc_units[unit].td_dev =
1012 				    config_found_sm_loc(sc->twa_dv, attr,
1013 				    locs, &twaa, twa_print, config_stdsubmatch);
1014 			}
1015 		} else {
1016 			if (td->td_dev != NULL) {
1017 				(void) config_detach(td->td_dev, DETACH_FORCE);
1018 				td->td_dev = NULL;
1019 				td->td_size = 0;
1020 
1021 				twa_recompute_openings(sc);
1022 			}
1023 		}
1024 		free(tr->tr_data, M_DEVBUF);
1025 
1026 		twa_release_request(tr);
1027 	}
1028 	splx(s);
1029 
1030 	return (0);
1031 }
1032 
1033 
1034 #ifdef	DIAGNOSTIC
1035 static inline void
1036 twa_check_busy_q(struct twa_request *tr)
1037 {
1038 	struct twa_request *rq;
1039 	struct twa_softc *sc = tr->tr_sc;
1040 
1041 	TAILQ_FOREACH(rq, &sc->twa_busy, tr_link) {
1042 		if (tr->tr_request_id == rq->tr_request_id) {
1043 			panic("cannot submit same request more than once");
1044 		} else if (tr->bp == rq->bp && tr->bp != 0) {
1045 			/* XXX A check for 0 for the buf ptr is needed to
1046 			 * guard against ioctl requests with a buf ptr of
1047 			 * 0 and also aen notifications. Looking for
1048 			 * external cmds only.
1049 			 */
1050 			panic("cannot submit same buf more than once");
1051 		} else {
1052 			/* Empty else statement */
1053 		}
1054 	}
1055 }
1056 #endif
1057 
1058 static int
1059 twa_start(struct twa_request *tr)
1060 {
1061 	struct twa_softc	*sc = tr->tr_sc;
1062 	uint32_t		status_reg;
1063 	int			s;
1064 	int			error;
1065 
1066 	s = splbio();
1067 
1068 	/*
1069 	 * The 9650 and 9690 have a bug in the detection of the full queue
1070 	 * condition.
1071 	 *
1072 	 * If a write operation has filled the queue and is directly followed
1073 	 * by a status read, it sometimes doesn't return the correct result.
1074 	 * To work around this, the upper 32bit are written first.
1075 	 * This effectively serialises the hardware, but does not change
1076 	 * the state of the queue.
1077 	 */
1078 	if (sc->sc_quirks & TWA_QUIRK_QUEUEFULL_BUG) {
1079 		/* Write lower 32 bits of address */
1080 		TWA_WRITE_COMMAND_QUEUE_LOW(sc, tr->tr_cmd_phys +
1081 			sizeof(struct twa_command_header));
1082 	}
1083 
1084 	/* Check to see if we can post a command. */
1085 	status_reg = twa_inl(sc, TWA_STATUS_REGISTER_OFFSET);
1086 	if ((error = twa_check_ctlr_state(sc, status_reg)))
1087 		goto out;
1088 
1089 	if (status_reg & TWA_STATUS_COMMAND_QUEUE_FULL) {
1090 			if (tr->tr_status != TWA_CMD_PENDING) {
1091 				tr->tr_status = TWA_CMD_PENDING;
1092 				TAILQ_INSERT_TAIL(&tr->tr_sc->twa_pending,
1093 					tr, tr_link);
1094 			}
1095 			twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
1096 					TWA_CONTROL_UNMASK_COMMAND_INTERRUPT);
1097 			error = EBUSY;
1098 	} else {
1099 	   	bus_dmamap_sync(sc->twa_dma_tag, sc->twa_cmd_map,
1100 			(char *)tr->tr_command - (char *)sc->twa_cmds,
1101 			sizeof(struct twa_command_packet),
1102 			BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
1103 
1104 		if (sc->sc_quirks & TWA_QUIRK_QUEUEFULL_BUG) {
1105 			/*
1106 			 * Cmd queue is not full.  Post the command
1107 			 * by writing upper 32 bits of address.
1108 			 */
1109 			TWA_WRITE_COMMAND_QUEUE_HIGH(sc, tr->tr_cmd_phys +
1110 				sizeof(struct twa_command_header));
1111 		} else {
1112 			/* Cmd queue is not full.  Post the command. */
1113 			TWA_WRITE_COMMAND_QUEUE(sc, tr->tr_cmd_phys +
1114 				sizeof(struct twa_command_header));
1115 		}
1116 
1117 		/* Mark the request as currently being processed. */
1118 		tr->tr_status = TWA_CMD_BUSY;
1119 
1120 #ifdef	DIAGNOSTIC
1121 		twa_check_busy_q(tr);
1122 #endif
1123 
1124 		/* Move the request into the busy queue. */
1125 		TAILQ_INSERT_TAIL(&tr->tr_sc->twa_busy, tr, tr_link);
1126 	}
1127 out:
1128 	splx(s);
1129 	return(error);
1130 }
1131 
1132 static int
1133 twa_drain_response_queue(struct twa_softc *sc)
1134 {
1135 	uint32_t			status_reg;
1136 
1137 	for (;;) {
1138 		status_reg = twa_inl(sc, TWA_STATUS_REGISTER_OFFSET);
1139 		if (twa_check_ctlr_state(sc, status_reg))
1140 			return(1);
1141 		if (status_reg & TWA_STATUS_RESPONSE_QUEUE_EMPTY)
1142 			return(0); /* no more response queue entries */
1143 		(void)twa_inl(sc, TWA_RESPONSE_QUEUE_OFFSET);
1144 	}
1145 }
1146 
1147 /*
1148  * twa_drain_response_queue_large:
1149  *
1150  * specific to the 9550 and 9650 controller to remove requests.
1151  *
1152  * Removes all requests from "large" response queue on the 9550 controller.
1153  * This procedure is called as part of the 9550 controller reset sequence.
1154  */
1155 static int
1156 twa_drain_response_queue_large(struct twa_softc *sc, uint32_t timeout)
1157 {
1158 	uint32_t	start_time = 0, end_time;
1159 	uint32_t	response = 0;
1160 
1161 	if (sc->sc_product_id == PCI_PRODUCT_3WARE_9550 ||
1162 	    sc->sc_product_id == PCI_PRODUCT_3WARE_9650 ) {
1163 	       start_time = 0;
1164 	       end_time = (timeout * TWA_MICROSECOND);
1165 
1166 	       while ((response &
1167 		   TWA_9550SX_DRAIN_COMPLETE) != TWA_9550SX_DRAIN_COMPLETE) {
1168 			response = twa_inl(sc, TWA_RESPONSE_QUEUE_LARGE_OFFSET);
1169 			if (start_time >= end_time)
1170 			       return (1);
1171 			DELAY(1);
1172 			start_time++;
1173 	       }
1174 	       /* P-chip delay */
1175 	       DELAY(500000);
1176        }
1177        return (0);
1178 }
1179 
1180 static void
1181 twa_drain_busy_queue(struct twa_softc *sc)
1182 {
1183 	struct twa_request	*tr;
1184 
1185 	/* Walk the busy queue. */
1186 
1187 	while ((tr = TAILQ_FIRST(&sc->twa_busy)) != NULL) {
1188 		TAILQ_REMOVE(&sc->twa_busy, tr, tr_link);
1189 
1190 		twa_unmap_request(tr);
1191 		if ((tr->tr_cmd_pkt_type & TWA_CMD_PKT_TYPE_INTERNAL) ||
1192 			(tr->tr_cmd_pkt_type & TWA_CMD_PKT_TYPE_IOCTL)) {
1193 			/* It's an internal/ioctl request.  Simply free it. */
1194 			if (tr->tr_data)
1195 				free(tr->tr_data, M_DEVBUF);
1196 			twa_release_request(tr);
1197 		} else {
1198 			/* It's a SCSI request.  Complete it. */
1199 			tr->tr_command->command.cmd_pkt_9k.status = EIO;
1200 			if (tr->tr_callback)
1201 				tr->tr_callback(tr);
1202 		}
1203 	}
1204 }
1205 
1206 static int
1207 twa_drain_pending_queue(struct twa_softc *sc)
1208 {
1209 	struct twa_request	*tr;
1210 	int			s, error = 0;
1211 
1212 	/*
1213 	 * Pull requests off the pending queue, and submit them.
1214 	 */
1215 	s = splbio();
1216 	while ((tr = TAILQ_FIRST(&sc->twa_pending)) != NULL) {
1217 		TAILQ_REMOVE(&sc->twa_pending, tr, tr_link);
1218 
1219 		if ((error = twa_start(tr))) {
1220 			if (error == EBUSY) {
1221 				tr->tr_status = TWA_CMD_PENDING;
1222 
1223 				/* queue at the head */
1224 				TAILQ_INSERT_HEAD(&tr->tr_sc->twa_pending,
1225 					tr, tr_link);
1226 				error = 0;
1227 				break;
1228 			} else {
1229 				if (tr->tr_flags & TWA_CMD_SLEEP_ON_REQUEST) {
1230 					tr->tr_error = error;
1231 					tr->tr_callback(tr);
1232 					error = EIO;
1233 				}
1234 			}
1235 		}
1236 	}
1237 	splx(s);
1238 
1239 	return(error);
1240 }
1241 
1242 static int
1243 twa_drain_aen_queue(struct twa_softc *sc)
1244 {
1245 	int				s, error = 0;
1246 	struct twa_request		*tr;
1247 	struct twa_command_header	*cmd_hdr;
1248 	struct timeval	t1;
1249 	uint32_t		timeout;
1250 
1251 	for (;;) {
1252 		if ((tr = twa_get_request(sc, 0)) == NULL) {
1253 			error = EIO;
1254 			break;
1255 		}
1256 		tr->tr_cmd_pkt_type |= TWA_CMD_PKT_TYPE_INTERNAL;
1257 		tr->tr_callback = NULL;
1258 
1259 		tr->tr_data = malloc(TWA_SECTOR_SIZE, M_DEVBUF, M_NOWAIT);
1260 
1261 		if (tr->tr_data == NULL) {
1262 			error = 1;
1263 			goto out;
1264 		}
1265 
1266 		if (twa_request_sense(tr, 0) != 0) {
1267 			error = 1;
1268 			break;
1269 		}
1270 
1271 		timeout = (1000/*ms*/ * 100/*us*/ * TWA_REQUEST_TIMEOUT_PERIOD);
1272 
1273 		microtime(&t1);
1274 
1275 		timeout += t1.tv_usec;
1276 
1277 		do {
1278 			s = splbio();
1279 			twa_done(tr->tr_sc);
1280 			splx(s);
1281 			if (tr->tr_status != TWA_CMD_BUSY)
1282 				break;
1283 			microtime(&t1);
1284 		} while (t1.tv_usec <= timeout);
1285 
1286 		if (tr->tr_status != TWA_CMD_COMPLETE) {
1287 			error = ETIMEDOUT;
1288 			break;
1289 		}
1290 
1291 		if ((error = tr->tr_command->command.cmd_pkt_9k.status))
1292 			break;
1293 
1294 		cmd_hdr = (struct twa_command_header *)(tr->tr_data);
1295 		if ((cmd_hdr->status_block.error) /* aen_code */
1296 				== TWA_AEN_QUEUE_EMPTY)
1297 			break;
1298 		(void)twa_enqueue_aen(sc, cmd_hdr);
1299 
1300 		free(tr->tr_data, M_DEVBUF);
1301 		twa_release_request(tr);
1302 	}
1303 out:
1304 	if (tr) {
1305 		if (tr->tr_data)
1306 			free(tr->tr_data, M_DEVBUF);
1307 
1308 		twa_release_request(tr);
1309 	}
1310 	return(error);
1311 }
1312 
1313 
1314 #if 0
1315 static void
1316 twa_check_response_q(struct twa_request *tr, int clear)
1317 {
1318 	int j;
1319 	static int i = 0;
1320 	static struct twa_request	*req = 0;
1321 	static struct buf		*hist[255];
1322 
1323 
1324 	if (clear) {
1325 		i = 0;
1326 		for (j = 0; j < 255; j++)
1327 			hist[j] = 0;
1328 		return;
1329 	}
1330 
1331 	if (req == 0)
1332 		req = tr;
1333 
1334 	if ((tr->tr_cmd_pkt_type & TWA_CMD_PKT_TYPE_EXTERNAL) != 0) {
1335 		/* XXX this is bogus ! req can't be anything else but tr ! */
1336 		if (req->tr_request_id == tr->tr_request_id)
1337 			panic("req id: %d on controller queue twice",
1338 		    	    tr->tr_request_id);
1339 
1340 		for (j = 0; j < i; j++)
1341 			if (tr->bp == hist[j])
1342 				panic("req id: %d buf found twice",
1343 		    	    	    tr->tr_request_id);
1344 		}
1345 	req = tr;
1346 
1347 	hist[i++] = req->bp;
1348 }
1349 #endif
1350 
1351 static int
1352 twa_done(struct twa_softc *sc)
1353 {
1354 	union twa_response_queue	rq;
1355 	struct twa_request		*tr;
1356 	int				rv = 0;
1357 	uint32_t			status_reg;
1358 
1359 	for (;;) {
1360 		status_reg = twa_inl(sc, TWA_STATUS_REGISTER_OFFSET);
1361 		if ((rv = twa_check_ctlr_state(sc, status_reg)))
1362 			break;
1363 		if (status_reg & TWA_STATUS_RESPONSE_QUEUE_EMPTY)
1364 			break;
1365 		/* Response queue is not empty. */
1366 		rq.value = twa_inl(sc, TWA_RESPONSE_QUEUE_OFFSET);
1367 		tr = sc->sc_twa_request + rq.u.response_id;
1368 #if 0
1369 		twa_check_response_q(tr, 0);
1370 #endif
1371 		/* Unmap the command packet, and any associated data buffer. */
1372 		twa_unmap_request(tr);
1373 
1374 		tr->tr_status = TWA_CMD_COMPLETE;
1375 		TAILQ_REMOVE(&tr->tr_sc->twa_busy, tr, tr_link);
1376 
1377 		if (tr->tr_callback)
1378 			tr->tr_callback(tr);
1379 	}
1380 	(void)twa_drain_pending_queue(sc);
1381 
1382 #if 0
1383 	twa_check_response_q(NULL, 1);
1384 #endif
1385 	return(rv);
1386 }
1387 
1388 /*
1389  * Function name:	twa_init_ctlr
1390  * Description:		Establishes a logical connection with the controller.
1391  *			If bundled with firmware, determines whether or not
1392  *			the driver is compatible with the firmware on the
1393  *			controller, before proceeding to work with it.
1394  *
1395  * Input:		sc	-- ptr to per ctlr structure
1396  * Output:		None
1397  * Return value:	0	-- success
1398  *			non-zero-- failure
1399  */
1400 static int
1401 twa_init_ctlr(struct twa_softc *sc)
1402 {
1403 	uint16_t	fw_on_ctlr_srl = 0;
1404 	uint16_t	fw_on_ctlr_arch_id = 0;
1405 	uint16_t	fw_on_ctlr_branch = 0;
1406 	uint16_t	fw_on_ctlr_build = 0;
1407 	uint32_t	init_connect_result = 0;
1408 	int		error = 0;
1409 
1410 	/* Wait for the controller to become ready. */
1411 	if (twa_wait_status(sc, TWA_STATUS_MICROCONTROLLER_READY,
1412 					TWA_REQUEST_TIMEOUT_PERIOD)) {
1413 		return(ENXIO);
1414 	}
1415 	/* Drain the response queue. */
1416 	if (twa_drain_response_queue(sc))
1417 		return(1);
1418 
1419 	/* Establish a logical connection with the controller. */
1420 	if ((error = twa_init_connection(sc, TWA_INIT_MESSAGE_CREDITS,
1421 			TWA_EXTENDED_INIT_CONNECT, TWA_CURRENT_FW_SRL,
1422 			TWA_9000_ARCH_ID, TWA_CURRENT_FW_BRANCH,
1423 			TWA_CURRENT_FW_BUILD, &fw_on_ctlr_srl,
1424 			&fw_on_ctlr_arch_id, &fw_on_ctlr_branch,
1425 			&fw_on_ctlr_build, &init_connect_result))) {
1426 		return(error);
1427 	}
1428 	twa_drain_aen_queue(sc);
1429 
1430 	/* Set controller state to initialized. */
1431 	sc->twa_state &= ~TWA_STATE_SHUTDOWN;
1432 	return(0);
1433 }
1434 
1435 static int
1436 twa_setup(device_t self)
1437 {
1438 	struct twa_softc *sc;
1439 	struct tw_cl_event_packet *aen_queue;
1440 	uint32_t		i = 0;
1441 	int			error = 0;
1442 
1443 	sc = device_private(self);
1444 
1445 	/* Initialize request queues. */
1446 	TAILQ_INIT(&sc->twa_free);
1447 	TAILQ_INIT(&sc->twa_busy);
1448 	TAILQ_INIT(&sc->twa_pending);
1449 
1450 	sc->twa_sc_flags = 0;
1451 
1452 	if (twa_alloc_req_pkts(sc, TWA_Q_LENGTH)) {
1453 
1454 		return(ENOMEM);
1455 	}
1456 
1457 	/* Allocate memory for the AEN queue. */
1458 	if ((aen_queue = malloc(sizeof(struct tw_cl_event_packet) *
1459 	    TWA_Q_LENGTH, M_DEVBUF, M_WAITOK)) == NULL) {
1460 		/*
1461 		 * This should not cause us to return error.  We will only be
1462 		 * unable to support AEN's.  But then, we will have to check
1463 		 * time and again to see if we can support AEN's, if we
1464 		 * continue.  So, we will just return error.
1465 		 */
1466 		return (ENOMEM);
1467 	}
1468 	/* Initialize the aen queue. */
1469 	memset(aen_queue, 0, sizeof(struct tw_cl_event_packet) * TWA_Q_LENGTH);
1470 
1471 	for (i = 0; i < TWA_Q_LENGTH; i++)
1472 		sc->twa_aen_queue[i] = &(aen_queue[i]);
1473 
1474 	twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
1475 		TWA_CONTROL_DISABLE_INTERRUPTS);
1476 
1477 	/* Initialize the controller. */
1478 	if ((error = twa_init_ctlr(sc))) {
1479 		/* Soft reset the controller, and try one more time. */
1480 
1481 		printf("%s: controller initialization failed. "
1482 		    "Retrying initialization\n", device_xname(sc->twa_dv));
1483 
1484 		if ((error = twa_soft_reset(sc)) == 0)
1485 			error = twa_init_ctlr(sc);
1486 	}
1487 
1488 	twa_describe_controller(sc);
1489 
1490 	error = twa_request_bus_scan(self, "twa", 0);
1491 
1492 	twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
1493 		TWA_CONTROL_CLEAR_ATTENTION_INTERRUPT |
1494 		TWA_CONTROL_UNMASK_RESPONSE_INTERRUPT |
1495 		TWA_CONTROL_ENABLE_INTERRUPTS);
1496 
1497 	return (error);
1498 }
1499 
1500 void *twa_sdh;
1501 
1502 static void
1503 twa_attach(device_t parent, device_t self, void *aux)
1504 {
1505 	struct pci_attach_args *pa;
1506 	struct twa_softc *sc;
1507 	pci_chipset_tag_t pc;
1508 	pcireg_t csr;
1509 	pci_intr_handle_t ih;
1510 	const char *intrstr;
1511 	const struct sysctlnode *node;
1512 	const struct twa_pci_identity *entry;
1513 	int i;
1514 	bool use_64bit;
1515 	char intrbuf[PCI_INTRSTR_LEN];
1516 
1517 	sc = device_private(self);
1518 
1519 	sc->twa_dv = self;
1520 
1521 	pa = aux;
1522 	pc = pa->pa_pc;
1523 	sc->pc = pa->pa_pc;
1524 	sc->tag = pa->pa_tag;
1525 
1526 	entry = twa_lookup(pa->pa_id);
1527 	pci_aprint_devinfo_fancy(pa, "RAID controller", entry->name, 1);
1528 
1529 	sc->sc_quirks = 0;
1530 
1531 	if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_3WARE_9000) {
1532 		sc->sc_nunits = TWA_MAX_UNITS;
1533 		use_64bit = false;
1534 		if (pci_mapreg_map(pa, PCI_MAPREG_START, PCI_MAPREG_TYPE_IO, 0,
1535 	    	    &sc->twa_bus_iot, &sc->twa_bus_ioh, NULL, NULL)) {
1536 			aprint_error_dev(sc->twa_dv, "can't map i/o space\n");
1537 			return;
1538 		}
1539 	} else if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_3WARE_9550) {
1540 		sc->sc_nunits = TWA_MAX_UNITS;
1541 		use_64bit = true;
1542 		if (pci_mapreg_map(pa, PCI_MAPREG_START + 0x08,
1543 	    	    PCI_MAPREG_MEM_TYPE_64BIT, 0, &sc->twa_bus_iot,
1544 		    &sc->twa_bus_ioh, NULL, NULL)) {
1545 			aprint_error_dev(sc->twa_dv, "can't map mem space\n");
1546 			return;
1547 		}
1548 	} else if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_3WARE_9650) {
1549 		sc->sc_nunits = TWA_9650_MAX_UNITS;
1550 		use_64bit = true;
1551 		if (pci_mapreg_map(pa, PCI_MAPREG_START + 0x08,
1552 	    	    PCI_MAPREG_MEM_TYPE_64BIT, 0, &sc->twa_bus_iot,
1553 		    &sc->twa_bus_ioh, NULL, NULL)) {
1554 			aprint_error_dev(sc->twa_dv, "can't map mem space\n");
1555 			return;
1556 		}
1557 		sc->sc_quirks |= TWA_QUIRK_QUEUEFULL_BUG;
1558 	} else if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_3WARE_9690) {
1559 		sc->sc_nunits = TWA_9690_MAX_UNITS;
1560 		use_64bit = true;
1561 		if (pci_mapreg_map(pa, PCI_MAPREG_START + 0x08,
1562 	    	    PCI_MAPREG_MEM_TYPE_64BIT, 0, &sc->twa_bus_iot,
1563 		    &sc->twa_bus_ioh, NULL, NULL)) {
1564 			aprint_error_dev(sc->twa_dv, "can't map mem space\n");
1565 			return;
1566 		}
1567 		sc->sc_quirks |= TWA_QUIRK_QUEUEFULL_BUG;
1568 	} else {
1569 		sc->sc_nunits = 0;
1570 		use_64bit = false;
1571 		aprint_error_dev(sc->twa_dv,
1572 		    "product id 0x%02x not recognized\n",
1573 		    PCI_PRODUCT(pa->pa_id));
1574 		return;
1575 	}
1576 
1577 	if (pci_dma64_available(pa) && use_64bit) {
1578 		aprint_verbose_dev(self, "64-bit DMA addressing active\n");
1579 		sc->twa_dma_tag = pa->pa_dmat64;
1580 	} else {
1581 		sc->twa_dma_tag = pa->pa_dmat;
1582 	}
1583 
1584  	sc->sc_product_id = PCI_PRODUCT(pa->pa_id);
1585 	/* Enable the device. */
1586 	csr = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
1587 
1588 	pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG,
1589 	    csr | PCI_COMMAND_MASTER_ENABLE);
1590 
1591 	/* Map and establish the interrupt. */
1592 	if (pci_intr_map(pa, &ih)) {
1593 		aprint_error_dev(sc->twa_dv, "can't map interrupt\n");
1594 		return;
1595 	}
1596 	intrstr = pci_intr_string(pc, ih, intrbuf, sizeof(intrbuf));
1597 
1598 	sc->twa_ih = pci_intr_establish_xname(pc, ih, IPL_BIO, twa_intr, sc,
1599 	    device_xname(self));
1600 	if (sc->twa_ih == NULL) {
1601 		aprint_error_dev(sc->twa_dv, "can't establish interrupt%s%s\n",
1602 			(intrstr) ? " at " : "",
1603 			(intrstr) ? intrstr : "");
1604 		return;
1605 	}
1606 
1607 	if (intrstr != NULL)
1608 		aprint_normal_dev(sc->twa_dv, "interrupting at %s\n", intrstr);
1609 
1610 	twa_setup(self);
1611 
1612 	if (twa_sdh == NULL)
1613 		twa_sdh = shutdownhook_establish(twa_shutdown, NULL);
1614 
1615 	/* sysctl set-up for 3ware cli */
1616 	if (sysctl_createv(NULL, 0, NULL, &node,
1617 				0, CTLTYPE_NODE, device_xname(sc->twa_dv),
1618 				SYSCTL_DESCR("twa driver information"),
1619 				NULL, 0, NULL, 0,
1620 				CTL_HW, CTL_CREATE, CTL_EOL) != 0) {
1621 		aprint_error_dev(sc->twa_dv,
1622 		    "could not create %s.%s sysctl node\n",
1623 		    "hw", device_xname(sc->twa_dv));
1624 		return;
1625 	}
1626 	if ((i = sysctl_createv(NULL, 0, NULL, NULL,
1627 				0, CTLTYPE_STRING, "driver_version",
1628 				SYSCTL_DESCR("twa driver version"),
1629 				NULL, 0, __UNCONST(&twaver), 0,
1630 				CTL_HW, node->sysctl_num, CTL_CREATE, CTL_EOL))
1631 				!= 0) {
1632 		aprint_error_dev(sc->twa_dv,
1633 		    "could not create %s.%s.driver_version sysctl\n",
1634 		    "hw", device_xname(sc->twa_dv));
1635 		return;
1636 	}
1637 
1638 	return;
1639 }
1640 
1641 static void
1642 twa_shutdown(void *arg)
1643 {
1644 	extern struct cfdriver twa_cd;
1645 	struct twa_softc *sc;
1646 	int i, unit;
1647 
1648 	for (i = 0; i < twa_cd.cd_ndevs; i++) {
1649 		if ((sc = device_lookup_private(&twa_cd, i)) == NULL)
1650 			continue;
1651 
1652 		for (unit = 0; unit < sc->sc_nunits; unit++)
1653 			if (sc->sc_units[unit].td_dev != NULL)
1654 				(void) config_detach(sc->sc_units[unit].td_dev,
1655 					DETACH_FORCE | DETACH_QUIET);
1656 
1657 		twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
1658 			TWA_CONTROL_DISABLE_INTERRUPTS);
1659 
1660 		/* Let the controller know that we are going down. */
1661 		(void)twa_init_connection(sc, TWA_SHUTDOWN_MESSAGE_CREDITS,
1662 				0, 0, 0, 0, 0,
1663 				NULL, NULL, NULL, NULL, NULL);
1664 	}
1665 }
1666 
1667 void
1668 twa_register_callbacks(struct twa_softc *sc, int unit,
1669     const struct twa_callbacks *tcb)
1670 {
1671 
1672 	sc->sc_units[unit].td_callbacks = tcb;
1673 }
1674 
1675 /*
1676  * Print autoconfiguration message for a sub-device
1677  */
1678 static int
1679 twa_print(void *aux, const char *pnp)
1680 {
1681 	struct twa_attach_args *twaa;
1682 
1683 	twaa = aux;
1684 
1685 	if (pnp !=NULL)
1686 		aprint_normal("block device at %s\n", pnp);
1687 	aprint_normal(" unit %d\n", twaa->twaa_unit);
1688 	return (UNCONF);
1689 }
1690 
1691 static void
1692 twa_fillin_sgl(struct twa_sg *sgl, bus_dma_segment_t *segs, int nsegments)
1693 {
1694 	int	i;
1695 	for (i = 0; i < nsegments; i++) {
1696 		sgl[i].address = segs[i].ds_addr;
1697 		sgl[i].length = (uint32_t)(segs[i].ds_len);
1698 	}
1699 }
1700 
1701 static int
1702 twa_submit_io(struct twa_request *tr)
1703 {
1704 	int	error;
1705 
1706 	if ((error = twa_start(tr))) {
1707 		if (error == EBUSY)
1708 			error = 0; /* request is in the pending queue */
1709 		else {
1710 			tr->tr_error = error;
1711 		}
1712 	}
1713 	return(error);
1714 }
1715 
1716 /*
1717  * Function name:	twa_setup_data_dmamap
1718  * Description:		Callback of bus_dmamap_load for the buffer associated
1719  *			with data.  Updates the cmd pkt (size/sgl_entries
1720  *			fields, as applicable) to reflect the number of sg
1721  *			elements.
1722  *
1723  * Input:		arg	-- ptr to request pkt
1724  *			segs	-- ptr to a list of segment descriptors
1725  *			nsegments--# of segments
1726  *			error	-- 0 if no errors encountered before callback,
1727  *				   non-zero if errors were encountered
1728  * Output:		None
1729  * Return value:	None
1730  */
1731 static int
1732 twa_setup_data_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments)
1733 {
1734 	struct twa_request		*tr = (struct twa_request *)arg;
1735 	struct twa_command_packet	*cmdpkt = tr->tr_command;
1736 	struct twa_command_9k		*cmd9k;
1737 	union twa_command_7k		*cmd7k;
1738 	uint8_t				sgl_offset;
1739 	int				error;
1740 
1741 	if (tr->tr_cmd_pkt_type & TWA_CMD_PKT_TYPE_9K) {
1742 		cmd9k = &(cmdpkt->command.cmd_pkt_9k);
1743 		twa_fillin_sgl(&(cmd9k->sg_list[0]), segs, nsegments);
1744 		cmd9k->sgl_entries += nsegments - 1;
1745 	} else {
1746 		/* It's a 7000 command packet. */
1747 		cmd7k = &(cmdpkt->command.cmd_pkt_7k);
1748 		if ((sgl_offset = cmdpkt->command.cmd_pkt_7k.generic.sgl_offset))
1749 			twa_fillin_sgl((struct twa_sg *)
1750 					(((uint32_t *)cmd7k) + sgl_offset),
1751 					segs, nsegments);
1752 		/* Modify the size field, based on sg address size. */
1753 		cmd7k->generic.size +=
1754 			((TWA_64BIT_ADDRESSES ? 3 : 2) * nsegments);
1755 	}
1756 	if (tr->tr_flags & TWA_CMD_DATA_IN)
1757 		bus_dmamap_sync(tr->tr_sc->twa_dma_tag, tr->tr_dma_map, 0,
1758 			tr->tr_length, BUS_DMASYNC_PREWRITE);
1759 	if (tr->tr_flags & TWA_CMD_DATA_OUT) {
1760 		/*
1761 		 * If we're using an alignment buffer, and we're
1762 		 * writing data, copy the real data out.
1763 		 */
1764 		if (tr->tr_flags & TWA_CMD_DATA_COPY_NEEDED)
1765 			memcpy(tr->tr_data, tr->tr_real_data,
1766 				tr->tr_real_length);
1767 		bus_dmamap_sync(tr->tr_sc->twa_dma_tag, tr->tr_dma_map, 0,
1768 			tr->tr_length, BUS_DMASYNC_PREREAD);
1769 	}
1770 	error = twa_submit_io(tr);
1771 
1772 	if (error) {
1773 		twa_unmap_request(tr);
1774 		/*
1775 		 * If the caller had been returned EINPROGRESS, and he has
1776 		 * registered a callback for handling completion, the callback
1777 		 * will never get called because we were unable to submit the
1778 		 * request.  So, free up the request right here.
1779 		 */
1780 		if (tr->tr_callback)
1781 			twa_release_request(tr);
1782 	}
1783 	return (error);
1784 }
1785 
1786 /*
1787  * Function name:	twa_map_request
1788  * Description:		Maps a cmd pkt and data associated with it, into
1789  *			DMA'able memory.
1790  *
1791  * Input:		tr	-- ptr to request pkt
1792  * Output:		None
1793  * Return value:	0	-- success
1794  *			non-zero-- failure
1795  */
1796 int
1797 twa_map_request(struct twa_request *tr)
1798 {
1799 	struct twa_softc	*sc = tr->tr_sc;
1800 	int			 s, rv, rc;
1801 
1802 	/* If the command involves data, map that too. */
1803 	if (tr->tr_data != NULL) {
1804 
1805 		if (((u_long)tr->tr_data & (511)) != 0) {
1806 			tr->tr_flags |= TWA_CMD_DATA_COPY_NEEDED;
1807 			tr->tr_real_data = tr->tr_data;
1808 			tr->tr_real_length = tr->tr_length;
1809 			s = splvm();
1810 			rc = uvm_km_kmem_alloc(kmem_va_arena,
1811 			    tr->tr_length, (VM_NOSLEEP | VM_INSTANTFIT),
1812 			    (vmem_addr_t *)&tr->tr_data);
1813 			splx(s);
1814 
1815 			if (rc != 0) {
1816 				tr->tr_data = tr->tr_real_data;
1817 				tr->tr_length = tr->tr_real_length;
1818 				return(ENOMEM);
1819 			}
1820 			if ((tr->tr_flags & TWA_CMD_DATA_IN) != 0)
1821 				memcpy(tr->tr_data, tr->tr_real_data,
1822 					tr->tr_length);
1823 		}
1824 
1825 		/*
1826 		 * Map the data buffer into bus space and build the S/G list.
1827 		 */
1828 		rv = bus_dmamap_load(sc->twa_dma_tag, tr->tr_dma_map,
1829 			tr->tr_data, tr->tr_length, NULL,
1830 			BUS_DMA_NOWAIT | BUS_DMA_STREAMING);
1831 
1832 		if (rv != 0) {
1833 			if ((tr->tr_flags & TWA_CMD_DATA_COPY_NEEDED) != 0) {
1834 				s = splvm();
1835 				uvm_km_kmem_free(kmem_va_arena,
1836 				    (vaddr_t)tr->tr_data, tr->tr_length);
1837 				splx(s);
1838 			}
1839 			return (rv);
1840 		}
1841 
1842 		if ((rv = twa_setup_data_dmamap(tr,
1843 				tr->tr_dma_map->dm_segs,
1844 				tr->tr_dma_map->dm_nsegs))) {
1845 
1846 			if (tr->tr_flags & TWA_CMD_DATA_COPY_NEEDED) {
1847 				s = splvm();
1848 				uvm_km_kmem_free(kmem_va_arena,
1849 				    (vaddr_t)tr->tr_data, tr->tr_length);
1850 				splx(s);
1851 				tr->tr_data = tr->tr_real_data;
1852 				tr->tr_length = tr->tr_real_length;
1853 			}
1854 		}
1855 
1856 	} else
1857 		if ((rv = twa_submit_io(tr)))
1858 			twa_unmap_request(tr);
1859 
1860 	return (rv);
1861 }
1862 
1863 /*
1864  * Function name:	twa_intr
1865  * Description:		Interrupt handler.  Determines the kind of interrupt,
1866  *			and calls the appropriate handler.
1867  *
1868  * Input:		sc	-- ptr to per ctlr structure
1869  * Output:		None
1870  * Return value:	None
1871  */
1872 
1873 static int
1874 twa_intr(void *arg)
1875 {
1876 	int	caught, s, rv __diagused;
1877 	struct twa_softc *sc;
1878 	uint32_t	status_reg;
1879 	sc = (struct twa_softc *)arg;
1880 
1881 	caught = 0;
1882 	/* Collect current interrupt status. */
1883 	status_reg = twa_inl(sc, TWA_STATUS_REGISTER_OFFSET);
1884 	if (twa_check_ctlr_state(sc, status_reg)) {
1885 		caught = 1;
1886 		goto bail;
1887 	}
1888 	/* Dispatch based on the kind of interrupt. */
1889 	if (status_reg & TWA_STATUS_HOST_INTERRUPT) {
1890 		twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
1891 			TWA_CONTROL_CLEAR_HOST_INTERRUPT);
1892 		caught = 1;
1893 	}
1894 	if ((status_reg & TWA_STATUS_ATTENTION_INTERRUPT) != 0) {
1895 		twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
1896 			TWA_CONTROL_CLEAR_ATTENTION_INTERRUPT);
1897 		rv = twa_fetch_aen(sc);
1898 #ifdef DIAGNOSTIC
1899 		if (rv != 0)
1900 			printf("%s: unable to retrieve AEN (%d)\n",
1901 				device_xname(sc->twa_dv), rv);
1902 #endif
1903 		caught = 1;
1904 	}
1905 	if (status_reg & TWA_STATUS_COMMAND_INTERRUPT) {
1906 		/* Start any requests that might be in the pending queue. */
1907 		twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
1908 			TWA_CONTROL_MASK_COMMAND_INTERRUPT);
1909 		(void)twa_drain_pending_queue(sc);
1910 		caught = 1;
1911 	}
1912 	if (status_reg & TWA_STATUS_RESPONSE_INTERRUPT) {
1913 		s = splbio();
1914 		twa_done(sc);
1915 		splx(s);
1916 		caught = 1;
1917 	}
1918 bail:
1919 	return (caught);
1920 }
1921 
1922 /*
1923  * Accept an open operation on the control device.
1924  */
1925 static int
1926 twaopen(dev_t dev, int flag, int mode, struct lwp *l)
1927 {
1928 	struct twa_softc *twa;
1929 
1930 	if ((twa = device_lookup_private(&twa_cd, minor(dev))) == NULL)
1931 		return (ENXIO);
1932 	if ((twa->twa_sc_flags & TWA_STATE_OPEN) != 0)
1933 		return (EBUSY);
1934 
1935 	twa->twa_sc_flags |= TWA_STATE_OPEN;
1936 
1937 	return (0);
1938 }
1939 
1940 /*
1941  * Accept the last close on the control device.
1942  */
1943 static int
1944 twaclose(dev_t dev, int flag, int mode,
1945     struct lwp *l)
1946 {
1947 	struct twa_softc *twa;
1948 
1949 	twa = device_lookup_private(&twa_cd, minor(dev));
1950 	twa->twa_sc_flags &= ~TWA_STATE_OPEN;
1951 	return (0);
1952 }
1953 
1954 /*
1955  * Function name:	twaioctl
1956  * Description:		ioctl handler.
1957  *
1958  * Input:		sc	-- ptr to per ctlr structure
1959  *			cmd	-- ioctl cmd
1960  *			buf	-- ptr to buffer in kernel memory, which is
1961  *				   a copy of the input buffer in user-space
1962  * Output:		buf	-- ptr to buffer in kernel memory, which will
1963  *				   be copied of the output buffer in user-space
1964  * Return value:	0	-- success
1965  *			non-zero-- failure
1966  */
1967 static int
1968 twaioctl(dev_t dev, u_long cmd, void *data, int flag,
1969     struct lwp *l)
1970 {
1971 	struct twa_softc *sc;
1972 	struct twa_ioctl_9k	*user_buf = (struct twa_ioctl_9k *)data;
1973 	struct tw_cl_event_packet event_buf;
1974 	struct twa_request 	*tr = 0;
1975 	int32_t			event_index = 0;
1976 	int32_t			start_index;
1977 	int			s, error = 0;
1978 
1979 	sc = device_lookup_private(&twa_cd, minor(dev));
1980 
1981 	switch (cmd) {
1982 	case TW_OSL_IOCTL_FIRMWARE_PASS_THROUGH:
1983 	{
1984 		struct twa_command_packet	*cmdpkt;
1985 		uint32_t			data_buf_size_adjusted;
1986 
1987 		/* Get a request packet */
1988 		tr = twa_get_request_wait(sc, 0);
1989 		KASSERT(tr != NULL);
1990 		/*
1991 		 * Make sure that the data buffer sent to firmware is a
1992 		 * 512 byte multiple in size.
1993 		 */
1994 		data_buf_size_adjusted =
1995 			(user_buf->twa_drvr_pkt.buffer_length + 511) & ~511;
1996 
1997 		if ((tr->tr_length = data_buf_size_adjusted)) {
1998 			if ((tr->tr_data = malloc(data_buf_size_adjusted,
1999 			    M_DEVBUF, M_WAITOK)) == NULL) {
2000 				error = ENOMEM;
2001 				goto fw_passthru_done;
2002 			}
2003 			/* Copy the payload. */
2004 			if ((error = copyin((void *) (user_buf->pdata),
2005 				(void *) (tr->tr_data),
2006 				user_buf->twa_drvr_pkt.buffer_length)) != 0) {
2007 					goto fw_passthru_done;
2008 			}
2009 			tr->tr_flags |= TWA_CMD_DATA_IN | TWA_CMD_DATA_OUT;
2010 		}
2011 		tr->tr_cmd_pkt_type |= TWA_CMD_PKT_TYPE_IOCTL;
2012 		cmdpkt = tr->tr_command;
2013 
2014 		/* Copy the command packet. */
2015 		memcpy(cmdpkt, &(user_buf->twa_cmd_pkt),
2016 			sizeof(struct twa_command_packet));
2017 		cmdpkt->command.cmd_pkt_7k.generic.request_id =
2018 			tr->tr_request_id;
2019 
2020 		/* Send down the request, and wait for it to complete. */
2021 		if ((error = twa_wait_request(tr, TWA_REQUEST_TIMEOUT_PERIOD))) 		{
2022 			if (error == ETIMEDOUT)
2023 				break; /* clean-up done by twa_wait_request */
2024 			goto fw_passthru_done;
2025 		}
2026 
2027 		/* Copy the command packet back into user space. */
2028 		memcpy(&user_buf->twa_cmd_pkt, cmdpkt,
2029 			sizeof(struct twa_command_packet));
2030 
2031 		/* If there was a payload, copy it back too. */
2032 		if (tr->tr_length)
2033 			error = copyout(tr->tr_data, user_buf->pdata,
2034 					user_buf->twa_drvr_pkt.buffer_length);
2035 fw_passthru_done:
2036 		/* Free resources. */
2037 		if (tr->tr_data)
2038 			free(tr->tr_data, M_DEVBUF);
2039 
2040 		if (tr)
2041 			twa_release_request(tr);
2042 		break;
2043 	}
2044 
2045 	case TW_OSL_IOCTL_SCAN_BUS:
2046 		twa_request_bus_scan(sc->twa_dv, "twa", 0);
2047 		break;
2048 
2049 	case TW_CL_IOCTL_GET_FIRST_EVENT:
2050 		if (sc->twa_aen_queue_wrapped) {
2051 			if (sc->twa_aen_queue_overflow) {
2052 				/*
2053 				 * The aen queue has wrapped, even before some
2054 				 * events have been retrieved.  Let the caller
2055 				 * know that he missed out on some AEN's.
2056 				 */
2057 				user_buf->twa_drvr_pkt.status =
2058 					TWA_ERROR_AEN_OVERFLOW;
2059 				sc->twa_aen_queue_overflow = FALSE;
2060 			} else
2061 				user_buf->twa_drvr_pkt.status = 0;
2062 			event_index = sc->twa_aen_head;
2063 		} else {
2064 			if (sc->twa_aen_head == sc->twa_aen_tail) {
2065 				user_buf->twa_drvr_pkt.status =
2066 					TWA_ERROR_AEN_NO_EVENTS;
2067 				break;
2068 			}
2069 			user_buf->twa_drvr_pkt.status = 0;
2070 			event_index = sc->twa_aen_tail;	/* = 0 */
2071 		}
2072 		if ((error = copyout(sc->twa_aen_queue[event_index],
2073 		    user_buf->pdata, sizeof(struct tw_cl_event_packet))) != 0)
2074 			(sc->twa_aen_queue[event_index])->retrieved =
2075 			    TWA_AEN_RETRIEVED;
2076 		break;
2077 
2078 	case TW_CL_IOCTL_GET_LAST_EVENT:
2079 		if (sc->twa_aen_queue_wrapped) {
2080 			if (sc->twa_aen_queue_overflow) {
2081 				/*
2082 				 * The aen queue has wrapped, even before some
2083 				 * events have been retrieved.  Let the caller
2084 				 * know that he missed out on some AEN's.
2085 				 */
2086 				user_buf->twa_drvr_pkt.status =
2087 					TWA_ERROR_AEN_OVERFLOW;
2088 				sc->twa_aen_queue_overflow = FALSE;
2089 			} else
2090 				user_buf->twa_drvr_pkt.status = 0;
2091 		} else {
2092 			if (sc->twa_aen_head == sc->twa_aen_tail) {
2093 				user_buf->twa_drvr_pkt.status =
2094 					TWA_ERROR_AEN_NO_EVENTS;
2095 				break;
2096 			}
2097 			user_buf->twa_drvr_pkt.status = 0;
2098 		}
2099 		event_index =
2100 		    (sc->twa_aen_head - 1 + TWA_Q_LENGTH) % TWA_Q_LENGTH;
2101 		if ((error = copyout(sc->twa_aen_queue[event_index],
2102 		    user_buf->pdata, sizeof(struct tw_cl_event_packet))) != 0)
2103 			(sc->twa_aen_queue[event_index])->retrieved =
2104 			    TWA_AEN_RETRIEVED;
2105 		break;
2106 
2107 	case TW_CL_IOCTL_GET_NEXT_EVENT:
2108 		user_buf->twa_drvr_pkt.status = 0;
2109 		if (sc->twa_aen_queue_wrapped) {
2110 
2111 			if (sc->twa_aen_queue_overflow) {
2112 				/*
2113 				 * The aen queue has wrapped, even before some
2114 				 * events have been retrieved.  Let the caller
2115 				 * know that he missed out on some AEN's.
2116 				 */
2117 				user_buf->twa_drvr_pkt.status =
2118 					TWA_ERROR_AEN_OVERFLOW;
2119 				sc->twa_aen_queue_overflow = FALSE;
2120 			}
2121 			start_index = sc->twa_aen_head;
2122 		} else {
2123 			if (sc->twa_aen_head == sc->twa_aen_tail) {
2124 				user_buf->twa_drvr_pkt.status =
2125 					TWA_ERROR_AEN_NO_EVENTS;
2126 				break;
2127 			}
2128 			start_index = sc->twa_aen_tail;	/* = 0 */
2129 		}
2130 		error = copyin(user_buf->pdata, &event_buf,
2131 				sizeof(struct tw_cl_event_packet));
2132 
2133 		event_index = (start_index + event_buf.sequence_id -
2134 		    (sc->twa_aen_queue[start_index])->sequence_id + 1)
2135 		    % TWA_Q_LENGTH;
2136 
2137 		if (!((sc->twa_aen_queue[event_index])->sequence_id >
2138 		    event_buf.sequence_id)) {
2139 			if (user_buf->twa_drvr_pkt.status ==
2140 			    TWA_ERROR_AEN_OVERFLOW)
2141 				/* so we report the overflow next time */
2142 				sc->twa_aen_queue_overflow = TRUE;
2143 			user_buf->twa_drvr_pkt.status = TWA_ERROR_AEN_NO_EVENTS;
2144 			break;
2145 		}
2146 		if ((error = copyout(sc->twa_aen_queue[event_index],
2147 		    user_buf->pdata, sizeof(struct tw_cl_event_packet))) != 0)
2148 			(sc->twa_aen_queue[event_index])->retrieved =
2149 			    TWA_AEN_RETRIEVED;
2150 		break;
2151 
2152 	case TW_CL_IOCTL_GET_PREVIOUS_EVENT:
2153 		user_buf->twa_drvr_pkt.status = 0;
2154 		if (sc->twa_aen_queue_wrapped) {
2155 			if (sc->twa_aen_queue_overflow) {
2156 				/*
2157 				 * The aen queue has wrapped, even before some
2158 				 * events have been retrieved.  Let the caller
2159 				 * know that he missed out on some AEN's.
2160 				 */
2161 				user_buf->twa_drvr_pkt.status =
2162 					TWA_ERROR_AEN_OVERFLOW;
2163 				sc->twa_aen_queue_overflow = FALSE;
2164 			}
2165 			start_index = sc->twa_aen_head;
2166 		} else {
2167 			if (sc->twa_aen_head == sc->twa_aen_tail) {
2168 				user_buf->twa_drvr_pkt.status =
2169 					TWA_ERROR_AEN_NO_EVENTS;
2170 				break;
2171 			}
2172 			start_index = sc->twa_aen_tail;	/* = 0 */
2173 		}
2174 		if ((error = copyin(user_buf->pdata, &event_buf,
2175 				sizeof(struct tw_cl_event_packet))) != 0)
2176 
2177 		event_index = (start_index + event_buf.sequence_id -
2178 		    (sc->twa_aen_queue[start_index])->sequence_id - 1)
2179 		    % TWA_Q_LENGTH;
2180 		if (!((sc->twa_aen_queue[event_index])->sequence_id <
2181 		    event_buf.sequence_id)) {
2182 			if (user_buf->twa_drvr_pkt.status ==
2183 			    TWA_ERROR_AEN_OVERFLOW)
2184 				/* so we report the overflow next time */
2185 				sc->twa_aen_queue_overflow = TRUE;
2186 			user_buf->twa_drvr_pkt.status =
2187 				TWA_ERROR_AEN_NO_EVENTS;
2188 			break;
2189 		}
2190 		if ((error = copyout(sc->twa_aen_queue [event_index],
2191 		    user_buf->pdata, sizeof(struct tw_cl_event_packet))) != 0)
2192 			aprint_error_dev(sc->twa_dv, "get_previous: Could not "
2193 			    "copyout to event_buf. error = %x\n", error);
2194 		(sc->twa_aen_queue[event_index])->retrieved = TWA_AEN_RETRIEVED;
2195 		break;
2196 
2197 	case TW_CL_IOCTL_GET_LOCK:
2198 	{
2199 		struct tw_cl_lock_packet	twa_lock;
2200 
2201 		copyin(user_buf->pdata, &twa_lock,
2202 				sizeof(struct tw_cl_lock_packet));
2203 		s = splbio();
2204 		if ((sc->twa_ioctl_lock.lock == TWA_LOCK_FREE) ||
2205 			(twa_lock.force_flag) ||
2206 			(time_second >= sc->twa_ioctl_lock.timeout)) {
2207 
2208 			sc->twa_ioctl_lock.lock = TWA_LOCK_HELD;
2209 			sc->twa_ioctl_lock.timeout = time_second +
2210 				(twa_lock.timeout_msec / 1000);
2211 			twa_lock.time_remaining_msec = twa_lock.timeout_msec;
2212 			user_buf->twa_drvr_pkt.status = 0;
2213 		} else {
2214 			twa_lock.time_remaining_msec =
2215 				(sc->twa_ioctl_lock.timeout - time_second) *
2216 				1000;
2217 			user_buf->twa_drvr_pkt.status =
2218 					TWA_ERROR_IOCTL_LOCK_ALREADY_HELD;
2219 		}
2220 		splx(s);
2221 		copyout(&twa_lock, user_buf->pdata,
2222 				sizeof(struct tw_cl_lock_packet));
2223 		break;
2224 	}
2225 
2226 	case TW_CL_IOCTL_RELEASE_LOCK:
2227 		s = splbio();
2228 		if (sc->twa_ioctl_lock.lock == TWA_LOCK_FREE) {
2229 			user_buf->twa_drvr_pkt.status =
2230 				TWA_ERROR_IOCTL_LOCK_NOT_HELD;
2231 		} else {
2232 			sc->twa_ioctl_lock.lock = TWA_LOCK_FREE;
2233 			user_buf->twa_drvr_pkt.status = 0;
2234 		}
2235 		splx(s);
2236 		break;
2237 
2238 	case TW_CL_IOCTL_GET_COMPATIBILITY_INFO:
2239 	{
2240 		struct tw_cl_compatibility_packet	comp_pkt;
2241 
2242 		memcpy(comp_pkt.driver_version, TWA_DRIVER_VERSION_STRING,
2243 					sizeof(TWA_DRIVER_VERSION_STRING));
2244 		comp_pkt.working_srl = sc->working_srl;
2245 		comp_pkt.working_branch = sc->working_branch;
2246 		comp_pkt.working_build = sc->working_build;
2247 		user_buf->twa_drvr_pkt.status = 0;
2248 
2249 		/* Copy compatibility information to user space. */
2250 		copyout(&comp_pkt, user_buf->pdata,
2251 				uimin(sizeof(struct tw_cl_compatibility_packet),
2252 					user_buf->twa_drvr_pkt.buffer_length));
2253 		break;
2254 	}
2255 
2256 	case TWA_IOCTL_GET_UNITNAME:	/* WASABI EXTENSION */
2257 	{
2258 		struct twa_unitname	*tn;
2259 		struct twa_drive	*tdr;
2260 
2261 		tn = (struct twa_unitname *)data;
2262 			/* XXX mutex */
2263 		if (tn->tn_unit < 0 || tn->tn_unit >= sc->sc_nunits)
2264 			return (EINVAL);
2265 		tdr = &sc->sc_units[tn->tn_unit];
2266 		if (tdr->td_dev == NULL)
2267 			tn->tn_name[0] = '\0';
2268 		else
2269 			strlcpy(tn->tn_name, device_xname(tdr->td_dev),
2270 			    sizeof(tn->tn_name));
2271 		return (0);
2272 	}
2273 
2274 	default:
2275 		/* Unknown opcode. */
2276 		error = ENOTTY;
2277 	}
2278 
2279 	return(error);
2280 }
2281 
2282 const struct cdevsw twa_cdevsw = {
2283 	.d_open = twaopen,
2284 	.d_close = twaclose,
2285 	.d_read = noread,
2286 	.d_write = nowrite,
2287 	.d_ioctl = twaioctl,
2288 	.d_stop = nostop,
2289 	.d_tty = notty,
2290 	.d_poll = nopoll,
2291 	.d_mmap = nommap,
2292 	.d_kqfilter = nokqfilter,
2293 	.d_discard = nodiscard,
2294 	.d_flag = D_OTHER
2295 };
2296 
2297 /*
2298  * Function name:	twa_get_param
2299  * Description:		Get a firmware parameter.
2300  *
2301  * Input:		sc		-- ptr to per ctlr structure
2302  *			table_id	-- parameter table #
2303  *			param_id	-- index of the parameter in the table
2304  *			param_size	-- size of the parameter in bytes
2305  *			callback	-- ptr to function, if any, to be called
2306  *					back on completion; NULL if no callback.
2307  * Output:		None
2308  * Return value:	ptr to param structure	-- success
2309  *			NULL			-- failure
2310  */
2311 static int
2312 twa_get_param(struct twa_softc *sc, int table_id, int param_id,
2313     size_t param_size, void (* callback)(struct twa_request *tr),
2314     struct twa_param_9k **param)
2315 {
2316 	int			rv = 0;
2317 	struct twa_request	*tr;
2318 	union twa_command_7k	*cmd;
2319 
2320 	/* Get a request packet. */
2321 	if ((tr = twa_get_request(sc, 0)) == NULL) {
2322 		rv = EAGAIN;
2323 		goto out;
2324 	}
2325 
2326 	tr->tr_cmd_pkt_type |= TWA_CMD_PKT_TYPE_INTERNAL;
2327 
2328 	/* Allocate memory to read data into. */
2329 	if ((*param = (struct twa_param_9k *)
2330 		malloc(TWA_SECTOR_SIZE, M_DEVBUF, M_NOWAIT)) == NULL) {
2331 		rv = ENOMEM;
2332 		goto out;
2333 	}
2334 
2335 	memset(*param, 0, sizeof(struct twa_param_9k) - 1 + param_size);
2336 	tr->tr_data = *param;
2337 	tr->tr_length = TWA_SECTOR_SIZE;
2338 	tr->tr_flags = TWA_CMD_DATA_IN | TWA_CMD_DATA_OUT;
2339 
2340 	/* Build the cmd pkt. */
2341 	cmd = &(tr->tr_command->command.cmd_pkt_7k);
2342 
2343 	tr->tr_command->cmd_hdr.header_desc.size_header = 128;
2344 
2345 	cmd->param.opcode = TWA_OP_GET_PARAM;
2346 	cmd->param.sgl_offset = 2;
2347 	cmd->param.size = 2;
2348 	cmd->param.request_id = tr->tr_request_id;
2349 	cmd->param.unit = 0;
2350 	cmd->param.param_count = 1;
2351 
2352 	/* Specify which parameter we need. */
2353 	(*param)->table_id = table_id | TWA_9K_PARAM_DESCRIPTOR;
2354 	(*param)->parameter_id = param_id;
2355 	(*param)->parameter_size_bytes = param_size;
2356 
2357 	/* Submit the command. */
2358 	if (callback == NULL) {
2359 		/* There's no call back; wait till the command completes. */
2360 		rv = twa_immediate_request(tr, TWA_REQUEST_TIMEOUT_PERIOD);
2361 
2362 		if (rv != 0)
2363 			goto out;
2364 
2365 		if ((rv = cmd->param.status) != 0) {
2366 		     /* twa_drain_complete_queue will have done the unmapping */
2367 		     goto out;
2368 		}
2369 		twa_release_request(tr);
2370 		return (rv);
2371 	} else {
2372 		/* There's a call back.  Simply submit the command. */
2373 		tr->tr_callback = callback;
2374 		rv = twa_map_request(tr);
2375 		return (rv);
2376 	}
2377 out:
2378 	if (tr)
2379 		twa_release_request(tr);
2380 	return(rv);
2381 }
2382 
2383 /*
2384  * Function name:	twa_set_param
2385  * Description:		Set a firmware parameter.
2386  *
2387  * Input:		sc		-- ptr to per ctlr structure
2388  *			table_id	-- parameter table #
2389  *			param_id	-- index of the parameter in the table
2390  *			param_size	-- size of the parameter in bytes
2391  *			callback	-- ptr to function, if any, to be called
2392  *					back on completion; NULL if no callback.
2393  * Output:		None
2394  * Return value:	0	-- success
2395  *			non-zero-- failure
2396  */
2397 static int
2398 twa_set_param(struct twa_softc *sc, int table_id, int param_id, int param_size,
2399     void *data, void (* callback)(struct twa_request *tr))
2400 {
2401 	struct twa_request	*tr;
2402 	union twa_command_7k	*cmd;
2403 	struct twa_param_9k	*param = NULL;
2404 	int			error = ENOMEM;
2405 
2406 	tr = twa_get_request(sc, 0);
2407 	if (tr == NULL)
2408 		return (EAGAIN);
2409 
2410 	tr->tr_cmd_pkt_type |= TWA_CMD_PKT_TYPE_INTERNAL;
2411 
2412 	/* Allocate memory to send data using. */
2413 	if ((param = (struct twa_param_9k *)
2414 			malloc(TWA_SECTOR_SIZE, M_DEVBUF, M_NOWAIT)) == NULL)
2415 		goto out;
2416 	memset(param, 0, sizeof(struct twa_param_9k) - 1 + param_size);
2417 	tr->tr_data = param;
2418 	tr->tr_length = TWA_SECTOR_SIZE;
2419 	tr->tr_flags = TWA_CMD_DATA_IN | TWA_CMD_DATA_OUT;
2420 
2421 	/* Build the cmd pkt. */
2422 	cmd = &(tr->tr_command->command.cmd_pkt_7k);
2423 
2424 	tr->tr_command->cmd_hdr.header_desc.size_header = 128;
2425 
2426 	cmd->param.opcode = TWA_OP_SET_PARAM;
2427 	cmd->param.sgl_offset = 2;
2428 	cmd->param.size = 2;
2429 	cmd->param.request_id = tr->tr_request_id;
2430 	cmd->param.unit = 0;
2431 	cmd->param.param_count = 1;
2432 
2433 	/* Specify which parameter we want to set. */
2434 	param->table_id = table_id | TWA_9K_PARAM_DESCRIPTOR;
2435 	param->parameter_id = param_id;
2436 	param->parameter_size_bytes = param_size;
2437 	memcpy(param->data, data, param_size);
2438 
2439 	/* Submit the command. */
2440 	if (callback == NULL) {
2441 		/* There's no call back;  wait till the command completes. */
2442 		error = twa_immediate_request(tr, TWA_REQUEST_TIMEOUT_PERIOD);
2443 		if (error == ETIMEDOUT)
2444 			/* clean-up done by twa_immediate_request */
2445 			return(error);
2446 		if (error)
2447 			goto out;
2448 		if ((error = cmd->param.status)) {
2449 			/*
2450 			 * twa_drain_complete_queue will have done the
2451 			 * unmapping.
2452 			 */
2453 			goto out;
2454 		}
2455 		free(param, M_DEVBUF);
2456 		twa_release_request(tr);
2457 		return(error);
2458 	} else {
2459 		/* There's a call back.  Simply submit the command. */
2460 		tr->tr_callback = callback;
2461 		if ((error = twa_map_request(tr)))
2462 			goto out;
2463 
2464 		return (0);
2465 	}
2466 out:
2467 	if (param)
2468 		free(param, M_DEVBUF);
2469 	if (tr)
2470 		twa_release_request(tr);
2471 	return(error);
2472 }
2473 
2474 /*
2475  * Function name:	twa_init_connection
2476  * Description:		Send init_connection cmd to firmware
2477  *
2478  * Input:		sc		-- ptr to per ctlr structure
2479  *			message_credits	-- max # of requests that we might send
2480  *					 down simultaneously.  This will be
2481  *					 typically set to 256 at init-time or
2482  *					after a reset, and to 1 at shutdown-time
2483  *			set_features	-- indicates if we intend to use 64-bit
2484  *					sg, also indicates if we want to do a
2485  *					basic or an extended init_connection;
2486  *
2487  * Note: The following input/output parameters are valid, only in case of an
2488  *		extended init_connection:
2489  *
2490  *			current_fw_srl		-- srl of fw we are bundled
2491  *						with, if any; 0 otherwise
2492  *			current_fw_arch_id	-- arch_id of fw we are bundled
2493  *						with, if any; 0 otherwise
2494  *			current_fw_branch	-- branch # of fw we are bundled
2495  *						with, if any; 0 otherwise
2496  *			current_fw_build	-- build # of fw we are bundled
2497  *						with, if any; 0 otherwise
2498  * Output:		fw_on_ctlr_srl		-- srl of fw on ctlr
2499  *			fw_on_ctlr_arch_id	-- arch_id of fw on ctlr
2500  *			fw_on_ctlr_branch	-- branch # of fw on ctlr
2501  *			fw_on_ctlr_build	-- build # of fw on ctlr
2502  *			init_connect_result	-- result bitmap of fw response
2503  * Return value:	0	-- success
2504  *			non-zero-- failure
2505  */
2506 static int
2507 twa_init_connection(struct twa_softc *sc, uint16_t message_credits,
2508     uint32_t set_features, uint16_t current_fw_srl,
2509     uint16_t current_fw_arch_id, uint16_t current_fw_branch,
2510     uint16_t current_fw_build, uint16_t *fw_on_ctlr_srl,
2511     uint16_t *fw_on_ctlr_arch_id, uint16_t *fw_on_ctlr_branch,
2512     uint16_t *fw_on_ctlr_build, uint32_t *init_connect_result)
2513 {
2514 	struct twa_request		*tr;
2515 	struct twa_command_init_connect	*init_connect;
2516 	int				error = 1;
2517 
2518 	/* Get a request packet. */
2519 	if ((tr = twa_get_request(sc, 0)) == NULL)
2520 		goto out;
2521 	tr->tr_cmd_pkt_type |= TWA_CMD_PKT_TYPE_INTERNAL;
2522 	/* Build the cmd pkt. */
2523 	init_connect = &(tr->tr_command->command.cmd_pkt_7k.init_connect);
2524 
2525 	tr->tr_command->cmd_hdr.header_desc.size_header = 128;
2526 
2527 	init_connect->opcode = TWA_OP_INIT_CONNECTION;
2528    	init_connect->request_id = tr->tr_request_id;
2529 	init_connect->message_credits = message_credits;
2530 	init_connect->features = set_features;
2531 	if (TWA_64BIT_ADDRESSES)
2532 		init_connect->features |= TWA_64BIT_SG_ADDRESSES;
2533 	if (set_features & TWA_EXTENDED_INIT_CONNECT) {
2534 		/*
2535 		 * Fill in the extra fields needed for
2536 		 * an extended init_connect.
2537 		 */
2538 		init_connect->size = 6;
2539 		init_connect->fw_srl = current_fw_srl;
2540 		init_connect->fw_arch_id = current_fw_arch_id;
2541 		init_connect->fw_branch = current_fw_branch;
2542 	} else
2543 		init_connect->size = 3;
2544 
2545 	/* Submit the command, and wait for it to complete. */
2546 	error = twa_immediate_request(tr, TWA_REQUEST_TIMEOUT_PERIOD);
2547 	if (error == ETIMEDOUT)
2548 		return(error); /* clean-up done by twa_immediate_request */
2549 	if (error)
2550 		goto out;
2551 	if ((error = init_connect->status)) {
2552 		/* twa_drain_complete_queue will have done the unmapping */
2553 		goto out;
2554 	}
2555 	if (set_features & TWA_EXTENDED_INIT_CONNECT) {
2556 		*fw_on_ctlr_srl = init_connect->fw_srl;
2557 		*fw_on_ctlr_arch_id = init_connect->fw_arch_id;
2558 		*fw_on_ctlr_branch = init_connect->fw_branch;
2559 		*fw_on_ctlr_build = init_connect->fw_build;
2560 		*init_connect_result = init_connect->result;
2561 	}
2562 	twa_release_request(tr);
2563 	return(error);
2564 
2565 out:
2566 	if (tr)
2567 		twa_release_request(tr);
2568 	return(error);
2569 }
2570 
2571 static int
2572 twa_reset(struct twa_softc *sc)
2573 {
2574 	int	s;
2575 	int	error = 0;
2576 
2577 	/* Set the 'in reset' flag. */
2578 	sc->twa_sc_flags |= TWA_STATE_IN_RESET;
2579 
2580 	/*
2581 	 * Disable interrupts from the controller, and mask any
2582 	 * accidental entry into our interrupt handler.
2583 	 */
2584 	twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
2585 		TWA_CONTROL_DISABLE_INTERRUPTS);
2586 
2587 	s = splbio();
2588 
2589 	/* Soft reset the controller. */
2590 	if ((error = twa_soft_reset(sc)))
2591 		goto out;
2592 
2593 	/* Re-establish logical connection with the controller. */
2594 	if ((error = twa_init_connection(sc, TWA_INIT_MESSAGE_CREDITS,
2595 					0, 0, 0, 0, 0,
2596 					NULL, NULL, NULL, NULL, NULL))) {
2597 		goto out;
2598 	}
2599 	/*
2600 	 * Complete all requests in the complete queue; error back all requests
2601 	 * in the busy queue.  Any internal requests will be simply freed.
2602 	 * Re-submit any requests in the pending queue.
2603 	 */
2604 	twa_drain_busy_queue(sc);
2605 
2606 out:
2607 	splx(s);
2608 	/*
2609 	 * Enable interrupts, and also clear attention and response interrupts.
2610 	 */
2611 	twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
2612 		TWA_CONTROL_CLEAR_ATTENTION_INTERRUPT |
2613 		TWA_CONTROL_UNMASK_RESPONSE_INTERRUPT |
2614 		TWA_CONTROL_ENABLE_INTERRUPTS);
2615 
2616 	/* Clear the 'in reset' flag. */
2617 	sc->twa_sc_flags &= ~TWA_STATE_IN_RESET;
2618 
2619 	return(error);
2620 }
2621 
2622 static int
2623 twa_soft_reset(struct twa_softc *sc)
2624 {
2625 	uint32_t	status_reg;
2626 
2627 	twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
2628 			TWA_CONTROL_ISSUE_SOFT_RESET |
2629 			TWA_CONTROL_CLEAR_HOST_INTERRUPT |
2630 			TWA_CONTROL_CLEAR_ATTENTION_INTERRUPT |
2631 			TWA_CONTROL_MASK_COMMAND_INTERRUPT |
2632 			TWA_CONTROL_MASK_RESPONSE_INTERRUPT |
2633 			TWA_CONTROL_DISABLE_INTERRUPTS);
2634 
2635 	if (twa_drain_response_queue_large(sc, 30) != 0) {
2636 		aprint_error_dev(sc->twa_dv,
2637 		    "response queue not empty after reset.\n");
2638 		return(1);
2639 	}
2640 	if (twa_wait_status(sc, TWA_STATUS_MICROCONTROLLER_READY |
2641 				TWA_STATUS_ATTENTION_INTERRUPT, 30)) {
2642 		aprint_error_dev(sc->twa_dv,
2643 		    "no attention interrupt after reset.\n");
2644 		return(1);
2645 	}
2646 	twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
2647 		TWA_CONTROL_CLEAR_ATTENTION_INTERRUPT);
2648 
2649 	if (twa_drain_response_queue(sc)) {
2650 		aprint_error_dev(sc->twa_dv, "cannot drain response queue.\n");
2651 		return(1);
2652 	}
2653 	if (twa_drain_aen_queue(sc)) {
2654 		aprint_error_dev(sc->twa_dv, "cannot drain AEN queue.\n");
2655 		return(1);
2656 	}
2657 	if (twa_find_aen(sc, TWA_AEN_SOFT_RESET)) {
2658 		aprint_error_dev(sc->twa_dv,
2659 		    "reset not reported by controller.\n");
2660 		return(1);
2661 	}
2662 	status_reg = twa_inl(sc, TWA_STATUS_REGISTER_OFFSET);
2663 	if (TWA_STATUS_ERRORS(status_reg) ||
2664 	    twa_check_ctlr_state(sc, status_reg)) {
2665 		aprint_error_dev(sc->twa_dv, "controller errors detected.\n");
2666 		return(1);
2667 	}
2668 	return(0);
2669 }
2670 
2671 static int
2672 twa_wait_status(struct twa_softc *sc, uint32_t status, uint32_t timeout)
2673 {
2674 	struct timeval		t1;
2675 	time_t		end_time;
2676 	uint32_t	status_reg;
2677 
2678 	timeout = (timeout * 1000 * 100);
2679 
2680 	microtime(&t1);
2681 
2682 	end_time = t1.tv_usec + timeout;
2683 
2684 	do {
2685 		status_reg = twa_inl(sc, TWA_STATUS_REGISTER_OFFSET);
2686 		/* got the required bit(s)? */
2687 		if ((status_reg & status) == status)
2688 			return(0);
2689 		DELAY(100000);
2690 		microtime(&t1);
2691 	} while (t1.tv_usec <= end_time);
2692 
2693 	return(1);
2694 }
2695 
2696 static int
2697 twa_fetch_aen(struct twa_softc *sc)
2698 {
2699 	struct twa_request	*tr;
2700 	int			s, error = 0;
2701 
2702 	s = splbio();
2703 
2704 	if ((tr = twa_get_request(sc, TWA_CMD_AEN)) == NULL) {
2705 		splx(s);
2706 		return(EIO);
2707 	}
2708 	tr->tr_cmd_pkt_type |= TWA_CMD_PKT_TYPE_INTERNAL;
2709 	tr->tr_callback = twa_aen_callback;
2710 	tr->tr_data = malloc(TWA_SECTOR_SIZE, M_DEVBUF, M_NOWAIT);
2711 	if (twa_request_sense(tr, 0) != 0) {
2712 		if (tr->tr_data)
2713 			free(tr->tr_data, M_DEVBUF);
2714 		twa_release_request(tr);
2715 		error = 1;
2716 	}
2717 	splx(s);
2718 
2719 	return(error);
2720 }
2721 
2722 /*
2723  * Function name:	twa_aen_callback
2724  * Description:		Callback for requests to fetch AEN's.
2725  *
2726  * Input:		tr	-- ptr to completed request pkt
2727  * Output:		None
2728  * Return value:	None
2729  */
2730 static void
2731 twa_aen_callback(struct twa_request *tr)
2732 {
2733 	int i;
2734 	int fetch_more_aens = 0;
2735 	struct twa_softc		*sc = tr->tr_sc;
2736 	struct twa_command_header	*cmd_hdr =
2737 		(struct twa_command_header *)(tr->tr_data);
2738 	struct twa_command_9k		*cmd =
2739 		&(tr->tr_command->command.cmd_pkt_9k);
2740 
2741 	if (! cmd->status) {
2742 		if ((tr->tr_cmd_pkt_type & TWA_CMD_PKT_TYPE_9K) &&
2743 			(cmd->cdb[0] == 0x3 /* REQUEST_SENSE */))
2744 			if (twa_enqueue_aen(sc, cmd_hdr)
2745 				!= TWA_AEN_QUEUE_EMPTY)
2746 				fetch_more_aens = 1;
2747 	} else {
2748 		cmd_hdr->err_specific_desc[sizeof(cmd_hdr->err_specific_desc) - 1] = '\0';
2749 		for (i = 0; i < 18; i++)
2750 			printf("%x\t", tr->tr_command->cmd_hdr.sense_data[i]);
2751 		printf("\n"); /* print new line */
2752 
2753 		for (i = 0; i < 128; i++)
2754 			printf("%x\t", ((int8_t *)(tr->tr_data))[i]);
2755 		printf("\n"); /* print new line */
2756 	}
2757 	if (tr->tr_data)
2758 		free(tr->tr_data, M_DEVBUF);
2759 	twa_release_request(tr);
2760 
2761 	if (fetch_more_aens)
2762 		twa_fetch_aen(sc);
2763 }
2764 
2765 /*
2766  * Function name:	twa_enqueue_aen
2767  * Description:		Queues AEN's to be supplied to user-space tools on request.
2768  *
2769  * Input:		sc	-- ptr to per ctlr structure
2770  *			cmd_hdr	-- ptr to hdr of fw cmd pkt, from where the AEN
2771  *				   details can be retrieved.
2772  * Output:		None
2773  * Return value:	None
2774  */
2775 static uint16_t
2776 twa_enqueue_aen(struct twa_softc *sc, struct twa_command_header *cmd_hdr)
2777 {
2778 	int			rv __diagused, s;
2779 	struct tw_cl_event_packet *event;
2780 	uint16_t		aen_code;
2781 	unsigned long		sync_time;
2782 
2783 	s = splbio();
2784 	aen_code = cmd_hdr->status_block.error;
2785 
2786 	switch (aen_code) {
2787 	case TWA_AEN_SYNC_TIME_WITH_HOST:
2788 
2789 		sync_time = (time_second - (3 * 86400)) % 604800;
2790 		rv = twa_set_param(sc, TWA_PARAM_TIME_TABLE,
2791 				TWA_PARAM_TIME_SchedulerTime, 4,
2792 				&sync_time, twa_aen_callback);
2793 #ifdef DIAGNOSTIC
2794 		if (rv != 0)
2795 			aprint_error_dev(sc->twa_dv,
2796 			    "unable to sync time with ctlr\n");
2797 #endif
2798 		break;
2799 
2800 	case TWA_AEN_QUEUE_EMPTY:
2801 		break;
2802 
2803 	default:
2804 		/* Queue the event. */
2805 		event = sc->twa_aen_queue[sc->twa_aen_head];
2806 		if (event->retrieved == TWA_AEN_NOT_RETRIEVED)
2807 			sc->twa_aen_queue_overflow = TRUE;
2808 		event->severity =
2809 			cmd_hdr->status_block.substatus_block.severity;
2810 		event->time_stamp_sec = time_second;
2811 		event->aen_code = aen_code;
2812 		event->retrieved = TWA_AEN_NOT_RETRIEVED;
2813 		event->sequence_id = ++(sc->twa_current_sequence_id);
2814 		cmd_hdr->err_specific_desc[sizeof(cmd_hdr->err_specific_desc) - 1] = '\0';
2815 		event->parameter_len = strlen(cmd_hdr->err_specific_desc);
2816 		memcpy(event->parameter_data, cmd_hdr->err_specific_desc,
2817 			event->parameter_len);
2818 
2819 		if (event->severity < TWA_AEN_SEVERITY_DEBUG) {
2820 			printf("%s: AEN 0x%04X: %s: %s: %s\n",
2821 				device_xname(sc->twa_dv),
2822 				aen_code,
2823 				twa_aen_severity_table[event->severity],
2824 				twa_find_msg_string(twa_aen_table, aen_code),
2825 				event->parameter_data);
2826 		}
2827 
2828 		if ((sc->twa_aen_head + 1) == TWA_Q_LENGTH)
2829 			sc->twa_aen_queue_wrapped = TRUE;
2830 		sc->twa_aen_head = (sc->twa_aen_head + 1) % TWA_Q_LENGTH;
2831 		break;
2832 	} /* switch */
2833 	splx(s);
2834 
2835 	return (aen_code);
2836 }
2837 
2838 /*
2839  * Function name:	twa_find_aen
2840  * Description:		Reports whether a given AEN ever occurred.
2841  *
2842  * Input:		sc	-- ptr to per ctlr structure
2843  *			aen_code-- AEN to look for
2844  * Output:		None
2845  * Return value:	0	-- success
2846  *			non-zero-- failure
2847  */
2848 static int
2849 twa_find_aen(struct twa_softc *sc, uint16_t aen_code)
2850 {
2851 	uint32_t	last_index;
2852 	int		s;
2853 	int		i;
2854 
2855 	s = splbio();
2856 
2857 	if (sc->twa_aen_queue_wrapped)
2858 		last_index = sc->twa_aen_head;
2859 	else
2860 		last_index = 0;
2861 
2862 	i = sc->twa_aen_head;
2863 	do {
2864 		i = (i + TWA_Q_LENGTH - 1) % TWA_Q_LENGTH;
2865 		if ((sc->twa_aen_queue[i])->aen_code == aen_code) {
2866 			splx(s);
2867 			return(0);
2868 		}
2869 	} while (i != last_index);
2870 
2871 	splx(s);
2872 	return(1);
2873 }
2874 
2875 static inline void
2876 twa_request_init(struct twa_request *tr, int flags)
2877 {
2878 	tr->tr_data = NULL;
2879 	tr->tr_real_data = NULL;
2880 	tr->tr_length = 0;
2881 	tr->tr_real_length = 0;
2882 	tr->tr_status = TWA_CMD_SETUP;/* command is in setup phase */
2883 	tr->tr_flags = flags;
2884 	tr->tr_error = 0;
2885 	tr->tr_callback = NULL;
2886 	tr->tr_cmd_pkt_type = 0;
2887 	tr->bp = 0;
2888 
2889 	/*
2890 	 * Look at the status field in the command packet to see how
2891 	 * it completed the last time it was used, and zero out only
2892 	 * the portions that might have changed.  Note that we don't
2893 	 * care to zero out the sglist.
2894 	 */
2895 	if (tr->tr_command->command.cmd_pkt_9k.status)
2896 		memset(tr->tr_command, 0,
2897 			sizeof(struct twa_command_header) + 28);
2898 	else
2899 		memset(&(tr->tr_command->command), 0, 28);
2900 }
2901 
2902 struct twa_request *
2903 twa_get_request_wait(struct twa_softc *sc, int flags)
2904 {
2905 	struct twa_request *tr;
2906 	int s;
2907 
2908 	KASSERT((flags & TWA_CMD_AEN) == 0);
2909 
2910 	s = splbio();
2911 	while ((tr = TAILQ_FIRST(&sc->twa_free)) == NULL) {
2912 		sc->twa_sc_flags |= TWA_STATE_REQUEST_WAIT;
2913 		(void) tsleep(&sc->twa_free, PRIBIO, "twaccb", hz);
2914 	}
2915 	TAILQ_REMOVE(&sc->twa_free, tr, tr_link);
2916 
2917 	splx(s);
2918 
2919 	twa_request_init(tr, flags);
2920 
2921 	return(tr);
2922 }
2923 
2924 struct twa_request *
2925 twa_get_request(struct twa_softc *sc, int flags)
2926 {
2927 	int s;
2928 	struct twa_request *tr;
2929 
2930 	/* Get a free request packet. */
2931 	s = splbio();
2932 	if (__predict_false((flags & TWA_CMD_AEN) != 0)) {
2933 
2934 		if ((sc->sc_twa_request->tr_flags & TWA_CMD_AEN_BUSY) == 0) {
2935 			tr = sc->sc_twa_request;
2936 			flags |= TWA_CMD_AEN_BUSY;
2937 		} else {
2938 			splx(s);
2939 			return (NULL);
2940 		}
2941 	} else {
2942 		if (__predict_false((tr =
2943 				TAILQ_FIRST(&sc->twa_free)) == NULL)) {
2944 			splx(s);
2945 			return (NULL);
2946 		}
2947 		TAILQ_REMOVE(&sc->twa_free, tr, tr_link);
2948 	}
2949 	splx(s);
2950 
2951 	twa_request_init(tr, flags);
2952 
2953 	return(tr);
2954 }
2955 
2956 /*
2957  * Print some information about the controller
2958  */
2959 static void
2960 twa_describe_controller(struct twa_softc *sc)
2961 {
2962 	struct twa_param_9k	*p[10];
2963 	int			i, rv = 0;
2964 	uint32_t		dsize;
2965 	uint8_t			ports;
2966 
2967 	memset(p, 0, sizeof(p));
2968 
2969 	/* Get the port count. */
2970 	rv |= twa_get_param(sc, TWA_PARAM_CONTROLLER,
2971 		TWA_PARAM_CONTROLLER_PortCount, 1, NULL, &p[0]);
2972 
2973 	/* get version strings */
2974 	rv |= twa_get_param(sc, TWA_PARAM_VERSION, TWA_PARAM_VERSION_FW,
2975 		16, NULL, &p[1]);
2976 	rv |= twa_get_param(sc, TWA_PARAM_VERSION, TWA_PARAM_VERSION_BIOS,
2977 		16, NULL, &p[2]);
2978 	rv |= twa_get_param(sc, TWA_PARAM_VERSION, TWA_PARAM_VERSION_Mon,
2979 		16, NULL, &p[3]);
2980 	rv |= twa_get_param(sc, TWA_PARAM_VERSION, TWA_PARAM_VERSION_PCBA,
2981 		8, NULL, &p[4]);
2982 	rv |= twa_get_param(sc, TWA_PARAM_VERSION, TWA_PARAM_VERSION_ATA,
2983 		8, NULL, &p[5]);
2984 	rv |= twa_get_param(sc, TWA_PARAM_VERSION, TWA_PARAM_VERSION_PCI,
2985 		8, NULL, &p[6]);
2986 	rv |= twa_get_param(sc, TWA_PARAM_DRIVESUMMARY, TWA_PARAM_DRIVESTATUS,
2987 		16, NULL, &p[7]);
2988 
2989 	if (rv) {
2990 		/* some error occurred */
2991 		aprint_error_dev(sc->twa_dv,
2992 		    "failed to fetch version information\n");
2993 		goto bail;
2994 	}
2995 
2996 	ports = *(uint8_t *)(p[0]->data);
2997 
2998 	aprint_normal_dev(sc->twa_dv, "%d ports, Firmware %.16s, BIOS %.16s\n",
2999 		ports, p[1]->data, p[2]->data);
3000 
3001 	aprint_verbose_dev(sc->twa_dv,
3002 	    "Monitor %.16s, PCB %.8s, Achip %.8s, Pchip %.8s\n",
3003 		p[3]->data, p[4]->data,
3004 		p[5]->data, p[6]->data);
3005 
3006 	for (i = 0; i < ports; i++) {
3007 
3008 		if ((*((char *)(p[7]->data + i)) & TWA_DRIVE_DETECTED) == 0)
3009 			continue;
3010 
3011 		rv = twa_get_param(sc, TWA_PARAM_DRIVE_TABLE + i,
3012 			TWA_PARAM_DRIVEMODELINDEX,
3013 			TWA_PARAM_DRIVEMODEL_LENGTH, NULL, &p[8]);
3014 
3015 		if (rv != 0) {
3016 			aprint_error_dev(sc->twa_dv,
3017 			    "unable to get drive model for port %d\n", i);
3018 			continue;
3019 		}
3020 
3021 		rv = twa_get_param(sc, TWA_PARAM_DRIVE_TABLE + i,
3022 			TWA_PARAM_DRIVESIZEINDEX,
3023 			TWA_PARAM_DRIVESIZE_LENGTH, NULL, &p[9]);
3024 
3025 		if (rv != 0) {
3026 			aprint_error_dev(sc->twa_dv, "unable to get drive size"
3027 			    " for port %d\n", i);
3028 			free(p[8], M_DEVBUF);
3029 			continue;
3030 		}
3031 
3032 		dsize = *(uint32_t *)(p[9]->data);
3033 
3034 		aprint_verbose_dev(sc->twa_dv, "port %d: %.40s %d MB\n",
3035 		    i, p[8]->data, dsize / 2048);
3036 
3037 		if (p[8])
3038 			free(p[8], M_DEVBUF);
3039 		if (p[9])
3040 			free(p[9], M_DEVBUF);
3041 	}
3042 bail:
3043 	if (p[0])
3044 		free(p[0], M_DEVBUF);
3045 	if (p[1])
3046 		free(p[1], M_DEVBUF);
3047 	if (p[2])
3048 		free(p[2], M_DEVBUF);
3049 	if (p[3])
3050 		free(p[3], M_DEVBUF);
3051 	if (p[4])
3052 		free(p[4], M_DEVBUF);
3053 	if (p[5])
3054 		free(p[5], M_DEVBUF);
3055 	if (p[6])
3056 		free(p[6], M_DEVBUF);
3057 }
3058 
3059 /*
3060  * Function name:	twa_check_ctlr_state
3061  * Description:		Makes sure that the fw status register reports a
3062  *			proper status.
3063  *
3064  * Input:		sc		-- ptr to per ctlr structure
3065  *			status_reg	-- value in the status register
3066  * Output:		None
3067  * Return value:	0	-- no errors
3068  *			non-zero-- errors
3069  */
3070 static int
3071 twa_check_ctlr_state(struct twa_softc *sc, uint32_t status_reg)
3072 {
3073 	int		result = 0;
3074 	struct timeval	t1;
3075 	static time_t	last_warning[2] = {0, 0};
3076 
3077 	/* Check if the 'micro-controller ready' bit is not set. */
3078 	if ((status_reg & TWA_STATUS_EXPECTED_BITS) !=
3079 				TWA_STATUS_EXPECTED_BITS) {
3080 
3081 		microtime(&t1);
3082 
3083 		last_warning[0] += (5 * 1000 * 100);
3084 
3085 		if (t1.tv_usec > last_warning[0]) {
3086 			microtime(&t1);
3087 			last_warning[0] = t1.tv_usec;
3088 		}
3089 		result = 1;
3090 	}
3091 
3092 	/* Check if any error bits are set. */
3093 	if ((status_reg & TWA_STATUS_UNEXPECTED_BITS) != 0) {
3094 
3095 		microtime(&t1);
3096 		last_warning[1] += (5 * 1000 * 100);
3097 		if (t1.tv_usec > last_warning[1]) {
3098 		     	microtime(&t1);
3099 			last_warning[1] = t1.tv_usec;
3100 		}
3101 		if (status_reg & TWA_STATUS_PCI_PARITY_ERROR_INTERRUPT) {
3102 			aprint_error_dev(sc->twa_dv, "clearing PCI parity "
3103 			    "error re-seat/move/replace card.\n");
3104 			twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
3105 				TWA_CONTROL_CLEAR_PARITY_ERROR);
3106 			pci_conf_write(sc->pc, sc->tag,
3107 				PCI_COMMAND_STATUS_REG,
3108 				TWA_PCI_CONFIG_CLEAR_PARITY_ERROR);
3109 		}
3110 		if (status_reg & TWA_STATUS_PCI_ABORT_INTERRUPT) {
3111 			aprint_error_dev(sc->twa_dv, "clearing PCI abort\n");
3112 			twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
3113 				TWA_CONTROL_CLEAR_PCI_ABORT);
3114 			pci_conf_write(sc->pc, sc->tag,
3115 				PCI_COMMAND_STATUS_REG,
3116 				TWA_PCI_CONFIG_CLEAR_PCI_ABORT);
3117 		}
3118 		if (status_reg & TWA_STATUS_QUEUE_ERROR_INTERRUPT) {
3119  			/*
3120 			 * As documented by 3ware, the 9650 erroneously
3121 			 * flags queue errors during resets.
3122 			 * Just ignore them during the reset instead of
3123 			 * bothering the console.
3124  			 */
3125  			if ((sc->sc_product_id != PCI_PRODUCT_3WARE_9650) ||
3126  			    ((sc->twa_sc_flags & TWA_STATE_IN_RESET) == 0)) {
3127  				aprint_error_dev(sc->twa_dv,
3128  				    "clearing controller queue error\n");
3129  			}
3130 
3131   			twa_outl(sc, TWA_CONTROL_REGISTER_OFFSET,
3132  				TWA_CONTROL_CLEAR_QUEUE_ERROR);
3133 		}
3134 		if (status_reg & TWA_STATUS_MICROCONTROLLER_ERROR) {
3135 			aprint_error_dev(sc->twa_dv,
3136 			    "micro-controller error\n");
3137 			result = 1;
3138 		}
3139 	}
3140 	return(result);
3141 }
3142 
3143 MODULE(MODULE_CLASS_DRIVER, twa, "pci");
3144 
3145 #ifdef _MODULE
3146 #include "ioconf.c"
3147 #endif
3148 
3149 static int
3150 twa_modcmd(modcmd_t cmd, void *opaque)
3151 {
3152 	int error = 0;
3153 
3154 #ifdef _MODULE
3155 	switch (cmd) {
3156 	case MODULE_CMD_INIT:
3157 		error = config_init_component(cfdriver_ioconf_twa,
3158 		    cfattach_ioconf_twa, cfdata_ioconf_twa);
3159 		break;
3160 	case MODULE_CMD_FINI:
3161 		error = config_fini_component(cfdriver_ioconf_twa,
3162 		    cfattach_ioconf_twa, cfdata_ioconf_twa);
3163 		break;
3164 	default:
3165 		error = ENOTTY;
3166 		break;
3167 	}
3168 #endif
3169 
3170 	return error;
3171 }
3172