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>
24 #ifndef __CHANNELMESSAGES_H
25 #define __CHANNELMESSAGES_H
27 #include "VmbusPacketFormat.h"
29 /* Version 1 messages */
30 enum vmbus_channel_message_type
{
31 ChannelMessageInvalid
= 0,
32 ChannelMessageOfferChannel
= 1,
33 ChannelMessageRescindChannelOffer
= 2,
34 ChannelMessageRequestOffers
= 3,
35 ChannelMessageAllOffersDelivered
= 4,
36 ChannelMessageOpenChannel
= 5,
37 ChannelMessageOpenChannelResult
= 6,
38 ChannelMessageCloseChannel
= 7,
39 ChannelMessageGpadlHeader
= 8,
40 ChannelMessageGpadlBody
= 9,
41 ChannelMessageGpadlCreated
= 10,
42 ChannelMessageGpadlTeardown
= 11,
43 ChannelMessageGpadlTorndown
= 12,
44 ChannelMessageRelIdReleased
= 13,
45 ChannelMessageInitiateContact
= 14,
46 ChannelMessageVersionResponse
= 15,
47 ChannelMessageUnload
= 16,
48 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
49 ChannelMessageViewRangeAdd
= 17,
50 ChannelMessageViewRangeRemove
= 18,
53 } __attribute__((packed
));
55 struct vmbus_channel_message_header
{
56 enum vmbus_channel_message_type MessageType
;
58 } __attribute__((packed
));
60 /* Query VMBus Version parameters */
61 struct vmbus_channel_query_vmbus_version
{
62 struct vmbus_channel_message_header Header
;
64 } __attribute__((packed
));
66 /* VMBus Version Supported parameters */
67 struct vmbus_channel_version_supported
{
68 struct vmbus_channel_message_header Header
;
69 bool VersionSupported
;
70 } __attribute__((packed
));
72 /* Offer Channel parameters */
73 struct vmbus_channel_offer_channel
{
74 struct vmbus_channel_message_header Header
;
75 struct vmbus_channel_offer Offer
;
78 bool MonitorAllocated
;
79 } __attribute__((packed
));
81 /* Rescind Offer parameters */
82 struct vmbus_channel_rescind_offer
{
83 struct vmbus_channel_message_header Header
;
85 } __attribute__((packed
));
88 * Request Offer -- no parameters, SynIC message contains the partition ID
89 * Set Snoop -- no parameters, SynIC message contains the partition ID
90 * Clear Snoop -- no parameters, SynIC message contains the partition ID
91 * All Offers Delivered -- no parameters, SynIC message contains the partition
93 * Flush Client -- no parameters, SynIC message contains the partition ID
96 /* Open Channel parameters */
97 struct vmbus_channel_open_channel
{
98 struct vmbus_channel_message_header Header
;
100 /* Identifies the specific VMBus channel that is being opened. */
103 /* ID making a particular open request at a channel offer unique. */
106 /* GPADL for the channel's ring buffer. */
107 u32 RingBufferGpadlHandle
;
109 /* GPADL for the channel's server context save area. */
110 u32 ServerContextAreaGpadlHandle
;
113 * The upstream ring buffer begins at offset zero in the memory
114 * described by RingBufferGpadlHandle. The downstream ring buffer
115 * follows it at this offset (in pages).
117 u32 DownstreamRingBufferPageOffset
;
119 /* User-specific data to be passed along to the server endpoint. */
120 unsigned char UserData
[MAX_USER_DEFINED_BYTES
];
121 } __attribute__((packed
));
123 /* Open Channel Result parameters */
124 struct vmbus_channel_open_result
{
125 struct vmbus_channel_message_header Header
;
129 } __attribute__((packed
));
131 /* Close channel parameters; */
132 struct vmbus_channel_close_channel
{
133 struct vmbus_channel_message_header Header
;
135 } __attribute__((packed
));
137 /* Channel Message GPADL */
138 #define GPADL_TYPE_RING_BUFFER 1
139 #define GPADL_TYPE_SERVER_SAVE_AREA 2
140 #define GPADL_TYPE_TRANSACTION 8
143 * The number of PFNs in a GPADL message is defined by the number of
144 * pages that would be spanned by ByteCount and ByteOffset. If the
145 * implied number of PFNs won't fit in this packet, there will be a
146 * follow-up packet that contains more.
148 struct vmbus_channel_gpadl_header
{
149 struct vmbus_channel_message_header Header
;
154 struct gpa_range Range
[0];
155 } __attribute__((packed
));
157 /* This is the followup packet that contains more PFNs. */
158 struct vmbus_channel_gpadl_body
{
159 struct vmbus_channel_message_header Header
;
163 } __attribute__((packed
));
165 struct vmbus_channel_gpadl_created
{
166 struct vmbus_channel_message_header Header
;
170 } __attribute__((packed
));
172 struct vmbus_channel_gpadl_teardown
{
173 struct vmbus_channel_message_header Header
;
176 } __attribute__((packed
));
178 struct vmbus_channel_gpadl_torndown
{
179 struct vmbus_channel_message_header Header
;
181 } __attribute__((packed
));
183 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
184 struct vmbus_channel_view_range_add
{
185 struct vmbus_channel_message_header Header
;
186 PHYSICAL_ADDRESS ViewRangeBase
;
189 } __attribute__((packed
));
191 struct vmbus_channel_view_range_remove
{
192 struct vmbus_channel_message_header Header
;
193 PHYSICAL_ADDRESS ViewRangeBase
;
195 } __attribute__((packed
));
198 struct vmbus_channel_relid_released
{
199 struct vmbus_channel_message_header Header
;
201 } __attribute__((packed
));
203 struct vmbus_channel_initiate_contact
{
204 struct vmbus_channel_message_header Header
;
205 u32 VMBusVersionRequested
;
210 } __attribute__((packed
));
212 struct vmbus_channel_version_response
{
213 struct vmbus_channel_message_header Header
;
214 bool VersionSupported
;
215 } __attribute__((packed
));