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