sys/dev/disk/nata/ata-all.c

   1 /*-
   2  * Copyright (c) 1998 - 2006 Søren Schmidt <sos@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer,
  10  *    without modification, immediately at the beginning of the file.
  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 ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/sys/dev/ata/ata-all.c,v 1.279 2007/02/23 16:25:08 jhb Exp $
  27  */
  28
  29 #include "opt_ata.h"
  30
  31 #include <sys/param.h>
  32 #include <sys/bus.h>
  33 #include <sys/callout.h>
  34 #include <sys/conf.h>
  35 #include <sys/ctype.h>
  36 #include <sys/device.h>
  37 #include <sys/endian.h>
  38 #include <sys/kernel.h>
  39 #include <sys/libkern.h>
  40 #include <sys/lock.h>           /* for {get,rel}_mplock() */
  41 #include <sys/malloc.h>
  42 #include <sys/module.h>
  43 #include <sys/nata.h>
  44 #include <sys/objcache.h>
  45 #include <sys/queue.h>
  46 #include <sys/sysctl.h>
  47 #include <sys/systm.h>
  48
  49 #include <sys/mplock2.h>
  50
  51 #include "ata-all.h"
  52 #include "ata_if.h"
  53
  54 /* device structure */
  55 static  d_ioctl_t       ata_ioctl;
  56 static struct dev_ops ata_ops = {
  57         { "ata", 159, 0 },
  58         .d_open =       nullopen,
  59         .d_close =      nullclose,
  60         .d_ioctl =      ata_ioctl,
  61 };
  62
  63 /* prototypes */
  64 #if 0
  65 static void ata_boot_attach(void);
  66 #endif
  67 static device_t ata_add_child(device_t, struct ata_device *, int);
  68 static int ata_getparam(struct ata_device *, int);
  69 static void bswap(int8_t *, int);
  70 static void btrim(int8_t *, int);
  71 static void bpack(int8_t *, int8_t *, int);
  72
  73 /* global vars */
  74 MALLOC_DEFINE(M_ATA, "ata_generic", "ATA driver generic layer");
  75 int (*ata_raid_ioctl_func)(u_long cmd, caddr_t data) = NULL;
  76 devclass_t ata_devclass;
  77 struct objcache *ata_request_cache;
  78 struct objcache *ata_composite_cache;
  79 struct objcache_malloc_args ata_request_malloc_args = {
  80         sizeof(struct ata_request), M_ATA };
  81 struct objcache_malloc_args ata_composite_malloc_args = {
  82         sizeof(struct ata_composite), M_ATA };
  83 int ata_wc = 1;
  84
  85 /* local vars */
  86 static int ata_dma = 1;
  87 static int atapi_dma = 1;
  88
  89 /* sysctl vars */
  90 SYSCTL_NODE(_hw, OID_AUTO, ata, CTLFLAG_RD, 0, "ATA driver parameters");
  91 TUNABLE_INT("hw.ata.ata_dma", &ata_dma);
  92 SYSCTL_INT(_hw_ata, OID_AUTO, ata_dma, CTLFLAG_RW, &ata_dma, 0,
  93            "ATA disk DMA mode control");
  94 TUNABLE_INT("hw.ata.atapi_dma", &atapi_dma);
  95 SYSCTL_INT(_hw_ata, OID_AUTO, atapi_dma, CTLFLAG_RW, &atapi_dma, 0,
  96            "ATAPI device DMA mode control");
  97 TUNABLE_INT("hw.ata.wc", &ata_wc);
  98 SYSCTL_INT(_hw_ata, OID_AUTO, ata_wc, CTLFLAG_RW, &ata_wc, 0,
  99            "ATA disk write caching");
 100
 101 /*
 102  * newbus device interface related functions
 103  */
 104 int
 105 ata_probe(device_t dev)
 106 {
 107     return 0;
 108 }
 109
 110 int
 111 ata_attach(device_t dev)
 112 {
 113     struct ata_channel *ch = device_get_softc(dev);
 114     int error, rid;
 115
 116     /* check that we have a virgin channel to attach */
 117     if (ch->r_irq)
 118         return EEXIST;
 119
 120     /* initialize the softc basics */
 121     ch->dev = dev;
 122     ch->state = ATA_IDLE;
 123     lockinit(&ch->state_mtx, "ataattach_state", 0, 0);
 124     lockinit(&ch->queue_mtx, "ataattach_queue", 0, 0);
 125     ata_queue_init(ch);
 126
 127     /* reset the controller HW, the channel and device(s) */
 128     while (ATA_LOCKING(dev, ATA_LF_LOCK) != ch->unit)
 129         tsleep(&error, 0, "ataatch", 1);
 130     ATA_RESET(dev);
 131     ATA_LOCKING(dev, ATA_LF_UNLOCK);
 132
 133     /* setup interrupt delivery */
 134     rid = ATA_IRQ_RID;
 135     ch->r_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
 136                                        RF_SHAREABLE | RF_ACTIVE);
 137     if (!ch->r_irq) {
 138         device_printf(dev, "unable to allocate interrupt\n");
 139         return ENXIO;
 140     }
 141     if ((error = bus_setup_intr(dev, ch->r_irq, ATA_INTR_FLAGS,
 142                                 (driver_intr_t *)ata_interrupt, ch, &ch->ih,
 143                                 NULL))) {
 144         device_printf(dev, "unable to setup interrupt\n");
 145         return error;
 146     }
 147
 148     /* probe and attach devices on this channel unless we are in early boot */
 149     ata_identify(dev);
 150     return 0;
 151 }
 152
 153 int
 154 ata_detach(device_t dev)
 155 {
 156     struct ata_channel *ch = device_get_softc(dev);
 157     device_t *children;
 158     int nchildren, i;
 159
 160     /* check that we have a valid channel to detach */
 161     if (!ch->r_irq)
 162         return ENXIO;
 163
 164     /* grap the channel lock so no new requests gets launched */
 165     lockmgr(&ch->state_mtx, LK_EXCLUSIVE);
 166     ch->state |= ATA_STALL_QUEUE;
 167     lockmgr(&ch->state_mtx, LK_RELEASE);
 168
 169     /* detach & delete all children */
 170     if (!device_get_children(dev, &children, &nchildren)) {
 171         for (i = 0; i < nchildren; i++)
 172             if (children[i])
 173                 device_delete_child(dev, children[i]);
 174         kfree(children, M_TEMP);
 175     }
 176
 177     /* release resources */
 178     bus_teardown_intr(dev, ch->r_irq, ch->ih);
 179     bus_release_resource(dev, SYS_RES_IRQ, ATA_IRQ_RID, ch->r_irq);
 180     ch->r_irq = NULL;
 181     lockuninit(&ch->state_mtx);
 182     lockuninit(&ch->queue_mtx);
 183     return 0;
 184 }
 185
 186 int
 187 ata_reinit(device_t dev)
 188 {
 189     struct ata_channel *ch = device_get_softc(dev);
 190     struct ata_request *request;
 191     device_t *children;
 192     int nchildren, i;
 193
 194     /* check that we have a valid channel to reinit */
 195     if (!ch || !ch->r_irq)
 196         return ENXIO;
 197
 198     if (bootverbose)
 199         device_printf(dev, "reiniting channel ..\n");
 200
 201     /* poll for locking the channel */
 202     while (ATA_LOCKING(dev, ATA_LF_LOCK) != ch->unit)
 203         tsleep(&dev, 0, "atarini", 1);
 204
 205     /* catch eventual request in ch->running */
 206     lockmgr(&ch->state_mtx, LK_EXCLUSIVE);
 207     if ((request = ch->running))
 208         callout_stop_sync(&request->callout);
 209     ch->running = NULL;
 210
 211     /* unconditionally grap the channel lock */
 212     ch->state |= ATA_STALL_QUEUE;
 213     lockmgr(&ch->state_mtx, LK_RELEASE);
 214
 215     /* reset the controller HW, the channel and device(s) */
 216     ATA_RESET(dev);
 217
 218     /* reinit the children and delete any that fails */
 219     if (!device_get_children(dev, &children, &nchildren)) {
 220         get_mplock();
 221         for (i = 0; i < nchildren; i++) {
 222             /* did any children go missing ? */
 223             if (children[i] && device_is_attached(children[i]) &&
 224                 ATA_REINIT(children[i])) {
 225                 /*
 226                  * if we had a running request and its device matches
 227                  * this child we need to inform the request that the
 228                  * device is gone.
 229                  */
 230                 if (request && request->dev == children[i]) {
 231                     request->result = ENXIO;
 232                     device_printf(request->dev, "FAILURE - device detached\n");
 233
 234                     /* if not timeout finish request here */
 235                     if (!(request->flags & ATA_R_TIMEOUT))
 236                             ata_finish(request);
 237                     request = NULL;
 238                 }
 239                 device_delete_child(dev, children[i]);
 240             }
 241         }
 242         kfree(children, M_TEMP);
 243         rel_mplock();
 244     }
 245
 246     /* if we still have a good request put it on the queue again */
 247     if (request && !(request->flags & ATA_R_TIMEOUT)) {
 248         device_printf(request->dev,
 249                       "WARNING - %s requeued due to channel reset",
 250                       ata_cmd2str(request));
 251         if (!(request->flags & (ATA_R_ATAPI | ATA_R_CONTROL)))
 252             kprintf(" LBA=%ju", request->u.ata.lba);
 253         kprintf("\n");
 254         request->flags |= ATA_R_REQUEUE;
 255         ata_queue_request(request);
 256     }
 257
 258     /* we're done release the channel for new work */
 259     lockmgr(&ch->state_mtx, LK_EXCLUSIVE);
 260     ch->state = ATA_IDLE;
 261     lockmgr(&ch->state_mtx, LK_RELEASE);
 262     ATA_LOCKING(dev, ATA_LF_UNLOCK);
 263
 264     if (bootverbose)
 265         device_printf(dev, "reinit done ..\n");
 266
 267     /* kick off requests on the queue */
 268     ata_start(dev);
 269     return 0;
 270 }
 271
 272 int
 273 ata_suspend(device_t dev)
 274 {
 275     struct ata_channel *ch;
 276
 277     /* check for valid device */
 278     if (!dev || !(ch = device_get_softc(dev)))
 279         return ENXIO;
 280
 281     /* wait for the channel to be IDLE or detached before suspending */
 282     while (ch->r_irq) {
 283         lockmgr(&ch->state_mtx, LK_EXCLUSIVE);
 284         if (ch->state == ATA_IDLE) {
 285             ch->state = ATA_ACTIVE;
 286             lockmgr(&ch->state_mtx, LK_RELEASE);
 287             break;
 288         }
 289         lockmgr(&ch->state_mtx, LK_RELEASE);
 290         tsleep(ch, 0, "atasusp", hz/10);
 291     }
 292     ATA_LOCKING(dev, ATA_LF_UNLOCK);
 293     return 0;
 294 }
 295
 296 int
 297 ata_resume(device_t dev)
 298 {
 299     struct ata_channel *ch;
 300     int error;
 301
 302     /* check for valid device */
 303     if (!dev || !(ch = device_get_softc(dev)))
 304         return ENXIO;
 305
 306     /* reinit the devices, we dont know what mode/state they are in */
 307     error = ata_reinit(dev);
 308
 309     /* kick off requests on the queue */
 310     ata_start(dev);
 311     return error;
 312 }
 313
 314 int
 315 ata_interrupt(void *data)
 316 {
 317     struct ata_channel *ch = (struct ata_channel *)data;
 318     struct ata_request *request;
 319
 320     lockmgr(&ch->state_mtx, LK_EXCLUSIVE);
 321     do {
 322         /*
 323          * Ignore interrupt if its not for us.  This may also have the
 324          * side effect of processing events unrelated to I/O requests.
 325          */
 326         if (ch->hw.status && !ch->hw.status(ch->dev))
 327             break;
 328
 329         /*
 330          * Check if we have a running request, and make sure it has been
 331          * completely queued.  Otherwise the channel status may indicate
 332          * not-busy when, in fact, the command had not yet been issued.
 333          */
 334         if ((request = ch->running) == NULL)
 335             break;
 336         if ((request->flags & ATA_R_HWCMDQUEUED) == 0) {
 337             kprintf("ata_interrupt: early interrupt\n");
 338             break;
 339         }
 340
 341         ATA_DEBUG_RQ(request, "interrupt");
 342
 343         /* safetycheck for the right state */
 344         if (ch->state == ATA_IDLE) {
 345             device_printf(request->dev, "interrupt on idle channel ignored\n");
 346             break;
 347         }
 348
 349         /*
 350          * we have the HW locks, so end the transaction for this request
 351          * if it finishes immediately otherwise wait for next interrupt
 352          */
 353         if (ch->hw.end_transaction(request) == ATA_OP_FINISHED) {
 354             ch->running = NULL;
 355             if (ch->state == ATA_ACTIVE)
 356                 ch->state = ATA_IDLE;
 357             lockmgr(&ch->state_mtx, LK_RELEASE);
 358             ATA_LOCKING(ch->dev, ATA_LF_UNLOCK);
 359             ata_finish(request);
 360             return 1;
 361         }
 362     } while (0);
 363     lockmgr(&ch->state_mtx, LK_RELEASE);
 364     return 0;
 365 }
 366
 367 /*
 368  * device related interfaces
 369  */
 370 static int
 371 ata_ioctl(struct dev_ioctl_args *ap)
 372 {
 373     device_t device, *children;
 374     struct ata_ioc_devices *devices = (struct ata_ioc_devices *)ap->a_data;
 375     int *value = (int *)ap->a_data;
 376     int i, nchildren, error = ENOTTY;
 377
 378     switch (ap->a_cmd) {
 379     case IOCATAGMAXCHANNEL:
 380         *value = devclass_get_maxunit(ata_devclass);
 381         error = 0;
 382         break;
 383
 384     case IOCATAREINIT:
 385         if (*value > devclass_get_maxunit(ata_devclass) ||
 386             !(device = devclass_get_device(ata_devclass, *value)))
 387             return ENXIO;
 388         error = ata_reinit(device);
 389         ata_start(device);
 390         break;
 391
 392     case IOCATAATTACH:
 393         if (*value > devclass_get_maxunit(ata_devclass) ||
 394             !(device = devclass_get_device(ata_devclass, *value)))
 395             return ENXIO;
 396         /* XXX SOS should enable channel HW on controller */
 397         error = ata_attach(device);
 398         break;
 399
 400     case IOCATADETACH:
 401         if (*value > devclass_get_maxunit(ata_devclass) ||
 402             !(device = devclass_get_device(ata_devclass, *value)))
 403             return ENXIO;
 404         error = ata_detach(device);
 405         /* XXX SOS should disable channel HW on controller */
 406         break;
 407
 408     case IOCATADEVICES:
 409         if (devices->channel > devclass_get_maxunit(ata_devclass) ||
 410             !(device = devclass_get_device(ata_devclass, devices->channel)))
 411             return ENXIO;
 412         bzero(devices->name[0], 32);
 413         bzero(&devices->params[0], sizeof(struct ata_params));
 414         bzero(devices->name[1], 32);
 415         bzero(&devices->params[1], sizeof(struct ata_params));
 416         if (!device_get_children(device, &children, &nchildren)) {
 417             for (i = 0; i < nchildren; i++) {
 418                 if (children[i] && device_is_attached(children[i])) {
 419                     struct ata_device *atadev = device_get_softc(children[i]);
 420
 421                     if (atadev->unit == ATA_MASTER) {
 422                         strncpy(devices->name[0],
 423                                 device_get_nameunit(children[i]), 32);
 424                         bcopy(&atadev->param, &devices->params[0],
 425                               sizeof(struct ata_params));
 426                     }
 427                     if (atadev->unit == ATA_SLAVE) {
 428                         strncpy(devices->name[1],
 429                                 device_get_nameunit(children[i]), 32);
 430                         bcopy(&atadev->param, &devices->params[1],
 431                               sizeof(struct ata_params));
 432                     }
 433                 }
 434             }
 435             kfree(children, M_TEMP);
 436             error = 0;
 437         }
 438         else
 439             error = ENODEV;
 440         break;
 441
 442     default:
 443         if (ata_raid_ioctl_func)
 444             error = ata_raid_ioctl_func(ap->a_cmd, ap->a_data);
 445     }
 446     return error;
 447 }
 448
 449 int
 450 ata_device_ioctl(device_t dev, u_long cmd, caddr_t data)
 451 {
 452     struct ata_device *atadev = device_get_softc(dev);
 453     struct ata_ioc_request *ioc_request = (struct ata_ioc_request *)data;
 454     struct ata_params *params = (struct ata_params *)data;
 455     int *mode = (int *)data;
 456     struct ata_request *request;
 457     caddr_t buf;
 458     int error;
 459
 460     switch (cmd) {
 461     case IOCATAREQUEST:
 462         if (!(buf = kmalloc(ioc_request->count, M_ATA, M_WAITOK | M_NULLOK))) {
 463             return ENOMEM;
 464         }
 465         if (!(request = ata_alloc_request())) {
 466             kfree(buf, M_ATA);
 467             return  ENOMEM;
 468         }
 469         if (ioc_request->flags & ATA_CMD_WRITE) {
 470             error = copyin(ioc_request->data, buf, ioc_request->count);
 471             if (error) {
 472                 kfree(buf, M_ATA);
 473                 ata_free_request(request);
 474                 return error;
 475             }
 476         }
 477         request->dev = dev;
 478         if (ioc_request->flags & ATA_CMD_ATAPI) {
 479             request->flags = ATA_R_ATAPI;
 480             bcopy(ioc_request->u.atapi.ccb, request->u.atapi.ccb, 16);
 481         }
 482         else {
 483             request->u.ata.command = ioc_request->u.ata.command;
 484             request->u.ata.feature = ioc_request->u.ata.feature;
 485             request->u.ata.lba = ioc_request->u.ata.lba;
 486             request->u.ata.count = ioc_request->u.ata.count;
 487         }
 488         request->timeout = ioc_request->timeout;
 489         request->data = buf;
 490         request->bytecount = ioc_request->count;
 491         request->transfersize = request->bytecount;
 492         if (ioc_request->flags & ATA_CMD_CONTROL)
 493             request->flags |= ATA_R_CONTROL;
 494         if (ioc_request->flags & ATA_CMD_READ)
 495             request->flags |= ATA_R_READ;
 496         if (ioc_request->flags & ATA_CMD_WRITE)
 497             request->flags |= ATA_R_WRITE;
 498         ata_queue_request(request);
 499         if (request->flags & ATA_R_ATAPI) {
 500             bcopy(&request->u.atapi.sense, &ioc_request->u.atapi.sense,
 501                   sizeof(struct atapi_sense));
 502         }
 503         else {
 504             ioc_request->u.ata.command = request->u.ata.command;
 505             ioc_request->u.ata.feature = request->u.ata.feature;
 506             ioc_request->u.ata.lba = request->u.ata.lba;
 507             ioc_request->u.ata.count = request->u.ata.count;
 508         }
 509         ioc_request->error = request->result;
 510         if (ioc_request->flags & ATA_CMD_READ)
 511             error = copyout(buf, ioc_request->data, ioc_request->count);
 512         else
 513             error = 0;
 514         kfree(buf, M_ATA);
 515         ata_free_request(request);
 516         return error;
 517
 518     case IOCATAGPARM:
 519         ata_getparam(atadev, 0);
 520         bcopy(&atadev->param, params, sizeof(struct ata_params));
 521         return 0;
 522
 523     case IOCATASMODE:
 524         atadev->mode = *mode;
 525         ATA_SETMODE(device_get_parent(dev), dev);
 526         return 0;
 527
 528     case IOCATAGMODE:
 529         *mode = atadev->mode;
 530         return 0;
 531     default:
 532         return ENOTTY;
 533     }
 534 }
 535
 536 #if 0
 537
 538 static void
 539 ata_boot_attach(void)
 540 {
 541     struct ata_channel *ch;
 542     int ctlr;
 543
 544     get_mplock();
 545
 546     /* kick of probe and attach on all channels */
 547     for (ctlr = 0; ctlr < devclass_get_maxunit(ata_devclass); ctlr++) {
 548         if ((ch = devclass_get_softc(ata_devclass, ctlr))) {
 549             ata_identify(ch->dev);
 550         }
 551     }
 552
 553     rel_mplock();
 554 }
 555
 556 #endif
 557
 558 void
 559 ata_print_cable(device_t dev, u_int8_t *who)
 560 {
 561     device_printf(dev,
 562                   "DMA limited to UDMA33, %s found non-ATA66 cable\n", who);
 563 }
 564
 565 /*
 566  * misc support functions
 567  */
 568 static device_t
 569 ata_add_child(device_t parent, struct ata_device *atadev, int unit)
 570 {
 571     device_t child;
 572
 573     if ((child = device_add_child(parent, NULL, unit))) {
 574         device_set_softc(child, atadev);
 575         device_quiet(child);
 576         atadev->dev = child;
 577         atadev->max_iosize = DEV_BSIZE;
 578         atadev->mode = ATA_PIO_MAX;
 579     }
 580     return child;
 581 }
 582
 583 static int
 584 ata_getparam(struct ata_device *atadev, int init)
 585 {
 586     struct ata_channel *ch = device_get_softc(device_get_parent(atadev->dev));
 587     struct ata_request *request;
 588     u_int8_t command = 0;
 589     int error = ENOMEM, retries = 2;
 590
 591     if (ch->devices &
 592         (atadev->unit == ATA_MASTER ? ATA_ATA_MASTER : ATA_ATA_SLAVE))
 593         command = ATA_ATA_IDENTIFY;
 594     if (ch->devices &
 595         (atadev->unit == ATA_MASTER ? ATA_ATAPI_MASTER : ATA_ATAPI_SLAVE))
 596         command = ATA_ATAPI_IDENTIFY;
 597     if (!command)
 598         return ENXIO;
 599
 600     while (retries-- > 0 && error) {
 601         if (!(request = ata_alloc_request()))
 602             break;
 603         request->dev = atadev->dev;
 604         request->timeout = 1;
 605         request->retries = 0;
 606         request->u.ata.command = command;
 607         request->flags = (ATA_R_READ|ATA_R_AT_HEAD|ATA_R_DIRECT|ATA_R_QUIET);
 608         request->data = (void *)&atadev->param;
 609         request->bytecount = sizeof(struct ata_params);
 610         request->donecount = 0;
 611         request->transfersize = DEV_BSIZE;
 612         ata_queue_request(request);
 613         error = request->result;
 614         ata_free_request(request);
 615     }
 616
 617     if (!error && (isprint(atadev->param.model[0]) ||
 618                    isprint(atadev->param.model[1]))) {
 619         struct ata_params *atacap = &atadev->param;
 620         int16_t *ptr;
 621
 622         for (ptr = (int16_t *)atacap;
 623              ptr < (int16_t *)atacap + sizeof(struct ata_params)/2; ptr++) {
 624             *ptr = le16toh(*ptr);
 625         }
 626         if (!(!strncmp(atacap->model, "FX", 2) ||
 627               !strncmp(atacap->model, "NEC", 3) ||
 628               !strncmp(atacap->model, "Pioneer", 7) ||
 629               !strncmp(atacap->model, "SHARP", 5))) {
 630             bswap(atacap->model, sizeof(atacap->model));
 631             bswap(atacap->revision, sizeof(atacap->revision));
 632             bswap(atacap->serial, sizeof(atacap->serial));
 633         }
 634         btrim(atacap->model, sizeof(atacap->model));
 635         bpack(atacap->model, atacap->model, sizeof(atacap->model));
 636         btrim(atacap->revision, sizeof(atacap->revision));
 637         bpack(atacap->revision, atacap->revision, sizeof(atacap->revision));
 638         btrim(atacap->serial, sizeof(atacap->serial));
 639         bpack(atacap->serial, atacap->serial, sizeof(atacap->serial));
 640
 641         if (bootverbose)
 642             kprintf("ata%d-%s: pio=%s wdma=%s udma=%s cable=%s wire\n",
 643                    device_get_unit(ch->dev),
 644                    atadev->unit == ATA_MASTER ? "master" : "slave",
 645                    ata_mode2str(ata_pmode(atacap)),
 646                    ata_mode2str(ata_wmode(atacap)),
 647                    ata_mode2str(ata_umode(atacap)),
 648                    (atacap->hwres & ATA_CABLE_ID) ? "80":"40");
 649
 650         if (init) {
 651             char buffer[64];
 652
 653             ksprintf(buffer, "%.40s/%.8s", atacap->model, atacap->revision);
 654             device_set_desc_copy(atadev->dev, buffer);
 655             if ((atadev->param.config & ATA_PROTO_ATAPI) &&
 656                 (atadev->param.config != ATA_CFA_MAGIC1) &&
 657                 (atadev->param.config != ATA_CFA_MAGIC2)) {
 658                 if (atapi_dma && ch->dma &&
 659                     (atadev->param.config & ATA_DRQ_MASK) != ATA_DRQ_INTR &&
 660                     ata_umode(&atadev->param) >= ATA_UDMA2)
 661                     atadev->mode = ATA_DMA_MAX;
 662             }
 663             else {
 664                 if (ata_dma && ch->dma &&
 665                     (ata_umode(&atadev->param) > 0 ||
 666                      ata_wmode(&atadev->param) > 0))
 667                     atadev->mode = ATA_DMA_MAX;
 668             }
 669         }
 670     }
 671     else {
 672         if (!error)
 673             error = ENXIO;
 674     }
 675     return error;
 676 }
 677
 678 int
 679 ata_identify(device_t dev)
 680 {
 681     struct ata_channel *ch = device_get_softc(dev);
 682     struct ata_device *master = NULL, *slave = NULL;
 683     device_t master_child = NULL, slave_child = NULL;
 684     int master_unit = -1, slave_unit = -1;
 685
 686     if (ch->devices & (ATA_ATA_MASTER | ATA_ATAPI_MASTER)) {
 687         if (!(master = kmalloc(sizeof(struct ata_device),
 688                               M_ATA, M_INTWAIT | M_ZERO))) {
 689             device_printf(dev, "out of memory\n");
 690             return ENOMEM;
 691         }
 692         master->unit = ATA_MASTER;
 693     }
 694     if (ch->devices & (ATA_ATA_SLAVE | ATA_ATAPI_SLAVE)) {
 695         if (!(slave = kmalloc(sizeof(struct ata_device),
 696                              M_ATA, M_INTWAIT | M_ZERO))) {
 697             kfree(master, M_ATA);
 698             device_printf(dev, "out of memory\n");
 699             return ENOMEM;
 700         }
 701         slave->unit = ATA_SLAVE;
 702     }
 703
 704 #ifdef ATA_STATIC_ID
 705     if (ch->devices & ATA_ATA_MASTER)
 706         master_unit = (device_get_unit(dev) << 1);
 707 #endif
 708     if (master && !(master_child = ata_add_child(dev, master, master_unit))) {
 709         kfree(master, M_ATA);
 710         master = NULL;
 711     }
 712 #ifdef ATA_STATIC_ID
 713     if (ch->devices & ATA_ATA_SLAVE)
 714         slave_unit = (device_get_unit(dev) << 1) + 1;
 715 #endif
 716     if (slave && !(slave_child = ata_add_child(dev, slave, slave_unit))) {
 717         kfree(slave, M_ATA);
 718         slave = NULL;
 719     }
 720
 721     if (slave && ata_getparam(slave, 1)) {
 722         device_delete_child(dev, slave_child);
 723         kfree(slave, M_ATA);
 724     }
 725     if (master && ata_getparam(master, 1)) {
 726         device_delete_child(dev, master_child);
 727         kfree(master, M_ATA);
 728     }
 729
 730     bus_generic_probe(dev);
 731     bus_generic_attach(dev);
 732     return 0;
 733 }
 734
 735 void
 736 ata_default_registers(device_t dev)
 737 {
 738     struct ata_channel *ch = device_get_softc(dev);
 739
 740     /* fill in the defaults from whats setup already */
 741     ch->r_io[ATA_ERROR].res = ch->r_io[ATA_FEATURE].res;
 742     ch->r_io[ATA_ERROR].offset = ch->r_io[ATA_FEATURE].offset;
 743     ch->r_io[ATA_IREASON].res = ch->r_io[ATA_COUNT].res;
 744     ch->r_io[ATA_IREASON].offset = ch->r_io[ATA_COUNT].offset;
 745     ch->r_io[ATA_STATUS].res = ch->r_io[ATA_COMMAND].res;
 746     ch->r_io[ATA_STATUS].offset = ch->r_io[ATA_COMMAND].offset;
 747     ch->r_io[ATA_ALTSTAT].res = ch->r_io[ATA_CONTROL].res;
 748     ch->r_io[ATA_ALTSTAT].offset = ch->r_io[ATA_CONTROL].offset;
 749 }
 750
 751 void
 752 ata_modify_if_48bit(struct ata_request *request)
 753 {
 754     struct ata_channel *ch = device_get_softc(device_get_parent(request->dev));
 755     struct ata_device *atadev = device_get_softc(request->dev);
 756
 757     atadev->flags &= ~ATA_D_48BIT_ACTIVE;
 758
 759     if (((request->u.ata.lba + request->u.ata.count) >= ATA_MAX_28BIT_LBA ||
 760          request->u.ata.count > 256) &&
 761         atadev->param.support.command2 & ATA_SUPPORT_ADDRESS48) {
 762
 763         /* translate command into 48bit version */
 764         switch (request->u.ata.command) {
 765         case ATA_READ:
 766             request->u.ata.command = ATA_READ48;
 767             break;
 768         case ATA_READ_MUL:
 769             request->u.ata.command = ATA_READ_MUL48;
 770             break;
 771         case ATA_READ_DMA:
 772             if (ch->flags & ATA_NO_48BIT_DMA) {
 773                 if (request->transfersize > DEV_BSIZE)
 774                     request->u.ata.command = ATA_READ_MUL48;
 775                 else
 776                     request->u.ata.command = ATA_READ48;
 777                 request->flags &= ~ATA_R_DMA;
 778             }
 779             else
 780                 request->u.ata.command = ATA_READ_DMA48;
 781             break;
 782         case ATA_READ_DMA_QUEUED:
 783             if (ch->flags & ATA_NO_48BIT_DMA) {
 784                 if (request->transfersize > DEV_BSIZE)
 785                     request->u.ata.command = ATA_READ_MUL48;
 786                 else
 787                     request->u.ata.command = ATA_READ48;
 788                 request->flags &= ~ATA_R_DMA;
 789             }
 790             else
 791                 request->u.ata.command = ATA_READ_DMA_QUEUED48;
 792             break;
 793         case ATA_WRITE:
 794             request->u.ata.command = ATA_WRITE48;
 795             break;
 796         case ATA_WRITE_MUL:
 797             request->u.ata.command = ATA_WRITE_MUL48;
 798             break;
 799         case ATA_WRITE_DMA:
 800             if (ch->flags & ATA_NO_48BIT_DMA) {
 801                 if (request->transfersize > DEV_BSIZE)
 802                     request->u.ata.command = ATA_WRITE_MUL48;
 803                 else
 804                     request->u.ata.command = ATA_WRITE48;
 805                 request->flags &= ~ATA_R_DMA;
 806             }
 807             else
 808                 request->u.ata.command = ATA_WRITE_DMA48;
 809             break;
 810         case ATA_WRITE_DMA_QUEUED:
 811             if (ch->flags & ATA_NO_48BIT_DMA) {
 812                 if (request->transfersize > DEV_BSIZE)
 813                     request->u.ata.command = ATA_WRITE_MUL48;
 814                 else
 815                     request->u.ata.command = ATA_WRITE48;
 816                 request->u.ata.command = ATA_WRITE48;
 817                 request->flags &= ~ATA_R_DMA;
 818             }
 819             else
 820                 request->u.ata.command = ATA_WRITE_DMA_QUEUED48;
 821             break;
 822         case ATA_FLUSHCACHE:
 823             request->u.ata.command = ATA_FLUSHCACHE48;
 824             break;
 825         case ATA_READ_NATIVE_MAX_ADDRESS:
 826             request->u.ata.command = ATA_READ_NATIVE_MAX_ADDRESS48;
 827             break;
 828         case ATA_SET_MAX_ADDRESS:
 829             request->u.ata.command = ATA_SET_MAX_ADDRESS48;
 830             break;
 831         default:
 832             return;
 833         }
 834         atadev->flags |= ATA_D_48BIT_ACTIVE;
 835     }
 836 }
 837
 838 void
 839 ata_udelay(int interval)
 840 {
 841     /*
 842      * We can't use tsleep here, because we might be called from callout
 843      * context.
 844      */
 845     if (1 || interval < (1000000/hz))
 846         DELAY(interval);
 847     else
 848         tsleep(&interval, 0, "ataslp", 1 + interval / (1000000 / hz));
 849 }
 850
 851 const char *
 852 ata_mode2str(int mode)
 853 {
 854     switch (mode) {
 855     case -1: return "UNSUPPORTED";
 856     case ATA_PIO0: return "PIO0";
 857     case ATA_PIO1: return "PIO1";
 858     case ATA_PIO2: return "PIO2";
 859     case ATA_PIO3: return "PIO3";
 860     case ATA_PIO4: return "PIO4";
 861     case ATA_WDMA0: return "WDMA0";
 862     case ATA_WDMA1: return "WDMA1";
 863     case ATA_WDMA2: return "WDMA2";
 864     case ATA_UDMA0: return "UDMA16";
 865     case ATA_UDMA1: return "UDMA25";
 866     case ATA_UDMA2: return "UDMA33";
 867     case ATA_UDMA3: return "UDMA40";
 868     case ATA_UDMA4: return "UDMA66";
 869     case ATA_UDMA5: return "UDMA100";
 870     case ATA_UDMA6: return "UDMA133";
 871     case ATA_SA150: return "SATA150";
 872     case ATA_SA300: return "SATA300";
 873     case ATA_USB: return "USB";
 874     case ATA_USB1: return "USB1";
 875     case ATA_USB2: return "USB2";
 876     default:
 877         if (mode & ATA_DMA_MASK)
 878             return "BIOSDMA";
 879         else
 880             return "BIOSPIO";
 881     }
 882 }
 883
 884 int
 885 ata_atapi(device_t dev)
 886 {
 887     struct ata_channel *ch = device_get_softc(device_get_parent(dev));
 888     struct ata_device *atadev = device_get_softc(dev);
 889
 890     return ((atadev->unit == ATA_MASTER && ch->devices & ATA_ATAPI_MASTER) ||
 891             (atadev->unit == ATA_SLAVE && ch->devices & ATA_ATAPI_SLAVE));
 892 }
 893
 894 int
 895 ata_pmode(struct ata_params *ap)
 896 {
 897     if (ap->atavalid & ATA_FLAG_64_70) {
 898         if (ap->apiomodes & 0x02)
 899             return ATA_PIO4;
 900         if (ap->apiomodes & 0x01)
 901             return ATA_PIO3;
 902     }
 903     if (ap->mwdmamodes & 0x04)
 904         return ATA_PIO4;
 905     if (ap->mwdmamodes & 0x02)
 906         return ATA_PIO3;
 907     if (ap->mwdmamodes & 0x01)
 908         return ATA_PIO2;
 909     if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x200)
 910         return ATA_PIO2;
 911     if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x100)
 912         return ATA_PIO1;
 913     if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x000)
 914         return ATA_PIO0;
 915     return ATA_PIO0;
 916 }
 917
 918 int
 919 ata_wmode(struct ata_params *ap)
 920 {
 921     if (ap->mwdmamodes & 0x04)
 922         return ATA_WDMA2;
 923     if (ap->mwdmamodes & 0x02)
 924         return ATA_WDMA1;
 925     if (ap->mwdmamodes & 0x01)
 926         return ATA_WDMA0;
 927     return -1;
 928 }
 929
 930 int
 931 ata_umode(struct ata_params *ap)
 932 {
 933     if (ap->atavalid & ATA_FLAG_88) {
 934         if (ap->udmamodes & 0x40)
 935             return ATA_UDMA6;
 936         if (ap->udmamodes & 0x20)
 937             return ATA_UDMA5;
 938         if (ap->udmamodes & 0x10)
 939             return ATA_UDMA4;
 940         if (ap->udmamodes & 0x08)
 941             return ATA_UDMA3;
 942         if (ap->udmamodes & 0x04)
 943             return ATA_UDMA2;
 944         if (ap->udmamodes & 0x02)
 945             return ATA_UDMA1;
 946         if (ap->udmamodes & 0x01)
 947             return ATA_UDMA0;
 948     }
 949     return -1;
 950 }
 951
 952 int
 953 ata_limit_mode(device_t dev, int mode, int maxmode)
 954 {
 955     struct ata_device *atadev = device_get_softc(dev);
 956
 957     if (maxmode && mode > maxmode)
 958         mode = maxmode;
 959
 960     if (mode >= ATA_UDMA0 && ata_umode(&atadev->param) > 0)
 961         return min(mode, ata_umode(&atadev->param));
 962
 963     if (mode >= ATA_WDMA0 && ata_wmode(&atadev->param) > 0)
 964         return min(mode, ata_wmode(&atadev->param));
 965
 966     if (mode > ata_pmode(&atadev->param))
 967         return min(mode, ata_pmode(&atadev->param));
 968
 969     return mode;
 970 }
 971
 972 static void
 973 bswap(int8_t *buf, int len)
 974 {
 975     u_int16_t *ptr = (u_int16_t*)(buf + len);
 976
 977     while (--ptr >= (u_int16_t*)buf)
 978         *ptr = ntohs(*ptr);
 979 }
 980
 981 static void
 982 btrim(int8_t *buf, int len)
 983 {
 984     int8_t *ptr;
 985
 986     for (ptr = buf; ptr < buf+len; ++ptr)
 987         if (!*ptr || *ptr == '_')
 988             *ptr = ' ';
 989     for (ptr = buf + len - 1; ptr >= buf && *ptr == ' '; --ptr)
 990         *ptr = 0;
 991 }
 992
 993 static void
 994 bpack(int8_t *src, int8_t *dst, int len)
 995 {
 996     int i, j, blank;
 997
 998     for (i = j = blank = 0 ; i < len; i++) {
 999         if (blank && src[i] == ' ') continue;
1000         if (blank && src[i] != ' ') {
1001             dst[j++] = src[i];
1002             blank = 0;
1003             continue;
1004         }
1005         if (src[i] == ' ') {
1006             blank = 1;
1007             if (i == 0)
1008                 continue;
1009         }
1010         dst[j++] = src[i];
1011     }
1012     if (j < len)
1013         dst[j] = 0x00;
1014 }
1015
1016
1017 /*
1018  * module handeling
1019  */
1020 static int
1021 ata_module_event_handler(module_t mod, int what, void *arg)
1022 {
1023     /* static because we need the reference at destruction time */
1024     static cdev_t atacdev;
1025
1026     switch (what) {
1027     case MOD_LOAD:
1028         /* register controlling device */
1029         atacdev = make_dev(&ata_ops, 0, UID_ROOT, GID_OPERATOR, 0600, "ata");
1030         reference_dev(atacdev);
1031         return 0;
1032
1033     case MOD_UNLOAD:
1034         /* deregister controlling device */
1035         destroy_dev(atacdev);
1036         dev_ops_remove_all(&ata_ops);
1037         return 0;
1038
1039     default:
1040         return EOPNOTSUPP;
1041     }
1042 }
1043
1044 static moduledata_t ata_moduledata = { "ata", ata_module_event_handler, NULL };
1045 DECLARE_MODULE(ata, ata_moduledata, SI_SUB_CONFIGURE, SI_ORDER_SECOND);
1046 MODULE_VERSION(ata, 1);
1047
1048 /*
1049  * Construct a completely zero'ed ata_request. On objcache_put(), an
1050  * ata_request object is also zero'ed, so objcache_get() is guaranteed to give
1051  * completely zero'ed objects without spending too much time.
1052  */
1053 static boolean_t
1054 ata_request_cache_ctor(void *obj, void *private, int ocflags)
1055 {
1056     struct ata_request *arp = obj;
1057
1058     bzero(arp, sizeof(struct ata_request));
1059     return(TRUE);
1060 }
1061
1062 /*
1063  * Construct a completely zero'ed ata_composite. On objcache_put(), an
1064  * ata_composite object is also zero'ed, so objcache_get() is guaranteed to give
1065  * completely zero'ed objects without spending too much time.
1066  */
1067 static boolean_t
1068 ata_composite_cache_ctor(void *obj, void *private, int ocflags)
1069 {
1070     struct ata_composite *acp = obj;
1071
1072     bzero(acp, sizeof(struct ata_composite));
1073     return(TRUE);
1074 }
1075
1076 static void
1077 ata_init(void)
1078 {
1079     ata_request_cache = objcache_create("ata_request", 0, 0,
1080                                         ata_request_cache_ctor, NULL, NULL,
1081                                         objcache_malloc_alloc,
1082                                         objcache_malloc_free,
1083                                         &ata_request_malloc_args);
1084     ata_composite_cache = objcache_create("ata_composite", 0, 0,
1085                                           ata_composite_cache_ctor, NULL, NULL,
1086                                           objcache_malloc_alloc,
1087                                           objcache_malloc_free,
1088                                           &ata_composite_malloc_args);
1089 }
1090 SYSINIT(ata_register, SI_SUB_DRIVERS, SI_ORDER_SECOND, ata_init, NULL);
1091
1092 static void
1093 ata_uninit(void)
1094 {
1095     objcache_destroy(ata_composite_cache);
1096     objcache_destroy(ata_request_cache);
1097 }
1098 SYSUNINIT(ata_unregister, SI_SUB_DRIVERS, SI_ORDER_SECOND, ata_uninit, NULL);