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