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
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed by Bill Paul.
20 * 4. Neither the name of the author nor the names of any co-contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul, THE VOICES IN HIS HEAD OR
28 * THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
30 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
31 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
32 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
33 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
34 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 * USB Communication Device Class (Ethernet Networking Control Model)
39 * http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
42 #include <sys/cdefs.h>
43 __FBSDID("$FreeBSD$");
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/sockio.h>
49 #include <sys/malloc.h>
50 #include <sys/kernel.h>
51 #include <sys/module.h>
52 #include <sys/socket.h>
53 #include <sys/endian.h>
56 #include <net/if_arp.h>
57 #include <net/ethernet.h>
58 #include <net/if_types.h>
59 #include <net/if_media.h>
64 #include <machine/bus.h>
66 #include <dev/usb/usb.h>
67 #include <dev/usb/usbdi.h>
68 #include <dev/usb/usbdi_util.h>
69 #include <dev/usb/usbdivar.h>
70 #include <dev/usb/usb_ethersubr.h>
72 #include <dev/usb/usbcdc.h>
74 #include <dev/usb/if_cdcereg.h>
76 static device_probe_t cdce_match;
77 static device_attach_t cdce_attach;
78 static device_detach_t cdce_detach;
79 static device_shutdown_t cdce_shutdown;
81 static device_method_t cdce_methods[] = {
82 /* Device interface */
83 DEVMETHOD(device_probe, cdce_match),
84 DEVMETHOD(device_attach, cdce_attach),
85 DEVMETHOD(device_detach, cdce_detach),
86 DEVMETHOD(device_shutdown, cdce_shutdown),
91 static driver_t cdce_driver = {
94 sizeof(struct cdce_softc)
97 static devclass_t cdce_devclass;
99 DRIVER_MODULE(cdce, uhub, cdce_driver, cdce_devclass, usbd_driver_load, 0);
100 MODULE_VERSION(cdce, 0);
101 MODULE_DEPEND(cdce, usb, 1, 1, 1);
103 static int cdce_encap(struct cdce_softc *, struct mbuf *, int);
104 static void cdce_rxeof(usbd_xfer_handle, usbd_private_handle, usbd_status);
105 static void cdce_txeof(usbd_xfer_handle, usbd_private_handle, usbd_status);
106 static void cdce_start(struct ifnet *);
107 static int cdce_ioctl(struct ifnet *, u_long, caddr_t);
108 static void cdce_init(void *);
109 static void cdce_reset(struct cdce_softc *);
110 static void cdce_stop(struct cdce_softc *);
111 static void cdce_rxstart(struct ifnet *);
112 static int cdce_ifmedia_upd(struct ifnet *ifp);
113 static void cdce_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr);
115 static const struct cdce_type cdce_devs[] = {
116 {{ USB_VENDOR_ACERLABS, USB_PRODUCT_ACERLABS_M5632 }, CDCE_NO_UNION },
117 {{ USB_VENDOR_AMBIT, USB_PRODUCT_AMBIT_NTL_250 }, CDCE_NO_UNION },
118 {{ USB_VENDOR_COMPAQ, USB_PRODUCT_COMPAQ_IPAQLINUX }, CDCE_NO_UNION },
119 {{ USB_VENDOR_GMATE, USB_PRODUCT_GMATE_YP3X00 }, CDCE_NO_UNION },
120 {{ USB_VENDOR_MOTOROLA2, USB_PRODUCT_MOTOROLA2_USBLAN }, CDCE_ZAURUS | CDCE_NO_UNION },
121 {{ USB_VENDOR_MOTOROLA2, USB_PRODUCT_MOTOROLA2_USBLAN2 }, CDCE_ZAURUS | CDCE_NO_UNION },
122 {{ USB_VENDOR_NETCHIP, USB_PRODUCT_NETCHIP_ETHERNETGADGET }, CDCE_NO_UNION },
123 {{ USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2501 }, CDCE_NO_UNION },
124 {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SL5500 }, CDCE_ZAURUS },
125 {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SL5600 }, CDCE_ZAURUS | CDCE_NO_UNION },
126 {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SLA300 }, CDCE_ZAURUS | CDCE_NO_UNION },
127 {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SLC700 }, CDCE_ZAURUS | CDCE_NO_UNION },
128 {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SLC750 }, CDCE_ZAURUS | CDCE_NO_UNION },
130 #define cdce_lookup(v, p) ((const struct cdce_type *)usb_lookup(cdce_devs, v, p))
133 cdce_match(device_t self)
135 struct usb_attach_arg *uaa = device_get_ivars(self);
136 usb_interface_descriptor_t *id;
138 if (uaa->iface == NULL)
139 return (UMATCH_NONE);
141 id = usbd_get_interface_descriptor(uaa->iface);
143 return (UMATCH_NONE);
145 if (cdce_lookup(uaa->vendor, uaa->product) != NULL)
146 return (UMATCH_VENDOR_PRODUCT);
148 if (id->bInterfaceClass == UICLASS_CDC && id->bInterfaceSubClass ==
149 UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL)
150 return (UMATCH_IFACECLASS_GENERIC);
152 return (UMATCH_NONE);
156 cdce_attach(device_t self)
158 struct cdce_softc *sc = device_get_softc(self);
159 struct usb_attach_arg *uaa = device_get_ivars(self);
161 usbd_device_handle dev = uaa->device;
162 const struct cdce_type *t;
163 usb_interface_descriptor_t *id;
164 usb_endpoint_descriptor_t *ed;
165 const usb_cdc_union_descriptor_t *ud;
166 usb_config_descriptor_t *cd;
169 u_char eaddr[ETHER_ADDR_LEN];
170 const usb_cdc_ethernet_descriptor_t *ue;
171 char eaddr_str[USB_MAX_STRING_LEN];
174 sc->cdce_udev = uaa->device;
176 t = cdce_lookup(uaa->vendor, uaa->product);
178 sc->cdce_flags = t->cdce_flags;
180 if (sc->cdce_flags & CDCE_NO_UNION)
181 sc->cdce_data_iface = uaa->iface;
183 ud = (const usb_cdc_union_descriptor_t *)usb_find_desc(sc->cdce_udev,
184 UDESC_CS_INTERFACE, UDESCSUB_CDC_UNION);
186 device_printf(sc->cdce_dev, "no union descriptor\n");
189 data_ifcno = ud->bSlaveInterface[0];
191 for (i = 0; i < uaa->nifaces; i++) {
192 if (uaa->ifaces[i] != NULL) {
193 id = usbd_get_interface_descriptor(
195 if (id != NULL && id->bInterfaceNumber ==
197 sc->cdce_data_iface = uaa->ifaces[i];
198 uaa->ifaces[i] = NULL;
204 if (sc->cdce_data_iface == NULL) {
205 device_printf(sc->cdce_dev, "no data interface\n");
211 * The Data Class interface of a networking device shall have a minimum
212 * of two interface settings. The first setting (the default interface
213 * setting) includes no endpoints and therefore no networking traffic is
214 * exchanged whenever the default interface setting is selected. One or
215 * more additional interface settings are used for normal operation, and
216 * therefore each includes a pair of endpoints (one IN, and one OUT) to
217 * exchange network traffic. Select an alternate interface setting to
218 * initialize the network aspects of the device and to enable the
219 * exchange of network traffic.
222 * Some devices, most notably cable modems, include interface settings
223 * that have no IN or OUT endpoint, therefore loop through the list of all
224 * available interface settings looking for one with both IN and OUT
227 id = usbd_get_interface_descriptor(sc->cdce_data_iface);
228 cd = usbd_get_config_descriptor(sc->cdce_udev);
229 numalts = usbd_get_no_alts(cd, id->bInterfaceNumber);
231 for (j = 0; j < numalts; j++) {
232 if (usbd_set_interface(sc->cdce_data_iface, j)) {
233 device_printf(sc->cdce_dev,
234 "setting alternate interface failed\n");
237 /* Find endpoints. */
238 id = usbd_get_interface_descriptor(sc->cdce_data_iface);
239 sc->cdce_bulkin_no = sc->cdce_bulkout_no = -1;
240 for (i = 0; i < id->bNumEndpoints; i++) {
241 ed = usbd_interface2endpoint_descriptor(sc->cdce_data_iface, i);
243 device_printf(sc->cdce_dev,
244 "could not read endpoint descriptor\n");
247 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
248 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
249 sc->cdce_bulkin_no = ed->bEndpointAddress;
250 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
251 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
252 sc->cdce_bulkout_no = ed->bEndpointAddress;
253 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
254 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
255 /* XXX: CDC spec defines an interrupt pipe, but it is not
256 * needed for simple host-to-host applications. */
258 device_printf(sc->cdce_dev,
259 "unexpected endpoint\n");
262 /* If we found something, try and use it... */
263 if ((sc->cdce_bulkin_no != -1) && (sc->cdce_bulkout_no != -1))
267 if (sc->cdce_bulkin_no == -1) {
268 device_printf(sc->cdce_dev, "could not find data bulk in\n");
271 if (sc->cdce_bulkout_no == -1 ) {
272 device_printf(sc->cdce_dev, "could not find data bulk out\n");
276 mtx_init(&sc->cdce_mtx, device_get_nameunit(sc->cdce_dev), MTX_NETWORK_LOCK,
277 MTX_DEF | MTX_RECURSE);
278 ifmedia_init(&sc->cdce_ifmedia, 0, cdce_ifmedia_upd, cdce_ifmedia_sts);
281 ue = (const usb_cdc_ethernet_descriptor_t *)usb_find_desc(dev,
282 UDESC_INTERFACE, UDESCSUB_CDC_ENF);
283 if (!ue || usbd_get_string(dev, ue->iMacAddress, eaddr_str,
284 sizeof(eaddr_str))) {
285 /* Fake MAC address */
286 device_printf(sc->cdce_dev, "faking MAC address\n");
288 memcpy(&eaddr[1], &ticks, sizeof(u_int32_t));
289 eaddr[5] = (u_int8_t)device_get_unit(sc->cdce_dev);
293 memset(eaddr, 0, ETHER_ADDR_LEN);
294 for (i = 0; i < ETHER_ADDR_LEN * 2; i++) {
295 int c = eaddr_str[i];
297 if ('0' <= c && c <= '9')
308 ifp = GET_IFP(sc) = if_alloc(IFT_ETHER);
310 device_printf(sc->cdce_dev, "can not if_alloc()\n");
312 mtx_destroy(&sc->cdce_mtx);
316 if_initname(ifp, "cdce", device_get_unit(sc->cdce_dev));
317 ifp->if_mtu = ETHERMTU;
318 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST |
320 ifp->if_ioctl = cdce_ioctl;
321 ifp->if_output = ether_output;
322 ifp->if_start = cdce_start;
323 ifp->if_init = cdce_init;
324 ifp->if_baudrate = 11000000;
325 ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
328 sc->q.if_rxstart = cdce_rxstart;
330 /* No IFM type for 11Mbps USB, so go with 10baseT */
331 ifmedia_add(&sc->cdce_ifmedia, IFM_ETHER | IFM_10_T, 0, 0);
332 ifmedia_set(&sc->cdce_ifmedia, IFM_ETHER | IFM_10_T);
334 ether_ifattach(ifp, eaddr);
335 usb_register_netisr();
339 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->cdce_udev,
346 cdce_detach(device_t self)
348 struct cdce_softc *sc = device_get_softc(self);
354 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
355 cdce_shutdown(sc->cdce_dev);
359 ifmedia_removeall(&sc->cdce_ifmedia);
361 mtx_destroy(&sc->cdce_mtx);
363 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->cdce_udev,
370 cdce_start(struct ifnet *ifp)
372 struct cdce_softc *sc;
373 struct mbuf *m_head = NULL;
379 if (sc->cdce_dying ||
380 ifp->if_drv_flags & IFF_DRV_OACTIVE ||
381 !(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
386 IF_DEQUEUE(&ifp->if_snd, m_head);
387 if (m_head == NULL) {
392 if (cdce_encap(sc, m_head, 0)) {
393 IF_PREPEND(&ifp->if_snd, m_head);
394 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
399 BPF_MTAP(ifp, m_head);
401 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
409 cdce_encap(struct cdce_softc *sc, struct mbuf *m, int idx)
415 c = &sc->cdce_cdata.ue_tx_chain[idx];
417 m_copydata(m, 0, m->m_pkthdr.len, c->ue_buf);
418 if (sc->cdce_flags & CDCE_ZAURUS) {
419 /* Zaurus wants a 32-bit CRC appended to every frame */
422 crc = htole32(crc32(c->ue_buf, m->m_pkthdr.len));
423 bcopy(&crc, c->ue_buf + m->m_pkthdr.len, 4);
428 usbd_setup_xfer(c->ue_xfer, sc->cdce_bulkout_pipe, c, c->ue_buf,
429 m->m_pkthdr.len + extra, 0, 10000, cdce_txeof);
430 err = usbd_transfer(c->ue_xfer);
431 if (err != USBD_IN_PROGRESS) {
436 sc->cdce_cdata.ue_tx_cnt++;
442 cdce_stop(struct cdce_softc *sc)
454 if (sc->cdce_bulkin_pipe != NULL) {
455 err = usbd_abort_pipe(sc->cdce_bulkin_pipe);
457 device_printf(sc->cdce_dev,
458 "abort rx pipe failed: %s\n", usbd_errstr(err));
459 err = usbd_close_pipe(sc->cdce_bulkin_pipe);
461 device_printf(sc->cdce_dev,
462 "close rx pipe failed: %s\n", usbd_errstr(err));
463 sc->cdce_bulkin_pipe = NULL;
466 if (sc->cdce_bulkout_pipe != NULL) {
467 err = usbd_abort_pipe(sc->cdce_bulkout_pipe);
469 device_printf(sc->cdce_dev,
470 "abort tx pipe failed: %s\n", usbd_errstr(err));
471 err = usbd_close_pipe(sc->cdce_bulkout_pipe);
473 device_printf(sc->cdce_dev,
474 "close tx pipe failed: %s\n", usbd_errstr(err));
475 sc->cdce_bulkout_pipe = NULL;
478 usb_ether_rx_list_free(&sc->cdce_cdata);
479 usb_ether_tx_list_free(&sc->cdce_cdata);
481 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
488 cdce_shutdown(device_t dev)
490 struct cdce_softc *sc;
492 sc = device_get_softc(dev);
499 cdce_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
501 struct cdce_softc *sc = ifp->if_softc;
502 struct ifreq *ifr = (struct ifreq *)data;
510 if (ifp->if_flags & IFF_UP) {
511 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING))
514 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
522 error = ifmedia_ioctl(ifp, ifr, &sc->cdce_ifmedia, command);
526 error = ether_ioctl(ifp, command, data);
534 cdce_reset(struct cdce_softc *sc)
536 /* XXX Maybe reset the bulk pipes here? */
543 struct cdce_softc *sc = xsc;
544 struct ifnet *ifp = GET_IFP(sc);
549 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
555 if (usb_ether_tx_list_init(sc, &sc->cdce_cdata,
556 sc->cdce_udev) == ENOBUFS) {
557 device_printf(sc->cdce_dev, "tx list init failed\n");
562 if (usb_ether_rx_list_init(sc, &sc->cdce_cdata,
563 sc->cdce_udev) == ENOBUFS) {
564 device_printf(sc->cdce_dev, "rx list init failed\n");
569 /* Maybe set multicast / broadcast here??? */
571 err = usbd_open_pipe(sc->cdce_data_iface, sc->cdce_bulkin_no,
572 USBD_EXCLUSIVE_USE, &sc->cdce_bulkin_pipe);
574 device_printf(sc->cdce_dev, "open rx pipe failed: %s\n",
580 err = usbd_open_pipe(sc->cdce_data_iface, sc->cdce_bulkout_no,
581 USBD_EXCLUSIVE_USE, &sc->cdce_bulkout_pipe);
583 device_printf(sc->cdce_dev, "open tx pipe failed: %s\n",
589 for (i = 0; i < UE_RX_LIST_CNT; i++) {
590 c = &sc->cdce_cdata.ue_rx_chain[i];
591 usbd_setup_xfer(c->ue_xfer, sc->cdce_bulkin_pipe, c,
592 mtod(c->ue_mbuf, char *), UE_BUFSZ, USBD_SHORT_XFER_OK,
593 USBD_NO_TIMEOUT, cdce_rxeof);
594 usbd_transfer(c->ue_xfer);
597 ifp->if_drv_flags |= IFF_DRV_RUNNING;
598 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
606 cdce_rxeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
608 struct ue_chain *c = priv;
609 struct cdce_softc *sc = c->ue_sc;
617 if (sc->cdce_dying || !(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
622 if (status != USBD_NORMAL_COMPLETION) {
623 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
627 if (sc->cdce_rxeof_errors == 0)
628 device_printf(sc->cdce_dev, "usb error on rx: %s\n",
629 usbd_errstr(status));
630 if (status == USBD_STALLED)
631 usbd_clear_endpoint_stall_async(sc->cdce_bulkin_pipe);
632 DELAY(sc->cdce_rxeof_errors * 10000);
633 sc->cdce_rxeof_errors++;
637 sc->cdce_rxeof_errors = 0;
639 usbd_get_xfer_status(xfer, NULL, NULL, &total_len, NULL);
641 if (sc->cdce_flags & CDCE_ZAURUS)
642 total_len -= 4; /* Strip off CRC added by Zaurus */
646 if (total_len < sizeof(struct ether_header)) {
652 m->m_pkthdr.rcvif = (struct ifnet *)&sc->q;
653 m->m_pkthdr.len = m->m_len = total_len;
655 /* Put the packet on the special USB input queue. */
662 /* Setup new transfer. */
663 usbd_setup_xfer(c->ue_xfer, sc->cdce_bulkin_pipe, c,
664 mtod(c->ue_mbuf, char *),
665 UE_BUFSZ, USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT,
667 usbd_transfer(c->ue_xfer);
674 cdce_txeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
676 struct ue_chain *c = priv;
677 struct cdce_softc *sc = c->ue_sc;
684 if (sc->cdce_dying ||
685 !(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
690 if (status != USBD_NORMAL_COMPLETION) {
691 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
696 device_printf(sc->cdce_dev, "usb error on tx: %s\n",
697 usbd_errstr(status));
698 if (status == USBD_STALLED)
699 usbd_clear_endpoint_stall_async(sc->cdce_bulkout_pipe);
704 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
705 usbd_get_xfer_status(c->ue_xfer, NULL, NULL, NULL, &err);
707 if (c->ue_mbuf != NULL) {
708 c->ue_mbuf->m_pkthdr.rcvif = ifp;
709 usb_tx_done(c->ue_mbuf);
724 cdce_rxstart(struct ifnet *ifp)
726 struct cdce_softc *sc;
732 if (sc->cdce_dying || !(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
737 c = &sc->cdce_cdata.ue_rx_chain[sc->cdce_cdata.ue_rx_prod];
739 c->ue_mbuf = usb_ether_newbuf();
740 if (c->ue_mbuf == NULL) {
741 device_printf(sc->cdce_dev, "no memory for rx list "
742 "-- packet dropped!\n");
748 usbd_setup_xfer(c->ue_xfer, sc->cdce_bulkin_pipe, c,
749 mtod(c->ue_mbuf, char *), UE_BUFSZ, USBD_SHORT_XFER_OK,
750 USBD_NO_TIMEOUT, cdce_rxeof);
751 usbd_transfer(c->ue_xfer);
758 cdce_ifmedia_upd(struct ifnet *ifp)
761 /* no-op, cdce has only 1 possible media type */
766 cdce_ifmedia_sts(struct ifnet * const ifp, struct ifmediareq *req)
769 req->ifm_status = IFM_AVALID | IFM_ACTIVE;
770 req->ifm_active = IFM_ETHER | IFM_10_T;