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