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