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