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