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
63 #define IPHETH_USBINTF_CLASS 255
64 #define IPHETH_USBINTF_SUBCLASS 253
65 #define IPHETH_USBINTF_PROTO 1
67 #define IPHETH_BUF_SIZE 1516
68 #define IPHETH_TX_TIMEOUT (5 * HZ)
70 #define IPHETH_INTFNUM 2
71 #define IPHETH_ALT_INTFNUM 1
73 #define IPHETH_CTRL_ENDP 0x00
74 #define IPHETH_CTRL_BUF_SIZE 0x40
75 #define IPHETH_CTRL_TIMEOUT (5 * HZ)
77 #define IPHETH_CMD_GET_MACADDR 0x00
78 #define IPHETH_CMD_CARRIER_CHECK 0x45
80 #define IPHETH_CARRIER_CHECK_TIMEOUT round_jiffies_relative(1 * HZ)
81 #define IPHETH_CARRIER_ON 0x04
83 static struct usb_device_id ipheth_table
[] = {
84 { USB_DEVICE_AND_INTERFACE_INFO(
85 USB_VENDOR_APPLE
, USB_PRODUCT_IPHONE
,
86 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
87 IPHETH_USBINTF_PROTO
) },
88 { USB_DEVICE_AND_INTERFACE_INFO(
89 USB_VENDOR_APPLE
, USB_PRODUCT_IPHONE_3G
,
90 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
91 IPHETH_USBINTF_PROTO
) },
92 { USB_DEVICE_AND_INTERFACE_INFO(
93 USB_VENDOR_APPLE
, USB_PRODUCT_IPHONE_3GS
,
94 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
95 IPHETH_USBINTF_PROTO
) },
96 { USB_DEVICE_AND_INTERFACE_INFO(
97 USB_VENDOR_APPLE
, USB_PRODUCT_IPHONE_4
,
98 IPHETH_USBINTF_CLASS
, IPHETH_USBINTF_SUBCLASS
,
99 IPHETH_USBINTF_PROTO
) },
102 MODULE_DEVICE_TABLE(usb
, ipheth_table
);
104 struct ipheth_device
{
105 struct usb_device
*udev
;
106 struct usb_interface
*intf
;
107 struct net_device
*net
;
108 struct sk_buff
*tx_skb
;
111 unsigned char *tx_buf
;
112 unsigned char *rx_buf
;
113 unsigned char *ctrl_buf
;
116 struct delayed_work carrier_work
;
119 static int ipheth_rx_submit(struct ipheth_device
*dev
, gfp_t mem_flags
);
121 static int ipheth_alloc_urbs(struct ipheth_device
*iphone
)
123 struct urb
*tx_urb
= NULL
;
124 struct urb
*rx_urb
= NULL
;
128 tx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
132 rx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
136 tx_buf
= usb_alloc_coherent(iphone
->udev
, IPHETH_BUF_SIZE
,
137 GFP_KERNEL
, &tx_urb
->transfer_dma
);
141 rx_buf
= usb_alloc_coherent(iphone
->udev
, IPHETH_BUF_SIZE
,
142 GFP_KERNEL
, &rx_urb
->transfer_dma
);
147 iphone
->tx_urb
= tx_urb
;
148 iphone
->rx_urb
= rx_urb
;
149 iphone
->tx_buf
= tx_buf
;
150 iphone
->rx_buf
= rx_buf
;
154 usb_free_coherent(iphone
->udev
, IPHETH_BUF_SIZE
, tx_buf
,
155 tx_urb
->transfer_dma
);
157 usb_free_urb(rx_urb
);
159 usb_free_urb(tx_urb
);
164 static void ipheth_free_urbs(struct ipheth_device
*iphone
)
166 usb_free_coherent(iphone
->udev
, IPHETH_BUF_SIZE
, iphone
->rx_buf
,
167 iphone
->rx_urb
->transfer_dma
);
168 usb_free_coherent(iphone
->udev
, IPHETH_BUF_SIZE
, iphone
->tx_buf
,
169 iphone
->tx_urb
->transfer_dma
);
170 usb_free_urb(iphone
->rx_urb
);
171 usb_free_urb(iphone
->tx_urb
);
174 static void ipheth_kill_urbs(struct ipheth_device
*dev
)
176 usb_kill_urb(dev
->tx_urb
);
177 usb_kill_urb(dev
->rx_urb
);
180 static void ipheth_rcvbulk_callback(struct urb
*urb
)
182 struct ipheth_device
*dev
;
192 status
= urb
->status
;
201 err("%s: urb status: %d", __func__
, status
);
205 len
= urb
->actual_length
;
206 buf
= urb
->transfer_buffer
;
208 skb
= dev_alloc_skb(NET_IP_ALIGN
+ len
);
210 err("%s: dev_alloc_skb: -ENOMEM", __func__
);
211 dev
->net
->stats
.rx_dropped
++;
215 skb_reserve(skb
, NET_IP_ALIGN
);
216 memcpy(skb_put(skb
, len
), buf
+ NET_IP_ALIGN
, len
- NET_IP_ALIGN
);
218 skb
->protocol
= eth_type_trans(skb
, dev
->net
);
220 dev
->net
->stats
.rx_packets
++;
221 dev
->net
->stats
.rx_bytes
+= len
;
224 ipheth_rx_submit(dev
, GFP_ATOMIC
);
227 static void ipheth_sndbulk_callback(struct urb
*urb
)
229 struct ipheth_device
*dev
;
230 int status
= urb
->status
;
238 status
!= -ECONNRESET
&&
239 status
!= -ESHUTDOWN
)
240 err("%s: urb status: %d", __func__
, status
);
242 dev_kfree_skb_irq(dev
->tx_skb
);
243 netif_wake_queue(dev
->net
);
246 static int ipheth_carrier_set(struct ipheth_device
*dev
)
248 struct usb_device
*udev
= dev
->udev
;
251 retval
= usb_control_msg(udev
,
252 usb_rcvctrlpipe(udev
, IPHETH_CTRL_ENDP
),
253 IPHETH_CMD_CARRIER_CHECK
, /* request */
254 0xc0, /* request type */
257 dev
->ctrl_buf
, IPHETH_CTRL_BUF_SIZE
,
258 IPHETH_CTRL_TIMEOUT
);
260 err("%s: usb_control_msg: %d", __func__
, retval
);
264 if (dev
->ctrl_buf
[0] == IPHETH_CARRIER_ON
)
265 netif_carrier_on(dev
->net
);
267 netif_carrier_off(dev
->net
);
272 static void ipheth_carrier_check_work(struct work_struct
*work
)
274 struct ipheth_device
*dev
= container_of(work
, struct ipheth_device
,
277 ipheth_carrier_set(dev
);
278 schedule_delayed_work(&dev
->carrier_work
, IPHETH_CARRIER_CHECK_TIMEOUT
);
281 static int ipheth_get_macaddr(struct ipheth_device
*dev
)
283 struct usb_device
*udev
= dev
->udev
;
284 struct net_device
*net
= dev
->net
;
287 retval
= usb_control_msg(udev
,
288 usb_rcvctrlpipe(udev
, IPHETH_CTRL_ENDP
),
289 IPHETH_CMD_GET_MACADDR
, /* request */
290 0xc0, /* request type */
294 IPHETH_CTRL_BUF_SIZE
,
295 IPHETH_CTRL_TIMEOUT
);
297 err("%s: usb_control_msg: %d", __func__
, retval
);
298 } else if (retval
< ETH_ALEN
) {
299 err("%s: usb_control_msg: short packet: %d bytes",
303 memcpy(net
->dev_addr
, dev
->ctrl_buf
, ETH_ALEN
);
310 static int ipheth_rx_submit(struct ipheth_device
*dev
, gfp_t mem_flags
)
312 struct usb_device
*udev
= dev
->udev
;
315 usb_fill_bulk_urb(dev
->rx_urb
, udev
,
316 usb_rcvbulkpipe(udev
, dev
->bulk_in
),
317 dev
->rx_buf
, IPHETH_BUF_SIZE
,
318 ipheth_rcvbulk_callback
,
320 dev
->rx_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
322 retval
= usb_submit_urb(dev
->rx_urb
, mem_flags
);
324 err("%s: usb_submit_urb: %d", __func__
, retval
);
328 static int ipheth_open(struct net_device
*net
)
330 struct ipheth_device
*dev
= netdev_priv(net
);
331 struct usb_device
*udev
= dev
->udev
;
334 usb_set_interface(udev
, IPHETH_INTFNUM
, IPHETH_ALT_INTFNUM
);
336 retval
= ipheth_carrier_set(dev
);
340 retval
= ipheth_rx_submit(dev
, GFP_KERNEL
);
344 schedule_delayed_work(&dev
->carrier_work
, IPHETH_CARRIER_CHECK_TIMEOUT
);
345 netif_start_queue(net
);
349 static int ipheth_close(struct net_device
*net
)
351 struct ipheth_device
*dev
= netdev_priv(net
);
353 cancel_delayed_work_sync(&dev
->carrier_work
);
354 netif_stop_queue(net
);
358 static int ipheth_tx(struct sk_buff
*skb
, struct net_device
*net
)
360 struct ipheth_device
*dev
= netdev_priv(net
);
361 struct usb_device
*udev
= dev
->udev
;
365 if (skb
->len
> IPHETH_BUF_SIZE
) {
366 WARN(1, "%s: skb too large: %d bytes", __func__
, skb
->len
);
367 dev
->net
->stats
.tx_dropped
++;
368 dev_kfree_skb_irq(skb
);
372 memcpy(dev
->tx_buf
, skb
->data
, skb
->len
);
373 if (skb
->len
< IPHETH_BUF_SIZE
)
374 memset(dev
->tx_buf
+ skb
->len
, 0, IPHETH_BUF_SIZE
- skb
->len
);
376 usb_fill_bulk_urb(dev
->tx_urb
, udev
,
377 usb_sndbulkpipe(udev
, dev
->bulk_out
),
378 dev
->tx_buf
, IPHETH_BUF_SIZE
,
379 ipheth_sndbulk_callback
,
381 dev
->tx_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
383 retval
= usb_submit_urb(dev
->tx_urb
, GFP_ATOMIC
);
385 err("%s: usb_submit_urb: %d", __func__
, retval
);
386 dev
->net
->stats
.tx_errors
++;
387 dev_kfree_skb_irq(skb
);
391 dev
->net
->stats
.tx_packets
++;
392 dev
->net
->stats
.tx_bytes
+= skb
->len
;
393 netif_stop_queue(net
);
399 static void ipheth_tx_timeout(struct net_device
*net
)
401 struct ipheth_device
*dev
= netdev_priv(net
);
403 err("%s: TX timeout", __func__
);
404 dev
->net
->stats
.tx_errors
++;
405 usb_unlink_urb(dev
->tx_urb
);
408 static struct net_device_stats
*ipheth_stats(struct net_device
*net
)
410 struct ipheth_device
*dev
= netdev_priv(net
);
411 return &dev
->net
->stats
;
414 static u32
ipheth_ethtool_op_get_link(struct net_device
*net
)
416 struct ipheth_device
*dev
= netdev_priv(net
);
417 return netif_carrier_ok(dev
->net
);
420 static struct ethtool_ops ops
= {
421 .get_link
= ipheth_ethtool_op_get_link
424 static const struct net_device_ops ipheth_netdev_ops
= {
425 .ndo_open
= &ipheth_open
,
426 .ndo_stop
= &ipheth_close
,
427 .ndo_start_xmit
= &ipheth_tx
,
428 .ndo_tx_timeout
= &ipheth_tx_timeout
,
429 .ndo_get_stats
= &ipheth_stats
,
432 static int ipheth_probe(struct usb_interface
*intf
,
433 const struct usb_device_id
*id
)
435 struct usb_device
*udev
= interface_to_usbdev(intf
);
436 struct usb_host_interface
*hintf
;
437 struct usb_endpoint_descriptor
*endp
;
438 struct ipheth_device
*dev
;
439 struct net_device
*netdev
;
443 netdev
= alloc_etherdev(sizeof(struct ipheth_device
));
447 netdev
->netdev_ops
= &ipheth_netdev_ops
;
448 netdev
->watchdog_timeo
= IPHETH_TX_TIMEOUT
;
449 strcpy(netdev
->name
, "eth%d");
451 dev
= netdev_priv(netdev
);
456 /* Set up endpoints */
457 hintf
= usb_altnum_to_altsetting(intf
, IPHETH_ALT_INTFNUM
);
460 err("Unable to find alternate settings interface");
464 for (i
= 0; i
< hintf
->desc
.bNumEndpoints
; i
++) {
465 endp
= &hintf
->endpoint
[i
].desc
;
466 if (usb_endpoint_is_bulk_in(endp
))
467 dev
->bulk_in
= endp
->bEndpointAddress
;
468 else if (usb_endpoint_is_bulk_out(endp
))
469 dev
->bulk_out
= endp
->bEndpointAddress
;
471 if (!(dev
->bulk_in
&& dev
->bulk_out
)) {
473 err("Unable to find endpoints");
477 dev
->ctrl_buf
= kmalloc(IPHETH_CTRL_BUF_SIZE
, GFP_KERNEL
);
478 if (dev
->ctrl_buf
== NULL
) {
480 goto err_alloc_ctrl_buf
;
483 retval
= ipheth_get_macaddr(dev
);
485 goto err_get_macaddr
;
487 INIT_DELAYED_WORK(&dev
->carrier_work
, ipheth_carrier_check_work
);
489 retval
= ipheth_alloc_urbs(dev
);
491 err("error allocating urbs: %d", retval
);
495 usb_set_intfdata(intf
, dev
);
497 SET_NETDEV_DEV(netdev
, &intf
->dev
);
498 SET_ETHTOOL_OPS(netdev
, &ops
);
500 retval
= register_netdev(netdev
);
502 err("error registering netdev: %d", retval
);
504 goto err_register_netdev
;
507 dev_info(&intf
->dev
, "Apple iPhone USB Ethernet device attached\n");
511 ipheth_free_urbs(dev
);
515 kfree(dev
->ctrl_buf
);
521 static void ipheth_disconnect(struct usb_interface
*intf
)
523 struct ipheth_device
*dev
;
525 dev
= usb_get_intfdata(intf
);
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
);
533 usb_set_intfdata(intf
, NULL
);
534 dev_info(&intf
->dev
, "Apple iPhone USB Ethernet now disconnected\n");
537 static struct usb_driver ipheth_driver
= {
539 .probe
= ipheth_probe
,
540 .disconnect
= ipheth_disconnect
,
541 .id_table
= ipheth_table
,
544 static int __init
ipheth_init(void)
548 retval
= usb_register(&ipheth_driver
);
550 err("usb_register failed: %d", retval
);
556 static void __exit
ipheth_exit(void)
558 usb_deregister(&ipheth_driver
);
561 module_init(ipheth_init
);
562 module_exit(ipheth_exit
);
564 MODULE_AUTHOR("Diego Giagio <diego@giagio.com>");
565 MODULE_DESCRIPTION("Apple iPhone USB Ethernet driver");
566 MODULE_LICENSE("Dual BSD/GPL");