mly.c revision 315813
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/10/sys/dev/mly/mly.c 315813 2017-03-23 06:41:13Z 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 60static int mly_probe(device_t dev); 61static int mly_attach(device_t dev); 62static int mly_pci_attach(struct mly_softc *sc); 63static int mly_detach(device_t dev); 64static int mly_shutdown(device_t dev); 65static void mly_intr(void *arg); 66 67static int mly_sg_map(struct mly_softc *sc); 68static void mly_sg_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error); 69static int mly_mmbox_map(struct mly_softc *sc); 70static void mly_mmbox_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error); 71static void mly_free(struct mly_softc *sc); 72 73static int mly_get_controllerinfo(struct mly_softc *sc); 74static void mly_scan_devices(struct mly_softc *sc); 75static void mly_rescan_btl(struct mly_softc *sc, int bus, int target); 76static void mly_complete_rescan(struct mly_command *mc); 77static int mly_get_eventstatus(struct mly_softc *sc); 78static int mly_enable_mmbox(struct mly_softc *sc); 79static int mly_flush(struct mly_softc *sc); 80static 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); 82static void mly_check_event(struct mly_softc *sc); 83static void mly_fetch_event(struct mly_softc *sc); 84static void mly_complete_event(struct mly_command *mc); 85static void mly_process_event(struct mly_softc *sc, struct mly_event *me); 86static void mly_periodic(void *data); 87 88static int mly_immediate_command(struct mly_command *mc); 89static int mly_start(struct mly_command *mc); 90static void mly_done(struct mly_softc *sc); 91static void mly_complete(void *context, int pending); 92 93static int mly_alloc_command(struct mly_softc *sc, struct mly_command **mcp); 94static void mly_release_command(struct mly_command *mc); 95static void mly_alloc_commands_map(void *arg, bus_dma_segment_t *segs, int nseg, int error); 96static int mly_alloc_commands(struct mly_softc *sc); 97static void mly_release_commands(struct mly_softc *sc); 98static void mly_map_command(struct mly_command *mc); 99static void mly_unmap_command(struct mly_command *mc); 100 101static int mly_cam_attach(struct mly_softc *sc); 102static void mly_cam_detach(struct mly_softc *sc); 103static void mly_cam_rescan_btl(struct mly_softc *sc, int bus, int target); 104static void mly_cam_action(struct cam_sim *sim, union ccb *ccb); 105static int mly_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio); 106static void mly_cam_poll(struct cam_sim *sim); 107static void mly_cam_complete(struct mly_command *mc); 108static struct cam_periph *mly_find_periph(struct mly_softc *sc, int bus, int target); 109static int mly_name_device(struct mly_softc *sc, int bus, int target); 110 111static int mly_fwhandshake(struct mly_softc *sc); 112 113static void mly_describe_controller(struct mly_softc *sc); 114#ifdef MLY_DEBUG 115static void mly_printstate(struct mly_softc *sc); 116static void mly_print_command(struct mly_command *mc); 117static void mly_print_packet(struct mly_command *mc); 118static void mly_panic(struct mly_softc *sc, char *reason); 119static int mly_timeout(struct mly_softc *sc); 120#endif 121void mly_print_controller(int controller); 122 123 124static d_open_t mly_user_open; 125static d_close_t mly_user_close; 126static d_ioctl_t mly_user_ioctl; 127static int mly_user_command(struct mly_softc *sc, struct mly_user_command *uc); 128static int mly_user_health(struct mly_softc *sc, struct mly_user_health *uh); 129 130#define MLY_CMD_TIMEOUT 20 131 132static 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 141static driver_t mly_pci_driver = { 142 "mly", 143 mly_methods, 144 sizeof(struct mly_softc) 145}; 146 147static devclass_t mly_devclass; 148DRIVER_MODULE(mly, pci, mly_pci_driver, mly_devclass, 0, 0); 149MODULE_DEPEND(mly, pci, 1, 1, 1); 150MODULE_DEPEND(mly, cam, 1, 1, 1); 151 152static 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 167static 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 */ 187static int 188mly_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 */ 210static int 211mly_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 */ 332static int 333mly_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 482fail: 483 return(error); 484} 485 486/******************************************************************************** 487 * Shut the controller down and detach all our resources. 488 */ 489static int 490mly_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 */ 510static int 511mly_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 */ 536static void 537mly_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 */ 555static int 556mly_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 */ 602static void 603mly_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 */ 616static int 617mly_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 */ 657static void 658mly_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 */ 672static void 673mly_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 */ 739static int 740mly_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 */ 781static void 782mly_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 */ 811static void 812mly_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 */ 871static void 872mly_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 */ 970static int 971mly_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 */ 1005static int 1006mly_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 */ 1049static int 1050mly_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 */ 1082static int 1083mly_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 1143out: 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 */ 1156static void 1157mly_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 */ 1185static void 1186mly_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 */ 1256static void 1257mly_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 */ 1282static void 1283mly_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 case 's': /* report of sense data */ 1342 if (((ssd->flags & SSD_KEY) == SSD_KEY_NO_SENSE) || 1343 (((ssd->flags & SSD_KEY) == SSD_KEY_NOT_READY) && 1344 (ssd->add_sense_code == 0x04) && 1345 ((ssd->add_sense_code_qual == 0x01) || (ssd->add_sense_code_qual == 0x02)))) 1346 break; /* ignore NO_SENSE or NOT_READY in one case */ 1347 1348 mly_printf(sc, "physical device %d:%d %s\n", me->channel, me->target, tp); 1349 mly_printf(sc, " sense key %d asc %02x ascq %02x\n", 1350 ssd->flags & SSD_KEY, ssd->add_sense_code, ssd->add_sense_code_qual); 1351 mly_printf(sc, " info %4D csi %4D\n", ssd->info, "", ssd->cmd_spec_info, ""); 1352 if (action == 'r') 1353 sc->mly_btl[me->channel][me->target].mb_flags |= MLY_BTL_RESCAN; 1354 break; 1355 case 'e': 1356 mly_printf(sc, tp, me->target, me->lun); 1357 printf("\n"); 1358 break; 1359 case 'c': 1360 mly_printf(sc, "controller %s\n", tp); 1361 break; 1362 case '?': 1363 mly_printf(sc, "%s - %d\n", tp, me->code); 1364 break; 1365 default: /* probably a 'noisy' event being ignored */ 1366 break; 1367 } 1368} 1369 1370/******************************************************************************** 1371 * Perform periodic activities. 1372 */ 1373static void 1374mly_periodic(void *data) 1375{ 1376 struct mly_softc *sc = (struct mly_softc *)data; 1377 int bus, target; 1378 1379 debug_called(2); 1380 1381 /* 1382 * Scan devices. 1383 */ 1384 for (bus = 0; bus < sc->mly_cam_channels; bus++) { 1385 if (MLY_BUS_IS_VALID(sc, bus)) { 1386 for (target = 0; target < MLY_MAX_TARGETS; target++) { 1387 1388 /* ignore the controller in this scan */ 1389 if (target == sc->mly_controllerparam->initiator_id) 1390 continue; 1391 1392 /* perform device rescan? */ 1393 if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_RESCAN) 1394 mly_rescan_btl(sc, bus, target); 1395 } 1396 } 1397 } 1398 1399 /* check for controller events */ 1400 mly_check_event(sc); 1401 1402 /* reschedule ourselves */ 1403 sc->mly_periodic = timeout(mly_periodic, sc, MLY_PERIODIC_INTERVAL * hz); 1404} 1405 1406/******************************************************************************** 1407 ******************************************************************************** 1408 Command Processing 1409 ******************************************************************************** 1410 ********************************************************************************/ 1411 1412/******************************************************************************** 1413 * Run a command and wait for it to complete. 1414 * 1415 */ 1416static int 1417mly_immediate_command(struct mly_command *mc) 1418{ 1419 struct mly_softc *sc = mc->mc_sc; 1420 int error, s; 1421 1422 debug_called(1); 1423 1424 /* spinning at splcam is ugly, but we're only used during controller init */ 1425 s = splcam(); 1426 if ((error = mly_start(mc))) { 1427 splx(s); 1428 return(error); 1429 } 1430 1431 if (sc->mly_state & MLY_STATE_INTERRUPTS_ON) { 1432 /* sleep on the command */ 1433 while(!(mc->mc_flags & MLY_CMD_COMPLETE)) { 1434 tsleep(mc, PRIBIO, "mlywait", 0); 1435 } 1436 } else { 1437 /* spin and collect status while we do */ 1438 while(!(mc->mc_flags & MLY_CMD_COMPLETE)) { 1439 mly_done(mc->mc_sc); 1440 } 1441 } 1442 splx(s); 1443 return(0); 1444} 1445 1446/******************************************************************************** 1447 * Deliver a command to the controller. 1448 * 1449 * XXX it would be good to just queue commands that we can't submit immediately 1450 * and send them later, but we probably want a wrapper for that so that 1451 * we don't hang on a failed submission for an immediate command. 1452 */ 1453static int 1454mly_start(struct mly_command *mc) 1455{ 1456 struct mly_softc *sc = mc->mc_sc; 1457 union mly_command_packet *pkt; 1458 int s; 1459 1460 debug_called(2); 1461 1462 /* 1463 * Set the command up for delivery to the controller. 1464 */ 1465 mly_map_command(mc); 1466 mc->mc_packet->generic.command_id = mc->mc_slot; 1467 1468#ifdef MLY_DEBUG 1469 mc->mc_timestamp = time_second; 1470#endif 1471 1472 s = splcam(); 1473 1474 /* 1475 * Do we have to use the hardware mailbox? 1476 */ 1477 if (!(sc->mly_state & MLY_STATE_MMBOX_ACTIVE)) { 1478 /* 1479 * Check to see if the controller is ready for us. 1480 */ 1481 if (MLY_IDBR_TRUE(sc, MLY_HM_CMDSENT)) { 1482 splx(s); 1483 return(EBUSY); 1484 } 1485 mc->mc_flags |= MLY_CMD_BUSY; 1486 1487 /* 1488 * It's ready, send the command. 1489 */ 1490 MLY_SET_MBOX(sc, sc->mly_command_mailbox, &mc->mc_packetphys); 1491 MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_CMDSENT); 1492 1493 } else { /* use memory-mailbox mode */ 1494 1495 pkt = &sc->mly_mmbox->mmm_command[sc->mly_mmbox_command_index]; 1496 1497 /* check to see if the next index is free yet */ 1498 if (pkt->mmbox.flag != 0) { 1499 splx(s); 1500 return(EBUSY); 1501 } 1502 mc->mc_flags |= MLY_CMD_BUSY; 1503 1504 /* copy in new command */ 1505 bcopy(mc->mc_packet->mmbox.data, pkt->mmbox.data, sizeof(pkt->mmbox.data)); 1506 /* barrier to ensure completion of previous write before we write the flag */ 1507 bus_space_barrier(sc->mly_btag, sc->mly_bhandle, 0, 0, 1508 BUS_SPACE_BARRIER_WRITE); 1509 /* copy flag last */ 1510 pkt->mmbox.flag = mc->mc_packet->mmbox.flag; 1511 /* barrier to ensure completion of previous write before we notify the controller */ 1512 bus_space_barrier(sc->mly_btag, sc->mly_bhandle, 0, 0, 1513 BUS_SPACE_BARRIER_WRITE); 1514 1515 /* signal controller, update index */ 1516 MLY_SET_REG(sc, sc->mly_idbr, MLY_AM_CMDSENT); 1517 sc->mly_mmbox_command_index = (sc->mly_mmbox_command_index + 1) % MLY_MMBOX_COMMANDS; 1518 } 1519 1520 mly_enqueue_busy(mc); 1521 splx(s); 1522 return(0); 1523} 1524 1525/******************************************************************************** 1526 * Pick up command status from the controller, schedule a completion event 1527 */ 1528static void 1529mly_done(struct mly_softc *sc) 1530{ 1531 struct mly_command *mc; 1532 union mly_status_packet *sp; 1533 u_int16_t slot; 1534 int s, worked; 1535 1536 s = splcam(); 1537 worked = 0; 1538 1539 /* pick up hardware-mailbox commands */ 1540 if (MLY_ODBR_TRUE(sc, MLY_HM_STSREADY)) { 1541 slot = MLY_GET_REG2(sc, sc->mly_status_mailbox); 1542 if (slot < MLY_SLOT_MAX) { 1543 mc = &sc->mly_command[slot - MLY_SLOT_START]; 1544 mc->mc_status = MLY_GET_REG(sc, sc->mly_status_mailbox + 2); 1545 mc->mc_sense = MLY_GET_REG(sc, sc->mly_status_mailbox + 3); 1546 mc->mc_resid = MLY_GET_REG4(sc, sc->mly_status_mailbox + 4); 1547 mly_remove_busy(mc); 1548 mc->mc_flags &= ~MLY_CMD_BUSY; 1549 mly_enqueue_complete(mc); 1550 worked = 1; 1551 } else { 1552 /* slot 0xffff may mean "extremely bogus command" */ 1553 mly_printf(sc, "got HM completion for illegal slot %u\n", slot); 1554 } 1555 /* unconditionally acknowledge status */ 1556 MLY_SET_REG(sc, sc->mly_odbr, MLY_HM_STSREADY); 1557 MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_STSACK); 1558 } 1559 1560 /* pick up memory-mailbox commands */ 1561 if (MLY_ODBR_TRUE(sc, MLY_AM_STSREADY)) { 1562 for (;;) { 1563 sp = &sc->mly_mmbox->mmm_status[sc->mly_mmbox_status_index]; 1564 1565 /* check for more status */ 1566 if (sp->mmbox.flag == 0) 1567 break; 1568 1569 /* get slot number */ 1570 slot = sp->status.command_id; 1571 if (slot < MLY_SLOT_MAX) { 1572 mc = &sc->mly_command[slot - MLY_SLOT_START]; 1573 mc->mc_status = sp->status.status; 1574 mc->mc_sense = sp->status.sense_length; 1575 mc->mc_resid = sp->status.residue; 1576 mly_remove_busy(mc); 1577 mc->mc_flags &= ~MLY_CMD_BUSY; 1578 mly_enqueue_complete(mc); 1579 worked = 1; 1580 } else { 1581 /* slot 0xffff may mean "extremely bogus command" */ 1582 mly_printf(sc, "got AM completion for illegal slot %u at %d\n", 1583 slot, sc->mly_mmbox_status_index); 1584 } 1585 1586 /* clear and move to next index */ 1587 sp->mmbox.flag = 0; 1588 sc->mly_mmbox_status_index = (sc->mly_mmbox_status_index + 1) % MLY_MMBOX_STATUS; 1589 } 1590 /* acknowledge that we have collected status value(s) */ 1591 MLY_SET_REG(sc, sc->mly_odbr, MLY_AM_STSREADY); 1592 } 1593 1594 splx(s); 1595 if (worked) { 1596 if (sc->mly_state & MLY_STATE_INTERRUPTS_ON) 1597 taskqueue_enqueue(taskqueue_swi_giant, &sc->mly_task_complete); 1598 else 1599 mly_complete(sc, 0); 1600 } 1601} 1602 1603/******************************************************************************** 1604 * Process completed commands 1605 */ 1606static void 1607mly_complete(void *context, int pending) 1608{ 1609 struct mly_softc *sc = (struct mly_softc *)context; 1610 struct mly_command *mc; 1611 void (* mc_complete)(struct mly_command *mc); 1612 1613 1614 debug_called(2); 1615 1616 /* 1617 * Spin pulling commands off the completed queue and processing them. 1618 */ 1619 while ((mc = mly_dequeue_complete(sc)) != NULL) { 1620 1621 /* 1622 * Free controller resources, mark command complete. 1623 * 1624 * Note that as soon as we mark the command complete, it may be freed 1625 * out from under us, so we need to save the mc_complete field in 1626 * order to later avoid dereferencing mc. (We would not expect to 1627 * have a polling/sleeping consumer with mc_complete != NULL). 1628 */ 1629 mly_unmap_command(mc); 1630 mc_complete = mc->mc_complete; 1631 mc->mc_flags |= MLY_CMD_COMPLETE; 1632 1633 /* 1634 * Call completion handler or wake up sleeping consumer. 1635 */ 1636 if (mc_complete != NULL) { 1637 mc_complete(mc); 1638 } else { 1639 wakeup(mc); 1640 } 1641 } 1642 1643 /* 1644 * XXX if we are deferring commands due to controller-busy status, we should 1645 * retry submitting them here. 1646 */ 1647} 1648 1649/******************************************************************************** 1650 ******************************************************************************** 1651 Command Buffer Management 1652 ******************************************************************************** 1653 ********************************************************************************/ 1654 1655/******************************************************************************** 1656 * Allocate a command. 1657 */ 1658static int 1659mly_alloc_command(struct mly_softc *sc, struct mly_command **mcp) 1660{ 1661 struct mly_command *mc; 1662 1663 debug_called(3); 1664 1665 if ((mc = mly_dequeue_free(sc)) == NULL) 1666 return(ENOMEM); 1667 1668 *mcp = mc; 1669 return(0); 1670} 1671 1672/******************************************************************************** 1673 * Release a command back to the freelist. 1674 */ 1675static void 1676mly_release_command(struct mly_command *mc) 1677{ 1678 debug_called(3); 1679 1680 /* 1681 * Fill in parts of the command that may cause confusion if 1682 * a consumer doesn't when we are later allocated. 1683 */ 1684 mc->mc_data = NULL; 1685 mc->mc_flags = 0; 1686 mc->mc_complete = NULL; 1687 mc->mc_private = NULL; 1688 1689 /* 1690 * By default, we set up to overwrite the command packet with 1691 * sense information. 1692 */ 1693 mc->mc_packet->generic.sense_buffer_address = mc->mc_packetphys; 1694 mc->mc_packet->generic.maximum_sense_size = sizeof(union mly_command_packet); 1695 1696 mly_enqueue_free(mc); 1697} 1698 1699/******************************************************************************** 1700 * Map helper for command allocation. 1701 */ 1702static void 1703mly_alloc_commands_map(void *arg, bus_dma_segment_t *segs, int nseg, int error) 1704{ 1705 struct mly_softc *sc = (struct mly_softc *)arg; 1706 1707 debug_called(1); 1708 1709 sc->mly_packetphys = segs[0].ds_addr; 1710} 1711 1712/******************************************************************************** 1713 * Allocate and initialise command and packet structures. 1714 * 1715 * If the controller supports fewer than MLY_MAX_COMMANDS commands, limit our 1716 * allocation to that number. If we don't yet know how many commands the 1717 * controller supports, allocate a very small set (suitable for initialisation 1718 * purposes only). 1719 */ 1720static int 1721mly_alloc_commands(struct mly_softc *sc) 1722{ 1723 struct mly_command *mc; 1724 int i, ncmd; 1725 1726 if (sc->mly_controllerinfo == NULL) { 1727 ncmd = 4; 1728 } else { 1729 ncmd = min(MLY_MAX_COMMANDS, sc->mly_controllerinfo->maximum_parallel_commands); 1730 } 1731 1732 /* 1733 * Allocate enough space for all the command packets in one chunk and 1734 * map them permanently into controller-visible space. 1735 */ 1736 if (bus_dmamem_alloc(sc->mly_packet_dmat, (void **)&sc->mly_packet, 1737 BUS_DMA_NOWAIT, &sc->mly_packetmap)) { 1738 return(ENOMEM); 1739 } 1740 if (bus_dmamap_load(sc->mly_packet_dmat, sc->mly_packetmap, sc->mly_packet, 1741 ncmd * sizeof(union mly_command_packet), 1742 mly_alloc_commands_map, sc, BUS_DMA_NOWAIT) != 0) 1743 return (ENOMEM); 1744 1745 for (i = 0; i < ncmd; i++) { 1746 mc = &sc->mly_command[i]; 1747 bzero(mc, sizeof(*mc)); 1748 mc->mc_sc = sc; 1749 mc->mc_slot = MLY_SLOT_START + i; 1750 mc->mc_packet = sc->mly_packet + i; 1751 mc->mc_packetphys = sc->mly_packetphys + (i * sizeof(union mly_command_packet)); 1752 if (!bus_dmamap_create(sc->mly_buffer_dmat, 0, &mc->mc_datamap)) 1753 mly_release_command(mc); 1754 } 1755 return(0); 1756} 1757 1758/******************************************************************************** 1759 * Free all the storage held by commands. 1760 * 1761 * Must be called with all commands on the free list. 1762 */ 1763static void 1764mly_release_commands(struct mly_softc *sc) 1765{ 1766 struct mly_command *mc; 1767 1768 /* throw away command buffer DMA maps */ 1769 while (mly_alloc_command(sc, &mc) == 0) 1770 bus_dmamap_destroy(sc->mly_buffer_dmat, mc->mc_datamap); 1771 1772 /* release the packet storage */ 1773 if (sc->mly_packet != NULL) { 1774 bus_dmamap_unload(sc->mly_packet_dmat, sc->mly_packetmap); 1775 bus_dmamem_free(sc->mly_packet_dmat, sc->mly_packet, sc->mly_packetmap); 1776 sc->mly_packet = NULL; 1777 } 1778} 1779 1780 1781/******************************************************************************** 1782 * Command-mapping helper function - populate this command's s/g table 1783 * with the s/g entries for its data. 1784 */ 1785static void 1786mly_map_command_sg(void *arg, bus_dma_segment_t *segs, int nseg, int error) 1787{ 1788 struct mly_command *mc = (struct mly_command *)arg; 1789 struct mly_softc *sc = mc->mc_sc; 1790 struct mly_command_generic *gen = &(mc->mc_packet->generic); 1791 struct mly_sg_entry *sg; 1792 int i, tabofs; 1793 1794 debug_called(2); 1795 1796 /* can we use the transfer structure directly? */ 1797 if (nseg <= 2) { 1798 sg = &gen->transfer.direct.sg[0]; 1799 gen->command_control.extended_sg_table = 0; 1800 } else { 1801 tabofs = ((mc->mc_slot - MLY_SLOT_START) * MLY_MAX_SGENTRIES); 1802 sg = sc->mly_sg_table + tabofs; 1803 gen->transfer.indirect.entries[0] = nseg; 1804 gen->transfer.indirect.table_physaddr[0] = sc->mly_sg_busaddr + (tabofs * sizeof(struct mly_sg_entry)); 1805 gen->command_control.extended_sg_table = 1; 1806 } 1807 1808 /* copy the s/g table */ 1809 for (i = 0; i < nseg; i++) { 1810 sg[i].physaddr = segs[i].ds_addr; 1811 sg[i].length = segs[i].ds_len; 1812 } 1813 1814} 1815 1816#if 0 1817/******************************************************************************** 1818 * Command-mapping helper function - save the cdb's physical address. 1819 * 1820 * We don't support 'large' SCSI commands at this time, so this is unused. 1821 */ 1822static void 1823mly_map_command_cdb(void *arg, bus_dma_segment_t *segs, int nseg, int error) 1824{ 1825 struct mly_command *mc = (struct mly_command *)arg; 1826 1827 debug_called(2); 1828 1829 /* XXX can we safely assume that a CDB will never cross a page boundary? */ 1830 if ((segs[0].ds_addr % PAGE_SIZE) > 1831 ((segs[0].ds_addr + mc->mc_packet->scsi_large.cdb_length) % PAGE_SIZE)) 1832 panic("cdb crosses page boundary"); 1833 1834 /* fix up fields in the command packet */ 1835 mc->mc_packet->scsi_large.cdb_physaddr = segs[0].ds_addr; 1836} 1837#endif 1838 1839/******************************************************************************** 1840 * Map a command into controller-visible space 1841 */ 1842static void 1843mly_map_command(struct mly_command *mc) 1844{ 1845 struct mly_softc *sc = mc->mc_sc; 1846 1847 debug_called(2); 1848 1849 /* don't map more than once */ 1850 if (mc->mc_flags & MLY_CMD_MAPPED) 1851 return; 1852 1853 /* does the command have a data buffer? */ 1854 if (mc->mc_data != NULL) { 1855 if (mc->mc_flags & MLY_CMD_CCB) 1856 bus_dmamap_load_ccb(sc->mly_buffer_dmat, mc->mc_datamap, 1857 mc->mc_data, mly_map_command_sg, mc, 0); 1858 else 1859 bus_dmamap_load(sc->mly_buffer_dmat, mc->mc_datamap, 1860 mc->mc_data, mc->mc_length, 1861 mly_map_command_sg, mc, 0); 1862 if (mc->mc_flags & MLY_CMD_DATAIN) 1863 bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_PREREAD); 1864 if (mc->mc_flags & MLY_CMD_DATAOUT) 1865 bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_PREWRITE); 1866 } 1867 mc->mc_flags |= MLY_CMD_MAPPED; 1868} 1869 1870/******************************************************************************** 1871 * Unmap a command from controller-visible space 1872 */ 1873static void 1874mly_unmap_command(struct mly_command *mc) 1875{ 1876 struct mly_softc *sc = mc->mc_sc; 1877 1878 debug_called(2); 1879 1880 if (!(mc->mc_flags & MLY_CMD_MAPPED)) 1881 return; 1882 1883 /* does the command have a data buffer? */ 1884 if (mc->mc_data != NULL) { 1885 if (mc->mc_flags & MLY_CMD_DATAIN) 1886 bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_POSTREAD); 1887 if (mc->mc_flags & MLY_CMD_DATAOUT) 1888 bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_POSTWRITE); 1889 1890 bus_dmamap_unload(sc->mly_buffer_dmat, mc->mc_datamap); 1891 } 1892 mc->mc_flags &= ~MLY_CMD_MAPPED; 1893} 1894 1895 1896/******************************************************************************** 1897 ******************************************************************************** 1898 CAM interface 1899 ******************************************************************************** 1900 ********************************************************************************/ 1901 1902/******************************************************************************** 1903 * Attach the physical and virtual SCSI busses to CAM. 1904 * 1905 * Physical bus numbering starts from 0, virtual bus numbering from one greater 1906 * than the highest physical bus. Physical busses are only registered if 1907 * the kernel environment variable "hw.mly.register_physical_channels" is set. 1908 * 1909 * When we refer to a "bus", we are referring to the bus number registered with 1910 * the SIM, wheras a "channel" is a channel number given to the adapter. In order 1911 * to keep things simple, we map these 1:1, so "bus" and "channel" may be used 1912 * interchangeably. 1913 */ 1914static int 1915mly_cam_attach(struct mly_softc *sc) 1916{ 1917 struct cam_devq *devq; 1918 int chn, i; 1919 1920 debug_called(1); 1921 1922 /* 1923 * Allocate a devq for all our channels combined. 1924 */ 1925 if ((devq = cam_simq_alloc(sc->mly_controllerinfo->maximum_parallel_commands)) == NULL) { 1926 mly_printf(sc, "can't allocate CAM SIM queue\n"); 1927 return(ENOMEM); 1928 } 1929 1930 /* 1931 * If physical channel registration has been requested, register these first. 1932 * Note that we enable tagged command queueing for physical channels. 1933 */ 1934 if (testenv("hw.mly.register_physical_channels")) { 1935 chn = 0; 1936 for (i = 0; i < sc->mly_controllerinfo->physical_channels_present; i++, chn++) { 1937 1938 if ((sc->mly_cam_sim[chn] = cam_sim_alloc(mly_cam_action, mly_cam_poll, "mly", sc, 1939 device_get_unit(sc->mly_dev), 1940 &Giant, 1941 sc->mly_controllerinfo->maximum_parallel_commands, 1942 1, devq)) == NULL) { 1943 return(ENOMEM); 1944 } 1945 if (xpt_bus_register(sc->mly_cam_sim[chn], sc->mly_dev, chn)) { 1946 mly_printf(sc, "CAM XPT phsyical channel registration failed\n"); 1947 return(ENXIO); 1948 } 1949 debug(1, "registered physical channel %d", chn); 1950 } 1951 } 1952 1953 /* 1954 * Register our virtual channels, with bus numbers matching channel numbers. 1955 */ 1956 chn = sc->mly_controllerinfo->physical_channels_present; 1957 for (i = 0; i < sc->mly_controllerinfo->virtual_channels_present; i++, chn++) { 1958 if ((sc->mly_cam_sim[chn] = cam_sim_alloc(mly_cam_action, mly_cam_poll, "mly", sc, 1959 device_get_unit(sc->mly_dev), 1960 &Giant, 1961 sc->mly_controllerinfo->maximum_parallel_commands, 1962 0, devq)) == NULL) { 1963 return(ENOMEM); 1964 } 1965 if (xpt_bus_register(sc->mly_cam_sim[chn], sc->mly_dev, chn)) { 1966 mly_printf(sc, "CAM XPT virtual channel registration failed\n"); 1967 return(ENXIO); 1968 } 1969 debug(1, "registered virtual channel %d", chn); 1970 } 1971 1972 /* 1973 * This is the total number of channels that (might have been) registered with 1974 * CAM. Some may not have been; check the mly_cam_sim array to be certain. 1975 */ 1976 sc->mly_cam_channels = sc->mly_controllerinfo->physical_channels_present + 1977 sc->mly_controllerinfo->virtual_channels_present; 1978 1979 return(0); 1980} 1981 1982/******************************************************************************** 1983 * Detach from CAM 1984 */ 1985static void 1986mly_cam_detach(struct mly_softc *sc) 1987{ 1988 int i; 1989 1990 debug_called(1); 1991 1992 for (i = 0; i < sc->mly_cam_channels; i++) { 1993 if (sc->mly_cam_sim[i] != NULL) { 1994 xpt_bus_deregister(cam_sim_path(sc->mly_cam_sim[i])); 1995 cam_sim_free(sc->mly_cam_sim[i], 0); 1996 } 1997 } 1998 if (sc->mly_cam_devq != NULL) 1999 cam_simq_free(sc->mly_cam_devq); 2000} 2001 2002/************************************************************************ 2003 * Rescan a device. 2004 */ 2005static void 2006mly_cam_rescan_btl(struct mly_softc *sc, int bus, int target) 2007{ 2008 union ccb *ccb; 2009 2010 debug_called(1); 2011 2012 if ((ccb = xpt_alloc_ccb()) == NULL) { 2013 mly_printf(sc, "rescan failed (can't allocate CCB)\n"); 2014 return; 2015 } 2016 if (xpt_create_path(&ccb->ccb_h.path, NULL, 2017 cam_sim_path(sc->mly_cam_sim[bus]), target, 0) != CAM_REQ_CMP) { 2018 mly_printf(sc, "rescan failed (can't create path)\n"); 2019 xpt_free_ccb(ccb); 2020 return; 2021 } 2022 debug(1, "rescan target %d:%d", bus, target); 2023 xpt_rescan(ccb); 2024} 2025 2026/******************************************************************************** 2027 * Handle an action requested by CAM 2028 */ 2029static void 2030mly_cam_action(struct cam_sim *sim, union ccb *ccb) 2031{ 2032 struct mly_softc *sc = cam_sim_softc(sim); 2033 2034 debug_called(2); 2035 2036 switch (ccb->ccb_h.func_code) { 2037 2038 /* perform SCSI I/O */ 2039 case XPT_SCSI_IO: 2040 if (!mly_cam_action_io(sim, (struct ccb_scsiio *)&ccb->csio)) 2041 return; 2042 break; 2043 2044 /* perform geometry calculations */ 2045 case XPT_CALC_GEOMETRY: 2046 { 2047 struct ccb_calc_geometry *ccg = &ccb->ccg; 2048 u_int32_t secs_per_cylinder; 2049 2050 debug(2, "XPT_CALC_GEOMETRY %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun); 2051 2052 if (sc->mly_controllerparam->bios_geometry == MLY_BIOSGEOM_8G) { 2053 ccg->heads = 255; 2054 ccg->secs_per_track = 63; 2055 } else { /* MLY_BIOSGEOM_2G */ 2056 ccg->heads = 128; 2057 ccg->secs_per_track = 32; 2058 } 2059 secs_per_cylinder = ccg->heads * ccg->secs_per_track; 2060 ccg->cylinders = ccg->volume_size / secs_per_cylinder; 2061 ccb->ccb_h.status = CAM_REQ_CMP; 2062 break; 2063 } 2064 2065 /* handle path attribute inquiry */ 2066 case XPT_PATH_INQ: 2067 { 2068 struct ccb_pathinq *cpi = &ccb->cpi; 2069 2070 debug(2, "XPT_PATH_INQ %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun); 2071 2072 cpi->version_num = 1; 2073 cpi->hba_inquiry = PI_TAG_ABLE; /* XXX extra flags for physical channels? */ 2074 cpi->target_sprt = 0; 2075 cpi->hba_misc = 0; 2076 cpi->max_target = MLY_MAX_TARGETS - 1; 2077 cpi->max_lun = MLY_MAX_LUNS - 1; 2078 cpi->initiator_id = sc->mly_controllerparam->initiator_id; 2079 strlcpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN); 2080 strlcpy(cpi->hba_vid, "Mylex", HBA_IDLEN); 2081 strlcpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN); 2082 cpi->unit_number = cam_sim_unit(sim); 2083 cpi->bus_id = cam_sim_bus(sim); 2084 cpi->base_transfer_speed = 132 * 1024; /* XXX what to set this to? */ 2085 cpi->transport = XPORT_SPI; 2086 cpi->transport_version = 2; 2087 cpi->protocol = PROTO_SCSI; 2088 cpi->protocol_version = SCSI_REV_2; 2089 ccb->ccb_h.status = CAM_REQ_CMP; 2090 break; 2091 } 2092 2093 case XPT_GET_TRAN_SETTINGS: 2094 { 2095 struct ccb_trans_settings *cts = &ccb->cts; 2096 int bus, target; 2097 struct ccb_trans_settings_scsi *scsi = &cts->proto_specific.scsi; 2098 struct ccb_trans_settings_spi *spi = &cts->xport_specific.spi; 2099 2100 cts->protocol = PROTO_SCSI; 2101 cts->protocol_version = SCSI_REV_2; 2102 cts->transport = XPORT_SPI; 2103 cts->transport_version = 2; 2104 2105 scsi->flags = 0; 2106 scsi->valid = 0; 2107 spi->flags = 0; 2108 spi->valid = 0; 2109 2110 bus = cam_sim_bus(sim); 2111 target = cts->ccb_h.target_id; 2112 debug(2, "XPT_GET_TRAN_SETTINGS %d:%d", bus, target); 2113 /* logical device? */ 2114 if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_LOGICAL) { 2115 /* nothing special for these */ 2116 /* physical device? */ 2117 } else if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_PHYSICAL) { 2118 /* allow CAM to try tagged transactions */ 2119 scsi->flags |= CTS_SCSI_FLAGS_TAG_ENB; 2120 scsi->valid |= CTS_SCSI_VALID_TQ; 2121 2122 /* convert speed (MHz) to usec */ 2123 if (sc->mly_btl[bus][target].mb_speed == 0) { 2124 spi->sync_period = 1000000 / 5; 2125 } else { 2126 spi->sync_period = 1000000 / sc->mly_btl[bus][target].mb_speed; 2127 } 2128 2129 /* convert bus width to CAM internal encoding */ 2130 switch (sc->mly_btl[bus][target].mb_width) { 2131 case 32: 2132 spi->bus_width = MSG_EXT_WDTR_BUS_32_BIT; 2133 break; 2134 case 16: 2135 spi->bus_width = MSG_EXT_WDTR_BUS_16_BIT; 2136 break; 2137 case 8: 2138 default: 2139 spi->bus_width = MSG_EXT_WDTR_BUS_8_BIT; 2140 break; 2141 } 2142 spi->valid |= CTS_SPI_VALID_SYNC_RATE | CTS_SPI_VALID_BUS_WIDTH; 2143 2144 /* not a device, bail out */ 2145 } else { 2146 cts->ccb_h.status = CAM_REQ_CMP_ERR; 2147 break; 2148 } 2149 2150 /* disconnect always OK */ 2151 spi->flags |= CTS_SPI_FLAGS_DISC_ENB; 2152 spi->valid |= CTS_SPI_VALID_DISC; 2153 2154 cts->ccb_h.status = CAM_REQ_CMP; 2155 break; 2156 } 2157 2158 default: /* we can't do this */ 2159 debug(2, "unspported func_code = 0x%x", ccb->ccb_h.func_code); 2160 ccb->ccb_h.status = CAM_REQ_INVALID; 2161 break; 2162 } 2163 2164 xpt_done(ccb); 2165} 2166 2167/******************************************************************************** 2168 * Handle an I/O operation requested by CAM 2169 */ 2170static int 2171mly_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio) 2172{ 2173 struct mly_softc *sc = cam_sim_softc(sim); 2174 struct mly_command *mc; 2175 struct mly_command_scsi_small *ss; 2176 int bus, target; 2177 int error; 2178 int s; 2179 2180 bus = cam_sim_bus(sim); 2181 target = csio->ccb_h.target_id; 2182 2183 debug(2, "XPT_SCSI_IO %d:%d:%d", bus, target, csio->ccb_h.target_lun); 2184 2185 /* validate bus number */ 2186 if (!MLY_BUS_IS_VALID(sc, bus)) { 2187 debug(0, " invalid bus %d", bus); 2188 csio->ccb_h.status = CAM_REQ_CMP_ERR; 2189 } 2190 2191 /* check for I/O attempt to a protected device */ 2192 if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_PROTECTED) { 2193 debug(2, " device protected"); 2194 csio->ccb_h.status = CAM_REQ_CMP_ERR; 2195 } 2196 2197 /* check for I/O attempt to nonexistent device */ 2198 if (!(sc->mly_btl[bus][target].mb_flags & (MLY_BTL_LOGICAL | MLY_BTL_PHYSICAL))) { 2199 debug(2, " device %d:%d does not exist", bus, target); 2200 csio->ccb_h.status = CAM_REQ_CMP_ERR; 2201 } 2202 2203 /* XXX increase if/when we support large SCSI commands */ 2204 if (csio->cdb_len > MLY_CMD_SCSI_SMALL_CDB) { 2205 debug(0, " command too large (%d > %d)", csio->cdb_len, MLY_CMD_SCSI_SMALL_CDB); 2206 csio->ccb_h.status = CAM_REQ_CMP_ERR; 2207 } 2208 2209 /* check that the CDB pointer is not to a physical address */ 2210 if ((csio->ccb_h.flags & CAM_CDB_POINTER) && (csio->ccb_h.flags & CAM_CDB_PHYS)) { 2211 debug(0, " CDB pointer is to physical address"); 2212 csio->ccb_h.status = CAM_REQ_CMP_ERR; 2213 } 2214 2215 /* abandon aborted ccbs or those that have failed validation */ 2216 if ((csio->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG) { 2217 debug(2, "abandoning CCB due to abort/validation failure"); 2218 return(EINVAL); 2219 } 2220 2221 /* 2222 * Get a command, or push the ccb back to CAM and freeze the queue. 2223 */ 2224 if ((error = mly_alloc_command(sc, &mc))) { 2225 s = splcam(); 2226 xpt_freeze_simq(sim, 1); 2227 csio->ccb_h.status |= CAM_REQUEUE_REQ; 2228 sc->mly_qfrzn_cnt++; 2229 splx(s); 2230 return(error); 2231 } 2232 2233 /* build the command */ 2234 mc->mc_data = csio; 2235 mc->mc_length = csio->dxfer_len; 2236 mc->mc_complete = mly_cam_complete; 2237 mc->mc_private = csio; 2238 mc->mc_flags |= MLY_CMD_CCB; 2239 /* XXX This code doesn't set the data direction in mc_flags. */ 2240 2241 /* save the bus number in the ccb for later recovery XXX should be a better way */ 2242 csio->ccb_h.sim_priv.entries[0].field = bus; 2243 2244 /* build the packet for the controller */ 2245 ss = &mc->mc_packet->scsi_small; 2246 ss->opcode = MDACMD_SCSI; 2247 if (csio->ccb_h.flags & CAM_DIS_DISCONNECT) 2248 ss->command_control.disable_disconnect = 1; 2249 if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT) 2250 ss->command_control.data_direction = MLY_CCB_WRITE; 2251 ss->data_size = csio->dxfer_len; 2252 ss->addr.phys.lun = csio->ccb_h.target_lun; 2253 ss->addr.phys.target = csio->ccb_h.target_id; 2254 ss->addr.phys.channel = bus; 2255 if (csio->ccb_h.timeout < (60 * 1000)) { 2256 ss->timeout.value = csio->ccb_h.timeout / 1000; 2257 ss->timeout.scale = MLY_TIMEOUT_SECONDS; 2258 } else if (csio->ccb_h.timeout < (60 * 60 * 1000)) { 2259 ss->timeout.value = csio->ccb_h.timeout / (60 * 1000); 2260 ss->timeout.scale = MLY_TIMEOUT_MINUTES; 2261 } else { 2262 ss->timeout.value = csio->ccb_h.timeout / (60 * 60 * 1000); /* overflow? */ 2263 ss->timeout.scale = MLY_TIMEOUT_HOURS; 2264 } 2265 ss->maximum_sense_size = csio->sense_len; 2266 ss->cdb_length = csio->cdb_len; 2267 if (csio->ccb_h.flags & CAM_CDB_POINTER) { 2268 bcopy(csio->cdb_io.cdb_ptr, ss->cdb, csio->cdb_len); 2269 } else { 2270 bcopy(csio->cdb_io.cdb_bytes, ss->cdb, csio->cdb_len); 2271 } 2272 2273 /* give the command to the controller */ 2274 if ((error = mly_start(mc))) { 2275 s = splcam(); 2276 xpt_freeze_simq(sim, 1); 2277 csio->ccb_h.status |= CAM_REQUEUE_REQ; 2278 sc->mly_qfrzn_cnt++; 2279 splx(s); 2280 return(error); 2281 } 2282 2283 return(0); 2284} 2285 2286/******************************************************************************** 2287 * Check for possibly-completed commands. 2288 */ 2289static void 2290mly_cam_poll(struct cam_sim *sim) 2291{ 2292 struct mly_softc *sc = cam_sim_softc(sim); 2293 2294 debug_called(2); 2295 2296 mly_done(sc); 2297} 2298 2299/******************************************************************************** 2300 * Handle completion of a command - pass results back through the CCB 2301 */ 2302static void 2303mly_cam_complete(struct mly_command *mc) 2304{ 2305 struct mly_softc *sc = mc->mc_sc; 2306 struct ccb_scsiio *csio = (struct ccb_scsiio *)mc->mc_private; 2307 struct scsi_inquiry_data *inq = (struct scsi_inquiry_data *)csio->data_ptr; 2308 struct mly_btl *btl; 2309 u_int8_t cmd; 2310 int bus, target; 2311 int s; 2312 2313 debug_called(2); 2314 2315 csio->scsi_status = mc->mc_status; 2316 switch(mc->mc_status) { 2317 case SCSI_STATUS_OK: 2318 /* 2319 * In order to report logical device type and status, we overwrite 2320 * the result of the INQUIRY command to logical devices. 2321 */ 2322 bus = csio->ccb_h.sim_priv.entries[0].field; 2323 target = csio->ccb_h.target_id; 2324 /* XXX validate bus/target? */ 2325 if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_LOGICAL) { 2326 if (csio->ccb_h.flags & CAM_CDB_POINTER) { 2327 cmd = *csio->cdb_io.cdb_ptr; 2328 } else { 2329 cmd = csio->cdb_io.cdb_bytes[0]; 2330 } 2331 if (cmd == INQUIRY) { 2332 btl = &sc->mly_btl[bus][target]; 2333 padstr(inq->vendor, mly_describe_code(mly_table_device_type, btl->mb_type), 8); 2334 padstr(inq->product, mly_describe_code(mly_table_device_state, btl->mb_state), 16); 2335 padstr(inq->revision, "", 4); 2336 } 2337 } 2338 2339 debug(2, "SCSI_STATUS_OK"); 2340 csio->ccb_h.status = CAM_REQ_CMP; 2341 break; 2342 2343 case SCSI_STATUS_CHECK_COND: 2344 debug(1, "SCSI_STATUS_CHECK_COND sense %d resid %d", mc->mc_sense, mc->mc_resid); 2345 csio->ccb_h.status = CAM_SCSI_STATUS_ERROR; 2346 bzero(&csio->sense_data, SSD_FULL_SIZE); 2347 bcopy(mc->mc_packet, &csio->sense_data, mc->mc_sense); 2348 csio->sense_len = mc->mc_sense; 2349 csio->ccb_h.status |= CAM_AUTOSNS_VALID; 2350 csio->resid = mc->mc_resid; /* XXX this is a signed value... */ 2351 break; 2352 2353 case SCSI_STATUS_BUSY: 2354 debug(1, "SCSI_STATUS_BUSY"); 2355 csio->ccb_h.status = CAM_SCSI_BUSY; 2356 break; 2357 2358 default: 2359 debug(1, "unknown status 0x%x", csio->scsi_status); 2360 csio->ccb_h.status = CAM_REQ_CMP_ERR; 2361 break; 2362 } 2363 2364 s = splcam(); 2365 if (sc->mly_qfrzn_cnt) { 2366 csio->ccb_h.status |= CAM_RELEASE_SIMQ; 2367 sc->mly_qfrzn_cnt--; 2368 } 2369 splx(s); 2370 2371 xpt_done((union ccb *)csio); 2372 mly_release_command(mc); 2373} 2374 2375/******************************************************************************** 2376 * Find a peripheral attahed at (bus),(target) 2377 */ 2378static struct cam_periph * 2379mly_find_periph(struct mly_softc *sc, int bus, int target) 2380{ 2381 struct cam_periph *periph; 2382 struct cam_path *path; 2383 int status; 2384 2385 status = xpt_create_path(&path, NULL, cam_sim_path(sc->mly_cam_sim[bus]), target, 0); 2386 if (status == CAM_REQ_CMP) { 2387 periph = cam_periph_find(path, NULL); 2388 xpt_free_path(path); 2389 } else { 2390 periph = NULL; 2391 } 2392 return(periph); 2393} 2394 2395/******************************************************************************** 2396 * Name the device at (bus)(target) 2397 */ 2398static int 2399mly_name_device(struct mly_softc *sc, int bus, int target) 2400{ 2401 struct cam_periph *periph; 2402 2403 if ((periph = mly_find_periph(sc, bus, target)) != NULL) { 2404 sprintf(sc->mly_btl[bus][target].mb_name, "%s%d", periph->periph_name, periph->unit_number); 2405 return(0); 2406 } 2407 sc->mly_btl[bus][target].mb_name[0] = 0; 2408 return(ENOENT); 2409} 2410 2411/******************************************************************************** 2412 ******************************************************************************** 2413 Hardware Control 2414 ******************************************************************************** 2415 ********************************************************************************/ 2416 2417/******************************************************************************** 2418 * Handshake with the firmware while the card is being initialised. 2419 */ 2420static int 2421mly_fwhandshake(struct mly_softc *sc) 2422{ 2423 u_int8_t error, param0, param1; 2424 int spinup = 0; 2425 2426 debug_called(1); 2427 2428 /* set HM_STSACK and let the firmware initialise */ 2429 MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_STSACK); 2430 DELAY(1000); /* too short? */ 2431 2432 /* if HM_STSACK is still true, the controller is initialising */ 2433 if (!MLY_IDBR_TRUE(sc, MLY_HM_STSACK)) 2434 return(0); 2435 mly_printf(sc, "controller initialisation started\n"); 2436 2437 /* spin waiting for initialisation to finish, or for a message to be delivered */ 2438 while (MLY_IDBR_TRUE(sc, MLY_HM_STSACK)) { 2439 /* check for a message */ 2440 if (MLY_ERROR_VALID(sc)) { 2441 error = MLY_GET_REG(sc, sc->mly_error_status) & ~MLY_MSG_EMPTY; 2442 param0 = MLY_GET_REG(sc, sc->mly_command_mailbox); 2443 param1 = MLY_GET_REG(sc, sc->mly_command_mailbox + 1); 2444 2445 switch(error) { 2446 case MLY_MSG_SPINUP: 2447 if (!spinup) { 2448 mly_printf(sc, "drive spinup in progress\n"); 2449 spinup = 1; /* only print this once (should print drive being spun?) */ 2450 } 2451 break; 2452 case MLY_MSG_RACE_RECOVERY_FAIL: 2453 mly_printf(sc, "mirror race recovery failed, one or more drives offline\n"); 2454 break; 2455 case MLY_MSG_RACE_IN_PROGRESS: 2456 mly_printf(sc, "mirror race recovery in progress\n"); 2457 break; 2458 case MLY_MSG_RACE_ON_CRITICAL: 2459 mly_printf(sc, "mirror race recovery on a critical drive\n"); 2460 break; 2461 case MLY_MSG_PARITY_ERROR: 2462 mly_printf(sc, "FATAL MEMORY PARITY ERROR\n"); 2463 return(ENXIO); 2464 default: 2465 mly_printf(sc, "unknown initialisation code 0x%x\n", error); 2466 } 2467 } 2468 } 2469 return(0); 2470} 2471 2472/******************************************************************************** 2473 ******************************************************************************** 2474 Debugging and Diagnostics 2475 ******************************************************************************** 2476 ********************************************************************************/ 2477 2478/******************************************************************************** 2479 * Print some information about the controller. 2480 */ 2481static void 2482mly_describe_controller(struct mly_softc *sc) 2483{ 2484 struct mly_ioctl_getcontrollerinfo *mi = sc->mly_controllerinfo; 2485 2486 mly_printf(sc, "%16s, %d channel%s, firmware %d.%02d-%d-%02d (%02d%02d%02d%02d), %dMB RAM\n", 2487 mi->controller_name, mi->physical_channels_present, (mi->physical_channels_present) > 1 ? "s" : "", 2488 mi->fw_major, mi->fw_minor, mi->fw_turn, mi->fw_build, /* XXX turn encoding? */ 2489 mi->fw_century, mi->fw_year, mi->fw_month, mi->fw_day, 2490 mi->memory_size); 2491 2492 if (bootverbose) { 2493 mly_printf(sc, "%s %s (%x), %dMHz %d-bit %.16s\n", 2494 mly_describe_code(mly_table_oemname, mi->oem_information), 2495 mly_describe_code(mly_table_controllertype, mi->controller_type), mi->controller_type, 2496 mi->interface_speed, mi->interface_width, mi->interface_name); 2497 mly_printf(sc, "%dMB %dMHz %d-bit %s%s%s, cache %dMB\n", 2498 mi->memory_size, mi->memory_speed, mi->memory_width, 2499 mly_describe_code(mly_table_memorytype, mi->memory_type), 2500 mi->memory_parity ? "+parity": "",mi->memory_ecc ? "+ECC": "", 2501 mi->cache_size); 2502 mly_printf(sc, "CPU: %s @ %dMHz\n", 2503 mly_describe_code(mly_table_cputype, mi->cpu[0].type), mi->cpu[0].speed); 2504 if (mi->l2cache_size != 0) 2505 mly_printf(sc, "%dKB L2 cache\n", mi->l2cache_size); 2506 if (mi->exmemory_size != 0) 2507 mly_printf(sc, "%dMB %dMHz %d-bit private %s%s%s\n", 2508 mi->exmemory_size, mi->exmemory_speed, mi->exmemory_width, 2509 mly_describe_code(mly_table_memorytype, mi->exmemory_type), 2510 mi->exmemory_parity ? "+parity": "",mi->exmemory_ecc ? "+ECC": ""); 2511 mly_printf(sc, "battery backup %s\n", mi->bbu_present ? "present" : "not installed"); 2512 mly_printf(sc, "maximum data transfer %d blocks, maximum sg entries/command %d\n", 2513 mi->maximum_block_count, mi->maximum_sg_entries); 2514 mly_printf(sc, "logical devices present/critical/offline %d/%d/%d\n", 2515 mi->logical_devices_present, mi->logical_devices_critical, mi->logical_devices_offline); 2516 mly_printf(sc, "physical devices present %d\n", 2517 mi->physical_devices_present); 2518 mly_printf(sc, "physical disks present/offline %d/%d\n", 2519 mi->physical_disks_present, mi->physical_disks_offline); 2520 mly_printf(sc, "%d physical channel%s, %d virtual channel%s of %d possible\n", 2521 mi->physical_channels_present, mi->physical_channels_present == 1 ? "" : "s", 2522 mi->virtual_channels_present, mi->virtual_channels_present == 1 ? "" : "s", 2523 mi->virtual_channels_possible); 2524 mly_printf(sc, "%d parallel commands supported\n", mi->maximum_parallel_commands); 2525 mly_printf(sc, "%dMB flash ROM, %d of %d maximum cycles\n", 2526 mi->flash_size, mi->flash_age, mi->flash_maximum_age); 2527 } 2528} 2529 2530#ifdef MLY_DEBUG 2531/******************************************************************************** 2532 * Print some controller state 2533 */ 2534static void 2535mly_printstate(struct mly_softc *sc) 2536{ 2537 mly_printf(sc, "IDBR %02x ODBR %02x ERROR %02x (%x %x %x)\n", 2538 MLY_GET_REG(sc, sc->mly_idbr), 2539 MLY_GET_REG(sc, sc->mly_odbr), 2540 MLY_GET_REG(sc, sc->mly_error_status), 2541 sc->mly_idbr, 2542 sc->mly_odbr, 2543 sc->mly_error_status); 2544 mly_printf(sc, "IMASK %02x ISTATUS %02x\n", 2545 MLY_GET_REG(sc, sc->mly_interrupt_mask), 2546 MLY_GET_REG(sc, sc->mly_interrupt_status)); 2547 mly_printf(sc, "COMMAND %02x %02x %02x %02x %02x %02x %02x %02x\n", 2548 MLY_GET_REG(sc, sc->mly_command_mailbox), 2549 MLY_GET_REG(sc, sc->mly_command_mailbox + 1), 2550 MLY_GET_REG(sc, sc->mly_command_mailbox + 2), 2551 MLY_GET_REG(sc, sc->mly_command_mailbox + 3), 2552 MLY_GET_REG(sc, sc->mly_command_mailbox + 4), 2553 MLY_GET_REG(sc, sc->mly_command_mailbox + 5), 2554 MLY_GET_REG(sc, sc->mly_command_mailbox + 6), 2555 MLY_GET_REG(sc, sc->mly_command_mailbox + 7)); 2556 mly_printf(sc, "STATUS %02x %02x %02x %02x %02x %02x %02x %02x\n", 2557 MLY_GET_REG(sc, sc->mly_status_mailbox), 2558 MLY_GET_REG(sc, sc->mly_status_mailbox + 1), 2559 MLY_GET_REG(sc, sc->mly_status_mailbox + 2), 2560 MLY_GET_REG(sc, sc->mly_status_mailbox + 3), 2561 MLY_GET_REG(sc, sc->mly_status_mailbox + 4), 2562 MLY_GET_REG(sc, sc->mly_status_mailbox + 5), 2563 MLY_GET_REG(sc, sc->mly_status_mailbox + 6), 2564 MLY_GET_REG(sc, sc->mly_status_mailbox + 7)); 2565 mly_printf(sc, " %04x %08x\n", 2566 MLY_GET_REG2(sc, sc->mly_status_mailbox), 2567 MLY_GET_REG4(sc, sc->mly_status_mailbox + 4)); 2568} 2569 2570struct mly_softc *mly_softc0 = NULL; 2571void 2572mly_printstate0(void) 2573{ 2574 if (mly_softc0 != NULL) 2575 mly_printstate(mly_softc0); 2576} 2577 2578/******************************************************************************** 2579 * Print a command 2580 */ 2581static void 2582mly_print_command(struct mly_command *mc) 2583{ 2584 struct mly_softc *sc = mc->mc_sc; 2585 2586 mly_printf(sc, "COMMAND @ %p\n", mc); 2587 mly_printf(sc, " slot %d\n", mc->mc_slot); 2588 mly_printf(sc, " status 0x%x\n", mc->mc_status); 2589 mly_printf(sc, " sense len %d\n", mc->mc_sense); 2590 mly_printf(sc, " resid %d\n", mc->mc_resid); 2591 mly_printf(sc, " packet %p/0x%llx\n", mc->mc_packet, mc->mc_packetphys); 2592 if (mc->mc_packet != NULL) 2593 mly_print_packet(mc); 2594 mly_printf(sc, " data %p/%d\n", mc->mc_data, mc->mc_length); 2595 mly_printf(sc, " flags %b\n", mc->mc_flags, "\20\1busy\2complete\3slotted\4mapped\5datain\6dataout\n"); 2596 mly_printf(sc, " complete %p\n", mc->mc_complete); 2597 mly_printf(sc, " private %p\n", mc->mc_private); 2598} 2599 2600/******************************************************************************** 2601 * Print a command packet 2602 */ 2603static void 2604mly_print_packet(struct mly_command *mc) 2605{ 2606 struct mly_softc *sc = mc->mc_sc; 2607 struct mly_command_generic *ge = (struct mly_command_generic *)mc->mc_packet; 2608 struct mly_command_scsi_small *ss = (struct mly_command_scsi_small *)mc->mc_packet; 2609 struct mly_command_scsi_large *sl = (struct mly_command_scsi_large *)mc->mc_packet; 2610 struct mly_command_ioctl *io = (struct mly_command_ioctl *)mc->mc_packet; 2611 int transfer; 2612 2613 mly_printf(sc, " command_id %d\n", ge->command_id); 2614 mly_printf(sc, " opcode %d\n", ge->opcode); 2615 mly_printf(sc, " command_control fua %d dpo %d est %d dd %s nas %d ddis %d\n", 2616 ge->command_control.force_unit_access, 2617 ge->command_control.disable_page_out, 2618 ge->command_control.extended_sg_table, 2619 (ge->command_control.data_direction == MLY_CCB_WRITE) ? "WRITE" : "READ", 2620 ge->command_control.no_auto_sense, 2621 ge->command_control.disable_disconnect); 2622 mly_printf(sc, " data_size %d\n", ge->data_size); 2623 mly_printf(sc, " sense_buffer_address 0x%llx\n", ge->sense_buffer_address); 2624 mly_printf(sc, " lun %d\n", ge->addr.phys.lun); 2625 mly_printf(sc, " target %d\n", ge->addr.phys.target); 2626 mly_printf(sc, " channel %d\n", ge->addr.phys.channel); 2627 mly_printf(sc, " logical device %d\n", ge->addr.log.logdev); 2628 mly_printf(sc, " controller %d\n", ge->addr.phys.controller); 2629 mly_printf(sc, " timeout %d %s\n", 2630 ge->timeout.value, 2631 (ge->timeout.scale == MLY_TIMEOUT_SECONDS) ? "seconds" : 2632 ((ge->timeout.scale == MLY_TIMEOUT_MINUTES) ? "minutes" : "hours")); 2633 mly_printf(sc, " maximum_sense_size %d\n", ge->maximum_sense_size); 2634 switch(ge->opcode) { 2635 case MDACMD_SCSIPT: 2636 case MDACMD_SCSI: 2637 mly_printf(sc, " cdb length %d\n", ss->cdb_length); 2638 mly_printf(sc, " cdb %*D\n", ss->cdb_length, ss->cdb, " "); 2639 transfer = 1; 2640 break; 2641 case MDACMD_SCSILC: 2642 case MDACMD_SCSILCPT: 2643 mly_printf(sc, " cdb length %d\n", sl->cdb_length); 2644 mly_printf(sc, " cdb 0x%llx\n", sl->cdb_physaddr); 2645 transfer = 1; 2646 break; 2647 case MDACMD_IOCTL: 2648 mly_printf(sc, " sub_ioctl 0x%x\n", io->sub_ioctl); 2649 switch(io->sub_ioctl) { 2650 case MDACIOCTL_SETMEMORYMAILBOX: 2651 mly_printf(sc, " health_buffer_size %d\n", 2652 io->param.setmemorymailbox.health_buffer_size); 2653 mly_printf(sc, " health_buffer_phys 0x%llx\n", 2654 io->param.setmemorymailbox.health_buffer_physaddr); 2655 mly_printf(sc, " command_mailbox 0x%llx\n", 2656 io->param.setmemorymailbox.command_mailbox_physaddr); 2657 mly_printf(sc, " status_mailbox 0x%llx\n", 2658 io->param.setmemorymailbox.status_mailbox_physaddr); 2659 transfer = 0; 2660 break; 2661 2662 case MDACIOCTL_SETREALTIMECLOCK: 2663 case MDACIOCTL_GETHEALTHSTATUS: 2664 case MDACIOCTL_GETCONTROLLERINFO: 2665 case MDACIOCTL_GETLOGDEVINFOVALID: 2666 case MDACIOCTL_GETPHYSDEVINFOVALID: 2667 case MDACIOCTL_GETPHYSDEVSTATISTICS: 2668 case MDACIOCTL_GETLOGDEVSTATISTICS: 2669 case MDACIOCTL_GETCONTROLLERSTATISTICS: 2670 case MDACIOCTL_GETBDT_FOR_SYSDRIVE: 2671 case MDACIOCTL_CREATENEWCONF: 2672 case MDACIOCTL_ADDNEWCONF: 2673 case MDACIOCTL_GETDEVCONFINFO: 2674 case MDACIOCTL_GETFREESPACELIST: 2675 case MDACIOCTL_MORE: 2676 case MDACIOCTL_SETPHYSDEVPARAMETER: 2677 case MDACIOCTL_GETPHYSDEVPARAMETER: 2678 case MDACIOCTL_GETLOGDEVPARAMETER: 2679 case MDACIOCTL_SETLOGDEVPARAMETER: 2680 mly_printf(sc, " param %10D\n", io->param.data.param, " "); 2681 transfer = 1; 2682 break; 2683 2684 case MDACIOCTL_GETEVENT: 2685 mly_printf(sc, " event %d\n", 2686 io->param.getevent.sequence_number_low + ((u_int32_t)io->addr.log.logdev << 16)); 2687 transfer = 1; 2688 break; 2689 2690 case MDACIOCTL_SETRAIDDEVSTATE: 2691 mly_printf(sc, " state %d\n", io->param.setraiddevstate.state); 2692 transfer = 0; 2693 break; 2694 2695 case MDACIOCTL_XLATEPHYSDEVTORAIDDEV: 2696 mly_printf(sc, " raid_device %d\n", io->param.xlatephysdevtoraiddev.raid_device); 2697 mly_printf(sc, " controller %d\n", io->param.xlatephysdevtoraiddev.controller); 2698 mly_printf(sc, " channel %d\n", io->param.xlatephysdevtoraiddev.channel); 2699 mly_printf(sc, " target %d\n", io->param.xlatephysdevtoraiddev.target); 2700 mly_printf(sc, " lun %d\n", io->param.xlatephysdevtoraiddev.lun); 2701 transfer = 0; 2702 break; 2703 2704 case MDACIOCTL_GETGROUPCONFINFO: 2705 mly_printf(sc, " group %d\n", io->param.getgroupconfinfo.group); 2706 transfer = 1; 2707 break; 2708 2709 case MDACIOCTL_GET_SUBSYSTEM_DATA: 2710 case MDACIOCTL_SET_SUBSYSTEM_DATA: 2711 case MDACIOCTL_STARTDISOCVERY: 2712 case MDACIOCTL_INITPHYSDEVSTART: 2713 case MDACIOCTL_INITPHYSDEVSTOP: 2714 case MDACIOCTL_INITRAIDDEVSTART: 2715 case MDACIOCTL_INITRAIDDEVSTOP: 2716 case MDACIOCTL_REBUILDRAIDDEVSTART: 2717 case MDACIOCTL_REBUILDRAIDDEVSTOP: 2718 case MDACIOCTL_MAKECONSISTENTDATASTART: 2719 case MDACIOCTL_MAKECONSISTENTDATASTOP: 2720 case MDACIOCTL_CONSISTENCYCHECKSTART: 2721 case MDACIOCTL_CONSISTENCYCHECKSTOP: 2722 case MDACIOCTL_RESETDEVICE: 2723 case MDACIOCTL_FLUSHDEVICEDATA: 2724 case MDACIOCTL_PAUSEDEVICE: 2725 case MDACIOCTL_UNPAUSEDEVICE: 2726 case MDACIOCTL_LOCATEDEVICE: 2727 case MDACIOCTL_SETMASTERSLAVEMODE: 2728 case MDACIOCTL_DELETERAIDDEV: 2729 case MDACIOCTL_REPLACEINTERNALDEV: 2730 case MDACIOCTL_CLEARCONF: 2731 case MDACIOCTL_GETCONTROLLERPARAMETER: 2732 case MDACIOCTL_SETCONTRLLERPARAMETER: 2733 case MDACIOCTL_CLEARCONFSUSPMODE: 2734 case MDACIOCTL_STOREIMAGE: 2735 case MDACIOCTL_READIMAGE: 2736 case MDACIOCTL_FLASHIMAGES: 2737 case MDACIOCTL_RENAMERAIDDEV: 2738 default: /* no idea what to print */ 2739 transfer = 0; 2740 break; 2741 } 2742 break; 2743 2744 case MDACMD_IOCTLCHECK: 2745 case MDACMD_MEMCOPY: 2746 default: 2747 transfer = 0; 2748 break; /* print nothing */ 2749 } 2750 if (transfer) { 2751 if (ge->command_control.extended_sg_table) { 2752 mly_printf(sc, " sg table 0x%llx/%d\n", 2753 ge->transfer.indirect.table_physaddr[0], ge->transfer.indirect.entries[0]); 2754 } else { 2755 mly_printf(sc, " 0000 0x%llx/%lld\n", 2756 ge->transfer.direct.sg[0].physaddr, ge->transfer.direct.sg[0].length); 2757 mly_printf(sc, " 0001 0x%llx/%lld\n", 2758 ge->transfer.direct.sg[1].physaddr, ge->transfer.direct.sg[1].length); 2759 } 2760 } 2761} 2762 2763/******************************************************************************** 2764 * Panic in a slightly informative fashion 2765 */ 2766static void 2767mly_panic(struct mly_softc *sc, char *reason) 2768{ 2769 mly_printstate(sc); 2770 panic(reason); 2771} 2772 2773/******************************************************************************** 2774 * Print queue statistics, callable from DDB. 2775 */ 2776void 2777mly_print_controller(int controller) 2778{ 2779 struct mly_softc *sc; 2780 2781 if ((sc = devclass_get_softc(devclass_find("mly"), controller)) == NULL) { 2782 printf("mly: controller %d invalid\n", controller); 2783 } else { 2784 device_printf(sc->mly_dev, "queue curr max\n"); 2785 device_printf(sc->mly_dev, "free %04d/%04d\n", 2786 sc->mly_qstat[MLYQ_FREE].q_length, sc->mly_qstat[MLYQ_FREE].q_max); 2787 device_printf(sc->mly_dev, "busy %04d/%04d\n", 2788 sc->mly_qstat[MLYQ_BUSY].q_length, sc->mly_qstat[MLYQ_BUSY].q_max); 2789 device_printf(sc->mly_dev, "complete %04d/%04d\n", 2790 sc->mly_qstat[MLYQ_COMPLETE].q_length, sc->mly_qstat[MLYQ_COMPLETE].q_max); 2791 } 2792} 2793#endif 2794 2795 2796/******************************************************************************** 2797 ******************************************************************************** 2798 Control device interface 2799 ******************************************************************************** 2800 ********************************************************************************/ 2801 2802/******************************************************************************** 2803 * Accept an open operation on the control device. 2804 */ 2805static int 2806mly_user_open(struct cdev *dev, int flags, int fmt, struct thread *td) 2807{ 2808 struct mly_softc *sc = dev->si_drv1; 2809 2810 sc->mly_state |= MLY_STATE_OPEN; 2811 return(0); 2812} 2813 2814/******************************************************************************** 2815 * Accept the last close on the control device. 2816 */ 2817static int 2818mly_user_close(struct cdev *dev, int flags, int fmt, struct thread *td) 2819{ 2820 struct mly_softc *sc = dev->si_drv1; 2821 2822 sc->mly_state &= ~MLY_STATE_OPEN; 2823 return (0); 2824} 2825 2826/******************************************************************************** 2827 * Handle controller-specific control operations. 2828 */ 2829static int 2830mly_user_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, 2831 int32_t flag, struct thread *td) 2832{ 2833 struct mly_softc *sc = (struct mly_softc *)dev->si_drv1; 2834 struct mly_user_command *uc = (struct mly_user_command *)addr; 2835 struct mly_user_health *uh = (struct mly_user_health *)addr; 2836 2837 switch(cmd) { 2838 case MLYIO_COMMAND: 2839 return(mly_user_command(sc, uc)); 2840 case MLYIO_HEALTH: 2841 return(mly_user_health(sc, uh)); 2842 default: 2843 return(ENOIOCTL); 2844 } 2845} 2846 2847/******************************************************************************** 2848 * Execute a command passed in from userspace. 2849 * 2850 * The control structure contains the actual command for the controller, as well 2851 * as the user-space data pointer and data size, and an optional sense buffer 2852 * size/pointer. On completion, the data size is adjusted to the command 2853 * residual, and the sense buffer size to the size of the returned sense data. 2854 * 2855 */ 2856static int 2857mly_user_command(struct mly_softc *sc, struct mly_user_command *uc) 2858{ 2859 struct mly_command *mc; 2860 int error, s; 2861 2862 /* allocate a command */ 2863 if (mly_alloc_command(sc, &mc)) { 2864 error = ENOMEM; 2865 goto out; /* XXX Linux version will wait for a command */ 2866 } 2867 2868 /* handle data size/direction */ 2869 mc->mc_length = (uc->DataTransferLength >= 0) ? uc->DataTransferLength : -uc->DataTransferLength; 2870 if (mc->mc_length > 0) { 2871 if ((mc->mc_data = malloc(mc->mc_length, M_DEVBUF, M_NOWAIT)) == NULL) { 2872 error = ENOMEM; 2873 goto out; 2874 } 2875 } 2876 if (uc->DataTransferLength > 0) { 2877 mc->mc_flags |= MLY_CMD_DATAIN; 2878 bzero(mc->mc_data, mc->mc_length); 2879 } 2880 if (uc->DataTransferLength < 0) { 2881 mc->mc_flags |= MLY_CMD_DATAOUT; 2882 if ((error = copyin(uc->DataTransferBuffer, mc->mc_data, mc->mc_length)) != 0) 2883 goto out; 2884 } 2885 2886 /* copy the controller command */ 2887 bcopy(&uc->CommandMailbox, mc->mc_packet, sizeof(uc->CommandMailbox)); 2888 2889 /* clear command completion handler so that we get woken up */ 2890 mc->mc_complete = NULL; 2891 2892 /* execute the command */ 2893 if ((error = mly_start(mc)) != 0) 2894 goto out; 2895 s = splcam(); 2896 while (!(mc->mc_flags & MLY_CMD_COMPLETE)) 2897 tsleep(mc, PRIBIO, "mlyioctl", 0); 2898 splx(s); 2899 2900 /* return the data to userspace */ 2901 if (uc->DataTransferLength > 0) 2902 if ((error = copyout(mc->mc_data, uc->DataTransferBuffer, mc->mc_length)) != 0) 2903 goto out; 2904 2905 /* return the sense buffer to userspace */ 2906 if ((uc->RequestSenseLength > 0) && (mc->mc_sense > 0)) { 2907 if ((error = copyout(mc->mc_packet, uc->RequestSenseBuffer, 2908 min(uc->RequestSenseLength, mc->mc_sense))) != 0) 2909 goto out; 2910 } 2911 2912 /* return command results to userspace (caller will copy out) */ 2913 uc->DataTransferLength = mc->mc_resid; 2914 uc->RequestSenseLength = min(uc->RequestSenseLength, mc->mc_sense); 2915 uc->CommandStatus = mc->mc_status; 2916 error = 0; 2917 2918 out: 2919 if (mc->mc_data != NULL) 2920 free(mc->mc_data, M_DEVBUF); 2921 if (mc != NULL) 2922 mly_release_command(mc); 2923 return(error); 2924} 2925 2926/******************************************************************************** 2927 * Return health status to userspace. If the health change index in the user 2928 * structure does not match that currently exported by the controller, we 2929 * return the current status immediately. Otherwise, we block until either 2930 * interrupted or new status is delivered. 2931 */ 2932static int 2933mly_user_health(struct mly_softc *sc, struct mly_user_health *uh) 2934{ 2935 struct mly_health_status mh; 2936 int error, s; 2937 2938 /* fetch the current health status from userspace */ 2939 if ((error = copyin(uh->HealthStatusBuffer, &mh, sizeof(mh))) != 0) 2940 return(error); 2941 2942 /* spin waiting for a status update */ 2943 s = splcam(); 2944 error = EWOULDBLOCK; 2945 while ((error != 0) && (sc->mly_event_change == mh.change_counter)) 2946 error = tsleep(&sc->mly_event_change, PRIBIO | PCATCH, "mlyhealth", 0); 2947 splx(s); 2948 2949 /* copy the controller's health status buffer out (there is a race here if it changes again) */ 2950 error = copyout(&sc->mly_mmbox->mmm_health.status, uh->HealthStatusBuffer, 2951 sizeof(uh->HealthStatusBuffer)); 2952 return(error); 2953} 2954 2955#ifdef MLY_DEBUG 2956static int 2957mly_timeout(struct mly_softc *sc) 2958{ 2959 struct mly_command *mc; 2960 int deadline; 2961 2962 deadline = time_second - MLY_CMD_TIMEOUT; 2963 TAILQ_FOREACH(mc, &sc->mly_busy, mc_link) { 2964 if ((mc->mc_timestamp < deadline)) { 2965 device_printf(sc->mly_dev, 2966 "COMMAND %p TIMEOUT AFTER %d SECONDS\n", mc, 2967 (int)(time_second - mc->mc_timestamp)); 2968 } 2969 } 2970 2971 timeout((timeout_t *)mly_timeout, sc, MLY_CMD_TIMEOUT * hz); 2972 2973 return (0); 2974} 2975#endif 2976