diff options
author | Daniel Hartmeier <dhartmei@cvs.openbsd.org> | 2004-07-20 20:30:10 +0000 |
---|---|---|
committer | Daniel Hartmeier <dhartmei@cvs.openbsd.org> | 2004-07-20 20:30:10 +0000 |
commit | 5ee2de3755d1cfb57f96c46d6b7a4c5207720c76 (patch) | |
tree | 23a7c3e133e4dcf94eb11d15948362c76ceb4857 | |
parent | 64dca843839b54c45ee22dacc5b821c64e301b08 (diff) |
Driver for USB CDC Ethernet devices (USB Host-to-Host), appearing as
network interfaces, transporting Ethernet, supporting Sharp Zaurus and
Prolific PL-2501 (external cable). Written by Craig Boston based on code
from Bill Paul. ok deraadt@
-rw-r--r-- | share/man/man4/Makefile | 4 | ||||
-rw-r--r-- | share/man/man4/cdce.4 | 130 | ||||
-rw-r--r-- | sys/arch/i386/conf/GENERIC | 3 | ||||
-rw-r--r-- | sys/dev/usb/files.usb | 7 | ||||
-rw-r--r-- | sys/dev/usb/if_cdce.c | 759 | ||||
-rw-r--r-- | sys/dev/usb/if_cdcereg.h | 85 |
6 files changed, 984 insertions, 4 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index d38e697d6c1..2f2ca94a732 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,11 +1,11 @@ -# $OpenBSD: Makefile,v 1.271 2004/07/15 23:58:28 deraadt Exp $ +# $OpenBSD: Makefile,v 1.272 2004/07/20 20:30:09 dhartmei Exp $ MAN= aac.4 ac97.4 acphy.4 addcom.4 adv.4 aha.4 ahb.4 ahc.4 ahd.4 \ aic.4 amdpm.4 ami.4 amphy.4 an.4 aria.4 ast.4 atalk.4 \ atapiscsi.4 atw.4 audio.4 aue.4 auich.4 autri.4 auvia.4 awi.4 \ axe.4 az.4 bce.4 bge.4 bha.4 bio.4 bktr.4 bmtphy.4 boca.4 bpf.4 \ brgphy.4 bridge.4 cac.4 cardbus.4 carp.4 ccd.4 cd.4 \ - ch.4 clcs.4 clct.4 cmpci.4 cnw.4 com.4 \ + cdce.4 ch.4 clcs.4 clct.4 cmpci.4 cnw.4 com.4 \ crypto.4 cue.4 cy.4 cz.4 dc.4 dcphy.4 ddb.4 de.4 dpt.4 \ drum.4 eap.4 ec.4 eephy.4 ef.4 eg.4 ehci.4 eisa.4 el.4 em.4 \ emu.4 enc.4 ep.4 esa.4 eso.4 ess.4 exphy.4 \ diff --git a/share/man/man4/cdce.4 b/share/man/man4/cdce.4 new file mode 100644 index 00000000000..668a097dd04 --- /dev/null +++ b/share/man/man4/cdce.4 @@ -0,0 +1,130 @@ +.\" Copyright (c) 2004 Daniel Hartmeier +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" - Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" - Redistributions in binary form must reproduce the above +.\" copyright notice, this list of conditions and the following +.\" disclaimer in the documentation and/or other materials provided +.\" with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $OpenBSD: cdce.4,v 1.1 2004/07/20 20:30:09 dhartmei Exp $ +.\" +.Dd July 20, 2004 +.Dt CDCE 4 +.Os +.Sh NAME +.Nm cdce +.Nd USB Communication Device Class Ethernet driver +.Sh SYNOPSIS +.Cd "cdce* at uhub? port ?" +.Sh DESCRIPTION +The +.Nm +driver provides support for USB Host-to-Host (aka USB-to-USB) bridges +based on the USB Communication Device Class (CDC) and Ethernet subclass, +including the following: +.Pp +.Bl -bullet -compact +.It +Prolific PL-2501 +.It +Sharp Zaurus +.El +.Pp +The USB bridge appears as a regular network interface on both sides, +transporting Ethernet frames. +An IP address can be assigned using +.Xr ifconfig 8 +or +.Xr hostname.if 5 +.Pp +USB 1.x bridges support speeds of up to 12Mbps, and USB 2.0 speeds of +up to 480Mbps. +.Pp +Packets are +received and transmitted over separate USB bulk transfer endpoints. +.Pp +The +.Nm +driver does not support different media types or options. +.Sh DIAGNOSTICS +.Bl -diag +.It "cdce%d: no union descriptor" +The driver couldn't fetch an interface descriptor from the USB +device. +For a manually added USB vendor/product, the CDCE_NO_UNION flag +can be tried to work around the missing descriptor. +.It "cdce%d: no data interface" +.It "cdce%d: could not read endpoint descriptor" +.It "cdce%d: unexpected endpoint" +.It "cdce%d: could not find data bulk in/out" +For a manually added USB vendor/product, these errors indicate +that the bridge is not compatible with the driver. +.It "cdce%d: watchdog timeout" +A packet was queued for transmission and a transmit command was +issued, however the device failed to acknowledge the transmission +before a timeout expired. +.It "cdce%d: no memory for rx list -- packet dropped!" +Memory allocation through MGETHDR or MCLGET failed, the system +is running low on mbufs. +.It "cdce%d: abort/close rx/tx pipe failed" +.It "cdce%d: rx/tx list init failed" +.It "cdce%d: open rx/tx pipe failed" +.It "cdce%d: usb error on rx/tx" +.El +.Sh SEE ALSO +.Xr arp 4 , +.Xr intro 4 , +.Xr netintro 4 , +.Xr usb 4 , +.Xr hostname.if 5 , +.Xr ifconfig 8 +.Rs +.%T "Universal Serial Bus Class Definitions for Communication Devices" +.%O http://www.usb.org/developers/devclass_docs/usbcdc11.pdf +.Re +.Rs +.%T "Data sheet Prolific PL-2501 Host-to-Host Bridge/Network Controller" +.%O http://tech.prolific.com.tw/visitor/fcabdl.asp?fid=20679530 +.Re +.Sh HISTORY +The +.Nm +device driver first appeared in +.Ox 3.6 . +.Sh AUTHORS +The +.Nm +driver was written by +.An Craig Boston Aq craig@tobuj.gank.org +based on the +.Xr aue 4 +driver written by +.An Bill Paul Aq wpaul@windriver.com +and ported to +.Ox +by +.An Daniel Hartmeier Aq dhartmei@openbsd.org . +.Sh CAVEATS +Many USB devices notoriously fail to report their class and interfaces +correctly. +Undetected products might work flawlessly when their vendor and product IDs +are added to the driver manually. diff --git a/sys/arch/i386/conf/GENERIC b/sys/arch/i386/conf/GENERIC index 1c51b9f2031..82901fcdbd3 100644 --- a/sys/arch/i386/conf/GENERIC +++ b/sys/arch/i386/conf/GENERIC @@ -1,4 +1,4 @@ -# $OpenBSD: GENERIC,v 1.375 2004/06/29 04:01:29 millert Exp $ +# $OpenBSD: GENERIC,v 1.376 2004/07/20 20:30:09 dhartmei Exp $ # # GENERIC -- everything that's currently supported # @@ -153,6 +153,7 @@ aue* at uhub? port ? # ADMtek AN986 Pegasus Ethernet axe* at uhub? port ? # ASIX Electronics AX88172 USB Ethernet cue* at uhub? port ? # CATC USB-EL1201A based Ethernet kue* at uhub? port ? # Kawasaki KL5KUSB101B based Ethernet +cdce* at uhub? port ? # CDC Ethernet upl* at uhub? port ? # Prolific PL2301/PL2302 host-to-host `network' url* at uhub? port ? # Realtek RTL8150L based adapters wi* at uhub? port ? # WaveLAN IEEE 802.11DS diff --git a/sys/dev/usb/files.usb b/sys/dev/usb/files.usb index 73fb005e0cd..5251509974c 100644 --- a/sys/dev/usb/files.usb +++ b/sys/dev/usb/files.usb @@ -1,4 +1,4 @@ -# $OpenBSD: files.usb,v 1.35 2004/04/02 01:10:09 deraadt Exp $ +# $OpenBSD: files.usb,v 1.36 2004/07/20 20:30:09 dhartmei Exp $ # $NetBSD: files.usb,v 1.16 2000/02/14 20:29:54 augustss Exp $ # # Config file and device description for machine-independent USB code. @@ -140,6 +140,11 @@ device kue: ether, ifnet, ifmedia attach kue at uhub file dev/usb/if_kue.c kue +# CDC Ethernet +device cdce: ether, ifnet, ifmedia +attach cdce at uhub +file dev/usb/if_cdce.c cdce + # Prolific PL2302 host-host device upl: ifnet attach upl at uhub diff --git a/sys/dev/usb/if_cdce.c b/sys/dev/usb/if_cdce.c new file mode 100644 index 00000000000..2aa85deede4 --- /dev/null +++ b/sys/dev/usb/if_cdce.c @@ -0,0 +1,759 @@ +/* $OpenBSD: if_cdce.c,v 1.1 2004/07/20 20:30:09 dhartmei Exp $ */ + +/* + * Copyright (c) 1997, 1998, 1999, 2000-2003 Bill Paul <wpaul@windriver.com> + * Copyright (c) 2003 Craig Boston + * Copyright (c) 2004 Daniel Hartmeier + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * This product includes software developed by Bill Paul. + * 4. Neither the name of the author nor the names of any co-contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul, THE VOICES IN HIS HEAD OR + * THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; + * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, + * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR + * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * USB Communication Device Class (Ethernet Networking Control Model) + * http://www.usb.org/developers/devclass_docs/usbcdc11.pdf + * + */ + +#include <bpfilter.h> + +#include <sys/param.h> +#include <sys/systm.h> +#include <sys/sockio.h> +#include <sys/mbuf.h> +#include <sys/malloc.h> +#include <sys/kernel.h> +#include <sys/socket.h> +#include <sys/device.h> +#include <sys/proc.h> + +#include <net/if.h> +#include <net/if_dl.h> + +#if NBPFILTER > 0 +#include <net/bpf.h> +#define BPF_MTAP(ifp, m) bpf_mtap((ifp)->if_bpf, (m)) +#endif + +#include <netinet/in.h> +#include <netinet/in_systm.h> +#include <netinet/in_var.h> +#include <netinet/ip.h> +#include <netinet/if_ether.h> + +#include <dev/usb/usb.h> +#include <dev/usb/usbdi.h> +#include <dev/usb/usbdi_util.h> +#include <dev/usb/usbdevs.h> +#include <dev/usb/usbcdc.h> + +#include <dev/usb/if_cdcereg.h> + +Static void *cdce_get_desc(usbd_device_handle dev, int type, int subtype); +Static int cdce_tx_list_init(struct cdce_softc *); +Static int cdce_rx_list_init(struct cdce_softc *); +Static int cdce_newbuf(struct cdce_softc *, struct cdce_chain *, + struct mbuf *); +Static int cdce_encap(struct cdce_softc *, struct mbuf *, int); +Static void cdce_rxeof(usbd_xfer_handle, usbd_private_handle, usbd_status); +Static void cdce_txeof(usbd_xfer_handle, usbd_private_handle, usbd_status); +Static void cdce_start(struct ifnet *); +Static int cdce_ioctl(struct ifnet *, u_long, caddr_t); +Static void cdce_init(void *); +Static void cdce_watchdog(struct ifnet *); +Static void cdce_stop(struct cdce_softc *); + +Static const struct cdce_type cdce_devs[] = { + {{ USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2501 }, CDCE_NO_UNION }, + {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SL5500 }, CDCE_ZAURUS }, + {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_A300 }, CDCE_ZAURUS | CDCE_NO_UNION }, + {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SL5600 }, CDCE_ZAURUS | CDCE_NO_UNION }, + {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_C700 }, CDCE_ZAURUS | CDCE_NO_UNION }, + {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_C750 }, CDCE_ZAURUS | CDCE_NO_UNION }, +}; +#define cdce_lookup(v, p) ((const struct cdce_type *)usb_lookup(cdce_devs, v, p)) + +USB_DECLARE_DRIVER_CLASS(cdce, DV_IFNET); + +USB_MATCH(cdce) +{ + USB_MATCH_START(cdce, uaa); + usb_interface_descriptor_t *id; + + if (uaa->iface == NULL) + return (UMATCH_NONE); + + id = usbd_get_interface_descriptor(uaa->iface); + if (id == NULL) + return (UMATCH_NONE); + + if (cdce_lookup(uaa->vendor, uaa->product) != NULL) + return (UMATCH_VENDOR_PRODUCT); + + if (id->bInterfaceClass == UICLASS_CDC && id->bInterfaceSubClass == + UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL) + return (UMATCH_IFACECLASS_GENERIC); + + return (UMATCH_NONE); +} + +USB_ATTACH(cdce) +{ + USB_ATTACH_START(cdce, sc, uaa); + char devinfo[1024]; + int s; + struct ifnet *ifp; + usbd_device_handle dev = uaa->device; + const struct cdce_type *t; + usb_interface_descriptor_t *id; + usb_endpoint_descriptor_t *ed; + usb_cdc_union_descriptor_t *ud; + int data_ifcno; + u_int16_t macaddr_hi; + int i; + + usbd_devinfo(dev, 0, devinfo, sizeof devinfo); + USB_ATTACH_SETUP; + printf("%s: %s\n", USBDEVNAME(sc->cdce_dev), devinfo); + + sc->cdce_udev = uaa->device; + sc->cdce_ctl_iface = uaa->iface; + + t = cdce_lookup(uaa->vendor, uaa->product); + if (t) + sc->cdce_flags = t->cdce_flags; + + if (sc->cdce_flags & CDCE_NO_UNION) + sc->cdce_data_iface = sc->cdce_ctl_iface; + else { + ud = cdce_get_desc(sc->cdce_udev, UDESC_CS_INTERFACE, + UDESCSUB_CDC_UNION); + if (ud == NULL) { + printf("%s: no union descriptor\n", + USBDEVNAME(sc->cdce_dev)); + USB_ATTACH_ERROR_RETURN; + } + data_ifcno = ud->bSlaveInterface[0]; + + for (i = 0; i < uaa->nifaces; i++) { + if (uaa->ifaces[i] != NULL) { + id = usbd_get_interface_descriptor( + uaa->ifaces[i]); + if (id != NULL && id->bInterfaceNumber == + data_ifcno) { + sc->cdce_data_iface = uaa->ifaces[i]; + uaa->ifaces[i] = NULL; + } + } + } + } + + if (sc->cdce_data_iface == NULL) { + printf("%s: no data interface\n", USBDEVNAME(sc->cdce_dev)); + USB_ATTACH_ERROR_RETURN; + } + + /* Find endpoints. */ + id = usbd_get_interface_descriptor(sc->cdce_data_iface); + sc->cdce_bulkin_no = sc->cdce_bulkout_no = -1; + for (i = 0; i < id->bNumEndpoints; i++) { + ed = usbd_interface2endpoint_descriptor(sc->cdce_data_iface, i); + if (!ed) { + printf("%s: could not read endpoint descriptor\n", + USBDEVNAME(sc->cdce_dev)); + USB_ATTACH_ERROR_RETURN; + } + if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && + UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) { + sc->cdce_bulkin_no = ed->bEndpointAddress; + } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT && + UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) { + sc->cdce_bulkout_no = ed->bEndpointAddress; + } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && + UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) { + /* XXX: CDC spec defines an interrupt pipe, but it is not + * needed for simple host-to-host applications. */ + } else { + printf("%s: unexpected endpoint\n", + USBDEVNAME(sc->cdce_dev)); + } + } + + if (sc->cdce_bulkin_no == -1) { + printf("%s: could not find data bulk in\n", + USBDEVNAME(sc->cdce_dev)); + USB_ATTACH_ERROR_RETURN; + } + if (sc->cdce_bulkout_no == -1 ) { + printf("%s: could not find data bulk out\n", + USBDEVNAME(sc->cdce_dev)); + USB_ATTACH_ERROR_RETURN; + } + + s = splnet(); + + macaddr_hi = htons(0x2acb); + bcopy(&macaddr_hi, &sc->cdce_arpcom.ac_enaddr[0], sizeof(u_int16_t)); + bcopy(&ticks, &sc->cdce_arpcom.ac_enaddr[2], sizeof(u_int32_t)); + sc->cdce_arpcom.ac_enaddr[5] = (u_int8_t)(sc->cdce_unit); + + printf("%s: address %s\n", USBDEVNAME(sc->cdce_dev), + ether_sprintf(sc->cdce_arpcom.ac_enaddr)); + + ifp = GET_IFP(sc); + ifp->if_softc = sc; + ifp->if_mtu = ETHERMTU; + ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST; + ifp->if_ioctl = cdce_ioctl; + ifp->if_start = cdce_start; + ifp->if_watchdog = cdce_watchdog; + strncpy(ifp->if_xname, USBDEVNAME(sc->cdce_dev), IFNAMSIZ); + + IFQ_SET_READY(&ifp->if_snd); + + if_attach(ifp); + Ether_ifattach(ifp, sc->cdce_arpcom.ac_enaddr); + + sc->cdce_attached = 1; + splx(s); + + usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->cdce_udev, + USBDEV(sc->cdce_dev)); + + USB_ATTACH_SUCCESS_RETURN; +} + +USB_DETACH(cdce) +{ + USB_DETACH_START(cdce, sc); + struct ifnet *ifp = GET_IFP(sc); + int s; + + s = splusb(); + + if (!sc->cdce_attached) { + splx(s); + return (0); + } + + if (ifp->if_flags & IFF_RUNNING) + cdce_stop(sc); + + ether_ifdetach(ifp); + + if_detach(ifp); + + sc->cdce_attached = 0; + splx(s); + + return (0); +} + +Static void +cdce_start(struct ifnet *ifp) +{ + struct cdce_softc *sc = ifp->if_softc; + struct mbuf *m_head = NULL; + + if (sc->cdce_dying || (ifp->if_flags & IFF_OACTIVE)) + return; + + IFQ_POLL(&ifp->if_snd, m_head); + if (m_head == NULL) + return; + + if (cdce_encap(sc, m_head, 0)) { + ifp->if_flags |= IFF_OACTIVE; + return; + } + + IFQ_DEQUEUE(&ifp->if_snd, m_head); + +#if NBPFILTER > 0 + if (ifp->if_bpf) + BPF_MTAP(ifp, m_head); +#endif + + ifp->if_flags |= IFF_OACTIVE; + + ifp->if_timer = 6; +} + +Static int +cdce_encap(struct cdce_softc *sc, struct mbuf *m, int idx) +{ + struct cdce_chain *c; + usbd_status err; + int extra = 0; + + c = &sc->cdce_cdata.cdce_tx_chain[idx]; + + m_copydata(m, 0, m->m_pkthdr.len, c->cdce_buf); + if (sc->cdce_flags & CDCE_ZAURUS) { + /* Zaurus wants a 32-bit CRC appended to every frame */ + u_int32_t crc; + + crc = ether_crc32_le(c->cdce_buf, m->m_pkthdr.len); + bcopy(&crc, c->cdce_buf + m->m_pkthdr.len, 4); + extra = 4; + } + c->cdce_mbuf = m; + + usbd_setup_xfer(c->cdce_xfer, sc->cdce_bulkout_pipe, c, c->cdce_buf, + m->m_pkthdr.len + extra, USBD_NO_COPY, 10000, cdce_txeof); + err = usbd_transfer(c->cdce_xfer); + if (err != USBD_IN_PROGRESS) { + cdce_stop(sc); + return (EIO); + } + + sc->cdce_cdata.cdce_tx_cnt++; + + return (0); +} + +Static void +cdce_stop(struct cdce_softc *sc) +{ + usbd_status err; + struct ifnet *ifp = GET_IFP(sc); + int i; + + ifp->if_timer = 0; + + if (sc->cdce_bulkin_pipe != NULL) { + err = usbd_abort_pipe(sc->cdce_bulkin_pipe); + if (err) + printf("%s: abort rx pipe failed: %s\n", + USBDEVNAME(sc->cdce_dev), usbd_errstr(err)); + err = usbd_close_pipe(sc->cdce_bulkin_pipe); + if (err) + printf("%s: close rx pipe failed: %s\n", + USBDEVNAME(sc->cdce_dev), usbd_errstr(err)); + sc->cdce_bulkin_pipe = NULL; + } + + if (sc->cdce_bulkout_pipe != NULL) { + err = usbd_abort_pipe(sc->cdce_bulkout_pipe); + if (err) + printf("%s: abort tx pipe failed: %s\n", + USBDEVNAME(sc->cdce_dev), usbd_errstr(err)); + err = usbd_close_pipe(sc->cdce_bulkout_pipe); + if (err) + printf("%s: close tx pipe failed: %s\n", + USBDEVNAME(sc->cdce_dev), usbd_errstr(err)); + sc->cdce_bulkout_pipe = NULL; + } + + for (i = 0; i < CDCE_RX_LIST_CNT; i++) { + if (sc->cdce_cdata.cdce_rx_chain[i].cdce_mbuf != NULL) { + m_freem(sc->cdce_cdata.cdce_rx_chain[i].cdce_mbuf); + sc->cdce_cdata.cdce_rx_chain[i].cdce_mbuf = NULL; + } + if (sc->cdce_cdata.cdce_rx_chain[i].cdce_xfer != NULL) { + usbd_free_xfer(sc->cdce_cdata.cdce_rx_chain[i].cdce_xfer); + sc->cdce_cdata.cdce_rx_chain[i].cdce_xfer = NULL; + } + } + + for (i = 0; i < CDCE_TX_LIST_CNT; i++) { + if (sc->cdce_cdata.cdce_tx_chain[i].cdce_mbuf != NULL) { + m_freem(sc->cdce_cdata.cdce_tx_chain[i].cdce_mbuf); + sc->cdce_cdata.cdce_tx_chain[i].cdce_mbuf = NULL; + } + if (sc->cdce_cdata.cdce_tx_chain[i].cdce_xfer != NULL) { + usbd_free_xfer(sc->cdce_cdata.cdce_tx_chain[i].cdce_xfer); + sc->cdce_cdata.cdce_tx_chain[i].cdce_xfer = NULL; + } + } + + ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE); +} + +Static int +cdce_ioctl(struct ifnet *ifp, u_long command, caddr_t data) +{ + struct cdce_softc *sc = ifp->if_softc; + struct ifaddr *ifa = (struct ifaddr *)data; + struct ifreq *ifr = (struct ifreq *)data; + int s, error = 0; + + if (sc->cdce_dying) + return (EIO); + + s = splnet(); + + switch(command) { + case SIOCSIFADDR: + ifp->if_flags |= IFF_UP; + cdce_init(sc); + switch (ifa->ifa_addr->sa_family) { + case AF_INET: + arp_ifinit(&sc->cdce_arpcom, ifa); + break; + } + break; + + case SIOCSIFMTU: + if (ifr->ifr_mtu > ETHERMTU) + error = EINVAL; + else + ifp->if_mtu = ifr->ifr_mtu; + break; + + case SIOCSIFFLAGS: + if (ifp->if_flags & IFF_UP) { + if (!(ifp->if_flags & IFF_RUNNING)) + cdce_init(sc); + } else { + if (ifp->if_flags & IFF_RUNNING) + cdce_stop(sc); + } + error = 0; + break; + + default: + error = EINVAL; + break; + } + + splx(s); + + return (error); +} + +Static void +cdce_watchdog(struct ifnet *ifp) +{ + struct cdce_softc *sc = ifp->if_softc; + + if (sc->cdce_dying) + return; + + ifp->if_oerrors++; + printf("%s: watchdog timeout\n", USBDEVNAME(sc->cdce_dev)); +} + +Static void +cdce_init(void *xsc) +{ + struct cdce_softc *sc = xsc; + struct ifnet *ifp = GET_IFP(sc); + struct cdce_chain *c; + usbd_status err; + int s, i; + + if (ifp->if_flags & IFF_RUNNING) + return; + + s = splnet(); + + if (cdce_tx_list_init(sc) == ENOBUFS) { + printf("%s: tx list init failed\n", USBDEVNAME(sc->cdce_dev)); + splx(s); + return; + } + + if (cdce_rx_list_init(sc) == ENOBUFS) { + printf("%s: rx list init failed\n", USBDEVNAME(sc->cdce_dev)); + splx(s); + return; + } + + /* Maybe set multicast / broadcast here??? */ + + err = usbd_open_pipe(sc->cdce_data_iface, sc->cdce_bulkin_no, + USBD_EXCLUSIVE_USE, &sc->cdce_bulkin_pipe); + if (err) { + printf("%s: open rx pipe failed: %s\n", USBDEVNAME(sc->cdce_dev), + usbd_errstr(err)); + splx(s); + return; + } + + err = usbd_open_pipe(sc->cdce_data_iface, sc->cdce_bulkout_no, + USBD_EXCLUSIVE_USE, &sc->cdce_bulkout_pipe); + if (err) { + printf("%s: open tx pipe failed: %s\n", USBDEVNAME(sc->cdce_dev), + usbd_errstr(err)); + splx(s); + return; + } + + for (i = 0; i < CDCE_RX_LIST_CNT; i++) { + c = &sc->cdce_cdata.cdce_rx_chain[i]; + usbd_setup_xfer(c->cdce_xfer, sc->cdce_bulkin_pipe, c, + c->cdce_buf, CDCE_BUFSZ, USBD_SHORT_XFER_OK | USBD_NO_COPY, + USBD_NO_TIMEOUT, cdce_rxeof); + usbd_transfer(c->cdce_xfer); + } + + ifp->if_flags |= IFF_RUNNING; + ifp->if_flags &= ~IFF_OACTIVE; + + splx(s); +} + +Static int +cdce_newbuf(struct cdce_softc *sc, struct cdce_chain *c, struct mbuf *m) +{ + struct mbuf *m_new = NULL; + + if (m == NULL) { + MGETHDR(m_new, M_DONTWAIT, MT_DATA); + if (m_new == NULL) { + printf("%s: no memory for rx list " + "-- packet dropped!\n", USBDEVNAME(sc->cdce_dev)); + return (ENOBUFS); + } + MCLGET(m_new, M_DONTWAIT); + if (!(m_new->m_flags & M_EXT)) { + printf("%s: no memory for rx list " + "-- packet dropped!\n", USBDEVNAME(sc->cdce_dev)); + m_freem(m_new); + return (ENOBUFS); + } + m_new->m_len = m_new->m_pkthdr.len = MCLBYTES; + } else { + m_new = m; + m_new->m_len = m_new->m_pkthdr.len = MCLBYTES; + m_new->m_data = m_new->m_ext.ext_buf; + } + c->cdce_mbuf = m_new; + return (0); +} + +Static int +cdce_rx_list_init(struct cdce_softc *sc) +{ + struct cdce_cdata *cd; + struct cdce_chain *c; + int i; + + cd = &sc->cdce_cdata; + for (i = 0; i < CDCE_RX_LIST_CNT; i++) { + c = &cd->cdce_rx_chain[i]; + c->cdce_sc = sc; + c->cdce_idx = i; + if (cdce_newbuf(sc, c, NULL) == ENOBUFS) + return (ENOBUFS); + if (c->cdce_xfer == NULL) { + c->cdce_xfer = usbd_alloc_xfer(sc->cdce_udev); + if (c->cdce_xfer == NULL) + return (ENOBUFS); + c->cdce_buf = usbd_alloc_buffer(c->cdce_xfer, CDCE_BUFSZ); + if (c->cdce_buf == NULL) + return (ENOBUFS); + } + } + + return (0); +} + +Static int +cdce_tx_list_init(struct cdce_softc *sc) +{ + struct cdce_cdata *cd; + struct cdce_chain *c; + int i; + + cd = &sc->cdce_cdata; + for (i = 0; i < CDCE_TX_LIST_CNT; i++) { + c = &cd->cdce_tx_chain[i]; + c->cdce_sc = sc; + c->cdce_idx = i; + c->cdce_mbuf = NULL; + if (c->cdce_xfer == NULL) { + c->cdce_xfer = usbd_alloc_xfer(sc->cdce_udev); + if (c->cdce_xfer == NULL) + return (ENOBUFS); + c->cdce_buf = usbd_alloc_buffer(c->cdce_xfer, CDCE_BUFSZ); + if (c->cdce_buf == NULL) + return (ENOBUFS); + } + } + + return (0); +} + +Static void +cdce_rxeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status) +{ + struct cdce_chain *c = priv; + struct cdce_softc *sc = c->cdce_sc; + struct ifnet *ifp = GET_IFP(sc); + struct mbuf *m; + int total_len = 0; + int s; + + if (sc->cdce_dying || !(ifp->if_flags & IFF_RUNNING)) + return; + + if (status != USBD_NORMAL_COMPLETION) { + if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) + return; + if (sc->cdce_rxeof_errors == 0) + printf("%s: usb error on rx: %s\n", + USBDEVNAME(sc->cdce_dev), usbd_errstr(status)); + if (status == USBD_STALLED) + usbd_clear_endpoint_stall(sc->cdce_bulkin_pipe); + DELAY(sc->cdce_rxeof_errors * 10000); + sc->cdce_rxeof_errors++; + goto done; + } + + sc->cdce_rxeof_errors = 0; + + usbd_get_xfer_status(xfer, NULL, NULL, &total_len, NULL); + if (sc->cdce_flags & CDCE_ZAURUS) + total_len -= 4; /* Strip off CRC added by Zaurus */ + if (total_len <= 1) + goto done; + + m = c->cdce_mbuf; + memcpy(mtod(m, char *), c->cdce_buf, total_len); + + if (total_len < sizeof(struct ether_header)) { + ifp->if_ierrors++; + goto done; + } + + ifp->if_ipackets++; + m->m_pkthdr.len = m->m_len = total_len; + m->m_pkthdr.rcvif = ifp; + + s = splnet(); + + if (cdce_newbuf(sc, c, NULL) == ENOBUFS) { + ifp->if_ierrors++; + goto done1; + } + +#if NBPFILTER > 0 + if (ifp->if_bpf) + BPF_MTAP(ifp, m); +#endif + + IF_INPUT(ifp, m); + +done1: + splx(s); + +done: + /* Setup new transfer. */ + usbd_setup_xfer(c->cdce_xfer, sc->cdce_bulkin_pipe, c, c->cdce_buf, + CDCE_BUFSZ, USBD_SHORT_XFER_OK | USBD_NO_COPY, USBD_NO_TIMEOUT, + cdce_rxeof); + usbd_transfer(c->cdce_xfer); +} + +Static void +cdce_txeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status) +{ + struct cdce_chain *c = priv; + struct cdce_softc *sc = c->cdce_sc; + struct ifnet *ifp = GET_IFP(sc); + usbd_status err; + int s; + + if (sc->cdce_dying) + return; + + s = splnet(); + + ifp->if_timer = 0; + ifp->if_flags &= ~IFF_OACTIVE; + + if (status != USBD_NORMAL_COMPLETION) { + if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) { + splx(s); + return; + } + ifp->if_oerrors++; + printf("%s: usb error on tx: %s\n", USBDEVNAME(sc->cdce_dev), + usbd_errstr(status)); + if (status == USBD_STALLED) + usbd_clear_endpoint_stall(sc->cdce_bulkout_pipe); + splx(s); + return; + } + + usbd_get_xfer_status(c->cdce_xfer, NULL, NULL, NULL, &err); + + if (c->cdce_mbuf != NULL) { + m_freem(c->cdce_mbuf); + c->cdce_mbuf = NULL; + } + + if (err) + ifp->if_oerrors++; + else + ifp->if_opackets++; + + if (IFQ_IS_EMPTY(&ifp->if_snd) == 0) + cdce_start(ifp); + + splx(s); +} + +void * +cdce_get_desc(usbd_device_handle dev, int type, int subtype) +{ + usb_descriptor_t *desc; + usb_config_descriptor_t *cd = usbd_get_config_descriptor(dev); + uByte *p = (uByte *)cd; + uByte *end = p + UGETW(cd->wTotalLength); + + while (p < end) { + desc = (usb_descriptor_t *)p; + if (desc->bDescriptorType == type && + desc->bDescriptorSubtype == subtype) + return (desc); + p += desc->bLength; + } + + return (NULL); +} + +int +cdce_activate(device_ptr_t self, enum devact act) +{ + struct cdce_softc *sc = (struct cdce_softc *)self; + + switch (act) { + case DVACT_ACTIVATE: + return (EOPNOTSUPP); + break; + + case DVACT_DEACTIVATE: + if_deactivate(GET_IFP(sc)); + sc->cdce_dying = 1; + break; + } + return (0); +} diff --git a/sys/dev/usb/if_cdcereg.h b/sys/dev/usb/if_cdcereg.h new file mode 100644 index 00000000000..a01f5f5a66b --- /dev/null +++ b/sys/dev/usb/if_cdcereg.h @@ -0,0 +1,85 @@ +/* $OpenBSD: if_cdcereg.h,v 1.1 2004/07/20 20:30:09 dhartmei Exp $ */ + +/* + * Copyright (c) 1997, 1998, 1999, 2000-2003 Bill Paul <wpaul@windriver.com> + * Copyright (c) 2003 Craig Boston + * Copyright (c) 2004 Daniel Hartmeier + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * This product includes software developed by Bill Paul. + * 4. Neither the name of the author nor the names of any co-contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul, THE VOICES IN HIS HEAD OR + * THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; + * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, + * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR + * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#define CDCE_RX_LIST_CNT 1 +#define CDCE_TX_LIST_CNT 1 +#define CDCE_BUFSZ 1542 + +struct cdce_type { + struct usb_devno cdce_dev; + u_int16_t cdce_flags; +#define CDCE_ZAURUS 1 +#define CDCE_NO_UNION 2 +}; + +struct cdce_softc; + +struct cdce_chain { + struct cdce_softc *cdce_sc; + usbd_xfer_handle cdce_xfer; + char *cdce_buf; + struct mbuf *cdce_mbuf; + int cdce_accum; + int cdce_idx; +}; + +struct cdce_cdata { + struct cdce_chain cdce_rx_chain[CDCE_RX_LIST_CNT]; + struct cdce_chain cdce_tx_chain[CDCE_TX_LIST_CNT]; + int cdce_tx_prod; + int cdce_tx_cons; + int cdce_tx_cnt; + int cdce_rx_prod; +}; + +struct cdce_softc { + USBBASEDEVICE cdce_dev; + struct arpcom cdce_arpcom; +#define GET_IFP(sc) (&(sc)->cdce_arpcom.ac_if) + usbd_device_handle cdce_udev; + usbd_interface_handle cdce_ctl_iface; + usbd_interface_handle cdce_data_iface; + int cdce_bulkin_no; + usbd_pipe_handle cdce_bulkin_pipe; + int cdce_bulkout_no; + usbd_pipe_handle cdce_bulkout_pipe; + char cdce_dying; + int cdce_unit; + struct cdce_cdata cdce_cdata; + int cdce_rxeof_errors; + u_int16_t cdce_flags; + char cdce_attached; +}; |