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