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