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                                                    void *context);
  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->context)
 138                 return;
 139
 140         vmbus_get_debug_info(device->context, &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_get_interface() - Get the vmbus channel interface.
 490  * @interface: Pointer to channel interface structure
 491  *
 492  * Get the Hyper-V channel used for the driver.
 493  *
 494  * @interface is of type &struct vmbus_channel_interface
 495  * This is invoked by child/client driver that sits above vmbus.
 496  *
 497  * Mainly used by Hyper-V drivers.
 498  */
 499 void vmbus_get_interface(struct vmbus_channel_interface *interface)
 500 {
 501         *interface = vmbus_ops;
 502 }
 503 EXPORT_SYMBOL(vmbus_get_interface);
 504
 505 /*
 506  * vmbus_child_device_create - Creates and registers a new child device
 507  * on the vmbus.
 508  */
 509 static struct hv_device *vmbus_child_device_create(struct hv_guid *type,
 510                                                    struct hv_guid *instance,
 511                                                    void *context)
 512 {
 513         struct vm_device *child_device_ctx;
 514         struct hv_device *child_device_obj;
 515
 516         /* Allocate the new child device */
 517         child_device_ctx = kzalloc(sizeof(struct vm_device), GFP_KERNEL);
 518         if (!child_device_ctx) {
 519                 DPRINT_ERR(VMBUS_DRV,
 520                         "unable to allocate device_context for child device");
 521                 return NULL;
 522         }
 523
 524         DPRINT_DBG(VMBUS_DRV, "child device (%p) allocated - "
 525                 "type {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 526                 "%02x%02x%02x%02x%02x%02x%02x%02x},"
 527                 "id {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 528                 "%02x%02x%02x%02x%02x%02x%02x%02x}",
 529                 &child_device_ctx->device,
 530                 type->data[3], type->data[2], type->data[1], type->data[0],
 531                 type->data[5], type->data[4], type->data[7], type->data[6],
 532                 type->data[8], type->data[9], type->data[10], type->data[11],
 533                 type->data[12], type->data[13], type->data[14], type->data[15],
 534                 instance->data[3], instance->data[2],
 535                 instance->data[1], instance->data[0],
 536                 instance->data[5], instance->data[4],
 537                 instance->data[7], instance->data[6],
 538                 instance->data[8], instance->data[9],
 539                 instance->data[10], instance->data[11],
 540                 instance->data[12], instance->data[13],
 541                 instance->data[14], instance->data[15]);
 542
 543         child_device_obj = &child_device_ctx->device_obj;
 544         child_device_obj->context = context;
 545         memcpy(&child_device_obj->deviceType, type, sizeof(struct hv_guid));
 546         memcpy(&child_device_obj->deviceInstance, instance,
 547                sizeof(struct hv_guid));
 548
 549         memcpy(&child_device_ctx->class_id, type, sizeof(struct hv_guid));
 550         memcpy(&child_device_ctx->device_id, instance, sizeof(struct hv_guid));
 551
 552         return child_device_obj;
 553 }
 554
 555 /*
 556  * vmbus_child_device_register - Register the child device on the specified bus
 557  */
 558 static int vmbus_child_device_register(struct hv_device *root_device_obj,
 559                                        struct hv_device *child_device_obj)
 560 {
 561         int ret = 0;
 562         struct vm_device *root_device_ctx =
 563                                 to_vm_device(root_device_obj);
 564         struct vm_device *child_device_ctx =
 565                                 to_vm_device(child_device_obj);
 566         static atomic_t device_num = ATOMIC_INIT(0);
 567
 568         DPRINT_DBG(VMBUS_DRV, "child device (%p) registering",
 569                    child_device_ctx);
 570
 571         /* Set the device name. Otherwise, device_register() will fail. */
 572         dev_set_name(&child_device_ctx->device, "vmbus_0_%d",
 573                      atomic_inc_return(&device_num));
 574
 575         /* The new device belongs to this bus */
 576         child_device_ctx->device.bus = &g_vmbus_drv.bus; /* device->dev.bus; */
 577         child_device_ctx->device.parent = &root_device_ctx->device;
 578         child_device_ctx->device.release = vmbus_device_release;
 579
 580         /*
 581          * Register with the LDM. This will kick off the driver/device
 582          * binding...which will eventually call vmbus_match() and vmbus_probe()
 583          */
 584         ret = device_register(&child_device_ctx->device);
 585
 586         /* vmbus_probe() error does not get propergate to device_register(). */
 587         ret = child_device_ctx->probe_error;
 588
 589         if (ret)
 590                 DPRINT_ERR(VMBUS_DRV, "unable to register child device (%p)",
 591                            &child_device_ctx->device);
 592         else
 593                 DPRINT_INFO(VMBUS_DRV, "child device (%p) registered",
 594                             &child_device_ctx->device);
 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_INFO(VMBUS_DRV, "unregistering child device (%p)",
 608                     &device_ctx->device);
 609
 610         /*
 611          * Kick off the process of unregistering the device.
 612          * This will call vmbus_remove() and eventually vmbus_device_release()
 613          */
 614         device_unregister(&device_ctx->device);
 615
 616         DPRINT_INFO(VMBUS_DRV, "child device (%p) unregistered",
 617                     &device_ctx->device);
 618 }
 619
 620 /*
 621  * vmbus_child_device_destroy - Destroy the specified child device on the vmbus.
 622  */
 623 static void vmbus_child_device_destroy(struct hv_device *device_obj)
 624 {
 625 }
 626
 627 /*
 628  * vmbus_uevent - add uevent for our device
 629  *
 630  * This routine is invoked when a device is added or removed on the vmbus to
 631  * generate a uevent to udev in the userspace. The udev will then look at its
 632  * rule and the uevent generated here to load the appropriate driver
 633  */
 634 static int vmbus_uevent(struct device *device, struct kobj_uevent_env *env)
 635 {
 636         struct vm_device *device_ctx = device_to_vm_device(device);
 637         int ret;
 638
 639         DPRINT_INFO(VMBUS_DRV, "generating uevent - VMBUS_DEVICE_CLASS_GUID={"
 640                     "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 641                     "%02x%02x%02x%02x%02x%02x%02x%02x}",
 642                     device_ctx->class_id.data[3], device_ctx->class_id.data[2],
 643                     device_ctx->class_id.data[1], device_ctx->class_id.data[0],
 644                     device_ctx->class_id.data[5], device_ctx->class_id.data[4],
 645                     device_ctx->class_id.data[7], device_ctx->class_id.data[6],
 646                     device_ctx->class_id.data[8], device_ctx->class_id.data[9],
 647                     device_ctx->class_id.data[10],
 648                     device_ctx->class_id.data[11],
 649                     device_ctx->class_id.data[12],
 650                     device_ctx->class_id.data[13],
 651                     device_ctx->class_id.data[14],
 652                     device_ctx->class_id.data[15]);
 653
 654         ret = add_uevent_var(env, "VMBUS_DEVICE_CLASS_GUID={"
 655                              "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 656                              "%02x%02x%02x%02x%02x%02x%02x%02x}",
 657                              device_ctx->class_id.data[3],
 658                              device_ctx->class_id.data[2],
 659                              device_ctx->class_id.data[1],
 660                              device_ctx->class_id.data[0],
 661                              device_ctx->class_id.data[5],
 662                              device_ctx->class_id.data[4],
 663                              device_ctx->class_id.data[7],
 664                              device_ctx->class_id.data[6],
 665                              device_ctx->class_id.data[8],
 666                              device_ctx->class_id.data[9],
 667                              device_ctx->class_id.data[10],
 668                              device_ctx->class_id.data[11],
 669                              device_ctx->class_id.data[12],
 670                              device_ctx->class_id.data[13],
 671                              device_ctx->class_id.data[14],
 672                              device_ctx->class_id.data[15]);
 673
 674         if (ret)
 675                 return ret;
 676
 677         ret = add_uevent_var(env, "VMBUS_DEVICE_DEVICE_GUID={"
 678                              "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 679                              "%02x%02x%02x%02x%02x%02x%02x%02x}",
 680                              device_ctx->device_id.data[3],
 681                              device_ctx->device_id.data[2],
 682                              device_ctx->device_id.data[1],
 683                              device_ctx->device_id.data[0],
 684                              device_ctx->device_id.data[5],
 685                              device_ctx->device_id.data[4],
 686                              device_ctx->device_id.data[7],
 687                              device_ctx->device_id.data[6],
 688                              device_ctx->device_id.data[8],
 689                              device_ctx->device_id.data[9],
 690                              device_ctx->device_id.data[10],
 691                              device_ctx->device_id.data[11],
 692                              device_ctx->device_id.data[12],
 693                              device_ctx->device_id.data[13],
 694                              device_ctx->device_id.data[14],
 695                              device_ctx->device_id.data[15]);
 696         if (ret)
 697                 return ret;
 698
 699         return 0;
 700 }
 701
 702 /*
 703  * vmbus_match - Attempt to match the specified device to the specified driver
 704  */
 705 static int vmbus_match(struct device *device, struct device_driver *driver)
 706 {
 707         int match = 0;
 708         struct driver_context *driver_ctx = driver_to_driver_context(driver);
 709         struct vm_device *device_ctx = device_to_vm_device(device);
 710
 711         /* We found our driver ? */
 712         if (memcmp(&device_ctx->class_id, &driver_ctx->class_id,
 713                    sizeof(struct hv_guid)) == 0) {
 714                 /*
 715                  * !! NOTE: The driver_ctx is not a vmbus_drv_ctx. We typecast
 716                  * it here to access the struct hv_driver field
 717                  */
 718                 struct vmbus_driver_context *vmbus_drv_ctx =
 719                         (struct vmbus_driver_context *)driver_ctx;
 720
 721                 device_ctx->device_obj.Driver = &vmbus_drv_ctx->drv_obj.Base;
 722                 DPRINT_INFO(VMBUS_DRV,
 723                             "device object (%p) set to driver object (%p)",
 724                             &device_ctx->device_obj,
 725                             device_ctx->device_obj.Driver);
 726
 727                 match = 1;
 728         }
 729         return match;
 730 }
 731
 732 /*
 733  * vmbus_probe_failed_cb - Callback when a driver probe failed in vmbus_probe()
 734  *
 735  * We need a callback because we cannot invoked device_unregister() inside
 736  * vmbus_probe() since vmbus_probe() may be invoked inside device_register()
 737  * i.e. we cannot call device_unregister() inside device_register()
 738  */
 739 static void vmbus_probe_failed_cb(struct work_struct *context)
 740 {
 741         struct vm_device *device_ctx = (struct vm_device *)context;
 742
 743         /*
 744          * Kick off the process of unregistering the device.
 745          * This will call vmbus_remove() and eventually vmbus_device_release()
 746          */
 747         device_unregister(&device_ctx->device);
 748
 749         /* put_device(&device_ctx->device); */
 750 }
 751
 752 /*
 753  * vmbus_probe - Add the new vmbus's child device
 754  */
 755 static int vmbus_probe(struct device *child_device)
 756 {
 757         int ret = 0;
 758         struct driver_context *driver_ctx =
 759                         driver_to_driver_context(child_device->driver);
 760         struct vm_device *device_ctx =
 761                         device_to_vm_device(child_device);
 762
 763         /* Let the specific open-source driver handles the probe if it can */
 764         if (driver_ctx->probe) {
 765                 ret = device_ctx->probe_error = driver_ctx->probe(child_device);
 766                 if (ret != 0) {
 767                         DPRINT_ERR(VMBUS_DRV, "probe() failed for device %s "
 768                                    "(%p) on driver %s (%d)...",
 769                                    dev_name(child_device), child_device,
 770                                    child_device->driver->name, ret);
 771
 772                         INIT_WORK(&device_ctx->probe_failed_work_item,
 773                                   vmbus_probe_failed_cb);
 774                         schedule_work(&device_ctx->probe_failed_work_item);
 775                 }
 776         } else {
 777                 DPRINT_ERR(VMBUS_DRV, "probe() method not set for driver - %s",
 778                            child_device->driver->name);
 779                 ret = -1;
 780         }
 781         return ret;
 782 }
 783
 784 /*
 785  * vmbus_remove - Remove a vmbus device
 786  */
 787 static int vmbus_remove(struct device *child_device)
 788 {
 789         int ret;
 790         struct driver_context *driver_ctx;
 791
 792         /* Special case root bus device */
 793         if (child_device->parent == NULL) {
 794                 /*
 795                  * No-op since it is statically defined and handle in
 796                  * vmbus_bus_exit()
 797                  */
 798                 return 0;
 799         }
 800
 801         if (child_device->driver) {
 802                 driver_ctx = driver_to_driver_context(child_device->driver);
 803
 804                 /*
 805                  * Let the specific open-source driver handles the removal if
 806                  * it can
 807                  */
 808                 if (driver_ctx->remove) {
 809                         ret = driver_ctx->remove(child_device);
 810                 } else {
 811                         DPRINT_ERR(VMBUS_DRV,
 812                                    "remove() method not set for driver - %s",
 813                                    child_device->driver->name);
 814                         ret = -1;
 815                 }
 816         }
 817
 818         return 0;
 819 }
 820
 821 /*
 822  * vmbus_shutdown - Shutdown a vmbus device
 823  */
 824 static void vmbus_shutdown(struct device *child_device)
 825 {
 826         struct driver_context *driver_ctx;
 827
 828         /* Special case root bus device */
 829         if (child_device->parent == NULL) {
 830                 /*
 831                  * No-op since it is statically defined and handle in
 832                  * vmbus_bus_exit()
 833                  */
 834                 return;
 835         }
 836
 837         /* The device may not be attached yet */
 838         if (!child_device->driver)
 839                 return;
 840
 841         driver_ctx = driver_to_driver_context(child_device->driver);
 842
 843         /* Let the specific open-source driver handles the removal if it can */
 844         if (driver_ctx->shutdown)
 845                 driver_ctx->shutdown(child_device);
 846
 847         return;
 848 }
 849
 850 /*
 851  * vmbus_bus_release - Final callback release of the vmbus root device
 852  */
 853 static void vmbus_bus_release(struct device *device)
 854 {
 855         /* FIXME */
 856         /* Empty release functions are a bug, or a major sign
 857          * of a problem design, this MUST BE FIXED! */
 858         dev_err(device, "%s needs to be fixed!\n", __func__);
 859         WARN_ON(1);
 860 }
 861
 862 /*
 863  * vmbus_device_release - Final callback release of the vmbus child device
 864  */
 865 static void vmbus_device_release(struct device *device)
 866 {
 867         struct vm_device *device_ctx = device_to_vm_device(device);
 868
 869         /* vmbus_child_device_destroy(&device_ctx->device_obj); */
 870         kfree(device_ctx);
 871
 872         /* !!DO NOT REFERENCE device_ctx anymore at this point!! */
 873 }
 874
 875 /*
 876  * vmbus_msg_dpc - Tasklet routine to handle hypervisor messages
 877  */
 878 static void vmbus_msg_dpc(unsigned long data)
 879 {
 880         struct vmbus_driver *vmbus_drv_obj = (struct vmbus_driver *)data;
 881
 882         /* ASSERT(vmbus_drv_obj->OnMsgDpc != NULL); */
 883
 884         /* Call to bus driver to handle interrupt */
 885         vmbus_drv_obj->OnMsgDpc(&vmbus_drv_obj->Base);
 886 }
 887
 888 /*
 889  * vmbus_msg_dpc - Tasklet routine to handle hypervisor events
 890  */
 891 static void vmbus_event_dpc(unsigned long data)
 892 {
 893         struct vmbus_driver *vmbus_drv_obj = (struct vmbus_driver *)data;
 894
 895         /* ASSERT(vmbus_drv_obj->OnEventDpc != NULL); */
 896
 897         /* Call to bus driver to handle interrupt */
 898         vmbus_drv_obj->OnEventDpc(&vmbus_drv_obj->Base);
 899 }
 900
 901 static irqreturn_t vmbus_isr(int irq, void *dev_id)
 902 {
 903         struct vmbus_driver *vmbus_driver_obj = &g_vmbus_drv.drv_obj;
 904         int ret;
 905
 906         /* ASSERT(vmbus_driver_obj->OnIsr != NULL); */
 907
 908         /* Call to bus driver to handle interrupt */
 909         ret = vmbus_driver_obj->OnIsr(&vmbus_driver_obj->Base);
 910
 911         /* Schedules a dpc if necessary */
 912         if (ret > 0) {
 913                 if (test_bit(0, (unsigned long *)&ret))
 914                         tasklet_schedule(&g_vmbus_drv.msg_dpc);
 915
 916                 if (test_bit(1, (unsigned long *)&ret))
 917                         tasklet_schedule(&g_vmbus_drv.event_dpc);
 918
 919                 return IRQ_HANDLED;
 920         } else {
 921                 return IRQ_NONE;
 922         }
 923 }
 924
 925 static struct dmi_system_id __initdata microsoft_hv_dmi_table[] = {
 926         {
 927                 .ident = "Hyper-V",
 928                 .matches = {
 929                         DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
 930                         DMI_MATCH(DMI_PRODUCT_NAME, "Virtual Machine"),
 931                         DMI_MATCH(DMI_BOARD_NAME, "Virtual Machine"),
 932                 },
 933         },
 934         { },
 935 };
 936 MODULE_DEVICE_TABLE(dmi, microsoft_hv_dmi_table);
 937
 938 static int __init vmbus_init(void)
 939 {
 940         DPRINT_INFO(VMBUS_DRV,
 941                 "Vmbus initializing.... current log level 0x%x (%x,%x)",
 942                 vmbus_loglevel, HIWORD(vmbus_loglevel), LOWORD(vmbus_loglevel));
 943         /* Todo: it is used for loglevel, to be ported to new kernel. */
 944
 945         if (!dmi_check_system(microsoft_hv_dmi_table))
 946                 return -ENODEV;
 947
 948         return vmbus_bus_init(VmbusInitialize);
 949 }
 950
 951 static void __exit vmbus_exit(void)
 952 {
 953         vmbus_bus_exit();
 954         /* Todo: it is used for loglevel, to be ported to new kernel. */
 955 }
 956
 957 /*
 958  * We use a PCI table to determine if we should autoload this driver  This is
 959  * needed by distro tools to determine if the hyperv drivers should be
 960  * installed and/or configured.  We don't do anything else with the table, but
 961  * it needs to be present.
 962  */
 963 static const struct pci_device_id microsoft_hv_pci_table[] = {
 964         { PCI_DEVICE(0x1414, 0x5353) }, /* VGA compatible controller */
 965         { 0 }
 966 };
 967 MODULE_DEVICE_TABLE(pci, microsoft_hv_pci_table);
 968
 969 MODULE_LICENSE("GPL");
 970 MODULE_VERSION(HV_DRV_VERSION);
 971 module_param(vmbus_irq, int, S_IRUGO);
 972 module_param(vmbus_loglevel, int, S_IRUGO);
 973
 974 module_init(vmbus_init);
 975 module_exit(vmbus_exit);