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/caps.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 [URNDIS_BULK_RX] = {
94 .type = UE_BULK,
95 .endpoint = UE_ADDR_ANY,
96 .direction = UE_DIR_RX,
97 .if_index = 0,
98 .frames = 1,
99 .bufsize = RNDIS_RX_MAXLEN,
100 .flags = {.short_xfer_ok = 1,},
101 .callback = urndis_bulk_read_callback,
102 .timeout = 0, /* no timeout */
103 .usb_mode = USB_MODE_HOST,
104 },
105
106 [URNDIS_BULK_TX] = {
107 .type = UE_BULK,
108 .endpoint = UE_ADDR_ANY,
109 .direction = UE_DIR_TX,
110 .if_index = 0,
111 .frames = RNDIS_TX_FRAMES_MAX,
112 .bufsize = (RNDIS_TX_FRAMES_MAX * RNDIS_TX_MAXLEN),
113 .flags = {
114 .force_short_xfer = 1,
115 },
116 .callback = urndis_bulk_write_callback,
117 .timeout = 10000, /* 10 seconds */
118 .usb_mode = USB_MODE_HOST,
119 },
120
121 [URNDIS_INTR_RX] = {
122 .type = UE_INTERRUPT,
123 .endpoint = UE_ADDR_ANY,
124 .direction = UE_DIR_RX,
125 .if_index = 1,
126 .bufsize = 0, /* use wMaxPacketSize */
127 .flags = {.short_xfer_ok = 1,.no_pipe_ok = 1,},
128 .callback = urndis_intr_read_callback,
129 .timeout = 0,
130 .usb_mode = USB_MODE_HOST,
131 },
132 };
133
134 static device_method_t urndis_methods[] = {
135 /* Device interface */
136 DEVMETHOD(device_probe, urndis_probe),
137 DEVMETHOD(device_attach, urndis_attach),
138 DEVMETHOD(device_detach, urndis_detach),
139 DEVMETHOD(device_suspend, urndis_suspend),
140 DEVMETHOD(device_resume, urndis_resume),
141
142 DEVMETHOD_END
143 };
144
145 static driver_t urndis_driver = {
146 .name = "urndis",
147 .methods = urndis_methods,
148 .size = sizeof(struct urndis_softc),
149 };
150
151 static devclass_t urndis_devclass;
152
153 DRIVER_MODULE(urndis, uhub, urndis_driver, urndis_devclass, NULL, NULL);
154 MODULE_VERSION(urndis, 1);
155 MODULE_DEPEND(urndis, uether, 1, 1, 1);
156 MODULE_DEPEND(urndis, usb, 1, 1, 1);
157 MODULE_DEPEND(urndis, ether, 1, 1, 1);
158
159 static const struct usb_ether_methods urndis_ue_methods = {
160 .ue_attach_post = urndis_attach_post,
161 .ue_start = urndis_start,
162 .ue_init = urndis_init,
163 .ue_stop = urndis_stop,
164 .ue_setmulti = urndis_setmulti,
165 .ue_setpromisc = urndis_setpromisc,
166 };
167
168 static const STRUCT_USB_HOST_ID urndis_host_devs[] = {
169 /* Generic RNDIS class match */
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 /* HP-WebOS */
175 {USB_VENDOR(USB_VENDOR_PALM), USB_IFACE_CLASS(UICLASS_CDC),
176 USB_IFACE_SUBCLASS(UISUBCLASS_ABSTRACT_CONTROL_MODEL),
177 USB_IFACE_PROTOCOL(0xff)},
178 };
179
180 static const STRUCT_USB_HOST_ID urndis_non_huawei_host_devs[] = {
181 {USB_IFACE_CLASS(UICLASS_CDC),
182 USB_IFACE_SUBCLASS(UISUBCLASS_ABSTRACT_CONTROL_MODEL),
183 USB_IFACE_PROTOCOL(0xff)},
184 };
185
186 static int
urndis_probe(device_t dev)187 urndis_probe(device_t dev)
188 {
189 int res;
190 struct usb_attach_arg *uaa = device_get_ivars(dev);
191
192 res = usbd_lookup_id_by_uaa(urndis_host_devs,
193 sizeof(urndis_host_devs), uaa);
194 if (res == 0)
195 return(0);
196 if (uaa->info.idVendor == USB_VENDOR_HUAWEI)
197 return(ENXIO);
198 return (usbd_lookup_id_by_uaa(urndis_non_huawei_host_devs,
199 sizeof(urndis_non_huawei_host_devs), uaa));
200 }
201
202 static void
urndis_attach_post(struct usb_ether * ue)203 urndis_attach_post(struct usb_ether *ue)
204 {
205 /* no-op */
206 return;
207 }
208
209 static int
urndis_attach(device_t dev)210 urndis_attach(device_t dev)
211 {
212 struct urndis_softc *sc = device_get_softc(dev);
213 struct usb_ether *ue = &sc->sc_ue;
214 struct usb_attach_arg *uaa = device_get_ivars(dev);
215 struct usb_cdc_cm_descriptor *cmd;
216 struct {
217 struct urndis_set_req hdr;
218 uint32_t filter;
219 } msg_filter;
220 const void *buf;
221 uint16_t bufsz;
222 uint8_t iface_index[2] = { uaa->info.bIfaceIndex + 1, uaa->info.bIfaceIndex };
223 int error;
224 uint8_t i;
225
226 sc->sc_ue.ue_udev = uaa->device;
227 sc->sc_ifaceno_ctl = uaa->info.bIfaceNum;
228
229 cmd = usbd_find_descriptor(uaa->device, NULL, uaa->info.bIfaceIndex,
230 UDESC_CS_INTERFACE, 0xFF, UDESCSUB_CDC_CM, 0xFF);
231 if (cmd != NULL) {
232 DPRINTF("Call Mode Descriptor found, dataif=%d\n", cmd->bDataInterface);
233 iface_index[0] = cmd->bDataInterface;
234 }
235
236 device_set_usb_desc(dev);
237
238 lockinit(&sc->sc_lock, device_get_nameunit(dev), 0, LK_CANRECURSE);
239
240 /* scan the alternate settings looking for a valid one */
241
242 for (i = 0; i != 32; i++) {
243
244 error = usbd_set_alt_interface_index(uaa->device,
245 iface_index[0], i);
246
247 if (error != 0)
248 break;
249
250 error = usbd_transfer_setup(uaa->device,
251 iface_index, sc->sc_xfer, urndis_config,
252 URNDIS_N_TRANSFER, sc, &sc->sc_lock);
253
254 if (error == 0)
255 break;
256 }
257
258 if ((error != 0) || (i == 32)) {
259 device_printf(dev, "No valid alternate setting found\n");
260 goto detach;
261 }
262 URNDIS_LOCK(sc);
263 error = urndis_ctrl_query(sc, OID_802_3_PERMANENT_ADDRESS, &buf, &bufsz);
264 URNDIS_UNLOCK(sc);
265
266 if (error != (int)RNDIS_STATUS_SUCCESS) {
267 device_printf(dev, "Unable to get hardware address\n");
268 goto detach;
269 }
270 if (bufsz != ETHER_ADDR_LEN) {
271 device_printf(dev, "Invalid address length: %d bytes\n", bufsz);
272 goto detach;
273 }
274 memcpy(&sc->sc_ue.ue_eaddr, buf, ETHER_ADDR_LEN);
275
276 /* Initialize packet filter */
277 sc->sc_filter = RNDIS_PACKET_TYPE_BROADCAST |
278 RNDIS_PACKET_TYPE_ALL_MULTICAST;
279 msg_filter.filter = htole32(sc->sc_filter);
280
281 URNDIS_LOCK(sc);
282 error = urndis_ctrl_set(sc, OID_GEN_CURRENT_PACKET_FILTER,
283 &msg_filter.hdr, sizeof(msg_filter));
284 URNDIS_UNLOCK(sc);
285
286 if (error != (int)RNDIS_STATUS_SUCCESS) {
287 device_printf(dev, "Unable to set data filters\n");
288 goto detach;
289 }
290 ue->ue_sc = sc;
291 ue->ue_dev = dev;
292 ue->ue_udev = uaa->device;
293 ue->ue_lock = &sc->sc_lock;
294 ue->ue_methods = &urndis_ue_methods;
295
296 error = uether_ifattach(ue);
297 if (error) {
298 device_printf(dev, "Could not attach interface\n");
299 goto detach;
300 }
301
302 URNDIS_LOCK(sc);
303 /* start interrupt endpoint, if any */
304 usbd_transfer_start(sc->sc_xfer[URNDIS_INTR_RX]);
305 URNDIS_UNLOCK(sc);
306
307 return (0); /* success */
308
309 detach:
310 urndis_detach(dev);
311 return (ENXIO); /* failure */
312 }
313
314 static int
urndis_detach(device_t dev)315 urndis_detach(device_t dev)
316 {
317 struct urndis_softc *sc = device_get_softc(dev);
318 struct usb_ether *ue = &sc->sc_ue;
319
320 /* stop all USB transfers first */
321 usbd_transfer_unsetup(sc->sc_xfer, URNDIS_N_TRANSFER);
322
323 uether_ifdetach(ue);
324
325 lockuninit(&sc->sc_lock);
326
327 return (0);
328 }
329
330 static void
urndis_start(struct usb_ether * ue)331 urndis_start(struct usb_ether *ue)
332 {
333 struct urndis_softc *sc = uether_getsc(ue);
334
335 /*
336 * Start the USB transfers, if not already started:
337 */
338 usbd_transfer_start(sc->sc_xfer[URNDIS_BULK_TX]);
339 usbd_transfer_start(sc->sc_xfer[URNDIS_BULK_RX]);
340 }
341
342 static void
urndis_init(struct usb_ether * ue)343 urndis_init(struct usb_ether *ue)
344 {
345 struct urndis_softc *sc = uether_getsc(ue);
346 struct ifnet *ifp = uether_getifp(ue);
347
348 URNDIS_LOCK_ASSERT(sc);
349
350 ifp->if_flags |= IFF_RUNNING;
351
352 urndis_ctrl_init(sc);
353
354 /* stall data write direction, which depends on USB mode */
355 usbd_xfer_set_stall(sc->sc_xfer[URNDIS_BULK_TX]);
356
357 /* start data transfers */
358 urndis_start(ue);
359 }
360
361 static void
urndis_stop(struct usb_ether * ue)362 urndis_stop(struct usb_ether *ue)
363 {
364 struct urndis_softc *sc = uether_getsc(ue);
365 struct ifnet *ifp = uether_getifp(ue);
366
367 URNDIS_LOCK_ASSERT(sc);
368
369 ifp->if_flags &= ~IFF_RUNNING;
370
371 /*
372 * stop all the transfers, if not already stopped:
373 */
374 usbd_transfer_stop(sc->sc_xfer[URNDIS_BULK_RX]);
375 usbd_transfer_stop(sc->sc_xfer[URNDIS_BULK_TX]);
376 }
377
378 static void
urndis_setmulti(struct usb_ether * ue)379 urndis_setmulti(struct usb_ether *ue)
380 {
381 /* no-op */
382 return;
383 }
384
385 static void
urndis_setpromisc(struct usb_ether * ue)386 urndis_setpromisc(struct usb_ether *ue)
387 {
388 /* no-op */
389 return;
390 }
391
392 static int
urndis_suspend(device_t dev)393 urndis_suspend(device_t dev)
394 {
395 device_printf(dev, "Suspending\n");
396 return (0);
397 }
398
399 static int
urndis_resume(device_t dev)400 urndis_resume(device_t dev)
401 {
402 device_printf(dev, "Resuming\n");
403 return (0);
404 }
405
406 static usb_error_t
urndis_ctrl_msg(struct urndis_softc * sc,uint8_t rt,uint8_t r,uint16_t index,uint16_t value,void * buf,uint16_t buflen)407 urndis_ctrl_msg(struct urndis_softc *sc, uint8_t rt, uint8_t r,
408 uint16_t index, uint16_t value, void *buf, uint16_t buflen)
409 {
410 usb_device_request_t req;
411
412 req.bmRequestType = rt;
413 req.bRequest = r;
414 USETW(req.wValue, value);
415 USETW(req.wIndex, index);
416 USETW(req.wLength, buflen);
417
418 return (usbd_do_request_flags(sc->sc_ue.ue_udev,
419 &sc->sc_lock, &req, buf, (rt & UT_READ) ?
420 USB_SHORT_XFER_OK : 0, NULL, 2000 /* ms */ ));
421 }
422
423 static usb_error_t
urndis_ctrl_send(struct urndis_softc * sc,void * buf,uint16_t len)424 urndis_ctrl_send(struct urndis_softc *sc, void *buf, uint16_t len)
425 {
426 usb_error_t err;
427
428 err = urndis_ctrl_msg(sc, UT_WRITE_CLASS_INTERFACE, UR_GET_STATUS,
429 sc->sc_ifaceno_ctl, 0, buf, len);
430
431 DPRINTF("%s\n", usbd_errstr(err));
432
433 return (err);
434 }
435
436 static struct urndis_comp_hdr *
urndis_ctrl_recv(struct urndis_softc * sc)437 urndis_ctrl_recv(struct urndis_softc *sc)
438 {
439 struct urndis_comp_hdr *hdr;
440 usb_error_t err;
441
442 err = urndis_ctrl_msg(sc, UT_READ_CLASS_INTERFACE, UR_CLEAR_FEATURE,
443 sc->sc_ifaceno_ctl, 0, sc->sc_response_buf, RNDIS_RESPONSE_LEN);
444
445 if (err != USB_ERR_NORMAL_COMPLETION)
446 return (NULL);
447
448 hdr = (struct urndis_comp_hdr *)sc->sc_response_buf;
449
450 DPRINTF("type 0x%x len %u\n", le32toh(hdr->rm_type),
451 le32toh(hdr->rm_len));
452
453 if (le32toh(hdr->rm_len) > RNDIS_RESPONSE_LEN) {
454 DPRINTF("ctrl message error: wrong size %u > %u\n",
455 le32toh(hdr->rm_len), RNDIS_RESPONSE_LEN);
456 return (NULL);
457 }
458 return (hdr);
459 }
460
461 static uint32_t
urndis_ctrl_handle(struct urndis_softc * sc,struct urndis_comp_hdr * hdr,const void ** buf,uint16_t * bufsz)462 urndis_ctrl_handle(struct urndis_softc *sc, struct urndis_comp_hdr *hdr,
463 const void **buf, uint16_t *bufsz)
464 {
465 uint32_t rval;
466
467 DPRINTF("\n");
468
469 if (buf != NULL && bufsz != NULL) {
470 *buf = NULL;
471 *bufsz = 0;
472 }
473 switch (le32toh(hdr->rm_type)) {
474 case REMOTE_NDIS_INITIALIZE_CMPLT:
475 rval = urndis_ctrl_handle_init(sc, hdr);
476 break;
477
478 case REMOTE_NDIS_QUERY_CMPLT:
479 rval = urndis_ctrl_handle_query(sc, hdr, buf, bufsz);
480 break;
481
482 case REMOTE_NDIS_RESET_CMPLT:
483 rval = urndis_ctrl_handle_reset(sc, hdr);
484 break;
485
486 case REMOTE_NDIS_KEEPALIVE_CMPLT:
487 case REMOTE_NDIS_SET_CMPLT:
488 rval = le32toh(hdr->rm_status);
489 break;
490
491 default:
492 DPRINTF("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
500 static uint32_t
urndis_ctrl_handle_init(struct urndis_softc * sc,const struct urndis_comp_hdr * hdr)501 urndis_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
543 static uint32_t
urndis_ctrl_handle_query(struct urndis_softc * sc,const struct urndis_comp_hdr * hdr,const void ** buf,uint16_t * bufsz)544 urndis_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
550 msg = (const struct urndis_query_comp *)hdr;
551
552 DPRINTF("len %u rid %u status 0x%x "
553 "buflen %u bufoff %u\n",
554 le32toh(msg->rm_len),
555 le32toh(msg->rm_rid),
556 le32toh(msg->rm_status),
557 le32toh(msg->rm_infobuflen),
558 le32toh(msg->rm_infobufoffset));
559
560 if (buf != NULL && bufsz != NULL) {
561 *buf = NULL;
562 *bufsz = 0;
563 }
564 if (le32toh(msg->rm_status) != RNDIS_STATUS_SUCCESS) {
565 DPRINTF("query failed 0x%x\n", le32toh(msg->rm_status));
566 return (le32toh(msg->rm_status));
567 }
568 limit = le32toh(msg->rm_infobuflen);
569 limit += le32toh(msg->rm_infobufoffset);
570 limit += RNDIS_HEADER_OFFSET;
571
572 if (limit > (uint64_t)le32toh(msg->rm_len)) {
573 DPRINTF("ctrl message error: invalid query info "
574 "len/offset/end_position(%u/%u/%u) -> "
575 "go out of buffer limit %u\n",
576 le32toh(msg->rm_infobuflen),
577 le32toh(msg->rm_infobufoffset),
578 le32toh(msg->rm_infobuflen) +
579 le32toh(msg->rm_infobufoffset) + RNDIS_HEADER_OFFSET,
580 le32toh(msg->rm_len));
581 return (RNDIS_STATUS_FAILURE);
582 }
583 if (buf != NULL && bufsz != NULL) {
584 *buf = ((const uint8_t *)msg) + RNDIS_HEADER_OFFSET + le32toh(msg->rm_infobufoffset);
585 *bufsz = le32toh(msg->rm_infobuflen);
586 }
587 return (le32toh(msg->rm_status));
588 }
589
590 static uint32_t
urndis_ctrl_handle_reset(struct urndis_softc * sc,const struct urndis_comp_hdr * hdr)591 urndis_ctrl_handle_reset(struct urndis_softc *sc,
592 const struct urndis_comp_hdr *hdr)
593 {
594 const struct urndis_reset_comp *msg;
595 uint32_t rval;
596
597 msg = (const struct urndis_reset_comp *)hdr;
598
599 rval = le32toh(msg->rm_status);
600
601 DPRINTF("len %u status 0x%x "
602 "adrreset %u\n",
603 le32toh(msg->rm_len),
604 rval,
605 le32toh(msg->rm_adrreset));
606
607 if (rval != RNDIS_STATUS_SUCCESS) {
608 DPRINTF("reset failed 0x%x\n", rval);
609 return (rval);
610 }
611 if (msg->rm_adrreset != 0) {
612 struct {
613 struct urndis_set_req hdr;
614 uint32_t filter;
615 } msg_filter;
616
617 msg_filter.filter = htole32(sc->sc_filter);
618
619 rval = urndis_ctrl_set(sc, OID_GEN_CURRENT_PACKET_FILTER,
620 &msg_filter.hdr, sizeof(msg_filter));
621
622 if (rval != RNDIS_STATUS_SUCCESS) {
623 DPRINTF("unable to reset data filters\n");
624 return (rval);
625 }
626 }
627 return (rval);
628 }
629
630 static uint32_t
urndis_ctrl_init(struct urndis_softc * sc)631 urndis_ctrl_init(struct urndis_softc *sc)
632 {
633 struct urndis_init_req msg;
634 struct urndis_comp_hdr *hdr;
635 uint32_t rval;
636
637 msg.rm_type = htole32(REMOTE_NDIS_INITIALIZE_MSG);
638 msg.rm_len = htole32(sizeof(msg));
639 msg.rm_rid = htole32(0);
640 msg.rm_ver_major = htole32(1);
641 msg.rm_ver_minor = htole32(1);
642 msg.rm_max_xfersz = htole32(RNDIS_RX_MAXLEN);
643
644 DPRINTF("type %u len %u rid %u ver_major %u "
645 "ver_minor %u max_xfersz %u\n",
646 le32toh(msg.rm_type),
647 le32toh(msg.rm_len),
648 le32toh(msg.rm_rid),
649 le32toh(msg.rm_ver_major),
650 le32toh(msg.rm_ver_minor),
651 le32toh(msg.rm_max_xfersz));
652
653 rval = urndis_ctrl_send(sc, &msg, sizeof(msg));
654
655 if (rval != RNDIS_STATUS_SUCCESS) {
656 DPRINTF("init failed\n");
657 return (rval);
658 }
659 if ((hdr = urndis_ctrl_recv(sc)) == NULL) {
660 DPRINTF("unable to get init response\n");
661 return (RNDIS_STATUS_FAILURE);
662 }
663 rval = urndis_ctrl_handle(sc, hdr, NULL, NULL);
664
665 return (rval);
666 }
667
668 #if 0
669 static uint32_t
670 urndis_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 #endif
692
693 static uint32_t
urndis_ctrl_query(struct urndis_softc * sc,uint32_t oid,const void ** rbuf,uint16_t * rbufsz)694 urndis_ctrl_query(struct urndis_softc *sc, uint32_t oid, const void **rbuf, uint16_t *rbufsz)
695 {
696 struct urndis_query_req msg;
697 uint32_t rval;
698 struct urndis_comp_hdr *hdr;
699
700 msg.rm_type = htole32(REMOTE_NDIS_QUERY_MSG);
701 msg.rm_len = htole32(sizeof(msg));
702 msg.rm_rid = 0; /* XXX */
703 msg.rm_oid = htole32(oid);
704 msg.rm_infobuflen = htole32(0);
705 msg.rm_infobufoffset = 0;
706 msg.rm_devicevchdl = 0;
707
708 DPRINTF("type %u len %u rid %u oid 0x%x "
709 "infobuflen %u infobufoffset %u devicevchdl %u\n",
710 le32toh(msg.rm_type),
711 le32toh(msg.rm_len),
712 le32toh(msg.rm_rid),
713 le32toh(msg.rm_oid),
714 le32toh(msg.rm_infobuflen),
715 le32toh(msg.rm_infobufoffset),
716 le32toh(msg.rm_devicevchdl));
717
718 rval = urndis_ctrl_send(sc, &msg, sizeof(msg));
719
720 if (rval != RNDIS_STATUS_SUCCESS) {
721 DPRINTF("query failed\n");
722 return (rval);
723 }
724 if ((hdr = urndis_ctrl_recv(sc)) == NULL) {
725 DPRINTF("unable to get query response\n");
726 return (RNDIS_STATUS_FAILURE);
727 }
728 rval = urndis_ctrl_handle(sc, hdr, rbuf, rbufsz);
729
730 return (rval);
731 }
732
733 static uint32_t
urndis_ctrl_set(struct urndis_softc * sc,uint32_t oid,struct urndis_set_req * msg,uint16_t len)734 urndis_ctrl_set(struct urndis_softc *sc, uint32_t oid, struct urndis_set_req *msg, uint16_t len)
735 {
736 struct urndis_comp_hdr *hdr;
737 uint32_t rval;
738 uint32_t datalen = len - sizeof(*msg);
739
740 msg->rm_type = htole32(REMOTE_NDIS_SET_MSG);
741 msg->rm_len = htole32(len);
742 msg->rm_rid = 0; /* XXX */
743 msg->rm_oid = htole32(oid);
744 msg->rm_infobuflen = htole32(datalen);
745 if (datalen != 0) {
746 msg->rm_infobufoffset = htole32(sizeof(*msg) - RNDIS_HEADER_OFFSET);
747 } else {
748 msg->rm_infobufoffset = 0;
749 }
750 msg->rm_devicevchdl = 0;
751
752 DPRINTF("type %u len %u rid %u oid 0x%x "
753 "infobuflen %u infobufoffset %u devicevchdl %u\n",
754 le32toh(msg->rm_type),
755 le32toh(msg->rm_len),
756 le32toh(msg->rm_rid),
757 le32toh(msg->rm_oid),
758 le32toh(msg->rm_infobuflen),
759 le32toh(msg->rm_infobufoffset),
760 le32toh(msg->rm_devicevchdl));
761
762 rval = urndis_ctrl_send(sc, msg, len);
763
764 if (rval != RNDIS_STATUS_SUCCESS) {
765 DPRINTF("set failed\n");
766 return (rval);
767 }
768 if ((hdr = urndis_ctrl_recv(sc)) == NULL) {
769 DPRINTF("unable to get set response\n");
770 return (RNDIS_STATUS_FAILURE);
771 }
772 rval = urndis_ctrl_handle(sc, hdr, NULL, NULL);
773 if (rval != RNDIS_STATUS_SUCCESS)
774 DPRINTF("set failed 0x%x\n", rval);
775
776 return (rval);
777 }
778
779 static void
urndis_bulk_read_callback(struct usb_xfer * xfer,usb_error_t error)780 urndis_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
781 {
782 struct urndis_softc *sc = usbd_xfer_softc(xfer);
783 struct usb_page_cache *pc = usbd_xfer_get_frame(xfer, 0);
784 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
785 struct urndis_packet_msg msg;
786 struct mbuf *m;
787 int actlen;
788 int aframes;
789 int offset;
790
791 switch (USB_GET_STATE(xfer)) {
792 case USB_ST_TRANSFERRED:
793
794 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
795
796 DPRINTFN(1, "received %u bytes in %u frames\n", actlen, aframes);
797
798 for (offset = 0; actlen >= (uint32_t)sizeof(msg);) {
799
800 /* copy out header */
801 usbd_copy_out(pc, offset, &msg, sizeof(msg));
802
803 if (le32toh(0x1234567U) != 0x1234567U) {
804 /* swap endianness */
805 msg.rm_type = le32toh(msg.rm_type);
806 msg.rm_len = le32toh(msg.rm_len);
807 msg.rm_dataoffset = le32toh(msg.rm_dataoffset);
808 msg.rm_datalen = le32toh(msg.rm_datalen);
809 msg.rm_oobdataoffset = le32toh(msg.rm_oobdataoffset);
810 msg.rm_oobdatalen = le32toh(msg.rm_oobdatalen);
811 msg.rm_oobdataelements = le32toh(msg.rm_oobdataelements);
812 msg.rm_pktinfooffset = le32toh(msg.rm_pktinfooffset);
813 msg.rm_pktinfolen = le32toh(msg.rm_pktinfolen);
814 msg.rm_vchandle = le32toh(msg.rm_vchandle);
815 msg.rm_reserved = le32toh(msg.rm_reserved);
816 }
817
818 DPRINTF("len %u data(off:%u len:%u) "
819 "oobdata(off:%u len:%u nb:%u) perpacket(off:%u len:%u)\n",
820 msg.rm_len, msg.rm_dataoffset, msg.rm_datalen,
821 msg.rm_oobdataoffset, msg.rm_oobdatalen,
822 msg.rm_oobdataelements, msg.rm_pktinfooffset,
823 msg.rm_pktinfooffset);
824
825 /* sanity check the RNDIS header */
826 if (msg.rm_type != REMOTE_NDIS_PACKET_MSG) {
827 DPRINTF("invalid type 0x%x != 0x%x\n",
828 msg.rm_type, REMOTE_NDIS_PACKET_MSG);
829 goto tr_setup;
830 } else if (msg.rm_len < (uint32_t)sizeof(msg)) {
831 DPRINTF("invalid msg len %u < %u\n",
832 msg.rm_len, (unsigned)sizeof(msg));
833 goto tr_setup;
834 } else if (msg.rm_len > (uint32_t)actlen) {
835 DPRINTF("invalid msg len %u > buffer "
836 "len %u\n", msg.rm_len, actlen);
837 goto tr_setup;
838 } else if (msg.rm_dataoffset >= (uint32_t)actlen) {
839 DPRINTF("invalid msg dataoffset %u > buffer "
840 "dataoffset %u\n", msg.rm_dataoffset, actlen);
841 goto tr_setup;
842 } else if (msg.rm_datalen > (uint32_t)actlen) {
843 DPRINTF("invalid msg datalen %u > buffer "
844 "datalen %u\n", msg.rm_datalen, actlen);
845 goto tr_setup;
846 } else if ((msg.rm_dataoffset + msg.rm_datalen +
847 (uint32_t)__offsetof(struct urndis_packet_msg,
848 rm_dataoffset)) > (uint32_t)actlen) {
849 DPRINTF("invalid dataoffset %u larger than %u\n",
850 msg.rm_dataoffset + msg.rm_datalen +
851 (uint32_t)__offsetof(struct urndis_packet_msg,
852 rm_dataoffset), actlen);
853 goto tr_setup;
854 } else if (msg.rm_datalen < (uint32_t)sizeof(struct ether_header)) {
855 IFNET_STAT_INC(ifp, ierrors, 1);
856 DPRINTF("invalid ethernet size "
857 "%u < %u\n", msg.rm_datalen, (unsigned)sizeof(struct ether_header));
858 goto tr_setup;
859 } else if (msg.rm_datalen > (uint32_t)MCLBYTES) {
860 IFNET_STAT_INC(ifp, ierrors, 1);
861 DPRINTF("invalid ethernet size "
862 "%u > %u\n",
863 msg.rm_datalen, (unsigned)MCLBYTES);
864 goto tr_setup;
865 } else if (msg.rm_datalen > (uint32_t)(MHLEN - ETHER_ALIGN)) {
866 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
867 } else {
868 m = m_gethdr(M_NOWAIT, MT_DATA);
869 }
870
871 /* check if we have a buffer */
872 if (m != NULL) {
873 m_adj(m, ETHER_ALIGN);
874
875 usbd_copy_out(pc, offset + msg.rm_dataoffset +
876 __offsetof(struct urndis_packet_msg,
877 rm_dataoffset), m->m_data, msg.rm_datalen);
878
879 /* enqueue */
880 uether_rxmbuf(&sc->sc_ue, m, msg.rm_datalen);
881 } else {
882 IFNET_STAT_INC(ifp, ierrors, 1);
883 }
884 offset += msg.rm_len;
885 actlen -= msg.rm_len;
886 }
887
888 case USB_ST_SETUP:
889 tr_setup:
890 usbd_xfer_set_frame_len(xfer, 0, RNDIS_RX_MAXLEN);
891 usbd_xfer_set_frames(xfer, 1);
892 usbd_transfer_submit(xfer);
893 uether_rxflush(&sc->sc_ue); /* must be last */
894 break;
895
896 default: /* Error */
897 DPRINTFN(1, "error = %s\n", usbd_errstr(error));
898
899 if (error != USB_ERR_CANCELLED) {
900 /* try to clear stall first */
901 usbd_xfer_set_stall(xfer);
902 usbd_xfer_set_frames(xfer, 0);
903 usbd_transfer_submit(xfer);
904 }
905 break;
906 }
907 }
908
909 static void
urndis_bulk_write_callback(struct usb_xfer * xfer,usb_error_t error)910 urndis_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
911 {
912 struct urndis_packet_msg msg;
913 struct urndis_softc *sc = usbd_xfer_softc(xfer);
914 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
915 struct mbuf *m;
916 unsigned x;
917 int actlen;
918 int aframes;
919
920 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
921
922 DPRINTFN(1, "\n");
923
924 switch (USB_GET_STATE(xfer)) {
925 case USB_ST_TRANSFERRED:
926 DPRINTFN(11, "%u bytes in %u frames\n", actlen, aframes);
927
928 ifq_clr_oactive(&ifp->if_snd);
929 IFNET_STAT_INC(ifp, opackets, 1);
930
931 /* FALLTHROUGH */
932 case USB_ST_SETUP:
933 tr_setup:
934 if (ifq_is_oactive(&ifp->if_snd)) {
935 return;
936 }
937 memset(&msg, 0, sizeof(msg));
938
939 for (x = 0; x != RNDIS_TX_FRAMES_MAX; x++) {
940 struct usb_page_cache *pc = usbd_xfer_get_frame(xfer, x);
941
942 usbd_xfer_set_frame_offset(xfer, x * RNDIS_TX_MAXLEN, x);
943
944 next_pkt:
945 m = ifq_dequeue(&ifp->if_snd);
946
947 if (m == NULL)
948 break;
949
950 if ((m->m_pkthdr.len + sizeof(msg)) > RNDIS_TX_MAXLEN) {
951 DPRINTF("Too big packet\n");
952 IFNET_STAT_INC(ifp, oerrors, 1);
953
954 /* Free buffer */
955 m_freem(m);
956 goto next_pkt;
957 }
958 msg.rm_type = htole32(REMOTE_NDIS_PACKET_MSG);
959 msg.rm_len = htole32(sizeof(msg) + m->m_pkthdr.len);
960
961 msg.rm_dataoffset = htole32(RNDIS_DATA_OFFSET);
962 msg.rm_datalen = htole32(m->m_pkthdr.len);
963
964 /* copy in all data */
965 usbd_copy_in(pc, 0, &msg, sizeof(msg));
966 usbd_m_copy_in(pc, sizeof(msg), m, 0, m->m_pkthdr.len);
967 usbd_xfer_set_frame_len(xfer, x, sizeof(msg) + m->m_pkthdr.len);
968
969 /*
970 * If there's a BPF listener, bounce a copy of
971 * this frame to him:
972 */
973 BPF_MTAP(ifp, m);
974
975 /* Free buffer */
976 m_freem(m);
977 }
978 if (x != 0) {
979 usbd_xfer_set_frames(xfer, x);
980 usbd_transfer_submit(xfer);
981 ifq_set_oactive(&ifp->if_snd);
982 }
983 break;
984
985 default: /* Error */
986 DPRINTFN(11, "transfer error, %s\n", usbd_errstr(error));
987
988 /* count output errors */
989 IFNET_STAT_INC(ifp, oerrors, 1);
990 ifq_clr_oactive(&ifp->if_snd);
991
992 if (error != USB_ERR_CANCELLED) {
993 /* try to clear stall first */
994 usbd_xfer_set_stall(xfer);
995 goto tr_setup;
996 }
997 break;
998 }
999 }
1000
1001 static void
urndis_intr_read_callback(struct usb_xfer * xfer,usb_error_t error)1002 urndis_intr_read_callback(struct usb_xfer *xfer, usb_error_t error)
1003 {
1004 int actlen;
1005
1006 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1007
1008 switch (USB_GET_STATE(xfer)) {
1009 case USB_ST_TRANSFERRED:
1010
1011 DPRINTF("Received %d bytes\n", actlen);
1012
1013 /* TODO: decode some indications */
1014
1015 /* FALLTHROUGH */
1016 case USB_ST_SETUP:
1017 tr_setup:
1018 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1019 usbd_transfer_submit(xfer);
1020 break;
1021
1022 default: /* Error */
1023 if (error != USB_ERR_CANCELLED) {
1024 /* start clear stall */
1025 usbd_xfer_set_stall(xfer);
1026 goto tr_setup;
1027 }
1028 break;
1029 }
1030 }
1031