[deliverable/linux.git] / drivers / hv / hyperv_vmbus.h

/*
 *
 * Copyright (c) 2011, 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>
 *   K. Y. Srinivasan <kys@microsoft.com>
 *
 */

#ifndef _HYPERV_VMBUS_H
#define _HYPERV_VMBUS_H

#include <linux/list.h>
#include <asm/sync_bitops.h>
#include <linux/atomic.h>
#include <linux/hyperv.h>

/*
 * The below CPUID leaves are present if VersionAndFeatures.HypervisorPresent
 * is set by CPUID(HVCPUID_VERSION_FEATURES).
 */
enum hv_cpuid_function {
	HVCPUID_VERSION_FEATURES		= 0x00000001,
	HVCPUID_VENDOR_MAXFUNCTION		= 0x40000000,
	HVCPUID_INTERFACE			= 0x40000001,

	/*
	 * The remaining functions depend on the value of
	 * HVCPUID_INTERFACE
	 */
	HVCPUID_VERSION			= 0x40000002,
	HVCPUID_FEATURES			= 0x40000003,
	HVCPUID_ENLIGHTENMENT_INFO	= 0x40000004,
	HVCPUID_IMPLEMENTATION_LIMITS		= 0x40000005,
};

/* Define version of the synthetic interrupt controller. */
#define HV_SYNIC_VERSION		(1)

/* Define the expected SynIC version. */
#define HV_SYNIC_VERSION_1		(0x1)

/* Define synthetic interrupt controller message constants. */
#define HV_MESSAGE_SIZE			(256)
#define HV_MESSAGE_PAYLOAD_BYTE_COUNT	(240)
#define HV_MESSAGE_PAYLOAD_QWORD_COUNT	(30)
#define HV_ANY_VP			(0xFFFFFFFF)

/* Define synthetic interrupt controller flag constants. */
#define HV_EVENT_FLAGS_COUNT		(256 * 8)
#define HV_EVENT_FLAGS_BYTE_COUNT	(256)
#define HV_EVENT_FLAGS_DWORD_COUNT	(256 / sizeof(u32))

/* Define hypervisor message types. */
enum hv_message_type {
	HVMSG_NONE			= 0x00000000,

	/* Memory access messages. */
	HVMSG_UNMAPPED_GPA		= 0x80000000,
	HVMSG_GPA_INTERCEPT		= 0x80000001,

	/* Timer notification messages. */
	HVMSG_TIMER_EXPIRED			= 0x80000010,

	/* Error messages. */
	HVMSG_INVALID_VP_REGISTER_VALUE	= 0x80000020,
	HVMSG_UNRECOVERABLE_EXCEPTION	= 0x80000021,
	HVMSG_UNSUPPORTED_FEATURE		= 0x80000022,

	/* Trace buffer complete messages. */
	HVMSG_EVENTLOG_BUFFERCOMPLETE	= 0x80000040,

	/* Platform-specific processor intercept messages. */
	HVMSG_X64_IOPORT_INTERCEPT		= 0x80010000,
	HVMSG_X64_MSR_INTERCEPT		= 0x80010001,
	HVMSG_X64_CPUID_INTERCEPT		= 0x80010002,
	HVMSG_X64_EXCEPTION_INTERCEPT	= 0x80010003,
	HVMSG_X64_APIC_EOI			= 0x80010004,
	HVMSG_X64_LEGACY_FP_ERROR		= 0x80010005
};

/* Define the number of synthetic interrupt sources. */
#define HV_SYNIC_SINT_COUNT		(16)
#define HV_SYNIC_STIMER_COUNT		(4)

/* Define invalid partition identifier. */
#define HV_PARTITION_ID_INVALID		((u64)0x0)

/* Define connection identifier type. */
union hv_connection_id {
	u32 asu32;
	struct {
		u32 id:24;
		u32 reserved:8;
	} u;
};

/* Define port identifier type. */
union hv_port_id {
	u32 asu32;
	struct {
		u32 id:24;
		u32 reserved:8;
	} u ;
};

/* Define port type. */
enum hv_port_type {
	HVPORT_MSG	= 1,
	HVPORT_EVENT		= 2,
	HVPORT_MONITOR	= 3
};

/* Define port information structure. */
struct hv_port_info {
	enum hv_port_type port_type;
	u32 padding;
	union {
		struct {
			u32 target_sint;
			u32 target_vp;
			u64 rsvdz;
		} message_port_info;
		struct {
			u32 target_sint;
			u32 target_vp;
			u16 base_flag_bumber;
			u16 flag_count;
			u32 rsvdz;
		} event_port_info;
		struct {
			u64 monitor_address;
			u64 rsvdz;
		} monitor_port_info;
	};
};

struct hv_connection_info {
	enum hv_port_type port_type;
	u32 padding;
	union {
		struct {
			u64 rsvdz;
		} message_connection_info;
		struct {
			u64 rsvdz;
		} event_connection_info;
		struct {
			u64 monitor_address;
		} monitor_connection_info;
	};
};

/* Define synthetic interrupt controller message flags. */
union hv_message_flags {
	u8 asu8;
	struct {
		u8 msg_pending:1;
		u8 reserved:7;
	};
};

/* Define synthetic interrupt controller message header. */
struct hv_message_header {
	enum hv_message_type message_type;
	u8 payload_size;
	union hv_message_flags message_flags;
	u8 reserved[2];
	union {
		u64 sender;
		union hv_port_id port;
	};
};

/* Define timer message payload structure. */
struct hv_timer_message_payload {
	u32 timer_index;
	u32 reserved;
	u64 expiration_time;	/* When the timer expired */
	u64 delivery_time;	/* When the message was delivered */
};

/* Define synthetic interrupt controller message format. */
struct hv_message {
	struct hv_message_header header;
	union {
		u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
	} u ;
};

/* Define the number of message buffers associated with each port. */
#define HV_PORT_MESSAGE_BUFFER_COUNT	(16)

/* Define the synthetic interrupt message page layout. */
struct hv_message_page {
	struct hv_message sint_message[HV_SYNIC_SINT_COUNT];
};

/* Define the synthetic interrupt controller event flags format. */
union hv_synic_event_flags {
	u8 flags8[HV_EVENT_FLAGS_BYTE_COUNT];
	u32 flags32[HV_EVENT_FLAGS_DWORD_COUNT];
};

/* Define the synthetic interrupt flags page layout. */
struct hv_synic_event_flags_page {
	union hv_synic_event_flags sintevent_flags[HV_SYNIC_SINT_COUNT];
};

/* Define SynIC control register. */
union hv_synic_scontrol {
	u64 as_uint64;
	struct {
		u64 enable:1;
		u64 reserved:63;
	};
};

/* Define synthetic interrupt source. */
union hv_synic_sint {
	u64 as_uint64;
	struct {
		u64 vector:8;
		u64 reserved1:8;
		u64 masked:1;
		u64 auto_eoi:1;
		u64 reserved2:46;
	};
};

/* Define the format of the SIMP register */
union hv_synic_simp {
	u64 as_uint64;
	struct {
		u64 simp_enabled:1;
		u64 preserved:11;
		u64 base_simp_gpa:52;
	};
};

/* Define the format of the SIEFP register */
union hv_synic_siefp {
	u64 as_uint64;
	struct {
		u64 siefp_enabled:1;
		u64 preserved:11;
		u64 base_siefp_gpa:52;
	};
};

/* Definitions for the monitored notification facility */
union hv_monitor_trigger_group {
	u64 as_uint64;
	struct {
		u32 pending;
		u32 armed;
	};
};

struct hv_monitor_parameter {
	union hv_connection_id connectionid;
	u16 flagnumber;
	u16 rsvdz;
};

union hv_monitor_trigger_state {
	u32 asu32;

	struct {
		u32 group_enable:4;
		u32 rsvdz:28;
	};
};

/* struct hv_monitor_page Layout */
/* ------------------------------------------------------ */
/* | 0   | TriggerState (4 bytes) | Rsvd1 (4 bytes)     | */
/* | 8   | TriggerGroup[0]                              | */
/* | 10  | TriggerGroup[1]                              | */
/* | 18  | TriggerGroup[2]                              | */
/* | 20  | TriggerGroup[3]                              | */
/* | 28  | Rsvd2[0]                                     | */
/* | 30  | Rsvd2[1]                                     | */
/* | 38  | Rsvd2[2]                                     | */
/* | 40  | NextCheckTime[0][0]    | NextCheckTime[0][1] | */
/* | ...                                                | */
/* | 240 | Latency[0][0..3]                             | */
/* | 340 | Rsvz3[0]                                     | */
/* | 440 | Parameter[0][0]                              | */
/* | 448 | Parameter[0][1]                              | */
/* | ...                                                | */
/* | 840 | Rsvd4[0]                                     | */
/* ------------------------------------------------------ */
struct hv_monitor_page {
	union hv_monitor_trigger_state trigger_state;
	u32 rsvdz1;

	union hv_monitor_trigger_group trigger_group[4];
	u64 rsvdz2[3];

	s32 next_checktime[4][32];

	u16 latency[4][32];
	u64 rsvdz3[32];

	struct hv_monitor_parameter parameter[4][32];

	u8 rsvdz4[1984];
};

/* Declare the various hypercall operations. */
enum hv_call_code {
	HVCALL_POST_MESSAGE	= 0x005c,
	HVCALL_SIGNAL_EVENT	= 0x005d,
};

/* Definition of the hv_post_message hypercall input structure. */
struct hv_input_post_message {
	union hv_connection_id connectionid;
	u32 reserved;
	enum hv_message_type message_type;
	u32 payload_size;
	u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
};

/* Definition of the hv_signal_event hypercall input structure. */
struct hv_input_signal_event {
	union hv_connection_id connectionid;
	u16 flag_number;
	u16 rsvdz;
};

/*
 * Versioning definitions used for guests reporting themselves to the
 * hypervisor, and visa versa.
 */

/* Version info reported by guest OS's */
enum hv_guest_os_vendor {
	HVGUESTOS_VENDOR_MICROSOFT	= 0x0001
};

enum hv_guest_os_microsoft_ids {
	HVGUESTOS_MICROSOFT_UNDEFINED	= 0x00,
	HVGUESTOS_MICROSOFT_MSDOS		= 0x01,
	HVGUESTOS_MICROSOFT_WINDOWS3X	= 0x02,
	HVGUESTOS_MICROSOFT_WINDOWS9X	= 0x03,
	HVGUESTOS_MICROSOFT_WINDOWSNT	= 0x04,
	HVGUESTOS_MICROSOFT_WINDOWSCE	= 0x05
};

/*
 * Declare the MSR used to identify the guest OS.
 */
#define HV_X64_MSR_GUEST_OS_ID	0x40000000

union hv_x64_msr_guest_os_id_contents {
	u64 as_uint64;
	struct {
		u64 build_number:16;
		u64 service_version:8; /* Service Pack, etc. */
		u64 minor_version:8;
		u64 major_version:8;
		u64 os_id:8; /* enum hv_guest_os_microsoft_ids (if Vendor=MS) */
		u64 vendor_id:16; /* enum hv_guest_os_vendor */
	};
};

/*
 * Declare the MSR used to setup pages used to communicate with the hypervisor.
 */
#define HV_X64_MSR_HYPERCALL	0x40000001

union hv_x64_msr_hypercall_contents {
	u64 as_uint64;
	struct {
		u64 enable:1;
		u64 reserved:11;
		u64 guest_physical_address:52;
	};
};


enum {
	VMBUS_MESSAGE_CONNECTION_ID	= 1,
	VMBUS_MESSAGE_PORT_ID		= 1,
	VMBUS_EVENT_CONNECTION_ID	= 2,
	VMBUS_EVENT_PORT_ID		= 2,
	VMBUS_MONITOR_CONNECTION_ID	= 3,
	VMBUS_MONITOR_PORT_ID		= 3,
	VMBUS_MESSAGE_SINT		= 2,
};

/* #defines */

#define HV_PRESENT_BIT			0x80000000

/*
 * The guest OS needs to register the guest ID with the hypervisor.
 * The guest ID is a 64 bit entity and the structure of this ID is
 * specified in the Hyper-V specification:
 *
 * http://msdn.microsoft.com/en-us/library/windows/hardware/ff542653%28v=vs.85%29.aspx
 *
 * While the current guideline does not specify how Linux guest ID(s)
 * need to be generated, our plan is to publish the guidelines for
 * Linux and other guest operating systems that currently are hosted
 * on Hyper-V. The implementation here conforms to this yet
 * unpublished guidelines.
 *
 *
 * Bit(s)
 * 63 - Indicates if the OS is Open Source or not; 1 is Open Source
 * 62:56 - Os Type; Linux is 0x100
 * 55:48 - Distro specific identification
 * 47:16 - Linux kernel version number
 * 15:0  - Distro specific identification
 *
 *
 */

#define HV_LINUX_VENDOR_ID		0x8100

/*
 * Generate the guest ID based on the guideline described above.
 */

static inline  __u64 generate_guest_id(__u8 d_info1, __u32 kernel_version,
					__u16 d_info2)
{
	__u64 guest_id = 0;

	guest_id = (((__u64)HV_LINUX_VENDOR_ID) << 48);
	guest_id |= (((__u64)(d_info1)) << 48);
	guest_id |= (((__u64)(kernel_version)) << 16);
	guest_id |= ((__u64)(d_info2));

	return guest_id;
}


#define HV_CPU_POWER_MANAGEMENT		(1 << 0)
#define HV_RECOMMENDATIONS_MAX		4

#define HV_X64_MAX			5
#define HV_CAPS_MAX			8


#define HV_HYPERCALL_PARAM_ALIGN	sizeof(u64)


/* Service definitions */

#define HV_SERVICE_PARENT_PORT				(0)
#define HV_SERVICE_PARENT_CONNECTION			(0)

#define HV_SERVICE_CONNECT_RESPONSE_SUCCESS		(0)
#define HV_SERVICE_CONNECT_RESPONSE_INVALID_PARAMETER	(1)
#define HV_SERVICE_CONNECT_RESPONSE_UNKNOWN_SERVICE	(2)
#define HV_SERVICE_CONNECT_RESPONSE_CONNECTION_REJECTED	(3)

#define HV_SERVICE_CONNECT_REQUEST_MESSAGE_ID		(1)
#define HV_SERVICE_CONNECT_RESPONSE_MESSAGE_ID		(2)
#define HV_SERVICE_DISCONNECT_REQUEST_MESSAGE_ID	(3)
#define HV_SERVICE_DISCONNECT_RESPONSE_MESSAGE_ID	(4)
#define HV_SERVICE_MAX_MESSAGE_ID				(4)

#define HV_SERVICE_PROTOCOL_VERSION (0x0010)
#define HV_CONNECT_PAYLOAD_BYTE_COUNT 64

/* #define VMBUS_REVISION_NUMBER	6 */

/* Our local vmbus's port and connection id. Anything >0 is fine */
/* #define VMBUS_PORT_ID		11 */

/* 628180B8-308D-4c5e-B7DB-1BEB62E62EF4 */
static const uuid_le VMBUS_SERVICE_ID = {
	.b = {
		0xb8, 0x80, 0x81, 0x62, 0x8d, 0x30, 0x5e, 0x4c,
		0xb7, 0xdb, 0x1b, 0xeb, 0x62, 0xe6, 0x2e, 0xf4
	},
};


struct hv_input_signal_event_buffer {
	u64 align8;
	struct hv_input_signal_event event;
};

struct hv_context {
	/* We only support running on top of Hyper-V
	* So at this point this really can only contain the Hyper-V ID
	*/
	u64 guestid;

	void *hypercall_page;

	bool synic_initialized;

	/*
	 * This is used as an input param to HvCallSignalEvent hypercall. The
	 * input param is immutable in our usage and must be dynamic mem (vs
	 * stack or global). */
	struct hv_input_signal_event_buffer *signal_event_buffer;
	/* 8-bytes aligned of the buffer above */
	struct hv_input_signal_event *signal_event_param;

	void *synic_message_page[NR_CPUS];
	void *synic_event_page[NR_CPUS];
};

extern struct hv_context hv_context;


/* Hv Interface */

extern int hv_init(void);

extern void hv_cleanup(void);

extern int hv_post_message(union hv_connection_id connection_id,
			 enum hv_message_type message_type,
			 void *payload, size_t payload_size);

extern u16 hv_signal_event(void);

extern void hv_synic_init(void *irqarg);

extern void hv_synic_cleanup(void *arg);


/* Interface */


int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info, void *buffer,
		   u32 buflen);

void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);

int hv_ringbuffer_write(struct hv_ring_buffer_info *ring_info,
		    struct scatterlist *sglist,
		    u32 sgcount, bool *signal);

int hv_ringbuffer_peek(struct hv_ring_buffer_info *ring_info, void *buffer,
		   u32 buflen);

int hv_ringbuffer_read(struct hv_ring_buffer_info *ring_info,
		   void *buffer,
		   u32 buflen,
		   u32 offset);


void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info *ring_info,
			    struct hv_ring_buffer_debug_info *debug_info);

void hv_begin_read(struct hv_ring_buffer_info *rbi);

u32 hv_end_read(struct hv_ring_buffer_info *rbi);

/*
 * Maximum channels is determined by the size of the interrupt page
 * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
 * and the other is receive endpoint interrupt
 */
#define MAX_NUM_CHANNELS	((PAGE_SIZE >> 1) << 3)	/* 16348 channels */

/* The value here must be in multiple of 32 */
/* TODO: Need to make this configurable */
#define MAX_NUM_CHANNELS_SUPPORTED	256


enum vmbus_connect_state {
	DISCONNECTED,
	CONNECTING,
	CONNECTED,
	DISCONNECTING
};

#define MAX_SIZE_CHANNEL_MESSAGE	HV_MESSAGE_PAYLOAD_BYTE_COUNT

struct vmbus_connection {
	enum vmbus_connect_state conn_state;

	atomic_t next_gpadl_handle;

	/*
	 * Represents channel interrupts. Each bit position represents a
	 * channel.  When a channel sends an interrupt via VMBUS, it finds its
	 * bit in the sendInterruptPage, set it and calls Hv to generate a port
	 * event. The other end receives the port event and parse the
	 * recvInterruptPage to see which bit is set
	 */
	void *int_page;
	void *send_int_page;
	void *recv_int_page;

	/*
	 * 2 pages - 1st page for parent->child notification and 2nd
	 * is child->parent notification
	 */
	void *monitor_pages;
	struct list_head chn_msg_list;
	spinlock_t channelmsg_lock;

	/* List of channels */
	struct list_head chn_list;
	spinlock_t channel_lock;

	struct workqueue_struct *work_queue;
};


struct vmbus_msginfo {
	/* Bookkeeping stuff */
	struct list_head msglist_entry;

	/* The message itself */
	unsigned char msg[0];
};


extern struct vmbus_connection vmbus_connection;

/* General vmbus interface */

struct hv_device *vmbus_device_create(uuid_le *type,
					 uuid_le *instance,
					 struct vmbus_channel *channel);

int vmbus_device_register(struct hv_device *child_device_obj);
void vmbus_device_unregister(struct hv_device *device_obj);

/* static void */
/* VmbusChildDeviceDestroy( */
/* struct hv_device *); */

struct vmbus_channel *relid2channel(u32 relid);

void vmbus_free_channels(void);

/* Connection interface */

int vmbus_connect(void);

int vmbus_post_msg(void *buffer, size_t buflen);

int vmbus_set_event(u32 child_relid);

void vmbus_on_event(unsigned long data);


#endif /* _HYPERV_VMBUS_H */
Commit	Line	Data
0f2a6619 S	1	/*
	2	*
	3	* Copyright (c) 2011, 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	* K. Y. Srinivasan <kys@microsoft.com>
	22	*
	23	*/
	24
	25	#ifndef _HYPERV_VMBUS_H
	26	#define _HYPERV_VMBUS_H
	27
43c698b9 S	28	#include <linux/list.h>
	29	#include <asm/sync_bitops.h>
	30	#include <linux/atomic.h>
46a97191	31	#include <linux/hyperv.h>
43c698b9	32
afbdc4a9 S	33	/*
	34	* The below CPUID leaves are present if VersionAndFeatures.HypervisorPresent
	35	* is set by CPUID(HVCPUID_VERSION_FEATURES).
	36	*/
	37	enum hv_cpuid_function {
	38	HVCPUID_VERSION_FEATURES = 0x00000001,
	39	HVCPUID_VENDOR_MAXFUNCTION = 0x40000000,
	40	HVCPUID_INTERFACE = 0x40000001,
	41
	42	/*
	43	* The remaining functions depend on the value of
	44	* HVCPUID_INTERFACE
	45	*/
	46	HVCPUID_VERSION = 0x40000002,
	47	HVCPUID_FEATURES = 0x40000003,
	48	HVCPUID_ENLIGHTENMENT_INFO = 0x40000004,
	49	HVCPUID_IMPLEMENTATION_LIMITS = 0x40000005,
	50	};
	51
	52	/* Define version of the synthetic interrupt controller. */
	53	#define HV_SYNIC_VERSION (1)
	54
	55	/* Define the expected SynIC version. */
	56	#define HV_SYNIC_VERSION_1 (0x1)
	57
	58	/* Define synthetic interrupt controller message constants. */
	59	#define HV_MESSAGE_SIZE (256)
	60	#define HV_MESSAGE_PAYLOAD_BYTE_COUNT (240)
	61	#define HV_MESSAGE_PAYLOAD_QWORD_COUNT (30)
	62	#define HV_ANY_VP (0xFFFFFFFF)
	63
	64	/* Define synthetic interrupt controller flag constants. */
	65	#define HV_EVENT_FLAGS_COUNT (256 * 8)
	66	#define HV_EVENT_FLAGS_BYTE_COUNT (256)
	67	#define HV_EVENT_FLAGS_DWORD_COUNT (256 / sizeof(u32))
	68
	69	/* Define hypervisor message types. */
	70	enum hv_message_type {
	71	HVMSG_NONE = 0x00000000,
	72
	73	/* Memory access messages. */
	74	HVMSG_UNMAPPED_GPA = 0x80000000,
	75	HVMSG_GPA_INTERCEPT = 0x80000001,
	76
	77	/* Timer notification messages. */
	78	HVMSG_TIMER_EXPIRED = 0x80000010,
	79
	80	/* Error messages. */
	81	HVMSG_INVALID_VP_REGISTER_VALUE = 0x80000020,
	82	HVMSG_UNRECOVERABLE_EXCEPTION = 0x80000021,
	83	HVMSG_UNSUPPORTED_FEATURE = 0x80000022,
	84
	85	/* Trace buffer complete messages. */
	86	HVMSG_EVENTLOG_BUFFERCOMPLETE = 0x80000040,
	87
	88	/* Platform-specific processor intercept messages. */
	89	HVMSG_X64_IOPORT_INTERCEPT = 0x80010000,
	90	HVMSG_X64_MSR_INTERCEPT = 0x80010001,
	91	HVMSG_X64_CPUID_INTERCEPT = 0x80010002,
	92	HVMSG_X64_EXCEPTION_INTERCEPT = 0x80010003,
	93	HVMSG_X64_APIC_EOI = 0x80010004,
	94	HVMSG_X64_LEGACY_FP_ERROR = 0x80010005
	95	};
	96
97	/* Define the number of synthetic interrupt sources. */
98	#define HV_SYNIC_SINT_COUNT (16)
99	#define HV_SYNIC_STIMER_COUNT (4)
100
101	/* Define invalid partition identifier. */
102	#define HV_PARTITION_ID_INVALID ((u64)0x0)
103
104	/* Define connection identifier type. */
105	union hv_connection_id {
106	u32 asu32;
107	struct {
108	u32 id:24;
109	u32 reserved:8;
110	} u;
111	};
112
113	/* Define port identifier type. */
114	union hv_port_id {
115	u32 asu32;
116	struct {
117	u32 id:24;
118	u32 reserved:8;
119	} u ;
120	};
121
122	/* Define port type. */
123	enum hv_port_type {
124	HVPORT_MSG = 1,
125	HVPORT_EVENT = 2,
126	HVPORT_MONITOR = 3
127	};
128
129	/* Define port information structure. */
130	struct hv_port_info {
131	enum hv_port_type port_type;
132	u32 padding;
133	union {
134	struct {
135	u32 target_sint;
136	u32 target_vp;
137	u64 rsvdz;
138	} message_port_info;
139	struct {
140	u32 target_sint;
141	u32 target_vp;
142	u16 base_flag_bumber;
143	u16 flag_count;
144	u32 rsvdz;
145	} event_port_info;
146	struct {
147	u64 monitor_address;
148	u64 rsvdz;
149	} monitor_port_info;
150	};
151	};
152
153	struct hv_connection_info {
154	enum hv_port_type port_type;
155	u32 padding;
156	union {
157	struct {
158	u64 rsvdz;
159	} message_connection_info;
160	struct {
161	u64 rsvdz;
162	} event_connection_info;
163	struct {
164	u64 monitor_address;
165	} monitor_connection_info;
166	};
167	};
168
169	/* Define synthetic interrupt controller message flags. */
170	union hv_message_flags {
171	u8 asu8;
172	struct {
173	u8 msg_pending:1;
174	u8 reserved:7;
175	};
176	};
177
178	/* Define synthetic interrupt controller message header. */
179	struct hv_message_header {
180	enum hv_message_type message_type;
181	u8 payload_size;
182	union hv_message_flags message_flags;
183	u8 reserved[2];
184	union {
185	u64 sender;
186	union hv_port_id port;
187	};
188	};
189
190	/* Define timer message payload structure. */
191	struct hv_timer_message_payload {
192	u32 timer_index;
193	u32 reserved;
194	u64 expiration_time; /* When the timer expired */
195	u64 delivery_time; /* When the message was delivered */
196	};
197
198	/* Define synthetic interrupt controller message format. */
199	struct hv_message {
200	struct hv_message_header header;
201	union {
202	u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
203	} u ;
204	};
205
206	/* Define the number of message buffers associated with each port. */
207	#define HV_PORT_MESSAGE_BUFFER_COUNT (16)
208
209	/* Define the synthetic interrupt message page layout. */
210	struct hv_message_page {
211	struct hv_message sint_message[HV_SYNIC_SINT_COUNT];
212	};
213
214	/* Define the synthetic interrupt controller event flags format. */
215	union hv_synic_event_flags {
216	u8 flags8[HV_EVENT_FLAGS_BYTE_COUNT];
217	u32 flags32[HV_EVENT_FLAGS_DWORD_COUNT];
218	};
219
220	/* Define the synthetic interrupt flags page layout. */
221	struct hv_synic_event_flags_page {
222	union hv_synic_event_flags sintevent_flags[HV_SYNIC_SINT_COUNT];
223	};
224
225	/* Define SynIC control register. */
226	union hv_synic_scontrol {
227	u64 as_uint64;
228	struct {
229	u64 enable:1;
230	u64 reserved:63;
231	};
232	};
233
234	/* Define synthetic interrupt source. */
235	union hv_synic_sint {
236	u64 as_uint64;
237	struct {
238	u64 vector:8;
239	u64 reserved1:8;
240	u64 masked:1;
241	u64 auto_eoi:1;
242	u64 reserved2:46;
243	};
244	};
245
246	/* Define the format of the SIMP register */
247	union hv_synic_simp {
248	u64 as_uint64;
249	struct {
250	u64 simp_enabled:1;
251	u64 preserved:11;
252	u64 base_simp_gpa:52;
253	};
254	};
255
256	/* Define the format of the SIEFP register */
257	union hv_synic_siefp {
258	u64 as_uint64;
259	struct {
260	u64 siefp_enabled:1;
261	u64 preserved:11;
262	u64 base_siefp_gpa:52;
263	};
264	};
265
266	/* Definitions for the monitored notification facility */
267	union hv_monitor_trigger_group {
268	u64 as_uint64;
269	struct {
270	u32 pending;
271	u32 armed;
272	};
273	};
274
275	struct hv_monitor_parameter {
276	union hv_connection_id connectionid;
277	u16 flagnumber;
278	u16 rsvdz;
279	};
280
281	union hv_monitor_trigger_state {
282	u32 asu32;
283
284	struct {
285	u32 group_enable:4;
286	u32 rsvdz:28;
287	};
288	};
289
290	/* struct hv_monitor_page Layout */
291	/* ------------------------------------------------------ */
292	/* \| 0 \| TriggerState (4 bytes) \| Rsvd1 (4 bytes) \| */
293	/* \| 8 \| TriggerGroup[0] \| */
294	/* \| 10 \| TriggerGroup[1] \| */
295	/* \| 18 \| TriggerGroup[2] \| */
296	/* \| 20 \| TriggerGroup[3] \| */
297	/* \| 28 \| Rsvd2[0] \| */
298	/* \| 30 \| Rsvd2[1] \| */
299	/* \| 38 \| Rsvd2[2] \| */
300	/* \| 40 \| NextCheckTime[0][0] \| NextCheckTime[0][1] \| */
301	/* \| ... \| */
302	/* \| 240 \| Latency[0][0..3] \| */
303	/* \| 340 \| Rsvz3[0] \| */
304	/* \| 440 \| Parameter[0][0] \| */
305	/* \| 448 \| Parameter[0][1] \| */
306	/* \| ... \| */
307	/* \| 840 \| Rsvd4[0] \| */
308	/* ------------------------------------------------------ */
309	struct hv_monitor_page {
310	union hv_monitor_trigger_state trigger_state;
311	u32 rsvdz1;
312
313	union hv_monitor_trigger_group trigger_group[4];
314	u64 rsvdz2[3];
315
316	s32 next_checktime[4][32];
317
318	u16 latency[4][32];
319	u64 rsvdz3[32];
320
321	struct hv_monitor_parameter parameter[4][32];
322
323	u8 rsvdz4[1984];
324	};
325
326	/* Declare the various hypercall operations. */
327	enum hv_call_code {
328	HVCALL_POST_MESSAGE = 0x005c,
329	HVCALL_SIGNAL_EVENT = 0x005d,
330	};
331
332	/* Definition of the hv_post_message hypercall input structure. */
333	struct hv_input_post_message {
334	union hv_connection_id connectionid;
335	u32 reserved;
336	enum hv_message_type message_type;
337	u32 payload_size;
338	u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
339	};
340
341	/* Definition of the hv_signal_event hypercall input structure. */
342	struct hv_input_signal_event {
343	union hv_connection_id connectionid;
344	u16 flag_number;
345	u16 rsvdz;
346	};
347
348	/*
349	* Versioning definitions used for guests reporting themselves to the
350	* hypervisor, and visa versa.
351	*/
352
353	/* Version info reported by guest OS's */
354	enum hv_guest_os_vendor {
355	HVGUESTOS_VENDOR_MICROSOFT = 0x0001
356	};
357
358	enum hv_guest_os_microsoft_ids {
359	HVGUESTOS_MICROSOFT_UNDEFINED = 0x00,
360	HVGUESTOS_MICROSOFT_MSDOS = 0x01,
361	HVGUESTOS_MICROSOFT_WINDOWS3X = 0x02,
362	HVGUESTOS_MICROSOFT_WINDOWS9X = 0x03,
363	HVGUESTOS_MICROSOFT_WINDOWSNT = 0x04,
364	HVGUESTOS_MICROSOFT_WINDOWSCE = 0x05
365	};
366
367	/*
368	* Declare the MSR used to identify the guest OS.
369	*/
370	#define HV_X64_MSR_GUEST_OS_ID 0x40000000
371
372	union hv_x64_msr_guest_os_id_contents {
373	u64 as_uint64;
374	struct {
375	u64 build_number:16;
376	u64 service_version:8; /* Service Pack, etc. */
377	u64 minor_version:8;
378	u64 major_version:8;
379	u64 os_id:8; /* enum hv_guest_os_microsoft_ids (if Vendor=MS) */
380	u64 vendor_id:16; /* enum hv_guest_os_vendor */
381	};
382	};
383
384	/*
385	* Declare the MSR used to setup pages used to communicate with the hypervisor.
386	*/
387	#define HV_X64_MSR_HYPERCALL 0x40000001
388
389	union hv_x64_msr_hypercall_contents {
390	u64 as_uint64;
391	struct {
392	u64 enable:1;
393	u64 reserved:11;
394	u64 guest_physical_address:52;
395	};
396	};
397
3645a917 S	398
	399	enum {
	400	VMBUS_MESSAGE_CONNECTION_ID = 1,
	401	VMBUS_MESSAGE_PORT_ID = 1,
	402	VMBUS_EVENT_CONNECTION_ID = 2,
	403	VMBUS_EVENT_PORT_ID = 2,
	404	VMBUS_MONITOR_CONNECTION_ID = 3,
	405	VMBUS_MONITOR_PORT_ID = 3,
	406	VMBUS_MESSAGE_SINT = 2,
	407	};
	408
	409	/* #defines */
	410
	411	#define HV_PRESENT_BIT 0x80000000
	412
83ba0c4f S	413	/*
	414	* The guest OS needs to register the guest ID with the hypervisor.
	415	* The guest ID is a 64 bit entity and the structure of this ID is
	416	* specified in the Hyper-V specification:
	417	*
	418	* http://msdn.microsoft.com/en-us/library/windows/hardware/ff542653%28v=vs.85%29.aspx
	419	*
	420	* While the current guideline does not specify how Linux guest ID(s)
	421	* need to be generated, our plan is to publish the guidelines for
	422	* Linux and other guest operating systems that currently are hosted
	423	* on Hyper-V. The implementation here conforms to this yet
	424	* unpublished guidelines.
	425	*
	426	*
	427	* Bit(s)
	428	* 63 - Indicates if the OS is Open Source or not; 1 is Open Source
	429	* 62:56 - Os Type; Linux is 0x100
	430	* 55:48 - Distro specific identification
	431	* 47:16 - Linux kernel version number
	432	* 15:0 - Distro specific identification
	433	*
	434	*
	435	*/
	436
	437	#define HV_LINUX_VENDOR_ID 0x8100
	438
	439	/*
	440	* Generate the guest ID based on the guideline described above.
	441	*/
	442
	443	static inline __u64 generate_guest_id(__u8 d_info1, __u32 kernel_version,
	444	__u16 d_info2)
	445	{
	446	__u64 guest_id = 0;
	447
	448	guest_id = (((__u64)HV_LINUX_VENDOR_ID) << 48);
	449	guest_id \|= (((__u64)(d_info1)) << 48);
	450	guest_id \|= (((__u64)(kernel_version)) << 16);
	451	guest_id \|= ((__u64)(d_info2));
	452
	453	return guest_id;
	454	}
	455
3645a917 S	456
	457	#define HV_CPU_POWER_MANAGEMENT (1 << 0)
	458	#define HV_RECOMMENDATIONS_MAX 4
	459
	460	#define HV_X64_MAX 5
	461	#define HV_CAPS_MAX 8
	462
	463
	464	#define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
	465
	466
	467	/* Service definitions */
	468
	469	#define HV_SERVICE_PARENT_PORT (0)
	470	#define HV_SERVICE_PARENT_CONNECTION (0)
	471
	472	#define HV_SERVICE_CONNECT_RESPONSE_SUCCESS (0)
	473	#define HV_SERVICE_CONNECT_RESPONSE_INVALID_PARAMETER (1)
	474	#define HV_SERVICE_CONNECT_RESPONSE_UNKNOWN_SERVICE (2)
	475	#define HV_SERVICE_CONNECT_RESPONSE_CONNECTION_REJECTED (3)
	476
	477	#define HV_SERVICE_CONNECT_REQUEST_MESSAGE_ID (1)
	478	#define HV_SERVICE_CONNECT_RESPONSE_MESSAGE_ID (2)
	479	#define HV_SERVICE_DISCONNECT_REQUEST_MESSAGE_ID (3)
	480	#define HV_SERVICE_DISCONNECT_RESPONSE_MESSAGE_ID (4)
	481	#define HV_SERVICE_MAX_MESSAGE_ID (4)
	482
	483	#define HV_SERVICE_PROTOCOL_VERSION (0x0010)
	484	#define HV_CONNECT_PAYLOAD_BYTE_COUNT 64
	485
	486	/* #define VMBUS_REVISION_NUMBER 6 */
	487
	488	/* Our local vmbus's port and connection id. Anything >0 is fine */
	489	/* #define VMBUS_PORT_ID 11 */
	490
	491	/* 628180B8-308D-4c5e-B7DB-1BEB62E62EF4 */
358d2ee2 S	492	static const uuid_le VMBUS_SERVICE_ID = {
358d2ee2 S	493	.b = {
3645a917 S	494	0xb8, 0x80, 0x81, 0x62, 0x8d, 0x30, 0x5e, 0x4c,
	495	0xb7, 0xdb, 0x1b, 0xeb, 0x62, 0xe6, 0x2e, 0xf4
	496	},
	497	};
	498
3645a917 S	499
	500
	501	struct hv_input_signal_event_buffer {
	502	u64 align8;
	503	struct hv_input_signal_event event;
	504	};
	505
	506	struct hv_context {
	507	/* We only support running on top of Hyper-V
	508	* So at this point this really can only contain the Hyper-V ID
	509	*/
	510	u64 guestid;
	511
	512	void *hypercall_page;
	513
	514	bool synic_initialized;
	515
	516	/*
	517	* This is used as an input param to HvCallSignalEvent hypercall. The
	518	* input param is immutable in our usage and must be dynamic mem (vs
	519	* stack or global). */
	520	struct hv_input_signal_event_buffer *signal_event_buffer;
	521	/* 8-bytes aligned of the buffer above */
	522	struct hv_input_signal_event *signal_event_param;
	523
14c1bf8a S	524	void *synic_message_page[NR_CPUS];
14c1bf8a S	525	void *synic_event_page[NR_CPUS];
3645a917 S	526	};
	527
	528	extern struct hv_context hv_context;
	529
	530
	531	/* Hv Interface */
	532
	533	extern int hv_init(void);
	534
	535	extern void hv_cleanup(void);
	536
415f0a02	537	extern int hv_post_message(union hv_connection_id connection_id,
3645a917 S	538	enum hv_message_type message_type,
	539	void *payload, size_t payload_size);
	540
	541	extern u16 hv_signal_event(void);
	542
	543	extern void hv_synic_init(void *irqarg);
	544
	545	extern void hv_synic_cleanup(void *arg);
	546
940655c1 S	547
	548	/* Interface */
	549
	550
	551	int hv_ringbuffer_init(struct hv_ring_buffer_info ring_info, void buffer,
	552	u32 buflen);
	553
	554	void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
	555
	556	int hv_ringbuffer_write(struct hv_ring_buffer_info *ring_info,
	557	struct scatterlist *sglist,
98fa8cf4	558	u32 sgcount, bool *signal);
940655c1 S	559
	560	int hv_ringbuffer_peek(struct hv_ring_buffer_info ring_info, void buffer,
	561	u32 buflen);
	562
	563	int hv_ringbuffer_read(struct hv_ring_buffer_info *ring_info,
	564	void *buffer,
	565	u32 buflen,
	566	u32 offset);
	567
940655c1	568
940655c1 S	569	void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info *ring_info,
	570	struct hv_ring_buffer_debug_info *debug_info);
	571
6fdf3b21 S	572	void hv_begin_read(struct hv_ring_buffer_info *rbi);
	573
	574	u32 hv_end_read(struct hv_ring_buffer_info *rbi);
	575
89b2ca47 S	576	/*
	577	* Maximum channels is determined by the size of the interrupt page
	578	* which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
	579	* and the other is receive endpoint interrupt
	580	*/
	581	#define MAX_NUM_CHANNELS ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
	582
	583	/* The value here must be in multiple of 32 */
	584	/* TODO: Need to make this configurable */
	585	#define MAX_NUM_CHANNELS_SUPPORTED 256
	586
	587
	588	enum vmbus_connect_state {
	589	DISCONNECTED,
	590	CONNECTING,
	591	CONNECTED,
	592	DISCONNECTING
	593	};
	594
	595	#define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
	596
	597	struct vmbus_connection {
	598	enum vmbus_connect_state conn_state;
	599
	600	atomic_t next_gpadl_handle;
	601
	602	/*
	603	* Represents channel interrupts. Each bit position represents a
	604	* channel. When a channel sends an interrupt via VMBUS, it finds its
	605	* bit in the sendInterruptPage, set it and calls Hv to generate a port
	606	* event. The other end receives the port event and parse the
	607	* recvInterruptPage to see which bit is set
	608	*/
	609	void *int_page;
	610	void *send_int_page;
	611	void *recv_int_page;
	612
	613	/*
	614	* 2 pages - 1st page for parent->child notification and 2nd
	615	* is child->parent notification
	616	*/
	617	void *monitor_pages;
	618	struct list_head chn_msg_list;
	619	spinlock_t channelmsg_lock;
	620
	621	/* List of channels */
	622	struct list_head chn_list;
	623	spinlock_t channel_lock;
	624
	625	struct workqueue_struct *work_queue;
	626	};
	627
	628
	629	struct vmbus_msginfo {
	630	/* Bookkeeping stuff */
	631	struct list_head msglist_entry;
	632
	633	/* The message itself */
	634	unsigned char msg[0];
	635	};
	636
	637
	638	extern struct vmbus_connection vmbus_connection;
	639
640	/* General vmbus interface */
641
f2c73011	642	struct hv_device vmbus_device_create(uuid_le type,
358d2ee2	643	uuid_le *instance,
89b2ca47 S	644	struct vmbus_channel *channel);
89b2ca47 S	645
22794281	646	int vmbus_device_register(struct hv_device *child_device_obj);
696453ba	647	void vmbus_device_unregister(struct hv_device *device_obj);
89b2ca47 S	648
	649	/* static void */
	650	/* VmbusChildDeviceDestroy( */
	651	/* struct hv_device ); /
	652
	653	struct vmbus_channel *relid2channel(u32 relid);
	654
93e5bd06	655	void vmbus_free_channels(void);
89b2ca47 S	656
	657	/* Connection interface */
	658
	659	int vmbus_connect(void);
	660
89b2ca47 S	661	int vmbus_post_msg(void *buffer, size_t buflen);
	662
	663	int vmbus_set_event(u32 child_relid);
	664
	665	void vmbus_on_event(unsigned long data);
	666
	667
0f2a6619	668	#endif /* _HYPERV_VMBUS_H */