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_shutdown_t cdce_shutdown;
77 USB_DECLARE_DRIVER_INIT(cdce,
78 DEVMETHOD(device_probe, cdce_match),
79 DEVMETHOD(device_attach, cdce_attach),
80 DEVMETHOD(device_detach, cdce_detach),
81 DEVMETHOD(device_shutdown, cdce_shutdown)
83 DRIVER_MODULE(cdce, uhub, cdce_driver, cdce_devclass, usbd_driver_load, 0);
84 MODULE_VERSION(cdce, 0);
86 Static int cdce_encap(struct cdce_softc *, struct mbuf *, int);
87 Static void cdce_rxeof(usbd_xfer_handle, usbd_private_handle, usbd_status);
88 Static void cdce_txeof(usbd_xfer_handle, usbd_private_handle, usbd_status);
89 Static void cdce_start(struct ifnet *);
90 Static int cdce_ioctl(struct ifnet *, u_long, caddr_t);
91 Static void cdce_init(void *);
92 Static void cdce_reset(struct cdce_softc *);
93 Static void cdce_stop(struct cdce_softc *);
94 Static void cdce_rxstart(struct ifnet *);
95 Static int cdce_ifmedia_upd(struct ifnet *ifp);
96 Static void cdce_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr);
98 Static const struct cdce_type cdce_devs[] = {
99 {{ USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2501 }, CDCE_NO_UNION },
100 {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SL5500 }, CDCE_ZAURUS },
101 {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SLA300 }, CDCE_ZAURUS | CDCE_NO_UNION },
102 {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SL5600 }, CDCE_ZAURUS | CDCE_NO_UNION },
103 {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SLC700 }, CDCE_ZAURUS | CDCE_NO_UNION },
104 {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SLC750 }, CDCE_ZAURUS | CDCE_NO_UNION },
105 {{ USB_VENDOR_GMATE, USB_PRODUCT_GMATE_YP3X00 }, CDCE_NO_UNION },
106 {{ USB_VENDOR_NETCHIP, USB_PRODUCT_NETCHIP_ETHERNETGADGET }, CDCE_NO_UNION },
108 #define cdce_lookup(v, p) ((const struct cdce_type *)usb_lookup(cdce_devs, v, p))
112 USB_MATCH_START(cdce, uaa);
113 usb_interface_descriptor_t *id;
115 if (uaa->iface == NULL)
116 return (UMATCH_NONE);
118 id = usbd_get_interface_descriptor(uaa->iface);
120 return (UMATCH_NONE);
122 if (cdce_lookup(uaa->vendor, uaa->product) != NULL)
123 return (UMATCH_VENDOR_PRODUCT);
125 if (id->bInterfaceClass == UICLASS_CDC && id->bInterfaceSubClass ==
126 UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL)
127 return (UMATCH_IFACECLASS_GENERIC);
129 return (UMATCH_NONE);
134 USB_ATTACH_START(cdce, sc, uaa);
136 usbd_device_handle dev = uaa->device;
137 const struct cdce_type *t;
138 usb_interface_descriptor_t *id;
139 usb_endpoint_descriptor_t *ed;
140 const usb_cdc_union_descriptor_t *ud;
141 usb_config_descriptor_t *cd;
144 u_char eaddr[ETHER_ADDR_LEN];
145 const usb_cdc_ethernet_descriptor_t *ue;
146 char eaddr_str[USB_MAX_STRING_LEN];
148 bzero(sc, sizeof(struct cdce_softc));
150 usbd_devinfo(dev, 0, sc->devinfo);
151 device_set_desc_copy(self, sc->devinfo);
152 printf("%s: %s\n", USBDEVNAME(sc->cdce_dev), sc->devinfo);
154 sc->cdce_udev = uaa->device;
155 sc->cdce_unit = device_get_unit(self);
157 t = cdce_lookup(uaa->vendor, uaa->product);
159 sc->cdce_flags = t->cdce_flags;
161 if (sc->cdce_flags & CDCE_NO_UNION)
162 sc->cdce_data_iface = uaa->iface;
164 ud = (const usb_cdc_union_descriptor_t *)usb_find_desc(sc->cdce_udev,
165 UDESC_CS_INTERFACE, UDESCSUB_CDC_UNION);
167 printf("%s: no union descriptor\n",
168 USBDEVNAME(sc->cdce_dev));
169 USB_ATTACH_ERROR_RETURN;
171 data_ifcno = ud->bSlaveInterface[0];
173 for (i = 0; i < uaa->nifaces; i++) {
174 if (uaa->ifaces[i] != NULL) {
175 id = usbd_get_interface_descriptor(
177 if (id != NULL && id->bInterfaceNumber ==
179 sc->cdce_data_iface = uaa->ifaces[i];
180 uaa->ifaces[i] = NULL;
186 if (sc->cdce_data_iface == NULL) {
187 printf("%s: no data interface\n", USBDEVNAME(sc->cdce_dev));
188 USB_ATTACH_ERROR_RETURN;
193 * The Data Class interface of a networking device shall have a minimum
194 * of two interface settings. The first setting (the default interface
195 * setting) includes no endpoints and therefore no networking traffic is
196 * exchanged whenever the default interface setting is selected. One or
197 * more additional interface settings are used for normal operation, and
198 * therefore each includes a pair of endpoints (one IN, and one OUT) to
199 * exchange network traffic. Select an alternate interface setting to
200 * initialize the network aspects of the device and to enable the
201 * exchange of network traffic.
204 * Some devices, most notably cable modems, include interface settings
205 * that have no IN or OUT endpoint, therefore loop through the list of all
206 * available interface settings looking for one with both IN and OUT
209 id = usbd_get_interface_descriptor(sc->cdce_data_iface);
210 cd = usbd_get_config_descriptor(sc->cdce_udev);
211 numalts = usbd_get_no_alts(cd, id->bInterfaceNumber);
213 for (j = 0; j < numalts; j++) {
214 if (usbd_set_interface(sc->cdce_data_iface, j)) {
215 printf("%s: setting alternate interface failed\n",
216 USBDEVNAME(sc->cdce_dev));
217 USB_ATTACH_ERROR_RETURN;
219 /* Find endpoints. */
220 id = usbd_get_interface_descriptor(sc->cdce_data_iface);
221 sc->cdce_bulkin_no = sc->cdce_bulkout_no = -1;
222 for (i = 0; i < id->bNumEndpoints; i++) {
223 ed = usbd_interface2endpoint_descriptor(sc->cdce_data_iface, i);
225 printf("%s: could not read endpoint descriptor\n",
226 USBDEVNAME(sc->cdce_dev));
227 USB_ATTACH_ERROR_RETURN;
229 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
230 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
231 sc->cdce_bulkin_no = ed->bEndpointAddress;
232 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
233 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
234 sc->cdce_bulkout_no = ed->bEndpointAddress;
235 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
236 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
237 /* XXX: CDC spec defines an interrupt pipe, but it is not
238 * needed for simple host-to-host applications. */
240 printf("%s: unexpected endpoint\n",
241 USBDEVNAME(sc->cdce_dev));
244 /* If we found something, try and use it... */
245 if ((sc->cdce_bulkin_no != -1) && (sc->cdce_bulkout_no != -1))
249 if (sc->cdce_bulkin_no == -1) {
250 printf("%s: could not find data bulk in\n",
251 USBDEVNAME(sc->cdce_dev));
252 USB_ATTACH_ERROR_RETURN;
254 if (sc->cdce_bulkout_no == -1 ) {
255 printf("%s: could not find data bulk out\n",
256 USBDEVNAME(sc->cdce_dev));
257 USB_ATTACH_ERROR_RETURN;
260 mtx_init(&sc->cdce_mtx, USBDEVNAME(sc->cdce_dev), MTX_NETWORK_LOCK,
261 MTX_DEF | MTX_RECURSE);
262 ifmedia_init(&sc->cdce_ifmedia, 0, cdce_ifmedia_upd, cdce_ifmedia_sts);
265 ue = (const usb_cdc_ethernet_descriptor_t *)usb_find_desc(dev,
266 UDESC_INTERFACE, UDESCSUB_CDC_ENF);
267 if (!ue || usbd_get_string(dev, ue->iMacAddress, eaddr_str)) {
268 /* Fake MAC address */
269 printf("%s: faking MAC address\n", USBDEVNAME(sc->cdce_dev));
271 memcpy(&eaddr[1], &ticks, sizeof(u_int32_t));
272 eaddr[5] = (u_int8_t)(sc->cdce_unit);
276 memset(eaddr, 0, ETHER_ADDR_LEN);
277 for (i = 0; i < ETHER_ADDR_LEN * 2; i++) {
278 int c = eaddr_str[i];
280 if ('0' <= c && c <= '9')
291 ifp = GET_IFP(sc) = if_alloc(IFT_ETHER);
293 printf("%s: can not if_alloc()\n", USBDEVNAME(sc->cdce_dev));
295 mtx_destroy(&sc->cdce_mtx);
296 USB_ATTACH_ERROR_RETURN;
299 if_initname(ifp, "cdce", sc->cdce_unit);
300 ifp->if_mtu = ETHERMTU;
301 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST |
303 ifp->if_ioctl = cdce_ioctl;
304 ifp->if_output = ether_output;
305 ifp->if_start = cdce_start;
306 ifp->if_init = cdce_init;
307 ifp->if_baudrate = 11000000;
308 ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
311 sc->q.if_rxstart = cdce_rxstart;
313 /* No IFM type for 11Mbps USB, so go with 10baseT */
314 ifmedia_add(&sc->cdce_ifmedia, IFM_ETHER | IFM_10_T, 0, 0);
315 ifmedia_set(&sc->cdce_ifmedia, IFM_ETHER | IFM_10_T);
317 ether_ifattach(ifp, eaddr);
318 usb_register_netisr();
322 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->cdce_udev,
323 USBDEV(sc->cdce_dev));
325 USB_ATTACH_SUCCESS_RETURN;
330 USB_DETACH_START(cdce, sc);
336 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
337 cdce_shutdown(sc->cdce_dev);
341 ifmedia_removeall(&sc->cdce_ifmedia);
343 mtx_destroy(&sc->cdce_mtx);
345 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->cdce_udev,
346 USBDEV(sc->cdce_dev));
352 cdce_start(struct ifnet *ifp)
354 struct cdce_softc *sc;
355 struct mbuf *m_head = NULL;
361 if (sc->cdce_dying ||
362 ifp->if_drv_flags & IFF_DRV_OACTIVE ||
363 !(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
368 IF_DEQUEUE(&ifp->if_snd, m_head);
369 if (m_head == NULL) {
374 if (cdce_encap(sc, m_head, 0)) {
375 IF_PREPEND(&ifp->if_snd, m_head);
376 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
381 BPF_MTAP(ifp, m_head);
383 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
391 cdce_encap(struct cdce_softc *sc, struct mbuf *m, int idx)
397 c = &sc->cdce_cdata.ue_tx_chain[idx];
399 m_copydata(m, 0, m->m_pkthdr.len, c->ue_buf);
400 if (sc->cdce_flags & CDCE_ZAURUS) {
401 /* Zaurus wants a 32-bit CRC appended to every frame */
404 crc = htole32(crc32(c->ue_buf, m->m_pkthdr.len));
405 bcopy(&crc, c->ue_buf + m->m_pkthdr.len, 4);
410 usbd_setup_xfer(c->ue_xfer, sc->cdce_bulkout_pipe, c, c->ue_buf,
411 m->m_pkthdr.len + extra, 0, 10000, cdce_txeof);
412 err = usbd_transfer(c->ue_xfer);
413 if (err != USBD_IN_PROGRESS) {
418 sc->cdce_cdata.ue_tx_cnt++;
424 cdce_stop(struct cdce_softc *sc)
436 if (sc->cdce_bulkin_pipe != NULL) {
437 err = usbd_abort_pipe(sc->cdce_bulkin_pipe);
439 printf("%s: abort rx pipe failed: %s\n",
440 USBDEVNAME(sc->cdce_dev), usbd_errstr(err));
441 err = usbd_close_pipe(sc->cdce_bulkin_pipe);
443 printf("%s: close rx pipe failed: %s\n",
444 USBDEVNAME(sc->cdce_dev), usbd_errstr(err));
445 sc->cdce_bulkin_pipe = NULL;
448 if (sc->cdce_bulkout_pipe != NULL) {
449 err = usbd_abort_pipe(sc->cdce_bulkout_pipe);
451 printf("%s: abort tx pipe failed: %s\n",
452 USBDEVNAME(sc->cdce_dev), usbd_errstr(err));
453 err = usbd_close_pipe(sc->cdce_bulkout_pipe);
455 printf("%s: close tx pipe failed: %s\n",
456 USBDEVNAME(sc->cdce_dev), usbd_errstr(err));
457 sc->cdce_bulkout_pipe = NULL;
460 usb_ether_rx_list_free(&sc->cdce_cdata);
461 usb_ether_tx_list_free(&sc->cdce_cdata);
463 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
470 cdce_shutdown(device_ptr_t dev)
472 struct cdce_softc *sc;
474 sc = device_get_softc(dev);
481 cdce_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
483 struct cdce_softc *sc = ifp->if_softc;
484 struct ifreq *ifr = (struct ifreq *)data;
492 if (ifp->if_flags & IFF_UP) {
493 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING))
496 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
504 error = ifmedia_ioctl(ifp, ifr, &sc->cdce_ifmedia, command);
508 error = ether_ioctl(ifp, command, data);
516 cdce_reset(struct cdce_softc *sc)
518 /* XXX Maybe reset the bulk pipes here? */
525 struct cdce_softc *sc = xsc;
526 struct ifnet *ifp = GET_IFP(sc);
531 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
537 if (usb_ether_tx_list_init(sc, &sc->cdce_cdata,
538 sc->cdce_udev) == ENOBUFS) {
539 printf("%s: tx list init failed\n", USBDEVNAME(sc->cdce_dev));
544 if (usb_ether_rx_list_init(sc, &sc->cdce_cdata,
545 sc->cdce_udev) == ENOBUFS) {
546 printf("%s: rx list init failed\n", USBDEVNAME(sc->cdce_dev));
551 /* Maybe set multicast / broadcast here??? */
553 err = usbd_open_pipe(sc->cdce_data_iface, sc->cdce_bulkin_no,
554 USBD_EXCLUSIVE_USE, &sc->cdce_bulkin_pipe);
556 printf("%s: open rx pipe failed: %s\n", USBDEVNAME(sc->cdce_dev),
562 err = usbd_open_pipe(sc->cdce_data_iface, sc->cdce_bulkout_no,
563 USBD_EXCLUSIVE_USE, &sc->cdce_bulkout_pipe);
565 printf("%s: open tx pipe failed: %s\n", USBDEVNAME(sc->cdce_dev),
571 for (i = 0; i < UE_RX_LIST_CNT; i++) {
572 c = &sc->cdce_cdata.ue_rx_chain[i];
573 usbd_setup_xfer(c->ue_xfer, sc->cdce_bulkin_pipe, c,
574 mtod(c->ue_mbuf, char *), UE_BUFSZ, USBD_SHORT_XFER_OK,
575 USBD_NO_TIMEOUT, cdce_rxeof);
576 usbd_transfer(c->ue_xfer);
579 ifp->if_drv_flags |= IFF_DRV_RUNNING;
580 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
588 cdce_rxeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
590 struct ue_chain *c = priv;
591 struct cdce_softc *sc = c->ue_sc;
599 if (sc->cdce_dying || !(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
604 if (status != USBD_NORMAL_COMPLETION) {
605 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
609 if (sc->cdce_rxeof_errors == 0)
610 printf("%s: usb error on rx: %s\n",
611 USBDEVNAME(sc->cdce_dev), usbd_errstr(status));
612 if (status == USBD_STALLED)
613 usbd_clear_endpoint_stall(sc->cdce_bulkin_pipe);
614 DELAY(sc->cdce_rxeof_errors * 10000);
615 sc->cdce_rxeof_errors++;
619 sc->cdce_rxeof_errors = 0;
621 usbd_get_xfer_status(xfer, NULL, NULL, &total_len, NULL);
623 if (sc->cdce_flags & CDCE_ZAURUS)
624 total_len -= 4; /* Strip off CRC added by Zaurus */
628 if (total_len < sizeof(struct ether_header)) {
634 m->m_pkthdr.rcvif = (struct ifnet *)&sc->q;
635 m->m_pkthdr.len = m->m_len = total_len;
637 /* Put the packet on the special USB input queue. */
644 /* Setup new transfer. */
645 usbd_setup_xfer(c->ue_xfer, sc->cdce_bulkin_pipe, c,
646 mtod(c->ue_mbuf, char *),
647 UE_BUFSZ, USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT,
649 usbd_transfer(c->ue_xfer);
656 cdce_txeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
658 struct ue_chain *c = priv;
659 struct cdce_softc *sc = c->ue_sc;
666 if (sc->cdce_dying ||
667 !(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
672 if (status != USBD_NORMAL_COMPLETION) {
673 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
678 printf("%s: usb error on tx: %s\n", USBDEVNAME(sc->cdce_dev),
679 usbd_errstr(status));
680 if (status == USBD_STALLED)
681 usbd_clear_endpoint_stall(sc->cdce_bulkout_pipe);
686 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
687 usbd_get_xfer_status(c->ue_xfer, NULL, NULL, NULL, &err);
689 if (c->ue_mbuf != NULL) {
690 c->ue_mbuf->m_pkthdr.rcvif = ifp;
691 usb_tx_done(c->ue_mbuf);
706 cdce_rxstart(struct ifnet *ifp)
708 struct cdce_softc *sc;
714 if (sc->cdce_dying || !(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
719 c = &sc->cdce_cdata.ue_rx_chain[sc->cdce_cdata.ue_rx_prod];
721 c->ue_mbuf = usb_ether_newbuf();
722 if (c->ue_mbuf == NULL) {
723 printf("%s: no memory for rx list "
724 "-- packet dropped!\n", USBDEVNAME(sc->cdce_dev));
730 usbd_setup_xfer(c->ue_xfer, sc->cdce_bulkin_pipe, c,
731 mtod(c->ue_mbuf, char *), UE_BUFSZ, USBD_SHORT_XFER_OK,
732 USBD_NO_TIMEOUT, cdce_rxeof);
733 usbd_transfer(c->ue_xfer);
740 cdce_ifmedia_upd(struct ifnet *ifp)
743 /* no-op, cdce has only 1 possible media type */
748 cdce_ifmedia_sts(struct ifnet * const ifp, struct ifmediareq *req)
751 req->ifm_status = IFM_AVALID | IFM_ACTIVE;
752 req->ifm_active = IFM_ETHER | IFM_10_T;