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 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 *driver_name
= "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 device_type
= {
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 device_id
= {
143 0xfc, 0x60, 0x37, 0xac, 0xdf, 0x9a, 0xaa, 0x40,
144 0x94, 0x27, 0xa7, 0x0e, 0xd6, 0xde, 0x95, 0xc5
148 static struct hv_device
*vmbus_device
; /* vmbus root device */
151 * vmbus_child_dev_add - Registers the child device with the vmbus
153 int vmbus_child_dev_add(struct hv_device
*child_dev
)
155 return vmbus_child_device_register(vmbus_device
, child_dev
);
159 * vmbus_dev_add - Callback when the root bus device is added
161 static int vmbus_dev_add(struct hv_device
*dev
, void *info
)
163 u32
*irqvector
= info
;
168 memcpy(&vmbus_device
->dev_type
, &device_type
, sizeof(struct hv_guid
));
169 memcpy(&vmbus_device
->dev_instance
, &device_id
,
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
= vmbus_connect();
179 /* VmbusSendEvent(device->localPortId+1); */
184 * vmbus_dev_rm - Callback when the root bus device is removed
186 static int vmbus_dev_rm(struct hv_device
*dev
)
190 vmbus_release_unattached_channels();
192 on_each_cpu(hv_synic_cleanup
, NULL
, 1);
197 * vmbus_cleanup - Perform any cleanup when the driver is removed
199 static void vmbus_cleanup(struct hv_driver
*drv
)
201 /* struct vmbus_driver *driver = (struct vmbus_driver *)drv; */
206 struct onmessage_work_context
{
207 struct work_struct work
;
208 struct hv_message msg
;
211 static void vmbus_onmessage_work(struct work_struct
*work
)
213 struct onmessage_work_context
*ctx
;
215 ctx
= container_of(work
, struct onmessage_work_context
,
217 vmbus_onmessage(&ctx
->msg
);
222 * vmbus_on_msg_dpc - DPC routine to handle messages from the hypervisior
224 static void vmbus_on_msg_dpc(struct hv_driver
*drv
)
226 int cpu
= smp_processor_id();
227 void *page_addr
= hv_context
.synic_message_page
[cpu
];
228 struct hv_message
*msg
= (struct hv_message
*)page_addr
+
230 struct onmessage_work_context
*ctx
;
233 if (msg
->header
.message_type
== HVMSG_NONE
) {
237 ctx
= kmalloc(sizeof(*ctx
), GFP_ATOMIC
);
240 INIT_WORK(&ctx
->work
, vmbus_onmessage_work
);
241 memcpy(&ctx
->msg
, msg
, sizeof(*msg
));
242 queue_work(vmbus_connection
.work_queue
, &ctx
->work
);
245 msg
->header
.message_type
= HVMSG_NONE
;
248 * Make sure the write to MessageType (ie set to
249 * HVMSG_NONE) happens before we read the
250 * MessagePending and EOMing. Otherwise, the EOMing
251 * will not deliver any more messages since there is
256 if (msg
->header
.message_flags
.msg_pending
) {
258 * This will cause message queue rescan to
259 * possibly deliver another msg from the
262 wrmsrl(HV_X64_MSR_EOM
, 0);
268 * vmbus_on_isr - ISR routine
270 static int vmbus_on_isr(struct hv_driver
*drv
)
273 int cpu
= smp_processor_id();
275 struct hv_message
*msg
;
276 union hv_synic_event_flags
*event
;
278 page_addr
= hv_context
.synic_message_page
[cpu
];
279 msg
= (struct hv_message
*)page_addr
+ VMBUS_MESSAGE_SINT
;
281 /* Check if there are actual msgs to be process */
282 if (msg
->header
.message_type
!= HVMSG_NONE
) {
283 DPRINT_DBG(VMBUS
, "received msg type %d size %d",
284 msg
->header
.message_type
,
285 msg
->header
.payload_size
);
289 /* TODO: Check if there are events to be process */
290 page_addr
= hv_context
.synic_event_page
[cpu
];
291 event
= (union hv_synic_event_flags
*)page_addr
+ VMBUS_MESSAGE_SINT
;
293 /* Since we are a child, we only need to check bit 0 */
294 if (test_and_clear_bit(0, (unsigned long *) &event
->flags32
[0])) {
295 DPRINT_DBG(VMBUS
, "received event %d", event
->flags32
[0]);
302 static void get_channel_info(struct hv_device
*device
,
303 struct hv_device_info
*info
)
305 struct vmbus_channel_debug_info debug_info
;
307 if (!device
->channel
)
310 vmbus_get_debug_info(device
->channel
, &debug_info
);
312 info
->chn_id
= debug_info
.relid
;
313 info
->chn_state
= debug_info
.state
;
314 memcpy(&info
->chn_type
, &debug_info
.interfacetype
,
315 sizeof(struct hv_guid
));
316 memcpy(&info
->chn_instance
, &debug_info
.interface_instance
,
317 sizeof(struct hv_guid
));
319 info
->monitor_id
= debug_info
.monitorid
;
321 info
->server_monitor_pending
= debug_info
.servermonitor_pending
;
322 info
->server_monitor_latency
= debug_info
.servermonitor_latency
;
323 info
->server_monitor_conn_id
= debug_info
.servermonitor_connectionid
;
325 info
->client_monitor_pending
= debug_info
.clientmonitor_pending
;
326 info
->client_monitor_latency
= debug_info
.clientmonitor_latency
;
327 info
->client_monitor_conn_id
= debug_info
.clientmonitor_connectionid
;
329 info
->inbound
.int_mask
= debug_info
.inbound
.current_interrupt_mask
;
330 info
->inbound
.read_idx
= debug_info
.inbound
.current_read_index
;
331 info
->inbound
.write_idx
= debug_info
.inbound
.current_write_index
;
332 info
->inbound
.bytes_avail_toread
=
333 debug_info
.inbound
.bytes_avail_toread
;
334 info
->inbound
.bytes_avail_towrite
=
335 debug_info
.inbound
.bytes_avail_towrite
;
337 info
->outbound
.int_mask
=
338 debug_info
.outbound
.current_interrupt_mask
;
339 info
->outbound
.read_idx
= debug_info
.outbound
.current_read_index
;
340 info
->outbound
.write_idx
= debug_info
.outbound
.current_write_index
;
341 info
->outbound
.bytes_avail_toread
=
342 debug_info
.outbound
.bytes_avail_toread
;
343 info
->outbound
.bytes_avail_towrite
=
344 debug_info
.outbound
.bytes_avail_towrite
;
348 * vmbus_show_device_attr - Show the device attribute in sysfs.
350 * This is invoked when user does a
351 * "cat /sys/bus/vmbus/devices/<busdevice>/<attr name>"
353 static ssize_t
vmbus_show_device_attr(struct device
*dev
,
354 struct device_attribute
*dev_attr
,
357 struct vm_device
*device_ctx
= device_to_vm_device(dev
);
358 struct hv_device_info device_info
;
360 memset(&device_info
, 0, sizeof(struct hv_device_info
));
362 get_channel_info(&device_ctx
->device_obj
, &device_info
);
364 if (!strcmp(dev_attr
->attr
.name
, "class_id")) {
365 return sprintf(buf
, "{%02x%02x%02x%02x-%02x%02x-%02x%02x-"
366 "%02x%02x%02x%02x%02x%02x%02x%02x}\n",
367 device_info
.chn_type
.data
[3],
368 device_info
.chn_type
.data
[2],
369 device_info
.chn_type
.data
[1],
370 device_info
.chn_type
.data
[0],
371 device_info
.chn_type
.data
[5],
372 device_info
.chn_type
.data
[4],
373 device_info
.chn_type
.data
[7],
374 device_info
.chn_type
.data
[6],
375 device_info
.chn_type
.data
[8],
376 device_info
.chn_type
.data
[9],
377 device_info
.chn_type
.data
[10],
378 device_info
.chn_type
.data
[11],
379 device_info
.chn_type
.data
[12],
380 device_info
.chn_type
.data
[13],
381 device_info
.chn_type
.data
[14],
382 device_info
.chn_type
.data
[15]);
383 } else if (!strcmp(dev_attr
->attr
.name
, "device_id")) {
384 return sprintf(buf
, "{%02x%02x%02x%02x-%02x%02x-%02x%02x-"
385 "%02x%02x%02x%02x%02x%02x%02x%02x}\n",
386 device_info
.chn_instance
.data
[3],
387 device_info
.chn_instance
.data
[2],
388 device_info
.chn_instance
.data
[1],
389 device_info
.chn_instance
.data
[0],
390 device_info
.chn_instance
.data
[5],
391 device_info
.chn_instance
.data
[4],
392 device_info
.chn_instance
.data
[7],
393 device_info
.chn_instance
.data
[6],
394 device_info
.chn_instance
.data
[8],
395 device_info
.chn_instance
.data
[9],
396 device_info
.chn_instance
.data
[10],
397 device_info
.chn_instance
.data
[11],
398 device_info
.chn_instance
.data
[12],
399 device_info
.chn_instance
.data
[13],
400 device_info
.chn_instance
.data
[14],
401 device_info
.chn_instance
.data
[15]);
402 } else if (!strcmp(dev_attr
->attr
.name
, "state")) {
403 return sprintf(buf
, "%d\n", device_info
.chn_state
);
404 } else if (!strcmp(dev_attr
->attr
.name
, "id")) {
405 return sprintf(buf
, "%d\n", device_info
.chn_id
);
406 } else if (!strcmp(dev_attr
->attr
.name
, "out_intr_mask")) {
407 return sprintf(buf
, "%d\n", device_info
.outbound
.int_mask
);
408 } else if (!strcmp(dev_attr
->attr
.name
, "out_read_index")) {
409 return sprintf(buf
, "%d\n", device_info
.outbound
.read_idx
);
410 } else if (!strcmp(dev_attr
->attr
.name
, "out_write_index")) {
411 return sprintf(buf
, "%d\n", device_info
.outbound
.write_idx
);
412 } else if (!strcmp(dev_attr
->attr
.name
, "out_read_bytes_avail")) {
413 return sprintf(buf
, "%d\n",
414 device_info
.outbound
.bytes_avail_toread
);
415 } else if (!strcmp(dev_attr
->attr
.name
, "out_write_bytes_avail")) {
416 return sprintf(buf
, "%d\n",
417 device_info
.outbound
.bytes_avail_towrite
);
418 } else if (!strcmp(dev_attr
->attr
.name
, "in_intr_mask")) {
419 return sprintf(buf
, "%d\n", device_info
.inbound
.int_mask
);
420 } else if (!strcmp(dev_attr
->attr
.name
, "in_read_index")) {
421 return sprintf(buf
, "%d\n", device_info
.inbound
.read_idx
);
422 } else if (!strcmp(dev_attr
->attr
.name
, "in_write_index")) {
423 return sprintf(buf
, "%d\n", device_info
.inbound
.write_idx
);
424 } else if (!strcmp(dev_attr
->attr
.name
, "in_read_bytes_avail")) {
425 return sprintf(buf
, "%d\n",
426 device_info
.inbound
.bytes_avail_toread
);
427 } else if (!strcmp(dev_attr
->attr
.name
, "in_write_bytes_avail")) {
428 return sprintf(buf
, "%d\n",
429 device_info
.inbound
.bytes_avail_towrite
);
430 } else if (!strcmp(dev_attr
->attr
.name
, "monitor_id")) {
431 return sprintf(buf
, "%d\n", device_info
.monitor_id
);
432 } else if (!strcmp(dev_attr
->attr
.name
, "server_monitor_pending")) {
433 return sprintf(buf
, "%d\n", device_info
.server_monitor_pending
);
434 } else if (!strcmp(dev_attr
->attr
.name
, "server_monitor_latency")) {
435 return sprintf(buf
, "%d\n", device_info
.server_monitor_latency
);
436 } else if (!strcmp(dev_attr
->attr
.name
, "server_monitor_conn_id")) {
437 return sprintf(buf
, "%d\n",
438 device_info
.server_monitor_conn_id
);
439 } else if (!strcmp(dev_attr
->attr
.name
, "client_monitor_pending")) {
440 return sprintf(buf
, "%d\n", device_info
.client_monitor_pending
);
441 } else if (!strcmp(dev_attr
->attr
.name
, "client_monitor_latency")) {
442 return sprintf(buf
, "%d\n", device_info
.client_monitor_latency
);
443 } else if (!strcmp(dev_attr
->attr
.name
, "client_monitor_conn_id")) {
444 return sprintf(buf
, "%d\n",
445 device_info
.client_monitor_conn_id
);
452 * vmbus_bus_init -Main vmbus driver initialization routine.
455 * - initialize the vmbus driver context
456 * - setup various driver entry points
457 * - invoke the vmbus hv main init routine
458 * - get the irq resource
459 * - invoke the vmbus to add the vmbus root device
460 * - setup the vmbus root device
461 * - retrieve the channel offers
463 static int vmbus_bus_init(void)
465 struct vmbus_driver_context
*vmbus_drv_ctx
= &vmbus_drv
;
466 struct hv_driver
*driver
= &vmbus_drv
.drv_obj
;
467 struct vm_device
*dev_ctx
= &vmbus_drv
.device_ctx
;
471 DPRINT_INFO(VMBUS
, "+++++++ HV Driver version = %s +++++++",
473 DPRINT_INFO(VMBUS
, "+++++++ Vmbus supported version = %d +++++++",
474 VMBUS_REVISION_NUMBER
);
475 DPRINT_INFO(VMBUS
, "+++++++ Vmbus using SINT %d +++++++",
477 DPRINT_DBG(VMBUS
, "sizeof(vmbus_channel_packet_page_buffer)=%zd, "
478 "sizeof(VMBUS_CHANNEL_PACKET_MULITPAGE_BUFFER)=%zd",
479 sizeof(struct vmbus_channel_packet_page_buffer
),
480 sizeof(struct vmbus_channel_packet_multipage_buffer
));
482 driver
->name
= driver_name
;
483 memcpy(&driver
->dev_type
, &device_type
, sizeof(struct hv_guid
));
485 /* Setup dispatch table */
486 driver
->dev_add
= vmbus_dev_add
;
487 driver
->dev_rm
= vmbus_dev_rm
;
488 driver
->cleanup
= vmbus_cleanup
;
490 /* Hypervisor initialization...setup hypercall page..etc */
493 DPRINT_ERR(VMBUS
, "Unable to initialize the hypervisor - 0x%x",
499 if (!driver
->dev_add
) {
500 DPRINT_ERR(VMBUS_DRV
, "OnDeviceAdd() routine not set");
505 vmbus_drv_ctx
->bus
.name
= driver
->name
;
507 /* Initialize the bus context */
508 tasklet_init(&vmbus_drv_ctx
->msg_dpc
, vmbus_msg_dpc
,
509 (unsigned long)driver
);
510 tasklet_init(&vmbus_drv_ctx
->event_dpc
, vmbus_event_dpc
,
511 (unsigned long)driver
);
513 /* Now, register the bus driver with LDM */
514 ret
= bus_register(&vmbus_drv_ctx
->bus
);
520 /* Get the interrupt resource */
521 ret
= request_irq(vmbus_irq
, vmbus_isr
, IRQF_SAMPLE_RANDOM
,
525 DPRINT_ERR(VMBUS_DRV
, "ERROR - Unable to request IRQ %d",
528 bus_unregister(&vmbus_drv_ctx
->bus
);
533 vector
= VMBUS_IRQ_VECTOR
;
535 DPRINT_INFO(VMBUS_DRV
, "irq 0x%x vector 0x%x", vmbus_irq
, vector
);
537 /* Call to bus driver to add the root device */
538 memset(dev_ctx
, 0, sizeof(struct vm_device
));
540 ret
= driver
->dev_add(&dev_ctx
->device_obj
, &vector
);
542 DPRINT_ERR(VMBUS_DRV
,
543 "ERROR - Unable to add vmbus root device");
545 free_irq(vmbus_irq
, NULL
);
547 bus_unregister(&vmbus_drv_ctx
->bus
);
552 /* strcpy(dev_ctx->device.bus_id, dev_ctx->device_obj.name); */
553 dev_set_name(&dev_ctx
->device
, "vmbus_0_0");
554 memcpy(&dev_ctx
->class_id
, &dev_ctx
->device_obj
.dev_type
,
555 sizeof(struct hv_guid
));
556 memcpy(&dev_ctx
->device_id
, &dev_ctx
->device_obj
.dev_instance
,
557 sizeof(struct hv_guid
));
559 /* No need to bind a driver to the root device. */
560 dev_ctx
->device
.parent
= NULL
;
561 /* NULL; vmbus_remove() does not get invoked */
562 dev_ctx
->device
.bus
= &vmbus_drv_ctx
->bus
;
564 /* Setup the device dispatch table */
565 dev_ctx
->device
.release
= vmbus_bus_release
;
567 /* Setup the bus as root device */
568 ret
= device_register(&dev_ctx
->device
);
570 DPRINT_ERR(VMBUS_DRV
,
571 "ERROR - Unable to register vmbus root device");
573 free_irq(vmbus_irq
, NULL
);
574 bus_unregister(&vmbus_drv_ctx
->bus
);
580 vmbus_request_offers();
581 wait_for_completion(&hv_channel_ready
);
588 * vmbus_bus_exit - Terminate the vmbus driver.
590 * This routine is opposite of vmbus_bus_init()
592 static void vmbus_bus_exit(void)
594 struct hv_driver
*driver
= &vmbus_drv
.drv_obj
;
595 struct vmbus_driver_context
*vmbus_drv_ctx
= &vmbus_drv
;
597 struct vm_device
*dev_ctx
= &vmbus_drv
.device_ctx
;
599 /* Remove the root device */
601 driver
->dev_rm(&dev_ctx
->device_obj
);
604 driver
->cleanup(driver
);
606 /* Unregister the root bus device */
607 device_unregister(&dev_ctx
->device
);
609 bus_unregister(&vmbus_drv_ctx
->bus
);
611 free_irq(vmbus_irq
, NULL
);
613 tasklet_kill(&vmbus_drv_ctx
->msg_dpc
);
614 tasklet_kill(&vmbus_drv_ctx
->event_dpc
);
619 * vmbus_child_driver_register() - Register a vmbus's child driver
620 * @driver_ctx: Pointer to driver structure you want to register
622 * @driver_ctx is of type &struct driver_context
624 * Registers the given driver with Linux through the 'driver_register()' call
625 * And sets up the hyper-v vmbus handling for this driver.
626 * It will return the state of the 'driver_register()' call.
628 * Mainly used by Hyper-V drivers.
630 int vmbus_child_driver_register(struct driver_context
*driver_ctx
)
634 DPRINT_INFO(VMBUS_DRV
, "child driver (%p) registering - name %s",
635 driver_ctx
, driver_ctx
->driver
.name
);
637 /* The child driver on this vmbus */
638 driver_ctx
->driver
.bus
= &vmbus_drv
.bus
;
640 ret
= driver_register(&driver_ctx
->driver
);
642 vmbus_request_offers();
646 EXPORT_SYMBOL(vmbus_child_driver_register
);
649 * vmbus_child_driver_unregister() - Unregister a vmbus's child driver
650 * @driver_ctx: Pointer to driver structure you want to un-register
652 * @driver_ctx is of type &struct driver_context
654 * Un-register the given driver with Linux through the 'driver_unregister()'
655 * call. And ungegisters the driver from the Hyper-V vmbus handler.
657 * Mainly used by Hyper-V drivers.
659 void vmbus_child_driver_unregister(struct driver_context
*driver_ctx
)
661 DPRINT_INFO(VMBUS_DRV
, "child driver (%p) unregistering - name %s",
662 driver_ctx
, driver_ctx
->driver
.name
);
664 driver_unregister(&driver_ctx
->driver
);
666 driver_ctx
->driver
.bus
= NULL
;
668 EXPORT_SYMBOL(vmbus_child_driver_unregister
);
671 * vmbus_child_device_create - Creates and registers a new child device
674 struct hv_device
*vmbus_child_device_create(struct hv_guid
*type
,
675 struct hv_guid
*instance
,
676 struct vmbus_channel
*channel
)
678 struct vm_device
*child_device_ctx
;
679 struct hv_device
*child_device_obj
;
681 /* Allocate the new child device */
682 child_device_ctx
= kzalloc(sizeof(struct vm_device
), GFP_KERNEL
);
683 if (!child_device_ctx
) {
684 DPRINT_ERR(VMBUS_DRV
,
685 "unable to allocate device_context for child device");
689 DPRINT_DBG(VMBUS_DRV
, "child device (%p) allocated - "
690 "type {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
691 "%02x%02x%02x%02x%02x%02x%02x%02x},"
692 "id {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
693 "%02x%02x%02x%02x%02x%02x%02x%02x}",
694 &child_device_ctx
->device
,
695 type
->data
[3], type
->data
[2], type
->data
[1], type
->data
[0],
696 type
->data
[5], type
->data
[4], type
->data
[7], type
->data
[6],
697 type
->data
[8], type
->data
[9], type
->data
[10], type
->data
[11],
698 type
->data
[12], type
->data
[13], type
->data
[14], type
->data
[15],
699 instance
->data
[3], instance
->data
[2],
700 instance
->data
[1], instance
->data
[0],
701 instance
->data
[5], instance
->data
[4],
702 instance
->data
[7], instance
->data
[6],
703 instance
->data
[8], instance
->data
[9],
704 instance
->data
[10], instance
->data
[11],
705 instance
->data
[12], instance
->data
[13],
706 instance
->data
[14], instance
->data
[15]);
708 child_device_obj
= &child_device_ctx
->device_obj
;
709 child_device_obj
->channel
= channel
;
710 memcpy(&child_device_obj
->dev_type
, type
, sizeof(struct hv_guid
));
711 memcpy(&child_device_obj
->dev_instance
, instance
,
712 sizeof(struct hv_guid
));
714 memcpy(&child_device_ctx
->class_id
, type
, sizeof(struct hv_guid
));
715 memcpy(&child_device_ctx
->device_id
, instance
, sizeof(struct hv_guid
));
717 return child_device_obj
;
721 * vmbus_child_device_register - Register the child device on the specified bus
723 int vmbus_child_device_register(struct hv_device
*root_device_obj
,
724 struct hv_device
*child_device_obj
)
727 struct vm_device
*root_device_ctx
=
728 to_vm_device(root_device_obj
);
729 struct vm_device
*child_device_ctx
=
730 to_vm_device(child_device_obj
);
731 static atomic_t device_num
= ATOMIC_INIT(0);
733 DPRINT_DBG(VMBUS_DRV
, "child device (%p) registering",
736 /* Set the device name. Otherwise, device_register() will fail. */
737 dev_set_name(&child_device_ctx
->device
, "vmbus_0_%d",
738 atomic_inc_return(&device_num
));
740 /* The new device belongs to this bus */
741 child_device_ctx
->device
.bus
= &vmbus_drv
.bus
; /* device->dev.bus; */
742 child_device_ctx
->device
.parent
= &root_device_ctx
->device
;
743 child_device_ctx
->device
.release
= vmbus_device_release
;
746 * Register with the LDM. This will kick off the driver/device
747 * binding...which will eventually call vmbus_match() and vmbus_probe()
749 ret
= device_register(&child_device_ctx
->device
);
751 /* vmbus_probe() error does not get propergate to device_register(). */
752 ret
= child_device_ctx
->probe_error
;
755 DPRINT_ERR(VMBUS_DRV
, "unable to register child device (%p)",
756 &child_device_ctx
->device
);
758 DPRINT_INFO(VMBUS_DRV
, "child device (%p) registered",
759 &child_device_ctx
->device
);
765 * vmbus_child_device_unregister - Remove the specified child device
768 void vmbus_child_device_unregister(struct hv_device
*device_obj
)
770 struct vm_device
*device_ctx
= to_vm_device(device_obj
);
772 DPRINT_INFO(VMBUS_DRV
, "unregistering child device (%p)",
773 &device_ctx
->device
);
776 * Kick off the process of unregistering the device.
777 * This will call vmbus_remove() and eventually vmbus_device_release()
779 device_unregister(&device_ctx
->device
);
781 DPRINT_INFO(VMBUS_DRV
, "child device (%p) unregistered",
782 &device_ctx
->device
);
786 * vmbus_uevent - add uevent for our device
788 * This routine is invoked when a device is added or removed on the vmbus to
789 * generate a uevent to udev in the userspace. The udev will then look at its
790 * rule and the uevent generated here to load the appropriate driver
792 static int vmbus_uevent(struct device
*device
, struct kobj_uevent_env
*env
)
794 struct vm_device
*device_ctx
= device_to_vm_device(device
);
797 DPRINT_INFO(VMBUS_DRV
, "generating uevent - VMBUS_DEVICE_CLASS_GUID={"
798 "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
799 "%02x%02x%02x%02x%02x%02x%02x%02x}",
800 device_ctx
->class_id
.data
[3], device_ctx
->class_id
.data
[2],
801 device_ctx
->class_id
.data
[1], device_ctx
->class_id
.data
[0],
802 device_ctx
->class_id
.data
[5], device_ctx
->class_id
.data
[4],
803 device_ctx
->class_id
.data
[7], device_ctx
->class_id
.data
[6],
804 device_ctx
->class_id
.data
[8], device_ctx
->class_id
.data
[9],
805 device_ctx
->class_id
.data
[10],
806 device_ctx
->class_id
.data
[11],
807 device_ctx
->class_id
.data
[12],
808 device_ctx
->class_id
.data
[13],
809 device_ctx
->class_id
.data
[14],
810 device_ctx
->class_id
.data
[15]);
812 ret
= add_uevent_var(env
, "VMBUS_DEVICE_CLASS_GUID={"
813 "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
814 "%02x%02x%02x%02x%02x%02x%02x%02x}",
815 device_ctx
->class_id
.data
[3],
816 device_ctx
->class_id
.data
[2],
817 device_ctx
->class_id
.data
[1],
818 device_ctx
->class_id
.data
[0],
819 device_ctx
->class_id
.data
[5],
820 device_ctx
->class_id
.data
[4],
821 device_ctx
->class_id
.data
[7],
822 device_ctx
->class_id
.data
[6],
823 device_ctx
->class_id
.data
[8],
824 device_ctx
->class_id
.data
[9],
825 device_ctx
->class_id
.data
[10],
826 device_ctx
->class_id
.data
[11],
827 device_ctx
->class_id
.data
[12],
828 device_ctx
->class_id
.data
[13],
829 device_ctx
->class_id
.data
[14],
830 device_ctx
->class_id
.data
[15]);
835 ret
= add_uevent_var(env
, "VMBUS_DEVICE_DEVICE_GUID={"
836 "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
837 "%02x%02x%02x%02x%02x%02x%02x%02x}",
838 device_ctx
->device_id
.data
[3],
839 device_ctx
->device_id
.data
[2],
840 device_ctx
->device_id
.data
[1],
841 device_ctx
->device_id
.data
[0],
842 device_ctx
->device_id
.data
[5],
843 device_ctx
->device_id
.data
[4],
844 device_ctx
->device_id
.data
[7],
845 device_ctx
->device_id
.data
[6],
846 device_ctx
->device_id
.data
[8],
847 device_ctx
->device_id
.data
[9],
848 device_ctx
->device_id
.data
[10],
849 device_ctx
->device_id
.data
[11],
850 device_ctx
->device_id
.data
[12],
851 device_ctx
->device_id
.data
[13],
852 device_ctx
->device_id
.data
[14],
853 device_ctx
->device_id
.data
[15]);
861 * vmbus_match - Attempt to match the specified device to the specified driver
863 static int vmbus_match(struct device
*device
, struct device_driver
*driver
)
866 struct driver_context
*driver_ctx
= driver_to_driver_context(driver
);
867 struct vm_device
*device_ctx
= device_to_vm_device(device
);
869 /* We found our driver ? */
870 if (memcmp(&device_ctx
->class_id
, &driver_ctx
->class_id
,
871 sizeof(struct hv_guid
)) == 0) {
873 * !! NOTE: The driver_ctx is not a vmbus_drv_ctx. We typecast
874 * it here to access the struct hv_driver field
876 struct vmbus_driver_context
*vmbus_drv_ctx
=
877 (struct vmbus_driver_context
*)driver_ctx
;
879 device_ctx
->device_obj
.drv
= &vmbus_drv_ctx
->drv_obj
;
880 DPRINT_INFO(VMBUS_DRV
,
881 "device object (%p) set to driver object (%p)",
882 &device_ctx
->device_obj
,
883 device_ctx
->device_obj
.drv
);
891 * vmbus_probe_failed_cb - Callback when a driver probe failed in vmbus_probe()
893 * We need a callback because we cannot invoked device_unregister() inside
894 * vmbus_probe() since vmbus_probe() may be invoked inside device_register()
895 * i.e. we cannot call device_unregister() inside device_register()
897 static void vmbus_probe_failed_cb(struct work_struct
*context
)
899 struct vm_device
*device_ctx
= (struct vm_device
*)context
;
902 * Kick off the process of unregistering the device.
903 * This will call vmbus_remove() and eventually vmbus_device_release()
905 device_unregister(&device_ctx
->device
);
907 /* put_device(&device_ctx->device); */
911 * vmbus_probe - Add the new vmbus's child device
913 static int vmbus_probe(struct device
*child_device
)
916 struct driver_context
*driver_ctx
=
917 driver_to_driver_context(child_device
->driver
);
918 struct vm_device
*device_ctx
=
919 device_to_vm_device(child_device
);
921 /* Let the specific open-source driver handles the probe if it can */
922 if (driver_ctx
->driver
.probe
) {
923 ret
= device_ctx
->probe_error
=
924 driver_ctx
->driver
.probe(child_device
);
926 DPRINT_ERR(VMBUS_DRV
, "probe() failed for device %s "
927 "(%p) on driver %s (%d)...",
928 dev_name(child_device
), child_device
,
929 child_device
->driver
->name
, ret
);
931 INIT_WORK(&device_ctx
->probe_failed_work_item
,
932 vmbus_probe_failed_cb
);
933 schedule_work(&device_ctx
->probe_failed_work_item
);
936 DPRINT_ERR(VMBUS_DRV
, "probe() method not set for driver - %s",
937 child_device
->driver
->name
);
944 * vmbus_remove - Remove a vmbus device
946 static int vmbus_remove(struct device
*child_device
)
949 struct driver_context
*driver_ctx
;
951 /* Special case root bus device */
952 if (child_device
->parent
== NULL
) {
954 * No-op since it is statically defined and handle in
960 if (child_device
->driver
) {
961 driver_ctx
= driver_to_driver_context(child_device
->driver
);
964 * Let the specific open-source driver handles the removal if
967 if (driver_ctx
->driver
.remove
) {
968 ret
= driver_ctx
->driver
.remove(child_device
);
970 DPRINT_ERR(VMBUS_DRV
,
971 "remove() method not set for driver - %s",
972 child_device
->driver
->name
);
981 * vmbus_shutdown - Shutdown a vmbus device
983 static void vmbus_shutdown(struct device
*child_device
)
985 struct driver_context
*driver_ctx
;
987 /* Special case root bus device */
988 if (child_device
->parent
== NULL
) {
990 * No-op since it is statically defined and handle in
996 /* The device may not be attached yet */
997 if (!child_device
->driver
)
1000 driver_ctx
= driver_to_driver_context(child_device
->driver
);
1002 /* Let the specific open-source driver handles the removal if it can */
1003 if (driver_ctx
->driver
.shutdown
)
1004 driver_ctx
->driver
.shutdown(child_device
);
1010 * vmbus_bus_release - Final callback release of the vmbus root device
1012 static void vmbus_bus_release(struct device
*device
)
1015 /* Empty release functions are a bug, or a major sign
1016 * of a problem design, this MUST BE FIXED! */
1017 dev_err(device
, "%s needs to be fixed!\n", __func__
);
1022 * vmbus_device_release - Final callback release of the vmbus child device
1024 static void vmbus_device_release(struct device
*device
)
1026 struct vm_device
*device_ctx
= device_to_vm_device(device
);
1030 /* !!DO NOT REFERENCE device_ctx anymore at this point!! */
1034 * vmbus_msg_dpc - Tasklet routine to handle hypervisor messages
1036 static void vmbus_msg_dpc(unsigned long data
)
1038 struct hv_driver
*driver
= (struct hv_driver
*)data
;
1040 /* Call to bus driver to handle interrupt */
1041 vmbus_on_msg_dpc(driver
);
1045 * vmbus_event_dpc - Tasklet routine to handle hypervisor events
1047 static void vmbus_event_dpc(unsigned long data
)
1049 /* Call to bus driver to handle interrupt */
1053 static irqreturn_t
vmbus_isr(int irq
, void *dev_id
)
1055 struct hv_driver
*driver
= &vmbus_drv
.drv_obj
;
1058 /* Call to bus driver to handle interrupt */
1059 ret
= vmbus_on_isr(driver
);
1061 /* Schedules a dpc if necessary */
1063 if (test_bit(0, (unsigned long *)&ret
))
1064 tasklet_schedule(&vmbus_drv
.msg_dpc
);
1066 if (test_bit(1, (unsigned long *)&ret
))
1067 tasklet_schedule(&vmbus_drv
.event_dpc
);
1075 static struct dmi_system_id __initdata microsoft_hv_dmi_table
[] = {
1079 DMI_MATCH(DMI_SYS_VENDOR
, "Microsoft Corporation"),
1080 DMI_MATCH(DMI_PRODUCT_NAME
, "Virtual Machine"),
1081 DMI_MATCH(DMI_BOARD_NAME
, "Virtual Machine"),
1086 MODULE_DEVICE_TABLE(dmi
, microsoft_hv_dmi_table
);
1088 static int __init
vmbus_init(void)
1090 DPRINT_INFO(VMBUS_DRV
,
1091 "Vmbus initializing.... current log level 0x%x (%x,%x)",
1092 vmbus_loglevel
, HIWORD(vmbus_loglevel
), LOWORD(vmbus_loglevel
));
1093 /* Todo: it is used for loglevel, to be ported to new kernel. */
1095 if (!dmi_check_system(microsoft_hv_dmi_table
))
1098 return vmbus_bus_init();
1101 static void __exit
vmbus_exit(void)
1104 /* Todo: it is used for loglevel, to be ported to new kernel. */
1108 * We use a PCI table to determine if we should autoload this driver This is
1109 * needed by distro tools to determine if the hyperv drivers should be
1110 * installed and/or configured. We don't do anything else with the table, but
1111 * it needs to be present.
1113 static const struct pci_device_id microsoft_hv_pci_table
[] = {
1114 { PCI_DEVICE(0x1414, 0x5353) }, /* VGA compatible controller */
1117 MODULE_DEVICE_TABLE(pci
, microsoft_hv_pci_table
);
1119 MODULE_LICENSE("GPL");
1120 MODULE_VERSION(HV_DRV_VERSION
);
1121 module_param(vmbus_irq
, int, S_IRUGO
);
1122 module_param(vmbus_loglevel
, int, S_IRUGO
);
1124 module_init(vmbus_init
);
1125 module_exit(vmbus_exit
);