1 /*
2  * Copyright (c) 2009, Microsoft Corporation.
3  *
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.
7  *
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.
12  *
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.
16  *
17  * Authors:
18  *   Haiyang Zhang <haiyangz@microsoft.com>
19  *   Hank Janssen  <hjanssen@microsoft.com>
20  *   K. Y. Srinivasan <kys@microsoft.com>
21  */
22 
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 
45 /*
46  * All wire protocol details (storage protocol between the guest and the host)
47  * are consolidated here.
48  *
49  * Begin protocol definitions.
50  */
51 
52 /*
53  * Version history:
54  * V1 Beta: 0.1
55  * V1 RC < 2008/1/31: 1.0
56  * V1 RC > 2008/1/31:  2.0
57  * Win7: 4.2
58  * Win8: 5.1
59  * Win8.1: 6.0
60  * Win10: 6.2
61  */
62 
63 #define VMSTOR_PROTO_VERSION(MAJOR_, MINOR_)	((((MAJOR_) & 0xff) << 8) | \
64 						(((MINOR_) & 0xff)))
65 
66 #define VMSTOR_PROTO_VERSION_WIN6	VMSTOR_PROTO_VERSION(2, 0)
67 #define VMSTOR_PROTO_VERSION_WIN7	VMSTOR_PROTO_VERSION(4, 2)
68 #define VMSTOR_PROTO_VERSION_WIN8	VMSTOR_PROTO_VERSION(5, 1)
69 #define VMSTOR_PROTO_VERSION_WIN8_1	VMSTOR_PROTO_VERSION(6, 0)
70 #define VMSTOR_PROTO_VERSION_WIN10	VMSTOR_PROTO_VERSION(6, 2)
71 
72 /*  Packet structure describing virtual storage requests. */
73 enum vstor_packet_operation {
74 	VSTOR_OPERATION_COMPLETE_IO		= 1,
75 	VSTOR_OPERATION_REMOVE_DEVICE		= 2,
76 	VSTOR_OPERATION_EXECUTE_SRB		= 3,
77 	VSTOR_OPERATION_RESET_LUN		= 4,
78 	VSTOR_OPERATION_RESET_ADAPTER		= 5,
79 	VSTOR_OPERATION_RESET_BUS		= 6,
80 	VSTOR_OPERATION_BEGIN_INITIALIZATION	= 7,
81 	VSTOR_OPERATION_END_INITIALIZATION	= 8,
82 	VSTOR_OPERATION_QUERY_PROTOCOL_VERSION	= 9,
83 	VSTOR_OPERATION_QUERY_PROPERTIES	= 10,
84 	VSTOR_OPERATION_ENUMERATE_BUS		= 11,
85 	VSTOR_OPERATION_FCHBA_DATA              = 12,
86 	VSTOR_OPERATION_CREATE_SUB_CHANNELS     = 13,
87 	VSTOR_OPERATION_MAXIMUM                 = 13
88 };
89 
90 /*
91  * WWN packet for Fibre Channel HBA
92  */
93 
94 struct hv_fc_wwn_packet {
95 	bool	primary_active;
96 	u8	reserved1;
97 	u8	reserved2;
98 	u8	primary_port_wwn[8];
99 	u8	primary_node_wwn[8];
100 	u8	secondary_port_wwn[8];
101 	u8	secondary_node_wwn[8];
102 };
103 
104 
105 
106 /*
107  * SRB Flag Bits
108  */
109 
110 #define SRB_FLAGS_QUEUE_ACTION_ENABLE		0x00000002
111 #define SRB_FLAGS_DISABLE_DISCONNECT		0x00000004
112 #define SRB_FLAGS_DISABLE_SYNCH_TRANSFER	0x00000008
113 #define SRB_FLAGS_BYPASS_FROZEN_QUEUE		0x00000010
114 #define SRB_FLAGS_DISABLE_AUTOSENSE		0x00000020
115 #define SRB_FLAGS_DATA_IN			0x00000040
116 #define SRB_FLAGS_DATA_OUT			0x00000080
117 #define SRB_FLAGS_NO_DATA_TRANSFER		0x00000000
118 #define SRB_FLAGS_UNSPECIFIED_DIRECTION	(SRB_FLAGS_DATA_IN | SRB_FLAGS_DATA_OUT)
119 #define SRB_FLAGS_NO_QUEUE_FREEZE		0x00000100
120 #define SRB_FLAGS_ADAPTER_CACHE_ENABLE		0x00000200
121 #define SRB_FLAGS_FREE_SENSE_BUFFER		0x00000400
122 
123 /*
124  * This flag indicates the request is part of the workflow for processing a D3.
125  */
126 #define SRB_FLAGS_D3_PROCESSING			0x00000800
127 #define SRB_FLAGS_IS_ACTIVE			0x00010000
128 #define SRB_FLAGS_ALLOCATED_FROM_ZONE		0x00020000
129 #define SRB_FLAGS_SGLIST_FROM_POOL		0x00040000
130 #define SRB_FLAGS_BYPASS_LOCKED_QUEUE		0x00080000
131 #define SRB_FLAGS_NO_KEEP_AWAKE			0x00100000
132 #define SRB_FLAGS_PORT_DRIVER_ALLOCSENSE	0x00200000
133 #define SRB_FLAGS_PORT_DRIVER_SENSEHASPORT	0x00400000
134 #define SRB_FLAGS_DONT_START_NEXT_PACKET	0x00800000
135 #define SRB_FLAGS_PORT_DRIVER_RESERVED		0x0F000000
136 #define SRB_FLAGS_CLASS_DRIVER_RESERVED		0xF0000000
137 
138 
139 /*
140  * Platform neutral description of a scsi request -
141  * this remains the same across the write regardless of 32/64 bit
142  * note: it's patterned off the SCSI_PASS_THROUGH structure
143  */
144 #define STORVSC_MAX_CMD_LEN			0x10
145 
146 #define POST_WIN7_STORVSC_SENSE_BUFFER_SIZE	0x14
147 #define PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE	0x12
148 
149 #define STORVSC_SENSE_BUFFER_SIZE		0x14
150 #define STORVSC_MAX_BUF_LEN_WITH_PADDING	0x14
151 
152 /*
153  * Sense buffer size changed in win8; have a run-time
154  * variable to track the size we should use.  This value will
155  * likely change during protocol negotiation but it is valid
156  * to start by assuming pre-Win8.
157  */
158 static int sense_buffer_size = PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE;
159 
160 /*
161  * The storage protocol version is determined during the
162  * initial exchange with the host.  It will indicate which
163  * storage functionality is available in the host.
164 */
165 static int vmstor_proto_version;
166 
167 struct vmscsi_win8_extension {
168 	/*
169 	 * The following were added in Windows 8
170 	 */
171 	u16 reserve;
172 	u8  queue_tag;
173 	u8  queue_action;
174 	u32 srb_flags;
175 	u32 time_out_value;
176 	u32 queue_sort_ey;
177 } __packed;
178 
179 struct vmscsi_request {
180 	u16 length;
181 	u8 srb_status;
182 	u8 scsi_status;
183 
184 	u8  port_number;
185 	u8  path_id;
186 	u8  target_id;
187 	u8  lun;
188 
189 	u8  cdb_length;
190 	u8  sense_info_length;
191 	u8  data_in;
192 	u8  reserved;
193 
194 	u32 data_transfer_length;
195 
196 	union {
197 		u8 cdb[STORVSC_MAX_CMD_LEN];
198 		u8 sense_data[STORVSC_SENSE_BUFFER_SIZE];
199 		u8 reserved_array[STORVSC_MAX_BUF_LEN_WITH_PADDING];
200 	};
201 	/*
202 	 * The following was added in win8.
203 	 */
204 	struct vmscsi_win8_extension win8_extension;
205 
206 } __attribute((packed));
207 
208 
209 /*
210  * The size of the vmscsi_request has changed in win8. The
211  * additional size is because of new elements added to the
212  * structure. These elements are valid only when we are talking
213  * to a win8 host.
214  * Track the correction to size we need to apply. This value
215  * will likely change during protocol negotiation but it is
216  * valid to start by assuming pre-Win8.
217  */
218 static int vmscsi_size_delta = sizeof(struct vmscsi_win8_extension);
219 
220 /*
221  * The list of storage protocols in order of preference.
222  */
223 struct vmstor_protocol {
224 	int protocol_version;
225 	int sense_buffer_size;
226 	int vmscsi_size_delta;
227 };
228 
229 
230 static const struct vmstor_protocol vmstor_protocols[] = {
231 	{
232 		VMSTOR_PROTO_VERSION_WIN10,
233 		POST_WIN7_STORVSC_SENSE_BUFFER_SIZE,
234 		0
235 	},
236 	{
237 		VMSTOR_PROTO_VERSION_WIN8_1,
238 		POST_WIN7_STORVSC_SENSE_BUFFER_SIZE,
239 		0
240 	},
241 	{
242 		VMSTOR_PROTO_VERSION_WIN8,
243 		POST_WIN7_STORVSC_SENSE_BUFFER_SIZE,
244 		0
245 	},
246 	{
247 		VMSTOR_PROTO_VERSION_WIN7,
248 		PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE,
249 		sizeof(struct vmscsi_win8_extension),
250 	},
251 	{
252 		VMSTOR_PROTO_VERSION_WIN6,
253 		PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE,
254 		sizeof(struct vmscsi_win8_extension),
255 	}
256 };
257 
258 
259 /*
260  * This structure is sent during the intialization phase to get the different
261  * properties of the channel.
262  */
263 
264 #define STORAGE_CHANNEL_SUPPORTS_MULTI_CHANNEL		0x1
265 
266 struct vmstorage_channel_properties {
267 	u32 reserved;
268 	u16 max_channel_cnt;
269 	u16 reserved1;
270 
271 	u32 flags;
272 	u32   max_transfer_bytes;
273 
274 	u64  reserved2;
275 } __packed;
276 
277 /*  This structure is sent during the storage protocol negotiations. */
278 struct vmstorage_protocol_version {
279 	/* Major (MSW) and minor (LSW) version numbers. */
280 	u16 major_minor;
281 
282 	/*
283 	 * Revision number is auto-incremented whenever this file is changed
284 	 * (See FILL_VMSTOR_REVISION macro above).  Mismatch does not
285 	 * definitely indicate incompatibility--but it does indicate mismatched
286 	 * builds.
287 	 * This is only used on the windows side. Just set it to 0.
288 	 */
289 	u16 revision;
290 } __packed;
291 
292 /* Channel Property Flags */
293 #define STORAGE_CHANNEL_REMOVABLE_FLAG		0x1
294 #define STORAGE_CHANNEL_EMULATED_IDE_FLAG	0x2
295 
296 struct vstor_packet {
297 	/* Requested operation type */
298 	enum vstor_packet_operation operation;
299 
300 	/*  Flags - see below for values */
301 	u32 flags;
302 
303 	/* Status of the request returned from the server side. */
304 	u32 status;
305 
306 	/* Data payload area */
307 	union {
308 		/*
309 		 * Structure used to forward SCSI commands from the
310 		 * client to the server.
311 		 */
312 		struct vmscsi_request vm_srb;
313 
314 		/* Structure used to query channel properties. */
315 		struct vmstorage_channel_properties storage_channel_properties;
316 
317 		/* Used during version negotiations. */
318 		struct vmstorage_protocol_version version;
319 
320 		/* Fibre channel address packet */
321 		struct hv_fc_wwn_packet wwn_packet;
322 
323 		/* Number of sub-channels to create */
324 		u16 sub_channel_count;
325 
326 		/* This will be the maximum of the union members */
327 		u8  buffer[0x34];
328 	};
329 } __packed;
330 
331 /*
332  * Packet Flags:
333  *
334  * This flag indicates that the server should send back a completion for this
335  * packet.
336  */
337 
338 #define REQUEST_COMPLETION_FLAG	0x1
339 
340 /* Matches Windows-end */
341 enum storvsc_request_type {
342 	WRITE_TYPE = 0,
343 	READ_TYPE,
344 	UNKNOWN_TYPE,
345 };
346 
347 /*
348  * SRB status codes and masks; a subset of the codes used here.
349  */
350 
351 #define SRB_STATUS_AUTOSENSE_VALID	0x80
352 #define SRB_STATUS_QUEUE_FROZEN		0x40
353 #define SRB_STATUS_INVALID_LUN	0x20
354 #define SRB_STATUS_SUCCESS	0x01
355 #define SRB_STATUS_ABORTED	0x02
356 #define SRB_STATUS_ERROR	0x04
357 
358 #define SRB_STATUS(status) \
359 	(status & ~(SRB_STATUS_AUTOSENSE_VALID | SRB_STATUS_QUEUE_FROZEN))
360 /*
361  * This is the end of Protocol specific defines.
362  */
363 
364 static int storvsc_ringbuffer_size = (256 * PAGE_SIZE);
365 static u32 max_outstanding_req_per_channel;
366 
367 static int storvsc_vcpus_per_sub_channel = 4;
368 
369 module_param(storvsc_ringbuffer_size, int, S_IRUGO);
370 MODULE_PARM_DESC(storvsc_ringbuffer_size, "Ring buffer size (bytes)");
371 
372 module_param(storvsc_vcpus_per_sub_channel, int, S_IRUGO);
373 MODULE_PARM_DESC(vcpus_per_sub_channel, "Ratio of VCPUs to subchannels");
374 /*
375  * Timeout in seconds for all devices managed by this driver.
376  */
377 static int storvsc_timeout = 180;
378 
379 static int msft_blist_flags = BLIST_TRY_VPD_PAGES;
380 
381 
382 static void storvsc_on_channel_callback(void *context);
383 
384 #define STORVSC_MAX_LUNS_PER_TARGET			255
385 #define STORVSC_MAX_TARGETS				2
386 #define STORVSC_MAX_CHANNELS				8
387 
388 #define STORVSC_FC_MAX_LUNS_PER_TARGET			255
389 #define STORVSC_FC_MAX_TARGETS				128
390 #define STORVSC_FC_MAX_CHANNELS				8
391 
392 #define STORVSC_IDE_MAX_LUNS_PER_TARGET			64
393 #define STORVSC_IDE_MAX_TARGETS				1
394 #define STORVSC_IDE_MAX_CHANNELS			1
395 
396 struct storvsc_cmd_request {
397 	struct scsi_cmnd *cmd;
398 
399 	struct hv_device *device;
400 
401 	/* Synchronize the request/response if needed */
402 	struct completion wait_event;
403 
404 	struct vmbus_channel_packet_multipage_buffer mpb;
405 	struct vmbus_packet_mpb_array *payload;
406 	u32 payload_sz;
407 
408 	struct vstor_packet vstor_packet;
409 };
410 
411 
412 /* A storvsc device is a device object that contains a vmbus channel */
413 struct storvsc_device {
414 	struct hv_device *device;
415 
416 	bool	 destroy;
417 	bool	 drain_notify;
418 	bool	 open_sub_channel;
419 	atomic_t num_outstanding_req;
420 	struct Scsi_Host *host;
421 
422 	wait_queue_head_t waiting_to_drain;
423 
424 	/*
425 	 * Each unique Port/Path/Target represents 1 channel ie scsi
426 	 * controller. In reality, the pathid, targetid is always 0
427 	 * and the port is set by us
428 	 */
429 	unsigned int port_number;
430 	unsigned char path_id;
431 	unsigned char target_id;
432 
433 	/*
434 	 * Max I/O, the device can support.
435 	 */
436 	u32   max_transfer_bytes;
437 	/* Used for vsc/vsp channel reset process */
438 	struct storvsc_cmd_request init_request;
439 	struct storvsc_cmd_request reset_request;
440 };
441 
442 struct hv_host_device {
443 	struct hv_device *dev;
444 	unsigned int port;
445 	unsigned char path;
446 	unsigned char target;
447 };
448 
449 struct storvsc_scan_work {
450 	struct work_struct work;
451 	struct Scsi_Host *host;
452 	uint lun;
453 };
454 
storvsc_device_scan(struct work_struct * work)455 static void storvsc_device_scan(struct work_struct *work)
456 {
457 	struct storvsc_scan_work *wrk;
458 	uint lun;
459 	struct scsi_device *sdev;
460 
461 	wrk = container_of(work, struct storvsc_scan_work, work);
462 	lun = wrk->lun;
463 
464 	sdev = scsi_device_lookup(wrk->host, 0, 0, lun);
465 	if (!sdev)
466 		goto done;
467 	scsi_rescan_device(&sdev->sdev_gendev);
468 	scsi_device_put(sdev);
469 
470 done:
471 	kfree(wrk);
472 }
473 
storvsc_host_scan(struct work_struct * work)474 static void storvsc_host_scan(struct work_struct *work)
475 {
476 	struct storvsc_scan_work *wrk;
477 	struct Scsi_Host *host;
478 	struct scsi_device *sdev;
479 
480 	wrk = container_of(work, struct storvsc_scan_work, work);
481 	host = wrk->host;
482 
483 	/*
484 	 * Before scanning the host, first check to see if any of the
485 	 * currrently known devices have been hot removed. We issue a
486 	 * "unit ready" command against all currently known devices.
487 	 * This I/O will result in an error for devices that have been
488 	 * removed. As part of handling the I/O error, we remove the device.
489 	 *
490 	 * When a LUN is added or removed, the host sends us a signal to
491 	 * scan the host. Thus we are forced to discover the LUNs that
492 	 * may have been removed this way.
493 	 */
494 	mutex_lock(&host->scan_mutex);
495 	shost_for_each_device(sdev, host)
496 		scsi_test_unit_ready(sdev, 1, 1, NULL);
497 	mutex_unlock(&host->scan_mutex);
498 	/*
499 	 * Now scan the host to discover LUNs that may have been added.
500 	 */
501 	scsi_scan_host(host);
502 
503 	kfree(wrk);
504 }
505 
storvsc_remove_lun(struct work_struct * work)506 static void storvsc_remove_lun(struct work_struct *work)
507 {
508 	struct storvsc_scan_work *wrk;
509 	struct scsi_device *sdev;
510 
511 	wrk = container_of(work, struct storvsc_scan_work, work);
512 	if (!scsi_host_get(wrk->host))
513 		goto done;
514 
515 	sdev = scsi_device_lookup(wrk->host, 0, 0, wrk->lun);
516 
517 	if (sdev) {
518 		scsi_remove_device(sdev);
519 		scsi_device_put(sdev);
520 	}
521 	scsi_host_put(wrk->host);
522 
523 done:
524 	kfree(wrk);
525 }
526 
527 
528 /*
529  * We can get incoming messages from the host that are not in response to
530  * messages that we have sent out. An example of this would be messages
531  * received by the guest to notify dynamic addition/removal of LUNs. To
532  * deal with potential race conditions where the driver may be in the
533  * midst of being unloaded when we might receive an unsolicited message
534  * from the host, we have implemented a mechanism to gurantee sequential
535  * consistency:
536  *
537  * 1) Once the device is marked as being destroyed, we will fail all
538  *    outgoing messages.
539  * 2) We permit incoming messages when the device is being destroyed,
540  *    only to properly account for messages already sent out.
541  */
542 
get_out_stor_device(struct hv_device * device)543 static inline struct storvsc_device *get_out_stor_device(
544 					struct hv_device *device)
545 {
546 	struct storvsc_device *stor_device;
547 
548 	stor_device = hv_get_drvdata(device);
549 
550 	if (stor_device && stor_device->destroy)
551 		stor_device = NULL;
552 
553 	return stor_device;
554 }
555 
556 
storvsc_wait_to_drain(struct storvsc_device * dev)557 static inline void storvsc_wait_to_drain(struct storvsc_device *dev)
558 {
559 	dev->drain_notify = true;
560 	wait_event(dev->waiting_to_drain,
561 		   atomic_read(&dev->num_outstanding_req) == 0);
562 	dev->drain_notify = false;
563 }
564 
get_in_stor_device(struct hv_device * device)565 static inline struct storvsc_device *get_in_stor_device(
566 					struct hv_device *device)
567 {
568 	struct storvsc_device *stor_device;
569 
570 	stor_device = hv_get_drvdata(device);
571 
572 	if (!stor_device)
573 		goto get_in_err;
574 
575 	/*
576 	 * If the device is being destroyed; allow incoming
577 	 * traffic only to cleanup outstanding requests.
578 	 */
579 
580 	if (stor_device->destroy  &&
581 		(atomic_read(&stor_device->num_outstanding_req) == 0))
582 		stor_device = NULL;
583 
584 get_in_err:
585 	return stor_device;
586 
587 }
588 
handle_sc_creation(struct vmbus_channel * new_sc)589 static void handle_sc_creation(struct vmbus_channel *new_sc)
590 {
591 	struct hv_device *device = new_sc->primary_channel->device_obj;
592 	struct storvsc_device *stor_device;
593 	struct vmstorage_channel_properties props;
594 
595 	stor_device = get_out_stor_device(device);
596 	if (!stor_device)
597 		return;
598 
599 	if (stor_device->open_sub_channel == false)
600 		return;
601 
602 	memset(&props, 0, sizeof(struct vmstorage_channel_properties));
603 
604 	vmbus_open(new_sc,
605 		   storvsc_ringbuffer_size,
606 		   storvsc_ringbuffer_size,
607 		   (void *)&props,
608 		   sizeof(struct vmstorage_channel_properties),
609 		   storvsc_on_channel_callback, new_sc);
610 }
611 
handle_multichannel_storage(struct hv_device * device,int max_chns)612 static void  handle_multichannel_storage(struct hv_device *device, int max_chns)
613 {
614 	struct storvsc_device *stor_device;
615 	int num_cpus = num_online_cpus();
616 	int num_sc;
617 	struct storvsc_cmd_request *request;
618 	struct vstor_packet *vstor_packet;
619 	int ret, t;
620 
621 	num_sc = ((max_chns > num_cpus) ? num_cpus : max_chns);
622 	stor_device = get_out_stor_device(device);
623 	if (!stor_device)
624 		return;
625 
626 	request = &stor_device->init_request;
627 	vstor_packet = &request->vstor_packet;
628 
629 	stor_device->open_sub_channel = true;
630 	/*
631 	 * Establish a handler for dealing with subchannels.
632 	 */
633 	vmbus_set_sc_create_callback(device->channel, handle_sc_creation);
634 
635 	/*
636 	 * Check to see if sub-channels have already been created. This
637 	 * can happen when this driver is re-loaded after unloading.
638 	 */
639 
640 	if (vmbus_are_subchannels_present(device->channel))
641 		return;
642 
643 	stor_device->open_sub_channel = false;
644 	/*
645 	 * Request the host to create sub-channels.
646 	 */
647 	memset(request, 0, sizeof(struct storvsc_cmd_request));
648 	init_completion(&request->wait_event);
649 	vstor_packet->operation = VSTOR_OPERATION_CREATE_SUB_CHANNELS;
650 	vstor_packet->flags = REQUEST_COMPLETION_FLAG;
651 	vstor_packet->sub_channel_count = num_sc;
652 
653 	ret = vmbus_sendpacket(device->channel, vstor_packet,
654 			       (sizeof(struct vstor_packet) -
655 			       vmscsi_size_delta),
656 			       (unsigned long)request,
657 			       VM_PKT_DATA_INBAND,
658 			       VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
659 
660 	if (ret != 0)
661 		return;
662 
663 	t = wait_for_completion_timeout(&request->wait_event, 10*HZ);
664 	if (t == 0)
665 		return;
666 
667 	if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
668 	    vstor_packet->status != 0)
669 		return;
670 
671 	/*
672 	 * Now that we created the sub-channels, invoke the check; this
673 	 * may trigger the callback.
674 	 */
675 	stor_device->open_sub_channel = true;
676 	vmbus_are_subchannels_present(device->channel);
677 }
678 
storvsc_channel_init(struct hv_device * device)679 static int storvsc_channel_init(struct hv_device *device)
680 {
681 	struct storvsc_device *stor_device;
682 	struct storvsc_cmd_request *request;
683 	struct vstor_packet *vstor_packet;
684 	int ret, t, i;
685 	int max_chns;
686 	bool process_sub_channels = false;
687 
688 	stor_device = get_out_stor_device(device);
689 	if (!stor_device)
690 		return -ENODEV;
691 
692 	request = &stor_device->init_request;
693 	vstor_packet = &request->vstor_packet;
694 
695 	/*
696 	 * Now, initiate the vsc/vsp initialization protocol on the open
697 	 * channel
698 	 */
699 	memset(request, 0, sizeof(struct storvsc_cmd_request));
700 	init_completion(&request->wait_event);
701 	vstor_packet->operation = VSTOR_OPERATION_BEGIN_INITIALIZATION;
702 	vstor_packet->flags = REQUEST_COMPLETION_FLAG;
703 
704 	ret = vmbus_sendpacket(device->channel, vstor_packet,
705 			       (sizeof(struct vstor_packet) -
706 			       vmscsi_size_delta),
707 			       (unsigned long)request,
708 			       VM_PKT_DATA_INBAND,
709 			       VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
710 	if (ret != 0)
711 		goto cleanup;
712 
713 	t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
714 	if (t == 0) {
715 		ret = -ETIMEDOUT;
716 		goto cleanup;
717 	}
718 
719 	if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
720 	    vstor_packet->status != 0) {
721 		ret = -EINVAL;
722 		goto cleanup;
723 	}
724 
725 
726 	for (i = 0; i < ARRAY_SIZE(vmstor_protocols); i++) {
727 		/* reuse the packet for version range supported */
728 		memset(vstor_packet, 0, sizeof(struct vstor_packet));
729 		vstor_packet->operation =
730 			VSTOR_OPERATION_QUERY_PROTOCOL_VERSION;
731 		vstor_packet->flags = REQUEST_COMPLETION_FLAG;
732 
733 		vstor_packet->version.major_minor =
734 			vmstor_protocols[i].protocol_version;
735 
736 		/*
737 		 * The revision number is only used in Windows; set it to 0.
738 		 */
739 		vstor_packet->version.revision = 0;
740 
741 		ret = vmbus_sendpacket(device->channel, vstor_packet,
742 			       (sizeof(struct vstor_packet) -
743 				vmscsi_size_delta),
744 			       (unsigned long)request,
745 			       VM_PKT_DATA_INBAND,
746 			       VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
747 		if (ret != 0)
748 			goto cleanup;
749 
750 		t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
751 		if (t == 0) {
752 			ret = -ETIMEDOUT;
753 			goto cleanup;
754 		}
755 
756 		if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO) {
757 			ret = -EINVAL;
758 			goto cleanup;
759 		}
760 
761 		if (vstor_packet->status == 0) {
762 			vmstor_proto_version =
763 				vmstor_protocols[i].protocol_version;
764 
765 			sense_buffer_size =
766 				vmstor_protocols[i].sense_buffer_size;
767 
768 			vmscsi_size_delta =
769 				vmstor_protocols[i].vmscsi_size_delta;
770 
771 			break;
772 		}
773 	}
774 
775 	if (vstor_packet->status != 0) {
776 		ret = -EINVAL;
777 		goto cleanup;
778 	}
779 
780 
781 	memset(vstor_packet, 0, sizeof(struct vstor_packet));
782 	vstor_packet->operation = VSTOR_OPERATION_QUERY_PROPERTIES;
783 	vstor_packet->flags = REQUEST_COMPLETION_FLAG;
784 
785 	ret = vmbus_sendpacket(device->channel, vstor_packet,
786 			       (sizeof(struct vstor_packet) -
787 				vmscsi_size_delta),
788 			       (unsigned long)request,
789 			       VM_PKT_DATA_INBAND,
790 			       VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
791 
792 	if (ret != 0)
793 		goto cleanup;
794 
795 	t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
796 	if (t == 0) {
797 		ret = -ETIMEDOUT;
798 		goto cleanup;
799 	}
800 
801 	if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
802 	    vstor_packet->status != 0) {
803 		ret = -EINVAL;
804 		goto cleanup;
805 	}
806 
807 	/*
808 	 * Check to see if multi-channel support is there.
809 	 * Hosts that implement protocol version of 5.1 and above
810 	 * support multi-channel.
811 	 */
812 	max_chns = vstor_packet->storage_channel_properties.max_channel_cnt;
813 	if (vmstor_proto_version >= VMSTOR_PROTO_VERSION_WIN8) {
814 		if (vstor_packet->storage_channel_properties.flags &
815 		    STORAGE_CHANNEL_SUPPORTS_MULTI_CHANNEL)
816 			process_sub_channels = true;
817 	}
818 	stor_device->max_transfer_bytes =
819 		vstor_packet->storage_channel_properties.max_transfer_bytes;
820 
821 	memset(vstor_packet, 0, sizeof(struct vstor_packet));
822 	vstor_packet->operation = VSTOR_OPERATION_END_INITIALIZATION;
823 	vstor_packet->flags = REQUEST_COMPLETION_FLAG;
824 
825 	ret = vmbus_sendpacket(device->channel, vstor_packet,
826 			       (sizeof(struct vstor_packet) -
827 				vmscsi_size_delta),
828 			       (unsigned long)request,
829 			       VM_PKT_DATA_INBAND,
830 			       VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
831 
832 	if (ret != 0)
833 		goto cleanup;
834 
835 	t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
836 	if (t == 0) {
837 		ret = -ETIMEDOUT;
838 		goto cleanup;
839 	}
840 
841 	if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
842 	    vstor_packet->status != 0) {
843 		ret = -EINVAL;
844 		goto cleanup;
845 	}
846 
847 	if (process_sub_channels)
848 		handle_multichannel_storage(device, max_chns);
849 
850 
851 cleanup:
852 	return ret;
853 }
854 
storvsc_handle_error(struct vmscsi_request * vm_srb,struct scsi_cmnd * scmnd,struct Scsi_Host * host,u8 asc,u8 ascq)855 static void storvsc_handle_error(struct vmscsi_request *vm_srb,
856 				struct scsi_cmnd *scmnd,
857 				struct Scsi_Host *host,
858 				u8 asc, u8 ascq)
859 {
860 	struct storvsc_scan_work *wrk;
861 	void (*process_err_fn)(struct work_struct *work);
862 	bool do_work = false;
863 
864 	switch (SRB_STATUS(vm_srb->srb_status)) {
865 	case SRB_STATUS_ERROR:
866 		/*
867 		 * If there is an error; offline the device since all
868 		 * error recovery strategies would have already been
869 		 * deployed on the host side. However, if the command
870 		 * were a pass-through command deal with it appropriately.
871 		 */
872 		switch (scmnd->cmnd[0]) {
873 		case ATA_16:
874 		case ATA_12:
875 			set_host_byte(scmnd, DID_PASSTHROUGH);
876 			break;
877 		/*
878 		 * On Some Windows hosts TEST_UNIT_READY command can return
879 		 * SRB_STATUS_ERROR, let the upper level code deal with it
880 		 * based on the sense information.
881 		 */
882 		case TEST_UNIT_READY:
883 			break;
884 		default:
885 			set_host_byte(scmnd, DID_TARGET_FAILURE);
886 		}
887 		break;
888 	case SRB_STATUS_INVALID_LUN:
889 		do_work = true;
890 		process_err_fn = storvsc_remove_lun;
891 		break;
892 	case SRB_STATUS_ABORTED:
893 		if (vm_srb->srb_status & SRB_STATUS_AUTOSENSE_VALID &&
894 		    (asc == 0x2a) && (ascq == 0x9)) {
895 			do_work = true;
896 			process_err_fn = storvsc_device_scan;
897 			/*
898 			 * Retry the I/O that trigerred this.
899 			 */
900 			set_host_byte(scmnd, DID_REQUEUE);
901 		}
902 		break;
903 	}
904 
905 	if (!do_work)
906 		return;
907 
908 	/*
909 	 * We need to schedule work to process this error; schedule it.
910 	 */
911 	wrk = kmalloc(sizeof(struct storvsc_scan_work), GFP_ATOMIC);
912 	if (!wrk) {
913 		set_host_byte(scmnd, DID_TARGET_FAILURE);
914 		return;
915 	}
916 
917 	wrk->host = host;
918 	wrk->lun = vm_srb->lun;
919 	INIT_WORK(&wrk->work, process_err_fn);
920 	schedule_work(&wrk->work);
921 }
922 
923 
storvsc_command_completion(struct storvsc_cmd_request * cmd_request)924 static void storvsc_command_completion(struct storvsc_cmd_request *cmd_request)
925 {
926 	struct scsi_cmnd *scmnd = cmd_request->cmd;
927 	struct hv_host_device *host_dev = shost_priv(scmnd->device->host);
928 	struct scsi_sense_hdr sense_hdr;
929 	struct vmscsi_request *vm_srb;
930 	struct Scsi_Host *host;
931 	struct storvsc_device *stor_dev;
932 	struct hv_device *dev = host_dev->dev;
933 	u32 payload_sz = cmd_request->payload_sz;
934 	void *payload = cmd_request->payload;
935 
936 	stor_dev = get_in_stor_device(dev);
937 	host = stor_dev->host;
938 
939 	vm_srb = &cmd_request->vstor_packet.vm_srb;
940 
941 	scmnd->result = vm_srb->scsi_status;
942 
943 	if (scmnd->result) {
944 		if (scsi_normalize_sense(scmnd->sense_buffer,
945 				SCSI_SENSE_BUFFERSIZE, &sense_hdr))
946 			scsi_print_sense_hdr(scmnd->device, "storvsc",
947 					     &sense_hdr);
948 	}
949 
950 	if (vm_srb->srb_status != SRB_STATUS_SUCCESS)
951 		storvsc_handle_error(vm_srb, scmnd, host, sense_hdr.asc,
952 					 sense_hdr.ascq);
953 
954 	scsi_set_resid(scmnd,
955 		cmd_request->payload->range.len -
956 		vm_srb->data_transfer_length);
957 
958 	scmnd->scsi_done(scmnd);
959 
960 	if (payload_sz >
961 		sizeof(struct vmbus_channel_packet_multipage_buffer))
962 		kfree(payload);
963 }
964 
storvsc_on_io_completion(struct hv_device * device,struct vstor_packet * vstor_packet,struct storvsc_cmd_request * request)965 static void storvsc_on_io_completion(struct hv_device *device,
966 				  struct vstor_packet *vstor_packet,
967 				  struct storvsc_cmd_request *request)
968 {
969 	struct storvsc_device *stor_device;
970 	struct vstor_packet *stor_pkt;
971 
972 	stor_device = hv_get_drvdata(device);
973 	stor_pkt = &request->vstor_packet;
974 
975 	/*
976 	 * The current SCSI handling on the host side does
977 	 * not correctly handle:
978 	 * INQUIRY command with page code parameter set to 0x80
979 	 * MODE_SENSE command with cmd[2] == 0x1c
980 	 *
981 	 * Setup srb and scsi status so this won't be fatal.
982 	 * We do this so we can distinguish truly fatal failues
983 	 * (srb status == 0x4) and off-line the device in that case.
984 	 */
985 
986 	if ((stor_pkt->vm_srb.cdb[0] == INQUIRY) ||
987 	   (stor_pkt->vm_srb.cdb[0] == MODE_SENSE)) {
988 		vstor_packet->vm_srb.scsi_status = 0;
989 		vstor_packet->vm_srb.srb_status = SRB_STATUS_SUCCESS;
990 	}
991 
992 
993 	/* Copy over the status...etc */
994 	stor_pkt->vm_srb.scsi_status = vstor_packet->vm_srb.scsi_status;
995 	stor_pkt->vm_srb.srb_status = vstor_packet->vm_srb.srb_status;
996 	stor_pkt->vm_srb.sense_info_length =
997 	vstor_packet->vm_srb.sense_info_length;
998 
999 
1000 	if ((vstor_packet->vm_srb.scsi_status & 0xFF) == 0x02) {
1001 		/* CHECK_CONDITION */
1002 		if (vstor_packet->vm_srb.srb_status &
1003 			SRB_STATUS_AUTOSENSE_VALID) {
1004 			/* autosense data available */
1005 
1006 			memcpy(request->cmd->sense_buffer,
1007 			       vstor_packet->vm_srb.sense_data,
1008 			       vstor_packet->vm_srb.sense_info_length);
1009 
1010 		}
1011 	}
1012 
1013 	stor_pkt->vm_srb.data_transfer_length =
1014 	vstor_packet->vm_srb.data_transfer_length;
1015 
1016 	storvsc_command_completion(request);
1017 
1018 	if (atomic_dec_and_test(&stor_device->num_outstanding_req) &&
1019 		stor_device->drain_notify)
1020 		wake_up(&stor_device->waiting_to_drain);
1021 
1022 
1023 }
1024 
storvsc_on_receive(struct hv_device * device,struct vstor_packet * vstor_packet,struct storvsc_cmd_request * request)1025 static void storvsc_on_receive(struct hv_device *device,
1026 			     struct vstor_packet *vstor_packet,
1027 			     struct storvsc_cmd_request *request)
1028 {
1029 	struct storvsc_scan_work *work;
1030 	struct storvsc_device *stor_device;
1031 
1032 	switch (vstor_packet->operation) {
1033 	case VSTOR_OPERATION_COMPLETE_IO:
1034 		storvsc_on_io_completion(device, vstor_packet, request);
1035 		break;
1036 
1037 	case VSTOR_OPERATION_REMOVE_DEVICE:
1038 	case VSTOR_OPERATION_ENUMERATE_BUS:
1039 		stor_device = get_in_stor_device(device);
1040 		work = kmalloc(sizeof(struct storvsc_scan_work), GFP_ATOMIC);
1041 		if (!work)
1042 			return;
1043 
1044 		INIT_WORK(&work->work, storvsc_host_scan);
1045 		work->host = stor_device->host;
1046 		schedule_work(&work->work);
1047 		break;
1048 
1049 	default:
1050 		break;
1051 	}
1052 }
1053 
storvsc_on_channel_callback(void * context)1054 static void storvsc_on_channel_callback(void *context)
1055 {
1056 	struct vmbus_channel *channel = (struct vmbus_channel *)context;
1057 	struct hv_device *device;
1058 	struct storvsc_device *stor_device;
1059 	u32 bytes_recvd;
1060 	u64 request_id;
1061 	unsigned char packet[ALIGN(sizeof(struct vstor_packet), 8)];
1062 	struct storvsc_cmd_request *request;
1063 	int ret;
1064 
1065 	if (channel->primary_channel != NULL)
1066 		device = channel->primary_channel->device_obj;
1067 	else
1068 		device = channel->device_obj;
1069 
1070 	stor_device = get_in_stor_device(device);
1071 	if (!stor_device)
1072 		return;
1073 
1074 	do {
1075 		ret = vmbus_recvpacket(channel, packet,
1076 				       ALIGN((sizeof(struct vstor_packet) -
1077 					     vmscsi_size_delta), 8),
1078 				       &bytes_recvd, &request_id);
1079 		if (ret == 0 && bytes_recvd > 0) {
1080 
1081 			request = (struct storvsc_cmd_request *)
1082 					(unsigned long)request_id;
1083 
1084 			if ((request == &stor_device->init_request) ||
1085 			    (request == &stor_device->reset_request)) {
1086 
1087 				memcpy(&request->vstor_packet, packet,
1088 				       (sizeof(struct vstor_packet) -
1089 					vmscsi_size_delta));
1090 				complete(&request->wait_event);
1091 			} else {
1092 				storvsc_on_receive(device,
1093 						(struct vstor_packet *)packet,
1094 						request);
1095 			}
1096 		} else {
1097 			break;
1098 		}
1099 	} while (1);
1100 
1101 	return;
1102 }
1103 
storvsc_connect_to_vsp(struct hv_device * device,u32 ring_size)1104 static int storvsc_connect_to_vsp(struct hv_device *device, u32 ring_size)
1105 {
1106 	struct vmstorage_channel_properties props;
1107 	int ret;
1108 
1109 	memset(&props, 0, sizeof(struct vmstorage_channel_properties));
1110 
1111 	ret = vmbus_open(device->channel,
1112 			 ring_size,
1113 			 ring_size,
1114 			 (void *)&props,
1115 			 sizeof(struct vmstorage_channel_properties),
1116 			 storvsc_on_channel_callback, device->channel);
1117 
1118 	if (ret != 0)
1119 		return ret;
1120 
1121 	ret = storvsc_channel_init(device);
1122 
1123 	return ret;
1124 }
1125 
storvsc_dev_remove(struct hv_device * device)1126 static int storvsc_dev_remove(struct hv_device *device)
1127 {
1128 	struct storvsc_device *stor_device;
1129 	unsigned long flags;
1130 
1131 	stor_device = hv_get_drvdata(device);
1132 
1133 	spin_lock_irqsave(&device->channel->inbound_lock, flags);
1134 	stor_device->destroy = true;
1135 	spin_unlock_irqrestore(&device->channel->inbound_lock, flags);
1136 
1137 	/*
1138 	 * At this point, all outbound traffic should be disable. We
1139 	 * only allow inbound traffic (responses) to proceed so that
1140 	 * outstanding requests can be completed.
1141 	 */
1142 
1143 	storvsc_wait_to_drain(stor_device);
1144 
1145 	/*
1146 	 * Since we have already drained, we don't need to busy wait
1147 	 * as was done in final_release_stor_device()
1148 	 * Note that we cannot set the ext pointer to NULL until
1149 	 * we have drained - to drain the outgoing packets, we need to
1150 	 * allow incoming packets.
1151 	 */
1152 	spin_lock_irqsave(&device->channel->inbound_lock, flags);
1153 	hv_set_drvdata(device, NULL);
1154 	spin_unlock_irqrestore(&device->channel->inbound_lock, flags);
1155 
1156 	/* Close the channel */
1157 	vmbus_close(device->channel);
1158 
1159 	kfree(stor_device);
1160 	return 0;
1161 }
1162 
storvsc_do_io(struct hv_device * device,struct storvsc_cmd_request * request)1163 static int storvsc_do_io(struct hv_device *device,
1164 			 struct storvsc_cmd_request *request)
1165 {
1166 	struct storvsc_device *stor_device;
1167 	struct vstor_packet *vstor_packet;
1168 	struct vmbus_channel *outgoing_channel;
1169 	int ret = 0;
1170 
1171 	vstor_packet = &request->vstor_packet;
1172 	stor_device = get_out_stor_device(device);
1173 
1174 	if (!stor_device)
1175 		return -ENODEV;
1176 
1177 
1178 	request->device  = device;
1179 	/*
1180 	 * Select an an appropriate channel to send the request out.
1181 	 */
1182 
1183 	outgoing_channel = vmbus_get_outgoing_channel(device->channel);
1184 
1185 
1186 	vstor_packet->flags |= REQUEST_COMPLETION_FLAG;
1187 
1188 	vstor_packet->vm_srb.length = (sizeof(struct vmscsi_request) -
1189 					vmscsi_size_delta);
1190 
1191 
1192 	vstor_packet->vm_srb.sense_info_length = sense_buffer_size;
1193 
1194 
1195 	vstor_packet->vm_srb.data_transfer_length =
1196 	request->payload->range.len;
1197 
1198 	vstor_packet->operation = VSTOR_OPERATION_EXECUTE_SRB;
1199 
1200 	if (request->payload->range.len) {
1201 
1202 		ret = vmbus_sendpacket_mpb_desc(outgoing_channel,
1203 				request->payload, request->payload_sz,
1204 				vstor_packet,
1205 				(sizeof(struct vstor_packet) -
1206 				vmscsi_size_delta),
1207 				(unsigned long)request);
1208 	} else {
1209 		ret = vmbus_sendpacket(outgoing_channel, vstor_packet,
1210 			       (sizeof(struct vstor_packet) -
1211 				vmscsi_size_delta),
1212 			       (unsigned long)request,
1213 			       VM_PKT_DATA_INBAND,
1214 			       VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
1215 	}
1216 
1217 	if (ret != 0)
1218 		return ret;
1219 
1220 	atomic_inc(&stor_device->num_outstanding_req);
1221 
1222 	return ret;
1223 }
1224 
storvsc_device_configure(struct scsi_device * sdevice)1225 static int storvsc_device_configure(struct scsi_device *sdevice)
1226 {
1227 
1228 	blk_queue_max_segment_size(sdevice->request_queue, PAGE_SIZE);
1229 
1230 	blk_queue_bounce_limit(sdevice->request_queue, BLK_BOUNCE_ANY);
1231 
1232 	blk_queue_rq_timeout(sdevice->request_queue, (storvsc_timeout * HZ));
1233 
1234 	/* Ensure there are no gaps in presented sgls */
1235 	blk_queue_virt_boundary(sdevice->request_queue, PAGE_SIZE - 1);
1236 
1237 	sdevice->no_write_same = 1;
1238 
1239 	/*
1240 	 * Add blist flags to permit the reading of the VPD pages even when
1241 	 * the target may claim SPC-2 compliance. MSFT targets currently
1242 	 * claim SPC-2 compliance while they implement post SPC-2 features.
1243 	 * With this patch we can correctly handle WRITE_SAME_16 issues.
1244 	 */
1245 	sdevice->sdev_bflags |= msft_blist_flags;
1246 
1247 	/*
1248 	 * If the host is WIN8 or WIN8 R2, claim conformance to SPC-3
1249 	 * if the device is a MSFT virtual device.  If the host is
1250 	 * WIN10 or newer, allow write_same.
1251 	 */
1252 	if (!strncmp(sdevice->vendor, "Msft", 4)) {
1253 		switch (vmstor_proto_version) {
1254 		case VMSTOR_PROTO_VERSION_WIN8:
1255 		case VMSTOR_PROTO_VERSION_WIN8_1:
1256 			sdevice->scsi_level = SCSI_SPC_3;
1257 			break;
1258 		}
1259 
1260 		if (vmstor_proto_version >= VMSTOR_PROTO_VERSION_WIN10)
1261 			sdevice->no_write_same = 0;
1262 	}
1263 
1264 	return 0;
1265 }
1266 
storvsc_get_chs(struct scsi_device * sdev,struct block_device * bdev,sector_t capacity,int * info)1267 static int storvsc_get_chs(struct scsi_device *sdev, struct block_device * bdev,
1268 			   sector_t capacity, int *info)
1269 {
1270 	sector_t nsect = capacity;
1271 	sector_t cylinders = nsect;
1272 	int heads, sectors_pt;
1273 
1274 	/*
1275 	 * We are making up these values; let us keep it simple.
1276 	 */
1277 	heads = 0xff;
1278 	sectors_pt = 0x3f;      /* Sectors per track */
1279 	sector_div(cylinders, heads * sectors_pt);
1280 	if ((sector_t)(cylinders + 1) * heads * sectors_pt < nsect)
1281 		cylinders = 0xffff;
1282 
1283 	info[0] = heads;
1284 	info[1] = sectors_pt;
1285 	info[2] = (int)cylinders;
1286 
1287 	return 0;
1288 }
1289 
storvsc_host_reset_handler(struct scsi_cmnd * scmnd)1290 static int storvsc_host_reset_handler(struct scsi_cmnd *scmnd)
1291 {
1292 	struct hv_host_device *host_dev = shost_priv(scmnd->device->host);
1293 	struct hv_device *device = host_dev->dev;
1294 
1295 	struct storvsc_device *stor_device;
1296 	struct storvsc_cmd_request *request;
1297 	struct vstor_packet *vstor_packet;
1298 	int ret, t;
1299 
1300 
1301 	stor_device = get_out_stor_device(device);
1302 	if (!stor_device)
1303 		return FAILED;
1304 
1305 	request = &stor_device->reset_request;
1306 	vstor_packet = &request->vstor_packet;
1307 
1308 	init_completion(&request->wait_event);
1309 
1310 	vstor_packet->operation = VSTOR_OPERATION_RESET_BUS;
1311 	vstor_packet->flags = REQUEST_COMPLETION_FLAG;
1312 	vstor_packet->vm_srb.path_id = stor_device->path_id;
1313 
1314 	ret = vmbus_sendpacket(device->channel, vstor_packet,
1315 			       (sizeof(struct vstor_packet) -
1316 				vmscsi_size_delta),
1317 			       (unsigned long)&stor_device->reset_request,
1318 			       VM_PKT_DATA_INBAND,
1319 			       VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
1320 	if (ret != 0)
1321 		return FAILED;
1322 
1323 	t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
1324 	if (t == 0)
1325 		return TIMEOUT_ERROR;
1326 
1327 
1328 	/*
1329 	 * At this point, all outstanding requests in the adapter
1330 	 * should have been flushed out and return to us
1331 	 * There is a potential race here where the host may be in
1332 	 * the process of responding when we return from here.
1333 	 * Just wait for all in-transit packets to be accounted for
1334 	 * before we return from here.
1335 	 */
1336 	storvsc_wait_to_drain(stor_device);
1337 
1338 	return SUCCESS;
1339 }
1340 
1341 /*
1342  * The host guarantees to respond to each command, although I/O latencies might
1343  * be unbounded on Azure.  Reset the timer unconditionally to give the host a
1344  * chance to perform EH.
1345  */
storvsc_eh_timed_out(struct scsi_cmnd * scmnd)1346 static enum blk_eh_timer_return storvsc_eh_timed_out(struct scsi_cmnd *scmnd)
1347 {
1348 	return BLK_EH_RESET_TIMER;
1349 }
1350 
storvsc_scsi_cmd_ok(struct scsi_cmnd * scmnd)1351 static bool storvsc_scsi_cmd_ok(struct scsi_cmnd *scmnd)
1352 {
1353 	bool allowed = true;
1354 	u8 scsi_op = scmnd->cmnd[0];
1355 
1356 	switch (scsi_op) {
1357 	/* the host does not handle WRITE_SAME, log accident usage */
1358 	case WRITE_SAME:
1359 	/*
1360 	 * smartd sends this command and the host does not handle
1361 	 * this. So, don't send it.
1362 	 */
1363 	case SET_WINDOW:
1364 		scmnd->result = ILLEGAL_REQUEST << 16;
1365 		allowed = false;
1366 		break;
1367 	default:
1368 		break;
1369 	}
1370 	return allowed;
1371 }
1372 
storvsc_queuecommand(struct Scsi_Host * host,struct scsi_cmnd * scmnd)1373 static int storvsc_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *scmnd)
1374 {
1375 	int ret;
1376 	struct hv_host_device *host_dev = shost_priv(host);
1377 	struct hv_device *dev = host_dev->dev;
1378 	struct storvsc_cmd_request *cmd_request = scsi_cmd_priv(scmnd);
1379 	int i;
1380 	struct scatterlist *sgl;
1381 	unsigned int sg_count = 0;
1382 	struct vmscsi_request *vm_srb;
1383 	struct scatterlist *cur_sgl;
1384 	struct vmbus_packet_mpb_array  *payload;
1385 	u32 payload_sz;
1386 	u32 length;
1387 
1388 	if (vmstor_proto_version <= VMSTOR_PROTO_VERSION_WIN8) {
1389 		/*
1390 		 * On legacy hosts filter unimplemented commands.
1391 		 * Future hosts are expected to correctly handle
1392 		 * unsupported commands. Furthermore, it is
1393 		 * possible that some of the currently
1394 		 * unsupported commands maybe supported in
1395 		 * future versions of the host.
1396 		 */
1397 		if (!storvsc_scsi_cmd_ok(scmnd)) {
1398 			scmnd->scsi_done(scmnd);
1399 			return 0;
1400 		}
1401 	}
1402 
1403 	/* Setup the cmd request */
1404 	cmd_request->cmd = scmnd;
1405 
1406 	vm_srb = &cmd_request->vstor_packet.vm_srb;
1407 	vm_srb->win8_extension.time_out_value = 60;
1408 
1409 	vm_srb->win8_extension.srb_flags |=
1410 		SRB_FLAGS_DISABLE_SYNCH_TRANSFER;
1411 
1412 	/* Build the SRB */
1413 	switch (scmnd->sc_data_direction) {
1414 	case DMA_TO_DEVICE:
1415 		vm_srb->data_in = WRITE_TYPE;
1416 		vm_srb->win8_extension.srb_flags |= SRB_FLAGS_DATA_OUT;
1417 		break;
1418 	case DMA_FROM_DEVICE:
1419 		vm_srb->data_in = READ_TYPE;
1420 		vm_srb->win8_extension.srb_flags |= SRB_FLAGS_DATA_IN;
1421 		break;
1422 	case DMA_NONE:
1423 		vm_srb->data_in = UNKNOWN_TYPE;
1424 		vm_srb->win8_extension.srb_flags |= SRB_FLAGS_NO_DATA_TRANSFER;
1425 		break;
1426 	default:
1427 		/*
1428 		 * This is DMA_BIDIRECTIONAL or something else we are never
1429 		 * supposed to see here.
1430 		 */
1431 		WARN(1, "Unexpected data direction: %d\n",
1432 		     scmnd->sc_data_direction);
1433 		return -EINVAL;
1434 	}
1435 
1436 
1437 	vm_srb->port_number = host_dev->port;
1438 	vm_srb->path_id = scmnd->device->channel;
1439 	vm_srb->target_id = scmnd->device->id;
1440 	vm_srb->lun = scmnd->device->lun;
1441 
1442 	vm_srb->cdb_length = scmnd->cmd_len;
1443 
1444 	memcpy(vm_srb->cdb, scmnd->cmnd, vm_srb->cdb_length);
1445 
1446 	sgl = (struct scatterlist *)scsi_sglist(scmnd);
1447 	sg_count = scsi_sg_count(scmnd);
1448 
1449 	length = scsi_bufflen(scmnd);
1450 	payload = (struct vmbus_packet_mpb_array *)&cmd_request->mpb;
1451 	payload_sz = sizeof(cmd_request->mpb);
1452 
1453 	if (sg_count) {
1454 		if (sg_count > MAX_PAGE_BUFFER_COUNT) {
1455 
1456 			payload_sz = (sg_count * sizeof(void *) +
1457 				      sizeof(struct vmbus_packet_mpb_array));
1458 			payload = kmalloc(payload_sz, GFP_ATOMIC);
1459 			if (!payload)
1460 				return SCSI_MLQUEUE_DEVICE_BUSY;
1461 		}
1462 
1463 		payload->range.len = length;
1464 		payload->range.offset = sgl[0].offset;
1465 
1466 		cur_sgl = sgl;
1467 		for (i = 0; i < sg_count; i++) {
1468 			payload->range.pfn_array[i] =
1469 				page_to_pfn(sg_page((cur_sgl)));
1470 			cur_sgl = sg_next(cur_sgl);
1471 		}
1472 
1473 	} else if (scsi_sglist(scmnd)) {
1474 		payload->range.len = length;
1475 		payload->range.offset =
1476 			virt_to_phys(scsi_sglist(scmnd)) & (PAGE_SIZE-1);
1477 		payload->range.pfn_array[0] =
1478 			virt_to_phys(scsi_sglist(scmnd)) >> PAGE_SHIFT;
1479 	}
1480 
1481 	cmd_request->payload = payload;
1482 	cmd_request->payload_sz = payload_sz;
1483 
1484 	/* Invokes the vsc to start an IO */
1485 	ret = storvsc_do_io(dev, cmd_request);
1486 
1487 	if (ret == -EAGAIN) {
1488 		/* no more space */
1489 		return SCSI_MLQUEUE_DEVICE_BUSY;
1490 	}
1491 
1492 	return 0;
1493 }
1494 
1495 static struct scsi_host_template scsi_driver = {
1496 	.module	=		THIS_MODULE,
1497 	.name =			"storvsc_host_t",
1498 	.cmd_size =             sizeof(struct storvsc_cmd_request),
1499 	.bios_param =		storvsc_get_chs,
1500 	.queuecommand =		storvsc_queuecommand,
1501 	.eh_host_reset_handler =	storvsc_host_reset_handler,
1502 	.proc_name =		"storvsc_host",
1503 	.eh_timed_out =		storvsc_eh_timed_out,
1504 	.slave_configure =	storvsc_device_configure,
1505 	.cmd_per_lun =		255,
1506 	.this_id =		-1,
1507 	.use_clustering =	ENABLE_CLUSTERING,
1508 	/* Make sure we dont get a sg segment crosses a page boundary */
1509 	.dma_boundary =		PAGE_SIZE-1,
1510 	.no_write_same =	1,
1511 };
1512 
1513 enum {
1514 	SCSI_GUID,
1515 	IDE_GUID,
1516 	SFC_GUID,
1517 };
1518 
1519 static const struct hv_vmbus_device_id id_table[] = {
1520 	/* SCSI guid */
1521 	{ HV_SCSI_GUID,
1522 	  .driver_data = SCSI_GUID
1523 	},
1524 	/* IDE guid */
1525 	{ HV_IDE_GUID,
1526 	  .driver_data = IDE_GUID
1527 	},
1528 	/* Fibre Channel GUID */
1529 	{
1530 	  HV_SYNTHFC_GUID,
1531 	  .driver_data = SFC_GUID
1532 	},
1533 	{ },
1534 };
1535 
1536 MODULE_DEVICE_TABLE(vmbus, id_table);
1537 
storvsc_probe(struct hv_device * device,const struct hv_vmbus_device_id * dev_id)1538 static int storvsc_probe(struct hv_device *device,
1539 			const struct hv_vmbus_device_id *dev_id)
1540 {
1541 	int ret;
1542 	int num_cpus = num_online_cpus();
1543 	struct Scsi_Host *host;
1544 	struct hv_host_device *host_dev;
1545 	bool dev_is_ide = ((dev_id->driver_data == IDE_GUID) ? true : false);
1546 	int target = 0;
1547 	struct storvsc_device *stor_device;
1548 	int max_luns_per_target;
1549 	int max_targets;
1550 	int max_channels;
1551 	int max_sub_channels = 0;
1552 
1553 	/*
1554 	 * Based on the windows host we are running on,
1555 	 * set state to properly communicate with the host.
1556 	 */
1557 
1558 	if (vmbus_proto_version < VERSION_WIN8) {
1559 		max_luns_per_target = STORVSC_IDE_MAX_LUNS_PER_TARGET;
1560 		max_targets = STORVSC_IDE_MAX_TARGETS;
1561 		max_channels = STORVSC_IDE_MAX_CHANNELS;
1562 	} else {
1563 		max_luns_per_target = STORVSC_MAX_LUNS_PER_TARGET;
1564 		max_targets = STORVSC_MAX_TARGETS;
1565 		max_channels = STORVSC_MAX_CHANNELS;
1566 		/*
1567 		 * On Windows8 and above, we support sub-channels for storage.
1568 		 * The number of sub-channels offerred is based on the number of
1569 		 * VCPUs in the guest.
1570 		 */
1571 		max_sub_channels = (num_cpus / storvsc_vcpus_per_sub_channel);
1572 	}
1573 
1574 	scsi_driver.can_queue = (max_outstanding_req_per_channel *
1575 				 (max_sub_channels + 1));
1576 
1577 	host = scsi_host_alloc(&scsi_driver,
1578 			       sizeof(struct hv_host_device));
1579 	if (!host)
1580 		return -ENOMEM;
1581 
1582 	host_dev = shost_priv(host);
1583 	memset(host_dev, 0, sizeof(struct hv_host_device));
1584 
1585 	host_dev->port = host->host_no;
1586 	host_dev->dev = device;
1587 
1588 
1589 	stor_device = kzalloc(sizeof(struct storvsc_device), GFP_KERNEL);
1590 	if (!stor_device) {
1591 		ret = -ENOMEM;
1592 		goto err_out0;
1593 	}
1594 
1595 	stor_device->destroy = false;
1596 	stor_device->open_sub_channel = false;
1597 	init_waitqueue_head(&stor_device->waiting_to_drain);
1598 	stor_device->device = device;
1599 	stor_device->host = host;
1600 	hv_set_drvdata(device, stor_device);
1601 
1602 	stor_device->port_number = host->host_no;
1603 	ret = storvsc_connect_to_vsp(device, storvsc_ringbuffer_size);
1604 	if (ret)
1605 		goto err_out1;
1606 
1607 	host_dev->path = stor_device->path_id;
1608 	host_dev->target = stor_device->target_id;
1609 
1610 	switch (dev_id->driver_data) {
1611 	case SFC_GUID:
1612 		host->max_lun = STORVSC_FC_MAX_LUNS_PER_TARGET;
1613 		host->max_id = STORVSC_FC_MAX_TARGETS;
1614 		host->max_channel = STORVSC_FC_MAX_CHANNELS - 1;
1615 		break;
1616 
1617 	case SCSI_GUID:
1618 		host->max_lun = max_luns_per_target;
1619 		host->max_id = max_targets;
1620 		host->max_channel = max_channels - 1;
1621 		break;
1622 
1623 	default:
1624 		host->max_lun = STORVSC_IDE_MAX_LUNS_PER_TARGET;
1625 		host->max_id = STORVSC_IDE_MAX_TARGETS;
1626 		host->max_channel = STORVSC_IDE_MAX_CHANNELS - 1;
1627 		break;
1628 	}
1629 	/* max cmd length */
1630 	host->max_cmd_len = STORVSC_MAX_CMD_LEN;
1631 
1632 	/*
1633 	 * set the table size based on the info we got
1634 	 * from the host.
1635 	 */
1636 	host->sg_tablesize = (stor_device->max_transfer_bytes >> PAGE_SHIFT);
1637 
1638 	/* Register the HBA and start the scsi bus scan */
1639 	ret = scsi_add_host(host, &device->device);
1640 	if (ret != 0)
1641 		goto err_out2;
1642 
1643 	if (!dev_is_ide) {
1644 		scsi_scan_host(host);
1645 	} else {
1646 		target = (device->dev_instance.b[5] << 8 |
1647 			 device->dev_instance.b[4]);
1648 		ret = scsi_add_device(host, 0, target, 0);
1649 		if (ret) {
1650 			scsi_remove_host(host);
1651 			goto err_out2;
1652 		}
1653 	}
1654 	return 0;
1655 
1656 err_out2:
1657 	/*
1658 	 * Once we have connected with the host, we would need to
1659 	 * to invoke storvsc_dev_remove() to rollback this state and
1660 	 * this call also frees up the stor_device; hence the jump around
1661 	 * err_out1 label.
1662 	 */
1663 	storvsc_dev_remove(device);
1664 	goto err_out0;
1665 
1666 err_out1:
1667 	kfree(stor_device);
1668 
1669 err_out0:
1670 	scsi_host_put(host);
1671 	return ret;
1672 }
1673 
storvsc_remove(struct hv_device * dev)1674 static int storvsc_remove(struct hv_device *dev)
1675 {
1676 	struct storvsc_device *stor_device = hv_get_drvdata(dev);
1677 	struct Scsi_Host *host = stor_device->host;
1678 
1679 	scsi_remove_host(host);
1680 	storvsc_dev_remove(dev);
1681 	scsi_host_put(host);
1682 
1683 	return 0;
1684 }
1685 
1686 static struct hv_driver storvsc_drv = {
1687 	.name = KBUILD_MODNAME,
1688 	.id_table = id_table,
1689 	.probe = storvsc_probe,
1690 	.remove = storvsc_remove,
1691 };
1692 
storvsc_drv_init(void)1693 static int __init storvsc_drv_init(void)
1694 {
1695 
1696 	/*
1697 	 * Divide the ring buffer data size (which is 1 page less
1698 	 * than the ring buffer size since that page is reserved for
1699 	 * the ring buffer indices) by the max request size (which is
1700 	 * vmbus_channel_packet_multipage_buffer + struct vstor_packet + u64)
1701 	 */
1702 	max_outstanding_req_per_channel =
1703 		((storvsc_ringbuffer_size - PAGE_SIZE) /
1704 		ALIGN(MAX_MULTIPAGE_BUFFER_PACKET +
1705 		sizeof(struct vstor_packet) + sizeof(u64) -
1706 		vmscsi_size_delta,
1707 		sizeof(u64)));
1708 
1709 	return vmbus_driver_register(&storvsc_drv);
1710 }
1711 
storvsc_drv_exit(void)1712 static void __exit storvsc_drv_exit(void)
1713 {
1714 	vmbus_driver_unregister(&storvsc_drv);
1715 }
1716 
1717 MODULE_LICENSE("GPL");
1718 MODULE_DESCRIPTION("Microsoft Hyper-V virtual storage driver");
1719 module_init(storvsc_drv_init);
1720 module_exit(storvsc_drv_exit);
1721