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>
21 #include <linux/init.h>
22 #include <linux/module.h>
23 #include <linux/device.h>
24 #include <linux/irq.h>
25 #include <linux/interrupt.h>
26 #include <linux/sysctl.h>
27 #include <linux/pci.h>
28 #include <linux/dmi.h>
29 #include <linux/slab.h>
30 #include "version_info.h"
36 /* FIXME! We need to do this dynamically for PIC and APIC system */
38 #define VMBUS_IRQ_VECTOR IRQ5_VECTOR
40 /* Main vmbus driver data structure */
41 struct vmbus_driver_context {
42 /* !! These must be the first 2 fields !! */
43 /* FIXME, this is a bug */
44 /* The driver field is not used in here. Instead, the bus field is */
45 /* used to represent the driver */
46 struct driver_context drv_ctx;
47 struct vmbus_driver drv_obj;
50 struct tasklet_struct msg_dpc;
51 struct tasklet_struct event_dpc;
53 /* The bus root device */
54 struct vm_device device_ctx;
57 static int vmbus_match(struct device *device, struct device_driver *driver);
58 static int vmbus_probe(struct device *device);
59 static int vmbus_remove(struct device *device);
60 static void vmbus_shutdown(struct device *device);
61 static int vmbus_uevent(struct device *device, struct kobj_uevent_env *env);
62 static void vmbus_msg_dpc(unsigned long data);
63 static void vmbus_event_dpc(unsigned long data);
65 static irqreturn_t vmbus_isr(int irq, void *dev_id);
67 static void vmbus_device_release(struct device *device);
68 static void vmbus_bus_release(struct device *device);
70 static struct hv_device *vmbus_child_device_create(struct hv_guid *type,
71 struct hv_guid *instance,
73 static void vmbus_child_device_destroy(struct hv_device *device_obj);
74 static int vmbus_child_device_register(struct hv_device *root_device_obj,
75 struct hv_device *child_device_obj);
76 static void vmbus_child_device_unregister(struct hv_device *child_device_obj);
77 static void vmbus_child_device_get_info(struct hv_device *device_obj,
78 struct hv_device_info *device_info);
79 static ssize_t vmbus_show_device_attr(struct device *dev,
80 struct device_attribute *dev_attr,
84 unsigned int vmbus_loglevel = (ALL_MODULES << 16 | INFO_LVL);
85 EXPORT_SYMBOL(vmbus_loglevel);
86 /* (ALL_MODULES << 16 | DEBUG_LVL_ENTEREXIT); */
87 /* (((VMBUS | VMBUS_DRV)<<16) | DEBUG_LVL_ENTEREXIT); */
89 static int vmbus_irq = VMBUS_IRQ;
91 /* Set up per device attributes in /sys/bus/vmbus/devices/<bus device> */
92 static struct device_attribute vmbus_device_attrs[] = {
93 __ATTR(id, S_IRUGO, vmbus_show_device_attr, NULL),
94 __ATTR(state, S_IRUGO, vmbus_show_device_attr, NULL),
95 __ATTR(class_id, S_IRUGO, vmbus_show_device_attr, NULL),
96 __ATTR(device_id, S_IRUGO, vmbus_show_device_attr, NULL),
97 __ATTR(monitor_id, S_IRUGO, vmbus_show_device_attr, NULL),
99 __ATTR(server_monitor_pending, S_IRUGO, vmbus_show_device_attr, NULL),
100 __ATTR(server_monitor_latency, S_IRUGO, vmbus_show_device_attr, NULL),
101 __ATTR(server_monitor_conn_id, S_IRUGO, vmbus_show_device_attr, NULL),
103 __ATTR(client_monitor_pending, S_IRUGO, vmbus_show_device_attr, NULL),
104 __ATTR(client_monitor_latency, S_IRUGO, vmbus_show_device_attr, NULL),
105 __ATTR(client_monitor_conn_id, S_IRUGO, vmbus_show_device_attr, NULL),
107 __ATTR(out_intr_mask, S_IRUGO, vmbus_show_device_attr, NULL),
108 __ATTR(out_read_index, S_IRUGO, vmbus_show_device_attr, NULL),
109 __ATTR(out_write_index, S_IRUGO, vmbus_show_device_attr, NULL),
110 __ATTR(out_read_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
111 __ATTR(out_write_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
113 __ATTR(in_intr_mask, S_IRUGO, vmbus_show_device_attr, NULL),
114 __ATTR(in_read_index, S_IRUGO, vmbus_show_device_attr, NULL),
115 __ATTR(in_write_index, S_IRUGO, vmbus_show_device_attr, NULL),
116 __ATTR(in_read_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
117 __ATTR(in_write_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
121 /* The one and only one */
122 static struct vmbus_driver_context g_vmbus_drv = {
124 .bus.match = vmbus_match,
125 .bus.shutdown = vmbus_shutdown,
126 .bus.remove = vmbus_remove,
127 .bus.probe = vmbus_probe,
128 .bus.uevent = vmbus_uevent,
129 .bus.dev_attrs = vmbus_device_attrs,
133 * vmbus_show_device_attr - Show the device attribute in sysfs.
135 * This is invoked when user does a
136 * "cat /sys/bus/vmbus/devices/<busdevice>/<attr name>"
138 static ssize_t vmbus_show_device_attr(struct device *dev,
139 struct device_attribute *dev_attr,
142 struct vm_device *device_ctx = device_to_vm_device(dev);
143 struct hv_device_info device_info;
145 memset(&device_info, 0, sizeof(struct hv_device_info));
147 vmbus_child_device_get_info(&device_ctx->device_obj, &device_info);
149 if (!strcmp(dev_attr->attr.name, "class_id")) {
150 return sprintf(buf, "{%02x%02x%02x%02x-%02x%02x-%02x%02x-"
151 "%02x%02x%02x%02x%02x%02x%02x%02x}\n",
152 device_info.ChannelType.data[3],
153 device_info.ChannelType.data[2],
154 device_info.ChannelType.data[1],
155 device_info.ChannelType.data[0],
156 device_info.ChannelType.data[5],
157 device_info.ChannelType.data[4],
158 device_info.ChannelType.data[7],
159 device_info.ChannelType.data[6],
160 device_info.ChannelType.data[8],
161 device_info.ChannelType.data[9],
162 device_info.ChannelType.data[10],
163 device_info.ChannelType.data[11],
164 device_info.ChannelType.data[12],
165 device_info.ChannelType.data[13],
166 device_info.ChannelType.data[14],
167 device_info.ChannelType.data[15]);
168 } else if (!strcmp(dev_attr->attr.name, "device_id")) {
169 return sprintf(buf, "{%02x%02x%02x%02x-%02x%02x-%02x%02x-"
170 "%02x%02x%02x%02x%02x%02x%02x%02x}\n",
171 device_info.ChannelInstance.data[3],
172 device_info.ChannelInstance.data[2],
173 device_info.ChannelInstance.data[1],
174 device_info.ChannelInstance.data[0],
175 device_info.ChannelInstance.data[5],
176 device_info.ChannelInstance.data[4],
177 device_info.ChannelInstance.data[7],
178 device_info.ChannelInstance.data[6],
179 device_info.ChannelInstance.data[8],
180 device_info.ChannelInstance.data[9],
181 device_info.ChannelInstance.data[10],
182 device_info.ChannelInstance.data[11],
183 device_info.ChannelInstance.data[12],
184 device_info.ChannelInstance.data[13],
185 device_info.ChannelInstance.data[14],
186 device_info.ChannelInstance.data[15]);
187 } else if (!strcmp(dev_attr->attr.name, "state")) {
188 return sprintf(buf, "%d\n", device_info.ChannelState);
189 } else if (!strcmp(dev_attr->attr.name, "id")) {
190 return sprintf(buf, "%d\n", device_info.ChannelId);
191 } else if (!strcmp(dev_attr->attr.name, "out_intr_mask")) {
192 return sprintf(buf, "%d\n", device_info.Outbound.InterruptMask);
193 } else if (!strcmp(dev_attr->attr.name, "out_read_index")) {
194 return sprintf(buf, "%d\n", device_info.Outbound.ReadIndex);
195 } else if (!strcmp(dev_attr->attr.name, "out_write_index")) {
196 return sprintf(buf, "%d\n", device_info.Outbound.WriteIndex);
197 } else if (!strcmp(dev_attr->attr.name, "out_read_bytes_avail")) {
198 return sprintf(buf, "%d\n",
199 device_info.Outbound.BytesAvailToRead);
200 } else if (!strcmp(dev_attr->attr.name, "out_write_bytes_avail")) {
201 return sprintf(buf, "%d\n",
202 device_info.Outbound.BytesAvailToWrite);
203 } else if (!strcmp(dev_attr->attr.name, "in_intr_mask")) {
204 return sprintf(buf, "%d\n", device_info.Inbound.InterruptMask);
205 } else if (!strcmp(dev_attr->attr.name, "in_read_index")) {
206 return sprintf(buf, "%d\n", device_info.Inbound.ReadIndex);
207 } else if (!strcmp(dev_attr->attr.name, "in_write_index")) {
208 return sprintf(buf, "%d\n", device_info.Inbound.WriteIndex);
209 } else if (!strcmp(dev_attr->attr.name, "in_read_bytes_avail")) {
210 return sprintf(buf, "%d\n",
211 device_info.Inbound.BytesAvailToRead);
212 } else if (!strcmp(dev_attr->attr.name, "in_write_bytes_avail")) {
213 return sprintf(buf, "%d\n",
214 device_info.Inbound.BytesAvailToWrite);
215 } else if (!strcmp(dev_attr->attr.name, "monitor_id")) {
216 return sprintf(buf, "%d\n", device_info.MonitorId);
217 } else if (!strcmp(dev_attr->attr.name, "server_monitor_pending")) {
218 return sprintf(buf, "%d\n", device_info.ServerMonitorPending);
219 } else if (!strcmp(dev_attr->attr.name, "server_monitor_latency")) {
220 return sprintf(buf, "%d\n", device_info.ServerMonitorLatency);
221 } else if (!strcmp(dev_attr->attr.name, "server_monitor_conn_id")) {
222 return sprintf(buf, "%d\n",
223 device_info.ServerMonitorConnectionId);
224 } else if (!strcmp(dev_attr->attr.name, "client_monitor_pending")) {
225 return sprintf(buf, "%d\n", device_info.ClientMonitorPending);
226 } else if (!strcmp(dev_attr->attr.name, "client_monitor_latency")) {
227 return sprintf(buf, "%d\n", device_info.ClientMonitorLatency);
228 } else if (!strcmp(dev_attr->attr.name, "client_monitor_conn_id")) {
229 return sprintf(buf, "%d\n",
230 device_info.ClientMonitorConnectionId);
237 * vmbus_bus_init -Main vmbus driver initialization routine.
240 * - initialize the vmbus driver context
241 * - setup various driver entry points
242 * - invoke the vmbus hv main init routine
243 * - get the irq resource
244 * - invoke the vmbus to add the vmbus root device
245 * - setup the vmbus root device
246 * - retrieve the channel offers
248 static int vmbus_bus_init(int (*drv_init)(struct hv_driver *drv))
250 struct vmbus_driver_context *vmbus_drv_ctx = &g_vmbus_drv;
251 struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
252 struct vm_device *dev_ctx = &g_vmbus_drv.device_ctx;
256 DPRINT_ENTER(VMBUS_DRV);
259 * Set this up to allow lower layer to callback to add/remove child
262 vmbus_drv_obj->OnChildDeviceCreate = vmbus_child_device_create;
263 vmbus_drv_obj->OnChildDeviceDestroy = vmbus_child_device_destroy;
264 vmbus_drv_obj->OnChildDeviceAdd = vmbus_child_device_register;
265 vmbus_drv_obj->OnChildDeviceRemove = vmbus_child_device_unregister;
267 /* Call to bus driver to initialize */
268 ret = drv_init(&vmbus_drv_obj->Base);
270 DPRINT_ERR(VMBUS_DRV, "Unable to initialize vmbus (%d)", ret);
275 if (!vmbus_drv_obj->Base.OnDeviceAdd) {
276 DPRINT_ERR(VMBUS_DRV, "OnDeviceAdd() routine not set");
281 vmbus_drv_ctx->bus.name = vmbus_drv_obj->Base.name;
283 /* Initialize the bus context */
284 tasklet_init(&vmbus_drv_ctx->msg_dpc, vmbus_msg_dpc,
285 (unsigned long)vmbus_drv_obj);
286 tasklet_init(&vmbus_drv_ctx->event_dpc, vmbus_event_dpc,
287 (unsigned long)vmbus_drv_obj);
289 /* Now, register the bus driver with LDM */
290 ret = bus_register(&vmbus_drv_ctx->bus);
296 /* Get the interrupt resource */
297 ret = request_irq(vmbus_irq, vmbus_isr, IRQF_SAMPLE_RANDOM,
298 vmbus_drv_obj->Base.name, NULL);
301 DPRINT_ERR(VMBUS_DRV, "ERROR - Unable to request IRQ %d",
304 bus_unregister(&vmbus_drv_ctx->bus);
309 vector = VMBUS_IRQ_VECTOR;
311 DPRINT_INFO(VMBUS_DRV, "irq 0x%x vector 0x%x", vmbus_irq, vector);
313 /* Call to bus driver to add the root device */
314 memset(dev_ctx, 0, sizeof(struct vm_device));
316 ret = vmbus_drv_obj->Base.OnDeviceAdd(&dev_ctx->device_obj, &vector);
318 DPRINT_ERR(VMBUS_DRV,
319 "ERROR - Unable to add vmbus root device");
321 free_irq(vmbus_irq, NULL);
323 bus_unregister(&vmbus_drv_ctx->bus);
328 /* strcpy(dev_ctx->device.bus_id, dev_ctx->device_obj.name); */
329 dev_set_name(&dev_ctx->device, "vmbus_0_0");
330 memcpy(&dev_ctx->class_id, &dev_ctx->device_obj.deviceType,
331 sizeof(struct hv_guid));
332 memcpy(&dev_ctx->device_id, &dev_ctx->device_obj.deviceInstance,
333 sizeof(struct hv_guid));
335 /* No need to bind a driver to the root device. */
336 dev_ctx->device.parent = NULL;
337 /* NULL; vmbus_remove() does not get invoked */
338 dev_ctx->device.bus = &vmbus_drv_ctx->bus;
340 /* Setup the device dispatch table */
341 dev_ctx->device.release = vmbus_bus_release;
343 /* Setup the bus as root device */
344 ret = device_register(&dev_ctx->device);
346 DPRINT_ERR(VMBUS_DRV,
347 "ERROR - Unable to register vmbus root device");
349 free_irq(vmbus_irq, NULL);
350 bus_unregister(&vmbus_drv_ctx->bus);
357 vmbus_drv_obj->GetChannelOffers();
360 DPRINT_EXIT(VMBUS_DRV);
366 * vmbus_bus_exit - Terminate the vmbus driver.
368 * This routine is opposite of vmbus_bus_init()
370 static void vmbus_bus_exit(void)
372 struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
373 struct vmbus_driver_context *vmbus_drv_ctx = &g_vmbus_drv;
375 struct vm_device *dev_ctx = &g_vmbus_drv.device_ctx;
377 DPRINT_ENTER(VMBUS_DRV);
379 /* Remove the root device */
380 if (vmbus_drv_obj->Base.OnDeviceRemove)
381 vmbus_drv_obj->Base.OnDeviceRemove(&dev_ctx->device_obj);
383 if (vmbus_drv_obj->Base.OnCleanup)
384 vmbus_drv_obj->Base.OnCleanup(&vmbus_drv_obj->Base);
386 /* Unregister the root bus device */
387 device_unregister(&dev_ctx->device);
389 bus_unregister(&vmbus_drv_ctx->bus);
391 free_irq(vmbus_irq, NULL);
393 tasklet_kill(&vmbus_drv_ctx->msg_dpc);
394 tasklet_kill(&vmbus_drv_ctx->event_dpc);
396 DPRINT_EXIT(VMBUS_DRV);
403 * vmbus_child_driver_register() - Register a vmbus's child driver
404 * @driver_ctx: Pointer to driver structure you want to register
406 * @driver_ctx is of type &struct driver_context
408 * Registers the given driver with Linux through the 'driver_register()' call
409 * And sets up the hyper-v vmbus handling for this driver.
410 * It will return the state of the 'driver_register()' call.
412 * Mainly used by Hyper-V drivers.
414 int vmbus_child_driver_register(struct driver_context *driver_ctx)
416 struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
419 DPRINT_ENTER(VMBUS_DRV);
421 DPRINT_INFO(VMBUS_DRV, "child driver (%p) registering - name %s",
422 driver_ctx, driver_ctx->driver.name);
424 /* The child driver on this vmbus */
425 driver_ctx->driver.bus = &g_vmbus_drv.bus;
427 ret = driver_register(&driver_ctx->driver);
429 vmbus_drv_obj->GetChannelOffers();
431 DPRINT_EXIT(VMBUS_DRV);
435 EXPORT_SYMBOL(vmbus_child_driver_register);
438 * vmbus_child_driver_unregister() - Unregister a vmbus's child driver
439 * @driver_ctx: Pointer to driver structure you want to un-register
441 * @driver_ctx is of type &struct driver_context
443 * Un-register the given driver with Linux through the 'driver_unregister()'
444 * call. And ungegisters the driver from the Hyper-V vmbus handler.
446 * Mainly used by Hyper-V drivers.
448 void vmbus_child_driver_unregister(struct driver_context *driver_ctx)
450 DPRINT_ENTER(VMBUS_DRV);
452 DPRINT_INFO(VMBUS_DRV, "child driver (%p) unregistering - name %s",
453 driver_ctx, driver_ctx->driver.name);
455 driver_unregister(&driver_ctx->driver);
457 driver_ctx->driver.bus = NULL;
459 DPRINT_EXIT(VMBUS_DRV);
461 EXPORT_SYMBOL(vmbus_child_driver_unregister);
464 * vmbus_get_interface() - Get the vmbus channel interface.
465 * @interface: Pointer to channel interface structure
467 * Get the Hyper-V channel used for the driver.
469 * @interface is of type &struct vmbus_channel_interface
470 * This is invoked by child/client driver that sits above vmbus.
472 * Mainly used by Hyper-V drivers.
474 void vmbus_get_interface(struct vmbus_channel_interface *interface)
476 struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
478 vmbus_drv_obj->GetChannelInterface(interface);
480 EXPORT_SYMBOL(vmbus_get_interface);
483 * vmbus_child_device_get_info - Get the vmbus child device info.
485 * This is invoked to display various device attributes in sysfs.
487 static void vmbus_child_device_get_info(struct hv_device *device_obj,
488 struct hv_device_info *device_info)
490 struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
492 vmbus_drv_obj->GetChannelInfo(device_obj, device_info);
496 * vmbus_child_device_create - Creates and registers a new child device
499 static struct hv_device *vmbus_child_device_create(struct hv_guid *type,
500 struct hv_guid *instance,
503 struct vm_device *child_device_ctx;
504 struct hv_device *child_device_obj;
506 DPRINT_ENTER(VMBUS_DRV);
508 /* Allocate the new child device */
509 child_device_ctx = kzalloc(sizeof(struct vm_device), GFP_KERNEL);
510 if (!child_device_ctx) {
511 DPRINT_ERR(VMBUS_DRV,
512 "unable to allocate device_context for child device");
513 DPRINT_EXIT(VMBUS_DRV);
518 DPRINT_DBG(VMBUS_DRV, "child device (%p) allocated - "
519 "type {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
520 "%02x%02x%02x%02x%02x%02x%02x%02x},"
521 "id {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
522 "%02x%02x%02x%02x%02x%02x%02x%02x}",
523 &child_device_ctx->device,
524 type->data[3], type->data[2], type->data[1], type->data[0],
525 type->data[5], type->data[4], type->data[7], type->data[6],
526 type->data[8], type->data[9], type->data[10], type->data[11],
527 type->data[12], type->data[13], type->data[14], type->data[15],
528 instance->data[3], instance->data[2],
529 instance->data[1], instance->data[0],
530 instance->data[5], instance->data[4],
531 instance->data[7], instance->data[6],
532 instance->data[8], instance->data[9],
533 instance->data[10], instance->data[11],
534 instance->data[12], instance->data[13],
535 instance->data[14], instance->data[15]);
537 child_device_obj = &child_device_ctx->device_obj;
538 child_device_obj->context = context;
539 memcpy(&child_device_obj->deviceType, type, sizeof(struct hv_guid));
540 memcpy(&child_device_obj->deviceInstance, instance,
541 sizeof(struct hv_guid));
543 memcpy(&child_device_ctx->class_id, type, sizeof(struct hv_guid));
544 memcpy(&child_device_ctx->device_id, instance, sizeof(struct hv_guid));
546 DPRINT_EXIT(VMBUS_DRV);
548 return child_device_obj;
552 * vmbus_child_device_register - Register the child device on the specified bus
554 static int vmbus_child_device_register(struct hv_device *root_device_obj,
555 struct hv_device *child_device_obj)
558 struct vm_device *root_device_ctx =
559 to_vm_device(root_device_obj);
560 struct vm_device *child_device_ctx =
561 to_vm_device(child_device_obj);
562 static atomic_t device_num = ATOMIC_INIT(0);
564 DPRINT_ENTER(VMBUS_DRV);
566 DPRINT_DBG(VMBUS_DRV, "child device (%p) registering",
569 /* Set the device name. Otherwise, device_register() will fail. */
570 dev_set_name(&child_device_ctx->device, "vmbus_0_%d",
571 atomic_inc_return(&device_num));
573 /* The new device belongs to this bus */
574 child_device_ctx->device.bus = &g_vmbus_drv.bus; /* device->dev.bus; */
575 child_device_ctx->device.parent = &root_device_ctx->device;
576 child_device_ctx->device.release = vmbus_device_release;
579 * Register with the LDM. This will kick off the driver/device
580 * binding...which will eventually call vmbus_match() and vmbus_probe()
582 ret = device_register(&child_device_ctx->device);
584 /* vmbus_probe() error does not get propergate to device_register(). */
585 ret = child_device_ctx->probe_error;
588 DPRINT_ERR(VMBUS_DRV, "unable to register child device (%p)",
589 &child_device_ctx->device);
591 DPRINT_INFO(VMBUS_DRV, "child device (%p) registered",
592 &child_device_ctx->device);
594 DPRINT_EXIT(VMBUS_DRV);
600 * vmbus_child_device_unregister - Remove the specified child device
603 static void vmbus_child_device_unregister(struct hv_device *device_obj)
605 struct vm_device *device_ctx = to_vm_device(device_obj);
607 DPRINT_ENTER(VMBUS_DRV);
609 DPRINT_INFO(VMBUS_DRV, "unregistering child device (%p)",
610 &device_ctx->device);
613 * Kick off the process of unregistering the device.
614 * This will call vmbus_remove() and eventually vmbus_device_release()
616 device_unregister(&device_ctx->device);
618 DPRINT_INFO(VMBUS_DRV, "child device (%p) unregistered",
619 &device_ctx->device);
621 DPRINT_EXIT(VMBUS_DRV);
625 * vmbus_child_device_destroy - Destroy the specified child device on the vmbus.
627 static void vmbus_child_device_destroy(struct hv_device *device_obj)
629 DPRINT_ENTER(VMBUS_DRV);
631 DPRINT_EXIT(VMBUS_DRV);
635 * vmbus_uevent - add uevent for our device
637 * This routine is invoked when a device is added or removed on the vmbus to
638 * generate a uevent to udev in the userspace. The udev will then look at its
639 * rule and the uevent generated here to load the appropriate driver
641 static int vmbus_uevent(struct device *device, struct kobj_uevent_env *env)
643 struct vm_device *device_ctx = device_to_vm_device(device);
646 DPRINT_ENTER(VMBUS_DRV);
648 DPRINT_INFO(VMBUS_DRV, "generating uevent - VMBUS_DEVICE_CLASS_GUID={"
649 "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
650 "%02x%02x%02x%02x%02x%02x%02x%02x}",
651 device_ctx->class_id.data[3], device_ctx->class_id.data[2],
652 device_ctx->class_id.data[1], device_ctx->class_id.data[0],
653 device_ctx->class_id.data[5], device_ctx->class_id.data[4],
654 device_ctx->class_id.data[7], device_ctx->class_id.data[6],
655 device_ctx->class_id.data[8], device_ctx->class_id.data[9],
656 device_ctx->class_id.data[10],
657 device_ctx->class_id.data[11],
658 device_ctx->class_id.data[12],
659 device_ctx->class_id.data[13],
660 device_ctx->class_id.data[14],
661 device_ctx->class_id.data[15]);
663 ret = add_uevent_var(env, "VMBUS_DEVICE_CLASS_GUID={"
664 "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
665 "%02x%02x%02x%02x%02x%02x%02x%02x}",
666 device_ctx->class_id.data[3],
667 device_ctx->class_id.data[2],
668 device_ctx->class_id.data[1],
669 device_ctx->class_id.data[0],
670 device_ctx->class_id.data[5],
671 device_ctx->class_id.data[4],
672 device_ctx->class_id.data[7],
673 device_ctx->class_id.data[6],
674 device_ctx->class_id.data[8],
675 device_ctx->class_id.data[9],
676 device_ctx->class_id.data[10],
677 device_ctx->class_id.data[11],
678 device_ctx->class_id.data[12],
679 device_ctx->class_id.data[13],
680 device_ctx->class_id.data[14],
681 device_ctx->class_id.data[15]);
686 ret = add_uevent_var(env, "VMBUS_DEVICE_DEVICE_GUID={"
687 "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
688 "%02x%02x%02x%02x%02x%02x%02x%02x}",
689 device_ctx->device_id.data[3],
690 device_ctx->device_id.data[2],
691 device_ctx->device_id.data[1],
692 device_ctx->device_id.data[0],
693 device_ctx->device_id.data[5],
694 device_ctx->device_id.data[4],
695 device_ctx->device_id.data[7],
696 device_ctx->device_id.data[6],
697 device_ctx->device_id.data[8],
698 device_ctx->device_id.data[9],
699 device_ctx->device_id.data[10],
700 device_ctx->device_id.data[11],
701 device_ctx->device_id.data[12],
702 device_ctx->device_id.data[13],
703 device_ctx->device_id.data[14],
704 device_ctx->device_id.data[15]);
708 DPRINT_EXIT(VMBUS_DRV);
714 * vmbus_match - Attempt to match the specified device to the specified driver
716 static int vmbus_match(struct device *device, struct device_driver *driver)
719 struct driver_context *driver_ctx = driver_to_driver_context(driver);
720 struct vm_device *device_ctx = device_to_vm_device(device);
722 DPRINT_ENTER(VMBUS_DRV);
724 /* We found our driver ? */
725 if (memcmp(&device_ctx->class_id, &driver_ctx->class_id,
726 sizeof(struct hv_guid)) == 0) {
728 * !! NOTE: The driver_ctx is not a vmbus_drv_ctx. We typecast
729 * it here to access the struct hv_driver field
731 struct vmbus_driver_context *vmbus_drv_ctx =
732 (struct vmbus_driver_context *)driver_ctx;
734 device_ctx->device_obj.Driver = &vmbus_drv_ctx->drv_obj.Base;
735 DPRINT_INFO(VMBUS_DRV,
736 "device object (%p) set to driver object (%p)",
737 &device_ctx->device_obj,
738 device_ctx->device_obj.Driver);
743 DPRINT_EXIT(VMBUS_DRV);
749 * vmbus_probe_failed_cb - Callback when a driver probe failed in vmbus_probe()
751 * We need a callback because we cannot invoked device_unregister() inside
752 * vmbus_probe() since vmbus_probe() may be invoked inside device_register()
753 * i.e. we cannot call device_unregister() inside device_register()
755 static void vmbus_probe_failed_cb(struct work_struct *context)
757 struct vm_device *device_ctx = (struct vm_device *)context;
759 DPRINT_ENTER(VMBUS_DRV);
762 * Kick off the process of unregistering the device.
763 * This will call vmbus_remove() and eventually vmbus_device_release()
765 device_unregister(&device_ctx->device);
767 /* put_device(&device_ctx->device); */
768 DPRINT_EXIT(VMBUS_DRV);
772 * vmbus_probe - Add the new vmbus's child device
774 static int vmbus_probe(struct device *child_device)
777 struct driver_context *driver_ctx =
778 driver_to_driver_context(child_device->driver);
779 struct vm_device *device_ctx =
780 device_to_vm_device(child_device);
782 DPRINT_ENTER(VMBUS_DRV);
784 /* Let the specific open-source driver handles the probe if it can */
785 if (driver_ctx->probe) {
786 ret = device_ctx->probe_error = driver_ctx->probe(child_device);
788 DPRINT_ERR(VMBUS_DRV, "probe() failed for device %s "
789 "(%p) on driver %s (%d)...",
790 dev_name(child_device), child_device,
791 child_device->driver->name, ret);
793 INIT_WORK(&device_ctx->probe_failed_work_item,
794 vmbus_probe_failed_cb);
795 schedule_work(&device_ctx->probe_failed_work_item);
798 DPRINT_ERR(VMBUS_DRV, "probe() method not set for driver - %s",
799 child_device->driver->name);
803 DPRINT_EXIT(VMBUS_DRV);
808 * vmbus_remove - Remove a vmbus device
810 static int vmbus_remove(struct device *child_device)
813 struct driver_context *driver_ctx;
815 DPRINT_ENTER(VMBUS_DRV);
817 /* Special case root bus device */
818 if (child_device->parent == NULL) {
820 * No-op since it is statically defined and handle in
823 DPRINT_EXIT(VMBUS_DRV);
827 if (child_device->driver) {
828 driver_ctx = driver_to_driver_context(child_device->driver);
831 * Let the specific open-source driver handles the removal if
834 if (driver_ctx->remove) {
835 ret = driver_ctx->remove(child_device);
837 DPRINT_ERR(VMBUS_DRV,
838 "remove() method not set for driver - %s",
839 child_device->driver->name);
844 DPRINT_EXIT(VMBUS_DRV);
850 * vmbus_shutdown - Shutdown a vmbus device
852 static void vmbus_shutdown(struct device *child_device)
854 struct driver_context *driver_ctx;
856 DPRINT_ENTER(VMBUS_DRV);
858 /* Special case root bus device */
859 if (child_device->parent == NULL) {
861 * No-op since it is statically defined and handle in
864 DPRINT_EXIT(VMBUS_DRV);
868 /* The device may not be attached yet */
869 if (!child_device->driver) {
870 DPRINT_EXIT(VMBUS_DRV);
874 driver_ctx = driver_to_driver_context(child_device->driver);
876 /* Let the specific open-source driver handles the removal if it can */
877 if (driver_ctx->shutdown)
878 driver_ctx->shutdown(child_device);
880 DPRINT_EXIT(VMBUS_DRV);
886 * vmbus_bus_release - Final callback release of the vmbus root device
888 static void vmbus_bus_release(struct device *device)
890 DPRINT_ENTER(VMBUS_DRV);
892 /* Empty release functions are a bug, or a major sign
893 * of a problem design, this MUST BE FIXED! */
894 dev_err(device, "%s needs to be fixed!\n", __func__);
896 DPRINT_EXIT(VMBUS_DRV);
900 * vmbus_device_release - Final callback release of the vmbus child device
902 static void vmbus_device_release(struct device *device)
904 struct vm_device *device_ctx = device_to_vm_device(device);
906 DPRINT_ENTER(VMBUS_DRV);
908 /* vmbus_child_device_destroy(&device_ctx->device_obj); */
911 /* !!DO NOT REFERENCE device_ctx anymore at this point!! */
912 DPRINT_EXIT(VMBUS_DRV);
918 * vmbus_msg_dpc - Tasklet routine to handle hypervisor messages
920 static void vmbus_msg_dpc(unsigned long data)
922 struct vmbus_driver *vmbus_drv_obj = (struct vmbus_driver *)data;
924 DPRINT_ENTER(VMBUS_DRV);
926 /* ASSERT(vmbus_drv_obj->OnMsgDpc != NULL); */
928 /* Call to bus driver to handle interrupt */
929 vmbus_drv_obj->OnMsgDpc(&vmbus_drv_obj->Base);
931 DPRINT_EXIT(VMBUS_DRV);
935 * vmbus_msg_dpc - Tasklet routine to handle hypervisor events
937 static void vmbus_event_dpc(unsigned long data)
939 struct vmbus_driver *vmbus_drv_obj = (struct vmbus_driver *)data;
941 DPRINT_ENTER(VMBUS_DRV);
943 /* ASSERT(vmbus_drv_obj->OnEventDpc != NULL); */
945 /* Call to bus driver to handle interrupt */
946 vmbus_drv_obj->OnEventDpc(&vmbus_drv_obj->Base);
948 DPRINT_EXIT(VMBUS_DRV);
951 static irqreturn_t vmbus_isr(int irq, void *dev_id)
953 struct vmbus_driver *vmbus_driver_obj = &g_vmbus_drv.drv_obj;
956 DPRINT_ENTER(VMBUS_DRV);
958 /* ASSERT(vmbus_driver_obj->OnIsr != NULL); */
960 /* Call to bus driver to handle interrupt */
961 ret = vmbus_driver_obj->OnIsr(&vmbus_driver_obj->Base);
963 /* Schedules a dpc if necessary */
965 if (test_bit(0, (unsigned long *)&ret))
966 tasklet_schedule(&g_vmbus_drv.msg_dpc);
968 if (test_bit(1, (unsigned long *)&ret))
969 tasklet_schedule(&g_vmbus_drv.event_dpc);
971 DPRINT_EXIT(VMBUS_DRV);
974 DPRINT_EXIT(VMBUS_DRV);
979 static struct dmi_system_id __initdata microsoft_hv_dmi_table[] = {
983 DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
984 DMI_MATCH(DMI_PRODUCT_NAME, "Virtual Machine"),
985 DMI_MATCH(DMI_BOARD_NAME, "Virtual Machine"),
990 MODULE_DEVICE_TABLE(dmi, microsoft_hv_dmi_table);
992 static int __init vmbus_init(void)
996 DPRINT_ENTER(VMBUS_DRV);
998 DPRINT_INFO(VMBUS_DRV,
999 "Vmbus initializing.... current log level 0x%x (%x,%x)",
1000 vmbus_loglevel, HIWORD(vmbus_loglevel), LOWORD(vmbus_loglevel));
1001 /* Todo: it is used for loglevel, to be ported to new kernel. */
1003 if (!dmi_check_system(microsoft_hv_dmi_table))
1006 ret = vmbus_bus_init(VmbusInitialize);
1008 DPRINT_EXIT(VMBUS_DRV);
1012 static void __exit vmbus_exit(void)
1014 DPRINT_ENTER(VMBUS_DRV);
1017 /* Todo: it is used for loglevel, to be ported to new kernel. */
1018 DPRINT_EXIT(VMBUS_DRV);
1023 * We use a PCI table to determine if we should autoload this driver This is
1024 * needed by distro tools to determine if the hyperv drivers should be
1025 * installed and/or configured. We don't do anything else with the table, but
1026 * it needs to be present.
1028 const static struct pci_device_id microsoft_hv_pci_table[] = {
1029 { PCI_DEVICE(0x1414, 0x5353) }, /* VGA compatible controller */
1032 MODULE_DEVICE_TABLE(pci, microsoft_hv_pci_table);
1034 MODULE_LICENSE("GPL");
1035 MODULE_VERSION(HV_DRV_VERSION);
1036 module_param(vmbus_irq, int, S_IRUGO);
1037 module_param(vmbus_loglevel, int, S_IRUGO);
1039 module_init(vmbus_init);
1040 module_exit(vmbus_exit);