[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>
#include <linux/interrupt.h>

#include "hv_trace.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 synthetic interrupt controller flag constants. */
#define HV_EVENT_FLAGS_COUNT		(256 * 8)
#define HV_EVENT_FLAGS_LONG_COUNT	(256 / sizeof(unsigned long))

/*
 * 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 {
	unsigned long flags[HV_EVENT_FLAGS_LONG_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,
};

/*
 * Per cpu state for channel handling
 */
struct hv_per_cpu_context {
	void *synic_message_page;
	void *synic_event_page;
	/*
	 * buffer to post messages to the host.
	 */
	void *post_msg_page;

	/*
	 * 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 msg_dpc;

	/*
	 * To optimize the mapping of relid to channel, maintain
	 * per-cpu list of the channels based on their CPU affinity.
	 */
	struct list_head chan_list;
	struct clock_event_device *clk_evt;
};

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;

	struct hv_per_cpu_context __percpu *cpu_context;

	/*
	 * To manage allocations in a NUMA node.
	 * Array indexed by numa node ID.
	 */
	struct cpumask *hv_numa_map;
};

extern struct hv_context hv_context;

/* 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,
			const struct kvec *kv_list, u32 kv_count);

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

/*
 * 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 {
	/*
	 * CPU on which the initial host contact was made.
	 */
	int connect_cpu;

	atomic_t offer_in_progress;

	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;

	/*
	 * An offer message is handled first on the work_queue, and then
	 * is further handled on handle_primary_chan_wq or
	 * handle_sub_chan_wq.
	 */
	struct workqueue_struct *work_queue;
	struct workqueue_struct *handle_primary_chan_wq;
	struct workqueue_struct *handle_sub_chan_wq;
};


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

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


extern struct vmbus_connection vmbus_connection;

static inline void vmbus_send_interrupt(u32 relid)
{
	sync_set_bit(relid, vmbus_connection.send_int_page);
}

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 const 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);
int vmbus_add_channel_kobj(struct hv_device *device_obj,
			   struct vmbus_channel *channel);

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 *srv);
void hv_kvp_deinit(void);
void hv_kvp_onchannelcallback(void *context);

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

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

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

	if (in_interrupt() && (channel->target_cpu == smp_processor_id())) {
		cb(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>
37cdd991	32	#include <linux/interrupt.h>
43c698b9	33
c9fe0f8f VK	34	#include "hv_trace.h"
c9fe0f8f VK	35
c0b200cf S	36	/*
	37	* Timeout for services such as KVP and fcopy.
	38	*/
	39	#define HV_UTIL_TIMEOUT 30
	40
4dbfc2e6 VK	41	/*
	42	* Timeout for guest-host handshake for services.
	43	*/
d7edd31b	44	#define HV_UTIL_NEGO_TIMEOUT 55
4dbfc2e6	45
5c1bec61 SH	46	/* Define synthetic interrupt controller flag constants. */
	47	#define HV_EVENT_FLAGS_COUNT (256 * 8)
	48	#define HV_EVENT_FLAGS_LONG_COUNT (256 / sizeof(unsigned long))
afbdc4a9	49
4061ed9e S	50	/*
	51	* Timer configuration register.
	52	*/
	53	union hv_timer_config {
	54	u64 as_uint64;
	55	struct {
	56	u64 enable:1;
	57	u64 periodic:1;
	58	u64 lazy:1;
	59	u64 auto_enable:1;
	60	u64 reserved_z0:12;
	61	u64 sintx:4;
	62	u64 reserved_z1:44;
	63	};
	64	};
	65
afbdc4a9	66
afbdc4a9 S	67	/* Define the synthetic interrupt controller event flags format. */
afbdc4a9 S	68	union hv_synic_event_flags {
5c1bec61	69	unsigned long flags[HV_EVENT_FLAGS_LONG_COUNT];
afbdc4a9 S	70	};
afbdc4a9 S	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
37cdd991 SH	195	/*
	196	* Per cpu state for channel handling
	197	*/
	198	struct hv_per_cpu_context {
	199	void *synic_message_page;
	200	void *synic_event_page;
	201	/*
	202	* buffer to post messages to the host.
	203	*/
	204	void *post_msg_page;
	205
	206	/*
	207	* Starting with win8, we can take channel interrupts on any CPU;
	208	* we will manage the tasklet that handles events messages on a per CPU
	209	* basis.
	210	*/
37cdd991 SH	211	struct tasklet_struct msg_dpc;
	212
	213	/*
	214	* To optimize the mapping of relid to channel, maintain
	215	* per-cpu list of the channels based on their CPU affinity.
	216	*/
	217	struct list_head chan_list;
	218	struct clock_event_device *clk_evt;
	219	};
	220
3645a917 S	221	struct hv_context {
3645a917 S	222	/* We only support running on top of Hyper-V
2a9d7de2 SH	223	* So at this point this really can only contain the Hyper-V ID
2a9d7de2 SH	224	*/
3645a917 S	225	u64 guestid;
3645a917 S	226
ca9357bd	227	void *tsc_page;
3645a917 S	228
	229	bool synic_initialized;
	230
37cdd991 SH	231	struct hv_per_cpu_context __percpu *cpu_context;
37cdd991 SH	232
9f01ec53 S	233	/*
	234	* To manage allocations in a NUMA node.
	235	* Array indexed by numa node ID.
	236	*/
	237	struct cpumask *hv_numa_map;
3645a917 S	238	};
	239
	240	extern struct hv_context hv_context;
	241
3645a917 S	242	/* Hv Interface */
	243
	244	extern int hv_init(void);
	245
415f0a02	246	extern int hv_post_message(union hv_connection_id connection_id,
3645a917 S	247	enum hv_message_type message_type,
	248	void *payload, size_t payload_size);
	249
2608fb65 JW	250	extern int hv_synic_alloc(void);
	251
	252	extern void hv_synic_free(void);
	253
76d36ab7	254	extern int hv_synic_init(unsigned int cpu);
3645a917	255
76d36ab7	256	extern int hv_synic_cleanup(unsigned int cpu);
3645a917	257
e086748c VK	258	extern void hv_synic_clockevents_cleanup(void);
e086748c VK	259
940655c1 S	260	/* Interface */
	261
	262
9988ce68 VK	263	int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
9988ce68 VK	264	struct page *pages, u32 pagecnt);
940655c1 S	265
	266	void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
	267
1f6ee4e7	268	int hv_ringbuffer_write(struct vmbus_channel *channel,
e4165a0f	269	const struct kvec *kv_list, u32 kv_count);
940655c1	270
3372592a	271	int hv_ringbuffer_read(struct vmbus_channel *channel,
940b68e2	272	void buffer, u32 buflen, u32 buffer_actual_len,
3372592a	273	u64 *requestid, bool raw);
940655c1	274
89b2ca47 S	275	/*
	276	* Maximum channels is determined by the size of the interrupt page
	277	* which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
	278	* and the other is receive endpoint interrupt
	279	*/
	280	#define MAX_NUM_CHANNELS ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
	281
	282	/* The value here must be in multiple of 32 */
	283	/* TODO: Need to make this configurable */
	284	#define MAX_NUM_CHANNELS_SUPPORTED 256
	285
	286
	287	enum vmbus_connect_state {
	288	DISCONNECTED,
	289	CONNECTING,
	290	CONNECTED,
	291	DISCONNECTING
	292	};
	293
	294	#define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
	295
	296	struct vmbus_connection {
54a66265 S	297	/*
	298	* CPU on which the initial host contact was made.
	299	*/
	300	int connect_cpu;
	301
	302	atomic_t offer_in_progress;
	303
89b2ca47 S	304	enum vmbus_connect_state conn_state;
	305
	306	atomic_t next_gpadl_handle;
	307
2db84eff	308	struct completion unload_event;
89b2ca47 S	309	/*
	310	* Represents channel interrupts. Each bit position represents a
	311	* channel. When a channel sends an interrupt via VMBUS, it finds its
	312	* bit in the sendInterruptPage, set it and calls Hv to generate a port
	313	* event. The other end receives the port event and parse the
	314	* recvInterruptPage to see which bit is set
	315	*/
	316	void *int_page;
	317	void *send_int_page;
	318	void *recv_int_page;
	319
	320	/*
	321	* 2 pages - 1st page for parent->child notification and 2nd
	322	* is child->parent notification
	323	*/
8681db44	324	struct hv_monitor_page *monitor_pages[2];
89b2ca47 S	325	struct list_head chn_msg_list;
	326	spinlock_t channelmsg_lock;
	327
	328	/* List of channels */
	329	struct list_head chn_list;
d6f591e3	330	struct mutex channel_mutex;
89b2ca47	331
262ab06b DC	332	/*
	333	* An offer message is handled first on the work_queue, and then
	334	* is further handled on handle_primary_chan_wq or
	335	* handle_sub_chan_wq.
	336	*/
89b2ca47	337	struct workqueue_struct *work_queue;
262ab06b DC	338	struct workqueue_struct *handle_primary_chan_wq;
262ab06b DC	339	struct workqueue_struct *handle_sub_chan_wq;
89b2ca47 S	340	};
	341
	342
	343	struct vmbus_msginfo {
	344	/* Bookkeeping stuff */
	345	struct list_head msglist_entry;
	346
	347	/* The message itself */
	348	unsigned char msg[0];
	349	};
	350
	351
	352	extern struct vmbus_connection vmbus_connection;
	353
5c1bec61 SH	354	static inline void vmbus_send_interrupt(u32 relid)
	355	{
	356	sync_set_bit(relid, vmbus_connection.send_int_page);
	357	}
	358
652594c7 DC	359	enum vmbus_message_handler_type {
	360	/* The related handler can sleep. */
	361	VMHT_BLOCKING = 0,
	362
	363	/* The related handler must NOT sleep. */
	364	VMHT_NON_BLOCKING = 1,
	365	};
	366
	367	struct vmbus_channel_message_table_entry {
	368	enum vmbus_channel_message_type message_type;
	369	enum vmbus_message_handler_type handler_type;
	370	void (message_handler)(struct vmbus_channel_message_header msg);
	371	};
	372
e6242fa0	373	extern const struct vmbus_channel_message_table_entry
652594c7 DC	374	channel_message_table[CHANNELMSG_COUNT];
652594c7 DC	375
0f70b669	376
89b2ca47 S	377	/* General vmbus interface */
89b2ca47 S	378
1b9d48f2	379	struct hv_device vmbus_device_create(const uuid_le type,
	380	const uuid_le *instance,
	381	struct vmbus_channel *channel);
89b2ca47	382
22794281	383	int vmbus_device_register(struct hv_device *child_device_obj);
696453ba	384	void vmbus_device_unregister(struct hv_device *device_obj);
c2e5df61 SH	385	int vmbus_add_channel_kobj(struct hv_device *device_obj,
c2e5df61 SH	386	struct vmbus_channel *channel);
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
2a9d7de2	402	int hv_kvp_init(struct hv_util_service *srv);
3647a83d	403	void hv_kvp_deinit(void);
2a9d7de2	404	void hv_kvp_onchannelcallback(void *context);
3647a83d	405
2a9d7de2	406	int hv_vss_init(struct hv_util_service *srv);
3647a83d	407	void hv_vss_deinit(void);
2a9d7de2	408	void hv_vss_onchannelcallback(void *context);
3647a83d	409
2a9d7de2	410	int hv_fcopy_init(struct hv_util_service *srv);
01325476	411	void hv_fcopy_deinit(void);
2a9d7de2	412	void hv_fcopy_onchannelcallback(void *context);
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
1e052a16 S	421	if (in_interrupt() && (channel->target_cpu == smp_processor_id())) {
	422	cb(channel);
	423	return;
	424	}
3cace4a6	425	smp_call_function_single(channel->target_cpu, cb, channel, true);
8efe78fd	426	}
89b2ca47	427
636c88da VK	428	enum hvutil_device_state {
	429	HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */
	430	HVUTIL_READY, /* userspace is registered */
	431	HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
	432	HVUTIL_USERSPACE_REQ, /* request to userspace was sent */
	433	HVUTIL_USERSPACE_RECV, /* reply from userspace was received */
	434	HVUTIL_DEVICE_DYING, /* driver unload is in progress */
	435	};
	436
0f2a6619	437	#endif /* _HYPERV_VMBUS_H */