2 * Copyright (c) 2000, 2001 Michael Smith
3 * Copyright (c) 2000 BSDi
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/malloc.h>
33 #include <sys/kernel.h>
36 #include <sys/ctype.h>
37 #include <sys/ioccom.h>
40 #include <machine/bus.h>
41 #include <machine/resource.h>
45 #include <cam/cam_ccb.h>
46 #include <cam/cam_periph.h>
47 #include <cam/cam_sim.h>
48 #include <cam/cam_xpt_sim.h>
49 #include <cam/scsi/scsi_all.h>
50 #include <cam/scsi/scsi_message.h>
52 #include <dev/pci/pcireg.h>
53 #include <dev/pci/pcivar.h>
55 #include <dev/mly/mlyreg.h>
56 #include <dev/mly/mlyio.h>
57 #include <dev/mly/mlyvar.h>
58 #include <dev/mly/mly_tables.h>
60 static int mly_probe(device_t dev);
61 static int mly_attach(device_t dev);
62 static int mly_pci_attach(struct mly_softc *sc);
63 static int mly_detach(device_t dev);
64 static int mly_shutdown(device_t dev);
65 static void mly_intr(void *arg);
67 static int mly_sg_map(struct mly_softc *sc);
68 static void mly_sg_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error);
69 static int mly_mmbox_map(struct mly_softc *sc);
70 static void mly_mmbox_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error);
71 static void mly_free(struct mly_softc *sc);
73 static int mly_get_controllerinfo(struct mly_softc *sc);
74 static void mly_scan_devices(struct mly_softc *sc);
75 static void mly_rescan_btl(struct mly_softc *sc, int bus, int target);
76 static void mly_complete_rescan(struct mly_command *mc);
77 static int mly_get_eventstatus(struct mly_softc *sc);
78 static int mly_enable_mmbox(struct mly_softc *sc);
79 static int mly_flush(struct mly_softc *sc);
80 static int mly_ioctl(struct mly_softc *sc, struct mly_command_ioctl *ioctl, void **data,
81 size_t datasize, u_int8_t *status, void *sense_buffer, size_t *sense_length);
82 static void mly_check_event(struct mly_softc *sc);
83 static void mly_fetch_event(struct mly_softc *sc);
84 static void mly_complete_event(struct mly_command *mc);
85 static void mly_process_event(struct mly_softc *sc, struct mly_event *me);
86 static void mly_periodic(void *data);
88 static int mly_immediate_command(struct mly_command *mc);
89 static int mly_start(struct mly_command *mc);
90 static void mly_done(struct mly_softc *sc);
91 static void mly_complete(void *context, int pending);
93 static int mly_alloc_command(struct mly_softc *sc, struct mly_command **mcp);
94 static void mly_release_command(struct mly_command *mc);
95 static void mly_alloc_commands_map(void *arg, bus_dma_segment_t *segs, int nseg, int error);
96 static int mly_alloc_commands(struct mly_softc *sc);
97 static void mly_release_commands(struct mly_softc *sc);
98 static void mly_map_command(struct mly_command *mc);
99 static void mly_unmap_command(struct mly_command *mc);
101 static int mly_cam_attach(struct mly_softc *sc);
102 static void mly_cam_detach(struct mly_softc *sc);
103 static void mly_cam_rescan_btl(struct mly_softc *sc, int bus, int target);
104 static void mly_cam_action(struct cam_sim *sim, union ccb *ccb);
105 static int mly_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio);
106 static void mly_cam_poll(struct cam_sim *sim);
107 static void mly_cam_complete(struct mly_command *mc);
108 static struct cam_periph *mly_find_periph(struct mly_softc *sc, int bus, int target);
109 static int mly_name_device(struct mly_softc *sc, int bus, int target);
111 static int mly_fwhandshake(struct mly_softc *sc);
113 static void mly_describe_controller(struct mly_softc *sc);
115 static void mly_printstate(struct mly_softc *sc);
116 static void mly_print_command(struct mly_command *mc);
117 static void mly_print_packet(struct mly_command *mc);
118 static void mly_panic(struct mly_softc *sc, char *reason);
119 static int mly_timeout(struct mly_softc *sc);
121 void mly_print_controller(int controller);
124 static d_open_t mly_user_open;
125 static d_close_t mly_user_close;
126 static d_ioctl_t mly_user_ioctl;
127 static int mly_user_command(struct mly_softc *sc, struct mly_user_command *uc);
128 static int mly_user_health(struct mly_softc *sc, struct mly_user_health *uh);
130 #define MLY_CMD_TIMEOUT 20
132 static device_method_t mly_methods[] = {
133 /* Device interface */
134 DEVMETHOD(device_probe, mly_probe),
135 DEVMETHOD(device_attach, mly_attach),
136 DEVMETHOD(device_detach, mly_detach),
137 DEVMETHOD(device_shutdown, mly_shutdown),
141 static driver_t mly_pci_driver = {
144 sizeof(struct mly_softc)
147 static devclass_t mly_devclass;
148 DRIVER_MODULE(mly, pci, mly_pci_driver, mly_devclass, 0, 0);
149 MODULE_DEPEND(mly, pci, 1, 1, 1);
150 MODULE_DEPEND(mly, cam, 1, 1, 1);
152 static struct cdevsw mly_cdevsw = {
153 .d_version = D_VERSION,
154 .d_flags = D_NEEDGIANT,
155 .d_open = mly_user_open,
156 .d_close = mly_user_close,
157 .d_ioctl = mly_user_ioctl,
161 /********************************************************************************
162 ********************************************************************************
164 ********************************************************************************
165 ********************************************************************************/
167 static struct mly_ident
175 } mly_identifiers[] = {
176 {0x1069, 0xba56, 0x1069, 0x0040, MLY_HWIF_STRONGARM, "Mylex eXtremeRAID 2000"},
177 {0x1069, 0xba56, 0x1069, 0x0030, MLY_HWIF_STRONGARM, "Mylex eXtremeRAID 3000"},
178 {0x1069, 0x0050, 0x1069, 0x0050, MLY_HWIF_I960RX, "Mylex AcceleRAID 352"},
179 {0x1069, 0x0050, 0x1069, 0x0052, MLY_HWIF_I960RX, "Mylex AcceleRAID 170"},
180 {0x1069, 0x0050, 0x1069, 0x0054, MLY_HWIF_I960RX, "Mylex AcceleRAID 160"},
184 /********************************************************************************
185 * Compare the provided PCI device with the list we support.
188 mly_probe(device_t dev)
194 for (m = mly_identifiers; m->vendor != 0; m++) {
195 if ((m->vendor == pci_get_vendor(dev)) &&
196 (m->device == pci_get_device(dev)) &&
197 ((m->subvendor == 0) || ((m->subvendor == pci_get_subvendor(dev)) &&
198 (m->subdevice == pci_get_subdevice(dev))))) {
200 device_set_desc(dev, m->desc);
201 return(BUS_PROBE_DEFAULT); /* allow room to be overridden */
207 /********************************************************************************
208 * Initialise the controller and softc
211 mly_attach(device_t dev)
213 struct mly_softc *sc = device_get_softc(dev);
221 if (device_get_unit(sc->mly_dev) == 0)
226 * Do PCI-specific initialisation.
228 if ((error = mly_pci_attach(sc)) != 0)
232 * Initialise per-controller queues.
236 mly_initq_complete(sc);
239 * Initialise command-completion task.
241 TASK_INIT(&sc->mly_task_complete, 0, mly_complete, sc);
243 /* disable interrupts before we start talking to the controller */
244 MLY_MASK_INTERRUPTS(sc);
247 * Wait for the controller to come ready, handshake with the firmware if required.
248 * This is typically only necessary on platforms where the controller BIOS does not
251 if ((error = mly_fwhandshake(sc)))
255 * Allocate initial command buffers.
257 if ((error = mly_alloc_commands(sc)))
261 * Obtain controller feature information
263 if ((error = mly_get_controllerinfo(sc)))
267 * Reallocate command buffers now we know how many we want.
269 mly_release_commands(sc);
270 if ((error = mly_alloc_commands(sc)))
274 * Get the current event counter for health purposes, populate the initial
275 * health status buffer.
277 if ((error = mly_get_eventstatus(sc)))
281 * Enable memory-mailbox mode.
283 if ((error = mly_enable_mmbox(sc)))
289 if ((error = mly_cam_attach(sc)))
293 * Print a little information about the controller
295 mly_describe_controller(sc);
298 * Mark all attached devices for rescan.
300 mly_scan_devices(sc);
303 * Instigate the first status poll immediately. Rescan completions won't
304 * happen until interrupts are enabled, which should still be before
305 * the SCSI subsystem gets to us, courtesy of the "SCSI settling delay".
307 mly_periodic((void *)sc);
310 * Create the control device.
312 sc->mly_dev_t = make_dev(&mly_cdevsw, 0, UID_ROOT, GID_OPERATOR,
313 S_IRUSR | S_IWUSR, "mly%d", device_get_unit(sc->mly_dev));
314 sc->mly_dev_t->si_drv1 = sc;
316 /* enable interrupts now */
317 MLY_UNMASK_INTERRUPTS(sc);
320 timeout((timeout_t *)mly_timeout, sc, MLY_CMD_TIMEOUT * hz);
329 /********************************************************************************
330 * Perform PCI-specific initialisation.
333 mly_pci_attach(struct mly_softc *sc)
339 /* assume failure is 'not configured' */
343 * Verify that the adapter is correctly set up in PCI space.
345 pci_enable_busmaster(sc->mly_dev);
348 * Allocate the PCI register window.
350 sc->mly_regs_rid = PCIR_BAR(0); /* first base address register */
351 if ((sc->mly_regs_resource = bus_alloc_resource_any(sc->mly_dev,
352 SYS_RES_MEMORY, &sc->mly_regs_rid, RF_ACTIVE)) == NULL) {
353 mly_printf(sc, "can't allocate register window\n");
356 sc->mly_btag = rman_get_bustag(sc->mly_regs_resource);
357 sc->mly_bhandle = rman_get_bushandle(sc->mly_regs_resource);
360 * Allocate and connect our interrupt.
363 if ((sc->mly_irq = bus_alloc_resource_any(sc->mly_dev, SYS_RES_IRQ,
364 &sc->mly_irq_rid, RF_SHAREABLE | RF_ACTIVE)) == NULL) {
365 mly_printf(sc, "can't allocate interrupt\n");
368 if (bus_setup_intr(sc->mly_dev, sc->mly_irq, INTR_TYPE_CAM | INTR_ENTROPY, NULL, mly_intr, sc, &sc->mly_intr)) {
369 mly_printf(sc, "can't set up interrupt\n");
373 /* assume failure is 'out of memory' */
377 * Allocate the parent bus DMA tag appropriate for our PCI interface.
379 * Note that all of these controllers are 64-bit capable.
381 if (bus_dma_tag_create(bus_get_dma_tag(sc->mly_dev),/* PCI parent */
382 1, 0, /* alignment, boundary */
383 BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
384 BUS_SPACE_MAXADDR, /* highaddr */
385 NULL, NULL, /* filter, filterarg */
386 BUS_SPACE_MAXSIZE_32BIT, /* maxsize */
387 BUS_SPACE_UNRESTRICTED, /* nsegments */
388 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
389 BUS_DMA_ALLOCNOW, /* flags */
392 &sc->mly_parent_dmat)) {
393 mly_printf(sc, "can't allocate parent DMA tag\n");
398 * Create DMA tag for mapping buffers into controller-addressable space.
400 if (bus_dma_tag_create(sc->mly_parent_dmat, /* parent */
401 1, 0, /* alignment, boundary */
402 BUS_SPACE_MAXADDR, /* lowaddr */
403 BUS_SPACE_MAXADDR, /* highaddr */
404 NULL, NULL, /* filter, filterarg */
405 DFLTPHYS, /* maxsize */
406 MLY_MAX_SGENTRIES, /* nsegments */
407 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
409 busdma_lock_mutex, /* lockfunc */
410 &Giant, /* lockarg */
411 &sc->mly_buffer_dmat)) {
412 mly_printf(sc, "can't allocate buffer DMA tag\n");
417 * Initialise the DMA tag for command packets.
419 if (bus_dma_tag_create(sc->mly_parent_dmat, /* parent */
420 1, 0, /* alignment, boundary */
421 BUS_SPACE_MAXADDR, /* lowaddr */
422 BUS_SPACE_MAXADDR, /* highaddr */
423 NULL, NULL, /* filter, filterarg */
424 sizeof(union mly_command_packet) * MLY_MAX_COMMANDS, 1, /* maxsize, nsegments */
425 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
426 BUS_DMA_ALLOCNOW, /* flags */
427 NULL, NULL, /* lockfunc, lockarg */
428 &sc->mly_packet_dmat)) {
429 mly_printf(sc, "can't allocate command packet DMA tag\n");
434 * Detect the hardware interface version
436 for (i = 0; mly_identifiers[i].vendor != 0; i++) {
437 if ((mly_identifiers[i].vendor == pci_get_vendor(sc->mly_dev)) &&
438 (mly_identifiers[i].device == pci_get_device(sc->mly_dev))) {
439 sc->mly_hwif = mly_identifiers[i].hwif;
440 switch(sc->mly_hwif) {
441 case MLY_HWIF_I960RX:
442 debug(1, "set hardware up for i960RX");
443 sc->mly_doorbell_true = 0x00;
444 sc->mly_command_mailbox = MLY_I960RX_COMMAND_MAILBOX;
445 sc->mly_status_mailbox = MLY_I960RX_STATUS_MAILBOX;
446 sc->mly_idbr = MLY_I960RX_IDBR;
447 sc->mly_odbr = MLY_I960RX_ODBR;
448 sc->mly_error_status = MLY_I960RX_ERROR_STATUS;
449 sc->mly_interrupt_status = MLY_I960RX_INTERRUPT_STATUS;
450 sc->mly_interrupt_mask = MLY_I960RX_INTERRUPT_MASK;
452 case MLY_HWIF_STRONGARM:
453 debug(1, "set hardware up for StrongARM");
454 sc->mly_doorbell_true = 0xff; /* doorbell 'true' is 0 */
455 sc->mly_command_mailbox = MLY_STRONGARM_COMMAND_MAILBOX;
456 sc->mly_status_mailbox = MLY_STRONGARM_STATUS_MAILBOX;
457 sc->mly_idbr = MLY_STRONGARM_IDBR;
458 sc->mly_odbr = MLY_STRONGARM_ODBR;
459 sc->mly_error_status = MLY_STRONGARM_ERROR_STATUS;
460 sc->mly_interrupt_status = MLY_STRONGARM_INTERRUPT_STATUS;
461 sc->mly_interrupt_mask = MLY_STRONGARM_INTERRUPT_MASK;
469 * Create the scatter/gather mappings.
471 if ((error = mly_sg_map(sc)))
475 * Allocate and map the memory mailbox
477 if ((error = mly_mmbox_map(sc)))
486 /********************************************************************************
487 * Shut the controller down and detach all our resources.
490 mly_detach(device_t dev)
494 if ((error = mly_shutdown(dev)) != 0)
497 mly_free(device_get_softc(dev));
501 /********************************************************************************
502 * Bring the controller to a state where it can be safely left alone.
504 * Note that it should not be necessary to wait for any outstanding commands,
505 * as they should be completed prior to calling here.
507 * XXX this applies for I/O, but not status polls; we should beware of
508 * the case where a status command is running while we detach.
511 mly_shutdown(device_t dev)
513 struct mly_softc *sc = device_get_softc(dev);
517 if (sc->mly_state & MLY_STATE_OPEN)
520 /* kill the periodic event */
521 untimeout(mly_periodic, sc, sc->mly_periodic);
523 /* flush controller */
524 mly_printf(sc, "flushing cache...");
525 printf("%s\n", mly_flush(sc) ? "failed" : "done");
527 MLY_MASK_INTERRUPTS(sc);
532 /*******************************************************************************
533 * Take an interrupt, or be poked by other code to look for interrupt-worthy
539 struct mly_softc *sc = (struct mly_softc *)arg;
546 /********************************************************************************
547 ********************************************************************************
548 Bus-dependant Resource Management
549 ********************************************************************************
550 ********************************************************************************/
552 /********************************************************************************
553 * Allocate memory for the scatter/gather tables
556 mly_sg_map(struct mly_softc *sc)
563 * Create a single tag describing a region large enough to hold all of
564 * the s/g lists we will need.
566 segsize = sizeof(struct mly_sg_entry) * MLY_MAX_COMMANDS *MLY_MAX_SGENTRIES;
567 if (bus_dma_tag_create(sc->mly_parent_dmat, /* parent */
568 1, 0, /* alignment,boundary */
569 BUS_SPACE_MAXADDR, /* lowaddr */
570 BUS_SPACE_MAXADDR, /* highaddr */
571 NULL, NULL, /* filter, filterarg */
572 segsize, 1, /* maxsize, nsegments */
573 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
574 BUS_DMA_ALLOCNOW, /* flags */
575 NULL, NULL, /* lockfunc, lockarg */
577 mly_printf(sc, "can't allocate scatter/gather DMA tag\n");
582 * Allocate enough s/g maps for all commands and permanently map them into
583 * controller-visible space.
585 * XXX this assumes we can get enough space for all the s/g maps in one
588 if (bus_dmamem_alloc(sc->mly_sg_dmat, (void **)&sc->mly_sg_table,
589 BUS_DMA_NOWAIT, &sc->mly_sg_dmamap)) {
590 mly_printf(sc, "can't allocate s/g table\n");
593 if (bus_dmamap_load(sc->mly_sg_dmat, sc->mly_sg_dmamap, sc->mly_sg_table,
594 segsize, mly_sg_map_helper, sc, BUS_DMA_NOWAIT) != 0)
599 /********************************************************************************
600 * Save the physical address of the base of the s/g table.
603 mly_sg_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
605 struct mly_softc *sc = (struct mly_softc *)arg;
609 /* save base of s/g table's address in bus space */
610 sc->mly_sg_busaddr = segs->ds_addr;
613 /********************************************************************************
614 * Allocate memory for the memory-mailbox interface
617 mly_mmbox_map(struct mly_softc *sc)
621 * Create a DMA tag for a single contiguous region large enough for the
622 * memory mailbox structure.
624 if (bus_dma_tag_create(sc->mly_parent_dmat, /* parent */
625 1, 0, /* alignment,boundary */
626 BUS_SPACE_MAXADDR, /* lowaddr */
627 BUS_SPACE_MAXADDR, /* highaddr */
628 NULL, NULL, /* filter, filterarg */
629 sizeof(struct mly_mmbox), 1, /* maxsize, nsegments */
630 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
631 BUS_DMA_ALLOCNOW, /* flags */
632 NULL, NULL, /* lockfunc, lockarg */
633 &sc->mly_mmbox_dmat)) {
634 mly_printf(sc, "can't allocate memory mailbox DMA tag\n");
639 * Allocate the buffer
641 if (bus_dmamem_alloc(sc->mly_mmbox_dmat, (void **)&sc->mly_mmbox, BUS_DMA_NOWAIT, &sc->mly_mmbox_dmamap)) {
642 mly_printf(sc, "can't allocate memory mailbox\n");
645 if (bus_dmamap_load(sc->mly_mmbox_dmat, sc->mly_mmbox_dmamap, sc->mly_mmbox,
646 sizeof(struct mly_mmbox), mly_mmbox_map_helper, sc,
647 BUS_DMA_NOWAIT) != 0)
649 bzero(sc->mly_mmbox, sizeof(*sc->mly_mmbox));
654 /********************************************************************************
655 * Save the physical address of the memory mailbox
658 mly_mmbox_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
660 struct mly_softc *sc = (struct mly_softc *)arg;
664 sc->mly_mmbox_busaddr = segs->ds_addr;
667 /********************************************************************************
668 * Free all of the resources associated with (sc)
670 * Should not be called if the controller is active.
673 mly_free(struct mly_softc *sc)
678 /* Remove the management device */
679 destroy_dev(sc->mly_dev_t);
681 /* detach from CAM */
684 /* release command memory */
685 mly_release_commands(sc);
687 /* throw away the controllerinfo structure */
688 if (sc->mly_controllerinfo != NULL)
689 free(sc->mly_controllerinfo, M_DEVBUF);
691 /* throw away the controllerparam structure */
692 if (sc->mly_controllerparam != NULL)
693 free(sc->mly_controllerparam, M_DEVBUF);
695 /* destroy data-transfer DMA tag */
696 if (sc->mly_buffer_dmat)
697 bus_dma_tag_destroy(sc->mly_buffer_dmat);
699 /* free and destroy DMA memory and tag for s/g lists */
700 if (sc->mly_sg_table) {
701 bus_dmamap_unload(sc->mly_sg_dmat, sc->mly_sg_dmamap);
702 bus_dmamem_free(sc->mly_sg_dmat, sc->mly_sg_table, sc->mly_sg_dmamap);
705 bus_dma_tag_destroy(sc->mly_sg_dmat);
707 /* free and destroy DMA memory and tag for memory mailbox */
709 bus_dmamap_unload(sc->mly_mmbox_dmat, sc->mly_mmbox_dmamap);
710 bus_dmamem_free(sc->mly_mmbox_dmat, sc->mly_mmbox, sc->mly_mmbox_dmamap);
712 if (sc->mly_mmbox_dmat)
713 bus_dma_tag_destroy(sc->mly_mmbox_dmat);
715 /* disconnect the interrupt handler */
717 bus_teardown_intr(sc->mly_dev, sc->mly_irq, sc->mly_intr);
718 if (sc->mly_irq != NULL)
719 bus_release_resource(sc->mly_dev, SYS_RES_IRQ, sc->mly_irq_rid, sc->mly_irq);
721 /* destroy the parent DMA tag */
722 if (sc->mly_parent_dmat)
723 bus_dma_tag_destroy(sc->mly_parent_dmat);
725 /* release the register window mapping */
726 if (sc->mly_regs_resource != NULL)
727 bus_release_resource(sc->mly_dev, SYS_RES_MEMORY, sc->mly_regs_rid, sc->mly_regs_resource);
730 /********************************************************************************
731 ********************************************************************************
733 ********************************************************************************
734 ********************************************************************************/
736 /********************************************************************************
737 * Fill in the mly_controllerinfo and mly_controllerparam fields in the softc.
740 mly_get_controllerinfo(struct mly_softc *sc)
742 struct mly_command_ioctl mci;
748 if (sc->mly_controllerinfo != NULL)
749 free(sc->mly_controllerinfo, M_DEVBUF);
751 /* build the getcontrollerinfo ioctl and send it */
752 bzero(&mci, sizeof(mci));
753 sc->mly_controllerinfo = NULL;
754 mci.sub_ioctl = MDACIOCTL_GETCONTROLLERINFO;
755 if ((error = mly_ioctl(sc, &mci, (void **)&sc->mly_controllerinfo, sizeof(*sc->mly_controllerinfo),
756 &status, NULL, NULL)))
761 if (sc->mly_controllerparam != NULL)
762 free(sc->mly_controllerparam, M_DEVBUF);
764 /* build the getcontrollerparameter ioctl and send it */
765 bzero(&mci, sizeof(mci));
766 sc->mly_controllerparam = NULL;
767 mci.sub_ioctl = MDACIOCTL_GETCONTROLLERPARAMETER;
768 if ((error = mly_ioctl(sc, &mci, (void **)&sc->mly_controllerparam, sizeof(*sc->mly_controllerparam),
769 &status, NULL, NULL)))
777 /********************************************************************************
778 * Schedule all possible devices for a rescan.
782 mly_scan_devices(struct mly_softc *sc)
789 * Clear any previous BTL information.
791 bzero(&sc->mly_btl, sizeof(sc->mly_btl));
794 * Mark all devices as requiring a rescan, and let the next
795 * periodic scan collect them.
797 for (bus = 0; bus < sc->mly_cam_channels; bus++)
798 if (MLY_BUS_IS_VALID(sc, bus))
799 for (target = 0; target < MLY_MAX_TARGETS; target++)
800 sc->mly_btl[bus][target].mb_flags = MLY_BTL_RESCAN;
804 /********************************************************************************
805 * Rescan a device, possibly as a consequence of getting an event which suggests
806 * that it may have changed.
808 * If we suffer resource starvation, we can abandon the rescan as we'll be
812 mly_rescan_btl(struct mly_softc *sc, int bus, int target)
814 struct mly_command *mc;
815 struct mly_command_ioctl *mci;
819 /* check that this bus is valid */
820 if (!MLY_BUS_IS_VALID(sc, bus))
824 if (mly_alloc_command(sc, &mc))
827 /* set up the data buffer */
828 if ((mc->mc_data = malloc(sizeof(union mly_devinfo), M_DEVBUF, M_NOWAIT | M_ZERO)) == NULL) {
829 mly_release_command(mc);
832 mc->mc_flags |= MLY_CMD_DATAIN;
833 mc->mc_complete = mly_complete_rescan;
838 mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
839 mci->opcode = MDACMD_IOCTL;
840 mci->addr.phys.controller = 0;
841 mci->timeout.value = 30;
842 mci->timeout.scale = MLY_TIMEOUT_SECONDS;
843 if (MLY_BUS_IS_VIRTUAL(sc, bus)) {
844 mc->mc_length = mci->data_size = sizeof(struct mly_ioctl_getlogdevinfovalid);
845 mci->sub_ioctl = MDACIOCTL_GETLOGDEVINFOVALID;
846 mci->addr.log.logdev = MLY_LOGDEV_ID(sc, bus, target);
847 debug(1, "logical device %d", mci->addr.log.logdev);
849 mc->mc_length = mci->data_size = sizeof(struct mly_ioctl_getphysdevinfovalid);
850 mci->sub_ioctl = MDACIOCTL_GETPHYSDEVINFOVALID;
851 mci->addr.phys.lun = 0;
852 mci->addr.phys.target = target;
853 mci->addr.phys.channel = bus;
854 debug(1, "physical device %d:%d", mci->addr.phys.channel, mci->addr.phys.target);
858 * Dispatch the command. If we successfully send the command, clear the rescan
861 if (mly_start(mc) != 0) {
862 mly_release_command(mc);
864 sc->mly_btl[bus][target].mb_flags &= ~MLY_BTL_RESCAN; /* success */
868 /********************************************************************************
869 * Handle the completion of a rescan operation
872 mly_complete_rescan(struct mly_command *mc)
874 struct mly_softc *sc = mc->mc_sc;
875 struct mly_ioctl_getlogdevinfovalid *ldi;
876 struct mly_ioctl_getphysdevinfovalid *pdi;
877 struct mly_command_ioctl *mci;
878 struct mly_btl btl, *btlp;
879 int bus, target, rescan;
884 * Recover the bus and target from the command. We need these even in
885 * the case where we don't have a useful response.
887 mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
888 if (mci->sub_ioctl == MDACIOCTL_GETLOGDEVINFOVALID) {
889 bus = MLY_LOGDEV_BUS(sc, mci->addr.log.logdev);
890 target = MLY_LOGDEV_TARGET(sc, mci->addr.log.logdev);
892 bus = mci->addr.phys.channel;
893 target = mci->addr.phys.target;
895 /* XXX validate bus/target? */
897 /* the default result is 'no device' */
898 bzero(&btl, sizeof(btl));
900 /* if the rescan completed OK, we have possibly-new BTL data */
901 if (mc->mc_status == 0) {
902 if (mc->mc_length == sizeof(*ldi)) {
903 ldi = (struct mly_ioctl_getlogdevinfovalid *)mc->mc_data;
904 if ((MLY_LOGDEV_BUS(sc, ldi->logical_device_number) != bus) ||
905 (MLY_LOGDEV_TARGET(sc, ldi->logical_device_number) != target)) {
906 mly_printf(sc, "WARNING: BTL rescan for %d:%d returned data for %d:%d instead\n",
907 bus, target, MLY_LOGDEV_BUS(sc, ldi->logical_device_number),
908 MLY_LOGDEV_TARGET(sc, ldi->logical_device_number));
909 /* XXX what can we do about this? */
911 btl.mb_flags = MLY_BTL_LOGICAL;
912 btl.mb_type = ldi->raid_level;
913 btl.mb_state = ldi->state;
914 debug(1, "BTL rescan for %d returns %s, %s", ldi->logical_device_number,
915 mly_describe_code(mly_table_device_type, ldi->raid_level),
916 mly_describe_code(mly_table_device_state, ldi->state));
917 } else if (mc->mc_length == sizeof(*pdi)) {
918 pdi = (struct mly_ioctl_getphysdevinfovalid *)mc->mc_data;
919 if ((pdi->channel != bus) || (pdi->target != target)) {
920 mly_printf(sc, "WARNING: BTL rescan for %d:%d returned data for %d:%d instead\n",
921 bus, target, pdi->channel, pdi->target);
922 /* XXX what can we do about this? */
924 btl.mb_flags = MLY_BTL_PHYSICAL;
925 btl.mb_type = MLY_DEVICE_TYPE_PHYSICAL;
926 btl.mb_state = pdi->state;
927 btl.mb_speed = pdi->speed;
928 btl.mb_width = pdi->width;
929 if (pdi->state != MLY_DEVICE_STATE_UNCONFIGURED)
930 sc->mly_btl[bus][target].mb_flags |= MLY_BTL_PROTECTED;
931 debug(1, "BTL rescan for %d:%d returns %s", bus, target,
932 mly_describe_code(mly_table_device_state, pdi->state));
934 mly_printf(sc, "BTL rescan result invalid\n");
938 free(mc->mc_data, M_DEVBUF);
939 mly_release_command(mc);
942 * Decide whether we need to rescan the device.
946 /* device type changes (usually between 'nothing' and 'something') */
947 btlp = &sc->mly_btl[bus][target];
948 if (btl.mb_flags != btlp->mb_flags) {
949 debug(1, "flags changed, rescanning");
953 /* XXX other reasons? */
956 * Update BTL information.
961 * Perform CAM rescan if required.
964 mly_cam_rescan_btl(sc, bus, target);
967 /********************************************************************************
968 * Get the current health status and set the 'next event' counter to suit.
971 mly_get_eventstatus(struct mly_softc *sc)
973 struct mly_command_ioctl mci;
974 struct mly_health_status *mh;
978 /* build the gethealthstatus ioctl and send it */
979 bzero(&mci, sizeof(mci));
981 mci.sub_ioctl = MDACIOCTL_GETHEALTHSTATUS;
983 if ((error = mly_ioctl(sc, &mci, (void **)&mh, sizeof(*mh), &status, NULL, NULL)))
988 /* get the event counter */
989 sc->mly_event_change = mh->change_counter;
990 sc->mly_event_waiting = mh->next_event;
991 sc->mly_event_counter = mh->next_event;
993 /* save the health status into the memory mailbox */
994 bcopy(mh, &sc->mly_mmbox->mmm_health.status, sizeof(*mh));
996 debug(1, "initial change counter %d, event counter %d", mh->change_counter, mh->next_event);
1002 /********************************************************************************
1003 * Enable the memory mailbox mode.
1006 mly_enable_mmbox(struct mly_softc *sc)
1008 struct mly_command_ioctl mci;
1009 u_int8_t *sp, status;
1014 /* build the ioctl and send it */
1015 bzero(&mci, sizeof(mci));
1016 mci.sub_ioctl = MDACIOCTL_SETMEMORYMAILBOX;
1017 /* set buffer addresses */
1018 mci.param.setmemorymailbox.command_mailbox_physaddr =
1019 sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_command);
1020 mci.param.setmemorymailbox.status_mailbox_physaddr =
1021 sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_status);
1022 mci.param.setmemorymailbox.health_buffer_physaddr =
1023 sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_health);
1025 /* set buffer sizes - abuse of data_size field is revolting */
1026 sp = (u_int8_t *)&mci.data_size;
1027 sp[0] = ((sizeof(union mly_command_packet) * MLY_MMBOX_COMMANDS) / 1024);
1028 sp[1] = (sizeof(union mly_status_packet) * MLY_MMBOX_STATUS) / 1024;
1029 mci.param.setmemorymailbox.health_buffer_size = sizeof(union mly_health_region) / 1024;
1031 debug(1, "memory mailbox at %p (0x%llx/%d 0x%llx/%d 0x%llx/%d", sc->mly_mmbox,
1032 mci.param.setmemorymailbox.command_mailbox_physaddr, sp[0],
1033 mci.param.setmemorymailbox.status_mailbox_physaddr, sp[1],
1034 mci.param.setmemorymailbox.health_buffer_physaddr,
1035 mci.param.setmemorymailbox.health_buffer_size);
1037 if ((error = mly_ioctl(sc, &mci, NULL, 0, &status, NULL, NULL)))
1041 sc->mly_state |= MLY_STATE_MMBOX_ACTIVE;
1042 debug(1, "memory mailbox active");
1046 /********************************************************************************
1047 * Flush all pending I/O from the controller.
1050 mly_flush(struct mly_softc *sc)
1052 struct mly_command_ioctl mci;
1058 /* build the ioctl */
1059 bzero(&mci, sizeof(mci));
1060 mci.sub_ioctl = MDACIOCTL_FLUSHDEVICEDATA;
1061 mci.param.deviceoperation.operation_device = MLY_OPDEVICE_PHYSICAL_CONTROLLER;
1063 /* pass it off to the controller */
1064 if ((error = mly_ioctl(sc, &mci, NULL, 0, &status, NULL, NULL)))
1067 return((status == 0) ? 0 : EIO);
1070 /********************************************************************************
1071 * Perform an ioctl command.
1073 * If (data) is not NULL, the command requires data transfer. If (*data) is NULL
1074 * the command requires data transfer from the controller, and we will allocate
1075 * a buffer for it. If (*data) is not NULL, the command requires data transfer
1076 * to the controller.
1078 * XXX passing in the whole ioctl structure is ugly. Better ideas?
1080 * XXX we don't even try to handle the case where datasize > 4k. We should.
1083 mly_ioctl(struct mly_softc *sc, struct mly_command_ioctl *ioctl, void **data, size_t datasize,
1084 u_int8_t *status, void *sense_buffer, size_t *sense_length)
1086 struct mly_command *mc;
1087 struct mly_command_ioctl *mci;
1093 if (mly_alloc_command(sc, &mc)) {
1098 /* copy the ioctl structure, but save some important fields and then fixup */
1099 mci = &mc->mc_packet->ioctl;
1100 ioctl->sense_buffer_address = mci->sense_buffer_address;
1101 ioctl->maximum_sense_size = mci->maximum_sense_size;
1103 mci->opcode = MDACMD_IOCTL;
1104 mci->timeout.value = 30;
1105 mci->timeout.scale = MLY_TIMEOUT_SECONDS;
1107 /* handle the data buffer */
1109 if (*data == NULL) {
1110 /* allocate data buffer */
1111 if ((mc->mc_data = malloc(datasize, M_DEVBUF, M_NOWAIT)) == NULL) {
1115 mc->mc_flags |= MLY_CMD_DATAIN;
1117 mc->mc_data = *data;
1118 mc->mc_flags |= MLY_CMD_DATAOUT;
1120 mc->mc_length = datasize;
1121 mc->mc_packet->generic.data_size = datasize;
1124 /* run the command */
1125 if ((error = mly_immediate_command(mc)))
1128 /* clean up and return any data */
1129 *status = mc->mc_status;
1130 if ((mc->mc_sense > 0) && (sense_buffer != NULL)) {
1131 bcopy(mc->mc_packet, sense_buffer, mc->mc_sense);
1132 *sense_length = mc->mc_sense;
1136 /* should we return a data pointer? */
1137 if ((data != NULL) && (*data == NULL))
1138 *data = mc->mc_data;
1140 /* command completed OK */
1145 /* do we need to free a data buffer we allocated? */
1146 if (error && (mc->mc_data != NULL) && (*data == NULL))
1147 free(mc->mc_data, M_DEVBUF);
1148 mly_release_command(mc);
1153 /********************************************************************************
1154 * Check for event(s) outstanding in the controller.
1157 mly_check_event(struct mly_softc *sc)
1161 * The controller may have updated the health status information,
1162 * so check for it here. Note that the counters are all in host memory,
1163 * so this check is very cheap. Also note that we depend on checking on
1166 if (sc->mly_mmbox->mmm_health.status.change_counter != sc->mly_event_change) {
1167 sc->mly_event_change = sc->mly_mmbox->mmm_health.status.change_counter;
1168 debug(1, "event change %d, event status update, %d -> %d", sc->mly_event_change,
1169 sc->mly_event_waiting, sc->mly_mmbox->mmm_health.status.next_event);
1170 sc->mly_event_waiting = sc->mly_mmbox->mmm_health.status.next_event;
1172 /* wake up anyone that might be interested in this */
1173 wakeup(&sc->mly_event_change);
1175 if (sc->mly_event_counter != sc->mly_event_waiting)
1176 mly_fetch_event(sc);
1179 /********************************************************************************
1180 * Fetch one event from the controller.
1182 * If we fail due to resource starvation, we'll be retried the next time a
1183 * command completes.
1186 mly_fetch_event(struct mly_softc *sc)
1188 struct mly_command *mc;
1189 struct mly_command_ioctl *mci;
1196 if (mly_alloc_command(sc, &mc))
1199 /* set up the data buffer */
1200 if ((mc->mc_data = malloc(sizeof(struct mly_event), M_DEVBUF, M_NOWAIT | M_ZERO)) == NULL) {
1201 mly_release_command(mc);
1204 mc->mc_length = sizeof(struct mly_event);
1205 mc->mc_flags |= MLY_CMD_DATAIN;
1206 mc->mc_complete = mly_complete_event;
1209 * Get an event number to fetch. It's possible that we've raced with another
1210 * context for the last event, in which case there will be no more events.
1213 if (sc->mly_event_counter == sc->mly_event_waiting) {
1214 mly_release_command(mc);
1218 event = sc->mly_event_counter++;
1224 * At this point we are committed to sending this request, as it
1225 * will be the only one constructed for this particular event number.
1227 mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
1228 mci->opcode = MDACMD_IOCTL;
1229 mci->data_size = sizeof(struct mly_event);
1230 mci->addr.phys.lun = (event >> 16) & 0xff;
1231 mci->addr.phys.target = (event >> 24) & 0xff;
1232 mci->addr.phys.channel = 0;
1233 mci->addr.phys.controller = 0;
1234 mci->timeout.value = 30;
1235 mci->timeout.scale = MLY_TIMEOUT_SECONDS;
1236 mci->sub_ioctl = MDACIOCTL_GETEVENT;
1237 mci->param.getevent.sequence_number_low = event & 0xffff;
1239 debug(1, "fetch event %u", event);
1242 * Submit the command.
1244 * Note that failure of mly_start() will result in this event never being
1247 if (mly_start(mc) != 0) {
1248 mly_printf(sc, "couldn't fetch event %u\n", event);
1249 mly_release_command(mc);
1253 /********************************************************************************
1254 * Handle the completion of an event poll.
1257 mly_complete_event(struct mly_command *mc)
1259 struct mly_softc *sc = mc->mc_sc;
1260 struct mly_event *me = (struct mly_event *)mc->mc_data;
1265 * If the event was successfully fetched, process it.
1267 if (mc->mc_status == SCSI_STATUS_OK) {
1268 mly_process_event(sc, me);
1271 mly_release_command(mc);
1274 * Check for another event.
1276 mly_check_event(sc);
1279 /********************************************************************************
1280 * Process a controller event.
1283 mly_process_event(struct mly_softc *sc, struct mly_event *me)
1285 struct scsi_sense_data_fixed *ssd;
1287 int bus, target, event, class, action;
1289 ssd = (struct scsi_sense_data_fixed *)&me->sense[0];
1292 * Errors can be reported using vendor-unique sense data. In this case, the
1293 * event code will be 0x1c (Request sense data present), the sense key will
1294 * be 0x09 (vendor specific), the MSB of the ASC will be set, and the
1295 * actual event code will be a 16-bit value comprised of the ASCQ (low byte)
1296 * and low seven bits of the ASC (low seven bits of the high byte).
1298 if ((me->code == 0x1c) &&
1299 ((ssd->flags & SSD_KEY) == SSD_KEY_Vendor_Specific) &&
1300 (ssd->add_sense_code & 0x80)) {
1301 event = ((int)(ssd->add_sense_code & ~0x80) << 8) + ssd->add_sense_code_qual;
1306 /* look up event, get codes */
1307 fp = mly_describe_code(mly_table_event, event);
1309 debug(1, "Event %d code 0x%x", me->sequence_number, me->code);
1313 if (isupper(class) && bootverbose)
1314 class = tolower(class);
1316 /* get action code, text string */
1321 * Print some information about the event.
1323 * This code uses a table derived from the corresponding portion of the Linux
1324 * driver, and thus the parser is very similar.
1327 case 'p': /* error on physical device */
1328 mly_printf(sc, "physical device %d:%d %s\n", me->channel, me->target, tp);
1330 sc->mly_btl[me->channel][me->target].mb_flags |= MLY_BTL_RESCAN;
1332 case 'l': /* error on logical unit */
1333 case 'm': /* message about logical unit */
1334 bus = MLY_LOGDEV_BUS(sc, me->lun);
1335 target = MLY_LOGDEV_TARGET(sc, me->lun);
1336 mly_name_device(sc, bus, target);
1337 mly_printf(sc, "logical device %d (%s) %s\n", me->lun, sc->mly_btl[bus][target].mb_name, tp);
1339 sc->mly_btl[bus][target].mb_flags |= MLY_BTL_RESCAN;
1341 case 's': /* report of sense data */
1342 if (((ssd->flags & SSD_KEY) == SSD_KEY_NO_SENSE) ||
1343 (((ssd->flags & SSD_KEY) == SSD_KEY_NOT_READY) &&
1344 (ssd->add_sense_code == 0x04) &&
1345 ((ssd->add_sense_code_qual == 0x01) || (ssd->add_sense_code_qual == 0x02))))
1346 break; /* ignore NO_SENSE or NOT_READY in one case */
1348 mly_printf(sc, "physical device %d:%d %s\n", me->channel, me->target, tp);
1349 mly_printf(sc, " sense key %d asc %02x ascq %02x\n",
1350 ssd->flags & SSD_KEY, ssd->add_sense_code, ssd->add_sense_code_qual);
1351 mly_printf(sc, " info %4D csi %4D\n", ssd->info, "", ssd->cmd_spec_info, "");
1353 sc->mly_btl[me->channel][me->target].mb_flags |= MLY_BTL_RESCAN;
1356 mly_printf(sc, tp, me->target, me->lun);
1360 mly_printf(sc, "controller %s\n", tp);
1363 mly_printf(sc, "%s - %d\n", tp, me->code);
1365 default: /* probably a 'noisy' event being ignored */
1370 /********************************************************************************
1371 * Perform periodic activities.
1374 mly_periodic(void *data)
1376 struct mly_softc *sc = (struct mly_softc *)data;
1384 for (bus = 0; bus < sc->mly_cam_channels; bus++) {
1385 if (MLY_BUS_IS_VALID(sc, bus)) {
1386 for (target = 0; target < MLY_MAX_TARGETS; target++) {
1388 /* ignore the controller in this scan */
1389 if (target == sc->mly_controllerparam->initiator_id)
1392 /* perform device rescan? */
1393 if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_RESCAN)
1394 mly_rescan_btl(sc, bus, target);
1399 /* check for controller events */
1400 mly_check_event(sc);
1402 /* reschedule ourselves */
1403 sc->mly_periodic = timeout(mly_periodic, sc, MLY_PERIODIC_INTERVAL * hz);
1406 /********************************************************************************
1407 ********************************************************************************
1409 ********************************************************************************
1410 ********************************************************************************/
1412 /********************************************************************************
1413 * Run a command and wait for it to complete.
1417 mly_immediate_command(struct mly_command *mc)
1419 struct mly_softc *sc = mc->mc_sc;
1424 /* spinning at splcam is ugly, but we're only used during controller init */
1426 if ((error = mly_start(mc))) {
1431 if (sc->mly_state & MLY_STATE_INTERRUPTS_ON) {
1432 /* sleep on the command */
1433 while(!(mc->mc_flags & MLY_CMD_COMPLETE)) {
1434 tsleep(mc, PRIBIO, "mlywait", 0);
1437 /* spin and collect status while we do */
1438 while(!(mc->mc_flags & MLY_CMD_COMPLETE)) {
1439 mly_done(mc->mc_sc);
1446 /********************************************************************************
1447 * Deliver a command to the controller.
1449 * XXX it would be good to just queue commands that we can't submit immediately
1450 * and send them later, but we probably want a wrapper for that so that
1451 * we don't hang on a failed submission for an immediate command.
1454 mly_start(struct mly_command *mc)
1456 struct mly_softc *sc = mc->mc_sc;
1457 union mly_command_packet *pkt;
1463 * Set the command up for delivery to the controller.
1465 mly_map_command(mc);
1466 mc->mc_packet->generic.command_id = mc->mc_slot;
1469 mc->mc_timestamp = time_second;
1475 * Do we have to use the hardware mailbox?
1477 if (!(sc->mly_state & MLY_STATE_MMBOX_ACTIVE)) {
1479 * Check to see if the controller is ready for us.
1481 if (MLY_IDBR_TRUE(sc, MLY_HM_CMDSENT)) {
1485 mc->mc_flags |= MLY_CMD_BUSY;
1488 * It's ready, send the command.
1490 MLY_SET_MBOX(sc, sc->mly_command_mailbox, &mc->mc_packetphys);
1491 MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_CMDSENT);
1493 } else { /* use memory-mailbox mode */
1495 pkt = &sc->mly_mmbox->mmm_command[sc->mly_mmbox_command_index];
1497 /* check to see if the next index is free yet */
1498 if (pkt->mmbox.flag != 0) {
1502 mc->mc_flags |= MLY_CMD_BUSY;
1504 /* copy in new command */
1505 bcopy(mc->mc_packet->mmbox.data, pkt->mmbox.data, sizeof(pkt->mmbox.data));
1506 /* barrier to ensure completion of previous write before we write the flag */
1507 bus_space_barrier(sc->mly_btag, sc->mly_bhandle, 0, 0,
1508 BUS_SPACE_BARRIER_WRITE);
1509 /* copy flag last */
1510 pkt->mmbox.flag = mc->mc_packet->mmbox.flag;
1511 /* barrier to ensure completion of previous write before we notify the controller */
1512 bus_space_barrier(sc->mly_btag, sc->mly_bhandle, 0, 0,
1513 BUS_SPACE_BARRIER_WRITE);
1515 /* signal controller, update index */
1516 MLY_SET_REG(sc, sc->mly_idbr, MLY_AM_CMDSENT);
1517 sc->mly_mmbox_command_index = (sc->mly_mmbox_command_index + 1) % MLY_MMBOX_COMMANDS;
1520 mly_enqueue_busy(mc);
1525 /********************************************************************************
1526 * Pick up command status from the controller, schedule a completion event
1529 mly_done(struct mly_softc *sc)
1531 struct mly_command *mc;
1532 union mly_status_packet *sp;
1539 /* pick up hardware-mailbox commands */
1540 if (MLY_ODBR_TRUE(sc, MLY_HM_STSREADY)) {
1541 slot = MLY_GET_REG2(sc, sc->mly_status_mailbox);
1542 if (slot < MLY_SLOT_MAX) {
1543 mc = &sc->mly_command[slot - MLY_SLOT_START];
1544 mc->mc_status = MLY_GET_REG(sc, sc->mly_status_mailbox + 2);
1545 mc->mc_sense = MLY_GET_REG(sc, sc->mly_status_mailbox + 3);
1546 mc->mc_resid = MLY_GET_REG4(sc, sc->mly_status_mailbox + 4);
1547 mly_remove_busy(mc);
1548 mc->mc_flags &= ~MLY_CMD_BUSY;
1549 mly_enqueue_complete(mc);
1552 /* slot 0xffff may mean "extremely bogus command" */
1553 mly_printf(sc, "got HM completion for illegal slot %u\n", slot);
1555 /* unconditionally acknowledge status */
1556 MLY_SET_REG(sc, sc->mly_odbr, MLY_HM_STSREADY);
1557 MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_STSACK);
1560 /* pick up memory-mailbox commands */
1561 if (MLY_ODBR_TRUE(sc, MLY_AM_STSREADY)) {
1563 sp = &sc->mly_mmbox->mmm_status[sc->mly_mmbox_status_index];
1565 /* check for more status */
1566 if (sp->mmbox.flag == 0)
1569 /* get slot number */
1570 slot = sp->status.command_id;
1571 if (slot < MLY_SLOT_MAX) {
1572 mc = &sc->mly_command[slot - MLY_SLOT_START];
1573 mc->mc_status = sp->status.status;
1574 mc->mc_sense = sp->status.sense_length;
1575 mc->mc_resid = sp->status.residue;
1576 mly_remove_busy(mc);
1577 mc->mc_flags &= ~MLY_CMD_BUSY;
1578 mly_enqueue_complete(mc);
1581 /* slot 0xffff may mean "extremely bogus command" */
1582 mly_printf(sc, "got AM completion for illegal slot %u at %d\n",
1583 slot, sc->mly_mmbox_status_index);
1586 /* clear and move to next index */
1588 sc->mly_mmbox_status_index = (sc->mly_mmbox_status_index + 1) % MLY_MMBOX_STATUS;
1590 /* acknowledge that we have collected status value(s) */
1591 MLY_SET_REG(sc, sc->mly_odbr, MLY_AM_STSREADY);
1596 if (sc->mly_state & MLY_STATE_INTERRUPTS_ON)
1597 taskqueue_enqueue(taskqueue_swi_giant, &sc->mly_task_complete);
1599 mly_complete(sc, 0);
1603 /********************************************************************************
1604 * Process completed commands
1607 mly_complete(void *context, int pending)
1609 struct mly_softc *sc = (struct mly_softc *)context;
1610 struct mly_command *mc;
1611 void (* mc_complete)(struct mly_command *mc);
1617 * Spin pulling commands off the completed queue and processing them.
1619 while ((mc = mly_dequeue_complete(sc)) != NULL) {
1622 * Free controller resources, mark command complete.
1624 * Note that as soon as we mark the command complete, it may be freed
1625 * out from under us, so we need to save the mc_complete field in
1626 * order to later avoid dereferencing mc. (We would not expect to
1627 * have a polling/sleeping consumer with mc_complete != NULL).
1629 mly_unmap_command(mc);
1630 mc_complete = mc->mc_complete;
1631 mc->mc_flags |= MLY_CMD_COMPLETE;
1634 * Call completion handler or wake up sleeping consumer.
1636 if (mc_complete != NULL) {
1644 * XXX if we are deferring commands due to controller-busy status, we should
1645 * retry submitting them here.
1649 /********************************************************************************
1650 ********************************************************************************
1651 Command Buffer Management
1652 ********************************************************************************
1653 ********************************************************************************/
1655 /********************************************************************************
1656 * Allocate a command.
1659 mly_alloc_command(struct mly_softc *sc, struct mly_command **mcp)
1661 struct mly_command *mc;
1665 if ((mc = mly_dequeue_free(sc)) == NULL)
1672 /********************************************************************************
1673 * Release a command back to the freelist.
1676 mly_release_command(struct mly_command *mc)
1681 * Fill in parts of the command that may cause confusion if
1682 * a consumer doesn't when we are later allocated.
1686 mc->mc_complete = NULL;
1687 mc->mc_private = NULL;
1690 * By default, we set up to overwrite the command packet with
1691 * sense information.
1693 mc->mc_packet->generic.sense_buffer_address = mc->mc_packetphys;
1694 mc->mc_packet->generic.maximum_sense_size = sizeof(union mly_command_packet);
1696 mly_enqueue_free(mc);
1699 /********************************************************************************
1700 * Map helper for command allocation.
1703 mly_alloc_commands_map(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1705 struct mly_softc *sc = (struct mly_softc *)arg;
1709 sc->mly_packetphys = segs[0].ds_addr;
1712 /********************************************************************************
1713 * Allocate and initialise command and packet structures.
1715 * If the controller supports fewer than MLY_MAX_COMMANDS commands, limit our
1716 * allocation to that number. If we don't yet know how many commands the
1717 * controller supports, allocate a very small set (suitable for initialisation
1721 mly_alloc_commands(struct mly_softc *sc)
1723 struct mly_command *mc;
1726 if (sc->mly_controllerinfo == NULL) {
1729 ncmd = min(MLY_MAX_COMMANDS, sc->mly_controllerinfo->maximum_parallel_commands);
1733 * Allocate enough space for all the command packets in one chunk and
1734 * map them permanently into controller-visible space.
1736 if (bus_dmamem_alloc(sc->mly_packet_dmat, (void **)&sc->mly_packet,
1737 BUS_DMA_NOWAIT, &sc->mly_packetmap)) {
1740 if (bus_dmamap_load(sc->mly_packet_dmat, sc->mly_packetmap, sc->mly_packet,
1741 ncmd * sizeof(union mly_command_packet),
1742 mly_alloc_commands_map, sc, BUS_DMA_NOWAIT) != 0)
1745 for (i = 0; i < ncmd; i++) {
1746 mc = &sc->mly_command[i];
1747 bzero(mc, sizeof(*mc));
1749 mc->mc_slot = MLY_SLOT_START + i;
1750 mc->mc_packet = sc->mly_packet + i;
1751 mc->mc_packetphys = sc->mly_packetphys + (i * sizeof(union mly_command_packet));
1752 if (!bus_dmamap_create(sc->mly_buffer_dmat, 0, &mc->mc_datamap))
1753 mly_release_command(mc);
1758 /********************************************************************************
1759 * Free all the storage held by commands.
1761 * Must be called with all commands on the free list.
1764 mly_release_commands(struct mly_softc *sc)
1766 struct mly_command *mc;
1768 /* throw away command buffer DMA maps */
1769 while (mly_alloc_command(sc, &mc) == 0)
1770 bus_dmamap_destroy(sc->mly_buffer_dmat, mc->mc_datamap);
1772 /* release the packet storage */
1773 if (sc->mly_packet != NULL) {
1774 bus_dmamap_unload(sc->mly_packet_dmat, sc->mly_packetmap);
1775 bus_dmamem_free(sc->mly_packet_dmat, sc->mly_packet, sc->mly_packetmap);
1776 sc->mly_packet = NULL;
1781 /********************************************************************************
1782 * Command-mapping helper function - populate this command's s/g table
1783 * with the s/g entries for its data.
1786 mly_map_command_sg(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1788 struct mly_command *mc = (struct mly_command *)arg;
1789 struct mly_softc *sc = mc->mc_sc;
1790 struct mly_command_generic *gen = &(mc->mc_packet->generic);
1791 struct mly_sg_entry *sg;
1796 /* can we use the transfer structure directly? */
1798 sg = &gen->transfer.direct.sg[0];
1799 gen->command_control.extended_sg_table = 0;
1801 tabofs = ((mc->mc_slot - MLY_SLOT_START) * MLY_MAX_SGENTRIES);
1802 sg = sc->mly_sg_table + tabofs;
1803 gen->transfer.indirect.entries[0] = nseg;
1804 gen->transfer.indirect.table_physaddr[0] = sc->mly_sg_busaddr + (tabofs * sizeof(struct mly_sg_entry));
1805 gen->command_control.extended_sg_table = 1;
1808 /* copy the s/g table */
1809 for (i = 0; i < nseg; i++) {
1810 sg[i].physaddr = segs[i].ds_addr;
1811 sg[i].length = segs[i].ds_len;
1817 /********************************************************************************
1818 * Command-mapping helper function - save the cdb's physical address.
1820 * We don't support 'large' SCSI commands at this time, so this is unused.
1823 mly_map_command_cdb(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1825 struct mly_command *mc = (struct mly_command *)arg;
1829 /* XXX can we safely assume that a CDB will never cross a page boundary? */
1830 if ((segs[0].ds_addr % PAGE_SIZE) >
1831 ((segs[0].ds_addr + mc->mc_packet->scsi_large.cdb_length) % PAGE_SIZE))
1832 panic("cdb crosses page boundary");
1834 /* fix up fields in the command packet */
1835 mc->mc_packet->scsi_large.cdb_physaddr = segs[0].ds_addr;
1839 /********************************************************************************
1840 * Map a command into controller-visible space
1843 mly_map_command(struct mly_command *mc)
1845 struct mly_softc *sc = mc->mc_sc;
1849 /* don't map more than once */
1850 if (mc->mc_flags & MLY_CMD_MAPPED)
1853 /* does the command have a data buffer? */
1854 if (mc->mc_data != NULL) {
1855 if (mc->mc_flags & MLY_CMD_CCB)
1856 bus_dmamap_load_ccb(sc->mly_buffer_dmat, mc->mc_datamap,
1857 mc->mc_data, mly_map_command_sg, mc, 0);
1859 bus_dmamap_load(sc->mly_buffer_dmat, mc->mc_datamap,
1860 mc->mc_data, mc->mc_length,
1861 mly_map_command_sg, mc, 0);
1862 if (mc->mc_flags & MLY_CMD_DATAIN)
1863 bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_PREREAD);
1864 if (mc->mc_flags & MLY_CMD_DATAOUT)
1865 bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_PREWRITE);
1867 mc->mc_flags |= MLY_CMD_MAPPED;
1870 /********************************************************************************
1871 * Unmap a command from controller-visible space
1874 mly_unmap_command(struct mly_command *mc)
1876 struct mly_softc *sc = mc->mc_sc;
1880 if (!(mc->mc_flags & MLY_CMD_MAPPED))
1883 /* does the command have a data buffer? */
1884 if (mc->mc_data != NULL) {
1885 if (mc->mc_flags & MLY_CMD_DATAIN)
1886 bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_POSTREAD);
1887 if (mc->mc_flags & MLY_CMD_DATAOUT)
1888 bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_POSTWRITE);
1890 bus_dmamap_unload(sc->mly_buffer_dmat, mc->mc_datamap);
1892 mc->mc_flags &= ~MLY_CMD_MAPPED;
1896 /********************************************************************************
1897 ********************************************************************************
1899 ********************************************************************************
1900 ********************************************************************************/
1902 /********************************************************************************
1903 * Attach the physical and virtual SCSI busses to CAM.
1905 * Physical bus numbering starts from 0, virtual bus numbering from one greater
1906 * than the highest physical bus. Physical busses are only registered if
1907 * the kernel environment variable "hw.mly.register_physical_channels" is set.
1909 * When we refer to a "bus", we are referring to the bus number registered with
1910 * the SIM, wheras a "channel" is a channel number given to the adapter. In order
1911 * to keep things simple, we map these 1:1, so "bus" and "channel" may be used
1915 mly_cam_attach(struct mly_softc *sc)
1917 struct cam_devq *devq;
1923 * Allocate a devq for all our channels combined.
1925 if ((devq = cam_simq_alloc(sc->mly_controllerinfo->maximum_parallel_commands)) == NULL) {
1926 mly_printf(sc, "can't allocate CAM SIM queue\n");
1931 * If physical channel registration has been requested, register these first.
1932 * Note that we enable tagged command queueing for physical channels.
1934 if (testenv("hw.mly.register_physical_channels")) {
1936 for (i = 0; i < sc->mly_controllerinfo->physical_channels_present; i++, chn++) {
1938 if ((sc->mly_cam_sim[chn] = cam_sim_alloc(mly_cam_action, mly_cam_poll, "mly", sc,
1939 device_get_unit(sc->mly_dev),
1941 sc->mly_controllerinfo->maximum_parallel_commands,
1942 1, devq)) == NULL) {
1945 if (xpt_bus_register(sc->mly_cam_sim[chn], sc->mly_dev, chn)) {
1946 mly_printf(sc, "CAM XPT phsyical channel registration failed\n");
1949 debug(1, "registered physical channel %d", chn);
1954 * Register our virtual channels, with bus numbers matching channel numbers.
1956 chn = sc->mly_controllerinfo->physical_channels_present;
1957 for (i = 0; i < sc->mly_controllerinfo->virtual_channels_present; i++, chn++) {
1958 if ((sc->mly_cam_sim[chn] = cam_sim_alloc(mly_cam_action, mly_cam_poll, "mly", sc,
1959 device_get_unit(sc->mly_dev),
1961 sc->mly_controllerinfo->maximum_parallel_commands,
1962 0, devq)) == NULL) {
1965 if (xpt_bus_register(sc->mly_cam_sim[chn], sc->mly_dev, chn)) {
1966 mly_printf(sc, "CAM XPT virtual channel registration failed\n");
1969 debug(1, "registered virtual channel %d", chn);
1973 * This is the total number of channels that (might have been) registered with
1974 * CAM. Some may not have been; check the mly_cam_sim array to be certain.
1976 sc->mly_cam_channels = sc->mly_controllerinfo->physical_channels_present +
1977 sc->mly_controllerinfo->virtual_channels_present;
1982 /********************************************************************************
1986 mly_cam_detach(struct mly_softc *sc)
1992 for (i = 0; i < sc->mly_cam_channels; i++) {
1993 if (sc->mly_cam_sim[i] != NULL) {
1994 xpt_bus_deregister(cam_sim_path(sc->mly_cam_sim[i]));
1995 cam_sim_free(sc->mly_cam_sim[i], 0);
1998 if (sc->mly_cam_devq != NULL)
1999 cam_simq_free(sc->mly_cam_devq);
2002 /************************************************************************
2006 mly_cam_rescan_btl(struct mly_softc *sc, int bus, int target)
2012 if ((ccb = xpt_alloc_ccb()) == NULL) {
2013 mly_printf(sc, "rescan failed (can't allocate CCB)\n");
2016 if (xpt_create_path(&ccb->ccb_h.path, NULL,
2017 cam_sim_path(sc->mly_cam_sim[bus]), target, 0) != CAM_REQ_CMP) {
2018 mly_printf(sc, "rescan failed (can't create path)\n");
2022 debug(1, "rescan target %d:%d", bus, target);
2026 /********************************************************************************
2027 * Handle an action requested by CAM
2030 mly_cam_action(struct cam_sim *sim, union ccb *ccb)
2032 struct mly_softc *sc = cam_sim_softc(sim);
2036 switch (ccb->ccb_h.func_code) {
2038 /* perform SCSI I/O */
2040 if (!mly_cam_action_io(sim, (struct ccb_scsiio *)&ccb->csio))
2044 /* perform geometry calculations */
2045 case XPT_CALC_GEOMETRY:
2047 struct ccb_calc_geometry *ccg = &ccb->ccg;
2048 u_int32_t secs_per_cylinder;
2050 debug(2, "XPT_CALC_GEOMETRY %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
2052 if (sc->mly_controllerparam->bios_geometry == MLY_BIOSGEOM_8G) {
2054 ccg->secs_per_track = 63;
2055 } else { /* MLY_BIOSGEOM_2G */
2057 ccg->secs_per_track = 32;
2059 secs_per_cylinder = ccg->heads * ccg->secs_per_track;
2060 ccg->cylinders = ccg->volume_size / secs_per_cylinder;
2061 ccb->ccb_h.status = CAM_REQ_CMP;
2065 /* handle path attribute inquiry */
2068 struct ccb_pathinq *cpi = &ccb->cpi;
2070 debug(2, "XPT_PATH_INQ %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
2072 cpi->version_num = 1;
2073 cpi->hba_inquiry = PI_TAG_ABLE; /* XXX extra flags for physical channels? */
2074 cpi->target_sprt = 0;
2076 cpi->max_target = MLY_MAX_TARGETS - 1;
2077 cpi->max_lun = MLY_MAX_LUNS - 1;
2078 cpi->initiator_id = sc->mly_controllerparam->initiator_id;
2079 strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
2080 strncpy(cpi->hba_vid, "FreeBSD", HBA_IDLEN);
2081 strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
2082 cpi->unit_number = cam_sim_unit(sim);
2083 cpi->bus_id = cam_sim_bus(sim);
2084 cpi->base_transfer_speed = 132 * 1024; /* XXX what to set this to? */
2085 cpi->transport = XPORT_SPI;
2086 cpi->transport_version = 2;
2087 cpi->protocol = PROTO_SCSI;
2088 cpi->protocol_version = SCSI_REV_2;
2089 ccb->ccb_h.status = CAM_REQ_CMP;
2093 case XPT_GET_TRAN_SETTINGS:
2095 struct ccb_trans_settings *cts = &ccb->cts;
2097 struct ccb_trans_settings_scsi *scsi = &cts->proto_specific.scsi;
2098 struct ccb_trans_settings_spi *spi = &cts->xport_specific.spi;
2100 cts->protocol = PROTO_SCSI;
2101 cts->protocol_version = SCSI_REV_2;
2102 cts->transport = XPORT_SPI;
2103 cts->transport_version = 2;
2110 bus = cam_sim_bus(sim);
2111 target = cts->ccb_h.target_id;
2112 debug(2, "XPT_GET_TRAN_SETTINGS %d:%d", bus, target);
2113 /* logical device? */
2114 if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_LOGICAL) {
2115 /* nothing special for these */
2116 /* physical device? */
2117 } else if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_PHYSICAL) {
2118 /* allow CAM to try tagged transactions */
2119 scsi->flags |= CTS_SCSI_FLAGS_TAG_ENB;
2120 scsi->valid |= CTS_SCSI_VALID_TQ;
2122 /* convert speed (MHz) to usec */
2123 if (sc->mly_btl[bus][target].mb_speed == 0) {
2124 spi->sync_period = 1000000 / 5;
2126 spi->sync_period = 1000000 / sc->mly_btl[bus][target].mb_speed;
2129 /* convert bus width to CAM internal encoding */
2130 switch (sc->mly_btl[bus][target].mb_width) {
2132 spi->bus_width = MSG_EXT_WDTR_BUS_32_BIT;
2135 spi->bus_width = MSG_EXT_WDTR_BUS_16_BIT;
2139 spi->bus_width = MSG_EXT_WDTR_BUS_8_BIT;
2142 spi->valid |= CTS_SPI_VALID_SYNC_RATE | CTS_SPI_VALID_BUS_WIDTH;
2144 /* not a device, bail out */
2146 cts->ccb_h.status = CAM_REQ_CMP_ERR;
2150 /* disconnect always OK */
2151 spi->flags |= CTS_SPI_FLAGS_DISC_ENB;
2152 spi->valid |= CTS_SPI_VALID_DISC;
2154 cts->ccb_h.status = CAM_REQ_CMP;
2158 default: /* we can't do this */
2159 debug(2, "unspported func_code = 0x%x", ccb->ccb_h.func_code);
2160 ccb->ccb_h.status = CAM_REQ_INVALID;
2167 /********************************************************************************
2168 * Handle an I/O operation requested by CAM
2171 mly_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio)
2173 struct mly_softc *sc = cam_sim_softc(sim);
2174 struct mly_command *mc;
2175 struct mly_command_scsi_small *ss;
2180 bus = cam_sim_bus(sim);
2181 target = csio->ccb_h.target_id;
2183 debug(2, "XPT_SCSI_IO %d:%d:%d", bus, target, csio->ccb_h.target_lun);
2185 /* validate bus number */
2186 if (!MLY_BUS_IS_VALID(sc, bus)) {
2187 debug(0, " invalid bus %d", bus);
2188 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2191 /* check for I/O attempt to a protected device */
2192 if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_PROTECTED) {
2193 debug(2, " device protected");
2194 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2197 /* check for I/O attempt to nonexistent device */
2198 if (!(sc->mly_btl[bus][target].mb_flags & (MLY_BTL_LOGICAL | MLY_BTL_PHYSICAL))) {
2199 debug(2, " device %d:%d does not exist", bus, target);
2200 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2203 /* XXX increase if/when we support large SCSI commands */
2204 if (csio->cdb_len > MLY_CMD_SCSI_SMALL_CDB) {
2205 debug(0, " command too large (%d > %d)", csio->cdb_len, MLY_CMD_SCSI_SMALL_CDB);
2206 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2209 /* check that the CDB pointer is not to a physical address */
2210 if ((csio->ccb_h.flags & CAM_CDB_POINTER) && (csio->ccb_h.flags & CAM_CDB_PHYS)) {
2211 debug(0, " CDB pointer is to physical address");
2212 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2215 /* abandon aborted ccbs or those that have failed validation */
2216 if ((csio->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
2217 debug(2, "abandoning CCB due to abort/validation failure");
2222 * Get a command, or push the ccb back to CAM and freeze the queue.
2224 if ((error = mly_alloc_command(sc, &mc))) {
2226 xpt_freeze_simq(sim, 1);
2227 csio->ccb_h.status |= CAM_REQUEUE_REQ;
2228 sc->mly_qfrzn_cnt++;
2233 /* build the command */
2235 mc->mc_length = csio->dxfer_len;
2236 mc->mc_complete = mly_cam_complete;
2237 mc->mc_private = csio;
2238 mc->mc_flags |= MLY_CMD_CCB;
2239 /* XXX This code doesn't set the data direction in mc_flags. */
2241 /* save the bus number in the ccb for later recovery XXX should be a better way */
2242 csio->ccb_h.sim_priv.entries[0].field = bus;
2244 /* build the packet for the controller */
2245 ss = &mc->mc_packet->scsi_small;
2246 ss->opcode = MDACMD_SCSI;
2247 if (csio->ccb_h.flags & CAM_DIS_DISCONNECT)
2248 ss->command_control.disable_disconnect = 1;
2249 if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT)
2250 ss->command_control.data_direction = MLY_CCB_WRITE;
2251 ss->data_size = csio->dxfer_len;
2252 ss->addr.phys.lun = csio->ccb_h.target_lun;
2253 ss->addr.phys.target = csio->ccb_h.target_id;
2254 ss->addr.phys.channel = bus;
2255 if (csio->ccb_h.timeout < (60 * 1000)) {
2256 ss->timeout.value = csio->ccb_h.timeout / 1000;
2257 ss->timeout.scale = MLY_TIMEOUT_SECONDS;
2258 } else if (csio->ccb_h.timeout < (60 * 60 * 1000)) {
2259 ss->timeout.value = csio->ccb_h.timeout / (60 * 1000);
2260 ss->timeout.scale = MLY_TIMEOUT_MINUTES;
2262 ss->timeout.value = csio->ccb_h.timeout / (60 * 60 * 1000); /* overflow? */
2263 ss->timeout.scale = MLY_TIMEOUT_HOURS;
2265 ss->maximum_sense_size = csio->sense_len;
2266 ss->cdb_length = csio->cdb_len;
2267 if (csio->ccb_h.flags & CAM_CDB_POINTER) {
2268 bcopy(csio->cdb_io.cdb_ptr, ss->cdb, csio->cdb_len);
2270 bcopy(csio->cdb_io.cdb_bytes, ss->cdb, csio->cdb_len);
2273 /* give the command to the controller */
2274 if ((error = mly_start(mc))) {
2276 xpt_freeze_simq(sim, 1);
2277 csio->ccb_h.status |= CAM_REQUEUE_REQ;
2278 sc->mly_qfrzn_cnt++;
2286 /********************************************************************************
2287 * Check for possibly-completed commands.
2290 mly_cam_poll(struct cam_sim *sim)
2292 struct mly_softc *sc = cam_sim_softc(sim);
2299 /********************************************************************************
2300 * Handle completion of a command - pass results back through the CCB
2303 mly_cam_complete(struct mly_command *mc)
2305 struct mly_softc *sc = mc->mc_sc;
2306 struct ccb_scsiio *csio = (struct ccb_scsiio *)mc->mc_private;
2307 struct scsi_inquiry_data *inq = (struct scsi_inquiry_data *)csio->data_ptr;
2308 struct mly_btl *btl;
2315 csio->scsi_status = mc->mc_status;
2316 switch(mc->mc_status) {
2317 case SCSI_STATUS_OK:
2319 * In order to report logical device type and status, we overwrite
2320 * the result of the INQUIRY command to logical devices.
2322 bus = csio->ccb_h.sim_priv.entries[0].field;
2323 target = csio->ccb_h.target_id;
2324 /* XXX validate bus/target? */
2325 if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_LOGICAL) {
2326 if (csio->ccb_h.flags & CAM_CDB_POINTER) {
2327 cmd = *csio->cdb_io.cdb_ptr;
2329 cmd = csio->cdb_io.cdb_bytes[0];
2331 if (cmd == INQUIRY) {
2332 btl = &sc->mly_btl[bus][target];
2333 padstr(inq->vendor, mly_describe_code(mly_table_device_type, btl->mb_type), 8);
2334 padstr(inq->product, mly_describe_code(mly_table_device_state, btl->mb_state), 16);
2335 padstr(inq->revision, "", 4);
2339 debug(2, "SCSI_STATUS_OK");
2340 csio->ccb_h.status = CAM_REQ_CMP;
2343 case SCSI_STATUS_CHECK_COND:
2344 debug(1, "SCSI_STATUS_CHECK_COND sense %d resid %d", mc->mc_sense, mc->mc_resid);
2345 csio->ccb_h.status = CAM_SCSI_STATUS_ERROR;
2346 bzero(&csio->sense_data, SSD_FULL_SIZE);
2347 bcopy(mc->mc_packet, &csio->sense_data, mc->mc_sense);
2348 csio->sense_len = mc->mc_sense;
2349 csio->ccb_h.status |= CAM_AUTOSNS_VALID;
2350 csio->resid = mc->mc_resid; /* XXX this is a signed value... */
2353 case SCSI_STATUS_BUSY:
2354 debug(1, "SCSI_STATUS_BUSY");
2355 csio->ccb_h.status = CAM_SCSI_BUSY;
2359 debug(1, "unknown status 0x%x", csio->scsi_status);
2360 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2365 if (sc->mly_qfrzn_cnt) {
2366 csio->ccb_h.status |= CAM_RELEASE_SIMQ;
2367 sc->mly_qfrzn_cnt--;
2371 xpt_done((union ccb *)csio);
2372 mly_release_command(mc);
2375 /********************************************************************************
2376 * Find a peripheral attahed at (bus),(target)
2378 static struct cam_periph *
2379 mly_find_periph(struct mly_softc *sc, int bus, int target)
2381 struct cam_periph *periph;
2382 struct cam_path *path;
2385 status = xpt_create_path(&path, NULL, cam_sim_path(sc->mly_cam_sim[bus]), target, 0);
2386 if (status == CAM_REQ_CMP) {
2387 periph = cam_periph_find(path, NULL);
2388 xpt_free_path(path);
2395 /********************************************************************************
2396 * Name the device at (bus)(target)
2399 mly_name_device(struct mly_softc *sc, int bus, int target)
2401 struct cam_periph *periph;
2403 if ((periph = mly_find_periph(sc, bus, target)) != NULL) {
2404 sprintf(sc->mly_btl[bus][target].mb_name, "%s%d", periph->periph_name, periph->unit_number);
2407 sc->mly_btl[bus][target].mb_name[0] = 0;
2411 /********************************************************************************
2412 ********************************************************************************
2414 ********************************************************************************
2415 ********************************************************************************/
2417 /********************************************************************************
2418 * Handshake with the firmware while the card is being initialised.
2421 mly_fwhandshake(struct mly_softc *sc)
2423 u_int8_t error, param0, param1;
2428 /* set HM_STSACK and let the firmware initialise */
2429 MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_STSACK);
2430 DELAY(1000); /* too short? */
2432 /* if HM_STSACK is still true, the controller is initialising */
2433 if (!MLY_IDBR_TRUE(sc, MLY_HM_STSACK))
2435 mly_printf(sc, "controller initialisation started\n");
2437 /* spin waiting for initialisation to finish, or for a message to be delivered */
2438 while (MLY_IDBR_TRUE(sc, MLY_HM_STSACK)) {
2439 /* check for a message */
2440 if (MLY_ERROR_VALID(sc)) {
2441 error = MLY_GET_REG(sc, sc->mly_error_status) & ~MLY_MSG_EMPTY;
2442 param0 = MLY_GET_REG(sc, sc->mly_command_mailbox);
2443 param1 = MLY_GET_REG(sc, sc->mly_command_mailbox + 1);
2446 case MLY_MSG_SPINUP:
2448 mly_printf(sc, "drive spinup in progress\n");
2449 spinup = 1; /* only print this once (should print drive being spun?) */
2452 case MLY_MSG_RACE_RECOVERY_FAIL:
2453 mly_printf(sc, "mirror race recovery failed, one or more drives offline\n");
2455 case MLY_MSG_RACE_IN_PROGRESS:
2456 mly_printf(sc, "mirror race recovery in progress\n");
2458 case MLY_MSG_RACE_ON_CRITICAL:
2459 mly_printf(sc, "mirror race recovery on a critical drive\n");
2461 case MLY_MSG_PARITY_ERROR:
2462 mly_printf(sc, "FATAL MEMORY PARITY ERROR\n");
2465 mly_printf(sc, "unknown initialisation code 0x%x\n", error);
2472 /********************************************************************************
2473 ********************************************************************************
2474 Debugging and Diagnostics
2475 ********************************************************************************
2476 ********************************************************************************/
2478 /********************************************************************************
2479 * Print some information about the controller.
2482 mly_describe_controller(struct mly_softc *sc)
2484 struct mly_ioctl_getcontrollerinfo *mi = sc->mly_controllerinfo;
2486 mly_printf(sc, "%16s, %d channel%s, firmware %d.%02d-%d-%02d (%02d%02d%02d%02d), %dMB RAM\n",
2487 mi->controller_name, mi->physical_channels_present, (mi->physical_channels_present) > 1 ? "s" : "",
2488 mi->fw_major, mi->fw_minor, mi->fw_turn, mi->fw_build, /* XXX turn encoding? */
2489 mi->fw_century, mi->fw_year, mi->fw_month, mi->fw_day,
2493 mly_printf(sc, "%s %s (%x), %dMHz %d-bit %.16s\n",
2494 mly_describe_code(mly_table_oemname, mi->oem_information),
2495 mly_describe_code(mly_table_controllertype, mi->controller_type), mi->controller_type,
2496 mi->interface_speed, mi->interface_width, mi->interface_name);
2497 mly_printf(sc, "%dMB %dMHz %d-bit %s%s%s, cache %dMB\n",
2498 mi->memory_size, mi->memory_speed, mi->memory_width,
2499 mly_describe_code(mly_table_memorytype, mi->memory_type),
2500 mi->memory_parity ? "+parity": "",mi->memory_ecc ? "+ECC": "",
2502 mly_printf(sc, "CPU: %s @ %dMHz\n",
2503 mly_describe_code(mly_table_cputype, mi->cpu[0].type), mi->cpu[0].speed);
2504 if (mi->l2cache_size != 0)
2505 mly_printf(sc, "%dKB L2 cache\n", mi->l2cache_size);
2506 if (mi->exmemory_size != 0)
2507 mly_printf(sc, "%dMB %dMHz %d-bit private %s%s%s\n",
2508 mi->exmemory_size, mi->exmemory_speed, mi->exmemory_width,
2509 mly_describe_code(mly_table_memorytype, mi->exmemory_type),
2510 mi->exmemory_parity ? "+parity": "",mi->exmemory_ecc ? "+ECC": "");
2511 mly_printf(sc, "battery backup %s\n", mi->bbu_present ? "present" : "not installed");
2512 mly_printf(sc, "maximum data transfer %d blocks, maximum sg entries/command %d\n",
2513 mi->maximum_block_count, mi->maximum_sg_entries);
2514 mly_printf(sc, "logical devices present/critical/offline %d/%d/%d\n",
2515 mi->logical_devices_present, mi->logical_devices_critical, mi->logical_devices_offline);
2516 mly_printf(sc, "physical devices present %d\n",
2517 mi->physical_devices_present);
2518 mly_printf(sc, "physical disks present/offline %d/%d\n",
2519 mi->physical_disks_present, mi->physical_disks_offline);
2520 mly_printf(sc, "%d physical channel%s, %d virtual channel%s of %d possible\n",
2521 mi->physical_channels_present, mi->physical_channels_present == 1 ? "" : "s",
2522 mi->virtual_channels_present, mi->virtual_channels_present == 1 ? "" : "s",
2523 mi->virtual_channels_possible);
2524 mly_printf(sc, "%d parallel commands supported\n", mi->maximum_parallel_commands);
2525 mly_printf(sc, "%dMB flash ROM, %d of %d maximum cycles\n",
2526 mi->flash_size, mi->flash_age, mi->flash_maximum_age);
2531 /********************************************************************************
2532 * Print some controller state
2535 mly_printstate(struct mly_softc *sc)
2537 mly_printf(sc, "IDBR %02x ODBR %02x ERROR %02x (%x %x %x)\n",
2538 MLY_GET_REG(sc, sc->mly_idbr),
2539 MLY_GET_REG(sc, sc->mly_odbr),
2540 MLY_GET_REG(sc, sc->mly_error_status),
2543 sc->mly_error_status);
2544 mly_printf(sc, "IMASK %02x ISTATUS %02x\n",
2545 MLY_GET_REG(sc, sc->mly_interrupt_mask),
2546 MLY_GET_REG(sc, sc->mly_interrupt_status));
2547 mly_printf(sc, "COMMAND %02x %02x %02x %02x %02x %02x %02x %02x\n",
2548 MLY_GET_REG(sc, sc->mly_command_mailbox),
2549 MLY_GET_REG(sc, sc->mly_command_mailbox + 1),
2550 MLY_GET_REG(sc, sc->mly_command_mailbox + 2),
2551 MLY_GET_REG(sc, sc->mly_command_mailbox + 3),
2552 MLY_GET_REG(sc, sc->mly_command_mailbox + 4),
2553 MLY_GET_REG(sc, sc->mly_command_mailbox + 5),
2554 MLY_GET_REG(sc, sc->mly_command_mailbox + 6),
2555 MLY_GET_REG(sc, sc->mly_command_mailbox + 7));
2556 mly_printf(sc, "STATUS %02x %02x %02x %02x %02x %02x %02x %02x\n",
2557 MLY_GET_REG(sc, sc->mly_status_mailbox),
2558 MLY_GET_REG(sc, sc->mly_status_mailbox + 1),
2559 MLY_GET_REG(sc, sc->mly_status_mailbox + 2),
2560 MLY_GET_REG(sc, sc->mly_status_mailbox + 3),
2561 MLY_GET_REG(sc, sc->mly_status_mailbox + 4),
2562 MLY_GET_REG(sc, sc->mly_status_mailbox + 5),
2563 MLY_GET_REG(sc, sc->mly_status_mailbox + 6),
2564 MLY_GET_REG(sc, sc->mly_status_mailbox + 7));
2565 mly_printf(sc, " %04x %08x\n",
2566 MLY_GET_REG2(sc, sc->mly_status_mailbox),
2567 MLY_GET_REG4(sc, sc->mly_status_mailbox + 4));
2570 struct mly_softc *mly_softc0 = NULL;
2572 mly_printstate0(void)
2574 if (mly_softc0 != NULL)
2575 mly_printstate(mly_softc0);
2578 /********************************************************************************
2582 mly_print_command(struct mly_command *mc)
2584 struct mly_softc *sc = mc->mc_sc;
2586 mly_printf(sc, "COMMAND @ %p\n", mc);
2587 mly_printf(sc, " slot %d\n", mc->mc_slot);
2588 mly_printf(sc, " status 0x%x\n", mc->mc_status);
2589 mly_printf(sc, " sense len %d\n", mc->mc_sense);
2590 mly_printf(sc, " resid %d\n", mc->mc_resid);
2591 mly_printf(sc, " packet %p/0x%llx\n", mc->mc_packet, mc->mc_packetphys);
2592 if (mc->mc_packet != NULL)
2593 mly_print_packet(mc);
2594 mly_printf(sc, " data %p/%d\n", mc->mc_data, mc->mc_length);
2595 mly_printf(sc, " flags %b\n", mc->mc_flags, "\20\1busy\2complete\3slotted\4mapped\5datain\6dataout\n");
2596 mly_printf(sc, " complete %p\n", mc->mc_complete);
2597 mly_printf(sc, " private %p\n", mc->mc_private);
2600 /********************************************************************************
2601 * Print a command packet
2604 mly_print_packet(struct mly_command *mc)
2606 struct mly_softc *sc = mc->mc_sc;
2607 struct mly_command_generic *ge = (struct mly_command_generic *)mc->mc_packet;
2608 struct mly_command_scsi_small *ss = (struct mly_command_scsi_small *)mc->mc_packet;
2609 struct mly_command_scsi_large *sl = (struct mly_command_scsi_large *)mc->mc_packet;
2610 struct mly_command_ioctl *io = (struct mly_command_ioctl *)mc->mc_packet;
2613 mly_printf(sc, " command_id %d\n", ge->command_id);
2614 mly_printf(sc, " opcode %d\n", ge->opcode);
2615 mly_printf(sc, " command_control fua %d dpo %d est %d dd %s nas %d ddis %d\n",
2616 ge->command_control.force_unit_access,
2617 ge->command_control.disable_page_out,
2618 ge->command_control.extended_sg_table,
2619 (ge->command_control.data_direction == MLY_CCB_WRITE) ? "WRITE" : "READ",
2620 ge->command_control.no_auto_sense,
2621 ge->command_control.disable_disconnect);
2622 mly_printf(sc, " data_size %d\n", ge->data_size);
2623 mly_printf(sc, " sense_buffer_address 0x%llx\n", ge->sense_buffer_address);
2624 mly_printf(sc, " lun %d\n", ge->addr.phys.lun);
2625 mly_printf(sc, " target %d\n", ge->addr.phys.target);
2626 mly_printf(sc, " channel %d\n", ge->addr.phys.channel);
2627 mly_printf(sc, " logical device %d\n", ge->addr.log.logdev);
2628 mly_printf(sc, " controller %d\n", ge->addr.phys.controller);
2629 mly_printf(sc, " timeout %d %s\n",
2631 (ge->timeout.scale == MLY_TIMEOUT_SECONDS) ? "seconds" :
2632 ((ge->timeout.scale == MLY_TIMEOUT_MINUTES) ? "minutes" : "hours"));
2633 mly_printf(sc, " maximum_sense_size %d\n", ge->maximum_sense_size);
2634 switch(ge->opcode) {
2637 mly_printf(sc, " cdb length %d\n", ss->cdb_length);
2638 mly_printf(sc, " cdb %*D\n", ss->cdb_length, ss->cdb, " ");
2642 case MDACMD_SCSILCPT:
2643 mly_printf(sc, " cdb length %d\n", sl->cdb_length);
2644 mly_printf(sc, " cdb 0x%llx\n", sl->cdb_physaddr);
2648 mly_printf(sc, " sub_ioctl 0x%x\n", io->sub_ioctl);
2649 switch(io->sub_ioctl) {
2650 case MDACIOCTL_SETMEMORYMAILBOX:
2651 mly_printf(sc, " health_buffer_size %d\n",
2652 io->param.setmemorymailbox.health_buffer_size);
2653 mly_printf(sc, " health_buffer_phys 0x%llx\n",
2654 io->param.setmemorymailbox.health_buffer_physaddr);
2655 mly_printf(sc, " command_mailbox 0x%llx\n",
2656 io->param.setmemorymailbox.command_mailbox_physaddr);
2657 mly_printf(sc, " status_mailbox 0x%llx\n",
2658 io->param.setmemorymailbox.status_mailbox_physaddr);
2662 case MDACIOCTL_SETREALTIMECLOCK:
2663 case MDACIOCTL_GETHEALTHSTATUS:
2664 case MDACIOCTL_GETCONTROLLERINFO:
2665 case MDACIOCTL_GETLOGDEVINFOVALID:
2666 case MDACIOCTL_GETPHYSDEVINFOVALID:
2667 case MDACIOCTL_GETPHYSDEVSTATISTICS:
2668 case MDACIOCTL_GETLOGDEVSTATISTICS:
2669 case MDACIOCTL_GETCONTROLLERSTATISTICS:
2670 case MDACIOCTL_GETBDT_FOR_SYSDRIVE:
2671 case MDACIOCTL_CREATENEWCONF:
2672 case MDACIOCTL_ADDNEWCONF:
2673 case MDACIOCTL_GETDEVCONFINFO:
2674 case MDACIOCTL_GETFREESPACELIST:
2675 case MDACIOCTL_MORE:
2676 case MDACIOCTL_SETPHYSDEVPARAMETER:
2677 case MDACIOCTL_GETPHYSDEVPARAMETER:
2678 case MDACIOCTL_GETLOGDEVPARAMETER:
2679 case MDACIOCTL_SETLOGDEVPARAMETER:
2680 mly_printf(sc, " param %10D\n", io->param.data.param, " ");
2684 case MDACIOCTL_GETEVENT:
2685 mly_printf(sc, " event %d\n",
2686 io->param.getevent.sequence_number_low + ((u_int32_t)io->addr.log.logdev << 16));
2690 case MDACIOCTL_SETRAIDDEVSTATE:
2691 mly_printf(sc, " state %d\n", io->param.setraiddevstate.state);
2695 case MDACIOCTL_XLATEPHYSDEVTORAIDDEV:
2696 mly_printf(sc, " raid_device %d\n", io->param.xlatephysdevtoraiddev.raid_device);
2697 mly_printf(sc, " controller %d\n", io->param.xlatephysdevtoraiddev.controller);
2698 mly_printf(sc, " channel %d\n", io->param.xlatephysdevtoraiddev.channel);
2699 mly_printf(sc, " target %d\n", io->param.xlatephysdevtoraiddev.target);
2700 mly_printf(sc, " lun %d\n", io->param.xlatephysdevtoraiddev.lun);
2704 case MDACIOCTL_GETGROUPCONFINFO:
2705 mly_printf(sc, " group %d\n", io->param.getgroupconfinfo.group);
2709 case MDACIOCTL_GET_SUBSYSTEM_DATA:
2710 case MDACIOCTL_SET_SUBSYSTEM_DATA:
2711 case MDACIOCTL_STARTDISOCVERY:
2712 case MDACIOCTL_INITPHYSDEVSTART:
2713 case MDACIOCTL_INITPHYSDEVSTOP:
2714 case MDACIOCTL_INITRAIDDEVSTART:
2715 case MDACIOCTL_INITRAIDDEVSTOP:
2716 case MDACIOCTL_REBUILDRAIDDEVSTART:
2717 case MDACIOCTL_REBUILDRAIDDEVSTOP:
2718 case MDACIOCTL_MAKECONSISTENTDATASTART:
2719 case MDACIOCTL_MAKECONSISTENTDATASTOP:
2720 case MDACIOCTL_CONSISTENCYCHECKSTART:
2721 case MDACIOCTL_CONSISTENCYCHECKSTOP:
2722 case MDACIOCTL_RESETDEVICE:
2723 case MDACIOCTL_FLUSHDEVICEDATA:
2724 case MDACIOCTL_PAUSEDEVICE:
2725 case MDACIOCTL_UNPAUSEDEVICE:
2726 case MDACIOCTL_LOCATEDEVICE:
2727 case MDACIOCTL_SETMASTERSLAVEMODE:
2728 case MDACIOCTL_DELETERAIDDEV:
2729 case MDACIOCTL_REPLACEINTERNALDEV:
2730 case MDACIOCTL_CLEARCONF:
2731 case MDACIOCTL_GETCONTROLLERPARAMETER:
2732 case MDACIOCTL_SETCONTRLLERPARAMETER:
2733 case MDACIOCTL_CLEARCONFSUSPMODE:
2734 case MDACIOCTL_STOREIMAGE:
2735 case MDACIOCTL_READIMAGE:
2736 case MDACIOCTL_FLASHIMAGES:
2737 case MDACIOCTL_RENAMERAIDDEV:
2738 default: /* no idea what to print */
2744 case MDACMD_IOCTLCHECK:
2745 case MDACMD_MEMCOPY:
2748 break; /* print nothing */
2751 if (ge->command_control.extended_sg_table) {
2752 mly_printf(sc, " sg table 0x%llx/%d\n",
2753 ge->transfer.indirect.table_physaddr[0], ge->transfer.indirect.entries[0]);
2755 mly_printf(sc, " 0000 0x%llx/%lld\n",
2756 ge->transfer.direct.sg[0].physaddr, ge->transfer.direct.sg[0].length);
2757 mly_printf(sc, " 0001 0x%llx/%lld\n",
2758 ge->transfer.direct.sg[1].physaddr, ge->transfer.direct.sg[1].length);
2763 /********************************************************************************
2764 * Panic in a slightly informative fashion
2767 mly_panic(struct mly_softc *sc, char *reason)
2773 /********************************************************************************
2774 * Print queue statistics, callable from DDB.
2777 mly_print_controller(int controller)
2779 struct mly_softc *sc;
2781 if ((sc = devclass_get_softc(devclass_find("mly"), controller)) == NULL) {
2782 printf("mly: controller %d invalid\n", controller);
2784 device_printf(sc->mly_dev, "queue curr max\n");
2785 device_printf(sc->mly_dev, "free %04d/%04d\n",
2786 sc->mly_qstat[MLYQ_FREE].q_length, sc->mly_qstat[MLYQ_FREE].q_max);
2787 device_printf(sc->mly_dev, "busy %04d/%04d\n",
2788 sc->mly_qstat[MLYQ_BUSY].q_length, sc->mly_qstat[MLYQ_BUSY].q_max);
2789 device_printf(sc->mly_dev, "complete %04d/%04d\n",
2790 sc->mly_qstat[MLYQ_COMPLETE].q_length, sc->mly_qstat[MLYQ_COMPLETE].q_max);
2796 /********************************************************************************
2797 ********************************************************************************
2798 Control device interface
2799 ********************************************************************************
2800 ********************************************************************************/
2802 /********************************************************************************
2803 * Accept an open operation on the control device.
2806 mly_user_open(struct cdev *dev, int flags, int fmt, struct thread *td)
2808 struct mly_softc *sc = dev->si_drv1;
2810 sc->mly_state |= MLY_STATE_OPEN;
2814 /********************************************************************************
2815 * Accept the last close on the control device.
2818 mly_user_close(struct cdev *dev, int flags, int fmt, struct thread *td)
2820 struct mly_softc *sc = dev->si_drv1;
2822 sc->mly_state &= ~MLY_STATE_OPEN;
2826 /********************************************************************************
2827 * Handle controller-specific control operations.
2830 mly_user_ioctl(struct cdev *dev, u_long cmd, caddr_t addr,
2831 int32_t flag, struct thread *td)
2833 struct mly_softc *sc = (struct mly_softc *)dev->si_drv1;
2834 struct mly_user_command *uc = (struct mly_user_command *)addr;
2835 struct mly_user_health *uh = (struct mly_user_health *)addr;
2839 return(mly_user_command(sc, uc));
2841 return(mly_user_health(sc, uh));
2847 /********************************************************************************
2848 * Execute a command passed in from userspace.
2850 * The control structure contains the actual command for the controller, as well
2851 * as the user-space data pointer and data size, and an optional sense buffer
2852 * size/pointer. On completion, the data size is adjusted to the command
2853 * residual, and the sense buffer size to the size of the returned sense data.
2857 mly_user_command(struct mly_softc *sc, struct mly_user_command *uc)
2859 struct mly_command *mc;
2862 /* allocate a command */
2863 if (mly_alloc_command(sc, &mc)) {
2865 goto out; /* XXX Linux version will wait for a command */
2868 /* handle data size/direction */
2869 mc->mc_length = (uc->DataTransferLength >= 0) ? uc->DataTransferLength : -uc->DataTransferLength;
2870 if (mc->mc_length > 0) {
2871 if ((mc->mc_data = malloc(mc->mc_length, M_DEVBUF, M_NOWAIT)) == NULL) {
2876 if (uc->DataTransferLength > 0) {
2877 mc->mc_flags |= MLY_CMD_DATAIN;
2878 bzero(mc->mc_data, mc->mc_length);
2880 if (uc->DataTransferLength < 0) {
2881 mc->mc_flags |= MLY_CMD_DATAOUT;
2882 if ((error = copyin(uc->DataTransferBuffer, mc->mc_data, mc->mc_length)) != 0)
2886 /* copy the controller command */
2887 bcopy(&uc->CommandMailbox, mc->mc_packet, sizeof(uc->CommandMailbox));
2889 /* clear command completion handler so that we get woken up */
2890 mc->mc_complete = NULL;
2892 /* execute the command */
2893 if ((error = mly_start(mc)) != 0)
2896 while (!(mc->mc_flags & MLY_CMD_COMPLETE))
2897 tsleep(mc, PRIBIO, "mlyioctl", 0);
2900 /* return the data to userspace */
2901 if (uc->DataTransferLength > 0)
2902 if ((error = copyout(mc->mc_data, uc->DataTransferBuffer, mc->mc_length)) != 0)
2905 /* return the sense buffer to userspace */
2906 if ((uc->RequestSenseLength > 0) && (mc->mc_sense > 0)) {
2907 if ((error = copyout(mc->mc_packet, uc->RequestSenseBuffer,
2908 min(uc->RequestSenseLength, mc->mc_sense))) != 0)
2912 /* return command results to userspace (caller will copy out) */
2913 uc->DataTransferLength = mc->mc_resid;
2914 uc->RequestSenseLength = min(uc->RequestSenseLength, mc->mc_sense);
2915 uc->CommandStatus = mc->mc_status;
2919 if (mc->mc_data != NULL)
2920 free(mc->mc_data, M_DEVBUF);
2922 mly_release_command(mc);
2926 /********************************************************************************
2927 * Return health status to userspace. If the health change index in the user
2928 * structure does not match that currently exported by the controller, we
2929 * return the current status immediately. Otherwise, we block until either
2930 * interrupted or new status is delivered.
2933 mly_user_health(struct mly_softc *sc, struct mly_user_health *uh)
2935 struct mly_health_status mh;
2938 /* fetch the current health status from userspace */
2939 if ((error = copyin(uh->HealthStatusBuffer, &mh, sizeof(mh))) != 0)
2942 /* spin waiting for a status update */
2944 error = EWOULDBLOCK;
2945 while ((error != 0) && (sc->mly_event_change == mh.change_counter))
2946 error = tsleep(&sc->mly_event_change, PRIBIO | PCATCH, "mlyhealth", 0);
2949 /* copy the controller's health status buffer out (there is a race here if it changes again) */
2950 error = copyout(&sc->mly_mmbox->mmm_health.status, uh->HealthStatusBuffer,
2951 sizeof(uh->HealthStatusBuffer));
2957 mly_timeout(struct mly_softc *sc)
2959 struct mly_command *mc;
2962 deadline = time_second - MLY_CMD_TIMEOUT;
2963 TAILQ_FOREACH(mc, &sc->mly_busy, mc_link) {
2964 if ((mc->mc_timestamp < deadline)) {
2965 device_printf(sc->mly_dev,
2966 "COMMAND %p TIMEOUT AFTER %d SECONDS\n", mc,
2967 (int)(time_second - mc->mc_timestamp));
2971 timeout((timeout_t *)mly_timeout, sc, MLY_CMD_TIMEOUT * hz);