From c2318dc6c6c08ef8875f5f956fe70a1abd0b7b17 Mon Sep 17 00:00:00 2001 From: Hasso Tepper Date: Wed, 7 Nov 2007 09:07:44 +0000 Subject: [PATCH] Add uchcom(4) - the driver for WinChipHead CH341/CH340 chips. Obtained-from: NetBSD --- share/man/man4/Makefile | 3 +- share/man/man4/uchcom.4 | 83 +++ sys/conf/files | 3 +- sys/config/LINT | 3 +- sys/dev/usbmisc/Makefile | 4 +- sys/dev/usbmisc/uchcom/Makefile | 10 + sys/dev/usbmisc/uchcom/uchcom.c | 1028 +++++++++++++++++++++++++++++++ 7 files changed, 1129 insertions(+), 5 deletions(-) create mode 100644 share/man/man4/uchcom.4 create mode 100644 sys/dev/usbmisc/uchcom/Makefile create mode 100644 sys/dev/usbmisc/uchcom/uchcom.c diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index d80039ae5f..cf1b1a9dff 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,6 +1,6 @@ # @(#)Makefile 8.1 (Berkeley) 6/18/93 # $FreeBSD: src/share/man/man4/Makefile,v 1.83.2.66 2003/06/04 17:10:30 sam Exp $ -# $DragonFly: src/share/man/man4/Makefile,v 1.72 2007/11/07 08:57:17 hasso Exp $ +# $DragonFly: src/share/man/man4/Makefile,v 1.73 2007/11/07 09:07:44 hasso Exp $ MAN= aac.4 \ acpi.4 \ @@ -266,6 +266,7 @@ MAN= aac.4 \ uark.4 \ ubsa.4 \ ubsec.4 \ + uchcom.4 \ ucom.4 \ udp.4 \ ufm.4 \ diff --git a/share/man/man4/uchcom.4 b/share/man/man4/uchcom.4 new file mode 100644 index 0000000000..de988862b1 --- /dev/null +++ b/share/man/man4/uchcom.4 @@ -0,0 +1,83 @@ +.\" $NetBSD: uchcom.4,v 1.1 2007/09/03 18:02:17 tshiozak Exp $ +.\" $DragonFly: src/share/man/man4/uchcom.4,v 1.1 2007/11/07 09:07:44 hasso 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. +.\" +.Dd November 11, 2007 +.Dt UCHCOM 4 +.Os +.Sh NAME +.Nm uchcom +.Nd USB support for WinChipHead CH341/CH340 serial adapters driver +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device uchcom" +.Cd "device ucom" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +uchcom_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +driver provides support for the WinChipHead CH341/CH340 USB-to-RS-232 +Bridge chip. +.Pp +The device is accessed through the +.Xr ucom 4 +driver which makes it behave like a +.Xr tty 4 . +.Sh SEE ALSO +.Xr tty 4 , +.Xr ucom 4 , +.Xr usb 4 +.Sh HISTORY +The +.Nm +driver +appeared in +.Nx +5.0 and was imported into +.Dx 1.11 . +.Sh BUGS +Actually, this chip seems unable to drive other than 8 data bits and +1 stop bit line. diff --git a/sys/conf/files b/sys/conf/files index 1c6b4a0d38..6beef57805 100644 --- a/sys/conf/files +++ b/sys/conf/files @@ -1,5 +1,5 @@ # $FreeBSD: src/sys/conf/files,v 1.340.2.137 2003/06/04 17:10:30 sam Exp $ -# $DragonFly: src/sys/conf/files,v 1.189 2007/11/07 08:57:17 hasso Exp $ +# $DragonFly: src/sys/conf/files,v 1.190 2007/11/07 09:07:44 hasso Exp $ # # The long compile-with and dependency lines are required because of # limitations in config: backslash-newline doesn't work in strings, and @@ -1193,6 +1193,7 @@ bus/usb/hid.c optional usb bus/usb/uhub.c optional usb dev/usbmisc/moscom/moscom.c optional moscom ucom dev/usbmisc/uark/uark.c optional uark ucom +dev/usbmisc/uchcom/uchcom.c optional uchcom ucom dev/usbmisc/ufm/ufm.c optional ufm dev/usbmisc/ubsa/ubsa.c optional ubsa ucom dev/usbmisc/uftdi/uftdi.c optional uftdi ucom diff --git a/sys/config/LINT b/sys/config/LINT index 6d0d4b49c0..b8d3a0c785 100644 --- a/sys/config/LINT +++ b/sys/config/LINT @@ -3,7 +3,7 @@ # as much of the source tree as it can. # # $FreeBSD: src/sys/i386/conf/LINT,v 1.749.2.144 2003/06/04 17:56:59 sam Exp $ -# $DragonFly: src/sys/config/LINT,v 1.136 2007/11/07 08:57:17 hasso Exp $ +# $DragonFly: src/sys/config/LINT,v 1.137 2007/11/07 09:07:44 hasso Exp $ # # NB: You probably don't want to try running a kernel built from this # file. Instead, you should start from GENERIC, and add options from @@ -2550,6 +2550,7 @@ device urio device uscanner # USB com devices device moscom +device uchcom device ucom device umct device uplcom diff --git a/sys/dev/usbmisc/Makefile b/sys/dev/usbmisc/Makefile index 26f871feb0..6b7c2b3864 100644 --- a/sys/dev/usbmisc/Makefile +++ b/sys/dev/usbmisc/Makefile @@ -1,7 +1,7 @@ -# $DragonFly: src/sys/dev/usbmisc/Makefile,v 1.7 2007/11/07 08:57:17 hasso Exp $ +# $DragonFly: src/sys/dev/usbmisc/Makefile,v 1.8 2007/11/07 09:07:44 hasso Exp $ # -SUBDIR= moscom uark ubsa ucom ufm uftdi ugen uhid ukbd ulpt umass \ +SUBDIR= moscom uark ubsa uchcom ucom ufm uftdi ugen uhid ukbd ulpt umass \ umodem ums umsm uplcom uscanner uslcom uticom uvisor uvscom umct .include diff --git a/sys/dev/usbmisc/uchcom/Makefile b/sys/dev/usbmisc/uchcom/Makefile new file mode 100644 index 0000000000..48bc67a1af --- /dev/null +++ b/sys/dev/usbmisc/uchcom/Makefile @@ -0,0 +1,10 @@ +# $DragonFly: src/sys/dev/usbmisc/uchcom/Makefile,v 1.1 2007/11/07 09:07:44 hasso Exp $ + +S= ${.CURDIR}/../.. +.PATH: $S/dev/usb + +KMOD= uchcom +SRCS= uchcom.c opt_usb.h device_if.h bus_if.h +NOMAN= + +.include diff --git a/sys/dev/usbmisc/uchcom/uchcom.c b/sys/dev/usbmisc/uchcom/uchcom.c new file mode 100644 index 0000000000..353552ef49 --- /dev/null +++ b/sys/dev/usbmisc/uchcom/uchcom.c @@ -0,0 +1,1028 @@ +/* $NetBSD: uchcom.c,v 1.1 2007/09/03 17:57:37 tshiozak Exp $ */ +/* $DragonFly: src/sys/dev/usbmisc/uchcom/uchcom.c,v 1.1 2007/11/07 09:07:44 hasso 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 +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +#include + +#ifdef UCHCOM_DEBUG +#define DPRINTFN(n, x) do { if (uchcomdebug > (n)) kprintf x; } while (0) +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 ucom_softc sc_ucom; + + 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])) + +static void uchcom_get_status(void *, int, u_char *, u_char *); +static void uchcom_set(void *, int, int, int); +static int uchcom_param(void *, int, struct termios *); +static int uchcom_open(void *, int); +static void uchcom_close(void *, int); +static void uchcom_intr(usbd_xfer_handle, usbd_private_handle, + usbd_status); + +static int set_config(struct uchcom_softc *); +static int find_ifaces(struct uchcom_softc *, usbd_interface_handle *); +static int find_endpoints(struct uchcom_softc *, + struct uchcom_endpoints *); +static void close_intr_pipe(struct uchcom_softc *); + +static device_probe_t uchcom_match; +static device_attach_t uchcom_attach; +static device_detach_t uchcom_detach; + +static device_method_t uchcom_methods[] = { + DEVMETHOD(device_probe, uchcom_match), + DEVMETHOD(device_attach, uchcom_attach), + DEVMETHOD(device_detach, uchcom_detach), + { 0, 0 } +}; + +static driver_t uchcom_driver = { + "ucom", + uchcom_methods, + sizeof (struct uchcom_softc) +}; + +DRIVER_MODULE(uchcom, uhub, uchcom_driver, ucom_devclass, usbd_driver_load, 0); +MODULE_DEPEND(uchcom, usb, 1, 1, 1); +MODULE_DEPEND(uchcom, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER); +MODULE_VERSION(uchcom, 1); + +struct ucom_callback uchcom_callback = { + .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_DEVICE(0x4348, 0x5523) }, /* QinHeng Electronics CH341/340 */ +}; +#define uchcom_lookup(v, p) usb_lookup(uchcom_devs, v, p) + +/* ---------------------------------------------------------------------- + * driver entry points + */ + +static int +uchcom_match(device_t self) +{ + struct usb_attach_arg *uaa = device_get_ivars(self); + + if (uaa->iface != NULL) + return UMATCH_NONE; + + return (uchcom_lookup(uaa->vendor, uaa->product) != NULL ? + UMATCH_VENDOR_PRODUCT : UMATCH_NONE); +} + +static int +uchcom_attach(device_t self) +{ + struct uchcom_softc *sc = device_get_softc(self); + struct usb_attach_arg *uaa = device_get_ivars(self); + struct ucom_softc *ucom = &sc->sc_ucom; + usbd_device_handle dev = uaa->device; + struct uchcom_endpoints endpoints; + + bzero(sc, sizeof (struct uchcom_softc)); + ucom->sc_dev = self; + ucom->sc_udev = dev; + ucom->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: + device_printf(ucom->sc_dev, "CH340\n"); + break; + default: + device_printf(ucom->sc_dev, "CH341\n"); + break; + } + + if (find_ifaces(sc, &ucom->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 */ + ucom->sc_portno = UCOM_UNK_PORTNO; + ucom->sc_bulkin_no = endpoints.ep_bulkin; + ucom->sc_bulkout_no = endpoints.ep_bulkout; + ucom->sc_ibufsize = UCHCOMIBUFSIZE; + ucom->sc_obufsize = UCHCOMOBUFSIZE; + ucom->sc_ibufsizepad = UCHCOMIBUFSIZE; + ucom->sc_opkthdrlen = 0; + ucom->sc_callback = &uchcom_callback; + + usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, ucom->sc_udev, + ucom->sc_dev); + ucom_attach(&sc->sc_ucom); + + return 0; + +failed: + ucom->sc_dying = 1; + return ENXIO; +} + +static int +uchcom_detach(device_t self) +{ + struct uchcom_softc *sc = device_get_softc(self); + int rv = 0; + + DPRINTF(("uchcom_detach: sc=%p flags=%d\n", sc, flags)); + + close_intr_pipe(sc); + sc->sc_ucom.sc_dying = 1; + rv = ucom_detach(&sc->sc_ucom); + usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_ucom.sc_udev, + sc->sc_ucom.sc_dev); + + return rv; +} + +#if 0 /* not yet */ +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: + uchcom_close_intr_pipe(sc); + sc->sc_dying = 1; + if (sc->sc_subdev != NULL) + rv = config_deactivate(sc->sc_subdev); + break; + } + return rv; +} +#endif + +int +set_config(struct uchcom_softc *sc) +{ + usbd_status err; + + err = usbd_set_config_index(sc->sc_ucom.sc_udev, + UCHCOM_CONFIG_INDEX, 1); + if (err) { + device_printf(sc->sc_ucom.sc_dev, "failed to set " + "configuration: %s\n", 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_ucom.sc_udev, + UCHCOM_IFACE_INDEX, riface); + if (err) { + device_printf(sc->sc_ucom.sc_dev, "failed to get interface: " + "%s\n", 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_ucom.sc_iface); + + for (i = 0; i < id->bNumEndpoints; i++) { + ed = usbd_interface2endpoint_descriptor(sc->sc_ucom.sc_iface, + i); + if (ed == NULL) { + device_printf(sc->sc_ucom.sc_dev, + "no endpoint descriptor for %d\n", 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) { + device_printf(sc->sc_ucom.sc_dev, + "no interrupt end point\n"); + } + if (bin == -1) { + device_printf(sc->sc_ucom.sc_dev, + "no data bulk in end point\n"); + } + if (bout == -1) { + device_printf(sc->sc_ucom.sc_dev, + "no data bulk out end point\n"); + } + return -1; + } + if (isize < UCHCOM_INTR_LEAST) { + device_printf(sc->sc_ucom.sc_dev, "intr pipe is too short\n"); + return -1; + } + + DPRINTF(("%s: bulkin=%d, bulkout=%d, intr=%d, isize=%d\n", + device_get_nameunit(sc->sc_ucom.sc_dev), 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 + */ + +static __inline 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_ucom.sc_udev, &req, 0); +} + +static __inline 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_ucom.sc_udev, &req, buf, + USBD_SHORT_XFER_OK, actlen, + USBD_DEFAULT_TIMEOUT); +} + +static __inline 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)); +} + +static __inline 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; +} + +static __inline 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; +} + +static __inline usbd_status +read_status(struct uchcom_softc *sc, uint8_t *rval) +{ + return read_reg(sc, UCHCOM_REG_STAT1, rval, UCHCOM_REG_STAT2, NULL); +} + +static __inline usbd_status +set_dtrrts_10(struct uchcom_softc *sc, uint8_t val) +{ + return write_reg(sc, UCHCOM_REG_STAT1, val, UCHCOM_REG_STAT1, val); +} + +static __inline 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 + */ + +static int +update_version(struct uchcom_softc *sc) +{ + usbd_status err; + + err = get_version(sc, &sc->sc_version); + if (err) { + device_printf(sc->sc_ucom.sc_dev, "cannot get version: %s\n", + usbd_errstr(err)); + return EIO; + } + + return 0; +} + +static 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); +} + +static int +update_status(struct uchcom_softc *sc) +{ + usbd_status err; + uint8_t cur; + + err = read_status(sc, &cur); + if (err) { + device_printf(sc->sc_ucom.sc_dev, "cannot update status: %s\n", + usbd_errstr(err)); + return EIO; + } + convert_status(sc, cur); + + return 0; +} + + +static 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) { + device_printf(sc->sc_ucom.sc_dev, "cannot set DTR/RTS: %s\n", + usbd_errstr(err)); + return EIO; + } + + return 0; +} + +static 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; +} + +static 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= rate && + dividers[i].dvr_low <= rate) { + rp = ÷rs[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; +} + +static 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))) { + device_printf(sc->sc_ucom.sc_dev, "cannot set DTE rate: %s\n", + usbd_errstr(err)); + return EIO; + } + + return 0; +} + +static 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) { + device_printf(sc->sc_ucom.sc_dev, "cannot get LCR: %s\n", + 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) { + device_printf(sc->sc_ucom.sc_dev, "cannot set LCR: %s\n", + usbd_errstr(err)); + return EIO; + } + + return 0; +} + +static 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) { + device_printf(sc->sc_ucom.sc_dev, "cannot clear: %s\n", + usbd_errstr(err)); + return EIO; + } + + return 0; +} + +static 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", + device_get_nameunit(sc->sc_ucom.sc_dev), val, idx)); + + err = generic_control_out(sc, UCHCOM_REQ_RESET, val, idx); + if (err) + goto failed; + + return 0; + +failed: + device_printf(sc->sc_ucom.sc_dev, "cannot reset: %s\n", + usbd_errstr(err)); + return EIO; +} + +static 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; +} + +static 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 = kmalloc(sc->sc_intr_size, M_USBDEV, M_WAITOK); + err = usbd_open_pipe_intr(sc->sc_ucom.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) { + device_printf(sc->sc_ucom.sc_dev, "cannot open " + "interrupt pipe: %s\n", usbd_errstr(err)); + return EIO; + } + } + return 0; +} + +static void +close_intr_pipe(struct uchcom_softc *sc) +{ + usbd_status err; + + if (sc->sc_ucom.sc_dying) + return; + + if (sc->sc_intr_pipe != NULL) { + err = usbd_abort_pipe(sc->sc_intr_pipe); + if (err) + device_printf(sc->sc_ucom.sc_dev, "abort interrupt " + "pipe failed: %s\n", usbd_errstr(err)); + err = usbd_close_pipe(sc->sc_intr_pipe); + if (err) + device_printf(sc->sc_ucom.sc_dev, "close interrupt " + "pipe failed: %s\n", usbd_errstr(err)); + kfree(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_ucom.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_ucom.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_ucom.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_ucom.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_ucom.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_ucom.sc_dying) + return; + + if (status != USBD_NORMAL_COMPLETION) { + if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) + return; + + DPRINTF(("%s: abnormal status: %s\n", + device_get_nameunit(sc->sc_ucom.sc_dev), + 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", + device_get_nameunit(sc->sc_ucom.sc_dev), + (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(&sc->sc_ucom); +} -- 2.41.0