2 * Linux driver for VMware's para-virtualized SCSI HBA.
4 * Copyright (C) 2008-2009, VMware, Inc. All Rights Reserved.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; version 2 of the License and no later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
13 * NON INFRINGEMENT. See the GNU General Public License for more
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 * Maintained by: Alok N Kataria <akataria@vmware.com>
24 #include <linux/kernel.h>
25 #include <linux/module.h>
26 #include <linux/interrupt.h>
27 #include <linux/slab.h>
28 #include <linux/workqueue.h>
29 #include <linux/pci.h>
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_host.h>
33 #include <scsi/scsi_cmnd.h>
34 #include <scsi/scsi_device.h>
36 #include "vmw_pvscsi.h"
38 #define PVSCSI_LINUX_DRIVER_DESC "VMware PVSCSI driver"
40 MODULE_DESCRIPTION(PVSCSI_LINUX_DRIVER_DESC);
41 MODULE_AUTHOR("VMware, Inc.");
42 MODULE_LICENSE("GPL");
43 MODULE_VERSION(PVSCSI_DRIVER_VERSION_STRING);
45 #define PVSCSI_DEFAULT_NUM_PAGES_PER_RING 8
46 #define PVSCSI_DEFAULT_NUM_PAGES_MSG_RING 1
47 #define PVSCSI_DEFAULT_QUEUE_DEPTH 64
48 #define SGL_SIZE PAGE_SIZE
50 struct pvscsi_sg_list {
51 struct PVSCSISGElement sge[PVSCSI_MAX_NUM_SG_ENTRIES_PER_SEGMENT];
56 * The index of the context in cmd_map serves as the context ID for a
57 * 1-to-1 mapping completions back to requests.
59 struct scsi_cmnd *cmd;
60 struct pvscsi_sg_list *sgl;
61 struct list_head list;
67 struct pvscsi_adapter {
77 struct workqueue_struct *workqueue;
78 struct work_struct work;
80 struct PVSCSIRingReqDesc *req_ring;
85 struct PVSCSIRingCmpDesc *cmp_ring;
89 struct PVSCSIRingMsgDesc *msg_ring;
93 struct PVSCSIRingsState *rings_state;
94 dma_addr_t ringStatePA;
97 struct Scsi_Host *host;
99 struct list_head cmd_pool;
100 struct pvscsi_ctx *cmd_map;
104 /* Command line parameters */
105 static int pvscsi_ring_pages = PVSCSI_DEFAULT_NUM_PAGES_PER_RING;
106 static int pvscsi_msg_ring_pages = PVSCSI_DEFAULT_NUM_PAGES_MSG_RING;
107 static int pvscsi_cmd_per_lun = PVSCSI_DEFAULT_QUEUE_DEPTH;
108 static bool pvscsi_disable_msi;
109 static bool pvscsi_disable_msix;
110 static bool pvscsi_use_msg = true;
112 #define PVSCSI_RW (S_IRUSR | S_IWUSR)
114 module_param_named(ring_pages, pvscsi_ring_pages, int, PVSCSI_RW);
115 MODULE_PARM_DESC(ring_pages, "Number of pages per req/cmp ring - (default="
116 __stringify(PVSCSI_DEFAULT_NUM_PAGES_PER_RING) ")");
118 module_param_named(msg_ring_pages, pvscsi_msg_ring_pages, int, PVSCSI_RW);
119 MODULE_PARM_DESC(msg_ring_pages, "Number of pages for the msg ring - (default="
120 __stringify(PVSCSI_DEFAULT_NUM_PAGES_MSG_RING) ")");
122 module_param_named(cmd_per_lun, pvscsi_cmd_per_lun, int, PVSCSI_RW);
123 MODULE_PARM_DESC(cmd_per_lun, "Maximum commands per lun - (default="
124 __stringify(PVSCSI_MAX_REQ_QUEUE_DEPTH) ")");
126 module_param_named(disable_msi, pvscsi_disable_msi, bool, PVSCSI_RW);
127 MODULE_PARM_DESC(disable_msi, "Disable MSI use in driver - (default=0)");
129 module_param_named(disable_msix, pvscsi_disable_msix, bool, PVSCSI_RW);
130 MODULE_PARM_DESC(disable_msix, "Disable MSI-X use in driver - (default=0)");
132 module_param_named(use_msg, pvscsi_use_msg, bool, PVSCSI_RW);
133 MODULE_PARM_DESC(use_msg, "Use msg ring when available - (default=1)");
135 static const struct pci_device_id pvscsi_pci_tbl[] = {
136 { PCI_VDEVICE(VMWARE, PCI_DEVICE_ID_VMWARE_PVSCSI) },
140 MODULE_DEVICE_TABLE(pci, pvscsi_pci_tbl);
142 static struct device *
143 pvscsi_dev(const struct pvscsi_adapter *adapter)
145 return &(adapter->dev->dev);
148 static struct pvscsi_ctx *
149 pvscsi_find_context(const struct pvscsi_adapter *adapter, struct scsi_cmnd *cmd)
151 struct pvscsi_ctx *ctx, *end;
153 end = &adapter->cmd_map[adapter->req_depth];
154 for (ctx = adapter->cmd_map; ctx < end; ctx++)
161 static struct pvscsi_ctx *
162 pvscsi_acquire_context(struct pvscsi_adapter *adapter, struct scsi_cmnd *cmd)
164 struct pvscsi_ctx *ctx;
166 if (list_empty(&adapter->cmd_pool))
169 ctx = list_first_entry(&adapter->cmd_pool, struct pvscsi_ctx, list);
171 list_del(&ctx->list);
176 static void pvscsi_release_context(struct pvscsi_adapter *adapter,
177 struct pvscsi_ctx *ctx)
180 list_add(&ctx->list, &adapter->cmd_pool);
184 * Map a pvscsi_ctx struct to a context ID field value; we map to a simple
185 * non-zero integer. ctx always points to an entry in cmd_map array, hence
186 * the return value is always >=1.
188 static u64 pvscsi_map_context(const struct pvscsi_adapter *adapter,
189 const struct pvscsi_ctx *ctx)
191 return ctx - adapter->cmd_map + 1;
194 static struct pvscsi_ctx *
195 pvscsi_get_context(const struct pvscsi_adapter *adapter, u64 context)
197 return &adapter->cmd_map[context - 1];
200 static void pvscsi_reg_write(const struct pvscsi_adapter *adapter,
203 writel(val, adapter->mmioBase + offset);
206 static u32 pvscsi_reg_read(const struct pvscsi_adapter *adapter, u32 offset)
208 return readl(adapter->mmioBase + offset);
211 static u32 pvscsi_read_intr_status(const struct pvscsi_adapter *adapter)
213 return pvscsi_reg_read(adapter, PVSCSI_REG_OFFSET_INTR_STATUS);
216 static void pvscsi_write_intr_status(const struct pvscsi_adapter *adapter,
219 pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_INTR_STATUS, val);
222 static void pvscsi_unmask_intr(const struct pvscsi_adapter *adapter)
226 intr_bits = PVSCSI_INTR_CMPL_MASK;
227 if (adapter->use_msg)
228 intr_bits |= PVSCSI_INTR_MSG_MASK;
230 pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_INTR_MASK, intr_bits);
233 static void pvscsi_mask_intr(const struct pvscsi_adapter *adapter)
235 pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_INTR_MASK, 0);
238 static void pvscsi_write_cmd_desc(const struct pvscsi_adapter *adapter,
239 u32 cmd, const void *desc, size_t len)
241 const u32 *ptr = desc;
245 pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_COMMAND, cmd);
246 for (i = 0; i < len; i++)
247 pvscsi_reg_write(adapter,
248 PVSCSI_REG_OFFSET_COMMAND_DATA, ptr[i]);
251 static void pvscsi_abort_cmd(const struct pvscsi_adapter *adapter,
252 const struct pvscsi_ctx *ctx)
254 struct PVSCSICmdDescAbortCmd cmd = { 0 };
256 cmd.target = ctx->cmd->device->id;
257 cmd.context = pvscsi_map_context(adapter, ctx);
259 pvscsi_write_cmd_desc(adapter, PVSCSI_CMD_ABORT_CMD, &cmd, sizeof(cmd));
262 static void pvscsi_kick_rw_io(const struct pvscsi_adapter *adapter)
264 pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_KICK_RW_IO, 0);
267 static void pvscsi_process_request_ring(const struct pvscsi_adapter *adapter)
269 pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_KICK_NON_RW_IO, 0);
272 static int scsi_is_rw(unsigned char op)
274 return op == READ_6 || op == WRITE_6 ||
275 op == READ_10 || op == WRITE_10 ||
276 op == READ_12 || op == WRITE_12 ||
277 op == READ_16 || op == WRITE_16;
280 static void pvscsi_kick_io(const struct pvscsi_adapter *adapter,
284 pvscsi_kick_rw_io(adapter);
286 pvscsi_process_request_ring(adapter);
289 static void ll_adapter_reset(const struct pvscsi_adapter *adapter)
291 dev_dbg(pvscsi_dev(adapter), "Adapter Reset on %p\n", adapter);
293 pvscsi_write_cmd_desc(adapter, PVSCSI_CMD_ADAPTER_RESET, NULL, 0);
296 static void ll_bus_reset(const struct pvscsi_adapter *adapter)
298 dev_dbg(pvscsi_dev(adapter), "Reseting bus on %p\n", adapter);
300 pvscsi_write_cmd_desc(adapter, PVSCSI_CMD_RESET_BUS, NULL, 0);
303 static void ll_device_reset(const struct pvscsi_adapter *adapter, u32 target)
305 struct PVSCSICmdDescResetDevice cmd = { 0 };
307 dev_dbg(pvscsi_dev(adapter), "Reseting device: target=%u\n", target);
311 pvscsi_write_cmd_desc(adapter, PVSCSI_CMD_RESET_DEVICE,
315 static void pvscsi_create_sg(struct pvscsi_ctx *ctx,
316 struct scatterlist *sg, unsigned count)
319 struct PVSCSISGElement *sge;
321 BUG_ON(count > PVSCSI_MAX_NUM_SG_ENTRIES_PER_SEGMENT);
323 sge = &ctx->sgl->sge[0];
324 for (i = 0; i < count; i++, sg++) {
325 sge[i].addr = sg_dma_address(sg);
326 sge[i].length = sg_dma_len(sg);
332 * Map all data buffers for a command into PCI space and
333 * setup the scatter/gather list if needed.
335 static void pvscsi_map_buffers(struct pvscsi_adapter *adapter,
336 struct pvscsi_ctx *ctx, struct scsi_cmnd *cmd,
337 struct PVSCSIRingReqDesc *e)
340 unsigned bufflen = scsi_bufflen(cmd);
341 struct scatterlist *sg;
343 e->dataLen = bufflen;
348 sg = scsi_sglist(cmd);
349 count = scsi_sg_count(cmd);
351 int segs = scsi_dma_map(cmd);
353 pvscsi_create_sg(ctx, sg, segs);
355 e->flags |= PVSCSI_FLAG_CMD_WITH_SG_LIST;
356 ctx->sglPA = pci_map_single(adapter->dev, ctx->sgl,
357 SGL_SIZE, PCI_DMA_TODEVICE);
358 e->dataAddr = ctx->sglPA;
360 e->dataAddr = sg_dma_address(sg);
363 * In case there is no S/G list, scsi_sglist points
364 * directly to the buffer.
366 ctx->dataPA = pci_map_single(adapter->dev, sg, bufflen,
367 cmd->sc_data_direction);
368 e->dataAddr = ctx->dataPA;
372 static void pvscsi_unmap_buffers(const struct pvscsi_adapter *adapter,
373 struct pvscsi_ctx *ctx)
375 struct scsi_cmnd *cmd;
379 bufflen = scsi_bufflen(cmd);
382 unsigned count = scsi_sg_count(cmd);
387 pci_unmap_single(adapter->dev, ctx->sglPA,
388 SGL_SIZE, PCI_DMA_TODEVICE);
392 pci_unmap_single(adapter->dev, ctx->dataPA, bufflen,
393 cmd->sc_data_direction);
395 if (cmd->sense_buffer)
396 pci_unmap_single(adapter->dev, ctx->sensePA,
397 SCSI_SENSE_BUFFERSIZE, PCI_DMA_FROMDEVICE);
400 static int __devinit pvscsi_allocate_rings(struct pvscsi_adapter *adapter)
402 adapter->rings_state = pci_alloc_consistent(adapter->dev, PAGE_SIZE,
403 &adapter->ringStatePA);
404 if (!adapter->rings_state)
407 adapter->req_pages = min(PVSCSI_MAX_NUM_PAGES_REQ_RING,
409 adapter->req_depth = adapter->req_pages
410 * PVSCSI_MAX_NUM_REQ_ENTRIES_PER_PAGE;
411 adapter->req_ring = pci_alloc_consistent(adapter->dev,
412 adapter->req_pages * PAGE_SIZE,
413 &adapter->reqRingPA);
414 if (!adapter->req_ring)
417 adapter->cmp_pages = min(PVSCSI_MAX_NUM_PAGES_CMP_RING,
419 adapter->cmp_ring = pci_alloc_consistent(adapter->dev,
420 adapter->cmp_pages * PAGE_SIZE,
421 &adapter->cmpRingPA);
422 if (!adapter->cmp_ring)
425 BUG_ON(!IS_ALIGNED(adapter->ringStatePA, PAGE_SIZE));
426 BUG_ON(!IS_ALIGNED(adapter->reqRingPA, PAGE_SIZE));
427 BUG_ON(!IS_ALIGNED(adapter->cmpRingPA, PAGE_SIZE));
429 if (!adapter->use_msg)
432 adapter->msg_pages = min(PVSCSI_MAX_NUM_PAGES_MSG_RING,
433 pvscsi_msg_ring_pages);
434 adapter->msg_ring = pci_alloc_consistent(adapter->dev,
435 adapter->msg_pages * PAGE_SIZE,
436 &adapter->msgRingPA);
437 if (!adapter->msg_ring)
439 BUG_ON(!IS_ALIGNED(adapter->msgRingPA, PAGE_SIZE));
444 static void pvscsi_setup_all_rings(const struct pvscsi_adapter *adapter)
446 struct PVSCSICmdDescSetupRings cmd = { 0 };
450 cmd.ringsStatePPN = adapter->ringStatePA >> PAGE_SHIFT;
451 cmd.reqRingNumPages = adapter->req_pages;
452 cmd.cmpRingNumPages = adapter->cmp_pages;
454 base = adapter->reqRingPA;
455 for (i = 0; i < adapter->req_pages; i++) {
456 cmd.reqRingPPNs[i] = base >> PAGE_SHIFT;
460 base = adapter->cmpRingPA;
461 for (i = 0; i < adapter->cmp_pages; i++) {
462 cmd.cmpRingPPNs[i] = base >> PAGE_SHIFT;
466 memset(adapter->rings_state, 0, PAGE_SIZE);
467 memset(adapter->req_ring, 0, adapter->req_pages * PAGE_SIZE);
468 memset(adapter->cmp_ring, 0, adapter->cmp_pages * PAGE_SIZE);
470 pvscsi_write_cmd_desc(adapter, PVSCSI_CMD_SETUP_RINGS,
473 if (adapter->use_msg) {
474 struct PVSCSICmdDescSetupMsgRing cmd_msg = { 0 };
476 cmd_msg.numPages = adapter->msg_pages;
478 base = adapter->msgRingPA;
479 for (i = 0; i < adapter->msg_pages; i++) {
480 cmd_msg.ringPPNs[i] = base >> PAGE_SHIFT;
483 memset(adapter->msg_ring, 0, adapter->msg_pages * PAGE_SIZE);
485 pvscsi_write_cmd_desc(adapter, PVSCSI_CMD_SETUP_MSG_RING,
486 &cmd_msg, sizeof(cmd_msg));
491 * Pull a completion descriptor off and pass the completion back
492 * to the SCSI mid layer.
494 static void pvscsi_complete_request(struct pvscsi_adapter *adapter,
495 const struct PVSCSIRingCmpDesc *e)
497 struct pvscsi_ctx *ctx;
498 struct scsi_cmnd *cmd;
499 u32 btstat = e->hostStatus;
500 u32 sdstat = e->scsiStatus;
502 ctx = pvscsi_get_context(adapter, e->context);
504 pvscsi_unmap_buffers(adapter, ctx);
505 pvscsi_release_context(adapter, ctx);
508 if (sdstat != SAM_STAT_GOOD &&
509 (btstat == BTSTAT_SUCCESS ||
510 btstat == BTSTAT_LINKED_COMMAND_COMPLETED ||
511 btstat == BTSTAT_LINKED_COMMAND_COMPLETED_WITH_FLAG)) {
512 cmd->result = (DID_OK << 16) | sdstat;
513 if (sdstat == SAM_STAT_CHECK_CONDITION && cmd->sense_buffer)
514 cmd->result |= (DRIVER_SENSE << 24);
518 case BTSTAT_LINKED_COMMAND_COMPLETED:
519 case BTSTAT_LINKED_COMMAND_COMPLETED_WITH_FLAG:
520 /* If everything went fine, let's move on.. */
521 cmd->result = (DID_OK << 16);
525 case BTSTAT_DATA_UNDERRUN:
526 /* Report residual data in underruns */
527 scsi_set_resid(cmd, scsi_bufflen(cmd) - e->dataLen);
528 cmd->result = (DID_ERROR << 16);
531 case BTSTAT_SELTIMEO:
532 /* Our emulation returns this for non-connected devs */
533 cmd->result = (DID_BAD_TARGET << 16);
536 case BTSTAT_LUNMISMATCH:
537 case BTSTAT_TAGREJECT:
539 cmd->result = (DRIVER_INVALID << 24);
542 case BTSTAT_HAHARDWARE:
543 case BTSTAT_INVPHASE:
544 case BTSTAT_HATIMEOUT:
545 case BTSTAT_NORESPONSE:
546 case BTSTAT_DISCONNECT:
547 case BTSTAT_HASOFTWARE:
549 case BTSTAT_SENSFAILED:
550 cmd->result |= (DID_ERROR << 16);
555 case BTSTAT_BUSRESET:
556 cmd->result = (DID_RESET << 16);
559 case BTSTAT_ABORTQUEUE:
560 cmd->result = (DID_ABORT << 16);
563 case BTSTAT_SCSIPARITY:
564 cmd->result = (DID_PARITY << 16);
568 cmd->result = (DID_ERROR << 16);
569 scmd_printk(KERN_DEBUG, cmd,
570 "Unknown completion status: 0x%x\n",
574 dev_dbg(&cmd->device->sdev_gendev,
575 "cmd=%p %x ctx=%p result=0x%x status=0x%x,%x\n",
576 cmd, cmd->cmnd[0], ctx, cmd->result, btstat, sdstat);
582 * barrier usage : Since the PVSCSI device is emulated, there could be cases
583 * where we may want to serialize some accesses between the driver and the
584 * emulation layer. We use compiler barriers instead of the more expensive
585 * memory barriers because PVSCSI is only supported on X86 which has strong
586 * memory access ordering.
588 static void pvscsi_process_completion_ring(struct pvscsi_adapter *adapter)
590 struct PVSCSIRingsState *s = adapter->rings_state;
591 struct PVSCSIRingCmpDesc *ring = adapter->cmp_ring;
592 u32 cmp_entries = s->cmpNumEntriesLog2;
594 while (s->cmpConsIdx != s->cmpProdIdx) {
595 struct PVSCSIRingCmpDesc *e = ring + (s->cmpConsIdx &
598 * This barrier() ensures that *e is not dereferenced while
599 * the device emulation still writes data into the slot.
600 * Since the device emulation advances s->cmpProdIdx only after
601 * updating the slot we want to check it first.
604 pvscsi_complete_request(adapter, e);
606 * This barrier() ensures that compiler doesn't reorder write
607 * to s->cmpConsIdx before the read of (*e) inside
608 * pvscsi_complete_request. Otherwise, device emulation may
609 * overwrite *e before we had a chance to read it.
617 * Translate a Linux SCSI request into a request ring entry.
619 static int pvscsi_queue_ring(struct pvscsi_adapter *adapter,
620 struct pvscsi_ctx *ctx, struct scsi_cmnd *cmd)
622 struct PVSCSIRingsState *s;
623 struct PVSCSIRingReqDesc *e;
624 struct scsi_device *sdev;
627 s = adapter->rings_state;
629 req_entries = s->reqNumEntriesLog2;
632 * If this condition holds, we might have room on the request ring, but
633 * we might not have room on the completion ring for the response.
634 * However, we have already ruled out this possibility - we would not
635 * have successfully allocated a context if it were true, since we only
636 * have one context per request entry. Check for it anyway, since it
637 * would be a serious bug.
639 if (s->reqProdIdx - s->cmpConsIdx >= 1 << req_entries) {
640 scmd_printk(KERN_ERR, cmd, "vmw_pvscsi: "
641 "ring full: reqProdIdx=%d cmpConsIdx=%d\n",
642 s->reqProdIdx, s->cmpConsIdx);
646 e = adapter->req_ring + (s->reqProdIdx & MASK(req_entries));
648 e->bus = sdev->channel;
649 e->target = sdev->id;
650 memset(e->lun, 0, sizeof(e->lun));
651 e->lun[1] = sdev->lun;
653 if (cmd->sense_buffer) {
654 ctx->sensePA = pci_map_single(adapter->dev, cmd->sense_buffer,
655 SCSI_SENSE_BUFFERSIZE,
657 e->senseAddr = ctx->sensePA;
658 e->senseLen = SCSI_SENSE_BUFFERSIZE;
663 e->cdbLen = cmd->cmd_len;
664 e->vcpuHint = smp_processor_id();
665 memcpy(e->cdb, cmd->cmnd, e->cdbLen);
667 e->tag = SIMPLE_QUEUE_TAG;
668 if (sdev->tagged_supported &&
669 (cmd->tag == HEAD_OF_QUEUE_TAG ||
670 cmd->tag == ORDERED_QUEUE_TAG))
673 if (cmd->sc_data_direction == DMA_FROM_DEVICE)
674 e->flags = PVSCSI_FLAG_CMD_DIR_TOHOST;
675 else if (cmd->sc_data_direction == DMA_TO_DEVICE)
676 e->flags = PVSCSI_FLAG_CMD_DIR_TODEVICE;
677 else if (cmd->sc_data_direction == DMA_NONE)
678 e->flags = PVSCSI_FLAG_CMD_DIR_NONE;
682 pvscsi_map_buffers(adapter, ctx, cmd, e);
684 e->context = pvscsi_map_context(adapter, ctx);
693 static int pvscsi_queue(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
695 struct Scsi_Host *host = cmd->device->host;
696 struct pvscsi_adapter *adapter = shost_priv(host);
697 struct pvscsi_ctx *ctx;
700 spin_lock_irqsave(&adapter->hw_lock, flags);
702 ctx = pvscsi_acquire_context(adapter, cmd);
703 if (!ctx || pvscsi_queue_ring(adapter, ctx, cmd) != 0) {
705 pvscsi_release_context(adapter, ctx);
706 spin_unlock_irqrestore(&adapter->hw_lock, flags);
707 return SCSI_MLQUEUE_HOST_BUSY;
710 cmd->scsi_done = done;
712 dev_dbg(&cmd->device->sdev_gendev,
713 "queued cmd %p, ctx %p, op=%x\n", cmd, ctx, cmd->cmnd[0]);
715 spin_unlock_irqrestore(&adapter->hw_lock, flags);
717 pvscsi_kick_io(adapter, cmd->cmnd[0]);
722 static int pvscsi_abort(struct scsi_cmnd *cmd)
724 struct pvscsi_adapter *adapter = shost_priv(cmd->device->host);
725 struct pvscsi_ctx *ctx;
728 scmd_printk(KERN_DEBUG, cmd, "task abort on host %u, %p\n",
729 adapter->host->host_no, cmd);
731 spin_lock_irqsave(&adapter->hw_lock, flags);
734 * Poll the completion ring first - we might be trying to abort
735 * a command that is waiting to be dispatched in the completion ring.
737 pvscsi_process_completion_ring(adapter);
740 * If there is no context for the command, it either already succeeded
741 * or else was never properly issued. Not our problem.
743 ctx = pvscsi_find_context(adapter, cmd);
745 scmd_printk(KERN_DEBUG, cmd, "Failed to abort cmd %p\n", cmd);
749 pvscsi_abort_cmd(adapter, ctx);
751 pvscsi_process_completion_ring(adapter);
754 spin_unlock_irqrestore(&adapter->hw_lock, flags);
759 * Abort all outstanding requests. This is only safe to use if the completion
760 * ring will never be walked again or the device has been reset, because it
761 * destroys the 1-1 mapping between context field passed to emulation and our
764 static void pvscsi_reset_all(struct pvscsi_adapter *adapter)
768 for (i = 0; i < adapter->req_depth; i++) {
769 struct pvscsi_ctx *ctx = &adapter->cmd_map[i];
770 struct scsi_cmnd *cmd = ctx->cmd;
772 scmd_printk(KERN_ERR, cmd,
773 "Forced reset on cmd %p\n", cmd);
774 pvscsi_unmap_buffers(adapter, ctx);
775 pvscsi_release_context(adapter, ctx);
776 cmd->result = (DID_RESET << 16);
782 static int pvscsi_host_reset(struct scsi_cmnd *cmd)
784 struct Scsi_Host *host = cmd->device->host;
785 struct pvscsi_adapter *adapter = shost_priv(host);
789 scmd_printk(KERN_INFO, cmd, "SCSI Host reset\n");
791 spin_lock_irqsave(&adapter->hw_lock, flags);
793 use_msg = adapter->use_msg;
796 adapter->use_msg = 0;
797 spin_unlock_irqrestore(&adapter->hw_lock, flags);
800 * Now that we know that the ISR won't add more work on the
801 * workqueue we can safely flush any outstanding work.
803 flush_workqueue(adapter->workqueue);
804 spin_lock_irqsave(&adapter->hw_lock, flags);
808 * We're going to tear down the entire ring structure and set it back
809 * up, so stalling new requests until all completions are flushed and
810 * the rings are back in place.
813 pvscsi_process_request_ring(adapter);
815 ll_adapter_reset(adapter);
818 * Now process any completions. Note we do this AFTER adapter reset,
819 * which is strange, but stops races where completions get posted
820 * between processing the ring and issuing the reset. The backend will
821 * not touch the ring memory after reset, so the immediately pre-reset
822 * completion ring state is still valid.
824 pvscsi_process_completion_ring(adapter);
826 pvscsi_reset_all(adapter);
827 adapter->use_msg = use_msg;
828 pvscsi_setup_all_rings(adapter);
829 pvscsi_unmask_intr(adapter);
831 spin_unlock_irqrestore(&adapter->hw_lock, flags);
836 static int pvscsi_bus_reset(struct scsi_cmnd *cmd)
838 struct Scsi_Host *host = cmd->device->host;
839 struct pvscsi_adapter *adapter = shost_priv(host);
842 scmd_printk(KERN_INFO, cmd, "SCSI Bus reset\n");
845 * We don't want to queue new requests for this bus after
846 * flushing all pending requests to emulation, since new
847 * requests could then sneak in during this bus reset phase,
848 * so take the lock now.
850 spin_lock_irqsave(&adapter->hw_lock, flags);
852 pvscsi_process_request_ring(adapter);
853 ll_bus_reset(adapter);
854 pvscsi_process_completion_ring(adapter);
856 spin_unlock_irqrestore(&adapter->hw_lock, flags);
861 static int pvscsi_device_reset(struct scsi_cmnd *cmd)
863 struct Scsi_Host *host = cmd->device->host;
864 struct pvscsi_adapter *adapter = shost_priv(host);
867 scmd_printk(KERN_INFO, cmd, "SCSI device reset on scsi%u:%u\n",
868 host->host_no, cmd->device->id);
871 * We don't want to queue new requests for this device after flushing
872 * all pending requests to emulation, since new requests could then
873 * sneak in during this device reset phase, so take the lock now.
875 spin_lock_irqsave(&adapter->hw_lock, flags);
877 pvscsi_process_request_ring(adapter);
878 ll_device_reset(adapter, cmd->device->id);
879 pvscsi_process_completion_ring(adapter);
881 spin_unlock_irqrestore(&adapter->hw_lock, flags);
886 static struct scsi_host_template pvscsi_template;
888 static const char *pvscsi_info(struct Scsi_Host *host)
890 struct pvscsi_adapter *adapter = shost_priv(host);
891 static char buf[256];
893 sprintf(buf, "VMware PVSCSI storage adapter rev %d, req/cmp/msg rings: "
894 "%u/%u/%u pages, cmd_per_lun=%u", adapter->rev,
895 adapter->req_pages, adapter->cmp_pages, adapter->msg_pages,
896 pvscsi_template.cmd_per_lun);
901 static struct scsi_host_template pvscsi_template = {
902 .module = THIS_MODULE,
903 .name = "VMware PVSCSI Host Adapter",
904 .proc_name = "vmw_pvscsi",
906 .queuecommand = pvscsi_queue,
908 .sg_tablesize = PVSCSI_MAX_NUM_SG_ENTRIES_PER_SEGMENT,
909 .dma_boundary = UINT_MAX,
910 .max_sectors = 0xffff,
911 .use_clustering = ENABLE_CLUSTERING,
912 .eh_abort_handler = pvscsi_abort,
913 .eh_device_reset_handler = pvscsi_device_reset,
914 .eh_bus_reset_handler = pvscsi_bus_reset,
915 .eh_host_reset_handler = pvscsi_host_reset,
918 static void pvscsi_process_msg(const struct pvscsi_adapter *adapter,
919 const struct PVSCSIRingMsgDesc *e)
921 struct PVSCSIRingsState *s = adapter->rings_state;
922 struct Scsi_Host *host = adapter->host;
923 struct scsi_device *sdev;
925 printk(KERN_INFO "vmw_pvscsi: msg type: 0x%x - MSG RING: %u/%u (%u) \n",
926 e->type, s->msgProdIdx, s->msgConsIdx, s->msgNumEntriesLog2);
928 BUILD_BUG_ON(PVSCSI_MSG_LAST != 2);
930 if (e->type == PVSCSI_MSG_DEV_ADDED) {
931 struct PVSCSIMsgDescDevStatusChanged *desc;
932 desc = (struct PVSCSIMsgDescDevStatusChanged *)e;
935 "vmw_pvscsi: msg: device added at scsi%u:%u:%u\n",
936 desc->bus, desc->target, desc->lun[1]);
938 if (!scsi_host_get(host))
941 sdev = scsi_device_lookup(host, desc->bus, desc->target,
944 printk(KERN_INFO "vmw_pvscsi: device already exists\n");
945 scsi_device_put(sdev);
947 scsi_add_device(adapter->host, desc->bus,
948 desc->target, desc->lun[1]);
951 } else if (e->type == PVSCSI_MSG_DEV_REMOVED) {
952 struct PVSCSIMsgDescDevStatusChanged *desc;
953 desc = (struct PVSCSIMsgDescDevStatusChanged *)e;
956 "vmw_pvscsi: msg: device removed at scsi%u:%u:%u\n",
957 desc->bus, desc->target, desc->lun[1]);
959 if (!scsi_host_get(host))
962 sdev = scsi_device_lookup(host, desc->bus, desc->target,
965 scsi_remove_device(sdev);
966 scsi_device_put(sdev);
969 "vmw_pvscsi: failed to lookup scsi%u:%u:%u\n",
970 desc->bus, desc->target, desc->lun[1]);
976 static int pvscsi_msg_pending(const struct pvscsi_adapter *adapter)
978 struct PVSCSIRingsState *s = adapter->rings_state;
980 return s->msgProdIdx != s->msgConsIdx;
983 static void pvscsi_process_msg_ring(const struct pvscsi_adapter *adapter)
985 struct PVSCSIRingsState *s = adapter->rings_state;
986 struct PVSCSIRingMsgDesc *ring = adapter->msg_ring;
987 u32 msg_entries = s->msgNumEntriesLog2;
989 while (pvscsi_msg_pending(adapter)) {
990 struct PVSCSIRingMsgDesc *e = ring + (s->msgConsIdx &
994 pvscsi_process_msg(adapter, e);
1000 static void pvscsi_msg_workqueue_handler(struct work_struct *data)
1002 struct pvscsi_adapter *adapter;
1004 adapter = container_of(data, struct pvscsi_adapter, work);
1006 pvscsi_process_msg_ring(adapter);
1009 static int pvscsi_setup_msg_workqueue(struct pvscsi_adapter *adapter)
1013 if (!pvscsi_use_msg)
1016 pvscsi_reg_write(adapter, PVSCSI_REG_OFFSET_COMMAND,
1017 PVSCSI_CMD_SETUP_MSG_RING);
1019 if (pvscsi_reg_read(adapter, PVSCSI_REG_OFFSET_COMMAND_STATUS) == -1)
1022 snprintf(name, sizeof(name),
1023 "vmw_pvscsi_wq_%u", adapter->host->host_no);
1025 adapter->workqueue = create_singlethread_workqueue(name);
1026 if (!adapter->workqueue) {
1027 printk(KERN_ERR "vmw_pvscsi: failed to create work queue\n");
1030 INIT_WORK(&adapter->work, pvscsi_msg_workqueue_handler);
1035 static irqreturn_t pvscsi_isr(int irq, void *devp)
1037 struct pvscsi_adapter *adapter = devp;
1040 if (adapter->use_msi || adapter->use_msix)
1043 u32 val = pvscsi_read_intr_status(adapter);
1044 handled = (val & PVSCSI_INTR_ALL_SUPPORTED) != 0;
1046 pvscsi_write_intr_status(devp, val);
1050 unsigned long flags;
1052 spin_lock_irqsave(&adapter->hw_lock, flags);
1054 pvscsi_process_completion_ring(adapter);
1055 if (adapter->use_msg && pvscsi_msg_pending(adapter))
1056 queue_work(adapter->workqueue, &adapter->work);
1058 spin_unlock_irqrestore(&adapter->hw_lock, flags);
1061 return IRQ_RETVAL(handled);
1064 static void pvscsi_free_sgls(const struct pvscsi_adapter *adapter)
1066 struct pvscsi_ctx *ctx = adapter->cmd_map;
1069 for (i = 0; i < adapter->req_depth; ++i, ++ctx)
1070 free_pages((unsigned long)ctx->sgl, get_order(SGL_SIZE));
1073 static int pvscsi_setup_msix(const struct pvscsi_adapter *adapter,
1076 struct msix_entry entry = { 0, PVSCSI_VECTOR_COMPLETION };
1079 ret = pci_enable_msix(adapter->dev, &entry, 1);
1083 *irq = entry.vector;
1088 static void pvscsi_shutdown_intr(struct pvscsi_adapter *adapter)
1091 free_irq(adapter->irq, adapter);
1094 if (adapter->use_msi) {
1095 pci_disable_msi(adapter->dev);
1096 adapter->use_msi = 0;
1097 } else if (adapter->use_msix) {
1098 pci_disable_msix(adapter->dev);
1099 adapter->use_msix = 0;
1103 static void pvscsi_release_resources(struct pvscsi_adapter *adapter)
1105 pvscsi_shutdown_intr(adapter);
1107 if (adapter->workqueue)
1108 destroy_workqueue(adapter->workqueue);
1110 if (adapter->mmioBase)
1111 pci_iounmap(adapter->dev, adapter->mmioBase);
1113 pci_release_regions(adapter->dev);
1115 if (adapter->cmd_map) {
1116 pvscsi_free_sgls(adapter);
1117 kfree(adapter->cmd_map);
1120 if (adapter->rings_state)
1121 pci_free_consistent(adapter->dev, PAGE_SIZE,
1122 adapter->rings_state, adapter->ringStatePA);
1124 if (adapter->req_ring)
1125 pci_free_consistent(adapter->dev,
1126 adapter->req_pages * PAGE_SIZE,
1127 adapter->req_ring, adapter->reqRingPA);
1129 if (adapter->cmp_ring)
1130 pci_free_consistent(adapter->dev,
1131 adapter->cmp_pages * PAGE_SIZE,
1132 adapter->cmp_ring, adapter->cmpRingPA);
1134 if (adapter->msg_ring)
1135 pci_free_consistent(adapter->dev,
1136 adapter->msg_pages * PAGE_SIZE,
1137 adapter->msg_ring, adapter->msgRingPA);
1141 * Allocate scatter gather lists.
1143 * These are statically allocated. Trying to be clever was not worth it.
1145 * Dynamic allocation can fail, and we can't go deeep into the memory
1146 * allocator, since we're a SCSI driver, and trying too hard to allocate
1147 * memory might generate disk I/O. We also don't want to fail disk I/O
1148 * in that case because we can't get an allocation - the I/O could be
1149 * trying to swap out data to free memory. Since that is pathological,
1150 * just use a statically allocated scatter list.
1153 static int __devinit pvscsi_allocate_sg(struct pvscsi_adapter *adapter)
1155 struct pvscsi_ctx *ctx;
1158 ctx = adapter->cmd_map;
1159 BUILD_BUG_ON(sizeof(struct pvscsi_sg_list) > SGL_SIZE);
1161 for (i = 0; i < adapter->req_depth; ++i, ++ctx) {
1162 ctx->sgl = (void *)__get_free_pages(GFP_KERNEL,
1163 get_order(SGL_SIZE));
1165 BUG_ON(!IS_ALIGNED(((unsigned long)ctx->sgl), PAGE_SIZE));
1167 for (; i >= 0; --i, --ctx) {
1168 free_pages((unsigned long)ctx->sgl,
1169 get_order(SGL_SIZE));
1179 static int __devinit pvscsi_probe(struct pci_dev *pdev,
1180 const struct pci_device_id *id)
1182 struct pvscsi_adapter *adapter;
1183 struct Scsi_Host *host;
1185 unsigned long flags = 0;
1190 if (pci_enable_device(pdev))
1193 if (pci_set_dma_mask(pdev, DMA_BIT_MASK(64)) == 0 &&
1194 pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64)) == 0) {
1195 printk(KERN_INFO "vmw_pvscsi: using 64bit dma\n");
1196 } else if (pci_set_dma_mask(pdev, DMA_BIT_MASK(32)) == 0 &&
1197 pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32)) == 0) {
1198 printk(KERN_INFO "vmw_pvscsi: using 32bit dma\n");
1200 printk(KERN_ERR "vmw_pvscsi: failed to set DMA mask\n");
1201 goto out_disable_device;
1204 pvscsi_template.can_queue =
1205 min(PVSCSI_MAX_NUM_PAGES_REQ_RING, pvscsi_ring_pages) *
1206 PVSCSI_MAX_NUM_REQ_ENTRIES_PER_PAGE;
1207 pvscsi_template.cmd_per_lun =
1208 min(pvscsi_template.can_queue, pvscsi_cmd_per_lun);
1209 host = scsi_host_alloc(&pvscsi_template, sizeof(struct pvscsi_adapter));
1211 printk(KERN_ERR "vmw_pvscsi: failed to allocate host\n");
1212 goto out_disable_device;
1215 adapter = shost_priv(host);
1216 memset(adapter, 0, sizeof(*adapter));
1217 adapter->dev = pdev;
1218 adapter->host = host;
1220 spin_lock_init(&adapter->hw_lock);
1222 host->max_channel = 0;
1225 host->max_cmd_len = 16;
1227 adapter->rev = pdev->revision;
1229 if (pci_request_regions(pdev, "vmw_pvscsi")) {
1230 printk(KERN_ERR "vmw_pvscsi: pci memory selection failed\n");
1234 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
1235 if ((pci_resource_flags(pdev, i) & PCI_BASE_ADDRESS_SPACE_IO))
1238 if (pci_resource_len(pdev, i) < PVSCSI_MEM_SPACE_SIZE)
1244 if (i == DEVICE_COUNT_RESOURCE) {
1246 "vmw_pvscsi: adapter has no suitable MMIO region\n");
1247 goto out_release_resources;
1250 adapter->mmioBase = pci_iomap(pdev, i, PVSCSI_MEM_SPACE_SIZE);
1252 if (!adapter->mmioBase) {
1254 "vmw_pvscsi: can't iomap for BAR %d memsize %lu\n",
1255 i, PVSCSI_MEM_SPACE_SIZE);
1256 goto out_release_resources;
1259 pci_set_master(pdev);
1260 pci_set_drvdata(pdev, host);
1262 ll_adapter_reset(adapter);
1264 adapter->use_msg = pvscsi_setup_msg_workqueue(adapter);
1266 error = pvscsi_allocate_rings(adapter);
1268 printk(KERN_ERR "vmw_pvscsi: unable to allocate ring memory\n");
1269 goto out_release_resources;
1273 * From this point on we should reset the adapter if anything goes
1276 pvscsi_setup_all_rings(adapter);
1278 adapter->cmd_map = kcalloc(adapter->req_depth,
1279 sizeof(struct pvscsi_ctx), GFP_KERNEL);
1280 if (!adapter->cmd_map) {
1281 printk(KERN_ERR "vmw_pvscsi: failed to allocate memory.\n");
1283 goto out_reset_adapter;
1286 INIT_LIST_HEAD(&adapter->cmd_pool);
1287 for (i = 0; i < adapter->req_depth; i++) {
1288 struct pvscsi_ctx *ctx = adapter->cmd_map + i;
1289 list_add(&ctx->list, &adapter->cmd_pool);
1292 error = pvscsi_allocate_sg(adapter);
1294 printk(KERN_ERR "vmw_pvscsi: unable to allocate s/g table\n");
1295 goto out_reset_adapter;
1298 if (!pvscsi_disable_msix &&
1299 pvscsi_setup_msix(adapter, &adapter->irq) == 0) {
1300 printk(KERN_INFO "vmw_pvscsi: using MSI-X\n");
1301 adapter->use_msix = 1;
1302 } else if (!pvscsi_disable_msi && pci_enable_msi(pdev) == 0) {
1303 printk(KERN_INFO "vmw_pvscsi: using MSI\n");
1304 adapter->use_msi = 1;
1305 adapter->irq = pdev->irq;
1307 printk(KERN_INFO "vmw_pvscsi: using INTx\n");
1308 adapter->irq = pdev->irq;
1309 flags = IRQF_SHARED;
1312 error = request_irq(adapter->irq, pvscsi_isr, flags,
1313 "vmw_pvscsi", adapter);
1316 "vmw_pvscsi: unable to request IRQ: %d\n", error);
1318 goto out_reset_adapter;
1321 error = scsi_add_host(host, &pdev->dev);
1324 "vmw_pvscsi: scsi_add_host failed: %d\n", error);
1325 goto out_reset_adapter;
1328 dev_info(&pdev->dev, "VMware PVSCSI rev %d host #%u\n",
1329 adapter->rev, host->host_no);
1331 pvscsi_unmask_intr(adapter);
1333 scsi_scan_host(host);
1338 ll_adapter_reset(adapter);
1339 out_release_resources:
1340 pvscsi_release_resources(adapter);
1342 scsi_host_put(host);
1344 pci_set_drvdata(pdev, NULL);
1345 pci_disable_device(pdev);
1350 static void __pvscsi_shutdown(struct pvscsi_adapter *adapter)
1352 pvscsi_mask_intr(adapter);
1354 if (adapter->workqueue)
1355 flush_workqueue(adapter->workqueue);
1357 pvscsi_shutdown_intr(adapter);
1359 pvscsi_process_request_ring(adapter);
1360 pvscsi_process_completion_ring(adapter);
1361 ll_adapter_reset(adapter);
1364 static void pvscsi_shutdown(struct pci_dev *dev)
1366 struct Scsi_Host *host = pci_get_drvdata(dev);
1367 struct pvscsi_adapter *adapter = shost_priv(host);
1369 __pvscsi_shutdown(adapter);
1372 static void pvscsi_remove(struct pci_dev *pdev)
1374 struct Scsi_Host *host = pci_get_drvdata(pdev);
1375 struct pvscsi_adapter *adapter = shost_priv(host);
1377 scsi_remove_host(host);
1379 __pvscsi_shutdown(adapter);
1380 pvscsi_release_resources(adapter);
1382 scsi_host_put(host);
1384 pci_set_drvdata(pdev, NULL);
1385 pci_disable_device(pdev);
1388 static struct pci_driver pvscsi_pci_driver = {
1389 .name = "vmw_pvscsi",
1390 .id_table = pvscsi_pci_tbl,
1391 .probe = pvscsi_probe,
1392 .remove = __devexit_p(pvscsi_remove),
1393 .shutdown = pvscsi_shutdown,
1396 static int __init pvscsi_init(void)
1398 pr_info("%s - version %s\n",
1399 PVSCSI_LINUX_DRIVER_DESC, PVSCSI_DRIVER_VERSION_STRING);
1400 return pci_register_driver(&pvscsi_pci_driver);
1403 static void __exit pvscsi_exit(void)
1405 pci_unregister_driver(&pvscsi_pci_driver);
1408 module_init(pvscsi_init);
1409 module_exit(pvscsi_exit);