sys/dev/disk/nata/ata-disk.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-disk.c,v 1.197 2006/03/31 08:09:04 sos Exp $
  27  * $DragonFly: src/sys/dev/disk/nata/ata-disk.c,v 1.3 2007/05/15 00:01:03 dillon Exp $
  28  */
  29
  30 #include "opt_ata.h"
  31
  32 #include <sys/param.h>
  33 #include <sys/bio.h>
  34 #include <sys/buf.h>
  35 #include <sys/bus.h>
  36 #include <sys/device.h>
  37 #include <sys/devicestat.h>
  38 #include <sys/disk.h>
  39 #include <sys/libkern.h>
  40 #include <sys/malloc.h>
  41 #include <sys/module.h>
  42 #include <sys/nata.h>
  43 #include <sys/systm.h>
  44
  45 #include <vm/pmap.h>
  46
  47 #include <machine/md_var.h>
  48
  49 #include "ata-all.h"
  50 #include "ata-disk.h"
  51 #include "ata_if.h"
  52
  53 /* device structure */
  54 static  d_open_t        ad_open;
  55 static  d_close_t       ad_close;
  56 static  d_ioctl_t       ad_ioctl;
  57 static  d_strategy_t    ad_strategy;
  58 static  d_dump_t        ad_dump;
  59 static struct dev_ops ad_ops = {
  60         { "ad", 116, D_DISK },
  61         .d_open =       ad_open,
  62         .d_close =      ad_close,
  63         .d_read =       physread,
  64         .d_write =      physwrite,
  65         .d_ioctl =      ad_ioctl,
  66         .d_strategy =   ad_strategy,
  67         .d_dump =       ad_dump,
  68 };
  69
  70 /* prototypes */
  71 static void ad_init(device_t);
  72 static void ad_done(struct ata_request *);
  73 static void ad_describe(device_t dev);
  74 static int ad_version(u_int16_t);
  75
  76 /* local vars */
  77 static MALLOC_DEFINE(M_AD, "ad_driver", "ATA disk driver");
  78
  79 static int
  80 ad_probe(device_t dev)
  81 {
  82     struct ata_device *atadev = device_get_softc(dev);
  83
  84     if (!(atadev->param.config & ATA_PROTO_ATAPI) ||
  85         (atadev->param.config == ATA_CFA_MAGIC1) ||
  86         (atadev->param.config == ATA_CFA_MAGIC2))
  87         return 0;
  88     else
  89         return ENXIO;
  90 }
  91
  92 static int
  93 ad_attach(device_t dev)
  94 {
  95     struct ata_channel *ch = device_get_softc(device_get_parent(dev));
  96     struct ata_device *atadev = device_get_softc(dev);
  97     struct disk_info info;
  98     struct ad_softc *adp;
  99     cdev_t cdev;
 100     u_int32_t lbasize;
 101     u_int64_t lbasize48;
 102
 103     /* check that we have a virgin disk to attach */
 104     if (device_get_ivars(dev))
 105         return EEXIST;
 106
 107     /* XXX TGEN We're not in interrupt context, so we can M_WAITOK and remove
 108        the OOM check. */
 109     if (!(adp = kmalloc(sizeof(struct ad_softc), M_AD, M_NOWAIT | M_ZERO))) {
 110         device_printf(dev, "out of memory\n");
 111         return ENOMEM;
 112     }
 113     device_set_ivars(dev, adp);
 114
 115     if (atadev->param.atavalid & ATA_FLAG_54_58) {
 116         adp->heads = atadev->param.current_heads;
 117         adp->sectors = atadev->param.current_sectors;
 118         adp->total_secs = (u_int32_t)atadev->param.current_size_1 |
 119                           ((u_int32_t)atadev->param.current_size_2 << 16);
 120     }
 121     else {
 122         adp->heads = atadev->param.heads;
 123         adp->sectors = atadev->param.sectors;
 124         adp->total_secs = atadev->param.cylinders * adp->heads * adp->sectors;
 125     }
 126     lbasize = (u_int32_t)atadev->param.lba_size_1 |
 127               ((u_int32_t)atadev->param.lba_size_2 << 16);
 128
 129     /* does this device need oldstyle CHS addressing */
 130     if (!ad_version(atadev->param.version_major) || !lbasize)
 131         atadev->flags |= ATA_D_USE_CHS;
 132
 133     /* use the 28bit LBA size if valid or bigger than the CHS mapping */
 134     if (atadev->param.cylinders == 16383 || adp->total_secs < lbasize)
 135         adp->total_secs = lbasize;
 136
 137     /* use the 48bit LBA size if valid */
 138     lbasize48 = ((u_int64_t)atadev->param.lba_size48_1) |
 139                 ((u_int64_t)atadev->param.lba_size48_2 << 16) |
 140                 ((u_int64_t)atadev->param.lba_size48_3 << 32) |
 141                 ((u_int64_t)atadev->param.lba_size48_4 << 48);
 142     if ((atadev->param.support.command2 & ATA_SUPPORT_ADDRESS48) &&
 143         lbasize48 > ATA_MAX_28BIT_LBA)
 144         adp->total_secs = lbasize48;
 145
 146     /* init device parameters */
 147     ad_init(dev);
 148
 149     /* create the disk device */
 150     /* XXX TGEN Maybe use DEVSTAT_ALL_SUPPORTED, DEVSTAT_TYPE_DIRECT,
 151        DEVSTAT_PRIORITY_MAX. */
 152     devstat_add_entry(&adp->stats, "ad", device_get_unit(dev), DEV_BSIZE,
 153                       DEVSTAT_NO_ORDERED_TAGS,
 154                       DEVSTAT_TYPE_DIRECT | DEVSTAT_TYPE_IF_IDE,
 155                       DEVSTAT_PRIORITY_DISK);
 156     cdev = disk_create(device_get_unit(dev), &adp->disk, &ad_ops);
 157     cdev->si_drv1 = dev;
 158     if (ch->dma)
 159         cdev->si_iosize_max = ch->dma->max_iosize;
 160     else
 161         cdev->si_iosize_max = DFLTPHYS;
 162     adp->cdev = cdev;
 163
 164     bzero(&info, sizeof(info));
 165     info.d_media_blksize = DEV_BSIZE;           /* mandatory */
 166     info.d_media_blocks = adp->total_secs;
 167
 168     info.d_secpertrack = adp->sectors;          /* optional */
 169     info.d_nheads = adp->heads;
 170     info.d_ncylinders = adp->total_secs/(adp->heads*adp->sectors);
 171     info.d_secpercyl = adp->sectors * adp->heads;
 172
 173     device_add_child(dev, "subdisk", device_get_unit(dev));
 174     bus_generic_attach(dev);
 175
 176     /* announce we are here */
 177     ad_describe(dev);
 178
 179     disk_setdiskinfo(&adp->disk, &info);
 180
 181     return 0;
 182 }
 183
 184 static int
 185 ad_detach(device_t dev)
 186 {
 187     struct ad_softc *adp = device_get_ivars(dev);
 188     device_t *children;
 189     int nchildren, i;
 190
 191     /* check that we have a valid disk to detach */
 192     if (!adp)
 193         return ENXIO;
 194
 195 #if 0 /* XXX TGEN Probably useless, we fail the queue below. */
 196     /* check that the disk is closed */
 197     if (adp->ad_flags & AD_DISK_OPEN)
 198         return EBUSY;
 199 #endif /* 0 */
 200
 201     /* detach & delete all children */
 202     if (!device_get_children(dev, &children, &nchildren)) {
 203         for (i = 0; i < nchildren; i++)
 204             if (children[i])
 205                 device_delete_child(dev, children[i]);
 206         kfree(children, M_TEMP);
 207     }
 208
 209     /* detroy disk from the system so we dont get any further requests */
 210     disk_invalidate(&adp->disk);
 211     disk_destroy(&adp->disk);
 212
 213     /* fail requests on the queue and any thats "in flight" for this device */
 214     ata_fail_requests(dev);
 215
 216     /* dont leave anything behind */
 217     /* disk_destroy() already took care of the dev_ops */
 218     devstat_remove_entry(&adp->stats);
 219     device_set_ivars(dev, NULL);
 220     kfree(adp, M_AD);
 221     return 0;
 222 }
 223
 224 static void
 225 ad_shutdown(device_t dev)
 226 {
 227     struct ata_device *atadev = device_get_softc(dev);
 228
 229     if (atadev->param.support.command2 & ATA_SUPPORT_FLUSHCACHE)
 230         ata_controlcmd(dev, ATA_FLUSHCACHE, 0, 0, 0);
 231 }
 232
 233 static int
 234 ad_reinit(device_t dev)
 235 {
 236     struct ata_channel *ch = device_get_softc(device_get_parent(dev));
 237     struct ata_device *atadev = device_get_softc(dev);
 238
 239     /* if detach pending, return error */
 240     if (((atadev->unit == ATA_MASTER) && !(ch->devices & ATA_ATA_MASTER)) ||
 241         ((atadev->unit == ATA_SLAVE) && !(ch->devices & ATA_ATA_SLAVE))) {
 242         return 1;
 243     }
 244     ad_init(dev);
 245     return 0;
 246 }
 247
 248 static int
 249 ad_open(struct dev_open_args *ap)
 250 {
 251     device_t dev = ap->a_head.a_dev->si_drv1;
 252     struct ad_softc *adp = device_get_ivars(dev);
 253
 254     if (!adp || adp->cdev == NULL)
 255         return ENXIO;
 256     if(!device_is_attached(dev))
 257         return EBUSY;
 258
 259 #if 0 /* XXX TGEN Probably useless, queue will be failed on detach. */
 260     adp->ad_flags &= AD_DISK_OPEN;
 261 #endif /* 0 */
 262     return 0;
 263 }
 264
 265 static int
 266 ad_close(struct dev_close_args *ap)
 267 {
 268     device_t dev = ap->a_head.a_dev->si_drv1;
 269     struct ad_softc *adp = device_get_ivars(dev);
 270
 271 #if 0 /* XXX TGEN Probably useless, queue will be failed on detach. */
 272     adp->ad_flags |= AD_DISK_OPEN;
 273 #endif /* 0 */
 274     return 0;
 275 }
 276
 277 static int
 278 ad_ioctl(struct dev_ioctl_args *ap)
 279 {
 280     return ata_device_ioctl(ap->a_head.a_dev->si_drv1, ap->a_cmd, ap->a_data);
 281 }
 282
 283 static int
 284 ad_strategy(struct dev_strategy_args *ap)
 285 {
 286     device_t dev =  ap->a_head.a_dev->si_drv1;
 287     struct bio *bp = ap->a_bio;
 288     struct buf *bbp = bp->bio_buf;
 289     struct ata_device *atadev = device_get_softc(dev);
 290     struct ata_request *request;
 291     struct ad_softc *adp = device_get_ivars(dev);
 292
 293     if (!(request = ata_alloc_request())) {
 294         device_printf(dev, "FAILURE - out of memory in strategy\n");
 295         bbp->b_flags |= B_ERROR;
 296         bbp->b_error = ENOMEM;
 297         biodone(bp);
 298         return(0);
 299     }
 300
 301     /* setup request */
 302     request->dev = dev;
 303     request->bio = bp;
 304     request->callback = ad_done;
 305     request->timeout = 5;
 306     request->retries = 2;
 307     request->data = bbp->b_data;
 308     request->bytecount = bbp->b_bcount;
 309     /* lba is block granularity, convert byte granularity bio_offset */
 310     request->u.ata.lba = (u_int64_t)(bp->bio_offset >> DEV_BSHIFT);
 311     request->u.ata.count = request->bytecount / DEV_BSIZE;
 312     request->transfersize = min(bbp->b_bcount, atadev->max_iosize);
 313
 314     switch (bbp->b_cmd) {
 315     case BUF_CMD_READ:
 316         request->flags = ATA_R_READ;
 317         if (atadev->mode >= ATA_DMA) {
 318             request->u.ata.command = ATA_READ_DMA;
 319             request->flags |= ATA_R_DMA;
 320         }
 321         else if (request->transfersize > DEV_BSIZE)
 322             request->u.ata.command = ATA_READ_MUL;
 323         else
 324             request->u.ata.command = ATA_READ;
 325         break;
 326     case BUF_CMD_WRITE:
 327         request->flags = ATA_R_WRITE;
 328         if (atadev->mode >= ATA_DMA) {
 329             request->u.ata.command = ATA_WRITE_DMA;
 330             request->flags |= ATA_R_DMA;
 331         }
 332         else if (request->transfersize > DEV_BSIZE)
 333             request->u.ata.command = ATA_WRITE_MUL;
 334         else
 335             request->u.ata.command = ATA_WRITE;
 336         break;
 337     default:
 338         device_printf(dev, "FAILURE - unknown BUF operation\n");
 339         ata_free_request(request);
 340         bbp->b_flags |= B_ERROR;
 341         bbp->b_error = EIO;
 342         biodone(bp);
 343         return(0);
 344     }
 345     request->flags |= ATA_R_ORDERED;
 346     devstat_start_transaction(&adp->stats);
 347     ata_queue_request(request);
 348     return(0);
 349 }
 350
 351 static void
 352 ad_done(struct ata_request *request)
 353 {
 354     struct ad_softc *adp = device_get_ivars(request->dev);
 355     struct bio *bp = request->bio;
 356     struct buf *bbp = bp->bio_buf;
 357
 358     /* finish up transfer */
 359     if ((bbp->b_error = request->result))
 360         bbp->b_flags |= B_ERROR;
 361     bbp->b_resid = bbp->b_bcount - request->donecount;
 362     devstat_end_transaction_buf(&adp->stats, bbp);
 363     biodone(bp);
 364     ata_free_request(request);
 365 }
 366
 367 static int
 368 ad_dump(struct dev_dump_args *ap)
 369 {
 370     device_t dev = ap->a_head.a_dev->si_drv1;
 371     struct ata_device *atadev = device_get_softc(dev);
 372     struct ata_request request;
 373     vm_paddr_t addr = 0;
 374     long blkcnt;
 375     int dumppages = MAXDUMPPGS;
 376     int error = 0;
 377     int i;
 378
 379     blkcnt = howmany(PAGE_SIZE, ap->a_secsize);
 380
 381     while (ap->a_count > 0) {
 382         caddr_t va = NULL;
 383
 384         if ((ap->a_count /blkcnt) < dumppages)
 385             dumppages = ap->a_count / blkcnt;
 386
 387         for (i = 0; i < dumppages; ++i) {
 388             vm_paddr_t a = addr + (i * PAGE_SIZE);
 389             if (is_physical_memory(a))
 390                 va = pmap_kenter_temporary(trunc_page(a), i);
 391             else
 392                 va = pmap_kenter_temporary(trunc_page(0), i);
 393         }
 394
 395         bzero(&request, sizeof(struct ata_request));
 396         request.dev = dev;
 397         /* request.bio = NULL; */
 398         request.timeout = 5;
 399         request.retries = 2;
 400         request.data = va;
 401         request.bytecount = dumppages * PAGE_SIZE;
 402         request.u.ata.lba = ap->a_blkno;
 403         request.u.ata.count = request.bytecount / DEV_BSIZE;
 404         request.transfersize = min(request.bytecount, atadev->max_iosize);
 405         request.flags = ATA_R_WRITE | ATA_R_AT_HEAD;
 406         if (atadev->mode >= ATA_DMA) {
 407             request.u.ata.command = ATA_WRITE_DMA;
 408             request.flags |= ATA_DMA;
 409         } else if (request.transfersize > DEV_BSIZE)
 410             request.u.ata.command = ATA_WRITE_MUL;
 411         else
 412             request.u.ata.command = ATA_WRITE;
 413         ata_queue_request(&request);
 414         if (request.result)
 415             return request.result;
 416
 417         if (dumpstatus(addr, (off_t)ap->a_count * DEV_BSIZE) < 0)
 418             return EINTR;
 419
 420         ap->a_blkno += blkcnt * dumppages;
 421         ap->a_count -= blkcnt * dumppages;
 422         addr += PAGE_SIZE * dumppages;
 423     }
 424
 425     /* flush buffers to media */
 426     if (atadev->param.support.command2 & ATA_SUPPORT_FLUSHCACHE)
 427         error = ata_controlcmd(dev, ATA_FLUSHCACHE, 0, 0, 0);
 428     return error;
 429 }
 430
 431 static void
 432 ad_init(device_t dev)
 433 {
 434     struct ata_device *atadev = device_get_softc(dev);
 435
 436     ATA_SETMODE(device_get_parent(dev), dev);
 437
 438     /* enable readahead caching */
 439     if (atadev->param.support.command1 & ATA_SUPPORT_LOOKAHEAD)
 440         ata_controlcmd(dev, ATA_SETFEATURES, ATA_SF_ENAB_RCACHE, 0, 0);
 441
 442     /* enable write caching if supported and configured */
 443     if (atadev->param.support.command1 & ATA_SUPPORT_WRITECACHE) {
 444         if (ata_wc)
 445             ata_controlcmd(dev, ATA_SETFEATURES, ATA_SF_ENAB_WCACHE, 0, 0);
 446         else
 447             ata_controlcmd(dev, ATA_SETFEATURES, ATA_SF_DIS_WCACHE, 0, 0);
 448     }
 449
 450     /* use multiple sectors/interrupt if device supports it */
 451     if (ad_version(atadev->param.version_major)) {
 452         int secsperint = max(1, min(atadev->param.sectors_intr, 16));
 453
 454         if (!ata_controlcmd(dev, ATA_SET_MULTI, 0, 0, secsperint))
 455             atadev->max_iosize = secsperint * DEV_BSIZE;
 456     }
 457     else
 458         atadev->max_iosize = DEV_BSIZE;
 459 }
 460
 461 void
 462 ad_describe(device_t dev)
 463 {
 464     struct ata_channel *ch = device_get_softc(device_get_parent(dev));
 465     struct ata_device *atadev = device_get_softc(dev);
 466     struct ad_softc *adp = device_get_ivars(dev);
 467     u_int8_t *marker, vendor[64], product[64];
 468
 469     /* try to seperate the ATA model string into vendor and model parts */
 470     if ((marker = index(atadev->param.model, ' ')) ||
 471         (marker = index(atadev->param.model, '-'))) {
 472         int len = (marker - atadev->param.model);
 473
 474         strncpy(vendor, atadev->param.model, len);
 475         vendor[len++] = 0;
 476         strcat(vendor, " ");
 477         strncpy(product, atadev->param.model + len, 40 - len);
 478         vendor[40 - len] = 0;
 479     }
 480     else {
 481         if (!strncmp(atadev->param.model, "ST", 2))
 482             strcpy(vendor, "Seagate ");
 483         else
 484             strcpy(vendor, "");
 485         strncpy(product, atadev->param.model, 40);
 486     }
 487
 488     device_printf(dev, "%lluMB <%s%s %.8s> at ata%d-%s %s%s\n",
 489                   (unsigned long long)(adp->total_secs / (1048576 / DEV_BSIZE)),
 490                   vendor, product, atadev->param.revision,
 491                   device_get_unit(ch->dev),
 492                   (atadev->unit == ATA_MASTER) ? "master" : "slave",
 493                   (adp->flags & AD_F_TAG_ENABLED) ? "tagged " : "",
 494                   ata_mode2str(atadev->mode));
 495     if (bootverbose) {
 496         device_printf(dev, "%llu sectors [%lluC/%dH/%dS] "
 497                       "%d sectors/interrupt %d depth queue\n",
 498                       (unsigned long long)adp->total_secs,(unsigned long long)(
 499                       adp->total_secs / (adp->heads * adp->sectors)),
 500                       adp->heads, adp->sectors, atadev->max_iosize / DEV_BSIZE,
 501                       adp->num_tags + 1);
 502     }
 503 }
 504
 505 static int
 506 ad_version(u_int16_t version)
 507 {
 508     int bit;
 509
 510     if (version == 0xffff)
 511         return 0;
 512     for (bit = 15; bit >= 0; bit--)
 513         if (version & (1<<bit))
 514             return bit;
 515     return 0;
 516 }
 517
 518 static device_method_t ad_methods[] = {
 519     /* device interface */
 520     DEVMETHOD(device_probe,     ad_probe),
 521     DEVMETHOD(device_attach,    ad_attach),
 522     DEVMETHOD(device_detach,    ad_detach),
 523     DEVMETHOD(device_shutdown,  ad_shutdown),
 524
 525     /* ATA methods */
 526     DEVMETHOD(ata_reinit,       ad_reinit),
 527
 528     { 0, 0 }
 529 };
 530
 531 static driver_t ad_driver = {
 532     "ad",
 533     ad_methods,
 534     0,
 535 };
 536
 537 devclass_t ad_devclass;
 538
 539 DRIVER_MODULE(ad, ata, ad_driver, ad_devclass, NULL, NULL);
 540 MODULE_VERSION(ad, 1);
 541 MODULE_DEPEND(ad, ata, 1, 1, 1);