sys/dev/ata/ata-disk.c

   1 /*-
   2  * Copyright (c) 1998 - 2007 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
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include "opt_ata.h"
  31 #include <sys/param.h>
  32 #include <sys/systm.h>
  33 #include <sys/ata.h>
  34 #include <sys/kernel.h>
  35 #include <sys/module.h>
  36 #include <sys/malloc.h>
  37 #include <sys/bio.h>
  38 #include <sys/bus.h>
  39 #include <sys/conf.h>
  40 #include <sys/disk.h>
  41 #include <sys/cons.h>
  42 #include <sys/sysctl.h>
  43 #include <sys/sema.h>
  44 #include <sys/taskqueue.h>
  45 #include <vm/uma.h>
  46 #include <machine/md_var.h>
  47 #include <machine/bus.h>
  48 #include <sys/rman.h>
  49 #include <geom/geom_disk.h>
  50 #include <dev/ata/ata-all.h>
  51 #include <dev/ata/ata-pci.h>
  52 #include <dev/ata/ata-disk.h>
  53 #include <dev/ata/ata-raid.h>
  54 #include <ata_if.h>
  55
  56 /* prototypes */
  57 static void ad_init(device_t);
  58 static void ad_done(struct ata_request *);
  59 static void ad_describe(device_t dev);
  60 static int ad_version(u_int16_t);
  61 static disk_strategy_t ad_strategy;
  62 static disk_ioctl_t ad_ioctl;
  63 static dumper_t ad_dump;
  64
  65 /*
  66  * Most platforms map firmware geom to actual, but some don't.  If
  67  * not overridden, default to nothing.
  68  */
  69 #ifndef ad_firmware_geom_adjust
  70 #define ad_firmware_geom_adjust(dev, disk)
  71 #endif
  72
  73 /* local vars */
  74 static MALLOC_DEFINE(M_AD, "ad_driver", "ATA disk driver");
  75
  76 static int
  77 ad_probe(device_t dev)
  78 {
  79     struct ata_device *atadev = device_get_softc(dev);
  80
  81     if (!(atadev->param.config & ATA_PROTO_ATAPI) ||
  82         (atadev->param.config == ATA_CFA_MAGIC1) ||
  83         (atadev->param.config == ATA_CFA_MAGIC2) ||
  84         (atadev->param.config == ATA_CFA_MAGIC3))
  85         return 0;
  86     else
  87         return ENXIO;
  88 }
  89
  90 static int
  91 ad_attach(device_t dev)
  92 {
  93     struct ata_channel *ch = device_get_softc(device_get_parent(dev));
  94     struct ata_device *atadev = device_get_softc(dev);
  95     struct ad_softc *adp;
  96     u_int32_t lbasize;
  97     u_int64_t lbasize48;
  98
  99     /* check that we have a virgin disk to attach */
 100     if (device_get_ivars(dev))
 101         return EEXIST;
 102
 103     if (!(adp = malloc(sizeof(struct ad_softc), M_AD, M_NOWAIT | M_ZERO))) {
 104         device_printf(dev, "out of memory\n");
 105         return ENOMEM;
 106     }
 107     device_set_ivars(dev, adp);
 108
 109     if ((atadev->param.atavalid & ATA_FLAG_54_58) &&
 110         atadev->param.current_heads && atadev->param.current_sectors) {
 111         adp->heads = atadev->param.current_heads;
 112         adp->sectors = atadev->param.current_sectors;
 113         adp->total_secs = (u_int32_t)atadev->param.current_size_1 |
 114                           ((u_int32_t)atadev->param.current_size_2 << 16);
 115     }
 116     else {
 117         adp->heads = atadev->param.heads;
 118         adp->sectors = atadev->param.sectors;
 119         adp->total_secs = atadev->param.cylinders * adp->heads * adp->sectors;
 120     }
 121     lbasize = (u_int32_t)atadev->param.lba_size_1 |
 122               ((u_int32_t)atadev->param.lba_size_2 << 16);
 123
 124     /* does this device need oldstyle CHS addressing */
 125     if (!ad_version(atadev->param.version_major) || !lbasize)
 126         atadev->flags |= ATA_D_USE_CHS;
 127
 128     /* use the 28bit LBA size if valid or bigger than the CHS mapping */
 129     if (atadev->param.cylinders == 16383 || adp->total_secs < lbasize)
 130         adp->total_secs = lbasize;
 131
 132     /* use the 48bit LBA size if valid */
 133     lbasize48 = ((u_int64_t)atadev->param.lba_size48_1) |
 134                 ((u_int64_t)atadev->param.lba_size48_2 << 16) |
 135                 ((u_int64_t)atadev->param.lba_size48_3 << 32) |
 136                 ((u_int64_t)atadev->param.lba_size48_4 << 48);
 137     if ((atadev->param.support.command2 & ATA_SUPPORT_ADDRESS48) &&
 138         lbasize48 > ATA_MAX_28BIT_LBA)
 139         adp->total_secs = lbasize48;
 140
 141     /* init device parameters */
 142     ad_init(dev);
 143
 144     /* announce we are here */
 145     ad_describe(dev);
 146
 147     /* create the disk device */
 148     adp->disk = disk_alloc();
 149     adp->disk->d_strategy = ad_strategy;
 150     adp->disk->d_ioctl = ad_ioctl;
 151     adp->disk->d_dump = ad_dump;
 152     adp->disk->d_name = "ad";
 153     adp->disk->d_drv1 = dev;
 154     if (ch->dma)
 155         adp->disk->d_maxsize = ch->dma->max_iosize;
 156     else
 157         adp->disk->d_maxsize = DFLTPHYS;
 158     adp->disk->d_sectorsize = DEV_BSIZE;
 159     adp->disk->d_mediasize = DEV_BSIZE * (off_t)adp->total_secs;
 160     adp->disk->d_fwsectors = adp->sectors;
 161     adp->disk->d_fwheads = adp->heads;
 162     adp->disk->d_unit = device_get_unit(dev);
 163     if (atadev->param.support.command2 & ATA_SUPPORT_FLUSHCACHE)
 164         adp->disk->d_flags = DISKFLAG_CANFLUSHCACHE;
 165     snprintf(adp->disk->d_ident, sizeof(adp->disk->d_ident), "ad:%s",
 166         atadev->param.serial);
 167     disk_create(adp->disk, DISK_VERSION);
 168     device_add_child(dev, "subdisk", device_get_unit(dev));
 169     ad_firmware_geom_adjust(dev, adp->disk);
 170     bus_generic_attach(dev);
 171     return 0;
 172 }
 173
 174 static int
 175 ad_detach(device_t dev)
 176 {
 177     struct ad_softc *adp = device_get_ivars(dev);
 178     device_t *children;
 179     int nchildren, i;
 180
 181     /* check that we have a valid disk to detach */
 182     if (!device_get_ivars(dev))
 183         return ENXIO;
 184
 185     /* detach & delete all children */
 186     if (!device_get_children(dev, &children, &nchildren)) {
 187         for (i = 0; i < nchildren; i++)
 188             if (children[i])
 189                 device_delete_child(dev, children[i]);
 190         free(children, M_TEMP);
 191     }
 192
 193     /* detroy disk from the system so we dont get any further requests */
 194     disk_destroy(adp->disk);
 195
 196     /* fail requests on the queue and any thats "in flight" for this device */
 197     ata_fail_requests(dev);
 198
 199     /* dont leave anything behind */
 200     device_set_ivars(dev, NULL);
 201     free(adp, M_AD);
 202     return 0;
 203 }
 204
 205 static void
 206 ad_shutdown(device_t dev)
 207 {
 208     struct ata_device *atadev = device_get_softc(dev);
 209
 210     if (atadev->param.support.command2 & ATA_SUPPORT_FLUSHCACHE)
 211         ata_controlcmd(dev, ATA_FLUSHCACHE, 0, 0, 0);
 212 }
 213
 214 static int
 215 ad_reinit(device_t dev)
 216 {
 217     struct ata_channel *ch = device_get_softc(device_get_parent(dev));
 218     struct ata_device *atadev = device_get_softc(dev);
 219
 220     /* if detach pending, return error */
 221     if (((atadev->unit == ATA_MASTER) && !(ch->devices & ATA_ATA_MASTER)) ||
 222         ((atadev->unit == ATA_SLAVE) && !(ch->devices & ATA_ATA_SLAVE))) {
 223         return 1;
 224     }
 225     ad_init(dev);
 226     return 0;
 227 }
 228
 229 static void
 230 ad_strategy(struct bio *bp)
 231 {
 232     device_t dev =  bp->bio_disk->d_drv1;
 233     struct ata_device *atadev = device_get_softc(dev);
 234     struct ata_request *request;
 235
 236     if (!(request = ata_alloc_request())) {
 237         device_printf(dev, "FAILURE - out of memory in start\n");
 238         biofinish(bp, NULL, ENOMEM);
 239         return;
 240     }
 241
 242     /* setup request */
 243     request->dev = dev;
 244     request->bio = bp;
 245     request->callback = ad_done;
 246     request->timeout = 5;
 247     request->retries = 2;
 248     request->data = bp->bio_data;
 249     request->bytecount = bp->bio_bcount;
 250     request->u.ata.lba = bp->bio_pblkno;
 251     request->u.ata.count = request->bytecount / DEV_BSIZE;
 252     request->transfersize = min(bp->bio_bcount, atadev->max_iosize);
 253
 254     switch (bp->bio_cmd) {
 255     case BIO_READ:
 256         request->flags = ATA_R_READ;
 257         if (atadev->mode >= ATA_DMA) {
 258             request->u.ata.command = ATA_READ_DMA;
 259             request->flags |= ATA_R_DMA;
 260         }
 261         else if (request->transfersize > DEV_BSIZE)
 262             request->u.ata.command = ATA_READ_MUL;
 263         else
 264             request->u.ata.command = ATA_READ;
 265         break;
 266     case BIO_WRITE:
 267         request->flags = ATA_R_WRITE;
 268         if (atadev->mode >= ATA_DMA) {
 269             request->u.ata.command = ATA_WRITE_DMA;
 270             request->flags |= ATA_R_DMA;
 271         }
 272         else if (request->transfersize > DEV_BSIZE)
 273             request->u.ata.command = ATA_WRITE_MUL;
 274         else
 275             request->u.ata.command = ATA_WRITE;
 276         break;
 277     case BIO_FLUSH:
 278         request->u.ata.lba = 0;
 279         request->u.ata.count = 0;
 280         request->u.ata.feature = 0;
 281         request->bytecount = 0;
 282         request->transfersize = 0;
 283         request->flags = ATA_R_CONTROL;
 284         request->u.ata.command = ATA_FLUSHCACHE;
 285         break;
 286     default:
 287         device_printf(dev, "FAILURE - unknown BIO operation\n");
 288         ata_free_request(request);
 289         biofinish(bp, NULL, EIO);
 290         return;
 291     }
 292     request->flags |= ATA_R_ORDERED;
 293     ata_queue_request(request);
 294 }
 295
 296 static void
 297 ad_done(struct ata_request *request)
 298 {
 299     struct bio *bp = request->bio;
 300
 301     /* finish up transfer */
 302     if ((bp->bio_error = request->result))
 303         bp->bio_flags |= BIO_ERROR;
 304     bp->bio_resid = bp->bio_bcount - request->donecount;
 305     biodone(bp);
 306     ata_free_request(request);
 307 }
 308
 309 static int
 310 ad_ioctl(struct disk *disk, u_long cmd, void *data, int flag, struct thread *td)
 311 {
 312     return ata_device_ioctl(disk->d_drv1, cmd, data);
 313 }
 314
 315 static int
 316 ad_dump(void *arg, void *virtual, vm_offset_t physical,
 317         off_t offset, size_t length)
 318 {
 319     struct disk *dp = arg;
 320     struct bio bp;
 321
 322     /* length zero is special and really means flush buffers to media */
 323     if (!length) {
 324         struct ata_device *atadev = device_get_softc(dp->d_drv1);
 325         int error = 0;
 326
 327         if (atadev->param.support.command2 & ATA_SUPPORT_FLUSHCACHE)
 328             error = ata_controlcmd(dp->d_drv1, ATA_FLUSHCACHE, 0, 0, 0);
 329         return error;
 330     }
 331
 332     bzero(&bp, sizeof(struct bio));
 333     bp.bio_disk = dp;
 334     bp.bio_pblkno = offset / DEV_BSIZE;
 335     bp.bio_bcount = length;
 336     bp.bio_data = virtual;
 337     bp.bio_cmd = BIO_WRITE;
 338     ad_strategy(&bp);
 339     return bp.bio_error;
 340 }
 341
 342 static void
 343 ad_init(device_t dev)
 344 {
 345     struct ata_device *atadev = device_get_softc(dev);
 346
 347     ATA_SETMODE(device_get_parent(dev), dev);
 348
 349     /* enable readahead caching */
 350     if (atadev->param.support.command1 & ATA_SUPPORT_LOOKAHEAD)
 351         ata_controlcmd(dev, ATA_SETFEATURES, ATA_SF_ENAB_RCACHE, 0, 0);
 352
 353     /* enable write caching if supported and configured */
 354     if (atadev->param.support.command1 & ATA_SUPPORT_WRITECACHE) {
 355         if (ata_wc)
 356             ata_controlcmd(dev, ATA_SETFEATURES, ATA_SF_ENAB_WCACHE, 0, 0);
 357         else
 358             ata_controlcmd(dev, ATA_SETFEATURES, ATA_SF_DIS_WCACHE, 0, 0);
 359     }
 360
 361     /* use multiple sectors/interrupt if device supports it */
 362     if (ad_version(atadev->param.version_major)) {
 363         int secsperint = max(1, min(atadev->param.sectors_intr, 16));
 364
 365         if (!ata_controlcmd(dev, ATA_SET_MULTI, 0, 0, secsperint))
 366             atadev->max_iosize = secsperint * DEV_BSIZE;
 367     }
 368     else
 369         atadev->max_iosize = DEV_BSIZE;
 370 }
 371
 372 void
 373 ad_describe(device_t dev)
 374 {
 375     struct ata_channel *ch = device_get_softc(device_get_parent(dev));
 376     struct ata_device *atadev = device_get_softc(dev);
 377     struct ad_softc *adp = device_get_ivars(dev);
 378     u_int8_t *marker, vendor[64], product[64];
 379
 380     /* try to seperate the ATA model string into vendor and model parts */
 381     if ((marker = index(atadev->param.model, ' ')) ||
 382         (marker = index(atadev->param.model, '-'))) {
 383         int len = (marker - atadev->param.model);
 384
 385         strncpy(vendor, atadev->param.model, len);
 386         vendor[len++] = 0;
 387         strcat(vendor, " ");
 388         strncpy(product, atadev->param.model + len, 40 - len);
 389         vendor[40 - len] = 0;
 390     }
 391     else {
 392         if (!strncmp(atadev->param.model, "ST", 2))
 393             strcpy(vendor, "Seagate ");
 394         else
 395             strcpy(vendor, "");
 396         strncpy(product, atadev->param.model, 40);
 397     }
 398
 399     device_printf(dev, "%juMB <%s%s %.8s> at ata%d-%s %s%s\n",
 400                   adp->total_secs / (1048576 / DEV_BSIZE),
 401                   vendor, product, atadev->param.revision,
 402                   device_get_unit(ch->dev),
 403                   (atadev->unit == ATA_MASTER) ? "master" : "slave",
 404                   (adp->flags & AD_F_TAG_ENABLED) ? "tagged " : "",
 405                   ata_mode2str(atadev->mode));
 406     if (bootverbose) {
 407         device_printf(dev, "%ju sectors [%juC/%dH/%dS] "
 408                       "%d sectors/interrupt %d depth queue\n", adp->total_secs,
 409                       adp->total_secs / (adp->heads * adp->sectors),
 410                       adp->heads, adp->sectors, atadev->max_iosize / DEV_BSIZE,
 411                       adp->num_tags + 1);
 412     }
 413 }
 414
 415 static int
 416 ad_version(u_int16_t version)
 417 {
 418     int bit;
 419
 420     if (version == 0xffff)
 421         return 0;
 422     for (bit = 15; bit >= 0; bit--)
 423         if (version & (1<<bit))
 424             return bit;
 425     return 0;
 426 }
 427
 428 static device_method_t ad_methods[] = {
 429     /* device interface */
 430     DEVMETHOD(device_probe,     ad_probe),
 431     DEVMETHOD(device_attach,    ad_attach),
 432     DEVMETHOD(device_detach,    ad_detach),
 433     DEVMETHOD(device_shutdown,  ad_shutdown),
 434
 435     /* ATA methods */
 436     DEVMETHOD(ata_reinit,       ad_reinit),
 437
 438     { 0, 0 }
 439 };
 440
 441 static driver_t ad_driver = {
 442     "ad",
 443     ad_methods,
 444     0,
 445 };
 446
 447 devclass_t ad_devclass;
 448
 449 DRIVER_MODULE(ad, ata, ad_driver, ad_devclass, NULL, NULL);
 450 MODULE_VERSION(ad, 1);
 451 MODULE_DEPEND(ad, ata, 1, 1, 1);