/*      $NetBSD: uark.c,v 1.18 2021/08/07 16:19:17 thorpej Exp $        */
/*      $OpenBSD: uark.c,v 1.13 2009/10/13 19:33:17 pirofti Exp $       */

/*
 * Copyright (c) 2006 Jonathan Gray <jsg@openbsd.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: uark.c,v 1.18 2021/08/07 16:19:17 thorpej Exp $");

#ifdef _KERNEL_OPT
#include "opt_usb.h"
#endif

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/conf.h>
#include <sys/tty.h>
#include <sys/device.h>

#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usbdi_util.h>
#include <dev/usb/usbdevs.h>

#include <dev/usb/ucomvar.h>

#ifdef UARK_DEBUG
#define DPRINTFN(n, x)  do { if (uarkdebug > (n)) printf x; } while (0)
int     uarkebug = 0;
#else
#define DPRINTFN(n, x)
#endif
#define DPRINTF(x) DPRINTFN(0, x)

#define UARKBUFSZ               256
#define UARK_CONFIG_NO  0
#define UARK_IFACE_NO           0

#define UARK_SET_DATA_BITS(x)   (x - 5)

#define UARK_PARITY_NONE        0x00
#define UARK_PARITY_ODD         0x08
#define UARK_PARITY_EVEN        0x18

#define UARK_STOP_BITS_1        0x00
#define UARK_STOP_BITS_2        0x04

#define UARK_BAUD_REF           3000000

#define UARK_WRITE              0x40
#define UARK_READ               0xc0

#define UARK_REQUEST            0xfe

struct uark_softc {
        device_t                sc_dev;
        struct usbd_device *    sc_udev;
        struct usbd_interface * sc_iface;
        device_t                sc_subdev;

        u_char                  sc_msr;
        u_char                  sc_lsr;

        bool                    sc_dying;
};

static void     uark_get_status(void *, int portno, u_char *lsr, u_char *msr);
static void     uark_set(void *, int, int, int);
static int      uark_param(void *, int, struct termios *);
static int      uark_open(void *, int);
static void     uark_break(void *, int, int);
static int      uark_cmd(struct uark_softc *, uint16_t, uint16_t);

static const struct ucom_methods uark_methods = {
        .ucom_get_status = uark_get_status,
        .ucom_set = uark_set,
        .ucom_param = uark_param,
        .ucom_open = uark_open,
};

static const struct usb_devno uark_devs[] = {
        { USB_VENDOR_ARKMICROCHIPS, USB_PRODUCT_ARKMICROCHIPS_USBSERIAL },
};

static int      uark_match(device_t, cfdata_t, void *);
static void     uark_attach(device_t, device_t, void *);
static int      uark_detach(device_t, int);

CFATTACH_DECL_NEW(uark, sizeof(struct uark_softc), uark_match, uark_attach,
    uark_detach, NULL);

static int
uark_match(device_t parent, cfdata_t match, void *aux)
{
        struct usb_attach_arg *uaa = aux;

        return (usb_lookup(uark_devs, uaa->uaa_vendor, uaa->uaa_product)
            != NULL) ? UMATCH_VENDOR_PRODUCT : UMATCH_NONE;
}

static void
uark_attach(device_t parent, device_t self, void *aux)
{
        struct uark_softc *sc = device_private(self);
        struct usb_attach_arg *uaa = aux;
        struct usbd_device *dev = uaa->uaa_device;
        char *devinfop;
        struct ucom_attach_args ucaa;
        usb_interface_descriptor_t *id;
        usb_endpoint_descriptor_t *ed;
        usbd_status error;
        int i;

        memset(&ucaa, 0, sizeof(ucaa));
        sc->sc_dev = self;

        devinfop = usbd_devinfo_alloc(dev, 0);
        aprint_naive("\n");
        aprint_normal("\n");
        aprint_normal_dev(self, "%s\n", devinfop);
        usbd_devinfo_free(devinfop);

        sc->sc_udev = dev;
        sc->sc_dying = false;

        if (usbd_set_config_index(sc->sc_udev, UARK_CONFIG_NO, 1) != 0) {
                aprint_error_dev(self, "could not set configuration no\n");
                sc->sc_dying = true;
                return;
        }

        /* get the first interface handle */
        error = usbd_device2interface_handle(sc->sc_udev, UARK_IFACE_NO,
            &sc->sc_iface);
        if (error != 0) {
                aprint_error_dev(self, "could not get interface handle\n");
                sc->sc_dying = true;
                return;
        }

        id = usbd_get_interface_descriptor(sc->sc_iface);

        ucaa.ucaa_bulkin = ucaa.ucaa_bulkout = -1;
        for (i = 0; i < id->bNumEndpoints; i++) {
                ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
                if (ed == NULL) {
                        aprint_error_dev(self,
                            "no endpoint descriptor found for %d\n", i);
                        sc->sc_dying = true;
                        return;
                }

                if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
                    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK)
                        ucaa.ucaa_bulkin = ed->bEndpointAddress;
                else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
                    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK)
                        ucaa.ucaa_bulkout = ed->bEndpointAddress;
        }

        if (ucaa.ucaa_bulkin == -1 || ucaa.ucaa_bulkout == -1) {
                aprint_error_dev(self, "missing endpoint\n");
                sc->sc_dying = true;
                return;
        }

        ucaa.ucaa_ibufsize = UARKBUFSZ;
        ucaa.ucaa_obufsize = UARKBUFSZ;
        ucaa.ucaa_ibufsizepad = UARKBUFSZ;
        ucaa.ucaa_opkthdrlen = 0;
        ucaa.ucaa_device = sc->sc_udev;
        ucaa.ucaa_iface = sc->sc_iface;
        ucaa.ucaa_methods = &uark_methods;
        ucaa.ucaa_arg = sc;
        ucaa.ucaa_info = NULL;

        usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, sc->sc_dev);

        sc->sc_subdev = config_found(self, &ucaa, ucomprint,
            CFARGS(.submatch = ucomsubmatch));

        return;
}

static int
uark_detach(device_t self, int flags)
{
        struct uark_softc *sc = device_private(self);
        int rv = 0;

        sc->sc_dying = true;

        if (sc->sc_subdev != NULL) {
                rv = config_detach(sc->sc_subdev, flags);
                sc->sc_subdev = NULL;
        }

        usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev);

        return rv;
}

static void
uark_set(void *vsc, int portno, int reg, int onoff)
{
        struct uark_softc *sc = vsc;

        if (sc->sc_dying)
                return;

        switch (reg) {
        case UCOM_SET_BREAK:
                uark_break(sc, portno, onoff);
                return;
        case UCOM_SET_DTR:
        case UCOM_SET_RTS:
        default:
                return;
        }
}

static int
uark_param(void *vsc, int portno, struct termios *t)
{
        struct uark_softc *sc = (struct uark_softc *)vsc;
        int data;

        if (sc->sc_dying)
                return EIO;

        switch (t->c_ospeed) {
        case 300:
        case 600:
        case 1200:
        case 1800:
        case 2400:
        case 4800:
        case 9600:
        case 19200:
        case 38400:
        case 57600:
        case 115200:
                uark_cmd(sc, 3, 0x83);
                uark_cmd(sc, 0, (UARK_BAUD_REF / t->c_ospeed) & 0xFF);
                uark_cmd(sc, 1, (UARK_BAUD_REF / t->c_ospeed) >> 8);
                uark_cmd(sc, 3, 0x03);
                break;
        default:
                return EINVAL;
        }

        if (ISSET(t->c_cflag, CSTOPB))
                data = UARK_STOP_BITS_2;
        else
                data = UARK_STOP_BITS_1;

        if (ISSET(t->c_cflag, PARENB)) {
                if (ISSET(t->c_cflag, PARODD))
                        data |= UARK_PARITY_ODD;
                else
                        data |= UARK_PARITY_EVEN;
        } else
                data |= UARK_PARITY_NONE;

        switch (ISSET(t->c_cflag, CSIZE)) {
        case CS5:
                data |= UARK_SET_DATA_BITS(5);
                break;
        case CS6:
                data |= UARK_SET_DATA_BITS(6);
                break;
        case CS7:
                data |= UARK_SET_DATA_BITS(7);
                break;
        case CS8:
                data |= UARK_SET_DATA_BITS(8);
                break;
        }

        uark_cmd(sc, 3, 0x00);
        uark_cmd(sc, 3, data);

#if 0
        /* XXX flow control */
        if (ISSET(t->c_cflag, CRTSCTS)) {
                /*  rts/cts flow ctl */
        } else if (ISSET(t->c_iflag, IXON|IXOFF)) {
                /*  xon/xoff flow ctl */
        } else {
                /* disable flow ctl */
        }
#endif

        return 0;
}

static int
uark_open(void *arg, int portno)
{
        struct uark_softc *sc = arg;

        if (sc->sc_dying)
                return EIO;

        return 0;
}

static void
uark_get_status(void *vsc, int portno, u_char *lsr, u_char *msr)
{
        struct uark_softc *sc = vsc;

        if (sc->sc_dying)
                return;

        *msr = sc->sc_msr;
        *lsr = sc->sc_lsr;
}

static void
uark_break(void *vsc, int portno, int onoff)
{
#if 0
        struct uark_softc *sc = vsc;

        if (sc->sc_dying)
                return;

#ifdef UARK_DEBUG
        aprint_normal_dev(sc->sc_dev, "break %s!\n", onoff ? "on" : "off");
#endif

        if (onoff)
                /* break on */
                uark_cmd(sc, 4, 0x01);
        else
                uark_cmd(sc, 4, 0x00);
#endif
}

static int
uark_cmd(struct uark_softc *sc, uint16_t index, uint16_t value)
{
        usb_device_request_t req;
        usbd_status err;

        req.bmRequestType = UARK_WRITE;
        req.bRequest = UARK_REQUEST;
        USETW(req.wValue, value);
        USETW(req.wIndex, index);
        USETW(req.wLength, 0);
        err = usbd_do_request(sc->sc_udev, &req, NULL);

        if (err)
                return EIO;

        return 0;
}