[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 "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 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 */
    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,
            .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;
            /* 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;
        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_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 (!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);
    }
}

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