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 | |
Greg Kroah-Hartman | 447fc67 | 2010-05-05 22:43:02 -0700 | [diff] [blame] | 28 | #include "vmbus_api.h" |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 29 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 30 | /* Defines */ |
Hank Janssen | 15dd1c9 | 2010-08-05 19:30:31 +0000 | [diff] [blame^] | 31 | #define STORVSC_RING_BUFFER_SIZE (20*PAGE_SIZE) |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 32 | #define BLKVSC_RING_BUFFER_SIZE (20*PAGE_SIZE) |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 33 | |
Hank Janssen | 15dd1c9 | 2010-08-05 19:30:31 +0000 | [diff] [blame^] | 34 | #define STORVSC_MAX_IO_REQUESTS 128 |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 35 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 36 | /* |
| 37 | * In Hyper-V, each port/path/target maps to 1 scsi host adapter. In |
| 38 | * reality, the path/target is not used (ie always set to 0) so our |
| 39 | * scsi host adapter essentially has 1 bus with 1 target that contains |
| 40 | * up to 256 luns. |
| 41 | */ |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 42 | #define STORVSC_MAX_LUNS_PER_TARGET 64 |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 43 | #define STORVSC_MAX_TARGETS 1 |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 44 | #define STORVSC_MAX_CHANNELS 1 |
| 45 | |
Nicolas Palix | 0b3f683 | 2009-07-29 14:10:19 +0200 | [diff] [blame] | 46 | struct hv_storvsc_request; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 47 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 48 | /* Matches Windows-end */ |
Greg Kroah-Hartman | 9f0c7d2 | 2009-08-28 16:20:07 -0700 | [diff] [blame] | 49 | enum storvsc_request_type{ |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 50 | WRITE_TYPE, |
| 51 | READ_TYPE, |
| 52 | UNKNOWN_TYPE, |
Greg Kroah-Hartman | 9f0c7d2 | 2009-08-28 16:20:07 -0700 | [diff] [blame] | 53 | }; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 54 | |
Nicolas Palix | 0b3f683 | 2009-07-29 14:10:19 +0200 | [diff] [blame] | 55 | struct hv_storvsc_request { |
Greg Kroah-Hartman | 9f0c7d2 | 2009-08-28 16:20:07 -0700 | [diff] [blame] | 56 | enum storvsc_request_type Type; |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 57 | u32 Host; |
| 58 | u32 Bus; |
| 59 | u32 TargetId; |
| 60 | u32 LunId; |
| 61 | u8 *Cdb; |
| 62 | u32 CdbLen; |
| 63 | u32 Status; |
| 64 | u32 BytesXfer; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 65 | |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 66 | unsigned char *SenseBuffer; |
| 67 | u32 SenseBufferSize; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 68 | |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 69 | void *Context; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 70 | |
Greg Kroah-Hartman | f25c749 | 2009-09-02 11:28:55 -0700 | [diff] [blame] | 71 | void (*OnIOCompletion)(struct hv_storvsc_request *Request); |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 72 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 73 | /* This points to the memory after DataBuffer */ |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 74 | void *Extension; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 75 | |
Greg Kroah-Hartman | ee3d7dd | 2009-08-20 12:17:36 -0700 | [diff] [blame] | 76 | struct hv_multipage_buffer DataBuffer; |
Nicolas Palix | 0b3f683 | 2009-07-29 14:10:19 +0200 | [diff] [blame] | 77 | }; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 78 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 79 | /* Represents the block vsc driver */ |
Greg Kroah-Hartman | 9f0c7d2 | 2009-08-28 16:20:07 -0700 | [diff] [blame] | 80 | struct storvsc_driver_object { |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 81 | /* Must be the first field */ |
| 82 | /* Which is a bug FIXME! */ |
| 83 | struct hv_driver Base; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 84 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 85 | /* Set by caller (in bytes) */ |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 86 | u32 RingBufferSize; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 87 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 88 | /* Allocate this much private extension for each I/O request */ |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 89 | u32 RequestExtSize; |
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 | /* Maximum # of requests in flight per channel/device */ |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 92 | u32 MaxOutstandingRequestsPerChannel; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 93 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 94 | /* Specific to this driver */ |
Greg Kroah-Hartman | f25c749 | 2009-09-02 11:28:55 -0700 | [diff] [blame] | 95 | int (*OnIORequest)(struct hv_device *Device, |
| 96 | struct hv_storvsc_request *Request); |
Greg Kroah-Hartman | 9f0c7d2 | 2009-08-28 16:20:07 -0700 | [diff] [blame] | 97 | }; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 98 | |
Greg Kroah-Hartman | 9f0c7d2 | 2009-08-28 16:20:07 -0700 | [diff] [blame] | 99 | struct storvsc_device_info { |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 100 | unsigned int PortNumber; |
| 101 | unsigned char PathId; |
| 102 | unsigned char TargetId; |
Greg Kroah-Hartman | 9f0c7d2 | 2009-08-28 16:20:07 -0700 | [diff] [blame] | 103 | }; |
Hank Janssen | ab05778 | 2009-07-13 15:19:28 -0700 | [diff] [blame] | 104 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 105 | /* Interface */ |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 106 | int StorVscInitialize(struct hv_driver *driver); |
Greg Kroah-Hartman | 354b0a6 | 2010-01-08 10:24:26 -0800 | [diff] [blame] | 107 | int StorVscOnHostReset(struct hv_device *Device); |
Greg Kroah-Hartman | 9bcd786 | 2009-08-28 16:19:17 -0700 | [diff] [blame] | 108 | int BlkVscInitialize(struct hv_driver *driver); |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 109 | |
Bill Pemberton | 454f18a | 2009-07-27 16:47:24 -0400 | [diff] [blame] | 110 | #endif /* _STORVSC_API_H_ */ |