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