1 /* $NetBSD: if_cdce.c,v 1.4 2004/10/24 12:50:54 augustss Exp $ */
4 * Copyright (c) 1997, 1998, 1999, 2000-2003 Bill Paul <wpaul@windriver.com>
5 * Copyright (c) 2003-2005 Craig Boston
6 * Copyright (c) 2004 Daniel Hartmeier
7 * Copyright (c) 2009 Hans Petter Selasky
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by Bill Paul.
21 * 4. Neither the name of the author nor the names of any co-contributors
22 * may be used to endorse or promote products derived from this software
23 * without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul, THE VOICES IN HIS HEAD OR
29 * THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
32 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
33 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
34 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
35 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 * USB Communication Device Class (Ethernet Networking Control Model)
40 * http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
44 * USB Network Control Model (NCM)
45 * http://www.usb.org/developers/devclass_docs/NCM10.zip
48 #include <sys/cdefs.h>
49 __FBSDID("$FreeBSD$");
51 #include <sys/stdint.h>
52 #include <sys/stddef.h>
53 #include <sys/param.h>
54 #include <sys/queue.h>
55 #include <sys/types.h>
56 #include <sys/systm.h>
57 #include <sys/kernel.h>
59 #include <sys/module.h>
61 #include <sys/mutex.h>
62 #include <sys/condvar.h>
63 #include <sys/sysctl.h>
65 #include <sys/unistd.h>
66 #include <sys/callout.h>
67 #include <sys/malloc.h>
70 #include <dev/usb/usb.h>
71 #include <dev/usb/usbdi.h>
72 #include <dev/usb/usbdi_util.h>
73 #include <dev/usb/usb_cdc.h>
76 #define USB_DEBUG_VAR cdce_debug
77 #include <dev/usb/usb_debug.h>
78 #include <dev/usb/usb_process.h>
81 #include <dev/usb/net/usb_ethernet.h>
82 #include <dev/usb/net/if_cdcereg.h>
84 static device_probe_t cdce_probe;
85 static device_attach_t cdce_attach;
86 static device_detach_t cdce_detach;
87 static device_suspend_t cdce_suspend;
88 static device_resume_t cdce_resume;
89 static usb_handle_request_t cdce_handle_request;
91 static usb_callback_t cdce_bulk_write_callback;
92 static usb_callback_t cdce_bulk_read_callback;
93 static usb_callback_t cdce_intr_read_callback;
94 static usb_callback_t cdce_intr_write_callback;
97 static usb_callback_t cdce_ncm_bulk_write_callback;
98 static usb_callback_t cdce_ncm_bulk_read_callback;
101 static uether_fn_t cdce_attach_post;
102 static uether_fn_t cdce_init;
103 static uether_fn_t cdce_stop;
104 static uether_fn_t cdce_start;
105 static uether_fn_t cdce_setmulti;
106 static uether_fn_t cdce_setpromisc;
108 static uint32_t cdce_m_crc32(struct mbuf *, uint32_t, uint32_t);
111 static int cdce_debug = 0;
112 static int cdce_tx_interval = 0;
114 static SYSCTL_NODE(_hw_usb, OID_AUTO, cdce, CTLFLAG_RW, 0, "USB CDC-Ethernet");
115 SYSCTL_INT(_hw_usb_cdce, OID_AUTO, debug, CTLFLAG_RW, &cdce_debug, 0,
117 SYSCTL_INT(_hw_usb_cdce, OID_AUTO, interval, CTLFLAG_RW, &cdce_tx_interval, 0,
118 "NCM transmit interval in ms");
121 static const struct usb_config cdce_config[CDCE_N_TRANSFER] = {
125 .endpoint = UE_ADDR_ANY,
126 .direction = UE_DIR_RX,
128 .frames = CDCE_FRAMES_MAX,
129 .bufsize = (CDCE_FRAMES_MAX * MCLBYTES),
130 .flags = {.pipe_bof = 1,.short_frames_ok = 1,.short_xfer_ok = 1,.ext_buffer = 1,},
131 .callback = cdce_bulk_read_callback,
132 .timeout = 0, /* no timeout */
133 .usb_mode = USB_MODE_DUAL, /* both modes */
138 .endpoint = UE_ADDR_ANY,
139 .direction = UE_DIR_TX,
141 .frames = CDCE_FRAMES_MAX,
142 .bufsize = (CDCE_FRAMES_MAX * MCLBYTES),
143 .flags = {.pipe_bof = 1,.force_short_xfer = 1,.ext_buffer = 1,},
144 .callback = cdce_bulk_write_callback,
145 .timeout = 10000, /* 10 seconds */
146 .usb_mode = USB_MODE_DUAL, /* both modes */
150 .type = UE_INTERRUPT,
151 .endpoint = UE_ADDR_ANY,
152 .direction = UE_DIR_RX,
154 .bufsize = CDCE_IND_SIZE_MAX,
155 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,.no_pipe_ok = 1,},
156 .callback = cdce_intr_read_callback,
158 .usb_mode = USB_MODE_HOST,
162 .type = UE_INTERRUPT,
163 .endpoint = UE_ADDR_ANY,
164 .direction = UE_DIR_TX,
166 .bufsize = CDCE_IND_SIZE_MAX,
167 .flags = {.pipe_bof = 1,.force_short_xfer = 1,.no_pipe_ok = 1,},
168 .callback = cdce_intr_write_callback,
169 .timeout = 10000, /* 10 seconds */
170 .usb_mode = USB_MODE_DEVICE,
175 static const struct usb_config cdce_ncm_config[CDCE_N_TRANSFER] = {
179 .endpoint = UE_ADDR_ANY,
180 .direction = UE_DIR_RX,
182 .frames = CDCE_NCM_RX_FRAMES_MAX,
183 .bufsize = (CDCE_NCM_RX_FRAMES_MAX * CDCE_NCM_RX_MAXLEN),
184 .flags = {.pipe_bof = 1,.short_frames_ok = 1,.short_xfer_ok = 1,},
185 .callback = cdce_ncm_bulk_read_callback,
186 .timeout = 0, /* no timeout */
187 .usb_mode = USB_MODE_DUAL, /* both modes */
192 .endpoint = UE_ADDR_ANY,
193 .direction = UE_DIR_TX,
195 .frames = CDCE_NCM_TX_FRAMES_MAX,
196 .bufsize = (CDCE_NCM_TX_FRAMES_MAX * CDCE_NCM_TX_MAXLEN),
197 .flags = {.pipe_bof = 1,},
198 .callback = cdce_ncm_bulk_write_callback,
199 .timeout = 10000, /* 10 seconds */
200 .usb_mode = USB_MODE_DUAL, /* both modes */
204 .type = UE_INTERRUPT,
205 .endpoint = UE_ADDR_ANY,
206 .direction = UE_DIR_RX,
208 .bufsize = CDCE_IND_SIZE_MAX,
209 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,.no_pipe_ok = 1,},
210 .callback = cdce_intr_read_callback,
212 .usb_mode = USB_MODE_HOST,
216 .type = UE_INTERRUPT,
217 .endpoint = UE_ADDR_ANY,
218 .direction = UE_DIR_TX,
220 .bufsize = CDCE_IND_SIZE_MAX,
221 .flags = {.pipe_bof = 1,.force_short_xfer = 1,.no_pipe_ok = 1,},
222 .callback = cdce_intr_write_callback,
223 .timeout = 10000, /* 10 seconds */
224 .usb_mode = USB_MODE_DEVICE,
229 static device_method_t cdce_methods[] = {
231 DEVMETHOD(usb_handle_request, cdce_handle_request),
233 /* Device interface */
234 DEVMETHOD(device_probe, cdce_probe),
235 DEVMETHOD(device_attach, cdce_attach),
236 DEVMETHOD(device_detach, cdce_detach),
237 DEVMETHOD(device_suspend, cdce_suspend),
238 DEVMETHOD(device_resume, cdce_resume),
243 static driver_t cdce_driver = {
245 .methods = cdce_methods,
246 .size = sizeof(struct cdce_softc),
249 static devclass_t cdce_devclass;
251 DRIVER_MODULE(cdce, uhub, cdce_driver, cdce_devclass, NULL, 0);
252 MODULE_VERSION(cdce, 1);
253 MODULE_DEPEND(cdce, uether, 1, 1, 1);
254 MODULE_DEPEND(cdce, usb, 1, 1, 1);
255 MODULE_DEPEND(cdce, ether, 1, 1, 1);
257 static const struct usb_ether_methods cdce_ue_methods = {
258 .ue_attach_post = cdce_attach_post,
259 .ue_start = cdce_start,
260 .ue_init = cdce_init,
261 .ue_stop = cdce_stop,
262 .ue_setmulti = cdce_setmulti,
263 .ue_setpromisc = cdce_setpromisc,
266 static const STRUCT_USB_HOST_ID cdce_host_devs[] = {
267 {USB_VPI(USB_VENDOR_ACERLABS, USB_PRODUCT_ACERLABS_M5632, CDCE_FLAG_NO_UNION)},
268 {USB_VPI(USB_VENDOR_AMBIT, USB_PRODUCT_AMBIT_NTL_250, CDCE_FLAG_NO_UNION)},
269 {USB_VPI(USB_VENDOR_COMPAQ, USB_PRODUCT_COMPAQ_IPAQLINUX, CDCE_FLAG_NO_UNION)},
270 {USB_VPI(USB_VENDOR_GMATE, USB_PRODUCT_GMATE_YP3X00, CDCE_FLAG_NO_UNION)},
271 {USB_VPI(USB_VENDOR_MOTOROLA2, USB_PRODUCT_MOTOROLA2_USBLAN, CDCE_FLAG_ZAURUS | CDCE_FLAG_NO_UNION)},
272 {USB_VPI(USB_VENDOR_MOTOROLA2, USB_PRODUCT_MOTOROLA2_USBLAN2, CDCE_FLAG_ZAURUS | CDCE_FLAG_NO_UNION)},
273 {USB_VPI(USB_VENDOR_NETCHIP, USB_PRODUCT_NETCHIP_ETHERNETGADGET, CDCE_FLAG_NO_UNION)},
274 {USB_VPI(USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2501, CDCE_FLAG_NO_UNION)},
275 {USB_VPI(USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SL5500, CDCE_FLAG_ZAURUS)},
276 {USB_VPI(USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SL5600, CDCE_FLAG_ZAURUS | CDCE_FLAG_NO_UNION)},
277 {USB_VPI(USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SLA300, CDCE_FLAG_ZAURUS | CDCE_FLAG_NO_UNION)},
278 {USB_VPI(USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SLC700, CDCE_FLAG_ZAURUS | CDCE_FLAG_NO_UNION)},
279 {USB_VPI(USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SLC750, CDCE_FLAG_ZAURUS | CDCE_FLAG_NO_UNION)},
282 static const STRUCT_USB_DUAL_ID cdce_dual_devs[] = {
283 {USB_IF_CSI(UICLASS_CDC, UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL, 0)},
284 {USB_IF_CSI(UICLASS_CDC, UISUBCLASS_MOBILE_DIRECT_LINE_MODEL, 0)},
285 {USB_IF_CSI(UICLASS_CDC, UISUBCLASS_NETWORK_CONTROL_MODEL, 0)},
289 /*------------------------------------------------------------------------*
295 *------------------------------------------------------------------------*/
297 cdce_ncm_init(struct cdce_softc *sc)
299 struct usb_ncm_parameters temp;
300 struct usb_device_request req;
301 struct usb_ncm_func_descriptor *ufd;
305 ufd = usbd_find_descriptor(sc->sc_ue.ue_udev, NULL,
306 sc->sc_ifaces_index[1], UDESC_CS_INTERFACE, 0xFF,
307 UCDC_NCM_FUNC_DESC_SUBTYPE, 0xFF);
309 /* verify length of NCM functional descriptor */
311 if (ufd->bLength < sizeof(*ufd))
314 DPRINTFN(1, "Found NCM functional descriptor.\n");
317 req.bmRequestType = UT_READ_CLASS_INTERFACE;
318 req.bRequest = UCDC_NCM_GET_NTB_PARAMETERS;
319 USETW(req.wValue, 0);
320 req.wIndex[0] = sc->sc_ifaces_index[1];
322 USETW(req.wLength, sizeof(temp));
324 err = usbd_do_request_flags(sc->sc_ue.ue_udev, NULL, &req,
325 &temp, 0, NULL, 1000 /* ms */);
329 /* Read correct set of parameters according to device mode */
331 if (usbd_get_mode(sc->sc_ue.ue_udev) == USB_MODE_HOST) {
332 sc->sc_ncm.rx_max = UGETDW(temp.dwNtbInMaxSize);
333 sc->sc_ncm.tx_max = UGETDW(temp.dwNtbOutMaxSize);
334 sc->sc_ncm.tx_remainder = UGETW(temp.wNdpOutPayloadRemainder);
335 sc->sc_ncm.tx_modulus = UGETW(temp.wNdpOutDivisor);
336 sc->sc_ncm.tx_struct_align = UGETW(temp.wNdpOutAlignment);
337 sc->sc_ncm.tx_nframe = UGETW(temp.wNtbOutMaxDatagrams);
339 sc->sc_ncm.rx_max = UGETDW(temp.dwNtbOutMaxSize);
340 sc->sc_ncm.tx_max = UGETDW(temp.dwNtbInMaxSize);
341 sc->sc_ncm.tx_remainder = UGETW(temp.wNdpInPayloadRemainder);
342 sc->sc_ncm.tx_modulus = UGETW(temp.wNdpInDivisor);
343 sc->sc_ncm.tx_struct_align = UGETW(temp.wNdpInAlignment);
344 sc->sc_ncm.tx_nframe = UGETW(temp.wNtbOutMaxDatagrams);
347 /* Verify maximum receive length */
349 if ((sc->sc_ncm.rx_max < 32) ||
350 (sc->sc_ncm.rx_max > CDCE_NCM_RX_MAXLEN)) {
351 DPRINTFN(1, "Using default maximum receive length\n");
352 sc->sc_ncm.rx_max = CDCE_NCM_RX_MAXLEN;
355 /* Verify maximum transmit length */
357 if ((sc->sc_ncm.tx_max < 32) ||
358 (sc->sc_ncm.tx_max > CDCE_NCM_TX_MAXLEN)) {
359 DPRINTFN(1, "Using default maximum transmit length\n");
360 sc->sc_ncm.tx_max = CDCE_NCM_TX_MAXLEN;
364 * Verify that the structure alignment is:
366 * - not greater than the maximum transmit length
367 * - not less than four bytes
369 if ((sc->sc_ncm.tx_struct_align < 4) ||
370 (sc->sc_ncm.tx_struct_align !=
371 ((-sc->sc_ncm.tx_struct_align) & sc->sc_ncm.tx_struct_align)) ||
372 (sc->sc_ncm.tx_struct_align >= sc->sc_ncm.tx_max)) {
373 DPRINTFN(1, "Using default other alignment: 4 bytes\n");
374 sc->sc_ncm.tx_struct_align = 4;
378 * Verify that the payload alignment is:
380 * - not greater than the maximum transmit length
381 * - not less than four bytes
383 if ((sc->sc_ncm.tx_modulus < 4) ||
384 (sc->sc_ncm.tx_modulus !=
385 ((-sc->sc_ncm.tx_modulus) & sc->sc_ncm.tx_modulus)) ||
386 (sc->sc_ncm.tx_modulus >= sc->sc_ncm.tx_max)) {
387 DPRINTFN(1, "Using default transmit modulus: 4 bytes\n");
388 sc->sc_ncm.tx_modulus = 4;
391 /* Verify that the payload remainder */
393 if ((sc->sc_ncm.tx_remainder >= sc->sc_ncm.tx_modulus)) {
394 DPRINTFN(1, "Using default transmit remainder: 0 bytes\n");
395 sc->sc_ncm.tx_remainder = 0;
399 * Offset the TX remainder so that IP packet payload starts at
400 * the tx_modulus. This is not too clear in the specification.
403 sc->sc_ncm.tx_remainder =
404 (sc->sc_ncm.tx_remainder - ETHER_HDR_LEN) &
405 (sc->sc_ncm.tx_modulus - 1);
407 /* Verify max datagrams */
409 if (sc->sc_ncm.tx_nframe == 0 ||
410 sc->sc_ncm.tx_nframe > (CDCE_NCM_SUBFRAMES_MAX - 1)) {
411 DPRINTFN(1, "Using default max "
412 "subframes: %u units\n", CDCE_NCM_SUBFRAMES_MAX - 1);
413 /* need to reserve one entry for zero padding */
414 sc->sc_ncm.tx_nframe = (CDCE_NCM_SUBFRAMES_MAX - 1);
417 /* Additional configuration, will fail in device side mode, which is OK. */
419 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
420 req.bRequest = UCDC_NCM_SET_NTB_INPUT_SIZE;
421 USETW(req.wValue, 0);
422 req.wIndex[0] = sc->sc_ifaces_index[1];
426 (ufd->bmNetworkCapabilities & UCDC_NCM_CAP_MAX_DGRAM)) {
427 USETW(req.wLength, 8);
428 USETDW(value, sc->sc_ncm.rx_max);
429 USETW(value + 4, (CDCE_NCM_SUBFRAMES_MAX - 1));
432 USETW(req.wLength, 4);
433 USETDW(value, sc->sc_ncm.rx_max);
436 err = usbd_do_request_flags(sc->sc_ue.ue_udev, NULL, &req,
437 &value, 0, NULL, 1000 /* ms */);
439 DPRINTFN(1, "Setting input size "
440 "to %u failed.\n", sc->sc_ncm.rx_max);
443 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
444 req.bRequest = UCDC_NCM_SET_CRC_MODE;
445 USETW(req.wValue, 0); /* no CRC */
446 req.wIndex[0] = sc->sc_ifaces_index[1];
448 USETW(req.wLength, 0);
450 err = usbd_do_request_flags(sc->sc_ue.ue_udev, NULL, &req,
451 NULL, 0, NULL, 1000 /* ms */);
453 DPRINTFN(1, "Setting CRC mode to off failed.\n");
456 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
457 req.bRequest = UCDC_NCM_SET_NTB_FORMAT;
458 USETW(req.wValue, 0); /* NTB-16 */
459 req.wIndex[0] = sc->sc_ifaces_index[1];
461 USETW(req.wLength, 0);
463 err = usbd_do_request_flags(sc->sc_ue.ue_udev, NULL, &req,
464 NULL, 0, NULL, 1000 /* ms */);
466 DPRINTFN(1, "Setting NTB format to 16-bit failed.\n");
469 return (0); /* success */
474 cdce_probe(device_t dev)
476 struct usb_attach_arg *uaa = device_get_ivars(dev);
479 error = usbd_lookup_id_by_uaa(cdce_host_devs, sizeof(cdce_host_devs), uaa);
481 error = usbd_lookup_id_by_uaa(cdce_dual_devs, sizeof(cdce_dual_devs), uaa);
486 cdce_attach_post(struct usb_ether *ue)
493 cdce_attach(device_t dev)
495 struct cdce_softc *sc = device_get_softc(dev);
496 struct usb_ether *ue = &sc->sc_ue;
497 struct usb_attach_arg *uaa = device_get_ivars(dev);
498 struct usb_interface *iface;
499 const struct usb_cdc_union_descriptor *ud;
500 const struct usb_interface_descriptor *id;
501 const struct usb_cdc_ethernet_descriptor *ued;
502 const struct usb_config *pcfg;
506 uint8_t data_iface_no;
507 char eaddr_str[5 * ETHER_ADDR_LEN]; /* approx */
509 sc->sc_flags = USB_GET_DRIVER_INFO(uaa);
510 sc->sc_ue.ue_udev = uaa->device;
512 device_set_usb_desc(dev);
514 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
516 ud = usbd_find_descriptor
517 (uaa->device, NULL, uaa->info.bIfaceIndex,
518 UDESC_CS_INTERFACE, 0xFF, UDESCSUB_CDC_UNION, 0xFF);
520 if ((ud == NULL) || (ud->bLength < sizeof(*ud)) ||
521 (sc->sc_flags & CDCE_FLAG_NO_UNION)) {
522 DPRINTFN(1, "No union descriptor!\n");
523 sc->sc_ifaces_index[0] = uaa->info.bIfaceIndex;
524 sc->sc_ifaces_index[1] = uaa->info.bIfaceIndex;
525 goto alloc_transfers;
527 data_iface_no = ud->bSlaveInterface[0];
531 iface = usbd_get_iface(uaa->device, i);
535 id = usbd_get_interface_descriptor(iface);
537 if (id && (id->bInterfaceNumber == data_iface_no)) {
538 sc->sc_ifaces_index[0] = i;
539 sc->sc_ifaces_index[1] = uaa->info.bIfaceIndex;
540 usbd_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex);
544 device_printf(dev, "no data interface found\n");
552 * The Data Class interface of a networking device shall have
553 * a minimum of two interface settings. The first setting
554 * (the default interface setting) includes no endpoints and
555 * therefore no networking traffic is exchanged whenever the
556 * default interface setting is selected. One or more
557 * additional interface settings are used for normal
558 * operation, and therefore each includes a pair of endpoints
559 * (one IN, and one OUT) to exchange network traffic. Select
560 * an alternate interface setting to initialize the network
561 * aspects of the device and to enable the exchange of
566 * Some devices, most notably cable modems, include interface
567 * settings that have no IN or OUT endpoint, therefore loop
568 * through the list of all available interface settings
569 * looking for one with both IN and OUT endpoints.
574 pcfg = cdce_config; /* Default Configuration */
576 for (i = 0; i != 32; i++) {
578 error = usbd_set_alt_interface_index(uaa->device,
579 sc->sc_ifaces_index[0], i);
583 if ((i == 0) && (cdce_ncm_init(sc) == 0))
584 pcfg = cdce_ncm_config;
586 error = usbd_transfer_setup(uaa->device,
587 sc->sc_ifaces_index, sc->sc_xfer,
588 pcfg, CDCE_N_TRANSFER, sc, &sc->sc_mtx);
594 if (error || (i == 32)) {
595 device_printf(dev, "No valid alternate "
600 ued = usbd_find_descriptor
601 (uaa->device, NULL, uaa->info.bIfaceIndex,
602 UDESC_CS_INTERFACE, 0xFF, UDESCSUB_CDC_ENF, 0xFF);
604 if ((ued == NULL) || (ued->bLength < sizeof(*ued))) {
605 error = USB_ERR_INVAL;
607 error = usbd_req_get_string_any(uaa->device, NULL,
608 eaddr_str, sizeof(eaddr_str), ued->iMacAddress);
613 /* fake MAC address */
615 device_printf(dev, "faking MAC address\n");
617 sc->sc_ue.ue_eaddr[0] = 0x2a;
618 memcpy(&sc->sc_ue.ue_eaddr[1], &seed, sizeof(uint32_t));
619 sc->sc_ue.ue_eaddr[5] = device_get_unit(dev);
623 memset(sc->sc_ue.ue_eaddr, 0, sizeof(sc->sc_ue.ue_eaddr));
625 for (i = 0; i != (ETHER_ADDR_LEN * 2); i++) {
627 char c = eaddr_str[i];
629 if ('0' <= c && c <= '9')
640 sc->sc_ue.ue_eaddr[i / 2] |= c;
643 if (uaa->usb_mode == USB_MODE_DEVICE) {
645 * Do not use the same MAC address like the peer !
647 sc->sc_ue.ue_eaddr[5] ^= 0xFF;
653 ue->ue_udev = uaa->device;
654 ue->ue_mtx = &sc->sc_mtx;
655 ue->ue_methods = &cdce_ue_methods;
657 error = uether_ifattach(ue);
659 device_printf(dev, "could not attach interface\n");
662 return (0); /* success */
666 return (ENXIO); /* failure */
670 cdce_detach(device_t dev)
672 struct cdce_softc *sc = device_get_softc(dev);
673 struct usb_ether *ue = &sc->sc_ue;
675 /* stop all USB transfers first */
676 usbd_transfer_unsetup(sc->sc_xfer, CDCE_N_TRANSFER);
678 mtx_destroy(&sc->sc_mtx);
684 cdce_start(struct usb_ether *ue)
686 struct cdce_softc *sc = uether_getsc(ue);
689 * Start the USB transfers, if not already started:
691 usbd_transfer_start(sc->sc_xfer[CDCE_BULK_TX]);
692 usbd_transfer_start(sc->sc_xfer[CDCE_BULK_RX]);
696 cdce_free_queue(struct mbuf **ppm, uint8_t n)
699 for (x = 0; x != n; x++) {
700 if (ppm[x] != NULL) {
708 cdce_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
710 struct cdce_softc *sc = usbd_xfer_softc(xfer);
711 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
718 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
722 switch (USB_GET_STATE(xfer)) {
723 case USB_ST_TRANSFERRED:
724 DPRINTFN(11, "transfer complete: %u bytes in %u frames\n",
729 /* free all previous TX buffers */
730 cdce_free_queue(sc->sc_tx_buf, CDCE_FRAMES_MAX);
735 for (x = 0; x != CDCE_FRAMES_MAX; x++) {
737 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
742 if (sc->sc_flags & CDCE_FLAG_ZAURUS) {
744 * Zaurus wants a 32-bit CRC appended
748 crc = cdce_m_crc32(m, 0, m->m_pkthdr.len);
751 if (!m_append(m, 4, (void *)&crc)) {
757 if (m->m_len != m->m_pkthdr.len) {
758 mt = m_defrag(m, M_NOWAIT);
766 if (m->m_pkthdr.len > MCLBYTES) {
767 m->m_pkthdr.len = MCLBYTES;
769 sc->sc_tx_buf[x] = m;
770 usbd_xfer_set_frame_data(xfer, x, m->m_data, m->m_len);
773 * If there's a BPF listener, bounce a copy of
779 usbd_xfer_set_frames(xfer, x);
781 usbd_transfer_submit(xfer);
786 DPRINTFN(11, "transfer error, %s\n",
789 /* free all previous TX buffers */
790 cdce_free_queue(sc->sc_tx_buf, CDCE_FRAMES_MAX);
792 /* count output errors */
795 if (error != USB_ERR_CANCELLED) {
796 /* try to clear stall first */
797 usbd_xfer_set_stall(xfer);
805 cdce_m_crc32_cb(void *arg, void *src, uint32_t count)
807 uint32_t *p_crc = arg;
809 *p_crc = crc32_raw(src, count, *p_crc);
814 cdce_m_crc32(struct mbuf *m, uint32_t src_offset, uint32_t src_len)
816 uint32_t crc = 0xFFFFFFFF;
819 error = m_apply(m, src_offset, src_len, cdce_m_crc32_cb, &crc);
820 return (crc ^ 0xFFFFFFFF);
824 cdce_init(struct usb_ether *ue)
826 struct cdce_softc *sc = uether_getsc(ue);
827 struct ifnet *ifp = uether_getifp(ue);
829 CDCE_LOCK_ASSERT(sc, MA_OWNED);
831 ifp->if_drv_flags |= IFF_DRV_RUNNING;
833 /* start interrupt transfer */
834 usbd_transfer_start(sc->sc_xfer[CDCE_INTR_RX]);
835 usbd_transfer_start(sc->sc_xfer[CDCE_INTR_TX]);
837 /* stall data write direction, which depends on USB mode */
838 usbd_xfer_set_stall(sc->sc_xfer[CDCE_BULK_TX]);
840 /* start data transfers */
845 cdce_stop(struct usb_ether *ue)
847 struct cdce_softc *sc = uether_getsc(ue);
848 struct ifnet *ifp = uether_getifp(ue);
850 CDCE_LOCK_ASSERT(sc, MA_OWNED);
852 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
855 * stop all the transfers, if not already stopped:
857 usbd_transfer_stop(sc->sc_xfer[CDCE_BULK_RX]);
858 usbd_transfer_stop(sc->sc_xfer[CDCE_BULK_TX]);
859 usbd_transfer_stop(sc->sc_xfer[CDCE_INTR_RX]);
860 usbd_transfer_stop(sc->sc_xfer[CDCE_INTR_TX]);
864 cdce_setmulti(struct usb_ether *ue)
871 cdce_setpromisc(struct usb_ether *ue)
878 cdce_suspend(device_t dev)
880 device_printf(dev, "Suspending\n");
885 cdce_resume(device_t dev)
887 device_printf(dev, "Resuming\n");
892 cdce_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
894 struct cdce_softc *sc = usbd_xfer_softc(xfer);
901 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
903 switch (USB_GET_STATE(xfer)) {
904 case USB_ST_TRANSFERRED:
906 DPRINTF("received %u bytes in %u frames\n", actlen, aframes);
908 for (x = 0; x != aframes; x++) {
910 m = sc->sc_rx_buf[x];
911 sc->sc_rx_buf[x] = NULL;
912 len = usbd_xfer_frame_len(xfer, x);
914 /* Strip off CRC added by Zaurus, if any */
915 if ((sc->sc_flags & CDCE_FLAG_ZAURUS) && len >= 14)
918 if (len < (int)sizeof(struct ether_header)) {
923 uether_rxmbuf(&sc->sc_ue, m, len);
929 * TODO: Implement support for multi frame transfers,
930 * when the USB hardware supports it.
932 for (x = 0; x != 1; x++) {
933 if (sc->sc_rx_buf[x] == NULL) {
937 sc->sc_rx_buf[x] = m;
939 m = sc->sc_rx_buf[x];
942 usbd_xfer_set_frame_data(xfer, x, m->m_data, m->m_len);
944 /* set number of frames and start hardware */
945 usbd_xfer_set_frames(xfer, x);
946 usbd_transfer_submit(xfer);
947 /* flush any received frames */
948 uether_rxflush(&sc->sc_ue);
952 DPRINTF("error = %s\n",
955 if (error != USB_ERR_CANCELLED) {
957 /* try to clear stall first */
958 usbd_xfer_set_stall(xfer);
959 usbd_xfer_set_frames(xfer, 0);
960 usbd_transfer_submit(xfer);
964 /* need to free the RX-mbufs when we are cancelled */
965 cdce_free_queue(sc->sc_rx_buf, CDCE_FRAMES_MAX);
971 cdce_intr_read_callback(struct usb_xfer *xfer, usb_error_t error)
975 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
977 switch (USB_GET_STATE(xfer)) {
978 case USB_ST_TRANSFERRED:
980 DPRINTF("Received %d bytes\n", actlen);
982 /* TODO: decode some indications */
987 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
988 usbd_transfer_submit(xfer);
992 if (error != USB_ERR_CANCELLED) {
993 /* start clear stall */
994 usbd_xfer_set_stall(xfer);
1002 cdce_intr_write_callback(struct usb_xfer *xfer, usb_error_t error)
1006 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1008 switch (USB_GET_STATE(xfer)) {
1009 case USB_ST_TRANSFERRED:
1011 DPRINTF("Transferred %d bytes\n", actlen);
1017 usbd_xfer_set_frame_len(xfer, 0, XXX);
1018 usbd_transfer_submit(xfer);
1022 default: /* Error */
1023 if (error != USB_ERR_CANCELLED) {
1024 /* start clear stall */
1025 usbd_xfer_set_stall(xfer);
1033 cdce_handle_request(device_t dev,
1034 const void *req, void **pptr, uint16_t *plen,
1035 uint16_t offset, uint8_t *pstate)
1037 return (ENXIO); /* use builtin handler */
1042 cdce_ncm_tx_zero(struct usb_page_cache *pc,
1043 uint32_t start, uint32_t end)
1045 if (start >= CDCE_NCM_TX_MAXLEN)
1047 if (end > CDCE_NCM_TX_MAXLEN)
1048 end = CDCE_NCM_TX_MAXLEN;
1050 usbd_frame_zero(pc, start, end - start);
1054 cdce_ncm_fill_tx_frames(struct usb_xfer *xfer, uint8_t index)
1056 struct cdce_softc *sc = usbd_xfer_softc(xfer);
1057 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
1058 struct usb_page_cache *pc = usbd_xfer_get_frame(xfer, index);
1062 uint32_t last_offset;
1066 usbd_xfer_set_frame_offset(xfer, index * CDCE_NCM_TX_MAXLEN, index);
1068 offset = sizeof(sc->sc_ncm.hdr) +
1069 sizeof(sc->sc_ncm.dpt) + sizeof(sc->sc_ncm.dp);
1071 /* Store last valid offset before alignment */
1072 last_offset = offset;
1075 offset = CDCE_NCM_ALIGN(sc->sc_ncm.tx_remainder,
1076 offset, sc->sc_ncm.tx_modulus);
1079 cdce_ncm_tx_zero(pc, last_offset, offset);
1084 for (n = 0; n != sc->sc_ncm.tx_nframe; n++) {
1086 /* check if end of transmit buffer is reached */
1088 if (offset >= sc->sc_ncm.tx_max)
1091 /* compute maximum buffer size */
1093 rem = sc->sc_ncm.tx_max - offset;
1095 IFQ_DRV_DEQUEUE(&(ifp->if_snd), m);
1098 /* buffer not full */
1103 if (m->m_pkthdr.len > (int)rem) {
1105 /* The frame won't fit in our buffer */
1106 DPRINTFN(1, "Frame too big to be transmitted!\n");
1112 /* Wait till next buffer becomes ready */
1113 IFQ_DRV_PREPEND(&(ifp->if_snd), m);
1116 usbd_m_copy_in(pc, offset, m, 0, m->m_pkthdr.len);
1118 USETW(sc->sc_ncm.dp[n].wFrameLength, m->m_pkthdr.len);
1119 USETW(sc->sc_ncm.dp[n].wFrameIndex, offset);
1122 offset += m->m_pkthdr.len;
1124 /* Store last valid offset before alignment */
1125 last_offset = offset;
1128 offset = CDCE_NCM_ALIGN(sc->sc_ncm.tx_remainder,
1129 offset, sc->sc_ncm.tx_modulus);
1132 cdce_ncm_tx_zero(pc, last_offset, offset);
1135 * If there's a BPF listener, bounce a copy
1136 * of this frame to him:
1144 /* Pre-increment interface counter */
1152 rem = (sizeof(sc->sc_ncm.dpt) + (4 * n) + 4);
1154 USETW(sc->sc_ncm.dpt.wLength, rem);
1156 /* zero the rest of the data pointer entries */
1157 for (; n != CDCE_NCM_SUBFRAMES_MAX; n++) {
1158 USETW(sc->sc_ncm.dp[n].wFrameLength, 0);
1159 USETW(sc->sc_ncm.dp[n].wFrameIndex, 0);
1162 offset = last_offset;
1165 offset = CDCE_NCM_ALIGN(0, offset, CDCE_NCM_TX_MINLEN);
1167 /* Optimise, save bandwidth and force short termination */
1168 if (offset >= sc->sc_ncm.tx_max)
1169 offset = sc->sc_ncm.tx_max;
1174 cdce_ncm_tx_zero(pc, last_offset, offset);
1176 /* set frame length */
1177 usbd_xfer_set_frame_len(xfer, index, offset);
1179 /* Fill out 16-bit header */
1180 sc->sc_ncm.hdr.dwSignature[0] = 'N';
1181 sc->sc_ncm.hdr.dwSignature[1] = 'C';
1182 sc->sc_ncm.hdr.dwSignature[2] = 'M';
1183 sc->sc_ncm.hdr.dwSignature[3] = 'H';
1184 USETW(sc->sc_ncm.hdr.wHeaderLength, sizeof(sc->sc_ncm.hdr));
1185 USETW(sc->sc_ncm.hdr.wBlockLength, offset);
1186 USETW(sc->sc_ncm.hdr.wSequence, sc->sc_ncm.tx_seq);
1187 USETW(sc->sc_ncm.hdr.wDptIndex, sizeof(sc->sc_ncm.hdr));
1189 sc->sc_ncm.tx_seq++;
1191 /* Fill out 16-bit frame table header */
1192 sc->sc_ncm.dpt.dwSignature[0] = 'N';
1193 sc->sc_ncm.dpt.dwSignature[1] = 'C';
1194 sc->sc_ncm.dpt.dwSignature[2] = 'M';
1195 sc->sc_ncm.dpt.dwSignature[3] = '0';
1196 USETW(sc->sc_ncm.dpt.wNextNdpIndex, 0); /* reserved */
1198 usbd_copy_in(pc, 0, &(sc->sc_ncm.hdr), sizeof(sc->sc_ncm.hdr));
1199 usbd_copy_in(pc, sizeof(sc->sc_ncm.hdr), &(sc->sc_ncm.dpt),
1200 sizeof(sc->sc_ncm.dpt));
1201 usbd_copy_in(pc, sizeof(sc->sc_ncm.hdr) + sizeof(sc->sc_ncm.dpt),
1202 &(sc->sc_ncm.dp), sizeof(sc->sc_ncm.dp));
1207 cdce_ncm_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
1209 struct cdce_softc *sc = usbd_xfer_softc(xfer);
1210 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
1216 switch (USB_GET_STATE(xfer)) {
1217 case USB_ST_TRANSFERRED:
1219 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
1221 DPRINTFN(10, "transfer complete: "
1222 "%u bytes in %u frames\n", actlen, aframes);
1225 for (x = 0; x != CDCE_NCM_TX_FRAMES_MAX; x++) {
1226 temp = cdce_ncm_fill_tx_frames(xfer, x);
1237 usbd_xfer_set_interval(xfer, cdce_tx_interval);
1239 usbd_xfer_set_frames(xfer, x);
1240 usbd_transfer_submit(xfer);
1244 default: /* Error */
1245 DPRINTFN(10, "Transfer error: %s\n",
1246 usbd_errstr(error));
1248 /* update error counter */
1249 ifp->if_oerrors += 1;
1251 if (error != USB_ERR_CANCELLED) {
1252 /* try to clear stall first */
1253 usbd_xfer_set_stall(xfer);
1254 usbd_xfer_set_frames(xfer, 0);
1255 usbd_transfer_submit(xfer);
1262 cdce_ncm_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
1264 struct cdce_softc *sc = usbd_xfer_softc(xfer);
1265 struct usb_page_cache *pc = usbd_xfer_get_frame(xfer, 0);
1266 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
1277 switch (USB_GET_STATE(xfer)) {
1278 case USB_ST_TRANSFERRED:
1280 usbd_xfer_status(xfer, &actlen, &sumlen, &aframes, NULL);
1282 DPRINTFN(1, "received %u bytes in %u frames\n",
1285 if (actlen < (int)(sizeof(sc->sc_ncm.hdr) +
1286 sizeof(sc->sc_ncm.dpt))) {
1287 DPRINTFN(1, "frame too short\n");
1290 usbd_copy_out(pc, 0, &(sc->sc_ncm.hdr),
1291 sizeof(sc->sc_ncm.hdr));
1293 if ((sc->sc_ncm.hdr.dwSignature[0] != 'N') ||
1294 (sc->sc_ncm.hdr.dwSignature[1] != 'C') ||
1295 (sc->sc_ncm.hdr.dwSignature[2] != 'M') ||
1296 (sc->sc_ncm.hdr.dwSignature[3] != 'H')) {
1297 DPRINTFN(1, "invalid HDR signature: "
1298 "0x%02x:0x%02x:0x%02x:0x%02x\n",
1299 sc->sc_ncm.hdr.dwSignature[0],
1300 sc->sc_ncm.hdr.dwSignature[1],
1301 sc->sc_ncm.hdr.dwSignature[2],
1302 sc->sc_ncm.hdr.dwSignature[3]);
1305 temp = UGETW(sc->sc_ncm.hdr.wBlockLength);
1306 if (temp > sumlen) {
1307 DPRINTFN(1, "unsupported block length %u/%u\n",
1311 temp = UGETW(sc->sc_ncm.hdr.wDptIndex);
1312 if ((int)(temp + sizeof(sc->sc_ncm.dpt)) > actlen) {
1313 DPRINTFN(1, "invalid DPT index: 0x%04x\n", temp);
1316 usbd_copy_out(pc, temp, &(sc->sc_ncm.dpt),
1317 sizeof(sc->sc_ncm.dpt));
1319 if ((sc->sc_ncm.dpt.dwSignature[0] != 'N') ||
1320 (sc->sc_ncm.dpt.dwSignature[1] != 'C') ||
1321 (sc->sc_ncm.dpt.dwSignature[2] != 'M') ||
1322 (sc->sc_ncm.dpt.dwSignature[3] != '0')) {
1323 DPRINTFN(1, "invalid DPT signature"
1324 "0x%02x:0x%02x:0x%02x:0x%02x\n",
1325 sc->sc_ncm.dpt.dwSignature[0],
1326 sc->sc_ncm.dpt.dwSignature[1],
1327 sc->sc_ncm.dpt.dwSignature[2],
1328 sc->sc_ncm.dpt.dwSignature[3]);
1331 nframes = UGETW(sc->sc_ncm.dpt.wLength) / 4;
1333 /* Subtract size of header and last zero padded entry */
1334 if (nframes >= (2 + 1))
1339 DPRINTFN(1, "nframes = %u\n", nframes);
1341 temp += sizeof(sc->sc_ncm.dpt);
1343 if ((temp + (4 * nframes)) > actlen)
1346 if (nframes > CDCE_NCM_SUBFRAMES_MAX) {
1347 DPRINTFN(1, "Truncating number of frames from %u to %u\n",
1348 nframes, CDCE_NCM_SUBFRAMES_MAX);
1349 nframes = CDCE_NCM_SUBFRAMES_MAX;
1351 usbd_copy_out(pc, temp, &(sc->sc_ncm.dp), (4 * nframes));
1355 for (x = 0; x != nframes; x++) {
1357 offset = UGETW(sc->sc_ncm.dp[x].wFrameIndex);
1358 temp = UGETW(sc->sc_ncm.dp[x].wFrameLength);
1360 if ((offset == 0) ||
1361 (temp < (int)sizeof(struct ether_header)) ||
1362 (temp > (MCLBYTES - ETHER_ALIGN))) {
1363 DPRINTFN(1, "NULL frame detected at %d\n", x);
1365 /* silently ignore this frame */
1367 } else if ((offset + temp) > actlen) {
1368 DPRINTFN(1, "invalid frame "
1369 "detected at %d\n", x);
1371 /* silently ignore this frame */
1373 } else if (temp > (int)(MHLEN - ETHER_ALIGN)) {
1374 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
1376 m = m_gethdr(M_NOWAIT, MT_DATA);
1379 DPRINTFN(16, "frame %u, offset = %u, length = %u \n",
1382 /* check if we have a buffer */
1384 m_adj(m, ETHER_ALIGN);
1386 usbd_copy_out(pc, offset, m->m_data, temp);
1389 uether_rxmbuf(&sc->sc_ue, m, temp);
1397 DPRINTFN(1, "Efficiency: %u/%u bytes\n", sumdata, actlen);
1401 usbd_xfer_set_frame_len(xfer, 0, sc->sc_ncm.rx_max);
1402 usbd_xfer_set_frames(xfer, 1);
1403 usbd_transfer_submit(xfer);
1404 uether_rxflush(&sc->sc_ue); /* must be last */
1407 default: /* Error */
1408 DPRINTFN(1, "error = %s\n",
1409 usbd_errstr(error));
1411 if (error != USB_ERR_CANCELLED) {
1413 /* try to clear stall first */
1414 usbd_xfer_set_stall(xfer);
1415 usbd_xfer_set_frames(xfer, 0);
1416 usbd_transfer_submit(xfer);