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