[net-next-2.6.git] / drivers / staging / hv / ChannelMgmt.h

/*
 *
 * 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 _CHANNEL_MGMT_H_
#define _CHANNEL_MGMT_H_

#include "List.h"
#include "RingBuffer.h"

#include "VmbusChannelInterface.h"
#include "include/VmbusPacketFormat.h"

/* Version 1 messages */
enum vmbus_channel_message_type {
	ChannelMessageInvalid			=  0,
	ChannelMessageOfferChannel		=  1,
	ChannelMessageRescindChannelOffer	=  2,
	ChannelMessageRequestOffers		=  3,
	ChannelMessageAllOffersDelivered	=  4,
	ChannelMessageOpenChannel		=  5,
	ChannelMessageOpenChannelResult		=  6,
	ChannelMessageCloseChannel		=  7,
	ChannelMessageGpadlHeader		=  8,
	ChannelMessageGpadlBody			=  9,
	ChannelMessageGpadlCreated		= 10,
	ChannelMessageGpadlTeardown		= 11,
	ChannelMessageGpadlTorndown		= 12,
	ChannelMessageRelIdReleased		= 13,
	ChannelMessageInitiateContact		= 14,
	ChannelMessageVersionResponse		= 15,
	ChannelMessageUnload			= 16,
#ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
	ChannelMessageViewRangeAdd		= 17,
	ChannelMessageViewRangeRemove		= 18,
#endif
	ChannelMessageCount
} __attribute__((packed));

struct vmbus_channel_message_header {
	enum vmbus_channel_message_type MessageType;
	u32 Padding;
} __attribute__((packed));

/* Query VMBus Version parameters */
struct vmbus_channel_query_vmbus_version {
	struct vmbus_channel_message_header Header;
	u32 Version;
} __attribute__((packed));

/* VMBus Version Supported parameters */
struct vmbus_channel_version_supported {
	struct vmbus_channel_message_header Header;
	bool VersionSupported;
} __attribute__((packed));

/* Offer Channel parameters */
struct vmbus_channel_offer_channel {
	struct vmbus_channel_message_header Header;
	struct vmbus_channel_offer Offer;
	u32 ChildRelId;
	u8 MonitorId;
	bool MonitorAllocated;
} __attribute__((packed));

/* Rescind Offer parameters */
struct vmbus_channel_rescind_offer {
	struct vmbus_channel_message_header Header;
	u32 ChildRelId;
} __attribute__((packed));

/*
 * Request Offer -- no parameters, SynIC message contains the partition ID
 * Set Snoop -- no parameters, SynIC message contains the partition ID
 * Clear Snoop -- no parameters, SynIC message contains the partition ID
 * All Offers Delivered -- no parameters, SynIC message contains the partition
 *		           ID
 * Flush Client -- no parameters, SynIC message contains the partition ID
 */

/* Open Channel parameters */
struct vmbus_channel_open_channel {
	struct vmbus_channel_message_header Header;

	/* Identifies the specific VMBus channel that is being opened. */
	u32 ChildRelId;

	/* ID making a particular open request at a channel offer unique. */
	u32 OpenId;

	/* GPADL for the channel's ring buffer. */
	u32 RingBufferGpadlHandle;

	/* GPADL for the channel's server context save area. */
	u32 ServerContextAreaGpadlHandle;

	/*
	* The upstream ring buffer begins at offset zero in the memory
	* described by RingBufferGpadlHandle. The downstream ring buffer
	* follows it at this offset (in pages).
	*/
	u32 DownstreamRingBufferPageOffset;

	/* User-specific data to be passed along to the server endpoint. */
	unsigned char UserData[MAX_USER_DEFINED_BYTES];
} __attribute__((packed));

/* Open Channel Result parameters */
struct vmbus_channel_open_result {
	struct vmbus_channel_message_header Header;
	u32 ChildRelId;
	u32 OpenId;
	u32 Status;
} __attribute__((packed));

/* Close channel parameters; */
struct vmbus_channel_close_channel {
	struct vmbus_channel_message_header Header;
	u32 ChildRelId;
} __attribute__((packed));

/* Channel Message GPADL */
#define GPADL_TYPE_RING_BUFFER		1
#define GPADL_TYPE_SERVER_SAVE_AREA	2
#define GPADL_TYPE_TRANSACTION		8

/*
 * The number of PFNs in a GPADL message is defined by the number of
 * pages that would be spanned by ByteCount and ByteOffset.  If the
 * implied number of PFNs won't fit in this packet, there will be a
 * follow-up packet that contains more.
 */
struct vmbus_channel_gpadl_header {
	struct vmbus_channel_message_header Header;
	u32 ChildRelId;
	u32 Gpadl;
	u16 RangeBufLen;
	u16 RangeCount;
	struct gpa_range Range[0];
} __attribute__((packed));

/* This is the followup packet that contains more PFNs. */
struct vmbus_channel_gpadl_body {
	struct vmbus_channel_message_header Header;
	u32 MessageNumber;
	u32 Gpadl;
	u64 Pfn[0];
} __attribute__((packed));

struct vmbus_channel_gpadl_created {
	struct vmbus_channel_message_header Header;
	u32 ChildRelId;
	u32 Gpadl;
	u32 CreationStatus;
} __attribute__((packed));

struct vmbus_channel_gpadl_teardown {
	struct vmbus_channel_message_header Header;
	u32 ChildRelId;
	u32 Gpadl;
} __attribute__((packed));

struct vmbus_channel_gpadl_torndown {
	struct vmbus_channel_message_header Header;
	u32 Gpadl;
} __attribute__((packed));

#ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
struct vmbus_channel_view_range_add {
	struct vmbus_channel_message_header Header;
	PHYSICAL_ADDRESS ViewRangeBase;
	u64 ViewRangeLength;
	u32 ChildRelId;
} __attribute__((packed));

struct vmbus_channel_view_range_remove {
	struct vmbus_channel_message_header Header;
	PHYSICAL_ADDRESS ViewRangeBase;
	u32 ChildRelId;
} __attribute__((packed));
#endif

struct vmbus_channel_relid_released {
	struct vmbus_channel_message_header Header;
	u32 ChildRelId;
} __attribute__((packed));

struct vmbus_channel_initiate_contact {
	struct vmbus_channel_message_header Header;
	u32 VMBusVersionRequested;
	u32 Padding2;
	u64 InterruptPage;
	u64 MonitorPage1;
	u64 MonitorPage2;
} __attribute__((packed));

struct vmbus_channel_version_response {
	struct vmbus_channel_message_header Header;
	bool VersionSupported;
} __attribute__((packed));

typedef void (*PFN_CHANNEL_CALLBACK)(void *context);

enum vmbus_channel_state {
	CHANNEL_OFFER_STATE,
	CHANNEL_OPENING_STATE,
	CHANNEL_OPEN_STATE,
};

struct vmbus_channel {
	LIST_ENTRY ListEntry;

	struct hv_device *DeviceObject;

	struct timer_list poll_timer; /* SA-111 workaround */

	enum vmbus_channel_state State;

	struct vmbus_channel_offer_channel OfferMsg;
	/*
	 * These are based on the OfferMsg.MonitorId.
	 * Save it here for easy access.
	 */
	u8 MonitorGroup;
	u8 MonitorBit;

	u32 RingBufferGpadlHandle;

	/* Allocated memory for ring buffer */
	void *RingBufferPages;
	u32 RingBufferPageCount;
	RING_BUFFER_INFO Outbound;	/* send to parent */
	RING_BUFFER_INFO Inbound;	/* receive from parent */
	spinlock_t inbound_lock;
	struct workqueue_struct *ControlWQ;

	/* Channel callback are invoked in this workqueue context */
	/* HANDLE dataWorkQueue; */

	PFN_CHANNEL_CALLBACK OnChannelCallback;
	void *ChannelCallbackContext;
};

struct vmbus_channel_debug_info {
	u32 RelId;
	enum vmbus_channel_state State;
	struct hv_guid InterfaceType;
	struct hv_guid InterfaceInstance;
	u32 MonitorId;
	u32 ServerMonitorPending;
	u32 ServerMonitorLatency;
	u32 ServerMonitorConnectionId;
	u32 ClientMonitorPending;
	u32 ClientMonitorLatency;
	u32 ClientMonitorConnectionId;

	RING_BUFFER_DEBUG_INFO Inbound;
	RING_BUFFER_DEBUG_INFO Outbound;
};

/*
 * Represents each channel msg on the vmbus connection This is a
 * variable-size data structure depending on the msg type itself
 */
struct vmbus_channel_msginfo {
	/* Bookkeeping stuff */
	LIST_ENTRY MsgListEntry;

	/* So far, this is only used to handle gpadl body message */
	LIST_ENTRY SubMsgList;

	/* Synchronize the request/response if needed */
	struct osd_waitevent *WaitEvent;

	union {
		struct vmbus_channel_version_supported VersionSupported;
		struct vmbus_channel_open_result OpenResult;
		struct vmbus_channel_gpadl_torndown GpadlTorndown;
		struct vmbus_channel_gpadl_created GpadlCreated;
		struct vmbus_channel_version_response VersionResponse;
	} Response;

	u32 MessageSize;
	/*
	 * The channel message that goes out on the "wire".
	 * It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header
	 */
	unsigned char Msg[0];
};


struct vmbus_channel *AllocVmbusChannel(void);

void FreeVmbusChannel(struct vmbus_channel *Channel);

void VmbusOnChannelMessage(void *Context);

int VmbusChannelRequestOffers(void);

void VmbusChannelReleaseUnattachedChannels(void);

#endif /* _CHANNEL_MGMT_H_ */
Commit	Line	Data
3e7ee490 HJ	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 _CHANNEL_MGMT_H_
	26	#define _CHANNEL_MGMT_H_
	27
0b43c180	28	#include "List.h"
3e7ee490 HJ	29	#include "RingBuffer.h"
3e7ee490 HJ	30
0197e34c	31	#include "VmbusChannelInterface.h"
2def7b8b	32	#include "include/VmbusPacketFormat.h"
3e7ee490	33
2def7b8b GKH	34	/* Version 1 messages */
	35	enum vmbus_channel_message_type {
	36	ChannelMessageInvalid = 0,
	37	ChannelMessageOfferChannel = 1,
	38	ChannelMessageRescindChannelOffer = 2,
	39	ChannelMessageRequestOffers = 3,
	40	ChannelMessageAllOffersDelivered = 4,
	41	ChannelMessageOpenChannel = 5,
	42	ChannelMessageOpenChannelResult = 6,
	43	ChannelMessageCloseChannel = 7,
	44	ChannelMessageGpadlHeader = 8,
	45	ChannelMessageGpadlBody = 9,
	46	ChannelMessageGpadlCreated = 10,
	47	ChannelMessageGpadlTeardown = 11,
	48	ChannelMessageGpadlTorndown = 12,
	49	ChannelMessageRelIdReleased = 13,
	50	ChannelMessageInitiateContact = 14,
	51	ChannelMessageVersionResponse = 15,
	52	ChannelMessageUnload = 16,
	53	#ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
	54	ChannelMessageViewRangeAdd = 17,
	55	ChannelMessageViewRangeRemove = 18,
	56	#endif
	57	ChannelMessageCount
	58	} __attribute__((packed));
3e7ee490	59
2def7b8b GKH	60	struct vmbus_channel_message_header {
	61	enum vmbus_channel_message_type MessageType;
	62	u32 Padding;
	63	} __attribute__((packed));
	64
	65	/* Query VMBus Version parameters */
	66	struct vmbus_channel_query_vmbus_version {
	67	struct vmbus_channel_message_header Header;
	68	u32 Version;
	69	} __attribute__((packed));
	70
	71	/* VMBus Version Supported parameters */
	72	struct vmbus_channel_version_supported {
	73	struct vmbus_channel_message_header Header;
	74	bool VersionSupported;
	75	} __attribute__((packed));
	76
	77	/* Offer Channel parameters */
	78	struct vmbus_channel_offer_channel {
	79	struct vmbus_channel_message_header Header;
	80	struct vmbus_channel_offer Offer;
	81	u32 ChildRelId;
	82	u8 MonitorId;
	83	bool MonitorAllocated;
	84	} __attribute__((packed));
	85
	86	/* Rescind Offer parameters */
	87	struct vmbus_channel_rescind_offer {
	88	struct vmbus_channel_message_header Header;
	89	u32 ChildRelId;
	90	} __attribute__((packed));
	91
	92	/*
	93	* Request Offer -- no parameters, SynIC message contains the partition ID
	94	* Set Snoop -- no parameters, SynIC message contains the partition ID
	95	* Clear Snoop -- no parameters, SynIC message contains the partition ID
	96	* All Offers Delivered -- no parameters, SynIC message contains the partition
	97	* ID
	98	* Flush Client -- no parameters, SynIC message contains the partition ID
	99	*/
	100
	101	/* Open Channel parameters */
	102	struct vmbus_channel_open_channel {
	103	struct vmbus_channel_message_header Header;
	104
	105	/* Identifies the specific VMBus channel that is being opened. */
	106	u32 ChildRelId;
	107
	108	/* ID making a particular open request at a channel offer unique. */
	109	u32 OpenId;
	110
	111	/* GPADL for the channel's ring buffer. */
	112	u32 RingBufferGpadlHandle;
	113
	114	/* GPADL for the channel's server context save area. */
	115	u32 ServerContextAreaGpadlHandle;
	116
	117	/*
	118	* The upstream ring buffer begins at offset zero in the memory
	119	* described by RingBufferGpadlHandle. The downstream ring buffer
	120	* follows it at this offset (in pages).
	121	*/
	122	u32 DownstreamRingBufferPageOffset;
	123
124	/* User-specific data to be passed along to the server endpoint. */
125	unsigned char UserData[MAX_USER_DEFINED_BYTES];
126	} __attribute__((packed));
127
128	/* Open Channel Result parameters */
129	struct vmbus_channel_open_result {
130	struct vmbus_channel_message_header Header;
131	u32 ChildRelId;
132	u32 OpenId;
133	u32 Status;
134	} __attribute__((packed));
135
136	/* Close channel parameters; */
137	struct vmbus_channel_close_channel {
138	struct vmbus_channel_message_header Header;
139	u32 ChildRelId;
140	} __attribute__((packed));
141
142	/* Channel Message GPADL */
143	#define GPADL_TYPE_RING_BUFFER 1
144	#define GPADL_TYPE_SERVER_SAVE_AREA 2
145	#define GPADL_TYPE_TRANSACTION 8
146
147	/*
148	* The number of PFNs in a GPADL message is defined by the number of
149	* pages that would be spanned by ByteCount and ByteOffset. If the
150	* implied number of PFNs won't fit in this packet, there will be a
151	* follow-up packet that contains more.
152	*/
153	struct vmbus_channel_gpadl_header {
154	struct vmbus_channel_message_header Header;
155	u32 ChildRelId;
156	u32 Gpadl;
157	u16 RangeBufLen;
158	u16 RangeCount;
159	struct gpa_range Range[0];
160	} __attribute__((packed));
161
162	/* This is the followup packet that contains more PFNs. */
163	struct vmbus_channel_gpadl_body {
164	struct vmbus_channel_message_header Header;
165	u32 MessageNumber;
166	u32 Gpadl;
167	u64 Pfn[0];
168	} __attribute__((packed));
169
170	struct vmbus_channel_gpadl_created {
171	struct vmbus_channel_message_header Header;
172	u32 ChildRelId;
173	u32 Gpadl;
174	u32 CreationStatus;
175	} __attribute__((packed));
176
177	struct vmbus_channel_gpadl_teardown {
178	struct vmbus_channel_message_header Header;
179	u32 ChildRelId;
180	u32 Gpadl;
181	} __attribute__((packed));
182
183	struct vmbus_channel_gpadl_torndown {
184	struct vmbus_channel_message_header Header;
185	u32 Gpadl;
186	} __attribute__((packed));
187
188	#ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
189	struct vmbus_channel_view_range_add {
190	struct vmbus_channel_message_header Header;
191	PHYSICAL_ADDRESS ViewRangeBase;
192	u64 ViewRangeLength;
193	u32 ChildRelId;
194	} __attribute__((packed));
195
196	struct vmbus_channel_view_range_remove {
197	struct vmbus_channel_message_header Header;
198	PHYSICAL_ADDRESS ViewRangeBase;
199	u32 ChildRelId;
200	} __attribute__((packed));
201	#endif
202
203	struct vmbus_channel_relid_released {
204	struct vmbus_channel_message_header Header;
205	u32 ChildRelId;
206	} __attribute__((packed));
207
208	struct vmbus_channel_initiate_contact {
209	struct vmbus_channel_message_header Header;
210	u32 VMBusVersionRequested;
211	u32 Padding2;
212	u64 InterruptPage;
213	u64 MonitorPage1;
214	u64 MonitorPage2;
215	} __attribute__((packed));
216
217	struct vmbus_channel_version_response {
218	struct vmbus_channel_message_header Header;
219	bool VersionSupported;
220	} __attribute__((packed));
3e7ee490	221
b239549c	222	typedef void (PFN_CHANNEL_CALLBACK)(void context);
3e7ee490	223
aded7165	224	enum vmbus_channel_state {
3e7ee490 HJ	225	CHANNEL_OFFER_STATE,
	226	CHANNEL_OPENING_STATE,
	227	CHANNEL_OPEN_STATE,
aded7165	228	};
3e7ee490	229
aded7165	230	struct vmbus_channel {
b239549c	231	LIST_ENTRY ListEntry;
3e7ee490	232
3d3b5518	233	struct hv_device *DeviceObject;
3e7ee490	234
c8a429a4	235	struct timer_list poll_timer; /* SA-111 workaround */
3e7ee490	236
aded7165	237	enum vmbus_channel_state State;
3e7ee490	238
82250213	239	struct vmbus_channel_offer_channel OfferMsg;
b239549c GKH	240	/*
	241	* These are based on the OfferMsg.MonitorId.
	242	* Save it here for easy access.
	243	*/
	244	u8 MonitorGroup;
	245	u8 MonitorBit;
3e7ee490	246
b239549c	247	u32 RingBufferGpadlHandle;
3e7ee490	248
454f18a9	249	/* Allocated memory for ring buffer */
b239549c GKH	250	void *RingBufferPages;
	251	u32 RingBufferPageCount;
	252	RING_BUFFER_INFO Outbound; /* send to parent */
	253	RING_BUFFER_INFO Inbound; /* receive from parent */
54411c42	254	spinlock_t inbound_lock;
df8d9b1f	255	struct workqueue_struct *ControlWQ;
3e7ee490	256
454f18a9	257	/* Channel callback are invoked in this workqueue context */
b239549c	258	/* HANDLE dataWorkQueue; */
3e7ee490	259
b239549c GKH	260	PFN_CHANNEL_CALLBACK OnChannelCallback;
b239549c GKH	261	void *ChannelCallbackContext;
aded7165	262	};
3e7ee490	263
aded7165	264	struct vmbus_channel_debug_info {
b239549c	265	u32 RelId;
aded7165	266	enum vmbus_channel_state State;
caf26a31 GKH	267	struct hv_guid InterfaceType;
caf26a31 GKH	268	struct hv_guid InterfaceInstance;
b239549c GKH	269	u32 MonitorId;
	270	u32 ServerMonitorPending;
	271	u32 ServerMonitorLatency;
	272	u32 ServerMonitorConnectionId;
	273	u32 ClientMonitorPending;
	274	u32 ClientMonitorLatency;
	275	u32 ClientMonitorConnectionId;
	276
	277	RING_BUFFER_DEBUG_INFO Inbound;
	278	RING_BUFFER_DEBUG_INFO Outbound;
aded7165	279	};
3e7ee490	280
454f18a9 BP	281	/*
	282	* Represents each channel msg on the vmbus connection This is a
	283	* variable-size data structure depending on the msg type itself
	284	*/
aded7165	285	struct vmbus_channel_msginfo {
454f18a9	286	/* Bookkeeping stuff */
b239549c	287	LIST_ENTRY MsgListEntry;
3e7ee490	288
454f18a9	289	/* So far, this is only used to handle gpadl body message */
b239549c	290	LIST_ENTRY SubMsgList;
3e7ee490	291
454f18a9	292	/* Synchronize the request/response if needed */
aedb444a	293	struct osd_waitevent *WaitEvent;
3e7ee490	294
aded7165	295	union {
82250213 GKH	296	struct vmbus_channel_version_supported VersionSupported;
	297	struct vmbus_channel_open_result OpenResult;
	298	struct vmbus_channel_gpadl_torndown GpadlTorndown;
	299	struct vmbus_channel_gpadl_created GpadlCreated;
	300	struct vmbus_channel_version_response VersionResponse;
aded7165	301	} Response;
3e7ee490	302
b239549c GKH	303	u32 MessageSize;
	304	/*
	305	* The channel message that goes out on the "wire".
	306	* It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header
	307	*/
	308	unsigned char Msg[0];
aded7165	309	};
3e7ee490 HJ	310
3e7ee490 HJ	311
aded7165	312	struct vmbus_channel *AllocVmbusChannel(void);
3e7ee490	313
aded7165	314	void FreeVmbusChannel(struct vmbus_channel *Channel);
3e7ee490	315
b239549c	316	void VmbusOnChannelMessage(void *Context);
3e7ee490	317
b239549c	318	int VmbusChannelRequestOffers(void);
3e7ee490	319
b239549c	320	void VmbusChannelReleaseUnattachedChannels(void);
3e7ee490	321
454f18a9	322	#endif /* _CHANNEL_MGMT_H_ */