2009-07-14 00:15:47 +02:00
|
|
|
/*
|
|
|
|
*
|
|
|
|
* 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>
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2009-07-14 02:09:34 +02:00
|
|
|
#include "VmbusPacketFormat.h"
|
2009-07-14 00:15:47 +02:00
|
|
|
|
|
|
|
#define C_ASSERT(x)
|
2009-07-15 00:09:36 +02:00
|
|
|
typedef u32 NTSTATUS;
|
2009-07-14 00:15:47 +02:00
|
|
|
|
|
|
|
#pragma pack(push,1)
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
|
|
|
|
/* Version 1 messages */
|
|
|
|
|
2009-07-14 00:15:47 +02:00
|
|
|
|
|
|
|
typedef 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
|
|
|
|
} VMBUS_CHANNEL_MESSAGE_TYPE, *PVMBUS_CHANNEL_MESSAGE_TYPE;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
/* begin_wpp config */
|
|
|
|
/* CUSTOM_TYPE(ChannelMessageType, ItemEnum(_VMBUS_CHANNEL_MESSAGE_TYPE)); */
|
|
|
|
/* end_wpp */
|
2009-07-14 00:15:47 +02:00
|
|
|
|
|
|
|
typedef struct _VMBUS_CHANNEL_MESSAGE_HEADER
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_TYPE MessageType;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 Padding;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_MESSAGE_HEADER, *PVMBUS_CHANNEL_MESSAGE_HEADER;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
/* Query VMBus Version parameters */
|
2009-07-14 00:15:47 +02:00
|
|
|
typedef struct _VMBUS_CHANNEL_QUERY_VMBUS_VERSION
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 Version;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_QUERY_VMBUS_VERSION, *PVMBUS_CHANNEL_QUERY_VMBUS_VERSION;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
/* VMBus Version Supported parameters */
|
2009-07-14 00:15:47 +02:00
|
|
|
typedef struct _VMBUS_CHANNEL_VERSION_SUPPORTED
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
2009-07-15 00:13:46 +02:00
|
|
|
bool VersionSupported;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_VERSION_SUPPORTED, *PVMBUS_CHANNEL_VERSION_SUPPORTED;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
/* Offer Channel parameters */
|
2009-07-14 00:15:47 +02:00
|
|
|
typedef struct _VMBUS_CHANNEL_OFFER_CHANNEL
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
|
|
|
VMBUS_CHANNEL_OFFER Offer;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 ChildRelId;
|
2009-07-15 00:08:20 +02:00
|
|
|
u8 MonitorId;
|
2009-07-15 00:13:46 +02:00
|
|
|
bool MonitorAllocated;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_OFFER_CHANNEL, *PVMBUS_CHANNEL_OFFER_CHANNEL;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
|
|
|
|
/* Make sure VMBUS_CHANNEL_OFFER_CHANNEL fits into Synic message. */
|
|
|
|
|
2009-07-14 00:15:47 +02:00
|
|
|
C_ASSERT(sizeof(VMBUS_CHANNEL_OFFER_CHANNEL) <= MAXIMUM_SYNIC_MESSAGE_BYTES);
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
/* Rescind Offer parameters */
|
2009-07-14 00:15:47 +02:00
|
|
|
typedef struct _VMBUS_CHANNEL_RESCIND_OFFER
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 ChildRelId;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_RESCIND_OFFER, *PVMBUS_CHANNEL_RESCIND_OFFER;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
/* 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 */
|
2009-07-14 00:15:47 +02:00
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
/* Open Channel parameters */
|
2009-07-14 00:15:47 +02:00
|
|
|
typedef struct _VMBUS_CHANNEL_OPEN_CHANNEL
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
|
|
|
|
/* Identifies the specific VMBus channel that is being opened. */
|
|
|
|
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 ChildRelId;
|
2009-07-14 00:15:47 +02:00
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
|
|
|
|
/* ID making a particular open request at a channel offer unique. */
|
|
|
|
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 OpenId;
|
2009-07-14 00:15:47 +02:00
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
|
|
|
|
/* GPADL for the channel's ring buffer. */
|
|
|
|
|
2009-07-14 00:15:47 +02:00
|
|
|
GPADL_HANDLE RingBufferGpadlHandle;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
|
|
|
|
/* GPADL for the channel's server context save area. */
|
|
|
|
|
2009-07-14 00:15:47 +02:00
|
|
|
GPADL_HANDLE ServerContextAreaGpadlHandle;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
|
|
|
|
/*
|
|
|
|
* 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).
|
|
|
|
*/
|
|
|
|
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 DownstreamRingBufferPageOffset;
|
2009-07-14 00:15:47 +02:00
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
|
|
|
|
/* User-specific data to be passed along to the server endpoint. */
|
|
|
|
|
2009-07-15 00:10:26 +02:00
|
|
|
unsigned char UserData[MAX_USER_DEFINED_BYTES];
|
2009-07-14 00:15:47 +02:00
|
|
|
|
|
|
|
} VMBUS_CHANNEL_OPEN_CHANNEL, *PVMBUS_CHANNEL_OPEN_CHANNEL;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
/* Reopen Channel parameters; */
|
2009-07-14 00:15:47 +02:00
|
|
|
typedef VMBUS_CHANNEL_OPEN_CHANNEL VMBUS_CHANNEL_REOPEN_CHANNEL, *PVMBUS_CHANNEL_REOPEN_CHANNEL;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
/* Open Channel Result parameters */
|
2009-07-14 00:15:47 +02:00
|
|
|
typedef struct _VMBUS_CHANNEL_OPEN_RESULT
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 ChildRelId;
|
|
|
|
u32 OpenId;
|
2009-07-14 00:15:47 +02:00
|
|
|
NTSTATUS Status;
|
|
|
|
} VMBUS_CHANNEL_OPEN_RESULT, *PVMBUS_CHANNEL_OPEN_RESULT;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
/* Close channel parameters; */
|
2009-07-14 00:15:47 +02:00
|
|
|
typedef struct _VMBUS_CHANNEL_CLOSE_CHANNEL
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 ChildRelId;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_CLOSE_CHANNEL, *PVMBUS_CHANNEL_CLOSE_CHANNEL;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
/* Channel Message GPADL */
|
2009-07-14 00:15:47 +02:00
|
|
|
#define GPADL_TYPE_RING_BUFFER 1
|
|
|
|
#define GPADL_TYPE_SERVER_SAVE_AREA 2
|
|
|
|
#define GPADL_TYPE_TRANSACTION 8
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
|
|
|
|
/*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2009-07-14 00:15:47 +02:00
|
|
|
|
|
|
|
typedef struct _VMBUS_CHANNEL_GPADL_HEADER
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 ChildRelId;
|
|
|
|
u32 Gpadl;
|
2009-07-15 00:09:10 +02:00
|
|
|
u16 RangeBufLen;
|
|
|
|
u16 RangeCount;
|
2009-07-14 00:15:47 +02:00
|
|
|
GPA_RANGE Range[0];
|
|
|
|
} VMBUS_CHANNEL_GPADL_HEADER, *PVMBUS_CHANNEL_GPADL_HEADER;
|
|
|
|
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
|
|
|
|
/* This is the followup packet that contains more PFNs. */
|
|
|
|
|
2009-07-14 00:15:47 +02:00
|
|
|
|
|
|
|
typedef struct _VMBUS_CHANNEL_GPADL_BODY
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 MessageNumber;
|
|
|
|
u32 Gpadl;
|
2009-07-15 00:10:26 +02:00
|
|
|
u64 Pfn[0];
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_GPADL_BODY, *PVMBUS_CHANNEL_GPADL_BODY;
|
|
|
|
|
|
|
|
|
|
|
|
typedef struct _VMBUS_CHANNEL_GPADL_CREATED
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 ChildRelId;
|
|
|
|
u32 Gpadl;
|
|
|
|
u32 CreationStatus;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_GPADL_CREATED, *PVMBUS_CHANNEL_GPADL_CREATED;
|
|
|
|
|
|
|
|
typedef struct _VMBUS_CHANNEL_GPADL_TEARDOWN
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 ChildRelId;
|
|
|
|
u32 Gpadl;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_GPADL_TEARDOWN, *PVMBUS_CHANNEL_GPADL_TEARDOWN;
|
|
|
|
|
|
|
|
typedef struct _VMBUS_CHANNEL_GPADL_TORNDOWN
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 Gpadl;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_GPADL_TORNDOWN, *PVMBUS_CHANNEL_GPADL_TORNDOWN;
|
|
|
|
|
|
|
|
#ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
|
|
|
|
typedef struct _VMBUS_CHANNEL_VIEW_RANGE_ADD
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
|
|
|
PHYSICAL_ADDRESS ViewRangeBase;
|
2009-07-15 00:10:26 +02:00
|
|
|
u64 ViewRangeLength;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 ChildRelId;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_VIEW_RANGE_ADD, *PVMBUS_CHANNEL_VIEW_RANGE_ADD;
|
|
|
|
|
|
|
|
typedef struct _VMBUS_CHANNEL_VIEW_RANGE_REMOVE
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
|
|
|
PHYSICAL_ADDRESS ViewRangeBase;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 ChildRelId;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_VIEW_RANGE_REMOVE, *PVMBUS_CHANNEL_VIEW_RANGE_REMOVE;
|
|
|
|
#endif
|
|
|
|
|
|
|
|
typedef struct _VMBUS_CHANNEL_RELID_RELEASED
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 ChildRelId;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_RELID_RELEASED, *PVMBUS_CHANNEL_RELID_RELEASED;
|
|
|
|
|
|
|
|
typedef struct _VMBUS_CHANNEL_INITIATE_CONTACT
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
2009-07-15 00:09:36 +02:00
|
|
|
u32 VMBusVersionRequested;
|
|
|
|
u32 Padding2;
|
2009-07-15 00:10:26 +02:00
|
|
|
u64 InterruptPage;
|
|
|
|
u64 MonitorPage1;
|
|
|
|
u64 MonitorPage2;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_INITIATE_CONTACT, *PVMBUS_CHANNEL_INITIATE_CONTACT;
|
|
|
|
|
|
|
|
typedef struct _VMBUS_CHANNEL_VERSION_RESPONSE
|
|
|
|
{
|
|
|
|
VMBUS_CHANNEL_MESSAGE_HEADER Header;
|
2009-07-15 00:13:46 +02:00
|
|
|
bool VersionSupported;
|
2009-07-14 00:15:47 +02:00
|
|
|
} VMBUS_CHANNEL_VERSION_RESPONSE, *PVMBUS_CHANNEL_VERSION_RESPONSE;
|
|
|
|
|
|
|
|
typedef VMBUS_CHANNEL_MESSAGE_HEADER VMBUS_CHANNEL_UNLOAD, *PVMBUS_CHANNEL_UNLOAD;
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
|
|
|
|
/* Kind of a table to use the preprocessor to get us the right type for a */
|
|
|
|
/* specified message ID. Used with ChAllocateSendMessage() */
|
|
|
|
|
2009-07-14 00:15:47 +02:00
|
|
|
#define ChannelMessageQueryVmbusVersion_TYPE VMBUS_CHANNEL_MESSAGE_HEADER
|
|
|
|
#define ChannelMessageVmbusVersionSupported_TYPE VMBUS_CHANNEL_VERSION_SUPPORTED
|
|
|
|
#define ChannelMessageOfferChannel_TYPE VMBUS_CHANNEL_OFFER_CHANNEL
|
|
|
|
#define ChannelMessageRescindChannelOffer_TYPE VMBUS_CHANNEL_RESCIND_OFFER
|
|
|
|
#define ChannelMessageRequestOffers_TYPE VMBUS_CHANNEL_MESSAGE_HEADER
|
|
|
|
#define ChannelMessageAllOffersDelivered_TYPE VMBUS_CHANNEL_MESSAGE_HEADER
|
|
|
|
#define ChannelMessageOpenChannel_TYPE VMBUS_CHANNEL_OPEN_CHANNEL
|
|
|
|
#define ChannelMessageOpenChannelResult_TYPE VMBUS_CHANNEL_OPEN_RESULT
|
|
|
|
#define ChannelMessageCloseChannel_TYPE VMBUS_CHANNEL_CLOSE_CHANNEL
|
|
|
|
#define ChannelMessageAllGpadlsUnmapped_TYPE VMBUS_CHANNEL_CLOSE_CHANNEL
|
|
|
|
#define ChannelMessageGpadlHeader_TYPE VMBUS_CHANNEL_GPADL_HEADER
|
|
|
|
#define ChannelMessageGpadlBody_TYPE VMBUS_CHANNEL_GPADL_BODY
|
|
|
|
#define ChannelMessageGpadlCreated_TYPE VMBUS_CHANNEL_GPADL_CREATED
|
|
|
|
#define ChannelMessageGpadlTeardown_TYPE VMBUS_CHANNEL_GPADL_TEARDOWN
|
|
|
|
#define ChannelMessageGpadlTorndown_TYPE VMBUS_CHANNEL_GPADL_TORNDOWN
|
|
|
|
#define ChannelMessageViewRangeAdd_TYPE VMBUS_CHANNEL_VIEW_RANGE_ADD
|
|
|
|
#define ChannelMessageViewRangeRemove_TYPE VMBUS_CHANNEL_VIEW_RANGE_REMOVE
|
|
|
|
#define ChannelMessageRelIdReleased_TYPE VMBUS_CHANNEL_RELID_RELEASED
|
|
|
|
#define ChannelMessageInitiateContact_TYPE VMBUS_CHANNEL_INITIATE_CONTACT
|
|
|
|
#define ChannelMessageVersionResponse_TYPE VMBUS_CHANNEL_VERSION_RESPONSE
|
|
|
|
#define ChannelMessageUnload_TYPE VMBUS_CHANNEL_UNLOAD
|
|
|
|
|
2009-07-27 22:47:24 +02:00
|
|
|
|
|
|
|
/* Preprocessor wrapper to ChAllocateSendMessageSize() converting the return */
|
|
|
|
/* value to the correct pointer and calculate the needed size. */
|
|
|
|
|
|
|
|
/* Argument: */
|
|
|
|
|
|
|
|
/* Id - the numberic ID (type VMBUS_CHANNEL_MESSAGE_TYPE) of the message to */
|
|
|
|
/* send. */
|
|
|
|
|
2009-07-14 00:15:47 +02:00
|
|
|
#define ChAllocateSendMessage(Id, Fn, Context) \
|
|
|
|
(Id##_TYPE*)ChAllocateSendMessageSized(sizeof(Id##_TYPE), Id, Fn, Context)
|
|
|
|
|
|
|
|
|
|
|
|
#pragma pack(pop)
|