2 * Virtio SCSI HBA driver
4 * Copyright IBM Corp. 2010
5 * Copyright Red Hat, Inc. 2011
8 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
9 * Paolo Bonzini <pbonzini@redhat.com>
11 * This work is licensed under the terms of the GNU GPL, version 2 or later.
12 * See the COPYING file in the top-level directory.
16 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18 #include <linux/module.h>
19 #include <linux/slab.h>
20 #include <linux/mempool.h>
21 #include <linux/interrupt.h>
22 #include <linux/virtio.h>
23 #include <linux/virtio_ids.h>
24 #include <linux/virtio_config.h>
25 #include <linux/virtio_scsi.h>
26 #include <linux/cpu.h>
27 #include <linux/blkdev.h>
28 #include <scsi/scsi_host.h>
29 #include <scsi/scsi_device.h>
30 #include <scsi/scsi_cmnd.h>
31 #include <scsi/scsi_tcq.h>
32 #include <linux/seqlock.h>
33 #include <linux/blk-mq-virtio.h>
35 #define VIRTIO_SCSI_MEMPOOL_SZ 64
36 #define VIRTIO_SCSI_EVENT_LEN 8
37 #define VIRTIO_SCSI_VQ_BASE 2
39 /* Command queue element */
40 struct virtio_scsi_cmd {
42 struct completion *comp;
44 struct virtio_scsi_cmd_req cmd;
45 struct virtio_scsi_cmd_req_pi cmd_pi;
46 struct virtio_scsi_ctrl_tmf_req tmf;
47 struct virtio_scsi_ctrl_an_req an;
50 struct virtio_scsi_cmd_resp cmd;
51 struct virtio_scsi_ctrl_tmf_resp tmf;
52 struct virtio_scsi_ctrl_an_resp an;
53 struct virtio_scsi_event evt;
55 } ____cacheline_aligned_in_smp;
57 struct virtio_scsi_event_node {
58 struct virtio_scsi *vscsi;
59 struct virtio_scsi_event event;
60 struct work_struct work;
63 struct virtio_scsi_vq {
71 * Per-target queue state.
73 * This struct holds the data needed by the queue steering policy. When a
74 * target is sent multiple requests, we need to drive them to the same queue so
75 * that FIFO processing order is kept. However, if a target was idle, we can
76 * choose a queue arbitrarily. In this case the queue is chosen according to
77 * the current VCPU, so the driver expects the number of request queues to be
78 * equal to the number of VCPUs. This makes it easy and fast to select the
79 * queue, and also lets the driver optimize the IRQ affinity for the virtqueues
80 * (each virtqueue's affinity is set to the CPU that "owns" the queue).
82 * tgt_seq is held to serialize reading and writing req_vq.
84 * Decrements of reqs are never concurrent with writes of req_vq: before the
85 * decrement reqs will be != 0; after the decrement the virtqueue completion
86 * routine will not use the req_vq so it can be changed by a new request.
87 * Thus they can happen outside the tgt_seq, provided of course we make reqs
90 struct virtio_scsi_target_state {
93 /* Count of outstanding requests. */
96 /* Currently active virtqueue for requests sent to this target. */
97 struct virtio_scsi_vq *req_vq;
100 /* Driver instance state */
102 struct virtio_device *vdev;
104 /* Get some buffers ready for event vq */
105 struct virtio_scsi_event_node event_list[VIRTIO_SCSI_EVENT_LEN];
109 /* If the affinity hint is set for virtqueues */
110 bool affinity_hint_set;
112 struct hlist_node node;
114 /* Protected by event_vq lock */
117 struct virtio_scsi_vq ctrl_vq;
118 struct virtio_scsi_vq event_vq;
119 struct virtio_scsi_vq req_vqs[];
122 static struct kmem_cache *virtscsi_cmd_cache;
123 static mempool_t *virtscsi_cmd_pool;
125 static inline struct Scsi_Host *virtio_scsi_host(struct virtio_device *vdev)
130 static void virtscsi_compute_resid(struct scsi_cmnd *sc, u32 resid)
135 if (!scsi_bidi_cmnd(sc)) {
136 scsi_set_resid(sc, resid);
140 scsi_in(sc)->resid = min(resid, scsi_in(sc)->length);
141 scsi_out(sc)->resid = resid - scsi_in(sc)->resid;
145 * virtscsi_complete_cmd - finish a scsi_cmd and invoke scsi_done
147 * Called with vq_lock held.
149 static void virtscsi_complete_cmd(struct virtio_scsi *vscsi, void *buf)
151 struct virtio_scsi_cmd *cmd = buf;
152 struct scsi_cmnd *sc = cmd->sc;
153 struct virtio_scsi_cmd_resp *resp = &cmd->resp.cmd;
154 struct virtio_scsi_target_state *tgt =
155 scsi_target(sc->device)->hostdata;
157 dev_dbg(&sc->device->sdev_gendev,
158 "cmd %p response %u status %#02x sense_len %u\n",
159 sc, resp->response, resp->status, resp->sense_len);
161 sc->result = resp->status;
162 virtscsi_compute_resid(sc, virtio32_to_cpu(vscsi->vdev, resp->resid));
163 switch (resp->response) {
164 case VIRTIO_SCSI_S_OK:
165 set_host_byte(sc, DID_OK);
167 case VIRTIO_SCSI_S_OVERRUN:
168 set_host_byte(sc, DID_ERROR);
170 case VIRTIO_SCSI_S_ABORTED:
171 set_host_byte(sc, DID_ABORT);
173 case VIRTIO_SCSI_S_BAD_TARGET:
174 set_host_byte(sc, DID_BAD_TARGET);
176 case VIRTIO_SCSI_S_RESET:
177 set_host_byte(sc, DID_RESET);
179 case VIRTIO_SCSI_S_BUSY:
180 set_host_byte(sc, DID_BUS_BUSY);
182 case VIRTIO_SCSI_S_TRANSPORT_FAILURE:
183 set_host_byte(sc, DID_TRANSPORT_DISRUPTED);
185 case VIRTIO_SCSI_S_TARGET_FAILURE:
186 set_host_byte(sc, DID_TARGET_FAILURE);
188 case VIRTIO_SCSI_S_NEXUS_FAILURE:
189 set_host_byte(sc, DID_NEXUS_FAILURE);
192 scmd_printk(KERN_WARNING, sc, "Unknown response %d",
195 case VIRTIO_SCSI_S_FAILURE:
196 set_host_byte(sc, DID_ERROR);
200 WARN_ON(virtio32_to_cpu(vscsi->vdev, resp->sense_len) >
201 VIRTIO_SCSI_SENSE_SIZE);
202 if (sc->sense_buffer) {
203 memcpy(sc->sense_buffer, resp->sense,
205 virtio32_to_cpu(vscsi->vdev, resp->sense_len),
206 VIRTIO_SCSI_SENSE_SIZE));
208 set_driver_byte(sc, DRIVER_SENSE);
213 atomic_dec(&tgt->reqs);
216 static void virtscsi_vq_done(struct virtio_scsi *vscsi,
217 struct virtio_scsi_vq *virtscsi_vq,
218 void (*fn)(struct virtio_scsi *vscsi, void *buf))
223 struct virtqueue *vq = virtscsi_vq->vq;
225 spin_lock_irqsave(&virtscsi_vq->vq_lock, flags);
227 virtqueue_disable_cb(vq);
228 while ((buf = virtqueue_get_buf(vq, &len)) != NULL)
231 if (unlikely(virtqueue_is_broken(vq)))
233 } while (!virtqueue_enable_cb(vq));
234 spin_unlock_irqrestore(&virtscsi_vq->vq_lock, flags);
237 static void virtscsi_req_done(struct virtqueue *vq)
239 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
240 struct virtio_scsi *vscsi = shost_priv(sh);
241 int index = vq->index - VIRTIO_SCSI_VQ_BASE;
242 struct virtio_scsi_vq *req_vq = &vscsi->req_vqs[index];
244 virtscsi_vq_done(vscsi, req_vq, virtscsi_complete_cmd);
247 static void virtscsi_poll_requests(struct virtio_scsi *vscsi)
251 num_vqs = vscsi->num_queues;
252 for (i = 0; i < num_vqs; i++)
253 virtscsi_vq_done(vscsi, &vscsi->req_vqs[i],
254 virtscsi_complete_cmd);
257 static void virtscsi_complete_free(struct virtio_scsi *vscsi, void *buf)
259 struct virtio_scsi_cmd *cmd = buf;
265 static void virtscsi_ctrl_done(struct virtqueue *vq)
267 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
268 struct virtio_scsi *vscsi = shost_priv(sh);
270 virtscsi_vq_done(vscsi, &vscsi->ctrl_vq, virtscsi_complete_free);
273 static void virtscsi_handle_event(struct work_struct *work);
275 static int virtscsi_kick_event(struct virtio_scsi *vscsi,
276 struct virtio_scsi_event_node *event_node)
279 struct scatterlist sg;
282 INIT_WORK(&event_node->work, virtscsi_handle_event);
283 sg_init_one(&sg, &event_node->event, sizeof(struct virtio_scsi_event));
285 spin_lock_irqsave(&vscsi->event_vq.vq_lock, flags);
287 err = virtqueue_add_inbuf(vscsi->event_vq.vq, &sg, 1, event_node,
290 virtqueue_kick(vscsi->event_vq.vq);
292 spin_unlock_irqrestore(&vscsi->event_vq.vq_lock, flags);
297 static int virtscsi_kick_event_all(struct virtio_scsi *vscsi)
301 for (i = 0; i < VIRTIO_SCSI_EVENT_LEN; i++) {
302 vscsi->event_list[i].vscsi = vscsi;
303 virtscsi_kick_event(vscsi, &vscsi->event_list[i]);
309 static void virtscsi_cancel_event_work(struct virtio_scsi *vscsi)
313 /* Stop scheduling work before calling cancel_work_sync. */
314 spin_lock_irq(&vscsi->event_vq.vq_lock);
315 vscsi->stop_events = true;
316 spin_unlock_irq(&vscsi->event_vq.vq_lock);
318 for (i = 0; i < VIRTIO_SCSI_EVENT_LEN; i++)
319 cancel_work_sync(&vscsi->event_list[i].work);
322 static void virtscsi_handle_transport_reset(struct virtio_scsi *vscsi,
323 struct virtio_scsi_event *event)
325 struct scsi_device *sdev;
326 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
327 unsigned int target = event->lun[1];
328 unsigned int lun = (event->lun[2] << 8) | event->lun[3];
330 switch (virtio32_to_cpu(vscsi->vdev, event->reason)) {
331 case VIRTIO_SCSI_EVT_RESET_RESCAN:
332 scsi_add_device(shost, 0, target, lun);
334 case VIRTIO_SCSI_EVT_RESET_REMOVED:
335 sdev = scsi_device_lookup(shost, 0, target, lun);
337 scsi_remove_device(sdev);
338 scsi_device_put(sdev);
340 pr_err("SCSI device %d 0 %d %d not found\n",
341 shost->host_no, target, lun);
345 pr_info("Unsupport virtio scsi event reason %x\n", event->reason);
349 static void virtscsi_handle_param_change(struct virtio_scsi *vscsi,
350 struct virtio_scsi_event *event)
352 struct scsi_device *sdev;
353 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
354 unsigned int target = event->lun[1];
355 unsigned int lun = (event->lun[2] << 8) | event->lun[3];
356 u8 asc = virtio32_to_cpu(vscsi->vdev, event->reason) & 255;
357 u8 ascq = virtio32_to_cpu(vscsi->vdev, event->reason) >> 8;
359 sdev = scsi_device_lookup(shost, 0, target, lun);
361 pr_err("SCSI device %d 0 %d %d not found\n",
362 shost->host_no, target, lun);
366 /* Handle "Parameters changed", "Mode parameters changed", and
367 "Capacity data has changed". */
368 if (asc == 0x2a && (ascq == 0x00 || ascq == 0x01 || ascq == 0x09))
369 scsi_rescan_device(&sdev->sdev_gendev);
371 scsi_device_put(sdev);
374 static void virtscsi_handle_event(struct work_struct *work)
376 struct virtio_scsi_event_node *event_node =
377 container_of(work, struct virtio_scsi_event_node, work);
378 struct virtio_scsi *vscsi = event_node->vscsi;
379 struct virtio_scsi_event *event = &event_node->event;
382 cpu_to_virtio32(vscsi->vdev, VIRTIO_SCSI_T_EVENTS_MISSED)) {
383 event->event &= ~cpu_to_virtio32(vscsi->vdev,
384 VIRTIO_SCSI_T_EVENTS_MISSED);
385 scsi_scan_host(virtio_scsi_host(vscsi->vdev));
388 switch (virtio32_to_cpu(vscsi->vdev, event->event)) {
389 case VIRTIO_SCSI_T_NO_EVENT:
391 case VIRTIO_SCSI_T_TRANSPORT_RESET:
392 virtscsi_handle_transport_reset(vscsi, event);
394 case VIRTIO_SCSI_T_PARAM_CHANGE:
395 virtscsi_handle_param_change(vscsi, event);
398 pr_err("Unsupport virtio scsi event %x\n", event->event);
400 virtscsi_kick_event(vscsi, event_node);
403 static void virtscsi_complete_event(struct virtio_scsi *vscsi, void *buf)
405 struct virtio_scsi_event_node *event_node = buf;
407 if (!vscsi->stop_events)
408 queue_work(system_freezable_wq, &event_node->work);
411 static void virtscsi_event_done(struct virtqueue *vq)
413 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
414 struct virtio_scsi *vscsi = shost_priv(sh);
416 virtscsi_vq_done(vscsi, &vscsi->event_vq, virtscsi_complete_event);
420 * virtscsi_add_cmd - add a virtio_scsi_cmd to a virtqueue
421 * @vq : the struct virtqueue we're talking about
422 * @cmd : command structure
423 * @req_size : size of the request buffer
424 * @resp_size : size of the response buffer
426 static int virtscsi_add_cmd(struct virtqueue *vq,
427 struct virtio_scsi_cmd *cmd,
428 size_t req_size, size_t resp_size)
430 struct scsi_cmnd *sc = cmd->sc;
431 struct scatterlist *sgs[6], req, resp;
432 struct sg_table *out, *in;
433 unsigned out_num = 0, in_num = 0;
437 if (sc && sc->sc_data_direction != DMA_NONE) {
438 if (sc->sc_data_direction != DMA_FROM_DEVICE)
439 out = &scsi_out(sc)->table;
440 if (sc->sc_data_direction != DMA_TO_DEVICE)
441 in = &scsi_in(sc)->table;
444 /* Request header. */
445 sg_init_one(&req, &cmd->req, req_size);
446 sgs[out_num++] = &req;
448 /* Data-out buffer. */
450 /* Place WRITE protection SGLs before Data OUT payload */
451 if (scsi_prot_sg_count(sc))
452 sgs[out_num++] = scsi_prot_sglist(sc);
453 sgs[out_num++] = out->sgl;
456 /* Response header. */
457 sg_init_one(&resp, &cmd->resp, resp_size);
458 sgs[out_num + in_num++] = &resp;
462 /* Place READ protection SGLs before Data IN payload */
463 if (scsi_prot_sg_count(sc))
464 sgs[out_num + in_num++] = scsi_prot_sglist(sc);
465 sgs[out_num + in_num++] = in->sgl;
468 return virtqueue_add_sgs(vq, sgs, out_num, in_num, cmd, GFP_ATOMIC);
471 static int virtscsi_kick_cmd(struct virtio_scsi_vq *vq,
472 struct virtio_scsi_cmd *cmd,
473 size_t req_size, size_t resp_size)
477 bool needs_kick = false;
479 spin_lock_irqsave(&vq->vq_lock, flags);
480 err = virtscsi_add_cmd(vq->vq, cmd, req_size, resp_size);
482 needs_kick = virtqueue_kick_prepare(vq->vq);
484 spin_unlock_irqrestore(&vq->vq_lock, flags);
487 virtqueue_notify(vq->vq);
491 static void virtio_scsi_init_hdr(struct virtio_device *vdev,
492 struct virtio_scsi_cmd_req *cmd,
493 struct scsi_cmnd *sc)
496 cmd->lun[1] = sc->device->id;
497 cmd->lun[2] = (sc->device->lun >> 8) | 0x40;
498 cmd->lun[3] = sc->device->lun & 0xff;
499 cmd->tag = cpu_to_virtio64(vdev, (unsigned long)sc);
500 cmd->task_attr = VIRTIO_SCSI_S_SIMPLE;
505 #ifdef CONFIG_BLK_DEV_INTEGRITY
506 static void virtio_scsi_init_hdr_pi(struct virtio_device *vdev,
507 struct virtio_scsi_cmd_req_pi *cmd_pi,
508 struct scsi_cmnd *sc)
510 struct request *rq = sc->request;
511 struct blk_integrity *bi;
513 virtio_scsi_init_hdr(vdev, (struct virtio_scsi_cmd_req *)cmd_pi, sc);
515 if (!rq || !scsi_prot_sg_count(sc))
518 bi = blk_get_integrity(rq->rq_disk);
520 if (sc->sc_data_direction == DMA_TO_DEVICE)
521 cmd_pi->pi_bytesout = cpu_to_virtio32(vdev,
524 else if (sc->sc_data_direction == DMA_FROM_DEVICE)
525 cmd_pi->pi_bytesin = cpu_to_virtio32(vdev,
531 static int virtscsi_queuecommand(struct virtio_scsi *vscsi,
532 struct virtio_scsi_vq *req_vq,
533 struct scsi_cmnd *sc)
535 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
536 struct virtio_scsi_cmd *cmd = scsi_cmd_priv(sc);
541 BUG_ON(scsi_sg_count(sc) > shost->sg_tablesize);
543 /* TODO: check feature bit and fail if unsupported? */
544 BUG_ON(sc->sc_data_direction == DMA_BIDIRECTIONAL);
546 dev_dbg(&sc->device->sdev_gendev,
547 "cmd %p CDB: %#02x\n", sc, sc->cmnd[0]);
549 memset(cmd, 0, sizeof(*cmd));
552 BUG_ON(sc->cmd_len > VIRTIO_SCSI_CDB_SIZE);
554 #ifdef CONFIG_BLK_DEV_INTEGRITY
555 if (virtio_has_feature(vscsi->vdev, VIRTIO_SCSI_F_T10_PI)) {
556 virtio_scsi_init_hdr_pi(vscsi->vdev, &cmd->req.cmd_pi, sc);
557 memcpy(cmd->req.cmd_pi.cdb, sc->cmnd, sc->cmd_len);
558 req_size = sizeof(cmd->req.cmd_pi);
562 virtio_scsi_init_hdr(vscsi->vdev, &cmd->req.cmd, sc);
563 memcpy(cmd->req.cmd.cdb, sc->cmnd, sc->cmd_len);
564 req_size = sizeof(cmd->req.cmd);
567 ret = virtscsi_kick_cmd(req_vq, cmd, req_size, sizeof(cmd->resp.cmd));
569 cmd->resp.cmd.response = VIRTIO_SCSI_S_BAD_TARGET;
570 spin_lock_irqsave(&req_vq->vq_lock, flags);
571 virtscsi_complete_cmd(vscsi, cmd);
572 spin_unlock_irqrestore(&req_vq->vq_lock, flags);
573 } else if (ret != 0) {
574 return SCSI_MLQUEUE_HOST_BUSY;
579 static int virtscsi_queuecommand_single(struct Scsi_Host *sh,
580 struct scsi_cmnd *sc)
582 struct virtio_scsi *vscsi = shost_priv(sh);
583 struct virtio_scsi_target_state *tgt =
584 scsi_target(sc->device)->hostdata;
586 atomic_inc(&tgt->reqs);
587 return virtscsi_queuecommand(vscsi, &vscsi->req_vqs[0], sc);
590 static struct virtio_scsi_vq *virtscsi_pick_vq_mq(struct virtio_scsi *vscsi,
591 struct scsi_cmnd *sc)
593 u32 tag = blk_mq_unique_tag(sc->request);
594 u16 hwq = blk_mq_unique_tag_to_hwq(tag);
596 return &vscsi->req_vqs[hwq];
599 static struct virtio_scsi_vq *virtscsi_pick_vq(struct virtio_scsi *vscsi,
600 struct virtio_scsi_target_state *tgt)
602 struct virtio_scsi_vq *vq;
606 local_irq_save(flags);
607 if (atomic_inc_return(&tgt->reqs) > 1) {
611 seq = read_seqcount_begin(&tgt->tgt_seq);
613 } while (read_seqcount_retry(&tgt->tgt_seq, seq));
615 /* no writes can be concurrent because of atomic_t */
616 write_seqcount_begin(&tgt->tgt_seq);
618 /* keep previous req_vq if a reader just arrived */
619 if (unlikely(atomic_read(&tgt->reqs) > 1)) {
624 queue_num = smp_processor_id();
625 while (unlikely(queue_num >= vscsi->num_queues))
626 queue_num -= vscsi->num_queues;
627 tgt->req_vq = vq = &vscsi->req_vqs[queue_num];
629 write_seqcount_end(&tgt->tgt_seq);
631 local_irq_restore(flags);
636 static int virtscsi_queuecommand_multi(struct Scsi_Host *sh,
637 struct scsi_cmnd *sc)
639 struct virtio_scsi *vscsi = shost_priv(sh);
640 struct virtio_scsi_target_state *tgt =
641 scsi_target(sc->device)->hostdata;
642 struct virtio_scsi_vq *req_vq;
644 if (shost_use_blk_mq(sh))
645 req_vq = virtscsi_pick_vq_mq(vscsi, sc);
647 req_vq = virtscsi_pick_vq(vscsi, tgt);
649 return virtscsi_queuecommand(vscsi, req_vq, sc);
652 static int virtscsi_tmf(struct virtio_scsi *vscsi, struct virtio_scsi_cmd *cmd)
654 DECLARE_COMPLETION_ONSTACK(comp);
658 if (virtscsi_kick_cmd(&vscsi->ctrl_vq, cmd,
659 sizeof cmd->req.tmf, sizeof cmd->resp.tmf) < 0)
662 wait_for_completion(&comp);
663 if (cmd->resp.tmf.response == VIRTIO_SCSI_S_OK ||
664 cmd->resp.tmf.response == VIRTIO_SCSI_S_FUNCTION_SUCCEEDED)
668 * The spec guarantees that all requests related to the TMF have
669 * been completed, but the callback might not have run yet if
670 * we're using independent interrupts (e.g. MSI). Poll the
673 * In the abort case, sc->scsi_done will do nothing, because
674 * the block layer must have detected a timeout and as a result
675 * REQ_ATOM_COMPLETE has been set.
677 virtscsi_poll_requests(vscsi);
680 mempool_free(cmd, virtscsi_cmd_pool);
684 static int virtscsi_device_reset(struct scsi_cmnd *sc)
686 struct virtio_scsi *vscsi = shost_priv(sc->device->host);
687 struct virtio_scsi_cmd *cmd;
689 sdev_printk(KERN_INFO, sc->device, "device reset\n");
690 cmd = mempool_alloc(virtscsi_cmd_pool, GFP_NOIO);
694 memset(cmd, 0, sizeof(*cmd));
696 cmd->req.tmf = (struct virtio_scsi_ctrl_tmf_req){
697 .type = VIRTIO_SCSI_T_TMF,
698 .subtype = cpu_to_virtio32(vscsi->vdev,
699 VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET),
701 .lun[1] = sc->device->id,
702 .lun[2] = (sc->device->lun >> 8) | 0x40,
703 .lun[3] = sc->device->lun & 0xff,
705 return virtscsi_tmf(vscsi, cmd);
709 * virtscsi_change_queue_depth() - Change a virtscsi target's queue depth
710 * @sdev: Virtscsi target whose queue depth to change
711 * @qdepth: New queue depth
713 static int virtscsi_change_queue_depth(struct scsi_device *sdev, int qdepth)
715 struct Scsi_Host *shost = sdev->host;
716 int max_depth = shost->cmd_per_lun;
718 return scsi_change_queue_depth(sdev, min(max_depth, qdepth));
721 static int virtscsi_abort(struct scsi_cmnd *sc)
723 struct virtio_scsi *vscsi = shost_priv(sc->device->host);
724 struct virtio_scsi_cmd *cmd;
726 scmd_printk(KERN_INFO, sc, "abort\n");
727 cmd = mempool_alloc(virtscsi_cmd_pool, GFP_NOIO);
731 memset(cmd, 0, sizeof(*cmd));
733 cmd->req.tmf = (struct virtio_scsi_ctrl_tmf_req){
734 .type = VIRTIO_SCSI_T_TMF,
735 .subtype = VIRTIO_SCSI_T_TMF_ABORT_TASK,
737 .lun[1] = sc->device->id,
738 .lun[2] = (sc->device->lun >> 8) | 0x40,
739 .lun[3] = sc->device->lun & 0xff,
740 .tag = cpu_to_virtio64(vscsi->vdev, (unsigned long)sc),
742 return virtscsi_tmf(vscsi, cmd);
745 static int virtscsi_target_alloc(struct scsi_target *starget)
747 struct Scsi_Host *sh = dev_to_shost(starget->dev.parent);
748 struct virtio_scsi *vscsi = shost_priv(sh);
750 struct virtio_scsi_target_state *tgt =
751 kmalloc(sizeof(*tgt), GFP_KERNEL);
755 seqcount_init(&tgt->tgt_seq);
756 atomic_set(&tgt->reqs, 0);
757 tgt->req_vq = &vscsi->req_vqs[0];
759 starget->hostdata = tgt;
763 static void virtscsi_target_destroy(struct scsi_target *starget)
765 struct virtio_scsi_target_state *tgt = starget->hostdata;
769 static int virtscsi_map_queues(struct Scsi_Host *shost)
771 struct virtio_scsi *vscsi = shost_priv(shost);
773 return blk_mq_virtio_map_queues(&shost->tag_set, vscsi->vdev, 2);
776 static struct scsi_host_template virtscsi_host_template_single = {
777 .module = THIS_MODULE,
778 .name = "Virtio SCSI HBA",
779 .proc_name = "virtio_scsi",
781 .cmd_size = sizeof(struct virtio_scsi_cmd),
782 .queuecommand = virtscsi_queuecommand_single,
783 .change_queue_depth = virtscsi_change_queue_depth,
784 .eh_abort_handler = virtscsi_abort,
785 .eh_device_reset_handler = virtscsi_device_reset,
788 .dma_boundary = UINT_MAX,
789 .use_clustering = ENABLE_CLUSTERING,
790 .target_alloc = virtscsi_target_alloc,
791 .target_destroy = virtscsi_target_destroy,
792 .track_queue_depth = 1,
795 static struct scsi_host_template virtscsi_host_template_multi = {
796 .module = THIS_MODULE,
797 .name = "Virtio SCSI HBA",
798 .proc_name = "virtio_scsi",
800 .cmd_size = sizeof(struct virtio_scsi_cmd),
801 .queuecommand = virtscsi_queuecommand_multi,
802 .change_queue_depth = virtscsi_change_queue_depth,
803 .eh_abort_handler = virtscsi_abort,
804 .eh_device_reset_handler = virtscsi_device_reset,
807 .dma_boundary = UINT_MAX,
808 .use_clustering = ENABLE_CLUSTERING,
809 .target_alloc = virtscsi_target_alloc,
810 .target_destroy = virtscsi_target_destroy,
811 .map_queues = virtscsi_map_queues,
812 .track_queue_depth = 1,
815 #define virtscsi_config_get(vdev, fld) \
817 typeof(((struct virtio_scsi_config *)0)->fld) __val; \
818 virtio_cread(vdev, struct virtio_scsi_config, fld, &__val); \
822 #define virtscsi_config_set(vdev, fld, val) \
824 typeof(((struct virtio_scsi_config *)0)->fld) __val = (val); \
825 virtio_cwrite(vdev, struct virtio_scsi_config, fld, &__val); \
828 static void virtscsi_init_vq(struct virtio_scsi_vq *virtscsi_vq,
829 struct virtqueue *vq)
831 spin_lock_init(&virtscsi_vq->vq_lock);
832 virtscsi_vq->vq = vq;
835 static void virtscsi_remove_vqs(struct virtio_device *vdev)
837 /* Stop all the virtqueues. */
838 vdev->config->reset(vdev);
839 vdev->config->del_vqs(vdev);
842 static int virtscsi_init(struct virtio_device *vdev,
843 struct virtio_scsi *vscsi)
848 vq_callback_t **callbacks;
850 struct virtqueue **vqs;
851 struct irq_affinity desc = { .pre_vectors = 2 };
853 num_vqs = vscsi->num_queues + VIRTIO_SCSI_VQ_BASE;
854 vqs = kmalloc(num_vqs * sizeof(struct virtqueue *), GFP_KERNEL);
855 callbacks = kmalloc(num_vqs * sizeof(vq_callback_t *), GFP_KERNEL);
856 names = kmalloc(num_vqs * sizeof(char *), GFP_KERNEL);
858 if (!callbacks || !vqs || !names) {
863 callbacks[0] = virtscsi_ctrl_done;
864 callbacks[1] = virtscsi_event_done;
865 names[0] = "control";
867 for (i = VIRTIO_SCSI_VQ_BASE; i < num_vqs; i++) {
868 callbacks[i] = virtscsi_req_done;
869 names[i] = "request";
872 /* Discover virtqueues and write information to configuration. */
873 err = vdev->config->find_vqs(vdev, num_vqs, vqs, callbacks, names,
878 virtscsi_init_vq(&vscsi->ctrl_vq, vqs[0]);
879 virtscsi_init_vq(&vscsi->event_vq, vqs[1]);
880 for (i = VIRTIO_SCSI_VQ_BASE; i < num_vqs; i++)
881 virtscsi_init_vq(&vscsi->req_vqs[i - VIRTIO_SCSI_VQ_BASE],
884 virtscsi_config_set(vdev, cdb_size, VIRTIO_SCSI_CDB_SIZE);
885 virtscsi_config_set(vdev, sense_size, VIRTIO_SCSI_SENSE_SIZE);
894 virtscsi_remove_vqs(vdev);
898 static int virtscsi_probe(struct virtio_device *vdev)
900 struct Scsi_Host *shost;
901 struct virtio_scsi *vscsi;
903 u32 sg_elems, num_targets;
906 struct scsi_host_template *hostt;
908 if (!vdev->config->get) {
909 dev_err(&vdev->dev, "%s failure: config access disabled\n",
914 /* We need to know how many queues before we allocate. */
915 num_queues = virtscsi_config_get(vdev, num_queues) ? : 1;
917 num_targets = virtscsi_config_get(vdev, max_target) + 1;
920 hostt = &virtscsi_host_template_single;
922 hostt = &virtscsi_host_template_multi;
924 shost = scsi_host_alloc(hostt,
925 sizeof(*vscsi) + sizeof(vscsi->req_vqs[0]) * num_queues);
929 sg_elems = virtscsi_config_get(vdev, seg_max) ?: 1;
930 shost->sg_tablesize = sg_elems;
931 vscsi = shost_priv(shost);
933 vscsi->num_queues = num_queues;
936 err = virtscsi_init(vdev, vscsi);
938 goto virtscsi_init_failed;
940 cmd_per_lun = virtscsi_config_get(vdev, cmd_per_lun) ?: 1;
941 shost->cmd_per_lun = min_t(u32, cmd_per_lun, shost->can_queue);
942 shost->max_sectors = virtscsi_config_get(vdev, max_sectors) ?: 0xFFFF;
944 /* LUNs > 256 are reported with format 1, so they go in the range
947 shost->max_lun = virtscsi_config_get(vdev, max_lun) + 1 + 0x4000;
948 shost->max_id = num_targets;
949 shost->max_channel = 0;
950 shost->max_cmd_len = VIRTIO_SCSI_CDB_SIZE;
951 shost->nr_hw_queues = num_queues;
953 #ifdef CONFIG_BLK_DEV_INTEGRITY
954 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_T10_PI)) {
957 host_prot = SHOST_DIF_TYPE1_PROTECTION | SHOST_DIF_TYPE2_PROTECTION |
958 SHOST_DIF_TYPE3_PROTECTION | SHOST_DIX_TYPE1_PROTECTION |
959 SHOST_DIX_TYPE2_PROTECTION | SHOST_DIX_TYPE3_PROTECTION;
961 scsi_host_set_prot(shost, host_prot);
962 scsi_host_set_guard(shost, SHOST_DIX_GUARD_CRC);
966 err = scsi_add_host(shost, &vdev->dev);
968 goto scsi_add_host_failed;
970 virtio_device_ready(vdev);
972 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
973 virtscsi_kick_event_all(vscsi);
975 scsi_scan_host(shost);
978 scsi_add_host_failed:
979 vdev->config->del_vqs(vdev);
980 virtscsi_init_failed:
981 scsi_host_put(shost);
985 static void virtscsi_remove(struct virtio_device *vdev)
987 struct Scsi_Host *shost = virtio_scsi_host(vdev);
988 struct virtio_scsi *vscsi = shost_priv(shost);
990 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
991 virtscsi_cancel_event_work(vscsi);
993 scsi_remove_host(shost);
994 virtscsi_remove_vqs(vdev);
995 scsi_host_put(shost);
998 #ifdef CONFIG_PM_SLEEP
999 static int virtscsi_freeze(struct virtio_device *vdev)
1001 virtscsi_remove_vqs(vdev);
1005 static int virtscsi_restore(struct virtio_device *vdev)
1007 struct Scsi_Host *sh = virtio_scsi_host(vdev);
1008 struct virtio_scsi *vscsi = shost_priv(sh);
1011 err = virtscsi_init(vdev, vscsi);
1015 virtio_device_ready(vdev);
1017 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
1018 virtscsi_kick_event_all(vscsi);
1024 static struct virtio_device_id id_table[] = {
1025 { VIRTIO_ID_SCSI, VIRTIO_DEV_ANY_ID },
1029 static unsigned int features[] = {
1030 VIRTIO_SCSI_F_HOTPLUG,
1031 VIRTIO_SCSI_F_CHANGE,
1032 #ifdef CONFIG_BLK_DEV_INTEGRITY
1033 VIRTIO_SCSI_F_T10_PI,
1037 static struct virtio_driver virtio_scsi_driver = {
1038 .feature_table = features,
1039 .feature_table_size = ARRAY_SIZE(features),
1040 .driver.name = KBUILD_MODNAME,
1041 .driver.owner = THIS_MODULE,
1042 .id_table = id_table,
1043 .probe = virtscsi_probe,
1044 #ifdef CONFIG_PM_SLEEP
1045 .freeze = virtscsi_freeze,
1046 .restore = virtscsi_restore,
1048 .remove = virtscsi_remove,
1051 static int __init init(void)
1055 virtscsi_cmd_cache = KMEM_CACHE(virtio_scsi_cmd, 0);
1056 if (!virtscsi_cmd_cache) {
1057 pr_err("kmem_cache_create() for virtscsi_cmd_cache failed\n");
1063 mempool_create_slab_pool(VIRTIO_SCSI_MEMPOOL_SZ,
1064 virtscsi_cmd_cache);
1065 if (!virtscsi_cmd_pool) {
1066 pr_err("mempool_create() for virtscsi_cmd_pool failed\n");
1069 ret = register_virtio_driver(&virtio_scsi_driver);
1076 if (virtscsi_cmd_pool) {
1077 mempool_destroy(virtscsi_cmd_pool);
1078 virtscsi_cmd_pool = NULL;
1080 if (virtscsi_cmd_cache) {
1081 kmem_cache_destroy(virtscsi_cmd_cache);
1082 virtscsi_cmd_cache = NULL;
1087 static void __exit fini(void)
1089 unregister_virtio_driver(&virtio_scsi_driver);
1090 mempool_destroy(virtscsi_cmd_pool);
1091 kmem_cache_destroy(virtscsi_cmd_cache);
1096 MODULE_DEVICE_TABLE(virtio, id_table);
1097 MODULE_DESCRIPTION("Virtio SCSI HBA driver");
1098 MODULE_LICENSE("GPL");