xref: /dragonfly/sys/dev/raid/mly/mly.c (revision 17b61719)
1 /*-
2  * Copyright (c) 2000, 2001 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  *	$FreeBSD: src/sys/dev/mly/mly.c,v 1.3.2.3 2001/03/05 20:17:24 msmith Exp $
28  *	$DragonFly: src/sys/dev/raid/mly/mly.c,v 1.10 2004/06/21 15:39:31 dillon Exp $
29  */
30 
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/malloc.h>
34 #include <sys/kernel.h>
35 #include <sys/bus.h>
36 #include <sys/conf.h>
37 #include <sys/ctype.h>
38 #include <sys/ioccom.h>
39 #include <sys/stat.h>
40 
41 #include <machine/bus_memio.h>
42 #include <machine/bus.h>
43 #include <machine/resource.h>
44 #include <sys/rman.h>
45 
46 #include <bus/cam/scsi/scsi_all.h>
47 
48 #include "mlyreg.h"
49 #include "mlyio.h"
50 #include "mlyvar.h"
51 #define MLY_DEFINE_TABLES
52 #include "mly_tables.h"
53 
54 static int	mly_get_controllerinfo(struct mly_softc *sc);
55 static void	mly_scan_devices(struct mly_softc *sc);
56 static void	mly_rescan_btl(struct mly_softc *sc, int bus, int target);
57 static void	mly_complete_rescan(struct mly_command *mc);
58 static int	mly_get_eventstatus(struct mly_softc *sc);
59 static int	mly_enable_mmbox(struct mly_softc *sc);
60 static int	mly_flush(struct mly_softc *sc);
61 static int	mly_ioctl(struct mly_softc *sc, struct mly_command_ioctl *ioctl, void **data,
62 			  size_t datasize, u_int8_t *status, void *sense_buffer, size_t *sense_length);
63 static void	mly_fetch_event(struct mly_softc *sc);
64 static void	mly_complete_event(struct mly_command *mc);
65 static void	mly_process_event(struct mly_softc *sc, struct mly_event *me);
66 static void	mly_periodic(void *data);
67 
68 static int	mly_immediate_command(struct mly_command *mc);
69 static int	mly_start(struct mly_command *mc);
70 static void	mly_complete(void *context, int pending);
71 
72 static void	mly_alloc_commands_map(void *arg, bus_dma_segment_t *segs, int nseg, int error);
73 static int	mly_alloc_commands(struct mly_softc *sc);
74 static void	mly_map_command(struct mly_command *mc);
75 static void	mly_unmap_command(struct mly_command *mc);
76 
77 static int	mly_fwhandshake(struct mly_softc *sc);
78 
79 static void	mly_describe_controller(struct mly_softc *sc);
80 #ifdef MLY_DEBUG
81 static void	mly_printstate(struct mly_softc *sc);
82 static void	mly_print_command(struct mly_command *mc);
83 static void	mly_print_packet(struct mly_command *mc);
84 static void	mly_panic(struct mly_softc *sc, char *reason);
85 #endif
86 void		mly_print_controller(int controller);
87 
88 static d_open_t		mly_user_open;
89 static d_close_t	mly_user_close;
90 static d_ioctl_t	mly_user_ioctl;
91 static int	mly_user_command(struct mly_softc *sc, struct mly_user_command *uc);
92 static int	mly_user_health(struct mly_softc *sc, struct mly_user_health *uh);
93 
94 #define MLY_CDEV_MAJOR  158
95 
96 static struct cdevsw mly_cdevsw = {
97     /* name */	"mly",
98     /* cmaj */	MLY_CDEV_MAJOR,
99     /* flags */	0,
100     /* port */	NULL,
101     /* clone */	NULL,
102 
103     mly_user_open,
104     mly_user_close,
105     noread,
106     nowrite,
107     mly_user_ioctl,
108     nopoll,
109     nommap,
110     nostrategy,
111     nodump,
112     nopsize
113 };
114 
115 /********************************************************************************
116  ********************************************************************************
117                                                                  Device Interface
118  ********************************************************************************
119  ********************************************************************************/
120 
121 /********************************************************************************
122  * Initialise the controller and softc
123  */
124 int
125 mly_attach(struct mly_softc *sc)
126 {
127     int		error;
128 
129     debug_called(1);
130 
131     /*
132      * Initialise per-controller queues.
133      */
134     mly_initq_free(sc);
135     mly_initq_ready(sc);
136     mly_initq_busy(sc);
137     mly_initq_complete(sc);
138 
139 #if defined(__FreeBSD__) && __FreeBSD_version >= 500005
140     /*
141      * Initialise command-completion task.
142      */
143     TASK_INIT(&sc->mly_task_complete, 0, mly_complete, sc);
144 #endif
145 
146     /* disable interrupts before we start talking to the controller */
147     MLY_MASK_INTERRUPTS(sc);
148 
149     /*
150      * Wait for the controller to come ready, handshake with the firmware if required.
151      * This is typically only necessary on platforms where the controller BIOS does not
152      * run.
153      */
154     if ((error = mly_fwhandshake(sc)))
155 	return(error);
156 
157     /*
158      * Allocate command buffers
159      */
160     if ((error = mly_alloc_commands(sc)))
161 	return(error);
162 
163     /*
164      * Obtain controller feature information
165      */
166     if ((error = mly_get_controllerinfo(sc)))
167 	return(error);
168 
169     /*
170      * Get the current event counter for health purposes, populate the initial
171      * health status buffer.
172      */
173     if ((error = mly_get_eventstatus(sc)))
174 	return(error);
175 
176     /*
177      * Enable memory-mailbox mode
178      */
179     if ((error = mly_enable_mmbox(sc)))
180 	return(error);
181 
182     /*
183      * Attach to CAM.
184      */
185     if ((error = mly_cam_attach(sc)))
186 	return(error);
187 
188     /*
189      * Print a little information about the controller
190      */
191     mly_describe_controller(sc);
192 
193     /*
194      * Mark all attached devices for rescan
195      */
196     mly_scan_devices(sc);
197 
198     /*
199      * Instigate the first status poll immediately.  Rescan completions won't
200      * happen until interrupts are enabled, which should still be before
201      * the SCSI subsystem gets to us. (XXX assuming CAM and interrupt-driven
202      * discovery here...)
203      */
204     mly_periodic((void *)sc);
205 
206     /*
207      * Create the control device.
208      */
209     cdevsw_add(&mly_cdevsw, -1, device_get_unit(sc->mly_dev));
210     sc->mly_dev_t = make_dev(&mly_cdevsw, device_get_unit(sc->mly_dev),
211     				UID_ROOT, GID_OPERATOR, S_IRUSR | S_IWUSR,
212 				"mly%d", device_get_unit(sc->mly_dev));
213     sc->mly_dev_t->si_drv1 = sc;
214 
215     /* enable interrupts now */
216     MLY_UNMASK_INTERRUPTS(sc);
217 
218     return(0);
219 }
220 
221 /********************************************************************************
222  * Bring the controller to a state where it can be safely left alone.
223  */
224 void
225 mly_detach(struct mly_softc *sc)
226 {
227 
228     debug_called(1);
229 
230     /* kill the periodic event */
231     untimeout(mly_periodic, sc, sc->mly_periodic);
232 
233     sc->mly_state |= MLY_STATE_SUSPEND;
234 
235     /* flush controller */
236     mly_printf(sc, "flushing cache...");
237     printf("%s\n", mly_flush(sc) ? "failed" : "done");
238 
239     MLY_MASK_INTERRUPTS(sc);
240 }
241 
242 /********************************************************************************
243  ********************************************************************************
244                                                                  Command Wrappers
245  ********************************************************************************
246  ********************************************************************************/
247 
248 /********************************************************************************
249  * Fill in the mly_controllerinfo and mly_controllerparam fields in the softc.
250  */
251 static int
252 mly_get_controllerinfo(struct mly_softc *sc)
253 {
254     struct mly_command_ioctl	mci;
255     u_int8_t			status;
256     int				error;
257 
258     debug_called(1);
259 
260     if (sc->mly_controllerinfo != NULL)
261 	free(sc->mly_controllerinfo, M_DEVBUF);
262 
263     /* build the getcontrollerinfo ioctl and send it */
264     bzero(&mci, sizeof(mci));
265     sc->mly_controllerinfo = NULL;
266     mci.sub_ioctl = MDACIOCTL_GETCONTROLLERINFO;
267     if ((error = mly_ioctl(sc, &mci, (void **)&sc->mly_controllerinfo, sizeof(*sc->mly_controllerinfo),
268 			   &status, NULL, NULL)))
269 	return(error);
270     if (status != 0)
271 	return(EIO);
272 
273     if (sc->mly_controllerparam != NULL)
274 	free(sc->mly_controllerparam, M_DEVBUF);
275 
276     /* build the getcontrollerparameter ioctl and send it */
277     bzero(&mci, sizeof(mci));
278     sc->mly_controllerparam = NULL;
279     mci.sub_ioctl = MDACIOCTL_GETCONTROLLERPARAMETER;
280     if ((error = mly_ioctl(sc, &mci, (void **)&sc->mly_controllerparam, sizeof(*sc->mly_controllerparam),
281 			   &status, NULL, NULL)))
282 	return(error);
283     if (status != 0)
284 	return(EIO);
285 
286     return(0);
287 }
288 
289 /********************************************************************************
290  * Schedule all possible devices for a rescan.
291  *
292  */
293 static void
294 mly_scan_devices(struct mly_softc *sc)
295 {
296     int		bus, target, nchn;
297 
298     debug_called(1);
299 
300     /*
301      * Clear any previous BTL information.
302      */
303     bzero(&sc->mly_btl, sizeof(sc->mly_btl));
304 
305     /*
306      * Mark all devices as requiring a rescan, and let the early periodic scan collect them.
307      */
308     nchn = sc->mly_controllerinfo->physical_channels_present +
309 	sc->mly_controllerinfo->virtual_channels_present;
310     for (bus = 0; bus < nchn; bus++)
311 	for (target = 0; target < MLY_MAX_TARGETS; target++)
312 	    sc->mly_btl[bus][target].mb_flags = MLY_BTL_RESCAN;
313 
314 }
315 
316 /********************************************************************************
317  * Rescan a device, possibly as a consequence of getting an event which suggests
318  * that it may have changed.
319  */
320 static void
321 mly_rescan_btl(struct mly_softc *sc, int bus, int target)
322 {
323     struct mly_command		*mc;
324     struct mly_command_ioctl	*mci;
325 
326     debug_called(2);
327 
328     /* get a command */
329     mc = NULL;
330     if (mly_alloc_command(sc, &mc))
331 	return;				/* we'll be retried soon */
332 
333     /* set up the data buffer */
334     mc->mc_data = malloc(sizeof(union mly_devinfo), M_DEVBUF, M_INTWAIT | M_ZERO);
335     mc->mc_flags |= MLY_CMD_DATAIN;
336     mc->mc_complete = mly_complete_rescan;
337 
338     sc->mly_btl[bus][target].mb_flags &= ~MLY_BTL_RESCAN;
339 
340     /*
341      * Build the ioctl.
342      *
343      * At this point we are committed to sending this request, as it
344      * will be the only one constructed for this particular update.
345      */
346     mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
347     mci->opcode = MDACMD_IOCTL;
348     mci->addr.phys.controller = 0;
349     mci->timeout.value = 30;
350     mci->timeout.scale = MLY_TIMEOUT_SECONDS;
351     if (bus >= sc->mly_controllerinfo->physical_channels_present) {
352 	mc->mc_length = mci->data_size = sizeof(struct mly_ioctl_getlogdevinfovalid);
353 	mci->sub_ioctl = MDACIOCTL_GETLOGDEVINFOVALID;
354 	mci->addr.log.logdev = ((bus - sc->mly_controllerinfo->physical_channels_present) * MLY_MAX_TARGETS)
355 	    + target;
356 	debug(2, "logical device %d", mci->addr.log.logdev);
357     } else {
358 	mc->mc_length = mci->data_size = sizeof(struct mly_ioctl_getphysdevinfovalid);
359 	mci->sub_ioctl = MDACIOCTL_GETPHYSDEVINFOVALID;
360 	mci->addr.phys.lun = 0;
361 	mci->addr.phys.target = target;
362 	mci->addr.phys.channel = bus;
363 	debug(2, "physical device %d:%d", mci->addr.phys.channel, mci->addr.phys.target);
364     }
365 
366     /*
367      * Use the ready queue to get this command dispatched.
368      */
369     mly_enqueue_ready(mc);
370     mly_startio(sc);
371 }
372 
373 /********************************************************************************
374  * Handle the completion of a rescan operation
375  */
376 static void
377 mly_complete_rescan(struct mly_command *mc)
378 {
379     struct mly_softc				*sc = mc->mc_sc;
380     struct mly_ioctl_getlogdevinfovalid		*ldi;
381     struct mly_ioctl_getphysdevinfovalid	*pdi;
382     int						bus, target;
383 
384     debug_called(2);
385 
386     /* iff the command completed OK, we should use the result to update our data */
387     if (mc->mc_status == 0) {
388 	if (mc->mc_length == sizeof(*ldi)) {
389 	    ldi = (struct mly_ioctl_getlogdevinfovalid *)mc->mc_data;
390 	    bus = MLY_LOGDEV_BUS(sc, ldi->logical_device_number);
391 	    target = MLY_LOGDEV_TARGET(ldi->logical_device_number);
392 	    sc->mly_btl[bus][target].mb_flags = MLY_BTL_LOGICAL;	/* clears all other flags */
393 	    sc->mly_btl[bus][target].mb_type = ldi->raid_level;
394 	    sc->mly_btl[bus][target].mb_state = ldi->state;
395 	    debug(2, "BTL rescan for %d returns %s, %s", ldi->logical_device_number,
396 		  mly_describe_code(mly_table_device_type, ldi->raid_level),
397 		  mly_describe_code(mly_table_device_state, ldi->state));
398 	} else if (mc->mc_length == sizeof(*pdi)) {
399 	    pdi = (struct mly_ioctl_getphysdevinfovalid *)mc->mc_data;
400 	    bus = pdi->channel;
401 	    target = pdi->target;
402 	    sc->mly_btl[bus][target].mb_flags = MLY_BTL_PHYSICAL;	/* clears all other flags */
403 	    sc->mly_btl[bus][target].mb_type = MLY_DEVICE_TYPE_PHYSICAL;
404 	    sc->mly_btl[bus][target].mb_state = pdi->state;
405 	    sc->mly_btl[bus][target].mb_speed = pdi->speed;
406 	    sc->mly_btl[bus][target].mb_width = pdi->width;
407 	    if (pdi->state != MLY_DEVICE_STATE_UNCONFIGURED)
408 		sc->mly_btl[bus][target].mb_flags |= MLY_BTL_PROTECTED;
409 	    debug(2, "BTL rescan for %d:%d returns %s", bus, target,
410 		  mly_describe_code(mly_table_device_state, pdi->state));
411 	} else {
412 	    mly_printf(sc, "BTL rescan result corrupted\n");
413 	}
414     } else {
415 	/*
416 	 * A request sent for a device beyond the last device present will fail.
417 	 * We don't care about this, so we do nothing about it.
418 	 */
419     }
420     free(mc->mc_data, M_DEVBUF);
421     mly_release_command(mc);
422 }
423 
424 /********************************************************************************
425  * Get the current health status and set the 'next event' counter to suit.
426  */
427 static int
428 mly_get_eventstatus(struct mly_softc *sc)
429 {
430     struct mly_command_ioctl	mci;
431     struct mly_health_status	*mh;
432     u_int8_t			status;
433     int				error;
434 
435     /* build the gethealthstatus ioctl and send it */
436     bzero(&mci, sizeof(mci));
437     mh = NULL;
438     mci.sub_ioctl = MDACIOCTL_GETHEALTHSTATUS;
439 
440     if ((error = mly_ioctl(sc, &mci, (void **)&mh, sizeof(*mh), &status, NULL, NULL)))
441 	return(error);
442     if (status != 0)
443 	return(EIO);
444 
445     /* get the event counter */
446     sc->mly_event_change = mh->change_counter;
447     sc->mly_event_waiting = mh->next_event;
448     sc->mly_event_counter = mh->next_event;
449 
450     /* save the health status into the memory mailbox */
451     bcopy(mh, &sc->mly_mmbox->mmm_health.status, sizeof(*mh));
452 
453     debug(1, "initial change counter %d, event counter %d", mh->change_counter, mh->next_event);
454 
455     free(mh, M_DEVBUF);
456     return(0);
457 }
458 
459 /********************************************************************************
460  * Enable the memory mailbox mode.
461  */
462 static int
463 mly_enable_mmbox(struct mly_softc *sc)
464 {
465     struct mly_command_ioctl	mci;
466     u_int8_t			*sp, status;
467     int				error;
468 
469     debug_called(1);
470 
471     /* build the ioctl and send it */
472     bzero(&mci, sizeof(mci));
473     mci.sub_ioctl = MDACIOCTL_SETMEMORYMAILBOX;
474     /* set buffer addresses */
475     mci.param.setmemorymailbox.command_mailbox_physaddr =
476 	sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_command);
477     mci.param.setmemorymailbox.status_mailbox_physaddr =
478 	sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_status);
479     mci.param.setmemorymailbox.health_buffer_physaddr =
480 	sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_health);
481 
482     /* set buffer sizes - abuse of data_size field is revolting */
483     sp = (u_int8_t *)&mci.data_size;
484     sp[0] = ((sizeof(union mly_command_packet) * MLY_MMBOX_COMMANDS) / 1024);
485     sp[1] = (sizeof(union mly_status_packet) * MLY_MMBOX_STATUS) / 1024;
486     mci.param.setmemorymailbox.health_buffer_size = sizeof(union mly_health_region) / 1024;
487 
488     debug(1, "memory mailbox at %p (0x%llx/%d 0x%llx/%d 0x%llx/%d", sc->mly_mmbox,
489 	  mci.param.setmemorymailbox.command_mailbox_physaddr, sp[0],
490 	  mci.param.setmemorymailbox.status_mailbox_physaddr, sp[1],
491 	  mci.param.setmemorymailbox.health_buffer_physaddr,
492 	  mci.param.setmemorymailbox.health_buffer_size);
493 
494     if ((error = mly_ioctl(sc, &mci, NULL, 0, &status, NULL, NULL)))
495 	return(error);
496     if (status != 0)
497 	return(EIO);
498     sc->mly_state |= MLY_STATE_MMBOX_ACTIVE;
499     debug(1, "memory mailbox active");
500     return(0);
501 }
502 
503 /********************************************************************************
504  * Flush all pending I/O from the controller.
505  */
506 static int
507 mly_flush(struct mly_softc *sc)
508 {
509     struct mly_command_ioctl	mci;
510     u_int8_t			status;
511     int				error;
512 
513     debug_called(1);
514 
515     /* build the ioctl */
516     bzero(&mci, sizeof(mci));
517     mci.sub_ioctl = MDACIOCTL_FLUSHDEVICEDATA;
518     mci.param.deviceoperation.operation_device = MLY_OPDEVICE_PHYSICAL_CONTROLLER;
519 
520     /* pass it off to the controller */
521     if ((error = mly_ioctl(sc, &mci, NULL, 0, &status, NULL, NULL)))
522 	return(error);
523 
524     return((status == 0) ? 0 : EIO);
525 }
526 
527 /********************************************************************************
528  * Perform an ioctl command.
529  *
530  * If (data) is not NULL, the command requires data transfer.  If (*data) is NULL
531  * the command requires data transfer from the controller, and we will allocate
532  * a buffer for it.  If (*data) is not NULL, the command requires data transfer
533  * to the controller.
534  *
535  * XXX passing in the whole ioctl structure is ugly.  Better ideas?
536  *
537  * XXX we don't even try to handle the case where datasize > 4k.  We should.
538  */
539 static int
540 mly_ioctl(struct mly_softc *sc, struct mly_command_ioctl *ioctl, void **data, size_t datasize,
541 	  u_int8_t *status, void *sense_buffer, size_t *sense_length)
542 {
543     struct mly_command		*mc;
544     struct mly_command_ioctl	*mci;
545     int				error;
546 
547     debug_called(1);
548 
549     mc = NULL;
550     if (mly_alloc_command(sc, &mc)) {
551 	error = ENOMEM;
552 	goto out;
553     }
554 
555     /* copy the ioctl structure, but save some important fields and then fixup */
556     mci = &mc->mc_packet->ioctl;
557     ioctl->sense_buffer_address = mci->sense_buffer_address;
558     ioctl->maximum_sense_size = mci->maximum_sense_size;
559     *mci = *ioctl;
560     mci->opcode = MDACMD_IOCTL;
561     mci->timeout.value = 30;
562     mci->timeout.scale = MLY_TIMEOUT_SECONDS;
563 
564     /* handle the data buffer */
565     if (data != NULL) {
566 	if (*data == NULL) {
567 	    /* allocate data buffer */
568 	    mc->mc_data = malloc(datasize, M_DEVBUF, M_INTWAIT);
569 	    mc->mc_flags |= MLY_CMD_DATAIN;
570 	} else {
571 	    mc->mc_data = *data;
572 	    mc->mc_flags |= MLY_CMD_DATAOUT;
573 	}
574 	mc->mc_length = datasize;
575 	mc->mc_packet->generic.data_size = datasize;
576     }
577 
578     /* run the command */
579     if ((error = mly_immediate_command(mc)))
580 	goto out;
581 
582     /* clean up and return any data */
583     *status = mc->mc_status;
584     if ((mc->mc_sense > 0) && (sense_buffer != NULL)) {
585 	bcopy(mc->mc_packet, sense_buffer, mc->mc_sense);
586 	*sense_length = mc->mc_sense;
587 	goto out;
588     }
589 
590     /* should we return a data pointer? */
591     if ((data != NULL) && (*data == NULL))
592 	*data = mc->mc_data;
593 
594     /* command completed OK */
595     error = 0;
596 
597 out:
598     if (mc != NULL) {
599 	/* do we need to free a data buffer we allocated? */
600 	if (error && (mc->mc_data != NULL) && (*data == NULL))
601 	    free(mc->mc_data, M_DEVBUF);
602 	mly_release_command(mc);
603     }
604     return(error);
605 }
606 
607 /********************************************************************************
608  * Fetch one event from the controller.
609  */
610 static void
611 mly_fetch_event(struct mly_softc *sc)
612 {
613     struct mly_command		*mc;
614     struct mly_command_ioctl	*mci;
615     int				s;
616     u_int32_t			event;
617 
618     debug_called(2);
619 
620     /* get a command */
621     mc = NULL;
622     if (mly_alloc_command(sc, &mc))
623 	return;				/* we'll get retried the next time a command completes */
624 
625     /* set up the data buffer */
626     mc->mc_data = malloc(sizeof(struct mly_event), M_DEVBUF, M_INTWAIT|M_ZERO);
627     mc->mc_length = sizeof(struct mly_event);
628     mc->mc_flags |= MLY_CMD_DATAIN;
629     mc->mc_complete = mly_complete_event;
630 
631     /*
632      * Get an event number to fetch.  It's possible that we've raced with another
633      * context for the last event, in which case there will be no more events.
634      */
635     s = splcam();
636     if (sc->mly_event_counter == sc->mly_event_waiting) {
637 	mly_release_command(mc);
638 	splx(s);
639 	return;
640     }
641     event = sc->mly_event_counter++;
642     splx(s);
643 
644     /*
645      * Build the ioctl.
646      *
647      * At this point we are committed to sending this request, as it
648      * will be the only one constructed for this particular event number.
649      */
650     mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
651     mci->opcode = MDACMD_IOCTL;
652     mci->data_size = sizeof(struct mly_event);
653     mci->addr.phys.lun = (event >> 16) & 0xff;
654     mci->addr.phys.target = (event >> 24) & 0xff;
655     mci->addr.phys.channel = 0;
656     mci->addr.phys.controller = 0;
657     mci->timeout.value = 30;
658     mci->timeout.scale = MLY_TIMEOUT_SECONDS;
659     mci->sub_ioctl = MDACIOCTL_GETEVENT;
660     mci->param.getevent.sequence_number_low = event & 0xffff;
661 
662     debug(2, "fetch event %u", event);
663 
664     /*
665      * Use the ready queue to get this command dispatched.
666      */
667     mly_enqueue_ready(mc);
668     mly_startio(sc);
669 }
670 
671 /********************************************************************************
672  * Handle the completion of an event poll.
673  *
674  * Note that we don't actually have to instigate another poll; the completion of
675  * this command will trigger that if there are any more events to poll for.
676  */
677 static void
678 mly_complete_event(struct mly_command *mc)
679 {
680     struct mly_softc	*sc = mc->mc_sc;
681     struct mly_event	*me = (struct mly_event *)mc->mc_data;
682 
683     debug_called(2);
684 
685     /*
686      * If the event was successfully fetched, process it.
687      */
688     if (mc->mc_status == SCSI_STATUS_OK) {
689 	mly_process_event(sc, me);
690 	free(me, M_DEVBUF);
691     }
692     mly_release_command(mc);
693 }
694 
695 /********************************************************************************
696  * Process a controller event.
697  */
698 static void
699 mly_process_event(struct mly_softc *sc, struct mly_event *me)
700 {
701     struct scsi_sense_data	*ssd = (struct scsi_sense_data *)&me->sense[0];
702     char			*fp, *tp;
703     int				bus, target, event, class, action;
704 
705     /*
706      * Errors can be reported using vendor-unique sense data.  In this case, the
707      * event code will be 0x1c (Request sense data present), the sense key will
708      * be 0x09 (vendor specific), the MSB of the ASC will be set, and the
709      * actual event code will be a 16-bit value comprised of the ASCQ (low byte)
710      * and low seven bits of the ASC (low seven bits of the high byte).
711      */
712     if ((me->code == 0x1c) &&
713 	((ssd->flags & SSD_KEY) == SSD_KEY_Vendor_Specific) &&
714 	(ssd->add_sense_code & 0x80)) {
715 	event = ((int)(ssd->add_sense_code & ~0x80) << 8) + ssd->add_sense_code_qual;
716     } else {
717 	event = me->code;
718     }
719 
720     /* look up event, get codes */
721     fp = mly_describe_code(mly_table_event, event);
722 
723     debug(2, "Event %d  code 0x%x", me->sequence_number, me->code);
724 
725     /* quiet event? */
726     class = fp[0];
727     if (isupper(class) && bootverbose)
728 	class = tolower(class);
729 
730     /* get action code, text string */
731     action = fp[1];
732     tp = &fp[2];
733 
734     /*
735      * Print some information about the event.
736      *
737      * This code uses a table derived from the corresponding portion of the Linux
738      * driver, and thus the parser is very similar.
739      */
740     switch(class) {
741     case 'p':		/* error on physical device */
742 	mly_printf(sc, "physical device %d:%d %s\n", me->channel, me->target, tp);
743 	if (action == 'r')
744 	    sc->mly_btl[me->channel][me->target].mb_flags |= MLY_BTL_RESCAN;
745 	break;
746     case 'l':		/* error on logical unit */
747     case 'm':		/* message about logical unit */
748 	bus = MLY_LOGDEV_BUS(sc, me->lun);
749 	target = MLY_LOGDEV_TARGET(me->lun);
750 	mly_name_device(sc, bus, target);
751 	mly_printf(sc, "logical device %d (%s) %s\n", me->lun, sc->mly_btl[bus][target].mb_name, tp);
752 	if (action == 'r')
753 	    sc->mly_btl[bus][target].mb_flags |= MLY_BTL_RESCAN;
754 	break;
755       break;
756     case 's':		/* report of sense data */
757 	if (((ssd->flags & SSD_KEY) == SSD_KEY_NO_SENSE) ||
758 	    (((ssd->flags & SSD_KEY) == SSD_KEY_NOT_READY) &&
759 	     (ssd->add_sense_code == 0x04) &&
760 	     ((ssd->add_sense_code_qual == 0x01) || (ssd->add_sense_code_qual == 0x02))))
761 	    break;	/* ignore NO_SENSE or NOT_READY in one case */
762 
763 	mly_printf(sc, "physical device %d:%d %s\n", me->channel, me->target, tp);
764 	mly_printf(sc, "  sense key %d  asc %02x  ascq %02x\n",
765 		      ssd->flags & SSD_KEY, ssd->add_sense_code, ssd->add_sense_code_qual);
766 	mly_printf(sc, "  info %4D  csi %4D\n", ssd->info, "", ssd->cmd_spec_info, "");
767 	if (action == 'r')
768 	    sc->mly_btl[me->channel][me->target].mb_flags |= MLY_BTL_RESCAN;
769 	break;
770     case 'e':
771 	mly_printf(sc, tp, me->target, me->lun);
772 	break;
773     case 'c':
774 	mly_printf(sc, "controller %s\n", tp);
775 	break;
776     case '?':
777 	mly_printf(sc, "%s - %d\n", tp, me->code);
778 	break;
779     default:	/* probably a 'noisy' event being ignored */
780 	break;
781     }
782 }
783 
784 /********************************************************************************
785  * Perform periodic activities.
786  */
787 static void
788 mly_periodic(void *data)
789 {
790     struct mly_softc	*sc = (struct mly_softc *)data;
791     int			nchn, bus, target;
792 
793     debug_called(2);
794 
795     /*
796      * Scan devices.
797      */
798     nchn = sc->mly_controllerinfo->physical_channels_present +
799 	sc->mly_controllerinfo->virtual_channels_present;
800     for (bus = 0; bus < nchn; bus++) {
801 	for (target = 0; target < MLY_MAX_TARGETS; target++) {
802 
803 	    /* ignore the controller in this scan */
804 	    if (target == sc->mly_controllerparam->initiator_id)
805 		continue;
806 
807 	    /* perform device rescan? */
808 	    if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_RESCAN)
809 		mly_rescan_btl(sc, bus, target);
810 	}
811     }
812 
813     sc->mly_periodic = timeout(mly_periodic, sc, hz);
814 }
815 
816 /********************************************************************************
817  ********************************************************************************
818                                                                Command Processing
819  ********************************************************************************
820  ********************************************************************************/
821 
822 /********************************************************************************
823  * Run a command and wait for it to complete.
824  *
825  */
826 static int
827 mly_immediate_command(struct mly_command *mc)
828 {
829     struct mly_softc	*sc = mc->mc_sc;
830     int			error, s;
831 
832     debug_called(2);
833 
834     /* spinning at splcam is ugly, but we're only used during controller init */
835     s = splcam();
836     if ((error = mly_start(mc)))
837 	return(error);
838 
839     if (sc->mly_state & MLY_STATE_INTERRUPTS_ON) {
840 	/* sleep on the command */
841 	while(!(mc->mc_flags & MLY_CMD_COMPLETE)) {
842 	    tsleep(mc, 0, "mlywait", 0);
843 	}
844     } else {
845 	/* spin and collect status while we do */
846 	while(!(mc->mc_flags & MLY_CMD_COMPLETE)) {
847 	    mly_done(mc->mc_sc);
848 	}
849     }
850     splx(s);
851     return(0);
852 }
853 
854 /********************************************************************************
855  * Start as much queued I/O as possible on the controller
856  */
857 void
858 mly_startio(struct mly_softc *sc)
859 {
860     struct mly_command	*mc;
861 
862     debug_called(2);
863 
864     for (;;) {
865 
866 	/* try for a ready command */
867 	mc = mly_dequeue_ready(sc);
868 
869 	/* try to build a command from a queued ccb */
870 	if (!mc)
871 	    mly_cam_command(sc, &mc);
872 
873 	/* no command == nothing to do */
874 	if (!mc)
875 	    break;
876 
877 	/* try to post the command */
878 	if (mly_start(mc)) {
879 	    /* controller busy, or no resources - defer for later */
880 	    mly_requeue_ready(mc);
881 	    break;
882 	}
883     }
884 }
885 
886 /********************************************************************************
887  * Deliver a command to the controller; allocate controller resources at the
888  * last moment.
889  */
890 static int
891 mly_start(struct mly_command *mc)
892 {
893     struct mly_softc		*sc = mc->mc_sc;
894     union mly_command_packet	*pkt;
895     int				s;
896 
897     debug_called(2);
898 
899     /*
900      * Set the command up for delivery to the controller.
901      */
902     mly_map_command(mc);
903     mc->mc_packet->generic.command_id = mc->mc_slot;
904 
905     s = splcam();
906 
907     /*
908      * Do we have to use the hardware mailbox?
909      */
910     if (!(sc->mly_state & MLY_STATE_MMBOX_ACTIVE)) {
911 	/*
912 	 * Check to see if the controller is ready for us.
913 	 */
914 	if (MLY_IDBR_TRUE(sc, MLY_HM_CMDSENT)) {
915 	    splx(s);
916 	    return(EBUSY);
917 	}
918 	mc->mc_flags |= MLY_CMD_BUSY;
919 
920 	/*
921 	 * It's ready, send the command.
922 	 */
923 	MLY_SET_MBOX(sc, sc->mly_command_mailbox, &mc->mc_packetphys);
924 	MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_CMDSENT);
925 
926     } else {	/* use memory-mailbox mode */
927 
928 	pkt = &sc->mly_mmbox->mmm_command[sc->mly_mmbox_command_index];
929 
930 	/* check to see if the next index is free yet */
931 	if (pkt->mmbox.flag != 0) {
932 	    splx(s);
933 	    return(EBUSY);
934 	}
935 	mc->mc_flags |= MLY_CMD_BUSY;
936 
937 	/* copy in new command */
938 	bcopy(mc->mc_packet->mmbox.data, pkt->mmbox.data, sizeof(pkt->mmbox.data));
939 	/* barrier to ensure completion of previous write before we write the flag */
940 	bus_space_barrier(NULL, NULL, 0, 0, BUS_SPACE_BARRIER_WRITE);	/* tag/handle? */
941 	/* copy flag last */
942 	pkt->mmbox.flag = mc->mc_packet->mmbox.flag;
943 	/* barrier to ensure completion of previous write before we notify the controller */
944 	bus_space_barrier(NULL, NULL, 0, 0, BUS_SPACE_BARRIER_WRITE);	/* tag/handle */
945 
946 	/* signal controller, update index */
947 	MLY_SET_REG(sc, sc->mly_idbr, MLY_AM_CMDSENT);
948 	sc->mly_mmbox_command_index = (sc->mly_mmbox_command_index + 1) % MLY_MMBOX_COMMANDS;
949     }
950 
951     mly_enqueue_busy(mc);
952     splx(s);
953     return(0);
954 }
955 
956 /********************************************************************************
957  * Pick up command status from the controller, schedule a completion event
958  */
959 void
960 mly_done(struct mly_softc *sc)
961 {
962     struct mly_command		*mc;
963     union mly_status_packet	*sp;
964     u_int16_t			slot;
965     int				s, worked;
966 
967     s = splcam();
968     worked = 0;
969 
970     /* pick up hardware-mailbox commands */
971     if (MLY_ODBR_TRUE(sc, MLY_HM_STSREADY)) {
972 	slot = MLY_GET_REG2(sc, sc->mly_status_mailbox);
973 	if (slot < MLY_SLOT_MAX) {
974 	    mc = &sc->mly_command[slot - MLY_SLOT_START];
975 	    mc->mc_status = MLY_GET_REG(sc, sc->mly_status_mailbox + 2);
976 	    mc->mc_sense = MLY_GET_REG(sc, sc->mly_status_mailbox + 3);
977 	    mc->mc_resid = MLY_GET_REG4(sc, sc->mly_status_mailbox + 4);
978 	    mly_remove_busy(mc);
979 	    mc->mc_flags &= ~MLY_CMD_BUSY;
980 	    mly_enqueue_complete(mc);
981 	    worked = 1;
982 	} else {
983 	    /* slot 0xffff may mean "extremely bogus command" */
984 	    mly_printf(sc, "got HM completion for illegal slot %u\n", slot);
985 	}
986 	/* unconditionally acknowledge status */
987 	MLY_SET_REG(sc, sc->mly_odbr, MLY_HM_STSREADY);
988 	MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_STSACK);
989     }
990 
991     /* pick up memory-mailbox commands */
992     if (MLY_ODBR_TRUE(sc, MLY_AM_STSREADY)) {
993 	for (;;) {
994 	    sp = &sc->mly_mmbox->mmm_status[sc->mly_mmbox_status_index];
995 
996 	    /* check for more status */
997 	    if (sp->mmbox.flag == 0)
998 		break;
999 
1000 	    /* get slot number */
1001 	    slot = sp->status.command_id;
1002 	    if (slot < MLY_SLOT_MAX) {
1003 		mc = &sc->mly_command[slot - MLY_SLOT_START];
1004 		mc->mc_status = sp->status.status;
1005 		mc->mc_sense = sp->status.sense_length;
1006 		mc->mc_resid = sp->status.residue;
1007 		mly_remove_busy(mc);
1008 		mc->mc_flags &= ~MLY_CMD_BUSY;
1009 		mly_enqueue_complete(mc);
1010 		worked = 1;
1011 	    } else {
1012 		/* slot 0xffff may mean "extremely bogus command" */
1013 		mly_printf(sc, "got AM completion for illegal slot %u at %d\n",
1014 			   slot, sc->mly_mmbox_status_index);
1015 	    }
1016 
1017 	    /* clear and move to next index */
1018 	    sp->mmbox.flag = 0;
1019 	    sc->mly_mmbox_status_index = (sc->mly_mmbox_status_index + 1) % MLY_MMBOX_STATUS;
1020 	}
1021 	/* acknowledge that we have collected status value(s) */
1022 	MLY_SET_REG(sc, sc->mly_odbr, MLY_AM_STSREADY);
1023     }
1024 
1025     splx(s);
1026     if (worked) {
1027 #if defined(__FreeBSD__) && __FreeBSD_version >= 500005
1028 	if (sc->mly_state & MLY_STATE_INTERRUPTS_ON)
1029 	    taskqueue_enqueue(taskqueue_swi, &sc->mly_task_complete);
1030 	else
1031 #endif
1032 	    mly_complete(sc, 0);
1033     }
1034 }
1035 
1036 /********************************************************************************
1037  * Process completed commands
1038  */
1039 static void
1040 mly_complete(void *context, int pending)
1041 {
1042     struct mly_softc	*sc = (struct mly_softc *)context;
1043     struct mly_command	*mc;
1044     void	        (* mc_complete)(struct mly_command *mc);
1045 
1046 
1047     debug_called(2);
1048 
1049     /*
1050      * Spin pulling commands off the completed queue and processing them.
1051      */
1052     while ((mc = mly_dequeue_complete(sc)) != NULL) {
1053 
1054 	/*
1055 	 * Free controller resources, mark command complete.
1056 	 *
1057 	 * Note that as soon as we mark the command complete, it may be freed
1058 	 * out from under us, so we need to save the mc_complete field in
1059 	 * order to later avoid dereferencing mc.  (We would not expect to
1060 	 * have a polling/sleeping consumer with mc_complete != NULL).
1061 	 */
1062 	mly_unmap_command(mc);
1063 	mc_complete = mc->mc_complete;
1064 	mc->mc_flags |= MLY_CMD_COMPLETE;
1065 
1066 	/*
1067 	 * Call completion handler or wake up sleeping consumer.
1068 	 */
1069 	if (mc_complete != NULL) {
1070 	    mc_complete(mc);
1071 	} else {
1072 	    wakeup(mc);
1073 	}
1074     }
1075 
1076     /*
1077      * We may have freed up controller resources which would allow us
1078      * to push more commands onto the controller, so we check here.
1079      */
1080     mly_startio(sc);
1081 
1082     /*
1083      * The controller may have updated the health status information,
1084      * so check for it here.
1085      *
1086      * Note that we only check for health status after a completed command.  It
1087      * might be wise to ping the controller occasionally if it's been idle for
1088      * a while just to check up on it.  While a filesystem is mounted, or I/O is
1089      * active this isn't really an issue.
1090      */
1091     if (sc->mly_mmbox->mmm_health.status.change_counter != sc->mly_event_change) {
1092 	sc->mly_event_change = sc->mly_mmbox->mmm_health.status.change_counter;
1093 	debug(1, "event change %d, event status update, %d -> %d", sc->mly_event_change,
1094 	      sc->mly_event_waiting, sc->mly_mmbox->mmm_health.status.next_event);
1095 	sc->mly_event_waiting = sc->mly_mmbox->mmm_health.status.next_event;
1096 
1097 	/* wake up anyone that might be interested in this */
1098 	wakeup(&sc->mly_event_change);
1099     }
1100     if (sc->mly_event_counter != sc->mly_event_waiting)
1101 	mly_fetch_event(sc);
1102 }
1103 
1104 /********************************************************************************
1105  ********************************************************************************
1106                                                         Command Buffer Management
1107  ********************************************************************************
1108  ********************************************************************************/
1109 
1110 /********************************************************************************
1111  * Allocate a command.
1112  */
1113 int
1114 mly_alloc_command(struct mly_softc *sc, struct mly_command **mcp)
1115 {
1116     struct mly_command	*mc;
1117 
1118     debug_called(3);
1119 
1120     if ((mc = mly_dequeue_free(sc)) == NULL)
1121 	return(ENOMEM);
1122 
1123     *mcp = mc;
1124     return(0);
1125 }
1126 
1127 /********************************************************************************
1128  * Release a command back to the freelist.
1129  */
1130 void
1131 mly_release_command(struct mly_command *mc)
1132 {
1133     debug_called(3);
1134 
1135     /*
1136      * Fill in parts of the command that may cause confusion if
1137      * a consumer doesn't when we are later allocated.
1138      */
1139     mc->mc_data = NULL;
1140     mc->mc_flags = 0;
1141     mc->mc_complete = NULL;
1142     mc->mc_private = NULL;
1143 
1144     /*
1145      * By default, we set up to overwrite the command packet with
1146      * sense information.
1147      */
1148     mc->mc_packet->generic.sense_buffer_address = mc->mc_packetphys;
1149     mc->mc_packet->generic.maximum_sense_size = sizeof(union mly_command_packet);
1150 
1151     mly_enqueue_free(mc);
1152 }
1153 
1154 /********************************************************************************
1155  * Map helper for command allocation.
1156  */
1157 static void
1158 mly_alloc_commands_map(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1159 {
1160     struct mly_softc	*sc = (struct mly_softc *)arg
1161 
1162     debug_called(2);
1163 
1164     sc->mly_packetphys = segs[0].ds_addr;
1165 }
1166 
1167 /********************************************************************************
1168  * Allocate and initialise command and packet structures.
1169  */
1170 static int
1171 mly_alloc_commands(struct mly_softc *sc)
1172 {
1173     struct mly_command		*mc;
1174     int				i;
1175 
1176     /*
1177      * Allocate enough space for all the command packets in one chunk and
1178      * map them permanently into controller-visible space.
1179      */
1180     if (bus_dmamem_alloc(sc->mly_packet_dmat, (void **)&sc->mly_packet,
1181 			 BUS_DMA_NOWAIT, &sc->mly_packetmap)) {
1182 	return(ENOMEM);
1183     }
1184     bus_dmamap_load(sc->mly_packet_dmat, sc->mly_packetmap, sc->mly_packet,
1185 		    MLY_MAXCOMMANDS * sizeof(union mly_command_packet),
1186 		    mly_alloc_commands_map, sc, 0);
1187 
1188     for (i = 0; i < MLY_MAXCOMMANDS; i++) {
1189 	mc = &sc->mly_command[i];
1190 	bzero(mc, sizeof(*mc));
1191 	mc->mc_sc = sc;
1192 	mc->mc_slot = MLY_SLOT_START + i;
1193 	mc->mc_packet = sc->mly_packet + i;
1194 	mc->mc_packetphys = sc->mly_packetphys + (i * sizeof(union mly_command_packet));
1195 	if (!bus_dmamap_create(sc->mly_buffer_dmat, 0, &mc->mc_datamap))
1196 	    mly_release_command(mc);
1197     }
1198     return(0);
1199 }
1200 
1201 /********************************************************************************
1202  * Command-mapping helper function - populate this command's s/g table
1203  * with the s/g entries for its data.
1204  */
1205 static void
1206 mly_map_command_sg(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1207 {
1208     struct mly_command		*mc = (struct mly_command *)arg;
1209     struct mly_softc		*sc = mc->mc_sc;
1210     struct mly_command_generic	*gen = &(mc->mc_packet->generic);
1211     struct mly_sg_entry		*sg;
1212     int				i, tabofs;
1213 
1214     debug_called(3);
1215 
1216     /* can we use the transfer structure directly? */
1217     if (nseg <= 2) {
1218 	sg = &gen->transfer.direct.sg[0];
1219 	gen->command_control.extended_sg_table = 0;
1220     } else {
1221 	tabofs = ((mc->mc_slot - MLY_SLOT_START) * MLY_MAXSGENTRIES);
1222 	sg = sc->mly_sg_table + tabofs;
1223 	gen->transfer.indirect.entries[0] = nseg;
1224 	gen->transfer.indirect.table_physaddr[0] = sc->mly_sg_busaddr + (tabofs * sizeof(struct mly_sg_entry));
1225 	gen->command_control.extended_sg_table = 1;
1226     }
1227 
1228     /* copy the s/g table */
1229     for (i = 0; i < nseg; i++) {
1230 	sg[i].physaddr = segs[i].ds_addr;
1231 	sg[i].length = segs[i].ds_len;
1232     }
1233 
1234 }
1235 
1236 #if 0
1237 /********************************************************************************
1238  * Command-mapping helper function - save the cdb's physical address.
1239  *
1240  * We don't support 'large' SCSI commands at this time, so this is unused.
1241  */
1242 static void
1243 mly_map_command_cdb(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1244 {
1245     struct mly_command			*mc = (struct mly_command *)arg;
1246 
1247     debug_called(3);
1248 
1249     /* XXX can we safely assume that a CDB will never cross a page boundary? */
1250     if ((segs[0].ds_addr % PAGE_SIZE) >
1251 	((segs[0].ds_addr + mc->mc_packet->scsi_large.cdb_length) % PAGE_SIZE))
1252 	panic("cdb crosses page boundary");
1253 
1254     /* fix up fields in the command packet */
1255     mc->mc_packet->scsi_large.cdb_physaddr = segs[0].ds_addr;
1256 }
1257 #endif
1258 
1259 /********************************************************************************
1260  * Map a command into controller-visible space
1261  */
1262 static void
1263 mly_map_command(struct mly_command *mc)
1264 {
1265     struct mly_softc	*sc = mc->mc_sc;
1266 
1267     debug_called(2);
1268 
1269     /* don't map more than once */
1270     if (mc->mc_flags & MLY_CMD_MAPPED)
1271 	return;
1272 
1273     /* does the command have a data buffer? */
1274     if (mc->mc_data != NULL)
1275 	bus_dmamap_load(sc->mly_buffer_dmat, mc->mc_datamap, mc->mc_data, mc->mc_length,
1276 			mly_map_command_sg, mc, 0);
1277 
1278     if (mc->mc_flags & MLY_CMD_DATAIN)
1279 	bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_PREREAD);
1280     if (mc->mc_flags & MLY_CMD_DATAOUT)
1281 	bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_PREWRITE);
1282 
1283     mc->mc_flags |= MLY_CMD_MAPPED;
1284 }
1285 
1286 /********************************************************************************
1287  * Unmap a command from controller-visible space
1288  */
1289 static void
1290 mly_unmap_command(struct mly_command *mc)
1291 {
1292     struct mly_softc	*sc = mc->mc_sc;
1293 
1294     debug_called(2);
1295 
1296     if (!(mc->mc_flags & MLY_CMD_MAPPED))
1297 	return;
1298 
1299     if (mc->mc_flags & MLY_CMD_DATAIN)
1300 	bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_POSTREAD);
1301     if (mc->mc_flags & MLY_CMD_DATAOUT)
1302 	bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_POSTWRITE);
1303 
1304     /* does the command have a data buffer? */
1305     if (mc->mc_data != NULL)
1306 	bus_dmamap_unload(sc->mly_buffer_dmat, mc->mc_datamap);
1307 
1308     mc->mc_flags &= ~MLY_CMD_MAPPED;
1309 }
1310 
1311 /********************************************************************************
1312  ********************************************************************************
1313                                                                  Hardware Control
1314  ********************************************************************************
1315  ********************************************************************************/
1316 
1317 /********************************************************************************
1318  * Handshake with the firmware while the card is being initialised.
1319  */
1320 static int
1321 mly_fwhandshake(struct mly_softc *sc)
1322 {
1323     u_int8_t	error, param0, param1;
1324     int		spinup = 0;
1325 
1326     debug_called(1);
1327 
1328     /* set HM_STSACK and let the firmware initialise */
1329     MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_STSACK);
1330     DELAY(1000);	/* too short? */
1331 
1332     /* if HM_STSACK is still true, the controller is initialising */
1333     if (!MLY_IDBR_TRUE(sc, MLY_HM_STSACK))
1334 	return(0);
1335     mly_printf(sc, "controller initialisation started\n");
1336 
1337     /* spin waiting for initialisation to finish, or for a message to be delivered */
1338     while (MLY_IDBR_TRUE(sc, MLY_HM_STSACK)) {
1339 	/* check for a message */
1340 	if (MLY_ERROR_VALID(sc)) {
1341 	    error = MLY_GET_REG(sc, sc->mly_error_status) & ~MLY_MSG_EMPTY;
1342 	    param0 = MLY_GET_REG(sc, sc->mly_command_mailbox);
1343 	    param1 = MLY_GET_REG(sc, sc->mly_command_mailbox + 1);
1344 
1345 	    switch(error) {
1346 	    case MLY_MSG_SPINUP:
1347 		if (!spinup) {
1348 		    mly_printf(sc, "drive spinup in progress\n");
1349 		    spinup = 1;			/* only print this once (should print drive being spun?) */
1350 		}
1351 		break;
1352 	    case MLY_MSG_RACE_RECOVERY_FAIL:
1353 		mly_printf(sc, "mirror race recovery failed, one or more drives offline\n");
1354 		break;
1355 	    case MLY_MSG_RACE_IN_PROGRESS:
1356 		mly_printf(sc, "mirror race recovery in progress\n");
1357 		break;
1358 	    case MLY_MSG_RACE_ON_CRITICAL:
1359 		mly_printf(sc, "mirror race recovery on a critical drive\n");
1360 		break;
1361 	    case MLY_MSG_PARITY_ERROR:
1362 		mly_printf(sc, "FATAL MEMORY PARITY ERROR\n");
1363 		return(ENXIO);
1364 	    default:
1365 		mly_printf(sc, "unknown initialisation code 0x%x\n", error);
1366 	    }
1367 	}
1368     }
1369     return(0);
1370 }
1371 
1372 /********************************************************************************
1373  ********************************************************************************
1374                                                         Debugging and Diagnostics
1375  ********************************************************************************
1376  ********************************************************************************/
1377 
1378 /********************************************************************************
1379  * Print some information about the controller.
1380  */
1381 static void
1382 mly_describe_controller(struct mly_softc *sc)
1383 {
1384     struct mly_ioctl_getcontrollerinfo	*mi = sc->mly_controllerinfo;
1385 
1386     mly_printf(sc, "%16s, %d channel%s, firmware %d.%02d-%d-%02d (%02d%02d%02d%02d), %dMB RAM\n",
1387 	       mi->controller_name, mi->physical_channels_present, (mi->physical_channels_present) > 1 ? "s" : "",
1388 	       mi->fw_major, mi->fw_minor, mi->fw_turn, mi->fw_build,	/* XXX turn encoding? */
1389 	       mi->fw_century, mi->fw_year, mi->fw_month, mi->fw_day,
1390 	       mi->memory_size);
1391 
1392     if (bootverbose) {
1393 	mly_printf(sc, "%s %s (%x), %dMHz %d-bit %.16s\n",
1394 		   mly_describe_code(mly_table_oemname, mi->oem_information),
1395 		   mly_describe_code(mly_table_controllertype, mi->controller_type), mi->controller_type,
1396 		   mi->interface_speed, mi->interface_width, mi->interface_name);
1397 	mly_printf(sc, "%dMB %dMHz %d-bit %s%s%s, cache %dMB\n",
1398 		   mi->memory_size, mi->memory_speed, mi->memory_width,
1399 		   mly_describe_code(mly_table_memorytype, mi->memory_type),
1400 		   mi->memory_parity ? "+parity": "",mi->memory_ecc ? "+ECC": "",
1401 		   mi->cache_size);
1402 	mly_printf(sc, "CPU: %s @ %dMHZ\n",
1403 		   mly_describe_code(mly_table_cputype, mi->cpu[0].type), mi->cpu[0].speed);
1404 	if (mi->l2cache_size != 0)
1405 	    mly_printf(sc, "%dKB L2 cache\n", mi->l2cache_size);
1406 	if (mi->exmemory_size != 0)
1407 	    mly_printf(sc, "%dMB %dMHz %d-bit private %s%s%s\n",
1408 		       mi->exmemory_size, mi->exmemory_speed, mi->exmemory_width,
1409 		       mly_describe_code(mly_table_memorytype, mi->exmemory_type),
1410 		       mi->exmemory_parity ? "+parity": "",mi->exmemory_ecc ? "+ECC": "");
1411 	mly_printf(sc, "battery backup %s\n", mi->bbu_present ? "present" : "not installed");
1412 	mly_printf(sc, "maximum data transfer %d blocks, maximum sg entries/command %d\n",
1413 		   mi->maximum_block_count, mi->maximum_sg_entries);
1414 	mly_printf(sc, "logical devices present/critical/offline %d/%d/%d\n",
1415 		   mi->logical_devices_present, mi->logical_devices_critical, mi->logical_devices_offline);
1416 	mly_printf(sc, "physical devices present %d\n",
1417 		   mi->physical_devices_present);
1418 	mly_printf(sc, "physical disks present/offline %d/%d\n",
1419 		   mi->physical_disks_present, mi->physical_disks_offline);
1420 	mly_printf(sc, "%d physical channel%s, %d virtual channel%s of %d possible\n",
1421 		   mi->physical_channels_present, mi->physical_channels_present == 1 ? "" : "s",
1422 		   mi->virtual_channels_present, mi->virtual_channels_present == 1 ? "" : "s",
1423 		   mi->virtual_channels_possible);
1424 	mly_printf(sc, "%d parallel commands supported\n", mi->maximum_parallel_commands);
1425 	mly_printf(sc, "%dMB flash ROM, %d of %d maximum cycles\n",
1426 		   mi->flash_size, mi->flash_age, mi->flash_maximum_age);
1427     }
1428 }
1429 
1430 #ifdef MLY_DEBUG
1431 /********************************************************************************
1432  * Print some controller state
1433  */
1434 static void
1435 mly_printstate(struct mly_softc *sc)
1436 {
1437     mly_printf(sc, "IDBR %02x  ODBR %02x  ERROR %02x  (%x %x %x)\n",
1438 		  MLY_GET_REG(sc, sc->mly_idbr),
1439 		  MLY_GET_REG(sc, sc->mly_odbr),
1440 		  MLY_GET_REG(sc, sc->mly_error_status),
1441 		  sc->mly_idbr,
1442 		  sc->mly_odbr,
1443 		  sc->mly_error_status);
1444     mly_printf(sc, "IMASK %02x  ISTATUS %02x\n",
1445 		  MLY_GET_REG(sc, sc->mly_interrupt_mask),
1446 		  MLY_GET_REG(sc, sc->mly_interrupt_status));
1447     mly_printf(sc, "COMMAND %02x %02x %02x %02x %02x %02x %02x %02x\n",
1448 		  MLY_GET_REG(sc, sc->mly_command_mailbox),
1449 		  MLY_GET_REG(sc, sc->mly_command_mailbox + 1),
1450 		  MLY_GET_REG(sc, sc->mly_command_mailbox + 2),
1451 		  MLY_GET_REG(sc, sc->mly_command_mailbox + 3),
1452 		  MLY_GET_REG(sc, sc->mly_command_mailbox + 4),
1453 		  MLY_GET_REG(sc, sc->mly_command_mailbox + 5),
1454 		  MLY_GET_REG(sc, sc->mly_command_mailbox + 6),
1455 		  MLY_GET_REG(sc, sc->mly_command_mailbox + 7));
1456     mly_printf(sc, "STATUS  %02x %02x %02x %02x %02x %02x %02x %02x\n",
1457 		  MLY_GET_REG(sc, sc->mly_status_mailbox),
1458 		  MLY_GET_REG(sc, sc->mly_status_mailbox + 1),
1459 		  MLY_GET_REG(sc, sc->mly_status_mailbox + 2),
1460 		  MLY_GET_REG(sc, sc->mly_status_mailbox + 3),
1461 		  MLY_GET_REG(sc, sc->mly_status_mailbox + 4),
1462 		  MLY_GET_REG(sc, sc->mly_status_mailbox + 5),
1463 		  MLY_GET_REG(sc, sc->mly_status_mailbox + 6),
1464 		  MLY_GET_REG(sc, sc->mly_status_mailbox + 7));
1465     mly_printf(sc, "        %04x        %08x\n",
1466 		  MLY_GET_REG2(sc, sc->mly_status_mailbox),
1467 		  MLY_GET_REG4(sc, sc->mly_status_mailbox + 4));
1468 }
1469 
1470 struct mly_softc	*mly_softc0 = NULL;
1471 void
1472 mly_printstate0(void)
1473 {
1474     if (mly_softc0 != NULL)
1475 	mly_printstate(mly_softc0);
1476 }
1477 
1478 /********************************************************************************
1479  * Print a command
1480  */
1481 static void
1482 mly_print_command(struct mly_command *mc)
1483 {
1484     struct mly_softc	*sc = mc->mc_sc;
1485 
1486     mly_printf(sc, "COMMAND @ %p\n", mc);
1487     mly_printf(sc, "  slot      %d\n", mc->mc_slot);
1488     mly_printf(sc, "  status    0x%x\n", mc->mc_status);
1489     mly_printf(sc, "  sense len %d\n", mc->mc_sense);
1490     mly_printf(sc, "  resid     %d\n", mc->mc_resid);
1491     mly_printf(sc, "  packet    %p/0x%llx\n", mc->mc_packet, mc->mc_packetphys);
1492     if (mc->mc_packet != NULL)
1493 	mly_print_packet(mc);
1494     mly_printf(sc, "  data      %p/%d\n", mc->mc_data, mc->mc_length);
1495     mly_printf(sc, "  flags     %b\n", mc->mc_flags, "\20\1busy\2complete\3slotted\4mapped\5datain\6dataout\n");
1496     mly_printf(sc, "  complete  %p\n", mc->mc_complete);
1497     mly_printf(sc, "  private   %p\n", mc->mc_private);
1498 }
1499 
1500 /********************************************************************************
1501  * Print a command packet
1502  */
1503 static void
1504 mly_print_packet(struct mly_command *mc)
1505 {
1506     struct mly_softc			*sc = mc->mc_sc;
1507     struct mly_command_generic		*ge = (struct mly_command_generic *)mc->mc_packet;
1508     struct mly_command_scsi_small	*ss = (struct mly_command_scsi_small *)mc->mc_packet;
1509     struct mly_command_scsi_large	*sl = (struct mly_command_scsi_large *)mc->mc_packet;
1510     struct mly_command_ioctl		*io = (struct mly_command_ioctl *)mc->mc_packet;
1511     int					transfer;
1512 
1513     mly_printf(sc, "   command_id           %d\n", ge->command_id);
1514     mly_printf(sc, "   opcode               %d\n", ge->opcode);
1515     mly_printf(sc, "   command_control      fua %d  dpo %d  est %d  dd %s  nas %d ddis %d\n",
1516 		  ge->command_control.force_unit_access,
1517 		  ge->command_control.disable_page_out,
1518 		  ge->command_control.extended_sg_table,
1519 		  (ge->command_control.data_direction == MLY_CCB_WRITE) ? "WRITE" : "READ",
1520 		  ge->command_control.no_auto_sense,
1521 		  ge->command_control.disable_disconnect);
1522     mly_printf(sc, "   data_size            %d\n", ge->data_size);
1523     mly_printf(sc, "   sense_buffer_address 0x%llx\n", ge->sense_buffer_address);
1524     mly_printf(sc, "   lun                  %d\n", ge->addr.phys.lun);
1525     mly_printf(sc, "   target               %d\n", ge->addr.phys.target);
1526     mly_printf(sc, "   channel              %d\n", ge->addr.phys.channel);
1527     mly_printf(sc, "   logical device       %d\n", ge->addr.log.logdev);
1528     mly_printf(sc, "   controller           %d\n", ge->addr.phys.controller);
1529     mly_printf(sc, "   timeout              %d %s\n",
1530 		  ge->timeout.value,
1531 		  (ge->timeout.scale == MLY_TIMEOUT_SECONDS) ? "seconds" :
1532 		  ((ge->timeout.scale == MLY_TIMEOUT_MINUTES) ? "minutes" : "hours"));
1533     mly_printf(sc, "   maximum_sense_size   %d\n", ge->maximum_sense_size);
1534     switch(ge->opcode) {
1535     case MDACMD_SCSIPT:
1536     case MDACMD_SCSI:
1537 	mly_printf(sc, "   cdb length           %d\n", ss->cdb_length);
1538 	mly_printf(sc, "   cdb                  %*D\n", ss->cdb_length, ss->cdb, " ");
1539 	transfer = 1;
1540 	break;
1541     case MDACMD_SCSILC:
1542     case MDACMD_SCSILCPT:
1543 	mly_printf(sc, "   cdb length           %d\n", sl->cdb_length);
1544 	mly_printf(sc, "   cdb                  0x%llx\n", sl->cdb_physaddr);
1545 	transfer = 1;
1546 	break;
1547     case MDACMD_IOCTL:
1548 	mly_printf(sc, "   sub_ioctl            0x%x\n", io->sub_ioctl);
1549 	switch(io->sub_ioctl) {
1550 	case MDACIOCTL_SETMEMORYMAILBOX:
1551 	    mly_printf(sc, "   health_buffer_size   %d\n",
1552 			  io->param.setmemorymailbox.health_buffer_size);
1553 	    mly_printf(sc, "   health_buffer_phys   0x%llx\n",
1554 			  io->param.setmemorymailbox.health_buffer_physaddr);
1555 	    mly_printf(sc, "   command_mailbox      0x%llx\n",
1556 			  io->param.setmemorymailbox.command_mailbox_physaddr);
1557 	    mly_printf(sc, "   status_mailbox       0x%llx\n",
1558 			  io->param.setmemorymailbox.status_mailbox_physaddr);
1559 	    transfer = 0;
1560 	    break;
1561 
1562 	case MDACIOCTL_SETREALTIMECLOCK:
1563 	case MDACIOCTL_GETHEALTHSTATUS:
1564 	case MDACIOCTL_GETCONTROLLERINFO:
1565 	case MDACIOCTL_GETLOGDEVINFOVALID:
1566 	case MDACIOCTL_GETPHYSDEVINFOVALID:
1567 	case MDACIOCTL_GETPHYSDEVSTATISTICS:
1568 	case MDACIOCTL_GETLOGDEVSTATISTICS:
1569 	case MDACIOCTL_GETCONTROLLERSTATISTICS:
1570 	case MDACIOCTL_GETBDT_FOR_SYSDRIVE:
1571 	case MDACIOCTL_CREATENEWCONF:
1572 	case MDACIOCTL_ADDNEWCONF:
1573 	case MDACIOCTL_GETDEVCONFINFO:
1574 	case MDACIOCTL_GETFREESPACELIST:
1575 	case MDACIOCTL_MORE:
1576 	case MDACIOCTL_SETPHYSDEVPARAMETER:
1577 	case MDACIOCTL_GETPHYSDEVPARAMETER:
1578 	case MDACIOCTL_GETLOGDEVPARAMETER:
1579 	case MDACIOCTL_SETLOGDEVPARAMETER:
1580 	    mly_printf(sc, "   param                %10D\n", io->param.data.param, " ");
1581 	    transfer = 1;
1582 	    break;
1583 
1584 	case MDACIOCTL_GETEVENT:
1585 	    mly_printf(sc, "   event                %d\n",
1586 		       io->param.getevent.sequence_number_low + ((u_int32_t)io->addr.log.logdev << 16));
1587 	    transfer = 1;
1588 	    break;
1589 
1590 	case MDACIOCTL_SETRAIDDEVSTATE:
1591 	    mly_printf(sc, "   state                %d\n", io->param.setraiddevstate.state);
1592 	    transfer = 0;
1593 	    break;
1594 
1595 	case MDACIOCTL_XLATEPHYSDEVTORAIDDEV:
1596 	    mly_printf(sc, "   raid_device          %d\n", io->param.xlatephysdevtoraiddev.raid_device);
1597 	    mly_printf(sc, "   controller           %d\n", io->param.xlatephysdevtoraiddev.controller);
1598 	    mly_printf(sc, "   channel              %d\n", io->param.xlatephysdevtoraiddev.channel);
1599 	    mly_printf(sc, "   target               %d\n", io->param.xlatephysdevtoraiddev.target);
1600 	    mly_printf(sc, "   lun                  %d\n", io->param.xlatephysdevtoraiddev.lun);
1601 	    transfer = 0;
1602 	    break;
1603 
1604 	case MDACIOCTL_GETGROUPCONFINFO:
1605 	    mly_printf(sc, "   group                %d\n", io->param.getgroupconfinfo.group);
1606 	    transfer = 1;
1607 	    break;
1608 
1609 	case MDACIOCTL_GET_SUBSYSTEM_DATA:
1610 	case MDACIOCTL_SET_SUBSYSTEM_DATA:
1611 	case MDACIOCTL_STARTDISOCVERY:
1612 	case MDACIOCTL_INITPHYSDEVSTART:
1613 	case MDACIOCTL_INITPHYSDEVSTOP:
1614 	case MDACIOCTL_INITRAIDDEVSTART:
1615 	case MDACIOCTL_INITRAIDDEVSTOP:
1616 	case MDACIOCTL_REBUILDRAIDDEVSTART:
1617 	case MDACIOCTL_REBUILDRAIDDEVSTOP:
1618 	case MDACIOCTL_MAKECONSISTENTDATASTART:
1619 	case MDACIOCTL_MAKECONSISTENTDATASTOP:
1620 	case MDACIOCTL_CONSISTENCYCHECKSTART:
1621 	case MDACIOCTL_CONSISTENCYCHECKSTOP:
1622 	case MDACIOCTL_RESETDEVICE:
1623 	case MDACIOCTL_FLUSHDEVICEDATA:
1624 	case MDACIOCTL_PAUSEDEVICE:
1625 	case MDACIOCTL_UNPAUSEDEVICE:
1626 	case MDACIOCTL_LOCATEDEVICE:
1627 	case MDACIOCTL_SETMASTERSLAVEMODE:
1628 	case MDACIOCTL_DELETERAIDDEV:
1629 	case MDACIOCTL_REPLACEINTERNALDEV:
1630 	case MDACIOCTL_CLEARCONF:
1631 	case MDACIOCTL_GETCONTROLLERPARAMETER:
1632 	case MDACIOCTL_SETCONTRLLERPARAMETER:
1633 	case MDACIOCTL_CLEARCONFSUSPMODE:
1634 	case MDACIOCTL_STOREIMAGE:
1635 	case MDACIOCTL_READIMAGE:
1636 	case MDACIOCTL_FLASHIMAGES:
1637 	case MDACIOCTL_RENAMERAIDDEV:
1638 	default:			/* no idea what to print */
1639 	    transfer = 0;
1640 	    break;
1641 	}
1642 	break;
1643 
1644     case MDACMD_IOCTLCHECK:
1645     case MDACMD_MEMCOPY:
1646     default:
1647 	transfer = 0;
1648 	break;	/* print nothing */
1649     }
1650     if (transfer) {
1651 	if (ge->command_control.extended_sg_table) {
1652 	    mly_printf(sc, "   sg table             0x%llx/%d\n",
1653 			  ge->transfer.indirect.table_physaddr[0], ge->transfer.indirect.entries[0]);
1654 	} else {
1655 	    mly_printf(sc, "   0000                 0x%llx/%lld\n",
1656 			  ge->transfer.direct.sg[0].physaddr, ge->transfer.direct.sg[0].length);
1657 	    mly_printf(sc, "   0001                 0x%llx/%lld\n",
1658 			  ge->transfer.direct.sg[1].physaddr, ge->transfer.direct.sg[1].length);
1659 	}
1660     }
1661 }
1662 
1663 /********************************************************************************
1664  * Panic in a slightly informative fashion
1665  */
1666 static void
1667 mly_panic(struct mly_softc *sc, char *reason)
1668 {
1669     mly_printstate(sc);
1670     panic(reason);
1671 }
1672 #endif
1673 
1674 /********************************************************************************
1675  * Print queue statistics, callable from DDB.
1676  */
1677 void
1678 mly_print_controller(int controller)
1679 {
1680     struct mly_softc	*sc;
1681 
1682     if ((sc = devclass_get_softc(devclass_find("mly"), controller)) == NULL) {
1683 	printf("mly: controller %d invalid\n", controller);
1684     } else {
1685 	device_printf(sc->mly_dev, "queue    curr max\n");
1686 	device_printf(sc->mly_dev, "free     %04d/%04d\n",
1687 		      sc->mly_qstat[MLYQ_FREE].q_length, sc->mly_qstat[MLYQ_FREE].q_max);
1688 	device_printf(sc->mly_dev, "ready    %04d/%04d\n",
1689 		      sc->mly_qstat[MLYQ_READY].q_length, sc->mly_qstat[MLYQ_READY].q_max);
1690 	device_printf(sc->mly_dev, "busy     %04d/%04d\n",
1691 		      sc->mly_qstat[MLYQ_BUSY].q_length, sc->mly_qstat[MLYQ_BUSY].q_max);
1692 	device_printf(sc->mly_dev, "complete %04d/%04d\n",
1693 		      sc->mly_qstat[MLYQ_COMPLETE].q_length, sc->mly_qstat[MLYQ_COMPLETE].q_max);
1694     }
1695 }
1696 
1697 
1698 /********************************************************************************
1699  ********************************************************************************
1700                                                          Control device interface
1701  ********************************************************************************
1702  ********************************************************************************/
1703 
1704 /********************************************************************************
1705  * Accept an open operation on the control device.
1706  */
1707 static int
1708 mly_user_open(dev_t dev, int flags, int fmt, d_thread_t *td)
1709 {
1710     int			unit = minor(dev);
1711     struct mly_softc	*sc = devclass_get_softc(devclass_find("mly"), unit);
1712 
1713     sc->mly_state |= MLY_STATE_OPEN;
1714     return(0);
1715 }
1716 
1717 /********************************************************************************
1718  * Accept the last close on the control device.
1719  */
1720 static int
1721 mly_user_close(dev_t dev, int flags, int fmt, d_thread_t *td)
1722 {
1723     int			unit = minor(dev);
1724     struct mly_softc	*sc = devclass_get_softc(devclass_find("mly"), unit);
1725 
1726     sc->mly_state &= ~MLY_STATE_OPEN;
1727     return (0);
1728 }
1729 
1730 /********************************************************************************
1731  * Handle controller-specific control operations.
1732  */
1733 static int
1734 mly_user_ioctl(dev_t dev, u_long cmd, caddr_t addr, int32_t flag, d_thread_t *td)
1735 {
1736     struct mly_softc		*sc = (struct mly_softc *)dev->si_drv1;
1737     struct mly_user_command	*uc = (struct mly_user_command *)addr;
1738     struct mly_user_health	*uh = (struct mly_user_health *)addr;
1739 
1740     switch(cmd) {
1741     case MLYIO_COMMAND:
1742 	return(mly_user_command(sc, uc));
1743     case MLYIO_HEALTH:
1744 	return(mly_user_health(sc, uh));
1745     default:
1746 	return(ENOIOCTL);
1747     }
1748 }
1749 
1750 /********************************************************************************
1751  * Execute a command passed in from userspace.
1752  *
1753  * The control structure contains the actual command for the controller, as well
1754  * as the user-space data pointer and data size, and an optional sense buffer
1755  * size/pointer.  On completion, the data size is adjusted to the command
1756  * residual, and the sense buffer size to the size of the returned sense data.
1757  *
1758  */
1759 static int
1760 mly_user_command(struct mly_softc *sc, struct mly_user_command *uc)
1761 {
1762     struct mly_command			*mc;
1763     int					error, s;
1764 
1765     /* allocate a command */
1766     if (mly_alloc_command(sc, &mc)) {
1767 	error = ENOMEM;
1768 	goto out;		/* XXX Linux version will wait for a command */
1769     }
1770 
1771     /* handle data size/direction */
1772     mc->mc_length = (uc->DataTransferLength >= 0) ? uc->DataTransferLength : -uc->DataTransferLength;
1773     if (mc->mc_length > 0)
1774 	mc->mc_data = malloc(mc->mc_length, M_DEVBUF, M_INTWAIT);
1775     if (uc->DataTransferLength > 0) {
1776 	mc->mc_flags |= MLY_CMD_DATAIN;
1777 	bzero(mc->mc_data, mc->mc_length);
1778     }
1779     if (uc->DataTransferLength < 0) {
1780 	mc->mc_flags |= MLY_CMD_DATAOUT;
1781 	if ((error = copyin(uc->DataTransferBuffer, mc->mc_data, mc->mc_length)) != 0)
1782 	    goto out;
1783     }
1784 
1785     /* copy the controller command */
1786     bcopy(&uc->CommandMailbox, mc->mc_packet, sizeof(uc->CommandMailbox));
1787 
1788     /* clear command completion handler so that we get woken up */
1789     mc->mc_complete = NULL;
1790 
1791     /* execute the command */
1792     s = splcam();
1793     mly_requeue_ready(mc);
1794     mly_startio(sc);
1795     while (!(mc->mc_flags & MLY_CMD_COMPLETE))
1796 	tsleep(mc, 0, "mlyioctl", 0);
1797     splx(s);
1798 
1799     /* return the data to userspace */
1800     if (uc->DataTransferLength > 0)
1801 	if ((error = copyout(mc->mc_data, uc->DataTransferBuffer, mc->mc_length)) != 0)
1802 	    goto out;
1803 
1804     /* return the sense buffer to userspace */
1805     if ((uc->RequestSenseLength > 0) && (mc->mc_sense > 0)) {
1806 	if ((error = copyout(mc->mc_packet, uc->RequestSenseBuffer,
1807 			     min(uc->RequestSenseLength, mc->mc_sense))) != 0)
1808 	    goto out;
1809     }
1810 
1811     /* return command results to userspace (caller will copy out) */
1812     uc->DataTransferLength = mc->mc_resid;
1813     uc->RequestSenseLength = min(uc->RequestSenseLength, mc->mc_sense);
1814     uc->CommandStatus = mc->mc_status;
1815     error = 0;
1816 
1817  out:
1818     if (mc->mc_data != NULL)
1819 	free(mc->mc_data, M_DEVBUF);
1820     if (mc != NULL)
1821 	mly_release_command(mc);
1822     return(error);
1823 }
1824 
1825 /********************************************************************************
1826  * Return health status to userspace.  If the health change index in the user
1827  * structure does not match that currently exported by the controller, we
1828  * return the current status immediately.  Otherwise, we block until either
1829  * interrupted or new status is delivered.
1830  */
1831 static int
1832 mly_user_health(struct mly_softc *sc, struct mly_user_health *uh)
1833 {
1834     struct mly_health_status		mh;
1835     int					error, s;
1836 
1837     /* fetch the current health status from userspace */
1838     if ((error = copyin(uh->HealthStatusBuffer, &mh, sizeof(mh))) != 0)
1839 	return(error);
1840 
1841     /* spin waiting for a status update */
1842     s = splcam();
1843     error = EWOULDBLOCK;
1844     while ((error != 0) && (sc->mly_event_change == mh.change_counter))
1845 	error = tsleep(&sc->mly_event_change, PCATCH, "mlyhealth", 0);
1846     splx(s);
1847 
1848     /* copy the controller's health status buffer out (there is a race here if it changes again) */
1849     error = copyout(&sc->mly_mmbox->mmm_health.status, uh->HealthStatusBuffer,
1850 		    sizeof(uh->HealthStatusBuffer));
1851     return(error);
1852 }
1853