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