sys/dev/tws/tws.c

   1 /*
   2  * Copyright (c) 2010, LSI Corp.
   3  * All rights reserved.
   4  * Author : Manjunath Ranganathaiah
   5  * Support: freebsdraid@lsi.com
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of the <ORGANIZATION> nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32  * POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  * $FreeBSD$
  35 */
  36
  37
  38 #include <dev/tws/tws.h>
  39 #include <dev/tws/tws_services.h>
  40 #include <dev/tws/tws_hdm.h>
  41
  42 #include <cam/cam.h>
  43 #include <cam/cam_ccb.h>
  44
  45 MALLOC_DEFINE(M_TWS, "twsbuf", "buffers used by tws driver");
  46 int tws_queue_depth = TWS_MAX_REQS;
  47 int tws_enable_msi = 0;
  48 int tws_enable_msix = 0;
  49
  50
  51
  52 /* externs */
  53 extern int tws_cam_attach(struct tws_softc *sc);
  54 extern void tws_cam_detach(struct tws_softc *sc);
  55 extern int tws_init_ctlr(struct tws_softc *sc);
  56 extern boolean tws_ctlr_ready(struct tws_softc *sc);
  57 extern void tws_turn_off_interrupts(struct tws_softc *sc);
  58 extern void tws_q_insert_tail(struct tws_softc *sc, struct tws_request *req,
  59                                 u_int8_t q_type );
  60 extern struct tws_request *tws_q_remove_request(struct tws_softc *sc,
  61                                    struct tws_request *req, u_int8_t q_type );
  62 extern struct tws_request *tws_q_remove_head(struct tws_softc *sc,
  63                                                        u_int8_t q_type );
  64 extern boolean tws_get_response(struct tws_softc *sc, u_int16_t *req_id);
  65 extern boolean tws_ctlr_reset(struct tws_softc *sc);
  66 extern void tws_intr(void *arg);
  67 extern int tws_use_32bit_sgls;
  68
  69
  70 struct tws_request *tws_get_request(struct tws_softc *sc, u_int16_t type);
  71 int tws_init_connect(struct tws_softc *sc, u_int16_t mc);
  72 void tws_send_event(struct tws_softc *sc, u_int8_t event);
  73 uint8_t tws_get_state(struct tws_softc *sc);
  74 void tws_release_request(struct tws_request *req);
  75
  76
  77
  78 /* Function prototypes */
  79 static d_open_t     tws_open;
  80 static d_close_t    tws_close;
  81 static d_read_t     tws_read;
  82 static d_write_t    tws_write;
  83 extern d_ioctl_t    tws_ioctl;
  84
  85 static int tws_init(struct tws_softc *sc);
  86 static void tws_dmamap_cmds_load_cbfn(void *arg, bus_dma_segment_t *segs,
  87                            int nseg, int error);
  88
  89 static int tws_init_reqs(struct tws_softc *sc, u_int32_t dma_mem_size);
  90 static int tws_init_aen_q(struct tws_softc *sc);
  91 static int tws_init_trace_q(struct tws_softc *sc);
  92 static int tws_setup_irq(struct tws_softc *sc);
  93 int tws_setup_intr(struct tws_softc *sc, int irqs);
  94 int tws_teardown_intr(struct tws_softc *sc);
  95
  96
  97 /* Character device entry points */
  98
  99 static struct cdevsw tws_cdevsw = {
 100     .d_version =    D_VERSION,
 101     .d_open =   tws_open,
 102     .d_close =  tws_close,
 103     .d_read =   tws_read,
 104     .d_write =  tws_write,
 105     .d_ioctl =  tws_ioctl,
 106     .d_name =   "tws",
 107 };
 108
 109 /*
 110  * In the cdevsw routines, we find our softc by using the si_drv1 member
 111  * of struct cdev.  We set this variable to point to our softc in our
 112  * attach routine when we create the /dev entry.
 113  */
 114
 115 int
 116 tws_open(struct cdev *dev, int oflags, int devtype, d_thread_t *td)
 117 {
 118     struct tws_softc *sc = dev->si_drv1;
 119
 120     if ( sc )
 121         TWS_TRACE_DEBUG(sc, "entry", dev, oflags);
 122     return (0);
 123 }
 124
 125 int
 126 tws_close(struct cdev *dev, int fflag, int devtype, d_thread_t *td)
 127 {
 128     struct tws_softc *sc = dev->si_drv1;
 129
 130     if ( sc )
 131         TWS_TRACE_DEBUG(sc, "entry", dev, fflag);
 132     return (0);
 133 }
 134
 135 int
 136 tws_read(struct cdev *dev, struct uio *uio, int ioflag)
 137 {
 138     struct tws_softc *sc = dev->si_drv1;
 139
 140     if ( sc )
 141         TWS_TRACE_DEBUG(sc, "entry", dev, ioflag);
 142     return (0);
 143 }
 144
 145 int
 146 tws_write(struct cdev *dev, struct uio *uio, int ioflag)
 147 {
 148     struct tws_softc *sc = dev->si_drv1;
 149
 150     if ( sc )
 151         TWS_TRACE_DEBUG(sc, "entry", dev, ioflag);
 152     return (0);
 153 }
 154
 155 /* PCI Support Functions */
 156
 157 /*
 158  * Compare the device ID of this device against the IDs that this driver
 159  * supports.  If there is a match, set the description and return success.
 160  */
 161 static int
 162 tws_probe(device_t dev)
 163 {
 164     static u_int8_t first_ctlr = 1;
 165
 166     if ((pci_get_vendor(dev) == TWS_VENDOR_ID) &&
 167         (pci_get_device(dev) == TWS_DEVICE_ID)) {
 168         device_set_desc(dev, "LSI 3ware SAS/SATA Storage Controller");
 169         if (first_ctlr) {
 170             printf("LSI 3ware device driver for SAS/SATA storage "
 171                     "controllers, version: %s\n", TWS_DRIVER_VERSION_STRING);
 172             first_ctlr = 0;
 173         }
 174
 175         return(BUS_PROBE_DEFAULT);
 176     }
 177     return (ENXIO);
 178 }
 179
 180 /* Attach function is only called if the probe is successful. */
 181
 182 static int
 183 tws_attach(device_t dev)
 184 {
 185     struct tws_softc *sc = device_get_softc(dev);
 186     u_int32_t cmd, bar;
 187     int error=0,i;
 188
 189     /* no tracing yet */
 190     /* Look up our softc and initialize its fields. */
 191     sc->tws_dev = dev;
 192     sc->device_id = pci_get_device(dev);
 193     sc->subvendor_id = pci_get_subvendor(dev);
 194     sc->subdevice_id = pci_get_subdevice(dev);
 195
 196     /* Intialize mutexes */
 197     mtx_init( &sc->q_lock, "tws_q_lock", NULL, MTX_DEF);
 198     mtx_init( &sc->sim_lock,  "tws_sim_lock", NULL, MTX_DEF);
 199     mtx_init( &sc->gen_lock,  "tws_gen_lock", NULL, MTX_DEF);
 200     mtx_init( &sc->io_lock,  "tws_io_lock", NULL, MTX_DEF);
 201
 202     if ( tws_init_trace_q(sc) == FAILURE )
 203         printf("trace init failure\n");
 204     /* send init event */
 205     mtx_lock(&sc->gen_lock);
 206     tws_send_event(sc, TWS_INIT_START);
 207     mtx_unlock(&sc->gen_lock);
 208
 209
 210 #if _BYTE_ORDER == _BIG_ENDIAN
 211     TWS_TRACE(sc, "BIG endian", 0, 0);
 212 #endif
 213     /* sysctl context setup */
 214     sysctl_ctx_init(&sc->tws_clist);
 215     sc->tws_oidp = SYSCTL_ADD_NODE(&sc->tws_clist,
 216                                    SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
 217                                    device_get_nameunit(dev),
 218                                    CTLFLAG_RD, 0, "");
 219     if ( sc->tws_oidp == NULL ) {
 220         tws_log(sc, SYSCTL_TREE_NODE_ADD);
 221         goto attach_fail_1;
 222     }
 223     SYSCTL_ADD_STRING(&sc->tws_clist, SYSCTL_CHILDREN(sc->tws_oidp),
 224                       OID_AUTO, "driver_version", CTLFLAG_RD,
 225                       TWS_DRIVER_VERSION_STRING, 0, "TWS driver version");
 226
 227     cmd = pci_read_config(dev, PCIR_COMMAND, 2);
 228     if ( (cmd & PCIM_CMD_PORTEN) == 0) {
 229         tws_log(sc, PCI_COMMAND_READ);
 230         goto attach_fail_1;
 231     }
 232     /* Force the busmaster enable bit on. */
 233     cmd |= PCIM_CMD_BUSMASTEREN;
 234     pci_write_config(dev, PCIR_COMMAND, cmd, 2);
 235
 236     bar = pci_read_config(dev, TWS_PCI_BAR0, 4);
 237     TWS_TRACE_DEBUG(sc, "bar0 ", bar, 0);
 238     bar = pci_read_config(dev, TWS_PCI_BAR1, 4);
 239     bar = bar & ~TWS_BIT2;
 240     TWS_TRACE_DEBUG(sc, "bar1 ", bar, 0);
 241
 242     /* MFA base address is BAR2 register used for
 243      * push mode. Firmware will evatualy move to
 244      * pull mode during witch this needs to change
 245      */
 246 #ifndef TWS_PULL_MODE_ENABLE
 247     sc->mfa_base = (u_int64_t)pci_read_config(dev, TWS_PCI_BAR2, 4);
 248     sc->mfa_base = sc->mfa_base & ~TWS_BIT2;
 249     TWS_TRACE_DEBUG(sc, "bar2 ", sc->mfa_base, 0);
 250 #endif
 251
 252     /* allocate MMIO register space */
 253     sc->reg_res_id = TWS_PCI_BAR1; /* BAR1 offset */
 254     if ((sc->reg_res = bus_alloc_resource(dev, SYS_RES_MEMORY,
 255                                 &(sc->reg_res_id), 0, ~0, 1, RF_ACTIVE))
 256                                 == NULL) {
 257         tws_log(sc, ALLOC_MEMORY_RES);
 258         goto attach_fail_1;
 259     }
 260     sc->bus_tag = rman_get_bustag(sc->reg_res);
 261     sc->bus_handle = rman_get_bushandle(sc->reg_res);
 262
 263 #ifndef TWS_PULL_MODE_ENABLE
 264     /* Allocate bus space for inbound mfa */
 265     sc->mfa_res_id = TWS_PCI_BAR2; /* BAR2 offset */
 266     if ((sc->mfa_res = bus_alloc_resource(dev, SYS_RES_MEMORY,
 267                           &(sc->mfa_res_id), 0, ~0, 0x100000, RF_ACTIVE))
 268                                 == NULL) {
 269         tws_log(sc, ALLOC_MEMORY_RES);
 270         goto attach_fail_2;
 271     }
 272     sc->bus_mfa_tag = rman_get_bustag(sc->mfa_res);
 273     sc->bus_mfa_handle = rman_get_bushandle(sc->mfa_res);
 274 #endif
 275
 276     /* Allocate and register our interrupt. */
 277     sc->intr_type = TWS_INTx; /* default */
 278
 279     if ( tws_enable_msi )
 280         sc->intr_type = TWS_MSI;
 281     if ( tws_setup_irq(sc) == FAILURE ) {
 282         tws_log(sc, ALLOC_MEMORY_RES);
 283         goto attach_fail_3;
 284     }
 285
 286     /*
 287      * Create a /dev entry for this device.  The kernel will assign us
 288      * a major number automatically.  We use the unit number of this
 289      * device as the minor number and name the character device
 290      * "tws<unit>".
 291      */
 292     sc->tws_cdev = make_dev(&tws_cdevsw, device_get_unit(dev),
 293         UID_ROOT, GID_OPERATOR, S_IRUSR | S_IWUSR, "tws%u",
 294         device_get_unit(dev));
 295     sc->tws_cdev->si_drv1 = sc;
 296
 297     if ( tws_init(sc) == FAILURE ) {
 298         tws_log(sc, TWS_INIT_FAILURE);
 299         goto attach_fail_4;
 300     }
 301     if ( tws_init_ctlr(sc) == FAILURE ) {
 302         tws_log(sc, TWS_CTLR_INIT_FAILURE);
 303         goto attach_fail_4;
 304     }
 305     if ((error = tws_cam_attach(sc))) {
 306         tws_log(sc, TWS_CAM_ATTACH);
 307         goto attach_fail_4;
 308     }
 309     /* send init complete event */
 310     mtx_lock(&sc->gen_lock);
 311     tws_send_event(sc, TWS_INIT_COMPLETE);
 312     mtx_unlock(&sc->gen_lock);
 313
 314     TWS_TRACE_DEBUG(sc, "attached successfully", 0, sc->device_id);
 315     return(0);
 316
 317 attach_fail_4:
 318     tws_teardown_intr(sc);
 319     destroy_dev(sc->tws_cdev);
 320 attach_fail_3:
 321     for(i=0;i<sc->irqs;i++) {
 322         if ( sc->irq_res[i] ){
 323             if (bus_release_resource(sc->tws_dev,
 324                  SYS_RES_IRQ, sc->irq_res_id[i], sc->irq_res[i]))
 325                 TWS_TRACE(sc, "bus irq res", 0, 0);
 326         }
 327     }
 328 #ifndef TWS_PULL_MODE_ENABLE
 329 attach_fail_2:
 330 #endif
 331     if ( sc->mfa_res ){
 332         if (bus_release_resource(sc->tws_dev,
 333                  SYS_RES_MEMORY, sc->mfa_res_id, sc->mfa_res))
 334             TWS_TRACE(sc, "bus release ", 0, sc->mfa_res_id);
 335     }
 336     if ( sc->reg_res ){
 337         if (bus_release_resource(sc->tws_dev,
 338                  SYS_RES_MEMORY, sc->reg_res_id, sc->reg_res))
 339             TWS_TRACE(sc, "bus release2 ", 0, sc->reg_res_id);
 340     }
 341 attach_fail_1:
 342     mtx_destroy(&sc->q_lock);
 343     mtx_destroy(&sc->sim_lock);
 344     mtx_destroy(&sc->gen_lock);
 345     mtx_destroy(&sc->io_lock);
 346     sysctl_ctx_free(&sc->tws_clist);
 347     return (ENXIO);
 348 }
 349
 350 /* Detach device. */
 351
 352 static int
 353 tws_detach(device_t dev)
 354 {
 355     struct tws_softc *sc = device_get_softc(dev);
 356     int i;
 357     u_int32_t reg;
 358
 359     TWS_TRACE_DEBUG(sc, "entry", 0, 0);
 360
 361     mtx_lock(&sc->gen_lock);
 362     tws_send_event(sc, TWS_UNINIT_START);
 363     mtx_unlock(&sc->gen_lock);
 364
 365     /* needs to disable interrupt before detaching from cam */
 366     tws_turn_off_interrupts(sc);
 367     /* clear door bell */
 368     tws_write_reg(sc, TWS_I2O0_HOBDBC, ~0, 4);
 369     reg = tws_read_reg(sc, TWS_I2O0_HIMASK, 4);
 370     TWS_TRACE_DEBUG(sc, "turn-off-intr", reg, 0);
 371     sc->obfl_q_overrun = false;
 372     tws_init_connect(sc, 1);
 373
 374     /* Teardown the state in our softc created in our attach routine. */
 375     /* Disconnect the interrupt handler. */
 376     tws_teardown_intr(sc);
 377
 378     /* Release irq resource */
 379     for(i=0;i<sc->irqs;i++) {
 380         if ( sc->irq_res[i] ){
 381             if (bus_release_resource(sc->tws_dev,
 382                      SYS_RES_IRQ, sc->irq_res_id[i], sc->irq_res[i]))
 383                 TWS_TRACE(sc, "bus release irq resource",
 384                                        i, sc->irq_res_id[i]);
 385         }
 386     }
 387     if ( sc->intr_type == TWS_MSI ) {
 388         pci_release_msi(sc->tws_dev);
 389     }
 390
 391     tws_cam_detach(sc);
 392
 393     /* Release memory resource */
 394     if ( sc->mfa_res ){
 395         if (bus_release_resource(sc->tws_dev,
 396                  SYS_RES_MEMORY, sc->mfa_res_id, sc->mfa_res))
 397             TWS_TRACE(sc, "bus release mem resource", 0, sc->mfa_res_id);
 398     }
 399     if ( sc->reg_res ){
 400         if (bus_release_resource(sc->tws_dev,
 401                  SYS_RES_MEMORY, sc->reg_res_id, sc->reg_res))
 402             TWS_TRACE(sc, "bus release mem resource", 0, sc->reg_res_id);
 403     }
 404
 405     free(sc->reqs, M_TWS);
 406     free(sc->sense_bufs, M_TWS);
 407     free(sc->scan_ccb, M_TWS);
 408     free(sc->aen_q.q, M_TWS);
 409     free(sc->trace_q.q, M_TWS);
 410     mtx_destroy(&sc->q_lock);
 411     mtx_destroy(&sc->sim_lock);
 412     mtx_destroy(&sc->gen_lock);
 413     mtx_destroy(&sc->io_lock);
 414     destroy_dev(sc->tws_cdev);
 415     sysctl_ctx_free(&sc->tws_clist);
 416     return (0);
 417 }
 418
 419 int
 420 tws_setup_intr(struct tws_softc *sc, int irqs)
 421 {
 422     int i, error;
 423
 424     for(i=0;i<irqs;i++) {
 425         if (!(sc->intr_handle[i])) {
 426             if ((error = bus_setup_intr(sc->tws_dev, sc->irq_res[i],
 427                                     INTR_TYPE_CAM | INTR_MPSAFE,
 428 #if (__FreeBSD_version >= 700000)
 429                                     NULL,
 430 #endif
 431                                     tws_intr, sc, &sc->intr_handle[i]))) {
 432                 tws_log(sc, SETUP_INTR_RES);
 433                 return(FAILURE);
 434             }
 435         }
 436     }
 437     return(SUCCESS);
 438
 439 }
 440
 441
 442 int
 443 tws_teardown_intr(struct tws_softc *sc)
 444 {
 445     int i, error;
 446
 447     for(i=0;i<sc->irqs;i++) {
 448         if (sc->intr_handle[i]) {
 449             error = bus_teardown_intr(sc->tws_dev,
 450                                       sc->irq_res[i], sc->intr_handle[i]);
 451             sc->intr_handle[i] = NULL;
 452         }
 453     }
 454     return(SUCCESS);
 455 }
 456
 457
 458 static int
 459 tws_setup_irq(struct tws_softc *sc)
 460 {
 461     int messages;
 462     u_int16_t cmd;
 463
 464     cmd = pci_read_config(sc->tws_dev, PCIR_COMMAND, 2);
 465     switch(sc->intr_type) {
 466         case TWS_INTx :
 467             cmd = cmd & ~0x0400;
 468             pci_write_config(sc->tws_dev, PCIR_COMMAND, cmd, 2);
 469             sc->irqs = 1;
 470             sc->irq_res_id[0] = 0;
 471             sc->irq_res[0] = bus_alloc_resource_any(sc->tws_dev, SYS_RES_IRQ,
 472                             &sc->irq_res_id[0], RF_SHAREABLE | RF_ACTIVE);
 473             if ( ! sc->irq_res[0] )
 474                 return(FAILURE);
 475             if ( tws_setup_intr(sc, sc->irqs) == FAILURE )
 476                 return(FAILURE);
 477             device_printf(sc->tws_dev, "Using legacy INTx\n");
 478             break;
 479         case TWS_MSI :
 480             cmd = cmd | 0x0400;
 481             pci_write_config(sc->tws_dev, PCIR_COMMAND, cmd, 2);
 482             sc->irqs = 1;
 483             sc->irq_res_id[0] = 1;
 484             messages = 1;
 485             if (pci_alloc_msi(sc->tws_dev, &messages) != 0 ) {
 486                 TWS_TRACE(sc, "pci alloc msi fail", 0, messages);
 487                 return(FAILURE);
 488             }
 489             sc->irq_res[0] = bus_alloc_resource_any(sc->tws_dev, SYS_RES_IRQ,
 490                               &sc->irq_res_id[0], RF_SHAREABLE | RF_ACTIVE);
 491
 492             if ( !sc->irq_res[0]  )
 493                 return(FAILURE);
 494             if ( tws_setup_intr(sc, sc->irqs) == FAILURE )
 495                 return(FAILURE);
 496             device_printf(sc->tws_dev, "Using MSI\n");
 497             break;
 498
 499     }
 500
 501     return(SUCCESS);
 502 }
 503
 504 static int
 505 tws_init(struct tws_softc *sc)
 506 {
 507
 508     u_int32_t max_sg_elements;
 509     u_int32_t dma_mem_size;
 510     int error;
 511     u_int32_t reg;
 512
 513     sc->seq_id = 0;
 514     if ( tws_queue_depth > TWS_MAX_REQS )
 515         tws_queue_depth = TWS_MAX_REQS;
 516     if (tws_queue_depth < TWS_RESERVED_REQS+1)
 517         tws_queue_depth = TWS_RESERVED_REQS+1;
 518     sc->is64bit = (sizeof(bus_addr_t) == 8) ? true : false;
 519     max_sg_elements = (sc->is64bit && !tws_use_32bit_sgls) ?
 520                                  TWS_MAX_64BIT_SG_ELEMENTS :
 521                                  TWS_MAX_32BIT_SG_ELEMENTS;
 522     dma_mem_size = (sizeof(struct tws_command_packet) * tws_queue_depth) +
 523                              (TWS_SECTOR_SIZE) ;
 524     if ( bus_dma_tag_create(NULL,                    /* parent */
 525                             TWS_ALIGNMENT,           /* alignment */
 526                             0,                       /* boundary */
 527                             BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
 528                             BUS_SPACE_MAXADDR,       /* highaddr */
 529                             NULL, NULL,              /* filter, filterarg */
 530                             BUS_SPACE_MAXSIZE,       /* maxsize */
 531                             max_sg_elements,         /* numsegs */
 532                             BUS_SPACE_MAXSIZE,       /* maxsegsize */
 533                             0,                       /* flags */
 534                             NULL, NULL,              /* lockfunc, lockfuncarg */
 535                             &sc->parent_tag          /* tag */
 536                            )) {
 537         TWS_TRACE_DEBUG(sc, "DMA parent tag Create fail", max_sg_elements,
 538                                                     sc->is64bit);
 539         return(ENOMEM);
 540     }
 541     /* In bound message frame requires 16byte alignment.
 542      * Outbound MF's can live with 4byte alignment - for now just
 543      * use 16 for both.
 544      */
 545     if ( bus_dma_tag_create(sc->parent_tag,       /* parent */
 546                             TWS_IN_MF_ALIGNMENT,  /* alignment */
 547                             0,                    /* boundary */
 548                             BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
 549                             BUS_SPACE_MAXADDR,    /* highaddr */
 550                             NULL, NULL,           /* filter, filterarg */
 551                             dma_mem_size,         /* maxsize */
 552                             1,                    /* numsegs */
 553                             BUS_SPACE_MAXSIZE,    /* maxsegsize */
 554                             0,                    /* flags */
 555                             NULL, NULL,           /* lockfunc, lockfuncarg */
 556                             &sc->cmd_tag          /* tag */
 557                            )) {
 558         TWS_TRACE_DEBUG(sc, "DMA cmd tag Create fail", max_sg_elements, sc->is64bit);
 559         return(ENOMEM);
 560     }
 561
 562     if (bus_dmamem_alloc(sc->cmd_tag, &sc->dma_mem,
 563                     BUS_DMA_NOWAIT, &sc->cmd_map)) {
 564         TWS_TRACE_DEBUG(sc, "DMA mem alloc fail", max_sg_elements, sc->is64bit);
 565         return(ENOMEM);
 566     }
 567
 568     /* if bus_dmamem_alloc succeeds then bus_dmamap_load will succeed */
 569     sc->dma_mem_phys=0;
 570     error = bus_dmamap_load(sc->cmd_tag, sc->cmd_map, sc->dma_mem,
 571                     dma_mem_size, tws_dmamap_cmds_load_cbfn,
 572                     &sc->dma_mem_phys, 0);
 573
 574    /*
 575     * Create a dma tag for data buffers; size will be the maximum
 576     * possible I/O size (128kB).
 577     */
 578     if (bus_dma_tag_create(sc->parent_tag,         /* parent */
 579                            TWS_ALIGNMENT,          /* alignment */
 580                            0,                      /* boundary */
 581                            BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
 582                            BUS_SPACE_MAXADDR,      /* highaddr */
 583                            NULL, NULL,             /* filter, filterarg */
 584                            TWS_MAX_IO_SIZE,        /* maxsize */
 585                            max_sg_elements,        /* nsegments */
 586                            TWS_MAX_IO_SIZE,        /* maxsegsize */
 587                            BUS_DMA_ALLOCNOW,       /* flags */
 588                            busdma_lock_mutex,      /* lockfunc */
 589                            &sc->io_lock,           /* lockfuncarg */
 590                            &sc->data_tag           /* tag */)) {
 591         TWS_TRACE_DEBUG(sc, "DMA cmd tag Create fail", max_sg_elements, sc->is64bit);
 592         return(ENOMEM);
 593     }
 594
 595     sc->reqs = malloc(sizeof(struct tws_request) * tws_queue_depth, M_TWS,
 596                       M_WAITOK | M_ZERO);
 597     if ( sc->reqs == NULL ) {
 598         TWS_TRACE_DEBUG(sc, "malloc failed", 0, sc->is64bit);
 599         return(ENOMEM);
 600     }
 601     sc->sense_bufs = malloc(sizeof(struct tws_sense) * tws_queue_depth, M_TWS,
 602                       M_WAITOK | M_ZERO);
 603     if ( sc->sense_bufs == NULL ) {
 604         TWS_TRACE_DEBUG(sc, "sense malloc failed", 0, sc->is64bit);
 605         return(ENOMEM);
 606     }
 607     sc->scan_ccb = malloc(sizeof(union ccb), M_TWS, M_WAITOK | M_ZERO);
 608     if ( sc->scan_ccb == NULL ) {
 609         TWS_TRACE_DEBUG(sc, "ccb malloc failed", 0, sc->is64bit);
 610         return(ENOMEM);
 611     }
 612
 613     if ( !tws_ctlr_ready(sc) )
 614         if( !tws_ctlr_reset(sc) )
 615             return(FAILURE);
 616
 617     bzero(&sc->stats, sizeof(struct tws_stats));
 618     tws_init_qs(sc);
 619     tws_turn_off_interrupts(sc);
 620
 621     /*
 622      * enable pull mode by setting bit1 .
 623      * setting bit0 to 1 will enable interrupt coalesing
 624      * will revisit.
 625      */
 626
 627 #ifdef TWS_PULL_MODE_ENABLE
 628
 629     reg = tws_read_reg(sc, TWS_I2O0_CTL, 4);
 630     TWS_TRACE_DEBUG(sc, "i20 ctl", reg, TWS_I2O0_CTL);
 631     tws_write_reg(sc, TWS_I2O0_CTL, reg | TWS_BIT1, 4);
 632
 633 #endif
 634
 635     TWS_TRACE_DEBUG(sc, "dma_mem_phys", sc->dma_mem_phys, TWS_I2O0_CTL);
 636     if ( tws_init_reqs(sc, dma_mem_size) == FAILURE )
 637         return(FAILURE);
 638     if ( tws_init_aen_q(sc) == FAILURE )
 639         return(FAILURE);
 640
 641     return(SUCCESS);
 642
 643 }
 644
 645 static int
 646 tws_init_aen_q(struct tws_softc *sc)
 647 {
 648     sc->aen_q.head=0;
 649     sc->aen_q.tail=0;
 650     sc->aen_q.depth=256;
 651     sc->aen_q.overflow=0;
 652     sc->aen_q.q = malloc(sizeof(struct tws_event_packet)*sc->aen_q.depth,
 653                               M_TWS, M_WAITOK | M_ZERO);
 654     if ( ! sc->aen_q.q )
 655         return(FAILURE);
 656     return(SUCCESS);
 657 }
 658
 659 static int
 660 tws_init_trace_q(struct tws_softc *sc)
 661 {
 662     sc->trace_q.head=0;
 663     sc->trace_q.tail=0;
 664     sc->trace_q.depth=256;
 665     sc->trace_q.overflow=0;
 666     sc->trace_q.q = malloc(sizeof(struct tws_trace_rec)*sc->trace_q.depth,
 667                               M_TWS, M_WAITOK | M_ZERO);
 668     if ( ! sc->trace_q.q )
 669         return(FAILURE);
 670     return(SUCCESS);
 671 }
 672
 673 static int
 674 tws_init_reqs(struct tws_softc *sc, u_int32_t dma_mem_size)
 675 {
 676
 677     struct tws_command_packet *cmd_buf;
 678     cmd_buf = (struct tws_command_packet *)sc->dma_mem;
 679     int i;
 680
 681     bzero(cmd_buf, dma_mem_size);
 682     TWS_TRACE_DEBUG(sc, "phy cmd", sc->dma_mem_phys, 0);
 683     mtx_lock(&sc->q_lock);
 684     for ( i=0; i< tws_queue_depth; i++)
 685     {
 686         if (bus_dmamap_create(sc->data_tag, 0, &sc->reqs[i].dma_map)) {
 687             /* log a ENOMEM failure msg here */
 688             return(FAILURE);
 689         }
 690         sc->reqs[i].cmd_pkt =  &cmd_buf[i];
 691
 692         sc->sense_bufs[i].hdr = &cmd_buf[i].hdr ;
 693         sc->sense_bufs[i].hdr_pkt_phy = sc->dma_mem_phys +
 694                               (i * sizeof(struct tws_command_packet));
 695
 696         sc->reqs[i].cmd_pkt_phy = sc->dma_mem_phys +
 697                               sizeof(struct tws_command_header) +
 698                               (i * sizeof(struct tws_command_packet));
 699         sc->reqs[i].request_id = i;
 700         sc->reqs[i].sc = sc;
 701
 702         sc->reqs[i].cmd_pkt->hdr.header_desc.size_header = 128;
 703
 704         sc->reqs[i].state = TWS_REQ_STATE_FREE;
 705         if ( i >= TWS_RESERVED_REQS )
 706             tws_q_insert_tail(sc, &sc->reqs[i], TWS_FREE_Q);
 707     }
 708     mtx_unlock(&sc->q_lock);
 709     return(SUCCESS);
 710 }
 711
 712 static void
 713 tws_dmamap_cmds_load_cbfn(void *arg, bus_dma_segment_t *segs,
 714                            int nseg, int error)
 715 {
 716
 717     /* printf("command load done \n"); */
 718
 719     *((bus_addr_t *)arg) = segs[0].ds_addr;
 720 }
 721
 722 void
 723 tws_send_event(struct tws_softc *sc, u_int8_t event)
 724 {
 725     mtx_assert(&sc->gen_lock, MA_OWNED);
 726     TWS_TRACE_DEBUG(sc, "received event ", 0, event);
 727     switch (event) {
 728
 729         case TWS_INIT_START:
 730             sc->tws_state = TWS_INIT;
 731             break;
 732
 733         case TWS_INIT_COMPLETE:
 734             if (sc->tws_state != TWS_INIT) {
 735                 device_printf(sc->tws_dev, "invalid state transition %d => TWS_ONLINE\n", sc->tws_state);
 736             } else {
 737                 sc->tws_state = TWS_ONLINE;
 738             }
 739             break;
 740
 741         case TWS_RESET_START:
 742             /* We can transition to reset state from any state except reset*/
 743             if (sc->tws_state != TWS_RESET) {
 744                 sc->tws_prev_state = sc->tws_state;
 745                 sc->tws_state = TWS_RESET;
 746             }
 747             break;
 748
 749         case TWS_RESET_COMPLETE:
 750             if (sc->tws_state != TWS_RESET) {
 751                 device_printf(sc->tws_dev, "invalid state transition %d => %d (previous state)\n", sc->tws_state, sc->tws_prev_state);
 752             } else {
 753                 sc->tws_state = sc->tws_prev_state;
 754             }
 755             break;
 756
 757         case TWS_SCAN_FAILURE:
 758             if (sc->tws_state != TWS_ONLINE) {
 759                 device_printf(sc->tws_dev, "invalid state transition %d => TWS_OFFLINE\n", sc->tws_state);
 760             } else {
 761                 sc->tws_state = TWS_OFFLINE;
 762             }
 763             break;
 764
 765         case TWS_UNINIT_START:
 766             if ((sc->tws_state != TWS_ONLINE) && (sc->tws_state != TWS_OFFLINE)) {
 767                 device_printf(sc->tws_dev, "invalid state transition %d => TWS_UNINIT\n", sc->tws_state);
 768             } else {
 769                 sc->tws_state = TWS_UNINIT;
 770             }
 771             break;
 772     }
 773
 774 }
 775
 776 uint8_t
 777 tws_get_state(struct tws_softc *sc)
 778 {
 779
 780     return((u_int8_t)sc->tws_state);
 781
 782 }
 783
 784 /* Called during system shutdown after sync. */
 785
 786 static int
 787 tws_shutdown(device_t dev)
 788 {
 789
 790     struct tws_softc *sc = device_get_softc(dev);
 791
 792     TWS_TRACE_DEBUG(sc, "entry", 0, 0);
 793
 794     tws_turn_off_interrupts(sc);
 795     tws_init_connect(sc, 1);
 796
 797     return (0);
 798 }
 799
 800 /*
 801  * Device suspend routine.
 802  */
 803 static int
 804 tws_suspend(device_t dev)
 805 {
 806     struct tws_softc *sc = device_get_softc(dev);
 807
 808     if ( sc )
 809         TWS_TRACE_DEBUG(sc, "entry", 0, 0);
 810     return (0);
 811 }
 812
 813 /*
 814  * Device resume routine.
 815  */
 816 static int
 817 tws_resume(device_t dev)
 818 {
 819
 820     struct tws_softc *sc = device_get_softc(dev);
 821
 822     if ( sc )
 823         TWS_TRACE_DEBUG(sc, "entry", 0, 0);
 824     return (0);
 825 }
 826
 827
 828 struct tws_request *
 829 tws_get_request(struct tws_softc *sc, u_int16_t type)
 830 {
 831     struct mtx *my_mutex = ((type == TWS_REQ_TYPE_SCSI_IO) ? &sc->q_lock : &sc->gen_lock);
 832     struct tws_request *r = NULL;
 833
 834     mtx_lock(my_mutex);
 835
 836     if (type == TWS_REQ_TYPE_SCSI_IO) {
 837         r = tws_q_remove_head(sc, TWS_FREE_Q);
 838     } else {
 839         if ( sc->reqs[type].state == TWS_REQ_STATE_FREE ) {
 840             r = &sc->reqs[type];
 841         }
 842     }
 843
 844     if ( r ) {
 845         bzero(&r->cmd_pkt->cmd, sizeof(struct tws_command_apache));
 846         r->data = NULL;
 847         r->length = 0;
 848         r->type = type;
 849         r->flags = TWS_DIR_UNKNOWN;
 850         r->error_code = TWS_REQ_RET_INVALID;
 851         r->cb = NULL;
 852         r->ccb_ptr = NULL;
 853         r->thandle.callout = NULL;
 854         r->next = r->prev = NULL;
 855
 856         r->state = ((type == TWS_REQ_TYPE_SCSI_IO) ? TWS_REQ_STATE_TRAN : TWS_REQ_STATE_BUSY);
 857     }
 858
 859     mtx_unlock(my_mutex);
 860
 861     return(r);
 862 }
 863
 864 void
 865 tws_release_request(struct tws_request *req)
 866 {
 867
 868     struct tws_softc *sc = req->sc;
 869
 870     TWS_TRACE_DEBUG(sc, "entry", sc, 0);
 871     mtx_lock(&sc->q_lock);
 872     tws_q_insert_tail(sc, req, TWS_FREE_Q);
 873     mtx_unlock(&sc->q_lock);
 874 }
 875
 876 static device_method_t tws_methods[] = {
 877     /* Device interface */
 878     DEVMETHOD(device_probe,     tws_probe),
 879     DEVMETHOD(device_attach,    tws_attach),
 880     DEVMETHOD(device_detach,    tws_detach),
 881     DEVMETHOD(device_shutdown,  tws_shutdown),
 882     DEVMETHOD(device_suspend,   tws_suspend),
 883     DEVMETHOD(device_resume,    tws_resume),
 884
 885     DEVMETHOD(bus_print_child,      bus_generic_print_child),
 886     DEVMETHOD(bus_driver_added,     bus_generic_driver_added),
 887     { 0, 0 }
 888 };
 889
 890 static driver_t tws_driver = {
 891         "tws",
 892         tws_methods,
 893         sizeof(struct tws_softc)
 894 };
 895
 896
 897 static devclass_t tws_devclass;
 898
 899 /* DEFINE_CLASS_0(tws, tws_driver, tws_methods, sizeof(struct tws_softc)); */
 900 DRIVER_MODULE(tws, pci, tws_driver, tws_devclass, 0, 0);
 901 MODULE_DEPEND(tws, cam, 1, 1, 1);
 902 MODULE_DEPEND(tws, pci, 1, 1, 1);
 903
 904 TUNABLE_INT("hw.tws.queue_depth", &tws_queue_depth);
 905 TUNABLE_INT("hw.tws.enable_msi", &tws_enable_msi);