1184610Salfred/*	$NetBSD: if_udav.c,v 1.2 2003/09/04 15:17:38 tsutsui Exp $	*/
2184610Salfred/*	$nabe: if_udav.c,v 1.3 2003/08/21 16:57:19 nabe Exp $	*/
3184610Salfred/*	$FreeBSD$	*/
4184610Salfred/*-
5184610Salfred * Copyright (c) 2003
6184610Salfred *     Shingo WATANABE <nabe@nabechan.org>.  All rights reserved.
7184610Salfred *
8184610Salfred * Redistribution and use in source and binary forms, with or without
9184610Salfred * modification, are permitted provided that the following conditions
10184610Salfred * are met:
11184610Salfred * 1. Redistributions of source code must retain the above copyright
12184610Salfred *    notice, this list of conditions and the following disclaimer.
13184610Salfred * 2. Redistributions in binary form must reproduce the above copyright
14184610Salfred *    notice, this list of conditions and the following disclaimer in the
15184610Salfred *    documentation and/or other materials provided with the distribution.
16184610Salfred * 3. Neither the name of the author nor the names of any co-contributors
17184610Salfred *    may be used to endorse or promote products derived from this software
18184610Salfred *    without specific prior written permission.
19184610Salfred *
20184610Salfred * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21184610Salfred * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22184610Salfred * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23184610Salfred * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24184610Salfred * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25184610Salfred * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26184610Salfred * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27184610Salfred * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28184610Salfred * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29184610Salfred * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30184610Salfred * SUCH DAMAGE.
31184610Salfred *
32184610Salfred */
33184610Salfred
34184610Salfred/*
35184610Salfred * DM9601(DAVICOM USB to Ethernet MAC Controller with Integrated 10/100 PHY)
36184610Salfred * The spec can be found at the following url.
37254404Skevlo *   http://ptm2.cc.utu.fi/ftp/network/cards/DM9601/From_NET/DM9601-DS-P01-930914.pdf
38184610Salfred */
39184610Salfred
40184610Salfred/*
41184610Salfred * TODO:
42184610Salfred *	Interrupt Endpoint support
43184610Salfred *	External PHYs
44184610Salfred */
45184610Salfred
46184610Salfred#include <sys/cdefs.h>
47184610Salfred__FBSDID("$FreeBSD$");
48184610Salfred
49194677Sthompsa#include <sys/stdint.h>
50194677Sthompsa#include <sys/stddef.h>
51194677Sthompsa#include <sys/param.h>
52194677Sthompsa#include <sys/queue.h>
53194677Sthompsa#include <sys/types.h>
54194677Sthompsa#include <sys/systm.h>
55257176Sglebius#include <sys/socket.h>
56194677Sthompsa#include <sys/kernel.h>
57194677Sthompsa#include <sys/bus.h>
58194677Sthompsa#include <sys/module.h>
59194677Sthompsa#include <sys/lock.h>
60194677Sthompsa#include <sys/mutex.h>
61194677Sthompsa#include <sys/condvar.h>
62194677Sthompsa#include <sys/sysctl.h>
63194677Sthompsa#include <sys/sx.h>
64194677Sthompsa#include <sys/unistd.h>
65194677Sthompsa#include <sys/callout.h>
66194677Sthompsa#include <sys/malloc.h>
67194677Sthompsa#include <sys/priv.h>
68194677Sthompsa
69257176Sglebius#include <net/if.h>
70257176Sglebius#include <net/if_var.h>
71257176Sglebius
72194677Sthompsa#include <dev/usb/usb.h>
73194677Sthompsa#include <dev/usb/usbdi.h>
74194677Sthompsa#include <dev/usb/usbdi_util.h>
75188746Sthompsa#include "usbdevs.h"
76184610Salfred
77184610Salfred#define	USB_DEBUG_VAR udav_debug
78194677Sthompsa#include <dev/usb/usb_debug.h>
79188942Sthompsa#include <dev/usb/usb_process.h>
80184610Salfred
81188942Sthompsa#include <dev/usb/net/usb_ethernet.h>
82188942Sthompsa#include <dev/usb/net/if_udavreg.h>
83184610Salfred
84184610Salfred/* prototypes */
85184610Salfred
86184610Salfredstatic device_probe_t udav_probe;
87184610Salfredstatic device_attach_t udav_attach;
88184610Salfredstatic device_detach_t udav_detach;
89184610Salfred
90193045Sthompsastatic usb_callback_t udav_bulk_write_callback;
91193045Sthompsastatic usb_callback_t udav_bulk_read_callback;
92193045Sthompsastatic usb_callback_t udav_intr_callback;
93184610Salfred
94193045Sthompsastatic uether_fn_t udav_attach_post;
95193045Sthompsastatic uether_fn_t udav_init;
96193045Sthompsastatic uether_fn_t udav_stop;
97193045Sthompsastatic uether_fn_t udav_start;
98193045Sthompsastatic uether_fn_t udav_tick;
99193045Sthompsastatic uether_fn_t udav_setmulti;
100193045Sthompsastatic uether_fn_t udav_setpromisc;
101184610Salfred
102188412Sthompsastatic int	udav_csr_read(struct udav_softc *, uint16_t, void *, int);
103188412Sthompsastatic int	udav_csr_write(struct udav_softc *, uint16_t, void *, int);
104188412Sthompsastatic uint8_t	udav_csr_read1(struct udav_softc *, uint16_t);
105188412Sthompsastatic int	udav_csr_write1(struct udav_softc *, uint16_t, uint8_t);
106188412Sthompsastatic void	udav_reset(struct udav_softc *);
107188412Sthompsastatic int	udav_ifmedia_upd(struct ifnet *);
108188412Sthompsastatic void	udav_ifmedia_status(struct ifnet *, struct ifmediareq *);
109184610Salfred
110188412Sthompsastatic miibus_readreg_t udav_miibus_readreg;
111188412Sthompsastatic miibus_writereg_t udav_miibus_writereg;
112188412Sthompsastatic miibus_statchg_t udav_miibus_statchg;
113184610Salfred
114192984Sthompsastatic const struct usb_config udav_config[UDAV_N_TRANSFER] = {
115184610Salfred
116187259Sthompsa	[UDAV_BULK_DT_WR] = {
117184610Salfred		.type = UE_BULK,
118184610Salfred		.endpoint = UE_ADDR_ANY,
119184610Salfred		.direction = UE_DIR_OUT,
120190734Sthompsa		.bufsize = (MCLBYTES + 2),
121190734Sthompsa		.flags = {.pipe_bof = 1,.force_short_xfer = 1,},
122190734Sthompsa		.callback = udav_bulk_write_callback,
123190734Sthompsa		.timeout = 10000,	/* 10 seconds */
124184610Salfred	},
125184610Salfred
126187259Sthompsa	[UDAV_BULK_DT_RD] = {
127184610Salfred		.type = UE_BULK,
128184610Salfred		.endpoint = UE_ADDR_ANY,
129184610Salfred		.direction = UE_DIR_IN,
130190734Sthompsa		.bufsize = (MCLBYTES + 3),
131190734Sthompsa		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
132190734Sthompsa		.callback = udav_bulk_read_callback,
133190734Sthompsa		.timeout = 0,	/* no timeout */
134184610Salfred	},
135184610Salfred
136187259Sthompsa	[UDAV_INTR_DT_RD] = {
137184610Salfred		.type = UE_INTERRUPT,
138184610Salfred		.endpoint = UE_ADDR_ANY,
139184610Salfred		.direction = UE_DIR_IN,
140190734Sthompsa		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
141190734Sthompsa		.bufsize = 0,	/* use wMaxPacketSize */
142190734Sthompsa		.callback = udav_intr_callback,
143184610Salfred	},
144184610Salfred};
145184610Salfred
146184610Salfredstatic device_method_t udav_methods[] = {
147184610Salfred	/* Device interface */
148184610Salfred	DEVMETHOD(device_probe, udav_probe),
149184610Salfred	DEVMETHOD(device_attach, udav_attach),
150184610Salfred	DEVMETHOD(device_detach, udav_detach),
151184610Salfred
152184610Salfred	/* MII interface */
153188412Sthompsa	DEVMETHOD(miibus_readreg, udav_miibus_readreg),
154188412Sthompsa	DEVMETHOD(miibus_writereg, udav_miibus_writereg),
155188412Sthompsa	DEVMETHOD(miibus_statchg, udav_miibus_statchg),
156184610Salfred
157227843Smarius	DEVMETHOD_END
158184610Salfred};
159184610Salfred
160184610Salfredstatic driver_t udav_driver = {
161184610Salfred	.name = "udav",
162184610Salfred	.methods = udav_methods,
163184610Salfred	.size = sizeof(struct udav_softc),
164184610Salfred};
165184610Salfred
166184610Salfredstatic devclass_t udav_devclass;
167184610Salfred
168292080Simpstatic const STRUCT_USB_HOST_ID udav_devs[] = {
169292080Simp	/* ShanTou DM9601 USB NIC */
170292080Simp	{USB_VPI(USB_VENDOR_SHANTOU, USB_PRODUCT_SHANTOU_DM9601, 0)},
171292080Simp	/* ShanTou ST268 USB NIC */
172292080Simp	{USB_VPI(USB_VENDOR_SHANTOU, USB_PRODUCT_SHANTOU_ST268, 0)},
173292080Simp	/* Corega USB-TXC */
174292080Simp	{USB_VPI(USB_VENDOR_COREGA, USB_PRODUCT_COREGA_FETHER_USB_TXC, 0)},
175292080Simp	/* ShanTou AMD8515 USB NIC */
176292080Simp	{USB_VPI(USB_VENDOR_SHANTOU, USB_PRODUCT_SHANTOU_ADM8515, 0)},
177292080Simp	/* Kontron AG USB Ethernet */
178292080Simp	{USB_VPI(USB_VENDOR_KONTRON, USB_PRODUCT_KONTRON_DM9601, 0)},
179292080Simp	{USB_VPI(USB_VENDOR_KONTRON, USB_PRODUCT_KONTRON_JP1082,
180292080Simp	    UDAV_FLAG_NO_PHY)},
181292080Simp};
182292080Simp
183189275SthompsaDRIVER_MODULE(udav, uhub, udav_driver, udav_devclass, NULL, 0);
184184610SalfredDRIVER_MODULE(miibus, udav, miibus_driver, miibus_devclass, 0, 0);
185188942SthompsaMODULE_DEPEND(udav, uether, 1, 1, 1);
186188942SthompsaMODULE_DEPEND(udav, usb, 1, 1, 1);
187184610SalfredMODULE_DEPEND(udav, ether, 1, 1, 1);
188184610SalfredMODULE_DEPEND(udav, miibus, 1, 1, 1);
189212122SthompsaMODULE_VERSION(udav, 1);
190292080SimpUSB_PNP_HOST_INFO(udav_devs);
191184610Salfred
192242777Shselaskystatic const struct usb_ether_methods udav_ue_methods = {
193188412Sthompsa	.ue_attach_post = udav_attach_post,
194188412Sthompsa	.ue_start = udav_start,
195188412Sthompsa	.ue_init = udav_init,
196188412Sthompsa	.ue_stop = udav_stop,
197188412Sthompsa	.ue_tick = udav_tick,
198188412Sthompsa	.ue_setmulti = udav_setmulti,
199188412Sthompsa	.ue_setpromisc = udav_setpromisc,
200188412Sthompsa	.ue_mii_upd = udav_ifmedia_upd,
201188412Sthompsa	.ue_mii_sts = udav_ifmedia_status,
202188412Sthompsa};
203188412Sthompsa
204242777Shselaskystatic const struct usb_ether_methods udav_ue_methods_nophy = {
205242777Shselasky	.ue_attach_post = udav_attach_post,
206242777Shselasky	.ue_start = udav_start,
207242777Shselasky	.ue_init = udav_init,
208242777Shselasky	.ue_stop = udav_stop,
209242777Shselasky	.ue_setmulti = udav_setmulti,
210242777Shselasky	.ue_setpromisc = udav_setpromisc,
211242777Shselasky};
212242777Shselasky
213207077Sthompsa#ifdef USB_DEBUG
214184610Salfredstatic int udav_debug = 0;
215184610Salfred
216227309Sedstatic SYSCTL_NODE(_hw_usb, OID_AUTO, udav, CTLFLAG_RW, 0, "USB udav");
217276701ShselaskySYSCTL_INT(_hw_usb_udav, OID_AUTO, debug, CTLFLAG_RWTUN, &udav_debug, 0,
218184610Salfred    "Debug level");
219184610Salfred#endif
220184610Salfred
221188412Sthompsa#define	UDAV_SETBIT(sc, reg, x)	\
222188412Sthompsa	udav_csr_write1(sc, reg, udav_csr_read1(sc, reg) | (x))
223184610Salfred
224188412Sthompsa#define	UDAV_CLRBIT(sc, reg, x)	\
225188412Sthompsa	udav_csr_write1(sc, reg, udav_csr_read1(sc, reg) & ~(x))
226184610Salfred
227188412Sthompsastatic void
228192984Sthompsaudav_attach_post(struct usb_ether *ue)
229188412Sthompsa{
230194228Sthompsa	struct udav_softc *sc = uether_getsc(ue);
231188412Sthompsa
232188412Sthompsa	/* reset the adapter */
233188412Sthompsa	udav_reset(sc);
234188412Sthompsa
235188412Sthompsa	/* Get Ethernet Address */
236188412Sthompsa	udav_csr_read(sc, UDAV_PAR, ue->ue_eaddr, ETHER_ADDR_LEN);
237188412Sthompsa}
238188412Sthompsa
239184610Salfredstatic int
240184610Salfredudav_probe(device_t dev)
241184610Salfred{
242192984Sthompsa	struct usb_attach_arg *uaa = device_get_ivars(dev);
243184610Salfred
244192499Sthompsa	if (uaa->usb_mode != USB_MODE_HOST)
245184610Salfred		return (ENXIO);
246188412Sthompsa	if (uaa->info.bConfigIndex != UDAV_CONFIG_INDEX)
247184610Salfred		return (ENXIO);
248188412Sthompsa	if (uaa->info.bIfaceIndex != UDAV_IFACE_INDEX)
249184610Salfred		return (ENXIO);
250188412Sthompsa
251194228Sthompsa	return (usbd_lookup_id_by_uaa(udav_devs, sizeof(udav_devs), uaa));
252184610Salfred}
253184610Salfred
254184610Salfredstatic int
255184610Salfredudav_attach(device_t dev)
256184610Salfred{
257192984Sthompsa	struct usb_attach_arg *uaa = device_get_ivars(dev);
258184610Salfred	struct udav_softc *sc = device_get_softc(dev);
259192984Sthompsa	struct usb_ether *ue = &sc->sc_ue;
260184610Salfred	uint8_t iface_index;
261188412Sthompsa	int error;
262184610Salfred
263184610Salfred	sc->sc_flags = USB_GET_DRIVER_INFO(uaa);
264184610Salfred
265194228Sthompsa	device_set_usb_desc(dev);
266184610Salfred
267188412Sthompsa	mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
268184610Salfred
269184610Salfred	iface_index = UDAV_IFACE_INDEX;
270194228Sthompsa	error = usbd_transfer_setup(uaa->device, &iface_index,
271187259Sthompsa	    sc->sc_xfer, udav_config, UDAV_N_TRANSFER, sc, &sc->sc_mtx);
272184610Salfred	if (error) {
273199816Sthompsa		device_printf(dev, "allocating USB transfers failed\n");
274184610Salfred		goto detach;
275184610Salfred	}
276188412Sthompsa
277238466Srpaulo	/*
278238466Srpaulo	 * The JP1082 has an unusable PHY and provides no link information.
279238466Srpaulo	 */
280238466Srpaulo	if (sc->sc_flags & UDAV_FLAG_NO_PHY) {
281242777Shselasky		ue->ue_methods = &udav_ue_methods_nophy;
282238466Srpaulo		sc->sc_flags |= UDAV_FLAG_LINK;
283242777Shselasky	} else {
284242777Shselasky		ue->ue_methods = &udav_ue_methods;
285238466Srpaulo	}
286238466Srpaulo
287188412Sthompsa	ue->ue_sc = sc;
288188412Sthompsa	ue->ue_dev = dev;
289188412Sthompsa	ue->ue_udev = uaa->device;
290188412Sthompsa	ue->ue_mtx = &sc->sc_mtx;
291188412Sthompsa
292194228Sthompsa	error = uether_ifattach(ue);
293184610Salfred	if (error) {
294188412Sthompsa		device_printf(dev, "could not attach interface\n");
295184610Salfred		goto detach;
296184610Salfred	}
297184610Salfred
298184610Salfred	return (0);			/* success */
299184610Salfred
300184610Salfreddetach:
301184610Salfred	udav_detach(dev);
302184610Salfred	return (ENXIO);			/* failure */
303184610Salfred}
304184610Salfred
305184610Salfredstatic int
306184610Salfredudav_detach(device_t dev)
307184610Salfred{
308184610Salfred	struct udav_softc *sc = device_get_softc(dev);
309192984Sthompsa	struct usb_ether *ue = &sc->sc_ue;
310184610Salfred
311194228Sthompsa	usbd_transfer_unsetup(sc->sc_xfer, UDAV_N_TRANSFER);
312194228Sthompsa	uether_ifdetach(ue);
313184610Salfred	mtx_destroy(&sc->sc_mtx);
314184610Salfred
315184610Salfred	return (0);
316184610Salfred}
317184610Salfred
318184610Salfred#if 0
319188412Sthompsastatic int
320188412Sthompsaudav_mem_read(struct udav_softc *sc, uint16_t offset, void *buf,
321188412Sthompsa    int len)
322184610Salfred{
323192984Sthompsa	struct usb_device_request req;
324184610Salfred
325184610Salfred	len &= 0xff;
326184610Salfred
327184610Salfred	req.bmRequestType = UT_READ_VENDOR_DEVICE;
328184610Salfred	req.bRequest = UDAV_REQ_MEM_READ;
329184610Salfred	USETW(req.wValue, 0x0000);
330184610Salfred	USETW(req.wIndex, offset);
331184610Salfred	USETW(req.wLength, len);
332184610Salfred
333194228Sthompsa	return (uether_do_request(&sc->sc_ue, &req, buf, 1000));
334184610Salfred}
335184610Salfred
336188412Sthompsastatic int
337188412Sthompsaudav_mem_write(struct udav_softc *sc, uint16_t offset, void *buf,
338188412Sthompsa    int len)
339184610Salfred{
340192984Sthompsa	struct usb_device_request req;
341184610Salfred
342184610Salfred	len &= 0xff;
343184610Salfred
344184610Salfred	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
345184610Salfred	req.bRequest = UDAV_REQ_MEM_WRITE;
346184610Salfred	USETW(req.wValue, 0x0000);
347184610Salfred	USETW(req.wIndex, offset);
348184610Salfred	USETW(req.wLength, len);
349184610Salfred
350194228Sthompsa	return (uether_do_request(&sc->sc_ue, &req, buf, 1000));
351184610Salfred}
352184610Salfred
353188412Sthompsastatic int
354188412Sthompsaudav_mem_write1(struct udav_softc *sc, uint16_t offset,
355184610Salfred    uint8_t ch)
356184610Salfred{
357192984Sthompsa	struct usb_device_request req;
358184610Salfred
359184610Salfred	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
360184610Salfred	req.bRequest = UDAV_REQ_MEM_WRITE1;
361184610Salfred	USETW(req.wValue, ch);
362184610Salfred	USETW(req.wIndex, offset);
363184610Salfred	USETW(req.wLength, 0x0000);
364184610Salfred
365194228Sthompsa	return (uether_do_request(&sc->sc_ue, &req, NULL, 1000));
366184610Salfred}
367184610Salfred#endif
368184610Salfred
369188412Sthompsastatic int
370188412Sthompsaudav_csr_read(struct udav_softc *sc, uint16_t offset, void *buf, int len)
371184610Salfred{
372192984Sthompsa	struct usb_device_request req;
373184610Salfred
374184610Salfred	len &= 0xff;
375184610Salfred
376184610Salfred	req.bmRequestType = UT_READ_VENDOR_DEVICE;
377184610Salfred	req.bRequest = UDAV_REQ_REG_READ;
378184610Salfred	USETW(req.wValue, 0x0000);
379184610Salfred	USETW(req.wIndex, offset);
380184610Salfred	USETW(req.wLength, len);
381184610Salfred
382194228Sthompsa	return (uether_do_request(&sc->sc_ue, &req, buf, 1000));
383184610Salfred}
384184610Salfred
385188412Sthompsastatic int
386188412Sthompsaudav_csr_write(struct udav_softc *sc, uint16_t offset, void *buf, int len)
387184610Salfred{
388192984Sthompsa	struct usb_device_request req;
389184610Salfred
390184610Salfred	offset &= 0xff;
391184610Salfred	len &= 0xff;
392184610Salfred
393184610Salfred	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
394184610Salfred	req.bRequest = UDAV_REQ_REG_WRITE;
395184610Salfred	USETW(req.wValue, 0x0000);
396184610Salfred	USETW(req.wIndex, offset);
397184610Salfred	USETW(req.wLength, len);
398184610Salfred
399194228Sthompsa	return (uether_do_request(&sc->sc_ue, &req, buf, 1000));
400184610Salfred}
401184610Salfred
402184610Salfredstatic uint8_t
403188412Sthompsaudav_csr_read1(struct udav_softc *sc, uint16_t offset)
404184610Salfred{
405184610Salfred	uint8_t val;
406184610Salfred
407188412Sthompsa	udav_csr_read(sc, offset, &val, 1);
408184610Salfred	return (val);
409184610Salfred}
410184610Salfred
411188412Sthompsastatic int
412188412Sthompsaudav_csr_write1(struct udav_softc *sc, uint16_t offset,
413184610Salfred    uint8_t ch)
414184610Salfred{
415192984Sthompsa	struct usb_device_request req;
416184610Salfred
417184610Salfred	offset &= 0xff;
418184610Salfred
419184610Salfred	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
420184610Salfred	req.bRequest = UDAV_REQ_REG_WRITE1;
421184610Salfred	USETW(req.wValue, ch);
422184610Salfred	USETW(req.wIndex, offset);
423184610Salfred	USETW(req.wLength, 0x0000);
424184610Salfred
425194228Sthompsa	return (uether_do_request(&sc->sc_ue, &req, NULL, 1000));
426184610Salfred}
427184610Salfred
428184610Salfredstatic void
429192984Sthompsaudav_init(struct usb_ether *ue)
430184610Salfred{
431188412Sthompsa	struct udav_softc *sc = ue->ue_sc;
432194228Sthompsa	struct ifnet *ifp = uether_getifp(&sc->sc_ue);
433184610Salfred
434188412Sthompsa	UDAV_LOCK_ASSERT(sc, MA_OWNED);
435184610Salfred
436184610Salfred	/*
437184610Salfred	 * Cancel pending I/O
438184610Salfred	 */
439188412Sthompsa	udav_stop(ue);
440184610Salfred
441184610Salfred	/* set MAC address */
442188412Sthompsa	udav_csr_write(sc, UDAV_PAR, IF_LLADDR(ifp), ETHER_ADDR_LEN);
443184610Salfred
444184610Salfred	/* initialize network control register */
445184610Salfred
446184610Salfred	/* disable loopback  */
447188412Sthompsa	UDAV_CLRBIT(sc, UDAV_NCR, UDAV_NCR_LBK0 | UDAV_NCR_LBK1);
448184610Salfred
449184610Salfred	/* Initialize RX control register */
450188412Sthompsa	UDAV_SETBIT(sc, UDAV_RCR, UDAV_RCR_DIS_LONG | UDAV_RCR_DIS_CRC);
451184610Salfred
452184610Salfred	/* load multicast filter and update promiscious mode bit */
453188412Sthompsa	udav_setpromisc(ue);
454184610Salfred
455184610Salfred	/* enable RX */
456188412Sthompsa	UDAV_SETBIT(sc, UDAV_RCR, UDAV_RCR_RXEN);
457184610Salfred
458184610Salfred	/* clear POWER_DOWN state of internal PHY */
459188412Sthompsa	UDAV_SETBIT(sc, UDAV_GPCR, UDAV_GPCR_GEP_CNTL0);
460188412Sthompsa	UDAV_CLRBIT(sc, UDAV_GPR, UDAV_GPR_GEPIO0);
461184610Salfred
462194677Sthompsa	usbd_xfer_set_stall(sc->sc_xfer[UDAV_BULK_DT_WR]);
463184610Salfred
464188412Sthompsa	ifp->if_drv_flags |= IFF_DRV_RUNNING;
465188412Sthompsa	udav_start(ue);
466184610Salfred}
467184610Salfred
468184610Salfredstatic void
469188412Sthompsaudav_reset(struct udav_softc *sc)
470184610Salfred{
471188412Sthompsa	int i;
472184610Salfred
473184610Salfred	/* Select PHY */
474184610Salfred#if 1
475184610Salfred	/*
476184610Salfred	 * XXX: force select internal phy.
477184610Salfred	 *	external phy routines are not tested.
478184610Salfred	 */
479188412Sthompsa	UDAV_CLRBIT(sc, UDAV_NCR, UDAV_NCR_EXT_PHY);
480184610Salfred#else
481188412Sthompsa	if (sc->sc_flags & UDAV_EXT_PHY)
482188412Sthompsa		UDAV_SETBIT(sc, UDAV_NCR, UDAV_NCR_EXT_PHY);
483188412Sthompsa	else
484188412Sthompsa		UDAV_CLRBIT(sc, UDAV_NCR, UDAV_NCR_EXT_PHY);
485184610Salfred#endif
486184610Salfred
487188412Sthompsa	UDAV_SETBIT(sc, UDAV_NCR, UDAV_NCR_RST);
488184610Salfred
489188412Sthompsa	for (i = 0; i < UDAV_TX_TIMEOUT; i++) {
490188412Sthompsa		if (!(udav_csr_read1(sc, UDAV_NCR) & UDAV_NCR_RST))
491184610Salfred			break;
492194228Sthompsa		if (uether_pause(&sc->sc_ue, hz / 100))
493188412Sthompsa			break;
494184610Salfred	}
495184610Salfred
496194228Sthompsa	uether_pause(&sc->sc_ue, hz / 100);
497184610Salfred}
498184610Salfred
499184610Salfred#define	UDAV_BITS	6
500184610Salfredstatic void
501192984Sthompsaudav_setmulti(struct usb_ether *ue)
502184610Salfred{
503188412Sthompsa	struct udav_softc *sc = ue->ue_sc;
504194228Sthompsa	struct ifnet *ifp = uether_getifp(&sc->sc_ue);
505188412Sthompsa	struct ifmultiaddr *ifma;
506188412Sthompsa	uint8_t hashtbl[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
507188412Sthompsa	int h = 0;
508184610Salfred
509188412Sthompsa	UDAV_LOCK_ASSERT(sc, MA_OWNED);
510184610Salfred
511188412Sthompsa	if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
512188412Sthompsa		UDAV_SETBIT(sc, UDAV_RCR, UDAV_RCR_ALL|UDAV_RCR_PRMSC);
513188412Sthompsa		return;
514188412Sthompsa	}
515188412Sthompsa
516188412Sthompsa	/* first, zot all the existing hash bits */
517188412Sthompsa	memset(hashtbl, 0x00, sizeof(hashtbl));
518188412Sthompsa	hashtbl[7] |= 0x80;	/* broadcast address */
519188412Sthompsa	udav_csr_write(sc, UDAV_MAR, hashtbl, sizeof(hashtbl));
520188412Sthompsa
521188412Sthompsa	/* now program new ones */
522195049Srwatson	if_maddr_rlock(ifp);
523188412Sthompsa	TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link)
524188412Sthompsa	{
525188412Sthompsa		if (ifma->ifma_addr->sa_family != AF_LINK)
526188412Sthompsa			continue;
527188412Sthompsa		h = ether_crc32_be(LLADDR((struct sockaddr_dl *)
528188412Sthompsa		    ifma->ifma_addr), ETHER_ADDR_LEN) >> 26;
529188412Sthompsa		hashtbl[h / 8] |= 1 << (h % 8);
530188412Sthompsa	}
531195049Srwatson	if_maddr_runlock(ifp);
532188412Sthompsa
533188412Sthompsa	/* disable all multicast */
534188412Sthompsa	UDAV_CLRBIT(sc, UDAV_RCR, UDAV_RCR_ALL);
535188412Sthompsa
536188412Sthompsa	/* write hash value to the register */
537188412Sthompsa	udav_csr_write(sc, UDAV_MAR, hashtbl, sizeof(hashtbl));
538184610Salfred}
539184610Salfred
540184610Salfredstatic void
541192984Sthompsaudav_setpromisc(struct usb_ether *ue)
542184610Salfred{
543188412Sthompsa	struct udav_softc *sc = ue->ue_sc;
544194228Sthompsa	struct ifnet *ifp = uether_getifp(&sc->sc_ue);
545184610Salfred	uint8_t rxmode;
546184610Salfred
547188412Sthompsa	rxmode = udav_csr_read1(sc, UDAV_RCR);
548184610Salfred	rxmode &= ~(UDAV_RCR_ALL | UDAV_RCR_PRMSC);
549184610Salfred
550188412Sthompsa	if (ifp->if_flags & IFF_PROMISC)
551184610Salfred		rxmode |= UDAV_RCR_ALL | UDAV_RCR_PRMSC;
552188412Sthompsa	else if (ifp->if_flags & IFF_ALLMULTI)
553184610Salfred		rxmode |= UDAV_RCR_ALL;
554184610Salfred
555184610Salfred	/* write new mode bits */
556188412Sthompsa	udav_csr_write1(sc, UDAV_RCR, rxmode);
557184610Salfred}
558184610Salfred
559184610Salfredstatic void
560192984Sthompsaudav_start(struct usb_ether *ue)
561184610Salfred{
562188412Sthompsa	struct udav_softc *sc = ue->ue_sc;
563184610Salfred
564188412Sthompsa	/*
565188412Sthompsa	 * start the USB transfers, if not already started:
566188412Sthompsa	 */
567194228Sthompsa	usbd_transfer_start(sc->sc_xfer[UDAV_INTR_DT_RD]);
568194228Sthompsa	usbd_transfer_start(sc->sc_xfer[UDAV_BULK_DT_RD]);
569194228Sthompsa	usbd_transfer_start(sc->sc_xfer[UDAV_BULK_DT_WR]);
570184610Salfred}
571184610Salfred
572184610Salfredstatic void
573194677Sthompsaudav_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
574184610Salfred{
575194677Sthompsa	struct udav_softc *sc = usbd_xfer_softc(xfer);
576194228Sthompsa	struct ifnet *ifp = uether_getifp(&sc->sc_ue);
577194677Sthompsa	struct usb_page_cache *pc;
578184610Salfred	struct mbuf *m;
579188412Sthompsa	int extra_len;
580188412Sthompsa	int temp_len;
581184610Salfred	uint8_t buf[2];
582184610Salfred
583184610Salfred	switch (USB_GET_STATE(xfer)) {
584184610Salfred	case USB_ST_TRANSFERRED:
585184610Salfred		DPRINTFN(11, "transfer complete\n");
586271832Sglebius		if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
587184610Salfred
588188412Sthompsa		/* FALLTHROUGH */
589184610Salfred	case USB_ST_SETUP:
590188412Sthompsatr_setup:
591188412Sthompsa		if ((sc->sc_flags & UDAV_FLAG_LINK) == 0) {
592184610Salfred			/*
593184610Salfred			 * don't send anything if there is no link !
594184610Salfred			 */
595188412Sthompsa			return;
596184610Salfred		}
597184610Salfred		IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
598184610Salfred
599188412Sthompsa		if (m == NULL)
600188412Sthompsa			return;
601188412Sthompsa		if (m->m_pkthdr.len > MCLBYTES)
602184610Salfred			m->m_pkthdr.len = MCLBYTES;
603184610Salfred		if (m->m_pkthdr.len < UDAV_MIN_FRAME_LEN) {
604184610Salfred			extra_len = UDAV_MIN_FRAME_LEN - m->m_pkthdr.len;
605184610Salfred		} else {
606184610Salfred			extra_len = 0;
607184610Salfred		}
608184610Salfred
609184610Salfred		temp_len = (m->m_pkthdr.len + extra_len);
610184610Salfred
611184610Salfred		/*
612184610Salfred		 * the frame length is specified in the first 2 bytes of the
613184610Salfred		 * buffer
614184610Salfred		 */
615184610Salfred		buf[0] = (uint8_t)(temp_len);
616184610Salfred		buf[1] = (uint8_t)(temp_len >> 8);
617184610Salfred
618184610Salfred		temp_len += 2;
619184610Salfred
620194677Sthompsa		pc = usbd_xfer_get_frame(xfer, 0);
621194677Sthompsa		usbd_copy_in(pc, 0, buf, 2);
622194677Sthompsa		usbd_m_copy_in(pc, 2, m, 0, m->m_pkthdr.len);
623184610Salfred
624194677Sthompsa		if (extra_len)
625194677Sthompsa			usbd_frame_zero(pc, temp_len - extra_len, extra_len);
626184610Salfred		/*
627184610Salfred		 * if there's a BPF listener, bounce a copy
628184610Salfred		 * of this frame to him:
629184610Salfred		 */
630184610Salfred		BPF_MTAP(ifp, m);
631184610Salfred
632184610Salfred		m_freem(m);
633184610Salfred
634194677Sthompsa		usbd_xfer_set_frame_len(xfer, 0, temp_len);
635194228Sthompsa		usbd_transfer_submit(xfer);
636184610Salfred		return;
637184610Salfred
638184610Salfred	default:			/* Error */
639184610Salfred		DPRINTFN(11, "transfer error, %s\n",
640194677Sthompsa		    usbd_errstr(error));
641184610Salfred
642271832Sglebius		if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
643188412Sthompsa
644194677Sthompsa		if (error != USB_ERR_CANCELLED) {
645184610Salfred			/* try to clear stall first */
646194677Sthompsa			usbd_xfer_set_stall(xfer);
647188412Sthompsa			goto tr_setup;
648184610Salfred		}
649184610Salfred		return;
650184610Salfred	}
651184610Salfred}
652184610Salfred
653184610Salfredstatic void
654194677Sthompsaudav_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
655184610Salfred{
656194677Sthompsa	struct udav_softc *sc = usbd_xfer_softc(xfer);
657192984Sthompsa	struct usb_ether *ue = &sc->sc_ue;
658194228Sthompsa	struct ifnet *ifp = uether_getifp(ue);
659194677Sthompsa	struct usb_page_cache *pc;
660188412Sthompsa	struct udav_rxpkt stat;
661188412Sthompsa	int len;
662194677Sthompsa	int actlen;
663184610Salfred
664194677Sthompsa	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
665194677Sthompsa
666184610Salfred	switch (USB_GET_STATE(xfer)) {
667184610Salfred	case USB_ST_TRANSFERRED:
668184610Salfred
669233774Shselasky		if (actlen < (int)(sizeof(stat) + ETHER_CRC_LEN)) {
670271832Sglebius			if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
671184610Salfred			goto tr_setup;
672184610Salfred		}
673194677Sthompsa		pc = usbd_xfer_get_frame(xfer, 0);
674194677Sthompsa		usbd_copy_out(pc, 0, &stat, sizeof(stat));
675194677Sthompsa		actlen -= sizeof(stat);
676194677Sthompsa		len = min(actlen, le16toh(stat.pktlen));
677188412Sthompsa		len -= ETHER_CRC_LEN;
678184610Salfred
679188412Sthompsa		if (stat.rxstat & UDAV_RSR_LCS) {
680271832Sglebius			if_inc_counter(ifp, IFCOUNTER_COLLISIONS, 1);
681184610Salfred			goto tr_setup;
682184610Salfred		}
683188412Sthompsa		if (stat.rxstat & UDAV_RSR_ERR) {
684271832Sglebius			if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
685184610Salfred			goto tr_setup;
686184610Salfred		}
687194677Sthompsa		uether_rxbuf(ue, pc, sizeof(stat), len);
688188412Sthompsa		/* FALLTHROUGH */
689184610Salfred	case USB_ST_SETUP:
690184610Salfredtr_setup:
691194677Sthompsa		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
692194228Sthompsa		usbd_transfer_submit(xfer);
693194228Sthompsa		uether_rxflush(ue);
694184610Salfred		return;
695184610Salfred
696184610Salfred	default:			/* Error */
697188412Sthompsa		DPRINTF("bulk read error, %s\n",
698194677Sthompsa		    usbd_errstr(error));
699188412Sthompsa
700194677Sthompsa		if (error != USB_ERR_CANCELLED) {
701184610Salfred			/* try to clear stall first */
702194677Sthompsa			usbd_xfer_set_stall(xfer);
703188412Sthompsa			goto tr_setup;
704184610Salfred		}
705184610Salfred		return;
706184610Salfred	}
707184610Salfred}
708184610Salfred
709184610Salfredstatic void
710194677Sthompsaudav_intr_callback(struct usb_xfer *xfer, usb_error_t error)
711184610Salfred{
712184610Salfred	switch (USB_GET_STATE(xfer)) {
713184610Salfred	case USB_ST_TRANSFERRED:
714184610Salfred	case USB_ST_SETUP:
715188412Sthompsatr_setup:
716194677Sthompsa		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
717194228Sthompsa		usbd_transfer_submit(xfer);
718184610Salfred		return;
719184610Salfred
720184610Salfred	default:			/* Error */
721194677Sthompsa		if (error != USB_ERR_CANCELLED) {
722188412Sthompsa			/* try to clear stall first */
723194677Sthompsa			usbd_xfer_set_stall(xfer);
724188412Sthompsa			goto tr_setup;
725184610Salfred		}
726184610Salfred		return;
727184610Salfred	}
728184610Salfred}
729184610Salfred
730184610Salfredstatic void
731192984Sthompsaudav_stop(struct usb_ether *ue)
732184610Salfred{
733188412Sthompsa	struct udav_softc *sc = ue->ue_sc;
734194228Sthompsa	struct ifnet *ifp = uether_getifp(&sc->sc_ue);
735184610Salfred
736188412Sthompsa	UDAV_LOCK_ASSERT(sc, MA_OWNED);
737184610Salfred
738188412Sthompsa	ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
739238466Srpaulo	if (!(sc->sc_flags & UDAV_FLAG_NO_PHY))
740238466Srpaulo		sc->sc_flags &= ~UDAV_FLAG_LINK;
741184610Salfred
742184610Salfred	/*
743184610Salfred	 * stop all the transfers, if not already stopped:
744184610Salfred	 */
745194228Sthompsa	usbd_transfer_stop(sc->sc_xfer[UDAV_BULK_DT_WR]);
746194228Sthompsa	usbd_transfer_stop(sc->sc_xfer[UDAV_BULK_DT_RD]);
747194228Sthompsa	usbd_transfer_stop(sc->sc_xfer[UDAV_INTR_DT_RD]);
748184610Salfred
749188412Sthompsa	udav_reset(sc);
750184610Salfred}
751184610Salfred
752184610Salfredstatic int
753188412Sthompsaudav_ifmedia_upd(struct ifnet *ifp)
754184610Salfred{
755184610Salfred	struct udav_softc *sc = ifp->if_softc;
756184610Salfred	struct mii_data *mii = GET_MII(sc);
757221407Smarius	struct mii_softc *miisc;
758251734Skevlo	int error;
759184610Salfred
760188412Sthompsa	UDAV_LOCK_ASSERT(sc, MA_OWNED);
761184610Salfred
762188412Sthompsa        sc->sc_flags &= ~UDAV_FLAG_LINK;
763221407Smarius	LIST_FOREACH(miisc, &mii->mii_phys, mii_list)
764221407Smarius		PHY_RESET(miisc);
765251734Skevlo	error = mii_mediachg(mii);
766251734Skevlo	return (error);
767184610Salfred}
768184610Salfred
769184610Salfredstatic void
770188412Sthompsaudav_ifmedia_status(struct ifnet *ifp, struct ifmediareq *ifmr)
771184610Salfred{
772184610Salfred	struct udav_softc *sc = ifp->if_softc;
773188412Sthompsa	struct mii_data *mii = GET_MII(sc);
774184610Salfred
775188412Sthompsa	UDAV_LOCK(sc);
776188412Sthompsa	mii_pollstat(mii);
777188412Sthompsa	ifmr->ifm_active = mii->mii_media_active;
778188412Sthompsa	ifmr->ifm_status = mii->mii_media_status;
779226479Syongari	UDAV_UNLOCK(sc);
780184610Salfred}
781184610Salfred
782184610Salfredstatic void
783192984Sthompsaudav_tick(struct usb_ether *ue)
784184610Salfred{
785188412Sthompsa	struct udav_softc *sc = ue->ue_sc;
786184610Salfred	struct mii_data *mii = GET_MII(sc);
787184610Salfred
788188412Sthompsa	UDAV_LOCK_ASSERT(sc, MA_OWNED);
789188412Sthompsa
790184610Salfred	mii_tick(mii);
791188412Sthompsa	if ((sc->sc_flags & UDAV_FLAG_LINK) == 0
792188412Sthompsa	    && mii->mii_media_status & IFM_ACTIVE &&
793188412Sthompsa	    IFM_SUBTYPE(mii->mii_media_active) != IFM_NONE) {
794188412Sthompsa		sc->sc_flags |= UDAV_FLAG_LINK;
795188412Sthompsa		udav_start(ue);
796184610Salfred	}
797184610Salfred}
798184610Salfred
799184610Salfredstatic int
800188412Sthompsaudav_miibus_readreg(device_t dev, int phy, int reg)
801184610Salfred{
802184610Salfred	struct udav_softc *sc = device_get_softc(dev);
803184610Salfred	uint16_t data16;
804184610Salfred	uint8_t val[2];
805188412Sthompsa	int locked;
806184610Salfred
807184610Salfred	/* XXX: one PHY only for the internal PHY */
808188412Sthompsa	if (phy != 0)
809184610Salfred		return (0);
810184610Salfred
811188412Sthompsa	locked = mtx_owned(&sc->sc_mtx);
812188412Sthompsa	if (!locked)
813188412Sthompsa		UDAV_LOCK(sc);
814188412Sthompsa
815184610Salfred	/* select internal PHY and set PHY register address */
816188412Sthompsa	udav_csr_write1(sc, UDAV_EPAR,
817184610Salfred	    UDAV_EPAR_PHY_ADR0 | (reg & UDAV_EPAR_EROA_MASK));
818184610Salfred
819184610Salfred	/* select PHY operation and start read command */
820188412Sthompsa	udav_csr_write1(sc, UDAV_EPCR, UDAV_EPCR_EPOS | UDAV_EPCR_ERPRR);
821184610Salfred
822184610Salfred	/* XXX: should we wait? */
823184610Salfred
824184610Salfred	/* end read command */
825188412Sthompsa	UDAV_CLRBIT(sc, UDAV_EPCR, UDAV_EPCR_ERPRR);
826184610Salfred
827184610Salfred	/* retrieve the result from data registers */
828188412Sthompsa	udav_csr_read(sc, UDAV_EPDRL, val, 2);
829184610Salfred
830184610Salfred	data16 = (val[0] | (val[1] << 8));
831184610Salfred
832184610Salfred	DPRINTFN(11, "phy=%d reg=0x%04x => 0x%04x\n",
833184610Salfred	    phy, reg, data16);
834184610Salfred
835188412Sthompsa	if (!locked)
836188412Sthompsa		UDAV_UNLOCK(sc);
837184610Salfred	return (data16);
838184610Salfred}
839184610Salfred
840184610Salfredstatic int
841188412Sthompsaudav_miibus_writereg(device_t dev, int phy, int reg, int data)
842184610Salfred{
843184610Salfred	struct udav_softc *sc = device_get_softc(dev);
844184610Salfred	uint8_t val[2];
845188412Sthompsa	int locked;
846184610Salfred
847184610Salfred	/* XXX: one PHY only for the internal PHY */
848188412Sthompsa	if (phy != 0)
849184610Salfred		return (0);
850184610Salfred
851188412Sthompsa	locked = mtx_owned(&sc->sc_mtx);
852188412Sthompsa	if (!locked)
853188412Sthompsa		UDAV_LOCK(sc);
854188412Sthompsa
855184610Salfred	/* select internal PHY and set PHY register address */
856188412Sthompsa	udav_csr_write1(sc, UDAV_EPAR,
857184610Salfred	    UDAV_EPAR_PHY_ADR0 | (reg & UDAV_EPAR_EROA_MASK));
858184610Salfred
859184610Salfred	/* put the value to the data registers */
860184610Salfred	val[0] = (data & 0xff);
861184610Salfred	val[1] = (data >> 8) & 0xff;
862188412Sthompsa	udav_csr_write(sc, UDAV_EPDRL, val, 2);
863184610Salfred
864184610Salfred	/* select PHY operation and start write command */
865188412Sthompsa	udav_csr_write1(sc, UDAV_EPCR, UDAV_EPCR_EPOS | UDAV_EPCR_ERPRW);
866184610Salfred
867184610Salfred	/* XXX: should we wait? */
868184610Salfred
869184610Salfred	/* end write command */
870188412Sthompsa	UDAV_CLRBIT(sc, UDAV_EPCR, UDAV_EPCR_ERPRW);
871184610Salfred
872188412Sthompsa	if (!locked)
873188412Sthompsa		UDAV_UNLOCK(sc);
874184610Salfred	return (0);
875184610Salfred}
876184610Salfred
877184610Salfredstatic void
878188412Sthompsaudav_miibus_statchg(device_t dev)
879184610Salfred{
880184610Salfred	/* nothing to do */
881184610Salfred}
882