3 * Copyright (c) 2011, Microsoft Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307 USA.
19 * Haiyang Zhang <haiyangz@microsoft.com>
20 * Hank Janssen <hjanssen@microsoft.com>
21 * K. Y. Srinivasan <kys@microsoft.com>
25 #ifndef _HYPERV_VMBUS_H
26 #define _HYPERV_VMBUS_H
28 #include <linux/list.h>
29 #include <asm/sync_bitops.h>
30 #include <linux/atomic.h>
31 #include <linux/hyperv.h>
34 * Timeout for services such as KVP and fcopy.
36 #define HV_UTIL_TIMEOUT 30
39 * Timeout for guest-host handshake for services.
41 #define HV_UTIL_NEGO_TIMEOUT 55
46 #define HV_EVENT_FLAGS_BYTE_COUNT (256)
47 #define HV_EVENT_FLAGS_DWORD_COUNT (256 / sizeof(u32))
50 * Timer configuration register.
52 union hv_timer_config
{
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
];
72 /* Define SynIC control register. */
73 union hv_synic_scontrol
{
81 /* Define synthetic interrupt source. */
93 /* Define the format of the SIMP register */
103 /* Define the format of the SIEFP register */
104 union hv_synic_siefp
{
109 u64 base_siefp_gpa
:52;
113 /* Definitions for the monitored notification facility */
114 union hv_monitor_trigger_group
{
122 struct hv_monitor_parameter
{
123 union hv_connection_id connectionid
;
128 union hv_monitor_trigger_state
{
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] | */
149 /* | 240 | Latency[0][0..3] | */
150 /* | 340 | Rsvz3[0] | */
151 /* | 440 | Parameter[0][0] | */
152 /* | 448 | Parameter[0][1] | */
154 /* | 840 | Rsvd4[0] | */
155 /* ------------------------------------------------------ */
156 struct hv_monitor_page
{
157 union hv_monitor_trigger_state trigger_state
;
160 union hv_monitor_trigger_group trigger_group
[4];
163 s32 next_checktime
[4][32];
168 struct hv_monitor_parameter parameter
[4][32];
173 #define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
175 /* Definition of the hv_post_message hypercall input structure. */
176 struct hv_input_post_message
{
177 union hv_connection_id connectionid
;
181 u64 payload
[HV_MESSAGE_PAYLOAD_QWORD_COUNT
];
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,
196 /* We only support running on top of Hyper-V
197 * So at this point this really can only contain the Hyper-V ID
203 bool synic_initialized
;
205 void *synic_message_page
[NR_CPUS
];
206 void *synic_event_page
[NR_CPUS
];
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:
213 * vp_index[a] is the Hyper-V's processor ID corresponding to
216 u32 vp_index
[NR_CPUS
];
218 * Starting with win8, we can take channel interrupts on any CPU;
219 * we will manage the tasklet that handles events messages on a per CPU
222 struct tasklet_struct
*event_dpc
[NR_CPUS
];
223 struct tasklet_struct
*msg_dpc
[NR_CPUS
];
225 * To optimize the mapping of relid to channel, maintain
226 * per-cpu list of the channels based on their CPU affinity.
228 struct list_head percpu_list
[NR_CPUS
];
230 * buffer to post messages to the host.
232 void *post_msg_page
[NR_CPUS
];
234 * Support PV clockevent device.
236 struct clock_event_device
*clk_evt
[NR_CPUS
];
238 * To manage allocations in a NUMA node.
239 * Array indexed by numa node ID.
241 struct cpumask
*hv_numa_map
;
244 extern struct hv_context hv_context
;
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
;
256 extern int hv_init(void);
258 extern int hv_post_message(union hv_connection_id connection_id
,
259 enum hv_message_type message_type
,
260 void *payload
, size_t payload_size
);
262 extern int hv_synic_alloc(void);
264 extern void hv_synic_free(void);
266 extern int hv_synic_init(unsigned int cpu
);
268 extern int hv_synic_cleanup(unsigned int cpu
);
270 extern void hv_synic_clockevents_cleanup(void);
275 int hv_ringbuffer_init(struct hv_ring_buffer_info
*ring_info
,
276 struct page
*pages
, u32 pagecnt
);
278 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info
*ring_info
);
280 int hv_ringbuffer_write(struct vmbus_channel
*channel
,
281 struct kvec
*kv_list
,
282 u32 kv_count
, bool lock
,
285 int hv_ringbuffer_read(struct vmbus_channel
*channel
,
286 void *buffer
, u32 buflen
, u32
*buffer_actual_len
,
287 u64
*requestid
, bool raw
);
289 void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info
*ring_info
,
290 struct hv_ring_buffer_debug_info
*debug_info
);
292 void hv_begin_read(struct hv_ring_buffer_info
*rbi
);
294 u32
hv_end_read(struct hv_ring_buffer_info
*rbi
);
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
301 #define MAX_NUM_CHANNELS ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
303 /* The value here must be in multiple of 32 */
304 /* TODO: Need to make this configurable */
305 #define MAX_NUM_CHANNELS_SUPPORTED 256
308 enum vmbus_connect_state
{
315 #define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
317 struct vmbus_connection
{
318 enum vmbus_connect_state conn_state
;
320 atomic_t next_gpadl_handle
;
322 struct completion unload_event
;
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
335 * 2 pages - 1st page for parent->child notification and 2nd
336 * is child->parent notification
338 struct hv_monitor_page
*monitor_pages
[2];
339 struct list_head chn_msg_list
;
340 spinlock_t channelmsg_lock
;
342 /* List of channels */
343 struct list_head chn_list
;
344 struct mutex channel_mutex
;
346 struct workqueue_struct
*work_queue
;
350 struct vmbus_msginfo
{
351 /* Bookkeeping stuff */
352 struct list_head msglist_entry
;
354 /* The message itself */
355 unsigned char msg
[0];
359 extern struct vmbus_connection vmbus_connection
;
361 enum vmbus_message_handler_type
{
362 /* The related handler can sleep. */
365 /* The related handler must NOT sleep. */
366 VMHT_NON_BLOCKING
= 1,
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
);
375 extern struct vmbus_channel_message_table_entry
376 channel_message_table
[CHANNELMSG_COUNT
];
379 /* General vmbus interface */
381 struct hv_device
*vmbus_device_create(const uuid_le
*type
,
382 const uuid_le
*instance
,
383 struct vmbus_channel
*channel
);
385 int vmbus_device_register(struct hv_device
*child_device_obj
);
386 void vmbus_device_unregister(struct hv_device
*device_obj
);
388 struct vmbus_channel
*relid2channel(u32 relid
);
390 void vmbus_free_channels(void);
392 /* Connection interface */
394 int vmbus_connect(void);
395 void vmbus_disconnect(void);
397 int vmbus_post_msg(void *buffer
, size_t buflen
, bool can_sleep
);
399 void vmbus_on_event(unsigned long data
);
400 void vmbus_on_msg_dpc(unsigned long data
);
402 int hv_kvp_init(struct hv_util_service
*);
403 void hv_kvp_deinit(void);
404 void hv_kvp_onchannelcallback(void *);
406 int hv_vss_init(struct hv_util_service
*);
407 void hv_vss_deinit(void);
408 void hv_vss_onchannelcallback(void *);
410 int hv_fcopy_init(struct hv_util_service
*);
411 void hv_fcopy_deinit(void);
412 void hv_fcopy_onchannelcallback(void *);
413 void vmbus_initiate_unload(bool crash
);
415 static inline void hv_poll_channel(struct vmbus_channel
*channel
,
421 smp_call_function_single(channel
->target_cpu
, cb
, channel
, true);
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 */
433 #endif /* _HYPERV_VMBUS_H */