1 /* $OpenBSD: if_kue.c,v 1.92 2020/07/31 10:49:32 mglocker Exp $ */ 2 /* $NetBSD: if_kue.c,v 1.50 2002/07/16 22:00:31 augustss Exp $ */ 3 /* 4 * Copyright (c) 1997, 1998, 1999, 2000 5 * Bill Paul <wpaul@ee.columbia.edu>. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 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. 21 * 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. 33 * 34 * $FreeBSD: src/sys/dev/usb/if_kue.c,v 1.14 2000/01/14 01:36:15 wpaul Exp $ 35 */ 36 37 /* 38 * Kawasaki LSI KL5KUSB101B USB to ethernet adapter driver. 39 * 40 * Written by Bill Paul <wpaul@ee.columbia.edu> 41 * Electrical Engineering Department 42 * Columbia University, New York City 43 */ 44 45 /* 46 * The KLSI USB to ethernet adapter chip contains an USB serial interface, 47 * ethernet MAC and embedded microcontroller (called the QT Engine). 48 * The chip must have firmware loaded into it before it will operate. 49 * Packets are passed between the chip and host via bulk transfers. 50 * There is an interrupt endpoint mentioned in the software spec, however 51 * it's currently unused. This device is 10Mbps half-duplex only, hence 52 * there is no media selection logic. The MAC supports a 128 entry 53 * multicast filter, though the exact size of the filter can depend 54 * on the firmware. Curiously, while the software spec describes various 55 * ethernet statistics counters, my sample adapter and firmware combination 56 * claims not to support any statistics counters at all. 57 * 58 * Note that once we load the firmware in the device, we have to be 59 * careful not to load it again: if you restart your computer but 60 * leave the adapter attached to the USB controller, it may remain 61 * powered on and retain its firmware. In this case, we don't need 62 * to load the firmware a second time. 63 * 64 * Special thanks to Rob Furr for providing an ADS Technologies 65 * adapter for development and testing. No monkeys were harmed during 66 * the development of this driver. 67 */ 68 69 /* 70 * Ported to NetBSD and somewhat rewritten by Lennart Augustsson. 71 */ 72 73 #include "bpfilter.h" 74 75 #include <sys/param.h> 76 #include <sys/systm.h> 77 #include <sys/sockio.h> 78 #include <sys/mbuf.h> 79 #include <sys/malloc.h> 80 #include <sys/kernel.h> 81 #include <sys/socket.h> 82 #include <sys/device.h> 83 84 #include <net/if.h> 85 86 #if NBPFILTER > 0 87 #include <net/bpf.h> 88 #endif 89 90 #include <netinet/in.h> 91 #include <netinet/if_ether.h> 92 93 #include <dev/usb/usb.h> 94 #include <dev/usb/usbdi.h> 95 #include <dev/usb/usbdi_util.h> 96 #include <dev/usb/usbdevs.h> 97 98 #include <dev/usb/if_kuereg.h> 99 #include <dev/usb/if_kuevar.h> 100 101 #ifdef KUE_DEBUG 102 #define DPRINTF(x) do { if (kuedebug) printf x; } while (0) 103 #define DPRINTFN(n,x) do { if (kuedebug >= (n)) printf x; } while (0) 104 int kuedebug = 0; 105 #else 106 #define DPRINTF(x) 107 #define DPRINTFN(n,x) 108 #endif 109 110 /* 111 * Various supported device vendors/products. 112 */ 113 const struct usb_devno kue_devs[] = { 114 { USB_VENDOR_3COM, USB_PRODUCT_3COM_3C19250 }, 115 { USB_VENDOR_3COM, USB_PRODUCT_3COM_3C460 }, 116 { USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_URE450 }, 117 { USB_VENDOR_ADS, USB_PRODUCT_ADS_UBS10BT }, 118 { USB_VENDOR_ADS, USB_PRODUCT_ADS_UBS10BTX }, 119 { USB_VENDOR_AOX, USB_PRODUCT_AOX_USB101 }, 120 { USB_VENDOR_ASANTE, USB_PRODUCT_ASANTE_EA }, 121 { USB_VENDOR_ATEN, USB_PRODUCT_ATEN_UC10T }, 122 { USB_VENDOR_ATEN, USB_PRODUCT_ATEN_DSB650C }, 123 { USB_VENDOR_COREGA, USB_PRODUCT_COREGA_ETHER_USB_T }, 124 { USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650C }, 125 { USB_VENDOR_ENTREGA, USB_PRODUCT_ENTREGA_E45 }, 126 { USB_VENDOR_ENTREGA, USB_PRODUCT_ENTREGA_XX1 }, 127 { USB_VENDOR_ENTREGA, USB_PRODUCT_ENTREGA_XX2 }, 128 { USB_VENDOR_IODATA, USB_PRODUCT_IODATA_USBETT }, 129 { USB_VENDOR_JATON, USB_PRODUCT_JATON_EDA }, 130 { USB_VENDOR_KINGSTON, USB_PRODUCT_KINGSTON_XX1 }, 131 { USB_VENDOR_KLSI, USB_PRODUCT_KLSI_DUH3E10BT }, 132 { USB_VENDOR_KLSI, USB_PRODUCT_KLSI_DUH3E10BTN }, 133 { USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB10T }, 134 { USB_VENDOR_MOBILITY, USB_PRODUCT_MOBILITY_EA }, 135 { USB_VENDOR_NETGEAR, USB_PRODUCT_NETGEAR_EA101 }, 136 { USB_VENDOR_NETGEAR, USB_PRODUCT_NETGEAR_EA101X }, 137 { USB_VENDOR_PERACOM, USB_PRODUCT_PERACOM_ENET }, 138 { USB_VENDOR_PERACOM, USB_PRODUCT_PERACOM_ENET2 }, 139 { USB_VENDOR_PERACOM, USB_PRODUCT_PERACOM_ENET3 }, 140 { USB_VENDOR_PORTGEAR, USB_PRODUCT_PORTGEAR_EA8 }, 141 { USB_VENDOR_PORTGEAR, USB_PRODUCT_PORTGEAR_EA9 }, 142 { USB_VENDOR_PORTSMITH, USB_PRODUCT_PORTSMITH_EEA }, 143 { USB_VENDOR_SHARK, USB_PRODUCT_SHARK_PA }, 144 { USB_VENDOR_SILICOM, USB_PRODUCT_SILICOM_U2E }, 145 { USB_VENDOR_SILICOM, USB_PRODUCT_SILICOM_GPE }, 146 { USB_VENDOR_SMC, USB_PRODUCT_SMC_2102USB }, 147 }; 148 149 int kue_match(struct device *, void *, void *); 150 void kue_attach(struct device *, struct device *, void *); 151 int kue_detach(struct device *, int); 152 153 struct cfdriver kue_cd = { 154 NULL, "kue", DV_IFNET 155 }; 156 157 const struct cfattach kue_ca = { 158 sizeof(struct kue_softc), kue_match, kue_attach, kue_detach 159 }; 160 161 int kue_tx_list_init(struct kue_softc *); 162 int kue_rx_list_init(struct kue_softc *); 163 int kue_newbuf(struct kue_softc *, struct kue_chain *,struct mbuf *); 164 int kue_send(struct kue_softc *, struct mbuf *, int); 165 int kue_open_pipes(struct kue_softc *); 166 void kue_rxeof(struct usbd_xfer *, void *, usbd_status); 167 void kue_txeof(struct usbd_xfer *, void *, usbd_status); 168 void kue_start(struct ifnet *); 169 int kue_ioctl(struct ifnet *, u_long, caddr_t); 170 void kue_init(void *); 171 void kue_stop(struct kue_softc *); 172 void kue_watchdog(struct ifnet *); 173 174 void kue_setmulti(struct kue_softc *); 175 void kue_reset(struct kue_softc *); 176 177 usbd_status kue_ctl(struct kue_softc *, int, u_int8_t, 178 u_int16_t, void *, u_int32_t); 179 usbd_status kue_setword(struct kue_softc *, u_int8_t, u_int16_t); 180 int kue_load_fw(struct kue_softc *); 181 void kue_attachhook(struct device *); 182 183 usbd_status 184 kue_setword(struct kue_softc *sc, u_int8_t breq, u_int16_t word) 185 { 186 usb_device_request_t req; 187 188 DPRINTFN(10,("%s: %s: enter\n", sc->kue_dev.dv_xname,__func__)); 189 190 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 191 req.bRequest = breq; 192 USETW(req.wValue, word); 193 USETW(req.wIndex, 0); 194 USETW(req.wLength, 0); 195 196 return (usbd_do_request(sc->kue_udev, &req, NULL)); 197 } 198 199 usbd_status 200 kue_ctl(struct kue_softc *sc, int rw, u_int8_t breq, u_int16_t val, 201 void *data, u_int32_t len) 202 { 203 usb_device_request_t req; 204 205 DPRINTFN(10,("%s: %s: enter, len=%d\n", sc->kue_dev.dv_xname, 206 __func__, len)); 207 208 if (rw == KUE_CTL_WRITE) 209 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 210 else 211 req.bmRequestType = UT_READ_VENDOR_DEVICE; 212 213 req.bRequest = breq; 214 USETW(req.wValue, val); 215 USETW(req.wIndex, 0); 216 USETW(req.wLength, len); 217 218 return (usbd_do_request(sc->kue_udev, &req, data)); 219 } 220 221 int 222 kue_load_fw(struct kue_softc *sc) 223 { 224 usb_device_descriptor_t *dd; 225 usbd_status err; 226 struct kue_firmware *fw; 227 u_char *buf; 228 size_t buflen; 229 230 DPRINTFN(1,("%s: %s: enter\n", sc->kue_dev.dv_xname, __func__)); 231 232 /* 233 * First, check if we even need to load the firmware. 234 * If the device was still attached when the system was 235 * rebooted, it may already have firmware loaded in it. 236 * If this is the case, we don't need to do it again. 237 * And in fact, if we try to load it again, we'll hang, 238 * so we have to avoid this condition if we don't want 239 * to look stupid. 240 * 241 * We can test this quickly by checking the bcdRevision 242 * code. The NIC will return a different revision code if 243 * it's probed while the firmware is still loaded and 244 * running. 245 */ 246 if ((dd = usbd_get_device_descriptor(sc->kue_udev)) == NULL) 247 return (EIO); 248 if (UGETW(dd->bcdDevice) >= KUE_WARM_REV) { 249 printf("%s: warm boot, no firmware download\n", 250 sc->kue_dev.dv_xname); 251 return (0); 252 } 253 254 err = loadfirmware("kue", &buf, &buflen); 255 if (err) { 256 printf("%s: failed loadfirmware of file %s: errno %d\n", 257 sc->kue_dev.dv_xname, "kue", err); 258 return (err); 259 } 260 fw = (struct kue_firmware *)buf; 261 262 printf("%s: cold boot, downloading firmware\n", 263 sc->kue_dev.dv_xname); 264 265 /* Load code segment */ 266 DPRINTFN(1,("%s: kue_load_fw: download code_seg\n", 267 sc->kue_dev.dv_xname)); 268 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN, 269 0, (void *)&fw->data[0], ntohl(fw->codeseglen)); 270 if (err) { 271 printf("%s: failed to load code segment: %s\n", 272 sc->kue_dev.dv_xname, usbd_errstr(err)); 273 free(buf, M_DEVBUF, buflen); 274 return (EIO); 275 } 276 277 /* Load fixup segment */ 278 DPRINTFN(1,("%s: kue_load_fw: download fix_seg\n", 279 sc->kue_dev.dv_xname)); 280 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN, 281 0, (void *)&fw->data[ntohl(fw->codeseglen)], ntohl(fw->fixseglen)); 282 if (err) { 283 printf("%s: failed to load fixup segment: %s\n", 284 sc->kue_dev.dv_xname, usbd_errstr(err)); 285 free(buf, M_DEVBUF, buflen); 286 return (EIO); 287 } 288 289 /* Send trigger command. */ 290 DPRINTFN(1,("%s: kue_load_fw: download trig_seg\n", 291 sc->kue_dev.dv_xname)); 292 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN, 293 0, (void *)&fw->data[ntohl(fw->codeseglen) + ntohl(fw->fixseglen)], 294 ntohl(fw->trigseglen)); 295 if (err) { 296 printf("%s: failed to load trigger segment: %s\n", 297 sc->kue_dev.dv_xname, usbd_errstr(err)); 298 free(buf, M_DEVBUF, buflen); 299 return (EIO); 300 } 301 free(buf, M_DEVBUF, buflen); 302 303 usbd_delay_ms(sc->kue_udev, 10); 304 305 /* 306 * Reload device descriptor. 307 * Why? The chip without the firmware loaded returns 308 * one revision code. The chip with the firmware 309 * loaded and running returns a *different* revision 310 * code. This confuses the quirk mechanism, which is 311 * dependent on the revision data. 312 */ 313 (void)usbd_reload_device_desc(sc->kue_udev); 314 315 DPRINTFN(1,("%s: %s: done\n", sc->kue_dev.dv_xname, __func__)); 316 317 /* Reset the adapter. */ 318 kue_reset(sc); 319 320 return (0); 321 } 322 323 void 324 kue_setmulti(struct kue_softc *sc) 325 { 326 struct arpcom *ac = &sc->arpcom; 327 struct ifnet *ifp = GET_IFP(sc); 328 struct ether_multi *enm; 329 struct ether_multistep step; 330 int i; 331 332 DPRINTFN(5,("%s: %s: enter\n", sc->kue_dev.dv_xname, __func__)); 333 334 if (ifp->if_flags & IFF_PROMISC || ac->ac_multirangecnt > 0) { 335 allmulti: 336 ifp->if_flags |= IFF_ALLMULTI; 337 sc->kue_rxfilt |= KUE_RXFILT_ALLMULTI; 338 sc->kue_rxfilt &= ~KUE_RXFILT_MULTICAST; 339 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->kue_rxfilt); 340 return; 341 } 342 343 sc->kue_rxfilt &= ~KUE_RXFILT_ALLMULTI; 344 345 i = 0; 346 ETHER_FIRST_MULTI(step, ac, enm); 347 while (enm != NULL) { 348 if (i == KUE_MCFILTCNT(sc)) 349 goto allmulti; 350 351 memcpy(KUE_MCFILT(sc, i), enm->enm_addrlo, ETHER_ADDR_LEN); 352 ETHER_NEXT_MULTI(step, enm); 353 i++; 354 } 355 356 ifp->if_flags &= ~IFF_ALLMULTI; 357 358 sc->kue_rxfilt |= KUE_RXFILT_MULTICAST; 359 kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MCAST_FILTERS, 360 i, sc->kue_mcfilters, i * ETHER_ADDR_LEN); 361 362 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->kue_rxfilt); 363 } 364 365 /* 366 * Issue a SET_CONFIGURATION command to reset the MAC. This should be 367 * done after the firmware is loaded into the adapter in order to 368 * bring it into proper operation. 369 */ 370 void 371 kue_reset(struct kue_softc *sc) 372 { 373 DPRINTFN(5,("%s: %s: enter\n", sc->kue_dev.dv_xname, __func__)); 374 375 if (usbd_set_config_no(sc->kue_udev, KUE_CONFIG_NO, 1) || 376 usbd_device2interface_handle(sc->kue_udev, KUE_IFACE_IDX, 377 &sc->kue_iface)) 378 printf("%s: reset failed\n", sc->kue_dev.dv_xname); 379 380 /* Wait a little while for the chip to get its brains in order. */ 381 usbd_delay_ms(sc->kue_udev, 10); 382 } 383 384 /* 385 * Probe for a KLSI chip. 386 */ 387 int 388 kue_match(struct device *parent, void *match, void *aux) 389 { 390 struct usb_attach_arg *uaa = aux; 391 392 DPRINTFN(25,("kue_match: enter\n")); 393 394 if (uaa->iface != NULL) 395 return (UMATCH_NONE); 396 397 return (usb_lookup(kue_devs, uaa->vendor, uaa->product) != NULL ? 398 UMATCH_VENDOR_PRODUCT : UMATCH_NONE); 399 } 400 401 void 402 kue_attachhook(struct device *self) 403 { 404 struct kue_softc *sc = (struct kue_softc *)self; 405 int s; 406 struct ifnet *ifp; 407 struct usbd_device *dev = sc->kue_udev; 408 struct usbd_interface *iface; 409 usbd_status err; 410 usb_interface_descriptor_t *id; 411 usb_endpoint_descriptor_t *ed; 412 int i; 413 414 /* Load the firmware into the NIC. */ 415 if (kue_load_fw(sc)) { 416 printf("%s: loading firmware failed\n", 417 sc->kue_dev.dv_xname); 418 return; 419 } 420 421 err = usbd_device2interface_handle(dev, KUE_IFACE_IDX, &iface); 422 if (err) { 423 printf("%s: getting interface handle failed\n", 424 sc->kue_dev.dv_xname); 425 return; 426 } 427 428 sc->kue_iface = iface; 429 id = usbd_get_interface_descriptor(iface); 430 431 /* Find endpoints. */ 432 for (i = 0; i < id->bNumEndpoints; i++) { 433 ed = usbd_interface2endpoint_descriptor(iface, i); 434 if (ed == NULL) { 435 printf("%s: couldn't get ep %d\n", 436 sc->kue_dev.dv_xname, i); 437 return; 438 } 439 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 440 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) { 441 sc->kue_ed[KUE_ENDPT_RX] = ed->bEndpointAddress; 442 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT && 443 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) { 444 sc->kue_ed[KUE_ENDPT_TX] = ed->bEndpointAddress; 445 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 446 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) { 447 sc->kue_ed[KUE_ENDPT_INTR] = ed->bEndpointAddress; 448 } 449 } 450 451 if (sc->kue_ed[KUE_ENDPT_RX] == 0 || sc->kue_ed[KUE_ENDPT_TX] == 0) { 452 printf("%s: missing endpoint\n", sc->kue_dev.dv_xname); 453 return; 454 } 455 456 /* Read ethernet descriptor */ 457 err = kue_ctl(sc, KUE_CTL_READ, KUE_CMD_GET_ETHER_DESCRIPTOR, 458 0, &sc->kue_desc, sizeof(sc->kue_desc)); 459 if (err) { 460 printf("%s: could not read Ethernet descriptor\n", 461 sc->kue_dev.dv_xname); 462 return; 463 } 464 465 sc->kue_mcfilters = mallocarray(KUE_MCFILTCNT(sc), ETHER_ADDR_LEN, 466 M_USBDEV, M_NOWAIT); 467 if (sc->kue_mcfilters == NULL) { 468 printf("%s: no memory for multicast filter buffer\n", 469 sc->kue_dev.dv_xname); 470 return; 471 } 472 sc->kue_mcfilterslen = KUE_MCFILTCNT(sc); 473 474 s = splnet(); 475 476 /* 477 * A KLSI chip was detected. Inform the world. 478 */ 479 printf("%s: address %s\n", sc->kue_dev.dv_xname, 480 ether_sprintf(sc->kue_desc.kue_macaddr)); 481 482 bcopy(sc->kue_desc.kue_macaddr, 483 (char *)&sc->arpcom.ac_enaddr, ETHER_ADDR_LEN); 484 485 /* Initialize interface info.*/ 486 ifp = GET_IFP(sc); 487 ifp->if_softc = sc; 488 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST; 489 ifp->if_ioctl = kue_ioctl; 490 ifp->if_start = kue_start; 491 ifp->if_watchdog = kue_watchdog; 492 strlcpy(ifp->if_xname, sc->kue_dev.dv_xname, IFNAMSIZ); 493 494 /* Attach the interface. */ 495 if_attach(ifp); 496 ether_ifattach(ifp); 497 498 sc->kue_attached = 1; 499 splx(s); 500 501 } 502 503 /* 504 * Attach the interface. Allocate softc structures, do 505 * setup and ethernet/BPF attach. 506 */ 507 void 508 kue_attach(struct device *parent, struct device *self, void *aux) 509 { 510 struct kue_softc *sc = (struct kue_softc *)self; 511 struct usb_attach_arg *uaa = aux; 512 struct usbd_device *dev = uaa->device; 513 usbd_status err; 514 515 DPRINTFN(5,(" : kue_attach: sc=%p, dev=%p", sc, dev)); 516 517 err = usbd_set_config_no(dev, KUE_CONFIG_NO, 1); 518 if (err) { 519 printf("%s: setting config no failed\n", 520 sc->kue_dev.dv_xname); 521 return; 522 } 523 524 sc->kue_udev = dev; 525 sc->kue_product = uaa->product; 526 sc->kue_vendor = uaa->vendor; 527 528 config_mountroot(self, kue_attachhook); 529 } 530 531 int 532 kue_detach(struct device *self, int flags) 533 { 534 struct kue_softc *sc = (struct kue_softc *)self; 535 struct ifnet *ifp = GET_IFP(sc); 536 int s; 537 538 /* Detached before attached finished, so just bail out. */ 539 if (!sc->kue_attached) 540 return (0); 541 542 s = splusb(); /* XXX why? */ 543 544 if (sc->kue_mcfilters != NULL) { 545 free(sc->kue_mcfilters, M_USBDEV, sc->kue_mcfilterslen); 546 sc->kue_mcfilters = NULL; 547 } 548 549 if (ifp->if_flags & IFF_RUNNING) 550 kue_stop(sc); 551 552 if (ifp->if_softc != NULL) { 553 ether_ifdetach(ifp); 554 if_detach(ifp); 555 } 556 557 #ifdef DIAGNOSTIC 558 if (sc->kue_ep[KUE_ENDPT_TX] != NULL || 559 sc->kue_ep[KUE_ENDPT_RX] != NULL || 560 sc->kue_ep[KUE_ENDPT_INTR] != NULL) 561 printf("%s: detach has active endpoints\n", 562 sc->kue_dev.dv_xname); 563 #endif 564 565 sc->kue_attached = 0; 566 splx(s); 567 568 return (0); 569 } 570 571 /* 572 * Initialize an RX descriptor and attach an MBUF cluster. 573 */ 574 int 575 kue_newbuf(struct kue_softc *sc, struct kue_chain *c, struct mbuf *m) 576 { 577 struct mbuf *m_new = NULL; 578 579 DPRINTFN(10,("%s: %s: enter\n", sc->kue_dev.dv_xname,__func__)); 580 581 if (m == NULL) { 582 MGETHDR(m_new, M_DONTWAIT, MT_DATA); 583 if (m_new == NULL) { 584 printf("%s: no memory for rx list " 585 "-- packet dropped!\n", sc->kue_dev.dv_xname); 586 return (ENOBUFS); 587 } 588 589 MCLGET(m_new, M_DONTWAIT); 590 if (!(m_new->m_flags & M_EXT)) { 591 printf("%s: no memory for rx list " 592 "-- packet dropped!\n", sc->kue_dev.dv_xname); 593 m_freem(m_new); 594 return (ENOBUFS); 595 } 596 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES; 597 } else { 598 m_new = m; 599 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES; 600 m_new->m_data = m_new->m_ext.ext_buf; 601 } 602 603 c->kue_mbuf = m_new; 604 605 return (0); 606 } 607 608 int 609 kue_rx_list_init(struct kue_softc *sc) 610 { 611 struct kue_cdata *cd; 612 struct kue_chain *c; 613 int i; 614 615 DPRINTFN(5,("%s: %s: enter\n", sc->kue_dev.dv_xname, __func__)); 616 617 cd = &sc->kue_cdata; 618 for (i = 0; i < KUE_RX_LIST_CNT; i++) { 619 c = &cd->kue_rx_chain[i]; 620 c->kue_sc = sc; 621 c->kue_idx = i; 622 if (kue_newbuf(sc, c, NULL) == ENOBUFS) 623 return (ENOBUFS); 624 if (c->kue_xfer == NULL) { 625 c->kue_xfer = usbd_alloc_xfer(sc->kue_udev); 626 if (c->kue_xfer == NULL) 627 return (ENOBUFS); 628 c->kue_buf = usbd_alloc_buffer(c->kue_xfer, KUE_BUFSZ); 629 if (c->kue_buf == NULL) 630 return (ENOBUFS); /* XXX free xfer */ 631 } 632 } 633 634 return (0); 635 } 636 637 int 638 kue_tx_list_init(struct kue_softc *sc) 639 { 640 struct kue_cdata *cd; 641 struct kue_chain *c; 642 int i; 643 644 DPRINTFN(5,("%s: %s: enter\n", sc->kue_dev.dv_xname, __func__)); 645 646 cd = &sc->kue_cdata; 647 for (i = 0; i < KUE_TX_LIST_CNT; i++) { 648 c = &cd->kue_tx_chain[i]; 649 c->kue_sc = sc; 650 c->kue_idx = i; 651 c->kue_mbuf = NULL; 652 if (c->kue_xfer == NULL) { 653 c->kue_xfer = usbd_alloc_xfer(sc->kue_udev); 654 if (c->kue_xfer == NULL) 655 return (ENOBUFS); 656 c->kue_buf = usbd_alloc_buffer(c->kue_xfer, KUE_BUFSZ); 657 if (c->kue_buf == NULL) 658 return (ENOBUFS); 659 } 660 } 661 662 return (0); 663 } 664 665 /* 666 * A frame has been uploaded: pass the resulting mbuf chain up to 667 * the higher level protocols. 668 */ 669 void 670 kue_rxeof(struct usbd_xfer *xfer, void *priv, usbd_status status) 671 { 672 struct kue_chain *c = priv; 673 struct kue_softc *sc = c->kue_sc; 674 struct ifnet *ifp = GET_IFP(sc); 675 struct mbuf_list ml = MBUF_LIST_INITIALIZER(); 676 struct mbuf *m; 677 int total_len = 0; 678 int s; 679 680 DPRINTFN(10,("%s: %s: enter status=%d\n", sc->kue_dev.dv_xname, 681 __func__, status)); 682 683 if (usbd_is_dying(sc->kue_udev)) 684 return; 685 686 if (!(ifp->if_flags & IFF_RUNNING)) 687 return; 688 689 if (status != USBD_NORMAL_COMPLETION) { 690 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) 691 return; 692 sc->kue_rx_errs++; 693 if (usbd_ratecheck(&sc->kue_rx_notice)) { 694 printf("%s: %u usb errors on rx: %s\n", 695 sc->kue_dev.dv_xname, sc->kue_rx_errs, 696 usbd_errstr(status)); 697 sc->kue_rx_errs = 0; 698 } 699 if (status == USBD_STALLED) 700 usbd_clear_endpoint_stall_async(sc->kue_ep[KUE_ENDPT_RX]); 701 goto done; 702 } 703 704 usbd_get_xfer_status(xfer, NULL, NULL, &total_len, NULL); 705 706 DPRINTFN(10,("%s: %s: total_len=%d len=%d\n", sc->kue_dev.dv_xname, 707 __func__, total_len, 708 UGETW(mtod(c->kue_mbuf, u_int8_t *)))); 709 710 if (total_len <= 1) 711 goto done; 712 713 m = c->kue_mbuf; 714 /* copy data to mbuf */ 715 memcpy(mtod(m, char *), c->kue_buf, total_len); 716 717 /* No errors; receive the packet. */ 718 total_len = UGETW(mtod(m, u_int8_t *)); 719 m_adj(m, sizeof(u_int16_t)); 720 721 if (total_len < sizeof(struct ether_header)) { 722 ifp->if_ierrors++; 723 goto done; 724 } 725 726 m->m_pkthdr.len = m->m_len = total_len; 727 ml_enqueue(&ml, m); 728 729 if (kue_newbuf(sc, c, NULL) == ENOBUFS) { 730 ifp->if_ierrors++; 731 goto done; 732 } 733 734 s = splnet(); 735 if_input(ifp, &ml); 736 splx(s); 737 738 done: 739 740 /* Setup new transfer. */ 741 usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_RX], 742 c, c->kue_buf, KUE_BUFSZ, USBD_SHORT_XFER_OK | USBD_NO_COPY, 743 USBD_NO_TIMEOUT, kue_rxeof); 744 usbd_transfer(c->kue_xfer); 745 746 DPRINTFN(10,("%s: %s: start rx\n", sc->kue_dev.dv_xname, 747 __func__)); 748 } 749 750 /* 751 * A frame was downloaded to the chip. It's safe for us to clean up 752 * the list buffers. 753 */ 754 755 void 756 kue_txeof(struct usbd_xfer *xfer, void *priv, usbd_status status) 757 { 758 struct kue_chain *c = priv; 759 struct kue_softc *sc = c->kue_sc; 760 struct ifnet *ifp = GET_IFP(sc); 761 int s; 762 763 if (usbd_is_dying(sc->kue_udev)) 764 return; 765 766 s = splnet(); 767 768 DPRINTFN(10,("%s: %s: enter status=%d\n", sc->kue_dev.dv_xname, 769 __func__, status)); 770 771 ifp->if_timer = 0; 772 ifq_clr_oactive(&ifp->if_snd); 773 774 if (status != USBD_NORMAL_COMPLETION) { 775 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) { 776 splx(s); 777 return; 778 } 779 ifp->if_oerrors++; 780 printf("%s: usb error on tx: %s\n", sc->kue_dev.dv_xname, 781 usbd_errstr(status)); 782 if (status == USBD_STALLED) 783 usbd_clear_endpoint_stall_async(sc->kue_ep[KUE_ENDPT_TX]); 784 splx(s); 785 return; 786 } 787 788 m_freem(c->kue_mbuf); 789 c->kue_mbuf = NULL; 790 791 if (ifq_empty(&ifp->if_snd) == 0) 792 kue_start(ifp); 793 794 splx(s); 795 } 796 797 int 798 kue_send(struct kue_softc *sc, struct mbuf *m, int idx) 799 { 800 int total_len; 801 struct kue_chain *c; 802 usbd_status err; 803 804 DPRINTFN(10,("%s: %s: enter\n", sc->kue_dev.dv_xname,__func__)); 805 806 c = &sc->kue_cdata.kue_tx_chain[idx]; 807 808 /* 809 * Copy the mbuf data into a contiguous buffer, leaving two 810 * bytes at the beginning to hold the frame length. 811 */ 812 m_copydata(m, 0, m->m_pkthdr.len, c->kue_buf + 2); 813 c->kue_mbuf = m; 814 815 total_len = m->m_pkthdr.len + 2; 816 /* XXX what's this? */ 817 total_len += 64 - (total_len % 64); 818 819 /* Frame length is specified in the first 2 bytes of the buffer. */ 820 c->kue_buf[0] = (u_int8_t)m->m_pkthdr.len; 821 c->kue_buf[1] = (u_int8_t)(m->m_pkthdr.len >> 8); 822 823 usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_TX], 824 c, c->kue_buf, total_len, USBD_NO_COPY, USBD_DEFAULT_TIMEOUT, 825 kue_txeof); 826 827 /* Transmit */ 828 err = usbd_transfer(c->kue_xfer); 829 if (err != USBD_IN_PROGRESS) { 830 printf("%s: kue_send error=%s\n", sc->kue_dev.dv_xname, 831 usbd_errstr(err)); 832 c->kue_mbuf = NULL; 833 kue_stop(sc); 834 return (EIO); 835 } 836 837 sc->kue_cdata.kue_tx_cnt++; 838 839 return (0); 840 } 841 842 void 843 kue_start(struct ifnet *ifp) 844 { 845 struct kue_softc *sc = ifp->if_softc; 846 struct mbuf *m_head = NULL; 847 848 DPRINTFN(10,("%s: %s: enter\n", sc->kue_dev.dv_xname,__func__)); 849 850 if (usbd_is_dying(sc->kue_udev)) 851 return; 852 853 if (ifq_is_oactive(&ifp->if_snd)) 854 return; 855 856 m_head = ifq_dequeue(&ifp->if_snd); 857 if (m_head == NULL) 858 return; 859 860 if (kue_send(sc, m_head, 0)) { 861 m_freem(m_head); 862 ifq_set_oactive(&ifp->if_snd); 863 return; 864 } 865 866 #if NBPFILTER > 0 867 /* 868 * If there's a BPF listener, bounce a copy of this frame 869 * to him. 870 */ 871 if (ifp->if_bpf) 872 bpf_mtap(ifp->if_bpf, m_head, BPF_DIRECTION_OUT); 873 #endif 874 875 ifq_set_oactive(&ifp->if_snd); 876 877 /* 878 * Set a timeout in case the chip goes out to lunch. 879 */ 880 ifp->if_timer = 6; 881 } 882 883 void 884 kue_init(void *xsc) 885 { 886 struct kue_softc *sc = xsc; 887 struct ifnet *ifp = GET_IFP(sc); 888 int s; 889 u_char *eaddr; 890 891 DPRINTFN(5,("%s: %s: enter\n", sc->kue_dev.dv_xname,__func__)); 892 893 if (ifp->if_flags & IFF_RUNNING) 894 return; 895 896 s = splnet(); 897 898 eaddr = sc->arpcom.ac_enaddr; 899 /* Set MAC address */ 900 kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MAC, 0, eaddr, ETHER_ADDR_LEN); 901 902 sc->kue_rxfilt = KUE_RXFILT_UNICAST | KUE_RXFILT_BROADCAST; 903 904 /* If we want promiscuous mode, set the allframes bit. */ 905 if (ifp->if_flags & IFF_PROMISC) 906 sc->kue_rxfilt |= KUE_RXFILT_PROMISC; 907 908 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->kue_rxfilt); 909 910 /* I'm not sure how to tune these. */ 911 #if 0 912 /* 913 * Leave this one alone for now; setting it 914 * wrong causes lockups on some machines/controllers. 915 */ 916 kue_setword(sc, KUE_CMD_SET_SOFS, 1); 917 #endif 918 kue_setword(sc, KUE_CMD_SET_URB_SIZE, 64); 919 920 /* Init TX ring. */ 921 if (kue_tx_list_init(sc) == ENOBUFS) { 922 printf("%s: tx list init failed\n", sc->kue_dev.dv_xname); 923 splx(s); 924 return; 925 } 926 927 /* Init RX ring. */ 928 if (kue_rx_list_init(sc) == ENOBUFS) { 929 printf("%s: rx list init failed\n", sc->kue_dev.dv_xname); 930 splx(s); 931 return; 932 } 933 934 /* Load the multicast filter. */ 935 kue_setmulti(sc); 936 937 if (sc->kue_ep[KUE_ENDPT_RX] == NULL) { 938 if (kue_open_pipes(sc)) { 939 splx(s); 940 return; 941 } 942 } 943 944 ifp->if_flags |= IFF_RUNNING; 945 ifq_clr_oactive(&ifp->if_snd); 946 947 splx(s); 948 } 949 950 int 951 kue_open_pipes(struct kue_softc *sc) 952 { 953 usbd_status err; 954 struct kue_chain *c; 955 int i; 956 957 DPRINTFN(5,("%s: %s: enter\n", sc->kue_dev.dv_xname,__func__)); 958 959 /* Open RX and TX pipes. */ 960 err = usbd_open_pipe(sc->kue_iface, sc->kue_ed[KUE_ENDPT_RX], 961 USBD_EXCLUSIVE_USE, &sc->kue_ep[KUE_ENDPT_RX]); 962 if (err) { 963 printf("%s: open rx pipe failed: %s\n", 964 sc->kue_dev.dv_xname, usbd_errstr(err)); 965 return (EIO); 966 } 967 968 err = usbd_open_pipe(sc->kue_iface, sc->kue_ed[KUE_ENDPT_TX], 969 USBD_EXCLUSIVE_USE, &sc->kue_ep[KUE_ENDPT_TX]); 970 if (err) { 971 printf("%s: open tx pipe failed: %s\n", 972 sc->kue_dev.dv_xname, usbd_errstr(err)); 973 return (EIO); 974 } 975 976 /* Start up the receive pipe. */ 977 for (i = 0; i < KUE_RX_LIST_CNT; i++) { 978 c = &sc->kue_cdata.kue_rx_chain[i]; 979 usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_RX], 980 c, c->kue_buf, KUE_BUFSZ, 981 USBD_SHORT_XFER_OK | USBD_NO_COPY, USBD_NO_TIMEOUT, 982 kue_rxeof); 983 DPRINTFN(5,("%s: %s: start read\n", sc->kue_dev.dv_xname, 984 __func__)); 985 usbd_transfer(c->kue_xfer); 986 } 987 988 return (0); 989 } 990 991 int 992 kue_ioctl(struct ifnet *ifp, u_long command, caddr_t data) 993 { 994 struct kue_softc *sc = ifp->if_softc; 995 int s, error = 0; 996 997 DPRINTFN(5,("%s: %s: enter\n", sc->kue_dev.dv_xname,__func__)); 998 999 if (usbd_is_dying(sc->kue_udev)) 1000 return ENXIO; 1001 1002 #ifdef DIAGNOSTIC 1003 if (!curproc) { 1004 printf("%s: no proc!!\n", sc->kue_dev.dv_xname); 1005 return EIO; 1006 } 1007 #endif 1008 1009 s = splnet(); 1010 1011 switch(command) { 1012 case SIOCSIFADDR: 1013 ifp->if_flags |= IFF_UP; 1014 kue_init(sc); 1015 break; 1016 1017 case SIOCSIFFLAGS: 1018 if (ifp->if_flags & IFF_UP) { 1019 if (ifp->if_flags & IFF_RUNNING && 1020 ifp->if_flags & IFF_PROMISC && 1021 !(sc->kue_if_flags & IFF_PROMISC)) { 1022 sc->kue_rxfilt |= KUE_RXFILT_PROMISC; 1023 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, 1024 sc->kue_rxfilt); 1025 } else if (ifp->if_flags & IFF_RUNNING && 1026 !(ifp->if_flags & IFF_PROMISC) && 1027 sc->kue_if_flags & IFF_PROMISC) { 1028 sc->kue_rxfilt &= ~KUE_RXFILT_PROMISC; 1029 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, 1030 sc->kue_rxfilt); 1031 } else if (!(ifp->if_flags & IFF_RUNNING)) 1032 kue_init(sc); 1033 } else { 1034 if (ifp->if_flags & IFF_RUNNING) 1035 kue_stop(sc); 1036 } 1037 sc->kue_if_flags = ifp->if_flags; 1038 error = 0; 1039 break; 1040 1041 default: 1042 error = ether_ioctl(ifp, &sc->arpcom, command, data); 1043 } 1044 1045 if (error == ENETRESET) { 1046 if (ifp->if_flags & IFF_RUNNING) 1047 kue_setmulti(sc); 1048 error = 0; 1049 } 1050 1051 splx(s); 1052 return (error); 1053 } 1054 1055 void 1056 kue_watchdog(struct ifnet *ifp) 1057 { 1058 struct kue_softc *sc = ifp->if_softc; 1059 struct kue_chain *c; 1060 usbd_status stat; 1061 int s; 1062 1063 DPRINTFN(5,("%s: %s: enter\n", sc->kue_dev.dv_xname,__func__)); 1064 1065 if (usbd_is_dying(sc->kue_udev)) 1066 return; 1067 1068 ifp->if_oerrors++; 1069 printf("%s: watchdog timeout\n", sc->kue_dev.dv_xname); 1070 1071 s = splusb(); 1072 c = &sc->kue_cdata.kue_tx_chain[0]; 1073 usbd_get_xfer_status(c->kue_xfer, NULL, NULL, NULL, &stat); 1074 kue_txeof(c->kue_xfer, c, stat); 1075 1076 if (ifq_empty(&ifp->if_snd) == 0) 1077 kue_start(ifp); 1078 splx(s); 1079 } 1080 1081 /* 1082 * Stop the adapter and free any mbufs allocated to the 1083 * RX and TX lists. 1084 */ 1085 void 1086 kue_stop(struct kue_softc *sc) 1087 { 1088 usbd_status err; 1089 struct ifnet *ifp; 1090 int i; 1091 1092 DPRINTFN(5,("%s: %s: enter\n", sc->kue_dev.dv_xname,__func__)); 1093 1094 ifp = GET_IFP(sc); 1095 ifp->if_timer = 0; 1096 ifp->if_flags &= ~IFF_RUNNING; 1097 ifq_clr_oactive(&ifp->if_snd); 1098 1099 /* Stop transfers. */ 1100 if (sc->kue_ep[KUE_ENDPT_RX] != NULL) { 1101 err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_RX]); 1102 if (err) { 1103 printf("%s: close rx pipe failed: %s\n", 1104 sc->kue_dev.dv_xname, usbd_errstr(err)); 1105 } 1106 sc->kue_ep[KUE_ENDPT_RX] = NULL; 1107 } 1108 1109 if (sc->kue_ep[KUE_ENDPT_TX] != NULL) { 1110 err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_TX]); 1111 if (err) { 1112 printf("%s: close tx pipe failed: %s\n", 1113 sc->kue_dev.dv_xname, usbd_errstr(err)); 1114 } 1115 sc->kue_ep[KUE_ENDPT_TX] = NULL; 1116 } 1117 1118 if (sc->kue_ep[KUE_ENDPT_INTR] != NULL) { 1119 err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_INTR]); 1120 if (err) { 1121 printf("%s: close intr pipe failed: %s\n", 1122 sc->kue_dev.dv_xname, usbd_errstr(err)); 1123 } 1124 sc->kue_ep[KUE_ENDPT_INTR] = NULL; 1125 } 1126 1127 /* Free RX resources. */ 1128 for (i = 0; i < KUE_RX_LIST_CNT; i++) { 1129 if (sc->kue_cdata.kue_rx_chain[i].kue_mbuf != NULL) { 1130 m_freem(sc->kue_cdata.kue_rx_chain[i].kue_mbuf); 1131 sc->kue_cdata.kue_rx_chain[i].kue_mbuf = NULL; 1132 } 1133 if (sc->kue_cdata.kue_rx_chain[i].kue_xfer != NULL) { 1134 usbd_free_xfer(sc->kue_cdata.kue_rx_chain[i].kue_xfer); 1135 sc->kue_cdata.kue_rx_chain[i].kue_xfer = NULL; 1136 } 1137 } 1138 1139 /* Free TX resources. */ 1140 for (i = 0; i < KUE_TX_LIST_CNT; i++) { 1141 if (sc->kue_cdata.kue_tx_chain[i].kue_mbuf != NULL) { 1142 m_freem(sc->kue_cdata.kue_tx_chain[i].kue_mbuf); 1143 sc->kue_cdata.kue_tx_chain[i].kue_mbuf = NULL; 1144 } 1145 if (sc->kue_cdata.kue_tx_chain[i].kue_xfer != NULL) { 1146 usbd_free_xfer(sc->kue_cdata.kue_tx_chain[i].kue_xfer); 1147 sc->kue_cdata.kue_tx_chain[i].kue_xfer = NULL; 1148 } 1149 } 1150 } 1151