1 /* $OpenBSD: if_urndis.c,v 1.46 2013/12/09 15:45:29 pirofti Exp $ */
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>
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.
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.
23 #include <sys/cdefs.h>
24 __FBSDID("$FreeBSD$");
26 #include <sys/stdint.h>
27 #include <sys/stddef.h>
28 #include <sys/param.h>
29 #include <sys/queue.h>
30 #include <sys/types.h>
31 #include <sys/systm.h>
32 #include <sys/socket.h>
33 #include <sys/kernel.h>
35 #include <sys/module.h>
37 #include <sys/mutex.h>
38 #include <sys/condvar.h>
39 #include <sys/sysctl.h>
41 #include <sys/unistd.h>
42 #include <sys/callout.h>
43 #include <sys/malloc.h>
47 #include <net/if_var.h>
49 #include <dev/usb/usb.h>
50 #include <dev/usb/usbdi.h>
51 #include <dev/usb/usbdi_util.h>
54 #define USB_DEBUG_VAR urndis_debug
55 #include <dev/usb/usb_debug.h>
56 #include <dev/usb/usb_process.h>
59 #include <dev/usb/net/usb_ethernet.h>
60 #include <dev/usb/net/if_urndisreg.h>
62 #include <dev/usb/usb_cdc.h>
64 static device_probe_t urndis_probe;
65 static device_attach_t urndis_attach;
66 static device_detach_t urndis_detach;
67 static device_suspend_t urndis_suspend;
68 static device_resume_t urndis_resume;
70 static usb_callback_t urndis_bulk_write_callback;
71 static usb_callback_t urndis_bulk_read_callback;
72 static usb_callback_t urndis_intr_read_callback;
74 static uether_fn_t urndis_attach_post;
75 static uether_fn_t urndis_init;
76 static uether_fn_t urndis_stop;
77 static uether_fn_t urndis_start;
78 static uether_fn_t urndis_setmulti;
79 static uether_fn_t urndis_setpromisc;
81 static uint32_t urndis_ctrl_query(struct urndis_softc *sc, uint32_t oid,
82 struct urndis_query_req *msg, uint16_t len,
83 const void **rbuf, uint16_t *rbufsz);
84 static uint32_t urndis_ctrl_set(struct urndis_softc *sc, uint32_t oid,
85 struct urndis_set_req *msg, uint16_t len);
86 static uint32_t urndis_ctrl_handle_init(struct urndis_softc *sc,
87 const struct urndis_comp_hdr *hdr);
88 static uint32_t urndis_ctrl_handle_query(struct urndis_softc *sc,
89 const struct urndis_comp_hdr *hdr, const void **buf,
91 static uint32_t urndis_ctrl_handle_reset(struct urndis_softc *sc,
92 const struct urndis_comp_hdr *hdr);
93 static uint32_t urndis_ctrl_init(struct urndis_softc *sc);
94 static uint32_t urndis_ctrl_halt(struct urndis_softc *sc);
97 static int urndis_debug = 0;
98 static SYSCTL_NODE(_hw_usb, OID_AUTO, urndis, CTLFLAG_RW, 0, "USB RNDIS-Ethernet");
99 SYSCTL_INT(_hw_usb_urndis, OID_AUTO, debug, CTLFLAG_RW, &urndis_debug, 0,
103 static const struct usb_config urndis_config[URNDIS_N_TRANSFER] = {
106 .endpoint = UE_ADDR_ANY,
107 .direction = UE_DIR_RX,
110 .bufsize = RNDIS_RX_MAXLEN,
111 .flags = {.short_xfer_ok = 1,},
112 .callback = urndis_bulk_read_callback,
113 .timeout = 0, /* no timeout */
114 .usb_mode = USB_MODE_HOST,
119 .endpoint = UE_ADDR_ANY,
120 .direction = UE_DIR_TX,
122 .frames = RNDIS_TX_FRAMES_MAX,
123 .bufsize = (RNDIS_TX_FRAMES_MAX * RNDIS_TX_MAXLEN),
125 .force_short_xfer = 1,
127 .callback = urndis_bulk_write_callback,
128 .timeout = 10000, /* 10 seconds */
129 .usb_mode = USB_MODE_HOST,
133 .type = UE_INTERRUPT,
134 .endpoint = UE_ADDR_ANY,
135 .direction = UE_DIR_RX,
137 .bufsize = 0, /* use wMaxPacketSize */
138 .flags = {.short_xfer_ok = 1,.no_pipe_ok = 1,},
139 .callback = urndis_intr_read_callback,
141 .usb_mode = USB_MODE_HOST,
145 static device_method_t urndis_methods[] = {
146 /* Device interface */
147 DEVMETHOD(device_probe, urndis_probe),
148 DEVMETHOD(device_attach, urndis_attach),
149 DEVMETHOD(device_detach, urndis_detach),
150 DEVMETHOD(device_suspend, urndis_suspend),
151 DEVMETHOD(device_resume, urndis_resume),
156 static driver_t urndis_driver = {
158 .methods = urndis_methods,
159 .size = sizeof(struct urndis_softc),
162 static devclass_t urndis_devclass;
164 DRIVER_MODULE(urndis, uhub, urndis_driver, urndis_devclass, NULL, NULL);
165 MODULE_VERSION(urndis, 1);
166 MODULE_DEPEND(urndis, uether, 1, 1, 1);
167 MODULE_DEPEND(urndis, usb, 1, 1, 1);
168 MODULE_DEPEND(urndis, ether, 1, 1, 1);
170 static const struct usb_ether_methods urndis_ue_methods = {
171 .ue_attach_post = urndis_attach_post,
172 .ue_start = urndis_start,
173 .ue_init = urndis_init,
174 .ue_stop = urndis_stop,
175 .ue_setmulti = urndis_setmulti,
176 .ue_setpromisc = urndis_setpromisc,
179 static const STRUCT_USB_HOST_ID urndis_host_devs[] = {
180 /* Generic RNDIS class match */
181 {USB_IFACE_CLASS(UICLASS_CDC),
182 USB_IFACE_SUBCLASS(UISUBCLASS_ABSTRACT_CONTROL_MODEL),
183 USB_IFACE_PROTOCOL(0xff)},
184 {USB_IFACE_CLASS(UICLASS_WIRELESS), USB_IFACE_SUBCLASS(UISUBCLASS_RF),
185 USB_IFACE_PROTOCOL(UIPROTO_RNDIS)},
186 {USB_IFACE_CLASS(UICLASS_IAD), USB_IFACE_SUBCLASS(UISUBCLASS_SYNC),
187 USB_IFACE_PROTOCOL(UIPROTO_ACTIVESYNC)},
189 {USB_VENDOR(USB_VENDOR_PALM), USB_IFACE_CLASS(UICLASS_CDC),
190 USB_IFACE_SUBCLASS(UISUBCLASS_ABSTRACT_CONTROL_MODEL),
191 USB_IFACE_PROTOCOL(0xff)},
195 urndis_probe(device_t dev)
197 struct usb_attach_arg *uaa = device_get_ivars(dev);
199 return (usbd_lookup_id_by_uaa(urndis_host_devs, sizeof(urndis_host_devs), uaa));
203 urndis_attach_post(struct usb_ether *ue)
210 urndis_attach(device_t dev)
214 struct urndis_query_req query;
215 struct urndis_set_req set;
218 uint8_t eaddr[ETHER_ADDR_LEN];
222 struct urndis_softc *sc = device_get_softc(dev);
223 struct usb_ether *ue = &sc->sc_ue;
224 struct usb_attach_arg *uaa = device_get_ivars(dev);
225 struct usb_cdc_cm_descriptor *cmd;
228 uint8_t iface_index[2] = { uaa->info.bIfaceIndex + 1, uaa->info.bIfaceIndex };
232 sc->sc_ue.ue_udev = uaa->device;
233 sc->sc_ifaceno_ctl = uaa->info.bIfaceNum;
235 cmd = usbd_find_descriptor(uaa->device, NULL, uaa->info.bIfaceIndex,
236 UDESC_CS_INTERFACE, 0xFF, UDESCSUB_CDC_CM, 0xFF);
238 DPRINTF("Call Mode Descriptor found, dataif=%d\n", cmd->bDataInterface);
239 iface_index[0] = cmd->bDataInterface;
242 device_set_usb_desc(dev);
244 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
246 /* scan the alternate settings looking for a valid one */
247 for (i = 0; i != 32; i++) {
248 error = usbd_set_alt_interface_index(uaa->device,
254 error = usbd_transfer_setup(uaa->device,
255 iface_index, sc->sc_xfer, urndis_config,
256 URNDIS_N_TRANSFER, sc, &sc->sc_mtx);
261 if ((error != 0) || (i == 32)) {
262 device_printf(dev, "No valid alternate setting found\n");
266 /* Initialize device - must be done before even querying it */
268 error = urndis_ctrl_init(sc);
270 if (error != (int)RNDIS_STATUS_SUCCESS) {
271 device_printf(dev, "Unable to initialize hardware\n");
275 /* Determine MAC address */
276 memset(msg.ibuf.eaddr, 0, sizeof(msg.ibuf.eaddr));
278 error = urndis_ctrl_query(sc, OID_802_3_PERMANENT_ADDRESS,
279 &msg.hdr.query, sizeof(msg.hdr.query) + sizeof(msg.ibuf.eaddr),
282 if (error != (int)RNDIS_STATUS_SUCCESS) {
283 device_printf(dev, "Unable to get hardware address\n");
286 if (bufsz != ETHER_ADDR_LEN) {
287 device_printf(dev, "Invalid address length: %d bytes\n", bufsz);
290 memcpy(&sc->sc_ue.ue_eaddr, buf, ETHER_ADDR_LEN);
292 /* Initialize packet filter */
293 sc->sc_filter = RNDIS_PACKET_TYPE_BROADCAST |
294 RNDIS_PACKET_TYPE_ALL_MULTICAST;
295 msg.ibuf.filter = htole32(sc->sc_filter);
297 error = urndis_ctrl_set(sc, OID_GEN_CURRENT_PACKET_FILTER,
298 &msg.hdr.set, sizeof(msg.hdr.set) + sizeof(msg.ibuf.filter));
300 if (error != (int)RNDIS_STATUS_SUCCESS) {
301 device_printf(dev, "Unable to set data filters\n");
307 ue->ue_udev = uaa->device;
308 ue->ue_mtx = &sc->sc_mtx;
309 ue->ue_methods = &urndis_ue_methods;
311 error = uether_ifattach(ue);
313 device_printf(dev, "Could not attach interface\n");
318 /* start interrupt endpoint, if any */
319 usbd_transfer_start(sc->sc_xfer[URNDIS_INTR_RX]);
322 return (0); /* success */
325 (void)urndis_detach(dev);
326 return (ENXIO); /* failure */
330 urndis_detach(device_t dev)
332 struct urndis_softc *sc = device_get_softc(dev);
333 struct usb_ether *ue = &sc->sc_ue;
335 /* stop all USB transfers first */
336 usbd_transfer_unsetup(sc->sc_xfer, URNDIS_N_TRANSFER);
341 (void)urndis_ctrl_halt(sc);
344 mtx_destroy(&sc->sc_mtx);
350 urndis_start(struct usb_ether *ue)
352 struct urndis_softc *sc = uether_getsc(ue);
355 * Start the USB transfers, if not already started:
357 usbd_transfer_start(sc->sc_xfer[URNDIS_BULK_TX]);
358 usbd_transfer_start(sc->sc_xfer[URNDIS_BULK_RX]);
362 urndis_init(struct usb_ether *ue)
364 struct urndis_softc *sc = uether_getsc(ue);
365 struct ifnet *ifp = uether_getifp(ue);
367 URNDIS_LOCK_ASSERT(sc, MA_OWNED);
369 ifp->if_drv_flags |= IFF_DRV_RUNNING;
371 /* stall data write direction, which depends on USB mode */
372 usbd_xfer_set_stall(sc->sc_xfer[URNDIS_BULK_TX]);
374 /* start data transfers */
379 urndis_stop(struct usb_ether *ue)
381 struct urndis_softc *sc = uether_getsc(ue);
382 struct ifnet *ifp = uether_getifp(ue);
384 URNDIS_LOCK_ASSERT(sc, MA_OWNED);
386 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
389 * stop all the transfers, if not already stopped:
391 usbd_transfer_stop(sc->sc_xfer[URNDIS_BULK_RX]);
392 usbd_transfer_stop(sc->sc_xfer[URNDIS_BULK_TX]);
396 urndis_setmulti(struct usb_ether *ue)
403 urndis_setpromisc(struct usb_ether *ue)
410 urndis_suspend(device_t dev)
413 device_printf(dev, "Suspending\n");
418 urndis_resume(device_t dev)
421 device_printf(dev, "Resuming\n");
426 urndis_ctrl_msg(struct urndis_softc *sc, uint8_t rt, uint8_t r,
427 uint16_t index, uint16_t value, void *buf, uint16_t buflen)
429 usb_device_request_t req;
431 req.bmRequestType = rt;
433 USETW(req.wValue, value);
434 USETW(req.wIndex, index);
435 USETW(req.wLength, buflen);
437 return (usbd_do_request_flags(sc->sc_ue.ue_udev,
438 &sc->sc_mtx, &req, buf, (rt & UT_READ) ?
439 USB_SHORT_XFER_OK : 0, NULL, 2000 /* ms */ ));
443 urndis_ctrl_send(struct urndis_softc *sc, void *buf, uint16_t len)
447 err = urndis_ctrl_msg(sc, UT_WRITE_CLASS_INTERFACE,
448 UCDC_SEND_ENCAPSULATED_COMMAND, sc->sc_ifaceno_ctl, 0, buf, len);
450 DPRINTF("%s\n", usbd_errstr(err));
455 static struct urndis_comp_hdr *
456 urndis_ctrl_recv(struct urndis_softc *sc)
458 struct urndis_comp_hdr *hdr;
461 err = urndis_ctrl_msg(sc, UT_READ_CLASS_INTERFACE,
462 UCDC_GET_ENCAPSULATED_RESPONSE, sc->sc_ifaceno_ctl, 0,
463 sc->sc_response_buf, RNDIS_RESPONSE_LEN);
465 if (err != USB_ERR_NORMAL_COMPLETION)
468 hdr = (struct urndis_comp_hdr *)sc->sc_response_buf;
470 DPRINTF("type 0x%x len %u\n", le32toh(hdr->rm_type),
471 le32toh(hdr->rm_len));
473 if (le32toh(hdr->rm_len) > RNDIS_RESPONSE_LEN) {
474 DPRINTF("ctrl message error: wrong size %u > %u\n",
475 le32toh(hdr->rm_len), RNDIS_RESPONSE_LEN);
482 urndis_ctrl_handle(struct urndis_softc *sc, struct urndis_comp_hdr *hdr,
483 const void **buf, uint16_t *bufsz)
489 if (buf != NULL && bufsz != NULL) {
493 switch (le32toh(hdr->rm_type)) {
494 case REMOTE_NDIS_INITIALIZE_CMPLT:
495 rval = urndis_ctrl_handle_init(sc, hdr);
498 case REMOTE_NDIS_QUERY_CMPLT:
499 rval = urndis_ctrl_handle_query(sc, hdr, buf, bufsz);
502 case REMOTE_NDIS_RESET_CMPLT:
503 rval = urndis_ctrl_handle_reset(sc, hdr);
506 case REMOTE_NDIS_KEEPALIVE_CMPLT:
507 case REMOTE_NDIS_SET_CMPLT:
508 rval = le32toh(hdr->rm_status);
512 device_printf(sc->sc_ue.ue_dev,
513 "ctrl message error: unknown event 0x%x\n",
514 le32toh(hdr->rm_type));
515 rval = RNDIS_STATUS_FAILURE;
522 urndis_ctrl_handle_init(struct urndis_softc *sc,
523 const struct urndis_comp_hdr *hdr)
525 const struct urndis_init_comp *msg;
527 msg = (const struct urndis_init_comp *)hdr;
529 DPRINTF("len %u rid %u status 0x%x "
530 "ver_major %u ver_minor %u devflags 0x%x medium 0x%x pktmaxcnt %u "
531 "pktmaxsz %u align %u aflistoffset %u aflistsz %u\n",
532 le32toh(msg->rm_len),
533 le32toh(msg->rm_rid),
534 le32toh(msg->rm_status),
535 le32toh(msg->rm_ver_major),
536 le32toh(msg->rm_ver_minor),
537 le32toh(msg->rm_devflags),
538 le32toh(msg->rm_medium),
539 le32toh(msg->rm_pktmaxcnt),
540 le32toh(msg->rm_pktmaxsz),
541 le32toh(msg->rm_align),
542 le32toh(msg->rm_aflistoffset),
543 le32toh(msg->rm_aflistsz));
545 if (le32toh(msg->rm_status) != RNDIS_STATUS_SUCCESS) {
546 DPRINTF("init failed 0x%x\n", le32toh(msg->rm_status));
547 return (le32toh(msg->rm_status));
549 if (le32toh(msg->rm_devflags) != RNDIS_DF_CONNECTIONLESS) {
550 DPRINTF("wrong device type (current type: 0x%x)\n",
551 le32toh(msg->rm_devflags));
552 return (RNDIS_STATUS_FAILURE);
554 if (le32toh(msg->rm_medium) != RNDIS_MEDIUM_802_3) {
555 DPRINTF("medium not 802.3 (current medium: 0x%x)\n",
556 le32toh(msg->rm_medium));
557 return (RNDIS_STATUS_FAILURE);
559 sc->sc_lim_pktsz = le32toh(msg->rm_pktmaxsz);
561 return (le32toh(msg->rm_status));
565 urndis_ctrl_handle_query(struct urndis_softc *sc,
566 const struct urndis_comp_hdr *hdr, const void **buf, uint16_t *bufsz)
568 const struct urndis_query_comp *msg;
571 msg = (const struct urndis_query_comp *)hdr;
573 DPRINTF("len %u rid %u status 0x%x "
574 "buflen %u bufoff %u\n",
575 le32toh(msg->rm_len),
576 le32toh(msg->rm_rid),
577 le32toh(msg->rm_status),
578 le32toh(msg->rm_infobuflen),
579 le32toh(msg->rm_infobufoffset));
583 if (le32toh(msg->rm_status) != RNDIS_STATUS_SUCCESS) {
584 DPRINTF("query failed 0x%x\n", le32toh(msg->rm_status));
585 return (le32toh(msg->rm_status));
587 limit = le32toh(msg->rm_infobuflen);
588 limit += le32toh(msg->rm_infobufoffset);
589 limit += RNDIS_HEADER_OFFSET;
591 if (limit > (uint64_t)le32toh(msg->rm_len)) {
592 DPRINTF("ctrl message error: invalid query info "
593 "len/offset/end_position(%u/%u/%u) -> "
594 "go out of buffer limit %u\n",
595 le32toh(msg->rm_infobuflen),
596 le32toh(msg->rm_infobufoffset),
597 le32toh(msg->rm_infobuflen) +
598 le32toh(msg->rm_infobufoffset) + RNDIS_HEADER_OFFSET,
599 le32toh(msg->rm_len));
600 return (RNDIS_STATUS_FAILURE);
602 *buf = ((const uint8_t *)msg) + RNDIS_HEADER_OFFSET +
603 le32toh(msg->rm_infobufoffset);
604 *bufsz = le32toh(msg->rm_infobuflen);
606 return (le32toh(msg->rm_status));
610 urndis_ctrl_handle_reset(struct urndis_softc *sc,
611 const struct urndis_comp_hdr *hdr)
613 const struct urndis_reset_comp *msg;
616 msg = (const struct urndis_reset_comp *)hdr;
618 rval = le32toh(msg->rm_status);
620 DPRINTF("len %u status 0x%x "
622 le32toh(msg->rm_len),
624 le32toh(msg->rm_adrreset));
626 if (rval != RNDIS_STATUS_SUCCESS) {
627 DPRINTF("reset failed 0x%x\n", rval);
630 if (msg->rm_adrreset != 0) {
632 struct urndis_set_req hdr;
636 msg_filter.filter = htole32(sc->sc_filter);
638 rval = urndis_ctrl_set(sc, OID_GEN_CURRENT_PACKET_FILTER,
639 &msg_filter.hdr, sizeof(msg_filter));
641 if (rval != RNDIS_STATUS_SUCCESS) {
642 DPRINTF("unable to reset data filters\n");
650 urndis_ctrl_init(struct urndis_softc *sc)
652 struct urndis_init_req msg;
653 struct urndis_comp_hdr *hdr;
656 msg.rm_type = htole32(REMOTE_NDIS_INITIALIZE_MSG);
657 msg.rm_len = htole32(sizeof(msg));
659 msg.rm_ver_major = htole32(1);
660 msg.rm_ver_minor = htole32(1);
661 msg.rm_max_xfersz = htole32(RNDIS_RX_MAXLEN);
663 DPRINTF("type %u len %u rid %u ver_major %u "
664 "ver_minor %u max_xfersz %u\n",
665 le32toh(msg.rm_type),
668 le32toh(msg.rm_ver_major),
669 le32toh(msg.rm_ver_minor),
670 le32toh(msg.rm_max_xfersz));
672 rval = urndis_ctrl_send(sc, &msg, sizeof(msg));
674 if (rval != RNDIS_STATUS_SUCCESS) {
675 DPRINTF("init failed\n");
678 if ((hdr = urndis_ctrl_recv(sc)) == NULL) {
679 DPRINTF("unable to get init response\n");
680 return (RNDIS_STATUS_FAILURE);
682 rval = urndis_ctrl_handle(sc, hdr, NULL, NULL);
688 urndis_ctrl_halt(struct urndis_softc *sc)
690 struct urndis_halt_req msg;
693 msg.rm_type = htole32(REMOTE_NDIS_HALT_MSG);
694 msg.rm_len = htole32(sizeof(msg));
697 DPRINTF("type %u len %u rid %u\n",
698 le32toh(msg.rm_type),
700 le32toh(msg.rm_rid));
702 rval = urndis_ctrl_send(sc, &msg, sizeof(msg));
704 if (rval != RNDIS_STATUS_SUCCESS)
705 DPRINTF("halt failed\n");
711 * NB: Querying a device has the requirment of using an input buffer the size
712 * of the expected reply or larger, except for variably sized replies.
715 urndis_ctrl_query(struct urndis_softc *sc, uint32_t oid,
716 struct urndis_query_req *msg, uint16_t len, const void **rbuf,
719 struct urndis_comp_hdr *hdr;
720 uint32_t datalen, rval;
722 msg->rm_type = htole32(REMOTE_NDIS_QUERY_MSG);
723 msg->rm_len = htole32(len);
724 msg->rm_rid = 0; /* XXX */
725 msg->rm_oid = htole32(oid);
726 datalen = len - sizeof(*msg);
727 msg->rm_infobuflen = htole32(datalen);
729 msg->rm_infobufoffset = htole32(sizeof(*msg) -
730 RNDIS_HEADER_OFFSET);
732 msg->rm_infobufoffset = 0;
734 msg->rm_devicevchdl = 0;
736 DPRINTF("type %u len %u rid %u oid 0x%x "
737 "infobuflen %u infobufoffset %u devicevchdl %u\n",
738 le32toh(msg->rm_type),
739 le32toh(msg->rm_len),
740 le32toh(msg->rm_rid),
741 le32toh(msg->rm_oid),
742 le32toh(msg->rm_infobuflen),
743 le32toh(msg->rm_infobufoffset),
744 le32toh(msg->rm_devicevchdl));
746 rval = urndis_ctrl_send(sc, msg, len);
748 if (rval != RNDIS_STATUS_SUCCESS) {
749 DPRINTF("query failed\n");
752 if ((hdr = urndis_ctrl_recv(sc)) == NULL) {
753 DPRINTF("unable to get query response\n");
754 return (RNDIS_STATUS_FAILURE);
756 rval = urndis_ctrl_handle(sc, hdr, rbuf, rbufsz);
762 urndis_ctrl_set(struct urndis_softc *sc, uint32_t oid,
763 struct urndis_set_req *msg, uint16_t len)
765 struct urndis_comp_hdr *hdr;
766 uint32_t datalen, rval;
768 msg->rm_type = htole32(REMOTE_NDIS_SET_MSG);
769 msg->rm_len = htole32(len);
770 msg->rm_rid = 0; /* XXX */
771 msg->rm_oid = htole32(oid);
772 datalen = len - sizeof(*msg);
773 msg->rm_infobuflen = htole32(datalen);
775 msg->rm_infobufoffset = htole32(sizeof(*msg) -
776 RNDIS_HEADER_OFFSET);
778 msg->rm_infobufoffset = 0;
780 msg->rm_devicevchdl = 0;
782 DPRINTF("type %u len %u rid %u oid 0x%x "
783 "infobuflen %u infobufoffset %u devicevchdl %u\n",
784 le32toh(msg->rm_type),
785 le32toh(msg->rm_len),
786 le32toh(msg->rm_rid),
787 le32toh(msg->rm_oid),
788 le32toh(msg->rm_infobuflen),
789 le32toh(msg->rm_infobufoffset),
790 le32toh(msg->rm_devicevchdl));
792 rval = urndis_ctrl_send(sc, msg, len);
794 if (rval != RNDIS_STATUS_SUCCESS) {
795 DPRINTF("set failed\n");
798 if ((hdr = urndis_ctrl_recv(sc)) == NULL) {
799 DPRINTF("unable to get set response\n");
800 return (RNDIS_STATUS_FAILURE);
802 rval = urndis_ctrl_handle(sc, hdr, NULL, NULL);
803 if (rval != RNDIS_STATUS_SUCCESS)
804 DPRINTF("set failed 0x%x\n", rval);
810 urndis_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
812 struct urndis_softc *sc = usbd_xfer_softc(xfer);
813 struct usb_page_cache *pc = usbd_xfer_get_frame(xfer, 0);
814 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
815 struct urndis_packet_msg msg;
821 switch (USB_GET_STATE(xfer)) {
822 case USB_ST_TRANSFERRED:
823 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
825 DPRINTFN(1, "received %u bytes in %u frames\n", actlen, aframes);
827 for (offset = 0; actlen >= (uint32_t)sizeof(msg);) {
828 /* copy out header */
829 usbd_copy_out(pc, offset, &msg, sizeof(msg));
831 if (le32toh(0x1234567U) != 0x1234567U) {
832 /* swap endianness */
833 msg.rm_type = le32toh(msg.rm_type);
834 msg.rm_len = le32toh(msg.rm_len);
835 msg.rm_dataoffset = le32toh(msg.rm_dataoffset);
836 msg.rm_datalen = le32toh(msg.rm_datalen);
837 msg.rm_oobdataoffset = le32toh(msg.rm_oobdataoffset);
838 msg.rm_oobdatalen = le32toh(msg.rm_oobdatalen);
839 msg.rm_oobdataelements = le32toh(msg.rm_oobdataelements);
840 msg.rm_pktinfooffset = le32toh(msg.rm_pktinfooffset);
841 msg.rm_pktinfolen = le32toh(msg.rm_pktinfolen);
842 msg.rm_vchandle = le32toh(msg.rm_vchandle);
843 msg.rm_reserved = le32toh(msg.rm_reserved);
846 DPRINTF("len %u data(off:%u len:%u) "
847 "oobdata(off:%u len:%u nb:%u) perpacket(off:%u len:%u)\n",
848 msg.rm_len, msg.rm_dataoffset, msg.rm_datalen,
849 msg.rm_oobdataoffset, msg.rm_oobdatalen,
850 msg.rm_oobdataelements, msg.rm_pktinfooffset,
851 msg.rm_pktinfooffset);
853 /* sanity check the RNDIS header */
854 if (msg.rm_type != REMOTE_NDIS_PACKET_MSG) {
855 DPRINTF("invalid type 0x%x != 0x%x\n",
856 msg.rm_type, REMOTE_NDIS_PACKET_MSG);
858 } else if (msg.rm_len < (uint32_t)sizeof(msg)) {
859 DPRINTF("invalid msg len %u < %u\n",
860 msg.rm_len, (unsigned)sizeof(msg));
862 } else if (msg.rm_len > (uint32_t)actlen) {
863 DPRINTF("invalid msg len %u > buffer "
864 "len %u\n", msg.rm_len, actlen);
866 } else if (msg.rm_dataoffset >= (uint32_t)actlen) {
867 DPRINTF("invalid msg dataoffset %u > buffer "
868 "dataoffset %u\n", msg.rm_dataoffset, actlen);
870 } else if (msg.rm_datalen > (uint32_t)actlen) {
871 DPRINTF("invalid msg datalen %u > buffer "
872 "datalen %u\n", msg.rm_datalen, actlen);
874 } else if ((msg.rm_dataoffset + msg.rm_datalen +
875 (uint32_t)__offsetof(struct urndis_packet_msg,
876 rm_dataoffset)) > (uint32_t)actlen) {
877 DPRINTF("invalid dataoffset %u larger than %u\n",
878 msg.rm_dataoffset + msg.rm_datalen +
879 (uint32_t)__offsetof(struct urndis_packet_msg,
880 rm_dataoffset), actlen);
882 } else if (msg.rm_datalen < (uint32_t)sizeof(struct ether_header)) {
884 DPRINTF("invalid ethernet size "
885 "%u < %u\n", msg.rm_datalen, (unsigned)sizeof(struct ether_header));
887 } else if (msg.rm_datalen > (uint32_t)(MCLBYTES - ETHER_ALIGN)) {
889 DPRINTF("invalid ethernet size "
891 msg.rm_datalen, (unsigned)MCLBYTES);
893 } else if (msg.rm_datalen > (uint32_t)(MHLEN - ETHER_ALIGN)) {
894 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
896 m = m_gethdr(M_NOWAIT, MT_DATA);
899 /* check if we have a buffer */
901 m->m_len = m->m_pkthdr.len = msg.rm_datalen + ETHER_ALIGN;
902 m_adj(m, ETHER_ALIGN);
904 usbd_copy_out(pc, offset + msg.rm_dataoffset +
905 __offsetof(struct urndis_packet_msg,
906 rm_dataoffset), m->m_data, msg.rm_datalen);
909 uether_rxmbuf(&sc->sc_ue, m, msg.rm_datalen);
913 offset += msg.rm_len;
914 actlen -= msg.rm_len;
919 usbd_xfer_set_frame_len(xfer, 0, RNDIS_RX_MAXLEN);
920 usbd_xfer_set_frames(xfer, 1);
921 usbd_transfer_submit(xfer);
922 uether_rxflush(&sc->sc_ue); /* must be last */
926 DPRINTFN(1, "error = %s\n", usbd_errstr(error));
928 if (error != USB_ERR_CANCELLED) {
929 /* try to clear stall first */
930 usbd_xfer_set_stall(xfer);
931 usbd_xfer_set_frames(xfer, 0);
932 usbd_transfer_submit(xfer);
939 urndis_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
941 struct urndis_packet_msg msg;
942 struct urndis_softc *sc = usbd_xfer_softc(xfer);
943 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
949 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
953 switch (USB_GET_STATE(xfer)) {
954 case USB_ST_TRANSFERRED:
955 DPRINTFN(11, "%u bytes in %u frames\n", actlen, aframes);
962 memset(&msg, 0, sizeof(msg));
964 for (x = 0; x != RNDIS_TX_FRAMES_MAX; x++) {
965 struct usb_page_cache *pc = usbd_xfer_get_frame(xfer, x);
967 usbd_xfer_set_frame_offset(xfer, x * RNDIS_TX_MAXLEN, x);
970 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
975 if ((m->m_pkthdr.len + sizeof(msg)) > RNDIS_TX_MAXLEN) {
976 DPRINTF("Too big packet\n");
983 msg.rm_type = htole32(REMOTE_NDIS_PACKET_MSG);
984 msg.rm_len = htole32(sizeof(msg) + m->m_pkthdr.len);
986 msg.rm_dataoffset = htole32(RNDIS_DATA_OFFSET);
987 msg.rm_datalen = htole32(m->m_pkthdr.len);
989 /* copy in all data */
990 usbd_copy_in(pc, 0, &msg, sizeof(msg));
991 usbd_m_copy_in(pc, sizeof(msg), m, 0, m->m_pkthdr.len);
992 usbd_xfer_set_frame_len(xfer, x, sizeof(msg) + m->m_pkthdr.len);
995 * If there's a BPF listener, bounce a copy of
1004 usbd_xfer_set_frames(xfer, x);
1005 usbd_transfer_submit(xfer);
1009 default: /* Error */
1010 DPRINTFN(11, "transfer error, %s\n", usbd_errstr(error));
1012 /* count output errors */
1015 if (error != USB_ERR_CANCELLED) {
1016 /* try to clear stall first */
1017 usbd_xfer_set_stall(xfer);
1025 urndis_intr_read_callback(struct usb_xfer *xfer, usb_error_t error)
1029 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1031 switch (USB_GET_STATE(xfer)) {
1032 case USB_ST_TRANSFERRED:
1034 DPRINTF("Received %d bytes\n", actlen);
1036 /* TODO: decode some indications */
1041 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1042 usbd_transfer_submit(xfer);
1045 default: /* Error */
1046 if (error != USB_ERR_CANCELLED) {
1047 /* start clear stall */
1048 usbd_xfer_set_stall(xfer);