Commit | Line | Data |
---|---|---|
3b20eb23 | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
0f2a6619 S |
2 | /* |
3 | * | |
4 | * Copyright (c) 2011, Microsoft Corporation. | |
5 | * | |
0f2a6619 S |
6 | * Authors: |
7 | * Haiyang Zhang <haiyangz@microsoft.com> | |
8 | * Hank Janssen <hjanssen@microsoft.com> | |
9 | * K. Y. Srinivasan <kys@microsoft.com> | |
0f2a6619 S |
10 | */ |
11 | ||
12 | #ifndef _HYPERV_VMBUS_H | |
13 | #define _HYPERV_VMBUS_H | |
14 | ||
43c698b9 S |
15 | #include <linux/list.h> |
16 | #include <asm/sync_bitops.h> | |
5a485803 | 17 | #include <asm/hyperv-tlfs.h> |
43c698b9 | 18 | #include <linux/atomic.h> |
46a97191 | 19 | #include <linux/hyperv.h> |
37cdd991 | 20 | #include <linux/interrupt.h> |
43c698b9 | 21 | |
c9fe0f8f VK |
22 | #include "hv_trace.h" |
23 | ||
c0b200cf S |
24 | /* |
25 | * Timeout for services such as KVP and fcopy. | |
26 | */ | |
27 | #define HV_UTIL_TIMEOUT 30 | |
28 | ||
4dbfc2e6 VK |
29 | /* |
30 | * Timeout for guest-host handshake for services. | |
31 | */ | |
d7edd31b | 32 | #define HV_UTIL_NEGO_TIMEOUT 55 |
4dbfc2e6 | 33 | |
afbdc4a9 S |
34 | |
35 | /* Definitions for the monitored notification facility */ | |
36 | union hv_monitor_trigger_group { | |
37 | u64 as_uint64; | |
38 | struct { | |
39 | u32 pending; | |
40 | u32 armed; | |
41 | }; | |
42 | }; | |
43 | ||
44 | struct hv_monitor_parameter { | |
45 | union hv_connection_id connectionid; | |
46 | u16 flagnumber; | |
47 | u16 rsvdz; | |
48 | }; | |
49 | ||
50 | union hv_monitor_trigger_state { | |
51 | u32 asu32; | |
52 | ||
53 | struct { | |
54 | u32 group_enable:4; | |
55 | u32 rsvdz:28; | |
56 | }; | |
57 | }; | |
58 | ||
59 | /* struct hv_monitor_page Layout */ | |
60 | /* ------------------------------------------------------ */ | |
61 | /* | 0 | TriggerState (4 bytes) | Rsvd1 (4 bytes) | */ | |
62 | /* | 8 | TriggerGroup[0] | */ | |
63 | /* | 10 | TriggerGroup[1] | */ | |
64 | /* | 18 | TriggerGroup[2] | */ | |
65 | /* | 20 | TriggerGroup[3] | */ | |
66 | /* | 28 | Rsvd2[0] | */ | |
67 | /* | 30 | Rsvd2[1] | */ | |
68 | /* | 38 | Rsvd2[2] | */ | |
69 | /* | 40 | NextCheckTime[0][0] | NextCheckTime[0][1] | */ | |
70 | /* | ... | */ | |
71 | /* | 240 | Latency[0][0..3] | */ | |
72 | /* | 340 | Rsvz3[0] | */ | |
73 | /* | 440 | Parameter[0][0] | */ | |
74 | /* | 448 | Parameter[0][1] | */ | |
75 | /* | ... | */ | |
76 | /* | 840 | Rsvd4[0] | */ | |
77 | /* ------------------------------------------------------ */ | |
78 | struct hv_monitor_page { | |
79 | union hv_monitor_trigger_state trigger_state; | |
80 | u32 rsvdz1; | |
81 | ||
82 | union hv_monitor_trigger_group trigger_group[4]; | |
83 | u64 rsvdz2[3]; | |
84 | ||
85 | s32 next_checktime[4][32]; | |
86 | ||
87 | u16 latency[4][32]; | |
88 | u64 rsvdz3[32]; | |
89 | ||
90 | struct hv_monitor_parameter parameter[4][32]; | |
91 | ||
92 | u8 rsvdz4[1984]; | |
93 | }; | |
94 | ||
8e27a236 S |
95 | #define HV_HYPERCALL_PARAM_ALIGN sizeof(u64) |
96 | ||
afbdc4a9 S |
97 | /* Definition of the hv_post_message hypercall input structure. */ |
98 | struct hv_input_post_message { | |
99 | union hv_connection_id connectionid; | |
100 | u32 reserved; | |
7797dcf6 | 101 | u32 message_type; |
afbdc4a9 S |
102 | u32 payload_size; |
103 | u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT]; | |
104 | }; | |
105 | ||
afbdc4a9 | 106 | |
3645a917 S |
107 | enum { |
108 | VMBUS_MESSAGE_CONNECTION_ID = 1, | |
ae20b254 | 109 | VMBUS_MESSAGE_CONNECTION_ID_4 = 4, |
3645a917 S |
110 | VMBUS_MESSAGE_PORT_ID = 1, |
111 | VMBUS_EVENT_CONNECTION_ID = 2, | |
112 | VMBUS_EVENT_PORT_ID = 2, | |
113 | VMBUS_MONITOR_CONNECTION_ID = 3, | |
114 | VMBUS_MONITOR_PORT_ID = 3, | |
115 | VMBUS_MESSAGE_SINT = 2, | |
116 | }; | |
117 | ||
37cdd991 SH |
118 | /* |
119 | * Per cpu state for channel handling | |
120 | */ | |
121 | struct hv_per_cpu_context { | |
122 | void *synic_message_page; | |
123 | void *synic_event_page; | |
124 | /* | |
125 | * buffer to post messages to the host. | |
126 | */ | |
127 | void *post_msg_page; | |
128 | ||
129 | /* | |
130 | * Starting with win8, we can take channel interrupts on any CPU; | |
131 | * we will manage the tasklet that handles events messages on a per CPU | |
132 | * basis. | |
133 | */ | |
37cdd991 SH |
134 | struct tasklet_struct msg_dpc; |
135 | ||
136 | /* | |
137 | * To optimize the mapping of relid to channel, maintain | |
138 | * per-cpu list of the channels based on their CPU affinity. | |
139 | */ | |
140 | struct list_head chan_list; | |
37cdd991 SH |
141 | }; |
142 | ||
3645a917 S |
143 | struct hv_context { |
144 | /* We only support running on top of Hyper-V | |
2a9d7de2 SH |
145 | * So at this point this really can only contain the Hyper-V ID |
146 | */ | |
3645a917 S |
147 | u64 guestid; |
148 | ||
ca9357bd | 149 | void *tsc_page; |
3645a917 | 150 | |
37cdd991 SH |
151 | struct hv_per_cpu_context __percpu *cpu_context; |
152 | ||
9f01ec53 S |
153 | /* |
154 | * To manage allocations in a NUMA node. | |
155 | * Array indexed by numa node ID. | |
156 | */ | |
157 | struct cpumask *hv_numa_map; | |
3645a917 S |
158 | }; |
159 | ||
160 | extern struct hv_context hv_context; | |
161 | ||
3645a917 S |
162 | /* Hv Interface */ |
163 | ||
164 | extern int hv_init(void); | |
165 | ||
415f0a02 | 166 | extern int hv_post_message(union hv_connection_id connection_id, |
3645a917 S |
167 | enum hv_message_type message_type, |
168 | void *payload, size_t payload_size); | |
169 | ||
2608fb65 JW |
170 | extern int hv_synic_alloc(void); |
171 | ||
172 | extern void hv_synic_free(void); | |
173 | ||
dba61cda | 174 | extern void hv_synic_enable_regs(unsigned int cpu); |
76d36ab7 | 175 | extern int hv_synic_init(unsigned int cpu); |
3645a917 | 176 | |
dba61cda | 177 | extern void hv_synic_disable_regs(unsigned int cpu); |
76d36ab7 | 178 | extern int hv_synic_cleanup(unsigned int cpu); |
3645a917 | 179 | |
940655c1 S |
180 | /* Interface */ |
181 | ||
14948e39 | 182 | void hv_ringbuffer_pre_init(struct vmbus_channel *channel); |
940655c1 | 183 | |
9988ce68 VK |
184 | int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info, |
185 | struct page *pages, u32 pagecnt); | |
940655c1 S |
186 | |
187 | void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info); | |
188 | ||
1f6ee4e7 | 189 | int hv_ringbuffer_write(struct vmbus_channel *channel, |
e4165a0f | 190 | const struct kvec *kv_list, u32 kv_count); |
940655c1 | 191 | |
3372592a | 192 | int hv_ringbuffer_read(struct vmbus_channel *channel, |
940b68e2 | 193 | void *buffer, u32 buflen, u32 *buffer_actual_len, |
3372592a | 194 | u64 *requestid, bool raw); |
940655c1 | 195 | |
89b2ca47 S |
196 | /* |
197 | * Maximum channels is determined by the size of the interrupt page | |
198 | * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt | |
199 | * and the other is receive endpoint interrupt | |
200 | */ | |
201 | #define MAX_NUM_CHANNELS ((PAGE_SIZE >> 1) << 3) /* 16348 channels */ | |
202 | ||
203 | /* The value here must be in multiple of 32 */ | |
204 | /* TODO: Need to make this configurable */ | |
205 | #define MAX_NUM_CHANNELS_SUPPORTED 256 | |
206 | ||
207 | ||
208 | enum vmbus_connect_state { | |
209 | DISCONNECTED, | |
210 | CONNECTING, | |
211 | CONNECTED, | |
212 | DISCONNECTING | |
213 | }; | |
214 | ||
215 | #define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT | |
216 | ||
217 | struct vmbus_connection { | |
54a66265 S |
218 | /* |
219 | * CPU on which the initial host contact was made. | |
220 | */ | |
221 | int connect_cpu; | |
222 | ||
ae20b254 DC |
223 | u32 msg_conn_id; |
224 | ||
54a66265 S |
225 | atomic_t offer_in_progress; |
226 | ||
89b2ca47 S |
227 | enum vmbus_connect_state conn_state; |
228 | ||
229 | atomic_t next_gpadl_handle; | |
230 | ||
2db84eff | 231 | struct completion unload_event; |
89b2ca47 S |
232 | /* |
233 | * Represents channel interrupts. Each bit position represents a | |
234 | * channel. When a channel sends an interrupt via VMBUS, it finds its | |
235 | * bit in the sendInterruptPage, set it and calls Hv to generate a port | |
236 | * event. The other end receives the port event and parse the | |
237 | * recvInterruptPage to see which bit is set | |
238 | */ | |
239 | void *int_page; | |
240 | void *send_int_page; | |
241 | void *recv_int_page; | |
242 | ||
243 | /* | |
244 | * 2 pages - 1st page for parent->child notification and 2nd | |
245 | * is child->parent notification | |
246 | */ | |
8681db44 | 247 | struct hv_monitor_page *monitor_pages[2]; |
89b2ca47 S |
248 | struct list_head chn_msg_list; |
249 | spinlock_t channelmsg_lock; | |
250 | ||
251 | /* List of channels */ | |
252 | struct list_head chn_list; | |
d6f591e3 | 253 | struct mutex channel_mutex; |
89b2ca47 | 254 | |
37c2578c DC |
255 | /* |
256 | * An offer message is handled first on the work_queue, and then | |
257 | * is further handled on handle_primary_chan_wq or | |
258 | * handle_sub_chan_wq. | |
259 | */ | |
89b2ca47 | 260 | struct workqueue_struct *work_queue; |
37c2578c DC |
261 | struct workqueue_struct *handle_primary_chan_wq; |
262 | struct workqueue_struct *handle_sub_chan_wq; | |
89b2ca47 S |
263 | }; |
264 | ||
265 | ||
266 | struct vmbus_msginfo { | |
267 | /* Bookkeeping stuff */ | |
268 | struct list_head msglist_entry; | |
269 | ||
270 | /* The message itself */ | |
271 | unsigned char msg[0]; | |
272 | }; | |
273 | ||
274 | ||
275 | extern struct vmbus_connection vmbus_connection; | |
276 | ||
5c1bec61 SH |
277 | static inline void vmbus_send_interrupt(u32 relid) |
278 | { | |
279 | sync_set_bit(relid, vmbus_connection.send_int_page); | |
280 | } | |
281 | ||
652594c7 DC |
282 | enum vmbus_message_handler_type { |
283 | /* The related handler can sleep. */ | |
284 | VMHT_BLOCKING = 0, | |
285 | ||
286 | /* The related handler must NOT sleep. */ | |
287 | VMHT_NON_BLOCKING = 1, | |
288 | }; | |
289 | ||
290 | struct vmbus_channel_message_table_entry { | |
291 | enum vmbus_channel_message_type message_type; | |
292 | enum vmbus_message_handler_type handler_type; | |
293 | void (*message_handler)(struct vmbus_channel_message_header *msg); | |
294 | }; | |
295 | ||
e6242fa0 | 296 | extern const struct vmbus_channel_message_table_entry |
652594c7 DC |
297 | channel_message_table[CHANNELMSG_COUNT]; |
298 | ||
0f70b669 | 299 | |
89b2ca47 S |
300 | /* General vmbus interface */ |
301 | ||
593db803 AS |
302 | struct hv_device *vmbus_device_create(const guid_t *type, |
303 | const guid_t *instance, | |
1b9d48f2 | 304 | struct vmbus_channel *channel); |
89b2ca47 | 305 | |
22794281 | 306 | int vmbus_device_register(struct hv_device *child_device_obj); |
696453ba | 307 | void vmbus_device_unregister(struct hv_device *device_obj); |
c2e5df61 SH |
308 | int vmbus_add_channel_kobj(struct hv_device *device_obj, |
309 | struct vmbus_channel *channel); | |
89b2ca47 | 310 | |
46fc1548 KB |
311 | void vmbus_remove_channel_attr_group(struct vmbus_channel *channel); |
312 | ||
d43e2fe7 | 313 | struct vmbus_channel *relid2channel(u32 relid); |
89b2ca47 | 314 | |
93e5bd06 | 315 | void vmbus_free_channels(void); |
89b2ca47 S |
316 | |
317 | /* Connection interface */ | |
318 | ||
319 | int vmbus_connect(void); | |
09a19628 | 320 | void vmbus_disconnect(void); |
89b2ca47 | 321 | |
c0bb0392 | 322 | int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep); |
89b2ca47 | 323 | |
89b2ca47 | 324 | void vmbus_on_event(unsigned long data); |
d81274aa | 325 | void vmbus_on_msg_dpc(unsigned long data); |
89b2ca47 | 326 | |
2a9d7de2 | 327 | int hv_kvp_init(struct hv_util_service *srv); |
3647a83d | 328 | void hv_kvp_deinit(void); |
2a9d7de2 | 329 | void hv_kvp_onchannelcallback(void *context); |
3647a83d | 330 | |
2a9d7de2 | 331 | int hv_vss_init(struct hv_util_service *srv); |
3647a83d | 332 | void hv_vss_deinit(void); |
2a9d7de2 | 333 | void hv_vss_onchannelcallback(void *context); |
3647a83d | 334 | |
2a9d7de2 | 335 | int hv_fcopy_init(struct hv_util_service *srv); |
01325476 | 336 | void hv_fcopy_deinit(void); |
2a9d7de2 | 337 | void hv_fcopy_onchannelcallback(void *context); |
75ff3a8a | 338 | void vmbus_initiate_unload(bool crash); |
01325476 | 339 | |
8efe78fd VK |
340 | static inline void hv_poll_channel(struct vmbus_channel *channel, |
341 | void (*cb)(void *)) | |
342 | { | |
343 | if (!channel) | |
344 | return; | |
345 | ||
1e052a16 S |
346 | if (in_interrupt() && (channel->target_cpu == smp_processor_id())) { |
347 | cb(channel); | |
348 | return; | |
349 | } | |
3cace4a6 | 350 | smp_call_function_single(channel->target_cpu, cb, channel, true); |
8efe78fd | 351 | } |
89b2ca47 | 352 | |
636c88da VK |
353 | enum hvutil_device_state { |
354 | HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */ | |
355 | HVUTIL_READY, /* userspace is registered */ | |
356 | HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */ | |
357 | HVUTIL_USERSPACE_REQ, /* request to userspace was sent */ | |
358 | HVUTIL_USERSPACE_RECV, /* reply from userspace was received */ | |
359 | HVUTIL_DEVICE_DYING, /* driver unload is in progress */ | |
360 | }; | |
361 | ||
0f2a6619 | 362 | #endif /* _HYPERV_VMBUS_H */ |