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 <linux/completion.h>
31 #include "version_info.h"
36 #include "vmbus_private.h"
39 /* FIXME! We need to do this dynamically for PIC and APIC system */
41 #define VMBUS_IRQ_VECTOR IRQ5_VECTOR
43 /* Main vmbus driver data structure */
44 struct vmbus_driver_context
{
45 /* !! These must be the first 2 fields !! */
46 /* FIXME, this is a bug */
47 /* The driver field is not used in here. Instead, the bus field is */
48 /* used to represent the driver */
49 struct driver_context drv_ctx
;
50 struct hv_driver drv_obj
;
53 struct tasklet_struct msg_dpc
;
54 struct tasklet_struct event_dpc
;
56 /* The bus root device */
57 struct vm_device device_ctx
;
60 static int vmbus_match(struct device
*device
, struct device_driver
*driver
);
61 static int vmbus_probe(struct device
*device
);
62 static int vmbus_remove(struct device
*device
);
63 static void vmbus_shutdown(struct device
*device
);
64 static int vmbus_uevent(struct device
*device
, struct kobj_uevent_env
*env
);
65 static void vmbus_msg_dpc(unsigned long data
);
66 static void vmbus_event_dpc(unsigned long data
);
68 static irqreturn_t
vmbus_isr(int irq
, void *dev_id
);
70 static void vmbus_device_release(struct device
*device
);
71 static void vmbus_bus_release(struct device
*device
);
73 static ssize_t
vmbus_show_device_attr(struct device
*dev
,
74 struct device_attribute
*dev_attr
,
78 unsigned int vmbus_loglevel
= (ALL_MODULES
<< 16 | INFO_LVL
);
79 EXPORT_SYMBOL(vmbus_loglevel
);
80 /* (ALL_MODULES << 16 | DEBUG_LVL_ENTEREXIT); */
81 /* (((VMBUS | VMBUS_DRV)<<16) | DEBUG_LVL_ENTEREXIT); */
83 static int vmbus_irq
= VMBUS_IRQ
;
85 /* Set up per device attributes in /sys/bus/vmbus/devices/<bus device> */
86 static struct device_attribute vmbus_device_attrs
[] = {
87 __ATTR(id
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
88 __ATTR(state
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
89 __ATTR(class_id
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
90 __ATTR(device_id
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
91 __ATTR(monitor_id
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
93 __ATTR(server_monitor_pending
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
94 __ATTR(server_monitor_latency
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
95 __ATTR(server_monitor_conn_id
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
97 __ATTR(client_monitor_pending
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
98 __ATTR(client_monitor_latency
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
99 __ATTR(client_monitor_conn_id
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
101 __ATTR(out_intr_mask
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
102 __ATTR(out_read_index
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
103 __ATTR(out_write_index
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
104 __ATTR(out_read_bytes_avail
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
105 __ATTR(out_write_bytes_avail
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
107 __ATTR(in_intr_mask
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
108 __ATTR(in_read_index
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
109 __ATTR(in_write_index
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
110 __ATTR(in_read_bytes_avail
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
111 __ATTR(in_write_bytes_avail
, S_IRUGO
, vmbus_show_device_attr
, NULL
),
115 /* The one and only one */
116 static struct vmbus_driver_context g_vmbus_drv
= {
118 .bus
.match
= vmbus_match
,
119 .bus
.shutdown
= vmbus_shutdown
,
120 .bus
.remove
= vmbus_remove
,
121 .bus
.probe
= vmbus_probe
,
122 .bus
.uevent
= vmbus_uevent
,
123 .bus
.dev_attrs
= vmbus_device_attrs
,
126 static const char *gDriverName
= "hyperv";
129 * Windows vmbus does not defined this.
130 * We defined this to be consistent with other devices
132 /* {c5295816-f63a-4d5f-8d1a-4daf999ca185} */
133 static const struct hv_guid gVmbusDeviceType
= {
135 0x16, 0x58, 0x29, 0xc5, 0x3a, 0xf6, 0x5f, 0x4d,
136 0x8d, 0x1a, 0x4d, 0xaf, 0x99, 0x9c, 0xa1, 0x85
140 /* {ac3760fc-9adf-40aa-9427-a70ed6de95c5} */
141 static const struct hv_guid gVmbusDeviceId
= {
143 0xfc, 0x60, 0x37, 0xac, 0xdf, 0x9a, 0xaa, 0x40,
144 0x94, 0x27, 0xa7, 0x0e, 0xd6, 0xde, 0x95, 0xc5
148 static struct hv_device
*gDevice
; /* vmbus root device */
151 * VmbusChildDeviceAdd - Registers the child device with the vmbus
153 int VmbusChildDeviceAdd(struct hv_device
*ChildDevice
)
155 return vmbus_child_device_register(gDevice
, ChildDevice
);
159 * VmbusOnDeviceAdd - Callback when the root bus device is added
161 static int VmbusOnDeviceAdd(struct hv_device
*dev
, void *AdditionalInfo
)
163 u32
*irqvector
= AdditionalInfo
;
168 memcpy(&gDevice
->deviceType
, &gVmbusDeviceType
, sizeof(struct hv_guid
));
169 memcpy(&gDevice
->deviceInstance
, &gVmbusDeviceId
,
170 sizeof(struct hv_guid
));
172 /* strcpy(dev->name, "vmbus"); */
174 on_each_cpu(hv_synic_init
, (void *)irqvector
, 1);
176 /* Connect to VMBus in the root partition */
177 ret
= VmbusConnect();
179 /* VmbusSendEvent(device->localPortId+1); */
184 * VmbusOnDeviceRemove - Callback when the root bus device is removed
186 static int VmbusOnDeviceRemove(struct hv_device
*dev
)
190 vmbus_release_unattached_channels();
192 on_each_cpu(hv_synic_cleanup
, NULL
, 1);
197 * VmbusOnCleanup - Perform any cleanup when the driver is removed
199 static void VmbusOnCleanup(struct hv_driver
*drv
)
201 /* struct vmbus_driver *driver = (struct vmbus_driver *)drv; */
207 * vmbus_on_msg_dpc - DPC routine to handle messages from the hypervisior
209 static void vmbus_on_msg_dpc(struct hv_driver
*drv
)
211 int cpu
= smp_processor_id();
212 void *page_addr
= hv_context
.synic_message_page
[cpu
];
213 struct hv_message
*msg
= (struct hv_message
*)page_addr
+
215 struct hv_message
*copied
;
218 if (msg
->header
.message_type
== HVMSG_NONE
) {
222 copied
= kmemdup(msg
, sizeof(*copied
), GFP_ATOMIC
);
226 osd_schedule_callback(gVmbusConnection
.WorkQueue
,
231 msg
->header
.message_type
= HVMSG_NONE
;
234 * Make sure the write to MessageType (ie set to
235 * HVMSG_NONE) happens before we read the
236 * MessagePending and EOMing. Otherwise, the EOMing
237 * will not deliver any more messages since there is
242 if (msg
->header
.message_flags
.msg_pending
) {
244 * This will cause message queue rescan to
245 * possibly deliver another msg from the
248 wrmsrl(HV_X64_MSR_EOM
, 0);
254 * vmbus_on_event_dpc - DPC routine to handle events from the hypervisior
256 static void vmbus_on_event_dpc(struct hv_driver
*drv
)
258 /* TODO: Process any events */
263 * vmbus_on_isr - ISR routine
265 static int vmbus_on_isr(struct hv_driver
*drv
)
268 int cpu
= smp_processor_id();
270 struct hv_message
*msg
;
271 union hv_synic_event_flags
*event
;
273 page_addr
= hv_context
.synic_message_page
[cpu
];
274 msg
= (struct hv_message
*)page_addr
+ VMBUS_MESSAGE_SINT
;
276 /* Check if there are actual msgs to be process */
277 if (msg
->header
.message_type
!= HVMSG_NONE
) {
278 DPRINT_DBG(VMBUS
, "received msg type %d size %d",
279 msg
->header
.message_type
,
280 msg
->header
.payload_size
);
284 /* TODO: Check if there are events to be process */
285 page_addr
= hv_context
.synic_event_page
[cpu
];
286 event
= (union hv_synic_event_flags
*)page_addr
+ VMBUS_MESSAGE_SINT
;
288 /* Since we are a child, we only need to check bit 0 */
289 if (test_and_clear_bit(0, (unsigned long *) &event
->flags32
[0])) {
290 DPRINT_DBG(VMBUS
, "received event %d", event
->flags32
[0]);
297 static void get_channel_info(struct hv_device
*device
,
298 struct hv_device_info
*info
)
300 struct vmbus_channel_debug_info debug_info
;
302 if (!device
->channel
)
305 vmbus_get_debug_info(device
->channel
, &debug_info
);
307 info
->ChannelId
= debug_info
.relid
;
308 info
->ChannelState
= debug_info
.state
;
309 memcpy(&info
->ChannelType
, &debug_info
.interfacetype
,
310 sizeof(struct hv_guid
));
311 memcpy(&info
->ChannelInstance
, &debug_info
.interface_instance
,
312 sizeof(struct hv_guid
));
314 info
->MonitorId
= debug_info
.monitorid
;
316 info
->ServerMonitorPending
= debug_info
.servermonitor_pending
;
317 info
->ServerMonitorLatency
= debug_info
.servermonitor_latency
;
318 info
->ServerMonitorConnectionId
= debug_info
.servermonitor_connectionid
;
320 info
->ClientMonitorPending
= debug_info
.clientmonitor_pending
;
321 info
->ClientMonitorLatency
= debug_info
.clientmonitor_latency
;
322 info
->ClientMonitorConnectionId
= debug_info
.clientmonitor_connectionid
;
324 info
->Inbound
.InterruptMask
= debug_info
.inbound
.current_interrupt_mask
;
325 info
->Inbound
.ReadIndex
= debug_info
.inbound
.current_read_index
;
326 info
->Inbound
.WriteIndex
= debug_info
.inbound
.current_write_index
;
327 info
->Inbound
.BytesAvailToRead
= debug_info
.inbound
.bytes_avail_toread
;
328 info
->Inbound
.BytesAvailToWrite
=
329 debug_info
.inbound
.bytes_avail_towrite
;
331 info
->Outbound
.InterruptMask
=
332 debug_info
.outbound
.current_interrupt_mask
;
333 info
->Outbound
.ReadIndex
= debug_info
.outbound
.current_read_index
;
334 info
->Outbound
.WriteIndex
= debug_info
.outbound
.current_write_index
;
335 info
->Outbound
.BytesAvailToRead
=
336 debug_info
.outbound
.bytes_avail_toread
;
337 info
->Outbound
.BytesAvailToWrite
=
338 debug_info
.outbound
.bytes_avail_towrite
;
342 * vmbus_show_device_attr - Show the device attribute in sysfs.
344 * This is invoked when user does a
345 * "cat /sys/bus/vmbus/devices/<busdevice>/<attr name>"
347 static ssize_t
vmbus_show_device_attr(struct device
*dev
,
348 struct device_attribute
*dev_attr
,
351 struct vm_device
*device_ctx
= device_to_vm_device(dev
);
352 struct hv_device_info device_info
;
354 memset(&device_info
, 0, sizeof(struct hv_device_info
));
356 get_channel_info(&device_ctx
->device_obj
, &device_info
);
358 if (!strcmp(dev_attr
->attr
.name
, "class_id")) {
359 return sprintf(buf
, "{%02x%02x%02x%02x-%02x%02x-%02x%02x-"
360 "%02x%02x%02x%02x%02x%02x%02x%02x}\n",
361 device_info
.ChannelType
.data
[3],
362 device_info
.ChannelType
.data
[2],
363 device_info
.ChannelType
.data
[1],
364 device_info
.ChannelType
.data
[0],
365 device_info
.ChannelType
.data
[5],
366 device_info
.ChannelType
.data
[4],
367 device_info
.ChannelType
.data
[7],
368 device_info
.ChannelType
.data
[6],
369 device_info
.ChannelType
.data
[8],
370 device_info
.ChannelType
.data
[9],
371 device_info
.ChannelType
.data
[10],
372 device_info
.ChannelType
.data
[11],
373 device_info
.ChannelType
.data
[12],
374 device_info
.ChannelType
.data
[13],
375 device_info
.ChannelType
.data
[14],
376 device_info
.ChannelType
.data
[15]);
377 } else if (!strcmp(dev_attr
->attr
.name
, "device_id")) {
378 return sprintf(buf
, "{%02x%02x%02x%02x-%02x%02x-%02x%02x-"
379 "%02x%02x%02x%02x%02x%02x%02x%02x}\n",
380 device_info
.ChannelInstance
.data
[3],
381 device_info
.ChannelInstance
.data
[2],
382 device_info
.ChannelInstance
.data
[1],
383 device_info
.ChannelInstance
.data
[0],
384 device_info
.ChannelInstance
.data
[5],
385 device_info
.ChannelInstance
.data
[4],
386 device_info
.ChannelInstance
.data
[7],
387 device_info
.ChannelInstance
.data
[6],
388 device_info
.ChannelInstance
.data
[8],
389 device_info
.ChannelInstance
.data
[9],
390 device_info
.ChannelInstance
.data
[10],
391 device_info
.ChannelInstance
.data
[11],
392 device_info
.ChannelInstance
.data
[12],
393 device_info
.ChannelInstance
.data
[13],
394 device_info
.ChannelInstance
.data
[14],
395 device_info
.ChannelInstance
.data
[15]);
396 } else if (!strcmp(dev_attr
->attr
.name
, "state")) {
397 return sprintf(buf
, "%d\n", device_info
.ChannelState
);
398 } else if (!strcmp(dev_attr
->attr
.name
, "id")) {
399 return sprintf(buf
, "%d\n", device_info
.ChannelId
);
400 } else if (!strcmp(dev_attr
->attr
.name
, "out_intr_mask")) {
401 return sprintf(buf
, "%d\n", device_info
.Outbound
.InterruptMask
);
402 } else if (!strcmp(dev_attr
->attr
.name
, "out_read_index")) {
403 return sprintf(buf
, "%d\n", device_info
.Outbound
.ReadIndex
);
404 } else if (!strcmp(dev_attr
->attr
.name
, "out_write_index")) {
405 return sprintf(buf
, "%d\n", device_info
.Outbound
.WriteIndex
);
406 } else if (!strcmp(dev_attr
->attr
.name
, "out_read_bytes_avail")) {
407 return sprintf(buf
, "%d\n",
408 device_info
.Outbound
.BytesAvailToRead
);
409 } else if (!strcmp(dev_attr
->attr
.name
, "out_write_bytes_avail")) {
410 return sprintf(buf
, "%d\n",
411 device_info
.Outbound
.BytesAvailToWrite
);
412 } else if (!strcmp(dev_attr
->attr
.name
, "in_intr_mask")) {
413 return sprintf(buf
, "%d\n", device_info
.Inbound
.InterruptMask
);
414 } else if (!strcmp(dev_attr
->attr
.name
, "in_read_index")) {
415 return sprintf(buf
, "%d\n", device_info
.Inbound
.ReadIndex
);
416 } else if (!strcmp(dev_attr
->attr
.name
, "in_write_index")) {
417 return sprintf(buf
, "%d\n", device_info
.Inbound
.WriteIndex
);
418 } else if (!strcmp(dev_attr
->attr
.name
, "in_read_bytes_avail")) {
419 return sprintf(buf
, "%d\n",
420 device_info
.Inbound
.BytesAvailToRead
);
421 } else if (!strcmp(dev_attr
->attr
.name
, "in_write_bytes_avail")) {
422 return sprintf(buf
, "%d\n",
423 device_info
.Inbound
.BytesAvailToWrite
);
424 } else if (!strcmp(dev_attr
->attr
.name
, "monitor_id")) {
425 return sprintf(buf
, "%d\n", device_info
.MonitorId
);
426 } else if (!strcmp(dev_attr
->attr
.name
, "server_monitor_pending")) {
427 return sprintf(buf
, "%d\n", device_info
.ServerMonitorPending
);
428 } else if (!strcmp(dev_attr
->attr
.name
, "server_monitor_latency")) {
429 return sprintf(buf
, "%d\n", device_info
.ServerMonitorLatency
);
430 } else if (!strcmp(dev_attr
->attr
.name
, "server_monitor_conn_id")) {
431 return sprintf(buf
, "%d\n",
432 device_info
.ServerMonitorConnectionId
);
433 } else if (!strcmp(dev_attr
->attr
.name
, "client_monitor_pending")) {
434 return sprintf(buf
, "%d\n", device_info
.ClientMonitorPending
);
435 } else if (!strcmp(dev_attr
->attr
.name
, "client_monitor_latency")) {
436 return sprintf(buf
, "%d\n", device_info
.ClientMonitorLatency
);
437 } else if (!strcmp(dev_attr
->attr
.name
, "client_monitor_conn_id")) {
438 return sprintf(buf
, "%d\n",
439 device_info
.ClientMonitorConnectionId
);
446 * vmbus_bus_init -Main vmbus driver initialization routine.
449 * - initialize the vmbus driver context
450 * - setup various driver entry points
451 * - invoke the vmbus hv main init routine
452 * - get the irq resource
453 * - invoke the vmbus to add the vmbus root device
454 * - setup the vmbus root device
455 * - retrieve the channel offers
457 static int vmbus_bus_init(void)
459 struct vmbus_driver_context
*vmbus_drv_ctx
= &g_vmbus_drv
;
460 struct hv_driver
*driver
= &g_vmbus_drv
.drv_obj
;
461 struct vm_device
*dev_ctx
= &g_vmbus_drv
.device_ctx
;
465 DPRINT_INFO(VMBUS
, "+++++++ HV Driver version = %s +++++++",
467 DPRINT_INFO(VMBUS
, "+++++++ Vmbus supported version = %d +++++++",
468 VMBUS_REVISION_NUMBER
);
469 DPRINT_INFO(VMBUS
, "+++++++ Vmbus using SINT %d +++++++",
471 DPRINT_DBG(VMBUS
, "sizeof(vmbus_channel_packet_page_buffer)=%zd, "
472 "sizeof(VMBUS_CHANNEL_PACKET_MULITPAGE_BUFFER)=%zd",
473 sizeof(struct vmbus_channel_packet_page_buffer
),
474 sizeof(struct vmbus_channel_packet_multipage_buffer
));
476 driver
->name
= gDriverName
;
477 memcpy(&driver
->deviceType
, &gVmbusDeviceType
, sizeof(struct hv_guid
));
479 /* Setup dispatch table */
480 driver
->OnDeviceAdd
= VmbusOnDeviceAdd
;
481 driver
->OnDeviceRemove
= VmbusOnDeviceRemove
;
482 driver
->OnCleanup
= VmbusOnCleanup
;
484 /* Hypervisor initialization...setup hypercall page..etc */
487 DPRINT_ERR(VMBUS
, "Unable to initialize the hypervisor - 0x%x",
493 if (!driver
->OnDeviceAdd
) {
494 DPRINT_ERR(VMBUS_DRV
, "OnDeviceAdd() routine not set");
499 vmbus_drv_ctx
->bus
.name
= driver
->name
;
501 /* Initialize the bus context */
502 tasklet_init(&vmbus_drv_ctx
->msg_dpc
, vmbus_msg_dpc
,
503 (unsigned long)driver
);
504 tasklet_init(&vmbus_drv_ctx
->event_dpc
, vmbus_event_dpc
,
505 (unsigned long)driver
);
507 /* Now, register the bus driver with LDM */
508 ret
= bus_register(&vmbus_drv_ctx
->bus
);
514 /* Get the interrupt resource */
515 ret
= request_irq(vmbus_irq
, vmbus_isr
, IRQF_SAMPLE_RANDOM
,
519 DPRINT_ERR(VMBUS_DRV
, "ERROR - Unable to request IRQ %d",
522 bus_unregister(&vmbus_drv_ctx
->bus
);
527 vector
= VMBUS_IRQ_VECTOR
;
529 DPRINT_INFO(VMBUS_DRV
, "irq 0x%x vector 0x%x", vmbus_irq
, vector
);
531 /* Call to bus driver to add the root device */
532 memset(dev_ctx
, 0, sizeof(struct vm_device
));
534 ret
= driver
->OnDeviceAdd(&dev_ctx
->device_obj
, &vector
);
536 DPRINT_ERR(VMBUS_DRV
,
537 "ERROR - Unable to add vmbus root device");
539 free_irq(vmbus_irq
, NULL
);
541 bus_unregister(&vmbus_drv_ctx
->bus
);
546 /* strcpy(dev_ctx->device.bus_id, dev_ctx->device_obj.name); */
547 dev_set_name(&dev_ctx
->device
, "vmbus_0_0");
548 memcpy(&dev_ctx
->class_id
, &dev_ctx
->device_obj
.deviceType
,
549 sizeof(struct hv_guid
));
550 memcpy(&dev_ctx
->device_id
, &dev_ctx
->device_obj
.deviceInstance
,
551 sizeof(struct hv_guid
));
553 /* No need to bind a driver to the root device. */
554 dev_ctx
->device
.parent
= NULL
;
555 /* NULL; vmbus_remove() does not get invoked */
556 dev_ctx
->device
.bus
= &vmbus_drv_ctx
->bus
;
558 /* Setup the device dispatch table */
559 dev_ctx
->device
.release
= vmbus_bus_release
;
561 /* Setup the bus as root device */
562 ret
= device_register(&dev_ctx
->device
);
564 DPRINT_ERR(VMBUS_DRV
,
565 "ERROR - Unable to register vmbus root device");
567 free_irq(vmbus_irq
, NULL
);
568 bus_unregister(&vmbus_drv_ctx
->bus
);
574 vmbus_request_offers();
575 wait_for_completion(&hv_channel_ready
);
582 * vmbus_bus_exit - Terminate the vmbus driver.
584 * This routine is opposite of vmbus_bus_init()
586 static void vmbus_bus_exit(void)
588 struct hv_driver
*driver
= &g_vmbus_drv
.drv_obj
;
589 struct vmbus_driver_context
*vmbus_drv_ctx
= &g_vmbus_drv
;
591 struct vm_device
*dev_ctx
= &g_vmbus_drv
.device_ctx
;
593 /* Remove the root device */
594 if (driver
->OnDeviceRemove
)
595 driver
->OnDeviceRemove(&dev_ctx
->device_obj
);
597 if (driver
->OnCleanup
)
598 driver
->OnCleanup(driver
);
600 /* Unregister the root bus device */
601 device_unregister(&dev_ctx
->device
);
603 bus_unregister(&vmbus_drv_ctx
->bus
);
605 free_irq(vmbus_irq
, NULL
);
607 tasklet_kill(&vmbus_drv_ctx
->msg_dpc
);
608 tasklet_kill(&vmbus_drv_ctx
->event_dpc
);
613 * vmbus_child_driver_register() - Register a vmbus's child driver
614 * @driver_ctx: Pointer to driver structure you want to register
616 * @driver_ctx is of type &struct driver_context
618 * Registers the given driver with Linux through the 'driver_register()' call
619 * And sets up the hyper-v vmbus handling for this driver.
620 * It will return the state of the 'driver_register()' call.
622 * Mainly used by Hyper-V drivers.
624 int vmbus_child_driver_register(struct driver_context
*driver_ctx
)
628 DPRINT_INFO(VMBUS_DRV
, "child driver (%p) registering - name %s",
629 driver_ctx
, driver_ctx
->driver
.name
);
631 /* The child driver on this vmbus */
632 driver_ctx
->driver
.bus
= &g_vmbus_drv
.bus
;
634 ret
= driver_register(&driver_ctx
->driver
);
636 vmbus_request_offers();
640 EXPORT_SYMBOL(vmbus_child_driver_register
);
643 * vmbus_child_driver_unregister() - Unregister a vmbus's child driver
644 * @driver_ctx: Pointer to driver structure you want to un-register
646 * @driver_ctx is of type &struct driver_context
648 * Un-register the given driver with Linux through the 'driver_unregister()'
649 * call. And ungegisters the driver from the Hyper-V vmbus handler.
651 * Mainly used by Hyper-V drivers.
653 void vmbus_child_driver_unregister(struct driver_context
*driver_ctx
)
655 DPRINT_INFO(VMBUS_DRV
, "child driver (%p) unregistering - name %s",
656 driver_ctx
, driver_ctx
->driver
.name
);
658 driver_unregister(&driver_ctx
->driver
);
660 driver_ctx
->driver
.bus
= NULL
;
662 EXPORT_SYMBOL(vmbus_child_driver_unregister
);
665 * vmbus_child_device_create - Creates and registers a new child device
668 struct hv_device
*vmbus_child_device_create(struct hv_guid
*type
,
669 struct hv_guid
*instance
,
670 struct vmbus_channel
*channel
)
672 struct vm_device
*child_device_ctx
;
673 struct hv_device
*child_device_obj
;
675 /* Allocate the new child device */
676 child_device_ctx
= kzalloc(sizeof(struct vm_device
), GFP_KERNEL
);
677 if (!child_device_ctx
) {
678 DPRINT_ERR(VMBUS_DRV
,
679 "unable to allocate device_context for child device");
683 DPRINT_DBG(VMBUS_DRV
, "child device (%p) allocated - "
684 "type {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
685 "%02x%02x%02x%02x%02x%02x%02x%02x},"
686 "id {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
687 "%02x%02x%02x%02x%02x%02x%02x%02x}",
688 &child_device_ctx
->device
,
689 type
->data
[3], type
->data
[2], type
->data
[1], type
->data
[0],
690 type
->data
[5], type
->data
[4], type
->data
[7], type
->data
[6],
691 type
->data
[8], type
->data
[9], type
->data
[10], type
->data
[11],
692 type
->data
[12], type
->data
[13], type
->data
[14], type
->data
[15],
693 instance
->data
[3], instance
->data
[2],
694 instance
->data
[1], instance
->data
[0],
695 instance
->data
[5], instance
->data
[4],
696 instance
->data
[7], instance
->data
[6],
697 instance
->data
[8], instance
->data
[9],
698 instance
->data
[10], instance
->data
[11],
699 instance
->data
[12], instance
->data
[13],
700 instance
->data
[14], instance
->data
[15]);
702 child_device_obj
= &child_device_ctx
->device_obj
;
703 child_device_obj
->channel
= channel
;
704 memcpy(&child_device_obj
->deviceType
, type
, sizeof(struct hv_guid
));
705 memcpy(&child_device_obj
->deviceInstance
, instance
,
706 sizeof(struct hv_guid
));
708 memcpy(&child_device_ctx
->class_id
, type
, sizeof(struct hv_guid
));
709 memcpy(&child_device_ctx
->device_id
, instance
, sizeof(struct hv_guid
));
711 return child_device_obj
;
715 * vmbus_child_device_register - Register the child device on the specified bus
717 int vmbus_child_device_register(struct hv_device
*root_device_obj
,
718 struct hv_device
*child_device_obj
)
721 struct vm_device
*root_device_ctx
=
722 to_vm_device(root_device_obj
);
723 struct vm_device
*child_device_ctx
=
724 to_vm_device(child_device_obj
);
725 static atomic_t device_num
= ATOMIC_INIT(0);
727 DPRINT_DBG(VMBUS_DRV
, "child device (%p) registering",
730 /* Set the device name. Otherwise, device_register() will fail. */
731 dev_set_name(&child_device_ctx
->device
, "vmbus_0_%d",
732 atomic_inc_return(&device_num
));
734 /* The new device belongs to this bus */
735 child_device_ctx
->device
.bus
= &g_vmbus_drv
.bus
; /* device->dev.bus; */
736 child_device_ctx
->device
.parent
= &root_device_ctx
->device
;
737 child_device_ctx
->device
.release
= vmbus_device_release
;
740 * Register with the LDM. This will kick off the driver/device
741 * binding...which will eventually call vmbus_match() and vmbus_probe()
743 ret
= device_register(&child_device_ctx
->device
);
745 /* vmbus_probe() error does not get propergate to device_register(). */
746 ret
= child_device_ctx
->probe_error
;
749 DPRINT_ERR(VMBUS_DRV
, "unable to register child device (%p)",
750 &child_device_ctx
->device
);
752 DPRINT_INFO(VMBUS_DRV
, "child device (%p) registered",
753 &child_device_ctx
->device
);
759 * vmbus_child_device_unregister - Remove the specified child device
762 void vmbus_child_device_unregister(struct hv_device
*device_obj
)
764 struct vm_device
*device_ctx
= to_vm_device(device_obj
);
766 DPRINT_INFO(VMBUS_DRV
, "unregistering child device (%p)",
767 &device_ctx
->device
);
770 * Kick off the process of unregistering the device.
771 * This will call vmbus_remove() and eventually vmbus_device_release()
773 device_unregister(&device_ctx
->device
);
775 DPRINT_INFO(VMBUS_DRV
, "child device (%p) unregistered",
776 &device_ctx
->device
);
780 * vmbus_uevent - add uevent for our device
782 * This routine is invoked when a device is added or removed on the vmbus to
783 * generate a uevent to udev in the userspace. The udev will then look at its
784 * rule and the uevent generated here to load the appropriate driver
786 static int vmbus_uevent(struct device
*device
, struct kobj_uevent_env
*env
)
788 struct vm_device
*device_ctx
= device_to_vm_device(device
);
791 DPRINT_INFO(VMBUS_DRV
, "generating uevent - VMBUS_DEVICE_CLASS_GUID={"
792 "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
793 "%02x%02x%02x%02x%02x%02x%02x%02x}",
794 device_ctx
->class_id
.data
[3], device_ctx
->class_id
.data
[2],
795 device_ctx
->class_id
.data
[1], device_ctx
->class_id
.data
[0],
796 device_ctx
->class_id
.data
[5], device_ctx
->class_id
.data
[4],
797 device_ctx
->class_id
.data
[7], device_ctx
->class_id
.data
[6],
798 device_ctx
->class_id
.data
[8], device_ctx
->class_id
.data
[9],
799 device_ctx
->class_id
.data
[10],
800 device_ctx
->class_id
.data
[11],
801 device_ctx
->class_id
.data
[12],
802 device_ctx
->class_id
.data
[13],
803 device_ctx
->class_id
.data
[14],
804 device_ctx
->class_id
.data
[15]);
806 ret
= add_uevent_var(env
, "VMBUS_DEVICE_CLASS_GUID={"
807 "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
808 "%02x%02x%02x%02x%02x%02x%02x%02x}",
809 device_ctx
->class_id
.data
[3],
810 device_ctx
->class_id
.data
[2],
811 device_ctx
->class_id
.data
[1],
812 device_ctx
->class_id
.data
[0],
813 device_ctx
->class_id
.data
[5],
814 device_ctx
->class_id
.data
[4],
815 device_ctx
->class_id
.data
[7],
816 device_ctx
->class_id
.data
[6],
817 device_ctx
->class_id
.data
[8],
818 device_ctx
->class_id
.data
[9],
819 device_ctx
->class_id
.data
[10],
820 device_ctx
->class_id
.data
[11],
821 device_ctx
->class_id
.data
[12],
822 device_ctx
->class_id
.data
[13],
823 device_ctx
->class_id
.data
[14],
824 device_ctx
->class_id
.data
[15]);
829 ret
= add_uevent_var(env
, "VMBUS_DEVICE_DEVICE_GUID={"
830 "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
831 "%02x%02x%02x%02x%02x%02x%02x%02x}",
832 device_ctx
->device_id
.data
[3],
833 device_ctx
->device_id
.data
[2],
834 device_ctx
->device_id
.data
[1],
835 device_ctx
->device_id
.data
[0],
836 device_ctx
->device_id
.data
[5],
837 device_ctx
->device_id
.data
[4],
838 device_ctx
->device_id
.data
[7],
839 device_ctx
->device_id
.data
[6],
840 device_ctx
->device_id
.data
[8],
841 device_ctx
->device_id
.data
[9],
842 device_ctx
->device_id
.data
[10],
843 device_ctx
->device_id
.data
[11],
844 device_ctx
->device_id
.data
[12],
845 device_ctx
->device_id
.data
[13],
846 device_ctx
->device_id
.data
[14],
847 device_ctx
->device_id
.data
[15]);
855 * vmbus_match - Attempt to match the specified device to the specified driver
857 static int vmbus_match(struct device
*device
, struct device_driver
*driver
)
860 struct driver_context
*driver_ctx
= driver_to_driver_context(driver
);
861 struct vm_device
*device_ctx
= device_to_vm_device(device
);
863 /* We found our driver ? */
864 if (memcmp(&device_ctx
->class_id
, &driver_ctx
->class_id
,
865 sizeof(struct hv_guid
)) == 0) {
867 * !! NOTE: The driver_ctx is not a vmbus_drv_ctx. We typecast
868 * it here to access the struct hv_driver field
870 struct vmbus_driver_context
*vmbus_drv_ctx
=
871 (struct vmbus_driver_context
*)driver_ctx
;
873 device_ctx
->device_obj
.Driver
= &vmbus_drv_ctx
->drv_obj
;
874 DPRINT_INFO(VMBUS_DRV
,
875 "device object (%p) set to driver object (%p)",
876 &device_ctx
->device_obj
,
877 device_ctx
->device_obj
.Driver
);
885 * vmbus_probe_failed_cb - Callback when a driver probe failed in vmbus_probe()
887 * We need a callback because we cannot invoked device_unregister() inside
888 * vmbus_probe() since vmbus_probe() may be invoked inside device_register()
889 * i.e. we cannot call device_unregister() inside device_register()
891 static void vmbus_probe_failed_cb(struct work_struct
*context
)
893 struct vm_device
*device_ctx
= (struct vm_device
*)context
;
896 * Kick off the process of unregistering the device.
897 * This will call vmbus_remove() and eventually vmbus_device_release()
899 device_unregister(&device_ctx
->device
);
901 /* put_device(&device_ctx->device); */
905 * vmbus_probe - Add the new vmbus's child device
907 static int vmbus_probe(struct device
*child_device
)
910 struct driver_context
*driver_ctx
=
911 driver_to_driver_context(child_device
->driver
);
912 struct vm_device
*device_ctx
=
913 device_to_vm_device(child_device
);
915 /* Let the specific open-source driver handles the probe if it can */
916 if (driver_ctx
->probe
) {
917 ret
= device_ctx
->probe_error
= driver_ctx
->probe(child_device
);
919 DPRINT_ERR(VMBUS_DRV
, "probe() failed for device %s "
920 "(%p) on driver %s (%d)...",
921 dev_name(child_device
), child_device
,
922 child_device
->driver
->name
, ret
);
924 INIT_WORK(&device_ctx
->probe_failed_work_item
,
925 vmbus_probe_failed_cb
);
926 schedule_work(&device_ctx
->probe_failed_work_item
);
929 DPRINT_ERR(VMBUS_DRV
, "probe() method not set for driver - %s",
930 child_device
->driver
->name
);
937 * vmbus_remove - Remove a vmbus device
939 static int vmbus_remove(struct device
*child_device
)
942 struct driver_context
*driver_ctx
;
944 /* Special case root bus device */
945 if (child_device
->parent
== NULL
) {
947 * No-op since it is statically defined and handle in
953 if (child_device
->driver
) {
954 driver_ctx
= driver_to_driver_context(child_device
->driver
);
957 * Let the specific open-source driver handles the removal if
960 if (driver_ctx
->remove
) {
961 ret
= driver_ctx
->remove(child_device
);
963 DPRINT_ERR(VMBUS_DRV
,
964 "remove() method not set for driver - %s",
965 child_device
->driver
->name
);
974 * vmbus_shutdown - Shutdown a vmbus device
976 static void vmbus_shutdown(struct device
*child_device
)
978 struct driver_context
*driver_ctx
;
980 /* Special case root bus device */
981 if (child_device
->parent
== NULL
) {
983 * No-op since it is statically defined and handle in
989 /* The device may not be attached yet */
990 if (!child_device
->driver
)
993 driver_ctx
= driver_to_driver_context(child_device
->driver
);
995 /* Let the specific open-source driver handles the removal if it can */
996 if (driver_ctx
->shutdown
)
997 driver_ctx
->shutdown(child_device
);
1003 * vmbus_bus_release - Final callback release of the vmbus root device
1005 static void vmbus_bus_release(struct device
*device
)
1008 /* Empty release functions are a bug, or a major sign
1009 * of a problem design, this MUST BE FIXED! */
1010 dev_err(device
, "%s needs to be fixed!\n", __func__
);
1015 * vmbus_device_release - Final callback release of the vmbus child device
1017 static void vmbus_device_release(struct device
*device
)
1019 struct vm_device
*device_ctx
= device_to_vm_device(device
);
1023 /* !!DO NOT REFERENCE device_ctx anymore at this point!! */
1027 * vmbus_msg_dpc - Tasklet routine to handle hypervisor messages
1029 static void vmbus_msg_dpc(unsigned long data
)
1031 struct hv_driver
*driver
= (struct hv_driver
*)data
;
1033 /* Call to bus driver to handle interrupt */
1034 vmbus_on_msg_dpc(driver
);
1038 * vmbus_event_dpc - Tasklet routine to handle hypervisor events
1040 static void vmbus_event_dpc(unsigned long data
)
1042 struct hv_driver
*driver
= (struct hv_driver
*)data
;
1044 /* Call to bus driver to handle interrupt */
1045 vmbus_on_event_dpc(driver
);
1048 static irqreturn_t
vmbus_isr(int irq
, void *dev_id
)
1050 struct hv_driver
*driver
= &g_vmbus_drv
.drv_obj
;
1053 /* Call to bus driver to handle interrupt */
1054 ret
= vmbus_on_isr(driver
);
1056 /* Schedules a dpc if necessary */
1058 if (test_bit(0, (unsigned long *)&ret
))
1059 tasklet_schedule(&g_vmbus_drv
.msg_dpc
);
1061 if (test_bit(1, (unsigned long *)&ret
))
1062 tasklet_schedule(&g_vmbus_drv
.event_dpc
);
1070 static struct dmi_system_id __initdata microsoft_hv_dmi_table
[] = {
1074 DMI_MATCH(DMI_SYS_VENDOR
, "Microsoft Corporation"),
1075 DMI_MATCH(DMI_PRODUCT_NAME
, "Virtual Machine"),
1076 DMI_MATCH(DMI_BOARD_NAME
, "Virtual Machine"),
1081 MODULE_DEVICE_TABLE(dmi
, microsoft_hv_dmi_table
);
1083 static int __init
vmbus_init(void)
1085 DPRINT_INFO(VMBUS_DRV
,
1086 "Vmbus initializing.... current log level 0x%x (%x,%x)",
1087 vmbus_loglevel
, HIWORD(vmbus_loglevel
), LOWORD(vmbus_loglevel
));
1088 /* Todo: it is used for loglevel, to be ported to new kernel. */
1090 if (!dmi_check_system(microsoft_hv_dmi_table
))
1093 return vmbus_bus_init();
1096 static void __exit
vmbus_exit(void)
1099 /* Todo: it is used for loglevel, to be ported to new kernel. */
1103 * We use a PCI table to determine if we should autoload this driver This is
1104 * needed by distro tools to determine if the hyperv drivers should be
1105 * installed and/or configured. We don't do anything else with the table, but
1106 * it needs to be present.
1108 static const struct pci_device_id microsoft_hv_pci_table
[] = {
1109 { PCI_DEVICE(0x1414, 0x5353) }, /* VGA compatible controller */
1112 MODULE_DEVICE_TABLE(pci
, microsoft_hv_pci_table
);
1114 MODULE_LICENSE("GPL");
1115 MODULE_VERSION(HV_DRV_VERSION
);
1116 module_param(vmbus_irq
, int, S_IRUGO
);
1117 module_param(vmbus_loglevel
, int, S_IRUGO
);
1119 module_init(vmbus_init
);
1120 module_exit(vmbus_exit
);