1*81508fe3Sjsg /* $OpenBSD: umcs.c,v 1.12 2024/05/23 03:21:09 jsg Exp $ */
21b055645Smpi /* $NetBSD: umcs.c,v 1.8 2014/08/23 21:37:56 martin Exp $ */
31b055645Smpi /* $FreeBSD: head/sys/dev/usb/serial/umcs.c 260559 2014-01-12 11:44:28Z hselasky $ */
41b055645Smpi
51b055645Smpi /*-
61b055645Smpi * Copyright (c) 2010 Lev Serebryakov <lev@FreeBSD.org>.
71b055645Smpi * All rights reserved.
81b055645Smpi *
91b055645Smpi * Redistribution and use in source and binary forms, with or without
101b055645Smpi * modification, are permitted provided that the following conditions
111b055645Smpi * are met:
121b055645Smpi * 1. Redistributions of source code must retain the above copyright
131b055645Smpi * notice, this list of conditions and the following disclaimer.
141b055645Smpi * 2. Redistributions in binary form must reproduce the above copyright
151b055645Smpi * notice, this list of conditions and the following disclaimer in the
161b055645Smpi * documentation and/or other materials provided with the distribution.
171b055645Smpi *
181b055645Smpi * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
191b055645Smpi * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
201b055645Smpi * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
211b055645Smpi * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
221b055645Smpi * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
231b055645Smpi * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
241b055645Smpi * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
251b055645Smpi * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
261b055645Smpi * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
271b055645Smpi * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
281b055645Smpi * SUCH DAMAGE.
291b055645Smpi */
301b055645Smpi
311b055645Smpi /*
321b055645Smpi * This driver supports several multiport USB-to-RS232 serial adapters driven
331b055645Smpi * by MosChip mos7820 and mos7840, bridge chips. The adapters are sold under
341b055645Smpi * many different brand names.
351b055645Smpi *
361b055645Smpi * Datasheets are available at MosChip www site at http://www.moschip.com.
371b055645Smpi * The datasheets don't contain full programming information for the chip.
381b055645Smpi *
394b1a56afSjsg * It is normal to have only two enabled ports in devices, based on quad-port
401b055645Smpi * mos7840.
411b055645Smpi */
421b055645Smpi
431b055645Smpi #include <sys/param.h>
441b055645Smpi #include <sys/systm.h>
451b055645Smpi #include <sys/malloc.h>
461b055645Smpi #include <sys/tty.h>
471b055645Smpi #include <sys/device.h>
48364e4a0cSmpi #include <sys/task.h>
491b055645Smpi
501b055645Smpi #include <dev/usb/usb.h>
511b055645Smpi #include <dev/usb/usbdi.h>
521b055645Smpi #include <dev/usb/usbdevs.h>
531b055645Smpi
541b055645Smpi #include <dev/usb/ucomvar.h>
551b055645Smpi
561b055645Smpi #include "umcs.h"
571b055645Smpi
581b055645Smpi #ifdef UMCS_DEBUG
591b055645Smpi #define DPRINTF(x...) printf(x)
601b055645Smpi #else
611b055645Smpi #define DPRINTF(x...)
621b055645Smpi #endif
631b055645Smpi
641b055645Smpi #define DEVNAME(_sc) ((_sc)->sc_dev.dv_xname)
651b055645Smpi
661b055645Smpi /*
671b055645Smpi * Two-port devices (both with 7820 chip and 7840 chip configured as two-port)
681b055645Smpi * have ports 0 and 2, with ports 1 and 3 omitted.
691b055645Smpi * So, PHYSICAL port numbers on two-port device will be 0 and 2.
701b055645Smpi *
711b055645Smpi * We use an array of the following struct, indexed by ucom port index,
721b055645Smpi * and include the physical port number in it.
731b055645Smpi */
741b055645Smpi struct umcs_port {
751b055645Smpi struct ucom_softc *ucom; /* ucom subdevice */
761b055645Smpi unsigned int pn; /* physical port number */
77364e4a0cSmpi int flags;
78364e4a0cSmpi #define UMCS_STATCHG 0x01
79364e4a0cSmpi
801b055645Smpi uint8_t lcr; /* local line control reg. */
811b055645Smpi uint8_t mcr; /* local modem control reg. */
821b055645Smpi };
831b055645Smpi
841b055645Smpi struct umcs_softc {
851b055645Smpi struct device sc_dev;
861b055645Smpi struct usbd_device *sc_udev; /* the usb device */
871b055645Smpi struct usbd_pipe *sc_ipipe; /* interrupt pipe */
881b055645Smpi uint8_t *sc_ibuf; /* buffer for interrupt xfer */
891b055645Smpi unsigned int sc_isize; /* size of buffer */
901b055645Smpi
911b055645Smpi struct umcs_port sc_subdevs[UMCS_MAX_PORTS];
921b055645Smpi uint8_t sc_numports; /* number of ports */
931b055645Smpi
941b055645Smpi int sc_init_done;
95364e4a0cSmpi struct task sc_status_task;
961b055645Smpi };
971b055645Smpi
981b055645Smpi int umcs_get_reg(struct umcs_softc *, uint8_t, uint8_t *);
991b055645Smpi int umcs_set_reg(struct umcs_softc *, uint8_t, uint8_t);
1001b055645Smpi int umcs_get_uart_reg(struct umcs_softc *, uint8_t, uint8_t, uint8_t *);
1011b055645Smpi int umcs_set_uart_reg(struct umcs_softc *, uint8_t, uint8_t, uint8_t);
1021b055645Smpi int umcs_calc_baudrate(uint32_t, uint16_t *, uint8_t *);
1031b055645Smpi int umcs_set_baudrate(struct umcs_softc *, uint8_t, uint32_t);
1041b055645Smpi void umcs_dtr(struct umcs_softc *, int, int);
1051b055645Smpi void umcs_rts(struct umcs_softc *, int, int);
1061b055645Smpi void umcs_break(struct umcs_softc *, int, int);
1071b055645Smpi
1081b055645Smpi int umcs_match(struct device *, void *, void *);
1091b055645Smpi void umcs_attach(struct device *, struct device *, void *);
1101b055645Smpi int umcs_detach(struct device *, int);
1111b055645Smpi void umcs_intr(struct usbd_xfer *, void *, usbd_status);
112364e4a0cSmpi void umcs_status_task(void *);
1131b055645Smpi
1141b055645Smpi void umcs_get_status(void *, int, uint8_t *, uint8_t *);
1151b055645Smpi void umcs_set(void *, int, int, int);
1161b055645Smpi int umcs_param(void *, int, struct termios *);
1171b055645Smpi int umcs_open(void *, int);
1181b055645Smpi void umcs_close(void *, int);
1191b055645Smpi
120c520a48cSnaddy const struct ucom_methods umcs_methods = {
1211b055645Smpi umcs_get_status,
1221b055645Smpi umcs_set,
1231b055645Smpi umcs_param,
1241b055645Smpi NULL,
1251b055645Smpi umcs_open,
1261b055645Smpi umcs_close,
1271b055645Smpi NULL,
1281b055645Smpi NULL,
1291b055645Smpi };
1301b055645Smpi
1311b055645Smpi const struct usb_devno umcs_devs[] = {
1321b055645Smpi { USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7810 },
1331b055645Smpi { USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7820 },
1341b055645Smpi { USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7840 },
1351b055645Smpi { USB_VENDOR_ATEN, USB_PRODUCT_ATEN_UC2324 }
1361b055645Smpi };
1371b055645Smpi
1381b055645Smpi struct cfdriver umcs_cd = {
1391b055645Smpi NULL, "umcs", DV_DULL
1401b055645Smpi };
1411b055645Smpi
1421b055645Smpi const struct cfattach umcs_ca = {
1431b055645Smpi sizeof(struct umcs_softc), umcs_match, umcs_attach, umcs_detach
1441b055645Smpi };
1451b055645Smpi
1461b055645Smpi
1471b055645Smpi static inline int
umcs_reg_sp(int pn)1481b055645Smpi umcs_reg_sp(int pn)
1491b055645Smpi {
1501b055645Smpi KASSERT(pn >= 0 && pn < 4);
1511b055645Smpi switch (pn) {
1521b055645Smpi default:
1531b055645Smpi case 0: return UMCS_SP1;
1541b055645Smpi case 1: return UMCS_SP2;
1551b055645Smpi case 2: return UMCS_SP3;
1561b055645Smpi case 3: return UMCS_SP4;
1571b055645Smpi }
1581b055645Smpi }
1591b055645Smpi
1601b055645Smpi static inline int
umcs_reg_ctrl(int pn)1611b055645Smpi umcs_reg_ctrl(int pn)
1621b055645Smpi {
1631b055645Smpi KASSERT(pn >= 0 && pn < 4);
1641b055645Smpi switch (pn) {
1651b055645Smpi default:
1661b055645Smpi case 0: return UMCS_CTRL1;
1671b055645Smpi case 1: return UMCS_CTRL2;
1681b055645Smpi case 2: return UMCS_CTRL3;
1691b055645Smpi case 3: return UMCS_CTRL4;
1701b055645Smpi }
1711b055645Smpi }
1721b055645Smpi
1731b055645Smpi int
umcs_match(struct device * dev,void * match,void * aux)1741b055645Smpi umcs_match(struct device *dev, void *match, void *aux)
1751b055645Smpi {
1761b055645Smpi struct usb_attach_arg *uaa = aux;
1771b055645Smpi
1784dd0bafbSmpi if (uaa->iface == NULL || uaa->ifaceno != UMCS_IFACE_NO)
1794dd0bafbSmpi return (UMATCH_NONE);
1804dd0bafbSmpi
1811b055645Smpi return (usb_lookup(umcs_devs, uaa->vendor, uaa->product) != NULL) ?
1821b055645Smpi UMATCH_VENDOR_PRODUCT : UMATCH_NONE;
1831b055645Smpi }
1841b055645Smpi
1851b055645Smpi void
umcs_attach(struct device * parent,struct device * self,void * aux)1861b055645Smpi umcs_attach(struct device *parent, struct device *self, void *aux)
1871b055645Smpi {
1881b055645Smpi struct umcs_softc *sc = (struct umcs_softc *)self;
1891b055645Smpi struct usb_attach_arg *uaa = aux;
1901b055645Smpi usb_interface_descriptor_t *id;
1911b055645Smpi usb_endpoint_descriptor_t *ed;
1921b055645Smpi struct ucom_attach_args uca;
1931b055645Smpi int error, i, intr_addr;
1941b055645Smpi uint8_t data;
1951b055645Smpi
1961b055645Smpi sc->sc_udev = uaa->device;
1971b055645Smpi
1981b055645Smpi /*
1991b055645Smpi * Get number of ports
2001b055645Smpi * Documentation (full datasheet) says, that number of ports is
2011b055645Smpi * set as UMCS_MODE_SELECT24S bit in MODE R/Only
2021b055645Smpi * register. But vendor driver uses these undocumented
2031b055645Smpi * register & bit.
2041b055645Smpi *
2051b055645Smpi * Experiments show, that MODE register can have `0'
2061b055645Smpi * (4 ports) bit on 2-port device, so use vendor driver's way.
2071b055645Smpi *
2081b055645Smpi * Also, see notes in header file for these constants.
2091b055645Smpi */
210d89ebf1cSmpi if (umcs_get_reg(sc, UMCS_GPIO, &data)) {
21149c516daSmpi printf("%s: unable to get number of ports\n", DEVNAME(sc));
21249c516daSmpi usbd_deactivate(sc->sc_udev);
21349c516daSmpi return;
21449c516daSmpi }
2151b055645Smpi if (data & UMCS_GPIO_4PORTS)
2161b055645Smpi sc->sc_numports = 4; /* physical port no are : 0, 1, 2, 3 */
2171b055645Smpi else if (uaa->product == USB_PRODUCT_MOSCHIP_MCS7810)
2181b055645Smpi sc->sc_numports = 1;
2191b055645Smpi else
2201b055645Smpi sc->sc_numports = 2; /* physical port no are: 0 and 2 */
2211b055645Smpi
2221b055645Smpi #ifdef UMCS_DEBUG
2231b055645Smpi if (!umcs_get_reg(sc, UMCS_MODE, &data)) {
2244b1a56afSjsg printf("%s: On-die configuration: RST: active %s, "
2251b055645Smpi "HRD: %s, PLL: %s, POR: %s, Ports: %s, EEPROM write %s, "
2261b055645Smpi "IrDA is %savailable\n", DEVNAME(sc),
2271b055645Smpi (data & UMCS_MODE_RESET) ? "low" : "high",
2281b055645Smpi (data & UMCS_MODE_SER_PRSNT) ? "yes" : "no",
2291b055645Smpi (data & UMCS_MODE_PLLBYPASS) ? "bypassed" : "avail",
2301b055645Smpi (data & UMCS_MODE_PORBYPASS) ? "bypassed" : "avail",
2311b055645Smpi (data & UMCS_MODE_SELECT24S) ? "2" : "4",
2321b055645Smpi (data & UMCS_MODE_EEPROMWR) ? "enabled" : "disabled",
2331b055645Smpi (data & UMCS_MODE_IRDA) ? "" : "not ");
2341b055645Smpi }
2351b055645Smpi #endif
2361b055645Smpi
2371b055645Smpi /* Set up the interrupt pipe */
2384dd0bafbSmpi id = usbd_get_interface_descriptor(uaa->iface);
2391b055645Smpi intr_addr = -1;
2401b055645Smpi for (i = 0 ; i < id->bNumEndpoints ; i++) {
2414dd0bafbSmpi ed = usbd_interface2endpoint_descriptor(uaa->iface, i);
2421b055645Smpi if (ed == NULL) {
2431b055645Smpi printf("%s: no endpoint descriptor found for %d\n",
2441b055645Smpi DEVNAME(sc), i);
2451b055645Smpi usbd_deactivate(sc->sc_udev);
2461b055645Smpi return;
2471b055645Smpi }
2481b055645Smpi
2491b055645Smpi if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
2501b055645Smpi UE_GET_XFERTYPE(ed->bmAttributes) != UE_INTERRUPT)
2511b055645Smpi continue;
2521b055645Smpi sc->sc_isize = UGETW(ed->wMaxPacketSize);
2531b055645Smpi intr_addr = ed->bEndpointAddress;
2541b055645Smpi break;
2551b055645Smpi }
2561b055645Smpi if (intr_addr < 0) {
2571b055645Smpi printf("%s: missing endpoint\n", DEVNAME(sc));
2581b055645Smpi usbd_deactivate(sc->sc_udev);
2591b055645Smpi return;
2601b055645Smpi }
2611b055645Smpi sc->sc_ibuf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK);
2621b055645Smpi
2634dd0bafbSmpi error = usbd_open_pipe_intr(uaa->iface, intr_addr,
2641b055645Smpi USBD_SHORT_XFER_OK, &sc->sc_ipipe, sc, sc->sc_ibuf,
2651b055645Smpi sc->sc_isize, umcs_intr, 100 /* XXX */);
2661b055645Smpi if (error) {
2671b055645Smpi printf("%s: cannot open interrupt pipe (addr %d)\n",
2681b055645Smpi DEVNAME(sc), intr_addr);
2691b055645Smpi usbd_deactivate(sc->sc_udev);
2701b055645Smpi return;
2711b055645Smpi }
2721b055645Smpi
2731b055645Smpi memset(&uca, 0, sizeof uca);
2741b055645Smpi uca.ibufsize = 256;
2751b055645Smpi uca.obufsize = 256;
2761b055645Smpi uca.ibufsizepad = 256;
2771b055645Smpi uca.opkthdrlen = 0;
2781b055645Smpi uca.device = sc->sc_udev;
2794dd0bafbSmpi uca.iface = uaa->iface;
2801b055645Smpi uca.methods = &umcs_methods;
2811b055645Smpi uca.arg = sc;
2821b055645Smpi
2831b055645Smpi for (i = 0; i < sc->sc_numports; i++) {
2841b055645Smpi uca.bulkin = uca.bulkout = -1;
2851b055645Smpi
2861b055645Smpi /*
2871b055645Smpi * On 4 port cards, endpoints are 0/1, 2/3, 4/5, and 6/7.
2881b055645Smpi * On 2 port cards, they are 0/1 and 4/5.
2891b055645Smpi * On single port, just 0/1 will be used.
2901b055645Smpi */
2911b055645Smpi int pn = i * (sc->sc_numports == 2 ? 2 : 1);
2921b055645Smpi
2934dd0bafbSmpi ed = usbd_interface2endpoint_descriptor(uaa->iface, pn*2);
2941b055645Smpi if (ed == NULL) {
2951b055645Smpi printf("%s: no bulk in endpoint found for %d\n",
2961b055645Smpi DEVNAME(sc), i);
2971b055645Smpi usbd_deactivate(sc->sc_udev);
2981b055645Smpi return;
2991b055645Smpi }
3001b055645Smpi uca.bulkin = ed->bEndpointAddress;
3011b055645Smpi
3024dd0bafbSmpi ed = usbd_interface2endpoint_descriptor(uaa->iface, pn*2+1);
3031b055645Smpi if (ed == NULL) {
3041b055645Smpi printf("%s: no bulk out endpoint found for %d\n",
3051b055645Smpi DEVNAME(sc), i);
3061b055645Smpi usbd_deactivate(sc->sc_udev);
3071b055645Smpi return;
3081b055645Smpi }
3091b055645Smpi uca.bulkout = ed->bEndpointAddress;
3101b055645Smpi uca.portno = i;
3111b055645Smpi
3121b055645Smpi sc->sc_subdevs[i].pn = pn;
3131b055645Smpi sc->sc_subdevs[i].ucom = (struct ucom_softc *)
3141b055645Smpi config_found_sm(self, &uca, ucomprint, ucomsubmatch);
3151b055645Smpi }
316364e4a0cSmpi
317364e4a0cSmpi task_set(&sc->sc_status_task, umcs_status_task, sc);
3181b055645Smpi }
3191b055645Smpi
3201b055645Smpi int
umcs_get_reg(struct umcs_softc * sc,uint8_t reg,uint8_t * data)3211b055645Smpi umcs_get_reg(struct umcs_softc *sc, uint8_t reg, uint8_t *data)
3221b055645Smpi {
3231b055645Smpi usb_device_request_t req;
3241b055645Smpi
3251b055645Smpi req.bmRequestType = UT_READ_VENDOR_DEVICE;
3261b055645Smpi req.bRequest = UMCS_READ;
3271b055645Smpi USETW(req.wValue, 0);
3281b055645Smpi USETW(req.wIndex, reg);
3291b055645Smpi USETW(req.wLength, UMCS_READ_LENGTH);
3301b055645Smpi
3311b055645Smpi if (usbd_do_request(sc->sc_udev, &req, data))
3321b055645Smpi return (EIO);
3331b055645Smpi
3341b055645Smpi return (0);
3351b055645Smpi }
3361b055645Smpi
3371b055645Smpi int
umcs_set_reg(struct umcs_softc * sc,uint8_t reg,uint8_t data)3381b055645Smpi umcs_set_reg(struct umcs_softc *sc, uint8_t reg, uint8_t data)
3391b055645Smpi {
3401b055645Smpi usb_device_request_t req;
3411b055645Smpi
3421b055645Smpi req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
3431b055645Smpi req.bRequest = UMCS_WRITE;
3441b055645Smpi USETW(req.wValue, data);
3451b055645Smpi USETW(req.wIndex, reg);
3461b055645Smpi USETW(req.wLength, 0);
3471b055645Smpi
3481b055645Smpi if (usbd_do_request(sc->sc_udev, &req, NULL))
3491b055645Smpi return (EIO);
3501b055645Smpi
3511b055645Smpi return (0);
3521b055645Smpi }
3531b055645Smpi
3541b055645Smpi int
umcs_get_uart_reg(struct umcs_softc * sc,uint8_t portno,uint8_t reg,uint8_t * data)3551b055645Smpi umcs_get_uart_reg(struct umcs_softc *sc, uint8_t portno, uint8_t reg,
3561b055645Smpi uint8_t *data)
3571b055645Smpi {
3581b055645Smpi usb_device_request_t req;
3591b055645Smpi uint16_t wVal;
3601b055645Smpi
3611b055645Smpi wVal = ((uint16_t)(sc->sc_subdevs[portno].pn + 1)) << 8;
3621b055645Smpi
3631b055645Smpi req.bmRequestType = UT_READ_VENDOR_DEVICE;
3641b055645Smpi req.bRequest = UMCS_READ;
3651b055645Smpi USETW(req.wValue, wVal);
3661b055645Smpi USETW(req.wIndex, reg);
3671b055645Smpi USETW(req.wLength, UMCS_READ_LENGTH);
3681b055645Smpi
3691b055645Smpi if (usbd_do_request(sc->sc_udev, &req, data))
3701b055645Smpi return (EIO);
3711b055645Smpi
3721b055645Smpi return (0);
3731b055645Smpi }
3741b055645Smpi
3751b055645Smpi int
umcs_set_uart_reg(struct umcs_softc * sc,uint8_t portno,uint8_t reg,uint8_t data)3761b055645Smpi umcs_set_uart_reg(struct umcs_softc *sc, uint8_t portno, uint8_t reg,
3771b055645Smpi uint8_t data)
3781b055645Smpi {
3791b055645Smpi usb_device_request_t req;
3801b055645Smpi uint16_t wVal;
3811b055645Smpi
3821b055645Smpi wVal = ((uint16_t)(sc->sc_subdevs[portno].pn + 1)) << 8 | data;
3831b055645Smpi
3841b055645Smpi req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
3851b055645Smpi req.bRequest = UMCS_WRITE;
3861b055645Smpi USETW(req.wValue, wVal);
3871b055645Smpi USETW(req.wIndex, reg);
3881b055645Smpi USETW(req.wLength, 0);
3891b055645Smpi
3901b055645Smpi if (usbd_do_request(sc->sc_udev, &req, NULL))
3911b055645Smpi return (EIO);
3921b055645Smpi
3931b055645Smpi return (0);
3941b055645Smpi }
3951b055645Smpi
3961b055645Smpi int
umcs_set_baudrate(struct umcs_softc * sc,uint8_t portno,uint32_t rate)3971b055645Smpi umcs_set_baudrate(struct umcs_softc *sc, uint8_t portno, uint32_t rate)
3981b055645Smpi {
3991b055645Smpi int pn = sc->sc_subdevs[portno].pn;
4001b055645Smpi int spreg = umcs_reg_sp(pn);
4011b055645Smpi uint8_t lcr = sc->sc_subdevs[portno].lcr;
4021b055645Smpi uint8_t clk, data;
4031b055645Smpi uint16_t div;
4041b055645Smpi
4051b055645Smpi if (umcs_calc_baudrate(rate, &div, &clk))
4061b055645Smpi return (EINVAL);
4071b055645Smpi
4081b055645Smpi DPRINTF("%s: portno %d set speed: %d (%02x/%d)\n", DEVNAME(sc), portno,
4091b055645Smpi rate, clk, div);
4101b055645Smpi
4114b1a56afSjsg /* Set clock source for standard BAUD frequencies */
4121b055645Smpi if (umcs_get_reg(sc, spreg, &data))
4131b055645Smpi return (EIO);
4141b055645Smpi data &= UMCS_SPx_CLK_MASK;
4151b055645Smpi if (umcs_set_reg(sc, spreg, data | clk))
4161b055645Smpi return (EIO);
4171b055645Smpi
4181b055645Smpi /* Set divider */
4191b055645Smpi lcr |= UMCS_LCR_DIVISORS;
4201b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_LCR, lcr))
4211b055645Smpi return (EIO);
4221b055645Smpi sc->sc_subdevs[portno].lcr = lcr;
4231b055645Smpi
4241b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_DLL, div & 0xff) ||
4251b055645Smpi umcs_set_uart_reg(sc, portno, UMCS_REG_DLM, (div >> 8) & 0xff))
4261b055645Smpi return (EIO);
4271b055645Smpi
4281b055645Smpi /* Turn off access to DLL/DLM registers of UART */
4291b055645Smpi lcr &= ~UMCS_LCR_DIVISORS;
4301b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_LCR, lcr))
4311b055645Smpi return (EIO);
4321b055645Smpi sc->sc_subdevs[portno].lcr = lcr;
4331b055645Smpi
4341b055645Smpi return (0);
4351b055645Smpi }
4361b055645Smpi
4374b1a56afSjsg /* Maximum speeds for standard frequencies, when PLL is not used */
4381b055645Smpi static const uint32_t umcs_baudrate_divisors[] = {
4391b055645Smpi 0, 115200, 230400, 403200, 460800, 806400, 921600, 1572864, 3145728,
4401b055645Smpi };
4411b055645Smpi
4421b055645Smpi int
umcs_calc_baudrate(uint32_t rate,uint16_t * divisor,uint8_t * clk)4431b055645Smpi umcs_calc_baudrate(uint32_t rate, uint16_t *divisor, uint8_t *clk)
4441b055645Smpi {
4451b055645Smpi const uint8_t divisors_len = nitems(umcs_baudrate_divisors);
4461b055645Smpi uint8_t i = 0;
4471b055645Smpi
4481b055645Smpi if (rate > umcs_baudrate_divisors[divisors_len - 1])
4491b055645Smpi return (-1);
4501b055645Smpi
4511b055645Smpi for (i = 0; i < divisors_len - 1; i++) {
4521b055645Smpi if (rate > umcs_baudrate_divisors[i] &&
453739356a6Smpi rate <= umcs_baudrate_divisors[i + 1]) {
4541b055645Smpi *divisor = umcs_baudrate_divisors[i + 1] / rate;
4551b055645Smpi /* 0x00 .. 0x70 */
4561b055645Smpi *clk = i << UMCS_SPx_CLK_SHIFT;
4571b055645Smpi return (0);
4581b055645Smpi }
459739356a6Smpi }
460739356a6Smpi
461739356a6Smpi return (-1);
462739356a6Smpi }
4631b055645Smpi
4641b055645Smpi int
umcs_detach(struct device * self,int flags)4651b055645Smpi umcs_detach(struct device *self, int flags)
4661b055645Smpi {
4671b055645Smpi struct umcs_softc *sc = (struct umcs_softc *)self;
4681b055645Smpi
469364e4a0cSmpi task_del(systq, &sc->sc_status_task);
470364e4a0cSmpi
4711b055645Smpi if (sc->sc_ipipe != NULL) {
4721b055645Smpi usbd_close_pipe(sc->sc_ipipe);
4731b055645Smpi sc->sc_ipipe = NULL;
4741b055645Smpi }
4751b055645Smpi
4761b055645Smpi if (sc->sc_ibuf != NULL) {
4771b055645Smpi free(sc->sc_ibuf, M_USBDEV, sc->sc_isize);
4781b055645Smpi sc->sc_ibuf = NULL;
4791b055645Smpi }
4801b055645Smpi
4811b055645Smpi return (config_detach_children(self, flags));
4821b055645Smpi }
4831b055645Smpi
4841b055645Smpi void
umcs_get_status(void * self,int portno,uint8_t * lsr,uint8_t * msr)4851b055645Smpi umcs_get_status(void *self, int portno, uint8_t *lsr, uint8_t *msr)
4861b055645Smpi {
4871b055645Smpi struct umcs_softc *sc = self;
4881b055645Smpi uint8_t hw_lsr = 0; /* local line status register */
4891b055645Smpi uint8_t hw_msr = 0; /* local modem status register */
4901b055645Smpi
4911b055645Smpi if (usbd_is_dying(sc->sc_udev))
4921b055645Smpi return;
4931b055645Smpi
4941b055645Smpi /* Read LSR & MSR */
4951b055645Smpi if (umcs_get_uart_reg(sc, portno, UMCS_REG_LSR, &hw_lsr) ||
4961b055645Smpi umcs_get_uart_reg(sc, portno, UMCS_REG_MSR, &hw_msr))
4971b055645Smpi return;
4981b055645Smpi
4991b055645Smpi *lsr = hw_lsr;
5001b055645Smpi *msr = hw_msr;
5011b055645Smpi }
5021b055645Smpi
5031b055645Smpi void
umcs_set(void * self,int portno,int reg,int onoff)5041b055645Smpi umcs_set(void *self, int portno, int reg, int onoff)
5051b055645Smpi {
5061b055645Smpi struct umcs_softc *sc = self;
5071b055645Smpi
5081b055645Smpi if (usbd_is_dying(sc->sc_udev))
5091b055645Smpi return;
5101b055645Smpi
5111b055645Smpi switch (reg) {
5121b055645Smpi case UCOM_SET_DTR:
5131b055645Smpi umcs_dtr(sc, portno, onoff);
5141b055645Smpi break;
5151b055645Smpi case UCOM_SET_RTS:
5161b055645Smpi umcs_rts(sc, portno, onoff);
5171b055645Smpi break;
5181b055645Smpi case UCOM_SET_BREAK:
5191b055645Smpi umcs_break(sc, portno, onoff);
5201b055645Smpi break;
5211b055645Smpi default:
5221b055645Smpi break;
5231b055645Smpi }
5241b055645Smpi }
5251b055645Smpi
5261b055645Smpi int
umcs_param(void * self,int portno,struct termios * t)5271b055645Smpi umcs_param(void *self, int portno, struct termios *t)
5281b055645Smpi {
5291b055645Smpi struct umcs_softc *sc = self;
5301b055645Smpi uint8_t lcr = sc->sc_subdevs[portno].lcr;
5311b055645Smpi uint8_t mcr = sc->sc_subdevs[portno].mcr;
5321b055645Smpi int error = 0;
5331b055645Smpi
5341b055645Smpi if (t->c_cflag & CSTOPB)
5351b055645Smpi lcr |= UMCS_LCR_STOPB2;
5361b055645Smpi else
5371b055645Smpi lcr |= UMCS_LCR_STOPB1;
5381b055645Smpi
5391b055645Smpi lcr &= ~UMCS_LCR_PARITYMASK;
5401b055645Smpi if (t->c_cflag & PARENB) {
5411b055645Smpi lcr |= UMCS_LCR_PARITYON;
5421b055645Smpi if (t->c_cflag & PARODD) {
5432923759dSjsg lcr |= UMCS_LCR_PARITYODD;
5441b055645Smpi } else {
5452923759dSjsg lcr |= UMCS_LCR_PARITYEVEN;
5461b055645Smpi }
5471b055645Smpi } else {
5481b055645Smpi lcr &= ~UMCS_LCR_PARITYON;
5491b055645Smpi }
5501b055645Smpi
5511b055645Smpi lcr &= ~UMCS_LCR_DATALENMASK;
5521b055645Smpi switch (t->c_cflag & CSIZE) {
5531b055645Smpi case CS5:
5541b055645Smpi lcr |= UMCS_LCR_DATALEN5;
5551b055645Smpi break;
5561b055645Smpi case CS6:
5571b055645Smpi lcr |= UMCS_LCR_DATALEN6;
5581b055645Smpi break;
5591b055645Smpi case CS7:
5601b055645Smpi lcr |= UMCS_LCR_DATALEN7;
5611b055645Smpi break;
5621b055645Smpi case CS8:
5631b055645Smpi lcr |= UMCS_LCR_DATALEN8;
5641b055645Smpi break;
5651b055645Smpi }
5661b055645Smpi
5671b055645Smpi if (t->c_cflag & CRTSCTS)
5681b055645Smpi mcr |= UMCS_MCR_CTSRTS;
5691b055645Smpi else
5701b055645Smpi mcr &= ~UMCS_MCR_CTSRTS;
5711b055645Smpi
5721b055645Smpi if (t->c_cflag & CLOCAL)
5731b055645Smpi mcr &= ~UMCS_MCR_DTRDSR;
5741b055645Smpi else
5751b055645Smpi mcr |= UMCS_MCR_DTRDSR;
5761b055645Smpi
5771b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_LCR, lcr))
5781b055645Smpi return (EIO);
5791b055645Smpi sc->sc_subdevs[portno].lcr = lcr;
5801b055645Smpi
5811b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_MCR, mcr))
5821b055645Smpi return (EIO);
5831b055645Smpi sc->sc_subdevs[portno].mcr = mcr;
5841b055645Smpi
5851b055645Smpi error = umcs_set_baudrate(sc, portno, t->c_ospeed);
5861b055645Smpi
5871b055645Smpi return (error);
5881b055645Smpi }
5891b055645Smpi
5901b055645Smpi void
umcs_dtr(struct umcs_softc * sc,int portno,int onoff)5911b055645Smpi umcs_dtr(struct umcs_softc *sc, int portno, int onoff)
5921b055645Smpi {
5931b055645Smpi uint8_t mcr = sc->sc_subdevs[portno].mcr;
5941b055645Smpi
5951b055645Smpi if (onoff)
5961b055645Smpi mcr |= UMCS_MCR_DTR;
5971b055645Smpi else
5981b055645Smpi mcr &= ~UMCS_MCR_DTR;
5991b055645Smpi
6001b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_MCR, mcr))
6011b055645Smpi return;
6021b055645Smpi sc->sc_subdevs[portno].mcr = mcr;
6031b055645Smpi }
6041b055645Smpi
6051b055645Smpi void
umcs_rts(struct umcs_softc * sc,int portno,int onoff)6061b055645Smpi umcs_rts(struct umcs_softc *sc, int portno, int onoff)
6071b055645Smpi {
6081b055645Smpi uint8_t mcr = sc->sc_subdevs[portno].mcr;
6091b055645Smpi
6101b055645Smpi if (onoff)
6111b055645Smpi mcr |= UMCS_MCR_RTS;
6121b055645Smpi else
6131b055645Smpi mcr &= ~UMCS_MCR_RTS;
6141b055645Smpi
6151b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_MCR, mcr))
6161b055645Smpi return;
6171b055645Smpi sc->sc_subdevs[portno].mcr = mcr;
6181b055645Smpi }
6191b055645Smpi
6201b055645Smpi void
umcs_break(struct umcs_softc * sc,int portno,int onoff)6211b055645Smpi umcs_break(struct umcs_softc *sc, int portno, int onoff)
6221b055645Smpi {
6231b055645Smpi uint8_t lcr = sc->sc_subdevs[portno].lcr;
6241b055645Smpi
6251b055645Smpi if (onoff)
6261b055645Smpi lcr |= UMCS_LCR_BREAK;
6271b055645Smpi else
6281b055645Smpi lcr &= ~UMCS_LCR_BREAK;
6291b055645Smpi
6301b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_LCR, lcr))
6311b055645Smpi return;
6321b055645Smpi sc->sc_subdevs[portno].lcr = lcr;
6331b055645Smpi }
6341b055645Smpi
6351b055645Smpi int
umcs_open(void * self,int portno)6361b055645Smpi umcs_open(void *self, int portno)
6371b055645Smpi {
6381b055645Smpi struct umcs_softc *sc = self;
6391b055645Smpi int pn = sc->sc_subdevs[portno].pn;
6401b055645Smpi int spreg = umcs_reg_sp(pn);
6411b055645Smpi int ctrlreg = umcs_reg_ctrl(pn);
6421b055645Smpi uint8_t mcr = sc->sc_subdevs[portno].mcr;
6431b055645Smpi uint8_t lcr = sc->sc_subdevs[portno].lcr;
6441b055645Smpi uint8_t data;
6451b055645Smpi int error;
6461b055645Smpi
6471b055645Smpi if (usbd_is_dying(sc->sc_udev))
6481b055645Smpi return (EIO);
6491b055645Smpi
6501b055645Smpi /* If it very first open, finish global configuration */
6511b055645Smpi if (!sc->sc_init_done) {
6521b055645Smpi if (umcs_get_reg(sc, UMCS_CTRL1, &data) ||
6531b055645Smpi umcs_set_reg(sc, UMCS_CTRL1, data | UMCS_CTRL1_DRIVER_DONE))
6541b055645Smpi return (EIO);
6551b055645Smpi sc->sc_init_done = 1;
6561b055645Smpi }
6571b055645Smpi
6581b055645Smpi /* Toggle reset bit on-off */
6591b055645Smpi if (umcs_get_reg(sc, spreg, &data) ||
6601b055645Smpi umcs_set_reg(sc, spreg, data | UMCS_SPx_UART_RESET) ||
6611b055645Smpi umcs_set_reg(sc, spreg, data & ~UMCS_SPx_UART_RESET))
6621b055645Smpi return (EIO);
6631b055645Smpi
6641b055645Smpi /* Set RS-232 mode */
6651b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_SCRATCHPAD,
6661b055645Smpi UMCS_SCRATCHPAD_RS232))
6671b055645Smpi return (EIO);
6681b055645Smpi
6691b055645Smpi /* Disable RX on time of initialization */
6701b055645Smpi if (umcs_get_reg(sc, ctrlreg, &data) ||
6711b055645Smpi umcs_set_reg(sc, ctrlreg, data | UMCS_CTRL_RX_DISABLE))
6721b055645Smpi return (EIO);
6731b055645Smpi
6741b055645Smpi /* Disable all interrupts */
6751b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_IER, 0))
6761b055645Smpi return (EIO);
6771b055645Smpi
6781b055645Smpi /* Reset FIFO -- documented */
6791b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_FCR, 0) ||
6801b055645Smpi umcs_set_uart_reg(sc, portno, UMCS_REG_FCR,
6811b055645Smpi UMCS_FCR_ENABLE | UMCS_FCR_FLUSHRHR |
6821b055645Smpi UMCS_FCR_FLUSHTHR | UMCS_FCR_RTL_1_14))
6831b055645Smpi return (EIO);
6841b055645Smpi
6851b055645Smpi /* Set 8 bit, no parity, 1 stop bit -- documented */
6861b055645Smpi lcr = UMCS_LCR_DATALEN8 | UMCS_LCR_STOPB1;
6871b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_LCR, lcr))
6881b055645Smpi return (EIO);
6891b055645Smpi sc->sc_subdevs[portno].lcr = lcr;
6901b055645Smpi
6911b055645Smpi /*
6921b055645Smpi * Enable DTR/RTS on modem control, enable modem interrupts --
6931b055645Smpi * documented
6941b055645Smpi */
6951b055645Smpi mcr = UMCS_MCR_DTR | UMCS_MCR_RTS | UMCS_MCR_IE;
6961b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_MCR, mcr))
6971b055645Smpi return (EIO);
6981b055645Smpi sc->sc_subdevs[portno].mcr = mcr;
6991b055645Smpi
7001b055645Smpi /* Clearing Bulkin and Bulkout FIFO */
7011b055645Smpi if (umcs_get_reg(sc, spreg, &data))
7021b055645Smpi return (EIO);
7031b055645Smpi data |= UMCS_SPx_RESET_OUT_FIFO|UMCS_SPx_RESET_IN_FIFO;
7041b055645Smpi if (umcs_set_reg(sc, spreg, data))
7051b055645Smpi return (EIO);
7061b055645Smpi data &= ~(UMCS_SPx_RESET_OUT_FIFO|UMCS_SPx_RESET_IN_FIFO);
7071b055645Smpi if (umcs_set_reg(sc, spreg, data))
7081b055645Smpi return (EIO);
7091b055645Smpi
7101b055645Smpi /* Set speed 9600 */
7111b055645Smpi if ((error = umcs_set_baudrate(sc, portno, 9600)) != 0)
7121b055645Smpi return (error);
7131b055645Smpi
7141b055645Smpi /* Finally enable all interrupts -- documented */
7151b055645Smpi /*
7161b055645Smpi * Copied from vendor driver, I don't know why we should read LCR
7171b055645Smpi * here
7181b055645Smpi */
7191b055645Smpi if (umcs_get_uart_reg(sc, portno, UMCS_REG_LCR,
7201b055645Smpi &sc->sc_subdevs[portno].lcr))
7211b055645Smpi return (EIO);
7221b055645Smpi if (umcs_set_uart_reg(sc, portno, UMCS_REG_IER,
7231b055645Smpi UMCS_IER_RXSTAT | UMCS_IER_MODEM))
7241b055645Smpi return (EIO);
7251b055645Smpi
7261b055645Smpi /* Enable RX */
7271b055645Smpi if (umcs_get_reg(sc, ctrlreg, &data) ||
7281b055645Smpi umcs_set_reg(sc, ctrlreg, data & ~UMCS_CTRL_RX_DISABLE))
7291b055645Smpi return (EIO);
7301b055645Smpi
7311b055645Smpi return (0);
7321b055645Smpi }
7331b055645Smpi
7341b055645Smpi void
umcs_close(void * self,int portno)7351b055645Smpi umcs_close(void *self, int portno)
7361b055645Smpi {
7371b055645Smpi struct umcs_softc *sc = self;
7381b055645Smpi int pn = sc->sc_subdevs[portno].pn;
7391b055645Smpi int ctrlreg = umcs_reg_ctrl(pn);
7401b055645Smpi uint8_t data;
7411b055645Smpi
7421b055645Smpi if (usbd_is_dying(sc->sc_udev))
7431b055645Smpi return;
7441b055645Smpi
7451b055645Smpi umcs_set_uart_reg(sc, portno, UMCS_REG_MCR, 0);
7461b055645Smpi umcs_set_uart_reg(sc, portno, UMCS_REG_IER, 0);
7471b055645Smpi
7481b055645Smpi /* Disable RX */
7491b055645Smpi if (umcs_get_reg(sc, ctrlreg, &data) ||
7501b055645Smpi umcs_set_reg(sc, ctrlreg, data | UMCS_CTRL_RX_DISABLE))
7511b055645Smpi return;
7521b055645Smpi }
7531b055645Smpi
7541b055645Smpi void
umcs_intr(struct usbd_xfer * xfer,void * priv,usbd_status status)7551b055645Smpi umcs_intr(struct usbd_xfer *xfer, void *priv, usbd_status status)
7561b055645Smpi {
7571b055645Smpi struct umcs_softc *sc = priv;
7581b055645Smpi uint8_t *buf = sc->sc_ibuf;
7591b055645Smpi int actlen, i;
7601b055645Smpi
7611b055645Smpi if (usbd_is_dying(sc->sc_udev))
7621b055645Smpi return;
7631b055645Smpi
7641b055645Smpi if (status == USBD_CANCELLED || status == USBD_IOERROR)
7651b055645Smpi return;
7661b055645Smpi
7671b055645Smpi if (status != USBD_NORMAL_COMPLETION) {
7681b055645Smpi DPRINTF("%s: interrupt status=%d\n", DEVNAME(sc), status);
7691b055645Smpi usbd_clear_endpoint_stall_async(sc->sc_ipipe);
7701b055645Smpi return;
7711b055645Smpi }
7721b055645Smpi
7731b055645Smpi usbd_get_xfer_status(xfer, NULL, NULL, &actlen, NULL);
7741b055645Smpi if (actlen != 5 && actlen != 13) {
7751b055645Smpi printf("%s: invalid interrupt data length %d\n", DEVNAME(sc),
7761b055645Smpi actlen);
7771b055645Smpi return;
7781b055645Smpi }
7791b055645Smpi
7801b055645Smpi /* Check status of all ports */
7811b055645Smpi for (i = 0; i < sc->sc_numports; i++) {
7821b055645Smpi uint8_t pn = sc->sc_subdevs[i].pn;
7831b055645Smpi
7841b055645Smpi if (buf[pn] & UMCS_ISR_NOPENDING)
7851b055645Smpi continue;
7861b055645Smpi
7871b055645Smpi DPRINTF("%s: port %d has pending interrupt: %02x, FIFO=%02x\n",
7881b055645Smpi DEVNAME(sc), i, buf[pn] & UMCS_ISR_INTMASK,
7891b055645Smpi buf[pn] & (~UMCS_ISR_INTMASK));
7901b055645Smpi
7911b055645Smpi switch (buf[pn] & UMCS_ISR_INTMASK) {
7921b055645Smpi case UMCS_ISR_RXERR:
7931b055645Smpi case UMCS_ISR_RXHASDATA:
7941b055645Smpi case UMCS_ISR_RXTIMEOUT:
7951b055645Smpi case UMCS_ISR_MSCHANGE:
796364e4a0cSmpi sc->sc_subdevs[i].flags |= UMCS_STATCHG;
797364e4a0cSmpi task_add(systq, &sc->sc_status_task);
7981b055645Smpi break;
7991b055645Smpi default:
8001b055645Smpi /* Do nothing */
8011b055645Smpi break;
8021b055645Smpi }
8031b055645Smpi }
8041b055645Smpi }
805364e4a0cSmpi
806364e4a0cSmpi void
umcs_status_task(void * arg)807364e4a0cSmpi umcs_status_task(void *arg)
808364e4a0cSmpi {
809364e4a0cSmpi struct umcs_softc *sc = arg;
810364e4a0cSmpi int i;
811364e4a0cSmpi
812364e4a0cSmpi for (i = 0; i < sc->sc_numports; i++) {
813364e4a0cSmpi if ((sc->sc_subdevs[i].flags & UMCS_STATCHG) == 0)
814364e4a0cSmpi continue;
815364e4a0cSmpi
816364e4a0cSmpi sc->sc_subdevs[i].flags &= ~UMCS_STATCHG;
817364e4a0cSmpi ucom_status_change(sc->sc_subdevs[i].ucom);
818364e4a0cSmpi }
819364e4a0cSmpi }
820