Driver for WinChipHead CH341/340 USB serial adapters.

originally written by Takuya SHIOZAKI <tshiozak@netbsd.org>

Currently untested due to lack of hardware.

6 files changed, 1119 insertions, 7 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 0312b19b682..f7b49bc3145 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.426 2007/09/07 19:19:53 kettenis Exp $
+#	$OpenBSD: Makefile,v 1.427 2007/09/08 02:15:52 jsg Exp $
 
 MAN=	aac.4 ac97.4 acphy.4 \
 	acpi.4 acpiac.4 acpibat.4 acpibtn.4 acpicpu.4 acpidock.4 \
@@ -45,7 +45,7 @@ MAN=	aac.4 ac97.4 acphy.4 \
 	stp.4 sv.4 systrace.4 tcic.4 tcp.4 termios.4 tht.4 ti.4 tl.4 \
 	tlphy.4 tqphy.4 trm.4 trunk.4 tsl.4 tty.4 tun.4 twe.4 txp.4 \
 	txphy.4 uaudio.4 uark.4 uath.4 uberry.4 ubsa.4 ubsec.4 ubt.4 \
-	ucom.4 ucycom.4 udav.4 udcf.4 udp.4 udsbr.4 \
+	ucom.4 uchcom.4 ucycom.4 udav.4 udcf.4 udp.4 udsbr.4 \
 	ueagle.4 uftdi.4 ugen.4 uhci.4 uhid.4 uhidev.4 uipaq.4 uk.4 ukbd.4 \
 	ukphy.4 ulpt.4 umass.4 umct.4 umidi.4 umodem.4 ums.4 umsm.4 \
 	unix.4 uow.4 upl.4 uplcom.4 urio.4 url.4 urlphy.4 usb.4 usbf.4 \
diff --git a/share/man/man4/uchcom.4 b/share/man/man4/uchcom.4
new file mode 100644
index 00000000000..f10cc16c2f3
--- /dev/null
+++ b/share/man/man4/uchcom.4
@@ -0,0 +1,51 @@
+.\"	$OpenBSD: uchcom.4,v 1.1 2007/09/08 02:15:52 jsg Exp $
+.\"
+.\" Copyright (c) 2007 Jonathan Gray <jsg@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: September 8 2007 $
+.Dt UCHCOM 4
+.Os
+.Sh NAME
+.Nm uchcom
+.Nd WinChipHead CH341/340 based USB serial adapter
+.Sh SYNOPSIS
+.Cd "uchcom* at uhub?"
+.Cd "ucom* at uchcom?"
+.Sh DESCRIPTION
+The
+.Nm
+driver supports WinChipHead CH341/340 serial devices.
+.Sh SEE ALSO
+.Xr tty 4 ,
+.Xr ucom 4 ,
+.Xr uhub 4 ,
+.Xr usb 4
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Ox 4.3 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Takuya SHIOZAKI
+.Aq tshiozak@netbsd.org
+and ported to
+.Ox
+by
+.An Jonathan Gray
+.Aq jsg@openbsd.org .
diff --git a/share/man/man4/ucom.4 b/share/man/man4/ucom.4
index 00e912ab3c9..ebac552428d 100644
--- a/share/man/man4/ucom.4
+++ b/share/man/man4/ucom.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ucom.4,v 1.21 2007/05/31 19:19:52 jmc Exp $
+.\" $OpenBSD: ucom.4,v 1.22 2007/09/08 02:15:52 jsg Exp $
 .\" $NetBSD: ucom.4,v 1.3 2000/04/14 14:55:18 augustss Exp $
 .\"
 .\" Copyright (c) 1999 The NetBSD Foundation, Inc.
@@ -35,7 +35,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: May 31 2007 $
+.Dd $Mdocdate: September 8 2007 $
 .Dt UCOM 4
 .Os
 .Sh NAME
@@ -44,6 +44,7 @@
 .Sh SYNOPSIS
 .Cd "ucom* at uark?"
 .Cd "ucom* at ubsa?"
+.Cd "ucom* at uchcom?"
 .Cd "ucom* at ucycom?"
 .Cd "ucom* at uftdi?"
 .Cd "ucom* at uipaq?"
diff --git a/share/man/man4/usb.4 b/share/man/man4/usb.4
index e75a97ab410..e5e7a9bb5e0 100644
--- a/share/man/man4/usb.4
+++ b/share/man/man4/usb.4
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: usb.4,v 1.91 2007/06/20 14:24:40 mbalmer Exp $
+.\"	$OpenBSD: usb.4,v 1.92 2007/09/08 02:15:52 jsg Exp $
 .\"	$NetBSD: usb.4,v 1.15 1999/07/29 14:20:32 augustss Exp $
 .\"
 .\" Copyright (c) 1999 The NetBSD Foundation, Inc.
@@ -35,7 +35,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: June 20 2007 $
+.Dd $Mdocdate: September 8 2007 $
 .Dt USB 4
 .Os
 .Sh NAME
@@ -168,6 +168,8 @@ Arkmicro Technologies ARK3116 based USB serial adapter
 Belkin USB serial adapter
 .It Xr ucom 4
 USB tty support
+.It Xr uchcom 4
+WinChipHead CH341/340 based USB serial adapter
 .It Xr ucycom 4
 Cypress microcontroller based USB serial adapter
 .It Xr uftdi 4
diff --git a/sys/dev/usb/files.usb b/sys/dev/usb/files.usb
index 99aa3fbe8ce..680f2c22fb1 100644
--- a/sys/dev/usb/files.usb
+++ b/sys/dev/usb/files.usb
@@ -1,4 +1,4 @@
-#	$OpenBSD: files.usb,v 1.70 2007/05/30 12:16:24 gwk Exp $
+#	$OpenBSD: files.usb,v 1.71 2007/09/08 02:15:52 jsg 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.
@@ -232,6 +232,11 @@ device	umsm: ucombus
 attach	umsm at uhub
 file	dev/usb/umsm.c			umsm
 
+# WinChipHead CH341/340 serial
+device	uchcom: ucombus
+attach	uchcom at uhub
+file	dev/usb/uchcom.c		uchcom
+
 # Scanners
 # Generic scanner support
 device	uscanner
diff --git a/sys/dev/usb/uchcom.c b/sys/dev/usb/uchcom.c
new file mode 100644
index 00000000000..940c02af824
--- /dev/null
+++ b/sys/dev/usb/uchcom.c
@@ -0,0 +1,1053 @@
+/*	$OpenBSD: uchcom.c,v 1.1 2007/09/08 02:15:52 jsg Exp $	*/
+/*	$NetBSD: uchcom.c,v 1.1 2007/09/03 17:57:37 tshiozak Exp $	*/
+
+/*
+ * Copyright (c) 2007 The NetBSD Foundation, Inc.
+ * All rights reserved.
+ *
+ * This code is derived from software contributed to The NetBSD Foundation
+ * by Takuya SHIOZAKI (tshiozak@netbsd.org).
+ *
+ * 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 the NetBSD
+ *        Foundation, Inc. and its contributors.
+ * 4. Neither the name of The NetBSD Foundation nor the names of its
+ *    contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
+ */
+
+/*
+ * driver for WinChipHead CH341/340, the worst USB-serial chip in the world.
+ */
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/kernel.h>
+#include <sys/malloc.h>
+#include <sys/conf.h>
+#include <sys/tty.h>
+#include <sys/device.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/ucomvar.h>
+
+#ifdef UCHCOM_DEBUG
+#define DPRINTFN(n, x)  if (uchcomdebug > (n)) logprintf x
+int	uchcomdebug = 0;
+#else
+#define DPRINTFN(n, x)
+#endif
+#define DPRINTF(x) DPRINTFN(0, x)
+
+#define	UCHCOM_IFACE_INDEX	0
+#define	UCHCOM_CONFIG_INDEX	0
+
+#define UCHCOM_REV_CH340	0x0250
+#define UCHCOM_INPUT_BUF_SIZE	8
+
+#define UCHCOM_REQ_GET_VERSION	0x5F
+#define UCHCOM_REQ_READ_REG	0x95
+#define UCHCOM_REQ_WRITE_REG	0x9A
+#define UCHCOM_REQ_RESET	0xA1
+#define UCHCOM_REQ_SET_DTRRTS	0xA4
+
+#define UCHCOM_REG_STAT1	0x06
+#define UCHCOM_REG_STAT2	0x07
+#define UCHCOM_REG_BPS_PRE	0x12
+#define UCHCOM_REG_BPS_DIV	0x13
+#define UCHCOM_REG_BPS_MOD	0x14
+#define UCHCOM_REG_BPS_PAD	0x0F
+#define UCHCOM_REG_BREAK1	0x05
+#define UCHCOM_REG_BREAK2	0x18
+#define UCHCOM_REG_LCR1		0x18
+#define UCHCOM_REG_LCR2		0x25
+
+#define UCHCOM_VER_20		0x20
+
+#define UCHCOM_BASE_UNKNOWN	0
+#define UCHCOM_BPS_MOD_BASE	20000000
+#define UCHCOM_BPS_MOD_BASE_OFS	1100
+
+#define UCHCOM_DTR_MASK		0x20
+#define UCHCOM_RTS_MASK		0x40
+
+#define UCHCOM_BRK1_MASK	0x01
+#define UCHCOM_BRK2_MASK	0x40
+
+#define UCHCOM_LCR1_MASK	0xAF
+#define UCHCOM_LCR2_MASK	0x07
+#define UCHCOM_LCR1_PARENB	0x80
+#define UCHCOM_LCR2_PAREVEN	0x07
+#define UCHCOM_LCR2_PARODD	0x06
+#define UCHCOM_LCR2_PARMARK	0x05
+#define UCHCOM_LCR2_PARSPACE	0x04
+
+#define UCHCOM_INTR_STAT1	0x02
+#define UCHCOM_INTR_STAT2	0x03
+#define UCHCOM_INTR_LEAST	4
+
+#define UCHCOMIBUFSIZE 256
+#define UCHCOMOBUFSIZE 256
+
+struct uchcom_softc
+{
+	struct device		 sc_dev;
+	usbd_device_handle	 sc_udev;
+	struct device		*sc_subdev;
+	usbd_interface_handle	 sc_iface;
+	int			 sc_dying;
+	/* */
+	int			 sc_intr_endpoint;
+	int			 sc_intr_size;
+	usbd_pipe_handle	 sc_intr_pipe;
+	u_char			*sc_intr_buf;
+	/* */
+	uint8_t			 sc_version;
+	int			 sc_dtr;
+	int			 sc_rts;
+	u_char			 sc_lsr;
+	u_char			 sc_msr;
+	int			 sc_lcr1;
+	int			 sc_lcr2;
+};
+
+struct uchcom_endpoints
+{
+	int		ep_bulkin;
+	int		ep_bulkout;
+	int		ep_intr;
+	int		ep_intr_size;
+};
+
+struct uchcom_divider
+{
+	uint8_t		dv_prescaler;
+	uint8_t		dv_div;
+	uint8_t		dv_mod;
+};
+
+struct uchcom_divider_record
+{
+	uint32_t		dvr_high;
+	uint32_t		dvr_low;
+	uint32_t		dvr_base_clock;
+	struct uchcom_divider	dvr_divider;
+};
+
+static const struct uchcom_divider_record dividers[] =
+{
+	{  307200, 307200, UCHCOM_BASE_UNKNOWN, { 7, 0xD9, 0 } },
+	{  921600, 921600, UCHCOM_BASE_UNKNOWN, { 7, 0xF3, 0 } },
+	{ 2999999,  23530,             6000000, { 3,    0, 0 } },
+	{   23529,   2942,              750000, { 2,    0, 0 } },
+	{    2941,    368,               93750, { 1,    0, 0 } },
+	{     367,      1,               11719, { 0,    0, 0 } },
+};
+#define NUM_DIVIDERS	(sizeof (dividers) / sizeof (dividers[0]))
+
+void		uchcom_get_status(void *, int, u_char *, u_char *);
+void		uchcom_set(void *, int, int, int);
+int		uchcom_param(void *, int, struct termios *);
+int		uchcom_open(void *, int);
+void		uchcom_close(void *, int);
+void		uchcom_intr(usbd_xfer_handle, usbd_private_handle,
+		    usbd_status);
+
+int		set_config(struct uchcom_softc *);
+int		find_ifaces(struct uchcom_softc *, usbd_interface_handle *);
+int		find_endpoints(struct uchcom_softc *,
+		    struct uchcom_endpoints *);
+void		close_intr_pipe(struct uchcom_softc *);
+
+
+usbd_status 	generic_control_out(struct uchcom_softc *sc, uint8_t reqno,
+		    uint16_t value, uint16_t index);
+usbd_status	generic_control_in(struct uchcom_softc *, uint8_t, 
+		    uint16_t, uint16_t, void *, int, int *);
+usbd_status	write_reg(struct uchcom_softc *, uint8_t, uint8_t, uint8_t,
+		    uint8_t); 
+usbd_status	read_reg(struct uchcom_softc *, uint8_t, uint8_t *, uint8_t,
+		    uint8_t *);
+usbd_status	get_version(struct uchcom_softc *, uint8_t *); 
+usbd_status	get_status(struct uchcom_softc *, uint8_t *);
+usbd_status	set_dtrrts_10(struct uchcom_softc *, uint8_t);
+usbd_status	set_dtrrts_20(struct uchcom_softc *, uint8_t);
+int		update_version(struct uchcom_softc *);
+void		convert_status(struct uchcom_softc *, uint8_t);
+int		update_status(struct uchcom_softc *);
+int		set_dtrrts(struct uchcom_softc *, int, int);
+int		set_break(struct uchcom_softc *, int);
+int		calc_divider_settings(struct uchcom_divider *, uint32_t);
+int		set_dte_rate(struct uchcom_softc *, uint32_t);
+int		set_line_control(struct uchcom_softc *, tcflag_t);
+int		clear_chip(struct uchcom_softc *);
+int		reset_chip(struct uchcom_softc *);
+int		setup_comm(struct uchcom_softc *);
+int		setup_intr_pipe(struct uchcom_softc *);
+
+
+int		uchcom_match(struct device *, void *, void *); 
+void		uchcom_attach(struct device *, struct device *, void *); 
+int		uchcom_detach(struct device *, int); 
+int		uchcom_activate(struct device *, enum devact);
+
+struct	ucom_methods uchcom_methods = {
+	.ucom_get_status	= uchcom_get_status,
+	.ucom_set		= uchcom_set,
+	.ucom_param		= uchcom_param,
+	.ucom_ioctl		= NULL,
+	.ucom_open		= uchcom_open,
+	.ucom_close		= uchcom_close,
+	.ucom_read		= NULL,
+	.ucom_write		= NULL,
+};
+
+static const struct usb_devno uchcom_devs[] = {
+	{ USB_VENDOR_WCH, USB_PRODUCT_WCH_CH341 },
+};
+#define uchcom_lookup(v, p)	usb_lookup(uchcom_devs, v, p)
+
+struct cfdriver uchcom_cd = { 
+	NULL, "uchcom", DV_DULL 
+}; 
+
+const struct cfattach uchcom_ca = { 
+	sizeof(struct uchcom_softc), 
+	uchcom_match, 
+	uchcom_attach, 
+	uchcom_detach, 
+	uchcom_activate, 
+};
+
+/* ----------------------------------------------------------------------
+ * driver entry points
+ */
+
+int
+uchcom_match(struct device *parent, void *match, void *aux)
+{
+	struct usb_attach_arg *uaa = aux;
+
+	if (uaa->iface != NULL)
+		return UMATCH_NONE;
+
+	return (uchcom_lookup(uaa->vendor, uaa->product) != NULL ?
+		UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
+}
+
+void
+uchcom_attach(struct device *parent, struct device *self, void *aux)
+{
+	struct uchcom_softc *sc = (struct uchcom_softc *)self;
+	struct usb_attach_arg *uaa = aux;
+	struct ucom_attach_args uca;
+	usbd_device_handle dev = uaa->device;
+	char *devinfop;
+	struct uchcom_endpoints endpoints;
+
+	devinfop = usbd_devinfo_alloc(dev, 0);
+	printf("\n%s: %s", sc->sc_dev.dv_xname, devinfop);
+	usbd_devinfo_free(devinfop);
+
+        sc->sc_udev = dev;
+	sc->sc_dying = 0;
+	sc->sc_dtr = sc->sc_rts = -1;
+	sc->sc_lsr = sc->sc_msr = 0;
+
+	DPRINTF(("\n\nuchcom attach: sc=%p\n", sc));
+
+	if (set_config(sc))
+		goto failed;
+
+	switch (uaa->release) {
+	case UCHCOM_REV_CH340:
+		printf(": CH340\n");
+		break;
+	default:
+		printf(": CH341\n");
+		break;
+	}
+
+	if (find_ifaces(sc, &sc->sc_iface))
+		goto failed;
+
+	if (find_endpoints(sc, &endpoints))
+		goto failed;
+
+	sc->sc_intr_endpoint = endpoints.ep_intr;
+	sc->sc_intr_size = endpoints.ep_intr_size;
+
+	/* setup ucom layer */
+	uca.portno = UCOM_UNK_PORTNO;
+	uca.bulkin = endpoints.ep_bulkin;
+	uca.bulkout = endpoints.ep_bulkout;
+	uca.ibufsize = UCHCOMIBUFSIZE;
+	uca.obufsize = UCHCOMOBUFSIZE;
+	uca.ibufsizepad = UCHCOMIBUFSIZE;
+	uca.opkthdrlen = 0;
+	uca.device = dev;
+	uca.iface = sc->sc_iface;
+	uca.methods = &uchcom_methods;
+	uca.arg = sc;
+	uca.info = NULL;
+
+	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
+	    &sc->sc_dev);
+	
+	sc->sc_subdev = config_found_sm(self, &uca, ucomprint, ucomsubmatch);
+
+	return;
+
+failed:
+	sc->sc_dying = 1;
+}
+
+int
+uchcom_detach(struct device *self, int flags)
+{
+	struct uchcom_softc *sc = (struct uchcom_softc *)self;
+	int rv = 0;
+
+	DPRINTF(("uchcom_detach: sc=%p flags=%d\n", sc, flags));
+
+	close_intr_pipe(sc);
+
+	sc->sc_dying = 1;
+
+	if (sc->sc_subdev != NULL) {
+		rv = config_detach(sc->sc_subdev, flags);
+		sc->sc_subdev = NULL;
+	}
+
+	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
+			   &sc->sc_dev);
+
+	return rv;
+}
+
+int
+uchcom_activate(struct device *self, enum devact act)
+{
+	struct uchcom_softc *sc = (struct uchcom_softc *)self;
+	int rv = 0;
+
+	switch (act) {
+	case DVACT_ACTIVATE:
+		rv = EOPNOTSUPP;
+		break;
+	case DVACT_DEACTIVATE:
+		close_intr_pipe(sc);
+		sc->sc_dying = 1;
+		if (sc->sc_subdev != NULL)
+			rv = config_deactivate(sc->sc_subdev);
+		break;
+	}
+	return rv;
+}
+
+int
+set_config(struct uchcom_softc *sc)
+{
+	usbd_status err;
+
+	err = usbd_set_config_index(sc->sc_udev, UCHCOM_CONFIG_INDEX, 1);
+	if (err) {
+		printf("%s: failed to set configuration: %s\n",
+		       sc->sc_dev.dv_xname, usbd_errstr(err));
+		return -1;
+	}
+
+	return 0;
+}
+
+int
+find_ifaces(struct uchcom_softc *sc, usbd_interface_handle *riface)
+{
+	usbd_status err;
+
+	err = usbd_device2interface_handle(sc->sc_udev, UCHCOM_IFACE_INDEX,
+					   riface);
+	if (err) {
+		printf("\n%s: failed to get interface: %s\n",
+			sc->sc_dev.dv_xname, usbd_errstr(err));
+		return -1;
+	}
+
+	return 0;
+}
+
+int
+find_endpoints(struct uchcom_softc *sc, struct uchcom_endpoints *endpoints)
+{
+	int i, bin=-1, bout=-1, intr=-1, isize=0;
+	usb_interface_descriptor_t *id;
+	usb_endpoint_descriptor_t *ed;
+
+	id = usbd_get_interface_descriptor(sc->sc_iface);
+
+	for (i = 0; i < id->bNumEndpoints; i++) {
+		ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
+		if (ed == NULL) {
+			printf("%s: no endpoint descriptor for %d\n",
+				sc->sc_dev.dv_xname, i);
+			return -1;
+		}
+
+		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
+		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
+			intr = ed->bEndpointAddress;
+			isize = UGETW(ed->wMaxPacketSize);
+		} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
+			   UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
+			bin = ed->bEndpointAddress;
+		} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
+			   UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
+			bout = ed->bEndpointAddress;
+		}
+	}
+
+	if (intr == -1 || bin == -1 || bout == -1) {
+		if (intr == -1) {
+			printf("%s: no interrupt end point\n",
+			       sc->sc_dev.dv_xname);
+		}
+		if (bin == -1) {
+			printf("%s: no data bulk in end point\n",
+			       sc->sc_dev.dv_xname);
+		}
+		if (bout == -1) {
+			printf("%s: no data bulk out end point\n",
+			       sc->sc_dev.dv_xname);
+		}
+		return -1;
+	}
+	if (isize < UCHCOM_INTR_LEAST) {
+		printf("%s: intr pipe is too short", sc->sc_dev.dv_xname);
+		return -1;
+	}
+
+	DPRINTF(("%s: bulkin=%d, bulkout=%d, intr=%d, isize=%d\n",
+		 sc->sc_dev.dv_xname, bin, bout, intr, isize));
+
+	endpoints->ep_intr = intr;
+	endpoints->ep_intr_size = isize;
+	endpoints->ep_bulkin = bin;
+	endpoints->ep_bulkout = bout;
+
+	return 0;
+}
+
+
+/* ----------------------------------------------------------------------
+ * low level i/o
+ */
+
+usbd_status
+generic_control_out(struct uchcom_softc *sc, uint8_t reqno,
+    uint16_t value, uint16_t index)
+{
+	usb_device_request_t req;
+
+	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
+	req.bRequest = reqno;
+	USETW(req.wValue, value);
+	USETW(req.wIndex, index);
+	USETW(req.wLength, 0);
+
+	return usbd_do_request(sc->sc_udev, &req, 0);
+}
+
+usbd_status
+generic_control_in(struct uchcom_softc *sc, uint8_t reqno,
+    uint16_t value, uint16_t index, void *buf, int buflen, int *actlen)
+{
+	usb_device_request_t req;
+
+	req.bmRequestType = UT_READ_VENDOR_DEVICE;
+	req.bRequest = reqno;
+	USETW(req.wValue, value);
+	USETW(req.wIndex, index);
+	USETW(req.wLength, (uint16_t)buflen);
+
+	return usbd_do_request_flags(sc->sc_udev, &req, buf,
+				     USBD_SHORT_XFER_OK, actlen,
+				     USBD_DEFAULT_TIMEOUT);
+}
+
+usbd_status
+write_reg(struct uchcom_softc *sc,
+    uint8_t reg1, uint8_t val1, uint8_t reg2, uint8_t val2)
+{
+	DPRINTF(("uchcom: write reg 0x%02X<-0x%02X, 0x%02X<-0x%02X\n",
+		 (unsigned)reg1, (unsigned)val1,
+		 (unsigned)reg2, (unsigned)val2));
+	return generic_control_out(
+		sc, UCHCOM_REQ_WRITE_REG,
+		reg1|((uint16_t)reg2<<8), val1|((uint16_t)val2<<8));
+}
+
+usbd_status
+read_reg(struct uchcom_softc *sc,
+    uint8_t reg1, uint8_t *rval1, uint8_t reg2, uint8_t *rval2)
+{
+	uint8_t buf[UCHCOM_INPUT_BUF_SIZE];
+	usbd_status err;
+	int actin;
+
+	err = generic_control_in(
+		sc, UCHCOM_REQ_READ_REG,
+		reg1|((uint16_t)reg2<<8), 0, buf, sizeof buf, &actin);
+	if (err)
+		return err;
+
+	DPRINTF(("uchcom: read reg 0x%02X->0x%02X, 0x%02X->0x%02X\n",
+		 (unsigned)reg1, (unsigned)buf[0],
+		 (unsigned)reg2, (unsigned)buf[1]));
+
+	if (rval1) *rval1 = buf[0];
+	if (rval2) *rval2 = buf[1];
+
+	return USBD_NORMAL_COMPLETION;
+}
+
+usbd_status
+get_version(struct uchcom_softc *sc, uint8_t *rver)
+{
+	uint8_t buf[UCHCOM_INPUT_BUF_SIZE];
+	usbd_status err;
+	int actin;
+
+	err = generic_control_in(
+		sc, UCHCOM_REQ_GET_VERSION, 0, 0, buf, sizeof buf, &actin);
+	if (err)
+		return err;
+
+	if (rver) *rver = buf[0];
+
+	return USBD_NORMAL_COMPLETION;
+}
+
+usbd_status
+get_status(struct uchcom_softc *sc, uint8_t *rval)
+{
+	return read_reg(sc, UCHCOM_REG_STAT1, rval, UCHCOM_REG_STAT2, NULL);
+}
+
+usbd_status
+set_dtrrts_10(struct uchcom_softc *sc, uint8_t val)
+{
+	return write_reg(sc, UCHCOM_REG_STAT1, val, UCHCOM_REG_STAT1, val);
+}
+
+usbd_status
+set_dtrrts_20(struct uchcom_softc *sc, uint8_t val)
+{
+	return generic_control_out(sc, UCHCOM_REQ_SET_DTRRTS, val, 0);
+}
+
+
+/* ----------------------------------------------------------------------
+ * middle layer
+ */
+
+int
+update_version(struct uchcom_softc *sc)
+{
+	usbd_status err;
+
+	err = get_version(sc, &sc->sc_version);
+	if (err) {
+		printf("%s: cannot get version: %s\n",
+		       sc->sc_dev.dv_xname, usbd_errstr(err));
+		return EIO;
+	}
+
+	return 0;
+}
+
+void
+convert_status(struct uchcom_softc *sc, uint8_t cur)
+{
+	sc->sc_dtr = !(cur & UCHCOM_DTR_MASK);
+	sc->sc_rts = !(cur & UCHCOM_RTS_MASK);
+
+	cur = ~cur & 0x0F;
+	sc->sc_msr = (cur << 4) | ((sc->sc_msr >> 4) ^ cur);
+}
+
+int
+update_status(struct uchcom_softc *sc)
+{
+	usbd_status err;
+	uint8_t cur;
+
+	err = get_status(sc, &cur);
+	if (err) {
+		printf("%s: cannot update status: %s\n",
+		       sc->sc_dev.dv_xname, usbd_errstr(err));
+		return EIO;
+	}
+	convert_status(sc, cur);
+
+	return 0;
+}
+
+
+int
+set_dtrrts(struct uchcom_softc *sc, int dtr, int rts)
+{
+	usbd_status err;
+	uint8_t val = 0;
+
+	if (dtr) val |= UCHCOM_DTR_MASK;
+	if (rts) val |= UCHCOM_RTS_MASK;
+
+	if (sc->sc_version < UCHCOM_VER_20)
+		err = set_dtrrts_10(sc, ~val);
+	else
+		err = set_dtrrts_20(sc, ~val);
+
+	if (err) {
+		printf("%s: cannot set DTR/RTS: %s\n",
+		       sc->sc_dev.dv_xname, usbd_errstr(err));
+		return EIO;
+	}
+
+	return 0;
+}
+
+int
+set_break(struct uchcom_softc *sc, int onoff)
+{
+	usbd_status err;
+	uint8_t brk1, brk2;
+
+	err = read_reg(sc, UCHCOM_REG_BREAK1, &brk1, UCHCOM_REG_BREAK2, &brk2);
+	if (err)
+		return EIO;
+	if (onoff) {
+		/* on - clear bits */
+		brk1 &= ~UCHCOM_BRK1_MASK;
+		brk2 &= ~UCHCOM_BRK2_MASK;
+	} else {
+		/* off - set bits */
+		brk1 |= UCHCOM_BRK1_MASK;
+		brk2 |= UCHCOM_BRK2_MASK;
+	}
+	err = write_reg(sc, UCHCOM_REG_BREAK1, brk1, UCHCOM_REG_BREAK2, brk2);
+	if (err)
+		return EIO;
+
+	return 0;
+}
+
+int
+calc_divider_settings(struct uchcom_divider *dp, uint32_t rate)
+{
+	int i;
+	const struct uchcom_divider_record *rp;
+	uint32_t div, rem, mod;
+
+	/* find record */
+	for (i=0; i<NUM_DIVIDERS; i++) {
+		if (dividers[i].dvr_high >= rate &&
+		    dividers[i].dvr_low <= rate) {
+			rp = &dividers[i];
+			goto found;
+		}
+	}
+	return -1;
+
+found:
+	dp->dv_prescaler = rp->dvr_divider.dv_prescaler;
+	if (rp->dvr_base_clock == UCHCOM_BASE_UNKNOWN)
+		dp->dv_div = rp->dvr_divider.dv_div;
+	else {
+		div = rp->dvr_base_clock / rate;
+		rem = rp->dvr_base_clock % rate;
+		if (div==0 || div>=0xFF)
+			return -1;
+		if ((rem<<1) >= rate)
+			div += 1;
+		dp->dv_div = (uint8_t)-div;
+	}
+
+	mod = UCHCOM_BPS_MOD_BASE/rate + UCHCOM_BPS_MOD_BASE_OFS;
+	mod = mod + mod/2;
+
+	dp->dv_mod = mod / 0x100;
+
+	return 0;
+}
+
+int
+set_dte_rate(struct uchcom_softc *sc, uint32_t rate)
+{
+	usbd_status err;
+	struct uchcom_divider dv;
+
+	if (calc_divider_settings(&dv, rate))
+		return EINVAL;
+
+	if ((err = write_reg(sc,
+			     UCHCOM_REG_BPS_PRE, dv.dv_prescaler,
+			     UCHCOM_REG_BPS_DIV, dv.dv_div)) ||
+	    (err = write_reg(sc,
+			     UCHCOM_REG_BPS_MOD, dv.dv_mod,
+			     UCHCOM_REG_BPS_PAD, 0))) {
+		printf("%s: cannot set DTE rate: %s\n",
+		       sc->sc_dev.dv_xname, usbd_errstr(err));
+		return EIO;
+	}
+
+	return 0;
+}
+
+int
+set_line_control(struct uchcom_softc *sc, tcflag_t cflag)
+{
+	usbd_status err;
+	uint8_t lcr1 = 0, lcr2 = 0;
+
+	err = read_reg(sc, UCHCOM_REG_LCR1, &lcr1, UCHCOM_REG_LCR2, &lcr2);
+	if (err) {
+		printf("%s: cannot get LCR: %s\n",
+		       sc->sc_dev.dv_xname, usbd_errstr(err));
+		return EIO;
+	}
+
+	lcr1 &= ~UCHCOM_LCR1_MASK;
+	lcr2 &= ~UCHCOM_LCR2_MASK;
+
+	/*
+	 * XXX: it is difficult to handle the line control appropriately:
+	 *   - CS8, !CSTOPB and any parity mode seems ok, but
+	 *   - the chip doesn't have the function to calculate parity
+	 *     in !CS8 mode.
+	 *   - it is unclear that the chip supports CS5,6 mode.
+	 *   - it is unclear how to handle stop bits.
+	 */
+
+	switch (ISSET(cflag, CSIZE)) {
+	case CS5:
+	case CS6:
+	case CS7:
+		return EINVAL;
+	case CS8:
+		break;
+	}
+
+	if (ISSET(cflag, PARENB)) {
+		lcr1 |= UCHCOM_LCR1_PARENB;
+		if (ISSET(cflag, PARODD))
+			lcr2 |= UCHCOM_LCR2_PARODD;
+		else
+			lcr2 |= UCHCOM_LCR2_PAREVEN;
+	}
+
+	err = write_reg(sc, UCHCOM_REG_LCR1, lcr1, UCHCOM_REG_LCR2, lcr2);
+	if (err) {
+		printf("%s: cannot set LCR: %s\n",
+		       sc->sc_dev.dv_xname, usbd_errstr(err));
+		return EIO;
+	}
+
+	return 0;
+}
+
+int
+clear_chip(struct uchcom_softc *sc)
+{
+	usbd_status err;
+
+	DPRINTF(("%s: clear\n", sc->sc_dev.dv_xname));
+	err = generic_control_out(sc, UCHCOM_REQ_RESET, 0, 0);
+	if (err) {
+		printf("%s: cannot clear: %s\n",
+		       sc->sc_dev.dv_xname, usbd_errstr(err));
+		return EIO;
+	}
+
+	return 0;
+}
+
+int
+reset_chip(struct uchcom_softc *sc)
+{
+	usbd_status err;
+	uint8_t lcr1, lcr2, pre, div, mod;
+	uint16_t val=0, idx=0;
+
+	err = read_reg(sc, UCHCOM_REG_LCR1, &lcr1, UCHCOM_REG_LCR2, &lcr2);
+	if (err)
+		goto failed;
+
+	err = read_reg(sc, UCHCOM_REG_BPS_PRE, &pre, UCHCOM_REG_BPS_DIV, &div);
+	if (err)
+		goto failed;
+
+	err = read_reg(sc, UCHCOM_REG_BPS_MOD, &mod, UCHCOM_REG_BPS_PAD, NULL);
+	if (err)
+		goto failed;
+
+	val |= (uint16_t)(lcr1&0xF0) << 8;
+	val |= 0x01;
+	val |= (uint16_t)(lcr2&0x0F) << 8;
+	val |= 0x02;
+	idx |= pre & 0x07;
+	val |= 0x04;
+	idx |= (uint16_t)div << 8;
+	val |= 0x08;
+	idx |= mod & 0xF8;
+	val |= 0x10;
+
+	DPRINTF(("%s: reset v=0x%04X, i=0x%04X\n",
+		 sc->sc_dev.dv_xname, val, idx));
+
+	err = generic_control_out(sc, UCHCOM_REQ_RESET, val, idx);
+	if (err)
+		goto failed;
+
+	return 0;
+
+failed:
+	printf("%s: cannot reset: %s\n",
+	       sc->sc_dev.dv_xname, usbd_errstr(err));
+	return EIO;
+}
+
+int
+setup_comm(struct uchcom_softc *sc)
+{
+	int ret;
+
+	ret = update_version(sc);
+	if (ret)
+		return ret;
+
+	ret = clear_chip(sc);
+	if (ret)
+		return ret;
+
+	ret = set_dte_rate(sc, TTYDEF_SPEED);
+	if (ret)
+		return ret;
+
+	ret = set_line_control(sc, CS8);
+	if (ret)
+		return ret;
+
+	ret = update_status(sc);
+	if (ret)
+		return ret;
+
+	ret = reset_chip(sc);
+	if (ret)
+		return ret;
+
+	ret = set_dte_rate(sc, TTYDEF_SPEED); /* XXX */
+	if (ret)
+		return ret;
+
+	sc->sc_dtr = sc->sc_rts = 1;
+	ret = set_dtrrts(sc, sc->sc_dtr, sc->sc_rts);
+	if (ret)
+		return ret;
+
+	return 0;
+}
+
+int
+setup_intr_pipe(struct uchcom_softc *sc)
+{
+	usbd_status err;
+
+	if (sc->sc_intr_endpoint != -1 && sc->sc_intr_pipe == NULL) {
+		sc->sc_intr_buf = malloc(sc->sc_intr_size, M_USBDEV, M_WAITOK);
+		err = usbd_open_pipe_intr(sc->sc_iface,
+					  sc->sc_intr_endpoint,
+					  USBD_SHORT_XFER_OK,
+					  &sc->sc_intr_pipe, sc,
+					  sc->sc_intr_buf,
+					  sc->sc_intr_size,
+					  uchcom_intr, USBD_DEFAULT_INTERVAL);
+		if (err) {
+			printf("%s: cannot open interrupt pipe: %s\n",
+			       sc->sc_dev.dv_xname,
+			       usbd_errstr(err));
+			return EIO;
+		}
+	}
+	return 0;
+}
+
+void
+close_intr_pipe(struct uchcom_softc *sc)
+{
+	usbd_status err;
+
+	if (sc->sc_dying)
+		return;
+
+	if (sc->sc_intr_pipe != NULL) {
+		err = usbd_abort_pipe(sc->sc_intr_pipe);
+		if (err)
+			printf("%s: abort interrupt pipe failed: %s\n",
+			       sc->sc_dev.dv_xname, usbd_errstr(err));
+		err = usbd_close_pipe(sc->sc_intr_pipe);
+		if (err)
+			printf("%s: close interrupt pipe failed: %s\n",
+			       sc->sc_dev.dv_xname, usbd_errstr(err));
+		free(sc->sc_intr_buf, M_USBDEV);
+		sc->sc_intr_pipe = NULL;
+	}
+}
+
+
+/* ----------------------------------------------------------------------
+ * methods for ucom
+ */
+void
+uchcom_get_status(void *arg, int portno, u_char *rlsr, u_char *rmsr)
+{
+	struct uchcom_softc *sc = arg;
+
+	if (sc->sc_dying)
+		return;
+
+	*rlsr = sc->sc_lsr;
+	*rmsr = sc->sc_msr;
+}
+
+void
+uchcom_set(void *arg, int portno, int reg, int onoff)
+{
+	struct uchcom_softc *sc = arg;
+
+	if (sc->sc_dying)
+		return;
+
+	switch (reg) {
+	case UCOM_SET_DTR:
+		sc->sc_dtr = !!onoff;
+		set_dtrrts(sc, sc->sc_dtr, sc->sc_rts);
+		break;
+	case UCOM_SET_RTS:
+		sc->sc_rts = !!onoff;
+		set_dtrrts(sc, sc->sc_dtr, sc->sc_rts);
+		break;
+	case UCOM_SET_BREAK:
+		set_break(sc, onoff);
+		break;
+	}
+}
+
+int
+uchcom_param(void *arg, int portno, struct termios *t)
+{
+	struct uchcom_softc *sc = arg;
+	int ret;
+
+	if (sc->sc_dying)
+		return 0;
+
+	ret = set_line_control(sc, t->c_cflag);
+	if (ret)
+		return ret;
+
+	ret = set_dte_rate(sc, t->c_ospeed);
+	if (ret)
+		return ret;
+
+	return 0;
+}
+
+int
+uchcom_open(void *arg, int portno)
+{
+	int ret;
+	struct uchcom_softc *sc = arg;
+
+	if (sc->sc_dying)
+		return EIO;
+
+	ret = setup_intr_pipe(sc);
+	if (ret)
+		return ret;
+
+	ret = setup_comm(sc);
+	if (ret)
+		return ret;
+
+	return 0;
+}
+
+void
+uchcom_close(void *arg, int portno)
+{
+	struct uchcom_softc *sc = arg;
+
+	if (sc->sc_dying)
+		return;
+
+	close_intr_pipe(sc);
+}
+
+
+/* ----------------------------------------------------------------------
+ * callback when the modem status is changed.
+ */
+void
+uchcom_intr(usbd_xfer_handle xfer, usbd_private_handle priv,
+    usbd_status status)
+{
+	struct uchcom_softc *sc = priv;
+	u_char *buf = sc->sc_intr_buf;
+
+	if (sc->sc_dying)
+		return;
+
+	if (status != USBD_NORMAL_COMPLETION) {
+		if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
+			return;
+
+		DPRINTF(("%s: abnormal status: %s\n",
+			 sc->sc_dev.dv_xname, usbd_errstr(status)));
+		usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
+		return;
+	}
+	DPRINTF(("%s: intr: 0x%02X 0x%02X 0x%02X 0x%02X "
+		 "0x%02X 0x%02X 0x%02X 0x%02X\n",
+		 sc->sc_dev.dv_xname,
+		 (unsigned)buf[0], (unsigned)buf[1],
+		 (unsigned)buf[2], (unsigned)buf[3],
+		 (unsigned)buf[4], (unsigned)buf[5],
+		 (unsigned)buf[6], (unsigned)buf[7]));
+
+	convert_status(sc, buf[UCHCOM_INTR_STAT1]);
+	ucom_status_change((struct ucom_softc *) sc->sc_subdev);
+}