Merge branch 'for-next-3.17' of git://git.samba.org/sfrench/cifs-2.6
[linux/fpc-iii.git] / drivers / scsi / storvsc_drv.c
blobfecac5d03fddd141d785455b556b84eec0b9dc0f
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/mempool.h>
36 #include <linux/blkdev.h>
37 #include <scsi/scsi.h>
38 #include <scsi/scsi_cmnd.h>
39 #include <scsi/scsi_host.h>
40 #include <scsi/scsi_device.h>
41 #include <scsi/scsi_tcq.h>
42 #include <scsi/scsi_eh.h>
43 #include <scsi/scsi_devinfo.h>
44 #include <scsi/scsi_dbg.h>
47 * All wire protocol details (storage protocol between the guest and the host)
48 * are consolidated here.
50 * Begin protocol definitions.
54 * Version history:
55 * V1 Beta: 0.1
56 * V1 RC < 2008/1/31: 1.0
57 * V1 RC > 2008/1/31: 2.0
58 * Win7: 4.2
59 * Win8: 5.1
63 #define VMSTOR_WIN7_MAJOR 4
64 #define VMSTOR_WIN7_MINOR 2
66 #define VMSTOR_WIN8_MAJOR 5
67 #define VMSTOR_WIN8_MINOR 1
70 /* Packet structure describing virtual storage requests. */
71 enum vstor_packet_operation {
72 VSTOR_OPERATION_COMPLETE_IO = 1,
73 VSTOR_OPERATION_REMOVE_DEVICE = 2,
74 VSTOR_OPERATION_EXECUTE_SRB = 3,
75 VSTOR_OPERATION_RESET_LUN = 4,
76 VSTOR_OPERATION_RESET_ADAPTER = 5,
77 VSTOR_OPERATION_RESET_BUS = 6,
78 VSTOR_OPERATION_BEGIN_INITIALIZATION = 7,
79 VSTOR_OPERATION_END_INITIALIZATION = 8,
80 VSTOR_OPERATION_QUERY_PROTOCOL_VERSION = 9,
81 VSTOR_OPERATION_QUERY_PROPERTIES = 10,
82 VSTOR_OPERATION_ENUMERATE_BUS = 11,
83 VSTOR_OPERATION_FCHBA_DATA = 12,
84 VSTOR_OPERATION_CREATE_SUB_CHANNELS = 13,
85 VSTOR_OPERATION_MAXIMUM = 13
89 * WWN packet for Fibre Channel HBA
92 struct hv_fc_wwn_packet {
93 bool primary_active;
94 u8 reserved1;
95 u8 reserved2;
96 u8 primary_port_wwn[8];
97 u8 primary_node_wwn[8];
98 u8 secondary_port_wwn[8];
99 u8 secondary_node_wwn[8];
105 * SRB Flag Bits
108 #define SRB_FLAGS_QUEUE_ACTION_ENABLE 0x00000002
109 #define SRB_FLAGS_DISABLE_DISCONNECT 0x00000004
110 #define SRB_FLAGS_DISABLE_SYNCH_TRANSFER 0x00000008
111 #define SRB_FLAGS_BYPASS_FROZEN_QUEUE 0x00000010
112 #define SRB_FLAGS_DISABLE_AUTOSENSE 0x00000020
113 #define SRB_FLAGS_DATA_IN 0x00000040
114 #define SRB_FLAGS_DATA_OUT 0x00000080
115 #define SRB_FLAGS_NO_DATA_TRANSFER 0x00000000
116 #define SRB_FLAGS_UNSPECIFIED_DIRECTION (SRB_FLAGS_DATA_IN | SRB_FLAGS_DATA_OUT)
117 #define SRB_FLAGS_NO_QUEUE_FREEZE 0x00000100
118 #define SRB_FLAGS_ADAPTER_CACHE_ENABLE 0x00000200
119 #define SRB_FLAGS_FREE_SENSE_BUFFER 0x00000400
122 * This flag indicates the request is part of the workflow for processing a D3.
124 #define SRB_FLAGS_D3_PROCESSING 0x00000800
125 #define SRB_FLAGS_IS_ACTIVE 0x00010000
126 #define SRB_FLAGS_ALLOCATED_FROM_ZONE 0x00020000
127 #define SRB_FLAGS_SGLIST_FROM_POOL 0x00040000
128 #define SRB_FLAGS_BYPASS_LOCKED_QUEUE 0x00080000
129 #define SRB_FLAGS_NO_KEEP_AWAKE 0x00100000
130 #define SRB_FLAGS_PORT_DRIVER_ALLOCSENSE 0x00200000
131 #define SRB_FLAGS_PORT_DRIVER_SENSEHASPORT 0x00400000
132 #define SRB_FLAGS_DONT_START_NEXT_PACKET 0x00800000
133 #define SRB_FLAGS_PORT_DRIVER_RESERVED 0x0F000000
134 #define SRB_FLAGS_CLASS_DRIVER_RESERVED 0xF0000000
138 * Platform neutral description of a scsi request -
139 * this remains the same across the write regardless of 32/64 bit
140 * note: it's patterned off the SCSI_PASS_THROUGH structure
142 #define STORVSC_MAX_CMD_LEN 0x10
144 #define POST_WIN7_STORVSC_SENSE_BUFFER_SIZE 0x14
145 #define PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE 0x12
147 #define STORVSC_SENSE_BUFFER_SIZE 0x14
148 #define STORVSC_MAX_BUF_LEN_WITH_PADDING 0x14
151 * Sense buffer size changed in win8; have a run-time
152 * variable to track the size we should use.
154 static int sense_buffer_size;
157 * The size of the vmscsi_request has changed in win8. The
158 * additional size is because of new elements added to the
159 * structure. These elements are valid only when we are talking
160 * to a win8 host.
161 * Track the correction to size we need to apply.
164 static int vmscsi_size_delta;
165 static int vmstor_current_major;
166 static int vmstor_current_minor;
168 struct vmscsi_win8_extension {
170 * The following were added in Windows 8
172 u16 reserve;
173 u8 queue_tag;
174 u8 queue_action;
175 u32 srb_flags;
176 u32 time_out_value;
177 u32 queue_sort_ey;
178 } __packed;
180 struct vmscsi_request {
181 u16 length;
182 u8 srb_status;
183 u8 scsi_status;
185 u8 port_number;
186 u8 path_id;
187 u8 target_id;
188 u8 lun;
190 u8 cdb_length;
191 u8 sense_info_length;
192 u8 data_in;
193 u8 reserved;
195 u32 data_transfer_length;
197 union {
198 u8 cdb[STORVSC_MAX_CMD_LEN];
199 u8 sense_data[STORVSC_SENSE_BUFFER_SIZE];
200 u8 reserved_array[STORVSC_MAX_BUF_LEN_WITH_PADDING];
203 * The following was added in win8.
205 struct vmscsi_win8_extension win8_extension;
207 } __attribute((packed));
211 * This structure is sent during the intialization phase to get the different
212 * properties of the channel.
215 #define STORAGE_CHANNEL_SUPPORTS_MULTI_CHANNEL 0x1
217 struct vmstorage_channel_properties {
218 u32 reserved;
219 u16 max_channel_cnt;
220 u16 reserved1;
222 u32 flags;
223 u32 max_transfer_bytes;
225 u64 reserved2;
226 } __packed;
228 /* This structure is sent during the storage protocol negotiations. */
229 struct vmstorage_protocol_version {
230 /* Major (MSW) and minor (LSW) version numbers. */
231 u16 major_minor;
234 * Revision number is auto-incremented whenever this file is changed
235 * (See FILL_VMSTOR_REVISION macro above). Mismatch does not
236 * definitely indicate incompatibility--but it does indicate mismatched
237 * builds.
238 * This is only used on the windows side. Just set it to 0.
240 u16 revision;
241 } __packed;
243 /* Channel Property Flags */
244 #define STORAGE_CHANNEL_REMOVABLE_FLAG 0x1
245 #define STORAGE_CHANNEL_EMULATED_IDE_FLAG 0x2
247 struct vstor_packet {
248 /* Requested operation type */
249 enum vstor_packet_operation operation;
251 /* Flags - see below for values */
252 u32 flags;
254 /* Status of the request returned from the server side. */
255 u32 status;
257 /* Data payload area */
258 union {
260 * Structure used to forward SCSI commands from the
261 * client to the server.
263 struct vmscsi_request vm_srb;
265 /* Structure used to query channel properties. */
266 struct vmstorage_channel_properties storage_channel_properties;
268 /* Used during version negotiations. */
269 struct vmstorage_protocol_version version;
271 /* Fibre channel address packet */
272 struct hv_fc_wwn_packet wwn_packet;
274 /* Number of sub-channels to create */
275 u16 sub_channel_count;
277 /* This will be the maximum of the union members */
278 u8 buffer[0x34];
280 } __packed;
283 * Packet Flags:
285 * This flag indicates that the server should send back a completion for this
286 * packet.
289 #define REQUEST_COMPLETION_FLAG 0x1
291 /* Matches Windows-end */
292 enum storvsc_request_type {
293 WRITE_TYPE = 0,
294 READ_TYPE,
295 UNKNOWN_TYPE,
299 * SRB status codes and masks; a subset of the codes used here.
302 #define SRB_STATUS_AUTOSENSE_VALID 0x80
303 #define SRB_STATUS_INVALID_LUN 0x20
304 #define SRB_STATUS_SUCCESS 0x01
305 #define SRB_STATUS_ABORTED 0x02
306 #define SRB_STATUS_ERROR 0x04
309 * This is the end of Protocol specific defines.
314 * We setup a mempool to allocate request structures for this driver
315 * on a per-lun basis. The following define specifies the number of
316 * elements in the pool.
319 #define STORVSC_MIN_BUF_NR 64
320 static int storvsc_ringbuffer_size = (20 * PAGE_SIZE);
322 module_param(storvsc_ringbuffer_size, int, S_IRUGO);
323 MODULE_PARM_DESC(storvsc_ringbuffer_size, "Ring buffer size (bytes)");
326 * Timeout in seconds for all devices managed by this driver.
328 static int storvsc_timeout = 180;
330 static int msft_blist_flags = BLIST_TRY_VPD_PAGES;
332 #define STORVSC_MAX_IO_REQUESTS 200
334 static void storvsc_on_channel_callback(void *context);
336 #define STORVSC_MAX_LUNS_PER_TARGET 255
337 #define STORVSC_MAX_TARGETS 2
338 #define STORVSC_MAX_CHANNELS 8
340 #define STORVSC_FC_MAX_LUNS_PER_TARGET 255
341 #define STORVSC_FC_MAX_TARGETS 128
342 #define STORVSC_FC_MAX_CHANNELS 8
344 #define STORVSC_IDE_MAX_LUNS_PER_TARGET 64
345 #define STORVSC_IDE_MAX_TARGETS 1
346 #define STORVSC_IDE_MAX_CHANNELS 1
348 struct storvsc_cmd_request {
349 struct list_head entry;
350 struct scsi_cmnd *cmd;
352 unsigned int bounce_sgl_count;
353 struct scatterlist *bounce_sgl;
355 struct hv_device *device;
357 /* Synchronize the request/response if needed */
358 struct completion wait_event;
360 unsigned char *sense_buffer;
361 struct hv_multipage_buffer data_buffer;
362 struct vstor_packet vstor_packet;
366 /* A storvsc device is a device object that contains a vmbus channel */
367 struct storvsc_device {
368 struct hv_device *device;
370 bool destroy;
371 bool drain_notify;
372 bool open_sub_channel;
373 atomic_t num_outstanding_req;
374 struct Scsi_Host *host;
376 wait_queue_head_t waiting_to_drain;
379 * Each unique Port/Path/Target represents 1 channel ie scsi
380 * controller. In reality, the pathid, targetid is always 0
381 * and the port is set by us
383 unsigned int port_number;
384 unsigned char path_id;
385 unsigned char target_id;
387 /* Used for vsc/vsp channel reset process */
388 struct storvsc_cmd_request init_request;
389 struct storvsc_cmd_request reset_request;
392 struct stor_mem_pools {
393 struct kmem_cache *request_pool;
394 mempool_t *request_mempool;
397 struct hv_host_device {
398 struct hv_device *dev;
399 unsigned int port;
400 unsigned char path;
401 unsigned char target;
404 struct storvsc_scan_work {
405 struct work_struct work;
406 struct Scsi_Host *host;
407 uint lun;
410 static void storvsc_device_scan(struct work_struct *work)
412 struct storvsc_scan_work *wrk;
413 uint lun;
414 struct scsi_device *sdev;
416 wrk = container_of(work, struct storvsc_scan_work, work);
417 lun = wrk->lun;
419 sdev = scsi_device_lookup(wrk->host, 0, 0, lun);
420 if (!sdev)
421 goto done;
422 scsi_rescan_device(&sdev->sdev_gendev);
423 scsi_device_put(sdev);
425 done:
426 kfree(wrk);
429 static void storvsc_bus_scan(struct work_struct *work)
431 struct storvsc_scan_work *wrk;
432 int id, order_id;
434 wrk = container_of(work, struct storvsc_scan_work, work);
435 for (id = 0; id < wrk->host->max_id; ++id) {
436 if (wrk->host->reverse_ordering)
437 order_id = wrk->host->max_id - id - 1;
438 else
439 order_id = id;
441 scsi_scan_target(&wrk->host->shost_gendev, 0,
442 order_id, SCAN_WILD_CARD, 1);
444 kfree(wrk);
447 static void storvsc_remove_lun(struct work_struct *work)
449 struct storvsc_scan_work *wrk;
450 struct scsi_device *sdev;
452 wrk = container_of(work, struct storvsc_scan_work, work);
453 if (!scsi_host_get(wrk->host))
454 goto done;
456 sdev = scsi_device_lookup(wrk->host, 0, 0, wrk->lun);
458 if (sdev) {
459 scsi_remove_device(sdev);
460 scsi_device_put(sdev);
462 scsi_host_put(wrk->host);
464 done:
465 kfree(wrk);
469 * Major/minor macros. Minor version is in LSB, meaning that earlier flat
470 * version numbers will be interpreted as "0.x" (i.e., 1 becomes 0.1).
473 static inline u16 storvsc_get_version(u8 major, u8 minor)
475 u16 version;
477 version = ((major << 8) | minor);
478 return version;
482 * We can get incoming messages from the host that are not in response to
483 * messages that we have sent out. An example of this would be messages
484 * received by the guest to notify dynamic addition/removal of LUNs. To
485 * deal with potential race conditions where the driver may be in the
486 * midst of being unloaded when we might receive an unsolicited message
487 * from the host, we have implemented a mechanism to gurantee sequential
488 * consistency:
490 * 1) Once the device is marked as being destroyed, we will fail all
491 * outgoing messages.
492 * 2) We permit incoming messages when the device is being destroyed,
493 * only to properly account for messages already sent out.
496 static inline struct storvsc_device *get_out_stor_device(
497 struct hv_device *device)
499 struct storvsc_device *stor_device;
501 stor_device = hv_get_drvdata(device);
503 if (stor_device && stor_device->destroy)
504 stor_device = NULL;
506 return stor_device;
510 static inline void storvsc_wait_to_drain(struct storvsc_device *dev)
512 dev->drain_notify = true;
513 wait_event(dev->waiting_to_drain,
514 atomic_read(&dev->num_outstanding_req) == 0);
515 dev->drain_notify = false;
518 static inline struct storvsc_device *get_in_stor_device(
519 struct hv_device *device)
521 struct storvsc_device *stor_device;
523 stor_device = hv_get_drvdata(device);
525 if (!stor_device)
526 goto get_in_err;
529 * If the device is being destroyed; allow incoming
530 * traffic only to cleanup outstanding requests.
533 if (stor_device->destroy &&
534 (atomic_read(&stor_device->num_outstanding_req) == 0))
535 stor_device = NULL;
537 get_in_err:
538 return stor_device;
542 static void destroy_bounce_buffer(struct scatterlist *sgl,
543 unsigned int sg_count)
545 int i;
546 struct page *page_buf;
548 for (i = 0; i < sg_count; i++) {
549 page_buf = sg_page((&sgl[i]));
550 if (page_buf != NULL)
551 __free_page(page_buf);
554 kfree(sgl);
557 static int do_bounce_buffer(struct scatterlist *sgl, unsigned int sg_count)
559 int i;
561 /* No need to check */
562 if (sg_count < 2)
563 return -1;
565 /* We have at least 2 sg entries */
566 for (i = 0; i < sg_count; i++) {
567 if (i == 0) {
568 /* make sure 1st one does not have hole */
569 if (sgl[i].offset + sgl[i].length != PAGE_SIZE)
570 return i;
571 } else if (i == sg_count - 1) {
572 /* make sure last one does not have hole */
573 if (sgl[i].offset != 0)
574 return i;
575 } else {
576 /* make sure no hole in the middle */
577 if (sgl[i].length != PAGE_SIZE || sgl[i].offset != 0)
578 return i;
581 return -1;
584 static struct scatterlist *create_bounce_buffer(struct scatterlist *sgl,
585 unsigned int sg_count,
586 unsigned int len,
587 int write)
589 int i;
590 int num_pages;
591 struct scatterlist *bounce_sgl;
592 struct page *page_buf;
593 unsigned int buf_len = ((write == WRITE_TYPE) ? 0 : PAGE_SIZE);
595 num_pages = ALIGN(len, PAGE_SIZE) >> PAGE_SHIFT;
597 bounce_sgl = kcalloc(num_pages, sizeof(struct scatterlist), GFP_ATOMIC);
598 if (!bounce_sgl)
599 return NULL;
601 sg_init_table(bounce_sgl, num_pages);
602 for (i = 0; i < num_pages; i++) {
603 page_buf = alloc_page(GFP_ATOMIC);
604 if (!page_buf)
605 goto cleanup;
606 sg_set_page(&bounce_sgl[i], page_buf, buf_len, 0);
609 return bounce_sgl;
611 cleanup:
612 destroy_bounce_buffer(bounce_sgl, num_pages);
613 return NULL;
616 /* Disgusting wrapper functions */
617 static inline unsigned long sg_kmap_atomic(struct scatterlist *sgl, int idx)
619 void *addr = kmap_atomic(sg_page(sgl + idx));
620 return (unsigned long)addr;
623 static inline void sg_kunmap_atomic(unsigned long addr)
625 kunmap_atomic((void *)addr);
629 /* Assume the original sgl has enough room */
630 static unsigned int copy_from_bounce_buffer(struct scatterlist *orig_sgl,
631 struct scatterlist *bounce_sgl,
632 unsigned int orig_sgl_count,
633 unsigned int bounce_sgl_count)
635 int i;
636 int j = 0;
637 unsigned long src, dest;
638 unsigned int srclen, destlen, copylen;
639 unsigned int total_copied = 0;
640 unsigned long bounce_addr = 0;
641 unsigned long dest_addr = 0;
642 unsigned long flags;
644 local_irq_save(flags);
646 for (i = 0; i < orig_sgl_count; i++) {
647 dest_addr = sg_kmap_atomic(orig_sgl,i) + orig_sgl[i].offset;
648 dest = dest_addr;
649 destlen = orig_sgl[i].length;
651 if (bounce_addr == 0)
652 bounce_addr = sg_kmap_atomic(bounce_sgl,j);
654 while (destlen) {
655 src = bounce_addr + bounce_sgl[j].offset;
656 srclen = bounce_sgl[j].length - bounce_sgl[j].offset;
658 copylen = min(srclen, destlen);
659 memcpy((void *)dest, (void *)src, copylen);
661 total_copied += copylen;
662 bounce_sgl[j].offset += copylen;
663 destlen -= copylen;
664 dest += copylen;
666 if (bounce_sgl[j].offset == bounce_sgl[j].length) {
667 /* full */
668 sg_kunmap_atomic(bounce_addr);
669 j++;
672 * It is possible that the number of elements
673 * in the bounce buffer may not be equal to
674 * the number of elements in the original
675 * scatter list. Handle this correctly.
678 if (j == bounce_sgl_count) {
680 * We are done; cleanup and return.
682 sg_kunmap_atomic(dest_addr - orig_sgl[i].offset);
683 local_irq_restore(flags);
684 return total_copied;
687 /* if we need to use another bounce buffer */
688 if (destlen || i != orig_sgl_count - 1)
689 bounce_addr = sg_kmap_atomic(bounce_sgl,j);
690 } else if (destlen == 0 && i == orig_sgl_count - 1) {
691 /* unmap the last bounce that is < PAGE_SIZE */
692 sg_kunmap_atomic(bounce_addr);
696 sg_kunmap_atomic(dest_addr - orig_sgl[i].offset);
699 local_irq_restore(flags);
701 return total_copied;
704 /* Assume the bounce_sgl has enough room ie using the create_bounce_buffer() */
705 static unsigned int copy_to_bounce_buffer(struct scatterlist *orig_sgl,
706 struct scatterlist *bounce_sgl,
707 unsigned int orig_sgl_count)
709 int i;
710 int j = 0;
711 unsigned long src, dest;
712 unsigned int srclen, destlen, copylen;
713 unsigned int total_copied = 0;
714 unsigned long bounce_addr = 0;
715 unsigned long src_addr = 0;
716 unsigned long flags;
718 local_irq_save(flags);
720 for (i = 0; i < orig_sgl_count; i++) {
721 src_addr = sg_kmap_atomic(orig_sgl,i) + orig_sgl[i].offset;
722 src = src_addr;
723 srclen = orig_sgl[i].length;
725 if (bounce_addr == 0)
726 bounce_addr = sg_kmap_atomic(bounce_sgl,j);
728 while (srclen) {
729 /* assume bounce offset always == 0 */
730 dest = bounce_addr + bounce_sgl[j].length;
731 destlen = PAGE_SIZE - bounce_sgl[j].length;
733 copylen = min(srclen, destlen);
734 memcpy((void *)dest, (void *)src, copylen);
736 total_copied += copylen;
737 bounce_sgl[j].length += copylen;
738 srclen -= copylen;
739 src += copylen;
741 if (bounce_sgl[j].length == PAGE_SIZE) {
742 /* full..move to next entry */
743 sg_kunmap_atomic(bounce_addr);
744 j++;
746 /* if we need to use another bounce buffer */
747 if (srclen || i != orig_sgl_count - 1)
748 bounce_addr = sg_kmap_atomic(bounce_sgl,j);
750 } else if (srclen == 0 && i == orig_sgl_count - 1) {
751 /* unmap the last bounce that is < PAGE_SIZE */
752 sg_kunmap_atomic(bounce_addr);
756 sg_kunmap_atomic(src_addr - orig_sgl[i].offset);
759 local_irq_restore(flags);
761 return total_copied;
764 static void handle_sc_creation(struct vmbus_channel *new_sc)
766 struct hv_device *device = new_sc->primary_channel->device_obj;
767 struct storvsc_device *stor_device;
768 struct vmstorage_channel_properties props;
770 stor_device = get_out_stor_device(device);
771 if (!stor_device)
772 return;
774 if (stor_device->open_sub_channel == false)
775 return;
777 memset(&props, 0, sizeof(struct vmstorage_channel_properties));
779 vmbus_open(new_sc,
780 storvsc_ringbuffer_size,
781 storvsc_ringbuffer_size,
782 (void *)&props,
783 sizeof(struct vmstorage_channel_properties),
784 storvsc_on_channel_callback, new_sc);
787 static void handle_multichannel_storage(struct hv_device *device, int max_chns)
789 struct storvsc_device *stor_device;
790 int num_cpus = num_online_cpus();
791 int num_sc;
792 struct storvsc_cmd_request *request;
793 struct vstor_packet *vstor_packet;
794 int ret, t;
796 num_sc = ((max_chns > num_cpus) ? num_cpus : max_chns);
797 stor_device = get_out_stor_device(device);
798 if (!stor_device)
799 return;
801 request = &stor_device->init_request;
802 vstor_packet = &request->vstor_packet;
804 stor_device->open_sub_channel = true;
806 * Establish a handler for dealing with subchannels.
808 vmbus_set_sc_create_callback(device->channel, handle_sc_creation);
811 * Check to see if sub-channels have already been created. This
812 * can happen when this driver is re-loaded after unloading.
815 if (vmbus_are_subchannels_present(device->channel))
816 return;
818 stor_device->open_sub_channel = false;
820 * Request the host to create sub-channels.
822 memset(request, 0, sizeof(struct storvsc_cmd_request));
823 init_completion(&request->wait_event);
824 vstor_packet->operation = VSTOR_OPERATION_CREATE_SUB_CHANNELS;
825 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
826 vstor_packet->sub_channel_count = num_sc;
828 ret = vmbus_sendpacket(device->channel, vstor_packet,
829 (sizeof(struct vstor_packet) -
830 vmscsi_size_delta),
831 (unsigned long)request,
832 VM_PKT_DATA_INBAND,
833 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
835 if (ret != 0)
836 return;
838 t = wait_for_completion_timeout(&request->wait_event, 10*HZ);
839 if (t == 0)
840 return;
842 if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
843 vstor_packet->status != 0)
844 return;
847 * Now that we created the sub-channels, invoke the check; this
848 * may trigger the callback.
850 stor_device->open_sub_channel = true;
851 vmbus_are_subchannels_present(device->channel);
854 static int storvsc_channel_init(struct hv_device *device)
856 struct storvsc_device *stor_device;
857 struct storvsc_cmd_request *request;
858 struct vstor_packet *vstor_packet;
859 int ret, t;
860 int max_chns;
861 bool process_sub_channels = false;
863 stor_device = get_out_stor_device(device);
864 if (!stor_device)
865 return -ENODEV;
867 request = &stor_device->init_request;
868 vstor_packet = &request->vstor_packet;
871 * Now, initiate the vsc/vsp initialization protocol on the open
872 * channel
874 memset(request, 0, sizeof(struct storvsc_cmd_request));
875 init_completion(&request->wait_event);
876 vstor_packet->operation = VSTOR_OPERATION_BEGIN_INITIALIZATION;
877 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
879 ret = vmbus_sendpacket(device->channel, vstor_packet,
880 (sizeof(struct vstor_packet) -
881 vmscsi_size_delta),
882 (unsigned long)request,
883 VM_PKT_DATA_INBAND,
884 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
885 if (ret != 0)
886 goto cleanup;
888 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
889 if (t == 0) {
890 ret = -ETIMEDOUT;
891 goto cleanup;
894 if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
895 vstor_packet->status != 0)
896 goto cleanup;
899 /* reuse the packet for version range supported */
900 memset(vstor_packet, 0, sizeof(struct vstor_packet));
901 vstor_packet->operation = VSTOR_OPERATION_QUERY_PROTOCOL_VERSION;
902 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
904 vstor_packet->version.major_minor =
905 storvsc_get_version(vmstor_current_major, vmstor_current_minor);
908 * The revision number is only used in Windows; set it to 0.
910 vstor_packet->version.revision = 0;
912 ret = vmbus_sendpacket(device->channel, vstor_packet,
913 (sizeof(struct vstor_packet) -
914 vmscsi_size_delta),
915 (unsigned long)request,
916 VM_PKT_DATA_INBAND,
917 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
918 if (ret != 0)
919 goto cleanup;
921 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
922 if (t == 0) {
923 ret = -ETIMEDOUT;
924 goto cleanup;
927 if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
928 vstor_packet->status != 0)
929 goto cleanup;
932 memset(vstor_packet, 0, sizeof(struct vstor_packet));
933 vstor_packet->operation = VSTOR_OPERATION_QUERY_PROPERTIES;
934 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
936 ret = vmbus_sendpacket(device->channel, vstor_packet,
937 (sizeof(struct vstor_packet) -
938 vmscsi_size_delta),
939 (unsigned long)request,
940 VM_PKT_DATA_INBAND,
941 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
943 if (ret != 0)
944 goto cleanup;
946 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
947 if (t == 0) {
948 ret = -ETIMEDOUT;
949 goto cleanup;
952 if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
953 vstor_packet->status != 0)
954 goto cleanup;
957 * Check to see if multi-channel support is there.
958 * Hosts that implement protocol version of 5.1 and above
959 * support multi-channel.
961 max_chns = vstor_packet->storage_channel_properties.max_channel_cnt;
962 if ((vmbus_proto_version != VERSION_WIN7) &&
963 (vmbus_proto_version != VERSION_WS2008)) {
964 if (vstor_packet->storage_channel_properties.flags &
965 STORAGE_CHANNEL_SUPPORTS_MULTI_CHANNEL)
966 process_sub_channels = true;
969 memset(vstor_packet, 0, sizeof(struct vstor_packet));
970 vstor_packet->operation = VSTOR_OPERATION_END_INITIALIZATION;
971 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
973 ret = vmbus_sendpacket(device->channel, vstor_packet,
974 (sizeof(struct vstor_packet) -
975 vmscsi_size_delta),
976 (unsigned long)request,
977 VM_PKT_DATA_INBAND,
978 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
980 if (ret != 0)
981 goto cleanup;
983 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
984 if (t == 0) {
985 ret = -ETIMEDOUT;
986 goto cleanup;
989 if (vstor_packet->operation != VSTOR_OPERATION_COMPLETE_IO ||
990 vstor_packet->status != 0)
991 goto cleanup;
993 if (process_sub_channels)
994 handle_multichannel_storage(device, max_chns);
997 cleanup:
998 return ret;
1001 static void storvsc_handle_error(struct vmscsi_request *vm_srb,
1002 struct scsi_cmnd *scmnd,
1003 struct Scsi_Host *host,
1004 u8 asc, u8 ascq)
1006 struct storvsc_scan_work *wrk;
1007 void (*process_err_fn)(struct work_struct *work);
1008 bool do_work = false;
1010 switch (vm_srb->srb_status) {
1011 case SRB_STATUS_ERROR:
1013 * If there is an error; offline the device since all
1014 * error recovery strategies would have already been
1015 * deployed on the host side. However, if the command
1016 * were a pass-through command deal with it appropriately.
1018 switch (scmnd->cmnd[0]) {
1019 case ATA_16:
1020 case ATA_12:
1021 set_host_byte(scmnd, DID_PASSTHROUGH);
1022 break;
1024 * On Some Windows hosts TEST_UNIT_READY command can return
1025 * SRB_STATUS_ERROR, let the upper level code deal with it
1026 * based on the sense information.
1028 case TEST_UNIT_READY:
1029 break;
1030 default:
1031 set_host_byte(scmnd, DID_TARGET_FAILURE);
1033 break;
1034 case SRB_STATUS_INVALID_LUN:
1035 do_work = true;
1036 process_err_fn = storvsc_remove_lun;
1037 break;
1038 case (SRB_STATUS_ABORTED | SRB_STATUS_AUTOSENSE_VALID):
1039 if ((asc == 0x2a) && (ascq == 0x9)) {
1040 do_work = true;
1041 process_err_fn = storvsc_device_scan;
1043 * Retry the I/O that trigerred this.
1045 set_host_byte(scmnd, DID_REQUEUE);
1047 break;
1050 if (!do_work)
1051 return;
1054 * We need to schedule work to process this error; schedule it.
1056 wrk = kmalloc(sizeof(struct storvsc_scan_work), GFP_ATOMIC);
1057 if (!wrk) {
1058 set_host_byte(scmnd, DID_TARGET_FAILURE);
1059 return;
1062 wrk->host = host;
1063 wrk->lun = vm_srb->lun;
1064 INIT_WORK(&wrk->work, process_err_fn);
1065 schedule_work(&wrk->work);
1069 static void storvsc_command_completion(struct storvsc_cmd_request *cmd_request)
1071 struct scsi_cmnd *scmnd = cmd_request->cmd;
1072 struct hv_host_device *host_dev = shost_priv(scmnd->device->host);
1073 void (*scsi_done_fn)(struct scsi_cmnd *);
1074 struct scsi_sense_hdr sense_hdr;
1075 struct vmscsi_request *vm_srb;
1076 struct stor_mem_pools *memp = scmnd->device->hostdata;
1077 struct Scsi_Host *host;
1078 struct storvsc_device *stor_dev;
1079 struct hv_device *dev = host_dev->dev;
1081 stor_dev = get_in_stor_device(dev);
1082 host = stor_dev->host;
1084 vm_srb = &cmd_request->vstor_packet.vm_srb;
1085 if (cmd_request->bounce_sgl_count) {
1086 if (vm_srb->data_in == READ_TYPE)
1087 copy_from_bounce_buffer(scsi_sglist(scmnd),
1088 cmd_request->bounce_sgl,
1089 scsi_sg_count(scmnd),
1090 cmd_request->bounce_sgl_count);
1091 destroy_bounce_buffer(cmd_request->bounce_sgl,
1092 cmd_request->bounce_sgl_count);
1095 scmnd->result = vm_srb->scsi_status;
1097 if (scmnd->result) {
1098 if (scsi_normalize_sense(scmnd->sense_buffer,
1099 SCSI_SENSE_BUFFERSIZE, &sense_hdr))
1100 scsi_print_sense_hdr("storvsc", &sense_hdr);
1103 if (vm_srb->srb_status != SRB_STATUS_SUCCESS)
1104 storvsc_handle_error(vm_srb, scmnd, host, sense_hdr.asc,
1105 sense_hdr.ascq);
1107 scsi_set_resid(scmnd,
1108 cmd_request->data_buffer.len -
1109 vm_srb->data_transfer_length);
1111 scsi_done_fn = scmnd->scsi_done;
1113 scmnd->host_scribble = NULL;
1114 scmnd->scsi_done = NULL;
1116 scsi_done_fn(scmnd);
1118 mempool_free(cmd_request, memp->request_mempool);
1121 static void storvsc_on_io_completion(struct hv_device *device,
1122 struct vstor_packet *vstor_packet,
1123 struct storvsc_cmd_request *request)
1125 struct storvsc_device *stor_device;
1126 struct vstor_packet *stor_pkt;
1128 stor_device = hv_get_drvdata(device);
1129 stor_pkt = &request->vstor_packet;
1132 * The current SCSI handling on the host side does
1133 * not correctly handle:
1134 * INQUIRY command with page code parameter set to 0x80
1135 * MODE_SENSE command with cmd[2] == 0x1c
1137 * Setup srb and scsi status so this won't be fatal.
1138 * We do this so we can distinguish truly fatal failues
1139 * (srb status == 0x4) and off-line the device in that case.
1142 if ((stor_pkt->vm_srb.cdb[0] == INQUIRY) ||
1143 (stor_pkt->vm_srb.cdb[0] == MODE_SENSE)) {
1144 vstor_packet->vm_srb.scsi_status = 0;
1145 vstor_packet->vm_srb.srb_status = SRB_STATUS_SUCCESS;
1149 /* Copy over the status...etc */
1150 stor_pkt->vm_srb.scsi_status = vstor_packet->vm_srb.scsi_status;
1151 stor_pkt->vm_srb.srb_status = vstor_packet->vm_srb.srb_status;
1152 stor_pkt->vm_srb.sense_info_length =
1153 vstor_packet->vm_srb.sense_info_length;
1155 if (vstor_packet->vm_srb.scsi_status != 0 ||
1156 vstor_packet->vm_srb.srb_status != SRB_STATUS_SUCCESS){
1157 dev_warn(&device->device,
1158 "cmd 0x%x scsi status 0x%x srb status 0x%x\n",
1159 stor_pkt->vm_srb.cdb[0],
1160 vstor_packet->vm_srb.scsi_status,
1161 vstor_packet->vm_srb.srb_status);
1164 if ((vstor_packet->vm_srb.scsi_status & 0xFF) == 0x02) {
1165 /* CHECK_CONDITION */
1166 if (vstor_packet->vm_srb.srb_status &
1167 SRB_STATUS_AUTOSENSE_VALID) {
1168 /* autosense data available */
1169 dev_warn(&device->device,
1170 "stor pkt %p autosense data valid - len %d\n",
1171 request,
1172 vstor_packet->vm_srb.sense_info_length);
1174 memcpy(request->sense_buffer,
1175 vstor_packet->vm_srb.sense_data,
1176 vstor_packet->vm_srb.sense_info_length);
1181 stor_pkt->vm_srb.data_transfer_length =
1182 vstor_packet->vm_srb.data_transfer_length;
1184 storvsc_command_completion(request);
1186 if (atomic_dec_and_test(&stor_device->num_outstanding_req) &&
1187 stor_device->drain_notify)
1188 wake_up(&stor_device->waiting_to_drain);
1193 static void storvsc_on_receive(struct hv_device *device,
1194 struct vstor_packet *vstor_packet,
1195 struct storvsc_cmd_request *request)
1197 struct storvsc_scan_work *work;
1198 struct storvsc_device *stor_device;
1200 switch (vstor_packet->operation) {
1201 case VSTOR_OPERATION_COMPLETE_IO:
1202 storvsc_on_io_completion(device, vstor_packet, request);
1203 break;
1205 case VSTOR_OPERATION_REMOVE_DEVICE:
1206 case VSTOR_OPERATION_ENUMERATE_BUS:
1207 stor_device = get_in_stor_device(device);
1208 work = kmalloc(sizeof(struct storvsc_scan_work), GFP_ATOMIC);
1209 if (!work)
1210 return;
1212 INIT_WORK(&work->work, storvsc_bus_scan);
1213 work->host = stor_device->host;
1214 schedule_work(&work->work);
1215 break;
1217 default:
1218 break;
1222 static void storvsc_on_channel_callback(void *context)
1224 struct vmbus_channel *channel = (struct vmbus_channel *)context;
1225 struct hv_device *device;
1226 struct storvsc_device *stor_device;
1227 u32 bytes_recvd;
1228 u64 request_id;
1229 unsigned char packet[ALIGN(sizeof(struct vstor_packet), 8)];
1230 struct storvsc_cmd_request *request;
1231 int ret;
1233 if (channel->primary_channel != NULL)
1234 device = channel->primary_channel->device_obj;
1235 else
1236 device = channel->device_obj;
1238 stor_device = get_in_stor_device(device);
1239 if (!stor_device)
1240 return;
1242 do {
1243 ret = vmbus_recvpacket(channel, packet,
1244 ALIGN((sizeof(struct vstor_packet) -
1245 vmscsi_size_delta), 8),
1246 &bytes_recvd, &request_id);
1247 if (ret == 0 && bytes_recvd > 0) {
1249 request = (struct storvsc_cmd_request *)
1250 (unsigned long)request_id;
1252 if ((request == &stor_device->init_request) ||
1253 (request == &stor_device->reset_request)) {
1255 memcpy(&request->vstor_packet, packet,
1256 (sizeof(struct vstor_packet) -
1257 vmscsi_size_delta));
1258 complete(&request->wait_event);
1259 } else {
1260 storvsc_on_receive(device,
1261 (struct vstor_packet *)packet,
1262 request);
1264 } else {
1265 break;
1267 } while (1);
1269 return;
1272 static int storvsc_connect_to_vsp(struct hv_device *device, u32 ring_size)
1274 struct vmstorage_channel_properties props;
1275 int ret;
1277 memset(&props, 0, sizeof(struct vmstorage_channel_properties));
1279 ret = vmbus_open(device->channel,
1280 ring_size,
1281 ring_size,
1282 (void *)&props,
1283 sizeof(struct vmstorage_channel_properties),
1284 storvsc_on_channel_callback, device->channel);
1286 if (ret != 0)
1287 return ret;
1289 ret = storvsc_channel_init(device);
1291 return ret;
1294 static int storvsc_dev_remove(struct hv_device *device)
1296 struct storvsc_device *stor_device;
1297 unsigned long flags;
1299 stor_device = hv_get_drvdata(device);
1301 spin_lock_irqsave(&device->channel->inbound_lock, flags);
1302 stor_device->destroy = true;
1303 spin_unlock_irqrestore(&device->channel->inbound_lock, flags);
1306 * At this point, all outbound traffic should be disable. We
1307 * only allow inbound traffic (responses) to proceed so that
1308 * outstanding requests can be completed.
1311 storvsc_wait_to_drain(stor_device);
1314 * Since we have already drained, we don't need to busy wait
1315 * as was done in final_release_stor_device()
1316 * Note that we cannot set the ext pointer to NULL until
1317 * we have drained - to drain the outgoing packets, we need to
1318 * allow incoming packets.
1320 spin_lock_irqsave(&device->channel->inbound_lock, flags);
1321 hv_set_drvdata(device, NULL);
1322 spin_unlock_irqrestore(&device->channel->inbound_lock, flags);
1324 /* Close the channel */
1325 vmbus_close(device->channel);
1327 kfree(stor_device);
1328 return 0;
1331 static int storvsc_do_io(struct hv_device *device,
1332 struct storvsc_cmd_request *request)
1334 struct storvsc_device *stor_device;
1335 struct vstor_packet *vstor_packet;
1336 struct vmbus_channel *outgoing_channel;
1337 int ret = 0;
1339 vstor_packet = &request->vstor_packet;
1340 stor_device = get_out_stor_device(device);
1342 if (!stor_device)
1343 return -ENODEV;
1346 request->device = device;
1348 * Select an an appropriate channel to send the request out.
1351 outgoing_channel = vmbus_get_outgoing_channel(device->channel);
1354 vstor_packet->flags |= REQUEST_COMPLETION_FLAG;
1356 vstor_packet->vm_srb.length = (sizeof(struct vmscsi_request) -
1357 vmscsi_size_delta);
1360 vstor_packet->vm_srb.sense_info_length = sense_buffer_size;
1363 vstor_packet->vm_srb.data_transfer_length =
1364 request->data_buffer.len;
1366 vstor_packet->operation = VSTOR_OPERATION_EXECUTE_SRB;
1368 if (request->data_buffer.len) {
1369 ret = vmbus_sendpacket_multipagebuffer(outgoing_channel,
1370 &request->data_buffer,
1371 vstor_packet,
1372 (sizeof(struct vstor_packet) -
1373 vmscsi_size_delta),
1374 (unsigned long)request);
1375 } else {
1376 ret = vmbus_sendpacket(device->channel, vstor_packet,
1377 (sizeof(struct vstor_packet) -
1378 vmscsi_size_delta),
1379 (unsigned long)request,
1380 VM_PKT_DATA_INBAND,
1381 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
1384 if (ret != 0)
1385 return ret;
1387 atomic_inc(&stor_device->num_outstanding_req);
1389 return ret;
1392 static int storvsc_device_alloc(struct scsi_device *sdevice)
1394 struct stor_mem_pools *memp;
1395 int number = STORVSC_MIN_BUF_NR;
1397 memp = kzalloc(sizeof(struct stor_mem_pools), GFP_KERNEL);
1398 if (!memp)
1399 return -ENOMEM;
1401 memp->request_pool =
1402 kmem_cache_create(dev_name(&sdevice->sdev_dev),
1403 sizeof(struct storvsc_cmd_request), 0,
1404 SLAB_HWCACHE_ALIGN, NULL);
1406 if (!memp->request_pool)
1407 goto err0;
1409 memp->request_mempool = mempool_create(number, mempool_alloc_slab,
1410 mempool_free_slab,
1411 memp->request_pool);
1413 if (!memp->request_mempool)
1414 goto err1;
1416 sdevice->hostdata = memp;
1418 return 0;
1420 err1:
1421 kmem_cache_destroy(memp->request_pool);
1423 err0:
1424 kfree(memp);
1425 return -ENOMEM;
1428 static void storvsc_device_destroy(struct scsi_device *sdevice)
1430 struct stor_mem_pools *memp = sdevice->hostdata;
1432 if (!memp)
1433 return;
1435 mempool_destroy(memp->request_mempool);
1436 kmem_cache_destroy(memp->request_pool);
1437 kfree(memp);
1438 sdevice->hostdata = NULL;
1441 static int storvsc_device_configure(struct scsi_device *sdevice)
1443 scsi_adjust_queue_depth(sdevice, MSG_SIMPLE_TAG,
1444 STORVSC_MAX_IO_REQUESTS);
1446 blk_queue_max_segment_size(sdevice->request_queue, PAGE_SIZE);
1448 blk_queue_bounce_limit(sdevice->request_queue, BLK_BOUNCE_ANY);
1450 blk_queue_rq_timeout(sdevice->request_queue, (storvsc_timeout * HZ));
1452 sdevice->no_write_same = 1;
1455 * Add blist flags to permit the reading of the VPD pages even when
1456 * the target may claim SPC-2 compliance. MSFT targets currently
1457 * claim SPC-2 compliance while they implement post SPC-2 features.
1458 * With this patch we can correctly handle WRITE_SAME_16 issues.
1460 sdevice->sdev_bflags |= msft_blist_flags;
1462 return 0;
1465 static int storvsc_get_chs(struct scsi_device *sdev, struct block_device * bdev,
1466 sector_t capacity, int *info)
1468 sector_t nsect = capacity;
1469 sector_t cylinders = nsect;
1470 int heads, sectors_pt;
1473 * We are making up these values; let us keep it simple.
1475 heads = 0xff;
1476 sectors_pt = 0x3f; /* Sectors per track */
1477 sector_div(cylinders, heads * sectors_pt);
1478 if ((sector_t)(cylinders + 1) * heads * sectors_pt < nsect)
1479 cylinders = 0xffff;
1481 info[0] = heads;
1482 info[1] = sectors_pt;
1483 info[2] = (int)cylinders;
1485 return 0;
1488 static int storvsc_host_reset_handler(struct scsi_cmnd *scmnd)
1490 struct hv_host_device *host_dev = shost_priv(scmnd->device->host);
1491 struct hv_device *device = host_dev->dev;
1493 struct storvsc_device *stor_device;
1494 struct storvsc_cmd_request *request;
1495 struct vstor_packet *vstor_packet;
1496 int ret, t;
1499 stor_device = get_out_stor_device(device);
1500 if (!stor_device)
1501 return FAILED;
1503 request = &stor_device->reset_request;
1504 vstor_packet = &request->vstor_packet;
1506 init_completion(&request->wait_event);
1508 vstor_packet->operation = VSTOR_OPERATION_RESET_BUS;
1509 vstor_packet->flags = REQUEST_COMPLETION_FLAG;
1510 vstor_packet->vm_srb.path_id = stor_device->path_id;
1512 ret = vmbus_sendpacket(device->channel, vstor_packet,
1513 (sizeof(struct vstor_packet) -
1514 vmscsi_size_delta),
1515 (unsigned long)&stor_device->reset_request,
1516 VM_PKT_DATA_INBAND,
1517 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
1518 if (ret != 0)
1519 return FAILED;
1521 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
1522 if (t == 0)
1523 return TIMEOUT_ERROR;
1527 * At this point, all outstanding requests in the adapter
1528 * should have been flushed out and return to us
1529 * There is a potential race here where the host may be in
1530 * the process of responding when we return from here.
1531 * Just wait for all in-transit packets to be accounted for
1532 * before we return from here.
1534 storvsc_wait_to_drain(stor_device);
1536 return SUCCESS;
1540 * The host guarantees to respond to each command, although I/O latencies might
1541 * be unbounded on Azure. Reset the timer unconditionally to give the host a
1542 * chance to perform EH.
1544 static enum blk_eh_timer_return storvsc_eh_timed_out(struct scsi_cmnd *scmnd)
1546 return BLK_EH_RESET_TIMER;
1549 static bool storvsc_scsi_cmd_ok(struct scsi_cmnd *scmnd)
1551 bool allowed = true;
1552 u8 scsi_op = scmnd->cmnd[0];
1554 switch (scsi_op) {
1555 /* the host does not handle WRITE_SAME, log accident usage */
1556 case WRITE_SAME:
1558 * smartd sends this command and the host does not handle
1559 * this. So, don't send it.
1561 case SET_WINDOW:
1562 scmnd->result = ILLEGAL_REQUEST << 16;
1563 allowed = false;
1564 break;
1565 default:
1566 break;
1568 return allowed;
1571 static int storvsc_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *scmnd)
1573 int ret;
1574 struct hv_host_device *host_dev = shost_priv(host);
1575 struct hv_device *dev = host_dev->dev;
1576 struct storvsc_cmd_request *cmd_request;
1577 unsigned int request_size = 0;
1578 int i;
1579 struct scatterlist *sgl;
1580 unsigned int sg_count = 0;
1581 struct vmscsi_request *vm_srb;
1582 struct stor_mem_pools *memp = scmnd->device->hostdata;
1584 if (vmstor_current_major <= VMSTOR_WIN8_MAJOR) {
1586 * On legacy hosts filter unimplemented commands.
1587 * Future hosts are expected to correctly handle
1588 * unsupported commands. Furthermore, it is
1589 * possible that some of the currently
1590 * unsupported commands maybe supported in
1591 * future versions of the host.
1593 if (!storvsc_scsi_cmd_ok(scmnd)) {
1594 scmnd->scsi_done(scmnd);
1595 return 0;
1599 request_size = sizeof(struct storvsc_cmd_request);
1601 cmd_request = mempool_alloc(memp->request_mempool,
1602 GFP_ATOMIC);
1605 * We might be invoked in an interrupt context; hence
1606 * mempool_alloc() can fail.
1608 if (!cmd_request)
1609 return SCSI_MLQUEUE_DEVICE_BUSY;
1611 memset(cmd_request, 0, sizeof(struct storvsc_cmd_request));
1613 /* Setup the cmd request */
1614 cmd_request->cmd = scmnd;
1616 scmnd->host_scribble = (unsigned char *)cmd_request;
1618 vm_srb = &cmd_request->vstor_packet.vm_srb;
1619 vm_srb->win8_extension.time_out_value = 60;
1621 vm_srb->win8_extension.srb_flags |=
1622 (SRB_FLAGS_QUEUE_ACTION_ENABLE |
1623 SRB_FLAGS_DISABLE_SYNCH_TRANSFER);
1625 /* Build the SRB */
1626 switch (scmnd->sc_data_direction) {
1627 case DMA_TO_DEVICE:
1628 vm_srb->data_in = WRITE_TYPE;
1629 vm_srb->win8_extension.srb_flags |= SRB_FLAGS_DATA_OUT;
1630 break;
1631 case DMA_FROM_DEVICE:
1632 vm_srb->data_in = READ_TYPE;
1633 vm_srb->win8_extension.srb_flags |= SRB_FLAGS_DATA_IN;
1634 break;
1635 default:
1636 vm_srb->data_in = UNKNOWN_TYPE;
1637 vm_srb->win8_extension.srb_flags |= (SRB_FLAGS_DATA_IN |
1638 SRB_FLAGS_DATA_OUT);
1639 break;
1643 vm_srb->port_number = host_dev->port;
1644 vm_srb->path_id = scmnd->device->channel;
1645 vm_srb->target_id = scmnd->device->id;
1646 vm_srb->lun = scmnd->device->lun;
1648 vm_srb->cdb_length = scmnd->cmd_len;
1650 memcpy(vm_srb->cdb, scmnd->cmnd, vm_srb->cdb_length);
1652 cmd_request->sense_buffer = scmnd->sense_buffer;
1655 cmd_request->data_buffer.len = scsi_bufflen(scmnd);
1656 if (scsi_sg_count(scmnd)) {
1657 sgl = (struct scatterlist *)scsi_sglist(scmnd);
1658 sg_count = scsi_sg_count(scmnd);
1660 /* check if we need to bounce the sgl */
1661 if (do_bounce_buffer(sgl, scsi_sg_count(scmnd)) != -1) {
1662 cmd_request->bounce_sgl =
1663 create_bounce_buffer(sgl, scsi_sg_count(scmnd),
1664 scsi_bufflen(scmnd),
1665 vm_srb->data_in);
1666 if (!cmd_request->bounce_sgl) {
1667 ret = SCSI_MLQUEUE_HOST_BUSY;
1668 goto queue_error;
1671 cmd_request->bounce_sgl_count =
1672 ALIGN(scsi_bufflen(scmnd), PAGE_SIZE) >>
1673 PAGE_SHIFT;
1675 if (vm_srb->data_in == WRITE_TYPE)
1676 copy_to_bounce_buffer(sgl,
1677 cmd_request->bounce_sgl,
1678 scsi_sg_count(scmnd));
1680 sgl = cmd_request->bounce_sgl;
1681 sg_count = cmd_request->bounce_sgl_count;
1684 cmd_request->data_buffer.offset = sgl[0].offset;
1686 for (i = 0; i < sg_count; i++)
1687 cmd_request->data_buffer.pfn_array[i] =
1688 page_to_pfn(sg_page((&sgl[i])));
1690 } else if (scsi_sglist(scmnd)) {
1691 cmd_request->data_buffer.offset =
1692 virt_to_phys(scsi_sglist(scmnd)) & (PAGE_SIZE-1);
1693 cmd_request->data_buffer.pfn_array[0] =
1694 virt_to_phys(scsi_sglist(scmnd)) >> PAGE_SHIFT;
1697 /* Invokes the vsc to start an IO */
1698 ret = storvsc_do_io(dev, cmd_request);
1700 if (ret == -EAGAIN) {
1701 /* no more space */
1703 if (cmd_request->bounce_sgl_count) {
1704 destroy_bounce_buffer(cmd_request->bounce_sgl,
1705 cmd_request->bounce_sgl_count);
1707 ret = SCSI_MLQUEUE_DEVICE_BUSY;
1708 goto queue_error;
1712 return 0;
1714 queue_error:
1715 mempool_free(cmd_request, memp->request_mempool);
1716 scmnd->host_scribble = NULL;
1717 return ret;
1720 static struct scsi_host_template scsi_driver = {
1721 .module = THIS_MODULE,
1722 .name = "storvsc_host_t",
1723 .bios_param = storvsc_get_chs,
1724 .queuecommand = storvsc_queuecommand,
1725 .eh_host_reset_handler = storvsc_host_reset_handler,
1726 .eh_timed_out = storvsc_eh_timed_out,
1727 .slave_alloc = storvsc_device_alloc,
1728 .slave_destroy = storvsc_device_destroy,
1729 .slave_configure = storvsc_device_configure,
1730 .cmd_per_lun = 255,
1731 .can_queue = STORVSC_MAX_IO_REQUESTS*STORVSC_MAX_TARGETS,
1732 .this_id = -1,
1733 /* no use setting to 0 since ll_blk_rw reset it to 1 */
1734 /* currently 32 */
1735 .sg_tablesize = MAX_MULTIPAGE_BUFFER_COUNT,
1736 .use_clustering = DISABLE_CLUSTERING,
1737 /* Make sure we dont get a sg segment crosses a page boundary */
1738 .dma_boundary = PAGE_SIZE-1,
1739 .no_write_same = 1,
1742 enum {
1743 SCSI_GUID,
1744 IDE_GUID,
1745 SFC_GUID,
1748 static const struct hv_vmbus_device_id id_table[] = {
1749 /* SCSI guid */
1750 { HV_SCSI_GUID,
1751 .driver_data = SCSI_GUID
1753 /* IDE guid */
1754 { HV_IDE_GUID,
1755 .driver_data = IDE_GUID
1757 /* Fibre Channel GUID */
1759 HV_SYNTHFC_GUID,
1760 .driver_data = SFC_GUID
1762 { },
1765 MODULE_DEVICE_TABLE(vmbus, id_table);
1767 static int storvsc_probe(struct hv_device *device,
1768 const struct hv_vmbus_device_id *dev_id)
1770 int ret;
1771 struct Scsi_Host *host;
1772 struct hv_host_device *host_dev;
1773 bool dev_is_ide = ((dev_id->driver_data == IDE_GUID) ? true : false);
1774 int target = 0;
1775 struct storvsc_device *stor_device;
1778 * Based on the windows host we are running on,
1779 * set state to properly communicate with the host.
1782 switch (vmbus_proto_version) {
1783 case VERSION_WS2008:
1784 case VERSION_WIN7:
1785 sense_buffer_size = PRE_WIN8_STORVSC_SENSE_BUFFER_SIZE;
1786 vmscsi_size_delta = sizeof(struct vmscsi_win8_extension);
1787 vmstor_current_major = VMSTOR_WIN7_MAJOR;
1788 vmstor_current_minor = VMSTOR_WIN7_MINOR;
1789 break;
1790 default:
1791 sense_buffer_size = POST_WIN7_STORVSC_SENSE_BUFFER_SIZE;
1792 vmscsi_size_delta = 0;
1793 vmstor_current_major = VMSTOR_WIN8_MAJOR;
1794 vmstor_current_minor = VMSTOR_WIN8_MINOR;
1795 break;
1798 if (dev_id->driver_data == SFC_GUID)
1799 scsi_driver.can_queue = (STORVSC_MAX_IO_REQUESTS *
1800 STORVSC_FC_MAX_TARGETS);
1801 host = scsi_host_alloc(&scsi_driver,
1802 sizeof(struct hv_host_device));
1803 if (!host)
1804 return -ENOMEM;
1806 host_dev = shost_priv(host);
1807 memset(host_dev, 0, sizeof(struct hv_host_device));
1809 host_dev->port = host->host_no;
1810 host_dev->dev = device;
1813 stor_device = kzalloc(sizeof(struct storvsc_device), GFP_KERNEL);
1814 if (!stor_device) {
1815 ret = -ENOMEM;
1816 goto err_out0;
1819 stor_device->destroy = false;
1820 stor_device->open_sub_channel = false;
1821 init_waitqueue_head(&stor_device->waiting_to_drain);
1822 stor_device->device = device;
1823 stor_device->host = host;
1824 hv_set_drvdata(device, stor_device);
1826 stor_device->port_number = host->host_no;
1827 ret = storvsc_connect_to_vsp(device, storvsc_ringbuffer_size);
1828 if (ret)
1829 goto err_out1;
1831 host_dev->path = stor_device->path_id;
1832 host_dev->target = stor_device->target_id;
1834 switch (dev_id->driver_data) {
1835 case SFC_GUID:
1836 host->max_lun = STORVSC_FC_MAX_LUNS_PER_TARGET;
1837 host->max_id = STORVSC_FC_MAX_TARGETS;
1838 host->max_channel = STORVSC_FC_MAX_CHANNELS - 1;
1839 break;
1841 case SCSI_GUID:
1842 host->max_lun = STORVSC_MAX_LUNS_PER_TARGET;
1843 host->max_id = STORVSC_MAX_TARGETS;
1844 host->max_channel = STORVSC_MAX_CHANNELS - 1;
1845 break;
1847 default:
1848 host->max_lun = STORVSC_IDE_MAX_LUNS_PER_TARGET;
1849 host->max_id = STORVSC_IDE_MAX_TARGETS;
1850 host->max_channel = STORVSC_IDE_MAX_CHANNELS - 1;
1851 break;
1853 /* max cmd length */
1854 host->max_cmd_len = STORVSC_MAX_CMD_LEN;
1856 /* Register the HBA and start the scsi bus scan */
1857 ret = scsi_add_host(host, &device->device);
1858 if (ret != 0)
1859 goto err_out2;
1861 if (!dev_is_ide) {
1862 scsi_scan_host(host);
1863 } else {
1864 target = (device->dev_instance.b[5] << 8 |
1865 device->dev_instance.b[4]);
1866 ret = scsi_add_device(host, 0, target, 0);
1867 if (ret) {
1868 scsi_remove_host(host);
1869 goto err_out2;
1872 return 0;
1874 err_out2:
1876 * Once we have connected with the host, we would need to
1877 * to invoke storvsc_dev_remove() to rollback this state and
1878 * this call also frees up the stor_device; hence the jump around
1879 * err_out1 label.
1881 storvsc_dev_remove(device);
1882 goto err_out0;
1884 err_out1:
1885 kfree(stor_device);
1887 err_out0:
1888 scsi_host_put(host);
1889 return ret;
1892 static int storvsc_remove(struct hv_device *dev)
1894 struct storvsc_device *stor_device = hv_get_drvdata(dev);
1895 struct Scsi_Host *host = stor_device->host;
1897 scsi_remove_host(host);
1898 storvsc_dev_remove(dev);
1899 scsi_host_put(host);
1901 return 0;
1904 static struct hv_driver storvsc_drv = {
1905 .name = KBUILD_MODNAME,
1906 .id_table = id_table,
1907 .probe = storvsc_probe,
1908 .remove = storvsc_remove,
1911 static int __init storvsc_drv_init(void)
1913 u32 max_outstanding_req_per_channel;
1916 * Divide the ring buffer data size (which is 1 page less
1917 * than the ring buffer size since that page is reserved for
1918 * the ring buffer indices) by the max request size (which is
1919 * vmbus_channel_packet_multipage_buffer + struct vstor_packet + u64)
1921 max_outstanding_req_per_channel =
1922 ((storvsc_ringbuffer_size - PAGE_SIZE) /
1923 ALIGN(MAX_MULTIPAGE_BUFFER_PACKET +
1924 sizeof(struct vstor_packet) + sizeof(u64) -
1925 vmscsi_size_delta,
1926 sizeof(u64)));
1928 if (max_outstanding_req_per_channel <
1929 STORVSC_MAX_IO_REQUESTS)
1930 return -EINVAL;
1932 return vmbus_driver_register(&storvsc_drv);
1935 static void __exit storvsc_drv_exit(void)
1937 vmbus_driver_unregister(&storvsc_drv);
1940 MODULE_LICENSE("GPL");
1941 MODULE_DESCRIPTION("Microsoft Hyper-V virtual storage driver");
1942 module_init(storvsc_drv_init);
1943 module_exit(storvsc_drv_exit);