2 * Copyright (c) 2009, Microsoft Corporation.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
15 * Place - Suite 330, Boston, MA 02111-1307 USA.
18 * Haiyang Zhang <haiyangz@microsoft.com>
19 * Hank Janssen <hjanssen@microsoft.com>
20 * K. Y. Srinivasan <kys@microsoft.com>
23 #include <linux/kernel.h>
24 #include <linux/wait.h>
25 #include <linux/sched.h>
26 #include <linux/completion.h>
27 #include <linux/string.h>
29 #include <linux/delay.h>
30 #include <linux/init.h>
31 #include <linux/slab.h>
32 #include <linux/module.h>
33 #include <linux/device.h>
34 #include <linux/hyperv.h>
35 #include <linux/blkdev.h>
36 #include <scsi/scsi.h>
37 #include <scsi/scsi_cmnd.h>
38 #include <scsi/scsi_host.h>
39 #include <scsi/scsi_device.h>
40 #include <scsi/scsi_tcq.h>
41 #include <scsi/scsi_eh.h>
42 #include <scsi/scsi_devinfo.h>
43 #include <scsi/scsi_dbg.h>
46 * All wire protocol details (storage protocol between the guest and the host)
47 * are consolidated here.
49 * Begin protocol definitions.
55 * V1 RC < 2008/1/31: 1.0
56 * V1 RC > 2008/1/31: 2.0
63 #define VMSTOR_PROTO_VERSION(MAJOR_, MINOR_) ((((MAJOR_) & 0xff) << 8) | \
66 #define VMSTOR_PROTO_VERSION_WIN6 VMSTOR_PROTO_VERSION(2, 0)
67 #define VMSTOR_PROTO_VERSION_WIN7 VMSTOR_PROTO_VERSION(4, 2)
68 #define VMSTOR_PROTO_VERSION_WIN8 VMSTOR_PROTO_VERSION(5, 1)
69 #define VMSTOR_PROTO_VERSION_WIN8_1 VMSTOR_PROTO_VERSION(6, 0)
70 #define VMSTOR_PROTO_VERSION_WIN10 VMSTOR_PROTO_VERSION(6, 2)
72 /* Packet structure describing virtual storage requests. */
73 enum vstor_packet_operation {
74 VSTOR_OPERATION_COMPLETE_IO = 1,
75 VSTOR_OPERATION_REMOVE_DEVICE = 2,
76 VSTOR_OPERATION_EXECUTE_SRB = 3,
77 VSTOR_OPERATION_RESET_LUN = 4,
78 VSTOR_OPERATION_RESET_ADAPTER = 5,
79 VSTOR_OPERATION_RESET_BUS = 6,
80 VSTOR_OPERATION_BEGIN_INITIALIZATION = 7,
81 VSTOR_OPERATION_END_INITIALIZATION = 8,
82 VSTOR_OPERATION_QUERY_PROTOCOL_VERSION = 9,
83 VSTOR_OPERATION_QUERY_PROPERTIES = 10,
84 VSTOR_OPERATION_ENUMERATE_BUS = 11,
85 VSTOR_OPERATION_FCHBA_DATA = 12,
86 VSTOR_OPERATION_CREATE_SUB_CHANNELS = 13,
87 VSTOR_OPERATION_MAXIMUM = 13
91 * WWN packet for Fibre Channel HBA
94 struct hv_fc_wwn_packet {
98 u8 primary_port_wwn[8];
99 u8 primary_node_wwn[8];
100 u8 secondary_port_wwn[8];
101 u8 secondary_node_wwn[8];
110 #define SRB_FLAGS_QUEUE_ACTION_ENABLE 0x00000002
111 #define SRB_FLAGS_DISABLE_DISCONNECT 0x00000004
112 #define SRB_FLAGS_DISABLE_SYNCH_TRANSFER 0x00000008
113 #define SRB_FLAGS_BYPASS_FROZEN_QUEUE 0x00000010
114 #define SRB_FLAGS_DISABLE_AUTOSENSE 0x00000020
115 #define SRB_FLAGS_DATA_IN 0x00000040
116 #define SRB_FLAGS_DATA_OUT 0x00000080
117 #define SRB_FLAGS_NO_DATA_TRANSFER 0x00000000
118 #define SRB_FLAGS_UNSPECIFIED_DIRECTION (SRB_FLAGS_DATA_IN | SRB_FLAGS_DATA_OUT)
119 #define SRB_FLAGS_NO_QUEUE_FREEZE 0x00000100
120 #define SRB_FLAGS_ADAPTER_CACHE_ENABLE 0x00000200
121 #define SRB_FLAGS_FREE_SENSE_BUFFER 0x00000400
124 * This flag indicates the request is part of the workflow for processing a D3.
126 #define SRB_FLAGS_D3_PROCESSING 0x00000800
127 #define SRB_FLAGS_IS_ACTIVE 0x00010000
128 #define SRB_FLAGS_ALLOCATED_FROM_ZONE 0x00020000
129 #define SRB_FLAGS_SGLIST_FROM_POOL 0x00040000
130 #define SRB_FLAGS_BYPASS_LOCKED_QUEUE 0x00080000
131 #define SRB_FLAGS_NO_KEEP_AWAKE 0x00100000
132 #define SRB_FLAGS_PORT_DRIVER_ALLOCSENSE 0x00200000
133 #define SRB_FLAGS_PORT_DRIVER_SENSEHASPORT 0x00400000
134 #define SRB_FLAGS_DONT_START_NEXT_PACKET 0x00800000
135 #define SRB_FLAGS_PORT_DRIVER_RESERVED 0x0F000000
136 #define SRB_FLAGS_CLASS_DRIVER_RESERVED 0xF0000000
140 * Platform neutral description of a scsi request -
141 * this remains the same across the write regardless of 32/64 bit
142 * note: it's patterned off the SCSI_PASS_THROUGH structure
144 #define STORVSC_MAX_CMD_LEN 0x10
146 #define POST_WIN7_STORVSC_SENSE_BUFFER_SIZE 0x14
147 #define PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE 0x12
149 #define STORVSC_SENSE_BUFFER_SIZE 0x14
150 #define STORVSC_MAX_BUF_LEN_WITH_PADDING 0x14
153 * Sense buffer size changed in win8; have a run-time
154 * variable to track the size we should use. This value will
155 * likely change during protocol negotiation but it is valid
156 * to start by assuming pre-Win8.
158 static int sense_buffer_size = PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE;
161 * The storage protocol version is determined during the
162 * initial exchange with the host. It will indicate which
163 * storage functionality is available in the host.
165 static int vmstor_proto_version;
167 struct vmscsi_win8_extension {
169 * The following were added in Windows 8
179 struct vmscsi_request {
190 u8 sense_info_length;
194 u32 data_transfer_length;
197 u8 cdb[STORVSC_MAX_CMD_LEN];
198 u8 sense_data[STORVSC_SENSE_BUFFER_SIZE];
199 u8 reserved_array[STORVSC_MAX_BUF_LEN_WITH_PADDING];
202 * The following was added in win8.
204 struct vmscsi_win8_extension win8_extension;
206 } __attribute((packed));
210 * The size of the vmscsi_request has changed in win8. The
211 * additional size is because of new elements added to the
212 * structure. These elements are valid only when we are talking
214 * Track the correction to size we need to apply. This value
215 * will likely change during protocol negotiation but it is
216 * valid to start by assuming pre-Win8.
218 static int vmscsi_size_delta = sizeof(struct vmscsi_win8_extension);
221 * The list of storage protocols in order of preference.
223 struct vmstor_protocol {
224 int protocol_version;
225 int sense_buffer_size;
226 int vmscsi_size_delta;
230 static const struct vmstor_protocol vmstor_protocols[] = {
232 VMSTOR_PROTO_VERSION_WIN10,
233 POST_WIN7_STORVSC_SENSE_BUFFER_SIZE,
237 VMSTOR_PROTO_VERSION_WIN8_1,
238 POST_WIN7_STORVSC_SENSE_BUFFER_SIZE,
242 VMSTOR_PROTO_VERSION_WIN8,
243 POST_WIN7_STORVSC_SENSE_BUFFER_SIZE,
247 VMSTOR_PROTO_VERSION_WIN7,
248 PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE,
249 sizeof(struct vmscsi_win8_extension),
252 VMSTOR_PROTO_VERSION_WIN6,
253 PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE,
254 sizeof(struct vmscsi_win8_extension),
260 * This structure is sent during the intialization phase to get the different
261 * properties of the channel.
264 #define STORAGE_CHANNEL_SUPPORTS_MULTI_CHANNEL 0x1
266 struct vmstorage_channel_properties {
272 u32 max_transfer_bytes;
277 /* This structure is sent during the storage protocol negotiations. */
278 struct vmstorage_protocol_version {
279 /* Major (MSW) and minor (LSW) version numbers. */
283 * Revision number is auto-incremented whenever this file is changed
284 * (See FILL_VMSTOR_REVISION macro above). Mismatch does not
285 * definitely indicate incompatibility--but it does indicate mismatched
287 * This is only used on the windows side. Just set it to 0.
292 /* Channel Property Flags */
293 #define STORAGE_CHANNEL_REMOVABLE_FLAG 0x1
294 #define STORAGE_CHANNEL_EMULATED_IDE_FLAG 0x2
296 struct vstor_packet {
297 /* Requested operation type */
298 enum vstor_packet_operation operation;
300 /* Flags - see below for values */
303 /* Status of the request returned from the server side. */
306 /* Data payload area */
309 * Structure used to forward SCSI commands from the
310 * client to the server.
312 struct vmscsi_request vm_srb;
314 /* Structure used to query channel properties. */
315 struct vmstorage_channel_properties storage_channel_properties;
317 /* Used during version negotiations. */
318 struct vmstorage_protocol_version version;
320 /* Fibre channel address packet */
321 struct hv_fc_wwn_packet wwn_packet;
323 /* Number of sub-channels to create */
324 u16 sub_channel_count;
326 /* This will be the maximum of the union members */
334 * This flag indicates that the server should send back a completion for this
338 #define REQUEST_COMPLETION_FLAG 0x1
340 /* Matches Windows-end */
341 enum storvsc_request_type {
348 * SRB status codes and masks; a subset of the codes used here.
351 #define SRB_STATUS_AUTOSENSE_VALID 0x80
352 #define SRB_STATUS_QUEUE_FROZEN 0x40
353 #define SRB_STATUS_INVALID_LUN 0x20
354 #define SRB_STATUS_SUCCESS 0x01
355 #define SRB_STATUS_ABORTED 0x02
356 #define SRB_STATUS_ERROR 0x04
358 #define SRB_STATUS(status) \
359 (status & ~(SRB_STATUS_AUTOSENSE_VALID | SRB_STATUS_QUEUE_FROZEN))
361 * This is the end of Protocol specific defines.
364 static int storvsc_ringbuffer_size = (256 * PAGE_SIZE);
365 static u32 max_outstanding_req_per_channel;
367 static int storvsc_vcpus_per_sub_channel = 4;
369 module_param(storvsc_ringbuffer_size, int, S_IRUGO);
370 MODULE_PARM_DESC(storvsc_ringbuffer_size, "Ring buffer size (bytes)");
372 module_param(storvsc_vcpus_per_sub_channel, int, S_IRUGO);
373 MODULE_PARM_DESC(vcpus_per_sub_channel, "Ratio of VCPUs to subchannels");
375 * Timeout in seconds for all devices managed by this driver.
377 static int storvsc_timeout = 180;
379 static int msft_blist_flags = BLIST_TRY_VPD_PAGES;
382 static void storvsc_on_channel_callback(void *context);
384 #define STORVSC_MAX_LUNS_PER_TARGET 255
385 #define STORVSC_MAX_TARGETS 2
386 #define STORVSC_MAX_CHANNELS 8
388 #define STORVSC_FC_MAX_LUNS_PER_TARGET 255
389 #define STORVSC_FC_MAX_TARGETS 128
390 #define STORVSC_FC_MAX_CHANNELS 8
392 #define STORVSC_IDE_MAX_LUNS_PER_TARGET 64
393 #define STORVSC_IDE_MAX_TARGETS 1
394 #define STORVSC_IDE_MAX_CHANNELS 1
396 struct storvsc_cmd_request {
397 struct scsi_cmnd *cmd;
399 struct hv_device *device;
401 /* Synchronize the request/response if needed */
402 struct completion wait_event;
404 struct vmbus_channel_packet_multipage_buffer mpb;
405 struct vmbus_packet_mpb_array *payload;
408 struct vstor_packet vstor_packet;
412 /* A storvsc device is a device object that contains a vmbus channel */
413 struct storvsc_device {
414 struct hv_device *device;
418 bool open_sub_channel;
419 atomic_t num_outstanding_req;
420 struct Scsi_Host *host;
422 wait_queue_head_t waiting_to_drain;
425 * Each unique Port/Path/Target represents 1 channel ie scsi
426 * controller. In reality, the pathid, targetid is always 0
427 * and the port is set by us
429 unsigned int port_number;
430 unsigned char path_id;
431 unsigned char target_id;
434 * Max I/O, the device can support.
436 u32 max_transfer_bytes;
437 /* Used for vsc/vsp channel reset process */
438 struct storvsc_cmd_request init_request;
439 struct storvsc_cmd_request reset_request;
442 struct hv_host_device {
443 struct hv_device *dev;
446 unsigned char target;
449 struct storvsc_scan_work {
450 struct work_struct work;
451 struct Scsi_Host *host;
455 static void storvsc_device_scan(struct work_struct *work)
457 struct storvsc_scan_work *wrk;
459 struct scsi_device *sdev;
461 wrk = container_of(work, struct storvsc_scan_work, work);
464 sdev = scsi_device_lookup(wrk->host, 0, 0, lun);
467 scsi_rescan_device(&sdev->sdev_gendev);
468 scsi_device_put(sdev);
474 static void storvsc_host_scan(struct work_struct *work)
476 struct storvsc_scan_work *wrk;
477 struct Scsi_Host *host;
478 struct scsi_device *sdev;
480 wrk = container_of(work, struct storvsc_scan_work, work);
484 * Before scanning the host, first check to see if any of the
485 * currrently known devices have been hot removed. We issue a
486 * "unit ready" command against all currently known devices.
487 * This I/O will result in an error for devices that have been
488 * removed. As part of handling the I/O error, we remove the device.
490 * When a LUN is added or removed, the host sends us a signal to
491 * scan the host. Thus we are forced to discover the LUNs that
492 * may have been removed this way.
494 mutex_lock(&host->scan_mutex);
495 shost_for_each_device(sdev, host)
496 scsi_test_unit_ready(sdev, 1, 1, NULL);
497 mutex_unlock(&host->scan_mutex);
499 * Now scan the host to discover LUNs that may have been added.
501 scsi_scan_host(host);
506 static void storvsc_remove_lun(struct work_struct *work)
508 struct storvsc_scan_work *wrk;
509 struct scsi_device *sdev;
511 wrk = container_of(work, struct storvsc_scan_work, work);
512 if (!scsi_host_get(wrk->host))
515 sdev = scsi_device_lookup(wrk->host, 0, 0, wrk->lun);
518 scsi_remove_device(sdev);
519 scsi_device_put(sdev);
521 scsi_host_put(wrk->host);
529 * We can get incoming messages from the host that are not in response to
530 * messages that we have sent out. An example of this would be messages
531 * received by the guest to notify dynamic addition/removal of LUNs. To
532 * deal with potential race conditions where the driver may be in the
533 * midst of being unloaded when we might receive an unsolicited message
534 * from the host, we have implemented a mechanism to gurantee sequential
537 * 1) Once the device is marked as being destroyed, we will fail all
539 * 2) We permit incoming messages when the device is being destroyed,
540 * only to properly account for messages already sent out.
543 static inline struct storvsc_device *get_out_stor_device(
544 struct hv_device *device)
546 struct storvsc_device *stor_device;
548 stor_device = hv_get_drvdata(device);
550 if (stor_device && stor_device->destroy)
557 static inline void storvsc_wait_to_drain(struct storvsc_device *dev)
559 dev->drain_notify = true;
560 wait_event(dev->waiting_to_drain,
561 atomic_read(&dev->num_outstanding_req) == 0);
562 dev->drain_notify = false;
565 static inline struct storvsc_device *get_in_stor_device(
566 struct hv_device *device)
568 struct storvsc_device *stor_device;
570 stor_device = hv_get_drvdata(device);
576 * If the device is being destroyed; allow incoming
577 * traffic only to cleanup outstanding requests.
580 if (stor_device->destroy &&
581 (atomic_read(&stor_device->num_outstanding_req) == 0))
589 static void handle_sc_creation(struct vmbus_channel *new_sc)
591 struct hv_device *device = new_sc->primary_channel->device_obj;
592 struct storvsc_device *stor_device;
593 struct vmstorage_channel_properties props;
595 stor_device = get_out_stor_device(device);
599 if (stor_device->open_sub_channel == false)
602 memset(&props, 0, sizeof(struct vmstorage_channel_properties));
605 storvsc_ringbuffer_size,
606 storvsc_ringbuffer_size,
608 sizeof(struct vmstorage_channel_properties),
609 storvsc_on_channel_callback, new_sc);
612 static void handle_multichannel_storage(struct hv_device *device, int max_chns)
614 struct storvsc_device *stor_device;
615 int num_cpus = num_online_cpus();
617 struct storvsc_cmd_request *request;
618 struct vstor_packet *vstor_packet;
621 num_sc = ((max_chns > num_cpus) ? num_cpus : max_chns);
622 stor_device = get_out_stor_device(device);
626 request = &stor_device->init_request;
627 vstor_packet = &request->vstor_packet;
629 stor_device->open_sub_channel = true;
631 * Establish a handler for dealing with subchannels.
633 vmbus_set_sc_create_callback(device->channel, handle_sc_creation);
636 * Check to see if sub-channels have already been created. This
637 * can happen when this driver is re-loaded after unloading.
640 if (vmbus_are_subchannels_present(device->channel))
643 stor_device->open_sub_channel = false;
645 * Request the host to create sub-channels.
647 memset(request, 0, sizeof(struct storvsc_cmd_request));
648 init_completion(&request->wait_event);
649 vstor_packet->operation = VSTOR_OPERATION_CREATE_SUB_CHANNELS;
650 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
651 vstor_packet->sub_channel_count = num_sc;
653 ret = vmbus_sendpacket(device->channel, vstor_packet,
654 (sizeof(struct vstor_packet) -
656 (unsigned long)request,
658 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
663 t = wait_for_completion_timeout(&request->wait_event, 10*HZ);
667 if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
668 vstor_packet->status != 0)
672 * Now that we created the sub-channels, invoke the check; this
673 * may trigger the callback.
675 stor_device->open_sub_channel = true;
676 vmbus_are_subchannels_present(device->channel);
679 static int storvsc_channel_init(struct hv_device *device)
681 struct storvsc_device *stor_device;
682 struct storvsc_cmd_request *request;
683 struct vstor_packet *vstor_packet;
686 bool process_sub_channels = false;
688 stor_device = get_out_stor_device(device);
692 request = &stor_device->init_request;
693 vstor_packet = &request->vstor_packet;
696 * Now, initiate the vsc/vsp initialization protocol on the open
699 memset(request, 0, sizeof(struct storvsc_cmd_request));
700 init_completion(&request->wait_event);
701 vstor_packet->operation = VSTOR_OPERATION_BEGIN_INITIALIZATION;
702 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
704 ret = vmbus_sendpacket(device->channel, vstor_packet,
705 (sizeof(struct vstor_packet) -
707 (unsigned long)request,
709 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
713 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
719 if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
720 vstor_packet->status != 0) {
726 for (i = 0; i < ARRAY_SIZE(vmstor_protocols); i++) {
727 /* reuse the packet for version range supported */
728 memset(vstor_packet, 0, sizeof(struct vstor_packet));
729 vstor_packet->operation =
730 VSTOR_OPERATION_QUERY_PROTOCOL_VERSION;
731 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
733 vstor_packet->version.major_minor =
734 vmstor_protocols[i].protocol_version;
737 * The revision number is only used in Windows; set it to 0.
739 vstor_packet->version.revision = 0;
741 ret = vmbus_sendpacket(device->channel, vstor_packet,
742 (sizeof(struct vstor_packet) -
744 (unsigned long)request,
746 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
750 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
756 if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO) {
761 if (vstor_packet->status == 0) {
762 vmstor_proto_version =
763 vmstor_protocols[i].protocol_version;
766 vmstor_protocols[i].sense_buffer_size;
769 vmstor_protocols[i].vmscsi_size_delta;
775 if (vstor_packet->status != 0) {
781 memset(vstor_packet, 0, sizeof(struct vstor_packet));
782 vstor_packet->operation = VSTOR_OPERATION_QUERY_PROPERTIES;
783 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
785 ret = vmbus_sendpacket(device->channel, vstor_packet,
786 (sizeof(struct vstor_packet) -
788 (unsigned long)request,
790 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
795 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
801 if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
802 vstor_packet->status != 0) {
808 * Check to see if multi-channel support is there.
809 * Hosts that implement protocol version of 5.1 and above
810 * support multi-channel.
812 max_chns = vstor_packet->storage_channel_properties.max_channel_cnt;
813 if (vmstor_proto_version >= VMSTOR_PROTO_VERSION_WIN8) {
814 if (vstor_packet->storage_channel_properties.flags &
815 STORAGE_CHANNEL_SUPPORTS_MULTI_CHANNEL)
816 process_sub_channels = true;
818 stor_device->max_transfer_bytes =
819 vstor_packet->storage_channel_properties.max_transfer_bytes;
821 memset(vstor_packet, 0, sizeof(struct vstor_packet));
822 vstor_packet->operation = VSTOR_OPERATION_END_INITIALIZATION;
823 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
825 ret = vmbus_sendpacket(device->channel, vstor_packet,
826 (sizeof(struct vstor_packet) -
828 (unsigned long)request,
830 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
835 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
841 if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
842 vstor_packet->status != 0) {
847 if (process_sub_channels)
848 handle_multichannel_storage(device, max_chns);
855 static void storvsc_handle_error(struct vmscsi_request *vm_srb,
856 struct scsi_cmnd *scmnd,
857 struct Scsi_Host *host,
860 struct storvsc_scan_work *wrk;
861 void (*process_err_fn)(struct work_struct *work);
862 bool do_work = false;
864 switch (SRB_STATUS(vm_srb->srb_status)) {
865 case SRB_STATUS_ERROR:
867 * If there is an error; offline the device since all
868 * error recovery strategies would have already been
869 * deployed on the host side. However, if the command
870 * were a pass-through command deal with it appropriately.
872 switch (scmnd->cmnd[0]) {
875 set_host_byte(scmnd, DID_PASSTHROUGH);
878 * On Some Windows hosts TEST_UNIT_READY command can return
879 * SRB_STATUS_ERROR, let the upper level code deal with it
880 * based on the sense information.
882 case TEST_UNIT_READY:
885 set_host_byte(scmnd, DID_TARGET_FAILURE);
888 case SRB_STATUS_INVALID_LUN:
890 process_err_fn = storvsc_remove_lun;
892 case SRB_STATUS_ABORTED:
893 if (vm_srb->srb_status & SRB_STATUS_AUTOSENSE_VALID &&
894 (asc == 0x2a) && (ascq == 0x9)) {
896 process_err_fn = storvsc_device_scan;
898 * Retry the I/O that trigerred this.
900 set_host_byte(scmnd, DID_REQUEUE);
909 * We need to schedule work to process this error; schedule it.
911 wrk = kmalloc(sizeof(struct storvsc_scan_work), GFP_ATOMIC);
913 set_host_byte(scmnd, DID_TARGET_FAILURE);
918 wrk->lun = vm_srb->lun;
919 INIT_WORK(&wrk->work, process_err_fn);
920 schedule_work(&wrk->work);
924 static void storvsc_command_completion(struct storvsc_cmd_request *cmd_request)
926 struct scsi_cmnd *scmnd = cmd_request->cmd;
927 struct hv_host_device *host_dev = shost_priv(scmnd->device->host);
928 struct scsi_sense_hdr sense_hdr;
929 struct vmscsi_request *vm_srb;
930 struct Scsi_Host *host;
931 struct storvsc_device *stor_dev;
932 struct hv_device *dev = host_dev->dev;
933 u32 payload_sz = cmd_request->payload_sz;
934 void *payload = cmd_request->payload;
936 stor_dev = get_in_stor_device(dev);
937 host = stor_dev->host;
939 vm_srb = &cmd_request->vstor_packet.vm_srb;
941 scmnd->result = vm_srb->scsi_status;
944 if (scsi_normalize_sense(scmnd->sense_buffer,
945 SCSI_SENSE_BUFFERSIZE, &sense_hdr))
946 scsi_print_sense_hdr(scmnd->device, "storvsc",
950 if (vm_srb->srb_status != SRB_STATUS_SUCCESS)
951 storvsc_handle_error(vm_srb, scmnd, host, sense_hdr.asc,
954 scsi_set_resid(scmnd,
955 cmd_request->payload->range.len -
956 vm_srb->data_transfer_length);
958 scmnd->scsi_done(scmnd);
961 sizeof(struct vmbus_channel_packet_multipage_buffer))
965 static void storvsc_on_io_completion(struct hv_device *device,
966 struct vstor_packet *vstor_packet,
967 struct storvsc_cmd_request *request)
969 struct storvsc_device *stor_device;
970 struct vstor_packet *stor_pkt;
972 stor_device = hv_get_drvdata(device);
973 stor_pkt = &request->vstor_packet;
976 * The current SCSI handling on the host side does
977 * not correctly handle:
978 * INQUIRY command with page code parameter set to 0x80
979 * MODE_SENSE command with cmd[2] == 0x1c
981 * Setup srb and scsi status so this won't be fatal.
982 * We do this so we can distinguish truly fatal failues
983 * (srb status == 0x4) and off-line the device in that case.
986 if ((stor_pkt->vm_srb.cdb[0] == INQUIRY) ||
987 (stor_pkt->vm_srb.cdb[0] == MODE_SENSE)) {
988 vstor_packet->vm_srb.scsi_status = 0;
989 vstor_packet->vm_srb.srb_status = SRB_STATUS_SUCCESS;
993 /* Copy over the status...etc */
994 stor_pkt->vm_srb.scsi_status = vstor_packet->vm_srb.scsi_status;
995 stor_pkt->vm_srb.srb_status = vstor_packet->vm_srb.srb_status;
996 stor_pkt->vm_srb.sense_info_length =
997 vstor_packet->vm_srb.sense_info_length;
1000 if ((vstor_packet->vm_srb.scsi_status & 0xFF) == 0x02) {
1001 /* CHECK_CONDITION */
1002 if (vstor_packet->vm_srb.srb_status &
1003 SRB_STATUS_AUTOSENSE_VALID) {
1004 /* autosense data available */
1006 memcpy(request->cmd->sense_buffer,
1007 vstor_packet->vm_srb.sense_data,
1008 vstor_packet->vm_srb.sense_info_length);
1013 stor_pkt->vm_srb.data_transfer_length =
1014 vstor_packet->vm_srb.data_transfer_length;
1016 storvsc_command_completion(request);
1018 if (atomic_dec_and_test(&stor_device->num_outstanding_req) &&
1019 stor_device->drain_notify)
1020 wake_up(&stor_device->waiting_to_drain);
1025 static void storvsc_on_receive(struct hv_device *device,
1026 struct vstor_packet *vstor_packet,
1027 struct storvsc_cmd_request *request)
1029 struct storvsc_scan_work *work;
1030 struct storvsc_device *stor_device;
1032 switch (vstor_packet->operation) {
1033 case VSTOR_OPERATION_COMPLETE_IO:
1034 storvsc_on_io_completion(device, vstor_packet, request);
1037 case VSTOR_OPERATION_REMOVE_DEVICE:
1038 case VSTOR_OPERATION_ENUMERATE_BUS:
1039 stor_device = get_in_stor_device(device);
1040 work = kmalloc(sizeof(struct storvsc_scan_work), GFP_ATOMIC);
1044 INIT_WORK(&work->work, storvsc_host_scan);
1045 work->host = stor_device->host;
1046 schedule_work(&work->work);
1054 static void storvsc_on_channel_callback(void *context)
1056 struct vmbus_channel *channel = (struct vmbus_channel *)context;
1057 struct hv_device *device;
1058 struct storvsc_device *stor_device;
1061 unsigned char packet[ALIGN(sizeof(struct vstor_packet), 8)];
1062 struct storvsc_cmd_request *request;
1065 if (channel->primary_channel != NULL)
1066 device = channel->primary_channel->device_obj;
1068 device = channel->device_obj;
1070 stor_device = get_in_stor_device(device);
1075 ret = vmbus_recvpacket(channel, packet,
1076 ALIGN((sizeof(struct vstor_packet) -
1077 vmscsi_size_delta), 8),
1078 &bytes_recvd, &request_id);
1079 if (ret == 0 && bytes_recvd > 0) {
1081 request = (struct storvsc_cmd_request *)
1082 (unsigned long)request_id;
1084 if ((request == &stor_device->init_request) ||
1085 (request == &stor_device->reset_request)) {
1087 memcpy(&request->vstor_packet, packet,
1088 (sizeof(struct vstor_packet) -
1089 vmscsi_size_delta));
1090 complete(&request->wait_event);
1092 storvsc_on_receive(device,
1093 (struct vstor_packet *)packet,
1104 static int storvsc_connect_to_vsp(struct hv_device *device, u32 ring_size)
1106 struct vmstorage_channel_properties props;
1109 memset(&props, 0, sizeof(struct vmstorage_channel_properties));
1111 ret = vmbus_open(device->channel,
1115 sizeof(struct vmstorage_channel_properties),
1116 storvsc_on_channel_callback, device->channel);
1121 ret = storvsc_channel_init(device);
1126 static int storvsc_dev_remove(struct hv_device *device)
1128 struct storvsc_device *stor_device;
1129 unsigned long flags;
1131 stor_device = hv_get_drvdata(device);
1133 spin_lock_irqsave(&device->channel->inbound_lock, flags);
1134 stor_device->destroy = true;
1135 spin_unlock_irqrestore(&device->channel->inbound_lock, flags);
1138 * At this point, all outbound traffic should be disable. We
1139 * only allow inbound traffic (responses) to proceed so that
1140 * outstanding requests can be completed.
1143 storvsc_wait_to_drain(stor_device);
1146 * Since we have already drained, we don't need to busy wait
1147 * as was done in final_release_stor_device()
1148 * Note that we cannot set the ext pointer to NULL until
1149 * we have drained - to drain the outgoing packets, we need to
1150 * allow incoming packets.
1152 spin_lock_irqsave(&device->channel->inbound_lock, flags);
1153 hv_set_drvdata(device, NULL);
1154 spin_unlock_irqrestore(&device->channel->inbound_lock, flags);
1156 /* Close the channel */
1157 vmbus_close(device->channel);
1163 static int storvsc_do_io(struct hv_device *device,
1164 struct storvsc_cmd_request *request)
1166 struct storvsc_device *stor_device;
1167 struct vstor_packet *vstor_packet;
1168 struct vmbus_channel *outgoing_channel;
1171 vstor_packet = &request->vstor_packet;
1172 stor_device = get_out_stor_device(device);
1178 request->device = device;
1180 * Select an an appropriate channel to send the request out.
1183 outgoing_channel = vmbus_get_outgoing_channel(device->channel);
1186 vstor_packet->flags |= REQUEST_COMPLETION_FLAG;
1188 vstor_packet->vm_srb.length = (sizeof(struct vmscsi_request) -
1192 vstor_packet->vm_srb.sense_info_length = sense_buffer_size;
1195 vstor_packet->vm_srb.data_transfer_length =
1196 request->payload->range.len;
1198 vstor_packet->operation = VSTOR_OPERATION_EXECUTE_SRB;
1200 if (request->payload->range.len) {
1202 ret = vmbus_sendpacket_mpb_desc(outgoing_channel,
1203 request->payload, request->payload_sz,
1205 (sizeof(struct vstor_packet) -
1207 (unsigned long)request);
1209 ret = vmbus_sendpacket(outgoing_channel, vstor_packet,
1210 (sizeof(struct vstor_packet) -
1212 (unsigned long)request,
1214 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
1220 atomic_inc(&stor_device->num_outstanding_req);
1225 static int storvsc_device_configure(struct scsi_device *sdevice)
1228 blk_queue_max_segment_size(sdevice->request_queue, PAGE_SIZE);
1230 blk_queue_bounce_limit(sdevice->request_queue, BLK_BOUNCE_ANY);
1232 blk_queue_rq_timeout(sdevice->request_queue, (storvsc_timeout * HZ));
1234 /* Ensure there are no gaps in presented sgls */
1235 blk_queue_virt_boundary(sdevice->request_queue, PAGE_SIZE - 1);
1237 sdevice->no_write_same = 1;
1240 * Add blist flags to permit the reading of the VPD pages even when
1241 * the target may claim SPC-2 compliance. MSFT targets currently
1242 * claim SPC-2 compliance while they implement post SPC-2 features.
1243 * With this patch we can correctly handle WRITE_SAME_16 issues.
1245 sdevice->sdev_bflags |= msft_blist_flags;
1248 * If the host is WIN8 or WIN8 R2, claim conformance to SPC-3
1249 * if the device is a MSFT virtual device. If the host is
1250 * WIN10 or newer, allow write_same.
1252 if (!strncmp(sdevice->vendor, "Msft", 4)) {
1253 switch (vmstor_proto_version) {
1254 case VMSTOR_PROTO_VERSION_WIN8:
1255 case VMSTOR_PROTO_VERSION_WIN8_1:
1256 sdevice->scsi_level = SCSI_SPC_3;
1260 if (vmstor_proto_version >= VMSTOR_PROTO_VERSION_WIN10)
1261 sdevice->no_write_same = 0;
1267 static int storvsc_get_chs(struct scsi_device *sdev, struct block_device * bdev,
1268 sector_t capacity, int *info)
1270 sector_t nsect = capacity;
1271 sector_t cylinders = nsect;
1272 int heads, sectors_pt;
1275 * We are making up these values; let us keep it simple.
1278 sectors_pt = 0x3f; /* Sectors per track */
1279 sector_div(cylinders, heads * sectors_pt);
1280 if ((sector_t)(cylinders + 1) * heads * sectors_pt < nsect)
1284 info[1] = sectors_pt;
1285 info[2] = (int)cylinders;
1290 static int storvsc_host_reset_handler(struct scsi_cmnd *scmnd)
1292 struct hv_host_device *host_dev = shost_priv(scmnd->device->host);
1293 struct hv_device *device = host_dev->dev;
1295 struct storvsc_device *stor_device;
1296 struct storvsc_cmd_request *request;
1297 struct vstor_packet *vstor_packet;
1301 stor_device = get_out_stor_device(device);
1305 request = &stor_device->reset_request;
1306 vstor_packet = &request->vstor_packet;
1308 init_completion(&request->wait_event);
1310 vstor_packet->operation = VSTOR_OPERATION_RESET_BUS;
1311 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
1312 vstor_packet->vm_srb.path_id = stor_device->path_id;
1314 ret = vmbus_sendpacket(device->channel, vstor_packet,
1315 (sizeof(struct vstor_packet) -
1317 (unsigned long)&stor_device->reset_request,
1319 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
1323 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
1325 return TIMEOUT_ERROR;
1329 * At this point, all outstanding requests in the adapter
1330 * should have been flushed out and return to us
1331 * There is a potential race here where the host may be in
1332 * the process of responding when we return from here.
1333 * Just wait for all in-transit packets to be accounted for
1334 * before we return from here.
1336 storvsc_wait_to_drain(stor_device);
1342 * The host guarantees to respond to each command, although I/O latencies might
1343 * be unbounded on Azure. Reset the timer unconditionally to give the host a
1344 * chance to perform EH.
1346 static enum blk_eh_timer_return storvsc_eh_timed_out(struct scsi_cmnd *scmnd)
1348 return BLK_EH_RESET_TIMER;
1351 static bool storvsc_scsi_cmd_ok(struct scsi_cmnd *scmnd)
1353 bool allowed = true;
1354 u8 scsi_op = scmnd->cmnd[0];
1357 /* the host does not handle WRITE_SAME, log accident usage */
1360 * smartd sends this command and the host does not handle
1361 * this. So, don't send it.
1364 scmnd->result = ILLEGAL_REQUEST << 16;
1373 static int storvsc_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *scmnd)
1376 struct hv_host_device *host_dev = shost_priv(host);
1377 struct hv_device *dev = host_dev->dev;
1378 struct storvsc_cmd_request *cmd_request = scsi_cmd_priv(scmnd);
1380 struct scatterlist *sgl;
1381 unsigned int sg_count = 0;
1382 struct vmscsi_request *vm_srb;
1383 struct scatterlist *cur_sgl;
1384 struct vmbus_packet_mpb_array *payload;
1388 if (vmstor_proto_version <= VMSTOR_PROTO_VERSION_WIN8) {
1390 * On legacy hosts filter unimplemented commands.
1391 * Future hosts are expected to correctly handle
1392 * unsupported commands. Furthermore, it is
1393 * possible that some of the currently
1394 * unsupported commands maybe supported in
1395 * future versions of the host.
1397 if (!storvsc_scsi_cmd_ok(scmnd)) {
1398 scmnd->scsi_done(scmnd);
1403 /* Setup the cmd request */
1404 cmd_request->cmd = scmnd;
1406 vm_srb = &cmd_request->vstor_packet.vm_srb;
1407 vm_srb->win8_extension.time_out_value = 60;
1409 vm_srb->win8_extension.srb_flags |=
1410 SRB_FLAGS_DISABLE_SYNCH_TRANSFER;
1413 switch (scmnd->sc_data_direction) {
1415 vm_srb->data_in = WRITE_TYPE;
1416 vm_srb->win8_extension.srb_flags |= SRB_FLAGS_DATA_OUT;
1418 case DMA_FROM_DEVICE:
1419 vm_srb->data_in = READ_TYPE;
1420 vm_srb->win8_extension.srb_flags |= SRB_FLAGS_DATA_IN;
1423 vm_srb->data_in = UNKNOWN_TYPE;
1424 vm_srb->win8_extension.srb_flags |= SRB_FLAGS_NO_DATA_TRANSFER;
1428 * This is DMA_BIDIRECTIONAL or something else we are never
1429 * supposed to see here.
1431 WARN(1, "Unexpected data direction: %d\n",
1432 scmnd->sc_data_direction);
1437 vm_srb->port_number = host_dev->port;
1438 vm_srb->path_id = scmnd->device->channel;
1439 vm_srb->target_id = scmnd->device->id;
1440 vm_srb->lun = scmnd->device->lun;
1442 vm_srb->cdb_length = scmnd->cmd_len;
1444 memcpy(vm_srb->cdb, scmnd->cmnd, vm_srb->cdb_length);
1446 sgl = (struct scatterlist *)scsi_sglist(scmnd);
1447 sg_count = scsi_sg_count(scmnd);
1449 length = scsi_bufflen(scmnd);
1450 payload = (struct vmbus_packet_mpb_array *)&cmd_request->mpb;
1451 payload_sz = sizeof(cmd_request->mpb);
1454 if (sg_count > MAX_PAGE_BUFFER_COUNT) {
1456 payload_sz = (sg_count * sizeof(void *) +
1457 sizeof(struct vmbus_packet_mpb_array));
1458 payload = kmalloc(payload_sz, GFP_ATOMIC);
1460 return SCSI_MLQUEUE_DEVICE_BUSY;
1463 payload->range.len = length;
1464 payload->range.offset = sgl[0].offset;
1467 for (i = 0; i < sg_count; i++) {
1468 payload->range.pfn_array[i] =
1469 page_to_pfn(sg_page((cur_sgl)));
1470 cur_sgl = sg_next(cur_sgl);
1473 } else if (scsi_sglist(scmnd)) {
1474 payload->range.len = length;
1475 payload->range.offset =
1476 virt_to_phys(scsi_sglist(scmnd)) & (PAGE_SIZE-1);
1477 payload->range.pfn_array[0] =
1478 virt_to_phys(scsi_sglist(scmnd)) >> PAGE_SHIFT;
1481 cmd_request->payload = payload;
1482 cmd_request->payload_sz = payload_sz;
1484 /* Invokes the vsc to start an IO */
1485 ret = storvsc_do_io(dev, cmd_request);
1487 if (ret == -EAGAIN) {
1489 return SCSI_MLQUEUE_DEVICE_BUSY;
1495 static struct scsi_host_template scsi_driver = {
1496 .module = THIS_MODULE,
1497 .name = "storvsc_host_t",
1498 .cmd_size = sizeof(struct storvsc_cmd_request),
1499 .bios_param = storvsc_get_chs,
1500 .queuecommand = storvsc_queuecommand,
1501 .eh_host_reset_handler = storvsc_host_reset_handler,
1502 .proc_name = "storvsc_host",
1503 .eh_timed_out = storvsc_eh_timed_out,
1504 .slave_configure = storvsc_device_configure,
1507 .use_clustering = ENABLE_CLUSTERING,
1508 /* Make sure we dont get a sg segment crosses a page boundary */
1509 .dma_boundary = PAGE_SIZE-1,
1519 static const struct hv_vmbus_device_id id_table[] = {
1522 .driver_data = SCSI_GUID
1526 .driver_data = IDE_GUID
1528 /* Fibre Channel GUID */
1531 .driver_data = SFC_GUID
1536 MODULE_DEVICE_TABLE(vmbus, id_table);
1538 static int storvsc_probe(struct hv_device *device,
1539 const struct hv_vmbus_device_id *dev_id)
1542 int num_cpus = num_online_cpus();
1543 struct Scsi_Host *host;
1544 struct hv_host_device *host_dev;
1545 bool dev_is_ide = ((dev_id->driver_data == IDE_GUID) ? true : false);
1547 struct storvsc_device *stor_device;
1548 int max_luns_per_target;
1551 int max_sub_channels = 0;
1554 * Based on the windows host we are running on,
1555 * set state to properly communicate with the host.
1558 if (vmbus_proto_version < VERSION_WIN8) {
1559 max_luns_per_target = STORVSC_IDE_MAX_LUNS_PER_TARGET;
1560 max_targets = STORVSC_IDE_MAX_TARGETS;
1561 max_channels = STORVSC_IDE_MAX_CHANNELS;
1563 max_luns_per_target = STORVSC_MAX_LUNS_PER_TARGET;
1564 max_targets = STORVSC_MAX_TARGETS;
1565 max_channels = STORVSC_MAX_CHANNELS;
1567 * On Windows8 and above, we support sub-channels for storage.
1568 * The number of sub-channels offerred is based on the number of
1569 * VCPUs in the guest.
1571 max_sub_channels = (num_cpus / storvsc_vcpus_per_sub_channel);
1574 scsi_driver.can_queue = (max_outstanding_req_per_channel *
1575 (max_sub_channels + 1));
1577 host = scsi_host_alloc(&scsi_driver,
1578 sizeof(struct hv_host_device));
1582 host_dev = shost_priv(host);
1583 memset(host_dev, 0, sizeof(struct hv_host_device));
1585 host_dev->port = host->host_no;
1586 host_dev->dev = device;
1589 stor_device = kzalloc(sizeof(struct storvsc_device), GFP_KERNEL);
1595 stor_device->destroy = false;
1596 stor_device->open_sub_channel = false;
1597 init_waitqueue_head(&stor_device->waiting_to_drain);
1598 stor_device->device = device;
1599 stor_device->host = host;
1600 hv_set_drvdata(device, stor_device);
1602 stor_device->port_number = host->host_no;
1603 ret = storvsc_connect_to_vsp(device, storvsc_ringbuffer_size);
1607 host_dev->path = stor_device->path_id;
1608 host_dev->target = stor_device->target_id;
1610 switch (dev_id->driver_data) {
1612 host->max_lun = STORVSC_FC_MAX_LUNS_PER_TARGET;
1613 host->max_id = STORVSC_FC_MAX_TARGETS;
1614 host->max_channel = STORVSC_FC_MAX_CHANNELS - 1;
1618 host->max_lun = max_luns_per_target;
1619 host->max_id = max_targets;
1620 host->max_channel = max_channels - 1;
1624 host->max_lun = STORVSC_IDE_MAX_LUNS_PER_TARGET;
1625 host->max_id = STORVSC_IDE_MAX_TARGETS;
1626 host->max_channel = STORVSC_IDE_MAX_CHANNELS - 1;
1629 /* max cmd length */
1630 host->max_cmd_len = STORVSC_MAX_CMD_LEN;
1633 * set the table size based on the info we got
1636 host->sg_tablesize = (stor_device->max_transfer_bytes >> PAGE_SHIFT);
1638 /* Register the HBA and start the scsi bus scan */
1639 ret = scsi_add_host(host, &device->device);
1644 scsi_scan_host(host);
1646 target = (device->dev_instance.b[5] << 8 |
1647 device->dev_instance.b[4]);
1648 ret = scsi_add_device(host, 0, target, 0);
1650 scsi_remove_host(host);
1658 * Once we have connected with the host, we would need to
1659 * to invoke storvsc_dev_remove() to rollback this state and
1660 * this call also frees up the stor_device; hence the jump around
1663 storvsc_dev_remove(device);
1670 scsi_host_put(host);
1674 static int storvsc_remove(struct hv_device *dev)
1676 struct storvsc_device *stor_device = hv_get_drvdata(dev);
1677 struct Scsi_Host *host = stor_device->host;
1679 scsi_remove_host(host);
1680 storvsc_dev_remove(dev);
1681 scsi_host_put(host);
1686 static struct hv_driver storvsc_drv = {
1687 .name = KBUILD_MODNAME,
1688 .id_table = id_table,
1689 .probe = storvsc_probe,
1690 .remove = storvsc_remove,
1693 static int __init storvsc_drv_init(void)
1697 * Divide the ring buffer data size (which is 1 page less
1698 * than the ring buffer size since that page is reserved for
1699 * the ring buffer indices) by the max request size (which is
1700 * vmbus_channel_packet_multipage_buffer + struct vstor_packet + u64)
1702 max_outstanding_req_per_channel =
1703 ((storvsc_ringbuffer_size - PAGE_SIZE) /
1704 ALIGN(MAX_MULTIPAGE_BUFFER_PACKET +
1705 sizeof(struct vstor_packet) + sizeof(u64) -
1709 return vmbus_driver_register(&storvsc_drv);
1712 static void __exit storvsc_drv_exit(void)
1714 vmbus_driver_unregister(&storvsc_drv);
1717 MODULE_LICENSE("GPL");
1718 MODULE_DESCRIPTION("Microsoft Hyper-V virtual storage driver");
1719 module_init(storvsc_drv_init);
1720 module_exit(storvsc_drv_exit);