1f1ae32a1SGerd Hoffmann /* 2f1ae32a1SGerd Hoffmann * FTDI FT232BM Device emulation 3f1ae32a1SGerd Hoffmann * 4f1ae32a1SGerd Hoffmann * Copyright (c) 2006 CodeSourcery. 5f1ae32a1SGerd Hoffmann * Copyright (c) 2008 Samuel Thibault <samuel.thibault@ens-lyon.org> 6f1ae32a1SGerd Hoffmann * Written by Paul Brook, reused for FTDI by Samuel Thibault 7f1ae32a1SGerd Hoffmann * 8f1ae32a1SGerd Hoffmann * This code is licensed under the LGPL. 9f1ae32a1SGerd Hoffmann */ 10f1ae32a1SGerd Hoffmann 11e532b2e0SPeter Maydell #include "qemu/osdep.h" 12da34e65cSMarkus Armbruster #include "qapi/error.h" 13f348b6d1SVeronia Bahaa #include "qemu/cutils.h" 14d49b6836SMarkus Armbruster #include "qemu/error-report.h" 150b8fa32fSMarkus Armbruster #include "qemu/module.h" 16a27bd6c7SMarkus Armbruster #include "hw/qdev-properties.h" 17f1ae32a1SGerd Hoffmann #include "hw/usb.h" 18d6454270SMarkus Armbruster #include "migration/vmstate.h" 19463581a8SMichael S. Tsirkin #include "desc.h" 207566c6efSMarc-André Lureau #include "chardev/char-serial.h" 214d43a603SMarc-André Lureau #include "chardev/char-fe.h" 22f1ae32a1SGerd Hoffmann 23f1ae32a1SGerd Hoffmann //#define DEBUG_Serial 24f1ae32a1SGerd Hoffmann 25f1ae32a1SGerd Hoffmann #ifdef DEBUG_Serial 26f1ae32a1SGerd Hoffmann #define DPRINTF(fmt, ...) \ 27f1ae32a1SGerd Hoffmann do { printf("usb-serial: " fmt , ## __VA_ARGS__); } while (0) 28f1ae32a1SGerd Hoffmann #else 29f1ae32a1SGerd Hoffmann #define DPRINTF(fmt, ...) do {} while(0) 30f1ae32a1SGerd Hoffmann #endif 31f1ae32a1SGerd Hoffmann 32f1ae32a1SGerd Hoffmann #define RECV_BUF 384 33f1ae32a1SGerd Hoffmann 34f1ae32a1SGerd Hoffmann /* Commands */ 35f1ae32a1SGerd Hoffmann #define FTDI_RESET 0 36f1ae32a1SGerd Hoffmann #define FTDI_SET_MDM_CTRL 1 37f1ae32a1SGerd Hoffmann #define FTDI_SET_FLOW_CTRL 2 38f1ae32a1SGerd Hoffmann #define FTDI_SET_BAUD 3 39f1ae32a1SGerd Hoffmann #define FTDI_SET_DATA 4 40f1ae32a1SGerd Hoffmann #define FTDI_GET_MDM_ST 5 41f1ae32a1SGerd Hoffmann #define FTDI_SET_EVENT_CHR 6 42f1ae32a1SGerd Hoffmann #define FTDI_SET_ERROR_CHR 7 43f1ae32a1SGerd Hoffmann #define FTDI_SET_LATENCY 9 44f1ae32a1SGerd Hoffmann #define FTDI_GET_LATENCY 10 45f1ae32a1SGerd Hoffmann 46f1ae32a1SGerd Hoffmann #define DeviceOutVendor ((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8) 47f1ae32a1SGerd Hoffmann #define DeviceInVendor ((USB_DIR_IN |USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8) 48f1ae32a1SGerd Hoffmann 49f1ae32a1SGerd Hoffmann /* RESET */ 50f1ae32a1SGerd Hoffmann 51f1ae32a1SGerd Hoffmann #define FTDI_RESET_SIO 0 52f1ae32a1SGerd Hoffmann #define FTDI_RESET_RX 1 53f1ae32a1SGerd Hoffmann #define FTDI_RESET_TX 2 54f1ae32a1SGerd Hoffmann 55f1ae32a1SGerd Hoffmann /* SET_MDM_CTRL */ 56f1ae32a1SGerd Hoffmann 57f1ae32a1SGerd Hoffmann #define FTDI_DTR 1 58f1ae32a1SGerd Hoffmann #define FTDI_SET_DTR (FTDI_DTR << 8) 59f1ae32a1SGerd Hoffmann #define FTDI_RTS 2 60f1ae32a1SGerd Hoffmann #define FTDI_SET_RTS (FTDI_RTS << 8) 61f1ae32a1SGerd Hoffmann 62f1ae32a1SGerd Hoffmann /* SET_FLOW_CTRL */ 63f1ae32a1SGerd Hoffmann 64f1ae32a1SGerd Hoffmann #define FTDI_RTS_CTS_HS 1 65f1ae32a1SGerd Hoffmann #define FTDI_DTR_DSR_HS 2 66f1ae32a1SGerd Hoffmann #define FTDI_XON_XOFF_HS 4 67f1ae32a1SGerd Hoffmann 68f1ae32a1SGerd Hoffmann /* SET_DATA */ 69f1ae32a1SGerd Hoffmann 70f1ae32a1SGerd Hoffmann #define FTDI_PARITY (0x7 << 8) 71f1ae32a1SGerd Hoffmann #define FTDI_ODD (0x1 << 8) 72f1ae32a1SGerd Hoffmann #define FTDI_EVEN (0x2 << 8) 73f1ae32a1SGerd Hoffmann #define FTDI_MARK (0x3 << 8) 74f1ae32a1SGerd Hoffmann #define FTDI_SPACE (0x4 << 8) 75f1ae32a1SGerd Hoffmann 76f1ae32a1SGerd Hoffmann #define FTDI_STOP (0x3 << 11) 77f1ae32a1SGerd Hoffmann #define FTDI_STOP1 (0x0 << 11) 78f1ae32a1SGerd Hoffmann #define FTDI_STOP15 (0x1 << 11) 79f1ae32a1SGerd Hoffmann #define FTDI_STOP2 (0x2 << 11) 80f1ae32a1SGerd Hoffmann 81f1ae32a1SGerd Hoffmann /* GET_MDM_ST */ 82f1ae32a1SGerd Hoffmann /* TODO: should be sent every 40ms */ 83f1ae32a1SGerd Hoffmann #define FTDI_CTS (1<<4) // CTS line status 84f1ae32a1SGerd Hoffmann #define FTDI_DSR (1<<5) // DSR line status 85f1ae32a1SGerd Hoffmann #define FTDI_RI (1<<6) // RI line status 86f1ae32a1SGerd Hoffmann #define FTDI_RLSD (1<<7) // Receive Line Signal Detect 87f1ae32a1SGerd Hoffmann 88f1ae32a1SGerd Hoffmann /* Status */ 89f1ae32a1SGerd Hoffmann 90f1ae32a1SGerd Hoffmann #define FTDI_DR (1<<0) // Data Ready 91f1ae32a1SGerd Hoffmann #define FTDI_OE (1<<1) // Overrun Err 92f1ae32a1SGerd Hoffmann #define FTDI_PE (1<<2) // Parity Err 93f1ae32a1SGerd Hoffmann #define FTDI_FE (1<<3) // Framing Err 94f1ae32a1SGerd Hoffmann #define FTDI_BI (1<<4) // Break Interrupt 95f1ae32a1SGerd Hoffmann #define FTDI_THRE (1<<5) // Transmitter Holding Register 96f1ae32a1SGerd Hoffmann #define FTDI_TEMT (1<<6) // Transmitter Empty 97f1ae32a1SGerd Hoffmann #define FTDI_FIFO (1<<7) // Error in FIFO 98f1ae32a1SGerd Hoffmann 99f1ae32a1SGerd Hoffmann typedef struct { 100f1ae32a1SGerd Hoffmann USBDevice dev; 1015843b6b3SJason Andryuk USBEndpoint *intr; 102f1ae32a1SGerd Hoffmann uint8_t recv_buf[RECV_BUF]; 103f1ae32a1SGerd Hoffmann uint16_t recv_ptr; 104f1ae32a1SGerd Hoffmann uint16_t recv_used; 105f1ae32a1SGerd Hoffmann uint8_t event_chr; 106f1ae32a1SGerd Hoffmann uint8_t error_chr; 107f1ae32a1SGerd Hoffmann uint8_t event_trigger; 108f1ae32a1SGerd Hoffmann QEMUSerialSetParams params; 109f1ae32a1SGerd Hoffmann int latency; /* ms */ 110becdfa00SMarc-André Lureau CharBackend cs; 111f1ae32a1SGerd Hoffmann } USBSerialState; 112f1ae32a1SGerd Hoffmann 113cdf0d769SGonglei #define TYPE_USB_SERIAL "usb-serial-dev" 114cdf0d769SGonglei #define USB_SERIAL_DEV(obj) OBJECT_CHECK(USBSerialState, (obj), TYPE_USB_SERIAL) 115cdf0d769SGonglei 116f1ae32a1SGerd Hoffmann enum { 117f1ae32a1SGerd Hoffmann STR_MANUFACTURER = 1, 118f1ae32a1SGerd Hoffmann STR_PRODUCT_SERIAL, 119f1ae32a1SGerd Hoffmann STR_PRODUCT_BRAILLE, 120f1ae32a1SGerd Hoffmann STR_SERIALNUMBER, 121f1ae32a1SGerd Hoffmann }; 122f1ae32a1SGerd Hoffmann 123f1ae32a1SGerd Hoffmann static const USBDescStrings desc_strings = { 12493bfef4cSCrístian Viana [STR_MANUFACTURER] = "QEMU", 125f1ae32a1SGerd Hoffmann [STR_PRODUCT_SERIAL] = "QEMU USB SERIAL", 1262964cd9bSSamuel Thibault [STR_PRODUCT_BRAILLE] = "QEMU USB BAUM BRAILLE", 127f1ae32a1SGerd Hoffmann [STR_SERIALNUMBER] = "1", 128f1ae32a1SGerd Hoffmann }; 129f1ae32a1SGerd Hoffmann 130f1ae32a1SGerd Hoffmann static const USBDescIface desc_iface0 = { 131f1ae32a1SGerd Hoffmann .bInterfaceNumber = 0, 132f1ae32a1SGerd Hoffmann .bNumEndpoints = 2, 133f1ae32a1SGerd Hoffmann .bInterfaceClass = 0xff, 134f1ae32a1SGerd Hoffmann .bInterfaceSubClass = 0xff, 135f1ae32a1SGerd Hoffmann .bInterfaceProtocol = 0xff, 136f1ae32a1SGerd Hoffmann .eps = (USBDescEndpoint[]) { 137f1ae32a1SGerd Hoffmann { 138f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_IN | 0x01, 139f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_BULK, 140f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64, 141f1ae32a1SGerd Hoffmann },{ 142f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_OUT | 0x02, 143f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_BULK, 144f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64, 145f1ae32a1SGerd Hoffmann }, 146f1ae32a1SGerd Hoffmann } 147f1ae32a1SGerd Hoffmann }; 148f1ae32a1SGerd Hoffmann 149f1ae32a1SGerd Hoffmann static const USBDescDevice desc_device = { 150f1ae32a1SGerd Hoffmann .bcdUSB = 0x0200, 151f1ae32a1SGerd Hoffmann .bMaxPacketSize0 = 8, 152f1ae32a1SGerd Hoffmann .bNumConfigurations = 1, 153f1ae32a1SGerd Hoffmann .confs = (USBDescConfig[]) { 154f1ae32a1SGerd Hoffmann { 155f1ae32a1SGerd Hoffmann .bNumInterfaces = 1, 156f1ae32a1SGerd Hoffmann .bConfigurationValue = 1, 1575843b6b3SJason Andryuk .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_WAKEUP, 158f1ae32a1SGerd Hoffmann .bMaxPower = 50, 159f1ae32a1SGerd Hoffmann .nif = 1, 160f1ae32a1SGerd Hoffmann .ifs = &desc_iface0, 161f1ae32a1SGerd Hoffmann }, 162f1ae32a1SGerd Hoffmann }, 163f1ae32a1SGerd Hoffmann }; 164f1ae32a1SGerd Hoffmann 165f1ae32a1SGerd Hoffmann static const USBDesc desc_serial = { 166f1ae32a1SGerd Hoffmann .id = { 167f1ae32a1SGerd Hoffmann .idVendor = 0x0403, 168f1ae32a1SGerd Hoffmann .idProduct = 0x6001, 169f1ae32a1SGerd Hoffmann .bcdDevice = 0x0400, 170f1ae32a1SGerd Hoffmann .iManufacturer = STR_MANUFACTURER, 171f1ae32a1SGerd Hoffmann .iProduct = STR_PRODUCT_SERIAL, 172f1ae32a1SGerd Hoffmann .iSerialNumber = STR_SERIALNUMBER, 173f1ae32a1SGerd Hoffmann }, 174f1ae32a1SGerd Hoffmann .full = &desc_device, 175f1ae32a1SGerd Hoffmann .str = desc_strings, 176f1ae32a1SGerd Hoffmann }; 177f1ae32a1SGerd Hoffmann 178f1ae32a1SGerd Hoffmann static const USBDesc desc_braille = { 179f1ae32a1SGerd Hoffmann .id = { 180f1ae32a1SGerd Hoffmann .idVendor = 0x0403, 181f1ae32a1SGerd Hoffmann .idProduct = 0xfe72, 182f1ae32a1SGerd Hoffmann .bcdDevice = 0x0400, 183f1ae32a1SGerd Hoffmann .iManufacturer = STR_MANUFACTURER, 184f1ae32a1SGerd Hoffmann .iProduct = STR_PRODUCT_BRAILLE, 185f1ae32a1SGerd Hoffmann .iSerialNumber = STR_SERIALNUMBER, 186f1ae32a1SGerd Hoffmann }, 187f1ae32a1SGerd Hoffmann .full = &desc_device, 188f1ae32a1SGerd Hoffmann .str = desc_strings, 189f1ae32a1SGerd Hoffmann }; 190f1ae32a1SGerd Hoffmann 191f1ae32a1SGerd Hoffmann static void usb_serial_reset(USBSerialState *s) 192f1ae32a1SGerd Hoffmann { 193f1ae32a1SGerd Hoffmann /* TODO: Set flow control to none */ 194f1ae32a1SGerd Hoffmann s->event_chr = 0x0d; 195f1ae32a1SGerd Hoffmann s->event_trigger = 0; 196f1ae32a1SGerd Hoffmann s->recv_ptr = 0; 197f1ae32a1SGerd Hoffmann s->recv_used = 0; 198f1ae32a1SGerd Hoffmann /* TODO: purge in char driver */ 199f1ae32a1SGerd Hoffmann } 200f1ae32a1SGerd Hoffmann 201f1ae32a1SGerd Hoffmann static void usb_serial_handle_reset(USBDevice *dev) 202f1ae32a1SGerd Hoffmann { 203f1ae32a1SGerd Hoffmann USBSerialState *s = (USBSerialState *)dev; 204f1ae32a1SGerd Hoffmann 205f1ae32a1SGerd Hoffmann DPRINTF("Reset\n"); 206f1ae32a1SGerd Hoffmann 207f1ae32a1SGerd Hoffmann usb_serial_reset(s); 208f1ae32a1SGerd Hoffmann /* TODO: Reset char device, send BREAK? */ 209f1ae32a1SGerd Hoffmann } 210f1ae32a1SGerd Hoffmann 211f1ae32a1SGerd Hoffmann static uint8_t usb_get_modem_lines(USBSerialState *s) 212f1ae32a1SGerd Hoffmann { 213f1ae32a1SGerd Hoffmann int flags; 214f1ae32a1SGerd Hoffmann uint8_t ret; 215f1ae32a1SGerd Hoffmann 2165345fdb4SMarc-André Lureau if (qemu_chr_fe_ioctl(&s->cs, 217becdfa00SMarc-André Lureau CHR_IOCTL_SERIAL_GET_TIOCM, &flags) == -ENOTSUP) { 218f1ae32a1SGerd Hoffmann return FTDI_CTS|FTDI_DSR|FTDI_RLSD; 219becdfa00SMarc-André Lureau } 220f1ae32a1SGerd Hoffmann 221f1ae32a1SGerd Hoffmann ret = 0; 222f1ae32a1SGerd Hoffmann if (flags & CHR_TIOCM_CTS) 223f1ae32a1SGerd Hoffmann ret |= FTDI_CTS; 224f1ae32a1SGerd Hoffmann if (flags & CHR_TIOCM_DSR) 225f1ae32a1SGerd Hoffmann ret |= FTDI_DSR; 226f1ae32a1SGerd Hoffmann if (flags & CHR_TIOCM_RI) 227f1ae32a1SGerd Hoffmann ret |= FTDI_RI; 228f1ae32a1SGerd Hoffmann if (flags & CHR_TIOCM_CAR) 229f1ae32a1SGerd Hoffmann ret |= FTDI_RLSD; 230f1ae32a1SGerd Hoffmann 231f1ae32a1SGerd Hoffmann return ret; 232f1ae32a1SGerd Hoffmann } 233f1ae32a1SGerd Hoffmann 2349a77a0f5SHans de Goede static void usb_serial_handle_control(USBDevice *dev, USBPacket *p, 235f1ae32a1SGerd Hoffmann int request, int value, int index, int length, uint8_t *data) 236f1ae32a1SGerd Hoffmann { 237f1ae32a1SGerd Hoffmann USBSerialState *s = (USBSerialState *)dev; 238f1ae32a1SGerd Hoffmann int ret; 239f1ae32a1SGerd Hoffmann 240f1ae32a1SGerd Hoffmann DPRINTF("got control %x, value %x\n",request, value); 241f1ae32a1SGerd Hoffmann ret = usb_desc_handle_control(dev, p, request, value, index, length, data); 242f1ae32a1SGerd Hoffmann if (ret >= 0) { 2439a77a0f5SHans de Goede return; 244f1ae32a1SGerd Hoffmann } 245f1ae32a1SGerd Hoffmann 246f1ae32a1SGerd Hoffmann switch (request) { 247f1ae32a1SGerd Hoffmann case EndpointOutRequest | USB_REQ_CLEAR_FEATURE: 248f1ae32a1SGerd Hoffmann break; 249f1ae32a1SGerd Hoffmann 250f1ae32a1SGerd Hoffmann /* Class specific requests. */ 251f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_RESET: 252f1ae32a1SGerd Hoffmann switch (value) { 253f1ae32a1SGerd Hoffmann case FTDI_RESET_SIO: 254f1ae32a1SGerd Hoffmann usb_serial_reset(s); 255f1ae32a1SGerd Hoffmann break; 256f1ae32a1SGerd Hoffmann case FTDI_RESET_RX: 257f1ae32a1SGerd Hoffmann s->recv_ptr = 0; 258f1ae32a1SGerd Hoffmann s->recv_used = 0; 259f1ae32a1SGerd Hoffmann /* TODO: purge from char device */ 260f1ae32a1SGerd Hoffmann break; 261f1ae32a1SGerd Hoffmann case FTDI_RESET_TX: 262f1ae32a1SGerd Hoffmann /* TODO: purge from char device */ 263f1ae32a1SGerd Hoffmann break; 264f1ae32a1SGerd Hoffmann } 265f1ae32a1SGerd Hoffmann break; 266f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_MDM_CTRL: 267f1ae32a1SGerd Hoffmann { 268f1ae32a1SGerd Hoffmann static int flags; 2695345fdb4SMarc-André Lureau qemu_chr_fe_ioctl(&s->cs, CHR_IOCTL_SERIAL_GET_TIOCM, &flags); 270f1ae32a1SGerd Hoffmann if (value & FTDI_SET_RTS) { 271f1ae32a1SGerd Hoffmann if (value & FTDI_RTS) 272f1ae32a1SGerd Hoffmann flags |= CHR_TIOCM_RTS; 273f1ae32a1SGerd Hoffmann else 274f1ae32a1SGerd Hoffmann flags &= ~CHR_TIOCM_RTS; 275f1ae32a1SGerd Hoffmann } 276f1ae32a1SGerd Hoffmann if (value & FTDI_SET_DTR) { 277f1ae32a1SGerd Hoffmann if (value & FTDI_DTR) 278f1ae32a1SGerd Hoffmann flags |= CHR_TIOCM_DTR; 279f1ae32a1SGerd Hoffmann else 280f1ae32a1SGerd Hoffmann flags &= ~CHR_TIOCM_DTR; 281f1ae32a1SGerd Hoffmann } 2825345fdb4SMarc-André Lureau qemu_chr_fe_ioctl(&s->cs, CHR_IOCTL_SERIAL_SET_TIOCM, &flags); 283f1ae32a1SGerd Hoffmann break; 284f1ae32a1SGerd Hoffmann } 285f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_FLOW_CTRL: 286f1ae32a1SGerd Hoffmann /* TODO: ioctl */ 287f1ae32a1SGerd Hoffmann break; 288f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_BAUD: { 289f1ae32a1SGerd Hoffmann static const int subdivisors8[8] = { 0, 4, 2, 1, 3, 5, 6, 7 }; 290f1ae32a1SGerd Hoffmann int subdivisor8 = subdivisors8[((value & 0xc000) >> 14) 291f1ae32a1SGerd Hoffmann | ((index & 1) << 2)]; 292f1ae32a1SGerd Hoffmann int divisor = value & 0x3fff; 293f1ae32a1SGerd Hoffmann 294f1ae32a1SGerd Hoffmann /* chip special cases */ 295f1ae32a1SGerd Hoffmann if (divisor == 1 && subdivisor8 == 0) 296f1ae32a1SGerd Hoffmann subdivisor8 = 4; 297f1ae32a1SGerd Hoffmann if (divisor == 0 && subdivisor8 == 0) 298f1ae32a1SGerd Hoffmann divisor = 1; 299f1ae32a1SGerd Hoffmann 300f1ae32a1SGerd Hoffmann s->params.speed = (48000000 / 2) / (8 * divisor + subdivisor8); 3015345fdb4SMarc-André Lureau qemu_chr_fe_ioctl(&s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params); 302f1ae32a1SGerd Hoffmann break; 303f1ae32a1SGerd Hoffmann } 304f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_DATA: 305f1ae32a1SGerd Hoffmann switch (value & FTDI_PARITY) { 306f1ae32a1SGerd Hoffmann case 0: 307f1ae32a1SGerd Hoffmann s->params.parity = 'N'; 308f1ae32a1SGerd Hoffmann break; 309f1ae32a1SGerd Hoffmann case FTDI_ODD: 310f1ae32a1SGerd Hoffmann s->params.parity = 'O'; 311f1ae32a1SGerd Hoffmann break; 312f1ae32a1SGerd Hoffmann case FTDI_EVEN: 313f1ae32a1SGerd Hoffmann s->params.parity = 'E'; 314f1ae32a1SGerd Hoffmann break; 315f1ae32a1SGerd Hoffmann default: 316f1ae32a1SGerd Hoffmann DPRINTF("unsupported parity %d\n", value & FTDI_PARITY); 317f1ae32a1SGerd Hoffmann goto fail; 318f1ae32a1SGerd Hoffmann } 319f1ae32a1SGerd Hoffmann switch (value & FTDI_STOP) { 320f1ae32a1SGerd Hoffmann case FTDI_STOP1: 321f1ae32a1SGerd Hoffmann s->params.stop_bits = 1; 322f1ae32a1SGerd Hoffmann break; 323f1ae32a1SGerd Hoffmann case FTDI_STOP2: 324f1ae32a1SGerd Hoffmann s->params.stop_bits = 2; 325f1ae32a1SGerd Hoffmann break; 326f1ae32a1SGerd Hoffmann default: 327f1ae32a1SGerd Hoffmann DPRINTF("unsupported stop bits %d\n", value & FTDI_STOP); 328f1ae32a1SGerd Hoffmann goto fail; 329f1ae32a1SGerd Hoffmann } 3305345fdb4SMarc-André Lureau qemu_chr_fe_ioctl(&s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params); 331f1ae32a1SGerd Hoffmann /* TODO: TX ON/OFF */ 332f1ae32a1SGerd Hoffmann break; 333f1ae32a1SGerd Hoffmann case DeviceInVendor | FTDI_GET_MDM_ST: 334f1ae32a1SGerd Hoffmann data[0] = usb_get_modem_lines(s) | 1; 335f1ae32a1SGerd Hoffmann data[1] = 0; 3369a77a0f5SHans de Goede p->actual_length = 2; 337f1ae32a1SGerd Hoffmann break; 338f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_EVENT_CHR: 339f1ae32a1SGerd Hoffmann /* TODO: handle it */ 340f1ae32a1SGerd Hoffmann s->event_chr = value; 341f1ae32a1SGerd Hoffmann break; 342f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_ERROR_CHR: 343f1ae32a1SGerd Hoffmann /* TODO: handle it */ 344f1ae32a1SGerd Hoffmann s->error_chr = value; 345f1ae32a1SGerd Hoffmann break; 346f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_LATENCY: 347f1ae32a1SGerd Hoffmann s->latency = value; 348f1ae32a1SGerd Hoffmann break; 349f1ae32a1SGerd Hoffmann case DeviceInVendor | FTDI_GET_LATENCY: 350f1ae32a1SGerd Hoffmann data[0] = s->latency; 3519a77a0f5SHans de Goede p->actual_length = 1; 352f1ae32a1SGerd Hoffmann break; 353f1ae32a1SGerd Hoffmann default: 354f1ae32a1SGerd Hoffmann fail: 355f1ae32a1SGerd Hoffmann DPRINTF("got unsupported/bogus control %x, value %x\n", request, value); 3569a77a0f5SHans de Goede p->status = USB_RET_STALL; 357f1ae32a1SGerd Hoffmann break; 358f1ae32a1SGerd Hoffmann } 359f1ae32a1SGerd Hoffmann } 360f1ae32a1SGerd Hoffmann 3612bcf4e9fSJason Andryuk static void usb_serial_token_in(USBSerialState *s, USBPacket *p) 3622bcf4e9fSJason Andryuk { 363*87db78f7SJason Andryuk const int max_packet_size = desc_iface0.eps[0].wMaxPacketSize; 364*87db78f7SJason Andryuk int packet_len; 3652bcf4e9fSJason Andryuk uint8_t header[2]; 3662bcf4e9fSJason Andryuk 367*87db78f7SJason Andryuk packet_len = p->iov.size; 368*87db78f7SJason Andryuk if (packet_len <= 2) { 3692bcf4e9fSJason Andryuk p->status = USB_RET_NAK; 3702bcf4e9fSJason Andryuk return; 3712bcf4e9fSJason Andryuk } 372*87db78f7SJason Andryuk 3732bcf4e9fSJason Andryuk header[0] = usb_get_modem_lines(s) | 1; 3742bcf4e9fSJason Andryuk /* We do not have the uart details */ 3752bcf4e9fSJason Andryuk /* handle serial break */ 3762bcf4e9fSJason Andryuk if (s->event_trigger && s->event_trigger & FTDI_BI) { 3772bcf4e9fSJason Andryuk s->event_trigger &= ~FTDI_BI; 3782bcf4e9fSJason Andryuk header[1] = FTDI_BI; 3792bcf4e9fSJason Andryuk usb_packet_copy(p, header, 2); 3802bcf4e9fSJason Andryuk return; 3812bcf4e9fSJason Andryuk } else { 3822bcf4e9fSJason Andryuk header[1] = 0; 3832bcf4e9fSJason Andryuk } 384*87db78f7SJason Andryuk 385*87db78f7SJason Andryuk if (!s->recv_used) { 386*87db78f7SJason Andryuk p->status = USB_RET_NAK; 387*87db78f7SJason Andryuk return; 388*87db78f7SJason Andryuk } 389*87db78f7SJason Andryuk 390*87db78f7SJason Andryuk while (s->recv_used && packet_len > 2) { 391*87db78f7SJason Andryuk int first_len, len; 392*87db78f7SJason Andryuk 393*87db78f7SJason Andryuk len = MIN(packet_len, max_packet_size); 3942bcf4e9fSJason Andryuk len -= 2; 3952bcf4e9fSJason Andryuk if (len > s->recv_used) { 3962bcf4e9fSJason Andryuk len = s->recv_used; 3972bcf4e9fSJason Andryuk } 398*87db78f7SJason Andryuk 399*87db78f7SJason Andryuk first_len = RECV_BUF - s->recv_ptr; 4002bcf4e9fSJason Andryuk if (first_len > len) { 4012bcf4e9fSJason Andryuk first_len = len; 4022bcf4e9fSJason Andryuk } 4032bcf4e9fSJason Andryuk usb_packet_copy(p, header, 2); 4042bcf4e9fSJason Andryuk usb_packet_copy(p, s->recv_buf + s->recv_ptr, first_len); 4052bcf4e9fSJason Andryuk if (len > first_len) { 4062bcf4e9fSJason Andryuk usb_packet_copy(p, s->recv_buf, len - first_len); 4072bcf4e9fSJason Andryuk } 4082bcf4e9fSJason Andryuk s->recv_used -= len; 4092bcf4e9fSJason Andryuk s->recv_ptr = (s->recv_ptr + len) % RECV_BUF; 410*87db78f7SJason Andryuk packet_len -= len + 2; 411*87db78f7SJason Andryuk } 4122bcf4e9fSJason Andryuk 4132bcf4e9fSJason Andryuk return; 4142bcf4e9fSJason Andryuk } 4152bcf4e9fSJason Andryuk 4169a77a0f5SHans de Goede static void usb_serial_handle_data(USBDevice *dev, USBPacket *p) 417f1ae32a1SGerd Hoffmann { 418f1ae32a1SGerd Hoffmann USBSerialState *s = (USBSerialState *)dev; 419f1ae32a1SGerd Hoffmann uint8_t devep = p->ep->nr; 420f1ae32a1SGerd Hoffmann struct iovec *iov; 4212bcf4e9fSJason Andryuk int i; 422f1ae32a1SGerd Hoffmann 423f1ae32a1SGerd Hoffmann switch (p->pid) { 424f1ae32a1SGerd Hoffmann case USB_TOKEN_OUT: 425f1ae32a1SGerd Hoffmann if (devep != 2) 426f1ae32a1SGerd Hoffmann goto fail; 427f1ae32a1SGerd Hoffmann for (i = 0; i < p->iov.niov; i++) { 428f1ae32a1SGerd Hoffmann iov = p->iov.iov + i; 4296ab3fc32SDaniel P. Berrange /* XXX this blocks entire thread. Rewrite to use 4306ab3fc32SDaniel P. Berrange * qemu_chr_fe_write and background I/O callbacks */ 4315345fdb4SMarc-André Lureau qemu_chr_fe_write_all(&s->cs, iov->iov_base, iov->iov_len); 432f1ae32a1SGerd Hoffmann } 4339a77a0f5SHans de Goede p->actual_length = p->iov.size; 434f1ae32a1SGerd Hoffmann break; 435f1ae32a1SGerd Hoffmann 436f1ae32a1SGerd Hoffmann case USB_TOKEN_IN: 437f1ae32a1SGerd Hoffmann if (devep != 1) 438f1ae32a1SGerd Hoffmann goto fail; 4392bcf4e9fSJason Andryuk usb_serial_token_in(s, p); 440f1ae32a1SGerd Hoffmann break; 441f1ae32a1SGerd Hoffmann 442f1ae32a1SGerd Hoffmann default: 443f1ae32a1SGerd Hoffmann DPRINTF("Bad token\n"); 444f1ae32a1SGerd Hoffmann fail: 4459a77a0f5SHans de Goede p->status = USB_RET_STALL; 446f1ae32a1SGerd Hoffmann break; 447f1ae32a1SGerd Hoffmann } 448f1ae32a1SGerd Hoffmann } 449f1ae32a1SGerd Hoffmann 450f1ae32a1SGerd Hoffmann static int usb_serial_can_read(void *opaque) 451f1ae32a1SGerd Hoffmann { 452f1ae32a1SGerd Hoffmann USBSerialState *s = opaque; 453da124e62SGerd Hoffmann 454da124e62SGerd Hoffmann if (!s->dev.attached) { 455da124e62SGerd Hoffmann return 0; 456da124e62SGerd Hoffmann } 457f1ae32a1SGerd Hoffmann return RECV_BUF - s->recv_used; 458f1ae32a1SGerd Hoffmann } 459f1ae32a1SGerd Hoffmann 460f1ae32a1SGerd Hoffmann static void usb_serial_read(void *opaque, const uint8_t *buf, int size) 461f1ae32a1SGerd Hoffmann { 462f1ae32a1SGerd Hoffmann USBSerialState *s = opaque; 463f1ae32a1SGerd Hoffmann int first_size, start; 464f1ae32a1SGerd Hoffmann 465f1ae32a1SGerd Hoffmann /* room in the buffer? */ 466f1ae32a1SGerd Hoffmann if (size > (RECV_BUF - s->recv_used)) 467f1ae32a1SGerd Hoffmann size = RECV_BUF - s->recv_used; 468f1ae32a1SGerd Hoffmann 469f1ae32a1SGerd Hoffmann start = s->recv_ptr + s->recv_used; 470f1ae32a1SGerd Hoffmann if (start < RECV_BUF) { 471f1ae32a1SGerd Hoffmann /* copy data to end of buffer */ 472f1ae32a1SGerd Hoffmann first_size = RECV_BUF - start; 473f1ae32a1SGerd Hoffmann if (first_size > size) 474f1ae32a1SGerd Hoffmann first_size = size; 475f1ae32a1SGerd Hoffmann 476f1ae32a1SGerd Hoffmann memcpy(s->recv_buf + start, buf, first_size); 477f1ae32a1SGerd Hoffmann 478f1ae32a1SGerd Hoffmann /* wrap around to front if needed */ 479f1ae32a1SGerd Hoffmann if (size > first_size) 480f1ae32a1SGerd Hoffmann memcpy(s->recv_buf, buf + first_size, size - first_size); 481f1ae32a1SGerd Hoffmann } else { 482f1ae32a1SGerd Hoffmann start -= RECV_BUF; 483f1ae32a1SGerd Hoffmann memcpy(s->recv_buf + start, buf, size); 484f1ae32a1SGerd Hoffmann } 485f1ae32a1SGerd Hoffmann s->recv_used += size; 4865843b6b3SJason Andryuk 4875843b6b3SJason Andryuk usb_wakeup(s->intr, 0); 488f1ae32a1SGerd Hoffmann } 489f1ae32a1SGerd Hoffmann 490083b266fSPhilippe Mathieu-Daudé static void usb_serial_event(void *opaque, QEMUChrEvent event) 491f1ae32a1SGerd Hoffmann { 492f1ae32a1SGerd Hoffmann USBSerialState *s = opaque; 493f1ae32a1SGerd Hoffmann 494f1ae32a1SGerd Hoffmann switch (event) { 495f1ae32a1SGerd Hoffmann case CHR_EVENT_BREAK: 496f1ae32a1SGerd Hoffmann s->event_trigger |= FTDI_BI; 497f1ae32a1SGerd Hoffmann break; 498f1ae32a1SGerd Hoffmann case CHR_EVENT_OPENED: 499da124e62SGerd Hoffmann if (!s->dev.attached) { 5007334d650SGonglei usb_device_attach(&s->dev, &error_abort); 501da124e62SGerd Hoffmann } 502da124e62SGerd Hoffmann break; 503da124e62SGerd Hoffmann case CHR_EVENT_CLOSED: 504da124e62SGerd Hoffmann if (s->dev.attached) { 505da124e62SGerd Hoffmann usb_device_detach(&s->dev); 506da124e62SGerd Hoffmann } 507f1ae32a1SGerd Hoffmann break; 508c263158eSPhilippe Mathieu-Daudé case CHR_EVENT_MUX_IN: 509c263158eSPhilippe Mathieu-Daudé case CHR_EVENT_MUX_OUT: 510c263158eSPhilippe Mathieu-Daudé /* Ignore */ 511c263158eSPhilippe Mathieu-Daudé break; 512f1ae32a1SGerd Hoffmann } 513f1ae32a1SGerd Hoffmann } 514f1ae32a1SGerd Hoffmann 51538fff2c9SGonglei static void usb_serial_realize(USBDevice *dev, Error **errp) 516f1ae32a1SGerd Hoffmann { 517cdf0d769SGonglei USBSerialState *s = USB_SERIAL_DEV(dev); 5187334d650SGonglei Error *local_err = NULL; 519f1ae32a1SGerd Hoffmann 5209d55d1adSGerd Hoffmann usb_desc_create_serial(dev); 521f1ae32a1SGerd Hoffmann usb_desc_init(dev); 522da124e62SGerd Hoffmann dev->auto_attach = 0; 523f1ae32a1SGerd Hoffmann 52430650701SAnton Nefedov if (!qemu_chr_fe_backend_connected(&s->cs)) { 52538fff2c9SGonglei error_setg(errp, "Property chardev is required"); 52638fff2c9SGonglei return; 527f1ae32a1SGerd Hoffmann } 528f1ae32a1SGerd Hoffmann 5297334d650SGonglei usb_check_attach(dev, &local_err); 5307334d650SGonglei if (local_err) { 5317334d650SGonglei error_propagate(errp, local_err); 5327334d650SGonglei return; 5337334d650SGonglei } 5347334d650SGonglei 5355345fdb4SMarc-André Lureau qemu_chr_fe_set_handlers(&s->cs, usb_serial_can_read, usb_serial_read, 53681517ba3SAnton Nefedov usb_serial_event, NULL, s, NULL, true); 537f1ae32a1SGerd Hoffmann usb_serial_handle_reset(dev); 538da124e62SGerd Hoffmann 53930650701SAnton Nefedov if (qemu_chr_fe_backend_open(&s->cs) && !dev->attached) { 5407334d650SGonglei usb_device_attach(dev, &error_abort); 5417d553f27SGonglei } 5425843b6b3SJason Andryuk s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1); 543da124e62SGerd Hoffmann } 544f1ae32a1SGerd Hoffmann 545f1ae32a1SGerd Hoffmann static USBDevice *usb_braille_init(USBBus *bus, const char *unused) 546f1ae32a1SGerd Hoffmann { 547f1ae32a1SGerd Hoffmann USBDevice *dev; 5480ec7b3e7SMarc-André Lureau Chardev *cdrv; 549f1ae32a1SGerd Hoffmann 5504ad6f6cbSPaolo Bonzini cdrv = qemu_chr_new("braille", "braille", NULL); 551f1ae32a1SGerd Hoffmann if (!cdrv) 552f1ae32a1SGerd Hoffmann return NULL; 553f1ae32a1SGerd Hoffmann 554f1ae32a1SGerd Hoffmann dev = usb_create(bus, "usb-braille"); 555f1ae32a1SGerd Hoffmann qdev_prop_set_chr(&dev->qdev, "chardev", cdrv); 556f1ae32a1SGerd Hoffmann return dev; 557f1ae32a1SGerd Hoffmann } 558f1ae32a1SGerd Hoffmann 559f1ae32a1SGerd Hoffmann static const VMStateDescription vmstate_usb_serial = { 560f1ae32a1SGerd Hoffmann .name = "usb-serial", 561f1ae32a1SGerd Hoffmann .unmigratable = 1, 562f1ae32a1SGerd Hoffmann }; 563f1ae32a1SGerd Hoffmann 564f1ae32a1SGerd Hoffmann static Property serial_properties[] = { 565f1ae32a1SGerd Hoffmann DEFINE_PROP_CHR("chardev", USBSerialState, cs), 566f1ae32a1SGerd Hoffmann DEFINE_PROP_END_OF_LIST(), 567f1ae32a1SGerd Hoffmann }; 568f1ae32a1SGerd Hoffmann 569cdf0d769SGonglei static void usb_serial_dev_class_init(ObjectClass *klass, void *data) 570f1ae32a1SGerd Hoffmann { 571f1ae32a1SGerd Hoffmann DeviceClass *dc = DEVICE_CLASS(klass); 572f1ae32a1SGerd Hoffmann USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 573f1ae32a1SGerd Hoffmann 57438fff2c9SGonglei uc->realize = usb_serial_realize; 575f1ae32a1SGerd Hoffmann uc->handle_reset = usb_serial_handle_reset; 576f1ae32a1SGerd Hoffmann uc->handle_control = usb_serial_handle_control; 577f1ae32a1SGerd Hoffmann uc->handle_data = usb_serial_handle_data; 578f1ae32a1SGerd Hoffmann dc->vmsd = &vmstate_usb_serial; 579125ee0edSMarcel Apfelbaum set_bit(DEVICE_CATEGORY_INPUT, dc->categories); 580f1ae32a1SGerd Hoffmann } 581f1ae32a1SGerd Hoffmann 582cdf0d769SGonglei static const TypeInfo usb_serial_dev_type_info = { 583cdf0d769SGonglei .name = TYPE_USB_SERIAL, 584cdf0d769SGonglei .parent = TYPE_USB_DEVICE, 585cdf0d769SGonglei .instance_size = sizeof(USBSerialState), 586cdf0d769SGonglei .abstract = true, 587cdf0d769SGonglei .class_init = usb_serial_dev_class_init, 588cdf0d769SGonglei }; 589cdf0d769SGonglei 590cdf0d769SGonglei static void usb_serial_class_initfn(ObjectClass *klass, void *data) 591cdf0d769SGonglei { 592cdf0d769SGonglei DeviceClass *dc = DEVICE_CLASS(klass); 593cdf0d769SGonglei USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 594cdf0d769SGonglei 595cdf0d769SGonglei uc->product_desc = "QEMU USB Serial"; 596cdf0d769SGonglei uc->usb_desc = &desc_serial; 5974f67d30bSMarc-André Lureau device_class_set_props(dc, serial_properties); 598cdf0d769SGonglei } 599cdf0d769SGonglei 6008c43a6f0SAndreas Färber static const TypeInfo serial_info = { 601f1ae32a1SGerd Hoffmann .name = "usb-serial", 602cdf0d769SGonglei .parent = TYPE_USB_SERIAL, 603f1ae32a1SGerd Hoffmann .class_init = usb_serial_class_initfn, 604f1ae32a1SGerd Hoffmann }; 605f1ae32a1SGerd Hoffmann 606f1ae32a1SGerd Hoffmann static Property braille_properties[] = { 607f1ae32a1SGerd Hoffmann DEFINE_PROP_CHR("chardev", USBSerialState, cs), 608f1ae32a1SGerd Hoffmann DEFINE_PROP_END_OF_LIST(), 609f1ae32a1SGerd Hoffmann }; 610f1ae32a1SGerd Hoffmann 611f1ae32a1SGerd Hoffmann static void usb_braille_class_initfn(ObjectClass *klass, void *data) 612f1ae32a1SGerd Hoffmann { 613f1ae32a1SGerd Hoffmann DeviceClass *dc = DEVICE_CLASS(klass); 614f1ae32a1SGerd Hoffmann USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 615f1ae32a1SGerd Hoffmann 616f1ae32a1SGerd Hoffmann uc->product_desc = "QEMU USB Braille"; 617f1ae32a1SGerd Hoffmann uc->usb_desc = &desc_braille; 6184f67d30bSMarc-André Lureau device_class_set_props(dc, braille_properties); 619f1ae32a1SGerd Hoffmann } 620f1ae32a1SGerd Hoffmann 6218c43a6f0SAndreas Färber static const TypeInfo braille_info = { 622f1ae32a1SGerd Hoffmann .name = "usb-braille", 623cdf0d769SGonglei .parent = TYPE_USB_SERIAL, 624f1ae32a1SGerd Hoffmann .class_init = usb_braille_class_initfn, 625f1ae32a1SGerd Hoffmann }; 626f1ae32a1SGerd Hoffmann 627f1ae32a1SGerd Hoffmann static void usb_serial_register_types(void) 628f1ae32a1SGerd Hoffmann { 629cdf0d769SGonglei type_register_static(&usb_serial_dev_type_info); 630f1ae32a1SGerd Hoffmann type_register_static(&serial_info); 631f1ae32a1SGerd Hoffmann type_register_static(&braille_info); 632f1ae32a1SGerd Hoffmann usb_legacy_register("usb-braille", "braille", usb_braille_init); 633f1ae32a1SGerd Hoffmann } 634f1ae32a1SGerd Hoffmann 635f1ae32a1SGerd Hoffmann type_init(usb_serial_register_types) 636