2 * Copyright (c) 2009, Microsoft Corporation.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
15 * Place - Suite 330, Boston, MA 02111-1307 USA.
18 * Haiyang Zhang <haiyangz@microsoft.com>
19 * Hank Janssen <hjanssen@microsoft.com>
20 * K. Y. Srinivasan <kys@microsoft.com>
23 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
25 #include <linux/init.h>
26 #include <linux/module.h>
27 #include <linux/device.h>
28 #include <linux/irq.h>
29 #include <linux/interrupt.h>
30 #include <linux/sysctl.h>
31 #include <linux/slab.h>
32 #include <linux/acpi.h>
33 #include <acpi/acpi_bus.h>
34 #include <linux/completion.h>
35 #include <linux/hyperv.h>
36 #include <asm/hyperv.h>
37 #include <asm/hypervisor.h>
38 #include "hyperv_vmbus.h"
41 static struct acpi_device *hv_acpi_dev;
43 static struct tasklet_struct msg_dpc;
44 static struct completion probe_event;
47 struct hv_device_info {
54 u32 server_monitor_pending;
55 u32 server_monitor_latency;
56 u32 server_monitor_conn_id;
57 u32 client_monitor_pending;
58 u32 client_monitor_latency;
59 u32 client_monitor_conn_id;
61 struct hv_dev_port_info inbound;
62 struct hv_dev_port_info outbound;
65 static int vmbus_exists(void)
67 if (hv_acpi_dev == NULL)
74 static void get_channel_info(struct hv_device *device,
75 struct hv_device_info *info)
77 struct vmbus_channel_debug_info debug_info;
82 vmbus_get_debug_info(device->channel, &debug_info);
84 info->chn_id = debug_info.relid;
85 info->chn_state = debug_info.state;
86 memcpy(&info->chn_type, &debug_info.interfacetype,
88 memcpy(&info->chn_instance, &debug_info.interface_instance,
91 info->monitor_id = debug_info.monitorid;
93 info->server_monitor_pending = debug_info.servermonitor_pending;
94 info->server_monitor_latency = debug_info.servermonitor_latency;
95 info->server_monitor_conn_id = debug_info.servermonitor_connectionid;
97 info->client_monitor_pending = debug_info.clientmonitor_pending;
98 info->client_monitor_latency = debug_info.clientmonitor_latency;
99 info->client_monitor_conn_id = debug_info.clientmonitor_connectionid;
101 info->inbound.int_mask = debug_info.inbound.current_interrupt_mask;
102 info->inbound.read_idx = debug_info.inbound.current_read_index;
103 info->inbound.write_idx = debug_info.inbound.current_write_index;
104 info->inbound.bytes_avail_toread =
105 debug_info.inbound.bytes_avail_toread;
106 info->inbound.bytes_avail_towrite =
107 debug_info.inbound.bytes_avail_towrite;
109 info->outbound.int_mask =
110 debug_info.outbound.current_interrupt_mask;
111 info->outbound.read_idx = debug_info.outbound.current_read_index;
112 info->outbound.write_idx = debug_info.outbound.current_write_index;
113 info->outbound.bytes_avail_toread =
114 debug_info.outbound.bytes_avail_toread;
115 info->outbound.bytes_avail_towrite =
116 debug_info.outbound.bytes_avail_towrite;
119 #define VMBUS_ALIAS_LEN ((sizeof((struct hv_vmbus_device_id *)0)->guid) * 2)
120 static void print_alias_name(struct hv_device *hv_dev, char *alias_name)
123 for (i = 0; i < VMBUS_ALIAS_LEN; i += 2)
124 sprintf(&alias_name[i], "%02x", hv_dev->dev_type.b[i/2]);
128 * vmbus_show_device_attr - Show the device attribute in sysfs.
130 * This is invoked when user does a
131 * "cat /sys/bus/vmbus/devices/<busdevice>/<attr name>"
133 static ssize_t vmbus_show_device_attr(struct device *dev,
134 struct device_attribute *dev_attr,
137 struct hv_device *hv_dev = device_to_hv_device(dev);
138 struct hv_device_info *device_info;
139 char alias_name[VMBUS_ALIAS_LEN + 1];
142 device_info = kzalloc(sizeof(struct hv_device_info), GFP_KERNEL);
146 get_channel_info(hv_dev, device_info);
148 if (!strcmp(dev_attr->attr.name, "class_id")) {
149 ret = sprintf(buf, "{%pUl}\n", device_info->chn_type.b);
150 } else if (!strcmp(dev_attr->attr.name, "device_id")) {
151 ret = sprintf(buf, "{%pUl}\n", device_info->chn_instance.b);
152 } else if (!strcmp(dev_attr->attr.name, "modalias")) {
153 print_alias_name(hv_dev, alias_name);
154 ret = sprintf(buf, "vmbus:%s\n", alias_name);
155 } else if (!strcmp(dev_attr->attr.name, "state")) {
156 ret = sprintf(buf, "%d\n", device_info->chn_state);
157 } else if (!strcmp(dev_attr->attr.name, "id")) {
158 ret = sprintf(buf, "%d\n", device_info->chn_id);
159 } else if (!strcmp(dev_attr->attr.name, "out_intr_mask")) {
160 ret = sprintf(buf, "%d\n", device_info->outbound.int_mask);
161 } else if (!strcmp(dev_attr->attr.name, "out_read_index")) {
162 ret = sprintf(buf, "%d\n", device_info->outbound.read_idx);
163 } else if (!strcmp(dev_attr->attr.name, "out_write_index")) {
164 ret = sprintf(buf, "%d\n", device_info->outbound.write_idx);
165 } else if (!strcmp(dev_attr->attr.name, "out_read_bytes_avail")) {
166 ret = sprintf(buf, "%d\n",
167 device_info->outbound.bytes_avail_toread);
168 } else if (!strcmp(dev_attr->attr.name, "out_write_bytes_avail")) {
169 ret = sprintf(buf, "%d\n",
170 device_info->outbound.bytes_avail_towrite);
171 } else if (!strcmp(dev_attr->attr.name, "in_intr_mask")) {
172 ret = sprintf(buf, "%d\n", device_info->inbound.int_mask);
173 } else if (!strcmp(dev_attr->attr.name, "in_read_index")) {
174 ret = sprintf(buf, "%d\n", device_info->inbound.read_idx);
175 } else if (!strcmp(dev_attr->attr.name, "in_write_index")) {
176 ret = sprintf(buf, "%d\n", device_info->inbound.write_idx);
177 } else if (!strcmp(dev_attr->attr.name, "in_read_bytes_avail")) {
178 ret = sprintf(buf, "%d\n",
179 device_info->inbound.bytes_avail_toread);
180 } else if (!strcmp(dev_attr->attr.name, "in_write_bytes_avail")) {
181 ret = sprintf(buf, "%d\n",
182 device_info->inbound.bytes_avail_towrite);
183 } else if (!strcmp(dev_attr->attr.name, "monitor_id")) {
184 ret = sprintf(buf, "%d\n", device_info->monitor_id);
185 } else if (!strcmp(dev_attr->attr.name, "server_monitor_pending")) {
186 ret = sprintf(buf, "%d\n", device_info->server_monitor_pending);
187 } else if (!strcmp(dev_attr->attr.name, "server_monitor_latency")) {
188 ret = sprintf(buf, "%d\n", device_info->server_monitor_latency);
189 } else if (!strcmp(dev_attr->attr.name, "server_monitor_conn_id")) {
190 ret = sprintf(buf, "%d\n",
191 device_info->server_monitor_conn_id);
192 } else if (!strcmp(dev_attr->attr.name, "client_monitor_pending")) {
193 ret = sprintf(buf, "%d\n", device_info->client_monitor_pending);
194 } else if (!strcmp(dev_attr->attr.name, "client_monitor_latency")) {
195 ret = sprintf(buf, "%d\n", device_info->client_monitor_latency);
196 } else if (!strcmp(dev_attr->attr.name, "client_monitor_conn_id")) {
197 ret = sprintf(buf, "%d\n",
198 device_info->client_monitor_conn_id);
205 /* Set up per device attributes in /sys/bus/vmbus/devices/<bus device> */
206 static struct device_attribute vmbus_device_attrs[] = {
207 __ATTR(id, S_IRUGO, vmbus_show_device_attr, NULL),
208 __ATTR(state, S_IRUGO, vmbus_show_device_attr, NULL),
209 __ATTR(class_id, S_IRUGO, vmbus_show_device_attr, NULL),
210 __ATTR(device_id, S_IRUGO, vmbus_show_device_attr, NULL),
211 __ATTR(monitor_id, S_IRUGO, vmbus_show_device_attr, NULL),
212 __ATTR(modalias, S_IRUGO, vmbus_show_device_attr, NULL),
214 __ATTR(server_monitor_pending, S_IRUGO, vmbus_show_device_attr, NULL),
215 __ATTR(server_monitor_latency, S_IRUGO, vmbus_show_device_attr, NULL),
216 __ATTR(server_monitor_conn_id, S_IRUGO, vmbus_show_device_attr, NULL),
218 __ATTR(client_monitor_pending, S_IRUGO, vmbus_show_device_attr, NULL),
219 __ATTR(client_monitor_latency, S_IRUGO, vmbus_show_device_attr, NULL),
220 __ATTR(client_monitor_conn_id, S_IRUGO, vmbus_show_device_attr, NULL),
222 __ATTR(out_intr_mask, S_IRUGO, vmbus_show_device_attr, NULL),
223 __ATTR(out_read_index, S_IRUGO, vmbus_show_device_attr, NULL),
224 __ATTR(out_write_index, S_IRUGO, vmbus_show_device_attr, NULL),
225 __ATTR(out_read_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
226 __ATTR(out_write_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
228 __ATTR(in_intr_mask, S_IRUGO, vmbus_show_device_attr, NULL),
229 __ATTR(in_read_index, S_IRUGO, vmbus_show_device_attr, NULL),
230 __ATTR(in_write_index, S_IRUGO, vmbus_show_device_attr, NULL),
231 __ATTR(in_read_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
232 __ATTR(in_write_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
238 * vmbus_uevent - add uevent for our device
240 * This routine is invoked when a device is added or removed on the vmbus to
241 * generate a uevent to udev in the userspace. The udev will then look at its
242 * rule and the uevent generated here to load the appropriate driver
244 * The alias string will be of the form vmbus:guid where guid is the string
245 * representation of the device guid (each byte of the guid will be
246 * represented with two hex characters.
248 static int vmbus_uevent(struct device *device, struct kobj_uevent_env *env)
250 struct hv_device *dev = device_to_hv_device(device);
252 char alias_name[VMBUS_ALIAS_LEN + 1];
254 print_alias_name(dev, alias_name);
255 ret = add_uevent_var(env, "MODALIAS=vmbus:%s", alias_name);
259 static uuid_le null_guid;
261 static inline bool is_null_guid(const __u8 *guid)
263 if (memcmp(guid, &null_guid, sizeof(uuid_le)))
269 * Return a matching hv_vmbus_device_id pointer.
270 * If there is no match, return NULL.
272 static const struct hv_vmbus_device_id *hv_vmbus_get_id(
273 const struct hv_vmbus_device_id *id,
276 for (; !is_null_guid(id->guid); id++)
277 if (!memcmp(&id->guid, guid, sizeof(uuid_le)))
286 * vmbus_match - Attempt to match the specified device to the specified driver
288 static int vmbus_match(struct device *device, struct device_driver *driver)
290 struct hv_driver *drv = drv_to_hv_drv(driver);
291 struct hv_device *hv_dev = device_to_hv_device(device);
293 if (hv_vmbus_get_id(drv->id_table, hv_dev->dev_type.b))
300 * vmbus_probe - Add the new vmbus's child device
302 static int vmbus_probe(struct device *child_device)
305 struct hv_driver *drv =
306 drv_to_hv_drv(child_device->driver);
307 struct hv_device *dev = device_to_hv_device(child_device);
308 const struct hv_vmbus_device_id *dev_id;
310 dev_id = hv_vmbus_get_id(drv->id_table, dev->dev_type.b);
312 ret = drv->probe(dev, dev_id);
314 pr_err("probe failed for device %s (%d)\n",
315 dev_name(child_device), ret);
318 pr_err("probe not set for driver %s\n",
319 dev_name(child_device));
326 * vmbus_remove - Remove a vmbus device
328 static int vmbus_remove(struct device *child_device)
330 struct hv_driver *drv = drv_to_hv_drv(child_device->driver);
331 struct hv_device *dev = device_to_hv_device(child_device);
336 pr_err("remove not set for driver %s\n",
337 dev_name(child_device));
344 * vmbus_shutdown - Shutdown a vmbus device
346 static void vmbus_shutdown(struct device *child_device)
348 struct hv_driver *drv;
349 struct hv_device *dev = device_to_hv_device(child_device);
352 /* The device may not be attached yet */
353 if (!child_device->driver)
356 drv = drv_to_hv_drv(child_device->driver);
366 * vmbus_device_release - Final callback release of the vmbus child device
368 static void vmbus_device_release(struct device *device)
370 struct hv_device *hv_dev = device_to_hv_device(device);
376 /* The one and only one */
377 static struct bus_type hv_bus = {
379 .match = vmbus_match,
380 .shutdown = vmbus_shutdown,
381 .remove = vmbus_remove,
382 .probe = vmbus_probe,
383 .uevent = vmbus_uevent,
384 .dev_attrs = vmbus_device_attrs,
387 static const char *driver_name = "hyperv";
390 struct onmessage_work_context {
391 struct work_struct work;
392 struct hv_message msg;
395 static void vmbus_onmessage_work(struct work_struct *work)
397 struct onmessage_work_context *ctx;
399 ctx = container_of(work, struct onmessage_work_context,
401 vmbus_onmessage(&ctx->msg);
405 static void vmbus_on_msg_dpc(unsigned long data)
407 int cpu = smp_processor_id();
408 void *page_addr = hv_context.synic_message_page[cpu];
409 struct hv_message *msg = (struct hv_message *)page_addr +
411 struct onmessage_work_context *ctx;
414 if (msg->header.message_type == HVMSG_NONE) {
418 ctx = kmalloc(sizeof(*ctx), GFP_ATOMIC);
421 INIT_WORK(&ctx->work, vmbus_onmessage_work);
422 memcpy(&ctx->msg, msg, sizeof(*msg));
423 queue_work(vmbus_connection.work_queue, &ctx->work);
426 msg->header.message_type = HVMSG_NONE;
429 * Make sure the write to MessageType (ie set to
430 * HVMSG_NONE) happens before we read the
431 * MessagePending and EOMing. Otherwise, the EOMing
432 * will not deliver any more messages since there is
437 if (msg->header.message_flags.msg_pending) {
439 * This will cause message queue rescan to
440 * possibly deliver another msg from the
443 wrmsrl(HV_X64_MSR_EOM, 0);
448 static irqreturn_t vmbus_isr(int irq, void *dev_id)
450 int cpu = smp_processor_id();
452 struct hv_message *msg;
453 union hv_synic_event_flags *event;
454 bool handled = false;
457 * Check for events before checking for messages. This is the order
458 * in which events and messages are checked in Windows guests on
459 * Hyper-V, and the Windows team suggested we do the same.
462 if ((vmbus_proto_version == VERSION_WS2008) ||
463 (vmbus_proto_version == VERSION_WIN7)) {
465 page_addr = hv_context.synic_event_page[cpu];
466 event = (union hv_synic_event_flags *)page_addr +
469 /* Since we are a child, we only need to check bit 0 */
470 if (sync_test_and_clear_bit(0,
471 (unsigned long *) &event->flags32[0])) {
476 * Our host is win8 or above. The signaling mechanism
477 * has changed and we can directly look at the event page.
478 * If bit n is set then we have an interrup on the channel
485 tasklet_schedule(hv_context.event_dpc[cpu]);
488 page_addr = hv_context.synic_message_page[cpu];
489 msg = (struct hv_message *)page_addr + VMBUS_MESSAGE_SINT;
491 /* Check if there are actual msgs to be processed */
492 if (msg->header.message_type != HVMSG_NONE) {
494 tasklet_schedule(&msg_dpc);
504 * vmbus_bus_init -Main vmbus driver initialization routine.
507 * - initialize the vmbus driver context
508 * - invoke the vmbus hv main init routine
509 * - get the irq resource
510 * - retrieve the channel offers
512 static int vmbus_bus_init(int irq)
517 /* Hypervisor initialization...setup hypercall page..etc */
520 pr_err("Unable to initialize the hypervisor - 0x%x\n", ret);
524 tasklet_init(&msg_dpc, vmbus_on_msg_dpc, 0);
526 ret = bus_register(&hv_bus);
530 ret = request_irq(irq, vmbus_isr, 0, driver_name, hv_acpi_dev);
533 pr_err("Unable to request IRQ %d\n",
538 vector = IRQ0_VECTOR + irq;
541 * Notify the hypervisor of our irq and
542 * connect to the host.
544 on_each_cpu(hv_synic_init, (void *)&vector, 1);
545 ret = vmbus_connect();
549 vmbus_request_offers();
554 free_irq(irq, hv_acpi_dev);
557 bus_unregister(&hv_bus);
566 * __vmbus_child_driver_register - Register a vmbus's driver
567 * @drv: Pointer to driver structure you want to register
568 * @owner: owner module of the drv
569 * @mod_name: module name string
571 * Registers the given driver with Linux through the 'driver_register()' call
572 * and sets up the hyper-v vmbus handling for this driver.
573 * It will return the state of the 'driver_register()' call.
576 int __vmbus_driver_register(struct hv_driver *hv_driver, struct module *owner, const char *mod_name)
580 pr_info("registering driver %s\n", hv_driver->name);
582 ret = vmbus_exists();
586 hv_driver->driver.name = hv_driver->name;
587 hv_driver->driver.owner = owner;
588 hv_driver->driver.mod_name = mod_name;
589 hv_driver->driver.bus = &hv_bus;
591 ret = driver_register(&hv_driver->driver);
595 EXPORT_SYMBOL_GPL(__vmbus_driver_register);
598 * vmbus_driver_unregister() - Unregister a vmbus's driver
599 * @drv: Pointer to driver structure you want to un-register
601 * Un-register the given driver that was previous registered with a call to
602 * vmbus_driver_register()
604 void vmbus_driver_unregister(struct hv_driver *hv_driver)
606 pr_info("unregistering driver %s\n", hv_driver->name);
609 driver_unregister(&hv_driver->driver);
611 EXPORT_SYMBOL_GPL(vmbus_driver_unregister);
614 * vmbus_device_create - Creates and registers a new child device
617 struct hv_device *vmbus_device_create(uuid_le *type,
619 struct vmbus_channel *channel)
621 struct hv_device *child_device_obj;
623 child_device_obj = kzalloc(sizeof(struct hv_device), GFP_KERNEL);
624 if (!child_device_obj) {
625 pr_err("Unable to allocate device object for child device\n");
629 child_device_obj->channel = channel;
630 memcpy(&child_device_obj->dev_type, type, sizeof(uuid_le));
631 memcpy(&child_device_obj->dev_instance, instance,
635 return child_device_obj;
639 * vmbus_device_register - Register the child device
641 int vmbus_device_register(struct hv_device *child_device_obj)
645 static atomic_t device_num = ATOMIC_INIT(0);
647 dev_set_name(&child_device_obj->device, "vmbus_0_%d",
648 atomic_inc_return(&device_num));
650 child_device_obj->device.bus = &hv_bus;
651 child_device_obj->device.parent = &hv_acpi_dev->dev;
652 child_device_obj->device.release = vmbus_device_release;
655 * Register with the LDM. This will kick off the driver/device
656 * binding...which will eventually call vmbus_match() and vmbus_probe()
658 ret = device_register(&child_device_obj->device);
661 pr_err("Unable to register child device\n");
663 pr_info("child device %s registered\n",
664 dev_name(&child_device_obj->device));
670 * vmbus_device_unregister - Remove the specified child device
673 void vmbus_device_unregister(struct hv_device *device_obj)
676 * Kick off the process of unregistering the device.
677 * This will call vmbus_remove() and eventually vmbus_device_release()
679 device_unregister(&device_obj->device);
681 pr_info("child device %s unregistered\n",
682 dev_name(&device_obj->device));
687 * VMBUS is an acpi enumerated device. Get the the IRQ information
691 static acpi_status vmbus_walk_resources(struct acpi_resource *res, void *irq)
694 if (res->type == ACPI_RESOURCE_TYPE_IRQ) {
695 struct acpi_resource_irq *irqp;
696 irqp = &res->data.irq;
698 *((unsigned int *)irq) = irqp->interrupts[0];
704 static int vmbus_acpi_add(struct acpi_device *device)
708 hv_acpi_dev = device;
710 result = acpi_walk_resources(device->handle, METHOD_NAME__CRS,
711 vmbus_walk_resources, &irq);
713 if (ACPI_FAILURE(result)) {
714 complete(&probe_event);
717 complete(&probe_event);
721 static const struct acpi_device_id vmbus_acpi_device_ids[] = {
726 MODULE_DEVICE_TABLE(acpi, vmbus_acpi_device_ids);
728 static struct acpi_driver vmbus_acpi_driver = {
730 .ids = vmbus_acpi_device_ids,
732 .add = vmbus_acpi_add,
736 static int __init hv_acpi_init(void)
740 if (x86_hyper != &x86_hyper_ms_hyperv)
743 init_completion(&probe_event);
746 * Get irq resources first.
749 ret = acpi_bus_register_driver(&vmbus_acpi_driver);
754 t = wait_for_completion_timeout(&probe_event, 5*HZ);
765 ret = vmbus_bus_init(irq);
772 acpi_bus_unregister_driver(&vmbus_acpi_driver);
777 static void __exit vmbus_exit(void)
780 free_irq(irq, hv_acpi_dev);
781 vmbus_free_channels();
782 bus_unregister(&hv_bus);
784 acpi_bus_unregister_driver(&vmbus_acpi_driver);
788 MODULE_LICENSE("GPL");
789 MODULE_VERSION(HV_DRV_VERSION);
791 subsys_initcall(hv_acpi_init);
792 module_exit(vmbus_exit);