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