2 * Copyright (c) 2009 Alexander Motin <mav@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$");
32 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
38 #include <sys/sysctl.h>
39 #include <sys/taskqueue.h>
41 #include <sys/mutex.h>
43 #include <sys/devicestat.h>
44 #include <sys/eventhandler.h>
45 #include <sys/malloc.h>
48 #include <sys/reboot.h>
49 #include <geom/geom_disk.h>
58 #include <cam/cam_ccb.h>
59 #include <cam/cam_periph.h>
60 #include <cam/cam_xpt_periph.h>
61 #include <cam/cam_sim.h>
63 #include <cam/ata/ata_all.h>
65 #include <machine/md_var.h> /* geometry translation */
69 #define ATA_MAX_28BIT_LBA 268435455UL
78 ADA_FLAG_CAN_48BIT = 0x0002,
79 ADA_FLAG_CAN_FLUSHCACHE = 0x0004,
80 ADA_FLAG_CAN_NCQ = 0x0008,
81 ADA_FLAG_CAN_DMA = 0x0010,
82 ADA_FLAG_NEED_OTAG = 0x0020,
83 ADA_FLAG_WAS_OTAG = 0x0040,
84 ADA_FLAG_CAN_TRIM = 0x0080,
85 ADA_FLAG_OPEN = 0x0100,
86 ADA_FLAG_SCTX_INIT = 0x0200,
87 ADA_FLAG_CAN_CFA = 0x0400,
88 ADA_FLAG_CAN_POWERMGT = 0x0800,
89 ADA_FLAG_CAN_DMA48 = 0x1000,
90 ADA_FLAG_DIRTY = 0x2000
98 #define ADA_Q_BIT_STRING \
103 ADA_CCB_RAHEAD = 0x01,
104 ADA_CCB_WCACHE = 0x02,
105 ADA_CCB_BUFFER_IO = 0x03,
108 ADA_CCB_TYPE_MASK = 0x0F,
111 /* Offsets into our private area for storing information */
112 #define ccb_state ppriv_field0
113 #define ccb_bp ppriv_ptr1
117 u_int8_t secs_per_track;
119 u_int32_t secsize; /* Number of bytes/logical sector */
120 u_int64_t sectors; /* Total number sectors */
123 #define TRIM_MAX_BLOCKS 8
124 #define TRIM_MAX_RANGES (TRIM_MAX_BLOCKS * ATA_DSM_BLK_RANGES)
125 struct trim_request {
126 uint8_t data[TRIM_MAX_RANGES * ATA_DSM_RANGE_SIZE];
127 TAILQ_HEAD(, bio) bps;
131 struct bio_queue_head bio_queue;
132 struct bio_queue_head trim_queue;
133 int outstanding_cmds; /* Number of active commands */
134 int refcount; /* Active xpt_action() calls */
143 #ifdef ADA_TEST_FAILURE
144 int force_read_error;
145 int force_write_error;
146 int periodic_read_error;
147 int periodic_read_count;
149 struct disk_params params;
151 struct task sysctl_task;
152 struct sysctl_ctx_list sysctl_ctx;
153 struct sysctl_oid *sysctl_tree;
154 struct callout sendordered_c;
155 struct trim_request trim_req;
158 struct ada_quirk_entry {
159 struct scsi_inquiry_pattern inq_pat;
163 static struct ada_quirk_entry ada_quirk_table[] =
166 /* Hitachi Advanced Format (4k) drives */
167 { T_DIRECT, SIP_MEDIA_FIXED, "*", "Hitachi H??????????E3*", "*" },
171 /* Samsung Advanced Format (4k) drives */
172 { T_DIRECT, SIP_MEDIA_FIXED, "*", "SAMSUNG HD155UI*", "*" },
176 /* Samsung Advanced Format (4k) drives */
177 { T_DIRECT, SIP_MEDIA_FIXED, "*", "SAMSUNG HD204UI*", "*" },
181 /* Seagate Barracuda Green Advanced Format (4k) drives */
182 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST????DL*", "*" },
186 /* Seagate Barracuda Advanced Format (4k) drives */
187 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST???DM*", "*" },
191 /* Seagate Barracuda Advanced Format (4k) drives */
192 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST????DM*", "*" },
196 /* Seagate Momentus Advanced Format (4k) drives */
197 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9500423AS*", "*" },
201 /* Seagate Momentus Advanced Format (4k) drives */
202 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9500424AS*", "*" },
206 /* Seagate Momentus Advanced Format (4k) drives */
207 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9640423AS*", "*" },
211 /* Seagate Momentus Advanced Format (4k) drives */
212 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9640424AS*", "*" },
216 /* Seagate Momentus Advanced Format (4k) drives */
217 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9750420AS*", "*" },
221 /* Seagate Momentus Advanced Format (4k) drives */
222 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9750422AS*", "*" },
226 /* Seagate Momentus Advanced Format (4k) drives */
227 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9750423AS*", "*" },
231 /* Seagate Momentus Thin Advanced Format (4k) drives */
232 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST???LT*", "*" },
236 /* WDC Caviar Red Advanced Format (4k) drives */
237 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD????CX*", "*" },
241 /* WDC Caviar Green Advanced Format (4k) drives */
242 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD????RS*", "*" },
246 /* WDC Caviar Green/Red Advanced Format (4k) drives */
247 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD????RX*", "*" },
251 /* WDC Caviar Red Advanced Format (4k) drives */
252 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD??????CX*", "*" },
256 /* WDC Caviar Black Advanced Format (4k) drives */
257 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD??????EX*", "*" },
261 /* WDC Caviar Green Advanced Format (4k) drives */
262 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD??????RS*", "*" },
266 /* WDC Caviar Green Advanced Format (4k) drives */
267 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD??????RX*", "*" },
271 /* WDC Scorpio Black Advanced Format (4k) drives */
272 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD???PKT*", "*" },
276 /* WDC Scorpio Black Advanced Format (4k) drives */
277 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD?????PKT*", "*" },
281 /* WDC Scorpio Blue Advanced Format (4k) drives */
282 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD???PVT*", "*" },
286 /* WDC Scorpio Blue Advanced Format (4k) drives */
287 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD?????PVT*", "*" },
293 * Corsair Force 2 SSDs
294 * 4k optimised & trim only works in 4k requests + 4k aligned
296 { T_DIRECT, SIP_MEDIA_FIXED, "*", "Corsair CSSD-F*", "*" },
301 * Corsair Force 3 SSDs
302 * 4k optimised & trim only works in 4k requests + 4k aligned
304 { T_DIRECT, SIP_MEDIA_FIXED, "*", "Corsair Force 3*", "*" },
309 * Corsair Neutron GTX SSDs
310 * 4k optimised & trim only works in 4k requests + 4k aligned
312 { T_DIRECT, SIP_MEDIA_FIXED, "*", "Corsair Neutron GTX*", "*" },
317 * Corsair Force GT & GS SSDs
318 * 4k optimised & trim only works in 4k requests + 4k aligned
320 { T_DIRECT, SIP_MEDIA_FIXED, "*", "Corsair Force G*", "*" },
326 * 4k optimised & trim only works in 4k requests + 4k aligned
328 { T_DIRECT, SIP_MEDIA_FIXED, "*", "M4-CT???M4SSD2*", "*" },
333 * Crucial RealSSD C300 SSDs
336 { T_DIRECT, SIP_MEDIA_FIXED, "*", "C300-CTFDDAC???MAG*",
337 "*" }, /*quirks*/ADA_Q_4K
341 * Intel 320 Series SSDs
342 * 4k optimised & trim only works in 4k requests + 4k aligned
344 { T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSA2CW*", "*" },
349 * Intel 330 Series SSDs
350 * 4k optimised & trim only works in 4k requests + 4k aligned
352 { T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSC2CT*", "*" },
357 * Intel 510 Series SSDs
358 * 4k optimised & trim only works in 4k requests + 4k aligned
360 { T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSC2MH*", "*" },
365 * Intel 520 Series SSDs
366 * 4k optimised & trim only works in 4k requests + 4k aligned
368 { T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSC2BW*", "*" },
373 * Intel X25-M Series SSDs
374 * 4k optimised & trim only works in 4k requests + 4k aligned
376 { T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSA2M*", "*" },
381 * Kingston E100 Series SSDs
382 * 4k optimised & trim only works in 4k requests + 4k aligned
384 { T_DIRECT, SIP_MEDIA_FIXED, "*", "KINGSTON SE100S3*", "*" },
389 * Kingston HyperX 3k SSDs
390 * 4k optimised & trim only works in 4k requests + 4k aligned
392 { T_DIRECT, SIP_MEDIA_FIXED, "*", "KINGSTON SH103S3*", "*" },
397 * Marvell SSDs (entry taken from OpenSolaris)
398 * 4k optimised & trim only works in 4k requests + 4k aligned
400 { T_DIRECT, SIP_MEDIA_FIXED, "*", "MARVELL SD88SA02*", "*" },
406 * 4k optimised & trim only works in 4k requests + 4k aligned
408 { T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ-AGILITY2*", "*" },
414 * 4k optimised & trim only works in 4k requests + 4k aligned
416 { T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ-AGILITY3*", "*" },
421 * OCZ Deneva R Series SSDs
422 * 4k optimised & trim only works in 4k requests + 4k aligned
424 { T_DIRECT, SIP_MEDIA_FIXED, "*", "DENRSTE251M45*", "*" },
429 * OCZ Vertex 2 SSDs (inc pro series)
430 * 4k optimised & trim only works in 4k requests + 4k aligned
432 { T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ?VERTEX2*", "*" },
438 * 4k optimised & trim only works in 4k requests + 4k aligned
440 { T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ-VERTEX3*", "*" },
446 * 4k optimised & trim only works in 4k requests + 4k aligned
448 { T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ-VERTEX4*", "*" },
453 * Samsung 830 Series SSDs
456 { T_DIRECT, SIP_MEDIA_FIXED, "*", "SAMSUNG SSD 830 Series*", "*" },
464 { T_DIRECT, SIP_MEDIA_FIXED, "*", "Samsung SSD 840*", "*" },
469 * Samsung 843T Series SSDs
472 { T_DIRECT, SIP_MEDIA_FIXED, "*", "SAMSUNG MZ7WD*", "*" },
480 { T_DIRECT, SIP_MEDIA_FIXED, "*", "Samsung SSD 850*", "*" },
485 * Samsung PM853T Series SSDs
488 { T_DIRECT, SIP_MEDIA_FIXED, "*", "SAMSUNG MZ7GE*", "*" },
493 * SuperTalent TeraDrive CT SSDs
494 * 4k optimised & trim only works in 4k requests + 4k aligned
496 { T_DIRECT, SIP_MEDIA_FIXED, "*", "FTM??CT25H*", "*" },
501 * XceedIOPS SATA SSDs
504 { T_DIRECT, SIP_MEDIA_FIXED, "*", "SG9XCS2D*", "*" },
510 T_ANY, SIP_MEDIA_REMOVABLE|SIP_MEDIA_FIXED,
511 /*vendor*/"*", /*product*/"*", /*revision*/"*"
517 static disk_strategy_t adastrategy;
518 static dumper_t adadump;
519 static periph_init_t adainit;
520 static void adaasync(void *callback_arg, u_int32_t code,
521 struct cam_path *path, void *arg);
522 static void adasysctlinit(void *context, int pending);
523 static periph_ctor_t adaregister;
524 static periph_dtor_t adacleanup;
525 static periph_start_t adastart;
526 static periph_oninv_t adaoninvalidate;
527 static void adadone(struct cam_periph *periph,
528 union ccb *done_ccb);
529 static int adaerror(union ccb *ccb, u_int32_t cam_flags,
530 u_int32_t sense_flags);
531 static void adagetparams(struct cam_periph *periph,
532 struct ccb_getdev *cgd);
533 static timeout_t adasendorderedtag;
534 static void adashutdown(void *arg, int howto);
535 static void adasuspend(void *arg);
536 static void adaresume(void *arg);
538 #ifndef ADA_DEFAULT_LEGACY_ALIASES
539 #define ADA_DEFAULT_LEGACY_ALIASES 1
542 #ifndef ADA_DEFAULT_TIMEOUT
543 #define ADA_DEFAULT_TIMEOUT 30 /* Timeout in seconds */
546 #ifndef ADA_DEFAULT_RETRY
547 #define ADA_DEFAULT_RETRY 4
550 #ifndef ADA_DEFAULT_SEND_ORDERED
551 #define ADA_DEFAULT_SEND_ORDERED 1
554 #ifndef ADA_DEFAULT_SPINDOWN_SHUTDOWN
555 #define ADA_DEFAULT_SPINDOWN_SHUTDOWN 1
558 #ifndef ADA_DEFAULT_SPINDOWN_SUSPEND
559 #define ADA_DEFAULT_SPINDOWN_SUSPEND 1
562 #ifndef ADA_DEFAULT_READ_AHEAD
563 #define ADA_DEFAULT_READ_AHEAD 1
566 #ifndef ADA_DEFAULT_WRITE_CACHE
567 #define ADA_DEFAULT_WRITE_CACHE 1
570 #define ADA_RA (softc->read_ahead >= 0 ? \
571 softc->read_ahead : ada_read_ahead)
572 #define ADA_WC (softc->write_cache >= 0 ? \
573 softc->write_cache : ada_write_cache)
574 #define ADA_SIO (softc->sort_io_queue >= 0 ? \
575 softc->sort_io_queue : cam_sort_io_queues)
578 * Most platforms map firmware geometry to actual, but some don't. If
579 * not overridden, default to nothing.
581 #ifndef ata_disk_firmware_geom_adjust
582 #define ata_disk_firmware_geom_adjust(disk)
585 static int ada_legacy_aliases = ADA_DEFAULT_LEGACY_ALIASES;
586 static int ada_retry_count = ADA_DEFAULT_RETRY;
587 static int ada_default_timeout = ADA_DEFAULT_TIMEOUT;
588 static int ada_send_ordered = ADA_DEFAULT_SEND_ORDERED;
589 static int ada_spindown_shutdown = ADA_DEFAULT_SPINDOWN_SHUTDOWN;
590 static int ada_spindown_suspend = ADA_DEFAULT_SPINDOWN_SUSPEND;
591 static int ada_read_ahead = ADA_DEFAULT_READ_AHEAD;
592 static int ada_write_cache = ADA_DEFAULT_WRITE_CACHE;
594 static SYSCTL_NODE(_kern_cam, OID_AUTO, ada, CTLFLAG_RD, 0,
595 "CAM Direct Access Disk driver");
596 SYSCTL_INT(_kern_cam_ada, OID_AUTO, legacy_aliases, CTLFLAG_RWTUN,
597 &ada_legacy_aliases, 0, "Create legacy-like device aliases");
598 SYSCTL_INT(_kern_cam_ada, OID_AUTO, retry_count, CTLFLAG_RWTUN,
599 &ada_retry_count, 0, "Normal I/O retry count");
600 SYSCTL_INT(_kern_cam_ada, OID_AUTO, default_timeout, CTLFLAG_RWTUN,
601 &ada_default_timeout, 0, "Normal I/O timeout (in seconds)");
602 SYSCTL_INT(_kern_cam_ada, OID_AUTO, send_ordered, CTLFLAG_RWTUN,
603 &ada_send_ordered, 0, "Send Ordered Tags");
604 SYSCTL_INT(_kern_cam_ada, OID_AUTO, spindown_shutdown, CTLFLAG_RWTUN,
605 &ada_spindown_shutdown, 0, "Spin down upon shutdown");
606 SYSCTL_INT(_kern_cam_ada, OID_AUTO, spindown_suspend, CTLFLAG_RWTUN,
607 &ada_spindown_suspend, 0, "Spin down upon suspend");
608 SYSCTL_INT(_kern_cam_ada, OID_AUTO, read_ahead, CTLFLAG_RWTUN,
609 &ada_read_ahead, 0, "Enable disk read-ahead");
610 SYSCTL_INT(_kern_cam_ada, OID_AUTO, write_cache, CTLFLAG_RWTUN,
611 &ada_write_cache, 0, "Enable disk write cache");
614 * ADA_ORDEREDTAG_INTERVAL determines how often, relative
615 * to the default timeout, we check to see whether an ordered
616 * tagged transaction is appropriate to prevent simple tag
617 * starvation. Since we'd like to ensure that there is at least
618 * 1/2 of the timeout length left for a starved transaction to
619 * complete after we've sent an ordered tag, we must poll at least
620 * four times in every timeout period. This takes care of the worst
621 * case where a starved transaction starts during an interval that
622 * meets the requirement "don't send an ordered tag" test so it takes
623 * us two intervals to determine that a tag must be sent.
625 #ifndef ADA_ORDEREDTAG_INTERVAL
626 #define ADA_ORDEREDTAG_INTERVAL 4
629 static struct periph_driver adadriver =
632 TAILQ_HEAD_INITIALIZER(adadriver.units), /* generation */ 0
635 PERIPHDRIVER_DECLARE(ada, adadriver);
637 static MALLOC_DEFINE(M_ATADA, "ata_da", "ata_da buffers");
640 adaopen(struct disk *dp)
642 struct cam_periph *periph;
643 struct ada_softc *softc;
646 periph = (struct cam_periph *)dp->d_drv1;
647 if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
651 cam_periph_lock(periph);
652 if ((error = cam_periph_hold(periph, PRIBIO|PCATCH)) != 0) {
653 cam_periph_unlock(periph);
654 cam_periph_release(periph);
658 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE | CAM_DEBUG_PERIPH,
661 softc = (struct ada_softc *)periph->softc;
662 softc->flags |= ADA_FLAG_OPEN;
664 cam_periph_unhold(periph);
665 cam_periph_unlock(periph);
670 adaclose(struct disk *dp)
672 struct cam_periph *periph;
673 struct ada_softc *softc;
677 periph = (struct cam_periph *)dp->d_drv1;
678 softc = (struct ada_softc *)periph->softc;
679 cam_periph_lock(periph);
681 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE | CAM_DEBUG_PERIPH,
684 /* We only sync the cache if the drive is capable of it. */
685 if ((softc->flags & ADA_FLAG_DIRTY) != 0 &&
686 (softc->flags & ADA_FLAG_CAN_FLUSHCACHE) != 0 &&
687 (periph->flags & CAM_PERIPH_INVALID) == 0 &&
688 cam_periph_hold(periph, PRIBIO) == 0) {
690 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
691 cam_fill_ataio(&ccb->ataio,
698 ada_default_timeout*1000);
700 if (softc->flags & ADA_FLAG_CAN_48BIT)
701 ata_48bit_cmd(&ccb->ataio, ATA_FLUSHCACHE48, 0, 0, 0);
703 ata_28bit_cmd(&ccb->ataio, ATA_FLUSHCACHE, 0, 0, 0);
704 error = cam_periph_runccb(ccb, adaerror, /*cam_flags*/0,
705 /*sense_flags*/0, softc->disk->d_devstat);
708 xpt_print(periph->path, "Synchronize cache failed\n");
710 softc->flags &= ~ADA_FLAG_DIRTY;
711 xpt_release_ccb(ccb);
712 cam_periph_unhold(periph);
715 softc->flags &= ~ADA_FLAG_OPEN;
717 while (softc->refcount != 0)
718 cam_periph_sleep(periph, &softc->refcount, PRIBIO, "adaclose", 1);
719 cam_periph_unlock(periph);
720 cam_periph_release(periph);
725 adaschedule(struct cam_periph *periph)
727 struct ada_softc *softc = (struct ada_softc *)periph->softc;
729 if (softc->state != ADA_STATE_NORMAL)
732 /* Check if we have more work to do. */
733 if (bioq_first(&softc->bio_queue) ||
734 (!softc->trim_running && bioq_first(&softc->trim_queue))) {
735 xpt_schedule(periph, CAM_PRIORITY_NORMAL);
740 * Actually translate the requested transfer into one the physical driver
741 * can understand. The transfer is described by a buf and will include
742 * only one physical transfer.
745 adastrategy(struct bio *bp)
747 struct cam_periph *periph;
748 struct ada_softc *softc;
750 periph = (struct cam_periph *)bp->bio_disk->d_drv1;
751 softc = (struct ada_softc *)periph->softc;
753 cam_periph_lock(periph);
755 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("adastrategy(%p)\n", bp));
758 * If the device has been made invalid, error out
760 if ((periph->flags & CAM_PERIPH_INVALID) != 0) {
761 cam_periph_unlock(periph);
762 biofinish(bp, NULL, ENXIO);
767 * Place it in the queue of disk activities for this disk
769 if (bp->bio_cmd == BIO_DELETE) {
770 bioq_disksort(&softc->trim_queue, bp);
773 bioq_disksort(&softc->bio_queue, bp);
775 bioq_insert_tail(&softc->bio_queue, bp);
779 * Schedule ourselves for performing the work.
782 cam_periph_unlock(periph);
788 adadump(void *arg, void *virtual, vm_offset_t physical, off_t offset, size_t length)
790 struct cam_periph *periph;
791 struct ada_softc *softc;
801 softc = (struct ada_softc *)periph->softc;
802 cam_periph_lock(periph);
803 secsize = softc->params.secsize;
804 lba = offset / secsize;
805 count = length / secsize;
807 if ((periph->flags & CAM_PERIPH_INVALID) != 0) {
808 cam_periph_unlock(periph);
813 xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
814 ccb.ccb_h.ccb_state = ADA_CCB_DUMP;
815 cam_fill_ataio(&ccb.ataio,
820 (u_int8_t *) virtual,
822 ada_default_timeout*1000);
823 if ((softc->flags & ADA_FLAG_CAN_48BIT) &&
824 (lba + count >= ATA_MAX_28BIT_LBA ||
826 ata_48bit_cmd(&ccb.ataio, ATA_WRITE_DMA48,
829 ata_28bit_cmd(&ccb.ataio, ATA_WRITE_DMA,
832 xpt_polled_action(&ccb);
834 error = cam_periph_error(&ccb,
835 0, SF_NO_RECOVERY | SF_NO_RETRY, NULL);
836 if ((ccb.ccb_h.status & CAM_DEV_QFRZN) != 0)
837 cam_release_devq(ccb.ccb_h.path, /*relsim_flags*/0,
838 /*reduction*/0, /*timeout*/0, /*getcount_only*/0);
840 printf("Aborting dump due to I/O error.\n");
842 cam_periph_unlock(periph);
846 if (softc->flags & ADA_FLAG_CAN_FLUSHCACHE) {
847 xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
849 ccb.ccb_h.ccb_state = ADA_CCB_DUMP;
850 cam_fill_ataio(&ccb.ataio,
857 ada_default_timeout*1000);
859 if (softc->flags & ADA_FLAG_CAN_48BIT)
860 ata_48bit_cmd(&ccb.ataio, ATA_FLUSHCACHE48, 0, 0, 0);
862 ata_28bit_cmd(&ccb.ataio, ATA_FLUSHCACHE, 0, 0, 0);
863 xpt_polled_action(&ccb);
865 error = cam_periph_error(&ccb,
866 0, SF_NO_RECOVERY | SF_NO_RETRY, NULL);
867 if ((ccb.ccb_h.status & CAM_DEV_QFRZN) != 0)
868 cam_release_devq(ccb.ccb_h.path, /*relsim_flags*/0,
869 /*reduction*/0, /*timeout*/0, /*getcount_only*/0);
871 xpt_print(periph->path, "Synchronize cache failed\n");
873 cam_periph_unlock(periph);
883 * Install a global async callback. This callback will
884 * receive async callbacks like "new device found".
886 status = xpt_register_async(AC_FOUND_DEVICE, adaasync, NULL, NULL);
888 if (status != CAM_REQ_CMP) {
889 printf("ada: Failed to attach master async callback "
890 "due to status 0x%x!\n", status);
891 } else if (ada_send_ordered) {
893 /* Register our event handlers */
894 if ((EVENTHANDLER_REGISTER(power_suspend, adasuspend,
895 NULL, EVENTHANDLER_PRI_LAST)) == NULL)
896 printf("adainit: power event registration failed!\n");
897 if ((EVENTHANDLER_REGISTER(power_resume, adaresume,
898 NULL, EVENTHANDLER_PRI_LAST)) == NULL)
899 printf("adainit: power event registration failed!\n");
900 if ((EVENTHANDLER_REGISTER(shutdown_post_sync, adashutdown,
901 NULL, SHUTDOWN_PRI_DEFAULT)) == NULL)
902 printf("adainit: shutdown event registration failed!\n");
907 * Callback from GEOM, called when it has finished cleaning up its
911 adadiskgonecb(struct disk *dp)
913 struct cam_periph *periph;
915 periph = (struct cam_periph *)dp->d_drv1;
917 cam_periph_release(periph);
921 adaoninvalidate(struct cam_periph *periph)
923 struct ada_softc *softc;
925 softc = (struct ada_softc *)periph->softc;
928 * De-register any async callbacks.
930 xpt_register_async(0, adaasync, periph, periph->path);
933 * Return all queued I/O with ENXIO.
934 * XXX Handle any transactions queued to the card
935 * with XPT_ABORT_CCB.
937 bioq_flush(&softc->bio_queue, NULL, ENXIO);
938 bioq_flush(&softc->trim_queue, NULL, ENXIO);
940 disk_gone(softc->disk);
944 adacleanup(struct cam_periph *periph)
946 struct ada_softc *softc;
948 softc = (struct ada_softc *)periph->softc;
950 cam_periph_unlock(periph);
953 * If we can't free the sysctl tree, oh well...
955 if ((softc->flags & ADA_FLAG_SCTX_INIT) != 0
956 && sysctl_ctx_free(&softc->sysctl_ctx) != 0) {
957 xpt_print(periph->path, "can't remove sysctl context\n");
960 disk_destroy(softc->disk);
961 callout_drain(&softc->sendordered_c);
962 free(softc, M_DEVBUF);
963 cam_periph_lock(periph);
967 adaasync(void *callback_arg, u_int32_t code,
968 struct cam_path *path, void *arg)
970 struct ccb_getdev cgd;
971 struct cam_periph *periph;
972 struct ada_softc *softc;
974 periph = (struct cam_periph *)callback_arg;
976 case AC_FOUND_DEVICE:
978 struct ccb_getdev *cgd;
981 cgd = (struct ccb_getdev *)arg;
985 if (cgd->protocol != PROTO_ATA)
989 * Allocate a peripheral instance for
990 * this device and start the probe
993 status = cam_periph_alloc(adaregister, adaoninvalidate,
994 adacleanup, adastart,
995 "ada", CAM_PERIPH_BIO,
997 AC_FOUND_DEVICE, cgd);
999 if (status != CAM_REQ_CMP
1000 && status != CAM_REQ_INPROG)
1001 printf("adaasync: Unable to attach to new device "
1002 "due to status 0x%x\n", status);
1005 case AC_GETDEV_CHANGED:
1007 softc = (struct ada_softc *)periph->softc;
1008 xpt_setup_ccb(&cgd.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
1009 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1010 xpt_action((union ccb *)&cgd);
1012 if ((cgd.ident_data.capabilities1 & ATA_SUPPORT_DMA) &&
1013 (cgd.inq_flags & SID_DMA))
1014 softc->flags |= ADA_FLAG_CAN_DMA;
1016 softc->flags &= ~ADA_FLAG_CAN_DMA;
1017 if (cgd.ident_data.support.command2 & ATA_SUPPORT_ADDRESS48) {
1018 softc->flags |= ADA_FLAG_CAN_48BIT;
1019 if (cgd.inq_flags & SID_DMA48)
1020 softc->flags |= ADA_FLAG_CAN_DMA48;
1022 softc->flags &= ~ADA_FLAG_CAN_DMA48;
1024 softc->flags &= ~(ADA_FLAG_CAN_48BIT |
1025 ADA_FLAG_CAN_DMA48);
1026 if ((cgd.ident_data.satacapabilities & ATA_SUPPORT_NCQ) &&
1027 (cgd.inq_flags & SID_DMA) && (cgd.inq_flags & SID_CmdQue))
1028 softc->flags |= ADA_FLAG_CAN_NCQ;
1030 softc->flags &= ~ADA_FLAG_CAN_NCQ;
1031 if ((cgd.ident_data.support_dsm & ATA_SUPPORT_DSM_TRIM) &&
1032 (cgd.inq_flags & SID_DMA))
1033 softc->flags |= ADA_FLAG_CAN_TRIM;
1035 softc->flags &= ~ADA_FLAG_CAN_TRIM;
1037 cam_periph_async(periph, code, path, arg);
1040 case AC_ADVINFO_CHANGED:
1044 buftype = (uintptr_t)arg;
1045 if (buftype == CDAI_TYPE_PHYS_PATH) {
1046 struct ada_softc *softc;
1048 softc = periph->softc;
1049 disk_attr_changed(softc->disk, "GEOM::physpath",
1057 softc = (struct ada_softc *)periph->softc;
1058 cam_periph_async(periph, code, path, arg);
1059 if (softc->state != ADA_STATE_NORMAL)
1061 xpt_setup_ccb(&cgd.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
1062 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1063 xpt_action((union ccb *)&cgd);
1065 cgd.ident_data.support.command1 & ATA_SUPPORT_LOOKAHEAD)
1066 softc->state = ADA_STATE_RAHEAD;
1067 else if (ADA_WC >= 0 &&
1068 cgd.ident_data.support.command1 & ATA_SUPPORT_WRITECACHE)
1069 softc->state = ADA_STATE_WCACHE;
1072 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
1073 softc->state = ADA_STATE_NORMAL;
1075 xpt_schedule(periph, CAM_PRIORITY_DEV);
1078 cam_periph_async(periph, code, path, arg);
1084 adasysctlinit(void *context, int pending)
1086 struct cam_periph *periph;
1087 struct ada_softc *softc;
1088 char tmpstr[80], tmpstr2[80];
1090 periph = (struct cam_periph *)context;
1092 /* periph was held for us when this task was enqueued */
1093 if ((periph->flags & CAM_PERIPH_INVALID) != 0) {
1094 cam_periph_release(periph);
1098 softc = (struct ada_softc *)periph->softc;
1099 snprintf(tmpstr, sizeof(tmpstr), "CAM ADA unit %d", periph->unit_number);
1100 snprintf(tmpstr2, sizeof(tmpstr2), "%d", periph->unit_number);
1102 sysctl_ctx_init(&softc->sysctl_ctx);
1103 softc->flags |= ADA_FLAG_SCTX_INIT;
1104 softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
1105 SYSCTL_STATIC_CHILDREN(_kern_cam_ada), OID_AUTO, tmpstr2,
1106 CTLFLAG_RD, 0, tmpstr);
1107 if (softc->sysctl_tree == NULL) {
1108 printf("adasysctlinit: unable to allocate sysctl tree\n");
1109 cam_periph_release(periph);
1113 SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1114 OID_AUTO, "read_ahead", CTLFLAG_RW | CTLFLAG_MPSAFE,
1115 &softc->read_ahead, 0, "Enable disk read ahead.");
1116 SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1117 OID_AUTO, "write_cache", CTLFLAG_RW | CTLFLAG_MPSAFE,
1118 &softc->write_cache, 0, "Enable disk write cache.");
1119 SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1120 OID_AUTO, "sort_io_queue", CTLFLAG_RW | CTLFLAG_MPSAFE,
1121 &softc->sort_io_queue, 0,
1122 "Sort IO queue to try and optimise disk access patterns");
1123 #ifdef ADA_TEST_FAILURE
1125 * Add a 'door bell' sysctl which allows one to set it from userland
1126 * and cause something bad to happen. For the moment, we only allow
1127 * whacking the next read or write.
1129 SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1130 OID_AUTO, "force_read_error", CTLFLAG_RW | CTLFLAG_MPSAFE,
1131 &softc->force_read_error, 0,
1132 "Force a read error for the next N reads.");
1133 SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1134 OID_AUTO, "force_write_error", CTLFLAG_RW | CTLFLAG_MPSAFE,
1135 &softc->force_write_error, 0,
1136 "Force a write error for the next N writes.");
1137 SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1138 OID_AUTO, "periodic_read_error", CTLFLAG_RW | CTLFLAG_MPSAFE,
1139 &softc->periodic_read_error, 0,
1140 "Force a read error every N reads (don't set too low).");
1142 cam_periph_release(periph);
1146 adagetattr(struct bio *bp)
1149 struct cam_periph *periph;
1151 periph = (struct cam_periph *)bp->bio_disk->d_drv1;
1152 cam_periph_lock(periph);
1153 ret = xpt_getattr(bp->bio_data, bp->bio_length, bp->bio_attribute,
1155 cam_periph_unlock(periph);
1157 bp->bio_completed = bp->bio_length;
1162 adaregister(struct cam_periph *periph, void *arg)
1164 struct ada_softc *softc;
1165 struct ccb_pathinq cpi;
1166 struct ccb_getdev *cgd;
1167 char announce_buf[80], buf1[32];
1168 struct disk_params *dp;
1171 int legacy_id, quirks;
1173 cgd = (struct ccb_getdev *)arg;
1175 printf("adaregister: no getdev CCB, can't register device\n");
1176 return(CAM_REQ_CMP_ERR);
1179 softc = (struct ada_softc *)malloc(sizeof(*softc), M_DEVBUF,
1182 if (softc == NULL) {
1183 printf("adaregister: Unable to probe new device. "
1184 "Unable to allocate softc\n");
1185 return(CAM_REQ_CMP_ERR);
1188 bioq_init(&softc->bio_queue);
1189 bioq_init(&softc->trim_queue);
1191 if ((cgd->ident_data.capabilities1 & ATA_SUPPORT_DMA) &&
1192 (cgd->inq_flags & SID_DMA))
1193 softc->flags |= ADA_FLAG_CAN_DMA;
1194 if (cgd->ident_data.support.command2 & ATA_SUPPORT_ADDRESS48) {
1195 softc->flags |= ADA_FLAG_CAN_48BIT;
1196 if (cgd->inq_flags & SID_DMA48)
1197 softc->flags |= ADA_FLAG_CAN_DMA48;
1199 if (cgd->ident_data.support.command2 & ATA_SUPPORT_FLUSHCACHE)
1200 softc->flags |= ADA_FLAG_CAN_FLUSHCACHE;
1201 if (cgd->ident_data.support.command1 & ATA_SUPPORT_POWERMGT)
1202 softc->flags |= ADA_FLAG_CAN_POWERMGT;
1203 if ((cgd->ident_data.satacapabilities & ATA_SUPPORT_NCQ) &&
1204 (cgd->inq_flags & SID_DMA) && (cgd->inq_flags & SID_CmdQue))
1205 softc->flags |= ADA_FLAG_CAN_NCQ;
1206 if ((cgd->ident_data.support_dsm & ATA_SUPPORT_DSM_TRIM) &&
1207 (cgd->inq_flags & SID_DMA)) {
1208 softc->flags |= ADA_FLAG_CAN_TRIM;
1209 softc->trim_max_ranges = TRIM_MAX_RANGES;
1210 if (cgd->ident_data.max_dsm_blocks != 0) {
1211 softc->trim_max_ranges =
1212 min(cgd->ident_data.max_dsm_blocks *
1213 ATA_DSM_BLK_RANGES, softc->trim_max_ranges);
1216 if (cgd->ident_data.support.command2 & ATA_SUPPORT_CFA)
1217 softc->flags |= ADA_FLAG_CAN_CFA;
1219 periph->softc = softc;
1222 * See if this device has any quirks.
1224 match = cam_quirkmatch((caddr_t)&cgd->ident_data,
1225 (caddr_t)ada_quirk_table,
1226 sizeof(ada_quirk_table)/sizeof(*ada_quirk_table),
1227 sizeof(*ada_quirk_table), ata_identify_match);
1229 softc->quirks = ((struct ada_quirk_entry *)match)->quirks;
1231 softc->quirks = ADA_Q_NONE;
1233 bzero(&cpi, sizeof(cpi));
1234 xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NONE);
1235 cpi.ccb_h.func_code = XPT_PATH_INQ;
1236 xpt_action((union ccb *)&cpi);
1238 TASK_INIT(&softc->sysctl_task, 0, adasysctlinit, periph);
1241 * Register this media as a disk
1243 (void)cam_periph_hold(periph, PRIBIO);
1244 cam_periph_unlock(periph);
1245 snprintf(announce_buf, sizeof(announce_buf),
1246 "kern.cam.ada.%d.quirks", periph->unit_number);
1247 quirks = softc->quirks;
1248 TUNABLE_INT_FETCH(announce_buf, &quirks);
1249 softc->quirks = quirks;
1250 softc->read_ahead = -1;
1251 snprintf(announce_buf, sizeof(announce_buf),
1252 "kern.cam.ada.%d.read_ahead", periph->unit_number);
1253 TUNABLE_INT_FETCH(announce_buf, &softc->read_ahead);
1254 softc->write_cache = -1;
1255 snprintf(announce_buf, sizeof(announce_buf),
1256 "kern.cam.ada.%d.write_cache", periph->unit_number);
1257 TUNABLE_INT_FETCH(announce_buf, &softc->write_cache);
1258 /* Disable queue sorting for non-rotational media by default. */
1259 if (cgd->ident_data.media_rotation_rate == ATA_RATE_NON_ROTATING)
1260 softc->sort_io_queue = 0;
1262 softc->sort_io_queue = -1;
1263 adagetparams(periph, cgd);
1264 softc->disk = disk_alloc();
1265 softc->disk->d_rotation_rate = cgd->ident_data.media_rotation_rate;
1266 softc->disk->d_devstat = devstat_new_entry(periph->periph_name,
1267 periph->unit_number, softc->params.secsize,
1268 DEVSTAT_ALL_SUPPORTED,
1269 DEVSTAT_TYPE_DIRECT |
1270 XPORT_DEVSTAT_TYPE(cpi.transport),
1271 DEVSTAT_PRIORITY_DISK);
1272 softc->disk->d_open = adaopen;
1273 softc->disk->d_close = adaclose;
1274 softc->disk->d_strategy = adastrategy;
1275 softc->disk->d_getattr = adagetattr;
1276 softc->disk->d_dump = adadump;
1277 softc->disk->d_gone = adadiskgonecb;
1278 softc->disk->d_name = "ada";
1279 softc->disk->d_drv1 = periph;
1280 maxio = cpi.maxio; /* Honor max I/O size of SIM */
1282 maxio = DFLTPHYS; /* traditional default */
1283 else if (maxio > MAXPHYS)
1284 maxio = MAXPHYS; /* for safety */
1285 if (softc->flags & ADA_FLAG_CAN_48BIT)
1286 maxio = min(maxio, 65536 * softc->params.secsize);
1287 else /* 28bit ATA command limit */
1288 maxio = min(maxio, 256 * softc->params.secsize);
1289 softc->disk->d_maxsize = maxio;
1290 softc->disk->d_unit = periph->unit_number;
1291 softc->disk->d_flags = DISKFLAG_DIRECT_COMPLETION;
1292 if (softc->flags & ADA_FLAG_CAN_FLUSHCACHE)
1293 softc->disk->d_flags |= DISKFLAG_CANFLUSHCACHE;
1294 if (softc->flags & ADA_FLAG_CAN_TRIM) {
1295 softc->disk->d_flags |= DISKFLAG_CANDELETE;
1296 softc->disk->d_delmaxsize = softc->params.secsize *
1298 softc->trim_max_ranges;
1299 } else if ((softc->flags & ADA_FLAG_CAN_CFA) &&
1300 !(softc->flags & ADA_FLAG_CAN_48BIT)) {
1301 softc->disk->d_flags |= DISKFLAG_CANDELETE;
1302 softc->disk->d_delmaxsize = 256 * softc->params.secsize;
1304 softc->disk->d_delmaxsize = maxio;
1305 if ((cpi.hba_misc & PIM_UNMAPPED) != 0)
1306 softc->disk->d_flags |= DISKFLAG_UNMAPPED_BIO;
1307 strlcpy(softc->disk->d_descr, cgd->ident_data.model,
1308 MIN(sizeof(softc->disk->d_descr), sizeof(cgd->ident_data.model)));
1309 strlcpy(softc->disk->d_ident, cgd->ident_data.serial,
1310 MIN(sizeof(softc->disk->d_ident), sizeof(cgd->ident_data.serial)));
1311 softc->disk->d_hba_vendor = cpi.hba_vendor;
1312 softc->disk->d_hba_device = cpi.hba_device;
1313 softc->disk->d_hba_subvendor = cpi.hba_subvendor;
1314 softc->disk->d_hba_subdevice = cpi.hba_subdevice;
1316 softc->disk->d_sectorsize = softc->params.secsize;
1317 softc->disk->d_mediasize = (off_t)softc->params.sectors *
1318 softc->params.secsize;
1319 if (ata_physical_sector_size(&cgd->ident_data) !=
1320 softc->params.secsize) {
1321 softc->disk->d_stripesize =
1322 ata_physical_sector_size(&cgd->ident_data);
1323 softc->disk->d_stripeoffset = (softc->disk->d_stripesize -
1324 ata_logical_sector_offset(&cgd->ident_data)) %
1325 softc->disk->d_stripesize;
1326 } else if (softc->quirks & ADA_Q_4K) {
1327 softc->disk->d_stripesize = 4096;
1328 softc->disk->d_stripeoffset = 0;
1330 softc->disk->d_fwsectors = softc->params.secs_per_track;
1331 softc->disk->d_fwheads = softc->params.heads;
1332 ata_disk_firmware_geom_adjust(softc->disk);
1334 if (ada_legacy_aliases) {
1335 #ifdef ATA_STATIC_ID
1336 legacy_id = xpt_path_legacy_ata_id(periph->path);
1338 legacy_id = softc->disk->d_unit;
1340 if (legacy_id >= 0) {
1341 snprintf(announce_buf, sizeof(announce_buf),
1342 "kern.devalias.%s%d",
1343 softc->disk->d_name, softc->disk->d_unit);
1344 snprintf(buf1, sizeof(buf1),
1346 kern_setenv(announce_buf, buf1);
1351 * Acquire a reference to the periph before we register with GEOM.
1352 * We'll release this reference once GEOM calls us back (via
1353 * adadiskgonecb()) telling us that our provider has been freed.
1355 if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
1356 xpt_print(periph->path, "%s: lost periph during "
1357 "registration!\n", __func__);
1358 cam_periph_lock(periph);
1359 return (CAM_REQ_CMP_ERR);
1361 disk_create(softc->disk, DISK_VERSION);
1362 cam_periph_lock(periph);
1363 cam_periph_unhold(periph);
1365 dp = &softc->params;
1366 snprintf(announce_buf, sizeof(announce_buf),
1367 "%juMB (%ju %u byte sectors: %dH %dS/T %dC)",
1368 (uintmax_t)(((uintmax_t)dp->secsize *
1369 dp->sectors) / (1024*1024)),
1370 (uintmax_t)dp->sectors,
1371 dp->secsize, dp->heads,
1372 dp->secs_per_track, dp->cylinders);
1373 xpt_announce_periph(periph, announce_buf);
1374 xpt_announce_quirks(periph, softc->quirks, ADA_Q_BIT_STRING);
1376 printf("%s%d: Previously was known as ad%d\n",
1377 periph->periph_name, periph->unit_number, legacy_id);
1380 * Create our sysctl variables, now that we know
1381 * we have successfully attached.
1383 if (cam_periph_acquire(periph) == CAM_REQ_CMP)
1384 taskqueue_enqueue(taskqueue_thread, &softc->sysctl_task);
1387 * Add async callbacks for bus reset and
1388 * bus device reset calls. I don't bother
1389 * checking if this fails as, in most cases,
1390 * the system will function just fine without
1391 * them and the only alternative would be to
1392 * not attach the device on failure.
1394 xpt_register_async(AC_SENT_BDR | AC_BUS_RESET | AC_LOST_DEVICE |
1395 AC_GETDEV_CHANGED | AC_ADVINFO_CHANGED,
1396 adaasync, periph, periph->path);
1399 * Schedule a periodic event to occasionally send an
1400 * ordered tag to a device.
1402 callout_init_mtx(&softc->sendordered_c, cam_periph_mtx(periph), 0);
1403 callout_reset(&softc->sendordered_c,
1404 (ada_default_timeout * hz) / ADA_ORDEREDTAG_INTERVAL,
1405 adasendorderedtag, softc);
1408 cgd->ident_data.support.command1 & ATA_SUPPORT_LOOKAHEAD) {
1409 softc->state = ADA_STATE_RAHEAD;
1410 } else if (ADA_WC >= 0 &&
1411 cgd->ident_data.support.command1 & ATA_SUPPORT_WRITECACHE) {
1412 softc->state = ADA_STATE_WCACHE;
1414 softc->state = ADA_STATE_NORMAL;
1415 return(CAM_REQ_CMP);
1417 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
1418 softc->state = ADA_STATE_NORMAL;
1420 xpt_schedule(periph, CAM_PRIORITY_DEV);
1421 return(CAM_REQ_CMP);
1425 ada_dsmtrim(struct ada_softc *softc, struct bio *bp, struct ccb_ataio *ataio)
1427 struct trim_request *req = &softc->trim_req;
1428 uint64_t lastlba = (uint64_t)-1;
1429 int c, lastcount = 0, off, ranges = 0;
1431 bzero(req, sizeof(*req));
1432 TAILQ_INIT(&req->bps);
1434 uint64_t lba = bp->bio_pblkno;
1435 int count = bp->bio_bcount / softc->params.secsize;
1437 bioq_remove(&softc->trim_queue, bp);
1439 /* Try to extend the previous range. */
1440 if (lba == lastlba) {
1441 c = min(count, ATA_DSM_RANGE_MAX - lastcount);
1443 off = (ranges - 1) * ATA_DSM_RANGE_SIZE;
1444 req->data[off + 6] = lastcount & 0xff;
1445 req->data[off + 7] =
1446 (lastcount >> 8) & 0xff;
1452 c = min(count, ATA_DSM_RANGE_MAX);
1453 off = ranges * ATA_DSM_RANGE_SIZE;
1454 req->data[off + 0] = lba & 0xff;
1455 req->data[off + 1] = (lba >> 8) & 0xff;
1456 req->data[off + 2] = (lba >> 16) & 0xff;
1457 req->data[off + 3] = (lba >> 24) & 0xff;
1458 req->data[off + 4] = (lba >> 32) & 0xff;
1459 req->data[off + 5] = (lba >> 40) & 0xff;
1460 req->data[off + 6] = c & 0xff;
1461 req->data[off + 7] = (c >> 8) & 0xff;
1467 * Its the caller's responsibility to ensure the
1468 * request will fit so we don't need to check for
1473 TAILQ_INSERT_TAIL(&req->bps, bp, bio_queue);
1474 bp = bioq_first(&softc->trim_queue);
1476 bp->bio_bcount / softc->params.secsize >
1477 (softc->trim_max_ranges - ranges) * ATA_DSM_RANGE_MAX)
1480 cam_fill_ataio(ataio,
1486 ((ranges + ATA_DSM_BLK_RANGES - 1) /
1487 ATA_DSM_BLK_RANGES) * ATA_DSM_BLK_SIZE,
1488 ada_default_timeout * 1000);
1489 ata_48bit_cmd(ataio, ATA_DATA_SET_MANAGEMENT,
1490 ATA_DSM_TRIM, 0, (ranges + ATA_DSM_BLK_RANGES -
1491 1) / ATA_DSM_BLK_RANGES);
1495 ada_cfaerase(struct ada_softc *softc, struct bio *bp, struct ccb_ataio *ataio)
1497 struct trim_request *req = &softc->trim_req;
1498 uint64_t lba = bp->bio_pblkno;
1499 uint16_t count = bp->bio_bcount / softc->params.secsize;
1501 bzero(req, sizeof(*req));
1502 TAILQ_INIT(&req->bps);
1503 bioq_remove(&softc->trim_queue, bp);
1504 TAILQ_INSERT_TAIL(&req->bps, bp, bio_queue);
1506 cam_fill_ataio(ataio,
1513 ada_default_timeout*1000);
1517 ata_28bit_cmd(ataio, ATA_CFA_ERASE, 0, lba, count);
1521 adastart(struct cam_periph *periph, union ccb *start_ccb)
1523 struct ada_softc *softc = (struct ada_softc *)periph->softc;
1524 struct ccb_ataio *ataio = &start_ccb->ataio;
1526 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("adastart\n"));
1528 switch (softc->state) {
1529 case ADA_STATE_NORMAL:
1534 /* Run TRIM if not running yet. */
1535 if (!softc->trim_running &&
1536 (bp = bioq_first(&softc->trim_queue)) != 0) {
1537 if (softc->flags & ADA_FLAG_CAN_TRIM) {
1538 ada_dsmtrim(softc, bp, ataio);
1539 } else if ((softc->flags & ADA_FLAG_CAN_CFA) &&
1540 !(softc->flags & ADA_FLAG_CAN_48BIT)) {
1541 ada_cfaerase(softc, bp, ataio);
1543 /* This can happen if DMA was disabled. */
1544 bioq_remove(&softc->trim_queue, bp);
1545 bp->bio_error = EOPNOTSUPP;
1546 bp->bio_flags |= BIO_ERROR;
1548 xpt_release_ccb(start_ccb);
1549 adaschedule(periph);
1552 softc->trim_running = 1;
1553 start_ccb->ccb_h.ccb_state = ADA_CCB_TRIM;
1554 start_ccb->ccb_h.flags |= CAM_UNLOCKED;
1557 /* Run regular command. */
1558 bp = bioq_first(&softc->bio_queue);
1560 xpt_release_ccb(start_ccb);
1563 bioq_remove(&softc->bio_queue, bp);
1565 if ((bp->bio_flags & BIO_ORDERED) != 0
1566 || (softc->flags & ADA_FLAG_NEED_OTAG) != 0) {
1567 softc->flags &= ~ADA_FLAG_NEED_OTAG;
1568 softc->flags |= ADA_FLAG_WAS_OTAG;
1573 switch (bp->bio_cmd) {
1575 softc->flags |= ADA_FLAG_DIRTY;
1579 uint64_t lba = bp->bio_pblkno;
1580 uint16_t count = bp->bio_bcount / softc->params.secsize;
1581 #ifdef ADA_TEST_FAILURE
1585 * Support the failure ioctls. If the command is a
1586 * read, and there are pending forced read errors, or
1587 * if a write and pending write errors, then fail this
1588 * operation with EIO. This is useful for testing
1589 * purposes. Also, support having every Nth read fail.
1591 * This is a rather blunt tool.
1593 if (bp->bio_cmd == BIO_READ) {
1594 if (softc->force_read_error) {
1595 softc->force_read_error--;
1598 if (softc->periodic_read_error > 0) {
1599 if (++softc->periodic_read_count >=
1600 softc->periodic_read_error) {
1601 softc->periodic_read_count = 0;
1606 if (softc->force_write_error) {
1607 softc->force_write_error--;
1612 bp->bio_error = EIO;
1613 bp->bio_flags |= BIO_ERROR;
1615 xpt_release_ccb(start_ccb);
1616 adaschedule(periph);
1620 KASSERT((bp->bio_flags & BIO_UNMAPPED) == 0 ||
1621 round_page(bp->bio_bcount + bp->bio_ma_offset) /
1622 PAGE_SIZE == bp->bio_ma_n,
1623 ("Short bio %p", bp));
1624 cam_fill_ataio(ataio,
1627 (bp->bio_cmd == BIO_READ ? CAM_DIR_IN :
1628 CAM_DIR_OUT) | ((bp->bio_flags & BIO_UNMAPPED)
1629 != 0 ? CAM_DATA_BIO : 0),
1631 ((bp->bio_flags & BIO_UNMAPPED) != 0) ? (void *)bp :
1634 ada_default_timeout*1000);
1636 if ((softc->flags & ADA_FLAG_CAN_NCQ) && tag_code) {
1637 if (bp->bio_cmd == BIO_READ) {
1638 ata_ncq_cmd(ataio, ATA_READ_FPDMA_QUEUED,
1641 ata_ncq_cmd(ataio, ATA_WRITE_FPDMA_QUEUED,
1644 } else if ((softc->flags & ADA_FLAG_CAN_48BIT) &&
1645 (lba + count >= ATA_MAX_28BIT_LBA ||
1647 if (softc->flags & ADA_FLAG_CAN_DMA48) {
1648 if (bp->bio_cmd == BIO_READ) {
1649 ata_48bit_cmd(ataio, ATA_READ_DMA48,
1652 ata_48bit_cmd(ataio, ATA_WRITE_DMA48,
1656 if (bp->bio_cmd == BIO_READ) {
1657 ata_48bit_cmd(ataio, ATA_READ_MUL48,
1660 ata_48bit_cmd(ataio, ATA_WRITE_MUL48,
1667 if (softc->flags & ADA_FLAG_CAN_DMA) {
1668 if (bp->bio_cmd == BIO_READ) {
1669 ata_28bit_cmd(ataio, ATA_READ_DMA,
1672 ata_28bit_cmd(ataio, ATA_WRITE_DMA,
1676 if (bp->bio_cmd == BIO_READ) {
1677 ata_28bit_cmd(ataio, ATA_READ_MUL,
1680 ata_28bit_cmd(ataio, ATA_WRITE_MUL,
1688 cam_fill_ataio(ataio,
1695 ada_default_timeout*1000);
1697 if (softc->flags & ADA_FLAG_CAN_48BIT)
1698 ata_48bit_cmd(ataio, ATA_FLUSHCACHE48, 0, 0, 0);
1700 ata_28bit_cmd(ataio, ATA_FLUSHCACHE, 0, 0, 0);
1703 start_ccb->ccb_h.ccb_state = ADA_CCB_BUFFER_IO;
1704 start_ccb->ccb_h.flags |= CAM_UNLOCKED;
1706 start_ccb->ccb_h.ccb_bp = bp;
1707 softc->outstanding_cmds++;
1709 cam_periph_unlock(periph);
1710 xpt_action(start_ccb);
1711 cam_periph_lock(periph);
1714 /* May have more work to do, so ensure we stay scheduled */
1715 adaschedule(periph);
1718 case ADA_STATE_RAHEAD:
1719 case ADA_STATE_WCACHE:
1721 cam_fill_ataio(ataio,
1728 ada_default_timeout*1000);
1730 if (softc->state == ADA_STATE_RAHEAD) {
1731 ata_28bit_cmd(ataio, ATA_SETFEATURES, ADA_RA ?
1732 ATA_SF_ENAB_RCACHE : ATA_SF_DIS_RCACHE, 0, 0);
1733 start_ccb->ccb_h.ccb_state = ADA_CCB_RAHEAD;
1735 ata_28bit_cmd(ataio, ATA_SETFEATURES, ADA_WC ?
1736 ATA_SF_ENAB_WCACHE : ATA_SF_DIS_WCACHE, 0, 0);
1737 start_ccb->ccb_h.ccb_state = ADA_CCB_WCACHE;
1739 start_ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1740 xpt_action(start_ccb);
1747 adadone(struct cam_periph *periph, union ccb *done_ccb)
1749 struct ada_softc *softc;
1750 struct ccb_ataio *ataio;
1751 struct ccb_getdev *cgd;
1752 struct cam_path *path;
1755 softc = (struct ada_softc *)periph->softc;
1756 ataio = &done_ccb->ataio;
1757 path = done_ccb->ccb_h.path;
1759 CAM_DEBUG(path, CAM_DEBUG_TRACE, ("adadone\n"));
1761 state = ataio->ccb_h.ccb_state & ADA_CCB_TYPE_MASK;
1763 case ADA_CCB_BUFFER_IO:
1769 cam_periph_lock(periph);
1770 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1771 error = adaerror(done_ccb, 0, 0);
1772 if (error == ERESTART) {
1773 /* A retry was scheduled, so just return. */
1774 cam_periph_unlock(periph);
1777 if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
1778 cam_release_devq(path,
1782 /*getcount_only*/0);
1784 if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
1785 panic("REQ_CMP with QFRZN");
1788 bp = (struct bio *)done_ccb->ccb_h.ccb_bp;
1789 bp->bio_error = error;
1791 bp->bio_resid = bp->bio_bcount;
1792 bp->bio_flags |= BIO_ERROR;
1794 if (state == ADA_CCB_TRIM)
1797 bp->bio_resid = ataio->resid;
1798 if (bp->bio_resid > 0)
1799 bp->bio_flags |= BIO_ERROR;
1801 softc->outstanding_cmds--;
1802 if (softc->outstanding_cmds == 0)
1803 softc->flags |= ADA_FLAG_WAS_OTAG;
1804 xpt_release_ccb(done_ccb);
1805 if (state == ADA_CCB_TRIM) {
1806 TAILQ_HEAD(, bio) queue;
1810 TAILQ_CONCAT(&queue, &softc->trim_req.bps, bio_queue);
1812 * Normally, the xpt_release_ccb() above would make sure
1813 * that when we have more work to do, that work would
1814 * get kicked off. However, we specifically keep
1815 * trim_running set to 0 before the call above to allow
1816 * other I/O to progress when many BIO_DELETE requests
1817 * are pushed down. We set trim_running to 0 and call
1818 * daschedule again so that we don't stall if there are
1819 * no other I/Os pending apart from BIO_DELETEs.
1821 softc->trim_running = 0;
1822 adaschedule(periph);
1823 cam_periph_unlock(periph);
1824 while ((bp1 = TAILQ_FIRST(&queue)) != NULL) {
1825 TAILQ_REMOVE(&queue, bp1, bio_queue);
1826 bp1->bio_error = error;
1828 bp1->bio_flags |= BIO_ERROR;
1829 bp1->bio_resid = bp1->bio_bcount;
1835 cam_periph_unlock(periph);
1840 case ADA_CCB_RAHEAD:
1842 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1843 if (adaerror(done_ccb, 0, 0) == ERESTART) {
1845 /* Drop freeze taken due to CAM_DEV_QFREEZE */
1846 cam_release_devq(path, 0, 0, 0, FALSE);
1848 } else if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1849 cam_release_devq(path,
1853 /*getcount_only*/0);
1858 * Since our peripheral may be invalidated by an error
1859 * above or an external event, we must release our CCB
1860 * before releasing the reference on the peripheral.
1861 * The peripheral will only go away once the last reference
1862 * is removed, and we need it around for the CCB release
1865 cgd = (struct ccb_getdev *)done_ccb;
1866 xpt_setup_ccb(&cgd->ccb_h, path, CAM_PRIORITY_NORMAL);
1867 cgd->ccb_h.func_code = XPT_GDEV_TYPE;
1868 xpt_action((union ccb *)cgd);
1870 cgd->ident_data.support.command1 & ATA_SUPPORT_WRITECACHE) {
1871 softc->state = ADA_STATE_WCACHE;
1872 xpt_release_ccb(done_ccb);
1873 xpt_schedule(periph, CAM_PRIORITY_DEV);
1876 softc->state = ADA_STATE_NORMAL;
1877 xpt_release_ccb(done_ccb);
1878 /* Drop freeze taken due to CAM_DEV_QFREEZE */
1879 cam_release_devq(path, 0, 0, 0, FALSE);
1880 adaschedule(periph);
1881 cam_periph_release_locked(periph);
1884 case ADA_CCB_WCACHE:
1886 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1887 if (adaerror(done_ccb, 0, 0) == ERESTART) {
1889 } else if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1890 cam_release_devq(path,
1894 /*getcount_only*/0);
1898 softc->state = ADA_STATE_NORMAL;
1900 * Since our peripheral may be invalidated by an error
1901 * above or an external event, we must release our CCB
1902 * before releasing the reference on the peripheral.
1903 * The peripheral will only go away once the last reference
1904 * is removed, and we need it around for the CCB release
1907 xpt_release_ccb(done_ccb);
1908 /* Drop freeze taken due to CAM_DEV_QFREEZE */
1909 cam_release_devq(path, 0, 0, 0, FALSE);
1910 adaschedule(periph);
1911 cam_periph_release_locked(periph);
1915 /* No-op. We're polling */
1920 xpt_release_ccb(done_ccb);
1924 adaerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
1927 return(cam_periph_error(ccb, cam_flags, sense_flags, NULL));
1931 adagetparams(struct cam_periph *periph, struct ccb_getdev *cgd)
1933 struct ada_softc *softc = (struct ada_softc *)periph->softc;
1934 struct disk_params *dp = &softc->params;
1935 u_int64_t lbasize48;
1938 dp->secsize = ata_logical_sector_size(&cgd->ident_data);
1939 if ((cgd->ident_data.atavalid & ATA_FLAG_54_58) &&
1940 cgd->ident_data.current_heads && cgd->ident_data.current_sectors) {
1941 dp->heads = cgd->ident_data.current_heads;
1942 dp->secs_per_track = cgd->ident_data.current_sectors;
1943 dp->cylinders = cgd->ident_data.cylinders;
1944 dp->sectors = (u_int32_t)cgd->ident_data.current_size_1 |
1945 ((u_int32_t)cgd->ident_data.current_size_2 << 16);
1947 dp->heads = cgd->ident_data.heads;
1948 dp->secs_per_track = cgd->ident_data.sectors;
1949 dp->cylinders = cgd->ident_data.cylinders;
1950 dp->sectors = cgd->ident_data.cylinders * dp->heads * dp->secs_per_track;
1952 lbasize = (u_int32_t)cgd->ident_data.lba_size_1 |
1953 ((u_int32_t)cgd->ident_data.lba_size_2 << 16);
1955 /* use the 28bit LBA size if valid or bigger than the CHS mapping */
1956 if (cgd->ident_data.cylinders == 16383 || dp->sectors < lbasize)
1957 dp->sectors = lbasize;
1959 /* use the 48bit LBA size if valid */
1960 lbasize48 = ((u_int64_t)cgd->ident_data.lba_size48_1) |
1961 ((u_int64_t)cgd->ident_data.lba_size48_2 << 16) |
1962 ((u_int64_t)cgd->ident_data.lba_size48_3 << 32) |
1963 ((u_int64_t)cgd->ident_data.lba_size48_4 << 48);
1964 if ((cgd->ident_data.support.command2 & ATA_SUPPORT_ADDRESS48) &&
1965 lbasize48 > ATA_MAX_28BIT_LBA)
1966 dp->sectors = lbasize48;
1970 adasendorderedtag(void *arg)
1972 struct ada_softc *softc = arg;
1974 if (ada_send_ordered) {
1975 if (softc->outstanding_cmds > 0) {
1976 if ((softc->flags & ADA_FLAG_WAS_OTAG) == 0)
1977 softc->flags |= ADA_FLAG_NEED_OTAG;
1978 softc->flags &= ~ADA_FLAG_WAS_OTAG;
1981 /* Queue us up again */
1982 callout_reset(&softc->sendordered_c,
1983 (ada_default_timeout * hz) / ADA_ORDEREDTAG_INTERVAL,
1984 adasendorderedtag, softc);
1988 * Step through all ADA peripheral drivers, and if the device is still open,
1989 * sync the disk cache to physical media.
1994 struct cam_periph *periph;
1995 struct ada_softc *softc;
1999 CAM_PERIPH_FOREACH(periph, &adadriver) {
2000 softc = (struct ada_softc *)periph->softc;
2001 if (SCHEDULER_STOPPED()) {
2002 /* If we paniced with the lock held, do not recurse. */
2003 if (!cam_periph_owned(periph) &&
2004 (softc->flags & ADA_FLAG_OPEN)) {
2005 adadump(softc->disk, NULL, 0, 0, 0);
2009 cam_periph_lock(periph);
2011 * We only sync the cache if the drive is still open, and
2012 * if the drive is capable of it..
2014 if (((softc->flags & ADA_FLAG_OPEN) == 0) ||
2015 (softc->flags & ADA_FLAG_CAN_FLUSHCACHE) == 0) {
2016 cam_periph_unlock(periph);
2020 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
2021 cam_fill_ataio(&ccb->ataio,
2028 ada_default_timeout*1000);
2029 if (softc->flags & ADA_FLAG_CAN_48BIT)
2030 ata_48bit_cmd(&ccb->ataio, ATA_FLUSHCACHE48, 0, 0, 0);
2032 ata_28bit_cmd(&ccb->ataio, ATA_FLUSHCACHE, 0, 0, 0);
2034 error = cam_periph_runccb(ccb, adaerror, /*cam_flags*/0,
2035 /*sense_flags*/ SF_NO_RECOVERY | SF_NO_RETRY,
2036 softc->disk->d_devstat);
2038 xpt_print(periph->path, "Synchronize cache failed\n");
2039 xpt_release_ccb(ccb);
2040 cam_periph_unlock(periph);
2045 adaspindown(uint8_t cmd, int flags)
2047 struct cam_periph *periph;
2048 struct ada_softc *softc;
2052 CAM_PERIPH_FOREACH(periph, &adadriver) {
2053 /* If we paniced with lock held - not recurse here. */
2054 if (cam_periph_owned(periph))
2056 cam_periph_lock(periph);
2057 softc = (struct ada_softc *)periph->softc;
2059 * We only spin-down the drive if it is capable of it..
2061 if ((softc->flags & ADA_FLAG_CAN_POWERMGT) == 0) {
2062 cam_periph_unlock(periph);
2067 xpt_print(periph->path, "spin-down\n");
2069 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
2070 cam_fill_ataio(&ccb->ataio,
2073 CAM_DIR_NONE | flags,
2077 ada_default_timeout*1000);
2078 ata_28bit_cmd(&ccb->ataio, cmd, 0, 0, 0);
2080 error = cam_periph_runccb(ccb, adaerror, /*cam_flags*/0,
2081 /*sense_flags*/ SF_NO_RECOVERY | SF_NO_RETRY,
2082 softc->disk->d_devstat);
2084 xpt_print(periph->path, "Spin-down disk failed\n");
2085 xpt_release_ccb(ccb);
2086 cam_periph_unlock(periph);
2091 adashutdown(void *arg, int howto)
2095 if (ada_spindown_shutdown != 0 &&
2096 (howto & (RB_HALT | RB_POWEROFF)) != 0)
2097 adaspindown(ATA_STANDBY_IMMEDIATE, 0);
2101 adasuspend(void *arg)
2105 if (ada_spindown_suspend != 0)
2106 adaspindown(ATA_SLEEP, CAM_DEV_QFREEZE);
2110 adaresume(void *arg)
2112 struct cam_periph *periph;
2113 struct ada_softc *softc;
2115 if (ada_spindown_suspend == 0)
2118 CAM_PERIPH_FOREACH(periph, &adadriver) {
2119 cam_periph_lock(periph);
2120 softc = (struct ada_softc *)periph->softc;
2122 * We only spin-down the drive if it is capable of it..
2124 if ((softc->flags & ADA_FLAG_CAN_POWERMGT) == 0) {
2125 cam_periph_unlock(periph);
2130 xpt_print(periph->path, "resume\n");
2133 * Drop freeze taken due to CAM_DEV_QFREEZE flag set on
2136 cam_release_devq(periph->path,
2140 /*getcount_only*/0);
2142 cam_periph_unlock(periph);
2146 #endif /* _KERNEL */