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         DPRINT_ENTER(VMBUS_DRV);
 257
 258         /*
 259          * Set this up to allow lower layer to callback to add/remove child
 260          * devices on the bus
 261          */
 262         vmbus_drv_obj->OnChildDeviceCreate = vmbus_child_device_create;
 263         vmbus_drv_obj->OnChildDeviceDestroy = vmbus_child_device_destroy;
 264         vmbus_drv_obj->OnChildDeviceAdd = vmbus_child_device_register;
 265         vmbus_drv_obj->OnChildDeviceRemove = vmbus_child_device_unregister;
 266
 267         /* Call to bus driver to initialize */
 268         ret = drv_init(&vmbus_drv_obj->Base);
 269         if (ret != 0) {
 270                 DPRINT_ERR(VMBUS_DRV, "Unable to initialize vmbus (%d)", ret);
 271                 goto cleanup;
 272         }
 273
 274         /* Sanity checks */
 275         if (!vmbus_drv_obj->Base.OnDeviceAdd) {
 276                 DPRINT_ERR(VMBUS_DRV, "OnDeviceAdd() routine not set");
 277                 ret = -1;
 278                 goto cleanup;
 279         }
 280
 281         vmbus_drv_ctx->bus.name = vmbus_drv_obj->Base.name;
 282
 283         /* Initialize the bus context */
 284         tasklet_init(&vmbus_drv_ctx->msg_dpc, vmbus_msg_dpc,
 285                      (unsigned long)vmbus_drv_obj);
 286         tasklet_init(&vmbus_drv_ctx->event_dpc, vmbus_event_dpc,
 287                      (unsigned long)vmbus_drv_obj);
 288
 289         /* Now, register the bus driver with LDM */
 290         ret = bus_register(&vmbus_drv_ctx->bus);
 291         if (ret) {
 292                 ret = -1;
 293                 goto cleanup;
 294         }
 295
 296         /* Get the interrupt resource */
 297         ret = request_irq(vmbus_irq, vmbus_isr, IRQF_SAMPLE_RANDOM,
 298                           vmbus_drv_obj->Base.name, NULL);
 299
 300         if (ret != 0) {
 301                 DPRINT_ERR(VMBUS_DRV, "ERROR - Unable to request IRQ %d",
 302                            vmbus_irq);
 303
 304                 bus_unregister(&vmbus_drv_ctx->bus);
 305
 306                 ret = -1;
 307                 goto cleanup;
 308         }
 309         vector = VMBUS_IRQ_VECTOR;
 310
 311         DPRINT_INFO(VMBUS_DRV, "irq 0x%x vector 0x%x", vmbus_irq, vector);
 312
 313         /* Call to bus driver to add the root device */
 314         memset(dev_ctx, 0, sizeof(struct vm_device));
 315
 316         ret = vmbus_drv_obj->Base.OnDeviceAdd(&dev_ctx->device_obj, &vector);
 317         if (ret != 0) {
 318                 DPRINT_ERR(VMBUS_DRV,
 319                            "ERROR - Unable to add vmbus root device");
 320
 321                 free_irq(vmbus_irq, NULL);
 322
 323                 bus_unregister(&vmbus_drv_ctx->bus);
 324
 325                 ret = -1;
 326                 goto cleanup;
 327         }
 328         /* strcpy(dev_ctx->device.bus_id, dev_ctx->device_obj.name); */
 329         dev_set_name(&dev_ctx->device, "vmbus_0_0");
 330         memcpy(&dev_ctx->class_id, &dev_ctx->device_obj.deviceType,
 331                 sizeof(struct hv_guid));
 332         memcpy(&dev_ctx->device_id, &dev_ctx->device_obj.deviceInstance,
 333                 sizeof(struct hv_guid));
 334
 335         /* No need to bind a driver to the root device. */
 336         dev_ctx->device.parent = NULL;
 337         /* NULL; vmbus_remove() does not get invoked */
 338         dev_ctx->device.bus = &vmbus_drv_ctx->bus;
 339
 340         /* Setup the device dispatch table */
 341         dev_ctx->device.release = vmbus_bus_release;
 342
 343         /* Setup the bus as root device */
 344         ret = device_register(&dev_ctx->device);
 345         if (ret) {
 346                 DPRINT_ERR(VMBUS_DRV,
 347                            "ERROR - Unable to register vmbus root device");
 348
 349                 free_irq(vmbus_irq, NULL);
 350                 bus_unregister(&vmbus_drv_ctx->bus);
 351
 352                 ret = -1;
 353                 goto cleanup;
 354         }
 355
 356
 357         vmbus_drv_obj->GetChannelOffers();
 358
 359 cleanup:
 360         DPRINT_EXIT(VMBUS_DRV);
 361
 362         return ret;
 363 }
 364
 365 /*
 366  * vmbus_bus_exit - Terminate the vmbus driver.
 367  *
 368  * This routine is opposite of vmbus_bus_init()
 369  */
 370 static void vmbus_bus_exit(void)
 371 {
 372         struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
 373         struct vmbus_driver_context *vmbus_drv_ctx = &g_vmbus_drv;
 374
 375         struct vm_device *dev_ctx = &g_vmbus_drv.device_ctx;
 376
 377         DPRINT_ENTER(VMBUS_DRV);
 378
 379         /* Remove the root device */
 380         if (vmbus_drv_obj->Base.OnDeviceRemove)
 381                 vmbus_drv_obj->Base.OnDeviceRemove(&dev_ctx->device_obj);
 382
 383         if (vmbus_drv_obj->Base.OnCleanup)
 384                 vmbus_drv_obj->Base.OnCleanup(&vmbus_drv_obj->Base);
 385
 386         /* Unregister the root bus device */
 387         device_unregister(&dev_ctx->device);
 388
 389         bus_unregister(&vmbus_drv_ctx->bus);
 390
 391         free_irq(vmbus_irq, NULL);
 392
 393         tasklet_kill(&vmbus_drv_ctx->msg_dpc);
 394         tasklet_kill(&vmbus_drv_ctx->event_dpc);
 395
 396         DPRINT_EXIT(VMBUS_DRV);
 397
 398         return;
 399 }
 400
 401
 402 /**
 403  * vmbus_child_driver_register() - Register a vmbus's child driver
 404  * @driver_ctx:        Pointer to driver structure you want to register
 405  *
 406  * @driver_ctx is of type &struct driver_context
 407  *
 408  * Registers the given driver with Linux through the 'driver_register()' call
 409  * And sets up the hyper-v vmbus handling for this driver.
 410  * It will return the state of the 'driver_register()' call.
 411  *
 412  * Mainly used by Hyper-V drivers.
 413  */
 414 int vmbus_child_driver_register(struct driver_context *driver_ctx)
 415 {
 416         struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
 417         int ret;
 418
 419         DPRINT_ENTER(VMBUS_DRV);
 420
 421         DPRINT_INFO(VMBUS_DRV, "child driver (%p) registering - name %s",
 422                     driver_ctx, driver_ctx->driver.name);
 423
 424         /* The child driver on this vmbus */
 425         driver_ctx->driver.bus = &g_vmbus_drv.bus;
 426
 427         ret = driver_register(&driver_ctx->driver);
 428
 429         vmbus_drv_obj->GetChannelOffers();
 430
 431         DPRINT_EXIT(VMBUS_DRV);
 432
 433         return ret;
 434 }
 435 EXPORT_SYMBOL(vmbus_child_driver_register);
 436
 437 /**
 438  * vmbus_child_driver_unregister() - Unregister a vmbus's child driver
 439  * @driver_ctx:        Pointer to driver structure you want to un-register
 440  *
 441  * @driver_ctx is of type &struct driver_context
 442  *
 443  * Un-register the given driver with Linux through the 'driver_unregister()'
 444  * call. And ungegisters the driver from the Hyper-V vmbus handler.
 445  *
 446  * Mainly used by Hyper-V drivers.
 447  */
 448 void vmbus_child_driver_unregister(struct driver_context *driver_ctx)
 449 {
 450         DPRINT_ENTER(VMBUS_DRV);
 451
 452         DPRINT_INFO(VMBUS_DRV, "child driver (%p) unregistering - name %s",
 453                     driver_ctx, driver_ctx->driver.name);
 454
 455         driver_unregister(&driver_ctx->driver);
 456
 457         driver_ctx->driver.bus = NULL;
 458
 459         DPRINT_EXIT(VMBUS_DRV);
 460 }
 461 EXPORT_SYMBOL(vmbus_child_driver_unregister);
 462
 463 /**
 464  * vmbus_get_interface() - Get the vmbus channel interface.
 465  * @interface: Pointer to channel interface structure
 466  *
 467  * Get the Hyper-V channel used for the driver.
 468  *
 469  * @interface is of type &struct vmbus_channel_interface
 470  * This is invoked by child/client driver that sits above vmbus.
 471  *
 472  * Mainly used by Hyper-V drivers.
 473  */
 474 void vmbus_get_interface(struct vmbus_channel_interface *interface)
 475 {
 476         struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
 477
 478         vmbus_drv_obj->GetChannelInterface(interface);
 479 }
 480 EXPORT_SYMBOL(vmbus_get_interface);
 481
 482 /*
 483  * vmbus_child_device_get_info - Get the vmbus child device info.
 484  *
 485  * This is invoked to display various device attributes in sysfs.
 486  */
 487 static void vmbus_child_device_get_info(struct hv_device *device_obj,
 488                                         struct hv_device_info *device_info)
 489 {
 490         struct vmbus_driver *vmbus_drv_obj = &g_vmbus_drv.drv_obj;
 491
 492         vmbus_drv_obj->GetChannelInfo(device_obj, device_info);
 493 }
 494
 495 /*
 496  * vmbus_child_device_create - Creates and registers a new child device
 497  * on the vmbus.
 498  */
 499 static struct hv_device *vmbus_child_device_create(struct hv_guid *type,
 500                                                    struct hv_guid *instance,
 501                                                    void *context)
 502 {
 503         struct vm_device *child_device_ctx;
 504         struct hv_device *child_device_obj;
 505
 506         DPRINT_ENTER(VMBUS_DRV);
 507
 508         /* Allocate the new child device */
 509         child_device_ctx = kzalloc(sizeof(struct vm_device), GFP_KERNEL);
 510         if (!child_device_ctx) {
 511                 DPRINT_ERR(VMBUS_DRV,
 512                         "unable to allocate device_context for child device");
 513                 DPRINT_EXIT(VMBUS_DRV);
 514
 515                 return NULL;
 516         }
 517
 518         DPRINT_DBG(VMBUS_DRV, "child device (%p) allocated - "
 519                 "type {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 520                 "%02x%02x%02x%02x%02x%02x%02x%02x},"
 521                 "id {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 522                 "%02x%02x%02x%02x%02x%02x%02x%02x}",
 523                 &child_device_ctx->device,
 524                 type->data[3], type->data[2], type->data[1], type->data[0],
 525                 type->data[5], type->data[4], type->data[7], type->data[6],
 526                 type->data[8], type->data[9], type->data[10], type->data[11],
 527                 type->data[12], type->data[13], type->data[14], type->data[15],
 528                 instance->data[3], instance->data[2],
 529                 instance->data[1], instance->data[0],
 530                 instance->data[5], instance->data[4],
 531                 instance->data[7], instance->data[6],
 532                 instance->data[8], instance->data[9],
 533                 instance->data[10], instance->data[11],
 534                 instance->data[12], instance->data[13],
 535                 instance->data[14], instance->data[15]);
 536
 537         child_device_obj = &child_device_ctx->device_obj;
 538         child_device_obj->context = context;
 539         memcpy(&child_device_obj->deviceType, type, sizeof(struct hv_guid));
 540         memcpy(&child_device_obj->deviceInstance, instance,
 541                sizeof(struct hv_guid));
 542
 543         memcpy(&child_device_ctx->class_id, type, sizeof(struct hv_guid));
 544         memcpy(&child_device_ctx->device_id, instance, sizeof(struct hv_guid));
 545
 546         DPRINT_EXIT(VMBUS_DRV);
 547
 548         return child_device_obj;
 549 }
 550
 551 /*
 552  * vmbus_child_device_register - Register the child device on the specified bus
 553  */
 554 static int vmbus_child_device_register(struct hv_device *root_device_obj,
 555                                        struct hv_device *child_device_obj)
 556 {
 557         int ret = 0;
 558         struct vm_device *root_device_ctx =
 559                                 to_vm_device(root_device_obj);
 560         struct vm_device *child_device_ctx =
 561                                 to_vm_device(child_device_obj);
 562         static atomic_t device_num = ATOMIC_INIT(0);
 563
 564         DPRINT_ENTER(VMBUS_DRV);
 565
 566         DPRINT_DBG(VMBUS_DRV, "child device (%p) registering",
 567                    child_device_ctx);
 568
 569         /* Set the device name. Otherwise, device_register() will fail. */
 570         dev_set_name(&child_device_ctx->device, "vmbus_0_%d",
 571                      atomic_inc_return(&device_num));
 572
 573         /* The new device belongs to this bus */
 574         child_device_ctx->device.bus = &g_vmbus_drv.bus; /* device->dev.bus; */
 575         child_device_ctx->device.parent = &root_device_ctx->device;
 576         child_device_ctx->device.release = vmbus_device_release;
 577
 578         /*
 579          * Register with the LDM. This will kick off the driver/device
 580          * binding...which will eventually call vmbus_match() and vmbus_probe()
 581          */
 582         ret = device_register(&child_device_ctx->device);
 583
 584         /* vmbus_probe() error does not get propergate to device_register(). */
 585         ret = child_device_ctx->probe_error;
 586
 587         if (ret)
 588                 DPRINT_ERR(VMBUS_DRV, "unable to register child device (%p)",
 589                            &child_device_ctx->device);
 590         else
 591                 DPRINT_INFO(VMBUS_DRV, "child device (%p) registered",
 592                             &child_device_ctx->device);
 593
 594         DPRINT_EXIT(VMBUS_DRV);
 595
 596         return ret;
 597 }
 598
 599 /*
 600  * vmbus_child_device_unregister - Remove the specified child device
 601  * from the vmbus.
 602  */
 603 static void vmbus_child_device_unregister(struct hv_device *device_obj)
 604 {
 605         struct vm_device *device_ctx = to_vm_device(device_obj);
 606
 607         DPRINT_ENTER(VMBUS_DRV);
 608
 609         DPRINT_INFO(VMBUS_DRV, "unregistering child device (%p)",
 610                     &device_ctx->device);
 611
 612         /*
 613          * Kick off the process of unregistering the device.
 614          * This will call vmbus_remove() and eventually vmbus_device_release()
 615          */
 616         device_unregister(&device_ctx->device);
 617
 618         DPRINT_INFO(VMBUS_DRV, "child device (%p) unregistered",
 619                     &device_ctx->device);
 620
 621         DPRINT_EXIT(VMBUS_DRV);
 622 }
 623
 624 /*
 625  * vmbus_child_device_destroy - Destroy the specified child device on the vmbus.
 626  */
 627 static void vmbus_child_device_destroy(struct hv_device *device_obj)
 628 {
 629         DPRINT_ENTER(VMBUS_DRV);
 630
 631         DPRINT_EXIT(VMBUS_DRV);
 632 }
 633
 634 /*
 635  * vmbus_uevent - add uevent for our device
 636  *
 637  * This routine is invoked when a device is added or removed on the vmbus to
 638  * generate a uevent to udev in the userspace. The udev will then look at its
 639  * rule and the uevent generated here to load the appropriate driver
 640  */
 641 static int vmbus_uevent(struct device *device, struct kobj_uevent_env *env)
 642 {
 643         struct vm_device *device_ctx = device_to_vm_device(device);
 644         int ret;
 645
 646         DPRINT_ENTER(VMBUS_DRV);
 647
 648         DPRINT_INFO(VMBUS_DRV, "generating uevent - VMBUS_DEVICE_CLASS_GUID={"
 649                     "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 650                     "%02x%02x%02x%02x%02x%02x%02x%02x}",
 651                     device_ctx->class_id.data[3], device_ctx->class_id.data[2],
 652                     device_ctx->class_id.data[1], device_ctx->class_id.data[0],
 653                     device_ctx->class_id.data[5], device_ctx->class_id.data[4],
 654                     device_ctx->class_id.data[7], device_ctx->class_id.data[6],
 655                     device_ctx->class_id.data[8], device_ctx->class_id.data[9],
 656                     device_ctx->class_id.data[10],
 657                     device_ctx->class_id.data[11],
 658                     device_ctx->class_id.data[12],
 659                     device_ctx->class_id.data[13],
 660                     device_ctx->class_id.data[14],
 661                     device_ctx->class_id.data[15]);
 662
 663         ret = add_uevent_var(env, "VMBUS_DEVICE_CLASS_GUID={"
 664                              "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 665                              "%02x%02x%02x%02x%02x%02x%02x%02x}",
 666                              device_ctx->class_id.data[3],
 667                              device_ctx->class_id.data[2],
 668                              device_ctx->class_id.data[1],
 669                              device_ctx->class_id.data[0],
 670                              device_ctx->class_id.data[5],
 671                              device_ctx->class_id.data[4],
 672                              device_ctx->class_id.data[7],
 673                              device_ctx->class_id.data[6],
 674                              device_ctx->class_id.data[8],
 675                              device_ctx->class_id.data[9],
 676                              device_ctx->class_id.data[10],
 677                              device_ctx->class_id.data[11],
 678                              device_ctx->class_id.data[12],
 679                              device_ctx->class_id.data[13],
 680                              device_ctx->class_id.data[14],
 681                              device_ctx->class_id.data[15]);
 682
 683         if (ret)
 684                 return ret;
 685
 686         ret = add_uevent_var(env, "VMBUS_DEVICE_DEVICE_GUID={"
 687                              "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 688                              "%02x%02x%02x%02x%02x%02x%02x%02x}",
 689                              device_ctx->device_id.data[3],
 690                              device_ctx->device_id.data[2],
 691                              device_ctx->device_id.data[1],
 692                              device_ctx->device_id.data[0],
 693                              device_ctx->device_id.data[5],
 694                              device_ctx->device_id.data[4],
 695                              device_ctx->device_id.data[7],
 696                              device_ctx->device_id.data[6],
 697                              device_ctx->device_id.data[8],
 698                              device_ctx->device_id.data[9],
 699                              device_ctx->device_id.data[10],
 700                              device_ctx->device_id.data[11],
 701                              device_ctx->device_id.data[12],
 702                              device_ctx->device_id.data[13],
 703                              device_ctx->device_id.data[14],
 704                              device_ctx->device_id.data[15]);
 705         if (ret)
 706                 return ret;
 707
 708         DPRINT_EXIT(VMBUS_DRV);
 709
 710         return 0;
 711 }
 712
 713 /*
 714  * vmbus_match - Attempt to match the specified device to the specified driver
 715  */
 716 static int vmbus_match(struct device *device, struct device_driver *driver)
 717 {
 718         int match = 0;
 719         struct driver_context *driver_ctx = driver_to_driver_context(driver);
 720         struct vm_device *device_ctx = device_to_vm_device(device);
 721
 722         DPRINT_ENTER(VMBUS_DRV);
 723
 724         /* We found our driver ? */
 725         if (memcmp(&device_ctx->class_id, &driver_ctx->class_id,
 726                    sizeof(struct hv_guid)) == 0) {
 727                 /*
 728                  * !! NOTE: The driver_ctx is not a vmbus_drv_ctx. We typecast
 729                  * it here to access the struct hv_driver field
 730                  */
 731                 struct vmbus_driver_context *vmbus_drv_ctx =
 732                         (struct vmbus_driver_context *)driver_ctx;
 733
 734                 device_ctx->device_obj.Driver = &vmbus_drv_ctx->drv_obj.Base;
 735                 DPRINT_INFO(VMBUS_DRV,
 736                             "device object (%p) set to driver object (%p)",
 737                             &device_ctx->device_obj,
 738                             device_ctx->device_obj.Driver);
 739
 740                 match = 1;
 741         }
 742
 743         DPRINT_EXIT(VMBUS_DRV);
 744
 745         return match;
 746 }
 747
 748 /*
 749  * vmbus_probe_failed_cb - Callback when a driver probe failed in vmbus_probe()
 750  *
 751  * We need a callback because we cannot invoked device_unregister() inside
 752  * vmbus_probe() since vmbus_probe() may be invoked inside device_register()
 753  * i.e. we cannot call device_unregister() inside device_register()
 754  */
 755 static void vmbus_probe_failed_cb(struct work_struct *context)
 756 {
 757         struct vm_device *device_ctx = (struct vm_device *)context;
 758
 759         DPRINT_ENTER(VMBUS_DRV);
 760
 761         /*
 762          * Kick off the process of unregistering the device.
 763          * This will call vmbus_remove() and eventually vmbus_device_release()
 764          */
 765         device_unregister(&device_ctx->device);
 766
 767         /* put_device(&device_ctx->device); */
 768         DPRINT_EXIT(VMBUS_DRV);
 769 }
 770
 771 /*
 772  * vmbus_probe - Add the new vmbus's child device
 773  */
 774 static int vmbus_probe(struct device *child_device)
 775 {
 776         int ret = 0;
 777         struct driver_context *driver_ctx =
 778                         driver_to_driver_context(child_device->driver);
 779         struct vm_device *device_ctx =
 780                         device_to_vm_device(child_device);
 781
 782         DPRINT_ENTER(VMBUS_DRV);
 783
 784         /* Let the specific open-source driver handles the probe if it can */
 785         if (driver_ctx->probe) {
 786                 ret = device_ctx->probe_error = driver_ctx->probe(child_device);
 787                 if (ret != 0) {
 788                         DPRINT_ERR(VMBUS_DRV, "probe() failed for device %s "
 789                                    "(%p) on driver %s (%d)...",
 790                                    dev_name(child_device), child_device,
 791                                    child_device->driver->name, ret);
 792
 793                         INIT_WORK(&device_ctx->probe_failed_work_item,
 794                                   vmbus_probe_failed_cb);
 795                         schedule_work(&device_ctx->probe_failed_work_item);
 796                 }
 797         } else {
 798                 DPRINT_ERR(VMBUS_DRV, "probe() method not set for driver - %s",
 799                            child_device->driver->name);
 800                 ret = -1;
 801         }
 802
 803         DPRINT_EXIT(VMBUS_DRV);
 804         return ret;
 805 }
 806
 807 /*
 808  * vmbus_remove - Remove a vmbus device
 809  */
 810 static int vmbus_remove(struct device *child_device)
 811 {
 812         int ret;
 813         struct driver_context *driver_ctx;
 814
 815         DPRINT_ENTER(VMBUS_DRV);
 816
 817         /* Special case root bus device */
 818         if (child_device->parent == NULL) {
 819                 /*
 820                  * No-op since it is statically defined and handle in
 821                  * vmbus_bus_exit()
 822                  */
 823                 DPRINT_EXIT(VMBUS_DRV);
 824                 return 0;
 825         }
 826
 827         if (child_device->driver) {
 828                 driver_ctx = driver_to_driver_context(child_device->driver);
 829
 830                 /*
 831                  * Let the specific open-source driver handles the removal if
 832                  * it can
 833                  */
 834                 if (driver_ctx->remove) {
 835                         ret = driver_ctx->remove(child_device);
 836                 } else {
 837                         DPRINT_ERR(VMBUS_DRV,
 838                                    "remove() method not set for driver - %s",
 839                                    child_device->driver->name);
 840                         ret = -1;
 841                 }
 842         }
 843
 844         DPRINT_EXIT(VMBUS_DRV);
 845
 846         return 0;
 847 }
 848
 849 /*
 850  * vmbus_shutdown - Shutdown a vmbus device
 851  */
 852 static void vmbus_shutdown(struct device *child_device)
 853 {
 854         struct driver_context *driver_ctx;
 855
 856         DPRINT_ENTER(VMBUS_DRV);
 857
 858         /* Special case root bus device */
 859         if (child_device->parent == NULL) {
 860                 /*
 861                  * No-op since it is statically defined and handle in
 862                  * vmbus_bus_exit()
 863                  */
 864                 DPRINT_EXIT(VMBUS_DRV);
 865                 return;
 866         }
 867
 868         /* The device may not be attached yet */
 869         if (!child_device->driver) {
 870                 DPRINT_EXIT(VMBUS_DRV);
 871                 return;
 872         }
 873
 874         driver_ctx = driver_to_driver_context(child_device->driver);
 875
 876         /* Let the specific open-source driver handles the removal if it can */
 877         if (driver_ctx->shutdown)
 878                 driver_ctx->shutdown(child_device);
 879
 880         DPRINT_EXIT(VMBUS_DRV);
 881
 882         return;
 883 }
 884
 885 /*
 886  * vmbus_bus_release - Final callback release of the vmbus root device
 887  */
 888 static void vmbus_bus_release(struct device *device)
 889 {
 890         DPRINT_ENTER(VMBUS_DRV);
 891         /* FIXME */
 892         /* Empty release functions are a bug, or a major sign
 893          * of a problem design, this MUST BE FIXED! */
 894         dev_err(device, "%s needs to be fixed!\n", __func__);
 895         WARN_ON(1);
 896         DPRINT_EXIT(VMBUS_DRV);
 897 }
 898
 899 /*
 900  * vmbus_device_release - Final callback release of the vmbus child device
 901  */
 902 static void vmbus_device_release(struct device *device)
 903 {
 904         struct vm_device *device_ctx = device_to_vm_device(device);
 905
 906         DPRINT_ENTER(VMBUS_DRV);
 907
 908         /* vmbus_child_device_destroy(&device_ctx->device_obj); */
 909         kfree(device_ctx);
 910
 911         /* !!DO NOT REFERENCE device_ctx anymore at this point!! */
 912         DPRINT_EXIT(VMBUS_DRV);
 913
 914         return;
 915 }
 916
 917 /*
 918  * vmbus_msg_dpc - Tasklet routine to handle hypervisor messages
 919  */
 920 static void vmbus_msg_dpc(unsigned long data)
 921 {
 922         struct vmbus_driver *vmbus_drv_obj = (struct vmbus_driver *)data;
 923
 924         DPRINT_ENTER(VMBUS_DRV);
 925
 926         /* ASSERT(vmbus_drv_obj->OnMsgDpc != NULL); */
 927
 928         /* Call to bus driver to handle interrupt */
 929         vmbus_drv_obj->OnMsgDpc(&vmbus_drv_obj->Base);
 930
 931         DPRINT_EXIT(VMBUS_DRV);
 932 }
 933
 934 /*
 935  * vmbus_msg_dpc - Tasklet routine to handle hypervisor events
 936  */
 937 static void vmbus_event_dpc(unsigned long data)
 938 {
 939         struct vmbus_driver *vmbus_drv_obj = (struct vmbus_driver *)data;
 940
 941         DPRINT_ENTER(VMBUS_DRV);
 942
 943         /* ASSERT(vmbus_drv_obj->OnEventDpc != NULL); */
 944
 945         /* Call to bus driver to handle interrupt */
 946         vmbus_drv_obj->OnEventDpc(&vmbus_drv_obj->Base);
 947
 948         DPRINT_EXIT(VMBUS_DRV);
 949 }
 950
 951 static irqreturn_t vmbus_isr(int irq, void *dev_id)
 952 {
 953         struct vmbus_driver *vmbus_driver_obj = &g_vmbus_drv.drv_obj;
 954         int ret;
 955
 956         DPRINT_ENTER(VMBUS_DRV);
 957
 958         /* ASSERT(vmbus_driver_obj->OnIsr != NULL); */
 959
 960         /* Call to bus driver to handle interrupt */
 961         ret = vmbus_driver_obj->OnIsr(&vmbus_driver_obj->Base);
 962
 963         /* Schedules a dpc if necessary */
 964         if (ret > 0) {
 965                 if (test_bit(0, (unsigned long *)&ret))
 966                         tasklet_schedule(&g_vmbus_drv.msg_dpc);
 967
 968                 if (test_bit(1, (unsigned long *)&ret))
 969                         tasklet_schedule(&g_vmbus_drv.event_dpc);
 970
 971                 DPRINT_EXIT(VMBUS_DRV);
 972                 return IRQ_HANDLED;
 973         } else {
 974                 DPRINT_EXIT(VMBUS_DRV);
 975                 return IRQ_NONE;
 976         }
 977 }
 978
 979 static struct dmi_system_id __initdata microsoft_hv_dmi_table[] = {
 980         {
 981                 .ident = "Hyper-V",
 982                 .matches = {
 983                         DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
 984                         DMI_MATCH(DMI_PRODUCT_NAME, "Virtual Machine"),
 985                         DMI_MATCH(DMI_BOARD_NAME, "Virtual Machine"),
 986                 },
 987         },
 988         { },
 989 };
 990 MODULE_DEVICE_TABLE(dmi, microsoft_hv_dmi_table);
 991
 992 static int __init vmbus_init(void)
 993 {
 994         int ret = 0;
 995
 996         DPRINT_ENTER(VMBUS_DRV);
 997
 998         DPRINT_INFO(VMBUS_DRV,
 999                 "Vmbus initializing.... current log level 0x%x (%x,%x)",
1000                 vmbus_loglevel, HIWORD(vmbus_loglevel), LOWORD(vmbus_loglevel));
1001         /* Todo: it is used for loglevel, to be ported to new kernel. */
1002
1003         if (!dmi_check_system(microsoft_hv_dmi_table))
1004                 return -ENODEV;
1005
1006         ret = vmbus_bus_init(VmbusInitialize);
1007
1008         DPRINT_EXIT(VMBUS_DRV);
1009         return ret;
1010 }
1011
1012 static void __exit vmbus_exit(void)
1013 {
1014         DPRINT_ENTER(VMBUS_DRV);
1015
1016         vmbus_bus_exit();
1017         /* Todo: it is used for loglevel, to be ported to new kernel. */
1018         DPRINT_EXIT(VMBUS_DRV);
1019         return;
1020 }
1021
1022 /*
1023  * We use a PCI table to determine if we should autoload this driver  This is
1024  * needed by distro tools to determine if the hyperv drivers should be
1025  * installed and/or configured.  We don't do anything else with the table, but
1026  * it needs to be present.
1027  */
1028 const static struct pci_device_id microsoft_hv_pci_table[] = {
1029         { PCI_DEVICE(0x1414, 0x5353) }, /* VGA compatible controller */
1030         { 0 }
1031 };
1032 MODULE_DEVICE_TABLE(pci, microsoft_hv_pci_table);
1033
1034 MODULE_LICENSE("GPL");
1035 MODULE_VERSION(HV_DRV_VERSION);
1036 module_param(vmbus_irq, int, S_IRUGO);
1037 module_param(vmbus_loglevel, int, S_IRUGO);
1038
1039 module_init(vmbus_init);
1040 module_exit(vmbus_exit);