drivers/net/usb/ipheth.c

   1 /*
   2  * ipheth.c - Apple iPhone USB Ethernet driver
   3  *
   4  * Copyright (c) 2009 Diego Giagio <diego@giagio.com>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of GIAGIO.COM nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * Alternatively, provided that this notice is retained in full, this
  20  * software may be distributed under the terms of the GNU General
  21  * Public License ("GPL") version 2, in which case the provisions of the
  22  * GPL apply INSTEAD OF those given above.
  23  *
  24  * The provided data structures and external interfaces from this code
  25  * are not restricted to be used by modules with a GPL compatible license.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  30  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  31  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  32  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  33  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  34  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  35  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  36  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  37  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  38  * DAMAGE.
  39  *
  40  *
  41  * Attention: iPhone device must be paired, otherwise it won't respond to our
  42  * driver. For more info: http://giagio.com/wiki/moin.cgi/iPhoneEthernetDriver
  43  *
  44  */
  45
  46 #include <linux/kernel.h>
  47 #include <linux/errno.h>
  48 #include <linux/init.h>
  49 #include <linux/slab.h>
  50 #include <linux/module.h>
  51 #include <linux/netdevice.h>
  52 #include <linux/etherdevice.h>
  53 #include <linux/ethtool.h>
  54 #include <linux/usb.h>
  55 #include <linux/workqueue.h>
  56
  57 #define USB_VENDOR_APPLE        0x05ac
  58 #define USB_PRODUCT_IPHONE      0x1290
  59 #define USB_PRODUCT_IPHONE_3G   0x1292
  60 #define USB_PRODUCT_IPHONE_3GS  0x1294
  61 #define USB_PRODUCT_IPHONE_4    0x1297
  62 #define USB_PRODUCT_IPAD 0x129a
  63 #define USB_PRODUCT_IPHONE_4_VZW 0x129c
  64 #define USB_PRODUCT_IPHONE_4S   0x12a0
  65 #define USB_PRODUCT_IPHONE_5    0x12a8
  66
  67 #define IPHETH_USBINTF_CLASS    255
  68 #define IPHETH_USBINTF_SUBCLASS 253
  69 #define IPHETH_USBINTF_PROTO    1
  70
  71 #define IPHETH_BUF_SIZE         1516
  72 #define IPHETH_IP_ALIGN         2       /* padding at front of URB */
  73 #define IPHETH_TX_TIMEOUT       (5 * HZ)
  74
  75 #define IPHETH_INTFNUM          2
  76 #define IPHETH_ALT_INTFNUM      1
  77
  78 #define IPHETH_CTRL_ENDP        0x00
  79 #define IPHETH_CTRL_BUF_SIZE    0x40
  80 #define IPHETH_CTRL_TIMEOUT     (5 * HZ)
  81
  82 #define IPHETH_CMD_GET_MACADDR   0x00
  83 #define IPHETH_CMD_CARRIER_CHECK 0x45
  84
  85 #define IPHETH_CARRIER_CHECK_TIMEOUT round_jiffies_relative(1 * HZ)
  86 #define IPHETH_CARRIER_ON       0x04
  87
  88 static struct usb_device_id ipheth_table[] = {
  89         { USB_DEVICE_AND_INTERFACE_INFO(
  90                 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE,
  91                 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
  92                 IPHETH_USBINTF_PROTO) },
  93         { USB_DEVICE_AND_INTERFACE_INFO(
  94                 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_3G,
  95                 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
  96                 IPHETH_USBINTF_PROTO) },
  97         { USB_DEVICE_AND_INTERFACE_INFO(
  98                 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_3GS,
  99                 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
 100                 IPHETH_USBINTF_PROTO) },
 101         { USB_DEVICE_AND_INTERFACE_INFO(
 102                 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_4,
 103                 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
 104                 IPHETH_USBINTF_PROTO) },
 105         { USB_DEVICE_AND_INTERFACE_INFO(
 106                 USB_VENDOR_APPLE, USB_PRODUCT_IPAD,
 107                 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
 108                 IPHETH_USBINTF_PROTO) },
 109         { USB_DEVICE_AND_INTERFACE_INFO(
 110                 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_4_VZW,
 111                 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
 112                 IPHETH_USBINTF_PROTO) },
 113         { USB_DEVICE_AND_INTERFACE_INFO(
 114                 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_4S,
 115                 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
 116                 IPHETH_USBINTF_PROTO) },
 117         { USB_DEVICE_AND_INTERFACE_INFO(
 118                 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_5,
 119                 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
 120                 IPHETH_USBINTF_PROTO) },
 121         { }
 122 };
 123 MODULE_DEVICE_TABLE(usb, ipheth_table);
 124
 125 struct ipheth_device {
 126         struct usb_device *udev;
 127         struct usb_interface *intf;
 128         struct net_device *net;
 129         struct sk_buff *tx_skb;
 130         struct urb *tx_urb;
 131         struct urb *rx_urb;
 132         unsigned char *tx_buf;
 133         unsigned char *rx_buf;
 134         unsigned char *ctrl_buf;
 135         u8 bulk_in;
 136         u8 bulk_out;
 137         struct delayed_work carrier_work;
 138 };
 139
 140 static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags);
 141
 142 static int ipheth_alloc_urbs(struct ipheth_device *iphone)
 143 {
 144         struct urb *tx_urb = NULL;
 145         struct urb *rx_urb = NULL;
 146         u8 *tx_buf = NULL;
 147         u8 *rx_buf = NULL;
 148
 149         tx_urb = usb_alloc_urb(0, GFP_KERNEL);
 150         if (tx_urb == NULL)
 151                 goto error_nomem;
 152
 153         rx_urb = usb_alloc_urb(0, GFP_KERNEL);
 154         if (rx_urb == NULL)
 155                 goto free_tx_urb;
 156
 157         tx_buf = usb_alloc_coherent(iphone->udev, IPHETH_BUF_SIZE,
 158                                     GFP_KERNEL, &tx_urb->transfer_dma);
 159         if (tx_buf == NULL)
 160                 goto free_rx_urb;
 161
 162         rx_buf = usb_alloc_coherent(iphone->udev, IPHETH_BUF_SIZE,
 163                                     GFP_KERNEL, &rx_urb->transfer_dma);
 164         if (rx_buf == NULL)
 165                 goto free_tx_buf;
 166
 167
 168         iphone->tx_urb = tx_urb;
 169         iphone->rx_urb = rx_urb;
 170         iphone->tx_buf = tx_buf;
 171         iphone->rx_buf = rx_buf;
 172         return 0;
 173
 174 free_tx_buf:
 175         usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, tx_buf,
 176                           tx_urb->transfer_dma);
 177 free_rx_urb:
 178         usb_free_urb(rx_urb);
 179 free_tx_urb:
 180         usb_free_urb(tx_urb);
 181 error_nomem:
 182         return -ENOMEM;
 183 }
 184
 185 static void ipheth_free_urbs(struct ipheth_device *iphone)
 186 {
 187         usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, iphone->rx_buf,
 188                           iphone->rx_urb->transfer_dma);
 189         usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, iphone->tx_buf,
 190                           iphone->tx_urb->transfer_dma);
 191         usb_free_urb(iphone->rx_urb);
 192         usb_free_urb(iphone->tx_urb);
 193 }
 194
 195 static void ipheth_kill_urbs(struct ipheth_device *dev)
 196 {
 197         usb_kill_urb(dev->tx_urb);
 198         usb_kill_urb(dev->rx_urb);
 199 }
 200
 201 static void ipheth_rcvbulk_callback(struct urb *urb)
 202 {
 203         struct ipheth_device *dev;
 204         struct sk_buff *skb;
 205         int status;
 206         char *buf;
 207         int len;
 208
 209         dev = urb->context;
 210         if (dev == NULL)
 211                 return;
 212
 213         status = urb->status;
 214         switch (status) {
 215         case -ENOENT:
 216         case -ECONNRESET:
 217         case -ESHUTDOWN:
 218                 return;
 219         case 0:
 220                 break;
 221         default:
 222                 err("%s: urb status: %d", __func__, status);
 223                 return;
 224         }
 225
 226         if (urb->actual_length <= IPHETH_IP_ALIGN) {
 227                 dev->net->stats.rx_length_errors++;
 228                 return;
 229         }
 230         len = urb->actual_length - IPHETH_IP_ALIGN;
 231         buf = urb->transfer_buffer + IPHETH_IP_ALIGN;
 232
 233         skb = dev_alloc_skb(len);
 234         if (!skb) {
 235                 err("%s: dev_alloc_skb: -ENOMEM", __func__);
 236                 dev->net->stats.rx_dropped++;
 237                 return;
 238         }
 239
 240         memcpy(skb_put(skb, len), buf, len);
 241         skb->dev = dev->net;
 242         skb->protocol = eth_type_trans(skb, dev->net);
 243
 244         dev->net->stats.rx_packets++;
 245         dev->net->stats.rx_bytes += len;
 246
 247         netif_rx(skb);
 248         ipheth_rx_submit(dev, GFP_ATOMIC);
 249 }
 250
 251 static void ipheth_sndbulk_callback(struct urb *urb)
 252 {
 253         struct ipheth_device *dev;
 254         int status = urb->status;
 255
 256         dev = urb->context;
 257         if (dev == NULL)
 258                 return;
 259
 260         if (status != 0 &&
 261             status != -ENOENT &&
 262             status != -ECONNRESET &&
 263             status != -ESHUTDOWN)
 264                 err("%s: urb status: %d", __func__, status);
 265
 266         dev_kfree_skb_irq(dev->tx_skb);
 267         netif_wake_queue(dev->net);
 268 }
 269
 270 static int ipheth_carrier_set(struct ipheth_device *dev)
 271 {
 272         struct usb_device *udev = dev->udev;
 273         int retval;
 274
 275         retval = usb_control_msg(udev,
 276                         usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
 277                         IPHETH_CMD_CARRIER_CHECK, /* request */
 278                         0xc0, /* request type */
 279                         0x00, /* value */
 280                         0x02, /* index */
 281                         dev->ctrl_buf, IPHETH_CTRL_BUF_SIZE,
 282                         IPHETH_CTRL_TIMEOUT);
 283         if (retval < 0) {
 284                 err("%s: usb_control_msg: %d", __func__, retval);
 285                 return retval;
 286         }
 287
 288         if (dev->ctrl_buf[0] == IPHETH_CARRIER_ON)
 289                 netif_carrier_on(dev->net);
 290         else
 291                 netif_carrier_off(dev->net);
 292
 293         return 0;
 294 }
 295
 296 static void ipheth_carrier_check_work(struct work_struct *work)
 297 {
 298         struct ipheth_device *dev = container_of(work, struct ipheth_device,
 299                                                  carrier_work.work);
 300
 301         ipheth_carrier_set(dev);
 302         schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
 303 }
 304
 305 static int ipheth_get_macaddr(struct ipheth_device *dev)
 306 {
 307         struct usb_device *udev = dev->udev;
 308         struct net_device *net = dev->net;
 309         int retval;
 310
 311         retval = usb_control_msg(udev,
 312                                  usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
 313                                  IPHETH_CMD_GET_MACADDR, /* request */
 314                                  0xc0, /* request type */
 315                                  0x00, /* value */
 316                                  0x02, /* index */
 317                                  dev->ctrl_buf,
 318                                  IPHETH_CTRL_BUF_SIZE,
 319                                  IPHETH_CTRL_TIMEOUT);
 320         if (retval < 0) {
 321                 err("%s: usb_control_msg: %d", __func__, retval);
 322         } else if (retval < ETH_ALEN) {
 323                 err("%s: usb_control_msg: short packet: %d bytes",
 324                         __func__, retval);
 325                 retval = -EINVAL;
 326         } else {
 327                 memcpy(net->dev_addr, dev->ctrl_buf, ETH_ALEN);
 328                 retval = 0;
 329         }
 330
 331         return retval;
 332 }
 333
 334 static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags)
 335 {
 336         struct usb_device *udev = dev->udev;
 337         int retval;
 338
 339         usb_fill_bulk_urb(dev->rx_urb, udev,
 340                           usb_rcvbulkpipe(udev, dev->bulk_in),
 341                           dev->rx_buf, IPHETH_BUF_SIZE,
 342                           ipheth_rcvbulk_callback,
 343                           dev);
 344         dev->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 345
 346         retval = usb_submit_urb(dev->rx_urb, mem_flags);
 347         if (retval)
 348                 err("%s: usb_submit_urb: %d", __func__, retval);
 349         return retval;
 350 }
 351
 352 static int ipheth_open(struct net_device *net)
 353 {
 354         struct ipheth_device *dev = netdev_priv(net);
 355         struct usb_device *udev = dev->udev;
 356         int retval = 0;
 357
 358         usb_set_interface(udev, IPHETH_INTFNUM, IPHETH_ALT_INTFNUM);
 359
 360         retval = ipheth_carrier_set(dev);
 361         if (retval)
 362                 return retval;
 363
 364         retval = ipheth_rx_submit(dev, GFP_KERNEL);
 365         if (retval)
 366                 return retval;
 367
 368         schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
 369         netif_start_queue(net);
 370         return retval;
 371 }
 372
 373 static int ipheth_close(struct net_device *net)
 374 {
 375         struct ipheth_device *dev = netdev_priv(net);
 376
 377         cancel_delayed_work_sync(&dev->carrier_work);
 378         netif_stop_queue(net);
 379         return 0;
 380 }
 381
 382 static int ipheth_tx(struct sk_buff *skb, struct net_device *net)
 383 {
 384         struct ipheth_device *dev = netdev_priv(net);
 385         struct usb_device *udev = dev->udev;
 386         int retval;
 387
 388         /* Paranoid */
 389         if (skb->len > IPHETH_BUF_SIZE) {
 390                 WARN(1, "%s: skb too large: %d bytes\n", __func__, skb->len);
 391                 dev->net->stats.tx_dropped++;
 392                 dev_kfree_skb_irq(skb);
 393                 return NETDEV_TX_OK;
 394         }
 395
 396         memcpy(dev->tx_buf, skb->data, skb->len);
 397         if (skb->len < IPHETH_BUF_SIZE)
 398                 memset(dev->tx_buf + skb->len, 0, IPHETH_BUF_SIZE - skb->len);
 399
 400         usb_fill_bulk_urb(dev->tx_urb, udev,
 401                           usb_sndbulkpipe(udev, dev->bulk_out),
 402                           dev->tx_buf, IPHETH_BUF_SIZE,
 403                           ipheth_sndbulk_callback,
 404                           dev);
 405         dev->tx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 406
 407         retval = usb_submit_urb(dev->tx_urb, GFP_ATOMIC);
 408         if (retval) {
 409                 err("%s: usb_submit_urb: %d", __func__, retval);
 410                 dev->net->stats.tx_errors++;
 411                 dev_kfree_skb_irq(skb);
 412         } else {
 413                 dev->tx_skb = skb;
 414
 415                 dev->net->stats.tx_packets++;
 416                 dev->net->stats.tx_bytes += skb->len;
 417                 netif_stop_queue(net);
 418         }
 419
 420         return NETDEV_TX_OK;
 421 }
 422
 423 static void ipheth_tx_timeout(struct net_device *net)
 424 {
 425         struct ipheth_device *dev = netdev_priv(net);
 426
 427         err("%s: TX timeout", __func__);
 428         dev->net->stats.tx_errors++;
 429         usb_unlink_urb(dev->tx_urb);
 430 }
 431
 432 static u32 ipheth_ethtool_op_get_link(struct net_device *net)
 433 {
 434         struct ipheth_device *dev = netdev_priv(net);
 435         return netif_carrier_ok(dev->net);
 436 }
 437
 438 static struct ethtool_ops ops = {
 439         .get_link = ipheth_ethtool_op_get_link
 440 };
 441
 442 static const struct net_device_ops ipheth_netdev_ops = {
 443         .ndo_open = ipheth_open,
 444         .ndo_stop = ipheth_close,
 445         .ndo_start_xmit = ipheth_tx,
 446         .ndo_tx_timeout = ipheth_tx_timeout,
 447 };
 448
 449 static int ipheth_probe(struct usb_interface *intf,
 450                         const struct usb_device_id *id)
 451 {
 452         struct usb_device *udev = interface_to_usbdev(intf);
 453         struct usb_host_interface *hintf;
 454         struct usb_endpoint_descriptor *endp;
 455         struct ipheth_device *dev;
 456         struct net_device *netdev;
 457         int i;
 458         int retval;
 459
 460         netdev = alloc_etherdev(sizeof(struct ipheth_device));
 461         if (!netdev)
 462                 return -ENOMEM;
 463
 464         netdev->netdev_ops = &ipheth_netdev_ops;
 465         netdev->watchdog_timeo = IPHETH_TX_TIMEOUT;
 466         strcpy(netdev->name, "eth%d");
 467
 468         dev = netdev_priv(netdev);
 469         dev->udev = udev;
 470         dev->net = netdev;
 471         dev->intf = intf;
 472
 473         /* Set up endpoints */
 474         hintf = usb_altnum_to_altsetting(intf, IPHETH_ALT_INTFNUM);
 475         if (hintf == NULL) {
 476                 retval = -ENODEV;
 477                 err("Unable to find alternate settings interface");
 478                 goto err_endpoints;
 479         }
 480
 481         for (i = 0; i < hintf->desc.bNumEndpoints; i++) {
 482                 endp = &hintf->endpoint[i].desc;
 483                 if (usb_endpoint_is_bulk_in(endp))
 484                         dev->bulk_in = endp->bEndpointAddress;
 485                 else if (usb_endpoint_is_bulk_out(endp))
 486                         dev->bulk_out = endp->bEndpointAddress;
 487         }
 488         if (!(dev->bulk_in && dev->bulk_out)) {
 489                 retval = -ENODEV;
 490                 err("Unable to find endpoints");
 491                 goto err_endpoints;
 492         }
 493
 494         dev->ctrl_buf = kmalloc(IPHETH_CTRL_BUF_SIZE, GFP_KERNEL);
 495         if (dev->ctrl_buf == NULL) {
 496                 retval = -ENOMEM;
 497                 goto err_alloc_ctrl_buf;
 498         }
 499
 500         retval = ipheth_get_macaddr(dev);
 501         if (retval)
 502                 goto err_get_macaddr;
 503
 504         INIT_DELAYED_WORK(&dev->carrier_work, ipheth_carrier_check_work);
 505
 506         retval = ipheth_alloc_urbs(dev);
 507         if (retval) {
 508                 err("error allocating urbs: %d", retval);
 509                 goto err_alloc_urbs;
 510         }
 511
 512         usb_set_intfdata(intf, dev);
 513
 514         SET_NETDEV_DEV(netdev, &intf->dev);
 515         SET_ETHTOOL_OPS(netdev, &ops);
 516
 517         retval = register_netdev(netdev);
 518         if (retval) {
 519                 err("error registering netdev: %d", retval);
 520                 retval = -EIO;
 521                 goto err_register_netdev;
 522         }
 523
 524         dev_info(&intf->dev, "Apple iPhone USB Ethernet device attached\n");
 525         return 0;
 526
 527 err_register_netdev:
 528         ipheth_free_urbs(dev);
 529 err_alloc_urbs:
 530 err_get_macaddr:
 531 err_alloc_ctrl_buf:
 532         kfree(dev->ctrl_buf);
 533 err_endpoints:
 534         free_netdev(netdev);
 535         return retval;
 536 }
 537
 538 static void ipheth_disconnect(struct usb_interface *intf)
 539 {
 540         struct ipheth_device *dev;
 541
 542         dev = usb_get_intfdata(intf);
 543         if (dev != NULL) {
 544                 unregister_netdev(dev->net);
 545                 ipheth_kill_urbs(dev);
 546                 ipheth_free_urbs(dev);
 547                 kfree(dev->ctrl_buf);
 548                 free_netdev(dev->net);
 549         }
 550         usb_set_intfdata(intf, NULL);
 551         dev_info(&intf->dev, "Apple iPhone USB Ethernet now disconnected\n");
 552 }
 553
 554 static struct usb_driver ipheth_driver = {
 555         .name =         "ipheth",
 556         .probe =        ipheth_probe,
 557         .disconnect =   ipheth_disconnect,
 558         .id_table =     ipheth_table,
 559 };
 560
 561 static int __init ipheth_init(void)
 562 {
 563         int retval;
 564
 565         retval = usb_register(&ipheth_driver);
 566         if (retval) {
 567                 err("usb_register failed: %d", retval);
 568                 return retval;
 569         }
 570         return 0;
 571 }
 572
 573 static void __exit ipheth_exit(void)
 574 {
 575         usb_deregister(&ipheth_driver);
 576 }
 577
 578 module_init(ipheth_init);
 579 module_exit(ipheth_exit);
 580
 581 MODULE_AUTHOR("Diego Giagio <diego@giagio.com>");
 582 MODULE_DESCRIPTION("Apple iPhone USB Ethernet driver");
 583 MODULE_LICENSE("Dual BSD/GPL");