2 * QEMU VMWARE PVSCSI paravirtual SCSI bus
4 * Copyright (c) 2012 Ravello Systems LTD (http://ravellosystems.com)
6 * Developed by Daynix Computing LTD (http://www.daynix.com)
8 * Based on implementation by Paolo Bonzini
9 * http://lists.gnu.org/archive/html/qemu-devel/2011-08/msg00729.html
16 * This work is licensed under the terms of the GNU GPL, version 2.
17 * See the COPYING file in the top-level directory.
20 * MSI-X support has been removed for the moment because it leads Windows OS
21 * to crash on startup. The crash happens because Windows driver requires
22 * MSI-X shared memory to be part of the same BAR used for rings state
23 * registers, etc. This is not supported by QEMU infrastructure so separate
24 * BAR created from MSI-X purposes. Windows driver fails to deal with 2 BARs.
28 #include "qemu/osdep.h"
29 #include "qapi/error.h"
30 #include "qemu/main-loop.h"
31 #include "qemu/module.h"
32 #include "hw/scsi/scsi.h"
33 #include "migration/vmstate.h"
34 #include "scsi/constants.h"
35 #include "hw/pci/msi.h"
36 #include "vmw_pvscsi.h"
40 #define PVSCSI_USE_64BIT (true)
41 #define PVSCSI_PER_VECTOR_MASK (false)
43 #define PVSCSI_MAX_DEVS (64)
44 #define PVSCSI_MSIX_NUM_VECTORS (1)
46 #define PVSCSI_MAX_SG_ELEM 2048
48 #define PVSCSI_MAX_CMD_DATA_WORDS \
49 (sizeof(PVSCSICmdDescSetupRings)/sizeof(uint32_t))
51 #define RS_GET_FIELD(m, field) \
52 (ldl_le_pci_dma(&container_of(m, PVSCSIState, rings)->parent_obj, \
53 (m)->rs_pa + offsetof(struct PVSCSIRingsState, field)))
54 #define RS_SET_FIELD(m, field, val) \
55 (stl_le_pci_dma(&container_of(m, PVSCSIState, rings)->parent_obj, \
56 (m)->rs_pa + offsetof(struct PVSCSIRingsState, field), val))
58 typedef struct PVSCSIClass {
59 PCIDeviceClass parent_class;
60 DeviceRealize parent_dc_realize;
63 #define TYPE_PVSCSI "pvscsi"
64 #define PVSCSI(obj) OBJECT_CHECK(PVSCSIState, (obj), TYPE_PVSCSI)
66 #define PVSCSI_DEVICE_CLASS(klass) \
67 OBJECT_CLASS_CHECK(PVSCSIClass, (klass), TYPE_PVSCSI)
68 #define PVSCSI_DEVICE_GET_CLASS(obj) \
69 OBJECT_GET_CLASS(PVSCSIClass, (obj), TYPE_PVSCSI)
71 /* Compatibility flags for migration */
72 #define PVSCSI_COMPAT_OLD_PCI_CONFIGURATION_BIT 0
73 #define PVSCSI_COMPAT_OLD_PCI_CONFIGURATION \
74 (1 << PVSCSI_COMPAT_OLD_PCI_CONFIGURATION_BIT)
75 #define PVSCSI_COMPAT_DISABLE_PCIE_BIT 1
76 #define PVSCSI_COMPAT_DISABLE_PCIE \
77 (1 << PVSCSI_COMPAT_DISABLE_PCIE_BIT)
79 #define PVSCSI_USE_OLD_PCI_CONFIGURATION(s) \
80 ((s)->compat_flags & PVSCSI_COMPAT_OLD_PCI_CONFIGURATION)
81 #define PVSCSI_MSI_OFFSET(s) \
82 (PVSCSI_USE_OLD_PCI_CONFIGURATION(s) ? 0x50 : 0x7c)
83 #define PVSCSI_EXP_EP_OFFSET (0x40)
85 typedef struct PVSCSIRingInfo {
87 uint32_t txr_len_mask;
88 uint32_t rxr_len_mask;
89 uint32_t msg_len_mask;
90 uint64_t req_ring_pages_pa[PVSCSI_SETUP_RINGS_MAX_NUM_PAGES];
91 uint64_t cmp_ring_pages_pa[PVSCSI_SETUP_RINGS_MAX_NUM_PAGES];
92 uint64_t msg_ring_pages_pa[PVSCSI_SETUP_MSG_RING_MAX_NUM_PAGES];
93 uint64_t consumed_ptr;
94 uint64_t filled_cmp_ptr;
95 uint64_t filled_msg_ptr;
98 typedef struct PVSCSISGState {
104 typedef QTAILQ_HEAD(, PVSCSIRequest) PVSCSIRequestList;
107 PCIDevice parent_obj;
108 MemoryRegion io_space;
110 QEMUBH *completion_worker;
111 PVSCSIRequestList pending_queue;
112 PVSCSIRequestList completion_queue;
114 uint64_t reg_interrupt_status; /* Interrupt status register value */
115 uint64_t reg_interrupt_enabled; /* Interrupt mask register value */
116 uint64_t reg_command_status; /* Command status register value */
118 /* Command data adoption mechanism */
119 uint64_t curr_cmd; /* Last command arrived */
120 uint32_t curr_cmd_data_cntr; /* Amount of data for last command */
122 /* Collector for current command data */
123 uint32_t curr_cmd_data[PVSCSI_MAX_CMD_DATA_WORDS];
125 uint8_t rings_info_valid; /* Whether data rings initialized */
126 uint8_t msg_ring_info_valid; /* Whether message ring initialized */
127 uint8_t use_msg; /* Whether to use message ring */
129 uint8_t msi_used; /* For migration compatibility */
130 PVSCSIRingInfo rings; /* Data transfer rings manager */
131 uint32_t resetting; /* Reset in progress */
133 uint32_t compat_flags;
136 typedef struct PVSCSIRequest {
144 struct PVSCSIRingReqDesc req;
145 struct PVSCSIRingCmpDesc cmp;
146 QTAILQ_ENTRY(PVSCSIRequest) next;
149 /* Integer binary logarithm */
151 pvscsi_log2(uint32_t input)
155 while (input >> ++log) {
161 pvscsi_ring_init_data(PVSCSIRingInfo *m, PVSCSICmdDescSetupRings *ri)
164 uint32_t txr_len_log2, rxr_len_log2;
165 uint32_t req_ring_size, cmp_ring_size;
166 m->rs_pa = ri->ringsStatePPN << VMW_PAGE_SHIFT;
168 req_ring_size = ri->reqRingNumPages * PVSCSI_MAX_NUM_REQ_ENTRIES_PER_PAGE;
169 cmp_ring_size = ri->cmpRingNumPages * PVSCSI_MAX_NUM_CMP_ENTRIES_PER_PAGE;
170 txr_len_log2 = pvscsi_log2(req_ring_size - 1);
171 rxr_len_log2 = pvscsi_log2(cmp_ring_size - 1);
173 m->txr_len_mask = MASK(txr_len_log2);
174 m->rxr_len_mask = MASK(rxr_len_log2);
177 m->filled_cmp_ptr = 0;
179 for (i = 0; i < ri->reqRingNumPages; i++) {
180 m->req_ring_pages_pa[i] = ri->reqRingPPNs[i] << VMW_PAGE_SHIFT;
183 for (i = 0; i < ri->cmpRingNumPages; i++) {
184 m->cmp_ring_pages_pa[i] = ri->cmpRingPPNs[i] << VMW_PAGE_SHIFT;
187 RS_SET_FIELD(m, reqProdIdx, 0);
188 RS_SET_FIELD(m, reqConsIdx, 0);
189 RS_SET_FIELD(m, reqNumEntriesLog2, txr_len_log2);
191 RS_SET_FIELD(m, cmpProdIdx, 0);
192 RS_SET_FIELD(m, cmpConsIdx, 0);
193 RS_SET_FIELD(m, cmpNumEntriesLog2, rxr_len_log2);
195 trace_pvscsi_ring_init_data(txr_len_log2, rxr_len_log2);
197 /* Flush ring state page changes */
202 pvscsi_ring_init_msg(PVSCSIRingInfo *m, PVSCSICmdDescSetupMsgRing *ri)
208 if (!ri->numPages || ri->numPages > PVSCSI_SETUP_MSG_RING_MAX_NUM_PAGES) {
211 ring_size = ri->numPages * PVSCSI_MAX_NUM_MSG_ENTRIES_PER_PAGE;
212 len_log2 = pvscsi_log2(ring_size - 1);
214 m->msg_len_mask = MASK(len_log2);
216 m->filled_msg_ptr = 0;
218 for (i = 0; i < ri->numPages; i++) {
219 m->msg_ring_pages_pa[i] = ri->ringPPNs[i] << VMW_PAGE_SHIFT;
222 RS_SET_FIELD(m, msgProdIdx, 0);
223 RS_SET_FIELD(m, msgConsIdx, 0);
224 RS_SET_FIELD(m, msgNumEntriesLog2, len_log2);
226 trace_pvscsi_ring_init_msg(len_log2);
228 /* Flush ring state page changes */
235 pvscsi_ring_cleanup(PVSCSIRingInfo *mgr)
238 mgr->txr_len_mask = 0;
239 mgr->rxr_len_mask = 0;
240 mgr->msg_len_mask = 0;
241 mgr->consumed_ptr = 0;
242 mgr->filled_cmp_ptr = 0;
243 mgr->filled_msg_ptr = 0;
244 memset(mgr->req_ring_pages_pa, 0, sizeof(mgr->req_ring_pages_pa));
245 memset(mgr->cmp_ring_pages_pa, 0, sizeof(mgr->cmp_ring_pages_pa));
246 memset(mgr->msg_ring_pages_pa, 0, sizeof(mgr->msg_ring_pages_pa));
250 pvscsi_ring_pop_req_descr(PVSCSIRingInfo *mgr)
252 uint32_t ready_ptr = RS_GET_FIELD(mgr, reqProdIdx);
253 uint32_t ring_size = PVSCSI_MAX_NUM_PAGES_REQ_RING
254 * PVSCSI_MAX_NUM_REQ_ENTRIES_PER_PAGE;
256 if (ready_ptr != mgr->consumed_ptr
257 && ready_ptr - mgr->consumed_ptr < ring_size) {
258 uint32_t next_ready_ptr =
259 mgr->consumed_ptr++ & mgr->txr_len_mask;
260 uint32_t next_ready_page =
261 next_ready_ptr / PVSCSI_MAX_NUM_REQ_ENTRIES_PER_PAGE;
262 uint32_t inpage_idx =
263 next_ready_ptr % PVSCSI_MAX_NUM_REQ_ENTRIES_PER_PAGE;
265 return mgr->req_ring_pages_pa[next_ready_page] +
266 inpage_idx * sizeof(PVSCSIRingReqDesc);
273 pvscsi_ring_flush_req(PVSCSIRingInfo *mgr)
275 RS_SET_FIELD(mgr, reqConsIdx, mgr->consumed_ptr);
279 pvscsi_ring_pop_cmp_descr(PVSCSIRingInfo *mgr)
282 * According to Linux driver code it explicitly verifies that number
283 * of requests being processed by device is less then the size of
284 * completion queue, so device may omit completion queue overflow
285 * conditions check. We assume that this is true for other (Windows)
289 uint32_t free_cmp_ptr =
290 mgr->filled_cmp_ptr++ & mgr->rxr_len_mask;
291 uint32_t free_cmp_page =
292 free_cmp_ptr / PVSCSI_MAX_NUM_CMP_ENTRIES_PER_PAGE;
293 uint32_t inpage_idx =
294 free_cmp_ptr % PVSCSI_MAX_NUM_CMP_ENTRIES_PER_PAGE;
295 return mgr->cmp_ring_pages_pa[free_cmp_page] +
296 inpage_idx * sizeof(PVSCSIRingCmpDesc);
300 pvscsi_ring_pop_msg_descr(PVSCSIRingInfo *mgr)
302 uint32_t free_msg_ptr =
303 mgr->filled_msg_ptr++ & mgr->msg_len_mask;
304 uint32_t free_msg_page =
305 free_msg_ptr / PVSCSI_MAX_NUM_MSG_ENTRIES_PER_PAGE;
306 uint32_t inpage_idx =
307 free_msg_ptr % PVSCSI_MAX_NUM_MSG_ENTRIES_PER_PAGE;
308 return mgr->msg_ring_pages_pa[free_msg_page] +
309 inpage_idx * sizeof(PVSCSIRingMsgDesc);
313 pvscsi_ring_flush_cmp(PVSCSIRingInfo *mgr)
315 /* Flush descriptor changes */
318 trace_pvscsi_ring_flush_cmp(mgr->filled_cmp_ptr);
320 RS_SET_FIELD(mgr, cmpProdIdx, mgr->filled_cmp_ptr);
324 pvscsi_ring_msg_has_room(PVSCSIRingInfo *mgr)
326 uint32_t prodIdx = RS_GET_FIELD(mgr, msgProdIdx);
327 uint32_t consIdx = RS_GET_FIELD(mgr, msgConsIdx);
329 return (prodIdx - consIdx) < (mgr->msg_len_mask + 1);
333 pvscsi_ring_flush_msg(PVSCSIRingInfo *mgr)
335 /* Flush descriptor changes */
338 trace_pvscsi_ring_flush_msg(mgr->filled_msg_ptr);
340 RS_SET_FIELD(mgr, msgProdIdx, mgr->filled_msg_ptr);
344 pvscsi_reset_state(PVSCSIState *s)
346 s->curr_cmd = PVSCSI_CMD_FIRST;
347 s->curr_cmd_data_cntr = 0;
348 s->reg_command_status = PVSCSI_COMMAND_PROCESSING_SUCCEEDED;
349 s->reg_interrupt_status = 0;
350 pvscsi_ring_cleanup(&s->rings);
351 s->rings_info_valid = FALSE;
352 s->msg_ring_info_valid = FALSE;
353 QTAILQ_INIT(&s->pending_queue);
354 QTAILQ_INIT(&s->completion_queue);
358 pvscsi_update_irq_status(PVSCSIState *s)
360 PCIDevice *d = PCI_DEVICE(s);
361 bool should_raise = s->reg_interrupt_enabled & s->reg_interrupt_status;
363 trace_pvscsi_update_irq_level(should_raise, s->reg_interrupt_enabled,
364 s->reg_interrupt_status);
366 if (msi_enabled(d)) {
368 trace_pvscsi_update_irq_msi();
369 msi_notify(d, PVSCSI_VECTOR_COMPLETION);
374 pci_set_irq(d, !!should_raise);
378 pvscsi_raise_completion_interrupt(PVSCSIState *s)
380 s->reg_interrupt_status |= PVSCSI_INTR_CMPL_0;
382 /* Memory barrier to flush interrupt status register changes*/
385 pvscsi_update_irq_status(s);
389 pvscsi_raise_message_interrupt(PVSCSIState *s)
391 s->reg_interrupt_status |= PVSCSI_INTR_MSG_0;
393 /* Memory barrier to flush interrupt status register changes*/
396 pvscsi_update_irq_status(s);
400 pvscsi_cmp_ring_put(PVSCSIState *s, struct PVSCSIRingCmpDesc *cmp_desc)
404 cmp_descr_pa = pvscsi_ring_pop_cmp_descr(&s->rings);
405 trace_pvscsi_cmp_ring_put(cmp_descr_pa);
406 cpu_physical_memory_write(cmp_descr_pa, (void *)cmp_desc,
411 pvscsi_msg_ring_put(PVSCSIState *s, struct PVSCSIRingMsgDesc *msg_desc)
415 msg_descr_pa = pvscsi_ring_pop_msg_descr(&s->rings);
416 trace_pvscsi_msg_ring_put(msg_descr_pa);
417 cpu_physical_memory_write(msg_descr_pa, (void *)msg_desc,
422 pvscsi_process_completion_queue(void *opaque)
424 PVSCSIState *s = opaque;
425 PVSCSIRequest *pvscsi_req;
426 bool has_completed = false;
428 while (!QTAILQ_EMPTY(&s->completion_queue)) {
429 pvscsi_req = QTAILQ_FIRST(&s->completion_queue);
430 QTAILQ_REMOVE(&s->completion_queue, pvscsi_req, next);
431 pvscsi_cmp_ring_put(s, &pvscsi_req->cmp);
433 has_completed = true;
437 pvscsi_ring_flush_cmp(&s->rings);
438 pvscsi_raise_completion_interrupt(s);
443 pvscsi_reset_adapter(PVSCSIState *s)
446 qbus_reset_all(BUS(&s->bus));
448 pvscsi_process_completion_queue(s);
449 assert(QTAILQ_EMPTY(&s->pending_queue));
450 pvscsi_reset_state(s);
454 pvscsi_schedule_completion_processing(PVSCSIState *s)
456 /* Try putting more complete requests on the ring. */
457 if (!QTAILQ_EMPTY(&s->completion_queue)) {
458 qemu_bh_schedule(s->completion_worker);
463 pvscsi_complete_request(PVSCSIState *s, PVSCSIRequest *r)
465 assert(!r->completed);
467 trace_pvscsi_complete_request(r->cmp.context, r->cmp.dataLen,
469 if (r->sreq != NULL) {
470 scsi_req_unref(r->sreq);
474 QTAILQ_REMOVE(&s->pending_queue, r, next);
475 QTAILQ_INSERT_TAIL(&s->completion_queue, r, next);
476 pvscsi_schedule_completion_processing(s);
479 static QEMUSGList *pvscsi_get_sg_list(SCSIRequest *r)
481 PVSCSIRequest *req = r->hba_private;
483 trace_pvscsi_get_sg_list(req->sgl.nsg, req->sgl.size);
489 pvscsi_get_next_sg_elem(PVSCSISGState *sg)
491 struct PVSCSISGElement elem;
493 cpu_physical_memory_read(sg->elemAddr, (void *)&elem, sizeof(elem));
494 if ((elem.flags & ~PVSCSI_KNOWN_FLAGS) != 0) {
496 * There is PVSCSI_SGE_FLAG_CHAIN_ELEMENT flag described in
497 * header file but its value is unknown. This flag requires
498 * additional processing, so we put warning here to catch it
499 * some day and make proper implementation
501 trace_pvscsi_get_next_sg_elem(elem.flags);
504 sg->elemAddr += sizeof(elem);
505 sg->dataAddr = elem.addr;
506 sg->resid = elem.length;
510 pvscsi_write_sense(PVSCSIRequest *r, uint8_t *sense, int len)
512 r->cmp.senseLen = MIN(r->req.senseLen, len);
513 r->sense_key = sense[(sense[0] & 2) ? 1 : 2];
514 cpu_physical_memory_write(r->req.senseAddr, sense, r->cmp.senseLen);
518 pvscsi_command_complete(SCSIRequest *req, uint32_t status, size_t resid)
520 PVSCSIRequest *pvscsi_req = req->hba_private;
524 trace_pvscsi_command_complete_not_found(req->tag);
530 /* Short transfer. */
531 trace_pvscsi_command_complete_data_run();
532 pvscsi_req->cmp.hostStatus = BTSTAT_DATARUN;
535 pvscsi_req->cmp.scsiStatus = status;
536 if (pvscsi_req->cmp.scsiStatus == CHECK_CONDITION) {
537 uint8_t sense[SCSI_SENSE_BUF_SIZE];
539 scsi_req_get_sense(pvscsi_req->sreq, sense, sizeof(sense));
541 trace_pvscsi_command_complete_sense_len(sense_len);
542 pvscsi_write_sense(pvscsi_req, sense, sense_len);
544 qemu_sglist_destroy(&pvscsi_req->sgl);
545 pvscsi_complete_request(s, pvscsi_req);
549 pvscsi_send_msg(PVSCSIState *s, SCSIDevice *dev, uint32_t msg_type)
551 if (s->msg_ring_info_valid && pvscsi_ring_msg_has_room(&s->rings)) {
552 PVSCSIMsgDescDevStatusChanged msg = {0};
555 msg.bus = dev->channel;
556 msg.target = dev->id;
557 msg.lun[1] = dev->lun;
559 pvscsi_msg_ring_put(s, (PVSCSIRingMsgDesc *)&msg);
560 pvscsi_ring_flush_msg(&s->rings);
561 pvscsi_raise_message_interrupt(s);
566 pvscsi_hotplug(HotplugHandler *hotplug_dev, DeviceState *dev, Error **errp)
568 PVSCSIState *s = PVSCSI(hotplug_dev);
570 pvscsi_send_msg(s, SCSI_DEVICE(dev), PVSCSI_MSG_DEV_ADDED);
574 pvscsi_hot_unplug(HotplugHandler *hotplug_dev, DeviceState *dev, Error **errp)
576 PVSCSIState *s = PVSCSI(hotplug_dev);
578 pvscsi_send_msg(s, SCSI_DEVICE(dev), PVSCSI_MSG_DEV_REMOVED);
579 qdev_simple_device_unplug_cb(hotplug_dev, dev, errp);
583 pvscsi_request_cancelled(SCSIRequest *req)
585 PVSCSIRequest *pvscsi_req = req->hba_private;
586 PVSCSIState *s = pvscsi_req->dev;
588 if (pvscsi_req->completed) {
592 if (pvscsi_req->dev->resetting) {
593 pvscsi_req->cmp.hostStatus = BTSTAT_BUSRESET;
595 pvscsi_req->cmp.hostStatus = BTSTAT_ABORTQUEUE;
598 pvscsi_complete_request(s, pvscsi_req);
602 pvscsi_device_find(PVSCSIState *s, int channel, int target,
603 uint8_t *requested_lun, uint8_t *target_lun)
605 if (requested_lun[0] || requested_lun[2] || requested_lun[3] ||
606 requested_lun[4] || requested_lun[5] || requested_lun[6] ||
607 requested_lun[7] || (target > PVSCSI_MAX_DEVS)) {
610 *target_lun = requested_lun[1];
611 return scsi_device_find(&s->bus, channel, target, *target_lun);
615 static PVSCSIRequest *
616 pvscsi_queue_pending_descriptor(PVSCSIState *s, SCSIDevice **d,
617 struct PVSCSIRingReqDesc *descr)
619 PVSCSIRequest *pvscsi_req;
622 pvscsi_req = g_malloc0(sizeof(*pvscsi_req));
624 pvscsi_req->req = *descr;
625 pvscsi_req->cmp.context = pvscsi_req->req.context;
626 QTAILQ_INSERT_TAIL(&s->pending_queue, pvscsi_req, next);
628 *d = pvscsi_device_find(s, descr->bus, descr->target, descr->lun, &lun);
630 pvscsi_req->lun = lun;
637 pvscsi_convert_sglist(PVSCSIRequest *r)
639 uint32_t chunk_size, elmcnt = 0;
640 uint64_t data_length = r->req.dataLen;
641 PVSCSISGState sg = r->sg;
642 while (data_length && elmcnt < PVSCSI_MAX_SG_ELEM) {
643 while (!sg.resid && elmcnt++ < PVSCSI_MAX_SG_ELEM) {
644 pvscsi_get_next_sg_elem(&sg);
645 trace_pvscsi_convert_sglist(r->req.context, r->sg.dataAddr,
648 chunk_size = MIN(data_length, sg.resid);
650 qemu_sglist_add(&r->sgl, sg.dataAddr, chunk_size);
653 sg.dataAddr += chunk_size;
654 data_length -= chunk_size;
655 sg.resid -= chunk_size;
660 pvscsi_build_sglist(PVSCSIState *s, PVSCSIRequest *r)
662 PCIDevice *d = PCI_DEVICE(s);
664 pci_dma_sglist_init(&r->sgl, d, 1);
665 if (r->req.flags & PVSCSI_FLAG_CMD_WITH_SG_LIST) {
666 pvscsi_convert_sglist(r);
668 qemu_sglist_add(&r->sgl, r->req.dataAddr, r->req.dataLen);
673 pvscsi_process_request_descriptor(PVSCSIState *s,
674 struct PVSCSIRingReqDesc *descr)
677 PVSCSIRequest *r = pvscsi_queue_pending_descriptor(s, &d, descr);
680 trace_pvscsi_process_req_descr(descr->cdb[0], descr->context);
683 r->cmp.hostStatus = BTSTAT_SELTIMEO;
684 trace_pvscsi_process_req_descr_unknown_device();
685 pvscsi_complete_request(s, r);
689 if (descr->flags & PVSCSI_FLAG_CMD_WITH_SG_LIST) {
690 r->sg.elemAddr = descr->dataAddr;
693 r->sreq = scsi_req_new(d, descr->context, r->lun, descr->cdb, r);
694 if (r->sreq->cmd.mode == SCSI_XFER_FROM_DEV &&
695 (descr->flags & PVSCSI_FLAG_CMD_DIR_TODEVICE)) {
696 r->cmp.hostStatus = BTSTAT_BADMSG;
697 trace_pvscsi_process_req_descr_invalid_dir();
698 scsi_req_cancel(r->sreq);
701 if (r->sreq->cmd.mode == SCSI_XFER_TO_DEV &&
702 (descr->flags & PVSCSI_FLAG_CMD_DIR_TOHOST)) {
703 r->cmp.hostStatus = BTSTAT_BADMSG;
704 trace_pvscsi_process_req_descr_invalid_dir();
705 scsi_req_cancel(r->sreq);
709 pvscsi_build_sglist(s, r);
710 n = scsi_req_enqueue(r->sreq);
713 scsi_req_continue(r->sreq);
718 pvscsi_process_io(PVSCSIState *s)
720 PVSCSIRingReqDesc descr;
721 hwaddr next_descr_pa;
723 assert(s->rings_info_valid);
724 while ((next_descr_pa = pvscsi_ring_pop_req_descr(&s->rings)) != 0) {
726 /* Only read after production index verification */
729 trace_pvscsi_process_io(next_descr_pa);
730 cpu_physical_memory_read(next_descr_pa, &descr, sizeof(descr));
731 pvscsi_process_request_descriptor(s, &descr);
734 pvscsi_ring_flush_req(&s->rings);
738 pvscsi_dbg_dump_tx_rings_config(PVSCSICmdDescSetupRings *rc)
741 trace_pvscsi_tx_rings_ppn("Rings State", rc->ringsStatePPN);
743 trace_pvscsi_tx_rings_num_pages("Request Ring", rc->reqRingNumPages);
744 for (i = 0; i < rc->reqRingNumPages; i++) {
745 trace_pvscsi_tx_rings_ppn("Request Ring", rc->reqRingPPNs[i]);
748 trace_pvscsi_tx_rings_num_pages("Confirm Ring", rc->cmpRingNumPages);
749 for (i = 0; i < rc->cmpRingNumPages; i++) {
750 trace_pvscsi_tx_rings_ppn("Confirm Ring", rc->cmpRingPPNs[i]);
755 pvscsi_on_cmd_config(PVSCSIState *s)
757 trace_pvscsi_on_cmd_noimpl("PVSCSI_CMD_CONFIG");
758 return PVSCSI_COMMAND_PROCESSING_FAILED;
762 pvscsi_on_cmd_unplug(PVSCSIState *s)
764 trace_pvscsi_on_cmd_noimpl("PVSCSI_CMD_DEVICE_UNPLUG");
765 return PVSCSI_COMMAND_PROCESSING_FAILED;
769 pvscsi_on_issue_scsi(PVSCSIState *s)
771 trace_pvscsi_on_cmd_noimpl("PVSCSI_CMD_ISSUE_SCSI");
772 return PVSCSI_COMMAND_PROCESSING_FAILED;
776 pvscsi_on_cmd_setup_rings(PVSCSIState *s)
778 PVSCSICmdDescSetupRings *rc =
779 (PVSCSICmdDescSetupRings *) s->curr_cmd_data;
781 trace_pvscsi_on_cmd_arrived("PVSCSI_CMD_SETUP_RINGS");
783 if (!rc->reqRingNumPages
784 || rc->reqRingNumPages > PVSCSI_SETUP_RINGS_MAX_NUM_PAGES
785 || !rc->cmpRingNumPages
786 || rc->cmpRingNumPages > PVSCSI_SETUP_RINGS_MAX_NUM_PAGES) {
787 return PVSCSI_COMMAND_PROCESSING_FAILED;
790 pvscsi_dbg_dump_tx_rings_config(rc);
791 pvscsi_ring_init_data(&s->rings, rc);
793 s->rings_info_valid = TRUE;
794 return PVSCSI_COMMAND_PROCESSING_SUCCEEDED;
798 pvscsi_on_cmd_abort(PVSCSIState *s)
800 PVSCSICmdDescAbortCmd *cmd = (PVSCSICmdDescAbortCmd *) s->curr_cmd_data;
801 PVSCSIRequest *r, *next;
803 trace_pvscsi_on_cmd_abort(cmd->context, cmd->target);
805 QTAILQ_FOREACH_SAFE(r, &s->pending_queue, next, next) {
806 if (r->req.context == cmd->context) {
811 assert(!r->completed);
812 r->cmp.hostStatus = BTSTAT_ABORTQUEUE;
813 scsi_req_cancel(r->sreq);
816 return PVSCSI_COMMAND_PROCESSING_SUCCEEDED;
820 pvscsi_on_cmd_unknown(PVSCSIState *s)
822 trace_pvscsi_on_cmd_unknown_data(s->curr_cmd_data[0]);
823 return PVSCSI_COMMAND_PROCESSING_FAILED;
827 pvscsi_on_cmd_reset_device(PVSCSIState *s)
829 uint8_t target_lun = 0;
830 struct PVSCSICmdDescResetDevice *cmd =
831 (struct PVSCSICmdDescResetDevice *) s->curr_cmd_data;
834 sdev = pvscsi_device_find(s, 0, cmd->target, cmd->lun, &target_lun);
836 trace_pvscsi_on_cmd_reset_dev(cmd->target, (int) target_lun, sdev);
840 device_reset(&sdev->qdev);
842 return PVSCSI_COMMAND_PROCESSING_SUCCEEDED;
845 return PVSCSI_COMMAND_PROCESSING_FAILED;
849 pvscsi_on_cmd_reset_bus(PVSCSIState *s)
851 trace_pvscsi_on_cmd_arrived("PVSCSI_CMD_RESET_BUS");
854 qbus_reset_all(BUS(&s->bus));
856 return PVSCSI_COMMAND_PROCESSING_SUCCEEDED;
860 pvscsi_on_cmd_setup_msg_ring(PVSCSIState *s)
862 PVSCSICmdDescSetupMsgRing *rc =
863 (PVSCSICmdDescSetupMsgRing *) s->curr_cmd_data;
865 trace_pvscsi_on_cmd_arrived("PVSCSI_CMD_SETUP_MSG_RING");
868 return PVSCSI_COMMAND_PROCESSING_FAILED;
871 if (s->rings_info_valid) {
872 if (pvscsi_ring_init_msg(&s->rings, rc) < 0) {
873 return PVSCSI_COMMAND_PROCESSING_FAILED;
875 s->msg_ring_info_valid = TRUE;
877 return sizeof(PVSCSICmdDescSetupMsgRing) / sizeof(uint32_t);
881 pvscsi_on_cmd_adapter_reset(PVSCSIState *s)
883 trace_pvscsi_on_cmd_arrived("PVSCSI_CMD_ADAPTER_RESET");
885 pvscsi_reset_adapter(s);
886 return PVSCSI_COMMAND_PROCESSING_SUCCEEDED;
889 static const struct {
891 uint64_t (*handler_fn)(PVSCSIState *s);
892 } pvscsi_commands[] = {
893 [PVSCSI_CMD_FIRST] = {
895 .handler_fn = pvscsi_on_cmd_unknown,
898 /* Not implemented, data size defined based on what arrives on windows */
899 [PVSCSI_CMD_CONFIG] = {
900 .data_size = 6 * sizeof(uint32_t),
901 .handler_fn = pvscsi_on_cmd_config,
904 /* Command not implemented, data size is unknown */
905 [PVSCSI_CMD_ISSUE_SCSI] = {
907 .handler_fn = pvscsi_on_issue_scsi,
910 /* Command not implemented, data size is unknown */
911 [PVSCSI_CMD_DEVICE_UNPLUG] = {
913 .handler_fn = pvscsi_on_cmd_unplug,
916 [PVSCSI_CMD_SETUP_RINGS] = {
917 .data_size = sizeof(PVSCSICmdDescSetupRings),
918 .handler_fn = pvscsi_on_cmd_setup_rings,
921 [PVSCSI_CMD_RESET_DEVICE] = {
922 .data_size = sizeof(struct PVSCSICmdDescResetDevice),
923 .handler_fn = pvscsi_on_cmd_reset_device,
926 [PVSCSI_CMD_RESET_BUS] = {
928 .handler_fn = pvscsi_on_cmd_reset_bus,
931 [PVSCSI_CMD_SETUP_MSG_RING] = {
932 .data_size = sizeof(PVSCSICmdDescSetupMsgRing),
933 .handler_fn = pvscsi_on_cmd_setup_msg_ring,
936 [PVSCSI_CMD_ADAPTER_RESET] = {
938 .handler_fn = pvscsi_on_cmd_adapter_reset,
941 [PVSCSI_CMD_ABORT_CMD] = {
942 .data_size = sizeof(struct PVSCSICmdDescAbortCmd),
943 .handler_fn = pvscsi_on_cmd_abort,
948 pvscsi_do_command_processing(PVSCSIState *s)
950 size_t bytes_arrived = s->curr_cmd_data_cntr * sizeof(uint32_t);
952 assert(s->curr_cmd < PVSCSI_CMD_LAST);
953 if (bytes_arrived >= pvscsi_commands[s->curr_cmd].data_size) {
954 s->reg_command_status = pvscsi_commands[s->curr_cmd].handler_fn(s);
955 s->curr_cmd = PVSCSI_CMD_FIRST;
956 s->curr_cmd_data_cntr = 0;
961 pvscsi_on_command_data(PVSCSIState *s, uint32_t value)
963 size_t bytes_arrived = s->curr_cmd_data_cntr * sizeof(uint32_t);
965 assert(bytes_arrived < sizeof(s->curr_cmd_data));
966 s->curr_cmd_data[s->curr_cmd_data_cntr++] = value;
968 pvscsi_do_command_processing(s);
972 pvscsi_on_command(PVSCSIState *s, uint64_t cmd_id)
974 if ((cmd_id > PVSCSI_CMD_FIRST) && (cmd_id < PVSCSI_CMD_LAST)) {
975 s->curr_cmd = cmd_id;
977 s->curr_cmd = PVSCSI_CMD_FIRST;
978 trace_pvscsi_on_cmd_unknown(cmd_id);
981 s->curr_cmd_data_cntr = 0;
982 s->reg_command_status = PVSCSI_COMMAND_NOT_ENOUGH_DATA;
984 pvscsi_do_command_processing(s);
988 pvscsi_io_write(void *opaque, hwaddr addr,
989 uint64_t val, unsigned size)
991 PVSCSIState *s = opaque;
994 case PVSCSI_REG_OFFSET_COMMAND:
995 pvscsi_on_command(s, val);
998 case PVSCSI_REG_OFFSET_COMMAND_DATA:
999 pvscsi_on_command_data(s, (uint32_t) val);
1002 case PVSCSI_REG_OFFSET_INTR_STATUS:
1003 trace_pvscsi_io_write("PVSCSI_REG_OFFSET_INTR_STATUS", val);
1004 s->reg_interrupt_status &= ~val;
1005 pvscsi_update_irq_status(s);
1006 pvscsi_schedule_completion_processing(s);
1009 case PVSCSI_REG_OFFSET_INTR_MASK:
1010 trace_pvscsi_io_write("PVSCSI_REG_OFFSET_INTR_MASK", val);
1011 s->reg_interrupt_enabled = val;
1012 pvscsi_update_irq_status(s);
1015 case PVSCSI_REG_OFFSET_KICK_NON_RW_IO:
1016 trace_pvscsi_io_write("PVSCSI_REG_OFFSET_KICK_NON_RW_IO", val);
1017 pvscsi_process_io(s);
1020 case PVSCSI_REG_OFFSET_KICK_RW_IO:
1021 trace_pvscsi_io_write("PVSCSI_REG_OFFSET_KICK_RW_IO", val);
1022 pvscsi_process_io(s);
1025 case PVSCSI_REG_OFFSET_DEBUG:
1026 trace_pvscsi_io_write("PVSCSI_REG_OFFSET_DEBUG", val);
1030 trace_pvscsi_io_write_unknown(addr, size, val);
1037 pvscsi_io_read(void *opaque, hwaddr addr, unsigned size)
1039 PVSCSIState *s = opaque;
1042 case PVSCSI_REG_OFFSET_INTR_STATUS:
1043 trace_pvscsi_io_read("PVSCSI_REG_OFFSET_INTR_STATUS",
1044 s->reg_interrupt_status);
1045 return s->reg_interrupt_status;
1047 case PVSCSI_REG_OFFSET_INTR_MASK:
1048 trace_pvscsi_io_read("PVSCSI_REG_OFFSET_INTR_MASK",
1049 s->reg_interrupt_status);
1050 return s->reg_interrupt_enabled;
1052 case PVSCSI_REG_OFFSET_COMMAND_STATUS:
1053 trace_pvscsi_io_read("PVSCSI_REG_OFFSET_COMMAND_STATUS",
1054 s->reg_interrupt_status);
1055 return s->reg_command_status;
1058 trace_pvscsi_io_read_unknown(addr, size);
1065 pvscsi_init_msi(PVSCSIState *s)
1068 PCIDevice *d = PCI_DEVICE(s);
1070 res = msi_init(d, PVSCSI_MSI_OFFSET(s), PVSCSI_MSIX_NUM_VECTORS,
1071 PVSCSI_USE_64BIT, PVSCSI_PER_VECTOR_MASK, NULL);
1073 trace_pvscsi_init_msi_fail(res);
1074 s->msi_used = false;
1081 pvscsi_cleanup_msi(PVSCSIState *s)
1083 PCIDevice *d = PCI_DEVICE(s);
1088 static const MemoryRegionOps pvscsi_ops = {
1089 .read = pvscsi_io_read,
1090 .write = pvscsi_io_write,
1091 .endianness = DEVICE_LITTLE_ENDIAN,
1093 .min_access_size = 4,
1094 .max_access_size = 4,
1098 static const struct SCSIBusInfo pvscsi_scsi_info = {
1100 .max_target = PVSCSI_MAX_DEVS,
1104 .get_sg_list = pvscsi_get_sg_list,
1105 .complete = pvscsi_command_complete,
1106 .cancel = pvscsi_request_cancelled,
1110 pvscsi_realizefn(PCIDevice *pci_dev, Error **errp)
1112 PVSCSIState *s = PVSCSI(pci_dev);
1114 trace_pvscsi_state("init");
1116 /* PCI subsystem ID, subsystem vendor ID, revision */
1117 if (PVSCSI_USE_OLD_PCI_CONFIGURATION(s)) {
1118 pci_set_word(pci_dev->config + PCI_SUBSYSTEM_ID, 0x1000);
1120 pci_set_word(pci_dev->config + PCI_SUBSYSTEM_VENDOR_ID,
1121 PCI_VENDOR_ID_VMWARE);
1122 pci_set_word(pci_dev->config + PCI_SUBSYSTEM_ID,
1123 PCI_DEVICE_ID_VMWARE_PVSCSI);
1124 pci_config_set_revision(pci_dev->config, 0x2);
1127 /* PCI latency timer = 255 */
1128 pci_dev->config[PCI_LATENCY_TIMER] = 0xff;
1130 /* Interrupt pin A */
1131 pci_config_set_interrupt_pin(pci_dev->config, 1);
1133 memory_region_init_io(&s->io_space, OBJECT(s), &pvscsi_ops, s,
1134 "pvscsi-io", PVSCSI_MEM_SPACE_SIZE);
1135 pci_register_bar(pci_dev, 0, PCI_BASE_ADDRESS_SPACE_MEMORY, &s->io_space);
1139 if (pci_is_express(pci_dev) && pci_bus_is_express(pci_get_bus(pci_dev))) {
1140 pcie_endpoint_cap_init(pci_dev, PVSCSI_EXP_EP_OFFSET);
1143 s->completion_worker = qemu_bh_new(pvscsi_process_completion_queue, s);
1145 scsi_bus_new(&s->bus, sizeof(s->bus), DEVICE(pci_dev),
1146 &pvscsi_scsi_info, NULL);
1147 /* override default SCSI bus hotplug-handler, with pvscsi's one */
1148 qbus_set_hotplug_handler(BUS(&s->bus), OBJECT(s), &error_abort);
1149 pvscsi_reset_state(s);
1153 pvscsi_uninit(PCIDevice *pci_dev)
1155 PVSCSIState *s = PVSCSI(pci_dev);
1157 trace_pvscsi_state("uninit");
1158 qemu_bh_delete(s->completion_worker);
1160 pvscsi_cleanup_msi(s);
1164 pvscsi_reset(DeviceState *dev)
1166 PCIDevice *d = PCI_DEVICE(dev);
1167 PVSCSIState *s = PVSCSI(d);
1169 trace_pvscsi_state("reset");
1170 pvscsi_reset_adapter(s);
1174 pvscsi_pre_save(void *opaque)
1176 PVSCSIState *s = (PVSCSIState *) opaque;
1178 trace_pvscsi_state("presave");
1180 assert(QTAILQ_EMPTY(&s->pending_queue));
1181 assert(QTAILQ_EMPTY(&s->completion_queue));
1187 pvscsi_post_load(void *opaque, int version_id)
1189 trace_pvscsi_state("postload");
1193 static bool pvscsi_vmstate_need_pcie_device(void *opaque)
1195 PVSCSIState *s = PVSCSI(opaque);
1197 return !(s->compat_flags & PVSCSI_COMPAT_DISABLE_PCIE);
1200 static bool pvscsi_vmstate_test_pci_device(void *opaque, int version_id)
1202 return !pvscsi_vmstate_need_pcie_device(opaque);
1205 static const VMStateDescription vmstate_pvscsi_pcie_device = {
1206 .name = "pvscsi/pcie",
1207 .needed = pvscsi_vmstate_need_pcie_device,
1208 .fields = (VMStateField[]) {
1209 VMSTATE_PCI_DEVICE(parent_obj, PVSCSIState),
1210 VMSTATE_END_OF_LIST()
1214 static const VMStateDescription vmstate_pvscsi = {
1217 .minimum_version_id = 0,
1218 .pre_save = pvscsi_pre_save,
1219 .post_load = pvscsi_post_load,
1220 .fields = (VMStateField[]) {
1221 VMSTATE_STRUCT_TEST(parent_obj, PVSCSIState,
1222 pvscsi_vmstate_test_pci_device, 0,
1223 vmstate_pci_device, PCIDevice),
1224 VMSTATE_UINT8(msi_used, PVSCSIState),
1225 VMSTATE_UINT32(resetting, PVSCSIState),
1226 VMSTATE_UINT64(reg_interrupt_status, PVSCSIState),
1227 VMSTATE_UINT64(reg_interrupt_enabled, PVSCSIState),
1228 VMSTATE_UINT64(reg_command_status, PVSCSIState),
1229 VMSTATE_UINT64(curr_cmd, PVSCSIState),
1230 VMSTATE_UINT32(curr_cmd_data_cntr, PVSCSIState),
1231 VMSTATE_UINT32_ARRAY(curr_cmd_data, PVSCSIState,
1232 ARRAY_SIZE(((PVSCSIState *)NULL)->curr_cmd_data)),
1233 VMSTATE_UINT8(rings_info_valid, PVSCSIState),
1234 VMSTATE_UINT8(msg_ring_info_valid, PVSCSIState),
1235 VMSTATE_UINT8(use_msg, PVSCSIState),
1237 VMSTATE_UINT64(rings.rs_pa, PVSCSIState),
1238 VMSTATE_UINT32(rings.txr_len_mask, PVSCSIState),
1239 VMSTATE_UINT32(rings.rxr_len_mask, PVSCSIState),
1240 VMSTATE_UINT64_ARRAY(rings.req_ring_pages_pa, PVSCSIState,
1241 PVSCSI_SETUP_RINGS_MAX_NUM_PAGES),
1242 VMSTATE_UINT64_ARRAY(rings.cmp_ring_pages_pa, PVSCSIState,
1243 PVSCSI_SETUP_RINGS_MAX_NUM_PAGES),
1244 VMSTATE_UINT64(rings.consumed_ptr, PVSCSIState),
1245 VMSTATE_UINT64(rings.filled_cmp_ptr, PVSCSIState),
1247 VMSTATE_END_OF_LIST()
1249 .subsections = (const VMStateDescription*[]) {
1250 &vmstate_pvscsi_pcie_device,
1255 static Property pvscsi_properties[] = {
1256 DEFINE_PROP_UINT8("use_msg", PVSCSIState, use_msg, 1),
1257 DEFINE_PROP_BIT("x-old-pci-configuration", PVSCSIState, compat_flags,
1258 PVSCSI_COMPAT_OLD_PCI_CONFIGURATION_BIT, false),
1259 DEFINE_PROP_BIT("x-disable-pcie", PVSCSIState, compat_flags,
1260 PVSCSI_COMPAT_DISABLE_PCIE_BIT, false),
1261 DEFINE_PROP_END_OF_LIST(),
1264 static void pvscsi_realize(DeviceState *qdev, Error **errp)
1266 PVSCSIClass *pvs_c = PVSCSI_DEVICE_GET_CLASS(qdev);
1267 PCIDevice *pci_dev = PCI_DEVICE(qdev);
1268 PVSCSIState *s = PVSCSI(qdev);
1270 if (!(s->compat_flags & PVSCSI_COMPAT_DISABLE_PCIE)) {
1271 pci_dev->cap_present |= QEMU_PCI_CAP_EXPRESS;
1274 pvs_c->parent_dc_realize(qdev, errp);
1277 static void pvscsi_class_init(ObjectClass *klass, void *data)
1279 DeviceClass *dc = DEVICE_CLASS(klass);
1280 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1281 PVSCSIClass *pvs_k = PVSCSI_DEVICE_CLASS(klass);
1282 HotplugHandlerClass *hc = HOTPLUG_HANDLER_CLASS(klass);
1284 k->realize = pvscsi_realizefn;
1285 k->exit = pvscsi_uninit;
1286 k->vendor_id = PCI_VENDOR_ID_VMWARE;
1287 k->device_id = PCI_DEVICE_ID_VMWARE_PVSCSI;
1288 k->class_id = PCI_CLASS_STORAGE_SCSI;
1289 k->subsystem_id = 0x1000;
1290 device_class_set_parent_realize(dc, pvscsi_realize,
1291 &pvs_k->parent_dc_realize);
1292 dc->reset = pvscsi_reset;
1293 dc->vmsd = &vmstate_pvscsi;
1294 dc->props = pvscsi_properties;
1295 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
1296 hc->unplug = pvscsi_hot_unplug;
1297 hc->plug = pvscsi_hotplug;
1300 static const TypeInfo pvscsi_info = {
1301 .name = TYPE_PVSCSI,
1302 .parent = TYPE_PCI_DEVICE,
1303 .class_size = sizeof(PVSCSIClass),
1304 .instance_size = sizeof(PVSCSIState),
1305 .class_init = pvscsi_class_init,
1306 .interfaces = (InterfaceInfo[]) {
1307 { TYPE_HOTPLUG_HANDLER },
1308 { INTERFACE_PCIE_DEVICE },
1309 { INTERFACE_CONVENTIONAL_PCI_DEVICE },
1315 pvscsi_register_types(void)
1317 type_register_static(&pvscsi_info);
1320 type_init(pvscsi_register_types);