1 /*- 2 * Copyright (c) 2000 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: src/sys/dev/twe/twe.c,v 1.1.2.6 2002/03/07 09:57:02 msmith Exp $ 28 * $DragonFly: src/sys/dev/raid/twe/twe.c,v 1.5 2004/01/05 17:40:00 drhodus Exp $ 29 */ 30 31 /* 32 * Driver for the 3ware Escalade family of IDE RAID controllers. 33 */ 34 35 #include "twe_compat.h" 36 #include "twereg.h" 37 #include "tweio.h" 38 #include "twevar.h" 39 #define TWE_DEFINE_TABLES 40 #include "twe_tables.h" 41 42 /* 43 * Command submission. 44 */ 45 static int twe_get_param_1(struct twe_softc *sc, int table_id, int param_id, u_int8_t *result); 46 static int twe_get_param_2(struct twe_softc *sc, int table_id, int param_id, u_int16_t *result); 47 static int twe_get_param_4(struct twe_softc *sc, int table_id, int param_id, u_int32_t *result); 48 static void *twe_get_param(struct twe_softc *sc, int table_id, int parameter_id, size_t size, 49 void (* func)(struct twe_request *tr)); 50 #ifdef TWE_SHUTDOWN_NOTIFICATION 51 static int twe_set_param_1(struct twe_softc *sc, int table_id, int param_id, u_int8_t value); 52 #endif 53 #if 0 54 static int twe_set_param_2(struct twe_softc *sc, int table_id, int param_id, u_int16_t value); 55 static int twe_set_param_4(struct twe_softc *sc, int table_id, int param_id, u_int32_t value); 56 #endif 57 static int twe_set_param(struct twe_softc *sc, int table_id, int param_id, int param_size, 58 void *data); 59 static int twe_init_connection(struct twe_softc *sc, int mode); 60 static int twe_wait_request(struct twe_request *tr); 61 static int twe_immediate_request(struct twe_request *tr); 62 static void twe_completeio(struct twe_request *tr); 63 static void twe_reset(struct twe_softc *sc); 64 static void twe_add_unit(struct twe_softc *sc, int unit); 65 static void twe_del_unit(struct twe_softc *sc, int unit); 66 67 /* 68 * Command I/O to controller. 69 */ 70 static int twe_start(struct twe_request *tr); 71 static void twe_done(struct twe_softc *sc); 72 static void twe_complete(struct twe_softc *sc); 73 static int twe_wait_status(struct twe_softc *sc, u_int32_t status, int timeout); 74 static int twe_drain_response_queue(struct twe_softc *sc); 75 static int twe_check_bits(struct twe_softc *sc, u_int32_t status_reg); 76 static int twe_soft_reset(struct twe_softc *sc); 77 78 /* 79 * Interrupt handling. 80 */ 81 static void twe_host_intr(struct twe_softc *sc); 82 static void twe_attention_intr(struct twe_softc *sc); 83 static void twe_command_intr(struct twe_softc *sc); 84 85 /* 86 * Asynchronous event handling. 87 */ 88 static int twe_fetch_aen(struct twe_softc *sc); 89 static void twe_handle_aen(struct twe_request *tr); 90 static void twe_enqueue_aen(struct twe_softc *sc, u_int16_t aen); 91 static int twe_dequeue_aen(struct twe_softc *sc); 92 static int twe_drain_aen_queue(struct twe_softc *sc); 93 static int twe_find_aen(struct twe_softc *sc, u_int16_t aen); 94 95 /* 96 * Command buffer management. 97 */ 98 static int twe_get_request(struct twe_softc *sc, struct twe_request **tr); 99 static void twe_release_request(struct twe_request *tr); 100 101 /* 102 * Debugging. 103 */ 104 static char *twe_format_aen(struct twe_softc *sc, u_int16_t aen); 105 static int twe_report_request(struct twe_request *tr); 106 static void twe_panic(struct twe_softc *sc, char *reason); 107 108 /******************************************************************************** 109 ******************************************************************************** 110 Public Interfaces 111 ******************************************************************************** 112 ********************************************************************************/ 113 114 /******************************************************************************** 115 * Initialise the controller, set up driver data structures. 116 */ 117 int 118 twe_setup(struct twe_softc *sc) 119 { 120 struct twe_request *tr; 121 u_int32_t status_reg; 122 int i; 123 124 debug_called(4); 125 126 /* 127 * Initialise request queues. 128 */ 129 twe_initq_free(sc); 130 twe_initq_bio(sc); 131 twe_initq_ready(sc); 132 twe_initq_busy(sc); 133 twe_initq_complete(sc); 134 sc->twe_wait_aen = -1; 135 136 /* 137 * Allocate request structures up front. 138 */ 139 for (i = 0; i < TWE_Q_LENGTH; i++) { 140 if ((tr = twe_allocate_request(sc)) == NULL) 141 return(ENOMEM); 142 /* 143 * Set global defaults that won't change. 144 */ 145 tr->tr_command.generic.host_id = sc->twe_host_id; /* controller-assigned host ID */ 146 tr->tr_command.generic.request_id = i; /* our index number */ 147 sc->twe_lookup[i] = tr; 148 149 /* 150 * Put command onto the freelist. 151 */ 152 twe_release_request(tr); 153 } 154 155 /* 156 * Check status register for errors, clear them. 157 */ 158 status_reg = TWE_STATUS(sc); 159 twe_check_bits(sc, status_reg); 160 161 /* 162 * Wait for the controller to come ready. 163 */ 164 if (twe_wait_status(sc, TWE_STATUS_MICROCONTROLLER_READY, 60)) { 165 twe_printf(sc, "microcontroller not ready\n"); 166 return(ENXIO); 167 } 168 169 /* 170 * Disable interrupts from the card. 171 */ 172 twe_disable_interrupts(sc); 173 174 /* 175 * Soft reset the controller, look for the AEN acknowledging the reset, 176 * check for errors, drain the response queue. 177 */ 178 for (i = 0; i < TWE_MAX_RESET_TRIES; i++) { 179 180 if (i > 0) 181 twe_printf(sc, "reset %d failed, trying again\n", i); 182 183 if (!twe_soft_reset(sc)) 184 break; /* reset process complete */ 185 } 186 /* did we give up? */ 187 if (i >= TWE_MAX_RESET_TRIES) { 188 twe_printf(sc, "can't initialise controller, giving up\n"); 189 return(ENXIO); 190 } 191 192 return(0); 193 } 194 195 static void 196 twe_add_unit(struct twe_softc *sc, int unit) 197 { 198 struct twe_drive *dr; 199 int table; 200 u_int16_t dsize; 201 TWE_Param *drives = NULL, *param = NULL; 202 TWE_Unit_Descriptor *ud; 203 204 if (unit < 0 || unit > TWE_MAX_UNITS) 205 return; 206 207 /* 208 * The controller is in a safe state, so try to find drives attached to it. 209 */ 210 if ((drives = twe_get_param(sc, TWE_PARAM_UNITSUMMARY, TWE_PARAM_UNITSUMMARY_Status, 211 TWE_MAX_UNITS, NULL)) == NULL) { 212 twe_printf(sc, "can't detect attached units\n"); 213 return; 214 } 215 216 dr = &sc->twe_drive[unit]; 217 /* check that the drive is online */ 218 if (!(drives->data[unit] & TWE_PARAM_UNITSTATUS_Online)) 219 goto out; 220 221 table = TWE_PARAM_UNITINFO + unit; 222 223 if (twe_get_param_4(sc, table, TWE_PARAM_UNITINFO_Capacity, &dr->td_size)) { 224 twe_printf(sc, "error fetching capacity for unit %d\n", unit); 225 goto out; 226 } 227 if (twe_get_param_1(sc, table, TWE_PARAM_UNITINFO_Status, &dr->td_state)) { 228 twe_printf(sc, "error fetching state for unit %d\n", unit); 229 goto out; 230 } 231 if (twe_get_param_2(sc, table, TWE_PARAM_UNITINFO_DescriptorSize, &dsize)) { 232 twe_printf(sc, "error fetching descriptor size for unit %d\n", unit); 233 goto out; 234 } 235 if ((param = twe_get_param(sc, table, TWE_PARAM_UNITINFO_Descriptor, dsize - 3, NULL)) == NULL) { 236 twe_printf(sc, "error fetching descriptor for unit %d\n", unit); 237 goto out; 238 } 239 ud = (TWE_Unit_Descriptor *)param->data; 240 dr->td_type = ud->configuration; 241 242 /* build synthetic geometry as per controller internal rules */ 243 if (dr->td_size > 0x200000) { 244 dr->td_heads = 255; 245 dr->td_sectors = 63; 246 } else { 247 dr->td_heads = 64; 248 dr->td_sectors = 32; 249 } 250 dr->td_cylinders = dr->td_size / (dr->td_heads * dr->td_sectors); 251 dr->td_unit = unit; 252 253 twe_attach_drive(sc, dr); 254 255 out: 256 if (param != NULL) 257 free(param, M_DEVBUF); 258 if (drives != NULL) 259 free(drives, M_DEVBUF); 260 } 261 262 static void 263 twe_del_unit(struct twe_softc *sc, int unit) 264 { 265 266 if (unit < 0 || unit > TWE_MAX_UNITS) 267 return; 268 269 twe_detach_drive(sc, unit); 270 } 271 272 /******************************************************************************** 273 * Locate disk devices and attach children to them. 274 */ 275 void 276 twe_init(struct twe_softc *sc) 277 { 278 int i; 279 280 /* 281 * Scan for drives 282 */ 283 for (i = 0; i < TWE_MAX_UNITS; i++) 284 twe_add_unit(sc, i); 285 286 /* 287 * Initialise connection with controller. 288 */ 289 twe_init_connection(sc, TWE_INIT_MESSAGE_CREDITS); 290 291 #ifdef TWE_SHUTDOWN_NOTIFICATION 292 /* 293 * Tell the controller we support shutdown notification. 294 */ 295 twe_set_param_1(sc, TWE_PARAM_FEATURES, TWE_PARAM_FEATURES_DriverShutdown, 1); 296 #endif 297 298 /* 299 * Mark controller up and ready to run. 300 */ 301 sc->twe_state &= ~TWE_STATE_SHUTDOWN; 302 303 /* 304 * Finally enable interrupts. 305 */ 306 twe_enable_interrupts(sc); 307 } 308 309 /******************************************************************************** 310 * Stop the controller 311 */ 312 void 313 twe_deinit(struct twe_softc *sc) 314 { 315 /* 316 * Mark the controller as shutting down, and disable any further interrupts. 317 */ 318 sc->twe_state |= TWE_STATE_SHUTDOWN; 319 twe_disable_interrupts(sc); 320 321 #ifdef TWE_SHUTDOWN_NOTIFICATION 322 /* 323 * Disconnect from the controller 324 */ 325 twe_init_connection(sc, TWE_SHUTDOWN_MESSAGE_CREDITS); 326 #endif 327 } 328 329 /******************************************************************************* 330 * Take an interrupt, or be poked by other code to look for interrupt-worthy 331 * status. 332 */ 333 void 334 twe_intr(struct twe_softc *sc) 335 { 336 u_int32_t status_reg; 337 338 debug_called(4); 339 340 /* 341 * Collect current interrupt status. 342 */ 343 status_reg = TWE_STATUS(sc); 344 twe_check_bits(sc, status_reg); 345 346 /* 347 * Dispatch based on interrupt status 348 */ 349 if (status_reg & TWE_STATUS_HOST_INTERRUPT) 350 twe_host_intr(sc); 351 if (status_reg & TWE_STATUS_ATTENTION_INTERRUPT) 352 twe_attention_intr(sc); 353 if (status_reg & TWE_STATUS_COMMAND_INTERRUPT) 354 twe_command_intr(sc); 355 if (status_reg & TWE_STATUS_RESPONSE_INTERRUPT) 356 twe_done(sc); 357 }; 358 359 /******************************************************************************** 360 * Pull as much work off the softc's work queue as possible and give it to the 361 * controller. 362 */ 363 void 364 twe_startio(struct twe_softc *sc) 365 { 366 struct twe_request *tr; 367 TWE_Command *cmd; 368 twe_bio *bp; 369 int error; 370 371 debug_called(4); 372 373 /* spin until something prevents us from doing any work */ 374 for (;;) { 375 376 /* try to get a command that's already ready to go */ 377 tr = twe_dequeue_ready(sc); 378 379 /* build a command from an outstanding bio */ 380 if (tr == NULL) { 381 382 /* see if there's work to be done */ 383 if ((bp = twe_dequeue_bio(sc)) == NULL) 384 break; 385 386 /* get a command to handle the bio with */ 387 if (twe_get_request(sc, &tr)) { 388 twe_enqueue_bio(sc, bp); /* failed, put the bio back */ 389 break; 390 } 391 392 /* connect the bio to the command */ 393 tr->tr_complete = twe_completeio; 394 tr->tr_private = bp; 395 tr->tr_data = TWE_BIO_DATA(bp); 396 tr->tr_length = TWE_BIO_LENGTH(bp); 397 cmd = &tr->tr_command; 398 if (TWE_BIO_IS_READ(bp)) { 399 tr->tr_flags |= TWE_CMD_DATAIN; 400 cmd->io.opcode = TWE_OP_READ; 401 } else { 402 tr->tr_flags |= TWE_CMD_DATAOUT; 403 cmd->io.opcode = TWE_OP_WRITE; 404 } 405 406 /* build a suitable I/O command (assumes 512-byte rounded transfers) */ 407 cmd->io.size = 3; 408 cmd->io.unit = TWE_BIO_UNIT(bp); 409 cmd->io.block_count = (tr->tr_length + TWE_BLOCK_SIZE - 1) / TWE_BLOCK_SIZE; 410 cmd->io.lba = TWE_BIO_LBA(bp); 411 412 /* map the command so the controller can work with it */ 413 twe_map_request(tr); 414 } 415 416 /* did we find something to do? */ 417 if (tr == NULL) 418 break; 419 420 /* try to give command to controller */ 421 error = twe_start(tr); 422 423 if (error != 0) { 424 if (error == EBUSY) { 425 twe_requeue_ready(tr); /* try it again later */ 426 break; /* don't try anything more for now */ 427 } 428 /* we don't support any other return from twe_start */ 429 twe_panic(sc, "twe_start returned nonsense"); 430 } 431 } 432 } 433 434 /******************************************************************************** 435 * Write blocks from memory to disk, for system crash dumps. 436 */ 437 int 438 twe_dump_blocks(struct twe_softc *sc, int unit, u_int32_t lba, void *data, int nblks) 439 { 440 struct twe_request *tr; 441 TWE_Command *cmd; 442 int error; 443 444 if (twe_get_request(sc, &tr)) 445 return(ENOMEM); 446 447 tr->tr_data = data; 448 tr->tr_status = TWE_CMD_SETUP; 449 tr->tr_length = nblks * TWE_BLOCK_SIZE; 450 tr->tr_flags = TWE_CMD_DATAOUT; 451 452 cmd = &tr->tr_command; 453 cmd->io.opcode = TWE_OP_WRITE; 454 cmd->io.size = 3; 455 cmd->io.unit = unit; 456 cmd->io.block_count = nblks; 457 cmd->io.lba = lba; 458 459 twe_map_request(tr); 460 error = twe_immediate_request(tr); 461 if (error == 0) 462 if (twe_report_request(tr)) 463 error = EIO; 464 twe_release_request(tr); 465 return(error); 466 } 467 468 /******************************************************************************** 469 * Handle controller-specific control operations. 470 */ 471 int 472 twe_ioctl(struct twe_softc *sc, int cmd, void *addr) 473 { 474 struct twe_usercommand *tu = (struct twe_usercommand *)addr; 475 struct twe_paramcommand *tp = (struct twe_paramcommand *)addr; 476 struct twe_drivecommand *td = (struct twe_drivecommand *)addr; 477 union twe_statrequest *ts = (union twe_statrequest *)addr; 478 TWE_Param *param; 479 void *data; 480 int *arg = (int *)addr; 481 struct twe_request *tr; 482 u_int8_t srid; 483 int s, error; 484 485 error = 0; 486 switch(cmd) { 487 /* handle a command from userspace */ 488 case TWEIO_COMMAND: 489 /* get a request */ 490 while (twe_get_request(sc, &tr)) 491 tsleep(NULL, PPAUSE, "twioctl", hz); 492 493 /* 494 * Save the command's request ID, copy the user-supplied command in, 495 * restore the request ID. 496 */ 497 srid = tr->tr_command.generic.request_id; 498 bcopy(&tu->tu_command, &tr->tr_command, sizeof(TWE_Command)); 499 tr->tr_command.generic.request_id = srid; 500 501 /* 502 * if there's a data buffer, allocate and copy it in. 503 * Must be in multipled of 512 bytes. 504 */ 505 tr->tr_length = (tu->tu_size + 511) & ~511; 506 if (tr->tr_length > 0) { 507 if ((tr->tr_data = malloc(tr->tr_length, M_DEVBUF, M_WAITOK)) == NULL) { 508 error = ENOMEM; 509 goto cmd_done; 510 } 511 if ((error = copyin(tu->tu_data, tr->tr_data, tu->tu_size)) != 0) 512 goto cmd_done; 513 tr->tr_flags |= TWE_CMD_DATAIN | TWE_CMD_DATAOUT; 514 } 515 516 /* run the command */ 517 twe_map_request(tr); 518 twe_wait_request(tr); 519 520 /* copy the command out again */ 521 bcopy(&tr->tr_command, &tu->tu_command, sizeof(TWE_Command)); 522 523 /* if there was a data buffer, copy it out */ 524 if (tr->tr_length > 0) 525 error = copyout(tr->tr_data, tu->tu_data, tu->tu_size); 526 527 cmd_done: 528 /* free resources */ 529 if (tr->tr_data != NULL) 530 free(tr->tr_data, M_DEVBUF); 531 if (tr != NULL) 532 twe_release_request(tr); 533 534 break; 535 536 /* fetch statistics counter */ 537 case TWEIO_STATS: 538 switch (ts->ts_item) { 539 #ifdef TWE_PERFORMANCE_MONITOR 540 case TWEQ_FREE: 541 case TWEQ_BIO: 542 case TWEQ_READY: 543 case TWEQ_BUSY: 544 case TWEQ_COMPLETE: 545 bcopy(&sc->twe_qstat[ts->ts_item], &ts->ts_qstat, sizeof(struct twe_qstat)); 546 break; 547 #endif 548 default: 549 error = ENOENT; 550 break; 551 } 552 break; 553 554 /* poll for an AEN */ 555 case TWEIO_AEN_POLL: 556 *arg = twe_dequeue_aen(sc); 557 break; 558 559 /* wait for another AEN to show up */ 560 case TWEIO_AEN_WAIT: 561 s = splbio(); 562 while ((*arg = twe_dequeue_aen(sc)) == TWE_AEN_QUEUE_EMPTY) { 563 error = tsleep(&sc->twe_aen_queue, PRIBIO | PCATCH, "tweaen", 0); 564 if (error == EINTR) 565 break; 566 } 567 splx(s); 568 break; 569 570 case TWEIO_GET_PARAM: 571 if ((param = twe_get_param(sc, tp->tp_table_id, tp->tp_param_id, tp->tp_size, NULL)) == NULL) { 572 twe_printf(sc, "TWEIO_GET_PARAM failed for 0x%x/0x%x/%d\n", 573 tp->tp_table_id, tp->tp_param_id, tp->tp_size); 574 error = EINVAL; 575 } else { 576 if (param->parameter_size_bytes > tp->tp_size) { 577 twe_printf(sc, "TWEIO_GET_PARAM parameter too large (%d > %d)\n", 578 param->parameter_size_bytes, tp->tp_size); 579 error = EFAULT; 580 } else { 581 error = copyout(param->data, tp->tp_data, param->parameter_size_bytes); 582 } 583 free(param, M_DEVBUF); 584 } 585 break; 586 587 case TWEIO_SET_PARAM: 588 if ((data = malloc(tp->tp_size, M_DEVBUF, M_WAITOK)) == NULL) { 589 error = ENOMEM; 590 } else { 591 error = copyin(tp->tp_data, data, tp->tp_size); 592 if (error == 0) 593 error = twe_set_param(sc, tp->tp_table_id, tp->tp_param_id, tp->tp_size, data); 594 free(data, M_DEVBUF); 595 } 596 break; 597 598 case TWEIO_RESET: 599 twe_reset(sc); 600 break; 601 602 case TWEIO_ADD_UNIT: 603 twe_add_unit(sc, td->td_unit); 604 break; 605 606 case TWEIO_DEL_UNIT: 607 twe_del_unit(sc, td->td_unit); 608 break; 609 610 /* XXX implement ATA PASSTHROUGH */ 611 612 /* nothing we understand */ 613 default: 614 error = ENOTTY; 615 } 616 617 return(error); 618 } 619 620 /******************************************************************************** 621 * Enable the useful interrupts from the controller. 622 */ 623 void 624 twe_enable_interrupts(struct twe_softc *sc) 625 { 626 sc->twe_state |= TWE_STATE_INTEN; 627 TWE_CONTROL(sc, 628 TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT | 629 TWE_CONTROL_UNMASK_RESPONSE_INTERRUPT | 630 TWE_CONTROL_ENABLE_INTERRUPTS); 631 } 632 633 /******************************************************************************** 634 * Disable interrupts from the controller. 635 */ 636 void 637 twe_disable_interrupts(struct twe_softc *sc) 638 { 639 TWE_CONTROL(sc, TWE_CONTROL_DISABLE_INTERRUPTS); 640 sc->twe_state &= ~TWE_STATE_INTEN; 641 } 642 643 /******************************************************************************** 644 ******************************************************************************** 645 Command Submission 646 ******************************************************************************** 647 ********************************************************************************/ 648 649 /******************************************************************************** 650 * Read integer parameter table entries. 651 */ 652 static int 653 twe_get_param_1(struct twe_softc *sc, int table_id, int param_id, u_int8_t *result) 654 { 655 TWE_Param *param; 656 657 if ((param = twe_get_param(sc, table_id, param_id, 1, NULL)) == NULL) 658 return(ENOENT); 659 *result = *(u_int8_t *)param->data; 660 free(param, M_DEVBUF); 661 return(0); 662 } 663 664 static int 665 twe_get_param_2(struct twe_softc *sc, int table_id, int param_id, u_int16_t *result) 666 { 667 TWE_Param *param; 668 669 if ((param = twe_get_param(sc, table_id, param_id, 2, NULL)) == NULL) 670 return(ENOENT); 671 *result = *(u_int16_t *)param->data; 672 free(param, M_DEVBUF); 673 return(0); 674 } 675 676 static int 677 twe_get_param_4(struct twe_softc *sc, int table_id, int param_id, u_int32_t *result) 678 { 679 TWE_Param *param; 680 681 if ((param = twe_get_param(sc, table_id, param_id, 4, NULL)) == NULL) 682 return(ENOENT); 683 *result = *(u_int32_t *)param->data; 684 free(param, M_DEVBUF); 685 return(0); 686 } 687 688 /******************************************************************************** 689 * Perform a TWE_OP_GET_PARAM command. If a callback function is provided, it 690 * will be called with the command when it's completed. If no callback is 691 * provided, we will wait for the command to complete and then return just the data. 692 * The caller is responsible for freeing the data when done with it. 693 */ 694 static void * 695 twe_get_param(struct twe_softc *sc, int table_id, int param_id, size_t param_size, 696 void (* func)(struct twe_request *tr)) 697 { 698 struct twe_request *tr; 699 TWE_Command *cmd; 700 TWE_Param *param; 701 int error; 702 703 debug_called(4); 704 705 tr = NULL; 706 param = NULL; 707 708 /* get a command */ 709 if (twe_get_request(sc, &tr)) 710 goto err; 711 712 /* get a buffer */ 713 if ((param = (TWE_Param *)malloc(TWE_SECTOR_SIZE, M_DEVBUF, M_NOWAIT)) == NULL) 714 goto err; 715 tr->tr_data = param; 716 tr->tr_length = TWE_SECTOR_SIZE; 717 tr->tr_flags = TWE_CMD_DATAIN | TWE_CMD_DATAOUT; 718 719 /* build the command for the controller */ 720 cmd = &tr->tr_command; 721 cmd->param.opcode = TWE_OP_GET_PARAM; 722 cmd->param.size = 2; 723 cmd->param.unit = 0; 724 cmd->param.param_count = 1; 725 726 /* map the command/data into controller-visible space */ 727 twe_map_request(tr); 728 729 /* fill in the outbound parameter data */ 730 param->table_id = table_id; 731 param->parameter_id = param_id; 732 param->parameter_size_bytes = param_size; 733 734 /* submit the command and either wait or let the callback handle it */ 735 if (func == NULL) { 736 /* XXX could use twe_wait_request here if interrupts were enabled? */ 737 error = twe_immediate_request(tr); 738 if (error == 0) { 739 if (twe_report_request(tr)) 740 goto err; 741 } 742 twe_release_request(tr); 743 return(param); 744 } else { 745 tr->tr_complete = func; 746 error = twe_start(tr); 747 if (error == 0) 748 return(func); 749 } 750 751 /* something failed */ 752 err: 753 debug(1, "failed"); 754 if (tr != NULL) 755 twe_release_request(tr); 756 if (param != NULL) 757 free(param, M_DEVBUF); 758 return(NULL); 759 } 760 761 /******************************************************************************** 762 * Set integer parameter table entries. 763 */ 764 #ifdef TWE_SHUTDOWN_NOTIFICATION 765 static int 766 twe_set_param_1(struct twe_softc *sc, int table_id, int param_id, u_int8_t value) 767 { 768 return(twe_set_param(sc, table_id, param_id, sizeof(value), &value)); 769 } 770 #endif 771 772 #if 0 773 static int 774 twe_set_param_2(struct twe_softc *sc, int table_id, int param_id, u_int16_t value) 775 { 776 return(twe_set_param(sc, table_id, param_id, sizeof(value), &value)); 777 } 778 779 static int 780 twe_set_param_4(struct twe_softc *sc, int table_id, int param_id, u_int32_t value) 781 { 782 return(twe_set_param(sc, table_id, param_id, sizeof(value), &value)); 783 } 784 #endif 785 786 /******************************************************************************** 787 * Perform a TWE_OP_SET_PARAM command, returns nonzero on error. 788 */ 789 static int 790 twe_set_param(struct twe_softc *sc, int table_id, int param_id, int param_size, void *data) 791 { 792 struct twe_request *tr; 793 TWE_Command *cmd; 794 TWE_Param *param; 795 int error; 796 797 debug_called(4); 798 799 tr = NULL; 800 param = NULL; 801 error = ENOMEM; 802 803 /* get a command */ 804 if (twe_get_request(sc, &tr)) 805 goto out; 806 807 /* get a buffer */ 808 if ((param = (TWE_Param *)malloc(TWE_SECTOR_SIZE, M_DEVBUF, M_NOWAIT)) == NULL) 809 goto out; 810 tr->tr_data = param; 811 tr->tr_length = TWE_SECTOR_SIZE; 812 tr->tr_flags = TWE_CMD_DATAIN | TWE_CMD_DATAOUT; 813 814 /* build the command for the controller */ 815 cmd = &tr->tr_command; 816 cmd->param.opcode = TWE_OP_SET_PARAM; 817 cmd->param.size = 2; 818 cmd->param.unit = 0; 819 cmd->param.param_count = 1; 820 821 /* map the command/data into controller-visible space */ 822 twe_map_request(tr); 823 824 /* fill in the outbound parameter data */ 825 param->table_id = table_id; 826 param->parameter_id = param_id; 827 param->parameter_size_bytes = param_size; 828 bcopy(data, param->data, param_size); 829 830 /* XXX could use twe_wait_request here if interrupts were enabled? */ 831 error = twe_immediate_request(tr); 832 if (error == 0) { 833 if (twe_report_request(tr)) 834 error = EIO; 835 } 836 837 out: 838 if (tr != NULL) 839 twe_release_request(tr); 840 if (param != NULL) 841 free(param, M_DEVBUF); 842 return(error); 843 } 844 845 /******************************************************************************** 846 * Perform a TWE_OP_INIT_CONNECTION command, returns nonzero on error. 847 * 848 * Typically called with interrupts disabled. 849 */ 850 static int 851 twe_init_connection(struct twe_softc *sc, int mode) 852 { 853 struct twe_request *tr; 854 TWE_Command *cmd; 855 int error; 856 857 debug_called(4); 858 859 /* get a command */ 860 if (twe_get_request(sc, &tr)) 861 return(NULL); 862 863 /* build the command */ 864 cmd = &tr->tr_command; 865 cmd->initconnection.opcode = TWE_OP_INIT_CONNECTION; 866 cmd->initconnection.size = 3; 867 cmd->initconnection.host_id = 0; 868 cmd->initconnection.message_credits = mode; 869 cmd->initconnection.response_queue_pointer = 0; 870 871 /* map the command into controller-visible space */ 872 twe_map_request(tr); 873 874 /* submit the command */ 875 error = twe_immediate_request(tr); 876 /* XXX check command result? */ 877 twe_unmap_request(tr); 878 twe_release_request(tr); 879 880 if (mode == TWE_INIT_MESSAGE_CREDITS) 881 sc->twe_host_id = cmd->initconnection.host_id; 882 return(error); 883 } 884 885 /******************************************************************************** 886 * Start the command (tr) and sleep waiting for it to complete. 887 * 888 * Successfully completed commands are dequeued. 889 */ 890 static int 891 twe_wait_request(struct twe_request *tr) 892 { 893 int s; 894 895 debug_called(4); 896 897 tr->tr_flags |= TWE_CMD_SLEEPER; 898 tr->tr_status = TWE_CMD_BUSY; 899 twe_enqueue_ready(tr); 900 twe_startio(tr->tr_sc); 901 s = splbio(); 902 while (tr->tr_status == TWE_CMD_BUSY) 903 tsleep(tr, PRIBIO, "twewait", 0); 904 splx(s); 905 906 return(0); 907 } 908 909 /******************************************************************************** 910 * Start the command (tr) and busy-wait for it to complete. 911 * This should only be used when interrupts are actually disabled (although it 912 * will work if they are not). 913 */ 914 static int 915 twe_immediate_request(struct twe_request *tr) 916 { 917 int error; 918 919 debug_called(4); 920 921 error = 0; 922 923 if ((error = twe_start(tr)) != 0) 924 return(error); 925 while (tr->tr_status == TWE_CMD_BUSY){ 926 twe_done(tr->tr_sc); 927 } 928 return(tr->tr_status != TWE_CMD_COMPLETE); 929 } 930 931 /******************************************************************************** 932 * Handle completion of an I/O command. 933 */ 934 static void 935 twe_completeio(struct twe_request *tr) 936 { 937 struct twe_softc *sc = tr->tr_sc; 938 twe_bio *bp = (twe_bio *)tr->tr_private; 939 940 debug_called(4); 941 942 if (tr->tr_status == TWE_CMD_COMPLETE) { 943 944 if (twe_report_request(tr)) 945 TWE_BIO_SET_ERROR(bp, EIO); 946 947 } else { 948 twe_panic(sc, "twe_completeio on incomplete command"); 949 } 950 tr->tr_private = NULL; 951 twed_intr(bp); 952 twe_release_request(tr); 953 } 954 955 /******************************************************************************** 956 * Reset the controller and pull all the active commands back onto the ready 957 * queue. Used to restart a controller that's exhibiting bad behaviour. 958 */ 959 static void 960 twe_reset(struct twe_softc *sc) 961 { 962 struct twe_request *tr; 963 int i, s; 964 965 /* 966 * Sleep for a short period to allow AENs to be signalled. 967 */ 968 tsleep(NULL, PRIBIO, "twereset", hz); 969 970 /* 971 * Disable interrupts from the controller, and mask any accidental entry 972 * into our interrupt handler. 973 */ 974 twe_printf(sc, "controller reset in progress...\n"); 975 twe_disable_interrupts(sc); 976 s = splbio(); 977 978 /* 979 * Try to soft-reset the controller. 980 */ 981 for (i = 0; i < TWE_MAX_RESET_TRIES; i++) { 982 983 if (i > 0) 984 twe_printf(sc, "reset %d failed, trying again\n", i); 985 986 if (!twe_soft_reset(sc)) 987 break; /* reset process complete */ 988 } 989 /* did we give up? */ 990 if (i >= TWE_MAX_RESET_TRIES) { 991 twe_printf(sc, "can't reset controller, giving up\n"); 992 goto out; 993 } 994 995 /* 996 * Move all of the commands that were busy back to the ready queue. 997 */ 998 i = 0; 999 while ((tr = twe_dequeue_busy(sc)) != NULL) { 1000 twe_enqueue_ready(tr); 1001 i++; 1002 } 1003 1004 /* 1005 * Kick the controller to start things going again, then re-enable interrupts. 1006 */ 1007 twe_startio(sc); 1008 twe_enable_interrupts(sc); 1009 twe_printf(sc, "controller reset done, %d commands restarted\n", i); 1010 1011 out: 1012 splx(s); 1013 twe_enable_interrupts(sc); 1014 } 1015 1016 /******************************************************************************** 1017 ******************************************************************************** 1018 Command I/O to Controller 1019 ******************************************************************************** 1020 ********************************************************************************/ 1021 1022 /******************************************************************************** 1023 * Try to deliver (tr) to the controller. 1024 * 1025 * Can be called at any interrupt level, with or without interrupts enabled. 1026 */ 1027 static int 1028 twe_start(struct twe_request *tr) 1029 { 1030 struct twe_softc *sc = tr->tr_sc; 1031 int i, s, done; 1032 u_int32_t status_reg; 1033 1034 debug_called(4); 1035 1036 /* mark the command as currently being processed */ 1037 tr->tr_status = TWE_CMD_BUSY; 1038 1039 /* 1040 * Spin briefly waiting for the controller to come ready 1041 * 1042 * XXX it might be more efficient to return EBUSY immediately 1043 * and let the command be rescheduled. 1044 */ 1045 for (i = 100000, done = 0; (i > 0) && !done; i--) { 1046 s = splbio(); 1047 1048 /* check to see if we can post a command */ 1049 status_reg = TWE_STATUS(sc); 1050 twe_check_bits(sc, status_reg); 1051 1052 if (!(status_reg & TWE_STATUS_COMMAND_QUEUE_FULL)) { 1053 TWE_COMMAND_QUEUE(sc, tr->tr_cmdphys); 1054 done = 1; 1055 /* move command to work queue */ 1056 twe_enqueue_busy(tr); 1057 #ifdef TWE_DEBUG 1058 if (tr->tr_complete != NULL) { 1059 debug(3, "queued request %d with callback %p", tr->tr_command.generic.request_id, tr->tr_complete); 1060 } else if (tr->tr_flags & TWE_CMD_SLEEPER) { 1061 debug(3, "queued request %d with wait channel %p", tr->tr_command.generic.request_id, tr); 1062 } else { 1063 debug(3, "queued request %d for polling caller", tr->tr_command.generic.request_id); 1064 } 1065 #endif 1066 } 1067 splx(s); /* drop spl to allow completion interrupts */ 1068 } 1069 1070 /* command is enqueued */ 1071 if (done) 1072 return(0); 1073 1074 /* 1075 * We couldn't get the controller to take the command; try submitting it again later. 1076 * This should only happen if something is wrong with the controller, or if we have 1077 * overestimated the number of commands it can accept. (Should we actually reject 1078 * the command at this point?) 1079 */ 1080 return(EBUSY); 1081 } 1082 1083 /******************************************************************************** 1084 * Poll the controller (sc) for completed commands. 1085 * 1086 * Can be called at any interrupt level, with or without interrupts enabled. 1087 */ 1088 static void 1089 twe_done(struct twe_softc *sc) 1090 { 1091 TWE_Response_Queue rq; 1092 struct twe_request *tr; 1093 int s, found; 1094 u_int32_t status_reg; 1095 1096 debug_called(5); 1097 1098 /* loop collecting completed commands */ 1099 found = 0; 1100 s = splbio(); 1101 for (;;) { 1102 status_reg = TWE_STATUS(sc); 1103 twe_check_bits(sc, status_reg); /* XXX should this fail? */ 1104 1105 if (!(status_reg & TWE_STATUS_RESPONSE_QUEUE_EMPTY)) { 1106 found = 1; 1107 rq = TWE_RESPONSE_QUEUE(sc); 1108 tr = sc->twe_lookup[rq.u.response_id]; /* find command */ 1109 if (tr->tr_status != TWE_CMD_BUSY) 1110 twe_printf(sc, "completion event for nonbusy command\n"); 1111 tr->tr_status = TWE_CMD_COMPLETE; 1112 debug(3, "completed request id %d with status %d", 1113 tr->tr_command.generic.request_id, tr->tr_command.generic.status); 1114 /* move to completed queue */ 1115 twe_remove_busy(tr); 1116 twe_enqueue_complete(tr); 1117 } else { 1118 break; /* no response ready */ 1119 } 1120 } 1121 splx(s); 1122 1123 /* if we've completed any commands, try posting some more */ 1124 if (found) 1125 twe_startio(sc); 1126 1127 /* handle completion and timeouts */ 1128 twe_complete(sc); /* XXX use deferred completion? */ 1129 } 1130 1131 /******************************************************************************** 1132 * Perform post-completion processing for commands on (sc). 1133 * 1134 * This is split from twe_done as it can be safely deferred and run at a lower 1135 * priority level should facilities for such a thing become available. 1136 */ 1137 static void 1138 twe_complete(struct twe_softc *sc) 1139 { 1140 struct twe_request *tr; 1141 1142 debug_called(5); 1143 1144 /* 1145 * Pull commands off the completed list, dispatch them appropriately 1146 */ 1147 while ((tr = twe_dequeue_complete(sc)) != NULL) { 1148 1149 /* unmap the command's data buffer */ 1150 twe_unmap_request(tr); 1151 1152 /* dispatch to suit command originator */ 1153 if (tr->tr_complete != NULL) { /* completion callback */ 1154 debug(2, "call completion handler %p", tr->tr_complete); 1155 tr->tr_complete(tr); 1156 1157 } else if (tr->tr_flags & TWE_CMD_SLEEPER) { /* caller is asleep waiting */ 1158 debug(2, "wake up command owner on %p", tr); 1159 wakeup_one(tr); 1160 1161 } else { /* caller is polling command */ 1162 debug(2, "command left for owner"); 1163 } 1164 } 1165 } 1166 1167 /******************************************************************************** 1168 * Wait for (status) to be set in the controller status register for up to 1169 * (timeout) seconds. Returns 0 if found, nonzero if we time out. 1170 * 1171 * Note: this busy-waits, rather than sleeping, since we may be called with 1172 * eg. clock interrupts masked. 1173 */ 1174 static int 1175 twe_wait_status(struct twe_softc *sc, u_int32_t status, int timeout) 1176 { 1177 time_t expiry; 1178 u_int32_t status_reg; 1179 1180 debug_called(4); 1181 1182 expiry = time_second + timeout; 1183 1184 do { 1185 status_reg = TWE_STATUS(sc); 1186 if (status_reg & status) /* got the required bit(s)? */ 1187 return(0); 1188 DELAY(100000); 1189 } while (time_second <= expiry); 1190 1191 return(1); 1192 } 1193 1194 /******************************************************************************** 1195 * Drain the response queue, which may contain responses to commands we know 1196 * nothing about. 1197 */ 1198 static int 1199 twe_drain_response_queue(struct twe_softc *sc) 1200 { 1201 TWE_Response_Queue rq; 1202 u_int32_t status_reg; 1203 1204 debug_called(4); 1205 1206 for (;;) { /* XXX give up eventually? */ 1207 status_reg = TWE_STATUS(sc); 1208 if (twe_check_bits(sc, status_reg)) 1209 return(1); 1210 if (status_reg & TWE_STATUS_RESPONSE_QUEUE_EMPTY) 1211 return(0); 1212 rq = TWE_RESPONSE_QUEUE(sc); 1213 } 1214 } 1215 1216 /******************************************************************************** 1217 * Soft-reset the controller 1218 */ 1219 static int 1220 twe_soft_reset(struct twe_softc *sc) 1221 { 1222 u_int32_t status_reg; 1223 1224 debug_called(2); 1225 1226 TWE_SOFT_RESET(sc); 1227 1228 if (twe_wait_status(sc, TWE_STATUS_ATTENTION_INTERRUPT, 30)) { 1229 twe_printf(sc, "no attention interrupt\n"); 1230 return(1); 1231 } 1232 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT); 1233 if (twe_drain_aen_queue(sc)) { 1234 twe_printf(sc, "can't drain AEN queue\n"); 1235 return(1); 1236 } 1237 if (twe_find_aen(sc, TWE_AEN_SOFT_RESET)) { 1238 twe_printf(sc, "reset not reported\n"); 1239 return(1); 1240 } 1241 status_reg = TWE_STATUS(sc); 1242 if (TWE_STATUS_ERRORS(status_reg) || twe_check_bits(sc, status_reg)) { 1243 twe_printf(sc, "controller errors detected\n"); 1244 return(1); 1245 } 1246 if (twe_drain_response_queue(sc)) { 1247 twe_printf(sc, "can't drain response queue\n"); 1248 return(1); 1249 } 1250 return(0); 1251 } 1252 1253 /******************************************************************************** 1254 ******************************************************************************** 1255 Interrupt Handling 1256 ******************************************************************************** 1257 ********************************************************************************/ 1258 1259 /******************************************************************************** 1260 * Host interrupt. 1261 * 1262 * XXX what does this mean? 1263 */ 1264 static void 1265 twe_host_intr(struct twe_softc *sc) 1266 { 1267 debug_called(4); 1268 1269 twe_printf(sc, "host interrupt\n"); 1270 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_HOST_INTERRUPT); 1271 } 1272 1273 /******************************************************************************** 1274 * Attention interrupt. 1275 * 1276 * Signalled when the controller has one or more AENs for us. 1277 */ 1278 static void 1279 twe_attention_intr(struct twe_softc *sc) 1280 { 1281 debug_called(4); 1282 1283 /* instigate a poll for AENs */ 1284 if (twe_fetch_aen(sc)) { 1285 twe_printf(sc, "error polling for signalled AEN\n"); 1286 } else { 1287 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT); 1288 } 1289 } 1290 1291 /******************************************************************************** 1292 * Command interrupt. 1293 * 1294 * Signalled when the controller can handle more commands. 1295 */ 1296 static void 1297 twe_command_intr(struct twe_softc *sc) 1298 { 1299 debug_called(4); 1300 1301 /* 1302 * We don't use this, rather we try to submit commands when we receive 1303 * them, and when other commands have completed. Mask it so we don't get 1304 * another one. 1305 */ 1306 twe_printf(sc, "command interrupt\n"); 1307 TWE_CONTROL(sc, TWE_CONTROL_MASK_COMMAND_INTERRUPT); 1308 } 1309 1310 /******************************************************************************** 1311 ******************************************************************************** 1312 Asynchronous Event Handling 1313 ******************************************************************************** 1314 ********************************************************************************/ 1315 1316 /******************************************************************************** 1317 * Request an AEN from the controller. 1318 */ 1319 static int 1320 twe_fetch_aen(struct twe_softc *sc) 1321 { 1322 1323 debug_called(4); 1324 1325 if ((twe_get_param(sc, TWE_PARAM_AEN, TWE_PARAM_AEN_UnitCode, 2, twe_handle_aen)) == NULL) 1326 return(EIO); 1327 return(0); 1328 } 1329 1330 /******************************************************************************** 1331 * Handle an AEN returned by the controller. 1332 */ 1333 static void 1334 twe_handle_aen(struct twe_request *tr) 1335 { 1336 struct twe_softc *sc = tr->tr_sc; 1337 TWE_Param *param; 1338 u_int16_t aen; 1339 1340 debug_called(4); 1341 1342 /* XXX check for command success somehow? */ 1343 1344 param = (TWE_Param *)tr->tr_data; 1345 aen = *(u_int16_t *)(param->data); 1346 1347 free(tr->tr_data, M_DEVBUF); 1348 twe_release_request(tr); 1349 twe_enqueue_aen(sc, aen); 1350 1351 /* XXX poll for more AENs? */ 1352 } 1353 1354 /******************************************************************************** 1355 * Pull AENs out of the controller and park them in the queue, in a context where 1356 * interrupts aren't active. Return nonzero if we encounter any errors in the 1357 * process of obtaining all the available AENs. 1358 */ 1359 static int 1360 twe_drain_aen_queue(struct twe_softc *sc) 1361 { 1362 u_int16_t aen; 1363 1364 for (;;) { 1365 if (twe_get_param_2(sc, TWE_PARAM_AEN, TWE_PARAM_AEN_UnitCode, &aen)) 1366 return(1); 1367 if (aen == TWE_AEN_QUEUE_EMPTY) 1368 return(0); 1369 twe_enqueue_aen(sc, aen); 1370 } 1371 } 1372 1373 /******************************************************************************** 1374 * Push an AEN that we've received onto the queue. 1375 * 1376 * Note that we have to lock this against reentrance, since it may be called 1377 * from both interrupt and non-interrupt context. 1378 * 1379 * If someone is waiting for the AEN we have, wake them up. 1380 */ 1381 static void 1382 twe_enqueue_aen(struct twe_softc *sc, u_int16_t aen) 1383 { 1384 char *msg; 1385 int s, next, nextnext; 1386 1387 debug_called(4); 1388 1389 if ((msg = twe_format_aen(sc, aen)) != NULL) 1390 twe_printf(sc, "AEN: <%s>\n", msg); 1391 1392 s = splbio(); 1393 /* enqueue the AEN */ 1394 next = ((sc->twe_aen_head + 1) % TWE_Q_LENGTH); 1395 nextnext = ((sc->twe_aen_head + 2) % TWE_Q_LENGTH); 1396 1397 /* check to see if this is the last free slot, and subvert the AEN if it is */ 1398 if (nextnext == sc->twe_aen_tail) 1399 aen = TWE_AEN_QUEUE_FULL; 1400 1401 /* look to see if there's room for this AEN */ 1402 if (next != sc->twe_aen_tail) { 1403 sc->twe_aen_queue[sc->twe_aen_head] = aen; 1404 sc->twe_aen_head = next; 1405 } 1406 1407 /* wake up anyone asleep on the queue */ 1408 wakeup(&sc->twe_aen_queue); 1409 1410 /* anyone looking for this AEN? */ 1411 if (sc->twe_wait_aen == aen) { 1412 sc->twe_wait_aen = -1; 1413 wakeup(&sc->twe_wait_aen); 1414 } 1415 splx(s); 1416 } 1417 1418 /******************************************************************************** 1419 * Pop an AEN off the queue, or return -1 if there are none left. 1420 * 1421 * We are more or less interrupt-safe, so don't block interrupts. 1422 */ 1423 static int 1424 twe_dequeue_aen(struct twe_softc *sc) 1425 { 1426 int result; 1427 1428 debug_called(4); 1429 1430 if (sc->twe_aen_tail == sc->twe_aen_head) { 1431 result = TWE_AEN_QUEUE_EMPTY; 1432 } else { 1433 result = sc->twe_aen_queue[sc->twe_aen_tail]; 1434 sc->twe_aen_tail = ((sc->twe_aen_tail + 1) % TWE_Q_LENGTH); 1435 } 1436 return(result); 1437 } 1438 1439 /******************************************************************************** 1440 * Check to see if the requested AEN is in the queue. 1441 * 1442 * XXX we could probably avoid masking interrupts here 1443 */ 1444 static int 1445 twe_find_aen(struct twe_softc *sc, u_int16_t aen) 1446 { 1447 int i, s, missing; 1448 1449 missing = 1; 1450 s = splbio(); 1451 for (i = sc->twe_aen_tail; (i != sc->twe_aen_head) && missing; i = (i + 1) % TWE_Q_LENGTH) { 1452 if (sc->twe_aen_queue[i] == aen) 1453 missing = 0; 1454 } 1455 splx(s); 1456 return(missing); 1457 } 1458 1459 1460 #if 0 /* currently unused */ 1461 /******************************************************************************** 1462 * Sleep waiting for at least (timeout) seconds until we see (aen) as 1463 * requested. Returns nonzero on timeout or failure. 1464 * 1465 * XXX: this should not be used in cases where there may be more than one sleeper 1466 * without a mechanism for registering multiple sleepers. 1467 */ 1468 static int 1469 twe_wait_aen(struct twe_softc *sc, int aen, int timeout) 1470 { 1471 time_t expiry; 1472 int found, s; 1473 1474 debug_called(4); 1475 1476 expiry = time_second + timeout; 1477 found = 0; 1478 1479 s = splbio(); 1480 sc->twe_wait_aen = aen; 1481 do { 1482 twe_fetch_aen(sc); 1483 tsleep(&sc->twe_wait_aen, PZERO, "twewaen", hz); 1484 if (sc->twe_wait_aen == -1) 1485 found = 1; 1486 } while ((time_second <= expiry) && !found); 1487 splx(s); 1488 return(!found); 1489 } 1490 #endif 1491 1492 /******************************************************************************** 1493 ******************************************************************************** 1494 Command Buffer Management 1495 ******************************************************************************** 1496 ********************************************************************************/ 1497 1498 /******************************************************************************** 1499 * Get a new command buffer. 1500 * 1501 * This will return NULL if all command buffers are in use. 1502 */ 1503 static int 1504 twe_get_request(struct twe_softc *sc, struct twe_request **tr) 1505 { 1506 debug_called(4); 1507 1508 /* try to reuse an old buffer */ 1509 *tr = twe_dequeue_free(sc); 1510 1511 /* initialise some fields to their defaults */ 1512 if (*tr != NULL) { 1513 (*tr)->tr_data = NULL; 1514 (*tr)->tr_private = NULL; 1515 (*tr)->tr_status = TWE_CMD_SETUP; /* command is in setup phase */ 1516 (*tr)->tr_flags = 0; 1517 (*tr)->tr_complete = NULL; 1518 (*tr)->tr_command.generic.status = 0; /* before submission to controller */ 1519 (*tr)->tr_command.generic.flags = 0; /* not used */ 1520 } 1521 return(*tr == NULL); 1522 } 1523 1524 /******************************************************************************** 1525 * Release a command buffer for reuse. 1526 * 1527 */ 1528 static void 1529 twe_release_request(struct twe_request *tr) 1530 { 1531 debug_called(4); 1532 1533 if (tr->tr_private != NULL) 1534 twe_panic(tr->tr_sc, "tr_private != NULL"); 1535 twe_enqueue_free(tr); 1536 } 1537 1538 /******************************************************************************** 1539 ******************************************************************************** 1540 Debugging 1541 ******************************************************************************** 1542 ********************************************************************************/ 1543 1544 /******************************************************************************** 1545 * Print some information about the controller 1546 */ 1547 void 1548 twe_describe_controller(struct twe_softc *sc) 1549 { 1550 TWE_Param *p[6]; 1551 u_int8_t ports; 1552 u_int32_t size; 1553 int i; 1554 1555 debug_called(2); 1556 1557 /* get the port count */ 1558 twe_get_param_1(sc, TWE_PARAM_CONTROLLER, TWE_PARAM_CONTROLLER_PortCount, &ports); 1559 1560 /* get version strings */ 1561 p[0] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_Mon, 16, NULL); 1562 p[1] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_FW, 16, NULL); 1563 p[2] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_BIOS, 16, NULL); 1564 p[3] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_PCB, 8, NULL); 1565 p[4] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_ATA, 8, NULL); 1566 p[5] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_PCI, 8, NULL); 1567 1568 twe_printf(sc, "%d ports, Firmware %.16s, BIOS %.16s\n", ports, p[1]->data, p[2]->data); 1569 if (bootverbose) 1570 twe_printf(sc, "Monitor %.16s, PCB %.8s, Achip %.8s, Pchip %.8s\n", p[0]->data, p[3]->data, 1571 p[4]->data, p[5]->data); 1572 free(p[0], M_DEVBUF); 1573 free(p[1], M_DEVBUF); 1574 free(p[2], M_DEVBUF); 1575 free(p[3], M_DEVBUF); 1576 free(p[4], M_DEVBUF); 1577 free(p[5], M_DEVBUF); 1578 1579 /* print attached drives */ 1580 if (bootverbose) { 1581 p[0] = twe_get_param(sc, TWE_PARAM_DRIVESUMMARY, TWE_PARAM_DRIVESUMMARY_Status, 16, NULL); 1582 for (i = 0; i < ports; i++) { 1583 if (p[0]->data[i] != TWE_PARAM_DRIVESTATUS_Present) 1584 continue; 1585 twe_get_param_4(sc, TWE_PARAM_DRIVEINFO + i, TWE_PARAM_DRIVEINFO_Size, &size); 1586 p[1] = twe_get_param(sc, TWE_PARAM_DRIVEINFO + i, TWE_PARAM_DRIVEINFO_Model, 40, NULL); 1587 if (p[1] != NULL) { 1588 twe_printf(sc, "port %d: %.40s %dMB\n", i, p[1]->data, size / 2048); 1589 free(p[1], M_DEVBUF); 1590 } else { 1591 twe_printf(sc, "port %d, drive status unavailable\n", i); 1592 } 1593 } 1594 free(p[0], M_DEVBUF); 1595 } 1596 } 1597 1598 /******************************************************************************** 1599 * Complain if the status bits aren't what we're expecting. 1600 * 1601 * Rate-limit the complaints to at most one of each every five seconds, but 1602 * always return the correct status. 1603 */ 1604 static int 1605 twe_check_bits(struct twe_softc *sc, u_int32_t status_reg) 1606 { 1607 int result; 1608 static time_t lastwarn[2] = {0, 0}; 1609 1610 /* 1611 * This can be a little problematic, as twe_panic may call twe_reset if 1612 * TWE_DEBUG is not set, which will call us again as part of the soft reset. 1613 */ 1614 if ((status_reg & TWE_STATUS_PANIC_BITS) != 0) { 1615 twe_printf(sc, "FATAL STATUS BIT(S) %b\n", status_reg & TWE_STATUS_PANIC_BITS, 1616 TWE_STATUS_BITS_DESCRIPTION); 1617 twe_panic(sc, "fatal status bits"); 1618 } 1619 1620 result = 0; 1621 if ((status_reg & TWE_STATUS_EXPECTED_BITS) != TWE_STATUS_EXPECTED_BITS) { 1622 if (time_second > (lastwarn[0] + 5)) { 1623 twe_printf(sc, "missing expected status bit(s) %b\n", ~status_reg & TWE_STATUS_EXPECTED_BITS, 1624 TWE_STATUS_BITS_DESCRIPTION); 1625 lastwarn[0] = time_second; 1626 } 1627 result = 1; 1628 } 1629 1630 if ((status_reg & TWE_STATUS_UNEXPECTED_BITS) != 0) { 1631 if (time_second > (lastwarn[1] + 5)) { 1632 twe_printf(sc, "unexpected status bit(s) %b\n", status_reg & TWE_STATUS_UNEXPECTED_BITS, 1633 TWE_STATUS_BITS_DESCRIPTION); 1634 lastwarn[1] = time_second; 1635 } 1636 result = 1; 1637 if (status_reg & TWE_STATUS_PCI_PARITY_ERROR) { 1638 twe_printf(sc, "PCI parity error: Reseat card, move card or buggy device present."); 1639 twe_clear_pci_parity_error(sc); 1640 } 1641 if (status_reg & TWE_STATUS_PCI_ABORT) { 1642 twe_printf(sc, "PCI abort, clearing."); 1643 twe_clear_pci_abort(sc); 1644 } 1645 } 1646 1647 return(result); 1648 } 1649 1650 /******************************************************************************** 1651 * Return a string describing (aen). 1652 * 1653 * The low 8 bits of the aen are the code, the high 8 bits give the unit number 1654 * where an AEN is specific to a unit. 1655 * 1656 * Note that we could expand this routine to handle eg. up/downgrading the status 1657 * of a drive if we had some idea of what the drive's initial status was. 1658 */ 1659 1660 static char * 1661 twe_format_aen(struct twe_softc *sc, u_int16_t aen) 1662 { 1663 static char buf[80]; 1664 device_t child; 1665 char *code, *msg; 1666 1667 code = twe_describe_code(twe_table_aen, TWE_AEN_CODE(aen)); 1668 msg = code + 2; 1669 1670 switch (*code) { 1671 case 'q': 1672 if (!bootverbose) 1673 return(NULL); 1674 /* FALLTHROUGH */ 1675 case 'a': 1676 return(msg); 1677 1678 case 'c': 1679 if ((child = sc->twe_drive[TWE_AEN_UNIT(aen)].td_disk) != NULL) { 1680 sprintf(buf, "twed%d: %s", device_get_unit(child), msg); 1681 } else { 1682 sprintf(buf, "twe%d: %s for unknown unit %d", device_get_unit(sc->twe_dev), 1683 msg, TWE_AEN_UNIT(aen)); 1684 } 1685 return(buf); 1686 1687 case 'p': 1688 sprintf(buf, "twe%d: port %d: %s", device_get_unit(sc->twe_dev), TWE_AEN_UNIT(aen), 1689 msg); 1690 return(buf); 1691 1692 1693 case 'x': 1694 default: 1695 break; 1696 } 1697 sprintf(buf, "unknown AEN 0x%x", aen); 1698 return(buf); 1699 } 1700 1701 /******************************************************************************** 1702 * Print a diagnostic if the status of the command warrants it, and return 1703 * either zero (command was ok) or nonzero (command failed). 1704 */ 1705 static int 1706 twe_report_request(struct twe_request *tr) 1707 { 1708 struct twe_softc *sc = tr->tr_sc; 1709 TWE_Command *cmd = &tr->tr_command; 1710 int result = 0; 1711 1712 /* 1713 * Check the command status value and handle accordingly. 1714 */ 1715 if (cmd->generic.status == TWE_STATUS_RESET) { 1716 /* 1717 * The status code 0xff requests a controller reset. 1718 */ 1719 twe_printf(sc, "command returned with controller rest request\n"); 1720 twe_reset(sc); 1721 result = 1; 1722 } else if (cmd->generic.status > TWE_STATUS_FATAL) { 1723 /* 1724 * Fatal errors that don't require controller reset. 1725 * 1726 * We know a few special flags values. 1727 */ 1728 switch (cmd->generic.flags) { 1729 case 0x1b: 1730 device_printf(sc->twe_drive[cmd->generic.unit].td_disk, 1731 "drive timeout"); 1732 break; 1733 case 0x51: 1734 device_printf(sc->twe_drive[cmd->generic.unit].td_disk, 1735 "unrecoverable drive error"); 1736 break; 1737 default: 1738 device_printf(sc->twe_drive[cmd->generic.unit].td_disk, 1739 "controller error - %s (flags = 0x%x)\n", 1740 twe_describe_code(twe_table_status, cmd->generic.status), 1741 cmd->generic.flags); 1742 result = 1; 1743 } 1744 } else if (cmd->generic.status > TWE_STATUS_WARNING) { 1745 /* 1746 * Warning level status. 1747 */ 1748 device_printf(sc->twe_drive[cmd->generic.unit].td_disk, 1749 "warning - %s (flags = 0x%x)\n", 1750 twe_describe_code(twe_table_status, cmd->generic.status), 1751 cmd->generic.flags); 1752 } else if (cmd->generic.status > 0x40) { 1753 /* 1754 * Info level status. 1755 */ 1756 device_printf(sc->twe_drive[cmd->generic.unit].td_disk, 1757 "attention - %s (flags = 0x%x)\n", 1758 twe_describe_code(twe_table_status, cmd->generic.status), 1759 cmd->generic.flags); 1760 } 1761 1762 return(result); 1763 } 1764 1765 /******************************************************************************** 1766 * Print some controller state to aid in debugging error/panic conditions 1767 */ 1768 void 1769 twe_print_controller(struct twe_softc *sc) 1770 { 1771 u_int32_t status_reg; 1772 1773 status_reg = TWE_STATUS(sc); 1774 twe_printf(sc, "status %b\n", status_reg, TWE_STATUS_BITS_DESCRIPTION); 1775 twe_printf(sc, " current max\n"); 1776 twe_printf(sc, "free %04d %04d\n", sc->twe_qstat[TWEQ_FREE].q_length, sc->twe_qstat[TWEQ_FREE].q_max); 1777 twe_printf(sc, "ready %04d %04d\n", sc->twe_qstat[TWEQ_READY].q_length, sc->twe_qstat[TWEQ_READY].q_max); 1778 twe_printf(sc, "busy %04d %04d\n", sc->twe_qstat[TWEQ_BUSY].q_length, sc->twe_qstat[TWEQ_BUSY].q_max); 1779 twe_printf(sc, "complete %04d %04d\n", sc->twe_qstat[TWEQ_COMPLETE].q_length, sc->twe_qstat[TWEQ_COMPLETE].q_max); 1780 twe_printf(sc, "bioq %04d %04d\n", sc->twe_qstat[TWEQ_BIO].q_length, sc->twe_qstat[TWEQ_BIO].q_max); 1781 twe_printf(sc, "AEN queue head %d tail %d\n", sc->twe_aen_head, sc->twe_aen_tail); 1782 } 1783 1784 static void 1785 twe_panic(struct twe_softc *sc, char *reason) 1786 { 1787 twe_print_controller(sc); 1788 #ifdef TWE_DEBUG 1789 panic(reason); 1790 #else 1791 twe_reset(sc); 1792 #endif 1793 } 1794 1795 #if 0 1796 /******************************************************************************** 1797 * Print a request/command in human-readable format. 1798 */ 1799 static void 1800 twe_print_request(struct twe_request *tr) 1801 { 1802 struct twe_softc *sc = tr->tr_sc; 1803 TWE_Command *cmd = &tr->tr_command; 1804 int i; 1805 1806 twe_printf(sc, "CMD: request_id %d opcode <%s> size %d unit %d host_id %d\n", 1807 cmd->generic.request_id, twe_describe_code(twe_table_opcode, cmd->generic.opcode), cmd->generic.size, 1808 cmd->generic.unit, cmd->generic.host_id); 1809 twe_printf(sc, " status %d flags 0x%x count %d sgl_offset %d\n", 1810 cmd->generic.status, cmd->generic.flags, cmd->generic.count, cmd->generic.sgl_offset); 1811 1812 switch(cmd->generic.opcode) { /* XXX add more opcodes? */ 1813 case TWE_OP_READ: 1814 case TWE_OP_WRITE: 1815 twe_printf(sc, " lba %d\n", cmd->io.lba); 1816 for (i = 0; (i < TWE_MAX_SGL_LENGTH) && (cmd->io.sgl[i].length != 0); i++) 1817 twe_printf(sc, " %d: 0x%x/%d\n", 1818 i, cmd->io.sgl[i].address, cmd->io.sgl[i].length); 1819 break; 1820 1821 case TWE_OP_GET_PARAM: 1822 case TWE_OP_SET_PARAM: 1823 for (i = 0; (i < TWE_MAX_SGL_LENGTH) && (cmd->param.sgl[i].length != 0); i++) 1824 twe_printf(sc, " %d: 0x%x/%d\n", 1825 i, cmd->param.sgl[i].address, cmd->param.sgl[i].length); 1826 break; 1827 1828 case TWE_OP_INIT_CONNECTION: 1829 twe_printf(sc, " response queue pointer 0x%x\n", 1830 cmd->initconnection.response_queue_pointer); 1831 break; 1832 1833 default: 1834 break; 1835 } 1836 twe_printf(sc, " tr_command %p/0x%x tr_data %p/0x%x,%d\n", 1837 tr, tr->tr_cmdphys, tr->tr_data, tr->tr_dataphys, tr->tr_length); 1838 twe_printf(sc, " tr_status %d tr_flags 0x%x tr_complete %p tr_private %p\n", 1839 tr->tr_status, tr->tr_flags, tr->tr_complete, tr->tr_private); 1840 } 1841 1842 #endif 1843