drivers/staging/hv/netvsc_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/highmem.h>
  24 #include <linux/device.h>
  25 #include <linux/io.h>
  26 #include <linux/delay.h>
  27 #include <linux/netdevice.h>
  28 #include <linux/inetdevice.h>
  29 #include <linux/etherdevice.h>
  30 #include <linux/skbuff.h>
  31 #include <linux/in.h>
  32 #include <linux/slab.h>
  33 #include <linux/dmi.h>
  34 #include <linux/pci.h>
  35 #include <net/arp.h>
  36 #include <net/route.h>
  37 #include <net/sock.h>
  38 #include <net/pkt_sched.h>
  39 #include "osd.h"
  40 #include "logging.h"
  41 #include "version_info.h"
  42 #include "vmbus.h"
  43 #include "netvsc_api.h"
  44
  45 struct net_device_context {
  46         /* point back to our device context */
  47         struct vm_device *device_ctx;
  48         unsigned long avail;
  49 };
  50
  51 struct netvsc_driver_context {
  52         /* !! These must be the first 2 fields !! */
  53         /* Which is a bug FIXME! */
  54         struct driver_context drv_ctx;
  55         struct netvsc_driver drv_obj;
  56 };
  57
  58 #define PACKET_PAGES_LOWATER  8
  59 /* Need this many pages to handle worst case fragmented packet */
  60 #define PACKET_PAGES_HIWATER  (MAX_SKB_FRAGS + 2)
  61
  62 static int ring_size = 128;
  63 module_param(ring_size, int, S_IRUGO);
  64 MODULE_PARM_DESC(ring_size, "Ring buffer size (# of pages)");
  65
  66 /* The one and only one */
  67 static struct netvsc_driver_context g_netvsc_drv;
  68
  69 static void netvsc_set_multicast_list(struct net_device *net)
  70 {
  71 }
  72
  73 static int netvsc_open(struct net_device *net)
  74 {
  75         struct net_device_context *net_device_ctx = netdev_priv(net);
  76         struct hv_device *device_obj = &net_device_ctx->device_ctx->device_obj;
  77         int ret = 0;
  78
  79         if (netif_carrier_ok(net)) {
  80                 /* Open up the device */
  81                 ret = RndisFilterOnOpen(device_obj);
  82                 if (ret != 0) {
  83                         DPRINT_ERR(NETVSC_DRV,
  84                                    "unable to open device (ret %d).", ret);
  85                         return ret;
  86                 }
  87
  88                 netif_start_queue(net);
  89         } else {
  90                 DPRINT_ERR(NETVSC_DRV, "unable to open device...link is down.");
  91         }
  92
  93         return ret;
  94 }
  95
  96 static int netvsc_close(struct net_device *net)
  97 {
  98         struct net_device_context *net_device_ctx = netdev_priv(net);
  99         struct hv_device *device_obj = &net_device_ctx->device_ctx->device_obj;
 100         int ret;
 101
 102         netif_stop_queue(net);
 103
 104         ret = RndisFilterOnClose(device_obj);
 105         if (ret != 0)
 106                 DPRINT_ERR(NETVSC_DRV, "unable to close device (ret %d).", ret);
 107
 108         return ret;
 109 }
 110
 111 static void netvsc_xmit_completion(void *context)
 112 {
 113         struct hv_netvsc_packet *packet = (struct hv_netvsc_packet *)context;
 114         struct sk_buff *skb = (struct sk_buff *)
 115                 (unsigned long)packet->Completion.Send.SendCompletionTid;
 116
 117         kfree(packet);
 118
 119         if (skb) {
 120                 struct net_device *net = skb->dev;
 121                 struct net_device_context *net_device_ctx = netdev_priv(net);
 122                 unsigned int num_pages = skb_shinfo(skb)->nr_frags + 2;
 123
 124                 dev_kfree_skb_any(skb);
 125
 126                 if ((net_device_ctx->avail += num_pages) >= PACKET_PAGES_HIWATER)
 127                         netif_wake_queue(net);
 128         }
 129 }
 130
 131 static int netvsc_start_xmit(struct sk_buff *skb, struct net_device *net)
 132 {
 133         struct net_device_context *net_device_ctx = netdev_priv(net);
 134         struct driver_context *driver_ctx =
 135             driver_to_driver_context(net_device_ctx->device_ctx->device.driver);
 136         struct netvsc_driver_context *net_drv_ctx =
 137                 (struct netvsc_driver_context *)driver_ctx;
 138         struct netvsc_driver *net_drv_obj = &net_drv_ctx->drv_obj;
 139         struct hv_netvsc_packet *packet;
 140         int ret;
 141         unsigned int i, num_pages;
 142
 143         DPRINT_DBG(NETVSC_DRV, "xmit packet - len %d data_len %d",
 144                    skb->len, skb->data_len);
 145
 146         /* Add 1 for skb->data and additional one for RNDIS */
 147         num_pages = skb_shinfo(skb)->nr_frags + 1 + 1;
 148         if (num_pages > net_device_ctx->avail)
 149                 return NETDEV_TX_BUSY;
 150
 151         /* Allocate a netvsc packet based on # of frags. */
 152         packet = kzalloc(sizeof(struct hv_netvsc_packet) +
 153                          (num_pages * sizeof(struct hv_page_buffer)) +
 154                          net_drv_obj->RequestExtSize, GFP_ATOMIC);
 155         if (!packet) {
 156                 /* out of memory, silently drop packet */
 157                 DPRINT_ERR(NETVSC_DRV, "unable to allocate hv_netvsc_packet");
 158
 159                 dev_kfree_skb(skb);
 160                 net->stats.tx_dropped++;
 161                 return NETDEV_TX_OK;
 162         }
 163
 164         packet->Extension = (void *)(unsigned long)packet +
 165                                 sizeof(struct hv_netvsc_packet) +
 166                                     (num_pages * sizeof(struct hv_page_buffer));
 167
 168         /* Setup the rndis header */
 169         packet->PageBufferCount = num_pages;
 170
 171         /* TODO: Flush all write buffers/ memory fence ??? */
 172         /* wmb(); */
 173
 174         /* Initialize it from the skb */
 175         packet->TotalDataBufferLength   = skb->len;
 176
 177         /* Start filling in the page buffers starting after RNDIS buffer. */
 178         packet->PageBuffers[1].Pfn = virt_to_phys(skb->data) >> PAGE_SHIFT;
 179         packet->PageBuffers[1].Offset
 180                 = (unsigned long)skb->data & (PAGE_SIZE - 1);
 181         packet->PageBuffers[1].Length = skb_headlen(skb);
 182
 183         /* Additional fragments are after SKB data */
 184         for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
 185                 skb_frag_t *f = &skb_shinfo(skb)->frags[i];
 186
 187                 packet->PageBuffers[i+2].Pfn = page_to_pfn(f->page);
 188                 packet->PageBuffers[i+2].Offset = f->page_offset;
 189                 packet->PageBuffers[i+2].Length = f->size;
 190         }
 191
 192         /* Set the completion routine */
 193         packet->Completion.Send.OnSendCompletion = netvsc_xmit_completion;
 194         packet->Completion.Send.SendCompletionContext = packet;
 195         packet->Completion.Send.SendCompletionTid = (unsigned long)skb;
 196
 197         ret = net_drv_obj->OnSend(&net_device_ctx->device_ctx->device_obj,
 198                                   packet);
 199         if (ret == 0) {
 200                 net->stats.tx_bytes += skb->len;
 201                 net->stats.tx_packets++;
 202
 203                 DPRINT_DBG(NETVSC_DRV, "# of xmits %lu total size %lu",
 204                            net->stats.tx_packets,
 205                            net->stats.tx_bytes);
 206
 207                 if ((net_device_ctx->avail -= num_pages) < PACKET_PAGES_LOWATER)
 208                         netif_stop_queue(net);
 209         } else {
 210                 /* we are shutting down or bus overloaded, just drop packet */
 211                 net->stats.tx_dropped++;
 212                 netvsc_xmit_completion(packet);
 213         }
 214
 215         return NETDEV_TX_OK;
 216 }
 217
 218 /*
 219  * netvsc_linkstatus_callback - Link up/down notification
 220  */
 221 static void netvsc_linkstatus_callback(struct hv_device *device_obj,
 222                                        unsigned int status)
 223 {
 224         struct vm_device *device_ctx = to_vm_device(device_obj);
 225         struct net_device *net = dev_get_drvdata(&device_ctx->device);
 226
 227         if (!net) {
 228                 DPRINT_ERR(NETVSC_DRV, "got link status but net device "
 229                                 "not initialized yet");
 230                 return;
 231         }
 232
 233         if (status == 1) {
 234                 netif_carrier_on(net);
 235                 netif_wake_queue(net);
 236         } else {
 237                 netif_carrier_off(net);
 238                 netif_stop_queue(net);
 239         }
 240 }
 241
 242 /*
 243  * netvsc_recv_callback -  Callback when we receive a packet from the
 244  * "wire" on the specified device.
 245  */
 246 static int netvsc_recv_callback(struct hv_device *device_obj,
 247                                 struct hv_netvsc_packet *packet)
 248 {
 249         struct vm_device *device_ctx = to_vm_device(device_obj);
 250         struct net_device *net = dev_get_drvdata(&device_ctx->device);
 251         struct sk_buff *skb;
 252         void *data;
 253         int i;
 254         unsigned long flags;
 255
 256         if (!net) {
 257                 DPRINT_ERR(NETVSC_DRV, "got receive callback but net device "
 258                                 "not initialized yet");
 259                 return 0;
 260         }
 261
 262         /* Allocate a skb - TODO direct I/O to pages? */
 263         skb = netdev_alloc_skb_ip_align(net, packet->TotalDataBufferLength);
 264         if (unlikely(!skb)) {
 265                 ++net->stats.rx_dropped;
 266                 return 0;
 267         }
 268
 269         /* for kmap_atomic */
 270         local_irq_save(flags);
 271
 272         /*
 273          * Copy to skb. This copy is needed here since the memory pointed by
 274          * hv_netvsc_packet cannot be deallocated
 275          */
 276         for (i = 0; i < packet->PageBufferCount; i++) {
 277                 data = kmap_atomic(pfn_to_page(packet->PageBuffers[i].Pfn),
 278                                                KM_IRQ1);
 279                 data = (void *)(unsigned long)data +
 280                                 packet->PageBuffers[i].Offset;
 281
 282                 memcpy(skb_put(skb, packet->PageBuffers[i].Length), data,
 283                        packet->PageBuffers[i].Length);
 284
 285                 kunmap_atomic((void *)((unsigned long)data -
 286                                        packet->PageBuffers[i].Offset), KM_IRQ1);
 287         }
 288
 289         local_irq_restore(flags);
 290
 291         skb->protocol = eth_type_trans(skb, net);
 292         skb->ip_summed = CHECKSUM_NONE;
 293
 294         net->stats.rx_packets++;
 295         net->stats.rx_bytes += skb->len;
 296
 297         /*
 298          * Pass the skb back up. Network stack will deallocate the skb when it
 299          * is done.
 300          * TODO - use NAPI?
 301          */
 302         netif_rx(skb);
 303
 304         DPRINT_DBG(NETVSC_DRV, "# of recvs %lu total size %lu",
 305                    net->stats.rx_packets, net->stats.rx_bytes);
 306
 307         return 0;
 308 }
 309
 310 static void netvsc_get_drvinfo(struct net_device *net,
 311                                struct ethtool_drvinfo *info)
 312 {
 313         strcpy(info->driver, "hv_netvsc");
 314         strcpy(info->version, HV_DRV_VERSION);
 315         strcpy(info->fw_version, "N/A");
 316 }
 317
 318 static const struct ethtool_ops ethtool_ops = {
 319         .get_drvinfo    = netvsc_get_drvinfo,
 320         .get_sg         = ethtool_op_get_sg,
 321         .set_sg         = ethtool_op_set_sg,
 322         .get_link       = ethtool_op_get_link,
 323 };
 324
 325 static const struct net_device_ops device_ops = {
 326         .ndo_open =                     netvsc_open,
 327         .ndo_stop =                     netvsc_close,
 328         .ndo_start_xmit =               netvsc_start_xmit,
 329         .ndo_set_multicast_list =       netvsc_set_multicast_list,
 330         .ndo_change_mtu =               eth_change_mtu,
 331         .ndo_validate_addr =            eth_validate_addr,
 332         .ndo_set_mac_address =          eth_mac_addr,
 333 };
 334
 335 static int netvsc_probe(struct device *device)
 336 {
 337         struct driver_context *driver_ctx =
 338                 driver_to_driver_context(device->driver);
 339         struct netvsc_driver_context *net_drv_ctx =
 340                 (struct netvsc_driver_context *)driver_ctx;
 341         struct netvsc_driver *net_drv_obj = &net_drv_ctx->drv_obj;
 342         struct vm_device *device_ctx = device_to_vm_device(device);
 343         struct hv_device *device_obj = &device_ctx->device_obj;
 344         struct net_device *net = NULL;
 345         struct net_device_context *net_device_ctx;
 346         struct netvsc_device_info device_info;
 347         int ret;
 348
 349         if (!net_drv_obj->Base.OnDeviceAdd)
 350                 return -1;
 351
 352         net = alloc_etherdev(sizeof(struct net_device_context));
 353         if (!net)
 354                 return -1;
 355
 356         /* Set initial state */
 357         netif_carrier_off(net);
 358         netif_stop_queue(net);
 359
 360         net_device_ctx = netdev_priv(net);
 361         net_device_ctx->device_ctx = device_ctx;
 362         net_device_ctx->avail = ring_size;
 363         dev_set_drvdata(device, net);
 364
 365         /* Notify the netvsc driver of the new device */
 366         ret = net_drv_obj->Base.OnDeviceAdd(device_obj, &device_info);
 367         if (ret != 0) {
 368                 free_netdev(net);
 369                 dev_set_drvdata(device, NULL);
 370
 371                 DPRINT_ERR(NETVSC_DRV, "unable to add netvsc device (ret %d)",
 372                            ret);
 373                 return ret;
 374         }
 375
 376         /*
 377          * If carrier is still off ie we did not get a link status callback,
 378          * update it if necessary
 379          */
 380         /*
 381          * FIXME: We should use a atomic or test/set instead to avoid getting
 382          * out of sync with the device's link status
 383          */
 384         if (!netif_carrier_ok(net))
 385                 if (!device_info.LinkState)
 386                         netif_carrier_on(net);
 387
 388         memcpy(net->dev_addr, device_info.MacAddr, ETH_ALEN);
 389
 390         net->netdev_ops = &device_ops;
 391
 392         /* TODO: Add GSO and Checksum offload */
 393         net->features = NETIF_F_SG;
 394
 395         SET_ETHTOOL_OPS(net, &ethtool_ops);
 396         SET_NETDEV_DEV(net, device);
 397
 398         ret = register_netdev(net);
 399         if (ret != 0) {
 400                 /* Remove the device and release the resource */
 401                 net_drv_obj->Base.OnDeviceRemove(device_obj);
 402                 free_netdev(net);
 403         }
 404
 405         return ret;
 406 }
 407
 408 static int netvsc_remove(struct device *device)
 409 {
 410         struct driver_context *driver_ctx =
 411                 driver_to_driver_context(device->driver);
 412         struct netvsc_driver_context *net_drv_ctx =
 413                 (struct netvsc_driver_context *)driver_ctx;
 414         struct netvsc_driver *net_drv_obj = &net_drv_ctx->drv_obj;
 415         struct vm_device *device_ctx = device_to_vm_device(device);
 416         struct net_device *net = dev_get_drvdata(&device_ctx->device);
 417         struct hv_device *device_obj = &device_ctx->device_obj;
 418         int ret;
 419
 420         if (net == NULL) {
 421                 DPRINT_INFO(NETVSC, "no net device to remove");
 422                 return 0;
 423         }
 424
 425         if (!net_drv_obj->Base.OnDeviceRemove)
 426                 return -1;
 427
 428         /* Stop outbound asap */
 429         netif_stop_queue(net);
 430         /* netif_carrier_off(net); */
 431
 432         unregister_netdev(net);
 433
 434         /*
 435          * Call to the vsc driver to let it know that the device is being
 436          * removed
 437          */
 438         ret = net_drv_obj->Base.OnDeviceRemove(device_obj);
 439         if (ret != 0) {
 440                 /* TODO: */
 441                 DPRINT_ERR(NETVSC, "unable to remove vsc device (ret %d)", ret);
 442         }
 443
 444         free_netdev(net);
 445         return ret;
 446 }
 447
 448 static int netvsc_drv_exit_cb(struct device *dev, void *data)
 449 {
 450         struct device **curr = (struct device **)data;
 451
 452         *curr = dev;
 453         /* stop iterating */
 454         return 1;
 455 }
 456
 457 static void netvsc_drv_exit(void)
 458 {
 459         struct netvsc_driver *netvsc_drv_obj = &g_netvsc_drv.drv_obj;
 460         struct driver_context *drv_ctx = &g_netvsc_drv.drv_ctx;
 461         struct device *current_dev;
 462         int ret;
 463
 464         while (1) {
 465                 current_dev = NULL;
 466
 467                 /* Get the device */
 468                 ret = driver_for_each_device(&drv_ctx->driver, NULL,
 469                                              &current_dev, netvsc_drv_exit_cb);
 470                 if (ret)
 471                         DPRINT_WARN(NETVSC_DRV,
 472                                     "driver_for_each_device returned %d", ret);
 473
 474                 if (current_dev == NULL)
 475                         break;
 476
 477                 /* Initiate removal from the top-down */
 478                 DPRINT_INFO(NETVSC_DRV, "unregistering device (%p)...",
 479                             current_dev);
 480
 481                 device_unregister(current_dev);
 482         }
 483
 484         if (netvsc_drv_obj->Base.OnCleanup)
 485                 netvsc_drv_obj->Base.OnCleanup(&netvsc_drv_obj->Base);
 486
 487         vmbus_child_driver_unregister(drv_ctx);
 488
 489         return;
 490 }
 491
 492 static int netvsc_drv_init(int (*drv_init)(struct hv_driver *drv))
 493 {
 494         struct netvsc_driver *net_drv_obj = &g_netvsc_drv.drv_obj;
 495         struct driver_context *drv_ctx = &g_netvsc_drv.drv_ctx;
 496         int ret;
 497
 498         net_drv_obj->RingBufferSize = ring_size * PAGE_SIZE;
 499         net_drv_obj->OnReceiveCallback = netvsc_recv_callback;
 500         net_drv_obj->OnLinkStatusChanged = netvsc_linkstatus_callback;
 501
 502         /* Callback to client driver to complete the initialization */
 503         drv_init(&net_drv_obj->Base);
 504
 505         drv_ctx->driver.name = net_drv_obj->Base.name;
 506         memcpy(&drv_ctx->class_id, &net_drv_obj->Base.deviceType,
 507                sizeof(struct hv_guid));
 508
 509         drv_ctx->probe = netvsc_probe;
 510         drv_ctx->remove = netvsc_remove;
 511
 512         /* The driver belongs to vmbus */
 513         ret = vmbus_child_driver_register(drv_ctx);
 514
 515         return ret;
 516 }
 517
 518 static const struct dmi_system_id __initconst
 519 hv_netvsc_dmi_table[] __maybe_unused  = {
 520         {
 521                 .ident = "Hyper-V",
 522                 .matches = {
 523                         DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
 524                         DMI_MATCH(DMI_PRODUCT_NAME, "Virtual Machine"),
 525                         DMI_MATCH(DMI_BOARD_NAME, "Virtual Machine"),
 526                 },
 527         },
 528         { },
 529 };
 530 MODULE_DEVICE_TABLE(dmi, hv_netvsc_dmi_table);
 531
 532 static int __init netvsc_init(void)
 533 {
 534         DPRINT_INFO(NETVSC_DRV, "Netvsc initializing....");
 535
 536         if (!dmi_check_system(hv_netvsc_dmi_table))
 537                 return -ENODEV;
 538
 539         return netvsc_drv_init(NetVscInitialize);
 540 }
 541
 542 static void __exit netvsc_exit(void)
 543 {
 544         netvsc_drv_exit();
 545 }
 546
 547 static const struct pci_device_id __initconst
 548 hv_netvsc_pci_table[] __maybe_unused = {
 549         { PCI_DEVICE(0x1414, 0x5353) }, /* VGA compatible controller */
 550         { 0 }
 551 };
 552 MODULE_DEVICE_TABLE(pci, hv_netvsc_pci_table);
 553
 554 MODULE_LICENSE("GPL");
 555 MODULE_VERSION(HV_DRV_VERSION);
 556 MODULE_DESCRIPTION("Microsoft Hyper-V network driver");
 557
 558 module_init(netvsc_init);
 559 module_exit(netvsc_exit);