2 * Copyright (c) 2009-2012 Microsoft Corp.
3 * Copyright (c) 2012 NetApp Inc.
4 * Copyright (c) 2012 Citrix Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice unmodified, this list of conditions, and the following
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 * VM Bus Driver Implementation
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
37 #include <sys/kernel.h>
39 #include <sys/malloc.h>
40 #include <sys/module.h>
42 #include <sys/sysctl.h>
43 #include <sys/syslog.h>
44 #include <sys/systm.h>
45 #include <sys/rtprio.h>
46 #include <sys/interrupt.h>
48 #include <sys/taskqueue.h>
49 #include <sys/mutex.h>
52 #include <machine/resource.h>
55 #include <machine/stdarg.h>
56 #include <machine/intr_machdep.h>
57 #include <machine/md_var.h>
58 #include <machine/segments.h>
60 #include <x86/apicvar.h>
62 #include "hv_vmbus_priv.h"
64 #include <contrib/dev/acpica/include/acpi.h>
67 static device_t vmbus_devp;
68 static int vmbus_inited;
69 static hv_setup_args setup_args; /* only CPU 0 supported at this time */
71 static char *vmbus_ids[] = { "VMBUS", NULL };
74 * @brief Software interrupt thread routine to handle channel messages from
78 vmbus_msg_swintr(void *arg)
82 hv_vmbus_channel_msg_header *hdr;
83 hv_vmbus_channel_msg_table_entry *entry;
84 hv_vmbus_channel_msg_type msg_type;
85 hv_vmbus_message* msg;
88 KASSERT(cpu <= mp_maxid, ("VMBUS: vmbus_msg_swintr: "
89 "cpu out of range!"));
91 page_addr = hv_vmbus_g_context.syn_ic_msg_page[cpu];
92 msg = (hv_vmbus_message*) page_addr + HV_VMBUS_MESSAGE_SINT;
95 if (msg->header.message_type == HV_MESSAGE_TYPE_NONE)
96 break; /* no message */
98 hdr = (hv_vmbus_channel_msg_header *)msg->u.payload;
99 msg_type = hdr->message_type;
101 if (msg_type >= HV_CHANNEL_MESSAGE_COUNT) {
102 printf("VMBUS: unknown message type = %d\n", msg_type);
106 entry = &g_channel_message_table[msg_type];
108 if (entry->messageHandler)
109 entry->messageHandler(hdr);
111 msg->header.message_type = HV_MESSAGE_TYPE_NONE;
114 * Make sure the write to message_type (ie set to
115 * HV_MESSAGE_TYPE_NONE) happens before we read the
116 * message_pending and EOMing. Otherwise, the EOMing will
117 * not deliver any more messages
118 * since there is no empty slot
122 if (msg->header.message_flags.u.message_pending) {
124 * This will cause message queue rescan to possibly
125 * deliver another msg from the hypervisor
127 wrmsr(HV_X64_MSR_EOM, 0);
133 * @brief Interrupt filter routine for VMBUS.
135 * The purpose of this routine is to determine the type of VMBUS protocol
136 * message to process - an event or a channel message.
139 hv_vmbus_isr(struct trapframe *frame)
142 hv_vmbus_message* msg;
143 hv_vmbus_synic_event_flags* event;
146 cpu = PCPU_GET(cpuid);
149 * The Windows team has advised that we check for events
150 * before checking for messages. This is the way they do it
151 * in Windows when running as a guest in Hyper-V
154 page_addr = hv_vmbus_g_context.syn_ic_event_page[cpu];
155 event = (hv_vmbus_synic_event_flags*)
156 page_addr + HV_VMBUS_MESSAGE_SINT;
158 if ((hv_vmbus_protocal_version == HV_VMBUS_VERSION_WS2008) ||
159 (hv_vmbus_protocal_version == HV_VMBUS_VERSION_WIN7)) {
160 /* Since we are a child, we only need to check bit 0 */
161 if (synch_test_and_clear_bit(0, &event->flags32[0])) {
162 hv_vmbus_on_events(cpu);
166 * On host with Win8 or above, we can directly look at
167 * the event page. If bit n is set, we have an interrupt
168 * on the channel with id n.
169 * Directly schedule the event software interrupt on
172 hv_vmbus_on_events(cpu);
175 /* Check if there are actual msgs to be process */
176 page_addr = hv_vmbus_g_context.syn_ic_msg_page[cpu];
177 msg = (hv_vmbus_message*) page_addr + HV_VMBUS_MESSAGE_SINT;
179 /* we call eventtimer process the message */
180 if (msg->header.message_type == HV_MESSAGE_TIMER_EXPIRED) {
181 msg->header.message_type = HV_MESSAGE_TYPE_NONE;
184 * Make sure the write to message_type (ie set to
185 * HV_MESSAGE_TYPE_NONE) happens before we read the
186 * message_pending and EOMing. Otherwise, the EOMing will
187 * not deliver any more messages
188 * since there is no empty slot
192 if (msg->header.message_flags.u.message_pending) {
194 * This will cause message queue rescan to possibly
195 * deliver another msg from the hypervisor
197 wrmsr(HV_X64_MSR_EOM, 0);
200 return (FILTER_HANDLED);
203 if (msg->header.message_type != HV_MESSAGE_TYPE_NONE) {
204 swi_sched(hv_vmbus_g_context.msg_swintr[cpu], 0);
207 return (FILTER_HANDLED);
210 u_long *hv_vmbus_intr_cpu[MAXCPU];
213 hv_vector_handler(struct trapframe *trap_frame)
218 * Disable preemption.
223 * Do a little interrupt counting.
225 cpu = PCPU_GET(cpuid);
226 (*hv_vmbus_intr_cpu[cpu])++;
228 hv_vmbus_isr(trap_frame);
243 struct hv_device *child_dev_ctx = device_get_ivars(child);
247 case HV_VMBUS_IVAR_TYPE:
248 *result = (uintptr_t) &child_dev_ctx->class_id;
250 case HV_VMBUS_IVAR_INSTANCE:
251 *result = (uintptr_t) &child_dev_ctx->device_id;
253 case HV_VMBUS_IVAR_DEVCTX:
254 *result = (uintptr_t) child_dev_ctx;
256 case HV_VMBUS_IVAR_NODE:
257 *result = (uintptr_t) child_dev_ctx->device;
272 case HV_VMBUS_IVAR_TYPE:
273 case HV_VMBUS_IVAR_INSTANCE:
274 case HV_VMBUS_IVAR_DEVCTX:
275 case HV_VMBUS_IVAR_NODE:
283 hv_vmbus_child_device_create(
286 hv_vmbus_channel* channel)
288 hv_device* child_dev;
291 * Allocate the new child device
293 child_dev = malloc(sizeof(hv_device), M_DEVBUF,
296 child_dev->channel = channel;
297 memcpy(&child_dev->class_id, &type, sizeof(hv_guid));
298 memcpy(&child_dev->device_id, &instance, sizeof(hv_guid));
304 print_dev_guid(struct hv_device *dev)
307 unsigned char guid_name[100];
308 for (i = 0; i < 32; i += 2)
309 sprintf(&guid_name[i], "%02x", dev->class_id.data[i / 2]);
311 printf("VMBUS: Class ID: %s\n", guid_name);
315 hv_vmbus_child_device_register(struct hv_device *child_dev)
320 print_dev_guid(child_dev);
323 child = device_add_child(vmbus_devp, NULL, -1);
324 child_dev->device = child;
325 device_set_ivars(child, child_dev);
328 ret = device_probe_and_attach(child);
335 hv_vmbus_child_device_unregister(struct hv_device *child_dev)
339 * XXXKYS: Ensure that this is the opposite of
343 ret = device_delete_child(vmbus_devp, child_dev->device);
349 vmbus_probe(device_t dev) {
350 if (ACPI_ID_PROBE(device_get_parent(dev), dev, vmbus_ids) == NULL ||
351 device_get_unit(dev) != 0)
354 device_set_desc(dev, "Vmbus Devices");
356 return (BUS_PROBE_DEFAULT);
360 extern inthand_t IDTVEC(rsvd), IDTVEC(hv_vmbus_callback);
363 * @brief Find a free IDT slot and setup the interrupt handler.
366 vmbus_vector_alloc(void)
370 struct gate_descriptor *ip;
373 * Search backwards form the highest IDT vector available for use
374 * as vmbus channel callback vector. We install 'hv_vmbus_callback'
375 * handler at that vector and use it to interrupt vcpus.
377 vector = APIC_SPURIOUS_INT;
378 while (--vector >= APIC_IPI_INTS) {
380 func = ((long)ip->gd_hioffset << 16 | ip->gd_looffset);
381 if (func == (uintptr_t)&IDTVEC(rsvd)) {
383 setidt(vector , IDTVEC(hv_vmbus_callback), SDT_SYS386IGT,
384 SEL_KPL, GSEL(GCODE_SEL, SEL_KPL));
386 setidt(vector , IDTVEC(hv_vmbus_callback), SDT_SYSIGT,
397 * @brief Restore the IDT slot to rsvd.
400 vmbus_vector_free(int vector)
403 struct gate_descriptor *ip;
408 KASSERT(vector >= APIC_IPI_INTS && vector < APIC_SPURIOUS_INT,
409 ("invalid vector %d", vector));
412 func = ((long)ip->gd_hioffset << 16 | ip->gd_looffset);
413 KASSERT(func == (uintptr_t)&IDTVEC(hv_vmbus_callback),
414 ("invalid vector %d", vector));
416 setidt(vector, IDTVEC(rsvd), SDT_SYSIGT, SEL_KPL, 0);
422 vmbus_vector_alloc(void)
428 vmbus_vector_free(int vector)
435 * @brief Main vmbus driver initialization routine.
438 * - initialize the vmbus driver context
439 * - setup various driver entry points
440 * - invoke the vmbus hv main init routine
441 * - get the irq resource
442 * - invoke the vmbus to add the vmbus root device
443 * - setup the vmbus root device
444 * - retrieve the channel offers
450 char buf[MAXCOMLEN + 1];
458 ret = hv_vmbus_init();
462 printf("Error VMBUS: Hypervisor Initialization Failed!\n");
467 * Find a free IDT slot for vmbus callback.
469 hv_vmbus_g_context.hv_cb_vector = vmbus_vector_alloc();
471 if (hv_vmbus_g_context.hv_cb_vector == 0) {
473 printf("Error VMBUS: Cannot find free IDT slot for "
474 "vmbus callback!\n");
479 printf("VMBUS: vmbus callback vector %d\n",
480 hv_vmbus_g_context.hv_cb_vector);
483 * Notify the hypervisor of our vector.
485 setup_args.vector = hv_vmbus_g_context.hv_cb_vector;
488 hv_vmbus_g_context.hv_msg_intr_event[j] = NULL;
489 hv_vmbus_g_context.msg_swintr[j] = NULL;
491 snprintf(buf, sizeof(buf), "cpu%d:hyperv", j);
492 intrcnt_add(buf, &hv_vmbus_intr_cpu[j]);
494 for (i = 0; i < 2; i++)
495 setup_args.page_buffers[2 * j + i] = NULL;
503 * Setup taskqueue to handle events
505 hv_vmbus_g_context.hv_event_queue[j] = taskqueue_create_fast("hyperv event", M_WAITOK,
506 taskqueue_thread_enqueue, &hv_vmbus_g_context.hv_event_queue[j]);
507 if (hv_vmbus_g_context.hv_event_queue[j] == NULL) {
509 printf("VMBUS: failed to setup taskqueue\n");
512 CPU_SETOF(j, &cpu_mask);
513 taskqueue_start_threads_cpuset(&hv_vmbus_g_context.hv_event_queue[j], 1, PI_NET, &cpu_mask,
517 * Setup software interrupt thread and handler for msg handling.
519 ret = swi_add(&hv_vmbus_g_context.hv_msg_intr_event[j],
520 "hv_msg", vmbus_msg_swintr, (void *)(long)j, SWI_CLOCK, 0,
521 &hv_vmbus_g_context.msg_swintr[j]);
524 printf("VMBUS: failed to setup msg swi for "
530 * Bind the swi thread to the cpu.
532 ret = intr_event_bind(hv_vmbus_g_context.hv_msg_intr_event[j],
536 printf("VMBUS: failed to bind msg swi thread "
542 * Prepare the per cpu msg and event pages to be called on each cpu.
544 for(i = 0; i < 2; i++) {
545 setup_args.page_buffers[2 * j + i] =
546 malloc(PAGE_SIZE, M_DEVBUF, M_WAITOK | M_ZERO);
551 printf("VMBUS: Calling smp_rendezvous, smp_started = %d\n",
554 smp_rendezvous(NULL, hv_vmbus_synic_init, NULL, &setup_args);
557 * Connect to VMBus in the root partition
559 ret = hv_vmbus_connect();
564 hv_vmbus_request_channel_offers();
569 * Free pages alloc'ed
571 for (n = 0; n < 2 * MAXCPU; n++)
572 if (setup_args.page_buffers[n] != NULL)
573 free(setup_args.page_buffers[n], M_DEVBUF);
576 * remove swi and vmbus callback vector;
579 if (hv_vmbus_g_context.hv_event_queue[j] != NULL)
580 taskqueue_free(hv_vmbus_g_context.hv_event_queue[j]);
581 if (hv_vmbus_g_context.msg_swintr[j] != NULL)
582 swi_remove(hv_vmbus_g_context.msg_swintr[j]);
583 hv_vmbus_g_context.hv_msg_intr_event[j] = NULL;
586 vmbus_vector_free(hv_vmbus_g_context.hv_cb_vector);
595 vmbus_attach(device_t dev)
598 device_printf(dev, "VMBUS: attach dev: %p\n", dev);
602 * If the system has already booted and thread
603 * scheduling is possible indicated by the global
604 * cold set to zero, we just call the driver
605 * initialization directly.
616 if (vm_guest != VM_GUEST_HV)
620 * If the system has already booted and thread
621 * scheduling is possible, as indicated by the
622 * global cold set to zero, we just call the driver
623 * initialization directly.
634 hv_vmbus_release_unattached_channels();
635 hv_vmbus_disconnect();
637 smp_rendezvous(NULL, hv_vmbus_synic_cleanup, NULL, NULL);
639 for(i = 0; i < 2 * MAXCPU; i++) {
640 if (setup_args.page_buffers[i] != 0)
641 free(setup_args.page_buffers[i], M_DEVBUF);
648 if (hv_vmbus_g_context.hv_event_queue[i] != NULL)
649 taskqueue_free(hv_vmbus_g_context.hv_event_queue[i]);
650 if (hv_vmbus_g_context.msg_swintr[i] != NULL)
651 swi_remove(hv_vmbus_g_context.msg_swintr[i]);
652 hv_vmbus_g_context.hv_msg_intr_event[i] = NULL;
655 vmbus_vector_free(hv_vmbus_g_context.hv_cb_vector);
667 vmbus_detach(device_t dev)
677 printf("VMBUS: load\n");
681 vmbus_mod_unload(void)
684 printf("VMBUS: unload\n");
688 vmbus_modevent(module_t mod, int what, void *arg)
703 static device_method_t vmbus_methods[] = {
704 /** Device interface */
705 DEVMETHOD(device_probe, vmbus_probe),
706 DEVMETHOD(device_attach, vmbus_attach),
707 DEVMETHOD(device_detach, vmbus_detach),
708 DEVMETHOD(device_shutdown, bus_generic_shutdown),
709 DEVMETHOD(device_suspend, bus_generic_suspend),
710 DEVMETHOD(device_resume, bus_generic_resume),
713 DEVMETHOD(bus_add_child, bus_generic_add_child),
714 DEVMETHOD(bus_print_child, bus_generic_print_child),
715 DEVMETHOD(bus_read_ivar, vmbus_read_ivar),
716 DEVMETHOD(bus_write_ivar, vmbus_write_ivar),
720 static char driver_name[] = "vmbus";
721 static driver_t vmbus_driver = { driver_name, vmbus_methods,0, };
724 devclass_t vmbus_devclass;
726 DRIVER_MODULE(vmbus, acpi, vmbus_driver, vmbus_devclass, vmbus_modevent, 0);
727 MODULE_DEPEND(vmbus, acpi, 1, 1, 1);
728 MODULE_VERSION(vmbus, 1);
730 /* We want to be started after SMP is initialized */
731 SYSINIT(vmb_init, SI_SUB_SMP + 1, SI_ORDER_FIRST, vmbus_init, NULL);