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 "hv_api.h"
  33 #include "logging.h"
  34 #include "vmbus.h"
  35 #include "channel.h"
  36 #include "vmbus_private.h"
  37
  38
  39 /* FIXME! We need to do this dynamically for PIC and APIC system */
  40 #define VMBUS_IRQ               0x5
  41 #define VMBUS_IRQ_VECTOR        IRQ5_VECTOR
  42
  43 /* Main vmbus driver data structure */
  44 struct vmbus_driver_context {
  45
  46         struct bus_type bus;
  47         struct tasklet_struct msg_dpc;
  48         struct tasklet_struct event_dpc;
  49
  50         /* The bus root device */
  51         struct hv_device device_ctx;
  52 };
  53
  54 static int vmbus_match(struct device *device, struct device_driver *driver);
  55 static int vmbus_probe(struct device *device);
  56 static int vmbus_remove(struct device *device);
  57 static void vmbus_shutdown(struct device *device);
  58 static int vmbus_uevent(struct device *device, struct kobj_uevent_env *env);
  59 static void vmbus_event_dpc(unsigned long data);
  60
  61 static irqreturn_t vmbus_isr(int irq, void *dev_id);
  62
  63 static void vmbus_device_release(struct device *device);
  64 static void vmbus_bus_release(struct device *device);
  65
  66 static ssize_t vmbus_show_device_attr(struct device *dev,
  67                                       struct device_attribute *dev_attr,
  68                                       char *buf);
  69
  70
  71 unsigned int vmbus_loglevel = (ALL_MODULES << 16 | INFO_LVL);
  72 EXPORT_SYMBOL(vmbus_loglevel);
  73         /* (ALL_MODULES << 16 | DEBUG_LVL_ENTEREXIT); */
  74         /* (((VMBUS | VMBUS_DRV)<<16) | DEBUG_LVL_ENTEREXIT); */
  75
  76 static int vmbus_irq = VMBUS_IRQ;
  77
  78 /* Set up per device attributes in /sys/bus/vmbus/devices/<bus device> */
  79 static struct device_attribute vmbus_device_attrs[] = {
  80         __ATTR(id, S_IRUGO, vmbus_show_device_attr, NULL),
  81         __ATTR(state, S_IRUGO, vmbus_show_device_attr, NULL),
  82         __ATTR(class_id, S_IRUGO, vmbus_show_device_attr, NULL),
  83         __ATTR(device_id, S_IRUGO, vmbus_show_device_attr, NULL),
  84         __ATTR(monitor_id, S_IRUGO, vmbus_show_device_attr, NULL),
  85
  86         __ATTR(server_monitor_pending, S_IRUGO, vmbus_show_device_attr, NULL),
  87         __ATTR(server_monitor_latency, S_IRUGO, vmbus_show_device_attr, NULL),
  88         __ATTR(server_monitor_conn_id, S_IRUGO, vmbus_show_device_attr, NULL),
  89
  90         __ATTR(client_monitor_pending, S_IRUGO, vmbus_show_device_attr, NULL),
  91         __ATTR(client_monitor_latency, S_IRUGO, vmbus_show_device_attr, NULL),
  92         __ATTR(client_monitor_conn_id, S_IRUGO, vmbus_show_device_attr, NULL),
  93
  94         __ATTR(out_intr_mask, S_IRUGO, vmbus_show_device_attr, NULL),
  95         __ATTR(out_read_index, S_IRUGO, vmbus_show_device_attr, NULL),
  96         __ATTR(out_write_index, S_IRUGO, vmbus_show_device_attr, NULL),
  97         __ATTR(out_read_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
  98         __ATTR(out_write_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
  99
 100         __ATTR(in_intr_mask, S_IRUGO, vmbus_show_device_attr, NULL),
 101         __ATTR(in_read_index, S_IRUGO, vmbus_show_device_attr, NULL),
 102         __ATTR(in_write_index, S_IRUGO, vmbus_show_device_attr, NULL),
 103         __ATTR(in_read_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
 104         __ATTR(in_write_bytes_avail, S_IRUGO, vmbus_show_device_attr, NULL),
 105         __ATTR_NULL
 106 };
 107
 108 /* The one and only one */
 109 static struct vmbus_driver_context vmbus_drv = {
 110         .bus.name =             "vmbus",
 111         .bus.match =            vmbus_match,
 112         .bus.shutdown =         vmbus_shutdown,
 113         .bus.remove =           vmbus_remove,
 114         .bus.probe =            vmbus_probe,
 115         .bus.uevent =           vmbus_uevent,
 116         .bus.dev_attrs =        vmbus_device_attrs,
 117 };
 118
 119 static const char *driver_name = "hyperv";
 120
 121 /*
 122  * Windows vmbus does not defined this.
 123  * We defined this to be consistent with other devices
 124  */
 125 /* {c5295816-f63a-4d5f-8d1a-4daf999ca185} */
 126 static const struct hv_guid device_type = {
 127         .data = {
 128                 0x16, 0x58, 0x29, 0xc5, 0x3a, 0xf6, 0x5f, 0x4d,
 129                 0x8d, 0x1a, 0x4d, 0xaf, 0x99, 0x9c, 0xa1, 0x85
 130         }
 131 };
 132
 133 /* {ac3760fc-9adf-40aa-9427-a70ed6de95c5} */
 134 static const struct hv_guid device_id = {
 135         .data = {
 136                 0xfc, 0x60, 0x37, 0xac, 0xdf, 0x9a, 0xaa, 0x40,
 137                 0x94, 0x27, 0xa7, 0x0e, 0xd6, 0xde, 0x95, 0xc5
 138         }
 139 };
 140
 141 static struct hv_device *vmbus_device; /* vmbus root device */
 142
 143 /*
 144  * vmbus_child_dev_add - Registers the child device with the vmbus
 145  */
 146 int vmbus_child_dev_add(struct hv_device *child_dev)
 147 {
 148         return vmbus_child_device_register(vmbus_device, child_dev);
 149 }
 150
 151 /*
 152  * vmbus_dev_add - Callback when the root bus device is added
 153  */
 154 static int vmbus_dev_add(struct hv_device *dev, void *info)
 155 {
 156         u32 *irqvector = info;
 157         int ret;
 158
 159         vmbus_device = dev;
 160
 161         memcpy(&vmbus_device->dev_type, &device_type, sizeof(struct hv_guid));
 162         memcpy(&vmbus_device->dev_instance, &device_id,
 163                sizeof(struct hv_guid));
 164
 165         /* strcpy(dev->name, "vmbus"); */
 166         /* SynIC setup... */
 167         on_each_cpu(hv_synic_init, (void *)irqvector, 1);
 168
 169         /* Connect to VMBus in the root partition */
 170         ret = vmbus_connect();
 171
 172         /* VmbusSendEvent(device->localPortId+1); */
 173         return ret;
 174 }
 175
 176 /*
 177  * vmbus_dev_rm - Callback when the root bus device is removed
 178  */
 179 static int vmbus_dev_rm(struct hv_device *dev)
 180 {
 181         int ret = 0;
 182
 183         vmbus_release_unattached_channels();
 184         vmbus_disconnect();
 185         on_each_cpu(hv_synic_cleanup, NULL, 1);
 186         return ret;
 187 }
 188
 189 /*
 190  * vmbus_cleanup - Perform any cleanup when the driver is removed
 191  */
 192 static void vmbus_cleanup(void)
 193 {
 194
 195         hv_cleanup();
 196 }
 197
 198 struct onmessage_work_context {
 199         struct work_struct work;
 200         struct hv_message msg;
 201 };
 202
 203 static void vmbus_onmessage_work(struct work_struct *work)
 204 {
 205         struct onmessage_work_context *ctx;
 206
 207         ctx = container_of(work, struct onmessage_work_context,
 208                            work);
 209         vmbus_onmessage(&ctx->msg);
 210         kfree(ctx);
 211 }
 212
 213 /*
 214  * vmbus_on_msg_dpc - DPC routine to handle messages from the hypervisior
 215  */
 216 static void vmbus_on_msg_dpc(unsigned long data)
 217 {
 218         int cpu = smp_processor_id();
 219         void *page_addr = hv_context.synic_message_page[cpu];
 220         struct hv_message *msg = (struct hv_message *)page_addr +
 221                                   VMBUS_MESSAGE_SINT;
 222         struct onmessage_work_context *ctx;
 223
 224         while (1) {
 225                 if (msg->header.message_type == HVMSG_NONE) {
 226                         /* no msg */
 227                         break;
 228                 } else {
 229                         ctx = kmalloc(sizeof(*ctx), GFP_ATOMIC);
 230                         if (ctx == NULL)
 231                                 continue;
 232                         INIT_WORK(&ctx->work, vmbus_onmessage_work);
 233                         memcpy(&ctx->msg, msg, sizeof(*msg));
 234                         queue_work(vmbus_connection.work_queue, &ctx->work);
 235                 }
 236
 237                 msg->header.message_type = HVMSG_NONE;
 238
 239                 /*
 240                  * Make sure the write to MessageType (ie set to
 241                  * HVMSG_NONE) happens before we read the
 242                  * MessagePending and EOMing. Otherwise, the EOMing
 243                  * will not deliver any more messages since there is
 244                  * no empty slot
 245                  */
 246                 mb();
 247
 248                 if (msg->header.message_flags.msg_pending) {
 249                         /*
 250                          * This will cause message queue rescan to
 251                          * possibly deliver another msg from the
 252                          * hypervisor
 253                          */
 254                         wrmsrl(HV_X64_MSR_EOM, 0);
 255                 }
 256         }
 257 }
 258
 259 /*
 260  * vmbus_on_isr - ISR routine
 261  */
 262 static int vmbus_on_isr(struct hv_driver *drv)
 263 {
 264         int ret = 0;
 265         int cpu = smp_processor_id();
 266         void *page_addr;
 267         struct hv_message *msg;
 268         union hv_synic_event_flags *event;
 269
 270         page_addr = hv_context.synic_message_page[cpu];
 271         msg = (struct hv_message *)page_addr + VMBUS_MESSAGE_SINT;
 272
 273         /* Check if there are actual msgs to be process */
 274         if (msg->header.message_type != HVMSG_NONE) {
 275                 DPRINT_DBG(VMBUS, "received msg type %d size %d",
 276                                 msg->header.message_type,
 277                                 msg->header.payload_size);
 278                 ret |= 0x1;
 279         }
 280
 281         /* TODO: Check if there are events to be process */
 282         page_addr = hv_context.synic_event_page[cpu];
 283         event = (union hv_synic_event_flags *)page_addr + VMBUS_MESSAGE_SINT;
 284
 285         /* Since we are a child, we only need to check bit 0 */
 286         if (test_and_clear_bit(0, (unsigned long *) &event->flags32[0])) {
 287                 DPRINT_DBG(VMBUS, "received event %d", event->flags32[0]);
 288                 ret |= 0x2;
 289         }
 290
 291         return ret;
 292 }
 293
 294 static void get_channel_info(struct hv_device *device,
 295                              struct hv_device_info *info)
 296 {
 297         struct vmbus_channel_debug_info debug_info;
 298
 299         if (!device->channel)
 300                 return;
 301
 302         vmbus_get_debug_info(device->channel, &debug_info);
 303
 304         info->chn_id = debug_info.relid;
 305         info->chn_state = debug_info.state;
 306         memcpy(&info->chn_type, &debug_info.interfacetype,
 307                sizeof(struct hv_guid));
 308         memcpy(&info->chn_instance, &debug_info.interface_instance,
 309                sizeof(struct hv_guid));
 310
 311         info->monitor_id = debug_info.monitorid;
 312
 313         info->server_monitor_pending = debug_info.servermonitor_pending;
 314         info->server_monitor_latency = debug_info.servermonitor_latency;
 315         info->server_monitor_conn_id = debug_info.servermonitor_connectionid;
 316
 317         info->client_monitor_pending = debug_info.clientmonitor_pending;
 318         info->client_monitor_latency = debug_info.clientmonitor_latency;
 319         info->client_monitor_conn_id = debug_info.clientmonitor_connectionid;
 320
 321         info->inbound.int_mask = debug_info.inbound.current_interrupt_mask;
 322         info->inbound.read_idx = debug_info.inbound.current_read_index;
 323         info->inbound.write_idx = debug_info.inbound.current_write_index;
 324         info->inbound.bytes_avail_toread =
 325                 debug_info.inbound.bytes_avail_toread;
 326         info->inbound.bytes_avail_towrite =
 327                 debug_info.inbound.bytes_avail_towrite;
 328
 329         info->outbound.int_mask =
 330                 debug_info.outbound.current_interrupt_mask;
 331         info->outbound.read_idx = debug_info.outbound.current_read_index;
 332         info->outbound.write_idx = debug_info.outbound.current_write_index;
 333         info->outbound.bytes_avail_toread =
 334                 debug_info.outbound.bytes_avail_toread;
 335         info->outbound.bytes_avail_towrite =
 336                 debug_info.outbound.bytes_avail_towrite;
 337 }
 338
 339 /*
 340  * vmbus_show_device_attr - Show the device attribute in sysfs.
 341  *
 342  * This is invoked when user does a
 343  * "cat /sys/bus/vmbus/devices/<busdevice>/<attr name>"
 344  */
 345 static ssize_t vmbus_show_device_attr(struct device *dev,
 346                                       struct device_attribute *dev_attr,
 347                                       char *buf)
 348 {
 349         struct hv_device *device_ctx = device_to_hv_device(dev);
 350         struct hv_device_info device_info;
 351
 352         memset(&device_info, 0, sizeof(struct hv_device_info));
 353
 354         get_channel_info(device_ctx, &device_info);
 355
 356         if (!strcmp(dev_attr->attr.name, "class_id")) {
 357                 return sprintf(buf, "{%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 358                                "%02x%02x%02x%02x%02x%02x%02x%02x}\n",
 359                                device_info.chn_type.data[3],
 360                                device_info.chn_type.data[2],
 361                                device_info.chn_type.data[1],
 362                                device_info.chn_type.data[0],
 363                                device_info.chn_type.data[5],
 364                                device_info.chn_type.data[4],
 365                                device_info.chn_type.data[7],
 366                                device_info.chn_type.data[6],
 367                                device_info.chn_type.data[8],
 368                                device_info.chn_type.data[9],
 369                                device_info.chn_type.data[10],
 370                                device_info.chn_type.data[11],
 371                                device_info.chn_type.data[12],
 372                                device_info.chn_type.data[13],
 373                                device_info.chn_type.data[14],
 374                                device_info.chn_type.data[15]);
 375         } else if (!strcmp(dev_attr->attr.name, "device_id")) {
 376                 return sprintf(buf, "{%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 377                                "%02x%02x%02x%02x%02x%02x%02x%02x}\n",
 378                                device_info.chn_instance.data[3],
 379                                device_info.chn_instance.data[2],
 380                                device_info.chn_instance.data[1],
 381                                device_info.chn_instance.data[0],
 382                                device_info.chn_instance.data[5],
 383                                device_info.chn_instance.data[4],
 384                                device_info.chn_instance.data[7],
 385                                device_info.chn_instance.data[6],
 386                                device_info.chn_instance.data[8],
 387                                device_info.chn_instance.data[9],
 388                                device_info.chn_instance.data[10],
 389                                device_info.chn_instance.data[11],
 390                                device_info.chn_instance.data[12],
 391                                device_info.chn_instance.data[13],
 392                                device_info.chn_instance.data[14],
 393                                device_info.chn_instance.data[15]);
 394         } else if (!strcmp(dev_attr->attr.name, "state")) {
 395                 return sprintf(buf, "%d\n", device_info.chn_state);
 396         } else if (!strcmp(dev_attr->attr.name, "id")) {
 397                 return sprintf(buf, "%d\n", device_info.chn_id);
 398         } else if (!strcmp(dev_attr->attr.name, "out_intr_mask")) {
 399                 return sprintf(buf, "%d\n", device_info.outbound.int_mask);
 400         } else if (!strcmp(dev_attr->attr.name, "out_read_index")) {
 401                 return sprintf(buf, "%d\n", device_info.outbound.read_idx);
 402         } else if (!strcmp(dev_attr->attr.name, "out_write_index")) {
 403                 return sprintf(buf, "%d\n", device_info.outbound.write_idx);
 404         } else if (!strcmp(dev_attr->attr.name, "out_read_bytes_avail")) {
 405                 return sprintf(buf, "%d\n",
 406                                device_info.outbound.bytes_avail_toread);
 407         } else if (!strcmp(dev_attr->attr.name, "out_write_bytes_avail")) {
 408                 return sprintf(buf, "%d\n",
 409                                device_info.outbound.bytes_avail_towrite);
 410         } else if (!strcmp(dev_attr->attr.name, "in_intr_mask")) {
 411                 return sprintf(buf, "%d\n", device_info.inbound.int_mask);
 412         } else if (!strcmp(dev_attr->attr.name, "in_read_index")) {
 413                 return sprintf(buf, "%d\n", device_info.inbound.read_idx);
 414         } else if (!strcmp(dev_attr->attr.name, "in_write_index")) {
 415                 return sprintf(buf, "%d\n", device_info.inbound.write_idx);
 416         } else if (!strcmp(dev_attr->attr.name, "in_read_bytes_avail")) {
 417                 return sprintf(buf, "%d\n",
 418                                device_info.inbound.bytes_avail_toread);
 419         } else if (!strcmp(dev_attr->attr.name, "in_write_bytes_avail")) {
 420                 return sprintf(buf, "%d\n",
 421                                device_info.inbound.bytes_avail_towrite);
 422         } else if (!strcmp(dev_attr->attr.name, "monitor_id")) {
 423                 return sprintf(buf, "%d\n", device_info.monitor_id);
 424         } else if (!strcmp(dev_attr->attr.name, "server_monitor_pending")) {
 425                 return sprintf(buf, "%d\n", device_info.server_monitor_pending);
 426         } else if (!strcmp(dev_attr->attr.name, "server_monitor_latency")) {
 427                 return sprintf(buf, "%d\n", device_info.server_monitor_latency);
 428         } else if (!strcmp(dev_attr->attr.name, "server_monitor_conn_id")) {
 429                 return sprintf(buf, "%d\n",
 430                                device_info.server_monitor_conn_id);
 431         } else if (!strcmp(dev_attr->attr.name, "client_monitor_pending")) {
 432                 return sprintf(buf, "%d\n", device_info.client_monitor_pending);
 433         } else if (!strcmp(dev_attr->attr.name, "client_monitor_latency")) {
 434                 return sprintf(buf, "%d\n", device_info.client_monitor_latency);
 435         } else if (!strcmp(dev_attr->attr.name, "client_monitor_conn_id")) {
 436                 return sprintf(buf, "%d\n",
 437                                device_info.client_monitor_conn_id);
 438         } else {
 439                 return 0;
 440         }
 441 }
 442
 443 /*
 444  * vmbus_bus_init -Main vmbus driver initialization routine.
 445  *
 446  * Here, we
 447  *      - initialize the vmbus driver context
 448  *      - setup various driver entry points
 449  *      - invoke the vmbus hv main init routine
 450  *      - get the irq resource
 451  *      - invoke the vmbus to add the vmbus root device
 452  *      - setup the vmbus root device
 453  *      - retrieve the channel offers
 454  */
 455 static int vmbus_bus_init(void)
 456 {
 457         struct vmbus_driver_context *vmbus_drv_ctx = &vmbus_drv;
 458         struct hv_device *dev_ctx = &vmbus_drv.device_ctx;
 459         int ret;
 460         unsigned int vector;
 461
 462         DPRINT_INFO(VMBUS, "+++++++ HV Driver version = %s +++++++",
 463                     HV_DRV_VERSION);
 464         DPRINT_INFO(VMBUS, "+++++++ Vmbus supported version = %d +++++++",
 465                         VMBUS_REVISION_NUMBER);
 466         DPRINT_INFO(VMBUS, "+++++++ Vmbus using SINT %d +++++++",
 467                         VMBUS_MESSAGE_SINT);
 468         DPRINT_DBG(VMBUS, "sizeof(vmbus_channel_packet_page_buffer)=%zd, "
 469                         "sizeof(VMBUS_CHANNEL_PACKET_MULITPAGE_BUFFER)=%zd",
 470                         sizeof(struct vmbus_channel_packet_page_buffer),
 471                         sizeof(struct vmbus_channel_packet_multipage_buffer));
 472
 473
 474         /* Hypervisor initialization...setup hypercall page..etc */
 475         ret = hv_init();
 476         if (ret != 0) {
 477                 DPRINT_ERR(VMBUS, "Unable to initialize the hypervisor - 0x%x",
 478                                 ret);
 479                 goto cleanup;
 480         }
 481
 482
 483         vmbus_drv_ctx->bus.name = driver_name;
 484
 485         /* Initialize the bus context */
 486         tasklet_init(&vmbus_drv_ctx->msg_dpc, vmbus_on_msg_dpc,
 487                      (unsigned long)NULL);
 488         tasklet_init(&vmbus_drv_ctx->event_dpc, vmbus_event_dpc,
 489                      (unsigned long)NULL);
 490
 491         /* Now, register the bus  with LDM */
 492         ret = bus_register(&vmbus_drv_ctx->bus);
 493         if (ret) {
 494                 ret = -1;
 495                 goto cleanup;
 496         }
 497
 498         /* Get the interrupt resource */
 499         ret = request_irq(vmbus_irq, vmbus_isr, IRQF_SAMPLE_RANDOM,
 500                           driver_name, NULL);
 501
 502         if (ret != 0) {
 503                 DPRINT_ERR(VMBUS_DRV, "ERROR - Unable to request IRQ %d",
 504                            vmbus_irq);
 505
 506                 bus_unregister(&vmbus_drv_ctx->bus);
 507
 508                 ret = -1;
 509                 goto cleanup;
 510         }
 511         vector = VMBUS_IRQ_VECTOR;
 512
 513         DPRINT_INFO(VMBUS_DRV, "irq 0x%x vector 0x%x", vmbus_irq, vector);
 514
 515         /* Add the root device */
 516         memset(dev_ctx, 0, sizeof(struct hv_device));
 517
 518         ret = vmbus_dev_add(dev_ctx, &vector);
 519         if (ret != 0) {
 520                 DPRINT_ERR(VMBUS_DRV,
 521                            "ERROR - Unable to add vmbus root device");
 522
 523                 free_irq(vmbus_irq, NULL);
 524
 525                 bus_unregister(&vmbus_drv_ctx->bus);
 526
 527                 ret = -1;
 528                 goto cleanup;
 529         }
 530         /* strcpy(dev_ctx->device.bus_id, dev_ctx->device_obj.name); */
 531         dev_set_name(&dev_ctx->device, "vmbus_0_0");
 532
 533         /* No need to bind a driver to the root device. */
 534         dev_ctx->device.parent = NULL;
 535         /* NULL; vmbus_remove() does not get invoked */
 536         dev_ctx->device.bus = &vmbus_drv_ctx->bus;
 537
 538         /* Setup the device dispatch table */
 539         dev_ctx->device.release = vmbus_bus_release;
 540
 541         /* register the  root device */
 542         ret = device_register(&dev_ctx->device);
 543         if (ret) {
 544                 DPRINT_ERR(VMBUS_DRV,
 545                            "ERROR - Unable to register vmbus root device");
 546
 547                 free_irq(vmbus_irq, NULL);
 548                 bus_unregister(&vmbus_drv_ctx->bus);
 549
 550                 ret = -1;
 551                 goto cleanup;
 552         }
 553
 554         vmbus_request_offers();
 555         wait_for_completion(&hv_channel_ready);
 556
 557 cleanup:
 558         return ret;
 559 }
 560
 561 /*
 562  * vmbus_bus_exit - Terminate the vmbus driver.
 563  *
 564  * This routine is opposite of vmbus_bus_init()
 565  */
 566 static void vmbus_bus_exit(void)
 567 {
 568         struct vmbus_driver_context *vmbus_drv_ctx = &vmbus_drv;
 569
 570         struct hv_device *dev_ctx = &vmbus_drv.device_ctx;
 571
 572         /* Remove the root device */
 573         vmbus_dev_rm(dev_ctx);
 574
 575         vmbus_cleanup();
 576
 577         /* Unregister the root bus device */
 578         device_unregister(&dev_ctx->device);
 579
 580         bus_unregister(&vmbus_drv_ctx->bus);
 581
 582         free_irq(vmbus_irq, NULL);
 583
 584         tasklet_kill(&vmbus_drv_ctx->msg_dpc);
 585         tasklet_kill(&vmbus_drv_ctx->event_dpc);
 586 }
 587
 588
 589 /**
 590  * vmbus_child_driver_register() - Register a vmbus's child driver
 591  * @drv:        Pointer to driver structure you want to register
 592  *
 593  *
 594  * Registers the given driver with Linux through the 'driver_register()' call
 595  * And sets up the hyper-v vmbus handling for this driver.
 596  * It will return the state of the 'driver_register()' call.
 597  *
 598  * Mainly used by Hyper-V drivers.
 599  */
 600 int vmbus_child_driver_register(struct device_driver *drv)
 601 {
 602         int ret;
 603
 604         DPRINT_INFO(VMBUS_DRV, "child driver (%p) registering - name %s",
 605                     drv, drv->name);
 606
 607         /* The child driver on this vmbus */
 608         drv->bus = &vmbus_drv.bus;
 609
 610         ret = driver_register(drv);
 611
 612         vmbus_request_offers();
 613
 614         return ret;
 615 }
 616 EXPORT_SYMBOL(vmbus_child_driver_register);
 617
 618 /**
 619  * vmbus_child_driver_unregister() - Unregister a vmbus's child driver
 620  * @drv:        Pointer to driver structure you want to un-register
 621  *
 622  *
 623  * Un-register the given driver with Linux through the 'driver_unregister()'
 624  * call. And ungegisters the driver from the Hyper-V vmbus handler.
 625  *
 626  * Mainly used by Hyper-V drivers.
 627  */
 628 void vmbus_child_driver_unregister(struct device_driver *drv)
 629 {
 630         DPRINT_INFO(VMBUS_DRV, "child driver (%p) unregistering - name %s",
 631                     drv, drv->name);
 632
 633         driver_unregister(drv);
 634
 635         drv->bus = NULL;
 636 }
 637 EXPORT_SYMBOL(vmbus_child_driver_unregister);
 638
 639 /*
 640  * vmbus_child_device_create - Creates and registers a new child device
 641  * on the vmbus.
 642  */
 643 struct hv_device *vmbus_child_device_create(struct hv_guid *type,
 644                                             struct hv_guid *instance,
 645                                             struct vmbus_channel *channel)
 646 {
 647         struct hv_device *child_device_obj;
 648
 649         /* Allocate the new child device */
 650         child_device_obj = kzalloc(sizeof(struct hv_device), GFP_KERNEL);
 651         if (!child_device_obj) {
 652                 DPRINT_ERR(VMBUS_DRV,
 653                         "unable to allocate device_context for child device");
 654                 return NULL;
 655         }
 656
 657         DPRINT_DBG(VMBUS_DRV, "child device (%p) allocated - "
 658                 "type {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 659                 "%02x%02x%02x%02x%02x%02x%02x%02x},"
 660                 "id {%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 661                 "%02x%02x%02x%02x%02x%02x%02x%02x}",
 662                 &child_device_obj->device,
 663                 type->data[3], type->data[2], type->data[1], type->data[0],
 664                 type->data[5], type->data[4], type->data[7], type->data[6],
 665                 type->data[8], type->data[9], type->data[10], type->data[11],
 666                 type->data[12], type->data[13], type->data[14], type->data[15],
 667                 instance->data[3], instance->data[2],
 668                 instance->data[1], instance->data[0],
 669                 instance->data[5], instance->data[4],
 670                 instance->data[7], instance->data[6],
 671                 instance->data[8], instance->data[9],
 672                 instance->data[10], instance->data[11],
 673                 instance->data[12], instance->data[13],
 674                 instance->data[14], instance->data[15]);
 675
 676         child_device_obj->channel = channel;
 677         memcpy(&child_device_obj->dev_type, type, sizeof(struct hv_guid));
 678         memcpy(&child_device_obj->dev_instance, instance,
 679                sizeof(struct hv_guid));
 680
 681
 682         return child_device_obj;
 683 }
 684
 685 /*
 686  * vmbus_child_device_register - Register the child device on the specified bus
 687  */
 688 int vmbus_child_device_register(struct hv_device *root_device_obj,
 689                                 struct hv_device *child_device_obj)
 690 {
 691         int ret = 0;
 692
 693         static atomic_t device_num = ATOMIC_INIT(0);
 694
 695         DPRINT_DBG(VMBUS_DRV, "child device (%p) registering",
 696                    child_device_obj);
 697
 698         /* Set the device name. Otherwise, device_register() will fail. */
 699         dev_set_name(&child_device_obj->device, "vmbus_0_%d",
 700                      atomic_inc_return(&device_num));
 701
 702         /* The new device belongs to this bus */
 703         child_device_obj->device.bus = &vmbus_drv.bus; /* device->dev.bus; */
 704         child_device_obj->device.parent = &root_device_obj->device;
 705         child_device_obj->device.release = vmbus_device_release;
 706
 707         /*
 708          * Register with the LDM. This will kick off the driver/device
 709          * binding...which will eventually call vmbus_match() and vmbus_probe()
 710          */
 711         ret = device_register(&child_device_obj->device);
 712
 713         /* vmbus_probe() error does not get propergate to device_register(). */
 714         ret = child_device_obj->probe_error;
 715
 716         if (ret)
 717                 DPRINT_ERR(VMBUS_DRV, "unable to register child device (%p)",
 718                            &child_device_obj->device);
 719         else
 720                 DPRINT_INFO(VMBUS_DRV, "child device (%p) registered",
 721                             &child_device_obj->device);
 722
 723         return ret;
 724 }
 725
 726 /*
 727  * vmbus_child_device_unregister - Remove the specified child device
 728  * from the vmbus.
 729  */
 730 void vmbus_child_device_unregister(struct hv_device *device_obj)
 731 {
 732
 733         DPRINT_INFO(VMBUS_DRV, "unregistering child device (%p)",
 734                     &device_obj->device);
 735
 736         /*
 737          * Kick off the process of unregistering the device.
 738          * This will call vmbus_remove() and eventually vmbus_device_release()
 739          */
 740         device_unregister(&device_obj->device);
 741
 742         DPRINT_INFO(VMBUS_DRV, "child device (%p) unregistered",
 743                     &device_obj->device);
 744 }
 745
 746 /*
 747  * vmbus_uevent - add uevent for our device
 748  *
 749  * This routine is invoked when a device is added or removed on the vmbus to
 750  * generate a uevent to udev in the userspace. The udev will then look at its
 751  * rule and the uevent generated here to load the appropriate driver
 752  */
 753 static int vmbus_uevent(struct device *device, struct kobj_uevent_env *env)
 754 {
 755         struct hv_device *dev = device_to_hv_device(device);
 756         int ret;
 757
 758         DPRINT_INFO(VMBUS_DRV, "generating uevent - VMBUS_DEVICE_CLASS_GUID={"
 759                     "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 760                     "%02x%02x%02x%02x%02x%02x%02x%02x}",
 761                     dev->dev_type.data[3], dev->dev_type.data[2],
 762                     dev->dev_type.data[1], dev->dev_type.data[0],
 763                     dev->dev_type.data[5], dev->dev_type.data[4],
 764                     dev->dev_type.data[7], dev->dev_type.data[6],
 765                     dev->dev_type.data[8], dev->dev_type.data[9],
 766                     dev->dev_type.data[10],
 767                     dev->dev_type.data[11],
 768                     dev->dev_type.data[12],
 769                     dev->dev_type.data[13],
 770                     dev->dev_type.data[14],
 771                     dev->dev_type.data[15]);
 772
 773         ret = add_uevent_var(env, "VMBUS_DEVICE_CLASS_GUID={"
 774                              "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 775                              "%02x%02x%02x%02x%02x%02x%02x%02x}",
 776                              dev->dev_type.data[3],
 777                              dev->dev_type.data[2],
 778                              dev->dev_type.data[1],
 779                              dev->dev_type.data[0],
 780                              dev->dev_type.data[5],
 781                              dev->dev_type.data[4],
 782                              dev->dev_type.data[7],
 783                              dev->dev_type.data[6],
 784                              dev->dev_type.data[8],
 785                              dev->dev_type.data[9],
 786                              dev->dev_type.data[10],
 787                              dev->dev_type.data[11],
 788                              dev->dev_type.data[12],
 789                              dev->dev_type.data[13],
 790                              dev->dev_type.data[14],
 791                              dev->dev_type.data[15]);
 792
 793         if (ret)
 794                 return ret;
 795
 796         ret = add_uevent_var(env, "VMBUS_DEVICE_DEVICE_GUID={"
 797                              "%02x%02x%02x%02x-%02x%02x-%02x%02x-"
 798                              "%02x%02x%02x%02x%02x%02x%02x%02x}",
 799                              dev->dev_instance.data[3],
 800                              dev->dev_instance.data[2],
 801                              dev->dev_instance.data[1],
 802                              dev->dev_instance.data[0],
 803                              dev->dev_instance.data[5],
 804                              dev->dev_instance.data[4],
 805                              dev->dev_instance.data[7],
 806                              dev->dev_instance.data[6],
 807                              dev->dev_instance.data[8],
 808                              dev->dev_instance.data[9],
 809                              dev->dev_instance.data[10],
 810                              dev->dev_instance.data[11],
 811                              dev->dev_instance.data[12],
 812                              dev->dev_instance.data[13],
 813                              dev->dev_instance.data[14],
 814                              dev->dev_instance.data[15]);
 815         if (ret)
 816                 return ret;
 817
 818         return 0;
 819 }
 820
 821 /*
 822  * vmbus_match - Attempt to match the specified device to the specified driver
 823  */
 824 static int vmbus_match(struct device *device, struct device_driver *driver)
 825 {
 826         int match = 0;
 827         struct hv_driver *drv = drv_to_hv_drv(driver);
 828         struct hv_device *device_ctx = device_to_hv_device(device);
 829
 830         /* We found our driver ? */
 831         if (memcmp(&device_ctx->dev_type, &drv->dev_type,
 832                    sizeof(struct hv_guid)) == 0) {
 833
 834                 device_ctx->drv = drv->priv;
 835                 DPRINT_INFO(VMBUS_DRV,
 836                             "device object (%p) set to driver object (%p)",
 837                             &device_ctx,
 838                             device_ctx->drv);
 839
 840                 match = 1;
 841         }
 842         return match;
 843 }
 844
 845 /*
 846  * vmbus_probe_failed_cb - Callback when a driver probe failed in vmbus_probe()
 847  *
 848  * We need a callback because we cannot invoked device_unregister() inside
 849  * vmbus_probe() since vmbus_probe() may be invoked inside device_register()
 850  * i.e. we cannot call device_unregister() inside device_register()
 851  */
 852 static void vmbus_probe_failed_cb(struct work_struct *context)
 853 {
 854         struct hv_device *device_ctx = (struct hv_device *)context;
 855
 856         /*
 857          * Kick off the process of unregistering the device.
 858          * This will call vmbus_remove() and eventually vmbus_device_release()
 859          */
 860         device_unregister(&device_ctx->device);
 861
 862         /* put_device(&device_ctx->device); */
 863 }
 864
 865 /*
 866  * vmbus_probe - Add the new vmbus's child device
 867  */
 868 static int vmbus_probe(struct device *child_device)
 869 {
 870         int ret = 0;
 871         struct hv_driver *drv =
 872                         drv_to_hv_drv(child_device->driver);
 873         struct hv_device *dev = device_to_hv_device(child_device);
 874
 875         /* Let the specific open-source driver handles the probe if it can */
 876         if (drv->driver.probe) {
 877                 ret = dev->probe_error =
 878                 drv->driver.probe(child_device);
 879                 if (ret != 0) {
 880                         DPRINT_ERR(VMBUS_DRV, "probe() failed for device %s "
 881                                    "(%p) on driver %s (%d)...",
 882                                    dev_name(child_device), child_device,
 883                                    child_device->driver->name, ret);
 884
 885                         INIT_WORK(&dev->probe_failed_work_item,
 886                                   vmbus_probe_failed_cb);
 887                         schedule_work(&dev->probe_failed_work_item);
 888                 }
 889         } else {
 890                 DPRINT_ERR(VMBUS_DRV, "probe() method not set for driver - %s",
 891                            child_device->driver->name);
 892                 ret = -1;
 893         }
 894         return ret;
 895 }
 896
 897 /*
 898  * vmbus_remove - Remove a vmbus device
 899  */
 900 static int vmbus_remove(struct device *child_device)
 901 {
 902         int ret;
 903         struct hv_driver *drv;
 904
 905         /* Special case root bus device */
 906         if (child_device->parent == NULL) {
 907                 /*
 908                  * No-op since it is statically defined and handle in
 909                  * vmbus_bus_exit()
 910                  */
 911                 return 0;
 912         }
 913
 914         if (child_device->driver) {
 915                 drv = drv_to_hv_drv(child_device->driver);
 916
 917                 /*
 918                  * Let the specific open-source driver handles the removal if
 919                  * it can
 920                  */
 921                 if (drv->driver.remove) {
 922                         ret = drv->driver.remove(child_device);
 923                 } else {
 924                         DPRINT_ERR(VMBUS_DRV,
 925                                    "remove() method not set for driver - %s",
 926                                    child_device->driver->name);
 927                         ret = -1;
 928                 }
 929         }
 930
 931         return 0;
 932 }
 933
 934 /*
 935  * vmbus_shutdown - Shutdown a vmbus device
 936  */
 937 static void vmbus_shutdown(struct device *child_device)
 938 {
 939         struct hv_driver *drv;
 940
 941         /* Special case root bus device */
 942         if (child_device->parent == NULL) {
 943                 /*
 944                  * No-op since it is statically defined and handle in
 945                  * vmbus_bus_exit()
 946                  */
 947                 return;
 948         }
 949
 950         /* The device may not be attached yet */
 951         if (!child_device->driver)
 952                 return;
 953
 954         drv = drv_to_hv_drv(child_device->driver);
 955
 956         /* Let the specific open-source driver handles the removal if it can */
 957         if (drv->driver.shutdown)
 958                 drv->driver.shutdown(child_device);
 959
 960         return;
 961 }
 962
 963 /*
 964  * vmbus_bus_release - Final callback release of the vmbus root device
 965  */
 966 static void vmbus_bus_release(struct device *device)
 967 {
 968         /* FIXME */
 969         /* Empty release functions are a bug, or a major sign
 970          * of a problem design, this MUST BE FIXED! */
 971         dev_err(device, "%s needs to be fixed!\n", __func__);
 972         WARN_ON(1);
 973 }
 974
 975 /*
 976  * vmbus_device_release - Final callback release of the vmbus child device
 977  */
 978 static void vmbus_device_release(struct device *device)
 979 {
 980         struct hv_device *device_ctx = device_to_hv_device(device);
 981
 982         kfree(device_ctx);
 983
 984         /* !!DO NOT REFERENCE device_ctx anymore at this point!! */
 985 }
 986
 987
 988 /*
 989  * vmbus_event_dpc - Tasklet routine to handle hypervisor events
 990  */
 991 static void vmbus_event_dpc(unsigned long data)
 992 {
 993         /* Call to bus driver to handle interrupt */
 994         vmbus_on_event();
 995 }
 996
 997 static irqreturn_t vmbus_isr(int irq, void *dev_id)
 998 {
 999         int ret;
1000
1001         /* Call to bus driver to handle interrupt */
1002         ret = vmbus_on_isr(NULL);
1003
1004         /* Schedules a dpc if necessary */
1005         if (ret > 0) {
1006                 if (test_bit(0, (unsigned long *)&ret))
1007                         tasklet_schedule(&vmbus_drv.msg_dpc);
1008
1009                 if (test_bit(1, (unsigned long *)&ret))
1010                         tasklet_schedule(&vmbus_drv.event_dpc);
1011
1012                 return IRQ_HANDLED;
1013         } else {
1014                 return IRQ_NONE;
1015         }
1016 }
1017
1018 static struct dmi_system_id __initdata microsoft_hv_dmi_table[] = {
1019         {
1020                 .ident = "Hyper-V",
1021                 .matches = {
1022                         DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
1023                         DMI_MATCH(DMI_PRODUCT_NAME, "Virtual Machine"),
1024                         DMI_MATCH(DMI_BOARD_NAME, "Virtual Machine"),
1025                 },
1026         },
1027         { },
1028 };
1029 MODULE_DEVICE_TABLE(dmi, microsoft_hv_dmi_table);
1030
1031 static int __init vmbus_init(void)
1032 {
1033         DPRINT_INFO(VMBUS_DRV,
1034                 "Vmbus initializing.... current log level 0x%x (%x,%x)",
1035                 vmbus_loglevel, HIWORD(vmbus_loglevel), LOWORD(vmbus_loglevel));
1036         /* Todo: it is used for loglevel, to be ported to new kernel. */
1037
1038         if (!dmi_check_system(microsoft_hv_dmi_table))
1039                 return -ENODEV;
1040
1041         return vmbus_bus_init();
1042 }
1043
1044 static void __exit vmbus_exit(void)
1045 {
1046         vmbus_bus_exit();
1047         /* Todo: it is used for loglevel, to be ported to new kernel. */
1048 }
1049
1050 /*
1051  * We use a PCI table to determine if we should autoload this driver  This is
1052  * needed by distro tools to determine if the hyperv drivers should be
1053  * installed and/or configured.  We don't do anything else with the table, but
1054  * it needs to be present.
1055  */
1056 static const struct pci_device_id microsoft_hv_pci_table[] = {
1057         { PCI_DEVICE(0x1414, 0x5353) }, /* VGA compatible controller */
1058         { 0 }
1059 };
1060 MODULE_DEVICE_TABLE(pci, microsoft_hv_pci_table);
1061
1062 MODULE_LICENSE("GPL");
1063 MODULE_VERSION(HV_DRV_VERSION);
1064 module_param(vmbus_irq, int, S_IRUGO);
1065 module_param(vmbus_loglevel, int, S_IRUGO);
1066
1067 module_init(vmbus_init);
1068 module_exit(vmbus_exit);