xref: /freebsd/sys/dev/usb/net/if_smsc.c (revision 076ad2f836d5f49dc1375f1677335a48fe0d4b82)
1 /*-
2  * Copyright (c) 2012
3  *	Ben Gray <bgray@freebsd.org>.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 /*
31  * SMSC LAN9xxx devices (http://www.smsc.com/)
32  *
33  * The LAN9500 & LAN9500A devices are stand-alone USB to Ethernet chips that
34  * support USB 2.0 and 10/100 Mbps Ethernet.
35  *
36  * The LAN951x devices are an integrated USB hub and USB to Ethernet adapter.
37  * The driver only covers the Ethernet part, the standard USB hub driver
38  * supports the hub part.
39  *
40  * This driver is closely modelled on the Linux driver written and copyrighted
41  * by SMSC.
42  *
43  *
44  *
45  *
46  * H/W TCP & UDP Checksum Offloading
47  * ---------------------------------
48  * The chip supports both tx and rx offloading of UDP & TCP checksums, this
49  * feature can be dynamically enabled/disabled.
50  *
51  * RX checksuming is performed across bytes after the IPv4 header to the end of
52  * the Ethernet frame, this means if the frame is padded with non-zero values
53  * the H/W checksum will be incorrect, however the rx code compensates for this.
54  *
55  * TX checksuming is more complicated, the device requires a special header to
56  * be prefixed onto the start of the frame which indicates the start and end
57  * positions of the UDP or TCP frame.  This requires the driver to manually
58  * go through the packet data and decode the headers prior to sending.
59  * On Linux they generally provide cues to the location of the csum and the
60  * area to calculate it over, on FreeBSD we seem to have to do it all ourselves,
61  * hence this is not as optimal and therefore h/w tX checksum is currently not
62  * implemented.
63  *
64  */
65 #include <sys/stdint.h>
66 #include <sys/stddef.h>
67 #include <sys/param.h>
68 #include <sys/queue.h>
69 #include <sys/types.h>
70 #include <sys/systm.h>
71 #include <sys/kernel.h>
72 #include <sys/bus.h>
73 #include <sys/module.h>
74 #include <sys/lock.h>
75 #include <sys/mutex.h>
76 #include <sys/condvar.h>
77 #include <sys/socket.h>
78 #include <sys/sysctl.h>
79 #include <sys/sx.h>
80 #include <sys/unistd.h>
81 #include <sys/callout.h>
82 #include <sys/malloc.h>
83 #include <sys/priv.h>
84 #include <sys/random.h>
85 
86 #include <net/if.h>
87 #include <net/if_var.h>
88 
89 #include <netinet/in.h>
90 #include <netinet/ip.h>
91 
92 #include "opt_platform.h"
93 
94 #ifdef FDT
95 #include <dev/fdt/fdt_common.h>
96 #include <dev/ofw/ofw_bus.h>
97 #include <dev/ofw/ofw_bus_subr.h>
98 #endif
99 
100 #include <dev/usb/usb.h>
101 #include <dev/usb/usbdi.h>
102 #include <dev/usb/usbdi_util.h>
103 #include "usbdevs.h"
104 
105 #define	USB_DEBUG_VAR smsc_debug
106 #include <dev/usb/usb_debug.h>
107 #include <dev/usb/usb_process.h>
108 
109 #include <dev/usb/net/usb_ethernet.h>
110 
111 #include <dev/usb/net/if_smscreg.h>
112 
113 #ifdef USB_DEBUG
114 static int smsc_debug = 0;
115 
116 SYSCTL_NODE(_hw_usb, OID_AUTO, smsc, CTLFLAG_RW, 0, "USB smsc");
117 SYSCTL_INT(_hw_usb_smsc, OID_AUTO, debug, CTLFLAG_RWTUN, &smsc_debug, 0,
118     "Debug level");
119 #endif
120 
121 /*
122  * Various supported device vendors/products.
123  */
124 static const struct usb_device_id smsc_devs[] = {
125 #define	SMSC_DEV(p,i) { USB_VPI(USB_VENDOR_SMC2, USB_PRODUCT_SMC2_##p, i) }
126 	SMSC_DEV(LAN89530_ETH, 0),
127 	SMSC_DEV(LAN9500_ETH, 0),
128 	SMSC_DEV(LAN9500_ETH_2, 0),
129 	SMSC_DEV(LAN9500A_ETH, 0),
130 	SMSC_DEV(LAN9500A_ETH_2, 0),
131 	SMSC_DEV(LAN9505_ETH, 0),
132 	SMSC_DEV(LAN9505A_ETH, 0),
133 	SMSC_DEV(LAN9514_ETH, 0),
134 	SMSC_DEV(LAN9514_ETH_2, 0),
135 	SMSC_DEV(LAN9530_ETH, 0),
136 	SMSC_DEV(LAN9730_ETH, 0),
137 	SMSC_DEV(LAN9500_SAL10, 0),
138 	SMSC_DEV(LAN9505_SAL10, 0),
139 	SMSC_DEV(LAN9500A_SAL10, 0),
140 	SMSC_DEV(LAN9505A_SAL10, 0),
141 	SMSC_DEV(LAN9514_SAL10, 0),
142 	SMSC_DEV(LAN9500A_HAL, 0),
143 	SMSC_DEV(LAN9505A_HAL, 0),
144 #undef SMSC_DEV
145 };
146 
147 
148 #ifdef USB_DEBUG
149 #define smsc_dbg_printf(sc, fmt, args...) \
150 	do { \
151 		if (smsc_debug > 0) \
152 			device_printf((sc)->sc_ue.ue_dev, "debug: " fmt, ##args); \
153 	} while(0)
154 #else
155 #define smsc_dbg_printf(sc, fmt, args...) do { } while (0)
156 #endif
157 
158 #define smsc_warn_printf(sc, fmt, args...) \
159 	device_printf((sc)->sc_ue.ue_dev, "warning: " fmt, ##args)
160 
161 #define smsc_err_printf(sc, fmt, args...) \
162 	device_printf((sc)->sc_ue.ue_dev, "error: " fmt, ##args)
163 
164 
165 #define ETHER_IS_ZERO(addr) \
166 	(!(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]))
167 
168 #define ETHER_IS_VALID(addr) \
169 	(!ETHER_IS_MULTICAST(addr) && !ETHER_IS_ZERO(addr))
170 
171 static device_probe_t smsc_probe;
172 static device_attach_t smsc_attach;
173 static device_detach_t smsc_detach;
174 
175 static usb_callback_t smsc_bulk_read_callback;
176 static usb_callback_t smsc_bulk_write_callback;
177 
178 static miibus_readreg_t smsc_miibus_readreg;
179 static miibus_writereg_t smsc_miibus_writereg;
180 static miibus_statchg_t smsc_miibus_statchg;
181 
182 #if __FreeBSD_version > 1000000
183 static int smsc_attach_post_sub(struct usb_ether *ue);
184 #endif
185 static uether_fn_t smsc_attach_post;
186 static uether_fn_t smsc_init;
187 static uether_fn_t smsc_stop;
188 static uether_fn_t smsc_start;
189 static uether_fn_t smsc_tick;
190 static uether_fn_t smsc_setmulti;
191 static uether_fn_t smsc_setpromisc;
192 
193 static int	smsc_ifmedia_upd(struct ifnet *);
194 static void	smsc_ifmedia_sts(struct ifnet *, struct ifmediareq *);
195 
196 static int smsc_chip_init(struct smsc_softc *sc);
197 static int smsc_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data);
198 
199 static const struct usb_config smsc_config[SMSC_N_TRANSFER] = {
200 
201 	[SMSC_BULK_DT_WR] = {
202 		.type = UE_BULK,
203 		.endpoint = UE_ADDR_ANY,
204 		.direction = UE_DIR_OUT,
205 		.frames = 16,
206 		.bufsize = 16 * (MCLBYTES + 16),
207 		.flags = {.pipe_bof = 1,.force_short_xfer = 1,},
208 		.callback = smsc_bulk_write_callback,
209 		.timeout = 10000,	/* 10 seconds */
210 	},
211 
212 	[SMSC_BULK_DT_RD] = {
213 		.type = UE_BULK,
214 		.endpoint = UE_ADDR_ANY,
215 		.direction = UE_DIR_IN,
216 		.bufsize = 20480,	/* bytes */
217 		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
218 		.callback = smsc_bulk_read_callback,
219 		.timeout = 0,	/* no timeout */
220 	},
221 
222 	/* The SMSC chip supports an interrupt endpoints, however they aren't
223 	 * needed as we poll on the MII status.
224 	 */
225 };
226 
227 static const struct usb_ether_methods smsc_ue_methods = {
228 	.ue_attach_post = smsc_attach_post,
229 #if __FreeBSD_version > 1000000
230 	.ue_attach_post_sub = smsc_attach_post_sub,
231 #endif
232 	.ue_start = smsc_start,
233 	.ue_ioctl = smsc_ioctl,
234 	.ue_init = smsc_init,
235 	.ue_stop = smsc_stop,
236 	.ue_tick = smsc_tick,
237 	.ue_setmulti = smsc_setmulti,
238 	.ue_setpromisc = smsc_setpromisc,
239 	.ue_mii_upd = smsc_ifmedia_upd,
240 	.ue_mii_sts = smsc_ifmedia_sts,
241 };
242 
243 /**
244  *	smsc_read_reg - Reads a 32-bit register on the device
245  *	@sc: driver soft context
246  *	@off: offset of the register
247  *	@data: pointer a value that will be populated with the register value
248  *
249  *	LOCKING:
250  *	The device lock must be held before calling this function.
251  *
252  *	RETURNS:
253  *	0 on success, a USB_ERR_?? error code on failure.
254  */
255 static int
256 smsc_read_reg(struct smsc_softc *sc, uint32_t off, uint32_t *data)
257 {
258 	struct usb_device_request req;
259 	uint32_t buf;
260 	usb_error_t err;
261 
262 	SMSC_LOCK_ASSERT(sc, MA_OWNED);
263 
264 	req.bmRequestType = UT_READ_VENDOR_DEVICE;
265 	req.bRequest = SMSC_UR_READ_REG;
266 	USETW(req.wValue, 0);
267 	USETW(req.wIndex, off);
268 	USETW(req.wLength, 4);
269 
270 	err = uether_do_request(&sc->sc_ue, &req, &buf, 1000);
271 	if (err != 0)
272 		smsc_warn_printf(sc, "Failed to read register 0x%0x\n", off);
273 
274 	*data = le32toh(buf);
275 
276 	return (err);
277 }
278 
279 /**
280  *	smsc_write_reg - Writes a 32-bit register on the device
281  *	@sc: driver soft context
282  *	@off: offset of the register
283  *	@data: the 32-bit value to write into the register
284  *
285  *	LOCKING:
286  *	The device lock must be held before calling this function.
287  *
288  *	RETURNS:
289  *	0 on success, a USB_ERR_?? error code on failure.
290  */
291 static int
292 smsc_write_reg(struct smsc_softc *sc, uint32_t off, uint32_t data)
293 {
294 	struct usb_device_request req;
295 	uint32_t buf;
296 	usb_error_t err;
297 
298 	SMSC_LOCK_ASSERT(sc, MA_OWNED);
299 
300 	buf = htole32(data);
301 
302 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
303 	req.bRequest = SMSC_UR_WRITE_REG;
304 	USETW(req.wValue, 0);
305 	USETW(req.wIndex, off);
306 	USETW(req.wLength, 4);
307 
308 	err = uether_do_request(&sc->sc_ue, &req, &buf, 1000);
309 	if (err != 0)
310 		smsc_warn_printf(sc, "Failed to write register 0x%0x\n", off);
311 
312 	return (err);
313 }
314 
315 /**
316  *	smsc_wait_for_bits - Polls on a register value until bits are cleared
317  *	@sc: soft context
318  *	@reg: offset of the register
319  *	@bits: if the bits are clear the function returns
320  *
321  *	LOCKING:
322  *	The device lock must be held before calling this function.
323  *
324  *	RETURNS:
325  *	0 on success, or a USB_ERR_?? error code on failure.
326  */
327 static int
328 smsc_wait_for_bits(struct smsc_softc *sc, uint32_t reg, uint32_t bits)
329 {
330 	usb_ticks_t start_ticks;
331 	const usb_ticks_t max_ticks = USB_MS_TO_TICKS(1000);
332 	uint32_t val;
333 	int err;
334 
335 	SMSC_LOCK_ASSERT(sc, MA_OWNED);
336 
337 	start_ticks = (usb_ticks_t)ticks;
338 	do {
339 		if ((err = smsc_read_reg(sc, reg, &val)) != 0)
340 			return (err);
341 		if (!(val & bits))
342 			return (0);
343 
344 		uether_pause(&sc->sc_ue, hz / 100);
345 	} while (((usb_ticks_t)(ticks - start_ticks)) < max_ticks);
346 
347 	return (USB_ERR_TIMEOUT);
348 }
349 
350 /**
351  *	smsc_eeprom_read - Reads the attached EEPROM
352  *	@sc: soft context
353  *	@off: the eeprom address offset
354  *	@buf: stores the bytes
355  *	@buflen: the number of bytes to read
356  *
357  *	Simply reads bytes from an attached eeprom.
358  *
359  *	LOCKING:
360  *	The function takes and releases the device lock if it is not already held.
361  *
362  *	RETURNS:
363  *	0 on success, or a USB_ERR_?? error code on failure.
364  */
365 static int
366 smsc_eeprom_read(struct smsc_softc *sc, uint16_t off, uint8_t *buf, uint16_t buflen)
367 {
368 	usb_ticks_t start_ticks;
369 	const usb_ticks_t max_ticks = USB_MS_TO_TICKS(1000);
370 	int err;
371 	int locked;
372 	uint32_t val;
373 	uint16_t i;
374 
375 	locked = mtx_owned(&sc->sc_mtx);
376 	if (!locked)
377 		SMSC_LOCK(sc);
378 
379 	err = smsc_wait_for_bits(sc, SMSC_EEPROM_CMD, SMSC_EEPROM_CMD_BUSY);
380 	if (err != 0) {
381 		smsc_warn_printf(sc, "eeprom busy, failed to read data\n");
382 		goto done;
383 	}
384 
385 	/* start reading the bytes, one at a time */
386 	for (i = 0; i < buflen; i++) {
387 
388 		val = SMSC_EEPROM_CMD_BUSY | (SMSC_EEPROM_CMD_ADDR_MASK & (off + i));
389 		if ((err = smsc_write_reg(sc, SMSC_EEPROM_CMD, val)) != 0)
390 			goto done;
391 
392 		start_ticks = (usb_ticks_t)ticks;
393 		do {
394 			if ((err = smsc_read_reg(sc, SMSC_EEPROM_CMD, &val)) != 0)
395 				goto done;
396 			if (!(val & SMSC_EEPROM_CMD_BUSY) || (val & SMSC_EEPROM_CMD_TIMEOUT))
397 				break;
398 
399 			uether_pause(&sc->sc_ue, hz / 100);
400 		} while (((usb_ticks_t)(ticks - start_ticks)) < max_ticks);
401 
402 		if (val & (SMSC_EEPROM_CMD_BUSY | SMSC_EEPROM_CMD_TIMEOUT)) {
403 			smsc_warn_printf(sc, "eeprom command failed\n");
404 			err = USB_ERR_IOERROR;
405 			break;
406 		}
407 
408 		if ((err = smsc_read_reg(sc, SMSC_EEPROM_DATA, &val)) != 0)
409 			goto done;
410 
411 		buf[i] = (val & 0xff);
412 	}
413 
414 done:
415 	if (!locked)
416 		SMSC_UNLOCK(sc);
417 
418 	return (err);
419 }
420 
421 /**
422  *	smsc_miibus_readreg - Reads a MII/MDIO register
423  *	@dev: usb ether device
424  *	@phy: the number of phy reading from
425  *	@reg: the register address
426  *
427  *	Attempts to read a phy register over the MII bus.
428  *
429  *	LOCKING:
430  *	Takes and releases the device mutex lock if not already held.
431  *
432  *	RETURNS:
433  *	Returns the 16-bits read from the MII register, if this function fails 0
434  *	is returned.
435  */
436 static int
437 smsc_miibus_readreg(device_t dev, int phy, int reg)
438 {
439 	struct smsc_softc *sc = device_get_softc(dev);
440 	int locked;
441 	uint32_t addr;
442 	uint32_t val = 0;
443 
444 	locked = mtx_owned(&sc->sc_mtx);
445 	if (!locked)
446 		SMSC_LOCK(sc);
447 
448 	if (smsc_wait_for_bits(sc, SMSC_MII_ADDR, SMSC_MII_BUSY) != 0) {
449 		smsc_warn_printf(sc, "MII is busy\n");
450 		goto done;
451 	}
452 
453 	addr = (phy << 11) | (reg << 6) | SMSC_MII_READ;
454 	smsc_write_reg(sc, SMSC_MII_ADDR, addr);
455 
456 	if (smsc_wait_for_bits(sc, SMSC_MII_ADDR, SMSC_MII_BUSY) != 0)
457 		smsc_warn_printf(sc, "MII read timeout\n");
458 
459 	smsc_read_reg(sc, SMSC_MII_DATA, &val);
460 	val = le32toh(val);
461 
462 done:
463 	if (!locked)
464 		SMSC_UNLOCK(sc);
465 
466 	return (val & 0xFFFF);
467 }
468 
469 /**
470  *	smsc_miibus_writereg - Writes a MII/MDIO register
471  *	@dev: usb ether device
472  *	@phy: the number of phy writing to
473  *	@reg: the register address
474  *	@val: the value to write
475  *
476  *	Attempts to write a phy register over the MII bus.
477  *
478  *	LOCKING:
479  *	Takes and releases the device mutex lock if not already held.
480  *
481  *	RETURNS:
482  *	Always returns 0 regardless of success or failure.
483  */
484 static int
485 smsc_miibus_writereg(device_t dev, int phy, int reg, int val)
486 {
487 	struct smsc_softc *sc = device_get_softc(dev);
488 	int locked;
489 	uint32_t addr;
490 
491 	if (sc->sc_phyno != phy)
492 		return (0);
493 
494 	locked = mtx_owned(&sc->sc_mtx);
495 	if (!locked)
496 		SMSC_LOCK(sc);
497 
498 	if (smsc_wait_for_bits(sc, SMSC_MII_ADDR, SMSC_MII_BUSY) != 0) {
499 		smsc_warn_printf(sc, "MII is busy\n");
500 		goto done;
501 	}
502 
503 	val = htole32(val);
504 	smsc_write_reg(sc, SMSC_MII_DATA, val);
505 
506 	addr = (phy << 11) | (reg << 6) | SMSC_MII_WRITE;
507 	smsc_write_reg(sc, SMSC_MII_ADDR, addr);
508 
509 	if (smsc_wait_for_bits(sc, SMSC_MII_ADDR, SMSC_MII_BUSY) != 0)
510 		smsc_warn_printf(sc, "MII write timeout\n");
511 
512 done:
513 	if (!locked)
514 		SMSC_UNLOCK(sc);
515 	return (0);
516 }
517 
518 
519 
520 /**
521  *	smsc_miibus_statchg - Called to detect phy status change
522  *	@dev: usb ether device
523  *
524  *	This function is called periodically by the system to poll for status
525  *	changes of the link.
526  *
527  *	LOCKING:
528  *	Takes and releases the device mutex lock if not already held.
529  */
530 static void
531 smsc_miibus_statchg(device_t dev)
532 {
533 	struct smsc_softc *sc = device_get_softc(dev);
534 	struct mii_data *mii = uether_getmii(&sc->sc_ue);
535 	struct ifnet *ifp;
536 	int locked;
537 	int err;
538 	uint32_t flow;
539 	uint32_t afc_cfg;
540 
541 	locked = mtx_owned(&sc->sc_mtx);
542 	if (!locked)
543 		SMSC_LOCK(sc);
544 
545 	ifp = uether_getifp(&sc->sc_ue);
546 	if (mii == NULL || ifp == NULL ||
547 	    (ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
548 		goto done;
549 
550 	/* Use the MII status to determine link status */
551 	sc->sc_flags &= ~SMSC_FLAG_LINK;
552 	if ((mii->mii_media_status & (IFM_ACTIVE | IFM_AVALID)) ==
553 	    (IFM_ACTIVE | IFM_AVALID)) {
554 		switch (IFM_SUBTYPE(mii->mii_media_active)) {
555 			case IFM_10_T:
556 			case IFM_100_TX:
557 				sc->sc_flags |= SMSC_FLAG_LINK;
558 				break;
559 			case IFM_1000_T:
560 				/* Gigabit ethernet not supported by chipset */
561 				break;
562 			default:
563 				break;
564 		}
565 	}
566 
567 	/* Lost link, do nothing. */
568 	if ((sc->sc_flags & SMSC_FLAG_LINK) == 0) {
569 		smsc_dbg_printf(sc, "link flag not set\n");
570 		goto done;
571 	}
572 
573 	err = smsc_read_reg(sc, SMSC_AFC_CFG, &afc_cfg);
574 	if (err) {
575 		smsc_warn_printf(sc, "failed to read initial AFC_CFG, error %d\n", err);
576 		goto done;
577 	}
578 
579 	/* Enable/disable full duplex operation and TX/RX pause */
580 	if ((IFM_OPTIONS(mii->mii_media_active) & IFM_FDX) != 0) {
581 		smsc_dbg_printf(sc, "full duplex operation\n");
582 		sc->sc_mac_csr &= ~SMSC_MAC_CSR_RCVOWN;
583 		sc->sc_mac_csr |= SMSC_MAC_CSR_FDPX;
584 
585 		if ((IFM_OPTIONS(mii->mii_media_active) & IFM_ETH_RXPAUSE) != 0)
586 			flow = 0xffff0002;
587 		else
588 			flow = 0;
589 
590 		if ((IFM_OPTIONS(mii->mii_media_active) & IFM_ETH_TXPAUSE) != 0)
591 			afc_cfg |= 0xf;
592 		else
593 			afc_cfg &= ~0xf;
594 
595 	} else {
596 		smsc_dbg_printf(sc, "half duplex operation\n");
597 		sc->sc_mac_csr &= ~SMSC_MAC_CSR_FDPX;
598 		sc->sc_mac_csr |= SMSC_MAC_CSR_RCVOWN;
599 
600 		flow = 0;
601 		afc_cfg |= 0xf;
602 	}
603 
604 	err = smsc_write_reg(sc, SMSC_MAC_CSR, sc->sc_mac_csr);
605 	err += smsc_write_reg(sc, SMSC_FLOW, flow);
606 	err += smsc_write_reg(sc, SMSC_AFC_CFG, afc_cfg);
607 	if (err)
608 		smsc_warn_printf(sc, "media change failed, error %d\n", err);
609 
610 done:
611 	if (!locked)
612 		SMSC_UNLOCK(sc);
613 }
614 
615 /**
616  *	smsc_ifmedia_upd - Set media options
617  *	@ifp: interface pointer
618  *
619  *	Basically boilerplate code that simply calls the mii functions to set the
620  *	media options.
621  *
622  *	LOCKING:
623  *	The device lock must be held before this function is called.
624  *
625  *	RETURNS:
626  *	Returns 0 on success or a negative error code.
627  */
628 static int
629 smsc_ifmedia_upd(struct ifnet *ifp)
630 {
631 	struct smsc_softc *sc = ifp->if_softc;
632 	struct mii_data *mii = uether_getmii(&sc->sc_ue);
633 	struct mii_softc *miisc;
634 	int err;
635 
636 	SMSC_LOCK_ASSERT(sc, MA_OWNED);
637 
638 	LIST_FOREACH(miisc, &mii->mii_phys, mii_list)
639 		PHY_RESET(miisc);
640 	err = mii_mediachg(mii);
641 	return (err);
642 }
643 
644 /**
645  *	smsc_ifmedia_sts - Report current media status
646  *	@ifp: inet interface pointer
647  *	@ifmr: interface media request
648  *
649  *	Basically boilerplate code that simply calls the mii functions to get the
650  *	media status.
651  *
652  *	LOCKING:
653  *	Internally takes and releases the device lock.
654  */
655 static void
656 smsc_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr)
657 {
658 	struct smsc_softc *sc = ifp->if_softc;
659 	struct mii_data *mii = uether_getmii(&sc->sc_ue);
660 
661 	SMSC_LOCK(sc);
662 	mii_pollstat(mii);
663 	ifmr->ifm_active = mii->mii_media_active;
664 	ifmr->ifm_status = mii->mii_media_status;
665 	SMSC_UNLOCK(sc);
666 }
667 
668 /**
669  *	smsc_hash - Calculate the hash of a mac address
670  *	@addr: The mac address to calculate the hash on
671  *
672  *	This function is used when configuring a range of m'cast mac addresses to
673  *	filter on.  The hash of the mac address is put in the device's mac hash
674  *	table.
675  *
676  *	RETURNS:
677  *	Returns a value from 0-63 value which is the hash of the mac address.
678  */
679 static inline uint32_t
680 smsc_hash(uint8_t addr[ETHER_ADDR_LEN])
681 {
682 	return (ether_crc32_be(addr, ETHER_ADDR_LEN) >> 26) & 0x3f;
683 }
684 
685 /**
686  *	smsc_setmulti - Setup multicast
687  *	@ue: usb ethernet device context
688  *
689  *	Tells the device to either accept frames with a multicast mac address, a
690  *	select group of m'cast mac addresses or just the devices mac address.
691  *
692  *	LOCKING:
693  *	Should be called with the SMSC lock held.
694  */
695 static void
696 smsc_setmulti(struct usb_ether *ue)
697 {
698 	struct smsc_softc *sc = uether_getsc(ue);
699 	struct ifnet *ifp = uether_getifp(ue);
700 	struct ifmultiaddr *ifma;
701 	uint32_t hashtbl[2] = { 0, 0 };
702 	uint32_t hash;
703 
704 	SMSC_LOCK_ASSERT(sc, MA_OWNED);
705 
706 	if (ifp->if_flags & (IFF_ALLMULTI | IFF_PROMISC)) {
707 		smsc_dbg_printf(sc, "receive all multicast enabled\n");
708 		sc->sc_mac_csr |= SMSC_MAC_CSR_MCPAS;
709 		sc->sc_mac_csr &= ~SMSC_MAC_CSR_HPFILT;
710 
711 	} else {
712 		/* Take the lock of the mac address list before hashing each of them */
713 		if_maddr_rlock(ifp);
714 
715 		if (!TAILQ_EMPTY(&ifp->if_multiaddrs)) {
716 			/* We are filtering on a set of address so calculate hashes of each
717 			 * of the address and set the corresponding bits in the register.
718 			 */
719 			sc->sc_mac_csr |= SMSC_MAC_CSR_HPFILT;
720 			sc->sc_mac_csr &= ~(SMSC_MAC_CSR_PRMS | SMSC_MAC_CSR_MCPAS);
721 
722 			TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
723 				if (ifma->ifma_addr->sa_family != AF_LINK)
724 					continue;
725 
726 				hash = smsc_hash(LLADDR((struct sockaddr_dl *)ifma->ifma_addr));
727 				hashtbl[hash >> 5] |= 1 << (hash & 0x1F);
728 			}
729 		} else {
730 			/* Only receive packets with destination set to our mac address */
731 			sc->sc_mac_csr &= ~(SMSC_MAC_CSR_MCPAS | SMSC_MAC_CSR_HPFILT);
732 		}
733 
734 		if_maddr_runlock(ifp);
735 
736 		/* Debug */
737 		if (sc->sc_mac_csr & SMSC_MAC_CSR_HPFILT)
738 			smsc_dbg_printf(sc, "receive select group of macs\n");
739 		else
740 			smsc_dbg_printf(sc, "receive own packets only\n");
741 	}
742 
743 	/* Write the hash table and mac control registers */
744 	smsc_write_reg(sc, SMSC_HASHH, hashtbl[1]);
745 	smsc_write_reg(sc, SMSC_HASHL, hashtbl[0]);
746 	smsc_write_reg(sc, SMSC_MAC_CSR, sc->sc_mac_csr);
747 }
748 
749 
750 /**
751  *	smsc_setpromisc - Enables/disables promiscuous mode
752  *	@ue: usb ethernet device context
753  *
754  *	LOCKING:
755  *	Should be called with the SMSC lock held.
756  */
757 static void
758 smsc_setpromisc(struct usb_ether *ue)
759 {
760 	struct smsc_softc *sc = uether_getsc(ue);
761 	struct ifnet *ifp = uether_getifp(ue);
762 
763 	smsc_dbg_printf(sc, "promiscuous mode %sabled\n",
764 	                (ifp->if_flags & IFF_PROMISC) ? "en" : "dis");
765 
766 	SMSC_LOCK_ASSERT(sc, MA_OWNED);
767 
768 	if (ifp->if_flags & IFF_PROMISC)
769 		sc->sc_mac_csr |= SMSC_MAC_CSR_PRMS;
770 	else
771 		sc->sc_mac_csr &= ~SMSC_MAC_CSR_PRMS;
772 
773 	smsc_write_reg(sc, SMSC_MAC_CSR, sc->sc_mac_csr);
774 }
775 
776 
777 /**
778  *	smsc_sethwcsum - Enable or disable H/W UDP and TCP checksumming
779  *	@sc: driver soft context
780  *
781  *	LOCKING:
782  *	Should be called with the SMSC lock held.
783  *
784  *	RETURNS:
785  *	Returns 0 on success or a negative error code.
786  */
787 static int smsc_sethwcsum(struct smsc_softc *sc)
788 {
789 	struct ifnet *ifp = uether_getifp(&sc->sc_ue);
790 	uint32_t val;
791 	int err;
792 
793 	if (!ifp)
794 		return (-EIO);
795 
796 	SMSC_LOCK_ASSERT(sc, MA_OWNED);
797 
798 	err = smsc_read_reg(sc, SMSC_COE_CTRL, &val);
799 	if (err != 0) {
800 		smsc_warn_printf(sc, "failed to read SMSC_COE_CTRL (err=%d)\n", err);
801 		return (err);
802 	}
803 
804 	/* Enable/disable the Rx checksum */
805 	if ((ifp->if_capabilities & ifp->if_capenable) & IFCAP_RXCSUM)
806 		val |= SMSC_COE_CTRL_RX_EN;
807 	else
808 		val &= ~SMSC_COE_CTRL_RX_EN;
809 
810 	/* Enable/disable the Tx checksum (currently not supported) */
811 	if ((ifp->if_capabilities & ifp->if_capenable) & IFCAP_TXCSUM)
812 		val |= SMSC_COE_CTRL_TX_EN;
813 	else
814 		val &= ~SMSC_COE_CTRL_TX_EN;
815 
816 	err = smsc_write_reg(sc, SMSC_COE_CTRL, val);
817 	if (err != 0) {
818 		smsc_warn_printf(sc, "failed to write SMSC_COE_CTRL (err=%d)\n", err);
819 		return (err);
820 	}
821 
822 	return (0);
823 }
824 
825 /**
826  *	smsc_setmacaddress - Sets the mac address in the device
827  *	@sc: driver soft context
828  *	@addr: pointer to array contain at least 6 bytes of the mac
829  *
830  *	Writes the MAC address into the device, usually the MAC is programmed with
831  *	values from the EEPROM.
832  *
833  *	LOCKING:
834  *	Should be called with the SMSC lock held.
835  *
836  *	RETURNS:
837  *	Returns 0 on success or a negative error code.
838  */
839 static int
840 smsc_setmacaddress(struct smsc_softc *sc, const uint8_t *addr)
841 {
842 	int err;
843 	uint32_t val;
844 
845 	smsc_dbg_printf(sc, "setting mac address to %02x:%02x:%02x:%02x:%02x:%02x\n",
846 	                addr[0], addr[1], addr[2], addr[3], addr[4], addr[5]);
847 
848 	SMSC_LOCK_ASSERT(sc, MA_OWNED);
849 
850 	val = (addr[3] << 24) | (addr[2] << 16) | (addr[1] << 8) | addr[0];
851 	if ((err = smsc_write_reg(sc, SMSC_MAC_ADDRL, val)) != 0)
852 		goto done;
853 
854 	val = (addr[5] << 8) | addr[4];
855 	err = smsc_write_reg(sc, SMSC_MAC_ADDRH, val);
856 
857 done:
858 	return (err);
859 }
860 
861 /**
862  *	smsc_reset - Reset the SMSC chip
863  *	@sc: device soft context
864  *
865  *	LOCKING:
866  *	Should be called with the SMSC lock held.
867  */
868 static void
869 smsc_reset(struct smsc_softc *sc)
870 {
871 	struct usb_config_descriptor *cd;
872 	usb_error_t err;
873 
874 	cd = usbd_get_config_descriptor(sc->sc_ue.ue_udev);
875 
876 	err = usbd_req_set_config(sc->sc_ue.ue_udev, &sc->sc_mtx,
877 	                          cd->bConfigurationValue);
878 	if (err)
879 		smsc_warn_printf(sc, "reset failed (ignored)\n");
880 
881 	/* Wait a little while for the chip to get its brains in order. */
882 	uether_pause(&sc->sc_ue, hz / 100);
883 
884 	/* Reinitialize controller to achieve full reset. */
885 	smsc_chip_init(sc);
886 }
887 
888 
889 /**
890  *	smsc_init - Initialises the LAN95xx chip
891  *	@ue: USB ether interface
892  *
893  *	Called when the interface is brought up (i.e. ifconfig ue0 up), this
894  *	initialise the interface and the rx/tx pipes.
895  *
896  *	LOCKING:
897  *	Should be called with the SMSC lock held.
898  */
899 static void
900 smsc_init(struct usb_ether *ue)
901 {
902 	struct smsc_softc *sc = uether_getsc(ue);
903 	struct ifnet *ifp = uether_getifp(ue);
904 
905 	SMSC_LOCK_ASSERT(sc, MA_OWNED);
906 
907 	if (smsc_setmacaddress(sc, IF_LLADDR(ifp)))
908 		smsc_dbg_printf(sc, "setting MAC address failed\n");
909 
910 	if ((ifp->if_drv_flags & IFF_DRV_RUNNING) != 0)
911 		return;
912 
913 	/* Cancel pending I/O */
914 	smsc_stop(ue);
915 
916 #if __FreeBSD_version <= 1000000
917 	/* On earlier versions this was the first place we could tell the system
918 	 * that we supported h/w csuming, however this is only called after the
919 	 * the interface has been brought up - not ideal.
920 	 */
921 	if (!(ifp->if_capabilities & IFCAP_RXCSUM)) {
922 		ifp->if_capabilities |= IFCAP_RXCSUM;
923 		ifp->if_capenable |= IFCAP_RXCSUM;
924 		ifp->if_hwassist = 0;
925 	}
926 
927 	/* TX checksuming is disabled for now
928 	ifp->if_capabilities |= IFCAP_TXCSUM;
929 	ifp->if_capenable |= IFCAP_TXCSUM;
930 	ifp->if_hwassist = CSUM_TCP | CSUM_UDP;
931 	*/
932 #endif
933 
934 	/* Reset the ethernet interface. */
935 	smsc_reset(sc);
936 
937 	/* Load the multicast filter. */
938 	smsc_setmulti(ue);
939 
940 	/* TCP/UDP checksum offload engines. */
941 	smsc_sethwcsum(sc);
942 
943 	usbd_xfer_set_stall(sc->sc_xfer[SMSC_BULK_DT_WR]);
944 
945 	/* Indicate we are up and running. */
946 	ifp->if_drv_flags |= IFF_DRV_RUNNING;
947 
948 	/* Switch to selected media. */
949 	smsc_ifmedia_upd(ifp);
950 	smsc_start(ue);
951 }
952 
953 /**
954  *	smsc_bulk_read_callback - Read callback used to process the USB URB
955  *	@xfer: the USB transfer
956  *	@error:
957  *
958  *	Reads the URB data which can contain one or more ethernet frames, the
959  *	frames are copyed into a mbuf and given to the system.
960  *
961  *	LOCKING:
962  *	No locking required, doesn't access internal driver settings.
963  */
964 static void
965 smsc_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
966 {
967 	struct smsc_softc *sc = usbd_xfer_softc(xfer);
968 	struct usb_ether *ue = &sc->sc_ue;
969 	struct ifnet *ifp = uether_getifp(ue);
970 	struct mbuf *m;
971 	struct usb_page_cache *pc;
972 	uint32_t rxhdr;
973 	uint16_t pktlen;
974 	int off;
975 	int actlen;
976 
977 	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
978 	smsc_dbg_printf(sc, "rx : actlen %d\n", actlen);
979 
980 	switch (USB_GET_STATE(xfer)) {
981 	case USB_ST_TRANSFERRED:
982 
983 		/* There is always a zero length frame after bringing the IF up */
984 		if (actlen < (sizeof(rxhdr) + ETHER_CRC_LEN))
985 			goto tr_setup;
986 
987 		/* There maybe multiple packets in the USB frame, each will have a
988 		 * header and each needs to have it's own mbuf allocated and populated
989 		 * for it.
990 		 */
991 		pc = usbd_xfer_get_frame(xfer, 0);
992 		off = 0;
993 
994 		while (off < actlen) {
995 
996 			/* The frame header is always aligned on a 4 byte boundary */
997 			off = ((off + 0x3) & ~0x3);
998 
999 			usbd_copy_out(pc, off, &rxhdr, sizeof(rxhdr));
1000 			off += (sizeof(rxhdr) + ETHER_ALIGN);
1001 			rxhdr = le32toh(rxhdr);
1002 
1003 			pktlen = (uint16_t)SMSC_RX_STAT_FRM_LENGTH(rxhdr);
1004 
1005 			smsc_dbg_printf(sc, "rx : rxhdr 0x%08x : pktlen %d : actlen %d : "
1006 			                "off %d\n", rxhdr, pktlen, actlen, off);
1007 
1008 
1009 			if (rxhdr & SMSC_RX_STAT_ERROR) {
1010 				smsc_dbg_printf(sc, "rx error (hdr 0x%08x)\n", rxhdr);
1011 				if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
1012 				if (rxhdr & SMSC_RX_STAT_COLLISION)
1013 					if_inc_counter(ifp, IFCOUNTER_COLLISIONS, 1);
1014 			} else {
1015 
1016 				/* Check if the ethernet frame is too big or too small */
1017 				if ((pktlen < ETHER_HDR_LEN) || (pktlen > (actlen - off)))
1018 					goto tr_setup;
1019 
1020 				/* Create a new mbuf to store the packet in */
1021 				m = uether_newbuf();
1022 				if (m == NULL) {
1023 					smsc_warn_printf(sc, "failed to create new mbuf\n");
1024 					if_inc_counter(ifp, IFCOUNTER_IQDROPS, 1);
1025 					goto tr_setup;
1026 				}
1027 
1028 				usbd_copy_out(pc, off, mtod(m, uint8_t *), pktlen);
1029 
1030 				/* Check if RX TCP/UDP checksumming is being offloaded */
1031 				if ((ifp->if_capenable & IFCAP_RXCSUM) != 0) {
1032 
1033 					struct ether_header *eh;
1034 
1035 					eh = mtod(m, struct ether_header *);
1036 
1037 					/* Remove the extra 2 bytes of the csum */
1038 					pktlen -= 2;
1039 
1040 					/* The checksum appears to be simplistically calculated
1041 					 * over the udp/tcp header and data up to the end of the
1042 					 * eth frame.  Which means if the eth frame is padded
1043 					 * the csum calculation is incorrectly performed over
1044 					 * the padding bytes as well. Therefore to be safe we
1045 					 * ignore the H/W csum on frames less than or equal to
1046 					 * 64 bytes.
1047 					 *
1048 					 * Ignore H/W csum for non-IPv4 packets.
1049 					 */
1050 					if ((be16toh(eh->ether_type) == ETHERTYPE_IP) &&
1051 					    (pktlen > ETHER_MIN_LEN)) {
1052 						struct ip *ip;
1053 
1054 						ip = (struct ip *)(eh + 1);
1055 						if ((ip->ip_v == IPVERSION) &&
1056 						    ((ip->ip_p == IPPROTO_TCP) ||
1057 						     (ip->ip_p == IPPROTO_UDP))) {
1058 							/* Indicate the UDP/TCP csum has been calculated */
1059 							m->m_pkthdr.csum_flags |= CSUM_DATA_VALID;
1060 
1061 							/* Copy the TCP/UDP checksum from the last 2 bytes
1062 							 * of the transfer and put in the csum_data field.
1063 							 */
1064 							usbd_copy_out(pc, (off + pktlen),
1065 							              &m->m_pkthdr.csum_data, 2);
1066 
1067 							/* The data is copied in network order, but the
1068 							 * csum algorithm in the kernel expects it to be
1069 							 * in host network order.
1070 							 */
1071 							m->m_pkthdr.csum_data = ntohs(m->m_pkthdr.csum_data);
1072 
1073 							smsc_dbg_printf(sc, "RX checksum offloaded (0x%04x)\n",
1074 							                m->m_pkthdr.csum_data);
1075 						}
1076 					}
1077 
1078 					/* Need to adjust the offset as well or we'll be off
1079 					 * by 2 because the csum is removed from the packet
1080 					 * length.
1081 					 */
1082 					off += 2;
1083 				}
1084 
1085 				/* Finally enqueue the mbuf on the receive queue */
1086 				/* Remove 4 trailing bytes */
1087 				if (pktlen < (4 + ETHER_HDR_LEN)) {
1088 					m_freem(m);
1089 					goto tr_setup;
1090 				}
1091 				uether_rxmbuf(ue, m, pktlen - 4);
1092 			}
1093 
1094 			/* Update the offset to move to the next potential packet */
1095 			off += pktlen;
1096 		}
1097 
1098 		/* FALLTHROUGH */
1099 
1100 	case USB_ST_SETUP:
1101 tr_setup:
1102 		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1103 		usbd_transfer_submit(xfer);
1104 		uether_rxflush(ue);
1105 		return;
1106 
1107 	default:
1108 		if (error != USB_ERR_CANCELLED) {
1109 			smsc_warn_printf(sc, "bulk read error, %s\n", usbd_errstr(error));
1110 			usbd_xfer_set_stall(xfer);
1111 			goto tr_setup;
1112 		}
1113 		return;
1114 	}
1115 }
1116 
1117 /**
1118  *	smsc_bulk_write_callback - Write callback used to send ethernet frame(s)
1119  *	@xfer: the USB transfer
1120  *	@error: error code if the transfers is in an errored state
1121  *
1122  *	The main write function that pulls ethernet frames off the queue and sends
1123  *	them out.
1124  *
1125  *	LOCKING:
1126  *
1127  */
1128 static void
1129 smsc_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
1130 {
1131 	struct smsc_softc *sc = usbd_xfer_softc(xfer);
1132 	struct ifnet *ifp = uether_getifp(&sc->sc_ue);
1133 	struct usb_page_cache *pc;
1134 	struct mbuf *m;
1135 	uint32_t txhdr;
1136 	uint32_t frm_len = 0;
1137 	int nframes;
1138 
1139 	switch (USB_GET_STATE(xfer)) {
1140 	case USB_ST_TRANSFERRED:
1141 		ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
1142 		/* FALLTHROUGH */
1143 
1144 	case USB_ST_SETUP:
1145 tr_setup:
1146 		if ((sc->sc_flags & SMSC_FLAG_LINK) == 0 ||
1147 			(ifp->if_drv_flags & IFF_DRV_OACTIVE) != 0) {
1148 			/* Don't send anything if there is no link or controller is busy. */
1149 			return;
1150 		}
1151 
1152 		for (nframes = 0; nframes < 16 &&
1153 		    !IFQ_DRV_IS_EMPTY(&ifp->if_snd); nframes++) {
1154 			IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
1155 			if (m == NULL)
1156 				break;
1157 			usbd_xfer_set_frame_offset(xfer, nframes * MCLBYTES,
1158 			    nframes);
1159 			frm_len = 0;
1160 			pc = usbd_xfer_get_frame(xfer, nframes);
1161 
1162 			/* Each frame is prefixed with two 32-bit values describing the
1163 			 * length of the packet and buffer.
1164 			 */
1165 			txhdr = SMSC_TX_CTRL_0_BUF_SIZE(m->m_pkthdr.len) |
1166 					SMSC_TX_CTRL_0_FIRST_SEG | SMSC_TX_CTRL_0_LAST_SEG;
1167 			txhdr = htole32(txhdr);
1168 			usbd_copy_in(pc, 0, &txhdr, sizeof(txhdr));
1169 
1170 			txhdr = SMSC_TX_CTRL_1_PKT_LENGTH(m->m_pkthdr.len);
1171 			txhdr = htole32(txhdr);
1172 			usbd_copy_in(pc, 4, &txhdr, sizeof(txhdr));
1173 
1174 			frm_len += 8;
1175 
1176 			/* Next copy in the actual packet */
1177 			usbd_m_copy_in(pc, frm_len, m, 0, m->m_pkthdr.len);
1178 			frm_len += m->m_pkthdr.len;
1179 
1180 			if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
1181 
1182 			/* If there's a BPF listener, bounce a copy of this frame to him */
1183 			BPF_MTAP(ifp, m);
1184 
1185 			m_freem(m);
1186 
1187 			/* Set frame length. */
1188 			usbd_xfer_set_frame_len(xfer, nframes, frm_len);
1189 		}
1190 		if (nframes != 0) {
1191 			usbd_xfer_set_frames(xfer, nframes);
1192 			usbd_transfer_submit(xfer);
1193 			ifp->if_drv_flags |= IFF_DRV_OACTIVE;
1194 		}
1195 		return;
1196 
1197 	default:
1198 		if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
1199 		ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
1200 
1201 		if (error != USB_ERR_CANCELLED) {
1202 			smsc_err_printf(sc, "usb error on tx: %s\n", usbd_errstr(error));
1203 			usbd_xfer_set_stall(xfer);
1204 			goto tr_setup;
1205 		}
1206 		return;
1207 	}
1208 }
1209 
1210 /**
1211  *	smsc_tick - Called periodically to monitor the state of the LAN95xx chip
1212  *	@ue: USB ether interface
1213  *
1214  *	Simply calls the mii status functions to check the state of the link.
1215  *
1216  *	LOCKING:
1217  *	Should be called with the SMSC lock held.
1218  */
1219 static void
1220 smsc_tick(struct usb_ether *ue)
1221 {
1222 	struct smsc_softc *sc = uether_getsc(ue);
1223 	struct mii_data *mii = uether_getmii(&sc->sc_ue);
1224 
1225 	SMSC_LOCK_ASSERT(sc, MA_OWNED);
1226 
1227 	mii_tick(mii);
1228 	if ((sc->sc_flags & SMSC_FLAG_LINK) == 0) {
1229 		smsc_miibus_statchg(ue->ue_dev);
1230 		if ((sc->sc_flags & SMSC_FLAG_LINK) != 0)
1231 			smsc_start(ue);
1232 	}
1233 }
1234 
1235 /**
1236  *	smsc_start - Starts communication with the LAN95xx chip
1237  *	@ue: USB ether interface
1238  *
1239  *
1240  *
1241  */
1242 static void
1243 smsc_start(struct usb_ether *ue)
1244 {
1245 	struct smsc_softc *sc = uether_getsc(ue);
1246 
1247 	/*
1248 	 * start the USB transfers, if not already started:
1249 	 */
1250 	usbd_transfer_start(sc->sc_xfer[SMSC_BULK_DT_RD]);
1251 	usbd_transfer_start(sc->sc_xfer[SMSC_BULK_DT_WR]);
1252 }
1253 
1254 /**
1255  *	smsc_stop - Stops communication with the LAN95xx chip
1256  *	@ue: USB ether interface
1257  *
1258  *
1259  *
1260  */
1261 static void
1262 smsc_stop(struct usb_ether *ue)
1263 {
1264 	struct smsc_softc *sc = uether_getsc(ue);
1265 	struct ifnet *ifp = uether_getifp(ue);
1266 
1267 	SMSC_LOCK_ASSERT(sc, MA_OWNED);
1268 
1269 	ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
1270 	sc->sc_flags &= ~SMSC_FLAG_LINK;
1271 
1272 	/*
1273 	 * stop all the transfers, if not already stopped:
1274 	 */
1275 	usbd_transfer_stop(sc->sc_xfer[SMSC_BULK_DT_WR]);
1276 	usbd_transfer_stop(sc->sc_xfer[SMSC_BULK_DT_RD]);
1277 }
1278 
1279 /**
1280  *	smsc_phy_init - Initialises the in-built SMSC phy
1281  *	@sc: driver soft context
1282  *
1283  *	Resets the PHY part of the chip and then initialises it to default
1284  *	values.  The 'link down' and 'auto-negotiation complete' interrupts
1285  *	from the PHY are also enabled, however we don't monitor the interrupt
1286  *	endpoints for the moment.
1287  *
1288  *	RETURNS:
1289  *	Returns 0 on success or EIO if failed to reset the PHY.
1290  */
1291 static int
1292 smsc_phy_init(struct smsc_softc *sc)
1293 {
1294 	int bmcr;
1295 	usb_ticks_t start_ticks;
1296 	const usb_ticks_t max_ticks = USB_MS_TO_TICKS(1000);
1297 
1298 	SMSC_LOCK_ASSERT(sc, MA_OWNED);
1299 
1300 	/* Reset phy and wait for reset to complete */
1301 	smsc_miibus_writereg(sc->sc_ue.ue_dev, sc->sc_phyno, MII_BMCR, BMCR_RESET);
1302 
1303 	start_ticks = ticks;
1304 	do {
1305 		uether_pause(&sc->sc_ue, hz / 100);
1306 		bmcr = smsc_miibus_readreg(sc->sc_ue.ue_dev, sc->sc_phyno, MII_BMCR);
1307 	} while ((bmcr & MII_BMCR) && ((ticks - start_ticks) < max_ticks));
1308 
1309 	if (((usb_ticks_t)(ticks - start_ticks)) >= max_ticks) {
1310 		smsc_err_printf(sc, "PHY reset timed-out");
1311 		return (EIO);
1312 	}
1313 
1314 	smsc_miibus_writereg(sc->sc_ue.ue_dev, sc->sc_phyno, MII_ANAR,
1315 	                     ANAR_10 | ANAR_10_FD | ANAR_TX | ANAR_TX_FD |  /* all modes */
1316 	                     ANAR_CSMA |
1317 	                     ANAR_FC |
1318 	                     ANAR_PAUSE_ASYM);
1319 
1320 	/* Setup the phy to interrupt when the link goes down or autoneg completes */
1321 	smsc_miibus_readreg(sc->sc_ue.ue_dev, sc->sc_phyno, SMSC_PHY_INTR_STAT);
1322 	smsc_miibus_writereg(sc->sc_ue.ue_dev, sc->sc_phyno, SMSC_PHY_INTR_MASK,
1323 	                     (SMSC_PHY_INTR_ANEG_COMP | SMSC_PHY_INTR_LINK_DOWN));
1324 
1325 	/* Restart auto-negotation */
1326 	bmcr = smsc_miibus_readreg(sc->sc_ue.ue_dev, sc->sc_phyno, MII_BMCR);
1327 	bmcr |= BMCR_STARTNEG;
1328 	smsc_miibus_writereg(sc->sc_ue.ue_dev, sc->sc_phyno, MII_BMCR, bmcr);
1329 
1330 	return (0);
1331 }
1332 
1333 
1334 /**
1335  *	smsc_chip_init - Initialises the chip after power on
1336  *	@sc: driver soft context
1337  *
1338  *	This initialisation sequence is modelled on the procedure in the Linux
1339  *	driver.
1340  *
1341  *	RETURNS:
1342  *	Returns 0 on success or an error code on failure.
1343  */
1344 static int
1345 smsc_chip_init(struct smsc_softc *sc)
1346 {
1347 	int err;
1348 	int locked;
1349 	uint32_t reg_val;
1350 	int burst_cap;
1351 
1352 	locked = mtx_owned(&sc->sc_mtx);
1353 	if (!locked)
1354 		SMSC_LOCK(sc);
1355 
1356 	/* Enter H/W config mode */
1357 	smsc_write_reg(sc, SMSC_HW_CFG, SMSC_HW_CFG_LRST);
1358 
1359 	if ((err = smsc_wait_for_bits(sc, SMSC_HW_CFG, SMSC_HW_CFG_LRST)) != 0) {
1360 		smsc_warn_printf(sc, "timed-out waiting for reset to complete\n");
1361 		goto init_failed;
1362 	}
1363 
1364 	/* Reset the PHY */
1365 	smsc_write_reg(sc, SMSC_PM_CTRL, SMSC_PM_CTRL_PHY_RST);
1366 
1367 	if ((err = smsc_wait_for_bits(sc, SMSC_PM_CTRL, SMSC_PM_CTRL_PHY_RST)) != 0) {
1368 		smsc_warn_printf(sc, "timed-out waiting for phy reset to complete\n");
1369 		goto init_failed;
1370 	}
1371 
1372 	/* Set the mac address */
1373 	if ((err = smsc_setmacaddress(sc, sc->sc_ue.ue_eaddr)) != 0) {
1374 		smsc_warn_printf(sc, "failed to set the MAC address\n");
1375 		goto init_failed;
1376 	}
1377 
1378 	/* Don't know what the HW_CFG_BIR bit is, but following the reset sequence
1379 	 * as used in the Linux driver.
1380 	 */
1381 	if ((err = smsc_read_reg(sc, SMSC_HW_CFG, &reg_val)) != 0) {
1382 		smsc_warn_printf(sc, "failed to read HW_CFG: %d\n", err);
1383 		goto init_failed;
1384 	}
1385 	reg_val |= SMSC_HW_CFG_BIR;
1386 	smsc_write_reg(sc, SMSC_HW_CFG, reg_val);
1387 
1388 	/* There is a so called 'turbo mode' that the linux driver supports, it
1389 	 * seems to allow you to jam multiple frames per Rx transaction.  By default
1390 	 * this driver supports that and therefore allows multiple frames per URB.
1391 	 *
1392 	 * The xfer buffer size needs to reflect this as well, therefore based on
1393 	 * the calculations in the Linux driver the RX bufsize is set to 18944,
1394 	 *     bufsz = (16 * 1024 + 5 * 512)
1395 	 *
1396 	 * Burst capability is the number of URBs that can be in a burst of data/
1397 	 * ethernet frames.
1398 	 */
1399 	if (usbd_get_speed(sc->sc_ue.ue_udev) == USB_SPEED_HIGH)
1400 		burst_cap = 37;
1401 	else
1402 		burst_cap = 128;
1403 
1404 	smsc_write_reg(sc, SMSC_BURST_CAP, burst_cap);
1405 
1406 	/* Set the default bulk in delay (magic value from Linux driver) */
1407 	smsc_write_reg(sc, SMSC_BULK_IN_DLY, 0x00002000);
1408 
1409 
1410 
1411 	/*
1412 	 * Initialise the RX interface
1413 	 */
1414 	if ((err = smsc_read_reg(sc, SMSC_HW_CFG, &reg_val)) < 0) {
1415 		smsc_warn_printf(sc, "failed to read HW_CFG: (err = %d)\n", err);
1416 		goto init_failed;
1417 	}
1418 
1419 	/* Adjust the packet offset in the buffer (designed to try and align IP
1420 	 * header on 4 byte boundary)
1421 	 */
1422 	reg_val &= ~SMSC_HW_CFG_RXDOFF;
1423 	reg_val |= (ETHER_ALIGN << 9) & SMSC_HW_CFG_RXDOFF;
1424 
1425 	/* The following setings are used for 'turbo mode', a.k.a multiple frames
1426 	 * per Rx transaction (again info taken form Linux driver).
1427 	 */
1428 	reg_val |= (SMSC_HW_CFG_MEF | SMSC_HW_CFG_BCE);
1429 
1430 	smsc_write_reg(sc, SMSC_HW_CFG, reg_val);
1431 
1432 	/* Clear the status register ? */
1433 	smsc_write_reg(sc, SMSC_INTR_STATUS, 0xffffffff);
1434 
1435 	/* Read and display the revision register */
1436 	if ((err = smsc_read_reg(sc, SMSC_ID_REV, &sc->sc_rev_id)) < 0) {
1437 		smsc_warn_printf(sc, "failed to read ID_REV (err = %d)\n", err);
1438 		goto init_failed;
1439 	}
1440 
1441 	device_printf(sc->sc_ue.ue_dev, "chip 0x%04lx, rev. %04lx\n",
1442 	    (sc->sc_rev_id & SMSC_ID_REV_CHIP_ID_MASK) >> 16,
1443 	    (sc->sc_rev_id & SMSC_ID_REV_CHIP_REV_MASK));
1444 
1445 	/* GPIO/LED setup */
1446 	reg_val = SMSC_LED_GPIO_CFG_SPD_LED | SMSC_LED_GPIO_CFG_LNK_LED |
1447 	          SMSC_LED_GPIO_CFG_FDX_LED;
1448 	smsc_write_reg(sc, SMSC_LED_GPIO_CFG, reg_val);
1449 
1450 	/*
1451 	 * Initialise the TX interface
1452 	 */
1453 	smsc_write_reg(sc, SMSC_FLOW, 0);
1454 
1455 	smsc_write_reg(sc, SMSC_AFC_CFG, AFC_CFG_DEFAULT);
1456 
1457 	/* Read the current MAC configuration */
1458 	if ((err = smsc_read_reg(sc, SMSC_MAC_CSR, &sc->sc_mac_csr)) < 0) {
1459 		smsc_warn_printf(sc, "failed to read MAC_CSR (err=%d)\n", err);
1460 		goto init_failed;
1461 	}
1462 
1463 	/* Vlan */
1464 	smsc_write_reg(sc, SMSC_VLAN1, (uint32_t)ETHERTYPE_VLAN);
1465 
1466 	/*
1467 	 * Initialise the PHY
1468 	 */
1469 	if ((err = smsc_phy_init(sc)) != 0)
1470 		goto init_failed;
1471 
1472 
1473 	/*
1474 	 * Start TX
1475 	 */
1476 	sc->sc_mac_csr |= SMSC_MAC_CSR_TXEN;
1477 	smsc_write_reg(sc, SMSC_MAC_CSR, sc->sc_mac_csr);
1478 	smsc_write_reg(sc, SMSC_TX_CFG, SMSC_TX_CFG_ON);
1479 
1480 	/*
1481 	 * Start RX
1482 	 */
1483 	sc->sc_mac_csr |= SMSC_MAC_CSR_RXEN;
1484 	smsc_write_reg(sc, SMSC_MAC_CSR, sc->sc_mac_csr);
1485 
1486 	if (!locked)
1487 		SMSC_UNLOCK(sc);
1488 
1489 	return (0);
1490 
1491 init_failed:
1492 	if (!locked)
1493 		SMSC_UNLOCK(sc);
1494 
1495 	smsc_err_printf(sc, "smsc_chip_init failed (err=%d)\n", err);
1496 	return (err);
1497 }
1498 
1499 
1500 /**
1501  *	smsc_ioctl - ioctl function for the device
1502  *	@ifp: interface pointer
1503  *	@cmd: the ioctl command
1504  *	@data: data passed in the ioctl call, typically a pointer to struct ifreq.
1505  *
1506  *	The ioctl routine is overridden to detect change requests for the H/W
1507  *	checksum capabilities.
1508  *
1509  *	RETURNS:
1510  *	0 on success and an error code on failure.
1511  */
1512 static int
1513 smsc_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
1514 {
1515 	struct usb_ether *ue = ifp->if_softc;
1516 	struct smsc_softc *sc;
1517 	struct ifreq *ifr;
1518 	int rc;
1519 	int mask;
1520 	int reinit;
1521 
1522 	if (cmd == SIOCSIFCAP) {
1523 
1524 		sc = uether_getsc(ue);
1525 		ifr = (struct ifreq *)data;
1526 
1527 		SMSC_LOCK(sc);
1528 
1529 		rc = 0;
1530 		reinit = 0;
1531 
1532 		mask = ifr->ifr_reqcap ^ ifp->if_capenable;
1533 
1534 		/* Modify the RX CSUM enable bits */
1535 		if ((mask & IFCAP_RXCSUM) != 0 &&
1536 		    (ifp->if_capabilities & IFCAP_RXCSUM) != 0) {
1537 			ifp->if_capenable ^= IFCAP_RXCSUM;
1538 
1539 			if (ifp->if_drv_flags & IFF_DRV_RUNNING) {
1540 				ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
1541 				reinit = 1;
1542 			}
1543 		}
1544 
1545 		SMSC_UNLOCK(sc);
1546 		if (reinit)
1547 #if __FreeBSD_version > 1000000
1548 			uether_init(ue);
1549 #else
1550 			ifp->if_init(ue);
1551 #endif
1552 
1553 	} else {
1554 		rc = uether_ioctl(ifp, cmd, data);
1555 	}
1556 
1557 	return (rc);
1558 }
1559 
1560 #ifdef FDT
1561 /*
1562  * This is FreeBSD-specific compatibility strings for RPi/RPi2
1563  */
1564 static phandle_t
1565 smsc_fdt_find_eth_node(phandle_t start)
1566 {
1567 	phandle_t child, node;
1568 
1569 	/* Traverse through entire tree to find usb ethernet nodes. */
1570 	for (node = OF_child(start); node != 0; node = OF_peer(node)) {
1571 		if (ofw_bus_node_is_compatible(node, "net,ethernet") &&
1572 		    ofw_bus_node_is_compatible(node, "usb,device"))
1573 			return (node);
1574 		child = smsc_fdt_find_eth_node(node);
1575 		if (child != -1)
1576 			return (child);
1577 	}
1578 
1579 	return (-1);
1580 }
1581 
1582 /*
1583  * Check if node's path is <*>/usb/hub/ethernet
1584  */
1585 static int
1586 smsc_fdt_is_usb_eth(phandle_t node)
1587 {
1588 	char name[16];
1589 	int len;
1590 
1591 	memset(name, 0, sizeof(name));
1592 	len = OF_getprop(node, "name", name, sizeof(name));
1593 	if (len <= 0)
1594 		return (0);
1595 
1596 	if (strcmp(name, "ethernet"))
1597 		return (0);
1598 
1599 	node = OF_parent(node);
1600 	if (node == -1)
1601 		return (0);
1602 	len = OF_getprop(node, "name", name, sizeof(name));
1603 	if (len <= 0)
1604 		return (0);
1605 
1606 	if (strcmp(name, "hub"))
1607 		return (0);
1608 
1609 	node = OF_parent(node);
1610 	if (node == -1)
1611 		return (0);
1612 	len = OF_getprop(node, "name", name, sizeof(name));
1613 	if (len <= 0)
1614 		return (0);
1615 
1616 	if (strcmp(name, "usb"))
1617 		return (0);
1618 
1619 	return (1);
1620 }
1621 
1622 static phandle_t
1623 smsc_fdt_find_eth_node_by_path(phandle_t start)
1624 {
1625 	phandle_t child, node;
1626 
1627 	/* Traverse through entire tree to find usb ethernet nodes. */
1628 	for (node = OF_child(start); node != 0; node = OF_peer(node)) {
1629 		if (smsc_fdt_is_usb_eth(node))
1630 			return (node);
1631 		child = smsc_fdt_find_eth_node_by_path(node);
1632 		if (child != -1)
1633 			return (child);
1634 	}
1635 
1636 	return (-1);
1637 }
1638 
1639 /**
1640  * Get MAC address from FDT blob.  Firmware or loader should fill
1641  * mac-address or local-mac-address property.  Returns 0 if MAC address
1642  * obtained, error code otherwise.
1643  */
1644 static int
1645 smsc_fdt_find_mac(unsigned char *mac)
1646 {
1647 	phandle_t node, root;
1648 	int len;
1649 
1650 	root = OF_finddevice("/");
1651 	node = smsc_fdt_find_eth_node(root);
1652 	/*
1653 	 * If it's not FreeBSD FDT blob for RPi, try more
1654 	 *     generic .../usb/hub/ethernet
1655 	 */
1656 	if (node == -1)
1657 		node = smsc_fdt_find_eth_node_by_path(root);
1658 
1659 	if (node != -1) {
1660 		/* Check if there is property */
1661 		if ((len = OF_getproplen(node, "local-mac-address")) > 0) {
1662 			if (len != ETHER_ADDR_LEN)
1663 				return (EINVAL);
1664 
1665 			OF_getprop(node, "local-mac-address", mac,
1666 			    ETHER_ADDR_LEN);
1667 			return (0);
1668 		}
1669 
1670 		if ((len = OF_getproplen(node, "mac-address")) > 0) {
1671 			if (len != ETHER_ADDR_LEN)
1672 				return (EINVAL);
1673 
1674 			OF_getprop(node, "mac-address", mac,
1675 			    ETHER_ADDR_LEN);
1676 			return (0);
1677 		}
1678 	}
1679 
1680 	return (ENXIO);
1681 }
1682 #endif
1683 
1684 /**
1685  *	smsc_attach_post - Called after the driver attached to the USB interface
1686  *	@ue: the USB ethernet device
1687  *
1688  *	This is where the chip is intialised for the first time.  This is different
1689  *	from the smsc_init() function in that that one is designed to setup the
1690  *	H/W to match the UE settings and can be called after a reset.
1691  *
1692  *
1693  */
1694 static void
1695 smsc_attach_post(struct usb_ether *ue)
1696 {
1697 	struct smsc_softc *sc = uether_getsc(ue);
1698 	uint32_t mac_h, mac_l;
1699 	int err;
1700 
1701 	smsc_dbg_printf(sc, "smsc_attach_post\n");
1702 
1703 	/* Setup some of the basics */
1704 	sc->sc_phyno = 1;
1705 
1706 
1707 	/* Attempt to get the mac address, if an EEPROM is not attached this
1708 	 * will just return FF:FF:FF:FF:FF:FF, so in such cases we invent a MAC
1709 	 * address based on urandom.
1710 	 */
1711 	memset(sc->sc_ue.ue_eaddr, 0xff, ETHER_ADDR_LEN);
1712 
1713 	/* Check if there is already a MAC address in the register */
1714 	if ((smsc_read_reg(sc, SMSC_MAC_ADDRL, &mac_l) == 0) &&
1715 	    (smsc_read_reg(sc, SMSC_MAC_ADDRH, &mac_h) == 0)) {
1716 		sc->sc_ue.ue_eaddr[5] = (uint8_t)((mac_h >> 8) & 0xff);
1717 		sc->sc_ue.ue_eaddr[4] = (uint8_t)((mac_h) & 0xff);
1718 		sc->sc_ue.ue_eaddr[3] = (uint8_t)((mac_l >> 24) & 0xff);
1719 		sc->sc_ue.ue_eaddr[2] = (uint8_t)((mac_l >> 16) & 0xff);
1720 		sc->sc_ue.ue_eaddr[1] = (uint8_t)((mac_l >> 8) & 0xff);
1721 		sc->sc_ue.ue_eaddr[0] = (uint8_t)((mac_l) & 0xff);
1722 	}
1723 
1724 	/* MAC address is not set so try to read from EEPROM, if that fails generate
1725 	 * a random MAC address.
1726 	 */
1727 	if (!ETHER_IS_VALID(sc->sc_ue.ue_eaddr)) {
1728 
1729 		err = smsc_eeprom_read(sc, 0x01, sc->sc_ue.ue_eaddr, ETHER_ADDR_LEN);
1730 #ifdef FDT
1731 		if ((err != 0) || (!ETHER_IS_VALID(sc->sc_ue.ue_eaddr)))
1732 			err = smsc_fdt_find_mac(sc->sc_ue.ue_eaddr);
1733 #endif
1734 		if ((err != 0) || (!ETHER_IS_VALID(sc->sc_ue.ue_eaddr))) {
1735 			read_random(sc->sc_ue.ue_eaddr, ETHER_ADDR_LEN);
1736 			sc->sc_ue.ue_eaddr[0] &= ~0x01;     /* unicast */
1737 			sc->sc_ue.ue_eaddr[0] |=  0x02;     /* locally administered */
1738 		}
1739 	}
1740 
1741 	/* Initialise the chip for the first time */
1742 	smsc_chip_init(sc);
1743 }
1744 
1745 
1746 /**
1747  *	smsc_attach_post_sub - Called after the driver attached to the USB interface
1748  *	@ue: the USB ethernet device
1749  *
1750  *	Most of this is boilerplate code and copied from the base USB ethernet
1751  *	driver.  It has been overriden so that we can indicate to the system that
1752  *	the chip supports H/W checksumming.
1753  *
1754  *	RETURNS:
1755  *	Returns 0 on success or a negative error code.
1756  */
1757 #if __FreeBSD_version > 1000000
1758 static int
1759 smsc_attach_post_sub(struct usb_ether *ue)
1760 {
1761 	struct smsc_softc *sc;
1762 	struct ifnet *ifp;
1763 	int error;
1764 
1765 	sc = uether_getsc(ue);
1766 	ifp = ue->ue_ifp;
1767 	ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
1768 	ifp->if_start = uether_start;
1769 	ifp->if_ioctl = smsc_ioctl;
1770 	ifp->if_init = uether_init;
1771 	IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen);
1772 	ifp->if_snd.ifq_drv_maxlen = ifqmaxlen;
1773 	IFQ_SET_READY(&ifp->if_snd);
1774 
1775 	/* The chip supports TCP/UDP checksum offloading on TX and RX paths, however
1776 	 * currently only RX checksum is supported in the driver (see top of file).
1777 	 */
1778 	ifp->if_capabilities |= IFCAP_RXCSUM | IFCAP_VLAN_MTU;
1779 	ifp->if_hwassist = 0;
1780 
1781 	/* TX checksuming is disabled (for now?)
1782 	ifp->if_capabilities |= IFCAP_TXCSUM;
1783 	ifp->if_capenable |= IFCAP_TXCSUM;
1784 	ifp->if_hwassist = CSUM_TCP | CSUM_UDP;
1785 	*/
1786 
1787 	ifp->if_capenable = ifp->if_capabilities;
1788 
1789 	mtx_lock(&Giant);
1790 	error = mii_attach(ue->ue_dev, &ue->ue_miibus, ifp,
1791 	    uether_ifmedia_upd, ue->ue_methods->ue_mii_sts,
1792 	    BMSR_DEFCAPMASK, sc->sc_phyno, MII_OFFSET_ANY, 0);
1793 	mtx_unlock(&Giant);
1794 
1795 	return (error);
1796 }
1797 #endif /* __FreeBSD_version > 1000000 */
1798 
1799 
1800 /**
1801  *	smsc_probe - Probe the interface.
1802  *	@dev: smsc device handle
1803  *
1804  *	Checks if the device is a match for this driver.
1805  *
1806  *	RETURNS:
1807  *	Returns 0 on success or an error code on failure.
1808  */
1809 static int
1810 smsc_probe(device_t dev)
1811 {
1812 	struct usb_attach_arg *uaa = device_get_ivars(dev);
1813 
1814 	if (uaa->usb_mode != USB_MODE_HOST)
1815 		return (ENXIO);
1816 	if (uaa->info.bConfigIndex != SMSC_CONFIG_INDEX)
1817 		return (ENXIO);
1818 	if (uaa->info.bIfaceIndex != SMSC_IFACE_IDX)
1819 		return (ENXIO);
1820 
1821 	return (usbd_lookup_id_by_uaa(smsc_devs, sizeof(smsc_devs), uaa));
1822 }
1823 
1824 
1825 /**
1826  *	smsc_attach - Attach the interface.
1827  *	@dev: smsc device handle
1828  *
1829  *	Allocate softc structures, do ifmedia setup and ethernet/BPF attach.
1830  *
1831  *	RETURNS:
1832  *	Returns 0 on success or a negative error code.
1833  */
1834 static int
1835 smsc_attach(device_t dev)
1836 {
1837 	struct usb_attach_arg *uaa = device_get_ivars(dev);
1838 	struct smsc_softc *sc = device_get_softc(dev);
1839 	struct usb_ether *ue = &sc->sc_ue;
1840 	uint8_t iface_index;
1841 	int err;
1842 
1843 	sc->sc_flags = USB_GET_DRIVER_INFO(uaa);
1844 
1845 	device_set_usb_desc(dev);
1846 
1847 	mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
1848 
1849 	/* Setup the endpoints for the SMSC LAN95xx device(s) */
1850 	iface_index = SMSC_IFACE_IDX;
1851 	err = usbd_transfer_setup(uaa->device, &iface_index, sc->sc_xfer,
1852 	                          smsc_config, SMSC_N_TRANSFER, sc, &sc->sc_mtx);
1853 	if (err) {
1854 		device_printf(dev, "error: allocating USB transfers failed\n");
1855 		goto detach;
1856 	}
1857 
1858 	ue->ue_sc = sc;
1859 	ue->ue_dev = dev;
1860 	ue->ue_udev = uaa->device;
1861 	ue->ue_mtx = &sc->sc_mtx;
1862 	ue->ue_methods = &smsc_ue_methods;
1863 
1864 	err = uether_ifattach(ue);
1865 	if (err) {
1866 		device_printf(dev, "error: could not attach interface\n");
1867 		goto detach;
1868 	}
1869 	return (0);			/* success */
1870 
1871 detach:
1872 	smsc_detach(dev);
1873 	return (ENXIO);		/* failure */
1874 }
1875 
1876 /**
1877  *	smsc_detach - Detach the interface.
1878  *	@dev: smsc device handle
1879  *
1880  *	RETURNS:
1881  *	Returns 0.
1882  */
1883 static int
1884 smsc_detach(device_t dev)
1885 {
1886 	struct smsc_softc *sc = device_get_softc(dev);
1887 	struct usb_ether *ue = &sc->sc_ue;
1888 
1889 	usbd_transfer_unsetup(sc->sc_xfer, SMSC_N_TRANSFER);
1890 	uether_ifdetach(ue);
1891 	mtx_destroy(&sc->sc_mtx);
1892 
1893 	return (0);
1894 }
1895 
1896 static device_method_t smsc_methods[] = {
1897 	/* Device interface */
1898 	DEVMETHOD(device_probe, smsc_probe),
1899 	DEVMETHOD(device_attach, smsc_attach),
1900 	DEVMETHOD(device_detach, smsc_detach),
1901 
1902 	/* bus interface */
1903 	DEVMETHOD(bus_print_child, bus_generic_print_child),
1904 	DEVMETHOD(bus_driver_added, bus_generic_driver_added),
1905 
1906 	/* MII interface */
1907 	DEVMETHOD(miibus_readreg, smsc_miibus_readreg),
1908 	DEVMETHOD(miibus_writereg, smsc_miibus_writereg),
1909 	DEVMETHOD(miibus_statchg, smsc_miibus_statchg),
1910 
1911 	DEVMETHOD_END
1912 };
1913 
1914 static driver_t smsc_driver = {
1915 	.name = "smsc",
1916 	.methods = smsc_methods,
1917 	.size = sizeof(struct smsc_softc),
1918 };
1919 
1920 static devclass_t smsc_devclass;
1921 
1922 DRIVER_MODULE(smsc, uhub, smsc_driver, smsc_devclass, NULL, 0);
1923 DRIVER_MODULE(miibus, smsc, miibus_driver, miibus_devclass, 0, 0);
1924 MODULE_DEPEND(smsc, uether, 1, 1, 1);
1925 MODULE_DEPEND(smsc, usb, 1, 1, 1);
1926 MODULE_DEPEND(smsc, ether, 1, 1, 1);
1927 MODULE_DEPEND(smsc, miibus, 1, 1, 1);
1928 MODULE_VERSION(smsc, 1);
1929 USB_PNP_HOST_INFO(smsc_devs);
1930