2 * Copyright (c) 1998 - 2008 Søren Schmidt <sos@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
32 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
36 #include <sys/malloc.h>
43 #include <sys/taskqueue.h>
45 #include <machine/md_var.h>
46 #include <machine/bus.h>
48 #include <geom/geom_disk.h>
49 #include <dev/ata/ata-all.h>
50 #include <dev/ata/ata-pci.h>
51 #include <dev/ata/ata-disk.h>
52 #include <dev/ata/ata-raid.h>
56 static void ad_init(device_t dev);
57 static int ad_get_geometry(device_t dev);
58 static void ad_set_geometry(device_t dev);
59 static void ad_done(struct ata_request *request);
60 static void ad_describe(device_t dev);
61 static int ad_version(u_int16_t version);
62 static disk_strategy_t ad_strategy;
63 static disk_ioctl_t ad_ioctl;
64 static dumper_t ad_dump;
67 * Most platforms map firmware geom to actual, but some don't. If
68 * not overridden, default to nothing.
70 #ifndef ata_disk_firmware_geom_adjust
71 #define ata_disk_firmware_geom_adjust(disk)
75 static MALLOC_DEFINE(M_AD, "ad_driver", "ATA disk driver");
78 ad_probe(device_t dev)
80 struct ata_device *atadev = device_get_softc(dev);
82 if (!(atadev->param.config & ATA_PROTO_ATAPI) ||
83 (atadev->param.config == ATA_CFA_MAGIC1) ||
84 (atadev->param.config == ATA_CFA_MAGIC2) ||
85 (atadev->param.config == ATA_CFA_MAGIC3))
92 ad_attach(device_t dev)
94 struct ata_channel *ch = device_get_softc(device_get_parent(dev));
95 struct ata_device *atadev = device_get_softc(dev);
98 /* check that we have a virgin disk to attach */
99 if (device_get_ivars(dev))
102 if (!(adp = malloc(sizeof(struct ad_softc), M_AD, M_NOWAIT | M_ZERO))) {
103 device_printf(dev, "out of memory\n");
106 device_set_ivars(dev, adp);
108 /* get device geometry into internal structs */
109 if (ad_get_geometry(dev))
112 /* set the max size if configured */
114 ad_set_geometry(dev);
116 /* init device parameters */
119 /* announce we are here */
122 /* create the disk device */
123 adp->disk = disk_alloc();
124 adp->disk->d_strategy = ad_strategy;
125 adp->disk->d_ioctl = ad_ioctl;
126 adp->disk->d_dump = ad_dump;
127 adp->disk->d_name = "ad";
128 adp->disk->d_drv1 = dev;
129 adp->disk->d_maxsize = ch->dma.max_iosize ? ch->dma.max_iosize : DFLTPHYS;
130 if (atadev->param.support.command2 & ATA_SUPPORT_ADDRESS48)
131 adp->disk->d_maxsize = min(adp->disk->d_maxsize, 65536 * DEV_BSIZE);
132 else /* 28bit ATA command limit */
133 adp->disk->d_maxsize = min(adp->disk->d_maxsize, 256 * DEV_BSIZE);
134 adp->disk->d_sectorsize = DEV_BSIZE;
135 adp->disk->d_mediasize = DEV_BSIZE * (off_t)adp->total_secs;
136 adp->disk->d_fwsectors = adp->sectors;
137 adp->disk->d_fwheads = adp->heads;
138 adp->disk->d_unit = device_get_unit(dev);
139 if (atadev->param.support.command2 & ATA_SUPPORT_FLUSHCACHE)
140 adp->disk->d_flags |= DISKFLAG_CANFLUSHCACHE;
141 if ((atadev->param.support.command2 & ATA_SUPPORT_CFA) ||
142 atadev->param.config == ATA_PROTO_CFA)
143 adp->disk->d_flags |= DISKFLAG_CANDELETE;
144 strlcpy(adp->disk->d_ident, atadev->param.serial,
145 sizeof(adp->disk->d_ident));
146 ata_disk_firmware_geom_adjust(adp->disk);
147 disk_create(adp->disk, DISK_VERSION);
148 device_add_child(dev, "subdisk", device_get_unit(dev));
149 bus_generic_attach(dev);
151 callout_init(&atadev->spindown_timer, 1);
156 ad_detach(device_t dev)
158 struct ad_softc *adp = device_get_ivars(dev);
159 struct ata_device *atadev = device_get_softc(dev);
163 /* check that we have a valid disk to detach */
164 if (!device_get_ivars(dev))
167 /* destroy the power timeout */
168 callout_drain(&atadev->spindown_timer);
170 /* detach & delete all children */
171 if (!device_get_children(dev, &children, &nchildren)) {
172 for (i = 0; i < nchildren; i++)
174 device_delete_child(dev, children[i]);
175 free(children, M_TEMP);
178 /* destroy disk from the system so we don't get any further requests */
179 disk_destroy(adp->disk);
181 /* fail requests on the queue and any that's "in flight" for this device */
182 ata_fail_requests(dev);
184 /* don't leave anything behind */
185 device_set_ivars(dev, NULL);
191 ad_shutdown(device_t dev)
193 struct ata_device *atadev = device_get_softc(dev);
195 if (atadev->param.support.command2 & ATA_SUPPORT_FLUSHCACHE)
196 ata_controlcmd(dev, ATA_FLUSHCACHE, 0, 0, 0);
201 ad_reinit(device_t dev)
203 struct ata_channel *ch = device_get_softc(device_get_parent(dev));
204 struct ata_device *atadev = device_get_softc(dev);
206 /* if detach pending, return error */
207 if (!(ch->devices & (ATA_ATA_MASTER << atadev->unit)))
215 ad_power_callback(struct ata_request *request)
217 device_printf(request->dev, "drive spun down.\n");
218 ata_free_request(request);
222 ad_spindown(void *priv)
225 struct ata_device *atadev = device_get_softc(dev);
226 struct ata_request *request;
228 if (!atadev->spindown)
230 device_printf(dev, "Idle, spin down\n");
231 atadev->spindown_state = 1;
232 if (!(request = ata_alloc_request())) {
233 device_printf(dev, "FAILURE - out of memory in ad_spindown\n");
237 request->flags = ATA_R_CONTROL;
238 request->timeout = ATA_REQUEST_TIMEOUT;
239 request->retries = 1;
240 request->callback = ad_power_callback;
241 request->u.ata.command = ATA_STANDBY_IMMEDIATE;
242 ata_queue_request(request);
247 ad_strategy(struct bio *bp)
249 device_t dev = bp->bio_disk->d_drv1;
250 struct ata_device *atadev = device_get_softc(dev);
251 struct ata_request *request;
253 if (atadev->spindown)
254 callout_reset(&atadev->spindown_timer, hz * atadev->spindown,
257 if (!(request = ata_alloc_request())) {
258 device_printf(dev, "FAILURE - out of memory in start\n");
259 biofinish(bp, NULL, ENOMEM);
266 request->callback = ad_done;
267 if (atadev->spindown_state) {
268 device_printf(dev, "request while spun down, starting.\n");
269 atadev->spindown_state = 0;
270 request->timeout = MAX(ATA_REQUEST_TIMEOUT, 31);
273 request->timeout = ATA_REQUEST_TIMEOUT;
275 request->retries = 2;
276 request->data = bp->bio_data;
277 request->bytecount = bp->bio_bcount;
278 request->u.ata.lba = bp->bio_pblkno;
279 request->u.ata.count = request->bytecount / DEV_BSIZE;
280 request->transfersize = min(bp->bio_bcount, atadev->max_iosize);
282 switch (bp->bio_cmd) {
284 request->flags = ATA_R_READ;
285 if (atadev->mode >= ATA_DMA) {
286 request->u.ata.command = ATA_READ_DMA;
287 request->flags |= ATA_R_DMA;
289 else if (request->transfersize > DEV_BSIZE)
290 request->u.ata.command = ATA_READ_MUL;
292 request->u.ata.command = ATA_READ;
295 request->flags = ATA_R_WRITE;
296 if (atadev->mode >= ATA_DMA) {
297 request->u.ata.command = ATA_WRITE_DMA;
298 request->flags |= ATA_R_DMA;
300 else if (request->transfersize > DEV_BSIZE)
301 request->u.ata.command = ATA_WRITE_MUL;
303 request->u.ata.command = ATA_WRITE;
306 request->flags = ATA_R_CONTROL;
307 request->u.ata.command = ATA_CFA_ERASE;
308 request->transfersize = 0;
309 request->donecount = bp->bio_bcount;
312 request->u.ata.lba = 0;
313 request->u.ata.count = 0;
314 request->u.ata.feature = 0;
315 request->bytecount = 0;
316 request->transfersize = 0;
317 request->flags = ATA_R_CONTROL;
318 request->u.ata.command = ATA_FLUSHCACHE;
321 device_printf(dev, "FAILURE - unknown BIO operation\n");
322 ata_free_request(request);
323 biofinish(bp, NULL, EIO);
326 request->flags |= ATA_R_ORDERED;
327 ata_queue_request(request);
331 ad_done(struct ata_request *request)
333 struct bio *bp = request->bio;
335 /* finish up transfer */
336 if ((bp->bio_error = request->result))
337 bp->bio_flags |= BIO_ERROR;
338 bp->bio_resid = bp->bio_bcount - request->donecount;
340 ata_free_request(request);
344 ad_ioctl(struct disk *disk, u_long cmd, void *data, int flag, struct thread *td)
346 return ata_device_ioctl(disk->d_drv1, cmd, data);
350 ad_dump(void *arg, void *virtual, vm_offset_t physical,
351 off_t offset, size_t length)
353 struct disk *dp = arg;
354 device_t dev = dp->d_drv1;
357 /* XXX: Drop pre-dump request queue. Long request queue processing
358 * causes stack overflow in ATA working in dumping (interruptless) mode.
359 * Conter-XXX: To make dump coherent we should avoid doing anything
360 * else while dumping.
362 ata_drop_requests(dev);
364 /* length zero is special and really means flush buffers to media */
366 struct ata_device *atadev = device_get_softc(dev);
369 if (atadev->param.support.command2 & ATA_SUPPORT_FLUSHCACHE)
370 error = ata_controlcmd(dev, ATA_FLUSHCACHE, 0, 0, 0);
374 bzero(&bp, sizeof(struct bio));
376 bp.bio_pblkno = offset / DEV_BSIZE;
377 bp.bio_bcount = length;
378 bp.bio_data = virtual;
379 bp.bio_cmd = BIO_WRITE;
385 ad_init(device_t dev)
387 struct ata_device *atadev = device_get_softc(dev);
391 /* enable readahead caching */
392 if (atadev->param.support.command1 & ATA_SUPPORT_LOOKAHEAD)
393 ata_controlcmd(dev, ATA_SETFEATURES, ATA_SF_ENAB_RCACHE, 0, 0);
395 /* enable write caching if supported and configured */
396 if (atadev->param.support.command1 & ATA_SUPPORT_WRITECACHE) {
398 ata_controlcmd(dev, ATA_SETFEATURES, ATA_SF_ENAB_WCACHE, 0, 0);
400 ata_controlcmd(dev, ATA_SETFEATURES, ATA_SF_DIS_WCACHE, 0, 0);
403 /* use multiple sectors/interrupt if device supports it */
404 if (ad_version(atadev->param.version_major)) {
405 int secsperint = max(1, min(atadev->param.sectors_intr & 0xff, 16));
407 if (!ata_controlcmd(dev, ATA_SET_MULTI, 0, 0, secsperint))
408 atadev->max_iosize = secsperint * DEV_BSIZE;
410 atadev->max_iosize = DEV_BSIZE;
413 atadev->max_iosize = DEV_BSIZE;
417 ad_get_geometry(device_t dev)
419 struct ata_device *atadev = device_get_softc(dev);
420 struct ad_softc *adp = device_get_ivars(dev);
424 if ((atadev->param.atavalid & ATA_FLAG_54_58) &&
425 atadev->param.current_heads && atadev->param.current_sectors) {
426 adp->heads = atadev->param.current_heads;
427 adp->sectors = atadev->param.current_sectors;
428 adp->total_secs = (u_int32_t)atadev->param.current_size_1 |
429 ((u_int32_t)atadev->param.current_size_2 << 16);
432 adp->heads = atadev->param.heads;
433 adp->sectors = atadev->param.sectors;
434 adp->total_secs = atadev->param.cylinders * adp->heads * adp->sectors;
436 lbasize = (u_int32_t)atadev->param.lba_size_1 |
437 ((u_int32_t)atadev->param.lba_size_2 << 16);
438 /* This device exists, but has no size. Filter out this bogus device. */
439 if (!lbasize && !adp->total_secs)
442 /* does this device need oldstyle CHS addressing */
443 if (!ad_version(atadev->param.version_major) || !lbasize)
444 atadev->flags |= ATA_D_USE_CHS;
446 /* use the 28bit LBA size if valid or bigger than the CHS mapping */
447 if (atadev->param.cylinders == 16383 || adp->total_secs < lbasize)
448 adp->total_secs = lbasize;
450 /* use the 48bit LBA size if valid */
451 lbasize48 = ((u_int64_t)atadev->param.lba_size48_1) |
452 ((u_int64_t)atadev->param.lba_size48_2 << 16) |
453 ((u_int64_t)atadev->param.lba_size48_3 << 32) |
454 ((u_int64_t)atadev->param.lba_size48_4 << 48);
455 if ((atadev->param.support.command2 & ATA_SUPPORT_ADDRESS48) &&
456 lbasize48 > ATA_MAX_28BIT_LBA)
457 adp->total_secs = lbasize48;
462 ad_set_geometry(device_t dev)
464 struct ad_softc *adp = device_get_ivars(dev);
465 struct ata_request *request;
468 device_printf(dev, "ORG %ju sectors [%juC/%dH/%dS]\n", adp->total_secs,
469 adp->total_secs / (adp->heads * adp->sectors),
470 adp->heads, adp->sectors);
472 if (!(request = ata_alloc_request()))
475 /* get the max native size the device supports */
477 request->u.ata.command = ATA_READ_NATIVE_MAX_ADDRESS;
478 request->u.ata.lba = 0;
479 request->u.ata.count = 0;
480 request->u.ata.feature = 0;
481 request->flags = ATA_R_CONTROL | ATA_R_QUIET;
482 request->timeout = ATA_REQUEST_TIMEOUT;
483 request->retries = 0;
484 ata_queue_request(request);
485 if (request->status & ATA_S_ERROR)
489 device_printf(dev, "MAX %ju sectors\n", request->u.ata.lba + 1);
491 /* if original size equals max size nothing more todo */
492 if (adp->total_secs >= request->u.ata.lba)
495 /* set the max native size to its max */
497 request->u.ata.command = ATA_SET_MAX_ADDRESS;
498 request->u.ata.count = 1;
499 request->u.ata.feature = 0;
500 request->flags = ATA_R_CONTROL;
501 request->timeout = ATA_REQUEST_TIMEOUT;
502 request->retries = 0;
503 ata_queue_request(request);
504 if (request->status & ATA_S_ERROR)
507 /* refresh geometry from drive */
508 ata_getparam(device_get_softc(dev), 0);
509 ad_get_geometry(dev);
511 device_printf(dev, "NEW %ju sectors [%juC/%dH/%dS]\n", adp->total_secs,
512 adp->total_secs / (adp->heads * adp->sectors),
513 adp->heads, adp->sectors);
515 ata_free_request(request);
519 ad_describe(device_t dev)
521 struct ata_channel *ch = device_get_softc(device_get_parent(dev));
522 struct ata_device *atadev = device_get_softc(dev);
523 struct ad_softc *adp = device_get_ivars(dev);
524 u_int8_t *marker, vendor[64], product[64];
526 /* try to separate the ATA model string into vendor and model parts */
527 if ((marker = index(atadev->param.model, ' ')) ||
528 (marker = index(atadev->param.model, '-'))) {
529 int len = (marker - atadev->param.model);
531 strncpy(vendor, atadev->param.model, len);
534 strncpy(product, atadev->param.model + len, 40 - len);
535 vendor[40 - len] = 0;
538 if (!strncmp(atadev->param.model, "ST", 2))
539 strcpy(vendor, "Seagate ");
540 else if (!strncmp(atadev->param.model, "HDS", 3))
541 strcpy(vendor, "Hitachi ");
544 strncpy(product, atadev->param.model, 40);
547 device_printf(dev, "%juMB <%s%s %.8s> at ata%d-%s %s%s %s\n",
548 adp->total_secs / (1048576 / DEV_BSIZE),
549 vendor, product, atadev->param.revision,
550 device_get_unit(ch->dev), ata_unit2str(atadev),
551 (adp->flags & AD_F_TAG_ENABLED) ? "tagged " : "",
552 ata_mode2str(atadev->mode),
553 ata_satarev2str(ATA_GETREV(device_get_parent(dev), atadev->unit)));
555 device_printf(dev, "%ju sectors [%juC/%dH/%dS] "
556 "%d sectors/interrupt %d depth queue\n", adp->total_secs,
557 adp->total_secs / (adp->heads * adp->sectors),
558 adp->heads, adp->sectors, atadev->max_iosize / DEV_BSIZE,
564 ad_version(u_int16_t version)
568 if (version == 0xffff)
570 for (bit = 15; bit >= 0; bit--)
571 if (version & (1<<bit))
576 static device_method_t ad_methods[] = {
577 /* device interface */
578 DEVMETHOD(device_probe, ad_probe),
579 DEVMETHOD(device_attach, ad_attach),
580 DEVMETHOD(device_detach, ad_detach),
581 DEVMETHOD(device_shutdown, ad_shutdown),
584 DEVMETHOD(ata_reinit, ad_reinit),
589 static driver_t ad_driver = {
595 devclass_t ad_devclass;
597 DRIVER_MODULE(ad, ata, ad_driver, ad_devclass, NULL, NULL);
598 MODULE_VERSION(ad, 1);
599 MODULE_DEPEND(ad, ata, 1, 1, 1);