Linux 4.19.133
[linux/fpc-iii.git] / drivers / net / usb / ipheth.c
blob3d71f17163902af71bb7485de78f5a3ed7af304c
1 /*
2 * ipheth.c - Apple iPhone USB Ethernet driver
4 * Copyright (c) 2009 Diego Giagio <diego@giagio.com>
5 * All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
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
38 * DAMAGE.
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 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;
154 static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags);
156 static int ipheth_alloc_urbs(struct ipheth_device *iphone)
158 struct urb *tx_urb = NULL;
159 struct urb *rx_urb = NULL;
160 u8 *tx_buf = NULL;
161 u8 *rx_buf = NULL;
163 tx_urb = usb_alloc_urb(0, GFP_KERNEL);
164 if (tx_urb == NULL)
165 goto error_nomem;
167 rx_urb = usb_alloc_urb(0, GFP_KERNEL);
168 if (rx_urb == NULL)
169 goto free_tx_urb;
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;
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;
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;
188 free_tx_buf:
189 usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, tx_buf,
190 tx_urb->transfer_dma);
191 free_rx_urb:
192 usb_free_urb(rx_urb);
193 free_tx_urb:
194 usb_free_urb(tx_urb);
195 error_nomem:
196 return -ENOMEM;
199 static void ipheth_free_urbs(struct ipheth_device *iphone)
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);
209 static void ipheth_kill_urbs(struct ipheth_device *dev)
211 usb_kill_urb(dev->tx_urb);
212 usb_kill_urb(dev->rx_urb);
215 static void ipheth_rcvbulk_callback(struct urb *urb)
217 struct ipheth_device *dev;
218 struct sk_buff *skb;
219 int status;
220 char *buf;
221 int len;
223 dev = urb->context;
224 if (dev == NULL)
225 return;
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;
242 if (urb->actual_length <= IPHETH_IP_ALIGN) {
243 dev->net->stats.rx_length_errors++;
244 return;
246 len = urb->actual_length - IPHETH_IP_ALIGN;
247 buf = urb->transfer_buffer + IPHETH_IP_ALIGN;
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;
257 skb_put_data(skb, buf, len);
258 skb->dev = dev->net;
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;
264 netif_rx(skb);
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;
273 dev = urb->context;
274 if (dev == NULL)
275 return;
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);
284 if (status == 0)
285 netif_wake_queue(dev->net);
286 else
287 // on URB error, trigger immediate poll
288 schedule_delayed_work(&dev->carrier_work, 0);
291 static int ipheth_carrier_set(struct ipheth_device *dev)
293 struct usb_device *udev;
294 int retval;
296 if (!dev)
297 return 0;
298 if (!dev->confirmed_pairing)
299 return 0;
301 udev = dev->udev;
302 retval = usb_control_msg(udev,
303 usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
304 IPHETH_CMD_CARRIER_CHECK, /* request */
305 0xc0, /* request type */
306 0x00, /* value */
307 0x02, /* index */
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;
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);
324 return 0;
327 static void ipheth_carrier_check_work(struct work_struct *work)
329 struct ipheth_device *dev = container_of(work, struct ipheth_device,
330 carrier_work.work);
332 ipheth_carrier_set(dev);
333 schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
336 static int ipheth_get_macaddr(struct ipheth_device *dev)
338 struct usb_device *udev = dev->udev;
339 struct net_device *net = dev->net;
340 int retval;
342 retval = usb_control_msg(udev,
343 usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
344 IPHETH_CMD_GET_MACADDR, /* request */
345 0xc0, /* request type */
346 0x00, /* value */
347 0x02, /* index */
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;
364 return retval;
367 static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags)
369 struct usb_device *udev = dev->udev;
370 int retval;
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;
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;
386 static int ipheth_open(struct net_device *net)
388 struct ipheth_device *dev = netdev_priv(net);
389 struct usb_device *udev = dev->udev;
390 int retval = 0;
392 usb_set_interface(udev, IPHETH_INTFNUM, IPHETH_ALT_INTFNUM);
394 retval = ipheth_carrier_set(dev);
395 if (retval)
396 return retval;
398 retval = ipheth_rx_submit(dev, GFP_KERNEL);
399 if (retval)
400 return retval;
402 schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
403 return retval;
406 static int ipheth_close(struct net_device *net)
408 struct ipheth_device *dev = netdev_priv(net);
410 cancel_delayed_work_sync(&dev->carrier_work);
411 netif_stop_queue(net);
412 return 0;
415 static int ipheth_tx(struct sk_buff *skb, struct net_device *net)
417 struct ipheth_device *dev = netdev_priv(net);
418 struct usb_device *udev = dev->udev;
419 int retval;
421 /* Paranoid */
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;
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);
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;
440 netif_stop_queue(net);
441 retval = usb_submit_urb(dev->tx_urb, GFP_ATOMIC);
442 if (retval) {
443 dev_err(&dev->intf->dev, "%s: usb_submit_urb: %d\n",
444 __func__, retval);
445 dev->net->stats.tx_errors++;
446 dev_kfree_skb_any(skb);
447 netif_wake_queue(net);
448 } else {
449 dev->net->stats.tx_packets++;
450 dev->net->stats.tx_bytes += skb->len;
451 dev_consume_skb_any(skb);
454 return NETDEV_TX_OK;
457 static void ipheth_tx_timeout(struct net_device *net)
459 struct ipheth_device *dev = netdev_priv(net);
461 dev_err(&dev->intf->dev, "%s: TX timeout\n", __func__);
462 dev->net->stats.tx_errors++;
463 usb_unlink_urb(dev->tx_urb);
466 static u32 ipheth_ethtool_op_get_link(struct net_device *net)
468 struct ipheth_device *dev = netdev_priv(net);
469 return netif_carrier_ok(dev->net);
472 static const struct ethtool_ops ops = {
473 .get_link = ipheth_ethtool_op_get_link
476 static const struct net_device_ops ipheth_netdev_ops = {
477 .ndo_open = ipheth_open,
478 .ndo_stop = ipheth_close,
479 .ndo_start_xmit = ipheth_tx,
480 .ndo_tx_timeout = ipheth_tx_timeout,
483 static int ipheth_probe(struct usb_interface *intf,
484 const struct usb_device_id *id)
486 struct usb_device *udev = interface_to_usbdev(intf);
487 struct usb_host_interface *hintf;
488 struct usb_endpoint_descriptor *endp;
489 struct ipheth_device *dev;
490 struct net_device *netdev;
491 int i;
492 int retval;
494 netdev = alloc_etherdev(sizeof(struct ipheth_device));
495 if (!netdev)
496 return -ENOMEM;
498 netdev->netdev_ops = &ipheth_netdev_ops;
499 netdev->watchdog_timeo = IPHETH_TX_TIMEOUT;
500 strcpy(netdev->name, "eth%d");
502 dev = netdev_priv(netdev);
503 dev->udev = udev;
504 dev->net = netdev;
505 dev->intf = intf;
506 dev->confirmed_pairing = false;
507 /* Set up endpoints */
508 hintf = usb_altnum_to_altsetting(intf, IPHETH_ALT_INTFNUM);
509 if (hintf == NULL) {
510 retval = -ENODEV;
511 dev_err(&intf->dev, "Unable to find alternate settings interface\n");
512 goto err_endpoints;
515 for (i = 0; i < hintf->desc.bNumEndpoints; i++) {
516 endp = &hintf->endpoint[i].desc;
517 if (usb_endpoint_is_bulk_in(endp))
518 dev->bulk_in = endp->bEndpointAddress;
519 else if (usb_endpoint_is_bulk_out(endp))
520 dev->bulk_out = endp->bEndpointAddress;
522 if (!(dev->bulk_in && dev->bulk_out)) {
523 retval = -ENODEV;
524 dev_err(&intf->dev, "Unable to find endpoints\n");
525 goto err_endpoints;
528 dev->ctrl_buf = kmalloc(IPHETH_CTRL_BUF_SIZE, GFP_KERNEL);
529 if (dev->ctrl_buf == NULL) {
530 retval = -ENOMEM;
531 goto err_alloc_ctrl_buf;
534 retval = ipheth_get_macaddr(dev);
535 if (retval)
536 goto err_get_macaddr;
538 INIT_DELAYED_WORK(&dev->carrier_work, ipheth_carrier_check_work);
540 retval = ipheth_alloc_urbs(dev);
541 if (retval) {
542 dev_err(&intf->dev, "error allocating urbs: %d\n", retval);
543 goto err_alloc_urbs;
546 usb_set_intfdata(intf, dev);
548 SET_NETDEV_DEV(netdev, &intf->dev);
549 netdev->ethtool_ops = &ops;
551 retval = register_netdev(netdev);
552 if (retval) {
553 dev_err(&intf->dev, "error registering netdev: %d\n", retval);
554 retval = -EIO;
555 goto err_register_netdev;
557 // carrier down and transmit queues stopped until packet from device
558 netif_carrier_off(netdev);
559 netif_tx_stop_all_queues(netdev);
560 dev_info(&intf->dev, "Apple iPhone USB Ethernet device attached\n");
561 return 0;
563 err_register_netdev:
564 ipheth_free_urbs(dev);
565 err_alloc_urbs:
566 err_get_macaddr:
567 err_alloc_ctrl_buf:
568 kfree(dev->ctrl_buf);
569 err_endpoints:
570 free_netdev(netdev);
571 return retval;
574 static void ipheth_disconnect(struct usb_interface *intf)
576 struct ipheth_device *dev;
578 dev = usb_get_intfdata(intf);
579 if (dev != NULL) {
580 unregister_netdev(dev->net);
581 ipheth_kill_urbs(dev);
582 ipheth_free_urbs(dev);
583 kfree(dev->ctrl_buf);
584 free_netdev(dev->net);
586 usb_set_intfdata(intf, NULL);
587 dev_info(&intf->dev, "Apple iPhone USB Ethernet now disconnected\n");
590 static struct usb_driver ipheth_driver = {
591 .name = "ipheth",
592 .probe = ipheth_probe,
593 .disconnect = ipheth_disconnect,
594 .id_table = ipheth_table,
595 .disable_hub_initiated_lpm = 1,
598 module_usb_driver(ipheth_driver);
600 MODULE_AUTHOR("Diego Giagio <diego@giagio.com>");
601 MODULE_DESCRIPTION("Apple iPhone USB Ethernet driver");
602 MODULE_LICENSE("Dual BSD/GPL");