inet: frag: enforce memory limits earlier
[linux/fpc-iii.git] / drivers / scsi / storvsc_drv.c
blobd92b2808d191ee974a1d343e18177a337a5e9eb4
1 /*
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
11 * more details.
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.
17 * Authors:
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>
28 #include <linux/mm.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.
55 * Version history:
56 * V1 Beta: 0.1
57 * V1 RC < 2008/1/31: 1.0
58 * V1 RC > 2008/1/31: 2.0
59 * Win7: 4.2
60 * Win8: 5.1
61 * Win8.1: 6.0
62 * Win10: 6.2
65 #define VMSTOR_PROTO_VERSION(MAJOR_, MINOR_) ((((MAJOR_) & 0xff) << 8) | \
66 (((MINOR_) & 0xff)))
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 {
97 u8 primary_active;
98 u8 reserved1[3];
99 u8 primary_port_wwn[8];
100 u8 primary_node_wwn[8];
101 u8 secondary_port_wwn[8];
102 u8 secondary_node_wwn[8];
108 * SRB Flag Bits
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, ...) \
185 do { \
186 if (do_logging(level)) \
187 dev_warn(&(dev)->device, fmt, ##__VA_ARGS__); \
188 } while (0)
190 struct vmscsi_win8_extension {
192 * The following were added in Windows 8
194 u16 reserve;
195 u8 queue_tag;
196 u8 queue_action;
197 u32 srb_flags;
198 u32 time_out_value;
199 u32 queue_sort_ey;
200 } __packed;
202 struct vmscsi_request {
203 u16 length;
204 u8 srb_status;
205 u8 scsi_status;
207 u8 port_number;
208 u8 path_id;
209 u8 target_id;
210 u8 lun;
212 u8 cdb_length;
213 u8 sense_info_length;
214 u8 data_in;
215 u8 reserved;
217 u32 data_transfer_length;
219 union {
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
236 * to a win8 host.
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 intialization phase to get the different
284 * properties of the channel.
287 #define STORAGE_CHANNEL_SUPPORTS_MULTI_CHANNEL 0x1
289 struct vmstorage_channel_properties {
290 u32 reserved;
291 u16 max_channel_cnt;
292 u16 reserved1;
294 u32 flags;
295 u32 max_transfer_bytes;
297 u64 reserved2;
298 } __packed;
300 /* This structure is sent during the storage protocol negotiations. */
301 struct vmstorage_protocol_version {
302 /* Major (MSW) and minor (LSW) version numbers. */
303 u16 major_minor;
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
309 * builds.
310 * This is only used on the windows side. Just set it to 0.
312 u16 revision;
313 } __packed;
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 */
324 u32 flags;
326 /* Status of the request returned from the server side. */
327 u32 status;
329 /* Data payload area */
330 union {
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 */
350 u8 buffer[0x34];
352 } __packed;
355 * Packet Flags:
357 * This flag indicates that the server should send back a completion for this
358 * packet.
361 #define REQUEST_COMPLETION_FLAG 0x1
363 /* Matches Windows-end */
364 enum storvsc_request_type {
365 WRITE_TYPE = 0,
366 READ_TYPE,
367 UNKNOWN_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;
405 #endif
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;
431 u32 payload_sz;
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;
441 bool destroy;
442 bool drain_notify;
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;
462 /* Used for vsc/vsp channel reset process */
463 struct storvsc_cmd_request init_request;
464 struct storvsc_cmd_request reset_request;
466 * Currently active port and node names for FC devices.
468 u64 node_name;
469 u64 port_name;
472 struct hv_host_device {
473 struct hv_device *dev;
474 unsigned int port;
475 unsigned char path;
476 unsigned char target;
479 struct storvsc_scan_work {
480 struct work_struct work;
481 struct Scsi_Host *host;
482 u8 lun;
483 u8 tgt_id;
486 static void storvsc_device_scan(struct work_struct *work)
488 struct storvsc_scan_work *wrk;
489 struct scsi_device *sdev;
491 wrk = container_of(work, struct storvsc_scan_work, work);
493 sdev = scsi_device_lookup(wrk->host, 0, wrk->tgt_id, wrk->lun);
494 if (!sdev)
495 goto done;
496 scsi_rescan_device(&sdev->sdev_gendev);
497 scsi_device_put(sdev);
499 done:
500 kfree(wrk);
503 static void storvsc_host_scan(struct work_struct *work)
505 struct storvsc_scan_work *wrk;
506 struct Scsi_Host *host;
507 struct scsi_device *sdev;
509 wrk = container_of(work, struct storvsc_scan_work, work);
510 host = wrk->host;
513 * Before scanning the host, first check to see if any of the
514 * currrently known devices have been hot removed. We issue a
515 * "unit ready" command against all currently known devices.
516 * This I/O will result in an error for devices that have been
517 * removed. As part of handling the I/O error, we remove the device.
519 * When a LUN is added or removed, the host sends us a signal to
520 * scan the host. Thus we are forced to discover the LUNs that
521 * may have been removed this way.
523 mutex_lock(&host->scan_mutex);
524 shost_for_each_device(sdev, host)
525 scsi_test_unit_ready(sdev, 1, 1, NULL);
526 mutex_unlock(&host->scan_mutex);
528 * Now scan the host to discover LUNs that may have been added.
530 scsi_scan_host(host);
532 kfree(wrk);
535 static void storvsc_remove_lun(struct work_struct *work)
537 struct storvsc_scan_work *wrk;
538 struct scsi_device *sdev;
540 wrk = container_of(work, struct storvsc_scan_work, work);
541 if (!scsi_host_get(wrk->host))
542 goto done;
544 sdev = scsi_device_lookup(wrk->host, 0, wrk->tgt_id, wrk->lun);
546 if (sdev) {
547 scsi_remove_device(sdev);
548 scsi_device_put(sdev);
550 scsi_host_put(wrk->host);
552 done:
553 kfree(wrk);
558 * We can get incoming messages from the host that are not in response to
559 * messages that we have sent out. An example of this would be messages
560 * received by the guest to notify dynamic addition/removal of LUNs. To
561 * deal with potential race conditions where the driver may be in the
562 * midst of being unloaded when we might receive an unsolicited message
563 * from the host, we have implemented a mechanism to gurantee sequential
564 * consistency:
566 * 1) Once the device is marked as being destroyed, we will fail all
567 * outgoing messages.
568 * 2) We permit incoming messages when the device is being destroyed,
569 * only to properly account for messages already sent out.
572 static inline struct storvsc_device *get_out_stor_device(
573 struct hv_device *device)
575 struct storvsc_device *stor_device;
577 stor_device = hv_get_drvdata(device);
579 if (stor_device && stor_device->destroy)
580 stor_device = NULL;
582 return stor_device;
586 static inline void storvsc_wait_to_drain(struct storvsc_device *dev)
588 dev->drain_notify = true;
589 wait_event(dev->waiting_to_drain,
590 atomic_read(&dev->num_outstanding_req) == 0);
591 dev->drain_notify = false;
594 static inline struct storvsc_device *get_in_stor_device(
595 struct hv_device *device)
597 struct storvsc_device *stor_device;
599 stor_device = hv_get_drvdata(device);
601 if (!stor_device)
602 goto get_in_err;
605 * If the device is being destroyed; allow incoming
606 * traffic only to cleanup outstanding requests.
609 if (stor_device->destroy &&
610 (atomic_read(&stor_device->num_outstanding_req) == 0))
611 stor_device = NULL;
613 get_in_err:
614 return stor_device;
618 static void handle_sc_creation(struct vmbus_channel *new_sc)
620 struct hv_device *device = new_sc->primary_channel->device_obj;
621 struct storvsc_device *stor_device;
622 struct vmstorage_channel_properties props;
624 stor_device = get_out_stor_device(device);
625 if (!stor_device)
626 return;
628 if (stor_device->open_sub_channel == false)
629 return;
631 memset(&props, 0, sizeof(struct vmstorage_channel_properties));
633 vmbus_open(new_sc,
634 storvsc_ringbuffer_size,
635 storvsc_ringbuffer_size,
636 (void *)&props,
637 sizeof(struct vmstorage_channel_properties),
638 storvsc_on_channel_callback, new_sc);
641 static void handle_multichannel_storage(struct hv_device *device, int max_chns)
643 struct storvsc_device *stor_device;
644 int num_cpus = num_online_cpus();
645 int num_sc;
646 struct storvsc_cmd_request *request;
647 struct vstor_packet *vstor_packet;
648 int ret, t;
650 num_sc = ((max_chns > num_cpus) ? num_cpus : max_chns);
651 stor_device = get_out_stor_device(device);
652 if (!stor_device)
653 return;
655 request = &stor_device->init_request;
656 vstor_packet = &request->vstor_packet;
658 stor_device->open_sub_channel = true;
660 * Establish a handler for dealing with subchannels.
662 vmbus_set_sc_create_callback(device->channel, handle_sc_creation);
665 * Check to see if sub-channels have already been created. This
666 * can happen when this driver is re-loaded after unloading.
669 if (vmbus_are_subchannels_present(device->channel))
670 return;
672 stor_device->open_sub_channel = false;
674 * Request the host to create sub-channels.
676 memset(request, 0, sizeof(struct storvsc_cmd_request));
677 init_completion(&request->wait_event);
678 vstor_packet->operation = VSTOR_OPERATION_CREATE_SUB_CHANNELS;
679 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
680 vstor_packet->sub_channel_count = num_sc;
682 ret = vmbus_sendpacket(device->channel, vstor_packet,
683 (sizeof(struct vstor_packet) -
684 vmscsi_size_delta),
685 (unsigned long)request,
686 VM_PKT_DATA_INBAND,
687 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
689 if (ret != 0)
690 return;
692 t = wait_for_completion_timeout(&request->wait_event, 10*HZ);
693 if (t == 0)
694 return;
696 if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
697 vstor_packet->status != 0)
698 return;
701 * Now that we created the sub-channels, invoke the check; this
702 * may trigger the callback.
704 stor_device->open_sub_channel = true;
705 vmbus_are_subchannels_present(device->channel);
708 static void cache_wwn(struct storvsc_device *stor_device,
709 struct vstor_packet *vstor_packet)
712 * Cache the currently active port and node ww names.
714 if (vstor_packet->wwn_packet.primary_active) {
715 stor_device->node_name =
716 wwn_to_u64(vstor_packet->wwn_packet.primary_node_wwn);
717 stor_device->port_name =
718 wwn_to_u64(vstor_packet->wwn_packet.primary_port_wwn);
719 } else {
720 stor_device->node_name =
721 wwn_to_u64(vstor_packet->wwn_packet.secondary_node_wwn);
722 stor_device->port_name =
723 wwn_to_u64(vstor_packet->wwn_packet.secondary_port_wwn);
728 static int storvsc_execute_vstor_op(struct hv_device *device,
729 struct storvsc_cmd_request *request,
730 bool status_check)
732 struct vstor_packet *vstor_packet;
733 int ret, t;
735 vstor_packet = &request->vstor_packet;
737 init_completion(&request->wait_event);
738 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
740 ret = vmbus_sendpacket(device->channel, vstor_packet,
741 (sizeof(struct vstor_packet) -
742 vmscsi_size_delta),
743 (unsigned long)request,
744 VM_PKT_DATA_INBAND,
745 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
746 if (ret != 0)
747 return ret;
749 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
750 if (t == 0)
751 return -ETIMEDOUT;
753 if (!status_check)
754 return ret;
756 if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
757 vstor_packet->status != 0)
758 return -EINVAL;
760 return ret;
763 static int storvsc_channel_init(struct hv_device *device, bool is_fc)
765 struct storvsc_device *stor_device;
766 struct storvsc_cmd_request *request;
767 struct vstor_packet *vstor_packet;
768 int ret, i;
769 int max_chns;
770 bool process_sub_channels = false;
772 stor_device = get_out_stor_device(device);
773 if (!stor_device)
774 return -ENODEV;
776 request = &stor_device->init_request;
777 vstor_packet = &request->vstor_packet;
780 * Now, initiate the vsc/vsp initialization protocol on the open
781 * channel
783 memset(request, 0, sizeof(struct storvsc_cmd_request));
784 vstor_packet->operation = VSTOR_OPERATION_BEGIN_INITIALIZATION;
785 ret = storvsc_execute_vstor_op(device, request, true);
786 if (ret)
787 return ret;
789 * Query host supported protocol version.
792 for (i = 0; i < ARRAY_SIZE(vmstor_protocols); i++) {
793 /* reuse the packet for version range supported */
794 memset(vstor_packet, 0, sizeof(struct vstor_packet));
795 vstor_packet->operation =
796 VSTOR_OPERATION_QUERY_PROTOCOL_VERSION;
798 vstor_packet->version.major_minor =
799 vmstor_protocols[i].protocol_version;
802 * The revision number is only used in Windows; set it to 0.
804 vstor_packet->version.revision = 0;
805 ret = storvsc_execute_vstor_op(device, request, false);
806 if (ret != 0)
807 return ret;
809 if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO)
810 return -EINVAL;
812 if (vstor_packet->status == 0) {
813 vmstor_proto_version =
814 vmstor_protocols[i].protocol_version;
816 sense_buffer_size =
817 vmstor_protocols[i].sense_buffer_size;
819 vmscsi_size_delta =
820 vmstor_protocols[i].vmscsi_size_delta;
822 break;
826 if (vstor_packet->status != 0)
827 return -EINVAL;
830 memset(vstor_packet, 0, sizeof(struct vstor_packet));
831 vstor_packet->operation = VSTOR_OPERATION_QUERY_PROPERTIES;
832 ret = storvsc_execute_vstor_op(device, request, true);
833 if (ret != 0)
834 return ret;
837 * Check to see if multi-channel support is there.
838 * Hosts that implement protocol version of 5.1 and above
839 * support multi-channel.
841 max_chns = vstor_packet->storage_channel_properties.max_channel_cnt;
842 if (vmstor_proto_version >= VMSTOR_PROTO_VERSION_WIN8) {
843 if (vstor_packet->storage_channel_properties.flags &
844 STORAGE_CHANNEL_SUPPORTS_MULTI_CHANNEL)
845 process_sub_channels = true;
847 stor_device->max_transfer_bytes =
848 vstor_packet->storage_channel_properties.max_transfer_bytes;
850 if (!is_fc)
851 goto done;
854 * For FC devices retrieve FC HBA data.
856 memset(vstor_packet, 0, sizeof(struct vstor_packet));
857 vstor_packet->operation = VSTOR_OPERATION_FCHBA_DATA;
858 ret = storvsc_execute_vstor_op(device, request, true);
859 if (ret != 0)
860 return ret;
863 * Cache the currently active port and node ww names.
865 cache_wwn(stor_device, vstor_packet);
867 done:
869 memset(vstor_packet, 0, sizeof(struct vstor_packet));
870 vstor_packet->operation = VSTOR_OPERATION_END_INITIALIZATION;
871 ret = storvsc_execute_vstor_op(device, request, true);
872 if (ret != 0)
873 return ret;
875 if (process_sub_channels)
876 handle_multichannel_storage(device, max_chns);
878 return ret;
881 static void storvsc_handle_error(struct vmscsi_request *vm_srb,
882 struct scsi_cmnd *scmnd,
883 struct Scsi_Host *host,
884 u8 asc, u8 ascq)
886 struct storvsc_scan_work *wrk;
887 void (*process_err_fn)(struct work_struct *work);
888 bool do_work = false;
890 switch (SRB_STATUS(vm_srb->srb_status)) {
891 case SRB_STATUS_ERROR:
893 * Let upper layer deal with error when
894 * sense message is present.
897 if (vm_srb->srb_status & SRB_STATUS_AUTOSENSE_VALID)
898 break;
900 * If there is an error; offline the device since all
901 * error recovery strategies would have already been
902 * deployed on the host side. However, if the command
903 * were a pass-through command deal with it appropriately.
905 switch (scmnd->cmnd[0]) {
906 case ATA_16:
907 case ATA_12:
908 set_host_byte(scmnd, DID_PASSTHROUGH);
909 break;
911 * On Some Windows hosts TEST_UNIT_READY command can return
912 * SRB_STATUS_ERROR, let the upper level code deal with it
913 * based on the sense information.
915 case TEST_UNIT_READY:
916 break;
917 default:
918 set_host_byte(scmnd, DID_ERROR);
920 break;
921 case SRB_STATUS_INVALID_LUN:
922 set_host_byte(scmnd, DID_NO_CONNECT);
923 do_work = true;
924 process_err_fn = storvsc_remove_lun;
925 break;
926 case SRB_STATUS_ABORTED:
927 if (vm_srb->srb_status & SRB_STATUS_AUTOSENSE_VALID &&
928 (asc == 0x2a) && (ascq == 0x9)) {
929 do_work = true;
930 process_err_fn = storvsc_device_scan;
932 * Retry the I/O that trigerred this.
934 set_host_byte(scmnd, DID_REQUEUE);
936 break;
939 if (!do_work)
940 return;
943 * We need to schedule work to process this error; schedule it.
945 wrk = kmalloc(sizeof(struct storvsc_scan_work), GFP_ATOMIC);
946 if (!wrk) {
947 set_host_byte(scmnd, DID_TARGET_FAILURE);
948 return;
951 wrk->host = host;
952 wrk->lun = vm_srb->lun;
953 wrk->tgt_id = vm_srb->target_id;
954 INIT_WORK(&wrk->work, process_err_fn);
955 schedule_work(&wrk->work);
959 static void storvsc_command_completion(struct storvsc_cmd_request *cmd_request,
960 struct storvsc_device *stor_dev)
962 struct scsi_cmnd *scmnd = cmd_request->cmd;
963 struct scsi_sense_hdr sense_hdr;
964 struct vmscsi_request *vm_srb;
965 u32 data_transfer_length;
966 struct Scsi_Host *host;
967 u32 payload_sz = cmd_request->payload_sz;
968 void *payload = cmd_request->payload;
970 host = stor_dev->host;
972 vm_srb = &cmd_request->vstor_packet.vm_srb;
973 data_transfer_length = vm_srb->data_transfer_length;
975 scmnd->result = vm_srb->scsi_status;
977 if (scmnd->result) {
978 if (scsi_normalize_sense(scmnd->sense_buffer,
979 SCSI_SENSE_BUFFERSIZE, &sense_hdr) &&
980 !(sense_hdr.sense_key == NOT_READY &&
981 sense_hdr.asc == 0x03A) &&
982 do_logging(STORVSC_LOGGING_ERROR))
983 scsi_print_sense_hdr(scmnd->device, "storvsc",
984 &sense_hdr);
987 if (vm_srb->srb_status != SRB_STATUS_SUCCESS) {
988 storvsc_handle_error(vm_srb, scmnd, host, sense_hdr.asc,
989 sense_hdr.ascq);
991 * The Windows driver set data_transfer_length on
992 * SRB_STATUS_DATA_OVERRUN. On other errors, this value
993 * is untouched. In these cases we set it to 0.
995 if (vm_srb->srb_status != SRB_STATUS_DATA_OVERRUN)
996 data_transfer_length = 0;
999 scsi_set_resid(scmnd,
1000 cmd_request->payload->range.len - data_transfer_length);
1002 scmnd->scsi_done(scmnd);
1004 if (payload_sz >
1005 sizeof(struct vmbus_channel_packet_multipage_buffer))
1006 kfree(payload);
1009 static void storvsc_on_io_completion(struct storvsc_device *stor_device,
1010 struct vstor_packet *vstor_packet,
1011 struct storvsc_cmd_request *request)
1013 struct vstor_packet *stor_pkt;
1014 struct hv_device *device = stor_device->device;
1016 stor_pkt = &request->vstor_packet;
1019 * The current SCSI handling on the host side does
1020 * not correctly handle:
1021 * INQUIRY command with page code parameter set to 0x80
1022 * MODE_SENSE command with cmd[2] == 0x1c
1024 * Setup srb and scsi status so this won't be fatal.
1025 * We do this so we can distinguish truly fatal failues
1026 * (srb status == 0x4) and off-line the device in that case.
1029 if ((stor_pkt->vm_srb.cdb[0] == INQUIRY) ||
1030 (stor_pkt->vm_srb.cdb[0] == MODE_SENSE)) {
1031 vstor_packet->vm_srb.scsi_status = 0;
1032 vstor_packet->vm_srb.srb_status = SRB_STATUS_SUCCESS;
1036 /* Copy over the status...etc */
1037 stor_pkt->vm_srb.scsi_status = vstor_packet->vm_srb.scsi_status;
1038 stor_pkt->vm_srb.srb_status = vstor_packet->vm_srb.srb_status;
1039 stor_pkt->vm_srb.sense_info_length =
1040 vstor_packet->vm_srb.sense_info_length;
1042 if (vstor_packet->vm_srb.scsi_status != 0 ||
1043 vstor_packet->vm_srb.srb_status != SRB_STATUS_SUCCESS)
1044 storvsc_log(device, STORVSC_LOGGING_WARN,
1045 "cmd 0x%x scsi status 0x%x srb status 0x%x\n",
1046 stor_pkt->vm_srb.cdb[0],
1047 vstor_packet->vm_srb.scsi_status,
1048 vstor_packet->vm_srb.srb_status);
1050 if ((vstor_packet->vm_srb.scsi_status & 0xFF) == 0x02) {
1051 /* CHECK_CONDITION */
1052 if (vstor_packet->vm_srb.srb_status &
1053 SRB_STATUS_AUTOSENSE_VALID) {
1054 /* autosense data available */
1056 storvsc_log(device, STORVSC_LOGGING_WARN,
1057 "stor pkt %p autosense data valid - len %d\n",
1058 request, vstor_packet->vm_srb.sense_info_length);
1060 memcpy(request->cmd->sense_buffer,
1061 vstor_packet->vm_srb.sense_data,
1062 vstor_packet->vm_srb.sense_info_length);
1067 stor_pkt->vm_srb.data_transfer_length =
1068 vstor_packet->vm_srb.data_transfer_length;
1070 storvsc_command_completion(request, stor_device);
1072 if (atomic_dec_and_test(&stor_device->num_outstanding_req) &&
1073 stor_device->drain_notify)
1074 wake_up(&stor_device->waiting_to_drain);
1079 static void storvsc_on_receive(struct storvsc_device *stor_device,
1080 struct vstor_packet *vstor_packet,
1081 struct storvsc_cmd_request *request)
1083 struct storvsc_scan_work *work;
1085 switch (vstor_packet->operation) {
1086 case VSTOR_OPERATION_COMPLETE_IO:
1087 storvsc_on_io_completion(stor_device, vstor_packet, request);
1088 break;
1090 case VSTOR_OPERATION_REMOVE_DEVICE:
1091 case VSTOR_OPERATION_ENUMERATE_BUS:
1092 work = kmalloc(sizeof(struct storvsc_scan_work), GFP_ATOMIC);
1093 if (!work)
1094 return;
1096 INIT_WORK(&work->work, storvsc_host_scan);
1097 work->host = stor_device->host;
1098 schedule_work(&work->work);
1099 break;
1101 case VSTOR_OPERATION_FCHBA_DATA:
1102 cache_wwn(stor_device, vstor_packet);
1103 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1104 fc_host_node_name(stor_device->host) = stor_device->node_name;
1105 fc_host_port_name(stor_device->host) = stor_device->port_name;
1106 #endif
1107 break;
1108 default:
1109 break;
1113 static void storvsc_on_channel_callback(void *context)
1115 struct vmbus_channel *channel = (struct vmbus_channel *)context;
1116 struct hv_device *device;
1117 struct storvsc_device *stor_device;
1118 u32 bytes_recvd;
1119 u64 request_id;
1120 unsigned char packet[ALIGN(sizeof(struct vstor_packet), 8)];
1121 struct storvsc_cmd_request *request;
1122 int ret;
1124 if (channel->primary_channel != NULL)
1125 device = channel->primary_channel->device_obj;
1126 else
1127 device = channel->device_obj;
1129 stor_device = get_in_stor_device(device);
1130 if (!stor_device)
1131 return;
1133 do {
1134 ret = vmbus_recvpacket(channel, packet,
1135 ALIGN((sizeof(struct vstor_packet) -
1136 vmscsi_size_delta), 8),
1137 &bytes_recvd, &request_id);
1138 if (ret == 0 && bytes_recvd > 0) {
1140 request = (struct storvsc_cmd_request *)
1141 (unsigned long)request_id;
1143 if ((request == &stor_device->init_request) ||
1144 (request == &stor_device->reset_request)) {
1146 memcpy(&request->vstor_packet, packet,
1147 (sizeof(struct vstor_packet) -
1148 vmscsi_size_delta));
1149 complete(&request->wait_event);
1150 } else {
1151 storvsc_on_receive(stor_device,
1152 (struct vstor_packet *)packet,
1153 request);
1155 } else {
1156 break;
1158 } while (1);
1160 return;
1163 static int storvsc_connect_to_vsp(struct hv_device *device, u32 ring_size,
1164 bool is_fc)
1166 struct vmstorage_channel_properties props;
1167 int ret;
1169 memset(&props, 0, sizeof(struct vmstorage_channel_properties));
1171 ret = vmbus_open(device->channel,
1172 ring_size,
1173 ring_size,
1174 (void *)&props,
1175 sizeof(struct vmstorage_channel_properties),
1176 storvsc_on_channel_callback, device->channel);
1178 if (ret != 0)
1179 return ret;
1181 ret = storvsc_channel_init(device, is_fc);
1183 return ret;
1186 static int storvsc_dev_remove(struct hv_device *device)
1188 struct storvsc_device *stor_device;
1189 unsigned long flags;
1191 stor_device = hv_get_drvdata(device);
1193 spin_lock_irqsave(&device->channel->inbound_lock, flags);
1194 stor_device->destroy = true;
1195 spin_unlock_irqrestore(&device->channel->inbound_lock, flags);
1198 * At this point, all outbound traffic should be disable. We
1199 * only allow inbound traffic (responses) to proceed so that
1200 * outstanding requests can be completed.
1203 storvsc_wait_to_drain(stor_device);
1206 * Since we have already drained, we don't need to busy wait
1207 * as was done in final_release_stor_device()
1208 * Note that we cannot set the ext pointer to NULL until
1209 * we have drained - to drain the outgoing packets, we need to
1210 * allow incoming packets.
1212 spin_lock_irqsave(&device->channel->inbound_lock, flags);
1213 hv_set_drvdata(device, NULL);
1214 spin_unlock_irqrestore(&device->channel->inbound_lock, flags);
1216 /* Close the channel */
1217 vmbus_close(device->channel);
1219 kfree(stor_device);
1220 return 0;
1223 static int storvsc_do_io(struct hv_device *device,
1224 struct storvsc_cmd_request *request)
1226 struct storvsc_device *stor_device;
1227 struct vstor_packet *vstor_packet;
1228 struct vmbus_channel *outgoing_channel;
1229 int ret = 0;
1231 vstor_packet = &request->vstor_packet;
1232 stor_device = get_out_stor_device(device);
1234 if (!stor_device)
1235 return -ENODEV;
1238 request->device = device;
1240 * Select an an appropriate channel to send the request out.
1243 outgoing_channel = vmbus_get_outgoing_channel(device->channel);
1246 vstor_packet->flags |= REQUEST_COMPLETION_FLAG;
1248 vstor_packet->vm_srb.length = (sizeof(struct vmscsi_request) -
1249 vmscsi_size_delta);
1252 vstor_packet->vm_srb.sense_info_length = sense_buffer_size;
1255 vstor_packet->vm_srb.data_transfer_length =
1256 request->payload->range.len;
1258 vstor_packet->operation = VSTOR_OPERATION_EXECUTE_SRB;
1260 if (request->payload->range.len) {
1262 ret = vmbus_sendpacket_mpb_desc(outgoing_channel,
1263 request->payload, request->payload_sz,
1264 vstor_packet,
1265 (sizeof(struct vstor_packet) -
1266 vmscsi_size_delta),
1267 (unsigned long)request);
1268 } else {
1269 ret = vmbus_sendpacket(outgoing_channel, vstor_packet,
1270 (sizeof(struct vstor_packet) -
1271 vmscsi_size_delta),
1272 (unsigned long)request,
1273 VM_PKT_DATA_INBAND,
1274 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
1277 if (ret != 0)
1278 return ret;
1280 atomic_inc(&stor_device->num_outstanding_req);
1282 return ret;
1285 static int storvsc_device_alloc(struct scsi_device *sdevice)
1288 * Set blist flag to permit the reading of the VPD pages even when
1289 * the target may claim SPC-2 compliance. MSFT targets currently
1290 * claim SPC-2 compliance while they implement post SPC-2 features.
1291 * With this flag we can correctly handle WRITE_SAME_16 issues.
1293 * Hypervisor reports SCSI_UNKNOWN type for DVD ROM device but
1294 * still supports REPORT LUN.
1296 sdevice->sdev_bflags = BLIST_REPORTLUN2 | BLIST_TRY_VPD_PAGES;
1298 return 0;
1301 static int storvsc_device_configure(struct scsi_device *sdevice)
1304 blk_queue_max_segment_size(sdevice->request_queue, PAGE_SIZE);
1306 blk_queue_bounce_limit(sdevice->request_queue, BLK_BOUNCE_ANY);
1308 blk_queue_rq_timeout(sdevice->request_queue, (storvsc_timeout * HZ));
1310 /* Ensure there are no gaps in presented sgls */
1311 blk_queue_virt_boundary(sdevice->request_queue, PAGE_SIZE - 1);
1313 sdevice->no_write_same = 1;
1316 * If the host is WIN8 or WIN8 R2, claim conformance to SPC-3
1317 * if the device is a MSFT virtual device. If the host is
1318 * WIN10 or newer, allow write_same.
1320 if (!strncmp(sdevice->vendor, "Msft", 4)) {
1321 switch (vmstor_proto_version) {
1322 case VMSTOR_PROTO_VERSION_WIN8:
1323 case VMSTOR_PROTO_VERSION_WIN8_1:
1324 sdevice->scsi_level = SCSI_SPC_3;
1325 break;
1328 if (vmstor_proto_version >= VMSTOR_PROTO_VERSION_WIN10)
1329 sdevice->no_write_same = 0;
1332 return 0;
1335 static int storvsc_get_chs(struct scsi_device *sdev, struct block_device * bdev,
1336 sector_t capacity, int *info)
1338 sector_t nsect = capacity;
1339 sector_t cylinders = nsect;
1340 int heads, sectors_pt;
1343 * We are making up these values; let us keep it simple.
1345 heads = 0xff;
1346 sectors_pt = 0x3f; /* Sectors per track */
1347 sector_div(cylinders, heads * sectors_pt);
1348 if ((sector_t)(cylinders + 1) * heads * sectors_pt < nsect)
1349 cylinders = 0xffff;
1351 info[0] = heads;
1352 info[1] = sectors_pt;
1353 info[2] = (int)cylinders;
1355 return 0;
1358 static int storvsc_host_reset_handler(struct scsi_cmnd *scmnd)
1360 struct hv_host_device *host_dev = shost_priv(scmnd->device->host);
1361 struct hv_device *device = host_dev->dev;
1363 struct storvsc_device *stor_device;
1364 struct storvsc_cmd_request *request;
1365 struct vstor_packet *vstor_packet;
1366 int ret, t;
1369 stor_device = get_out_stor_device(device);
1370 if (!stor_device)
1371 return FAILED;
1373 request = &stor_device->reset_request;
1374 vstor_packet = &request->vstor_packet;
1376 init_completion(&request->wait_event);
1378 vstor_packet->operation = VSTOR_OPERATION_RESET_BUS;
1379 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
1380 vstor_packet->vm_srb.path_id = stor_device->path_id;
1382 ret = vmbus_sendpacket(device->channel, vstor_packet,
1383 (sizeof(struct vstor_packet) -
1384 vmscsi_size_delta),
1385 (unsigned long)&stor_device->reset_request,
1386 VM_PKT_DATA_INBAND,
1387 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
1388 if (ret != 0)
1389 return FAILED;
1391 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
1392 if (t == 0)
1393 return TIMEOUT_ERROR;
1397 * At this point, all outstanding requests in the adapter
1398 * should have been flushed out and return to us
1399 * There is a potential race here where the host may be in
1400 * the process of responding when we return from here.
1401 * Just wait for all in-transit packets to be accounted for
1402 * before we return from here.
1404 storvsc_wait_to_drain(stor_device);
1406 return SUCCESS;
1410 * The host guarantees to respond to each command, although I/O latencies might
1411 * be unbounded on Azure. Reset the timer unconditionally to give the host a
1412 * chance to perform EH.
1414 static enum blk_eh_timer_return storvsc_eh_timed_out(struct scsi_cmnd *scmnd)
1416 return BLK_EH_RESET_TIMER;
1419 static bool storvsc_scsi_cmd_ok(struct scsi_cmnd *scmnd)
1421 bool allowed = true;
1422 u8 scsi_op = scmnd->cmnd[0];
1424 switch (scsi_op) {
1425 /* the host does not handle WRITE_SAME, log accident usage */
1426 case WRITE_SAME:
1428 * smartd sends this command and the host does not handle
1429 * this. So, don't send it.
1431 case SET_WINDOW:
1432 scmnd->result = ILLEGAL_REQUEST << 16;
1433 allowed = false;
1434 break;
1435 default:
1436 break;
1438 return allowed;
1441 static int storvsc_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *scmnd)
1443 int ret;
1444 struct hv_host_device *host_dev = shost_priv(host);
1445 struct hv_device *dev = host_dev->dev;
1446 struct storvsc_cmd_request *cmd_request = scsi_cmd_priv(scmnd);
1447 int i;
1448 struct scatterlist *sgl;
1449 unsigned int sg_count = 0;
1450 struct vmscsi_request *vm_srb;
1451 struct scatterlist *cur_sgl;
1452 struct vmbus_packet_mpb_array *payload;
1453 u32 payload_sz;
1454 u32 length;
1456 if (vmstor_proto_version <= VMSTOR_PROTO_VERSION_WIN8) {
1458 * On legacy hosts filter unimplemented commands.
1459 * Future hosts are expected to correctly handle
1460 * unsupported commands. Furthermore, it is
1461 * possible that some of the currently
1462 * unsupported commands maybe supported in
1463 * future versions of the host.
1465 if (!storvsc_scsi_cmd_ok(scmnd)) {
1466 scmnd->scsi_done(scmnd);
1467 return 0;
1471 /* Setup the cmd request */
1472 cmd_request->cmd = scmnd;
1474 vm_srb = &cmd_request->vstor_packet.vm_srb;
1475 vm_srb->win8_extension.time_out_value = 60;
1477 vm_srb->win8_extension.srb_flags |=
1478 SRB_FLAGS_DISABLE_SYNCH_TRANSFER;
1480 if (scmnd->device->tagged_supported) {
1481 vm_srb->win8_extension.srb_flags |=
1482 (SRB_FLAGS_QUEUE_ACTION_ENABLE | SRB_FLAGS_NO_QUEUE_FREEZE);
1483 vm_srb->win8_extension.queue_tag = SP_UNTAGGED;
1484 vm_srb->win8_extension.queue_action = SRB_SIMPLE_TAG_REQUEST;
1487 /* Build the SRB */
1488 switch (scmnd->sc_data_direction) {
1489 case DMA_TO_DEVICE:
1490 vm_srb->data_in = WRITE_TYPE;
1491 vm_srb->win8_extension.srb_flags |= SRB_FLAGS_DATA_OUT;
1492 break;
1493 case DMA_FROM_DEVICE:
1494 vm_srb->data_in = READ_TYPE;
1495 vm_srb->win8_extension.srb_flags |= SRB_FLAGS_DATA_IN;
1496 break;
1497 case DMA_NONE:
1498 vm_srb->data_in = UNKNOWN_TYPE;
1499 vm_srb->win8_extension.srb_flags |= SRB_FLAGS_NO_DATA_TRANSFER;
1500 break;
1501 default:
1503 * This is DMA_BIDIRECTIONAL or something else we are never
1504 * supposed to see here.
1506 WARN(1, "Unexpected data direction: %d\n",
1507 scmnd->sc_data_direction);
1508 return -EINVAL;
1512 vm_srb->port_number = host_dev->port;
1513 vm_srb->path_id = scmnd->device->channel;
1514 vm_srb->target_id = scmnd->device->id;
1515 vm_srb->lun = scmnd->device->lun;
1517 vm_srb->cdb_length = scmnd->cmd_len;
1519 memcpy(vm_srb->cdb, scmnd->cmnd, vm_srb->cdb_length);
1521 sgl = (struct scatterlist *)scsi_sglist(scmnd);
1522 sg_count = scsi_sg_count(scmnd);
1524 length = scsi_bufflen(scmnd);
1525 payload = (struct vmbus_packet_mpb_array *)&cmd_request->mpb;
1526 payload_sz = sizeof(cmd_request->mpb);
1528 if (sg_count) {
1529 if (sg_count > MAX_PAGE_BUFFER_COUNT) {
1531 payload_sz = (sg_count * sizeof(void *) +
1532 sizeof(struct vmbus_packet_mpb_array));
1533 payload = kmalloc(payload_sz, GFP_ATOMIC);
1534 if (!payload)
1535 return SCSI_MLQUEUE_DEVICE_BUSY;
1538 payload->range.len = length;
1539 payload->range.offset = sgl[0].offset;
1541 cur_sgl = sgl;
1542 for (i = 0; i < sg_count; i++) {
1543 payload->range.pfn_array[i] =
1544 page_to_pfn(sg_page((cur_sgl)));
1545 cur_sgl = sg_next(cur_sgl);
1548 } else if (scsi_sglist(scmnd)) {
1549 payload->range.len = length;
1550 payload->range.offset =
1551 virt_to_phys(scsi_sglist(scmnd)) & (PAGE_SIZE-1);
1552 payload->range.pfn_array[0] =
1553 virt_to_phys(scsi_sglist(scmnd)) >> PAGE_SHIFT;
1556 cmd_request->payload = payload;
1557 cmd_request->payload_sz = payload_sz;
1559 /* Invokes the vsc to start an IO */
1560 ret = storvsc_do_io(dev, cmd_request);
1562 if (ret == -EAGAIN) {
1563 if (payload_sz > sizeof(cmd_request->mpb))
1564 kfree(payload);
1565 /* no more space */
1566 return SCSI_MLQUEUE_DEVICE_BUSY;
1569 return 0;
1572 static struct scsi_host_template scsi_driver = {
1573 .module = THIS_MODULE,
1574 .name = "storvsc_host_t",
1575 .cmd_size = sizeof(struct storvsc_cmd_request),
1576 .bios_param = storvsc_get_chs,
1577 .queuecommand = storvsc_queuecommand,
1578 .eh_host_reset_handler = storvsc_host_reset_handler,
1579 .proc_name = "storvsc_host",
1580 .eh_timed_out = storvsc_eh_timed_out,
1581 .slave_alloc = storvsc_device_alloc,
1582 .slave_configure = storvsc_device_configure,
1583 .cmd_per_lun = 2048,
1584 .this_id = -1,
1585 .use_clustering = ENABLE_CLUSTERING,
1586 /* Make sure we dont get a sg segment crosses a page boundary */
1587 .dma_boundary = PAGE_SIZE-1,
1588 .no_write_same = 1,
1591 enum {
1592 SCSI_GUID,
1593 IDE_GUID,
1594 SFC_GUID,
1597 static const struct hv_vmbus_device_id id_table[] = {
1598 /* SCSI guid */
1599 { HV_SCSI_GUID,
1600 .driver_data = SCSI_GUID
1602 /* IDE guid */
1603 { HV_IDE_GUID,
1604 .driver_data = IDE_GUID
1606 /* Fibre Channel GUID */
1608 HV_SYNTHFC_GUID,
1609 .driver_data = SFC_GUID
1611 { },
1614 MODULE_DEVICE_TABLE(vmbus, id_table);
1616 static int storvsc_probe(struct hv_device *device,
1617 const struct hv_vmbus_device_id *dev_id)
1619 int ret;
1620 int num_cpus = num_online_cpus();
1621 struct Scsi_Host *host;
1622 struct hv_host_device *host_dev;
1623 bool dev_is_ide = ((dev_id->driver_data == IDE_GUID) ? true : false);
1624 bool is_fc = ((dev_id->driver_data == SFC_GUID) ? true : false);
1625 int target = 0;
1626 struct storvsc_device *stor_device;
1627 int max_luns_per_target;
1628 int max_targets;
1629 int max_channels;
1630 int max_sub_channels = 0;
1633 * Based on the windows host we are running on,
1634 * set state to properly communicate with the host.
1637 if (vmbus_proto_version < VERSION_WIN8) {
1638 max_luns_per_target = STORVSC_IDE_MAX_LUNS_PER_TARGET;
1639 max_targets = STORVSC_IDE_MAX_TARGETS;
1640 max_channels = STORVSC_IDE_MAX_CHANNELS;
1641 } else {
1642 max_luns_per_target = STORVSC_MAX_LUNS_PER_TARGET;
1643 max_targets = STORVSC_MAX_TARGETS;
1644 max_channels = STORVSC_MAX_CHANNELS;
1646 * On Windows8 and above, we support sub-channels for storage.
1647 * The number of sub-channels offerred is based on the number of
1648 * VCPUs in the guest.
1650 max_sub_channels = (num_cpus / storvsc_vcpus_per_sub_channel);
1653 scsi_driver.can_queue = (max_outstanding_req_per_channel *
1654 (max_sub_channels + 1));
1656 host = scsi_host_alloc(&scsi_driver,
1657 sizeof(struct hv_host_device));
1658 if (!host)
1659 return -ENOMEM;
1661 host_dev = shost_priv(host);
1662 memset(host_dev, 0, sizeof(struct hv_host_device));
1664 host_dev->port = host->host_no;
1665 host_dev->dev = device;
1668 stor_device = kzalloc(sizeof(struct storvsc_device), GFP_KERNEL);
1669 if (!stor_device) {
1670 ret = -ENOMEM;
1671 goto err_out0;
1674 stor_device->destroy = false;
1675 stor_device->open_sub_channel = false;
1676 init_waitqueue_head(&stor_device->waiting_to_drain);
1677 stor_device->device = device;
1678 stor_device->host = host;
1679 hv_set_drvdata(device, stor_device);
1681 stor_device->port_number = host->host_no;
1682 ret = storvsc_connect_to_vsp(device, storvsc_ringbuffer_size, is_fc);
1683 if (ret)
1684 goto err_out1;
1686 host_dev->path = stor_device->path_id;
1687 host_dev->target = stor_device->target_id;
1689 switch (dev_id->driver_data) {
1690 case SFC_GUID:
1691 host->max_lun = STORVSC_FC_MAX_LUNS_PER_TARGET;
1692 host->max_id = STORVSC_FC_MAX_TARGETS;
1693 host->max_channel = STORVSC_FC_MAX_CHANNELS - 1;
1694 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1695 host->transportt = fc_transport_template;
1696 #endif
1697 break;
1699 case SCSI_GUID:
1700 host->max_lun = max_luns_per_target;
1701 host->max_id = max_targets;
1702 host->max_channel = max_channels - 1;
1703 break;
1705 default:
1706 host->max_lun = STORVSC_IDE_MAX_LUNS_PER_TARGET;
1707 host->max_id = STORVSC_IDE_MAX_TARGETS;
1708 host->max_channel = STORVSC_IDE_MAX_CHANNELS - 1;
1709 break;
1711 /* max cmd length */
1712 host->max_cmd_len = STORVSC_MAX_CMD_LEN;
1715 * set the table size based on the info we got
1716 * from the host.
1718 host->sg_tablesize = (stor_device->max_transfer_bytes >> PAGE_SHIFT);
1720 /* Register the HBA and start the scsi bus scan */
1721 ret = scsi_add_host(host, &device->device);
1722 if (ret != 0)
1723 goto err_out2;
1725 if (!dev_is_ide) {
1726 scsi_scan_host(host);
1727 } else {
1728 target = (device->dev_instance.b[5] << 8 |
1729 device->dev_instance.b[4]);
1730 ret = scsi_add_device(host, 0, target, 0);
1731 if (ret) {
1732 scsi_remove_host(host);
1733 goto err_out2;
1736 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1737 if (host->transportt == fc_transport_template) {
1738 fc_host_node_name(host) = stor_device->node_name;
1739 fc_host_port_name(host) = stor_device->port_name;
1741 #endif
1742 return 0;
1744 err_out2:
1746 * Once we have connected with the host, we would need to
1747 * to invoke storvsc_dev_remove() to rollback this state and
1748 * this call also frees up the stor_device; hence the jump around
1749 * err_out1 label.
1751 storvsc_dev_remove(device);
1752 goto err_out0;
1754 err_out1:
1755 kfree(stor_device);
1757 err_out0:
1758 scsi_host_put(host);
1759 return ret;
1762 static int storvsc_remove(struct hv_device *dev)
1764 struct storvsc_device *stor_device = hv_get_drvdata(dev);
1765 struct Scsi_Host *host = stor_device->host;
1767 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1768 if (host->transportt == fc_transport_template)
1769 fc_remove_host(host);
1770 #endif
1771 scsi_remove_host(host);
1772 storvsc_dev_remove(dev);
1773 scsi_host_put(host);
1775 return 0;
1778 static struct hv_driver storvsc_drv = {
1779 .name = KBUILD_MODNAME,
1780 .id_table = id_table,
1781 .probe = storvsc_probe,
1782 .remove = storvsc_remove,
1785 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1786 static struct fc_function_template fc_transport_functions = {
1787 .show_host_node_name = 1,
1788 .show_host_port_name = 1,
1790 #endif
1792 static int __init storvsc_drv_init(void)
1794 int ret;
1797 * Divide the ring buffer data size (which is 1 page less
1798 * than the ring buffer size since that page is reserved for
1799 * the ring buffer indices) by the max request size (which is
1800 * vmbus_channel_packet_multipage_buffer + struct vstor_packet + u64)
1802 max_outstanding_req_per_channel =
1803 ((storvsc_ringbuffer_size - PAGE_SIZE) /
1804 ALIGN(MAX_MULTIPAGE_BUFFER_PACKET +
1805 sizeof(struct vstor_packet) + sizeof(u64) -
1806 vmscsi_size_delta,
1807 sizeof(u64)));
1809 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1810 fc_transport_template = fc_attach_transport(&fc_transport_functions);
1811 if (!fc_transport_template)
1812 return -ENODEV;
1815 * Install Hyper-V specific timeout handler.
1817 fc_transport_template->eh_timed_out = storvsc_eh_timed_out;
1818 #endif
1820 ret = vmbus_driver_register(&storvsc_drv);
1822 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1823 if (ret)
1824 fc_release_transport(fc_transport_template);
1825 #endif
1827 return ret;
1830 static void __exit storvsc_drv_exit(void)
1832 vmbus_driver_unregister(&storvsc_drv);
1833 #if IS_ENABLED(CONFIG_SCSI_FC_ATTRS)
1834 fc_release_transport(fc_transport_template);
1835 #endif
1838 MODULE_LICENSE("GPL");
1839 MODULE_DESCRIPTION("Microsoft Hyper-V virtual storage driver");
1840 module_init(storvsc_drv_init);
1841 module_exit(storvsc_drv_exit);