1 /*
2  * MOSCHIP MCS7830 based (7730/7830/7832) USB 2.0 Ethernet Devices
3  *
4  * based on usbnet.c, asix.c and the vendor provided mcs7830 driver
5  *
6  * Copyright (C) 2010 Andreas Mohr <andi@lisas.de>
7  * Copyright (C) 2006 Arnd Bergmann <arnd@arndb.de>
8  * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
9  * Copyright (C) 2005 Phil Chang <pchang23@sbcglobal.net>
10  * Copyright (c) 2002-2003 TiVo Inc.
11  *
12  * Definitions gathered from MOSCHIP, Data Sheet_7830DA.pdf (thanks!).
13  *
14  * 2010-12-19: add 7832 USB PID ("functionality same as MCS7830"),
15  *             per active notification by manufacturer
16  *
17  * TODO:
18  * - support HIF_REG_CONFIG_SLEEPMODE/HIF_REG_CONFIG_TXENABLE (via autopm?)
19  * - implement ethtool_ops get_pauseparam/set_pauseparam
20  *   via HIF_REG_PAUSE_THRESHOLD (>= revision C only!)
21  * - implement get_eeprom/[set_eeprom]
22  * - switch PHY on/off on ifup/ifdown (perhaps in usbnet.c, via MII)
23  * - mcs7830_get_regs() handling is weird: for rev 2 we return 32 regs,
24  *   can access only ~ 24, remaining user buffer is uninitialized garbage
25  * - anything else?
26  *
27  *
28  * This program is free software; you can redistribute it and/or modify
29  * it under the terms of the GNU General Public License as published by
30  * the Free Software Foundation; either version 2 of the License, or
31  * (at your option) any later version.
32  *
33  * This program is distributed in the hope that it will be useful,
34  * but WITHOUT ANY WARRANTY; without even the implied warranty of
35  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
36  * GNU General Public License for more details.
37  *
38  * You should have received a copy of the GNU General Public License
39  * along with this program; if not, write to the Free Software
40  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
41  */
42 
43 #include <linux/crc32.h>
44 #include <linux/etherdevice.h>
45 #include <linux/ethtool.h>
46 #include <linux/init.h>
47 #include <linux/mii.h>
48 #include <linux/module.h>
49 #include <linux/netdevice.h>
50 #include <linux/slab.h>
51 #include <linux/usb.h>
52 #include <linux/usb/usbnet.h>
53 
54 /* requests */
55 #define MCS7830_RD_BMREQ	(USB_DIR_IN  | USB_TYPE_VENDOR | \
56 				 USB_RECIP_DEVICE)
57 #define MCS7830_WR_BMREQ	(USB_DIR_OUT | USB_TYPE_VENDOR | \
58 				 USB_RECIP_DEVICE)
59 #define MCS7830_RD_BREQ		0x0E
60 #define MCS7830_WR_BREQ		0x0D
61 
62 #define MCS7830_CTRL_TIMEOUT	1000
63 #define MCS7830_MAX_MCAST	64
64 
65 #define MCS7830_VENDOR_ID	0x9710
66 #define MCS7832_PRODUCT_ID	0x7832
67 #define MCS7830_PRODUCT_ID	0x7830
68 #define MCS7730_PRODUCT_ID	0x7730
69 
70 #define SITECOM_VENDOR_ID	0x0DF6
71 #define LN_030_PRODUCT_ID	0x0021
72 
73 #define MCS7830_MII_ADVERTISE	(ADVERTISE_PAUSE_CAP | ADVERTISE_100FULL | \
74 				 ADVERTISE_100HALF | ADVERTISE_10FULL | \
75 				 ADVERTISE_10HALF | ADVERTISE_CSMA)
76 
77 /* HIF_REG_XX corresponding index value */
78 enum {
79 	HIF_REG_MULTICAST_HASH			= 0x00,
80 	HIF_REG_PACKET_GAP1			= 0x08,
81 	HIF_REG_PACKET_GAP2			= 0x09,
82 	HIF_REG_PHY_DATA			= 0x0a,
83 	HIF_REG_PHY_CMD1			= 0x0c,
84 	   HIF_REG_PHY_CMD1_READ		= 0x40,
85 	   HIF_REG_PHY_CMD1_WRITE		= 0x20,
86 	   HIF_REG_PHY_CMD1_PHYADDR		= 0x01,
87 	HIF_REG_PHY_CMD2			= 0x0d,
88 	   HIF_REG_PHY_CMD2_PEND_FLAG_BIT	= 0x80,
89 	   HIF_REG_PHY_CMD2_READY_FLAG_BIT	= 0x40,
90 	HIF_REG_CONFIG				= 0x0e,
91 	/* hmm, spec sez: "R/W", "Except bit 3" (likely TXENABLE). */
92 	   HIF_REG_CONFIG_CFG			= 0x80,
93 	   HIF_REG_CONFIG_SPEED100		= 0x40,
94 	   HIF_REG_CONFIG_FULLDUPLEX_ENABLE	= 0x20,
95 	   HIF_REG_CONFIG_RXENABLE		= 0x10,
96 	   HIF_REG_CONFIG_TXENABLE		= 0x08,
97 	   HIF_REG_CONFIG_SLEEPMODE		= 0x04,
98 	   HIF_REG_CONFIG_ALLMULTICAST		= 0x02,
99 	   HIF_REG_CONFIG_PROMISCUOUS		= 0x01,
100 	HIF_REG_ETHERNET_ADDR			= 0x0f,
101 	HIF_REG_FRAME_DROP_COUNTER		= 0x15, /* 0..ff; reset: 0 */
102 	HIF_REG_PAUSE_THRESHOLD			= 0x16,
103 	   HIF_REG_PAUSE_THRESHOLD_DEFAULT	= 0,
104 };
105 
106 /* Trailing status byte in Ethernet Rx frame */
107 enum {
108 	MCS7830_RX_SHORT_FRAME		= 0x01, /* < 64 bytes */
109 	MCS7830_RX_LENGTH_ERROR		= 0x02, /* framelen != Ethernet length field */
110 	MCS7830_RX_ALIGNMENT_ERROR	= 0x04, /* non-even number of nibbles */
111 	MCS7830_RX_CRC_ERROR		= 0x08,
112 	MCS7830_RX_LARGE_FRAME		= 0x10, /* > 1518 bytes */
113 	MCS7830_RX_FRAME_CORRECT	= 0x20, /* frame is correct */
114 	/* [7:6] reserved */
115 };
116 
117 struct mcs7830_data {
118 	u8 multi_filter[8];
119 	u8 config;
120 };
121 
122 static const char driver_name[] = "MOSCHIP usb-ethernet driver";
123 
mcs7830_get_reg(struct usbnet * dev,u16 index,u16 size,void * data)124 static int mcs7830_get_reg(struct usbnet *dev, u16 index, u16 size, void *data)
125 {
126 	struct usb_device *xdev = dev->udev;
127 	int ret;
128 	void *buffer;
129 
130 	buffer = kmalloc(size, GFP_NOIO);
131 	if (buffer == NULL)
132 		return -ENOMEM;
133 
134 	ret = usb_control_msg(xdev, usb_rcvctrlpipe(xdev, 0), MCS7830_RD_BREQ,
135 			      MCS7830_RD_BMREQ, 0x0000, index, buffer,
136 			      size, MCS7830_CTRL_TIMEOUT);
137 	memcpy(data, buffer, size);
138 	kfree(buffer);
139 
140 	return ret;
141 }
142 
mcs7830_set_reg(struct usbnet * dev,u16 index,u16 size,const void * data)143 static int mcs7830_set_reg(struct usbnet *dev, u16 index, u16 size, const void *data)
144 {
145 	struct usb_device *xdev = dev->udev;
146 	int ret;
147 	void *buffer;
148 
149 	buffer = kmemdup(data, size, GFP_NOIO);
150 	if (buffer == NULL)
151 		return -ENOMEM;
152 
153 	ret = usb_control_msg(xdev, usb_sndctrlpipe(xdev, 0), MCS7830_WR_BREQ,
154 			      MCS7830_WR_BMREQ, 0x0000, index, buffer,
155 			      size, MCS7830_CTRL_TIMEOUT);
156 	kfree(buffer);
157 	return ret;
158 }
159 
mcs7830_async_cmd_callback(struct urb * urb)160 static void mcs7830_async_cmd_callback(struct urb *urb)
161 {
162 	struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
163 	int status = urb->status;
164 
165 	if (status < 0)
166 		printk(KERN_DEBUG "%s() failed with %d\n",
167 		       __func__, status);
168 
169 	kfree(req);
170 	usb_free_urb(urb);
171 }
172 
mcs7830_set_reg_async(struct usbnet * dev,u16 index,u16 size,void * data)173 static void mcs7830_set_reg_async(struct usbnet *dev, u16 index, u16 size, void *data)
174 {
175 	struct usb_ctrlrequest *req;
176 	int ret;
177 	struct urb *urb;
178 
179 	urb = usb_alloc_urb(0, GFP_ATOMIC);
180 	if (!urb) {
181 		dev_dbg(&dev->udev->dev,
182 			"Error allocating URB in write_cmd_async!\n");
183 		return;
184 	}
185 
186 	req = kmalloc(sizeof *req, GFP_ATOMIC);
187 	if (!req) {
188 		dev_err(&dev->udev->dev,
189 			"Failed to allocate memory for control request\n");
190 		goto out;
191 	}
192 	req->bRequestType = MCS7830_WR_BMREQ;
193 	req->bRequest = MCS7830_WR_BREQ;
194 	req->wValue = 0;
195 	req->wIndex = cpu_to_le16(index);
196 	req->wLength = cpu_to_le16(size);
197 
198 	usb_fill_control_urb(urb, dev->udev,
199 			     usb_sndctrlpipe(dev->udev, 0),
200 			     (void *)req, data, size,
201 			     mcs7830_async_cmd_callback, req);
202 
203 	ret = usb_submit_urb(urb, GFP_ATOMIC);
204 	if (ret < 0) {
205 		dev_err(&dev->udev->dev,
206 			"Error submitting the control message: ret=%d\n", ret);
207 		goto out;
208 	}
209 	return;
210 out:
211 	kfree(req);
212 	usb_free_urb(urb);
213 }
214 
mcs7830_hif_get_mac_address(struct usbnet * dev,unsigned char * addr)215 static int mcs7830_hif_get_mac_address(struct usbnet *dev, unsigned char *addr)
216 {
217 	int ret = mcs7830_get_reg(dev, HIF_REG_ETHERNET_ADDR, ETH_ALEN, addr);
218 	if (ret < 0)
219 		return ret;
220 	return 0;
221 }
222 
mcs7830_hif_set_mac_address(struct usbnet * dev,unsigned char * addr)223 static int mcs7830_hif_set_mac_address(struct usbnet *dev, unsigned char *addr)
224 {
225 	int ret = mcs7830_set_reg(dev, HIF_REG_ETHERNET_ADDR, ETH_ALEN, addr);
226 
227 	if (ret < 0)
228 		return ret;
229 	return 0;
230 }
231 
mcs7830_set_mac_address(struct net_device * netdev,void * p)232 static int mcs7830_set_mac_address(struct net_device *netdev, void *p)
233 {
234 	int ret;
235 	struct usbnet *dev = netdev_priv(netdev);
236 	struct sockaddr *addr = p;
237 
238 	if (netif_running(netdev))
239 		return -EBUSY;
240 
241 	if (!is_valid_ether_addr(addr->sa_data))
242 		return -EADDRNOTAVAIL;
243 
244 	ret = mcs7830_hif_set_mac_address(dev, addr->sa_data);
245 
246 	if (ret < 0)
247 		return ret;
248 
249 	/* it worked --> adopt it on netdev side */
250 	memcpy(netdev->dev_addr, addr->sa_data, netdev->addr_len);
251 
252 	return 0;
253 }
254 
mcs7830_read_phy(struct usbnet * dev,u8 index)255 static int mcs7830_read_phy(struct usbnet *dev, u8 index)
256 {
257 	int ret;
258 	int i;
259 	__le16 val;
260 
261 	u8 cmd[2] = {
262 		HIF_REG_PHY_CMD1_READ | HIF_REG_PHY_CMD1_PHYADDR,
263 		HIF_REG_PHY_CMD2_PEND_FLAG_BIT | index,
264 	};
265 
266 	mutex_lock(&dev->phy_mutex);
267 	/* write the MII command */
268 	ret = mcs7830_set_reg(dev, HIF_REG_PHY_CMD1, 2, cmd);
269 	if (ret < 0)
270 		goto out;
271 
272 	/* wait for the data to become valid, should be within < 1ms */
273 	for (i = 0; i < 10; i++) {
274 		ret = mcs7830_get_reg(dev, HIF_REG_PHY_CMD1, 2, cmd);
275 		if ((ret < 0) || (cmd[1] & HIF_REG_PHY_CMD2_READY_FLAG_BIT))
276 			break;
277 		ret = -EIO;
278 		msleep(1);
279 	}
280 	if (ret < 0)
281 		goto out;
282 
283 	/* read actual register contents */
284 	ret = mcs7830_get_reg(dev, HIF_REG_PHY_DATA, 2, &val);
285 	if (ret < 0)
286 		goto out;
287 	ret = le16_to_cpu(val);
288 	dev_dbg(&dev->udev->dev, "read PHY reg %02x: %04x (%d tries)\n",
289 		index, val, i);
290 out:
291 	mutex_unlock(&dev->phy_mutex);
292 	return ret;
293 }
294 
mcs7830_write_phy(struct usbnet * dev,u8 index,u16 val)295 static int mcs7830_write_phy(struct usbnet *dev, u8 index, u16 val)
296 {
297 	int ret;
298 	int i;
299 	__le16 le_val;
300 
301 	u8 cmd[2] = {
302 		HIF_REG_PHY_CMD1_WRITE | HIF_REG_PHY_CMD1_PHYADDR,
303 		HIF_REG_PHY_CMD2_PEND_FLAG_BIT | (index & 0x1F),
304 	};
305 
306 	mutex_lock(&dev->phy_mutex);
307 
308 	/* write the new register contents */
309 	le_val = cpu_to_le16(val);
310 	ret = mcs7830_set_reg(dev, HIF_REG_PHY_DATA, 2, &le_val);
311 	if (ret < 0)
312 		goto out;
313 
314 	/* write the MII command */
315 	ret = mcs7830_set_reg(dev, HIF_REG_PHY_CMD1, 2, cmd);
316 	if (ret < 0)
317 		goto out;
318 
319 	/* wait for the command to be accepted by the PHY */
320 	for (i = 0; i < 10; i++) {
321 		ret = mcs7830_get_reg(dev, HIF_REG_PHY_CMD1, 2, cmd);
322 		if ((ret < 0) || (cmd[1] & HIF_REG_PHY_CMD2_READY_FLAG_BIT))
323 			break;
324 		ret = -EIO;
325 		msleep(1);
326 	}
327 	if (ret < 0)
328 		goto out;
329 
330 	ret = 0;
331 	dev_dbg(&dev->udev->dev, "write PHY reg %02x: %04x (%d tries)\n",
332 		index, val, i);
333 out:
334 	mutex_unlock(&dev->phy_mutex);
335 	return ret;
336 }
337 
338 /*
339  * This algorithm comes from the original mcs7830 version 1.4 driver,
340  * not sure if it is needed.
341  */
mcs7830_set_autoneg(struct usbnet * dev,int ptrUserPhyMode)342 static int mcs7830_set_autoneg(struct usbnet *dev, int ptrUserPhyMode)
343 {
344 	int ret;
345 	/* Enable all media types */
346 	ret = mcs7830_write_phy(dev, MII_ADVERTISE, MCS7830_MII_ADVERTISE);
347 
348 	/* First reset BMCR */
349 	if (!ret)
350 		ret = mcs7830_write_phy(dev, MII_BMCR, 0x0000);
351 	/* Enable Auto Neg */
352 	if (!ret)
353 		ret = mcs7830_write_phy(dev, MII_BMCR, BMCR_ANENABLE);
354 	/* Restart Auto Neg (Keep the Enable Auto Neg Bit Set) */
355 	if (!ret)
356 		ret = mcs7830_write_phy(dev, MII_BMCR,
357 				BMCR_ANENABLE | BMCR_ANRESTART	);
358 	return ret;
359 }
360 
361 
362 /*
363  * if we can read register 22, the chip revision is C or higher
364  */
mcs7830_get_rev(struct usbnet * dev)365 static int mcs7830_get_rev(struct usbnet *dev)
366 {
367 	u8 dummy[2];
368 	int ret;
369 	ret = mcs7830_get_reg(dev, HIF_REG_FRAME_DROP_COUNTER, 2, dummy);
370 	if (ret > 0)
371 		return 2; /* Rev C or later */
372 	return 1; /* earlier revision */
373 }
374 
375 /*
376  * On rev. C we need to set the pause threshold
377  */
mcs7830_rev_C_fixup(struct usbnet * dev)378 static void mcs7830_rev_C_fixup(struct usbnet *dev)
379 {
380 	u8 pause_threshold = HIF_REG_PAUSE_THRESHOLD_DEFAULT;
381 	int retry;
382 
383 	for (retry = 0; retry < 2; retry++) {
384 		if (mcs7830_get_rev(dev) == 2) {
385 			dev_info(&dev->udev->dev, "applying rev.C fixup\n");
386 			mcs7830_set_reg(dev, HIF_REG_PAUSE_THRESHOLD,
387 					1, &pause_threshold);
388 		}
389 		msleep(1);
390 	}
391 }
392 
mcs7830_mdio_read(struct net_device * netdev,int phy_id,int location)393 static int mcs7830_mdio_read(struct net_device *netdev, int phy_id,
394 			     int location)
395 {
396 	struct usbnet *dev = netdev_priv(netdev);
397 	return mcs7830_read_phy(dev, location);
398 }
399 
mcs7830_mdio_write(struct net_device * netdev,int phy_id,int location,int val)400 static void mcs7830_mdio_write(struct net_device *netdev, int phy_id,
401 				int location, int val)
402 {
403 	struct usbnet *dev = netdev_priv(netdev);
404 	mcs7830_write_phy(dev, location, val);
405 }
406 
mcs7830_ioctl(struct net_device * net,struct ifreq * rq,int cmd)407 static int mcs7830_ioctl(struct net_device *net, struct ifreq *rq, int cmd)
408 {
409 	struct usbnet *dev = netdev_priv(net);
410 	return generic_mii_ioctl(&dev->mii, if_mii(rq), cmd, NULL);
411 }
412 
mcs7830_get_data(struct usbnet * dev)413 static inline struct mcs7830_data *mcs7830_get_data(struct usbnet *dev)
414 {
415 	return (struct mcs7830_data *)&dev->data;
416 }
417 
mcs7830_hif_update_multicast_hash(struct usbnet * dev)418 static void mcs7830_hif_update_multicast_hash(struct usbnet *dev)
419 {
420 	struct mcs7830_data *data = mcs7830_get_data(dev);
421 	mcs7830_set_reg_async(dev, HIF_REG_MULTICAST_HASH,
422 				sizeof data->multi_filter,
423 				data->multi_filter);
424 }
425 
mcs7830_hif_update_config(struct usbnet * dev)426 static void mcs7830_hif_update_config(struct usbnet *dev)
427 {
428 	/* implementation specific to data->config
429            (argument needs to be heap-based anyway - USB DMA!) */
430 	struct mcs7830_data *data = mcs7830_get_data(dev);
431 	mcs7830_set_reg_async(dev, HIF_REG_CONFIG, 1, &data->config);
432 }
433 
mcs7830_data_set_multicast(struct net_device * net)434 static void mcs7830_data_set_multicast(struct net_device *net)
435 {
436 	struct usbnet *dev = netdev_priv(net);
437 	struct mcs7830_data *data = mcs7830_get_data(dev);
438 
439 	memset(data->multi_filter, 0, sizeof data->multi_filter);
440 
441 	data->config = HIF_REG_CONFIG_TXENABLE;
442 
443 	/* this should not be needed, but it doesn't work otherwise */
444 	data->config |= HIF_REG_CONFIG_ALLMULTICAST;
445 
446 	if (net->flags & IFF_PROMISC) {
447 		data->config |= HIF_REG_CONFIG_PROMISCUOUS;
448 	} else if (net->flags & IFF_ALLMULTI ||
449 		   netdev_mc_count(net) > MCS7830_MAX_MCAST) {
450 		data->config |= HIF_REG_CONFIG_ALLMULTICAST;
451 	} else if (netdev_mc_empty(net)) {
452 		/* just broadcast and directed */
453 	} else {
454 		/* We use the 20 byte dev->data
455 		 * for our 8 byte filter buffer
456 		 * to avoid allocating memory that
457 		 * is tricky to free later */
458 		struct netdev_hw_addr *ha;
459 		u32 crc_bits;
460 
461 		/* Build the multicast hash filter. */
462 		netdev_for_each_mc_addr(ha, net) {
463 			crc_bits = ether_crc(ETH_ALEN, ha->addr) >> 26;
464 			data->multi_filter[crc_bits >> 3] |= 1 << (crc_bits & 7);
465 		}
466 	}
467 }
468 
mcs7830_apply_base_config(struct usbnet * dev)469 static int mcs7830_apply_base_config(struct usbnet *dev)
470 {
471 	int ret;
472 
473 	/* re-configure known MAC (suspend case etc.) */
474 	ret = mcs7830_hif_set_mac_address(dev, dev->net->dev_addr);
475 	if (ret) {
476 		dev_info(&dev->udev->dev, "Cannot set MAC address\n");
477 		goto out;
478 	}
479 
480 	/* Set up PHY */
481 	ret = mcs7830_set_autoneg(dev, 0);
482 	if (ret) {
483 		dev_info(&dev->udev->dev, "Cannot set autoneg\n");
484 		goto out;
485 	}
486 
487 	mcs7830_hif_update_multicast_hash(dev);
488 	mcs7830_hif_update_config(dev);
489 
490 	mcs7830_rev_C_fixup(dev);
491 	ret = 0;
492 out:
493 	return ret;
494 }
495 
496 /* credits go to asix_set_multicast */
mcs7830_set_multicast(struct net_device * net)497 static void mcs7830_set_multicast(struct net_device *net)
498 {
499 	struct usbnet *dev = netdev_priv(net);
500 
501 	mcs7830_data_set_multicast(net);
502 
503 	mcs7830_hif_update_multicast_hash(dev);
504 	mcs7830_hif_update_config(dev);
505 }
506 
mcs7830_get_regs_len(struct net_device * net)507 static int mcs7830_get_regs_len(struct net_device *net)
508 {
509 	struct usbnet *dev = netdev_priv(net);
510 
511 	switch (mcs7830_get_rev(dev)) {
512 	case 1:
513 		return 21;
514 	case 2:
515 		return 32;
516 	}
517 	return 0;
518 }
519 
mcs7830_get_drvinfo(struct net_device * net,struct ethtool_drvinfo * drvinfo)520 static void mcs7830_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *drvinfo)
521 {
522 	usbnet_get_drvinfo(net, drvinfo);
523 	drvinfo->regdump_len = mcs7830_get_regs_len(net);
524 }
525 
mcs7830_get_regs(struct net_device * net,struct ethtool_regs * regs,void * data)526 static void mcs7830_get_regs(struct net_device *net, struct ethtool_regs *regs, void *data)
527 {
528 	struct usbnet *dev = netdev_priv(net);
529 
530 	regs->version = mcs7830_get_rev(dev);
531 	mcs7830_get_reg(dev, 0, regs->len, data);
532 }
533 
534 static const struct ethtool_ops mcs7830_ethtool_ops = {
535 	.get_drvinfo		= mcs7830_get_drvinfo,
536 	.get_regs_len		= mcs7830_get_regs_len,
537 	.get_regs		= mcs7830_get_regs,
538 
539 	/* common usbnet calls */
540 	.get_link		= usbnet_get_link,
541 	.get_msglevel		= usbnet_get_msglevel,
542 	.set_msglevel		= usbnet_set_msglevel,
543 	.get_settings		= usbnet_get_settings,
544 	.set_settings		= usbnet_set_settings,
545 	.nway_reset		= usbnet_nway_reset,
546 };
547 
548 static const struct net_device_ops mcs7830_netdev_ops = {
549 	.ndo_open		= usbnet_open,
550 	.ndo_stop		= usbnet_stop,
551 	.ndo_start_xmit		= usbnet_start_xmit,
552 	.ndo_tx_timeout		= usbnet_tx_timeout,
553 	.ndo_change_mtu		= usbnet_change_mtu,
554 	.ndo_validate_addr	= eth_validate_addr,
555 	.ndo_do_ioctl 		= mcs7830_ioctl,
556 	.ndo_set_rx_mode	= mcs7830_set_multicast,
557 	.ndo_set_mac_address	= mcs7830_set_mac_address,
558 };
559 
mcs7830_bind(struct usbnet * dev,struct usb_interface * udev)560 static int mcs7830_bind(struct usbnet *dev, struct usb_interface *udev)
561 {
562 	struct net_device *net = dev->net;
563 	int ret;
564 	int retry;
565 
566 	/* Initial startup: Gather MAC address setting from EEPROM */
567 	ret = -EINVAL;
568 	for (retry = 0; retry < 5 && ret; retry++)
569 		ret = mcs7830_hif_get_mac_address(dev, net->dev_addr);
570 	if (ret) {
571 		dev_warn(&dev->udev->dev, "Cannot read MAC address\n");
572 		goto out;
573 	}
574 
575 	mcs7830_data_set_multicast(net);
576 
577 	ret = mcs7830_apply_base_config(dev);
578 	if (ret)
579 		goto out;
580 
581 	net->ethtool_ops = &mcs7830_ethtool_ops;
582 	net->netdev_ops = &mcs7830_netdev_ops;
583 
584 	/* reserve space for the status byte on rx */
585 	dev->rx_urb_size = ETH_FRAME_LEN + 1;
586 
587 	dev->mii.mdio_read = mcs7830_mdio_read;
588 	dev->mii.mdio_write = mcs7830_mdio_write;
589 	dev->mii.dev = net;
590 	dev->mii.phy_id_mask = 0x3f;
591 	dev->mii.reg_num_mask = 0x1f;
592 	dev->mii.phy_id = *((u8 *) net->dev_addr + 1);
593 
594 	ret = usbnet_get_endpoints(dev, udev);
595 out:
596 	return ret;
597 }
598 
599 /* The chip always appends a status byte that we need to strip */
mcs7830_rx_fixup(struct usbnet * dev,struct sk_buff * skb)600 static int mcs7830_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
601 {
602 	u8 status;
603 
604 	/* This check is no longer done by usbnet */
605 	if (skb->len < dev->net->hard_header_len) {
606 		dev_err(&dev->udev->dev, "unexpected tiny rx frame\n");
607 		return 0;
608 	}
609 
610 	skb_trim(skb, skb->len - 1);
611 	status = skb->data[skb->len];
612 
613 	if (status != MCS7830_RX_FRAME_CORRECT) {
614 		dev_dbg(&dev->udev->dev, "rx fixup status %x\n", status);
615 
616 		/* hmm, perhaps usbnet.c already sees a globally visible
617 		   frame error and increments rx_errors on its own already? */
618 		dev->net->stats.rx_errors++;
619 
620 		if (status &	(MCS7830_RX_SHORT_FRAME
621 				|MCS7830_RX_LENGTH_ERROR
622 				|MCS7830_RX_LARGE_FRAME))
623 			dev->net->stats.rx_length_errors++;
624 		if (status & MCS7830_RX_ALIGNMENT_ERROR)
625 			dev->net->stats.rx_frame_errors++;
626 		if (status & MCS7830_RX_CRC_ERROR)
627 			dev->net->stats.rx_crc_errors++;
628 	}
629 
630 	return skb->len > 0;
631 }
632 
633 static const struct driver_info moschip_info = {
634 	.description	= "MOSCHIP 7830/7832/7730 usb-NET adapter",
635 	.bind		= mcs7830_bind,
636 	.rx_fixup	= mcs7830_rx_fixup,
637 	.flags		= FLAG_ETHER,
638 	.in		= 1,
639 	.out		= 2,
640 };
641 
642 static const struct driver_info sitecom_info = {
643 	.description    = "Sitecom LN-30 usb-NET adapter",
644 	.bind		= mcs7830_bind,
645 	.rx_fixup	= mcs7830_rx_fixup,
646 	.flags		= FLAG_ETHER,
647 	.in		= 1,
648 	.out		= 2,
649 };
650 
651 static const struct usb_device_id products[] = {
652 	{
653 		USB_DEVICE(MCS7830_VENDOR_ID, MCS7832_PRODUCT_ID),
654 		.driver_info = (unsigned long) &moschip_info,
655 	},
656 	{
657 		USB_DEVICE(MCS7830_VENDOR_ID, MCS7830_PRODUCT_ID),
658 		.driver_info = (unsigned long) &moschip_info,
659 	},
660 	{
661 		USB_DEVICE(MCS7830_VENDOR_ID, MCS7730_PRODUCT_ID),
662 		.driver_info = (unsigned long) &moschip_info,
663 	},
664 	{
665 		USB_DEVICE(SITECOM_VENDOR_ID, LN_030_PRODUCT_ID),
666 		.driver_info = (unsigned long) &sitecom_info,
667 	},
668 	{},
669 };
670 MODULE_DEVICE_TABLE(usb, products);
671 
mcs7830_reset_resume(struct usb_interface * intf)672 static int mcs7830_reset_resume (struct usb_interface *intf)
673 {
674  	/* YES, this function is successful enough that ethtool -d
675            does show same output pre-/post-suspend */
676 
677 	struct usbnet		*dev = usb_get_intfdata(intf);
678 
679 	mcs7830_apply_base_config(dev);
680 
681 	usbnet_resume(intf);
682 
683 	return 0;
684 }
685 
686 static struct usb_driver mcs7830_driver = {
687 	.name = driver_name,
688 	.id_table = products,
689 	.probe = usbnet_probe,
690 	.disconnect = usbnet_disconnect,
691 	.suspend = usbnet_suspend,
692 	.resume = usbnet_resume,
693 	.reset_resume = mcs7830_reset_resume,
694 };
695 
696 module_usb_driver(mcs7830_driver);
697 
698 MODULE_DESCRIPTION("USB to network adapter MCS7830)");
699 MODULE_LICENSE("GPL");
700