2 * SPDX-License-Identifier: BSD-4-Clause
4 * Copyright (c) 1997, 1998, 1999, 2000
5 * Bill Paul <wpaul@ee.columbia.edu>. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Bill Paul.
18 * 4. Neither the name of the author nor the names of any co-contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 * THE POSSIBILITY OF SUCH DAMAGE.
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
39 * CATC USB-EL1210A USB to ethernet driver. Used in the CATC Netmate
40 * adapters and others.
42 * Written by Bill Paul <wpaul@ee.columbia.edu>
43 * Electrical Engineering Department
44 * Columbia University, New York City
48 * The CATC USB-EL1210A provides USB ethernet support at 10Mbps. The
49 * RX filter uses a 512-bit multicast hash table, single perfect entry
50 * for the station address, and promiscuous mode. Unlike the ADMtek
51 * and KLSI chips, the CATC ASIC supports read and write combining
52 * mode where multiple packets can be transferred using a single bulk
53 * transaction, which helps performance a great deal.
56 #include <sys/stdint.h>
57 #include <sys/stddef.h>
58 #include <sys/param.h>
59 #include <sys/queue.h>
60 #include <sys/types.h>
61 #include <sys/systm.h>
62 #include <sys/socket.h>
63 #include <sys/kernel.h>
65 #include <sys/module.h>
67 #include <sys/mutex.h>
68 #include <sys/condvar.h>
69 #include <sys/sysctl.h>
71 #include <sys/unistd.h>
72 #include <sys/callout.h>
73 #include <sys/malloc.h>
77 #include <net/if_var.h>
79 #include <dev/usb/usb.h>
80 #include <dev/usb/usbdi.h>
81 #include <dev/usb/usbdi_util.h>
84 #define USB_DEBUG_VAR cue_debug
85 #include <dev/usb/usb_debug.h>
86 #include <dev/usb/usb_process.h>
88 #include <dev/usb/net/usb_ethernet.h>
89 #include <dev/usb/net/if_cuereg.h>
92 * Various supported device vendors/products.
95 /* Belkin F5U111 adapter covered by NETMATE entry */
97 static const STRUCT_USB_HOST_ID cue_devs[] = {
98 #define CUE_DEV(v,p) { USB_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p) }
99 CUE_DEV(CATC, NETMATE),
100 CUE_DEV(CATC, NETMATE2),
101 CUE_DEV(SMARTBRIDGES, SMARTLINK),
107 static device_probe_t cue_probe;
108 static device_attach_t cue_attach;
109 static device_detach_t cue_detach;
111 static usb_callback_t cue_bulk_read_callback;
112 static usb_callback_t cue_bulk_write_callback;
114 static uether_fn_t cue_attach_post;
115 static uether_fn_t cue_init;
116 static uether_fn_t cue_stop;
117 static uether_fn_t cue_start;
118 static uether_fn_t cue_tick;
119 static uether_fn_t cue_setmulti;
120 static uether_fn_t cue_setpromisc;
122 static uint8_t cue_csr_read_1(struct cue_softc *, uint16_t);
123 static uint16_t cue_csr_read_2(struct cue_softc *, uint8_t);
124 static int cue_csr_write_1(struct cue_softc *, uint16_t, uint16_t);
125 static int cue_mem(struct cue_softc *, uint8_t, uint16_t, void *, int);
126 static int cue_getmac(struct cue_softc *, void *);
127 static uint32_t cue_mchash(const uint8_t *);
128 static void cue_reset(struct cue_softc *);
131 static int cue_debug = 0;
133 static SYSCTL_NODE(_hw_usb, OID_AUTO, cue, CTLFLAG_RW, 0, "USB cue");
134 SYSCTL_INT(_hw_usb_cue, OID_AUTO, debug, CTLFLAG_RWTUN, &cue_debug, 0,
138 static const struct usb_config cue_config[CUE_N_TRANSFER] = {
142 .endpoint = UE_ADDR_ANY,
143 .direction = UE_DIR_OUT,
144 .bufsize = (MCLBYTES + 2),
145 .flags = {.pipe_bof = 1,},
146 .callback = cue_bulk_write_callback,
147 .timeout = 10000, /* 10 seconds */
152 .endpoint = UE_ADDR_ANY,
153 .direction = UE_DIR_IN,
154 .bufsize = (MCLBYTES + 2),
155 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
156 .callback = cue_bulk_read_callback,
160 static device_method_t cue_methods[] = {
161 /* Device interface */
162 DEVMETHOD(device_probe, cue_probe),
163 DEVMETHOD(device_attach, cue_attach),
164 DEVMETHOD(device_detach, cue_detach),
169 static driver_t cue_driver = {
171 .methods = cue_methods,
172 .size = sizeof(struct cue_softc),
175 static devclass_t cue_devclass;
177 DRIVER_MODULE(cue, uhub, cue_driver, cue_devclass, NULL, 0);
178 MODULE_DEPEND(cue, uether, 1, 1, 1);
179 MODULE_DEPEND(cue, usb, 1, 1, 1);
180 MODULE_DEPEND(cue, ether, 1, 1, 1);
181 MODULE_VERSION(cue, 1);
182 USB_PNP_HOST_INFO(cue_devs);
184 static const struct usb_ether_methods cue_ue_methods = {
185 .ue_attach_post = cue_attach_post,
186 .ue_start = cue_start,
190 .ue_setmulti = cue_setmulti,
191 .ue_setpromisc = cue_setpromisc,
194 #define CUE_SETBIT(sc, reg, x) \
195 cue_csr_write_1(sc, reg, cue_csr_read_1(sc, reg) | (x))
197 #define CUE_CLRBIT(sc, reg, x) \
198 cue_csr_write_1(sc, reg, cue_csr_read_1(sc, reg) & ~(x))
201 cue_csr_read_1(struct cue_softc *sc, uint16_t reg)
203 struct usb_device_request req;
206 req.bmRequestType = UT_READ_VENDOR_DEVICE;
207 req.bRequest = CUE_CMD_READREG;
208 USETW(req.wValue, 0);
209 USETW(req.wIndex, reg);
210 USETW(req.wLength, 1);
212 if (uether_do_request(&sc->sc_ue, &req, &val, 1000)) {
213 /* ignore any errors */
219 cue_csr_read_2(struct cue_softc *sc, uint8_t reg)
221 struct usb_device_request req;
224 req.bmRequestType = UT_READ_VENDOR_DEVICE;
225 req.bRequest = CUE_CMD_READREG;
226 USETW(req.wValue, 0);
227 USETW(req.wIndex, reg);
228 USETW(req.wLength, 2);
230 (void)uether_do_request(&sc->sc_ue, &req, &val, 1000);
231 return (le16toh(val));
235 cue_csr_write_1(struct cue_softc *sc, uint16_t reg, uint16_t val)
237 struct usb_device_request req;
239 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
240 req.bRequest = CUE_CMD_WRITEREG;
241 USETW(req.wValue, val);
242 USETW(req.wIndex, reg);
243 USETW(req.wLength, 0);
245 return (uether_do_request(&sc->sc_ue, &req, NULL, 1000));
249 cue_mem(struct cue_softc *sc, uint8_t cmd, uint16_t addr, void *buf, int len)
251 struct usb_device_request req;
253 if (cmd == CUE_CMD_READSRAM)
254 req.bmRequestType = UT_READ_VENDOR_DEVICE;
256 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
258 USETW(req.wValue, 0);
259 USETW(req.wIndex, addr);
260 USETW(req.wLength, len);
262 return (uether_do_request(&sc->sc_ue, &req, buf, 1000));
266 cue_getmac(struct cue_softc *sc, void *buf)
268 struct usb_device_request req;
270 req.bmRequestType = UT_READ_VENDOR_DEVICE;
271 req.bRequest = CUE_CMD_GET_MACADDR;
272 USETW(req.wValue, 0);
273 USETW(req.wIndex, 0);
274 USETW(req.wLength, ETHER_ADDR_LEN);
276 return (uether_do_request(&sc->sc_ue, &req, buf, 1000));
282 cue_mchash(const uint8_t *addr)
286 /* Compute CRC for the address value. */
287 crc = ether_crc32_le(addr, ETHER_ADDR_LEN);
289 return (crc & ((1 << CUE_BITS) - 1));
293 cue_setpromisc(struct usb_ether *ue)
295 struct cue_softc *sc = uether_getsc(ue);
296 struct ifnet *ifp = uether_getifp(ue);
298 CUE_LOCK_ASSERT(sc, MA_OWNED);
300 /* if we want promiscuous mode, set the allframes bit */
301 if (ifp->if_flags & IFF_PROMISC)
302 CUE_SETBIT(sc, CUE_ETHCTL, CUE_ETHCTL_PROMISC);
304 CUE_CLRBIT(sc, CUE_ETHCTL, CUE_ETHCTL_PROMISC);
306 /* write multicast hash-bits */
311 cue_setmulti(struct usb_ether *ue)
313 struct cue_softc *sc = uether_getsc(ue);
314 struct ifnet *ifp = uether_getifp(ue);
315 struct ifmultiaddr *ifma;
317 uint8_t hashtbl[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
319 CUE_LOCK_ASSERT(sc, MA_OWNED);
321 if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
322 for (i = 0; i < 8; i++)
324 cue_mem(sc, CUE_CMD_WRITESRAM, CUE_MCAST_TABLE_ADDR,
329 /* now program new ones */
331 CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link)
333 if (ifma->ifma_addr->sa_family != AF_LINK)
335 h = cue_mchash(LLADDR((struct sockaddr_dl *)ifma->ifma_addr));
336 hashtbl[h >> 3] |= 1 << (h & 0x7);
338 if_maddr_runlock(ifp);
341 * Also include the broadcast address in the filter
342 * so we can receive broadcast frames.
344 if (ifp->if_flags & IFF_BROADCAST) {
345 h = cue_mchash(ifp->if_broadcastaddr);
346 hashtbl[h >> 3] |= 1 << (h & 0x7);
349 cue_mem(sc, CUE_CMD_WRITESRAM, CUE_MCAST_TABLE_ADDR, &hashtbl, 8);
353 cue_reset(struct cue_softc *sc)
355 struct usb_device_request req;
357 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
358 req.bRequest = CUE_CMD_RESET;
359 USETW(req.wValue, 0);
360 USETW(req.wIndex, 0);
361 USETW(req.wLength, 0);
363 if (uether_do_request(&sc->sc_ue, &req, NULL, 1000)) {
364 /* ignore any errors */
368 * wait a little while for the chip to get its brains in order:
370 uether_pause(&sc->sc_ue, hz / 100);
374 cue_attach_post(struct usb_ether *ue)
376 struct cue_softc *sc = uether_getsc(ue);
378 cue_getmac(sc, ue->ue_eaddr);
382 cue_probe(device_t dev)
384 struct usb_attach_arg *uaa = device_get_ivars(dev);
386 if (uaa->usb_mode != USB_MODE_HOST)
388 if (uaa->info.bConfigIndex != CUE_CONFIG_IDX)
390 if (uaa->info.bIfaceIndex != CUE_IFACE_IDX)
393 return (usbd_lookup_id_by_uaa(cue_devs, sizeof(cue_devs), uaa));
397 * Attach the interface. Allocate softc structures, do ifmedia
398 * setup and ethernet/BPF attach.
401 cue_attach(device_t dev)
403 struct usb_attach_arg *uaa = device_get_ivars(dev);
404 struct cue_softc *sc = device_get_softc(dev);
405 struct usb_ether *ue = &sc->sc_ue;
409 device_set_usb_desc(dev);
410 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
412 iface_index = CUE_IFACE_IDX;
413 error = usbd_transfer_setup(uaa->device, &iface_index,
414 sc->sc_xfer, cue_config, CUE_N_TRANSFER, sc, &sc->sc_mtx);
416 device_printf(dev, "allocating USB transfers failed\n");
422 ue->ue_udev = uaa->device;
423 ue->ue_mtx = &sc->sc_mtx;
424 ue->ue_methods = &cue_ue_methods;
426 error = uether_ifattach(ue);
428 device_printf(dev, "could not attach interface\n");
431 return (0); /* success */
435 return (ENXIO); /* failure */
439 cue_detach(device_t dev)
441 struct cue_softc *sc = device_get_softc(dev);
442 struct usb_ether *ue = &sc->sc_ue;
444 usbd_transfer_unsetup(sc->sc_xfer, CUE_N_TRANSFER);
446 mtx_destroy(&sc->sc_mtx);
452 cue_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
454 struct cue_softc *sc = usbd_xfer_softc(xfer);
455 struct usb_ether *ue = &sc->sc_ue;
456 struct ifnet *ifp = uether_getifp(ue);
457 struct usb_page_cache *pc;
462 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
464 switch (USB_GET_STATE(xfer)) {
465 case USB_ST_TRANSFERRED:
467 if (actlen <= (int)(2 + sizeof(struct ether_header))) {
468 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
471 pc = usbd_xfer_get_frame(xfer, 0);
472 usbd_copy_out(pc, 0, buf, 2);
474 len = buf[0] | (buf[1] << 8);
475 len = min(actlen, len);
477 uether_rxbuf(ue, pc, 2, len);
481 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
482 usbd_transfer_submit(xfer);
487 DPRINTF("bulk read error, %s\n",
490 if (error != USB_ERR_CANCELLED) {
491 /* try to clear stall first */
492 usbd_xfer_set_stall(xfer);
501 cue_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
503 struct cue_softc *sc = usbd_xfer_softc(xfer);
504 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
505 struct usb_page_cache *pc;
509 switch (USB_GET_STATE(xfer)) {
510 case USB_ST_TRANSFERRED:
511 DPRINTFN(11, "transfer complete\n");
512 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
517 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
521 if (m->m_pkthdr.len > MCLBYTES)
522 m->m_pkthdr.len = MCLBYTES;
523 usbd_xfer_set_frame_len(xfer, 0, (m->m_pkthdr.len + 2));
525 /* the first two bytes are the frame length */
527 buf[0] = (uint8_t)(m->m_pkthdr.len);
528 buf[1] = (uint8_t)(m->m_pkthdr.len >> 8);
530 pc = usbd_xfer_get_frame(xfer, 0);
531 usbd_copy_in(pc, 0, buf, 2);
532 usbd_m_copy_in(pc, 2, m, 0, m->m_pkthdr.len);
535 * If there's a BPF listener, bounce a copy of this frame
542 usbd_transfer_submit(xfer);
547 DPRINTFN(11, "transfer error, %s\n",
550 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
552 if (error != USB_ERR_CANCELLED) {
553 /* try to clear stall first */
554 usbd_xfer_set_stall(xfer);
562 cue_tick(struct usb_ether *ue)
564 struct cue_softc *sc = uether_getsc(ue);
565 struct ifnet *ifp = uether_getifp(ue);
567 CUE_LOCK_ASSERT(sc, MA_OWNED);
569 if_inc_counter(ifp, IFCOUNTER_COLLISIONS, cue_csr_read_2(sc, CUE_TX_SINGLECOLL));
570 if_inc_counter(ifp, IFCOUNTER_COLLISIONS, cue_csr_read_2(sc, CUE_TX_MULTICOLL));
571 if_inc_counter(ifp, IFCOUNTER_COLLISIONS, cue_csr_read_2(sc, CUE_TX_EXCESSCOLL));
573 if (cue_csr_read_2(sc, CUE_RX_FRAMEERR))
574 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
578 cue_start(struct usb_ether *ue)
580 struct cue_softc *sc = uether_getsc(ue);
583 * start the USB transfers, if not already started:
585 usbd_transfer_start(sc->sc_xfer[CUE_BULK_DT_RD]);
586 usbd_transfer_start(sc->sc_xfer[CUE_BULK_DT_WR]);
590 cue_init(struct usb_ether *ue)
592 struct cue_softc *sc = uether_getsc(ue);
593 struct ifnet *ifp = uether_getifp(ue);
596 CUE_LOCK_ASSERT(sc, MA_OWNED);
599 * Cancel pending I/O and free all RX/TX buffers.
605 /* Set MAC address */
606 for (i = 0; i < ETHER_ADDR_LEN; i++)
607 cue_csr_write_1(sc, CUE_PAR0 - i, IF_LLADDR(ifp)[i]);
609 /* Enable RX logic. */
610 cue_csr_write_1(sc, CUE_ETHCTL, CUE_ETHCTL_RX_ON | CUE_ETHCTL_MCAST_ON);
612 /* Load the multicast filter */
616 * Set the number of RX and TX buffers that we want
617 * to reserve inside the ASIC.
619 cue_csr_write_1(sc, CUE_RX_BUFPKTS, CUE_RX_FRAMES);
620 cue_csr_write_1(sc, CUE_TX_BUFPKTS, CUE_TX_FRAMES);
622 /* Set advanced operation modes. */
623 cue_csr_write_1(sc, CUE_ADVANCED_OPMODES,
624 CUE_AOP_EMBED_RXLEN | 0x01);/* 1 wait state */
626 /* Program the LED operation. */
627 cue_csr_write_1(sc, CUE_LEDCTL, CUE_LEDCTL_FOLLOW_LINK);
629 usbd_xfer_set_stall(sc->sc_xfer[CUE_BULK_DT_WR]);
631 ifp->if_drv_flags |= IFF_DRV_RUNNING;
636 * Stop the adapter and free any mbufs allocated to the
640 cue_stop(struct usb_ether *ue)
642 struct cue_softc *sc = uether_getsc(ue);
643 struct ifnet *ifp = uether_getifp(ue);
645 CUE_LOCK_ASSERT(sc, MA_OWNED);
647 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
650 * stop all the transfers, if not already stopped:
652 usbd_transfer_stop(sc->sc_xfer[CUE_BULK_DT_WR]);
653 usbd_transfer_stop(sc->sc_xfer[CUE_BULK_DT_RD]);
655 cue_csr_write_1(sc, CUE_ETHCTL, 0);