[mirror_ubuntu-bionic-kernel.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>

/*
 * Timeout for services such as KVP and fcopy.
 */
#define HV_UTIL_TIMEOUT 30

/*
 * Timeout for guest-host handshake for services.
 */
#define HV_UTIL_NEGO_TIMEOUT 55


#define HV_EVENT_FLAGS_BYTE_COUNT	(256)
#define HV_EVENT_FLAGS_DWORD_COUNT	(256 / sizeof(u32))

/*
 * Timer configuration register.
 */
union hv_timer_config {
	u64 as_uint64;
	struct {
		u64 enable:1;
		u64 periodic:1;
		u64 lazy:1;
		u64 auto_enable:1;
		u64 reserved_z0:12;
		u64 sintx:4;
		u64 reserved_z1:44;
	};
};


/* 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 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];
};

#define HV_HYPERCALL_PARAM_ALIGN	sizeof(u64)

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


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,
};

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 *tsc_page;

	bool synic_initialized;

	void *synic_message_page[NR_CPUS];
	void *synic_event_page[NR_CPUS];
	/*
	 * Hypervisor's notion of virtual processor ID is different from
	 * Linux' notion of CPU ID. This information can only be retrieved
	 * in the context of the calling CPU. Setup a map for easy access
	 * to this information:
	 *
	 * vp_index[a] is the Hyper-V's processor ID corresponding to
	 * Linux cpuid 'a'.
	 */
	u32 vp_index[NR_CPUS];
	/*
	 * Starting with win8, we can take channel interrupts on any CPU;
	 * we will manage the tasklet that handles events messages on a per CPU
	 * basis.
	 */
	struct tasklet_struct *event_dpc[NR_CPUS];
	struct tasklet_struct *msg_dpc[NR_CPUS];
	/*
	 * To optimize the mapping of relid to channel, maintain
	 * per-cpu list of the channels based on their CPU affinity.
	 */
	struct list_head percpu_list[NR_CPUS];
	/*
	 * buffer to post messages to the host.
	 */
	void *post_msg_page[NR_CPUS];
	/*
	 * Support PV clockevent device.
	 */
	struct clock_event_device *clk_evt[NR_CPUS];
	/*
	 * To manage allocations in a NUMA node.
	 * Array indexed by numa node ID.
	 */
	struct cpumask *hv_numa_map;
};

extern struct hv_context hv_context;

struct hv_ring_buffer_debug_info {
	u32 current_interrupt_mask;
	u32 current_read_index;
	u32 current_write_index;
	u32 bytes_avail_toread;
	u32 bytes_avail_towrite;
};

/* Hv Interface */

extern int hv_init(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 int hv_synic_alloc(void);

extern void hv_synic_free(void);

extern int hv_synic_init(unsigned int cpu);

extern int hv_synic_cleanup(unsigned int cpu);

extern void hv_synic_clockevents_cleanup(void);

/* Interface */


int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
		       struct page *pages, u32 pagecnt);

void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);

int hv_ringbuffer_write(struct vmbus_channel *channel,
		    struct kvec *kv_list,
		    u32 kv_count, bool lock,
		    bool kick_q);

int hv_ringbuffer_read(struct vmbus_channel *channel,
		       void *buffer, u32 buflen, u32 *buffer_actual_len,
		       u64 *requestid, bool raw);

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;

	struct completion  unload_event;
	/*
	 * 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
	 */
	struct hv_monitor_page *monitor_pages[2];
	struct list_head chn_msg_list;
	spinlock_t channelmsg_lock;

	/* List of channels */
	struct list_head chn_list;
	struct mutex channel_mutex;

	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;

enum vmbus_message_handler_type {
	/* The related handler can sleep. */
	VMHT_BLOCKING = 0,

	/* The related handler must NOT sleep. */
	VMHT_NON_BLOCKING = 1,
};

struct vmbus_channel_message_table_entry {
	enum vmbus_channel_message_type message_type;
	enum vmbus_message_handler_type handler_type;
	void (*message_handler)(struct vmbus_channel_message_header *msg);
};

extern struct vmbus_channel_message_table_entry
	channel_message_table[CHANNELMSG_COUNT];


/* General vmbus interface */

struct hv_device *vmbus_device_create(const uuid_le *type,
				      const 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);

struct vmbus_channel *relid2channel(u32 relid);

void vmbus_free_channels(void);

/* Connection interface */

int vmbus_connect(void);
void vmbus_disconnect(void);

int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);

void vmbus_on_event(unsigned long data);
void vmbus_on_msg_dpc(unsigned long data);

int hv_kvp_init(struct hv_util_service *);
void hv_kvp_deinit(void);
void hv_kvp_onchannelcallback(void *);

int hv_vss_init(struct hv_util_service *);
void hv_vss_deinit(void);
void hv_vss_onchannelcallback(void *);

int hv_fcopy_init(struct hv_util_service *);
void hv_fcopy_deinit(void);
void hv_fcopy_onchannelcallback(void *);
void vmbus_initiate_unload(bool crash);

static inline void hv_poll_channel(struct vmbus_channel *channel,
				   void (*cb)(void *))
{
	if (!channel)
		return;

	smp_call_function_single(channel->target_cpu, cb, channel, true);
}

enum hvutil_device_state {
	HVUTIL_DEVICE_INIT = 0,  /* driver is loaded, waiting for userspace */
	HVUTIL_READY,            /* userspace is registered */
	HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
	HVUTIL_USERSPACE_REQ,    /* request to userspace was sent */
	HVUTIL_USERSPACE_RECV,   /* reply from userspace was received */
	HVUTIL_DEVICE_DYING,     /* driver unload is in progress */
};

#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
c0b200cf S	33	/*
	34	* Timeout for services such as KVP and fcopy.
	35	*/
	36	#define HV_UTIL_TIMEOUT 30
	37
4dbfc2e6 VK	38	/*
	39	* Timeout for guest-host handshake for services.
	40	*/
d7edd31b	41	#define HV_UTIL_NEGO_TIMEOUT 55
4dbfc2e6	42
96c1d058	43
afbdc4a9	44
afbdc4a9	45
afbdc4a9 S	46	#define HV_EVENT_FLAGS_BYTE_COUNT (256)
	47	#define HV_EVENT_FLAGS_DWORD_COUNT (256 / sizeof(u32))
	48
4061ed9e S	49	/*
	50	* Timer configuration register.
	51	*/
	52	union hv_timer_config {
	53	u64 as_uint64;
	54	struct {
	55	u64 enable:1;
	56	u64 periodic:1;
	57	u64 lazy:1;
	58	u64 auto_enable:1;
	59	u64 reserved_z0:12;
	60	u64 sintx:4;
	61	u64 reserved_z1:44;
	62	};
	63	};
	64
afbdc4a9	65
afbdc4a9 S	66	/* Define the synthetic interrupt controller event flags format. */
	67	union hv_synic_event_flags {
	68	u8 flags8[HV_EVENT_FLAGS_BYTE_COUNT];
	69	u32 flags32[HV_EVENT_FLAGS_DWORD_COUNT];
	70	};
	71
afbdc4a9 S	72	/* Define SynIC control register. */
	73	union hv_synic_scontrol {
	74	u64 as_uint64;
	75	struct {
	76	u64 enable:1;
	77	u64 reserved:63;
	78	};
	79	};
	80
	81	/* Define synthetic interrupt source. */
	82	union hv_synic_sint {
	83	u64 as_uint64;
	84	struct {
	85	u64 vector:8;
	86	u64 reserved1:8;
	87	u64 masked:1;
	88	u64 auto_eoi:1;
	89	u64 reserved2:46;
	90	};
	91	};
	92
	93	/* Define the format of the SIMP register */
	94	union hv_synic_simp {
	95	u64 as_uint64;
	96	struct {
	97	u64 simp_enabled:1;
	98	u64 preserved:11;
	99	u64 base_simp_gpa:52;
	100	};
	101	};
	102
	103	/* Define the format of the SIEFP register */
	104	union hv_synic_siefp {
	105	u64 as_uint64;
	106	struct {
	107	u64 siefp_enabled:1;
	108	u64 preserved:11;
	109	u64 base_siefp_gpa:52;
	110	};
	111	};
	112
	113	/* Definitions for the monitored notification facility */
	114	union hv_monitor_trigger_group {
	115	u64 as_uint64;
	116	struct {
	117	u32 pending;
	118	u32 armed;
	119	};
	120	};
	121
	122	struct hv_monitor_parameter {
	123	union hv_connection_id connectionid;
	124	u16 flagnumber;
	125	u16 rsvdz;
	126	};
	127
	128	union hv_monitor_trigger_state {
	129	u32 asu32;
	130
	131	struct {
	132	u32 group_enable:4;
	133	u32 rsvdz:28;
	134	};
	135	};
136
137	/* struct hv_monitor_page Layout */
138	/* ------------------------------------------------------ */
139	/* \| 0 \| TriggerState (4 bytes) \| Rsvd1 (4 bytes) \| */
140	/* \| 8 \| TriggerGroup[0] \| */
141	/* \| 10 \| TriggerGroup[1] \| */
142	/* \| 18 \| TriggerGroup[2] \| */
143	/* \| 20 \| TriggerGroup[3] \| */
144	/* \| 28 \| Rsvd2[0] \| */
145	/* \| 30 \| Rsvd2[1] \| */
146	/* \| 38 \| Rsvd2[2] \| */
147	/* \| 40 \| NextCheckTime[0][0] \| NextCheckTime[0][1] \| */
148	/* \| ... \| */
149	/* \| 240 \| Latency[0][0..3] \| */
150	/* \| 340 \| Rsvz3[0] \| */
151	/* \| 440 \| Parameter[0][0] \| */
152	/* \| 448 \| Parameter[0][1] \| */
153	/* \| ... \| */
154	/* \| 840 \| Rsvd4[0] \| */
155	/* ------------------------------------------------------ */
156	struct hv_monitor_page {
157	union hv_monitor_trigger_state trigger_state;
158	u32 rsvdz1;
159
160	union hv_monitor_trigger_group trigger_group[4];
161	u64 rsvdz2[3];
162
163	s32 next_checktime[4][32];
164
165	u16 latency[4][32];
166	u64 rsvdz3[32];
167
168	struct hv_monitor_parameter parameter[4][32];
169
170	u8 rsvdz4[1984];
171	};
172
8e27a236 S	173	#define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
8e27a236 S	174
afbdc4a9 S	175	/* Definition of the hv_post_message hypercall input structure. */
	176	struct hv_input_post_message {
	177	union hv_connection_id connectionid;
	178	u32 reserved;
7797dcf6	179	u32 message_type;
afbdc4a9 S	180	u32 payload_size;
	181	u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
	182	};
	183
afbdc4a9	184
3645a917 S	185	enum {
	186	VMBUS_MESSAGE_CONNECTION_ID = 1,
	187	VMBUS_MESSAGE_PORT_ID = 1,
	188	VMBUS_EVENT_CONNECTION_ID = 2,
	189	VMBUS_EVENT_PORT_ID = 2,
	190	VMBUS_MONITOR_CONNECTION_ID = 3,
	191	VMBUS_MONITOR_PORT_ID = 3,
	192	VMBUS_MESSAGE_SINT = 2,
	193	};
	194
3645a917 S	195	struct hv_context {
	196	/* We only support running on top of Hyper-V
	197	* So at this point this really can only contain the Hyper-V ID
	198	*/
	199	u64 guestid;
	200
ca9357bd	201	void *tsc_page;
3645a917 S	202
	203	bool synic_initialized;
	204
14c1bf8a S	205	void *synic_message_page[NR_CPUS];
14c1bf8a S	206	void *synic_event_page[NR_CPUS];
917ea427 S	207	/*
	208	* Hypervisor's notion of virtual processor ID is different from
	209	* Linux' notion of CPU ID. This information can only be retrieved
	210	* in the context of the calling CPU. Setup a map for easy access
	211	* to this information:
	212	*
	213	* vp_index[a] is the Hyper-V's processor ID corresponding to
	214	* Linux cpuid 'a'.
	215	*/
	216	u32 vp_index[NR_CPUS];
db11f12a S	217	/*
db11f12a S	218	* Starting with win8, we can take channel interrupts on any CPU;
d81274aa	219	* we will manage the tasklet that handles events messages on a per CPU
db11f12a S	220	* basis.
	221	*/
	222	struct tasklet_struct *event_dpc[NR_CPUS];
d81274aa	223	struct tasklet_struct *msg_dpc[NR_CPUS];
3a28fa35 S	224	/*
	225	* To optimize the mapping of relid to channel, maintain
	226	* per-cpu list of the channels based on their CPU affinity.
	227	*/
	228	struct list_head percpu_list[NR_CPUS];
b29ef354 S	229	/*
	230	* buffer to post messages to the host.
	231	*/
	232	void *post_msg_page[NR_CPUS];
4061ed9e S	233	/*
	234	* Support PV clockevent device.
	235	*/
	236	struct clock_event_device *clk_evt[NR_CPUS];
9f01ec53 S	237	/*
	238	* To manage allocations in a NUMA node.
	239	* Array indexed by numa node ID.
	240	*/
	241	struct cpumask *hv_numa_map;
3645a917 S	242	};
	243
	244	extern struct hv_context hv_context;
	245
1fdde16d GKH	246	struct hv_ring_buffer_debug_info {
	247	u32 current_interrupt_mask;
	248	u32 current_read_index;
	249	u32 current_write_index;
	250	u32 bytes_avail_toread;
	251	u32 bytes_avail_towrite;
	252	};
3645a917 S	253
	254	/* Hv Interface */
	255
	256	extern int hv_init(void);
	257
415f0a02	258	extern int hv_post_message(union hv_connection_id connection_id,
3645a917 S	259	enum hv_message_type message_type,
	260	void *payload, size_t payload_size);
	261
2608fb65 JW	262	extern int hv_synic_alloc(void);
	263
	264	extern void hv_synic_free(void);
	265
76d36ab7	266	extern int hv_synic_init(unsigned int cpu);
3645a917	267
76d36ab7	268	extern int hv_synic_cleanup(unsigned int cpu);
3645a917	269
e086748c VK	270	extern void hv_synic_clockevents_cleanup(void);
e086748c VK	271
940655c1 S	272	/* Interface */
	273
	274
9988ce68 VK	275	int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
9988ce68 VK	276	struct page *pages, u32 pagecnt);
940655c1 S	277
	278	void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
	279
1f6ee4e7	280	int hv_ringbuffer_write(struct vmbus_channel *channel,
011a7c3c	281	struct kvec *kv_list,
1f6ee4e7 S	282	u32 kv_count, bool lock,
1f6ee4e7 S	283	bool kick_q);
940655c1	284
3372592a	285	int hv_ringbuffer_read(struct vmbus_channel *channel,
940b68e2	286	void buffer, u32 buflen, u32 buffer_actual_len,
3372592a	287	u64 *requestid, bool raw);
940655c1	288
940655c1 S	289	void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info *ring_info,
	290	struct hv_ring_buffer_debug_info *debug_info);
	291
6fdf3b21 S	292	void hv_begin_read(struct hv_ring_buffer_info *rbi);
	293
	294	u32 hv_end_read(struct hv_ring_buffer_info *rbi);
	295
89b2ca47 S	296	/*
	297	* Maximum channels is determined by the size of the interrupt page
	298	* which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
	299	* and the other is receive endpoint interrupt
	300	*/
	301	#define MAX_NUM_CHANNELS ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
	302
	303	/* The value here must be in multiple of 32 */
	304	/* TODO: Need to make this configurable */
	305	#define MAX_NUM_CHANNELS_SUPPORTED 256
	306
	307
	308	enum vmbus_connect_state {
	309	DISCONNECTED,
	310	CONNECTING,
	311	CONNECTED,
	312	DISCONNECTING
	313	};
	314
	315	#define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
	316
	317	struct vmbus_connection {
	318	enum vmbus_connect_state conn_state;
	319
	320	atomic_t next_gpadl_handle;
	321
2db84eff	322	struct completion unload_event;
89b2ca47 S	323	/*
	324	* Represents channel interrupts. Each bit position represents a
	325	* channel. When a channel sends an interrupt via VMBUS, it finds its
	326	* bit in the sendInterruptPage, set it and calls Hv to generate a port
	327	* event. The other end receives the port event and parse the
	328	* recvInterruptPage to see which bit is set
	329	*/
	330	void *int_page;
	331	void *send_int_page;
	332	void *recv_int_page;
	333
	334	/*
	335	* 2 pages - 1st page for parent->child notification and 2nd
	336	* is child->parent notification
	337	*/
8681db44	338	struct hv_monitor_page *monitor_pages[2];
89b2ca47 S	339	struct list_head chn_msg_list;
	340	spinlock_t channelmsg_lock;
	341
	342	/* List of channels */
	343	struct list_head chn_list;
d6f591e3	344	struct mutex channel_mutex;
89b2ca47 S	345
	346	struct workqueue_struct *work_queue;
	347	};
	348
	349
	350	struct vmbus_msginfo {
	351	/* Bookkeeping stuff */
	352	struct list_head msglist_entry;
	353
	354	/* The message itself */
	355	unsigned char msg[0];
	356	};
	357
	358
	359	extern struct vmbus_connection vmbus_connection;
	360
652594c7 DC	361	enum vmbus_message_handler_type {
	362	/* The related handler can sleep. */
	363	VMHT_BLOCKING = 0,
	364
	365	/* The related handler must NOT sleep. */
	366	VMHT_NON_BLOCKING = 1,
	367	};
	368
	369	struct vmbus_channel_message_table_entry {
	370	enum vmbus_channel_message_type message_type;
	371	enum vmbus_message_handler_type handler_type;
	372	void (message_handler)(struct vmbus_channel_message_header msg);
	373	};
	374
	375	extern struct vmbus_channel_message_table_entry
	376	channel_message_table[CHANNELMSG_COUNT];
	377
0f70b669	378
89b2ca47 S	379	/* General vmbus interface */
89b2ca47 S	380
1b9d48f2	381	struct hv_device vmbus_device_create(const uuid_le type,
	382	const uuid_le *instance,
	383	struct vmbus_channel *channel);
89b2ca47	384
22794281	385	int vmbus_device_register(struct hv_device *child_device_obj);
696453ba	386	void vmbus_device_unregister(struct hv_device *device_obj);
89b2ca47	387
d43e2fe7	388	struct vmbus_channel *relid2channel(u32 relid);
89b2ca47	389
93e5bd06	390	void vmbus_free_channels(void);
89b2ca47 S	391
	392	/* Connection interface */
	393
	394	int vmbus_connect(void);
09a19628	395	void vmbus_disconnect(void);
89b2ca47	396
c0bb0392	397	int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
89b2ca47	398
89b2ca47	399	void vmbus_on_event(unsigned long data);
d81274aa	400	void vmbus_on_msg_dpc(unsigned long data);
89b2ca47	401
3647a83d VK	402	int hv_kvp_init(struct hv_util_service *);
	403	void hv_kvp_deinit(void);
	404	void hv_kvp_onchannelcallback(void *);
	405
	406	int hv_vss_init(struct hv_util_service *);
	407	void hv_vss_deinit(void);
	408	void hv_vss_onchannelcallback(void *);
	409
01325476 S	410	int hv_fcopy_init(struct hv_util_service *);
	411	void hv_fcopy_deinit(void);
	412	void hv_fcopy_onchannelcallback(void *);
75ff3a8a	413	void vmbus_initiate_unload(bool crash);
01325476	414
8efe78fd VK	415	static inline void hv_poll_channel(struct vmbus_channel *channel,
	416	void (cb)(void ))
	417	{
	418	if (!channel)
	419	return;
	420
3cace4a6	421	smp_call_function_single(channel->target_cpu, cb, channel, true);
8efe78fd	422	}
89b2ca47	423
636c88da VK	424	enum hvutil_device_state {
	425	HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */
	426	HVUTIL_READY, /* userspace is registered */
	427	HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
	428	HVUTIL_USERSPACE_REQ, /* request to userspace was sent */
	429	HVUTIL_USERSPACE_RECV, /* reply from userspace was received */
	430	HVUTIL_DEVICE_DYING, /* driver unload is in progress */
	431	};
	432
0f2a6619	433	#endif /* _HYPERV_VMBUS_H */