2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2012, Bryan Venteicher <bryanv@FreeBSD.org>
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 unmodified, this list of conditions, and the following
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 /* Driver for VirtIO SCSI devices. */
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/kthread.h>
38 #include <sys/malloc.h>
39 #include <sys/module.h>
40 #include <sys/sglist.h>
41 #include <sys/sysctl.h>
43 #include <sys/mutex.h>
44 #include <sys/callout.h>
45 #include <sys/queue.h>
48 #include <machine/stdarg.h>
50 #include <machine/bus.h>
51 #include <machine/resource.h>
56 #include <cam/cam_ccb.h>
57 #include <cam/cam_sim.h>
58 #include <cam/cam_periph.h>
59 #include <cam/cam_xpt_sim.h>
60 #include <cam/cam_debug.h>
61 #include <cam/scsi/scsi_all.h>
62 #include <cam/scsi/scsi_message.h>
64 #include <dev/virtio/virtio.h>
65 #include <dev/virtio/virtqueue.h>
66 #include <dev/virtio/scsi/virtio_scsi.h>
67 #include <dev/virtio/scsi/virtio_scsivar.h>
69 #include "virtio_if.h"
71 static int vtscsi_modevent(module_t, int, void *);
73 static int vtscsi_probe(device_t);
74 static int vtscsi_attach(device_t);
75 static int vtscsi_detach(device_t);
76 static int vtscsi_suspend(device_t);
77 static int vtscsi_resume(device_t);
79 static void vtscsi_negotiate_features(struct vtscsi_softc *);
80 static void vtscsi_read_config(struct vtscsi_softc *,
81 struct virtio_scsi_config *);
82 static int vtscsi_maximum_segments(struct vtscsi_softc *, int);
83 static int vtscsi_alloc_virtqueues(struct vtscsi_softc *);
84 static void vtscsi_write_device_config(struct vtscsi_softc *);
85 static int vtscsi_reinit(struct vtscsi_softc *);
87 static int vtscsi_alloc_cam(struct vtscsi_softc *);
88 static int vtscsi_register_cam(struct vtscsi_softc *);
89 static void vtscsi_free_cam(struct vtscsi_softc *);
90 static void vtscsi_cam_async(void *, uint32_t, struct cam_path *, void *);
91 static int vtscsi_register_async(struct vtscsi_softc *);
92 static void vtscsi_deregister_async(struct vtscsi_softc *);
93 static void vtscsi_cam_action(struct cam_sim *, union ccb *);
94 static void vtscsi_cam_poll(struct cam_sim *);
96 static void vtscsi_cam_scsi_io(struct vtscsi_softc *, struct cam_sim *,
98 static void vtscsi_cam_get_tran_settings(struct vtscsi_softc *,
100 static void vtscsi_cam_reset_bus(struct vtscsi_softc *, union ccb *);
101 static void vtscsi_cam_reset_dev(struct vtscsi_softc *, union ccb *);
102 static void vtscsi_cam_abort(struct vtscsi_softc *, union ccb *);
103 static void vtscsi_cam_path_inquiry(struct vtscsi_softc *,
104 struct cam_sim *, union ccb *);
106 static int vtscsi_sg_append_scsi_buf(struct vtscsi_softc *,
107 struct sglist *, struct ccb_scsiio *);
108 static int vtscsi_fill_scsi_cmd_sglist(struct vtscsi_softc *,
109 struct vtscsi_request *, int *, int *);
110 static int vtscsi_execute_scsi_cmd(struct vtscsi_softc *,
111 struct vtscsi_request *);
112 static int vtscsi_start_scsi_cmd(struct vtscsi_softc *, union ccb *);
113 static void vtscsi_complete_abort_timedout_scsi_cmd(struct vtscsi_softc *,
114 struct vtscsi_request *);
115 static int vtscsi_abort_timedout_scsi_cmd(struct vtscsi_softc *,
116 struct vtscsi_request *);
117 static void vtscsi_timedout_scsi_cmd(void *);
118 static cam_status vtscsi_scsi_cmd_cam_status(struct virtio_scsi_cmd_resp *);
119 static cam_status vtscsi_complete_scsi_cmd_response(struct vtscsi_softc *,
120 struct ccb_scsiio *, struct virtio_scsi_cmd_resp *);
121 static void vtscsi_complete_scsi_cmd(struct vtscsi_softc *,
122 struct vtscsi_request *);
124 static void vtscsi_poll_ctrl_req(struct vtscsi_softc *,
125 struct vtscsi_request *);
126 static int vtscsi_execute_ctrl_req(struct vtscsi_softc *,
127 struct vtscsi_request *, struct sglist *, int, int, int);
128 static void vtscsi_complete_abort_task_cmd(struct vtscsi_softc *c,
129 struct vtscsi_request *);
130 static int vtscsi_execute_abort_task_cmd(struct vtscsi_softc *,
131 struct vtscsi_request *);
132 static int vtscsi_execute_reset_dev_cmd(struct vtscsi_softc *,
133 struct vtscsi_request *);
135 static void vtscsi_get_request_lun(uint8_t [], target_id_t *, lun_id_t *);
136 static void vtscsi_set_request_lun(struct ccb_hdr *, uint8_t []);
137 static void vtscsi_init_scsi_cmd_req(struct ccb_scsiio *,
138 struct virtio_scsi_cmd_req *);
139 static void vtscsi_init_ctrl_tmf_req(struct ccb_hdr *, uint32_t,
140 uintptr_t, struct virtio_scsi_ctrl_tmf_req *);
142 static void vtscsi_freeze_simq(struct vtscsi_softc *, int);
143 static int vtscsi_thaw_simq(struct vtscsi_softc *, int);
145 static void vtscsi_announce(struct vtscsi_softc *, uint32_t, target_id_t,
147 static void vtscsi_execute_rescan(struct vtscsi_softc *, target_id_t,
149 static void vtscsi_execute_rescan_bus(struct vtscsi_softc *);
151 static void vtscsi_handle_event(struct vtscsi_softc *,
152 struct virtio_scsi_event *);
153 static int vtscsi_enqueue_event_buf(struct vtscsi_softc *,
154 struct virtio_scsi_event *);
155 static int vtscsi_init_event_vq(struct vtscsi_softc *);
156 static void vtscsi_reinit_event_vq(struct vtscsi_softc *);
157 static void vtscsi_drain_event_vq(struct vtscsi_softc *);
159 static void vtscsi_complete_vqs_locked(struct vtscsi_softc *);
160 static void vtscsi_complete_vqs(struct vtscsi_softc *);
161 static void vtscsi_drain_vqs(struct vtscsi_softc *);
162 static void vtscsi_cancel_request(struct vtscsi_softc *,
163 struct vtscsi_request *);
164 static void vtscsi_drain_vq(struct vtscsi_softc *, struct virtqueue *);
165 static void vtscsi_stop(struct vtscsi_softc *);
166 static int vtscsi_reset_bus(struct vtscsi_softc *);
168 static void vtscsi_init_request(struct vtscsi_softc *,
169 struct vtscsi_request *);
170 static int vtscsi_alloc_requests(struct vtscsi_softc *);
171 static void vtscsi_free_requests(struct vtscsi_softc *);
172 static void vtscsi_enqueue_request(struct vtscsi_softc *,
173 struct vtscsi_request *);
174 static struct vtscsi_request * vtscsi_dequeue_request(struct vtscsi_softc *);
176 static void vtscsi_complete_request(struct vtscsi_request *);
177 static void vtscsi_complete_vq(struct vtscsi_softc *, struct virtqueue *);
179 static void vtscsi_control_vq_intr(void *);
180 static void vtscsi_event_vq_intr(void *);
181 static void vtscsi_request_vq_intr(void *);
182 static void vtscsi_disable_vqs_intr(struct vtscsi_softc *);
183 static void vtscsi_enable_vqs_intr(struct vtscsi_softc *);
185 static void vtscsi_get_tunables(struct vtscsi_softc *);
186 static void vtscsi_add_sysctl(struct vtscsi_softc *);
188 static void vtscsi_printf_req(struct vtscsi_request *, const char *,
191 /* Global tunables. */
193 * The current QEMU VirtIO SCSI implementation does not cancel in-flight
194 * IO during virtio_stop(). So in-flight requests still complete after the
195 * device reset. We would have to wait for all the in-flight IO to complete,
196 * which defeats the typical purpose of a bus reset. We could simulate the
197 * bus reset with either I_T_NEXUS_RESET of all the targets, or with
198 * LOGICAL_UNIT_RESET of all the LUNs (assuming there is space in the
199 * control virtqueue). But this isn't very useful if things really go off
200 * the rails, so default to disabled for now.
202 static int vtscsi_bus_reset_disable = 1;
203 TUNABLE_INT("hw.vtscsi.bus_reset_disable", &vtscsi_bus_reset_disable);
205 static struct virtio_feature_desc vtscsi_feature_desc[] = {
206 { VIRTIO_SCSI_F_INOUT, "InOut" },
207 { VIRTIO_SCSI_F_HOTPLUG, "Hotplug" },
212 static device_method_t vtscsi_methods[] = {
213 /* Device methods. */
214 DEVMETHOD(device_probe, vtscsi_probe),
215 DEVMETHOD(device_attach, vtscsi_attach),
216 DEVMETHOD(device_detach, vtscsi_detach),
217 DEVMETHOD(device_suspend, vtscsi_suspend),
218 DEVMETHOD(device_resume, vtscsi_resume),
223 static driver_t vtscsi_driver = {
226 sizeof(struct vtscsi_softc)
228 static devclass_t vtscsi_devclass;
230 DRIVER_MODULE(virtio_scsi, virtio_pci, vtscsi_driver, vtscsi_devclass,
232 MODULE_VERSION(virtio_scsi, 1);
233 MODULE_DEPEND(virtio_scsi, virtio, 1, 1, 1);
234 MODULE_DEPEND(virtio_scsi, cam, 1, 1, 1);
237 vtscsi_modevent(module_t mod, int type, void *unused)
257 vtscsi_probe(device_t dev)
260 if (virtio_get_device_type(dev) != VIRTIO_ID_SCSI)
263 device_set_desc(dev, "VirtIO SCSI Adapter");
265 return (BUS_PROBE_DEFAULT);
269 vtscsi_attach(device_t dev)
271 struct vtscsi_softc *sc;
272 struct virtio_scsi_config scsicfg;
275 sc = device_get_softc(dev);
276 sc->vtscsi_dev = dev;
278 VTSCSI_LOCK_INIT(sc, device_get_nameunit(dev));
279 TAILQ_INIT(&sc->vtscsi_req_free);
281 vtscsi_get_tunables(sc);
282 vtscsi_add_sysctl(sc);
284 virtio_set_feature_desc(dev, vtscsi_feature_desc);
285 vtscsi_negotiate_features(sc);
287 if (virtio_with_feature(dev, VIRTIO_RING_F_INDIRECT_DESC))
288 sc->vtscsi_flags |= VTSCSI_FLAG_INDIRECT;
289 if (virtio_with_feature(dev, VIRTIO_SCSI_F_INOUT))
290 sc->vtscsi_flags |= VTSCSI_FLAG_BIDIRECTIONAL;
291 if (virtio_with_feature(dev, VIRTIO_SCSI_F_HOTPLUG))
292 sc->vtscsi_flags |= VTSCSI_FLAG_HOTPLUG;
294 vtscsi_read_config(sc, &scsicfg);
296 sc->vtscsi_max_channel = scsicfg.max_channel;
297 sc->vtscsi_max_target = scsicfg.max_target;
298 sc->vtscsi_max_lun = scsicfg.max_lun;
299 sc->vtscsi_event_buf_size = scsicfg.event_info_size;
301 vtscsi_write_device_config(sc);
303 sc->vtscsi_max_nsegs = vtscsi_maximum_segments(sc, scsicfg.seg_max);
304 sc->vtscsi_sglist = sglist_alloc(sc->vtscsi_max_nsegs, M_NOWAIT);
305 if (sc->vtscsi_sglist == NULL) {
307 device_printf(dev, "cannot allocate sglist\n");
311 error = vtscsi_alloc_virtqueues(sc);
313 device_printf(dev, "cannot allocate virtqueues\n");
317 error = vtscsi_init_event_vq(sc);
319 device_printf(dev, "cannot populate the eventvq\n");
323 error = vtscsi_alloc_requests(sc);
325 device_printf(dev, "cannot allocate requests\n");
329 error = vtscsi_alloc_cam(sc);
331 device_printf(dev, "cannot allocate CAM structures\n");
335 error = virtio_setup_intr(dev, INTR_TYPE_CAM);
337 device_printf(dev, "cannot setup virtqueue interrupts\n");
341 vtscsi_enable_vqs_intr(sc);
344 * Register with CAM after interrupts are enabled so we will get
345 * notified of the probe responses.
347 error = vtscsi_register_cam(sc);
349 device_printf(dev, "cannot register with CAM\n");
361 vtscsi_detach(device_t dev)
363 struct vtscsi_softc *sc;
365 sc = device_get_softc(dev);
368 sc->vtscsi_flags |= VTSCSI_FLAG_DETACH;
369 if (device_is_attached(dev))
373 vtscsi_complete_vqs(sc);
374 vtscsi_drain_vqs(sc);
377 vtscsi_free_requests(sc);
379 if (sc->vtscsi_sglist != NULL) {
380 sglist_free(sc->vtscsi_sglist);
381 sc->vtscsi_sglist = NULL;
384 VTSCSI_LOCK_DESTROY(sc);
390 vtscsi_suspend(device_t dev)
397 vtscsi_resume(device_t dev)
404 vtscsi_negotiate_features(struct vtscsi_softc *sc)
409 dev = sc->vtscsi_dev;
410 features = virtio_negotiate_features(dev, VTSCSI_FEATURES);
411 sc->vtscsi_features = features;
414 #define VTSCSI_GET_CONFIG(_dev, _field, _cfg) \
415 virtio_read_device_config(_dev, \
416 offsetof(struct virtio_scsi_config, _field), \
417 &(_cfg)->_field, sizeof((_cfg)->_field)) \
420 vtscsi_read_config(struct vtscsi_softc *sc,
421 struct virtio_scsi_config *scsicfg)
425 dev = sc->vtscsi_dev;
427 bzero(scsicfg, sizeof(struct virtio_scsi_config));
429 VTSCSI_GET_CONFIG(dev, num_queues, scsicfg);
430 VTSCSI_GET_CONFIG(dev, seg_max, scsicfg);
431 VTSCSI_GET_CONFIG(dev, max_sectors, scsicfg);
432 VTSCSI_GET_CONFIG(dev, cmd_per_lun, scsicfg);
433 VTSCSI_GET_CONFIG(dev, event_info_size, scsicfg);
434 VTSCSI_GET_CONFIG(dev, sense_size, scsicfg);
435 VTSCSI_GET_CONFIG(dev, cdb_size, scsicfg);
436 VTSCSI_GET_CONFIG(dev, max_channel, scsicfg);
437 VTSCSI_GET_CONFIG(dev, max_target, scsicfg);
438 VTSCSI_GET_CONFIG(dev, max_lun, scsicfg);
441 #undef VTSCSI_GET_CONFIG
444 vtscsi_maximum_segments(struct vtscsi_softc *sc, int seg_max)
448 nsegs = VTSCSI_MIN_SEGMENTS;
451 nsegs += MIN(seg_max, MAXPHYS / PAGE_SIZE + 1);
452 if (sc->vtscsi_flags & VTSCSI_FLAG_INDIRECT)
453 nsegs = MIN(nsegs, VIRTIO_MAX_INDIRECT);
461 vtscsi_alloc_virtqueues(struct vtscsi_softc *sc)
464 struct vq_alloc_info vq_info[3];
467 dev = sc->vtscsi_dev;
470 VQ_ALLOC_INFO_INIT(&vq_info[0], 0, vtscsi_control_vq_intr, sc,
471 &sc->vtscsi_control_vq, "%s control", device_get_nameunit(dev));
473 VQ_ALLOC_INFO_INIT(&vq_info[1], 0, vtscsi_event_vq_intr, sc,
474 &sc->vtscsi_event_vq, "%s event", device_get_nameunit(dev));
476 VQ_ALLOC_INFO_INIT(&vq_info[2], sc->vtscsi_max_nsegs,
477 vtscsi_request_vq_intr, sc, &sc->vtscsi_request_vq,
478 "%s request", device_get_nameunit(dev));
480 return (virtio_alloc_virtqueues(dev, 0, nvqs, vq_info));
484 vtscsi_write_device_config(struct vtscsi_softc *sc)
487 virtio_write_dev_config_4(sc->vtscsi_dev,
488 offsetof(struct virtio_scsi_config, sense_size),
489 VIRTIO_SCSI_SENSE_SIZE);
492 * This is the size in the virtio_scsi_cmd_req structure. Note
493 * this value (32) is larger than the maximum CAM CDB size (16).
495 virtio_write_dev_config_4(sc->vtscsi_dev,
496 offsetof(struct virtio_scsi_config, cdb_size),
497 VIRTIO_SCSI_CDB_SIZE);
501 vtscsi_reinit(struct vtscsi_softc *sc)
506 dev = sc->vtscsi_dev;
508 error = virtio_reinit(dev, sc->vtscsi_features);
510 vtscsi_write_device_config(sc);
511 vtscsi_reinit_event_vq(sc);
512 virtio_reinit_complete(dev);
514 vtscsi_enable_vqs_intr(sc);
517 vtscsi_dprintf(sc, VTSCSI_TRACE, "error=%d\n", error);
523 vtscsi_alloc_cam(struct vtscsi_softc *sc)
526 struct cam_devq *devq;
529 dev = sc->vtscsi_dev;
530 openings = sc->vtscsi_nrequests - VTSCSI_RESERVED_REQUESTS;
532 devq = cam_simq_alloc(openings);
534 device_printf(dev, "cannot allocate SIM queue\n");
538 sc->vtscsi_sim = cam_sim_alloc(vtscsi_cam_action, vtscsi_cam_poll,
539 "vtscsi", sc, device_get_unit(dev), VTSCSI_MTX(sc), 1,
541 if (sc->vtscsi_sim == NULL) {
543 device_printf(dev, "cannot allocate SIM\n");
551 vtscsi_register_cam(struct vtscsi_softc *sc)
554 int registered, error;
556 dev = sc->vtscsi_dev;
561 if (xpt_bus_register(sc->vtscsi_sim, dev, 0) != CAM_SUCCESS) {
563 device_printf(dev, "cannot register XPT bus\n");
569 if (xpt_create_path(&sc->vtscsi_path, NULL,
570 cam_sim_path(sc->vtscsi_sim), CAM_TARGET_WILDCARD,
571 CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
573 device_printf(dev, "cannot create bus path\n");
577 if (vtscsi_register_async(sc) != CAM_REQ_CMP) {
579 device_printf(dev, "cannot register async callback\n");
588 if (sc->vtscsi_path != NULL) {
589 xpt_free_path(sc->vtscsi_path);
590 sc->vtscsi_path = NULL;
594 xpt_bus_deregister(cam_sim_path(sc->vtscsi_sim));
602 vtscsi_free_cam(struct vtscsi_softc *sc)
607 if (sc->vtscsi_path != NULL) {
608 vtscsi_deregister_async(sc);
610 xpt_free_path(sc->vtscsi_path);
611 sc->vtscsi_path = NULL;
613 xpt_bus_deregister(cam_sim_path(sc->vtscsi_sim));
616 if (sc->vtscsi_sim != NULL) {
617 cam_sim_free(sc->vtscsi_sim, 1);
618 sc->vtscsi_sim = NULL;
625 vtscsi_cam_async(void *cb_arg, uint32_t code, struct cam_path *path, void *arg)
628 struct vtscsi_softc *sc;
631 sc = cam_sim_softc(sim);
633 vtscsi_dprintf(sc, VTSCSI_TRACE, "code=%u\n", code);
636 * TODO Once QEMU supports event reporting, we should
637 * (un)subscribe to events here.
640 case AC_FOUND_DEVICE:
648 vtscsi_register_async(struct vtscsi_softc *sc)
650 struct ccb_setasync csa;
652 xpt_setup_ccb(&csa.ccb_h, sc->vtscsi_path, 5);
653 csa.ccb_h.func_code = XPT_SASYNC_CB;
654 csa.event_enable = AC_LOST_DEVICE | AC_FOUND_DEVICE;
655 csa.callback = vtscsi_cam_async;
656 csa.callback_arg = sc->vtscsi_sim;
658 xpt_action((union ccb *) &csa);
660 return (csa.ccb_h.status);
664 vtscsi_deregister_async(struct vtscsi_softc *sc)
666 struct ccb_setasync csa;
668 xpt_setup_ccb(&csa.ccb_h, sc->vtscsi_path, 5);
669 csa.ccb_h.func_code = XPT_SASYNC_CB;
670 csa.event_enable = 0;
671 csa.callback = vtscsi_cam_async;
672 csa.callback_arg = sc->vtscsi_sim;
674 xpt_action((union ccb *) &csa);
678 vtscsi_cam_action(struct cam_sim *sim, union ccb *ccb)
680 struct vtscsi_softc *sc;
681 struct ccb_hdr *ccbh;
683 sc = cam_sim_softc(sim);
686 VTSCSI_LOCK_OWNED(sc);
688 if (sc->vtscsi_flags & VTSCSI_FLAG_DETACH) {
690 * The VTSCSI_MTX is briefly dropped between setting
691 * VTSCSI_FLAG_DETACH and deregistering with CAM, so
692 * drop any CCBs that come in during that window.
694 ccbh->status = CAM_NO_HBA;
699 switch (ccbh->func_code) {
701 vtscsi_cam_scsi_io(sc, sim, ccb);
704 case XPT_SET_TRAN_SETTINGS:
705 ccbh->status = CAM_FUNC_NOTAVAIL;
709 case XPT_GET_TRAN_SETTINGS:
710 vtscsi_cam_get_tran_settings(sc, ccb);
714 vtscsi_cam_reset_bus(sc, ccb);
718 vtscsi_cam_reset_dev(sc, ccb);
722 vtscsi_cam_abort(sc, ccb);
725 case XPT_CALC_GEOMETRY:
726 cam_calc_geometry(&ccb->ccg, 1);
731 vtscsi_cam_path_inquiry(sc, sim, ccb);
735 vtscsi_dprintf(sc, VTSCSI_ERROR,
736 "invalid ccb=%p func=%#x\n", ccb, ccbh->func_code);
738 ccbh->status = CAM_REQ_INVALID;
745 vtscsi_cam_poll(struct cam_sim *sim)
747 struct vtscsi_softc *sc;
749 sc = cam_sim_softc(sim);
751 vtscsi_complete_vqs_locked(sc);
755 vtscsi_cam_scsi_io(struct vtscsi_softc *sc, struct cam_sim *sim,
758 struct ccb_hdr *ccbh;
759 struct ccb_scsiio *csio;
765 if (csio->cdb_len > VIRTIO_SCSI_CDB_SIZE) {
767 ccbh->status = CAM_REQ_INVALID;
771 if ((ccbh->flags & CAM_DIR_MASK) == CAM_DIR_BOTH &&
772 (sc->vtscsi_flags & VTSCSI_FLAG_BIDIRECTIONAL) == 0) {
774 ccbh->status = CAM_REQ_INVALID;
778 error = vtscsi_start_scsi_cmd(sc, ccb);
782 vtscsi_dprintf(sc, VTSCSI_ERROR,
783 "error=%d ccb=%p status=%#x\n", error, ccb, ccbh->status);
789 vtscsi_cam_get_tran_settings(struct vtscsi_softc *sc, union ccb *ccb)
791 struct ccb_trans_settings *cts;
792 struct ccb_trans_settings_scsi *scsi;
795 scsi = &cts->proto_specific.scsi;
797 cts->protocol = PROTO_SCSI;
798 cts->protocol_version = SCSI_REV_SPC3;
799 cts->transport = XPORT_SAS;
800 cts->transport_version = 0;
802 scsi->valid = CTS_SCSI_VALID_TQ;
803 scsi->flags = CTS_SCSI_FLAGS_TAG_ENB;
805 ccb->ccb_h.status = CAM_REQ_CMP;
810 vtscsi_cam_reset_bus(struct vtscsi_softc *sc, union ccb *ccb)
814 error = vtscsi_reset_bus(sc);
816 ccb->ccb_h.status = CAM_REQ_CMP;
818 ccb->ccb_h.status = CAM_REQ_CMP_ERR;
820 vtscsi_dprintf(sc, VTSCSI_TRACE, "error=%d ccb=%p status=%#x\n",
821 error, ccb, ccb->ccb_h.status);
827 vtscsi_cam_reset_dev(struct vtscsi_softc *sc, union ccb *ccb)
829 struct ccb_hdr *ccbh;
830 struct vtscsi_request *req;
835 req = vtscsi_dequeue_request(sc);
838 vtscsi_freeze_simq(sc, VTSCSI_REQUEST);
844 error = vtscsi_execute_reset_dev_cmd(sc, req);
848 vtscsi_enqueue_request(sc, req);
851 vtscsi_dprintf(sc, VTSCSI_ERROR, "error=%d req=%p ccb=%p\n",
855 ccbh->status = CAM_RESRC_UNAVAIL;
857 ccbh->status = CAM_REQ_CMP_ERR;
863 vtscsi_cam_abort(struct vtscsi_softc *sc, union ccb *ccb)
865 struct vtscsi_request *req;
866 struct ccb_hdr *ccbh;
871 req = vtscsi_dequeue_request(sc);
874 vtscsi_freeze_simq(sc, VTSCSI_REQUEST);
880 error = vtscsi_execute_abort_task_cmd(sc, req);
884 vtscsi_enqueue_request(sc, req);
887 vtscsi_dprintf(sc, VTSCSI_ERROR, "error=%d req=%p ccb=%p\n",
891 ccbh->status = CAM_RESRC_UNAVAIL;
893 ccbh->status = CAM_REQ_CMP_ERR;
899 vtscsi_cam_path_inquiry(struct vtscsi_softc *sc, struct cam_sim *sim,
903 struct ccb_pathinq *cpi;
905 dev = sc->vtscsi_dev;
908 vtscsi_dprintf(sc, VTSCSI_TRACE, "sim=%p ccb=%p\n", sim, ccb);
910 cpi->version_num = 1;
911 cpi->hba_inquiry = PI_TAG_ABLE;
912 cpi->target_sprt = 0;
913 cpi->hba_misc = PIM_SEQSCAN | PIM_UNMAPPED;
914 if (vtscsi_bus_reset_disable != 0)
915 cpi->hba_misc |= PIM_NOBUSRESET;
916 cpi->hba_eng_cnt = 0;
918 cpi->max_target = sc->vtscsi_max_target;
919 cpi->max_lun = sc->vtscsi_max_lun;
920 cpi->initiator_id = VTSCSI_INITIATOR_ID;
922 strlcpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
923 strlcpy(cpi->hba_vid, "VirtIO", HBA_IDLEN);
924 strlcpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
926 cpi->unit_number = cam_sim_unit(sim);
927 cpi->bus_id = cam_sim_bus(sim);
929 cpi->base_transfer_speed = 300000;
931 cpi->protocol = PROTO_SCSI;
932 cpi->protocol_version = SCSI_REV_SPC3;
933 cpi->transport = XPORT_SAS;
934 cpi->transport_version = 0;
936 cpi->maxio = (sc->vtscsi_max_nsegs - VTSCSI_MIN_SEGMENTS - 1) *
939 cpi->hba_vendor = virtio_get_vendor(dev);
940 cpi->hba_device = virtio_get_device(dev);
941 cpi->hba_subvendor = virtio_get_subvendor(dev);
942 cpi->hba_subdevice = virtio_get_subdevice(dev);
944 ccb->ccb_h.status = CAM_REQ_CMP;
949 vtscsi_sg_append_scsi_buf(struct vtscsi_softc *sc, struct sglist *sg,
950 struct ccb_scsiio *csio)
952 struct ccb_hdr *ccbh;
953 struct bus_dma_segment *dseg;
959 switch ((ccbh->flags & CAM_DATA_MASK)) {
961 error = sglist_append(sg, csio->data_ptr, csio->dxfer_len);
964 error = sglist_append_phys(sg,
965 (vm_paddr_t)(vm_offset_t) csio->data_ptr, csio->dxfer_len);
968 for (i = 0; i < csio->sglist_cnt && error == 0; i++) {
969 dseg = &((struct bus_dma_segment *)csio->data_ptr)[i];
970 error = sglist_append(sg,
971 (void *)(vm_offset_t) dseg->ds_addr, dseg->ds_len);
974 case CAM_DATA_SG_PADDR:
975 for (i = 0; i < csio->sglist_cnt && error == 0; i++) {
976 dseg = &((struct bus_dma_segment *)csio->data_ptr)[i];
977 error = sglist_append_phys(sg,
978 (vm_paddr_t) dseg->ds_addr, dseg->ds_len);
982 error = sglist_append_bio(sg, (struct bio *) csio->data_ptr);
993 vtscsi_fill_scsi_cmd_sglist(struct vtscsi_softc *sc, struct vtscsi_request *req,
994 int *readable, int *writable)
997 struct ccb_hdr *ccbh;
998 struct ccb_scsiio *csio;
999 struct virtio_scsi_cmd_req *cmd_req;
1000 struct virtio_scsi_cmd_resp *cmd_resp;
1003 sg = sc->vtscsi_sglist;
1004 csio = &req->vsr_ccb->csio;
1005 ccbh = &csio->ccb_h;
1006 cmd_req = &req->vsr_cmd_req;
1007 cmd_resp = &req->vsr_cmd_resp;
1011 sglist_append(sg, cmd_req, sizeof(struct virtio_scsi_cmd_req));
1012 if ((ccbh->flags & CAM_DIR_MASK) == CAM_DIR_OUT) {
1013 error = vtscsi_sg_append_scsi_buf(sc, sg, csio);
1014 /* At least one segment must be left for the response. */
1015 if (error || sg->sg_nseg == sg->sg_maxseg)
1019 *readable = sg->sg_nseg;
1021 sglist_append(sg, cmd_resp, sizeof(struct virtio_scsi_cmd_resp));
1022 if ((ccbh->flags & CAM_DIR_MASK) == CAM_DIR_IN) {
1023 error = vtscsi_sg_append_scsi_buf(sc, sg, csio);
1028 *writable = sg->sg_nseg - *readable;
1030 vtscsi_dprintf(sc, VTSCSI_TRACE, "req=%p ccb=%p readable=%d "
1031 "writable=%d\n", req, ccbh, *readable, *writable);
1037 * This should never happen unless maxio was incorrectly set.
1039 vtscsi_set_ccb_status(ccbh, CAM_REQ_TOO_BIG, 0);
1041 vtscsi_dprintf(sc, VTSCSI_ERROR, "error=%d req=%p ccb=%p "
1042 "nseg=%d maxseg=%d\n",
1043 error, req, ccbh, sg->sg_nseg, sg->sg_maxseg);
1049 vtscsi_execute_scsi_cmd(struct vtscsi_softc *sc, struct vtscsi_request *req)
1052 struct virtqueue *vq;
1053 struct ccb_scsiio *csio;
1054 struct ccb_hdr *ccbh;
1055 struct virtio_scsi_cmd_req *cmd_req;
1056 struct virtio_scsi_cmd_resp *cmd_resp;
1057 int readable, writable, error;
1059 sg = sc->vtscsi_sglist;
1060 vq = sc->vtscsi_request_vq;
1061 csio = &req->vsr_ccb->csio;
1062 ccbh = &csio->ccb_h;
1063 cmd_req = &req->vsr_cmd_req;
1064 cmd_resp = &req->vsr_cmd_resp;
1066 vtscsi_init_scsi_cmd_req(csio, cmd_req);
1068 error = vtscsi_fill_scsi_cmd_sglist(sc, req, &readable, &writable);
1072 req->vsr_complete = vtscsi_complete_scsi_cmd;
1073 cmd_resp->response = -1;
1075 error = virtqueue_enqueue(vq, req, sg, readable, writable);
1077 vtscsi_dprintf(sc, VTSCSI_ERROR,
1078 "enqueue error=%d req=%p ccb=%p\n", error, req, ccbh);
1080 ccbh->status = CAM_REQUEUE_REQ;
1081 vtscsi_freeze_simq(sc, VTSCSI_REQUEST_VQ);
1085 ccbh->status |= CAM_SIM_QUEUED;
1086 ccbh->ccbh_vtscsi_req = req;
1088 virtqueue_notify(vq);
1090 if (ccbh->timeout != CAM_TIME_INFINITY) {
1091 req->vsr_flags |= VTSCSI_REQ_FLAG_TIMEOUT_SET;
1092 callout_reset_sbt(&req->vsr_callout, SBT_1MS * ccbh->timeout,
1093 0, vtscsi_timedout_scsi_cmd, req, 0);
1096 vtscsi_dprintf_req(req, VTSCSI_TRACE, "enqueued req=%p ccb=%p\n",
1103 vtscsi_start_scsi_cmd(struct vtscsi_softc *sc, union ccb *ccb)
1105 struct vtscsi_request *req;
1108 req = vtscsi_dequeue_request(sc);
1110 ccb->ccb_h.status = CAM_REQUEUE_REQ;
1111 vtscsi_freeze_simq(sc, VTSCSI_REQUEST);
1117 error = vtscsi_execute_scsi_cmd(sc, req);
1119 vtscsi_enqueue_request(sc, req);
1125 vtscsi_complete_abort_timedout_scsi_cmd(struct vtscsi_softc *sc,
1126 struct vtscsi_request *req)
1128 struct virtio_scsi_ctrl_tmf_resp *tmf_resp;
1129 struct vtscsi_request *to_req;
1132 tmf_resp = &req->vsr_tmf_resp;
1133 response = tmf_resp->response;
1134 to_req = req->vsr_timedout_req;
1136 vtscsi_dprintf(sc, VTSCSI_TRACE, "req=%p to_req=%p response=%d\n",
1137 req, to_req, response);
1139 vtscsi_enqueue_request(sc, req);
1142 * The timedout request could have completed between when the
1143 * abort task was sent and when the host processed it.
1145 if (to_req->vsr_state != VTSCSI_REQ_STATE_TIMEDOUT)
1148 /* The timedout request was successfully aborted. */
1149 if (response == VIRTIO_SCSI_S_FUNCTION_COMPLETE)
1152 /* Don't bother if the device is going away. */
1153 if (sc->vtscsi_flags & VTSCSI_FLAG_DETACH)
1156 /* The timedout request will be aborted by the reset. */
1157 if (sc->vtscsi_flags & VTSCSI_FLAG_RESET)
1160 vtscsi_reset_bus(sc);
1164 vtscsi_abort_timedout_scsi_cmd(struct vtscsi_softc *sc,
1165 struct vtscsi_request *to_req)
1168 struct ccb_hdr *to_ccbh;
1169 struct vtscsi_request *req;
1170 struct virtio_scsi_ctrl_tmf_req *tmf_req;
1171 struct virtio_scsi_ctrl_tmf_resp *tmf_resp;
1174 sg = sc->vtscsi_sglist;
1175 to_ccbh = &to_req->vsr_ccb->ccb_h;
1177 req = vtscsi_dequeue_request(sc);
1183 tmf_req = &req->vsr_tmf_req;
1184 tmf_resp = &req->vsr_tmf_resp;
1186 vtscsi_init_ctrl_tmf_req(to_ccbh, VIRTIO_SCSI_T_TMF_ABORT_TASK,
1187 (uintptr_t) to_ccbh, tmf_req);
1190 sglist_append(sg, tmf_req, sizeof(struct virtio_scsi_ctrl_tmf_req));
1191 sglist_append(sg, tmf_resp, sizeof(struct virtio_scsi_ctrl_tmf_resp));
1193 req->vsr_timedout_req = to_req;
1194 req->vsr_complete = vtscsi_complete_abort_timedout_scsi_cmd;
1195 tmf_resp->response = -1;
1197 error = vtscsi_execute_ctrl_req(sc, req, sg, 1, 1,
1198 VTSCSI_EXECUTE_ASYNC);
1202 vtscsi_enqueue_request(sc, req);
1205 vtscsi_dprintf(sc, VTSCSI_ERROR, "error=%d req=%p "
1206 "timedout req=%p ccb=%p\n", error, req, to_req, to_ccbh);
1212 vtscsi_timedout_scsi_cmd(void *xreq)
1214 struct vtscsi_softc *sc;
1215 struct vtscsi_request *to_req;
1218 sc = to_req->vsr_softc;
1220 vtscsi_dprintf(sc, VTSCSI_INFO, "timedout req=%p ccb=%p state=%#x\n",
1221 to_req, to_req->vsr_ccb, to_req->vsr_state);
1223 /* Don't bother if the device is going away. */
1224 if (sc->vtscsi_flags & VTSCSI_FLAG_DETACH)
1228 * Bail if the request is not in use. We likely raced when
1229 * stopping the callout handler or it has already been aborted.
1231 if (to_req->vsr_state != VTSCSI_REQ_STATE_INUSE ||
1232 (to_req->vsr_flags & VTSCSI_REQ_FLAG_TIMEOUT_SET) == 0)
1236 * Complete the request queue in case the timedout request is
1237 * actually just pending.
1239 vtscsi_complete_vq(sc, sc->vtscsi_request_vq);
1240 if (to_req->vsr_state == VTSCSI_REQ_STATE_FREE)
1243 sc->vtscsi_stats.scsi_cmd_timeouts++;
1244 to_req->vsr_state = VTSCSI_REQ_STATE_TIMEDOUT;
1246 if (vtscsi_abort_timedout_scsi_cmd(sc, to_req) == 0)
1249 vtscsi_dprintf(sc, VTSCSI_ERROR, "resetting bus\n");
1250 vtscsi_reset_bus(sc);
1254 vtscsi_scsi_cmd_cam_status(struct virtio_scsi_cmd_resp *cmd_resp)
1258 switch (cmd_resp->response) {
1259 case VIRTIO_SCSI_S_OK:
1260 status = CAM_REQ_CMP;
1262 case VIRTIO_SCSI_S_OVERRUN:
1263 status = CAM_DATA_RUN_ERR;
1265 case VIRTIO_SCSI_S_ABORTED:
1266 status = CAM_REQ_ABORTED;
1268 case VIRTIO_SCSI_S_BAD_TARGET:
1269 status = CAM_SEL_TIMEOUT;
1271 case VIRTIO_SCSI_S_RESET:
1272 status = CAM_SCSI_BUS_RESET;
1274 case VIRTIO_SCSI_S_BUSY:
1275 status = CAM_SCSI_BUSY;
1277 case VIRTIO_SCSI_S_TRANSPORT_FAILURE:
1278 case VIRTIO_SCSI_S_TARGET_FAILURE:
1279 case VIRTIO_SCSI_S_NEXUS_FAILURE:
1280 status = CAM_SCSI_IT_NEXUS_LOST;
1282 default: /* VIRTIO_SCSI_S_FAILURE */
1283 status = CAM_REQ_CMP_ERR;
1291 vtscsi_complete_scsi_cmd_response(struct vtscsi_softc *sc,
1292 struct ccb_scsiio *csio, struct virtio_scsi_cmd_resp *cmd_resp)
1296 csio->scsi_status = cmd_resp->status;
1297 csio->resid = cmd_resp->resid;
1299 if (csio->scsi_status == SCSI_STATUS_OK)
1300 status = CAM_REQ_CMP;
1302 status = CAM_SCSI_STATUS_ERROR;
1304 if (cmd_resp->sense_len > 0) {
1305 status |= CAM_AUTOSNS_VALID;
1307 if (cmd_resp->sense_len < csio->sense_len)
1308 csio->sense_resid = csio->sense_len -
1309 cmd_resp->sense_len;
1311 csio->sense_resid = 0;
1313 memcpy(&csio->sense_data, cmd_resp->sense,
1314 csio->sense_len - csio->sense_resid);
1317 vtscsi_dprintf(sc, status == CAM_REQ_CMP ? VTSCSI_TRACE : VTSCSI_ERROR,
1318 "ccb=%p scsi_status=%#x resid=%u sense_resid=%u\n",
1319 csio, csio->scsi_status, csio->resid, csio->sense_resid);
1325 vtscsi_complete_scsi_cmd(struct vtscsi_softc *sc, struct vtscsi_request *req)
1327 struct ccb_hdr *ccbh;
1328 struct ccb_scsiio *csio;
1329 struct virtio_scsi_cmd_resp *cmd_resp;
1332 csio = &req->vsr_ccb->csio;
1333 ccbh = &csio->ccb_h;
1334 cmd_resp = &req->vsr_cmd_resp;
1336 KASSERT(ccbh->ccbh_vtscsi_req == req,
1337 ("ccb %p req mismatch %p/%p", ccbh, ccbh->ccbh_vtscsi_req, req));
1339 if (req->vsr_flags & VTSCSI_REQ_FLAG_TIMEOUT_SET)
1340 callout_stop(&req->vsr_callout);
1342 status = vtscsi_scsi_cmd_cam_status(cmd_resp);
1343 if (status == CAM_REQ_ABORTED) {
1344 if (req->vsr_state == VTSCSI_REQ_STATE_TIMEDOUT)
1345 status = CAM_CMD_TIMEOUT;
1346 } else if (status == CAM_REQ_CMP)
1347 status = vtscsi_complete_scsi_cmd_response(sc, csio, cmd_resp);
1349 if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1350 status |= CAM_DEV_QFRZN;
1351 xpt_freeze_devq(ccbh->path, 1);
1354 if (vtscsi_thaw_simq(sc, VTSCSI_REQUEST | VTSCSI_REQUEST_VQ) != 0)
1355 status |= CAM_RELEASE_SIMQ;
1357 vtscsi_dprintf(sc, VTSCSI_TRACE, "req=%p ccb=%p status=%#x\n",
1360 ccbh->status = status;
1361 xpt_done(req->vsr_ccb);
1362 vtscsi_enqueue_request(sc, req);
1366 vtscsi_poll_ctrl_req(struct vtscsi_softc *sc, struct vtscsi_request *req)
1369 /* XXX We probably shouldn't poll forever. */
1370 req->vsr_flags |= VTSCSI_REQ_FLAG_POLLED;
1372 vtscsi_complete_vq(sc, sc->vtscsi_control_vq);
1373 while ((req->vsr_flags & VTSCSI_REQ_FLAG_COMPLETE) == 0);
1375 req->vsr_flags &= ~VTSCSI_REQ_FLAG_POLLED;
1379 vtscsi_execute_ctrl_req(struct vtscsi_softc *sc, struct vtscsi_request *req,
1380 struct sglist *sg, int readable, int writable, int flag)
1382 struct virtqueue *vq;
1385 vq = sc->vtscsi_control_vq;
1387 MPASS(flag == VTSCSI_EXECUTE_POLL || req->vsr_complete != NULL);
1389 error = virtqueue_enqueue(vq, req, sg, readable, writable);
1392 * Return EAGAIN when the virtqueue does not have enough
1393 * descriptors available.
1395 if (error == ENOSPC || error == EMSGSIZE)
1401 virtqueue_notify(vq);
1402 if (flag == VTSCSI_EXECUTE_POLL)
1403 vtscsi_poll_ctrl_req(sc, req);
1409 vtscsi_complete_abort_task_cmd(struct vtscsi_softc *sc,
1410 struct vtscsi_request *req)
1413 struct ccb_hdr *ccbh;
1414 struct virtio_scsi_ctrl_tmf_resp *tmf_resp;
1418 tmf_resp = &req->vsr_tmf_resp;
1420 switch (tmf_resp->response) {
1421 case VIRTIO_SCSI_S_FUNCTION_COMPLETE:
1422 ccbh->status = CAM_REQ_CMP;
1424 case VIRTIO_SCSI_S_FUNCTION_REJECTED:
1425 ccbh->status = CAM_UA_ABORT;
1428 ccbh->status = CAM_REQ_CMP_ERR;
1433 vtscsi_enqueue_request(sc, req);
1437 vtscsi_execute_abort_task_cmd(struct vtscsi_softc *sc,
1438 struct vtscsi_request *req)
1441 struct ccb_abort *cab;
1442 struct ccb_hdr *ccbh;
1443 struct ccb_hdr *abort_ccbh;
1444 struct vtscsi_request *abort_req;
1445 struct virtio_scsi_ctrl_tmf_req *tmf_req;
1446 struct virtio_scsi_ctrl_tmf_resp *tmf_resp;
1449 sg = sc->vtscsi_sglist;
1450 cab = &req->vsr_ccb->cab;
1452 tmf_req = &req->vsr_tmf_req;
1453 tmf_resp = &req->vsr_tmf_resp;
1455 /* CCB header and request that's to be aborted. */
1456 abort_ccbh = &cab->abort_ccb->ccb_h;
1457 abort_req = abort_ccbh->ccbh_vtscsi_req;
1459 if (abort_ccbh->func_code != XPT_SCSI_IO || abort_req == NULL) {
1464 /* Only attempt to abort requests that could be in-flight. */
1465 if (abort_req->vsr_state != VTSCSI_REQ_STATE_INUSE) {
1470 abort_req->vsr_state = VTSCSI_REQ_STATE_ABORTED;
1471 if (abort_req->vsr_flags & VTSCSI_REQ_FLAG_TIMEOUT_SET)
1472 callout_stop(&abort_req->vsr_callout);
1474 vtscsi_init_ctrl_tmf_req(ccbh, VIRTIO_SCSI_T_TMF_ABORT_TASK,
1475 (uintptr_t) abort_ccbh, tmf_req);
1478 sglist_append(sg, tmf_req, sizeof(struct virtio_scsi_ctrl_tmf_req));
1479 sglist_append(sg, tmf_resp, sizeof(struct virtio_scsi_ctrl_tmf_resp));
1481 req->vsr_complete = vtscsi_complete_abort_task_cmd;
1482 tmf_resp->response = -1;
1484 error = vtscsi_execute_ctrl_req(sc, req, sg, 1, 1,
1485 VTSCSI_EXECUTE_ASYNC);
1488 vtscsi_dprintf(sc, VTSCSI_TRACE, "error=%d req=%p abort_ccb=%p "
1489 "abort_req=%p\n", error, req, abort_ccbh, abort_req);
1495 vtscsi_complete_reset_dev_cmd(struct vtscsi_softc *sc,
1496 struct vtscsi_request *req)
1499 struct ccb_hdr *ccbh;
1500 struct virtio_scsi_ctrl_tmf_resp *tmf_resp;
1504 tmf_resp = &req->vsr_tmf_resp;
1506 vtscsi_dprintf(sc, VTSCSI_TRACE, "req=%p ccb=%p response=%d\n",
1507 req, ccb, tmf_resp->response);
1509 if (tmf_resp->response == VIRTIO_SCSI_S_FUNCTION_COMPLETE) {
1510 ccbh->status = CAM_REQ_CMP;
1511 vtscsi_announce(sc, AC_SENT_BDR, ccbh->target_id,
1514 ccbh->status = CAM_REQ_CMP_ERR;
1517 vtscsi_enqueue_request(sc, req);
1521 vtscsi_execute_reset_dev_cmd(struct vtscsi_softc *sc,
1522 struct vtscsi_request *req)
1525 struct ccb_resetdev *crd;
1526 struct ccb_hdr *ccbh;
1527 struct virtio_scsi_ctrl_tmf_req *tmf_req;
1528 struct virtio_scsi_ctrl_tmf_resp *tmf_resp;
1532 sg = sc->vtscsi_sglist;
1533 crd = &req->vsr_ccb->crd;
1535 tmf_req = &req->vsr_tmf_req;
1536 tmf_resp = &req->vsr_tmf_resp;
1538 if (ccbh->target_lun == CAM_LUN_WILDCARD)
1539 subtype = VIRTIO_SCSI_T_TMF_I_T_NEXUS_RESET;
1541 subtype = VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET;
1543 vtscsi_init_ctrl_tmf_req(ccbh, subtype, 0, tmf_req);
1546 sglist_append(sg, tmf_req, sizeof(struct virtio_scsi_ctrl_tmf_req));
1547 sglist_append(sg, tmf_resp, sizeof(struct virtio_scsi_ctrl_tmf_resp));
1549 req->vsr_complete = vtscsi_complete_reset_dev_cmd;
1550 tmf_resp->response = -1;
1552 error = vtscsi_execute_ctrl_req(sc, req, sg, 1, 1,
1553 VTSCSI_EXECUTE_ASYNC);
1555 vtscsi_dprintf(sc, VTSCSI_TRACE, "error=%d req=%p ccb=%p\n",
1562 vtscsi_get_request_lun(uint8_t lun[], target_id_t *target_id, lun_id_t *lun_id)
1565 *target_id = lun[1];
1566 *lun_id = (lun[2] << 8) | lun[3];
1570 vtscsi_set_request_lun(struct ccb_hdr *ccbh, uint8_t lun[])
1574 lun[1] = ccbh->target_id;
1575 lun[2] = 0x40 | ((ccbh->target_lun >> 8) & 0x3F);
1576 lun[3] = ccbh->target_lun & 0xFF;
1580 vtscsi_init_scsi_cmd_req(struct ccb_scsiio *csio,
1581 struct virtio_scsi_cmd_req *cmd_req)
1585 switch (csio->tag_action) {
1586 case MSG_HEAD_OF_Q_TAG:
1587 attr = VIRTIO_SCSI_S_HEAD;
1589 case MSG_ORDERED_Q_TAG:
1590 attr = VIRTIO_SCSI_S_ORDERED;
1593 attr = VIRTIO_SCSI_S_ACA;
1595 default: /* MSG_SIMPLE_Q_TAG */
1596 attr = VIRTIO_SCSI_S_SIMPLE;
1600 vtscsi_set_request_lun(&csio->ccb_h, cmd_req->lun);
1601 cmd_req->tag = (uintptr_t) csio;
1602 cmd_req->task_attr = attr;
1604 memcpy(cmd_req->cdb,
1605 csio->ccb_h.flags & CAM_CDB_POINTER ?
1606 csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes,
1611 vtscsi_init_ctrl_tmf_req(struct ccb_hdr *ccbh, uint32_t subtype,
1612 uintptr_t tag, struct virtio_scsi_ctrl_tmf_req *tmf_req)
1615 vtscsi_set_request_lun(ccbh, tmf_req->lun);
1617 tmf_req->type = VIRTIO_SCSI_T_TMF;
1618 tmf_req->subtype = subtype;
1623 vtscsi_freeze_simq(struct vtscsi_softc *sc, int reason)
1627 frozen = sc->vtscsi_frozen;
1629 if (reason & VTSCSI_REQUEST &&
1630 (sc->vtscsi_frozen & VTSCSI_FROZEN_NO_REQUESTS) == 0)
1631 sc->vtscsi_frozen |= VTSCSI_FROZEN_NO_REQUESTS;
1633 if (reason & VTSCSI_REQUEST_VQ &&
1634 (sc->vtscsi_frozen & VTSCSI_FROZEN_REQUEST_VQ_FULL) == 0)
1635 sc->vtscsi_frozen |= VTSCSI_FROZEN_REQUEST_VQ_FULL;
1637 /* Freeze the SIMQ if transitioned to frozen. */
1638 if (frozen == 0 && sc->vtscsi_frozen != 0) {
1639 vtscsi_dprintf(sc, VTSCSI_INFO, "SIMQ frozen\n");
1640 xpt_freeze_simq(sc->vtscsi_sim, 1);
1645 vtscsi_thaw_simq(struct vtscsi_softc *sc, int reason)
1649 if (sc->vtscsi_frozen == 0 || reason == 0)
1652 if (reason & VTSCSI_REQUEST &&
1653 sc->vtscsi_frozen & VTSCSI_FROZEN_NO_REQUESTS)
1654 sc->vtscsi_frozen &= ~VTSCSI_FROZEN_NO_REQUESTS;
1656 if (reason & VTSCSI_REQUEST_VQ &&
1657 sc->vtscsi_frozen & VTSCSI_FROZEN_REQUEST_VQ_FULL)
1658 sc->vtscsi_frozen &= ~VTSCSI_FROZEN_REQUEST_VQ_FULL;
1660 thawed = sc->vtscsi_frozen == 0;
1662 vtscsi_dprintf(sc, VTSCSI_INFO, "SIMQ thawed\n");
1668 vtscsi_announce(struct vtscsi_softc *sc, uint32_t ac_code,
1669 target_id_t target_id, lun_id_t lun_id)
1671 struct cam_path *path;
1673 /* Use the wildcard path from our softc for bus announcements. */
1674 if (target_id == CAM_TARGET_WILDCARD && lun_id == CAM_LUN_WILDCARD) {
1675 xpt_async(ac_code, sc->vtscsi_path, NULL);
1679 if (xpt_create_path(&path, NULL, cam_sim_path(sc->vtscsi_sim),
1680 target_id, lun_id) != CAM_REQ_CMP) {
1681 vtscsi_dprintf(sc, VTSCSI_ERROR, "cannot create path\n");
1685 xpt_async(ac_code, path, NULL);
1686 xpt_free_path(path);
1690 vtscsi_execute_rescan(struct vtscsi_softc *sc, target_id_t target_id,
1696 ccb = xpt_alloc_ccb_nowait();
1698 vtscsi_dprintf(sc, VTSCSI_ERROR, "cannot allocate CCB\n");
1702 status = xpt_create_path(&ccb->ccb_h.path, NULL,
1703 cam_sim_path(sc->vtscsi_sim), target_id, lun_id);
1704 if (status != CAM_REQ_CMP) {
1713 vtscsi_execute_rescan_bus(struct vtscsi_softc *sc)
1716 vtscsi_execute_rescan(sc, CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
1720 vtscsi_transport_reset_event(struct vtscsi_softc *sc,
1721 struct virtio_scsi_event *event)
1723 target_id_t target_id;
1726 vtscsi_get_request_lun(event->lun, &target_id, &lun_id);
1728 switch (event->reason) {
1729 case VIRTIO_SCSI_EVT_RESET_RESCAN:
1730 case VIRTIO_SCSI_EVT_RESET_REMOVED:
1731 vtscsi_execute_rescan(sc, target_id, lun_id);
1734 device_printf(sc->vtscsi_dev,
1735 "unhandled transport event reason: %d\n", event->reason);
1741 vtscsi_handle_event(struct vtscsi_softc *sc, struct virtio_scsi_event *event)
1745 if ((event->event & VIRTIO_SCSI_T_EVENTS_MISSED) == 0) {
1746 switch (event->event) {
1747 case VIRTIO_SCSI_T_TRANSPORT_RESET:
1748 vtscsi_transport_reset_event(sc, event);
1751 device_printf(sc->vtscsi_dev,
1752 "unhandled event: %d\n", event->event);
1756 vtscsi_execute_rescan_bus(sc);
1759 * This should always be successful since the buffer
1760 * was just dequeued.
1762 error = vtscsi_enqueue_event_buf(sc, event);
1764 ("cannot requeue event buffer: %d", error));
1768 vtscsi_enqueue_event_buf(struct vtscsi_softc *sc,
1769 struct virtio_scsi_event *event)
1772 struct virtqueue *vq;
1775 sg = sc->vtscsi_sglist;
1776 vq = sc->vtscsi_event_vq;
1777 size = sc->vtscsi_event_buf_size;
1782 error = sglist_append(sg, event, size);
1786 error = virtqueue_enqueue(vq, event, sg, 0, sg->sg_nseg);
1790 virtqueue_notify(vq);
1796 vtscsi_init_event_vq(struct vtscsi_softc *sc)
1798 struct virtio_scsi_event *event;
1802 * The first release of QEMU with VirtIO SCSI support would crash
1803 * when attempting to notify the event virtqueue. This was fixed
1804 * when hotplug support was added.
1806 if (sc->vtscsi_flags & VTSCSI_FLAG_HOTPLUG)
1807 size = sc->vtscsi_event_buf_size;
1811 if (size < sizeof(struct virtio_scsi_event))
1814 for (i = 0; i < VTSCSI_NUM_EVENT_BUFS; i++) {
1815 event = &sc->vtscsi_event_bufs[i];
1817 error = vtscsi_enqueue_event_buf(sc, event);
1823 * Even just one buffer is enough. Missed events are
1824 * denoted with the VIRTIO_SCSI_T_EVENTS_MISSED flag.
1833 vtscsi_reinit_event_vq(struct vtscsi_softc *sc)
1835 struct virtio_scsi_event *event;
1838 if ((sc->vtscsi_flags & VTSCSI_FLAG_HOTPLUG) == 0 ||
1839 sc->vtscsi_event_buf_size < sizeof(struct virtio_scsi_event))
1842 for (i = 0; i < VTSCSI_NUM_EVENT_BUFS; i++) {
1843 event = &sc->vtscsi_event_bufs[i];
1845 error = vtscsi_enqueue_event_buf(sc, event);
1850 KASSERT(i > 0, ("cannot reinit event vq: %d", error));
1854 vtscsi_drain_event_vq(struct vtscsi_softc *sc)
1856 struct virtqueue *vq;
1859 vq = sc->vtscsi_event_vq;
1862 while (virtqueue_drain(vq, &last) != NULL)
1865 KASSERT(virtqueue_empty(vq), ("eventvq not empty"));
1869 vtscsi_complete_vqs_locked(struct vtscsi_softc *sc)
1872 VTSCSI_LOCK_OWNED(sc);
1874 if (sc->vtscsi_request_vq != NULL)
1875 vtscsi_complete_vq(sc, sc->vtscsi_request_vq);
1876 if (sc->vtscsi_control_vq != NULL)
1877 vtscsi_complete_vq(sc, sc->vtscsi_control_vq);
1881 vtscsi_complete_vqs(struct vtscsi_softc *sc)
1885 vtscsi_complete_vqs_locked(sc);
1890 vtscsi_cancel_request(struct vtscsi_softc *sc, struct vtscsi_request *req)
1897 vtscsi_dprintf(sc, VTSCSI_TRACE, "req=%p ccb=%p\n", req, ccb);
1900 * The callout must be drained when detaching since the request is
1901 * about to be freed. The VTSCSI_MTX must not be held for this in
1902 * case the callout is pending because there is a deadlock potential.
1903 * Otherwise, the virtqueue is being drained because of a bus reset
1904 * so we only need to attempt to stop the callouts.
1906 detach = (sc->vtscsi_flags & VTSCSI_FLAG_DETACH) != 0;
1908 VTSCSI_LOCK_NOTOWNED(sc);
1910 VTSCSI_LOCK_OWNED(sc);
1912 if (req->vsr_flags & VTSCSI_REQ_FLAG_TIMEOUT_SET) {
1914 callout_drain(&req->vsr_callout);
1916 callout_stop(&req->vsr_callout);
1922 ccb->ccb_h.status = CAM_NO_HBA;
1924 ccb->ccb_h.status = CAM_REQUEUE_REQ;
1930 vtscsi_enqueue_request(sc, req);
1934 vtscsi_drain_vq(struct vtscsi_softc *sc, struct virtqueue *vq)
1936 struct vtscsi_request *req;
1941 vtscsi_dprintf(sc, VTSCSI_TRACE, "vq=%p\n", vq);
1943 while ((req = virtqueue_drain(vq, &last)) != NULL)
1944 vtscsi_cancel_request(sc, req);
1946 KASSERT(virtqueue_empty(vq), ("virtqueue not empty"));
1950 vtscsi_drain_vqs(struct vtscsi_softc *sc)
1953 if (sc->vtscsi_control_vq != NULL)
1954 vtscsi_drain_vq(sc, sc->vtscsi_control_vq);
1955 if (sc->vtscsi_request_vq != NULL)
1956 vtscsi_drain_vq(sc, sc->vtscsi_request_vq);
1957 if (sc->vtscsi_event_vq != NULL)
1958 vtscsi_drain_event_vq(sc);
1962 vtscsi_stop(struct vtscsi_softc *sc)
1965 vtscsi_disable_vqs_intr(sc);
1966 virtio_stop(sc->vtscsi_dev);
1970 vtscsi_reset_bus(struct vtscsi_softc *sc)
1974 VTSCSI_LOCK_OWNED(sc);
1976 if (vtscsi_bus_reset_disable != 0) {
1977 device_printf(sc->vtscsi_dev, "bus reset disabled\n");
1981 sc->vtscsi_flags |= VTSCSI_FLAG_RESET;
1984 * vtscsi_stop() will cause the in-flight requests to be canceled.
1985 * Those requests are then completed here so CAM will retry them
1986 * after the reset is complete.
1989 vtscsi_complete_vqs_locked(sc);
1991 /* Rid the virtqueues of any remaining requests. */
1992 vtscsi_drain_vqs(sc);
1995 * Any resource shortage that froze the SIMQ cannot persist across
1996 * a bus reset so ensure it gets thawed here.
1998 if (vtscsi_thaw_simq(sc, VTSCSI_REQUEST | VTSCSI_REQUEST_VQ) != 0)
1999 xpt_release_simq(sc->vtscsi_sim, 0);
2001 error = vtscsi_reinit(sc);
2003 device_printf(sc->vtscsi_dev,
2004 "reinitialization failed, stopping device...\n");
2007 vtscsi_announce(sc, AC_BUS_RESET, CAM_TARGET_WILDCARD,
2010 sc->vtscsi_flags &= ~VTSCSI_FLAG_RESET;
2016 vtscsi_init_request(struct vtscsi_softc *sc, struct vtscsi_request *req)
2020 int req_nsegs, resp_nsegs;
2022 req_nsegs = sglist_count(&req->vsr_ureq, sizeof(req->vsr_ureq));
2023 resp_nsegs = sglist_count(&req->vsr_uresp, sizeof(req->vsr_uresp));
2025 KASSERT(req_nsegs == 1, ("request crossed page boundary"));
2026 KASSERT(resp_nsegs == 1, ("response crossed page boundary"));
2029 req->vsr_softc = sc;
2030 callout_init_mtx(&req->vsr_callout, VTSCSI_MTX(sc), 0);
2034 vtscsi_alloc_requests(struct vtscsi_softc *sc)
2036 struct vtscsi_request *req;
2040 * Commands destined for either the request or control queues come
2041 * from the same SIM queue. Use the size of the request virtqueue
2042 * as it (should) be much more frequently used. Some additional
2043 * requests are allocated for internal (TMF) use.
2045 nreqs = virtqueue_size(sc->vtscsi_request_vq);
2046 if ((sc->vtscsi_flags & VTSCSI_FLAG_INDIRECT) == 0)
2047 nreqs /= VTSCSI_MIN_SEGMENTS;
2048 nreqs += VTSCSI_RESERVED_REQUESTS;
2050 for (i = 0; i < nreqs; i++) {
2051 req = malloc(sizeof(struct vtscsi_request), M_DEVBUF,
2056 vtscsi_init_request(sc, req);
2058 sc->vtscsi_nrequests++;
2059 vtscsi_enqueue_request(sc, req);
2066 vtscsi_free_requests(struct vtscsi_softc *sc)
2068 struct vtscsi_request *req;
2070 while ((req = vtscsi_dequeue_request(sc)) != NULL) {
2071 KASSERT(callout_active(&req->vsr_callout) == 0,
2072 ("request callout still active"));
2074 sc->vtscsi_nrequests--;
2075 free(req, M_DEVBUF);
2078 KASSERT(sc->vtscsi_nrequests == 0, ("leaked requests: %d",
2079 sc->vtscsi_nrequests));
2083 vtscsi_enqueue_request(struct vtscsi_softc *sc, struct vtscsi_request *req)
2086 KASSERT(req->vsr_softc == sc,
2087 ("non-matching request vsr_softc %p/%p", req->vsr_softc, sc));
2089 vtscsi_dprintf(sc, VTSCSI_TRACE, "req=%p\n", req);
2091 /* A request is available so the SIMQ could be released. */
2092 if (vtscsi_thaw_simq(sc, VTSCSI_REQUEST) != 0)
2093 xpt_release_simq(sc->vtscsi_sim, 1);
2095 req->vsr_ccb = NULL;
2096 req->vsr_complete = NULL;
2097 req->vsr_ptr0 = NULL;
2098 req->vsr_state = VTSCSI_REQ_STATE_FREE;
2101 bzero(&req->vsr_ureq, sizeof(req->vsr_ureq));
2102 bzero(&req->vsr_uresp, sizeof(req->vsr_uresp));
2105 * We insert at the tail of the queue in order to make it
2106 * very unlikely a request will be reused if we race with
2107 * stopping its callout handler.
2109 TAILQ_INSERT_TAIL(&sc->vtscsi_req_free, req, vsr_link);
2112 static struct vtscsi_request *
2113 vtscsi_dequeue_request(struct vtscsi_softc *sc)
2115 struct vtscsi_request *req;
2117 req = TAILQ_FIRST(&sc->vtscsi_req_free);
2119 req->vsr_state = VTSCSI_REQ_STATE_INUSE;
2120 TAILQ_REMOVE(&sc->vtscsi_req_free, req, vsr_link);
2122 sc->vtscsi_stats.dequeue_no_requests++;
2124 vtscsi_dprintf(sc, VTSCSI_TRACE, "req=%p\n", req);
2130 vtscsi_complete_request(struct vtscsi_request *req)
2133 if (req->vsr_flags & VTSCSI_REQ_FLAG_POLLED)
2134 req->vsr_flags |= VTSCSI_REQ_FLAG_COMPLETE;
2136 if (req->vsr_complete != NULL)
2137 req->vsr_complete(req->vsr_softc, req);
2141 vtscsi_complete_vq(struct vtscsi_softc *sc, struct virtqueue *vq)
2143 struct vtscsi_request *req;
2145 VTSCSI_LOCK_OWNED(sc);
2147 while ((req = virtqueue_dequeue(vq, NULL)) != NULL)
2148 vtscsi_complete_request(req);
2152 vtscsi_control_vq_intr(void *xsc)
2154 struct vtscsi_softc *sc;
2155 struct virtqueue *vq;
2158 vq = sc->vtscsi_control_vq;
2163 vtscsi_complete_vq(sc, sc->vtscsi_control_vq);
2165 if (virtqueue_enable_intr(vq) != 0) {
2166 virtqueue_disable_intr(vq);
2175 vtscsi_event_vq_intr(void *xsc)
2177 struct vtscsi_softc *sc;
2178 struct virtqueue *vq;
2179 struct virtio_scsi_event *event;
2182 vq = sc->vtscsi_event_vq;
2187 while ((event = virtqueue_dequeue(vq, NULL)) != NULL)
2188 vtscsi_handle_event(sc, event);
2190 if (virtqueue_enable_intr(vq) != 0) {
2191 virtqueue_disable_intr(vq);
2200 vtscsi_request_vq_intr(void *xsc)
2202 struct vtscsi_softc *sc;
2203 struct virtqueue *vq;
2206 vq = sc->vtscsi_request_vq;
2211 vtscsi_complete_vq(sc, sc->vtscsi_request_vq);
2213 if (virtqueue_enable_intr(vq) != 0) {
2214 virtqueue_disable_intr(vq);
2223 vtscsi_disable_vqs_intr(struct vtscsi_softc *sc)
2226 virtqueue_disable_intr(sc->vtscsi_control_vq);
2227 virtqueue_disable_intr(sc->vtscsi_event_vq);
2228 virtqueue_disable_intr(sc->vtscsi_request_vq);
2232 vtscsi_enable_vqs_intr(struct vtscsi_softc *sc)
2235 virtqueue_enable_intr(sc->vtscsi_control_vq);
2236 virtqueue_enable_intr(sc->vtscsi_event_vq);
2237 virtqueue_enable_intr(sc->vtscsi_request_vq);
2241 vtscsi_get_tunables(struct vtscsi_softc *sc)
2245 TUNABLE_INT_FETCH("hw.vtscsi.debug_level", &sc->vtscsi_debug);
2247 snprintf(tmpstr, sizeof(tmpstr), "dev.vtscsi.%d.debug_level",
2248 device_get_unit(sc->vtscsi_dev));
2249 TUNABLE_INT_FETCH(tmpstr, &sc->vtscsi_debug);
2253 vtscsi_add_sysctl(struct vtscsi_softc *sc)
2256 struct vtscsi_statistics *stats;
2257 struct sysctl_ctx_list *ctx;
2258 struct sysctl_oid *tree;
2259 struct sysctl_oid_list *child;
2261 dev = sc->vtscsi_dev;
2262 stats = &sc->vtscsi_stats;
2263 ctx = device_get_sysctl_ctx(dev);
2264 tree = device_get_sysctl_tree(dev);
2265 child = SYSCTL_CHILDREN(tree);
2267 SYSCTL_ADD_INT(ctx, child, OID_AUTO, "debug_level",
2268 CTLFLAG_RW, &sc->vtscsi_debug, 0,
2271 SYSCTL_ADD_ULONG(ctx, child, OID_AUTO, "scsi_cmd_timeouts",
2272 CTLFLAG_RD, &stats->scsi_cmd_timeouts,
2273 "SCSI command timeouts");
2274 SYSCTL_ADD_ULONG(ctx, child, OID_AUTO, "dequeue_no_requests",
2275 CTLFLAG_RD, &stats->dequeue_no_requests,
2276 "No available requests to dequeue");
2280 vtscsi_printf_req(struct vtscsi_request *req, const char *func,
2281 const char *fmt, ...)
2283 struct vtscsi_softc *sc;
2293 sc = req->vsr_softc;
2297 sbuf_new(&sb, str, sizeof(str), 0);
2300 sbuf_printf(&sb, "(noperiph:%s%d:%u): ",
2301 cam_sim_name(sc->vtscsi_sim), cam_sim_unit(sc->vtscsi_sim),
2302 cam_sim_bus(sc->vtscsi_sim));
2304 xpt_path_string(ccb->ccb_h.path, path_str, sizeof(path_str));
2305 sbuf_cat(&sb, path_str);
2306 if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
2307 scsi_command_string(&ccb->csio, &sb);
2308 sbuf_printf(&sb, "length %d ", ccb->csio.dxfer_len);
2312 sbuf_vprintf(&sb, fmt, ap);
2316 printf("%s: %s: %s", device_get_nameunit(sc->vtscsi_dev), func,