1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/*
*
* Copyright (c) 2009, Microsoft Corporation.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms and conditions of the GNU General Public License,
* version 2, as published by the Free Software Foundation.
*
* This program is distributed in the hope it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc., 59 Temple
* Place - Suite 330, Boston, MA 02111-1307 USA.
*
* Authors:
* Haiyang Zhang <haiyangz@microsoft.com>
* Hank Janssen <hjanssen@microsoft.com>
*
*/
#ifndef _VMBUS_API_H_
#define _VMBUS_API_H_
#define MAX_PAGE_BUFFER_COUNT 16
#define MAX_MULTIPAGE_BUFFER_COUNT 32 /* 128K */
#pragma pack(push, 1)
/* Single-page buffer */
struct hv_page_buffer {
u32 Length;
u32 Offset;
u64 Pfn;
};
/* Multiple-page buffer */
struct hv_multipage_buffer {
/* Length and Offset determines the # of pfns in the array */
u32 Length;
u32 Offset;
u64 PfnArray[MAX_MULTIPAGE_BUFFER_COUNT];
};
/* 0x18 includes the proprietary packet header */
#define MAX_PAGE_BUFFER_PACKET (0x18 + \
(sizeof(struct hv_page_buffer) * \
MAX_PAGE_BUFFER_COUNT))
#define MAX_MULTIPAGE_BUFFER_PACKET (0x18 + \
sizeof(struct hv_multipage_buffer))
#pragma pack(pop)
struct hv_driver;
struct hv_device;
struct hv_dev_port_info {
u32 InterruptMask;
u32 ReadIndex;
u32 WriteIndex;
u32 BytesAvailToRead;
u32 BytesAvailToWrite;
};
struct hv_device_info {
u32 ChannelId;
u32 ChannelState;
struct hv_guid ChannelType;
struct hv_guid ChannelInstance;
u32 MonitorId;
u32 ServerMonitorPending;
u32 ServerMonitorLatency;
u32 ServerMonitorConnectionId;
u32 ClientMonitorPending;
u32 ClientMonitorLatency;
u32 ClientMonitorConnectionId;
struct hv_dev_port_info Inbound;
struct hv_dev_port_info Outbound;
};
/**
* struct vmbus_channel_interface - Contains member functions for vmbus channel
* @Open: Open the channel
* @Close: Close the channel
* @SendPacket: Send a packet over the channel
* @SendPacketPageBuffer: Send a single page buffer over the channel
* @SendPacketMultiPageBuffer: Send a multiple page buffers
* @RecvPacket: Receive packet
* @RecvPacketRaw: Receive Raw packet
* @EstablishGpadl: Set up GPADL for ringbuffer
* @TeardownGpadl: Teardown GPADL for ringbuffer
* @GetInfo: Get info about the channel
*
* This structure contains function pointer to control vmbus channel
* behavior. None of these functions is externally callable, but they
* are used for normal vmbus channel internal behavior.
* Only used by Hyper-V drivers.
*/
struct vmbus_channel_interface {
int (*Open)(struct hv_device *Device, u32 SendBufferSize,
u32 RecvRingBufferSize, void *UserData, u32 UserDataLen,
void (*ChannelCallback)(void *context),
void *Context);
void (*Close)(struct hv_device *device);
int (*SendPacket)(struct hv_device *Device, const void *Buffer,
u32 BufferLen, u64 RequestId, u32 Type, u32 Flags);
int (*SendPacketPageBuffer)(struct hv_device *dev,
struct hv_page_buffer PageBuffers[],
u32 PageCount, void *Buffer, u32 BufferLen,
u64 RequestId);
int (*SendPacketMultiPageBuffer)(struct hv_device *device,
struct hv_multipage_buffer *mpb,
void *Buffer,
u32 BufferLen,
u64 RequestId);
int (*RecvPacket)(struct hv_device *dev, void *buf, u32 buflen,
u32 *BufferActualLen, u64 *RequestId);
int (*RecvPacketRaw)(struct hv_device *dev, void *buf, u32 buflen,
u32 *BufferActualLen, u64 *RequestId);
int (*EstablishGpadl)(struct hv_device *dev, void *buf, u32 buflen,
u32 *GpadlHandle);
int (*TeardownGpadl)(struct hv_device *device, u32 GpadlHandle);
void (*GetInfo)(struct hv_device *dev, struct hv_device_info *devinfo);
};
/* Base driver object */
struct hv_driver {
const char *name;
/* the device type supported by this driver */
struct hv_guid deviceType;
int (*OnDeviceAdd)(struct hv_device *device, void *data);
int (*OnDeviceRemove)(struct hv_device *device);
void (*OnCleanup)(struct hv_driver *driver);
struct vmbus_channel_interface VmbusChannelInterface;
};
/* Base device object */
struct hv_device {
/* the driver for this device */
struct hv_driver *Driver;
char name[64];
/* the device type id of this device */
struct hv_guid deviceType;
/* the device instance id of this device */
struct hv_guid deviceInstance;
void *context;
/* Device extension; */
void *Extension;
};
/* Vmbus driver object */
struct vmbus_driver {
/* !! Must be the 1st field !! */
/* FIXME if ^, then someone is doing somthing stupid */
struct hv_driver Base;
/* Set by the caller */
struct hv_device * (*OnChildDeviceCreate)(struct hv_guid *DeviceType,
struct hv_guid *DeviceInstance,
void *Context);
void (*OnChildDeviceDestroy)(struct hv_device *device);
int (*OnChildDeviceAdd)(struct hv_device *RootDevice,
struct hv_device *ChildDevice);
void (*OnChildDeviceRemove)(struct hv_device *device);
/* Set by the callee */
int (*OnIsr)(struct hv_driver *driver);
void (*OnMsgDpc)(struct hv_driver *driver);
void (*OnEventDpc)(struct hv_driver *driver);
void (*GetChannelOffers)(void);
void (*GetChannelInterface)(struct vmbus_channel_interface *i);
void (*GetChannelInfo)(struct hv_device *dev,
struct hv_device_info *devinfo);
};
int VmbusInitialize(struct hv_driver *drv);
#endif /* _VMBUS_API_H_ */
|
