[qemu.git] / hw / usb / dev-serial.c

/*
 * FTDI FT232BM Device emulation
 *
 * Copyright (c) 2006 CodeSourcery.
 * Copyright (c) 2008 Samuel Thibault <[email protected]>
 * Written by Paul Brook, reused for FTDI by Samuel Thibault
 *
 * This code is licensed under the LGPL.
 */

#include "qemu/osdep.h"
#include "qapi/error.h"
#include "qemu-common.h"
#include "qemu/cutils.h"
#include "qemu/error-report.h"
#include "hw/usb.h"
#include "hw/usb/desc.h"
#include "sysemu/char.h"

//#define DEBUG_Serial

#ifdef DEBUG_Serial
#define DPRINTF(fmt, ...) \
do { printf("usb-serial: " fmt , ## __VA_ARGS__); } while (0)
#else
#define DPRINTF(fmt, ...) do {} while(0)
#endif

#define RECV_BUF 384

/* Commands */
#define FTDI_RESET		0
#define FTDI_SET_MDM_CTRL	1
#define FTDI_SET_FLOW_CTRL	2
#define FTDI_SET_BAUD		3
#define FTDI_SET_DATA		4
#define FTDI_GET_MDM_ST		5
#define FTDI_SET_EVENT_CHR	6
#define FTDI_SET_ERROR_CHR	7
#define FTDI_SET_LATENCY	9
#define FTDI_GET_LATENCY	10

#define DeviceOutVendor	((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8)
#define DeviceInVendor	((USB_DIR_IN |USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8)

/* RESET */

#define FTDI_RESET_SIO	0
#define FTDI_RESET_RX	1
#define FTDI_RESET_TX	2

/* SET_MDM_CTRL */

#define FTDI_DTR	1
#define FTDI_SET_DTR	(FTDI_DTR << 8)
#define FTDI_RTS	2
#define FTDI_SET_RTS	(FTDI_RTS << 8)

/* SET_FLOW_CTRL */

#define FTDI_RTS_CTS_HS		1
#define FTDI_DTR_DSR_HS		2
#define FTDI_XON_XOFF_HS	4

/* SET_DATA */

#define FTDI_PARITY	(0x7 << 8)
#define FTDI_ODD	(0x1 << 8)
#define FTDI_EVEN	(0x2 << 8)
#define FTDI_MARK	(0x3 << 8)
#define FTDI_SPACE	(0x4 << 8)

#define FTDI_STOP	(0x3 << 11)
#define FTDI_STOP1	(0x0 << 11)
#define FTDI_STOP15	(0x1 << 11)
#define FTDI_STOP2	(0x2 << 11)

/* GET_MDM_ST */
/* TODO: should be sent every 40ms */
#define FTDI_CTS  (1<<4)        // CTS line status
#define FTDI_DSR  (1<<5)        // DSR line status
#define FTDI_RI   (1<<6)        // RI line status
#define FTDI_RLSD (1<<7)        // Receive Line Signal Detect

/* Status */

#define FTDI_DR   (1<<0)        // Data Ready
#define FTDI_OE   (1<<1)        // Overrun Err
#define FTDI_PE   (1<<2)        // Parity Err
#define FTDI_FE   (1<<3)        // Framing Err
#define FTDI_BI   (1<<4)        // Break Interrupt
#define FTDI_THRE (1<<5)        // Transmitter Holding Register
#define FTDI_TEMT (1<<6)        // Transmitter Empty
#define FTDI_FIFO (1<<7)        // Error in FIFO

typedef struct {
    USBDevice dev;
    uint8_t recv_buf[RECV_BUF];
    uint16_t recv_ptr;
    uint16_t recv_used;
    uint8_t event_chr;
    uint8_t error_chr;
    uint8_t event_trigger;
    QEMUSerialSetParams params;
    int latency;        /* ms */
    CharDriverState *cs;
} USBSerialState;

#define TYPE_USB_SERIAL "usb-serial-dev"
#define USB_SERIAL_DEV(obj) OBJECT_CHECK(USBSerialState, (obj), TYPE_USB_SERIAL)

enum {
    STR_MANUFACTURER = 1,
    STR_PRODUCT_SERIAL,
    STR_PRODUCT_BRAILLE,
    STR_SERIALNUMBER,
};

static const USBDescStrings desc_strings = {
    [STR_MANUFACTURER]    = "QEMU",
    [STR_PRODUCT_SERIAL]  = "QEMU USB SERIAL",
    [STR_PRODUCT_BRAILLE] = "QEMU USB BAUM BRAILLE",
    [STR_SERIALNUMBER]    = "1",
};

static const USBDescIface desc_iface0 = {
    .bInterfaceNumber              = 0,
    .bNumEndpoints                 = 2,
    .bInterfaceClass               = 0xff,
    .bInterfaceSubClass            = 0xff,
    .bInterfaceProtocol            = 0xff,
    .eps = (USBDescEndpoint[]) {
        {
            .bEndpointAddress      = USB_DIR_IN | 0x01,
            .bmAttributes          = USB_ENDPOINT_XFER_BULK,
            .wMaxPacketSize        = 64,
        },{
            .bEndpointAddress      = USB_DIR_OUT | 0x02,
            .bmAttributes          = USB_ENDPOINT_XFER_BULK,
            .wMaxPacketSize        = 64,
        },
    }
};

static const USBDescDevice desc_device = {
    .bcdUSB                        = 0x0200,
    .bMaxPacketSize0               = 8,
    .bNumConfigurations            = 1,
    .confs = (USBDescConfig[]) {
        {
            .bNumInterfaces        = 1,
            .bConfigurationValue   = 1,
            .bmAttributes          = USB_CFG_ATT_ONE,
            .bMaxPower             = 50,
            .nif = 1,
            .ifs = &desc_iface0,
        },
    },
};

static const USBDesc desc_serial = {
    .id = {
        .idVendor          = 0x0403,
        .idProduct         = 0x6001,
        .bcdDevice         = 0x0400,
        .iManufacturer     = STR_MANUFACTURER,
        .iProduct          = STR_PRODUCT_SERIAL,
        .iSerialNumber     = STR_SERIALNUMBER,
    },
    .full = &desc_device,
    .str  = desc_strings,
};

static const USBDesc desc_braille = {
    .id = {
        .idVendor          = 0x0403,
        .idProduct         = 0xfe72,
        .bcdDevice         = 0x0400,
        .iManufacturer     = STR_MANUFACTURER,
        .iProduct          = STR_PRODUCT_BRAILLE,
        .iSerialNumber     = STR_SERIALNUMBER,
    },
    .full = &desc_device,
    .str  = desc_strings,
};

static void usb_serial_reset(USBSerialState *s)
{
    /* TODO: Set flow control to none */
    s->event_chr = 0x0d;
    s->event_trigger = 0;
    s->recv_ptr = 0;
    s->recv_used = 0;
    /* TODO: purge in char driver */
}

static void usb_serial_handle_reset(USBDevice *dev)
{
    USBSerialState *s = (USBSerialState *)dev;

    DPRINTF("Reset\n");

    usb_serial_reset(s);
    /* TODO: Reset char device, send BREAK? */
}

static uint8_t usb_get_modem_lines(USBSerialState *s)
{
    int flags;
    uint8_t ret;

    if (qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_GET_TIOCM, &flags) == -ENOTSUP)
        return FTDI_CTS|FTDI_DSR|FTDI_RLSD;

    ret = 0;
    if (flags & CHR_TIOCM_CTS)
        ret |= FTDI_CTS;
    if (flags & CHR_TIOCM_DSR)
        ret |= FTDI_DSR;
    if (flags & CHR_TIOCM_RI)
        ret |= FTDI_RI;
    if (flags & CHR_TIOCM_CAR)
        ret |= FTDI_RLSD;

    return ret;
}

static void usb_serial_handle_control(USBDevice *dev, USBPacket *p,
               int request, int value, int index, int length, uint8_t *data)
{
    USBSerialState *s = (USBSerialState *)dev;
    int ret;

    DPRINTF("got control %x, value %x\n",request, value);
    ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
    if (ret >= 0) {
        return;
    }

    switch (request) {
    case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
        break;

        /* Class specific requests.  */
    case DeviceOutVendor | FTDI_RESET:
        switch (value) {
        case FTDI_RESET_SIO:
            usb_serial_reset(s);
            break;
        case FTDI_RESET_RX:
            s->recv_ptr = 0;
            s->recv_used = 0;
            /* TODO: purge from char device */
            break;
        case FTDI_RESET_TX:
            /* TODO: purge from char device */
            break;
        }
        break;
    case DeviceOutVendor | FTDI_SET_MDM_CTRL:
    {
        static int flags;
        qemu_chr_fe_ioctl(s->cs,CHR_IOCTL_SERIAL_GET_TIOCM, &flags);
        if (value & FTDI_SET_RTS) {
            if (value & FTDI_RTS)
                flags |= CHR_TIOCM_RTS;
            else
                flags &= ~CHR_TIOCM_RTS;
        }
        if (value & FTDI_SET_DTR) {
            if (value & FTDI_DTR)
                flags |= CHR_TIOCM_DTR;
            else
                flags &= ~CHR_TIOCM_DTR;
        }
        qemu_chr_fe_ioctl(s->cs,CHR_IOCTL_SERIAL_SET_TIOCM, &flags);
        break;
    }
    case DeviceOutVendor | FTDI_SET_FLOW_CTRL:
        /* TODO: ioctl */
        break;
    case DeviceOutVendor | FTDI_SET_BAUD: {
        static const int subdivisors8[8] = { 0, 4, 2, 1, 3, 5, 6, 7 };
        int subdivisor8 = subdivisors8[((value & 0xc000) >> 14)
                                     | ((index & 1) << 2)];
        int divisor = value & 0x3fff;

        /* chip special cases */
        if (divisor == 1 && subdivisor8 == 0)
            subdivisor8 = 4;
        if (divisor == 0 && subdivisor8 == 0)
            divisor = 1;

        s->params.speed = (48000000 / 2) / (8 * divisor + subdivisor8);
        qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
        break;
    }
    case DeviceOutVendor | FTDI_SET_DATA:
        switch (value & FTDI_PARITY) {
            case 0:
                s->params.parity = 'N';
                break;
            case FTDI_ODD:
                s->params.parity = 'O';
                break;
            case FTDI_EVEN:
                s->params.parity = 'E';
                break;
            default:
                DPRINTF("unsupported parity %d\n", value & FTDI_PARITY);
                goto fail;
        }
        switch (value & FTDI_STOP) {
            case FTDI_STOP1:
                s->params.stop_bits = 1;
                break;
            case FTDI_STOP2:
                s->params.stop_bits = 2;
                break;
            default:
                DPRINTF("unsupported stop bits %d\n", value & FTDI_STOP);
                goto fail;
        }
        qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
        /* TODO: TX ON/OFF */
        break;
    case DeviceInVendor | FTDI_GET_MDM_ST:
        data[0] = usb_get_modem_lines(s) | 1;
        data[1] = 0;
        p->actual_length = 2;
        break;
    case DeviceOutVendor | FTDI_SET_EVENT_CHR:
        /* TODO: handle it */
        s->event_chr = value;
        break;
    case DeviceOutVendor | FTDI_SET_ERROR_CHR:
        /* TODO: handle it */
        s->error_chr = value;
        break;
    case DeviceOutVendor | FTDI_SET_LATENCY:
        s->latency = value;
        break;
    case DeviceInVendor | FTDI_GET_LATENCY:
        data[0] = s->latency;
        p->actual_length = 1;
        break;
    default:
    fail:
        DPRINTF("got unsupported/bogus control %x, value %x\n", request, value);
        p->status = USB_RET_STALL;
        break;
    }
}

static void usb_serial_handle_data(USBDevice *dev, USBPacket *p)
{
    USBSerialState *s = (USBSerialState *)dev;
    uint8_t devep = p->ep->nr;
    struct iovec *iov;
    uint8_t header[2];
    int i, first_len, len;

    switch (p->pid) {
    case USB_TOKEN_OUT:
        if (devep != 2)
            goto fail;
        for (i = 0; i < p->iov.niov; i++) {
            iov = p->iov.iov + i;
            qemu_chr_fe_write(s->cs, iov->iov_base, iov->iov_len);
        }
        p->actual_length = p->iov.size;
        break;

    case USB_TOKEN_IN:
        if (devep != 1)
            goto fail;
        first_len = RECV_BUF - s->recv_ptr;
        len = p->iov.size;
        if (len <= 2) {
            p->status = USB_RET_NAK;
            break;
        }
        header[0] = usb_get_modem_lines(s) | 1;
        /* We do not have the uart details */
        /* handle serial break */
        if (s->event_trigger && s->event_trigger & FTDI_BI) {
            s->event_trigger &= ~FTDI_BI;
            header[1] = FTDI_BI;
            usb_packet_copy(p, header, 2);
            break;
        } else {
            header[1] = 0;
        }
        len -= 2;
        if (len > s->recv_used)
            len = s->recv_used;
        if (!len) {
            p->status = USB_RET_NAK;
            break;
        }
        if (first_len > len)
            first_len = len;
        usb_packet_copy(p, header, 2);
        usb_packet_copy(p, s->recv_buf + s->recv_ptr, first_len);
        if (len > first_len)
            usb_packet_copy(p, s->recv_buf, len - first_len);
        s->recv_used -= len;
        s->recv_ptr = (s->recv_ptr + len) % RECV_BUF;
        break;

    default:
        DPRINTF("Bad token\n");
    fail:
        p->status = USB_RET_STALL;
        break;
    }
}

static int usb_serial_can_read(void *opaque)
{
    USBSerialState *s = opaque;

    if (!s->dev.attached) {
        return 0;
    }
    return RECV_BUF - s->recv_used;
}

static void usb_serial_read(void *opaque, const uint8_t *buf, int size)
{
    USBSerialState *s = opaque;
    int first_size, start;

    /* room in the buffer? */
    if (size > (RECV_BUF - s->recv_used))
        size = RECV_BUF - s->recv_used;

    start = s->recv_ptr + s->recv_used;
    if (start < RECV_BUF) {
        /* copy data to end of buffer */
        first_size = RECV_BUF - start;
        if (first_size > size)
            first_size = size;

        memcpy(s->recv_buf + start, buf, first_size);

        /* wrap around to front if needed */
        if (size > first_size)
            memcpy(s->recv_buf, buf + first_size, size - first_size);
    } else {
        start -= RECV_BUF;
        memcpy(s->recv_buf + start, buf, size);
    }
    s->recv_used += size;
}

static void usb_serial_event(void *opaque, int event)
{
    USBSerialState *s = opaque;

    switch (event) {
        case CHR_EVENT_BREAK:
            s->event_trigger |= FTDI_BI;
            break;
        case CHR_EVENT_FOCUS:
            break;
        case CHR_EVENT_OPENED:
            if (!s->dev.attached) {
                usb_device_attach(&s->dev, &error_abort);
            }
            break;
        case CHR_EVENT_CLOSED:
            if (s->dev.attached) {
                usb_device_detach(&s->dev);
            }
            break;
    }
}

static void usb_serial_realize(USBDevice *dev, Error **errp)
{
    USBSerialState *s = USB_SERIAL_DEV(dev);
    Error *local_err = NULL;

    usb_desc_create_serial(dev);
    usb_desc_init(dev);
    dev->auto_attach = 0;

    if (!s->cs) {
        error_setg(errp, "Property chardev is required");
        return;
    }

    usb_check_attach(dev, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }

    qemu_chr_add_handlers(s->cs, usb_serial_can_read, usb_serial_read,
                          usb_serial_event, s);
    usb_serial_handle_reset(dev);

    if (s->cs->be_open && !dev->attached) {
        usb_device_attach(dev, &error_abort);
    }
}

static USBDevice *usb_serial_init(USBBus *bus, const char *filename)
{
    USBDevice *dev;
    CharDriverState *cdrv;
    uint32_t vendorid = 0, productid = 0;
    char label[32];
    static int index;

    while (*filename && *filename != ':') {
        const char *p;
        char *e;
        if (strstart(filename, "vendorid=", &p)) {
            vendorid = strtol(p, &e, 16);
            if (e == p || (*e && *e != ',' && *e != ':')) {
                error_report("bogus vendor ID %s", p);
                return NULL;
            }
            filename = e;
        } else if (strstart(filename, "productid=", &p)) {
            productid = strtol(p, &e, 16);
            if (e == p || (*e && *e != ',' && *e != ':')) {
                error_report("bogus product ID %s", p);
                return NULL;
            }
            filename = e;
        } else {
            error_report("unrecognized serial USB option %s", filename);
            return NULL;
        }
        while(*filename == ',')
            filename++;
    }
    if (!*filename) {
        error_report("character device specification needed");
        return NULL;
    }
    filename++;

    snprintf(label, sizeof(label), "usbserial%d", index++);
    cdrv = qemu_chr_new(label, filename, NULL);
    if (!cdrv)
        return NULL;

    dev = usb_create(bus, "usb-serial");
    qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
    if (vendorid)
        qdev_prop_set_uint16(&dev->qdev, "vendorid", vendorid);
    if (productid)
        qdev_prop_set_uint16(&dev->qdev, "productid", productid);
    return dev;
}

static USBDevice *usb_braille_init(USBBus *bus, const char *unused)
{
    USBDevice *dev;
    CharDriverState *cdrv;

    cdrv = qemu_chr_new("braille", "braille", NULL);
    if (!cdrv)
        return NULL;

    dev = usb_create(bus, "usb-braille");
    qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
    return dev;
}

static const VMStateDescription vmstate_usb_serial = {
    .name = "usb-serial",
    .unmigratable = 1,
};

static Property serial_properties[] = {
    DEFINE_PROP_CHR("chardev", USBSerialState, cs),
    DEFINE_PROP_END_OF_LIST(),
};

static void usb_serial_dev_class_init(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    USBDeviceClass *uc = USB_DEVICE_CLASS(klass);

    uc->realize        = usb_serial_realize;
    uc->handle_reset   = usb_serial_handle_reset;
    uc->handle_control = usb_serial_handle_control;
    uc->handle_data    = usb_serial_handle_data;
    dc->vmsd = &vmstate_usb_serial;
    set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
}

static const TypeInfo usb_serial_dev_type_info = {
    .name = TYPE_USB_SERIAL,
    .parent = TYPE_USB_DEVICE,
    .instance_size = sizeof(USBSerialState),
    .abstract = true,
    .class_init = usb_serial_dev_class_init,
};

static void usb_serial_class_initfn(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    USBDeviceClass *uc = USB_DEVICE_CLASS(klass);

    uc->product_desc   = "QEMU USB Serial";
    uc->usb_desc       = &desc_serial;
    dc->props = serial_properties;
}

static const TypeInfo serial_info = {
    .name          = "usb-serial",
    .parent        = TYPE_USB_SERIAL,
    .class_init    = usb_serial_class_initfn,
};

static Property braille_properties[] = {
    DEFINE_PROP_CHR("chardev", USBSerialState, cs),
    DEFINE_PROP_END_OF_LIST(),
};

static void usb_braille_class_initfn(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    USBDeviceClass *uc = USB_DEVICE_CLASS(klass);

    uc->product_desc   = "QEMU USB Braille";
    uc->usb_desc       = &desc_braille;
    dc->props = braille_properties;
}

static const TypeInfo braille_info = {
    .name          = "usb-braille",
    .parent        = TYPE_USB_SERIAL,
    .class_init    = usb_braille_class_initfn,
};

static void usb_serial_register_types(void)
{
    type_register_static(&usb_serial_dev_type_info);
    type_register_static(&serial_info);
    usb_legacy_register("usb-serial", "serial", usb_serial_init);
    type_register_static(&braille_info);
    usb_legacy_register("usb-braille", "braille", usb_braille_init);
}

type_init(usb_serial_register_types)
Commit	Line	Data
a7954218 AZ	1	/*
	2	* FTDI FT232BM Device emulation
	3	*
	4	* Copyright (c) 2006 CodeSourcery.
	5	* Copyright (c) 2008 Samuel Thibault <[email protected]>
	6	* Written by Paul Brook, reused for FTDI by Samuel Thibault
	7	*
8e31bf38	8	* This code is licensed under the LGPL.
a7954218 AZ	9	*/
a7954218 AZ	10
e532b2e0	11	#include "qemu/osdep.h"
da34e65c	12	#include "qapi/error.h"
a7954218	13	#include "qemu-common.h"
f348b6d1	14	#include "qemu/cutils.h"
d49b6836	15	#include "qemu/error-report.h"
f1ae32a1 GH	16	#include "hw/usb.h"
f1ae32a1 GH	17	#include "hw/usb/desc.h"
dccfcd0e	18	#include "sysemu/char.h"
a7954218 AZ	19
	20	//#define DEBUG_Serial
	21
	22	#ifdef DEBUG_Serial
001faf32 BS	23	#define DPRINTF(fmt, ...) \
001faf32 BS	24	do { printf("usb-serial: " fmt , ## __VA_ARGS__); } while (0)
a7954218	25	#else
001faf32	26	#define DPRINTF(fmt, ...) do {} while(0)
a7954218 AZ	27	#endif
	28
	29	#define RECV_BUF 384
a7954218 AZ	30
	31	/* Commands */
	32	#define FTDI_RESET 0
	33	#define FTDI_SET_MDM_CTRL 1
	34	#define FTDI_SET_FLOW_CTRL 2
	35	#define FTDI_SET_BAUD 3
	36	#define FTDI_SET_DATA 4
	37	#define FTDI_GET_MDM_ST 5
	38	#define FTDI_SET_EVENT_CHR 6
	39	#define FTDI_SET_ERROR_CHR 7
	40	#define FTDI_SET_LATENCY 9
	41	#define FTDI_GET_LATENCY 10
	42
	43	#define DeviceOutVendor ((USB_DIR_OUT\|USB_TYPE_VENDOR\|USB_RECIP_DEVICE)<<8)
	44	#define DeviceInVendor ((USB_DIR_IN \|USB_TYPE_VENDOR\|USB_RECIP_DEVICE)<<8)
	45
	46	/* RESET */
	47
	48	#define FTDI_RESET_SIO 0
	49	#define FTDI_RESET_RX 1
	50	#define FTDI_RESET_TX 2
	51
	52	/* SET_MDM_CTRL */
	53
a7954218	54	#define FTDI_DTR 1
abb8a139	55	#define FTDI_SET_DTR (FTDI_DTR << 8)
a7954218	56	#define FTDI_RTS 2
abb8a139	57	#define FTDI_SET_RTS (FTDI_RTS << 8)
a7954218 AZ	58
	59	/* SET_FLOW_CTRL */
	60
	61	#define FTDI_RTS_CTS_HS 1
	62	#define FTDI_DTR_DSR_HS 2
	63	#define FTDI_XON_XOFF_HS 4
	64
	65	/* SET_DATA */
	66
	67	#define FTDI_PARITY (0x7 << 8)
	68	#define FTDI_ODD (0x1 << 8)
	69	#define FTDI_EVEN (0x2 << 8)
	70	#define FTDI_MARK (0x3 << 8)
	71	#define FTDI_SPACE (0x4 << 8)
	72
	73	#define FTDI_STOP (0x3 << 11)
	74	#define FTDI_STOP1 (0x0 << 11)
	75	#define FTDI_STOP15 (0x1 << 11)
	76	#define FTDI_STOP2 (0x2 << 11)
	77
	78	/* GET_MDM_ST */
	79	/* TODO: should be sent every 40ms */
	80	#define FTDI_CTS (1<<4) // CTS line status
	81	#define FTDI_DSR (1<<5) // DSR line status
	82	#define FTDI_RI (1<<6) // RI line status
	83	#define FTDI_RLSD (1<<7) // Receive Line Signal Detect
	84
	85	/* Status */
	86
	87	#define FTDI_DR (1<<0) // Data Ready
	88	#define FTDI_OE (1<<1) // Overrun Err
	89	#define FTDI_PE (1<<2) // Parity Err
	90	#define FTDI_FE (1<<3) // Framing Err
	91	#define FTDI_BI (1<<4) // Break Interrupt
	92	#define FTDI_THRE (1<<5) // Transmitter Holding Register
	93	#define FTDI_TEMT (1<<6) // Transmitter Empty
	94	#define FTDI_FIFO (1<<7) // Error in FIFO
	95
	96	typedef struct {
	97	USBDevice dev;
a7954218	98	uint8_t recv_buf[RECV_BUF];
8109b9b6 AJ	99	uint16_t recv_ptr;
8109b9b6 AJ	100	uint16_t recv_used;
a7954218 AZ	101	uint8_t event_chr;
	102	uint8_t error_chr;
	103	uint8_t event_trigger;
a7954218 AZ	104	QEMUSerialSetParams params;
	105	int latency; /* ms */
	106	CharDriverState *cs;
	107	} USBSerialState;
	108
cdf0d769 GA	109	#define TYPE_USB_SERIAL "usb-serial-dev"
	110	#define USB_SERIAL_DEV(obj) OBJECT_CHECK(USBSerialState, (obj), TYPE_USB_SERIAL)
	111
f29783f7 GH	112	enum {
	113	STR_MANUFACTURER = 1,
	114	STR_PRODUCT_SERIAL,
	115	STR_PRODUCT_BRAILLE,
	116	STR_SERIALNUMBER,
a7954218 AZ	117	};
a7954218 AZ	118
f29783f7	119	static const USBDescStrings desc_strings = {
93bfef4c	120	[STR_MANUFACTURER] = "QEMU",
f29783f7	121	[STR_PRODUCT_SERIAL] = "QEMU USB SERIAL",
2964cd9b	122	[STR_PRODUCT_BRAILLE] = "QEMU USB BAUM BRAILLE",
f29783f7 GH	123	[STR_SERIALNUMBER] = "1",
	124	};
	125
	126	static const USBDescIface desc_iface0 = {
	127	.bInterfaceNumber = 0,
	128	.bNumEndpoints = 2,
	129	.bInterfaceClass = 0xff,
	130	.bInterfaceSubClass = 0xff,
	131	.bInterfaceProtocol = 0xff,
	132	.eps = (USBDescEndpoint[]) {
	133	{
	134	.bEndpointAddress = USB_DIR_IN \| 0x01,
	135	.bmAttributes = USB_ENDPOINT_XFER_BULK,
	136	.wMaxPacketSize = 64,
	137	},{
	138	.bEndpointAddress = USB_DIR_OUT \| 0x02,
	139	.bmAttributes = USB_ENDPOINT_XFER_BULK,
	140	.wMaxPacketSize = 64,
	141	},
	142	}
	143	};
	144
	145	static const USBDescDevice desc_device = {
	146	.bcdUSB = 0x0200,
	147	.bMaxPacketSize0 = 8,
	148	.bNumConfigurations = 1,
	149	.confs = (USBDescConfig[]) {
	150	{
	151	.bNumInterfaces = 1,
	152	.bConfigurationValue = 1,
bd93976a	153	.bmAttributes = USB_CFG_ATT_ONE,
f29783f7	154	.bMaxPower = 50,
add75088	155	.nif = 1,
f29783f7 GH	156	.ifs = &desc_iface0,
	157	},
	158	},
	159	};
	160
	161	static const USBDesc desc_serial = {
	162	.id = {
	163	.idVendor = 0x0403,
	164	.idProduct = 0x6001,
	165	.bcdDevice = 0x0400,
	166	.iManufacturer = STR_MANUFACTURER,
	167	.iProduct = STR_PRODUCT_SERIAL,
	168	.iSerialNumber = STR_SERIALNUMBER,
	169	},
	170	.full = &desc_device,
	171	.str = desc_strings,
	172	};
	173
	174	static const USBDesc desc_braille = {
	175	.id = {
	176	.idVendor = 0x0403,
	177	.idProduct = 0xfe72,
	178	.bcdDevice = 0x0400,
	179	.iManufacturer = STR_MANUFACTURER,
	180	.iProduct = STR_PRODUCT_BRAILLE,
	181	.iSerialNumber = STR_SERIALNUMBER,
	182	},
	183	.full = &desc_device,
	184	.str = desc_strings,
a7954218 AZ	185	};
	186
	187	static void usb_serial_reset(USBSerialState *s)
	188	{
	189	/* TODO: Set flow control to none */
	190	s->event_chr = 0x0d;
	191	s->event_trigger = 0;
	192	s->recv_ptr = 0;
	193	s->recv_used = 0;
	194	/* TODO: purge in char driver */
a7954218 AZ	195	}
	196
	197	static void usb_serial_handle_reset(USBDevice *dev)
	198	{
	199	USBSerialState s = (USBSerialState )dev;
	200
	201	DPRINTF("Reset\n");
	202
	203	usb_serial_reset(s);
	204	/* TODO: Reset char device, send BREAK? */
	205	}
	206
abb8a139 AJ	207	static uint8_t usb_get_modem_lines(USBSerialState *s)
	208	{
	209	int flags;
	210	uint8_t ret;
	211
41084f1b	212	if (qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_GET_TIOCM, &flags) == -ENOTSUP)
abb8a139 AJ	213	return FTDI_CTS\|FTDI_DSR\|FTDI_RLSD;
	214
	215	ret = 0;
	216	if (flags & CHR_TIOCM_CTS)
	217	ret \|= FTDI_CTS;
	218	if (flags & CHR_TIOCM_DSR)
	219	ret \|= FTDI_DSR;
	220	if (flags & CHR_TIOCM_RI)
	221	ret \|= FTDI_RI;
	222	if (flags & CHR_TIOCM_CAR)
	223	ret \|= FTDI_RLSD;
	224
	225	return ret;
	226	}
	227
9a77a0f5	228	static void usb_serial_handle_control(USBDevice dev, USBPacket p,
007fd62f	229	int request, int value, int index, int length, uint8_t *data)
a7954218 AZ	230	{
a7954218 AZ	231	USBSerialState s = (USBSerialState )dev;
f29783f7 GH	232	int ret;
	233
	234	DPRINTF("got control %x, value %x\n",request, value);
007fd62f	235	ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
f29783f7	236	if (ret >= 0) {
9a77a0f5	237	return;
f29783f7	238	}
a7954218	239
a7954218	240	switch (request) {
a7954218	241	case EndpointOutRequest \| USB_REQ_CLEAR_FEATURE:
a7954218 AZ	242	break;
	243
	244	/* Class specific requests. */
	245	case DeviceOutVendor \| FTDI_RESET:
	246	switch (value) {
	247	case FTDI_RESET_SIO:
	248	usb_serial_reset(s);
	249	break;
	250	case FTDI_RESET_RX:
	251	s->recv_ptr = 0;
	252	s->recv_used = 0;
	253	/* TODO: purge from char device */
	254	break;
	255	case FTDI_RESET_TX:
	256	/* TODO: purge from char device */
	257	break;
	258	}
	259	break;
	260	case DeviceOutVendor \| FTDI_SET_MDM_CTRL:
abb8a139 AJ	261	{
abb8a139 AJ	262	static int flags;
41084f1b	263	qemu_chr_fe_ioctl(s->cs,CHR_IOCTL_SERIAL_GET_TIOCM, &flags);
abb8a139 AJ	264	if (value & FTDI_SET_RTS) {
	265	if (value & FTDI_RTS)
	266	flags \|= CHR_TIOCM_RTS;
	267	else
	268	flags &= ~CHR_TIOCM_RTS;
	269	}
	270	if (value & FTDI_SET_DTR) {
	271	if (value & FTDI_DTR)
	272	flags \|= CHR_TIOCM_DTR;
	273	else
	274	flags &= ~CHR_TIOCM_DTR;
	275	}
41084f1b	276	qemu_chr_fe_ioctl(s->cs,CHR_IOCTL_SERIAL_SET_TIOCM, &flags);
a7954218	277	break;
abb8a139	278	}
a7954218 AZ	279	case DeviceOutVendor \| FTDI_SET_FLOW_CTRL:
	280	/* TODO: ioctl */
	281	break;
	282	case DeviceOutVendor \| FTDI_SET_BAUD: {
	283	static const int subdivisors8[8] = { 0, 4, 2, 1, 3, 5, 6, 7 };
	284	int subdivisor8 = subdivisors8[((value & 0xc000) >> 14)
	285	\| ((index & 1) << 2)];
	286	int divisor = value & 0x3fff;
	287
	288	/* chip special cases */
	289	if (divisor == 1 && subdivisor8 == 0)
	290	subdivisor8 = 4;
	291	if (divisor == 0 && subdivisor8 == 0)
	292	divisor = 1;
	293
	294	s->params.speed = (48000000 / 2) / (8 * divisor + subdivisor8);
41084f1b	295	qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
a7954218 AZ	296	break;
	297	}
	298	case DeviceOutVendor \| FTDI_SET_DATA:
	299	switch (value & FTDI_PARITY) {
	300	case 0:
	301	s->params.parity = 'N';
	302	break;
	303	case FTDI_ODD:
	304	s->params.parity = 'O';
	305	break;
	306	case FTDI_EVEN:
	307	s->params.parity = 'E';
	308	break;
	309	default:
	310	DPRINTF("unsupported parity %d\n", value & FTDI_PARITY);
	311	goto fail;
	312	}
	313	switch (value & FTDI_STOP) {
	314	case FTDI_STOP1:
	315	s->params.stop_bits = 1;
	316	break;
	317	case FTDI_STOP2:
	318	s->params.stop_bits = 2;
	319	break;
	320	default:
	321	DPRINTF("unsupported stop bits %d\n", value & FTDI_STOP);
	322	goto fail;
	323	}
41084f1b	324	qemu_chr_fe_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
a7954218 AZ	325	/* TODO: TX ON/OFF */
	326	break;
	327	case DeviceInVendor \| FTDI_GET_MDM_ST:
abb8a139 AJ	328	data[0] = usb_get_modem_lines(s) \| 1;
abb8a139 AJ	329	data[1] = 0;
9a77a0f5	330	p->actual_length = 2;
a7954218 AZ	331	break;
	332	case DeviceOutVendor \| FTDI_SET_EVENT_CHR:
	333	/* TODO: handle it */
	334	s->event_chr = value;
	335	break;
	336	case DeviceOutVendor \| FTDI_SET_ERROR_CHR:
	337	/* TODO: handle it */
	338	s->error_chr = value;
	339	break;
	340	case DeviceOutVendor \| FTDI_SET_LATENCY:
	341	s->latency = value;
	342	break;
	343	case DeviceInVendor \| FTDI_GET_LATENCY:
	344	data[0] = s->latency;
9a77a0f5	345	p->actual_length = 1;
a7954218 AZ	346	break;
	347	default:
	348	fail:
	349	DPRINTF("got unsupported/bogus control %x, value %x\n", request, value);
9a77a0f5	350	p->status = USB_RET_STALL;
a7954218 AZ	351	break;
a7954218 AZ	352	}
a7954218 AZ	353	}
a7954218 AZ	354
9a77a0f5	355	static void usb_serial_handle_data(USBDevice dev, USBPacket p)
a7954218 AZ	356	{
a7954218 AZ	357	USBSerialState s = (USBSerialState )dev;
079d0b7f	358	uint8_t devep = p->ep->nr;
9440b7e5 GH	359	struct iovec *iov;
9440b7e5 GH	360	uint8_t header[2];
9a77a0f5	361	int i, first_len, len;
a7954218 AZ	362
	363	switch (p->pid) {
	364	case USB_TOKEN_OUT:
	365	if (devep != 2)
	366	goto fail;
9440b7e5 GH	367	for (i = 0; i < p->iov.niov; i++) {
9440b7e5 GH	368	iov = p->iov.iov + i;
2cc6e0a1	369	qemu_chr_fe_write(s->cs, iov->iov_base, iov->iov_len);
9440b7e5	370	}
9a77a0f5	371	p->actual_length = p->iov.size;
a7954218 AZ	372	break;
	373
	374	case USB_TOKEN_IN:
	375	if (devep != 1)
	376	goto fail;
	377	first_len = RECV_BUF - s->recv_ptr;
9440b7e5	378	len = p->iov.size;
a7954218	379	if (len <= 2) {
9a77a0f5	380	p->status = USB_RET_NAK;
a7954218 AZ	381	break;
a7954218 AZ	382	}
9440b7e5	383	header[0] = usb_get_modem_lines(s) \| 1;
abb8a139	384	/* We do not have the uart details */
7e57f049 JW	385	/* handle serial break */
	386	if (s->event_trigger && s->event_trigger & FTDI_BI) {
	387	s->event_trigger &= ~FTDI_BI;
9440b7e5 GH	388	header[1] = FTDI_BI;
9440b7e5 GH	389	usb_packet_copy(p, header, 2);
7e57f049 JW	390	break;
7e57f049 JW	391	} else {
9440b7e5	392	header[1] = 0;
7e57f049	393	}
a7954218 AZ	394	len -= 2;
	395	if (len > s->recv_used)
	396	len = s->recv_used;
	397	if (!len) {
9a77a0f5	398	p->status = USB_RET_NAK;
a7954218 AZ	399	break;
	400	}
	401	if (first_len > len)
	402	first_len = len;
9440b7e5 GH	403	usb_packet_copy(p, header, 2);
9440b7e5 GH	404	usb_packet_copy(p, s->recv_buf + s->recv_ptr, first_len);
a7954218	405	if (len > first_len)
9440b7e5	406	usb_packet_copy(p, s->recv_buf, len - first_len);
a7954218 AZ	407	s->recv_used -= len;
a7954218 AZ	408	s->recv_ptr = (s->recv_ptr + len) % RECV_BUF;
a7954218 AZ	409	break;
	410
	411	default:
	412	DPRINTF("Bad token\n");
	413	fail:
9a77a0f5	414	p->status = USB_RET_STALL;
a7954218 AZ	415	break;
a7954218 AZ	416	}
a7954218 AZ	417	}
a7954218 AZ	418
8fcd3692	419	static int usb_serial_can_read(void *opaque)
a7954218 AZ	420	{
a7954218 AZ	421	USBSerialState *s = opaque;
da124e62 GH	422
	423	if (!s->dev.attached) {
	424	return 0;
	425	}
a7954218 AZ	426	return RECV_BUF - s->recv_used;
	427	}
	428
8fcd3692	429	static void usb_serial_read(void opaque, const uint8_t buf, int size)
a7954218 AZ	430	{
a7954218 AZ	431	USBSerialState *s = opaque;
4ab4183d DA	432	int first_size, start;
	433
	434	/* room in the buffer? */
	435	if (size > (RECV_BUF - s->recv_used))
	436	size = RECV_BUF - s->recv_used;
	437
	438	start = s->recv_ptr + s->recv_used;
	439	if (start < RECV_BUF) {
	440	/* copy data to end of buffer */
	441	first_size = RECV_BUF - start;
	442	if (first_size > size)
	443	first_size = size;
	444
	445	memcpy(s->recv_buf + start, buf, first_size);
	446
	447	/* wrap around to front if needed */
	448	if (size > first_size)
	449	memcpy(s->recv_buf, buf + first_size, size - first_size);
	450	} else {
	451	start -= RECV_BUF;
	452	memcpy(s->recv_buf + start, buf, size);
	453	}
a7954218 AZ	454	s->recv_used += size;
	455	}
	456
8fcd3692	457	static void usb_serial_event(void *opaque, int event)
a7954218 AZ	458	{
	459	USBSerialState *s = opaque;
	460
	461	switch (event) {
	462	case CHR_EVENT_BREAK:
7e57f049	463	s->event_trigger \|= FTDI_BI;
a7954218 AZ	464	break;
	465	case CHR_EVENT_FOCUS:
	466	break;
b6b8df56	467	case CHR_EVENT_OPENED:
da124e62	468	if (!s->dev.attached) {
7334d650	469	usb_device_attach(&s->dev, &error_abort);
da124e62 GH	470	}
	471	break;
	472	case CHR_EVENT_CLOSED:
	473	if (s->dev.attached) {
	474	usb_device_detach(&s->dev);
	475	}
a7954218 AZ	476	break;
	477	}
	478	}
	479
38fff2c9	480	static void usb_serial_realize(USBDevice dev, Error *errp)
806b6024	481	{
cdf0d769	482	USBSerialState *s = USB_SERIAL_DEV(dev);
7334d650	483	Error *local_err = NULL;
a980a065	484
9d55d1ad	485	usb_desc_create_serial(dev);
a980a065	486	usb_desc_init(dev);
da124e62	487	dev->auto_attach = 0;
2b0efdc3	488
81bf96d3	489	if (!s->cs) {
38fff2c9 GA	490	error_setg(errp, "Property chardev is required");
38fff2c9 GA	491	return;
81bf96d3 MA	492	}
81bf96d3 MA	493
7334d650 GA	494	usb_check_attach(dev, &local_err);
	495	if (local_err) {
	496	error_propagate(errp, local_err);
	497	return;
	498	}
	499
2b0efdc3 GH	500	qemu_chr_add_handlers(s->cs, usb_serial_can_read, usb_serial_read,
	501	usb_serial_event, s);
	502	usb_serial_handle_reset(dev);
da124e62	503
16665b94	504	if (s->cs->be_open && !dev->attached) {
7334d650	505	usb_device_attach(dev, &error_abort);
da124e62	506	}
806b6024 GH	507	}
806b6024 GH	508
3741715c	509	static USBDevice usb_serial_init(USBBus bus, const char *filename)
a7954218	510	{
806b6024	511	USBDevice *dev;
a7954218	512	CharDriverState *cdrv;
2b0efdc3	513	uint32_t vendorid = 0, productid = 0;
5ccfae10 AL	514	char label[32];
5ccfae10 AL	515	static int index;
a7954218 AZ	516
	517	while (filename && filename != ':') {
	518	const char *p;
	519	char *e;
	520	if (strstart(filename, "vendorid=", &p)) {
	521	vendorid = strtol(p, &e, 16);
	522	if (e == p \|\| (e && e != ',' && *e != ':')) {
1ecda02b	523	error_report("bogus vendor ID %s", p);
a7954218 AZ	524	return NULL;
	525	}
	526	filename = e;
	527	} else if (strstart(filename, "productid=", &p)) {
	528	productid = strtol(p, &e, 16);
	529	if (e == p \|\| (e && e != ',' && *e != ':')) {
1ecda02b	530	error_report("bogus product ID %s", p);
a7954218 AZ	531	return NULL;
	532	}
	533	filename = e;
	534	} else {
1ecda02b	535	error_report("unrecognized serial USB option %s", filename);
a7954218 AZ	536	return NULL;
	537	}
	538	while(*filename == ',')
	539	filename++;
	540	}
	541	if (!*filename) {
1ecda02b	542	error_report("character device specification needed");
a7954218 AZ	543	return NULL;
	544	}
	545	filename++;
a7954218	546
5ccfae10	547	snprintf(label, sizeof(label), "usbserial%d", index++);
27143a44	548	cdrv = qemu_chr_new(label, filename, NULL);
a7954218	549	if (!cdrv)
806b6024	550	return NULL;
a7954218	551
3741715c	552	dev = usb_create(bus, "usb-serial");
2b0efdc3 GH	553	qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
	554	if (vendorid)
	555	qdev_prop_set_uint16(&dev->qdev, "vendorid", vendorid);
	556	if (productid)
	557	qdev_prop_set_uint16(&dev->qdev, "productid", productid);
2b0efdc3 GH	558	return dev;
	559	}
	560
3741715c	561	static USBDevice usb_braille_init(USBBus bus, const char *unused)
2b0efdc3 GH	562	{
	563	USBDevice *dev;
	564	CharDriverState *cdrv;
	565
27143a44	566	cdrv = qemu_chr_new("braille", "braille", NULL);
2b0efdc3 GH	567	if (!cdrv)
2b0efdc3 GH	568	return NULL;
806b6024	569
3741715c	570	dev = usb_create(bus, "usb-braille");
2b0efdc3	571	qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
2b0efdc3	572	return dev;
a7954218	573	}
806b6024	574
98e51ec9 GH	575	static const VMStateDescription vmstate_usb_serial = {
	576	.name = "usb-serial",
	577	.unmigratable = 1,
	578	};
	579
39bffca2 AL	580	static Property serial_properties[] = {
	581	DEFINE_PROP_CHR("chardev", USBSerialState, cs),
	582	DEFINE_PROP_END_OF_LIST(),
	583	};
	584
cdf0d769	585	static void usb_serial_dev_class_init(ObjectClass klass, void data)
62aed765	586	{
39bffca2	587	DeviceClass *dc = DEVICE_CLASS(klass);
62aed765 AL	588	USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
62aed765 AL	589
cdf0d769	590	uc->realize = usb_serial_realize;
62aed765 AL	591	uc->handle_reset = usb_serial_handle_reset;
	592	uc->handle_control = usb_serial_handle_control;
	593	uc->handle_data = usb_serial_handle_data;
39bffca2	594	dc->vmsd = &vmstate_usb_serial;
125ee0ed	595	set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
62aed765 AL	596	}
62aed765 AL	597
cdf0d769 GA	598	static const TypeInfo usb_serial_dev_type_info = {
	599	.name = TYPE_USB_SERIAL,
	600	.parent = TYPE_USB_DEVICE,
	601	.instance_size = sizeof(USBSerialState),
	602	.abstract = true,
	603	.class_init = usb_serial_dev_class_init,
	604	};
	605
	606	static void usb_serial_class_initfn(ObjectClass klass, void data)
	607	{
	608	DeviceClass *dc = DEVICE_CLASS(klass);
	609	USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
	610
	611	uc->product_desc = "QEMU USB Serial";
	612	uc->usb_desc = &desc_serial;
	613	dc->props = serial_properties;
	614	}
	615
8c43a6f0	616	static const TypeInfo serial_info = {
39bffca2	617	.name = "usb-serial",
cdf0d769	618	.parent = TYPE_USB_SERIAL,
39bffca2 AL	619	.class_init = usb_serial_class_initfn,
	620	};
	621
	622	static Property braille_properties[] = {
	623	DEFINE_PROP_CHR("chardev", USBSerialState, cs),
	624	DEFINE_PROP_END_OF_LIST(),
2b0efdc3 GH	625	};
2b0efdc3 GH	626
62aed765 AL	627	static void usb_braille_class_initfn(ObjectClass klass, void data)
62aed765 AL	628	{
39bffca2	629	DeviceClass *dc = DEVICE_CLASS(klass);
62aed765 AL	630	USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
62aed765 AL	631
62aed765 AL	632	uc->product_desc = "QEMU USB Braille";
62aed765 AL	633	uc->usb_desc = &desc_braille;
39bffca2	634	dc->props = braille_properties;
62aed765 AL	635	}
62aed765 AL	636
8c43a6f0	637	static const TypeInfo braille_info = {
39bffca2	638	.name = "usb-braille",
cdf0d769	639	.parent = TYPE_USB_SERIAL,
39bffca2	640	.class_init = usb_braille_class_initfn,
806b6024 GH	641	};
806b6024 GH	642
83f7d43a	643	static void usb_serial_register_types(void)
806b6024	644	{
cdf0d769	645	type_register_static(&usb_serial_dev_type_info);
39bffca2	646	type_register_static(&serial_info);
ba02430f	647	usb_legacy_register("usb-serial", "serial", usb_serial_init);
39bffca2	648	type_register_static(&braille_info);
ba02430f	649	usb_legacy_register("usb-braille", "braille", usb_braille_init);
806b6024	650	}
83f7d43a AF	651
83f7d43a AF	652	type_init(usb_serial_register_types)