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_rescan_callback(struct cam_periph *periph, union ccb *ccb);
105 static void mly_cam_action(struct cam_sim *sim, union ccb *ccb);
106 static int mly_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio);
107 static void mly_cam_poll(struct cam_sim *sim);
108 static void mly_cam_complete(struct mly_command *mc);
109 static struct cam_periph *mly_find_periph(struct mly_softc *sc, int bus, int target);
110 static int mly_name_device(struct mly_softc *sc, int bus, int target);
112 static int mly_fwhandshake(struct mly_softc *sc);
114 static void mly_describe_controller(struct mly_softc *sc);
116 static void mly_printstate(struct mly_softc *sc);
117 static void mly_print_command(struct mly_command *mc);
118 static void mly_print_packet(struct mly_command *mc);
119 static void mly_panic(struct mly_softc *sc, char *reason);
121 void mly_print_controller(int controller);
122 static int mly_timeout(struct mly_softc *sc);
125 static d_open_t mly_user_open;
126 static d_close_t mly_user_close;
127 static d_ioctl_t mly_user_ioctl;
128 static int mly_user_command(struct mly_softc *sc, struct mly_user_command *uc);
129 static int mly_user_health(struct mly_softc *sc, struct mly_user_health *uh);
131 #define MLY_CMD_TIMEOUT 20
133 static device_method_t mly_methods[] = {
134 /* Device interface */
135 DEVMETHOD(device_probe, mly_probe),
136 DEVMETHOD(device_attach, mly_attach),
137 DEVMETHOD(device_detach, mly_detach),
138 DEVMETHOD(device_shutdown, mly_shutdown),
142 static driver_t mly_pci_driver = {
145 sizeof(struct mly_softc)
148 static devclass_t mly_devclass;
149 DRIVER_MODULE(mly, pci, mly_pci_driver, mly_devclass, 0, 0);
150 MODULE_DEPEND(mly, pci, 1, 1, 1);
151 MODULE_DEPEND(mly, cam, 1, 1, 1);
153 static struct cdevsw mly_cdevsw = {
154 .d_version = D_VERSION,
155 .d_flags = D_NEEDGIANT,
156 .d_open = mly_user_open,
157 .d_close = mly_user_close,
158 .d_ioctl = mly_user_ioctl,
162 /********************************************************************************
163 ********************************************************************************
165 ********************************************************************************
166 ********************************************************************************/
168 static struct mly_ident
176 } mly_identifiers[] = {
177 {0x1069, 0xba56, 0x1069, 0x0040, MLY_HWIF_STRONGARM, "Mylex eXtremeRAID 2000"},
178 {0x1069, 0xba56, 0x1069, 0x0030, MLY_HWIF_STRONGARM, "Mylex eXtremeRAID 3000"},
179 {0x1069, 0x0050, 0x1069, 0x0050, MLY_HWIF_I960RX, "Mylex AcceleRAID 352"},
180 {0x1069, 0x0050, 0x1069, 0x0052, MLY_HWIF_I960RX, "Mylex AcceleRAID 170"},
181 {0x1069, 0x0050, 0x1069, 0x0054, MLY_HWIF_I960RX, "Mylex AcceleRAID 160"},
185 /********************************************************************************
186 * Compare the provided PCI device with the list we support.
189 mly_probe(device_t dev)
195 for (m = mly_identifiers; m->vendor != 0; m++) {
196 if ((m->vendor == pci_get_vendor(dev)) &&
197 (m->device == pci_get_device(dev)) &&
198 ((m->subvendor == 0) || ((m->subvendor == pci_get_subvendor(dev)) &&
199 (m->subdevice == pci_get_subdevice(dev))))) {
201 device_set_desc(dev, m->desc);
202 return(BUS_PROBE_DEFAULT); /* allow room to be overridden */
208 /********************************************************************************
209 * Initialise the controller and softc
212 mly_attach(device_t dev)
214 struct mly_softc *sc = device_get_softc(dev);
222 if (device_get_unit(sc->mly_dev) == 0)
227 * Do PCI-specific initialisation.
229 if ((error = mly_pci_attach(sc)) != 0)
233 * Initialise per-controller queues.
237 mly_initq_complete(sc);
240 * Initialise command-completion task.
242 TASK_INIT(&sc->mly_task_complete, 0, mly_complete, sc);
244 /* disable interrupts before we start talking to the controller */
245 MLY_MASK_INTERRUPTS(sc);
248 * Wait for the controller to come ready, handshake with the firmware if required.
249 * This is typically only necessary on platforms where the controller BIOS does not
252 if ((error = mly_fwhandshake(sc)))
256 * Allocate initial command buffers.
258 if ((error = mly_alloc_commands(sc)))
262 * Obtain controller feature information
264 if ((error = mly_get_controllerinfo(sc)))
268 * Reallocate command buffers now we know how many we want.
270 mly_release_commands(sc);
271 if ((error = mly_alloc_commands(sc)))
275 * Get the current event counter for health purposes, populate the initial
276 * health status buffer.
278 if ((error = mly_get_eventstatus(sc)))
282 * Enable memory-mailbox mode.
284 if ((error = mly_enable_mmbox(sc)))
290 if ((error = mly_cam_attach(sc)))
294 * Print a little information about the controller
296 mly_describe_controller(sc);
299 * Mark all attached devices for rescan.
301 mly_scan_devices(sc);
304 * Instigate the first status poll immediately. Rescan completions won't
305 * happen until interrupts are enabled, which should still be before
306 * the SCSI subsystem gets to us, courtesy of the "SCSI settling delay".
308 mly_periodic((void *)sc);
311 * Create the control device.
313 sc->mly_dev_t = make_dev(&mly_cdevsw, 0, UID_ROOT, GID_OPERATOR,
314 S_IRUSR | S_IWUSR, "mly%d", device_get_unit(sc->mly_dev));
315 sc->mly_dev_t->si_drv1 = sc;
317 /* enable interrupts now */
318 MLY_UNMASK_INTERRUPTS(sc);
321 timeout((timeout_t *)mly_timeout, sc, MLY_CMD_TIMEOUT * hz);
330 /********************************************************************************
331 * Perform PCI-specific initialisation.
334 mly_pci_attach(struct mly_softc *sc)
341 /* assume failure is 'not configured' */
345 * Verify that the adapter is correctly set up in PCI space.
347 * XXX we shouldn't do this; the PCI code should.
349 command = pci_read_config(sc->mly_dev, PCIR_COMMAND, 2);
350 command |= PCIM_CMD_BUSMASTEREN;
351 pci_write_config(sc->mly_dev, PCIR_COMMAND, command, 2);
352 command = pci_read_config(sc->mly_dev, PCIR_COMMAND, 2);
353 if (!(command & PCIM_CMD_BUSMASTEREN)) {
354 mly_printf(sc, "can't enable busmaster feature\n");
357 if ((command & PCIM_CMD_MEMEN) == 0) {
358 mly_printf(sc, "memory window not available\n");
363 * Allocate the PCI register window.
365 sc->mly_regs_rid = PCIR_BAR(0); /* first base address register */
366 if ((sc->mly_regs_resource = bus_alloc_resource_any(sc->mly_dev,
367 SYS_RES_MEMORY, &sc->mly_regs_rid, RF_ACTIVE)) == NULL) {
368 mly_printf(sc, "can't allocate register window\n");
371 sc->mly_btag = rman_get_bustag(sc->mly_regs_resource);
372 sc->mly_bhandle = rman_get_bushandle(sc->mly_regs_resource);
375 * Allocate and connect our interrupt.
378 if ((sc->mly_irq = bus_alloc_resource_any(sc->mly_dev, SYS_RES_IRQ,
379 &sc->mly_irq_rid, RF_SHAREABLE | RF_ACTIVE)) == NULL) {
380 mly_printf(sc, "can't allocate interrupt\n");
383 if (bus_setup_intr(sc->mly_dev, sc->mly_irq, INTR_TYPE_CAM | INTR_ENTROPY, NULL, mly_intr, sc, &sc->mly_intr)) {
384 mly_printf(sc, "can't set up interrupt\n");
388 /* assume failure is 'out of memory' */
392 * Allocate the parent bus DMA tag appropriate for our PCI interface.
394 * Note that all of these controllers are 64-bit capable.
396 if (bus_dma_tag_create(NULL, /* parent */
397 1, 0, /* alignment, boundary */
398 BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
399 BUS_SPACE_MAXADDR, /* highaddr */
400 NULL, NULL, /* filter, filterarg */
401 MAXBSIZE, MLY_MAX_SGENTRIES, /* maxsize, nsegments */
402 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
403 BUS_DMA_ALLOCNOW, /* flags */
406 &sc->mly_parent_dmat)) {
407 mly_printf(sc, "can't allocate parent DMA tag\n");
412 * Create DMA tag for mapping buffers into controller-addressable space.
414 if (bus_dma_tag_create(sc->mly_parent_dmat, /* parent */
415 1, 0, /* alignment, boundary */
416 BUS_SPACE_MAXADDR, /* lowaddr */
417 BUS_SPACE_MAXADDR, /* highaddr */
418 NULL, NULL, /* filter, filterarg */
419 MAXBSIZE, MLY_MAX_SGENTRIES, /* maxsize, nsegments */
420 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
422 busdma_lock_mutex, /* lockfunc */
423 &Giant, /* lockarg */
424 &sc->mly_buffer_dmat)) {
425 mly_printf(sc, "can't allocate buffer DMA tag\n");
430 * Initialise the DMA tag for command packets.
432 if (bus_dma_tag_create(sc->mly_parent_dmat, /* parent */
433 1, 0, /* alignment, boundary */
434 BUS_SPACE_MAXADDR, /* lowaddr */
435 BUS_SPACE_MAXADDR, /* highaddr */
436 NULL, NULL, /* filter, filterarg */
437 sizeof(union mly_command_packet) * MLY_MAX_COMMANDS, 1, /* maxsize, nsegments */
438 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
439 BUS_DMA_ALLOCNOW, /* flags */
440 NULL, NULL, /* lockfunc, lockarg */
441 &sc->mly_packet_dmat)) {
442 mly_printf(sc, "can't allocate command packet DMA tag\n");
447 * Detect the hardware interface version
449 for (i = 0; mly_identifiers[i].vendor != 0; i++) {
450 if ((mly_identifiers[i].vendor == pci_get_vendor(sc->mly_dev)) &&
451 (mly_identifiers[i].device == pci_get_device(sc->mly_dev))) {
452 sc->mly_hwif = mly_identifiers[i].hwif;
453 switch(sc->mly_hwif) {
454 case MLY_HWIF_I960RX:
455 debug(1, "set hardware up for i960RX");
456 sc->mly_doorbell_true = 0x00;
457 sc->mly_command_mailbox = MLY_I960RX_COMMAND_MAILBOX;
458 sc->mly_status_mailbox = MLY_I960RX_STATUS_MAILBOX;
459 sc->mly_idbr = MLY_I960RX_IDBR;
460 sc->mly_odbr = MLY_I960RX_ODBR;
461 sc->mly_error_status = MLY_I960RX_ERROR_STATUS;
462 sc->mly_interrupt_status = MLY_I960RX_INTERRUPT_STATUS;
463 sc->mly_interrupt_mask = MLY_I960RX_INTERRUPT_MASK;
465 case MLY_HWIF_STRONGARM:
466 debug(1, "set hardware up for StrongARM");
467 sc->mly_doorbell_true = 0xff; /* doorbell 'true' is 0 */
468 sc->mly_command_mailbox = MLY_STRONGARM_COMMAND_MAILBOX;
469 sc->mly_status_mailbox = MLY_STRONGARM_STATUS_MAILBOX;
470 sc->mly_idbr = MLY_STRONGARM_IDBR;
471 sc->mly_odbr = MLY_STRONGARM_ODBR;
472 sc->mly_error_status = MLY_STRONGARM_ERROR_STATUS;
473 sc->mly_interrupt_status = MLY_STRONGARM_INTERRUPT_STATUS;
474 sc->mly_interrupt_mask = MLY_STRONGARM_INTERRUPT_MASK;
482 * Create the scatter/gather mappings.
484 if ((error = mly_sg_map(sc)))
488 * Allocate and map the memory mailbox
490 if ((error = mly_mmbox_map(sc)))
499 /********************************************************************************
500 * Shut the controller down and detach all our resources.
503 mly_detach(device_t dev)
507 if ((error = mly_shutdown(dev)) != 0)
510 mly_free(device_get_softc(dev));
514 /********************************************************************************
515 * Bring the controller to a state where it can be safely left alone.
517 * Note that it should not be necessary to wait for any outstanding commands,
518 * as they should be completed prior to calling here.
520 * XXX this applies for I/O, but not status polls; we should beware of
521 * the case where a status command is running while we detach.
524 mly_shutdown(device_t dev)
526 struct mly_softc *sc = device_get_softc(dev);
530 if (sc->mly_state & MLY_STATE_OPEN)
533 /* kill the periodic event */
534 untimeout(mly_periodic, sc, sc->mly_periodic);
536 /* flush controller */
537 mly_printf(sc, "flushing cache...");
538 printf("%s\n", mly_flush(sc) ? "failed" : "done");
540 MLY_MASK_INTERRUPTS(sc);
545 /*******************************************************************************
546 * Take an interrupt, or be poked by other code to look for interrupt-worthy
552 struct mly_softc *sc = (struct mly_softc *)arg;
559 /********************************************************************************
560 ********************************************************************************
561 Bus-dependant Resource Management
562 ********************************************************************************
563 ********************************************************************************/
565 /********************************************************************************
566 * Allocate memory for the scatter/gather tables
569 mly_sg_map(struct mly_softc *sc)
576 * Create a single tag describing a region large enough to hold all of
577 * the s/g lists we will need.
579 segsize = sizeof(struct mly_sg_entry) * MLY_MAX_COMMANDS *MLY_MAX_SGENTRIES;
580 if (bus_dma_tag_create(sc->mly_parent_dmat, /* parent */
581 1, 0, /* alignment,boundary */
582 BUS_SPACE_MAXADDR, /* lowaddr */
583 BUS_SPACE_MAXADDR, /* highaddr */
584 NULL, NULL, /* filter, filterarg */
585 segsize, 1, /* maxsize, nsegments */
586 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
587 BUS_DMA_ALLOCNOW, /* flags */
588 NULL, NULL, /* lockfunc, lockarg */
590 mly_printf(sc, "can't allocate scatter/gather DMA tag\n");
595 * Allocate enough s/g maps for all commands and permanently map them into
596 * controller-visible space.
598 * XXX this assumes we can get enough space for all the s/g maps in one
601 if (bus_dmamem_alloc(sc->mly_sg_dmat, (void **)&sc->mly_sg_table,
602 BUS_DMA_NOWAIT, &sc->mly_sg_dmamap)) {
603 mly_printf(sc, "can't allocate s/g table\n");
606 if (bus_dmamap_load(sc->mly_sg_dmat, sc->mly_sg_dmamap, sc->mly_sg_table,
607 segsize, mly_sg_map_helper, sc, BUS_DMA_NOWAIT) != 0)
612 /********************************************************************************
613 * Save the physical address of the base of the s/g table.
616 mly_sg_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
618 struct mly_softc *sc = (struct mly_softc *)arg;
622 /* save base of s/g table's address in bus space */
623 sc->mly_sg_busaddr = segs->ds_addr;
626 /********************************************************************************
627 * Allocate memory for the memory-mailbox interface
630 mly_mmbox_map(struct mly_softc *sc)
634 * Create a DMA tag for a single contiguous region large enough for the
635 * memory mailbox structure.
637 if (bus_dma_tag_create(sc->mly_parent_dmat, /* parent */
638 1, 0, /* alignment,boundary */
639 BUS_SPACE_MAXADDR, /* lowaddr */
640 BUS_SPACE_MAXADDR, /* highaddr */
641 NULL, NULL, /* filter, filterarg */
642 sizeof(struct mly_mmbox), 1, /* maxsize, nsegments */
643 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
644 BUS_DMA_ALLOCNOW, /* flags */
645 NULL, NULL, /* lockfunc, lockarg */
646 &sc->mly_mmbox_dmat)) {
647 mly_printf(sc, "can't allocate memory mailbox DMA tag\n");
652 * Allocate the buffer
654 if (bus_dmamem_alloc(sc->mly_mmbox_dmat, (void **)&sc->mly_mmbox, BUS_DMA_NOWAIT, &sc->mly_mmbox_dmamap)) {
655 mly_printf(sc, "can't allocate memory mailbox\n");
658 if (bus_dmamap_load(sc->mly_mmbox_dmat, sc->mly_mmbox_dmamap, sc->mly_mmbox,
659 sizeof(struct mly_mmbox), mly_mmbox_map_helper, sc,
660 BUS_DMA_NOWAIT) != 0)
662 bzero(sc->mly_mmbox, sizeof(*sc->mly_mmbox));
667 /********************************************************************************
668 * Save the physical address of the memory mailbox
671 mly_mmbox_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
673 struct mly_softc *sc = (struct mly_softc *)arg;
677 sc->mly_mmbox_busaddr = segs->ds_addr;
680 /********************************************************************************
681 * Free all of the resources associated with (sc)
683 * Should not be called if the controller is active.
686 mly_free(struct mly_softc *sc)
691 /* Remove the management device */
692 destroy_dev(sc->mly_dev_t);
694 /* detach from CAM */
697 /* release command memory */
698 mly_release_commands(sc);
700 /* throw away the controllerinfo structure */
701 if (sc->mly_controllerinfo != NULL)
702 free(sc->mly_controllerinfo, M_DEVBUF);
704 /* throw away the controllerparam structure */
705 if (sc->mly_controllerparam != NULL)
706 free(sc->mly_controllerparam, M_DEVBUF);
708 /* destroy data-transfer DMA tag */
709 if (sc->mly_buffer_dmat)
710 bus_dma_tag_destroy(sc->mly_buffer_dmat);
712 /* free and destroy DMA memory and tag for s/g lists */
713 if (sc->mly_sg_table) {
714 bus_dmamap_unload(sc->mly_sg_dmat, sc->mly_sg_dmamap);
715 bus_dmamem_free(sc->mly_sg_dmat, sc->mly_sg_table, sc->mly_sg_dmamap);
718 bus_dma_tag_destroy(sc->mly_sg_dmat);
720 /* free and destroy DMA memory and tag for memory mailbox */
722 bus_dmamap_unload(sc->mly_mmbox_dmat, sc->mly_mmbox_dmamap);
723 bus_dmamem_free(sc->mly_mmbox_dmat, sc->mly_mmbox, sc->mly_mmbox_dmamap);
725 if (sc->mly_mmbox_dmat)
726 bus_dma_tag_destroy(sc->mly_mmbox_dmat);
728 /* disconnect the interrupt handler */
730 bus_teardown_intr(sc->mly_dev, sc->mly_irq, sc->mly_intr);
731 if (sc->mly_irq != NULL)
732 bus_release_resource(sc->mly_dev, SYS_RES_IRQ, sc->mly_irq_rid, sc->mly_irq);
734 /* destroy the parent DMA tag */
735 if (sc->mly_parent_dmat)
736 bus_dma_tag_destroy(sc->mly_parent_dmat);
738 /* release the register window mapping */
739 if (sc->mly_regs_resource != NULL)
740 bus_release_resource(sc->mly_dev, SYS_RES_MEMORY, sc->mly_regs_rid, sc->mly_regs_resource);
743 /********************************************************************************
744 ********************************************************************************
746 ********************************************************************************
747 ********************************************************************************/
749 /********************************************************************************
750 * Fill in the mly_controllerinfo and mly_controllerparam fields in the softc.
753 mly_get_controllerinfo(struct mly_softc *sc)
755 struct mly_command_ioctl mci;
761 if (sc->mly_controllerinfo != NULL)
762 free(sc->mly_controllerinfo, M_DEVBUF);
764 /* build the getcontrollerinfo ioctl and send it */
765 bzero(&mci, sizeof(mci));
766 sc->mly_controllerinfo = NULL;
767 mci.sub_ioctl = MDACIOCTL_GETCONTROLLERINFO;
768 if ((error = mly_ioctl(sc, &mci, (void **)&sc->mly_controllerinfo, sizeof(*sc->mly_controllerinfo),
769 &status, NULL, NULL)))
774 if (sc->mly_controllerparam != NULL)
775 free(sc->mly_controllerparam, M_DEVBUF);
777 /* build the getcontrollerparameter ioctl and send it */
778 bzero(&mci, sizeof(mci));
779 sc->mly_controllerparam = NULL;
780 mci.sub_ioctl = MDACIOCTL_GETCONTROLLERPARAMETER;
781 if ((error = mly_ioctl(sc, &mci, (void **)&sc->mly_controllerparam, sizeof(*sc->mly_controllerparam),
782 &status, NULL, NULL)))
790 /********************************************************************************
791 * Schedule all possible devices for a rescan.
795 mly_scan_devices(struct mly_softc *sc)
802 * Clear any previous BTL information.
804 bzero(&sc->mly_btl, sizeof(sc->mly_btl));
807 * Mark all devices as requiring a rescan, and let the next
808 * periodic scan collect them.
810 for (bus = 0; bus < sc->mly_cam_channels; bus++)
811 if (MLY_BUS_IS_VALID(sc, bus))
812 for (target = 0; target < MLY_MAX_TARGETS; target++)
813 sc->mly_btl[bus][target].mb_flags = MLY_BTL_RESCAN;
817 /********************************************************************************
818 * Rescan a device, possibly as a consequence of getting an event which suggests
819 * that it may have changed.
821 * If we suffer resource starvation, we can abandon the rescan as we'll be
825 mly_rescan_btl(struct mly_softc *sc, int bus, int target)
827 struct mly_command *mc;
828 struct mly_command_ioctl *mci;
832 /* check that this bus is valid */
833 if (!MLY_BUS_IS_VALID(sc, bus))
837 if (mly_alloc_command(sc, &mc))
840 /* set up the data buffer */
841 if ((mc->mc_data = malloc(sizeof(union mly_devinfo), M_DEVBUF, M_NOWAIT | M_ZERO)) == NULL) {
842 mly_release_command(mc);
845 mc->mc_flags |= MLY_CMD_DATAIN;
846 mc->mc_complete = mly_complete_rescan;
851 mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
852 mci->opcode = MDACMD_IOCTL;
853 mci->addr.phys.controller = 0;
854 mci->timeout.value = 30;
855 mci->timeout.scale = MLY_TIMEOUT_SECONDS;
856 if (MLY_BUS_IS_VIRTUAL(sc, bus)) {
857 mc->mc_length = mci->data_size = sizeof(struct mly_ioctl_getlogdevinfovalid);
858 mci->sub_ioctl = MDACIOCTL_GETLOGDEVINFOVALID;
859 mci->addr.log.logdev = MLY_LOGDEV_ID(sc, bus, target);
860 debug(1, "logical device %d", mci->addr.log.logdev);
862 mc->mc_length = mci->data_size = sizeof(struct mly_ioctl_getphysdevinfovalid);
863 mci->sub_ioctl = MDACIOCTL_GETPHYSDEVINFOVALID;
864 mci->addr.phys.lun = 0;
865 mci->addr.phys.target = target;
866 mci->addr.phys.channel = bus;
867 debug(1, "physical device %d:%d", mci->addr.phys.channel, mci->addr.phys.target);
871 * Dispatch the command. If we successfully send the command, clear the rescan
874 if (mly_start(mc) != 0) {
875 mly_release_command(mc);
877 sc->mly_btl[bus][target].mb_flags &= ~MLY_BTL_RESCAN; /* success */
881 /********************************************************************************
882 * Handle the completion of a rescan operation
885 mly_complete_rescan(struct mly_command *mc)
887 struct mly_softc *sc = mc->mc_sc;
888 struct mly_ioctl_getlogdevinfovalid *ldi;
889 struct mly_ioctl_getphysdevinfovalid *pdi;
890 struct mly_command_ioctl *mci;
891 struct mly_btl btl, *btlp;
892 int bus, target, rescan;
897 * Recover the bus and target from the command. We need these even in
898 * the case where we don't have a useful response.
900 mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
901 if (mci->sub_ioctl == MDACIOCTL_GETLOGDEVINFOVALID) {
902 bus = MLY_LOGDEV_BUS(sc, mci->addr.log.logdev);
903 target = MLY_LOGDEV_TARGET(sc, mci->addr.log.logdev);
905 bus = mci->addr.phys.channel;
906 target = mci->addr.phys.target;
908 /* XXX validate bus/target? */
910 /* the default result is 'no device' */
911 bzero(&btl, sizeof(btl));
913 /* if the rescan completed OK, we have possibly-new BTL data */
914 if (mc->mc_status == 0) {
915 if (mc->mc_length == sizeof(*ldi)) {
916 ldi = (struct mly_ioctl_getlogdevinfovalid *)mc->mc_data;
917 if ((MLY_LOGDEV_BUS(sc, ldi->logical_device_number) != bus) ||
918 (MLY_LOGDEV_TARGET(sc, ldi->logical_device_number) != target)) {
919 mly_printf(sc, "WARNING: BTL rescan for %d:%d returned data for %d:%d instead\n",
920 bus, target, MLY_LOGDEV_BUS(sc, ldi->logical_device_number),
921 MLY_LOGDEV_TARGET(sc, ldi->logical_device_number));
922 /* XXX what can we do about this? */
924 btl.mb_flags = MLY_BTL_LOGICAL;
925 btl.mb_type = ldi->raid_level;
926 btl.mb_state = ldi->state;
927 debug(1, "BTL rescan for %d returns %s, %s", ldi->logical_device_number,
928 mly_describe_code(mly_table_device_type, ldi->raid_level),
929 mly_describe_code(mly_table_device_state, ldi->state));
930 } else if (mc->mc_length == sizeof(*pdi)) {
931 pdi = (struct mly_ioctl_getphysdevinfovalid *)mc->mc_data;
932 if ((pdi->channel != bus) || (pdi->target != target)) {
933 mly_printf(sc, "WARNING: BTL rescan for %d:%d returned data for %d:%d instead\n",
934 bus, target, pdi->channel, pdi->target);
935 /* XXX what can we do about this? */
937 btl.mb_flags = MLY_BTL_PHYSICAL;
938 btl.mb_type = MLY_DEVICE_TYPE_PHYSICAL;
939 btl.mb_state = pdi->state;
940 btl.mb_speed = pdi->speed;
941 btl.mb_width = pdi->width;
942 if (pdi->state != MLY_DEVICE_STATE_UNCONFIGURED)
943 sc->mly_btl[bus][target].mb_flags |= MLY_BTL_PROTECTED;
944 debug(1, "BTL rescan for %d:%d returns %s", bus, target,
945 mly_describe_code(mly_table_device_state, pdi->state));
947 mly_printf(sc, "BTL rescan result invalid\n");
951 free(mc->mc_data, M_DEVBUF);
952 mly_release_command(mc);
955 * Decide whether we need to rescan the device.
959 /* device type changes (usually between 'nothing' and 'something') */
960 btlp = &sc->mly_btl[bus][target];
961 if (btl.mb_flags != btlp->mb_flags) {
962 debug(1, "flags changed, rescanning");
966 /* XXX other reasons? */
969 * Update BTL information.
974 * Perform CAM rescan if required.
977 mly_cam_rescan_btl(sc, bus, target);
980 /********************************************************************************
981 * Get the current health status and set the 'next event' counter to suit.
984 mly_get_eventstatus(struct mly_softc *sc)
986 struct mly_command_ioctl mci;
987 struct mly_health_status *mh;
991 /* build the gethealthstatus ioctl and send it */
992 bzero(&mci, sizeof(mci));
994 mci.sub_ioctl = MDACIOCTL_GETHEALTHSTATUS;
996 if ((error = mly_ioctl(sc, &mci, (void **)&mh, sizeof(*mh), &status, NULL, NULL)))
1001 /* get the event counter */
1002 sc->mly_event_change = mh->change_counter;
1003 sc->mly_event_waiting = mh->next_event;
1004 sc->mly_event_counter = mh->next_event;
1006 /* save the health status into the memory mailbox */
1007 bcopy(mh, &sc->mly_mmbox->mmm_health.status, sizeof(*mh));
1009 debug(1, "initial change counter %d, event counter %d", mh->change_counter, mh->next_event);
1015 /********************************************************************************
1016 * Enable the memory mailbox mode.
1019 mly_enable_mmbox(struct mly_softc *sc)
1021 struct mly_command_ioctl mci;
1022 u_int8_t *sp, status;
1027 /* build the ioctl and send it */
1028 bzero(&mci, sizeof(mci));
1029 mci.sub_ioctl = MDACIOCTL_SETMEMORYMAILBOX;
1030 /* set buffer addresses */
1031 mci.param.setmemorymailbox.command_mailbox_physaddr =
1032 sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_command);
1033 mci.param.setmemorymailbox.status_mailbox_physaddr =
1034 sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_status);
1035 mci.param.setmemorymailbox.health_buffer_physaddr =
1036 sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_health);
1038 /* set buffer sizes - abuse of data_size field is revolting */
1039 sp = (u_int8_t *)&mci.data_size;
1040 sp[0] = ((sizeof(union mly_command_packet) * MLY_MMBOX_COMMANDS) / 1024);
1041 sp[1] = (sizeof(union mly_status_packet) * MLY_MMBOX_STATUS) / 1024;
1042 mci.param.setmemorymailbox.health_buffer_size = sizeof(union mly_health_region) / 1024;
1044 debug(1, "memory mailbox at %p (0x%llx/%d 0x%llx/%d 0x%llx/%d", sc->mly_mmbox,
1045 mci.param.setmemorymailbox.command_mailbox_physaddr, sp[0],
1046 mci.param.setmemorymailbox.status_mailbox_physaddr, sp[1],
1047 mci.param.setmemorymailbox.health_buffer_physaddr,
1048 mci.param.setmemorymailbox.health_buffer_size);
1050 if ((error = mly_ioctl(sc, &mci, NULL, 0, &status, NULL, NULL)))
1054 sc->mly_state |= MLY_STATE_MMBOX_ACTIVE;
1055 debug(1, "memory mailbox active");
1059 /********************************************************************************
1060 * Flush all pending I/O from the controller.
1063 mly_flush(struct mly_softc *sc)
1065 struct mly_command_ioctl mci;
1071 /* build the ioctl */
1072 bzero(&mci, sizeof(mci));
1073 mci.sub_ioctl = MDACIOCTL_FLUSHDEVICEDATA;
1074 mci.param.deviceoperation.operation_device = MLY_OPDEVICE_PHYSICAL_CONTROLLER;
1076 /* pass it off to the controller */
1077 if ((error = mly_ioctl(sc, &mci, NULL, 0, &status, NULL, NULL)))
1080 return((status == 0) ? 0 : EIO);
1083 /********************************************************************************
1084 * Perform an ioctl command.
1086 * If (data) is not NULL, the command requires data transfer. If (*data) is NULL
1087 * the command requires data transfer from the controller, and we will allocate
1088 * a buffer for it. If (*data) is not NULL, the command requires data transfer
1089 * to the controller.
1091 * XXX passing in the whole ioctl structure is ugly. Better ideas?
1093 * XXX we don't even try to handle the case where datasize > 4k. We should.
1096 mly_ioctl(struct mly_softc *sc, struct mly_command_ioctl *ioctl, void **data, size_t datasize,
1097 u_int8_t *status, void *sense_buffer, size_t *sense_length)
1099 struct mly_command *mc;
1100 struct mly_command_ioctl *mci;
1106 if (mly_alloc_command(sc, &mc)) {
1111 /* copy the ioctl structure, but save some important fields and then fixup */
1112 mci = &mc->mc_packet->ioctl;
1113 ioctl->sense_buffer_address = mci->sense_buffer_address;
1114 ioctl->maximum_sense_size = mci->maximum_sense_size;
1116 mci->opcode = MDACMD_IOCTL;
1117 mci->timeout.value = 30;
1118 mci->timeout.scale = MLY_TIMEOUT_SECONDS;
1120 /* handle the data buffer */
1122 if (*data == NULL) {
1123 /* allocate data buffer */
1124 if ((mc->mc_data = malloc(datasize, M_DEVBUF, M_NOWAIT)) == NULL) {
1128 mc->mc_flags |= MLY_CMD_DATAIN;
1130 mc->mc_data = *data;
1131 mc->mc_flags |= MLY_CMD_DATAOUT;
1133 mc->mc_length = datasize;
1134 mc->mc_packet->generic.data_size = datasize;
1137 /* run the command */
1138 if ((error = mly_immediate_command(mc)))
1141 /* clean up and return any data */
1142 *status = mc->mc_status;
1143 if ((mc->mc_sense > 0) && (sense_buffer != NULL)) {
1144 bcopy(mc->mc_packet, sense_buffer, mc->mc_sense);
1145 *sense_length = mc->mc_sense;
1149 /* should we return a data pointer? */
1150 if ((data != NULL) && (*data == NULL))
1151 *data = mc->mc_data;
1153 /* command completed OK */
1158 /* do we need to free a data buffer we allocated? */
1159 if (error && (mc->mc_data != NULL) && (*data == NULL))
1160 free(mc->mc_data, M_DEVBUF);
1161 mly_release_command(mc);
1166 /********************************************************************************
1167 * Check for event(s) outstanding in the controller.
1170 mly_check_event(struct mly_softc *sc)
1174 * The controller may have updated the health status information,
1175 * so check for it here. Note that the counters are all in host memory,
1176 * so this check is very cheap. Also note that we depend on checking on
1179 if (sc->mly_mmbox->mmm_health.status.change_counter != sc->mly_event_change) {
1180 sc->mly_event_change = sc->mly_mmbox->mmm_health.status.change_counter;
1181 debug(1, "event change %d, event status update, %d -> %d", sc->mly_event_change,
1182 sc->mly_event_waiting, sc->mly_mmbox->mmm_health.status.next_event);
1183 sc->mly_event_waiting = sc->mly_mmbox->mmm_health.status.next_event;
1185 /* wake up anyone that might be interested in this */
1186 wakeup(&sc->mly_event_change);
1188 if (sc->mly_event_counter != sc->mly_event_waiting)
1189 mly_fetch_event(sc);
1192 /********************************************************************************
1193 * Fetch one event from the controller.
1195 * If we fail due to resource starvation, we'll be retried the next time a
1196 * command completes.
1199 mly_fetch_event(struct mly_softc *sc)
1201 struct mly_command *mc;
1202 struct mly_command_ioctl *mci;
1209 if (mly_alloc_command(sc, &mc))
1212 /* set up the data buffer */
1213 if ((mc->mc_data = malloc(sizeof(struct mly_event), M_DEVBUF, M_NOWAIT | M_ZERO)) == NULL) {
1214 mly_release_command(mc);
1217 mc->mc_length = sizeof(struct mly_event);
1218 mc->mc_flags |= MLY_CMD_DATAIN;
1219 mc->mc_complete = mly_complete_event;
1222 * Get an event number to fetch. It's possible that we've raced with another
1223 * context for the last event, in which case there will be no more events.
1226 if (sc->mly_event_counter == sc->mly_event_waiting) {
1227 mly_release_command(mc);
1231 event = sc->mly_event_counter++;
1237 * At this point we are committed to sending this request, as it
1238 * will be the only one constructed for this particular event number.
1240 mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
1241 mci->opcode = MDACMD_IOCTL;
1242 mci->data_size = sizeof(struct mly_event);
1243 mci->addr.phys.lun = (event >> 16) & 0xff;
1244 mci->addr.phys.target = (event >> 24) & 0xff;
1245 mci->addr.phys.channel = 0;
1246 mci->addr.phys.controller = 0;
1247 mci->timeout.value = 30;
1248 mci->timeout.scale = MLY_TIMEOUT_SECONDS;
1249 mci->sub_ioctl = MDACIOCTL_GETEVENT;
1250 mci->param.getevent.sequence_number_low = event & 0xffff;
1252 debug(1, "fetch event %u", event);
1255 * Submit the command.
1257 * Note that failure of mly_start() will result in this event never being
1260 if (mly_start(mc) != 0) {
1261 mly_printf(sc, "couldn't fetch event %u\n", event);
1262 mly_release_command(mc);
1266 /********************************************************************************
1267 * Handle the completion of an event poll.
1270 mly_complete_event(struct mly_command *mc)
1272 struct mly_softc *sc = mc->mc_sc;
1273 struct mly_event *me = (struct mly_event *)mc->mc_data;
1278 * If the event was successfully fetched, process it.
1280 if (mc->mc_status == SCSI_STATUS_OK) {
1281 mly_process_event(sc, me);
1284 mly_release_command(mc);
1287 * Check for another event.
1289 mly_check_event(sc);
1292 /********************************************************************************
1293 * Process a controller event.
1296 mly_process_event(struct mly_softc *sc, struct mly_event *me)
1298 struct scsi_sense_data *ssd = (struct scsi_sense_data *)&me->sense[0];
1300 int bus, target, event, class, action;
1303 * Errors can be reported using vendor-unique sense data. In this case, the
1304 * event code will be 0x1c (Request sense data present), the sense key will
1305 * be 0x09 (vendor specific), the MSB of the ASC will be set, and the
1306 * actual event code will be a 16-bit value comprised of the ASCQ (low byte)
1307 * and low seven bits of the ASC (low seven bits of the high byte).
1309 if ((me->code == 0x1c) &&
1310 ((ssd->flags & SSD_KEY) == SSD_KEY_Vendor_Specific) &&
1311 (ssd->add_sense_code & 0x80)) {
1312 event = ((int)(ssd->add_sense_code & ~0x80) << 8) + ssd->add_sense_code_qual;
1317 /* look up event, get codes */
1318 fp = mly_describe_code(mly_table_event, event);
1320 debug(1, "Event %d code 0x%x", me->sequence_number, me->code);
1324 if (isupper(class) && bootverbose)
1325 class = tolower(class);
1327 /* get action code, text string */
1332 * Print some information about the event.
1334 * This code uses a table derived from the corresponding portion of the Linux
1335 * driver, and thus the parser is very similar.
1338 case 'p': /* error on physical device */
1339 mly_printf(sc, "physical device %d:%d %s\n", me->channel, me->target, tp);
1341 sc->mly_btl[me->channel][me->target].mb_flags |= MLY_BTL_RESCAN;
1343 case 'l': /* error on logical unit */
1344 case 'm': /* message about logical unit */
1345 bus = MLY_LOGDEV_BUS(sc, me->lun);
1346 target = MLY_LOGDEV_TARGET(sc, me->lun);
1347 mly_name_device(sc, bus, target);
1348 mly_printf(sc, "logical device %d (%s) %s\n", me->lun, sc->mly_btl[bus][target].mb_name, tp);
1350 sc->mly_btl[bus][target].mb_flags |= MLY_BTL_RESCAN;
1353 case 's': /* report of sense data */
1354 if (((ssd->flags & SSD_KEY) == SSD_KEY_NO_SENSE) ||
1355 (((ssd->flags & SSD_KEY) == SSD_KEY_NOT_READY) &&
1356 (ssd->add_sense_code == 0x04) &&
1357 ((ssd->add_sense_code_qual == 0x01) || (ssd->add_sense_code_qual == 0x02))))
1358 break; /* ignore NO_SENSE or NOT_READY in one case */
1360 mly_printf(sc, "physical device %d:%d %s\n", me->channel, me->target, tp);
1361 mly_printf(sc, " sense key %d asc %02x ascq %02x\n",
1362 ssd->flags & SSD_KEY, ssd->add_sense_code, ssd->add_sense_code_qual);
1363 mly_printf(sc, " info %4D csi %4D\n", ssd->info, "", ssd->cmd_spec_info, "");
1365 sc->mly_btl[me->channel][me->target].mb_flags |= MLY_BTL_RESCAN;
1368 mly_printf(sc, tp, me->target, me->lun);
1372 mly_printf(sc, "controller %s\n", tp);
1375 mly_printf(sc, "%s - %d\n", tp, me->code);
1377 default: /* probably a 'noisy' event being ignored */
1382 /********************************************************************************
1383 * Perform periodic activities.
1386 mly_periodic(void *data)
1388 struct mly_softc *sc = (struct mly_softc *)data;
1396 for (bus = 0; bus < sc->mly_cam_channels; bus++) {
1397 if (MLY_BUS_IS_VALID(sc, bus)) {
1398 for (target = 0; target < MLY_MAX_TARGETS; target++) {
1400 /* ignore the controller in this scan */
1401 if (target == sc->mly_controllerparam->initiator_id)
1404 /* perform device rescan? */
1405 if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_RESCAN)
1406 mly_rescan_btl(sc, bus, target);
1411 /* check for controller events */
1412 mly_check_event(sc);
1414 /* reschedule ourselves */
1415 sc->mly_periodic = timeout(mly_periodic, sc, MLY_PERIODIC_INTERVAL * hz);
1418 /********************************************************************************
1419 ********************************************************************************
1421 ********************************************************************************
1422 ********************************************************************************/
1424 /********************************************************************************
1425 * Run a command and wait for it to complete.
1429 mly_immediate_command(struct mly_command *mc)
1431 struct mly_softc *sc = mc->mc_sc;
1436 /* spinning at splcam is ugly, but we're only used during controller init */
1438 if ((error = mly_start(mc))) {
1443 if (sc->mly_state & MLY_STATE_INTERRUPTS_ON) {
1444 /* sleep on the command */
1445 while(!(mc->mc_flags & MLY_CMD_COMPLETE)) {
1446 tsleep(mc, PRIBIO, "mlywait", 0);
1449 /* spin and collect status while we do */
1450 while(!(mc->mc_flags & MLY_CMD_COMPLETE)) {
1451 mly_done(mc->mc_sc);
1458 /********************************************************************************
1459 * Deliver a command to the controller.
1461 * XXX it would be good to just queue commands that we can't submit immediately
1462 * and send them later, but we probably want a wrapper for that so that
1463 * we don't hang on a failed submission for an immediate command.
1466 mly_start(struct mly_command *mc)
1468 struct mly_softc *sc = mc->mc_sc;
1469 union mly_command_packet *pkt;
1475 * Set the command up for delivery to the controller.
1477 mly_map_command(mc);
1478 mc->mc_packet->generic.command_id = mc->mc_slot;
1481 mc->mc_timestamp = time_second;
1487 * Do we have to use the hardware mailbox?
1489 if (!(sc->mly_state & MLY_STATE_MMBOX_ACTIVE)) {
1491 * Check to see if the controller is ready for us.
1493 if (MLY_IDBR_TRUE(sc, MLY_HM_CMDSENT)) {
1497 mc->mc_flags |= MLY_CMD_BUSY;
1500 * It's ready, send the command.
1502 MLY_SET_MBOX(sc, sc->mly_command_mailbox, &mc->mc_packetphys);
1503 MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_CMDSENT);
1505 } else { /* use memory-mailbox mode */
1507 pkt = &sc->mly_mmbox->mmm_command[sc->mly_mmbox_command_index];
1509 /* check to see if the next index is free yet */
1510 if (pkt->mmbox.flag != 0) {
1514 mc->mc_flags |= MLY_CMD_BUSY;
1516 /* copy in new command */
1517 bcopy(mc->mc_packet->mmbox.data, pkt->mmbox.data, sizeof(pkt->mmbox.data));
1518 /* barrier to ensure completion of previous write before we write the flag */
1519 bus_space_barrier(sc->mly_btag, sc->mly_bhandle, 0, 0,
1520 BUS_SPACE_BARRIER_WRITE);
1521 /* copy flag last */
1522 pkt->mmbox.flag = mc->mc_packet->mmbox.flag;
1523 /* barrier to ensure completion of previous write before we notify the controller */
1524 bus_space_barrier(sc->mly_btag, sc->mly_bhandle, 0, 0,
1525 BUS_SPACE_BARRIER_WRITE);
1527 /* signal controller, update index */
1528 MLY_SET_REG(sc, sc->mly_idbr, MLY_AM_CMDSENT);
1529 sc->mly_mmbox_command_index = (sc->mly_mmbox_command_index + 1) % MLY_MMBOX_COMMANDS;
1532 mly_enqueue_busy(mc);
1537 /********************************************************************************
1538 * Pick up command status from the controller, schedule a completion event
1541 mly_done(struct mly_softc *sc)
1543 struct mly_command *mc;
1544 union mly_status_packet *sp;
1551 /* pick up hardware-mailbox commands */
1552 if (MLY_ODBR_TRUE(sc, MLY_HM_STSREADY)) {
1553 slot = MLY_GET_REG2(sc, sc->mly_status_mailbox);
1554 if (slot < MLY_SLOT_MAX) {
1555 mc = &sc->mly_command[slot - MLY_SLOT_START];
1556 mc->mc_status = MLY_GET_REG(sc, sc->mly_status_mailbox + 2);
1557 mc->mc_sense = MLY_GET_REG(sc, sc->mly_status_mailbox + 3);
1558 mc->mc_resid = MLY_GET_REG4(sc, sc->mly_status_mailbox + 4);
1559 mly_remove_busy(mc);
1560 mc->mc_flags &= ~MLY_CMD_BUSY;
1561 mly_enqueue_complete(mc);
1564 /* slot 0xffff may mean "extremely bogus command" */
1565 mly_printf(sc, "got HM completion for illegal slot %u\n", slot);
1567 /* unconditionally acknowledge status */
1568 MLY_SET_REG(sc, sc->mly_odbr, MLY_HM_STSREADY);
1569 MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_STSACK);
1572 /* pick up memory-mailbox commands */
1573 if (MLY_ODBR_TRUE(sc, MLY_AM_STSREADY)) {
1575 sp = &sc->mly_mmbox->mmm_status[sc->mly_mmbox_status_index];
1577 /* check for more status */
1578 if (sp->mmbox.flag == 0)
1581 /* get slot number */
1582 slot = sp->status.command_id;
1583 if (slot < MLY_SLOT_MAX) {
1584 mc = &sc->mly_command[slot - MLY_SLOT_START];
1585 mc->mc_status = sp->status.status;
1586 mc->mc_sense = sp->status.sense_length;
1587 mc->mc_resid = sp->status.residue;
1588 mly_remove_busy(mc);
1589 mc->mc_flags &= ~MLY_CMD_BUSY;
1590 mly_enqueue_complete(mc);
1593 /* slot 0xffff may mean "extremely bogus command" */
1594 mly_printf(sc, "got AM completion for illegal slot %u at %d\n",
1595 slot, sc->mly_mmbox_status_index);
1598 /* clear and move to next index */
1600 sc->mly_mmbox_status_index = (sc->mly_mmbox_status_index + 1) % MLY_MMBOX_STATUS;
1602 /* acknowledge that we have collected status value(s) */
1603 MLY_SET_REG(sc, sc->mly_odbr, MLY_AM_STSREADY);
1608 if (sc->mly_state & MLY_STATE_INTERRUPTS_ON)
1609 taskqueue_enqueue(taskqueue_swi_giant, &sc->mly_task_complete);
1611 mly_complete(sc, 0);
1615 /********************************************************************************
1616 * Process completed commands
1619 mly_complete(void *context, int pending)
1621 struct mly_softc *sc = (struct mly_softc *)context;
1622 struct mly_command *mc;
1623 void (* mc_complete)(struct mly_command *mc);
1629 * Spin pulling commands off the completed queue and processing them.
1631 while ((mc = mly_dequeue_complete(sc)) != NULL) {
1634 * Free controller resources, mark command complete.
1636 * Note that as soon as we mark the command complete, it may be freed
1637 * out from under us, so we need to save the mc_complete field in
1638 * order to later avoid dereferencing mc. (We would not expect to
1639 * have a polling/sleeping consumer with mc_complete != NULL).
1641 mly_unmap_command(mc);
1642 mc_complete = mc->mc_complete;
1643 mc->mc_flags |= MLY_CMD_COMPLETE;
1646 * Call completion handler or wake up sleeping consumer.
1648 if (mc_complete != NULL) {
1656 * XXX if we are deferring commands due to controller-busy status, we should
1657 * retry submitting them here.
1661 /********************************************************************************
1662 ********************************************************************************
1663 Command Buffer Management
1664 ********************************************************************************
1665 ********************************************************************************/
1667 /********************************************************************************
1668 * Allocate a command.
1671 mly_alloc_command(struct mly_softc *sc, struct mly_command **mcp)
1673 struct mly_command *mc;
1677 if ((mc = mly_dequeue_free(sc)) == NULL)
1684 /********************************************************************************
1685 * Release a command back to the freelist.
1688 mly_release_command(struct mly_command *mc)
1693 * Fill in parts of the command that may cause confusion if
1694 * a consumer doesn't when we are later allocated.
1698 mc->mc_complete = NULL;
1699 mc->mc_private = NULL;
1702 * By default, we set up to overwrite the command packet with
1703 * sense information.
1705 mc->mc_packet->generic.sense_buffer_address = mc->mc_packetphys;
1706 mc->mc_packet->generic.maximum_sense_size = sizeof(union mly_command_packet);
1708 mly_enqueue_free(mc);
1711 /********************************************************************************
1712 * Map helper for command allocation.
1715 mly_alloc_commands_map(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1717 struct mly_softc *sc = (struct mly_softc *)arg;
1721 sc->mly_packetphys = segs[0].ds_addr;
1724 /********************************************************************************
1725 * Allocate and initialise command and packet structures.
1727 * If the controller supports fewer than MLY_MAX_COMMANDS commands, limit our
1728 * allocation to that number. If we don't yet know how many commands the
1729 * controller supports, allocate a very small set (suitable for initialisation
1733 mly_alloc_commands(struct mly_softc *sc)
1735 struct mly_command *mc;
1738 if (sc->mly_controllerinfo == NULL) {
1741 ncmd = min(MLY_MAX_COMMANDS, sc->mly_controllerinfo->maximum_parallel_commands);
1745 * Allocate enough space for all the command packets in one chunk and
1746 * map them permanently into controller-visible space.
1748 if (bus_dmamem_alloc(sc->mly_packet_dmat, (void **)&sc->mly_packet,
1749 BUS_DMA_NOWAIT, &sc->mly_packetmap)) {
1752 if (bus_dmamap_load(sc->mly_packet_dmat, sc->mly_packetmap, sc->mly_packet,
1753 ncmd * sizeof(union mly_command_packet),
1754 mly_alloc_commands_map, sc, BUS_DMA_NOWAIT) != 0)
1757 for (i = 0; i < ncmd; i++) {
1758 mc = &sc->mly_command[i];
1759 bzero(mc, sizeof(*mc));
1761 mc->mc_slot = MLY_SLOT_START + i;
1762 mc->mc_packet = sc->mly_packet + i;
1763 mc->mc_packetphys = sc->mly_packetphys + (i * sizeof(union mly_command_packet));
1764 if (!bus_dmamap_create(sc->mly_buffer_dmat, 0, &mc->mc_datamap))
1765 mly_release_command(mc);
1770 /********************************************************************************
1771 * Free all the storage held by commands.
1773 * Must be called with all commands on the free list.
1776 mly_release_commands(struct mly_softc *sc)
1778 struct mly_command *mc;
1780 /* throw away command buffer DMA maps */
1781 while (mly_alloc_command(sc, &mc) == 0)
1782 bus_dmamap_destroy(sc->mly_buffer_dmat, mc->mc_datamap);
1784 /* release the packet storage */
1785 if (sc->mly_packet != NULL) {
1786 bus_dmamap_unload(sc->mly_packet_dmat, sc->mly_packetmap);
1787 bus_dmamem_free(sc->mly_packet_dmat, sc->mly_packet, sc->mly_packetmap);
1788 sc->mly_packet = NULL;
1793 /********************************************************************************
1794 * Command-mapping helper function - populate this command's s/g table
1795 * with the s/g entries for its data.
1798 mly_map_command_sg(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1800 struct mly_command *mc = (struct mly_command *)arg;
1801 struct mly_softc *sc = mc->mc_sc;
1802 struct mly_command_generic *gen = &(mc->mc_packet->generic);
1803 struct mly_sg_entry *sg;
1808 /* can we use the transfer structure directly? */
1810 sg = &gen->transfer.direct.sg[0];
1811 gen->command_control.extended_sg_table = 0;
1813 tabofs = ((mc->mc_slot - MLY_SLOT_START) * MLY_MAX_SGENTRIES);
1814 sg = sc->mly_sg_table + tabofs;
1815 gen->transfer.indirect.entries[0] = nseg;
1816 gen->transfer.indirect.table_physaddr[0] = sc->mly_sg_busaddr + (tabofs * sizeof(struct mly_sg_entry));
1817 gen->command_control.extended_sg_table = 1;
1820 /* copy the s/g table */
1821 for (i = 0; i < nseg; i++) {
1822 sg[i].physaddr = segs[i].ds_addr;
1823 sg[i].length = segs[i].ds_len;
1829 /********************************************************************************
1830 * Command-mapping helper function - save the cdb's physical address.
1832 * We don't support 'large' SCSI commands at this time, so this is unused.
1835 mly_map_command_cdb(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1837 struct mly_command *mc = (struct mly_command *)arg;
1841 /* XXX can we safely assume that a CDB will never cross a page boundary? */
1842 if ((segs[0].ds_addr % PAGE_SIZE) >
1843 ((segs[0].ds_addr + mc->mc_packet->scsi_large.cdb_length) % PAGE_SIZE))
1844 panic("cdb crosses page boundary");
1846 /* fix up fields in the command packet */
1847 mc->mc_packet->scsi_large.cdb_physaddr = segs[0].ds_addr;
1851 /********************************************************************************
1852 * Map a command into controller-visible space
1855 mly_map_command(struct mly_command *mc)
1857 struct mly_softc *sc = mc->mc_sc;
1861 /* don't map more than once */
1862 if (mc->mc_flags & MLY_CMD_MAPPED)
1865 /* does the command have a data buffer? */
1866 if (mc->mc_data != NULL) {
1867 bus_dmamap_load(sc->mly_buffer_dmat, mc->mc_datamap, mc->mc_data, mc->mc_length,
1868 mly_map_command_sg, mc, 0);
1870 if (mc->mc_flags & MLY_CMD_DATAIN)
1871 bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_PREREAD);
1872 if (mc->mc_flags & MLY_CMD_DATAOUT)
1873 bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_PREWRITE);
1875 mc->mc_flags |= MLY_CMD_MAPPED;
1878 /********************************************************************************
1879 * Unmap a command from controller-visible space
1882 mly_unmap_command(struct mly_command *mc)
1884 struct mly_softc *sc = mc->mc_sc;
1888 if (!(mc->mc_flags & MLY_CMD_MAPPED))
1891 /* does the command have a data buffer? */
1892 if (mc->mc_data != NULL) {
1893 if (mc->mc_flags & MLY_CMD_DATAIN)
1894 bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_POSTREAD);
1895 if (mc->mc_flags & MLY_CMD_DATAOUT)
1896 bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_POSTWRITE);
1898 bus_dmamap_unload(sc->mly_buffer_dmat, mc->mc_datamap);
1900 mc->mc_flags &= ~MLY_CMD_MAPPED;
1904 /********************************************************************************
1905 ********************************************************************************
1907 ********************************************************************************
1908 ********************************************************************************/
1910 /********************************************************************************
1911 * Attach the physical and virtual SCSI busses to CAM.
1913 * Physical bus numbering starts from 0, virtual bus numbering from one greater
1914 * than the highest physical bus. Physical busses are only registered if
1915 * the kernel environment variable "hw.mly.register_physical_channels" is set.
1917 * When we refer to a "bus", we are referring to the bus number registered with
1918 * the SIM, wheras a "channel" is a channel number given to the adapter. In order
1919 * to keep things simple, we map these 1:1, so "bus" and "channel" may be used
1923 mly_cam_attach(struct mly_softc *sc)
1925 struct cam_devq *devq;
1931 * Allocate a devq for all our channels combined.
1933 if ((devq = cam_simq_alloc(sc->mly_controllerinfo->maximum_parallel_commands)) == NULL) {
1934 mly_printf(sc, "can't allocate CAM SIM queue\n");
1939 * If physical channel registration has been requested, register these first.
1940 * Note that we enable tagged command queueing for physical channels.
1942 if (testenv("hw.mly.register_physical_channels")) {
1944 for (i = 0; i < sc->mly_controllerinfo->physical_channels_present; i++, chn++) {
1946 if ((sc->mly_cam_sim[chn] = cam_sim_alloc(mly_cam_action, mly_cam_poll, "mly", sc,
1947 device_get_unit(sc->mly_dev),
1949 sc->mly_controllerinfo->maximum_parallel_commands,
1950 1, devq)) == NULL) {
1953 if (xpt_bus_register(sc->mly_cam_sim[chn], sc->mly_dev, chn)) {
1954 mly_printf(sc, "CAM XPT phsyical channel registration failed\n");
1957 debug(1, "registered physical channel %d", chn);
1962 * Register our virtual channels, with bus numbers matching channel numbers.
1964 chn = sc->mly_controllerinfo->physical_channels_present;
1965 for (i = 0; i < sc->mly_controllerinfo->virtual_channels_present; i++, chn++) {
1966 if ((sc->mly_cam_sim[chn] = cam_sim_alloc(mly_cam_action, mly_cam_poll, "mly", sc,
1967 device_get_unit(sc->mly_dev),
1969 sc->mly_controllerinfo->maximum_parallel_commands,
1970 0, devq)) == NULL) {
1973 if (xpt_bus_register(sc->mly_cam_sim[chn], sc->mly_dev, chn)) {
1974 mly_printf(sc, "CAM XPT virtual channel registration failed\n");
1977 debug(1, "registered virtual channel %d", chn);
1981 * This is the total number of channels that (might have been) registered with
1982 * CAM. Some may not have been; check the mly_cam_sim array to be certain.
1984 sc->mly_cam_channels = sc->mly_controllerinfo->physical_channels_present +
1985 sc->mly_controllerinfo->virtual_channels_present;
1990 /********************************************************************************
1994 mly_cam_detach(struct mly_softc *sc)
2000 for (i = 0; i < sc->mly_cam_channels; i++) {
2001 if (sc->mly_cam_sim[i] != NULL) {
2002 xpt_bus_deregister(cam_sim_path(sc->mly_cam_sim[i]));
2003 cam_sim_free(sc->mly_cam_sim[i], 0);
2006 if (sc->mly_cam_devq != NULL)
2007 cam_simq_free(sc->mly_cam_devq);
2010 /************************************************************************
2014 mly_cam_rescan_btl(struct mly_softc *sc, int bus, int target)
2020 if ((ccb = malloc(sizeof(union ccb), M_TEMP, M_WAITOK | M_ZERO)) == NULL) {
2021 mly_printf(sc, "rescan failed (can't allocate CCB)\n");
2025 if (xpt_create_path(&sc->mly_cam_path, xpt_periph,
2026 cam_sim_path(sc->mly_cam_sim[bus]), target, 0) != CAM_REQ_CMP) {
2027 mly_printf(sc, "rescan failed (can't create path)\n");
2031 xpt_setup_ccb(&ccb->ccb_h, sc->mly_cam_path, 5/*priority (low)*/);
2032 ccb->ccb_h.func_code = XPT_SCAN_LUN;
2033 ccb->ccb_h.cbfcnp = mly_cam_rescan_callback;
2034 ccb->crcn.flags = CAM_FLAG_NONE;
2035 debug(1, "rescan target %d:%d", bus, target);
2040 mly_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb)
2045 /********************************************************************************
2046 * Handle an action requested by CAM
2049 mly_cam_action(struct cam_sim *sim, union ccb *ccb)
2051 struct mly_softc *sc = cam_sim_softc(sim);
2055 switch (ccb->ccb_h.func_code) {
2057 /* perform SCSI I/O */
2059 if (!mly_cam_action_io(sim, (struct ccb_scsiio *)&ccb->csio))
2063 /* perform geometry calculations */
2064 case XPT_CALC_GEOMETRY:
2066 struct ccb_calc_geometry *ccg = &ccb->ccg;
2067 u_int32_t secs_per_cylinder;
2069 debug(2, "XPT_CALC_GEOMETRY %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
2071 if (sc->mly_controllerparam->bios_geometry == MLY_BIOSGEOM_8G) {
2073 ccg->secs_per_track = 63;
2074 } else { /* MLY_BIOSGEOM_2G */
2076 ccg->secs_per_track = 32;
2078 secs_per_cylinder = ccg->heads * ccg->secs_per_track;
2079 ccg->cylinders = ccg->volume_size / secs_per_cylinder;
2080 ccb->ccb_h.status = CAM_REQ_CMP;
2084 /* handle path attribute inquiry */
2087 struct ccb_pathinq *cpi = &ccb->cpi;
2089 debug(2, "XPT_PATH_INQ %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
2091 cpi->version_num = 1;
2092 cpi->hba_inquiry = PI_TAG_ABLE; /* XXX extra flags for physical channels? */
2093 cpi->target_sprt = 0;
2095 cpi->max_target = MLY_MAX_TARGETS - 1;
2096 cpi->max_lun = MLY_MAX_LUNS - 1;
2097 cpi->initiator_id = sc->mly_controllerparam->initiator_id;
2098 strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
2099 strncpy(cpi->hba_vid, "FreeBSD", HBA_IDLEN);
2100 strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
2101 cpi->unit_number = cam_sim_unit(sim);
2102 cpi->bus_id = cam_sim_bus(sim);
2103 cpi->base_transfer_speed = 132 * 1024; /* XXX what to set this to? */
2104 cpi->transport = XPORT_SPI;
2105 cpi->transport_version = 2;
2106 cpi->protocol = PROTO_SCSI;
2107 cpi->protocol_version = SCSI_REV_2;
2108 ccb->ccb_h.status = CAM_REQ_CMP;
2112 case XPT_GET_TRAN_SETTINGS:
2114 struct ccb_trans_settings *cts = &ccb->cts;
2116 struct ccb_trans_settings_scsi *scsi = &cts->proto_specific.scsi;
2117 struct ccb_trans_settings_spi *spi = &cts->xport_specific.spi;
2119 cts->protocol = PROTO_SCSI;
2120 cts->protocol_version = SCSI_REV_2;
2121 cts->transport = XPORT_SPI;
2122 cts->transport_version = 2;
2129 bus = cam_sim_bus(sim);
2130 target = cts->ccb_h.target_id;
2131 debug(2, "XPT_GET_TRAN_SETTINGS %d:%d", bus, target);
2132 /* logical device? */
2133 if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_LOGICAL) {
2134 /* nothing special for these */
2135 /* physical device? */
2136 } else if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_PHYSICAL) {
2137 /* allow CAM to try tagged transactions */
2138 scsi->flags |= CTS_SCSI_FLAGS_TAG_ENB;
2139 scsi->valid |= CTS_SCSI_VALID_TQ;
2141 /* convert speed (MHz) to usec */
2142 if (sc->mly_btl[bus][target].mb_speed == 0) {
2143 spi->sync_period = 1000000 / 5;
2145 spi->sync_period = 1000000 / sc->mly_btl[bus][target].mb_speed;
2148 /* convert bus width to CAM internal encoding */
2149 switch (sc->mly_btl[bus][target].mb_width) {
2151 spi->bus_width = MSG_EXT_WDTR_BUS_32_BIT;
2154 spi->bus_width = MSG_EXT_WDTR_BUS_16_BIT;
2158 spi->bus_width = MSG_EXT_WDTR_BUS_8_BIT;
2161 spi->valid |= CTS_SPI_VALID_SYNC_RATE | CTS_SPI_VALID_BUS_WIDTH;
2163 /* not a device, bail out */
2165 cts->ccb_h.status = CAM_REQ_CMP_ERR;
2169 /* disconnect always OK */
2170 spi->flags |= CTS_SPI_FLAGS_DISC_ENB;
2171 spi->valid |= CTS_SPI_VALID_DISC;
2173 cts->ccb_h.status = CAM_REQ_CMP;
2177 default: /* we can't do this */
2178 debug(2, "unspported func_code = 0x%x", ccb->ccb_h.func_code);
2179 ccb->ccb_h.status = CAM_REQ_INVALID;
2186 /********************************************************************************
2187 * Handle an I/O operation requested by CAM
2190 mly_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio)
2192 struct mly_softc *sc = cam_sim_softc(sim);
2193 struct mly_command *mc;
2194 struct mly_command_scsi_small *ss;
2199 bus = cam_sim_bus(sim);
2200 target = csio->ccb_h.target_id;
2202 debug(2, "XPT_SCSI_IO %d:%d:%d", bus, target, csio->ccb_h.target_lun);
2204 /* validate bus number */
2205 if (!MLY_BUS_IS_VALID(sc, bus)) {
2206 debug(0, " invalid bus %d", bus);
2207 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2210 /* check for I/O attempt to a protected device */
2211 if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_PROTECTED) {
2212 debug(2, " device protected");
2213 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2216 /* check for I/O attempt to nonexistent device */
2217 if (!(sc->mly_btl[bus][target].mb_flags & (MLY_BTL_LOGICAL | MLY_BTL_PHYSICAL))) {
2218 debug(2, " device %d:%d does not exist", bus, target);
2219 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2222 /* XXX increase if/when we support large SCSI commands */
2223 if (csio->cdb_len > MLY_CMD_SCSI_SMALL_CDB) {
2224 debug(0, " command too large (%d > %d)", csio->cdb_len, MLY_CMD_SCSI_SMALL_CDB);
2225 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2228 /* check that the CDB pointer is not to a physical address */
2229 if ((csio->ccb_h.flags & CAM_CDB_POINTER) && (csio->ccb_h.flags & CAM_CDB_PHYS)) {
2230 debug(0, " CDB pointer is to physical address");
2231 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2234 /* if there is data transfer, it must be to/from a virtual address */
2235 if ((csio->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
2236 if (csio->ccb_h.flags & CAM_DATA_PHYS) { /* we can't map it */
2237 debug(0, " data pointer is to physical address");
2238 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2240 if (csio->ccb_h.flags & CAM_SCATTER_VALID) { /* we want to do the s/g setup */
2241 debug(0, " data has premature s/g setup");
2242 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2246 /* abandon aborted ccbs or those that have failed validation */
2247 if ((csio->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
2248 debug(2, "abandoning CCB due to abort/validation failure");
2253 * Get a command, or push the ccb back to CAM and freeze the queue.
2255 if ((error = mly_alloc_command(sc, &mc))) {
2257 xpt_freeze_simq(sim, 1);
2258 csio->ccb_h.status |= CAM_REQUEUE_REQ;
2259 sc->mly_qfrzn_cnt++;
2264 /* build the command */
2265 mc->mc_data = csio->data_ptr;
2266 mc->mc_length = csio->dxfer_len;
2267 mc->mc_complete = mly_cam_complete;
2268 mc->mc_private = csio;
2270 /* save the bus number in the ccb for later recovery XXX should be a better way */
2271 csio->ccb_h.sim_priv.entries[0].field = bus;
2273 /* build the packet for the controller */
2274 ss = &mc->mc_packet->scsi_small;
2275 ss->opcode = MDACMD_SCSI;
2276 if (csio->ccb_h.flags & CAM_DIS_DISCONNECT)
2277 ss->command_control.disable_disconnect = 1;
2278 if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT)
2279 ss->command_control.data_direction = MLY_CCB_WRITE;
2280 ss->data_size = csio->dxfer_len;
2281 ss->addr.phys.lun = csio->ccb_h.target_lun;
2282 ss->addr.phys.target = csio->ccb_h.target_id;
2283 ss->addr.phys.channel = bus;
2284 if (csio->ccb_h.timeout < (60 * 1000)) {
2285 ss->timeout.value = csio->ccb_h.timeout / 1000;
2286 ss->timeout.scale = MLY_TIMEOUT_SECONDS;
2287 } else if (csio->ccb_h.timeout < (60 * 60 * 1000)) {
2288 ss->timeout.value = csio->ccb_h.timeout / (60 * 1000);
2289 ss->timeout.scale = MLY_TIMEOUT_MINUTES;
2291 ss->timeout.value = csio->ccb_h.timeout / (60 * 60 * 1000); /* overflow? */
2292 ss->timeout.scale = MLY_TIMEOUT_HOURS;
2294 ss->maximum_sense_size = csio->sense_len;
2295 ss->cdb_length = csio->cdb_len;
2296 if (csio->ccb_h.flags & CAM_CDB_POINTER) {
2297 bcopy(csio->cdb_io.cdb_ptr, ss->cdb, csio->cdb_len);
2299 bcopy(csio->cdb_io.cdb_bytes, ss->cdb, csio->cdb_len);
2302 /* give the command to the controller */
2303 if ((error = mly_start(mc))) {
2305 xpt_freeze_simq(sim, 1);
2306 csio->ccb_h.status |= CAM_REQUEUE_REQ;
2307 sc->mly_qfrzn_cnt++;
2315 /********************************************************************************
2316 * Check for possibly-completed commands.
2319 mly_cam_poll(struct cam_sim *sim)
2321 struct mly_softc *sc = cam_sim_softc(sim);
2328 /********************************************************************************
2329 * Handle completion of a command - pass results back through the CCB
2332 mly_cam_complete(struct mly_command *mc)
2334 struct mly_softc *sc = mc->mc_sc;
2335 struct ccb_scsiio *csio = (struct ccb_scsiio *)mc->mc_private;
2336 struct scsi_inquiry_data *inq = (struct scsi_inquiry_data *)csio->data_ptr;
2337 struct mly_btl *btl;
2344 csio->scsi_status = mc->mc_status;
2345 switch(mc->mc_status) {
2346 case SCSI_STATUS_OK:
2348 * In order to report logical device type and status, we overwrite
2349 * the result of the INQUIRY command to logical devices.
2351 bus = csio->ccb_h.sim_priv.entries[0].field;
2352 target = csio->ccb_h.target_id;
2353 /* XXX validate bus/target? */
2354 if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_LOGICAL) {
2355 if (csio->ccb_h.flags & CAM_CDB_POINTER) {
2356 cmd = *csio->cdb_io.cdb_ptr;
2358 cmd = csio->cdb_io.cdb_bytes[0];
2360 if (cmd == INQUIRY) {
2361 btl = &sc->mly_btl[bus][target];
2362 padstr(inq->vendor, mly_describe_code(mly_table_device_type, btl->mb_type), 8);
2363 padstr(inq->product, mly_describe_code(mly_table_device_state, btl->mb_state), 16);
2364 padstr(inq->revision, "", 4);
2368 debug(2, "SCSI_STATUS_OK");
2369 csio->ccb_h.status = CAM_REQ_CMP;
2372 case SCSI_STATUS_CHECK_COND:
2373 debug(1, "SCSI_STATUS_CHECK_COND sense %d resid %d", mc->mc_sense, mc->mc_resid);
2374 csio->ccb_h.status = CAM_SCSI_STATUS_ERROR;
2375 bzero(&csio->sense_data, SSD_FULL_SIZE);
2376 bcopy(mc->mc_packet, &csio->sense_data, mc->mc_sense);
2377 csio->sense_len = mc->mc_sense;
2378 csio->ccb_h.status |= CAM_AUTOSNS_VALID;
2379 csio->resid = mc->mc_resid; /* XXX this is a signed value... */
2382 case SCSI_STATUS_BUSY:
2383 debug(1, "SCSI_STATUS_BUSY");
2384 csio->ccb_h.status = CAM_SCSI_BUSY;
2388 debug(1, "unknown status 0x%x", csio->scsi_status);
2389 csio->ccb_h.status = CAM_REQ_CMP_ERR;
2394 if (sc->mly_qfrzn_cnt) {
2395 csio->ccb_h.status |= CAM_RELEASE_SIMQ;
2396 sc->mly_qfrzn_cnt--;
2400 xpt_done((union ccb *)csio);
2401 mly_release_command(mc);
2404 /********************************************************************************
2405 * Find a peripheral attahed at (bus),(target)
2407 static struct cam_periph *
2408 mly_find_periph(struct mly_softc *sc, int bus, int target)
2410 struct cam_periph *periph;
2411 struct cam_path *path;
2414 status = xpt_create_path(&path, NULL, cam_sim_path(sc->mly_cam_sim[bus]), target, 0);
2415 if (status == CAM_REQ_CMP) {
2416 periph = cam_periph_find(path, NULL);
2417 xpt_free_path(path);
2424 /********************************************************************************
2425 * Name the device at (bus)(target)
2428 mly_name_device(struct mly_softc *sc, int bus, int target)
2430 struct cam_periph *periph;
2432 if ((periph = mly_find_periph(sc, bus, target)) != NULL) {
2433 sprintf(sc->mly_btl[bus][target].mb_name, "%s%d", periph->periph_name, periph->unit_number);
2436 sc->mly_btl[bus][target].mb_name[0] = 0;
2440 /********************************************************************************
2441 ********************************************************************************
2443 ********************************************************************************
2444 ********************************************************************************/
2446 /********************************************************************************
2447 * Handshake with the firmware while the card is being initialised.
2450 mly_fwhandshake(struct mly_softc *sc)
2452 u_int8_t error, param0, param1;
2457 /* set HM_STSACK and let the firmware initialise */
2458 MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_STSACK);
2459 DELAY(1000); /* too short? */
2461 /* if HM_STSACK is still true, the controller is initialising */
2462 if (!MLY_IDBR_TRUE(sc, MLY_HM_STSACK))
2464 mly_printf(sc, "controller initialisation started\n");
2466 /* spin waiting for initialisation to finish, or for a message to be delivered */
2467 while (MLY_IDBR_TRUE(sc, MLY_HM_STSACK)) {
2468 /* check for a message */
2469 if (MLY_ERROR_VALID(sc)) {
2470 error = MLY_GET_REG(sc, sc->mly_error_status) & ~MLY_MSG_EMPTY;
2471 param0 = MLY_GET_REG(sc, sc->mly_command_mailbox);
2472 param1 = MLY_GET_REG(sc, sc->mly_command_mailbox + 1);
2475 case MLY_MSG_SPINUP:
2477 mly_printf(sc, "drive spinup in progress\n");
2478 spinup = 1; /* only print this once (should print drive being spun?) */
2481 case MLY_MSG_RACE_RECOVERY_FAIL:
2482 mly_printf(sc, "mirror race recovery failed, one or more drives offline\n");
2484 case MLY_MSG_RACE_IN_PROGRESS:
2485 mly_printf(sc, "mirror race recovery in progress\n");
2487 case MLY_MSG_RACE_ON_CRITICAL:
2488 mly_printf(sc, "mirror race recovery on a critical drive\n");
2490 case MLY_MSG_PARITY_ERROR:
2491 mly_printf(sc, "FATAL MEMORY PARITY ERROR\n");
2494 mly_printf(sc, "unknown initialisation code 0x%x\n", error);
2501 /********************************************************************************
2502 ********************************************************************************
2503 Debugging and Diagnostics
2504 ********************************************************************************
2505 ********************************************************************************/
2507 /********************************************************************************
2508 * Print some information about the controller.
2511 mly_describe_controller(struct mly_softc *sc)
2513 struct mly_ioctl_getcontrollerinfo *mi = sc->mly_controllerinfo;
2515 mly_printf(sc, "%16s, %d channel%s, firmware %d.%02d-%d-%02d (%02d%02d%02d%02d), %dMB RAM\n",
2516 mi->controller_name, mi->physical_channels_present, (mi->physical_channels_present) > 1 ? "s" : "",
2517 mi->fw_major, mi->fw_minor, mi->fw_turn, mi->fw_build, /* XXX turn encoding? */
2518 mi->fw_century, mi->fw_year, mi->fw_month, mi->fw_day,
2522 mly_printf(sc, "%s %s (%x), %dMHz %d-bit %.16s\n",
2523 mly_describe_code(mly_table_oemname, mi->oem_information),
2524 mly_describe_code(mly_table_controllertype, mi->controller_type), mi->controller_type,
2525 mi->interface_speed, mi->interface_width, mi->interface_name);
2526 mly_printf(sc, "%dMB %dMHz %d-bit %s%s%s, cache %dMB\n",
2527 mi->memory_size, mi->memory_speed, mi->memory_width,
2528 mly_describe_code(mly_table_memorytype, mi->memory_type),
2529 mi->memory_parity ? "+parity": "",mi->memory_ecc ? "+ECC": "",
2531 mly_printf(sc, "CPU: %s @ %dMHZ\n",
2532 mly_describe_code(mly_table_cputype, mi->cpu[0].type), mi->cpu[0].speed);
2533 if (mi->l2cache_size != 0)
2534 mly_printf(sc, "%dKB L2 cache\n", mi->l2cache_size);
2535 if (mi->exmemory_size != 0)
2536 mly_printf(sc, "%dMB %dMHz %d-bit private %s%s%s\n",
2537 mi->exmemory_size, mi->exmemory_speed, mi->exmemory_width,
2538 mly_describe_code(mly_table_memorytype, mi->exmemory_type),
2539 mi->exmemory_parity ? "+parity": "",mi->exmemory_ecc ? "+ECC": "");
2540 mly_printf(sc, "battery backup %s\n", mi->bbu_present ? "present" : "not installed");
2541 mly_printf(sc, "maximum data transfer %d blocks, maximum sg entries/command %d\n",
2542 mi->maximum_block_count, mi->maximum_sg_entries);
2543 mly_printf(sc, "logical devices present/critical/offline %d/%d/%d\n",
2544 mi->logical_devices_present, mi->logical_devices_critical, mi->logical_devices_offline);
2545 mly_printf(sc, "physical devices present %d\n",
2546 mi->physical_devices_present);
2547 mly_printf(sc, "physical disks present/offline %d/%d\n",
2548 mi->physical_disks_present, mi->physical_disks_offline);
2549 mly_printf(sc, "%d physical channel%s, %d virtual channel%s of %d possible\n",
2550 mi->physical_channels_present, mi->physical_channels_present == 1 ? "" : "s",
2551 mi->virtual_channels_present, mi->virtual_channels_present == 1 ? "" : "s",
2552 mi->virtual_channels_possible);
2553 mly_printf(sc, "%d parallel commands supported\n", mi->maximum_parallel_commands);
2554 mly_printf(sc, "%dMB flash ROM, %d of %d maximum cycles\n",
2555 mi->flash_size, mi->flash_age, mi->flash_maximum_age);
2560 /********************************************************************************
2561 * Print some controller state
2564 mly_printstate(struct mly_softc *sc)
2566 mly_printf(sc, "IDBR %02x ODBR %02x ERROR %02x (%x %x %x)\n",
2567 MLY_GET_REG(sc, sc->mly_idbr),
2568 MLY_GET_REG(sc, sc->mly_odbr),
2569 MLY_GET_REG(sc, sc->mly_error_status),
2572 sc->mly_error_status);
2573 mly_printf(sc, "IMASK %02x ISTATUS %02x\n",
2574 MLY_GET_REG(sc, sc->mly_interrupt_mask),
2575 MLY_GET_REG(sc, sc->mly_interrupt_status));
2576 mly_printf(sc, "COMMAND %02x %02x %02x %02x %02x %02x %02x %02x\n",
2577 MLY_GET_REG(sc, sc->mly_command_mailbox),
2578 MLY_GET_REG(sc, sc->mly_command_mailbox + 1),
2579 MLY_GET_REG(sc, sc->mly_command_mailbox + 2),
2580 MLY_GET_REG(sc, sc->mly_command_mailbox + 3),
2581 MLY_GET_REG(sc, sc->mly_command_mailbox + 4),
2582 MLY_GET_REG(sc, sc->mly_command_mailbox + 5),
2583 MLY_GET_REG(sc, sc->mly_command_mailbox + 6),
2584 MLY_GET_REG(sc, sc->mly_command_mailbox + 7));
2585 mly_printf(sc, "STATUS %02x %02x %02x %02x %02x %02x %02x %02x\n",
2586 MLY_GET_REG(sc, sc->mly_status_mailbox),
2587 MLY_GET_REG(sc, sc->mly_status_mailbox + 1),
2588 MLY_GET_REG(sc, sc->mly_status_mailbox + 2),
2589 MLY_GET_REG(sc, sc->mly_status_mailbox + 3),
2590 MLY_GET_REG(sc, sc->mly_status_mailbox + 4),
2591 MLY_GET_REG(sc, sc->mly_status_mailbox + 5),
2592 MLY_GET_REG(sc, sc->mly_status_mailbox + 6),
2593 MLY_GET_REG(sc, sc->mly_status_mailbox + 7));
2594 mly_printf(sc, " %04x %08x\n",
2595 MLY_GET_REG2(sc, sc->mly_status_mailbox),
2596 MLY_GET_REG4(sc, sc->mly_status_mailbox + 4));
2599 struct mly_softc *mly_softc0 = NULL;
2601 mly_printstate0(void)
2603 if (mly_softc0 != NULL)
2604 mly_printstate(mly_softc0);
2607 /********************************************************************************
2611 mly_print_command(struct mly_command *mc)
2613 struct mly_softc *sc = mc->mc_sc;
2615 mly_printf(sc, "COMMAND @ %p\n", mc);
2616 mly_printf(sc, " slot %d\n", mc->mc_slot);
2617 mly_printf(sc, " status 0x%x\n", mc->mc_status);
2618 mly_printf(sc, " sense len %d\n", mc->mc_sense);
2619 mly_printf(sc, " resid %d\n", mc->mc_resid);
2620 mly_printf(sc, " packet %p/0x%llx\n", mc->mc_packet, mc->mc_packetphys);
2621 if (mc->mc_packet != NULL)
2622 mly_print_packet(mc);
2623 mly_printf(sc, " data %p/%d\n", mc->mc_data, mc->mc_length);
2624 mly_printf(sc, " flags %b\n", mc->mc_flags, "\20\1busy\2complete\3slotted\4mapped\5datain\6dataout\n");
2625 mly_printf(sc, " complete %p\n", mc->mc_complete);
2626 mly_printf(sc, " private %p\n", mc->mc_private);
2629 /********************************************************************************
2630 * Print a command packet
2633 mly_print_packet(struct mly_command *mc)
2635 struct mly_softc *sc = mc->mc_sc;
2636 struct mly_command_generic *ge = (struct mly_command_generic *)mc->mc_packet;
2637 struct mly_command_scsi_small *ss = (struct mly_command_scsi_small *)mc->mc_packet;
2638 struct mly_command_scsi_large *sl = (struct mly_command_scsi_large *)mc->mc_packet;
2639 struct mly_command_ioctl *io = (struct mly_command_ioctl *)mc->mc_packet;
2642 mly_printf(sc, " command_id %d\n", ge->command_id);
2643 mly_printf(sc, " opcode %d\n", ge->opcode);
2644 mly_printf(sc, " command_control fua %d dpo %d est %d dd %s nas %d ddis %d\n",
2645 ge->command_control.force_unit_access,
2646 ge->command_control.disable_page_out,
2647 ge->command_control.extended_sg_table,
2648 (ge->command_control.data_direction == MLY_CCB_WRITE) ? "WRITE" : "READ",
2649 ge->command_control.no_auto_sense,
2650 ge->command_control.disable_disconnect);
2651 mly_printf(sc, " data_size %d\n", ge->data_size);
2652 mly_printf(sc, " sense_buffer_address 0x%llx\n", ge->sense_buffer_address);
2653 mly_printf(sc, " lun %d\n", ge->addr.phys.lun);
2654 mly_printf(sc, " target %d\n", ge->addr.phys.target);
2655 mly_printf(sc, " channel %d\n", ge->addr.phys.channel);
2656 mly_printf(sc, " logical device %d\n", ge->addr.log.logdev);
2657 mly_printf(sc, " controller %d\n", ge->addr.phys.controller);
2658 mly_printf(sc, " timeout %d %s\n",
2660 (ge->timeout.scale == MLY_TIMEOUT_SECONDS) ? "seconds" :
2661 ((ge->timeout.scale == MLY_TIMEOUT_MINUTES) ? "minutes" : "hours"));
2662 mly_printf(sc, " maximum_sense_size %d\n", ge->maximum_sense_size);
2663 switch(ge->opcode) {
2666 mly_printf(sc, " cdb length %d\n", ss->cdb_length);
2667 mly_printf(sc, " cdb %*D\n", ss->cdb_length, ss->cdb, " ");
2671 case MDACMD_SCSILCPT:
2672 mly_printf(sc, " cdb length %d\n", sl->cdb_length);
2673 mly_printf(sc, " cdb 0x%llx\n", sl->cdb_physaddr);
2677 mly_printf(sc, " sub_ioctl 0x%x\n", io->sub_ioctl);
2678 switch(io->sub_ioctl) {
2679 case MDACIOCTL_SETMEMORYMAILBOX:
2680 mly_printf(sc, " health_buffer_size %d\n",
2681 io->param.setmemorymailbox.health_buffer_size);
2682 mly_printf(sc, " health_buffer_phys 0x%llx\n",
2683 io->param.setmemorymailbox.health_buffer_physaddr);
2684 mly_printf(sc, " command_mailbox 0x%llx\n",
2685 io->param.setmemorymailbox.command_mailbox_physaddr);
2686 mly_printf(sc, " status_mailbox 0x%llx\n",
2687 io->param.setmemorymailbox.status_mailbox_physaddr);
2691 case MDACIOCTL_SETREALTIMECLOCK:
2692 case MDACIOCTL_GETHEALTHSTATUS:
2693 case MDACIOCTL_GETCONTROLLERINFO:
2694 case MDACIOCTL_GETLOGDEVINFOVALID:
2695 case MDACIOCTL_GETPHYSDEVINFOVALID:
2696 case MDACIOCTL_GETPHYSDEVSTATISTICS:
2697 case MDACIOCTL_GETLOGDEVSTATISTICS:
2698 case MDACIOCTL_GETCONTROLLERSTATISTICS:
2699 case MDACIOCTL_GETBDT_FOR_SYSDRIVE:
2700 case MDACIOCTL_CREATENEWCONF:
2701 case MDACIOCTL_ADDNEWCONF:
2702 case MDACIOCTL_GETDEVCONFINFO:
2703 case MDACIOCTL_GETFREESPACELIST:
2704 case MDACIOCTL_MORE:
2705 case MDACIOCTL_SETPHYSDEVPARAMETER:
2706 case MDACIOCTL_GETPHYSDEVPARAMETER:
2707 case MDACIOCTL_GETLOGDEVPARAMETER:
2708 case MDACIOCTL_SETLOGDEVPARAMETER:
2709 mly_printf(sc, " param %10D\n", io->param.data.param, " ");
2713 case MDACIOCTL_GETEVENT:
2714 mly_printf(sc, " event %d\n",
2715 io->param.getevent.sequence_number_low + ((u_int32_t)io->addr.log.logdev << 16));
2719 case MDACIOCTL_SETRAIDDEVSTATE:
2720 mly_printf(sc, " state %d\n", io->param.setraiddevstate.state);
2724 case MDACIOCTL_XLATEPHYSDEVTORAIDDEV:
2725 mly_printf(sc, " raid_device %d\n", io->param.xlatephysdevtoraiddev.raid_device);
2726 mly_printf(sc, " controller %d\n", io->param.xlatephysdevtoraiddev.controller);
2727 mly_printf(sc, " channel %d\n", io->param.xlatephysdevtoraiddev.channel);
2728 mly_printf(sc, " target %d\n", io->param.xlatephysdevtoraiddev.target);
2729 mly_printf(sc, " lun %d\n", io->param.xlatephysdevtoraiddev.lun);
2733 case MDACIOCTL_GETGROUPCONFINFO:
2734 mly_printf(sc, " group %d\n", io->param.getgroupconfinfo.group);
2738 case MDACIOCTL_GET_SUBSYSTEM_DATA:
2739 case MDACIOCTL_SET_SUBSYSTEM_DATA:
2740 case MDACIOCTL_STARTDISOCVERY:
2741 case MDACIOCTL_INITPHYSDEVSTART:
2742 case MDACIOCTL_INITPHYSDEVSTOP:
2743 case MDACIOCTL_INITRAIDDEVSTART:
2744 case MDACIOCTL_INITRAIDDEVSTOP:
2745 case MDACIOCTL_REBUILDRAIDDEVSTART:
2746 case MDACIOCTL_REBUILDRAIDDEVSTOP:
2747 case MDACIOCTL_MAKECONSISTENTDATASTART:
2748 case MDACIOCTL_MAKECONSISTENTDATASTOP:
2749 case MDACIOCTL_CONSISTENCYCHECKSTART:
2750 case MDACIOCTL_CONSISTENCYCHECKSTOP:
2751 case MDACIOCTL_RESETDEVICE:
2752 case MDACIOCTL_FLUSHDEVICEDATA:
2753 case MDACIOCTL_PAUSEDEVICE:
2754 case MDACIOCTL_UNPAUSEDEVICE:
2755 case MDACIOCTL_LOCATEDEVICE:
2756 case MDACIOCTL_SETMASTERSLAVEMODE:
2757 case MDACIOCTL_DELETERAIDDEV:
2758 case MDACIOCTL_REPLACEINTERNALDEV:
2759 case MDACIOCTL_CLEARCONF:
2760 case MDACIOCTL_GETCONTROLLERPARAMETER:
2761 case MDACIOCTL_SETCONTRLLERPARAMETER:
2762 case MDACIOCTL_CLEARCONFSUSPMODE:
2763 case MDACIOCTL_STOREIMAGE:
2764 case MDACIOCTL_READIMAGE:
2765 case MDACIOCTL_FLASHIMAGES:
2766 case MDACIOCTL_RENAMERAIDDEV:
2767 default: /* no idea what to print */
2773 case MDACMD_IOCTLCHECK:
2774 case MDACMD_MEMCOPY:
2777 break; /* print nothing */
2780 if (ge->command_control.extended_sg_table) {
2781 mly_printf(sc, " sg table 0x%llx/%d\n",
2782 ge->transfer.indirect.table_physaddr[0], ge->transfer.indirect.entries[0]);
2784 mly_printf(sc, " 0000 0x%llx/%lld\n",
2785 ge->transfer.direct.sg[0].physaddr, ge->transfer.direct.sg[0].length);
2786 mly_printf(sc, " 0001 0x%llx/%lld\n",
2787 ge->transfer.direct.sg[1].physaddr, ge->transfer.direct.sg[1].length);
2792 /********************************************************************************
2793 * Panic in a slightly informative fashion
2796 mly_panic(struct mly_softc *sc, char *reason)
2802 /********************************************************************************
2803 * Print queue statistics, callable from DDB.
2806 mly_print_controller(int controller)
2808 struct mly_softc *sc;
2810 if ((sc = devclass_get_softc(devclass_find("mly"), controller)) == NULL) {
2811 printf("mly: controller %d invalid\n", controller);
2813 device_printf(sc->mly_dev, "queue curr max\n");
2814 device_printf(sc->mly_dev, "free %04d/%04d\n",
2815 sc->mly_qstat[MLYQ_FREE].q_length, sc->mly_qstat[MLYQ_FREE].q_max);
2816 device_printf(sc->mly_dev, "busy %04d/%04d\n",
2817 sc->mly_qstat[MLYQ_BUSY].q_length, sc->mly_qstat[MLYQ_BUSY].q_max);
2818 device_printf(sc->mly_dev, "complete %04d/%04d\n",
2819 sc->mly_qstat[MLYQ_COMPLETE].q_length, sc->mly_qstat[MLYQ_COMPLETE].q_max);
2825 /********************************************************************************
2826 ********************************************************************************
2827 Control device interface
2828 ********************************************************************************
2829 ********************************************************************************/
2831 /********************************************************************************
2832 * Accept an open operation on the control device.
2835 mly_user_open(struct cdev *dev, int flags, int fmt, struct thread *td)
2837 struct mly_softc *sc = dev->si_drv1;
2839 sc->mly_state |= MLY_STATE_OPEN;
2843 /********************************************************************************
2844 * Accept the last close on the control device.
2847 mly_user_close(struct cdev *dev, int flags, int fmt, struct thread *td)
2849 struct mly_softc *sc = dev->si_drv1;
2851 sc->mly_state &= ~MLY_STATE_OPEN;
2855 /********************************************************************************
2856 * Handle controller-specific control operations.
2859 mly_user_ioctl(struct cdev *dev, u_long cmd, caddr_t addr,
2860 int32_t flag, struct thread *td)
2862 struct mly_softc *sc = (struct mly_softc *)dev->si_drv1;
2863 struct mly_user_command *uc = (struct mly_user_command *)addr;
2864 struct mly_user_health *uh = (struct mly_user_health *)addr;
2868 return(mly_user_command(sc, uc));
2870 return(mly_user_health(sc, uh));
2876 /********************************************************************************
2877 * Execute a command passed in from userspace.
2879 * The control structure contains the actual command for the controller, as well
2880 * as the user-space data pointer and data size, and an optional sense buffer
2881 * size/pointer. On completion, the data size is adjusted to the command
2882 * residual, and the sense buffer size to the size of the returned sense data.
2886 mly_user_command(struct mly_softc *sc, struct mly_user_command *uc)
2888 struct mly_command *mc;
2891 /* allocate a command */
2892 if (mly_alloc_command(sc, &mc)) {
2894 goto out; /* XXX Linux version will wait for a command */
2897 /* handle data size/direction */
2898 mc->mc_length = (uc->DataTransferLength >= 0) ? uc->DataTransferLength : -uc->DataTransferLength;
2899 if (mc->mc_length > 0) {
2900 if ((mc->mc_data = malloc(mc->mc_length, M_DEVBUF, M_NOWAIT)) == NULL) {
2905 if (uc->DataTransferLength > 0) {
2906 mc->mc_flags |= MLY_CMD_DATAIN;
2907 bzero(mc->mc_data, mc->mc_length);
2909 if (uc->DataTransferLength < 0) {
2910 mc->mc_flags |= MLY_CMD_DATAOUT;
2911 if ((error = copyin(uc->DataTransferBuffer, mc->mc_data, mc->mc_length)) != 0)
2915 /* copy the controller command */
2916 bcopy(&uc->CommandMailbox, mc->mc_packet, sizeof(uc->CommandMailbox));
2918 /* clear command completion handler so that we get woken up */
2919 mc->mc_complete = NULL;
2921 /* execute the command */
2922 if ((error = mly_start(mc)) != 0)
2925 while (!(mc->mc_flags & MLY_CMD_COMPLETE))
2926 tsleep(mc, PRIBIO, "mlyioctl", 0);
2929 /* return the data to userspace */
2930 if (uc->DataTransferLength > 0)
2931 if ((error = copyout(mc->mc_data, uc->DataTransferBuffer, mc->mc_length)) != 0)
2934 /* return the sense buffer to userspace */
2935 if ((uc->RequestSenseLength > 0) && (mc->mc_sense > 0)) {
2936 if ((error = copyout(mc->mc_packet, uc->RequestSenseBuffer,
2937 min(uc->RequestSenseLength, mc->mc_sense))) != 0)
2941 /* return command results to userspace (caller will copy out) */
2942 uc->DataTransferLength = mc->mc_resid;
2943 uc->RequestSenseLength = min(uc->RequestSenseLength, mc->mc_sense);
2944 uc->CommandStatus = mc->mc_status;
2948 if (mc->mc_data != NULL)
2949 free(mc->mc_data, M_DEVBUF);
2951 mly_release_command(mc);
2955 /********************************************************************************
2956 * Return health status to userspace. If the health change index in the user
2957 * structure does not match that currently exported by the controller, we
2958 * return the current status immediately. Otherwise, we block until either
2959 * interrupted or new status is delivered.
2962 mly_user_health(struct mly_softc *sc, struct mly_user_health *uh)
2964 struct mly_health_status mh;
2967 /* fetch the current health status from userspace */
2968 if ((error = copyin(uh->HealthStatusBuffer, &mh, sizeof(mh))) != 0)
2971 /* spin waiting for a status update */
2973 error = EWOULDBLOCK;
2974 while ((error != 0) && (sc->mly_event_change == mh.change_counter))
2975 error = tsleep(&sc->mly_event_change, PRIBIO | PCATCH, "mlyhealth", 0);
2978 /* copy the controller's health status buffer out (there is a race here if it changes again) */
2979 error = copyout(&sc->mly_mmbox->mmm_health.status, uh->HealthStatusBuffer,
2980 sizeof(uh->HealthStatusBuffer));
2985 mly_timeout(struct mly_softc *sc)
2987 struct mly_command *mc;
2990 deadline = time_second - MLY_CMD_TIMEOUT;
2991 TAILQ_FOREACH(mc, &sc->mly_busy, mc_link) {
2992 if ((mc->mc_timestamp < deadline)) {
2993 device_printf(sc->mly_dev,
2994 "COMMAND %p TIMEOUT AFTER %d SECONDS\n", mc,
2995 (int)(time_second - mc->mc_timestamp));
2999 timeout((timeout_t *)mly_timeout, sc, MLY_CMD_TIMEOUT * hz);