2 * ipheth.c - Apple iPhone USB Ethernet driver
4 * Copyright (c) 2009 Diego Giagio <diego@giagio.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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.
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.
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
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
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>
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
62 #define IPHETH_USBINTF_CLASS 255
63 #define IPHETH_USBINTF_SUBCLASS 253
64 #define IPHETH_USBINTF_PROTO 1
66 #define IPHETH_BUF_SIZE 1516
67 #define IPHETH_TX_TIMEOUT (5 * HZ)
69 #define IPHETH_INTFNUM 2
70 #define IPHETH_ALT_INTFNUM 1
72 #define IPHETH_CTRL_ENDP 0x00
73 #define IPHETH_CTRL_BUF_SIZE 0x40
74 #define IPHETH_CTRL_TIMEOUT (5 * HZ)
76 #define IPHETH_CMD_GET_MACADDR 0x00
77 #define IPHETH_CMD_CARRIER_CHECK 0x45
79 #define IPHETH_CARRIER_CHECK_TIMEOUT round_jiffies_relative(1 * HZ)
80 #define IPHETH_CARRIER_ON 0x04
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) },
97 MODULE_DEVICE_TABLE(usb, ipheth_table);
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;
106 unsigned char *tx_buf;
107 unsigned char *rx_buf;
108 unsigned char *ctrl_buf;
111 struct delayed_work carrier_work;
114 static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags);
116 static int ipheth_alloc_urbs(struct ipheth_device *iphone)
118 struct urb *tx_urb = NULL;
119 struct urb *rx_urb = NULL;
123 tx_urb = usb_alloc_urb(0, GFP_KERNEL);
127 rx_urb = usb_alloc_urb(0, GFP_KERNEL);
131 tx_buf = usb_buffer_alloc(iphone->udev,
134 &tx_urb->transfer_dma);
138 rx_buf = usb_buffer_alloc(iphone->udev,
141 &rx_urb->transfer_dma);
146 iphone->tx_urb = tx_urb;
147 iphone->rx_urb = rx_urb;
148 iphone->tx_buf = tx_buf;
149 iphone->rx_buf = rx_buf;
153 usb_buffer_free(iphone->udev, IPHETH_BUF_SIZE, rx_buf,
154 rx_urb->transfer_dma);
155 usb_buffer_free(iphone->udev, IPHETH_BUF_SIZE, tx_buf,
156 tx_urb->transfer_dma);
157 usb_free_urb(rx_urb);
158 usb_free_urb(tx_urb);
162 static void ipheth_free_urbs(struct ipheth_device *iphone)
164 usb_buffer_free(iphone->udev, IPHETH_BUF_SIZE, iphone->rx_buf,
165 iphone->rx_urb->transfer_dma);
166 usb_buffer_free(iphone->udev, IPHETH_BUF_SIZE, iphone->tx_buf,
167 iphone->tx_urb->transfer_dma);
168 usb_free_urb(iphone->rx_urb);
169 usb_free_urb(iphone->tx_urb);
172 static void ipheth_kill_urbs(struct ipheth_device *dev)
174 usb_kill_urb(dev->tx_urb);
175 usb_kill_urb(dev->rx_urb);
178 static void ipheth_rcvbulk_callback(struct urb *urb)
180 struct ipheth_device *dev;
190 status = urb->status;
199 err("%s: urb status: %d", __func__, urb->status);
203 len = urb->actual_length;
204 buf = urb->transfer_buffer;
206 skb = dev_alloc_skb(NET_IP_ALIGN + len);
208 err("%s: dev_alloc_skb: -ENOMEM", __func__);
209 dev->net->stats.rx_dropped++;
213 skb_reserve(skb, NET_IP_ALIGN);
214 memcpy(skb_put(skb, len), buf + NET_IP_ALIGN, len - NET_IP_ALIGN);
216 skb->protocol = eth_type_trans(skb, dev->net);
218 dev->net->stats.rx_packets++;
219 dev->net->stats.rx_bytes += len;
222 ipheth_rx_submit(dev, GFP_ATOMIC);
225 static void ipheth_sndbulk_callback(struct urb *urb)
227 struct ipheth_device *dev;
233 if (urb->status != 0 &&
234 urb->status != -ENOENT &&
235 urb->status != -ECONNRESET &&
236 urb->status != -ESHUTDOWN)
237 err("%s: urb status: %d", __func__, urb->status);
239 dev_kfree_skb_irq(dev->tx_skb);
240 netif_wake_queue(dev->net);
243 static int ipheth_carrier_set(struct ipheth_device *dev)
245 struct usb_device *udev = dev->udev;
248 retval = usb_control_msg(udev,
249 usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
250 IPHETH_CMD_CARRIER_CHECK, /* request */
251 0xc0, /* request type */
254 dev->ctrl_buf, IPHETH_CTRL_BUF_SIZE,
255 IPHETH_CTRL_TIMEOUT);
257 err("%s: usb_control_msg: %d", __func__, retval);
261 if (dev->ctrl_buf[0] == IPHETH_CARRIER_ON)
262 netif_carrier_on(dev->net);
264 netif_carrier_off(dev->net);
269 static void ipheth_carrier_check_work(struct work_struct *work)
271 struct ipheth_device *dev = container_of(work, struct ipheth_device,
274 ipheth_carrier_set(dev);
275 schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
278 static int ipheth_get_macaddr(struct ipheth_device *dev)
280 struct usb_device *udev = dev->udev;
281 struct net_device *net = dev->net;
284 retval = usb_control_msg(udev,
285 usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
286 IPHETH_CMD_GET_MACADDR, /* request */
287 0xc0, /* request type */
291 IPHETH_CTRL_BUF_SIZE,
292 IPHETH_CTRL_TIMEOUT);
294 err("%s: usb_control_msg: %d", __func__, retval);
295 } else if (retval < ETH_ALEN) {
296 err("%s: usb_control_msg: short packet: %d bytes",
300 memcpy(net->dev_addr, dev->ctrl_buf, ETH_ALEN);
307 static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags)
309 struct usb_device *udev = dev->udev;
312 usb_fill_bulk_urb(dev->rx_urb, udev,
313 usb_rcvbulkpipe(udev, dev->bulk_in),
314 dev->rx_buf, IPHETH_BUF_SIZE,
315 ipheth_rcvbulk_callback,
317 dev->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
319 retval = usb_submit_urb(dev->rx_urb, mem_flags);
321 err("%s: usb_submit_urb: %d", __func__, retval);
325 static int ipheth_open(struct net_device *net)
327 struct ipheth_device *dev = netdev_priv(net);
328 struct usb_device *udev = dev->udev;
331 usb_set_interface(udev, IPHETH_INTFNUM, IPHETH_ALT_INTFNUM);
333 retval = ipheth_carrier_set(dev);
337 retval = ipheth_rx_submit(dev, GFP_KERNEL);
341 schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
342 netif_start_queue(net);
346 static int ipheth_close(struct net_device *net)
348 struct ipheth_device *dev = netdev_priv(net);
350 cancel_delayed_work_sync(&dev->carrier_work);
351 netif_stop_queue(net);
355 static int ipheth_tx(struct sk_buff *skb, struct net_device *net)
357 struct ipheth_device *dev = netdev_priv(net);
358 struct usb_device *udev = dev->udev;
362 if (skb->len > IPHETH_BUF_SIZE) {
363 WARN(1, "%s: skb too large: %d bytes", __func__, skb->len);
364 dev->net->stats.tx_dropped++;
365 dev_kfree_skb_irq(skb);
369 memcpy(dev->tx_buf, skb->data, skb->len);
370 if (skb->len < IPHETH_BUF_SIZE)
371 memset(dev->tx_buf + skb->len, 0, IPHETH_BUF_SIZE - skb->len);
373 usb_fill_bulk_urb(dev->tx_urb, udev,
374 usb_sndbulkpipe(udev, dev->bulk_out),
375 dev->tx_buf, IPHETH_BUF_SIZE,
376 ipheth_sndbulk_callback,
378 dev->tx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
380 retval = usb_submit_urb(dev->tx_urb, GFP_ATOMIC);
382 err("%s: usb_submit_urb: %d", __func__, retval);
383 dev->net->stats.tx_errors++;
384 dev_kfree_skb_irq(skb);
388 dev->net->stats.tx_packets++;
389 dev->net->stats.tx_bytes += skb->len;
390 netif_stop_queue(net);
396 static void ipheth_tx_timeout(struct net_device *net)
398 struct ipheth_device *dev = netdev_priv(net);
400 err("%s: TX timeout", __func__);
401 dev->net->stats.tx_errors++;
402 usb_unlink_urb(dev->tx_urb);
405 static struct net_device_stats *ipheth_stats(struct net_device *net)
407 struct ipheth_device *dev = netdev_priv(net);
408 return &dev->net->stats;
411 static u32 ipheth_ethtool_op_get_link(struct net_device *net)
413 struct ipheth_device *dev = netdev_priv(net);
414 return netif_carrier_ok(dev->net);
417 static struct ethtool_ops ops = {
418 .get_link = ipheth_ethtool_op_get_link
421 static const struct net_device_ops ipheth_netdev_ops = {
422 .ndo_open = &ipheth_open,
423 .ndo_stop = &ipheth_close,
424 .ndo_start_xmit = &ipheth_tx,
425 .ndo_tx_timeout = &ipheth_tx_timeout,
426 .ndo_get_stats = &ipheth_stats,
429 static struct device_type ipheth_type = {
433 static int ipheth_probe(struct usb_interface *intf,
434 const struct usb_device_id *id)
436 struct usb_device *udev = interface_to_usbdev(intf);
437 struct usb_host_interface *hintf;
438 struct usb_endpoint_descriptor *endp;
439 struct ipheth_device *dev;
440 struct net_device *netdev;
444 netdev = alloc_etherdev(sizeof(struct ipheth_device));
448 netdev->netdev_ops = &ipheth_netdev_ops;
449 netdev->watchdog_timeo = IPHETH_TX_TIMEOUT;
450 strcpy(netdev->name, "wwan%d");
452 dev = netdev_priv(netdev);
457 /* Set up endpoints */
458 hintf = usb_altnum_to_altsetting(intf, IPHETH_ALT_INTFNUM);
461 err("Unable to find alternate settings interface");
465 for (i = 0; i < hintf->desc.bNumEndpoints; i++) {
466 endp = &hintf->endpoint[i].desc;
467 if (usb_endpoint_is_bulk_in(endp))
468 dev->bulk_in = endp->bEndpointAddress;
469 else if (usb_endpoint_is_bulk_out(endp))
470 dev->bulk_out = endp->bEndpointAddress;
472 if (!(dev->bulk_in && dev->bulk_out)) {
474 err("Unable to find endpoints");
478 dev->ctrl_buf = kmalloc(IPHETH_CTRL_BUF_SIZE, GFP_KERNEL);
479 if (dev->ctrl_buf == NULL) {
481 goto err_alloc_ctrl_buf;
484 retval = ipheth_get_macaddr(dev);
486 goto err_get_macaddr;
488 INIT_DELAYED_WORK(&dev->carrier_work, ipheth_carrier_check_work);
490 retval = ipheth_alloc_urbs(dev);
492 err("error allocating urbs: %d", retval);
496 usb_set_intfdata(intf, dev);
498 SET_NETDEV_DEV(netdev, &intf->dev);
499 SET_ETHTOOL_OPS(netdev, &ops);
500 SET_NETDEV_DEVTYPE(netdev, &ipheth_type);
502 retval = register_netdev(netdev);
504 err("error registering netdev: %d", retval);
506 goto err_register_netdev;
509 dev_info(&intf->dev, "Apple iPhone USB Ethernet device attached\n");
513 ipheth_free_urbs(dev);
517 kfree(dev->ctrl_buf);
523 static void ipheth_disconnect(struct usb_interface *intf)
525 struct ipheth_device *dev;
527 dev = usb_get_intfdata(intf);
529 unregister_netdev(dev->net);
530 ipheth_kill_urbs(dev);
531 ipheth_free_urbs(dev);
532 kfree(dev->ctrl_buf);
533 free_netdev(dev->net);
535 usb_set_intfdata(intf, NULL);
536 dev_info(&intf->dev, "Apple iPhone USB Ethernet now disconnected\n");
539 static struct usb_driver ipheth_driver = {
541 .probe = ipheth_probe,
542 .disconnect = ipheth_disconnect,
543 .id_table = ipheth_table,
546 static int __init ipheth_init(void)
550 retval = usb_register(&ipheth_driver);
552 err("usb_register failed: %d", retval);
558 static void __exit ipheth_exit(void)
560 usb_deregister(&ipheth_driver);
563 module_init(ipheth_init);
564 module_exit(ipheth_exit);
566 MODULE_AUTHOR("Diego Giagio <diego@giagio.com>");
567 MODULE_DESCRIPTION("Apple iPhone USB Ethernet driver");
568 MODULE_LICENSE("Dual BSD/GPL");