if_kue.c revision 1.95
1 /* $NetBSD: if_kue.c,v 1.95 2019/05/23 13:10:52 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.95 2019/05/23 13:10:52 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 ifnet *ifp = GET_IFP(sc); 319 struct ether_multi *enm; 320 struct ether_multistep step; 321 int i; 322 323 DPRINTFN(5,("%s: %s: enter\n", device_xname(sc->kue_dev), __func__)); 324 325 if (ifp->if_flags & IFF_PROMISC) { 326 allmulti: 327 ifp->if_flags |= IFF_ALLMULTI; 328 sc->kue_rxfilt |= KUE_RXFILT_ALLMULTI; 329 sc->kue_rxfilt &= ~KUE_RXFILT_MULTICAST; 330 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->kue_rxfilt); 331 return; 332 } 333 334 sc->kue_rxfilt &= ~KUE_RXFILT_ALLMULTI; 335 336 i = 0; 337 ETHER_FIRST_MULTI(step, &sc->kue_ec, enm); 338 while (enm != NULL) { 339 if (i == KUE_MCFILTCNT(sc) || 340 memcmp(enm->enm_addrlo, enm->enm_addrhi, 341 ETHER_ADDR_LEN) != 0) 342 goto allmulti; 343 344 memcpy(KUE_MCFILT(sc, i), enm->enm_addrlo, ETHER_ADDR_LEN); 345 ETHER_NEXT_MULTI(step, enm); 346 i++; 347 } 348 349 ifp->if_flags &= ~IFF_ALLMULTI; 350 351 sc->kue_rxfilt |= KUE_RXFILT_MULTICAST; 352 kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MCAST_FILTERS, 353 i, sc->kue_mcfilters, i * ETHER_ADDR_LEN); 354 355 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->kue_rxfilt); 356 } 357 358 /* 359 * Issue a SET_CONFIGURATION command to reset the MAC. This should be 360 * done after the firmware is loaded into the adapter in order to 361 * bring it into proper operation. 362 */ 363 static void 364 kue_reset(struct kue_softc *sc) 365 { 366 DPRINTFN(5,("%s: %s: enter\n", device_xname(sc->kue_dev), __func__)); 367 368 if (usbd_set_config_no(sc->kue_udev, KUE_CONFIG_NO, 1) || 369 usbd_device2interface_handle(sc->kue_udev, KUE_IFACE_IDX, 370 &sc->kue_iface)) 371 printf("%s: reset failed\n", device_xname(sc->kue_dev)); 372 373 /* Wait a little while for the chip to get its brains in order. */ 374 usbd_delay_ms(sc->kue_udev, 10); 375 } 376 377 /* 378 * Probe for a KLSI chip. 379 */ 380 int 381 kue_match(device_t parent, cfdata_t match, void *aux) 382 { 383 struct usb_attach_arg *uaa = aux; 384 385 DPRINTFN(25,("kue_match: enter\n")); 386 387 return kue_lookup(uaa->uaa_vendor, uaa->uaa_product) != NULL ? 388 UMATCH_VENDOR_PRODUCT : UMATCH_NONE; 389 } 390 391 /* 392 * Attach the interface. Allocate softc structures, do 393 * setup and ethernet/BPF attach. 394 */ 395 void 396 kue_attach(device_t parent, device_t self, void *aux) 397 { 398 struct kue_softc *sc = device_private(self); 399 struct usb_attach_arg *uaa = aux; 400 char *devinfop; 401 int s; 402 struct ifnet *ifp; 403 struct usbd_device * dev = uaa->uaa_device; 404 struct usbd_interface * iface; 405 usbd_status err; 406 usb_interface_descriptor_t *id; 407 usb_endpoint_descriptor_t *ed; 408 int i; 409 410 DPRINTFN(5,(" : kue_attach: sc=%p, dev=%p", sc, dev)); 411 412 sc->kue_dev = self; 413 414 aprint_naive("\n"); 415 aprint_normal("\n"); 416 417 devinfop = usbd_devinfo_alloc(dev, 0); 418 aprint_normal_dev(self, "%s\n", devinfop); 419 usbd_devinfo_free(devinfop); 420 421 err = usbd_set_config_no(dev, KUE_CONFIG_NO, 1); 422 if (err) { 423 aprint_error_dev(self, "failed to set configuration" 424 ", err=%s\n", usbd_errstr(err)); 425 return; 426 } 427 428 sc->kue_udev = dev; 429 sc->kue_product = uaa->uaa_product; 430 sc->kue_vendor = uaa->uaa_vendor; 431 432 /* Load the firmware into the NIC. */ 433 if (kue_load_fw(sc)) { 434 aprint_error_dev(self, "loading firmware failed\n"); 435 return; 436 } 437 438 err = usbd_device2interface_handle(dev, KUE_IFACE_IDX, &iface); 439 if (err) { 440 aprint_error_dev(self, "getting interface handle failed\n"); 441 return; 442 } 443 444 sc->kue_iface = iface; 445 id = usbd_get_interface_descriptor(iface); 446 447 /* Find endpoints. */ 448 for (i = 0; i < id->bNumEndpoints; i++) { 449 ed = usbd_interface2endpoint_descriptor(iface, i); 450 if (ed == NULL) { 451 aprint_error_dev(self, "couldn't get ep %d\n", i); 452 return; 453 } 454 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 455 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) { 456 sc->kue_ed[KUE_ENDPT_RX] = ed->bEndpointAddress; 457 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT && 458 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) { 459 sc->kue_ed[KUE_ENDPT_TX] = ed->bEndpointAddress; 460 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 461 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) { 462 sc->kue_ed[KUE_ENDPT_INTR] = ed->bEndpointAddress; 463 } 464 } 465 466 if (sc->kue_ed[KUE_ENDPT_RX] == 0 || sc->kue_ed[KUE_ENDPT_TX] == 0) { 467 aprint_error_dev(self, "missing endpoint\n"); 468 return; 469 } 470 471 /* Read ethernet descriptor */ 472 err = kue_ctl(sc, KUE_CTL_READ, KUE_CMD_GET_ETHER_DESCRIPTOR, 473 0, &sc->kue_desc, sizeof(sc->kue_desc)); 474 if (err) { 475 aprint_error_dev(self, "could not read Ethernet descriptor\n"); 476 return; 477 } 478 479 sc->kue_mcfilters = kmem_alloc(KUE_MCFILTCNT(sc) * ETHER_ADDR_LEN, 480 KM_SLEEP); 481 482 s = splnet(); 483 484 /* 485 * A KLSI chip was detected. Inform the world. 486 */ 487 aprint_normal_dev(self, "Ethernet address %s\n", 488 ether_sprintf(sc->kue_desc.kue_macaddr)); 489 490 /* Initialize interface info.*/ 491 ifp = GET_IFP(sc); 492 ifp->if_softc = sc; 493 ifp->if_mtu = ETHERMTU; 494 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST; 495 ifp->if_ioctl = kue_ioctl; 496 ifp->if_start = kue_start; 497 ifp->if_watchdog = kue_watchdog; 498 strlcpy(ifp->if_xname, device_xname(sc->kue_dev), IFNAMSIZ); 499 500 IFQ_SET_READY(&ifp->if_snd); 501 502 /* Attach the interface. */ 503 if_attach(ifp); 504 ether_ifattach(ifp, sc->kue_desc.kue_macaddr); 505 rnd_attach_source(&sc->rnd_source, device_xname(sc->kue_dev), 506 RND_TYPE_NET, RND_FLAG_DEFAULT); 507 508 sc->kue_attached = true; 509 splx(s); 510 511 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->kue_udev, sc->kue_dev); 512 513 return; 514 } 515 516 int 517 kue_detach(device_t self, int flags) 518 { 519 struct kue_softc *sc = device_private(self); 520 struct ifnet *ifp = GET_IFP(sc); 521 int s; 522 523 s = splusb(); /* XXX why? */ 524 525 if (sc->kue_mcfilters != NULL) { 526 kmem_free(sc->kue_mcfilters, 527 KUE_MCFILTCNT(sc) * ETHER_ADDR_LEN); 528 sc->kue_mcfilters = NULL; 529 } 530 531 if (!sc->kue_attached) { 532 /* Detached before attached finished, so just bail out. */ 533 splx(s); 534 return 0; 535 } 536 537 if (ifp->if_flags & IFF_RUNNING) 538 kue_stop(sc); 539 540 rnd_detach_source(&sc->rnd_source); 541 ether_ifdetach(ifp); 542 543 if_detach(ifp); 544 545 #ifdef DIAGNOSTIC 546 if (sc->kue_ep[KUE_ENDPT_TX] != NULL || 547 sc->kue_ep[KUE_ENDPT_RX] != NULL || 548 sc->kue_ep[KUE_ENDPT_INTR] != NULL) 549 aprint_debug_dev(self, "detach has active endpoints\n"); 550 #endif 551 552 sc->kue_attached = false; 553 splx(s); 554 555 return 0; 556 } 557 558 int 559 kue_activate(device_t self, enum devact act) 560 { 561 struct kue_softc *sc = device_private(self); 562 563 DPRINTFN(2,("%s: %s: enter\n", device_xname(sc->kue_dev), __func__)); 564 565 switch (act) { 566 case DVACT_DEACTIVATE: 567 /* Deactivate the interface. */ 568 if_deactivate(&sc->kue_ec.ec_if); 569 sc->kue_dying = true; 570 return 0; 571 default: 572 return EOPNOTSUPP; 573 } 574 } 575 576 static int 577 kue_rx_list_init(struct kue_softc *sc) 578 { 579 struct kue_cdata *cd; 580 struct kue_chain *c; 581 int i; 582 583 DPRINTFN(5,("%s: %s: enter\n", device_xname(sc->kue_dev), __func__)); 584 585 cd = &sc->kue_cdata; 586 for (i = 0; i < KUE_RX_LIST_CNT; i++) { 587 c = &cd->kue_rx_chain[i]; 588 c->kue_sc = sc; 589 c->kue_idx = i; 590 if (c->kue_xfer == NULL) { 591 int error = usbd_create_xfer(sc->kue_ep[KUE_ENDPT_RX], 592 KUE_BUFSZ, 0, 0, &c->kue_xfer); 593 if (error) 594 return error; 595 c->kue_buf = usbd_get_buffer(c->kue_xfer); 596 } 597 } 598 599 return 0; 600 } 601 602 static int 603 kue_tx_list_init(struct kue_softc *sc) 604 { 605 struct kue_cdata *cd; 606 struct kue_chain *c; 607 int i; 608 609 DPRINTFN(5,("%s: %s: enter\n", device_xname(sc->kue_dev), __func__)); 610 611 cd = &sc->kue_cdata; 612 for (i = 0; i < KUE_TX_LIST_CNT; i++) { 613 c = &cd->kue_tx_chain[i]; 614 c->kue_sc = sc; 615 c->kue_idx = i; 616 if (c->kue_xfer == NULL) { 617 int error = usbd_create_xfer(sc->kue_ep[KUE_ENDPT_TX], 618 KUE_BUFSZ, 0, 0, &c->kue_xfer); 619 if (error) 620 return error; 621 c->kue_buf = usbd_get_buffer(c->kue_xfer); 622 } 623 } 624 625 return 0; 626 } 627 628 /* 629 * A frame has been uploaded: pass the resulting mbuf chain up to 630 * the higher level protocols. 631 */ 632 static void 633 kue_rxeof(struct usbd_xfer *xfer, void *priv, usbd_status status) 634 { 635 struct kue_chain *c = priv; 636 struct kue_softc *sc = c->kue_sc; 637 struct ifnet *ifp = GET_IFP(sc); 638 struct mbuf *m; 639 int total_len, pktlen; 640 int s; 641 642 DPRINTFN(10,("%s: %s: enter status=%d\n", device_xname(sc->kue_dev), 643 __func__, status)); 644 645 if (sc->kue_dying) 646 return; 647 648 if (!(ifp->if_flags & IFF_RUNNING)) 649 return; 650 651 if (status != USBD_NORMAL_COMPLETION) { 652 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) 653 return; 654 sc->kue_rx_errs++; 655 if (usbd_ratecheck(&sc->kue_rx_notice)) { 656 printf("%s: %u usb errors on rx: %s\n", 657 device_xname(sc->kue_dev), sc->kue_rx_errs, 658 usbd_errstr(status)); 659 sc->kue_rx_errs = 0; 660 } 661 if (status == USBD_STALLED) 662 usbd_clear_endpoint_stall_async(sc->kue_ep[KUE_ENDPT_RX]); 663 goto done; 664 } 665 666 usbd_get_xfer_status(xfer, NULL, NULL, &total_len, NULL); 667 668 DPRINTFN(10,("%s: %s: total_len=%d len=%d\n", device_xname(sc->kue_dev), 669 __func__, total_len, 670 le16dec(c->kue_buf))); 671 672 if (total_len <= 1) 673 goto done; 674 675 pktlen = le16dec(c->kue_buf); 676 if (pktlen > total_len - 2) 677 pktlen = total_len - 2; 678 679 if (pktlen < ETHER_MIN_LEN - ETHER_CRC_LEN || 680 pktlen > MCLBYTES - ETHER_ALIGN) { 681 ifp->if_ierrors++; 682 goto done; 683 } 684 685 /* No errors; receive the packet. */ 686 MGETHDR(m, M_DONTWAIT, MT_DATA); 687 if (m == NULL) { 688 ifp->if_ierrors++; 689 goto done; 690 } 691 if (pktlen > MHLEN - ETHER_ALIGN) { 692 MCLGET(m, M_DONTWAIT); 693 if ((m->m_flags & M_EXT) == 0) { 694 m_freem(m); 695 ifp->if_ierrors++; 696 goto done; 697 } 698 } 699 m->m_data += ETHER_ALIGN; 700 701 /* copy data to mbuf */ 702 memcpy(mtod(m, uint8_t *), c->kue_buf + 2, pktlen); 703 704 m->m_pkthdr.len = m->m_len = pktlen; 705 m_set_rcvif(m, ifp); 706 707 s = splnet(); 708 709 DPRINTFN(10,("%s: %s: deliver %d\n", device_xname(sc->kue_dev), 710 __func__, m->m_len)); 711 if_percpuq_enqueue(ifp->if_percpuq, m); 712 713 splx(s); 714 715 done: 716 717 /* Setup new transfer. */ 718 usbd_setup_xfer(c->kue_xfer, c, c->kue_buf, KUE_BUFSZ, 719 USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT, kue_rxeof); 720 usbd_transfer(c->kue_xfer); 721 722 DPRINTFN(10,("%s: %s: start rx\n", device_xname(sc->kue_dev), 723 __func__)); 724 } 725 726 /* 727 * A frame was downloaded to the chip. It's safe for us to clean up 728 * the list buffers. 729 */ 730 731 static void 732 kue_txeof(struct usbd_xfer *xfer, void *priv, 733 usbd_status status) 734 { 735 struct kue_chain *c = priv; 736 struct kue_softc *sc = c->kue_sc; 737 struct ifnet *ifp = GET_IFP(sc); 738 int s; 739 740 if (sc->kue_dying) 741 return; 742 743 s = splnet(); 744 745 DPRINTFN(10,("%s: %s: enter status=%d\n", device_xname(sc->kue_dev), 746 __func__, status)); 747 748 ifp->if_timer = 0; 749 ifp->if_flags &= ~IFF_OACTIVE; 750 751 if (status != USBD_NORMAL_COMPLETION) { 752 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) { 753 splx(s); 754 return; 755 } 756 ifp->if_oerrors++; 757 printf("%s: usb error on tx: %s\n", device_xname(sc->kue_dev), 758 usbd_errstr(status)); 759 if (status == USBD_STALLED) 760 usbd_clear_endpoint_stall_async(sc->kue_ep[KUE_ENDPT_TX]); 761 splx(s); 762 return; 763 } 764 765 ifp->if_opackets++; 766 767 if (IFQ_IS_EMPTY(&ifp->if_snd) == 0) 768 kue_start(ifp); 769 770 splx(s); 771 } 772 773 static int 774 kue_send(struct kue_softc *sc, struct mbuf *m, int idx) 775 { 776 int total_len; 777 struct kue_chain *c; 778 usbd_status err; 779 780 DPRINTFN(10,("%s: %s: enter\n", device_xname(sc->kue_dev),__func__)); 781 782 c = &sc->kue_cdata.kue_tx_chain[idx]; 783 784 /* Frame length is specified in the first 2 bytes of the buffer. */ 785 le16enc(c->kue_buf, (uint16_t)m->m_pkthdr.len); 786 787 /* 788 * Copy the mbuf data into a contiguous buffer, leaving two 789 * bytes at the beginning to hold the frame length. 790 */ 791 m_copydata(m, 0, m->m_pkthdr.len, c->kue_buf + 2); 792 793 total_len = 2 + m->m_pkthdr.len; 794 total_len = roundup2(total_len, 64); 795 796 usbd_setup_xfer(c->kue_xfer, c, c->kue_buf, total_len, 0, 797 USBD_DEFAULT_TIMEOUT, kue_txeof); 798 799 /* Transmit */ 800 err = usbd_transfer(c->kue_xfer); 801 if (err != USBD_IN_PROGRESS) { 802 printf("%s: kue_send error=%s\n", device_xname(sc->kue_dev), 803 usbd_errstr(err)); 804 kue_stop(sc); 805 return EIO; 806 } 807 808 sc->kue_cdata.kue_tx_cnt++; 809 810 return 0; 811 } 812 813 static void 814 kue_start(struct ifnet *ifp) 815 { 816 struct kue_softc *sc = ifp->if_softc; 817 struct mbuf *m; 818 819 DPRINTFN(10,("%s: %s: enter\n", device_xname(sc->kue_dev),__func__)); 820 821 if (sc->kue_dying) 822 return; 823 824 if (ifp->if_flags & IFF_OACTIVE) 825 return; 826 827 IFQ_POLL(&ifp->if_snd, m); 828 if (m == NULL) 829 return; 830 831 if (kue_send(sc, m, 0)) { 832 ifp->if_flags |= IFF_OACTIVE; 833 return; 834 } 835 836 IFQ_DEQUEUE(&ifp->if_snd, m); 837 838 /* 839 * If there's a BPF listener, bounce a copy of this frame 840 * to him. 841 */ 842 bpf_mtap(ifp, m, BPF_D_OUT); 843 m_freem(m); 844 845 ifp->if_flags |= IFF_OACTIVE; 846 847 /* 848 * Set a timeout in case the chip goes out to lunch. 849 */ 850 ifp->if_timer = 6; 851 } 852 853 static void 854 kue_init(void *xsc) 855 { 856 struct kue_softc *sc = xsc; 857 struct ifnet *ifp = GET_IFP(sc); 858 int s; 859 uint8_t eaddr[ETHER_ADDR_LEN]; 860 861 DPRINTFN(5,("%s: %s: enter\n", device_xname(sc->kue_dev),__func__)); 862 863 if (ifp->if_flags & IFF_RUNNING) 864 return; 865 866 s = splnet(); 867 868 memcpy(eaddr, CLLADDR(ifp->if_sadl), sizeof(eaddr)); 869 /* Set MAC address */ 870 kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MAC, 0, eaddr, ETHER_ADDR_LEN); 871 872 sc->kue_rxfilt = KUE_RXFILT_UNICAST | KUE_RXFILT_BROADCAST; 873 874 /* If we want promiscuous mode, set the allframes bit. */ 875 if (ifp->if_flags & IFF_PROMISC) 876 sc->kue_rxfilt |= KUE_RXFILT_PROMISC; 877 878 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->kue_rxfilt); 879 880 /* I'm not sure how to tune these. */ 881 #if 0 882 /* 883 * Leave this one alone for now; setting it 884 * wrong causes lockups on some machines/controllers. 885 */ 886 kue_setword(sc, KUE_CMD_SET_SOFS, 1); 887 #endif 888 kue_setword(sc, KUE_CMD_SET_URB_SIZE, 64); 889 890 /* Load the multicast filter. */ 891 kue_setmulti(sc); 892 893 if (sc->kue_ep[KUE_ENDPT_RX] == NULL) { 894 if (kue_open_pipes(sc)) { 895 splx(s); 896 return; 897 } 898 } 899 /* Init TX ring. */ 900 if (kue_tx_list_init(sc)) { 901 printf("%s: tx list init failed\n", device_xname(sc->kue_dev)); 902 splx(s); 903 return; 904 } 905 906 /* Init RX ring. */ 907 if (kue_rx_list_init(sc)) { 908 printf("%s: rx list init failed\n", device_xname(sc->kue_dev)); 909 splx(s); 910 return; 911 } 912 913 /* Start up the receive pipe. */ 914 for (size_t i = 0; i < KUE_RX_LIST_CNT; i++) { 915 struct kue_chain *c = &sc->kue_cdata.kue_rx_chain[i]; 916 usbd_setup_xfer(c->kue_xfer, c, c->kue_buf, KUE_BUFSZ, 917 USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT, kue_rxeof); 918 DPRINTFN(5,("%s: %s: start read\n", device_xname(sc->kue_dev), 919 __func__)); 920 usbd_transfer(c->kue_xfer); 921 } 922 923 ifp->if_flags |= IFF_RUNNING; 924 ifp->if_flags &= ~IFF_OACTIVE; 925 926 splx(s); 927 } 928 929 static int 930 kue_open_pipes(struct kue_softc *sc) 931 { 932 usbd_status err; 933 934 DPRINTFN(5,("%s: %s: enter\n", device_xname(sc->kue_dev),__func__)); 935 936 /* Open RX and TX pipes. */ 937 err = usbd_open_pipe(sc->kue_iface, sc->kue_ed[KUE_ENDPT_RX], 938 USBD_EXCLUSIVE_USE, &sc->kue_ep[KUE_ENDPT_RX]); 939 if (err) { 940 printf("%s: open rx pipe failed: %s\n", 941 device_xname(sc->kue_dev), usbd_errstr(err)); 942 return EIO; 943 } 944 945 err = usbd_open_pipe(sc->kue_iface, sc->kue_ed[KUE_ENDPT_TX], 946 USBD_EXCLUSIVE_USE, &sc->kue_ep[KUE_ENDPT_TX]); 947 if (err) { 948 printf("%s: open tx pipe failed: %s\n", 949 device_xname(sc->kue_dev), usbd_errstr(err)); 950 return EIO; 951 } 952 953 return 0; 954 } 955 956 static int 957 kue_ioctl(struct ifnet *ifp, u_long command, void *data) 958 { 959 struct kue_softc *sc = ifp->if_softc; 960 struct ifaddr *ifa = (struct ifaddr *)data; 961 struct ifreq *ifr = (struct ifreq *)data; 962 int s, error = 0; 963 964 DPRINTFN(5,("%s: %s: enter\n", device_xname(sc->kue_dev),__func__)); 965 966 if (sc->kue_dying) 967 return EIO; 968 969 s = splnet(); 970 971 switch (command) { 972 case SIOCINITIFADDR: 973 ifp->if_flags |= IFF_UP; 974 kue_init(sc); 975 976 switch (ifa->ifa_addr->sa_family) { 977 #ifdef INET 978 case AF_INET: 979 arp_ifinit(ifp, ifa); 980 break; 981 #endif /* INET */ 982 } 983 break; 984 985 case SIOCSIFMTU: 986 if (ifr->ifr_mtu < ETHERMIN || ifr->ifr_mtu > ETHERMTU) 987 error = EINVAL; 988 else if ((error = ifioctl_common(ifp, command, data)) == ENETRESET) 989 error = 0; 990 break; 991 992 case SIOCSIFFLAGS: 993 if ((error = ifioctl_common(ifp, command, data)) != 0) 994 break; 995 if (ifp->if_flags & IFF_UP) { 996 if (ifp->if_flags & IFF_RUNNING && 997 ifp->if_flags & IFF_PROMISC && 998 !(sc->kue_if_flags & IFF_PROMISC)) { 999 sc->kue_rxfilt |= KUE_RXFILT_PROMISC; 1000 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, 1001 sc->kue_rxfilt); 1002 } else if (ifp->if_flags & IFF_RUNNING && 1003 !(ifp->if_flags & IFF_PROMISC) && 1004 sc->kue_if_flags & IFF_PROMISC) { 1005 sc->kue_rxfilt &= ~KUE_RXFILT_PROMISC; 1006 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, 1007 sc->kue_rxfilt); 1008 } else if (!(ifp->if_flags & IFF_RUNNING)) 1009 kue_init(sc); 1010 } else { 1011 if (ifp->if_flags & IFF_RUNNING) 1012 kue_stop(sc); 1013 } 1014 sc->kue_if_flags = ifp->if_flags; 1015 error = 0; 1016 break; 1017 case SIOCADDMULTI: 1018 case SIOCDELMULTI: 1019 error = ether_ioctl(ifp, command, data); 1020 if (error == ENETRESET) { 1021 if (ifp->if_flags & IFF_RUNNING) 1022 kue_setmulti(sc); 1023 error = 0; 1024 } 1025 break; 1026 default: 1027 error = ether_ioctl(ifp, command, data); 1028 break; 1029 } 1030 1031 splx(s); 1032 1033 return error; 1034 } 1035 1036 static void 1037 kue_watchdog(struct ifnet *ifp) 1038 { 1039 struct kue_softc *sc = ifp->if_softc; 1040 struct kue_chain *c; 1041 usbd_status stat; 1042 int s; 1043 1044 DPRINTFN(5,("%s: %s: enter\n", device_xname(sc->kue_dev),__func__)); 1045 1046 if (sc->kue_dying) 1047 return; 1048 1049 ifp->if_oerrors++; 1050 printf("%s: watchdog timeout\n", device_xname(sc->kue_dev)); 1051 1052 s = splusb(); 1053 c = &sc->kue_cdata.kue_tx_chain[0]; 1054 usbd_get_xfer_status(c->kue_xfer, NULL, NULL, NULL, &stat); 1055 kue_txeof(c->kue_xfer, c, stat); 1056 1057 if (IFQ_IS_EMPTY(&ifp->if_snd) == 0) 1058 kue_start(ifp); 1059 splx(s); 1060 } 1061 1062 /* 1063 * Stop the adapter and free any mbufs allocated to the 1064 * RX and TX lists. 1065 */ 1066 static void 1067 kue_stop(struct kue_softc *sc) 1068 { 1069 usbd_status err; 1070 struct ifnet *ifp; 1071 int i; 1072 1073 DPRINTFN(5,("%s: %s: enter\n", device_xname(sc->kue_dev),__func__)); 1074 1075 ifp = GET_IFP(sc); 1076 ifp->if_timer = 0; 1077 1078 /* Stop transfers. */ 1079 if (sc->kue_ep[KUE_ENDPT_RX] != NULL) { 1080 err = usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_RX]); 1081 if (err) { 1082 printf("%s: abort rx pipe failed: %s\n", 1083 device_xname(sc->kue_dev), usbd_errstr(err)); 1084 } 1085 } 1086 1087 if (sc->kue_ep[KUE_ENDPT_TX] != NULL) { 1088 err = usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_TX]); 1089 if (err) { 1090 printf("%s: abort tx pipe failed: %s\n", 1091 device_xname(sc->kue_dev), usbd_errstr(err)); 1092 } 1093 } 1094 1095 if (sc->kue_ep[KUE_ENDPT_INTR] != NULL) { 1096 err = usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_INTR]); 1097 if (err) { 1098 printf("%s: abort intr pipe failed: %s\n", 1099 device_xname(sc->kue_dev), usbd_errstr(err)); 1100 } 1101 } 1102 1103 /* Free RX resources. */ 1104 for (i = 0; i < KUE_RX_LIST_CNT; i++) { 1105 if (sc->kue_cdata.kue_rx_chain[i].kue_xfer != NULL) { 1106 usbd_destroy_xfer(sc->kue_cdata.kue_rx_chain[i].kue_xfer); 1107 sc->kue_cdata.kue_rx_chain[i].kue_xfer = NULL; 1108 } 1109 } 1110 1111 /* Free TX resources. */ 1112 for (i = 0; i < KUE_TX_LIST_CNT; i++) { 1113 if (sc->kue_cdata.kue_tx_chain[i].kue_xfer != NULL) { 1114 usbd_destroy_xfer(sc->kue_cdata.kue_tx_chain[i].kue_xfer); 1115 sc->kue_cdata.kue_tx_chain[i].kue_xfer = NULL; 1116 } 1117 } 1118 1119 /* Close pipes. */ 1120 if (sc->kue_ep[KUE_ENDPT_RX] != NULL) { 1121 err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_RX]); 1122 if (err) { 1123 printf("%s: close rx pipe failed: %s\n", 1124 device_xname(sc->kue_dev), usbd_errstr(err)); 1125 } 1126 sc->kue_ep[KUE_ENDPT_RX] = NULL; 1127 } 1128 1129 if (sc->kue_ep[KUE_ENDPT_TX] != NULL) { 1130 err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_TX]); 1131 if (err) { 1132 printf("%s: close tx pipe failed: %s\n", 1133 device_xname(sc->kue_dev), usbd_errstr(err)); 1134 } 1135 sc->kue_ep[KUE_ENDPT_TX] = NULL; 1136 } 1137 1138 if (sc->kue_ep[KUE_ENDPT_INTR] != NULL) { 1139 err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_INTR]); 1140 if (err) { 1141 printf("%s: close intr pipe failed: %s\n", 1142 device_xname(sc->kue_dev), usbd_errstr(err)); 1143 } 1144 sc->kue_ep[KUE_ENDPT_INTR] = NULL; 1145 } 1146 1147 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE); 1148 } 1149
Indexes created Mon Sep 29 18:09:42 GMT 2025