2 * Copyright (c) 1999 Michael Smith
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $FreeBSD: src/sys/dev/mlx/mlx.c,v 1.14.2.5 2001/09/11 09:49:53 kris Exp $
27 * $DragonFly: src/sys/dev/raid/mlx/mlx.c,v 1.3 2003/06/23 17:55:32 dillon Exp $
31 * Driver for the Mylex DAC960 family of RAID controllers.
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/malloc.h>
37 #include <sys/kernel.h>
41 #include <sys/devicestat.h>
45 #include <machine/resource.h>
46 #include <machine/bus_memio.h>
47 #include <machine/bus_pio.h>
48 #include <machine/bus.h>
49 #include <machine/clock.h>
52 #include <dev/mlx/mlx_compat.h>
53 #include <dev/mlx/mlxio.h>
54 #include <dev/mlx/mlxvar.h>
55 #include <dev/mlx/mlxreg.h>
57 #define MLX_CDEV_MAJOR 130
59 static struct cdevsw mlx_cdevsw = {
61 /* close */ mlx_close,
64 /* ioctl */ mlx_ioctl,
67 /* strategy */ nostrategy,
69 /* maj */ MLX_CDEV_MAJOR,
75 devclass_t mlx_devclass;
78 * Per-interface accessor methods
80 static int mlx_v3_tryqueue(struct mlx_softc *sc, struct mlx_command *mc);
81 static int mlx_v3_findcomplete(struct mlx_softc *sc, u_int8_t *slot, u_int16_t *status);
82 static void mlx_v3_intaction(struct mlx_softc *sc, int action);
83 static int mlx_v3_fw_handshake(struct mlx_softc *sc, int *error, int *param1, int *param2);
85 static int mlx_v4_tryqueue(struct mlx_softc *sc, struct mlx_command *mc);
86 static int mlx_v4_findcomplete(struct mlx_softc *sc, u_int8_t *slot, u_int16_t *status);
87 static void mlx_v4_intaction(struct mlx_softc *sc, int action);
88 static int mlx_v4_fw_handshake(struct mlx_softc *sc, int *error, int *param1, int *param2);
90 static int mlx_v5_tryqueue(struct mlx_softc *sc, struct mlx_command *mc);
91 static int mlx_v5_findcomplete(struct mlx_softc *sc, u_int8_t *slot, u_int16_t *status);
92 static void mlx_v5_intaction(struct mlx_softc *sc, int action);
93 static int mlx_v5_fw_handshake(struct mlx_softc *sc, int *error, int *param1, int *param2);
98 static void mlx_periodic(void *data);
99 static void mlx_periodic_enquiry(struct mlx_command *mc);
100 static void mlx_periodic_eventlog_poll(struct mlx_softc *sc);
101 static void mlx_periodic_eventlog_respond(struct mlx_command *mc);
102 static void mlx_periodic_rebuild(struct mlx_command *mc);
107 static void mlx_pause_action(struct mlx_softc *sc);
108 static void mlx_pause_done(struct mlx_command *mc);
111 * Command submission.
113 static void *mlx_enquire(struct mlx_softc *sc, int command, size_t bufsize,
114 void (*complete)(struct mlx_command *mc));
115 static int mlx_flush(struct mlx_softc *sc);
116 static int mlx_check(struct mlx_softc *sc, int drive);
117 static int mlx_rebuild(struct mlx_softc *sc, int channel, int target);
118 static int mlx_wait_command(struct mlx_command *mc);
119 static int mlx_poll_command(struct mlx_command *mc);
120 static void mlx_startio(struct mlx_softc *sc);
121 static void mlx_completeio(struct mlx_command *mc);
122 static int mlx_user_command(struct mlx_softc *sc, struct mlx_usercommand *mu);
125 * Command buffer allocation.
127 static struct mlx_command *mlx_alloccmd(struct mlx_softc *sc);
128 static void mlx_releasecmd(struct mlx_command *mc);
129 static void mlx_freecmd(struct mlx_command *mc);
132 * Command management.
134 static int mlx_getslot(struct mlx_command *mc);
135 static void mlx_mapcmd(struct mlx_command *mc);
136 static void mlx_unmapcmd(struct mlx_command *mc);
137 static int mlx_start(struct mlx_command *mc);
138 static int mlx_done(struct mlx_softc *sc);
139 static void mlx_complete(struct mlx_softc *sc);
144 static char *mlx_diagnose_command(struct mlx_command *mc);
145 static void mlx_describe_controller(struct mlx_softc *sc);
146 static int mlx_fw_message(struct mlx_softc *sc, int status, int param1, int param2);
151 static struct mlx_sysdrive *mlx_findunit(struct mlx_softc *sc, int unit);
153 /********************************************************************************
154 ********************************************************************************
156 ********************************************************************************
157 ********************************************************************************/
159 /********************************************************************************
160 * Free all of the resources associated with (sc)
162 * Should not be called if the controller is active.
165 mlx_free(struct mlx_softc *sc)
167 struct mlx_command *mc;
171 /* cancel status timeout */
172 untimeout(mlx_periodic, sc, sc->mlx_timeout);
174 /* throw away any command buffers */
175 while ((mc = TAILQ_FIRST(&sc->mlx_freecmds)) != NULL) {
176 TAILQ_REMOVE(&sc->mlx_freecmds, mc, mc_link);
180 /* destroy data-transfer DMA tag */
181 if (sc->mlx_buffer_dmat)
182 bus_dma_tag_destroy(sc->mlx_buffer_dmat);
184 /* free and destroy DMA memory and tag for s/g lists */
186 bus_dmamem_free(sc->mlx_sg_dmat, sc->mlx_sgtable, sc->mlx_sg_dmamap);
188 bus_dma_tag_destroy(sc->mlx_sg_dmat);
190 /* disconnect the interrupt handler */
192 bus_teardown_intr(sc->mlx_dev, sc->mlx_irq, sc->mlx_intr);
193 if (sc->mlx_irq != NULL)
194 bus_release_resource(sc->mlx_dev, SYS_RES_IRQ, 0, sc->mlx_irq);
196 /* destroy the parent DMA tag */
197 if (sc->mlx_parent_dmat)
198 bus_dma_tag_destroy(sc->mlx_parent_dmat);
200 /* release the register window mapping */
201 if (sc->mlx_mem != NULL)
202 bus_release_resource(sc->mlx_dev, sc->mlx_mem_type, sc->mlx_mem_rid, sc->mlx_mem);
204 /* free controller enquiry data */
205 if (sc->mlx_enq2 != NULL)
206 free(sc->mlx_enq2, M_DEVBUF);
208 /* destroy control device */
209 if (sc->mlx_dev_t != (dev_t)NULL)
210 destroy_dev(sc->mlx_dev_t);
213 /********************************************************************************
214 * Map the scatter/gather table into bus space
217 mlx_dma_map_sg(void *arg, bus_dma_segment_t *segs, int nseg, int error)
219 struct mlx_softc *sc = (struct mlx_softc *)arg;
223 /* save base of s/g table's address in bus space */
224 sc->mlx_sgbusaddr = segs->ds_addr;
228 mlx_sglist_map(struct mlx_softc *sc)
235 /* destroy any existing mappings */
237 bus_dmamem_free(sc->mlx_sg_dmat, sc->mlx_sgtable, sc->mlx_sg_dmamap);
239 bus_dma_tag_destroy(sc->mlx_sg_dmat);
242 * Create a single tag describing a region large enough to hold all of
243 * the s/g lists we will need. If we're called early on, we don't know how
244 * many commands we're going to be asked to support, so only allocate enough
247 if (sc->mlx_enq2 == NULL) {
250 ncmd = sc->mlx_enq2->me_max_commands;
252 segsize = sizeof(struct mlx_sgentry) * MLX_NSEG * ncmd;
253 error = bus_dma_tag_create(sc->mlx_parent_dmat, /* parent */
254 1, 0, /* alignment, boundary */
255 BUS_SPACE_MAXADDR, /* lowaddr */
256 BUS_SPACE_MAXADDR, /* highaddr */
257 NULL, NULL, /* filter, filterarg */
258 segsize, 1, /* maxsize, nsegments */
259 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
263 device_printf(sc->mlx_dev, "can't allocate scatter/gather DMA tag\n");
268 * Allocate enough s/g maps for all commands and permanently map them into
269 * controller-visible space.
271 * XXX this assumes we can get enough space for all the s/g maps in one
272 * contiguous slab. We may need to switch to a more complex arrangement where
273 * we allocate in smaller chunks and keep a lookup table from slot to bus address.
275 error = bus_dmamem_alloc(sc->mlx_sg_dmat, (void **)&sc->mlx_sgtable, BUS_DMA_NOWAIT, &sc->mlx_sg_dmamap);
277 device_printf(sc->mlx_dev, "can't allocate s/g table\n");
280 bus_dmamap_load(sc->mlx_sg_dmat, sc->mlx_sg_dmamap, sc->mlx_sgtable, segsize, mlx_dma_map_sg, sc, 0);
284 /********************************************************************************
285 * Initialise the controller and softc
288 mlx_attach(struct mlx_softc *sc)
290 struct mlx_enquiry_old *meo;
291 int rid, error, fwminor, hscode, hserror, hsparam1, hsparam2, hsmsg;
296 * Initialise per-controller queues.
298 TAILQ_INIT(&sc->mlx_work);
299 TAILQ_INIT(&sc->mlx_freecmds);
300 MLX_BIO_QINIT(sc->mlx_bioq);
303 * Select accessor methods based on controller interface type.
305 switch(sc->mlx_iftype) {
308 sc->mlx_tryqueue = mlx_v3_tryqueue;
309 sc->mlx_findcomplete = mlx_v3_findcomplete;
310 sc->mlx_intaction = mlx_v3_intaction;
311 sc->mlx_fw_handshake = mlx_v3_fw_handshake;
314 sc->mlx_tryqueue = mlx_v4_tryqueue;
315 sc->mlx_findcomplete = mlx_v4_findcomplete;
316 sc->mlx_intaction = mlx_v4_intaction;
317 sc->mlx_fw_handshake = mlx_v4_fw_handshake;
320 sc->mlx_tryqueue = mlx_v5_tryqueue;
321 sc->mlx_findcomplete = mlx_v5_findcomplete;
322 sc->mlx_intaction = mlx_v5_intaction;
323 sc->mlx_fw_handshake = mlx_v5_fw_handshake;
327 return(ENXIO); /* should never happen */
330 /* disable interrupts before we start talking to the controller */
331 sc->mlx_intaction(sc, MLX_INTACTION_DISABLE);
334 * Wait for the controller to come ready, handshake with the firmware if required.
335 * This is typically only necessary on platforms where the controller BIOS does not
340 while ((hscode = sc->mlx_fw_handshake(sc, &hserror, &hsparam1, &hsparam2)) != 0) {
341 /* report first time around... */
343 device_printf(sc->mlx_dev, "controller initialisation in progress...\n");
346 /* did we get a real message? */
348 hscode = mlx_fw_message(sc, hserror, hsparam1, hsparam2);
349 /* fatal initialisation error? */
357 device_printf(sc->mlx_dev, "initialisation complete.\n");
360 * Allocate and connect our interrupt.
363 sc->mlx_irq = bus_alloc_resource(sc->mlx_dev, SYS_RES_IRQ, &rid, 0, ~0, 1, RF_SHAREABLE | RF_ACTIVE);
364 if (sc->mlx_irq == NULL) {
365 device_printf(sc->mlx_dev, "can't allocate interrupt\n");
369 error = bus_setup_intr(sc->mlx_dev, sc->mlx_irq, INTR_TYPE_BIO | INTR_ENTROPY, mlx_intr, sc, &sc->mlx_intr);
371 device_printf(sc->mlx_dev, "can't set up interrupt\n");
377 * Create DMA tag for mapping buffers into controller-addressable space.
379 error = bus_dma_tag_create(sc->mlx_parent_dmat, /* parent */
380 1, 0, /* alignment, boundary */
381 BUS_SPACE_MAXADDR, /* lowaddr */
382 BUS_SPACE_MAXADDR, /* highaddr */
383 NULL, NULL, /* filter, filterarg */
384 MAXBSIZE, MLX_NSEG, /* maxsize, nsegments */
385 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
387 &sc->mlx_buffer_dmat);
389 device_printf(sc->mlx_dev, "can't allocate buffer DMA tag\n");
395 * Create some initial scatter/gather mappings so we can run the probe commands.
397 error = mlx_sglist_map(sc);
399 device_printf(sc->mlx_dev, "can't make initial s/g list mapping\n");
405 * We don't (yet) know where the event log is up to.
407 sc->mlx_currevent = -1;
410 * Obtain controller feature information
412 if ((sc->mlx_enq2 = mlx_enquire(sc, MLX_CMD_ENQUIRY2, sizeof(struct mlx_enquiry2), NULL)) == NULL) {
413 device_printf(sc->mlx_dev, "ENQUIRY2 failed\n");
419 * Do quirk/feature related things.
421 fwminor = (sc->mlx_enq2->me_firmware_id >> 8) & 0xff;
422 switch(sc->mlx_iftype) {
424 /* These controllers don't report the firmware version in the ENQUIRY2 response */
425 if ((meo = mlx_enquire(sc, MLX_CMD_ENQUIRY_OLD, sizeof(struct mlx_enquiry_old), NULL)) == NULL) {
426 device_printf(sc->mlx_dev, "ENQUIRY_OLD failed\n");
430 sc->mlx_enq2->me_firmware_id = ('0' << 24) | (0 << 16) | (meo->me_fwminor << 8) | meo->me_fwmajor;
433 /* XXX require 2.42 or better (PCI) or 2.14 or better (EISA) */
434 if (meo->me_fwminor < 42) {
435 device_printf(sc->mlx_dev, " *** WARNING *** This firmware revision is not recommended\n");
436 device_printf(sc->mlx_dev, " *** WARNING *** Use revision 2.42 or later\n");
440 /* XXX certify 3.52? */
442 device_printf(sc->mlx_dev, " *** WARNING *** This firmware revision is not recommended\n");
443 device_printf(sc->mlx_dev, " *** WARNING *** Use revision 3.51 or later\n");
447 /* XXX certify firmware versions? */
449 device_printf(sc->mlx_dev, " *** WARNING *** This firmware revision is not recommended\n");
450 device_printf(sc->mlx_dev, " *** WARNING *** Use revision 4.06 or later\n");
455 device_printf(sc->mlx_dev, " *** WARNING *** This firmware revision is not recommended\n");
456 device_printf(sc->mlx_dev, " *** WARNING *** Use revision 5.07 or later\n");
461 return(ENXIO); /* should never happen */
465 * Create the final scatter/gather mappings now that we have characterised the controller.
467 error = mlx_sglist_map(sc);
469 device_printf(sc->mlx_dev, "can't make final s/g list mapping\n");
475 * No user-requested background operation is in progress.
477 sc->mlx_background = 0;
478 sc->mlx_rebuildstat.rs_code = MLX_REBUILDSTAT_IDLE;
481 * Create the control device.
483 sc->mlx_dev_t = make_dev(&mlx_cdevsw, device_get_unit(sc->mlx_dev), UID_ROOT, GID_OPERATOR,
484 S_IRUSR | S_IWUSR, "mlx%d", device_get_unit(sc->mlx_dev));
487 * Start the timeout routine.
489 sc->mlx_timeout = timeout(mlx_periodic, sc, hz);
491 /* print a little information about the controller */
492 mlx_describe_controller(sc);
497 /********************************************************************************
498 * Locate disk resources and attach children to them.
501 mlx_startup(struct mlx_softc *sc)
503 struct mlx_enq_sys_drive *mes;
504 struct mlx_sysdrive *dr;
510 * Scan all the system drives and attach children for those that
511 * don't currently have them.
513 mes = mlx_enquire(sc, MLX_CMD_ENQSYSDRIVE, sizeof(*mes) * MLX_MAXDRIVES, NULL);
515 device_printf(sc->mlx_dev, "error fetching drive status\n");
519 /* iterate over drives returned */
520 for (i = 0, dr = &sc->mlx_sysdrive[0];
521 (i < MLX_MAXDRIVES) && (mes[i].sd_size != 0xffffffff);
523 /* are we already attached to this drive? */
524 if (dr->ms_disk == 0) {
525 /* pick up drive information */
526 dr->ms_size = mes[i].sd_size;
527 dr->ms_raidlevel = mes[i].sd_raidlevel & 0xf;
528 dr->ms_state = mes[i].sd_state;
530 /* generate geometry information */
531 if (sc->mlx_geom == MLX_GEOM_128_32) {
534 dr->ms_cylinders = dr->ms_size / (128 * 32);
535 } else { /* MLX_GEOM_255/63 */
538 dr->ms_cylinders = dr->ms_size / (255 * 63);
540 dr->ms_disk = device_add_child(sc->mlx_dev, /*"mlxd"*/NULL, -1);
541 if (dr->ms_disk == 0)
542 device_printf(sc->mlx_dev, "device_add_child failed\n");
543 device_set_ivars(dr->ms_disk, dr);
547 if ((error = bus_generic_attach(sc->mlx_dev)) != 0)
548 device_printf(sc->mlx_dev, "bus_generic_attach returned %d", error);
550 /* mark controller back up */
551 sc->mlx_state &= ~MLX_STATE_SHUTDOWN;
553 /* enable interrupts */
554 sc->mlx_intaction(sc, MLX_INTACTION_ENABLE);
557 /********************************************************************************
558 * Disconnect from the controller completely, in preparation for unload.
561 mlx_detach(device_t dev)
563 struct mlx_softc *sc = device_get_softc(dev);
564 struct mlxd_softc *mlxd;
571 if (sc->mlx_state & MLX_STATE_OPEN)
574 for (i = 0; i < MLX_MAXDRIVES; i++) {
575 if (sc->mlx_sysdrive[i].ms_disk != 0) {
576 mlxd = device_get_softc(sc->mlx_sysdrive[i].ms_disk);
577 if (mlxd->mlxd_flags & MLXD_OPEN) { /* drive is mounted, abort detach */
578 device_printf(sc->mlx_sysdrive[i].ms_disk, "still open, can't detach\n");
583 if ((error = mlx_shutdown(dev)))
594 /********************************************************************************
595 * Bring the controller down to a dormant state and detach all child devices.
597 * This function is called before detach, system shutdown, or before performing
598 * an operation which may add or delete system disks. (Call mlx_startup to
599 * resume normal operation.)
601 * Note that we can assume that the bioq on the controller is empty, as we won't
602 * allow shutdown if any device is open.
605 mlx_shutdown(device_t dev)
607 struct mlx_softc *sc = device_get_softc(dev);
615 sc->mlx_state |= MLX_STATE_SHUTDOWN;
616 sc->mlx_intaction(sc, MLX_INTACTION_DISABLE);
618 /* flush controller */
619 device_printf(sc->mlx_dev, "flushing cache...");
626 /* delete all our child devices */
627 for (i = 0; i < MLX_MAXDRIVES; i++) {
628 if (sc->mlx_sysdrive[i].ms_disk != 0) {
629 if ((error = device_delete_child(sc->mlx_dev, sc->mlx_sysdrive[i].ms_disk)) != 0)
631 sc->mlx_sysdrive[i].ms_disk = 0;
640 /********************************************************************************
641 * Bring the controller to a quiescent state, ready for system suspend.
644 mlx_suspend(device_t dev)
646 struct mlx_softc *sc = device_get_softc(dev);
652 sc->mlx_state |= MLX_STATE_SUSPEND;
654 /* flush controller */
655 device_printf(sc->mlx_dev, "flushing cache...");
656 printf("%s\n", mlx_flush(sc) ? "failed" : "done");
658 sc->mlx_intaction(sc, MLX_INTACTION_DISABLE);
664 /********************************************************************************
665 * Bring the controller back to a state ready for operation.
668 mlx_resume(device_t dev)
670 struct mlx_softc *sc = device_get_softc(dev);
674 sc->mlx_state &= ~MLX_STATE_SUSPEND;
675 sc->mlx_intaction(sc, MLX_INTACTION_ENABLE);
680 /*******************************************************************************
681 * Take an interrupt, or be poked by other code to look for interrupt-worthy
687 struct mlx_softc *sc = (struct mlx_softc *)arg;
691 /* collect finished commands, queue anything waiting */
695 /*******************************************************************************
696 * Receive a buf structure from a child device and queue it on a particular
697 * disk resource, then poke the disk resource to start as much work as it can.
700 mlx_submit_buf(struct mlx_softc *sc, mlx_bio *bp)
707 MLX_BIO_QINSERT(sc->mlx_bioq, bp);
714 /********************************************************************************
715 * Accept an open operation on the control device.
718 mlx_open(dev_t dev, int flags, int fmt, d_thread_t *td)
720 int unit = minor(dev);
721 struct mlx_softc *sc = devclass_get_softc(mlx_devclass, unit);
723 sc->mlx_state |= MLX_STATE_OPEN;
727 /********************************************************************************
728 * Accept the last close on the control device.
731 mlx_close(dev_t dev, int flags, int fmt, d_thread_t *td)
733 int unit = minor(dev);
734 struct mlx_softc *sc = devclass_get_softc(mlx_devclass, unit);
736 sc->mlx_state &= ~MLX_STATE_OPEN;
740 /********************************************************************************
741 * Handle controller-specific control operations.
744 mlx_ioctl(dev_t dev, u_long cmd, caddr_t addr, int32_t flag, d_thread_t *td)
746 int unit = minor(dev);
747 struct mlx_softc *sc = devclass_get_softc(mlx_devclass, unit);
748 struct mlx_rebuild_request *rb = (struct mlx_rebuild_request *)addr;
749 struct mlx_rebuild_status *rs = (struct mlx_rebuild_status *)addr;
750 int *arg = (int *)addr;
751 struct mlx_pause *mp;
752 struct mlx_sysdrive *dr;
753 struct mlxd_softc *mlxd;
758 * Enumerate connected system drives; returns the first system drive's
759 * unit number if *arg is -1, or the next unit after *arg if it's
760 * a valid unit on this controller.
763 /* search system drives */
764 for (i = 0; i < MLX_MAXDRIVES; i++) {
765 /* is this one attached? */
766 if (sc->mlx_sysdrive[i].ms_disk != 0) {
767 /* looking for the next one we come across? */
769 *arg = device_get_unit(sc->mlx_sysdrive[0].ms_disk);
772 /* we want the one after this one */
773 if (*arg == device_get_unit(sc->mlx_sysdrive[i].ms_disk))
780 * Scan the controller to see whether new drives have appeared.
782 case MLX_RESCAN_DRIVES:
787 * Disconnect from the specified drive; it may be about to go
790 case MLX_DETACH_DRIVE: /* detach one drive */
792 if (((dr = mlx_findunit(sc, *arg)) == NULL) ||
793 ((mlxd = device_get_softc(dr->ms_disk)) == NULL))
796 device_printf(dr->ms_disk, "detaching...");
798 if (mlxd->mlxd_flags & MLXD_OPEN) {
803 /* flush controller */
810 if ((error = device_delete_child(sc->mlx_dev, dr->ms_disk)) != 0)
823 * Pause one or more SCSI channels for a period of time, to assist
824 * in the process of hot-swapping devices.
826 * Note that at least the 3.51 firmware on the DAC960PL doesn't seem
829 case MLX_PAUSE_CHANNEL: /* schedule a channel pause */
830 /* Does this command work on this firmware? */
831 if (!(sc->mlx_feature & MLX_FEAT_PAUSEWORKS))
834 mp = (struct mlx_pause *)addr;
835 if ((mp->mp_which == MLX_PAUSE_CANCEL) && (sc->mlx_pause.mp_when != 0)) {
836 /* cancel a pending pause operation */
837 sc->mlx_pause.mp_which = 0;
839 /* fix for legal channels */
840 mp->mp_which &= ((1 << sc->mlx_enq2->me_actual_channels) -1);
841 /* check time values */
842 if ((mp->mp_when < 0) || (mp->mp_when > 3600))
844 if ((mp->mp_howlong < 1) || (mp->mp_howlong > (0xf * 30)))
847 /* check for a pause currently running */
848 if ((sc->mlx_pause.mp_which != 0) && (sc->mlx_pause.mp_when == 0))
851 /* looks ok, go with it */
852 sc->mlx_pause.mp_which = mp->mp_which;
853 sc->mlx_pause.mp_when = time_second + mp->mp_when;
854 sc->mlx_pause.mp_howlong = sc->mlx_pause.mp_when + mp->mp_howlong;
859 * Accept a command passthrough-style.
862 return(mlx_user_command(sc, (struct mlx_usercommand *)addr));
865 * Start a rebuild on a given SCSI disk
867 case MLX_REBUILDASYNC:
868 if (sc->mlx_background != 0) {
869 rb->rr_status = 0x0106;
872 rb->rr_status = mlx_rebuild(sc, rb->rr_channel, rb->rr_target);
873 switch (rb->rr_status) {
878 error = ENOMEM; /* couldn't set up the command */
897 sc->mlx_background = MLX_BACKGROUND_REBUILD;
901 * Get the status of the current rebuild or consistency check.
903 case MLX_REBUILDSTAT:
904 *rs = sc->mlx_rebuildstat;
908 * Return the per-controller system drive number matching the
909 * disk device number in (arg), if it happens to belong to us.
911 case MLX_GET_SYSDRIVE:
913 mlxd = (struct mlxd_softc *)devclass_get_softc(mlxd_devclass, *arg);
914 if ((mlxd != NULL) && (mlxd->mlxd_drive >= sc->mlx_sysdrive) &&
915 (mlxd->mlxd_drive < (sc->mlx_sysdrive + MLX_MAXDRIVES))) {
917 *arg = mlxd->mlxd_drive - sc->mlx_sysdrive;
926 /********************************************************************************
927 * Handle operations requested by a System Drive connected to this controller.
930 mlx_submit_ioctl(struct mlx_softc *sc, struct mlx_sysdrive *drive, u_long cmd,
931 caddr_t addr, int32_t flag, d_thread_t *td)
933 int *arg = (int *)addr;
938 * Return the current status of this drive.
941 *arg = drive->ms_state;
945 * Start a background consistency check on this drive.
947 case MLXD_CHECKASYNC: /* start a background consistency check */
948 if (sc->mlx_background != 0) {
952 result = mlx_check(sc, drive - &sc->mlx_sysdrive[0]);
958 error = ENOMEM; /* couldn't set up the command */
974 sc->mlx_background = MLX_BACKGROUND_CHECK;
983 /********************************************************************************
984 ********************************************************************************
986 ********************************************************************************
987 ********************************************************************************/
989 /********************************************************************************
990 * Fire off commands to periodically check the status of connected drives.
993 mlx_periodic(void *data)
995 struct mlx_softc *sc = (struct mlx_softc *)data;
1002 if ((sc->mlx_pause.mp_which != 0) &&
1003 (sc->mlx_pause.mp_when > 0) &&
1004 (time_second >= sc->mlx_pause.mp_when)){
1006 mlx_pause_action(sc); /* pause is running */
1007 sc->mlx_pause.mp_when = 0;
1011 * Bus pause still running?
1013 } else if ((sc->mlx_pause.mp_which != 0) &&
1014 (sc->mlx_pause.mp_when == 0)) {
1016 /* time to stop bus pause? */
1017 if (time_second >= sc->mlx_pause.mp_howlong) {
1018 mlx_pause_action(sc);
1019 sc->mlx_pause.mp_which = 0; /* pause is complete */
1022 sysbeep((time_second % 5) * 100 + 500, hz/8);
1026 * Run normal periodic activities?
1028 } else if (time_second > (sc->mlx_lastpoll + 10)) {
1029 sc->mlx_lastpoll = time_second;
1032 * Check controller status.
1034 * XXX Note that this may not actually launch a command in situations of high load.
1036 mlx_enquire(sc, (sc->mlx_iftype == MLX_IFTYPE_2) ? MLX_CMD_ENQUIRY_OLD : MLX_CMD_ENQUIRY,
1037 imax(sizeof(struct mlx_enquiry), sizeof(struct mlx_enquiry_old)), mlx_periodic_enquiry);
1040 * Check system drive status.
1042 * XXX This might be better left to event-driven detection, eg. I/O to an offline
1043 * drive will detect it's offline, rebuilds etc. should detect the drive is back
1046 mlx_enquire(sc, MLX_CMD_ENQSYSDRIVE, sizeof(struct mlx_enq_sys_drive) * MLX_MAXDRIVES,
1047 mlx_periodic_enquiry);
1051 /* get drive rebuild/check status */
1052 /* XXX should check sc->mlx_background if this is only valid while in progress */
1053 mlx_enquire(sc, MLX_CMD_REBUILDSTAT, sizeof(struct mlx_rebuild_stat), mlx_periodic_rebuild);
1055 /* deal with possibly-missed interrupts and timed-out commands */
1058 /* reschedule another poll next second or so */
1059 sc->mlx_timeout = timeout(mlx_periodic, sc, hz);
1062 /********************************************************************************
1063 * Handle the result of an ENQUIRY command instigated by periodic status polling.
1066 mlx_periodic_enquiry(struct mlx_command *mc)
1068 struct mlx_softc *sc = mc->mc_sc;
1072 /* Command completed OK? */
1073 if (mc->mc_status != 0) {
1074 device_printf(sc->mlx_dev, "periodic enquiry failed - %s\n", mlx_diagnose_command(mc));
1078 /* respond to command */
1079 switch(mc->mc_mailbox[0]) {
1081 * This is currently a bit fruitless, as we don't know how to extract the eventlog
1084 case MLX_CMD_ENQUIRY_OLD:
1086 struct mlx_enquiry *me = (struct mlx_enquiry *)mc->mc_data;
1087 struct mlx_enquiry_old *meo = (struct mlx_enquiry_old *)mc->mc_data;
1090 /* convert data in-place to new format */
1091 for (i = (sizeof(me->me_dead) / sizeof(me->me_dead[0])) - 1; i >= 0; i--) {
1092 me->me_dead[i].dd_chan = meo->me_dead[i].dd_chan;
1093 me->me_dead[i].dd_targ = meo->me_dead[i].dd_targ;
1095 me->me_misc_flags = 0;
1096 me->me_rebuild_count = meo->me_rebuild_count;
1097 me->me_dead_count = meo->me_dead_count;
1098 me->me_critical_sd_count = meo->me_critical_sd_count;
1099 me->me_event_log_seq_num = 0;
1100 me->me_offline_sd_count = meo->me_offline_sd_count;
1101 me->me_max_commands = meo->me_max_commands;
1102 me->me_rebuild_flag = meo->me_rebuild_flag;
1103 me->me_fwmajor = meo->me_fwmajor;
1104 me->me_fwminor = meo->me_fwminor;
1105 me->me_status_flags = meo->me_status_flags;
1106 me->me_flash_age = meo->me_flash_age;
1107 for (i = (sizeof(me->me_drvsize) / sizeof(me->me_drvsize[0])) - 1; i >= 0; i--) {
1108 if (i > ((sizeof(meo->me_drvsize) / sizeof(meo->me_drvsize[0])) - 1)) {
1109 me->me_drvsize[i] = 0; /* drive beyond supported range */
1111 me->me_drvsize[i] = meo->me_drvsize[i];
1114 me->me_num_sys_drvs = meo->me_num_sys_drvs;
1119 * Generic controller status update. We could do more with this than just
1120 * checking the event log.
1122 case MLX_CMD_ENQUIRY:
1124 struct mlx_enquiry *me = (struct mlx_enquiry *)mc->mc_data;
1126 if (sc->mlx_currevent == -1) {
1127 /* initialise our view of the event log */
1128 sc->mlx_currevent = sc->mlx_lastevent = me->me_event_log_seq_num;
1129 } else if ((me->me_event_log_seq_num != sc->mlx_lastevent) && !(sc->mlx_flags & MLX_EVENTLOG_BUSY)) {
1130 /* record where current events are up to */
1131 sc->mlx_currevent = me->me_event_log_seq_num;
1132 debug(1, "event log pointer was %d, now %d\n", sc->mlx_lastevent, sc->mlx_currevent);
1134 /* mark the event log as busy */
1135 atomic_set_int(&sc->mlx_flags, MLX_EVENTLOG_BUSY);
1137 /* drain new eventlog entries */
1138 mlx_periodic_eventlog_poll(sc);
1142 case MLX_CMD_ENQSYSDRIVE:
1144 struct mlx_enq_sys_drive *mes = (struct mlx_enq_sys_drive *)mc->mc_data;
1145 struct mlx_sysdrive *dr;
1148 for (i = 0, dr = &sc->mlx_sysdrive[0];
1149 (i < MLX_MAXDRIVES) && (mes[i].sd_size != 0xffffffff);
1152 /* has state been changed by controller? */
1153 if (dr->ms_state != mes[i].sd_state) {
1154 switch(mes[i].sd_state) {
1155 case MLX_SYSD_OFFLINE:
1156 device_printf(dr->ms_disk, "drive offline\n");
1158 case MLX_SYSD_ONLINE:
1159 device_printf(dr->ms_disk, "drive online\n");
1161 case MLX_SYSD_CRITICAL:
1162 device_printf(dr->ms_disk, "drive critical\n");
1165 /* save new state */
1166 dr->ms_state = mes[i].sd_state;
1172 device_printf(sc->mlx_dev, "%s: unknown command 0x%x", __FUNCTION__, mc->mc_mailbox[0]);
1177 free(mc->mc_data, M_DEVBUF);
1181 /********************************************************************************
1182 * Instigate a poll for one event log message on (sc).
1183 * We only poll for one message at a time, to keep our command usage down.
1186 mlx_periodic_eventlog_poll(struct mlx_softc *sc)
1188 struct mlx_command *mc;
1189 void *result = NULL;
1194 /* get ourselves a command buffer */
1196 if ((mc = mlx_alloccmd(sc)) == NULL)
1198 /* allocate the response structure */
1199 if ((result = malloc(/*sizeof(struct mlx_eventlog_entry)*/1024, M_DEVBUF, M_NOWAIT)) == NULL)
1201 /* get a command slot */
1202 if (mlx_getslot(mc))
1205 /* map the command so the controller can see it */
1206 mc->mc_data = result;
1207 mc->mc_length = /*sizeof(struct mlx_eventlog_entry)*/1024;
1210 /* build the command to get one entry */
1211 mlx_make_type3(mc, MLX_CMD_LOGOP, MLX_LOGOP_GET, 1, sc->mlx_lastevent, 0, 0, mc->mc_dataphys, 0);
1212 mc->mc_complete = mlx_periodic_eventlog_respond;
1213 mc->mc_private = mc;
1215 /* start the command */
1216 if ((error = mlx_start(mc)) != 0)
1219 error = 0; /* success */
1225 free(result, M_DEVBUF);
1229 /********************************************************************************
1230 * Handle the result of polling for a log message, generate diagnostic output.
1231 * If this wasn't the last message waiting for us, we'll go collect another.
1233 static char *mlx_sense_messages[] = {
1234 "because write recovery failed",
1235 "because of SCSI bus reset failure",
1236 "because of double check condition",
1237 "because it was removed",
1238 "because of gross error on SCSI chip",
1239 "because of bad tag returned from drive",
1240 "because of timeout on SCSI command",
1241 "because of reset SCSI command issued from system",
1242 "because busy or parity error count exceeded limit",
1243 "because of 'kill drive' command from system",
1244 "because of selection timeout",
1245 "due to SCSI phase sequence error",
1246 "due to unknown status"
1250 mlx_periodic_eventlog_respond(struct mlx_command *mc)
1252 struct mlx_softc *sc = mc->mc_sc;
1253 struct mlx_eventlog_entry *el = (struct mlx_eventlog_entry *)mc->mc_data;
1258 sc->mlx_lastevent++; /* next message... */
1259 if (mc->mc_status == 0) {
1261 /* handle event log message */
1262 switch(el->el_type) {
1264 * This is the only sort of message we understand at the moment.
1265 * The tests here are probably incomplete.
1267 case MLX_LOGMSG_SENSE: /* sense data */
1268 /* Mylex vendor-specific message indicating a drive was killed? */
1269 if ((el->el_sensekey == 9) &&
1270 (el->el_asc == 0x80)) {
1271 if (el->el_asq < (sizeof(mlx_sense_messages) / sizeof(mlx_sense_messages[0]))) {
1272 reason = mlx_sense_messages[el->el_asq];
1274 reason = "for unknown reason";
1276 device_printf(sc->mlx_dev, "physical drive %d:%d killed %s\n",
1277 el->el_channel, el->el_target, reason);
1279 /* SCSI drive was reset? */
1280 if ((el->el_sensekey == 6) && (el->el_asc == 0x29)) {
1281 device_printf(sc->mlx_dev, "physical drive %d:%d reset\n",
1282 el->el_channel, el->el_target);
1284 /* SCSI drive error? */
1285 if (!((el->el_sensekey == 0) ||
1286 ((el->el_sensekey == 2) &&
1287 (el->el_asc == 0x04) &&
1288 ((el->el_asq == 0x01) ||
1289 (el->el_asq == 0x02))))) {
1290 device_printf(sc->mlx_dev, "physical drive %d:%d error log: sense = %d asc = %x asq = %x\n",
1291 el->el_channel, el->el_target, el->el_sensekey, el->el_asc, el->el_asq);
1292 device_printf(sc->mlx_dev, " info %4D csi %4D\n", el->el_information, ":", el->el_csi, ":");
1297 device_printf(sc->mlx_dev, "unknown log message type 0x%x\n", el->el_type);
1301 device_printf(sc->mlx_dev, "error reading message log - %s\n", mlx_diagnose_command(mc));
1302 /* give up on all the outstanding messages, as we may have come unsynched */
1303 sc->mlx_lastevent = sc->mlx_currevent;
1306 /* dispose of command and data */
1307 free(mc->mc_data, M_DEVBUF);
1310 /* is there another message to obtain? */
1311 if (sc->mlx_lastevent != sc->mlx_currevent) {
1312 mlx_periodic_eventlog_poll(sc);
1314 /* clear log-busy status */
1315 atomic_clear_int(&sc->mlx_flags, MLX_EVENTLOG_BUSY);
1319 /********************************************************************************
1320 * Handle check/rebuild operations in progress.
1323 mlx_periodic_rebuild(struct mlx_command *mc)
1325 struct mlx_softc *sc = mc->mc_sc;
1326 struct mlx_rebuild_status *mr = (struct mlx_rebuild_status *)mc->mc_data;
1328 switch(mc->mc_status) {
1329 case 0: /* operation running, update stats */
1330 sc->mlx_rebuildstat = *mr;
1332 /* spontaneous rebuild/check? */
1333 if (sc->mlx_background == 0) {
1334 sc->mlx_background = MLX_BACKGROUND_SPONTANEOUS;
1335 device_printf(sc->mlx_dev, "background check/rebuild operation started\n");
1339 case 0x0105: /* nothing running, finalise stats and report */
1340 switch(sc->mlx_background) {
1341 case MLX_BACKGROUND_CHECK:
1342 device_printf(sc->mlx_dev, "consistency check completed\n"); /* XXX print drive? */
1344 case MLX_BACKGROUND_REBUILD:
1345 device_printf(sc->mlx_dev, "drive rebuild completed\n"); /* XXX print channel/target? */
1347 case MLX_BACKGROUND_SPONTANEOUS:
1349 /* if we have previously been non-idle, report the transition */
1350 if (sc->mlx_rebuildstat.rs_code != MLX_REBUILDSTAT_IDLE) {
1351 device_printf(sc->mlx_dev, "background check/rebuild operation completed\n");
1354 sc->mlx_background = 0;
1355 sc->mlx_rebuildstat.rs_code = MLX_REBUILDSTAT_IDLE;
1358 free(mc->mc_data, M_DEVBUF);
1362 /********************************************************************************
1363 ********************************************************************************
1365 ********************************************************************************
1366 ********************************************************************************/
1368 /********************************************************************************
1369 * It's time to perform a channel pause action for (sc), either start or stop
1373 mlx_pause_action(struct mlx_softc *sc)
1375 struct mlx_command *mc;
1376 int failsafe, i, command;
1378 /* What are we doing here? */
1379 if (sc->mlx_pause.mp_when == 0) {
1380 command = MLX_CMD_STARTCHANNEL;
1384 command = MLX_CMD_STOPCHANNEL;
1387 * Channels will always start again after the failsafe period,
1388 * which is specified in multiples of 30 seconds.
1389 * This constrains us to a maximum pause of 450 seconds.
1391 failsafe = ((sc->mlx_pause.mp_howlong - time_second) + 5) / 30;
1392 if (failsafe > 0xf) {
1394 sc->mlx_pause.mp_howlong = time_second + (0xf * 30) - 5;
1398 /* build commands for every channel requested */
1399 for (i = 0; i < sc->mlx_enq2->me_actual_channels; i++) {
1400 if ((1 << i) & sc->mlx_pause.mp_which) {
1402 /* get ourselves a command buffer */
1403 if ((mc = mlx_alloccmd(sc)) == NULL)
1405 /* get a command slot */
1406 mc->mc_flags |= MLX_CMD_PRIORITY;
1407 if (mlx_getslot(mc))
1410 /* build the command */
1411 mlx_make_type2(mc, command, (failsafe << 4) | i, 0, 0, 0, 0, 0, 0, 0);
1412 mc->mc_complete = mlx_pause_done;
1413 mc->mc_private = sc; /* XXX not needed */
1416 /* command submitted OK */
1420 device_printf(sc->mlx_dev, "%s failed for channel %d\n",
1421 command == MLX_CMD_STOPCHANNEL ? "pause" : "resume", i);
1429 mlx_pause_done(struct mlx_command *mc)
1431 struct mlx_softc *sc = mc->mc_sc;
1432 int command = mc->mc_mailbox[0];
1433 int channel = mc->mc_mailbox[2] & 0xf;
1435 if (mc->mc_status != 0) {
1436 device_printf(sc->mlx_dev, "%s command failed - %s\n",
1437 command == MLX_CMD_STOPCHANNEL ? "pause" : "resume", mlx_diagnose_command(mc));
1438 } else if (command == MLX_CMD_STOPCHANNEL) {
1439 device_printf(sc->mlx_dev, "channel %d pausing for %ld seconds\n",
1440 channel, (long)(sc->mlx_pause.mp_howlong - time_second));
1442 device_printf(sc->mlx_dev, "channel %d resuming\n", channel);
1447 /********************************************************************************
1448 ********************************************************************************
1450 ********************************************************************************
1451 ********************************************************************************/
1453 /********************************************************************************
1454 * Perform an Enquiry command using a type-3 command buffer and a return a single
1455 * linear result buffer. If the completion function is specified, it will
1456 * be called with the completed command (and the result response will not be
1457 * valid until that point). Otherwise, the command will either be busy-waited
1458 * for (interrupts not enabled), or slept for.
1461 mlx_enquire(struct mlx_softc *sc, int command, size_t bufsize, void (* complete)(struct mlx_command *mc))
1463 struct mlx_command *mc;
1469 /* get ourselves a command buffer */
1472 if ((mc = mlx_alloccmd(sc)) == NULL)
1474 /* allocate the response structure */
1475 if ((result = malloc(bufsize, M_DEVBUF, M_NOWAIT)) == NULL)
1477 /* get a command slot */
1478 mc->mc_flags |= MLX_CMD_PRIORITY | MLX_CMD_DATAOUT;
1479 if (mlx_getslot(mc))
1482 /* map the command so the controller can see it */
1483 mc->mc_data = result;
1484 mc->mc_length = bufsize;
1487 /* build an enquiry command */
1488 mlx_make_type2(mc, command, 0, 0, 0, 0, 0, 0, mc->mc_dataphys, 0);
1490 /* do we want a completion callback? */
1491 if (complete != NULL) {
1492 mc->mc_complete = complete;
1493 mc->mc_private = mc;
1494 if ((error = mlx_start(mc)) != 0)
1497 /* run the command in either polled or wait mode */
1498 if ((sc->mlx_state & MLX_STATE_INTEN) ? mlx_wait_command(mc) : mlx_poll_command(mc))
1501 /* command completed OK? */
1502 if (mc->mc_status != 0) {
1503 device_printf(sc->mlx_dev, "ENQUIRY failed - %s\n", mlx_diagnose_command(mc));
1507 error = 0; /* success */
1509 /* we got a command, but nobody else will free it */
1510 if ((complete == NULL) && (mc != NULL))
1512 /* we got an error, and we allocated a result */
1513 if ((error != 0) && (result != NULL)) {
1514 free(result, M_DEVBUF);
1521 /********************************************************************************
1522 * Perform a Flush command on the nominated controller.
1524 * May be called with interrupts enabled or disabled; will not return until
1525 * the flush operation completes or fails.
1528 mlx_flush(struct mlx_softc *sc)
1530 struct mlx_command *mc;
1535 /* get ourselves a command buffer */
1537 if ((mc = mlx_alloccmd(sc)) == NULL)
1539 /* get a command slot */
1540 if (mlx_getslot(mc))
1543 /* build a flush command */
1544 mlx_make_type2(mc, MLX_CMD_FLUSH, 0, 0, 0, 0, 0, 0, 0, 0);
1546 /* can't assume that interrupts are going to work here, so play it safe */
1547 if (mlx_poll_command(mc))
1550 /* command completed OK? */
1551 if (mc->mc_status != 0) {
1552 device_printf(sc->mlx_dev, "FLUSH failed - %s\n", mlx_diagnose_command(mc));
1556 error = 0; /* success */
1563 /********************************************************************************
1564 * Start a background consistency check on (drive).
1566 * May be called with interrupts enabled or disabled; will return as soon as the
1567 * operation has started or been refused.
1570 mlx_check(struct mlx_softc *sc, int drive)
1572 struct mlx_command *mc;
1577 /* get ourselves a command buffer */
1579 if ((mc = mlx_alloccmd(sc)) == NULL)
1581 /* get a command slot */
1582 if (mlx_getslot(mc))
1585 /* build a checkasync command, set the "fix it" flag */
1586 mlx_make_type2(mc, MLX_CMD_CHECKASYNC, 0, 0, 0, 0, 0, drive | 0x80, 0, 0);
1588 /* start the command and wait for it to be returned */
1589 if (mlx_wait_command(mc))
1592 /* command completed OK? */
1593 if (mc->mc_status != 0) {
1594 device_printf(sc->mlx_dev, "CHECK ASYNC failed - %s\n", mlx_diagnose_command(mc));
1596 device_printf(sc->mlx_sysdrive[drive].ms_disk, "consistency check started");
1598 error = mc->mc_status;
1606 /********************************************************************************
1607 * Start a background rebuild of the physical drive at (channel),(target).
1609 * May be called with interrupts enabled or disabled; will return as soon as the
1610 * operation has started or been refused.
1613 mlx_rebuild(struct mlx_softc *sc, int channel, int target)
1615 struct mlx_command *mc;
1620 /* get ourselves a command buffer */
1622 if ((mc = mlx_alloccmd(sc)) == NULL)
1624 /* get a command slot */
1625 if (mlx_getslot(mc))
1628 /* build a checkasync command, set the "fix it" flag */
1629 mlx_make_type2(mc, MLX_CMD_REBUILDASYNC, channel, target, 0, 0, 0, 0, 0, 0);
1631 /* start the command and wait for it to be returned */
1632 if (mlx_wait_command(mc))
1635 /* command completed OK? */
1636 if (mc->mc_status != 0) {
1637 device_printf(sc->mlx_dev, "REBUILD ASYNC failed - %s\n", mlx_diagnose_command(mc));
1639 device_printf(sc->mlx_dev, "drive rebuild started for %d:%d\n", channel, target);
1641 error = mc->mc_status;
1649 /********************************************************************************
1650 * Run the command (mc) and return when it completes.
1652 * Interrupts need to be enabled; returns nonzero on error.
1655 mlx_wait_command(struct mlx_command *mc)
1657 struct mlx_softc *sc = mc->mc_sc;
1662 mc->mc_complete = NULL;
1663 mc->mc_private = mc; /* wake us when you're done */
1664 if ((error = mlx_start(mc)) != 0)
1668 /* XXX better timeout? */
1669 while ((mc->mc_status == MLX_STATUS_BUSY) && (count < 30)) {
1670 tsleep(mc->mc_private, PRIBIO | PCATCH, "mlxwcmd", hz);
1673 if (mc->mc_status != 0) {
1674 device_printf(sc->mlx_dev, "command failed - %s\n", mlx_diagnose_command(mc));
1681 /********************************************************************************
1682 * Start the command (mc) and busy-wait for it to complete.
1684 * Should only be used when interrupts can't be relied upon. Returns 0 on
1685 * success, nonzero on error.
1686 * Successfully completed commands are dequeued.
1689 mlx_poll_command(struct mlx_command *mc)
1691 struct mlx_softc *sc = mc->mc_sc;
1692 int error, count, s;
1696 mc->mc_complete = NULL;
1697 mc->mc_private = NULL; /* we will poll for it */
1698 if ((error = mlx_start(mc)) != 0)
1703 /* poll for completion */
1704 mlx_done(mc->mc_sc);
1706 } while ((mc->mc_status == MLX_STATUS_BUSY) && (count++ < 15000000));
1707 if (mc->mc_status != MLX_STATUS_BUSY) {
1709 TAILQ_REMOVE(&sc->mlx_work, mc, mc_link);
1713 device_printf(sc->mlx_dev, "command failed - %s\n", mlx_diagnose_command(mc));
1717 /********************************************************************************
1718 * Pull as much work off the softc's work queue as possible and give it to the
1719 * controller. Leave a couple of slots free for emergencies.
1721 * Must be called at splbio or in an equivalent fashion that prevents
1722 * reentry or activity on the bioq.
1725 mlx_startio(struct mlx_softc *sc)
1727 struct mlx_command *mc;
1728 struct mlxd_softc *mlxd;
1735 /* avoid reentrancy */
1736 if (mlx_lock_tas(sc, MLX_LOCK_STARTING))
1739 /* spin until something prevents us from doing any work */
1743 /* see if there's work to be done */
1744 if ((bp = MLX_BIO_QFIRST(sc->mlx_bioq)) == NULL)
1747 if ((mc = mlx_alloccmd(sc)) == NULL)
1749 /* get a slot for the command */
1750 if (mlx_getslot(mc) != 0) {
1754 /* get the buf containing our work */
1755 MLX_BIO_QREMOVE(sc->mlx_bioq, bp);
1759 /* connect the buf to the command */
1760 mc->mc_complete = mlx_completeio;
1761 mc->mc_private = bp;
1762 mc->mc_data = MLX_BIO_DATA(bp);
1763 mc->mc_length = MLX_BIO_LENGTH(bp);
1764 if (MLX_BIO_IS_READ(bp)) {
1765 mc->mc_flags |= MLX_CMD_DATAIN;
1766 cmd = MLX_CMD_READSG;
1768 mc->mc_flags |= MLX_CMD_DATAOUT;
1769 cmd = MLX_CMD_WRITESG;
1772 /* map the command so the controller can work with it */
1775 /* build a suitable I/O command (assumes 512-byte rounded transfers) */
1776 mlxd = (struct mlxd_softc *)MLX_BIO_SOFTC(bp);
1777 driveno = mlxd->mlxd_drive - sc->mlx_sysdrive;
1778 blkcount = (MLX_BIO_LENGTH(bp) + MLX_BLKSIZE - 1) / MLX_BLKSIZE;
1780 if ((MLX_BIO_LBA(bp) + blkcount) > sc->mlx_sysdrive[driveno].ms_size)
1781 device_printf(sc->mlx_dev, "I/O beyond end of unit (%u,%d > %u)\n",
1782 MLX_BIO_LBA(bp), blkcount, sc->mlx_sysdrive[driveno].ms_size);
1785 * Build the I/O command. Note that the SG list type bits are set to zero,
1786 * denoting the format of SG list that we are using.
1788 if (sc->mlx_iftype == MLX_IFTYPE_2) {
1789 mlx_make_type1(mc, (cmd == MLX_CMD_WRITESG) ? MLX_CMD_WRITESG_OLD : MLX_CMD_READSG_OLD,
1790 blkcount & 0xff, /* xfer length low byte */
1791 MLX_BIO_LBA(bp), /* physical block number */
1792 driveno, /* target drive number */
1793 mc->mc_sgphys, /* location of SG list */
1794 mc->mc_nsgent & 0x3f); /* size of SG list (top 3 bits clear) */
1796 mlx_make_type5(mc, cmd,
1797 blkcount & 0xff, /* xfer length low byte */
1798 (driveno << 3) | ((blkcount >> 8) & 0x07), /* target and length high 3 bits */
1799 MLX_BIO_LBA(bp), /* physical block number */
1800 mc->mc_sgphys, /* location of SG list */
1801 mc->mc_nsgent & 0x3f); /* size of SG list (top 3 bits clear) */
1804 /* try to give command to controller */
1805 if (mlx_start(mc) != 0) {
1806 /* fail the command */
1807 mc->mc_status = MLX_STATUS_WEDGED;
1813 mlx_lock_clr(sc, MLX_LOCK_STARTING);
1816 /********************************************************************************
1817 * Handle completion of an I/O command.
1820 mlx_completeio(struct mlx_command *mc)
1822 struct mlx_softc *sc = mc->mc_sc;
1823 mlx_bio *bp = (mlx_bio *)mc->mc_private;
1824 struct mlxd_softc *mlxd = (struct mlxd_softc *)MLX_BIO_SOFTC(bp);
1826 if (mc->mc_status != MLX_STATUS_OK) { /* could be more verbose here? */
1827 MLX_BIO_SET_ERROR(bp, EIO);
1829 switch(mc->mc_status) {
1830 case MLX_STATUS_RDWROFFLINE: /* system drive has gone offline */
1831 device_printf(mlxd->mlxd_dev, "drive offline\n");
1832 /* should signal this with a return code */
1833 mlxd->mlxd_drive->ms_state = MLX_SYSD_OFFLINE;
1836 default: /* other I/O error */
1837 device_printf(sc->mlx_dev, "I/O error - %s\n", mlx_diagnose_command(mc));
1839 device_printf(sc->mlx_dev, " b_bcount %ld blkcount %ld b_pblkno %d\n",
1840 MLX_BIO_LENGTH(bp), MLX_BIO_LENGTH(bp) / MLX_BLKSIZE, MLX_BIO_LBA(bp));
1841 device_printf(sc->mlx_dev, " %13D\n", mc->mc_mailbox, " ");
1850 /********************************************************************************
1851 * Take a command from user-space and try to run it.
1853 * XXX Note that this can't perform very much in the way of error checking, and
1854 * as such, applications _must_ be considered trustworthy.
1855 * XXX Commands using S/G for data are not supported.
1858 mlx_user_command(struct mlx_softc *sc, struct mlx_usercommand *mu)
1860 struct mlx_command *mc;
1861 struct mlx_dcdb *dcdb;
1872 /* get ourselves a command and copy in from user space */
1873 if ((mc = mlx_alloccmd(sc)) == NULL)
1875 bcopy(mu->mu_command, mc->mc_mailbox, sizeof(mc->mc_mailbox));
1876 debug(0, "got command buffer");
1878 /* if we need a buffer for data transfer, allocate one and copy in its initial contents */
1879 if (mu->mu_datasize > 0) {
1880 if (mu->mu_datasize > MAXPHYS)
1882 if (((kbuf = malloc(mu->mu_datasize, M_DEVBUF, M_WAITOK)) == NULL) ||
1883 (error = copyin(mu->mu_buf, kbuf, mu->mu_datasize)))
1885 debug(0, "got kernel buffer");
1888 /* get a command slot */
1889 if (mlx_getslot(mc))
1891 debug(0, "got a slot");
1893 /* map the command so the controller can see it */
1895 mc->mc_length = mu->mu_datasize;
1900 * If this is a passthrough SCSI command, the DCDB is packed at the
1901 * beginning of the data area. Fix up the DCDB to point to the correct physical
1902 * address and override any bufptr supplied by the caller since we know
1903 * what it's meant to be.
1905 if (mc->mc_mailbox[0] == MLX_CMD_DIRECT_CDB) {
1906 dcdb = (struct mlx_dcdb *)kbuf;
1907 dcdb->dcdb_physaddr = mc->mc_dataphys + sizeof(*dcdb);
1912 * If there's a data buffer, fix up the command's buffer pointer.
1914 if (mu->mu_datasize > 0) {
1916 /* range check the pointer to physical buffer address */
1917 if ((mu->mu_bufptr < 0) || (mu->mu_bufptr > (sizeof(mu->mu_command) - sizeof(u_int32_t)))) {
1921 mc->mc_mailbox[mu->mu_bufptr ] = mc->mc_dataphys & 0xff;
1922 mc->mc_mailbox[mu->mu_bufptr + 1] = (mc->mc_dataphys >> 8) & 0xff;
1923 mc->mc_mailbox[mu->mu_bufptr + 2] = (mc->mc_dataphys >> 16) & 0xff;
1924 mc->mc_mailbox[mu->mu_bufptr + 3] = (mc->mc_dataphys >> 24) & 0xff;
1926 debug(0, "command fixup");
1928 /* submit the command and wait */
1929 if ((error = mlx_wait_command(mc)) != 0)
1932 /* copy out status and data */
1933 mu->mu_status = mc->mc_status;
1934 if ((mu->mu_datasize > 0) && ((error = copyout(kbuf, mu->mu_buf, mu->mu_datasize))))
1941 free(kbuf, M_DEVBUF);
1945 /********************************************************************************
1946 ********************************************************************************
1947 Command I/O to Controller
1948 ********************************************************************************
1949 ********************************************************************************/
1951 /********************************************************************************
1952 * Find a free command slot for (mc).
1954 * Don't hand out a slot to a normal-priority command unless there are at least
1955 * 4 slots free for priority commands.
1958 mlx_getslot(struct mlx_command *mc)
1960 struct mlx_softc *sc = mc->mc_sc;
1966 * Enforce slot-usage limit, if we have the required information.
1968 if (sc->mlx_enq2 != NULL) {
1969 limit = sc->mlx_enq2->me_max_commands;
1973 if (sc->mlx_busycmds >= ((mc->mc_flags & MLX_CMD_PRIORITY) ? limit : limit - 4))
1977 * Allocate an outstanding command slot
1979 * XXX linear search is slow
1982 for (slot = 0; slot < limit; slot++) {
1983 debug(2, "try slot %d", slot);
1984 if (sc->mlx_busycmd[slot] == NULL)
1988 sc->mlx_busycmd[slot] = mc;
1997 debug(2, "got slot %d", slot);
2002 /********************************************************************************
2003 * Map/unmap (mc)'s data in the controller's addressable space.
2006 mlx_setup_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error)
2008 struct mlx_command *mc = (struct mlx_command *)arg;
2009 struct mlx_softc *sc = mc->mc_sc;
2010 struct mlx_sgentry *sg;
2015 /* XXX should be unnecessary */
2016 if (sc->mlx_enq2 && (nsegments > sc->mlx_enq2->me_max_sg))
2017 panic("MLX: too many s/g segments (%d, max %d)", nsegments, sc->mlx_enq2->me_max_sg);
2019 /* get base address of s/g table */
2020 sg = sc->mlx_sgtable + (mc->mc_slot * MLX_NSEG);
2022 /* save s/g table information in command */
2023 mc->mc_nsgent = nsegments;
2024 mc->mc_sgphys = sc->mlx_sgbusaddr + (mc->mc_slot * MLX_NSEG * sizeof(struct mlx_sgentry));
2025 mc->mc_dataphys = segs[0].ds_addr;
2027 /* populate s/g table */
2028 for (i = 0; i < nsegments; i++, sg++) {
2029 sg->sg_addr = segs[i].ds_addr;
2030 sg->sg_count = segs[i].ds_len;
2035 mlx_mapcmd(struct mlx_command *mc)
2037 struct mlx_softc *sc = mc->mc_sc;
2041 /* if the command involves data at all */
2042 if (mc->mc_data != NULL) {
2044 /* map the data buffer into bus space and build the s/g list */
2045 bus_dmamap_load(sc->mlx_buffer_dmat, mc->mc_dmamap, mc->mc_data, mc->mc_length,
2046 mlx_setup_dmamap, mc, 0);
2047 if (mc->mc_flags & MLX_CMD_DATAIN)
2048 bus_dmamap_sync(sc->mlx_buffer_dmat, mc->mc_dmamap, BUS_DMASYNC_PREREAD);
2049 if (mc->mc_flags & MLX_CMD_DATAOUT)
2050 bus_dmamap_sync(sc->mlx_buffer_dmat, mc->mc_dmamap, BUS_DMASYNC_PREWRITE);
2055 mlx_unmapcmd(struct mlx_command *mc)
2057 struct mlx_softc *sc = mc->mc_sc;
2061 /* if the command involved data at all */
2062 if (mc->mc_data != NULL) {
2064 if (mc->mc_flags & MLX_CMD_DATAIN)
2065 bus_dmamap_sync(sc->mlx_buffer_dmat, mc->mc_dmamap, BUS_DMASYNC_POSTREAD);
2066 if (mc->mc_flags & MLX_CMD_DATAOUT)
2067 bus_dmamap_sync(sc->mlx_buffer_dmat, mc->mc_dmamap, BUS_DMASYNC_POSTWRITE);
2069 bus_dmamap_unload(sc->mlx_buffer_dmat, mc->mc_dmamap);
2073 /********************************************************************************
2074 * Try to deliver (mc) to the controller.
2076 * Can be called at any interrupt level, with or without interrupts enabled.
2079 mlx_start(struct mlx_command *mc)
2081 struct mlx_softc *sc = mc->mc_sc;
2086 /* save the slot number as ident so we can handle this command when complete */
2087 mc->mc_mailbox[0x1] = mc->mc_slot;
2089 /* mark the command as currently being processed */
2090 mc->mc_status = MLX_STATUS_BUSY;
2092 /* set a default 60-second timeout XXX tunable? XXX not currently used */
2093 mc->mc_timeout = time_second + 60;
2095 /* spin waiting for the mailbox */
2096 for (i = 100000, done = 0; (i > 0) && !done; i--) {
2098 if (sc->mlx_tryqueue(sc, mc)) {
2100 /* move command to work queue */
2101 TAILQ_INSERT_TAIL(&sc->mlx_work, mc, mc_link);
2103 splx(s); /* drop spl to allow completion interrupts */
2106 /* command is enqueued */
2111 * We couldn't get the controller to take the command. Revoke the slot
2112 * that the command was given and return it with a bad status.
2114 sc->mlx_busycmd[mc->mc_slot] = NULL;
2115 device_printf(sc->mlx_dev, "controller wedged (not taking commands)\n");
2116 mc->mc_status = MLX_STATUS_WEDGED;
2121 /********************************************************************************
2122 * Poll the controller (sc) for completed commands.
2123 * Update command status and free slots for reuse. If any slots were freed,
2124 * new commands may be posted.
2126 * Returns nonzero if one or more commands were completed.
2129 mlx_done(struct mlx_softc *sc)
2131 struct mlx_command *mc;
2140 /* loop collecting completed commands */
2143 /* poll for a completed command's identifier and status */
2144 if (sc->mlx_findcomplete(sc, &slot, &status)) {
2146 mc = sc->mlx_busycmd[slot]; /* find command */
2147 if (mc != NULL) { /* paranoia */
2148 if (mc->mc_status == MLX_STATUS_BUSY) {
2149 mc->mc_status = status; /* save status */
2151 /* free slot for reuse */
2152 sc->mlx_busycmd[slot] = NULL;
2155 device_printf(sc->mlx_dev, "duplicate done event for slot %d\n", slot);
2158 device_printf(sc->mlx_dev, "done event for nonbusy slot %d\n", slot);
2166 /* if we've completed any commands, try posting some more */
2170 /* handle completion and timeouts */
2176 /********************************************************************************
2177 * Perform post-completion processing for commands on (sc).
2180 mlx_complete(struct mlx_softc *sc)
2182 struct mlx_command *mc, *nc;
2187 /* avoid reentrancy XXX might want to signal and request a restart */
2188 if (mlx_lock_tas(sc, MLX_LOCK_COMPLETING))
2194 /* scan the list of busy/done commands */
2195 mc = TAILQ_FIRST(&sc->mlx_work);
2196 while (mc != NULL) {
2197 nc = TAILQ_NEXT(mc, mc_link);
2199 /* Command has been completed in some fashion */
2200 if (mc->mc_status != MLX_STATUS_BUSY) {
2202 /* unmap the command's data buffer */
2205 * Does the command have a completion handler?
2207 if (mc->mc_complete != NULL) {
2208 /* remove from list and give to handler */
2209 TAILQ_REMOVE(&sc->mlx_work, mc, mc_link);
2210 mc->mc_complete(mc);
2213 * Is there a sleeper waiting on this command?
2215 } else if (mc->mc_private != NULL) { /* sleeping caller wants to know about it */
2217 /* remove from list and wake up sleeper */
2218 TAILQ_REMOVE(&sc->mlx_work, mc, mc_link);
2219 wakeup_one(mc->mc_private);
2222 * Leave the command for a caller that's polling for it.
2231 mlx_lock_clr(sc, MLX_LOCK_COMPLETING);
2234 /********************************************************************************
2235 ********************************************************************************
2236 Command Buffer Management
2237 ********************************************************************************
2238 ********************************************************************************/
2240 /********************************************************************************
2241 * Get a new command buffer.
2243 * This may return NULL in low-memory cases.
2245 * Note that using malloc() is expensive (the command buffer is << 1 page) but
2246 * necessary if we are to be a loadable module before the zone allocator is fixed.
2248 * If possible, we recycle a command buffer that's been used before.
2250 * XXX Note that command buffers are not cleaned out - it is the caller's
2251 * responsibility to ensure that all required fields are filled in before
2254 static struct mlx_command *
2255 mlx_alloccmd(struct mlx_softc *sc)
2257 struct mlx_command *mc;
2264 if ((mc = TAILQ_FIRST(&sc->mlx_freecmds)) != NULL)
2265 TAILQ_REMOVE(&sc->mlx_freecmds, mc, mc_link);
2268 /* allocate a new command buffer? */
2270 mc = (struct mlx_command *)malloc(sizeof(*mc), M_DEVBUF, M_NOWAIT | M_ZERO);
2273 error = bus_dmamap_create(sc->mlx_buffer_dmat, 0, &mc->mc_dmamap);
2283 /********************************************************************************
2284 * Release a command buffer for recycling.
2286 * XXX It might be a good idea to limit the number of commands we save for reuse
2287 * if it's shown that this list bloats out massively.
2290 mlx_releasecmd(struct mlx_command *mc)
2297 TAILQ_INSERT_HEAD(&mc->mc_sc->mlx_freecmds, mc, mc_link);
2301 /********************************************************************************
2302 * Permanently discard a command buffer.
2305 mlx_freecmd(struct mlx_command *mc)
2307 struct mlx_softc *sc = mc->mc_sc;
2310 bus_dmamap_destroy(sc->mlx_buffer_dmat, mc->mc_dmamap);
2315 /********************************************************************************
2316 ********************************************************************************
2317 Type 3 interface accessor methods
2318 ********************************************************************************
2319 ********************************************************************************/
2321 /********************************************************************************
2322 * Try to give (mc) to the controller. Returns 1 if successful, 0 on failure
2323 * (the controller is not ready to take a command).
2325 * Must be called at splbio or in a fashion that prevents reentry.
2328 mlx_v3_tryqueue(struct mlx_softc *sc, struct mlx_command *mc)
2334 /* ready for our command? */
2335 if (!(MLX_V3_GET_IDBR(sc) & MLX_V3_IDB_FULL)) {
2336 /* copy mailbox data to window */
2337 for (i = 0; i < 13; i++)
2338 MLX_V3_PUT_MAILBOX(sc, i, mc->mc_mailbox[i]);
2341 MLX_V3_PUT_IDBR(sc, MLX_V3_IDB_FULL);
2347 /********************************************************************************
2348 * See if a command has been completed, if so acknowledge its completion
2349 * and recover the slot number and status code.
2351 * Must be called at splbio or in a fashion that prevents reentry.
2354 mlx_v3_findcomplete(struct mlx_softc *sc, u_int8_t *slot, u_int16_t *status)
2359 /* status available? */
2360 if (MLX_V3_GET_ODBR(sc) & MLX_V3_ODB_SAVAIL) {
2361 *slot = MLX_V3_GET_STATUS_IDENT(sc); /* get command identifier */
2362 *status = MLX_V3_GET_STATUS(sc); /* get status */
2364 /* acknowledge completion */
2365 MLX_V3_PUT_ODBR(sc, MLX_V3_ODB_SAVAIL);
2366 MLX_V3_PUT_IDBR(sc, MLX_V3_IDB_SACK);
2372 /********************************************************************************
2373 * Enable/disable interrupts as requested. (No acknowledge required)
2375 * Must be called at splbio or in a fashion that prevents reentry.
2378 mlx_v3_intaction(struct mlx_softc *sc, int action)
2383 case MLX_INTACTION_DISABLE:
2384 MLX_V3_PUT_IER(sc, 0);
2385 sc->mlx_state &= ~MLX_STATE_INTEN;
2387 case MLX_INTACTION_ENABLE:
2388 MLX_V3_PUT_IER(sc, 1);
2389 sc->mlx_state |= MLX_STATE_INTEN;
2394 /********************************************************************************
2395 * Poll for firmware error codes during controller initialisation.
2396 * Returns 0 if initialisation is complete, 1 if still in progress but no
2397 * error has been fetched, 2 if an error has been retrieved.
2400 mlx_v3_fw_handshake(struct mlx_softc *sc, int *error, int *param1, int *param2)
2403 static int initted = 0;
2407 /* first time around, clear any hardware completion status */
2409 MLX_V3_PUT_IDBR(sc, MLX_V3_IDB_SACK);
2414 /* init in progress? */
2415 if (!(MLX_V3_GET_IDBR(sc) & MLX_V3_IDB_INIT_BUSY))
2418 /* test error value */
2419 fwerror = MLX_V3_GET_FWERROR(sc);
2420 if (!(fwerror & MLX_V3_FWERROR_PEND))
2423 /* mask status pending bit, fetch status */
2424 *error = fwerror & ~MLX_V3_FWERROR_PEND;
2425 *param1 = MLX_V3_GET_FWERROR_PARAM1(sc);
2426 *param2 = MLX_V3_GET_FWERROR_PARAM2(sc);
2429 MLX_V3_PUT_FWERROR(sc, 0);
2434 /********************************************************************************
2435 ********************************************************************************
2436 Type 4 interface accessor methods
2437 ********************************************************************************
2438 ********************************************************************************/
2440 /********************************************************************************
2441 * Try to give (mc) to the controller. Returns 1 if successful, 0 on failure
2442 * (the controller is not ready to take a command).
2444 * Must be called at splbio or in a fashion that prevents reentry.
2447 mlx_v4_tryqueue(struct mlx_softc *sc, struct mlx_command *mc)
2453 /* ready for our command? */
2454 if (!(MLX_V4_GET_IDBR(sc) & MLX_V4_IDB_FULL)) {
2455 /* copy mailbox data to window */
2456 for (i = 0; i < 13; i++)
2457 MLX_V4_PUT_MAILBOX(sc, i, mc->mc_mailbox[i]);
2459 /* memory-mapped controller, so issue a write barrier to ensure the mailbox is filled */
2460 bus_space_barrier(sc->mlx_btag, sc->mlx_bhandle, MLX_V4_MAILBOX, MLX_V4_MAILBOX_LENGTH,
2461 BUS_SPACE_BARRIER_WRITE);
2464 MLX_V4_PUT_IDBR(sc, MLX_V4_IDB_HWMBOX_CMD);
2470 /********************************************************************************
2471 * See if a command has been completed, if so acknowledge its completion
2472 * and recover the slot number and status code.
2474 * Must be called at splbio or in a fashion that prevents reentry.
2477 mlx_v4_findcomplete(struct mlx_softc *sc, u_int8_t *slot, u_int16_t *status)
2482 /* status available? */
2483 if (MLX_V4_GET_ODBR(sc) & MLX_V4_ODB_HWSAVAIL) {
2484 *slot = MLX_V4_GET_STATUS_IDENT(sc); /* get command identifier */
2485 *status = MLX_V4_GET_STATUS(sc); /* get status */
2487 /* acknowledge completion */
2488 MLX_V4_PUT_ODBR(sc, MLX_V4_ODB_HWMBOX_ACK);
2489 MLX_V4_PUT_IDBR(sc, MLX_V4_IDB_SACK);
2495 /********************************************************************************
2496 * Enable/disable interrupts as requested.
2498 * Must be called at splbio or in a fashion that prevents reentry.
2501 mlx_v4_intaction(struct mlx_softc *sc, int action)
2506 case MLX_INTACTION_DISABLE:
2507 MLX_V4_PUT_IER(sc, MLX_V4_IER_MASK | MLX_V4_IER_DISINT);
2508 sc->mlx_state &= ~MLX_STATE_INTEN;
2510 case MLX_INTACTION_ENABLE:
2511 MLX_V4_PUT_IER(sc, MLX_V4_IER_MASK & ~MLX_V4_IER_DISINT);
2512 sc->mlx_state |= MLX_STATE_INTEN;
2517 /********************************************************************************
2518 * Poll for firmware error codes during controller initialisation.
2519 * Returns 0 if initialisation is complete, 1 if still in progress but no
2520 * error has been fetched, 2 if an error has been retrieved.
2523 mlx_v4_fw_handshake(struct mlx_softc *sc, int *error, int *param1, int *param2)
2526 static int initted = 0;
2530 /* first time around, clear any hardware completion status */
2532 MLX_V4_PUT_IDBR(sc, MLX_V4_IDB_SACK);
2537 /* init in progress? */
2538 if (!(MLX_V4_GET_IDBR(sc) & MLX_V4_IDB_INIT_BUSY))
2541 /* test error value */
2542 fwerror = MLX_V4_GET_FWERROR(sc);
2543 if (!(fwerror & MLX_V4_FWERROR_PEND))
2546 /* mask status pending bit, fetch status */
2547 *error = fwerror & ~MLX_V4_FWERROR_PEND;
2548 *param1 = MLX_V4_GET_FWERROR_PARAM1(sc);
2549 *param2 = MLX_V4_GET_FWERROR_PARAM2(sc);
2552 MLX_V4_PUT_FWERROR(sc, 0);
2557 /********************************************************************************
2558 ********************************************************************************
2559 Type 5 interface accessor methods
2560 ********************************************************************************
2561 ********************************************************************************/
2563 /********************************************************************************
2564 * Try to give (mc) to the controller. Returns 1 if successful, 0 on failure
2565 * (the controller is not ready to take a command).
2567 * Must be called at splbio or in a fashion that prevents reentry.
2570 mlx_v5_tryqueue(struct mlx_softc *sc, struct mlx_command *mc)
2576 /* ready for our command? */
2577 if (MLX_V5_GET_IDBR(sc) & MLX_V5_IDB_EMPTY) {
2578 /* copy mailbox data to window */
2579 for (i = 0; i < 13; i++)
2580 MLX_V5_PUT_MAILBOX(sc, i, mc->mc_mailbox[i]);
2583 MLX_V5_PUT_IDBR(sc, MLX_V5_IDB_HWMBOX_CMD);
2589 /********************************************************************************
2590 * See if a command has been completed, if so acknowledge its completion
2591 * and recover the slot number and status code.
2593 * Must be called at splbio or in a fashion that prevents reentry.
2596 mlx_v5_findcomplete(struct mlx_softc *sc, u_int8_t *slot, u_int16_t *status)
2601 /* status available? */
2602 if (MLX_V5_GET_ODBR(sc) & MLX_V5_ODB_HWSAVAIL) {
2603 *slot = MLX_V5_GET_STATUS_IDENT(sc); /* get command identifier */
2604 *status = MLX_V5_GET_STATUS(sc); /* get status */
2606 /* acknowledge completion */
2607 MLX_V5_PUT_ODBR(sc, MLX_V5_ODB_HWMBOX_ACK);
2608 MLX_V5_PUT_IDBR(sc, MLX_V5_IDB_SACK);
2614 /********************************************************************************
2615 * Enable/disable interrupts as requested.
2617 * Must be called at splbio or in a fashion that prevents reentry.
2620 mlx_v5_intaction(struct mlx_softc *sc, int action)
2625 case MLX_INTACTION_DISABLE:
2626 MLX_V5_PUT_IER(sc, 0xff & MLX_V5_IER_DISINT);
2627 sc->mlx_state &= ~MLX_STATE_INTEN;
2629 case MLX_INTACTION_ENABLE:
2630 MLX_V5_PUT_IER(sc, 0xff & ~MLX_V5_IER_DISINT);
2631 sc->mlx_state |= MLX_STATE_INTEN;
2636 /********************************************************************************
2637 * Poll for firmware error codes during controller initialisation.
2638 * Returns 0 if initialisation is complete, 1 if still in progress but no
2639 * error has been fetched, 2 if an error has been retrieved.
2642 mlx_v5_fw_handshake(struct mlx_softc *sc, int *error, int *param1, int *param2)
2645 static int initted = 0;
2649 /* first time around, clear any hardware completion status */
2651 MLX_V5_PUT_IDBR(sc, MLX_V5_IDB_SACK);
2656 /* init in progress? */
2657 if (MLX_V5_GET_IDBR(sc) & MLX_V5_IDB_INIT_DONE)
2660 /* test for error value */
2661 fwerror = MLX_V5_GET_FWERROR(sc);
2662 if (!(fwerror & MLX_V5_FWERROR_PEND))
2665 /* mask status pending bit, fetch status */
2666 *error = fwerror & ~MLX_V5_FWERROR_PEND;
2667 *param1 = MLX_V5_GET_FWERROR_PARAM1(sc);
2668 *param2 = MLX_V5_GET_FWERROR_PARAM2(sc);
2671 MLX_V5_PUT_FWERROR(sc, 0xff);
2676 /********************************************************************************
2677 ********************************************************************************
2679 ********************************************************************************
2680 ********************************************************************************/
2682 /********************************************************************************
2683 * Return a status message describing (mc)
2685 static char *mlx_status_messages[] = {
2686 "normal completion", /* 00 */
2687 "irrecoverable data error", /* 01 */
2688 "drive does not exist, or is offline", /* 02 */
2689 "attempt to write beyond end of drive", /* 03 */
2690 "bad data encountered", /* 04 */
2691 "invalid log entry request", /* 05 */
2692 "attempt to rebuild online drive", /* 06 */
2693 "new disk failed during rebuild", /* 07 */
2694 "invalid channel/target", /* 08 */
2695 "rebuild/check already in progress", /* 09 */
2696 "one or more disks are dead", /* 10 */
2697 "invalid or non-redundant drive", /* 11 */
2698 "channel is busy", /* 12 */
2699 "channel is not stopped", /* 13 */
2700 "rebuild successfully terminated", /* 14 */
2701 "unsupported command", /* 15 */
2702 "check condition received", /* 16 */
2703 "device is busy", /* 17 */
2704 "selection or command timeout", /* 18 */
2705 "command terminated abnormally", /* 19 */
2714 } mlx_messages[] = {
2715 {MLX_CMD_READSG, 0x0001, 1},
2716 {MLX_CMD_READSG, 0x0002, 1},
2717 {MLX_CMD_READSG, 0x0105, 3},
2718 {MLX_CMD_READSG, 0x010c, 4},
2719 {MLX_CMD_WRITESG, 0x0001, 1},
2720 {MLX_CMD_WRITESG, 0x0002, 1},
2721 {MLX_CMD_WRITESG, 0x0105, 3},
2722 {MLX_CMD_READSG_OLD, 0x0001, 1},
2723 {MLX_CMD_READSG_OLD, 0x0002, 1},
2724 {MLX_CMD_READSG_OLD, 0x0105, 3},
2725 {MLX_CMD_WRITESG_OLD, 0x0001, 1},
2726 {MLX_CMD_WRITESG_OLD, 0x0002, 1},
2727 {MLX_CMD_WRITESG_OLD, 0x0105, 3},
2728 {MLX_CMD_LOGOP, 0x0105, 5},
2729 {MLX_CMD_REBUILDASYNC, 0x0002, 6},
2730 {MLX_CMD_REBUILDASYNC, 0x0004, 7},
2731 {MLX_CMD_REBUILDASYNC, 0x0105, 8},
2732 {MLX_CMD_REBUILDASYNC, 0x0106, 9},
2733 {MLX_CMD_REBUILDASYNC, 0x0107, 14},
2734 {MLX_CMD_CHECKASYNC, 0x0002, 10},
2735 {MLX_CMD_CHECKASYNC, 0x0105, 11},
2736 {MLX_CMD_CHECKASYNC, 0x0106, 9},
2737 {MLX_CMD_STOPCHANNEL, 0x0106, 12},
2738 {MLX_CMD_STOPCHANNEL, 0x0105, 8},
2739 {MLX_CMD_STARTCHANNEL, 0x0005, 13},
2740 {MLX_CMD_STARTCHANNEL, 0x0105, 8},
2741 {MLX_CMD_DIRECT_CDB, 0x0002, 16},
2742 {MLX_CMD_DIRECT_CDB, 0x0008, 17},
2743 {MLX_CMD_DIRECT_CDB, 0x000e, 18},
2744 {MLX_CMD_DIRECT_CDB, 0x000f, 19},
2745 {MLX_CMD_DIRECT_CDB, 0x0105, 8},
2752 mlx_diagnose_command(struct mlx_command *mc)
2754 static char unkmsg[80];
2757 /* look up message in table */
2758 for (i = 0; mlx_messages[i].command != -1; i++)
2759 if (((mc->mc_mailbox[0] == mlx_messages[i].command) || (mlx_messages[i].command == 0)) &&
2760 (mc->mc_status == mlx_messages[i].status))
2761 return(mlx_status_messages[mlx_messages[i].msg]);
2763 sprintf(unkmsg, "unknown response 0x%x for command 0x%x", (int)mc->mc_status, (int)mc->mc_mailbox[0]);
2767 /*******************************************************************************
2768 * Print a string describing the controller (sc)
2774 } mlx_controller_names[] = {
2789 mlx_describe_controller(struct mlx_softc *sc)
2791 static char buf[80];
2795 for (i = 0, model = NULL; mlx_controller_names[i].name != NULL; i++) {
2796 if ((sc->mlx_enq2->me_hardware_id & 0xff) == mlx_controller_names[i].hwid) {
2797 model = mlx_controller_names[i].name;
2801 if (model == NULL) {
2802 sprintf(buf, " model 0x%x", sc->mlx_enq2->me_hardware_id & 0xff);
2805 device_printf(sc->mlx_dev, "DAC%s, %d channel%s, firmware %d.%02d-%c-%02d, %dMB RAM\n",
2807 sc->mlx_enq2->me_actual_channels,
2808 sc->mlx_enq2->me_actual_channels > 1 ? "s" : "",
2809 sc->mlx_enq2->me_firmware_id & 0xff,
2810 (sc->mlx_enq2->me_firmware_id >> 8) & 0xff,
2811 (sc->mlx_enq2->me_firmware_id >> 24) & 0xff,
2812 (sc->mlx_enq2->me_firmware_id >> 16) & 0xff,
2813 sc->mlx_enq2->me_mem_size / (1024 * 1024));
2816 device_printf(sc->mlx_dev, " Hardware ID 0x%08x\n", sc->mlx_enq2->me_hardware_id);
2817 device_printf(sc->mlx_dev, " Firmware ID 0x%08x\n", sc->mlx_enq2->me_firmware_id);
2818 device_printf(sc->mlx_dev, " Configured/Actual channels %d/%d\n", sc->mlx_enq2->me_configured_channels,
2819 sc->mlx_enq2->me_actual_channels);
2820 device_printf(sc->mlx_dev, " Max Targets %d\n", sc->mlx_enq2->me_max_targets);
2821 device_printf(sc->mlx_dev, " Max Tags %d\n", sc->mlx_enq2->me_max_tags);
2822 device_printf(sc->mlx_dev, " Max System Drives %d\n", sc->mlx_enq2->me_max_sys_drives);
2823 device_printf(sc->mlx_dev, " Max Arms %d\n", sc->mlx_enq2->me_max_arms);
2824 device_printf(sc->mlx_dev, " Max Spans %d\n", sc->mlx_enq2->me_max_spans);
2825 device_printf(sc->mlx_dev, " DRAM/cache/flash/NVRAM size %d/%d/%d/%d\n", sc->mlx_enq2->me_mem_size,
2826 sc->mlx_enq2->me_cache_size, sc->mlx_enq2->me_flash_size, sc->mlx_enq2->me_nvram_size);
2827 device_printf(sc->mlx_dev, " DRAM type %d\n", sc->mlx_enq2->me_mem_type);
2828 device_printf(sc->mlx_dev, " Clock Speed %dns\n", sc->mlx_enq2->me_clock_speed);
2829 device_printf(sc->mlx_dev, " Hardware Speed %dns\n", sc->mlx_enq2->me_hardware_speed);
2830 device_printf(sc->mlx_dev, " Max Commands %d\n", sc->mlx_enq2->me_max_commands);
2831 device_printf(sc->mlx_dev, " Max SG Entries %d\n", sc->mlx_enq2->me_max_sg);
2832 device_printf(sc->mlx_dev, " Max DP %d\n", sc->mlx_enq2->me_max_dp);
2833 device_printf(sc->mlx_dev, " Max IOD %d\n", sc->mlx_enq2->me_max_iod);
2834 device_printf(sc->mlx_dev, " Max Comb %d\n", sc->mlx_enq2->me_max_comb);
2835 device_printf(sc->mlx_dev, " Latency %ds\n", sc->mlx_enq2->me_latency);
2836 device_printf(sc->mlx_dev, " SCSI Timeout %ds\n", sc->mlx_enq2->me_scsi_timeout);
2837 device_printf(sc->mlx_dev, " Min Free Lines %d\n", sc->mlx_enq2->me_min_freelines);
2838 device_printf(sc->mlx_dev, " Rate Constant %d\n", sc->mlx_enq2->me_rate_const);
2839 device_printf(sc->mlx_dev, " MAXBLK %d\n", sc->mlx_enq2->me_maxblk);
2840 device_printf(sc->mlx_dev, " Blocking Factor %d sectors\n", sc->mlx_enq2->me_blocking_factor);
2841 device_printf(sc->mlx_dev, " Cache Line Size %d blocks\n", sc->mlx_enq2->me_cacheline);
2842 device_printf(sc->mlx_dev, " SCSI Capability %s%dMHz, %d bit\n",
2843 sc->mlx_enq2->me_scsi_cap & (1<<4) ? "differential " : "",
2844 (1 << ((sc->mlx_enq2->me_scsi_cap >> 2) & 3)) * 10,
2845 8 << (sc->mlx_enq2->me_scsi_cap & 0x3));
2846 device_printf(sc->mlx_dev, " Firmware Build Number %d\n", sc->mlx_enq2->me_firmware_build);
2847 device_printf(sc->mlx_dev, " Fault Management Type %d\n", sc->mlx_enq2->me_fault_mgmt_type);
2848 device_printf(sc->mlx_dev, " Features %b\n", sc->mlx_enq2->me_firmware_features,
2849 "\20\4Background Init\3Read Ahead\2MORE\1Cluster\n");
2854 /*******************************************************************************
2855 * Emit a string describing the firmware handshake status code, and return a flag
2856 * indicating whether the code represents a fatal error.
2858 * Error code interpretations are from the Linux driver, and don't directly match
2859 * the messages printed by Mylex's BIOS. This may change if documentation on the
2860 * codes is forthcoming.
2863 mlx_fw_message(struct mlx_softc *sc, int error, int param1, int param2)
2867 device_printf(sc->mlx_dev, "physical drive %d:%d not responding\n", param2, param1);
2870 /* we could be neater about this and give some indication when we receive more of them */
2871 if (!(sc->mlx_flags & MLX_SPINUP_REPORTED)) {
2872 device_printf(sc->mlx_dev, "spinning up drives...\n");
2873 sc->mlx_flags |= MLX_SPINUP_REPORTED;
2877 device_printf(sc->mlx_dev, "configuration checksum error\n");
2880 device_printf(sc->mlx_dev, "mirror race recovery failed\n");
2883 device_printf(sc->mlx_dev, "mirror race recovery in progress\n");
2886 device_printf(sc->mlx_dev, "physical drive %d:%d COD mismatch\n", param2, param1);
2889 device_printf(sc->mlx_dev, "logical drive installation aborted\n");
2892 device_printf(sc->mlx_dev, "mirror race on a critical system drive\n");
2895 device_printf(sc->mlx_dev, "new controller configuration found\n");
2898 device_printf(sc->mlx_dev, "FATAL MEMORY PARITY ERROR\n");
2901 device_printf(sc->mlx_dev, "unknown firmware initialisation error %02x:%02x:%02x\n", error, param1, param2);
2907 /********************************************************************************
2908 ********************************************************************************
2910 ********************************************************************************
2911 ********************************************************************************/
2913 /********************************************************************************
2914 * Find the disk whose unit number is (unit) on this controller
2916 static struct mlx_sysdrive *
2917 mlx_findunit(struct mlx_softc *sc, int unit)
2921 /* search system drives */
2922 for (i = 0; i < MLX_MAXDRIVES; i++) {
2923 /* is this one attached? */
2924 if (sc->mlx_sysdrive[i].ms_disk != 0) {
2925 /* is this the one? */
2926 if (unit == device_get_unit(sc->mlx_sysdrive[i].ms_disk))
2927 return(&sc->mlx_sysdrive[i]);