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 "version_info.h"
  31 #include "osd.h"
  32 #include "logging.h"
  33 #include "vmbus.h"
  34
  35
  36 /* FIXME! We need to do this dynamically for PIC and APIC system */
  37 #define VMBUS_IRQ               0x5
  38 #define VMBUS_IRQ_VECTOR        IRQ5_VECTOR
  39
  40 /* Main vmbus driver data structure */
  41 struct vmbus_driver_context {
  42         /* !! These must be the first 2 fields !! */
  43         /* FIXME, this is a bug */
  44         /* The driver field is not used in here. Instead, the bus field is */
  45         /* used to represent the driver */
  46         struct driver_context drv_ctx;
  47         struct vmbus_driver drv_obj;
  48
  49         struct bus_type bus;
  50         struct tasklet_struct msg_dpc;
  51         struct tasklet_struct event_dpc;
  52
  53         /* The bus root device */
  54         struct vm_device device_ctx;
  55 };
  56
  57 static int vmbus_match(struct device *device, struct device_driver *driver);
  58 static int vmbus_probe(struct device *device);
  59 static int vmbus_remove(struct device *device);
  60 static void vmbus_shutdown(struct device *device);
  61 static int vmbus_uevent(struct device *device, struct kobj_uevent_env *env);
  62 static void vmbus_msg_dpc(unsigned long data);
  63 static void vmbus_event_dpc(unsigned long data);
  64
  65 static irqreturn_t vmbus_isr(int irq, void *dev_id);
  66
  67 static void vmbus_device_release(struct device *device);
  68 static void vmbus_bus_release(struct device *device);
  69
  70 static struct hv_device *vmbus_child_device_create(struct hv_guid *type,
  71                                                    struct hv_guid *instance,
  72                                                    void *context);
  73 static void vmbus_child_device_destroy(struct hv_device *device_obj);
  74 static int vmbus_child_device_register(struct hv_device *root_device_obj,
  75                                        struct hv_device *child_device_obj);
  76 static void vmbus_child_device_unregister(struct hv_device *child_device_obj);
  77 static void vmbus_child_device_get_info(struct hv_device *device_obj,
  78                                         struct hv_device_info *device_info);
  79 static ssize_t vmbus_show_device_attr(struct device *dev,
  80                                       struct device_attribute *dev_attr,
  81                                       char *buf);
  82
  83
  84 unsigned int vmbus_loglevel = (ALL_MODULES << 16 | INFO_LVL);
  85 EXPORT_SYMBOL(vmbus_loglevel);
  86         /* (ALL_MODULES << 16 | DEBUG_LVL_ENTEREXIT); */
  87         /* (((VMBUS | VMBUS_DRV)<<16) | DEBUG_LVL_ENTEREXIT); */
  88
  89 static int vmbus_irq = VMBUS_IRQ;
  90
  91 /* Set up per device attributes in /sys/bus/vmbus/devices/<bus device> */
  92 static struct device_attribute vmbus_device_attrs[] = {
  93         __ATTR(id, S_IRUGO, vmbus_show_device_attr, NULL),
  94         __ATTR(state, S_IRUGO, vmbus_show_device_attr, NULL),
  95         __ATTR(class_id, S_IRUGO, vmbus_show_device_attr, NULL),
  96         __ATTR(device_id, S_IRUGO, vmbus_show_device_attr, NULL),
  97         __ATTR(monitor_id, S_IRUGO, vmbus_show_device_attr, NULL),
  98
  99         __ATTR(server_monitor_pending, S_IRUGO, vmbus_show_device_attr, NULL),
 100         __ATTR(server_monitor_latency, S_IRUGO, vmbus_show_device_attr, NULL),
 101         __ATTR(server_monitor_conn_id, S_IRUGO, vmbus_show_device_attr, NULL),
 102
 103         __ATTR(client_monitor_pending, S_IRUGO, vmbus_show_device_attr, NULL),
 104         __ATTR(client_monitor_latency, S_IRUGO, vmbus_show_device_attr, NULL),
 105         __ATTR(client_monitor_conn_id, S_IRUGO, vmbus_show_device_attr, NULL),
 106
 107         __ATTR(out_intr_mask, S_IRUGO, vmbus_show_device_attr, NULL),
 108         __ATTR(out_read_index, S_IRUGO, vmbus_show_device_attr, NULL),
 109         __ATTR(out_write_index, S_IRUGO, vmbus_show_device_attr, NULL),
 110         __ATTR(out_read_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
 111         __ATTR(out_write_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
 112
 113         __ATTR(in_intr_mask, S_IRUGO, vmbus_show_device_attr, NULL),
 114         __ATTR(in_read_index, S_IRUGO, vmbus_show_device_attr, NULL),
 115         __ATTR(in_write_index, S_IRUGO, vmbus_show_device_attr, NULL),
 116         __ATTR(in_read_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
 117         __ATTR(in_write_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
 118         __ATTR_NULL
 119 };
 120
 121 /* The one and only one */
 122 static struct vmbus_driver_context g_vmbus_drv = {
 123         .bus.name =             "vmbus",
 124         .bus.match =            vmbus_match,
 125         .bus.shutdown =         vmbus_shutdown,
 126         .bus.remove =           vmbus_remove,
 127         .bus.probe =            vmbus_probe,
 128         .bus.uevent =           vmbus_uevent,
 129         .bus.dev_attrs =        vmbus_device_attrs,
 130 };
 131
 132 /*
 133  * vmbus_show_device_attr - Show the device attribute in sysfs.
 134  *
 135  * This is invoked when user does a
 136  * "cat /sys/bus/vmbus/devices/<busdevice>/<attr name>"
 137  */
 138 static ssize_t vmbus_show_device_attr(struct device *dev,
 139                                       struct device_attribute *dev_attr,
 140                                       char *buf)
 141 {
 142         struct vm_device *device_ctx = device_to_vm_device(dev);
 143         struct hv_device_info device_info;
 144
 145         memset(&device_info, 0, sizeof(struct hv_device_info));
 146
 147         vmbus_child_device_get_info(&device_ctx->device_obj, &device_info);
 148
 149         if (!strcmp(dev_attr->attr.name, "class_id")) {
 150                 return sprintf(buf, "{%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 151                                "%02x%02x%02x%02x%02x%02x%02x%02x}\n",
 152                                device_info.ChannelType.data[3],
 153                                device_info.ChannelType.data[2],
 154                                device_info.ChannelType.data[1],
 155                                device_info.ChannelType.data[0],
 156                                device_info.ChannelType.data[5],
 157                                device_info.ChannelType.data[4],
 158                                device_info.ChannelType.data[7],
 159                                device_info.ChannelType.data[6],
 160                                device_info.ChannelType.data[8],
 161                                device_info.ChannelType.data[9],
 162                                device_info.ChannelType.data[10],
 163                                device_info.ChannelType.data[11],
 164                                device_info.ChannelType.data[12],
 165                                device_info.ChannelType.data[13],
 166                                device_info.ChannelType.data[14],
 167                                device_info.ChannelType.data[15]);
 168         } else if (!strcmp(dev_attr->attr.name, "device_id")) {
 169                 return sprintf(buf, "{%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 170                                "%02x%02x%02x%02x%02x%02x%02x%02x}\n",
 171                                device_info.ChannelInstance.data[3],
 172                                device_info.ChannelInstance.data[2],
 173                                device_info.ChannelInstance.data[1],
 174                                device_info.ChannelInstance.data[0],
 175                                device_info.ChannelInstance.data[5],
 176                                device_info.ChannelInstance.data[4],
 177                                device_info.ChannelInstance.data[7],
 178                                device_info.ChannelInstance.data[6],
 179                                device_info.ChannelInstance.data[8],
 180                                device_info.ChannelInstance.data[9],
 181                                device_info.ChannelInstance.data[10],
 182                                device_info.ChannelInstance.data[11],
 183                                device_info.ChannelInstance.data[12],
 184                                device_info.ChannelInstance.data[13],
 185                                device_info.ChannelInstance.data[14],
 186                                device_info.ChannelInstance.data[15]);
 187         } else if (!strcmp(dev_attr->attr.name, "state")) {
 188                 return sprintf(buf, "%d\n", device_info.ChannelState);
 189         } else if (!strcmp(dev_attr->attr.name, "id")) {
 190                 return sprintf(buf, "%d\n", device_info.ChannelId);
 191         } else if (!strcmp(dev_attr->attr.name, "out_intr_mask")) {
 192                 return sprintf(buf, "%d\n", device_info.Outbound.InterruptMask);
 193         } else if (!strcmp(dev_attr->attr.name, "out_read_index")) {
 194                 return sprintf(buf, "%d\n", device_info.Outbound.ReadIndex);
 195         } else if (!strcmp(dev_attr->attr.name, "out_write_index")) {
 196                 return sprintf(buf, "%d\n", device_info.Outbound.WriteIndex);
 197         } else if (!strcmp(dev_attr->attr.name, "out_read_bytes_avail")) {
 198                 return sprintf(buf, "%d\n",
 199                                device_info.Outbound.BytesAvailToRead);
 200         } else if (!strcmp(dev_attr->attr.name, "out_write_bytes_avail")) {
 201                 return sprintf(buf, "%d\n",
 202                                device_info.Outbound.BytesAvailToWrite);
 203         } else if (!strcmp(dev_attr->attr.name, "in_intr_mask")) {
 204                 return sprintf(buf, "%d\n", device_info.Inbound.InterruptMask);
 205         } else if (!strcmp(dev_attr->attr.name, "in_read_index")) {
 206                 return sprintf(buf, "%d\n", device_info.Inbound.ReadIndex);
 207         } else if (!strcmp(dev_attr->attr.name, "in_write_index")) {
 208                 return sprintf(buf, "%d\n", device_info.Inbound.WriteIndex);
 209         } else if (!strcmp(dev_attr->attr.name, "in_read_bytes_avail")) {
 210                 return sprintf(buf, "%d\n",
 211                                device_info.Inbound.BytesAvailToRead);
 212         } else if (!strcmp(dev_attr->attr.name, "in_write_bytes_avail")) {
 213                 return sprintf(buf, "%d\n",
 214                                device_info.Inbound.BytesAvailToWrite);
 215         } else if (!strcmp(dev_attr->attr.name, "monitor_id")) {
 216                 return sprintf(buf, "%d\n", device_info.MonitorId);
 217         } else if (!strcmp(dev_attr->attr.name, "server_monitor_pending")) {
 218                 return sprintf(buf, "%d\n", device_info.ServerMonitorPending);
 219         } else if (!strcmp(dev_attr->attr.name, "server_monitor_latency")) {
 220                 return sprintf(buf, "%d\n", device_info.ServerMonitorLatency);
 221         } else if (!strcmp(dev_attr->attr.name, "server_monitor_conn_id")) {
 222                 return sprintf(buf, "%d\n",
 223                                device_info.ServerMonitorConnectionId);
 224         } else if (!strcmp(dev_attr->attr.name, "client_monitor_pending")) {
 225                 return sprintf(buf, "%d\n", device_info.ClientMonitorPending);
 226         } else if (!strcmp(dev_attr->attr.name, "client_monitor_latency")) {
 227                 return sprintf(buf, "%d\n", device_info.ClientMonitorLatency);
 228         } else if (!strcmp(dev_attr->attr.name, "client_monitor_conn_id")) {
 229                 return sprintf(buf, "%d\n",
 230                                device_info.ClientMonitorConnectionId);
 231         } else {
 232                 return 0;
 233         }
 234 }
 235
 236 /*
 237  * vmbus_bus_init -Main vmbus driver initialization routine.
 238  *
 239  * Here, we
 240  *      - initialize the vmbus driver context
 241  *      - setup various driver entry points
 242  *      - invoke the vmbus hv main init routine
 243  *      - get the irq resource
 244  *      - invoke the vmbus to add the vmbus root device
 245  *      - setup the vmbus root device
 246  *      - retrieve the channel offers
 247  */
 248 static int vmbus_bus_init(int (*drv_init)(struct hv_driver *drv))
 249 {
 250         struct vmbus_driver_context *vmbus_drv_ctx = &g_vmbus_drv;
 251         struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
 252         struct vm_device *dev_ctx = &g_vmbus_drv.device_ctx;
 253         int ret;
 254         unsigned int vector;
 255
 256         /*
 257          * Set this up to allow lower layer to callback to add/remove child
 258          * devices on the bus
 259          */
 260         vmbus_drv_obj->OnChildDeviceCreate = vmbus_child_device_create;
 261         vmbus_drv_obj->OnChildDeviceDestroy = vmbus_child_device_destroy;
 262         vmbus_drv_obj->OnChildDeviceAdd = vmbus_child_device_register;
 263         vmbus_drv_obj->OnChildDeviceRemove = vmbus_child_device_unregister;
 264
 265         /* Call to bus driver to initialize */
 266         ret = drv_init(&vmbus_drv_obj->Base);
 267         if (ret != 0) {
 268                 DPRINT_ERR(VMBUS_DRV, "Unable to initialize vmbus (%d)", ret);
 269                 goto cleanup;
 270         }
 271
 272         /* Sanity checks */
 273         if (!vmbus_drv_obj->Base.OnDeviceAdd) {
 274                 DPRINT_ERR(VMBUS_DRV, "OnDeviceAdd() routine not set");
 275                 ret = -1;
 276                 goto cleanup;
 277         }
 278
 279         vmbus_drv_ctx->bus.name = vmbus_drv_obj->Base.name;
 280
 281         /* Initialize the bus context */
 282         tasklet_init(&vmbus_drv_ctx->msg_dpc, vmbus_msg_dpc,
 283                      (unsigned long)vmbus_drv_obj);
 284         tasklet_init(&vmbus_drv_ctx->event_dpc, vmbus_event_dpc,
 285                      (unsigned long)vmbus_drv_obj);
 286
 287         /* Now, register the bus driver with LDM */
 288         ret = bus_register(&vmbus_drv_ctx->bus);
 289         if (ret) {
 290                 ret = -1;
 291                 goto cleanup;
 292         }
 293
 294         /* Get the interrupt resource */
 295         ret = request_irq(vmbus_irq, vmbus_isr, IRQF_SAMPLE_RANDOM,
 296                           vmbus_drv_obj->Base.name, NULL);
 297
 298         if (ret != 0) {
 299                 DPRINT_ERR(VMBUS_DRV, "ERROR - Unable to request IRQ %d",
 300                            vmbus_irq);
 301
 302                 bus_unregister(&vmbus_drv_ctx->bus);
 303
 304                 ret = -1;
 305                 goto cleanup;
 306         }
 307         vector = VMBUS_IRQ_VECTOR;
 308
 309         DPRINT_INFO(VMBUS_DRV, "irq 0x%x vector 0x%x", vmbus_irq, vector);
 310
 311         /* Call to bus driver to add the root device */
 312         memset(dev_ctx, 0, sizeof(struct vm_device));
 313
 314         ret = vmbus_drv_obj->Base.OnDeviceAdd(&dev_ctx->device_obj, &vector);
 315         if (ret != 0) {
 316                 DPRINT_ERR(VMBUS_DRV,
 317                            "ERROR - Unable to add vmbus root device");
 318
 319                 free_irq(vmbus_irq, NULL);
 320
 321                 bus_unregister(&vmbus_drv_ctx->bus);
 322
 323                 ret = -1;
 324                 goto cleanup;
 325         }
 326         /* strcpy(dev_ctx->device.bus_id, dev_ctx->device_obj.name); */
 327         dev_set_name(&dev_ctx->device, "vmbus_0_0");
 328         memcpy(&dev_ctx->class_id, &dev_ctx->device_obj.deviceType,
 329                 sizeof(struct hv_guid));
 330         memcpy(&dev_ctx->device_id, &dev_ctx->device_obj.deviceInstance,
 331                 sizeof(struct hv_guid));
 332
 333         /* No need to bind a driver to the root device. */
 334         dev_ctx->device.parent = NULL;
 335         /* NULL; vmbus_remove() does not get invoked */
 336         dev_ctx->device.bus = &vmbus_drv_ctx->bus;
 337
 338         /* Setup the device dispatch table */
 339         dev_ctx->device.release = vmbus_bus_release;
 340
 341         /* Setup the bus as root device */
 342         ret = device_register(&dev_ctx->device);
 343         if (ret) {
 344                 DPRINT_ERR(VMBUS_DRV,
 345                            "ERROR - Unable to register vmbus root device");
 346
 347                 free_irq(vmbus_irq, NULL);
 348                 bus_unregister(&vmbus_drv_ctx->bus);
 349
 350                 ret = -1;
 351                 goto cleanup;
 352         }
 353
 354
 355         vmbus_drv_obj->GetChannelOffers();
 356
 357 cleanup:
 358         return ret;
 359 }
 360
 361 /*
 362  * vmbus_bus_exit - Terminate the vmbus driver.
 363  *
 364  * This routine is opposite of vmbus_bus_init()
 365  */
 366 static void vmbus_bus_exit(void)
 367 {
 368         struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
 369         struct vmbus_driver_context *vmbus_drv_ctx = &g_vmbus_drv;
 370
 371         struct vm_device *dev_ctx = &g_vmbus_drv.device_ctx;
 372
 373         /* Remove the root device */
 374         if (vmbus_drv_obj->Base.OnDeviceRemove)
 375                 vmbus_drv_obj->Base.OnDeviceRemove(&dev_ctx->device_obj);
 376
 377         if (vmbus_drv_obj->Base.OnCleanup)
 378                 vmbus_drv_obj->Base.OnCleanup(&vmbus_drv_obj->Base);
 379
 380         /* Unregister the root bus device */
 381         device_unregister(&dev_ctx->device);
 382
 383         bus_unregister(&vmbus_drv_ctx->bus);
 384
 385         free_irq(vmbus_irq, NULL);
 386
 387         tasklet_kill(&vmbus_drv_ctx->msg_dpc);
 388         tasklet_kill(&vmbus_drv_ctx->event_dpc);
 389 }
 390
 391
 392 /**
 393  * vmbus_child_driver_register() - Register a vmbus's child driver
 394  * @driver_ctx:        Pointer to driver structure you want to register
 395  *
 396  * @driver_ctx is of type &struct driver_context
 397  *
 398  * Registers the given driver with Linux through the 'driver_register()' call
 399  * And sets up the hyper-v vmbus handling for this driver.
 400  * It will return the state of the 'driver_register()' call.
 401  *
 402  * Mainly used by Hyper-V drivers.
 403  */
 404 int vmbus_child_driver_register(struct driver_context *driver_ctx)
 405 {
 406         struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
 407         int ret;
 408
 409         DPRINT_INFO(VMBUS_DRV, "child driver (%p) registering - name %s",
 410                     driver_ctx, driver_ctx->driver.name);
 411
 412         /* The child driver on this vmbus */
 413         driver_ctx->driver.bus = &g_vmbus_drv.bus;
 414
 415         ret = driver_register(&driver_ctx->driver);
 416
 417         vmbus_drv_obj->GetChannelOffers();
 418
 419         return ret;
 420 }
 421 EXPORT_SYMBOL(vmbus_child_driver_register);
 422
 423 /**
 424  * vmbus_child_driver_unregister() - Unregister a vmbus's child driver
 425  * @driver_ctx:        Pointer to driver structure you want to un-register
 426  *
 427  * @driver_ctx is of type &struct driver_context
 428  *
 429  * Un-register the given driver with Linux through the 'driver_unregister()'
 430  * call. And ungegisters the driver from the Hyper-V vmbus handler.
 431  *
 432  * Mainly used by Hyper-V drivers.
 433  */
 434 void vmbus_child_driver_unregister(struct driver_context *driver_ctx)
 435 {
 436         DPRINT_INFO(VMBUS_DRV, "child driver (%p) unregistering - name %s",
 437                     driver_ctx, driver_ctx->driver.name);
 438
 439         driver_unregister(&driver_ctx->driver);
 440
 441         driver_ctx->driver.bus = NULL;
 442 }
 443 EXPORT_SYMBOL(vmbus_child_driver_unregister);
 444
 445 /**
 446  * vmbus_get_interface() - Get the vmbus channel interface.
 447  * @interface: Pointer to channel interface structure
 448  *
 449  * Get the Hyper-V channel used for the driver.
 450  *
 451  * @interface is of type &struct vmbus_channel_interface
 452  * This is invoked by child/client driver that sits above vmbus.
 453  *
 454  * Mainly used by Hyper-V drivers.
 455  */
 456 void vmbus_get_interface(struct vmbus_channel_interface *interface)
 457 {
 458         struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
 459
 460         vmbus_drv_obj->GetChannelInterface(interface);
 461 }
 462 EXPORT_SYMBOL(vmbus_get_interface);
 463
 464 /*
 465  * vmbus_child_device_get_info - Get the vmbus child device info.
 466  *
 467  * This is invoked to display various device attributes in sysfs.
 468  */
 469 static void vmbus_child_device_get_info(struct hv_device *device_obj,
 470                                         struct hv_device_info *device_info)
 471 {
 472         struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
 473
 474         vmbus_drv_obj->GetChannelInfo(device_obj, device_info);
 475 }
 476
 477 /*
 478  * vmbus_child_device_create - Creates and registers a new child device
 479  * on the vmbus.
 480  */
 481 static struct hv_device *vmbus_child_device_create(struct hv_guid *type,
 482                                                    struct hv_guid *instance,
 483                                                    void *context)
 484 {
 485         struct vm_device *child_device_ctx;
 486         struct hv_device *child_device_obj;
 487
 488         /* Allocate the new child device */
 489         child_device_ctx = kzalloc(sizeof(struct vm_device), GFP_KERNEL);
 490         if (!child_device_ctx) {
 491                 DPRINT_ERR(VMBUS_DRV,
 492                         "unable to allocate device_context for child device");
 493                 return NULL;
 494         }
 495
 496         DPRINT_DBG(VMBUS_DRV, "child device (%p) allocated - "
 497                 "type {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 498                 "%02x%02x%02x%02x%02x%02x%02x%02x},"
 499                 "id {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 500                 "%02x%02x%02x%02x%02x%02x%02x%02x}",
 501                 &child_device_ctx->device,
 502                 type->data[3], type->data[2], type->data[1], type->data[0],
 503                 type->data[5], type->data[4], type->data[7], type->data[6],
 504                 type->data[8], type->data[9], type->data[10], type->data[11],
 505                 type->data[12], type->data[13], type->data[14], type->data[15],
 506                 instance->data[3], instance->data[2],
 507                 instance->data[1], instance->data[0],
 508                 instance->data[5], instance->data[4],
 509                 instance->data[7], instance->data[6],
 510                 instance->data[8], instance->data[9],
 511                 instance->data[10], instance->data[11],
 512                 instance->data[12], instance->data[13],
 513                 instance->data[14], instance->data[15]);
 514
 515         child_device_obj = &child_device_ctx->device_obj;
 516         child_device_obj->context = context;
 517         memcpy(&child_device_obj->deviceType, type, sizeof(struct hv_guid));
 518         memcpy(&child_device_obj->deviceInstance, instance,
 519                sizeof(struct hv_guid));
 520
 521         memcpy(&child_device_ctx->class_id, type, sizeof(struct hv_guid));
 522         memcpy(&child_device_ctx->device_id, instance, sizeof(struct hv_guid));
 523
 524         return child_device_obj;
 525 }
 526
 527 /*
 528  * vmbus_child_device_register - Register the child device on the specified bus
 529  */
 530 static int vmbus_child_device_register(struct hv_device *root_device_obj,
 531                                        struct hv_device *child_device_obj)
 532 {
 533         int ret = 0;
 534         struct vm_device *root_device_ctx =
 535                                 to_vm_device(root_device_obj);
 536         struct vm_device *child_device_ctx =
 537                                 to_vm_device(child_device_obj);
 538         static atomic_t device_num = ATOMIC_INIT(0);
 539
 540         DPRINT_DBG(VMBUS_DRV, "child device (%p) registering",
 541                    child_device_ctx);
 542
 543         /* Set the device name. Otherwise, device_register() will fail. */
 544         dev_set_name(&child_device_ctx->device, "vmbus_0_%d",
 545                      atomic_inc_return(&device_num));
 546
 547         /* The new device belongs to this bus */
 548         child_device_ctx->device.bus = &g_vmbus_drv.bus; /* device->dev.bus; */
 549         child_device_ctx->device.parent = &root_device_ctx->device;
 550         child_device_ctx->device.release = vmbus_device_release;
 551
 552         /*
 553          * Register with the LDM. This will kick off the driver/device
 554          * binding...which will eventually call vmbus_match() and vmbus_probe()
 555          */
 556         ret = device_register(&child_device_ctx->device);
 557
 558         /* vmbus_probe() error does not get propergate to device_register(). */
 559         ret = child_device_ctx->probe_error;
 560
 561         if (ret)
 562                 DPRINT_ERR(VMBUS_DRV, "unable to register child device (%p)",
 563                            &child_device_ctx->device);
 564         else
 565                 DPRINT_INFO(VMBUS_DRV, "child device (%p) registered",
 566                             &child_device_ctx->device);
 567
 568         return ret;
 569 }
 570
 571 /*
 572  * vmbus_child_device_unregister - Remove the specified child device
 573  * from the vmbus.
 574  */
 575 static void vmbus_child_device_unregister(struct hv_device *device_obj)
 576 {
 577         struct vm_device *device_ctx = to_vm_device(device_obj);
 578
 579         DPRINT_INFO(VMBUS_DRV, "unregistering child device (%p)",
 580                     &device_ctx->device);
 581
 582         /*
 583          * Kick off the process of unregistering the device.
 584          * This will call vmbus_remove() and eventually vmbus_device_release()
 585          */
 586         device_unregister(&device_ctx->device);
 587
 588         DPRINT_INFO(VMBUS_DRV, "child device (%p) unregistered",
 589                     &device_ctx->device);
 590 }
 591
 592 /*
 593  * vmbus_child_device_destroy - Destroy the specified child device on the vmbus.
 594  */
 595 static void vmbus_child_device_destroy(struct hv_device *device_obj)
 596 {
 597 }
 598
 599 /*
 600  * vmbus_uevent - add uevent for our device
 601  *
 602  * This routine is invoked when a device is added or removed on the vmbus to
 603  * generate a uevent to udev in the userspace. The udev will then look at its
 604  * rule and the uevent generated here to load the appropriate driver
 605  */
 606 static int vmbus_uevent(struct device *device, struct kobj_uevent_env *env)
 607 {
 608         struct vm_device *device_ctx = device_to_vm_device(device);
 609         int ret;
 610
 611         DPRINT_INFO(VMBUS_DRV, "generating uevent - VMBUS_DEVICE_CLASS_GUID={"
 612                     "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 613                     "%02x%02x%02x%02x%02x%02x%02x%02x}",
 614                     device_ctx->class_id.data[3], device_ctx->class_id.data[2],
 615                     device_ctx->class_id.data[1], device_ctx->class_id.data[0],
 616                     device_ctx->class_id.data[5], device_ctx->class_id.data[4],
 617                     device_ctx->class_id.data[7], device_ctx->class_id.data[6],
 618                     device_ctx->class_id.data[8], device_ctx->class_id.data[9],
 619                     device_ctx->class_id.data[10],
 620                     device_ctx->class_id.data[11],
 621                     device_ctx->class_id.data[12],
 622                     device_ctx->class_id.data[13],
 623                     device_ctx->class_id.data[14],
 624                     device_ctx->class_id.data[15]);
 625
 626         ret = add_uevent_var(env, "VMBUS_DEVICE_CLASS_GUID={"
 627                              "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 628                              "%02x%02x%02x%02x%02x%02x%02x%02x}",
 629                              device_ctx->class_id.data[3],
 630                              device_ctx->class_id.data[2],
 631                              device_ctx->class_id.data[1],
 632                              device_ctx->class_id.data[0],
 633                              device_ctx->class_id.data[5],
 634                              device_ctx->class_id.data[4],
 635                              device_ctx->class_id.data[7],
 636                              device_ctx->class_id.data[6],
 637                              device_ctx->class_id.data[8],
 638                              device_ctx->class_id.data[9],
 639                              device_ctx->class_id.data[10],
 640                              device_ctx->class_id.data[11],
 641                              device_ctx->class_id.data[12],
 642                              device_ctx->class_id.data[13],
 643                              device_ctx->class_id.data[14],
 644                              device_ctx->class_id.data[15]);
 645
 646         if (ret)
 647                 return ret;
 648
 649         ret = add_uevent_var(env, "VMBUS_DEVICE_DEVICE_GUID={"
 650                              "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 651                              "%02x%02x%02x%02x%02x%02x%02x%02x}",
 652                              device_ctx->device_id.data[3],
 653                              device_ctx->device_id.data[2],
 654                              device_ctx->device_id.data[1],
 655                              device_ctx->device_id.data[0],
 656                              device_ctx->device_id.data[5],
 657                              device_ctx->device_id.data[4],
 658                              device_ctx->device_id.data[7],
 659                              device_ctx->device_id.data[6],
 660                              device_ctx->device_id.data[8],
 661                              device_ctx->device_id.data[9],
 662                              device_ctx->device_id.data[10],
 663                              device_ctx->device_id.data[11],
 664                              device_ctx->device_id.data[12],
 665                              device_ctx->device_id.data[13],
 666                              device_ctx->device_id.data[14],
 667                              device_ctx->device_id.data[15]);
 668         if (ret)
 669                 return ret;
 670
 671         return 0;
 672 }
 673
 674 /*
 675  * vmbus_match - Attempt to match the specified device to the specified driver
 676  */
 677 static int vmbus_match(struct device *device, struct device_driver *driver)
 678 {
 679         int match = 0;
 680         struct driver_context *driver_ctx = driver_to_driver_context(driver);
 681         struct vm_device *device_ctx = device_to_vm_device(device);
 682
 683         /* We found our driver ? */
 684         if (memcmp(&device_ctx->class_id, &driver_ctx->class_id,
 685                    sizeof(struct hv_guid)) == 0) {
 686                 /*
 687                  * !! NOTE: The driver_ctx is not a vmbus_drv_ctx. We typecast
 688                  * it here to access the struct hv_driver field
 689                  */
 690                 struct vmbus_driver_context *vmbus_drv_ctx =
 691                         (struct vmbus_driver_context *)driver_ctx;
 692
 693                 device_ctx->device_obj.Driver = &vmbus_drv_ctx->drv_obj.Base;
 694                 DPRINT_INFO(VMBUS_DRV,
 695                             "device object (%p) set to driver object (%p)",
 696                             &device_ctx->device_obj,
 697                             device_ctx->device_obj.Driver);
 698
 699                 match = 1;
 700         }
 701         return match;
 702 }
 703
 704 /*
 705  * vmbus_probe_failed_cb - Callback when a driver probe failed in vmbus_probe()
 706  *
 707  * We need a callback because we cannot invoked device_unregister() inside
 708  * vmbus_probe() since vmbus_probe() may be invoked inside device_register()
 709  * i.e. we cannot call device_unregister() inside device_register()
 710  */
 711 static void vmbus_probe_failed_cb(struct work_struct *context)
 712 {
 713         struct vm_device *device_ctx = (struct vm_device *)context;
 714
 715         /*
 716          * Kick off the process of unregistering the device.
 717          * This will call vmbus_remove() and eventually vmbus_device_release()
 718          */
 719         device_unregister(&device_ctx->device);
 720
 721         /* put_device(&device_ctx->device); */
 722 }
 723
 724 /*
 725  * vmbus_probe - Add the new vmbus's child device
 726  */
 727 static int vmbus_probe(struct device *child_device)
 728 {
 729         int ret = 0;
 730         struct driver_context *driver_ctx =
 731                         driver_to_driver_context(child_device->driver);
 732         struct vm_device *device_ctx =
 733                         device_to_vm_device(child_device);
 734
 735         /* Let the specific open-source driver handles the probe if it can */
 736         if (driver_ctx->probe) {
 737                 ret = device_ctx->probe_error = driver_ctx->probe(child_device);
 738                 if (ret != 0) {
 739                         DPRINT_ERR(VMBUS_DRV, "probe() failed for device %s "
 740                                    "(%p) on driver %s (%d)...",
 741                                    dev_name(child_device), child_device,
 742                                    child_device->driver->name, ret);
 743
 744                         INIT_WORK(&device_ctx->probe_failed_work_item,
 745                                   vmbus_probe_failed_cb);
 746                         schedule_work(&device_ctx->probe_failed_work_item);
 747                 }
 748         } else {
 749                 DPRINT_ERR(VMBUS_DRV, "probe() method not set for driver - %s",
 750                            child_device->driver->name);
 751                 ret = -1;
 752         }
 753         return ret;
 754 }
 755
 756 /*
 757  * vmbus_remove - Remove a vmbus device
 758  */
 759 static int vmbus_remove(struct device *child_device)
 760 {
 761         int ret;
 762         struct driver_context *driver_ctx;
 763
 764         /* Special case root bus device */
 765         if (child_device->parent == NULL) {
 766                 /*
 767                  * No-op since it is statically defined and handle in
 768                  * vmbus_bus_exit()
 769                  */
 770                 return 0;
 771         }
 772
 773         if (child_device->driver) {
 774                 driver_ctx = driver_to_driver_context(child_device->driver);
 775
 776                 /*
 777                  * Let the specific open-source driver handles the removal if
 778                  * it can
 779                  */
 780                 if (driver_ctx->remove) {
 781                         ret = driver_ctx->remove(child_device);
 782                 } else {
 783                         DPRINT_ERR(VMBUS_DRV,
 784                                    "remove() method not set for driver - %s",
 785                                    child_device->driver->name);
 786                         ret = -1;
 787                 }
 788         }
 789
 790         return 0;
 791 }
 792
 793 /*
 794  * vmbus_shutdown - Shutdown a vmbus device
 795  */
 796 static void vmbus_shutdown(struct device *child_device)
 797 {
 798         struct driver_context *driver_ctx;
 799
 800         /* Special case root bus device */
 801         if (child_device->parent == NULL) {
 802                 /*
 803                  * No-op since it is statically defined and handle in
 804                  * vmbus_bus_exit()
 805                  */
 806                 return;
 807         }
 808
 809         /* The device may not be attached yet */
 810         if (!child_device->driver)
 811                 return;
 812
 813         driver_ctx = driver_to_driver_context(child_device->driver);
 814
 815         /* Let the specific open-source driver handles the removal if it can */
 816         if (driver_ctx->shutdown)
 817                 driver_ctx->shutdown(child_device);
 818
 819         return;
 820 }
 821
 822 /*
 823  * vmbus_bus_release - Final callback release of the vmbus root device
 824  */
 825 static void vmbus_bus_release(struct device *device)
 826 {
 827         /* FIXME */
 828         /* Empty release functions are a bug, or a major sign
 829          * of a problem design, this MUST BE FIXED! */
 830         dev_err(device, "%s needs to be fixed!\n", __func__);
 831         WARN_ON(1);
 832 }
 833
 834 /*
 835  * vmbus_device_release - Final callback release of the vmbus child device
 836  */
 837 static void vmbus_device_release(struct device *device)
 838 {
 839         struct vm_device *device_ctx = device_to_vm_device(device);
 840
 841         /* vmbus_child_device_destroy(&device_ctx->device_obj); */
 842         kfree(device_ctx);
 843
 844         /* !!DO NOT REFERENCE device_ctx anymore at this point!! */
 845 }
 846
 847 /*
 848  * vmbus_msg_dpc - Tasklet routine to handle hypervisor messages
 849  */
 850 static void vmbus_msg_dpc(unsigned long data)
 851 {
 852         struct vmbus_driver *vmbus_drv_obj = (struct vmbus_driver *)data;
 853
 854         /* ASSERT(vmbus_drv_obj->OnMsgDpc != NULL); */
 855
 856         /* Call to bus driver to handle interrupt */
 857         vmbus_drv_obj->OnMsgDpc(&vmbus_drv_obj->Base);
 858 }
 859
 860 /*
 861  * vmbus_msg_dpc - Tasklet routine to handle hypervisor events
 862  */
 863 static void vmbus_event_dpc(unsigned long data)
 864 {
 865         struct vmbus_driver *vmbus_drv_obj = (struct vmbus_driver *)data;
 866
 867         /* ASSERT(vmbus_drv_obj->OnEventDpc != NULL); */
 868
 869         /* Call to bus driver to handle interrupt */
 870         vmbus_drv_obj->OnEventDpc(&vmbus_drv_obj->Base);
 871 }
 872
 873 static irqreturn_t vmbus_isr(int irq, void *dev_id)
 874 {
 875         struct vmbus_driver *vmbus_driver_obj = &g_vmbus_drv.drv_obj;
 876         int ret;
 877
 878         /* ASSERT(vmbus_driver_obj->OnIsr != NULL); */
 879
 880         /* Call to bus driver to handle interrupt */
 881         ret = vmbus_driver_obj->OnIsr(&vmbus_driver_obj->Base);
 882
 883         /* Schedules a dpc if necessary */
 884         if (ret > 0) {
 885                 if (test_bit(0, (unsigned long *)&ret))
 886                         tasklet_schedule(&g_vmbus_drv.msg_dpc);
 887
 888                 if (test_bit(1, (unsigned long *)&ret))
 889                         tasklet_schedule(&g_vmbus_drv.event_dpc);
 890
 891                 return IRQ_HANDLED;
 892         } else {
 893                 return IRQ_NONE;
 894         }
 895 }
 896
 897 static struct dmi_system_id __initdata microsoft_hv_dmi_table[] = {
 898         {
 899                 .ident = "Hyper-V",
 900                 .matches = {
 901                         DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
 902                         DMI_MATCH(DMI_PRODUCT_NAME, "Virtual Machine"),
 903                         DMI_MATCH(DMI_BOARD_NAME, "Virtual Machine"),
 904                 },
 905         },
 906         { },
 907 };
 908 MODULE_DEVICE_TABLE(dmi, microsoft_hv_dmi_table);
 909
 910 static int __init vmbus_init(void)
 911 {
 912         DPRINT_INFO(VMBUS_DRV,
 913                 "Vmbus initializing.... current log level 0x%x (%x,%x)",
 914                 vmbus_loglevel, HIWORD(vmbus_loglevel), LOWORD(vmbus_loglevel));
 915         /* Todo: it is used for loglevel, to be ported to new kernel. */
 916
 917         if (!dmi_check_system(microsoft_hv_dmi_table))
 918                 return -ENODEV;
 919
 920         return vmbus_bus_init(VmbusInitialize);
 921 }
 922
 923 static void __exit vmbus_exit(void)
 924 {
 925         vmbus_bus_exit();
 926         /* Todo: it is used for loglevel, to be ported to new kernel. */
 927 }
 928
 929 /*
 930  * We use a PCI table to determine if we should autoload this driver  This is
 931  * needed by distro tools to determine if the hyperv drivers should be
 932  * installed and/or configured.  We don't do anything else with the table, but
 933  * it needs to be present.
 934  */
 935 static const struct pci_device_id microsoft_hv_pci_table[] = {
 936         { PCI_DEVICE(0x1414, 0x5353) }, /* VGA compatible controller */
 937         { 0 }
 938 };
 939 MODULE_DEVICE_TABLE(pci, microsoft_hv_pci_table);
 940
 941 MODULE_LICENSE("GPL");
 942 MODULE_VERSION(HV_DRV_VERSION);
 943 module_param(vmbus_irq, int, S_IRUGO);
 944 module_param(vmbus_loglevel, int, S_IRUGO);
 945
 946 module_init(vmbus_init);
 947 module_exit(vmbus_exit);