xref: /dragonfly/sys/dev/raid/amr/amr.c (revision 93cb5144)
1 /*-
2  * Copyright (c) 1999,2000 Michael Smith
3  * Copyright (c) 2000 BSDi
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * Copyright (c) 2002 Eric Moore
28  * Copyright (c) 2002 LSI Logic Corporation
29  * All rights reserved.
30  *
31  * Redistribution and use in source and binary forms, with or without
32  * modification, are permitted provided that the following conditions
33  * are met:
34  * 1. Redistributions of source code must retain the above copyright
35  *    notice, this list of conditions and the following disclaimer.
36  * 2. Redistributions in binary form must reproduce the above copyright
37  *    notice, this list of conditions and the following disclaimer in the
38  *    documentation and/or other materials provided with the distribution.
39  * 3. The party using or redistributing the source code and binary forms
40  *    agrees to the disclaimer below and the terms and conditions set forth
41  *    herein.
42  *
43  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
44  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
47  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53  * SUCH DAMAGE.
54  *
55  *	$FreeBSD: src/sys/dev/amr/amr.c,v 1.7.2.13 2003/01/15 13:41:18 emoore Exp $
56  *	$DragonFly: src/sys/dev/raid/amr/amr.c,v 1.24 2007/05/15 22:44:09 dillon Exp $
57  */
58 
59 /*
60  * Driver for the AMI MegaRaid family of controllers.
61  */
62 
63 #include <sys/param.h>
64 #include <sys/systm.h>
65 #include <sys/malloc.h>
66 #include <sys/kernel.h>
67 
68 #include "amr_compat.h"
69 #include <sys/bus.h>
70 #include <sys/conf.h>
71 #include <sys/devicestat.h>
72 #include <sys/disk.h>
73 #include <sys/stat.h>
74 #include <sys/rman.h>
75 
76 #include <bus/pci/pcireg.h>
77 #include <bus/pci/pcivar.h>
78 
79 #include "amrio.h"
80 #include "amrreg.h"
81 #include "amrvar.h"
82 #define AMR_DEFINE_TABLES
83 #include "amr_tables.h"
84 
85 #define AMR_CDEV_MAJOR	132
86 
87 static d_open_t         amr_open;
88 static d_close_t        amr_close;
89 static d_ioctl_t        amr_ioctl;
90 
91 static struct dev_ops amr_ops = {
92 	{ "amr", AMR_CDEV_MAJOR, 0 },
93 	.d_open =	amr_open,
94 	.d_close =	amr_close,
95 	.d_ioctl =	amr_ioctl
96 };
97 
98 /*
99  * Initialisation, bus interface.
100  */
101 static void	amr_startup(void *arg);
102 
103 /*
104  * Command wrappers
105  */
106 static int	amr_query_controller(struct amr_softc *sc);
107 static void	*amr_enquiry(struct amr_softc *sc, size_t bufsize,
108 			     u_int8_t cmd, u_int8_t cmdsub, u_int8_t cmdqual);
109 static void	amr_completeio(struct amr_command *ac);
110 static int	amr_support_ext_cdb(struct amr_softc *sc);
111 
112 /*
113  * Command buffer allocation.
114  */
115 static void	amr_alloccmd_cluster(struct amr_softc *sc);
116 static void	amr_freecmd_cluster(struct amr_command_cluster *acc);
117 
118 /*
119  * Command processing.
120  */
121 static int	amr_bio_command(struct amr_softc *sc, struct amr_command **acp);
122 static int	amr_wait_command(struct amr_command *ac);
123 static int	amr_getslot(struct amr_command *ac);
124 static void	amr_mapcmd(struct amr_command *ac);
125 static void	amr_unmapcmd(struct amr_command *ac);
126 static int	amr_start(struct amr_command *ac);
127 static void	amr_complete(void *context, int pending);
128 
129 /*
130  * Status monitoring
131  */
132 static void	amr_periodic(void *data);
133 
134 /*
135  * Interface-specific shims
136  */
137 static int	amr_quartz_submit_command(struct amr_softc *sc);
138 static int	amr_quartz_get_work(struct amr_softc *sc, struct amr_mailbox *mbsave);
139 static int	amr_quartz_poll_command(struct amr_command *ac);
140 
141 static int	amr_std_submit_command(struct amr_softc *sc);
142 static int	amr_std_get_work(struct amr_softc *sc, struct amr_mailbox *mbsave);
143 static int	amr_std_poll_command(struct amr_command *ac);
144 static void	amr_std_attach_mailbox(struct amr_softc *sc);
145 
146 #ifdef AMR_BOARD_INIT
147 static int	amr_quartz_init(struct amr_softc *sc);
148 static int	amr_std_init(struct amr_softc *sc);
149 #endif
150 
151 /*
152  * Debugging
153  */
154 static void	amr_describe_controller(struct amr_softc *sc);
155 #ifdef AMR_DEBUG
156 #if 0
157 static void	amr_printcommand(struct amr_command *ac);
158 #endif
159 #endif
160 
161 DECLARE_DUMMY_MODULE(amr);
162 
163 /********************************************************************************
164  ********************************************************************************
165                                                                       Inline Glue
166  ********************************************************************************
167  ********************************************************************************/
168 
169 /********************************************************************************
170  ********************************************************************************
171                                                                 Public Interfaces
172  ********************************************************************************
173  ********************************************************************************/
174 
175 /********************************************************************************
176  * Initialise the controller and softc.
177  */
178 int
179 amr_attach(struct amr_softc *sc)
180 {
181 
182     debug_called(1);
183 
184     /*
185      * Initialise per-controller queues.
186      */
187     TAILQ_INIT(&sc->amr_completed);
188     TAILQ_INIT(&sc->amr_freecmds);
189     TAILQ_INIT(&sc->amr_cmd_clusters);
190     TAILQ_INIT(&sc->amr_ready);
191     bioq_init(&sc->amr_bioq);
192 
193 #if defined(__FreeBSD__) && __FreeBSD_version >= 500005
194     /*
195      * Initialise command-completion task.
196      */
197     TASK_INIT(&sc->amr_task_complete, 0, amr_complete, sc);
198 #endif
199 
200     debug(2, "queue init done");
201 
202     /*
203      * Configure for this controller type.
204      */
205     if (AMR_IS_QUARTZ(sc)) {
206 	sc->amr_submit_command = amr_quartz_submit_command;
207 	sc->amr_get_work       = amr_quartz_get_work;
208 	sc->amr_poll_command   = amr_quartz_poll_command;
209     } else {
210 	sc->amr_submit_command = amr_std_submit_command;
211 	sc->amr_get_work       = amr_std_get_work;
212 	sc->amr_poll_command   = amr_std_poll_command;
213 	amr_std_attach_mailbox(sc);
214     }
215 
216 #ifdef AMR_BOARD_INIT
217     if ((AMR_IS_QUARTZ(sc) ? amr_quartz_init(sc) : amr_std_init(sc))))
218 	return(ENXIO);
219 #endif
220 
221     /*
222      * Quiz controller for features and limits.
223      */
224     if (amr_query_controller(sc))
225 	return(ENXIO);
226 
227     debug(2, "controller query complete");
228 
229     /*
230      * Attach our 'real' SCSI channels to CAM.
231      */
232     if (amr_cam_attach(sc))
233 	return(ENXIO);
234     debug(2, "CAM attach done");
235 
236     /*
237      * Create the control device.
238      */
239     dev_ops_add(&amr_ops, -1, device_get_unit(sc->amr_dev));
240     sc->amr_dev_t = make_dev(&amr_ops, device_get_unit(sc->amr_dev),
241 			    UID_ROOT, GID_OPERATOR, S_IRUSR | S_IWUSR,
242 			    "amr%d", device_get_unit(sc->amr_dev));
243     sc->amr_dev_t->si_drv1 = sc;
244     reference_dev(sc->amr_dev_t);
245 
246     /*
247      * Schedule ourselves to bring the controller up once interrupts are
248      * available.
249      */
250     bzero(&sc->amr_ich, sizeof(struct intr_config_hook));
251     sc->amr_ich.ich_func = amr_startup;
252     sc->amr_ich.ich_arg = sc;
253     sc->amr_ich.ich_desc = "amr";
254     if (config_intrhook_establish(&sc->amr_ich) != 0) {
255 	device_printf(sc->amr_dev, "can't establish configuration hook\n");
256 	return(ENOMEM);
257     }
258 
259     /*
260      * Print a little information about the controller.
261      */
262     amr_describe_controller(sc);
263 
264     debug(2, "attach complete");
265     return(0);
266 }
267 
268 /********************************************************************************
269  * Locate disk resources and attach children to them.
270  */
271 static void
272 amr_startup(void *arg)
273 {
274     struct amr_softc	*sc = (struct amr_softc *)arg;
275     struct amr_logdrive	*dr;
276     int			i, error;
277 
278     debug_called(1);
279     callout_init(&sc->amr_timeout);
280 
281     /* pull ourselves off the intrhook chain */
282     config_intrhook_disestablish(&sc->amr_ich);
283 
284     /* get up-to-date drive information */
285     if (amr_query_controller(sc)) {
286 	device_printf(sc->amr_dev, "can't scan controller for drives\n");
287 	return;
288     }
289 
290     /* iterate over available drives */
291     for (i = 0, dr = &sc->amr_drive[0]; (i < AMR_MAXLD) && (dr->al_size != 0xffffffff); i++, dr++) {
292 	/* are we already attached to this drive? */
293 	if (dr->al_disk == 0) {
294 	    /* generate geometry information */
295 	    if (dr->al_size > 0x200000) {	/* extended translation? */
296 		dr->al_heads = 255;
297 		dr->al_sectors = 63;
298 	    } else {
299 		dr->al_heads = 64;
300 		dr->al_sectors = 32;
301 	    }
302 	    dr->al_cylinders = dr->al_size / (dr->al_heads * dr->al_sectors);
303 
304 	    dr->al_disk = device_add_child(sc->amr_dev, NULL, -1);
305 	    if (dr->al_disk == 0)
306 		device_printf(sc->amr_dev, "device_add_child failed\n");
307 	    device_set_ivars(dr->al_disk, dr);
308 	}
309     }
310 
311     if ((error = bus_generic_attach(sc->amr_dev)) != 0)
312 	device_printf(sc->amr_dev, "bus_generic_attach returned %d\n", error);
313 
314     /* mark controller back up */
315     sc->amr_state &= ~AMR_STATE_SHUTDOWN;
316 
317     /* interrupts will be enabled before we do anything more */
318     sc->amr_state |= AMR_STATE_INTEN;
319 
320     /*
321      * Start the timeout routine.
322      */
323 /*    callout_reset(&sc->amr_timeout, hz, amr_periodic, sc); */
324 
325     return;
326 }
327 
328 /*******************************************************************************
329  * Free resources associated with a controller instance
330  */
331 void
332 amr_free(struct amr_softc *sc)
333 {
334     struct amr_command_cluster	*acc;
335 
336     /* detach from CAM */
337     amr_cam_detach(sc);
338 
339     /* cancel status timeout */
340     callout_stop(&sc->amr_timeout);
341 
342     /* throw away any command buffers */
343     while ((acc = TAILQ_FIRST(&sc->amr_cmd_clusters)) != NULL) {
344 	TAILQ_REMOVE(&sc->amr_cmd_clusters, acc, acc_link);
345 	amr_freecmd_cluster(acc);
346     }
347 
348     /* destroy control device */
349     if( sc->amr_dev_t != (cdev_t)NULL)
350 	    destroy_dev(sc->amr_dev_t);
351     dev_ops_remove(&amr_ops, -1, device_get_unit(sc->amr_dev));
352 }
353 
354 /*******************************************************************************
355  * Receive a bio structure from a child device and queue it on a particular
356  * disk resource, then poke the disk resource to start as much work as it can.
357  */
358 int
359 amr_submit_bio(struct amr_softc *sc, struct bio *bio)
360 {
361     debug_called(2);
362 
363     amr_enqueue_bio(sc, bio);
364     amr_startio(sc);
365     return(0);
366 }
367 
368 /********************************************************************************
369  * Accept an open operation on the control device.
370  */
371 static int
372 amr_open(struct dev_open_args *ap)
373 {
374     cdev_t dev = ap->a_head.a_dev;
375     int			unit = minor(dev);
376     struct amr_softc	*sc = devclass_get_softc(devclass_find("amr"), unit);
377 
378     debug_called(1);
379 
380     sc->amr_state |= AMR_STATE_OPEN;
381     return(0);
382 }
383 
384 /********************************************************************************
385  * Accept the last close on the control device.
386  */
387 static int
388 amr_close(struct dev_close_args *ap)
389 {
390     cdev_t dev = ap->a_head.a_dev;
391     int			unit = minor(dev);
392     struct amr_softc	*sc = devclass_get_softc(devclass_find("amr"), unit);
393 
394     debug_called(1);
395 
396     sc->amr_state &= ~AMR_STATE_OPEN;
397     return (0);
398 }
399 
400 /********************************************************************************
401  * Handle controller-specific control operations.
402  */
403 static int
404 amr_ioctl(struct dev_ioctl_args *ap)
405 {
406     cdev_t dev = ap->a_head.a_dev;
407     struct amr_softc		*sc = (struct amr_softc *)dev->si_drv1;
408     int				*arg = (int *)ap->a_data;
409     struct amr_user_ioctl	*au = (struct amr_user_ioctl *)ap->a_data;
410     struct amr_command		*ac;
411     struct amr_mailbox_ioctl	*mbi;
412     struct amr_passthrough	*apt;
413     void			*dp;
414     int				error;
415 
416     debug_called(1);
417 
418     error = 0;
419     dp = NULL;
420     apt = NULL;
421     ac = NULL;
422     switch(ap->a_cmd) {
423 
424     case AMR_IO_VERSION:
425 	debug(1, "AMR_IO_VERSION");
426 	*arg = AMR_IO_VERSION_NUMBER;
427 	break;
428 
429     case AMR_IO_COMMAND:
430 	debug(1, "AMR_IO_COMMAND  0x%x", au->au_cmd[0]);
431 	/* handle inbound data buffer */
432 	if (au->au_length != 0) {
433 	    if ((dp = kmalloc(au->au_length, M_DEVBUF, M_WAITOK)) == NULL) {
434 		error = ENOMEM;
435 		break;
436 	    }
437 	    if ((error = copyin(au->au_buffer, dp, au->au_length)) != 0)
438 		break;
439 	    debug(2, "copyin %ld bytes from %p -> %p", au->au_length, au->au_buffer, dp);
440 	}
441 
442 	if ((ac = amr_alloccmd(sc)) == NULL) {
443 	    error = ENOMEM;
444 	    break;
445 	}
446 
447 	/* handle SCSI passthrough command */
448 	if (au->au_cmd[0] == AMR_CMD_PASS) {
449 	    if ((apt = kmalloc(sizeof(*apt), M_DEVBUF, M_WAITOK | M_ZERO)) == NULL) {
450 		error = ENOMEM;
451 		break;
452 	    }
453 
454 	    /* copy cdb */
455 	    apt->ap_cdb_length = au->au_cmd[2];
456 	    bcopy(&au->au_cmd[3], &apt->ap_cdb[0], apt->ap_cdb_length);
457 
458 	    /* build passthrough */
459 	    apt->ap_timeout		= au->au_cmd[apt->ap_cdb_length + 3] & 0x07;
460 	    apt->ap_ars			= (au->au_cmd[apt->ap_cdb_length + 3] & 0x08) ? 1 : 0;
461 	    apt->ap_islogical		= (au->au_cmd[apt->ap_cdb_length + 3] & 0x80) ? 1 : 0;
462 	    apt->ap_logical_drive_no	= au->au_cmd[apt->ap_cdb_length + 4];
463 	    apt->ap_channel		= au->au_cmd[apt->ap_cdb_length + 5];
464 	    apt->ap_scsi_id 		= au->au_cmd[apt->ap_cdb_length + 6];
465 	    apt->ap_request_sense_length	= 14;
466 	    apt->ap_data_transfer_length = au->au_length;
467 	    /* XXX what about the request-sense area? does the caller want it? */
468 
469 	    /* build command */
470 	    ac->ac_data = apt;
471 	    ac->ac_length = sizeof(*apt);
472 	    ac->ac_flags |= AMR_CMD_DATAOUT;
473 	    ac->ac_ccb_data = dp;
474 	    ac->ac_ccb_length = au->au_length;
475 	    if (au->au_direction & AMR_IO_READ)
476 		ac->ac_flags |= AMR_CMD_CCB_DATAIN;
477 	    if (au->au_direction & AMR_IO_WRITE)
478 		ac->ac_flags |= AMR_CMD_CCB_DATAOUT;
479 
480 	    ac->ac_mailbox.mb_command = AMR_CMD_PASS;
481 
482 	} else {
483 	    /* direct command to controller */
484 	    mbi = (struct amr_mailbox_ioctl *)&ac->ac_mailbox;
485 
486 	    /* copy pertinent mailbox items */
487 	    mbi->mb_command = au->au_cmd[0];
488 	    mbi->mb_channel = au->au_cmd[1];
489 	    mbi->mb_param = au->au_cmd[2];
490 	    mbi->mb_pad[0] = au->au_cmd[3];
491 	    mbi->mb_drive = au->au_cmd[4];
492 
493 	    /* build the command */
494 	    ac->ac_data = dp;
495 	    ac->ac_length = au->au_length;
496 	    if (au->au_direction & AMR_IO_READ)
497 		ac->ac_flags |= AMR_CMD_DATAIN;
498 	    if (au->au_direction & AMR_IO_WRITE)
499 		ac->ac_flags |= AMR_CMD_DATAOUT;
500 	}
501 
502 	/* run the command */
503 	if ((error = amr_wait_command(ac)) != 0)
504 	    break;
505 
506 	/* copy out data and set status */
507 	if (au->au_length != 0)
508 	    error = copyout(dp, au->au_buffer, au->au_length);
509 	debug(2, "copyout %ld bytes from %p -> %p", au->au_length, dp, au->au_buffer);
510 	if (dp != NULL)
511 	    debug(2, "%16d", (int)dp);
512 	au->au_status = ac->ac_status;
513 	break;
514 
515     default:
516 	debug(1, "unknown ioctl 0x%lx", cmd);
517 	error = ENOIOCTL;
518 	break;
519     }
520 
521     if (dp != NULL)
522 	kfree(dp, M_DEVBUF);
523     if (apt != NULL)
524 	kfree(apt, M_DEVBUF);
525     if (ac != NULL)
526 	amr_releasecmd(ac);
527     return(error);
528 }
529 
530 /********************************************************************************
531  ********************************************************************************
532                                                                 Status Monitoring
533  ********************************************************************************
534  ********************************************************************************/
535 
536 /********************************************************************************
537  * Perform a periodic check of the controller status
538  */
539 static void
540 amr_periodic(void *data)
541 {
542     struct amr_softc	*sc = (struct amr_softc *)data;
543 
544     debug_called(2);
545 
546     /* XXX perform periodic status checks here */
547 
548     /* compensate for missed interrupts */
549     amr_done(sc);
550 
551     /* reschedule */
552     callout_reset(&sc->amr_timeout, hz, amr_periodic, sc);
553 }
554 
555 /********************************************************************************
556  ********************************************************************************
557                                                                  Command Wrappers
558  ********************************************************************************
559  ********************************************************************************/
560 
561 /********************************************************************************
562  * Interrogate the controller for the operational parameters we require.
563  */
564 static int
565 amr_query_controller(struct amr_softc *sc)
566 {
567     struct amr_enquiry3	*aex;
568     struct amr_prodinfo	*ap;
569     struct amr_enquiry	*ae;
570     int			ldrv;
571 
572     /*
573      * If we haven't found the real limit yet, let us have a couple of commands in
574      * order to be able to probe.
575      */
576     if (sc->amr_maxio == 0)
577 	sc->amr_maxio = 2;
578 
579     /*
580      * Greater than 10 byte cdb support
581      */
582     sc->support_ext_cdb = amr_support_ext_cdb(sc);
583 
584     if(sc->support_ext_cdb) {
585 	debug(2,"supports extended CDBs.");
586     }
587 
588     /*
589      * Try to issue an ENQUIRY3 command
590      */
591     if ((aex = amr_enquiry(sc, 2048, AMR_CMD_CONFIG, AMR_CONFIG_ENQ3,
592 			   AMR_CONFIG_ENQ3_SOLICITED_FULL)) != NULL) {
593 
594 	/*
595 	 * Fetch current state of logical drives.
596 	 */
597 	for (ldrv = 0; ldrv < aex->ae_numldrives; ldrv++) {
598 	    sc->amr_drive[ldrv].al_size       = aex->ae_drivesize[ldrv];
599 	    sc->amr_drive[ldrv].al_state      = aex->ae_drivestate[ldrv];
600 	    sc->amr_drive[ldrv].al_properties = aex->ae_driveprop[ldrv];
601 	    debug(2, "  drive %d: %d state %x properties %x\n", ldrv, sc->amr_drive[ldrv].al_size,
602 		  sc->amr_drive[ldrv].al_state, sc->amr_drive[ldrv].al_properties);
603 	}
604 	kfree(aex, M_DEVBUF);
605 
606 	/*
607 	 * Get product info for channel count.
608 	 */
609 	if ((ap = amr_enquiry(sc, 2048, AMR_CMD_CONFIG, AMR_CONFIG_PRODUCT_INFO, 0)) == NULL) {
610 	    device_printf(sc->amr_dev, "can't obtain product data from controller\n");
611 	    return(1);
612 	}
613 	sc->amr_maxdrives = 40;
614 	sc->amr_maxchan = ap->ap_nschan;
615 	sc->amr_maxio = ap->ap_maxio;
616 	sc->amr_type |= AMR_TYPE_40LD;
617 	kfree(ap, M_DEVBUF);
618 
619     } else {
620 
621 	/* failed, try the 8LD ENQUIRY commands */
622 	if ((ae = (struct amr_enquiry *)amr_enquiry(sc, 2048, AMR_CMD_EXT_ENQUIRY2, 0, 0)) == NULL) {
623 	    if ((ae = (struct amr_enquiry *)amr_enquiry(sc, 2048, AMR_CMD_ENQUIRY, 0, 0)) == NULL) {
624 		device_printf(sc->amr_dev, "can't obtain configuration data from controller\n");
625 		return(1);
626 	    }
627 	    ae->ae_signature = 0;
628 	}
629 
630 	/*
631 	 * Fetch current state of logical drives.
632 	 */
633 	for (ldrv = 0; ldrv < ae->ae_ldrv.al_numdrives; ldrv++) {
634 	    sc->amr_drive[ldrv].al_size       = ae->ae_ldrv.al_size[ldrv];
635 	    sc->amr_drive[ldrv].al_state      = ae->ae_ldrv.al_state[ldrv];
636 	    sc->amr_drive[ldrv].al_properties = ae->ae_ldrv.al_properties[ldrv];
637 	    debug(2, "  drive %d: %d state %x properties %x\n", ldrv, sc->amr_drive[ldrv].al_size,
638 		  sc->amr_drive[ldrv].al_state, sc->amr_drive[ldrv].al_properties);
639 	}
640 
641 	sc->amr_maxdrives = 8;
642 	sc->amr_maxchan = ae->ae_adapter.aa_channels;
643 	sc->amr_maxio = ae->ae_adapter.aa_maxio;
644 	kfree(ae, M_DEVBUF);
645     }
646 
647     /*
648      * Mark remaining drives as unused.
649      */
650     for (; ldrv < AMR_MAXLD; ldrv++)
651 	sc->amr_drive[ldrv].al_size = 0xffffffff;
652 
653     /*
654      * Cap the maximum number of outstanding I/Os.  AMI's Linux driver doesn't trust
655      * the controller's reported value, and lockups have been seen when we do.
656      */
657     sc->amr_maxio = imin(sc->amr_maxio, AMR_LIMITCMD);
658 
659     return(0);
660 }
661 
662 /********************************************************************************
663  * Run a generic enquiry-style command.
664  */
665 static void *
666 amr_enquiry(struct amr_softc *sc, size_t bufsize, u_int8_t cmd, u_int8_t cmdsub, u_int8_t cmdqual)
667 {
668     struct amr_command	*ac;
669     void		*result;
670     u_int8_t		*mbox;
671     int			error;
672 
673     debug_called(1);
674 
675     error = 1;
676     result = NULL;
677 
678     /* get ourselves a command buffer */
679     if ((ac = amr_alloccmd(sc)) == NULL)
680 	goto out;
681     /* allocate the response structure */
682     result = kmalloc(bufsize, M_DEVBUF, M_INTWAIT);
683     /* set command flags */
684     ac->ac_flags |= AMR_CMD_PRIORITY | AMR_CMD_DATAOUT;
685 
686     /* point the command at our data */
687     ac->ac_data = result;
688     ac->ac_length = bufsize;
689 
690     /* build the command proper */
691     mbox = (u_int8_t *)&ac->ac_mailbox;		/* XXX want a real structure for this? */
692     mbox[0] = cmd;
693     mbox[2] = cmdsub;
694     mbox[3] = cmdqual;
695 
696     /* can't assume that interrupts are going to work here, so play it safe */
697     if (sc->amr_poll_command(ac))
698 	goto out;
699     error = ac->ac_status;
700 
701  out:
702     if (ac != NULL)
703 	amr_releasecmd(ac);
704     if ((error != 0) && (result != NULL)) {
705 	kfree(result, M_DEVBUF);
706 	result = NULL;
707     }
708     return(result);
709 }
710 
711 /********************************************************************************
712  * Flush the controller's internal cache, return status.
713  */
714 int
715 amr_flush(struct amr_softc *sc)
716 {
717     struct amr_command	*ac;
718     int			error;
719 
720     /* get ourselves a command buffer */
721     error = 1;
722     if ((ac = amr_alloccmd(sc)) == NULL)
723 	goto out;
724     /* set command flags */
725     ac->ac_flags |= AMR_CMD_PRIORITY | AMR_CMD_DATAOUT;
726 
727     /* build the command proper */
728     ac->ac_mailbox.mb_command = AMR_CMD_FLUSH;
729 
730     /* we have to poll, as the system may be going down or otherwise damaged */
731     if (sc->amr_poll_command(ac))
732 	goto out;
733     error = ac->ac_status;
734 
735  out:
736     if (ac != NULL)
737 	amr_releasecmd(ac);
738     return(error);
739 }
740 
741 /********************************************************************************
742  * Detect extented cdb >> greater than 10 byte cdb support
743  * returns '1' means this support exist
744  * returns '0' means this support doesn't exist
745  */
746 static int
747 amr_support_ext_cdb(struct amr_softc *sc)
748 {
749     struct amr_command	*ac;
750     u_int8_t		*mbox;
751     int			error;
752 
753     /* get ourselves a command buffer */
754     error = 0;
755     if ((ac = amr_alloccmd(sc)) == NULL)
756 	goto out;
757     /* set command flags */
758     ac->ac_flags |= AMR_CMD_PRIORITY | AMR_CMD_DATAOUT;
759 
760     /* build the command proper */
761     mbox = (u_int8_t *)&ac->ac_mailbox;		/* XXX want a real structure for this? */
762     mbox[0] = 0xA4;
763     mbox[2] = 0x16;
764 
765 
766     /* we have to poll, as the system may be going down or otherwise damaged */
767     if (sc->amr_poll_command(ac))
768 	goto out;
769     if( ac->ac_status == AMR_STATUS_SUCCESS ) {
770 	    error = 1;
771     }
772 
773 out:
774     if (ac != NULL)
775 	amr_releasecmd(ac);
776     return(error);
777 }
778 
779 /********************************************************************************
780  * Try to find I/O work for the controller from one or more of the work queues.
781  *
782  * We make the assumption that if the controller is not ready to take a command
783  * at some given time, it will generate an interrupt at some later time when
784  * it is.
785  */
786 void
787 amr_startio(struct amr_softc *sc)
788 {
789     struct amr_command	*ac;
790 
791     /* spin until something prevents us from doing any work */
792     for (;;) {
793 
794 	/* try to get a ready command */
795 	ac = amr_dequeue_ready(sc);
796 
797 	/* if that failed, build a command from a bio */
798 	if (ac == NULL)
799 	    (void)amr_bio_command(sc, &ac);
800 
801 	/* if that failed, build a command from a ccb */
802 	if (ac == NULL)
803 	    (void)amr_cam_command(sc, &ac);
804 
805 	/* if we don't have anything to do, give up */
806 	if (ac == NULL)
807 	    break;
808 
809 	/* try to give the command to the controller; if this fails save it for later and give up */
810 	if (amr_start(ac)) {
811 	    debug(2, "controller busy, command deferred");
812 	    amr_requeue_ready(ac);	/* XXX schedule retry very soon? */
813 	    break;
814 	}
815     }
816 }
817 
818 /********************************************************************************
819  * Handle completion of an I/O command.
820  */
821 static void
822 amr_completeio(struct amr_command *ac)
823 {
824     struct amr_softc	*sc = ac->ac_sc;
825 
826     if (ac->ac_status != AMR_STATUS_SUCCESS) {	/* could be more verbose here? */
827 	ac->ac_bio->bio_buf->b_error = EIO;
828 	ac->ac_bio->bio_buf->b_flags |= B_ERROR;
829 
830 	device_printf(sc->amr_dev, "I/O error - 0x%x\n", ac->ac_status);
831 /*	amr_printcommand(ac);*/
832     }
833     amrd_intr(ac->ac_bio);
834     amr_releasecmd(ac);
835 }
836 
837 /********************************************************************************
838  ********************************************************************************
839                                                                Command Processing
840  ********************************************************************************
841  ********************************************************************************/
842 
843 /********************************************************************************
844  * Convert a bio off the top of the bio queue into a command.
845  */
846 static int
847 amr_bio_command(struct amr_softc *sc, struct amr_command **acp)
848 {
849     struct amr_command	*ac;
850     struct amrd_softc	*amrd;
851     struct bio		*bio;
852     int			error;
853     int			blkcount;
854     int			driveno;
855     int			cmd;
856     u_int64_t		lba;
857 
858     ac = NULL;
859     error = 0;
860 
861     /* get a bio to work on */
862     if ((bio = amr_dequeue_bio(sc)) == NULL)
863 	goto out;
864 
865     /* get a command */
866     if ((ac = amr_alloccmd(sc)) == NULL) {
867 	error = ENOMEM;
868 	goto out;
869     }
870 
871     /* connect the bio to the command */
872     ac->ac_complete = amr_completeio;
873     ac->ac_bio = bio;
874     ac->ac_data = bio->bio_buf->b_data;
875     ac->ac_length = bio->bio_buf->b_bcount;
876     if (bio->bio_buf->b_cmd == BUF_CMD_READ) {
877 	ac->ac_flags |= AMR_CMD_DATAIN;
878 	cmd = AMR_CMD_LREAD;
879     } else {
880 	ac->ac_flags |= AMR_CMD_DATAOUT;
881 	cmd = AMR_CMD_LWRITE;
882     }
883     amrd = (struct amrd_softc *)bio->bio_driver_info;
884     driveno = amrd->amrd_drive - sc->amr_drive;
885     blkcount = (bio->bio_buf->b_bcount + AMR_BLKSIZE - 1) / AMR_BLKSIZE;
886     lba = bio->bio_offset / AMR_BLKSIZE;
887     KKASSERT(lba < 0x100000000ULL);
888 
889     ac->ac_mailbox.mb_command = cmd;
890     ac->ac_mailbox.mb_blkcount = blkcount;
891     ac->ac_mailbox.mb_lba = lba;
892     ac->ac_mailbox.mb_drive = driveno;
893     /* we fill in the s/g related data when the command is mapped */
894 
895     if ((lba + blkcount) > sc->amr_drive[driveno].al_size)
896 	device_printf(sc->amr_dev, "I/O beyond end of unit (%lld,%d > %lu)\n",
897 		      lba, blkcount,
898 		      (u_long)sc->amr_drive[driveno].al_size);
899 
900 out:
901     if (error != 0) {
902 	if (ac != NULL)
903 	    amr_releasecmd(ac);
904 	if (bio != NULL)			/* this breaks ordering... */
905 	    amr_enqueue_bio(sc, bio);
906     }
907     *acp = ac;
908     return(error);
909 }
910 
911 /********************************************************************************
912  * Take a command, submit it to the controller and sleep until it completes
913  * or fails.  Interrupts must be enabled, returns nonzero on error.
914  */
915 static int
916 amr_wait_command(struct amr_command *ac)
917 {
918     int			error, count;
919 
920     debug_called(1);
921 
922     ac->ac_complete = NULL;
923     ac->ac_flags |= AMR_CMD_SLEEP;
924     if ((error = amr_start(ac)) != 0)
925 	return(error);
926 
927     count = 0;
928     /* XXX better timeout? */
929     while ((ac->ac_flags & AMR_CMD_BUSY) && (count < 30)) {
930 	tsleep(ac, PCATCH, "amrwcmd", hz);
931     }
932     return(0);
933 }
934 
935 /********************************************************************************
936  * Take a command, submit it to the controller and busy-wait for it to return.
937  * Returns nonzero on error.  Can be safely called with interrupts enabled.
938  */
939 static int
940 amr_std_poll_command(struct amr_command *ac)
941 {
942     struct amr_softc	*sc = ac->ac_sc;
943     int			error, count;
944 
945     debug_called(2);
946 
947     ac->ac_complete = NULL;
948     if ((error = amr_start(ac)) != 0)
949 	return(error);
950 
951     count = 0;
952     do {
953 	/*
954 	 * Poll for completion, although the interrupt handler may beat us to it.
955 	 * Note that the timeout here is somewhat arbitrary.
956 	 */
957 	amr_done(sc);
958 	DELAY(1000);
959     } while ((ac->ac_flags & AMR_CMD_BUSY) && (count++ < 1000));
960     if (!(ac->ac_flags & AMR_CMD_BUSY)) {
961 	error = 0;
962     } else {
963 	/* XXX the slot is now marked permanently busy */
964 	error = EIO;
965 	device_printf(sc->amr_dev, "polled command timeout\n");
966     }
967     return(error);
968 }
969 
970 /********************************************************************************
971  * Take a command, submit it to the controller and busy-wait for it to return.
972  * Returns nonzero on error.  Can be safely called with interrupts enabled.
973  */
974 static int
975 amr_quartz_poll_command(struct amr_command *ac)
976 {
977     struct amr_softc	*sc = ac->ac_sc;
978     int			error,count;
979 
980     debug_called(2);
981 
982     /* now we have a slot, we can map the command (unmapped in amr_complete) */
983     amr_mapcmd(ac);
984 
985     crit_enter();
986 
987     if (sc->amr_state & AMR_STATE_INTEN) {
988 	    count=0;
989 	    while (sc->amr_busyslots) {
990 		    tsleep(sc, PCATCH, "amrpoll", hz);
991 		    if(count++>10) {
992 			    break;
993 		    }
994 	    }
995 
996 	    if(sc->amr_busyslots) {
997 		    device_printf(sc->amr_dev, "adapter is busy\n");
998 		    crit_exit();
999 		    amr_unmapcmd(ac);
1000 		    ac->ac_status=0;
1001 		    return(1);
1002 	    }
1003     }
1004 
1005     bcopy(&ac->ac_mailbox, (void *)(uintptr_t)(volatile void *)sc->amr_mailbox, AMR_MBOX_CMDSIZE);
1006 
1007     /* clear the poll/ack fields in the mailbox */
1008     sc->amr_mailbox->mb_ident = 0xFE;
1009     sc->amr_mailbox->mb_nstatus = 0xFF;
1010     sc->amr_mailbox->mb_status = 0xFF;
1011     sc->amr_mailbox->mb_poll = 0;
1012     sc->amr_mailbox->mb_ack = 0;
1013     sc->amr_mailbox->mb_busy = 1;
1014 
1015     AMR_QPUT_IDB(sc, sc->amr_mailboxphys | AMR_QIDB_SUBMIT);
1016 
1017     while(sc->amr_mailbox->mb_nstatus == 0xFF);
1018     while(sc->amr_mailbox->mb_status == 0xFF);
1019     ac->ac_status=sc->amr_mailbox->mb_status;
1020     error = (ac->ac_status !=AMR_STATUS_SUCCESS) ? 1:0;
1021     while(sc->amr_mailbox->mb_poll != 0x77);
1022     sc->amr_mailbox->mb_poll = 0;
1023     sc->amr_mailbox->mb_ack = 0x77;
1024 
1025     /* acknowledge that we have the commands */
1026     AMR_QPUT_IDB(sc, sc->amr_mailboxphys | AMR_QIDB_ACK);
1027     while(AMR_QGET_IDB(sc) & AMR_QIDB_ACK);
1028 
1029     crit_exit();
1030 
1031     /* unmap the command's data buffer */
1032     amr_unmapcmd(ac);
1033 
1034     return(error);
1035 }
1036 
1037 /********************************************************************************
1038  * Get a free command slot for a command if it doesn't already have one.
1039  *
1040  * May be safely called multiple times for a given command.
1041  */
1042 static int
1043 amr_getslot(struct amr_command *ac)
1044 {
1045     struct amr_softc	*sc = ac->ac_sc;
1046     int			slot, limit, error;
1047 
1048     debug_called(3);
1049 
1050     /* if the command already has a slot, don't try to give it another one */
1051     if (ac->ac_slot != 0)
1052 	return(0);
1053 
1054     /* enforce slot usage limit */
1055     limit = (ac->ac_flags & AMR_CMD_PRIORITY) ? sc->amr_maxio : sc->amr_maxio - 4;
1056     if (sc->amr_busyslots > limit)
1057 	return(EBUSY);
1058 
1059     /*
1060      * Allocate a slot.  XXX linear scan is slow
1061      */
1062     error = EBUSY;
1063     crit_enter();
1064     for (slot = 0; slot < sc->amr_maxio; slot++) {
1065 	if (sc->amr_busycmd[slot] == NULL) {
1066 	    sc->amr_busycmd[slot] = ac;
1067 	    sc->amr_busyslots++;
1068 	    ac->ac_slot = slot;
1069 	    error = 0;
1070 	    break;
1071 	}
1072     }
1073     crit_exit();
1074 
1075     return(error);
1076 }
1077 
1078 /********************************************************************************
1079  * Map/unmap (ac)'s data in the controller's addressable space as required.
1080  *
1081  * These functions may be safely called multiple times on a given command.
1082  */
1083 static void
1084 amr_setup_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error)
1085 {
1086     struct amr_command	*ac = (struct amr_command *)arg;
1087     struct amr_softc	*sc = ac->ac_sc;
1088     struct amr_sgentry	*sg;
1089     int			i;
1090     u_int8_t		*sgc;
1091 
1092     debug_called(3);
1093 
1094     /* get base address of s/g table */
1095     sg = sc->amr_sgtable + (ac->ac_slot * AMR_NSEG);
1096 
1097     /* save data physical address */
1098     ac->ac_dataphys = segs[0].ds_addr;
1099 
1100     /* for AMR_CMD_CONFIG the s/g count goes elsewhere */
1101     if (ac->ac_mailbox.mb_command == AMR_CMD_CONFIG) {
1102 	sgc = &(((struct amr_mailbox_ioctl *)&ac->ac_mailbox)->mb_param);
1103     } else {
1104 	sgc = &ac->ac_mailbox.mb_nsgelem;
1105     }
1106 
1107     /* decide whether we need to populate the s/g table */
1108     if (nsegments < 2) {
1109 	*sgc = 0;
1110 	ac->ac_mailbox.mb_nsgelem = 0;
1111 	ac->ac_mailbox.mb_physaddr = ac->ac_dataphys;
1112     } else {
1113         ac->ac_mailbox.mb_nsgelem = nsegments;
1114 	*sgc = nsegments;
1115 	ac->ac_mailbox.mb_physaddr = sc->amr_sgbusaddr + (ac->ac_slot * AMR_NSEG * sizeof(struct amr_sgentry));
1116 	for (i = 0; i < nsegments; i++, sg++) {
1117 	    sg->sg_addr = segs[i].ds_addr;
1118 	    sg->sg_count = segs[i].ds_len;
1119 	}
1120     }
1121 }
1122 
1123 static void
1124 amr_setup_ccbmap(void *arg, bus_dma_segment_t *segs, int nsegments, int error)
1125 {
1126     struct amr_command          *ac = (struct amr_command *)arg;
1127     struct amr_softc            *sc = ac->ac_sc;
1128     struct amr_sgentry          *sg;
1129     struct amr_passthrough      *ap = (struct amr_passthrough *)ac->ac_data;
1130     struct amr_ext_passthrough	*aep = (struct amr_ext_passthrough *)ac->ac_data;
1131     int                         i;
1132 
1133     /* get base address of s/g table */
1134     sg = sc->amr_sgtable + (ac->ac_slot * AMR_NSEG);
1135 
1136     /* decide whether we need to populate the s/g table */
1137     if( ac->ac_mailbox.mb_command == AMR_CMD_EXTPASS ) {
1138 	if (nsegments < 2) {
1139 	    aep->ap_no_sg_elements = 0;
1140 	    aep->ap_data_transfer_address =  segs[0].ds_addr;
1141 	} else {
1142 	    /* save s/g table information in passthrough */
1143 	    aep->ap_no_sg_elements = nsegments;
1144 	    aep->ap_data_transfer_address = sc->amr_sgbusaddr + (ac->ac_slot * AMR_NSEG * sizeof(struct amr_sgentry));
1145 	    /* populate s/g table (overwrites previous call which mapped the passthrough) */
1146 	    for (i = 0; i < nsegments; i++, sg++) {
1147 		sg->sg_addr = segs[i].ds_addr;
1148 		sg->sg_count = segs[i].ds_len;
1149 		debug(3, " %d: 0x%x/%d", i, sg->sg_addr, sg->sg_count);
1150 	    }
1151 	}
1152 	debug(3, "slot %d  %d segments at 0x%x, passthrough at 0x%x", ac->ac_slot,
1153 	    aep->ap_no_sg_elements, aep->ap_data_transfer_address, ac->ac_dataphys);
1154     } else {
1155 	if (nsegments < 2) {
1156 	    ap->ap_no_sg_elements = 0;
1157 	    ap->ap_data_transfer_address =  segs[0].ds_addr;
1158 	} else {
1159 	    /* save s/g table information in passthrough */
1160 	    ap->ap_no_sg_elements = nsegments;
1161 	    ap->ap_data_transfer_address = sc->amr_sgbusaddr + (ac->ac_slot * AMR_NSEG * sizeof(struct amr_sgentry));
1162 	    /* populate s/g table (overwrites previous call which mapped the passthrough) */
1163 	    for (i = 0; i < nsegments; i++, sg++) {
1164 		sg->sg_addr = segs[i].ds_addr;
1165 		sg->sg_count = segs[i].ds_len;
1166 		debug(3, " %d: 0x%x/%d", i, sg->sg_addr, sg->sg_count);
1167 	    }
1168 	}
1169 	debug(3, "slot %d  %d segments at 0x%x, passthrough at 0x%x", ac->ac_slot,
1170 	    ap->ap_no_sg_elements, ap->ap_data_transfer_address, ac->ac_dataphys);
1171     }
1172 }
1173 
1174 static void
1175 amr_mapcmd(struct amr_command *ac)
1176 {
1177     struct amr_softc	*sc = ac->ac_sc;
1178 
1179     debug_called(3);
1180 
1181     /* if the command involves data at all, and hasn't been mapped */
1182     if (!(ac->ac_flags & AMR_CMD_MAPPED)) {
1183 
1184 	if (ac->ac_data != NULL) {
1185 	    /* map the data buffers into bus space and build the s/g list */
1186 	    bus_dmamap_load(sc->amr_buffer_dmat, ac->ac_dmamap, ac->ac_data, ac->ac_length,
1187 			    amr_setup_dmamap, ac, 0);
1188 	    if (ac->ac_flags & AMR_CMD_DATAIN)
1189 		bus_dmamap_sync(sc->amr_buffer_dmat, ac->ac_dmamap, BUS_DMASYNC_PREREAD);
1190 	    if (ac->ac_flags & AMR_CMD_DATAOUT)
1191 		bus_dmamap_sync(sc->amr_buffer_dmat, ac->ac_dmamap, BUS_DMASYNC_PREWRITE);
1192 	}
1193 
1194 	if (ac->ac_ccb_data != NULL) {
1195 	    bus_dmamap_load(sc->amr_buffer_dmat, ac->ac_ccb_dmamap, ac->ac_ccb_data, ac->ac_ccb_length,
1196 			    amr_setup_ccbmap, ac, 0);
1197 	    if (ac->ac_flags & AMR_CMD_CCB_DATAIN)
1198 		bus_dmamap_sync(sc->amr_buffer_dmat, ac->ac_ccb_dmamap, BUS_DMASYNC_PREREAD);
1199 	    if (ac->ac_flags & AMR_CMD_CCB_DATAOUT)
1200 		bus_dmamap_sync(sc->amr_buffer_dmat, ac->ac_ccb_dmamap, BUS_DMASYNC_PREWRITE);
1201 	}
1202 	ac->ac_flags |= AMR_CMD_MAPPED;
1203     }
1204 }
1205 
1206 static void
1207 amr_unmapcmd(struct amr_command *ac)
1208 {
1209     struct amr_softc	*sc = ac->ac_sc;
1210 
1211     debug_called(3);
1212 
1213     /* if the command involved data at all and was mapped */
1214     if (ac->ac_flags & AMR_CMD_MAPPED) {
1215 
1216 	if (ac->ac_data != NULL) {
1217 	    if (ac->ac_flags & AMR_CMD_DATAIN)
1218 		bus_dmamap_sync(sc->amr_buffer_dmat, ac->ac_dmamap, BUS_DMASYNC_POSTREAD);
1219 	    if (ac->ac_flags & AMR_CMD_DATAOUT)
1220 		bus_dmamap_sync(sc->amr_buffer_dmat, ac->ac_dmamap, BUS_DMASYNC_POSTWRITE);
1221 	    bus_dmamap_unload(sc->amr_buffer_dmat, ac->ac_dmamap);
1222 	}
1223 
1224 	if (ac->ac_ccb_data != NULL) {
1225 	    if (ac->ac_flags & AMR_CMD_CCB_DATAIN)
1226 		bus_dmamap_sync(sc->amr_buffer_dmat, ac->ac_ccb_dmamap, BUS_DMASYNC_POSTREAD);
1227 	    if (ac->ac_flags & AMR_CMD_CCB_DATAOUT)
1228 		bus_dmamap_sync(sc->amr_buffer_dmat, ac->ac_ccb_dmamap, BUS_DMASYNC_POSTWRITE);
1229 	    bus_dmamap_unload(sc->amr_buffer_dmat, ac->ac_ccb_dmamap);
1230 	}
1231 	ac->ac_flags &= ~AMR_CMD_MAPPED;
1232     }
1233 }
1234 
1235 /********************************************************************************
1236  * Take a command and give it to the controller, returns 0 if successful, or
1237  * EBUSY if the command should be retried later.
1238  */
1239 static int
1240 amr_start(struct amr_command *ac)
1241 {
1242     struct amr_softc	*sc = ac->ac_sc;
1243     int			done, i;
1244 
1245     debug_called(3);
1246 
1247     /* mark command as busy so that polling consumer can tell */
1248     ac->ac_flags |= AMR_CMD_BUSY;
1249 
1250     /* get a command slot (freed in amr_done) */
1251     if (amr_getslot(ac))
1252 	return(EBUSY);
1253 
1254     /* now we have a slot, we can map the command (unmapped in amr_complete) */
1255     amr_mapcmd(ac);
1256 
1257     /* mark the new mailbox we are going to copy in as busy */
1258     ac->ac_mailbox.mb_busy = 1;
1259 
1260     /* clear the poll/ack fields in the mailbox */
1261     sc->amr_mailbox->mb_poll = 0;
1262     sc->amr_mailbox->mb_ack = 0;
1263 
1264     /*
1265      * Save the slot number so that we can locate this command when complete.
1266      * Note that ident = 0 seems to be special, so we don't use it.
1267      */
1268     ac->ac_mailbox.mb_ident = ac->ac_slot + 1;
1269 
1270     /*
1271      * Spin waiting for the mailbox, give up after ~1 second.  We expect the
1272      * controller to be able to handle our I/O.
1273      *
1274      * XXX perhaps we should wait for less time, and count on the deferred command
1275      * handling to deal with retries?
1276      */
1277     debug(4, "wait for mailbox");
1278     for (i = 10000, done = 0; (i > 0) && !done; i--) {
1279 	crit_enter();
1280 
1281 	/* is the mailbox free? */
1282 	if (sc->amr_mailbox->mb_busy == 0) {
1283 	    debug(4, "got mailbox");
1284 	    sc->amr_mailbox64->mb64_segment = 0;
1285 	    bcopy(&ac->ac_mailbox, (void *)(uintptr_t)(volatile void *)sc->amr_mailbox, AMR_MBOX_CMDSIZE);
1286 	    done = 1;
1287 
1288 	    /* not free, spin waiting */
1289 	} else {
1290 	    debug(4, "busy flag %x\n", sc->amr_mailbox->mb_busy);
1291 	    /* this is somewhat ugly */
1292 	    DELAY(100);
1293 	}
1294 	crit_exit();
1295     }
1296 
1297     /*
1298      * Now give the command to the controller
1299      */
1300     if (done) {
1301 	if (sc->amr_submit_command(sc)) {
1302 	    /* the controller wasn't ready to take the command, forget that we tried to post it */
1303 	    sc->amr_mailbox->mb_busy = 0;
1304 	    return(EBUSY);
1305 	}
1306 	debug(3, "posted command");
1307 	return(0);
1308     }
1309 
1310     /*
1311      * The controller wouldn't take the command.  Return the command as busy
1312      * so that it is retried later.
1313      */
1314     return(EBUSY);
1315 }
1316 
1317 /********************************************************************************
1318  * Extract one or more completed commands from the controller (sc)
1319  *
1320  * Returns nonzero if any commands on the work queue were marked as completed.
1321  */
1322 int
1323 amr_done(struct amr_softc *sc)
1324 {
1325     struct amr_command	*ac;
1326     struct amr_mailbox	mbox;
1327     int			i, idx, result;
1328 
1329     debug_called(3);
1330 
1331     /* See if there's anything for us to do */
1332     result = 0;
1333 
1334     /* loop collecting completed commands */
1335     for (;;) {
1336 	/* poll for a completed command's identifier and status */
1337 	if (sc->amr_get_work(sc, &mbox)) {
1338 	    result = 1;
1339 
1340 	    /* iterate over completed commands in this result */
1341 	    for (i = 0; i < mbox.mb_nstatus; i++) {
1342 		/* get pointer to busy command */
1343 		idx = mbox.mb_completed[i] - 1;
1344 		ac = sc->amr_busycmd[idx];
1345 
1346 		/* really a busy command? */
1347 		if (ac != NULL) {
1348 
1349 		    /* pull the command from the busy index */
1350 		    sc->amr_busycmd[idx] = NULL;
1351 		    sc->amr_busyslots--;
1352 
1353 		    /* save status for later use */
1354 		    ac->ac_status = mbox.mb_status;
1355 		    amr_enqueue_completed(ac);
1356 		    debug(3, "completed command with status %x", mbox.mb_status);
1357 		} else {
1358 		    device_printf(sc->amr_dev, "bad slot %d completed\n", idx);
1359 		}
1360 	    }
1361 	} else {
1362 	    break;	/* no work */
1363 	}
1364     }
1365 
1366     /* if we've completed any commands, try posting some more */
1367     if (result)
1368 	amr_startio(sc);
1369 
1370     /* handle completion and timeouts */
1371 #if defined(__FreeBSD__) && __FreeBSD_version >= 500005
1372     if (sc->amr_state & AMR_STATE_INTEN)
1373 	taskqueue_enqueue(taskqueue_swi, &sc->amr_task_complete);
1374     else
1375 #endif
1376 	amr_complete(sc, 0);
1377 
1378     return(result);
1379 }
1380 
1381 /********************************************************************************
1382  * Do completion processing on done commands on (sc)
1383  */
1384 static void
1385 amr_complete(void *context, int pending)
1386 {
1387     struct amr_softc	*sc = (struct amr_softc *)context;
1388     struct amr_command	*ac;
1389 
1390     debug_called(3);
1391 
1392     /* pull completed commands off the queue */
1393     for (;;) {
1394 	ac = amr_dequeue_completed(sc);
1395 	if (ac == NULL)
1396 	    break;
1397 
1398 	/* unmap the command's data buffer */
1399 	amr_unmapcmd(ac);
1400 
1401 	/* unbusy the command */
1402 	ac->ac_flags &= ~AMR_CMD_BUSY;
1403 
1404 	/*
1405 	 * Is there a completion handler?
1406 	 */
1407 	if (ac->ac_complete != NULL) {
1408 	    ac->ac_complete(ac);
1409 
1410 	    /*
1411 	     * Is someone sleeping on this one?
1412 	     */
1413 	} else if (ac->ac_flags & AMR_CMD_SLEEP) {
1414 	    wakeup(ac);
1415 	}
1416 
1417 	if(!sc->amr_busyslots) {
1418 	    wakeup(sc);
1419 	}
1420     }
1421 }
1422 
1423 /********************************************************************************
1424  ********************************************************************************
1425                                                         Command Buffer Management
1426  ********************************************************************************
1427  ********************************************************************************/
1428 
1429 /********************************************************************************
1430  * Get a new command buffer.
1431  *
1432  * This may return NULL in low-memory cases.
1433  *
1434  * If possible, we recycle a command buffer that's been used before.
1435  */
1436 struct amr_command *
1437 amr_alloccmd(struct amr_softc *sc)
1438 {
1439     struct amr_command	*ac;
1440 
1441     debug_called(3);
1442 
1443     ac = amr_dequeue_free(sc);
1444     if (ac == NULL) {
1445 	amr_alloccmd_cluster(sc);
1446 	ac = amr_dequeue_free(sc);
1447     }
1448     if (ac == NULL)
1449 	return(NULL);
1450 
1451     /* clear out significant fields */
1452     ac->ac_slot = 0;
1453     ac->ac_status = 0;
1454     bzero(&ac->ac_mailbox, sizeof(struct amr_mailbox));
1455     ac->ac_flags = 0;
1456     ac->ac_bio = NULL;
1457     ac->ac_data = NULL;
1458     ac->ac_ccb_data = NULL;
1459     ac->ac_complete = NULL;
1460     return(ac);
1461 }
1462 
1463 /********************************************************************************
1464  * Release a command buffer for recycling.
1465  */
1466 void
1467 amr_releasecmd(struct amr_command *ac)
1468 {
1469     debug_called(3);
1470 
1471     amr_enqueue_free(ac);
1472 }
1473 
1474 /********************************************************************************
1475  * Allocate a new command cluster and initialise it.
1476  */
1477 static void
1478 amr_alloccmd_cluster(struct amr_softc *sc)
1479 {
1480     struct amr_command_cluster	*acc;
1481     struct amr_command		*ac;
1482     int				i;
1483 
1484     acc = kmalloc(AMR_CMD_CLUSTERSIZE, M_DEVBUF, M_INTWAIT);
1485     crit_enter();
1486     TAILQ_INSERT_TAIL(&sc->amr_cmd_clusters, acc, acc_link);
1487     crit_exit();
1488     for (i = 0; i < AMR_CMD_CLUSTERCOUNT; i++) {
1489 	ac = &acc->acc_command[i];
1490 	bzero(ac, sizeof(*ac));
1491 	ac->ac_sc = sc;
1492 	if (!bus_dmamap_create(sc->amr_buffer_dmat, 0, &ac->ac_dmamap) &&
1493 	    !bus_dmamap_create(sc->amr_buffer_dmat, 0, &ac->ac_ccb_dmamap))
1494 	    amr_releasecmd(ac);
1495     }
1496 }
1497 
1498 /********************************************************************************
1499  * Free a command cluster
1500  */
1501 static void
1502 amr_freecmd_cluster(struct amr_command_cluster *acc)
1503 {
1504     struct amr_softc	*sc = acc->acc_command[0].ac_sc;
1505     int			i;
1506 
1507     for (i = 0; i < AMR_CMD_CLUSTERCOUNT; i++)
1508 	bus_dmamap_destroy(sc->amr_buffer_dmat, acc->acc_command[i].ac_dmamap);
1509     kfree(acc, M_DEVBUF);
1510 }
1511 
1512 /********************************************************************************
1513  ********************************************************************************
1514                                                          Interface-specific Shims
1515  ********************************************************************************
1516  ********************************************************************************/
1517 
1518 /********************************************************************************
1519  * Tell the controller that the mailbox contains a valid command
1520  */
1521 static int
1522 amr_quartz_submit_command(struct amr_softc *sc)
1523 {
1524     debug_called(3);
1525 
1526     if (AMR_QGET_IDB(sc) & AMR_QIDB_SUBMIT)
1527 	return(EBUSY);
1528     AMR_QPUT_IDB(sc, sc->amr_mailboxphys | AMR_QIDB_SUBMIT);
1529     return(0);
1530 }
1531 
1532 static int
1533 amr_std_submit_command(struct amr_softc *sc)
1534 {
1535     debug_called(3);
1536 
1537     if (AMR_SGET_MBSTAT(sc) & AMR_SMBOX_BUSYFLAG)
1538 	return(EBUSY);
1539     AMR_SPOST_COMMAND(sc);
1540     return(0);
1541 }
1542 
1543 /********************************************************************************
1544  * Claim any work that the controller has completed; acknowledge completion,
1545  * save details of the completion in (mbsave)
1546  */
1547 static int
1548 amr_quartz_get_work(struct amr_softc *sc, struct amr_mailbox *mbsave)
1549 {
1550     int		worked;
1551     u_int32_t	outd;
1552 
1553     debug_called(3);
1554 
1555     worked = 0;
1556     crit_enter();
1557 
1558     /* work waiting for us? */
1559     if ((outd = AMR_QGET_ODB(sc)) == AMR_QODB_READY) {
1560 
1561 	/* save mailbox, which contains a list of completed commands */
1562 	bcopy((void *)(uintptr_t)(volatile void *)sc->amr_mailbox, mbsave, sizeof(*mbsave));
1563 
1564 	/* acknowledge interrupt */
1565 	AMR_QPUT_ODB(sc, AMR_QODB_READY);
1566 
1567 	/* acknowledge that we have the commands */
1568 	AMR_QPUT_IDB(sc, sc->amr_mailboxphys | AMR_QIDB_ACK);
1569 
1570 #ifndef AMR_QUARTZ_GOFASTER
1571 	/*
1572 	 * This waits for the controller to notice that we've taken the
1573 	 * command from it.  It's very inefficient, and we shouldn't do it,
1574 	 * but if we remove this code, we stop completing commands under
1575 	 * load.
1576 	 *
1577 	 * Peter J says we shouldn't do this.  The documentation says we
1578 	 * should.  Who is right?
1579 	 */
1580 	while(AMR_QGET_IDB(sc) & AMR_QIDB_ACK)
1581 	    ;				/* XXX aiee! what if it dies? */
1582 #endif
1583 
1584 	worked = 1;			/* got some work */
1585     }
1586 
1587     crit_exit();
1588     return(worked);
1589 }
1590 
1591 static int
1592 amr_std_get_work(struct amr_softc *sc, struct amr_mailbox *mbsave)
1593 {
1594     int		worked;
1595     u_int8_t	istat;
1596 
1597     debug_called(3);
1598 
1599     worked = 0;
1600     crit_enter();
1601 
1602     /* check for valid interrupt status */
1603     istat = AMR_SGET_ISTAT(sc);
1604     if ((istat & AMR_SINTR_VALID) != 0) {
1605 	AMR_SPUT_ISTAT(sc, istat);	/* ack interrupt status */
1606 
1607 	/* save mailbox, which contains a list of completed commands */
1608 	bcopy((void *)(uintptr_t)(volatile void *)sc->amr_mailbox, mbsave, sizeof(*mbsave));
1609 
1610 	AMR_SACK_INTERRUPT(sc);		/* acknowledge we have the mailbox */
1611 	worked = 1;
1612     }
1613 
1614     crit_exit();
1615     return(worked);
1616 }
1617 
1618 /********************************************************************************
1619  * Notify the controller of the mailbox location.
1620  */
1621 static void
1622 amr_std_attach_mailbox(struct amr_softc *sc)
1623 {
1624 
1625     /* program the mailbox physical address */
1626     AMR_SBYTE_SET(sc, AMR_SMBOX_0, sc->amr_mailboxphys         & 0xff);
1627     AMR_SBYTE_SET(sc, AMR_SMBOX_1, (sc->amr_mailboxphys >>  8) & 0xff);
1628     AMR_SBYTE_SET(sc, AMR_SMBOX_2, (sc->amr_mailboxphys >> 16) & 0xff);
1629     AMR_SBYTE_SET(sc, AMR_SMBOX_3, (sc->amr_mailboxphys >> 24) & 0xff);
1630     AMR_SBYTE_SET(sc, AMR_SMBOX_ENABLE, AMR_SMBOX_ADDR);
1631 
1632     /* clear any outstanding interrupt and enable interrupts proper */
1633     AMR_SACK_INTERRUPT(sc);
1634     AMR_SENABLE_INTR(sc);
1635 }
1636 
1637 #ifdef AMR_BOARD_INIT
1638 /********************************************************************************
1639  * Initialise the controller
1640  */
1641 static int
1642 amr_quartz_init(struct amr_softc *sc)
1643 {
1644     int		status, ostatus;
1645 
1646     device_printf(sc->amr_dev, "initial init status %x\n", AMR_QGET_INITSTATUS(sc));
1647 
1648     AMR_QRESET(sc);
1649 
1650     ostatus = 0xff;
1651     while ((status = AMR_QGET_INITSTATUS(sc)) != AMR_QINIT_DONE) {
1652 	if (status != ostatus) {
1653 	    device_printf(sc->amr_dev, "(%x) %s\n", status, amr_describe_code(amr_table_qinit, status));
1654 	    ostatus = status;
1655 	}
1656 	switch (status) {
1657 	case AMR_QINIT_NOMEM:
1658 	    return(ENOMEM);
1659 
1660 	case AMR_QINIT_SCAN:
1661 	    /* XXX we could print channel/target here */
1662 	    break;
1663 	}
1664     }
1665     return(0);
1666 }
1667 
1668 static int
1669 amr_std_init(struct amr_softc *sc)
1670 {
1671     int		status, ostatus;
1672 
1673     device_printf(sc->amr_dev, "initial init status %x\n", AMR_SGET_INITSTATUS(sc));
1674 
1675     AMR_SRESET(sc);
1676 
1677     ostatus = 0xff;
1678     while ((status = AMR_SGET_INITSTATUS(sc)) != AMR_SINIT_DONE) {
1679 	if (status != ostatus) {
1680 	    device_printf(sc->amr_dev, "(%x) %s\n", status, amr_describe_code(amr_table_sinit, status));
1681 	    ostatus = status;
1682 	}
1683 	switch (status) {
1684 	case AMR_SINIT_NOMEM:
1685 	    return(ENOMEM);
1686 
1687 	case AMR_SINIT_INPROG:
1688 	    /* XXX we could print channel/target here? */
1689 	    break;
1690 	}
1691     }
1692     return(0);
1693 }
1694 #endif
1695 
1696 /********************************************************************************
1697  ********************************************************************************
1698                                                                         Debugging
1699  ********************************************************************************
1700  ********************************************************************************/
1701 
1702 /********************************************************************************
1703  * Identify the controller and print some information about it.
1704  */
1705 static void
1706 amr_describe_controller(struct amr_softc *sc)
1707 {
1708     struct amr_prodinfo	*ap;
1709     struct amr_enquiry	*ae;
1710     char		*prod;
1711 
1712     /*
1713      * Try to get 40LD product info, which tells us what the card is labelled as.
1714      */
1715     if ((ap = amr_enquiry(sc, 2048, AMR_CMD_CONFIG, AMR_CONFIG_PRODUCT_INFO, 0)) != NULL) {
1716 	device_printf(sc->amr_dev, "<LSILogic %.80s> Firmware %.16s, BIOS %.16s, %dMB RAM\n",
1717 		      ap->ap_product, ap->ap_firmware, ap->ap_bios,
1718 		      ap->ap_memsize);
1719 
1720 	kfree(ap, M_DEVBUF);
1721 	return;
1722     }
1723 
1724     /*
1725      * Try 8LD extended ENQUIRY to get controller signature, and use lookup table.
1726      */
1727     if ((ae = (struct amr_enquiry *)amr_enquiry(sc, 2048, AMR_CMD_EXT_ENQUIRY2, 0, 0)) != NULL) {
1728 	prod = amr_describe_code(amr_table_adaptertype, ae->ae_signature);
1729 
1730     } else if ((ae = (struct amr_enquiry *)amr_enquiry(sc, 2048, AMR_CMD_ENQUIRY, 0, 0)) != NULL) {
1731 
1732 	/*
1733 	 * Try to work it out based on the PCI signatures.
1734 	 */
1735 	switch (pci_get_device(sc->amr_dev)) {
1736 	case 0x9010:
1737 	    prod = "Series 428";
1738 	    break;
1739 	case 0x9060:
1740 	    prod = "Series 434";
1741 	    break;
1742 	default:
1743 	    prod = "unknown controller";
1744 	    break;
1745 	}
1746     } else {
1747 	prod = "unsupported controller";
1748     }
1749 
1750     /*
1751      * HP NetRaid controllers have a special encoding of the firmware and
1752      * BIOS versions. The AMI version seems to have it as strings whereas
1753      * the HP version does it with a leading uppercase character and two
1754      * binary numbers.
1755      */
1756 
1757     if(ae->ae_adapter.aa_firmware[2] >= 'A' &&
1758        ae->ae_adapter.aa_firmware[2] <= 'Z' &&
1759        ae->ae_adapter.aa_firmware[1] <  ' ' &&
1760        ae->ae_adapter.aa_firmware[0] <  ' ' &&
1761        ae->ae_adapter.aa_bios[2] >= 'A'     &&
1762        ae->ae_adapter.aa_bios[2] <= 'Z'     &&
1763        ae->ae_adapter.aa_bios[1] <  ' '     &&
1764        ae->ae_adapter.aa_bios[0] <  ' ') {
1765 
1766 	/* this looks like we have an HP NetRaid version of the MegaRaid */
1767 
1768     	if(ae->ae_signature == AMR_SIG_438) {
1769     		/* the AMI 438 is a NetRaid 3si in HP-land */
1770     		prod = "HP NetRaid 3si";
1771     	}
1772 
1773 	device_printf(sc->amr_dev, "<%s> Firmware %c.%02d.%02d, BIOS %c.%02d.%02d, %dMB RAM\n",
1774 		      prod, ae->ae_adapter.aa_firmware[2],
1775 		      ae->ae_adapter.aa_firmware[1],
1776 		      ae->ae_adapter.aa_firmware[0],
1777 		      ae->ae_adapter.aa_bios[2],
1778 		      ae->ae_adapter.aa_bios[1],
1779 		      ae->ae_adapter.aa_bios[0],
1780 		      ae->ae_adapter.aa_memorysize);
1781     } else {
1782 	device_printf(sc->amr_dev, "<%s> Firmware %.4s, BIOS %.4s, %dMB RAM\n",
1783 		      prod, ae->ae_adapter.aa_firmware, ae->ae_adapter.aa_bios,
1784 		      ae->ae_adapter.aa_memorysize);
1785     }
1786     kfree(ae, M_DEVBUF);
1787 }
1788 
1789 int
1790 amr_dump_blocks(struct amr_softc *sc, int unit, u_int64_t lba, void *data, int blks)
1791 {
1792 
1793     struct amr_command	*ac;
1794     int			error = 1;
1795 
1796     debug_called(1);
1797 
1798     sc->amr_state &= ~AMR_STATE_INTEN;
1799 
1800     /* get ourselves a command buffer */
1801     if ((ac = amr_alloccmd(sc)) == NULL)
1802 	goto out;
1803     /* set command flags */
1804     ac->ac_flags |= AMR_CMD_PRIORITY | AMR_CMD_DATAOUT;
1805 
1806     /* point the command at our data */
1807     ac->ac_data = data;
1808     ac->ac_length = blks * AMR_BLKSIZE;
1809 
1810     /* build the command proper */
1811     ac->ac_mailbox.mb_command 	= AMR_CMD_LWRITE;
1812     ac->ac_mailbox.mb_blkcount	= blks;
1813     ac->ac_mailbox.mb_lba	= lba;
1814     ac->ac_mailbox.mb_drive	= unit;
1815 
1816     /* can't assume that interrupts are going to work here, so play it safe */
1817     if (sc->amr_poll_command(ac))
1818 	goto out;
1819     error = ac->ac_status;
1820 
1821  out:
1822     if (ac != NULL)
1823 	amr_releasecmd(ac);
1824 
1825     sc->amr_state |= AMR_STATE_INTEN;
1826 
1827     return (error);
1828 }
1829 
1830 
1831 #ifdef AMR_DEBUG
1832 /********************************************************************************
1833  * Print the command (ac) in human-readable format
1834  */
1835 #if 0
1836 static void
1837 amr_printcommand(struct amr_command *ac)
1838 {
1839     struct amr_softc	*sc = ac->ac_sc;
1840     struct amr_sgentry	*sg;
1841     int			i;
1842 
1843     device_printf(sc->amr_dev, "cmd %x  ident %d  drive %d\n",
1844 		  ac->ac_mailbox.mb_command, ac->ac_mailbox.mb_ident, ac->ac_mailbox.mb_drive);
1845     device_printf(sc->amr_dev, "blkcount %d  lba %d\n",
1846 		  ac->ac_mailbox.mb_blkcount, ac->ac_mailbox.mb_lba);
1847     device_printf(sc->amr_dev, "virtaddr %p  length %lu\n", ac->ac_data, (unsigned long)ac->ac_length);
1848     device_printf(sc->amr_dev, "sg physaddr %08x  nsg %d\n",
1849 		  ac->ac_mailbox.mb_physaddr, ac->ac_mailbox.mb_nsgelem);
1850     device_printf(sc->amr_dev, "ccb %p  bio %p\n", ac->ac_ccb_data, ac->ac_bio);
1851 
1852     /* get base address of s/g table */
1853     sg = sc->amr_sgtable + (ac->ac_slot * AMR_NSEG);
1854     for (i = 0; i < ac->ac_mailbox.mb_nsgelem; i++, sg++)
1855 	device_printf(sc->amr_dev, "  %x/%d\n", sg->sg_addr, sg->sg_count);
1856 }
1857 #endif
1858 #endif
1859