xref: /openbmc/linux/drivers/net/usb/int51x1.c (revision f3539c12)
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, see <http://www.gnu.org/licenses/>.
24  */
25 
26 #include <linux/module.h>
27 #include <linux/ctype.h>
28 #include <linux/netdevice.h>
29 #include <linux/etherdevice.h>
30 #include <linux/ethtool.h>
31 #include <linux/slab.h>
32 #include <linux/mii.h>
33 #include <linux/usb.h>
34 #include <linux/usb/usbnet.h>
35 
36 #define INT51X1_VENDOR_ID	0x09e1
37 #define INT51X1_PRODUCT_ID	0x5121
38 
39 #define INT51X1_HEADER_SIZE	2	/* 2 byte header */
40 
41 #define PACKET_TYPE_PROMISCUOUS		(1 << 0)
42 #define PACKET_TYPE_ALL_MULTICAST	(1 << 1) /* no filter */
43 #define PACKET_TYPE_DIRECTED		(1 << 2)
44 #define PACKET_TYPE_BROADCAST		(1 << 3)
45 #define PACKET_TYPE_MULTICAST		(1 << 4) /* filtered */
46 
47 #define SET_ETHERNET_PACKET_FILTER	0x43
48 
49 static int int51x1_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
50 {
51 	int len;
52 
53 	if (!(pskb_may_pull(skb, INT51X1_HEADER_SIZE))) {
54 		netdev_err(dev->net, "unexpected tiny rx frame\n");
55 		return 0;
56 	}
57 
58 	len = le16_to_cpu(*(__le16 *)&skb->data[skb->len - 2]);
59 
60 	skb_trim(skb, len);
61 
62 	return 1;
63 }
64 
65 static struct sk_buff *int51x1_tx_fixup(struct usbnet *dev,
66 		struct sk_buff *skb, gfp_t flags)
67 {
68 	int pack_len = skb->len;
69 	int pack_with_header_len = pack_len + INT51X1_HEADER_SIZE;
70 	int headroom = skb_headroom(skb);
71 	int tailroom = skb_tailroom(skb);
72 	int need_tail = 0;
73 	__le16 *len;
74 
75 	/* if packet and our header is smaler than 64 pad to 64 (+ ZLP) */
76 	if ((pack_with_header_len) < dev->maxpacket)
77 		need_tail = dev->maxpacket - pack_with_header_len + 1;
78 	/*
79 	 * usbnet would send a ZLP if packetlength mod urbsize == 0 for us,
80 	 * but we need to know ourself, because this would add to the length
81 	 * we send down to the device...
82 	 */
83 	else if (!(pack_with_header_len % dev->maxpacket))
84 		need_tail = 1;
85 
86 	if (!skb_cloned(skb) &&
87 			(headroom + tailroom >= need_tail + INT51X1_HEADER_SIZE)) {
88 		if (headroom < INT51X1_HEADER_SIZE || tailroom < need_tail) {
89 			skb->data = memmove(skb->head + INT51X1_HEADER_SIZE,
90 					skb->data, skb->len);
91 			skb_set_tail_pointer(skb, skb->len);
92 		}
93 	} else {
94 		struct sk_buff *skb2;
95 
96 		skb2 = skb_copy_expand(skb,
97 				INT51X1_HEADER_SIZE,
98 				need_tail,
99 				flags);
100 		dev_kfree_skb_any(skb);
101 		if (!skb2)
102 			return NULL;
103 		skb = skb2;
104 	}
105 
106 	pack_len += need_tail;
107 	pack_len &= 0x07ff;
108 
109 	len = (__le16 *) __skb_push(skb, INT51X1_HEADER_SIZE);
110 	*len = cpu_to_le16(pack_len);
111 
112 	if(need_tail)
113 		memset(__skb_put(skb, need_tail), 0, need_tail);
114 
115 	return skb;
116 }
117 
118 static void int51x1_set_multicast(struct net_device *netdev)
119 {
120 	struct usbnet *dev = netdev_priv(netdev);
121 	u16 filter = PACKET_TYPE_DIRECTED | PACKET_TYPE_BROADCAST;
122 
123 	if (netdev->flags & IFF_PROMISC) {
124 		/* do not expect to see traffic of other PLCs */
125 		filter |= PACKET_TYPE_PROMISCUOUS;
126 		netdev_info(dev->net, "promiscuous mode enabled\n");
127 	} else if (!netdev_mc_empty(netdev) ||
128 		  (netdev->flags & IFF_ALLMULTI)) {
129 		filter |= PACKET_TYPE_ALL_MULTICAST;
130 		netdev_dbg(dev->net, "receive all multicast enabled\n");
131 	} else {
132 		/* ~PROMISCUOUS, ~MULTICAST */
133 		netdev_dbg(dev->net, "receive own packets only\n");
134 	}
135 
136 	usbnet_write_cmd_async(dev, SET_ETHERNET_PACKET_FILTER,
137 			       USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
138 			       filter, 0, NULL, 0);
139 }
140 
141 static const struct net_device_ops int51x1_netdev_ops = {
142 	.ndo_open		= usbnet_open,
143 	.ndo_stop		= usbnet_stop,
144 	.ndo_start_xmit		= usbnet_start_xmit,
145 	.ndo_tx_timeout		= usbnet_tx_timeout,
146 	.ndo_change_mtu		= usbnet_change_mtu,
147 	.ndo_set_mac_address	= eth_mac_addr,
148 	.ndo_validate_addr	= eth_validate_addr,
149 	.ndo_set_rx_mode	= int51x1_set_multicast,
150 };
151 
152 static int int51x1_bind(struct usbnet *dev, struct usb_interface *intf)
153 {
154 	int status = usbnet_get_ethernet_addr(dev, 3);
155 
156 	if (status)
157 		return status;
158 
159 	dev->net->hard_header_len += INT51X1_HEADER_SIZE;
160 	dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
161 	dev->net->netdev_ops = &int51x1_netdev_ops;
162 
163 	return usbnet_get_endpoints(dev, intf);
164 }
165 
166 static const struct driver_info int51x1_info = {
167 	.description = "Intellon usb powerline adapter",
168 	.bind        = int51x1_bind,
169 	.rx_fixup    = int51x1_rx_fixup,
170 	.tx_fixup    = int51x1_tx_fixup,
171 	.in          = 1,
172 	.out         = 2,
173 	.flags       = FLAG_ETHER,
174 };
175 
176 static const struct usb_device_id products[] = {
177 	{
178 	USB_DEVICE(INT51X1_VENDOR_ID, INT51X1_PRODUCT_ID),
179 		.driver_info = (unsigned long) &int51x1_info,
180 	},
181 	{},
182 };
183 MODULE_DEVICE_TABLE(usb, products);
184 
185 static struct usb_driver int51x1_driver = {
186 	.name       = "int51x1",
187 	.id_table   = products,
188 	.probe      = usbnet_probe,
189 	.disconnect = usbnet_disconnect,
190 	.suspend    = usbnet_suspend,
191 	.resume     = usbnet_resume,
192 	.disable_hub_initiated_lpm = 1,
193 };
194 
195 module_usb_driver(int51x1_driver);
196 
197 MODULE_AUTHOR("Peter Holik");
198 MODULE_DESCRIPTION("Intellon usb powerline adapter");
199 MODULE_LICENSE("GPL");
200