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" 22db1015e9SEduardo Habkost #include "qom/object.h" 23f1ae32a1SGerd Hoffmann 24f1ae32a1SGerd Hoffmann //#define DEBUG_Serial 25f1ae32a1SGerd Hoffmann 26f1ae32a1SGerd Hoffmann #ifdef DEBUG_Serial 27f1ae32a1SGerd Hoffmann #define DPRINTF(fmt, ...) \ 28f1ae32a1SGerd Hoffmann do { printf("usb-serial: " fmt , ## __VA_ARGS__); } while (0) 29f1ae32a1SGerd Hoffmann #else 30f1ae32a1SGerd Hoffmann #define DPRINTF(fmt, ...) do {} while(0) 31f1ae32a1SGerd Hoffmann #endif 32f1ae32a1SGerd Hoffmann 3330ad5fddSJason Andryuk #define RECV_BUF (512 - (2 * 8)) 34f1ae32a1SGerd Hoffmann 35f1ae32a1SGerd Hoffmann /* Commands */ 36f1ae32a1SGerd Hoffmann #define FTDI_RESET 0 37f1ae32a1SGerd Hoffmann #define FTDI_SET_MDM_CTRL 1 38f1ae32a1SGerd Hoffmann #define FTDI_SET_FLOW_CTRL 2 39f1ae32a1SGerd Hoffmann #define FTDI_SET_BAUD 3 40f1ae32a1SGerd Hoffmann #define FTDI_SET_DATA 4 41f1ae32a1SGerd Hoffmann #define FTDI_GET_MDM_ST 5 42f1ae32a1SGerd Hoffmann #define FTDI_SET_EVENT_CHR 6 43f1ae32a1SGerd Hoffmann #define FTDI_SET_ERROR_CHR 7 44f1ae32a1SGerd Hoffmann #define FTDI_SET_LATENCY 9 45f1ae32a1SGerd Hoffmann #define FTDI_GET_LATENCY 10 46f1ae32a1SGerd Hoffmann 47adab8d48SMark Cave-Ayland #define DeviceOutVendor \ 48adab8d48SMark Cave-Ayland ((USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE) << 8) 49adab8d48SMark Cave-Ayland #define DeviceInVendor \ 50adab8d48SMark Cave-Ayland ((USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE) << 8) 51f1ae32a1SGerd Hoffmann 52f1ae32a1SGerd Hoffmann /* RESET */ 53f1ae32a1SGerd Hoffmann 54f1ae32a1SGerd Hoffmann #define FTDI_RESET_SIO 0 55f1ae32a1SGerd Hoffmann #define FTDI_RESET_RX 1 56f1ae32a1SGerd Hoffmann #define FTDI_RESET_TX 2 57f1ae32a1SGerd Hoffmann 58f1ae32a1SGerd Hoffmann /* SET_MDM_CTRL */ 59f1ae32a1SGerd Hoffmann 60f1ae32a1SGerd Hoffmann #define FTDI_DTR 1 61f1ae32a1SGerd Hoffmann #define FTDI_SET_DTR (FTDI_DTR << 8) 62f1ae32a1SGerd Hoffmann #define FTDI_RTS 2 63f1ae32a1SGerd Hoffmann #define FTDI_SET_RTS (FTDI_RTS << 8) 64f1ae32a1SGerd Hoffmann 65f1ae32a1SGerd Hoffmann /* SET_FLOW_CTRL */ 66f1ae32a1SGerd Hoffmann 67f1ae32a1SGerd Hoffmann #define FTDI_RTS_CTS_HS 1 68f1ae32a1SGerd Hoffmann #define FTDI_DTR_DSR_HS 2 69f1ae32a1SGerd Hoffmann #define FTDI_XON_XOFF_HS 4 70f1ae32a1SGerd Hoffmann 71f1ae32a1SGerd Hoffmann /* SET_DATA */ 72f1ae32a1SGerd Hoffmann 73f1ae32a1SGerd Hoffmann #define FTDI_PARITY (0x7 << 8) 74f1ae32a1SGerd Hoffmann #define FTDI_ODD (0x1 << 8) 75f1ae32a1SGerd Hoffmann #define FTDI_EVEN (0x2 << 8) 76f1ae32a1SGerd Hoffmann #define FTDI_MARK (0x3 << 8) 77f1ae32a1SGerd Hoffmann #define FTDI_SPACE (0x4 << 8) 78f1ae32a1SGerd Hoffmann 79f1ae32a1SGerd Hoffmann #define FTDI_STOP (0x3 << 11) 80f1ae32a1SGerd Hoffmann #define FTDI_STOP1 (0x0 << 11) 81f1ae32a1SGerd Hoffmann #define FTDI_STOP15 (0x1 << 11) 82f1ae32a1SGerd Hoffmann #define FTDI_STOP2 (0x2 << 11) 83f1ae32a1SGerd Hoffmann 84f1ae32a1SGerd Hoffmann /* GET_MDM_ST */ 85f1ae32a1SGerd Hoffmann /* TODO: should be sent every 40ms */ 86adab8d48SMark Cave-Ayland #define FTDI_CTS (1 << 4) /* CTS line status */ 87adab8d48SMark Cave-Ayland #define FTDI_DSR (1 << 5) /* DSR line status */ 88adab8d48SMark Cave-Ayland #define FTDI_RI (1 << 6) /* RI line status */ 89adab8d48SMark Cave-Ayland #define FTDI_RLSD (1 << 7) /* Receive Line Signal Detect */ 90f1ae32a1SGerd Hoffmann 91f1ae32a1SGerd Hoffmann /* Status */ 92f1ae32a1SGerd Hoffmann 93adab8d48SMark Cave-Ayland #define FTDI_DR (1 << 0) /* Data Ready */ 94adab8d48SMark Cave-Ayland #define FTDI_OE (1 << 1) /* Overrun Err */ 95adab8d48SMark Cave-Ayland #define FTDI_PE (1 << 2) /* Parity Err */ 96adab8d48SMark Cave-Ayland #define FTDI_FE (1 << 3) /* Framing Err */ 97adab8d48SMark Cave-Ayland #define FTDI_BI (1 << 4) /* Break Interrupt */ 98adab8d48SMark Cave-Ayland #define FTDI_THRE (1 << 5) /* Transmitter Holding Register */ 99adab8d48SMark Cave-Ayland #define FTDI_TEMT (1 << 6) /* Transmitter Empty */ 100adab8d48SMark Cave-Ayland #define FTDI_FIFO (1 << 7) /* Error in FIFO */ 101f1ae32a1SGerd Hoffmann 102db1015e9SEduardo Habkost struct USBSerialState { 103f1ae32a1SGerd Hoffmann USBDevice dev; 104adab8d48SMark Cave-Ayland 1055843b6b3SJason Andryuk USBEndpoint *intr; 106f1ae32a1SGerd Hoffmann uint8_t recv_buf[RECV_BUF]; 107f1ae32a1SGerd Hoffmann uint16_t recv_ptr; 108f1ae32a1SGerd Hoffmann uint16_t recv_used; 109f1ae32a1SGerd Hoffmann uint8_t event_chr; 110f1ae32a1SGerd Hoffmann uint8_t error_chr; 111f1ae32a1SGerd Hoffmann uint8_t event_trigger; 112f1ae32a1SGerd Hoffmann QEMUSerialSetParams params; 113f1ae32a1SGerd Hoffmann int latency; /* ms */ 114becdfa00SMarc-André Lureau CharBackend cs; 115db1015e9SEduardo Habkost }; 116f1ae32a1SGerd Hoffmann 117cdf0d769SGonglei #define TYPE_USB_SERIAL "usb-serial-dev" 1188063396bSEduardo Habkost OBJECT_DECLARE_SIMPLE_TYPE(USBSerialState, USB_SERIAL) 119cdf0d769SGonglei 120f1ae32a1SGerd Hoffmann enum { 121f1ae32a1SGerd Hoffmann STR_MANUFACTURER = 1, 122f1ae32a1SGerd Hoffmann STR_PRODUCT_SERIAL, 123f1ae32a1SGerd Hoffmann STR_PRODUCT_BRAILLE, 124f1ae32a1SGerd Hoffmann STR_SERIALNUMBER, 125f1ae32a1SGerd Hoffmann }; 126f1ae32a1SGerd Hoffmann 127f1ae32a1SGerd Hoffmann static const USBDescStrings desc_strings = { 12893bfef4cSCrístian Viana [STR_MANUFACTURER] = "QEMU", 129f1ae32a1SGerd Hoffmann [STR_PRODUCT_SERIAL] = "QEMU USB SERIAL", 1302964cd9bSSamuel Thibault [STR_PRODUCT_BRAILLE] = "QEMU USB BAUM BRAILLE", 131f1ae32a1SGerd Hoffmann [STR_SERIALNUMBER] = "1", 132f1ae32a1SGerd Hoffmann }; 133f1ae32a1SGerd Hoffmann 134f1ae32a1SGerd Hoffmann static const USBDescIface desc_iface0 = { 135f1ae32a1SGerd Hoffmann .bInterfaceNumber = 0, 136f1ae32a1SGerd Hoffmann .bNumEndpoints = 2, 137f1ae32a1SGerd Hoffmann .bInterfaceClass = 0xff, 138f1ae32a1SGerd Hoffmann .bInterfaceSubClass = 0xff, 139f1ae32a1SGerd Hoffmann .bInterfaceProtocol = 0xff, 140f1ae32a1SGerd Hoffmann .eps = (USBDescEndpoint[]) { 141f1ae32a1SGerd Hoffmann { 142f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_IN | 0x01, 143f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_BULK, 144f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64, 145f1ae32a1SGerd Hoffmann },{ 146f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_OUT | 0x02, 147f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_BULK, 148f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64, 149f1ae32a1SGerd Hoffmann }, 150f1ae32a1SGerd Hoffmann } 151f1ae32a1SGerd Hoffmann }; 152f1ae32a1SGerd Hoffmann 153f1ae32a1SGerd Hoffmann static const USBDescDevice desc_device = { 154f1ae32a1SGerd Hoffmann .bcdUSB = 0x0200, 155f1ae32a1SGerd Hoffmann .bMaxPacketSize0 = 8, 156f1ae32a1SGerd Hoffmann .bNumConfigurations = 1, 157f1ae32a1SGerd Hoffmann .confs = (USBDescConfig[]) { 158f1ae32a1SGerd Hoffmann { 159f1ae32a1SGerd Hoffmann .bNumInterfaces = 1, 160f1ae32a1SGerd Hoffmann .bConfigurationValue = 1, 1615843b6b3SJason Andryuk .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_WAKEUP, 162f1ae32a1SGerd Hoffmann .bMaxPower = 50, 163f1ae32a1SGerd Hoffmann .nif = 1, 164f1ae32a1SGerd Hoffmann .ifs = &desc_iface0, 165f1ae32a1SGerd Hoffmann }, 166f1ae32a1SGerd Hoffmann }, 167f1ae32a1SGerd Hoffmann }; 168f1ae32a1SGerd Hoffmann 169f1ae32a1SGerd Hoffmann static const USBDesc desc_serial = { 170f1ae32a1SGerd Hoffmann .id = { 171f1ae32a1SGerd Hoffmann .idVendor = 0x0403, 172f1ae32a1SGerd Hoffmann .idProduct = 0x6001, 173f1ae32a1SGerd Hoffmann .bcdDevice = 0x0400, 174f1ae32a1SGerd Hoffmann .iManufacturer = STR_MANUFACTURER, 175f1ae32a1SGerd Hoffmann .iProduct = STR_PRODUCT_SERIAL, 176f1ae32a1SGerd Hoffmann .iSerialNumber = STR_SERIALNUMBER, 177f1ae32a1SGerd Hoffmann }, 178f1ae32a1SGerd Hoffmann .full = &desc_device, 179f1ae32a1SGerd Hoffmann .str = desc_strings, 180f1ae32a1SGerd Hoffmann }; 181f1ae32a1SGerd Hoffmann 182f1ae32a1SGerd Hoffmann static const USBDesc desc_braille = { 183f1ae32a1SGerd Hoffmann .id = { 184f1ae32a1SGerd Hoffmann .idVendor = 0x0403, 185f1ae32a1SGerd Hoffmann .idProduct = 0xfe72, 186f1ae32a1SGerd Hoffmann .bcdDevice = 0x0400, 187f1ae32a1SGerd Hoffmann .iManufacturer = STR_MANUFACTURER, 188f1ae32a1SGerd Hoffmann .iProduct = STR_PRODUCT_BRAILLE, 189f1ae32a1SGerd Hoffmann .iSerialNumber = STR_SERIALNUMBER, 190f1ae32a1SGerd Hoffmann }, 191f1ae32a1SGerd Hoffmann .full = &desc_device, 192f1ae32a1SGerd Hoffmann .str = desc_strings, 193f1ae32a1SGerd Hoffmann }; 194f1ae32a1SGerd Hoffmann 195f1ae32a1SGerd Hoffmann static void usb_serial_reset(USBSerialState *s) 196f1ae32a1SGerd Hoffmann { 197f1ae32a1SGerd Hoffmann /* TODO: Set flow control to none */ 198f1ae32a1SGerd Hoffmann s->event_chr = 0x0d; 199f1ae32a1SGerd Hoffmann s->event_trigger = 0; 200f1ae32a1SGerd Hoffmann s->recv_ptr = 0; 201f1ae32a1SGerd Hoffmann s->recv_used = 0; 202f1ae32a1SGerd Hoffmann /* TODO: purge in char driver */ 203f1ae32a1SGerd Hoffmann } 204f1ae32a1SGerd Hoffmann 205f1ae32a1SGerd Hoffmann static void usb_serial_handle_reset(USBDevice *dev) 206f1ae32a1SGerd Hoffmann { 207*8a0e4ee7SMark Cave-Ayland USBSerialState *s = USB_SERIAL(dev); 208f1ae32a1SGerd Hoffmann 209f1ae32a1SGerd Hoffmann DPRINTF("Reset\n"); 210f1ae32a1SGerd Hoffmann 211f1ae32a1SGerd Hoffmann usb_serial_reset(s); 212f1ae32a1SGerd Hoffmann /* TODO: Reset char device, send BREAK? */ 213f1ae32a1SGerd Hoffmann } 214f1ae32a1SGerd Hoffmann 215f1ae32a1SGerd Hoffmann static uint8_t usb_get_modem_lines(USBSerialState *s) 216f1ae32a1SGerd Hoffmann { 217f1ae32a1SGerd Hoffmann int flags; 218f1ae32a1SGerd Hoffmann uint8_t ret; 219f1ae32a1SGerd Hoffmann 2205345fdb4SMarc-André Lureau if (qemu_chr_fe_ioctl(&s->cs, 221becdfa00SMarc-André Lureau CHR_IOCTL_SERIAL_GET_TIOCM, &flags) == -ENOTSUP) { 222f1ae32a1SGerd Hoffmann return FTDI_CTS | FTDI_DSR | FTDI_RLSD; 223becdfa00SMarc-André Lureau } 224f1ae32a1SGerd Hoffmann 225f1ae32a1SGerd Hoffmann ret = 0; 226adab8d48SMark Cave-Ayland if (flags & CHR_TIOCM_CTS) { 227f1ae32a1SGerd Hoffmann ret |= FTDI_CTS; 228adab8d48SMark Cave-Ayland } 229adab8d48SMark Cave-Ayland if (flags & CHR_TIOCM_DSR) { 230f1ae32a1SGerd Hoffmann ret |= FTDI_DSR; 231adab8d48SMark Cave-Ayland } 232adab8d48SMark Cave-Ayland if (flags & CHR_TIOCM_RI) { 233f1ae32a1SGerd Hoffmann ret |= FTDI_RI; 234adab8d48SMark Cave-Ayland } 235adab8d48SMark Cave-Ayland if (flags & CHR_TIOCM_CAR) { 236f1ae32a1SGerd Hoffmann ret |= FTDI_RLSD; 237adab8d48SMark Cave-Ayland } 238f1ae32a1SGerd Hoffmann 239f1ae32a1SGerd Hoffmann return ret; 240f1ae32a1SGerd Hoffmann } 241f1ae32a1SGerd Hoffmann 2429a77a0f5SHans de Goede static void usb_serial_handle_control(USBDevice *dev, USBPacket *p, 243adab8d48SMark Cave-Ayland int request, int value, int index, 244adab8d48SMark Cave-Ayland int length, uint8_t *data) 245f1ae32a1SGerd Hoffmann { 246*8a0e4ee7SMark Cave-Ayland USBSerialState *s = USB_SERIAL(dev); 247f1ae32a1SGerd Hoffmann int ret; 248f1ae32a1SGerd Hoffmann 249f1ae32a1SGerd Hoffmann DPRINTF("got control %x, value %x\n", request, value); 250f1ae32a1SGerd Hoffmann ret = usb_desc_handle_control(dev, p, request, value, index, length, data); 251f1ae32a1SGerd Hoffmann if (ret >= 0) { 2529a77a0f5SHans de Goede return; 253f1ae32a1SGerd Hoffmann } 254f1ae32a1SGerd Hoffmann 255f1ae32a1SGerd Hoffmann switch (request) { 256f1ae32a1SGerd Hoffmann case EndpointOutRequest | USB_REQ_CLEAR_FEATURE: 257f1ae32a1SGerd Hoffmann break; 258f1ae32a1SGerd Hoffmann 259f1ae32a1SGerd Hoffmann /* Class specific requests. */ 260f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_RESET: 261f1ae32a1SGerd Hoffmann switch (value) { 262f1ae32a1SGerd Hoffmann case FTDI_RESET_SIO: 263f1ae32a1SGerd Hoffmann usb_serial_reset(s); 264f1ae32a1SGerd Hoffmann break; 265f1ae32a1SGerd Hoffmann case FTDI_RESET_RX: 266f1ae32a1SGerd Hoffmann s->recv_ptr = 0; 267f1ae32a1SGerd Hoffmann s->recv_used = 0; 268f1ae32a1SGerd Hoffmann /* TODO: purge from char device */ 269f1ae32a1SGerd Hoffmann break; 270f1ae32a1SGerd Hoffmann case FTDI_RESET_TX: 271f1ae32a1SGerd Hoffmann /* TODO: purge from char device */ 272f1ae32a1SGerd Hoffmann break; 273f1ae32a1SGerd Hoffmann } 274f1ae32a1SGerd Hoffmann break; 275f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_MDM_CTRL: 276f1ae32a1SGerd Hoffmann { 277f1ae32a1SGerd Hoffmann static int flags; 2785345fdb4SMarc-André Lureau qemu_chr_fe_ioctl(&s->cs, CHR_IOCTL_SERIAL_GET_TIOCM, &flags); 279f1ae32a1SGerd Hoffmann if (value & FTDI_SET_RTS) { 280adab8d48SMark Cave-Ayland if (value & FTDI_RTS) { 281f1ae32a1SGerd Hoffmann flags |= CHR_TIOCM_RTS; 282adab8d48SMark Cave-Ayland } else { 283f1ae32a1SGerd Hoffmann flags &= ~CHR_TIOCM_RTS; 284f1ae32a1SGerd Hoffmann } 285adab8d48SMark Cave-Ayland } 286f1ae32a1SGerd Hoffmann if (value & FTDI_SET_DTR) { 287adab8d48SMark Cave-Ayland if (value & FTDI_DTR) { 288f1ae32a1SGerd Hoffmann flags |= CHR_TIOCM_DTR; 289adab8d48SMark Cave-Ayland } else { 290f1ae32a1SGerd Hoffmann flags &= ~CHR_TIOCM_DTR; 291f1ae32a1SGerd Hoffmann } 292adab8d48SMark Cave-Ayland } 2935345fdb4SMarc-André Lureau qemu_chr_fe_ioctl(&s->cs, CHR_IOCTL_SERIAL_SET_TIOCM, &flags); 294f1ae32a1SGerd Hoffmann break; 295f1ae32a1SGerd Hoffmann } 296f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_FLOW_CTRL: 297f1ae32a1SGerd Hoffmann /* TODO: ioctl */ 298f1ae32a1SGerd Hoffmann break; 299f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_BAUD: { 300f1ae32a1SGerd Hoffmann static const int subdivisors8[8] = { 0, 4, 2, 1, 3, 5, 6, 7 }; 301f1ae32a1SGerd Hoffmann int subdivisor8 = subdivisors8[((value & 0xc000) >> 14) 302f1ae32a1SGerd Hoffmann | ((index & 1) << 2)]; 303f1ae32a1SGerd Hoffmann int divisor = value & 0x3fff; 304f1ae32a1SGerd Hoffmann 305f1ae32a1SGerd Hoffmann /* chip special cases */ 306adab8d48SMark Cave-Ayland if (divisor == 1 && subdivisor8 == 0) { 307f1ae32a1SGerd Hoffmann subdivisor8 = 4; 308adab8d48SMark Cave-Ayland } 309adab8d48SMark Cave-Ayland if (divisor == 0 && subdivisor8 == 0) { 310f1ae32a1SGerd Hoffmann divisor = 1; 311adab8d48SMark Cave-Ayland } 312f1ae32a1SGerd Hoffmann 313f1ae32a1SGerd Hoffmann s->params.speed = (48000000 / 2) / (8 * divisor + subdivisor8); 3145345fdb4SMarc-André Lureau qemu_chr_fe_ioctl(&s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params); 315f1ae32a1SGerd Hoffmann break; 316f1ae32a1SGerd Hoffmann } 317f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_DATA: 318f1ae32a1SGerd Hoffmann switch (value & FTDI_PARITY) { 319f1ae32a1SGerd Hoffmann case 0: 320f1ae32a1SGerd Hoffmann s->params.parity = 'N'; 321f1ae32a1SGerd Hoffmann break; 322f1ae32a1SGerd Hoffmann case FTDI_ODD: 323f1ae32a1SGerd Hoffmann s->params.parity = 'O'; 324f1ae32a1SGerd Hoffmann break; 325f1ae32a1SGerd Hoffmann case FTDI_EVEN: 326f1ae32a1SGerd Hoffmann s->params.parity = 'E'; 327f1ae32a1SGerd Hoffmann break; 328f1ae32a1SGerd Hoffmann default: 329f1ae32a1SGerd Hoffmann DPRINTF("unsupported parity %d\n", value & FTDI_PARITY); 330f1ae32a1SGerd Hoffmann goto fail; 331f1ae32a1SGerd Hoffmann } 332adab8d48SMark Cave-Ayland 333f1ae32a1SGerd Hoffmann switch (value & FTDI_STOP) { 334f1ae32a1SGerd Hoffmann case FTDI_STOP1: 335f1ae32a1SGerd Hoffmann s->params.stop_bits = 1; 336f1ae32a1SGerd Hoffmann break; 337f1ae32a1SGerd Hoffmann case FTDI_STOP2: 338f1ae32a1SGerd Hoffmann s->params.stop_bits = 2; 339f1ae32a1SGerd Hoffmann break; 340f1ae32a1SGerd Hoffmann default: 341f1ae32a1SGerd Hoffmann DPRINTF("unsupported stop bits %d\n", value & FTDI_STOP); 342f1ae32a1SGerd Hoffmann goto fail; 343f1ae32a1SGerd Hoffmann } 344adab8d48SMark Cave-Ayland 3455345fdb4SMarc-André Lureau qemu_chr_fe_ioctl(&s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params); 346f1ae32a1SGerd Hoffmann /* TODO: TX ON/OFF */ 347f1ae32a1SGerd Hoffmann break; 348f1ae32a1SGerd Hoffmann case DeviceInVendor | FTDI_GET_MDM_ST: 349f1ae32a1SGerd Hoffmann data[0] = usb_get_modem_lines(s) | 1; 350647ee987SJason Andryuk data[1] = FTDI_THRE | FTDI_TEMT; 3519a77a0f5SHans de Goede p->actual_length = 2; 352f1ae32a1SGerd Hoffmann break; 353f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_EVENT_CHR: 354f1ae32a1SGerd Hoffmann /* TODO: handle it */ 355f1ae32a1SGerd Hoffmann s->event_chr = value; 356f1ae32a1SGerd Hoffmann break; 357f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_ERROR_CHR: 358f1ae32a1SGerd Hoffmann /* TODO: handle it */ 359f1ae32a1SGerd Hoffmann s->error_chr = value; 360f1ae32a1SGerd Hoffmann break; 361f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_LATENCY: 362f1ae32a1SGerd Hoffmann s->latency = value; 363f1ae32a1SGerd Hoffmann break; 364f1ae32a1SGerd Hoffmann case DeviceInVendor | FTDI_GET_LATENCY: 365f1ae32a1SGerd Hoffmann data[0] = s->latency; 3669a77a0f5SHans de Goede p->actual_length = 1; 367f1ae32a1SGerd Hoffmann break; 368f1ae32a1SGerd Hoffmann default: 369f1ae32a1SGerd Hoffmann fail: 370f1ae32a1SGerd Hoffmann DPRINTF("got unsupported/bogus control %x, value %x\n", request, value); 3719a77a0f5SHans de Goede p->status = USB_RET_STALL; 372f1ae32a1SGerd Hoffmann break; 373f1ae32a1SGerd Hoffmann } 374f1ae32a1SGerd Hoffmann } 375f1ae32a1SGerd Hoffmann 3762bcf4e9fSJason Andryuk static void usb_serial_token_in(USBSerialState *s, USBPacket *p) 3772bcf4e9fSJason Andryuk { 37887db78f7SJason Andryuk const int max_packet_size = desc_iface0.eps[0].wMaxPacketSize; 37987db78f7SJason Andryuk int packet_len; 3802bcf4e9fSJason Andryuk uint8_t header[2]; 3812bcf4e9fSJason Andryuk 38287db78f7SJason Andryuk packet_len = p->iov.size; 38387db78f7SJason Andryuk if (packet_len <= 2) { 3842bcf4e9fSJason Andryuk p->status = USB_RET_NAK; 3852bcf4e9fSJason Andryuk return; 3862bcf4e9fSJason Andryuk } 38787db78f7SJason Andryuk 3882bcf4e9fSJason Andryuk header[0] = usb_get_modem_lines(s) | 1; 3892bcf4e9fSJason Andryuk /* We do not have the uart details */ 3902bcf4e9fSJason Andryuk /* handle serial break */ 3912bcf4e9fSJason Andryuk if (s->event_trigger && s->event_trigger & FTDI_BI) { 3922bcf4e9fSJason Andryuk s->event_trigger &= ~FTDI_BI; 3932bcf4e9fSJason Andryuk header[1] = FTDI_BI; 3942bcf4e9fSJason Andryuk usb_packet_copy(p, header, 2); 3952bcf4e9fSJason Andryuk return; 3962bcf4e9fSJason Andryuk } else { 3972bcf4e9fSJason Andryuk header[1] = 0; 3982bcf4e9fSJason Andryuk } 39987db78f7SJason Andryuk 40087db78f7SJason Andryuk if (!s->recv_used) { 40187db78f7SJason Andryuk p->status = USB_RET_NAK; 40287db78f7SJason Andryuk return; 40387db78f7SJason Andryuk } 40487db78f7SJason Andryuk 40587db78f7SJason Andryuk while (s->recv_used && packet_len > 2) { 40687db78f7SJason Andryuk int first_len, len; 40787db78f7SJason Andryuk 40887db78f7SJason Andryuk len = MIN(packet_len, max_packet_size); 4092bcf4e9fSJason Andryuk len -= 2; 4102bcf4e9fSJason Andryuk if (len > s->recv_used) { 4112bcf4e9fSJason Andryuk len = s->recv_used; 4122bcf4e9fSJason Andryuk } 41387db78f7SJason Andryuk 41487db78f7SJason Andryuk first_len = RECV_BUF - s->recv_ptr; 4152bcf4e9fSJason Andryuk if (first_len > len) { 4162bcf4e9fSJason Andryuk first_len = len; 4172bcf4e9fSJason Andryuk } 4182bcf4e9fSJason Andryuk usb_packet_copy(p, header, 2); 4192bcf4e9fSJason Andryuk usb_packet_copy(p, s->recv_buf + s->recv_ptr, first_len); 4202bcf4e9fSJason Andryuk if (len > first_len) { 4212bcf4e9fSJason Andryuk usb_packet_copy(p, s->recv_buf, len - first_len); 4222bcf4e9fSJason Andryuk } 4232bcf4e9fSJason Andryuk s->recv_used -= len; 4242bcf4e9fSJason Andryuk s->recv_ptr = (s->recv_ptr + len) % RECV_BUF; 42587db78f7SJason Andryuk packet_len -= len + 2; 42687db78f7SJason Andryuk } 4272bcf4e9fSJason Andryuk 4282bcf4e9fSJason Andryuk return; 4292bcf4e9fSJason Andryuk } 4302bcf4e9fSJason Andryuk 4319a77a0f5SHans de Goede static void usb_serial_handle_data(USBDevice *dev, USBPacket *p) 432f1ae32a1SGerd Hoffmann { 433*8a0e4ee7SMark Cave-Ayland USBSerialState *s = USB_SERIAL(dev); 434f1ae32a1SGerd Hoffmann uint8_t devep = p->ep->nr; 435f1ae32a1SGerd Hoffmann struct iovec *iov; 4362bcf4e9fSJason Andryuk int i; 437f1ae32a1SGerd Hoffmann 438f1ae32a1SGerd Hoffmann switch (p->pid) { 439f1ae32a1SGerd Hoffmann case USB_TOKEN_OUT: 440adab8d48SMark Cave-Ayland if (devep != 2) { 441f1ae32a1SGerd Hoffmann goto fail; 442adab8d48SMark Cave-Ayland } 443f1ae32a1SGerd Hoffmann for (i = 0; i < p->iov.niov; i++) { 444f1ae32a1SGerd Hoffmann iov = p->iov.iov + i; 445adab8d48SMark Cave-Ayland /* 446adab8d48SMark Cave-Ayland * XXX this blocks entire thread. Rewrite to use 447adab8d48SMark Cave-Ayland * qemu_chr_fe_write and background I/O callbacks 448adab8d48SMark Cave-Ayland */ 4495345fdb4SMarc-André Lureau qemu_chr_fe_write_all(&s->cs, iov->iov_base, iov->iov_len); 450f1ae32a1SGerd Hoffmann } 4519a77a0f5SHans de Goede p->actual_length = p->iov.size; 452f1ae32a1SGerd Hoffmann break; 453f1ae32a1SGerd Hoffmann 454f1ae32a1SGerd Hoffmann case USB_TOKEN_IN: 455adab8d48SMark Cave-Ayland if (devep != 1) { 456f1ae32a1SGerd Hoffmann goto fail; 457adab8d48SMark Cave-Ayland } 4582bcf4e9fSJason Andryuk usb_serial_token_in(s, p); 459f1ae32a1SGerd Hoffmann break; 460f1ae32a1SGerd Hoffmann 461f1ae32a1SGerd Hoffmann default: 462f1ae32a1SGerd Hoffmann DPRINTF("Bad token\n"); 463f1ae32a1SGerd Hoffmann fail: 4649a77a0f5SHans de Goede p->status = USB_RET_STALL; 465f1ae32a1SGerd Hoffmann break; 466f1ae32a1SGerd Hoffmann } 467f1ae32a1SGerd Hoffmann } 468f1ae32a1SGerd Hoffmann 469f1ae32a1SGerd Hoffmann static int usb_serial_can_read(void *opaque) 470f1ae32a1SGerd Hoffmann { 471f1ae32a1SGerd Hoffmann USBSerialState *s = opaque; 472da124e62SGerd Hoffmann 473da124e62SGerd Hoffmann if (!s->dev.attached) { 474da124e62SGerd Hoffmann return 0; 475da124e62SGerd Hoffmann } 476f1ae32a1SGerd Hoffmann return RECV_BUF - s->recv_used; 477f1ae32a1SGerd Hoffmann } 478f1ae32a1SGerd Hoffmann 479f1ae32a1SGerd Hoffmann static void usb_serial_read(void *opaque, const uint8_t *buf, int size) 480f1ae32a1SGerd Hoffmann { 481f1ae32a1SGerd Hoffmann USBSerialState *s = opaque; 482f1ae32a1SGerd Hoffmann int first_size, start; 483f1ae32a1SGerd Hoffmann 484f1ae32a1SGerd Hoffmann /* room in the buffer? */ 485adab8d48SMark Cave-Ayland if (size > (RECV_BUF - s->recv_used)) { 486f1ae32a1SGerd Hoffmann size = RECV_BUF - s->recv_used; 487adab8d48SMark Cave-Ayland } 488f1ae32a1SGerd Hoffmann 489f1ae32a1SGerd Hoffmann start = s->recv_ptr + s->recv_used; 490f1ae32a1SGerd Hoffmann if (start < RECV_BUF) { 491f1ae32a1SGerd Hoffmann /* copy data to end of buffer */ 492f1ae32a1SGerd Hoffmann first_size = RECV_BUF - start; 493adab8d48SMark Cave-Ayland if (first_size > size) { 494f1ae32a1SGerd Hoffmann first_size = size; 495adab8d48SMark Cave-Ayland } 496f1ae32a1SGerd Hoffmann 497f1ae32a1SGerd Hoffmann memcpy(s->recv_buf + start, buf, first_size); 498f1ae32a1SGerd Hoffmann 499f1ae32a1SGerd Hoffmann /* wrap around to front if needed */ 500adab8d48SMark Cave-Ayland if (size > first_size) { 501f1ae32a1SGerd Hoffmann memcpy(s->recv_buf, buf + first_size, size - first_size); 502adab8d48SMark Cave-Ayland } 503f1ae32a1SGerd Hoffmann } else { 504f1ae32a1SGerd Hoffmann start -= RECV_BUF; 505f1ae32a1SGerd Hoffmann memcpy(s->recv_buf + start, buf, size); 506f1ae32a1SGerd Hoffmann } 507f1ae32a1SGerd Hoffmann s->recv_used += size; 5085843b6b3SJason Andryuk 5095843b6b3SJason Andryuk usb_wakeup(s->intr, 0); 510f1ae32a1SGerd Hoffmann } 511f1ae32a1SGerd Hoffmann 512083b266fSPhilippe Mathieu-Daudé static void usb_serial_event(void *opaque, QEMUChrEvent event) 513f1ae32a1SGerd Hoffmann { 514f1ae32a1SGerd Hoffmann USBSerialState *s = opaque; 515f1ae32a1SGerd Hoffmann 516f1ae32a1SGerd Hoffmann switch (event) { 517f1ae32a1SGerd Hoffmann case CHR_EVENT_BREAK: 518f1ae32a1SGerd Hoffmann s->event_trigger |= FTDI_BI; 519f1ae32a1SGerd Hoffmann break; 520f1ae32a1SGerd Hoffmann case CHR_EVENT_OPENED: 521da124e62SGerd Hoffmann if (!s->dev.attached) { 5227334d650SGonglei usb_device_attach(&s->dev, &error_abort); 523da124e62SGerd Hoffmann } 524da124e62SGerd Hoffmann break; 525da124e62SGerd Hoffmann case CHR_EVENT_CLOSED: 526da124e62SGerd Hoffmann if (s->dev.attached) { 527da124e62SGerd Hoffmann usb_device_detach(&s->dev); 528da124e62SGerd Hoffmann } 529f1ae32a1SGerd Hoffmann break; 530c263158eSPhilippe Mathieu-Daudé case CHR_EVENT_MUX_IN: 531c263158eSPhilippe Mathieu-Daudé case CHR_EVENT_MUX_OUT: 532c263158eSPhilippe Mathieu-Daudé /* Ignore */ 533c263158eSPhilippe Mathieu-Daudé break; 534f1ae32a1SGerd Hoffmann } 535f1ae32a1SGerd Hoffmann } 536f1ae32a1SGerd Hoffmann 53738fff2c9SGonglei static void usb_serial_realize(USBDevice *dev, Error **errp) 538f1ae32a1SGerd Hoffmann { 539bdd5f27eSEduardo Habkost USBSerialState *s = USB_SERIAL(dev); 5407334d650SGonglei Error *local_err = NULL; 541f1ae32a1SGerd Hoffmann 5429d55d1adSGerd Hoffmann usb_desc_create_serial(dev); 543f1ae32a1SGerd Hoffmann usb_desc_init(dev); 544da124e62SGerd Hoffmann dev->auto_attach = 0; 545f1ae32a1SGerd Hoffmann 54630650701SAnton Nefedov if (!qemu_chr_fe_backend_connected(&s->cs)) { 54738fff2c9SGonglei error_setg(errp, "Property chardev is required"); 54838fff2c9SGonglei return; 549f1ae32a1SGerd Hoffmann } 550f1ae32a1SGerd Hoffmann 5517334d650SGonglei usb_check_attach(dev, &local_err); 5527334d650SGonglei if (local_err) { 5537334d650SGonglei error_propagate(errp, local_err); 5547334d650SGonglei return; 5557334d650SGonglei } 5567334d650SGonglei 5575345fdb4SMarc-André Lureau qemu_chr_fe_set_handlers(&s->cs, usb_serial_can_read, usb_serial_read, 55881517ba3SAnton Nefedov usb_serial_event, NULL, s, NULL, true); 559f1ae32a1SGerd Hoffmann usb_serial_handle_reset(dev); 560da124e62SGerd Hoffmann 56130650701SAnton Nefedov if (qemu_chr_fe_backend_open(&s->cs) && !dev->attached) { 5627334d650SGonglei usb_device_attach(dev, &error_abort); 5637d553f27SGonglei } 5645843b6b3SJason Andryuk s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1); 565da124e62SGerd Hoffmann } 566f1ae32a1SGerd Hoffmann 567590ce74aSMarkus Armbruster static USBDevice *usb_braille_init(const char *unused) 568f1ae32a1SGerd Hoffmann { 569f1ae32a1SGerd Hoffmann USBDevice *dev; 5700ec7b3e7SMarc-André Lureau Chardev *cdrv; 571f1ae32a1SGerd Hoffmann 5724ad6f6cbSPaolo Bonzini cdrv = qemu_chr_new("braille", "braille", NULL); 573adab8d48SMark Cave-Ayland if (!cdrv) { 574f1ae32a1SGerd Hoffmann return NULL; 575adab8d48SMark Cave-Ayland } 576f1ae32a1SGerd Hoffmann 577590ce74aSMarkus Armbruster dev = usb_new("usb-braille"); 578f1ae32a1SGerd Hoffmann qdev_prop_set_chr(&dev->qdev, "chardev", cdrv); 579f1ae32a1SGerd Hoffmann return dev; 580f1ae32a1SGerd Hoffmann } 581f1ae32a1SGerd Hoffmann 582f1ae32a1SGerd Hoffmann static const VMStateDescription vmstate_usb_serial = { 583f1ae32a1SGerd Hoffmann .name = "usb-serial", 584f1ae32a1SGerd Hoffmann .unmigratable = 1, 585f1ae32a1SGerd Hoffmann }; 586f1ae32a1SGerd Hoffmann 587f1ae32a1SGerd Hoffmann static Property serial_properties[] = { 588f1ae32a1SGerd Hoffmann DEFINE_PROP_CHR("chardev", USBSerialState, cs), 589f1ae32a1SGerd Hoffmann DEFINE_PROP_END_OF_LIST(), 590f1ae32a1SGerd Hoffmann }; 591f1ae32a1SGerd Hoffmann 592cdf0d769SGonglei static void usb_serial_dev_class_init(ObjectClass *klass, void *data) 593f1ae32a1SGerd Hoffmann { 594f1ae32a1SGerd Hoffmann DeviceClass *dc = DEVICE_CLASS(klass); 595f1ae32a1SGerd Hoffmann USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 596f1ae32a1SGerd Hoffmann 59738fff2c9SGonglei uc->realize = usb_serial_realize; 598f1ae32a1SGerd Hoffmann uc->handle_reset = usb_serial_handle_reset; 599f1ae32a1SGerd Hoffmann uc->handle_control = usb_serial_handle_control; 600f1ae32a1SGerd Hoffmann uc->handle_data = usb_serial_handle_data; 601f1ae32a1SGerd Hoffmann dc->vmsd = &vmstate_usb_serial; 602125ee0edSMarcel Apfelbaum set_bit(DEVICE_CATEGORY_INPUT, dc->categories); 603f1ae32a1SGerd Hoffmann } 604f1ae32a1SGerd Hoffmann 605cdf0d769SGonglei static const TypeInfo usb_serial_dev_type_info = { 606cdf0d769SGonglei .name = TYPE_USB_SERIAL, 607cdf0d769SGonglei .parent = TYPE_USB_DEVICE, 608cdf0d769SGonglei .instance_size = sizeof(USBSerialState), 609cdf0d769SGonglei .abstract = true, 610cdf0d769SGonglei .class_init = usb_serial_dev_class_init, 611cdf0d769SGonglei }; 612cdf0d769SGonglei 613cdf0d769SGonglei static void usb_serial_class_initfn(ObjectClass *klass, void *data) 614cdf0d769SGonglei { 615cdf0d769SGonglei DeviceClass *dc = DEVICE_CLASS(klass); 616cdf0d769SGonglei USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 617cdf0d769SGonglei 618cdf0d769SGonglei uc->product_desc = "QEMU USB Serial"; 619cdf0d769SGonglei uc->usb_desc = &desc_serial; 6204f67d30bSMarc-André Lureau device_class_set_props(dc, serial_properties); 621cdf0d769SGonglei } 622cdf0d769SGonglei 6238c43a6f0SAndreas Färber static const TypeInfo serial_info = { 624f1ae32a1SGerd Hoffmann .name = "usb-serial", 625cdf0d769SGonglei .parent = TYPE_USB_SERIAL, 626f1ae32a1SGerd Hoffmann .class_init = usb_serial_class_initfn, 627f1ae32a1SGerd Hoffmann }; 628f1ae32a1SGerd Hoffmann 629f1ae32a1SGerd Hoffmann static Property braille_properties[] = { 630f1ae32a1SGerd Hoffmann DEFINE_PROP_CHR("chardev", USBSerialState, cs), 631f1ae32a1SGerd Hoffmann DEFINE_PROP_END_OF_LIST(), 632f1ae32a1SGerd Hoffmann }; 633f1ae32a1SGerd Hoffmann 634f1ae32a1SGerd Hoffmann static void usb_braille_class_initfn(ObjectClass *klass, void *data) 635f1ae32a1SGerd Hoffmann { 636f1ae32a1SGerd Hoffmann DeviceClass *dc = DEVICE_CLASS(klass); 637f1ae32a1SGerd Hoffmann USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 638f1ae32a1SGerd Hoffmann 639f1ae32a1SGerd Hoffmann uc->product_desc = "QEMU USB Braille"; 640f1ae32a1SGerd Hoffmann uc->usb_desc = &desc_braille; 6414f67d30bSMarc-André Lureau device_class_set_props(dc, braille_properties); 642f1ae32a1SGerd Hoffmann } 643f1ae32a1SGerd Hoffmann 6448c43a6f0SAndreas Färber static const TypeInfo braille_info = { 645f1ae32a1SGerd Hoffmann .name = "usb-braille", 646cdf0d769SGonglei .parent = TYPE_USB_SERIAL, 647f1ae32a1SGerd Hoffmann .class_init = usb_braille_class_initfn, 648f1ae32a1SGerd Hoffmann }; 649f1ae32a1SGerd Hoffmann 650f1ae32a1SGerd Hoffmann static void usb_serial_register_types(void) 651f1ae32a1SGerd Hoffmann { 652cdf0d769SGonglei type_register_static(&usb_serial_dev_type_info); 653f1ae32a1SGerd Hoffmann type_register_static(&serial_info); 654f1ae32a1SGerd Hoffmann type_register_static(&braille_info); 655f1ae32a1SGerd Hoffmann usb_legacy_register("usb-braille", "braille", usb_braille_init); 656f1ae32a1SGerd Hoffmann } 657f1ae32a1SGerd Hoffmann 658f1ae32a1SGerd Hoffmann type_init(usb_serial_register_types) 659