[net-next-2.6.git] / drivers / net / usb / ipheth.c

/*
 * ipheth.c - Apple iPhone USB Ethernet driver
 *
 * Copyright (c) 2009 Diego Giagio <diego@giagio.com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of GIAGIO.COM nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * Alternatively, provided that this notice is retained in full, this
 * software may be distributed under the terms of the GNU General
 * Public License ("GPL") version 2, in which case the provisions of the
 * GPL apply INSTEAD OF those given above.
 *
 * The provided data structures and external interfaces from this code
 * are not restricted to be used by modules with a GPL compatible license.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 *
 * Attention: iPhone device must be paired, otherwise it won't respond to our
 * driver. For more info: http://giagio.com/wiki/moin.cgi/iPhoneEthernetDriver
 *
 */

#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/ethtool.h>
#include <linux/usb.h>
#include <linux/workqueue.h>

#define USB_VENDOR_APPLE        0x05ac
#define USB_PRODUCT_IPHONE      0x1290
#define USB_PRODUCT_IPHONE_3G   0x1292
#define USB_PRODUCT_IPHONE_3GS  0x1294
#define USB_PRODUCT_IPHONE_4	0x1297

#define IPHETH_USBINTF_CLASS    255
#define IPHETH_USBINTF_SUBCLASS 253
#define IPHETH_USBINTF_PROTO    1

#define IPHETH_BUF_SIZE         1516
#define IPHETH_TX_TIMEOUT       (5 * HZ)

#define IPHETH_INTFNUM          2
#define IPHETH_ALT_INTFNUM      1

#define IPHETH_CTRL_ENDP        0x00
#define IPHETH_CTRL_BUF_SIZE    0x40
#define IPHETH_CTRL_TIMEOUT     (5 * HZ)

#define IPHETH_CMD_GET_MACADDR   0x00
#define IPHETH_CMD_CARRIER_CHECK 0x45

#define IPHETH_CARRIER_CHECK_TIMEOUT round_jiffies_relative(1 * HZ)
#define IPHETH_CARRIER_ON       0x04

static struct usb_device_id ipheth_table[] = {
	{ USB_DEVICE_AND_INTERFACE_INFO(
		USB_VENDOR_APPLE, USB_PRODUCT_IPHONE,
		IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
		IPHETH_USBINTF_PROTO) },
	{ USB_DEVICE_AND_INTERFACE_INFO(
		USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_3G,
		IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
		IPHETH_USBINTF_PROTO) },
	{ USB_DEVICE_AND_INTERFACE_INFO(
		USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_3GS,
		IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
		IPHETH_USBINTF_PROTO) },
	{ USB_DEVICE_AND_INTERFACE_INFO(
		USB_VENDOR_APPLE, USB_PRODUCT_IPHONE_4,
		IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
		IPHETH_USBINTF_PROTO) },
	{ }
};
MODULE_DEVICE_TABLE(usb, ipheth_table);

struct ipheth_device {
	struct usb_device *udev;
	struct usb_interface *intf;
	struct net_device *net;
	struct sk_buff *tx_skb;
	struct urb *tx_urb;
	struct urb *rx_urb;
	unsigned char *tx_buf;
	unsigned char *rx_buf;
	unsigned char *ctrl_buf;
	u8 bulk_in;
	u8 bulk_out;
	struct delayed_work carrier_work;
};

static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags);

static int ipheth_alloc_urbs(struct ipheth_device *iphone)
{
	struct urb *tx_urb = NULL;
	struct urb *rx_urb = NULL;
	u8 *tx_buf = NULL;
	u8 *rx_buf = NULL;

	tx_urb = usb_alloc_urb(0, GFP_KERNEL);
	if (tx_urb == NULL)
		goto error_nomem;

	rx_urb = usb_alloc_urb(0, GFP_KERNEL);
	if (rx_urb == NULL)
		goto free_tx_urb;

	tx_buf = usb_alloc_coherent(iphone->udev, IPHETH_BUF_SIZE,
				    GFP_KERNEL, &tx_urb->transfer_dma);
	if (tx_buf == NULL)
		goto free_rx_urb;

	rx_buf = usb_alloc_coherent(iphone->udev, IPHETH_BUF_SIZE,
				    GFP_KERNEL, &rx_urb->transfer_dma);
	if (rx_buf == NULL)
		goto free_tx_buf;


	iphone->tx_urb = tx_urb;
	iphone->rx_urb = rx_urb;
	iphone->tx_buf = tx_buf;
	iphone->rx_buf = rx_buf;
	return 0;

free_tx_buf:
	usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, tx_buf,
			  tx_urb->transfer_dma);
free_rx_urb:
	usb_free_urb(rx_urb);
free_tx_urb:
	usb_free_urb(tx_urb);
error_nomem:
	return -ENOMEM;
}

static void ipheth_free_urbs(struct ipheth_device *iphone)
{
	usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, iphone->rx_buf,
			  iphone->rx_urb->transfer_dma);
	usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, iphone->tx_buf,
			  iphone->tx_urb->transfer_dma);
	usb_free_urb(iphone->rx_urb);
	usb_free_urb(iphone->tx_urb);
}

static void ipheth_kill_urbs(struct ipheth_device *dev)
{
	usb_kill_urb(dev->tx_urb);
	usb_kill_urb(dev->rx_urb);
}

static void ipheth_rcvbulk_callback(struct urb *urb)
{
	struct ipheth_device *dev;
	struct sk_buff *skb;
	int status;
	char *buf;
	int len;

	dev = urb->context;
	if (dev == NULL)
		return;

	status = urb->status;
	switch (status) {
	case -ENOENT:
	case -ECONNRESET:
	case -ESHUTDOWN:
		return;
	case 0:
		break;
	default:
		err("%s: urb status: %d", __func__, status);
		return;
	}

	len = urb->actual_length;
	buf = urb->transfer_buffer;

	skb = dev_alloc_skb(NET_IP_ALIGN + len);
	if (!skb) {
		err("%s: dev_alloc_skb: -ENOMEM", __func__);
		dev->net->stats.rx_dropped++;
		return;
	}

	skb_reserve(skb, NET_IP_ALIGN);
	memcpy(skb_put(skb, len), buf + NET_IP_ALIGN, len - NET_IP_ALIGN);
	skb->dev = dev->net;
	skb->protocol = eth_type_trans(skb, dev->net);

	dev->net->stats.rx_packets++;
	dev->net->stats.rx_bytes += len;

	netif_rx(skb);
	ipheth_rx_submit(dev, GFP_ATOMIC);
}

static void ipheth_sndbulk_callback(struct urb *urb)
{
	struct ipheth_device *dev;
	int status = urb->status;

	dev = urb->context;
	if (dev == NULL)
		return;

	if (status != 0 &&
	    status != -ENOENT &&
	    status != -ECONNRESET &&
	    status != -ESHUTDOWN)
		err("%s: urb status: %d", __func__, status);

	dev_kfree_skb_irq(dev->tx_skb);
	netif_wake_queue(dev->net);
}

static int ipheth_carrier_set(struct ipheth_device *dev)
{
	struct usb_device *udev = dev->udev;
	int retval;

	retval = usb_control_msg(udev,
			usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
			IPHETH_CMD_CARRIER_CHECK, /* request */
			0xc0, /* request type */
			0x00, /* value */
			0x02, /* index */
			dev->ctrl_buf, IPHETH_CTRL_BUF_SIZE,
			IPHETH_CTRL_TIMEOUT);
	if (retval < 0) {
		err("%s: usb_control_msg: %d", __func__, retval);
		return retval;
	}

	if (dev->ctrl_buf[0] == IPHETH_CARRIER_ON)
		netif_carrier_on(dev->net);
	else
		netif_carrier_off(dev->net);

	return 0;
}

static void ipheth_carrier_check_work(struct work_struct *work)
{
	struct ipheth_device *dev = container_of(work, struct ipheth_device,
						 carrier_work.work);

	ipheth_carrier_set(dev);
	schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
}

static int ipheth_get_macaddr(struct ipheth_device *dev)
{
	struct usb_device *udev = dev->udev;
	struct net_device *net = dev->net;
	int retval;

	retval = usb_control_msg(udev,
				 usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
				 IPHETH_CMD_GET_MACADDR, /* request */
				 0xc0, /* request type */
				 0x00, /* value */
				 0x02, /* index */
				 dev->ctrl_buf,
				 IPHETH_CTRL_BUF_SIZE,
				 IPHETH_CTRL_TIMEOUT);
	if (retval < 0) {
		err("%s: usb_control_msg: %d", __func__, retval);
	} else if (retval < ETH_ALEN) {
		err("%s: usb_control_msg: short packet: %d bytes",
			__func__, retval);
		retval = -EINVAL;
	} else {
		memcpy(net->dev_addr, dev->ctrl_buf, ETH_ALEN);
		retval = 0;
	}

	return retval;
}

static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags)
{
	struct usb_device *udev = dev->udev;
	int retval;

	usb_fill_bulk_urb(dev->rx_urb, udev,
			  usb_rcvbulkpipe(udev, dev->bulk_in),
			  dev->rx_buf, IPHETH_BUF_SIZE,
			  ipheth_rcvbulk_callback,
			  dev);
	dev->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

	retval = usb_submit_urb(dev->rx_urb, mem_flags);
	if (retval)
		err("%s: usb_submit_urb: %d", __func__, retval);
	return retval;
}

static int ipheth_open(struct net_device *net)
{
	struct ipheth_device *dev = netdev_priv(net);
	struct usb_device *udev = dev->udev;
	int retval = 0;

	usb_set_interface(udev, IPHETH_INTFNUM, IPHETH_ALT_INTFNUM);

	retval = ipheth_carrier_set(dev);
	if (retval)
		return retval;

	retval = ipheth_rx_submit(dev, GFP_KERNEL);
	if (retval)
		return retval;

	schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
	netif_start_queue(net);
	return retval;
}

static int ipheth_close(struct net_device *net)
{
	struct ipheth_device *dev = netdev_priv(net);

	cancel_delayed_work_sync(&dev->carrier_work);
	netif_stop_queue(net);
	return 0;
}

static int ipheth_tx(struct sk_buff *skb, struct net_device *net)
{
	struct ipheth_device *dev = netdev_priv(net);
	struct usb_device *udev = dev->udev;
	int retval;

	/* Paranoid */
	if (skb->len > IPHETH_BUF_SIZE) {
		WARN(1, "%s: skb too large: %d bytes", __func__, skb->len);
		dev->net->stats.tx_dropped++;
		dev_kfree_skb_irq(skb);
		return NETDEV_TX_OK;
	}

	memcpy(dev->tx_buf, skb->data, skb->len);
	if (skb->len < IPHETH_BUF_SIZE)
		memset(dev->tx_buf + skb->len, 0, IPHETH_BUF_SIZE - skb->len);

	usb_fill_bulk_urb(dev->tx_urb, udev,
			  usb_sndbulkpipe(udev, dev->bulk_out),
			  dev->tx_buf, IPHETH_BUF_SIZE,
			  ipheth_sndbulk_callback,
			  dev);
	dev->tx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

	retval = usb_submit_urb(dev->tx_urb, GFP_ATOMIC);
	if (retval) {
		err("%s: usb_submit_urb: %d", __func__, retval);
		dev->net->stats.tx_errors++;
		dev_kfree_skb_irq(skb);
	} else {
		dev->tx_skb = skb;

		dev->net->stats.tx_packets++;
		dev->net->stats.tx_bytes += skb->len;
		netif_stop_queue(net);
	}

	return NETDEV_TX_OK;
}

static void ipheth_tx_timeout(struct net_device *net)
{
	struct ipheth_device *dev = netdev_priv(net);

	err("%s: TX timeout", __func__);
	dev->net->stats.tx_errors++;
	usb_unlink_urb(dev->tx_urb);
}

static struct net_device_stats *ipheth_stats(struct net_device *net)
{
	struct ipheth_device *dev = netdev_priv(net);
	return &dev->net->stats;
}

static u32 ipheth_ethtool_op_get_link(struct net_device *net)
{
	struct ipheth_device *dev = netdev_priv(net);
	return netif_carrier_ok(dev->net);
}

static struct ethtool_ops ops = {
	.get_link = ipheth_ethtool_op_get_link
};

static const struct net_device_ops ipheth_netdev_ops = {
	.ndo_open = &ipheth_open,
	.ndo_stop = &ipheth_close,
	.ndo_start_xmit = &ipheth_tx,
	.ndo_tx_timeout = &ipheth_tx_timeout,
	.ndo_get_stats = &ipheth_stats,
};

static int ipheth_probe(struct usb_interface *intf,
			const struct usb_device_id *id)
{
	struct usb_device *udev = interface_to_usbdev(intf);
	struct usb_host_interface *hintf;
	struct usb_endpoint_descriptor *endp;
	struct ipheth_device *dev;
	struct net_device *netdev;
	int i;
	int retval;

	netdev = alloc_etherdev(sizeof(struct ipheth_device));
	if (!netdev)
		return -ENOMEM;

	netdev->netdev_ops = &ipheth_netdev_ops;
	netdev->watchdog_timeo = IPHETH_TX_TIMEOUT;
	strcpy(netdev->name, "eth%d");

	dev = netdev_priv(netdev);
	dev->udev = udev;
	dev->net = netdev;
	dev->intf = intf;

	/* Set up endpoints */
	hintf = usb_altnum_to_altsetting(intf, IPHETH_ALT_INTFNUM);
	if (hintf == NULL) {
		retval = -ENODEV;
		err("Unable to find alternate settings interface");
		goto err_endpoints;
	}

	for (i = 0; i < hintf->desc.bNumEndpoints; i++) {
		endp = &hintf->endpoint[i].desc;
		if (usb_endpoint_is_bulk_in(endp))
			dev->bulk_in = endp->bEndpointAddress;
		else if (usb_endpoint_is_bulk_out(endp))
			dev->bulk_out = endp->bEndpointAddress;
	}
	if (!(dev->bulk_in && dev->bulk_out)) {
		retval = -ENODEV;
		err("Unable to find endpoints");
		goto err_endpoints;
	}

	dev->ctrl_buf = kmalloc(IPHETH_CTRL_BUF_SIZE, GFP_KERNEL);
	if (dev->ctrl_buf == NULL) {
		retval = -ENOMEM;
		goto err_alloc_ctrl_buf;
	}

	retval = ipheth_get_macaddr(dev);
	if (retval)
		goto err_get_macaddr;

	INIT_DELAYED_WORK(&dev->carrier_work, ipheth_carrier_check_work);

	retval = ipheth_alloc_urbs(dev);
	if (retval) {
		err("error allocating urbs: %d", retval);
		goto err_alloc_urbs;
	}

	usb_set_intfdata(intf, dev);

	SET_NETDEV_DEV(netdev, &intf->dev);
	SET_ETHTOOL_OPS(netdev, &ops);

	retval = register_netdev(netdev);
	if (retval) {
		err("error registering netdev: %d", retval);
		retval = -EIO;
		goto err_register_netdev;
	}

	dev_info(&intf->dev, "Apple iPhone USB Ethernet device attached\n");
	return 0;

err_register_netdev:
	ipheth_free_urbs(dev);
err_alloc_urbs:
err_get_macaddr:
err_alloc_ctrl_buf:
	kfree(dev->ctrl_buf);
err_endpoints:
	free_netdev(netdev);
	return retval;
}

static void ipheth_disconnect(struct usb_interface *intf)
{
	struct ipheth_device *dev;

	dev = usb_get_intfdata(intf);
	if (dev != NULL) {
		unregister_netdev(dev->net);
		ipheth_kill_urbs(dev);
		ipheth_free_urbs(dev);
		kfree(dev->ctrl_buf);
		free_netdev(dev->net);
	}
	usb_set_intfdata(intf, NULL);
	dev_info(&intf->dev, "Apple iPhone USB Ethernet now disconnected\n");
}

static struct usb_driver ipheth_driver = {
	.name =		"ipheth",
	.probe =	ipheth_probe,
	.disconnect =	ipheth_disconnect,
	.id_table =	ipheth_table,
};

static int __init ipheth_init(void)
{
	int retval;

	retval = usb_register(&ipheth_driver);
	if (retval) {
		err("usb_register failed: %d", retval);
		return retval;
	}
	return 0;
}

static void __exit ipheth_exit(void)
{
	usb_deregister(&ipheth_driver);
}

module_init(ipheth_init);
module_exit(ipheth_exit);

MODULE_AUTHOR("Diego Giagio <diego@giagio.com>");
MODULE_DESCRIPTION("Apple iPhone USB Ethernet driver");
MODULE_LICENSE("Dual BSD/GPL");
Commit	Line	Data
a19259c3 DG	1	/*
	2	* ipheth.c - Apple iPhone USB Ethernet driver
	3	*
	4	* Copyright (c) 2009 Diego Giagio <diego@giagio.com>
	5	* All rights reserved.
	6	*
	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.
	18	*
	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.
	23	*
	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.
	26	*
	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.
	39	*
	40	*
	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
	43	*
	44	*/
	45
	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>
	56
	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
f95d76ab	61	#define USB_PRODUCT_IPHONE_4 0x1297
a19259c3 DG	62
	63	#define IPHETH_USBINTF_CLASS 255
	64	#define IPHETH_USBINTF_SUBCLASS 253
	65	#define IPHETH_USBINTF_PROTO 1
	66
	67	#define IPHETH_BUF_SIZE 1516
	68	#define IPHETH_TX_TIMEOUT (5 * HZ)
	69
	70	#define IPHETH_INTFNUM 2
	71	#define IPHETH_ALT_INTFNUM 1
	72
	73	#define IPHETH_CTRL_ENDP 0x00
	74	#define IPHETH_CTRL_BUF_SIZE 0x40
	75	#define IPHETH_CTRL_TIMEOUT (5 * HZ)
	76
	77	#define IPHETH_CMD_GET_MACADDR 0x00
	78	#define IPHETH_CMD_CARRIER_CHECK 0x45
	79
	80	#define IPHETH_CARRIER_CHECK_TIMEOUT round_jiffies_relative(1 * HZ)
	81	#define IPHETH_CARRIER_ON 0x04
	82
	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) },
f95d76ab JA	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) },
a19259c3 DG	100	{ }
	101	};
	102	MODULE_DEVICE_TABLE(usb, ipheth_table);
	103
	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;
	109	struct urb *tx_urb;
	110	struct urb *rx_urb;
	111	unsigned char *tx_buf;
	112	unsigned char *rx_buf;
	113	unsigned char *ctrl_buf;
	114	u8 bulk_in;
	115	u8 bulk_out;
	116	struct delayed_work carrier_work;
	117	};
	118
	119	static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags);
	120
	121	static int ipheth_alloc_urbs(struct ipheth_device *iphone)
	122	{
	123	struct urb *tx_urb = NULL;
	124	struct urb *rx_urb = NULL;
	125	u8 *tx_buf = NULL;
	126	u8 *rx_buf = NULL;
	127
	128	tx_urb = usb_alloc_urb(0, GFP_KERNEL);
	129	if (tx_urb == NULL)
d87ff58f	130	goto error_nomem;
a19259c3 DG	131
	132	rx_urb = usb_alloc_urb(0, GFP_KERNEL);
	133	if (rx_urb == NULL)
d87ff58f	134	goto free_tx_urb;
a19259c3	135
997ea58e DM	136	tx_buf = usb_alloc_coherent(iphone->udev, IPHETH_BUF_SIZE,
997ea58e DM	137	GFP_KERNEL, &tx_urb->transfer_dma);
a19259c3	138	if (tx_buf == NULL)
d87ff58f	139	goto free_rx_urb;
a19259c3	140
997ea58e DM	141	rx_buf = usb_alloc_coherent(iphone->udev, IPHETH_BUF_SIZE,
997ea58e DM	142	GFP_KERNEL, &rx_urb->transfer_dma);
a19259c3	143	if (rx_buf == NULL)
d87ff58f	144	goto free_tx_buf;
a19259c3 DG	145
	146
	147	iphone->tx_urb = tx_urb;
	148	iphone->rx_urb = rx_urb;
	149	iphone->tx_buf = tx_buf;
	150	iphone->rx_buf = rx_buf;
	151	return 0;
	152
d87ff58f	153	free_tx_buf:
997ea58e DM	154	usb_free_coherent(iphone->udev, IPHETH_BUF_SIZE, tx_buf,
997ea58e DM	155	tx_urb->transfer_dma);
d87ff58f	156	free_rx_urb:
a19259c3	157	usb_free_urb(rx_urb);
d87ff58f	158	free_tx_urb:
a19259c3	159	usb_free_urb(tx_urb);
d87ff58f	160	error_nomem:
a19259c3 DG	161	return -ENOMEM;
	162	}
	163
	164	static void ipheth_free_urbs(struct ipheth_device *iphone)
	165	{
997ea58e DM	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);
a19259c3 DG	170	usb_free_urb(iphone->rx_urb);
	171	usb_free_urb(iphone->tx_urb);
	172	}
	173
	174	static void ipheth_kill_urbs(struct ipheth_device *dev)
	175	{
	176	usb_kill_urb(dev->tx_urb);
	177	usb_kill_urb(dev->rx_urb);
	178	}
	179
	180	static void ipheth_rcvbulk_callback(struct urb *urb)
	181	{
	182	struct ipheth_device *dev;
	183	struct sk_buff *skb;
	184	int status;
	185	char *buf;
	186	int len;
	187
	188	dev = urb->context;
	189	if (dev == NULL)
	190	return;
	191
	192	status = urb->status;
	193	switch (status) {
	194	case -ENOENT:
	195	case -ECONNRESET:
	196	case -ESHUTDOWN:
	197	return;
	198	case 0:
	199	break;
	200	default:
c31fd6c2	201	err("%s: urb status: %d", __func__, status);
a19259c3 DG	202	return;
	203	}
	204
	205	len = urb->actual_length;
	206	buf = urb->transfer_buffer;
	207
	208	skb = dev_alloc_skb(NET_IP_ALIGN + len);
	209	if (!skb) {
	210	err("%s: dev_alloc_skb: -ENOMEM", __func__);
	211	dev->net->stats.rx_dropped++;
	212	return;
	213	}
	214
	215	skb_reserve(skb, NET_IP_ALIGN);
	216	memcpy(skb_put(skb, len), buf + NET_IP_ALIGN, len - NET_IP_ALIGN);
	217	skb->dev = dev->net;
	218	skb->protocol = eth_type_trans(skb, dev->net);
	219
	220	dev->net->stats.rx_packets++;
	221	dev->net->stats.rx_bytes += len;
	222
	223	netif_rx(skb);
	224	ipheth_rx_submit(dev, GFP_ATOMIC);
	225	}
	226
	227	static void ipheth_sndbulk_callback(struct urb *urb)
	228	{
	229	struct ipheth_device *dev;
c31fd6c2	230	int status = urb->status;
a19259c3 DG	231
	232	dev = urb->context;
	233	if (dev == NULL)
	234	return;
	235
c31fd6c2 ON	236	if (status != 0 &&
	237	status != -ENOENT &&
	238	status != -ECONNRESET &&
	239	status != -ESHUTDOWN)
	240	err("%s: urb status: %d", __func__, status);
a19259c3 DG	241
	242	dev_kfree_skb_irq(dev->tx_skb);
	243	netif_wake_queue(dev->net);
	244	}
	245
	246	static int ipheth_carrier_set(struct ipheth_device *dev)
	247	{
	248	struct usb_device *udev = dev->udev;
	249	int retval;
	250
	251	retval = usb_control_msg(udev,
	252	usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
	253	IPHETH_CMD_CARRIER_CHECK, /* request */
	254	0xc0, /* request type */
	255	0x00, /* value */
	256	0x02, /* index */
	257	dev->ctrl_buf, IPHETH_CTRL_BUF_SIZE,
	258	IPHETH_CTRL_TIMEOUT);
	259	if (retval < 0) {
	260	err("%s: usb_control_msg: %d", __func__, retval);
	261	return retval;
	262	}
	263
	264	if (dev->ctrl_buf[0] == IPHETH_CARRIER_ON)
	265	netif_carrier_on(dev->net);
	266	else
	267	netif_carrier_off(dev->net);
	268
	269	return 0;
	270	}
	271
	272	static void ipheth_carrier_check_work(struct work_struct *work)
	273	{
	274	struct ipheth_device *dev = container_of(work, struct ipheth_device,
	275	carrier_work.work);
	276
	277	ipheth_carrier_set(dev);
	278	schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
	279	}
	280
	281	static int ipheth_get_macaddr(struct ipheth_device *dev)
	282	{
	283	struct usb_device *udev = dev->udev;
	284	struct net_device *net = dev->net;
	285	int retval;
	286
	287	retval = usb_control_msg(udev,
	288	usb_rcvctrlpipe(udev, IPHETH_CTRL_ENDP),
	289	IPHETH_CMD_GET_MACADDR, /* request */
	290	0xc0, /* request type */
	291	0x00, /* value */
	292	0x02, /* index */
	293	dev->ctrl_buf,
	294	IPHETH_CTRL_BUF_SIZE,
	295	IPHETH_CTRL_TIMEOUT);
	296	if (retval < 0) {
	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",
	300	__func__, retval);
	301	retval = -EINVAL;
	302	} else {
	303	memcpy(net->dev_addr, dev->ctrl_buf, ETH_ALEN);
	304	retval = 0;
305	}
306
307	return retval;
308	}
309
310	static int ipheth_rx_submit(struct ipheth_device *dev, gfp_t mem_flags)
311	{
312	struct usb_device *udev = dev->udev;
313	int retval;
314
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,
319	dev);
320	dev->rx_urb->transfer_flags \|= URB_NO_TRANSFER_DMA_MAP;
321
322	retval = usb_submit_urb(dev->rx_urb, mem_flags);
323	if (retval)
324	err("%s: usb_submit_urb: %d", __func__, retval);
325	return retval;
326	}
327
328	static int ipheth_open(struct net_device *net)
329	{
330	struct ipheth_device *dev = netdev_priv(net);
331	struct usb_device *udev = dev->udev;
332	int retval = 0;
333
334	usb_set_interface(udev, IPHETH_INTFNUM, IPHETH_ALT_INTFNUM);
335
336	retval = ipheth_carrier_set(dev);
337	if (retval)
338	return retval;
339
340	retval = ipheth_rx_submit(dev, GFP_KERNEL);
341	if (retval)
342	return retval;
343
344	schedule_delayed_work(&dev->carrier_work, IPHETH_CARRIER_CHECK_TIMEOUT);
345	netif_start_queue(net);
346	return retval;
347	}
348
349	static int ipheth_close(struct net_device *net)
350	{
351	struct ipheth_device *dev = netdev_priv(net);
352
353	cancel_delayed_work_sync(&dev->carrier_work);
354	netif_stop_queue(net);
355	return 0;
356	}
357
358	static int ipheth_tx(struct sk_buff skb, struct net_device net)
359	{
360	struct ipheth_device *dev = netdev_priv(net);
361	struct usb_device *udev = dev->udev;
362	int retval;
363
364	/* Paranoid */
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);
369	return NETDEV_TX_OK;
370	}
371
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);
375
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,
380	dev);
381	dev->tx_urb->transfer_flags \|= URB_NO_TRANSFER_DMA_MAP;
382
383	retval = usb_submit_urb(dev->tx_urb, GFP_ATOMIC);
384	if (retval) {
385	err("%s: usb_submit_urb: %d", __func__, retval);
386	dev->net->stats.tx_errors++;
387	dev_kfree_skb_irq(skb);
388	} else {
389	dev->tx_skb = skb;
390
391	dev->net->stats.tx_packets++;
392	dev->net->stats.tx_bytes += skb->len;
393	netif_stop_queue(net);
394	}
395
396	return NETDEV_TX_OK;
397	}
398
399	static void ipheth_tx_timeout(struct net_device *net)
400	{
401	struct ipheth_device *dev = netdev_priv(net);
402
403	err("%s: TX timeout", __func__);
404	dev->net->stats.tx_errors++;
405	usb_unlink_urb(dev->tx_urb);
406	}
407
408	static struct net_device_stats ipheth_stats(struct net_device net)
409	{
410	struct ipheth_device *dev = netdev_priv(net);
411	return &dev->net->stats;
412	}
413
414	static u32 ipheth_ethtool_op_get_link(struct net_device *net)
415	{
416	struct ipheth_device *dev = netdev_priv(net);
417	return netif_carrier_ok(dev->net);
418	}
419
420	static struct ethtool_ops ops = {
421	.get_link = ipheth_ethtool_op_get_link
422	};
423
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,
430	};
431
a19259c3 DG	432	static int ipheth_probe(struct usb_interface *intf,
	433	const struct usb_device_id *id)
	434	{
	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;
	440	int i;
	441	int retval;
	442
	443	netdev = alloc_etherdev(sizeof(struct ipheth_device));
	444	if (!netdev)
	445	return -ENOMEM;
	446
	447	netdev->netdev_ops = &ipheth_netdev_ops;
	448	netdev->watchdog_timeo = IPHETH_TX_TIMEOUT;
c9cedbba	449	strcpy(netdev->name, "eth%d");
a19259c3 DG	450
	451	dev = netdev_priv(netdev);
	452	dev->udev = udev;
	453	dev->net = netdev;
	454	dev->intf = intf;
	455
	456	/* Set up endpoints */
	457	hintf = usb_altnum_to_altsetting(intf, IPHETH_ALT_INTFNUM);
	458	if (hintf == NULL) {
	459	retval = -ENODEV;
	460	err("Unable to find alternate settings interface");
	461	goto err_endpoints;
	462	}
	463
	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;
	470	}
	471	if (!(dev->bulk_in && dev->bulk_out)) {
	472	retval = -ENODEV;
	473	err("Unable to find endpoints");
	474	goto err_endpoints;
	475	}
	476
	477	dev->ctrl_buf = kmalloc(IPHETH_CTRL_BUF_SIZE, GFP_KERNEL);
	478	if (dev->ctrl_buf == NULL) {
	479	retval = -ENOMEM;
	480	goto err_alloc_ctrl_buf;
	481	}
	482
	483	retval = ipheth_get_macaddr(dev);
	484	if (retval)
	485	goto err_get_macaddr;
	486
	487	INIT_DELAYED_WORK(&dev->carrier_work, ipheth_carrier_check_work);
	488
	489	retval = ipheth_alloc_urbs(dev);
	490	if (retval) {
	491	err("error allocating urbs: %d", retval);
	492	goto err_alloc_urbs;
	493	}
	494
	495	usb_set_intfdata(intf, dev);
	496
	497	SET_NETDEV_DEV(netdev, &intf->dev);
	498	SET_ETHTOOL_OPS(netdev, &ops);
a19259c3 DG	499
	500	retval = register_netdev(netdev);
	501	if (retval) {
	502	err("error registering netdev: %d", retval);
	503	retval = -EIO;
	504	goto err_register_netdev;
	505	}
	506
	507	dev_info(&intf->dev, "Apple iPhone USB Ethernet device attached\n");
	508	return 0;
	509
	510	err_register_netdev:
	511	ipheth_free_urbs(dev);
	512	err_alloc_urbs:
	513	err_get_macaddr:
	514	err_alloc_ctrl_buf:
	515	kfree(dev->ctrl_buf);
	516	err_endpoints:
	517	free_netdev(netdev);
	518	return retval;
	519	}
	520
	521	static void ipheth_disconnect(struct usb_interface *intf)
	522	{
	523	struct ipheth_device *dev;
	524
	525	dev = usb_get_intfdata(intf);
	526	if (dev != NULL) {
	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);
	532	}
	533	usb_set_intfdata(intf, NULL);
	534	dev_info(&intf->dev, "Apple iPhone USB Ethernet now disconnected\n");
	535	}
	536
	537	static struct usb_driver ipheth_driver = {
	538	.name = "ipheth",
	539	.probe = ipheth_probe,
	540	.disconnect = ipheth_disconnect,
	541	.id_table = ipheth_table,
	542	};
	543
	544	static int __init ipheth_init(void)
	545	{
	546	int retval;
	547
	548	retval = usb_register(&ipheth_driver);
	549	if (retval) {
	550	err("usb_register failed: %d", retval);
	551	return retval;
	552	}
	553	return 0;
	554	}
	555
	556	static void __exit ipheth_exit(void)
	557	{
	558	usb_deregister(&ipheth_driver);
	559	}
	560
	561	module_init(ipheth_init);
	562	module_exit(ipheth_exit);
563
564	MODULE_AUTHOR("Diego Giagio <diego@giagio.com>");
565	MODULE_DESCRIPTION("Apple iPhone USB Ethernet driver");
566	MODULE_LICENSE("Dual BSD/GPL");