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_alloc_coherent(iphone->udev, IPHETH_BUF_SIZE,
132
GFP_KERNEL, &tx_urb->transfer_dma);
136
rx_buf = usb_alloc_coherent(iphone->udev, IPHETH_BUF_SIZE,
137
GFP_KERNEL, &rx_urb->transfer_dma);
142
iphone->tx_urb = tx_urb;
143
iphone->rx_urb = rx_urb;
144
iphone->tx_buf = tx_buf;
145
iphone->rx_buf = rx_buf;
149
usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, tx_buf,
150
tx_urb->transfer_dma);
152
usb_free_urb(rx_urb);
154
usb_free_urb(tx_urb);
159
static void ipheth_free_urbs(struct ipheth_device *iphone)
161
usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, iphone->rx_buf,
162
iphone->rx_urb->transfer_dma);
163
usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, iphone->tx_buf,
164
iphone->tx_urb->transfer_dma);
165
usb_free_urb(iphone->rx_urb);
166
usb_free_urb(iphone->tx_urb);
169
static void ipheth_kill_urbs(struct ipheth_device *dev)
171
usb_kill_urb(dev->tx_urb);
172
usb_kill_urb(dev->rx_urb);
175
static void ipheth_rcvbulk_callback(struct urb *urb)
177
struct ipheth_device *dev;
187
status = urb->status;
196
err("%s: urb status: %d", __func__, urb->status);
200
len = urb->actual_length;
201
buf = urb->transfer_buffer;
203
skb = dev_alloc_skb(NET_IP_ALIGN + len);
205
err("%s: dev_alloc_skb: -ENOMEM", __func__);
206
dev->net->stats.rx_dropped++;
210
skb_reserve(skb, NET_IP_ALIGN);
211
memcpy(skb_put(skb, len), buf + NET_IP_ALIGN, len - NET_IP_ALIGN);
213
skb->protocol = eth_type_trans(skb, dev->net);
215
dev->net->stats.rx_packets++;
216
dev->net->stats.rx_bytes += len;
219
ipheth_rx_submit(dev, GFP_ATOMIC);
222
static void ipheth_sndbulk_callback(struct urb *urb)
224
struct ipheth_device *dev;
230
if (urb->status != 0 &&
231
urb->status != -ENOENT &&
232
urb->status != -ECONNRESET &&
233
urb->status != -ESHUTDOWN)
234
err("%s: urb status: %d", __func__, urb->status);
236
dev_kfree_skb_irq(dev->tx_skb);
237
netif_wake_queue(dev->net);
240
static int ipheth_carrier_set(struct ipheth_device *dev)
242
struct usb_device *udev = dev->udev;
245
retval = usb_control_msg(udev,
246
usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
247
IPHETH_CMD_CARRIER_CHECK, /* request */
248
0xc0, /* request type */
251
dev->ctrl_buf, IPHETH_CTRL_BUF_SIZE,
252
IPHETH_CTRL_TIMEOUT);
254
err("%s: usb_control_msg: %d", __func__, retval);
258
if (dev->ctrl_buf[0] == IPHETH_CARRIER_ON)
259
netif_carrier_on(dev->net);
261
netif_carrier_off(dev->net);
266
static void ipheth_carrier_check_work(struct work_struct *work)
268
struct ipheth_device *dev = container_of(work, struct ipheth_device,
271
ipheth_carrier_set(dev);
272
schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
275
static int ipheth_get_macaddr(struct ipheth_device *dev)
277
struct usb_device *udev = dev->udev;
278
struct net_device *net = dev->net;
281
retval = usb_control_msg(udev,
282
usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
283
IPHETH_CMD_GET_MACADDR, /* request */
284
0xc0, /* request type */
288
IPHETH_CTRL_BUF_SIZE,
289
IPHETH_CTRL_TIMEOUT);
291
err("%s: usb_control_msg: %d", __func__, retval);
292
} else if (retval < ETH_ALEN) {
293
err("%s: usb_control_msg: short packet: %d bytes",
297
memcpy(net->dev_addr, dev->ctrl_buf, ETH_ALEN);
304
static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags)
306
struct usb_device *udev = dev->udev;
309
usb_fill_bulk_urb(dev->rx_urb, udev,
310
usb_rcvbulkpipe(udev, dev->bulk_in),
311
dev->rx_buf, IPHETH_BUF_SIZE,
312
ipheth_rcvbulk_callback,
314
dev->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
316
retval = usb_submit_urb(dev->rx_urb, mem_flags);
318
err("%s: usb_submit_urb: %d", __func__, retval);
322
static int ipheth_open(struct net_device *net)
324
struct ipheth_device *dev = netdev_priv(net);
325
struct usb_device *udev = dev->udev;
328
usb_set_interface(udev, IPHETH_INTFNUM, IPHETH_ALT_INTFNUM);
330
retval = ipheth_carrier_set(dev);
334
retval = ipheth_rx_submit(dev, GFP_KERNEL);
338
schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
339
netif_start_queue(net);
343
static int ipheth_close(struct net_device *net)
345
struct ipheth_device *dev = netdev_priv(net);
347
cancel_delayed_work_sync(&dev->carrier_work);
348
netif_stop_queue(net);
352
static int ipheth_tx(struct sk_buff *skb, struct net_device *net)
354
struct ipheth_device *dev = netdev_priv(net);
355
struct usb_device *udev = dev->udev;
359
if (skb->len > IPHETH_BUF_SIZE) {
360
WARN(1, "%s: skb too large: %d bytes", __func__, skb->len);
361
dev->net->stats.tx_dropped++;
362
dev_kfree_skb_irq(skb);
366
memcpy(dev->tx_buf, skb->data, skb->len);
367
if (skb->len < IPHETH_BUF_SIZE)
368
memset(dev->tx_buf + skb->len, 0, IPHETH_BUF_SIZE - skb->len);
370
usb_fill_bulk_urb(dev->tx_urb, udev,
371
usb_sndbulkpipe(udev, dev->bulk_out),
372
dev->tx_buf, IPHETH_BUF_SIZE,
373
ipheth_sndbulk_callback,
375
dev->tx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
377
retval = usb_submit_urb(dev->tx_urb, GFP_ATOMIC);
379
err("%s: usb_submit_urb: %d", __func__, retval);
380
dev->net->stats.tx_errors++;
381
dev_kfree_skb_irq(skb);
385
dev->net->stats.tx_packets++;
386
dev->net->stats.tx_bytes += skb->len;
387
netif_stop_queue(net);
393
static void ipheth_tx_timeout(struct net_device *net)
395
struct ipheth_device *dev = netdev_priv(net);
397
err("%s: TX timeout", __func__);
398
dev->net->stats.tx_errors++;
399
usb_unlink_urb(dev->tx_urb);
402
static struct net_device_stats *ipheth_stats(struct net_device *net)
404
struct ipheth_device *dev = netdev_priv(net);
405
return &dev->net->stats;
408
static u32 ipheth_ethtool_op_get_link(struct net_device *net)
410
struct ipheth_device *dev = netdev_priv(net);
411
return netif_carrier_ok(dev->net);
414
static struct ethtool_ops ops = {
415
.get_link = ipheth_ethtool_op_get_link
418
static const struct net_device_ops ipheth_netdev_ops = {
419
.ndo_open = &ipheth_open,
420
.ndo_stop = &ipheth_close,
421
.ndo_start_xmit = &ipheth_tx,
422
.ndo_tx_timeout = &ipheth_tx_timeout,
423
.ndo_get_stats = &ipheth_stats,
426
static struct device_type ipheth_type = {
430
static int ipheth_probe(struct usb_interface *intf,
431
const struct usb_device_id *id)
433
struct usb_device *udev = interface_to_usbdev(intf);
434
struct usb_host_interface *hintf;
435
struct usb_endpoint_descriptor *endp;
436
struct ipheth_device *dev;
437
struct net_device *netdev;
441
netdev = alloc_etherdev(sizeof(struct ipheth_device));
445
netdev->netdev_ops = &ipheth_netdev_ops;
446
netdev->watchdog_timeo = IPHETH_TX_TIMEOUT;
447
strcpy(netdev->name, "wwan%d");
449
dev = netdev_priv(netdev);
454
/* Set up endpoints */
455
hintf = usb_altnum_to_altsetting(intf, IPHETH_ALT_INTFNUM);
458
err("Unable to find alternate settings interface");
462
for (i = 0; i < hintf->desc.bNumEndpoints; i++) {
463
endp = &hintf->endpoint[i].desc;
464
if (usb_endpoint_is_bulk_in(endp))
465
dev->bulk_in = endp->bEndpointAddress;
466
else if (usb_endpoint_is_bulk_out(endp))
467
dev->bulk_out = endp->bEndpointAddress;
469
if (!(dev->bulk_in && dev->bulk_out)) {
471
err("Unable to find endpoints");
475
dev->ctrl_buf = kmalloc(IPHETH_CTRL_BUF_SIZE, GFP_KERNEL);
476
if (dev->ctrl_buf == NULL) {
478
goto err_alloc_ctrl_buf;
481
retval = ipheth_get_macaddr(dev);
483
goto err_get_macaddr;
485
INIT_DELAYED_WORK(&dev->carrier_work, ipheth_carrier_check_work);
487
retval = ipheth_alloc_urbs(dev);
489
err("error allocating urbs: %d", retval);
493
usb_set_intfdata(intf, dev);
495
SET_NETDEV_DEV(netdev, &intf->dev);
496
SET_ETHTOOL_OPS(netdev, &ops);
497
SET_NETDEV_DEVTYPE(netdev, &ipheth_type);
499
retval = register_netdev(netdev);
501
err("error registering netdev: %d", retval);
503
goto err_register_netdev;
506
dev_info(&intf->dev, "Apple iPhone USB Ethernet device attached\n");
510
ipheth_free_urbs(dev);
514
kfree(dev->ctrl_buf);
520
static void ipheth_disconnect(struct usb_interface *intf)
522
struct ipheth_device *dev;
524
dev = usb_get_intfdata(intf);
526
unregister_netdev(dev->net);
527
ipheth_kill_urbs(dev);
528
ipheth_free_urbs(dev);
529
kfree(dev->ctrl_buf);
530
free_netdev(dev->net);
532
usb_set_intfdata(intf, NULL);
533
dev_info(&intf->dev, "Apple iPhone USB Ethernet now disconnected\n");
536
static struct usb_driver ipheth_driver = {
538
.probe = ipheth_probe,
539
.disconnect = ipheth_disconnect,
540
.id_table = ipheth_table,
543
static int __init ipheth_init(void)
547
retval = usb_register(&ipheth_driver);
549
err("usb_register failed: %d", retval);
555
static void __exit ipheth_exit(void)
557
usb_deregister(&ipheth_driver);
560
module_init(ipheth_init);
561
module_exit(ipheth_exit);
563
MODULE_AUTHOR("Diego Giagio <diego@giagio.com>");
564
MODULE_DESCRIPTION("Apple iPhone USB Ethernet driver");
565
MODULE_LICENSE("Dual BSD/GPL");