[deliverable/linux.git] / drivers / net / usb / int51x1.c

/*
 * Copyright (c) 2009 Peter Holik
 *
 * Intellon usb PLC (Powerline Communications) usb net driver
 *
 * http://www.tandel.be/downloads/INT51X1_Datasheet.pdf
 *
 * Based on the work of Jan 'RedBully' Seiffert
 */

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or.
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#include <linux/module.h>
#include <linux/ctype.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/ethtool.h>
#include <linux/slab.h>
#include <linux/mii.h>
#include <linux/usb.h>
#include <linux/usb/usbnet.h>

#define INT51X1_VENDOR_ID	0x09e1
#define INT51X1_PRODUCT_ID	0x5121

#define INT51X1_HEADER_SIZE	2	/* 2 byte header */

#define PACKET_TYPE_PROMISCUOUS		(1 << 0)
#define PACKET_TYPE_ALL_MULTICAST	(1 << 1) /* no filter */
#define PACKET_TYPE_DIRECTED		(1 << 2)
#define PACKET_TYPE_BROADCAST		(1 << 3)
#define PACKET_TYPE_MULTICAST		(1 << 4) /* filtered */

#define SET_ETHERNET_PACKET_FILTER	0x43

static int int51x1_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
{
	int len;

	if (!(pskb_may_pull(skb, INT51X1_HEADER_SIZE))) {
		netdev_err(dev->net, "unexpected tiny rx frame\n");
		return 0;
	}

	len = le16_to_cpu(*(__le16 *)&skb->data[skb->len - 2]);

	skb_trim(skb, len);

	return 1;
}

static struct sk_buff *int51x1_tx_fixup(struct usbnet *dev,
		struct sk_buff *skb, gfp_t flags)
{
	int pack_len = skb->len;
	int pack_with_header_len = pack_len + INT51X1_HEADER_SIZE;
	int headroom = skb_headroom(skb);
	int tailroom = skb_tailroom(skb);
	int need_tail = 0;
	__le16 *len;

	/* if packet and our header is smaler than 64 pad to 64 (+ ZLP) */
	if ((pack_with_header_len) < dev->maxpacket)
		need_tail = dev->maxpacket - pack_with_header_len + 1;
	/*
	 * usbnet would send a ZLP if packetlength mod urbsize == 0 for us,
	 * but we need to know ourself, because this would add to the length
	 * we send down to the device...
	 */
	else if (!(pack_with_header_len % dev->maxpacket))
		need_tail = 1;

	if (!skb_cloned(skb) &&
			(headroom + tailroom >= need_tail + INT51X1_HEADER_SIZE)) {
		if (headroom < INT51X1_HEADER_SIZE || tailroom < need_tail) {
			skb->data = memmove(skb->head + INT51X1_HEADER_SIZE,
					skb->data, skb->len);
			skb_set_tail_pointer(skb, skb->len);
		}
	} else {
		struct sk_buff *skb2;

		skb2 = skb_copy_expand(skb,
				INT51X1_HEADER_SIZE,
				need_tail,
				flags);
		dev_kfree_skb_any(skb);
		if (!skb2)
			return NULL;
		skb = skb2;
	}

	pack_len += need_tail;
	pack_len &= 0x07ff;

	len = (__le16 *) __skb_push(skb, INT51X1_HEADER_SIZE);
	*len = cpu_to_le16(pack_len);

	if(need_tail)
		memset(__skb_put(skb, need_tail), 0, need_tail);

	return skb;
}

static void int51x1_set_multicast(struct net_device *netdev)
{
	struct usbnet *dev = netdev_priv(netdev);
	u16 filter = PACKET_TYPE_DIRECTED | PACKET_TYPE_BROADCAST;

	if (netdev->flags & IFF_PROMISC) {
		/* do not expect to see traffic of other PLCs */
		filter |= PACKET_TYPE_PROMISCUOUS;
		netdev_info(dev->net, "promiscuous mode enabled\n");
	} else if (!netdev_mc_empty(netdev) ||
		  (netdev->flags & IFF_ALLMULTI)) {
		filter |= PACKET_TYPE_ALL_MULTICAST;
		netdev_dbg(dev->net, "receive all multicast enabled\n");
	} else {
		/* ~PROMISCUOUS, ~MULTICAST */
		netdev_dbg(dev->net, "receive own packets only\n");
	}

	usbnet_write_cmd_async(dev, SET_ETHERNET_PACKET_FILTER,
			       USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
			       filter, 0, NULL, 0);
}

static const struct net_device_ops int51x1_netdev_ops = {
	.ndo_open		= usbnet_open,
	.ndo_stop		= usbnet_stop,
	.ndo_start_xmit		= usbnet_start_xmit,
	.ndo_tx_timeout		= usbnet_tx_timeout,
	.ndo_change_mtu		= usbnet_change_mtu,
	.ndo_set_mac_address	= eth_mac_addr,
	.ndo_validate_addr	= eth_validate_addr,
	.ndo_set_rx_mode	= int51x1_set_multicast,
};

static int int51x1_bind(struct usbnet *dev, struct usb_interface *intf)
{
	int status = usbnet_get_ethernet_addr(dev, 3);

	if (status)
		return status;

	dev->net->hard_header_len += INT51X1_HEADER_SIZE;
	dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
	dev->net->netdev_ops = &int51x1_netdev_ops;

	return usbnet_get_endpoints(dev, intf);
}

static const struct driver_info int51x1_info = {
	.description = "Intellon usb powerline adapter",
	.bind        = int51x1_bind,
	.rx_fixup    = int51x1_rx_fixup,
	.tx_fixup    = int51x1_tx_fixup,
	.in          = 1,
	.out         = 2,
	.flags       = FLAG_ETHER,
};

static const struct usb_device_id products[] = {
	{
	USB_DEVICE(INT51X1_VENDOR_ID, INT51X1_PRODUCT_ID),
		.driver_info = (unsigned long) &int51x1_info,
	},
	{},
};
MODULE_DEVICE_TABLE(usb, products);

static struct usb_driver int51x1_driver = {
	.name       = "int51x1",
	.id_table   = products,
	.probe      = usbnet_probe,
	.disconnect = usbnet_disconnect,
	.suspend    = usbnet_suspend,
	.resume     = usbnet_resume,
	.disable_hub_initiated_lpm = 1,
};

module_usb_driver(int51x1_driver);

MODULE_AUTHOR("Peter Holik");
MODULE_DESCRIPTION("Intellon usb powerline adapter");
MODULE_LICENSE("GPL");
Commit	Line	Data
4510d7cb PH	1	/*
	2	* Copyright (c) 2009 Peter Holik
	3	*
	4	* Intellon usb PLC (Powerline Communications) usb net driver
	5	*
	6	* http://www.tandel.be/downloads/INT51X1_Datasheet.pdf
	7	*
	8	* Based on the work of Jan 'RedBully' Seiffert
	9	*/
	10
	11	/*
	12	* This program is free software; you can redistribute it and/or modify
	13	* it under the terms of the GNU General Public License as published by
	14	* the Free Software Foundation; either version 2 of the License, or.
	15	* (at your option) any later version.
	16	*
	17	* This program is distributed in the hope that it will be useful,
	18	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	* GNU General Public License for more details.
	21	*
	22	* You should have received a copy of the GNU General Public License
	23	* along with this program; if not, write to the Free Software
	24	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	25	*/
	26
	27	#include <linux/module.h>
	28	#include <linux/ctype.h>
	29	#include <linux/netdevice.h>
	30	#include <linux/etherdevice.h>
	31	#include <linux/ethtool.h>
5a0e3ad6	32	#include <linux/slab.h>
4510d7cb PH	33	#include <linux/mii.h>
	34	#include <linux/usb.h>
	35	#include <linux/usb/usbnet.h>
	36
	37	#define INT51X1_VENDOR_ID 0x09e1
	38	#define INT51X1_PRODUCT_ID 0x5121
	39
	40	#define INT51X1_HEADER_SIZE 2 /* 2 byte header */
	41
	42	#define PACKET_TYPE_PROMISCUOUS (1 << 0)
	43	#define PACKET_TYPE_ALL_MULTICAST (1 << 1) /* no filter */
	44	#define PACKET_TYPE_DIRECTED (1 << 2)
	45	#define PACKET_TYPE_BROADCAST (1 << 3)
	46	#define PACKET_TYPE_MULTICAST (1 << 4) /* filtered */
	47
	48	#define SET_ETHERNET_PACKET_FILTER 0x43
	49
	50	static int int51x1_rx_fixup(struct usbnet dev, struct sk_buff skb)
	51	{
	52	int len;
	53
	54	if (!(pskb_may_pull(skb, INT51X1_HEADER_SIZE))) {
60b86755	55	netdev_err(dev->net, "unexpected tiny rx frame\n");
4510d7cb PH	56	return 0;
	57	}
	58
	59	len = le16_to_cpu((__le16 )&skb->data[skb->len - 2]);
	60
	61	skb_trim(skb, len);
	62
	63	return 1;
	64	}
	65
	66	static struct sk_buff int51x1_tx_fixup(struct usbnet dev,
	67	struct sk_buff *skb, gfp_t flags)
	68	{
	69	int pack_len = skb->len;
	70	int pack_with_header_len = pack_len + INT51X1_HEADER_SIZE;
	71	int headroom = skb_headroom(skb);
	72	int tailroom = skb_tailroom(skb);
	73	int need_tail = 0;
	74	__le16 *len;
	75
	76	/* if packet and our header is smaler than 64 pad to 64 (+ ZLP) */
	77	if ((pack_with_header_len) < dev->maxpacket)
	78	need_tail = dev->maxpacket - pack_with_header_len + 1;
	79	/*
	80	* usbnet would send a ZLP if packetlength mod urbsize == 0 for us,
	81	* but we need to know ourself, because this would add to the length
	82	* we send down to the device...
	83	*/
	84	else if (!(pack_with_header_len % dev->maxpacket))
	85	need_tail = 1;
	86
	87	if (!skb_cloned(skb) &&
	88	(headroom + tailroom >= need_tail + INT51X1_HEADER_SIZE)) {
	89	if (headroom < INT51X1_HEADER_SIZE \|\| tailroom < need_tail) {
	90	skb->data = memmove(skb->head + INT51X1_HEADER_SIZE,
	91	skb->data, skb->len);
	92	skb_set_tail_pointer(skb, skb->len);
	93	}
	94	} else {
	95	struct sk_buff *skb2;
	96
	97	skb2 = skb_copy_expand(skb,
	98	INT51X1_HEADER_SIZE,
	99	need_tail,
	100	flags);
	101	dev_kfree_skb_any(skb);
	102	if (!skb2)
	103	return NULL;
	104	skb = skb2;
	105	}
	106
	107	pack_len += need_tail;
	108	pack_len &= 0x07ff;
	109
	110	len = (__le16 *) __skb_push(skb, INT51X1_HEADER_SIZE);
	111	*len = cpu_to_le16(pack_len);
	112
	113	if(need_tail)
	114	memset(__skb_put(skb, need_tail), 0, need_tail);
	115
	116	return skb;
	117	}
	118
4510d7cb PH	119	static void int51x1_set_multicast(struct net_device *netdev)
4510d7cb PH	120	{
4510d7cb PH	121	struct usbnet *dev = netdev_priv(netdev);
	122	u16 filter = PACKET_TYPE_DIRECTED \| PACKET_TYPE_BROADCAST;
	123
	124	if (netdev->flags & IFF_PROMISC) {
	125	/* do not expect to see traffic of other PLCs */
	126	filter \|= PACKET_TYPE_PROMISCUOUS;
60b86755	127	netdev_info(dev->net, "promiscuous mode enabled\n");
4cd24eaf	128	} else if (!netdev_mc_empty(netdev) \|\|
4510d7cb PH	129	(netdev->flags & IFF_ALLMULTI)) {
4510d7cb PH	130	filter \|= PACKET_TYPE_ALL_MULTICAST;
60b86755	131	netdev_dbg(dev->net, "receive all multicast enabled\n");
4510d7cb PH	132	} else {
4510d7cb PH	133	/* ~PROMISCUOUS, ~MULTICAST */
60b86755	134	netdev_dbg(dev->net, "receive own packets only\n");
4510d7cb PH	135	}
4510d7cb PH	136
3898cdf9 ML	137	usbnet_write_cmd_async(dev, SET_ETHERNET_PACKET_FILTER,
	138	USB_DIR_OUT \| USB_TYPE_CLASS \| USB_RECIP_INTERFACE,
	139	filter, 0, NULL, 0);
4510d7cb PH	140	}
	141
	142	static const struct net_device_ops int51x1_netdev_ops = {
	143	.ndo_open = usbnet_open,
	144	.ndo_stop = usbnet_stop,
	145	.ndo_start_xmit = usbnet_start_xmit,
	146	.ndo_tx_timeout = usbnet_tx_timeout,
	147	.ndo_change_mtu = usbnet_change_mtu,
	148	.ndo_set_mac_address = eth_mac_addr,
	149	.ndo_validate_addr = eth_validate_addr,
afc4b13d	150	.ndo_set_rx_mode = int51x1_set_multicast,
4510d7cb PH	151	};
	152
	153	static int int51x1_bind(struct usbnet dev, struct usb_interface intf)
	154	{
	155	int status = usbnet_get_ethernet_addr(dev, 3);
	156
	157	if (status)
	158	return status;
	159
	160	dev->net->hard_header_len += INT51X1_HEADER_SIZE;
	161	dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
	162	dev->net->netdev_ops = &int51x1_netdev_ops;
	163
	164	return usbnet_get_endpoints(dev, intf);
	165	}
	166
	167	static const struct driver_info int51x1_info = {
	168	.description = "Intellon usb powerline adapter",
	169	.bind = int51x1_bind,
	170	.rx_fixup = int51x1_rx_fixup,
	171	.tx_fixup = int51x1_tx_fixup,
	172	.in = 1,
	173	.out = 2,
	174	.flags = FLAG_ETHER,
	175	};
	176
	177	static const struct usb_device_id products[] = {
	178	{
	179	USB_DEVICE(INT51X1_VENDOR_ID, INT51X1_PRODUCT_ID),
	180	.driver_info = (unsigned long) &int51x1_info,
	181	},
	182	{},
	183	};
	184	MODULE_DEVICE_TABLE(usb, products);
	185
	186	static struct usb_driver int51x1_driver = {
	187	.name = "int51x1",
	188	.id_table = products,
	189	.probe = usbnet_probe,
	190	.disconnect = usbnet_disconnect,
	191	.suspend = usbnet_suspend,
	192	.resume = usbnet_resume,
e1f12eb6	193	.disable_hub_initiated_lpm = 1,
4510d7cb PH	194	};
4510d7cb PH	195
d632eb1b	196	module_usb_driver(int51x1_driver);
4510d7cb PH	197
	198	MODULE_AUTHOR("Peter Holik");
	199	MODULE_DESCRIPTION("Intellon usb powerline adapter");
	200	MODULE_LICENSE("GPL");