3 * Copyright (c) 2009, Microsoft Corporation.
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.
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
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.
19 * Haiyang Zhang <haiyangz@microsoft.com>
20 * Hank Janssen <hjanssen@microsoft.com>
28 #define MAX_PAGE_BUFFER_COUNT 16
29 #define MAX_MULTIPAGE_BUFFER_COUNT 32 /* 128K */
33 /* Single-page buffer */
34 struct hv_page_buffer
{
40 /* Multiple-page buffer */
41 struct hv_multipage_buffer
{
42 /* Length and Offset determines the # of pfns in the array */
45 u64 PfnArray
[MAX_MULTIPAGE_BUFFER_COUNT
];
48 /* 0x18 includes the proprietary packet header */
49 #define MAX_PAGE_BUFFER_PACKET (0x18 + \
50 (sizeof(struct hv_page_buffer) * \
51 MAX_PAGE_BUFFER_COUNT))
52 #define MAX_MULTIPAGE_BUFFER_PACKET (0x18 + \
53 sizeof(struct hv_multipage_buffer))
61 struct hv_dev_port_info
{
66 u32 BytesAvailToWrite
;
69 struct hv_device_info
{
72 struct hv_guid ChannelType
;
73 struct hv_guid ChannelInstance
;
76 u32 ServerMonitorPending
;
77 u32 ServerMonitorLatency
;
78 u32 ServerMonitorConnectionId
;
79 u32 ClientMonitorPending
;
80 u32 ClientMonitorLatency
;
81 u32 ClientMonitorConnectionId
;
83 struct hv_dev_port_info Inbound
;
84 struct hv_dev_port_info Outbound
;
88 * struct vmbus_channel_interface - Contains member functions for vmbus channel
89 * @Open: Open the channel
90 * @Close: Close the channel
91 * @SendPacket: Send a packet over the channel
92 * @SendPacketPageBuffer: Send a single page buffer over the channel
93 * @SendPacketMultiPageBuffer: Send a multiple page buffers
94 * @RecvPacket: Receive packet
95 * @RecvPacketRaw: Receive Raw packet
96 * @EstablishGpadl: Set up GPADL for ringbuffer
98 * This structure contains function pointer to control vmbus channel
99 * behavior. None of these functions is externally callable, but they
100 * are used for normal vmbus channel internal behavior.
101 * Only used by Hyper-V drivers.
103 struct vmbus_channel_interface
{
104 int (*Open
)(struct hv_device
*Device
, u32 SendBufferSize
,
105 u32 RecvRingBufferSize
, void *UserData
, u32 UserDataLen
,
106 void (*ChannelCallback
)(void *context
),
108 void (*Close
)(struct hv_device
*device
);
109 int (*SendPacket
)(struct hv_device
*Device
, const void *Buffer
,
110 u32 BufferLen
, u64 RequestId
, u32 Type
, u32 Flags
);
111 int (*SendPacketPageBuffer
)(struct hv_device
*dev
,
112 struct hv_page_buffer PageBuffers
[],
113 u32 PageCount
, void *Buffer
, u32 BufferLen
,
115 int (*SendPacketMultiPageBuffer
)(struct hv_device
*device
,
116 struct hv_multipage_buffer
*mpb
,
120 int (*RecvPacket
)(struct hv_device
*dev
, void *buf
, u32 buflen
,
121 u32
*BufferActualLen
, u64
*RequestId
);
122 int (*RecvPacketRaw
)(struct hv_device
*dev
, void *buf
, u32 buflen
,
123 u32
*BufferActualLen
, u64
*RequestId
);
124 int (*EstablishGpadl
)(struct hv_device
*dev
, void *buf
, u32 buflen
,
128 extern const struct vmbus_channel_interface vmbus_ops
;
131 /* Base driver object */
135 /* the device type supported by this driver */
136 struct hv_guid deviceType
;
138 int (*OnDeviceAdd
)(struct hv_device
*device
, void *data
);
139 int (*OnDeviceRemove
)(struct hv_device
*device
);
140 void (*OnCleanup
)(struct hv_driver
*driver
);
142 struct vmbus_channel_interface VmbusChannelInterface
;
145 /* Base device object */
147 /* the driver for this device */
148 struct hv_driver
*Driver
;
152 /* the device type id of this device */
153 struct hv_guid deviceType
;
155 /* the device instance id of this device */
156 struct hv_guid deviceInstance
;
160 /* Device extension; */
164 /* Vmbus driver object */
165 struct vmbus_driver
{
166 /* !! Must be the 1st field !! */
167 /* FIXME if ^, then someone is doing somthing stupid */
168 struct hv_driver Base
;
170 /* Set by the caller */
171 struct hv_device
* (*OnChildDeviceCreate
)(struct hv_guid
*DeviceType
,
172 struct hv_guid
*DeviceInstance
,
174 void (*OnChildDeviceDestroy
)(struct hv_device
*device
);
175 int (*OnChildDeviceAdd
)(struct hv_device
*RootDevice
,
176 struct hv_device
*ChildDevice
);
177 void (*OnChildDeviceRemove
)(struct hv_device
*device
);
179 /* Set by the callee */
180 int (*OnIsr
)(struct hv_driver
*driver
);
181 void (*OnMsgDpc
)(struct hv_driver
*driver
);
182 void (*OnEventDpc
)(struct hv_driver
*driver
);
183 void (*GetChannelOffers
)(void);
186 int VmbusInitialize(struct hv_driver
*drv
);
188 #endif /* _VMBUS_API_H_ */