Loading...
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 *
4 * Copyright (c) 2011, Microsoft Corporation.
5 *
6 * Authors:
7 * Haiyang Zhang <haiyangz@microsoft.com>
8 * Hank Janssen <hjanssen@microsoft.com>
9 * K. Y. Srinivasan <kys@microsoft.com>
10 */
11
12#ifndef _HYPERV_VMBUS_H
13#define _HYPERV_VMBUS_H
14
15#include <linux/list.h>
16#include <linux/bitops.h>
17#include <asm/sync_bitops.h>
18#include <asm/hyperv-tlfs.h>
19#include <linux/atomic.h>
20#include <linux/hyperv.h>
21#include <linux/interrupt.h>
22
23#include "hv_trace.h"
24
25/*
26 * Timeout for services such as KVP and fcopy.
27 */
28#define HV_UTIL_TIMEOUT 30
29
30/*
31 * Timeout for guest-host handshake for services.
32 */
33#define HV_UTIL_NEGO_TIMEOUT 55
34
35
36/* Definitions for the monitored notification facility */
37union hv_monitor_trigger_group {
38 u64 as_uint64;
39 struct {
40 u32 pending;
41 u32 armed;
42 };
43};
44
45struct hv_monitor_parameter {
46 union hv_connection_id connectionid;
47 u16 flagnumber;
48 u16 rsvdz;
49};
50
51union hv_monitor_trigger_state {
52 u32 asu32;
53
54 struct {
55 u32 group_enable:4;
56 u32 rsvdz:28;
57 };
58};
59
60/* struct hv_monitor_page Layout */
61/* ------------------------------------------------------ */
62/* | 0 | TriggerState (4 bytes) | Rsvd1 (4 bytes) | */
63/* | 8 | TriggerGroup[0] | */
64/* | 10 | TriggerGroup[1] | */
65/* | 18 | TriggerGroup[2] | */
66/* | 20 | TriggerGroup[3] | */
67/* | 28 | Rsvd2[0] | */
68/* | 30 | Rsvd2[1] | */
69/* | 38 | Rsvd2[2] | */
70/* | 40 | NextCheckTime[0][0] | NextCheckTime[0][1] | */
71/* | ... | */
72/* | 240 | Latency[0][0..3] | */
73/* | 340 | Rsvz3[0] | */
74/* | 440 | Parameter[0][0] | */
75/* | 448 | Parameter[0][1] | */
76/* | ... | */
77/* | 840 | Rsvd4[0] | */
78/* ------------------------------------------------------ */
79struct hv_monitor_page {
80 union hv_monitor_trigger_state trigger_state;
81 u32 rsvdz1;
82
83 union hv_monitor_trigger_group trigger_group[4];
84 u64 rsvdz2[3];
85
86 s32 next_checktime[4][32];
87
88 u16 latency[4][32];
89 u64 rsvdz3[32];
90
91 struct hv_monitor_parameter parameter[4][32];
92
93 u8 rsvdz4[1984];
94};
95
96#define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
97
98/* Definition of the hv_post_message hypercall input structure. */
99struct hv_input_post_message {
100 union hv_connection_id connectionid;
101 u32 reserved;
102 u32 message_type;
103 u32 payload_size;
104 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
105};
106
107
108enum {
109 VMBUS_MESSAGE_CONNECTION_ID = 1,
110 VMBUS_MESSAGE_CONNECTION_ID_4 = 4,
111 VMBUS_MESSAGE_PORT_ID = 1,
112 VMBUS_EVENT_CONNECTION_ID = 2,
113 VMBUS_EVENT_PORT_ID = 2,
114 VMBUS_MONITOR_CONNECTION_ID = 3,
115 VMBUS_MONITOR_PORT_ID = 3,
116 VMBUS_MESSAGE_SINT = 2,
117};
118
119/*
120 * Per cpu state for channel handling
121 */
122struct hv_per_cpu_context {
123 void *synic_message_page;
124 void *synic_event_page;
125
126 /*
127 * The page is only used in hv_post_message() for a TDX VM (with the
128 * paravisor) to post a messages to Hyper-V: when such a VM calls
129 * HVCALL_POST_MESSAGE, it can't use the hyperv_pcpu_input_arg (which
130 * is encrypted in such a VM) as the hypercall input page, because
131 * the input page for HVCALL_POST_MESSAGE must be decrypted in such a
132 * VM, so post_msg_page (which is decrypted in hv_synic_alloc()) is
133 * introduced for this purpose. See hyperv_init() for more comments.
134 */
135 void *post_msg_page;
136
137 /*
138 * Starting with win8, we can take channel interrupts on any CPU;
139 * we will manage the tasklet that handles events messages on a per CPU
140 * basis.
141 */
142 struct tasklet_struct msg_dpc;
143};
144
145struct hv_context {
146 /* We only support running on top of Hyper-V
147 * So at this point this really can only contain the Hyper-V ID
148 */
149 u64 guestid;
150
151 struct hv_per_cpu_context __percpu *cpu_context;
152
153 /*
154 * To manage allocations in a NUMA node.
155 * Array indexed by numa node ID.
156 */
157 struct cpumask *hv_numa_map;
158};
159
160extern struct hv_context hv_context;
161
162/* Hv Interface */
163
164extern int hv_init(void);
165
166extern int hv_post_message(union hv_connection_id connection_id,
167 enum hv_message_type message_type,
168 void *payload, size_t payload_size);
169
170extern int hv_synic_alloc(void);
171
172extern void hv_synic_free(void);
173
174extern void hv_synic_enable_regs(unsigned int cpu);
175extern int hv_synic_init(unsigned int cpu);
176
177extern void hv_synic_disable_regs(unsigned int cpu);
178extern int hv_synic_cleanup(unsigned int cpu);
179
180/* Interface */
181
182void hv_ringbuffer_pre_init(struct vmbus_channel *channel);
183
184int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
185 struct page *pages, u32 pagecnt, u32 max_pkt_size);
186
187void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
188
189int hv_ringbuffer_write(struct vmbus_channel *channel,
190 const struct kvec *kv_list, u32 kv_count,
191 u64 requestid, u64 *trans_id);
192
193int hv_ringbuffer_read(struct vmbus_channel *channel,
194 void *buffer, u32 buflen, u32 *buffer_actual_len,
195 u64 *requestid, bool raw);
196
197/*
198 * The Maximum number of channels (16384) is determined by the size of the
199 * interrupt page, which is HV_HYP_PAGE_SIZE. 1/2 of HV_HYP_PAGE_SIZE is to
200 * send endpoint interrupts, and the other is to receive endpoint interrupts.
201 */
202#define MAX_NUM_CHANNELS ((HV_HYP_PAGE_SIZE >> 1) << 3)
203
204/* The value here must be in multiple of 32 */
205#define MAX_NUM_CHANNELS_SUPPORTED 256
206
207#define MAX_CHANNEL_RELIDS \
208 max(MAX_NUM_CHANNELS_SUPPORTED, HV_EVENT_FLAGS_COUNT)
209
210enum vmbus_connect_state {
211 DISCONNECTED,
212 CONNECTING,
213 CONNECTED,
214 DISCONNECTING
215};
216
217#define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
218
219/*
220 * The CPU that Hyper-V will interrupt for VMBUS messages, such as
221 * CHANNELMSG_OFFERCHANNEL and CHANNELMSG_RESCIND_CHANNELOFFER.
222 */
223#define VMBUS_CONNECT_CPU 0
224
225struct vmbus_connection {
226 u32 msg_conn_id;
227
228 atomic_t offer_in_progress;
229
230 enum vmbus_connect_state conn_state;
231
232 atomic_t next_gpadl_handle;
233
234 struct completion unload_event;
235 /*
236 * Represents channel interrupts. Each bit position represents a
237 * channel. When a channel sends an interrupt via VMBUS, it finds its
238 * bit in the sendInterruptPage, set it and calls Hv to generate a port
239 * event. The other end receives the port event and parse the
240 * recvInterruptPage to see which bit is set
241 */
242 void *int_page;
243 void *send_int_page;
244 void *recv_int_page;
245
246 /*
247 * 2 pages - 1st page for parent->child notification and 2nd
248 * is child->parent notification
249 */
250 struct hv_monitor_page *monitor_pages[2];
251 struct list_head chn_msg_list;
252 spinlock_t channelmsg_lock;
253
254 /* List of channels */
255 struct list_head chn_list;
256 struct mutex channel_mutex;
257
258 /* Array of channels */
259 struct vmbus_channel **channels;
260
261 /*
262 * An offer message is handled first on the work_queue, and then
263 * is further handled on handle_primary_chan_wq or
264 * handle_sub_chan_wq.
265 */
266 struct workqueue_struct *work_queue;
267 struct workqueue_struct *handle_primary_chan_wq;
268 struct workqueue_struct *handle_sub_chan_wq;
269 struct workqueue_struct *rescind_work_queue;
270
271 /*
272 * On suspension of the vmbus, the accumulated offer messages
273 * must be dropped.
274 */
275 bool ignore_any_offer_msg;
276
277 /*
278 * The number of sub-channels and hv_sock channels that should be
279 * cleaned up upon suspend: sub-channels will be re-created upon
280 * resume, and hv_sock channels should not survive suspend.
281 */
282 atomic_t nr_chan_close_on_suspend;
283 /*
284 * vmbus_bus_suspend() waits for "nr_chan_close_on_suspend" to
285 * drop to zero.
286 */
287 struct completion ready_for_suspend_event;
288
289 /*
290 * The number of primary channels that should be "fixed up"
291 * upon resume: these channels are re-offered upon resume, and some
292 * fields of the channel offers (i.e. child_relid and connection_id)
293 * can change, so the old offermsg must be fixed up, before the resume
294 * callbacks of the VSC drivers start to further touch the channels.
295 */
296 atomic_t nr_chan_fixup_on_resume;
297 /*
298 * vmbus_bus_resume() waits for "nr_chan_fixup_on_resume" to
299 * drop to zero.
300 */
301 struct completion ready_for_resume_event;
302};
303
304
305struct vmbus_msginfo {
306 /* Bookkeeping stuff */
307 struct list_head msglist_entry;
308
309 /* The message itself */
310 unsigned char msg[];
311};
312
313
314extern struct vmbus_connection vmbus_connection;
315
316int vmbus_negotiate_version(struct vmbus_channel_msginfo *msginfo, u32 version);
317
318static inline void vmbus_send_interrupt(u32 relid)
319{
320 sync_set_bit(relid, vmbus_connection.send_int_page);
321}
322
323enum vmbus_message_handler_type {
324 /* The related handler can sleep. */
325 VMHT_BLOCKING = 0,
326
327 /* The related handler must NOT sleep. */
328 VMHT_NON_BLOCKING = 1,
329};
330
331struct vmbus_channel_message_table_entry {
332 enum vmbus_channel_message_type message_type;
333 enum vmbus_message_handler_type handler_type;
334 void (*message_handler)(struct vmbus_channel_message_header *msg);
335 u32 min_payload_len;
336};
337
338extern const struct vmbus_channel_message_table_entry
339 channel_message_table[CHANNELMSG_COUNT];
340
341
342/* General vmbus interface */
343
344struct hv_device *vmbus_device_create(const guid_t *type,
345 const guid_t *instance,
346 struct vmbus_channel *channel);
347
348int vmbus_device_register(struct hv_device *child_device_obj);
349void vmbus_device_unregister(struct hv_device *device_obj);
350int vmbus_add_channel_kobj(struct hv_device *device_obj,
351 struct vmbus_channel *channel);
352
353void vmbus_remove_channel_attr_group(struct vmbus_channel *channel);
354
355void vmbus_channel_map_relid(struct vmbus_channel *channel);
356void vmbus_channel_unmap_relid(struct vmbus_channel *channel);
357
358struct vmbus_channel *relid2channel(u32 relid);
359
360void vmbus_free_channels(void);
361
362/* Connection interface */
363
364int vmbus_connect(void);
365void vmbus_disconnect(void);
366
367int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
368
369void vmbus_on_event(unsigned long data);
370void vmbus_on_msg_dpc(unsigned long data);
371
372int hv_kvp_init(struct hv_util_service *srv);
373void hv_kvp_deinit(void);
374int hv_kvp_pre_suspend(void);
375int hv_kvp_pre_resume(void);
376void hv_kvp_onchannelcallback(void *context);
377
378int hv_vss_init(struct hv_util_service *srv);
379void hv_vss_deinit(void);
380int hv_vss_pre_suspend(void);
381int hv_vss_pre_resume(void);
382void hv_vss_onchannelcallback(void *context);
383
384int hv_fcopy_init(struct hv_util_service *srv);
385void hv_fcopy_deinit(void);
386int hv_fcopy_pre_suspend(void);
387int hv_fcopy_pre_resume(void);
388void hv_fcopy_onchannelcallback(void *context);
389void vmbus_initiate_unload(bool crash);
390
391static inline void hv_poll_channel(struct vmbus_channel *channel,
392 void (*cb)(void *))
393{
394 if (!channel)
395 return;
396 cb(channel);
397}
398
399enum hvutil_device_state {
400 HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */
401 HVUTIL_READY, /* userspace is registered */
402 HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
403 HVUTIL_USERSPACE_REQ, /* request to userspace was sent */
404 HVUTIL_USERSPACE_RECV, /* reply from userspace was received */
405 HVUTIL_DEVICE_DYING, /* driver unload is in progress */
406};
407
408enum delay {
409 INTERRUPT_DELAY = 0,
410 MESSAGE_DELAY = 1,
411};
412
413extern const struct vmbus_device vmbus_devs[];
414
415static inline bool hv_is_perf_channel(struct vmbus_channel *channel)
416{
417 return vmbus_devs[channel->device_id].perf_device;
418}
419
420static inline bool hv_is_allocated_cpu(unsigned int cpu)
421{
422 struct vmbus_channel *channel, *sc;
423
424 lockdep_assert_held(&vmbus_connection.channel_mutex);
425 /*
426 * List additions/deletions as well as updates of the target CPUs are
427 * protected by channel_mutex.
428 */
429 list_for_each_entry(channel, &vmbus_connection.chn_list, listentry) {
430 if (!hv_is_perf_channel(channel))
431 continue;
432 if (channel->target_cpu == cpu)
433 return true;
434 list_for_each_entry(sc, &channel->sc_list, sc_list) {
435 if (sc->target_cpu == cpu)
436 return true;
437 }
438 }
439 return false;
440}
441
442static inline void hv_set_allocated_cpu(unsigned int cpu)
443{
444 cpumask_set_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
445}
446
447static inline void hv_clear_allocated_cpu(unsigned int cpu)
448{
449 if (hv_is_allocated_cpu(cpu))
450 return;
451 cpumask_clear_cpu(cpu, &hv_context.hv_numa_map[cpu_to_node(cpu)]);
452}
453
454static inline void hv_update_allocated_cpus(unsigned int old_cpu,
455 unsigned int new_cpu)
456{
457 hv_set_allocated_cpu(new_cpu);
458 hv_clear_allocated_cpu(old_cpu);
459}
460
461#ifdef CONFIG_HYPERV_TESTING
462
463int hv_debug_add_dev_dir(struct hv_device *dev);
464void hv_debug_rm_dev_dir(struct hv_device *dev);
465void hv_debug_rm_all_dir(void);
466int hv_debug_init(void);
467void hv_debug_delay_test(struct vmbus_channel *channel, enum delay delay_type);
468
469#else /* CONFIG_HYPERV_TESTING */
470
471static inline void hv_debug_rm_dev_dir(struct hv_device *dev) {};
472static inline void hv_debug_rm_all_dir(void) {};
473static inline void hv_debug_delay_test(struct vmbus_channel *channel,
474 enum delay delay_type) {};
475static inline int hv_debug_init(void)
476{
477 return -1;
478}
479
480static inline int hv_debug_add_dev_dir(struct hv_device *dev)
481{
482 return -1;
483}
484
485#endif /* CONFIG_HYPERV_TESTING */
486
487#endif /* _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 <linux/atomic.h>
31#include <linux/hyperv.h>
32
33/*
34 * The below CPUID leaves are present if VersionAndFeatures.HypervisorPresent
35 * is set by CPUID(HVCPUID_VERSION_FEATURES).
36 */
37enum hv_cpuid_function {
38 HVCPUID_VERSION_FEATURES = 0x00000001,
39 HVCPUID_VENDOR_MAXFUNCTION = 0x40000000,
40 HVCPUID_INTERFACE = 0x40000001,
41
42 /*
43 * The remaining functions depend on the value of
44 * HVCPUID_INTERFACE
45 */
46 HVCPUID_VERSION = 0x40000002,
47 HVCPUID_FEATURES = 0x40000003,
48 HVCPUID_ENLIGHTENMENT_INFO = 0x40000004,
49 HVCPUID_IMPLEMENTATION_LIMITS = 0x40000005,
50};
51
52/* Define version of the synthetic interrupt controller. */
53#define HV_SYNIC_VERSION (1)
54
55/* Define the expected SynIC version. */
56#define HV_SYNIC_VERSION_1 (0x1)
57
58/* Define synthetic interrupt controller message constants. */
59#define HV_MESSAGE_SIZE (256)
60#define HV_MESSAGE_PAYLOAD_BYTE_COUNT (240)
61#define HV_MESSAGE_PAYLOAD_QWORD_COUNT (30)
62#define HV_ANY_VP (0xFFFFFFFF)
63
64/* Define synthetic interrupt controller flag constants. */
65#define HV_EVENT_FLAGS_COUNT (256 * 8)
66#define HV_EVENT_FLAGS_BYTE_COUNT (256)
67#define HV_EVENT_FLAGS_DWORD_COUNT (256 / sizeof(u32))
68
69/* Define hypervisor message types. */
70enum hv_message_type {
71 HVMSG_NONE = 0x00000000,
72
73 /* Memory access messages. */
74 HVMSG_UNMAPPED_GPA = 0x80000000,
75 HVMSG_GPA_INTERCEPT = 0x80000001,
76
77 /* Timer notification messages. */
78 HVMSG_TIMER_EXPIRED = 0x80000010,
79
80 /* Error messages. */
81 HVMSG_INVALID_VP_REGISTER_VALUE = 0x80000020,
82 HVMSG_UNRECOVERABLE_EXCEPTION = 0x80000021,
83 HVMSG_UNSUPPORTED_FEATURE = 0x80000022,
84
85 /* Trace buffer complete messages. */
86 HVMSG_EVENTLOG_BUFFERCOMPLETE = 0x80000040,
87
88 /* Platform-specific processor intercept messages. */
89 HVMSG_X64_IOPORT_INTERCEPT = 0x80010000,
90 HVMSG_X64_MSR_INTERCEPT = 0x80010001,
91 HVMSG_X64_CPUID_INTERCEPT = 0x80010002,
92 HVMSG_X64_EXCEPTION_INTERCEPT = 0x80010003,
93 HVMSG_X64_APIC_EOI = 0x80010004,
94 HVMSG_X64_LEGACY_FP_ERROR = 0x80010005
95};
96
97/* Define the number of synthetic interrupt sources. */
98#define HV_SYNIC_SINT_COUNT (16)
99#define HV_SYNIC_STIMER_COUNT (4)
100
101/* Define invalid partition identifier. */
102#define HV_PARTITION_ID_INVALID ((u64)0x0)
103
104/* Define port identifier type. */
105union hv_port_id {
106 u32 asu32;
107 struct {
108 u32 id:24;
109 u32 reserved:8;
110 } u ;
111};
112
113/* Define port type. */
114enum hv_port_type {
115 HVPORT_MSG = 1,
116 HVPORT_EVENT = 2,
117 HVPORT_MONITOR = 3
118};
119
120/* Define port information structure. */
121struct hv_port_info {
122 enum hv_port_type port_type;
123 u32 padding;
124 union {
125 struct {
126 u32 target_sint;
127 u32 target_vp;
128 u64 rsvdz;
129 } message_port_info;
130 struct {
131 u32 target_sint;
132 u32 target_vp;
133 u16 base_flag_bumber;
134 u16 flag_count;
135 u32 rsvdz;
136 } event_port_info;
137 struct {
138 u64 monitor_address;
139 u64 rsvdz;
140 } monitor_port_info;
141 };
142};
143
144struct hv_connection_info {
145 enum hv_port_type port_type;
146 u32 padding;
147 union {
148 struct {
149 u64 rsvdz;
150 } message_connection_info;
151 struct {
152 u64 rsvdz;
153 } event_connection_info;
154 struct {
155 u64 monitor_address;
156 } monitor_connection_info;
157 };
158};
159
160/* Define synthetic interrupt controller message flags. */
161union hv_message_flags {
162 u8 asu8;
163 struct {
164 u8 msg_pending:1;
165 u8 reserved:7;
166 };
167};
168
169/* Define synthetic interrupt controller message header. */
170struct hv_message_header {
171 enum hv_message_type message_type;
172 u8 payload_size;
173 union hv_message_flags message_flags;
174 u8 reserved[2];
175 union {
176 u64 sender;
177 union hv_port_id port;
178 };
179};
180
181/* Define timer message payload structure. */
182struct hv_timer_message_payload {
183 u32 timer_index;
184 u32 reserved;
185 u64 expiration_time; /* When the timer expired */
186 u64 delivery_time; /* When the message was delivered */
187};
188
189/* Define synthetic interrupt controller message format. */
190struct hv_message {
191 struct hv_message_header header;
192 union {
193 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
194 } u ;
195};
196
197/* Define the number of message buffers associated with each port. */
198#define HV_PORT_MESSAGE_BUFFER_COUNT (16)
199
200/* Define the synthetic interrupt message page layout. */
201struct hv_message_page {
202 struct hv_message sint_message[HV_SYNIC_SINT_COUNT];
203};
204
205/* Define the synthetic interrupt controller event flags format. */
206union hv_synic_event_flags {
207 u8 flags8[HV_EVENT_FLAGS_BYTE_COUNT];
208 u32 flags32[HV_EVENT_FLAGS_DWORD_COUNT];
209};
210
211/* Define the synthetic interrupt flags page layout. */
212struct hv_synic_event_flags_page {
213 union hv_synic_event_flags sintevent_flags[HV_SYNIC_SINT_COUNT];
214};
215
216/* Define SynIC control register. */
217union hv_synic_scontrol {
218 u64 as_uint64;
219 struct {
220 u64 enable:1;
221 u64 reserved:63;
222 };
223};
224
225/* Define synthetic interrupt source. */
226union hv_synic_sint {
227 u64 as_uint64;
228 struct {
229 u64 vector:8;
230 u64 reserved1:8;
231 u64 masked:1;
232 u64 auto_eoi:1;
233 u64 reserved2:46;
234 };
235};
236
237/* Define the format of the SIMP register */
238union hv_synic_simp {
239 u64 as_uint64;
240 struct {
241 u64 simp_enabled:1;
242 u64 preserved:11;
243 u64 base_simp_gpa:52;
244 };
245};
246
247/* Define the format of the SIEFP register */
248union hv_synic_siefp {
249 u64 as_uint64;
250 struct {
251 u64 siefp_enabled:1;
252 u64 preserved:11;
253 u64 base_siefp_gpa:52;
254 };
255};
256
257/* Definitions for the monitored notification facility */
258union hv_monitor_trigger_group {
259 u64 as_uint64;
260 struct {
261 u32 pending;
262 u32 armed;
263 };
264};
265
266struct hv_monitor_parameter {
267 union hv_connection_id connectionid;
268 u16 flagnumber;
269 u16 rsvdz;
270};
271
272union hv_monitor_trigger_state {
273 u32 asu32;
274
275 struct {
276 u32 group_enable:4;
277 u32 rsvdz:28;
278 };
279};
280
281/* struct hv_monitor_page Layout */
282/* ------------------------------------------------------ */
283/* | 0 | TriggerState (4 bytes) | Rsvd1 (4 bytes) | */
284/* | 8 | TriggerGroup[0] | */
285/* | 10 | TriggerGroup[1] | */
286/* | 18 | TriggerGroup[2] | */
287/* | 20 | TriggerGroup[3] | */
288/* | 28 | Rsvd2[0] | */
289/* | 30 | Rsvd2[1] | */
290/* | 38 | Rsvd2[2] | */
291/* | 40 | NextCheckTime[0][0] | NextCheckTime[0][1] | */
292/* | ... | */
293/* | 240 | Latency[0][0..3] | */
294/* | 340 | Rsvz3[0] | */
295/* | 440 | Parameter[0][0] | */
296/* | 448 | Parameter[0][1] | */
297/* | ... | */
298/* | 840 | Rsvd4[0] | */
299/* ------------------------------------------------------ */
300struct hv_monitor_page {
301 union hv_monitor_trigger_state trigger_state;
302 u32 rsvdz1;
303
304 union hv_monitor_trigger_group trigger_group[4];
305 u64 rsvdz2[3];
306
307 s32 next_checktime[4][32];
308
309 u16 latency[4][32];
310 u64 rsvdz3[32];
311
312 struct hv_monitor_parameter parameter[4][32];
313
314 u8 rsvdz4[1984];
315};
316
317/* Declare the various hypercall operations. */
318enum hv_call_code {
319 HVCALL_POST_MESSAGE = 0x005c,
320 HVCALL_SIGNAL_EVENT = 0x005d,
321};
322
323/* Definition of the hv_post_message hypercall input structure. */
324struct hv_input_post_message {
325 union hv_connection_id connectionid;
326 u32 reserved;
327 enum hv_message_type message_type;
328 u32 payload_size;
329 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
330};
331
332/*
333 * Versioning definitions used for guests reporting themselves to the
334 * hypervisor, and visa versa.
335 */
336
337/* Version info reported by guest OS's */
338enum hv_guest_os_vendor {
339 HVGUESTOS_VENDOR_MICROSOFT = 0x0001
340};
341
342enum hv_guest_os_microsoft_ids {
343 HVGUESTOS_MICROSOFT_UNDEFINED = 0x00,
344 HVGUESTOS_MICROSOFT_MSDOS = 0x01,
345 HVGUESTOS_MICROSOFT_WINDOWS3X = 0x02,
346 HVGUESTOS_MICROSOFT_WINDOWS9X = 0x03,
347 HVGUESTOS_MICROSOFT_WINDOWSNT = 0x04,
348 HVGUESTOS_MICROSOFT_WINDOWSCE = 0x05
349};
350
351/*
352 * Declare the MSR used to identify the guest OS.
353 */
354#define HV_X64_MSR_GUEST_OS_ID 0x40000000
355
356union hv_x64_msr_guest_os_id_contents {
357 u64 as_uint64;
358 struct {
359 u64 build_number:16;
360 u64 service_version:8; /* Service Pack, etc. */
361 u64 minor_version:8;
362 u64 major_version:8;
363 u64 os_id:8; /* enum hv_guest_os_microsoft_ids (if Vendor=MS) */
364 u64 vendor_id:16; /* enum hv_guest_os_vendor */
365 };
366};
367
368/*
369 * Declare the MSR used to setup pages used to communicate with the hypervisor.
370 */
371#define HV_X64_MSR_HYPERCALL 0x40000001
372
373union hv_x64_msr_hypercall_contents {
374 u64 as_uint64;
375 struct {
376 u64 enable:1;
377 u64 reserved:11;
378 u64 guest_physical_address:52;
379 };
380};
381
382
383enum {
384 VMBUS_MESSAGE_CONNECTION_ID = 1,
385 VMBUS_MESSAGE_PORT_ID = 1,
386 VMBUS_EVENT_CONNECTION_ID = 2,
387 VMBUS_EVENT_PORT_ID = 2,
388 VMBUS_MONITOR_CONNECTION_ID = 3,
389 VMBUS_MONITOR_PORT_ID = 3,
390 VMBUS_MESSAGE_SINT = 2,
391};
392
393/* #defines */
394
395#define HV_PRESENT_BIT 0x80000000
396
397/*
398 * The guest OS needs to register the guest ID with the hypervisor.
399 * The guest ID is a 64 bit entity and the structure of this ID is
400 * specified in the Hyper-V specification:
401 *
402 * http://msdn.microsoft.com/en-us/library/windows/hardware/ff542653%28v=vs.85%29.aspx
403 *
404 * While the current guideline does not specify how Linux guest ID(s)
405 * need to be generated, our plan is to publish the guidelines for
406 * Linux and other guest operating systems that currently are hosted
407 * on Hyper-V. The implementation here conforms to this yet
408 * unpublished guidelines.
409 *
410 *
411 * Bit(s)
412 * 63 - Indicates if the OS is Open Source or not; 1 is Open Source
413 * 62:56 - Os Type; Linux is 0x100
414 * 55:48 - Distro specific identification
415 * 47:16 - Linux kernel version number
416 * 15:0 - Distro specific identification
417 *
418 *
419 */
420
421#define HV_LINUX_VENDOR_ID 0x8100
422
423/*
424 * Generate the guest ID based on the guideline described above.
425 */
426
427static inline __u64 generate_guest_id(__u8 d_info1, __u32 kernel_version,
428 __u16 d_info2)
429{
430 __u64 guest_id = 0;
431
432 guest_id = (((__u64)HV_LINUX_VENDOR_ID) << 48);
433 guest_id |= (((__u64)(d_info1)) << 48);
434 guest_id |= (((__u64)(kernel_version)) << 16);
435 guest_id |= ((__u64)(d_info2));
436
437 return guest_id;
438}
439
440
441#define HV_CPU_POWER_MANAGEMENT (1 << 0)
442#define HV_RECOMMENDATIONS_MAX 4
443
444#define HV_X64_MAX 5
445#define HV_CAPS_MAX 8
446
447
448#define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
449
450
451/* Service definitions */
452
453#define HV_SERVICE_PARENT_PORT (0)
454#define HV_SERVICE_PARENT_CONNECTION (0)
455
456#define HV_SERVICE_CONNECT_RESPONSE_SUCCESS (0)
457#define HV_SERVICE_CONNECT_RESPONSE_INVALID_PARAMETER (1)
458#define HV_SERVICE_CONNECT_RESPONSE_UNKNOWN_SERVICE (2)
459#define HV_SERVICE_CONNECT_RESPONSE_CONNECTION_REJECTED (3)
460
461#define HV_SERVICE_CONNECT_REQUEST_MESSAGE_ID (1)
462#define HV_SERVICE_CONNECT_RESPONSE_MESSAGE_ID (2)
463#define HV_SERVICE_DISCONNECT_REQUEST_MESSAGE_ID (3)
464#define HV_SERVICE_DISCONNECT_RESPONSE_MESSAGE_ID (4)
465#define HV_SERVICE_MAX_MESSAGE_ID (4)
466
467#define HV_SERVICE_PROTOCOL_VERSION (0x0010)
468#define HV_CONNECT_PAYLOAD_BYTE_COUNT 64
469
470/* #define VMBUS_REVISION_NUMBER 6 */
471
472/* Our local vmbus's port and connection id. Anything >0 is fine */
473/* #define VMBUS_PORT_ID 11 */
474
475/* 628180B8-308D-4c5e-B7DB-1BEB62E62EF4 */
476static const uuid_le VMBUS_SERVICE_ID = {
477 .b = {
478 0xb8, 0x80, 0x81, 0x62, 0x8d, 0x30, 0x5e, 0x4c,
479 0xb7, 0xdb, 0x1b, 0xeb, 0x62, 0xe6, 0x2e, 0xf4
480 },
481};
482
483
484
485struct hv_context {
486 /* We only support running on top of Hyper-V
487 * So at this point this really can only contain the Hyper-V ID
488 */
489 u64 guestid;
490
491 void *hypercall_page;
492
493 bool synic_initialized;
494
495 void *synic_message_page[NR_CPUS];
496 void *synic_event_page[NR_CPUS];
497 /*
498 * Hypervisor's notion of virtual processor ID is different from
499 * Linux' notion of CPU ID. This information can only be retrieved
500 * in the context of the calling CPU. Setup a map for easy access
501 * to this information:
502 *
503 * vp_index[a] is the Hyper-V's processor ID corresponding to
504 * Linux cpuid 'a'.
505 */
506 u32 vp_index[NR_CPUS];
507 /*
508 * Starting with win8, we can take channel interrupts on any CPU;
509 * we will manage the tasklet that handles events on a per CPU
510 * basis.
511 */
512 struct tasklet_struct *event_dpc[NR_CPUS];
513};
514
515extern struct hv_context hv_context;
516
517struct hv_ring_buffer_debug_info {
518 u32 current_interrupt_mask;
519 u32 current_read_index;
520 u32 current_write_index;
521 u32 bytes_avail_toread;
522 u32 bytes_avail_towrite;
523};
524
525/* Hv Interface */
526
527extern int hv_init(void);
528
529extern void hv_cleanup(void);
530
531extern int hv_post_message(union hv_connection_id connection_id,
532 enum hv_message_type message_type,
533 void *payload, size_t payload_size);
534
535extern u16 hv_signal_event(void *con_id);
536
537extern int hv_synic_alloc(void);
538
539extern void hv_synic_free(void);
540
541extern void hv_synic_init(void *irqarg);
542
543extern void hv_synic_cleanup(void *arg);
544
545/*
546 * Host version information.
547 */
548extern unsigned int host_info_eax;
549extern unsigned int host_info_ebx;
550extern unsigned int host_info_ecx;
551extern unsigned int host_info_edx;
552
553/* Interface */
554
555
556int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info, void *buffer,
557 u32 buflen);
558
559void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
560
561int hv_ringbuffer_write(struct hv_ring_buffer_info *ring_info,
562 struct kvec *kv_list,
563 u32 kv_count, bool *signal);
564
565int hv_ringbuffer_peek(struct hv_ring_buffer_info *ring_info, void *buffer,
566 u32 buflen);
567
568int hv_ringbuffer_read(struct hv_ring_buffer_info *ring_info,
569 void *buffer,
570 u32 buflen,
571 u32 offset, bool *signal);
572
573
574void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info *ring_info,
575 struct hv_ring_buffer_debug_info *debug_info);
576
577void hv_begin_read(struct hv_ring_buffer_info *rbi);
578
579u32 hv_end_read(struct hv_ring_buffer_info *rbi);
580
581/*
582 * Maximum channels is determined by the size of the interrupt page
583 * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
584 * and the other is receive endpoint interrupt
585 */
586#define MAX_NUM_CHANNELS ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
587
588/* The value here must be in multiple of 32 */
589/* TODO: Need to make this configurable */
590#define MAX_NUM_CHANNELS_SUPPORTED 256
591
592
593enum vmbus_connect_state {
594 DISCONNECTED,
595 CONNECTING,
596 CONNECTED,
597 DISCONNECTING
598};
599
600#define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
601
602struct vmbus_connection {
603 enum vmbus_connect_state conn_state;
604
605 atomic_t next_gpadl_handle;
606
607 /*
608 * Represents channel interrupts. Each bit position represents a
609 * channel. When a channel sends an interrupt via VMBUS, it finds its
610 * bit in the sendInterruptPage, set it and calls Hv to generate a port
611 * event. The other end receives the port event and parse the
612 * recvInterruptPage to see which bit is set
613 */
614 void *int_page;
615 void *send_int_page;
616 void *recv_int_page;
617
618 /*
619 * 2 pages - 1st page for parent->child notification and 2nd
620 * is child->parent notification
621 */
622 struct hv_monitor_page *monitor_pages[2];
623 struct list_head chn_msg_list;
624 spinlock_t channelmsg_lock;
625
626 /* List of channels */
627 struct list_head chn_list;
628 spinlock_t channel_lock;
629
630 struct workqueue_struct *work_queue;
631};
632
633
634struct vmbus_msginfo {
635 /* Bookkeeping stuff */
636 struct list_head msglist_entry;
637
638 /* The message itself */
639 unsigned char msg[0];
640};
641
642
643extern struct vmbus_connection vmbus_connection;
644
645/* General vmbus interface */
646
647struct hv_device *vmbus_device_create(uuid_le *type,
648 uuid_le *instance,
649 struct vmbus_channel *channel);
650
651int vmbus_device_register(struct hv_device *child_device_obj);
652void vmbus_device_unregister(struct hv_device *device_obj);
653
654/* static void */
655/* VmbusChildDeviceDestroy( */
656/* struct hv_device *); */
657
658struct vmbus_channel *relid2channel(u32 relid);
659
660void vmbus_free_channels(void);
661
662/* Connection interface */
663
664int vmbus_connect(void);
665
666int vmbus_post_msg(void *buffer, size_t buflen);
667
668int vmbus_set_event(struct vmbus_channel *channel);
669
670void vmbus_on_event(unsigned long data);
671
672int hv_fcopy_init(struct hv_util_service *);
673void hv_fcopy_deinit(void);
674void hv_fcopy_onchannelcallback(void *);
675
676
677#endif /* _HYPERV_VMBUS_H */