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/slab.h>
49 #include <linux/module.h>
50 #include <linux/netdevice.h>
51 #include <linux/etherdevice.h>
52 #include <linux/ethtool.h>
53 #include <linux/usb.h>
54 #include <linux/workqueue.h>
56 #define USB_VENDOR_APPLE 0x05ac
57 #define USB_PRODUCT_IPHONE 0x1290
58 #define USB_PRODUCT_IPHONE_3G 0x1292
59 #define USB_PRODUCT_IPHONE_3GS 0x1294
60 #define USB_PRODUCT_IPHONE_4 0x1297
61 #define USB_PRODUCT_IPAD 0x129a
62 #define USB_PRODUCT_IPAD_2 0x12a2
63 #define USB_PRODUCT_IPAD_3 0x12a6
64 #define USB_PRODUCT_IPAD_MINI 0x12ab
65 #define USB_PRODUCT_IPHONE_4_VZW 0x129c
66 #define USB_PRODUCT_IPHONE_4S 0x12a0
67 #define USB_PRODUCT_IPHONE_5 0x12a8
69 #define IPHETH_USBINTF_CLASS 255
70 #define IPHETH_USBINTF_SUBCLASS 253
71 #define IPHETH_USBINTF_PROTO 1
73 #define IPHETH_BUF_SIZE 1516
74 #define IPHETH_IP_ALIGN 2 /* padding at front of URB */
75 #define IPHETH_TX_TIMEOUT (5 * HZ)
77 #define IPHETH_INTFNUM 2
78 #define IPHETH_ALT_INTFNUM 1
80 #define IPHETH_CTRL_ENDP 0x00
81 #define IPHETH_CTRL_BUF_SIZE 0x40
82 #define IPHETH_CTRL_TIMEOUT (5 * HZ)
84 #define IPHETH_CMD_GET_MACADDR 0x00
85 #define IPHETH_CMD_CARRIER_CHECK 0x45
87 #define IPHETH_CARRIER_CHECK_TIMEOUT round_jiffies_relative(1 * HZ)
88 #define IPHETH_CARRIER_ON 0x04
90 static const struct usb_device_id ipheth_table
[] = {
91 { USB_DEVICE_AND_INTERFACE_INFO(
92 USB_VENDOR_APPLE
, USB_PRODUCT_IPHONE
,
93 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
94 IPHETH_USBINTF_PROTO
) },
95 { USB_DEVICE_AND_INTERFACE_INFO(
96 USB_VENDOR_APPLE
, USB_PRODUCT_IPHONE_3G
,
97 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
98 IPHETH_USBINTF_PROTO
) },
99 { USB_DEVICE_AND_INTERFACE_INFO(
100 USB_VENDOR_APPLE
, USB_PRODUCT_IPHONE_3GS
,
101 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
102 IPHETH_USBINTF_PROTO
) },
103 { USB_DEVICE_AND_INTERFACE_INFO(
104 USB_VENDOR_APPLE
, USB_PRODUCT_IPHONE_4
,
105 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
106 IPHETH_USBINTF_PROTO
) },
107 { USB_DEVICE_AND_INTERFACE_INFO(
108 USB_VENDOR_APPLE
, USB_PRODUCT_IPAD
,
109 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
110 IPHETH_USBINTF_PROTO
) },
111 { USB_DEVICE_AND_INTERFACE_INFO(
112 USB_VENDOR_APPLE
, USB_PRODUCT_IPAD_2
,
113 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
114 IPHETH_USBINTF_PROTO
) },
115 { USB_DEVICE_AND_INTERFACE_INFO(
116 USB_VENDOR_APPLE
, USB_PRODUCT_IPAD_3
,
117 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
118 IPHETH_USBINTF_PROTO
) },
119 { USB_DEVICE_AND_INTERFACE_INFO(
120 USB_VENDOR_APPLE
, USB_PRODUCT_IPAD_MINI
,
121 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
122 IPHETH_USBINTF_PROTO
) },
123 { USB_DEVICE_AND_INTERFACE_INFO(
124 USB_VENDOR_APPLE
, USB_PRODUCT_IPHONE_4_VZW
,
125 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
126 IPHETH_USBINTF_PROTO
) },
127 { USB_DEVICE_AND_INTERFACE_INFO(
128 USB_VENDOR_APPLE
, USB_PRODUCT_IPHONE_4S
,
129 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
130 IPHETH_USBINTF_PROTO
) },
131 { USB_DEVICE_AND_INTERFACE_INFO(
132 USB_VENDOR_APPLE
, USB_PRODUCT_IPHONE_5
,
133 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
134 IPHETH_USBINTF_PROTO
) },
137 MODULE_DEVICE_TABLE(usb
, ipheth_table
);
139 struct ipheth_device
{
140 struct usb_device
*udev
;
141 struct usb_interface
*intf
;
142 struct net_device
*net
;
143 struct sk_buff
*tx_skb
;
146 unsigned char *tx_buf
;
147 unsigned char *rx_buf
;
148 unsigned char *ctrl_buf
;
151 struct delayed_work carrier_work
;
152 bool confirmed_pairing
;
155 static int ipheth_rx_submit(struct ipheth_device
*dev
, gfp_t mem_flags
);
157 static int ipheth_alloc_urbs(struct ipheth_device
*iphone
)
159 struct urb
*tx_urb
= NULL
;
160 struct urb
*rx_urb
= NULL
;
164 tx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
168 rx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
172 tx_buf
= usb_alloc_coherent(iphone
->udev
, IPHETH_BUF_SIZE
,
173 GFP_KERNEL
, &tx_urb
->transfer_dma
);
177 rx_buf
= usb_alloc_coherent(iphone
->udev
, IPHETH_BUF_SIZE
,
178 GFP_KERNEL
, &rx_urb
->transfer_dma
);
183 iphone
->tx_urb
= tx_urb
;
184 iphone
->rx_urb
= rx_urb
;
185 iphone
->tx_buf
= tx_buf
;
186 iphone
->rx_buf
= rx_buf
;
190 usb_free_coherent(iphone
->udev
, IPHETH_BUF_SIZE
, tx_buf
,
191 tx_urb
->transfer_dma
);
193 usb_free_urb(rx_urb
);
195 usb_free_urb(tx_urb
);
200 static void ipheth_free_urbs(struct ipheth_device
*iphone
)
202 usb_free_coherent(iphone
->udev
, IPHETH_BUF_SIZE
, iphone
->rx_buf
,
203 iphone
->rx_urb
->transfer_dma
);
204 usb_free_coherent(iphone
->udev
, IPHETH_BUF_SIZE
, iphone
->tx_buf
,
205 iphone
->tx_urb
->transfer_dma
);
206 usb_free_urb(iphone
->rx_urb
);
207 usb_free_urb(iphone
->tx_urb
);
210 static void ipheth_kill_urbs(struct ipheth_device
*dev
)
212 usb_kill_urb(dev
->tx_urb
);
213 usb_kill_urb(dev
->rx_urb
);
216 static void ipheth_rcvbulk_callback(struct urb
*urb
)
218 struct ipheth_device
*dev
;
228 status
= urb
->status
;
237 dev_err(&dev
->intf
->dev
, "%s: urb status: %d\n",
242 if (urb
->actual_length
<= IPHETH_IP_ALIGN
) {
243 dev
->net
->stats
.rx_length_errors
++;
246 len
= urb
->actual_length
- IPHETH_IP_ALIGN
;
247 buf
= urb
->transfer_buffer
+ IPHETH_IP_ALIGN
;
249 skb
= dev_alloc_skb(len
);
251 dev_err(&dev
->intf
->dev
, "%s: dev_alloc_skb: -ENOMEM\n",
253 dev
->net
->stats
.rx_dropped
++;
257 skb_put_data(skb
, buf
, len
);
259 skb
->protocol
= eth_type_trans(skb
, dev
->net
);
261 dev
->net
->stats
.rx_packets
++;
262 dev
->net
->stats
.rx_bytes
+= len
;
263 dev
->confirmed_pairing
= true;
265 ipheth_rx_submit(dev
, GFP_ATOMIC
);
268 static void ipheth_sndbulk_callback(struct urb
*urb
)
270 struct ipheth_device
*dev
;
271 int status
= urb
->status
;
279 status
!= -ECONNRESET
&&
280 status
!= -ESHUTDOWN
)
281 dev_err(&dev
->intf
->dev
, "%s: urb status: %d\n",
284 dev_kfree_skb_irq(dev
->tx_skb
);
286 netif_wake_queue(dev
->net
);
288 // on URB error, trigger immediate poll
289 schedule_delayed_work(&dev
->carrier_work
, 0);
292 static int ipheth_carrier_set(struct ipheth_device
*dev
)
294 struct usb_device
*udev
;
299 if (!dev
->confirmed_pairing
)
303 retval
= usb_control_msg(udev
,
304 usb_rcvctrlpipe(udev
, IPHETH_CTRL_ENDP
),
305 IPHETH_CMD_CARRIER_CHECK
, /* request */
306 0xc0, /* request type */
309 dev
->ctrl_buf
, IPHETH_CTRL_BUF_SIZE
,
310 IPHETH_CTRL_TIMEOUT
);
312 dev_err(&dev
->intf
->dev
, "%s: usb_control_msg: %d\n",
317 if (dev
->ctrl_buf
[0] == IPHETH_CARRIER_ON
) {
318 netif_carrier_on(dev
->net
);
319 if (dev
->tx_urb
->status
!= -EINPROGRESS
)
320 netif_wake_queue(dev
->net
);
322 netif_carrier_off(dev
->net
);
323 netif_stop_queue(dev
->net
);
328 static void ipheth_carrier_check_work(struct work_struct
*work
)
330 struct ipheth_device
*dev
= container_of(work
, struct ipheth_device
,
333 ipheth_carrier_set(dev
);
334 schedule_delayed_work(&dev
->carrier_work
, IPHETH_CARRIER_CHECK_TIMEOUT
);
337 static int ipheth_get_macaddr(struct ipheth_device
*dev
)
339 struct usb_device
*udev
= dev
->udev
;
340 struct net_device
*net
= dev
->net
;
343 retval
= usb_control_msg(udev
,
344 usb_rcvctrlpipe(udev
, IPHETH_CTRL_ENDP
),
345 IPHETH_CMD_GET_MACADDR
, /* request */
346 0xc0, /* request type */
350 IPHETH_CTRL_BUF_SIZE
,
351 IPHETH_CTRL_TIMEOUT
);
353 dev_err(&dev
->intf
->dev
, "%s: usb_control_msg: %d\n",
355 } else if (retval
< ETH_ALEN
) {
356 dev_err(&dev
->intf
->dev
,
357 "%s: usb_control_msg: short packet: %d bytes\n",
361 memcpy(net
->dev_addr
, dev
->ctrl_buf
, ETH_ALEN
);
368 static int ipheth_rx_submit(struct ipheth_device
*dev
, gfp_t mem_flags
)
370 struct usb_device
*udev
= dev
->udev
;
373 usb_fill_bulk_urb(dev
->rx_urb
, udev
,
374 usb_rcvbulkpipe(udev
, dev
->bulk_in
),
375 dev
->rx_buf
, IPHETH_BUF_SIZE
,
376 ipheth_rcvbulk_callback
,
378 dev
->rx_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
380 retval
= usb_submit_urb(dev
->rx_urb
, mem_flags
);
382 dev_err(&dev
->intf
->dev
, "%s: usb_submit_urb: %d\n",
387 static int ipheth_open(struct net_device
*net
)
389 struct ipheth_device
*dev
= netdev_priv(net
);
390 struct usb_device
*udev
= dev
->udev
;
393 usb_set_interface(udev
, IPHETH_INTFNUM
, IPHETH_ALT_INTFNUM
);
395 retval
= ipheth_carrier_set(dev
);
399 retval
= ipheth_rx_submit(dev
, GFP_KERNEL
);
403 schedule_delayed_work(&dev
->carrier_work
, IPHETH_CARRIER_CHECK_TIMEOUT
);
407 static int ipheth_close(struct net_device
*net
)
409 struct ipheth_device
*dev
= netdev_priv(net
);
411 cancel_delayed_work_sync(&dev
->carrier_work
);
412 netif_stop_queue(net
);
416 static int ipheth_tx(struct sk_buff
*skb
, struct net_device
*net
)
418 struct ipheth_device
*dev
= netdev_priv(net
);
419 struct usb_device
*udev
= dev
->udev
;
423 if (skb
->len
> IPHETH_BUF_SIZE
) {
424 WARN(1, "%s: skb too large: %d bytes\n", __func__
, skb
->len
);
425 dev
->net
->stats
.tx_dropped
++;
426 dev_kfree_skb_irq(skb
);
430 memcpy(dev
->tx_buf
, skb
->data
, skb
->len
);
431 if (skb
->len
< IPHETH_BUF_SIZE
)
432 memset(dev
->tx_buf
+ skb
->len
, 0, IPHETH_BUF_SIZE
- skb
->len
);
434 usb_fill_bulk_urb(dev
->tx_urb
, udev
,
435 usb_sndbulkpipe(udev
, dev
->bulk_out
),
436 dev
->tx_buf
, IPHETH_BUF_SIZE
,
437 ipheth_sndbulk_callback
,
439 dev
->tx_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
441 retval
= usb_submit_urb(dev
->tx_urb
, GFP_ATOMIC
);
443 dev_err(&dev
->intf
->dev
, "%s: usb_submit_urb: %d\n",
445 dev
->net
->stats
.tx_errors
++;
446 dev_kfree_skb_irq(skb
);
450 dev
->net
->stats
.tx_packets
++;
451 dev
->net
->stats
.tx_bytes
+= skb
->len
;
452 netif_stop_queue(net
);
458 static void ipheth_tx_timeout(struct net_device
*net
)
460 struct ipheth_device
*dev
= netdev_priv(net
);
462 dev_err(&dev
->intf
->dev
, "%s: TX timeout\n", __func__
);
463 dev
->net
->stats
.tx_errors
++;
464 usb_unlink_urb(dev
->tx_urb
);
467 static u32
ipheth_ethtool_op_get_link(struct net_device
*net
)
469 struct ipheth_device
*dev
= netdev_priv(net
);
470 return netif_carrier_ok(dev
->net
);
473 static const struct ethtool_ops ops
= {
474 .get_link
= ipheth_ethtool_op_get_link
477 static const struct net_device_ops ipheth_netdev_ops
= {
478 .ndo_open
= ipheth_open
,
479 .ndo_stop
= ipheth_close
,
480 .ndo_start_xmit
= ipheth_tx
,
481 .ndo_tx_timeout
= ipheth_tx_timeout
,
484 static int ipheth_probe(struct usb_interface
*intf
,
485 const struct usb_device_id
*id
)
487 struct usb_device
*udev
= interface_to_usbdev(intf
);
488 struct usb_host_interface
*hintf
;
489 struct usb_endpoint_descriptor
*endp
;
490 struct ipheth_device
*dev
;
491 struct net_device
*netdev
;
495 netdev
= alloc_etherdev(sizeof(struct ipheth_device
));
499 netdev
->netdev_ops
= &ipheth_netdev_ops
;
500 netdev
->watchdog_timeo
= IPHETH_TX_TIMEOUT
;
501 strcpy(netdev
->name
, "eth%d");
503 dev
= netdev_priv(netdev
);
507 dev
->confirmed_pairing
= false;
508 /* Set up endpoints */
509 hintf
= usb_altnum_to_altsetting(intf
, IPHETH_ALT_INTFNUM
);
512 dev_err(&intf
->dev
, "Unable to find alternate settings interface\n");
516 for (i
= 0; i
< hintf
->desc
.bNumEndpoints
; i
++) {
517 endp
= &hintf
->endpoint
[i
].desc
;
518 if (usb_endpoint_is_bulk_in(endp
))
519 dev
->bulk_in
= endp
->bEndpointAddress
;
520 else if (usb_endpoint_is_bulk_out(endp
))
521 dev
->bulk_out
= endp
->bEndpointAddress
;
523 if (!(dev
->bulk_in
&& dev
->bulk_out
)) {
525 dev_err(&intf
->dev
, "Unable to find endpoints\n");
529 dev
->ctrl_buf
= kmalloc(IPHETH_CTRL_BUF_SIZE
, GFP_KERNEL
);
530 if (dev
->ctrl_buf
== NULL
) {
532 goto err_alloc_ctrl_buf
;
535 retval
= ipheth_get_macaddr(dev
);
537 goto err_get_macaddr
;
539 INIT_DELAYED_WORK(&dev
->carrier_work
, ipheth_carrier_check_work
);
541 retval
= ipheth_alloc_urbs(dev
);
543 dev_err(&intf
->dev
, "error allocating urbs: %d\n", retval
);
547 usb_set_intfdata(intf
, dev
);
549 SET_NETDEV_DEV(netdev
, &intf
->dev
);
550 netdev
->ethtool_ops
= &ops
;
552 retval
= register_netdev(netdev
);
554 dev_err(&intf
->dev
, "error registering netdev: %d\n", retval
);
556 goto err_register_netdev
;
558 // carrier down and transmit queues stopped until packet from device
559 netif_carrier_off(netdev
);
560 netif_tx_stop_all_queues(netdev
);
561 dev_info(&intf
->dev
, "Apple iPhone USB Ethernet device attached\n");
565 ipheth_free_urbs(dev
);
569 kfree(dev
->ctrl_buf
);
575 static void ipheth_disconnect(struct usb_interface
*intf
)
577 struct ipheth_device
*dev
;
579 dev
= usb_get_intfdata(intf
);
581 unregister_netdev(dev
->net
);
582 ipheth_kill_urbs(dev
);
583 ipheth_free_urbs(dev
);
584 kfree(dev
->ctrl_buf
);
585 free_netdev(dev
->net
);
587 usb_set_intfdata(intf
, NULL
);
588 dev_info(&intf
->dev
, "Apple iPhone USB Ethernet now disconnected\n");
591 static struct usb_driver ipheth_driver
= {
593 .probe
= ipheth_probe
,
594 .disconnect
= ipheth_disconnect
,
595 .id_table
= ipheth_table
,
596 .disable_hub_initiated_lpm
= 1,
599 module_usb_driver(ipheth_driver
);
601 MODULE_AUTHOR("Diego Giagio <diego@giagio.com>");
602 MODULE_DESCRIPTION("Apple iPhone USB Ethernet driver");
603 MODULE_LICENSE("Dual BSD/GPL");