if_mos.c revision 218765
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: head/sys/dev/usb/net/if_mos.c 218765 2011-02-17 07:39:53Z hselasky $");
83
84/*
85 * Moschip MCS7730/MCS7830 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/linker_set.h>
108#include <sys/module.h>
109#include <sys/lock.h>
110#include <sys/mutex.h>
111#include <sys/condvar.h>
112#include <sys/sysctl.h>
113#include <sys/sx.h>
114#include <sys/unistd.h>
115#include <sys/callout.h>
116#include <sys/malloc.h>
117#include <sys/priv.h>
118
119#include <dev/usb/usb.h>
120#include <dev/usb/usbdi.h>
121#include <dev/usb/usbdi_util.h>
122#include "usbdevs.h"
123
124#define	USB_DEBUG_VAR mos_debug
125#include <dev/usb/usb_debug.h>
126#include <dev/usb/usb_process.h>
127
128#include <dev/usb/net/usb_ethernet.h>
129
130//#include <dev/usb/net/if_mosreg.h>
131#include "if_mosreg.h"
132
133#ifdef USB_DEBUG
134static int mos_debug = 0;
135
136SYSCTL_NODE(_hw_usb, OID_AUTO, mos, CTLFLAG_RW, 0, "USB mos");
137SYSCTL_INT(_hw_usb_mos, OID_AUTO, debug, CTLFLAG_RW, &mos_debug, 0,
138    "Debug level");
139#endif
140
141#define MOS_DPRINTFN(fmt,...) \
142  DPRINTF("mos: %s: " fmt "\n",__FUNCTION__,## __VA_ARGS__)
143
144#define	USB_PRODUCT_MOSCHIP_MCS7730	0x7730
145#define	USB_PRODUCT_SITECOMEU_LN030	0x0021
146
147
148
149/* Various supported device vendors/products. */
150static const struct usb_device_id mos_devs[] = {
151	{USB_VPI(USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7730, MCS7730)},
152	{USB_VPI(USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7830, MCS7830)},
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	/* bus interface */
225	DEVMETHOD(bus_print_child, bus_generic_print_child),
226	DEVMETHOD(bus_driver_added, bus_generic_driver_added),
227
228	/* MII interface */
229	DEVMETHOD(miibus_readreg, mos_miibus_readreg),
230	DEVMETHOD(miibus_writereg, mos_miibus_writereg),
231	DEVMETHOD(miibus_statchg, mos_miibus_statchg),
232
233	{0, 0}
234};
235
236static driver_t mos_driver = {
237	.name = "mos",
238	.methods = mos_methods,
239	.size = sizeof(struct mos_softc)
240};
241
242static devclass_t mos_devclass;
243
244DRIVER_MODULE(mos, uhub, mos_driver, mos_devclass, NULL, 0);
245DRIVER_MODULE(miibus, mos, miibus_driver, miibus_devclass, 0, 0);
246MODULE_DEPEND(mos, uether, 1, 1, 1);
247MODULE_DEPEND(mos, usb, 1, 1, 1);
248MODULE_DEPEND(mos, ether, 1, 1, 1);
249MODULE_DEPEND(mos, miibus, 1, 1, 1);
250
251static const struct usb_ether_methods mos_ue_methods = {
252	.ue_attach_post = mos_attach_post,
253	.ue_start = mos_start,
254	.ue_init = mos_init,
255	.ue_stop = mos_stop,
256	.ue_tick = mos_tick,
257	.ue_setmulti = mos_setmulti,
258	.ue_setpromisc = mos_setpromisc,
259	.ue_mii_upd = mos_ifmedia_upd,
260	.ue_mii_sts = mos_ifmedia_sts,
261};
262
263
264static int
265mos_reg_read_1(struct mos_softc *sc, int reg)
266{
267	struct usb_device_request req;
268	usb_error_t err;
269	uByte val = 0;
270
271	req.bmRequestType = UT_READ_VENDOR_DEVICE;
272	req.bRequest = MOS_UR_READREG;
273	USETW(req.wValue, 0);
274	USETW(req.wIndex, reg);
275	USETW(req.wLength, 1);
276
277	err = uether_do_request(&sc->sc_ue, &req, &val, 1000);
278
279	if (err) {
280		MOS_DPRINTFN("mos_reg_read_1 error, reg: %d\n", reg);
281		return (-1);
282	}
283	return (val);
284}
285
286static int
287mos_reg_read_2(struct mos_softc *sc, int reg)
288{
289	struct usb_device_request req;
290	usb_error_t err;
291	uWord val;
292
293	USETW(val, 0);
294
295	req.bmRequestType = UT_READ_VENDOR_DEVICE;
296	req.bRequest = MOS_UR_READREG;
297	USETW(req.wValue, 0);
298	USETW(req.wIndex, reg);
299	USETW(req.wLength, 2);
300
301	err = uether_do_request(&sc->sc_ue, &req, &val, 1000);
302
303	if (err) {
304		MOS_DPRINTFN("mos_reg_read_2 error, reg: %d", reg);
305		return (-1);
306	}
307	return (UGETW(val));
308}
309
310static int
311mos_reg_write_1(struct mos_softc *sc, int reg, int aval)
312{
313	struct usb_device_request req;
314	usb_error_t err;
315	uByte val;
316	val = aval;
317
318	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
319	req.bRequest = MOS_UR_WRITEREG;
320	USETW(req.wValue, 0);
321	USETW(req.wIndex, reg);
322	USETW(req.wLength, 1);
323
324	err = uether_do_request(&sc->sc_ue, &req, &val, 1000);
325
326	if (err) {
327		MOS_DPRINTFN("mos_reg_write_1 error, reg: %d", reg);
328		return (-1);
329	}
330	return (0);
331}
332
333static int
334mos_reg_write_2(struct mos_softc *sc, int reg, int aval)
335{
336	struct usb_device_request req;
337	usb_error_t err;
338	uWord val;
339
340	USETW(val, aval);
341
342	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
343	req.bRequest = MOS_UR_WRITEREG;
344	USETW(req.wValue, 0);
345	USETW(req.wIndex, reg);
346	USETW(req.wLength, 2);
347
348	err = uether_do_request(&sc->sc_ue, &req, &val, 1000);
349
350	if (err) {
351		MOS_DPRINTFN("mos_reg_write_2 error, reg: %d", reg);
352		return (-1);
353	}
354	return (0);
355}
356
357static int
358mos_readmac(struct mos_softc *sc, u_char *mac)
359{
360	struct usb_device_request req;
361	usb_error_t err;
362
363	req.bmRequestType = UT_READ_VENDOR_DEVICE;
364	req.bRequest = MOS_UR_READREG;
365	USETW(req.wValue, 0);
366	USETW(req.wIndex, MOS_MAC);
367	USETW(req.wLength, ETHER_ADDR_LEN);
368
369	err = uether_do_request(&sc->sc_ue, &req, mac, 1000);
370
371	if (err) {
372		return (-1);
373	}
374	return (0);
375}
376
377static int
378mos_writemac(struct mos_softc *sc, uint8_t *mac)
379{
380	struct usb_device_request req;
381	usb_error_t err;
382
383	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
384	req.bRequest = MOS_UR_WRITEREG;
385	USETW(req.wValue, 0);
386	USETW(req.wIndex, MOS_MAC);
387	USETW(req.wLength, ETHER_ADDR_LEN);
388
389	err = uether_do_request(&sc->sc_ue, &req, mac, 1000);
390
391	if (err) {
392		MOS_DPRINTFN("mos_writemac error");
393		return (-1);
394	}
395	return (0);
396}
397
398static int
399mos_write_mcast(struct mos_softc *sc, u_char *hashtbl)
400{
401	struct usb_device_request req;
402	usb_error_t err;
403
404	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
405	req.bRequest = MOS_UR_WRITEREG;
406	USETW(req.wValue, 0);
407	USETW(req.wIndex, MOS_MCAST_TABLE);
408	USETW(req.wLength, 8);
409
410	err = uether_do_request(&sc->sc_ue, &req, hashtbl, 1000);
411
412	if (err) {
413		MOS_DPRINTFN("mos_reg_mcast error");
414		return (-1);
415	}
416	return (0);
417}
418
419static int
420mos_miibus_readreg(struct device *dev, int phy, int reg)
421{
422	struct mos_softc *sc = device_get_softc(dev);
423	uWord val;
424	int i, res, locked;
425
426	USETW(val, 0);
427
428	locked = mtx_owned(&sc->sc_mtx);
429	if (!locked)
430		MOS_LOCK(sc);
431
432	mos_reg_write_2(sc, MOS_PHY_DATA, 0);
433	mos_reg_write_1(sc, MOS_PHY_CTL, (phy & MOS_PHYCTL_PHYADDR) |
434	    MOS_PHYCTL_READ);
435	mos_reg_write_1(sc, MOS_PHY_STS, (reg & MOS_PHYSTS_PHYREG) |
436	    MOS_PHYSTS_PENDING);
437
438	for (i = 0; i < MOS_TIMEOUT; i++) {
439		if (mos_reg_read_1(sc, MOS_PHY_STS) & MOS_PHYSTS_READY)
440			break;
441	}
442	if (i == MOS_TIMEOUT) {
443		MOS_DPRINTFN("MII read timeout");
444	}
445	res = mos_reg_read_2(sc, MOS_PHY_DATA);
446
447	if (!locked)
448		MOS_UNLOCK(sc);
449	return (res);
450}
451
452static int
453mos_miibus_writereg(device_t dev, int phy, int reg, int val)
454{
455	struct mos_softc *sc = device_get_softc(dev);
456	int i, locked;
457
458	locked = mtx_owned(&sc->sc_mtx);
459	if (!locked)
460		MOS_LOCK(sc);
461
462	mos_reg_write_2(sc, MOS_PHY_DATA, val);
463	mos_reg_write_1(sc, MOS_PHY_CTL, (phy & MOS_PHYCTL_PHYADDR) |
464	    MOS_PHYCTL_WRITE);
465	mos_reg_write_1(sc, MOS_PHY_STS, (reg & MOS_PHYSTS_PHYREG) |
466	    MOS_PHYSTS_PENDING);
467
468	for (i = 0; i < MOS_TIMEOUT; i++) {
469		if (mos_reg_read_1(sc, MOS_PHY_STS) & MOS_PHYSTS_READY)
470			break;
471	}
472	if (i == MOS_TIMEOUT)
473		MOS_DPRINTFN("MII write timeout");
474
475	if (!locked)
476		MOS_UNLOCK(sc);
477	return 0;
478}
479
480static void
481mos_miibus_statchg(device_t dev)
482{
483	struct mos_softc *sc = device_get_softc(dev);
484	struct mii_data *mii = GET_MII(sc);
485	int val, err, locked;
486
487	locked = mtx_owned(&sc->sc_mtx);
488	if (!locked)
489		MOS_LOCK(sc);
490
491	/* disable RX, TX prior to changing FDX, SPEEDSEL */
492	val = mos_reg_read_1(sc, MOS_CTL);
493	val &= ~(MOS_CTL_TX_ENB | MOS_CTL_RX_ENB);
494	mos_reg_write_1(sc, MOS_CTL, val);
495
496	/* reset register which counts dropped frames */
497	mos_reg_write_1(sc, MOS_FRAME_DROP_CNT, 0);
498
499	if ((mii->mii_media_active & IFM_GMASK) == IFM_FDX)
500		val |= MOS_CTL_FDX_ENB;
501	else
502		val &= ~(MOS_CTL_FDX_ENB);
503
504	switch (IFM_SUBTYPE(mii->mii_media_active)) {
505	case IFM_100_TX:
506		val |= MOS_CTL_SPEEDSEL;
507		break;
508	case IFM_10_T:
509		val &= ~(MOS_CTL_SPEEDSEL);
510		break;
511	}
512
513	/* re-enable TX, RX */
514	val |= (MOS_CTL_TX_ENB | MOS_CTL_RX_ENB);
515	err = mos_reg_write_1(sc, MOS_CTL, val);
516
517	if (err)
518		MOS_DPRINTFN("media change failed");
519
520	if (!locked)
521		MOS_UNLOCK(sc);
522}
523
524/*
525 * Set media options.
526 */
527static int
528mos_ifmedia_upd(struct ifnet *ifp)
529{
530	struct mos_softc *sc = ifp->if_softc;
531	struct mii_data *mii = GET_MII(sc);
532	struct mii_softc *miisc;
533
534	MOS_LOCK_ASSERT(sc, MA_OWNED);
535
536	sc->mos_link = 0;
537	if (mii->mii_instance) {
538		LIST_FOREACH(miisc, &mii->mii_phys, mii_list)
539		    mii_phy_reset(miisc);
540	}
541	mii_mediachg(mii);
542	return (0);
543}
544
545/*
546 * Report current media status.
547 */
548static void
549mos_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr)
550{
551	struct mos_softc *sc = ifp->if_softc;
552	struct mii_data *mii = GET_MII(sc);
553
554	MOS_LOCK(sc);
555	mii_pollstat(mii);
556	MOS_UNLOCK(sc);
557
558	ifmr->ifm_active = mii->mii_media_active;
559	ifmr->ifm_status = mii->mii_media_status;
560}
561
562static void
563mos_setpromisc(struct usb_ether *ue)
564{
565	struct mos_softc *sc = uether_getsc(ue);
566	struct ifnet *ifp = uether_getifp(ue);
567
568	uint8_t rxmode;
569
570	MOS_LOCK_ASSERT(sc, MA_OWNED);
571
572	rxmode = mos_reg_read_1(sc, MOS_CTL);
573
574	/* If we want promiscuous mode, set the allframes bit. */
575	if (ifp->if_flags & IFF_PROMISC) {
576		rxmode |= MOS_CTL_RX_PROMISC;
577	} else {
578		rxmode &= ~MOS_CTL_RX_PROMISC;
579	}
580
581	mos_reg_write_1(sc, MOS_CTL, rxmode);
582}
583
584
585
586static void
587mos_setmulti(struct usb_ether *ue)
588{
589	struct mos_softc *sc = uether_getsc(ue);
590	struct ifnet *ifp = uether_getifp(ue);
591	struct ifmultiaddr *ifma;
592
593	uint32_t h = 0;
594	uint8_t rxmode;
595	uint8_t hashtbl[8] = {0, 0, 0, 0, 0, 0, 0, 0};
596	int allmulti = 0;
597
598	MOS_LOCK_ASSERT(sc, MA_OWNED);
599
600	rxmode = mos_reg_read_1(sc, MOS_CTL);
601
602	if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC)
603		allmulti = 1;
604
605	/* get all new ones */
606	if_maddr_rlock(ifp);
607	TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
608		if (ifma->ifma_addr->sa_family != AF_LINK) {
609			allmulti = 1;
610			continue;
611		};
612		h = ether_crc32_be(LLADDR((struct sockaddr_dl *)
613		    ifma->ifma_addr), ETHER_ADDR_LEN) >> 26;
614		hashtbl[h / 8] |= 1 << (h % 8);
615	}
616	if_maddr_runlock(ifp);
617
618	/* now program new ones */
619	if (allmulti == 1) {
620		rxmode |= MOS_CTL_ALLMULTI;
621		mos_reg_write_1(sc, MOS_CTL, rxmode);
622	} else {
623		rxmode &= ~MOS_CTL_ALLMULTI;
624		mos_write_mcast(sc, (void *)&hashtbl);
625		mos_reg_write_1(sc, MOS_CTL, rxmode);
626	}
627}
628
629static void
630mos_reset(struct mos_softc *sc)
631{
632	uint8_t ctl;
633
634	ctl = mos_reg_read_1(sc, MOS_CTL);
635	ctl &= ~(MOS_CTL_RX_PROMISC | MOS_CTL_ALLMULTI | MOS_CTL_TX_ENB |
636	    MOS_CTL_RX_ENB);
637	/* Disable RX, TX, promiscuous and allmulticast mode */
638	mos_reg_write_1(sc, MOS_CTL, ctl);
639
640	/* Reset frame drop counter register to zero */
641	mos_reg_write_1(sc, MOS_FRAME_DROP_CNT, 0);
642
643	/* Wait a little while for the chip to get its brains in order. */
644	usb_pause_mtx(&sc->sc_mtx, hz / 128);
645	return;
646}
647
648static void
649mos_chip_init(struct mos_softc *sc)
650{
651	int i;
652
653	/*
654	 * Rev.C devices have a pause threshold register which needs to be set
655	 * at startup.
656	 */
657	if (mos_reg_read_1(sc, MOS_PAUSE_TRHD) != -1) {
658		for (i = 0; i < MOS_PAUSE_REWRITES; i++)
659			mos_reg_write_1(sc, MOS_PAUSE_TRHD, 0);
660	}
661	sc->mos_phyaddrs[0] = 1;
662	sc->mos_phyaddrs[1] = 0xFF;
663}
664
665/*
666 * Probe for a MCS7x30 chip.
667 */
668static int
669mos_probe(device_t dev)
670{
671	struct usb_attach_arg *uaa = device_get_ivars(dev);
672        int retval;
673
674	if (uaa->usb_mode != USB_MODE_HOST)
675		return (ENXIO);
676	if (uaa->info.bConfigIndex != MOS_CONFIG_IDX)
677		return (ENXIO);
678	if (uaa->info.bIfaceIndex != MOS_IFACE_IDX)
679		return (ENXIO);
680
681	retval = usbd_lookup_id_by_uaa(mos_devs, sizeof(mos_devs), uaa);
682	return (retval);
683}
684
685/*
686 * Attach the interface. Allocate softc structures, do ifmedia
687 * setup and ethernet/BPF attach.
688 */
689static int
690mos_attach(device_t dev)
691{
692	struct usb_attach_arg *uaa = device_get_ivars(dev);
693	struct mos_softc *sc = device_get_softc(dev);
694	struct usb_ether *ue = &sc->sc_ue;
695	uint8_t iface_index;
696	int error;
697
698	sc->mos_flags = USB_GET_DRIVER_INFO(uaa);
699
700	device_set_usb_desc(dev);
701	mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
702
703	iface_index = MOS_IFACE_IDX;
704	error = usbd_transfer_setup(uaa->device, &iface_index,
705	    sc->sc_xfer, mos_config, MOS_ENDPT_MAX,
706	    sc, &sc->sc_mtx);
707
708	if (error) {
709		device_printf(dev, "allocating USB transfers failed\n");
710		goto detach;
711	}
712	ue->ue_sc = sc;
713	ue->ue_dev = dev;
714	ue->ue_udev = uaa->device;
715	ue->ue_mtx = &sc->sc_mtx;
716	ue->ue_methods = &mos_ue_methods;
717
718
719	if (sc->mos_flags & MCS7730) {
720		MOS_DPRINTFN("model: MCS7730");
721	} else if (sc->mos_flags & MCS7830) {
722		MOS_DPRINTFN("model: MCS7830");
723	}
724	error = uether_ifattach(ue);
725	if (error) {
726		device_printf(dev, "could not attach interface\n");
727		goto detach;
728	}
729	return (0);
730
731
732detach:
733	mos_detach(dev);
734	return (ENXIO);
735}
736
737
738static void
739mos_attach_post(struct usb_ether *ue)
740{
741	struct mos_softc *sc = uether_getsc(ue);
742        int err;
743
744	/* Read MAC address, inform the world. */
745	err = mos_readmac(sc, ue->ue_eaddr);
746
747	if (err)
748	  MOS_DPRINTFN("couldn't get MAC address");
749
750	MOS_DPRINTFN("address: %s", ether_sprintf(ue->ue_eaddr));
751
752	mos_chip_init(sc);
753}
754
755static int
756mos_detach(device_t dev)
757{
758	struct mos_softc *sc = device_get_softc(dev);
759	struct usb_ether *ue = &sc->sc_ue;
760
761	usbd_transfer_unsetup(sc->sc_xfer, MOS_ENDPT_MAX);
762	uether_ifdetach(ue);
763	mtx_destroy(&sc->sc_mtx);
764
765	return (0);
766}
767
768
769
770
771/*
772 * A frame has been uploaded: pass the resulting mbuf chain up to
773 * the higher level protocols.
774 */
775static void
776mos_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
777{
778	struct mos_softc *sc = usbd_xfer_softc(xfer);
779	struct usb_ether *ue = &sc->sc_ue;
780	struct ifnet *ifp = uether_getifp(ue);
781
782	uint8_t rxstat = 0;
783	uint32_t actlen;
784	uint16_t pktlen = 0;
785	struct usb_page_cache *pc;
786
787	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
788	pc = usbd_xfer_get_frame(xfer, 0);
789
790	switch (USB_GET_STATE(xfer)) {
791	case USB_ST_TRANSFERRED:
792		MOS_DPRINTFN("actlen : %d", actlen);
793		if (actlen <= 1) {
794			ifp->if_ierrors++;
795			goto tr_setup;
796		}
797		/* evaluate status byte at the end */
798		usbd_copy_out(pc, actlen - sizeof(rxstat), &rxstat,
799		    sizeof(rxstat));
800
801		if (rxstat != MOS_RXSTS_VALID) {
802			MOS_DPRINTFN("erroneous frame received");
803			if (rxstat & MOS_RXSTS_SHORT_FRAME)
804				MOS_DPRINTFN("frame size less than 64 bytes");
805			if (rxstat & MOS_RXSTS_LARGE_FRAME) {
806				MOS_DPRINTFN("frame size larger than "
807				    "1532 bytes");
808			}
809			if (rxstat & MOS_RXSTS_CRC_ERROR)
810				MOS_DPRINTFN("CRC error");
811			if (rxstat & MOS_RXSTS_ALIGN_ERROR)
812				MOS_DPRINTFN("alignment error");
813			ifp->if_ierrors++;
814			goto tr_setup;
815		}
816		/* Remember the last byte was used for the status fields */
817		pktlen = actlen - 1;
818		if (pktlen < sizeof(struct ether_header)) {
819			MOS_DPRINTFN("error: pktlen %d is smaller "
820			    "than ether_header %zd", pktlen,
821			    sizeof(struct ether_header));
822			ifp->if_ierrors++;
823			goto tr_setup;
824		}
825		uether_rxbuf(ue, pc, 0, actlen);
826		/* FALLTHROUGH */
827	case USB_ST_SETUP:
828tr_setup:
829		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
830		usbd_transfer_submit(xfer);
831		uether_rxflush(ue);
832		return;
833	default:
834		MOS_DPRINTFN("bulk read error, %s", usbd_errstr(error));
835		if (error != USB_ERR_CANCELLED) {
836			usbd_xfer_set_stall(xfer);
837			goto tr_setup;
838		}
839		MOS_DPRINTFN("start rx %i", usbd_xfer_max_len(xfer));
840		return;
841	}
842}
843
844/*
845 * A frame was downloaded to the chip. It's safe for us to clean up
846 * the list buffers.
847 */
848static void
849mos_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
850{
851	struct mos_softc *sc = usbd_xfer_softc(xfer);
852	struct ifnet *ifp = uether_getifp(&sc->sc_ue);
853	struct usb_page_cache *pc;
854	struct mbuf *m;
855
856
857
858	switch (USB_GET_STATE(xfer)) {
859	case USB_ST_TRANSFERRED:
860		MOS_DPRINTFN("transfer of complete");
861		ifp->if_opackets++;
862		/* FALLTHROUGH */
863	case USB_ST_SETUP:
864tr_setup:
865		/*
866		 * XXX: don't send anything if there is no link?
867		 */
868		IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
869		if (m == NULL)
870			return;
871
872		pc = usbd_xfer_get_frame(xfer, 0);
873		usbd_m_copy_in(pc, 0, m, 0, m->m_pkthdr.len);
874
875		usbd_xfer_set_frame_len(xfer, 0, m->m_pkthdr.len);
876
877
878		/*
879		 * if there's a BPF listener, bounce a copy
880		 * of this frame to him:
881		 */
882		BPF_MTAP(ifp, m);
883
884		m_freem(m);
885
886		usbd_transfer_submit(xfer);
887
888		ifp->if_opackets++;
889		return;
890	default:
891		MOS_DPRINTFN("usb error on tx: %s\n", usbd_errstr(error));
892		ifp->if_oerrors++;
893		if (error != USB_ERR_CANCELLED) {
894			usbd_xfer_set_stall(xfer);
895			goto tr_setup;
896		}
897		return;
898	}
899}
900
901static void
902mos_tick(struct usb_ether *ue)
903{
904	struct mos_softc *sc = uether_getsc(ue);
905	struct mii_data *mii = GET_MII(sc);
906
907	MOS_LOCK_ASSERT(sc, MA_OWNED);
908
909	mii_tick(mii);
910	if (!sc->mos_link && mii->mii_media_status & IFM_ACTIVE &&
911	    IFM_SUBTYPE(mii->mii_media_active) != IFM_NONE) {
912		MOS_DPRINTFN("got link");
913		sc->mos_link++;
914		mos_start(ue);
915	}
916}
917
918
919static void
920mos_start(struct usb_ether *ue)
921{
922	struct mos_softc *sc = uether_getsc(ue);
923
924	/*
925	 * start the USB transfers, if not already started:
926	 */
927	usbd_transfer_start(sc->sc_xfer[MOS_ENDPT_TX]);
928	usbd_transfer_start(sc->sc_xfer[MOS_ENDPT_RX]);
929	usbd_transfer_start(sc->sc_xfer[MOS_ENDPT_INTR]);
930}
931
932static void
933mos_init(struct usb_ether *ue)
934{
935	struct mos_softc *sc = uether_getsc(ue);
936	struct ifnet *ifp = uether_getifp(ue);
937	uint8_t rxmode;
938
939	MOS_LOCK_ASSERT(sc, MA_OWNED);
940
941	/* Cancel pending I/O and free all RX/TX buffers. */
942	mos_reset(sc);
943
944	/* Write MAC address */
945	mos_writemac(sc, IF_LLADDR(ifp));
946
947	/* Read and set transmitter IPG values */
948	sc->mos_ipgs[0] = mos_reg_read_1(sc, MOS_IPG0);
949	sc->mos_ipgs[1] = mos_reg_read_1(sc, MOS_IPG1);
950	mos_reg_write_1(sc, MOS_IPG0, sc->mos_ipgs[0]);
951	mos_reg_write_1(sc, MOS_IPG1, sc->mos_ipgs[1]);
952
953	/*
954	 * Enable receiver and transmitter, bridge controls speed/duplex
955	 * mode
956	 */
957	rxmode = mos_reg_read_1(sc, MOS_CTL);
958	rxmode |= MOS_CTL_RX_ENB | MOS_CTL_TX_ENB | MOS_CTL_BS_ENB;
959	rxmode &= ~(MOS_CTL_SLEEP);
960
961	mos_setpromisc(ue);
962
963	/* XXX: broadcast mode? */
964	mos_reg_write_1(sc, MOS_CTL, rxmode);
965
966	/* Load the multicast filter. */
967	mos_setmulti(ue);
968
969	ifp->if_drv_flags |= IFF_DRV_RUNNING;
970	mos_start(ue);
971}
972
973
974static void
975mos_intr_callback(struct usb_xfer *xfer, usb_error_t error)
976{
977	struct mos_softc *sc = usbd_xfer_softc(xfer);
978	struct ifnet *ifp = uether_getifp(&sc->sc_ue);
979	struct usb_page_cache *pc;
980	uint32_t pkt;
981	int actlen;
982
983	ifp->if_oerrors++;
984
985	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
986	MOS_DPRINTFN("actlen %i", actlen);
987
988	switch (USB_GET_STATE(xfer)) {
989	case USB_ST_TRANSFERRED:
990
991		pc = usbd_xfer_get_frame(xfer, 0);
992		usbd_copy_out(pc, 0, &pkt, sizeof(pkt));
993		/* FALLTHROUGH */
994	case USB_ST_SETUP:
995tr_setup:
996		return;
997	default:
998		if (error != USB_ERR_CANCELLED) {
999			usbd_xfer_set_stall(xfer);
1000			goto tr_setup;
1001		}
1002		return;
1003	}
1004}
1005
1006
1007/*
1008 * Stop the adapter and free any mbufs allocated to the
1009 * RX and TX lists.
1010 */
1011static void
1012mos_stop(struct usb_ether *ue)
1013{
1014	struct mos_softc *sc = uether_getsc(ue);
1015	struct ifnet *ifp = uether_getifp(ue);
1016
1017	mos_reset(sc);
1018
1019	MOS_LOCK_ASSERT(sc, MA_OWNED);
1020	ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
1021
1022	/* stop all the transfers, if not already stopped */
1023	usbd_transfer_stop(sc->sc_xfer[MOS_ENDPT_TX]);
1024	usbd_transfer_stop(sc->sc_xfer[MOS_ENDPT_RX]);
1025	usbd_transfer_stop(sc->sc_xfer[MOS_ENDPT_INTR]);
1026
1027	sc->mos_link = 0;
1028}
1029