1 /* $OpenBSD: if_urndis.c,v 1.46 2013/12/09 15:45:29 pirofti Exp $ */ 2 3 /* 4 * Copyright (c) 2010 Jonathan Armani <armani@openbsd.org> 5 * Copyright (c) 2010 Fabien Romano <fabien@openbsd.org> 6 * Copyright (c) 2010 Michael Knudsen <mk@openbsd.org> 7 * Copyright (c) 2014 Hans Petter Selasky <hselasky@freebsd.org> 8 * All rights reserved. 9 * 10 * Permission to use, copy, modify, and distribute this software for any 11 * purpose with or without fee is hereby granted, provided that the above 12 * copyright notice and this permission notice appear in all copies. 13 * 14 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 15 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 16 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 17 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 18 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 19 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 20 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 21 * 22 * $FreeBSD: head/sys/dev/usb/net/if_urndis.c 261544 2014-02-06 10:47:47Z hselasky $ 23 */ 24 25 #include <sys/stdint.h> 26 #include <sys/param.h> 27 #include <sys/queue.h> 28 #include <sys/types.h> 29 #include <sys/systm.h> 30 #include <sys/socket.h> 31 #include <sys/kernel.h> 32 #include <sys/bus.h> 33 #include <sys/module.h> 34 #include <sys/lock.h> 35 #include <sys/condvar.h> 36 #include <sys/sysctl.h> 37 #include <sys/unistd.h> 38 #include <sys/callout.h> 39 #include <sys/malloc.h> 40 #include <sys/priv.h> 41 42 #include <net/if.h> 43 #include <net/if_var.h> 44 #include <net/ifq_var.h> 45 46 #include <bus/u4b/usb.h> 47 #include <bus/u4b/usbdi.h> 48 #include <bus/u4b/usbdi_util.h> 49 #include "usbdevs.h" 50 51 #define USB_DEBUG_VAR urndis_debug 52 #include <bus/u4b/usb_debug.h> 53 #include <bus/u4b/usb_process.h> 54 #include "usb_if.h" 55 56 #include <bus/u4b/net/usb_ethernet.h> 57 #include <bus/u4b/net/if_urndisreg.h> 58 59 #include <bus/u4b/usb_cdc.h> 60 61 static device_probe_t urndis_probe; 62 static device_attach_t urndis_attach; 63 static device_detach_t urndis_detach; 64 static device_suspend_t urndis_suspend; 65 static device_resume_t urndis_resume; 66 67 static usb_callback_t urndis_bulk_write_callback; 68 static usb_callback_t urndis_bulk_read_callback; 69 static usb_callback_t urndis_intr_read_callback; 70 71 static uether_fn_t urndis_attach_post; 72 static uether_fn_t urndis_init; 73 static uether_fn_t urndis_stop; 74 static uether_fn_t urndis_start; 75 static uether_fn_t urndis_setmulti; 76 static uether_fn_t urndis_setpromisc; 77 78 static uint32_t urndis_ctrl_query(struct urndis_softc *, uint32_t, const void **, uint16_t *); 79 static uint32_t urndis_ctrl_set(struct urndis_softc *, uint32_t, struct urndis_set_req *, uint16_t); 80 static uint32_t urndis_ctrl_handle_init(struct urndis_softc *, const struct urndis_comp_hdr *); 81 static uint32_t urndis_ctrl_handle_query(struct urndis_softc *, const struct urndis_comp_hdr *, const void **, uint16_t *); 82 static uint32_t urndis_ctrl_handle_reset(struct urndis_softc *, const struct urndis_comp_hdr *); 83 static uint32_t urndis_ctrl_init(struct urndis_softc *); 84 85 #ifdef USB_DEBUG 86 static int urndis_debug = 0; 87 static SYSCTL_NODE(_hw_usb, OID_AUTO, urndis, CTLFLAG_RW, 0, "USB RNDIS-Ethernet"); 88 SYSCTL_INT(_hw_usb_urndis, OID_AUTO, debug, CTLFLAG_RW, &urndis_debug, 0, 89 "Debug level"); 90 #endif 91 92 static const struct usb_config urndis_config[URNDIS_N_TRANSFER] = { 93 94 [URNDIS_BULK_RX] = { 95 .type = UE_BULK, 96 .endpoint = UE_ADDR_ANY, 97 .direction = UE_DIR_RX, 98 .if_index = 0, 99 .frames = 1, 100 .bufsize = RNDIS_RX_MAXLEN, 101 .flags = {.short_xfer_ok = 1,}, 102 .callback = urndis_bulk_read_callback, 103 .timeout = 0, /* no timeout */ 104 .usb_mode = USB_MODE_HOST, 105 }, 106 107 [URNDIS_BULK_TX] = { 108 .type = UE_BULK, 109 .endpoint = UE_ADDR_ANY, 110 .direction = UE_DIR_TX, 111 .if_index = 0, 112 .frames = RNDIS_TX_FRAMES_MAX, 113 .bufsize = (RNDIS_TX_FRAMES_MAX * RNDIS_TX_MAXLEN), 114 .flags = { 115 .force_short_xfer = 1, 116 }, 117 .callback = urndis_bulk_write_callback, 118 .timeout = 10000, /* 10 seconds */ 119 .usb_mode = USB_MODE_HOST, 120 }, 121 122 [URNDIS_INTR_RX] = { 123 .type = UE_INTERRUPT, 124 .endpoint = UE_ADDR_ANY, 125 .direction = UE_DIR_RX, 126 .if_index = 1, 127 .bufsize = 0, /* use wMaxPacketSize */ 128 .flags = {.short_xfer_ok = 1,.no_pipe_ok = 1,}, 129 .callback = urndis_intr_read_callback, 130 .timeout = 0, 131 .usb_mode = USB_MODE_HOST, 132 }, 133 }; 134 135 static device_method_t urndis_methods[] = { 136 /* Device interface */ 137 DEVMETHOD(device_probe, urndis_probe), 138 DEVMETHOD(device_attach, urndis_attach), 139 DEVMETHOD(device_detach, urndis_detach), 140 DEVMETHOD(device_suspend, urndis_suspend), 141 DEVMETHOD(device_resume, urndis_resume), 142 143 DEVMETHOD_END 144 }; 145 146 static driver_t urndis_driver = { 147 .name = "urndis", 148 .methods = urndis_methods, 149 .size = sizeof(struct urndis_softc), 150 }; 151 152 static devclass_t urndis_devclass; 153 154 DRIVER_MODULE(urndis, uhub, urndis_driver, urndis_devclass, NULL, NULL); 155 MODULE_VERSION(urndis, 1); 156 MODULE_DEPEND(urndis, uether, 1, 1, 1); 157 MODULE_DEPEND(urndis, usb, 1, 1, 1); 158 MODULE_DEPEND(urndis, ether, 1, 1, 1); 159 160 static const struct usb_ether_methods urndis_ue_methods = { 161 .ue_attach_post = urndis_attach_post, 162 .ue_start = urndis_start, 163 .ue_init = urndis_init, 164 .ue_stop = urndis_stop, 165 .ue_setmulti = urndis_setmulti, 166 .ue_setpromisc = urndis_setpromisc, 167 }; 168 169 static const STRUCT_USB_HOST_ID urndis_host_devs[] = { 170 {USB_IFACE_CLASS(UICLASS_WIRELESS), USB_IFACE_SUBCLASS(UISUBCLASS_RF), 171 USB_IFACE_PROTOCOL(UIPROTO_RNDIS)}, 172 {USB_IFACE_CLASS(UICLASS_IAD), USB_IFACE_SUBCLASS(UISUBCLASS_SYNC), 173 USB_IFACE_PROTOCOL(UIPROTO_ACTIVESYNC)}, 174 }; 175 176 static const STRUCT_USB_HOST_ID urndis_non_huawei_host_devs[] = { 177 {USB_IFACE_CLASS(UICLASS_CDC), 178 USB_IFACE_SUBCLASS(UISUBCLASS_ABSTRACT_CONTROL_MODEL), 179 USB_IFACE_PROTOCOL(0xff)}, 180 }; 181 182 static int 183 urndis_probe(device_t dev) 184 { 185 int res; 186 struct usb_attach_arg *uaa = device_get_ivars(dev); 187 188 res = usbd_lookup_id_by_uaa(urndis_host_devs, 189 sizeof(urndis_host_devs), uaa); 190 if (res == 0) 191 return(0); 192 if (uaa->info.idVendor == USB_VENDOR_HUAWEI) 193 return(ENXIO); 194 return (usbd_lookup_id_by_uaa(urndis_non_huawei_host_devs, 195 sizeof(urndis_non_huawei_host_devs), uaa)); 196 } 197 198 static void 199 urndis_attach_post(struct usb_ether *ue) 200 { 201 /* no-op */ 202 return; 203 } 204 205 static int 206 urndis_attach(device_t dev) 207 { 208 struct urndis_softc *sc = device_get_softc(dev); 209 struct usb_ether *ue = &sc->sc_ue; 210 struct usb_attach_arg *uaa = device_get_ivars(dev); 211 struct usb_cdc_cm_descriptor *cmd; 212 struct { 213 struct urndis_set_req hdr; 214 uint32_t filter; 215 } msg_filter; 216 const void *buf; 217 uint16_t bufsz; 218 uint8_t iface_index[2] = { uaa->info.bIfaceIndex + 1, uaa->info.bIfaceIndex }; 219 int error; 220 uint8_t i; 221 222 sc->sc_ue.ue_udev = uaa->device; 223 sc->sc_ifaceno_ctl = uaa->info.bIfaceNum; 224 225 cmd = usbd_find_descriptor(uaa->device, NULL, uaa->info.bIfaceIndex, 226 UDESC_CS_INTERFACE, 0xFF, UDESCSUB_CDC_CM, 0xFF); 227 if (cmd != NULL) { 228 DPRINTF("Call Mode Descriptor found, dataif=%d\n", cmd->bDataInterface); 229 iface_index[0] = cmd->bDataInterface; 230 } 231 232 device_set_usb_desc(dev); 233 234 lockinit(&sc->sc_lock, device_get_nameunit(dev), 0, LK_CANRECURSE); 235 236 /* scan the alternate settings looking for a valid one */ 237 238 for (i = 0; i != 32; i++) { 239 240 error = usbd_set_alt_interface_index(uaa->device, 241 iface_index[0], i); 242 243 if (error != 0) 244 break; 245 246 error = usbd_transfer_setup(uaa->device, 247 iface_index, sc->sc_xfer, urndis_config, 248 URNDIS_N_TRANSFER, sc, &sc->sc_lock); 249 250 if (error == 0) 251 break; 252 } 253 254 if ((error != 0) || (i == 32)) { 255 device_printf(dev, "No valid alternate " 256 "setting found\n"); 257 goto detach; 258 } 259 URNDIS_LOCK(sc); 260 error = urndis_ctrl_query(sc, OID_802_3_PERMANENT_ADDRESS, &buf, &bufsz); 261 URNDIS_UNLOCK(sc); 262 263 if (error != (int)RNDIS_STATUS_SUCCESS) { 264 device_printf(dev, "Unable to get hardware address\n"); 265 goto detach; 266 } 267 if (bufsz != ETHER_ADDR_LEN) { 268 device_printf(dev, "Invalid address length: %d bytes\n", bufsz); 269 goto detach; 270 } 271 memcpy(&sc->sc_ue.ue_eaddr, buf, ETHER_ADDR_LEN); 272 273 /* Initialize packet filter */ 274 sc->sc_filter = RNDIS_PACKET_TYPE_BROADCAST | 275 RNDIS_PACKET_TYPE_ALL_MULTICAST; 276 msg_filter.filter = htole32(sc->sc_filter); 277 278 URNDIS_LOCK(sc); 279 error = urndis_ctrl_set(sc, OID_GEN_CURRENT_PACKET_FILTER, 280 &msg_filter.hdr, sizeof(msg_filter)); 281 URNDIS_UNLOCK(sc); 282 283 if (error != (int)RNDIS_STATUS_SUCCESS) { 284 device_printf(dev, "Unable to set data filters\n"); 285 goto detach; 286 } 287 ue->ue_sc = sc; 288 ue->ue_dev = dev; 289 ue->ue_udev = uaa->device; 290 ue->ue_lock = &sc->sc_lock; 291 ue->ue_methods = &urndis_ue_methods; 292 293 error = uether_ifattach(ue); 294 if (error) { 295 device_printf(dev, "Could not attach interface\n"); 296 goto detach; 297 } 298 299 URNDIS_LOCK(sc); 300 /* start interrupt endpoint, if any */ 301 usbd_transfer_start(sc->sc_xfer[URNDIS_INTR_RX]); 302 URNDIS_UNLOCK(sc); 303 304 return (0); /* success */ 305 306 detach: 307 urndis_detach(dev); 308 return (ENXIO); /* failure */ 309 } 310 311 static int 312 urndis_detach(device_t dev) 313 { 314 struct urndis_softc *sc = device_get_softc(dev); 315 struct usb_ether *ue = &sc->sc_ue; 316 317 /* stop all USB transfers first */ 318 usbd_transfer_unsetup(sc->sc_xfer, URNDIS_N_TRANSFER); 319 320 uether_ifdetach(ue); 321 322 lockuninit(&sc->sc_lock); 323 324 return (0); 325 } 326 327 static void 328 urndis_start(struct usb_ether *ue) 329 { 330 struct urndis_softc *sc = uether_getsc(ue); 331 332 /* 333 * Start the USB transfers, if not already started: 334 */ 335 usbd_transfer_start(sc->sc_xfer[URNDIS_BULK_TX]); 336 usbd_transfer_start(sc->sc_xfer[URNDIS_BULK_RX]); 337 } 338 339 static void 340 urndis_init(struct usb_ether *ue) 341 { 342 struct urndis_softc *sc = uether_getsc(ue); 343 struct ifnet *ifp = uether_getifp(ue); 344 345 URNDIS_LOCK_ASSERT(sc); 346 347 ifp->if_flags |= IFF_RUNNING; 348 349 urndis_ctrl_init(sc); 350 351 /* stall data write direction, which depends on USB mode */ 352 usbd_xfer_set_stall(sc->sc_xfer[URNDIS_BULK_TX]); 353 354 /* start data transfers */ 355 urndis_start(ue); 356 } 357 358 static void 359 urndis_stop(struct usb_ether *ue) 360 { 361 struct urndis_softc *sc = uether_getsc(ue); 362 struct ifnet *ifp = uether_getifp(ue); 363 364 URNDIS_LOCK_ASSERT(sc); 365 366 ifp->if_flags &= ~IFF_RUNNING; 367 368 /* 369 * stop all the transfers, if not already stopped: 370 */ 371 usbd_transfer_stop(sc->sc_xfer[URNDIS_BULK_RX]); 372 usbd_transfer_stop(sc->sc_xfer[URNDIS_BULK_TX]); 373 } 374 375 static void 376 urndis_setmulti(struct usb_ether *ue) 377 { 378 /* no-op */ 379 return; 380 } 381 382 static void 383 urndis_setpromisc(struct usb_ether *ue) 384 { 385 /* no-op */ 386 return; 387 } 388 389 static int 390 urndis_suspend(device_t dev) 391 { 392 device_printf(dev, "Suspending\n"); 393 return (0); 394 } 395 396 static int 397 urndis_resume(device_t dev) 398 { 399 device_printf(dev, "Resuming\n"); 400 return (0); 401 } 402 403 static usb_error_t 404 urndis_ctrl_msg(struct urndis_softc *sc, uint8_t rt, uint8_t r, 405 uint16_t index, uint16_t value, void *buf, uint16_t buflen) 406 { 407 usb_device_request_t req; 408 409 req.bmRequestType = rt; 410 req.bRequest = r; 411 USETW(req.wValue, value); 412 USETW(req.wIndex, index); 413 USETW(req.wLength, buflen); 414 415 return (usbd_do_request_flags(sc->sc_ue.ue_udev, 416 &sc->sc_lock, &req, buf, (rt & UT_READ) ? 417 USB_SHORT_XFER_OK : 0, NULL, 2000 /* ms */ )); 418 } 419 420 static usb_error_t 421 urndis_ctrl_send(struct urndis_softc *sc, void *buf, uint16_t len) 422 { 423 usb_error_t err; 424 425 err = urndis_ctrl_msg(sc, UT_WRITE_CLASS_INTERFACE, UR_GET_STATUS, 426 sc->sc_ifaceno_ctl, 0, buf, len); 427 428 DPRINTF("%s\n", usbd_errstr(err)); 429 430 return (err); 431 } 432 433 static struct urndis_comp_hdr * 434 urndis_ctrl_recv(struct urndis_softc *sc) 435 { 436 struct urndis_comp_hdr *hdr; 437 usb_error_t err; 438 439 err = urndis_ctrl_msg(sc, UT_READ_CLASS_INTERFACE, UR_CLEAR_FEATURE, 440 sc->sc_ifaceno_ctl, 0, sc->sc_response_buf, RNDIS_RESPONSE_LEN); 441 442 if (err != USB_ERR_NORMAL_COMPLETION) 443 return (NULL); 444 445 hdr = (struct urndis_comp_hdr *)sc->sc_response_buf; 446 447 DPRINTF("type 0x%x len %u\n", le32toh(hdr->rm_type), 448 le32toh(hdr->rm_len)); 449 450 if (le32toh(hdr->rm_len) > RNDIS_RESPONSE_LEN) { 451 DPRINTF("ctrl message error: wrong size %u > %u\n", 452 le32toh(hdr->rm_len), RNDIS_RESPONSE_LEN); 453 return (NULL); 454 } 455 return (hdr); 456 } 457 458 static uint32_t 459 urndis_ctrl_handle(struct urndis_softc *sc, struct urndis_comp_hdr *hdr, 460 const void **buf, uint16_t *bufsz) 461 { 462 uint32_t rval; 463 464 DPRINTF("\n"); 465 466 if (buf != NULL && bufsz != NULL) { 467 *buf = NULL; 468 *bufsz = 0; 469 } 470 switch (le32toh(hdr->rm_type)) { 471 case REMOTE_NDIS_INITIALIZE_CMPLT: 472 rval = urndis_ctrl_handle_init(sc, hdr); 473 break; 474 475 case REMOTE_NDIS_QUERY_CMPLT: 476 rval = urndis_ctrl_handle_query(sc, hdr, buf, bufsz); 477 break; 478 479 case REMOTE_NDIS_RESET_CMPLT: 480 rval = urndis_ctrl_handle_reset(sc, hdr); 481 break; 482 483 case REMOTE_NDIS_KEEPALIVE_CMPLT: 484 case REMOTE_NDIS_SET_CMPLT: 485 rval = le32toh(hdr->rm_status); 486 break; 487 488 default: 489 DPRINTF("ctrl message error: unknown event 0x%x\n", 490 le32toh(hdr->rm_type)); 491 rval = RNDIS_STATUS_FAILURE; 492 break; 493 } 494 return (rval); 495 } 496 497 static uint32_t 498 urndis_ctrl_handle_init(struct urndis_softc *sc, 499 const struct urndis_comp_hdr *hdr) 500 { 501 const struct urndis_init_comp *msg; 502 503 msg = (const struct urndis_init_comp *)hdr; 504 505 DPRINTF("len %u rid %u status 0x%x " 506 "ver_major %u ver_minor %u devflags 0x%x medium 0x%x pktmaxcnt %u " 507 "pktmaxsz %u align %u aflistoffset %u aflistsz %u\n", 508 le32toh(msg->rm_len), 509 le32toh(msg->rm_rid), 510 le32toh(msg->rm_status), 511 le32toh(msg->rm_ver_major), 512 le32toh(msg->rm_ver_minor), 513 le32toh(msg->rm_devflags), 514 le32toh(msg->rm_medium), 515 le32toh(msg->rm_pktmaxcnt), 516 le32toh(msg->rm_pktmaxsz), 517 le32toh(msg->rm_align), 518 le32toh(msg->rm_aflistoffset), 519 le32toh(msg->rm_aflistsz)); 520 521 if (le32toh(msg->rm_status) != RNDIS_STATUS_SUCCESS) { 522 DPRINTF("init failed 0x%x\n", le32toh(msg->rm_status)); 523 return (le32toh(msg->rm_status)); 524 } 525 if (le32toh(msg->rm_devflags) != RNDIS_DF_CONNECTIONLESS) { 526 DPRINTF("wrong device type (current type: 0x%x)\n", 527 le32toh(msg->rm_devflags)); 528 return (RNDIS_STATUS_FAILURE); 529 } 530 if (le32toh(msg->rm_medium) != RNDIS_MEDIUM_802_3) { 531 DPRINTF("medium not 802.3 (current medium: 0x%x)\n", 532 le32toh(msg->rm_medium)); 533 return (RNDIS_STATUS_FAILURE); 534 } 535 sc->sc_lim_pktsz = le32toh(msg->rm_pktmaxsz); 536 537 return (le32toh(msg->rm_status)); 538 } 539 540 static uint32_t 541 urndis_ctrl_handle_query(struct urndis_softc *sc, 542 const struct urndis_comp_hdr *hdr, const void **buf, uint16_t *bufsz) 543 { 544 const struct urndis_query_comp *msg; 545 uint64_t limit; 546 547 msg = (const struct urndis_query_comp *)hdr; 548 549 DPRINTF("len %u rid %u status 0x%x " 550 "buflen %u bufoff %u\n", 551 le32toh(msg->rm_len), 552 le32toh(msg->rm_rid), 553 le32toh(msg->rm_status), 554 le32toh(msg->rm_infobuflen), 555 le32toh(msg->rm_infobufoffset)); 556 557 if (buf != NULL && bufsz != NULL) { 558 *buf = NULL; 559 *bufsz = 0; 560 } 561 if (le32toh(msg->rm_status) != RNDIS_STATUS_SUCCESS) { 562 DPRINTF("query failed 0x%x\n", le32toh(msg->rm_status)); 563 return (le32toh(msg->rm_status)); 564 } 565 limit = le32toh(msg->rm_infobuflen); 566 limit += le32toh(msg->rm_infobufoffset); 567 limit += RNDIS_HEADER_OFFSET; 568 569 if (limit > (uint64_t)le32toh(msg->rm_len)) { 570 DPRINTF("ctrl message error: invalid query info " 571 "len/offset/end_position(%u/%u/%u) -> " 572 "go out of buffer limit %u\n", 573 le32toh(msg->rm_infobuflen), 574 le32toh(msg->rm_infobufoffset), 575 le32toh(msg->rm_infobuflen) + 576 le32toh(msg->rm_infobufoffset) + RNDIS_HEADER_OFFSET, 577 le32toh(msg->rm_len)); 578 return (RNDIS_STATUS_FAILURE); 579 } 580 if (buf != NULL && bufsz != NULL) { 581 *buf = ((const uint8_t *)msg) + RNDIS_HEADER_OFFSET + le32toh(msg->rm_infobufoffset); 582 *bufsz = le32toh(msg->rm_infobuflen); 583 } 584 return (le32toh(msg->rm_status)); 585 } 586 587 static uint32_t 588 urndis_ctrl_handle_reset(struct urndis_softc *sc, 589 const struct urndis_comp_hdr *hdr) 590 { 591 const struct urndis_reset_comp *msg; 592 uint32_t rval; 593 594 msg = (const struct urndis_reset_comp *)hdr; 595 596 rval = le32toh(msg->rm_status); 597 598 DPRINTF("len %u status 0x%x " 599 "adrreset %u\n", 600 le32toh(msg->rm_len), 601 rval, 602 le32toh(msg->rm_adrreset)); 603 604 if (rval != RNDIS_STATUS_SUCCESS) { 605 DPRINTF("reset failed 0x%x\n", rval); 606 return (rval); 607 } 608 if (msg->rm_adrreset != 0) { 609 struct { 610 struct urndis_set_req hdr; 611 uint32_t filter; 612 } msg_filter; 613 614 msg_filter.filter = htole32(sc->sc_filter); 615 616 rval = urndis_ctrl_set(sc, OID_GEN_CURRENT_PACKET_FILTER, 617 &msg_filter.hdr, sizeof(msg_filter)); 618 619 if (rval != RNDIS_STATUS_SUCCESS) { 620 DPRINTF("unable to reset data filters\n"); 621 return (rval); 622 } 623 } 624 return (rval); 625 } 626 627 static uint32_t 628 urndis_ctrl_init(struct urndis_softc *sc) 629 { 630 struct urndis_init_req msg; 631 struct urndis_comp_hdr *hdr; 632 uint32_t rval; 633 634 msg.rm_type = htole32(REMOTE_NDIS_INITIALIZE_MSG); 635 msg.rm_len = htole32(sizeof(msg)); 636 msg.rm_rid = htole32(0); 637 msg.rm_ver_major = htole32(1); 638 msg.rm_ver_minor = htole32(1); 639 msg.rm_max_xfersz = htole32(RNDIS_RX_MAXLEN); 640 641 DPRINTF("type %u len %u rid %u ver_major %u " 642 "ver_minor %u max_xfersz %u\n", 643 le32toh(msg.rm_type), 644 le32toh(msg.rm_len), 645 le32toh(msg.rm_rid), 646 le32toh(msg.rm_ver_major), 647 le32toh(msg.rm_ver_minor), 648 le32toh(msg.rm_max_xfersz)); 649 650 rval = urndis_ctrl_send(sc, &msg, sizeof(msg)); 651 652 if (rval != RNDIS_STATUS_SUCCESS) { 653 DPRINTF("init failed\n"); 654 return (rval); 655 } 656 if ((hdr = urndis_ctrl_recv(sc)) == NULL) { 657 DPRINTF("unable to get init response\n"); 658 return (RNDIS_STATUS_FAILURE); 659 } 660 rval = urndis_ctrl_handle(sc, hdr, NULL, NULL); 661 662 return (rval); 663 } 664 665 #if 0 666 static uint32_t 667 urndis_ctrl_halt(struct urndis_softc *sc) 668 { 669 struct urndis_halt_req msg; 670 uint32_t rval; 671 672 msg.rm_type = htole32(REMOTE_NDIS_HALT_MSG); 673 msg.rm_len = htole32(sizeof(msg)); 674 msg.rm_rid = 0; 675 676 DPRINTF("type %u len %u rid %u\n", 677 le32toh(msg.rm_type), 678 le32toh(msg.rm_len), 679 le32toh(msg.rm_rid)); 680 681 rval = urndis_ctrl_send(sc, &msg, sizeof(msg)); 682 683 if (rval != RNDIS_STATUS_SUCCESS) 684 printf("halt failed\n"); 685 686 return (rval); 687 } 688 689 #endif 690 691 static uint32_t 692 urndis_ctrl_query(struct urndis_softc *sc, uint32_t oid, const void **rbuf, uint16_t *rbufsz) 693 { 694 struct urndis_query_req msg; 695 uint32_t rval; 696 struct urndis_comp_hdr *hdr; 697 698 msg.rm_type = htole32(REMOTE_NDIS_QUERY_MSG); 699 msg.rm_len = htole32(sizeof(msg)); 700 msg.rm_rid = 0; /* XXX */ 701 msg.rm_oid = htole32(oid); 702 msg.rm_infobuflen = htole32(0); 703 msg.rm_infobufoffset = 0; 704 msg.rm_devicevchdl = 0; 705 706 DPRINTF("type %u len %u rid %u oid 0x%x " 707 "infobuflen %u infobufoffset %u devicevchdl %u\n", 708 le32toh(msg.rm_type), 709 le32toh(msg.rm_len), 710 le32toh(msg.rm_rid), 711 le32toh(msg.rm_oid), 712 le32toh(msg.rm_infobuflen), 713 le32toh(msg.rm_infobufoffset), 714 le32toh(msg.rm_devicevchdl)); 715 716 rval = urndis_ctrl_send(sc, &msg, sizeof(msg)); 717 718 if (rval != RNDIS_STATUS_SUCCESS) { 719 DPRINTF("query failed\n"); 720 return (rval); 721 } 722 if ((hdr = urndis_ctrl_recv(sc)) == NULL) { 723 DPRINTF("unable to get query response\n"); 724 return (RNDIS_STATUS_FAILURE); 725 } 726 rval = urndis_ctrl_handle(sc, hdr, rbuf, rbufsz); 727 728 return (rval); 729 } 730 731 static uint32_t 732 urndis_ctrl_set(struct urndis_softc *sc, uint32_t oid, struct urndis_set_req *msg, uint16_t len) 733 { 734 struct urndis_comp_hdr *hdr; 735 uint32_t rval; 736 uint32_t datalen = len - sizeof(*msg); 737 738 msg->rm_type = htole32(REMOTE_NDIS_SET_MSG); 739 msg->rm_len = htole32(len); 740 msg->rm_rid = 0; /* XXX */ 741 msg->rm_oid = htole32(oid); 742 msg->rm_infobuflen = htole32(datalen); 743 if (datalen != 0) { 744 msg->rm_infobufoffset = htole32(sizeof(*msg) - RNDIS_HEADER_OFFSET); 745 } else { 746 msg->rm_infobufoffset = 0; 747 } 748 msg->rm_devicevchdl = 0; 749 750 DPRINTF("type %u len %u rid %u oid 0x%x " 751 "infobuflen %u infobufoffset %u devicevchdl %u\n", 752 le32toh(msg->rm_type), 753 le32toh(msg->rm_len), 754 le32toh(msg->rm_rid), 755 le32toh(msg->rm_oid), 756 le32toh(msg->rm_infobuflen), 757 le32toh(msg->rm_infobufoffset), 758 le32toh(msg->rm_devicevchdl)); 759 760 rval = urndis_ctrl_send(sc, msg, len); 761 762 if (rval != RNDIS_STATUS_SUCCESS) { 763 DPRINTF("set failed\n"); 764 return (rval); 765 } 766 if ((hdr = urndis_ctrl_recv(sc)) == NULL) { 767 DPRINTF("unable to get set response\n"); 768 return (RNDIS_STATUS_FAILURE); 769 } 770 rval = urndis_ctrl_handle(sc, hdr, NULL, NULL); 771 if (rval != RNDIS_STATUS_SUCCESS) 772 DPRINTF("set failed 0x%x\n", rval); 773 774 return (rval); 775 } 776 777 static void 778 urndis_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error) 779 { 780 struct urndis_softc *sc = usbd_xfer_softc(xfer); 781 struct usb_page_cache *pc = usbd_xfer_get_frame(xfer, 0); 782 struct ifnet *ifp = uether_getifp(&sc->sc_ue); 783 struct urndis_packet_msg msg; 784 struct mbuf *m; 785 int actlen; 786 int aframes; 787 int offset; 788 789 switch (USB_GET_STATE(xfer)) { 790 case USB_ST_TRANSFERRED: 791 792 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL); 793 794 DPRINTFN(1, "received %u bytes in %u frames\n", actlen, aframes); 795 796 for (offset = 0; actlen >= (uint32_t)sizeof(msg);) { 797 798 /* copy out header */ 799 usbd_copy_out(pc, offset, &msg, sizeof(msg)); 800 801 if (le32toh(0x1234567U) != 0x1234567U) { 802 /* swap endianness */ 803 msg.rm_type = le32toh(msg.rm_type); 804 msg.rm_len = le32toh(msg.rm_len); 805 msg.rm_dataoffset = le32toh(msg.rm_dataoffset); 806 msg.rm_datalen = le32toh(msg.rm_datalen); 807 msg.rm_oobdataoffset = le32toh(msg.rm_oobdataoffset); 808 msg.rm_oobdatalen = le32toh(msg.rm_oobdatalen); 809 msg.rm_oobdataelements = le32toh(msg.rm_oobdataelements); 810 msg.rm_pktinfooffset = le32toh(msg.rm_pktinfooffset); 811 msg.rm_pktinfolen = le32toh(msg.rm_pktinfolen); 812 msg.rm_vchandle = le32toh(msg.rm_vchandle); 813 msg.rm_reserved = le32toh(msg.rm_reserved); 814 } 815 816 DPRINTF("len %u data(off:%u len:%u) " 817 "oobdata(off:%u len:%u nb:%u) perpacket(off:%u len:%u)\n", 818 msg.rm_len, msg.rm_dataoffset, msg.rm_datalen, 819 msg.rm_oobdataoffset, msg.rm_oobdatalen, 820 msg.rm_oobdataelements, msg.rm_pktinfooffset, 821 msg.rm_pktinfooffset); 822 823 /* sanity check the RNDIS header */ 824 if (msg.rm_type != REMOTE_NDIS_PACKET_MSG) { 825 DPRINTF("invalid type 0x%x != 0x%x\n", 826 msg.rm_type, REMOTE_NDIS_PACKET_MSG); 827 goto tr_setup; 828 } else if (msg.rm_len < (uint32_t)sizeof(msg)) { 829 DPRINTF("invalid msg len %u < %u\n", 830 msg.rm_len, (unsigned)sizeof(msg)); 831 goto tr_setup; 832 } else if (msg.rm_len > (uint32_t)actlen) { 833 DPRINTF("invalid msg len %u > buffer " 834 "len %u\n", msg.rm_len, actlen); 835 goto tr_setup; 836 } else if (msg.rm_dataoffset >= (uint32_t)actlen) { 837 DPRINTF("invalid msg dataoffset %u > buffer " 838 "dataoffset %u\n", msg.rm_dataoffset, actlen); 839 goto tr_setup; 840 } else if (msg.rm_datalen > (uint32_t)actlen) { 841 DPRINTF("invalid msg datalen %u > buffer " 842 "datalen %u\n", msg.rm_datalen, actlen); 843 goto tr_setup; 844 } else if ((msg.rm_dataoffset + msg.rm_datalen + 845 (uint32_t)__offsetof(struct urndis_packet_msg, 846 rm_dataoffset)) > (uint32_t)actlen) { 847 DPRINTF("invalid dataoffset %u larger than %u\n", 848 msg.rm_dataoffset + msg.rm_datalen + 849 (uint32_t)__offsetof(struct urndis_packet_msg, 850 rm_dataoffset), actlen); 851 goto tr_setup; 852 } else if (msg.rm_datalen < (uint32_t)sizeof(struct ether_header)) { 853 ifp->if_ierrors++; 854 DPRINTF("invalid ethernet size " 855 "%u < %u\n", msg.rm_datalen, (unsigned)sizeof(struct ether_header)); 856 goto tr_setup; 857 } else if (msg.rm_datalen > (uint32_t)MCLBYTES) { 858 ifp->if_ierrors++; 859 DPRINTF("invalid ethernet size " 860 "%u > %u\n", 861 msg.rm_datalen, (unsigned)MCLBYTES); 862 goto tr_setup; 863 } else if (msg.rm_datalen > (uint32_t)(MHLEN - ETHER_ALIGN)) { 864 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR); 865 } else { 866 m = m_gethdr(M_NOWAIT, MT_DATA); 867 } 868 869 /* check if we have a buffer */ 870 if (m != NULL) { 871 m_adj(m, ETHER_ALIGN); 872 873 usbd_copy_out(pc, offset + msg.rm_dataoffset + 874 __offsetof(struct urndis_packet_msg, 875 rm_dataoffset), m->m_data, msg.rm_datalen); 876 877 /* enqueue */ 878 uether_rxmbuf(&sc->sc_ue, m, msg.rm_datalen); 879 } else { 880 ifp->if_ierrors++; 881 } 882 offset += msg.rm_len; 883 actlen -= msg.rm_len; 884 } 885 886 case USB_ST_SETUP: 887 tr_setup: 888 usbd_xfer_set_frame_len(xfer, 0, RNDIS_RX_MAXLEN); 889 usbd_xfer_set_frames(xfer, 1); 890 usbd_transfer_submit(xfer); 891 uether_rxflush(&sc->sc_ue); /* must be last */ 892 break; 893 894 default: /* Error */ 895 DPRINTFN(1, "error = %s\n", usbd_errstr(error)); 896 897 if (error != USB_ERR_CANCELLED) { 898 /* try to clear stall first */ 899 usbd_xfer_set_stall(xfer); 900 usbd_xfer_set_frames(xfer, 0); 901 usbd_transfer_submit(xfer); 902 } 903 break; 904 } 905 } 906 907 static void 908 urndis_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error) 909 { 910 struct urndis_packet_msg msg; 911 struct urndis_softc *sc = usbd_xfer_softc(xfer); 912 struct ifnet *ifp = uether_getifp(&sc->sc_ue); 913 struct mbuf *m; 914 unsigned x; 915 int actlen; 916 int aframes; 917 918 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL); 919 920 DPRINTFN(1, "\n"); 921 922 switch (USB_GET_STATE(xfer)) { 923 case USB_ST_TRANSFERRED: 924 DPRINTFN(11, "%u bytes in %u frames\n", actlen, aframes); 925 926 ifp->if_opackets++; 927 928 /* FALLTHROUGH */ 929 case USB_ST_SETUP: 930 tr_setup: 931 memset(&msg, 0, sizeof(msg)); 932 933 for (x = 0; x != RNDIS_TX_FRAMES_MAX; x++) { 934 struct usb_page_cache *pc = usbd_xfer_get_frame(xfer, x); 935 936 usbd_xfer_set_frame_offset(xfer, x * RNDIS_TX_MAXLEN, x); 937 938 next_pkt: 939 m = ifq_dequeue(&ifp->if_snd); 940 941 if (m == NULL) 942 break; 943 944 if ((m->m_pkthdr.len + sizeof(msg)) > RNDIS_TX_MAXLEN) { 945 DPRINTF("Too big packet\n"); 946 ifp->if_oerrors++; 947 948 /* Free buffer */ 949 m_freem(m); 950 goto next_pkt; 951 } 952 msg.rm_type = htole32(REMOTE_NDIS_PACKET_MSG); 953 msg.rm_len = htole32(sizeof(msg) + m->m_pkthdr.len); 954 955 msg.rm_dataoffset = htole32(RNDIS_DATA_OFFSET); 956 msg.rm_datalen = htole32(m->m_pkthdr.len); 957 958 /* copy in all data */ 959 usbd_copy_in(pc, 0, &msg, sizeof(msg)); 960 usbd_m_copy_in(pc, sizeof(msg), m, 0, m->m_pkthdr.len); 961 usbd_xfer_set_frame_len(xfer, x, sizeof(msg) + m->m_pkthdr.len); 962 963 /* 964 * If there's a BPF listener, bounce a copy of 965 * this frame to him: 966 */ 967 BPF_MTAP(ifp, m); 968 969 /* Free buffer */ 970 m_freem(m); 971 } 972 if (x != 0) { 973 usbd_xfer_set_frames(xfer, x); 974 usbd_transfer_submit(xfer); 975 } 976 break; 977 978 default: /* Error */ 979 DPRINTFN(11, "transfer error, %s\n", usbd_errstr(error)); 980 981 /* count output errors */ 982 ifp->if_oerrors++; 983 984 if (error != USB_ERR_CANCELLED) { 985 /* try to clear stall first */ 986 usbd_xfer_set_stall(xfer); 987 goto tr_setup; 988 } 989 break; 990 } 991 } 992 993 static void 994 urndis_intr_read_callback(struct usb_xfer *xfer, usb_error_t error) 995 { 996 int actlen; 997 998 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 999 1000 switch (USB_GET_STATE(xfer)) { 1001 case USB_ST_TRANSFERRED: 1002 1003 DPRINTF("Received %d bytes\n", actlen); 1004 1005 /* TODO: decode some indications */ 1006 1007 /* FALLTHROUGH */ 1008 case USB_ST_SETUP: 1009 tr_setup: 1010 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 1011 usbd_transfer_submit(xfer); 1012 break; 1013 1014 default: /* Error */ 1015 if (error != USB_ERR_CANCELLED) { 1016 /* start clear stall */ 1017 usbd_xfer_set_stall(xfer); 1018 goto tr_setup; 1019 } 1020 break; 1021 } 1022 } 1023