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

/*
 * FTDI FT232BM Device emulation
 *
 * Copyright (c) 2006 CodeSourcery.
 * Copyright (c) 2008 Samuel Thibault <samuel.thibault@ens-lyon.org>
 * 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/cutils.h"
#include "qemu/error-report.h"
#include "qemu/module.h"
#include "hw/qdev-properties.h"
#include "hw/usb.h"
#include "migration/vmstate.h"
#include "desc.h"
#include "chardev/char-serial.h"
#include "chardev/char-fe.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 (512 - (2 * 8))

/* 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;
    USBEndpoint *intr;
    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 */
    CharBackend 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 | USB_CFG_ATT_WAKEUP,
            .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] = FTDI_THRE | FTDI_TEMT;
        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_token_in(USBSerialState *s, USBPacket *p)
{
    const int max_packet_size = desc_iface0.eps[0].wMaxPacketSize;
    int packet_len;
    uint8_t header[2];

    packet_len = p->iov.size;
    if (packet_len <= 2) {
        p->status = USB_RET_NAK;
        return;
    }

    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);
        return;
    } else {
        header[1] = 0;
    }

    if (!s->recv_used) {
        p->status = USB_RET_NAK;
        return;
    }

    while (s->recv_used && packet_len > 2) {
        int first_len, len;

        len = MIN(packet_len, max_packet_size);
        len -= 2;
        if (len > s->recv_used) {
            len = s->recv_used;
        }

        first_len = RECV_BUF - s->recv_ptr;
        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;
        packet_len -= len + 2;
    }

    return;
}

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

    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;
            /* XXX this blocks entire thread. Rewrite to use
             * qemu_chr_fe_write and background I/O callbacks */
            qemu_chr_fe_write_all(&s->cs, iov->iov_base, iov->iov_len);
        }
        p->actual_length = p->iov.size;
        break;

    case USB_TOKEN_IN:
        if (devep != 1)
            goto fail;
        usb_serial_token_in(s, p);
        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;

    usb_wakeup(s->intr, 0);
}

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

    switch (event) {
        case CHR_EVENT_BREAK:
            s->event_trigger |= FTDI_BI;
            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;
        case CHR_EVENT_MUX_IN:
        case CHR_EVENT_MUX_OUT:
            /* Ignore */
            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 (!qemu_chr_fe_backend_connected(&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_fe_set_handlers(&s->cs, usb_serial_can_read, usb_serial_read,
                             usb_serial_event, NULL, s, NULL, true);
    usb_serial_handle_reset(dev);

    if (qemu_chr_fe_backend_open(&s->cs) && !dev->attached) {
        usb_device_attach(dev, &error_abort);
    }
    s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1);
}

static USBDevice *usb_braille_init(const char *unused)
{
    USBDevice *dev;
    Chardev *cdrv;

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

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