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