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 _VMBUSPACKETFORMAT_H_
25 #define _VMBUSPACKETFORMAT_H_
27 struct vmpacket_descriptor
{
33 } __attribute__((packed
));
35 struct vmpacket_header
{
36 u32 PreviousPacketStartOffset
;
37 struct vmpacket_descriptor Descriptor
;
38 } __attribute__((packed
));
40 struct vmtransfer_page_range
{
43 } __attribute__((packed
));
45 struct vmtransfer_page_packet_header
{
46 struct vmpacket_descriptor d
;
47 u16 TransferPageSetId
;
51 struct vmtransfer_page_range Ranges
[1];
52 } __attribute__((packed
));
54 struct vmgpadl_packet_header
{
55 struct vmpacket_descriptor d
;
58 } __attribute__((packed
));
60 struct vmadd_remove_transfer_page_set
{
61 struct vmpacket_descriptor d
;
63 u16 TransferPageSetId
;
65 } __attribute__((packed
));
68 * This structure defines a range in guest physical space that can be made to
69 * look virtually contiguous.
78 * This is the format for an Establish Gpadl packet, which contains a handle by
79 * which this GPADL will be known and a set of GPA ranges associated with it.
80 * This can be converted to a MDL by the guest OS. If there are multiple GPA
81 * ranges, then the resulting MDL will be "chained," representing multiple VA
84 struct vmestablish_gpadl
{
85 struct vmpacket_descriptor d
;
88 struct gpa_range Range
[1];
89 } __attribute__((packed
));
92 * This is the format for a Teardown Gpadl packet, which indicates that the
93 * GPADL handle in the Establish Gpadl packet will never be referenced again.
95 struct vmteardown_gpadl
{
96 struct vmpacket_descriptor d
;
98 u32 Reserved
; /* for alignment to a 8-byte boundary */
99 } __attribute__((packed
));
102 * This is the format for a GPA-Direct packet, which contains a set of GPA
103 * ranges, in addition to commands and/or data.
105 struct vmdata_gpa_direct
{
106 struct vmpacket_descriptor d
;
109 struct gpa_range Range
[1];
110 } __attribute__((packed
));
112 /* This is the format for a Additional Data Packet. */
113 struct vmadditional_data
{
114 struct vmpacket_descriptor d
;
118 unsigned char Data
[1];
119 } __attribute__((packed
));
121 union vmpacket_largest_possible_header
{
122 struct vmpacket_descriptor SimpleHeader
;
123 struct vmtransfer_page_packet_header TransferPageHeader
;
124 struct vmgpadl_packet_header GpadlHeader
;
125 struct vmadd_remove_transfer_page_set AddRemoveTransferPageHeader
;
126 struct vmestablish_gpadl EstablishGpadlHeader
;
127 struct vmteardown_gpadl TeardownGpadlHeader
;
128 struct vmdata_gpa_direct DataGpaDirectHeader
;
131 #define VMPACKET_DATA_START_ADDRESS(__packet) \
132 (void *)(((unsigned char *)__packet) + \
133 ((struct vmpacket_descriptor)__packet)->DataOffset8 * 8)
135 #define VMPACKET_DATA_LENGTH(__packet) \
136 ((((struct vmpacket_descriptor)__packet)->Length8 - \
137 ((struct vmpacket_descriptor)__packet)->DataOffset8) * 8)
139 #define VMPACKET_TRANSFER_MODE(__packet) \
140 (((struct IMPACT)__packet)->Type)
142 enum vmbus_packet_type
{
143 VmbusPacketTypeInvalid
= 0x0,
144 VmbusPacketTypeSynch
= 0x1,
145 VmbusPacketTypeAddTransferPageSet
= 0x2,
146 VmbusPacketTypeRemoveTransferPageSet
= 0x3,
147 VmbusPacketTypeEstablishGpadl
= 0x4,
148 VmbusPacketTypeTearDownGpadl
= 0x5,
149 VmbusPacketTypeDataInBand
= 0x6,
150 VmbusPacketTypeDataUsingTransferPages
= 0x7,
151 VmbusPacketTypeDataUsingGpadl
= 0x8,
152 VmbusPacketTypeDataUsingGpaDirect
= 0x9,
153 VmbusPacketTypeCancelRequest
= 0xa,
154 VmbusPacketTypeCompletion
= 0xb,
155 VmbusPacketTypeDataUsingAdditionalPackets
= 0xc,
156 VmbusPacketTypeAdditionalData
= 0xd
159 #define VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED 1