diff options
author | 2014-12-04 11:05:26 +0000 | |
---|---|---|
committer | 2014-12-04 11:05:26 +0000 | |
commit | 1b05564564d89b9a14538c355120b0955d6541b9 (patch) | |
tree | 5d58c3ee3fe24e16c2b7cda2fc4597656b57dd2e | |
parent | regen (diff) | |
download | wireguard-openbsd-1b05564564d89b9a14538c355120b0955d6541b9.tar.xz wireguard-openbsd-1b05564564d89b9a14538c355120b0955d6541b9.zip |
Driver for MosChip Semiconductor 78x0 USB multiport serial adapters.
Ported from FreeBSD via NetBSD, tested on a ST Lab U-400 provided by
weerd@.
ok jsg@
-rw-r--r-- | sys/dev/usb/files.usb | 7 | ||||
-rw-r--r-- | sys/dev/usb/umcs.c | 806 | ||||
-rw-r--r-- | sys/dev/usb/umcs.h | 423 |
3 files changed, 1235 insertions, 1 deletions
diff --git a/sys/dev/usb/files.usb b/sys/dev/usb/files.usb index e0dbc79696f..d30784bdacd 100644 --- a/sys/dev/usb/files.usb +++ b/sys/dev/usb/files.usb @@ -1,4 +1,4 @@ -# $OpenBSD: files.usb,v 1.118 2014/11/24 02:03:37 brad Exp $ +# $OpenBSD: files.usb,v 1.119 2014/12/04 11:05:26 mpi 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. @@ -310,6 +310,11 @@ device moscom: ucombus attach moscom at uhub file dev/usb/moscom.c moscom +# MosChip MCS78x0 serials +device umcs: ucombus +attach umcs at uhub +file dev/usb/umcs.c umcs + # simple serial device uscom: ucombus attach uscom at uhub diff --git a/sys/dev/usb/umcs.c b/sys/dev/usb/umcs.c new file mode 100644 index 00000000000..96de4a044ce --- /dev/null +++ b/sys/dev/usb/umcs.c @@ -0,0 +1,806 @@ +/* $OpenBSD: umcs.c,v 1.1 2014/12/04 11:05:26 mpi Exp $ */ +/* $NetBSD: umcs.c,v 1.8 2014/08/23 21:37:56 martin Exp $ */ +/* $FreeBSD: head/sys/dev/usb/serial/umcs.c 260559 2014-01-12 11:44:28Z hselasky $ */ + +/*- + * Copyright (c) 2010 Lev Serebryakov <lev@FreeBSD.org>. + * 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. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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. + */ + +/* + * This driver supports several multiport USB-to-RS232 serial adapters driven + * by MosChip mos7820 and mos7840, bridge chips. The adapters are sold under + * many different brand names. + * + * Datasheets are available at MosChip www site at http://www.moschip.com. + * The datasheets don't contain full programming information for the chip. + * + * It is nornal to have only two enabled ports in devices, based on quad-port + * mos7840. + */ + +#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> + +#include "umcs.h" + +#ifdef UMCS_DEBUG +#define DPRINTF(x...) printf(x) +#else +#define DPRINTF(x...) +#endif + +#define DEVNAME(_sc) ((_sc)->sc_dev.dv_xname) + +/* + * Two-port devices (both with 7820 chip and 7840 chip configured as two-port) + * have ports 0 and 2, with ports 1 and 3 omitted. + * So, PHYSICAL port numbers on two-port device will be 0 and 2. + * + * We use an array of the following struct, indexed by ucom port index, + * and include the physical port number in it. + */ +struct umcs_port { + struct ucom_softc *ucom; /* ucom subdevice */ + unsigned int pn; /* physical port number */ + uint8_t lcr; /* local line control reg. */ + uint8_t mcr; /* local modem control reg. */ +}; + +struct umcs_softc { + struct device sc_dev; + struct usbd_interface *sc_iface; /* the usb interface */ + struct usbd_device *sc_udev; /* the usb device */ + struct usbd_pipe *sc_ipipe; /* interrupt pipe */ + uint8_t *sc_ibuf; /* buffer for interrupt xfer */ + unsigned int sc_isize; /* size of buffer */ + + struct umcs_port sc_subdevs[UMCS_MAX_PORTS]; + uint8_t sc_numports; /* number of ports */ + + int sc_init_done; +}; + +int umcs_get_reg(struct umcs_softc *, uint8_t, uint8_t *); +int umcs_set_reg(struct umcs_softc *, uint8_t, uint8_t); +int umcs_get_uart_reg(struct umcs_softc *, uint8_t, uint8_t, uint8_t *); +int umcs_set_uart_reg(struct umcs_softc *, uint8_t, uint8_t, uint8_t); +int umcs_calc_baudrate(uint32_t, uint16_t *, uint8_t *); +int umcs_set_baudrate(struct umcs_softc *, uint8_t, uint32_t); +void umcs_dtr(struct umcs_softc *, int, int); +void umcs_rts(struct umcs_softc *, int, int); +void umcs_break(struct umcs_softc *, int, int); + +int umcs_match(struct device *, void *, void *); +void umcs_attach(struct device *, struct device *, void *); +int umcs_detach(struct device *, int); +void umcs_intr(struct usbd_xfer *, void *, usbd_status); + +void umcs_get_status(void *, int, uint8_t *, uint8_t *); +void umcs_set(void *, int, int, int); +int umcs_param(void *, int, struct termios *); +int umcs_open(void *, int); +void umcs_close(void *, int); + +struct ucom_methods umcs_methods = { + umcs_get_status, + umcs_set, + umcs_param, + NULL, + umcs_open, + umcs_close, + NULL, + NULL, +}; + +const struct usb_devno umcs_devs[] = { + { USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7810 }, + { USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7820 }, + { USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7840 }, + { USB_VENDOR_ATEN, USB_PRODUCT_ATEN_UC2324 } +}; + +struct cfdriver umcs_cd = { + NULL, "umcs", DV_DULL +}; + +const struct cfattach umcs_ca = { + sizeof(struct umcs_softc), umcs_match, umcs_attach, umcs_detach +}; + + +static inline int +umcs_reg_sp(int pn) +{ + KASSERT(pn >= 0 && pn < 4); + switch (pn) { + default: + case 0: return UMCS_SP1; + case 1: return UMCS_SP2; + case 2: return UMCS_SP3; + case 3: return UMCS_SP4; + } +} + +static inline int +umcs_reg_ctrl(int pn) +{ + KASSERT(pn >= 0 && pn < 4); + switch (pn) { + default: + case 0: return UMCS_CTRL1; + case 1: return UMCS_CTRL2; + case 2: return UMCS_CTRL3; + case 3: return UMCS_CTRL4; + } +} + +int +umcs_match(struct device *dev, void *match, void *aux) +{ + struct usb_attach_arg *uaa = aux; + + return (usb_lookup(umcs_devs, uaa->vendor, uaa->product) != NULL) ? + UMATCH_VENDOR_PRODUCT : UMATCH_NONE; +} + +void +umcs_attach(struct device *parent, struct device *self, void *aux) +{ + struct umcs_softc *sc = (struct umcs_softc *)self; + struct usb_attach_arg *uaa = aux; + usb_interface_descriptor_t *id; + usb_endpoint_descriptor_t *ed; + struct ucom_attach_args uca; + int error, i, intr_addr; + uint8_t data; + + sc->sc_udev = uaa->device; + + if (usbd_set_config_index(sc->sc_udev, UMCS_CONFIG_NO, 1) != 0) { + printf("%s: could not set configuration no\n", DEVNAME(sc)); + usbd_deactivate(sc->sc_udev); + return; + } + + /* Get the first interface handle */ + error = usbd_device2interface_handle(sc->sc_udev, UMCS_IFACE_NO, + &sc->sc_iface); + if (error != 0) { + printf("%s: could not get interface handle\n", DEVNAME(sc)); + usbd_deactivate(sc->sc_udev); + return; + } + + /* + * Get number of ports + * Documentation (full datasheet) says, that number of ports is + * set as UMCS_MODE_SELECT24S bit in MODE R/Only + * register. But vendor driver uses these undocumented + * register & bit. + * + * Experiments show, that MODE register can have `0' + * (4 ports) bit on 2-port device, so use vendor driver's way. + * + * Also, see notes in header file for these constants. + */ + umcs_get_reg(sc, UMCS_GPIO, &data); + if (data & UMCS_GPIO_4PORTS) + sc->sc_numports = 4; /* physical port no are : 0, 1, 2, 3 */ + else if (uaa->product == USB_PRODUCT_MOSCHIP_MCS7810) + sc->sc_numports = 1; + else + sc->sc_numports = 2; /* physical port no are: 0 and 2 */ + +#ifdef UMCS_DEBUG + if (!umcs_get_reg(sc, UMCS_MODE, &data)) { + printf("%s: On-die confguration: RST: active %s, " + "HRD: %s, PLL: %s, POR: %s, Ports: %s, EEPROM write %s, " + "IrDA is %savailable\n", DEVNAME(sc), + (data & UMCS_MODE_RESET) ? "low" : "high", + (data & UMCS_MODE_SER_PRSNT) ? "yes" : "no", + (data & UMCS_MODE_PLLBYPASS) ? "bypassed" : "avail", + (data & UMCS_MODE_PORBYPASS) ? "bypassed" : "avail", + (data & UMCS_MODE_SELECT24S) ? "2" : "4", + (data & UMCS_MODE_EEPROMWR) ? "enabled" : "disabled", + (data & UMCS_MODE_IRDA) ? "" : "not "); + } +#endif + + /* Set up the interrupt pipe */ + id = usbd_get_interface_descriptor(sc->sc_iface); + intr_addr = -1; + for (i = 0 ; i < id->bNumEndpoints ; i++) { + ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i); + if (ed == NULL) { + printf("%s: no endpoint descriptor found for %d\n", + DEVNAME(sc), i); + usbd_deactivate(sc->sc_udev); + return; + } + + if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN || + UE_GET_XFERTYPE(ed->bmAttributes) != UE_INTERRUPT) + continue; + sc->sc_isize = UGETW(ed->wMaxPacketSize); + intr_addr = ed->bEndpointAddress; + break; + } + if (intr_addr < 0) { + printf("%s: missing endpoint\n", DEVNAME(sc)); + usbd_deactivate(sc->sc_udev); + return; + } + sc->sc_ibuf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK); + + error = usbd_open_pipe_intr(sc->sc_iface, intr_addr, + USBD_SHORT_XFER_OK, &sc->sc_ipipe, sc, sc->sc_ibuf, + sc->sc_isize, umcs_intr, 100 /* XXX */); + if (error) { + printf("%s: cannot open interrupt pipe (addr %d)\n", + DEVNAME(sc), intr_addr); + usbd_deactivate(sc->sc_udev); + return; + } + + memset(&uca, 0, sizeof uca); + uca.ibufsize = 256; + uca.obufsize = 256; + uca.ibufsizepad = 256; + uca.opkthdrlen = 0; + uca.device = sc->sc_udev; + uca.iface = sc->sc_iface; + uca.methods = &umcs_methods; + uca.arg = sc; + + for (i = 0; i < sc->sc_numports; i++) { + uca.bulkin = uca.bulkout = -1; + + /* + * On 4 port cards, endpoints are 0/1, 2/3, 4/5, and 6/7. + * On 2 port cards, they are 0/1 and 4/5. + * On single port, just 0/1 will be used. + */ + int pn = i * (sc->sc_numports == 2 ? 2 : 1); + + ed = usbd_interface2endpoint_descriptor(sc->sc_iface, pn*2); + if (ed == NULL) { + printf("%s: no bulk in endpoint found for %d\n", + DEVNAME(sc), i); + usbd_deactivate(sc->sc_udev); + return; + } + uca.bulkin = ed->bEndpointAddress; + + ed = usbd_interface2endpoint_descriptor(sc->sc_iface, pn*2+1); + if (ed == NULL) { + printf("%s: no bulk out endpoint found for %d\n", + DEVNAME(sc), i); + usbd_deactivate(sc->sc_udev); + return; + } + uca.bulkout = ed->bEndpointAddress; + uca.portno = i; + + sc->sc_subdevs[i].pn = pn; + sc->sc_subdevs[i].ucom = (struct ucom_softc *) + config_found_sm(self, &uca, ucomprint, ucomsubmatch); + } +} + +int +umcs_get_reg(struct umcs_softc *sc, uint8_t reg, uint8_t *data) +{ + usb_device_request_t req; + + req.bmRequestType = UT_READ_VENDOR_DEVICE; + req.bRequest = UMCS_READ; + USETW(req.wValue, 0); + USETW(req.wIndex, reg); + USETW(req.wLength, UMCS_READ_LENGTH); + + if (usbd_do_request(sc->sc_udev, &req, data)) + return (EIO); + + return (0); +} + +int +umcs_set_reg(struct umcs_softc *sc, uint8_t reg, uint8_t data) +{ + usb_device_request_t req; + + req.bmRequestType = UT_WRITE_VENDOR_DEVICE; + req.bRequest = UMCS_WRITE; + USETW(req.wValue, data); + USETW(req.wIndex, reg); + USETW(req.wLength, 0); + + if (usbd_do_request(sc->sc_udev, &req, NULL)) + return (EIO); + + return (0); +} + +int +umcs_get_uart_reg(struct umcs_softc *sc, uint8_t portno, uint8_t reg, + uint8_t *data) +{ + usb_device_request_t req; + uint16_t wVal; + + wVal = ((uint16_t)(sc->sc_subdevs[portno].pn + 1)) << 8; + + req.bmRequestType = UT_READ_VENDOR_DEVICE; + req.bRequest = UMCS_READ; + USETW(req.wValue, wVal); + USETW(req.wIndex, reg); + USETW(req.wLength, UMCS_READ_LENGTH); + + if (usbd_do_request(sc->sc_udev, &req, data)) + return (EIO); + + return (0); +} + +int +umcs_set_uart_reg(struct umcs_softc *sc, uint8_t portno, uint8_t reg, + uint8_t data) +{ + usb_device_request_t req; + uint16_t wVal; + + wVal = ((uint16_t)(sc->sc_subdevs[portno].pn + 1)) << 8 | data; + + req.bmRequestType = UT_WRITE_VENDOR_DEVICE; + req.bRequest = UMCS_WRITE; + USETW(req.wValue, wVal); + USETW(req.wIndex, reg); + USETW(req.wLength, 0); + + if (usbd_do_request(sc->sc_udev, &req, NULL)) + return (EIO); + + return (0); +} + +int +umcs_set_baudrate(struct umcs_softc *sc, uint8_t portno, uint32_t rate) +{ + int pn = sc->sc_subdevs[portno].pn; + int spreg = umcs_reg_sp(pn); + uint8_t lcr = sc->sc_subdevs[portno].lcr; + uint8_t clk, data; + uint16_t div; + + if (umcs_calc_baudrate(rate, &div, &clk)) + return (EINVAL); + + DPRINTF("%s: portno %d set speed: %d (%02x/%d)\n", DEVNAME(sc), portno, + rate, clk, div); + + /* Set clock source for standard BAUD frequences */ + if (umcs_get_reg(sc, spreg, &data)) + return (EIO); + data &= UMCS_SPx_CLK_MASK; + if (umcs_set_reg(sc, spreg, data | clk)) + return (EIO); + + /* Set divider */ + lcr |= UMCS_LCR_DIVISORS; + if (umcs_set_uart_reg(sc, portno, UMCS_REG_LCR, lcr)) + return (EIO); + sc->sc_subdevs[portno].lcr = lcr; + + if (umcs_set_uart_reg(sc, portno, UMCS_REG_DLL, div & 0xff) || + umcs_set_uart_reg(sc, portno, UMCS_REG_DLM, (div >> 8) & 0xff)) + return (EIO); + + /* Turn off access to DLL/DLM registers of UART */ + lcr &= ~UMCS_LCR_DIVISORS; + if (umcs_set_uart_reg(sc, portno, UMCS_REG_LCR, lcr)) + return (EIO); + sc->sc_subdevs[portno].lcr = lcr; + + return (0); +} + +/* Maximum speeds for standard frequences, when PLL is not used */ +static const uint32_t umcs_baudrate_divisors[] = { + 0, 115200, 230400, 403200, 460800, 806400, 921600, 1572864, 3145728, +}; + +int +umcs_calc_baudrate(uint32_t rate, uint16_t *divisor, uint8_t *clk) +{ + const uint8_t divisors_len = nitems(umcs_baudrate_divisors); + uint8_t i = 0; + + if (rate > umcs_baudrate_divisors[divisors_len - 1]) + return (-1); + + for (i = 0; i < divisors_len - 1; i++) { + if (rate > umcs_baudrate_divisors[i] && + rate <= umcs_baudrate_divisors[i + 1]) + break; + } + + *divisor = umcs_baudrate_divisors[i + 1] / rate; + /* 0x00 .. 0x70 */ + *clk = i << UMCS_SPx_CLK_SHIFT; + + return (0); +} + +int +umcs_detach(struct device *self, int flags) +{ + struct umcs_softc *sc = (struct umcs_softc *)self; + + if (sc->sc_ipipe != NULL) { + usbd_abort_pipe(sc->sc_ipipe); + usbd_close_pipe(sc->sc_ipipe); + sc->sc_ipipe = NULL; + } + + if (sc->sc_ibuf != NULL) { + free(sc->sc_ibuf, M_USBDEV, sc->sc_isize); + sc->sc_ibuf = NULL; + } + + return (config_detach_children(self, flags)); +} + +void +umcs_get_status(void *self, int portno, uint8_t *lsr, uint8_t *msr) +{ + struct umcs_softc *sc = self; + uint8_t hw_lsr = 0; /* local line status register */ + uint8_t hw_msr = 0; /* local modem status register */ + + if (usbd_is_dying(sc->sc_udev)) + return; + + /* Read LSR & MSR */ + if (umcs_get_uart_reg(sc, portno, UMCS_REG_LSR, &hw_lsr) || + umcs_get_uart_reg(sc, portno, UMCS_REG_MSR, &hw_msr)) + return; + + *lsr = hw_lsr; + *msr = hw_msr; +} + +void +umcs_set(void *self, int portno, int reg, int onoff) +{ + struct umcs_softc *sc = self; + + if (usbd_is_dying(sc->sc_udev)) + return; + + switch (reg) { + case UCOM_SET_DTR: + umcs_dtr(sc, portno, onoff); + break; + case UCOM_SET_RTS: + umcs_rts(sc, portno, onoff); + break; + case UCOM_SET_BREAK: + umcs_break(sc, portno, onoff); + break; + default: + break; + } +} + +int +umcs_param(void *self, int portno, struct termios *t) +{ + struct umcs_softc *sc = self; + uint8_t lcr = sc->sc_subdevs[portno].lcr; + uint8_t mcr = sc->sc_subdevs[portno].mcr; + int error = 0; + + if (t->c_cflag & CSTOPB) + lcr |= UMCS_LCR_STOPB2; + else + lcr |= UMCS_LCR_STOPB1; + + lcr &= ~UMCS_LCR_PARITYMASK; + if (t->c_cflag & PARENB) { + lcr |= UMCS_LCR_PARITYON; + if (t->c_cflag & PARODD) { + lcr = UMCS_LCR_PARITYODD; + } else { + lcr = UMCS_LCR_PARITYEVEN; + } + } else { + lcr &= ~UMCS_LCR_PARITYON; + } + + lcr &= ~UMCS_LCR_DATALENMASK; + switch (t->c_cflag & CSIZE) { + case CS5: + lcr |= UMCS_LCR_DATALEN5; + break; + case CS6: + lcr |= UMCS_LCR_DATALEN6; + break; + case CS7: + lcr |= UMCS_LCR_DATALEN7; + break; + case CS8: + lcr |= UMCS_LCR_DATALEN8; + break; + } + + if (t->c_cflag & CRTSCTS) + mcr |= UMCS_MCR_CTSRTS; + else + mcr &= ~UMCS_MCR_CTSRTS; + + if (t->c_cflag & CLOCAL) + mcr &= ~UMCS_MCR_DTRDSR; + else + mcr |= UMCS_MCR_DTRDSR; + + if (umcs_set_uart_reg(sc, portno, UMCS_REG_LCR, lcr)) + return (EIO); + sc->sc_subdevs[portno].lcr = lcr; + + if (umcs_set_uart_reg(sc, portno, UMCS_REG_MCR, mcr)) + return (EIO); + sc->sc_subdevs[portno].mcr = mcr; + + error = umcs_set_baudrate(sc, portno, t->c_ospeed); + + return (error); +} + +void +umcs_dtr(struct umcs_softc *sc, int portno, int onoff) +{ + uint8_t mcr = sc->sc_subdevs[portno].mcr; + + if (onoff) + mcr |= UMCS_MCR_DTR; + else + mcr &= ~UMCS_MCR_DTR; + + if (umcs_set_uart_reg(sc, portno, UMCS_REG_MCR, mcr)) + return; + sc->sc_subdevs[portno].mcr = mcr; +} + +void +umcs_rts(struct umcs_softc *sc, int portno, int onoff) +{ + uint8_t mcr = sc->sc_subdevs[portno].mcr; + + if (onoff) + mcr |= UMCS_MCR_RTS; + else + mcr &= ~UMCS_MCR_RTS; + + if (umcs_set_uart_reg(sc, portno, UMCS_REG_MCR, mcr)) + return; + sc->sc_subdevs[portno].mcr = mcr; +} + +void +umcs_break(struct umcs_softc *sc, int portno, int onoff) +{ + uint8_t lcr = sc->sc_subdevs[portno].lcr; + + if (onoff) + lcr |= UMCS_LCR_BREAK; + else + lcr &= ~UMCS_LCR_BREAK; + + if (umcs_set_uart_reg(sc, portno, UMCS_REG_LCR, lcr)) + return; + sc->sc_subdevs[portno].lcr = lcr; +} + +int +umcs_open(void *self, int portno) +{ + struct umcs_softc *sc = self; + int pn = sc->sc_subdevs[portno].pn; + int spreg = umcs_reg_sp(pn); + int ctrlreg = umcs_reg_ctrl(pn); + uint8_t mcr = sc->sc_subdevs[portno].mcr; + uint8_t lcr = sc->sc_subdevs[portno].lcr; + uint8_t data; + int error; + + if (usbd_is_dying(sc->sc_udev)) + return (EIO); + + /* If it very first open, finish global configuration */ + if (!sc->sc_init_done) { + if (umcs_get_reg(sc, UMCS_CTRL1, &data) || + umcs_set_reg(sc, UMCS_CTRL1, data | UMCS_CTRL1_DRIVER_DONE)) + return (EIO); + sc->sc_init_done = 1; + } + + /* Toggle reset bit on-off */ + if (umcs_get_reg(sc, spreg, &data) || + umcs_set_reg(sc, spreg, data | UMCS_SPx_UART_RESET) || + umcs_set_reg(sc, spreg, data & ~UMCS_SPx_UART_RESET)) + return (EIO); + + /* Set RS-232 mode */ + if (umcs_set_uart_reg(sc, portno, UMCS_REG_SCRATCHPAD, + UMCS_SCRATCHPAD_RS232)) + return (EIO); + + /* Disable RX on time of initialization */ + if (umcs_get_reg(sc, ctrlreg, &data) || + umcs_set_reg(sc, ctrlreg, data | UMCS_CTRL_RX_DISABLE)) + return (EIO); + + /* Disable all interrupts */ + if (umcs_set_uart_reg(sc, portno, UMCS_REG_IER, 0)) + return (EIO); + + /* Reset FIFO -- documented */ + if (umcs_set_uart_reg(sc, portno, UMCS_REG_FCR, 0) || + umcs_set_uart_reg(sc, portno, UMCS_REG_FCR, + UMCS_FCR_ENABLE | UMCS_FCR_FLUSHRHR | + UMCS_FCR_FLUSHTHR | UMCS_FCR_RTL_1_14)) + return (EIO); + + /* Set 8 bit, no parity, 1 stop bit -- documented */ + lcr = UMCS_LCR_DATALEN8 | UMCS_LCR_STOPB1; + if (umcs_set_uart_reg(sc, portno, UMCS_REG_LCR, lcr)) + return (EIO); + sc->sc_subdevs[portno].lcr = lcr; + + /* + * Enable DTR/RTS on modem control, enable modem interrupts -- + * documented + */ + mcr = UMCS_MCR_DTR | UMCS_MCR_RTS | UMCS_MCR_IE; + if (umcs_set_uart_reg(sc, portno, UMCS_REG_MCR, mcr)) + return (EIO); + sc->sc_subdevs[portno].mcr = mcr; + + /* Clearing Bulkin and Bulkout FIFO */ + if (umcs_get_reg(sc, spreg, &data)) + return (EIO); + data |= UMCS_SPx_RESET_OUT_FIFO|UMCS_SPx_RESET_IN_FIFO; + if (umcs_set_reg(sc, spreg, data)) + return (EIO); + data &= ~(UMCS_SPx_RESET_OUT_FIFO|UMCS_SPx_RESET_IN_FIFO); + if (umcs_set_reg(sc, spreg, data)) + return (EIO); + + /* Set speed 9600 */ + if ((error = umcs_set_baudrate(sc, portno, 9600)) != 0) + return (error); + + /* Finally enable all interrupts -- documented */ + /* + * Copied from vendor driver, I don't know why we should read LCR + * here + */ + if (umcs_get_uart_reg(sc, portno, UMCS_REG_LCR, + &sc->sc_subdevs[portno].lcr)) + return (EIO); + if (umcs_set_uart_reg(sc, portno, UMCS_REG_IER, + UMCS_IER_RXSTAT | UMCS_IER_MODEM)) + return (EIO); + + /* Enable RX */ + if (umcs_get_reg(sc, ctrlreg, &data) || + umcs_set_reg(sc, ctrlreg, data & ~UMCS_CTRL_RX_DISABLE)) + return (EIO); + + return (0); +} + +void +umcs_close(void *self, int portno) +{ + struct umcs_softc *sc = self; + int pn = sc->sc_subdevs[portno].pn; + int ctrlreg = umcs_reg_ctrl(pn); + uint8_t data; + + if (usbd_is_dying(sc->sc_udev)) + return; + + umcs_set_uart_reg(sc, portno, UMCS_REG_MCR, 0); + umcs_set_uart_reg(sc, portno, UMCS_REG_IER, 0); + + /* Disable RX */ + if (umcs_get_reg(sc, ctrlreg, &data) || + umcs_set_reg(sc, ctrlreg, data | UMCS_CTRL_RX_DISABLE)) + return; +} + +void +umcs_intr(struct usbd_xfer *xfer, void *priv, usbd_status status) +{ + struct umcs_softc *sc = priv; + uint8_t *buf = sc->sc_ibuf; + int actlen, i; + + if (usbd_is_dying(sc->sc_udev)) + return; + + if (status == USBD_CANCELLED || status == USBD_IOERROR) + return; + + if (status != USBD_NORMAL_COMPLETION) { + DPRINTF("%s: interrupt status=%d\n", DEVNAME(sc), status); + usbd_clear_endpoint_stall_async(sc->sc_ipipe); + return; + } + + usbd_get_xfer_status(xfer, NULL, NULL, &actlen, NULL); + if (actlen != 5 && actlen != 13) { + printf("%s: invalid interrupt data length %d\n", DEVNAME(sc), + actlen); + return; + } + + /* Check status of all ports */ + for (i = 0; i < sc->sc_numports; i++) { + uint8_t pn = sc->sc_subdevs[i].pn; + + if (buf[pn] & UMCS_ISR_NOPENDING) + continue; + + DPRINTF("%s: port %d has pending interrupt: %02x, FIFO=%02x\n", + DEVNAME(sc), i, buf[pn] & UMCS_ISR_INTMASK, + buf[pn] & (~UMCS_ISR_INTMASK)); + + switch (buf[pn] & UMCS_ISR_INTMASK) { + case UMCS_ISR_RXERR: + case UMCS_ISR_RXHASDATA: + case UMCS_ISR_RXTIMEOUT: + case UMCS_ISR_MSCHANGE: + ucom_status_change(sc->sc_subdevs[i].ucom); + break; + default: + /* Do nothing */ + break; + } + } +} diff --git a/sys/dev/usb/umcs.h b/sys/dev/usb/umcs.h new file mode 100644 index 00000000000..6cdd1db3985 --- /dev/null +++ b/sys/dev/usb/umcs.h @@ -0,0 +1,423 @@ +/* $OpenBSD: umcs.h,v 1.1 2014/12/04 11:05:26 mpi Exp $ */ +/* $NetBSD: umcs.h,v 1.1 2014/03/16 09:34:45 martin Exp $ */ + +/*- + * Copyright (c) 2010 Lev Serebryakov <lev@FreeBSD.org>. + * 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. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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. + */ + +#ifndef _UMCS_H_ +#define _UMCS_H_ + +#define UMCS_MAX_PORTS 4 + +#define UMCS_READ_LENGTH 1 /* bytes */ + +/* Read/Wrtire registers vendor commands */ +#define UMCS_READ 0x0d +#define UMCS_WRITE 0x0e + +#define UMCS_CONFIG_NO 0 +#define UMCS_IFACE_NO 0 + +/* Read/Wrtie EEPROM values */ +#define UMCS_EEPROM_RW_WVALUE 0x0900 + +/* + * All these registers are documented only in full datasheet, which + * can be requested from MosChip tech support. + */ +#define UMCS_SP1 0x00 /* Options for for UART 1, R/W */ +#define UMCS_CTRL1 0x01 /* Control bits for UART 1, R/W */ +#define UMCS_PINPONGHIGH 0x02 /* High bits of ping-pong reg, R/W */ +#define UMCS_PINPONGLOW 0x03 /* Low bits of ping-pong reg, R/W */ + + +/* DCRx_1 Registers goes here (see below, they are documented) */ +#define UMCS_GPIO 0x07 /* GPIO_0 and GPIO_1 bits, R/W */ +#define UMCS_SP2 0x08 /* Options for for UART 2, R/W */ +#define UMCS_CTRL2 0x09 /* Control bits for UART 2, R/W */ +#define UMCS_SP3 0x0a /* Options for for UART 3, R/W */ +#define UMCS_CTRL3 0x0b /* Control bits for UART 3, R/W */ +#define UMCS_SP4 0x0c /* Options for for UART 4, R/W */ +#define UMCS_CTRL4 0x0d /* Control bits for UART 4, R/W */ +#define UMCS_PLL_DIV_M 0x0e /* Pre-diviedr for PLL, R/W */ +#define UMCS_UNKNOWN1 0x0f /* NOT MENTIONED AND NOT USED */ +#define UMCS_PLL_DIV_N 0x10 /* Loop divider for PLL, R/W */ +#define UMCS_CLK_MUX 0x12 /* PLL clock & Int. ep ctrl, R/W */ +#define UMCS_UNKNOWN2 0x11 /* NOT MENTIONED AND NOT USED */ +#define UMCS_CLK_SELECT12 0x13 /* Clock source for ports 1 & 2, R/W */ +#define UMCS_CLK_SELECT34 0x14 /* Clock source for ports 3 & 4, R/W */ +#define UMCS_UNKNOWN3 0x15 /* NOT MENTIONED AND NOT USED */ + + +/* DCRx_2-DCRx_4 Registers goes here (see below, they are documented) */ +#define UMCS_UNKNOWN4 0x1f /* NOT MENTIONED AND NOT USED */ +#define UMCS_UNKNOWN5 0x20 /* NOT MENTIONED AND NOT USED */ +#define UMCS_UNKNOWN6 0x21 /* NOT MENTIONED AND NOT USED */ +#define UMCS_UNKNOWN7 0x22 /* NOT MENTIONED AND NOT USED */ +#define UMCS_UNKNOWN8 0x23 /* NOT MENTIONED AND NOT USED */ +#define UMCS_UNKNOWN9 0x24 /* NOT MENTIONED AND NOT USED */ +#define UMCS_UNKNOWNA 0x25 /* NOT MENTIONED AND NOT USED */ +#define UMCS_UNKNOWNB 0x26 /* NOT MENTIONED AND NOT USED */ +#define UMCS_UNKNOWNC 0x27 /* NOT MENTIONED AND NOT USED */ +#define UMCS_UNKNOWND 0x28 /* NOT MENTIONED AND NOT USED */ +#define UMCS_UNKNOWNE 0x29 /* NOT MENTIONED AND NOT USED */ +#define UMCS_UNKNOWNF 0x2a /* NOT MENTIONED AND NOT USED */ +#define UMCS_MODE 0x2b /* Hardware configuration, R */ +#define UMCS_SP1_ICG 0x2c /* Inter char gap config, port 1, R/W */ +#define UMCS_SP2_ICG 0x2d /* Inter char gap config, port 2, R/W */ +#define UMCS_SP3_ICG 0x2e /* Inter char gap config, port 3, R/W */ +#define UMCS_SP4_ICG 0x2f /* Inter char gap config, port 4, R/W */ +#define UMCS_RX_SAMPLING12 0x30 /* RX sampling for ports 1 & 2, R/W */ +#define UMCS_RX_SAMPLING34 0x31 /* RX sampling for ports 3 & 4, R/W */ +#define UMCS_BI_FIFO_STAT1 0x32 /* Bulk-In FIFO Stat for Port 1, R */ +#define UMCS_BO_FIFO_STAT1 0x33 /* Bulk-out FIFO Stat for Port 1, R */ +#define UMCS_BI_FIFO_STAT2 0x34 /* Bulk-In FIFO Stat for Port 2, R */ +#define UMCS_BO_FIFO_STAT2 0x35 /* Bulk-out FIFO Stat for Port 2, R */ +#define UMCS_BI_FIFO_STAT3 0x36 /* Bulk-In FIFO Stat for Port 3, R */ +#define UMCS_BO_FIFO_STAT3 0x37 /* Bulk-out FIFO Stat for Port 3, R */ +#define UMCS_BI_FIFO_STAT4 0x38 /* Bulk-In FIFO Stat for Port 4, R */ +#define UMCS_BO_FIFO_STAT4 0x39 /* Bulk-out FIFO Stat for Port 4, R */ +#define UMCS_ZERO_PERIOD1 0x3a /* Period btw frames for Port 1, R/W */ +#define UMCS_ZERO_PERIOD2 0x3b /* Period btw frames for Port 2 R/W */ +#define UMCS_ZERO_PERIOD3 0x3c /* Period btw frames for Port 3, R/W */ +#define UMCS_ZERO_PERIOD4 0x3d /* Period btw frames for Port 4, R/W */ +#define UMCS_ZERO_ENABLE 0x3e /* Enable zero-out frames, R/W */ + +/* Low 8 bits and high 1 bit of threshhold values for Bulk-Out ports 1-4 */ +#define UMCS_THR_VAL_LOW1 0x3f +#define UMCS_THR_VAL_HIGH1 0x40 +#define UMCS_THR_VAL_LOW2 0x41 +#define UMCS_THR_VAL_HIGH2 0x42 +#define UMCS_THR_VAL_LOW3 0x43 +#define UMCS_THR_VAL_HIGH3 0x44 +#define UMCS_THR_VAL_LOW4 0x45 +#define UMCS_THR_VAL_HIGH4 0x46 + + +/* Bits for SPx registers */ +#define UMCS_SPx_LOOP_PIPES 0x01 /* Loop Out FIFO to In FIFO */ +#define UMCS_SPx_SKIP_ERR_DATA 0x02 /* Drop data recevied with errors */ +#define UMCS_SPx_RESET_OUT_FIFO 0x04 /* Reset Bulk-Out FIFO */ +#define UMCS_SPx_RESET_IN_FIFO 0x08 /* Reset Bulk-In FIFO */ +#define UMCS_SPx_CLK_MASK 0x70 /* Mask to extract Baud CLK source */ +#define UMCS_SPx_CLK_X1 0x00 /* Max speed = 115200 bps, default */ +#define UMCS_SPx_CLK_X2 0x10 /* Max speed = 230400 bps */ +#define UMCS_SPx_CLK_X35 0x20 /* Max speed = 403200 bps */ +#define UMCS_SPx_CLK_X4 0x30 /* Nax speed = 460800 bps */ +#define UMCS_SPx_CLK_X7 0x40 /* Max speed = 806400 bps */ +#define UMCS_SPx_CLK_X8 0x50 /* Max speed = 921600 bps */ +#define UMCS_SPx_CLK_24MHZ 0x60 /* Max speed = 1.5Mbps */ +#define UMCS_SPx_CLK_48MHZ 0x70 /* Max speed = 3.0 Mbps */ +#define UMCS_SPx_CLK_SHIFT 4 /* Shift to get clock value */ +#define UMCS_SPx_UART_RESET 0x80 /* Reset UART */ + + +/* Bits for CTRL registers */ +#define UMCS_CTRL_HWFC 0x01 /* Enable hardware flow control */ +#define UMCS_CTRL_UNUNSED1 0x02 /* Reserved */ +#define UMCS_CTRL_CTS_ENABLE 0x04 /* CTS changes are translated to MSR */ +#define UMCS_CTRL_UNUSED2 0x08 /* Reserved for ports 2,3,4 */ +#define UMCS_CTRL1_DRIVER_DONE 0x08 /* Memory can be use as FIFO */ +#define UMCS_CTRL_RX_NEGATE 0x10 /* Negate RX input */ +#define UMCS_CTRL_RX_DISABLE 0x20 /* Disable RX logic */ +#define UMCS_CTRL_FSM_CONTROL 0x40 /* Disable RX FSM when TX is active */ +#define UMCS_CTRL_UNUSED3 0x80 /* Reserved */ + + +/* + * Bits for PINPONGx registers. These registers control how often two + * input buffers for Bulk-In FIFOs are swapped. One of buffers is used + * for USB transfer, other for receiving data from UART. Exact meaning + * of 15 bit value in these registers is unknown + */ +#define UMCS_PINPONGHIGH_MULT 128 /* Only 7 bits in PINPONGLOW register */ +#define UMCS_PINPONGLOW_BITS 7 /* Only 7 bits in PINPONGLOW register */ + + +/* + * THIS ONE IS UNDOCUMENTED IN FULL DATASHEET, but e-mail from tech support + * confirms, that it is register for GPIO_0 and GPIO_1 data input/output. + * Chips has 2 GPIO, but first one (lower bit) MUST be used by device + * authors as "number of port" indicator, grounded (0) for two-port + * devices and pulled-up to 1 for 4-port devices. + */ +#define UMCS_GPIO_4PORTS 0x01 /* Device has 4 ports configured */ +#define UMCS_GPIO_GPIO_0 0x01 /* The same as above */ +#define UMCS_GPIO_GPIO_1 0x02 /* GPIO_1 data */ + +/* + * Constants for PLL dividers. Ouptut frequency of PLL is: + * Fout = (N/M) * Fin. + * Default PLL input frequency Fin is 12Mhz (on-chip). + */ +#define UMCS_PLL_DIV_M_BITS 6 /* Number of bits for M divider */ +#define UMCS_PLL_DIV_M_MASK 0x3f /* Mask for M divider */ +#define UMCS_PLL_DIV_M_MIN 1 /* Minimum value for M, (0 forbidden) */ +#define UMCS_PLL_DIV_M_DEF 1 /* Default value for M */ +#define UMCS_PLL_DIV_M_MAX 63 /* Maximum value for M */ +#define UMCS_PLL_DIV_N_BITS 6 /* Number of bits for N divider */ +#define UMCS_PLL_DIV_N_MASK 0x3f /* Mask for N divider */ +#define UMCS_PLL_DIV_N_MIN 1 /* Minimum value for N, (0 forbidden) */ +#define UMCS_PLL_DIV_N_DEF 8 /* Default value for N */ +#define UMCS_PLL_DIV_N_MAX 63 /* Maximum value for N */ + + +/* Bits for CLK_MUX register */ +#define UMCS_CLK_MUX_INMASK 0x03 /* Mask to extract PLL clock input */ +#define UMCS_CLK_MUX_IN12MHZ 0x00 /* 12Mhz PLL input, default */ +#define UMCS_CLK_MUX_INEXTRN 0x01 /* External PLL input */ +#define UMCS_CLK_MUX_INRSV1 0x02 /* Reserved */ +#define UMCS_CLK_MUX_INRSV2 0x03 /* Reserved */ +#define UMCS_CLK_MUX_PLLHIGH 0x04 /* 20MHz-100MHz or 100MHz-300MHz range*/ +#define UMCS_CLK_MUX_INTRFIFOS 0x08 /* Enable FIFOs status (+8 bytes) */ +#define UMCS_CLK_MUX_RESERVED1 0x10 /* Unused */ +#define UMCS_CLK_MUX_RESERVED2 0x20 /* Unused */ +#define UMCS_CLK_MUX_RESERVED3 0x40 /* Unused */ +#define UMCS_CLK_MUX_RESERVED4 0x80 /* Unused */ + + +/* Bits for CLK_SELECTxx registers */ +#define UMCS_CLK_SELECT1_MASK 0x07 /* Bits for port 1 in CLK_SELECT12 */ +#define UMCS_CLK_SELECT1_SHIFT 0 /* Shift for port 1in CLK_SELECT12 */ +#define UMCS_CLK_SELECT2_MASK 0x38 /* Bits for port 2 in CLK_SELECT12 */ +#define UMCS_CLK_SELECT2_SHIFT 3 /* Shift for port 2 in CLK_SELECT12 */ +#define UMCS_CLK_SELECT3_MASK 0x07 /* Bits for port 3 in CLK_SELECT23 */ +#define UMCS_CLK_SELECT3_SHIFT 0 /* Shift for port 3 in CLK_SELECT23 */ +#define UMCS_CLK_SELECT4_MASK 0x38 /* Bits for port 4 in CLK_SELECT23 */ +#define UMCS_CLK_SELECT4_SHIFT 3 /* Shift for port 4 in CLK_SELECT23 */ +#define UMCS_CLK_SELECT_STD 0x00 /* STANDARD rate devired from 96Mhz */ +#define UMCS_CLK_SELECT_30MHZ 0x01 /* 30Mhz */ +#define UMCS_CLK_SELECT_96MHZ 0x02 /* 96Mhz direct */ +#define UMCS_CLK_SELECT_120MHZ 0x03 /* 120Mhz */ +#define UMCS_CLK_SELECT_PLL 0x04 /* PLL output */ +#define UMCS_CLK_SELECT_EXT 0x05 /* External clock input */ +#define UMCS_CLK_SELECT_RES1 0x06 /* Unused */ +#define UMCS_CLK_SELECT_RES2 0x07 /* Unused */ + + +/* Bits for MODE register */ +#define UMCS_MODE_RESERVED1 0x01 /* Unused */ +#define UMCS_MODE_RESET 0x02 /* RESET = Active High (default) */ +#define UMCS_MODE_SER_PRSNT 0x04 /* Reserved (default) */ +#define UMCS_MODE_PLLBYPASS 0x08 /* PLL output is bypassed */ +#define UMCS_MODE_PORBYPASS 0x10 /* Power-On Reset is bypassed */ +#define UMCS_MODE_SELECT24S 0x20 /* 4 or 2 Serial Ports / IrDA active */ +#define UMCS_MODE_EEPROMWR 0x40 /* EEPROM write is enabled (default) */ +#define UMCS_MODE_IRDA 0x80 /* IrDA mode is activated (default) */ + +/* All 8 bits is used as number of BAUD clocks of pause */ +#define UMCS_SPx_ICG_DEF 0x24 + + +/* + * Bits for RX_SAMPLINGxx registers. These registers control when + * bit value will be sampled within the baud period. + * 0 is very beginning of period, 15 is very end, 7 is the middle. + */ +#define UMCS_RX_SAMPLING1_MASK 0x0f /* Bits for port 1 in RX_SAMPLING12 */ +#define UMCS_RX_SAMPLING1_SHIFT 0 /* Shift for port 1in RX_SAMPLING12 */ +#define UMCS_RX_SAMPLING2_MASK 0xf0 /* Bits for port 2 in RX_SAMPLING12 */ +#define UMCS_RX_SAMPLING2_SHIFT 4 /* Shift for port 2 in RX_SAMPLING12 */ +#define UMCS_RX_SAMPLING3_MASK 0x0f /* Bits for port 3 in RX_SAMPLING23 */ +#define UMCS_RX_SAMPLING3_SHIFT 0 /* Shift for port 3 in RX_SAMPLING23 */ +#define UMCS_RX_SAMPLING4_MASK 0xf0 /* Bits for port 4 in RX_SAMPLING23 */ +#define UMCS_RX_SAMPLING4_SHIFT 4 /* Shift for port 4 in RX_SAMPLING23 */ +#define UMCS_RX_SAMPLINGx_MIN 0 /* Max for any RX Sampling */ +#define UMCS_RX_SAMPLINGx_DEF 7 /* Default for any RX Sampling */ +#define UMCS_RX_SAMPLINGx_MAX 15 /* Min for any RX Sampling */ + +/* Number of Bulk-in requests befor sending zero-sized reply */ +#define UMCS_ZERO_PERIODx_DEF 20 + + +/* Bits to enable sending zero-sized replies, per port, (default is on) */ +#define UMCS_ZERO_ENABLE_PORT1 0x01 +#define UMCS_ZERO_ENABLE_PORT2 0x02 +#define UMCS_ZERO_ENABLE_PORT3 0x04 +#define UMCS_ZERO_ENABLE_PORT4 0x08 + + +/* Bits for THR_VAL_HIx */ +#define UMCS_THR_VAL_HIMASK 0x01 /* Only one bit is used */ +#define UMCS_THR_VAL_HIMUL 256 /* This one bit is means "256" */ +#define UMCS_THR_VAL_HISHIFT 8 /* This one bit is means "256" */ +#define UMCS_THR_VAL_HIENABLE 0x80 /* Enable threshold */ + +/* These are documented in "public" datasheet */ +#define UMCS_DCR0_1 0x04 /* Device ctrl reg 0 for Port 1, R/W */ +#define UMCS_DCR1_1 0x05 /* Device ctrl reg 1 for Port 1, R/W */ +#define UMCS_DCR2_1 0x06 /* Device ctrl reg 2 for Port 1, R/W */ +#define UMCS_DCR0_2 0x16 /* Device ctrl reg 0 for Port 2, R/W */ +#define UMCS_DCR1_2 0x17 /* Device ctrl reg 1 for Port 2, R/W */ +#define UMCS_DCR2_2 0x18 /* Device ctrl reg 2 for Port 2, R/W */ +#define UMCS_DCR0_3 0x19 /* Device ctrl reg 0 for Port 3, R/W */ +#define UMCS_DCR1_3 0x1a /* Device ctrl reg 1 for Port 3, R/W */ +#define UMCS_DCR2_3 0x1b /* Device ctrl reg 2 for Port 3, R/W */ +#define UMCS_DCR0_4 0x1c /* Device ctrl reg 0 for Port 4, R/W */ +#define UMCS_DCR1_4 0x1d /* Device ctrl reg 1 for Port 4, R/W */ +#define UMCS_DCR2_4 0x1e /* Device ctrl reg 2 for Port 4, R/W */ + + +/* Bits of DCR0 registers, documented in datasheet */ +#define UMCS_DCR0_PWRSAVE 0x01 /* Transiver off when USB Suspend */ +#define UMCS_DCR0_RESERVED1 0x02 /* Unused */ +#define UMCS_DCR0_GPIO_MASK 0x0c /* GPIO Mode bits */ +#define UMCS_DCR0_GPIO_IN 0x00 /* GPIO Mode - Input (0b00) */ +#define UMCS_DCR0_GPIO_OUT 0x08 /* GPIO Mode - Input (0b10) */ +#define UMCS_DCR0_RTS_ACTHI 0x10 /* RTS Active is Hight, (default low) */ +#define UMCS_DCR0_RTS_AUTO 0x20 /* Control by state TX buffer or MCR */ +#define UMCS_DCR0_IRDA 0x40 /* IrDA mode */ +#define UMCS_DCR0_RESERVED2 0x80 /* Unused */ + +/* Bits of DCR1 registers, documented in datasheet, work only for port 1. */ +#define UMCS_DCR1_GPIO_CURRENT_MASK 0x03 /* Mask to get GPIO valule */ +#define UMCS_DCR1_GPIO_CURRENT_6MA 0x00 /* GPIO output current 6mA */ +#define UMCS_DCR1_GPIO_CURRENT_8MA 0x01 /* GPIO output current 8mA */ +#define UMCS_DCR1_GPIO_CURRENT_10MA 0x02 /* GPIO output current 10mA */ +#define UMCS_DCR1_GPIO_CURRENT_12MA 0x03 /* GPIO output current 12mA */ +#define UMCS_DCR1_UART_CURRENT_MASK 0x0c /* Mask to get UART value */ +#define UMCS_DCR1_UART_CURRENT_6MA 0x00 /* Output current 6mA */ +#define UMCS_DCR1_UART_CURRENT_8MA 0x04 /* Output current 8mA default */ +#define UMCS_DCR1_UART_CURRENT_10MA 0x08 /* UART output current 10mA */ +#define UMCS_DCR1_UART_CURRENT_12MA 0x0c /* UART output current 12mA */ +#define UMCS_DCR1_WAKEUP_DISABLE 0x10 /* Disable Remote USB Wakeup */ +#define UMCS_DCR1_PLLPWRDOWN_DISABLE 0x20 /* Disable PLL power down */ +#define UMCS_DCR1_LONG_INTERRUPT 0x40 /* Enable FIFO statistics */ +#define UMCS_DCR1_RESERVED1 0x80 /* Unused */ + +/* + * Bits of DCR2 registers, documented in datasheet + * Wakeup will work only if DCR0_IRDA = 0 (RS-xxx mode) and + * DCR1_WAKEUP_DISABLE = 0 (wakeup enabled). + */ +#define UMCS_DCR2_WAKEUP_CTS 0x01 /* Wakeup on CTS change, default = 0 */ +#define UMCS_DCR2_WAKEUP_DCD 0x02 /* Wakeup on DCD change, default = 0 */ +#define UMCS_DCR2_WAKEUP_RI 0x04 /* Wakeup on RI change, default = 1 */ +#define UMCS_DCR2_WAKEUP_DSR 0x08 /* Wakeup on DSR change, default = 0 */ +#define UMCS_DCR2_WAKEUP_RXD 0x10 /* Wakeup on RX Data change, dflt = 0 */ +#define UMCS_DCR2_WAKEUP_RESUME 0x20 /* Wakeup issues RESUME signal, + * DISCONNECT otherwise, default = 1 */ +#define UMCS_DCR2_RESERVED1 0x40 /* Unused */ +#define UMCS_DCR2_SHDN_POLARITY 0x80 /* 0: Pin 12 Active Low, 1: Pin 12 + * Active High, default = 0 */ + +/* Documented UART registers (fully compatible with 16550 UART) */ +#define UMCS_REG_THR 0x00 /* Transmitter Holding Register W */ +#define UMCS_REG_RHR 0x00 /* Receiver Holding Register R */ +#define UMCS_REG_IER 0x01 /* Interrupt enable register - R/W */ +#define UMCS_REG_FCR 0x02 /* FIFO Control register - W */ +#define UMCS_REG_ISR 0x02 /* Interrupt Status Registter R */ +#define UMCS_REG_LCR 0x03 /* Line control register R/W */ +#define UMCS_REG_MCR 0x04 /* Modem control register R/W */ +#define UMCS_REG_LSR 0x05 /* Line status register R */ +#define UMCS_REG_MSR 0x06 /* Modem status register R */ +#define UMCS_REG_SCRATCHPAD 0x07 /* Scratch pad register */ + +#define UMCS_REG_DLL 0x00 /* Low bits of BAUD divider */ +#define UMCS_REG_DLM 0x01 /* High bits of BAUD divider */ + +/* IER bits */ +#define UMCS_IER_RXREADY 0x01 /* RX Ready interrumpt mask */ +#define UMCS_IER_TXREADY 0x02 /* TX Ready interrumpt mask */ +#define UMCS_IER_RXSTAT 0x04 /* RX Status interrumpt mask */ +#define UMCS_IER_MODEM 0x08 /* Modem status change interrupt mask */ +#define UMCS_IER_SLEEP 0x10 /* SLEEP enable */ + +/* FCR bits */ +#define UMCS_FCR_ENABLE 0x01 /* Enable FIFO */ +#define UMCS_FCR_FLUSHRHR 0x02 /* Flush RHR and FIFO */ +#define UMCS_FCR_FLUSHTHR 0x04 /* Flush THR and FIFO */ +#define UMCS_FCR_RTLMASK 0xa0 /* Select RHR Interrupt Trigger level */ +#define UMCS_FCR_RTL_1_1 0x00 /* L1 = 1, L2 = 1 */ +#define UMCS_FCR_RTL_1_4 0x40 /* L1 = 1, L2 = 4 */ +#define UMCS_FCR_RTL_1_8 0x80 /* L1 = 1, L2 = 8 */ +#define UMCS_FCR_RTL_1_14 0xa0 /* L1 = 1, L2 = 14 */ + +/* ISR bits */ +#define UMCS_ISR_NOPENDING 0x01 /* No interrupt pending */ +#define UMCS_ISR_INTMASK 0x3f /* Mask to select interrupt source */ +#define UMCS_ISR_RXERR 0x06 /* Recevir error */ +#define UMCS_ISR_RXHASDATA 0x04 /* Recevier has data */ +#define UMCS_ISR_RXTIMEOUT 0x0c /* Recevier timeout */ +#define UMCS_ISR_TXEMPTY 0x02 /* Transmitter empty */ +#define UMCS_ISR_MSCHANGE 0x00 /* Modem status change */ + +/* LCR bits */ +#define UMCS_LCR_DATALENMASK 0x03 /* Mask for data length */ +#define UMCS_LCR_DATALEN5 0x00 /* 5 data bits */ +#define UMCS_LCR_DATALEN6 0x01 /* 6 data bits */ +#define UMCS_LCR_DATALEN7 0x02 /* 7 data bits */ +#define UMCS_LCR_DATALEN8 0x03 /* 8 data bits */ + +#define UMCS_LCR_STOPBMASK 0x04 /* Mask for stop bits */ +#define UMCS_LCR_STOPB1 0x00 /* 1 stop bit in any case */ +#define UMCS_LCR_STOPB2 0x04 /* 1.5-2 stop bits depends on data len*/ + +#define UMCS_LCR_PARITYMASK 0x38 /* Mask for all parity data */ +#define UMCS_LCR_PARITYON 0x08 /* Parity ON/OFF - ON */ +#define UMCS_LCR_PARITYODD 0x00 /* Parity Odd */ +#define UMCS_LCR_PARITYEVEN 0x10 /* Parity Even */ +#define UMCS_LCR_PARITYODD 0x00 /* Parity Odd */ +#define UMCS_LCR_PARITYFORCE 0x20 /* Force parity odd/even */ + +#define UMCS_LCR_BREAK 0x40 /* Send BREAK */ +#define UMCS_LCR_DIVISORS 0x80 /* Map DLL/DLM instead of xHR/IER */ + +/* LSR bits */ +#define UMCS_LSR_RHRAVAIL 0x01 /* Data available for read */ +#define UMCS_LSR_RHROVERRUN 0x02 /* Data FIFO/register overflow */ +#define UMCS_LSR_PARITYERR 0x04 /* Parity error */ +#define UMCS_LSR_FRAMEERR 0x10 /* Framing error */ +#define UMCS_LSR_BREAKERR 0x20 /* BREAK signal received */ +#define UMCS_LSR_THREMPTY 0x40 /* THR register is empty, ready for + * transmit */ +#define UMCS_LSR_HASERR 0x80 /* Has error in receiver FIFO */ + +/* MCR bits */ +#define UMCS_MCR_DTR 0x01 /* Force DTR to be active (low) */ +#define UMCS_MCR_RTS 0x02 /* Force RTS to be active (low) */ +#define UMCS_MCR_IE 0x04 /* Enable interrupts (not documented) */ +#define UMCS_MCR_LOOPBACK 0x10 /* Enable local loopback test mode */ +#define UMCS_MCR_CTSRTS 0x20 /* Enable CTS/RTS in 550 (FIFO) mode */ +#define UMCS_MCR_DTRDSR 0x40 /* Enable DTR/DSR in 550 (FIFO) mode */ +#define UMCS_MCR_DCD 0x80 /* Enable DCD in 550 (FIFO) mode */ + +/* MSR bits */ +#define UMCS_MSR_DELTACTS 0x01 /* CTS was changed since last read */ +#define UMCS_MSR_DELTADSR 0x02 /* DSR was changed since last read */ +#define UMCS_MSR_DELTARI 0x04 /* RI was changed since last read */ +#define UMCS_MSR_DELTADCD 0x08 /* DCD was changed since last read */ +#define UMCS_MSR_NEGCTS 0x10 /* Negated CTS signal */ +#define UMCS_MSR_NEGDSR 0x20 /* Negated DSR signal */ +#define UMCS_MSR_NEGRI 0x40 /* Negated RI signal */ +#define UMCS_MSR_NEGDCD 0x80 /* Negated DCD signal */ + +/* SCRATCHPAD bits */ +#define UMCS_SCRATCHPAD_RS232 0x00 /* RS-485 disabled */ +#define UMCS_SCRATCHPAD_RS485_DTRRX 0x80 /* RS-485 mode, DTR High = RX */ +#define UMCS_SCRATCHPAD_RS485_DTRTX 0xc0 /* RS-485 mode, DTR High = TX */ + +#endif /* _UMCS_H_ */ |