drivers/staging/hv/vmbus_drv.c

   1 /*
   2  * Copyright (c) 2009, Microsoft Corporation.
   3  *
   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.
   7  *
   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
  11  * more details.
  12  *
  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.
  16  *
  17  * Authors:
  18  *   Haiyang Zhang <haiyangz@microsoft.com>
  19  *   Hank Janssen  <hjanssen@microsoft.com>
  20  */
  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"
  32 #include "osd.h"
  33 #include "logging.h"
  34 #include "vmbus.h"
  35 #include "channel.h"
  36 #include "vmbus_private.h"
  37
  38
  39 /* FIXME! We need to do this dynamically for PIC and APIC system */
  40 #define VMBUS_IRQ               0x5
  41 #define VMBUS_IRQ_VECTOR        IRQ5_VECTOR
  42
  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;
  51
  52         struct bus_type bus;
  53         struct tasklet_struct msg_dpc;
  54         struct tasklet_struct event_dpc;
  55
  56         /* The bus root device */
  57         struct vm_device device_ctx;
  58 };
  59
  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);
  67
  68 static irqreturn_t vmbus_isr(int irq, void *dev_id);
  69
  70 static void vmbus_device_release(struct device *device);
  71 static void vmbus_bus_release(struct device *device);
  72
  73 static ssize_t vmbus_show_device_attr(struct device *dev,
  74                                       struct device_attribute *dev_attr,
  75                                       char *buf);
  76
  77
  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); */
  82
  83 static int vmbus_irq = VMBUS_IRQ;
  84
  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),
  92
  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),
  96
  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),
 100
 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),
 106
 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),
 112         __ATTR_NULL
 113 };
 114
 115 /* The one and only one */
 116 static struct vmbus_driver_context g_vmbus_drv = {
 117         .bus.name =             "vmbus",
 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,
 124 };
 125
 126 static const char *gDriverName = "hyperv";
 127
 128 /*
 129  * Windows vmbus does not defined this.
 130  * We defined this to be consistent with other devices
 131  */
 132 /* {c5295816-f63a-4d5f-8d1a-4daf999ca185} */
 133 static const struct hv_guid gVmbusDeviceType = {
 134         .data = {
 135                 0x16, 0x58, 0x29, 0xc5, 0x3a, 0xf6, 0x5f, 0x4d,
 136                 0x8d, 0x1a, 0x4d, 0xaf, 0x99, 0x9c, 0xa1, 0x85
 137         }
 138 };
 139
 140 /* {ac3760fc-9adf-40aa-9427-a70ed6de95c5} */
 141 static const struct hv_guid gVmbusDeviceId = {
 142         .data = {
 143                 0xfc, 0x60, 0x37, 0xac, 0xdf, 0x9a, 0xaa, 0x40,
 144                 0x94, 0x27, 0xa7, 0x0e, 0xd6, 0xde, 0x95, 0xc5
 145         }
 146 };
 147
 148 static struct hv_device *gDevice; /* vmbus root device */
 149
 150 /*
 151  * VmbusChildDeviceAdd - Registers the child device with the vmbus
 152  */
 153 int VmbusChildDeviceAdd(struct hv_device *ChildDevice)
 154 {
 155         return vmbus_child_device_register(gDevice, ChildDevice);
 156 }
 157
 158 /*
 159  * VmbusOnDeviceAdd - Callback when the root bus device is added
 160  */
 161 static int VmbusOnDeviceAdd(struct hv_device *dev, void *AdditionalInfo)
 162 {
 163         u32 *irqvector = AdditionalInfo;
 164         int ret;
 165
 166         gDevice = dev;
 167
 168         memcpy(&gDevice->deviceType, &gVmbusDeviceType, sizeof(struct hv_guid));
 169         memcpy(&gDevice->deviceInstance, &gVmbusDeviceId,
 170                sizeof(struct hv_guid));
 171
 172         /* strcpy(dev->name, "vmbus"); */
 173         /* SynIC setup... */
 174         on_each_cpu(hv_synic_init, (void *)irqvector, 1);
 175
 176         /* Connect to VMBus in the root partition */
 177         ret = VmbusConnect();
 178
 179         /* VmbusSendEvent(device->localPortId+1); */
 180         return ret;
 181 }
 182
 183 /*
 184  * VmbusOnDeviceRemove - Callback when the root bus device is removed
 185  */
 186 static int VmbusOnDeviceRemove(struct hv_device *dev)
 187 {
 188         int ret = 0;
 189
 190         vmbus_release_unattached_channels();
 191         VmbusDisconnect();
 192         on_each_cpu(hv_synic_cleanup, NULL, 1);
 193         return ret;
 194 }
 195
 196 /*
 197  * VmbusOnCleanup - Perform any cleanup when the driver is removed
 198  */
 199 static void VmbusOnCleanup(struct hv_driver *drv)
 200 {
 201         /* struct vmbus_driver *driver = (struct vmbus_driver *)drv; */
 202
 203         hv_cleanup();
 204 }
 205
 206 struct onmessage_work_context {
 207         struct work_struct work;
 208         struct hv_message msg;
 209 };
 210
 211 static void vmbus_onmessage_work(struct work_struct *work)
 212 {
 213         struct onmessage_work_context *ctx;
 214
 215         ctx = container_of(work, struct onmessage_work_context,
 216                            work);
 217         vmbus_onmessage(&ctx->msg);
 218         kfree(ctx);
 219 }
 220
 221 /*
 222  * vmbus_on_msg_dpc - DPC routine to handle messages from the hypervisior
 223  */
 224 static void vmbus_on_msg_dpc(struct hv_driver *drv)
 225 {
 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 +
 229                                   VMBUS_MESSAGE_SINT;
 230         struct onmessage_work_context *ctx;
 231
 232         while (1) {
 233                 if (msg->header.message_type == HVMSG_NONE) {
 234                         /* no msg */
 235                         break;
 236                 } else {
 237                         ctx = kmalloc(sizeof(*ctx), GFP_ATOMIC);
 238                         if (ctx == NULL)
 239                                 continue;
 240                         INIT_WORK(&ctx->work, vmbus_onmessage_work);
 241                         memcpy(&ctx->msg, msg, sizeof(*msg));
 242                         queue_work(gVmbusConnection.WorkQueue, &ctx->work);
 243                 }
 244
 245                 msg->header.message_type = HVMSG_NONE;
 246
 247                 /*
 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
 252                  * no empty slot
 253                  */
 254                 mb();
 255
 256                 if (msg->header.message_flags.msg_pending) {
 257                         /*
 258                          * This will cause message queue rescan to
 259                          * possibly deliver another msg from the
 260                          * hypervisor
 261                          */
 262                         wrmsrl(HV_X64_MSR_EOM, 0);
 263                 }
 264         }
 265 }
 266
 267 /*
 268  * vmbus_on_isr - ISR routine
 269  */
 270 static int vmbus_on_isr(struct hv_driver *drv)
 271 {
 272         int ret = 0;
 273         int cpu = smp_processor_id();
 274         void *page_addr;
 275         struct hv_message *msg;
 276         union hv_synic_event_flags *event;
 277
 278         page_addr = hv_context.synic_message_page[cpu];
 279         msg = (struct hv_message *)page_addr + VMBUS_MESSAGE_SINT;
 280
 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);
 286                 ret |= 0x1;
 287         }
 288
 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;
 292
 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]);
 296                 ret |= 0x2;
 297         }
 298
 299         return ret;
 300 }
 301
 302 static void get_channel_info(struct hv_device *device,
 303                              struct hv_device_info *info)
 304 {
 305         struct vmbus_channel_debug_info debug_info;
 306
 307         if (!device->channel)
 308                 return;
 309
 310         vmbus_get_debug_info(device->channel, &debug_info);
 311
 312         info->ChannelId = debug_info.relid;
 313         info->ChannelState = debug_info.state;
 314         memcpy(&info->ChannelType, &debug_info.interfacetype,
 315                sizeof(struct hv_guid));
 316         memcpy(&info->ChannelInstance, &debug_info.interface_instance,
 317                sizeof(struct hv_guid));
 318
 319         info->MonitorId = debug_info.monitorid;
 320
 321         info->ServerMonitorPending = debug_info.servermonitor_pending;
 322         info->ServerMonitorLatency = debug_info.servermonitor_latency;
 323         info->ServerMonitorConnectionId = debug_info.servermonitor_connectionid;
 324
 325         info->ClientMonitorPending = debug_info.clientmonitor_pending;
 326         info->ClientMonitorLatency = debug_info.clientmonitor_latency;
 327         info->ClientMonitorConnectionId = debug_info.clientmonitor_connectionid;
 328
 329         info->Inbound.InterruptMask = debug_info.inbound.current_interrupt_mask;
 330         info->Inbound.ReadIndex = debug_info.inbound.current_read_index;
 331         info->Inbound.WriteIndex = debug_info.inbound.current_write_index;
 332         info->Inbound.BytesAvailToRead = debug_info.inbound.bytes_avail_toread;
 333         info->Inbound.BytesAvailToWrite =
 334                 debug_info.inbound.bytes_avail_towrite;
 335
 336         info->Outbound.InterruptMask =
 337                 debug_info.outbound.current_interrupt_mask;
 338         info->Outbound.ReadIndex = debug_info.outbound.current_read_index;
 339         info->Outbound.WriteIndex = debug_info.outbound.current_write_index;
 340         info->Outbound.BytesAvailToRead =
 341                 debug_info.outbound.bytes_avail_toread;
 342         info->Outbound.BytesAvailToWrite =
 343                 debug_info.outbound.bytes_avail_towrite;
 344 }
 345
 346 /*
 347  * vmbus_show_device_attr - Show the device attribute in sysfs.
 348  *
 349  * This is invoked when user does a
 350  * "cat /sys/bus/vmbus/devices/<busdevice>/<attr name>"
 351  */
 352 static ssize_t vmbus_show_device_attr(struct device *dev,
 353                                       struct device_attribute *dev_attr,
 354                                       char *buf)
 355 {
 356         struct vm_device *device_ctx = device_to_vm_device(dev);
 357         struct hv_device_info device_info;
 358
 359         memset(&device_info, 0, sizeof(struct hv_device_info));
 360
 361         get_channel_info(&device_ctx->device_obj, &device_info);
 362
 363         if (!strcmp(dev_attr->attr.name, "class_id")) {
 364                 return sprintf(buf, "{%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 365                                "%02x%02x%02x%02x%02x%02x%02x%02x}\n",
 366                                device_info.ChannelType.data[3],
 367                                device_info.ChannelType.data[2],
 368                                device_info.ChannelType.data[1],
 369                                device_info.ChannelType.data[0],
 370                                device_info.ChannelType.data[5],
 371                                device_info.ChannelType.data[4],
 372                                device_info.ChannelType.data[7],
 373                                device_info.ChannelType.data[6],
 374                                device_info.ChannelType.data[8],
 375                                device_info.ChannelType.data[9],
 376                                device_info.ChannelType.data[10],
 377                                device_info.ChannelType.data[11],
 378                                device_info.ChannelType.data[12],
 379                                device_info.ChannelType.data[13],
 380                                device_info.ChannelType.data[14],
 381                                device_info.ChannelType.data[15]);
 382         } else if (!strcmp(dev_attr->attr.name, "device_id")) {
 383                 return sprintf(buf, "{%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 384                                "%02x%02x%02x%02x%02x%02x%02x%02x}\n",
 385                                device_info.ChannelInstance.data[3],
 386                                device_info.ChannelInstance.data[2],
 387                                device_info.ChannelInstance.data[1],
 388                                device_info.ChannelInstance.data[0],
 389                                device_info.ChannelInstance.data[5],
 390                                device_info.ChannelInstance.data[4],
 391                                device_info.ChannelInstance.data[7],
 392                                device_info.ChannelInstance.data[6],
 393                                device_info.ChannelInstance.data[8],
 394                                device_info.ChannelInstance.data[9],
 395                                device_info.ChannelInstance.data[10],
 396                                device_info.ChannelInstance.data[11],
 397                                device_info.ChannelInstance.data[12],
 398                                device_info.ChannelInstance.data[13],
 399                                device_info.ChannelInstance.data[14],
 400                                device_info.ChannelInstance.data[15]);
 401         } else if (!strcmp(dev_attr->attr.name, "state")) {
 402                 return sprintf(buf, "%d\n", device_info.ChannelState);
 403         } else if (!strcmp(dev_attr->attr.name, "id")) {
 404                 return sprintf(buf, "%d\n", device_info.ChannelId);
 405         } else if (!strcmp(dev_attr->attr.name, "out_intr_mask")) {
 406                 return sprintf(buf, "%d\n", device_info.Outbound.InterruptMask);
 407         } else if (!strcmp(dev_attr->attr.name, "out_read_index")) {
 408                 return sprintf(buf, "%d\n", device_info.Outbound.ReadIndex);
 409         } else if (!strcmp(dev_attr->attr.name, "out_write_index")) {
 410                 return sprintf(buf, "%d\n", device_info.Outbound.WriteIndex);
 411         } else if (!strcmp(dev_attr->attr.name, "out_read_bytes_avail")) {
 412                 return sprintf(buf, "%d\n",
 413                                device_info.Outbound.BytesAvailToRead);
 414         } else if (!strcmp(dev_attr->attr.name, "out_write_bytes_avail")) {
 415                 return sprintf(buf, "%d\n",
 416                                device_info.Outbound.BytesAvailToWrite);
 417         } else if (!strcmp(dev_attr->attr.name, "in_intr_mask")) {
 418                 return sprintf(buf, "%d\n", device_info.Inbound.InterruptMask);
 419         } else if (!strcmp(dev_attr->attr.name, "in_read_index")) {
 420                 return sprintf(buf, "%d\n", device_info.Inbound.ReadIndex);
 421         } else if (!strcmp(dev_attr->attr.name, "in_write_index")) {
 422                 return sprintf(buf, "%d\n", device_info.Inbound.WriteIndex);
 423         } else if (!strcmp(dev_attr->attr.name, "in_read_bytes_avail")) {
 424                 return sprintf(buf, "%d\n",
 425                                device_info.Inbound.BytesAvailToRead);
 426         } else if (!strcmp(dev_attr->attr.name, "in_write_bytes_avail")) {
 427                 return sprintf(buf, "%d\n",
 428                                device_info.Inbound.BytesAvailToWrite);
 429         } else if (!strcmp(dev_attr->attr.name, "monitor_id")) {
 430                 return sprintf(buf, "%d\n", device_info.MonitorId);
 431         } else if (!strcmp(dev_attr->attr.name, "server_monitor_pending")) {
 432                 return sprintf(buf, "%d\n", device_info.ServerMonitorPending);
 433         } else if (!strcmp(dev_attr->attr.name, "server_monitor_latency")) {
 434                 return sprintf(buf, "%d\n", device_info.ServerMonitorLatency);
 435         } else if (!strcmp(dev_attr->attr.name, "server_monitor_conn_id")) {
 436                 return sprintf(buf, "%d\n",
 437                                device_info.ServerMonitorConnectionId);
 438         } else if (!strcmp(dev_attr->attr.name, "client_monitor_pending")) {
 439                 return sprintf(buf, "%d\n", device_info.ClientMonitorPending);
 440         } else if (!strcmp(dev_attr->attr.name, "client_monitor_latency")) {
 441                 return sprintf(buf, "%d\n", device_info.ClientMonitorLatency);
 442         } else if (!strcmp(dev_attr->attr.name, "client_monitor_conn_id")) {
 443                 return sprintf(buf, "%d\n",
 444                                device_info.ClientMonitorConnectionId);
 445         } else {
 446                 return 0;
 447         }
 448 }
 449
 450 /*
 451  * vmbus_bus_init -Main vmbus driver initialization routine.
 452  *
 453  * Here, we
 454  *      - initialize the vmbus driver context
 455  *      - setup various driver entry points
 456  *      - invoke the vmbus hv main init routine
 457  *      - get the irq resource
 458  *      - invoke the vmbus to add the vmbus root device
 459  *      - setup the vmbus root device
 460  *      - retrieve the channel offers
 461  */
 462 static int vmbus_bus_init(void)
 463 {
 464         struct vmbus_driver_context *vmbus_drv_ctx = &g_vmbus_drv;
 465         struct hv_driver *driver = &g_vmbus_drv.drv_obj;
 466         struct vm_device *dev_ctx = &g_vmbus_drv.device_ctx;
 467         int ret;
 468         unsigned int vector;
 469
 470         DPRINT_INFO(VMBUS, "+++++++ HV Driver version = %s +++++++",
 471                     HV_DRV_VERSION);
 472         DPRINT_INFO(VMBUS, "+++++++ Vmbus supported version = %d +++++++",
 473                         VMBUS_REVISION_NUMBER);
 474         DPRINT_INFO(VMBUS, "+++++++ Vmbus using SINT %d +++++++",
 475                         VMBUS_MESSAGE_SINT);
 476         DPRINT_DBG(VMBUS, "sizeof(vmbus_channel_packet_page_buffer)=%zd, "
 477                         "sizeof(VMBUS_CHANNEL_PACKET_MULITPAGE_BUFFER)=%zd",
 478                         sizeof(struct vmbus_channel_packet_page_buffer),
 479                         sizeof(struct vmbus_channel_packet_multipage_buffer));
 480
 481         driver->name = gDriverName;
 482         memcpy(&driver->deviceType, &gVmbusDeviceType, sizeof(struct hv_guid));
 483
 484         /* Setup dispatch table */
 485         driver->OnDeviceAdd     = VmbusOnDeviceAdd;
 486         driver->OnDeviceRemove  = VmbusOnDeviceRemove;
 487         driver->OnCleanup       = VmbusOnCleanup;
 488
 489         /* Hypervisor initialization...setup hypercall page..etc */
 490         ret = hv_init();
 491         if (ret != 0) {
 492                 DPRINT_ERR(VMBUS, "Unable to initialize the hypervisor - 0x%x",
 493                                 ret);
 494                 goto cleanup;
 495         }
 496
 497         /* Sanity checks */
 498         if (!driver->OnDeviceAdd) {
 499                 DPRINT_ERR(VMBUS_DRV, "OnDeviceAdd() routine not set");
 500                 ret = -1;
 501                 goto cleanup;
 502         }
 503
 504         vmbus_drv_ctx->bus.name = driver->name;
 505
 506         /* Initialize the bus context */
 507         tasklet_init(&vmbus_drv_ctx->msg_dpc, vmbus_msg_dpc,
 508                      (unsigned long)driver);
 509         tasklet_init(&vmbus_drv_ctx->event_dpc, vmbus_event_dpc,
 510                      (unsigned long)driver);
 511
 512         /* Now, register the bus driver with LDM */
 513         ret = bus_register(&vmbus_drv_ctx->bus);
 514         if (ret) {
 515                 ret = -1;
 516                 goto cleanup;
 517         }
 518
 519         /* Get the interrupt resource */
 520         ret = request_irq(vmbus_irq, vmbus_isr, IRQF_SAMPLE_RANDOM,
 521                           driver->name, NULL);
 522
 523         if (ret != 0) {
 524                 DPRINT_ERR(VMBUS_DRV, "ERROR - Unable to request IRQ %d",
 525                            vmbus_irq);
 526
 527                 bus_unregister(&vmbus_drv_ctx->bus);
 528
 529                 ret = -1;
 530                 goto cleanup;
 531         }
 532         vector = VMBUS_IRQ_VECTOR;
 533
 534         DPRINT_INFO(VMBUS_DRV, "irq 0x%x vector 0x%x", vmbus_irq, vector);
 535
 536         /* Call to bus driver to add the root device */
 537         memset(dev_ctx, 0, sizeof(struct vm_device));
 538
 539         ret = driver->OnDeviceAdd(&dev_ctx->device_obj, &vector);
 540         if (ret != 0) {
 541                 DPRINT_ERR(VMBUS_DRV,
 542                            "ERROR - Unable to add vmbus root device");
 543
 544                 free_irq(vmbus_irq, NULL);
 545
 546                 bus_unregister(&vmbus_drv_ctx->bus);
 547
 548                 ret = -1;
 549                 goto cleanup;
 550         }
 551         /* strcpy(dev_ctx->device.bus_id, dev_ctx->device_obj.name); */
 552         dev_set_name(&dev_ctx->device, "vmbus_0_0");
 553         memcpy(&dev_ctx->class_id, &dev_ctx->device_obj.deviceType,
 554                 sizeof(struct hv_guid));
 555         memcpy(&dev_ctx->device_id, &dev_ctx->device_obj.deviceInstance,
 556                 sizeof(struct hv_guid));
 557
 558         /* No need to bind a driver to the root device. */
 559         dev_ctx->device.parent = NULL;
 560         /* NULL; vmbus_remove() does not get invoked */
 561         dev_ctx->device.bus = &vmbus_drv_ctx->bus;
 562
 563         /* Setup the device dispatch table */
 564         dev_ctx->device.release = vmbus_bus_release;
 565
 566         /* Setup the bus as root device */
 567         ret = device_register(&dev_ctx->device);
 568         if (ret) {
 569                 DPRINT_ERR(VMBUS_DRV,
 570                            "ERROR - Unable to register vmbus root device");
 571
 572                 free_irq(vmbus_irq, NULL);
 573                 bus_unregister(&vmbus_drv_ctx->bus);
 574
 575                 ret = -1;
 576                 goto cleanup;
 577         }
 578
 579         vmbus_request_offers();
 580         wait_for_completion(&hv_channel_ready);
 581
 582 cleanup:
 583         return ret;
 584 }
 585
 586 /*
 587  * vmbus_bus_exit - Terminate the vmbus driver.
 588  *
 589  * This routine is opposite of vmbus_bus_init()
 590  */
 591 static void vmbus_bus_exit(void)
 592 {
 593         struct hv_driver *driver = &g_vmbus_drv.drv_obj;
 594         struct vmbus_driver_context *vmbus_drv_ctx = &g_vmbus_drv;
 595
 596         struct vm_device *dev_ctx = &g_vmbus_drv.device_ctx;
 597
 598         /* Remove the root device */
 599         if (driver->OnDeviceRemove)
 600                 driver->OnDeviceRemove(&dev_ctx->device_obj);
 601
 602         if (driver->OnCleanup)
 603                 driver->OnCleanup(driver);
 604
 605         /* Unregister the root bus device */
 606         device_unregister(&dev_ctx->device);
 607
 608         bus_unregister(&vmbus_drv_ctx->bus);
 609
 610         free_irq(vmbus_irq, NULL);
 611
 612         tasklet_kill(&vmbus_drv_ctx->msg_dpc);
 613         tasklet_kill(&vmbus_drv_ctx->event_dpc);
 614 }
 615
 616
 617 /**
 618  * vmbus_child_driver_register() - Register a vmbus's child driver
 619  * @driver_ctx:        Pointer to driver structure you want to register
 620  *
 621  * @driver_ctx is of type &struct driver_context
 622  *
 623  * Registers the given driver with Linux through the 'driver_register()' call
 624  * And sets up the hyper-v vmbus handling for this driver.
 625  * It will return the state of the 'driver_register()' call.
 626  *
 627  * Mainly used by Hyper-V drivers.
 628  */
 629 int vmbus_child_driver_register(struct driver_context *driver_ctx)
 630 {
 631         int ret;
 632
 633         DPRINT_INFO(VMBUS_DRV, "child driver (%p) registering - name %s",
 634                     driver_ctx, driver_ctx->driver.name);
 635
 636         /* The child driver on this vmbus */
 637         driver_ctx->driver.bus = &g_vmbus_drv.bus;
 638
 639         ret = driver_register(&driver_ctx->driver);
 640
 641         vmbus_request_offers();
 642
 643         return ret;
 644 }
 645 EXPORT_SYMBOL(vmbus_child_driver_register);
 646
 647 /**
 648  * vmbus_child_driver_unregister() - Unregister a vmbus's child driver
 649  * @driver_ctx:        Pointer to driver structure you want to un-register
 650  *
 651  * @driver_ctx is of type &struct driver_context
 652  *
 653  * Un-register the given driver with Linux through the 'driver_unregister()'
 654  * call. And ungegisters the driver from the Hyper-V vmbus handler.
 655  *
 656  * Mainly used by Hyper-V drivers.
 657  */
 658 void vmbus_child_driver_unregister(struct driver_context *driver_ctx)
 659 {
 660         DPRINT_INFO(VMBUS_DRV, "child driver (%p) unregistering - name %s",
 661                     driver_ctx, driver_ctx->driver.name);
 662
 663         driver_unregister(&driver_ctx->driver);
 664
 665         driver_ctx->driver.bus = NULL;
 666 }
 667 EXPORT_SYMBOL(vmbus_child_driver_unregister);
 668
 669 /*
 670  * vmbus_child_device_create - Creates and registers a new child device
 671  * on the vmbus.
 672  */
 673 struct hv_device *vmbus_child_device_create(struct hv_guid *type,
 674                                             struct hv_guid *instance,
 675                                             struct vmbus_channel *channel)
 676 {
 677         struct vm_device *child_device_ctx;
 678         struct hv_device *child_device_obj;
 679
 680         /* Allocate the new child device */
 681         child_device_ctx = kzalloc(sizeof(struct vm_device), GFP_KERNEL);
 682         if (!child_device_ctx) {
 683                 DPRINT_ERR(VMBUS_DRV,
 684                         "unable to allocate device_context for child device");
 685                 return NULL;
 686         }
 687
 688         DPRINT_DBG(VMBUS_DRV, "child device (%p) allocated - "
 689                 "type {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 690                 "%02x%02x%02x%02x%02x%02x%02x%02x},"
 691                 "id {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 692                 "%02x%02x%02x%02x%02x%02x%02x%02x}",
 693                 &child_device_ctx->device,
 694                 type->data[3], type->data[2], type->data[1], type->data[0],
 695                 type->data[5], type->data[4], type->data[7], type->data[6],
 696                 type->data[8], type->data[9], type->data[10], type->data[11],
 697                 type->data[12], type->data[13], type->data[14], type->data[15],
 698                 instance->data[3], instance->data[2],
 699                 instance->data[1], instance->data[0],
 700                 instance->data[5], instance->data[4],
 701                 instance->data[7], instance->data[6],
 702                 instance->data[8], instance->data[9],
 703                 instance->data[10], instance->data[11],
 704                 instance->data[12], instance->data[13],
 705                 instance->data[14], instance->data[15]);
 706
 707         child_device_obj = &child_device_ctx->device_obj;
 708         child_device_obj->channel = channel;
 709         memcpy(&child_device_obj->deviceType, type, sizeof(struct hv_guid));
 710         memcpy(&child_device_obj->deviceInstance, instance,
 711                sizeof(struct hv_guid));
 712
 713         memcpy(&child_device_ctx->class_id, type, sizeof(struct hv_guid));
 714         memcpy(&child_device_ctx->device_id, instance, sizeof(struct hv_guid));
 715
 716         return child_device_obj;
 717 }
 718
 719 /*
 720  * vmbus_child_device_register - Register the child device on the specified bus
 721  */
 722 int vmbus_child_device_register(struct hv_device *root_device_obj,
 723                                 struct hv_device *child_device_obj)
 724 {
 725         int ret = 0;
 726         struct vm_device *root_device_ctx =
 727                                 to_vm_device(root_device_obj);
 728         struct vm_device *child_device_ctx =
 729                                 to_vm_device(child_device_obj);
 730         static atomic_t device_num = ATOMIC_INIT(0);
 731
 732         DPRINT_DBG(VMBUS_DRV, "child device (%p) registering",
 733                    child_device_ctx);
 734
 735         /* Set the device name. Otherwise, device_register() will fail. */
 736         dev_set_name(&child_device_ctx->device, "vmbus_0_%d",
 737                      atomic_inc_return(&device_num));
 738
 739         /* The new device belongs to this bus */
 740         child_device_ctx->device.bus = &g_vmbus_drv.bus; /* device->dev.bus; */
 741         child_device_ctx->device.parent = &root_device_ctx->device;
 742         child_device_ctx->device.release = vmbus_device_release;
 743
 744         /*
 745          * Register with the LDM. This will kick off the driver/device
 746          * binding...which will eventually call vmbus_match() and vmbus_probe()
 747          */
 748         ret = device_register(&child_device_ctx->device);
 749
 750         /* vmbus_probe() error does not get propergate to device_register(). */
 751         ret = child_device_ctx->probe_error;
 752
 753         if (ret)
 754                 DPRINT_ERR(VMBUS_DRV, "unable to register child device (%p)",
 755                            &child_device_ctx->device);
 756         else
 757                 DPRINT_INFO(VMBUS_DRV, "child device (%p) registered",
 758                             &child_device_ctx->device);
 759
 760         return ret;
 761 }
 762
 763 /*
 764  * vmbus_child_device_unregister - Remove the specified child device
 765  * from the vmbus.
 766  */
 767 void vmbus_child_device_unregister(struct hv_device *device_obj)
 768 {
 769         struct vm_device *device_ctx = to_vm_device(device_obj);
 770
 771         DPRINT_INFO(VMBUS_DRV, "unregistering child device (%p)",
 772                     &device_ctx->device);
 773
 774         /*
 775          * Kick off the process of unregistering the device.
 776          * This will call vmbus_remove() and eventually vmbus_device_release()
 777          */
 778         device_unregister(&device_ctx->device);
 779
 780         DPRINT_INFO(VMBUS_DRV, "child device (%p) unregistered",
 781                     &device_ctx->device);
 782 }
 783
 784 /*
 785  * vmbus_uevent - add uevent for our device
 786  *
 787  * This routine is invoked when a device is added or removed on the vmbus to
 788  * generate a uevent to udev in the userspace. The udev will then look at its
 789  * rule and the uevent generated here to load the appropriate driver
 790  */
 791 static int vmbus_uevent(struct device *device, struct kobj_uevent_env *env)
 792 {
 793         struct vm_device *device_ctx = device_to_vm_device(device);
 794         int ret;
 795
 796         DPRINT_INFO(VMBUS_DRV, "generating uevent - VMBUS_DEVICE_CLASS_GUID={"
 797                     "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 798                     "%02x%02x%02x%02x%02x%02x%02x%02x}",
 799                     device_ctx->class_id.data[3], device_ctx->class_id.data[2],
 800                     device_ctx->class_id.data[1], device_ctx->class_id.data[0],
 801                     device_ctx->class_id.data[5], device_ctx->class_id.data[4],
 802                     device_ctx->class_id.data[7], device_ctx->class_id.data[6],
 803                     device_ctx->class_id.data[8], device_ctx->class_id.data[9],
 804                     device_ctx->class_id.data[10],
 805                     device_ctx->class_id.data[11],
 806                     device_ctx->class_id.data[12],
 807                     device_ctx->class_id.data[13],
 808                     device_ctx->class_id.data[14],
 809                     device_ctx->class_id.data[15]);
 810
 811         ret = add_uevent_var(env, "VMBUS_DEVICE_CLASS_GUID={"
 812                              "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 813                              "%02x%02x%02x%02x%02x%02x%02x%02x}",
 814                              device_ctx->class_id.data[3],
 815                              device_ctx->class_id.data[2],
 816                              device_ctx->class_id.data[1],
 817                              device_ctx->class_id.data[0],
 818                              device_ctx->class_id.data[5],
 819                              device_ctx->class_id.data[4],
 820                              device_ctx->class_id.data[7],
 821                              device_ctx->class_id.data[6],
 822                              device_ctx->class_id.data[8],
 823                              device_ctx->class_id.data[9],
 824                              device_ctx->class_id.data[10],
 825                              device_ctx->class_id.data[11],
 826                              device_ctx->class_id.data[12],
 827                              device_ctx->class_id.data[13],
 828                              device_ctx->class_id.data[14],
 829                              device_ctx->class_id.data[15]);
 830
 831         if (ret)
 832                 return ret;
 833
 834         ret = add_uevent_var(env, "VMBUS_DEVICE_DEVICE_GUID={"
 835                              "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 836                              "%02x%02x%02x%02x%02x%02x%02x%02x}",
 837                              device_ctx->device_id.data[3],
 838                              device_ctx->device_id.data[2],
 839                              device_ctx->device_id.data[1],
 840                              device_ctx->device_id.data[0],
 841                              device_ctx->device_id.data[5],
 842                              device_ctx->device_id.data[4],
 843                              device_ctx->device_id.data[7],
 844                              device_ctx->device_id.data[6],
 845                              device_ctx->device_id.data[8],
 846                              device_ctx->device_id.data[9],
 847                              device_ctx->device_id.data[10],
 848                              device_ctx->device_id.data[11],
 849                              device_ctx->device_id.data[12],
 850                              device_ctx->device_id.data[13],
 851                              device_ctx->device_id.data[14],
 852                              device_ctx->device_id.data[15]);
 853         if (ret)
 854                 return ret;
 855
 856         return 0;
 857 }
 858
 859 /*
 860  * vmbus_match - Attempt to match the specified device to the specified driver
 861  */
 862 static int vmbus_match(struct device *device, struct device_driver *driver)
 863 {
 864         int match = 0;
 865         struct driver_context *driver_ctx = driver_to_driver_context(driver);
 866         struct vm_device *device_ctx = device_to_vm_device(device);
 867
 868         /* We found our driver ? */
 869         if (memcmp(&device_ctx->class_id, &driver_ctx->class_id,
 870                    sizeof(struct hv_guid)) == 0) {
 871                 /*
 872                  * !! NOTE: The driver_ctx is not a vmbus_drv_ctx. We typecast
 873                  * it here to access the struct hv_driver field
 874                  */
 875                 struct vmbus_driver_context *vmbus_drv_ctx =
 876                         (struct vmbus_driver_context *)driver_ctx;
 877
 878                 device_ctx->device_obj.Driver = &vmbus_drv_ctx->drv_obj;
 879                 DPRINT_INFO(VMBUS_DRV,
 880                             "device object (%p) set to driver object (%p)",
 881                             &device_ctx->device_obj,
 882                             device_ctx->device_obj.Driver);
 883
 884                 match = 1;
 885         }
 886         return match;
 887 }
 888
 889 /*
 890  * vmbus_probe_failed_cb - Callback when a driver probe failed in vmbus_probe()
 891  *
 892  * We need a callback because we cannot invoked device_unregister() inside
 893  * vmbus_probe() since vmbus_probe() may be invoked inside device_register()
 894  * i.e. we cannot call device_unregister() inside device_register()
 895  */
 896 static void vmbus_probe_failed_cb(struct work_struct *context)
 897 {
 898         struct vm_device *device_ctx = (struct vm_device *)context;
 899
 900         /*
 901          * Kick off the process of unregistering the device.
 902          * This will call vmbus_remove() and eventually vmbus_device_release()
 903          */
 904         device_unregister(&device_ctx->device);
 905
 906         /* put_device(&device_ctx->device); */
 907 }
 908
 909 /*
 910  * vmbus_probe - Add the new vmbus's child device
 911  */
 912 static int vmbus_probe(struct device *child_device)
 913 {
 914         int ret = 0;
 915         struct driver_context *driver_ctx =
 916                         driver_to_driver_context(child_device->driver);
 917         struct vm_device *device_ctx =
 918                         device_to_vm_device(child_device);
 919
 920         /* Let the specific open-source driver handles the probe if it can */
 921         if (driver_ctx->probe) {
 922                 ret = device_ctx->probe_error = driver_ctx->probe(child_device);
 923                 if (ret != 0) {
 924                         DPRINT_ERR(VMBUS_DRV, "probe() failed for device %s "
 925                                    "(%p) on driver %s (%d)...",
 926                                    dev_name(child_device), child_device,
 927                                    child_device->driver->name, ret);
 928
 929                         INIT_WORK(&device_ctx->probe_failed_work_item,
 930                                   vmbus_probe_failed_cb);
 931                         schedule_work(&device_ctx->probe_failed_work_item);
 932                 }
 933         } else {
 934                 DPRINT_ERR(VMBUS_DRV, "probe() method not set for driver - %s",
 935                            child_device->driver->name);
 936                 ret = -1;
 937         }
 938         return ret;
 939 }
 940
 941 /*
 942  * vmbus_remove - Remove a vmbus device
 943  */
 944 static int vmbus_remove(struct device *child_device)
 945 {
 946         int ret;
 947         struct driver_context *driver_ctx;
 948
 949         /* Special case root bus device */
 950         if (child_device->parent == NULL) {
 951                 /*
 952                  * No-op since it is statically defined and handle in
 953                  * vmbus_bus_exit()
 954                  */
 955                 return 0;
 956         }
 957
 958         if (child_device->driver) {
 959                 driver_ctx = driver_to_driver_context(child_device->driver);
 960
 961                 /*
 962                  * Let the specific open-source driver handles the removal if
 963                  * it can
 964                  */
 965                 if (driver_ctx->remove) {
 966                         ret = driver_ctx->remove(child_device);
 967                 } else {
 968                         DPRINT_ERR(VMBUS_DRV,
 969                                    "remove() method not set for driver - %s",
 970                                    child_device->driver->name);
 971                         ret = -1;
 972                 }
 973         }
 974
 975         return 0;
 976 }
 977
 978 /*
 979  * vmbus_shutdown - Shutdown a vmbus device
 980  */
 981 static void vmbus_shutdown(struct device *child_device)
 982 {
 983         struct driver_context *driver_ctx;
 984
 985         /* Special case root bus device */
 986         if (child_device->parent == NULL) {
 987                 /*
 988                  * No-op since it is statically defined and handle in
 989                  * vmbus_bus_exit()
 990                  */
 991                 return;
 992         }
 993
 994         /* The device may not be attached yet */
 995         if (!child_device->driver)
 996                 return;
 997
 998         driver_ctx = driver_to_driver_context(child_device->driver);
 999
1000         /* Let the specific open-source driver handles the removal if it can */
1001         if (driver_ctx->shutdown)
1002                 driver_ctx->shutdown(child_device);
1003
1004         return;
1005 }
1006
1007 /*
1008  * vmbus_bus_release - Final callback release of the vmbus root device
1009  */
1010 static void vmbus_bus_release(struct device *device)
1011 {
1012         /* FIXME */
1013         /* Empty release functions are a bug, or a major sign
1014          * of a problem design, this MUST BE FIXED! */
1015         dev_err(device, "%s needs to be fixed!\n", __func__);
1016         WARN_ON(1);
1017 }
1018
1019 /*
1020  * vmbus_device_release - Final callback release of the vmbus child device
1021  */
1022 static void vmbus_device_release(struct device *device)
1023 {
1024         struct vm_device *device_ctx = device_to_vm_device(device);
1025
1026         kfree(device_ctx);
1027
1028         /* !!DO NOT REFERENCE device_ctx anymore at this point!! */
1029 }
1030
1031 /*
1032  * vmbus_msg_dpc - Tasklet routine to handle hypervisor messages
1033  */
1034 static void vmbus_msg_dpc(unsigned long data)
1035 {
1036         struct hv_driver *driver = (struct hv_driver *)data;
1037
1038         /* Call to bus driver to handle interrupt */
1039         vmbus_on_msg_dpc(driver);
1040 }
1041
1042 /*
1043  * vmbus_event_dpc - Tasklet routine to handle hypervisor events
1044  */
1045 static void vmbus_event_dpc(unsigned long data)
1046 {
1047         /* Call to bus driver to handle interrupt */
1048         VmbusOnEvents();
1049 }
1050
1051 static irqreturn_t vmbus_isr(int irq, void *dev_id)
1052 {
1053         struct hv_driver *driver = &g_vmbus_drv.drv_obj;
1054         int ret;
1055
1056         /* Call to bus driver to handle interrupt */
1057         ret = vmbus_on_isr(driver);
1058
1059         /* Schedules a dpc if necessary */
1060         if (ret > 0) {
1061                 if (test_bit(0, (unsigned long *)&ret))
1062                         tasklet_schedule(&g_vmbus_drv.msg_dpc);
1063
1064                 if (test_bit(1, (unsigned long *)&ret))
1065                         tasklet_schedule(&g_vmbus_drv.event_dpc);
1066
1067                 return IRQ_HANDLED;
1068         } else {
1069                 return IRQ_NONE;
1070         }
1071 }
1072
1073 static struct dmi_system_id __initdata microsoft_hv_dmi_table[] = {
1074         {
1075                 .ident = "Hyper-V",
1076                 .matches = {
1077                         DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
1078                         DMI_MATCH(DMI_PRODUCT_NAME, "Virtual Machine"),
1079                         DMI_MATCH(DMI_BOARD_NAME, "Virtual Machine"),
1080                 },
1081         },
1082         { },
1083 };
1084 MODULE_DEVICE_TABLE(dmi, microsoft_hv_dmi_table);
1085
1086 static int __init vmbus_init(void)
1087 {
1088         DPRINT_INFO(VMBUS_DRV,
1089                 "Vmbus initializing.... current log level 0x%x (%x,%x)",
1090                 vmbus_loglevel, HIWORD(vmbus_loglevel), LOWORD(vmbus_loglevel));
1091         /* Todo: it is used for loglevel, to be ported to new kernel. */
1092
1093         if (!dmi_check_system(microsoft_hv_dmi_table))
1094                 return -ENODEV;
1095
1096         return vmbus_bus_init();
1097 }
1098
1099 static void __exit vmbus_exit(void)
1100 {
1101         vmbus_bus_exit();
1102         /* Todo: it is used for loglevel, to be ported to new kernel. */
1103 }
1104
1105 /*
1106  * We use a PCI table to determine if we should autoload this driver  This is
1107  * needed by distro tools to determine if the hyperv drivers should be
1108  * installed and/or configured.  We don't do anything else with the table, but
1109  * it needs to be present.
1110  */
1111 static const struct pci_device_id microsoft_hv_pci_table[] = {
1112         { PCI_DEVICE(0x1414, 0x5353) }, /* VGA compatible controller */
1113         { 0 }
1114 };
1115 MODULE_DEVICE_TABLE(pci, microsoft_hv_pci_table);
1116
1117 MODULE_LICENSE("GPL");
1118 MODULE_VERSION(HV_DRV_VERSION);
1119 module_param(vmbus_irq, int, S_IRUGO);
1120 module_param(vmbus_loglevel, int, S_IRUGO);
1121
1122 module_init(vmbus_init);
1123 module_exit(vmbus_exit);