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_IPAD_MINI 0x12ab 64 #define USB_PRODUCT_IPHONE_4_VZW 0x129c 65 #define USB_PRODUCT_IPHONE_4S 0x12a0 66 #define USB_PRODUCT_IPHONE_5 0x12a8 67 68 #define IPHETH_USBINTF_CLASS 255 69 #define IPHETH_USBINTF_SUBCLASS 253 70 #define IPHETH_USBINTF_PROTO 1 71 72 #define IPHETH_BUF_SIZE 1516 73 #define IPHETH_IP_ALIGN 2 /* padding at front of URB */ 74 #define IPHETH_TX_TIMEOUT (5 * HZ) 75 76 #define IPHETH_INTFNUM 2 77 #define IPHETH_ALT_INTFNUM 1 78 79 #define IPHETH_CTRL_ENDP 0x00 80 #define IPHETH_CTRL_BUF_SIZE 0x40 81 #define IPHETH_CTRL_TIMEOUT (5 * HZ) 82 83 #define IPHETH_CMD_GET_MACADDR 0x00 84 #define IPHETH_CMD_CARRIER_CHECK 0x45 85 86 #define IPHETH_CARRIER_CHECK_TIMEOUT round_jiffies_relative(1 * HZ) 87 #define IPHETH_CARRIER_ON 0x04 88 89 static struct usb_device_id ipheth_table[] = { 90 { USB_DEVICE_AND_INTERFACE_INFO( 91 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE, 92 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS, 93 IPHETH_USBINTF_PROTO) }, 94 { USB_DEVICE_AND_INTERFACE_INFO( 95 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_3G, 96 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS, 97 IPHETH_USBINTF_PROTO) }, 98 { USB_DEVICE_AND_INTERFACE_INFO( 99 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_3GS, 100 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS, 101 IPHETH_USBINTF_PROTO) }, 102 { USB_DEVICE_AND_INTERFACE_INFO( 103 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_4, 104 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS, 105 IPHETH_USBINTF_PROTO) }, 106 { USB_DEVICE_AND_INTERFACE_INFO( 107 USB_VENDOR_APPLE, USB_PRODUCT_IPAD, 108 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS, 109 IPHETH_USBINTF_PROTO) }, 110 { USB_DEVICE_AND_INTERFACE_INFO( 111 USB_VENDOR_APPLE, USB_PRODUCT_IPAD_MINI, 112 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS, 113 IPHETH_USBINTF_PROTO) }, 114 { USB_DEVICE_AND_INTERFACE_INFO( 115 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_4_VZW, 116 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS, 117 IPHETH_USBINTF_PROTO) }, 118 { USB_DEVICE_AND_INTERFACE_INFO( 119 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_4S, 120 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS, 121 IPHETH_USBINTF_PROTO) }, 122 { USB_DEVICE_AND_INTERFACE_INFO( 123 USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_5, 124 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS, 125 IPHETH_USBINTF_PROTO) }, 126 { } 127 }; 128 MODULE_DEVICE_TABLE(usb, ipheth_table); 129 130 struct ipheth_device { 131 struct usb_device *udev; 132 struct usb_interface *intf; 133 struct net_device *net; 134 struct sk_buff *tx_skb; 135 struct urb *tx_urb; 136 struct urb *rx_urb; 137 unsigned char *tx_buf; 138 unsigned char *rx_buf; 139 unsigned char *ctrl_buf; 140 u8 bulk_in; 141 u8 bulk_out; 142 struct delayed_work carrier_work; 143 }; 144 145 static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags); 146 147 static int ipheth_alloc_urbs(struct ipheth_device *iphone) 148 { 149 struct urb *tx_urb = NULL; 150 struct urb *rx_urb = NULL; 151 u8 *tx_buf = NULL; 152 u8 *rx_buf = NULL; 153 154 tx_urb = usb_alloc_urb(0, GFP_KERNEL); 155 if (tx_urb == NULL) 156 goto error_nomem; 157 158 rx_urb = usb_alloc_urb(0, GFP_KERNEL); 159 if (rx_urb == NULL) 160 goto free_tx_urb; 161 162 tx_buf = usb_alloc_coherent(iphone->udev, IPHETH_BUF_SIZE, 163 GFP_KERNEL, &tx_urb->transfer_dma); 164 if (tx_buf == NULL) 165 goto free_rx_urb; 166 167 rx_buf = usb_alloc_coherent(iphone->udev, IPHETH_BUF_SIZE, 168 GFP_KERNEL, &rx_urb->transfer_dma); 169 if (rx_buf == NULL) 170 goto free_tx_buf; 171 172 173 iphone->tx_urb = tx_urb; 174 iphone->rx_urb = rx_urb; 175 iphone->tx_buf = tx_buf; 176 iphone->rx_buf = rx_buf; 177 return 0; 178 179 free_tx_buf: 180 usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, tx_buf, 181 tx_urb->transfer_dma); 182 free_rx_urb: 183 usb_free_urb(rx_urb); 184 free_tx_urb: 185 usb_free_urb(tx_urb); 186 error_nomem: 187 return -ENOMEM; 188 } 189 190 static void ipheth_free_urbs(struct ipheth_device *iphone) 191 { 192 usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, iphone->rx_buf, 193 iphone->rx_urb->transfer_dma); 194 usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, iphone->tx_buf, 195 iphone->tx_urb->transfer_dma); 196 usb_free_urb(iphone->rx_urb); 197 usb_free_urb(iphone->tx_urb); 198 } 199 200 static void ipheth_kill_urbs(struct ipheth_device *dev) 201 { 202 usb_kill_urb(dev->tx_urb); 203 usb_kill_urb(dev->rx_urb); 204 } 205 206 static void ipheth_rcvbulk_callback(struct urb *urb) 207 { 208 struct ipheth_device *dev; 209 struct sk_buff *skb; 210 int status; 211 char *buf; 212 int len; 213 214 dev = urb->context; 215 if (dev == NULL) 216 return; 217 218 status = urb->status; 219 switch (status) { 220 case -ENOENT: 221 case -ECONNRESET: 222 case -ESHUTDOWN: 223 return; 224 case 0: 225 break; 226 default: 227 dev_err(&dev->intf->dev, "%s: urb status: %d\n", 228 __func__, status); 229 return; 230 } 231 232 if (urb->actual_length <= IPHETH_IP_ALIGN) { 233 dev->net->stats.rx_length_errors++; 234 return; 235 } 236 len = urb->actual_length - IPHETH_IP_ALIGN; 237 buf = urb->transfer_buffer + IPHETH_IP_ALIGN; 238 239 skb = dev_alloc_skb(len); 240 if (!skb) { 241 dev_err(&dev->intf->dev, "%s: dev_alloc_skb: -ENOMEM\n", 242 __func__); 243 dev->net->stats.rx_dropped++; 244 return; 245 } 246 247 memcpy(skb_put(skb, len), buf, len); 248 skb->dev = dev->net; 249 skb->protocol = eth_type_trans(skb, dev->net); 250 251 dev->net->stats.rx_packets++; 252 dev->net->stats.rx_bytes += len; 253 254 netif_rx(skb); 255 ipheth_rx_submit(dev, GFP_ATOMIC); 256 } 257 258 static void ipheth_sndbulk_callback(struct urb *urb) 259 { 260 struct ipheth_device *dev; 261 int status = urb->status; 262 263 dev = urb->context; 264 if (dev == NULL) 265 return; 266 267 if (status != 0 && 268 status != -ENOENT && 269 status != -ECONNRESET && 270 status != -ESHUTDOWN) 271 dev_err(&dev->intf->dev, "%s: urb status: %d\n", 272 __func__, status); 273 274 dev_kfree_skb_irq(dev->tx_skb); 275 netif_wake_queue(dev->net); 276 } 277 278 static int ipheth_carrier_set(struct ipheth_device *dev) 279 { 280 struct usb_device *udev = dev->udev; 281 int retval; 282 283 retval = usb_control_msg(udev, 284 usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP), 285 IPHETH_CMD_CARRIER_CHECK, /* request */ 286 0xc0, /* request type */ 287 0x00, /* value */ 288 0x02, /* index */ 289 dev->ctrl_buf, IPHETH_CTRL_BUF_SIZE, 290 IPHETH_CTRL_TIMEOUT); 291 if (retval < 0) { 292 dev_err(&dev->intf->dev, "%s: usb_control_msg: %d\n", 293 __func__, retval); 294 return retval; 295 } 296 297 if (dev->ctrl_buf[0] == IPHETH_CARRIER_ON) 298 netif_carrier_on(dev->net); 299 else 300 netif_carrier_off(dev->net); 301 302 return 0; 303 } 304 305 static void ipheth_carrier_check_work(struct work_struct *work) 306 { 307 struct ipheth_device *dev = container_of(work, struct ipheth_device, 308 carrier_work.work); 309 310 ipheth_carrier_set(dev); 311 schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT); 312 } 313 314 static int ipheth_get_macaddr(struct ipheth_device *dev) 315 { 316 struct usb_device *udev = dev->udev; 317 struct net_device *net = dev->net; 318 int retval; 319 320 retval = usb_control_msg(udev, 321 usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP), 322 IPHETH_CMD_GET_MACADDR, /* request */ 323 0xc0, /* request type */ 324 0x00, /* value */ 325 0x02, /* index */ 326 dev->ctrl_buf, 327 IPHETH_CTRL_BUF_SIZE, 328 IPHETH_CTRL_TIMEOUT); 329 if (retval < 0) { 330 dev_err(&dev->intf->dev, "%s: usb_control_msg: %d\n", 331 __func__, retval); 332 } else if (retval < ETH_ALEN) { 333 dev_err(&dev->intf->dev, 334 "%s: usb_control_msg: short packet: %d bytes\n", 335 __func__, retval); 336 retval = -EINVAL; 337 } else { 338 memcpy(net->dev_addr, dev->ctrl_buf, ETH_ALEN); 339 retval = 0; 340 } 341 342 return retval; 343 } 344 345 static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags) 346 { 347 struct usb_device *udev = dev->udev; 348 int retval; 349 350 usb_fill_bulk_urb(dev->rx_urb, udev, 351 usb_rcvbulkpipe(udev, dev->bulk_in), 352 dev->rx_buf, IPHETH_BUF_SIZE, 353 ipheth_rcvbulk_callback, 354 dev); 355 dev->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 356 357 retval = usb_submit_urb(dev->rx_urb, mem_flags); 358 if (retval) 359 dev_err(&dev->intf->dev, "%s: usb_submit_urb: %d\n", 360 __func__, retval); 361 return retval; 362 } 363 364 static int ipheth_open(struct net_device *net) 365 { 366 struct ipheth_device *dev = netdev_priv(net); 367 struct usb_device *udev = dev->udev; 368 int retval = 0; 369 370 usb_set_interface(udev, IPHETH_INTFNUM, IPHETH_ALT_INTFNUM); 371 372 retval = ipheth_carrier_set(dev); 373 if (retval) 374 return retval; 375 376 retval = ipheth_rx_submit(dev, GFP_KERNEL); 377 if (retval) 378 return retval; 379 380 schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT); 381 netif_start_queue(net); 382 return retval; 383 } 384 385 static int ipheth_close(struct net_device *net) 386 { 387 struct ipheth_device *dev = netdev_priv(net); 388 389 cancel_delayed_work_sync(&dev->carrier_work); 390 netif_stop_queue(net); 391 return 0; 392 } 393 394 static int ipheth_tx(struct sk_buff *skb, struct net_device *net) 395 { 396 struct ipheth_device *dev = netdev_priv(net); 397 struct usb_device *udev = dev->udev; 398 int retval; 399 400 /* Paranoid */ 401 if (skb->len > IPHETH_BUF_SIZE) { 402 WARN(1, "%s: skb too large: %d bytes\n", __func__, skb->len); 403 dev->net->stats.tx_dropped++; 404 dev_kfree_skb_irq(skb); 405 return NETDEV_TX_OK; 406 } 407 408 memcpy(dev->tx_buf, skb->data, skb->len); 409 if (skb->len < IPHETH_BUF_SIZE) 410 memset(dev->tx_buf + skb->len, 0, IPHETH_BUF_SIZE - skb->len); 411 412 usb_fill_bulk_urb(dev->tx_urb, udev, 413 usb_sndbulkpipe(udev, dev->bulk_out), 414 dev->tx_buf, IPHETH_BUF_SIZE, 415 ipheth_sndbulk_callback, 416 dev); 417 dev->tx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 418 419 retval = usb_submit_urb(dev->tx_urb, GFP_ATOMIC); 420 if (retval) { 421 dev_err(&dev->intf->dev, "%s: usb_submit_urb: %d\n", 422 __func__, retval); 423 dev->net->stats.tx_errors++; 424 dev_kfree_skb_irq(skb); 425 } else { 426 dev->tx_skb = skb; 427 428 dev->net->stats.tx_packets++; 429 dev->net->stats.tx_bytes += skb->len; 430 netif_stop_queue(net); 431 } 432 433 return NETDEV_TX_OK; 434 } 435 436 static void ipheth_tx_timeout(struct net_device *net) 437 { 438 struct ipheth_device *dev = netdev_priv(net); 439 440 dev_err(&dev->intf->dev, "%s: TX timeout\n", __func__); 441 dev->net->stats.tx_errors++; 442 usb_unlink_urb(dev->tx_urb); 443 } 444 445 static u32 ipheth_ethtool_op_get_link(struct net_device *net) 446 { 447 struct ipheth_device *dev = netdev_priv(net); 448 return netif_carrier_ok(dev->net); 449 } 450 451 static const struct ethtool_ops ops = { 452 .get_link = ipheth_ethtool_op_get_link 453 }; 454 455 static const struct net_device_ops ipheth_netdev_ops = { 456 .ndo_open = ipheth_open, 457 .ndo_stop = ipheth_close, 458 .ndo_start_xmit = ipheth_tx, 459 .ndo_tx_timeout = ipheth_tx_timeout, 460 }; 461 462 static int ipheth_probe(struct usb_interface *intf, 463 const struct usb_device_id *id) 464 { 465 struct usb_device *udev = interface_to_usbdev(intf); 466 struct usb_host_interface *hintf; 467 struct usb_endpoint_descriptor *endp; 468 struct ipheth_device *dev; 469 struct net_device *netdev; 470 int i; 471 int retval; 472 473 netdev = alloc_etherdev(sizeof(struct ipheth_device)); 474 if (!netdev) 475 return -ENOMEM; 476 477 netdev->netdev_ops = &ipheth_netdev_ops; 478 netdev->watchdog_timeo = IPHETH_TX_TIMEOUT; 479 strcpy(netdev->name, "eth%d"); 480 481 dev = netdev_priv(netdev); 482 dev->udev = udev; 483 dev->net = netdev; 484 dev->intf = intf; 485 486 /* Set up endpoints */ 487 hintf = usb_altnum_to_altsetting(intf, IPHETH_ALT_INTFNUM); 488 if (hintf == NULL) { 489 retval = -ENODEV; 490 dev_err(&intf->dev, "Unable to find alternate settings interface\n"); 491 goto err_endpoints; 492 } 493 494 for (i = 0; i < hintf->desc.bNumEndpoints; i++) { 495 endp = &hintf->endpoint[i].desc; 496 if (usb_endpoint_is_bulk_in(endp)) 497 dev->bulk_in = endp->bEndpointAddress; 498 else if (usb_endpoint_is_bulk_out(endp)) 499 dev->bulk_out = endp->bEndpointAddress; 500 } 501 if (!(dev->bulk_in && dev->bulk_out)) { 502 retval = -ENODEV; 503 dev_err(&intf->dev, "Unable to find endpoints\n"); 504 goto err_endpoints; 505 } 506 507 dev->ctrl_buf = kmalloc(IPHETH_CTRL_BUF_SIZE, GFP_KERNEL); 508 if (dev->ctrl_buf == NULL) { 509 retval = -ENOMEM; 510 goto err_alloc_ctrl_buf; 511 } 512 513 retval = ipheth_get_macaddr(dev); 514 if (retval) 515 goto err_get_macaddr; 516 517 INIT_DELAYED_WORK(&dev->carrier_work, ipheth_carrier_check_work); 518 519 retval = ipheth_alloc_urbs(dev); 520 if (retval) { 521 dev_err(&intf->dev, "error allocating urbs: %d\n", retval); 522 goto err_alloc_urbs; 523 } 524 525 usb_set_intfdata(intf, dev); 526 527 SET_NETDEV_DEV(netdev, &intf->dev); 528 SET_ETHTOOL_OPS(netdev, &ops); 529 530 retval = register_netdev(netdev); 531 if (retval) { 532 dev_err(&intf->dev, "error registering netdev: %d\n", retval); 533 retval = -EIO; 534 goto err_register_netdev; 535 } 536 537 dev_info(&intf->dev, "Apple iPhone USB Ethernet device attached\n"); 538 return 0; 539 540 err_register_netdev: 541 ipheth_free_urbs(dev); 542 err_alloc_urbs: 543 err_get_macaddr: 544 err_alloc_ctrl_buf: 545 kfree(dev->ctrl_buf); 546 err_endpoints: 547 free_netdev(netdev); 548 return retval; 549 } 550 551 static void ipheth_disconnect(struct usb_interface *intf) 552 { 553 struct ipheth_device *dev; 554 555 dev = usb_get_intfdata(intf); 556 if (dev != NULL) { 557 unregister_netdev(dev->net); 558 ipheth_kill_urbs(dev); 559 ipheth_free_urbs(dev); 560 kfree(dev->ctrl_buf); 561 free_netdev(dev->net); 562 } 563 usb_set_intfdata(intf, NULL); 564 dev_info(&intf->dev, "Apple iPhone USB Ethernet now disconnected\n"); 565 } 566 567 static struct usb_driver ipheth_driver = { 568 .name = "ipheth", 569 .probe = ipheth_probe, 570 .disconnect = ipheth_disconnect, 571 .id_table = ipheth_table, 572 .disable_hub_initiated_lpm = 1, 573 }; 574 575 module_usb_driver(ipheth_driver); 576 577 MODULE_AUTHOR("Diego Giagio <diego@giagio.com>"); 578 MODULE_DESCRIPTION("Apple iPhone USB Ethernet driver"); 579 MODULE_LICENSE("Dual BSD/GPL"); 580