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>
44 #include <scsi/scsi_transport_fc.h>
45 #include <scsi/scsi_transport.h>
48 * All wire protocol details (storage protocol between the guest and the host)
49 * are consolidated here.
51 * Begin protocol definitions.
57 * V1 RC < 2008/1/31: 1.0
58 * V1 RC > 2008/1/31: 2.0
65 #define VMSTOR_PROTO_VERSION(MAJOR_, MINOR_) ((((MAJOR_) & 0xff) << 8) | \
68 #define VMSTOR_PROTO_VERSION_WIN6 VMSTOR_PROTO_VERSION(2, 0)
69 #define VMSTOR_PROTO_VERSION_WIN7 VMSTOR_PROTO_VERSION(4, 2)
70 #define VMSTOR_PROTO_VERSION_WIN8 VMSTOR_PROTO_VERSION(5, 1)
71 #define VMSTOR_PROTO_VERSION_WIN8_1 VMSTOR_PROTO_VERSION(6, 0)
72 #define VMSTOR_PROTO_VERSION_WIN10 VMSTOR_PROTO_VERSION(6, 2)
74 /* Packet structure describing virtual storage requests. */
75 enum vstor_packet_operation
{
76 VSTOR_OPERATION_COMPLETE_IO
= 1,
77 VSTOR_OPERATION_REMOVE_DEVICE
= 2,
78 VSTOR_OPERATION_EXECUTE_SRB
= 3,
79 VSTOR_OPERATION_RESET_LUN
= 4,
80 VSTOR_OPERATION_RESET_ADAPTER
= 5,
81 VSTOR_OPERATION_RESET_BUS
= 6,
82 VSTOR_OPERATION_BEGIN_INITIALIZATION
= 7,
83 VSTOR_OPERATION_END_INITIALIZATION
= 8,
84 VSTOR_OPERATION_QUERY_PROTOCOL_VERSION
= 9,
85 VSTOR_OPERATION_QUERY_PROPERTIES
= 10,
86 VSTOR_OPERATION_ENUMERATE_BUS
= 11,
87 VSTOR_OPERATION_FCHBA_DATA
= 12,
88 VSTOR_OPERATION_CREATE_SUB_CHANNELS
= 13,
89 VSTOR_OPERATION_MAXIMUM
= 13
93 * WWN packet for Fibre Channel HBA
96 struct hv_fc_wwn_packet
{
99 u8 primary_port_wwn
[8];
100 u8 primary_node_wwn
[8];
101 u8 secondary_port_wwn
[8];
102 u8 secondary_node_wwn
[8];
111 #define SRB_FLAGS_QUEUE_ACTION_ENABLE 0x00000002
112 #define SRB_FLAGS_DISABLE_DISCONNECT 0x00000004
113 #define SRB_FLAGS_DISABLE_SYNCH_TRANSFER 0x00000008
114 #define SRB_FLAGS_BYPASS_FROZEN_QUEUE 0x00000010
115 #define SRB_FLAGS_DISABLE_AUTOSENSE 0x00000020
116 #define SRB_FLAGS_DATA_IN 0x00000040
117 #define SRB_FLAGS_DATA_OUT 0x00000080
118 #define SRB_FLAGS_NO_DATA_TRANSFER 0x00000000
119 #define SRB_FLAGS_UNSPECIFIED_DIRECTION (SRB_FLAGS_DATA_IN | SRB_FLAGS_DATA_OUT)
120 #define SRB_FLAGS_NO_QUEUE_FREEZE 0x00000100
121 #define SRB_FLAGS_ADAPTER_CACHE_ENABLE 0x00000200
122 #define SRB_FLAGS_FREE_SENSE_BUFFER 0x00000400
125 * This flag indicates the request is part of the workflow for processing a D3.
127 #define SRB_FLAGS_D3_PROCESSING 0x00000800
128 #define SRB_FLAGS_IS_ACTIVE 0x00010000
129 #define SRB_FLAGS_ALLOCATED_FROM_ZONE 0x00020000
130 #define SRB_FLAGS_SGLIST_FROM_POOL 0x00040000
131 #define SRB_FLAGS_BYPASS_LOCKED_QUEUE 0x00080000
132 #define SRB_FLAGS_NO_KEEP_AWAKE 0x00100000
133 #define SRB_FLAGS_PORT_DRIVER_ALLOCSENSE 0x00200000
134 #define SRB_FLAGS_PORT_DRIVER_SENSEHASPORT 0x00400000
135 #define SRB_FLAGS_DONT_START_NEXT_PACKET 0x00800000
136 #define SRB_FLAGS_PORT_DRIVER_RESERVED 0x0F000000
137 #define SRB_FLAGS_CLASS_DRIVER_RESERVED 0xF0000000
139 #define SP_UNTAGGED ((unsigned char) ~0)
140 #define SRB_SIMPLE_TAG_REQUEST 0x20
143 * Platform neutral description of a scsi request -
144 * this remains the same across the write regardless of 32/64 bit
145 * note: it's patterned off the SCSI_PASS_THROUGH structure
147 #define STORVSC_MAX_CMD_LEN 0x10
149 #define POST_WIN7_STORVSC_SENSE_BUFFER_SIZE 0x14
150 #define PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE 0x12
152 #define STORVSC_SENSE_BUFFER_SIZE 0x14
153 #define STORVSC_MAX_BUF_LEN_WITH_PADDING 0x14
156 * Sense buffer size changed in win8; have a run-time
157 * variable to track the size we should use. This value will
158 * likely change during protocol negotiation but it is valid
159 * to start by assuming pre-Win8.
161 static int sense_buffer_size
= PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE
;
164 * The storage protocol version is determined during the
165 * initial exchange with the host. It will indicate which
166 * storage functionality is available in the host.
168 static int vmstor_proto_version
;
170 #define STORVSC_LOGGING_NONE 0
171 #define STORVSC_LOGGING_ERROR 1
172 #define STORVSC_LOGGING_WARN 2
174 static int logging_level
= STORVSC_LOGGING_ERROR
;
175 module_param(logging_level
, int, S_IRUGO
|S_IWUSR
);
176 MODULE_PARM_DESC(logging_level
,
177 "Logging level, 0 - None, 1 - Error (default), 2 - Warning.");
179 static inline bool do_logging(int level
)
181 return logging_level
>= level
;
184 #define storvsc_log(dev, level, fmt, ...) \
186 if (do_logging(level)) \
187 dev_warn(&(dev)->device, fmt, ##__VA_ARGS__); \
190 struct vmscsi_win8_extension
{
192 * The following were added in Windows 8
202 struct vmscsi_request
{
213 u8 sense_info_length
;
217 u32 data_transfer_length
;
220 u8 cdb
[STORVSC_MAX_CMD_LEN
];
221 u8 sense_data
[STORVSC_SENSE_BUFFER_SIZE
];
222 u8 reserved_array
[STORVSC_MAX_BUF_LEN_WITH_PADDING
];
225 * The following was added in win8.
227 struct vmscsi_win8_extension win8_extension
;
229 } __attribute((packed
));
233 * The size of the vmscsi_request has changed in win8. The
234 * additional size is because of new elements added to the
235 * structure. These elements are valid only when we are talking
237 * Track the correction to size we need to apply. This value
238 * will likely change during protocol negotiation but it is
239 * valid to start by assuming pre-Win8.
241 static int vmscsi_size_delta
= sizeof(struct vmscsi_win8_extension
);
244 * The list of storage protocols in order of preference.
246 struct vmstor_protocol
{
247 int protocol_version
;
248 int sense_buffer_size
;
249 int vmscsi_size_delta
;
253 static const struct vmstor_protocol vmstor_protocols
[] = {
255 VMSTOR_PROTO_VERSION_WIN10
,
256 POST_WIN7_STORVSC_SENSE_BUFFER_SIZE
,
260 VMSTOR_PROTO_VERSION_WIN8_1
,
261 POST_WIN7_STORVSC_SENSE_BUFFER_SIZE
,
265 VMSTOR_PROTO_VERSION_WIN8
,
266 POST_WIN7_STORVSC_SENSE_BUFFER_SIZE
,
270 VMSTOR_PROTO_VERSION_WIN7
,
271 PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE
,
272 sizeof(struct vmscsi_win8_extension
),
275 VMSTOR_PROTO_VERSION_WIN6
,
276 PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE
,
277 sizeof(struct vmscsi_win8_extension
),
283 * This structure is sent during the initialization phase to get the different
284 * properties of the channel.
287 #define STORAGE_CHANNEL_SUPPORTS_MULTI_CHANNEL 0x1
289 struct vmstorage_channel_properties
{
295 u32 max_transfer_bytes
;
300 /* This structure is sent during the storage protocol negotiations. */
301 struct vmstorage_protocol_version
{
302 /* Major (MSW) and minor (LSW) version numbers. */
306 * Revision number is auto-incremented whenever this file is changed
307 * (See FILL_VMSTOR_REVISION macro above). Mismatch does not
308 * definitely indicate incompatibility--but it does indicate mismatched
310 * This is only used on the windows side. Just set it to 0.
315 /* Channel Property Flags */
316 #define STORAGE_CHANNEL_REMOVABLE_FLAG 0x1
317 #define STORAGE_CHANNEL_EMULATED_IDE_FLAG 0x2
319 struct vstor_packet
{
320 /* Requested operation type */
321 enum vstor_packet_operation operation
;
323 /* Flags - see below for values */
326 /* Status of the request returned from the server side. */
329 /* Data payload area */
332 * Structure used to forward SCSI commands from the
333 * client to the server.
335 struct vmscsi_request vm_srb
;
337 /* Structure used to query channel properties. */
338 struct vmstorage_channel_properties storage_channel_properties
;
340 /* Used during version negotiations. */
341 struct vmstorage_protocol_version version
;
343 /* Fibre channel address packet */
344 struct hv_fc_wwn_packet wwn_packet
;
346 /* Number of sub-channels to create */
347 u16 sub_channel_count
;
349 /* This will be the maximum of the union members */
357 * This flag indicates that the server should send back a completion for this
361 #define REQUEST_COMPLETION_FLAG 0x1
363 /* Matches Windows-end */
364 enum storvsc_request_type
{
371 * SRB status codes and masks; a subset of the codes used here.
374 #define SRB_STATUS_AUTOSENSE_VALID 0x80
375 #define SRB_STATUS_QUEUE_FROZEN 0x40
376 #define SRB_STATUS_INVALID_LUN 0x20
377 #define SRB_STATUS_SUCCESS 0x01
378 #define SRB_STATUS_ABORTED 0x02
379 #define SRB_STATUS_ERROR 0x04
380 #define SRB_STATUS_DATA_OVERRUN 0x12
382 #define SRB_STATUS(status) \
383 (status & ~(SRB_STATUS_AUTOSENSE_VALID | SRB_STATUS_QUEUE_FROZEN))
385 * This is the end of Protocol specific defines.
388 static int storvsc_ringbuffer_size
= (256 * PAGE_SIZE
);
389 static u32 max_outstanding_req_per_channel
;
391 static int storvsc_vcpus_per_sub_channel
= 4;
393 module_param(storvsc_ringbuffer_size
, int, S_IRUGO
);
394 MODULE_PARM_DESC(storvsc_ringbuffer_size
, "Ring buffer size (bytes)");
396 module_param(storvsc_vcpus_per_sub_channel
, int, S_IRUGO
);
397 MODULE_PARM_DESC(storvsc_vcpus_per_sub_channel
, "Ratio of VCPUs to subchannels");
399 * Timeout in seconds for all devices managed by this driver.
401 static int storvsc_timeout
= 180;
403 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
404 static struct scsi_transport_template
*fc_transport_template
;
407 static void storvsc_on_channel_callback(void *context
);
409 #define STORVSC_MAX_LUNS_PER_TARGET 255
410 #define STORVSC_MAX_TARGETS 2
411 #define STORVSC_MAX_CHANNELS 8
413 #define STORVSC_FC_MAX_LUNS_PER_TARGET 255
414 #define STORVSC_FC_MAX_TARGETS 128
415 #define STORVSC_FC_MAX_CHANNELS 8
417 #define STORVSC_IDE_MAX_LUNS_PER_TARGET 64
418 #define STORVSC_IDE_MAX_TARGETS 1
419 #define STORVSC_IDE_MAX_CHANNELS 1
421 struct storvsc_cmd_request
{
422 struct scsi_cmnd
*cmd
;
424 struct hv_device
*device
;
426 /* Synchronize the request/response if needed */
427 struct completion wait_event
;
429 struct vmbus_channel_packet_multipage_buffer mpb
;
430 struct vmbus_packet_mpb_array
*payload
;
433 struct vstor_packet vstor_packet
;
437 /* A storvsc device is a device object that contains a vmbus channel */
438 struct storvsc_device
{
439 struct hv_device
*device
;
443 bool open_sub_channel
;
444 atomic_t num_outstanding_req
;
445 struct Scsi_Host
*host
;
447 wait_queue_head_t waiting_to_drain
;
450 * Each unique Port/Path/Target represents 1 channel ie scsi
451 * controller. In reality, the pathid, targetid is always 0
452 * and the port is set by us
454 unsigned int port_number
;
455 unsigned char path_id
;
456 unsigned char target_id
;
459 * Max I/O, the device can support.
461 u32 max_transfer_bytes
;
463 * Number of sub-channels we will open.
466 struct vmbus_channel
**stor_chns
;
468 * Mask of CPUs bound to subchannels.
470 struct cpumask alloced_cpus
;
471 /* Used for vsc/vsp channel reset process */
472 struct storvsc_cmd_request init_request
;
473 struct storvsc_cmd_request reset_request
;
475 * Currently active port and node names for FC devices.
481 struct hv_host_device
{
482 struct hv_device
*dev
;
485 unsigned char target
;
488 struct storvsc_scan_work
{
489 struct work_struct work
;
490 struct Scsi_Host
*host
;
495 static void storvsc_device_scan(struct work_struct
*work
)
497 struct storvsc_scan_work
*wrk
;
498 struct scsi_device
*sdev
;
500 wrk
= container_of(work
, struct storvsc_scan_work
, work
);
502 sdev
= scsi_device_lookup(wrk
->host
, 0, wrk
->tgt_id
, wrk
->lun
);
505 scsi_rescan_device(&sdev
->sdev_gendev
);
506 scsi_device_put(sdev
);
512 static void storvsc_host_scan(struct work_struct
*work
)
514 struct storvsc_scan_work
*wrk
;
515 struct Scsi_Host
*host
;
516 struct scsi_device
*sdev
;
518 wrk
= container_of(work
, struct storvsc_scan_work
, work
);
522 * Before scanning the host, first check to see if any of the
523 * currrently known devices have been hot removed. We issue a
524 * "unit ready" command against all currently known devices.
525 * This I/O will result in an error for devices that have been
526 * removed. As part of handling the I/O error, we remove the device.
528 * When a LUN is added or removed, the host sends us a signal to
529 * scan the host. Thus we are forced to discover the LUNs that
530 * may have been removed this way.
532 mutex_lock(&host
->scan_mutex
);
533 shost_for_each_device(sdev
, host
)
534 scsi_test_unit_ready(sdev
, 1, 1, NULL
);
535 mutex_unlock(&host
->scan_mutex
);
537 * Now scan the host to discover LUNs that may have been added.
539 scsi_scan_host(host
);
544 static void storvsc_remove_lun(struct work_struct
*work
)
546 struct storvsc_scan_work
*wrk
;
547 struct scsi_device
*sdev
;
549 wrk
= container_of(work
, struct storvsc_scan_work
, work
);
550 if (!scsi_host_get(wrk
->host
))
553 sdev
= scsi_device_lookup(wrk
->host
, 0, wrk
->tgt_id
, wrk
->lun
);
556 scsi_remove_device(sdev
);
557 scsi_device_put(sdev
);
559 scsi_host_put(wrk
->host
);
567 * We can get incoming messages from the host that are not in response to
568 * messages that we have sent out. An example of this would be messages
569 * received by the guest to notify dynamic addition/removal of LUNs. To
570 * deal with potential race conditions where the driver may be in the
571 * midst of being unloaded when we might receive an unsolicited message
572 * from the host, we have implemented a mechanism to gurantee sequential
575 * 1) Once the device is marked as being destroyed, we will fail all
577 * 2) We permit incoming messages when the device is being destroyed,
578 * only to properly account for messages already sent out.
581 static inline struct storvsc_device
*get_out_stor_device(
582 struct hv_device
*device
)
584 struct storvsc_device
*stor_device
;
586 stor_device
= hv_get_drvdata(device
);
588 if (stor_device
&& stor_device
->destroy
)
595 static inline void storvsc_wait_to_drain(struct storvsc_device
*dev
)
597 dev
->drain_notify
= true;
598 wait_event(dev
->waiting_to_drain
,
599 atomic_read(&dev
->num_outstanding_req
) == 0);
600 dev
->drain_notify
= false;
603 static inline struct storvsc_device
*get_in_stor_device(
604 struct hv_device
*device
)
606 struct storvsc_device
*stor_device
;
608 stor_device
= hv_get_drvdata(device
);
614 * If the device is being destroyed; allow incoming
615 * traffic only to cleanup outstanding requests.
618 if (stor_device
->destroy
&&
619 (atomic_read(&stor_device
->num_outstanding_req
) == 0))
627 static void handle_sc_creation(struct vmbus_channel
*new_sc
)
629 struct hv_device
*device
= new_sc
->primary_channel
->device_obj
;
630 struct storvsc_device
*stor_device
;
631 struct vmstorage_channel_properties props
;
633 stor_device
= get_out_stor_device(device
);
637 if (stor_device
->open_sub_channel
== false)
640 memset(&props
, 0, sizeof(struct vmstorage_channel_properties
));
643 storvsc_ringbuffer_size
,
644 storvsc_ringbuffer_size
,
646 sizeof(struct vmstorage_channel_properties
),
647 storvsc_on_channel_callback
, new_sc
);
649 if (new_sc
->state
== CHANNEL_OPENED_STATE
) {
650 stor_device
->stor_chns
[new_sc
->target_cpu
] = new_sc
;
651 cpumask_set_cpu(new_sc
->target_cpu
, &stor_device
->alloced_cpus
);
655 static void handle_multichannel_storage(struct hv_device
*device
, int max_chns
)
657 struct storvsc_device
*stor_device
;
658 int num_cpus
= num_online_cpus();
660 struct storvsc_cmd_request
*request
;
661 struct vstor_packet
*vstor_packet
;
664 num_sc
= ((max_chns
> num_cpus
) ? num_cpus
: max_chns
);
665 stor_device
= get_out_stor_device(device
);
669 stor_device
->num_sc
= num_sc
;
670 request
= &stor_device
->init_request
;
671 vstor_packet
= &request
->vstor_packet
;
673 stor_device
->open_sub_channel
= true;
675 * Establish a handler for dealing with subchannels.
677 vmbus_set_sc_create_callback(device
->channel
, handle_sc_creation
);
680 * Check to see if sub-channels have already been created. This
681 * can happen when this driver is re-loaded after unloading.
684 if (vmbus_are_subchannels_present(device
->channel
))
687 stor_device
->open_sub_channel
= false;
689 * Request the host to create sub-channels.
691 memset(request
, 0, sizeof(struct storvsc_cmd_request
));
692 init_completion(&request
->wait_event
);
693 vstor_packet
->operation
= VSTOR_OPERATION_CREATE_SUB_CHANNELS
;
694 vstor_packet
->flags
= REQUEST_COMPLETION_FLAG
;
695 vstor_packet
->sub_channel_count
= num_sc
;
697 ret
= vmbus_sendpacket(device
->channel
, vstor_packet
,
698 (sizeof(struct vstor_packet
) -
700 (unsigned long)request
,
702 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED
);
707 t
= wait_for_completion_timeout(&request
->wait_event
, 10*HZ
);
711 if (vstor_packet
->operation
!= VSTOR_OPERATION_COMPLETE_IO
||
712 vstor_packet
->status
!= 0)
716 * Now that we created the sub-channels, invoke the check; this
717 * may trigger the callback.
719 stor_device
->open_sub_channel
= true;
720 vmbus_are_subchannels_present(device
->channel
);
723 static void cache_wwn(struct storvsc_device
*stor_device
,
724 struct vstor_packet
*vstor_packet
)
727 * Cache the currently active port and node ww names.
729 if (vstor_packet
->wwn_packet
.primary_active
) {
730 stor_device
->node_name
=
731 wwn_to_u64(vstor_packet
->wwn_packet
.primary_node_wwn
);
732 stor_device
->port_name
=
733 wwn_to_u64(vstor_packet
->wwn_packet
.primary_port_wwn
);
735 stor_device
->node_name
=
736 wwn_to_u64(vstor_packet
->wwn_packet
.secondary_node_wwn
);
737 stor_device
->port_name
=
738 wwn_to_u64(vstor_packet
->wwn_packet
.secondary_port_wwn
);
743 static int storvsc_execute_vstor_op(struct hv_device
*device
,
744 struct storvsc_cmd_request
*request
,
747 struct vstor_packet
*vstor_packet
;
750 vstor_packet
= &request
->vstor_packet
;
752 init_completion(&request
->wait_event
);
753 vstor_packet
->flags
= REQUEST_COMPLETION_FLAG
;
755 ret
= vmbus_sendpacket(device
->channel
, vstor_packet
,
756 (sizeof(struct vstor_packet
) -
758 (unsigned long)request
,
760 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED
);
764 t
= wait_for_completion_timeout(&request
->wait_event
, 5*HZ
);
771 if (vstor_packet
->operation
!= VSTOR_OPERATION_COMPLETE_IO
||
772 vstor_packet
->status
!= 0)
778 static int storvsc_channel_init(struct hv_device
*device
, bool is_fc
)
780 struct storvsc_device
*stor_device
;
781 struct storvsc_cmd_request
*request
;
782 struct vstor_packet
*vstor_packet
;
785 bool process_sub_channels
= false;
787 stor_device
= get_out_stor_device(device
);
791 request
= &stor_device
->init_request
;
792 vstor_packet
= &request
->vstor_packet
;
795 * Now, initiate the vsc/vsp initialization protocol on the open
798 memset(request
, 0, sizeof(struct storvsc_cmd_request
));
799 vstor_packet
->operation
= VSTOR_OPERATION_BEGIN_INITIALIZATION
;
800 ret
= storvsc_execute_vstor_op(device
, request
, true);
804 * Query host supported protocol version.
807 for (i
= 0; i
< ARRAY_SIZE(vmstor_protocols
); i
++) {
808 /* reuse the packet for version range supported */
809 memset(vstor_packet
, 0, sizeof(struct vstor_packet
));
810 vstor_packet
->operation
=
811 VSTOR_OPERATION_QUERY_PROTOCOL_VERSION
;
813 vstor_packet
->version
.major_minor
=
814 vmstor_protocols
[i
].protocol_version
;
817 * The revision number is only used in Windows; set it to 0.
819 vstor_packet
->version
.revision
= 0;
820 ret
= storvsc_execute_vstor_op(device
, request
, false);
824 if (vstor_packet
->operation
!= VSTOR_OPERATION_COMPLETE_IO
)
827 if (vstor_packet
->status
== 0) {
828 vmstor_proto_version
=
829 vmstor_protocols
[i
].protocol_version
;
832 vmstor_protocols
[i
].sense_buffer_size
;
835 vmstor_protocols
[i
].vmscsi_size_delta
;
841 if (vstor_packet
->status
!= 0)
845 memset(vstor_packet
, 0, sizeof(struct vstor_packet
));
846 vstor_packet
->operation
= VSTOR_OPERATION_QUERY_PROPERTIES
;
847 ret
= storvsc_execute_vstor_op(device
, request
, true);
852 * Check to see if multi-channel support is there.
853 * Hosts that implement protocol version of 5.1 and above
854 * support multi-channel.
856 max_chns
= vstor_packet
->storage_channel_properties
.max_channel_cnt
;
859 * Allocate state to manage the sub-channels.
860 * We allocate an array based on the numbers of possible CPUs
861 * (Hyper-V does not support cpu online/offline).
862 * This Array will be sparseley populated with unique
863 * channels - primary + sub-channels.
864 * We will however populate all the slots to evenly distribute
867 stor_device
->stor_chns
= kzalloc(sizeof(void *) * num_possible_cpus(),
869 if (stor_device
->stor_chns
== NULL
)
872 stor_device
->stor_chns
[device
->channel
->target_cpu
] = device
->channel
;
873 cpumask_set_cpu(device
->channel
->target_cpu
,
874 &stor_device
->alloced_cpus
);
876 if (vmstor_proto_version
>= VMSTOR_PROTO_VERSION_WIN8
) {
877 if (vstor_packet
->storage_channel_properties
.flags
&
878 STORAGE_CHANNEL_SUPPORTS_MULTI_CHANNEL
)
879 process_sub_channels
= true;
881 stor_device
->max_transfer_bytes
=
882 vstor_packet
->storage_channel_properties
.max_transfer_bytes
;
888 * For FC devices retrieve FC HBA data.
890 memset(vstor_packet
, 0, sizeof(struct vstor_packet
));
891 vstor_packet
->operation
= VSTOR_OPERATION_FCHBA_DATA
;
892 ret
= storvsc_execute_vstor_op(device
, request
, true);
897 * Cache the currently active port and node ww names.
899 cache_wwn(stor_device
, vstor_packet
);
903 memset(vstor_packet
, 0, sizeof(struct vstor_packet
));
904 vstor_packet
->operation
= VSTOR_OPERATION_END_INITIALIZATION
;
905 ret
= storvsc_execute_vstor_op(device
, request
, true);
909 if (process_sub_channels
)
910 handle_multichannel_storage(device
, max_chns
);
915 static void storvsc_handle_error(struct vmscsi_request
*vm_srb
,
916 struct scsi_cmnd
*scmnd
,
917 struct Scsi_Host
*host
,
920 struct storvsc_scan_work
*wrk
;
921 void (*process_err_fn
)(struct work_struct
*work
);
922 bool do_work
= false;
924 switch (SRB_STATUS(vm_srb
->srb_status
)) {
925 case SRB_STATUS_ERROR
:
927 * Let upper layer deal with error when
928 * sense message is present.
931 if (vm_srb
->srb_status
& SRB_STATUS_AUTOSENSE_VALID
)
934 * If there is an error; offline the device since all
935 * error recovery strategies would have already been
936 * deployed on the host side. However, if the command
937 * were a pass-through command deal with it appropriately.
939 switch (scmnd
->cmnd
[0]) {
942 set_host_byte(scmnd
, DID_PASSTHROUGH
);
945 * On Some Windows hosts TEST_UNIT_READY command can return
946 * SRB_STATUS_ERROR, let the upper level code deal with it
947 * based on the sense information.
949 case TEST_UNIT_READY
:
952 set_host_byte(scmnd
, DID_TARGET_FAILURE
);
955 case SRB_STATUS_INVALID_LUN
:
957 process_err_fn
= storvsc_remove_lun
;
959 case SRB_STATUS_ABORTED
:
960 if (vm_srb
->srb_status
& SRB_STATUS_AUTOSENSE_VALID
&&
961 (asc
== 0x2a) && (ascq
== 0x9)) {
963 process_err_fn
= storvsc_device_scan
;
965 * Retry the I/O that trigerred this.
967 set_host_byte(scmnd
, DID_REQUEUE
);
976 * We need to schedule work to process this error; schedule it.
978 wrk
= kmalloc(sizeof(struct storvsc_scan_work
), GFP_ATOMIC
);
980 set_host_byte(scmnd
, DID_TARGET_FAILURE
);
985 wrk
->lun
= vm_srb
->lun
;
986 wrk
->tgt_id
= vm_srb
->target_id
;
987 INIT_WORK(&wrk
->work
, process_err_fn
);
988 schedule_work(&wrk
->work
);
992 static void storvsc_command_completion(struct storvsc_cmd_request
*cmd_request
,
993 struct storvsc_device
*stor_dev
)
995 struct scsi_cmnd
*scmnd
= cmd_request
->cmd
;
996 struct scsi_sense_hdr sense_hdr
;
997 struct vmscsi_request
*vm_srb
;
998 u32 data_transfer_length
;
999 struct Scsi_Host
*host
;
1000 u32 payload_sz
= cmd_request
->payload_sz
;
1001 void *payload
= cmd_request
->payload
;
1003 host
= stor_dev
->host
;
1005 vm_srb
= &cmd_request
->vstor_packet
.vm_srb
;
1006 data_transfer_length
= vm_srb
->data_transfer_length
;
1008 scmnd
->result
= vm_srb
->scsi_status
;
1010 if (scmnd
->result
) {
1011 if (scsi_normalize_sense(scmnd
->sense_buffer
,
1012 SCSI_SENSE_BUFFERSIZE
, &sense_hdr
) &&
1013 !(sense_hdr
.sense_key
== NOT_READY
&&
1014 sense_hdr
.asc
== 0x03A) &&
1015 do_logging(STORVSC_LOGGING_ERROR
))
1016 scsi_print_sense_hdr(scmnd
->device
, "storvsc",
1020 if (vm_srb
->srb_status
!= SRB_STATUS_SUCCESS
) {
1021 storvsc_handle_error(vm_srb
, scmnd
, host
, sense_hdr
.asc
,
1024 * The Windows driver set data_transfer_length on
1025 * SRB_STATUS_DATA_OVERRUN. On other errors, this value
1026 * is untouched. In these cases we set it to 0.
1028 if (vm_srb
->srb_status
!= SRB_STATUS_DATA_OVERRUN
)
1029 data_transfer_length
= 0;
1032 scsi_set_resid(scmnd
,
1033 cmd_request
->payload
->range
.len
- data_transfer_length
);
1035 scmnd
->scsi_done(scmnd
);
1038 sizeof(struct vmbus_channel_packet_multipage_buffer
))
1042 static void storvsc_on_io_completion(struct storvsc_device
*stor_device
,
1043 struct vstor_packet
*vstor_packet
,
1044 struct storvsc_cmd_request
*request
)
1046 struct vstor_packet
*stor_pkt
;
1047 struct hv_device
*device
= stor_device
->device
;
1049 stor_pkt
= &request
->vstor_packet
;
1052 * The current SCSI handling on the host side does
1053 * not correctly handle:
1054 * INQUIRY command with page code parameter set to 0x80
1055 * MODE_SENSE command with cmd[2] == 0x1c
1057 * Setup srb and scsi status so this won't be fatal.
1058 * We do this so we can distinguish truly fatal failues
1059 * (srb status == 0x4) and off-line the device in that case.
1062 if ((stor_pkt
->vm_srb
.cdb
[0] == INQUIRY
) ||
1063 (stor_pkt
->vm_srb
.cdb
[0] == MODE_SENSE
)) {
1064 vstor_packet
->vm_srb
.scsi_status
= 0;
1065 vstor_packet
->vm_srb
.srb_status
= SRB_STATUS_SUCCESS
;
1069 /* Copy over the status...etc */
1070 stor_pkt
->vm_srb
.scsi_status
= vstor_packet
->vm_srb
.scsi_status
;
1071 stor_pkt
->vm_srb
.srb_status
= vstor_packet
->vm_srb
.srb_status
;
1072 stor_pkt
->vm_srb
.sense_info_length
=
1073 vstor_packet
->vm_srb
.sense_info_length
;
1075 if (vstor_packet
->vm_srb
.scsi_status
!= 0 ||
1076 vstor_packet
->vm_srb
.srb_status
!= SRB_STATUS_SUCCESS
)
1077 storvsc_log(device
, STORVSC_LOGGING_WARN
,
1078 "cmd 0x%x scsi status 0x%x srb status 0x%x\n",
1079 stor_pkt
->vm_srb
.cdb
[0],
1080 vstor_packet
->vm_srb
.scsi_status
,
1081 vstor_packet
->vm_srb
.srb_status
);
1083 if ((vstor_packet
->vm_srb
.scsi_status
& 0xFF) == 0x02) {
1084 /* CHECK_CONDITION */
1085 if (vstor_packet
->vm_srb
.srb_status
&
1086 SRB_STATUS_AUTOSENSE_VALID
) {
1087 /* autosense data available */
1089 storvsc_log(device
, STORVSC_LOGGING_WARN
,
1090 "stor pkt %p autosense data valid - len %d\n",
1091 request
, vstor_packet
->vm_srb
.sense_info_length
);
1093 memcpy(request
->cmd
->sense_buffer
,
1094 vstor_packet
->vm_srb
.sense_data
,
1095 vstor_packet
->vm_srb
.sense_info_length
);
1100 stor_pkt
->vm_srb
.data_transfer_length
=
1101 vstor_packet
->vm_srb
.data_transfer_length
;
1103 storvsc_command_completion(request
, stor_device
);
1105 if (atomic_dec_and_test(&stor_device
->num_outstanding_req
) &&
1106 stor_device
->drain_notify
)
1107 wake_up(&stor_device
->waiting_to_drain
);
1112 static void storvsc_on_receive(struct storvsc_device
*stor_device
,
1113 struct vstor_packet
*vstor_packet
,
1114 struct storvsc_cmd_request
*request
)
1116 struct storvsc_scan_work
*work
;
1118 switch (vstor_packet
->operation
) {
1119 case VSTOR_OPERATION_COMPLETE_IO
:
1120 storvsc_on_io_completion(stor_device
, vstor_packet
, request
);
1123 case VSTOR_OPERATION_REMOVE_DEVICE
:
1124 case VSTOR_OPERATION_ENUMERATE_BUS
:
1125 work
= kmalloc(sizeof(struct storvsc_scan_work
), GFP_ATOMIC
);
1129 INIT_WORK(&work
->work
, storvsc_host_scan
);
1130 work
->host
= stor_device
->host
;
1131 schedule_work(&work
->work
);
1134 case VSTOR_OPERATION_FCHBA_DATA
:
1135 cache_wwn(stor_device
, vstor_packet
);
1136 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1137 fc_host_node_name(stor_device
->host
) = stor_device
->node_name
;
1138 fc_host_port_name(stor_device
->host
) = stor_device
->port_name
;
1146 static void storvsc_on_channel_callback(void *context
)
1148 struct vmbus_channel
*channel
= (struct vmbus_channel
*)context
;
1149 struct hv_device
*device
;
1150 struct storvsc_device
*stor_device
;
1153 unsigned char packet
[ALIGN(sizeof(struct vstor_packet
), 8)];
1154 struct storvsc_cmd_request
*request
;
1157 if (channel
->primary_channel
!= NULL
)
1158 device
= channel
->primary_channel
->device_obj
;
1160 device
= channel
->device_obj
;
1162 stor_device
= get_in_stor_device(device
);
1167 ret
= vmbus_recvpacket(channel
, packet
,
1168 ALIGN((sizeof(struct vstor_packet
) -
1169 vmscsi_size_delta
), 8),
1170 &bytes_recvd
, &request_id
);
1171 if (ret
== 0 && bytes_recvd
> 0) {
1173 request
= (struct storvsc_cmd_request
*)
1174 (unsigned long)request_id
;
1176 if ((request
== &stor_device
->init_request
) ||
1177 (request
== &stor_device
->reset_request
)) {
1179 memcpy(&request
->vstor_packet
, packet
,
1180 (sizeof(struct vstor_packet
) -
1181 vmscsi_size_delta
));
1182 complete(&request
->wait_event
);
1184 storvsc_on_receive(stor_device
,
1185 (struct vstor_packet
*)packet
,
1196 static int storvsc_connect_to_vsp(struct hv_device
*device
, u32 ring_size
,
1199 struct vmstorage_channel_properties props
;
1202 memset(&props
, 0, sizeof(struct vmstorage_channel_properties
));
1204 ret
= vmbus_open(device
->channel
,
1208 sizeof(struct vmstorage_channel_properties
),
1209 storvsc_on_channel_callback
, device
->channel
);
1214 ret
= storvsc_channel_init(device
, is_fc
);
1219 static int storvsc_dev_remove(struct hv_device
*device
)
1221 struct storvsc_device
*stor_device
;
1222 unsigned long flags
;
1224 stor_device
= hv_get_drvdata(device
);
1226 spin_lock_irqsave(&device
->channel
->inbound_lock
, flags
);
1227 stor_device
->destroy
= true;
1228 spin_unlock_irqrestore(&device
->channel
->inbound_lock
, flags
);
1231 * At this point, all outbound traffic should be disable. We
1232 * only allow inbound traffic (responses) to proceed so that
1233 * outstanding requests can be completed.
1236 storvsc_wait_to_drain(stor_device
);
1239 * Since we have already drained, we don't need to busy wait
1240 * as was done in final_release_stor_device()
1241 * Note that we cannot set the ext pointer to NULL until
1242 * we have drained - to drain the outgoing packets, we need to
1243 * allow incoming packets.
1245 spin_lock_irqsave(&device
->channel
->inbound_lock
, flags
);
1246 hv_set_drvdata(device
, NULL
);
1247 spin_unlock_irqrestore(&device
->channel
->inbound_lock
, flags
);
1249 /* Close the channel */
1250 vmbus_close(device
->channel
);
1252 kfree(stor_device
->stor_chns
);
1257 static struct vmbus_channel
*get_og_chn(struct storvsc_device
*stor_device
,
1262 struct cpumask alloced_mask
;
1263 int num_channels
, tgt_cpu
;
1265 if (stor_device
->num_sc
== 0)
1266 return stor_device
->device
->channel
;
1269 * Our channel array is sparsley populated and we
1270 * initiated I/O on a processor/hw-q that does not
1271 * currently have a designated channel. Fix this.
1272 * The strategy is simple:
1273 * I. Ensure NUMA locality
1274 * II. Distribute evenly (best effort)
1275 * III. Mapping is persistent.
1278 cpumask_and(&alloced_mask
, &stor_device
->alloced_cpus
,
1279 cpumask_of_node(cpu_to_node(q_num
)));
1281 num_channels
= cpumask_weight(&alloced_mask
);
1282 if (num_channels
== 0)
1283 return stor_device
->device
->channel
;
1286 while (hash_qnum
>= num_channels
)
1287 hash_qnum
-= num_channels
;
1289 for_each_cpu(tgt_cpu
, &alloced_mask
) {
1290 if (slot
== hash_qnum
)
1295 stor_device
->stor_chns
[q_num
] = stor_device
->stor_chns
[tgt_cpu
];
1297 return stor_device
->stor_chns
[q_num
];
1301 static int storvsc_do_io(struct hv_device
*device
,
1302 struct storvsc_cmd_request
*request
, u16 q_num
)
1304 struct storvsc_device
*stor_device
;
1305 struct vstor_packet
*vstor_packet
;
1306 struct vmbus_channel
*outgoing_channel
;
1308 struct cpumask alloced_mask
;
1311 vstor_packet
= &request
->vstor_packet
;
1312 stor_device
= get_out_stor_device(device
);
1318 request
->device
= device
;
1320 * Select an an appropriate channel to send the request out.
1323 if (stor_device
->stor_chns
[q_num
] != NULL
) {
1324 outgoing_channel
= stor_device
->stor_chns
[q_num
];
1325 if (outgoing_channel
->target_cpu
== smp_processor_id()) {
1327 * Ideally, we want to pick a different channel if
1328 * available on the same NUMA node.
1330 cpumask_and(&alloced_mask
, &stor_device
->alloced_cpus
,
1331 cpumask_of_node(cpu_to_node(q_num
)));
1332 for_each_cpu(tgt_cpu
, &alloced_mask
) {
1333 if (tgt_cpu
!= outgoing_channel
->target_cpu
) {
1335 stor_device
->stor_chns
[tgt_cpu
];
1341 outgoing_channel
= get_og_chn(stor_device
, q_num
);
1345 vstor_packet
->flags
|= REQUEST_COMPLETION_FLAG
;
1347 vstor_packet
->vm_srb
.length
= (sizeof(struct vmscsi_request
) -
1351 vstor_packet
->vm_srb
.sense_info_length
= sense_buffer_size
;
1354 vstor_packet
->vm_srb
.data_transfer_length
=
1355 request
->payload
->range
.len
;
1357 vstor_packet
->operation
= VSTOR_OPERATION_EXECUTE_SRB
;
1359 if (request
->payload
->range
.len
) {
1361 ret
= vmbus_sendpacket_mpb_desc(outgoing_channel
,
1362 request
->payload
, request
->payload_sz
,
1364 (sizeof(struct vstor_packet
) -
1366 (unsigned long)request
);
1368 ret
= vmbus_sendpacket(outgoing_channel
, vstor_packet
,
1369 (sizeof(struct vstor_packet
) -
1371 (unsigned long)request
,
1373 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED
);
1379 atomic_inc(&stor_device
->num_outstanding_req
);
1384 static int storvsc_device_alloc(struct scsi_device
*sdevice
)
1387 * Set blist flag to permit the reading of the VPD pages even when
1388 * the target may claim SPC-2 compliance. MSFT targets currently
1389 * claim SPC-2 compliance while they implement post SPC-2 features.
1390 * With this flag we can correctly handle WRITE_SAME_16 issues.
1392 * Hypervisor reports SCSI_UNKNOWN type for DVD ROM device but
1393 * still supports REPORT LUN.
1395 sdevice
->sdev_bflags
= BLIST_REPORTLUN2
| BLIST_TRY_VPD_PAGES
;
1400 static int storvsc_device_configure(struct scsi_device
*sdevice
)
1403 blk_queue_bounce_limit(sdevice
->request_queue
, BLK_BOUNCE_ANY
);
1405 blk_queue_rq_timeout(sdevice
->request_queue
, (storvsc_timeout
* HZ
));
1407 /* Ensure there are no gaps in presented sgls */
1408 blk_queue_virt_boundary(sdevice
->request_queue
, PAGE_SIZE
- 1);
1410 sdevice
->no_write_same
= 1;
1413 * If the host is WIN8 or WIN8 R2, claim conformance to SPC-3
1414 * if the device is a MSFT virtual device. If the host is
1415 * WIN10 or newer, allow write_same.
1417 if (!strncmp(sdevice
->vendor
, "Msft", 4)) {
1418 switch (vmstor_proto_version
) {
1419 case VMSTOR_PROTO_VERSION_WIN8
:
1420 case VMSTOR_PROTO_VERSION_WIN8_1
:
1421 sdevice
->scsi_level
= SCSI_SPC_3
;
1425 if (vmstor_proto_version
>= VMSTOR_PROTO_VERSION_WIN10
)
1426 sdevice
->no_write_same
= 0;
1432 static int storvsc_get_chs(struct scsi_device
*sdev
, struct block_device
* bdev
,
1433 sector_t capacity
, int *info
)
1435 sector_t nsect
= capacity
;
1436 sector_t cylinders
= nsect
;
1437 int heads
, sectors_pt
;
1440 * We are making up these values; let us keep it simple.
1443 sectors_pt
= 0x3f; /* Sectors per track */
1444 sector_div(cylinders
, heads
* sectors_pt
);
1445 if ((sector_t
)(cylinders
+ 1) * heads
* sectors_pt
< nsect
)
1449 info
[1] = sectors_pt
;
1450 info
[2] = (int)cylinders
;
1455 static int storvsc_host_reset_handler(struct scsi_cmnd
*scmnd
)
1457 struct hv_host_device
*host_dev
= shost_priv(scmnd
->device
->host
);
1458 struct hv_device
*device
= host_dev
->dev
;
1460 struct storvsc_device
*stor_device
;
1461 struct storvsc_cmd_request
*request
;
1462 struct vstor_packet
*vstor_packet
;
1466 stor_device
= get_out_stor_device(device
);
1470 request
= &stor_device
->reset_request
;
1471 vstor_packet
= &request
->vstor_packet
;
1473 init_completion(&request
->wait_event
);
1475 vstor_packet
->operation
= VSTOR_OPERATION_RESET_BUS
;
1476 vstor_packet
->flags
= REQUEST_COMPLETION_FLAG
;
1477 vstor_packet
->vm_srb
.path_id
= stor_device
->path_id
;
1479 ret
= vmbus_sendpacket(device
->channel
, vstor_packet
,
1480 (sizeof(struct vstor_packet
) -
1482 (unsigned long)&stor_device
->reset_request
,
1484 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED
);
1488 t
= wait_for_completion_timeout(&request
->wait_event
, 5*HZ
);
1490 return TIMEOUT_ERROR
;
1494 * At this point, all outstanding requests in the adapter
1495 * should have been flushed out and return to us
1496 * There is a potential race here where the host may be in
1497 * the process of responding when we return from here.
1498 * Just wait for all in-transit packets to be accounted for
1499 * before we return from here.
1501 storvsc_wait_to_drain(stor_device
);
1507 * The host guarantees to respond to each command, although I/O latencies might
1508 * be unbounded on Azure. Reset the timer unconditionally to give the host a
1509 * chance to perform EH.
1511 static enum blk_eh_timer_return
storvsc_eh_timed_out(struct scsi_cmnd
*scmnd
)
1513 return BLK_EH_RESET_TIMER
;
1516 static bool storvsc_scsi_cmd_ok(struct scsi_cmnd
*scmnd
)
1518 bool allowed
= true;
1519 u8 scsi_op
= scmnd
->cmnd
[0];
1522 /* the host does not handle WRITE_SAME, log accident usage */
1525 * smartd sends this command and the host does not handle
1526 * this. So, don't send it.
1529 scmnd
->result
= ILLEGAL_REQUEST
<< 16;
1538 static int storvsc_queuecommand(struct Scsi_Host
*host
, struct scsi_cmnd
*scmnd
)
1541 struct hv_host_device
*host_dev
= shost_priv(host
);
1542 struct hv_device
*dev
= host_dev
->dev
;
1543 struct storvsc_cmd_request
*cmd_request
= scsi_cmd_priv(scmnd
);
1545 struct scatterlist
*sgl
;
1546 unsigned int sg_count
= 0;
1547 struct vmscsi_request
*vm_srb
;
1548 struct scatterlist
*cur_sgl
;
1549 struct vmbus_packet_mpb_array
*payload
;
1553 if (vmstor_proto_version
<= VMSTOR_PROTO_VERSION_WIN8
) {
1555 * On legacy hosts filter unimplemented commands.
1556 * Future hosts are expected to correctly handle
1557 * unsupported commands. Furthermore, it is
1558 * possible that some of the currently
1559 * unsupported commands maybe supported in
1560 * future versions of the host.
1562 if (!storvsc_scsi_cmd_ok(scmnd
)) {
1563 scmnd
->scsi_done(scmnd
);
1568 /* Setup the cmd request */
1569 cmd_request
->cmd
= scmnd
;
1571 vm_srb
= &cmd_request
->vstor_packet
.vm_srb
;
1572 vm_srb
->win8_extension
.time_out_value
= 60;
1574 vm_srb
->win8_extension
.srb_flags
|=
1575 SRB_FLAGS_DISABLE_SYNCH_TRANSFER
;
1577 if (scmnd
->device
->tagged_supported
) {
1578 vm_srb
->win8_extension
.srb_flags
|=
1579 (SRB_FLAGS_QUEUE_ACTION_ENABLE
| SRB_FLAGS_NO_QUEUE_FREEZE
);
1580 vm_srb
->win8_extension
.queue_tag
= SP_UNTAGGED
;
1581 vm_srb
->win8_extension
.queue_action
= SRB_SIMPLE_TAG_REQUEST
;
1585 switch (scmnd
->sc_data_direction
) {
1587 vm_srb
->data_in
= WRITE_TYPE
;
1588 vm_srb
->win8_extension
.srb_flags
|= SRB_FLAGS_DATA_OUT
;
1590 case DMA_FROM_DEVICE
:
1591 vm_srb
->data_in
= READ_TYPE
;
1592 vm_srb
->win8_extension
.srb_flags
|= SRB_FLAGS_DATA_IN
;
1595 vm_srb
->data_in
= UNKNOWN_TYPE
;
1596 vm_srb
->win8_extension
.srb_flags
|= SRB_FLAGS_NO_DATA_TRANSFER
;
1600 * This is DMA_BIDIRECTIONAL or something else we are never
1601 * supposed to see here.
1603 WARN(1, "Unexpected data direction: %d\n",
1604 scmnd
->sc_data_direction
);
1609 vm_srb
->port_number
= host_dev
->port
;
1610 vm_srb
->path_id
= scmnd
->device
->channel
;
1611 vm_srb
->target_id
= scmnd
->device
->id
;
1612 vm_srb
->lun
= scmnd
->device
->lun
;
1614 vm_srb
->cdb_length
= scmnd
->cmd_len
;
1616 memcpy(vm_srb
->cdb
, scmnd
->cmnd
, vm_srb
->cdb_length
);
1618 sgl
= (struct scatterlist
*)scsi_sglist(scmnd
);
1619 sg_count
= scsi_sg_count(scmnd
);
1621 length
= scsi_bufflen(scmnd
);
1622 payload
= (struct vmbus_packet_mpb_array
*)&cmd_request
->mpb
;
1623 payload_sz
= sizeof(cmd_request
->mpb
);
1626 if (sg_count
> MAX_PAGE_BUFFER_COUNT
) {
1628 payload_sz
= (sg_count
* sizeof(u64
) +
1629 sizeof(struct vmbus_packet_mpb_array
));
1630 payload
= kzalloc(payload_sz
, GFP_ATOMIC
);
1632 return SCSI_MLQUEUE_DEVICE_BUSY
;
1635 payload
->range
.len
= length
;
1636 payload
->range
.offset
= sgl
[0].offset
;
1639 for (i
= 0; i
< sg_count
; i
++) {
1640 payload
->range
.pfn_array
[i
] =
1641 page_to_pfn(sg_page((cur_sgl
)));
1642 cur_sgl
= sg_next(cur_sgl
);
1646 cmd_request
->payload
= payload
;
1647 cmd_request
->payload_sz
= payload_sz
;
1649 /* Invokes the vsc to start an IO */
1650 ret
= storvsc_do_io(dev
, cmd_request
, get_cpu());
1653 if (ret
== -EAGAIN
) {
1655 return SCSI_MLQUEUE_DEVICE_BUSY
;
1661 static struct scsi_host_template scsi_driver
= {
1662 .module
= THIS_MODULE
,
1663 .name
= "storvsc_host_t",
1664 .cmd_size
= sizeof(struct storvsc_cmd_request
),
1665 .bios_param
= storvsc_get_chs
,
1666 .queuecommand
= storvsc_queuecommand
,
1667 .eh_host_reset_handler
= storvsc_host_reset_handler
,
1668 .proc_name
= "storvsc_host",
1669 .eh_timed_out
= storvsc_eh_timed_out
,
1670 .slave_alloc
= storvsc_device_alloc
,
1671 .slave_configure
= storvsc_device_configure
,
1674 .use_clustering
= ENABLE_CLUSTERING
,
1675 /* Make sure we dont get a sg segment crosses a page boundary */
1676 .dma_boundary
= PAGE_SIZE
-1,
1678 .track_queue_depth
= 1,
1687 static const struct hv_vmbus_device_id id_table
[] = {
1690 .driver_data
= SCSI_GUID
1694 .driver_data
= IDE_GUID
1696 /* Fibre Channel GUID */
1699 .driver_data
= SFC_GUID
1704 MODULE_DEVICE_TABLE(vmbus
, id_table
);
1706 static int storvsc_probe(struct hv_device
*device
,
1707 const struct hv_vmbus_device_id
*dev_id
)
1710 int num_cpus
= num_online_cpus();
1711 struct Scsi_Host
*host
;
1712 struct hv_host_device
*host_dev
;
1713 bool dev_is_ide
= ((dev_id
->driver_data
== IDE_GUID
) ? true : false);
1714 bool is_fc
= ((dev_id
->driver_data
== SFC_GUID
) ? true : false);
1716 struct storvsc_device
*stor_device
;
1717 int max_luns_per_target
;
1720 int max_sub_channels
= 0;
1723 * Based on the windows host we are running on,
1724 * set state to properly communicate with the host.
1727 if (vmbus_proto_version
< VERSION_WIN8
) {
1728 max_luns_per_target
= STORVSC_IDE_MAX_LUNS_PER_TARGET
;
1729 max_targets
= STORVSC_IDE_MAX_TARGETS
;
1730 max_channels
= STORVSC_IDE_MAX_CHANNELS
;
1732 max_luns_per_target
= STORVSC_MAX_LUNS_PER_TARGET
;
1733 max_targets
= STORVSC_MAX_TARGETS
;
1734 max_channels
= STORVSC_MAX_CHANNELS
;
1736 * On Windows8 and above, we support sub-channels for storage.
1737 * The number of sub-channels offerred is based on the number of
1738 * VCPUs in the guest.
1740 max_sub_channels
= (num_cpus
/ storvsc_vcpus_per_sub_channel
);
1743 scsi_driver
.can_queue
= (max_outstanding_req_per_channel
*
1744 (max_sub_channels
+ 1));
1746 host
= scsi_host_alloc(&scsi_driver
,
1747 sizeof(struct hv_host_device
));
1751 host_dev
= shost_priv(host
);
1752 memset(host_dev
, 0, sizeof(struct hv_host_device
));
1754 host_dev
->port
= host
->host_no
;
1755 host_dev
->dev
= device
;
1758 stor_device
= kzalloc(sizeof(struct storvsc_device
), GFP_KERNEL
);
1764 stor_device
->destroy
= false;
1765 stor_device
->open_sub_channel
= false;
1766 init_waitqueue_head(&stor_device
->waiting_to_drain
);
1767 stor_device
->device
= device
;
1768 stor_device
->host
= host
;
1769 hv_set_drvdata(device
, stor_device
);
1771 stor_device
->port_number
= host
->host_no
;
1772 ret
= storvsc_connect_to_vsp(device
, storvsc_ringbuffer_size
, is_fc
);
1776 host_dev
->path
= stor_device
->path_id
;
1777 host_dev
->target
= stor_device
->target_id
;
1779 switch (dev_id
->driver_data
) {
1781 host
->max_lun
= STORVSC_FC_MAX_LUNS_PER_TARGET
;
1782 host
->max_id
= STORVSC_FC_MAX_TARGETS
;
1783 host
->max_channel
= STORVSC_FC_MAX_CHANNELS
- 1;
1784 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1785 host
->transportt
= fc_transport_template
;
1790 host
->max_lun
= max_luns_per_target
;
1791 host
->max_id
= max_targets
;
1792 host
->max_channel
= max_channels
- 1;
1796 host
->max_lun
= STORVSC_IDE_MAX_LUNS_PER_TARGET
;
1797 host
->max_id
= STORVSC_IDE_MAX_TARGETS
;
1798 host
->max_channel
= STORVSC_IDE_MAX_CHANNELS
- 1;
1801 /* max cmd length */
1802 host
->max_cmd_len
= STORVSC_MAX_CMD_LEN
;
1805 * set the table size based on the info we got
1808 host
->sg_tablesize
= (stor_device
->max_transfer_bytes
>> PAGE_SHIFT
);
1810 * Set the number of HW queues we are supporting.
1812 if (stor_device
->num_sc
!= 0)
1813 host
->nr_hw_queues
= stor_device
->num_sc
+ 1;
1815 /* Register the HBA and start the scsi bus scan */
1816 ret
= scsi_add_host(host
, &device
->device
);
1821 scsi_scan_host(host
);
1823 target
= (device
->dev_instance
.b
[5] << 8 |
1824 device
->dev_instance
.b
[4]);
1825 ret
= scsi_add_device(host
, 0, target
, 0);
1827 scsi_remove_host(host
);
1831 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1832 if (host
->transportt
== fc_transport_template
) {
1833 fc_host_node_name(host
) = stor_device
->node_name
;
1834 fc_host_port_name(host
) = stor_device
->port_name
;
1841 * Once we have connected with the host, we would need to
1842 * to invoke storvsc_dev_remove() to rollback this state and
1843 * this call also frees up the stor_device; hence the jump around
1846 storvsc_dev_remove(device
);
1850 kfree(stor_device
->stor_chns
);
1854 scsi_host_put(host
);
1858 static int storvsc_remove(struct hv_device
*dev
)
1860 struct storvsc_device
*stor_device
= hv_get_drvdata(dev
);
1861 struct Scsi_Host
*host
= stor_device
->host
;
1863 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1864 if (host
->transportt
== fc_transport_template
)
1865 fc_remove_host(host
);
1867 scsi_remove_host(host
);
1868 storvsc_dev_remove(dev
);
1869 scsi_host_put(host
);
1874 static struct hv_driver storvsc_drv
= {
1875 .name
= KBUILD_MODNAME
,
1876 .id_table
= id_table
,
1877 .probe
= storvsc_probe
,
1878 .remove
= storvsc_remove
,
1881 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1882 static struct fc_function_template fc_transport_functions
= {
1883 .show_host_node_name
= 1,
1884 .show_host_port_name
= 1,
1888 static int __init
storvsc_drv_init(void)
1893 * Divide the ring buffer data size (which is 1 page less
1894 * than the ring buffer size since that page is reserved for
1895 * the ring buffer indices) by the max request size (which is
1896 * vmbus_channel_packet_multipage_buffer + struct vstor_packet + u64)
1898 max_outstanding_req_per_channel
=
1899 ((storvsc_ringbuffer_size
- PAGE_SIZE
) /
1900 ALIGN(MAX_MULTIPAGE_BUFFER_PACKET
+
1901 sizeof(struct vstor_packet
) + sizeof(u64
) -
1905 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1906 fc_transport_template
= fc_attach_transport(&fc_transport_functions
);
1907 if (!fc_transport_template
)
1911 ret
= vmbus_driver_register(&storvsc_drv
);
1913 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1915 fc_release_transport(fc_transport_template
);
1921 static void __exit
storvsc_drv_exit(void)
1923 vmbus_driver_unregister(&storvsc_drv
);
1924 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1925 fc_release_transport(fc_transport_template
);
1929 MODULE_LICENSE("GPL");
1930 MODULE_DESCRIPTION("Microsoft Hyper-V virtual storage driver");
1931 module_init(storvsc_drv_init
);
1932 module_exit(storvsc_drv_exit
);