sys/dev/raid/twe/twe.c

   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.11 2005/06/26 22:03:29 dillon 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             /* get a command to handle the bio with */
 383             if (twe_get_request(sc, &tr))
 384                 break;
 385
 386             /* see if there's work to be done */
 387             if ((bp = twe_dequeue_bio(sc)) == NULL) {
 388                 twe_release_request(tr);
 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                         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(sc, 0, "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         crit_enter();
 562         while ((*arg = twe_dequeue_aen(sc)) == TWE_AEN_QUEUE_EMPTY) {
 563             error = tsleep(&sc->twe_aen_queue, 0 | PCATCH, "tweaen", 0);
 564             if (error == EINTR)
 565                 break;
 566         }
 567         crit_exit();
 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     param = malloc(TWE_SECTOR_SIZE, M_DEVBUF, M_INTWAIT);
 714     tr->tr_data = param;
 715     tr->tr_length = TWE_SECTOR_SIZE;
 716     tr->tr_flags = TWE_CMD_DATAIN | TWE_CMD_DATAOUT;
 717
 718     /* build the command for the controller */
 719     cmd = &tr->tr_command;
 720     cmd->param.opcode = TWE_OP_GET_PARAM;
 721     cmd->param.size = 2;
 722     cmd->param.unit = 0;
 723     cmd->param.param_count = 1;
 724
 725     /* map the command/data into controller-visible space */
 726     twe_map_request(tr);
 727
 728     /* fill in the outbound parameter data */
 729     param->table_id = table_id;
 730     param->parameter_id = param_id;
 731     param->parameter_size_bytes = param_size;
 732
 733     /* submit the command and either wait or let the callback handle it */
 734     if (func == NULL) {
 735         /* XXX could use twe_wait_request here if interrupts were enabled? */
 736         error = twe_immediate_request(tr);
 737         if (error == 0) {
 738             if (twe_report_request(tr))
 739                 goto err;
 740         }
 741         twe_release_request(tr);
 742         return(param);
 743     } else {
 744         tr->tr_complete = func;
 745         error = twe_start(tr);
 746         if (error == 0)
 747             return(func);
 748     }
 749
 750     /* something failed */
 751 err:
 752     debug(1, "failed");
 753     if (tr != NULL)
 754         twe_release_request(tr);
 755     if (param != NULL)
 756         free(param, M_DEVBUF);
 757     return(NULL);
 758 }
 759
 760 /********************************************************************************
 761  * Set integer parameter table entries.
 762  */
 763 #ifdef TWE_SHUTDOWN_NOTIFICATION
 764 static int
 765 twe_set_param_1(struct twe_softc *sc, int table_id, int param_id, u_int8_t value)
 766 {
 767     return(twe_set_param(sc, table_id, param_id, sizeof(value), &value));
 768 }
 769 #endif
 770
 771 #if 0
 772 static int
 773 twe_set_param_2(struct twe_softc *sc, int table_id, int param_id, u_int16_t value)
 774 {
 775     return(twe_set_param(sc, table_id, param_id, sizeof(value), &value));
 776 }
 777
 778 static int
 779 twe_set_param_4(struct twe_softc *sc, int table_id, int param_id, u_int32_t value)
 780 {
 781     return(twe_set_param(sc, table_id, param_id, sizeof(value), &value));
 782 }
 783 #endif
 784
 785 /********************************************************************************
 786  * Perform a TWE_OP_SET_PARAM command, returns nonzero on error.
 787  */
 788 static int
 789 twe_set_param(struct twe_softc *sc, int table_id, int param_id, int param_size, void *data)
 790 {
 791     struct twe_request  *tr;
 792     TWE_Command         *cmd;
 793     TWE_Param           *param;
 794     int                 error;
 795
 796     debug_called(4);
 797
 798     tr = NULL;
 799     param = NULL;
 800     error = ENOMEM;
 801
 802     /* get a command */
 803     if (twe_get_request(sc, &tr))
 804         goto out;
 805
 806     /* get a buffer */
 807     param = malloc(TWE_SECTOR_SIZE, M_DEVBUF, M_INTWAIT);
 808     tr->tr_data = param;
 809     tr->tr_length = TWE_SECTOR_SIZE;
 810     tr->tr_flags = TWE_CMD_DATAIN | TWE_CMD_DATAOUT;
 811
 812     /* build the command for the controller */
 813     cmd = &tr->tr_command;
 814     cmd->param.opcode = TWE_OP_SET_PARAM;
 815     cmd->param.size = 2;
 816     cmd->param.unit = 0;
 817     cmd->param.param_count = 1;
 818
 819     /* map the command/data into controller-visible space */
 820     twe_map_request(tr);
 821
 822     /* fill in the outbound parameter data */
 823     param->table_id = table_id;
 824     param->parameter_id = param_id;
 825     param->parameter_size_bytes = param_size;
 826     bcopy(data, param->data, param_size);
 827
 828     /* XXX could use twe_wait_request here if interrupts were enabled? */
 829     error = twe_immediate_request(tr);
 830     if (error == 0) {
 831         if (twe_report_request(tr))
 832             error = EIO;
 833     }
 834
 835 out:
 836     if (tr != NULL)
 837         twe_release_request(tr);
 838     if (param != NULL)
 839         free(param, M_DEVBUF);
 840     return(error);
 841 }
 842
 843 /********************************************************************************
 844  * Perform a TWE_OP_INIT_CONNECTION command, returns nonzero on error.
 845  *
 846  * Typically called with interrupts disabled.
 847  */
 848 static int
 849 twe_init_connection(struct twe_softc *sc, int mode)
 850 {
 851     struct twe_request  *tr;
 852     TWE_Command         *cmd;
 853     int                 error;
 854
 855     debug_called(4);
 856
 857     /* get a command */
 858     if (twe_get_request(sc, &tr))
 859         return(NULL);
 860
 861     /* build the command */
 862     cmd = &tr->tr_command;
 863     cmd->initconnection.opcode = TWE_OP_INIT_CONNECTION;
 864     cmd->initconnection.size = 3;
 865     cmd->initconnection.host_id = 0;
 866     cmd->initconnection.message_credits = mode;
 867     cmd->initconnection.response_queue_pointer = 0;
 868
 869     /* map the command into controller-visible space */
 870     twe_map_request(tr);
 871
 872     /* submit the command */
 873     error = twe_immediate_request(tr);
 874     /* XXX check command result? */
 875     twe_unmap_request(tr);
 876     twe_release_request(tr);
 877
 878     if (mode == TWE_INIT_MESSAGE_CREDITS)
 879         sc->twe_host_id = cmd->initconnection.host_id;
 880     return(error);
 881 }
 882
 883 /********************************************************************************
 884  * Start the command (tr) and sleep waiting for it to complete.
 885  *
 886  * Successfully completed commands are dequeued.
 887  */
 888 static int
 889 twe_wait_request(struct twe_request *tr)
 890 {
 891     debug_called(4);
 892
 893     tr->tr_flags |= TWE_CMD_SLEEPER;
 894     tr->tr_status = TWE_CMD_BUSY;
 895     twe_enqueue_ready(tr);
 896     twe_startio(tr->tr_sc);
 897     crit_enter();
 898     while (tr->tr_status == TWE_CMD_BUSY)
 899         tsleep(tr, 0, "twewait", 0);
 900     crit_exit();
 901
 902     return(0);
 903 }
 904
 905 /********************************************************************************
 906  * Start the command (tr) and busy-wait for it to complete.
 907  * This should only be used when interrupts are actually disabled (although it
 908  * will work if they are not).
 909  */
 910 static int
 911 twe_immediate_request(struct twe_request *tr)
 912 {
 913     int         error;
 914
 915     debug_called(4);
 916
 917     error = 0;
 918
 919     if ((error = twe_start(tr)) != 0)
 920         return(error);
 921     while (tr->tr_status == TWE_CMD_BUSY){
 922         twe_done(tr->tr_sc);
 923     }
 924     return(tr->tr_status != TWE_CMD_COMPLETE);
 925 }
 926
 927 /********************************************************************************
 928  * Handle completion of an I/O command.
 929  */
 930 static void
 931 twe_completeio(struct twe_request *tr)
 932 {
 933     struct twe_softc    *sc = tr->tr_sc;
 934     twe_bio             *bp = (twe_bio *)tr->tr_private;
 935
 936     debug_called(4);
 937
 938     if (tr->tr_status == TWE_CMD_COMPLETE) {
 939
 940         if (twe_report_request(tr))
 941             TWE_BIO_SET_ERROR(bp, EIO);
 942
 943     } else {
 944         twe_panic(sc, "twe_completeio on incomplete command");
 945     }
 946     tr->tr_private = NULL;
 947     twed_intr(bp);
 948     twe_release_request(tr);
 949 }
 950
 951 /********************************************************************************
 952  * Reset the controller and pull all the active commands back onto the ready
 953  * queue.  Used to restart a controller that's exhibiting bad behaviour.
 954  */
 955 static void
 956 twe_reset(struct twe_softc *sc)
 957 {
 958     struct twe_request  *tr;
 959     int                 i;
 960
 961     /*
 962      * Sleep for a short period to allow AENs to be signalled.
 963      */
 964     tsleep(sc, 0, "twereset", hz);
 965
 966     /*
 967      * Disable interrupts from the controller, and mask any accidental entry
 968      * into our interrupt handler.
 969      */
 970     twe_printf(sc, "controller reset in progress...\n");
 971     twe_disable_interrupts(sc);
 972     crit_enter();
 973
 974     /*
 975      * Try to soft-reset the controller.
 976      */
 977     for (i = 0; i < TWE_MAX_RESET_TRIES; i++) {
 978
 979         if (i > 0)
 980             twe_printf(sc, "reset %d failed, trying again\n", i);
 981
 982         if (!twe_soft_reset(sc))
 983             break;                      /* reset process complete */
 984     }
 985     /* did we give up? */
 986     if (i >= TWE_MAX_RESET_TRIES) {
 987         twe_printf(sc, "can't reset controller, giving up\n");
 988         goto out;
 989     }
 990
 991     /*
 992      * Move all of the commands that were busy back to the ready queue.
 993      */
 994     i = 0;
 995     while ((tr = twe_dequeue_busy(sc)) != NULL) {
 996         twe_enqueue_ready(tr);
 997         i++;
 998     }
 999
1000     /*
1001      * Kick the controller to start things going again, then re-enable interrupts.
1002      */
1003     twe_startio(sc);
1004     twe_enable_interrupts(sc);
1005     twe_printf(sc, "controller reset done, %d commands restarted\n", i);
1006
1007 out:
1008     crit_exit();
1009     twe_enable_interrupts(sc);
1010 }
1011
1012 /********************************************************************************
1013  ********************************************************************************
1014                                                         Command I/O to Controller
1015  ********************************************************************************
1016  ********************************************************************************/
1017
1018 /********************************************************************************
1019  * Try to deliver (tr) to the controller.
1020  *
1021  * Can be called at any interrupt level, with or without interrupts enabled.
1022  */
1023 static int
1024 twe_start(struct twe_request *tr)
1025 {
1026     struct twe_softc    *sc = tr->tr_sc;
1027     int                 i, done;
1028     u_int32_t           status_reg;
1029
1030     debug_called(4);
1031
1032     /* mark the command as currently being processed */
1033     tr->tr_status = TWE_CMD_BUSY;
1034
1035     /*
1036      * Spin briefly waiting for the controller to come ready
1037      *
1038      * XXX it might be more efficient to return EBUSY immediately
1039      *     and let the command be rescheduled.
1040      */
1041     for (i = 100000, done = 0; (i > 0) && !done; i--) {
1042         crit_enter();
1043
1044         /* check to see if we can post a command */
1045         status_reg = TWE_STATUS(sc);
1046         twe_check_bits(sc, status_reg);
1047
1048         if (!(status_reg & TWE_STATUS_COMMAND_QUEUE_FULL)) {
1049             /* move command to work queue */
1050             twe_enqueue_busy(tr);
1051             TWE_COMMAND_QUEUE(sc, tr->tr_cmdphys);
1052             done = 1;
1053 #ifdef TWE_DEBUG
1054             if (tr->tr_complete != NULL) {
1055                 debug(3, "queued request %d with callback %p", tr->tr_command.generic.request_id, tr->tr_complete);
1056             } else if (tr->tr_flags & TWE_CMD_SLEEPER) {
1057                 debug(3, "queued request %d with wait channel %p", tr->tr_command.generic.request_id, tr);
1058             } else {
1059                 debug(3, "queued request %d for polling caller", tr->tr_command.generic.request_id);
1060             }
1061 #endif
1062         }
1063         crit_exit();    /* drop spl to allow completion interrupts */
1064     }
1065
1066     /* command is enqueued */
1067     if (done)
1068         return(0);
1069
1070     /*
1071      * We couldn't get the controller to take the command; try submitting it again later.
1072      * This should only happen if something is wrong with the controller, or if we have
1073      * overestimated the number of commands it can accept.  (Should we actually reject
1074      * the command at this point?)
1075      */
1076     return(EBUSY);
1077 }
1078
1079 /********************************************************************************
1080  * Poll the controller (sc) for completed commands.
1081  *
1082  * Can be called at any interrupt level, with or without interrupts enabled.
1083  */
1084 static void
1085 twe_done(struct twe_softc *sc)
1086 {
1087     TWE_Response_Queue  rq;
1088     struct twe_request  *tr;
1089     int                 found;
1090     u_int32_t           status_reg;
1091
1092     debug_called(5);
1093
1094     /* loop collecting completed commands */
1095     found = 0;
1096     crit_enter();
1097     for (;;) {
1098         status_reg = TWE_STATUS(sc);
1099         twe_check_bits(sc, status_reg);         /* XXX should this fail? */
1100
1101         if (!(status_reg & TWE_STATUS_RESPONSE_QUEUE_EMPTY)) {
1102             found = 1;
1103             rq = TWE_RESPONSE_QUEUE(sc);
1104             tr = sc->twe_lookup[rq.u.response_id];      /* find command */
1105             if (tr->tr_status != TWE_CMD_BUSY)
1106                 twe_printf(sc, "completion event for nonbusy command\n");
1107             tr->tr_status = TWE_CMD_COMPLETE;
1108             debug(3, "completed request id %d with status %d",
1109                   tr->tr_command.generic.request_id, tr->tr_command.generic.status);
1110             /* move to completed queue */
1111             twe_remove_busy(tr);
1112             twe_enqueue_complete(tr);
1113         } else {
1114             break;                                      /* no response ready */
1115         }
1116     }
1117     crit_exit();
1118
1119     /* if we've completed any commands, try posting some more */
1120     if (found)
1121         twe_startio(sc);
1122
1123     /* handle completion and timeouts */
1124     twe_complete(sc);           /* XXX use deferred completion? */
1125 }
1126
1127 /********************************************************************************
1128  * Perform post-completion processing for commands on (sc).
1129  *
1130  * This is split from twe_done as it can be safely deferred and run at a lower
1131  * priority level should facilities for such a thing become available.
1132  */
1133 static void
1134 twe_complete(struct twe_softc *sc)
1135 {
1136     struct twe_request  *tr;
1137
1138     debug_called(5);
1139
1140     /*
1141      * Pull commands off the completed list, dispatch them appropriately
1142      */
1143     while ((tr = twe_dequeue_complete(sc)) != NULL) {
1144
1145         /* unmap the command's data buffer */
1146         twe_unmap_request(tr);
1147
1148         /* dispatch to suit command originator */
1149         if (tr->tr_complete != NULL) {          /* completion callback */
1150             debug(2, "call completion handler %p", tr->tr_complete);
1151             tr->tr_complete(tr);
1152
1153         } else if (tr->tr_flags & TWE_CMD_SLEEPER) {    /* caller is asleep waiting */
1154             debug(2, "wake up command owner on %p", tr);
1155             wakeup_one(tr);
1156
1157         } else {                                        /* caller is polling command */
1158             debug(2, "command left for owner");
1159         }
1160     }
1161 }
1162
1163 /********************************************************************************
1164  * Wait for (status) to be set in the controller status register for up to
1165  * (timeout) seconds.  Returns 0 if found, nonzero if we time out.
1166  *
1167  * Note: this busy-waits, rather than sleeping, since we may be called with
1168  * eg. clock interrupts masked.
1169  */
1170 static int
1171 twe_wait_status(struct twe_softc *sc, u_int32_t status, int timeout)
1172 {
1173     time_t      expiry;
1174     u_int32_t   status_reg;
1175
1176     debug_called(4);
1177
1178     expiry = time_second + timeout;
1179
1180     do {
1181         status_reg = TWE_STATUS(sc);
1182         if (status_reg & status)        /* got the required bit(s)? */
1183             return(0);
1184         DELAY(100000);
1185     } while (time_second <= expiry);
1186
1187     return(1);
1188 }
1189
1190 /********************************************************************************
1191  * Drain the response queue, which may contain responses to commands we know
1192  * nothing about.
1193  */
1194 static int
1195 twe_drain_response_queue(struct twe_softc *sc)
1196 {
1197     TWE_Response_Queue  rq;
1198     u_int32_t           status_reg;
1199
1200     debug_called(4);
1201
1202     for (;;) {                          /* XXX give up eventually? */
1203         status_reg = TWE_STATUS(sc);
1204         if (twe_check_bits(sc, status_reg))
1205             return(1);
1206         if (status_reg & TWE_STATUS_RESPONSE_QUEUE_EMPTY)
1207             return(0);
1208         rq = TWE_RESPONSE_QUEUE(sc);
1209     }
1210 }
1211
1212 /********************************************************************************
1213  * Soft-reset the controller
1214  */
1215 static int
1216 twe_soft_reset(struct twe_softc *sc)
1217 {
1218     u_int32_t           status_reg;
1219
1220     debug_called(2);
1221
1222     TWE_SOFT_RESET(sc);
1223
1224     if (twe_wait_status(sc, TWE_STATUS_ATTENTION_INTERRUPT, 30)) {
1225         twe_printf(sc, "no attention interrupt\n");
1226         return(1);
1227     }
1228     TWE_CONTROL(sc, TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT);
1229     if (twe_drain_aen_queue(sc)) {
1230         twe_printf(sc, "can't drain AEN queue\n");
1231         return(1);
1232     }
1233     if (twe_find_aen(sc, TWE_AEN_SOFT_RESET)) {
1234         twe_printf(sc, "reset not reported\n");
1235         return(1);
1236     }
1237     status_reg = TWE_STATUS(sc);
1238     if (TWE_STATUS_ERRORS(status_reg) || twe_check_bits(sc, status_reg)) {
1239         twe_printf(sc, "controller errors detected\n");
1240         return(1);
1241     }
1242     if (twe_drain_response_queue(sc)) {
1243         twe_printf(sc, "can't drain response queue\n");
1244         return(1);
1245     }
1246     return(0);
1247 }
1248
1249 /********************************************************************************
1250  ********************************************************************************
1251                                                                Interrupt Handling
1252  ********************************************************************************
1253  ********************************************************************************/
1254
1255 /********************************************************************************
1256  * Host interrupt.
1257  *
1258  * XXX what does this mean?
1259  */
1260 static void
1261 twe_host_intr(struct twe_softc *sc)
1262 {
1263     debug_called(4);
1264
1265     twe_printf(sc, "host interrupt\n");
1266     TWE_CONTROL(sc, TWE_CONTROL_CLEAR_HOST_INTERRUPT);
1267 }
1268
1269 /********************************************************************************
1270  * Attention interrupt.
1271  *
1272  * Signalled when the controller has one or more AENs for us.
1273  */
1274 static void
1275 twe_attention_intr(struct twe_softc *sc)
1276 {
1277     debug_called(4);
1278
1279     /* instigate a poll for AENs */
1280     if (twe_fetch_aen(sc)) {
1281         twe_printf(sc, "error polling for signalled AEN\n");
1282     } else {
1283         TWE_CONTROL(sc, TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT);
1284     }
1285 }
1286
1287 /********************************************************************************
1288  * Command interrupt.
1289  *
1290  * Signalled when the controller can handle more commands.
1291  */
1292 static void
1293 twe_command_intr(struct twe_softc *sc)
1294 {
1295     debug_called(4);
1296
1297     /*
1298      * We don't use this, rather we try to submit commands when we receive
1299      * them, and when other commands have completed.  Mask it so we don't get
1300      * another one.
1301      */
1302     twe_printf(sc, "command interrupt\n");
1303     TWE_CONTROL(sc, TWE_CONTROL_MASK_COMMAND_INTERRUPT);
1304 }
1305
1306 /********************************************************************************
1307  ********************************************************************************
1308                                                       Asynchronous Event Handling
1309  ********************************************************************************
1310  ********************************************************************************/
1311
1312 /********************************************************************************
1313  * Request an AEN from the controller.
1314  */
1315 static int
1316 twe_fetch_aen(struct twe_softc *sc)
1317 {
1318
1319     debug_called(4);
1320
1321     if ((twe_get_param(sc, TWE_PARAM_AEN, TWE_PARAM_AEN_UnitCode, 2, twe_handle_aen)) == NULL)
1322         return(EIO);
1323     return(0);
1324 }
1325
1326 /********************************************************************************
1327  * Handle an AEN returned by the controller.
1328  */
1329 static void
1330 twe_handle_aen(struct twe_request *tr)
1331 {
1332     struct twe_softc    *sc = tr->tr_sc;
1333     TWE_Param           *param;
1334     u_int16_t           aen;
1335
1336     debug_called(4);
1337
1338     /* XXX check for command success somehow? */
1339
1340     param = (TWE_Param *)tr->tr_data;
1341     aen = *(u_int16_t *)(param->data);
1342
1343     free(tr->tr_data, M_DEVBUF);
1344     twe_release_request(tr);
1345     twe_enqueue_aen(sc, aen);
1346
1347     /* XXX poll for more AENs? */
1348 }
1349
1350 /********************************************************************************
1351  * Pull AENs out of the controller and park them in the queue, in a context where
1352  * interrupts aren't active.  Return nonzero if we encounter any errors in the
1353  * process of obtaining all the available AENs.
1354  */
1355 static int
1356 twe_drain_aen_queue(struct twe_softc *sc)
1357 {
1358     u_int16_t   aen;
1359
1360     for (;;) {
1361         if (twe_get_param_2(sc, TWE_PARAM_AEN, TWE_PARAM_AEN_UnitCode, &aen))
1362             return(1);
1363         if (aen == TWE_AEN_QUEUE_EMPTY)
1364             return(0);
1365         twe_enqueue_aen(sc, aen);
1366     }
1367 }
1368
1369 /********************************************************************************
1370  * Push an AEN that we've received onto the queue.
1371  *
1372  * Note that we have to lock this against reentrance, since it may be called
1373  * from both interrupt and non-interrupt context.
1374  *
1375  * If someone is waiting for the AEN we have, wake them up.
1376  */
1377 static void
1378 twe_enqueue_aen(struct twe_softc *sc, u_int16_t aen)
1379 {
1380     char        *msg;
1381     int         next, nextnext;
1382
1383     debug_called(4);
1384
1385     if ((msg = twe_format_aen(sc, aen)) != NULL)
1386         twe_printf(sc, "AEN: <%s>\n", msg);
1387
1388     crit_enter();
1389     /* enqueue the AEN */
1390     next = ((sc->twe_aen_head + 1) % TWE_Q_LENGTH);
1391     nextnext = ((sc->twe_aen_head + 2) % TWE_Q_LENGTH);
1392
1393     /* check to see if this is the last free slot, and subvert the AEN if it is */
1394     if (nextnext == sc->twe_aen_tail)
1395         aen = TWE_AEN_QUEUE_FULL;
1396
1397     /* look to see if there's room for this AEN */
1398     if (next != sc->twe_aen_tail) {
1399         sc->twe_aen_queue[sc->twe_aen_head] = aen;
1400         sc->twe_aen_head = next;
1401     }
1402
1403     /* wake up anyone asleep on the queue */
1404     wakeup(&sc->twe_aen_queue);
1405
1406     /* anyone looking for this AEN? */
1407     if (sc->twe_wait_aen == aen) {
1408         sc->twe_wait_aen = -1;
1409         wakeup(&sc->twe_wait_aen);
1410     }
1411     crit_exit();
1412 }
1413
1414 /********************************************************************************
1415  * Pop an AEN off the queue, or return -1 if there are none left.
1416  *
1417  * We are more or less interrupt-safe, so don't block interrupts.
1418  */
1419 static int
1420 twe_dequeue_aen(struct twe_softc *sc)
1421 {
1422     int         result;
1423
1424     debug_called(4);
1425
1426     if (sc->twe_aen_tail == sc->twe_aen_head) {
1427         result = TWE_AEN_QUEUE_EMPTY;
1428     } else {
1429         result = sc->twe_aen_queue[sc->twe_aen_tail];
1430         sc->twe_aen_tail = ((sc->twe_aen_tail + 1) % TWE_Q_LENGTH);
1431     }
1432     return(result);
1433 }
1434
1435 /********************************************************************************
1436  * Check to see if the requested AEN is in the queue.
1437  *
1438  * XXX we could probably avoid masking interrupts here
1439  */
1440 static int
1441 twe_find_aen(struct twe_softc *sc, u_int16_t aen)
1442 {
1443     int         i, missing;
1444
1445     missing = 1;
1446     crit_enter();
1447     for (i = sc->twe_aen_tail; (i != sc->twe_aen_head) && missing; i = (i + 1) % TWE_Q_LENGTH) {
1448         if (sc->twe_aen_queue[i] == aen)
1449             missing = 0;
1450     }
1451     crit_exit();
1452     return(missing);
1453 }
1454
1455
1456 #if 0   /* currently unused */
1457 /********************************************************************************
1458  * Sleep waiting for at least (timeout) seconds until we see (aen) as
1459  * requested.  Returns nonzero on timeout or failure.
1460  *
1461  * XXX: this should not be used in cases where there may be more than one sleeper
1462  *      without a mechanism for registering multiple sleepers.
1463  */
1464 static int
1465 twe_wait_aen(struct twe_softc *sc, int aen, int timeout)
1466 {
1467     time_t      expiry;
1468     int         found;
1469
1470     debug_called(4);
1471
1472     expiry = time_second + timeout;
1473     found = 0;
1474
1475     crit_enter();
1476     sc->twe_wait_aen = aen;
1477     do {
1478         twe_fetch_aen(sc);
1479         tsleep(&sc->twe_wait_aen, PZERO, "twewaen", hz);
1480         if (sc->twe_wait_aen == -1)
1481             found = 1;
1482     } while ((time_second <= expiry) && !found);
1483     crit_exit();
1484     return(!found);
1485 }
1486 #endif
1487
1488 /********************************************************************************
1489  ********************************************************************************
1490                                                         Command Buffer Management
1491  ********************************************************************************
1492  ********************************************************************************/
1493
1494 /********************************************************************************
1495  * Get a new command buffer.
1496  *
1497  * This will return NULL if all command buffers are in use.
1498  */
1499 static int
1500 twe_get_request(struct twe_softc *sc, struct twe_request **tr)
1501 {
1502     debug_called(4);
1503
1504     /* try to reuse an old buffer */
1505     *tr = twe_dequeue_free(sc);
1506
1507     /* initialise some fields to their defaults */
1508     if (*tr != NULL) {
1509         (*tr)->tr_data = NULL;
1510         (*tr)->tr_private = NULL;
1511         (*tr)->tr_status = TWE_CMD_SETUP;               /* command is in setup phase */
1512         (*tr)->tr_flags = 0;
1513         (*tr)->tr_complete = NULL;
1514         (*tr)->tr_command.generic.status = 0;           /* before submission to controller */
1515         (*tr)->tr_command.generic.flags = 0;            /* not used */
1516     }
1517     return(*tr == NULL);
1518 }
1519
1520 /********************************************************************************
1521  * Release a command buffer for reuse.
1522  *
1523  */
1524 static void
1525 twe_release_request(struct twe_request *tr)
1526 {
1527     debug_called(4);
1528
1529     if (tr->tr_private != NULL)
1530         twe_panic(tr->tr_sc, "tr_private != NULL");
1531     twe_enqueue_free(tr);
1532 }
1533
1534 /********************************************************************************
1535  ********************************************************************************
1536                                                                         Debugging
1537  ********************************************************************************
1538  ********************************************************************************/
1539
1540 /********************************************************************************
1541  * Print some information about the controller
1542  */
1543 void
1544 twe_describe_controller(struct twe_softc *sc)
1545 {
1546     TWE_Param           *p[6];
1547     u_int8_t            ports;
1548     u_int32_t           size;
1549     int                 i;
1550
1551     debug_called(2);
1552
1553     /* get the port count */
1554     twe_get_param_1(sc, TWE_PARAM_CONTROLLER, TWE_PARAM_CONTROLLER_PortCount, &ports);
1555
1556     /* get version strings */
1557     p[0] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_Mon,  16, NULL);
1558     p[1] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_FW,   16, NULL);
1559     p[2] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_BIOS, 16, NULL);
1560     p[3] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_PCB,  8, NULL);
1561     p[4] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_ATA,  8, NULL);
1562     p[5] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_PCI,  8, NULL);
1563
1564     twe_printf(sc, "%d ports, Firmware %.16s, BIOS %.16s\n", ports, p[1]->data, p[2]->data);
1565     if (bootverbose)
1566         twe_printf(sc, "Monitor %.16s, PCB %.8s, Achip %.8s, Pchip %.8s\n", p[0]->data, p[3]->data,
1567                    p[4]->data, p[5]->data);
1568     free(p[0], M_DEVBUF);
1569     free(p[1], M_DEVBUF);
1570     free(p[2], M_DEVBUF);
1571     free(p[3], M_DEVBUF);
1572     free(p[4], M_DEVBUF);
1573     free(p[5], M_DEVBUF);
1574
1575     /* print attached drives */
1576     if (bootverbose) {
1577         p[0] = twe_get_param(sc, TWE_PARAM_DRIVESUMMARY, TWE_PARAM_DRIVESUMMARY_Status, 16, NULL);
1578         for (i = 0; i < ports; i++) {
1579             if (p[0]->data[i] != TWE_PARAM_DRIVESTATUS_Present)
1580                 continue;
1581             twe_get_param_4(sc, TWE_PARAM_DRIVEINFO + i, TWE_PARAM_DRIVEINFO_Size, &size);
1582             p[1] = twe_get_param(sc, TWE_PARAM_DRIVEINFO + i, TWE_PARAM_DRIVEINFO_Model, 40, NULL);
1583             if (p[1] != NULL) {
1584                 twe_printf(sc, "port %d: %.40s %dMB\n", i, p[1]->data, size / 2048);
1585                 free(p[1], M_DEVBUF);
1586             } else {
1587                 twe_printf(sc, "port %d, drive status unavailable\n", i);
1588             }
1589         }
1590         free(p[0], M_DEVBUF);
1591     }
1592 }
1593
1594 /********************************************************************************
1595  * Complain if the status bits aren't what we're expecting.
1596  *
1597  * Rate-limit the complaints to at most one of each every five seconds, but
1598  * always return the correct status.
1599  */
1600 static int
1601 twe_check_bits(struct twe_softc *sc, u_int32_t status_reg)
1602 {
1603     int                 result;
1604     static time_t       lastwarn[2] = {0, 0};
1605
1606     /*
1607      * This can be a little problematic, as twe_panic may call twe_reset if
1608      * TWE_DEBUG is not set, which will call us again as part of the soft reset.
1609      */
1610     if ((status_reg & TWE_STATUS_PANIC_BITS) != 0) {
1611         twe_printf(sc, "FATAL STATUS BIT(S) %b\n", status_reg & TWE_STATUS_PANIC_BITS,
1612                    TWE_STATUS_BITS_DESCRIPTION);
1613         twe_panic(sc, "fatal status bits");
1614     }
1615
1616     result = 0;
1617     if ((status_reg & TWE_STATUS_EXPECTED_BITS) != TWE_STATUS_EXPECTED_BITS) {
1618         if (time_second > (lastwarn[0] + 5)) {
1619             twe_printf(sc, "missing expected status bit(s) %b\n", ~status_reg & TWE_STATUS_EXPECTED_BITS,
1620                        TWE_STATUS_BITS_DESCRIPTION);
1621             lastwarn[0] = time_second;
1622         }
1623         result = 1;
1624     }
1625
1626     if ((status_reg & TWE_STATUS_UNEXPECTED_BITS) != 0) {
1627         if (time_second > (lastwarn[1] + 5)) {
1628             twe_printf(sc, "unexpected status bit(s) %b\n", status_reg & TWE_STATUS_UNEXPECTED_BITS,
1629                        TWE_STATUS_BITS_DESCRIPTION);
1630             lastwarn[1] = time_second;
1631         }
1632         result = 1;
1633         if (status_reg & TWE_STATUS_PCI_PARITY_ERROR) {
1634             twe_printf(sc, "PCI parity error: Reseat card, move card or buggy device present.");
1635             twe_clear_pci_parity_error(sc);
1636         }
1637         if (status_reg & TWE_STATUS_PCI_ABORT) {
1638             twe_printf(sc, "PCI abort, clearing.");
1639             twe_clear_pci_abort(sc);
1640         }
1641     }
1642
1643     return(result);
1644 }
1645
1646 /********************************************************************************
1647  * Return a string describing (aen).
1648  *
1649  * The low 8 bits of the aen are the code, the high 8 bits give the unit number
1650  * where an AEN is specific to a unit.
1651  *
1652  * Note that we could expand this routine to handle eg. up/downgrading the status
1653  * of a drive if we had some idea of what the drive's initial status was.
1654  */
1655
1656 static char *
1657 twe_format_aen(struct twe_softc *sc, u_int16_t aen)
1658 {
1659     static char buf[80];
1660     device_t    child;
1661     char        *code, *msg;
1662
1663     code = twe_describe_code(twe_table_aen, TWE_AEN_CODE(aen));
1664     msg = code + 2;
1665
1666     switch (*code) {
1667     case 'q':
1668         if (!bootverbose)
1669             return(NULL);
1670         /* FALLTHROUGH */
1671     case 'a':
1672         return(msg);
1673
1674     case 'c':
1675         if ((child = sc->twe_drive[TWE_AEN_UNIT(aen)].td_disk) != NULL) {
1676             sprintf(buf, "twed%d: %s", device_get_unit(child), msg);
1677         } else {
1678             sprintf(buf, "twe%d: %s for unknown unit %d", device_get_unit(sc->twe_dev),
1679                     msg, TWE_AEN_UNIT(aen));
1680         }
1681         return(buf);
1682
1683     case 'p':
1684         sprintf(buf, "twe%d: port %d: %s", device_get_unit(sc->twe_dev), TWE_AEN_UNIT(aen),
1685                 msg);
1686         return(buf);
1687
1688
1689     case 'x':
1690     default:
1691         break;
1692     }
1693     sprintf(buf, "unknown AEN 0x%x", aen);
1694     return(buf);
1695 }
1696
1697 /********************************************************************************
1698  * Print a diagnostic if the status of the command warrants it, and return
1699  * either zero (command was ok) or nonzero (command failed).
1700  */
1701 static int
1702 twe_report_request(struct twe_request *tr)
1703 {
1704     struct twe_softc    *sc = tr->tr_sc;
1705     TWE_Command         *cmd = &tr->tr_command;
1706     int                 result = 0;
1707
1708     /*
1709      * Check the command status value and handle accordingly.
1710      */
1711     if (cmd->generic.status == TWE_STATUS_RESET) {
1712         /*
1713          * The status code 0xff requests a controller reset.
1714          */
1715         twe_printf(sc, "command returned with controller rest request\n");
1716         twe_reset(sc);
1717         result = 1;
1718     } else if (cmd->generic.status > TWE_STATUS_FATAL) {
1719         /*
1720          * Fatal errors that don't require controller reset.
1721          *
1722          * We know a few special flags values.
1723          */
1724         switch (cmd->generic.flags) {
1725         case 0x1b:
1726             device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1727                           "drive timeout");
1728             break;
1729         case 0x51:
1730             device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1731                           "unrecoverable drive error");
1732             break;
1733         default:
1734             device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1735                           "controller error - %s (flags = 0x%x)\n",
1736                           twe_describe_code(twe_table_status, cmd->generic.status),
1737                           cmd->generic.flags);
1738             result = 1;
1739         }
1740     } else if (cmd->generic.status > TWE_STATUS_WARNING) {
1741         /*
1742          * Warning level status.
1743          */
1744         device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1745                       "warning - %s (flags = 0x%x)\n",
1746                       twe_describe_code(twe_table_status, cmd->generic.status),
1747                       cmd->generic.flags);
1748     } else if (cmd->generic.status > 0x40) {
1749         /*
1750          * Info level status.
1751          */
1752         device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1753                       "attention - %s (flags = 0x%x)\n",
1754                       twe_describe_code(twe_table_status, cmd->generic.status),
1755                       cmd->generic.flags);
1756     }
1757
1758     return(result);
1759 }
1760
1761 /********************************************************************************
1762  * Print some controller state to aid in debugging error/panic conditions
1763  */
1764 void
1765 twe_print_controller(struct twe_softc *sc)
1766 {
1767     u_int32_t           status_reg;
1768
1769     status_reg = TWE_STATUS(sc);
1770     twe_printf(sc, "status   %b\n", status_reg, TWE_STATUS_BITS_DESCRIPTION);
1771     twe_printf(sc, "          current  max\n");
1772     twe_printf(sc, "free      %04d     %04d\n", sc->twe_qstat[TWEQ_FREE].q_length, sc->twe_qstat[TWEQ_FREE].q_max);
1773     twe_printf(sc, "ready     %04d     %04d\n", sc->twe_qstat[TWEQ_READY].q_length, sc->twe_qstat[TWEQ_READY].q_max);
1774     twe_printf(sc, "busy      %04d     %04d\n", sc->twe_qstat[TWEQ_BUSY].q_length, sc->twe_qstat[TWEQ_BUSY].q_max);
1775     twe_printf(sc, "complete  %04d     %04d\n", sc->twe_qstat[TWEQ_COMPLETE].q_length, sc->twe_qstat[TWEQ_COMPLETE].q_max);
1776     twe_printf(sc, "bioq      %04d     %04d\n", sc->twe_qstat[TWEQ_BIO].q_length, sc->twe_qstat[TWEQ_BIO].q_max);
1777     twe_printf(sc, "AEN queue head %d  tail %d\n", sc->twe_aen_head, sc->twe_aen_tail);
1778 }
1779
1780 static void
1781 twe_panic(struct twe_softc *sc, char *reason)
1782 {
1783     twe_print_controller(sc);
1784 #ifdef TWE_DEBUG
1785     panic(reason);
1786 #else
1787     twe_reset(sc);
1788 #endif
1789 }
1790
1791 #if 0
1792 /********************************************************************************
1793  * Print a request/command in human-readable format.
1794  */
1795 static void
1796 twe_print_request(struct twe_request *tr)
1797 {
1798     struct twe_softc    *sc = tr->tr_sc;
1799     TWE_Command *cmd = &tr->tr_command;
1800     int         i;
1801
1802     twe_printf(sc, "CMD: request_id %d  opcode <%s>  size %d  unit %d  host_id %d\n",
1803                cmd->generic.request_id, twe_describe_code(twe_table_opcode, cmd->generic.opcode), cmd->generic.size,
1804                cmd->generic.unit, cmd->generic.host_id);
1805     twe_printf(sc, " status %d  flags 0x%x  count %d  sgl_offset %d\n",
1806                cmd->generic.status, cmd->generic.flags, cmd->generic.count, cmd->generic.sgl_offset);
1807
1808     switch(cmd->generic.opcode) {       /* XXX add more opcodes? */
1809     case TWE_OP_READ:
1810     case TWE_OP_WRITE:
1811         twe_printf(sc, " lba %d\n", cmd->io.lba);
1812         for (i = 0; (i < TWE_MAX_SGL_LENGTH) && (cmd->io.sgl[i].length != 0); i++)
1813             twe_printf(sc, "  %d: 0x%x/%d\n",
1814                        i, cmd->io.sgl[i].address, cmd->io.sgl[i].length);
1815         break;
1816
1817     case TWE_OP_GET_PARAM:
1818     case TWE_OP_SET_PARAM:
1819         for (i = 0; (i < TWE_MAX_SGL_LENGTH) && (cmd->param.sgl[i].length != 0); i++)
1820             twe_printf(sc, "  %d: 0x%x/%d\n",
1821                        i, cmd->param.sgl[i].address, cmd->param.sgl[i].length);
1822         break;
1823
1824     case TWE_OP_INIT_CONNECTION:
1825         twe_printf(sc, " response queue pointer 0x%x\n",
1826                    cmd->initconnection.response_queue_pointer);
1827         break;
1828
1829     default:
1830         break;
1831     }
1832     twe_printf(sc, " tr_command %p/0x%x  tr_data %p/0x%x,%d\n",
1833                tr, tr->tr_cmdphys, tr->tr_data, tr->tr_dataphys, tr->tr_length);
1834     twe_printf(sc, " tr_status %d  tr_flags 0x%x  tr_complete %p  tr_private %p\n",
1835                tr->tr_status, tr->tr_flags, tr->tr_complete, tr->tr_private);
1836 }
1837
1838 #endif