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