1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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>
55
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
68
69#define IPHETH_USBINTF_CLASS 255
70#define IPHETH_USBINTF_SUBCLASS 253
71#define IPHETH_USBINTF_PROTO 1
72
73#define IPHETH_BUF_SIZE 1516
74#define IPHETH_IP_ALIGN 2
75#define IPHETH_TX_TIMEOUT (5 * HZ)
76
77#define IPHETH_INTFNUM 2
78#define IPHETH_ALT_INTFNUM 1
79
80#define IPHETH_CTRL_ENDP 0x00
81#define IPHETH_CTRL_BUF_SIZE 0x40
82#define IPHETH_CTRL_TIMEOUT (5 * HZ)
83
84#define IPHETH_CMD_GET_MACADDR 0x00
85#define IPHETH_CMD_CARRIER_CHECK 0x45
86
87#define IPHETH_CARRIER_CHECK_TIMEOUT round_jiffies_relative(1 * HZ)
88#define IPHETH_CARRIER_ON 0x04
89
90static 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) },
135 { }
136};
137MODULE_DEVICE_TABLE(usb, ipheth_table);
138
139struct ipheth_device {
140 struct usb_device *udev;
141 struct usb_interface *intf;
142 struct net_device *net;
143 struct urb *tx_urb;
144 struct urb *rx_urb;
145 unsigned char *tx_buf;
146 unsigned char *rx_buf;
147 unsigned char *ctrl_buf;
148 u8 bulk_in;
149 u8 bulk_out;
150 struct delayed_work carrier_work;
151 bool confirmed_pairing;
152};
153
154static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags);
155
156static int ipheth_alloc_urbs(struct ipheth_device *iphone)
157{
158 struct urb *tx_urb = NULL;
159 struct urb *rx_urb = NULL;
160 u8 *tx_buf = NULL;
161 u8 *rx_buf = NULL;
162
163 tx_urb = usb_alloc_urb(0, GFP_KERNEL);
164 if (tx_urb == NULL)
165 goto error_nomem;
166
167 rx_urb = usb_alloc_urb(0, GFP_KERNEL);
168 if (rx_urb == NULL)
169 goto free_tx_urb;
170
171 tx_buf = usb_alloc_coherent(iphone->udev, IPHETH_BUF_SIZE,
172 GFP_KERNEL, &tx_urb->transfer_dma);
173 if (tx_buf == NULL)
174 goto free_rx_urb;
175
176 rx_buf = usb_alloc_coherent(iphone->udev, IPHETH_BUF_SIZE,
177 GFP_KERNEL, &rx_urb->transfer_dma);
178 if (rx_buf == NULL)
179 goto free_tx_buf;
180
181
182 iphone->tx_urb = tx_urb;
183 iphone->rx_urb = rx_urb;
184 iphone->tx_buf = tx_buf;
185 iphone->rx_buf = rx_buf;
186 return 0;
187
188free_tx_buf:
189 usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, tx_buf,
190 tx_urb->transfer_dma);
191free_rx_urb:
192 usb_free_urb(rx_urb);
193free_tx_urb:
194 usb_free_urb(tx_urb);
195error_nomem:
196 return -ENOMEM;
197}
198
199static void ipheth_free_urbs(struct ipheth_device *iphone)
200{
201 usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, iphone->rx_buf,
202 iphone->rx_urb->transfer_dma);
203 usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, iphone->tx_buf,
204 iphone->tx_urb->transfer_dma);
205 usb_free_urb(iphone->rx_urb);
206 usb_free_urb(iphone->tx_urb);
207}
208
209static void ipheth_kill_urbs(struct ipheth_device *dev)
210{
211 usb_kill_urb(dev->tx_urb);
212 usb_kill_urb(dev->rx_urb);
213}
214
215static void ipheth_rcvbulk_callback(struct urb *urb)
216{
217 struct ipheth_device *dev;
218 struct sk_buff *skb;
219 int status;
220 char *buf;
221 int len;
222
223 dev = urb->context;
224 if (dev == NULL)
225 return;
226
227 status = urb->status;
228 switch (status) {
229 case -ENOENT:
230 case -ECONNRESET:
231 case -ESHUTDOWN:
232 case -EPROTO:
233 return;
234 case 0:
235 break;
236 default:
237 dev_err(&dev->intf->dev, "%s: urb status: %d\n",
238 __func__, status);
239 return;
240 }
241
242 if (urb->actual_length <= IPHETH_IP_ALIGN) {
243 dev->net->stats.rx_length_errors++;
244 return;
245 }
246 len = urb->actual_length - IPHETH_IP_ALIGN;
247 buf = urb->transfer_buffer + IPHETH_IP_ALIGN;
248
249 skb = dev_alloc_skb(len);
250 if (!skb) {
251 dev_err(&dev->intf->dev, "%s: dev_alloc_skb: -ENOMEM\n",
252 __func__);
253 dev->net->stats.rx_dropped++;
254 return;
255 }
256
257 skb_put_data(skb, buf, len);
258 skb->dev = dev->net;
259 skb->protocol = eth_type_trans(skb, dev->net);
260
261 dev->net->stats.rx_packets++;
262 dev->net->stats.rx_bytes += len;
263 dev->confirmed_pairing = true;
264 netif_rx(skb);
265 ipheth_rx_submit(dev, GFP_ATOMIC);
266}
267
268static void ipheth_sndbulk_callback(struct urb *urb)
269{
270 struct ipheth_device *dev;
271 int status = urb->status;
272
273 dev = urb->context;
274 if (dev == NULL)
275 return;
276
277 if (status != 0 &&
278 status != -ENOENT &&
279 status != -ECONNRESET &&
280 status != -ESHUTDOWN)
281 dev_err(&dev->intf->dev, "%s: urb status: %d\n",
282 __func__, status);
283
284 if (status == 0)
285 netif_wake_queue(dev->net);
286 else
287
288 schedule_delayed_work(&dev->carrier_work, 0);
289}
290
291static int ipheth_carrier_set(struct ipheth_device *dev)
292{
293 struct usb_device *udev;
294 int retval;
295
296 if (!dev)
297 return 0;
298 if (!dev->confirmed_pairing)
299 return 0;
300
301 udev = dev->udev;
302 retval = usb_control_msg(udev,
303 usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
304 IPHETH_CMD_CARRIER_CHECK,
305 0xc0,
306 0x00,
307 0x02,
308 dev->ctrl_buf, IPHETH_CTRL_BUF_SIZE,
309 IPHETH_CTRL_TIMEOUT);
310 if (retval < 0) {
311 dev_err(&dev->intf->dev, "%s: usb_control_msg: %d\n",
312 __func__, retval);
313 return retval;
314 }
315
316 if (dev->ctrl_buf[0] == IPHETH_CARRIER_ON) {
317 netif_carrier_on(dev->net);
318 if (dev->tx_urb->status != -EINPROGRESS)
319 netif_wake_queue(dev->net);
320 } else {
321 netif_carrier_off(dev->net);
322 netif_stop_queue(dev->net);
323 }
324 return 0;
325}
326
327static void ipheth_carrier_check_work(struct work_struct *work)
328{
329 struct ipheth_device *dev = container_of(work, struct ipheth_device,
330 carrier_work.work);
331
332 ipheth_carrier_set(dev);
333 schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
334}
335
336static int ipheth_get_macaddr(struct ipheth_device *dev)
337{
338 struct usb_device *udev = dev->udev;
339 struct net_device *net = dev->net;
340 int retval;
341
342 retval = usb_control_msg(udev,
343 usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
344 IPHETH_CMD_GET_MACADDR,
345 0xc0,
346 0x00,
347 0x02,
348 dev->ctrl_buf,
349 IPHETH_CTRL_BUF_SIZE,
350 IPHETH_CTRL_TIMEOUT);
351 if (retval < 0) {
352 dev_err(&dev->intf->dev, "%s: usb_control_msg: %d\n",
353 __func__, retval);
354 } else if (retval < ETH_ALEN) {
355 dev_err(&dev->intf->dev,
356 "%s: usb_control_msg: short packet: %d bytes\n",
357 __func__, retval);
358 retval = -EINVAL;
359 } else {
360 memcpy(net->dev_addr, dev->ctrl_buf, ETH_ALEN);
361 retval = 0;
362 }
363
364 return retval;
365}
366
367static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags)
368{
369 struct usb_device *udev = dev->udev;
370 int retval;
371
372 usb_fill_bulk_urb(dev->rx_urb, udev,
373 usb_rcvbulkpipe(udev, dev->bulk_in),
374 dev->rx_buf, IPHETH_BUF_SIZE,
375 ipheth_rcvbulk_callback,
376 dev);
377 dev->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
378
379 retval = usb_submit_urb(dev->rx_urb, mem_flags);
380 if (retval)
381 dev_err(&dev->intf->dev, "%s: usb_submit_urb: %d\n",
382 __func__, retval);
383 return retval;
384}
385
386static int ipheth_open(struct net_device *net)
387{
388 struct ipheth_device *dev = netdev_priv(net);
389 struct usb_device *udev = dev->udev;
390 int retval = 0;
391
392 usb_set_interface(udev, IPHETH_INTFNUM, IPHETH_ALT_INTFNUM);
393
394 retval = ipheth_carrier_set(dev);
395 if (retval)
396 return retval;
397
398 retval = ipheth_rx_submit(dev, GFP_KERNEL);
399 if (retval)
400 return retval;
401
402 schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
403 return retval;
404}
405
406static int ipheth_close(struct net_device *net)
407{
408 struct ipheth_device *dev = netdev_priv(net);
409
410 cancel_delayed_work_sync(&dev->carrier_work);
411 netif_stop_queue(net);
412 return 0;
413}
414
415static int ipheth_tx(struct sk_buff *skb, struct net_device *net)
416{
417 struct ipheth_device *dev = netdev_priv(net);
418 struct usb_device *udev = dev->udev;
419 int retval;
420
421
422 if (skb->len > IPHETH_BUF_SIZE) {
423 WARN(1, "%s: skb too large: %d bytes\n", __func__, skb->len);
424 dev->net->stats.tx_dropped++;
425 dev_kfree_skb_any(skb);
426 return NETDEV_TX_OK;
427 }
428
429 memcpy(dev->tx_buf, skb->data, skb->len);
430 if (skb->len < IPHETH_BUF_SIZE)
431 memset(dev->tx_buf + skb->len, 0, IPHETH_BUF_SIZE - skb->len);
432
433 usb_fill_bulk_urb(dev->tx_urb, udev,
434 usb_sndbulkpipe(udev, dev->bulk_out),
435 dev->tx_buf, IPHETH_BUF_SIZE,
436 ipheth_sndbulk_callback,
437 dev);
438 dev->tx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
439
440 retval = usb_submit_urb(dev->tx_urb, GFP_ATOMIC);
441 if (retval) {
442 dev_err(&dev->intf->dev, "%s: usb_submit_urb: %d\n",
443 __func__, retval);
444 dev->net->stats.tx_errors++;
445 dev_kfree_skb_any(skb);
446 } else {
447 dev->net->stats.tx_packets++;
448 dev->net->stats.tx_bytes += skb->len;
449 dev_consume_skb_any(skb);
450 netif_stop_queue(net);
451 }
452
453 return NETDEV_TX_OK;
454}
455
456static void ipheth_tx_timeout(struct net_device *net)
457{
458 struct ipheth_device *dev = netdev_priv(net);
459
460 dev_err(&dev->intf->dev, "%s: TX timeout\n", __func__);
461 dev->net->stats.tx_errors++;
462 usb_unlink_urb(dev->tx_urb);
463}
464
465static u32 ipheth_ethtool_op_get_link(struct net_device *net)
466{
467 struct ipheth_device *dev = netdev_priv(net);
468 return netif_carrier_ok(dev->net);
469}
470
471static const struct ethtool_ops ops = {
472 .get_link = ipheth_ethtool_op_get_link
473};
474
475static const struct net_device_ops ipheth_netdev_ops = {
476 .ndo_open = ipheth_open,
477 .ndo_stop = ipheth_close,
478 .ndo_start_xmit = ipheth_tx,
479 .ndo_tx_timeout = ipheth_tx_timeout,
480};
481
482static int ipheth_probe(struct usb_interface *intf,
483 const struct usb_device_id *id)
484{
485 struct usb_device *udev = interface_to_usbdev(intf);
486 struct usb_host_interface *hintf;
487 struct usb_endpoint_descriptor *endp;
488 struct ipheth_device *dev;
489 struct net_device *netdev;
490 int i;
491 int retval;
492
493 netdev = alloc_etherdev(sizeof(struct ipheth_device));
494 if (!netdev)
495 return -ENOMEM;
496
497 netdev->netdev_ops = &ipheth_netdev_ops;
498 netdev->watchdog_timeo = IPHETH_TX_TIMEOUT;
499 strcpy(netdev->name, "eth%d");
500
501 dev = netdev_priv(netdev);
502 dev->udev = udev;
503 dev->net = netdev;
504 dev->intf = intf;
505 dev->confirmed_pairing = false;
506
507 hintf = usb_altnum_to_altsetting(intf, IPHETH_ALT_INTFNUM);
508 if (hintf == NULL) {
509 retval = -ENODEV;
510 dev_err(&intf->dev, "Unable to find alternate settings interface\n");
511 goto err_endpoints;
512 }
513
514 for (i = 0; i < hintf->desc.bNumEndpoints; i++) {
515 endp = &hintf->endpoint[i].desc;
516 if (usb_endpoint_is_bulk_in(endp))
517 dev->bulk_in = endp->bEndpointAddress;
518 else if (usb_endpoint_is_bulk_out(endp))
519 dev->bulk_out = endp->bEndpointAddress;
520 }
521 if (!(dev->bulk_in && dev->bulk_out)) {
522 retval = -ENODEV;
523 dev_err(&intf->dev, "Unable to find endpoints\n");
524 goto err_endpoints;
525 }
526
527 dev->ctrl_buf = kmalloc(IPHETH_CTRL_BUF_SIZE, GFP_KERNEL);
528 if (dev->ctrl_buf == NULL) {
529 retval = -ENOMEM;
530 goto err_alloc_ctrl_buf;
531 }
532
533 retval = ipheth_get_macaddr(dev);
534 if (retval)
535 goto err_get_macaddr;
536
537 INIT_DELAYED_WORK(&dev->carrier_work, ipheth_carrier_check_work);
538
539 retval = ipheth_alloc_urbs(dev);
540 if (retval) {
541 dev_err(&intf->dev, "error allocating urbs: %d\n", retval);
542 goto err_alloc_urbs;
543 }
544
545 usb_set_intfdata(intf, dev);
546
547 SET_NETDEV_DEV(netdev, &intf->dev);
548 netdev->ethtool_ops = &ops;
549
550 retval = register_netdev(netdev);
551 if (retval) {
552 dev_err(&intf->dev, "error registering netdev: %d\n", retval);
553 retval = -EIO;
554 goto err_register_netdev;
555 }
556
557 netif_carrier_off(netdev);
558 netif_tx_stop_all_queues(netdev);
559 dev_info(&intf->dev, "Apple iPhone USB Ethernet device attached\n");
560 return 0;
561
562err_register_netdev:
563 ipheth_free_urbs(dev);
564err_alloc_urbs:
565err_get_macaddr:
566err_alloc_ctrl_buf:
567 kfree(dev->ctrl_buf);
568err_endpoints:
569 free_netdev(netdev);
570 return retval;
571}
572
573static void ipheth_disconnect(struct usb_interface *intf)
574{
575 struct ipheth_device *dev;
576
577 dev = usb_get_intfdata(intf);
578 if (dev != NULL) {
579 unregister_netdev(dev->net);
580 ipheth_kill_urbs(dev);
581 ipheth_free_urbs(dev);
582 kfree(dev->ctrl_buf);
583 free_netdev(dev->net);
584 }
585 usb_set_intfdata(intf, NULL);
586 dev_info(&intf->dev, "Apple iPhone USB Ethernet now disconnected\n");
587}
588
589static struct usb_driver ipheth_driver = {
590 .name = "ipheth",
591 .probe = ipheth_probe,
592 .disconnect = ipheth_disconnect,
593 .id_table = ipheth_table,
594 .disable_hub_initiated_lpm = 1,
595};
596
597module_usb_driver(ipheth_driver);
598
599MODULE_AUTHOR("Diego Giagio <diego@giagio.com>");
600MODULE_DESCRIPTION("Apple iPhone USB Ethernet driver");
601MODULE_LICENSE("Dual BSD/GPL");
602
