Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 1 | /* |
| 2 | * |
| 3 | * Copyright (c) 2009, Microsoft Corporation. |
| 4 | * |
| 5 | * This program is free software; you can redistribute it and/or modify it |
| 6 | * under the terms and conditions of the GNU General Public License, |
| 7 | * version 2, as published by the Free Software Foundation. |
| 8 | * |
| 9 | * This program is distributed in the hope it will be useful, but WITHOUT |
| 10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
| 12 | * more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License along with |
| 15 | * this program; if not, write to the Free Software Foundation, Inc., 59 Temple |
| 16 | * Place - Suite 330, Boston, MA 02111-1307 USA. |
| 17 | * |
| 18 | * Authors: |
| 19 | * Haiyang Zhang <haiyangz@microsoft.com> |
| 20 | * Hank Janssen <hjanssen@microsoft.com> |
| 21 | * |
| 22 | */ |
| 23 | |
| 24 | |
| 25 | #ifndef _STORVSC_API_H_ |
| 26 | #define _STORVSC_API_H_ |
| 27 | |
K. Y. Srinivasan | ced01b0 | 2011-03-28 09:33:29 -0700 | [diff] [blame] | 28 | #include <linux/kernel.h> |
K. Y. Srinivasan | 036bbed | 2011-03-23 10:50:20 -0700 | [diff] [blame] | 29 | #include "vstorage.h" |
Greg Kroah-Hartman | 447fc67 | 2010-05-05 22:43:02 -0700 | [diff] [blame] | 30 | #include "vmbus_api.h" |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 31 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 32 | /* Defines */ |
Hank Janssen | 15dd1c9 | 2010-08-05 19:30:31 +0000 | [diff] [blame] | 33 | #define STORVSC_RING_BUFFER_SIZE (20*PAGE_SIZE) |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 34 | #define BLKVSC_RING_BUFFER_SIZE (20*PAGE_SIZE) |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 35 | |
Hank Janssen | 15dd1c9 | 2010-08-05 19:30:31 +0000 | [diff] [blame] | 36 | #define STORVSC_MAX_IO_REQUESTS 128 |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 37 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 38 | /* |
| 39 | * In Hyper-V, each port/path/target maps to 1 scsi host adapter. In |
| 40 | * reality, the path/target is not used (ie always set to 0) so our |
| 41 | * scsi host adapter essentially has 1 bus with 1 target that contains |
| 42 | * up to 256 luns. |
| 43 | */ |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 44 | #define STORVSC_MAX_LUNS_PER_TARGET 64 |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 45 | #define STORVSC_MAX_TARGETS 1 |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 46 | #define STORVSC_MAX_CHANNELS 1 |
| 47 | |
Nicolas Palix | 0b3f683 | 2009-07-29 14:10:19 +0200 | [diff] [blame] | 48 | struct hv_storvsc_request; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 49 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 50 | /* Matches Windows-end */ |
Greg Kroah-Hartman | 9f0c7d2 | 2009-08-28 16:20:07 -0700 | [diff] [blame] | 51 | enum storvsc_request_type{ |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 52 | WRITE_TYPE, |
| 53 | READ_TYPE, |
| 54 | UNKNOWN_TYPE, |
Greg Kroah-Hartman | 9f0c7d2 | 2009-08-28 16:20:07 -0700 | [diff] [blame] | 55 | }; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 56 | |
K. Y. Srinivasan | bf587a1 | 2011-03-28 09:33:26 -0700 | [diff] [blame] | 57 | |
| 58 | struct storvsc_request_extension { |
| 59 | struct hv_storvsc_request *request; |
| 60 | struct hv_device *device; |
| 61 | |
| 62 | /* Synchronize the request/response if needed */ |
K. Y. Srinivasan | 93958465 | 2011-03-28 09:33:30 -0700 | [diff] [blame^] | 63 | struct completion wait_event; |
K. Y. Srinivasan | bf587a1 | 2011-03-28 09:33:26 -0700 | [diff] [blame] | 64 | |
| 65 | struct vstor_packet vstor_packet; |
| 66 | }; |
| 67 | |
Nicolas Palix | 0b3f683 | 2009-07-29 14:10:19 +0200 | [diff] [blame] | 68 | struct hv_storvsc_request { |
Hank Janssen | 8a04602 | 2010-12-06 12:26:45 -0800 | [diff] [blame] | 69 | enum storvsc_request_type type; |
| 70 | u32 host; |
| 71 | u32 bus; |
| 72 | u32 target_id; |
| 73 | u32 lun_id; |
| 74 | u8 *cdb; |
| 75 | u32 cdb_len; |
| 76 | u32 status; |
| 77 | u32 bytes_xfer; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 78 | |
Hank Janssen | 8a04602 | 2010-12-06 12:26:45 -0800 | [diff] [blame] | 79 | unsigned char *sense_buffer; |
| 80 | u32 sense_buffer_size; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 81 | |
Hank Janssen | 8a04602 | 2010-12-06 12:26:45 -0800 | [diff] [blame] | 82 | void *context; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 83 | |
Hank Janssen | 8a04602 | 2010-12-06 12:26:45 -0800 | [diff] [blame] | 84 | void (*on_io_completion)(struct hv_storvsc_request *request); |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 85 | |
K. Y. Srinivasan | 2fd0df2 | 2011-03-28 09:33:27 -0700 | [diff] [blame] | 86 | struct storvsc_request_extension extension; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 87 | |
Hank Janssen | 8a04602 | 2010-12-06 12:26:45 -0800 | [diff] [blame] | 88 | struct hv_multipage_buffer data_buffer; |
Nicolas Palix | 0b3f683 | 2009-07-29 14:10:19 +0200 | [diff] [blame] | 89 | }; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 90 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 91 | /* Represents the block vsc driver */ |
Greg Kroah-Hartman | 9f0c7d2 | 2009-08-28 16:20:07 -0700 | [diff] [blame] | 92 | struct storvsc_driver_object { |
Hank Janssen | 8a04602 | 2010-12-06 12:26:45 -0800 | [diff] [blame] | 93 | struct hv_driver base; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 94 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 95 | /* Set by caller (in bytes) */ |
Hank Janssen | 8a04602 | 2010-12-06 12:26:45 -0800 | [diff] [blame] | 96 | u32 ring_buffer_size; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 97 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 98 | /* Maximum # of requests in flight per channel/device */ |
Hank Janssen | 8a04602 | 2010-12-06 12:26:45 -0800 | [diff] [blame] | 99 | u32 max_outstanding_req_per_channel; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 100 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 101 | /* Specific to this driver */ |
Hank Janssen | 8a04602 | 2010-12-06 12:26:45 -0800 | [diff] [blame] | 102 | int (*on_io_request)(struct hv_device *device, |
| 103 | struct hv_storvsc_request *request); |
Greg Kroah-Hartman | 9f0c7d2 | 2009-08-28 16:20:07 -0700 | [diff] [blame] | 104 | }; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 105 | |
Greg Kroah-Hartman | 9f0c7d2 | 2009-08-28 16:20:07 -0700 | [diff] [blame] | 106 | struct storvsc_device_info { |
Hank Janssen | 8a04602 | 2010-12-06 12:26:45 -0800 | [diff] [blame] | 107 | unsigned int port_number; |
| 108 | unsigned char path_id; |
| 109 | unsigned char target_id; |
Greg Kroah-Hartman | 9f0c7d2 | 2009-08-28 16:20:07 -0700 | [diff] [blame] | 110 | }; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 111 | |
K. Y. Srinivasan | f24eeb0 | 2011-03-23 10:50:21 -0700 | [diff] [blame] | 112 | /* A storvsc device is a device object that contains a vmbus channel */ |
| 113 | struct storvsc_device { |
| 114 | struct hv_device *device; |
| 115 | |
| 116 | /* 0 indicates the device is being destroyed */ |
| 117 | atomic_t ref_count; |
| 118 | |
| 119 | atomic_t num_outstanding_req; |
| 120 | |
| 121 | /* |
| 122 | * Each unique Port/Path/Target represents 1 channel ie scsi |
| 123 | * controller. In reality, the pathid, targetid is always 0 |
| 124 | * and the port is set by us |
| 125 | */ |
| 126 | unsigned int port_number; |
| 127 | unsigned char path_id; |
| 128 | unsigned char target_id; |
| 129 | |
K. Y. Srinivasan | f24eeb0 | 2011-03-23 10:50:21 -0700 | [diff] [blame] | 130 | /* Used for vsc/vsp channel reset process */ |
| 131 | struct storvsc_request_extension init_request; |
| 132 | struct storvsc_request_extension reset_request; |
| 133 | }; |
| 134 | |
K. Y. Srinivasan | 852c16d | 2011-03-23 10:50:31 -0700 | [diff] [blame] | 135 | |
| 136 | /* Get the stordevice object iff exists and its refcount > 1 */ |
| 137 | static inline struct storvsc_device *get_stor_device(struct hv_device *device) |
| 138 | { |
| 139 | struct storvsc_device *stor_device; |
| 140 | |
| 141 | stor_device = (struct storvsc_device *)device->ext; |
| 142 | if (stor_device && atomic_read(&stor_device->ref_count) > 1) |
| 143 | atomic_inc(&stor_device->ref_count); |
| 144 | else |
| 145 | stor_device = NULL; |
| 146 | |
| 147 | return stor_device; |
| 148 | } |
| 149 | |
K. Y. Srinivasan | 1604b1b | 2011-03-23 10:50:32 -0700 | [diff] [blame] | 150 | |
| 151 | static inline void put_stor_device(struct hv_device *device) |
| 152 | { |
| 153 | struct storvsc_device *stor_device; |
| 154 | |
| 155 | stor_device = (struct storvsc_device *)device->ext; |
| 156 | |
| 157 | atomic_dec(&stor_device->ref_count); |
| 158 | } |
| 159 | |
K. Y. Srinivasan | ced01b0 | 2011-03-28 09:33:29 -0700 | [diff] [blame] | 160 | static inline struct storvsc_driver_object *hvdr_to_stordr(struct hv_driver *d) |
| 161 | { |
| 162 | return container_of(d, struct storvsc_driver_object, base); |
| 163 | } |
| 164 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 165 | /* Interface */ |
| 166 | |
K. Y. Srinivasan | afa3f3d | 2011-03-23 10:50:23 -0700 | [diff] [blame] | 167 | int stor_vsc_on_device_add(struct hv_device *device, |
| 168 | void *additional_info); |
| 169 | int stor_vsc_on_device_remove(struct hv_device *device); |
| 170 | |
| 171 | int stor_vsc_on_io_request(struct hv_device *device, |
| 172 | struct hv_storvsc_request *request); |
| 173 | void stor_vsc_on_cleanup(struct hv_driver *driver); |
| 174 | |
| 175 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 176 | #endif /* _STORVSC_API_H_ */ |