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