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