2 * Copyright (c) 1997, 1998, 1999, 2000
3 * Bill Paul <wpaul@ee.columbia.edu>. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by Bill Paul.
16 * 4. Neither the name of the author nor the names of any co-contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
37 * CATC USB-EL1210A USB to ethernet driver. Used in the CATC Netmate
38 * adapters and others.
40 * Written by Bill Paul <wpaul@ee.columbia.edu>
41 * Electrical Engineering Department
42 * Columbia University, New York City
46 * The CATC USB-EL1210A provides USB ethernet support at 10Mbps. The
47 * RX filter uses a 512-bit multicast hash table, single perfect entry
48 * for the station address, and promiscuous mode. Unlike the ADMtek
49 * and KLSI chips, the CATC ASIC supports read and write combining
50 * mode where multiple packets can be transfered using a single bulk
51 * transaction, which helps performance a great deal.
54 #include <sys/stdint.h>
55 #include <sys/stddef.h>
56 #include <sys/param.h>
57 #include <sys/queue.h>
58 #include <sys/types.h>
59 #include <sys/systm.h>
60 #include <sys/kernel.h>
62 #include <sys/linker_set.h>
63 #include <sys/module.h>
65 #include <sys/mutex.h>
66 #include <sys/condvar.h>
67 #include <sys/sysctl.h>
69 #include <sys/unistd.h>
70 #include <sys/callout.h>
71 #include <sys/malloc.h>
74 #include <dev/usb/usb.h>
75 #include <dev/usb/usbdi.h>
76 #include <dev/usb/usbdi_util.h>
79 #define USB_DEBUG_VAR cue_debug
80 #include <dev/usb/usb_debug.h>
81 #include <dev/usb/usb_process.h>
83 #include <dev/usb/net/usb_ethernet.h>
84 #include <dev/usb/net/if_cuereg.h>
87 * Various supported device vendors/products.
90 /* Belkin F5U111 adapter covered by NETMATE entry */
92 static const struct usb_device_id cue_devs[] = {
93 {USB_VPI(USB_VENDOR_CATC, USB_PRODUCT_CATC_NETMATE, 0)},
94 {USB_VPI(USB_VENDOR_CATC, USB_PRODUCT_CATC_NETMATE2, 0)},
95 {USB_VPI(USB_VENDOR_SMARTBRIDGES, USB_PRODUCT_SMARTBRIDGES_SMARTLINK, 0)},
100 static device_probe_t cue_probe;
101 static device_attach_t cue_attach;
102 static device_detach_t cue_detach;
104 static usb_callback_t cue_bulk_read_callback;
105 static usb_callback_t cue_bulk_write_callback;
107 static uether_fn_t cue_attach_post;
108 static uether_fn_t cue_init;
109 static uether_fn_t cue_stop;
110 static uether_fn_t cue_start;
111 static uether_fn_t cue_tick;
112 static uether_fn_t cue_setmulti;
113 static uether_fn_t cue_setpromisc;
115 static uint8_t cue_csr_read_1(struct cue_softc *, uint16_t);
116 static uint16_t cue_csr_read_2(struct cue_softc *, uint8_t);
117 static int cue_csr_write_1(struct cue_softc *, uint16_t, uint16_t);
118 static int cue_mem(struct cue_softc *, uint8_t, uint16_t, void *, int);
119 static int cue_getmac(struct cue_softc *, void *);
120 static uint32_t cue_mchash(const uint8_t *);
121 static void cue_reset(struct cue_softc *);
124 static int cue_debug = 0;
126 SYSCTL_NODE(_hw_usb, OID_AUTO, cue, CTLFLAG_RW, 0, "USB cue");
127 SYSCTL_INT(_hw_usb_cue, OID_AUTO, debug, CTLFLAG_RW, &cue_debug, 0,
131 static const struct usb_config cue_config[CUE_N_TRANSFER] = {
135 .endpoint = UE_ADDR_ANY,
136 .direction = UE_DIR_OUT,
137 .bufsize = (MCLBYTES + 2),
138 .flags = {.pipe_bof = 1,},
139 .callback = cue_bulk_write_callback,
140 .timeout = 10000, /* 10 seconds */
145 .endpoint = UE_ADDR_ANY,
146 .direction = UE_DIR_IN,
147 .bufsize = (MCLBYTES + 2),
148 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
149 .callback = cue_bulk_read_callback,
153 static device_method_t cue_methods[] = {
154 /* Device interface */
155 DEVMETHOD(device_probe, cue_probe),
156 DEVMETHOD(device_attach, cue_attach),
157 DEVMETHOD(device_detach, cue_detach),
162 static driver_t cue_driver = {
164 .methods = cue_methods,
165 .size = sizeof(struct cue_softc),
168 static devclass_t cue_devclass;
170 DRIVER_MODULE(cue, uhub, cue_driver, cue_devclass, NULL, 0);
171 MODULE_DEPEND(cue, uether, 1, 1, 1);
172 MODULE_DEPEND(cue, usb, 1, 1, 1);
173 MODULE_DEPEND(cue, ether, 1, 1, 1);
175 static const struct usb_ether_methods cue_ue_methods = {
176 .ue_attach_post = cue_attach_post,
177 .ue_start = cue_start,
181 .ue_setmulti = cue_setmulti,
182 .ue_setpromisc = cue_setpromisc,
185 #define CUE_SETBIT(sc, reg, x) \
186 cue_csr_write_1(sc, reg, cue_csr_read_1(sc, reg) | (x))
188 #define CUE_CLRBIT(sc, reg, x) \
189 cue_csr_write_1(sc, reg, cue_csr_read_1(sc, reg) & ~(x))
192 cue_csr_read_1(struct cue_softc *sc, uint16_t reg)
194 struct usb_device_request req;
197 req.bmRequestType = UT_READ_VENDOR_DEVICE;
198 req.bRequest = CUE_CMD_READREG;
199 USETW(req.wValue, 0);
200 USETW(req.wIndex, reg);
201 USETW(req.wLength, 1);
203 if (uether_do_request(&sc->sc_ue, &req, &val, 1000)) {
204 /* ignore any errors */
210 cue_csr_read_2(struct cue_softc *sc, uint8_t reg)
212 struct usb_device_request req;
215 req.bmRequestType = UT_READ_VENDOR_DEVICE;
216 req.bRequest = CUE_CMD_READREG;
217 USETW(req.wValue, 0);
218 USETW(req.wIndex, reg);
219 USETW(req.wLength, 2);
221 (void)uether_do_request(&sc->sc_ue, &req, &val, 1000);
222 return (le16toh(val));
226 cue_csr_write_1(struct cue_softc *sc, uint16_t reg, uint16_t val)
228 struct usb_device_request req;
230 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
231 req.bRequest = CUE_CMD_WRITEREG;
232 USETW(req.wValue, val);
233 USETW(req.wIndex, reg);
234 USETW(req.wLength, 0);
236 return (uether_do_request(&sc->sc_ue, &req, NULL, 1000));
240 cue_mem(struct cue_softc *sc, uint8_t cmd, uint16_t addr, void *buf, int len)
242 struct usb_device_request req;
244 if (cmd == CUE_CMD_READSRAM)
245 req.bmRequestType = UT_READ_VENDOR_DEVICE;
247 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
249 USETW(req.wValue, 0);
250 USETW(req.wIndex, addr);
251 USETW(req.wLength, len);
253 return (uether_do_request(&sc->sc_ue, &req, buf, 1000));
257 cue_getmac(struct cue_softc *sc, void *buf)
259 struct usb_device_request req;
261 req.bmRequestType = UT_READ_VENDOR_DEVICE;
262 req.bRequest = CUE_CMD_GET_MACADDR;
263 USETW(req.wValue, 0);
264 USETW(req.wIndex, 0);
265 USETW(req.wLength, ETHER_ADDR_LEN);
267 return (uether_do_request(&sc->sc_ue, &req, buf, 1000));
273 cue_mchash(const uint8_t *addr)
277 /* Compute CRC for the address value. */
278 crc = ether_crc32_le(addr, ETHER_ADDR_LEN);
280 return (crc & ((1 << CUE_BITS) - 1));
284 cue_setpromisc(struct usb_ether *ue)
286 struct cue_softc *sc = uether_getsc(ue);
287 struct ifnet *ifp = uether_getifp(ue);
289 CUE_LOCK_ASSERT(sc, MA_OWNED);
291 /* if we want promiscuous mode, set the allframes bit */
292 if (ifp->if_flags & IFF_PROMISC)
293 CUE_SETBIT(sc, CUE_ETHCTL, CUE_ETHCTL_PROMISC);
295 CUE_CLRBIT(sc, CUE_ETHCTL, CUE_ETHCTL_PROMISC);
297 /* write multicast hash-bits */
302 cue_setmulti(struct usb_ether *ue)
304 struct cue_softc *sc = uether_getsc(ue);
305 struct ifnet *ifp = uether_getifp(ue);
306 struct ifmultiaddr *ifma;
308 uint8_t hashtbl[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
310 CUE_LOCK_ASSERT(sc, MA_OWNED);
312 if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
313 for (i = 0; i < 8; i++)
315 cue_mem(sc, CUE_CMD_WRITESRAM, CUE_MCAST_TABLE_ADDR,
320 /* now program new ones */
322 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link)
324 if (ifma->ifma_addr->sa_family != AF_LINK)
326 h = cue_mchash(LLADDR((struct sockaddr_dl *)ifma->ifma_addr));
327 hashtbl[h >> 3] |= 1 << (h & 0x7);
329 if_maddr_runlock(ifp);
332 * Also include the broadcast address in the filter
333 * so we can receive broadcast frames.
335 if (ifp->if_flags & IFF_BROADCAST) {
336 h = cue_mchash(ifp->if_broadcastaddr);
337 hashtbl[h >> 3] |= 1 << (h & 0x7);
340 cue_mem(sc, CUE_CMD_WRITESRAM, CUE_MCAST_TABLE_ADDR, &hashtbl, 8);
344 cue_reset(struct cue_softc *sc)
346 struct usb_device_request req;
348 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
349 req.bRequest = CUE_CMD_RESET;
350 USETW(req.wValue, 0);
351 USETW(req.wIndex, 0);
352 USETW(req.wLength, 0);
354 if (uether_do_request(&sc->sc_ue, &req, NULL, 1000)) {
355 /* ignore any errors */
359 * wait a little while for the chip to get its brains in order:
361 uether_pause(&sc->sc_ue, hz / 100);
365 cue_attach_post(struct usb_ether *ue)
367 struct cue_softc *sc = uether_getsc(ue);
369 cue_getmac(sc, ue->ue_eaddr);
373 cue_probe(device_t dev)
375 struct usb_attach_arg *uaa = device_get_ivars(dev);
377 if (uaa->usb_mode != USB_MODE_HOST)
379 if (uaa->info.bConfigIndex != CUE_CONFIG_IDX)
381 if (uaa->info.bIfaceIndex != CUE_IFACE_IDX)
384 return (usbd_lookup_id_by_uaa(cue_devs, sizeof(cue_devs), uaa));
388 * Attach the interface. Allocate softc structures, do ifmedia
389 * setup and ethernet/BPF attach.
392 cue_attach(device_t dev)
394 struct usb_attach_arg *uaa = device_get_ivars(dev);
395 struct cue_softc *sc = device_get_softc(dev);
396 struct usb_ether *ue = &sc->sc_ue;
400 device_set_usb_desc(dev);
401 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
403 iface_index = CUE_IFACE_IDX;
404 error = usbd_transfer_setup(uaa->device, &iface_index,
405 sc->sc_xfer, cue_config, CUE_N_TRANSFER, sc, &sc->sc_mtx);
407 device_printf(dev, "allocating USB transfers failed!\n");
413 ue->ue_udev = uaa->device;
414 ue->ue_mtx = &sc->sc_mtx;
415 ue->ue_methods = &cue_ue_methods;
417 error = uether_ifattach(ue);
419 device_printf(dev, "could not attach interface\n");
422 return (0); /* success */
426 return (ENXIO); /* failure */
430 cue_detach(device_t dev)
432 struct cue_softc *sc = device_get_softc(dev);
433 struct usb_ether *ue = &sc->sc_ue;
435 usbd_transfer_unsetup(sc->sc_xfer, CUE_N_TRANSFER);
437 mtx_destroy(&sc->sc_mtx);
443 cue_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
445 struct cue_softc *sc = usbd_xfer_softc(xfer);
446 struct usb_ether *ue = &sc->sc_ue;
447 struct ifnet *ifp = uether_getifp(ue);
448 struct usb_page_cache *pc;
453 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
455 switch (USB_GET_STATE(xfer)) {
456 case USB_ST_TRANSFERRED:
458 if (actlen <= (2 + sizeof(struct ether_header))) {
462 pc = usbd_xfer_get_frame(xfer, 0);
463 usbd_copy_out(pc, 0, buf, 2);
465 len = buf[0] | (buf[1] << 8);
466 len = min(actlen, len);
468 uether_rxbuf(ue, pc, 2, len);
472 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
473 usbd_transfer_submit(xfer);
478 DPRINTF("bulk read error, %s\n",
481 if (error != USB_ERR_CANCELLED) {
482 /* try to clear stall first */
483 usbd_xfer_set_stall(xfer);
492 cue_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
494 struct cue_softc *sc = usbd_xfer_softc(xfer);
495 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
496 struct usb_page_cache *pc;
500 switch (USB_GET_STATE(xfer)) {
501 case USB_ST_TRANSFERRED:
502 DPRINTFN(11, "transfer complete\n");
508 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
512 if (m->m_pkthdr.len > MCLBYTES)
513 m->m_pkthdr.len = MCLBYTES;
514 usbd_xfer_set_frame_len(xfer, 0, (m->m_pkthdr.len + 2));
516 /* the first two bytes are the frame length */
518 buf[0] = (uint8_t)(m->m_pkthdr.len);
519 buf[1] = (uint8_t)(m->m_pkthdr.len >> 8);
521 pc = usbd_xfer_get_frame(xfer, 0);
522 usbd_copy_in(pc, 0, buf, 2);
523 usbd_m_copy_in(pc, 2, m, 0, m->m_pkthdr.len);
526 * If there's a BPF listener, bounce a copy of this frame
533 usbd_transfer_submit(xfer);
538 DPRINTFN(11, "transfer error, %s\n",
543 if (error != USB_ERR_CANCELLED) {
544 /* try to clear stall first */
545 usbd_xfer_set_stall(xfer);
553 cue_tick(struct usb_ether *ue)
555 struct cue_softc *sc = uether_getsc(ue);
556 struct ifnet *ifp = uether_getifp(ue);
558 CUE_LOCK_ASSERT(sc, MA_OWNED);
560 ifp->if_collisions += cue_csr_read_2(sc, CUE_TX_SINGLECOLL);
561 ifp->if_collisions += cue_csr_read_2(sc, CUE_TX_MULTICOLL);
562 ifp->if_collisions += cue_csr_read_2(sc, CUE_TX_EXCESSCOLL);
564 if (cue_csr_read_2(sc, CUE_RX_FRAMEERR))
569 cue_start(struct usb_ether *ue)
571 struct cue_softc *sc = uether_getsc(ue);
574 * start the USB transfers, if not already started:
576 usbd_transfer_start(sc->sc_xfer[CUE_BULK_DT_RD]);
577 usbd_transfer_start(sc->sc_xfer[CUE_BULK_DT_WR]);
581 cue_init(struct usb_ether *ue)
583 struct cue_softc *sc = uether_getsc(ue);
584 struct ifnet *ifp = uether_getifp(ue);
587 CUE_LOCK_ASSERT(sc, MA_OWNED);
590 * Cancel pending I/O and free all RX/TX buffers.
596 /* Set MAC address */
597 for (i = 0; i < ETHER_ADDR_LEN; i++)
598 cue_csr_write_1(sc, CUE_PAR0 - i, IF_LLADDR(ifp)[i]);
600 /* Enable RX logic. */
601 cue_csr_write_1(sc, CUE_ETHCTL, CUE_ETHCTL_RX_ON | CUE_ETHCTL_MCAST_ON);
603 /* Load the multicast filter */
607 * Set the number of RX and TX buffers that we want
608 * to reserve inside the ASIC.
610 cue_csr_write_1(sc, CUE_RX_BUFPKTS, CUE_RX_FRAMES);
611 cue_csr_write_1(sc, CUE_TX_BUFPKTS, CUE_TX_FRAMES);
613 /* Set advanced operation modes. */
614 cue_csr_write_1(sc, CUE_ADVANCED_OPMODES,
615 CUE_AOP_EMBED_RXLEN | 0x01);/* 1 wait state */
617 /* Program the LED operation. */
618 cue_csr_write_1(sc, CUE_LEDCTL, CUE_LEDCTL_FOLLOW_LINK);
620 usbd_xfer_set_stall(sc->sc_xfer[CUE_BULK_DT_WR]);
622 ifp->if_drv_flags |= IFF_DRV_RUNNING;
627 * Stop the adapter and free any mbufs allocated to the
631 cue_stop(struct usb_ether *ue)
633 struct cue_softc *sc = uether_getsc(ue);
634 struct ifnet *ifp = uether_getifp(ue);
636 CUE_LOCK_ASSERT(sc, MA_OWNED);
638 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
641 * stop all the transfers, if not already stopped:
643 usbd_transfer_stop(sc->sc_xfer[CUE_BULK_DT_WR]);
644 usbd_transfer_stop(sc->sc_xfer[CUE_BULK_DT_RD]);
646 cue_csr_write_1(sc, CUE_ETHCTL, 0);