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