[qemu.git] / hw / usb-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 licenced under the LGPL.
 */

#include "qemu-common.h"
#include "usb.h"
#include "qemu-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;
    uint32_t vendorid;
    uint32_t productid;
    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;

static const uint8_t qemu_serial_dev_descriptor[] = {
        0x12,       /*  u8 bLength; */
        0x01,       /*  u8 bDescriptorType; Device */
        0x00, 0x02, /*  u16 bcdUSB; v2.0 */

        0x00,       /*  u8  bDeviceClass; */
        0x00,       /*  u8  bDeviceSubClass; */
        0x00,       /*  u8  bDeviceProtocol; [ low/full speeds only ] */
        0x08,       /*  u8  bMaxPacketSize0; 8 Bytes */

        /* Vendor and product id are arbitrary.  */
        0x03, 0x04, /*  u16 idVendor; */
        0x00, 0xFF, /*  u16 idProduct; */
        0x00, 0x04, /*  u16 bcdDevice */

        0x01,       /*  u8  iManufacturer; */
        0x02,       /*  u8  iProduct; */
        0x03,       /*  u8  iSerialNumber; */
        0x01        /*  u8  bNumConfigurations; */
};

static const uint8_t qemu_serial_config_descriptor[] = {

        /* one configuration */
        0x09,       /*  u8  bLength; */
        0x02,       /*  u8  bDescriptorType; Configuration */
        0x20, 0x00, /*  u16 wTotalLength; */
        0x01,       /*  u8  bNumInterfaces; (1) */
        0x01,       /*  u8  bConfigurationValue; */
        0x00,       /*  u8  iConfiguration; */
        0x80,       /*  u8  bmAttributes;
                                 Bit 7: must be set,
                                     6: Self-powered,
                                     5: Remote wakeup,
                                     4..0: resvd */
        100/2,       /*  u8  MaxPower; */

        /* one interface */
        0x09,       /*  u8  if_bLength; */
        0x04,       /*  u8  if_bDescriptorType; Interface */
        0x00,       /*  u8  if_bInterfaceNumber; */
        0x00,       /*  u8  if_bAlternateSetting; */
        0x02,       /*  u8  if_bNumEndpoints; */
        0xff,       /*  u8  if_bInterfaceClass; Vendor Specific */
        0xff,       /*  u8  if_bInterfaceSubClass; Vendor Specific */
        0xff,       /*  u8  if_bInterfaceProtocol; Vendor Specific */
        0x02,       /*  u8  if_iInterface; */

        /* Bulk-In endpoint */
        0x07,       /*  u8  ep_bLength; */
        0x05,       /*  u8  ep_bDescriptorType; Endpoint */
        0x81,       /*  u8  ep_bEndpointAddress; IN Endpoint 1 */
        0x02,       /*  u8  ep_bmAttributes; Bulk */
        0x40, 0x00, /*  u16 ep_wMaxPacketSize; */
        0x00,       /*  u8  ep_bInterval; */

        /* Bulk-Out endpoint */
        0x07,       /*  u8  ep_bLength; */
        0x05,       /*  u8  ep_bDescriptorType; Endpoint */
        0x02,       /*  u8  ep_bEndpointAddress; OUT Endpoint 2 */
        0x02,       /*  u8  ep_bmAttributes; Bulk */
        0x40, 0x00, /*  u16 ep_wMaxPacketSize; */
        0x00        /*  u8  ep_bInterval; */
};

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_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 int usb_serial_handle_control(USBDevice *dev, int request, int value,
                                  int index, int length, uint8_t *data)
{
    USBSerialState *s = (USBSerialState *)dev;
    int ret = 0;

    //DPRINTF("got control %x, value %x\n",request, value);
    switch (request) {
    case DeviceRequest | USB_REQ_GET_STATUS:
        data[0] = (0 << USB_DEVICE_SELF_POWERED) |
            (dev->remote_wakeup << USB_DEVICE_REMOTE_WAKEUP);
        data[1] = 0x00;
        ret = 2;
        break;
    case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
        if (value == USB_DEVICE_REMOTE_WAKEUP) {
            dev->remote_wakeup = 0;
        } else {
            goto fail;
        }
        ret = 0;
        break;
    case DeviceOutRequest | USB_REQ_SET_FEATURE:
        if (value == USB_DEVICE_REMOTE_WAKEUP) {
            dev->remote_wakeup = 1;
        } else {
            goto fail;
        }
        ret = 0;
        break;
    case DeviceOutRequest | USB_REQ_SET_ADDRESS:
        dev->addr = value;
        ret = 0;
        break;
    case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
        switch(value >> 8) {
        case USB_DT_DEVICE:
            memcpy(data, qemu_serial_dev_descriptor,
                   sizeof(qemu_serial_dev_descriptor));
            data[8] = s->vendorid & 0xff;
            data[9] = ((s->vendorid) >> 8) & 0xff;
            data[10] = s->productid & 0xff;
            data[11] = ((s->productid) >> 8) & 0xff;
            ret = sizeof(qemu_serial_dev_descriptor);
            break;
        case USB_DT_CONFIG:
            memcpy(data, qemu_serial_config_descriptor,
                   sizeof(qemu_serial_config_descriptor));
            ret = sizeof(qemu_serial_config_descriptor);
            break;
        case USB_DT_STRING:
            switch(value & 0xff) {
            case 0:
                /* language ids */
                data[0] = 4;
                data[1] = 3;
                data[2] = 0x09;
                data[3] = 0x04;
                ret = 4;
                break;
            case 1:
                /* vendor description */
                ret = set_usb_string(data, "QEMU " QEMU_VERSION);
                break;
            case 2:
                /* product description */
                ret = set_usb_string(data, "QEMU USB SERIAL");
                break;
            case 3:
                /* serial number */
                ret = set_usb_string(data, "1");
                break;
            default:
                goto fail;
            }
            break;
        default:
            goto fail;
        }
        break;
    case DeviceRequest | USB_REQ_GET_CONFIGURATION:
        data[0] = 1;
        ret = 1;
        break;
    case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
        ret = 0;
        break;
    case DeviceRequest | USB_REQ_GET_INTERFACE:
        data[0] = 0;
        ret = 1;
        break;
    case InterfaceOutRequest | USB_REQ_SET_INTERFACE:
        ret = 0;
        break;
    case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
        ret = 0;
        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_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_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_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_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;
        ret = 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;
        ret = 1;
        break;
    default:
    fail:
        DPRINTF("got unsupported/bogus control %x, value %x\n", request, value);
        ret = USB_RET_STALL;
        break;
    }
    return ret;
}

static int usb_serial_handle_data(USBDevice *dev, USBPacket *p)
{
    USBSerialState *s = (USBSerialState *)dev;
    int ret = 0;
    uint8_t devep = p->devep;
    uint8_t *data = p->data;
    int len = p->len;
    int first_len;

    switch (p->pid) {
    case USB_TOKEN_OUT:
        if (devep != 2)
            goto fail;
        qemu_chr_write(s->cs, data, len);
        break;

    case USB_TOKEN_IN:
        if (devep != 1)
            goto fail;
        first_len = RECV_BUF - s->recv_ptr;
        if (len <= 2) {
            ret = USB_RET_NAK;
            break;
        }
        *data++ = 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;
            *data++ = FTDI_BI;
            ret = 2;
            break;
        } else {
            *data++ = 0;
        }
        len -= 2;
        if (len > s->recv_used)
            len = s->recv_used;
        if (!len) {
            ret = USB_RET_NAK;
            break;
        }
        if (first_len > len)
            first_len = len;
        memcpy(data, s->recv_buf + s->recv_ptr, first_len);
        if (len > first_len)
            memcpy(data + first_len, s->recv_buf, len - first_len);
        s->recv_used -= len;
        s->recv_ptr = (s->recv_ptr + len) % RECV_BUF;
        ret = len + 2;
        break;

    default:
        DPRINTF("Bad token\n");
    fail:
        ret = USB_RET_STALL;
        break;
    }

    return ret;
}

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

    qemu_chr_close(s->cs);
}

static int usb_serial_can_read(void *opaque)
{
    USBSerialState *s = opaque;
    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 = RECV_BUF - s->recv_ptr;
    if (first_size > size)
        first_size = size;
    memcpy(s->recv_buf + s->recv_ptr + s->recv_used, buf, first_size);
    if (size > first_size)
        memcpy(s->recv_buf, buf + first_size, size - first_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:
            usb_serial_reset(s);
            /* TODO: Reset USB port */
            break;
    }
}

static int usb_serial_initfn(USBDevice *dev)
{
    USBSerialState *s = DO_UPCAST(USBSerialState, dev, dev);
    s->dev.speed = USB_SPEED_FULL;

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

static USBDevice *usb_serial_init(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 != ':')) {
                qemu_error("bogus vendor ID %s\n", p);
                return NULL;
            }
            filename = e;
        } else if (strstart(filename, "productid=", &p)) {
            productid = strtol(p, &e, 16);
            if (e == p || (*e && *e != ',' && *e != ':')) {
                qemu_error("bogus product ID %s\n", p);
                return NULL;
            }
            filename = e;
        } else {
            qemu_error("unrecognized serial USB option %s\n", filename);
            return NULL;
        }
        while(*filename == ',')
            filename++;
    }
    if (!*filename) {
        qemu_error("character device specification needed\n");
        return NULL;
    }
    filename++;

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

    dev = usb_create(NULL /* FIXME */, "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);
    qdev_init_nofail(&dev->qdev);

    return dev;
}

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

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

    dev = usb_create(NULL /* FIXME */, "usb-braille");
    qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
    qdev_init_nofail(&dev->qdev);

    return dev;
}

static struct USBDeviceInfo serial_info = {
    .product_desc   = "QEMU USB Serial",
    .qdev.name      = "usb-serial",
    .qdev.size      = sizeof(USBSerialState),
    .init           = usb_serial_initfn,
    .handle_packet  = usb_generic_handle_packet,
    .handle_reset   = usb_serial_handle_reset,
    .handle_control = usb_serial_handle_control,
    .handle_data    = usb_serial_handle_data,
    .handle_destroy = usb_serial_handle_destroy,
    .usbdevice_name = "serial",
    .usbdevice_init = usb_serial_init,
    .qdev.props     = (Property[]) {
        DEFINE_PROP_CHR("chardev",     USBSerialState, cs),
        DEFINE_PROP_HEX32("vendorid",  USBSerialState, vendorid,  0x0403),
        DEFINE_PROP_HEX32("productid", USBSerialState, productid, 0x6001),
        DEFINE_PROP_END_OF_LIST(),
    },
};

static struct USBDeviceInfo braille_info = {
    .product_desc   = "QEMU USB Braille",
    .qdev.name      = "usb-braille",
    .qdev.size      = sizeof(USBSerialState),
    .init           = usb_serial_initfn,
    .handle_packet  = usb_generic_handle_packet,
    .handle_reset   = usb_serial_handle_reset,
    .handle_control = usb_serial_handle_control,
    .handle_data    = usb_serial_handle_data,
    .handle_destroy = usb_serial_handle_destroy,
    .usbdevice_name = "braille",
    .usbdevice_init = usb_braille_init,
    .qdev.props     = (Property[]) {
        DEFINE_PROP_CHR("chardev",     USBSerialState, cs),
        DEFINE_PROP_HEX32("vendorid",  USBSerialState, vendorid,  0x0403),
        DEFINE_PROP_HEX32("productid", USBSerialState, productid, 0xfe72),
        DEFINE_PROP_END_OF_LIST(),
    },
};

static void usb_serial_register_devices(void)
{
    usb_qdev_register(&serial_info);
    usb_qdev_register(&braille_info);
}
device_init(usb_serial_register_devices)
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	*
	8	* This code is licenced under the LGPL.
	9	*/
	10
	11	#include "qemu-common.h"
	12	#include "usb.h"
	13	#include "qemu-char.h"
	14
	15	//#define DEBUG_Serial
	16
	17	#ifdef DEBUG_Serial
001faf32 BS	18	#define DPRINTF(fmt, ...) \
001faf32 BS	19	do { printf("usb-serial: " fmt , ## __VA_ARGS__); } while (0)
a7954218	20	#else
001faf32	21	#define DPRINTF(fmt, ...) do {} while(0)
a7954218 AZ	22	#endif
	23
	24	#define RECV_BUF 384
a7954218 AZ	25
	26	/* Commands */
	27	#define FTDI_RESET 0
	28	#define FTDI_SET_MDM_CTRL 1
	29	#define FTDI_SET_FLOW_CTRL 2
	30	#define FTDI_SET_BAUD 3
	31	#define FTDI_SET_DATA 4
	32	#define FTDI_GET_MDM_ST 5
	33	#define FTDI_SET_EVENT_CHR 6
	34	#define FTDI_SET_ERROR_CHR 7
	35	#define FTDI_SET_LATENCY 9
	36	#define FTDI_GET_LATENCY 10
	37
	38	#define DeviceOutVendor ((USB_DIR_OUT\|USB_TYPE_VENDOR\|USB_RECIP_DEVICE)<<8)
	39	#define DeviceInVendor ((USB_DIR_IN \|USB_TYPE_VENDOR\|USB_RECIP_DEVICE)<<8)
	40
	41	/* RESET */
	42
	43	#define FTDI_RESET_SIO 0
	44	#define FTDI_RESET_RX 1
	45	#define FTDI_RESET_TX 2
	46
	47	/* SET_MDM_CTRL */
	48
a7954218	49	#define FTDI_DTR 1
abb8a139	50	#define FTDI_SET_DTR (FTDI_DTR << 8)
a7954218	51	#define FTDI_RTS 2
abb8a139	52	#define FTDI_SET_RTS (FTDI_RTS << 8)
a7954218 AZ	53
	54	/* SET_FLOW_CTRL */
	55
	56	#define FTDI_RTS_CTS_HS 1
	57	#define FTDI_DTR_DSR_HS 2
	58	#define FTDI_XON_XOFF_HS 4
	59
	60	/* SET_DATA */
	61
	62	#define FTDI_PARITY (0x7 << 8)
	63	#define FTDI_ODD (0x1 << 8)
	64	#define FTDI_EVEN (0x2 << 8)
	65	#define FTDI_MARK (0x3 << 8)
	66	#define FTDI_SPACE (0x4 << 8)
	67
	68	#define FTDI_STOP (0x3 << 11)
	69	#define FTDI_STOP1 (0x0 << 11)
	70	#define FTDI_STOP15 (0x1 << 11)
	71	#define FTDI_STOP2 (0x2 << 11)
	72
	73	/* GET_MDM_ST */
	74	/* TODO: should be sent every 40ms */
	75	#define FTDI_CTS (1<<4) // CTS line status
	76	#define FTDI_DSR (1<<5) // DSR line status
	77	#define FTDI_RI (1<<6) // RI line status
	78	#define FTDI_RLSD (1<<7) // Receive Line Signal Detect
	79
	80	/* Status */
	81
	82	#define FTDI_DR (1<<0) // Data Ready
	83	#define FTDI_OE (1<<1) // Overrun Err
	84	#define FTDI_PE (1<<2) // Parity Err
	85	#define FTDI_FE (1<<3) // Framing Err
	86	#define FTDI_BI (1<<4) // Break Interrupt
	87	#define FTDI_THRE (1<<5) // Transmitter Holding Register
	88	#define FTDI_TEMT (1<<6) // Transmitter Empty
	89	#define FTDI_FIFO (1<<7) // Error in FIFO
	90
	91	typedef struct {
	92	USBDevice dev;
2b0efdc3 GH	93	uint32_t vendorid;
2b0efdc3 GH	94	uint32_t productid;
a7954218	95	uint8_t recv_buf[RECV_BUF];
8109b9b6 AJ	96	uint16_t recv_ptr;
8109b9b6 AJ	97	uint16_t recv_used;
a7954218 AZ	98	uint8_t event_chr;
	99	uint8_t error_chr;
	100	uint8_t event_trigger;
a7954218 AZ	101	QEMUSerialSetParams params;
	102	int latency; /* ms */
	103	CharDriverState *cs;
	104	} USBSerialState;
	105
	106	static const uint8_t qemu_serial_dev_descriptor[] = {
	107	0x12, /* u8 bLength; */
	108	0x01, /* u8 bDescriptorType; Device */
	109	0x00, 0x02, /* u16 bcdUSB; v2.0 */
	110
	111	0x00, /* u8 bDeviceClass; */
	112	0x00, /* u8 bDeviceSubClass; */
	113	0x00, /* u8 bDeviceProtocol; [ low/full speeds only ] */
	114	0x08, /* u8 bMaxPacketSize0; 8 Bytes */
	115
	116	/* Vendor and product id are arbitrary. */
	117	0x03, 0x04, /* u16 idVendor; */
	118	0x00, 0xFF, /* u16 idProduct; */
	119	0x00, 0x04, /* u16 bcdDevice */
	120
	121	0x01, /* u8 iManufacturer; */
	122	0x02, /* u8 iProduct; */
	123	0x03, /* u8 iSerialNumber; */
	124	0x01 /* u8 bNumConfigurations; */
	125	};
	126
	127	static const uint8_t qemu_serial_config_descriptor[] = {
	128
	129	/* one configuration */
	130	0x09, /* u8 bLength; */
	131	0x02, /* u8 bDescriptorType; Configuration */
	132	0x20, 0x00, /* u16 wTotalLength; */
	133	0x01, /* u8 bNumInterfaces; (1) */
	134	0x01, /* u8 bConfigurationValue; */
	135	0x00, /* u8 iConfiguration; */
	136	0x80, /* u8 bmAttributes;
	137	Bit 7: must be set,
	138	6: Self-powered,
	139	5: Remote wakeup,
	140	4..0: resvd */
	141	100/2, /* u8 MaxPower; */
	142
	143	/* one interface */
	144	0x09, /* u8 if_bLength; */
	145	0x04, /* u8 if_bDescriptorType; Interface */
	146	0x00, /* u8 if_bInterfaceNumber; */
	147	0x00, /* u8 if_bAlternateSetting; */
	148	0x02, /* u8 if_bNumEndpoints; */
	149	0xff, /* u8 if_bInterfaceClass; Vendor Specific */
	150	0xff, /* u8 if_bInterfaceSubClass; Vendor Specific */
	151	0xff, /* u8 if_bInterfaceProtocol; Vendor Specific */
	152	0x02, /* u8 if_iInterface; */
	153
	154	/* Bulk-In endpoint */
	155	0x07, /* u8 ep_bLength; */
	156	0x05, /* u8 ep_bDescriptorType; Endpoint */
	157	0x81, /* u8 ep_bEndpointAddress; IN Endpoint 1 */
	158	0x02, /* u8 ep_bmAttributes; Bulk */
	159	0x40, 0x00, /* u16 ep_wMaxPacketSize; */
	160	0x00, /* u8 ep_bInterval; */
	161
	162	/* Bulk-Out endpoint */
	163	0x07, /* u8 ep_bLength; */
	164	0x05, /* u8 ep_bDescriptorType; Endpoint */
165	0x02, /* u8 ep_bEndpointAddress; OUT Endpoint 2 */
166	0x02, /* u8 ep_bmAttributes; Bulk */
167	0x40, 0x00, /* u16 ep_wMaxPacketSize; */
168	0x00 /* u8 ep_bInterval; */
169	};
170
171	static void usb_serial_reset(USBSerialState *s)
172	{
173	/* TODO: Set flow control to none */
174	s->event_chr = 0x0d;
175	s->event_trigger = 0;
176	s->recv_ptr = 0;
177	s->recv_used = 0;
178	/* TODO: purge in char driver */
a7954218 AZ	179	}
	180
	181	static void usb_serial_handle_reset(USBDevice *dev)
	182	{
	183	USBSerialState s = (USBSerialState )dev;
	184
	185	DPRINTF("Reset\n");
	186
	187	usb_serial_reset(s);
	188	/* TODO: Reset char device, send BREAK? */
	189	}
	190
abb8a139 AJ	191	static uint8_t usb_get_modem_lines(USBSerialState *s)
	192	{
	193	int flags;
	194	uint8_t ret;
	195
	196	if (qemu_chr_ioctl(s->cs, CHR_IOCTL_SERIAL_GET_TIOCM, &flags) == -ENOTSUP)
	197	return FTDI_CTS\|FTDI_DSR\|FTDI_RLSD;
	198
	199	ret = 0;
	200	if (flags & CHR_TIOCM_CTS)
	201	ret \|= FTDI_CTS;
	202	if (flags & CHR_TIOCM_DSR)
	203	ret \|= FTDI_DSR;
	204	if (flags & CHR_TIOCM_RI)
	205	ret \|= FTDI_RI;
	206	if (flags & CHR_TIOCM_CAR)
	207	ret \|= FTDI_RLSD;
	208
	209	return ret;
	210	}
	211
a7954218 AZ	212	static int usb_serial_handle_control(USBDevice *dev, int request, int value,
	213	int index, int length, uint8_t *data)
	214	{
	215	USBSerialState s = (USBSerialState )dev;
	216	int ret = 0;
	217
	218	//DPRINTF("got control %x, value %x\n",request, value);
	219	switch (request) {
	220	case DeviceRequest \| USB_REQ_GET_STATUS:
	221	data[0] = (0 << USB_DEVICE_SELF_POWERED) \|
	222	(dev->remote_wakeup << USB_DEVICE_REMOTE_WAKEUP);
	223	data[1] = 0x00;
	224	ret = 2;
	225	break;
	226	case DeviceOutRequest \| USB_REQ_CLEAR_FEATURE:
	227	if (value == USB_DEVICE_REMOTE_WAKEUP) {
	228	dev->remote_wakeup = 0;
	229	} else {
	230	goto fail;
	231	}
	232	ret = 0;
	233	break;
	234	case DeviceOutRequest \| USB_REQ_SET_FEATURE:
	235	if (value == USB_DEVICE_REMOTE_WAKEUP) {
	236	dev->remote_wakeup = 1;
	237	} else {
	238	goto fail;
	239	}
	240	ret = 0;
	241	break;
	242	case DeviceOutRequest \| USB_REQ_SET_ADDRESS:
	243	dev->addr = value;
	244	ret = 0;
	245	break;
	246	case DeviceRequest \| USB_REQ_GET_DESCRIPTOR:
	247	switch(value >> 8) {
	248	case USB_DT_DEVICE:
	249	memcpy(data, qemu_serial_dev_descriptor,
	250	sizeof(qemu_serial_dev_descriptor));
	251	data[8] = s->vendorid & 0xff;
	252	data[9] = ((s->vendorid) >> 8) & 0xff;
	253	data[10] = s->productid & 0xff;
	254	data[11] = ((s->productid) >> 8) & 0xff;
	255	ret = sizeof(qemu_serial_dev_descriptor);
	256	break;
	257	case USB_DT_CONFIG:
	258	memcpy(data, qemu_serial_config_descriptor,
	259	sizeof(qemu_serial_config_descriptor));
	260	ret = sizeof(qemu_serial_config_descriptor);
	261	break;
	262	case USB_DT_STRING:
	263	switch(value & 0xff) {
	264	case 0:
	265	/* language ids */
	266	data[0] = 4;
	267	data[1] = 3;
	268	data[2] = 0x09;
	269	data[3] = 0x04;
	270	ret = 4;
	271	break;
	272	case 1:
	273	/* vendor description */
	274	ret = set_usb_string(data, "QEMU " QEMU_VERSION);
	275	break;
276	case 2:
277	/* product description */
278	ret = set_usb_string(data, "QEMU USB SERIAL");
279	break;
280	case 3:
281	/* serial number */
282	ret = set_usb_string(data, "1");
283	break;
284	default:
285	goto fail;
286	}
287	break;
288	default:
289	goto fail;
290	}
291	break;
292	case DeviceRequest \| USB_REQ_GET_CONFIGURATION:
293	data[0] = 1;
294	ret = 1;
295	break;
296	case DeviceOutRequest \| USB_REQ_SET_CONFIGURATION:
297	ret = 0;
298	break;
299	case DeviceRequest \| USB_REQ_GET_INTERFACE:
300	data[0] = 0;
301	ret = 1;
302	break;
303	case InterfaceOutRequest \| USB_REQ_SET_INTERFACE:
304	ret = 0;
305	break;
306	case EndpointOutRequest \| USB_REQ_CLEAR_FEATURE:
307	ret = 0;
308	break;
309
310	/* Class specific requests. */
311	case DeviceOutVendor \| FTDI_RESET:
312	switch (value) {
313	case FTDI_RESET_SIO:
314	usb_serial_reset(s);
315	break;
316	case FTDI_RESET_RX:
317	s->recv_ptr = 0;
318	s->recv_used = 0;
319	/* TODO: purge from char device */
320	break;
321	case FTDI_RESET_TX:
322	/* TODO: purge from char device */
323	break;
324	}
325	break;
326	case DeviceOutVendor \| FTDI_SET_MDM_CTRL:
abb8a139 AJ	327	{
	328	static int flags;
	329	qemu_chr_ioctl(s->cs,CHR_IOCTL_SERIAL_GET_TIOCM, &flags);
	330	if (value & FTDI_SET_RTS) {
	331	if (value & FTDI_RTS)
	332	flags \|= CHR_TIOCM_RTS;
	333	else
	334	flags &= ~CHR_TIOCM_RTS;
	335	}
	336	if (value & FTDI_SET_DTR) {
	337	if (value & FTDI_DTR)
	338	flags \|= CHR_TIOCM_DTR;
	339	else
	340	flags &= ~CHR_TIOCM_DTR;
	341	}
	342	qemu_chr_ioctl(s->cs,CHR_IOCTL_SERIAL_SET_TIOCM, &flags);
a7954218	343	break;
abb8a139	344	}
a7954218 AZ	345	case DeviceOutVendor \| FTDI_SET_FLOW_CTRL:
	346	/* TODO: ioctl */
	347	break;
	348	case DeviceOutVendor \| FTDI_SET_BAUD: {
	349	static const int subdivisors8[8] = { 0, 4, 2, 1, 3, 5, 6, 7 };
	350	int subdivisor8 = subdivisors8[((value & 0xc000) >> 14)
	351	\| ((index & 1) << 2)];
	352	int divisor = value & 0x3fff;
	353
	354	/* chip special cases */
	355	if (divisor == 1 && subdivisor8 == 0)
	356	subdivisor8 = 4;
	357	if (divisor == 0 && subdivisor8 == 0)
	358	divisor = 1;
	359
	360	s->params.speed = (48000000 / 2) / (8 * divisor + subdivisor8);
	361	qemu_chr_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
	362	break;
	363	}
	364	case DeviceOutVendor \| FTDI_SET_DATA:
	365	switch (value & FTDI_PARITY) {
	366	case 0:
	367	s->params.parity = 'N';
	368	break;
	369	case FTDI_ODD:
	370	s->params.parity = 'O';
	371	break;
	372	case FTDI_EVEN:
	373	s->params.parity = 'E';
	374	break;
	375	default:
	376	DPRINTF("unsupported parity %d\n", value & FTDI_PARITY);
	377	goto fail;
	378	}
	379	switch (value & FTDI_STOP) {
	380	case FTDI_STOP1:
	381	s->params.stop_bits = 1;
	382	break;
	383	case FTDI_STOP2:
	384	s->params.stop_bits = 2;
	385	break;
	386	default:
	387	DPRINTF("unsupported stop bits %d\n", value & FTDI_STOP);
	388	goto fail;
	389	}
	390	qemu_chr_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
	391	/* TODO: TX ON/OFF */
	392	break;
	393	case DeviceInVendor \| FTDI_GET_MDM_ST:
abb8a139 AJ	394	data[0] = usb_get_modem_lines(s) \| 1;
	395	data[1] = 0;
	396	ret = 2;
a7954218 AZ	397	break;
	398	case DeviceOutVendor \| FTDI_SET_EVENT_CHR:
	399	/* TODO: handle it */
	400	s->event_chr = value;
	401	break;
	402	case DeviceOutVendor \| FTDI_SET_ERROR_CHR:
	403	/* TODO: handle it */
	404	s->error_chr = value;
	405	break;
	406	case DeviceOutVendor \| FTDI_SET_LATENCY:
	407	s->latency = value;
	408	break;
	409	case DeviceInVendor \| FTDI_GET_LATENCY:
	410	data[0] = s->latency;
	411	ret = 1;
	412	break;
	413	default:
	414	fail:
	415	DPRINTF("got unsupported/bogus control %x, value %x\n", request, value);
	416	ret = USB_RET_STALL;
	417	break;
	418	}
	419	return ret;
	420	}
	421
	422	static int usb_serial_handle_data(USBDevice dev, USBPacket p)
	423	{
	424	USBSerialState s = (USBSerialState )dev;
	425	int ret = 0;
	426	uint8_t devep = p->devep;
	427	uint8_t *data = p->data;
	428	int len = p->len;
	429	int first_len;
	430
	431	switch (p->pid) {
	432	case USB_TOKEN_OUT:
	433	if (devep != 2)
	434	goto fail;
	435	qemu_chr_write(s->cs, data, len);
	436	break;
	437
	438	case USB_TOKEN_IN:
	439	if (devep != 1)
	440	goto fail;
	441	first_len = RECV_BUF - s->recv_ptr;
	442	if (len <= 2) {
	443	ret = USB_RET_NAK;
	444	break;
	445	}
abb8a139 AJ	446	*data++ = usb_get_modem_lines(s) \| 1;
abb8a139 AJ	447	/* We do not have the uart details */
7e57f049 JW	448	/* handle serial break */
	449	if (s->event_trigger && s->event_trigger & FTDI_BI) {
	450	s->event_trigger &= ~FTDI_BI;
	451	*data++ = FTDI_BI;
	452	ret = 2;
	453	break;
	454	} else {
	455	*data++ = 0;
	456	}
a7954218 AZ	457	len -= 2;
	458	if (len > s->recv_used)
	459	len = s->recv_used;
	460	if (!len) {
	461	ret = USB_RET_NAK;
	462	break;
	463	}
	464	if (first_len > len)
	465	first_len = len;
	466	memcpy(data, s->recv_buf + s->recv_ptr, first_len);
	467	if (len > first_len)
	468	memcpy(data + first_len, s->recv_buf, len - first_len);
	469	s->recv_used -= len;
	470	s->recv_ptr = (s->recv_ptr + len) % RECV_BUF;
	471	ret = len + 2;
	472	break;
	473
	474	default:
	475	DPRINTF("Bad token\n");
	476	fail:
	477	ret = USB_RET_STALL;
	478	break;
	479	}
	480
	481	return ret;
	482	}
	483
	484	static void usb_serial_handle_destroy(USBDevice *dev)
	485	{
	486	USBSerialState s = (USBSerialState )dev;
	487
	488	qemu_chr_close(s->cs);
a7954218 AZ	489	}
a7954218 AZ	490
8fcd3692	491	static int usb_serial_can_read(void *opaque)
a7954218 AZ	492	{
	493	USBSerialState *s = opaque;
	494	return RECV_BUF - s->recv_used;
	495	}
	496
8fcd3692	497	static void usb_serial_read(void opaque, const uint8_t buf, int size)
a7954218 AZ	498	{
	499	USBSerialState *s = opaque;
	500	int first_size = RECV_BUF - s->recv_ptr;
	501	if (first_size > size)
	502	first_size = size;
	503	memcpy(s->recv_buf + s->recv_ptr + s->recv_used, buf, first_size);
	504	if (size > first_size)
	505	memcpy(s->recv_buf, buf + first_size, size - first_size);
	506	s->recv_used += size;
	507	}
	508
8fcd3692	509	static void usb_serial_event(void *opaque, int event)
a7954218 AZ	510	{
	511	USBSerialState *s = opaque;
	512
	513	switch (event) {
	514	case CHR_EVENT_BREAK:
7e57f049	515	s->event_trigger \|= FTDI_BI;
a7954218 AZ	516	break;
	517	case CHR_EVENT_FOCUS:
	518	break;
b6b8df56	519	case CHR_EVENT_OPENED:
a7954218 AZ	520	usb_serial_reset(s);
	521	/* TODO: Reset USB port */
	522	break;
	523	}
	524	}
	525
806b6024 GH	526	static int usb_serial_initfn(USBDevice *dev)
	527	{
	528	USBSerialState *s = DO_UPCAST(USBSerialState, dev, dev);
	529	s->dev.speed = USB_SPEED_FULL;
2b0efdc3 GH	530
	531	qemu_chr_add_handlers(s->cs, usb_serial_can_read, usb_serial_read,
	532	usb_serial_event, s);
	533	usb_serial_handle_reset(dev);
806b6024 GH	534	return 0;
	535	}
	536
2b0efdc3	537	static USBDevice usb_serial_init(const char filename)
a7954218	538	{
806b6024	539	USBDevice *dev;
a7954218	540	CharDriverState *cdrv;
2b0efdc3	541	uint32_t vendorid = 0, productid = 0;
5ccfae10 AL	542	char label[32];
5ccfae10 AL	543	static int index;
a7954218 AZ	544
	545	while (filename && filename != ':') {
	546	const char *p;
	547	char *e;
	548	if (strstart(filename, "vendorid=", &p)) {
	549	vendorid = strtol(p, &e, 16);
	550	if (e == p \|\| (e && e != ',' && *e != ':')) {
2b0efdc3	551	qemu_error("bogus vendor ID %s\n", p);
a7954218 AZ	552	return NULL;
	553	}
	554	filename = e;
	555	} else if (strstart(filename, "productid=", &p)) {
	556	productid = strtol(p, &e, 16);
	557	if (e == p \|\| (e && e != ',' && *e != ':')) {
2b0efdc3	558	qemu_error("bogus product ID %s\n", p);
a7954218 AZ	559	return NULL;
	560	}
	561	filename = e;
	562	} else {
2b0efdc3	563	qemu_error("unrecognized serial USB option %s\n", filename);
a7954218 AZ	564	return NULL;
	565	}
	566	while(*filename == ',')
	567	filename++;
	568	}
	569	if (!*filename) {
2b0efdc3	570	qemu_error("character device specification needed\n");
a7954218 AZ	571	return NULL;
	572	}
	573	filename++;
a7954218	574
5ccfae10	575	snprintf(label, sizeof(label), "usbserial%d", index++);
ceecf1d1	576	cdrv = qemu_chr_open(label, filename, NULL);
a7954218	577	if (!cdrv)
806b6024	578	return NULL;
a7954218	579
556cd098	580	dev = usb_create(NULL /* FIXME */, "usb-serial");
2b0efdc3 GH	581	qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
	582	if (vendorid)
	583	qdev_prop_set_uint16(&dev->qdev, "vendorid", vendorid);
	584	if (productid)
	585	qdev_prop_set_uint16(&dev->qdev, "productid", productid);
beb6f0de	586	qdev_init_nofail(&dev->qdev);
a7954218	587
2b0efdc3 GH	588	return dev;
	589	}
	590
	591	static USBDevice usb_braille_init(const char unused)
	592	{
	593	USBDevice *dev;
	594	CharDriverState *cdrv;
	595
	596	cdrv = qemu_chr_open("braille", "braille", NULL);
	597	if (!cdrv)
	598	return NULL;
806b6024	599
556cd098	600	dev = usb_create(NULL /* FIXME */, "usb-braille");
2b0efdc3	601	qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
beb6f0de	602	qdev_init_nofail(&dev->qdev);
2b0efdc3 GH	603
2b0efdc3 GH	604	return dev;
a7954218	605	}
806b6024 GH	606
806b6024 GH	607	static struct USBDeviceInfo serial_info = {
06384698	608	.product_desc = "QEMU USB Serial",
556cd098	609	.qdev.name = "usb-serial",
2b0efdc3 GH	610	.qdev.size = sizeof(USBSerialState),
	611	.init = usb_serial_initfn,
	612	.handle_packet = usb_generic_handle_packet,
	613	.handle_reset = usb_serial_handle_reset,
	614	.handle_control = usb_serial_handle_control,
	615	.handle_data = usb_serial_handle_data,
	616	.handle_destroy = usb_serial_handle_destroy,
	617	.usbdevice_name = "serial",
	618	.usbdevice_init = usb_serial_init,
	619	.qdev.props = (Property[]) {
	620	DEFINE_PROP_CHR("chardev", USBSerialState, cs),
	621	DEFINE_PROP_HEX32("vendorid", USBSerialState, vendorid, 0x0403),
	622	DEFINE_PROP_HEX32("productid", USBSerialState, productid, 0x6001),
	623	DEFINE_PROP_END_OF_LIST(),
	624	},
	625	};
	626
	627	static struct USBDeviceInfo braille_info = {
06384698	628	.product_desc = "QEMU USB Braille",
556cd098	629	.qdev.name = "usb-braille",
806b6024 GH	630	.qdev.size = sizeof(USBSerialState),
	631	.init = usb_serial_initfn,
	632	.handle_packet = usb_generic_handle_packet,
	633	.handle_reset = usb_serial_handle_reset,
	634	.handle_control = usb_serial_handle_control,
	635	.handle_data = usb_serial_handle_data,
	636	.handle_destroy = usb_serial_handle_destroy,
2b0efdc3 GH	637	.usbdevice_name = "braille",
	638	.usbdevice_init = usb_braille_init,
	639	.qdev.props = (Property[]) {
	640	DEFINE_PROP_CHR("chardev", USBSerialState, cs),
	641	DEFINE_PROP_HEX32("vendorid", USBSerialState, vendorid, 0x0403),
	642	DEFINE_PROP_HEX32("productid", USBSerialState, productid, 0xfe72),
	643	DEFINE_PROP_END_OF_LIST(),
	644	},
806b6024 GH	645	};
	646
	647	static void usb_serial_register_devices(void)
	648	{
	649	usb_qdev_register(&serial_info);
2b0efdc3	650	usb_qdev_register(&braille_info);
806b6024 GH	651	}
806b6024 GH	652	device_init(usb_serial_register_devices)