mly.c revision 146734
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: head/sys/dev/mly/mly.c 146734 2005-05-29 04:42:30Z nyan $
28 */
29
30#include <sys/param.h>
31#include <sys/systm.h>
32#include <sys/malloc.h>
33#include <sys/kernel.h>
34#include <sys/bus.h>
35#include <sys/conf.h>
36#include <sys/ctype.h>
37#include <sys/ioccom.h>
38#include <sys/stat.h>
39
40#include <machine/bus.h>
41#include <machine/resource.h>
42#include <sys/rman.h>
43
44#include <cam/cam.h>
45#include <cam/cam_ccb.h>
46#include <cam/cam_periph.h>
47#include <cam/cam_sim.h>
48#include <cam/cam_xpt_sim.h>
49#include <cam/scsi/scsi_all.h>
50#include <cam/scsi/scsi_message.h>
51
52#include <dev/pci/pcireg.h>
53#include <dev/pci/pcivar.h>
54
55#include <dev/mly/mlyreg.h>
56#include <dev/mly/mlyio.h>
57#include <dev/mly/mlyvar.h>
58#include <dev/mly/mly_tables.h>
59
60static int	mly_probe(device_t dev);
61static int	mly_attach(device_t dev);
62static int	mly_pci_attach(struct mly_softc *sc);
63static int	mly_detach(device_t dev);
64static int	mly_shutdown(device_t dev);
65static void	mly_intr(void *arg);
66
67static int	mly_sg_map(struct mly_softc *sc);
68static void	mly_sg_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error);
69static int	mly_mmbox_map(struct mly_softc *sc);
70static void	mly_mmbox_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error);
71static void	mly_free(struct mly_softc *sc);
72
73static int	mly_get_controllerinfo(struct mly_softc *sc);
74static void	mly_scan_devices(struct mly_softc *sc);
75static void	mly_rescan_btl(struct mly_softc *sc, int bus, int target);
76static void	mly_complete_rescan(struct mly_command *mc);
77static int	mly_get_eventstatus(struct mly_softc *sc);
78static int	mly_enable_mmbox(struct mly_softc *sc);
79static int	mly_flush(struct mly_softc *sc);
80static int	mly_ioctl(struct mly_softc *sc, struct mly_command_ioctl *ioctl, void **data,
81			  size_t datasize, u_int8_t *status, void *sense_buffer, size_t *sense_length);
82static void	mly_check_event(struct mly_softc *sc);
83static void	mly_fetch_event(struct mly_softc *sc);
84static void	mly_complete_event(struct mly_command *mc);
85static void	mly_process_event(struct mly_softc *sc, struct mly_event *me);
86static void	mly_periodic(void *data);
87
88static int	mly_immediate_command(struct mly_command *mc);
89static int	mly_start(struct mly_command *mc);
90static void	mly_done(struct mly_softc *sc);
91static void	mly_complete(void *context, int pending);
92
93static int	mly_alloc_command(struct mly_softc *sc, struct mly_command **mcp);
94static void	mly_release_command(struct mly_command *mc);
95static void	mly_alloc_commands_map(void *arg, bus_dma_segment_t *segs, int nseg, int error);
96static int	mly_alloc_commands(struct mly_softc *sc);
97static void	mly_release_commands(struct mly_softc *sc);
98static void	mly_map_command(struct mly_command *mc);
99static void	mly_unmap_command(struct mly_command *mc);
100
101static int	mly_cam_attach(struct mly_softc *sc);
102static void	mly_cam_detach(struct mly_softc *sc);
103static void	mly_cam_rescan_btl(struct mly_softc *sc, int bus, int target);
104static void	mly_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb);
105static void	mly_cam_action(struct cam_sim *sim, union ccb *ccb);
106static int	mly_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio);
107static void	mly_cam_poll(struct cam_sim *sim);
108static void	mly_cam_complete(struct mly_command *mc);
109static struct cam_periph *mly_find_periph(struct mly_softc *sc, int bus, int target);
110static int	mly_name_device(struct mly_softc *sc, int bus, int target);
111
112static int	mly_fwhandshake(struct mly_softc *sc);
113
114static void	mly_describe_controller(struct mly_softc *sc);
115#ifdef MLY_DEBUG
116static void	mly_printstate(struct mly_softc *sc);
117static void	mly_print_command(struct mly_command *mc);
118static void	mly_print_packet(struct mly_command *mc);
119static void	mly_panic(struct mly_softc *sc, char *reason);
120#endif
121void		mly_print_controller(int controller);
122static int	mly_timeout(struct mly_softc *sc);
123
124
125static d_open_t		mly_user_open;
126static d_close_t	mly_user_close;
127static d_ioctl_t	mly_user_ioctl;
128static int	mly_user_command(struct mly_softc *sc, struct mly_user_command *uc);
129static int	mly_user_health(struct mly_softc *sc, struct mly_user_health *uh);
130
131#define MLY_CMD_TIMEOUT		20
132
133static device_method_t mly_methods[] = {
134    /* Device interface */
135    DEVMETHOD(device_probe,	mly_probe),
136    DEVMETHOD(device_attach,	mly_attach),
137    DEVMETHOD(device_detach,	mly_detach),
138    DEVMETHOD(device_shutdown,	mly_shutdown),
139    { 0, 0 }
140};
141
142static driver_t mly_pci_driver = {
143	"mly",
144	mly_methods,
145	sizeof(struct mly_softc)
146};
147
148static devclass_t	mly_devclass;
149DRIVER_MODULE(mly, pci, mly_pci_driver, mly_devclass, 0, 0);
150
151static struct cdevsw mly_cdevsw = {
152	.d_version =	D_VERSION,
153	.d_flags =	D_NEEDGIANT,
154	.d_open =	mly_user_open,
155	.d_close =	mly_user_close,
156	.d_ioctl =	mly_user_ioctl,
157	.d_name =	"mly",
158};
159
160/********************************************************************************
161 ********************************************************************************
162                                                                 Device Interface
163 ********************************************************************************
164 ********************************************************************************/
165
166static struct mly_ident
167{
168    u_int16_t		vendor;
169    u_int16_t		device;
170    u_int16_t		subvendor;
171    u_int16_t		subdevice;
172    int			hwif;
173    char		*desc;
174} mly_identifiers[] = {
175    {0x1069, 0xba56, 0x1069, 0x0040, MLY_HWIF_STRONGARM, "Mylex eXtremeRAID 2000"},
176    {0x1069, 0xba56, 0x1069, 0x0030, MLY_HWIF_STRONGARM, "Mylex eXtremeRAID 3000"},
177    {0x1069, 0x0050, 0x1069, 0x0050, MLY_HWIF_I960RX,    "Mylex AcceleRAID 352"},
178    {0x1069, 0x0050, 0x1069, 0x0052, MLY_HWIF_I960RX,    "Mylex AcceleRAID 170"},
179    {0x1069, 0x0050, 0x1069, 0x0054, MLY_HWIF_I960RX,    "Mylex AcceleRAID 160"},
180    {0, 0, 0, 0, 0, 0}
181};
182
183/********************************************************************************
184 * Compare the provided PCI device with the list we support.
185 */
186static int
187mly_probe(device_t dev)
188{
189    struct mly_ident	*m;
190
191    debug_called(1);
192
193    for (m = mly_identifiers; m->vendor != 0; m++) {
194	if ((m->vendor == pci_get_vendor(dev)) &&
195	    (m->device == pci_get_device(dev)) &&
196	    ((m->subvendor == 0) || ((m->subvendor == pci_get_subvendor(dev)) &&
197				     (m->subdevice == pci_get_subdevice(dev))))) {
198
199	    device_set_desc(dev, m->desc);
200	    return(BUS_PROBE_DEFAULT);	/* allow room to be overridden */
201	}
202    }
203    return(ENXIO);
204}
205
206/********************************************************************************
207 * Initialise the controller and softc
208 */
209static int
210mly_attach(device_t dev)
211{
212    struct mly_softc	*sc = device_get_softc(dev);
213    int			error;
214
215    debug_called(1);
216
217    sc->mly_dev = dev;
218
219#ifdef MLY_DEBUG
220    if (device_get_unit(sc->mly_dev) == 0)
221	mly_softc0 = sc;
222#endif
223
224    /*
225     * Do PCI-specific initialisation.
226     */
227    if ((error = mly_pci_attach(sc)) != 0)
228	goto out;
229
230    /*
231     * Initialise per-controller queues.
232     */
233    mly_initq_free(sc);
234    mly_initq_busy(sc);
235    mly_initq_complete(sc);
236
237#if __FreeBSD_version >= 500005
238    /*
239     * Initialise command-completion task.
240     */
241    TASK_INIT(&sc->mly_task_complete, 0, mly_complete, sc);
242#endif
243
244    /* disable interrupts before we start talking to the controller */
245    MLY_MASK_INTERRUPTS(sc);
246
247    /*
248     * Wait for the controller to come ready, handshake with the firmware if required.
249     * This is typically only necessary on platforms where the controller BIOS does not
250     * run.
251     */
252    if ((error = mly_fwhandshake(sc)))
253	goto out;
254
255    /*
256     * Allocate initial command buffers.
257     */
258    if ((error = mly_alloc_commands(sc)))
259	goto out;
260
261    /*
262     * Obtain controller feature information
263     */
264    if ((error = mly_get_controllerinfo(sc)))
265	goto out;
266
267    /*
268     * Reallocate command buffers now we know how many we want.
269     */
270    mly_release_commands(sc);
271    if ((error = mly_alloc_commands(sc)))
272	goto out;
273
274    /*
275     * Get the current event counter for health purposes, populate the initial
276     * health status buffer.
277     */
278    if ((error = mly_get_eventstatus(sc)))
279	goto out;
280
281    /*
282     * Enable memory-mailbox mode.
283     */
284    if ((error = mly_enable_mmbox(sc)))
285	goto out;
286
287    /*
288     * Attach to CAM.
289     */
290    if ((error = mly_cam_attach(sc)))
291	goto out;
292
293    /*
294     * Print a little information about the controller
295     */
296    mly_describe_controller(sc);
297
298    /*
299     * Mark all attached devices for rescan.
300     */
301    mly_scan_devices(sc);
302
303    /*
304     * Instigate the first status poll immediately.  Rescan completions won't
305     * happen until interrupts are enabled, which should still be before
306     * the SCSI subsystem gets to us, courtesy of the "SCSI settling delay".
307     */
308    mly_periodic((void *)sc);
309
310    /*
311     * Create the control device.
312     */
313    sc->mly_dev_t = make_dev(&mly_cdevsw, device_get_unit(sc->mly_dev), UID_ROOT, GID_OPERATOR,
314			     S_IRUSR | S_IWUSR, "mly%d", device_get_unit(sc->mly_dev));
315    sc->mly_dev_t->si_drv1 = sc;
316
317    /* enable interrupts now */
318    MLY_UNMASK_INTERRUPTS(sc);
319
320#ifdef MLY_DEBUG
321    timeout((timeout_t *)mly_timeout, sc, MLY_CMD_TIMEOUT * hz);
322#endif
323
324 out:
325    if (error != 0)
326	mly_free(sc);
327    return(error);
328}
329
330/********************************************************************************
331 * Perform PCI-specific initialisation.
332 */
333static int
334mly_pci_attach(struct mly_softc *sc)
335{
336    int			i, error;
337    u_int32_t		command;
338
339    debug_called(1);
340
341    /* assume failure is 'not configured' */
342    error = ENXIO;
343
344    /*
345     * Verify that the adapter is correctly set up in PCI space.
346     *
347     * XXX we shouldn't do this; the PCI code should.
348     */
349    command = pci_read_config(sc->mly_dev, PCIR_COMMAND, 2);
350    command |= PCIM_CMD_BUSMASTEREN;
351    pci_write_config(sc->mly_dev, PCIR_COMMAND, command, 2);
352    command = pci_read_config(sc->mly_dev, PCIR_COMMAND, 2);
353    if (!(command & PCIM_CMD_BUSMASTEREN)) {
354	mly_printf(sc, "can't enable busmaster feature\n");
355	goto fail;
356    }
357    if ((command & PCIM_CMD_MEMEN) == 0) {
358	mly_printf(sc, "memory window not available\n");
359	goto fail;
360    }
361
362    /*
363     * Allocate the PCI register window.
364     */
365    sc->mly_regs_rid = PCIR_BAR(0);	/* first base address register */
366    if ((sc->mly_regs_resource = bus_alloc_resource_any(sc->mly_dev,
367	    SYS_RES_MEMORY, &sc->mly_regs_rid, RF_ACTIVE)) == NULL) {
368	mly_printf(sc, "can't allocate register window\n");
369	goto fail;
370    }
371    sc->mly_btag = rman_get_bustag(sc->mly_regs_resource);
372    sc->mly_bhandle = rman_get_bushandle(sc->mly_regs_resource);
373
374    /*
375     * Allocate and connect our interrupt.
376     */
377    sc->mly_irq_rid = 0;
378    if ((sc->mly_irq = bus_alloc_resource_any(sc->mly_dev, SYS_RES_IRQ,
379		    &sc->mly_irq_rid, RF_SHAREABLE | RF_ACTIVE)) == NULL) {
380	mly_printf(sc, "can't allocate interrupt\n");
381	goto fail;
382    }
383    if (bus_setup_intr(sc->mly_dev, sc->mly_irq, INTR_TYPE_CAM | INTR_ENTROPY,  mly_intr, sc, &sc->mly_intr)) {
384	mly_printf(sc, "can't set up interrupt\n");
385	goto fail;
386    }
387
388    /* assume failure is 'out of memory' */
389    error = ENOMEM;
390
391    /*
392     * Allocate the parent bus DMA tag appropriate for our PCI interface.
393     *
394     * Note that all of these controllers are 64-bit capable.
395     */
396    if (bus_dma_tag_create(NULL, 			/* parent */
397			   1, 0, 			/* alignment, boundary */
398			   BUS_SPACE_MAXADDR_32BIT,	/* lowaddr */
399			   BUS_SPACE_MAXADDR, 		/* highaddr */
400			   NULL, NULL, 			/* filter, filterarg */
401			   MAXBSIZE, MLY_MAX_SGENTRIES,	/* maxsize, nsegments */
402			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
403			   BUS_DMA_ALLOCNOW,		/* flags */
404			   NULL,			/* lockfunc */
405			   NULL,			/* lockarg */
406			   &sc->mly_parent_dmat)) {
407	mly_printf(sc, "can't allocate parent DMA tag\n");
408	goto fail;
409    }
410
411    /*
412     * Create DMA tag for mapping buffers into controller-addressable space.
413     */
414    if (bus_dma_tag_create(sc->mly_parent_dmat, 	/* parent */
415			   1, 0, 			/* alignment, boundary */
416			   BUS_SPACE_MAXADDR,		/* lowaddr */
417			   BUS_SPACE_MAXADDR, 		/* highaddr */
418			   NULL, NULL, 			/* filter, filterarg */
419			   MAXBSIZE, MLY_MAX_SGENTRIES,	/* maxsize, nsegments */
420			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
421			   0,				/* flags */
422			   busdma_lock_mutex,		/* lockfunc */
423			   &Giant,			/* lockarg */
424			   &sc->mly_buffer_dmat)) {
425	mly_printf(sc, "can't allocate buffer DMA tag\n");
426	goto fail;
427    }
428
429    /*
430     * Initialise the DMA tag for command packets.
431     */
432    if (bus_dma_tag_create(sc->mly_parent_dmat,		/* parent */
433			   1, 0, 			/* alignment, boundary */
434			   BUS_SPACE_MAXADDR,		/* lowaddr */
435			   BUS_SPACE_MAXADDR, 		/* highaddr */
436			   NULL, NULL, 			/* filter, filterarg */
437			   sizeof(union mly_command_packet) * MLY_MAX_COMMANDS, 1,	/* maxsize, nsegments */
438			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
439			   BUS_DMA_ALLOCNOW,		/* flags */
440			   NULL, NULL,			/* lockfunc, lockarg */
441			   &sc->mly_packet_dmat)) {
442	mly_printf(sc, "can't allocate command packet DMA tag\n");
443	goto fail;
444    }
445
446    /*
447     * Detect the hardware interface version
448     */
449    for (i = 0; mly_identifiers[i].vendor != 0; i++) {
450	if ((mly_identifiers[i].vendor == pci_get_vendor(sc->mly_dev)) &&
451	    (mly_identifiers[i].device == pci_get_device(sc->mly_dev))) {
452	    sc->mly_hwif = mly_identifiers[i].hwif;
453	    switch(sc->mly_hwif) {
454	    case MLY_HWIF_I960RX:
455		debug(1, "set hardware up for i960RX");
456		sc->mly_doorbell_true = 0x00;
457		sc->mly_command_mailbox =  MLY_I960RX_COMMAND_MAILBOX;
458		sc->mly_status_mailbox =   MLY_I960RX_STATUS_MAILBOX;
459		sc->mly_idbr =             MLY_I960RX_IDBR;
460		sc->mly_odbr =             MLY_I960RX_ODBR;
461		sc->mly_error_status =     MLY_I960RX_ERROR_STATUS;
462		sc->mly_interrupt_status = MLY_I960RX_INTERRUPT_STATUS;
463		sc->mly_interrupt_mask =   MLY_I960RX_INTERRUPT_MASK;
464		break;
465	    case MLY_HWIF_STRONGARM:
466		debug(1, "set hardware up for StrongARM");
467		sc->mly_doorbell_true = 0xff;		/* doorbell 'true' is 0 */
468		sc->mly_command_mailbox =  MLY_STRONGARM_COMMAND_MAILBOX;
469		sc->mly_status_mailbox =   MLY_STRONGARM_STATUS_MAILBOX;
470		sc->mly_idbr =             MLY_STRONGARM_IDBR;
471		sc->mly_odbr =             MLY_STRONGARM_ODBR;
472		sc->mly_error_status =     MLY_STRONGARM_ERROR_STATUS;
473		sc->mly_interrupt_status = MLY_STRONGARM_INTERRUPT_STATUS;
474		sc->mly_interrupt_mask =   MLY_STRONGARM_INTERRUPT_MASK;
475		break;
476	    }
477	    break;
478	}
479    }
480
481    /*
482     * Create the scatter/gather mappings.
483     */
484    if ((error = mly_sg_map(sc)))
485	goto fail;
486
487    /*
488     * Allocate and map the memory mailbox
489     */
490    if ((error = mly_mmbox_map(sc)))
491	goto fail;
492
493    error = 0;
494
495fail:
496    return(error);
497}
498
499/********************************************************************************
500 * Shut the controller down and detach all our resources.
501 */
502static int
503mly_detach(device_t dev)
504{
505    int			error;
506
507    if ((error = mly_shutdown(dev)) != 0)
508	return(error);
509
510    mly_free(device_get_softc(dev));
511    return(0);
512}
513
514/********************************************************************************
515 * Bring the controller to a state where it can be safely left alone.
516 *
517 * Note that it should not be necessary to wait for any outstanding commands,
518 * as they should be completed prior to calling here.
519 *
520 * XXX this applies for I/O, but not status polls; we should beware of
521 *     the case where a status command is running while we detach.
522 */
523static int
524mly_shutdown(device_t dev)
525{
526    struct mly_softc	*sc = device_get_softc(dev);
527
528    debug_called(1);
529
530    if (sc->mly_state & MLY_STATE_OPEN)
531	return(EBUSY);
532
533    /* kill the periodic event */
534    untimeout(mly_periodic, sc, sc->mly_periodic);
535
536    /* flush controller */
537    mly_printf(sc, "flushing cache...");
538    printf("%s\n", mly_flush(sc) ? "failed" : "done");
539
540    MLY_MASK_INTERRUPTS(sc);
541
542    return(0);
543}
544
545/*******************************************************************************
546 * Take an interrupt, or be poked by other code to look for interrupt-worthy
547 * status.
548 */
549static void
550mly_intr(void *arg)
551{
552    struct mly_softc	*sc = (struct mly_softc *)arg;
553
554    debug_called(2);
555
556    mly_done(sc);
557};
558
559/********************************************************************************
560 ********************************************************************************
561                                                Bus-dependant Resource Management
562 ********************************************************************************
563 ********************************************************************************/
564
565/********************************************************************************
566 * Allocate memory for the scatter/gather tables
567 */
568static int
569mly_sg_map(struct mly_softc *sc)
570{
571    size_t	segsize;
572
573    debug_called(1);
574
575    /*
576     * Create a single tag describing a region large enough to hold all of
577     * the s/g lists we will need.
578     */
579    segsize = sizeof(struct mly_sg_entry) * MLY_MAX_COMMANDS *MLY_MAX_SGENTRIES;
580    if (bus_dma_tag_create(sc->mly_parent_dmat,		/* parent */
581			   1, 0, 			/* alignment,boundary */
582			   BUS_SPACE_MAXADDR,		/* lowaddr */
583			   BUS_SPACE_MAXADDR, 		/* highaddr */
584			   NULL, NULL, 			/* filter, filterarg */
585			   segsize, 1,			/* maxsize, nsegments */
586			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
587			   BUS_DMA_ALLOCNOW,		/* flags */
588			   NULL, NULL,			/* lockfunc, lockarg */
589			   &sc->mly_sg_dmat)) {
590	mly_printf(sc, "can't allocate scatter/gather DMA tag\n");
591	return(ENOMEM);
592    }
593
594    /*
595     * Allocate enough s/g maps for all commands and permanently map them into
596     * controller-visible space.
597     *
598     * XXX this assumes we can get enough space for all the s/g maps in one
599     * contiguous slab.
600     */
601    if (bus_dmamem_alloc(sc->mly_sg_dmat, (void **)&sc->mly_sg_table,
602			 BUS_DMA_NOWAIT, &sc->mly_sg_dmamap)) {
603	mly_printf(sc, "can't allocate s/g table\n");
604	return(ENOMEM);
605    }
606    if (bus_dmamap_load(sc->mly_sg_dmat, sc->mly_sg_dmamap, sc->mly_sg_table,
607			segsize, mly_sg_map_helper, sc, BUS_DMA_NOWAIT) != 0)
608	return (ENOMEM);
609    return(0);
610}
611
612/********************************************************************************
613 * Save the physical address of the base of the s/g table.
614 */
615static void
616mly_sg_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
617{
618    struct mly_softc	*sc = (struct mly_softc *)arg;
619
620    debug_called(1);
621
622    /* save base of s/g table's address in bus space */
623    sc->mly_sg_busaddr = segs->ds_addr;
624}
625
626/********************************************************************************
627 * Allocate memory for the memory-mailbox interface
628 */
629static int
630mly_mmbox_map(struct mly_softc *sc)
631{
632
633    /*
634     * Create a DMA tag for a single contiguous region large enough for the
635     * memory mailbox structure.
636     */
637    if (bus_dma_tag_create(sc->mly_parent_dmat,		/* parent */
638			   1, 0, 			/* alignment,boundary */
639			   BUS_SPACE_MAXADDR,		/* lowaddr */
640			   BUS_SPACE_MAXADDR, 		/* highaddr */
641			   NULL, NULL, 			/* filter, filterarg */
642			   sizeof(struct mly_mmbox), 1,	/* maxsize, nsegments */
643			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
644			   BUS_DMA_ALLOCNOW,		/* flags */
645			   NULL, NULL,			/* lockfunc, lockarg */
646			   &sc->mly_mmbox_dmat)) {
647	mly_printf(sc, "can't allocate memory mailbox DMA tag\n");
648	return(ENOMEM);
649    }
650
651    /*
652     * Allocate the buffer
653     */
654    if (bus_dmamem_alloc(sc->mly_mmbox_dmat, (void **)&sc->mly_mmbox, BUS_DMA_NOWAIT, &sc->mly_mmbox_dmamap)) {
655	mly_printf(sc, "can't allocate memory mailbox\n");
656	return(ENOMEM);
657    }
658    if (bus_dmamap_load(sc->mly_mmbox_dmat, sc->mly_mmbox_dmamap, sc->mly_mmbox,
659			sizeof(struct mly_mmbox), mly_mmbox_map_helper, sc,
660			BUS_DMA_NOWAIT) != 0)
661	return (ENOMEM);
662    bzero(sc->mly_mmbox, sizeof(*sc->mly_mmbox));
663    return(0);
664
665}
666
667/********************************************************************************
668 * Save the physical address of the memory mailbox
669 */
670static void
671mly_mmbox_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
672{
673    struct mly_softc	*sc = (struct mly_softc *)arg;
674
675    debug_called(1);
676
677    sc->mly_mmbox_busaddr = segs->ds_addr;
678}
679
680/********************************************************************************
681 * Free all of the resources associated with (sc)
682 *
683 * Should not be called if the controller is active.
684 */
685static void
686mly_free(struct mly_softc *sc)
687{
688
689    debug_called(1);
690
691    /* Remove the management device */
692    destroy_dev(sc->mly_dev_t);
693
694    /* detach from CAM */
695    mly_cam_detach(sc);
696
697    /* release command memory */
698    mly_release_commands(sc);
699
700    /* throw away the controllerinfo structure */
701    if (sc->mly_controllerinfo != NULL)
702	free(sc->mly_controllerinfo, M_DEVBUF);
703
704    /* throw away the controllerparam structure */
705    if (sc->mly_controllerparam != NULL)
706	free(sc->mly_controllerparam, M_DEVBUF);
707
708    /* destroy data-transfer DMA tag */
709    if (sc->mly_buffer_dmat)
710	bus_dma_tag_destroy(sc->mly_buffer_dmat);
711
712    /* free and destroy DMA memory and tag for s/g lists */
713    if (sc->mly_sg_table) {
714	bus_dmamap_unload(sc->mly_sg_dmat, sc->mly_sg_dmamap);
715	bus_dmamem_free(sc->mly_sg_dmat, sc->mly_sg_table, sc->mly_sg_dmamap);
716    }
717    if (sc->mly_sg_dmat)
718	bus_dma_tag_destroy(sc->mly_sg_dmat);
719
720    /* free and destroy DMA memory and tag for memory mailbox */
721    if (sc->mly_mmbox) {
722	bus_dmamap_unload(sc->mly_mmbox_dmat, sc->mly_mmbox_dmamap);
723	bus_dmamem_free(sc->mly_mmbox_dmat, sc->mly_mmbox, sc->mly_mmbox_dmamap);
724    }
725    if (sc->mly_mmbox_dmat)
726	bus_dma_tag_destroy(sc->mly_mmbox_dmat);
727
728    /* disconnect the interrupt handler */
729    if (sc->mly_intr)
730	bus_teardown_intr(sc->mly_dev, sc->mly_irq, sc->mly_intr);
731    if (sc->mly_irq != NULL)
732	bus_release_resource(sc->mly_dev, SYS_RES_IRQ, sc->mly_irq_rid, sc->mly_irq);
733
734    /* destroy the parent DMA tag */
735    if (sc->mly_parent_dmat)
736	bus_dma_tag_destroy(sc->mly_parent_dmat);
737
738    /* release the register window mapping */
739    if (sc->mly_regs_resource != NULL)
740	bus_release_resource(sc->mly_dev, SYS_RES_MEMORY, sc->mly_regs_rid, sc->mly_regs_resource);
741}
742
743/********************************************************************************
744 ********************************************************************************
745                                                                 Command Wrappers
746 ********************************************************************************
747 ********************************************************************************/
748
749/********************************************************************************
750 * Fill in the mly_controllerinfo and mly_controllerparam fields in the softc.
751 */
752static int
753mly_get_controllerinfo(struct mly_softc *sc)
754{
755    struct mly_command_ioctl	mci;
756    u_int8_t			status;
757    int				error;
758
759    debug_called(1);
760
761    if (sc->mly_controllerinfo != NULL)
762	free(sc->mly_controllerinfo, M_DEVBUF);
763
764    /* build the getcontrollerinfo ioctl and send it */
765    bzero(&mci, sizeof(mci));
766    sc->mly_controllerinfo = NULL;
767    mci.sub_ioctl = MDACIOCTL_GETCONTROLLERINFO;
768    if ((error = mly_ioctl(sc, &mci, (void **)&sc->mly_controllerinfo, sizeof(*sc->mly_controllerinfo),
769			   &status, NULL, NULL)))
770	return(error);
771    if (status != 0)
772	return(EIO);
773
774    if (sc->mly_controllerparam != NULL)
775	free(sc->mly_controllerparam, M_DEVBUF);
776
777    /* build the getcontrollerparameter ioctl and send it */
778    bzero(&mci, sizeof(mci));
779    sc->mly_controllerparam = NULL;
780    mci.sub_ioctl = MDACIOCTL_GETCONTROLLERPARAMETER;
781    if ((error = mly_ioctl(sc, &mci, (void **)&sc->mly_controllerparam, sizeof(*sc->mly_controllerparam),
782			   &status, NULL, NULL)))
783	return(error);
784    if (status != 0)
785	return(EIO);
786
787    return(0);
788}
789
790/********************************************************************************
791 * Schedule all possible devices for a rescan.
792 *
793 */
794static void
795mly_scan_devices(struct mly_softc *sc)
796{
797    int		bus, target;
798
799    debug_called(1);
800
801    /*
802     * Clear any previous BTL information.
803     */
804    bzero(&sc->mly_btl, sizeof(sc->mly_btl));
805
806    /*
807     * Mark all devices as requiring a rescan, and let the next
808     * periodic scan collect them.
809     */
810    for (bus = 0; bus < sc->mly_cam_channels; bus++)
811	if (MLY_BUS_IS_VALID(sc, bus))
812	    for (target = 0; target < MLY_MAX_TARGETS; target++)
813		sc->mly_btl[bus][target].mb_flags = MLY_BTL_RESCAN;
814
815}
816
817/********************************************************************************
818 * Rescan a device, possibly as a consequence of getting an event which suggests
819 * that it may have changed.
820 *
821 * If we suffer resource starvation, we can abandon the rescan as we'll be
822 * retried.
823 */
824static void
825mly_rescan_btl(struct mly_softc *sc, int bus, int target)
826{
827    struct mly_command		*mc;
828    struct mly_command_ioctl	*mci;
829
830    debug_called(1);
831
832    /* check that this bus is valid */
833    if (!MLY_BUS_IS_VALID(sc, bus))
834	return;
835
836    /* get a command */
837    if (mly_alloc_command(sc, &mc))
838	return;
839
840    /* set up the data buffer */
841    if ((mc->mc_data = malloc(sizeof(union mly_devinfo), M_DEVBUF, M_NOWAIT | M_ZERO)) == NULL) {
842	mly_release_command(mc);
843	return;
844    }
845    mc->mc_flags |= MLY_CMD_DATAIN;
846    mc->mc_complete = mly_complete_rescan;
847
848    /*
849     * Build the ioctl.
850     */
851    mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
852    mci->opcode = MDACMD_IOCTL;
853    mci->addr.phys.controller = 0;
854    mci->timeout.value = 30;
855    mci->timeout.scale = MLY_TIMEOUT_SECONDS;
856    if (MLY_BUS_IS_VIRTUAL(sc, bus)) {
857	mc->mc_length = mci->data_size = sizeof(struct mly_ioctl_getlogdevinfovalid);
858	mci->sub_ioctl = MDACIOCTL_GETLOGDEVINFOVALID;
859	mci->addr.log.logdev = MLY_LOGDEV_ID(sc, bus, target);
860	debug(1, "logical device %d", mci->addr.log.logdev);
861    } else {
862	mc->mc_length = mci->data_size = sizeof(struct mly_ioctl_getphysdevinfovalid);
863	mci->sub_ioctl = MDACIOCTL_GETPHYSDEVINFOVALID;
864	mci->addr.phys.lun = 0;
865	mci->addr.phys.target = target;
866	mci->addr.phys.channel = bus;
867	debug(1, "physical device %d:%d", mci->addr.phys.channel, mci->addr.phys.target);
868    }
869
870    /*
871     * Dispatch the command.  If we successfully send the command, clear the rescan
872     * bit.
873     */
874    if (mly_start(mc) != 0) {
875	mly_release_command(mc);
876    } else {
877	sc->mly_btl[bus][target].mb_flags &= ~MLY_BTL_RESCAN;	/* success */
878    }
879}
880
881/********************************************************************************
882 * Handle the completion of a rescan operation
883 */
884static void
885mly_complete_rescan(struct mly_command *mc)
886{
887    struct mly_softc				*sc = mc->mc_sc;
888    struct mly_ioctl_getlogdevinfovalid		*ldi;
889    struct mly_ioctl_getphysdevinfovalid	*pdi;
890    struct mly_command_ioctl			*mci;
891    struct mly_btl				btl, *btlp;
892    int						bus, target, rescan;
893
894    debug_called(1);
895
896    /*
897     * Recover the bus and target from the command.  We need these even in
898     * the case where we don't have a useful response.
899     */
900    mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
901    if (mci->sub_ioctl == MDACIOCTL_GETLOGDEVINFOVALID) {
902	bus = MLY_LOGDEV_BUS(sc, mci->addr.log.logdev);
903	target = MLY_LOGDEV_TARGET(sc, mci->addr.log.logdev);
904    } else {
905	bus = mci->addr.phys.channel;
906	target = mci->addr.phys.target;
907    }
908    /* XXX validate bus/target? */
909
910    /* the default result is 'no device' */
911    bzero(&btl, sizeof(btl));
912
913    /* if the rescan completed OK, we have possibly-new BTL data */
914    if (mc->mc_status == 0) {
915	if (mc->mc_length == sizeof(*ldi)) {
916	    ldi = (struct mly_ioctl_getlogdevinfovalid *)mc->mc_data;
917	    if ((MLY_LOGDEV_BUS(sc, ldi->logical_device_number) != bus) ||
918		(MLY_LOGDEV_TARGET(sc, ldi->logical_device_number) != target)) {
919		mly_printf(sc, "WARNING: BTL rescan for %d:%d returned data for %d:%d instead\n",
920			   bus, target, MLY_LOGDEV_BUS(sc, ldi->logical_device_number),
921			   MLY_LOGDEV_TARGET(sc, ldi->logical_device_number));
922		/* XXX what can we do about this? */
923	    }
924	    btl.mb_flags = MLY_BTL_LOGICAL;
925	    btl.mb_type = ldi->raid_level;
926	    btl.mb_state = ldi->state;
927	    debug(1, "BTL rescan for %d returns %s, %s", ldi->logical_device_number,
928		  mly_describe_code(mly_table_device_type, ldi->raid_level),
929		  mly_describe_code(mly_table_device_state, ldi->state));
930	} else if (mc->mc_length == sizeof(*pdi)) {
931	    pdi = (struct mly_ioctl_getphysdevinfovalid *)mc->mc_data;
932	    if ((pdi->channel != bus) || (pdi->target != target)) {
933		mly_printf(sc, "WARNING: BTL rescan for %d:%d returned data for %d:%d instead\n",
934			   bus, target, pdi->channel, pdi->target);
935		/* XXX what can we do about this? */
936	    }
937	    btl.mb_flags = MLY_BTL_PHYSICAL;
938	    btl.mb_type = MLY_DEVICE_TYPE_PHYSICAL;
939	    btl.mb_state = pdi->state;
940	    btl.mb_speed = pdi->speed;
941	    btl.mb_width = pdi->width;
942	    if (pdi->state != MLY_DEVICE_STATE_UNCONFIGURED)
943		sc->mly_btl[bus][target].mb_flags |= MLY_BTL_PROTECTED;
944	    debug(1, "BTL rescan for %d:%d returns %s", bus, target,
945		  mly_describe_code(mly_table_device_state, pdi->state));
946	} else {
947	    mly_printf(sc, "BTL rescan result invalid\n");
948	}
949    }
950
951    free(mc->mc_data, M_DEVBUF);
952    mly_release_command(mc);
953
954    /*
955     * Decide whether we need to rescan the device.
956     */
957    rescan = 0;
958
959    /* device type changes (usually between 'nothing' and 'something') */
960    btlp = &sc->mly_btl[bus][target];
961    if (btl.mb_flags != btlp->mb_flags) {
962	debug(1, "flags changed, rescanning");
963	rescan = 1;
964    }
965
966    /* XXX other reasons? */
967
968    /*
969     * Update BTL information.
970     */
971    *btlp = btl;
972
973    /*
974     * Perform CAM rescan if required.
975     */
976    if (rescan)
977	mly_cam_rescan_btl(sc, bus, target);
978}
979
980/********************************************************************************
981 * Get the current health status and set the 'next event' counter to suit.
982 */
983static int
984mly_get_eventstatus(struct mly_softc *sc)
985{
986    struct mly_command_ioctl	mci;
987    struct mly_health_status	*mh;
988    u_int8_t			status;
989    int				error;
990
991    /* build the gethealthstatus ioctl and send it */
992    bzero(&mci, sizeof(mci));
993    mh = NULL;
994    mci.sub_ioctl = MDACIOCTL_GETHEALTHSTATUS;
995
996    if ((error = mly_ioctl(sc, &mci, (void **)&mh, sizeof(*mh), &status, NULL, NULL)))
997	return(error);
998    if (status != 0)
999	return(EIO);
1000
1001    /* get the event counter */
1002    sc->mly_event_change = mh->change_counter;
1003    sc->mly_event_waiting = mh->next_event;
1004    sc->mly_event_counter = mh->next_event;
1005
1006    /* save the health status into the memory mailbox */
1007    bcopy(mh, &sc->mly_mmbox->mmm_health.status, sizeof(*mh));
1008
1009    debug(1, "initial change counter %d, event counter %d", mh->change_counter, mh->next_event);
1010
1011    free(mh, M_DEVBUF);
1012    return(0);
1013}
1014
1015/********************************************************************************
1016 * Enable the memory mailbox mode.
1017 */
1018static int
1019mly_enable_mmbox(struct mly_softc *sc)
1020{
1021    struct mly_command_ioctl	mci;
1022    u_int8_t			*sp, status;
1023    int				error;
1024
1025    debug_called(1);
1026
1027    /* build the ioctl and send it */
1028    bzero(&mci, sizeof(mci));
1029    mci.sub_ioctl = MDACIOCTL_SETMEMORYMAILBOX;
1030    /* set buffer addresses */
1031    mci.param.setmemorymailbox.command_mailbox_physaddr =
1032	sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_command);
1033    mci.param.setmemorymailbox.status_mailbox_physaddr =
1034	sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_status);
1035    mci.param.setmemorymailbox.health_buffer_physaddr =
1036	sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_health);
1037
1038    /* set buffer sizes - abuse of data_size field is revolting */
1039    sp = (u_int8_t *)&mci.data_size;
1040    sp[0] = ((sizeof(union mly_command_packet) * MLY_MMBOX_COMMANDS) / 1024);
1041    sp[1] = (sizeof(union mly_status_packet) * MLY_MMBOX_STATUS) / 1024;
1042    mci.param.setmemorymailbox.health_buffer_size = sizeof(union mly_health_region) / 1024;
1043
1044    debug(1, "memory mailbox at %p (0x%llx/%d 0x%llx/%d 0x%llx/%d", sc->mly_mmbox,
1045	  mci.param.setmemorymailbox.command_mailbox_physaddr, sp[0],
1046	  mci.param.setmemorymailbox.status_mailbox_physaddr, sp[1],
1047	  mci.param.setmemorymailbox.health_buffer_physaddr,
1048	  mci.param.setmemorymailbox.health_buffer_size);
1049
1050    if ((error = mly_ioctl(sc, &mci, NULL, 0, &status, NULL, NULL)))
1051	return(error);
1052    if (status != 0)
1053	return(EIO);
1054    sc->mly_state |= MLY_STATE_MMBOX_ACTIVE;
1055    debug(1, "memory mailbox active");
1056    return(0);
1057}
1058
1059/********************************************************************************
1060 * Flush all pending I/O from the controller.
1061 */
1062static int
1063mly_flush(struct mly_softc *sc)
1064{
1065    struct mly_command_ioctl	mci;
1066    u_int8_t			status;
1067    int				error;
1068
1069    debug_called(1);
1070
1071    /* build the ioctl */
1072    bzero(&mci, sizeof(mci));
1073    mci.sub_ioctl = MDACIOCTL_FLUSHDEVICEDATA;
1074    mci.param.deviceoperation.operation_device = MLY_OPDEVICE_PHYSICAL_CONTROLLER;
1075
1076    /* pass it off to the controller */
1077    if ((error = mly_ioctl(sc, &mci, NULL, 0, &status, NULL, NULL)))
1078	return(error);
1079
1080    return((status == 0) ? 0 : EIO);
1081}
1082
1083/********************************************************************************
1084 * Perform an ioctl command.
1085 *
1086 * If (data) is not NULL, the command requires data transfer.  If (*data) is NULL
1087 * the command requires data transfer from the controller, and we will allocate
1088 * a buffer for it.  If (*data) is not NULL, the command requires data transfer
1089 * to the controller.
1090 *
1091 * XXX passing in the whole ioctl structure is ugly.  Better ideas?
1092 *
1093 * XXX we don't even try to handle the case where datasize > 4k.  We should.
1094 */
1095static int
1096mly_ioctl(struct mly_softc *sc, struct mly_command_ioctl *ioctl, void **data, size_t datasize,
1097	  u_int8_t *status, void *sense_buffer, size_t *sense_length)
1098{
1099    struct mly_command		*mc;
1100    struct mly_command_ioctl	*mci;
1101    int				error;
1102
1103    debug_called(1);
1104
1105    mc = NULL;
1106    if (mly_alloc_command(sc, &mc)) {
1107	error = ENOMEM;
1108	goto out;
1109    }
1110
1111    /* copy the ioctl structure, but save some important fields and then fixup */
1112    mci = &mc->mc_packet->ioctl;
1113    ioctl->sense_buffer_address = mci->sense_buffer_address;
1114    ioctl->maximum_sense_size = mci->maximum_sense_size;
1115    *mci = *ioctl;
1116    mci->opcode = MDACMD_IOCTL;
1117    mci->timeout.value = 30;
1118    mci->timeout.scale = MLY_TIMEOUT_SECONDS;
1119
1120    /* handle the data buffer */
1121    if (data != NULL) {
1122	if (*data == NULL) {
1123	    /* allocate data buffer */
1124	    if ((mc->mc_data = malloc(datasize, M_DEVBUF, M_NOWAIT)) == NULL) {
1125		error = ENOMEM;
1126		goto out;
1127	    }
1128	    mc->mc_flags |= MLY_CMD_DATAIN;
1129	} else {
1130	    mc->mc_data = *data;
1131	    mc->mc_flags |= MLY_CMD_DATAOUT;
1132	}
1133	mc->mc_length = datasize;
1134	mc->mc_packet->generic.data_size = datasize;
1135    }
1136
1137    /* run the command */
1138    if ((error = mly_immediate_command(mc)))
1139	goto out;
1140
1141    /* clean up and return any data */
1142    *status = mc->mc_status;
1143    if ((mc->mc_sense > 0) && (sense_buffer != NULL)) {
1144	bcopy(mc->mc_packet, sense_buffer, mc->mc_sense);
1145	*sense_length = mc->mc_sense;
1146	goto out;
1147    }
1148
1149    /* should we return a data pointer? */
1150    if ((data != NULL) && (*data == NULL))
1151	*data = mc->mc_data;
1152
1153    /* command completed OK */
1154    error = 0;
1155
1156out:
1157    if (mc != NULL) {
1158	/* do we need to free a data buffer we allocated? */
1159	if (error && (mc->mc_data != NULL) && (*data == NULL))
1160	    free(mc->mc_data, M_DEVBUF);
1161	mly_release_command(mc);
1162    }
1163    return(error);
1164}
1165
1166/********************************************************************************
1167 * Check for event(s) outstanding in the controller.
1168 */
1169static void
1170mly_check_event(struct mly_softc *sc)
1171{
1172
1173    /*
1174     * The controller may have updated the health status information,
1175     * so check for it here.  Note that the counters are all in host memory,
1176     * so this check is very cheap.  Also note that we depend on checking on
1177     * completion
1178     */
1179    if (sc->mly_mmbox->mmm_health.status.change_counter != sc->mly_event_change) {
1180	sc->mly_event_change = sc->mly_mmbox->mmm_health.status.change_counter;
1181	debug(1, "event change %d, event status update, %d -> %d", sc->mly_event_change,
1182	      sc->mly_event_waiting, sc->mly_mmbox->mmm_health.status.next_event);
1183	sc->mly_event_waiting = sc->mly_mmbox->mmm_health.status.next_event;
1184
1185	/* wake up anyone that might be interested in this */
1186	wakeup(&sc->mly_event_change);
1187    }
1188    if (sc->mly_event_counter != sc->mly_event_waiting)
1189    mly_fetch_event(sc);
1190}
1191
1192/********************************************************************************
1193 * Fetch one event from the controller.
1194 *
1195 * If we fail due to resource starvation, we'll be retried the next time a
1196 * command completes.
1197 */
1198static void
1199mly_fetch_event(struct mly_softc *sc)
1200{
1201    struct mly_command		*mc;
1202    struct mly_command_ioctl	*mci;
1203    int				s;
1204    u_int32_t			event;
1205
1206    debug_called(1);
1207
1208    /* get a command */
1209    if (mly_alloc_command(sc, &mc))
1210	return;
1211
1212    /* set up the data buffer */
1213    if ((mc->mc_data = malloc(sizeof(struct mly_event), M_DEVBUF, M_NOWAIT | M_ZERO)) == NULL) {
1214	mly_release_command(mc);
1215	return;
1216    }
1217    mc->mc_length = sizeof(struct mly_event);
1218    mc->mc_flags |= MLY_CMD_DATAIN;
1219    mc->mc_complete = mly_complete_event;
1220
1221    /*
1222     * Get an event number to fetch.  It's possible that we've raced with another
1223     * context for the last event, in which case there will be no more events.
1224     */
1225    s = splcam();
1226    if (sc->mly_event_counter == sc->mly_event_waiting) {
1227	mly_release_command(mc);
1228	splx(s);
1229	return;
1230    }
1231    event = sc->mly_event_counter++;
1232    splx(s);
1233
1234    /*
1235     * Build the ioctl.
1236     *
1237     * At this point we are committed to sending this request, as it
1238     * will be the only one constructed for this particular event number.
1239     */
1240    mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
1241    mci->opcode = MDACMD_IOCTL;
1242    mci->data_size = sizeof(struct mly_event);
1243    mci->addr.phys.lun = (event >> 16) & 0xff;
1244    mci->addr.phys.target = (event >> 24) & 0xff;
1245    mci->addr.phys.channel = 0;
1246    mci->addr.phys.controller = 0;
1247    mci->timeout.value = 30;
1248    mci->timeout.scale = MLY_TIMEOUT_SECONDS;
1249    mci->sub_ioctl = MDACIOCTL_GETEVENT;
1250    mci->param.getevent.sequence_number_low = event & 0xffff;
1251
1252    debug(1, "fetch event %u", event);
1253
1254    /*
1255     * Submit the command.
1256     *
1257     * Note that failure of mly_start() will result in this event never being
1258     * fetched.
1259     */
1260    if (mly_start(mc) != 0) {
1261	mly_printf(sc, "couldn't fetch event %u\n", event);
1262	mly_release_command(mc);
1263    }
1264}
1265
1266/********************************************************************************
1267 * Handle the completion of an event poll.
1268 */
1269static void
1270mly_complete_event(struct mly_command *mc)
1271{
1272    struct mly_softc	*sc = mc->mc_sc;
1273    struct mly_event	*me = (struct mly_event *)mc->mc_data;
1274
1275    debug_called(1);
1276
1277    /*
1278     * If the event was successfully fetched, process it.
1279     */
1280    if (mc->mc_status == SCSI_STATUS_OK) {
1281	mly_process_event(sc, me);
1282	free(me, M_DEVBUF);
1283    }
1284    mly_release_command(mc);
1285
1286    /*
1287     * Check for another event.
1288     */
1289    mly_check_event(sc);
1290}
1291
1292/********************************************************************************
1293 * Process a controller event.
1294 */
1295static void
1296mly_process_event(struct mly_softc *sc, struct mly_event *me)
1297{
1298    struct scsi_sense_data	*ssd = (struct scsi_sense_data *)&me->sense[0];
1299    char			*fp, *tp;
1300    int				bus, target, event, class, action;
1301
1302    /*
1303     * Errors can be reported using vendor-unique sense data.  In this case, the
1304     * event code will be 0x1c (Request sense data present), the sense key will
1305     * be 0x09 (vendor specific), the MSB of the ASC will be set, and the
1306     * actual event code will be a 16-bit value comprised of the ASCQ (low byte)
1307     * and low seven bits of the ASC (low seven bits of the high byte).
1308     */
1309    if ((me->code == 0x1c) &&
1310	((ssd->flags & SSD_KEY) == SSD_KEY_Vendor_Specific) &&
1311	(ssd->add_sense_code & 0x80)) {
1312	event = ((int)(ssd->add_sense_code & ~0x80) << 8) + ssd->add_sense_code_qual;
1313    } else {
1314	event = me->code;
1315    }
1316
1317    /* look up event, get codes */
1318    fp = mly_describe_code(mly_table_event, event);
1319
1320    debug(1, "Event %d  code 0x%x", me->sequence_number, me->code);
1321
1322    /* quiet event? */
1323    class = fp[0];
1324    if (isupper(class) && bootverbose)
1325	class = tolower(class);
1326
1327    /* get action code, text string */
1328    action = fp[1];
1329    tp = &fp[2];
1330
1331    /*
1332     * Print some information about the event.
1333     *
1334     * This code uses a table derived from the corresponding portion of the Linux
1335     * driver, and thus the parser is very similar.
1336     */
1337    switch(class) {
1338    case 'p':		/* error on physical device */
1339	mly_printf(sc, "physical device %d:%d %s\n", me->channel, me->target, tp);
1340	if (action == 'r')
1341	    sc->mly_btl[me->channel][me->target].mb_flags |= MLY_BTL_RESCAN;
1342	break;
1343    case 'l':		/* error on logical unit */
1344    case 'm':		/* message about logical unit */
1345	bus = MLY_LOGDEV_BUS(sc, me->lun);
1346	target = MLY_LOGDEV_TARGET(sc, me->lun);
1347	mly_name_device(sc, bus, target);
1348	mly_printf(sc, "logical device %d (%s) %s\n", me->lun, sc->mly_btl[bus][target].mb_name, tp);
1349	if (action == 'r')
1350	    sc->mly_btl[bus][target].mb_flags |= MLY_BTL_RESCAN;
1351	break;
1352      break;
1353    case 's':		/* report of sense data */
1354	if (((ssd->flags & SSD_KEY) == SSD_KEY_NO_SENSE) ||
1355	    (((ssd->flags & SSD_KEY) == SSD_KEY_NOT_READY) &&
1356	     (ssd->add_sense_code == 0x04) &&
1357	     ((ssd->add_sense_code_qual == 0x01) || (ssd->add_sense_code_qual == 0x02))))
1358	    break;	/* ignore NO_SENSE or NOT_READY in one case */
1359
1360	mly_printf(sc, "physical device %d:%d %s\n", me->channel, me->target, tp);
1361	mly_printf(sc, "  sense key %d  asc %02x  ascq %02x\n",
1362		      ssd->flags & SSD_KEY, ssd->add_sense_code, ssd->add_sense_code_qual);
1363	mly_printf(sc, "  info %4D  csi %4D\n", ssd->info, "", ssd->cmd_spec_info, "");
1364	if (action == 'r')
1365	    sc->mly_btl[me->channel][me->target].mb_flags |= MLY_BTL_RESCAN;
1366	break;
1367    case 'e':
1368	mly_printf(sc, tp, me->target, me->lun);
1369	printf("\n");
1370	break;
1371    case 'c':
1372	mly_printf(sc, "controller %s\n", tp);
1373	break;
1374    case '?':
1375	mly_printf(sc, "%s - %d\n", tp, me->code);
1376	break;
1377    default:	/* probably a 'noisy' event being ignored */
1378	break;
1379    }
1380}
1381
1382/********************************************************************************
1383 * Perform periodic activities.
1384 */
1385static void
1386mly_periodic(void *data)
1387{
1388    struct mly_softc	*sc = (struct mly_softc *)data;
1389    int			bus, target;
1390
1391    debug_called(2);
1392
1393    /*
1394     * Scan devices.
1395     */
1396    for (bus = 0; bus < sc->mly_cam_channels; bus++) {
1397	if (MLY_BUS_IS_VALID(sc, bus)) {
1398	    for (target = 0; target < MLY_MAX_TARGETS; target++) {
1399
1400		/* ignore the controller in this scan */
1401		if (target == sc->mly_controllerparam->initiator_id)
1402		    continue;
1403
1404		/* perform device rescan? */
1405		if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_RESCAN)
1406		    mly_rescan_btl(sc, bus, target);
1407	    }
1408	}
1409    }
1410
1411    /* check for controller events */
1412    mly_check_event(sc);
1413
1414    /* reschedule ourselves */
1415    sc->mly_periodic = timeout(mly_periodic, sc, MLY_PERIODIC_INTERVAL * hz);
1416}
1417
1418/********************************************************************************
1419 ********************************************************************************
1420                                                               Command Processing
1421 ********************************************************************************
1422 ********************************************************************************/
1423
1424/********************************************************************************
1425 * Run a command and wait for it to complete.
1426 *
1427 */
1428static int
1429mly_immediate_command(struct mly_command *mc)
1430{
1431    struct mly_softc	*sc = mc->mc_sc;
1432    int			error, s;
1433
1434    debug_called(1);
1435
1436    /* spinning at splcam is ugly, but we're only used during controller init */
1437    s = splcam();
1438    if ((error = mly_start(mc))) {
1439	splx(s);
1440	return(error);
1441    }
1442
1443    if (sc->mly_state & MLY_STATE_INTERRUPTS_ON) {
1444	/* sleep on the command */
1445	while(!(mc->mc_flags & MLY_CMD_COMPLETE)) {
1446	    tsleep(mc, PRIBIO, "mlywait", 0);
1447	}
1448    } else {
1449	/* spin and collect status while we do */
1450	while(!(mc->mc_flags & MLY_CMD_COMPLETE)) {
1451	    mly_done(mc->mc_sc);
1452	}
1453    }
1454    splx(s);
1455    return(0);
1456}
1457
1458/********************************************************************************
1459 * Deliver a command to the controller.
1460 *
1461 * XXX it would be good to just queue commands that we can't submit immediately
1462 *     and send them later, but we probably want a wrapper for that so that
1463 *     we don't hang on a failed submission for an immediate command.
1464 */
1465static int
1466mly_start(struct mly_command *mc)
1467{
1468    struct mly_softc		*sc = mc->mc_sc;
1469    union mly_command_packet	*pkt;
1470    int				s;
1471
1472    debug_called(2);
1473
1474    /*
1475     * Set the command up for delivery to the controller.
1476     */
1477    mly_map_command(mc);
1478    mc->mc_packet->generic.command_id = mc->mc_slot;
1479
1480#ifdef MLY_DEBUG
1481    mc->mc_timestamp = time_second;
1482#endif
1483
1484    s = splcam();
1485
1486    /*
1487     * Do we have to use the hardware mailbox?
1488     */
1489    if (!(sc->mly_state & MLY_STATE_MMBOX_ACTIVE)) {
1490	/*
1491	 * Check to see if the controller is ready for us.
1492	 */
1493	if (MLY_IDBR_TRUE(sc, MLY_HM_CMDSENT)) {
1494	    splx(s);
1495	    return(EBUSY);
1496	}
1497	mc->mc_flags |= MLY_CMD_BUSY;
1498
1499	/*
1500	 * It's ready, send the command.
1501	 */
1502	MLY_SET_MBOX(sc, sc->mly_command_mailbox, &mc->mc_packetphys);
1503	MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_CMDSENT);
1504
1505    } else {	/* use memory-mailbox mode */
1506
1507	pkt = &sc->mly_mmbox->mmm_command[sc->mly_mmbox_command_index];
1508
1509	/* check to see if the next index is free yet */
1510	if (pkt->mmbox.flag != 0) {
1511	    splx(s);
1512	    return(EBUSY);
1513	}
1514	mc->mc_flags |= MLY_CMD_BUSY;
1515
1516	/* copy in new command */
1517	bcopy(mc->mc_packet->mmbox.data, pkt->mmbox.data, sizeof(pkt->mmbox.data));
1518	/* barrier to ensure completion of previous write before we write the flag */
1519	bus_space_barrier(sc->mly_btag, sc->mly_bhandle, 0, 0,
1520	    BUS_SPACE_BARRIER_WRITE);
1521	/* copy flag last */
1522	pkt->mmbox.flag = mc->mc_packet->mmbox.flag;
1523	/* barrier to ensure completion of previous write before we notify the controller */
1524	bus_space_barrier(sc->mly_btag, sc->mly_bhandle, 0, 0,
1525	    BUS_SPACE_BARRIER_WRITE);
1526
1527	/* signal controller, update index */
1528	MLY_SET_REG(sc, sc->mly_idbr, MLY_AM_CMDSENT);
1529	sc->mly_mmbox_command_index = (sc->mly_mmbox_command_index + 1) % MLY_MMBOX_COMMANDS;
1530    }
1531
1532    mly_enqueue_busy(mc);
1533    splx(s);
1534    return(0);
1535}
1536
1537/********************************************************************************
1538 * Pick up command status from the controller, schedule a completion event
1539 */
1540static void
1541mly_done(struct mly_softc *sc)
1542{
1543    struct mly_command		*mc;
1544    union mly_status_packet	*sp;
1545    u_int16_t			slot;
1546    int				s, worked;
1547
1548    s = splcam();
1549    worked = 0;
1550
1551    /* pick up hardware-mailbox commands */
1552    if (MLY_ODBR_TRUE(sc, MLY_HM_STSREADY)) {
1553	slot = MLY_GET_REG2(sc, sc->mly_status_mailbox);
1554	if (slot < MLY_SLOT_MAX) {
1555	    mc = &sc->mly_command[slot - MLY_SLOT_START];
1556	    mc->mc_status = MLY_GET_REG(sc, sc->mly_status_mailbox + 2);
1557	    mc->mc_sense = MLY_GET_REG(sc, sc->mly_status_mailbox + 3);
1558	    mc->mc_resid = MLY_GET_REG4(sc, sc->mly_status_mailbox + 4);
1559	    mly_remove_busy(mc);
1560	    mc->mc_flags &= ~MLY_CMD_BUSY;
1561	    mly_enqueue_complete(mc);
1562	    worked = 1;
1563	} else {
1564	    /* slot 0xffff may mean "extremely bogus command" */
1565	    mly_printf(sc, "got HM completion for illegal slot %u\n", slot);
1566	}
1567	/* unconditionally acknowledge status */
1568	MLY_SET_REG(sc, sc->mly_odbr, MLY_HM_STSREADY);
1569	MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_STSACK);
1570    }
1571
1572    /* pick up memory-mailbox commands */
1573    if (MLY_ODBR_TRUE(sc, MLY_AM_STSREADY)) {
1574	for (;;) {
1575	    sp = &sc->mly_mmbox->mmm_status[sc->mly_mmbox_status_index];
1576
1577	    /* check for more status */
1578	    if (sp->mmbox.flag == 0)
1579		break;
1580
1581	    /* get slot number */
1582	    slot = sp->status.command_id;
1583	    if (slot < MLY_SLOT_MAX) {
1584		mc = &sc->mly_command[slot - MLY_SLOT_START];
1585		mc->mc_status = sp->status.status;
1586		mc->mc_sense = sp->status.sense_length;
1587		mc->mc_resid = sp->status.residue;
1588		mly_remove_busy(mc);
1589		mc->mc_flags &= ~MLY_CMD_BUSY;
1590		mly_enqueue_complete(mc);
1591		worked = 1;
1592	    } else {
1593		/* slot 0xffff may mean "extremely bogus command" */
1594		mly_printf(sc, "got AM completion for illegal slot %u at %d\n",
1595			   slot, sc->mly_mmbox_status_index);
1596	    }
1597
1598	    /* clear and move to next index */
1599	    sp->mmbox.flag = 0;
1600	    sc->mly_mmbox_status_index = (sc->mly_mmbox_status_index + 1) % MLY_MMBOX_STATUS;
1601	}
1602	/* acknowledge that we have collected status value(s) */
1603	MLY_SET_REG(sc, sc->mly_odbr, MLY_AM_STSREADY);
1604    }
1605
1606    splx(s);
1607    if (worked) {
1608#if __FreeBSD_version >= 500005
1609	if (sc->mly_state & MLY_STATE_INTERRUPTS_ON)
1610	    taskqueue_enqueue(taskqueue_swi_giant, &sc->mly_task_complete);
1611	else
1612#endif
1613	    mly_complete(sc, 0);
1614    }
1615}
1616
1617/********************************************************************************
1618 * Process completed commands
1619 */
1620static void
1621mly_complete(void *context, int pending)
1622{
1623    struct mly_softc	*sc = (struct mly_softc *)context;
1624    struct mly_command	*mc;
1625    void	        (* mc_complete)(struct mly_command *mc);
1626
1627
1628    debug_called(2);
1629
1630    /*
1631     * Spin pulling commands off the completed queue and processing them.
1632     */
1633    while ((mc = mly_dequeue_complete(sc)) != NULL) {
1634
1635	/*
1636	 * Free controller resources, mark command complete.
1637	 *
1638	 * Note that as soon as we mark the command complete, it may be freed
1639	 * out from under us, so we need to save the mc_complete field in
1640	 * order to later avoid dereferencing mc.  (We would not expect to
1641	 * have a polling/sleeping consumer with mc_complete != NULL).
1642	 */
1643	mly_unmap_command(mc);
1644	mc_complete = mc->mc_complete;
1645	mc->mc_flags |= MLY_CMD_COMPLETE;
1646
1647	/*
1648	 * Call completion handler or wake up sleeping consumer.
1649	 */
1650	if (mc_complete != NULL) {
1651	    mc_complete(mc);
1652	} else {
1653	    wakeup(mc);
1654	}
1655    }
1656
1657    /*
1658     * XXX if we are deferring commands due to controller-busy status, we should
1659     *     retry submitting them here.
1660     */
1661}
1662
1663/********************************************************************************
1664 ********************************************************************************
1665                                                        Command Buffer Management
1666 ********************************************************************************
1667 ********************************************************************************/
1668
1669/********************************************************************************
1670 * Allocate a command.
1671 */
1672static int
1673mly_alloc_command(struct mly_softc *sc, struct mly_command **mcp)
1674{
1675    struct mly_command	*mc;
1676
1677    debug_called(3);
1678
1679    if ((mc = mly_dequeue_free(sc)) == NULL)
1680	return(ENOMEM);
1681
1682    *mcp = mc;
1683    return(0);
1684}
1685
1686/********************************************************************************
1687 * Release a command back to the freelist.
1688 */
1689static void
1690mly_release_command(struct mly_command *mc)
1691{
1692    debug_called(3);
1693
1694    /*
1695     * Fill in parts of the command that may cause confusion if
1696     * a consumer doesn't when we are later allocated.
1697     */
1698    mc->mc_data = NULL;
1699    mc->mc_flags = 0;
1700    mc->mc_complete = NULL;
1701    mc->mc_private = NULL;
1702
1703    /*
1704     * By default, we set up to overwrite the command packet with
1705     * sense information.
1706     */
1707    mc->mc_packet->generic.sense_buffer_address = mc->mc_packetphys;
1708    mc->mc_packet->generic.maximum_sense_size = sizeof(union mly_command_packet);
1709
1710    mly_enqueue_free(mc);
1711}
1712
1713/********************************************************************************
1714 * Map helper for command allocation.
1715 */
1716static void
1717mly_alloc_commands_map(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1718{
1719    struct mly_softc	*sc = (struct mly_softc *)arg;
1720
1721    debug_called(1);
1722
1723    sc->mly_packetphys = segs[0].ds_addr;
1724}
1725
1726/********************************************************************************
1727 * Allocate and initialise command and packet structures.
1728 *
1729 * If the controller supports fewer than MLY_MAX_COMMANDS commands, limit our
1730 * allocation to that number.  If we don't yet know how many commands the
1731 * controller supports, allocate a very small set (suitable for initialisation
1732 * purposes only).
1733 */
1734static int
1735mly_alloc_commands(struct mly_softc *sc)
1736{
1737    struct mly_command		*mc;
1738    int				i, ncmd;
1739
1740    if (sc->mly_controllerinfo == NULL) {
1741	ncmd = 4;
1742    } else {
1743	ncmd = min(MLY_MAX_COMMANDS, sc->mly_controllerinfo->maximum_parallel_commands);
1744    }
1745
1746    /*
1747     * Allocate enough space for all the command packets in one chunk and
1748     * map them permanently into controller-visible space.
1749     */
1750    if (bus_dmamem_alloc(sc->mly_packet_dmat, (void **)&sc->mly_packet,
1751			 BUS_DMA_NOWAIT, &sc->mly_packetmap)) {
1752	return(ENOMEM);
1753    }
1754    if (bus_dmamap_load(sc->mly_packet_dmat, sc->mly_packetmap, sc->mly_packet,
1755			ncmd * sizeof(union mly_command_packet),
1756			mly_alloc_commands_map, sc, BUS_DMA_NOWAIT) != 0)
1757	return (ENOMEM);
1758
1759    for (i = 0; i < ncmd; i++) {
1760	mc = &sc->mly_command[i];
1761	bzero(mc, sizeof(*mc));
1762	mc->mc_sc = sc;
1763	mc->mc_slot = MLY_SLOT_START + i;
1764	mc->mc_packet = sc->mly_packet + i;
1765	mc->mc_packetphys = sc->mly_packetphys + (i * sizeof(union mly_command_packet));
1766	if (!bus_dmamap_create(sc->mly_buffer_dmat, 0, &mc->mc_datamap))
1767	    mly_release_command(mc);
1768    }
1769    return(0);
1770}
1771
1772/********************************************************************************
1773 * Free all the storage held by commands.
1774 *
1775 * Must be called with all commands on the free list.
1776 */
1777static void
1778mly_release_commands(struct mly_softc *sc)
1779{
1780    struct mly_command	*mc;
1781
1782    /* throw away command buffer DMA maps */
1783    while (mly_alloc_command(sc, &mc) == 0)
1784	bus_dmamap_destroy(sc->mly_buffer_dmat, mc->mc_datamap);
1785
1786    /* release the packet storage */
1787    if (sc->mly_packet != NULL) {
1788	bus_dmamap_unload(sc->mly_packet_dmat, sc->mly_packetmap);
1789	bus_dmamem_free(sc->mly_packet_dmat, sc->mly_packet, sc->mly_packetmap);
1790	sc->mly_packet = NULL;
1791    }
1792}
1793
1794
1795/********************************************************************************
1796 * Command-mapping helper function - populate this command's s/g table
1797 * with the s/g entries for its data.
1798 */
1799static void
1800mly_map_command_sg(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1801{
1802    struct mly_command		*mc = (struct mly_command *)arg;
1803    struct mly_softc		*sc = mc->mc_sc;
1804    struct mly_command_generic	*gen = &(mc->mc_packet->generic);
1805    struct mly_sg_entry		*sg;
1806    int				i, tabofs;
1807
1808    debug_called(2);
1809
1810    /* can we use the transfer structure directly? */
1811    if (nseg <= 2) {
1812	sg = &gen->transfer.direct.sg[0];
1813	gen->command_control.extended_sg_table = 0;
1814    } else {
1815	tabofs = ((mc->mc_slot - MLY_SLOT_START) * MLY_MAX_SGENTRIES);
1816	sg = sc->mly_sg_table + tabofs;
1817	gen->transfer.indirect.entries[0] = nseg;
1818	gen->transfer.indirect.table_physaddr[0] = sc->mly_sg_busaddr + (tabofs * sizeof(struct mly_sg_entry));
1819	gen->command_control.extended_sg_table = 1;
1820    }
1821
1822    /* copy the s/g table */
1823    for (i = 0; i < nseg; i++) {
1824	sg[i].physaddr = segs[i].ds_addr;
1825	sg[i].length = segs[i].ds_len;
1826    }
1827
1828}
1829
1830#if 0
1831/********************************************************************************
1832 * Command-mapping helper function - save the cdb's physical address.
1833 *
1834 * We don't support 'large' SCSI commands at this time, so this is unused.
1835 */
1836static void
1837mly_map_command_cdb(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1838{
1839    struct mly_command			*mc = (struct mly_command *)arg;
1840
1841    debug_called(2);
1842
1843    /* XXX can we safely assume that a CDB will never cross a page boundary? */
1844    if ((segs[0].ds_addr % PAGE_SIZE) >
1845	((segs[0].ds_addr + mc->mc_packet->scsi_large.cdb_length) % PAGE_SIZE))
1846	panic("cdb crosses page boundary");
1847
1848    /* fix up fields in the command packet */
1849    mc->mc_packet->scsi_large.cdb_physaddr = segs[0].ds_addr;
1850}
1851#endif
1852
1853/********************************************************************************
1854 * Map a command into controller-visible space
1855 */
1856static void
1857mly_map_command(struct mly_command *mc)
1858{
1859    struct mly_softc	*sc = mc->mc_sc;
1860
1861    debug_called(2);
1862
1863    /* don't map more than once */
1864    if (mc->mc_flags & MLY_CMD_MAPPED)
1865	return;
1866
1867    /* does the command have a data buffer? */
1868    if (mc->mc_data != NULL) {
1869	bus_dmamap_load(sc->mly_buffer_dmat, mc->mc_datamap, mc->mc_data, mc->mc_length,
1870			mly_map_command_sg, mc, 0);
1871
1872	if (mc->mc_flags & MLY_CMD_DATAIN)
1873	    bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_PREREAD);
1874	if (mc->mc_flags & MLY_CMD_DATAOUT)
1875	    bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_PREWRITE);
1876    }
1877    mc->mc_flags |= MLY_CMD_MAPPED;
1878}
1879
1880/********************************************************************************
1881 * Unmap a command from controller-visible space
1882 */
1883static void
1884mly_unmap_command(struct mly_command *mc)
1885{
1886    struct mly_softc	*sc = mc->mc_sc;
1887
1888    debug_called(2);
1889
1890    if (!(mc->mc_flags & MLY_CMD_MAPPED))
1891	return;
1892
1893    /* does the command have a data buffer? */
1894    if (mc->mc_data != NULL) {
1895	if (mc->mc_flags & MLY_CMD_DATAIN)
1896	    bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_POSTREAD);
1897	if (mc->mc_flags & MLY_CMD_DATAOUT)
1898	    bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_POSTWRITE);
1899
1900	bus_dmamap_unload(sc->mly_buffer_dmat, mc->mc_datamap);
1901    }
1902    mc->mc_flags &= ~MLY_CMD_MAPPED;
1903}
1904
1905
1906/********************************************************************************
1907 ********************************************************************************
1908                                                                    CAM interface
1909 ********************************************************************************
1910 ********************************************************************************/
1911
1912/********************************************************************************
1913 * Attach the physical and virtual SCSI busses to CAM.
1914 *
1915 * Physical bus numbering starts from 0, virtual bus numbering from one greater
1916 * than the highest physical bus.  Physical busses are only registered if
1917 * the kernel environment variable "hw.mly.register_physical_channels" is set.
1918 *
1919 * When we refer to a "bus", we are referring to the bus number registered with
1920 * the SIM, wheras a "channel" is a channel number given to the adapter.  In order
1921 * to keep things simple, we map these 1:1, so "bus" and "channel" may be used
1922 * interchangeably.
1923 */
1924static int
1925mly_cam_attach(struct mly_softc *sc)
1926{
1927    struct cam_devq	*devq;
1928    int			chn, i;
1929
1930    debug_called(1);
1931
1932    /*
1933     * Allocate a devq for all our channels combined.
1934     */
1935    if ((devq = cam_simq_alloc(sc->mly_controllerinfo->maximum_parallel_commands)) == NULL) {
1936	mly_printf(sc, "can't allocate CAM SIM queue\n");
1937	return(ENOMEM);
1938    }
1939
1940    /*
1941     * If physical channel registration has been requested, register these first.
1942     * Note that we enable tagged command queueing for physical channels.
1943     */
1944    if (testenv("hw.mly.register_physical_channels")) {
1945	chn = 0;
1946	for (i = 0; i < sc->mly_controllerinfo->physical_channels_present; i++, chn++) {
1947
1948	    if ((sc->mly_cam_sim[chn] = cam_sim_alloc(mly_cam_action, mly_cam_poll, "mly", sc,
1949						      device_get_unit(sc->mly_dev),
1950						      sc->mly_controllerinfo->maximum_parallel_commands,
1951						      1, devq)) == NULL) {
1952		return(ENOMEM);
1953	    }
1954	    if (xpt_bus_register(sc->mly_cam_sim[chn], chn)) {
1955		mly_printf(sc, "CAM XPT phsyical channel registration failed\n");
1956		return(ENXIO);
1957	    }
1958	    debug(1, "registered physical channel %d", chn);
1959	}
1960    }
1961
1962    /*
1963     * Register our virtual channels, with bus numbers matching channel numbers.
1964     */
1965    chn = sc->mly_controllerinfo->physical_channels_present;
1966    for (i = 0; i < sc->mly_controllerinfo->virtual_channels_present; i++, chn++) {
1967	if ((sc->mly_cam_sim[chn] = cam_sim_alloc(mly_cam_action, mly_cam_poll, "mly", sc,
1968						  device_get_unit(sc->mly_dev),
1969						  sc->mly_controllerinfo->maximum_parallel_commands,
1970						  0, devq)) == NULL) {
1971	    return(ENOMEM);
1972	}
1973	if (xpt_bus_register(sc->mly_cam_sim[chn], chn)) {
1974	    mly_printf(sc, "CAM XPT virtual channel registration failed\n");
1975	    return(ENXIO);
1976	}
1977	debug(1, "registered virtual channel %d", chn);
1978    }
1979
1980    /*
1981     * This is the total number of channels that (might have been) registered with
1982     * CAM.  Some may not have been; check the mly_cam_sim array to be certain.
1983     */
1984    sc->mly_cam_channels = sc->mly_controllerinfo->physical_channels_present +
1985	sc->mly_controllerinfo->virtual_channels_present;
1986
1987    return(0);
1988}
1989
1990/********************************************************************************
1991 * Detach from CAM
1992 */
1993static void
1994mly_cam_detach(struct mly_softc *sc)
1995{
1996    int		i;
1997
1998    debug_called(1);
1999
2000    for (i = 0; i < sc->mly_cam_channels; i++) {
2001	if (sc->mly_cam_sim[i] != NULL) {
2002	    xpt_bus_deregister(cam_sim_path(sc->mly_cam_sim[i]));
2003	    cam_sim_free(sc->mly_cam_sim[i], 0);
2004	}
2005    }
2006    if (sc->mly_cam_devq != NULL)
2007	cam_simq_free(sc->mly_cam_devq);
2008}
2009
2010/************************************************************************
2011 * Rescan a device.
2012 */
2013static void
2014mly_cam_rescan_btl(struct mly_softc *sc, int bus, int target)
2015{
2016    union ccb	*ccb;
2017
2018    debug_called(1);
2019
2020    if ((ccb = malloc(sizeof(union ccb), M_TEMP, M_WAITOK | M_ZERO)) == NULL) {
2021	mly_printf(sc, "rescan failed (can't allocate CCB)\n");
2022	return;
2023    }
2024
2025    if (xpt_create_path(&sc->mly_cam_path, xpt_periph,
2026			cam_sim_path(sc->mly_cam_sim[bus]), target, 0) != CAM_REQ_CMP) {
2027	mly_printf(sc, "rescan failed (can't create path)\n");
2028	free(ccb, M_TEMP);
2029	return;
2030    }
2031    xpt_setup_ccb(&ccb->ccb_h, sc->mly_cam_path, 5/*priority (low)*/);
2032    ccb->ccb_h.func_code = XPT_SCAN_LUN;
2033    ccb->ccb_h.cbfcnp = mly_cam_rescan_callback;
2034    ccb->crcn.flags = CAM_FLAG_NONE;
2035    debug(1, "rescan target %d:%d", bus, target);
2036    xpt_action(ccb);
2037}
2038
2039static void
2040mly_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb)
2041{
2042    free(ccb, M_TEMP);
2043}
2044
2045/********************************************************************************
2046 * Handle an action requested by CAM
2047 */
2048static void
2049mly_cam_action(struct cam_sim *sim, union ccb *ccb)
2050{
2051    struct mly_softc	*sc = cam_sim_softc(sim);
2052
2053    debug_called(2);
2054
2055    switch (ccb->ccb_h.func_code) {
2056
2057	/* perform SCSI I/O */
2058    case XPT_SCSI_IO:
2059	if (!mly_cam_action_io(sim, (struct ccb_scsiio *)&ccb->csio))
2060	    return;
2061	break;
2062
2063	/* perform geometry calculations */
2064    case XPT_CALC_GEOMETRY:
2065    {
2066	struct ccb_calc_geometry	*ccg = &ccb->ccg;
2067        u_int32_t			secs_per_cylinder;
2068
2069	debug(2, "XPT_CALC_GEOMETRY %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
2070
2071	if (sc->mly_controllerparam->bios_geometry == MLY_BIOSGEOM_8G) {
2072	    ccg->heads = 255;
2073            ccg->secs_per_track = 63;
2074	} else {				/* MLY_BIOSGEOM_2G */
2075	    ccg->heads = 128;
2076            ccg->secs_per_track = 32;
2077	}
2078	secs_per_cylinder = ccg->heads * ccg->secs_per_track;
2079        ccg->cylinders = ccg->volume_size / secs_per_cylinder;
2080        ccb->ccb_h.status = CAM_REQ_CMP;
2081        break;
2082    }
2083
2084	/* handle path attribute inquiry */
2085    case XPT_PATH_INQ:
2086    {
2087	struct ccb_pathinq	*cpi = &ccb->cpi;
2088
2089	debug(2, "XPT_PATH_INQ %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
2090
2091	cpi->version_num = 1;
2092	cpi->hba_inquiry = PI_TAG_ABLE;		/* XXX extra flags for physical channels? */
2093	cpi->target_sprt = 0;
2094	cpi->hba_misc = 0;
2095	cpi->max_target = MLY_MAX_TARGETS - 1;
2096	cpi->max_lun = MLY_MAX_LUNS - 1;
2097	cpi->initiator_id = sc->mly_controllerparam->initiator_id;
2098	strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
2099        strncpy(cpi->hba_vid, "FreeBSD", HBA_IDLEN);
2100        strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
2101        cpi->unit_number = cam_sim_unit(sim);
2102        cpi->bus_id = cam_sim_bus(sim);
2103	cpi->base_transfer_speed = 132 * 1024;	/* XXX what to set this to? */
2104	ccb->ccb_h.status = CAM_REQ_CMP;
2105	break;
2106    }
2107
2108    case XPT_GET_TRAN_SETTINGS:
2109    {
2110	struct ccb_trans_settings	*cts = &ccb->cts;
2111	int				bus, target;
2112
2113	bus = cam_sim_bus(sim);
2114	target = cts->ccb_h.target_id;
2115	/* XXX validate bus/target? */
2116
2117	debug(2, "XPT_GET_TRAN_SETTINGS %d:%d", bus, target);
2118	cts->valid = 0;
2119
2120	/* logical device? */
2121	if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_LOGICAL) {
2122	    /* nothing special for these */
2123
2124	/* physical device? */
2125	} else if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_PHYSICAL) {
2126	    /* allow CAM to try tagged transactions */
2127	    cts->flags |= CCB_TRANS_TAG_ENB;
2128	    cts->valid |= CCB_TRANS_TQ_VALID;
2129
2130	    /* convert speed (MHz) to usec */
2131	    if (sc->mly_btl[bus][target].mb_speed == 0) {
2132		cts->sync_period = 1000000 / 5;
2133	    } else {
2134		cts->sync_period = 1000000 / sc->mly_btl[bus][target].mb_speed;
2135	    }
2136
2137	    /* convert bus width to CAM internal encoding */
2138	    switch (sc->mly_btl[bus][target].mb_width) {
2139	    case 32:
2140		cts->bus_width = MSG_EXT_WDTR_BUS_32_BIT;
2141		break;
2142	    case 16:
2143		cts->bus_width = MSG_EXT_WDTR_BUS_16_BIT;
2144		break;
2145	    case 8:
2146	    default:
2147		cts->bus_width = MSG_EXT_WDTR_BUS_8_BIT;
2148		break;
2149	    }
2150	    cts->valid |= CCB_TRANS_SYNC_RATE_VALID | CCB_TRANS_BUS_WIDTH_VALID;
2151
2152	    /* not a device, bail out */
2153	} else {
2154	    cts->ccb_h.status = CAM_REQ_CMP_ERR;
2155	    break;
2156	}
2157
2158	/* disconnect always OK */
2159	cts->flags |= CCB_TRANS_DISC_ENB;
2160	cts->valid |= CCB_TRANS_DISC_VALID;
2161
2162	cts->ccb_h.status = CAM_REQ_CMP;
2163	break;
2164    }
2165
2166    default:		/* we can't do this */
2167	debug(2, "unspported func_code = 0x%x", ccb->ccb_h.func_code);
2168	ccb->ccb_h.status = CAM_REQ_INVALID;
2169	break;
2170    }
2171
2172    xpt_done(ccb);
2173}
2174
2175/********************************************************************************
2176 * Handle an I/O operation requested by CAM
2177 */
2178static int
2179mly_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio)
2180{
2181    struct mly_softc			*sc = cam_sim_softc(sim);
2182    struct mly_command			*mc;
2183    struct mly_command_scsi_small	*ss;
2184    int					bus, target;
2185    int					error;
2186    int					s;
2187
2188    bus = cam_sim_bus(sim);
2189    target = csio->ccb_h.target_id;
2190
2191    debug(2, "XPT_SCSI_IO %d:%d:%d", bus, target, csio->ccb_h.target_lun);
2192
2193    /* validate bus number */
2194    if (!MLY_BUS_IS_VALID(sc, bus)) {
2195	debug(0, " invalid bus %d", bus);
2196	csio->ccb_h.status = CAM_REQ_CMP_ERR;
2197    }
2198
2199    /*  check for I/O attempt to a protected device */
2200    if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_PROTECTED) {
2201	debug(2, "  device protected");
2202	csio->ccb_h.status = CAM_REQ_CMP_ERR;
2203    }
2204
2205    /* check for I/O attempt to nonexistent device */
2206    if (!(sc->mly_btl[bus][target].mb_flags & (MLY_BTL_LOGICAL | MLY_BTL_PHYSICAL))) {
2207	debug(2, "  device %d:%d does not exist", bus, target);
2208	csio->ccb_h.status = CAM_REQ_CMP_ERR;
2209    }
2210
2211    /* XXX increase if/when we support large SCSI commands */
2212    if (csio->cdb_len > MLY_CMD_SCSI_SMALL_CDB) {
2213	debug(0, "  command too large (%d > %d)", csio->cdb_len, MLY_CMD_SCSI_SMALL_CDB);
2214	csio->ccb_h.status = CAM_REQ_CMP_ERR;
2215    }
2216
2217    /* check that the CDB pointer is not to a physical address */
2218    if ((csio->ccb_h.flags & CAM_CDB_POINTER) && (csio->ccb_h.flags & CAM_CDB_PHYS)) {
2219	debug(0, "  CDB pointer is to physical address");
2220	csio->ccb_h.status = CAM_REQ_CMP_ERR;
2221    }
2222
2223    /* if there is data transfer, it must be to/from a virtual address */
2224    if ((csio->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
2225	if (csio->ccb_h.flags & CAM_DATA_PHYS) {		/* we can't map it */
2226	    debug(0, "  data pointer is to physical address");
2227	    csio->ccb_h.status = CAM_REQ_CMP_ERR;
2228	}
2229	if (csio->ccb_h.flags & CAM_SCATTER_VALID) {	/* we want to do the s/g setup */
2230	    debug(0, "  data has premature s/g setup");
2231	    csio->ccb_h.status = CAM_REQ_CMP_ERR;
2232	}
2233    }
2234
2235    /* abandon aborted ccbs or those that have failed validation */
2236    if ((csio->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
2237	debug(2, "abandoning CCB due to abort/validation failure");
2238	return(EINVAL);
2239    }
2240
2241    /*
2242     * Get a command, or push the ccb back to CAM and freeze the queue.
2243     */
2244    if ((error = mly_alloc_command(sc, &mc))) {
2245	s = splcam();
2246	xpt_freeze_simq(sim, 1);
2247	csio->ccb_h.status |= CAM_REQUEUE_REQ;
2248	sc->mly_qfrzn_cnt++;
2249	splx(s);
2250	return(error);
2251    }
2252
2253    /* build the command */
2254    mc->mc_data = csio->data_ptr;
2255    mc->mc_length = csio->dxfer_len;
2256    mc->mc_complete = mly_cam_complete;
2257    mc->mc_private = csio;
2258
2259    /* save the bus number in the ccb for later recovery XXX should be a better way */
2260     csio->ccb_h.sim_priv.entries[0].field = bus;
2261
2262    /* build the packet for the controller */
2263    ss = &mc->mc_packet->scsi_small;
2264    ss->opcode = MDACMD_SCSI;
2265    if (csio->ccb_h.flags & CAM_DIS_DISCONNECT)
2266	ss->command_control.disable_disconnect = 1;
2267    if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT)
2268	ss->command_control.data_direction = MLY_CCB_WRITE;
2269    ss->data_size = csio->dxfer_len;
2270    ss->addr.phys.lun = csio->ccb_h.target_lun;
2271    ss->addr.phys.target = csio->ccb_h.target_id;
2272    ss->addr.phys.channel = bus;
2273    if (csio->ccb_h.timeout < (60 * 1000)) {
2274	ss->timeout.value = csio->ccb_h.timeout / 1000;
2275	ss->timeout.scale = MLY_TIMEOUT_SECONDS;
2276    } else if (csio->ccb_h.timeout < (60 * 60 * 1000)) {
2277	ss->timeout.value = csio->ccb_h.timeout / (60 * 1000);
2278	ss->timeout.scale = MLY_TIMEOUT_MINUTES;
2279    } else {
2280	ss->timeout.value = csio->ccb_h.timeout / (60 * 60 * 1000);	/* overflow? */
2281	ss->timeout.scale = MLY_TIMEOUT_HOURS;
2282    }
2283    ss->maximum_sense_size = csio->sense_len;
2284    ss->cdb_length = csio->cdb_len;
2285    if (csio->ccb_h.flags & CAM_CDB_POINTER) {
2286	bcopy(csio->cdb_io.cdb_ptr, ss->cdb, csio->cdb_len);
2287    } else {
2288	bcopy(csio->cdb_io.cdb_bytes, ss->cdb, csio->cdb_len);
2289    }
2290
2291    /* give the command to the controller */
2292    if ((error = mly_start(mc))) {
2293	s = splcam();
2294	xpt_freeze_simq(sim, 1);
2295	csio->ccb_h.status |= CAM_REQUEUE_REQ;
2296	sc->mly_qfrzn_cnt++;
2297	splx(s);
2298	return(error);
2299    }
2300
2301    return(0);
2302}
2303
2304/********************************************************************************
2305 * Check for possibly-completed commands.
2306 */
2307static void
2308mly_cam_poll(struct cam_sim *sim)
2309{
2310    struct mly_softc	*sc = cam_sim_softc(sim);
2311
2312    debug_called(2);
2313
2314    mly_done(sc);
2315}
2316
2317/********************************************************************************
2318 * Handle completion of a command - pass results back through the CCB
2319 */
2320static void
2321mly_cam_complete(struct mly_command *mc)
2322{
2323    struct mly_softc		*sc = mc->mc_sc;
2324    struct ccb_scsiio		*csio = (struct ccb_scsiio *)mc->mc_private;
2325    struct scsi_inquiry_data	*inq = (struct scsi_inquiry_data *)csio->data_ptr;
2326    struct mly_btl		*btl;
2327    u_int8_t			cmd;
2328    int				bus, target;
2329    int				s;
2330
2331    debug_called(2);
2332
2333    csio->scsi_status = mc->mc_status;
2334    switch(mc->mc_status) {
2335    case SCSI_STATUS_OK:
2336	/*
2337	 * In order to report logical device type and status, we overwrite
2338	 * the result of the INQUIRY command to logical devices.
2339	 */
2340	bus = csio->ccb_h.sim_priv.entries[0].field;
2341	target = csio->ccb_h.target_id;
2342	/* XXX validate bus/target? */
2343	if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_LOGICAL) {
2344	    if (csio->ccb_h.flags & CAM_CDB_POINTER) {
2345		cmd = *csio->cdb_io.cdb_ptr;
2346	    } else {
2347		cmd = csio->cdb_io.cdb_bytes[0];
2348	    }
2349	    if (cmd == INQUIRY) {
2350		btl = &sc->mly_btl[bus][target];
2351		padstr(inq->vendor, mly_describe_code(mly_table_device_type, btl->mb_type), 8);
2352		padstr(inq->product, mly_describe_code(mly_table_device_state, btl->mb_state), 16);
2353		padstr(inq->revision, "", 4);
2354	    }
2355	}
2356
2357	debug(2, "SCSI_STATUS_OK");
2358	csio->ccb_h.status = CAM_REQ_CMP;
2359	break;
2360
2361    case SCSI_STATUS_CHECK_COND:
2362	debug(1, "SCSI_STATUS_CHECK_COND  sense %d  resid %d", mc->mc_sense, mc->mc_resid);
2363	csio->ccb_h.status = CAM_SCSI_STATUS_ERROR;
2364	bzero(&csio->sense_data, SSD_FULL_SIZE);
2365	bcopy(mc->mc_packet, &csio->sense_data, mc->mc_sense);
2366	csio->sense_len = mc->mc_sense;
2367	csio->ccb_h.status |= CAM_AUTOSNS_VALID;
2368	csio->resid = mc->mc_resid;	/* XXX this is a signed value... */
2369	break;
2370
2371    case SCSI_STATUS_BUSY:
2372	debug(1, "SCSI_STATUS_BUSY");
2373	csio->ccb_h.status = CAM_SCSI_BUSY;
2374	break;
2375
2376    default:
2377	debug(1, "unknown status 0x%x", csio->scsi_status);
2378	csio->ccb_h.status = CAM_REQ_CMP_ERR;
2379	break;
2380    }
2381
2382    s = splcam();
2383    if (sc->mly_qfrzn_cnt) {
2384	csio->ccb_h.status |= CAM_RELEASE_SIMQ;
2385	sc->mly_qfrzn_cnt--;
2386    }
2387    splx(s);
2388
2389    xpt_done((union ccb *)csio);
2390    mly_release_command(mc);
2391}
2392
2393/********************************************************************************
2394 * Find a peripheral attahed at (bus),(target)
2395 */
2396static struct cam_periph *
2397mly_find_periph(struct mly_softc *sc, int bus, int target)
2398{
2399    struct cam_periph	*periph;
2400    struct cam_path	*path;
2401    int			status;
2402
2403    status = xpt_create_path(&path, NULL, cam_sim_path(sc->mly_cam_sim[bus]), target, 0);
2404    if (status == CAM_REQ_CMP) {
2405	periph = cam_periph_find(path, NULL);
2406	xpt_free_path(path);
2407    } else {
2408	periph = NULL;
2409    }
2410    return(periph);
2411}
2412
2413/********************************************************************************
2414 * Name the device at (bus)(target)
2415 */
2416static int
2417mly_name_device(struct mly_softc *sc, int bus, int target)
2418{
2419    struct cam_periph	*periph;
2420
2421    if ((periph = mly_find_periph(sc, bus, target)) != NULL) {
2422	sprintf(sc->mly_btl[bus][target].mb_name, "%s%d", periph->periph_name, periph->unit_number);
2423	return(0);
2424    }
2425    sc->mly_btl[bus][target].mb_name[0] = 0;
2426    return(ENOENT);
2427}
2428
2429/********************************************************************************
2430 ********************************************************************************
2431                                                                 Hardware Control
2432 ********************************************************************************
2433 ********************************************************************************/
2434
2435/********************************************************************************
2436 * Handshake with the firmware while the card is being initialised.
2437 */
2438static int
2439mly_fwhandshake(struct mly_softc *sc)
2440{
2441    u_int8_t	error, param0, param1;
2442    int		spinup = 0;
2443
2444    debug_called(1);
2445
2446    /* set HM_STSACK and let the firmware initialise */
2447    MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_STSACK);
2448    DELAY(1000);	/* too short? */
2449
2450    /* if HM_STSACK is still true, the controller is initialising */
2451    if (!MLY_IDBR_TRUE(sc, MLY_HM_STSACK))
2452	return(0);
2453    mly_printf(sc, "controller initialisation started\n");
2454
2455    /* spin waiting for initialisation to finish, or for a message to be delivered */
2456    while (MLY_IDBR_TRUE(sc, MLY_HM_STSACK)) {
2457	/* check for a message */
2458	if (MLY_ERROR_VALID(sc)) {
2459	    error = MLY_GET_REG(sc, sc->mly_error_status) & ~MLY_MSG_EMPTY;
2460	    param0 = MLY_GET_REG(sc, sc->mly_command_mailbox);
2461	    param1 = MLY_GET_REG(sc, sc->mly_command_mailbox + 1);
2462
2463	    switch(error) {
2464	    case MLY_MSG_SPINUP:
2465		if (!spinup) {
2466		    mly_printf(sc, "drive spinup in progress\n");
2467		    spinup = 1;			/* only print this once (should print drive being spun?) */
2468		}
2469		break;
2470	    case MLY_MSG_RACE_RECOVERY_FAIL:
2471		mly_printf(sc, "mirror race recovery failed, one or more drives offline\n");
2472		break;
2473	    case MLY_MSG_RACE_IN_PROGRESS:
2474		mly_printf(sc, "mirror race recovery in progress\n");
2475		break;
2476	    case MLY_MSG_RACE_ON_CRITICAL:
2477		mly_printf(sc, "mirror race recovery on a critical drive\n");
2478		break;
2479	    case MLY_MSG_PARITY_ERROR:
2480		mly_printf(sc, "FATAL MEMORY PARITY ERROR\n");
2481		return(ENXIO);
2482	    default:
2483		mly_printf(sc, "unknown initialisation code 0x%x\n", error);
2484	    }
2485	}
2486    }
2487    return(0);
2488}
2489
2490/********************************************************************************
2491 ********************************************************************************
2492                                                        Debugging and Diagnostics
2493 ********************************************************************************
2494 ********************************************************************************/
2495
2496/********************************************************************************
2497 * Print some information about the controller.
2498 */
2499static void
2500mly_describe_controller(struct mly_softc *sc)
2501{
2502    struct mly_ioctl_getcontrollerinfo	*mi = sc->mly_controllerinfo;
2503
2504    mly_printf(sc, "%16s, %d channel%s, firmware %d.%02d-%d-%02d (%02d%02d%02d%02d), %dMB RAM\n",
2505	       mi->controller_name, mi->physical_channels_present, (mi->physical_channels_present) > 1 ? "s" : "",
2506	       mi->fw_major, mi->fw_minor, mi->fw_turn, mi->fw_build,	/* XXX turn encoding? */
2507	       mi->fw_century, mi->fw_year, mi->fw_month, mi->fw_day,
2508	       mi->memory_size);
2509
2510    if (bootverbose) {
2511	mly_printf(sc, "%s %s (%x), %dMHz %d-bit %.16s\n",
2512		   mly_describe_code(mly_table_oemname, mi->oem_information),
2513		   mly_describe_code(mly_table_controllertype, mi->controller_type), mi->controller_type,
2514		   mi->interface_speed, mi->interface_width, mi->interface_name);
2515	mly_printf(sc, "%dMB %dMHz %d-bit %s%s%s, cache %dMB\n",
2516		   mi->memory_size, mi->memory_speed, mi->memory_width,
2517		   mly_describe_code(mly_table_memorytype, mi->memory_type),
2518		   mi->memory_parity ? "+parity": "",mi->memory_ecc ? "+ECC": "",
2519		   mi->cache_size);
2520	mly_printf(sc, "CPU: %s @ %dMHZ\n",
2521		   mly_describe_code(mly_table_cputype, mi->cpu[0].type), mi->cpu[0].speed);
2522	if (mi->l2cache_size != 0)
2523	    mly_printf(sc, "%dKB L2 cache\n", mi->l2cache_size);
2524	if (mi->exmemory_size != 0)
2525	    mly_printf(sc, "%dMB %dMHz %d-bit private %s%s%s\n",
2526		       mi->exmemory_size, mi->exmemory_speed, mi->exmemory_width,
2527		       mly_describe_code(mly_table_memorytype, mi->exmemory_type),
2528		       mi->exmemory_parity ? "+parity": "",mi->exmemory_ecc ? "+ECC": "");
2529	mly_printf(sc, "battery backup %s\n", mi->bbu_present ? "present" : "not installed");
2530	mly_printf(sc, "maximum data transfer %d blocks, maximum sg entries/command %d\n",
2531		   mi->maximum_block_count, mi->maximum_sg_entries);
2532	mly_printf(sc, "logical devices present/critical/offline %d/%d/%d\n",
2533		   mi->logical_devices_present, mi->logical_devices_critical, mi->logical_devices_offline);
2534	mly_printf(sc, "physical devices present %d\n",
2535		   mi->physical_devices_present);
2536	mly_printf(sc, "physical disks present/offline %d/%d\n",
2537		   mi->physical_disks_present, mi->physical_disks_offline);
2538	mly_printf(sc, "%d physical channel%s, %d virtual channel%s of %d possible\n",
2539		   mi->physical_channels_present, mi->physical_channels_present == 1 ? "" : "s",
2540		   mi->virtual_channels_present, mi->virtual_channels_present == 1 ? "" : "s",
2541		   mi->virtual_channels_possible);
2542	mly_printf(sc, "%d parallel commands supported\n", mi->maximum_parallel_commands);
2543	mly_printf(sc, "%dMB flash ROM, %d of %d maximum cycles\n",
2544		   mi->flash_size, mi->flash_age, mi->flash_maximum_age);
2545    }
2546}
2547
2548#ifdef MLY_DEBUG
2549/********************************************************************************
2550 * Print some controller state
2551 */
2552static void
2553mly_printstate(struct mly_softc *sc)
2554{
2555    mly_printf(sc, "IDBR %02x  ODBR %02x  ERROR %02x  (%x %x %x)\n",
2556		  MLY_GET_REG(sc, sc->mly_idbr),
2557		  MLY_GET_REG(sc, sc->mly_odbr),
2558		  MLY_GET_REG(sc, sc->mly_error_status),
2559		  sc->mly_idbr,
2560		  sc->mly_odbr,
2561		  sc->mly_error_status);
2562    mly_printf(sc, "IMASK %02x  ISTATUS %02x\n",
2563		  MLY_GET_REG(sc, sc->mly_interrupt_mask),
2564		  MLY_GET_REG(sc, sc->mly_interrupt_status));
2565    mly_printf(sc, "COMMAND %02x %02x %02x %02x %02x %02x %02x %02x\n",
2566		  MLY_GET_REG(sc, sc->mly_command_mailbox),
2567		  MLY_GET_REG(sc, sc->mly_command_mailbox + 1),
2568		  MLY_GET_REG(sc, sc->mly_command_mailbox + 2),
2569		  MLY_GET_REG(sc, sc->mly_command_mailbox + 3),
2570		  MLY_GET_REG(sc, sc->mly_command_mailbox + 4),
2571		  MLY_GET_REG(sc, sc->mly_command_mailbox + 5),
2572		  MLY_GET_REG(sc, sc->mly_command_mailbox + 6),
2573		  MLY_GET_REG(sc, sc->mly_command_mailbox + 7));
2574    mly_printf(sc, "STATUS  %02x %02x %02x %02x %02x %02x %02x %02x\n",
2575		  MLY_GET_REG(sc, sc->mly_status_mailbox),
2576		  MLY_GET_REG(sc, sc->mly_status_mailbox + 1),
2577		  MLY_GET_REG(sc, sc->mly_status_mailbox + 2),
2578		  MLY_GET_REG(sc, sc->mly_status_mailbox + 3),
2579		  MLY_GET_REG(sc, sc->mly_status_mailbox + 4),
2580		  MLY_GET_REG(sc, sc->mly_status_mailbox + 5),
2581		  MLY_GET_REG(sc, sc->mly_status_mailbox + 6),
2582		  MLY_GET_REG(sc, sc->mly_status_mailbox + 7));
2583    mly_printf(sc, "        %04x        %08x\n",
2584		  MLY_GET_REG2(sc, sc->mly_status_mailbox),
2585		  MLY_GET_REG4(sc, sc->mly_status_mailbox + 4));
2586}
2587
2588struct mly_softc	*mly_softc0 = NULL;
2589void
2590mly_printstate0(void)
2591{
2592    if (mly_softc0 != NULL)
2593	mly_printstate(mly_softc0);
2594}
2595
2596/********************************************************************************
2597 * Print a command
2598 */
2599static void
2600mly_print_command(struct mly_command *mc)
2601{
2602    struct mly_softc	*sc = mc->mc_sc;
2603
2604    mly_printf(sc, "COMMAND @ %p\n", mc);
2605    mly_printf(sc, "  slot      %d\n", mc->mc_slot);
2606    mly_printf(sc, "  status    0x%x\n", mc->mc_status);
2607    mly_printf(sc, "  sense len %d\n", mc->mc_sense);
2608    mly_printf(sc, "  resid     %d\n", mc->mc_resid);
2609    mly_printf(sc, "  packet    %p/0x%llx\n", mc->mc_packet, mc->mc_packetphys);
2610    if (mc->mc_packet != NULL)
2611	mly_print_packet(mc);
2612    mly_printf(sc, "  data      %p/%d\n", mc->mc_data, mc->mc_length);
2613    mly_printf(sc, "  flags     %b\n", mc->mc_flags, "\20\1busy\2complete\3slotted\4mapped\5datain\6dataout\n");
2614    mly_printf(sc, "  complete  %p\n", mc->mc_complete);
2615    mly_printf(sc, "  private   %p\n", mc->mc_private);
2616}
2617
2618/********************************************************************************
2619 * Print a command packet
2620 */
2621static void
2622mly_print_packet(struct mly_command *mc)
2623{
2624    struct mly_softc			*sc = mc->mc_sc;
2625    struct mly_command_generic		*ge = (struct mly_command_generic *)mc->mc_packet;
2626    struct mly_command_scsi_small	*ss = (struct mly_command_scsi_small *)mc->mc_packet;
2627    struct mly_command_scsi_large	*sl = (struct mly_command_scsi_large *)mc->mc_packet;
2628    struct mly_command_ioctl		*io = (struct mly_command_ioctl *)mc->mc_packet;
2629    int					transfer;
2630
2631    mly_printf(sc, "   command_id           %d\n", ge->command_id);
2632    mly_printf(sc, "   opcode               %d\n", ge->opcode);
2633    mly_printf(sc, "   command_control      fua %d  dpo %d  est %d  dd %s  nas %d ddis %d\n",
2634		  ge->command_control.force_unit_access,
2635		  ge->command_control.disable_page_out,
2636		  ge->command_control.extended_sg_table,
2637		  (ge->command_control.data_direction == MLY_CCB_WRITE) ? "WRITE" : "READ",
2638		  ge->command_control.no_auto_sense,
2639		  ge->command_control.disable_disconnect);
2640    mly_printf(sc, "   data_size            %d\n", ge->data_size);
2641    mly_printf(sc, "   sense_buffer_address 0x%llx\n", ge->sense_buffer_address);
2642    mly_printf(sc, "   lun                  %d\n", ge->addr.phys.lun);
2643    mly_printf(sc, "   target               %d\n", ge->addr.phys.target);
2644    mly_printf(sc, "   channel              %d\n", ge->addr.phys.channel);
2645    mly_printf(sc, "   logical device       %d\n", ge->addr.log.logdev);
2646    mly_printf(sc, "   controller           %d\n", ge->addr.phys.controller);
2647    mly_printf(sc, "   timeout              %d %s\n",
2648		  ge->timeout.value,
2649		  (ge->timeout.scale == MLY_TIMEOUT_SECONDS) ? "seconds" :
2650		  ((ge->timeout.scale == MLY_TIMEOUT_MINUTES) ? "minutes" : "hours"));
2651    mly_printf(sc, "   maximum_sense_size   %d\n", ge->maximum_sense_size);
2652    switch(ge->opcode) {
2653    case MDACMD_SCSIPT:
2654    case MDACMD_SCSI:
2655	mly_printf(sc, "   cdb length           %d\n", ss->cdb_length);
2656	mly_printf(sc, "   cdb                  %*D\n", ss->cdb_length, ss->cdb, " ");
2657	transfer = 1;
2658	break;
2659    case MDACMD_SCSILC:
2660    case MDACMD_SCSILCPT:
2661	mly_printf(sc, "   cdb length           %d\n", sl->cdb_length);
2662	mly_printf(sc, "   cdb                  0x%llx\n", sl->cdb_physaddr);
2663	transfer = 1;
2664	break;
2665    case MDACMD_IOCTL:
2666	mly_printf(sc, "   sub_ioctl            0x%x\n", io->sub_ioctl);
2667	switch(io->sub_ioctl) {
2668	case MDACIOCTL_SETMEMORYMAILBOX:
2669	    mly_printf(sc, "   health_buffer_size   %d\n",
2670			  io->param.setmemorymailbox.health_buffer_size);
2671	    mly_printf(sc, "   health_buffer_phys   0x%llx\n",
2672			  io->param.setmemorymailbox.health_buffer_physaddr);
2673	    mly_printf(sc, "   command_mailbox      0x%llx\n",
2674			  io->param.setmemorymailbox.command_mailbox_physaddr);
2675	    mly_printf(sc, "   status_mailbox       0x%llx\n",
2676			  io->param.setmemorymailbox.status_mailbox_physaddr);
2677	    transfer = 0;
2678	    break;
2679
2680	case MDACIOCTL_SETREALTIMECLOCK:
2681	case MDACIOCTL_GETHEALTHSTATUS:
2682	case MDACIOCTL_GETCONTROLLERINFO:
2683	case MDACIOCTL_GETLOGDEVINFOVALID:
2684	case MDACIOCTL_GETPHYSDEVINFOVALID:
2685	case MDACIOCTL_GETPHYSDEVSTATISTICS:
2686	case MDACIOCTL_GETLOGDEVSTATISTICS:
2687	case MDACIOCTL_GETCONTROLLERSTATISTICS:
2688	case MDACIOCTL_GETBDT_FOR_SYSDRIVE:
2689	case MDACIOCTL_CREATENEWCONF:
2690	case MDACIOCTL_ADDNEWCONF:
2691	case MDACIOCTL_GETDEVCONFINFO:
2692	case MDACIOCTL_GETFREESPACELIST:
2693	case MDACIOCTL_MORE:
2694	case MDACIOCTL_SETPHYSDEVPARAMETER:
2695	case MDACIOCTL_GETPHYSDEVPARAMETER:
2696	case MDACIOCTL_GETLOGDEVPARAMETER:
2697	case MDACIOCTL_SETLOGDEVPARAMETER:
2698	    mly_printf(sc, "   param                %10D\n", io->param.data.param, " ");
2699	    transfer = 1;
2700	    break;
2701
2702	case MDACIOCTL_GETEVENT:
2703	    mly_printf(sc, "   event                %d\n",
2704		       io->param.getevent.sequence_number_low + ((u_int32_t)io->addr.log.logdev << 16));
2705	    transfer = 1;
2706	    break;
2707
2708	case MDACIOCTL_SETRAIDDEVSTATE:
2709	    mly_printf(sc, "   state                %d\n", io->param.setraiddevstate.state);
2710	    transfer = 0;
2711	    break;
2712
2713	case MDACIOCTL_XLATEPHYSDEVTORAIDDEV:
2714	    mly_printf(sc, "   raid_device          %d\n", io->param.xlatephysdevtoraiddev.raid_device);
2715	    mly_printf(sc, "   controller           %d\n", io->param.xlatephysdevtoraiddev.controller);
2716	    mly_printf(sc, "   channel              %d\n", io->param.xlatephysdevtoraiddev.channel);
2717	    mly_printf(sc, "   target               %d\n", io->param.xlatephysdevtoraiddev.target);
2718	    mly_printf(sc, "   lun                  %d\n", io->param.xlatephysdevtoraiddev.lun);
2719	    transfer = 0;
2720	    break;
2721
2722	case MDACIOCTL_GETGROUPCONFINFO:
2723	    mly_printf(sc, "   group                %d\n", io->param.getgroupconfinfo.group);
2724	    transfer = 1;
2725	    break;
2726
2727	case MDACIOCTL_GET_SUBSYSTEM_DATA:
2728	case MDACIOCTL_SET_SUBSYSTEM_DATA:
2729	case MDACIOCTL_STARTDISOCVERY:
2730	case MDACIOCTL_INITPHYSDEVSTART:
2731	case MDACIOCTL_INITPHYSDEVSTOP:
2732	case MDACIOCTL_INITRAIDDEVSTART:
2733	case MDACIOCTL_INITRAIDDEVSTOP:
2734	case MDACIOCTL_REBUILDRAIDDEVSTART:
2735	case MDACIOCTL_REBUILDRAIDDEVSTOP:
2736	case MDACIOCTL_MAKECONSISTENTDATASTART:
2737	case MDACIOCTL_MAKECONSISTENTDATASTOP:
2738	case MDACIOCTL_CONSISTENCYCHECKSTART:
2739	case MDACIOCTL_CONSISTENCYCHECKSTOP:
2740	case MDACIOCTL_RESETDEVICE:
2741	case MDACIOCTL_FLUSHDEVICEDATA:
2742	case MDACIOCTL_PAUSEDEVICE:
2743	case MDACIOCTL_UNPAUSEDEVICE:
2744	case MDACIOCTL_LOCATEDEVICE:
2745	case MDACIOCTL_SETMASTERSLAVEMODE:
2746	case MDACIOCTL_DELETERAIDDEV:
2747	case MDACIOCTL_REPLACEINTERNALDEV:
2748	case MDACIOCTL_CLEARCONF:
2749	case MDACIOCTL_GETCONTROLLERPARAMETER:
2750	case MDACIOCTL_SETCONTRLLERPARAMETER:
2751	case MDACIOCTL_CLEARCONFSUSPMODE:
2752	case MDACIOCTL_STOREIMAGE:
2753	case MDACIOCTL_READIMAGE:
2754	case MDACIOCTL_FLASHIMAGES:
2755	case MDACIOCTL_RENAMERAIDDEV:
2756	default:			/* no idea what to print */
2757	    transfer = 0;
2758	    break;
2759	}
2760	break;
2761
2762    case MDACMD_IOCTLCHECK:
2763    case MDACMD_MEMCOPY:
2764    default:
2765	transfer = 0;
2766	break;	/* print nothing */
2767    }
2768    if (transfer) {
2769	if (ge->command_control.extended_sg_table) {
2770	    mly_printf(sc, "   sg table             0x%llx/%d\n",
2771			  ge->transfer.indirect.table_physaddr[0], ge->transfer.indirect.entries[0]);
2772	} else {
2773	    mly_printf(sc, "   0000                 0x%llx/%lld\n",
2774			  ge->transfer.direct.sg[0].physaddr, ge->transfer.direct.sg[0].length);
2775	    mly_printf(sc, "   0001                 0x%llx/%lld\n",
2776			  ge->transfer.direct.sg[1].physaddr, ge->transfer.direct.sg[1].length);
2777	}
2778    }
2779}
2780
2781/********************************************************************************
2782 * Panic in a slightly informative fashion
2783 */
2784static void
2785mly_panic(struct mly_softc *sc, char *reason)
2786{
2787    mly_printstate(sc);
2788    panic(reason);
2789}
2790
2791/********************************************************************************
2792 * Print queue statistics, callable from DDB.
2793 */
2794void
2795mly_print_controller(int controller)
2796{
2797    struct mly_softc	*sc;
2798
2799    if ((sc = devclass_get_softc(devclass_find("mly"), controller)) == NULL) {
2800	printf("mly: controller %d invalid\n", controller);
2801    } else {
2802	device_printf(sc->mly_dev, "queue    curr max\n");
2803	device_printf(sc->mly_dev, "free     %04d/%04d\n",
2804		      sc->mly_qstat[MLYQ_FREE].q_length, sc->mly_qstat[MLYQ_FREE].q_max);
2805	device_printf(sc->mly_dev, "busy     %04d/%04d\n",
2806		      sc->mly_qstat[MLYQ_BUSY].q_length, sc->mly_qstat[MLYQ_BUSY].q_max);
2807	device_printf(sc->mly_dev, "complete %04d/%04d\n",
2808		      sc->mly_qstat[MLYQ_COMPLETE].q_length, sc->mly_qstat[MLYQ_COMPLETE].q_max);
2809    }
2810}
2811#endif
2812
2813
2814/********************************************************************************
2815 ********************************************************************************
2816                                                         Control device interface
2817 ********************************************************************************
2818 ********************************************************************************/
2819
2820/********************************************************************************
2821 * Accept an open operation on the control device.
2822 */
2823static int
2824mly_user_open(struct cdev *dev, int flags, int fmt, struct thread *td)
2825{
2826    int			unit = minor(dev);
2827    struct mly_softc	*sc = devclass_get_softc(devclass_find("mly"), unit);
2828
2829    sc->mly_state |= MLY_STATE_OPEN;
2830    return(0);
2831}
2832
2833/********************************************************************************
2834 * Accept the last close on the control device.
2835 */
2836static int
2837mly_user_close(struct cdev *dev, int flags, int fmt, struct thread *td)
2838{
2839    int			unit = minor(dev);
2840    struct mly_softc	*sc = devclass_get_softc(devclass_find("mly"), unit);
2841
2842    sc->mly_state &= ~MLY_STATE_OPEN;
2843    return (0);
2844}
2845
2846/********************************************************************************
2847 * Handle controller-specific control operations.
2848 */
2849static int
2850mly_user_ioctl(struct cdev *dev, u_long cmd, caddr_t addr,
2851				int32_t flag, struct thread *td)
2852{
2853    struct mly_softc		*sc = (struct mly_softc *)dev->si_drv1;
2854    struct mly_user_command	*uc = (struct mly_user_command *)addr;
2855    struct mly_user_health	*uh = (struct mly_user_health *)addr;
2856
2857    switch(cmd) {
2858    case MLYIO_COMMAND:
2859	return(mly_user_command(sc, uc));
2860    case MLYIO_HEALTH:
2861	return(mly_user_health(sc, uh));
2862    default:
2863	return(ENOIOCTL);
2864    }
2865}
2866
2867/********************************************************************************
2868 * Execute a command passed in from userspace.
2869 *
2870 * The control structure contains the actual command for the controller, as well
2871 * as the user-space data pointer and data size, and an optional sense buffer
2872 * size/pointer.  On completion, the data size is adjusted to the command
2873 * residual, and the sense buffer size to the size of the returned sense data.
2874 *
2875 */
2876static int
2877mly_user_command(struct mly_softc *sc, struct mly_user_command *uc)
2878{
2879    struct mly_command	*mc;
2880    int			error, s;
2881
2882    /* allocate a command */
2883    if (mly_alloc_command(sc, &mc)) {
2884	error = ENOMEM;
2885	goto out;		/* XXX Linux version will wait for a command */
2886    }
2887
2888    /* handle data size/direction */
2889    mc->mc_length = (uc->DataTransferLength >= 0) ? uc->DataTransferLength : -uc->DataTransferLength;
2890    if (mc->mc_length > 0) {
2891	if ((mc->mc_data = malloc(mc->mc_length, M_DEVBUF, M_NOWAIT)) == NULL) {
2892	    error = ENOMEM;
2893	    goto out;
2894	}
2895    }
2896    if (uc->DataTransferLength > 0) {
2897	mc->mc_flags |= MLY_CMD_DATAIN;
2898	bzero(mc->mc_data, mc->mc_length);
2899    }
2900    if (uc->DataTransferLength < 0) {
2901	mc->mc_flags |= MLY_CMD_DATAOUT;
2902	if ((error = copyin(uc->DataTransferBuffer, mc->mc_data, mc->mc_length)) != 0)
2903	    goto out;
2904    }
2905
2906    /* copy the controller command */
2907    bcopy(&uc->CommandMailbox, mc->mc_packet, sizeof(uc->CommandMailbox));
2908
2909    /* clear command completion handler so that we get woken up */
2910    mc->mc_complete = NULL;
2911
2912    /* execute the command */
2913    if ((error = mly_start(mc)) != 0)
2914	goto out;
2915    s = splcam();
2916    while (!(mc->mc_flags & MLY_CMD_COMPLETE))
2917	tsleep(mc, PRIBIO, "mlyioctl", 0);
2918    splx(s);
2919
2920    /* return the data to userspace */
2921    if (uc->DataTransferLength > 0)
2922	if ((error = copyout(mc->mc_data, uc->DataTransferBuffer, mc->mc_length)) != 0)
2923	    goto out;
2924
2925    /* return the sense buffer to userspace */
2926    if ((uc->RequestSenseLength > 0) && (mc->mc_sense > 0)) {
2927	if ((error = copyout(mc->mc_packet, uc->RequestSenseBuffer,
2928			     min(uc->RequestSenseLength, mc->mc_sense))) != 0)
2929	    goto out;
2930    }
2931
2932    /* return command results to userspace (caller will copy out) */
2933    uc->DataTransferLength = mc->mc_resid;
2934    uc->RequestSenseLength = min(uc->RequestSenseLength, mc->mc_sense);
2935    uc->CommandStatus = mc->mc_status;
2936    error = 0;
2937
2938 out:
2939    if (mc->mc_data != NULL)
2940	free(mc->mc_data, M_DEVBUF);
2941    if (mc != NULL)
2942	mly_release_command(mc);
2943    return(error);
2944}
2945
2946/********************************************************************************
2947 * Return health status to userspace.  If the health change index in the user
2948 * structure does not match that currently exported by the controller, we
2949 * return the current status immediately.  Otherwise, we block until either
2950 * interrupted or new status is delivered.
2951 */
2952static int
2953mly_user_health(struct mly_softc *sc, struct mly_user_health *uh)
2954{
2955    struct mly_health_status		mh;
2956    int					error, s;
2957
2958    /* fetch the current health status from userspace */
2959    if ((error = copyin(uh->HealthStatusBuffer, &mh, sizeof(mh))) != 0)
2960	return(error);
2961
2962    /* spin waiting for a status update */
2963    s = splcam();
2964    error = EWOULDBLOCK;
2965    while ((error != 0) && (sc->mly_event_change == mh.change_counter))
2966	error = tsleep(&sc->mly_event_change, PRIBIO | PCATCH, "mlyhealth", 0);
2967    splx(s);
2968
2969    /* copy the controller's health status buffer out (there is a race here if it changes again) */
2970    error = copyout(&sc->mly_mmbox->mmm_health.status, uh->HealthStatusBuffer,
2971		    sizeof(uh->HealthStatusBuffer));
2972    return(error);
2973}
2974
2975static int
2976mly_timeout(struct mly_softc *sc)
2977{
2978	struct mly_command *mc;
2979	int deadline;
2980
2981	deadline = time_second - MLY_CMD_TIMEOUT;
2982	TAILQ_FOREACH(mc, &sc->mly_busy, mc_link) {
2983		if ((mc->mc_timestamp < deadline)) {
2984			device_printf(sc->mly_dev,
2985			    "COMMAND %p TIMEOUT AFTER %d SECONDS\n", mc,
2986			    (int)(time_second - mc->mc_timestamp));
2987		}
2988	}
2989
2990	timeout((timeout_t *)mly_timeout, sc, MLY_CMD_TIMEOUT * hz);
2991
2992	return (0);
2993}
2994