[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / staging / hv / vmbus_packet_format.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 _VMBUSPACKETFORMAT_H_
#define _VMBUSPACKETFORMAT_H_

struct vmpacket_descriptor {
	u16 Type;
	u16 DataOffset8;
	u16 Length8;
	u16 Flags;
	u64 TransactionId;
} __attribute__((packed));

struct vmpacket_header {
	u32 PreviousPacketStartOffset;
	struct vmpacket_descriptor Descriptor;
} __attribute__((packed));

struct vmtransfer_page_range {
	u32 ByteCount;
	u32 ByteOffset;
} __attribute__((packed));

struct vmtransfer_page_packet_header {
	struct vmpacket_descriptor d;
	u16 TransferPageSetId;
	bool SenderOwnsSet;
	u8 Reserved;
	u32 RangeCount;
	struct vmtransfer_page_range Ranges[1];
} __attribute__((packed));

struct vmgpadl_packet_header {
	struct vmpacket_descriptor d;
	u32 Gpadl;
	u32 Reserved;
} __attribute__((packed));

struct vmadd_remove_transfer_page_set {
	struct vmpacket_descriptor d;
	u32 Gpadl;
	u16 TransferPageSetId;
	u16 Reserved;
} __attribute__((packed));

/*
 * This structure defines a range in guest physical space that can be made to
 * look virtually contiguous.
 */
struct gpa_range {
	u32 ByteCount;
	u32 ByteOffset;
	u64 PfnArray[0];
};

/*
 * This is the format for an Establish Gpadl packet, which contains a handle by
 * which this GPADL will be known and a set of GPA ranges associated with it.
 * This can be converted to a MDL by the guest OS.  If there are multiple GPA
 * ranges, then the resulting MDL will be "chained," representing multiple VA
 * ranges.
 */
struct vmestablish_gpadl {
	struct vmpacket_descriptor d;
	u32 Gpadl;
	u32 RangeCount;
	struct gpa_range Range[1];
} __attribute__((packed));

/*
 * This is the format for a Teardown Gpadl packet, which indicates that the
 * GPADL handle in the Establish Gpadl packet will never be referenced again.
 */
struct vmteardown_gpadl {
	struct vmpacket_descriptor d;
	u32 Gpadl;
	u32 Reserved;	/* for alignment to a 8-byte boundary */
} __attribute__((packed));

/*
 * This is the format for a GPA-Direct packet, which contains a set of GPA
 * ranges, in addition to commands and/or data.
 */
struct vmdata_gpa_direct {
	struct vmpacket_descriptor d;
	u32 Reserved;
	u32 RangeCount;
	struct gpa_range Range[1];
} __attribute__((packed));

/* This is the format for a Additional Data Packet. */
struct vmadditional_data {
	struct vmpacket_descriptor d;
	u64 TotalBytes;
	u32 ByteOffset;
	u32 ByteCount;
	unsigned char Data[1];
} __attribute__((packed));

union vmpacket_largest_possible_header {
	struct vmpacket_descriptor SimpleHeader;
	struct vmtransfer_page_packet_header TransferPageHeader;
	struct vmgpadl_packet_header GpadlHeader;
	struct vmadd_remove_transfer_page_set AddRemoveTransferPageHeader;
	struct vmestablish_gpadl EstablishGpadlHeader;
	struct vmteardown_gpadl TeardownGpadlHeader;
	struct vmdata_gpa_direct DataGpaDirectHeader;
};

#define VMPACKET_DATA_START_ADDRESS(__packet)	\
	(void *)(((unsigned char *)__packet) +	\
	 ((struct vmpacket_descriptor)__packet)->DataOffset8 * 8)

#define VMPACKET_DATA_LENGTH(__packet)		\
	((((struct vmpacket_descriptor)__packet)->Length8 -	\
	  ((struct vmpacket_descriptor)__packet)->DataOffset8) * 8)

#define VMPACKET_TRANSFER_MODE(__packet)	\
	(((struct IMPACT)__packet)->Type)

enum vmbus_packet_type {
	VmbusPacketTypeInvalid				= 0x0,
	VmbusPacketTypeSynch				= 0x1,
	VmbusPacketTypeAddTransferPageSet		= 0x2,
	VmbusPacketTypeRemoveTransferPageSet		= 0x3,
	VmbusPacketTypeEstablishGpadl			= 0x4,
	VmbusPacketTypeTearDownGpadl			= 0x5,
	VmbusPacketTypeDataInBand			= 0x6,
	VmbusPacketTypeDataUsingTransferPages		= 0x7,
	VmbusPacketTypeDataUsingGpadl			= 0x8,
	VmbusPacketTypeDataUsingGpaDirect		= 0x9,
	VmbusPacketTypeCancelRequest			= 0xa,
	VmbusPacketTypeCompletion			= 0xb,
	VmbusPacketTypeDataUsingAdditionalPackets	= 0xc,
	VmbusPacketTypeAdditionalData			= 0xd
};

#define VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED	1

#endif
Commit	Line	Data
565e7dc8 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
4bedd6be	24	#ifndef _VMBUSPACKETFORMAT_H_
c88c4e4c	25	#define _VMBUSPACKETFORMAT_H_
565e7dc8	26
8dc0a06a	27	struct vmpacket_descriptor {
4bedd6be GKH	28	u16 Type;
	29	u16 DataOffset8;
	30	u16 Length8;
	31	u16 Flags;
	32	u64 TransactionId;
8dc0a06a	33	} __attribute__((packed));
565e7dc8	34
8dc0a06a GKH	35	struct vmpacket_header {
	36	u32 PreviousPacketStartOffset;
	37	struct vmpacket_descriptor Descriptor;
	38	} __attribute__((packed));
565e7dc8	39
8dc0a06a	40	struct vmtransfer_page_range {
4bedd6be GKH	41	u32 ByteCount;
4bedd6be GKH	42	u32 ByteOffset;
8dc0a06a	43	} __attribute__((packed));
565e7dc8	44
8dc0a06a GKH	45	struct vmtransfer_page_packet_header {
8dc0a06a GKH	46	struct vmpacket_descriptor d;
4bedd6be GKH	47	u16 TransferPageSetId;
	48	bool SenderOwnsSet;
	49	u8 Reserved;
	50	u32 RangeCount;
8dc0a06a GKH	51	struct vmtransfer_page_range Ranges[1];
8dc0a06a GKH	52	} __attribute__((packed));
565e7dc8	53
8dc0a06a GKH	54	struct vmgpadl_packet_header {
8dc0a06a GKH	55	struct vmpacket_descriptor d;
4bedd6be GKH	56	u32 Gpadl;
4bedd6be GKH	57	u32 Reserved;
8dc0a06a	58	} __attribute__((packed));
565e7dc8	59
8dc0a06a GKH	60	struct vmadd_remove_transfer_page_set {
8dc0a06a GKH	61	struct vmpacket_descriptor d;
4bedd6be GKH	62	u32 Gpadl;
	63	u16 TransferPageSetId;
	64	u16 Reserved;
8dc0a06a	65	} __attribute__((packed));
565e7dc8	66
4bedd6be GKH	67	/*
	68	* This structure defines a range in guest physical space that can be made to
	69	* look virtually contiguous.
	70	*/
8dc0a06a	71	struct gpa_range {
4bedd6be GKH	72	u32 ByteCount;
	73	u32 ByteOffset;
	74	u64 PfnArray[0];
8dc0a06a	75	};
565e7dc8	76
4bedd6be GKH	77	/*
	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
	82	* ranges.
	83	*/
8dc0a06a GKH	84	struct vmestablish_gpadl {
8dc0a06a GKH	85	struct vmpacket_descriptor d;
4bedd6be GKH	86	u32 Gpadl;
4bedd6be GKH	87	u32 RangeCount;
8dc0a06a GKH	88	struct gpa_range Range[1];
8dc0a06a GKH	89	} __attribute__((packed));
565e7dc8	90
4bedd6be GKH	91	/*
	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.
	94	*/
8dc0a06a GKH	95	struct vmteardown_gpadl {
8dc0a06a GKH	96	struct vmpacket_descriptor d;
4bedd6be GKH	97	u32 Gpadl;
4bedd6be GKH	98	u32 Reserved; /* for alignment to a 8-byte boundary */
8dc0a06a	99	} __attribute__((packed));
565e7dc8	100
4bedd6be GKH	101	/*
	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.
	104	*/
8dc0a06a GKH	105	struct vmdata_gpa_direct {
8dc0a06a GKH	106	struct vmpacket_descriptor d;
4bedd6be GKH	107	u32 Reserved;
4bedd6be GKH	108	u32 RangeCount;
8dc0a06a GKH	109	struct gpa_range Range[1];
8dc0a06a GKH	110	} __attribute__((packed));
454f18a9 BP	111
454f18a9 BP	112	/* This is the format for a Additional Data Packet. */
8dc0a06a GKH	113	struct vmadditional_data {
8dc0a06a GKH	114	struct vmpacket_descriptor d;
4bedd6be GKH	115	u64 TotalBytes;
	116	u32 ByteOffset;
	117	u32 ByteCount;
	118	unsigned char Data[1];
8dc0a06a GKH	119	} __attribute__((packed));
	120
	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;
	129	};
565e7dc8	130
4bedd6be GKH	131	#define VMPACKET_DATA_START_ADDRESS(__packet) \
4bedd6be GKH	132	(void )(((unsigned char )__packet) + \
8dc0a06a	133	((struct vmpacket_descriptor)__packet)->DataOffset8 * 8)
565e7dc8	134
4bedd6be	135	#define VMPACKET_DATA_LENGTH(__packet) \
8dc0a06a GKH	136	((((struct vmpacket_descriptor)__packet)->Length8 - \
8dc0a06a GKH	137	((struct vmpacket_descriptor)__packet)->DataOffset8) * 8)
565e7dc8	138
4bedd6be	139	#define VMPACKET_TRANSFER_MODE(__packet) \
8dc0a06a	140	(((struct IMPACT)__packet)->Type)
565e7dc8	141
8dc0a06a	142	enum vmbus_packet_type {
4bedd6be GKH	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
8dc0a06a	157	};
565e7dc8	158
4bedd6be GKH	159	#define VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED 1
	160
	161	#endif