blob: fd9165f674dabed35f047aae57e02c9b259b3cff [file] [log] [blame]
Hank Janssenab057782009-07-13 15:19:28 -07001/*
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. Srinivasanced01b02011-03-28 09:33:29 -070028#include <linux/kernel.h>
K. Y. Srinivasan036bbed2011-03-23 10:50:20 -070029#include "vstorage.h"
Greg Kroah-Hartman447fc672010-05-05 22:43:02 -070030#include "vmbus_api.h"
Hank Janssenab057782009-07-13 15:19:28 -070031
Bill Pemberton454f18a2009-07-27 16:47:24 -040032/* Defines */
Hank Janssen15dd1c92010-08-05 19:30:31 +000033#define STORVSC_RING_BUFFER_SIZE (20*PAGE_SIZE)
Greg Kroah-Hartman9bcd7862009-08-28 16:19:17 -070034#define BLKVSC_RING_BUFFER_SIZE (20*PAGE_SIZE)
Hank Janssenab057782009-07-13 15:19:28 -070035
Hank Janssen15dd1c92010-08-05 19:30:31 +000036#define STORVSC_MAX_IO_REQUESTS 128
Hank Janssenab057782009-07-13 15:19:28 -070037
Bill Pemberton454f18a2009-07-27 16:47:24 -040038/*
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 Janssenab057782009-07-13 15:19:28 -070044#define STORVSC_MAX_LUNS_PER_TARGET 64
Greg Kroah-Hartman9bcd7862009-08-28 16:19:17 -070045#define STORVSC_MAX_TARGETS 1
Hank Janssenab057782009-07-13 15:19:28 -070046#define STORVSC_MAX_CHANNELS 1
47
Nicolas Palix0b3f6832009-07-29 14:10:19 +020048struct hv_storvsc_request;
Hank Janssenab057782009-07-13 15:19:28 -070049
Bill Pemberton454f18a2009-07-27 16:47:24 -040050/* Matches Windows-end */
Greg Kroah-Hartman9f0c7d22009-08-28 16:20:07 -070051enum storvsc_request_type{
Hank Janssenab057782009-07-13 15:19:28 -070052 WRITE_TYPE,
53 READ_TYPE,
54 UNKNOWN_TYPE,
Greg Kroah-Hartman9f0c7d22009-08-28 16:20:07 -070055};
Hank Janssenab057782009-07-13 15:19:28 -070056
K. Y. Srinivasanbf587a12011-03-28 09:33:26 -070057
58struct storvsc_request_extension {
59 struct hv_storvsc_request *request;
60 struct hv_device *device;
61
62 /* Synchronize the request/response if needed */
K. Y. Srinivasan939584652011-03-28 09:33:30 -070063 struct completion wait_event;
K. Y. Srinivasanbf587a12011-03-28 09:33:26 -070064
K. Y. Srinivasan237ecd62011-03-28 09:33:39 -070065 unsigned char *sense_buffer;
66
K. Y. Srinivasanbf587a12011-03-28 09:33:26 -070067 struct vstor_packet vstor_packet;
68};
69
Nicolas Palix0b3f6832009-07-29 14:10:19 +020070struct hv_storvsc_request {
Hank Janssen8a046022010-12-06 12:26:45 -080071 u32 status;
72 u32 bytes_xfer;
Hank Janssenab057782009-07-13 15:19:28 -070073
Hank Janssen8a046022010-12-06 12:26:45 -080074 void *context;
Hank Janssenab057782009-07-13 15:19:28 -070075
Hank Janssen8a046022010-12-06 12:26:45 -080076 void (*on_io_completion)(struct hv_storvsc_request *request);
Hank Janssenab057782009-07-13 15:19:28 -070077
K. Y. Srinivasan2fd0df22011-03-28 09:33:27 -070078 struct storvsc_request_extension extension;
Hank Janssenab057782009-07-13 15:19:28 -070079
Hank Janssen8a046022010-12-06 12:26:45 -080080 struct hv_multipage_buffer data_buffer;
Nicolas Palix0b3f6832009-07-29 14:10:19 +020081};
Hank Janssenab057782009-07-13 15:19:28 -070082
Bill Pemberton454f18a2009-07-27 16:47:24 -040083/* Represents the block vsc driver */
Greg Kroah-Hartman9f0c7d22009-08-28 16:20:07 -070084struct storvsc_driver_object {
Hank Janssen8a046022010-12-06 12:26:45 -080085 struct hv_driver base;
Hank Janssenab057782009-07-13 15:19:28 -070086
Bill Pemberton454f18a2009-07-27 16:47:24 -040087 /* Set by caller (in bytes) */
Hank Janssen8a046022010-12-06 12:26:45 -080088 u32 ring_buffer_size;
Hank Janssenab057782009-07-13 15:19:28 -070089
Bill Pemberton454f18a2009-07-27 16:47:24 -040090 /* Maximum # of requests in flight per channel/device */
Hank Janssen8a046022010-12-06 12:26:45 -080091 u32 max_outstanding_req_per_channel;
Hank Janssenab057782009-07-13 15:19:28 -070092
Bill Pemberton454f18a2009-07-27 16:47:24 -040093 /* Specific to this driver */
Hank Janssen8a046022010-12-06 12:26:45 -080094 int (*on_io_request)(struct hv_device *device,
95 struct hv_storvsc_request *request);
Greg Kroah-Hartman9f0c7d22009-08-28 16:20:07 -070096};
Hank Janssenab057782009-07-13 15:19:28 -070097
Greg Kroah-Hartman9f0c7d22009-08-28 16:20:07 -070098struct storvsc_device_info {
Hank Janssen8a046022010-12-06 12:26:45 -080099 unsigned int port_number;
100 unsigned char path_id;
101 unsigned char target_id;
Greg Kroah-Hartman9f0c7d22009-08-28 16:20:07 -0700102};
Hank Janssenab057782009-07-13 15:19:28 -0700103
K. Y. Srinivasanf24eeb02011-03-23 10:50:21 -0700104/* A storvsc device is a device object that contains a vmbus channel */
105struct storvsc_device {
106 struct hv_device *device;
107
108 /* 0 indicates the device is being destroyed */
109 atomic_t ref_count;
110
111 atomic_t num_outstanding_req;
112
113 /*
114 * Each unique Port/Path/Target represents 1 channel ie scsi
115 * controller. In reality, the pathid, targetid is always 0
116 * and the port is set by us
117 */
118 unsigned int port_number;
119 unsigned char path_id;
120 unsigned char target_id;
121
K. Y. Srinivasanf24eeb02011-03-23 10:50:21 -0700122 /* Used for vsc/vsp channel reset process */
123 struct storvsc_request_extension init_request;
124 struct storvsc_request_extension reset_request;
125};
126
K. Y. Srinivasan852c16d2011-03-23 10:50:31 -0700127
128/* Get the stordevice object iff exists and its refcount > 1 */
129static inline struct storvsc_device *get_stor_device(struct hv_device *device)
130{
131 struct storvsc_device *stor_device;
132
133 stor_device = (struct storvsc_device *)device->ext;
134 if (stor_device && atomic_read(&stor_device->ref_count) > 1)
135 atomic_inc(&stor_device->ref_count);
136 else
137 stor_device = NULL;
138
139 return stor_device;
140}
141
K. Y. Srinivasan1604b1b2011-03-23 10:50:32 -0700142
143static inline void put_stor_device(struct hv_device *device)
144{
145 struct storvsc_device *stor_device;
146
147 stor_device = (struct storvsc_device *)device->ext;
148
149 atomic_dec(&stor_device->ref_count);
150}
151
K. Y. Srinivasanced01b02011-03-28 09:33:29 -0700152static inline struct storvsc_driver_object *hvdr_to_stordr(struct hv_driver *d)
153{
154 return container_of(d, struct storvsc_driver_object, base);
155}
156
Bill Pemberton454f18a2009-07-27 16:47:24 -0400157/* Interface */
158
K. Y. Srinivasanafa3f3d2011-03-23 10:50:23 -0700159int stor_vsc_on_device_add(struct hv_device *device,
160 void *additional_info);
161int stor_vsc_on_device_remove(struct hv_device *device);
162
163int stor_vsc_on_io_request(struct hv_device *device,
164 struct hv_storvsc_request *request);
165void stor_vsc_on_cleanup(struct hv_driver *driver);
166
167
Bill Pemberton454f18a2009-07-27 16:47:24 -0400168#endif /* _STORVSC_API_H_ */