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 23#include <sys/cdefs.h> 24 25#include <lwip/netif.h> 26#include <lwip/dhcp.h> 27#include <lwip/netifapi.h> 28#include <lwip/inet.h> 29 30#include "if_urndisreg.h" 31 32static device_probe_t urndis_probe; 33static device_attach_t urndis_attach; 34static device_detach_t urndis_detach; 35static device_suspend_t urndis_suspend; 36static device_resume_t urndis_resume; 37 38static usb_callback_t urndis_bulk_write_callback; 39static usb_callback_t urndis_bulk_read_callback; 40static usb_callback_t urndis_intr_read_callback; 41 42static uether_fn_t urndis_attach_post; 43static uether_fn_t urndis_init; 44static uether_fn_t urndis_stop; 45static uether_fn_t urndis_start; 46static uether_fn_t urndis_setmulti; 47static uether_fn_t urndis_setpromisc; 48 49static uint32_t urndis_ctrl_query(struct urndis_softc *sc, uint32_t oid, 50 struct urndis_query_req *msg, uint16_t len, 51 const void **rbuf, uint16_t *rbufsz); 52static uint32_t urndis_ctrl_set(struct urndis_softc *sc, uint32_t oid, 53 struct urndis_set_req *msg, uint16_t len); 54static uint32_t urndis_ctrl_handle_init(struct urndis_softc *sc, 55 const struct urndis_comp_hdr *hdr); 56static uint32_t urndis_ctrl_handle_query(struct urndis_softc *sc, 57 const struct urndis_comp_hdr *hdr, const void **buf, 58 uint16_t *bufsz); 59static uint32_t urndis_ctrl_handle_reset(struct urndis_softc *sc, 60 const struct urndis_comp_hdr *hdr); 61static uint32_t urndis_ctrl_init(struct urndis_softc *sc); 62static uint32_t urndis_ctrl_halt(struct urndis_softc *sc); 63 64#undef USB_DEBUG_VAR 65#define USB_DEBUG_VAR urndis_debug 66#ifdef LOSCFG_USB_DEBUG 67static int urndis_debug = 0; 68void 69usb_urndis_debug_func(int level) 70{ 71 urndis_debug = level; 72 PRINTK("The level of usb urndis debug is %d\n", level); 73} 74DEBUG_MODULE(urndis, usb_urndis_debug_func); 75#endif 76 77static const struct usb_config urndis_config[URNDIS_N_TRANSFER] = { 78 { /* [URNDIS_BULK_RX] = */ 79 .type = UE_BULK, 80 .endpoint = UE_ADDR_ANY, 81 .direction = UE_DIR_RX, 82 .if_index = 0, 83 .frames = 1, 84 .bufsize = RNDIS_RX_MAXLEN, 85 .flags = {.short_xfer_ok = 1,}, 86 .callback = urndis_bulk_read_callback, 87 .timeout = 0, /* no timeout */ 88 .usb_mode = USB_MODE_HOST, 89 }, 90 91 { /* [URNDIS_BULK_TX] = */ 92 .type = UE_BULK, 93 .endpoint = UE_ADDR_ANY, 94 .direction = UE_DIR_TX, 95 .if_index = 0, 96 .frames = RNDIS_TX_FRAMES_MAX, 97 .bufsize = (RNDIS_TX_FRAMES_MAX * RNDIS_TX_MAXLEN), 98 .flags = { 99 .force_short_xfer = 1, 100 }, 101 .callback = urndis_bulk_write_callback, 102 .timeout = 10000, /* 10 seconds */ 103 .usb_mode = USB_MODE_HOST, 104 }, 105 106 { /* [URNDIS_INTR_RX] = */ 107 .type = UE_INTERRUPT, 108 .endpoint = UE_ADDR_ANY, 109 .direction = UE_DIR_RX, 110 .if_index = 1, 111 .bufsize = 0, /* use wMaxPacketSize */ 112 .flags = {.short_xfer_ok = 1,.no_pipe_ok = 1,}, 113 .callback = urndis_intr_read_callback, 114 .timeout = 0, 115 .usb_mode = USB_MODE_HOST, 116 }, 117}; 118 119static device_method_t urndis_methods[] = { 120 /* Device interface */ 121 DEVMETHOD(device_probe, urndis_probe), 122 DEVMETHOD(device_attach, urndis_attach), 123 DEVMETHOD(device_detach, urndis_detach), 124 DEVMETHOD(device_suspend, urndis_suspend), 125 DEVMETHOD(device_resume, urndis_resume), 126 127 DEVMETHOD_END 128}; 129 130static driver_t urndis_driver = { 131 .name = "urndis", 132 .methods = urndis_methods, 133 .size = sizeof(struct urndis_softc), 134}; 135 136static devclass_t urndis_devclass; 137 138DRIVER_MODULE(urndis, uhub, urndis_driver, urndis_devclass, NULL, NULL); 139 140static const struct usb_ether_methods urndis_ue_methods = { 141 .ue_attach_post = urndis_attach_post, 142 .ue_start = urndis_start, 143 .ue_init = urndis_init, 144 .ue_stop = urndis_stop, 145 .ue_setmulti = urndis_setmulti, 146 .ue_setpromisc = urndis_setpromisc, 147}; 148 149static const STRUCT_USB_HOST_ID urndis_host_devs[] = { 150 /* Generic RNDIS class match */ 151 {USB_IFACE_CLASS(UICLASS_CDC), 152 USB_IFACE_SUBCLASS(UISUBCLASS_ABSTRACT_CONTROL_MODEL), 153 USB_IFACE_PROTOCOL(0xff)}, 154 {USB_IFACE_CLASS(UICLASS_WIRELESS), USB_IFACE_SUBCLASS(UISUBCLASS_RF), 155 USB_IFACE_PROTOCOL(UIPROTO_RNDIS)}, 156 {USB_IFACE_CLASS(UICLASS_IAD), USB_IFACE_SUBCLASS(UISUBCLASS_SYNC), 157 USB_IFACE_PROTOCOL(UIPROTO_ACTIVESYNC)}, 158}; 159 160static int 161urndis_probe(device_t dev) 162{ 163 struct usb_attach_arg *uaa = device_get_ivars(dev); 164 165 return (usbd_lookup_id_by_uaa(urndis_host_devs, sizeof(urndis_host_devs), uaa)); 166} 167 168static void 169urndis_attach_post(struct usb_ether *ue) 170{ 171 /* no-op */ 172} 173 174static int 175urndis_attach(device_t dev) 176{ 177 static struct { 178 union { 179 struct urndis_query_req query; 180 struct urndis_set_req set; 181 } hdr; 182 union { 183 uint8_t eaddr[NETIF_MAX_HWADDR_LEN]; 184 uint32_t filter; 185 } ibuf; 186 } msg; 187 struct urndis_softc *sc = device_get_softc(dev); 188 struct usb_ether *ue = &sc->sc_ue; 189 struct usb_attach_arg *uaa = device_get_ivars(dev); 190 struct usb_cdc_cm_descriptor *cmd; 191 const void *buf; 192 struct netif *netif; 193 194 uint16_t bufsz; 195 uint8_t iface_index[2] = {0}; 196 int error; 197 uint8_t i; 198 199 sc->sc_ue.ue_udev = uaa->device; 200 sc->sc_ifaceno_ctl = uaa->info.bIfaceNum; 201 iface_index[0] = uaa->info.bIfaceIndex + 1; 202 iface_index[1] = uaa->info.bIfaceIndex; 203 204 cmd = usbd_find_descriptor(uaa->device, NULL, uaa->info.bIfaceIndex, 205 UDESC_CS_INTERFACE, 0xFF, UDESCSUB_CDC_CM, 0xFF); 206 if (cmd != 0) { 207 DPRINTF("Call Mode Descriptor found, dataif=%d\n", cmd->bDataInterface); 208 iface_index[0] = cmd->bDataInterface; 209 } 210 211 device_set_usb_desc(dev); 212 213 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_RECURSE); 214 215 /* scan the alternate settings looking for a valid one */ 216 for (i = 0; i != 32; i++) { 217 error = usbd_set_alt_interface_index(uaa->device, 218 iface_index[0], i); 219 220 if (error != 0) 221 break; 222 223 error = usbd_transfer_setup(uaa->device, 224 iface_index, sc->sc_xfer, urndis_config, 225 URNDIS_N_TRANSFER, sc, &sc->sc_mtx); 226 227 if (error == 0) 228 break; 229 } 230 if ((error != 0) || (i == 32)) { 231 device_printf(dev, "No valid alternate setting found\n"); 232 goto detach; 233 } 234 235 URNDIS_LOCK(sc); 236 /* start interrupt endpoint, if any */ 237 usbd_transfer_start(sc->sc_xfer[URNDIS_INTR_RX]); 238 URNDIS_UNLOCK(sc); 239 240 /* Initialize device - must be done before even querying it */ 241 URNDIS_LOCK(sc); 242 error = urndis_ctrl_init(sc); 243 URNDIS_UNLOCK(sc); 244 if (error != (int)RNDIS_STATUS_SUCCESS) { 245 device_printf(dev, "Unable to initialize hardware\n"); 246 goto detach; 247 } 248 249 /* Determine MAC address */ 250 (void)memset_s(msg.ibuf.eaddr, sizeof(msg.ibuf.eaddr), 0, sizeof(msg.ibuf.eaddr)); 251 URNDIS_LOCK(sc); 252 error = urndis_ctrl_query(sc, OID_802_3_PERMANENT_ADDRESS, 253 &msg.hdr.query, sizeof(msg.hdr.query) + sizeof(msg.ibuf.eaddr), 254 &buf, &bufsz); 255 URNDIS_UNLOCK(sc); 256 if (error != (int)RNDIS_STATUS_SUCCESS) { 257 device_printf(dev, "Unable to get hardware address\n"); 258 goto detach; 259 } 260 if (bufsz != NETIF_MAX_HWADDR_LEN) { 261 device_printf(dev, "Invalid address length: %d bytes\n", bufsz); 262 goto detach; 263 } 264 (void)memcpy_s(&sc->sc_ue.ue_eaddr, NETIF_MAX_HWADDR_LEN, buf, NETIF_MAX_HWADDR_LEN); 265 266 /* Initialize packet filter */ 267 sc->sc_filter = RNDIS_PACKET_TYPE_BROADCAST | 268 RNDIS_PACKET_TYPE_ALL_MULTICAST; 269 msg.ibuf.filter = htole32(sc->sc_filter); 270 URNDIS_LOCK(sc); 271 error = urndis_ctrl_set(sc, OID_GEN_CURRENT_PACKET_FILTER, 272 &msg.hdr.set, sizeof(msg.hdr.set) + sizeof(msg.ibuf.filter)); 273 URNDIS_UNLOCK(sc); 274 if (error != (int)RNDIS_STATUS_SUCCESS) { 275 device_printf(dev, "Unable to set data filters\n"); 276 goto detach; 277 } 278 279 ue->ue_sc = sc; 280 ue->ue_dev = dev; 281 ue->ue_udev = uaa->device; 282 ue->ue_mtx = &sc->sc_mtx; 283 ue->ue_methods = &urndis_ue_methods; 284 error = uether_ifattach(ue); 285 if (error) { 286 device_printf(dev, "Could not attach interface\n"); 287 goto detach; 288 } 289 290 error = (int)LOS_EventRead(&ue->ue_event, 0x01, LOS_WAITMODE_OR | LOS_WAITMODE_CLR, 1000); 291 if (error == (int)LOS_ERRNO_EVENT_READ_TIMEOUT) { 292 device_printf(dev, "read sc_event fail , %x\n", error); 293 goto detach; 294 } 295 296 netif = &(ue->ue_drv_sc->ac_if); 297 if (!netif_is_up(netif)) { 298 (void)netifapi_netif_set_up(netif); 299 } 300 301 return (0); /* success */ 302 303detach: 304 305 (void)urndis_detach(dev); 306 return (ENXIO); /* failure */ 307} 308 309static int 310urndis_detach(device_t dev) 311{ 312 struct urndis_softc *sc = device_get_softc(dev); 313 struct usb_ether *ue = &sc->sc_ue; 314 315 /* stop all USB transfers first */ 316 usbd_transfer_unsetup(sc->sc_xfer, URNDIS_N_TRANSFER); 317 318 uether_ifdetach(ue); 319 320 URNDIS_LOCK(sc); 321 (void)urndis_ctrl_halt(sc); 322 URNDIS_UNLOCK(sc); 323 324 mtx_destroy(&sc->sc_mtx); 325 326 return (0); 327} 328 329static void 330urndis_start(struct usb_ether *ue) 331{ 332 struct urndis_softc *sc = uether_getsc(ue); 333 334 /* 335 * Start the USB transfers, if not already started: 336 */ 337 usbd_transfer_start(sc->sc_xfer[URNDIS_BULK_TX]); 338 usbd_transfer_start(sc->sc_xfer[URNDIS_BULK_RX]); 339} 340 341static void 342urndis_init(struct usb_ether *ue) 343{ 344 struct urndis_softc *sc = uether_getsc(ue); 345 struct los_eth_driver *ifp = ue->ue_drv_sc; 346 struct eth_drv_sc *drv_sc = (struct eth_drv_sc *)ifp->driver_context; 347 348 URNDIS_LOCK_ASSERT(sc, MA_OWNED); 349 350 drv_sc->state |= IFF_DRV_RUNNING; 351 352 /* stall data write direction, which depends on USB mode */ 353 usbd_xfer_set_stall(sc->sc_xfer[URNDIS_BULK_TX]); 354 355 /* start data transfers */ 356 urndis_start(ue); 357} 358 359static void 360urndis_stop(struct usb_ether *ue) 361{ 362 struct urndis_softc *sc = uether_getsc(ue); 363 struct los_eth_driver *ifp = ue->ue_drv_sc; 364 struct eth_drv_sc *drv_sc = (struct eth_drv_sc *)ifp->driver_context; 365 366 URNDIS_LOCK_ASSERT(sc, MA_OWNED); 367 368 drv_sc->state &= ~IFF_DRV_RUNNING; 369 370 /* 371 * stop all the transfers, if not already stopped: 372 */ 373 usbd_transfer_stop(sc->sc_xfer[URNDIS_BULK_RX]); 374 usbd_transfer_stop(sc->sc_xfer[URNDIS_BULK_TX]); 375} 376 377static void 378urndis_setmulti(struct usb_ether *ue) 379{ 380 /* no-op */ 381} 382 383static void 384urndis_setpromisc(struct usb_ether *ue) 385{ 386 /* no-op */ 387} 388 389static int 390urndis_suspend(device_t dev) 391{ 392 device_printf(dev, "Suspending\n"); 393 return (0); 394} 395 396static int 397urndis_resume(device_t dev) 398{ 399 device_printf(dev, "Resuming\n"); 400 return (0); 401} 402 403static usb_error_t 404urndis_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_mtx, &req, buf, (rt & UT_READ) ? 417 USB_SHORT_XFER_OK : 0, NULL, 2000 /* ms */ )); 418} 419 420static usb_error_t 421urndis_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, 426 UCDC_SEND_ENCAPSULATED_COMMAND, sc->sc_ifaceno_ctl, 0, buf, len); 427 428 DPRINTF("%s\n", usbd_errstr(err)); 429 430 return (err); 431} 432 433static struct urndis_comp_hdr * 434urndis_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, 440 UCDC_GET_ENCAPSULATED_RESPONSE, sc->sc_ifaceno_ctl, 0, 441 sc->sc_response_buf, RNDIS_RESPONSE_LEN); 442 443 if (err != USB_ERR_NORMAL_COMPLETION) 444 return (NULL); 445 446 hdr = (struct urndis_comp_hdr *)sc->sc_response_buf; 447 448 DPRINTF("type 0x%x len %u\n", le32toh(hdr->rm_type), 449 le32toh(hdr->rm_len)); 450 451 if (le32toh(hdr->rm_len) > RNDIS_RESPONSE_LEN) { 452 DPRINTF("ctrl message error: wrong size %u > %u\n", 453 le32toh(hdr->rm_len), RNDIS_RESPONSE_LEN); 454 return (NULL); 455 } 456 return (hdr); 457} 458 459static uint32_t 460urndis_ctrl_handle(struct urndis_softc *sc, struct urndis_comp_hdr *hdr, 461 const void **buf, uint16_t *bufsz) 462{ 463 uint32_t rval; 464 465 DPRINTF("\n"); 466 467 if (buf != NULL && bufsz != NULL) { 468 *buf = NULL; 469 *bufsz = 0; 470 } 471 switch (le32toh(hdr->rm_type)) { 472 case REMOTE_NDIS_INITIALIZE_CMPLT: 473 rval = urndis_ctrl_handle_init(sc, hdr); 474 break; 475 476 case REMOTE_NDIS_QUERY_CMPLT: 477 rval = urndis_ctrl_handle_query(sc, hdr, buf, bufsz); 478 break; 479 480 case REMOTE_NDIS_RESET_CMPLT: 481 rval = urndis_ctrl_handle_reset(sc, hdr); 482 break; 483 484 case REMOTE_NDIS_KEEPALIVE_CMPLT: 485 /* FALLTHROUGH */ 486 case REMOTE_NDIS_SET_CMPLT: 487 rval = le32toh(hdr->rm_status); 488 break; 489 490 default: 491 device_printf(sc->sc_ue.ue_dev, 492 "ctrl message error: unknown event 0x%x\n", 493 le32toh(hdr->rm_type)); 494 rval = RNDIS_STATUS_FAILURE; 495 break; 496 } 497 return (rval); 498} 499 500static uint32_t 501urndis_ctrl_handle_init(struct urndis_softc *sc, 502 const struct urndis_comp_hdr *hdr) 503{ 504 const struct urndis_init_comp *msg; 505 506 msg = (const struct urndis_init_comp *)hdr; 507 508 DPRINTF("len %u rid %u status 0x%x " 509 "ver_major %u ver_minor %u devflags 0x%x medium 0x%x pktmaxcnt %u " 510 "pktmaxsz %u align %u aflistoffset %u aflistsz %u\n", 511 le32toh(msg->rm_len), 512 le32toh(msg->rm_rid), 513 le32toh(msg->rm_status), 514 le32toh(msg->rm_ver_major), 515 le32toh(msg->rm_ver_minor), 516 le32toh(msg->rm_devflags), 517 le32toh(msg->rm_medium), 518 le32toh(msg->rm_pktmaxcnt), 519 le32toh(msg->rm_pktmaxsz), 520 le32toh(msg->rm_align), 521 le32toh(msg->rm_aflistoffset), 522 le32toh(msg->rm_aflistsz)); 523 524 if (le32toh(msg->rm_status) != RNDIS_STATUS_SUCCESS) { 525 DPRINTF("init failed 0x%x\n", le32toh(msg->rm_status)); 526 return (le32toh(msg->rm_status)); 527 } 528 if (le32toh(msg->rm_devflags) != RNDIS_DF_CONNECTIONLESS) { 529 DPRINTF("wrong device type (current type: 0x%x)\n", 530 le32toh(msg->rm_devflags)); 531 return (RNDIS_STATUS_FAILURE); 532 } 533 if (le32toh(msg->rm_medium) != RNDIS_MEDIUM_802_3) { 534 DPRINTF("medium not 802.3 (current medium: 0x%x)\n", 535 le32toh(msg->rm_medium)); 536 return (RNDIS_STATUS_FAILURE); 537 } 538 sc->sc_lim_pktsz = le32toh(msg->rm_pktmaxsz); 539 540 return (le32toh(msg->rm_status)); 541} 542 543static uint32_t 544urndis_ctrl_handle_query(struct urndis_softc *sc, 545 const struct urndis_comp_hdr *hdr, const void **buf, uint16_t *bufsz) 546{ 547 const struct urndis_query_comp *msg; 548 uint64_t limit; 549 if (hdr == NULL || buf == NULL || bufsz == NULL) { 550 return RNDIS_STATUS_FAILURE; 551 } 552 553 msg = (const struct urndis_query_comp *)hdr; 554 555 DPRINTF("len %u rid %u status 0x%x " 556 "buflen %u bufoff %u\n", 557 le32toh(msg->rm_len), 558 le32toh(msg->rm_rid), 559 le32toh(msg->rm_status), 560 le32toh(msg->rm_infobuflen), 561 le32toh(msg->rm_infobufoffset)); 562 563 *buf = NULL; 564 *bufsz = 0; 565 if (le32toh(msg->rm_status) != RNDIS_STATUS_SUCCESS) { 566 DPRINTF("query failed 0x%x\n", le32toh(msg->rm_status)); 567 return (le32toh(msg->rm_status)); 568 } 569 limit = le32toh(msg->rm_infobuflen); 570 limit += le32toh(msg->rm_infobufoffset); 571 limit += RNDIS_HEADER_OFFSET; 572 573 if (limit > (uint64_t)le32toh(msg->rm_len)) { 574 DPRINTF("ctrl message error: invalid query info " 575 "len/offset/end_position(%u/%u/%u) -> " 576 "go out of buffer limit %u\n", 577 le32toh(msg->rm_infobuflen), 578 le32toh(msg->rm_infobufoffset), 579 le32toh(msg->rm_infobuflen) + 580 le32toh(msg->rm_infobufoffset) + RNDIS_HEADER_OFFSET, 581 le32toh(msg->rm_len)); 582 return (RNDIS_STATUS_FAILURE); 583 } 584 *buf = ((const uint8_t *)msg) + RNDIS_HEADER_OFFSET + 585 le32toh(msg->rm_infobufoffset); 586 *bufsz = le32toh(msg->rm_infobuflen); 587 588 return (le32toh(msg->rm_status)); 589} 590 591static uint32_t 592urndis_ctrl_handle_reset(struct urndis_softc *sc, 593 const struct urndis_comp_hdr *hdr) 594{ 595 const struct urndis_reset_comp *msg; 596 uint32_t rval; 597 598 msg = (const struct urndis_reset_comp *)hdr; 599 600 rval = le32toh(msg->rm_status); 601 602 DPRINTF("len %u status 0x%x " 603 "adrreset %u\n", 604 le32toh(msg->rm_len), 605 rval, 606 le32toh(msg->rm_adrreset)); 607 608 if (rval != RNDIS_STATUS_SUCCESS) { 609 DPRINTF("reset failed 0x%x\n", rval); 610 return (rval); 611 } 612 if (msg->rm_adrreset != 0) { 613 struct { 614 struct urndis_set_req hdr; 615 uint32_t filter; 616 } msg_filter; 617 618 msg_filter.filter = htole32(sc->sc_filter); 619 620 rval = urndis_ctrl_set(sc, OID_GEN_CURRENT_PACKET_FILTER, 621 &msg_filter.hdr, sizeof(msg_filter)); 622 623 if (rval != RNDIS_STATUS_SUCCESS) { 624 DPRINTF("unable to reset data filters\n"); 625 return (rval); 626 } 627 } 628 return (rval); 629} 630 631static uint32_t 632urndis_ctrl_init(struct urndis_softc *sc) 633{ 634 struct urndis_init_req msg; 635 struct urndis_comp_hdr *hdr; 636 uint32_t rval; 637 638 msg.rm_type = htole32(REMOTE_NDIS_INITIALIZE_MSG); 639 msg.rm_len = htole32(sizeof(msg)); 640 msg.rm_rid = 0; 641 msg.rm_ver_major = htole32(1); 642 msg.rm_ver_minor = htole32(1); 643 msg.rm_max_xfersz = htole32(RNDIS_RX_MAXLEN); 644 645 DPRINTF("type %u len %u rid %u ver_major %u " 646 "ver_minor %u max_xfersz %u\n", 647 le32toh(msg.rm_type), 648 le32toh(msg.rm_len), 649 le32toh(msg.rm_rid), 650 le32toh(msg.rm_ver_major), 651 le32toh(msg.rm_ver_minor), 652 le32toh(msg.rm_max_xfersz)); 653 654 rval = urndis_ctrl_send(sc, &msg, sizeof(msg)); 655 656 if (rval != RNDIS_STATUS_SUCCESS) { 657 DPRINTF("init failed\n"); 658 return (rval); 659 } 660 if ((hdr = urndis_ctrl_recv(sc)) == NULL) { 661 DPRINTF("unable to get init response\n"); 662 return (RNDIS_STATUS_FAILURE); 663 } 664 rval = urndis_ctrl_handle(sc, hdr, NULL, NULL); 665 666 return (rval); 667} 668 669static uint32_t 670urndis_ctrl_halt(struct urndis_softc *sc) 671{ 672 struct urndis_halt_req msg; 673 uint32_t rval; 674 675 msg.rm_type = htole32(REMOTE_NDIS_HALT_MSG); 676 msg.rm_len = htole32(sizeof(msg)); 677 msg.rm_rid = 0; 678 679 DPRINTF("type %u len %u rid %u\n", 680 le32toh(msg.rm_type), 681 le32toh(msg.rm_len), 682 le32toh(msg.rm_rid)); 683 684 rval = urndis_ctrl_send(sc, &msg, sizeof(msg)); 685 686 if (rval != RNDIS_STATUS_SUCCESS) 687 DPRINTF("halt failed\n"); 688 689 return (rval); 690} 691 692/* 693 * NB: Querying a device has the requirment of using an input buffer the size 694 * of the expected reply or larger, except for variably sized replies. 695 */ 696static uint32_t 697urndis_ctrl_query(struct urndis_softc *sc, uint32_t oid, 698 struct urndis_query_req *msg, uint16_t len, const void **rbuf, 699 uint16_t *rbufsz) 700{ 701 struct urndis_comp_hdr *hdr; 702 uint32_t datalen, rval; 703 704 msg->rm_type = htole32(REMOTE_NDIS_QUERY_MSG); 705 msg->rm_len = htole32(len); 706 msg->rm_rid = 0; /* XXX */ 707 msg->rm_oid = htole32(oid); 708 datalen = len - sizeof(*msg); 709 msg->rm_infobuflen = htole32(datalen); 710 if (datalen != 0) { 711 msg->rm_infobufoffset = htole32(sizeof(*msg) - 712 RNDIS_HEADER_OFFSET); 713 } else { 714 msg->rm_infobufoffset = 0; 715 } 716 msg->rm_devicevchdl = 0; 717 718 DPRINTF("type %u len %u rid %u oid 0x%x " 719 "infobuflen %u infobufoffset %u devicevchdl %u\n", 720 le32toh(msg->rm_type), 721 le32toh(msg->rm_len), 722 le32toh(msg->rm_rid), 723 le32toh(msg->rm_oid), 724 le32toh(msg->rm_infobuflen), 725 le32toh(msg->rm_infobufoffset), 726 le32toh(msg->rm_devicevchdl)); 727 728 rval = urndis_ctrl_send(sc, msg, len); 729 730 if (rval != RNDIS_STATUS_SUCCESS) { 731 DPRINTF("query failed\n"); 732 return (rval); 733 } 734 if ((hdr = urndis_ctrl_recv(sc)) == NULL) { 735 DPRINTF("unable to get query response\n"); 736 return (RNDIS_STATUS_FAILURE); 737 } 738 rval = urndis_ctrl_handle(sc, hdr, rbuf, rbufsz); 739 740 return (rval); 741} 742 743static uint32_t 744urndis_ctrl_set(struct urndis_softc *sc, uint32_t oid, 745 struct urndis_set_req *msg, uint16_t len) 746{ 747 struct urndis_comp_hdr *hdr; 748 uint32_t datalen, rval; 749 750 msg->rm_type = htole32(REMOTE_NDIS_SET_MSG); 751 msg->rm_len = htole32(len); 752 msg->rm_rid = 0; /* XXX */ 753 msg->rm_oid = htole32(oid); 754 datalen = len - sizeof(*msg); 755 msg->rm_infobuflen = htole32(datalen); 756 if (datalen != 0) { 757 msg->rm_infobufoffset = htole32(sizeof(*msg) - 758 RNDIS_HEADER_OFFSET); 759 } else { 760 msg->rm_infobufoffset = 0; 761 } 762 msg->rm_devicevchdl = 0; 763 764 DPRINTF("type %u len %u rid %u oid 0x%x " 765 "infobuflen %u infobufoffset %u devicevchdl %u\n", 766 le32toh(msg->rm_type), 767 le32toh(msg->rm_len), 768 le32toh(msg->rm_rid), 769 le32toh(msg->rm_oid), 770 le32toh(msg->rm_infobuflen), 771 le32toh(msg->rm_infobufoffset), 772 le32toh(msg->rm_devicevchdl)); 773 774 rval = urndis_ctrl_send(sc, msg, len); 775 776 if (rval != RNDIS_STATUS_SUCCESS) { 777 DPRINTF("set failed\n"); 778 return (rval); 779 } 780 if ((hdr = urndis_ctrl_recv(sc)) == NULL) { 781 DPRINTF("unable to get set response\n"); 782 return (RNDIS_STATUS_FAILURE); 783 } 784 rval = urndis_ctrl_handle(sc, hdr, NULL, NULL); 785 if (rval != RNDIS_STATUS_SUCCESS) 786 DPRINTF("set failed 0x%x\n", rval); 787 788 return (rval); 789} 790 791#define OFFSET_OF(type, field) \ 792 ((size_t)(uintptr_t)((const volatile void *)&((type *)0)->field)) 793 794static int urndis_bulk_read(struct usb_xfer *xfer, struct urndis_packet_msg *msg, int offset) 795{ 796 struct urndis_softc *sc = usbd_xfer_softc(xfer); 797 struct usb_page_cache *pc = usbd_xfer_get_frame(xfer, 0); 798 struct usb_ether *ue = &sc->sc_ue; 799 struct los_eth_driver *ifp = ue->ue_drv_sc; 800 struct pbuf *m; 801 802 m = pbuf_alloc(PBUF_RAW, msg->rm_datalen + ETH_PAD_SIZE, PBUF_RAM); 803 if (m == NULL){ 804 DPRINTF("pbuf_alloc failed\n"); 805 return (-1); 806 } 807 808 #if ETH_PAD_SIZE 809 /* drop the padding word */ 810 if (pbuf_header(m, -ETH_PAD_SIZE)) { 811 PRINTK("[URNDIS_ERROR]urndis_rxeof : pbuf_header drop failed\n"); 812 (void) pbuf_free(m); 813 return (-1); 814 } 815 #endif 816 817 usbd_copy_out(pc, offset + msg->rm_dataoffset + 818 OFFSET_OF(struct urndis_packet_msg, rm_dataoffset), m->payload, msg->rm_datalen); 819 820 #if ETH_PAD_SIZE 821 /* reclaim the padding word */ 822 if (pbuf_header(m, ETH_PAD_SIZE)) { 823 PRINTK("[URNDIS_ERROR]urndis_rxeof : pbuf_header drop failed\n"); 824 (void) pbuf_free(m); 825 return (-1); 826 } 827 #endif 828 829 /* enqueue */ 830 driverif_input(&ifp->ac_if, m); 831 832 return (0); 833} 834 835static void 836urndis_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error) 837{ 838 struct urndis_softc *sc = usbd_xfer_softc(xfer); 839 struct usb_page_cache *pc = usbd_xfer_get_frame(xfer, 0); 840 struct urndis_packet_msg msg; 841 int actlen; 842 int aframes; 843 int offset; 844 845 switch (USB_GET_STATE(xfer)) { 846 case USB_ST_TRANSFERRED: 847 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL); 848 849 DPRINTFN(1, "received %u bytes in %u frames\n", actlen, aframes); 850 851 for (offset = 0; actlen >= (int)sizeof(msg);) { 852 /* copy out header */ 853 usbd_copy_out(pc, offset, &msg, sizeof(msg)); 854 855 if (le32toh(0x1234567U) != 0x1234567U) { 856 /* swap endianness */ 857 msg.rm_type = le32toh(msg.rm_type); 858 msg.rm_len = le32toh(msg.rm_len); 859 msg.rm_dataoffset = le32toh(msg.rm_dataoffset); 860 msg.rm_datalen = le32toh(msg.rm_datalen); 861 msg.rm_oobdataoffset = le32toh(msg.rm_oobdataoffset); 862 msg.rm_oobdatalen = le32toh(msg.rm_oobdatalen); 863 msg.rm_oobdataelements = le32toh(msg.rm_oobdataelements); 864 msg.rm_pktinfooffset = le32toh(msg.rm_pktinfooffset); 865 msg.rm_pktinfolen = le32toh(msg.rm_pktinfolen); 866 msg.rm_vchandle = le32toh(msg.rm_vchandle); 867 msg.rm_reserved = le32toh(msg.rm_reserved); 868 } 869 870 DPRINTF("len %u data(off:%u len:%u) " 871 "oobdata(off:%u len:%u nb:%u) perpacket(off:%u len:%u)\n", 872 msg.rm_len, msg.rm_dataoffset, msg.rm_datalen, 873 msg.rm_oobdataoffset, msg.rm_oobdatalen, 874 msg.rm_oobdataelements, msg.rm_pktinfooffset, 875 msg.rm_pktinfooffset); 876 877 /* sanity check the RNDIS header */ 878 if (msg.rm_type != REMOTE_NDIS_PACKET_MSG) { 879 DPRINTF("invalid type 0x%x != 0x%x\n", 880 msg.rm_type, REMOTE_NDIS_PACKET_MSG); 881 goto tr_setup; 882 } else if (msg.rm_len < (uint32_t)sizeof(msg)) { 883 DPRINTF("invalid msg len %u < %u\n", 884 msg.rm_len, (unsigned)sizeof(msg)); 885 goto tr_setup; 886 } else if (msg.rm_len > (uint32_t)actlen) { 887 DPRINTF("invalid msg len %u > buffer " 888 "len %u\n", msg.rm_len, actlen); 889 goto tr_setup; 890 } else if (msg.rm_dataoffset >= (uint32_t)actlen) { 891 DPRINTF("invalid msg dataoffset %u > buffer " 892 "dataoffset %u\n", msg.rm_dataoffset, actlen); 893 goto tr_setup; 894 } else if (msg.rm_datalen > (uint32_t)actlen) { 895 DPRINTF("invalid msg datalen %u > buffer " 896 "datalen %u\n", msg.rm_datalen, actlen); 897 goto tr_setup; 898 } else if (msg.rm_datalen < (uint32_t)sizeof(struct ether_header)) { 899 DPRINTF("invalid ethernet size " 900 "%u < %u\n", msg.rm_datalen, (unsigned)sizeof(struct ether_header)); 901 goto tr_setup; 902 } else if (msg.rm_datalen > (uint32_t)(MCLBYTES - ETHER_ALIGN)) { 903 DPRINTF("invalid ethernet size " 904 "%u > %u\n", 905 msg.rm_datalen, (unsigned)MCLBYTES); 906 goto tr_setup; 907 } else { 908 if (0 != urndis_bulk_read(xfer, &msg, offset)) { 909 return; 910 } 911 } 912 913 offset += msg.rm_len; 914 actlen -= msg.rm_len; 915 } 916 /* FALLTHROUGH */ 917 918 case USB_ST_SETUP: 919tr_setup: 920 921 usbd_xfer_set_frame_len(xfer, 0, RNDIS_RX_MAXLEN); 922 usbd_xfer_set_frames(xfer, 1); 923 usbd_transfer_submit(xfer); 924 uether_rxflush(&sc->sc_ue); /* must be last */ 925 break; 926 927 default: /* Error */ 928 DPRINTFN(1, "error = %s\n", usbd_errstr(error)); 929 930 if (error != USB_ERR_CANCELLED) { 931 /* try to clear stall first */ 932 usbd_xfer_set_stall(xfer); 933 usbd_xfer_set_frames(xfer, 0); 934 usbd_transfer_submit(xfer); 935 } 936 break; 937 } 938} 939 940static void 941urndis_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error) 942{ 943 struct urndis_packet_msg msg; 944 struct urndis_softc *sc = usbd_xfer_softc(xfer); 945 struct usb_ether *ue = &sc->sc_ue; 946 struct pbuf *m; 947 unsigned x; 948 int actlen; 949 int aframes; 950 951 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL); 952 953 DPRINTFN(1, "\n"); 954 955 switch (USB_GET_STATE(xfer)) { 956 case USB_ST_TRANSFERRED: 957 DPRINTFN(11, "%u bytes in %u frames\n", actlen, aframes); 958 959 /* FALLTHROUGH */ 960 case USB_ST_SETUP: 961tr_setup: 962 (void)memset_s(&msg, sizeof(msg), 0, sizeof(msg)); 963 964 for (x = 0; x != RNDIS_TX_FRAMES_MAX; x++) { 965 struct usb_page_cache *pc = usbd_xfer_get_frame(xfer, x); 966 967 usbd_xfer_set_frame_offset(xfer, x * RNDIS_TX_MAXLEN, x); 968 969next_pkt: 970 UE_LOCK(ue); 971 IF_DEQUEUE(&(ue->ue_txq), m); 972 UE_UNLOCK(ue); 973 974 if (m == NULL) 975 break; 976 977 if ((m->len + sizeof(msg)) > RNDIS_TX_MAXLEN) { 978 DPRINTF("Too big packet\n"); 979 980 /* Free buffer */ 981 uether_freebuf(m); 982 goto next_pkt; 983 } 984 msg.rm_type = htole32(REMOTE_NDIS_PACKET_MSG); 985 msg.rm_len = htole32(sizeof(msg) + m->len); 986 987 msg.rm_dataoffset = htole32(RNDIS_DATA_OFFSET); 988 msg.rm_datalen = htole32(m->len); 989 990 /* copy in all data */ 991 usbd_copy_in(pc, 0, &msg, sizeof(msg)); 992 usbd_copy_in(pc, sizeof(msg), m->payload, m->len); 993 usbd_xfer_set_frame_len(xfer, x, sizeof(msg) + m->len); 994 995 /* Free buffer */ 996 uether_freebuf(m); 997 } 998 if (x != 0) { 999 usbd_xfer_set_frames(xfer, x); 1000 usbd_transfer_submit(xfer); 1001 } 1002 break; 1003 1004 default: /* Error */ 1005 DPRINTFN(11, "transfer error, %s\n", usbd_errstr(error)); 1006 1007 if (error != USB_ERR_CANCELLED) { 1008 /* try to clear stall first */ 1009 usbd_xfer_set_stall(xfer); 1010 goto tr_setup; 1011 } 1012 break; 1013 } 1014} 1015 1016static void 1017urndis_intr_read_callback(struct usb_xfer *xfer, usb_error_t error) 1018{ 1019 int actlen; 1020 1021 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 1022 1023 switch (USB_GET_STATE(xfer)) { 1024 case USB_ST_TRANSFERRED: 1025 1026 DPRINTF("Received %d bytes\n", actlen); 1027 1028 /* TODO: decode some indications */ 1029 1030 /* FALLTHROUGH */ 1031 case USB_ST_SETUP: 1032tr_setup: 1033 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 1034 usbd_transfer_submit(xfer); 1035 break; 1036 1037 default: /* Error */ 1038 if (error != USB_ERR_CANCELLED) { 1039 /* start clear stall */ 1040 usbd_xfer_set_stall(xfer); 1041 goto tr_setup; 1042 } 1043 break; 1044 } 1045} 1046 1047#undef USB_DEBUG_VAR 1048