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.23 2006/12/20 18:14:40 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>
40 #include <sys/devicestat.h>
44 #include <sys/thread2.h>
46 #include <machine/clock.h>
48 #include "mlx_compat.h"
53 #define MLX_CDEV_MAJOR 130
55 static struct dev_ops mlx_ops
= {
56 { "mlx", MLX_CDEV_MAJOR
, 0 },
62 devclass_t mlx_devclass
;
65 * Per-interface accessor methods
67 static int mlx_v3_tryqueue(struct mlx_softc
*sc
, struct mlx_command
*mc
);
68 static int mlx_v3_findcomplete(struct mlx_softc
*sc
, u_int8_t
*slot
, u_int16_t
*status
);
69 static void mlx_v3_intaction(struct mlx_softc
*sc
, int action
);
70 static int mlx_v3_fw_handshake(struct mlx_softc
*sc
, int *error
, int *param1
, int *param2
);
72 static int mlx_v4_tryqueue(struct mlx_softc
*sc
, struct mlx_command
*mc
);
73 static int mlx_v4_findcomplete(struct mlx_softc
*sc
, u_int8_t
*slot
, u_int16_t
*status
);
74 static void mlx_v4_intaction(struct mlx_softc
*sc
, int action
);
75 static int mlx_v4_fw_handshake(struct mlx_softc
*sc
, int *error
, int *param1
, int *param2
);
77 static int mlx_v5_tryqueue(struct mlx_softc
*sc
, struct mlx_command
*mc
);
78 static int mlx_v5_findcomplete(struct mlx_softc
*sc
, u_int8_t
*slot
, u_int16_t
*status
);
79 static void mlx_v5_intaction(struct mlx_softc
*sc
, int action
);
80 static int mlx_v5_fw_handshake(struct mlx_softc
*sc
, int *error
, int *param1
, int *param2
);
85 static void mlx_periodic(void *data
);
86 static void mlx_periodic_enquiry(struct mlx_command
*mc
);
87 static void mlx_periodic_eventlog_poll(struct mlx_softc
*sc
);
88 static void mlx_periodic_eventlog_respond(struct mlx_command
*mc
);
89 static void mlx_periodic_rebuild(struct mlx_command
*mc
);
94 static void mlx_pause_action(struct mlx_softc
*sc
);
95 static void mlx_pause_done(struct mlx_command
*mc
);
100 static void *mlx_enquire(struct mlx_softc
*sc
, int command
, size_t bufsize
,
101 void (*complete
)(struct mlx_command
*mc
));
102 static int mlx_flush(struct mlx_softc
*sc
);
103 static int mlx_check(struct mlx_softc
*sc
, int drive
);
104 static int mlx_rebuild(struct mlx_softc
*sc
, int channel
, int target
);
105 static int mlx_wait_command(struct mlx_command
*mc
);
106 static int mlx_poll_command(struct mlx_command
*mc
);
107 static void mlx_startio(struct mlx_softc
*sc
);
108 static void mlx_completeio(struct mlx_command
*mc
);
109 static int mlx_user_command(struct mlx_softc
*sc
, struct mlx_usercommand
*mu
);
112 * Command buffer allocation.
114 static struct mlx_command
*mlx_alloccmd(struct mlx_softc
*sc
);
115 static void mlx_releasecmd(struct mlx_command
*mc
);
116 static void mlx_freecmd(struct mlx_command
*mc
);
119 * Command management.
121 static int mlx_getslot(struct mlx_command
*mc
);
122 static void mlx_mapcmd(struct mlx_command
*mc
);
123 static void mlx_unmapcmd(struct mlx_command
*mc
);
124 static int mlx_start(struct mlx_command
*mc
);
125 static int mlx_done(struct mlx_softc
*sc
);
126 static void mlx_complete(struct mlx_softc
*sc
);
131 static char *mlx_diagnose_command(struct mlx_command
*mc
);
132 static void mlx_describe_controller(struct mlx_softc
*sc
);
133 static int mlx_fw_message(struct mlx_softc
*sc
, int status
, int param1
, int param2
);
138 static struct mlx_sysdrive
*mlx_findunit(struct mlx_softc
*sc
, int unit
);
140 /********************************************************************************
141 ********************************************************************************
143 ********************************************************************************
144 ********************************************************************************/
146 /********************************************************************************
147 * Free all of the resources associated with (sc)
149 * Should not be called if the controller is active.
152 mlx_free(struct mlx_softc
*sc
)
154 struct mlx_command
*mc
;
158 /* cancel status timeout */
159 callout_stop(&sc
->mlx_timeout
);
161 /* throw away any command buffers */
162 while ((mc
= TAILQ_FIRST(&sc
->mlx_freecmds
)) != NULL
) {
163 TAILQ_REMOVE(&sc
->mlx_freecmds
, mc
, mc_link
);
167 /* destroy data-transfer DMA tag */
168 if (sc
->mlx_buffer_dmat
)
169 bus_dma_tag_destroy(sc
->mlx_buffer_dmat
);
171 /* free and destroy DMA memory and tag for s/g lists */
173 bus_dmamem_free(sc
->mlx_sg_dmat
, sc
->mlx_sgtable
, sc
->mlx_sg_dmamap
);
175 bus_dma_tag_destroy(sc
->mlx_sg_dmat
);
177 /* disconnect the interrupt handler */
179 bus_teardown_intr(sc
->mlx_dev
, sc
->mlx_irq
, sc
->mlx_intr
);
180 if (sc
->mlx_irq
!= NULL
)
181 bus_release_resource(sc
->mlx_dev
, SYS_RES_IRQ
, 0, sc
->mlx_irq
);
183 /* destroy the parent DMA tag */
184 if (sc
->mlx_parent_dmat
)
185 bus_dma_tag_destroy(sc
->mlx_parent_dmat
);
187 /* release the register window mapping */
188 if (sc
->mlx_mem
!= NULL
)
189 bus_release_resource(sc
->mlx_dev
, sc
->mlx_mem_type
, sc
->mlx_mem_rid
, sc
->mlx_mem
);
191 /* free controller enquiry data */
192 if (sc
->mlx_enq2
!= NULL
)
193 kfree(sc
->mlx_enq2
, M_DEVBUF
);
195 dev_ops_remove(&mlx_ops
, -1, device_get_unit(sc
->mlx_dev
));
198 /********************************************************************************
199 * Map the scatter/gather table into bus space
202 mlx_dma_map_sg(void *arg
, bus_dma_segment_t
*segs
, int nseg
, int error
)
204 struct mlx_softc
*sc
= (struct mlx_softc
*)arg
;
208 /* save base of s/g table's address in bus space */
209 sc
->mlx_sgbusaddr
= segs
->ds_addr
;
213 mlx_sglist_map(struct mlx_softc
*sc
)
220 /* destroy any existing mappings */
222 bus_dmamem_free(sc
->mlx_sg_dmat
, sc
->mlx_sgtable
, sc
->mlx_sg_dmamap
);
224 bus_dma_tag_destroy(sc
->mlx_sg_dmat
);
227 * Create a single tag describing a region large enough to hold all of
228 * the s/g lists we will need. If we're called early on, we don't know how
229 * many commands we're going to be asked to support, so only allocate enough
232 if (sc
->mlx_enq2
== NULL
) {
235 ncmd
= sc
->mlx_enq2
->me_max_commands
;
237 segsize
= sizeof(struct mlx_sgentry
) * MLX_NSEG
* ncmd
;
238 error
= bus_dma_tag_create(sc
->mlx_parent_dmat
, /* parent */
239 1, 0, /* alignment, boundary */
240 BUS_SPACE_MAXADDR
, /* lowaddr */
241 BUS_SPACE_MAXADDR
, /* highaddr */
242 NULL
, NULL
, /* filter, filterarg */
243 segsize
, 1, /* maxsize, nsegments */
244 BUS_SPACE_MAXSIZE_32BIT
, /* maxsegsize */
248 device_printf(sc
->mlx_dev
, "can't allocate scatter/gather DMA tag\n");
253 * Allocate enough s/g maps for all commands and permanently map them into
254 * controller-visible space.
256 * XXX this assumes we can get enough space for all the s/g maps in one
257 * contiguous slab. We may need to switch to a more complex arrangement where
258 * we allocate in smaller chunks and keep a lookup table from slot to bus address.
260 error
= bus_dmamem_alloc(sc
->mlx_sg_dmat
, (void **)&sc
->mlx_sgtable
, BUS_DMA_NOWAIT
, &sc
->mlx_sg_dmamap
);
262 device_printf(sc
->mlx_dev
, "can't allocate s/g table\n");
265 bus_dmamap_load(sc
->mlx_sg_dmat
, sc
->mlx_sg_dmamap
, sc
->mlx_sgtable
, segsize
, mlx_dma_map_sg
, sc
, 0);
269 /********************************************************************************
270 * Initialise the controller and softc
273 mlx_attach(struct mlx_softc
*sc
)
275 struct mlx_enquiry_old
*meo
;
276 int rid
, error
, fwminor
, hscode
, hserror
, hsparam1
, hsparam2
, hsmsg
;
279 callout_init(&sc
->mlx_timeout
);
282 * Initialise per-controller queues.
284 TAILQ_INIT(&sc
->mlx_work
);
285 TAILQ_INIT(&sc
->mlx_freecmds
);
286 bioq_init(&sc
->mlx_bioq
);
289 * Select accessor methods based on controller interface type.
291 switch(sc
->mlx_iftype
) {
294 sc
->mlx_tryqueue
= mlx_v3_tryqueue
;
295 sc
->mlx_findcomplete
= mlx_v3_findcomplete
;
296 sc
->mlx_intaction
= mlx_v3_intaction
;
297 sc
->mlx_fw_handshake
= mlx_v3_fw_handshake
;
300 sc
->mlx_tryqueue
= mlx_v4_tryqueue
;
301 sc
->mlx_findcomplete
= mlx_v4_findcomplete
;
302 sc
->mlx_intaction
= mlx_v4_intaction
;
303 sc
->mlx_fw_handshake
= mlx_v4_fw_handshake
;
306 sc
->mlx_tryqueue
= mlx_v5_tryqueue
;
307 sc
->mlx_findcomplete
= mlx_v5_findcomplete
;
308 sc
->mlx_intaction
= mlx_v5_intaction
;
309 sc
->mlx_fw_handshake
= mlx_v5_fw_handshake
;
313 return(ENXIO
); /* should never happen */
316 /* disable interrupts before we start talking to the controller */
317 sc
->mlx_intaction(sc
, MLX_INTACTION_DISABLE
);
320 * Wait for the controller to come ready, handshake with the firmware if required.
321 * This is typically only necessary on platforms where the controller BIOS does not
326 while ((hscode
= sc
->mlx_fw_handshake(sc
, &hserror
, &hsparam1
, &hsparam2
)) != 0) {
327 /* report first time around... */
329 device_printf(sc
->mlx_dev
, "controller initialisation in progress...\n");
332 /* did we get a real message? */
334 hscode
= mlx_fw_message(sc
, hserror
, hsparam1
, hsparam2
);
335 /* fatal initialisation error? */
343 device_printf(sc
->mlx_dev
, "initialisation complete.\n");
346 * Allocate and connect our interrupt.
349 sc
->mlx_irq
= bus_alloc_resource(sc
->mlx_dev
, SYS_RES_IRQ
, &rid
, 0, ~0, 1, RF_SHAREABLE
| RF_ACTIVE
);
350 if (sc
->mlx_irq
== NULL
) {
351 device_printf(sc
->mlx_dev
, "can't allocate interrupt\n");
355 error
= bus_setup_intr(sc
->mlx_dev
, sc
->mlx_irq
,
357 &sc
->mlx_intr
, NULL
);
359 device_printf(sc
->mlx_dev
, "can't set up interrupt\n");
365 * Create DMA tag for mapping buffers into controller-addressable space.
367 error
= bus_dma_tag_create(sc
->mlx_parent_dmat
, /* parent */
368 1, 0, /* alignment, boundary */
369 BUS_SPACE_MAXADDR
, /* lowaddr */
370 BUS_SPACE_MAXADDR
, /* highaddr */
371 NULL
, NULL
, /* filter, filterarg */
372 MAXBSIZE
, MLX_NSEG
, /* maxsize, nsegments */
373 BUS_SPACE_MAXSIZE_32BIT
, /* maxsegsize */
375 &sc
->mlx_buffer_dmat
);
377 device_printf(sc
->mlx_dev
, "can't allocate buffer DMA tag\n");
383 * Create some initial scatter/gather mappings so we can run the probe commands.
385 error
= mlx_sglist_map(sc
);
387 device_printf(sc
->mlx_dev
, "can't make initial s/g list mapping\n");
393 * We don't (yet) know where the event log is up to.
395 sc
->mlx_currevent
= -1;
398 * Obtain controller feature information
400 if ((sc
->mlx_enq2
= mlx_enquire(sc
, MLX_CMD_ENQUIRY2
, sizeof(struct mlx_enquiry2
), NULL
)) == NULL
) {
401 device_printf(sc
->mlx_dev
, "ENQUIRY2 failed\n");
407 * Do quirk/feature related things.
409 fwminor
= (sc
->mlx_enq2
->me_firmware_id
>> 8) & 0xff;
410 switch(sc
->mlx_iftype
) {
412 /* These controllers don't report the firmware version in the ENQUIRY2 response */
413 if ((meo
= mlx_enquire(sc
, MLX_CMD_ENQUIRY_OLD
, sizeof(struct mlx_enquiry_old
), NULL
)) == NULL
) {
414 device_printf(sc
->mlx_dev
, "ENQUIRY_OLD failed\n");
418 sc
->mlx_enq2
->me_firmware_id
= ('0' << 24) | (0 << 16) | (meo
->me_fwminor
<< 8) | meo
->me_fwmajor
;
419 kfree(meo
, M_DEVBUF
);
421 /* XXX require 2.42 or better (PCI) or 2.14 or better (EISA) */
422 if (meo
->me_fwminor
< 42) {
423 device_printf(sc
->mlx_dev
, " *** WARNING *** This firmware revision is not recommended\n");
424 device_printf(sc
->mlx_dev
, " *** WARNING *** Use revision 2.42 or later\n");
428 /* XXX certify 3.52? */
430 device_printf(sc
->mlx_dev
, " *** WARNING *** This firmware revision is not recommended\n");
431 device_printf(sc
->mlx_dev
, " *** WARNING *** Use revision 3.51 or later\n");
435 /* XXX certify firmware versions? */
437 device_printf(sc
->mlx_dev
, " *** WARNING *** This firmware revision is not recommended\n");
438 device_printf(sc
->mlx_dev
, " *** WARNING *** Use revision 4.06 or later\n");
443 device_printf(sc
->mlx_dev
, " *** WARNING *** This firmware revision is not recommended\n");
444 device_printf(sc
->mlx_dev
, " *** WARNING *** Use revision 5.07 or later\n");
449 return(ENXIO
); /* should never happen */
453 * Create the final scatter/gather mappings now that we have characterised the controller.
455 error
= mlx_sglist_map(sc
);
457 device_printf(sc
->mlx_dev
, "can't make final s/g list mapping\n");
463 * No user-requested background operation is in progress.
465 sc
->mlx_background
= 0;
466 sc
->mlx_rebuildstat
.rs_code
= MLX_REBUILDSTAT_IDLE
;
469 * Create the control device.
471 dev_ops_add(&mlx_ops
, -1, device_get_unit(sc
->mlx_dev
));
472 make_dev(&mlx_ops
, device_get_unit(sc
->mlx_dev
),
473 UID_ROOT
, GID_OPERATOR
, S_IRUSR
| S_IWUSR
,
474 "mlx%d", device_get_unit(sc
->mlx_dev
));
477 * Start the timeout routine.
479 callout_reset(&sc
->mlx_timeout
, hz
, mlx_periodic
, sc
);
481 /* print a little information about the controller */
482 mlx_describe_controller(sc
);
487 /********************************************************************************
488 * Locate disk resources and attach children to them.
491 mlx_startup(struct mlx_softc
*sc
)
493 struct mlx_enq_sys_drive
*mes
;
494 struct mlx_sysdrive
*dr
;
500 * Scan all the system drives and attach children for those that
501 * don't currently have them.
503 mes
= mlx_enquire(sc
, MLX_CMD_ENQSYSDRIVE
, sizeof(*mes
) * MLX_MAXDRIVES
, NULL
);
505 device_printf(sc
->mlx_dev
, "error fetching drive status\n");
509 /* iterate over drives returned */
510 for (i
= 0, dr
= &sc
->mlx_sysdrive
[0];
511 (i
< MLX_MAXDRIVES
) && (mes
[i
].sd_size
!= 0xffffffff);
513 /* are we already attached to this drive? */
514 if (dr
->ms_disk
== 0) {
515 /* pick up drive information */
516 dr
->ms_size
= mes
[i
].sd_size
;
517 dr
->ms_raidlevel
= mes
[i
].sd_raidlevel
& 0xf;
518 dr
->ms_state
= mes
[i
].sd_state
;
520 /* generate geometry information */
521 if (sc
->mlx_geom
== MLX_GEOM_128_32
) {
524 dr
->ms_cylinders
= dr
->ms_size
/ (128 * 32);
525 } else { /* MLX_GEOM_255/63 */
528 dr
->ms_cylinders
= dr
->ms_size
/ (255 * 63);
530 dr
->ms_disk
= device_add_child(sc
->mlx_dev
, /*"mlxd"*/NULL
, -1);
531 if (dr
->ms_disk
== 0)
532 device_printf(sc
->mlx_dev
, "device_add_child failed\n");
533 device_set_ivars(dr
->ms_disk
, dr
);
536 kfree(mes
, M_DEVBUF
);
537 if ((error
= bus_generic_attach(sc
->mlx_dev
)) != 0)
538 device_printf(sc
->mlx_dev
, "bus_generic_attach returned %d", error
);
540 /* mark controller back up */
541 sc
->mlx_state
&= ~MLX_STATE_SHUTDOWN
;
543 /* enable interrupts */
544 sc
->mlx_intaction(sc
, MLX_INTACTION_ENABLE
);
547 /********************************************************************************
548 * Disconnect from the controller completely, in preparation for unload.
551 mlx_detach(device_t dev
)
553 struct mlx_softc
*sc
= device_get_softc(dev
);
554 struct mlxd_softc
*mlxd
;
561 if (sc
->mlx_state
& MLX_STATE_OPEN
)
564 for (i
= 0; i
< MLX_MAXDRIVES
; i
++) {
565 if (sc
->mlx_sysdrive
[i
].ms_disk
!= 0) {
566 mlxd
= device_get_softc(sc
->mlx_sysdrive
[i
].ms_disk
);
567 if (mlxd
->mlxd_flags
& MLXD_OPEN
) { /* drive is mounted, abort detach */
568 device_printf(sc
->mlx_sysdrive
[i
].ms_disk
, "still open, can't detach\n");
573 if ((error
= mlx_shutdown(dev
)))
584 /********************************************************************************
585 * Bring the controller down to a dormant state and detach all child devices.
587 * This function is called before detach, system shutdown, or before performing
588 * an operation which may add or delete system disks. (Call mlx_startup to
589 * resume normal operation.)
591 * Note that we can assume that the bioq on the controller is empty, as we won't
592 * allow shutdown if any device is open.
595 mlx_shutdown(device_t dev
)
597 struct mlx_softc
*sc
= device_get_softc(dev
);
605 sc
->mlx_state
|= MLX_STATE_SHUTDOWN
;
606 sc
->mlx_intaction(sc
, MLX_INTACTION_DISABLE
);
608 /* flush controller */
609 device_printf(sc
->mlx_dev
, "flushing cache...");
616 /* delete all our child devices */
617 for (i
= 0; i
< MLX_MAXDRIVES
; i
++) {
618 if (sc
->mlx_sysdrive
[i
].ms_disk
!= 0) {
619 if ((error
= device_delete_child(sc
->mlx_dev
, sc
->mlx_sysdrive
[i
].ms_disk
)) != 0)
621 sc
->mlx_sysdrive
[i
].ms_disk
= 0;
630 /********************************************************************************
631 * Bring the controller to a quiescent state, ready for system suspend.
634 mlx_suspend(device_t dev
)
636 struct mlx_softc
*sc
= device_get_softc(dev
);
641 sc
->mlx_state
|= MLX_STATE_SUSPEND
;
643 /* flush controller */
644 device_printf(sc
->mlx_dev
, "flushing cache...");
645 printf("%s\n", mlx_flush(sc
) ? "failed" : "done");
647 sc
->mlx_intaction(sc
, MLX_INTACTION_DISABLE
);
653 /********************************************************************************
654 * Bring the controller back to a state ready for operation.
657 mlx_resume(device_t dev
)
659 struct mlx_softc
*sc
= device_get_softc(dev
);
663 sc
->mlx_state
&= ~MLX_STATE_SUSPEND
;
664 sc
->mlx_intaction(sc
, MLX_INTACTION_ENABLE
);
669 /*******************************************************************************
670 * Take an interrupt, or be poked by other code to look for interrupt-worthy
676 struct mlx_softc
*sc
= (struct mlx_softc
*)arg
;
680 /* collect finished commands, queue anything waiting */
684 /*******************************************************************************
685 * Receive a buf structure from a child device and queue it on a particular
686 * disk resource, then poke the disk resource to start as much work as it can.
689 mlx_submit_bio(struct mlx_softc
*sc
, struct bio
*bio
)
694 bioq_insert_tail(&sc
->mlx_bioq
, bio
);
701 /********************************************************************************
702 * Accept an open operation on the control device.
705 mlx_open(struct dev_open_args
*ap
)
707 cdev_t dev
= ap
->a_head
.a_dev
;
708 int unit
= minor(dev
);
709 struct mlx_softc
*sc
= devclass_get_softc(mlx_devclass
, unit
);
711 sc
->mlx_state
|= MLX_STATE_OPEN
;
715 /********************************************************************************
716 * Accept the last close on the control device.
719 mlx_close(struct dev_close_args
*ap
)
721 cdev_t dev
= ap
->a_head
.a_dev
;
722 int unit
= minor(dev
);
723 struct mlx_softc
*sc
= devclass_get_softc(mlx_devclass
, unit
);
725 sc
->mlx_state
&= ~MLX_STATE_OPEN
;
729 /********************************************************************************
730 * Handle controller-specific control operations.
733 mlx_ioctl(struct dev_ioctl_args
*ap
)
735 cdev_t dev
= ap
->a_head
.a_dev
;
736 int unit
= minor(dev
);
737 struct mlx_softc
*sc
= devclass_get_softc(mlx_devclass
, unit
);
738 struct mlx_rebuild_request
*rb
= (struct mlx_rebuild_request
*)ap
->a_data
;
739 struct mlx_rebuild_status
*rs
= (struct mlx_rebuild_status
*)ap
->a_data
;
740 int *arg
= (int *)ap
->a_data
;
741 struct mlx_pause
*mp
;
742 struct mlx_sysdrive
*dr
;
743 struct mlxd_softc
*mlxd
;
748 * Enumerate connected system drives; returns the first system drive's
749 * unit number if *arg is -1, or the next unit after *arg if it's
750 * a valid unit on this controller.
753 /* search system drives */
754 for (i
= 0; i
< MLX_MAXDRIVES
; i
++) {
755 /* is this one attached? */
756 if (sc
->mlx_sysdrive
[i
].ms_disk
!= 0) {
757 /* looking for the next one we come across? */
759 *arg
= device_get_unit(sc
->mlx_sysdrive
[0].ms_disk
);
762 /* we want the one after this one */
763 if (*arg
== device_get_unit(sc
->mlx_sysdrive
[i
].ms_disk
))
770 * Scan the controller to see whether new drives have appeared.
772 case MLX_RESCAN_DRIVES
:
777 * Disconnect from the specified drive; it may be about to go
780 case MLX_DETACH_DRIVE
: /* detach one drive */
782 if (((dr
= mlx_findunit(sc
, *arg
)) == NULL
) ||
783 ((mlxd
= device_get_softc(dr
->ms_disk
)) == NULL
))
786 device_printf(dr
->ms_disk
, "detaching...");
788 if (mlxd
->mlxd_flags
& MLXD_OPEN
) {
793 /* flush controller */
800 if ((error
= device_delete_child(sc
->mlx_dev
, dr
->ms_disk
)) != 0)
813 * Pause one or more SCSI channels for a period of time, to assist
814 * in the process of hot-swapping devices.
816 * Note that at least the 3.51 firmware on the DAC960PL doesn't seem
819 case MLX_PAUSE_CHANNEL
: /* schedule a channel pause */
820 /* Does this command work on this firmware? */
821 if (!(sc
->mlx_feature
& MLX_FEAT_PAUSEWORKS
))
824 mp
= (struct mlx_pause
*)ap
->a_data
;
825 if ((mp
->mp_which
== MLX_PAUSE_CANCEL
) && (sc
->mlx_pause
.mp_when
!= 0)) {
826 /* cancel a pending pause operation */
827 sc
->mlx_pause
.mp_which
= 0;
829 /* fix for legal channels */
830 mp
->mp_which
&= ((1 << sc
->mlx_enq2
->me_actual_channels
) -1);
831 /* check time values */
832 if ((mp
->mp_when
< 0) || (mp
->mp_when
> 3600))
834 if ((mp
->mp_howlong
< 1) || (mp
->mp_howlong
> (0xf * 30)))
837 /* check for a pause currently running */
838 if ((sc
->mlx_pause
.mp_which
!= 0) && (sc
->mlx_pause
.mp_when
== 0))
841 /* looks ok, go with it */
842 sc
->mlx_pause
.mp_which
= mp
->mp_which
;
843 sc
->mlx_pause
.mp_when
= time_second
+ mp
->mp_when
;
844 sc
->mlx_pause
.mp_howlong
= sc
->mlx_pause
.mp_when
+ mp
->mp_howlong
;
849 * Accept a command passthrough-style.
852 return(mlx_user_command(sc
, (struct mlx_usercommand
*)ap
->a_data
));
855 * Start a rebuild on a given SCSI disk
857 case MLX_REBUILDASYNC
:
858 if (sc
->mlx_background
!= 0) {
859 rb
->rr_status
= 0x0106;
862 rb
->rr_status
= mlx_rebuild(sc
, rb
->rr_channel
, rb
->rr_target
);
863 switch (rb
->rr_status
) {
868 error
= ENOMEM
; /* couldn't set up the command */
887 sc
->mlx_background
= MLX_BACKGROUND_REBUILD
;
891 * Get the status of the current rebuild or consistency check.
893 case MLX_REBUILDSTAT
:
894 *rs
= sc
->mlx_rebuildstat
;
898 * Return the per-controller system drive number matching the
899 * disk device number in (arg), if it happens to belong to us.
901 case MLX_GET_SYSDRIVE
:
903 mlxd
= (struct mlxd_softc
*)devclass_get_softc(mlxd_devclass
, *arg
);
904 if ((mlxd
!= NULL
) && (mlxd
->mlxd_drive
>= sc
->mlx_sysdrive
) &&
905 (mlxd
->mlxd_drive
< (sc
->mlx_sysdrive
+ MLX_MAXDRIVES
))) {
907 *arg
= mlxd
->mlxd_drive
- sc
->mlx_sysdrive
;
916 /********************************************************************************
917 * Handle operations requested by a System Drive connected to this controller.
920 mlx_submit_ioctl(struct mlx_softc
*sc
, struct mlx_sysdrive
*drive
, u_long cmd
,
921 caddr_t addr
, int32_t flag
)
923 int *arg
= (int *)addr
;
928 * Return the current status of this drive.
931 *arg
= drive
->ms_state
;
935 * Start a background consistency check on this drive.
937 case MLXD_CHECKASYNC
: /* start a background consistency check */
938 if (sc
->mlx_background
!= 0) {
942 result
= mlx_check(sc
, drive
- &sc
->mlx_sysdrive
[0]);
948 error
= ENOMEM
; /* couldn't set up the command */
964 sc
->mlx_background
= MLX_BACKGROUND_CHECK
;
973 /********************************************************************************
974 ********************************************************************************
976 ********************************************************************************
977 ********************************************************************************/
979 /********************************************************************************
980 * Fire off commands to periodically check the status of connected drives.
983 mlx_periodic(void *data
)
985 struct mlx_softc
*sc
= (struct mlx_softc
*)data
;
992 if ((sc
->mlx_pause
.mp_which
!= 0) &&
993 (sc
->mlx_pause
.mp_when
> 0) &&
994 (time_second
>= sc
->mlx_pause
.mp_when
)){
996 mlx_pause_action(sc
); /* pause is running */
997 sc
->mlx_pause
.mp_when
= 0;
1001 * Bus pause still running?
1003 } else if ((sc
->mlx_pause
.mp_which
!= 0) &&
1004 (sc
->mlx_pause
.mp_when
== 0)) {
1006 /* time to stop bus pause? */
1007 if (time_second
>= sc
->mlx_pause
.mp_howlong
) {
1008 mlx_pause_action(sc
);
1009 sc
->mlx_pause
.mp_which
= 0; /* pause is complete */
1012 sysbeep((time_second
% 5) * 100 + 500, hz
/8);
1016 * Run normal periodic activities?
1018 } else if (time_second
> (sc
->mlx_lastpoll
+ 10)) {
1019 sc
->mlx_lastpoll
= time_second
;
1022 * Check controller status.
1024 * XXX Note that this may not actually launch a command in situations of high load.
1026 mlx_enquire(sc
, (sc
->mlx_iftype
== MLX_IFTYPE_2
) ? MLX_CMD_ENQUIRY_OLD
: MLX_CMD_ENQUIRY
,
1027 imax(sizeof(struct mlx_enquiry
), sizeof(struct mlx_enquiry_old
)), mlx_periodic_enquiry
);
1030 * Check system drive status.
1032 * XXX This might be better left to event-driven detection, eg. I/O to an offline
1033 * drive will detect it's offline, rebuilds etc. should detect the drive is back
1036 mlx_enquire(sc
, MLX_CMD_ENQSYSDRIVE
, sizeof(struct mlx_enq_sys_drive
) * MLX_MAXDRIVES
,
1037 mlx_periodic_enquiry
);
1041 /* get drive rebuild/check status */
1042 /* XXX should check sc->mlx_background if this is only valid while in progress */
1043 mlx_enquire(sc
, MLX_CMD_REBUILDSTAT
, sizeof(struct mlx_rebuild_stat
), mlx_periodic_rebuild
);
1045 /* deal with possibly-missed interrupts and timed-out commands */
1048 /* reschedule another poll next second or so */
1049 callout_reset(&sc
->mlx_timeout
, hz
, mlx_periodic
, sc
);
1052 /********************************************************************************
1053 * Handle the result of an ENQUIRY command instigated by periodic status polling.
1056 mlx_periodic_enquiry(struct mlx_command
*mc
)
1058 struct mlx_softc
*sc
= mc
->mc_sc
;
1062 /* Command completed OK? */
1063 if (mc
->mc_status
!= 0) {
1064 device_printf(sc
->mlx_dev
, "periodic enquiry failed - %s\n", mlx_diagnose_command(mc
));
1068 /* respond to command */
1069 switch(mc
->mc_mailbox
[0]) {
1071 * This is currently a bit fruitless, as we don't know how to extract the eventlog
1074 case MLX_CMD_ENQUIRY_OLD
:
1076 struct mlx_enquiry
*me
= (struct mlx_enquiry
*)mc
->mc_data
;
1077 struct mlx_enquiry_old
*meo
= (struct mlx_enquiry_old
*)mc
->mc_data
;
1080 /* convert data in-place to new format */
1081 for (i
= (sizeof(me
->me_dead
) / sizeof(me
->me_dead
[0])) - 1; i
>= 0; i
--) {
1082 me
->me_dead
[i
].dd_chan
= meo
->me_dead
[i
].dd_chan
;
1083 me
->me_dead
[i
].dd_targ
= meo
->me_dead
[i
].dd_targ
;
1085 me
->me_misc_flags
= 0;
1086 me
->me_rebuild_count
= meo
->me_rebuild_count
;
1087 me
->me_dead_count
= meo
->me_dead_count
;
1088 me
->me_critical_sd_count
= meo
->me_critical_sd_count
;
1089 me
->me_event_log_seq_num
= 0;
1090 me
->me_offline_sd_count
= meo
->me_offline_sd_count
;
1091 me
->me_max_commands
= meo
->me_max_commands
;
1092 me
->me_rebuild_flag
= meo
->me_rebuild_flag
;
1093 me
->me_fwmajor
= meo
->me_fwmajor
;
1094 me
->me_fwminor
= meo
->me_fwminor
;
1095 me
->me_status_flags
= meo
->me_status_flags
;
1096 me
->me_flash_age
= meo
->me_flash_age
;
1097 for (i
= (sizeof(me
->me_drvsize
) / sizeof(me
->me_drvsize
[0])) - 1; i
>= 0; i
--) {
1098 if (i
> ((sizeof(meo
->me_drvsize
) / sizeof(meo
->me_drvsize
[0])) - 1)) {
1099 me
->me_drvsize
[i
] = 0; /* drive beyond supported range */
1101 me
->me_drvsize
[i
] = meo
->me_drvsize
[i
];
1104 me
->me_num_sys_drvs
= meo
->me_num_sys_drvs
;
1109 * Generic controller status update. We could do more with this than just
1110 * checking the event log.
1112 case MLX_CMD_ENQUIRY
:
1114 struct mlx_enquiry
*me
= (struct mlx_enquiry
*)mc
->mc_data
;
1116 if (sc
->mlx_currevent
== -1) {
1117 /* initialise our view of the event log */
1118 sc
->mlx_currevent
= sc
->mlx_lastevent
= me
->me_event_log_seq_num
;
1119 } else if ((me
->me_event_log_seq_num
!= sc
->mlx_lastevent
) && !(sc
->mlx_flags
& MLX_EVENTLOG_BUSY
)) {
1120 /* record where current events are up to */
1121 sc
->mlx_currevent
= me
->me_event_log_seq_num
;
1122 debug(1, "event log pointer was %d, now %d\n", sc
->mlx_lastevent
, sc
->mlx_currevent
);
1124 /* mark the event log as busy */
1125 atomic_set_int(&sc
->mlx_flags
, MLX_EVENTLOG_BUSY
);
1127 /* drain new eventlog entries */
1128 mlx_periodic_eventlog_poll(sc
);
1132 case MLX_CMD_ENQSYSDRIVE
:
1134 struct mlx_enq_sys_drive
*mes
= (struct mlx_enq_sys_drive
*)mc
->mc_data
;
1135 struct mlx_sysdrive
*dr
;
1138 for (i
= 0, dr
= &sc
->mlx_sysdrive
[0];
1139 (i
< MLX_MAXDRIVES
) && (mes
[i
].sd_size
!= 0xffffffff);
1142 /* has state been changed by controller? */
1143 if (dr
->ms_state
!= mes
[i
].sd_state
) {
1144 switch(mes
[i
].sd_state
) {
1145 case MLX_SYSD_OFFLINE
:
1146 device_printf(dr
->ms_disk
, "drive offline\n");
1148 case MLX_SYSD_ONLINE
:
1149 device_printf(dr
->ms_disk
, "drive online\n");
1151 case MLX_SYSD_CRITICAL
:
1152 device_printf(dr
->ms_disk
, "drive critical\n");
1155 /* save new state */
1156 dr
->ms_state
= mes
[i
].sd_state
;
1162 device_printf(sc
->mlx_dev
, "%s: unknown command 0x%x", __func__
, mc
->mc_mailbox
[0]);
1167 kfree(mc
->mc_data
, M_DEVBUF
);
1171 /********************************************************************************
1172 * Instigate a poll for one event log message on (sc).
1173 * We only poll for one message at a time, to keep our command usage down.
1176 mlx_periodic_eventlog_poll(struct mlx_softc
*sc
)
1178 struct mlx_command
*mc
;
1179 void *result
= NULL
;
1184 /* get ourselves a command buffer */
1186 if ((mc
= mlx_alloccmd(sc
)) == NULL
)
1189 * allocate the response structure - sizeof(struct mlx_eventlog_entry)?
1190 * Called from timeout - use M_NOWAIT (repoll later on failure?)
1192 if ((result
= kmalloc(1024, M_DEVBUF
, M_NOWAIT
)) == NULL
)
1194 /* get a command slot */
1195 if (mlx_getslot(mc
))
1198 /* map the command so the controller can see it */
1199 mc
->mc_data
= result
;
1200 mc
->mc_length
= /*sizeof(struct mlx_eventlog_entry)*/1024;
1203 /* build the command to get one entry */
1204 mlx_make_type3(mc
, MLX_CMD_LOGOP
, MLX_LOGOP_GET
, 1, sc
->mlx_lastevent
, 0, 0, mc
->mc_dataphys
, 0);
1205 mc
->mc_complete
= mlx_periodic_eventlog_respond
;
1206 mc
->mc_private
= mc
;
1208 /* start the command */
1209 if ((error
= mlx_start(mc
)) != 0)
1212 error
= 0; /* success */
1218 kfree(result
, M_DEVBUF
);
1222 /********************************************************************************
1223 * Handle the result of polling for a log message, generate diagnostic output.
1224 * If this wasn't the last message waiting for us, we'll go collect another.
1226 static char *mlx_sense_messages
[] = {
1227 "because write recovery failed",
1228 "because of SCSI bus reset failure",
1229 "because of double check condition",
1230 "because it was removed",
1231 "because of gross error on SCSI chip",
1232 "because of bad tag returned from drive",
1233 "because of timeout on SCSI command",
1234 "because of reset SCSI command issued from system",
1235 "because busy or parity error count exceeded limit",
1236 "because of 'kill drive' command from system",
1237 "because of selection timeout",
1238 "due to SCSI phase sequence error",
1239 "due to unknown status"
1243 mlx_periodic_eventlog_respond(struct mlx_command
*mc
)
1245 struct mlx_softc
*sc
= mc
->mc_sc
;
1246 struct mlx_eventlog_entry
*el
= (struct mlx_eventlog_entry
*)mc
->mc_data
;
1251 sc
->mlx_lastevent
++; /* next message... */
1252 if (mc
->mc_status
== 0) {
1254 /* handle event log message */
1255 switch(el
->el_type
) {
1257 * This is the only sort of message we understand at the moment.
1258 * The tests here are probably incomplete.
1260 case MLX_LOGMSG_SENSE
: /* sense data */
1261 /* Mylex vendor-specific message indicating a drive was killed? */
1262 if ((el
->el_sensekey
== 9) &&
1263 (el
->el_asc
== 0x80)) {
1264 if (el
->el_asq
< (sizeof(mlx_sense_messages
) / sizeof(mlx_sense_messages
[0]))) {
1265 reason
= mlx_sense_messages
[el
->el_asq
];
1267 reason
= "for unknown reason";
1269 device_printf(sc
->mlx_dev
, "physical drive %d:%d killed %s\n",
1270 el
->el_channel
, el
->el_target
, reason
);
1272 /* SCSI drive was reset? */
1273 if ((el
->el_sensekey
== 6) && (el
->el_asc
== 0x29)) {
1274 device_printf(sc
->mlx_dev
, "physical drive %d:%d reset\n",
1275 el
->el_channel
, el
->el_target
);
1277 /* SCSI drive error? */
1278 if (!((el
->el_sensekey
== 0) ||
1279 ((el
->el_sensekey
== 2) &&
1280 (el
->el_asc
== 0x04) &&
1281 ((el
->el_asq
== 0x01) ||
1282 (el
->el_asq
== 0x02))))) {
1283 device_printf(sc
->mlx_dev
, "physical drive %d:%d error log: sense = %d asc = %x asq = %x\n",
1284 el
->el_channel
, el
->el_target
, el
->el_sensekey
, el
->el_asc
, el
->el_asq
);
1285 device_printf(sc
->mlx_dev
, " info %4D csi %4D\n", el
->el_information
, ":", el
->el_csi
, ":");
1290 device_printf(sc
->mlx_dev
, "unknown log message type 0x%x\n", el
->el_type
);
1294 device_printf(sc
->mlx_dev
, "error reading message log - %s\n", mlx_diagnose_command(mc
));
1295 /* give up on all the outstanding messages, as we may have come unsynched */
1296 sc
->mlx_lastevent
= sc
->mlx_currevent
;
1299 /* dispose of command and data */
1300 kfree(mc
->mc_data
, M_DEVBUF
);
1303 /* is there another message to obtain? */
1304 if (sc
->mlx_lastevent
!= sc
->mlx_currevent
) {
1305 mlx_periodic_eventlog_poll(sc
);
1307 /* clear log-busy status */
1308 atomic_clear_int(&sc
->mlx_flags
, MLX_EVENTLOG_BUSY
);
1312 /********************************************************************************
1313 * Handle check/rebuild operations in progress.
1316 mlx_periodic_rebuild(struct mlx_command
*mc
)
1318 struct mlx_softc
*sc
= mc
->mc_sc
;
1319 struct mlx_rebuild_status
*mr
= (struct mlx_rebuild_status
*)mc
->mc_data
;
1321 switch(mc
->mc_status
) {
1322 case 0: /* operation running, update stats */
1323 sc
->mlx_rebuildstat
= *mr
;
1325 /* spontaneous rebuild/check? */
1326 if (sc
->mlx_background
== 0) {
1327 sc
->mlx_background
= MLX_BACKGROUND_SPONTANEOUS
;
1328 device_printf(sc
->mlx_dev
, "background check/rebuild operation started\n");
1332 case 0x0105: /* nothing running, finalise stats and report */
1333 switch(sc
->mlx_background
) {
1334 case MLX_BACKGROUND_CHECK
:
1335 device_printf(sc
->mlx_dev
, "consistency check completed\n"); /* XXX print drive? */
1337 case MLX_BACKGROUND_REBUILD
:
1338 device_printf(sc
->mlx_dev
, "drive rebuild completed\n"); /* XXX print channel/target? */
1340 case MLX_BACKGROUND_SPONTANEOUS
:
1342 /* if we have previously been non-idle, report the transition */
1343 if (sc
->mlx_rebuildstat
.rs_code
!= MLX_REBUILDSTAT_IDLE
) {
1344 device_printf(sc
->mlx_dev
, "background check/rebuild operation completed\n");
1347 sc
->mlx_background
= 0;
1348 sc
->mlx_rebuildstat
.rs_code
= MLX_REBUILDSTAT_IDLE
;
1351 kfree(mc
->mc_data
, M_DEVBUF
);
1355 /********************************************************************************
1356 ********************************************************************************
1358 ********************************************************************************
1359 ********************************************************************************/
1361 /********************************************************************************
1362 * It's time to perform a channel pause action for (sc), either start or stop
1366 mlx_pause_action(struct mlx_softc
*sc
)
1368 struct mlx_command
*mc
;
1369 int failsafe
, i
, command
;
1371 /* What are we doing here? */
1372 if (sc
->mlx_pause
.mp_when
== 0) {
1373 command
= MLX_CMD_STARTCHANNEL
;
1377 command
= MLX_CMD_STOPCHANNEL
;
1380 * Channels will always start again after the failsafe period,
1381 * which is specified in multiples of 30 seconds.
1382 * This constrains us to a maximum pause of 450 seconds.
1384 failsafe
= ((sc
->mlx_pause
.mp_howlong
- time_second
) + 5) / 30;
1385 if (failsafe
> 0xf) {
1387 sc
->mlx_pause
.mp_howlong
= time_second
+ (0xf * 30) - 5;
1391 /* build commands for every channel requested */
1392 for (i
= 0; i
< sc
->mlx_enq2
->me_actual_channels
; i
++) {
1393 if ((1 << i
) & sc
->mlx_pause
.mp_which
) {
1395 /* get ourselves a command buffer */
1396 if ((mc
= mlx_alloccmd(sc
)) == NULL
)
1398 /* get a command slot */
1399 mc
->mc_flags
|= MLX_CMD_PRIORITY
;
1400 if (mlx_getslot(mc
))
1403 /* build the command */
1404 mlx_make_type2(mc
, command
, (failsafe
<< 4) | i
, 0, 0, 0, 0, 0, 0, 0);
1405 mc
->mc_complete
= mlx_pause_done
;
1406 mc
->mc_private
= sc
; /* XXX not needed */
1409 /* command submitted OK */
1413 device_printf(sc
->mlx_dev
, "%s failed for channel %d\n",
1414 command
== MLX_CMD_STOPCHANNEL
? "pause" : "resume", i
);
1422 mlx_pause_done(struct mlx_command
*mc
)
1424 struct mlx_softc
*sc
= mc
->mc_sc
;
1425 int command
= mc
->mc_mailbox
[0];
1426 int channel
= mc
->mc_mailbox
[2] & 0xf;
1428 if (mc
->mc_status
!= 0) {
1429 device_printf(sc
->mlx_dev
, "%s command failed - %s\n",
1430 command
== MLX_CMD_STOPCHANNEL
? "pause" : "resume", mlx_diagnose_command(mc
));
1431 } else if (command
== MLX_CMD_STOPCHANNEL
) {
1432 device_printf(sc
->mlx_dev
, "channel %d pausing for %ld seconds\n",
1433 channel
, (long)(sc
->mlx_pause
.mp_howlong
- time_second
));
1435 device_printf(sc
->mlx_dev
, "channel %d resuming\n", channel
);
1440 /********************************************************************************
1441 ********************************************************************************
1443 ********************************************************************************
1444 ********************************************************************************/
1446 /********************************************************************************
1447 * Perform an Enquiry command using a type-3 command buffer and a return a single
1448 * linear result buffer. If the completion function is specified, it will
1449 * be called with the completed command (and the result response will not be
1450 * valid until that point). Otherwise, the command will either be busy-waited
1451 * for (interrupts not enabled), or slept for.
1454 mlx_enquire(struct mlx_softc
*sc
, int command
, size_t bufsize
, void (* complete
)(struct mlx_command
*mc
))
1456 struct mlx_command
*mc
;
1462 /* get ourselves a command buffer */
1465 if ((mc
= mlx_alloccmd(sc
)) == NULL
)
1467 /* allocate the response structure */
1468 result
= kmalloc(bufsize
, M_DEVBUF
, M_INTWAIT
);
1469 /* get a command slot */
1470 mc
->mc_flags
|= MLX_CMD_PRIORITY
| MLX_CMD_DATAOUT
;
1471 if (mlx_getslot(mc
))
1474 /* map the command so the controller can see it */
1475 mc
->mc_data
= result
;
1476 mc
->mc_length
= bufsize
;
1479 /* build an enquiry command */
1480 mlx_make_type2(mc
, command
, 0, 0, 0, 0, 0, 0, mc
->mc_dataphys
, 0);
1482 /* do we want a completion callback? */
1483 if (complete
!= NULL
) {
1484 mc
->mc_complete
= complete
;
1485 mc
->mc_private
= mc
;
1486 if ((error
= mlx_start(mc
)) != 0)
1489 /* run the command in either polled or wait mode */
1490 if ((sc
->mlx_state
& MLX_STATE_INTEN
) ? mlx_wait_command(mc
) : mlx_poll_command(mc
))
1493 /* command completed OK? */
1494 if (mc
->mc_status
!= 0) {
1495 device_printf(sc
->mlx_dev
, "ENQUIRY failed - %s\n", mlx_diagnose_command(mc
));
1499 error
= 0; /* success */
1501 /* we got a command, but nobody else will free it */
1502 if ((complete
== NULL
) && (mc
!= NULL
))
1504 /* we got an error, and we allocated a result */
1505 if ((error
!= 0) && (result
!= NULL
)) {
1506 kfree(result
, M_DEVBUF
);
1513 /********************************************************************************
1514 * Perform a Flush command on the nominated controller.
1516 * May be called with interrupts enabled or disabled; will not return until
1517 * the flush operation completes or fails.
1520 mlx_flush(struct mlx_softc
*sc
)
1522 struct mlx_command
*mc
;
1527 /* get ourselves a command buffer */
1529 if ((mc
= mlx_alloccmd(sc
)) == NULL
)
1531 /* get a command slot */
1532 if (mlx_getslot(mc
))
1535 /* build a flush command */
1536 mlx_make_type2(mc
, MLX_CMD_FLUSH
, 0, 0, 0, 0, 0, 0, 0, 0);
1538 /* can't assume that interrupts are going to work here, so play it safe */
1539 if (mlx_poll_command(mc
))
1542 /* command completed OK? */
1543 if (mc
->mc_status
!= 0) {
1544 device_printf(sc
->mlx_dev
, "FLUSH failed - %s\n", mlx_diagnose_command(mc
));
1548 error
= 0; /* success */
1555 /********************************************************************************
1556 * Start a background consistency check on (drive).
1558 * May be called with interrupts enabled or disabled; will return as soon as the
1559 * operation has started or been refused.
1562 mlx_check(struct mlx_softc
*sc
, int drive
)
1564 struct mlx_command
*mc
;
1569 /* get ourselves a command buffer */
1571 if ((mc
= mlx_alloccmd(sc
)) == NULL
)
1573 /* get a command slot */
1574 if (mlx_getslot(mc
))
1577 /* build a checkasync command, set the "fix it" flag */
1578 mlx_make_type2(mc
, MLX_CMD_CHECKASYNC
, 0, 0, 0, 0, 0, drive
| 0x80, 0, 0);
1580 /* start the command and wait for it to be returned */
1581 if (mlx_wait_command(mc
))
1584 /* command completed OK? */
1585 if (mc
->mc_status
!= 0) {
1586 device_printf(sc
->mlx_dev
, "CHECK ASYNC failed - %s\n", mlx_diagnose_command(mc
));
1588 device_printf(sc
->mlx_sysdrive
[drive
].ms_disk
, "consistency check started");
1590 error
= mc
->mc_status
;
1598 /********************************************************************************
1599 * Start a background rebuild of the physical drive at (channel),(target).
1601 * May be called with interrupts enabled or disabled; will return as soon as the
1602 * operation has started or been refused.
1605 mlx_rebuild(struct mlx_softc
*sc
, int channel
, int target
)
1607 struct mlx_command
*mc
;
1612 /* get ourselves a command buffer */
1614 if ((mc
= mlx_alloccmd(sc
)) == NULL
)
1616 /* get a command slot */
1617 if (mlx_getslot(mc
))
1620 /* build a checkasync command, set the "fix it" flag */
1621 mlx_make_type2(mc
, MLX_CMD_REBUILDASYNC
, channel
, target
, 0, 0, 0, 0, 0, 0);
1623 /* start the command and wait for it to be returned */
1624 if (mlx_wait_command(mc
))
1627 /* command completed OK? */
1628 if (mc
->mc_status
!= 0) {
1629 device_printf(sc
->mlx_dev
, "REBUILD ASYNC failed - %s\n", mlx_diagnose_command(mc
));
1631 device_printf(sc
->mlx_dev
, "drive rebuild started for %d:%d\n", channel
, target
);
1633 error
= mc
->mc_status
;
1641 /********************************************************************************
1642 * Run the command (mc) and return when it completes.
1644 * Interrupts need to be enabled; returns nonzero on error.
1647 mlx_wait_command(struct mlx_command
*mc
)
1649 struct mlx_softc
*sc
= mc
->mc_sc
;
1654 mc
->mc_complete
= NULL
;
1655 mc
->mc_private
= mc
; /* wake us when you're done */
1656 if ((error
= mlx_start(mc
)) != 0)
1660 /* XXX better timeout? */
1661 while ((mc
->mc_status
== MLX_STATUS_BUSY
) && (count
< 30)) {
1662 tsleep(mc
->mc_private
, PCATCH
, "mlxwcmd", hz
);
1665 if (mc
->mc_status
!= 0) {
1666 device_printf(sc
->mlx_dev
, "command failed - %s\n", mlx_diagnose_command(mc
));
1673 /********************************************************************************
1674 * Start the command (mc) and busy-wait for it to complete.
1676 * Should only be used when interrupts can't be relied upon. Returns 0 on
1677 * success, nonzero on error.
1678 * Successfully completed commands are dequeued.
1681 mlx_poll_command(struct mlx_command
*mc
)
1683 struct mlx_softc
*sc
= mc
->mc_sc
;
1688 mc
->mc_complete
= NULL
;
1689 mc
->mc_private
= NULL
; /* we will poll for it */
1690 if ((error
= mlx_start(mc
)) != 0)
1695 /* poll for completion */
1696 mlx_done(mc
->mc_sc
);
1698 } while ((mc
->mc_status
== MLX_STATUS_BUSY
) && (count
++ < 15000000));
1699 if (mc
->mc_status
!= MLX_STATUS_BUSY
) {
1701 TAILQ_REMOVE(&sc
->mlx_work
, mc
, mc_link
);
1705 device_printf(sc
->mlx_dev
, "command failed - %s\n", mlx_diagnose_command(mc
));
1709 /********************************************************************************
1710 * Pull as much work off the softc's work queue as possible and give it to the
1711 * controller. Leave a couple of slots free for emergencies.
1713 * Must be called at splbio or in an equivalent fashion that prevents
1714 * reentry or activity on the bioq.
1717 mlx_startio(struct mlx_softc
*sc
)
1719 struct mlx_command
*mc
;
1720 struct mlxd_softc
*mlxd
;
1728 /* avoid reentrancy */
1729 if (mlx_lock_tas(sc
, MLX_LOCK_STARTING
))
1732 /* spin until something prevents us from doing any work */
1736 /* see if there's work to be done */
1737 if ((bio
= bioq_first(&sc
->mlx_bioq
)) == NULL
)
1740 if ((mc
= mlx_alloccmd(sc
)) == NULL
)
1742 /* get a slot for the command */
1743 if (mlx_getslot(mc
) != 0) {
1747 /* get the buf containing our work */
1748 bioq_remove(&sc
->mlx_bioq
, bio
);
1753 /* connect the buf to the command */
1754 mc
->mc_complete
= mlx_completeio
;
1755 mc
->mc_private
= bp
;
1756 mc
->mc_data
= bp
->b_data
;
1757 mc
->mc_length
= bp
->b_bcount
;
1758 if (bp
->b_cmd
== BUF_CMD_READ
) {
1759 mc
->mc_flags
|= MLX_CMD_DATAIN
;
1760 cmd
= MLX_CMD_READSG
;
1762 mc
->mc_flags
|= MLX_CMD_DATAOUT
;
1763 cmd
= MLX_CMD_WRITESG
;
1766 /* map the command so the controller can work with it */
1769 /* build a suitable I/O command (assumes 512-byte rounded transfers) */
1770 mlxd
= (struct mlxd_softc
*)bio
->bio_driver_info
;
1771 driveno
= mlxd
->mlxd_drive
- sc
->mlx_sysdrive
;
1772 blkcount
= (bp
->b_bcount
+ MLX_BLKSIZE
- 1) / MLX_BLKSIZE
;
1773 blkno
= bio
->bio_offset
/ MLX_BLKSIZE
;
1775 if ((blkno
+ blkcount
) > sc
->mlx_sysdrive
[driveno
].ms_size
)
1776 device_printf(sc
->mlx_dev
, "I/O beyond end of unit (%u,%d > %u)\n",
1777 blkno
, blkcount
, sc
->mlx_sysdrive
[driveno
].ms_size
);
1780 * Build the I/O command. Note that the SG list type bits are set to zero,
1781 * denoting the format of SG list that we are using.
1783 if (sc
->mlx_iftype
== MLX_IFTYPE_2
) {
1784 mlx_make_type1(mc
, (cmd
== MLX_CMD_WRITESG
) ? MLX_CMD_WRITESG_OLD
: MLX_CMD_READSG_OLD
,
1785 blkcount
& 0xff, /* xfer length low byte */
1786 blkno
, /* physical block number */
1787 driveno
, /* target drive number */
1788 mc
->mc_sgphys
, /* location of SG list */
1789 mc
->mc_nsgent
& 0x3f); /* size of SG list (top 3 bits clear) */
1791 mlx_make_type5(mc
, cmd
,
1792 blkcount
& 0xff, /* xfer length low byte */
1793 (driveno
<< 3) | ((blkcount
>> 8) & 0x07), /* target and length high 3 bits */
1794 blkno
, /* physical block number */
1795 mc
->mc_sgphys
, /* location of SG list */
1796 mc
->mc_nsgent
& 0x3f); /* size of SG list (top 3 bits clear) */
1799 /* try to give command to controller */
1800 if (mlx_start(mc
) != 0) {
1801 /* fail the command */
1802 mc
->mc_status
= MLX_STATUS_WEDGED
;
1808 mlx_lock_clr(sc
, MLX_LOCK_STARTING
);
1811 /********************************************************************************
1812 * Handle completion of an I/O command.
1815 mlx_completeio(struct mlx_command
*mc
)
1817 struct mlx_softc
*sc
= mc
->mc_sc
;
1818 struct bio
*bio
= (mlx_bio
*)mc
->mc_private
;
1819 struct mlxd_softc
*mlxd
= (struct mlxd_softc
*)bio
->bio_driver_info
;
1820 struct buf
*bp
= bio
->bio_buf
;
1822 if (mc
->mc_status
!= MLX_STATUS_OK
) { /* could be more verbose here? */
1824 bp
->b_flags
|= B_ERROR
;
1826 switch(mc
->mc_status
) {
1827 case MLX_STATUS_RDWROFFLINE
: /* system drive has gone offline */
1828 device_printf(mlxd
->mlxd_dev
, "drive offline\n");
1829 /* should signal this with a return code */
1830 mlxd
->mlxd_drive
->ms_state
= MLX_SYSD_OFFLINE
;
1833 default: /* other I/O error */
1834 device_printf(sc
->mlx_dev
, "I/O error - %s\n", mlx_diagnose_command(mc
));
1836 device_printf(sc
->mlx_dev
, " b_bcount %ld offset %lld\n",
1837 bp
->b_bcount
, bio
->bio_offset
);
1838 device_printf(sc
->mlx_dev
, " %13D\n", mc
->mc_mailbox
, " ");
1847 /********************************************************************************
1848 * Take a command from user-space and try to run it.
1850 * XXX Note that this can't perform very much in the way of error checking, and
1851 * as such, applications _must_ be considered trustworthy.
1852 * XXX Commands using S/G for data are not supported.
1855 mlx_user_command(struct mlx_softc
*sc
, struct mlx_usercommand
*mu
)
1857 struct mlx_command
*mc
;
1858 struct mlx_dcdb
*dcdb
;
1869 /* get ourselves a command and copy in from user space */
1870 if ((mc
= mlx_alloccmd(sc
)) == NULL
)
1872 bcopy(mu
->mu_command
, mc
->mc_mailbox
, sizeof(mc
->mc_mailbox
));
1873 debug(0, "got command buffer");
1875 /* if we need a buffer for data transfer, allocate one and copy in its initial contents */
1876 if (mu
->mu_datasize
> 0) {
1877 if (mu
->mu_datasize
> MAXPHYS
)
1879 if (((kbuf
= kmalloc(mu
->mu_datasize
, M_DEVBUF
, M_WAITOK
)) == NULL
) ||
1880 (error
= copyin(mu
->mu_buf
, kbuf
, mu
->mu_datasize
)))
1882 debug(0, "got kernel buffer");
1885 /* get a command slot */
1886 if (mlx_getslot(mc
))
1888 debug(0, "got a slot");
1890 /* map the command so the controller can see it */
1892 mc
->mc_length
= mu
->mu_datasize
;
1897 * If this is a passthrough SCSI command, the DCDB is packed at the
1898 * beginning of the data area. Fix up the DCDB to point to the correct physical
1899 * address and override any bufptr supplied by the caller since we know
1900 * what it's meant to be.
1902 if (mc
->mc_mailbox
[0] == MLX_CMD_DIRECT_CDB
) {
1903 dcdb
= (struct mlx_dcdb
*)kbuf
;
1904 dcdb
->dcdb_physaddr
= mc
->mc_dataphys
+ sizeof(*dcdb
);
1909 * If there's a data buffer, fix up the command's buffer pointer.
1911 if (mu
->mu_datasize
> 0) {
1913 /* range check the pointer to physical buffer address */
1914 if ((mu
->mu_bufptr
< 0) || (mu
->mu_bufptr
> (sizeof(mu
->mu_command
) - sizeof(u_int32_t
)))) {
1918 mc
->mc_mailbox
[mu
->mu_bufptr
] = mc
->mc_dataphys
& 0xff;
1919 mc
->mc_mailbox
[mu
->mu_bufptr
+ 1] = (mc
->mc_dataphys
>> 8) & 0xff;
1920 mc
->mc_mailbox
[mu
->mu_bufptr
+ 2] = (mc
->mc_dataphys
>> 16) & 0xff;
1921 mc
->mc_mailbox
[mu
->mu_bufptr
+ 3] = (mc
->mc_dataphys
>> 24) & 0xff;
1923 debug(0, "command fixup");
1925 /* submit the command and wait */
1926 if ((error
= mlx_wait_command(mc
)) != 0)
1929 /* copy out status and data */
1930 mu
->mu_status
= mc
->mc_status
;
1931 if ((mu
->mu_datasize
> 0) && ((error
= copyout(kbuf
, mu
->mu_buf
, mu
->mu_datasize
))))
1938 kfree(kbuf
, M_DEVBUF
);
1942 /********************************************************************************
1943 ********************************************************************************
1944 Command I/O to Controller
1945 ********************************************************************************
1946 ********************************************************************************/
1948 /********************************************************************************
1949 * Find a free command slot for (mc).
1951 * Don't hand out a slot to a normal-priority command unless there are at least
1952 * 4 slots free for priority commands.
1955 mlx_getslot(struct mlx_command
*mc
)
1957 struct mlx_softc
*sc
= mc
->mc_sc
;
1963 * Enforce slot-usage limit, if we have the required information.
1965 if (sc
->mlx_enq2
!= NULL
) {
1966 limit
= sc
->mlx_enq2
->me_max_commands
;
1970 if (sc
->mlx_busycmds
>= ((mc
->mc_flags
& MLX_CMD_PRIORITY
) ? limit
: limit
- 4))
1974 * Allocate an outstanding command slot
1976 * XXX linear search is slow
1979 for (slot
= 0; slot
< limit
; slot
++) {
1980 debug(2, "try slot %d", slot
);
1981 if (sc
->mlx_busycmd
[slot
] == NULL
)
1985 sc
->mlx_busycmd
[slot
] = mc
;
1994 debug(2, "got slot %d", slot
);
1999 /********************************************************************************
2000 * Map/unmap (mc)'s data in the controller's addressable space.
2003 mlx_setup_dmamap(void *arg
, bus_dma_segment_t
*segs
, int nsegments
, int error
)
2005 struct mlx_command
*mc
= (struct mlx_command
*)arg
;
2006 struct mlx_softc
*sc
= mc
->mc_sc
;
2007 struct mlx_sgentry
*sg
;
2012 /* XXX should be unnecessary */
2013 if (sc
->mlx_enq2
&& (nsegments
> sc
->mlx_enq2
->me_max_sg
))
2014 panic("MLX: too many s/g segments (%d, max %d)", nsegments
, sc
->mlx_enq2
->me_max_sg
);
2016 /* get base address of s/g table */
2017 sg
= sc
->mlx_sgtable
+ (mc
->mc_slot
* MLX_NSEG
);
2019 /* save s/g table information in command */
2020 mc
->mc_nsgent
= nsegments
;
2021 mc
->mc_sgphys
= sc
->mlx_sgbusaddr
+ (mc
->mc_slot
* MLX_NSEG
* sizeof(struct mlx_sgentry
));
2022 mc
->mc_dataphys
= segs
[0].ds_addr
;
2024 /* populate s/g table */
2025 for (i
= 0; i
< nsegments
; i
++, sg
++) {
2026 sg
->sg_addr
= segs
[i
].ds_addr
;
2027 sg
->sg_count
= segs
[i
].ds_len
;
2032 mlx_mapcmd(struct mlx_command
*mc
)
2034 struct mlx_softc
*sc
= mc
->mc_sc
;
2038 /* if the command involves data at all */
2039 if (mc
->mc_data
!= NULL
) {
2041 /* map the data buffer into bus space and build the s/g list */
2042 bus_dmamap_load(sc
->mlx_buffer_dmat
, mc
->mc_dmamap
, mc
->mc_data
, mc
->mc_length
,
2043 mlx_setup_dmamap
, mc
, 0);
2044 if (mc
->mc_flags
& MLX_CMD_DATAIN
)
2045 bus_dmamap_sync(sc
->mlx_buffer_dmat
, mc
->mc_dmamap
, BUS_DMASYNC_PREREAD
);
2046 if (mc
->mc_flags
& MLX_CMD_DATAOUT
)
2047 bus_dmamap_sync(sc
->mlx_buffer_dmat
, mc
->mc_dmamap
, BUS_DMASYNC_PREWRITE
);
2052 mlx_unmapcmd(struct mlx_command
*mc
)
2054 struct mlx_softc
*sc
= mc
->mc_sc
;
2058 /* if the command involved data at all */
2059 if (mc
->mc_data
!= NULL
) {
2061 if (mc
->mc_flags
& MLX_CMD_DATAIN
)
2062 bus_dmamap_sync(sc
->mlx_buffer_dmat
, mc
->mc_dmamap
, BUS_DMASYNC_POSTREAD
);
2063 if (mc
->mc_flags
& MLX_CMD_DATAOUT
)
2064 bus_dmamap_sync(sc
->mlx_buffer_dmat
, mc
->mc_dmamap
, BUS_DMASYNC_POSTWRITE
);
2066 bus_dmamap_unload(sc
->mlx_buffer_dmat
, mc
->mc_dmamap
);
2070 /********************************************************************************
2071 * Try to deliver (mc) to the controller.
2073 * Can be called at any interrupt level, with or without interrupts enabled.
2076 mlx_start(struct mlx_command
*mc
)
2078 struct mlx_softc
*sc
= mc
->mc_sc
;
2083 /* save the slot number as ident so we can handle this command when complete */
2084 mc
->mc_mailbox
[0x1] = mc
->mc_slot
;
2086 /* mark the command as currently being processed */
2087 mc
->mc_status
= MLX_STATUS_BUSY
;
2089 /* set a default 60-second timeout XXX tunable? XXX not currently used */
2090 mc
->mc_timeout
= time_second
+ 60;
2092 /* spin waiting for the mailbox */
2093 for (i
= 100000, done
= 0; (i
> 0) && !done
; i
--) {
2095 if (sc
->mlx_tryqueue(sc
, mc
)) {
2097 /* move command to work queue */
2098 TAILQ_INSERT_TAIL(&sc
->mlx_work
, mc
, mc_link
);
2100 crit_exit(); /* drop spl to allow completion interrupts */
2103 /* command is enqueued */
2108 * We couldn't get the controller to take the command. Revoke the slot
2109 * that the command was given and return it with a bad status.
2111 sc
->mlx_busycmd
[mc
->mc_slot
] = NULL
;
2112 device_printf(sc
->mlx_dev
, "controller wedged (not taking commands)\n");
2113 mc
->mc_status
= MLX_STATUS_WEDGED
;
2118 /********************************************************************************
2119 * Poll the controller (sc) for completed commands.
2120 * Update command status and free slots for reuse. If any slots were freed,
2121 * new commands may be posted.
2123 * Returns nonzero if one or more commands were completed.
2126 mlx_done(struct mlx_softc
*sc
)
2128 struct mlx_command
*mc
;
2137 /* loop collecting completed commands */
2140 /* poll for a completed command's identifier and status */
2141 if (sc
->mlx_findcomplete(sc
, &slot
, &status
)) {
2143 mc
= sc
->mlx_busycmd
[slot
]; /* find command */
2144 if (mc
!= NULL
) { /* paranoia */
2145 if (mc
->mc_status
== MLX_STATUS_BUSY
) {
2146 mc
->mc_status
= status
; /* save status */
2148 /* free slot for reuse */
2149 sc
->mlx_busycmd
[slot
] = NULL
;
2152 device_printf(sc
->mlx_dev
, "duplicate done event for slot %d\n", slot
);
2155 device_printf(sc
->mlx_dev
, "done event for nonbusy slot %d\n", slot
);
2163 /* if we've completed any commands, try posting some more */
2167 /* handle completion and timeouts */
2173 /********************************************************************************
2174 * Perform post-completion processing for commands on (sc).
2177 mlx_complete(struct mlx_softc
*sc
)
2179 struct mlx_command
*mc
, *nc
;
2184 /* avoid reentrancy XXX might want to signal and request a restart */
2185 if (mlx_lock_tas(sc
, MLX_LOCK_COMPLETING
))
2191 /* scan the list of busy/done commands */
2192 mc
= TAILQ_FIRST(&sc
->mlx_work
);
2193 while (mc
!= NULL
) {
2194 nc
= TAILQ_NEXT(mc
, mc_link
);
2196 /* Command has been completed in some fashion */
2197 if (mc
->mc_status
!= MLX_STATUS_BUSY
) {
2199 /* unmap the command's data buffer */
2202 * Does the command have a completion handler?
2204 if (mc
->mc_complete
!= NULL
) {
2205 /* remove from list and give to handler */
2206 TAILQ_REMOVE(&sc
->mlx_work
, mc
, mc_link
);
2207 mc
->mc_complete(mc
);
2210 * Is there a sleeper waiting on this command?
2212 } else if (mc
->mc_private
!= NULL
) { /* sleeping caller wants to know about it */
2214 /* remove from list and wake up sleeper */
2215 TAILQ_REMOVE(&sc
->mlx_work
, mc
, mc_link
);
2216 wakeup_one(mc
->mc_private
);
2219 * Leave the command for a caller that's polling for it.
2228 mlx_lock_clr(sc
, MLX_LOCK_COMPLETING
);
2231 /********************************************************************************
2232 ********************************************************************************
2233 Command Buffer Management
2234 ********************************************************************************
2235 ********************************************************************************/
2237 /********************************************************************************
2238 * Get a new command buffer.
2240 * This may return NULL in low-memory cases.
2242 * Note that using malloc() is expensive (the command buffer is << 1 page) but
2243 * necessary if we are to be a loadable module before the zone allocator is fixed.
2245 * If possible, we recycle a command buffer that's been used before.
2247 * XXX Note that command buffers are not cleaned out - it is the caller's
2248 * responsibility to ensure that all required fields are filled in before
2251 static struct mlx_command
*
2252 mlx_alloccmd(struct mlx_softc
*sc
)
2254 struct mlx_command
*mc
;
2260 if ((mc
= TAILQ_FIRST(&sc
->mlx_freecmds
)) != NULL
)
2261 TAILQ_REMOVE(&sc
->mlx_freecmds
, mc
, mc_link
);
2264 /* allocate a new command buffer? */
2266 mc
= kmalloc(sizeof(*mc
), M_DEVBUF
, M_INTWAIT
| M_ZERO
);
2268 error
= bus_dmamap_create(sc
->mlx_buffer_dmat
, 0, &mc
->mc_dmamap
);
2270 kfree(mc
, M_DEVBUF
);
2277 /********************************************************************************
2278 * Release a command buffer for recycling.
2280 * XXX It might be a good idea to limit the number of commands we save for reuse
2281 * if it's shown that this list bloats out massively.
2284 mlx_releasecmd(struct mlx_command
*mc
)
2289 TAILQ_INSERT_HEAD(&mc
->mc_sc
->mlx_freecmds
, mc
, mc_link
);
2293 /********************************************************************************
2294 * Permanently discard a command buffer.
2297 mlx_freecmd(struct mlx_command
*mc
)
2299 struct mlx_softc
*sc
= mc
->mc_sc
;
2302 bus_dmamap_destroy(sc
->mlx_buffer_dmat
, mc
->mc_dmamap
);
2303 kfree(mc
, M_DEVBUF
);
2307 /********************************************************************************
2308 ********************************************************************************
2309 Type 3 interface accessor methods
2310 ********************************************************************************
2311 ********************************************************************************/
2313 /********************************************************************************
2314 * Try to give (mc) to the controller. Returns 1 if successful, 0 on failure
2315 * (the controller is not ready to take a command).
2317 * Must be called at splbio or in a fashion that prevents reentry.
2320 mlx_v3_tryqueue(struct mlx_softc
*sc
, struct mlx_command
*mc
)
2326 /* ready for our command? */
2327 if (!(MLX_V3_GET_IDBR(sc
) & MLX_V3_IDB_FULL
)) {
2328 /* copy mailbox data to window */
2329 for (i
= 0; i
< 13; i
++)
2330 MLX_V3_PUT_MAILBOX(sc
, i
, mc
->mc_mailbox
[i
]);
2333 MLX_V3_PUT_IDBR(sc
, MLX_V3_IDB_FULL
);
2339 /********************************************************************************
2340 * See if a command has been completed, if so acknowledge its completion
2341 * and recover the slot number and status code.
2343 * Must be called at splbio or in a fashion that prevents reentry.
2346 mlx_v3_findcomplete(struct mlx_softc
*sc
, u_int8_t
*slot
, u_int16_t
*status
)
2351 /* status available? */
2352 if (MLX_V3_GET_ODBR(sc
) & MLX_V3_ODB_SAVAIL
) {
2353 *slot
= MLX_V3_GET_STATUS_IDENT(sc
); /* get command identifier */
2354 *status
= MLX_V3_GET_STATUS(sc
); /* get status */
2356 /* acknowledge completion */
2357 MLX_V3_PUT_ODBR(sc
, MLX_V3_ODB_SAVAIL
);
2358 MLX_V3_PUT_IDBR(sc
, MLX_V3_IDB_SACK
);
2364 /********************************************************************************
2365 * Enable/disable interrupts as requested. (No acknowledge required)
2367 * Must be called at splbio or in a fashion that prevents reentry.
2370 mlx_v3_intaction(struct mlx_softc
*sc
, int action
)
2375 case MLX_INTACTION_DISABLE
:
2376 MLX_V3_PUT_IER(sc
, 0);
2377 sc
->mlx_state
&= ~MLX_STATE_INTEN
;
2379 case MLX_INTACTION_ENABLE
:
2380 MLX_V3_PUT_IER(sc
, 1);
2381 sc
->mlx_state
|= MLX_STATE_INTEN
;
2386 /********************************************************************************
2387 * Poll for firmware error codes during controller initialisation.
2388 * Returns 0 if initialisation is complete, 1 if still in progress but no
2389 * error has been fetched, 2 if an error has been retrieved.
2392 mlx_v3_fw_handshake(struct mlx_softc
*sc
, int *error
, int *param1
, int *param2
)
2395 static int initted
= 0;
2399 /* first time around, clear any hardware completion status */
2401 MLX_V3_PUT_IDBR(sc
, MLX_V3_IDB_SACK
);
2406 /* init in progress? */
2407 if (!(MLX_V3_GET_IDBR(sc
) & MLX_V3_IDB_INIT_BUSY
))
2410 /* test error value */
2411 fwerror
= MLX_V3_GET_FWERROR(sc
);
2412 if (!(fwerror
& MLX_V3_FWERROR_PEND
))
2415 /* mask status pending bit, fetch status */
2416 *error
= fwerror
& ~MLX_V3_FWERROR_PEND
;
2417 *param1
= MLX_V3_GET_FWERROR_PARAM1(sc
);
2418 *param2
= MLX_V3_GET_FWERROR_PARAM2(sc
);
2421 MLX_V3_PUT_FWERROR(sc
, 0);
2426 /********************************************************************************
2427 ********************************************************************************
2428 Type 4 interface accessor methods
2429 ********************************************************************************
2430 ********************************************************************************/
2432 /********************************************************************************
2433 * Try to give (mc) to the controller. Returns 1 if successful, 0 on failure
2434 * (the controller is not ready to take a command).
2436 * Must be called at splbio or in a fashion that prevents reentry.
2439 mlx_v4_tryqueue(struct mlx_softc
*sc
, struct mlx_command
*mc
)
2445 /* ready for our command? */
2446 if (!(MLX_V4_GET_IDBR(sc
) & MLX_V4_IDB_FULL
)) {
2447 /* copy mailbox data to window */
2448 for (i
= 0; i
< 13; i
++)
2449 MLX_V4_PUT_MAILBOX(sc
, i
, mc
->mc_mailbox
[i
]);
2451 /* memory-mapped controller, so issue a write barrier to ensure the mailbox is filled */
2452 bus_space_barrier(sc
->mlx_btag
, sc
->mlx_bhandle
, MLX_V4_MAILBOX
, MLX_V4_MAILBOX_LENGTH
,
2453 BUS_SPACE_BARRIER_WRITE
);
2456 MLX_V4_PUT_IDBR(sc
, MLX_V4_IDB_HWMBOX_CMD
);
2462 /********************************************************************************
2463 * See if a command has been completed, if so acknowledge its completion
2464 * and recover the slot number and status code.
2466 * Must be called at splbio or in a fashion that prevents reentry.
2469 mlx_v4_findcomplete(struct mlx_softc
*sc
, u_int8_t
*slot
, u_int16_t
*status
)
2474 /* status available? */
2475 if (MLX_V4_GET_ODBR(sc
) & MLX_V4_ODB_HWSAVAIL
) {
2476 *slot
= MLX_V4_GET_STATUS_IDENT(sc
); /* get command identifier */
2477 *status
= MLX_V4_GET_STATUS(sc
); /* get status */
2479 /* acknowledge completion */
2480 MLX_V4_PUT_ODBR(sc
, MLX_V4_ODB_HWMBOX_ACK
);
2481 MLX_V4_PUT_IDBR(sc
, MLX_V4_IDB_SACK
);
2487 /********************************************************************************
2488 * Enable/disable interrupts as requested.
2490 * Must be called at splbio or in a fashion that prevents reentry.
2493 mlx_v4_intaction(struct mlx_softc
*sc
, int action
)
2498 case MLX_INTACTION_DISABLE
:
2499 MLX_V4_PUT_IER(sc
, MLX_V4_IER_MASK
| MLX_V4_IER_DISINT
);
2500 sc
->mlx_state
&= ~MLX_STATE_INTEN
;
2502 case MLX_INTACTION_ENABLE
:
2503 MLX_V4_PUT_IER(sc
, MLX_V4_IER_MASK
& ~MLX_V4_IER_DISINT
);
2504 sc
->mlx_state
|= MLX_STATE_INTEN
;
2509 /********************************************************************************
2510 * Poll for firmware error codes during controller initialisation.
2511 * Returns 0 if initialisation is complete, 1 if still in progress but no
2512 * error has been fetched, 2 if an error has been retrieved.
2515 mlx_v4_fw_handshake(struct mlx_softc
*sc
, int *error
, int *param1
, int *param2
)
2518 static int initted
= 0;
2522 /* first time around, clear any hardware completion status */
2524 MLX_V4_PUT_IDBR(sc
, MLX_V4_IDB_SACK
);
2529 /* init in progress? */
2530 if (!(MLX_V4_GET_IDBR(sc
) & MLX_V4_IDB_INIT_BUSY
))
2533 /* test error value */
2534 fwerror
= MLX_V4_GET_FWERROR(sc
);
2535 if (!(fwerror
& MLX_V4_FWERROR_PEND
))
2538 /* mask status pending bit, fetch status */
2539 *error
= fwerror
& ~MLX_V4_FWERROR_PEND
;
2540 *param1
= MLX_V4_GET_FWERROR_PARAM1(sc
);
2541 *param2
= MLX_V4_GET_FWERROR_PARAM2(sc
);
2544 MLX_V4_PUT_FWERROR(sc
, 0);
2549 /********************************************************************************
2550 ********************************************************************************
2551 Type 5 interface accessor methods
2552 ********************************************************************************
2553 ********************************************************************************/
2555 /********************************************************************************
2556 * Try to give (mc) to the controller. Returns 1 if successful, 0 on failure
2557 * (the controller is not ready to take a command).
2559 * Must be called at splbio or in a fashion that prevents reentry.
2562 mlx_v5_tryqueue(struct mlx_softc
*sc
, struct mlx_command
*mc
)
2568 /* ready for our command? */
2569 if (MLX_V5_GET_IDBR(sc
) & MLX_V5_IDB_EMPTY
) {
2570 /* copy mailbox data to window */
2571 for (i
= 0; i
< 13; i
++)
2572 MLX_V5_PUT_MAILBOX(sc
, i
, mc
->mc_mailbox
[i
]);
2575 MLX_V5_PUT_IDBR(sc
, MLX_V5_IDB_HWMBOX_CMD
);
2581 /********************************************************************************
2582 * See if a command has been completed, if so acknowledge its completion
2583 * and recover the slot number and status code.
2585 * Must be called at splbio or in a fashion that prevents reentry.
2588 mlx_v5_findcomplete(struct mlx_softc
*sc
, u_int8_t
*slot
, u_int16_t
*status
)
2593 /* status available? */
2594 if (MLX_V5_GET_ODBR(sc
) & MLX_V5_ODB_HWSAVAIL
) {
2595 *slot
= MLX_V5_GET_STATUS_IDENT(sc
); /* get command identifier */
2596 *status
= MLX_V5_GET_STATUS(sc
); /* get status */
2598 /* acknowledge completion */
2599 MLX_V5_PUT_ODBR(sc
, MLX_V5_ODB_HWMBOX_ACK
);
2600 MLX_V5_PUT_IDBR(sc
, MLX_V5_IDB_SACK
);
2606 /********************************************************************************
2607 * Enable/disable interrupts as requested.
2609 * Must be called at splbio or in a fashion that prevents reentry.
2612 mlx_v5_intaction(struct mlx_softc
*sc
, int action
)
2617 case MLX_INTACTION_DISABLE
:
2618 MLX_V5_PUT_IER(sc
, 0xff & MLX_V5_IER_DISINT
);
2619 sc
->mlx_state
&= ~MLX_STATE_INTEN
;
2621 case MLX_INTACTION_ENABLE
:
2622 MLX_V5_PUT_IER(sc
, 0xff & ~MLX_V5_IER_DISINT
);
2623 sc
->mlx_state
|= MLX_STATE_INTEN
;
2628 /********************************************************************************
2629 * Poll for firmware error codes during controller initialisation.
2630 * Returns 0 if initialisation is complete, 1 if still in progress but no
2631 * error has been fetched, 2 if an error has been retrieved.
2634 mlx_v5_fw_handshake(struct mlx_softc
*sc
, int *error
, int *param1
, int *param2
)
2637 static int initted
= 0;
2641 /* first time around, clear any hardware completion status */
2643 MLX_V5_PUT_IDBR(sc
, MLX_V5_IDB_SACK
);
2648 /* init in progress? */
2649 if (MLX_V5_GET_IDBR(sc
) & MLX_V5_IDB_INIT_DONE
)
2652 /* test for error value */
2653 fwerror
= MLX_V5_GET_FWERROR(sc
);
2654 if (!(fwerror
& MLX_V5_FWERROR_PEND
))
2657 /* mask status pending bit, fetch status */
2658 *error
= fwerror
& ~MLX_V5_FWERROR_PEND
;
2659 *param1
= MLX_V5_GET_FWERROR_PARAM1(sc
);
2660 *param2
= MLX_V5_GET_FWERROR_PARAM2(sc
);
2663 MLX_V5_PUT_FWERROR(sc
, 0xff);
2668 /********************************************************************************
2669 ********************************************************************************
2671 ********************************************************************************
2672 ********************************************************************************/
2674 /********************************************************************************
2675 * Return a status message describing (mc)
2677 static char *mlx_status_messages
[] = {
2678 "normal completion", /* 00 */
2679 "irrecoverable data error", /* 01 */
2680 "drive does not exist, or is offline", /* 02 */
2681 "attempt to write beyond end of drive", /* 03 */
2682 "bad data encountered", /* 04 */
2683 "invalid log entry request", /* 05 */
2684 "attempt to rebuild online drive", /* 06 */
2685 "new disk failed during rebuild", /* 07 */
2686 "invalid channel/target", /* 08 */
2687 "rebuild/check already in progress", /* 09 */
2688 "one or more disks are dead", /* 10 */
2689 "invalid or non-redundant drive", /* 11 */
2690 "channel is busy", /* 12 */
2691 "channel is not stopped", /* 13 */
2692 "rebuild successfully terminated", /* 14 */
2693 "unsupported command", /* 15 */
2694 "check condition received", /* 16 */
2695 "device is busy", /* 17 */
2696 "selection or command timeout", /* 18 */
2697 "command terminated abnormally", /* 19 */
2706 } mlx_messages
[] = {
2707 {MLX_CMD_READSG
, 0x0001, 1},
2708 {MLX_CMD_READSG
, 0x0002, 1},
2709 {MLX_CMD_READSG
, 0x0105, 3},
2710 {MLX_CMD_READSG
, 0x010c, 4},
2711 {MLX_CMD_WRITESG
, 0x0001, 1},
2712 {MLX_CMD_WRITESG
, 0x0002, 1},
2713 {MLX_CMD_WRITESG
, 0x0105, 3},
2714 {MLX_CMD_READSG_OLD
, 0x0001, 1},
2715 {MLX_CMD_READSG_OLD
, 0x0002, 1},
2716 {MLX_CMD_READSG_OLD
, 0x0105, 3},
2717 {MLX_CMD_WRITESG_OLD
, 0x0001, 1},
2718 {MLX_CMD_WRITESG_OLD
, 0x0002, 1},
2719 {MLX_CMD_WRITESG_OLD
, 0x0105, 3},
2720 {MLX_CMD_LOGOP
, 0x0105, 5},
2721 {MLX_CMD_REBUILDASYNC
, 0x0002, 6},
2722 {MLX_CMD_REBUILDASYNC
, 0x0004, 7},
2723 {MLX_CMD_REBUILDASYNC
, 0x0105, 8},
2724 {MLX_CMD_REBUILDASYNC
, 0x0106, 9},
2725 {MLX_CMD_REBUILDASYNC
, 0x0107, 14},
2726 {MLX_CMD_CHECKASYNC
, 0x0002, 10},
2727 {MLX_CMD_CHECKASYNC
, 0x0105, 11},
2728 {MLX_CMD_CHECKASYNC
, 0x0106, 9},
2729 {MLX_CMD_STOPCHANNEL
, 0x0106, 12},
2730 {MLX_CMD_STOPCHANNEL
, 0x0105, 8},
2731 {MLX_CMD_STARTCHANNEL
, 0x0005, 13},
2732 {MLX_CMD_STARTCHANNEL
, 0x0105, 8},
2733 {MLX_CMD_DIRECT_CDB
, 0x0002, 16},
2734 {MLX_CMD_DIRECT_CDB
, 0x0008, 17},
2735 {MLX_CMD_DIRECT_CDB
, 0x000e, 18},
2736 {MLX_CMD_DIRECT_CDB
, 0x000f, 19},
2737 {MLX_CMD_DIRECT_CDB
, 0x0105, 8},
2744 mlx_diagnose_command(struct mlx_command
*mc
)
2746 static char unkmsg
[80];
2749 /* look up message in table */
2750 for (i
= 0; mlx_messages
[i
].command
!= -1; i
++)
2751 if (((mc
->mc_mailbox
[0] == mlx_messages
[i
].command
) || (mlx_messages
[i
].command
== 0)) &&
2752 (mc
->mc_status
== mlx_messages
[i
].status
))
2753 return(mlx_status_messages
[mlx_messages
[i
].msg
]);
2755 ksprintf(unkmsg
, "unknown response 0x%x for command 0x%x", (int)mc
->mc_status
, (int)mc
->mc_mailbox
[0]);
2759 /*******************************************************************************
2760 * Print a string describing the controller (sc)
2766 } mlx_controller_names
[] = {
2781 mlx_describe_controller(struct mlx_softc
*sc
)
2783 static char buf
[80];
2787 for (i
= 0, model
= NULL
; mlx_controller_names
[i
].name
!= NULL
; i
++) {
2788 if ((sc
->mlx_enq2
->me_hardware_id
& 0xff) == mlx_controller_names
[i
].hwid
) {
2789 model
= mlx_controller_names
[i
].name
;
2793 if (model
== NULL
) {
2794 ksprintf(buf
, " model 0x%x", sc
->mlx_enq2
->me_hardware_id
& 0xff);
2797 device_printf(sc
->mlx_dev
, "DAC%s, %d channel%s, firmware %d.%02d-%c-%02d, %dMB RAM\n",
2799 sc
->mlx_enq2
->me_actual_channels
,
2800 sc
->mlx_enq2
->me_actual_channels
> 1 ? "s" : "",
2801 sc
->mlx_enq2
->me_firmware_id
& 0xff,
2802 (sc
->mlx_enq2
->me_firmware_id
>> 8) & 0xff,
2803 (sc
->mlx_enq2
->me_firmware_id
>> 24) & 0xff,
2804 (sc
->mlx_enq2
->me_firmware_id
>> 16) & 0xff,
2805 sc
->mlx_enq2
->me_mem_size
/ (1024 * 1024));
2808 device_printf(sc
->mlx_dev
, " Hardware ID 0x%08x\n", sc
->mlx_enq2
->me_hardware_id
);
2809 device_printf(sc
->mlx_dev
, " Firmware ID 0x%08x\n", sc
->mlx_enq2
->me_firmware_id
);
2810 device_printf(sc
->mlx_dev
, " Configured/Actual channels %d/%d\n", sc
->mlx_enq2
->me_configured_channels
,
2811 sc
->mlx_enq2
->me_actual_channels
);
2812 device_printf(sc
->mlx_dev
, " Max Targets %d\n", sc
->mlx_enq2
->me_max_targets
);
2813 device_printf(sc
->mlx_dev
, " Max Tags %d\n", sc
->mlx_enq2
->me_max_tags
);
2814 device_printf(sc
->mlx_dev
, " Max System Drives %d\n", sc
->mlx_enq2
->me_max_sys_drives
);
2815 device_printf(sc
->mlx_dev
, " Max Arms %d\n", sc
->mlx_enq2
->me_max_arms
);
2816 device_printf(sc
->mlx_dev
, " Max Spans %d\n", sc
->mlx_enq2
->me_max_spans
);
2817 device_printf(sc
->mlx_dev
, " DRAM/cache/flash/NVRAM size %d/%d/%d/%d\n", sc
->mlx_enq2
->me_mem_size
,
2818 sc
->mlx_enq2
->me_cache_size
, sc
->mlx_enq2
->me_flash_size
, sc
->mlx_enq2
->me_nvram_size
);
2819 device_printf(sc
->mlx_dev
, " DRAM type %d\n", sc
->mlx_enq2
->me_mem_type
);
2820 device_printf(sc
->mlx_dev
, " Clock Speed %dns\n", sc
->mlx_enq2
->me_clock_speed
);
2821 device_printf(sc
->mlx_dev
, " Hardware Speed %dns\n", sc
->mlx_enq2
->me_hardware_speed
);
2822 device_printf(sc
->mlx_dev
, " Max Commands %d\n", sc
->mlx_enq2
->me_max_commands
);
2823 device_printf(sc
->mlx_dev
, " Max SG Entries %d\n", sc
->mlx_enq2
->me_max_sg
);
2824 device_printf(sc
->mlx_dev
, " Max DP %d\n", sc
->mlx_enq2
->me_max_dp
);
2825 device_printf(sc
->mlx_dev
, " Max IOD %d\n", sc
->mlx_enq2
->me_max_iod
);
2826 device_printf(sc
->mlx_dev
, " Max Comb %d\n", sc
->mlx_enq2
->me_max_comb
);
2827 device_printf(sc
->mlx_dev
, " Latency %ds\n", sc
->mlx_enq2
->me_latency
);
2828 device_printf(sc
->mlx_dev
, " SCSI Timeout %ds\n", sc
->mlx_enq2
->me_scsi_timeout
);
2829 device_printf(sc
->mlx_dev
, " Min Free Lines %d\n", sc
->mlx_enq2
->me_min_freelines
);
2830 device_printf(sc
->mlx_dev
, " Rate Constant %d\n", sc
->mlx_enq2
->me_rate_const
);
2831 device_printf(sc
->mlx_dev
, " MAXBLK %d\n", sc
->mlx_enq2
->me_maxblk
);
2832 device_printf(sc
->mlx_dev
, " Blocking Factor %d sectors\n", sc
->mlx_enq2
->me_blocking_factor
);
2833 device_printf(sc
->mlx_dev
, " Cache Line Size %d blocks\n", sc
->mlx_enq2
->me_cacheline
);
2834 device_printf(sc
->mlx_dev
, " SCSI Capability %s%dMHz, %d bit\n",
2835 sc
->mlx_enq2
->me_scsi_cap
& (1<<4) ? "differential " : "",
2836 (1 << ((sc
->mlx_enq2
->me_scsi_cap
>> 2) & 3)) * 10,
2837 8 << (sc
->mlx_enq2
->me_scsi_cap
& 0x3));
2838 device_printf(sc
->mlx_dev
, " Firmware Build Number %d\n", sc
->mlx_enq2
->me_firmware_build
);
2839 device_printf(sc
->mlx_dev
, " Fault Management Type %d\n", sc
->mlx_enq2
->me_fault_mgmt_type
);
2840 device_printf(sc
->mlx_dev
, " Features %b\n", sc
->mlx_enq2
->me_firmware_features
,
2841 "\20\4Background Init\3Read Ahead\2MORE\1Cluster\n");
2846 /*******************************************************************************
2847 * Emit a string describing the firmware handshake status code, and return a flag
2848 * indicating whether the code represents a fatal error.
2850 * Error code interpretations are from the Linux driver, and don't directly match
2851 * the messages printed by Mylex's BIOS. This may change if documentation on the
2852 * codes is forthcoming.
2855 mlx_fw_message(struct mlx_softc
*sc
, int error
, int param1
, int param2
)
2859 device_printf(sc
->mlx_dev
, "physical drive %d:%d not responding\n", param2
, param1
);
2862 /* we could be neater about this and give some indication when we receive more of them */
2863 if (!(sc
->mlx_flags
& MLX_SPINUP_REPORTED
)) {
2864 device_printf(sc
->mlx_dev
, "spinning up drives...\n");
2865 sc
->mlx_flags
|= MLX_SPINUP_REPORTED
;
2869 device_printf(sc
->mlx_dev
, "configuration checksum error\n");
2872 device_printf(sc
->mlx_dev
, "mirror race recovery failed\n");
2875 device_printf(sc
->mlx_dev
, "mirror race recovery in progress\n");
2878 device_printf(sc
->mlx_dev
, "physical drive %d:%d COD mismatch\n", param2
, param1
);
2881 device_printf(sc
->mlx_dev
, "logical drive installation aborted\n");
2884 device_printf(sc
->mlx_dev
, "mirror race on a critical system drive\n");
2887 device_printf(sc
->mlx_dev
, "new controller configuration found\n");
2890 device_printf(sc
->mlx_dev
, "FATAL MEMORY PARITY ERROR\n");
2893 device_printf(sc
->mlx_dev
, "unknown firmware initialisation error %02x:%02x:%02x\n", error
, param1
, param2
);
2899 /********************************************************************************
2900 ********************************************************************************
2902 ********************************************************************************
2903 ********************************************************************************/
2905 /********************************************************************************
2906 * Find the disk whose unit number is (unit) on this controller
2908 static struct mlx_sysdrive
*
2909 mlx_findunit(struct mlx_softc
*sc
, int unit
)
2913 /* search system drives */
2914 for (i
= 0; i
< MLX_MAXDRIVES
; i
++) {
2915 /* is this one attached? */
2916 if (sc
->mlx_sysdrive
[i
].ms_disk
!= 0) {
2917 /* is this the one? */
2918 if (unit
== device_get_unit(sc
->mlx_sysdrive
[i
].ms_disk
))
2919 return(&sc
->mlx_sysdrive
[i
]);