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
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
66 #define IPHETH_USBINTF_CLASS 255
67 #define IPHETH_USBINTF_SUBCLASS 253
68 #define IPHETH_USBINTF_PROTO 1
70 #define IPHETH_BUF_SIZE 1516
71 #define IPHETH_IP_ALIGN 2 /* padding at front of URB */
72 #define IPHETH_TX_TIMEOUT (5 * HZ)
74 #define IPHETH_INTFNUM 2
75 #define IPHETH_ALT_INTFNUM 1
77 #define IPHETH_CTRL_ENDP 0x00
78 #define IPHETH_CTRL_BUF_SIZE 0x40
79 #define IPHETH_CTRL_TIMEOUT (5 * HZ)
81 #define IPHETH_CMD_GET_MACADDR 0x00
82 #define IPHETH_CMD_CARRIER_CHECK 0x45
84 #define IPHETH_CARRIER_CHECK_TIMEOUT round_jiffies_relative(1 * HZ)
85 #define IPHETH_CARRIER_ON 0x04
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
) },
118 MODULE_DEVICE_TABLE(usb
, ipheth_table
);
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
;
127 unsigned char *tx_buf
;
128 unsigned char *rx_buf
;
129 unsigned char *ctrl_buf
;
132 struct delayed_work carrier_work
;
134 struct net_device_stats stats
;
137 static int ipheth_rx_submit(struct ipheth_device
*dev
, gfp_t mem_flags
);
139 static int ipheth_alloc_urbs(struct ipheth_device
*iphone
)
141 struct urb
*tx_urb
= NULL
;
142 struct urb
*rx_urb
= NULL
;
146 tx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
150 rx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
154 tx_buf
= usb_buffer_alloc(iphone
->udev
,
157 &tx_urb
->transfer_dma
);
161 rx_buf
= usb_buffer_alloc(iphone
->udev
,
164 &rx_urb
->transfer_dma
);
169 iphone
->tx_urb
= tx_urb
;
170 iphone
->rx_urb
= rx_urb
;
171 iphone
->tx_buf
= tx_buf
;
172 iphone
->rx_buf
= rx_buf
;
176 usb_buffer_free(iphone
->udev
, IPHETH_BUF_SIZE
, tx_buf
,
177 tx_urb
->transfer_dma
);
179 usb_free_urb(rx_urb
);
181 usb_free_urb(tx_urb
);
186 static void ipheth_free_urbs(struct ipheth_device
*iphone
)
188 usb_buffer_free(iphone
->udev
, IPHETH_BUF_SIZE
, iphone
->rx_buf
,
189 iphone
->rx_urb
->transfer_dma
);
190 usb_buffer_free(iphone
->udev
, IPHETH_BUF_SIZE
, iphone
->tx_buf
,
191 iphone
->tx_urb
->transfer_dma
);
192 usb_free_urb(iphone
->rx_urb
);
193 usb_free_urb(iphone
->tx_urb
);
196 static void ipheth_kill_urbs(struct ipheth_device
*dev
)
198 usb_kill_urb(dev
->tx_urb
);
199 usb_kill_urb(dev
->rx_urb
);
202 static void ipheth_rcvbulk_callback(struct urb
*urb
)
204 struct ipheth_device
*dev
;
214 status
= urb
->status
;
223 err("%s: urb status: %d", __func__
, urb
->status
);
227 if (urb
->actual_length
<= IPHETH_IP_ALIGN
) {
228 dev
->stats
.rx_length_errors
++;
231 len
= urb
->actual_length
- IPHETH_IP_ALIGN
;
232 buf
= urb
->transfer_buffer
+ IPHETH_IP_ALIGN
;
234 skb
= dev_alloc_skb(len
);
236 err("%s: dev_alloc_skb: -ENOMEM", __func__
);
237 dev
->stats
.rx_dropped
++;
241 memcpy(skb_put(skb
, len
), buf
, len
);
243 skb
->protocol
= eth_type_trans(skb
, dev
->net
);
245 dev
->stats
.rx_packets
++;
246 dev
->stats
.rx_bytes
+= len
;
249 ipheth_rx_submit(dev
, GFP_ATOMIC
);
252 static void ipheth_sndbulk_callback(struct urb
*urb
)
254 struct ipheth_device
*dev
;
260 if (urb
->status
!= 0 &&
261 urb
->status
!= -ENOENT
&&
262 urb
->status
!= -ECONNRESET
&&
263 urb
->status
!= -ESHUTDOWN
)
264 err("%s: urb status: %d", __func__
, urb
->status
);
266 dev_kfree_skb_irq(dev
->tx_skb
);
267 netif_wake_queue(dev
->net
);
270 static int ipheth_carrier_set(struct ipheth_device
*dev
)
272 struct usb_device
*udev
= dev
->udev
;
275 retval
= usb_control_msg(udev
,
276 usb_rcvctrlpipe(udev
, IPHETH_CTRL_ENDP
),
277 IPHETH_CMD_CARRIER_CHECK
, /* request */
278 0xc0, /* request type */
281 dev
->ctrl_buf
, IPHETH_CTRL_BUF_SIZE
,
282 IPHETH_CTRL_TIMEOUT
);
284 err("%s: usb_control_msg: %d", __func__
, retval
);
288 if (dev
->ctrl_buf
[0] == IPHETH_CARRIER_ON
)
289 netif_carrier_on(dev
->net
);
291 netif_carrier_off(dev
->net
);
296 static void ipheth_carrier_check_work(struct work_struct
*work
)
298 struct ipheth_device
*dev
= container_of(work
, struct ipheth_device
,
301 ipheth_carrier_set(dev
);
302 schedule_delayed_work(&dev
->carrier_work
, IPHETH_CARRIER_CHECK_TIMEOUT
);
305 static int ipheth_get_macaddr(struct ipheth_device
*dev
)
307 struct usb_device
*udev
= dev
->udev
;
308 struct net_device
*net
= dev
->net
;
311 retval
= usb_control_msg(udev
,
312 usb_rcvctrlpipe(udev
, IPHETH_CTRL_ENDP
),
313 IPHETH_CMD_GET_MACADDR
, /* request */
314 0xc0, /* request type */
318 IPHETH_CTRL_BUF_SIZE
,
319 IPHETH_CTRL_TIMEOUT
);
321 err("%s: usb_control_msg: %d", __func__
, retval
);
322 } else if (retval
< ETH_ALEN
) {
323 err("%s: usb_control_msg: short packet: %d bytes",
327 memcpy(net
->dev_addr
, dev
->ctrl_buf
, ETH_ALEN
);
334 static int ipheth_rx_submit(struct ipheth_device
*dev
, gfp_t mem_flags
)
336 struct usb_device
*udev
= dev
->udev
;
339 usb_fill_bulk_urb(dev
->rx_urb
, udev
,
340 usb_rcvbulkpipe(udev
, dev
->bulk_in
),
341 dev
->rx_buf
, IPHETH_BUF_SIZE
,
342 ipheth_rcvbulk_callback
,
344 dev
->rx_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
346 retval
= usb_submit_urb(dev
->rx_urb
, mem_flags
);
348 err("%s: usb_submit_urb: %d", __func__
, retval
);
352 static int ipheth_open(struct net_device
*net
)
354 struct ipheth_device
*dev
= netdev_priv(net
);
355 struct usb_device
*udev
= dev
->udev
;
358 usb_set_interface(udev
, IPHETH_INTFNUM
, IPHETH_ALT_INTFNUM
);
360 retval
= ipheth_carrier_set(dev
);
364 retval
= ipheth_rx_submit(dev
, GFP_KERNEL
);
368 schedule_delayed_work(&dev
->carrier_work
, IPHETH_CARRIER_CHECK_TIMEOUT
);
369 netif_start_queue(net
);
373 static int ipheth_close(struct net_device
*net
)
375 struct ipheth_device
*dev
= netdev_priv(net
);
377 cancel_rearming_delayed_work(&dev
->carrier_work
);
378 netif_stop_queue(net
);
382 static int ipheth_tx(struct sk_buff
*skb
, struct net_device
*net
)
384 struct ipheth_device
*dev
= netdev_priv(net
);
385 struct usb_device
*udev
= dev
->udev
;
389 if (skb
->len
> IPHETH_BUF_SIZE
) {
390 WARN(1, "%s: skb too large: %d bytes", __func__
, skb
->len
);
391 dev
->stats
.tx_dropped
++;
392 dev_kfree_skb_irq(skb
);
396 memcpy(dev
->tx_buf
, skb
->data
, skb
->len
);
397 if (skb
->len
< IPHETH_BUF_SIZE
)
398 memset(dev
->tx_buf
+ skb
->len
, 0, IPHETH_BUF_SIZE
- skb
->len
);
400 usb_fill_bulk_urb(dev
->tx_urb
, udev
,
401 usb_sndbulkpipe(udev
, dev
->bulk_out
),
402 dev
->tx_buf
, IPHETH_BUF_SIZE
,
403 ipheth_sndbulk_callback
,
405 dev
->tx_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
407 retval
= usb_submit_urb(dev
->tx_urb
, GFP_ATOMIC
);
409 err("%s: usb_submit_urb: %d", __func__
, retval
);
410 dev
->stats
.tx_errors
++;
411 dev_kfree_skb_irq(skb
);
413 net
->trans_start
= jiffies
;
416 dev
->stats
.tx_packets
++;
417 dev
->stats
.tx_bytes
+= skb
->len
;
418 netif_stop_queue(net
);
424 static void ipheth_tx_timeout(struct net_device
*net
)
426 struct ipheth_device
*dev
= netdev_priv(net
);
428 err("%s: TX timeout", __func__
);
429 dev
->stats
.tx_errors
++;
430 usb_unlink_urb(dev
->tx_urb
);
433 static struct net_device_stats
*ipheth_stats(struct net_device
*net
)
435 struct ipheth_device
*dev
= netdev_priv(net
);
439 static u32
ipheth_ethtool_op_get_link(struct net_device
*net
)
441 struct ipheth_device
*dev
= netdev_priv(net
);
442 return netif_carrier_ok(dev
->net
);
445 static const struct ethtool_ops ops
= {
446 .get_link
= ipheth_ethtool_op_get_link
450 static int ipheth_probe(struct usb_interface
*intf
,
451 const struct usb_device_id
*id
)
453 struct usb_device
*udev
= interface_to_usbdev(intf
);
454 struct usb_host_interface
*hintf
;
455 struct usb_endpoint_descriptor
*endp
;
456 struct ipheth_device
*dev
;
457 struct net_device
*netdev
;
461 netdev
= alloc_etherdev(sizeof(struct ipheth_device
));
465 netdev
->open
= ipheth_open
;
466 netdev
->stop
= ipheth_close
;
467 netdev
->hard_start_xmit
= ipheth_tx
;
468 netdev
->tx_timeout
= ipheth_tx_timeout
;
469 netdev
->get_stats
= ipheth_stats
;
470 netdev
->watchdog_timeo
= IPHETH_TX_TIMEOUT
;
471 strcpy(netdev
->name
, "eth%d");
473 dev
= netdev_priv(netdev
);
478 /* Set up endpoints */
479 hintf
= usb_altnum_to_altsetting(intf
, IPHETH_ALT_INTFNUM
);
482 err("Unable to find alternate settings interface");
486 for (i
= 0; i
< hintf
->desc
.bNumEndpoints
; i
++) {
487 endp
= &hintf
->endpoint
[i
].desc
;
488 if (usb_endpoint_is_bulk_in(endp
))
489 dev
->bulk_in
= endp
->bEndpointAddress
;
490 else if (usb_endpoint_is_bulk_out(endp
))
491 dev
->bulk_out
= endp
->bEndpointAddress
;
493 if (!(dev
->bulk_in
&& dev
->bulk_out
)) {
495 err("Unable to find endpoints");
499 dev
->ctrl_buf
= kmalloc(IPHETH_CTRL_BUF_SIZE
, GFP_KERNEL
);
500 if (dev
->ctrl_buf
== NULL
) {
502 goto err_alloc_ctrl_buf
;
505 retval
= ipheth_get_macaddr(dev
);
507 goto err_get_macaddr
;
509 INIT_DELAYED_WORK(&dev
->carrier_work
, ipheth_carrier_check_work
);
511 retval
= ipheth_alloc_urbs(dev
);
513 err("error allocating urbs: %d", retval
);
517 usb_set_intfdata(intf
, dev
);
519 SET_NETDEV_DEV(netdev
, &intf
->dev
);
520 SET_ETHTOOL_OPS(netdev
, &ops
);
522 retval
= register_netdev(netdev
);
524 err("error registering netdev: %d", retval
);
526 goto err_register_netdev
;
529 dev_info(&intf
->dev
, "Apple iPhone USB Ethernet device attached\n");
533 ipheth_free_urbs(dev
);
537 kfree(dev
->ctrl_buf
);
543 static void ipheth_disconnect(struct usb_interface
*intf
)
545 struct ipheth_device
*dev
;
547 dev
= usb_get_intfdata(intf
);
549 unregister_netdev(dev
->net
);
550 ipheth_kill_urbs(dev
);
551 ipheth_free_urbs(dev
);
552 kfree(dev
->ctrl_buf
);
553 free_netdev(dev
->net
);
555 usb_set_intfdata(intf
, NULL
);
556 dev_info(&intf
->dev
, "Apple iPhone USB Ethernet now disconnected\n");
559 static struct usb_driver ipheth_driver
= {
561 .probe
= ipheth_probe
,
562 .disconnect
= ipheth_disconnect
,
563 .id_table
= ipheth_table
,
566 static int __init
ipheth_init(void)
570 retval
= usb_register(&ipheth_driver
);
572 err("usb_register failed: %d", retval
);
578 static void __exit
ipheth_exit(void)
580 usb_deregister(&ipheth_driver
);
583 module_init(ipheth_init
);
584 module_exit(ipheth_exit
);
586 MODULE_AUTHOR("Diego Giagio <diego@giagio.com>");
587 MODULE_DESCRIPTION("Apple iPhone USB Ethernet driver");
588 MODULE_LICENSE("Dual BSD/GPL");