2 * Implementation of SCSI Direct Access Peripheral driver for CAM.
4 * Copyright (c) 1997 Justin T. Gibbs.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification, immediately at the beginning of the file.
13 * 2. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * $FreeBSD: src/sys/cam/scsi/scsi_da.c,v 1.42.2.46 2003/10/21 22:18:19 thomas Exp $
31 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
38 #include <sys/sysctl.h>
39 #include <sys/taskqueue.h>
42 #include <sys/devicestat.h>
44 #include <sys/dtype.h>
45 #include <sys/eventhandler.h>
46 #include <sys/malloc.h>
49 #include <sys/ioctl_compat.h>
52 #include <sys/thread2.h>
53 #include <sys/mplock2.h>
66 #include <sys/camlib.h>
68 #include "../cam_ccb.h"
69 #include "../cam_extend.h"
70 #include "../cam_periph.h"
71 #include "../cam_xpt_periph.h"
72 #include "../cam_sim.h"
74 #include "scsi_message.h"
88 DA_FLAG_PACK_INVALID = 0x001,
89 DA_FLAG_NEW_PACK = 0x002,
90 DA_FLAG_PACK_LOCKED = 0x004,
91 DA_FLAG_PACK_REMOVABLE = 0x008,
92 DA_FLAG_TAGGED_QUEUING = 0x010,
93 DA_FLAG_NEED_OTAG = 0x020,
94 DA_FLAG_WENT_IDLE = 0x040,
95 DA_FLAG_RETRY_UA = 0x080,
97 DA_FLAG_SCTX_INIT = 0x200,
98 DA_FLAG_RD_LIMIT = 0x400,
99 DA_FLAG_WR_LIMIT = 0x800,
100 DA_FLAG_CAN_TRIM = 0x1000
105 DA_Q_NO_SYNC_CACHE = 0x01,
106 DA_Q_NO_6_BYTE = 0x02,
107 DA_Q_NO_PREVENT = 0x04
112 DA_CCB_PROBE2 = 0x02,
113 DA_CCB_BUFFER_IO = 0x03,
114 DA_CCB_WAITING = 0x04,
117 DA_CCB_TYPE_MASK = 0x0F,
118 DA_CCB_RETRY_UA = 0x10
121 /* Offsets into our private area for storing information */
122 #define ccb_state ppriv_field0
123 #define ccb_bio ppriv_ptr1
128 u_int8_t secs_per_track;
129 u_int32_t secsize; /* Number of bytes/sector */
130 u_int64_t sectors; /* total number sectors */
133 #define TRIM_MAX_BLOCKS 8
134 #define TRIM_MAX_RANGES TRIM_MAX_BLOCKS * 64
135 struct trim_request {
136 uint8_t data[TRIM_MAX_RANGES * 8];
137 struct bio *bios[TRIM_MAX_RANGES];
141 struct bio_queue_head bio_queue_rd;
142 struct bio_queue_head bio_queue_wr;
143 struct bio_queue_head bio_queue_trim;
144 struct devstat device_stats;
145 SLIST_ENTRY(da_softc) links;
146 LIST_HEAD(, ccb_hdr) pending_ccbs;
150 int minimum_cmd_size;
151 int ordered_tag_count;
152 int outstanding_cmds_rd;
153 int outstanding_cmds_wr;
157 struct disk_params params;
160 struct task sysctl_task;
161 struct sysctl_ctx_list sysctl_ctx;
162 struct sysctl_oid *sysctl_tree;
163 struct callout sendordered_c;
164 struct trim_request trim_req;
167 struct da_quirk_entry {
168 struct scsi_inquiry_pattern inq_pat;
172 static const char quantum[] = "QUANTUM";
173 static const char microp[] = "MICROP";
175 static struct da_quirk_entry da_quirk_table[] =
177 /* SPI, FC devices */
180 * Fujitsu M2513A MO drives.
181 * Tested devices: M2513A2 firmware versions 1200 & 1300.
182 * (dip switch selects whether T_DIRECT or T_OPTICAL device)
183 * Reported by: W.Scholten <whs@xs4all.nl>
185 {T_DIRECT, SIP_MEDIA_REMOVABLE, "FUJITSU", "M2513A", "*"},
186 /*quirks*/ DA_Q_NO_SYNC_CACHE
190 {T_OPTICAL, SIP_MEDIA_REMOVABLE, "FUJITSU", "M2513A", "*"},
191 /*quirks*/ DA_Q_NO_SYNC_CACHE
195 * This particular Fujitsu drive doesn't like the
196 * synchronize cache command.
197 * Reported by: Tom Jackson <toj@gorilla.net>
199 {T_DIRECT, SIP_MEDIA_FIXED, "FUJITSU", "M2954*", "*"},
200 /*quirks*/ DA_Q_NO_SYNC_CACHE
204 * This drive doesn't like the synchronize cache command
205 * either. Reported by: Matthew Jacob <mjacob@feral.com>
206 * in NetBSD PR kern/6027, August 24, 1998.
208 {T_DIRECT, SIP_MEDIA_FIXED, microp, "2217*", "*"},
209 /*quirks*/ DA_Q_NO_SYNC_CACHE
213 * This drive doesn't like the synchronize cache command
214 * either. Reported by: Hellmuth Michaelis (hm@kts.org)
217 {T_DIRECT, SIP_MEDIA_FIXED, microp, "2112*", "*"},
218 /*quirks*/ DA_Q_NO_SYNC_CACHE
222 * Doesn't like the synchronize cache command.
223 * Reported by: Blaz Zupan <blaz@gold.amis.net>
225 {T_DIRECT, SIP_MEDIA_FIXED, "NEC", "D3847*", "*"},
226 /*quirks*/ DA_Q_NO_SYNC_CACHE
230 * Doesn't like the synchronize cache command.
231 * Reported by: Blaz Zupan <blaz@gold.amis.net>
233 {T_DIRECT, SIP_MEDIA_FIXED, quantum, "MAVERICK 540S", "*"},
234 /*quirks*/ DA_Q_NO_SYNC_CACHE
238 * Doesn't like the synchronize cache command.
240 {T_DIRECT, SIP_MEDIA_FIXED, quantum, "LPS525S", "*"},
241 /*quirks*/ DA_Q_NO_SYNC_CACHE
245 * Doesn't like the synchronize cache command.
246 * Reported by: walter@pelissero.de
248 {T_DIRECT, SIP_MEDIA_FIXED, quantum, "LPS540S", "*"},
249 /*quirks*/ DA_Q_NO_SYNC_CACHE
253 * Doesn't work correctly with 6 byte reads/writes.
254 * Returns illegal request, and points to byte 9 of the
256 * Reported by: Adam McDougall <bsdx@spawnet.com>
258 {T_DIRECT, SIP_MEDIA_FIXED, quantum, "VIKING 4*", "*"},
259 /*quirks*/ DA_Q_NO_6_BYTE
263 {T_DIRECT, SIP_MEDIA_FIXED, quantum, "VIKING 2*", "*"},
264 /*quirks*/ DA_Q_NO_6_BYTE
268 * Doesn't like the synchronize cache command.
269 * Reported by: walter@pelissero.de
271 {T_DIRECT, SIP_MEDIA_FIXED, "CONNER", "CP3500*", "*"},
272 /*quirks*/ DA_Q_NO_SYNC_CACHE
276 * The CISS RAID controllers do not support SYNC_CACHE
278 {T_DIRECT, SIP_MEDIA_FIXED, "COMPAQ", "RAID*", "*"},
279 /*quirks*/ DA_Q_NO_SYNC_CACHE
283 * The same goes for the mly(4) controllers
285 {T_DIRECT, SIP_MEDIA_FIXED, "MLY*", "*", "MYLX"},
286 /*quirks*/ DA_Q_NO_SYNC_CACHE
289 * USB mass storage devices supported by umass(4)
291 * NOTE: USB attachments automatically set DA_Q_NO_SYNC_CACHE so
292 * it does not have to be specified here.
296 * Creative Nomad MUVO mp3 player (USB)
299 {T_DIRECT, SIP_MEDIA_REMOVABLE, "CREATIVE", "NOMAD_MUVO", "*"},
300 /*quirks*/ DA_Q_NO_PREVENT
304 * Sigmatel USB Flash MP3 Player
307 {T_DIRECT, SIP_MEDIA_REMOVABLE, "SigmaTel", "MSCN", "*"},
308 /*quirks*/ DA_Q_NO_PREVENT
312 * SEAGRAND NP-900 MP3 Player
315 {T_DIRECT, SIP_MEDIA_REMOVABLE, "SEAGRAND", "NP-900*", "*"},
316 /*quirks*/ DA_Q_NO_PREVENT
320 * Creative MUVO Slim mp3 player (USB)
323 {T_DIRECT, SIP_MEDIA_REMOVABLE, "CREATIVE", "MuVo Slim",
324 "*"}, /*quirks*/ DA_Q_NO_PREVENT
328 * Philips USB Key Audio KEY013
331 {T_DIRECT, SIP_MEDIA_REMOVABLE, "PHILIPS", "Key*", "*"},
332 /*quirks*/ DA_Q_NO_PREVENT
336 static d_open_t daopen;
337 static d_close_t daclose;
338 static d_strategy_t dastrategy;
339 static d_dump_t dadump;
340 static d_ioctl_t daioctl;
341 static periph_init_t dainit;
342 static void daasync(void *callback_arg, u_int32_t code,
343 struct cam_path *path, void *arg);
344 static int dacmdsizesysctl(SYSCTL_HANDLER_ARGS);
345 static periph_ctor_t daregister;
346 static periph_dtor_t dacleanup;
347 static periph_start_t dastart;
348 static periph_oninv_t daoninvalidate;
349 static void dadone(struct cam_periph *periph,
350 union ccb *done_ccb);
351 static int daerror(union ccb *ccb, u_int32_t cam_flags,
352 u_int32_t sense_flags);
353 static void daprevent(struct cam_periph *periph, int action);
354 static int dagetcapacity(struct cam_periph *periph);
355 static int dacheckmedia(struct cam_periph *periph);
356 static void dasetgeom(struct cam_periph *periph, uint32_t block_len,
358 static void daflushbioq(struct bio_queue_head *bioq, int error);
359 static timeout_t dasendorderedtag;
360 static void dashutdown(void *arg, int howto);
362 #ifndef DA_DEFAULT_TIMEOUT
363 #define DA_DEFAULT_TIMEOUT 60 /* Timeout in seconds */
366 #ifndef DA_DEFAULT_RETRY
367 #define DA_DEFAULT_RETRY 4
370 #ifndef DA_DEFAULT_SEND_ORDERED
371 #define DA_DEFAULT_SEND_ORDERED 1
374 static int da_retry_count = DA_DEFAULT_RETRY;
375 static int da_default_timeout = DA_DEFAULT_TIMEOUT;
376 static int da_send_ordered = DA_DEFAULT_SEND_ORDERED;
377 static struct callout dasendorderedtag_ch;
379 SYSCTL_NODE(_kern_cam, OID_AUTO, da, CTLFLAG_RD, 0,
380 "CAM Direct Access Disk driver");
381 SYSCTL_INT(_kern_cam_da, OID_AUTO, retry_count, CTLFLAG_RW,
382 &da_retry_count, 0, "Normal I/O retry count");
383 TUNABLE_INT("kern.cam.da.retry_count", &da_retry_count);
384 SYSCTL_INT(_kern_cam_da, OID_AUTO, default_timeout, CTLFLAG_RW,
385 &da_default_timeout, 0, "Normal I/O timeout (in seconds)");
386 TUNABLE_INT("kern.cam.da.default_timeout", &da_default_timeout);
387 SYSCTL_INT(_kern_cam_da, OID_AUTO, da_send_ordered, CTLFLAG_RW,
388 &da_send_ordered, 0, "Send Ordered Tags");
389 TUNABLE_INT("kern.cam.da.da_send_ordered", &da_send_ordered);
392 * DA_ORDEREDTAG_INTERVAL determines how often, relative
393 * to the default timeout, we check to see whether an ordered
394 * tagged transaction is appropriate to prevent simple tag
395 * starvation. Since we'd like to ensure that there is at least
396 * 1/2 of the timeout length left for a starved transaction to
397 * complete after we've sent an ordered tag, we must poll at least
398 * four times in every timeout period. This takes care of the worst
399 * case where a starved transaction starts during an interval that
400 * meets the requirement "don't send an ordered tag" test so it takes
401 * us two intervals to determine that a tag must be sent.
403 #ifndef DA_ORDEREDTAG_INTERVAL
404 #define DA_ORDEREDTAG_INTERVAL 4
407 static struct periph_driver dadriver =
410 TAILQ_HEAD_INITIALIZER(dadriver.units), /* generation */ 0
413 PERIPHDRIVER_DECLARE(da, dadriver);
415 static struct dev_ops da_ops = {
416 { "da", 0, D_DISK | D_MPSAFE },
420 .d_write = physwrite,
421 .d_strategy = dastrategy,
426 static struct extend_array *daperiphs;
428 MALLOC_DEFINE(M_SCSIDA, "scsi_da", "scsi_da buffers");
431 daioctl(struct dev_ioctl_args *ap)
436 struct cam_periph *periph;
438 struct da_softc * softc;
440 off_t *del_num = (off_t*)ap->a_data;
444 cdev_t dev = ap->a_head.a_dev;
448 periph = cam_extend_get(daperiphs, unit);
451 softc = (struct da_softc *)periph->softc;
457 bytes_left = del_num[1];
458 bytes_start = del_num[0];
460 /* TRIM occurs on 512-byte sectors. */
461 KKASSERT((bytes_left % 512) == 0);
462 KKASSERT((bytes_start% 512) == 0);
465 /* Break TRIM up into int-sized commands because of b_bcount */
469 * Rather than than squezing out more blocks in b_bcount
470 * and having to break up the TRIM request in da_start(),
471 * we ensure we can always TRIM this many bytes with one
472 * TRIM command (this happens if the device only
473 * supports one TRIM block).
475 * With min TRIM blksize of 1, TRIM command free
476 * 4194240 blks(64*65535): each LBA range can address
477 * 65535 blks and there 64 such ranges in a 512-byte
478 * block. And, 4194240 * 512 = 0x7FFF8000
481 byte_count = MIN(bytes_left,0x7FFF8000);
482 bp = getnewbuf(0,0,0,1);
484 bp->b_cmd = BUF_CMD_FREEBLKS;
485 bp->b_bio1.bio_offset = bytes_start;
486 bp->b_bcount = byte_count;
487 bp->b_bio1.bio_flags |= BIO_SYNC;
488 bp->b_bio1.bio_done = biodone_sync;
490 dev_dstrategy(ap->a_head.a_dev, &bp->b_bio1);
492 if (biowait(&bp->b_bio1, "TRIM")) {
493 kprintf("Error:%d\n", bp->b_error);
494 return(bp->b_error ? bp->b_error : EIO);
497 bytes_left -= byte_count;
498 bytes_start += byte_count;
510 daopen(struct dev_open_args *ap)
512 cdev_t dev = ap->a_head.a_dev;
513 struct cam_periph *periph;
514 struct da_softc *softc;
515 struct disk_info info;
520 periph = cam_extend_get(daperiphs, unit);
521 if (periph == NULL) {
525 if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
529 cam_periph_lock(periph);
530 if ((error = cam_periph_hold(periph, PCATCH)) != 0) {
531 cam_periph_unlock(periph);
532 cam_periph_release(periph);
536 unit = periph->unit_number;
537 softc = (struct da_softc *)periph->softc;
539 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
540 ("daopen: dev=%s (unit %d)\n", devtoname(dev),
543 if ((softc->flags & DA_FLAG_PACK_INVALID) != 0) {
544 /* Invalidate our pack information. */
545 disk_invalidate(&softc->disk);
546 softc->flags &= ~DA_FLAG_PACK_INVALID;
549 error = dacheckmedia(periph);
550 softc->flags |= DA_FLAG_OPEN;
553 struct ccb_getdev cgd;
555 /* Build disk information structure */
556 bzero(&info, sizeof(info));
557 info.d_type = DTYPE_SCSI;
560 * Grab the inquiry data to get the vendor and product names.
561 * Put them in the typename and packname for the label.
563 xpt_setup_ccb(&cgd.ccb_h, periph->path, /*priority*/ 1);
564 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
565 xpt_action((union ccb *)&cgd);
568 * Check to see whether or not the blocksize is set yet.
569 * If it isn't, set it and then clear the blocksize
570 * unavailable flag for the device statistics.
572 if ((softc->device_stats.flags & DEVSTAT_BS_UNAVAILABLE) != 0){
573 softc->device_stats.block_size = softc->params.secsize;
574 softc->device_stats.flags &= ~DEVSTAT_BS_UNAVAILABLE;
579 if ((softc->flags & DA_FLAG_PACK_REMOVABLE) != 0 &&
580 (softc->quirks & DA_Q_NO_PREVENT) == 0)
581 daprevent(periph, PR_PREVENT);
583 softc->flags &= ~DA_FLAG_OPEN;
584 cam_periph_release(periph);
586 cam_periph_unhold(periph, 1);
591 daclose(struct dev_close_args *ap)
593 cdev_t dev = ap->a_head.a_dev;
594 struct cam_periph *periph;
595 struct da_softc *softc;
600 periph = cam_extend_get(daperiphs, unit);
604 cam_periph_lock(periph);
605 if ((error = cam_periph_hold(periph, 0)) != 0) {
606 cam_periph_unlock(periph);
607 cam_periph_release(periph);
611 softc = (struct da_softc *)periph->softc;
613 if ((softc->quirks & DA_Q_NO_SYNC_CACHE) == 0) {
616 ccb = cam_periph_getccb(periph, /*priority*/1);
618 scsi_synchronize_cache(&ccb->csio,
622 /*begin_lba*/0,/* Cover the whole disk */
627 cam_periph_runccb(ccb, /*error_routine*/NULL, /*cam_flags*/0,
628 /*sense_flags*/SF_RETRY_UA,
629 &softc->device_stats);
631 if ((ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
632 if ((ccb->ccb_h.status & CAM_STATUS_MASK) ==
633 CAM_SCSI_STATUS_ERROR) {
635 int sense_key, error_code;
637 scsi_extract_sense(&ccb->csio.sense_data,
641 if (sense_key != SSD_KEY_ILLEGAL_REQUEST)
642 scsi_sense_print(&ccb->csio);
644 xpt_print(periph->path, "Synchronize cache "
645 "failed, status == 0x%x, scsi status == "
646 "0x%x\n", ccb->csio.ccb_h.status,
647 ccb->csio.scsi_status);
651 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
652 cam_release_devq(ccb->ccb_h.path,
658 xpt_release_ccb(ccb);
662 if ((softc->flags & DA_FLAG_PACK_REMOVABLE) != 0) {
663 if ((softc->quirks & DA_Q_NO_PREVENT) == 0)
664 daprevent(periph, PR_ALLOW);
666 * If we've got removeable media, mark the blocksize as
667 * unavailable, since it could change when new media is
670 softc->device_stats.flags |= DEVSTAT_BS_UNAVAILABLE;
674 * Don't compound any ref counting software bugs with more.
676 if (softc->flags & DA_FLAG_OPEN) {
677 softc->flags &= ~DA_FLAG_OPEN;
678 cam_periph_release(periph);
680 xpt_print(periph->path,
681 "daclose() called on an already closed device!\n");
683 cam_periph_unhold(periph, 1);
688 * Actually translate the requested transfer into one the physical driver
689 * can understand. The transfer is described by a buf and will include
690 * only one physical transfer.
693 dastrategy(struct dev_strategy_args *ap)
695 cdev_t dev = ap->a_head.a_dev;
696 struct bio *bio = ap->a_bio;
697 struct buf *bp = bio->bio_buf;
698 struct cam_periph *periph;
699 struct da_softc *softc;
705 periph = cam_extend_get(daperiphs, unit);
706 if (periph == NULL) {
710 softc = (struct da_softc *)periph->softc;
712 cam_periph_lock(periph);
716 * check it's not too big a transfer for our adapter
718 scsi_minphys(bp, &sd_switch);
722 * Mask interrupts so that the pack cannot be invalidated until
723 * after we are in the queue. Otherwise, we might not properly
724 * clean up one of the buffers.
728 * If the device has been made invalid, error out
730 if ((softc->flags & DA_FLAG_PACK_INVALID)) {
731 cam_periph_unlock(periph);
737 * Place it in the queue of disk activities for this disk
739 if (bp->b_cmd == BUF_CMD_WRITE || bp->b_cmd == BUF_CMD_FLUSH)
740 bioqdisksort(&softc->bio_queue_wr, bio);
741 else if (bp->b_cmd == BUF_CMD_FREEBLKS)
742 bioqdisksort(&softc->bio_queue_trim, bio);
744 bioqdisksort(&softc->bio_queue_rd, bio);
747 * Schedule ourselves for performing the work.
749 xpt_schedule(periph, /* XXX priority */1);
750 cam_periph_unlock(periph);
754 bp->b_flags |= B_ERROR;
757 * Correctly set the buf to indicate a completed xfer
759 bp->b_resid = bp->b_bcount;
765 dadump(struct dev_dump_args *ap)
767 cdev_t dev = ap->a_head.a_dev;
768 struct cam_periph *periph;
769 struct da_softc *softc;
772 struct ccb_scsiio csio;
775 periph = cam_extend_get(daperiphs, unit);
779 softc = (struct da_softc *)periph->softc;
780 cam_periph_lock(periph);
781 secsize = softc->params.secsize; /* XXX: or ap->a_secsize? */
783 if ((softc->flags & DA_FLAG_PACK_INVALID) != 0) {
784 cam_periph_unlock(periph);
789 * because length == 0 means we are supposed to flush cache, we only
790 * try to write something if length > 0.
792 if (ap->a_length > 0) {
793 xpt_setup_ccb(&csio.ccb_h, periph->path, /*priority*/1);
794 csio.ccb_h.flags |= CAM_POLLED;
795 csio.ccb_h.ccb_state = DA_CCB_DUMP;
796 scsi_read_write(&csio,
802 /*minimum_cmd_size*/ softc->minimum_cmd_size,
803 ap->a_offset / secsize,
804 ap->a_length / secsize,
805 /*data_ptr*/(u_int8_t *) ap->a_virtual,
806 /*dxfer_len*/ap->a_length,
807 /*sense_len*/SSD_FULL_SIZE,
808 DA_DEFAULT_TIMEOUT * 1000);
809 xpt_polled_action((union ccb *)&csio);
811 if ((csio.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
812 kprintf("Aborting dump due to I/O error.\n");
813 if ((csio.ccb_h.status & CAM_STATUS_MASK) ==
814 CAM_SCSI_STATUS_ERROR)
815 scsi_sense_print(&csio);
817 kprintf("status == 0x%x, scsi status == 0x%x\n",
818 csio.ccb_h.status, csio.scsi_status);
821 cam_periph_unlock(periph);
826 * Sync the disk cache contents to the physical media.
828 if ((softc->quirks & DA_Q_NO_SYNC_CACHE) == 0) {
830 xpt_setup_ccb(&csio.ccb_h, periph->path, /*priority*/1);
831 csio.ccb_h.ccb_state = DA_CCB_DUMP;
832 scsi_synchronize_cache(&csio,
836 /*begin_lba*/0,/* Cover the whole disk */
840 xpt_polled_action((union ccb *)&csio);
842 if ((csio.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
843 if ((csio.ccb_h.status & CAM_STATUS_MASK) ==
844 CAM_SCSI_STATUS_ERROR) {
846 int sense_key, error_code;
848 scsi_extract_sense(&csio.sense_data,
852 if (sense_key != SSD_KEY_ILLEGAL_REQUEST)
853 scsi_sense_print(&csio);
855 xpt_print(periph->path, "Synchronize cache "
856 "failed, status == 0x%x, scsi status == "
857 "0x%x\n", csio.ccb_h.status,
862 cam_periph_unlock(periph);
872 * Create our extend array for storing the devices we attach to.
874 daperiphs = cam_extend_new();
875 if (daperiphs == NULL) {
876 kprintf("da: Failed to alloc extend array!\n");
880 callout_init(&dasendorderedtag_ch);
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, daasync, NULL, NULL);
888 if (status != CAM_REQ_CMP) {
889 kprintf("da: Failed to attach master async callback "
890 "due to status 0x%x!\n", status);
891 } else if (da_send_ordered) {
893 /* Register our shutdown event handler */
894 if ((EVENTHANDLER_REGISTER(shutdown_post_sync, dashutdown,
895 NULL, SHUTDOWN_PRI_DEFAULT)) == NULL)
896 kprintf("dainit: shutdown event registration failed!\n");
901 daoninvalidate(struct cam_periph *periph)
903 struct da_softc *softc;
905 softc = (struct da_softc *)periph->softc;
908 * De-register any async callbacks.
910 xpt_register_async(0, daasync, periph, periph->path);
912 softc->flags |= DA_FLAG_PACK_INVALID;
915 * Return all queued I/O with ENXIO.
916 * XXX Handle any transactions queued to the card
917 * with XPT_ABORT_CCB.
919 daflushbioq(&softc->bio_queue_trim, ENXIO);
920 daflushbioq(&softc->bio_queue_wr, ENXIO);
921 daflushbioq(&softc->bio_queue_rd, ENXIO);
922 xpt_print(periph->path, "lost device\n");
926 daflushbioq(struct bio_queue_head *bioq, int error)
931 while ((q_bio = bioq_first(bioq)) != NULL){
932 bioq_remove(bioq, q_bio);
933 q_bp = q_bio->bio_buf;
934 q_bp->b_resid = q_bp->b_bcount;
935 q_bp->b_error = error;
936 q_bp->b_flags |= B_ERROR;
942 dacleanup(struct cam_periph *periph)
944 struct da_softc *softc;
946 softc = (struct da_softc *)periph->softc;
948 devstat_remove_entry(&softc->device_stats);
949 cam_extend_release(daperiphs, periph->unit_number);
950 xpt_print(periph->path, "removing device entry\n");
952 * If we can't free the sysctl tree, oh well...
954 if ((softc->flags & DA_FLAG_SCTX_INIT) != 0
955 && sysctl_ctx_free(&softc->sysctl_ctx) != 0) {
956 xpt_print(periph->path, "can't remove sysctl context\n");
958 periph->softc = NULL;
959 if (softc->disk.d_rawdev) {
960 cam_periph_unlock(periph);
961 disk_destroy(&softc->disk);
962 cam_periph_lock(periph);
965 callout_stop(&softc->sendordered_c);
966 kfree(softc, M_DEVBUF);
970 daasync(void *callback_arg, u_int32_t code,
971 struct cam_path *path, void *arg)
973 struct cam_periph *periph;
975 periph = (struct cam_periph *)callback_arg;
978 case AC_FOUND_DEVICE:
980 struct ccb_getdev *cgd;
984 cgd = (struct ccb_getdev *)arg;
988 if (SID_TYPE(&cgd->inq_data) != T_DIRECT
989 && SID_TYPE(&cgd->inq_data) != T_RBC
990 && SID_TYPE(&cgd->inq_data) != T_OPTICAL)
994 * Don't complain if a valid peripheral is already attached.
996 periph = cam_periph_find(cgd->ccb_h.path, "da");
997 if (periph && (periph->flags & CAM_PERIPH_INVALID) == 0)
1001 * Allocate a peripheral instance for
1002 * this device and start the probe
1005 sim = xpt_path_sim(cgd->ccb_h.path);
1006 status = cam_periph_alloc(daregister, daoninvalidate,
1008 "da", CAM_PERIPH_BIO,
1009 cgd->ccb_h.path, daasync,
1010 AC_FOUND_DEVICE, cgd);
1012 if (status != CAM_REQ_CMP && status != CAM_REQ_INPROG) {
1013 kprintf("daasync: Unable to attach to new device "
1014 "due to status 0x%x\n", status);
1021 struct da_softc *softc;
1022 struct ccb_hdr *ccbh;
1024 softc = (struct da_softc *)periph->softc;
1026 * Don't fail on the expected unit attention
1029 softc->flags |= DA_FLAG_RETRY_UA;
1030 LIST_FOREACH(ccbh, &softc->pending_ccbs, periph_links.le)
1031 ccbh->ccb_state |= DA_CCB_RETRY_UA;
1035 cam_periph_async(periph, code, path, arg);
1041 dasysctlinit(void *context, int pending)
1043 struct cam_periph *periph;
1044 struct da_softc *softc;
1045 char tmpstr[80], tmpstr2[80];
1048 periph = (struct cam_periph *)context;
1049 if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
1054 softc = (struct da_softc *)periph->softc;
1055 ksnprintf(tmpstr, sizeof(tmpstr), "CAM DA unit %d", periph->unit_number);
1056 ksnprintf(tmpstr2, sizeof(tmpstr2), "%d", periph->unit_number);
1058 sysctl_ctx_init(&softc->sysctl_ctx);
1059 softc->flags |= DA_FLAG_SCTX_INIT;
1060 softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
1061 SYSCTL_STATIC_CHILDREN(_kern_cam_da), OID_AUTO, tmpstr2,
1062 CTLFLAG_RD, 0, tmpstr);
1063 if (softc->sysctl_tree == NULL) {
1064 kprintf("dasysctlinit: unable to allocate sysctl tree\n");
1065 cam_periph_release(periph);
1071 * Now register the sysctl handler, so the user can the value on
1074 SYSCTL_ADD_PROC(&softc->sysctl_ctx,SYSCTL_CHILDREN(softc->sysctl_tree),
1075 OID_AUTO, "minimum_cmd_size", CTLTYPE_INT | CTLFLAG_RW,
1076 &softc->minimum_cmd_size, 0, dacmdsizesysctl, "I",
1077 "Minimum CDB size");
1079 /* Only create the option if the device supports TRIM */
1080 if (softc->disk.d_info.d_trimflag) {
1081 SYSCTL_ADD_INT(&softc->sysctl_ctx,
1082 SYSCTL_CHILDREN(softc->sysctl_tree),
1086 &softc->trim_enabled,
1088 "Enable TRIM for this device (SSD))");
1091 cam_periph_release(periph);
1096 dacmdsizesysctl(SYSCTL_HANDLER_ARGS)
1100 value = *(int *)arg1;
1102 error = sysctl_handle_int(oidp, &value, 0, req);
1105 || (req->newptr == NULL))
1109 * Acceptable values here are 6, 10 or 12, or 16.
1113 else if ((value > 6)
1116 else if ((value > 10)
1119 else if (value > 12)
1122 *(int *)arg1 = value;
1128 daregister(struct cam_periph *periph, void *arg)
1130 struct da_softc *softc;
1131 struct ccb_pathinq cpi;
1132 struct ccb_getdev *cgd;
1136 cgd = (struct ccb_getdev *)arg;
1137 if (periph == NULL) {
1138 kprintf("daregister: periph was NULL!!\n");
1139 return(CAM_REQ_CMP_ERR);
1143 kprintf("daregister: no getdev CCB, can't register device\n");
1144 return(CAM_REQ_CMP_ERR);
1147 softc = kmalloc(sizeof(*softc), M_DEVBUF, M_INTWAIT | M_ZERO);
1148 LIST_INIT(&softc->pending_ccbs);
1149 softc->state = DA_STATE_PROBE;
1150 bioq_init(&softc->bio_queue_trim);
1151 bioq_init(&softc->bio_queue_rd);
1152 bioq_init(&softc->bio_queue_wr);
1153 if (SID_IS_REMOVABLE(&cgd->inq_data))
1154 softc->flags |= DA_FLAG_PACK_REMOVABLE;
1155 if ((cgd->inq_data.flags & SID_CmdQue) != 0)
1156 softc->flags |= DA_FLAG_TAGGED_QUEUING;
1158 /* Used to get TRIM status from AHCI driver */
1159 if (cgd->inq_data.vendor_specific1[0] == 1) {
1161 * max number of lba ranges an SSD can handle in a single
1162 * TRIM command. vendor_specific1[1] is the num of 512-byte
1163 * blocks the SSD reports that can be passed in a TRIM cmd.
1165 softc->trim_max_ranges =
1166 min(cgd->inq_data.vendor_specific1[1] * 64, TRIM_MAX_RANGES);
1169 periph->softc = softc;
1171 cam_extend_set(daperiphs, periph->unit_number, periph);
1174 * See if this device has any quirks.
1176 match = cam_quirkmatch((caddr_t)&cgd->inq_data,
1177 (caddr_t)da_quirk_table,
1178 NELEM(da_quirk_table),
1179 sizeof(*da_quirk_table), scsi_inquiry_match);
1182 softc->quirks = ((struct da_quirk_entry *)match)->quirks;
1184 softc->quirks = DA_Q_NONE;
1187 * Unconditionally disable the synchronize cache command for
1188 * usb attachments. It's just impossible to determine if the
1189 * device supports it or not and if it doesn't the port can
1192 if (strncmp(periph->sim->sim_name, "umass", 4) == 0) {
1193 softc->quirks |= DA_Q_NO_SYNC_CACHE;
1196 TASK_INIT(&softc->sysctl_task, 0, dasysctlinit, periph);
1198 /* Check if the SIM does not want 6 byte commands */
1199 bzero(&cpi, sizeof(cpi));
1200 xpt_setup_ccb(&cpi.ccb_h, periph->path, /*priority*/1);
1201 cpi.ccb_h.func_code = XPT_PATH_INQ;
1202 xpt_action((union ccb *)&cpi);
1203 if (cpi.ccb_h.status == CAM_REQ_CMP && (cpi.hba_misc & PIM_NO_6_BYTE))
1204 softc->quirks |= DA_Q_NO_6_BYTE;
1207 * RBC devices don't have to support READ(6), only READ(10).
1209 if (softc->quirks & DA_Q_NO_6_BYTE || SID_TYPE(&cgd->inq_data) == T_RBC)
1210 softc->minimum_cmd_size = 10;
1212 softc->minimum_cmd_size = 6;
1215 * Load the user's default, if any.
1217 ksnprintf(tmpstr, sizeof(tmpstr), "kern.cam.da.%d.minimum_cmd_size",
1218 periph->unit_number);
1219 TUNABLE_INT_FETCH(tmpstr, &softc->minimum_cmd_size);
1222 * 6, 10, 12, and 16 are the currently permissible values.
1224 if (softc->minimum_cmd_size < 6)
1225 softc->minimum_cmd_size = 6;
1226 else if ((softc->minimum_cmd_size > 6)
1227 && (softc->minimum_cmd_size <= 10))
1228 softc->minimum_cmd_size = 10;
1229 else if ((softc->minimum_cmd_size > 10)
1230 && (softc->minimum_cmd_size <= 12))
1231 softc->minimum_cmd_size = 12;
1232 else if (softc->minimum_cmd_size > 12)
1233 softc->minimum_cmd_size = 16;
1236 * The DA driver supports a blocksize, but
1237 * we don't know the blocksize until we do
1238 * a read capacity. So, set a flag to
1239 * indicate that the blocksize is
1240 * unavailable right now. We'll clear the
1241 * flag as soon as we've done a read capacity.
1243 devstat_add_entry(&softc->device_stats, "da",
1244 periph->unit_number, 0,
1245 DEVSTAT_BS_UNAVAILABLE,
1246 SID_TYPE(&cgd->inq_data) | DEVSTAT_TYPE_IF_SCSI,
1247 DEVSTAT_PRIORITY_DISK);
1250 * Register this media as a disk
1252 CAM_SIM_UNLOCK(periph->sim);
1253 disk_create(periph->unit_number, &softc->disk, &da_ops);
1254 if (cpi.maxio == 0 || cpi.maxio > MAXPHYS)
1255 softc->disk.d_rawdev->si_iosize_max = MAXPHYS;
1257 softc->disk.d_rawdev->si_iosize_max = cpi.maxio;
1258 CAM_SIM_LOCK(periph->sim);
1261 * Add async callbacks for bus reset and
1262 * bus device reset calls. I don't bother
1263 * checking if this fails as, in most cases,
1264 * the system will function just fine without
1265 * them and the only alternative would be to
1266 * not attach the device on failure.
1268 xpt_register_async(AC_SENT_BDR | AC_BUS_RESET | AC_LOST_DEVICE,
1269 daasync, periph, periph->path);
1272 * Take an exclusive refcount on the periph while dastart is called
1273 * to finish the probe. The reference will be dropped in dadone at
1276 cam_periph_hold(periph, 0);
1277 xpt_schedule(periph, /*priority*/5);
1280 * Schedule a periodic event to occasionally send an
1281 * ordered tag to a device.
1283 callout_init(&softc->sendordered_c);
1284 callout_reset(&softc->sendordered_c,
1285 (DA_DEFAULT_TIMEOUT * hz) / DA_ORDEREDTAG_INTERVAL,
1286 dasendorderedtag, softc);
1290 return(CAM_REQ_CMP);
1294 dastart(struct cam_periph *periph, union ccb *start_ccb)
1296 struct da_softc *softc;
1298 softc = (struct da_softc *)periph->softc;
1300 switch (softc->state) {
1301 case DA_STATE_NORMAL:
1303 /* Pull a buffer from the queue and get going on it */
1312 * See if there is a buf with work for us to do..
1314 bio_rd = bioq_first(&softc->bio_queue_rd);
1315 bio_wr = bioq_first(&softc->bio_queue_wr);
1317 if (periph->immediate_priority <= periph->pinfo.priority) {
1318 CAM_DEBUG_PRINT(CAM_DEBUG_SUBTRACE,
1319 ("queuing for immediate ccb\n"));
1320 start_ccb->ccb_h.ccb_state = DA_CCB_WAITING;
1321 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
1323 periph->immediate_priority = CAM_PRIORITY_NONE;
1324 wakeup(&periph->ccb_list);
1325 if (bio_rd || bio_wr) {
1327 * Have more work to do, so ensure we stay
1330 xpt_schedule(periph, /* XXX priority */1);
1335 /* Run the trim command if not already running */
1336 if (!softc->trim_running &&
1337 (bio = bioq_first(&softc->bio_queue_trim)) != NULL) {
1338 struct trim_request *req = &softc->trim_req;
1340 int bps = 0, ranges = 0;
1342 softc->trim_running = 1;
1343 bzero(req, sizeof(*req));
1350 count = bp->b_bcount / softc->params.secsize;
1351 lba = bio1->bio_offset/softc->params.secsize;
1353 kprintf("trim lba:%llu boff:%llu count:%d\n",
1354 (unsigned long long) lba,
1355 (unsigned long long) bio1->bio_offset,
1358 bioq_remove(&softc->bio_queue_trim, bio1);
1360 int c = min(count, 0xffff);
1361 int off = ranges * 8;
1363 req->data[off + 0] = lba & 0xff;
1364 req->data[off + 1] = (lba >> 8) & 0xff;
1365 req->data[off + 2] = (lba >> 16) & 0xff;
1366 req->data[off + 3] = (lba >> 24) & 0xff;
1367 req->data[off + 4] = (lba >> 32) & 0xff;
1368 req->data[off + 5] = (lba >> 40) & 0xff;
1369 req->data[off + 6] = c & 0xff;
1370 req->data[off + 7] = (c >> 8) & 0xff;
1376 /* Try to merge multiple TRIM requests */
1377 req->bios[bps++] = bio1;
1378 bio1 = bioq_first(&softc->bio_queue_trim);
1380 bio1->bio_buf->b_bcount / softc->params.secsize >
1381 (softc->trim_max_ranges - ranges) * 0xffff)
1386 cam_fill_csio(&start_ccb->csio,
1392 ((ranges +63)/64)*512,
1394 sizeof(struct scsi_rw_6),
1395 da_default_timeout*2);
1397 start_ccb->ccb_h.ccb_state = DA_CCB_TRIM;
1398 LIST_INSERT_HEAD(&softc->pending_ccbs,
1399 &start_ccb->ccb_h, periph_links.le);
1400 start_ccb->csio.ccb_h.func_code = XPT_TRIM;
1401 start_ccb->ccb_h.ccb_bio = bio;
1402 devstat_start_transaction(&softc->device_stats);
1403 xpt_action(start_ccb);
1404 xpt_schedule(periph, 1);
1409 * Select a read or write buffer to queue. Limit the number
1410 * of tags dedicated to reading or writing, giving reads
1413 * Writes to modern hard drives go into the HDs cache and
1414 * return completion nearly instantly. That is until the
1415 * cache becomes full. When the HDs cache becomes full
1416 * write commands will begin to stall. If all available
1417 * tags are taken up by writes which saturate the drive
1418 * reads will become tag-starved.
1420 * A similar situation can occur with reads. With many
1421 * parallel readers all tags can be taken up by reads
1422 * and prevent any writes from draining, even if the HD's
1423 * cache is not full.
1425 limit = periph->sim->max_tagged_dev_openings * 2 / 3 + 1;
1429 static long savets2;
1430 if (1 || time_second != savets2 || (ticks != savets && (softc->outstanding_cmds_rd || softc->outstanding_cmds_wr))) {
1431 kprintf("%d %d (%d)\n",
1432 softc->outstanding_cmds_rd,
1433 softc->outstanding_cmds_wr,
1436 savets2 = time_second;
1439 if (bio_rd && softc->outstanding_cmds_rd < limit) {
1441 bioq_remove(&softc->bio_queue_rd, bio);
1442 } else if (bio_wr && softc->outstanding_cmds_wr < limit) {
1444 bioq_remove(&softc->bio_queue_wr, bio);
1447 softc->flags |= DA_FLAG_RD_LIMIT;
1449 softc->flags |= DA_FLAG_WR_LIMIT;
1450 xpt_release_ccb(start_ccb);
1455 * We can queue new work.
1459 devstat_start_transaction(&softc->device_stats);
1461 if ((bp->b_flags & B_ORDERED) != 0 ||
1462 (softc->flags & DA_FLAG_NEED_OTAG) != 0) {
1463 softc->flags &= ~DA_FLAG_NEED_OTAG;
1464 softc->ordered_tag_count++;
1465 tag_code = MSG_ORDERED_Q_TAG;
1467 tag_code = MSG_SIMPLE_Q_TAG;
1474 * Block read/write op
1476 KKASSERT(bio->bio_offset % softc->params.secsize == 0);
1480 da_retry_count, /* retries */
1483 (bp->b_cmd == BUF_CMD_READ),
1485 softc->minimum_cmd_size,
1486 bio->bio_offset / softc->params.secsize,
1487 bp->b_bcount / softc->params.secsize,
1490 SSD_FULL_SIZE, /* sense_len */
1491 da_default_timeout * 1000
1496 * Silently complete a flush request if the device
1499 if (softc->quirks & DA_Q_NO_SYNC_CACHE) {
1500 xpt_release_ccb(start_ccb);
1502 devstat_end_transaction_buf(
1503 &softc->device_stats, bp);
1506 scsi_synchronize_cache(
1509 dadone, /* cbfcnp */
1512 0, /* count (whole disk) */
1514 da_default_timeout*1000 /* timeout */
1518 case BUF_CMD_FREEBLKS:
1519 if (softc->disk.d_info.d_trimflag & DA_FLAG_CAN_TRIM){
1520 start_ccb->csio.ccb_h.func_code = XPT_TRIM;
1524 xpt_release_ccb(start_ccb);
1526 panic("dastart: unrecognized bio cmd %d", bp->b_cmd);
1527 break; /* NOT REACHED */
1531 * Block out any asyncronous callbacks
1532 * while we touch the pending ccb list.
1535 start_ccb->ccb_h.ccb_state = DA_CCB_BUFFER_IO;
1536 LIST_INSERT_HEAD(&softc->pending_ccbs,
1537 &start_ccb->ccb_h, periph_links.le);
1538 if (bp->b_cmd == BUF_CMD_WRITE ||
1539 bp->b_cmd == BUF_CMD_FLUSH) {
1540 ++softc->outstanding_cmds_wr;
1542 ++softc->outstanding_cmds_rd;
1545 /* We expect a unit attention from this device */
1546 if ((softc->flags & DA_FLAG_RETRY_UA) != 0) {
1547 start_ccb->ccb_h.ccb_state |= DA_CCB_RETRY_UA;
1548 softc->flags &= ~DA_FLAG_RETRY_UA;
1551 start_ccb->ccb_h.ccb_bio = bio;
1552 xpt_action(start_ccb);
1556 * Be sure we stay scheduled if we have more work to do.
1558 if (bioq_first(&softc->bio_queue_rd) ||
1559 bioq_first(&softc->bio_queue_wr)) {
1560 xpt_schedule(periph, 1);
1564 case DA_STATE_PROBE:
1566 struct ccb_scsiio *csio;
1567 struct scsi_read_capacity_data *rcap;
1569 rcap = kmalloc(sizeof(*rcap), M_SCSIDA, M_INTWAIT | M_ZERO);
1570 csio = &start_ccb->csio;
1571 scsi_read_capacity(csio,
1578 start_ccb->ccb_h.ccb_bio = NULL;
1579 start_ccb->ccb_h.ccb_state = DA_CCB_PROBE;
1580 xpt_action(start_ccb);
1583 case DA_STATE_PROBE2:
1585 struct ccb_scsiio *csio;
1586 struct scsi_read_capacity_data_16 *rcaplong;
1588 rcaplong = kmalloc(sizeof(*rcaplong), M_SCSIDA,
1589 M_INTWAIT | M_ZERO);
1590 csio = &start_ccb->csio;
1591 scsi_read_capacity_16(csio,
1594 /*tag_action*/ MSG_SIMPLE_Q_TAG,
1599 /*sense_len*/ SSD_FULL_SIZE,
1601 start_ccb->ccb_h.ccb_bio = NULL;
1602 start_ccb->ccb_h.ccb_state = DA_CCB_PROBE2;
1603 xpt_action(start_ccb);
1610 cmd6workaround(union ccb *ccb)
1612 struct scsi_rw_6 cmd6;
1613 struct scsi_rw_10 *cmd10;
1614 struct da_softc *softc;
1618 cdb = ccb->csio.cdb_io.cdb_bytes;
1620 /* Translation only possible if CDB is an array and cmd is R/W6 */
1621 if ((ccb->ccb_h.flags & CAM_CDB_POINTER) != 0 ||
1622 (*cdb != READ_6 && *cdb != WRITE_6))
1625 xpt_print(ccb->ccb_h.path, "READ(6)/WRITE(6) not supported, "
1626 "increasing minimum_cmd_size to 10.\n");
1627 softc = (struct da_softc *)xpt_path_periph(ccb->ccb_h.path)->softc;
1628 softc->minimum_cmd_size = 10;
1630 bcopy(cdb, &cmd6, sizeof(struct scsi_rw_6));
1631 cmd10 = (struct scsi_rw_10 *)cdb;
1632 cmd10->opcode = (cmd6.opcode == READ_6) ? READ_10 : WRITE_10;
1634 scsi_ulto4b(scsi_3btoul(cmd6.addr), cmd10->addr);
1635 cmd10->reserved = 0;
1636 scsi_ulto2b(cmd6.length, cmd10->length);
1637 cmd10->control = cmd6.control;
1638 ccb->csio.cdb_len = sizeof(*cmd10);
1640 /* Requeue request, unfreezing queue if necessary */
1641 frozen = (ccb->ccb_h.status & CAM_DEV_QFRZN) != 0;
1642 ccb->ccb_h.status = CAM_REQUEUE_REQ;
1645 cam_release_devq(ccb->ccb_h.path,
1649 /*getcount_only*/0);
1655 dadone(struct cam_periph *periph, union ccb *done_ccb)
1657 struct da_softc *softc;
1658 struct ccb_scsiio *csio;
1659 struct disk_info info;
1661 softc = (struct da_softc *)periph->softc;
1662 csio = &done_ccb->csio;
1663 switch (csio->ccb_h.ccb_state & DA_CCB_TYPE_MASK) {
1664 case DA_CCB_BUFFER_IO:
1671 bio = (struct bio *)done_ccb->ccb_h.ccb_bio;
1673 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1677 if ((csio->ccb_h.ccb_state & DA_CCB_RETRY_UA) != 0)
1682 error = daerror(done_ccb, CAM_RETRY_SELTO, sf);
1683 if (error == ERESTART) {
1685 * A retry was scheuled, so
1691 if (error == ENXIO) {
1693 * Catastrophic error. Mark our pack as
1697 * XXX See if this is really a media
1700 xpt_print(periph->path,
1701 "Invalidating pack\n");
1702 softc->flags |= DA_FLAG_PACK_INVALID;
1706 * Return all queued write I/O's with EIO
1707 * so the client can retry these I/Os in the
1708 * proper order should it attempt to recover.
1710 * Leave read I/O's alone.
1712 daflushbioq(&softc->bio_queue_wr, EIO);
1713 bp->b_error = error;
1714 bp->b_resid = bp->b_bcount;
1715 bp->b_flags |= B_ERROR;
1717 bp->b_resid = csio->resid;
1719 if (bp->b_resid != 0)
1720 bp->b_flags |= B_ERROR;
1722 if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
1723 cam_release_devq(done_ccb->ccb_h.path,
1727 /*getcount_only*/0);
1729 if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
1730 panic("REQ_CMP with QFRZN");
1731 bp->b_resid = csio->resid;
1732 if (csio->resid > 0)
1733 bp->b_flags |= B_ERROR;
1737 * Block out any asyncronous callbacks
1738 * while we touch the pending ccb list.
1740 LIST_REMOVE(&done_ccb->ccb_h, periph_links.le);
1741 if (bp->b_cmd == BUF_CMD_WRITE || bp->b_cmd == BUF_CMD_FLUSH) {
1742 --softc->outstanding_cmds_wr;
1743 if (softc->flags & DA_FLAG_WR_LIMIT) {
1744 softc->flags &= ~DA_FLAG_WR_LIMIT;
1748 --softc->outstanding_cmds_rd;
1749 if (softc->flags & DA_FLAG_RD_LIMIT) {
1750 softc->flags &= ~DA_FLAG_RD_LIMIT;
1754 if (softc->outstanding_cmds_rd +
1755 softc->outstanding_cmds_wr == 0) {
1756 softc->flags |= DA_FLAG_WENT_IDLE;
1759 devstat_end_transaction_buf(&softc->device_stats, bp);
1760 if ((csio->ccb_h.ccb_state & DA_CCB_TYPE_MASK) ==
1762 struct trim_request *req =
1763 (struct trim_request *) csio->data_ptr;
1766 for (i = 1; i < softc->trim_max_ranges &&
1767 req->bios[i]; i++) {
1768 struct bio *bp1 = req->bios[i];
1770 bp1->bio_buf->b_resid = bp->b_resid;
1771 bp1->bio_buf->b_error = bp->b_error;
1772 if (bp->b_flags & B_ERROR)
1773 bp1->bio_buf->b_flags |= B_ERROR;
1776 softc->trim_running = 0;
1778 xpt_schedule(periph,1);
1784 xpt_schedule(periph, /*priority*/1);
1791 struct scsi_read_capacity_data *rdcap;
1792 struct scsi_read_capacity_data_16 *rcaplong;
1793 char announce_buf[80];
1797 if (softc->state == DA_STATE_PROBE)
1798 rdcap =(struct scsi_read_capacity_data *)csio->data_ptr;
1800 rcaplong = (struct scsi_read_capacity_data_16 *)
1803 bzero(&info, sizeof(info));
1804 info.d_type = DTYPE_SCSI;
1805 info.d_serialno = xpt_path_serialno(periph->path);
1807 if ((csio->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP) {
1808 struct disk_params *dp;
1809 uint32_t block_size;
1812 if (softc->state == DA_STATE_PROBE) {
1813 block_size = scsi_4btoul(rdcap->length);
1814 maxsector = scsi_4btoul(rdcap->addr);
1817 * According to SBC-2, if the standard 10
1818 * byte READ CAPACITY command returns 2^32,
1819 * we should issue the 16 byte version of
1820 * the command, since the device in question
1821 * has more sectors than can be represented
1822 * with the short version of the command.
1824 if (maxsector == 0xffffffff) {
1825 softc->state = DA_STATE_PROBE2;
1826 kfree(rdcap, M_SCSIDA);
1827 xpt_release_ccb(done_ccb);
1828 xpt_schedule(periph, /*priority*/5);
1832 block_size = scsi_4btoul(rcaplong->length);
1833 maxsector = scsi_8btou64(rcaplong->addr);
1835 dasetgeom(periph, block_size, maxsector);
1836 dp = &softc->params;
1837 ksnprintf(announce_buf, sizeof(announce_buf),
1838 "%juMB (%ju %u byte sectors: %dH %dS/T %dC)",
1839 (uintmax_t) (((uintmax_t)dp->secsize *
1840 dp->sectors) / (1024*1024)),
1841 (uintmax_t)dp->sectors,
1842 dp->secsize, dp->heads, dp->secs_per_track,
1845 CAM_SIM_UNLOCK(periph->sim);
1846 info.d_media_blksize = softc->params.secsize;
1847 info.d_media_blocks = softc->params.sectors;
1848 info.d_media_size = 0;
1849 info.d_secpertrack = softc->params.secs_per_track;
1850 info.d_nheads = softc->params.heads;
1851 info.d_ncylinders = softc->params.cylinders;
1852 info.d_secpercyl = softc->params.heads *
1853 softc->params.secs_per_track;
1854 info.d_serialno = xpt_path_serialno(periph->path);
1855 disk_setdiskinfo(&softc->disk, &info);
1856 CAM_SIM_LOCK(periph->sim);
1860 announce_buf[0] = '\0';
1863 * Retry any UNIT ATTENTION type errors. They
1864 * are expected at boot.
1866 error = daerror(done_ccb, CAM_RETRY_SELTO,
1867 SF_RETRY_UA|SF_NO_PRINT);
1868 if (error == ERESTART) {
1870 * A retry was scheuled, so
1874 } else if (error != 0) {
1875 struct scsi_sense_data *sense;
1877 int sense_key, error_code;
1880 struct ccb_getdev cgd;
1882 /* Don't wedge this device's queue */
1883 status = done_ccb->ccb_h.status;
1884 if ((status & CAM_DEV_QFRZN) != 0)
1885 cam_release_devq(done_ccb->ccb_h.path,
1889 /*getcount_only*/0);
1892 xpt_setup_ccb(&cgd.ccb_h,
1893 done_ccb->ccb_h.path,
1895 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1896 xpt_action((union ccb *)&cgd);
1898 if (((csio->ccb_h.flags & CAM_SENSE_PHYS) != 0)
1899 || ((csio->ccb_h.flags & CAM_SENSE_PTR) != 0)
1900 || ((status & CAM_AUTOSNS_VALID) == 0))
1906 sense = &csio->sense_data;
1907 scsi_extract_sense(sense, &error_code,
1912 * Attach to anything that claims to be a
1913 * direct access or optical disk device,
1914 * as long as it doesn't return a "Logical
1915 * unit not supported" (0x25) error.
1917 if ((have_sense) && (asc != 0x25)
1918 && (error_code == SSD_CURRENT_ERROR)) {
1919 const char *sense_key_desc;
1920 const char *asc_desc;
1922 scsi_sense_desc(sense_key, asc, ascq,
1926 ksnprintf(announce_buf,
1927 sizeof(announce_buf),
1928 "Attempt to query device "
1929 "size failed: %s, %s",
1932 info.d_media_blksize = 512;
1933 disk_setdiskinfo(&softc->disk, &info);
1939 xpt_print(periph->path,
1940 "got CAM status %#x\n",
1941 done_ccb->ccb_h.status);
1944 xpt_print(periph->path, "fatal error, "
1945 "failed to attach to device\n");
1948 * Free up resources.
1950 cam_periph_invalidate(periph);
1954 kfree(csio->data_ptr, M_SCSIDA);
1955 if (announce_buf[0] != '\0') {
1956 xpt_announce_periph(periph, announce_buf);
1958 * Create our sysctl variables, now that we know
1959 * we have successfully attached.
1961 taskqueue_enqueue(taskqueue_thread[mycpuid],
1962 &softc->sysctl_task);
1965 if (softc->trim_max_ranges) {
1966 softc->disk.d_info.d_trimflag |= DA_FLAG_CAN_TRIM;
1967 kprintf("%s%d: supports TRIM\n",
1968 periph->periph_name,
1969 periph->unit_number);
1971 softc->state = DA_STATE_NORMAL;
1973 * Since our peripheral may be invalidated by an error
1974 * above or an external event, we must release our CCB
1975 * before releasing the probe lock on the peripheral.
1976 * The peripheral will only go away once the last lock
1977 * is removed, and we need it around for the CCB release
1980 xpt_release_ccb(done_ccb);
1981 cam_periph_unhold(periph, 0);
1984 case DA_CCB_WAITING:
1986 /* Caller will release the CCB */
1987 wakeup(&done_ccb->ccb_h.cbfcnp);
1991 /* No-op. We're polling */
1996 xpt_release_ccb(done_ccb);
2000 daerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
2002 struct da_softc *softc;
2003 struct cam_periph *periph;
2006 periph = xpt_path_periph(ccb->ccb_h.path);
2007 softc = (struct da_softc *)periph->softc;
2010 * Automatically detect devices that do not support
2011 * READ(6)/WRITE(6) and upgrade to using 10 byte cdbs.
2014 if ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INVALID) {
2015 error = cmd6workaround(ccb);
2016 } else if (((ccb->ccb_h.status & CAM_STATUS_MASK) ==
2017 CAM_SCSI_STATUS_ERROR)
2018 && (ccb->ccb_h.status & CAM_AUTOSNS_VALID)
2019 && (ccb->csio.scsi_status == SCSI_STATUS_CHECK_COND)
2020 && ((ccb->ccb_h.flags & CAM_SENSE_PHYS) == 0)
2021 && ((ccb->ccb_h.flags & CAM_SENSE_PTR) == 0)) {
2022 int sense_key, error_code, asc, ascq;
2024 scsi_extract_sense(&ccb->csio.sense_data,
2025 &error_code, &sense_key, &asc, &ascq);
2026 if (sense_key == SSD_KEY_ILLEGAL_REQUEST)
2027 error = cmd6workaround(ccb);
2029 if (error == ERESTART)
2034 * Until we have a better way of doing pack validation,
2035 * don't treat UAs as errors.
2037 sense_flags |= SF_RETRY_UA;
2038 return(cam_periph_error(ccb, cam_flags, sense_flags,
2039 &softc->saved_ccb));
2043 daprevent(struct cam_periph *periph, int action)
2045 struct da_softc *softc;
2049 softc = (struct da_softc *)periph->softc;
2051 if (((action == PR_ALLOW)
2052 && (softc->flags & DA_FLAG_PACK_LOCKED) == 0)
2053 || ((action == PR_PREVENT)
2054 && (softc->flags & DA_FLAG_PACK_LOCKED) != 0)) {
2058 ccb = cam_periph_getccb(periph, /*priority*/1);
2060 scsi_prevent(&ccb->csio,
2068 error = cam_periph_runccb(ccb, /*error_routine*/NULL, CAM_RETRY_SELTO,
2069 SF_RETRY_UA, &softc->device_stats);
2072 if (action == PR_ALLOW)
2073 softc->flags &= ~DA_FLAG_PACK_LOCKED;
2075 softc->flags |= DA_FLAG_PACK_LOCKED;
2078 xpt_release_ccb(ccb);
2082 * Check media on open, e.g. card reader devices which had no initial media.
2085 dacheckmedia(struct cam_periph *periph)
2087 struct disk_params *dp;
2088 struct da_softc *softc;
2089 struct disk_info info;
2092 softc = (struct da_softc *)periph->softc;
2093 dp = &softc->params;
2095 error = dagetcapacity(periph);
2098 * Only reprobe on initial open and if the media is removable.
2100 * NOTE: If we setdiskinfo() it will take the device probe
2101 * a bit of time to probe the slices and partitions,
2102 * and mess up booting. So avoid if nothing has changed.
2105 if (softc->flags & DA_FLAG_OPEN)
2107 if ((softc->flags & DA_FLAG_PACK_REMOVABLE) == 0)
2110 bzero(&info, sizeof(info));
2111 info.d_type = DTYPE_SCSI;
2112 info.d_serialno = xpt_path_serialno(periph->path);
2115 CAM_SIM_UNLOCK(periph->sim);
2116 info.d_media_blksize = softc->params.secsize;
2117 info.d_media_blocks = softc->params.sectors;
2118 info.d_media_size = 0;
2119 info.d_secpertrack = softc->params.secs_per_track;
2120 info.d_nheads = softc->params.heads;
2121 info.d_ncylinders = softc->params.cylinders;
2122 info.d_secpercyl = softc->params.heads *
2123 softc->params.secs_per_track;
2124 info.d_serialno = xpt_path_serialno(periph->path);
2125 if (info.d_media_blocks != softc->disk.d_info.d_media_blocks) {
2126 kprintf("%s%d: open removable media: "
2127 "%juMB (%ju %u byte sectors: %dH %dS/T %dC)\n",
2128 periph->periph_name, periph->unit_number,
2129 (uintmax_t)(((uintmax_t)dp->secsize *
2130 dp->sectors) / (1024*1024)),
2131 (uintmax_t)dp->sectors, dp->secsize,
2132 dp->heads, dp->secs_per_track, dp->cylinders);
2133 disk_setdiskinfo(&softc->disk, &info);
2135 CAM_SIM_LOCK(periph->sim);
2137 kprintf("%s%d: open removable media: no media present\n",
2138 periph->periph_name, periph->unit_number);
2139 info.d_media_blksize = 512;
2140 disk_setdiskinfo(&softc->disk, &info);
2146 dagetcapacity(struct cam_periph *periph)
2148 struct da_softc *softc;
2150 struct scsi_read_capacity_data *rcap;
2151 struct scsi_read_capacity_data_16 *rcaplong;
2156 softc = (struct da_softc *)periph->softc;
2161 /* Do a read capacity */
2162 rcap = (struct scsi_read_capacity_data *)kmalloc(sizeof(*rcaplong),
2163 M_SCSIDA, M_INTWAIT);
2165 ccb = cam_periph_getccb(periph, /*priority*/1);
2166 scsi_read_capacity(&ccb->csio,
2173 ccb->ccb_h.ccb_bio = NULL;
2175 error = cam_periph_runccb(ccb, daerror,
2176 /*cam_flags*/CAM_RETRY_SELTO,
2177 /*sense_flags*/SF_RETRY_UA,
2178 &softc->device_stats);
2180 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
2181 cam_release_devq(ccb->ccb_h.path,
2185 /*getcount_only*/0);
2188 block_len = scsi_4btoul(rcap->length);
2189 maxsector = scsi_4btoul(rcap->addr);
2191 if (maxsector != 0xffffffff)
2196 rcaplong = (struct scsi_read_capacity_data_16 *)rcap;
2198 scsi_read_capacity_16(&ccb->csio,
2201 /*tag_action*/ MSG_SIMPLE_Q_TAG,
2206 /*sense_len*/ SSD_FULL_SIZE,
2208 ccb->ccb_h.ccb_bio = NULL;
2210 error = cam_periph_runccb(ccb, daerror,
2211 /*cam_flags*/CAM_RETRY_SELTO,
2212 /*sense_flags*/SF_RETRY_UA,
2213 &softc->device_stats);
2215 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
2216 cam_release_devq(ccb->ccb_h.path,
2220 /*getcount_only*/0);
2223 block_len = scsi_4btoul(rcaplong->length);
2224 maxsector = scsi_8btou64(rcaplong->addr);
2230 dasetgeom(periph, block_len, maxsector);
2232 xpt_release_ccb(ccb);
2234 kfree(rcap, M_SCSIDA);
2240 dasetgeom(struct cam_periph *periph, uint32_t block_len, uint64_t maxsector)
2242 struct ccb_calc_geometry ccg;
2243 struct da_softc *softc;
2244 struct disk_params *dp;
2246 softc = (struct da_softc *)periph->softc;
2248 dp = &softc->params;
2249 dp->secsize = block_len;
2250 dp->sectors = maxsector + 1;
2252 * Have the controller provide us with a geometry
2253 * for this disk. The only time the geometry
2254 * matters is when we boot and the controller
2255 * is the only one knowledgeable enough to come
2256 * up with something that will make this a bootable
2259 xpt_setup_ccb(&ccg.ccb_h, periph->path, /*priority*/1);
2260 ccg.ccb_h.func_code = XPT_CALC_GEOMETRY;
2261 ccg.block_size = dp->secsize;
2262 ccg.volume_size = dp->sectors;
2264 ccg.secs_per_track = 0;
2266 xpt_action((union ccb*)&ccg);
2267 if ((ccg.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
2269 * We don't know what went wrong here- but just pick
2270 * a geometry so we don't have nasty things like divide
2274 dp->secs_per_track = 255;
2275 dp->cylinders = dp->sectors / (255 * 255);
2276 if (dp->cylinders == 0) {
2280 dp->heads = ccg.heads;
2281 dp->secs_per_track = ccg.secs_per_track;
2282 dp->cylinders = ccg.cylinders;
2287 dasendorderedtag(void *arg)
2289 struct da_softc *softc = arg;
2291 if (da_send_ordered) {
2292 if ((softc->ordered_tag_count == 0)
2293 && ((softc->flags & DA_FLAG_WENT_IDLE) == 0)) {
2294 softc->flags |= DA_FLAG_NEED_OTAG;
2296 if (softc->outstanding_cmds_rd || softc->outstanding_cmds_wr)
2297 softc->flags &= ~DA_FLAG_WENT_IDLE;
2299 softc->ordered_tag_count = 0;
2301 /* Queue us up again */
2302 callout_reset(&softc->sendordered_c,
2303 (DA_DEFAULT_TIMEOUT * hz) / DA_ORDEREDTAG_INTERVAL,
2304 dasendorderedtag, softc);
2308 * Step through all DA peripheral drivers, and if the device is still open,
2309 * sync the disk cache to physical media.
2312 dashutdown(void * arg, int howto)
2314 struct cam_periph *periph;
2315 struct da_softc *softc;
2317 TAILQ_FOREACH(periph, &dadriver.units, unit_links) {
2320 cam_periph_lock(periph);
2321 softc = (struct da_softc *)periph->softc;
2324 * We only sync the cache if the drive is still open, and
2325 * if the drive is capable of it..
2327 if (((softc->flags & DA_FLAG_OPEN) == 0)
2328 || (softc->quirks & DA_Q_NO_SYNC_CACHE)) {
2329 cam_periph_unlock(periph);
2333 xpt_setup_ccb(&ccb.ccb_h, periph->path, /*priority*/1);
2335 ccb.ccb_h.ccb_state = DA_CCB_DUMP;
2336 scsi_synchronize_cache(&ccb.csio,
2340 /*begin_lba*/0, /* whole disk */
2345 xpt_polled_action(&ccb);
2347 if ((ccb.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
2348 if (((ccb.ccb_h.status & CAM_STATUS_MASK) ==
2349 CAM_SCSI_STATUS_ERROR)
2350 && (ccb.csio.scsi_status == SCSI_STATUS_CHECK_COND)){
2351 int error_code, sense_key, asc, ascq;
2353 scsi_extract_sense(&ccb.csio.sense_data,
2354 &error_code, &sense_key,
2357 if (sense_key != SSD_KEY_ILLEGAL_REQUEST)
2358 scsi_sense_print(&ccb.csio);
2360 xpt_print(periph->path, "Synchronize "
2361 "cache failed, status == 0x%x, scsi status "
2362 "== 0x%x\n", ccb.ccb_h.status,
2363 ccb.csio.scsi_status);
2367 if ((ccb.ccb_h.status & CAM_DEV_QFRZN) != 0)
2368 cam_release_devq(ccb.ccb_h.path,
2372 /*getcount_only*/0);
2374 cam_periph_unlock(periph);
2378 #else /* !_KERNEL */
2381 * XXX This is only left out of the kernel build to silence warnings. If,
2382 * for some reason this function is used in the kernel, the ifdefs should
2383 * be moved so it is included both in the kernel and userland.
2386 scsi_format_unit(struct ccb_scsiio *csio, u_int32_t retries,
2387 void (*cbfcnp)(struct cam_periph *, union ccb *),
2388 u_int8_t tag_action, u_int8_t byte2, u_int16_t ileave,
2389 u_int8_t *data_ptr, u_int32_t dxfer_len, u_int8_t sense_len,
2392 struct scsi_format_unit *scsi_cmd;
2394 scsi_cmd = (struct scsi_format_unit *)&csio->cdb_io.cdb_bytes;
2395 scsi_cmd->opcode = FORMAT_UNIT;
2396 scsi_cmd->byte2 = byte2;
2397 scsi_ulto2b(ileave, scsi_cmd->interleave);
2402 /*flags*/ (dxfer_len > 0) ? CAM_DIR_OUT : CAM_DIR_NONE,
2411 #endif /* _KERNEL */