xref: /freebsd/sys/dev/usb/net/if_mos.c (revision 2f513db7)
1 /*-
2  * SPDX-License-Identifier: (BSD-1-Clause AND BSD-4-Clause)
3  *
4  * Copyright (c) 2011 Rick van der Zwet <info@rickvanderzwet.nl>
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 /*-
20  * Copyright (c) 2008 Johann Christian Rode <jcrode@gmx.net>
21  *
22  * Permission to use, copy, modify, and distribute this software for any
23  * purpose with or without fee is hereby granted, provided that the above
24  * copyright notice and this permission notice appear in all copies.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
27  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
28  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
29  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
30  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
31  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
32  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
33  */
34 
35 /*-
36  * Copyright (c) 2005, 2006, 2007 Jonathan Gray <jsg@openbsd.org>
37  *
38  * Permission to use, copy, modify, and distribute this software for any
39  * purpose with or without fee is hereby granted, provided that the above
40  * copyright notice and this permission notice appear in all copies.
41  *
42  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
43  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
44  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
45  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
46  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
47  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
48  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
49  */
50 
51 /*-
52  * Copyright (c) 1997, 1998, 1999, 2000-2003
53  *	Bill Paul <wpaul@windriver.com>.  All rights reserved.
54  *
55  * Redistribution and use in source and binary forms, with or without
56  * modification, are permitted provided that the following conditions
57  * are met:
58  * 1. Redistributions of source code must retain the above copyright
59  *    notice, this list of conditions and the following disclaimer.
60  * 2. Redistributions in binary form must reproduce the above copyright
61  *    notice, this list of conditions and the following disclaimer in the
62  *    documentation and/or other materials provided with the distribution.
63  * 3. All advertising materials mentioning features or use of this software
64  *    must display the following acknowledgement:
65  *	This product includes software developed by Bill Paul.
66  * 4. Neither the name of the author nor the names of any co-contributors
67  *    may be used to endorse or promote products derived from this software
68  *    without specific prior written permission.
69  *
70  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
71  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
72  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
73  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
74  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
75  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
76  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
77  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
78  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
79  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
80  * THE POSSIBILITY OF SUCH DAMAGE.
81  */
82 
83 #include <sys/cdefs.h>
84 __FBSDID("$FreeBSD$");
85 
86 /*
87  * Moschip MCS7730/MCS7830/MCS7832 USB to Ethernet controller
88  * The datasheet is available at the following URL:
89  * http://www.moschip.com/data/products/MCS7830/Data%20Sheet_7830.pdf
90  */
91 
92 /*
93  * The FreeBSD if_mos.c driver is based on various different sources:
94  * The vendor provided driver at the following URL:
95  * http://www.moschip.com/data/products/MCS7830/Driver_FreeBSD_7830.tar.gz
96  *
97  * Mixed together with the OpenBSD if_mos.c driver for validation and checking
98  * and the FreeBSD if_reu.c as reference for the USB Ethernet framework.
99  */
100 
101 #include <sys/stdint.h>
102 #include <sys/stddef.h>
103 #include <sys/param.h>
104 #include <sys/queue.h>
105 #include <sys/types.h>
106 #include <sys/systm.h>
107 #include <sys/socket.h>
108 #include <sys/kernel.h>
109 #include <sys/bus.h>
110 #include <sys/module.h>
111 #include <sys/lock.h>
112 #include <sys/mutex.h>
113 #include <sys/condvar.h>
114 #include <sys/sysctl.h>
115 #include <sys/sx.h>
116 #include <sys/unistd.h>
117 #include <sys/callout.h>
118 #include <sys/malloc.h>
119 #include <sys/priv.h>
120 
121 #include <net/if.h>
122 #include <net/if_var.h>
123 #include <net/if_media.h>
124 
125 #include <dev/mii/mii.h>
126 #include <dev/mii/miivar.h>
127 
128 #include <dev/usb/usb.h>
129 #include <dev/usb/usbdi.h>
130 #include <dev/usb/usbdi_util.h>
131 #include "usbdevs.h"
132 
133 #define	USB_DEBUG_VAR mos_debug
134 #include <dev/usb/usb_debug.h>
135 #include <dev/usb/usb_process.h>
136 
137 #include <dev/usb/net/usb_ethernet.h>
138 
139 #include "miibus_if.h"
140 
141 //#include <dev/usb/net/if_mosreg.h>
142 #include "if_mosreg.h"
143 
144 #ifdef USB_DEBUG
145 static int mos_debug = 0;
146 
147 static SYSCTL_NODE(_hw_usb, OID_AUTO, mos, CTLFLAG_RW, 0, "USB mos");
148 SYSCTL_INT(_hw_usb_mos, OID_AUTO, debug, CTLFLAG_RWTUN, &mos_debug, 0,
149     "Debug level");
150 #endif
151 
152 #define MOS_DPRINTFN(fmt,...) \
153   DPRINTF("mos: %s: " fmt "\n",__FUNCTION__,## __VA_ARGS__)
154 
155 #define	USB_PRODUCT_MOSCHIP_MCS7730	0x7730
156 #define	USB_PRODUCT_SITECOMEU_LN030	0x0021
157 
158 
159 
160 /* Various supported device vendors/products. */
161 static const STRUCT_USB_HOST_ID mos_devs[] = {
162 	{USB_VPI(USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7730, MCS7730)},
163 	{USB_VPI(USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7830, MCS7830)},
164 	{USB_VPI(USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7832, MCS7832)},
165 	{USB_VPI(USB_VENDOR_SITECOMEU, USB_PRODUCT_SITECOMEU_LN030, MCS7830)},
166 };
167 
168 static int mos_probe(device_t dev);
169 static int mos_attach(device_t dev);
170 static void mos_attach_post(struct usb_ether *ue);
171 static int mos_detach(device_t dev);
172 
173 static void mos_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error);
174 static void mos_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error);
175 static void mos_intr_callback(struct usb_xfer *xfer, usb_error_t error);
176 static void mos_tick(struct usb_ether *);
177 static void mos_start(struct usb_ether *);
178 static void mos_init(struct usb_ether *);
179 static void mos_chip_init(struct mos_softc *);
180 static void mos_stop(struct usb_ether *);
181 static int mos_miibus_readreg(device_t, int, int);
182 static int mos_miibus_writereg(device_t, int, int, int);
183 static void mos_miibus_statchg(device_t);
184 static int mos_ifmedia_upd(struct ifnet *);
185 static void mos_ifmedia_sts(struct ifnet *, struct ifmediareq *);
186 static void mos_reset(struct mos_softc *sc);
187 
188 static int mos_reg_read_1(struct mos_softc *, int);
189 static int mos_reg_read_2(struct mos_softc *, int);
190 static int mos_reg_write_1(struct mos_softc *, int, int);
191 static int mos_reg_write_2(struct mos_softc *, int, int);
192 static int mos_readmac(struct mos_softc *, uint8_t *);
193 static int mos_writemac(struct mos_softc *, uint8_t *);
194 static int mos_write_mcast(struct mos_softc *, u_char *);
195 
196 static void mos_setmulti(struct usb_ether *);
197 static void mos_setpromisc(struct usb_ether *);
198 
199 static const struct usb_config mos_config[MOS_ENDPT_MAX] = {
200 
201 	[MOS_ENDPT_TX] = {
202 		.type = UE_BULK,
203 		.endpoint = UE_ADDR_ANY,
204 		.direction = UE_DIR_OUT,
205 		.bufsize = (MCLBYTES + 2),
206 		.flags = {.pipe_bof = 1,.force_short_xfer = 1,},
207 		.callback = mos_bulk_write_callback,
208 		.timeout = 10000,
209 	},
210 
211 	[MOS_ENDPT_RX] = {
212 		.type = UE_BULK,
213 		.endpoint = UE_ADDR_ANY,
214 		.direction = UE_DIR_IN,
215 		.bufsize = (MCLBYTES + 4 + ETHER_CRC_LEN),
216 		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
217 		.callback = mos_bulk_read_callback,
218 	},
219 
220 	[MOS_ENDPT_INTR] = {
221 		.type = UE_INTERRUPT,
222 		.endpoint = UE_ADDR_ANY,
223 		.direction = UE_DIR_IN,
224 		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
225 		.bufsize = 0,
226 		.callback = mos_intr_callback,
227 	},
228 };
229 
230 static device_method_t mos_methods[] = {
231 	/* Device interface */
232 	DEVMETHOD(device_probe, mos_probe),
233 	DEVMETHOD(device_attach, mos_attach),
234 	DEVMETHOD(device_detach, mos_detach),
235 
236 	/* MII interface */
237 	DEVMETHOD(miibus_readreg, mos_miibus_readreg),
238 	DEVMETHOD(miibus_writereg, mos_miibus_writereg),
239 	DEVMETHOD(miibus_statchg, mos_miibus_statchg),
240 
241 	DEVMETHOD_END
242 };
243 
244 static driver_t mos_driver = {
245 	.name = "mos",
246 	.methods = mos_methods,
247 	.size = sizeof(struct mos_softc)
248 };
249 
250 static devclass_t mos_devclass;
251 
252 DRIVER_MODULE(mos, uhub, mos_driver, mos_devclass, NULL, 0);
253 DRIVER_MODULE(miibus, mos, miibus_driver, miibus_devclass, 0, 0);
254 MODULE_DEPEND(mos, uether, 1, 1, 1);
255 MODULE_DEPEND(mos, usb, 1, 1, 1);
256 MODULE_DEPEND(mos, ether, 1, 1, 1);
257 MODULE_DEPEND(mos, miibus, 1, 1, 1);
258 USB_PNP_HOST_INFO(mos_devs);
259 
260 static const struct usb_ether_methods mos_ue_methods = {
261 	.ue_attach_post = mos_attach_post,
262 	.ue_start = mos_start,
263 	.ue_init = mos_init,
264 	.ue_stop = mos_stop,
265 	.ue_tick = mos_tick,
266 	.ue_setmulti = mos_setmulti,
267 	.ue_setpromisc = mos_setpromisc,
268 	.ue_mii_upd = mos_ifmedia_upd,
269 	.ue_mii_sts = mos_ifmedia_sts,
270 };
271 
272 
273 static int
274 mos_reg_read_1(struct mos_softc *sc, int reg)
275 {
276 	struct usb_device_request req;
277 	usb_error_t err;
278 	uByte val = 0;
279 
280 	req.bmRequestType = UT_READ_VENDOR_DEVICE;
281 	req.bRequest = MOS_UR_READREG;
282 	USETW(req.wValue, 0);
283 	USETW(req.wIndex, reg);
284 	USETW(req.wLength, 1);
285 
286 	err = uether_do_request(&sc->sc_ue, &req, &val, 1000);
287 
288 	if (err) {
289 		MOS_DPRINTFN("mos_reg_read_1 error, reg: %d\n", reg);
290 		return (-1);
291 	}
292 	return (val);
293 }
294 
295 static int
296 mos_reg_read_2(struct mos_softc *sc, int reg)
297 {
298 	struct usb_device_request req;
299 	usb_error_t err;
300 	uWord val;
301 
302 	USETW(val, 0);
303 
304 	req.bmRequestType = UT_READ_VENDOR_DEVICE;
305 	req.bRequest = MOS_UR_READREG;
306 	USETW(req.wValue, 0);
307 	USETW(req.wIndex, reg);
308 	USETW(req.wLength, 2);
309 
310 	err = uether_do_request(&sc->sc_ue, &req, &val, 1000);
311 
312 	if (err) {
313 		MOS_DPRINTFN("mos_reg_read_2 error, reg: %d", reg);
314 		return (-1);
315 	}
316 	return (UGETW(val));
317 }
318 
319 static int
320 mos_reg_write_1(struct mos_softc *sc, int reg, int aval)
321 {
322 	struct usb_device_request req;
323 	usb_error_t err;
324 	uByte val;
325 	val = aval;
326 
327 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
328 	req.bRequest = MOS_UR_WRITEREG;
329 	USETW(req.wValue, 0);
330 	USETW(req.wIndex, reg);
331 	USETW(req.wLength, 1);
332 
333 	err = uether_do_request(&sc->sc_ue, &req, &val, 1000);
334 
335 	if (err) {
336 		MOS_DPRINTFN("mos_reg_write_1 error, reg: %d", reg);
337 		return (-1);
338 	}
339 	return (0);
340 }
341 
342 static int
343 mos_reg_write_2(struct mos_softc *sc, int reg, int aval)
344 {
345 	struct usb_device_request req;
346 	usb_error_t err;
347 	uWord val;
348 
349 	USETW(val, aval);
350 
351 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
352 	req.bRequest = MOS_UR_WRITEREG;
353 	USETW(req.wValue, 0);
354 	USETW(req.wIndex, reg);
355 	USETW(req.wLength, 2);
356 
357 	err = uether_do_request(&sc->sc_ue, &req, &val, 1000);
358 
359 	if (err) {
360 		MOS_DPRINTFN("mos_reg_write_2 error, reg: %d", reg);
361 		return (-1);
362 	}
363 	return (0);
364 }
365 
366 static int
367 mos_readmac(struct mos_softc *sc, u_char *mac)
368 {
369 	struct usb_device_request req;
370 	usb_error_t err;
371 
372 	req.bmRequestType = UT_READ_VENDOR_DEVICE;
373 	req.bRequest = MOS_UR_READREG;
374 	USETW(req.wValue, 0);
375 	USETW(req.wIndex, MOS_MAC);
376 	USETW(req.wLength, ETHER_ADDR_LEN);
377 
378 	err = uether_do_request(&sc->sc_ue, &req, mac, 1000);
379 
380 	if (err) {
381 		return (-1);
382 	}
383 	return (0);
384 }
385 
386 static int
387 mos_writemac(struct mos_softc *sc, uint8_t *mac)
388 {
389 	struct usb_device_request req;
390 	usb_error_t err;
391 
392 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
393 	req.bRequest = MOS_UR_WRITEREG;
394 	USETW(req.wValue, 0);
395 	USETW(req.wIndex, MOS_MAC);
396 	USETW(req.wLength, ETHER_ADDR_LEN);
397 
398 	err = uether_do_request(&sc->sc_ue, &req, mac, 1000);
399 
400 	if (err) {
401 		MOS_DPRINTFN("mos_writemac error");
402 		return (-1);
403 	}
404 	return (0);
405 }
406 
407 static int
408 mos_write_mcast(struct mos_softc *sc, u_char *hashtbl)
409 {
410 	struct usb_device_request req;
411 	usb_error_t err;
412 
413 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
414 	req.bRequest = MOS_UR_WRITEREG;
415 	USETW(req.wValue, 0);
416 	USETW(req.wIndex, MOS_MCAST_TABLE);
417 	USETW(req.wLength, 8);
418 
419 	err = uether_do_request(&sc->sc_ue, &req, hashtbl, 1000);
420 
421 	if (err) {
422 		MOS_DPRINTFN("mos_reg_mcast error");
423 		return (-1);
424 	}
425 	return (0);
426 }
427 
428 static int
429 mos_miibus_readreg(device_t dev, int phy, int reg)
430 {
431 	struct mos_softc *sc = device_get_softc(dev);
432 	uWord val;
433 	int i, res, locked;
434 
435 	USETW(val, 0);
436 
437 	locked = mtx_owned(&sc->sc_mtx);
438 	if (!locked)
439 		MOS_LOCK(sc);
440 
441 	mos_reg_write_2(sc, MOS_PHY_DATA, 0);
442 	mos_reg_write_1(sc, MOS_PHY_CTL, (phy & MOS_PHYCTL_PHYADDR) |
443 	    MOS_PHYCTL_READ);
444 	mos_reg_write_1(sc, MOS_PHY_STS, (reg & MOS_PHYSTS_PHYREG) |
445 	    MOS_PHYSTS_PENDING);
446 
447 	for (i = 0; i < MOS_TIMEOUT; i++) {
448 		if (mos_reg_read_1(sc, MOS_PHY_STS) & MOS_PHYSTS_READY)
449 			break;
450 	}
451 	if (i == MOS_TIMEOUT) {
452 		MOS_DPRINTFN("MII read timeout");
453 	}
454 	res = mos_reg_read_2(sc, MOS_PHY_DATA);
455 
456 	if (!locked)
457 		MOS_UNLOCK(sc);
458 	return (res);
459 }
460 
461 static int
462 mos_miibus_writereg(device_t dev, int phy, int reg, int val)
463 {
464 	struct mos_softc *sc = device_get_softc(dev);
465 	int i, locked;
466 
467 	locked = mtx_owned(&sc->sc_mtx);
468 	if (!locked)
469 		MOS_LOCK(sc);
470 
471 	mos_reg_write_2(sc, MOS_PHY_DATA, val);
472 	mos_reg_write_1(sc, MOS_PHY_CTL, (phy & MOS_PHYCTL_PHYADDR) |
473 	    MOS_PHYCTL_WRITE);
474 	mos_reg_write_1(sc, MOS_PHY_STS, (reg & MOS_PHYSTS_PHYREG) |
475 	    MOS_PHYSTS_PENDING);
476 
477 	for (i = 0; i < MOS_TIMEOUT; i++) {
478 		if (mos_reg_read_1(sc, MOS_PHY_STS) & MOS_PHYSTS_READY)
479 			break;
480 	}
481 	if (i == MOS_TIMEOUT)
482 		MOS_DPRINTFN("MII write timeout");
483 
484 	if (!locked)
485 		MOS_UNLOCK(sc);
486 	return 0;
487 }
488 
489 static void
490 mos_miibus_statchg(device_t dev)
491 {
492 	struct mos_softc *sc = device_get_softc(dev);
493 	struct mii_data *mii = GET_MII(sc);
494 	int val, err, locked;
495 
496 	locked = mtx_owned(&sc->sc_mtx);
497 	if (!locked)
498 		MOS_LOCK(sc);
499 
500 	/* disable RX, TX prior to changing FDX, SPEEDSEL */
501 	val = mos_reg_read_1(sc, MOS_CTL);
502 	val &= ~(MOS_CTL_TX_ENB | MOS_CTL_RX_ENB);
503 	mos_reg_write_1(sc, MOS_CTL, val);
504 
505 	/* reset register which counts dropped frames */
506 	mos_reg_write_1(sc, MOS_FRAME_DROP_CNT, 0);
507 
508 	if ((mii->mii_media_active & IFM_GMASK) == IFM_FDX)
509 		val |= MOS_CTL_FDX_ENB;
510 	else
511 		val &= ~(MOS_CTL_FDX_ENB);
512 
513 	switch (IFM_SUBTYPE(mii->mii_media_active)) {
514 	case IFM_100_TX:
515 		val |= MOS_CTL_SPEEDSEL;
516 		break;
517 	case IFM_10_T:
518 		val &= ~(MOS_CTL_SPEEDSEL);
519 		break;
520 	}
521 
522 	/* re-enable TX, RX */
523 	val |= (MOS_CTL_TX_ENB | MOS_CTL_RX_ENB);
524 	err = mos_reg_write_1(sc, MOS_CTL, val);
525 
526 	if (err)
527 		MOS_DPRINTFN("media change failed");
528 
529 	if (!locked)
530 		MOS_UNLOCK(sc);
531 }
532 
533 /*
534  * Set media options.
535  */
536 static int
537 mos_ifmedia_upd(struct ifnet *ifp)
538 {
539 	struct mos_softc *sc = ifp->if_softc;
540 	struct mii_data *mii = GET_MII(sc);
541 	struct mii_softc *miisc;
542 	int error;
543 
544 	MOS_LOCK_ASSERT(sc, MA_OWNED);
545 
546 	sc->mos_link = 0;
547 	LIST_FOREACH(miisc, &mii->mii_phys, mii_list)
548 		PHY_RESET(miisc);
549 	error = mii_mediachg(mii);
550 	return (error);
551 }
552 
553 /*
554  * Report current media status.
555  */
556 static void
557 mos_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr)
558 {
559 	struct mos_softc *sc = ifp->if_softc;
560 	struct mii_data *mii = GET_MII(sc);
561 
562 	MOS_LOCK(sc);
563 	mii_pollstat(mii);
564 
565 	ifmr->ifm_active = mii->mii_media_active;
566 	ifmr->ifm_status = mii->mii_media_status;
567 	MOS_UNLOCK(sc);
568 }
569 
570 static void
571 mos_setpromisc(struct usb_ether *ue)
572 {
573 	struct mos_softc *sc = uether_getsc(ue);
574 	struct ifnet *ifp = uether_getifp(ue);
575 
576 	uint8_t rxmode;
577 
578 	MOS_LOCK_ASSERT(sc, MA_OWNED);
579 
580 	rxmode = mos_reg_read_1(sc, MOS_CTL);
581 
582 	/* If we want promiscuous mode, set the allframes bit. */
583 	if (ifp->if_flags & IFF_PROMISC) {
584 		rxmode |= MOS_CTL_RX_PROMISC;
585 	} else {
586 		rxmode &= ~MOS_CTL_RX_PROMISC;
587 	}
588 
589 	mos_reg_write_1(sc, MOS_CTL, rxmode);
590 }
591 
592 static u_int
593 mos_hash_maddr(void *arg, struct sockaddr_dl *sdl, u_int cnt)
594 {
595 	uint8_t *hashtbl = arg;
596 	uint32_t h;
597 
598 	h = ether_crc32_be(LLADDR(sdl), ETHER_ADDR_LEN) >> 26;
599 	hashtbl[h / 8] |= 1 << (h % 8);
600 
601 	return (1);
602 }
603 
604 static void
605 mos_setmulti(struct usb_ether *ue)
606 {
607 	struct mos_softc *sc = uether_getsc(ue);
608 	struct ifnet *ifp = uether_getifp(ue);
609 	uint8_t rxmode;
610 	uint8_t hashtbl[8] = {0, 0, 0, 0, 0, 0, 0, 0};
611 	int allmulti = 0;
612 
613 	MOS_LOCK_ASSERT(sc, MA_OWNED);
614 
615 	rxmode = mos_reg_read_1(sc, MOS_CTL);
616 
617 	if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC)
618 		allmulti = 1;
619 
620 	/* get all new ones */
621 	if_foreach_llmaddr(ifp, mos_hash_maddr, &hashtbl);
622 
623 	/* now program new ones */
624 	if (allmulti == 1) {
625 		rxmode |= MOS_CTL_ALLMULTI;
626 		mos_reg_write_1(sc, MOS_CTL, rxmode);
627 	} else {
628 		rxmode &= ~MOS_CTL_ALLMULTI;
629 		mos_write_mcast(sc, (void *)&hashtbl);
630 		mos_reg_write_1(sc, MOS_CTL, rxmode);
631 	}
632 }
633 
634 static void
635 mos_reset(struct mos_softc *sc)
636 {
637 	uint8_t ctl;
638 
639 	ctl = mos_reg_read_1(sc, MOS_CTL);
640 	ctl &= ~(MOS_CTL_RX_PROMISC | MOS_CTL_ALLMULTI | MOS_CTL_TX_ENB |
641 	    MOS_CTL_RX_ENB);
642 	/* Disable RX, TX, promiscuous and allmulticast mode */
643 	mos_reg_write_1(sc, MOS_CTL, ctl);
644 
645 	/* Reset frame drop counter register to zero */
646 	mos_reg_write_1(sc, MOS_FRAME_DROP_CNT, 0);
647 
648 	/* Wait a little while for the chip to get its brains in order. */
649 	usb_pause_mtx(&sc->sc_mtx, hz / 128);
650 	return;
651 }
652 
653 static void
654 mos_chip_init(struct mos_softc *sc)
655 {
656 	int i;
657 
658 	/*
659 	 * Rev.C devices have a pause threshold register which needs to be set
660 	 * at startup.
661 	 */
662 	if (mos_reg_read_1(sc, MOS_PAUSE_TRHD) != -1) {
663 		for (i = 0; i < MOS_PAUSE_REWRITES; i++)
664 			mos_reg_write_1(sc, MOS_PAUSE_TRHD, 0);
665 	}
666 	sc->mos_phyaddrs[0] = 1;
667 	sc->mos_phyaddrs[1] = 0xFF;
668 }
669 
670 /*
671  * Probe for a MCS7x30 chip.
672  */
673 static int
674 mos_probe(device_t dev)
675 {
676 	struct usb_attach_arg *uaa = device_get_ivars(dev);
677         int retval;
678 
679 	if (uaa->usb_mode != USB_MODE_HOST)
680 		return (ENXIO);
681 	if (uaa->info.bConfigIndex != MOS_CONFIG_IDX)
682 		return (ENXIO);
683 	if (uaa->info.bIfaceIndex != MOS_IFACE_IDX)
684 		return (ENXIO);
685 
686 	retval = usbd_lookup_id_by_uaa(mos_devs, sizeof(mos_devs), uaa);
687 	return (retval);
688 }
689 
690 /*
691  * Attach the interface. Allocate softc structures, do ifmedia
692  * setup and ethernet/BPF attach.
693  */
694 static int
695 mos_attach(device_t dev)
696 {
697 	struct usb_attach_arg *uaa = device_get_ivars(dev);
698 	struct mos_softc *sc = device_get_softc(dev);
699 	struct usb_ether *ue = &sc->sc_ue;
700 	uint8_t iface_index;
701 	int error;
702 
703 	sc->mos_flags = USB_GET_DRIVER_INFO(uaa);
704 
705 	device_set_usb_desc(dev);
706 	mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
707 
708 	iface_index = MOS_IFACE_IDX;
709 	error = usbd_transfer_setup(uaa->device, &iface_index,
710 	    sc->sc_xfer, mos_config, MOS_ENDPT_MAX,
711 	    sc, &sc->sc_mtx);
712 
713 	if (error) {
714 		device_printf(dev, "allocating USB transfers failed\n");
715 		goto detach;
716 	}
717 	ue->ue_sc = sc;
718 	ue->ue_dev = dev;
719 	ue->ue_udev = uaa->device;
720 	ue->ue_mtx = &sc->sc_mtx;
721 	ue->ue_methods = &mos_ue_methods;
722 
723 
724 	if (sc->mos_flags & MCS7730) {
725 		MOS_DPRINTFN("model: MCS7730");
726 	} else if (sc->mos_flags & MCS7830) {
727 		MOS_DPRINTFN("model: MCS7830");
728 	} else if (sc->mos_flags & MCS7832) {
729 		MOS_DPRINTFN("model: MCS7832");
730 	}
731 	error = uether_ifattach(ue);
732 	if (error) {
733 		device_printf(dev, "could not attach interface\n");
734 		goto detach;
735 	}
736 	return (0);
737 
738 
739 detach:
740 	mos_detach(dev);
741 	return (ENXIO);
742 }
743 
744 
745 static void
746 mos_attach_post(struct usb_ether *ue)
747 {
748 	struct mos_softc *sc = uether_getsc(ue);
749         int err;
750 
751 	/* Read MAC address, inform the world. */
752 	err = mos_readmac(sc, ue->ue_eaddr);
753 
754 	if (err)
755 	  MOS_DPRINTFN("couldn't get MAC address");
756 
757 	MOS_DPRINTFN("address: %s", ether_sprintf(ue->ue_eaddr));
758 
759 	mos_chip_init(sc);
760 }
761 
762 static int
763 mos_detach(device_t dev)
764 {
765 	struct mos_softc *sc = device_get_softc(dev);
766 	struct usb_ether *ue = &sc->sc_ue;
767 
768 	usbd_transfer_unsetup(sc->sc_xfer, MOS_ENDPT_MAX);
769 	uether_ifdetach(ue);
770 	mtx_destroy(&sc->sc_mtx);
771 
772 	return (0);
773 }
774 
775 
776 
777 
778 /*
779  * A frame has been uploaded: pass the resulting mbuf chain up to
780  * the higher level protocols.
781  */
782 static void
783 mos_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
784 {
785 	struct mos_softc *sc = usbd_xfer_softc(xfer);
786 	struct usb_ether *ue = &sc->sc_ue;
787 	struct ifnet *ifp = uether_getifp(ue);
788 
789 	uint8_t rxstat = 0;
790 	uint32_t actlen;
791 	uint16_t pktlen = 0;
792 	struct usb_page_cache *pc;
793 
794 	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
795 	pc = usbd_xfer_get_frame(xfer, 0);
796 
797 	switch (USB_GET_STATE(xfer)) {
798 	case USB_ST_TRANSFERRED:
799 		MOS_DPRINTFN("actlen : %d", actlen);
800 		if (actlen <= 1) {
801 			if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
802 			goto tr_setup;
803 		}
804 		/* evaluate status byte at the end */
805 		usbd_copy_out(pc, actlen - sizeof(rxstat), &rxstat,
806 		    sizeof(rxstat));
807 
808 		if (rxstat != MOS_RXSTS_VALID) {
809 			MOS_DPRINTFN("erroneous frame received");
810 			if (rxstat & MOS_RXSTS_SHORT_FRAME)
811 				MOS_DPRINTFN("frame size less than 64 bytes");
812 			if (rxstat & MOS_RXSTS_LARGE_FRAME) {
813 				MOS_DPRINTFN("frame size larger than "
814 				    "1532 bytes");
815 			}
816 			if (rxstat & MOS_RXSTS_CRC_ERROR)
817 				MOS_DPRINTFN("CRC error");
818 			if (rxstat & MOS_RXSTS_ALIGN_ERROR)
819 				MOS_DPRINTFN("alignment error");
820 			if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
821 			goto tr_setup;
822 		}
823 		/* Remember the last byte was used for the status fields */
824 		pktlen = actlen - 1;
825 		if (pktlen < sizeof(struct ether_header)) {
826 			MOS_DPRINTFN("error: pktlen %d is smaller "
827 			    "than ether_header %zd", pktlen,
828 			    sizeof(struct ether_header));
829 			if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
830 			goto tr_setup;
831 		}
832 		uether_rxbuf(ue, pc, 0, actlen);
833 		/* FALLTHROUGH */
834 	case USB_ST_SETUP:
835 tr_setup:
836 		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
837 		usbd_transfer_submit(xfer);
838 		uether_rxflush(ue);
839 		return;
840 	default:
841 		MOS_DPRINTFN("bulk read error, %s", usbd_errstr(error));
842 		if (error != USB_ERR_CANCELLED) {
843 			usbd_xfer_set_stall(xfer);
844 			goto tr_setup;
845 		}
846 		MOS_DPRINTFN("start rx %i", usbd_xfer_max_len(xfer));
847 		return;
848 	}
849 }
850 
851 /*
852  * A frame was downloaded to the chip. It's safe for us to clean up
853  * the list buffers.
854  */
855 static void
856 mos_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
857 {
858 	struct mos_softc *sc = usbd_xfer_softc(xfer);
859 	struct ifnet *ifp = uether_getifp(&sc->sc_ue);
860 	struct usb_page_cache *pc;
861 	struct mbuf *m;
862 
863 
864 
865 	switch (USB_GET_STATE(xfer)) {
866 	case USB_ST_TRANSFERRED:
867 		MOS_DPRINTFN("transfer of complete");
868 		if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
869 		/* FALLTHROUGH */
870 	case USB_ST_SETUP:
871 tr_setup:
872 		/*
873 		 * XXX: don't send anything if there is no link?
874 		 */
875 		IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
876 		if (m == NULL)
877 			return;
878 
879 		pc = usbd_xfer_get_frame(xfer, 0);
880 		usbd_m_copy_in(pc, 0, m, 0, m->m_pkthdr.len);
881 
882 		usbd_xfer_set_frame_len(xfer, 0, m->m_pkthdr.len);
883 
884 
885 		/*
886 		 * if there's a BPF listener, bounce a copy
887 		 * of this frame to him:
888 		 */
889 		BPF_MTAP(ifp, m);
890 
891 		m_freem(m);
892 
893 		usbd_transfer_submit(xfer);
894 
895 		if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
896 		return;
897 	default:
898 		MOS_DPRINTFN("usb error on tx: %s\n", usbd_errstr(error));
899 		if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
900 		if (error != USB_ERR_CANCELLED) {
901 			usbd_xfer_set_stall(xfer);
902 			goto tr_setup;
903 		}
904 		return;
905 	}
906 }
907 
908 static void
909 mos_tick(struct usb_ether *ue)
910 {
911 	struct mos_softc *sc = uether_getsc(ue);
912 	struct mii_data *mii = GET_MII(sc);
913 
914 	MOS_LOCK_ASSERT(sc, MA_OWNED);
915 
916 	mii_tick(mii);
917 	if (!sc->mos_link && mii->mii_media_status & IFM_ACTIVE &&
918 	    IFM_SUBTYPE(mii->mii_media_active) != IFM_NONE) {
919 		MOS_DPRINTFN("got link");
920 		sc->mos_link++;
921 		mos_start(ue);
922 	}
923 }
924 
925 
926 static void
927 mos_start(struct usb_ether *ue)
928 {
929 	struct mos_softc *sc = uether_getsc(ue);
930 
931 	/*
932 	 * start the USB transfers, if not already started:
933 	 */
934 	usbd_transfer_start(sc->sc_xfer[MOS_ENDPT_TX]);
935 	usbd_transfer_start(sc->sc_xfer[MOS_ENDPT_RX]);
936 	usbd_transfer_start(sc->sc_xfer[MOS_ENDPT_INTR]);
937 }
938 
939 static void
940 mos_init(struct usb_ether *ue)
941 {
942 	struct mos_softc *sc = uether_getsc(ue);
943 	struct ifnet *ifp = uether_getifp(ue);
944 	uint8_t rxmode;
945 
946 	MOS_LOCK_ASSERT(sc, MA_OWNED);
947 
948 	/* Cancel pending I/O and free all RX/TX buffers. */
949 	mos_reset(sc);
950 
951 	/* Write MAC address */
952 	mos_writemac(sc, IF_LLADDR(ifp));
953 
954 	/* Read and set transmitter IPG values */
955 	sc->mos_ipgs[0] = mos_reg_read_1(sc, MOS_IPG0);
956 	sc->mos_ipgs[1] = mos_reg_read_1(sc, MOS_IPG1);
957 	mos_reg_write_1(sc, MOS_IPG0, sc->mos_ipgs[0]);
958 	mos_reg_write_1(sc, MOS_IPG1, sc->mos_ipgs[1]);
959 
960 	/*
961 	 * Enable receiver and transmitter, bridge controls speed/duplex
962 	 * mode
963 	 */
964 	rxmode = mos_reg_read_1(sc, MOS_CTL);
965 	rxmode |= MOS_CTL_RX_ENB | MOS_CTL_TX_ENB | MOS_CTL_BS_ENB;
966 	rxmode &= ~(MOS_CTL_SLEEP);
967 
968 	mos_setpromisc(ue);
969 
970 	/* XXX: broadcast mode? */
971 	mos_reg_write_1(sc, MOS_CTL, rxmode);
972 
973 	/* Load the multicast filter. */
974 	mos_setmulti(ue);
975 
976 	ifp->if_drv_flags |= IFF_DRV_RUNNING;
977 	mos_start(ue);
978 }
979 
980 
981 static void
982 mos_intr_callback(struct usb_xfer *xfer, usb_error_t error)
983 {
984 	struct mos_softc *sc = usbd_xfer_softc(xfer);
985 	struct ifnet *ifp = uether_getifp(&sc->sc_ue);
986 	struct usb_page_cache *pc;
987 	uint32_t pkt;
988 	int actlen;
989 
990 	if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
991 
992 	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
993 	MOS_DPRINTFN("actlen %i", actlen);
994 
995 	switch (USB_GET_STATE(xfer)) {
996 	case USB_ST_TRANSFERRED:
997 
998 		pc = usbd_xfer_get_frame(xfer, 0);
999 		usbd_copy_out(pc, 0, &pkt, sizeof(pkt));
1000 		/* FALLTHROUGH */
1001 	case USB_ST_SETUP:
1002 tr_setup:
1003 		return;
1004 	default:
1005 		if (error != USB_ERR_CANCELLED) {
1006 			usbd_xfer_set_stall(xfer);
1007 			goto tr_setup;
1008 		}
1009 		return;
1010 	}
1011 }
1012 
1013 
1014 /*
1015  * Stop the adapter and free any mbufs allocated to the
1016  * RX and TX lists.
1017  */
1018 static void
1019 mos_stop(struct usb_ether *ue)
1020 {
1021 	struct mos_softc *sc = uether_getsc(ue);
1022 	struct ifnet *ifp = uether_getifp(ue);
1023 
1024 	mos_reset(sc);
1025 
1026 	MOS_LOCK_ASSERT(sc, MA_OWNED);
1027 	ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
1028 
1029 	/* stop all the transfers, if not already stopped */
1030 	usbd_transfer_stop(sc->sc_xfer[MOS_ENDPT_TX]);
1031 	usbd_transfer_stop(sc->sc_xfer[MOS_ENDPT_RX]);
1032 	usbd_transfer_stop(sc->sc_xfer[MOS_ENDPT_INTR]);
1033 
1034 	sc->mos_link = 0;
1035 }
1036