xref: /linux/drivers/net/usb/smsc95xx.c (revision bf4afc53b77aeaa48b5409da5c8da6bb4eff7f43)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2  /***************************************************************************
3  *
4  * Copyright (C) 2007-2008 SMSC
5  *
6  *****************************************************************************/
7 
8 #include <linux/module.h>
9 #include <linux/kmod.h>
10 #include <linux/netdevice.h>
11 #include <linux/etherdevice.h>
12 #include <linux/ethtool.h>
13 #include <linux/mii.h>
14 #include <linux/usb.h>
15 #include <linux/bitrev.h>
16 #include <linux/crc16.h>
17 #include <linux/crc32.h>
18 #include <linux/usb/usbnet.h>
19 #include <linux/slab.h>
20 #include <linux/of_net.h>
21 #include <linux/irq.h>
22 #include <linux/irqdomain.h>
23 #include <linux/mdio.h>
24 #include <linux/phy.h>
25 #include <net/selftests.h>
26 
27 #include "smsc95xx.h"
28 
29 #define SMSC_CHIPNAME			"smsc95xx"
30 #define HS_USB_PKT_SIZE			(512)
31 #define FS_USB_PKT_SIZE			(64)
32 #define DEFAULT_HS_BURST_CAP_SIZE	(16 * 1024 + 5 * HS_USB_PKT_SIZE)
33 #define DEFAULT_FS_BURST_CAP_SIZE	(6 * 1024 + 33 * FS_USB_PKT_SIZE)
34 #define DEFAULT_BULK_IN_DELAY		(0x00002000)
35 #define MAX_SINGLE_PACKET_SIZE		(2048)
36 #define LAN95XX_EEPROM_MAGIC		(0x9500)
37 #define EEPROM_MAC_OFFSET		(0x01)
38 #define DEFAULT_TX_CSUM_ENABLE		(true)
39 #define DEFAULT_RX_CSUM_ENABLE		(true)
40 #define SMSC95XX_INTERNAL_PHY_ID	(1)
41 #define SMSC95XX_TX_OVERHEAD		(8)
42 #define SMSC95XX_TX_OVERHEAD_CSUM	(12)
43 #define SUPPORTED_WAKE			(WAKE_PHY | WAKE_UCAST | WAKE_BCAST | \
44 					 WAKE_MCAST | WAKE_ARP | WAKE_MAGIC)
45 
46 #define FEATURE_8_WAKEUP_FILTERS	(0x01)
47 #define FEATURE_PHY_NLP_CROSSOVER	(0x02)
48 #define FEATURE_REMOTE_WAKEUP		(0x04)
49 
50 #define SUSPEND_SUSPEND0		(0x01)
51 #define SUSPEND_SUSPEND1		(0x02)
52 #define SUSPEND_SUSPEND2		(0x04)
53 #define SUSPEND_SUSPEND3		(0x08)
54 #define SUSPEND_ALLMODES		(SUSPEND_SUSPEND0 | SUSPEND_SUSPEND1 | \
55 					 SUSPEND_SUSPEND2 | SUSPEND_SUSPEND3)
56 
57 #define SMSC95XX_NR_IRQS		(1) /* raise to 12 for GPIOs */
58 #define PHY_HWIRQ			(SMSC95XX_NR_IRQS - 1)
59 
60 struct smsc95xx_priv {
61 	u32 mac_cr;
62 	u32 hash_hi;
63 	u32 hash_lo;
64 	u32 wolopts;
65 	bool pause_rx;
66 	bool pause_tx;
67 	bool pause_autoneg;
68 	spinlock_t mac_cr_lock;
69 	u8 features;
70 	u8 suspend_flags;
71 	bool is_internal_phy;
72 	struct irq_chip irqchip;
73 	struct irq_domain *irqdomain;
74 	struct fwnode_handle *irqfwnode;
75 	struct mii_bus *mdiobus;
76 	struct phy_device *phydev;
77 	struct task_struct *pm_task;
78 };
79 
80 static bool turbo_mode = true;
81 module_param(turbo_mode, bool, 0644);
82 MODULE_PARM_DESC(turbo_mode, "Enable multiple frames per Rx transaction");
83 
smsc95xx_read_reg(struct usbnet * dev,u32 index,u32 * data)84 static int __must_check smsc95xx_read_reg(struct usbnet *dev, u32 index,
85 					  u32 *data)
86 {
87 	struct smsc95xx_priv *pdata = dev->driver_priv;
88 	u32 buf;
89 	int ret;
90 	int (*fn)(struct usbnet *, u8, u8, u16, u16, void *, u16);
91 
92 	if (current != pdata->pm_task)
93 		fn = usbnet_read_cmd;
94 	else
95 		fn = usbnet_read_cmd_nopm;
96 
97 	ret = fn(dev, USB_VENDOR_REQUEST_READ_REGISTER, USB_DIR_IN
98 		 | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
99 		 0, index, &buf, 4);
100 	if (ret < 4) {
101 		ret = ret < 0 ? ret : -ENODATA;
102 
103 		if (ret != -ENODEV)
104 			netdev_warn(dev->net, "Failed to read reg index 0x%08x: %d\n",
105 				    index, ret);
106 		return ret;
107 	}
108 
109 	le32_to_cpus(&buf);
110 	*data = buf;
111 
112 	return ret;
113 }
114 
smsc95xx_write_reg(struct usbnet * dev,u32 index,u32 data)115 static int __must_check smsc95xx_write_reg(struct usbnet *dev, u32 index,
116 					   u32 data)
117 {
118 	struct smsc95xx_priv *pdata = dev->driver_priv;
119 	u32 buf;
120 	int ret;
121 	int (*fn)(struct usbnet *, u8, u8, u16, u16, const void *, u16);
122 
123 	if (current != pdata->pm_task)
124 		fn = usbnet_write_cmd;
125 	else
126 		fn = usbnet_write_cmd_nopm;
127 
128 	buf = data;
129 	cpu_to_le32s(&buf);
130 
131 	ret = fn(dev, USB_VENDOR_REQUEST_WRITE_REGISTER, USB_DIR_OUT
132 		 | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
133 		 0, index, &buf, 4);
134 	if (ret < 0 && ret != -ENODEV)
135 		netdev_warn(dev->net, "Failed to write reg index 0x%08x: %d\n",
136 			    index, ret);
137 
138 	return ret;
139 }
140 
141 /* Loop until the read is completed with timeout
142  * called with phy_mutex held */
smsc95xx_phy_wait_not_busy(struct usbnet * dev)143 static int __must_check smsc95xx_phy_wait_not_busy(struct usbnet *dev)
144 {
145 	unsigned long start_time = jiffies;
146 	u32 val;
147 	int ret;
148 
149 	do {
150 		ret = smsc95xx_read_reg(dev, MII_ADDR, &val);
151 		if (ret < 0) {
152 			/* Ignore -ENODEV error during disconnect() */
153 			if (ret == -ENODEV)
154 				return 0;
155 			netdev_warn(dev->net, "Error reading MII_ACCESS\n");
156 			return ret;
157 		}
158 
159 		if (!(val & MII_BUSY_))
160 			return 0;
161 	} while (!time_after(jiffies, start_time + HZ));
162 
163 	return -EIO;
164 }
165 
mii_address_cmd(int phy_id,int idx,u16 op)166 static u32 mii_address_cmd(int phy_id, int idx, u16 op)
167 {
168 	return (phy_id & 0x1f) << 11 | (idx & 0x1f) << 6 | op;
169 }
170 
smsc95xx_mdio_read(struct usbnet * dev,int phy_id,int idx)171 static int smsc95xx_mdio_read(struct usbnet *dev, int phy_id, int idx)
172 {
173 	u32 val, addr;
174 	int ret;
175 
176 	mutex_lock(&dev->phy_mutex);
177 
178 	/* confirm MII not busy */
179 	ret = smsc95xx_phy_wait_not_busy(dev);
180 	if (ret < 0) {
181 		netdev_warn(dev->net, "%s: MII is busy\n", __func__);
182 		goto done;
183 	}
184 
185 	/* set the address, index & direction (read from PHY) */
186 	addr = mii_address_cmd(phy_id, idx, MII_READ_ | MII_BUSY_);
187 	ret = smsc95xx_write_reg(dev, MII_ADDR, addr);
188 	if (ret < 0) {
189 		if (ret != -ENODEV)
190 			netdev_warn(dev->net, "Error writing MII_ADDR\n");
191 		goto done;
192 	}
193 
194 	ret = smsc95xx_phy_wait_not_busy(dev);
195 	if (ret < 0) {
196 		netdev_warn(dev->net, "Timed out reading MII reg %02X\n", idx);
197 		goto done;
198 	}
199 
200 	ret = smsc95xx_read_reg(dev, MII_DATA, &val);
201 	if (ret < 0) {
202 		if (ret != -ENODEV)
203 			netdev_warn(dev->net, "Error reading MII_DATA\n");
204 		goto done;
205 	}
206 
207 	ret = (u16)(val & 0xFFFF);
208 
209 done:
210 	mutex_unlock(&dev->phy_mutex);
211 
212 	/* Ignore -ENODEV error during disconnect() */
213 	if (ret == -ENODEV)
214 		return 0;
215 	return ret;
216 }
217 
smsc95xx_mdio_write(struct usbnet * dev,int phy_id,int idx,int regval)218 static void smsc95xx_mdio_write(struct usbnet *dev, int phy_id, int idx,
219 				int regval)
220 {
221 	u32 val, addr;
222 	int ret;
223 
224 	mutex_lock(&dev->phy_mutex);
225 
226 	/* confirm MII not busy */
227 	ret = smsc95xx_phy_wait_not_busy(dev);
228 	if (ret < 0) {
229 		netdev_warn(dev->net, "%s: MII is busy\n", __func__);
230 		goto done;
231 	}
232 
233 	val = regval;
234 	ret = smsc95xx_write_reg(dev, MII_DATA, val);
235 	if (ret < 0) {
236 		if (ret != -ENODEV)
237 			netdev_warn(dev->net, "Error writing MII_DATA\n");
238 		goto done;
239 	}
240 
241 	/* set the address, index & direction (write to PHY) */
242 	addr = mii_address_cmd(phy_id, idx, MII_WRITE_ | MII_BUSY_);
243 	ret = smsc95xx_write_reg(dev, MII_ADDR, addr);
244 	if (ret < 0) {
245 		if (ret != -ENODEV)
246 			netdev_warn(dev->net, "Error writing MII_ADDR\n");
247 		goto done;
248 	}
249 
250 	ret = smsc95xx_phy_wait_not_busy(dev);
251 	if (ret < 0) {
252 		netdev_warn(dev->net, "Timed out writing MII reg %02X\n", idx);
253 		goto done;
254 	}
255 
256 done:
257 	mutex_unlock(&dev->phy_mutex);
258 }
259 
smsc95xx_mdiobus_reset(struct mii_bus * bus)260 static int smsc95xx_mdiobus_reset(struct mii_bus *bus)
261 {
262 	struct smsc95xx_priv *pdata;
263 	struct usbnet *dev;
264 	u32 val;
265 	int ret;
266 
267 	dev = bus->priv;
268 	pdata = dev->driver_priv;
269 
270 	if (pdata->is_internal_phy)
271 		return 0;
272 
273 	mutex_lock(&dev->phy_mutex);
274 
275 	ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
276 	if (ret < 0)
277 		goto reset_out;
278 
279 	val |= PM_CTL_PHY_RST_;
280 
281 	ret = smsc95xx_write_reg(dev, PM_CTRL, val);
282 	if (ret < 0)
283 		goto reset_out;
284 
285 	/* Driver has no knowledge at this point about the external PHY.
286 	 * The 802.3 specifies that the reset process shall
287 	 * be completed within 0.5 s.
288 	 */
289 	fsleep(500000);
290 
291 reset_out:
292 	mutex_unlock(&dev->phy_mutex);
293 
294 	return 0;
295 }
296 
smsc95xx_mdiobus_read(struct mii_bus * bus,int phy_id,int idx)297 static int smsc95xx_mdiobus_read(struct mii_bus *bus, int phy_id, int idx)
298 {
299 	struct usbnet *dev = bus->priv;
300 
301 	return smsc95xx_mdio_read(dev, phy_id, idx);
302 }
303 
smsc95xx_mdiobus_write(struct mii_bus * bus,int phy_id,int idx,u16 regval)304 static int smsc95xx_mdiobus_write(struct mii_bus *bus, int phy_id, int idx,
305 				  u16 regval)
306 {
307 	struct usbnet *dev = bus->priv;
308 
309 	smsc95xx_mdio_write(dev, phy_id, idx, regval);
310 	return 0;
311 }
312 
smsc95xx_wait_eeprom(struct usbnet * dev)313 static int __must_check smsc95xx_wait_eeprom(struct usbnet *dev)
314 {
315 	unsigned long start_time = jiffies;
316 	u32 val;
317 	int ret;
318 
319 	do {
320 		ret = smsc95xx_read_reg(dev, E2P_CMD, &val);
321 		if (ret < 0) {
322 			netdev_warn(dev->net, "Error reading E2P_CMD\n");
323 			return ret;
324 		}
325 
326 		if (!(val & E2P_CMD_BUSY_) || (val & E2P_CMD_TIMEOUT_))
327 			break;
328 		udelay(40);
329 	} while (!time_after(jiffies, start_time + HZ));
330 
331 	if (val & (E2P_CMD_TIMEOUT_ | E2P_CMD_BUSY_)) {
332 		netdev_warn(dev->net, "EEPROM read operation timeout\n");
333 		return -EIO;
334 	}
335 
336 	return 0;
337 }
338 
smsc95xx_eeprom_confirm_not_busy(struct usbnet * dev)339 static int __must_check smsc95xx_eeprom_confirm_not_busy(struct usbnet *dev)
340 {
341 	unsigned long start_time = jiffies;
342 	u32 val;
343 	int ret;
344 
345 	do {
346 		ret = smsc95xx_read_reg(dev, E2P_CMD, &val);
347 		if (ret < 0) {
348 			netdev_warn(dev->net, "Error reading E2P_CMD\n");
349 			return ret;
350 		}
351 
352 		if (!(val & E2P_CMD_BUSY_))
353 			return 0;
354 
355 		udelay(40);
356 	} while (!time_after(jiffies, start_time + HZ));
357 
358 	netdev_warn(dev->net, "EEPROM is busy\n");
359 	return -EIO;
360 }
361 
smsc95xx_read_eeprom(struct usbnet * dev,u32 offset,u32 length,u8 * data)362 static int smsc95xx_read_eeprom(struct usbnet *dev, u32 offset, u32 length,
363 				u8 *data)
364 {
365 	u32 val;
366 	int i, ret;
367 
368 	BUG_ON(!dev);
369 	BUG_ON(!data);
370 
371 	ret = smsc95xx_eeprom_confirm_not_busy(dev);
372 	if (ret)
373 		return ret;
374 
375 	for (i = 0; i < length; i++) {
376 		val = E2P_CMD_BUSY_ | E2P_CMD_READ_ | (offset & E2P_CMD_ADDR_);
377 		ret = smsc95xx_write_reg(dev, E2P_CMD, val);
378 		if (ret < 0) {
379 			netdev_warn(dev->net, "Error writing E2P_CMD\n");
380 			return ret;
381 		}
382 
383 		ret = smsc95xx_wait_eeprom(dev);
384 		if (ret < 0)
385 			return ret;
386 
387 		ret = smsc95xx_read_reg(dev, E2P_DATA, &val);
388 		if (ret < 0) {
389 			netdev_warn(dev->net, "Error reading E2P_DATA\n");
390 			return ret;
391 		}
392 
393 		data[i] = val & 0xFF;
394 		offset++;
395 	}
396 
397 	return 0;
398 }
399 
smsc95xx_write_eeprom(struct usbnet * dev,u32 offset,u32 length,u8 * data)400 static int smsc95xx_write_eeprom(struct usbnet *dev, u32 offset, u32 length,
401 				 u8 *data)
402 {
403 	u32 val;
404 	int i, ret;
405 
406 	BUG_ON(!dev);
407 	BUG_ON(!data);
408 
409 	ret = smsc95xx_eeprom_confirm_not_busy(dev);
410 	if (ret)
411 		return ret;
412 
413 	/* Issue write/erase enable command */
414 	val = E2P_CMD_BUSY_ | E2P_CMD_EWEN_;
415 	ret = smsc95xx_write_reg(dev, E2P_CMD, val);
416 	if (ret < 0) {
417 		netdev_warn(dev->net, "Error writing E2P_DATA\n");
418 		return ret;
419 	}
420 
421 	ret = smsc95xx_wait_eeprom(dev);
422 	if (ret < 0)
423 		return ret;
424 
425 	for (i = 0; i < length; i++) {
426 
427 		/* Fill data register */
428 		val = data[i];
429 		ret = smsc95xx_write_reg(dev, E2P_DATA, val);
430 		if (ret < 0) {
431 			netdev_warn(dev->net, "Error writing E2P_DATA\n");
432 			return ret;
433 		}
434 
435 		/* Send "write" command */
436 		val = E2P_CMD_BUSY_ | E2P_CMD_WRITE_ | (offset & E2P_CMD_ADDR_);
437 		ret = smsc95xx_write_reg(dev, E2P_CMD, val);
438 		if (ret < 0) {
439 			netdev_warn(dev->net, "Error writing E2P_CMD\n");
440 			return ret;
441 		}
442 
443 		ret = smsc95xx_wait_eeprom(dev);
444 		if (ret < 0)
445 			return ret;
446 
447 		offset++;
448 	}
449 
450 	return 0;
451 }
452 
smsc95xx_write_reg_async(struct usbnet * dev,u16 index,u32 data)453 static int __must_check smsc95xx_write_reg_async(struct usbnet *dev, u16 index,
454 						 u32 data)
455 {
456 	const u16 size = 4;
457 	u32 buf;
458 	int ret;
459 
460 	buf = data;
461 	cpu_to_le32s(&buf);
462 
463 	ret = usbnet_write_cmd_async(dev, USB_VENDOR_REQUEST_WRITE_REGISTER,
464 				     USB_DIR_OUT | USB_TYPE_VENDOR |
465 				     USB_RECIP_DEVICE,
466 				     0, index, &buf, size);
467 	if (ret < 0)
468 		netdev_warn(dev->net, "Error write async cmd, sts=%d\n",
469 			    ret);
470 	return ret;
471 }
472 
473 /* returns hash bit number for given MAC address
474  * example:
475  * 01 00 5E 00 00 01 -> returns bit number 31 */
smsc95xx_hash(char addr[ETH_ALEN])476 static unsigned int smsc95xx_hash(char addr[ETH_ALEN])
477 {
478 	return (ether_crc(ETH_ALEN, addr) >> 26) & 0x3f;
479 }
480 
smsc95xx_set_multicast(struct net_device * netdev)481 static void smsc95xx_set_multicast(struct net_device *netdev)
482 {
483 	struct usbnet *dev = netdev_priv(netdev);
484 	struct smsc95xx_priv *pdata = dev->driver_priv;
485 	unsigned long flags;
486 	int ret;
487 
488 	pdata->hash_hi = 0;
489 	pdata->hash_lo = 0;
490 
491 	spin_lock_irqsave(&pdata->mac_cr_lock, flags);
492 
493 	if (dev->net->flags & IFF_PROMISC) {
494 		netif_dbg(dev, drv, dev->net, "promiscuous mode enabled\n");
495 		pdata->mac_cr |= MAC_CR_PRMS_;
496 		pdata->mac_cr &= ~(MAC_CR_MCPAS_ | MAC_CR_HPFILT_);
497 	} else if (dev->net->flags & IFF_ALLMULTI) {
498 		netif_dbg(dev, drv, dev->net, "receive all multicast enabled\n");
499 		pdata->mac_cr |= MAC_CR_MCPAS_;
500 		pdata->mac_cr &= ~(MAC_CR_PRMS_ | MAC_CR_HPFILT_);
501 	} else if (!netdev_mc_empty(dev->net)) {
502 		struct netdev_hw_addr *ha;
503 
504 		pdata->mac_cr |= MAC_CR_HPFILT_;
505 		pdata->mac_cr &= ~(MAC_CR_PRMS_ | MAC_CR_MCPAS_);
506 
507 		netdev_for_each_mc_addr(ha, netdev) {
508 			u32 bitnum = smsc95xx_hash(ha->addr);
509 			u32 mask = 0x01 << (bitnum & 0x1F);
510 			if (bitnum & 0x20)
511 				pdata->hash_hi |= mask;
512 			else
513 				pdata->hash_lo |= mask;
514 		}
515 
516 		netif_dbg(dev, drv, dev->net, "HASHH=0x%08X, HASHL=0x%08X\n",
517 				   pdata->hash_hi, pdata->hash_lo);
518 	} else {
519 		netif_dbg(dev, drv, dev->net, "receive own packets only\n");
520 		pdata->mac_cr &=
521 			~(MAC_CR_PRMS_ | MAC_CR_MCPAS_ | MAC_CR_HPFILT_);
522 	}
523 
524 	spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
525 
526 	/* Initiate async writes, as we can't wait for completion here */
527 	ret = smsc95xx_write_reg_async(dev, HASHH, pdata->hash_hi);
528 	if (ret < 0)
529 		netdev_warn(dev->net, "failed to initiate async write to HASHH\n");
530 
531 	ret = smsc95xx_write_reg_async(dev, HASHL, pdata->hash_lo);
532 	if (ret < 0)
533 		netdev_warn(dev->net, "failed to initiate async write to HASHL\n");
534 
535 	ret = smsc95xx_write_reg_async(dev, MAC_CR, pdata->mac_cr);
536 	if (ret < 0)
537 		netdev_warn(dev->net, "failed to initiate async write to MAC_CR\n");
538 }
539 
smsc95xx_phy_update_flowcontrol(struct usbnet * dev)540 static int smsc95xx_phy_update_flowcontrol(struct usbnet *dev)
541 {
542 	struct smsc95xx_priv *pdata = dev->driver_priv;
543 	u32 flow = 0, afc_cfg;
544 
545 	int ret = smsc95xx_read_reg(dev, AFC_CFG, &afc_cfg);
546 	if (ret < 0)
547 		return ret;
548 
549 	if (pdata->phydev->duplex == DUPLEX_FULL) {
550 		bool tx_pause, rx_pause;
551 
552 		if (pdata->phydev->autoneg == AUTONEG_ENABLE &&
553 		    pdata->pause_autoneg) {
554 			phy_get_pause(pdata->phydev, &tx_pause, &rx_pause);
555 		} else {
556 			tx_pause = pdata->pause_tx;
557 			rx_pause = pdata->pause_rx;
558 		}
559 
560 		if (rx_pause)
561 			flow = 0xFFFF0002;
562 
563 		if (tx_pause) {
564 			afc_cfg |= 0xF;
565 			flow |= 0xFFFF0000;
566 		} else {
567 			afc_cfg &= ~0xF;
568 		}
569 
570 		netif_dbg(dev, link, dev->net, "rx pause %s, tx pause %s\n",
571 			  rx_pause ? "enabled" : "disabled",
572 			  tx_pause ? "enabled" : "disabled");
573 	} else {
574 		netif_dbg(dev, link, dev->net, "half duplex\n");
575 		afc_cfg |= 0xF;
576 	}
577 
578 	ret = smsc95xx_write_reg(dev, FLOW, flow);
579 	if (ret < 0)
580 		return ret;
581 
582 	return smsc95xx_write_reg(dev, AFC_CFG, afc_cfg);
583 }
584 
smsc95xx_mac_update_fullduplex(struct usbnet * dev)585 static void smsc95xx_mac_update_fullduplex(struct usbnet *dev)
586 {
587 	struct smsc95xx_priv *pdata = dev->driver_priv;
588 	unsigned long flags;
589 	int ret;
590 
591 	spin_lock_irqsave(&pdata->mac_cr_lock, flags);
592 	if (pdata->phydev->duplex != DUPLEX_FULL) {
593 		pdata->mac_cr &= ~MAC_CR_FDPX_;
594 		pdata->mac_cr |= MAC_CR_RCVOWN_;
595 	} else {
596 		pdata->mac_cr &= ~MAC_CR_RCVOWN_;
597 		pdata->mac_cr |= MAC_CR_FDPX_;
598 	}
599 	spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
600 
601 	ret = smsc95xx_write_reg(dev, MAC_CR, pdata->mac_cr);
602 	if (ret < 0) {
603 		if (ret != -ENODEV)
604 			netdev_warn(dev->net,
605 				    "Error updating MAC full duplex mode\n");
606 		return;
607 	}
608 
609 	ret = smsc95xx_phy_update_flowcontrol(dev);
610 	if (ret < 0)
611 		netdev_warn(dev->net, "Error updating PHY flow control\n");
612 }
613 
smsc95xx_status(struct usbnet * dev,struct urb * urb)614 static void smsc95xx_status(struct usbnet *dev, struct urb *urb)
615 {
616 	struct smsc95xx_priv *pdata = dev->driver_priv;
617 	unsigned long flags;
618 	u32 intdata;
619 
620 	if (urb->actual_length != 4) {
621 		netdev_warn(dev->net, "unexpected urb length %d\n",
622 			    urb->actual_length);
623 		return;
624 	}
625 
626 	intdata = get_unaligned_le32(urb->transfer_buffer);
627 	netif_dbg(dev, link, dev->net, "intdata: 0x%08X\n", intdata);
628 
629 	local_irq_save(flags);
630 
631 	if (intdata & INT_ENP_PHY_INT_)
632 		generic_handle_domain_irq(pdata->irqdomain, PHY_HWIRQ);
633 	else
634 		netdev_warn(dev->net, "unexpected interrupt, intdata=0x%08X\n",
635 			    intdata);
636 
637 	local_irq_restore(flags);
638 }
639 
640 /* Enable or disable Tx & Rx checksum offload engines */
smsc95xx_set_features(struct net_device * netdev,netdev_features_t features)641 static int smsc95xx_set_features(struct net_device *netdev,
642 	netdev_features_t features)
643 {
644 	struct usbnet *dev = netdev_priv(netdev);
645 	u32 read_buf;
646 	int ret;
647 
648 	ret = smsc95xx_read_reg(dev, COE_CR, &read_buf);
649 	if (ret < 0)
650 		return ret;
651 
652 	if (features & NETIF_F_IP_CSUM)
653 		read_buf |= Tx_COE_EN_;
654 	else
655 		read_buf &= ~Tx_COE_EN_;
656 
657 	if (features & NETIF_F_RXCSUM)
658 		read_buf |= Rx_COE_EN_;
659 	else
660 		read_buf &= ~Rx_COE_EN_;
661 
662 	ret = smsc95xx_write_reg(dev, COE_CR, read_buf);
663 	if (ret < 0)
664 		return ret;
665 
666 	netif_dbg(dev, hw, dev->net, "COE_CR = 0x%08x\n", read_buf);
667 	return 0;
668 }
669 
smsc95xx_ethtool_get_eeprom_len(struct net_device * net)670 static int smsc95xx_ethtool_get_eeprom_len(struct net_device *net)
671 {
672 	return MAX_EEPROM_SIZE;
673 }
674 
smsc95xx_ethtool_get_eeprom(struct net_device * netdev,struct ethtool_eeprom * ee,u8 * data)675 static int smsc95xx_ethtool_get_eeprom(struct net_device *netdev,
676 				       struct ethtool_eeprom *ee, u8 *data)
677 {
678 	struct usbnet *dev = netdev_priv(netdev);
679 
680 	ee->magic = LAN95XX_EEPROM_MAGIC;
681 
682 	return smsc95xx_read_eeprom(dev, ee->offset, ee->len, data);
683 }
684 
smsc95xx_ethtool_set_eeprom(struct net_device * netdev,struct ethtool_eeprom * ee,u8 * data)685 static int smsc95xx_ethtool_set_eeprom(struct net_device *netdev,
686 				       struct ethtool_eeprom *ee, u8 *data)
687 {
688 	struct usbnet *dev = netdev_priv(netdev);
689 
690 	if (ee->magic != LAN95XX_EEPROM_MAGIC) {
691 		netdev_warn(dev->net, "EEPROM: magic value mismatch, magic = 0x%x\n",
692 			    ee->magic);
693 		return -EINVAL;
694 	}
695 
696 	return smsc95xx_write_eeprom(dev, ee->offset, ee->len, data);
697 }
698 
smsc95xx_ethtool_getregslen(struct net_device * netdev)699 static int smsc95xx_ethtool_getregslen(struct net_device *netdev)
700 {
701 	/* all smsc95xx registers */
702 	return COE_CR - ID_REV + sizeof(u32);
703 }
704 
705 static void
smsc95xx_ethtool_getregs(struct net_device * netdev,struct ethtool_regs * regs,void * buf)706 smsc95xx_ethtool_getregs(struct net_device *netdev, struct ethtool_regs *regs,
707 			 void *buf)
708 {
709 	struct usbnet *dev = netdev_priv(netdev);
710 	unsigned int i, j;
711 	int retval;
712 	u32 *data = buf;
713 
714 	retval = smsc95xx_read_reg(dev, ID_REV, &regs->version);
715 	if (retval < 0) {
716 		netdev_warn(netdev, "REGS: cannot read ID_REV\n");
717 		return;
718 	}
719 
720 	for (i = ID_REV, j = 0; i <= COE_CR; i += (sizeof(u32)), j++) {
721 		retval = smsc95xx_read_reg(dev, i, &data[j]);
722 		if (retval < 0) {
723 			netdev_warn(netdev, "REGS: cannot read reg[%x]\n", i);
724 			return;
725 		}
726 	}
727 }
728 
smsc95xx_ethtool_get_wol(struct net_device * net,struct ethtool_wolinfo * wolinfo)729 static void smsc95xx_ethtool_get_wol(struct net_device *net,
730 				     struct ethtool_wolinfo *wolinfo)
731 {
732 	struct usbnet *dev = netdev_priv(net);
733 	struct smsc95xx_priv *pdata = dev->driver_priv;
734 
735 	wolinfo->supported = SUPPORTED_WAKE;
736 	wolinfo->wolopts = pdata->wolopts;
737 }
738 
smsc95xx_ethtool_set_wol(struct net_device * net,struct ethtool_wolinfo * wolinfo)739 static int smsc95xx_ethtool_set_wol(struct net_device *net,
740 				    struct ethtool_wolinfo *wolinfo)
741 {
742 	struct usbnet *dev = netdev_priv(net);
743 	struct smsc95xx_priv *pdata = dev->driver_priv;
744 	int ret;
745 
746 	if (wolinfo->wolopts & ~SUPPORTED_WAKE)
747 		return -EINVAL;
748 
749 	pdata->wolopts = wolinfo->wolopts & SUPPORTED_WAKE;
750 
751 	ret = device_set_wakeup_enable(&dev->udev->dev, pdata->wolopts);
752 	if (ret < 0)
753 		netdev_warn(dev->net, "device_set_wakeup_enable error %d\n", ret);
754 
755 	return ret;
756 }
757 
smsc95xx_get_link(struct net_device * net)758 static u32 smsc95xx_get_link(struct net_device *net)
759 {
760 	phy_read_status(net->phydev);
761 	return net->phydev->link;
762 }
763 
smsc95xx_ethtool_get_strings(struct net_device * netdev,u32 sset,u8 * data)764 static void smsc95xx_ethtool_get_strings(struct net_device *netdev, u32 sset,
765 					u8 *data)
766 {
767 	switch (sset) {
768 	case ETH_SS_TEST:
769 		net_selftest_get_strings(data);
770 		break;
771 	}
772 }
773 
smsc95xx_ethtool_get_sset_count(struct net_device * ndev,int sset)774 static int smsc95xx_ethtool_get_sset_count(struct net_device *ndev, int sset)
775 {
776 	switch (sset) {
777 	case ETH_SS_TEST:
778 		return net_selftest_get_count();
779 	default:
780 		return -EOPNOTSUPP;
781 	}
782 }
783 
smsc95xx_get_pauseparam(struct net_device * ndev,struct ethtool_pauseparam * pause)784 static void smsc95xx_get_pauseparam(struct net_device *ndev,
785 				    struct ethtool_pauseparam *pause)
786 {
787 	struct smsc95xx_priv *pdata;
788 	struct usbnet *dev;
789 
790 	dev = netdev_priv(ndev);
791 	pdata = dev->driver_priv;
792 
793 	pause->autoneg = pdata->pause_autoneg;
794 	pause->rx_pause = pdata->pause_rx;
795 	pause->tx_pause = pdata->pause_tx;
796 }
797 
smsc95xx_set_pauseparam(struct net_device * ndev,struct ethtool_pauseparam * pause)798 static int smsc95xx_set_pauseparam(struct net_device *ndev,
799 				   struct ethtool_pauseparam *pause)
800 {
801 	bool pause_autoneg_rx, pause_autoneg_tx;
802 	struct smsc95xx_priv *pdata;
803 	struct phy_device *phydev;
804 	struct usbnet *dev;
805 
806 	dev = netdev_priv(ndev);
807 	pdata = dev->driver_priv;
808 	phydev = ndev->phydev;
809 
810 	if (!phydev)
811 		return -ENODEV;
812 
813 	pdata->pause_rx = pause->rx_pause;
814 	pdata->pause_tx = pause->tx_pause;
815 	pdata->pause_autoneg = pause->autoneg;
816 
817 	if (pause->autoneg) {
818 		pause_autoneg_rx = pause->rx_pause;
819 		pause_autoneg_tx = pause->tx_pause;
820 	} else {
821 		pause_autoneg_rx = false;
822 		pause_autoneg_tx = false;
823 	}
824 
825 	phy_set_asym_pause(ndev->phydev, pause_autoneg_rx, pause_autoneg_tx);
826 	if (phydev->link && (!pause->autoneg ||
827 			     phydev->autoneg == AUTONEG_DISABLE))
828 		smsc95xx_mac_update_fullduplex(dev);
829 
830 	return 0;
831 }
832 
833 static const struct ethtool_ops smsc95xx_ethtool_ops = {
834 	.get_link	= smsc95xx_get_link,
835 	.nway_reset	= phy_ethtool_nway_reset,
836 	.get_drvinfo	= usbnet_get_drvinfo,
837 	.get_msglevel	= usbnet_get_msglevel,
838 	.set_msglevel	= usbnet_set_msglevel,
839 	.get_eeprom_len	= smsc95xx_ethtool_get_eeprom_len,
840 	.get_eeprom	= smsc95xx_ethtool_get_eeprom,
841 	.set_eeprom	= smsc95xx_ethtool_set_eeprom,
842 	.get_regs_len	= smsc95xx_ethtool_getregslen,
843 	.get_regs	= smsc95xx_ethtool_getregs,
844 	.get_wol	= smsc95xx_ethtool_get_wol,
845 	.set_wol	= smsc95xx_ethtool_set_wol,
846 	.get_link_ksettings	= phy_ethtool_get_link_ksettings,
847 	.set_link_ksettings	= phy_ethtool_set_link_ksettings,
848 	.get_ts_info	= ethtool_op_get_ts_info,
849 	.self_test	= net_selftest,
850 	.get_strings	= smsc95xx_ethtool_get_strings,
851 	.get_sset_count	= smsc95xx_ethtool_get_sset_count,
852 	.get_pauseparam	= smsc95xx_get_pauseparam,
853 	.set_pauseparam	= smsc95xx_set_pauseparam,
854 };
855 
smsc95xx_init_mac_address(struct usbnet * dev)856 static void smsc95xx_init_mac_address(struct usbnet *dev)
857 {
858 	u8 addr[ETH_ALEN];
859 
860 	/* maybe the boot loader passed the MAC address in devicetree */
861 	if (!platform_get_ethdev_address(&dev->udev->dev, dev->net)) {
862 		if (is_valid_ether_addr(dev->net->dev_addr)) {
863 			/* device tree values are valid so use them */
864 			netif_dbg(dev, ifup, dev->net, "MAC address read from the device tree\n");
865 			return;
866 		}
867 	}
868 
869 	/* try reading mac address from EEPROM */
870 	if (smsc95xx_read_eeprom(dev, EEPROM_MAC_OFFSET, ETH_ALEN, addr) == 0) {
871 		eth_hw_addr_set(dev->net, addr);
872 		if (is_valid_ether_addr(dev->net->dev_addr)) {
873 			/* eeprom values are valid so use them */
874 			netif_dbg(dev, ifup, dev->net, "MAC address read from EEPROM\n");
875 			return;
876 		}
877 	}
878 
879 	/* no useful static MAC address found. generate a random one */
880 	eth_hw_addr_random(dev->net);
881 	netif_dbg(dev, ifup, dev->net, "MAC address set to eth_random_addr\n");
882 }
883 
smsc95xx_set_mac_address(struct usbnet * dev)884 static int smsc95xx_set_mac_address(struct usbnet *dev)
885 {
886 	u32 addr_lo = dev->net->dev_addr[0] | dev->net->dev_addr[1] << 8 |
887 		dev->net->dev_addr[2] << 16 | dev->net->dev_addr[3] << 24;
888 	u32 addr_hi = dev->net->dev_addr[4] | dev->net->dev_addr[5] << 8;
889 	int ret;
890 
891 	ret = smsc95xx_write_reg(dev, ADDRL, addr_lo);
892 	if (ret < 0)
893 		return ret;
894 
895 	return smsc95xx_write_reg(dev, ADDRH, addr_hi);
896 }
897 
898 /* starts the TX path */
smsc95xx_start_tx_path(struct usbnet * dev)899 static int smsc95xx_start_tx_path(struct usbnet *dev)
900 {
901 	struct smsc95xx_priv *pdata = dev->driver_priv;
902 	unsigned long flags;
903 	int ret;
904 
905 	/* Enable Tx at MAC */
906 	spin_lock_irqsave(&pdata->mac_cr_lock, flags);
907 	pdata->mac_cr |= MAC_CR_TXEN_;
908 	spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
909 
910 	ret = smsc95xx_write_reg(dev, MAC_CR, pdata->mac_cr);
911 	if (ret < 0)
912 		return ret;
913 
914 	/* Enable Tx at SCSRs */
915 	return smsc95xx_write_reg(dev, TX_CFG, TX_CFG_ON_);
916 }
917 
918 /* Starts the Receive path */
smsc95xx_start_rx_path(struct usbnet * dev)919 static int smsc95xx_start_rx_path(struct usbnet *dev)
920 {
921 	struct smsc95xx_priv *pdata = dev->driver_priv;
922 	unsigned long flags;
923 
924 	spin_lock_irqsave(&pdata->mac_cr_lock, flags);
925 	pdata->mac_cr |= MAC_CR_RXEN_;
926 	spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
927 
928 	return smsc95xx_write_reg(dev, MAC_CR, pdata->mac_cr);
929 }
930 
smsc95xx_reset(struct usbnet * dev)931 static int smsc95xx_reset(struct usbnet *dev)
932 {
933 	struct smsc95xx_priv *pdata = dev->driver_priv;
934 	u32 read_buf, burst_cap;
935 	int ret = 0, timeout;
936 
937 	netif_dbg(dev, ifup, dev->net, "entering smsc95xx_reset\n");
938 
939 	ret = smsc95xx_write_reg(dev, HW_CFG, HW_CFG_LRST_);
940 	if (ret < 0)
941 		return ret;
942 
943 	timeout = 0;
944 	do {
945 		msleep(10);
946 		ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
947 		if (ret < 0)
948 			return ret;
949 		timeout++;
950 	} while ((read_buf & HW_CFG_LRST_) && (timeout < 100));
951 
952 	if (timeout >= 100) {
953 		netdev_warn(dev->net, "timeout waiting for completion of Lite Reset\n");
954 		return -ETIMEDOUT;
955 	}
956 
957 	ret = smsc95xx_set_mac_address(dev);
958 	if (ret < 0)
959 		return ret;
960 
961 	netif_dbg(dev, ifup, dev->net, "MAC Address: %pM\n",
962 		  dev->net->dev_addr);
963 
964 	ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
965 	if (ret < 0)
966 		return ret;
967 
968 	netif_dbg(dev, ifup, dev->net, "Read Value from HW_CFG : 0x%08x\n",
969 		  read_buf);
970 
971 	read_buf |= HW_CFG_BIR_;
972 
973 	ret = smsc95xx_write_reg(dev, HW_CFG, read_buf);
974 	if (ret < 0)
975 		return ret;
976 
977 	ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
978 	if (ret < 0)
979 		return ret;
980 
981 	netif_dbg(dev, ifup, dev->net,
982 		  "Read Value from HW_CFG after writing HW_CFG_BIR_: 0x%08x\n",
983 		  read_buf);
984 
985 	if (!turbo_mode) {
986 		burst_cap = 0;
987 		dev->rx_urb_size = MAX_SINGLE_PACKET_SIZE;
988 	} else if (dev->udev->speed == USB_SPEED_HIGH) {
989 		burst_cap = DEFAULT_HS_BURST_CAP_SIZE / HS_USB_PKT_SIZE;
990 		dev->rx_urb_size = DEFAULT_HS_BURST_CAP_SIZE;
991 	} else {
992 		burst_cap = DEFAULT_FS_BURST_CAP_SIZE / FS_USB_PKT_SIZE;
993 		dev->rx_urb_size = DEFAULT_FS_BURST_CAP_SIZE;
994 	}
995 
996 	netif_dbg(dev, ifup, dev->net, "rx_urb_size=%ld\n",
997 		  (ulong)dev->rx_urb_size);
998 
999 	ret = smsc95xx_write_reg(dev, BURST_CAP, burst_cap);
1000 	if (ret < 0)
1001 		return ret;
1002 
1003 	ret = smsc95xx_read_reg(dev, BURST_CAP, &read_buf);
1004 	if (ret < 0)
1005 		return ret;
1006 
1007 	netif_dbg(dev, ifup, dev->net,
1008 		  "Read Value from BURST_CAP after writing: 0x%08x\n",
1009 		  read_buf);
1010 
1011 	ret = smsc95xx_write_reg(dev, BULK_IN_DLY, DEFAULT_BULK_IN_DELAY);
1012 	if (ret < 0)
1013 		return ret;
1014 
1015 	ret = smsc95xx_read_reg(dev, BULK_IN_DLY, &read_buf);
1016 	if (ret < 0)
1017 		return ret;
1018 
1019 	netif_dbg(dev, ifup, dev->net,
1020 		  "Read Value from BULK_IN_DLY after writing: 0x%08x\n",
1021 		  read_buf);
1022 
1023 	ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
1024 	if (ret < 0)
1025 		return ret;
1026 
1027 	netif_dbg(dev, ifup, dev->net, "Read Value from HW_CFG: 0x%08x\n",
1028 		  read_buf);
1029 
1030 	if (turbo_mode)
1031 		read_buf |= (HW_CFG_MEF_ | HW_CFG_BCE_);
1032 
1033 	read_buf &= ~HW_CFG_RXDOFF_;
1034 
1035 	/* set Rx data offset=2, Make IP header aligns on word boundary. */
1036 	read_buf |= NET_IP_ALIGN << 9;
1037 
1038 	ret = smsc95xx_write_reg(dev, HW_CFG, read_buf);
1039 	if (ret < 0)
1040 		return ret;
1041 
1042 	ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
1043 	if (ret < 0)
1044 		return ret;
1045 
1046 	netif_dbg(dev, ifup, dev->net,
1047 		  "Read Value from HW_CFG after writing: 0x%08x\n", read_buf);
1048 
1049 	ret = smsc95xx_write_reg(dev, INT_STS, INT_STS_CLEAR_ALL_);
1050 	if (ret < 0)
1051 		return ret;
1052 
1053 	ret = smsc95xx_read_reg(dev, ID_REV, &read_buf);
1054 	if (ret < 0)
1055 		return ret;
1056 	netif_dbg(dev, ifup, dev->net, "ID_REV = 0x%08x\n", read_buf);
1057 
1058 	ret = smsc95xx_read_reg(dev, LED_GPIO_CFG, &read_buf);
1059 	if (ret < 0)
1060 		return ret;
1061 	/* Configure GPIO pins as LED outputs */
1062 	read_buf |= LED_GPIO_CFG_SPD_LED | LED_GPIO_CFG_LNK_LED |
1063 		    LED_GPIO_CFG_FDX_LED;
1064 	ret = smsc95xx_write_reg(dev, LED_GPIO_CFG, read_buf);
1065 	if (ret < 0)
1066 		return ret;
1067 
1068 	/* Init Tx */
1069 	ret = smsc95xx_write_reg(dev, FLOW, 0);
1070 	if (ret < 0)
1071 		return ret;
1072 
1073 	ret = smsc95xx_write_reg(dev, AFC_CFG, AFC_CFG_DEFAULT);
1074 	if (ret < 0)
1075 		return ret;
1076 
1077 	/* Don't need mac_cr_lock during initialisation */
1078 	ret = smsc95xx_read_reg(dev, MAC_CR, &pdata->mac_cr);
1079 	if (ret < 0)
1080 		return ret;
1081 
1082 	/* Init Rx */
1083 	/* Set Vlan */
1084 	ret = smsc95xx_write_reg(dev, VLAN1, (u32)ETH_P_8021Q);
1085 	if (ret < 0)
1086 		return ret;
1087 
1088 	/* Enable or disable checksum offload engines */
1089 	ret = smsc95xx_set_features(dev->net, dev->net->features);
1090 	if (ret < 0) {
1091 		netdev_warn(dev->net, "Failed to set checksum offload features\n");
1092 		return ret;
1093 	}
1094 
1095 	smsc95xx_set_multicast(dev->net);
1096 
1097 	ret = smsc95xx_read_reg(dev, INT_EP_CTL, &read_buf);
1098 	if (ret < 0)
1099 		return ret;
1100 
1101 	/* enable PHY interrupts */
1102 	read_buf |= INT_EP_CTL_PHY_INT_;
1103 
1104 	ret = smsc95xx_write_reg(dev, INT_EP_CTL, read_buf);
1105 	if (ret < 0)
1106 		return ret;
1107 
1108 	ret = smsc95xx_start_tx_path(dev);
1109 	if (ret < 0) {
1110 		netdev_warn(dev->net, "Failed to start TX path\n");
1111 		return ret;
1112 	}
1113 
1114 	ret = smsc95xx_start_rx_path(dev);
1115 	if (ret < 0) {
1116 		netdev_warn(dev->net, "Failed to start RX path\n");
1117 		return ret;
1118 	}
1119 
1120 	netif_dbg(dev, ifup, dev->net, "smsc95xx_reset, return 0\n");
1121 	return 0;
1122 }
1123 
1124 static const struct net_device_ops smsc95xx_netdev_ops = {
1125 	.ndo_open		= usbnet_open,
1126 	.ndo_stop		= usbnet_stop,
1127 	.ndo_start_xmit		= usbnet_start_xmit,
1128 	.ndo_tx_timeout		= usbnet_tx_timeout,
1129 	.ndo_change_mtu		= usbnet_change_mtu,
1130 	.ndo_get_stats64	= dev_get_tstats64,
1131 	.ndo_set_mac_address 	= eth_mac_addr,
1132 	.ndo_validate_addr	= eth_validate_addr,
1133 	.ndo_eth_ioctl		= phy_do_ioctl_running,
1134 	.ndo_set_rx_mode	= smsc95xx_set_multicast,
1135 	.ndo_set_features	= smsc95xx_set_features,
1136 };
1137 
smsc95xx_handle_link_change(struct net_device * net)1138 static void smsc95xx_handle_link_change(struct net_device *net)
1139 {
1140 	struct usbnet *dev = netdev_priv(net);
1141 
1142 	phy_print_status(net->phydev);
1143 	smsc95xx_mac_update_fullduplex(dev);
1144 	usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
1145 }
1146 
smsc95xx_bind(struct usbnet * dev,struct usb_interface * intf)1147 static int smsc95xx_bind(struct usbnet *dev, struct usb_interface *intf)
1148 {
1149 	struct smsc95xx_priv *pdata;
1150 	char usb_path[64];
1151 	int ret, phy_irq;
1152 	u32 val;
1153 
1154 	ret = usbnet_get_endpoints(dev, intf);
1155 	if (ret < 0) {
1156 		netdev_warn(dev->net, "usbnet_get_endpoints failed: %d\n", ret);
1157 		return ret;
1158 	}
1159 
1160 	pdata = kzalloc_obj(*pdata);
1161 	if (!pdata)
1162 		return -ENOMEM;
1163 
1164 	dev->driver_priv = pdata;
1165 
1166 	spin_lock_init(&pdata->mac_cr_lock);
1167 
1168 	/* LAN95xx devices do not alter the computed checksum of 0 to 0xffff.
1169 	 * RFC 2460, ipv6 UDP calculated checksum yields a result of zero must
1170 	 * be changed to 0xffff. RFC 768, ipv4 UDP computed checksum is zero,
1171 	 * it is transmitted as all ones. The zero transmitted checksum means
1172 	 * transmitter generated no checksum. Hence, enable csum offload only
1173 	 * for ipv4 packets.
1174 	 */
1175 	if (DEFAULT_TX_CSUM_ENABLE)
1176 		dev->net->features |= NETIF_F_IP_CSUM;
1177 	if (DEFAULT_RX_CSUM_ENABLE)
1178 		dev->net->features |= NETIF_F_RXCSUM;
1179 
1180 	dev->net->hw_features = NETIF_F_IP_CSUM | NETIF_F_RXCSUM;
1181 	set_bit(EVENT_NO_IP_ALIGN, &dev->flags);
1182 
1183 	smsc95xx_init_mac_address(dev);
1184 
1185 	/* Init all registers */
1186 	ret = smsc95xx_reset(dev);
1187 	if (ret)
1188 		goto free_pdata;
1189 
1190 	/* create irq domain for use by PHY driver and GPIO consumers */
1191 	usb_make_path(dev->udev, usb_path, sizeof(usb_path));
1192 	pdata->irqfwnode = irq_domain_alloc_named_fwnode(usb_path);
1193 	if (!pdata->irqfwnode) {
1194 		ret = -ENOMEM;
1195 		goto free_pdata;
1196 	}
1197 
1198 	pdata->irqdomain = irq_domain_create_linear(pdata->irqfwnode,
1199 						    SMSC95XX_NR_IRQS,
1200 						    &irq_domain_simple_ops,
1201 						    pdata);
1202 	if (!pdata->irqdomain) {
1203 		ret = -ENOMEM;
1204 		goto free_irqfwnode;
1205 	}
1206 
1207 	phy_irq = irq_create_mapping(pdata->irqdomain, PHY_HWIRQ);
1208 	if (!phy_irq) {
1209 		ret = -ENOENT;
1210 		goto remove_irqdomain;
1211 	}
1212 
1213 	pdata->irqchip = dummy_irq_chip;
1214 	pdata->irqchip.name = SMSC_CHIPNAME;
1215 	irq_set_chip_and_handler_name(phy_irq, &pdata->irqchip,
1216 				      handle_simple_irq, "phy");
1217 
1218 	pdata->mdiobus = mdiobus_alloc();
1219 	if (!pdata->mdiobus) {
1220 		ret = -ENOMEM;
1221 		goto dispose_irq;
1222 	}
1223 
1224 	ret = smsc95xx_read_reg(dev, HW_CFG, &val);
1225 	if (ret < 0)
1226 		goto free_mdio;
1227 
1228 	pdata->is_internal_phy = !(val & HW_CFG_PSEL_);
1229 	if (pdata->is_internal_phy)
1230 		pdata->mdiobus->phy_mask = ~(1u << SMSC95XX_INTERNAL_PHY_ID);
1231 
1232 	pdata->mdiobus->priv = dev;
1233 	pdata->mdiobus->read = smsc95xx_mdiobus_read;
1234 	pdata->mdiobus->write = smsc95xx_mdiobus_write;
1235 	pdata->mdiobus->reset = smsc95xx_mdiobus_reset;
1236 	pdata->mdiobus->name = "smsc95xx-mdiobus";
1237 	pdata->mdiobus->parent = &dev->udev->dev;
1238 
1239 	snprintf(pdata->mdiobus->id, ARRAY_SIZE(pdata->mdiobus->id),
1240 		 "usb-%03d:%03d", dev->udev->bus->busnum, dev->udev->devnum);
1241 
1242 	ret = mdiobus_register(pdata->mdiobus);
1243 	if (ret) {
1244 		netdev_err(dev->net, "Could not register MDIO bus\n");
1245 		goto free_mdio;
1246 	}
1247 
1248 	pdata->phydev = phy_find_first(pdata->mdiobus);
1249 	if (!pdata->phydev) {
1250 		netdev_err(dev->net, "no PHY found\n");
1251 		ret = -ENODEV;
1252 		goto unregister_mdio;
1253 	}
1254 
1255 	pdata->phydev->irq = phy_irq;
1256 	pdata->phydev->is_internal = pdata->is_internal_phy;
1257 
1258 	/* detect device revision as different features may be available */
1259 	ret = smsc95xx_read_reg(dev, ID_REV, &val);
1260 	if (ret < 0)
1261 		goto unregister_mdio;
1262 
1263 	val >>= 16;
1264 	if ((val == ID_REV_CHIP_ID_9500A_) || (val == ID_REV_CHIP_ID_9530_) ||
1265 	    (val == ID_REV_CHIP_ID_89530_) || (val == ID_REV_CHIP_ID_9730_))
1266 		pdata->features = (FEATURE_8_WAKEUP_FILTERS |
1267 			FEATURE_PHY_NLP_CROSSOVER |
1268 			FEATURE_REMOTE_WAKEUP);
1269 	else if (val == ID_REV_CHIP_ID_9512_)
1270 		pdata->features = FEATURE_8_WAKEUP_FILTERS;
1271 
1272 	dev->net->netdev_ops = &smsc95xx_netdev_ops;
1273 	dev->net->ethtool_ops = &smsc95xx_ethtool_ops;
1274 	dev->net->flags |= IFF_MULTICAST;
1275 	dev->net->hard_header_len += SMSC95XX_TX_OVERHEAD_CSUM;
1276 	dev->net->min_mtu = ETH_MIN_MTU;
1277 	dev->net->max_mtu = ETH_DATA_LEN;
1278 	dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
1279 
1280 	pdata->pause_tx = true;
1281 	pdata->pause_rx = true;
1282 	pdata->pause_autoneg = true;
1283 	phy_support_asym_pause(pdata->phydev);
1284 
1285 	ret = phy_connect_direct(dev->net, pdata->phydev,
1286 				 &smsc95xx_handle_link_change,
1287 				 PHY_INTERFACE_MODE_MII);
1288 	if (ret) {
1289 		netdev_err(dev->net, "can't attach PHY to %s\n", pdata->mdiobus->id);
1290 		goto unregister_mdio;
1291 	}
1292 
1293 	phy_attached_info(dev->net->phydev);
1294 
1295 	return 0;
1296 
1297 unregister_mdio:
1298 	mdiobus_unregister(pdata->mdiobus);
1299 
1300 free_mdio:
1301 	mdiobus_free(pdata->mdiobus);
1302 
1303 dispose_irq:
1304 	irq_dispose_mapping(phy_irq);
1305 
1306 remove_irqdomain:
1307 	irq_domain_remove(pdata->irqdomain);
1308 
1309 free_irqfwnode:
1310 	irq_domain_free_fwnode(pdata->irqfwnode);
1311 
1312 free_pdata:
1313 	kfree(pdata);
1314 	return ret;
1315 }
1316 
smsc95xx_unbind(struct usbnet * dev,struct usb_interface * intf)1317 static void smsc95xx_unbind(struct usbnet *dev, struct usb_interface *intf)
1318 {
1319 	struct smsc95xx_priv *pdata = dev->driver_priv;
1320 
1321 	phy_disconnect(dev->net->phydev);
1322 	mdiobus_unregister(pdata->mdiobus);
1323 	mdiobus_free(pdata->mdiobus);
1324 	irq_dispose_mapping(irq_find_mapping(pdata->irqdomain, PHY_HWIRQ));
1325 	irq_domain_remove(pdata->irqdomain);
1326 	irq_domain_free_fwnode(pdata->irqfwnode);
1327 	netif_dbg(dev, ifdown, dev->net, "free pdata\n");
1328 	kfree(pdata);
1329 }
1330 
smsc95xx_start_phy(struct usbnet * dev)1331 static int smsc95xx_start_phy(struct usbnet *dev)
1332 {
1333 	phy_start(dev->net->phydev);
1334 
1335 	return 0;
1336 }
1337 
smsc95xx_stop(struct usbnet * dev)1338 static int smsc95xx_stop(struct usbnet *dev)
1339 {
1340 	phy_stop(dev->net->phydev);
1341 
1342 	return 0;
1343 }
1344 
smsc_crc(const u8 * buffer,size_t len,int filter)1345 static u32 smsc_crc(const u8 *buffer, size_t len, int filter)
1346 {
1347 	u32 crc = bitrev16(crc16(0xFFFF, buffer, len));
1348 	return crc << ((filter % 2) * 16);
1349 }
1350 
smsc95xx_link_ok(struct usbnet * dev)1351 static int smsc95xx_link_ok(struct usbnet *dev)
1352 {
1353 	struct smsc95xx_priv *pdata = dev->driver_priv;
1354 	int ret;
1355 
1356 	/* first, a dummy read, needed to latch some MII phys */
1357 	ret = smsc95xx_mdio_read(dev, pdata->phydev->mdio.addr, MII_BMSR);
1358 	if (ret < 0)
1359 		return ret;
1360 
1361 	ret = smsc95xx_mdio_read(dev, pdata->phydev->mdio.addr, MII_BMSR);
1362 	if (ret < 0)
1363 		return ret;
1364 
1365 	return !!(ret & BMSR_LSTATUS);
1366 }
1367 
smsc95xx_enter_suspend0(struct usbnet * dev)1368 static int smsc95xx_enter_suspend0(struct usbnet *dev)
1369 {
1370 	struct smsc95xx_priv *pdata = dev->driver_priv;
1371 	u32 val;
1372 	int ret;
1373 
1374 	ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1375 	if (ret < 0)
1376 		return ret;
1377 
1378 	val &= (~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_));
1379 	val |= PM_CTL_SUS_MODE_0;
1380 
1381 	ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1382 	if (ret < 0)
1383 		return ret;
1384 
1385 	/* clear wol status */
1386 	val &= ~PM_CTL_WUPS_;
1387 	val |= PM_CTL_WUPS_WOL_;
1388 
1389 	/* enable energy detection */
1390 	if (pdata->wolopts & WAKE_PHY)
1391 		val |= PM_CTL_WUPS_ED_;
1392 
1393 	ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1394 	if (ret < 0)
1395 		return ret;
1396 
1397 	/* read back PM_CTRL */
1398 	ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1399 	if (ret < 0)
1400 		return ret;
1401 
1402 	pdata->suspend_flags |= SUSPEND_SUSPEND0;
1403 
1404 	return 0;
1405 }
1406 
smsc95xx_enter_suspend1(struct usbnet * dev)1407 static int smsc95xx_enter_suspend1(struct usbnet *dev)
1408 {
1409 	struct smsc95xx_priv *pdata = dev->driver_priv;
1410 	int ret, phy_id = pdata->phydev->mdio.addr;
1411 	u32 val;
1412 
1413 	/* reconfigure link pulse detection timing for
1414 	 * compatibility with non-standard link partners
1415 	 */
1416 	if (pdata->features & FEATURE_PHY_NLP_CROSSOVER)
1417 		smsc95xx_mdio_write(dev, phy_id, PHY_EDPD_CONFIG,
1418 				    PHY_EDPD_CONFIG_DEFAULT);
1419 
1420 	/* enable energy detect power-down mode */
1421 	ret = smsc95xx_mdio_read(dev, phy_id, PHY_MODE_CTRL_STS);
1422 	if (ret < 0)
1423 		return ret;
1424 
1425 	ret |= MODE_CTRL_STS_EDPWRDOWN_;
1426 
1427 	smsc95xx_mdio_write(dev, phy_id, PHY_MODE_CTRL_STS, ret);
1428 
1429 	/* enter SUSPEND1 mode */
1430 	ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1431 	if (ret < 0)
1432 		return ret;
1433 
1434 	val &= ~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_);
1435 	val |= PM_CTL_SUS_MODE_1;
1436 
1437 	ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1438 	if (ret < 0)
1439 		return ret;
1440 
1441 	/* clear wol status, enable energy detection */
1442 	val &= ~PM_CTL_WUPS_;
1443 	val |= (PM_CTL_WUPS_ED_ | PM_CTL_ED_EN_);
1444 
1445 	ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1446 	if (ret < 0)
1447 		return ret;
1448 
1449 	pdata->suspend_flags |= SUSPEND_SUSPEND1;
1450 
1451 	return 0;
1452 }
1453 
smsc95xx_enter_suspend2(struct usbnet * dev)1454 static int smsc95xx_enter_suspend2(struct usbnet *dev)
1455 {
1456 	struct smsc95xx_priv *pdata = dev->driver_priv;
1457 	u32 val;
1458 	int ret;
1459 
1460 	ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1461 	if (ret < 0)
1462 		return ret;
1463 
1464 	val &= ~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_);
1465 	val |= PM_CTL_SUS_MODE_2;
1466 
1467 	ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1468 	if (ret < 0)
1469 		return ret;
1470 
1471 	pdata->suspend_flags |= SUSPEND_SUSPEND2;
1472 
1473 	return 0;
1474 }
1475 
smsc95xx_enter_suspend3(struct usbnet * dev)1476 static int smsc95xx_enter_suspend3(struct usbnet *dev)
1477 {
1478 	struct smsc95xx_priv *pdata = dev->driver_priv;
1479 	u32 val;
1480 	int ret;
1481 
1482 	ret = smsc95xx_read_reg(dev, RX_FIFO_INF, &val);
1483 	if (ret < 0)
1484 		return ret;
1485 
1486 	if (val & RX_FIFO_INF_USED_) {
1487 		netdev_info(dev->net, "rx fifo not empty in autosuspend\n");
1488 		return -EBUSY;
1489 	}
1490 
1491 	ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1492 	if (ret < 0)
1493 		return ret;
1494 
1495 	val &= ~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_);
1496 	val |= PM_CTL_SUS_MODE_3 | PM_CTL_RES_CLR_WKP_STS;
1497 
1498 	ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1499 	if (ret < 0)
1500 		return ret;
1501 
1502 	/* clear wol status */
1503 	val &= ~PM_CTL_WUPS_;
1504 	val |= PM_CTL_WUPS_WOL_;
1505 
1506 	ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1507 	if (ret < 0)
1508 		return ret;
1509 
1510 	pdata->suspend_flags |= SUSPEND_SUSPEND3;
1511 
1512 	return 0;
1513 }
1514 
smsc95xx_autosuspend(struct usbnet * dev,u32 link_up)1515 static int smsc95xx_autosuspend(struct usbnet *dev, u32 link_up)
1516 {
1517 	struct smsc95xx_priv *pdata = dev->driver_priv;
1518 
1519 	if (!netif_running(dev->net)) {
1520 		/* interface is ifconfig down so fully power down hw */
1521 		netdev_dbg(dev->net, "autosuspend entering SUSPEND2\n");
1522 		return smsc95xx_enter_suspend2(dev);
1523 	}
1524 
1525 	if (!link_up) {
1526 		/* link is down so enter EDPD mode, but only if device can
1527 		 * reliably resume from it.  This check should be redundant
1528 		 * as current FEATURE_REMOTE_WAKEUP parts also support
1529 		 * FEATURE_PHY_NLP_CROSSOVER but it's included for clarity */
1530 		if (!(pdata->features & FEATURE_PHY_NLP_CROSSOVER)) {
1531 			netdev_warn(dev->net, "EDPD not supported\n");
1532 			return -EBUSY;
1533 		}
1534 
1535 		netdev_dbg(dev->net, "autosuspend entering SUSPEND1\n");
1536 		netdev_info(dev->net, "entering SUSPEND1 mode\n");
1537 		return smsc95xx_enter_suspend1(dev);
1538 	}
1539 
1540 	netdev_dbg(dev->net, "autosuspend entering SUSPEND3\n");
1541 	return smsc95xx_enter_suspend3(dev);
1542 }
1543 
smsc95xx_suspend(struct usb_interface * intf,pm_message_t message)1544 static int smsc95xx_suspend(struct usb_interface *intf, pm_message_t message)
1545 {
1546 	struct usbnet *dev = usb_get_intfdata(intf);
1547 	struct smsc95xx_priv *pdata = dev->driver_priv;
1548 	u32 val, link_up;
1549 	int ret;
1550 
1551 	pdata->pm_task = current;
1552 
1553 	ret = usbnet_suspend(intf, message);
1554 	if (ret < 0) {
1555 		netdev_warn(dev->net, "usbnet_suspend error\n");
1556 		pdata->pm_task = NULL;
1557 		return ret;
1558 	}
1559 
1560 	if (pdata->suspend_flags) {
1561 		netdev_warn(dev->net, "error during last resume\n");
1562 		pdata->suspend_flags = 0;
1563 	}
1564 
1565 	link_up = smsc95xx_link_ok(dev);
1566 
1567 	if (message.event == PM_EVENT_AUTO_SUSPEND &&
1568 	    (pdata->features & FEATURE_REMOTE_WAKEUP)) {
1569 		ret = smsc95xx_autosuspend(dev, link_up);
1570 		goto done;
1571 	}
1572 
1573 	/* if we get this far we're not autosuspending */
1574 	/* if no wol options set, or if link is down and we're not waking on
1575 	 * PHY activity, enter lowest power SUSPEND2 mode
1576 	 */
1577 	if (!(pdata->wolopts & SUPPORTED_WAKE) ||
1578 		!(link_up || (pdata->wolopts & WAKE_PHY))) {
1579 		netdev_info(dev->net, "entering SUSPEND2 mode\n");
1580 
1581 		/* disable energy detect (link up) & wake up events */
1582 		ret = smsc95xx_read_reg(dev, WUCSR, &val);
1583 		if (ret < 0)
1584 			goto done;
1585 
1586 		val &= ~(WUCSR_MPEN_ | WUCSR_WAKE_EN_);
1587 
1588 		ret = smsc95xx_write_reg(dev, WUCSR, val);
1589 		if (ret < 0)
1590 			goto done;
1591 
1592 		ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1593 		if (ret < 0)
1594 			goto done;
1595 
1596 		val &= ~(PM_CTL_ED_EN_ | PM_CTL_WOL_EN_);
1597 
1598 		ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1599 		if (ret < 0)
1600 			goto done;
1601 
1602 		ret = smsc95xx_enter_suspend2(dev);
1603 		goto done;
1604 	}
1605 
1606 	if (pdata->wolopts & WAKE_PHY) {
1607 		/* if link is down then configure EDPD and enter SUSPEND1,
1608 		 * otherwise enter SUSPEND0 below
1609 		 */
1610 		if (!link_up) {
1611 			netdev_info(dev->net, "entering SUSPEND1 mode\n");
1612 			ret = smsc95xx_enter_suspend1(dev);
1613 			goto done;
1614 		}
1615 	}
1616 
1617 	if (pdata->wolopts & (WAKE_BCAST | WAKE_MCAST | WAKE_ARP | WAKE_UCAST)) {
1618 		u32 *filter_mask = kcalloc(32, sizeof(u32), GFP_KERNEL);
1619 		u32 command[2];
1620 		u32 offset[2];
1621 		u32 crc[4];
1622 		int wuff_filter_count =
1623 			(pdata->features & FEATURE_8_WAKEUP_FILTERS) ?
1624 			LAN9500A_WUFF_NUM : LAN9500_WUFF_NUM;
1625 		int i, filter = 0;
1626 
1627 		if (!filter_mask) {
1628 			netdev_warn(dev->net, "Unable to allocate filter_mask\n");
1629 			ret = -ENOMEM;
1630 			goto done;
1631 		}
1632 
1633 		memset(command, 0, sizeof(command));
1634 		memset(offset, 0, sizeof(offset));
1635 		memset(crc, 0, sizeof(crc));
1636 
1637 		if (pdata->wolopts & WAKE_BCAST) {
1638 			const u8 bcast[] = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
1639 			netdev_info(dev->net, "enabling broadcast detection\n");
1640 			filter_mask[filter * 4] = 0x003F;
1641 			filter_mask[filter * 4 + 1] = 0x00;
1642 			filter_mask[filter * 4 + 2] = 0x00;
1643 			filter_mask[filter * 4 + 3] = 0x00;
1644 			command[filter/4] |= 0x05UL << ((filter % 4) * 8);
1645 			offset[filter/4] |= 0x00 << ((filter % 4) * 8);
1646 			crc[filter/2] |= smsc_crc(bcast, 6, filter);
1647 			filter++;
1648 		}
1649 
1650 		if (pdata->wolopts & WAKE_MCAST) {
1651 			const u8 mcast[] = {0x01, 0x00, 0x5E};
1652 			netdev_info(dev->net, "enabling multicast detection\n");
1653 			filter_mask[filter * 4] = 0x0007;
1654 			filter_mask[filter * 4 + 1] = 0x00;
1655 			filter_mask[filter * 4 + 2] = 0x00;
1656 			filter_mask[filter * 4 + 3] = 0x00;
1657 			command[filter/4] |= 0x09UL << ((filter % 4) * 8);
1658 			offset[filter/4] |= 0x00  << ((filter % 4) * 8);
1659 			crc[filter/2] |= smsc_crc(mcast, 3, filter);
1660 			filter++;
1661 		}
1662 
1663 		if (pdata->wolopts & WAKE_ARP) {
1664 			const u8 arp[] = {0x08, 0x06};
1665 			netdev_info(dev->net, "enabling ARP detection\n");
1666 			filter_mask[filter * 4] = 0x0003;
1667 			filter_mask[filter * 4 + 1] = 0x00;
1668 			filter_mask[filter * 4 + 2] = 0x00;
1669 			filter_mask[filter * 4 + 3] = 0x00;
1670 			command[filter/4] |= 0x05UL << ((filter % 4) * 8);
1671 			offset[filter/4] |= 0x0C << ((filter % 4) * 8);
1672 			crc[filter/2] |= smsc_crc(arp, 2, filter);
1673 			filter++;
1674 		}
1675 
1676 		if (pdata->wolopts & WAKE_UCAST) {
1677 			netdev_info(dev->net, "enabling unicast detection\n");
1678 			filter_mask[filter * 4] = 0x003F;
1679 			filter_mask[filter * 4 + 1] = 0x00;
1680 			filter_mask[filter * 4 + 2] = 0x00;
1681 			filter_mask[filter * 4 + 3] = 0x00;
1682 			command[filter/4] |= 0x01UL << ((filter % 4) * 8);
1683 			offset[filter/4] |= 0x00 << ((filter % 4) * 8);
1684 			crc[filter/2] |= smsc_crc(dev->net->dev_addr, ETH_ALEN, filter);
1685 			filter++;
1686 		}
1687 
1688 		for (i = 0; i < (wuff_filter_count * 4); i++) {
1689 			ret = smsc95xx_write_reg(dev, WUFF, filter_mask[i]);
1690 			if (ret < 0) {
1691 				kfree(filter_mask);
1692 				goto done;
1693 			}
1694 		}
1695 		kfree(filter_mask);
1696 
1697 		for (i = 0; i < (wuff_filter_count / 4); i++) {
1698 			ret = smsc95xx_write_reg(dev, WUFF, command[i]);
1699 			if (ret < 0)
1700 				goto done;
1701 		}
1702 
1703 		for (i = 0; i < (wuff_filter_count / 4); i++) {
1704 			ret = smsc95xx_write_reg(dev, WUFF, offset[i]);
1705 			if (ret < 0)
1706 				goto done;
1707 		}
1708 
1709 		for (i = 0; i < (wuff_filter_count / 2); i++) {
1710 			ret = smsc95xx_write_reg(dev, WUFF, crc[i]);
1711 			if (ret < 0)
1712 				goto done;
1713 		}
1714 
1715 		/* clear any pending pattern match packet status */
1716 		ret = smsc95xx_read_reg(dev, WUCSR, &val);
1717 		if (ret < 0)
1718 			goto done;
1719 
1720 		val |= WUCSR_WUFR_;
1721 
1722 		ret = smsc95xx_write_reg(dev, WUCSR, val);
1723 		if (ret < 0)
1724 			goto done;
1725 	}
1726 
1727 	if (pdata->wolopts & WAKE_MAGIC) {
1728 		/* clear any pending magic packet status */
1729 		ret = smsc95xx_read_reg(dev, WUCSR, &val);
1730 		if (ret < 0)
1731 			goto done;
1732 
1733 		val |= WUCSR_MPR_;
1734 
1735 		ret = smsc95xx_write_reg(dev, WUCSR, val);
1736 		if (ret < 0)
1737 			goto done;
1738 	}
1739 
1740 	/* enable/disable wakeup sources */
1741 	ret = smsc95xx_read_reg(dev, WUCSR, &val);
1742 	if (ret < 0)
1743 		goto done;
1744 
1745 	if (pdata->wolopts & (WAKE_BCAST | WAKE_MCAST | WAKE_ARP | WAKE_UCAST)) {
1746 		netdev_info(dev->net, "enabling pattern match wakeup\n");
1747 		val |= WUCSR_WAKE_EN_;
1748 	} else {
1749 		netdev_info(dev->net, "disabling pattern match wakeup\n");
1750 		val &= ~WUCSR_WAKE_EN_;
1751 	}
1752 
1753 	if (pdata->wolopts & WAKE_MAGIC) {
1754 		netdev_info(dev->net, "enabling magic packet wakeup\n");
1755 		val |= WUCSR_MPEN_;
1756 	} else {
1757 		netdev_info(dev->net, "disabling magic packet wakeup\n");
1758 		val &= ~WUCSR_MPEN_;
1759 	}
1760 
1761 	ret = smsc95xx_write_reg(dev, WUCSR, val);
1762 	if (ret < 0)
1763 		goto done;
1764 
1765 	/* enable wol wakeup source */
1766 	ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1767 	if (ret < 0)
1768 		goto done;
1769 
1770 	val |= PM_CTL_WOL_EN_;
1771 
1772 	/* phy energy detect wakeup source */
1773 	if (pdata->wolopts & WAKE_PHY)
1774 		val |= PM_CTL_ED_EN_;
1775 
1776 	ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1777 	if (ret < 0)
1778 		goto done;
1779 
1780 	/* enable receiver to enable frame reception */
1781 	smsc95xx_start_rx_path(dev);
1782 
1783 	/* some wol options are enabled, so enter SUSPEND0 */
1784 	netdev_info(dev->net, "entering SUSPEND0 mode\n");
1785 	ret = smsc95xx_enter_suspend0(dev);
1786 
1787 done:
1788 	/*
1789 	 * TODO: resume() might need to handle the suspend failure
1790 	 * in system sleep
1791 	 */
1792 	if (ret && PMSG_IS_AUTO(message))
1793 		usbnet_resume(intf);
1794 
1795 	pdata->pm_task = NULL;
1796 	return ret;
1797 }
1798 
smsc95xx_resume(struct usb_interface * intf)1799 static int smsc95xx_resume(struct usb_interface *intf)
1800 {
1801 	struct usbnet *dev = usb_get_intfdata(intf);
1802 	struct smsc95xx_priv *pdata;
1803 	u8 suspend_flags;
1804 	int ret;
1805 	u32 val;
1806 
1807 	BUG_ON(!dev);
1808 	pdata = dev->driver_priv;
1809 	suspend_flags = pdata->suspend_flags;
1810 
1811 	netdev_dbg(dev->net, "resume suspend_flags=0x%02x\n", suspend_flags);
1812 
1813 	/* do this first to ensure it's cleared even in error case */
1814 	pdata->suspend_flags = 0;
1815 
1816 	pdata->pm_task = current;
1817 
1818 	if (suspend_flags & SUSPEND_ALLMODES) {
1819 		/* clear wake-up sources */
1820 		ret = smsc95xx_read_reg(dev, WUCSR, &val);
1821 		if (ret < 0)
1822 			goto done;
1823 
1824 		val &= ~(WUCSR_WAKE_EN_ | WUCSR_MPEN_);
1825 
1826 		ret = smsc95xx_write_reg(dev, WUCSR, val);
1827 		if (ret < 0)
1828 			goto done;
1829 
1830 		/* clear wake-up status */
1831 		ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1832 		if (ret < 0)
1833 			goto done;
1834 
1835 		val &= ~PM_CTL_WOL_EN_;
1836 		val |= PM_CTL_WUPS_;
1837 
1838 		ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1839 		if (ret < 0)
1840 			goto done;
1841 	}
1842 
1843 	phy_init_hw(pdata->phydev);
1844 
1845 	ret = usbnet_resume(intf);
1846 	if (ret < 0)
1847 		netdev_warn(dev->net, "usbnet_resume error\n");
1848 
1849 done:
1850 	pdata->pm_task = NULL;
1851 	return ret;
1852 }
1853 
smsc95xx_reset_resume(struct usb_interface * intf)1854 static int smsc95xx_reset_resume(struct usb_interface *intf)
1855 {
1856 	struct usbnet *dev = usb_get_intfdata(intf);
1857 	struct smsc95xx_priv *pdata = dev->driver_priv;
1858 	int ret;
1859 
1860 	pdata->pm_task = current;
1861 	ret = smsc95xx_reset(dev);
1862 	pdata->pm_task = NULL;
1863 	if (ret < 0)
1864 		return ret;
1865 
1866 	return smsc95xx_resume(intf);
1867 }
1868 
smsc95xx_rx_csum_offload(struct sk_buff * skb)1869 static void smsc95xx_rx_csum_offload(struct sk_buff *skb)
1870 {
1871 	u16 *csum_ptr = (u16 *)(skb_tail_pointer(skb) - 2);
1872 
1873 	skb->csum = (__force __wsum)get_unaligned(csum_ptr);
1874 	skb->ip_summed = CHECKSUM_COMPLETE;
1875 	skb_trim(skb, skb->len - 2); /* remove csum */
1876 }
1877 
smsc95xx_rx_fixup(struct usbnet * dev,struct sk_buff * skb)1878 static int smsc95xx_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
1879 {
1880 	/* This check is no longer done by usbnet */
1881 	if (skb->len < dev->net->hard_header_len)
1882 		return 0;
1883 
1884 	while (skb->len > 0) {
1885 		u32 header, align_count;
1886 		struct sk_buff *ax_skb;
1887 		unsigned char *packet;
1888 		u16 size;
1889 
1890 		header = get_unaligned_le32(skb->data);
1891 		skb_pull(skb, 4 + NET_IP_ALIGN);
1892 		packet = skb->data;
1893 
1894 		/* get the packet length */
1895 		size = (u16)((header & RX_STS_FL_) >> 16);
1896 		align_count = (4 - ((size + NET_IP_ALIGN) % 4)) % 4;
1897 
1898 		if (unlikely(size > skb->len)) {
1899 			netif_dbg(dev, rx_err, dev->net,
1900 				  "size err header=0x%08x\n", header);
1901 			return 0;
1902 		}
1903 
1904 		if (unlikely(header & RX_STS_ES_)) {
1905 			netif_dbg(dev, rx_err, dev->net,
1906 				  "Error header=0x%08x\n", header);
1907 			dev->net->stats.rx_errors++;
1908 			dev->net->stats.rx_dropped++;
1909 
1910 			if (header & RX_STS_CRC_) {
1911 				dev->net->stats.rx_crc_errors++;
1912 			} else {
1913 				if (header & (RX_STS_TL_ | RX_STS_RF_))
1914 					dev->net->stats.rx_frame_errors++;
1915 
1916 				if ((header & RX_STS_LE_) &&
1917 					(!(header & RX_STS_FT_)))
1918 					dev->net->stats.rx_length_errors++;
1919 			}
1920 		} else {
1921 			/* ETH_FRAME_LEN + 4(CRC) + 2(COE) + 4(Vlan) */
1922 			if (unlikely(size > (ETH_FRAME_LEN + 12))) {
1923 				netif_dbg(dev, rx_err, dev->net,
1924 					  "size err header=0x%08x\n", header);
1925 				return 0;
1926 			}
1927 
1928 			/* last frame in this batch */
1929 			if (skb->len == size) {
1930 				if (dev->net->features & NETIF_F_RXCSUM)
1931 					smsc95xx_rx_csum_offload(skb);
1932 				skb_trim(skb, skb->len - 4); /* remove fcs */
1933 
1934 				return 1;
1935 			}
1936 
1937 			ax_skb = netdev_alloc_skb_ip_align(dev->net, size);
1938 			if (unlikely(!ax_skb)) {
1939 				netdev_warn(dev->net, "Error allocating skb\n");
1940 				return 0;
1941 			}
1942 
1943 			skb_put(ax_skb, size);
1944 			memcpy(ax_skb->data, packet, size);
1945 
1946 			if (dev->net->features & NETIF_F_RXCSUM)
1947 				smsc95xx_rx_csum_offload(ax_skb);
1948 			skb_trim(ax_skb, ax_skb->len - 4); /* remove fcs */
1949 
1950 			usbnet_skb_return(dev, ax_skb);
1951 		}
1952 
1953 		skb_pull(skb, size);
1954 
1955 		/* padding bytes before the next frame starts */
1956 		if (skb->len)
1957 			skb_pull(skb, align_count);
1958 	}
1959 
1960 	return 1;
1961 }
1962 
smsc95xx_calc_csum_preamble(struct sk_buff * skb)1963 static u32 smsc95xx_calc_csum_preamble(struct sk_buff *skb)
1964 {
1965 	u16 low_16 = (u16)skb_checksum_start_offset(skb);
1966 	u16 high_16 = low_16 + skb->csum_offset;
1967 	return (high_16 << 16) | low_16;
1968 }
1969 
1970 /* The TX CSUM won't work if the checksum lies in the last 4 bytes of the
1971  * transmission. This is fairly unlikely, only seems to trigger with some
1972  * short TCP ACK packets sent.
1973  *
1974  * Note, this calculation should probably check for the alignment of the
1975  * data as well, but a straight check for csum being in the last four bytes
1976  * of the packet should be ok for now.
1977  */
smsc95xx_can_tx_checksum(struct sk_buff * skb)1978 static bool smsc95xx_can_tx_checksum(struct sk_buff *skb)
1979 {
1980        unsigned int len = skb->len - skb_checksum_start_offset(skb);
1981 
1982        if (skb->len <= 45)
1983 	       return false;
1984        return skb->csum_offset < (len - (4 + 1));
1985 }
1986 
smsc95xx_tx_fixup(struct usbnet * dev,struct sk_buff * skb,gfp_t flags)1987 static struct sk_buff *smsc95xx_tx_fixup(struct usbnet *dev,
1988 					 struct sk_buff *skb, gfp_t flags)
1989 {
1990 	bool csum = skb->ip_summed == CHECKSUM_PARTIAL;
1991 	int overhead = csum ? SMSC95XX_TX_OVERHEAD_CSUM : SMSC95XX_TX_OVERHEAD;
1992 	u32 tx_cmd_a, tx_cmd_b;
1993 	void *ptr;
1994 
1995 	/* We do not advertise SG, so skbs should be already linearized */
1996 	BUG_ON(skb_shinfo(skb)->nr_frags);
1997 
1998 	/* Make writable and expand header space by overhead if required */
1999 	if (skb_cow_head(skb, overhead)) {
2000 		/* Must deallocate here as returning NULL to indicate error
2001 		 * means the skb won't be deallocated in the caller.
2002 		 */
2003 		dev_kfree_skb_any(skb);
2004 		return NULL;
2005 	}
2006 
2007 	tx_cmd_b = (u32)skb->len;
2008 	tx_cmd_a = tx_cmd_b | TX_CMD_A_FIRST_SEG_ | TX_CMD_A_LAST_SEG_;
2009 
2010 	if (csum) {
2011 		if (!smsc95xx_can_tx_checksum(skb)) {
2012 			/* workaround - hardware tx checksum does not work
2013 			 * properly with extremely small packets */
2014 			long csstart = skb_checksum_start_offset(skb);
2015 			__wsum calc = csum_partial(skb->data + csstart,
2016 				skb->len - csstart, 0);
2017 			*((__sum16 *)(skb->data + csstart
2018 				+ skb->csum_offset)) = csum_fold(calc);
2019 
2020 			csum = false;
2021 		} else {
2022 			u32 csum_preamble = smsc95xx_calc_csum_preamble(skb);
2023 			ptr = skb_push(skb, 4);
2024 			put_unaligned_le32(csum_preamble, ptr);
2025 
2026 			tx_cmd_a += 4;
2027 			tx_cmd_b += 4;
2028 			tx_cmd_b |= TX_CMD_B_CSUM_ENABLE;
2029 		}
2030 	}
2031 
2032 	ptr = skb_push(skb, 8);
2033 	put_unaligned_le32(tx_cmd_a, ptr);
2034 	put_unaligned_le32(tx_cmd_b, ptr+4);
2035 
2036 	return skb;
2037 }
2038 
smsc95xx_manage_power(struct usbnet * dev,int on)2039 static int smsc95xx_manage_power(struct usbnet *dev, int on)
2040 {
2041 	struct smsc95xx_priv *pdata = dev->driver_priv;
2042 
2043 	dev->intf->needs_remote_wakeup = on;
2044 
2045 	if (pdata->features & FEATURE_REMOTE_WAKEUP)
2046 		return 0;
2047 
2048 	/* this chip revision isn't capable of remote wakeup */
2049 	netdev_info(dev->net, "hardware isn't capable of remote wakeup\n");
2050 
2051 	if (on)
2052 		usb_autopm_get_interface_no_resume(dev->intf);
2053 	else
2054 		usb_autopm_put_interface(dev->intf);
2055 
2056 	return 0;
2057 }
2058 
2059 static const struct driver_info smsc95xx_info = {
2060 	.description	= "smsc95xx USB 2.0 Ethernet",
2061 	.bind		= smsc95xx_bind,
2062 	.unbind		= smsc95xx_unbind,
2063 	.reset		= smsc95xx_reset,
2064 	.check_connect	= smsc95xx_start_phy,
2065 	.stop		= smsc95xx_stop,
2066 	.rx_fixup	= smsc95xx_rx_fixup,
2067 	.tx_fixup	= smsc95xx_tx_fixup,
2068 	.status		= smsc95xx_status,
2069 	.manage_power	= smsc95xx_manage_power,
2070 	.flags		= FLAG_ETHER | FLAG_SEND_ZLP | FLAG_LINK_INTR,
2071 };
2072 
2073 static const struct usb_device_id products[] = {
2074 	{
2075 		/* SMSC9500 USB Ethernet Device */
2076 		USB_DEVICE(0x0424, 0x9500),
2077 		.driver_info = (unsigned long) &smsc95xx_info,
2078 	},
2079 	{
2080 		/* SMSC9505 USB Ethernet Device */
2081 		USB_DEVICE(0x0424, 0x9505),
2082 		.driver_info = (unsigned long) &smsc95xx_info,
2083 	},
2084 	{
2085 		/* SMSC9500A USB Ethernet Device */
2086 		USB_DEVICE(0x0424, 0x9E00),
2087 		.driver_info = (unsigned long) &smsc95xx_info,
2088 	},
2089 	{
2090 		/* SMSC9505A USB Ethernet Device */
2091 		USB_DEVICE(0x0424, 0x9E01),
2092 		.driver_info = (unsigned long) &smsc95xx_info,
2093 	},
2094 	{
2095 		/* SMSC9512/9514 USB Hub & Ethernet Device */
2096 		USB_DEVICE(0x0424, 0xec00),
2097 		.driver_info = (unsigned long) &smsc95xx_info,
2098 	},
2099 	{
2100 		/* SMSC9500 USB Ethernet Device (SAL10) */
2101 		USB_DEVICE(0x0424, 0x9900),
2102 		.driver_info = (unsigned long) &smsc95xx_info,
2103 	},
2104 	{
2105 		/* SMSC9505 USB Ethernet Device (SAL10) */
2106 		USB_DEVICE(0x0424, 0x9901),
2107 		.driver_info = (unsigned long) &smsc95xx_info,
2108 	},
2109 	{
2110 		/* SMSC9500A USB Ethernet Device (SAL10) */
2111 		USB_DEVICE(0x0424, 0x9902),
2112 		.driver_info = (unsigned long) &smsc95xx_info,
2113 	},
2114 	{
2115 		/* SMSC9505A USB Ethernet Device (SAL10) */
2116 		USB_DEVICE(0x0424, 0x9903),
2117 		.driver_info = (unsigned long) &smsc95xx_info,
2118 	},
2119 	{
2120 		/* SMSC9512/9514 USB Hub & Ethernet Device (SAL10) */
2121 		USB_DEVICE(0x0424, 0x9904),
2122 		.driver_info = (unsigned long) &smsc95xx_info,
2123 	},
2124 	{
2125 		/* SMSC9500A USB Ethernet Device (HAL) */
2126 		USB_DEVICE(0x0424, 0x9905),
2127 		.driver_info = (unsigned long) &smsc95xx_info,
2128 	},
2129 	{
2130 		/* SMSC9505A USB Ethernet Device (HAL) */
2131 		USB_DEVICE(0x0424, 0x9906),
2132 		.driver_info = (unsigned long) &smsc95xx_info,
2133 	},
2134 	{
2135 		/* SMSC9500 USB Ethernet Device (Alternate ID) */
2136 		USB_DEVICE(0x0424, 0x9907),
2137 		.driver_info = (unsigned long) &smsc95xx_info,
2138 	},
2139 	{
2140 		/* SMSC9500A USB Ethernet Device (Alternate ID) */
2141 		USB_DEVICE(0x0424, 0x9908),
2142 		.driver_info = (unsigned long) &smsc95xx_info,
2143 	},
2144 	{
2145 		/* SMSC9512/9514 USB Hub & Ethernet Device (Alternate ID) */
2146 		USB_DEVICE(0x0424, 0x9909),
2147 		.driver_info = (unsigned long) &smsc95xx_info,
2148 	},
2149 	{
2150 		/* SMSC LAN9530 USB Ethernet Device */
2151 		USB_DEVICE(0x0424, 0x9530),
2152 		.driver_info = (unsigned long) &smsc95xx_info,
2153 	},
2154 	{
2155 		/* SMSC LAN9730 USB Ethernet Device */
2156 		USB_DEVICE(0x0424, 0x9730),
2157 		.driver_info = (unsigned long) &smsc95xx_info,
2158 	},
2159 	{
2160 		/* SMSC LAN89530 USB Ethernet Device */
2161 		USB_DEVICE(0x0424, 0x9E08),
2162 		.driver_info = (unsigned long) &smsc95xx_info,
2163 	},
2164 	{
2165 		/* SYSTEC USB-SPEmodule1 10BASE-T1L Ethernet Device */
2166 		USB_DEVICE(0x0878, 0x1400),
2167 		.driver_info = (unsigned long)&smsc95xx_info,
2168 	},
2169 	{
2170 		/* Microchip's EVB-LAN8670-USB 10BASE-T1S Ethernet Device */
2171 		USB_DEVICE(0x184F, 0x0051),
2172 		.driver_info = (unsigned long)&smsc95xx_info,
2173 	},
2174 	{ },		/* END */
2175 };
2176 MODULE_DEVICE_TABLE(usb, products);
2177 
2178 static struct usb_driver smsc95xx_driver = {
2179 	.name		= "smsc95xx",
2180 	.id_table	= products,
2181 	.probe		= usbnet_probe,
2182 	.suspend	= smsc95xx_suspend,
2183 	.resume		= smsc95xx_resume,
2184 	.reset_resume	= smsc95xx_reset_resume,
2185 	.disconnect	= usbnet_disconnect,
2186 	.disable_hub_initiated_lpm = 1,
2187 	.supports_autosuspend = 1,
2188 };
2189 
2190 module_usb_driver(smsc95xx_driver);
2191 
2192 MODULE_AUTHOR("Nancy Lin");
2193 MODULE_AUTHOR("Steve Glendinning <steve.glendinning@shawell.net>");
2194 MODULE_DESCRIPTION("SMSC95XX USB 2.0 Ethernet Devices");
2195 MODULE_LICENSE("GPL");
2196