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 47f1ae32a1SGerd Hoffmann #define DeviceOutVendor ((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8) 48f1ae32a1SGerd Hoffmann #define DeviceInVendor ((USB_DIR_IN |USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8) 49f1ae32a1SGerd Hoffmann 50f1ae32a1SGerd Hoffmann /* RESET */ 51f1ae32a1SGerd Hoffmann 52f1ae32a1SGerd Hoffmann #define FTDI_RESET_SIO 0 53f1ae32a1SGerd Hoffmann #define FTDI_RESET_RX 1 54f1ae32a1SGerd Hoffmann #define FTDI_RESET_TX 2 55f1ae32a1SGerd Hoffmann 56f1ae32a1SGerd Hoffmann /* SET_MDM_CTRL */ 57f1ae32a1SGerd Hoffmann 58f1ae32a1SGerd Hoffmann #define FTDI_DTR 1 59f1ae32a1SGerd Hoffmann #define FTDI_SET_DTR (FTDI_DTR << 8) 60f1ae32a1SGerd Hoffmann #define FTDI_RTS 2 61f1ae32a1SGerd Hoffmann #define FTDI_SET_RTS (FTDI_RTS << 8) 62f1ae32a1SGerd Hoffmann 63f1ae32a1SGerd Hoffmann /* SET_FLOW_CTRL */ 64f1ae32a1SGerd Hoffmann 65f1ae32a1SGerd Hoffmann #define FTDI_RTS_CTS_HS 1 66f1ae32a1SGerd Hoffmann #define FTDI_DTR_DSR_HS 2 67f1ae32a1SGerd Hoffmann #define FTDI_XON_XOFF_HS 4 68f1ae32a1SGerd Hoffmann 69f1ae32a1SGerd Hoffmann /* SET_DATA */ 70f1ae32a1SGerd Hoffmann 71f1ae32a1SGerd Hoffmann #define FTDI_PARITY (0x7 << 8) 72f1ae32a1SGerd Hoffmann #define FTDI_ODD (0x1 << 8) 73f1ae32a1SGerd Hoffmann #define FTDI_EVEN (0x2 << 8) 74f1ae32a1SGerd Hoffmann #define FTDI_MARK (0x3 << 8) 75f1ae32a1SGerd Hoffmann #define FTDI_SPACE (0x4 << 8) 76f1ae32a1SGerd Hoffmann 77f1ae32a1SGerd Hoffmann #define FTDI_STOP (0x3 << 11) 78f1ae32a1SGerd Hoffmann #define FTDI_STOP1 (0x0 << 11) 79f1ae32a1SGerd Hoffmann #define FTDI_STOP15 (0x1 << 11) 80f1ae32a1SGerd Hoffmann #define FTDI_STOP2 (0x2 << 11) 81f1ae32a1SGerd Hoffmann 82f1ae32a1SGerd Hoffmann /* GET_MDM_ST */ 83f1ae32a1SGerd Hoffmann /* TODO: should be sent every 40ms */ 84f1ae32a1SGerd Hoffmann #define FTDI_CTS (1<<4) // CTS line status 85f1ae32a1SGerd Hoffmann #define FTDI_DSR (1<<5) // DSR line status 86f1ae32a1SGerd Hoffmann #define FTDI_RI (1<<6) // RI line status 87f1ae32a1SGerd Hoffmann #define FTDI_RLSD (1<<7) // Receive Line Signal Detect 88f1ae32a1SGerd Hoffmann 89f1ae32a1SGerd Hoffmann /* Status */ 90f1ae32a1SGerd Hoffmann 91f1ae32a1SGerd Hoffmann #define FTDI_DR (1<<0) // Data Ready 92f1ae32a1SGerd Hoffmann #define FTDI_OE (1<<1) // Overrun Err 93f1ae32a1SGerd Hoffmann #define FTDI_PE (1<<2) // Parity Err 94f1ae32a1SGerd Hoffmann #define FTDI_FE (1<<3) // Framing Err 95f1ae32a1SGerd Hoffmann #define FTDI_BI (1<<4) // Break Interrupt 96f1ae32a1SGerd Hoffmann #define FTDI_THRE (1<<5) // Transmitter Holding Register 97f1ae32a1SGerd Hoffmann #define FTDI_TEMT (1<<6) // Transmitter Empty 98f1ae32a1SGerd Hoffmann #define FTDI_FIFO (1<<7) // Error in FIFO 99f1ae32a1SGerd Hoffmann 100db1015e9SEduardo Habkost struct USBSerialState { 101f1ae32a1SGerd Hoffmann USBDevice dev; 1025843b6b3SJason Andryuk USBEndpoint *intr; 103f1ae32a1SGerd Hoffmann uint8_t recv_buf[RECV_BUF]; 104f1ae32a1SGerd Hoffmann uint16_t recv_ptr; 105f1ae32a1SGerd Hoffmann uint16_t recv_used; 106f1ae32a1SGerd Hoffmann uint8_t event_chr; 107f1ae32a1SGerd Hoffmann uint8_t error_chr; 108f1ae32a1SGerd Hoffmann uint8_t event_trigger; 109f1ae32a1SGerd Hoffmann QEMUSerialSetParams params; 110f1ae32a1SGerd Hoffmann int latency; /* ms */ 111becdfa00SMarc-André Lureau CharBackend cs; 112db1015e9SEduardo Habkost }; 113db1015e9SEduardo Habkost typedef struct USBSerialState USBSerialState; 114f1ae32a1SGerd Hoffmann 115cdf0d769SGonglei #define TYPE_USB_SERIAL "usb-serial-dev" 116*bdd5f27eSEduardo Habkost DECLARE_INSTANCE_CHECKER(USBSerialState, USB_SERIAL, 1178110fa1dSEduardo Habkost TYPE_USB_SERIAL) 118cdf0d769SGonglei 119f1ae32a1SGerd Hoffmann enum { 120f1ae32a1SGerd Hoffmann STR_MANUFACTURER = 1, 121f1ae32a1SGerd Hoffmann STR_PRODUCT_SERIAL, 122f1ae32a1SGerd Hoffmann STR_PRODUCT_BRAILLE, 123f1ae32a1SGerd Hoffmann STR_SERIALNUMBER, 124f1ae32a1SGerd Hoffmann }; 125f1ae32a1SGerd Hoffmann 126f1ae32a1SGerd Hoffmann static const USBDescStrings desc_strings = { 12793bfef4cSCrístian Viana [STR_MANUFACTURER] = "QEMU", 128f1ae32a1SGerd Hoffmann [STR_PRODUCT_SERIAL] = "QEMU USB SERIAL", 1292964cd9bSSamuel Thibault [STR_PRODUCT_BRAILLE] = "QEMU USB BAUM BRAILLE", 130f1ae32a1SGerd Hoffmann [STR_SERIALNUMBER] = "1", 131f1ae32a1SGerd Hoffmann }; 132f1ae32a1SGerd Hoffmann 133f1ae32a1SGerd Hoffmann static const USBDescIface desc_iface0 = { 134f1ae32a1SGerd Hoffmann .bInterfaceNumber = 0, 135f1ae32a1SGerd Hoffmann .bNumEndpoints = 2, 136f1ae32a1SGerd Hoffmann .bInterfaceClass = 0xff, 137f1ae32a1SGerd Hoffmann .bInterfaceSubClass = 0xff, 138f1ae32a1SGerd Hoffmann .bInterfaceProtocol = 0xff, 139f1ae32a1SGerd Hoffmann .eps = (USBDescEndpoint[]) { 140f1ae32a1SGerd Hoffmann { 141f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_IN | 0x01, 142f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_BULK, 143f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64, 144f1ae32a1SGerd Hoffmann },{ 145f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_OUT | 0x02, 146f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_BULK, 147f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64, 148f1ae32a1SGerd Hoffmann }, 149f1ae32a1SGerd Hoffmann } 150f1ae32a1SGerd Hoffmann }; 151f1ae32a1SGerd Hoffmann 152f1ae32a1SGerd Hoffmann static const USBDescDevice desc_device = { 153f1ae32a1SGerd Hoffmann .bcdUSB = 0x0200, 154f1ae32a1SGerd Hoffmann .bMaxPacketSize0 = 8, 155f1ae32a1SGerd Hoffmann .bNumConfigurations = 1, 156f1ae32a1SGerd Hoffmann .confs = (USBDescConfig[]) { 157f1ae32a1SGerd Hoffmann { 158f1ae32a1SGerd Hoffmann .bNumInterfaces = 1, 159f1ae32a1SGerd Hoffmann .bConfigurationValue = 1, 1605843b6b3SJason Andryuk .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_WAKEUP, 161f1ae32a1SGerd Hoffmann .bMaxPower = 50, 162f1ae32a1SGerd Hoffmann .nif = 1, 163f1ae32a1SGerd Hoffmann .ifs = &desc_iface0, 164f1ae32a1SGerd Hoffmann }, 165f1ae32a1SGerd Hoffmann }, 166f1ae32a1SGerd Hoffmann }; 167f1ae32a1SGerd Hoffmann 168f1ae32a1SGerd Hoffmann static const USBDesc desc_serial = { 169f1ae32a1SGerd Hoffmann .id = { 170f1ae32a1SGerd Hoffmann .idVendor = 0x0403, 171f1ae32a1SGerd Hoffmann .idProduct = 0x6001, 172f1ae32a1SGerd Hoffmann .bcdDevice = 0x0400, 173f1ae32a1SGerd Hoffmann .iManufacturer = STR_MANUFACTURER, 174f1ae32a1SGerd Hoffmann .iProduct = STR_PRODUCT_SERIAL, 175f1ae32a1SGerd Hoffmann .iSerialNumber = STR_SERIALNUMBER, 176f1ae32a1SGerd Hoffmann }, 177f1ae32a1SGerd Hoffmann .full = &desc_device, 178f1ae32a1SGerd Hoffmann .str = desc_strings, 179f1ae32a1SGerd Hoffmann }; 180f1ae32a1SGerd Hoffmann 181f1ae32a1SGerd Hoffmann static const USBDesc desc_braille = { 182f1ae32a1SGerd Hoffmann .id = { 183f1ae32a1SGerd Hoffmann .idVendor = 0x0403, 184f1ae32a1SGerd Hoffmann .idProduct = 0xfe72, 185f1ae32a1SGerd Hoffmann .bcdDevice = 0x0400, 186f1ae32a1SGerd Hoffmann .iManufacturer = STR_MANUFACTURER, 187f1ae32a1SGerd Hoffmann .iProduct = STR_PRODUCT_BRAILLE, 188f1ae32a1SGerd Hoffmann .iSerialNumber = STR_SERIALNUMBER, 189f1ae32a1SGerd Hoffmann }, 190f1ae32a1SGerd Hoffmann .full = &desc_device, 191f1ae32a1SGerd Hoffmann .str = desc_strings, 192f1ae32a1SGerd Hoffmann }; 193f1ae32a1SGerd Hoffmann 194f1ae32a1SGerd Hoffmann static void usb_serial_reset(USBSerialState *s) 195f1ae32a1SGerd Hoffmann { 196f1ae32a1SGerd Hoffmann /* TODO: Set flow control to none */ 197f1ae32a1SGerd Hoffmann s->event_chr = 0x0d; 198f1ae32a1SGerd Hoffmann s->event_trigger = 0; 199f1ae32a1SGerd Hoffmann s->recv_ptr = 0; 200f1ae32a1SGerd Hoffmann s->recv_used = 0; 201f1ae32a1SGerd Hoffmann /* TODO: purge in char driver */ 202f1ae32a1SGerd Hoffmann } 203f1ae32a1SGerd Hoffmann 204f1ae32a1SGerd Hoffmann static void usb_serial_handle_reset(USBDevice *dev) 205f1ae32a1SGerd Hoffmann { 206f1ae32a1SGerd Hoffmann USBSerialState *s = (USBSerialState *)dev; 207f1ae32a1SGerd Hoffmann 208f1ae32a1SGerd Hoffmann DPRINTF("Reset\n"); 209f1ae32a1SGerd Hoffmann 210f1ae32a1SGerd Hoffmann usb_serial_reset(s); 211f1ae32a1SGerd Hoffmann /* TODO: Reset char device, send BREAK? */ 212f1ae32a1SGerd Hoffmann } 213f1ae32a1SGerd Hoffmann 214f1ae32a1SGerd Hoffmann static uint8_t usb_get_modem_lines(USBSerialState *s) 215f1ae32a1SGerd Hoffmann { 216f1ae32a1SGerd Hoffmann int flags; 217f1ae32a1SGerd Hoffmann uint8_t ret; 218f1ae32a1SGerd Hoffmann 2195345fdb4SMarc-André Lureau if (qemu_chr_fe_ioctl(&s->cs, 220becdfa00SMarc-André Lureau CHR_IOCTL_SERIAL_GET_TIOCM, &flags) == -ENOTSUP) { 221f1ae32a1SGerd Hoffmann return FTDI_CTS|FTDI_DSR|FTDI_RLSD; 222becdfa00SMarc-André Lureau } 223f1ae32a1SGerd Hoffmann 224f1ae32a1SGerd Hoffmann ret = 0; 225f1ae32a1SGerd Hoffmann if (flags & CHR_TIOCM_CTS) 226f1ae32a1SGerd Hoffmann ret |= FTDI_CTS; 227f1ae32a1SGerd Hoffmann if (flags & CHR_TIOCM_DSR) 228f1ae32a1SGerd Hoffmann ret |= FTDI_DSR; 229f1ae32a1SGerd Hoffmann if (flags & CHR_TIOCM_RI) 230f1ae32a1SGerd Hoffmann ret |= FTDI_RI; 231f1ae32a1SGerd Hoffmann if (flags & CHR_TIOCM_CAR) 232f1ae32a1SGerd Hoffmann ret |= FTDI_RLSD; 233f1ae32a1SGerd Hoffmann 234f1ae32a1SGerd Hoffmann return ret; 235f1ae32a1SGerd Hoffmann } 236f1ae32a1SGerd Hoffmann 2379a77a0f5SHans de Goede static void usb_serial_handle_control(USBDevice *dev, USBPacket *p, 238f1ae32a1SGerd Hoffmann int request, int value, int index, int length, uint8_t *data) 239f1ae32a1SGerd Hoffmann { 240f1ae32a1SGerd Hoffmann USBSerialState *s = (USBSerialState *)dev; 241f1ae32a1SGerd Hoffmann int ret; 242f1ae32a1SGerd Hoffmann 243f1ae32a1SGerd Hoffmann DPRINTF("got control %x, value %x\n",request, value); 244f1ae32a1SGerd Hoffmann ret = usb_desc_handle_control(dev, p, request, value, index, length, data); 245f1ae32a1SGerd Hoffmann if (ret >= 0) { 2469a77a0f5SHans de Goede return; 247f1ae32a1SGerd Hoffmann } 248f1ae32a1SGerd Hoffmann 249f1ae32a1SGerd Hoffmann switch (request) { 250f1ae32a1SGerd Hoffmann case EndpointOutRequest | USB_REQ_CLEAR_FEATURE: 251f1ae32a1SGerd Hoffmann break; 252f1ae32a1SGerd Hoffmann 253f1ae32a1SGerd Hoffmann /* Class specific requests. */ 254f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_RESET: 255f1ae32a1SGerd Hoffmann switch (value) { 256f1ae32a1SGerd Hoffmann case FTDI_RESET_SIO: 257f1ae32a1SGerd Hoffmann usb_serial_reset(s); 258f1ae32a1SGerd Hoffmann break; 259f1ae32a1SGerd Hoffmann case FTDI_RESET_RX: 260f1ae32a1SGerd Hoffmann s->recv_ptr = 0; 261f1ae32a1SGerd Hoffmann s->recv_used = 0; 262f1ae32a1SGerd Hoffmann /* TODO: purge from char device */ 263f1ae32a1SGerd Hoffmann break; 264f1ae32a1SGerd Hoffmann case FTDI_RESET_TX: 265f1ae32a1SGerd Hoffmann /* TODO: purge from char device */ 266f1ae32a1SGerd Hoffmann break; 267f1ae32a1SGerd Hoffmann } 268f1ae32a1SGerd Hoffmann break; 269f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_MDM_CTRL: 270f1ae32a1SGerd Hoffmann { 271f1ae32a1SGerd Hoffmann static int flags; 2725345fdb4SMarc-André Lureau qemu_chr_fe_ioctl(&s->cs, CHR_IOCTL_SERIAL_GET_TIOCM, &flags); 273f1ae32a1SGerd Hoffmann if (value & FTDI_SET_RTS) { 274f1ae32a1SGerd Hoffmann if (value & FTDI_RTS) 275f1ae32a1SGerd Hoffmann flags |= CHR_TIOCM_RTS; 276f1ae32a1SGerd Hoffmann else 277f1ae32a1SGerd Hoffmann flags &= ~CHR_TIOCM_RTS; 278f1ae32a1SGerd Hoffmann } 279f1ae32a1SGerd Hoffmann if (value & FTDI_SET_DTR) { 280f1ae32a1SGerd Hoffmann if (value & FTDI_DTR) 281f1ae32a1SGerd Hoffmann flags |= CHR_TIOCM_DTR; 282f1ae32a1SGerd Hoffmann else 283f1ae32a1SGerd Hoffmann flags &= ~CHR_TIOCM_DTR; 284f1ae32a1SGerd Hoffmann } 2855345fdb4SMarc-André Lureau qemu_chr_fe_ioctl(&s->cs, CHR_IOCTL_SERIAL_SET_TIOCM, &flags); 286f1ae32a1SGerd Hoffmann break; 287f1ae32a1SGerd Hoffmann } 288f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_FLOW_CTRL: 289f1ae32a1SGerd Hoffmann /* TODO: ioctl */ 290f1ae32a1SGerd Hoffmann break; 291f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_BAUD: { 292f1ae32a1SGerd Hoffmann static const int subdivisors8[8] = { 0, 4, 2, 1, 3, 5, 6, 7 }; 293f1ae32a1SGerd Hoffmann int subdivisor8 = subdivisors8[((value & 0xc000) >> 14) 294f1ae32a1SGerd Hoffmann | ((index & 1) << 2)]; 295f1ae32a1SGerd Hoffmann int divisor = value & 0x3fff; 296f1ae32a1SGerd Hoffmann 297f1ae32a1SGerd Hoffmann /* chip special cases */ 298f1ae32a1SGerd Hoffmann if (divisor == 1 && subdivisor8 == 0) 299f1ae32a1SGerd Hoffmann subdivisor8 = 4; 300f1ae32a1SGerd Hoffmann if (divisor == 0 && subdivisor8 == 0) 301f1ae32a1SGerd Hoffmann divisor = 1; 302f1ae32a1SGerd Hoffmann 303f1ae32a1SGerd Hoffmann s->params.speed = (48000000 / 2) / (8 * divisor + subdivisor8); 3045345fdb4SMarc-André Lureau qemu_chr_fe_ioctl(&s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params); 305f1ae32a1SGerd Hoffmann break; 306f1ae32a1SGerd Hoffmann } 307f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_DATA: 308f1ae32a1SGerd Hoffmann switch (value & FTDI_PARITY) { 309f1ae32a1SGerd Hoffmann case 0: 310f1ae32a1SGerd Hoffmann s->params.parity = 'N'; 311f1ae32a1SGerd Hoffmann break; 312f1ae32a1SGerd Hoffmann case FTDI_ODD: 313f1ae32a1SGerd Hoffmann s->params.parity = 'O'; 314f1ae32a1SGerd Hoffmann break; 315f1ae32a1SGerd Hoffmann case FTDI_EVEN: 316f1ae32a1SGerd Hoffmann s->params.parity = 'E'; 317f1ae32a1SGerd Hoffmann break; 318f1ae32a1SGerd Hoffmann default: 319f1ae32a1SGerd Hoffmann DPRINTF("unsupported parity %d\n", value & FTDI_PARITY); 320f1ae32a1SGerd Hoffmann goto fail; 321f1ae32a1SGerd Hoffmann } 322f1ae32a1SGerd Hoffmann switch (value & FTDI_STOP) { 323f1ae32a1SGerd Hoffmann case FTDI_STOP1: 324f1ae32a1SGerd Hoffmann s->params.stop_bits = 1; 325f1ae32a1SGerd Hoffmann break; 326f1ae32a1SGerd Hoffmann case FTDI_STOP2: 327f1ae32a1SGerd Hoffmann s->params.stop_bits = 2; 328f1ae32a1SGerd Hoffmann break; 329f1ae32a1SGerd Hoffmann default: 330f1ae32a1SGerd Hoffmann DPRINTF("unsupported stop bits %d\n", value & FTDI_STOP); 331f1ae32a1SGerd Hoffmann goto fail; 332f1ae32a1SGerd Hoffmann } 3335345fdb4SMarc-André Lureau qemu_chr_fe_ioctl(&s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params); 334f1ae32a1SGerd Hoffmann /* TODO: TX ON/OFF */ 335f1ae32a1SGerd Hoffmann break; 336f1ae32a1SGerd Hoffmann case DeviceInVendor | FTDI_GET_MDM_ST: 337f1ae32a1SGerd Hoffmann data[0] = usb_get_modem_lines(s) | 1; 338647ee987SJason Andryuk data[1] = FTDI_THRE | FTDI_TEMT; 3399a77a0f5SHans de Goede p->actual_length = 2; 340f1ae32a1SGerd Hoffmann break; 341f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_EVENT_CHR: 342f1ae32a1SGerd Hoffmann /* TODO: handle it */ 343f1ae32a1SGerd Hoffmann s->event_chr = value; 344f1ae32a1SGerd Hoffmann break; 345f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_ERROR_CHR: 346f1ae32a1SGerd Hoffmann /* TODO: handle it */ 347f1ae32a1SGerd Hoffmann s->error_chr = value; 348f1ae32a1SGerd Hoffmann break; 349f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_LATENCY: 350f1ae32a1SGerd Hoffmann s->latency = value; 351f1ae32a1SGerd Hoffmann break; 352f1ae32a1SGerd Hoffmann case DeviceInVendor | FTDI_GET_LATENCY: 353f1ae32a1SGerd Hoffmann data[0] = s->latency; 3549a77a0f5SHans de Goede p->actual_length = 1; 355f1ae32a1SGerd Hoffmann break; 356f1ae32a1SGerd Hoffmann default: 357f1ae32a1SGerd Hoffmann fail: 358f1ae32a1SGerd Hoffmann DPRINTF("got unsupported/bogus control %x, value %x\n", request, value); 3599a77a0f5SHans de Goede p->status = USB_RET_STALL; 360f1ae32a1SGerd Hoffmann break; 361f1ae32a1SGerd Hoffmann } 362f1ae32a1SGerd Hoffmann } 363f1ae32a1SGerd Hoffmann 3642bcf4e9fSJason Andryuk static void usb_serial_token_in(USBSerialState *s, USBPacket *p) 3652bcf4e9fSJason Andryuk { 36687db78f7SJason Andryuk const int max_packet_size = desc_iface0.eps[0].wMaxPacketSize; 36787db78f7SJason Andryuk int packet_len; 3682bcf4e9fSJason Andryuk uint8_t header[2]; 3692bcf4e9fSJason Andryuk 37087db78f7SJason Andryuk packet_len = p->iov.size; 37187db78f7SJason Andryuk if (packet_len <= 2) { 3722bcf4e9fSJason Andryuk p->status = USB_RET_NAK; 3732bcf4e9fSJason Andryuk return; 3742bcf4e9fSJason Andryuk } 37587db78f7SJason Andryuk 3762bcf4e9fSJason Andryuk header[0] = usb_get_modem_lines(s) | 1; 3772bcf4e9fSJason Andryuk /* We do not have the uart details */ 3782bcf4e9fSJason Andryuk /* handle serial break */ 3792bcf4e9fSJason Andryuk if (s->event_trigger && s->event_trigger & FTDI_BI) { 3802bcf4e9fSJason Andryuk s->event_trigger &= ~FTDI_BI; 3812bcf4e9fSJason Andryuk header[1] = FTDI_BI; 3822bcf4e9fSJason Andryuk usb_packet_copy(p, header, 2); 3832bcf4e9fSJason Andryuk return; 3842bcf4e9fSJason Andryuk } else { 3852bcf4e9fSJason Andryuk header[1] = 0; 3862bcf4e9fSJason Andryuk } 38787db78f7SJason Andryuk 38887db78f7SJason Andryuk if (!s->recv_used) { 38987db78f7SJason Andryuk p->status = USB_RET_NAK; 39087db78f7SJason Andryuk return; 39187db78f7SJason Andryuk } 39287db78f7SJason Andryuk 39387db78f7SJason Andryuk while (s->recv_used && packet_len > 2) { 39487db78f7SJason Andryuk int first_len, len; 39587db78f7SJason Andryuk 39687db78f7SJason Andryuk len = MIN(packet_len, max_packet_size); 3972bcf4e9fSJason Andryuk len -= 2; 3982bcf4e9fSJason Andryuk if (len > s->recv_used) { 3992bcf4e9fSJason Andryuk len = s->recv_used; 4002bcf4e9fSJason Andryuk } 40187db78f7SJason Andryuk 40287db78f7SJason Andryuk first_len = RECV_BUF - s->recv_ptr; 4032bcf4e9fSJason Andryuk if (first_len > len) { 4042bcf4e9fSJason Andryuk first_len = len; 4052bcf4e9fSJason Andryuk } 4062bcf4e9fSJason Andryuk usb_packet_copy(p, header, 2); 4072bcf4e9fSJason Andryuk usb_packet_copy(p, s->recv_buf + s->recv_ptr, first_len); 4082bcf4e9fSJason Andryuk if (len > first_len) { 4092bcf4e9fSJason Andryuk usb_packet_copy(p, s->recv_buf, len - first_len); 4102bcf4e9fSJason Andryuk } 4112bcf4e9fSJason Andryuk s->recv_used -= len; 4122bcf4e9fSJason Andryuk s->recv_ptr = (s->recv_ptr + len) % RECV_BUF; 41387db78f7SJason Andryuk packet_len -= len + 2; 41487db78f7SJason Andryuk } 4152bcf4e9fSJason Andryuk 4162bcf4e9fSJason Andryuk return; 4172bcf4e9fSJason Andryuk } 4182bcf4e9fSJason Andryuk 4199a77a0f5SHans de Goede static void usb_serial_handle_data(USBDevice *dev, USBPacket *p) 420f1ae32a1SGerd Hoffmann { 421f1ae32a1SGerd Hoffmann USBSerialState *s = (USBSerialState *)dev; 422f1ae32a1SGerd Hoffmann uint8_t devep = p->ep->nr; 423f1ae32a1SGerd Hoffmann struct iovec *iov; 4242bcf4e9fSJason Andryuk int i; 425f1ae32a1SGerd Hoffmann 426f1ae32a1SGerd Hoffmann switch (p->pid) { 427f1ae32a1SGerd Hoffmann case USB_TOKEN_OUT: 428f1ae32a1SGerd Hoffmann if (devep != 2) 429f1ae32a1SGerd Hoffmann goto fail; 430f1ae32a1SGerd Hoffmann for (i = 0; i < p->iov.niov; i++) { 431f1ae32a1SGerd Hoffmann iov = p->iov.iov + i; 4326ab3fc32SDaniel P. Berrange /* XXX this blocks entire thread. Rewrite to use 4336ab3fc32SDaniel P. Berrange * qemu_chr_fe_write and background I/O callbacks */ 4345345fdb4SMarc-André Lureau qemu_chr_fe_write_all(&s->cs, iov->iov_base, iov->iov_len); 435f1ae32a1SGerd Hoffmann } 4369a77a0f5SHans de Goede p->actual_length = p->iov.size; 437f1ae32a1SGerd Hoffmann break; 438f1ae32a1SGerd Hoffmann 439f1ae32a1SGerd Hoffmann case USB_TOKEN_IN: 440f1ae32a1SGerd Hoffmann if (devep != 1) 441f1ae32a1SGerd Hoffmann goto fail; 4422bcf4e9fSJason Andryuk usb_serial_token_in(s, p); 443f1ae32a1SGerd Hoffmann break; 444f1ae32a1SGerd Hoffmann 445f1ae32a1SGerd Hoffmann default: 446f1ae32a1SGerd Hoffmann DPRINTF("Bad token\n"); 447f1ae32a1SGerd Hoffmann fail: 4489a77a0f5SHans de Goede p->status = USB_RET_STALL; 449f1ae32a1SGerd Hoffmann break; 450f1ae32a1SGerd Hoffmann } 451f1ae32a1SGerd Hoffmann } 452f1ae32a1SGerd Hoffmann 453f1ae32a1SGerd Hoffmann static int usb_serial_can_read(void *opaque) 454f1ae32a1SGerd Hoffmann { 455f1ae32a1SGerd Hoffmann USBSerialState *s = opaque; 456da124e62SGerd Hoffmann 457da124e62SGerd Hoffmann if (!s->dev.attached) { 458da124e62SGerd Hoffmann return 0; 459da124e62SGerd Hoffmann } 460f1ae32a1SGerd Hoffmann return RECV_BUF - s->recv_used; 461f1ae32a1SGerd Hoffmann } 462f1ae32a1SGerd Hoffmann 463f1ae32a1SGerd Hoffmann static void usb_serial_read(void *opaque, const uint8_t *buf, int size) 464f1ae32a1SGerd Hoffmann { 465f1ae32a1SGerd Hoffmann USBSerialState *s = opaque; 466f1ae32a1SGerd Hoffmann int first_size, start; 467f1ae32a1SGerd Hoffmann 468f1ae32a1SGerd Hoffmann /* room in the buffer? */ 469f1ae32a1SGerd Hoffmann if (size > (RECV_BUF - s->recv_used)) 470f1ae32a1SGerd Hoffmann size = RECV_BUF - s->recv_used; 471f1ae32a1SGerd Hoffmann 472f1ae32a1SGerd Hoffmann start = s->recv_ptr + s->recv_used; 473f1ae32a1SGerd Hoffmann if (start < RECV_BUF) { 474f1ae32a1SGerd Hoffmann /* copy data to end of buffer */ 475f1ae32a1SGerd Hoffmann first_size = RECV_BUF - start; 476f1ae32a1SGerd Hoffmann if (first_size > size) 477f1ae32a1SGerd Hoffmann first_size = size; 478f1ae32a1SGerd Hoffmann 479f1ae32a1SGerd Hoffmann memcpy(s->recv_buf + start, buf, first_size); 480f1ae32a1SGerd Hoffmann 481f1ae32a1SGerd Hoffmann /* wrap around to front if needed */ 482f1ae32a1SGerd Hoffmann if (size > first_size) 483f1ae32a1SGerd Hoffmann memcpy(s->recv_buf, buf + first_size, size - first_size); 484f1ae32a1SGerd Hoffmann } else { 485f1ae32a1SGerd Hoffmann start -= RECV_BUF; 486f1ae32a1SGerd Hoffmann memcpy(s->recv_buf + start, buf, size); 487f1ae32a1SGerd Hoffmann } 488f1ae32a1SGerd Hoffmann s->recv_used += size; 4895843b6b3SJason Andryuk 4905843b6b3SJason Andryuk usb_wakeup(s->intr, 0); 491f1ae32a1SGerd Hoffmann } 492f1ae32a1SGerd Hoffmann 493083b266fSPhilippe Mathieu-Daudé static void usb_serial_event(void *opaque, QEMUChrEvent event) 494f1ae32a1SGerd Hoffmann { 495f1ae32a1SGerd Hoffmann USBSerialState *s = opaque; 496f1ae32a1SGerd Hoffmann 497f1ae32a1SGerd Hoffmann switch (event) { 498f1ae32a1SGerd Hoffmann case CHR_EVENT_BREAK: 499f1ae32a1SGerd Hoffmann s->event_trigger |= FTDI_BI; 500f1ae32a1SGerd Hoffmann break; 501f1ae32a1SGerd Hoffmann case CHR_EVENT_OPENED: 502da124e62SGerd Hoffmann if (!s->dev.attached) { 5037334d650SGonglei usb_device_attach(&s->dev, &error_abort); 504da124e62SGerd Hoffmann } 505da124e62SGerd Hoffmann break; 506da124e62SGerd Hoffmann case CHR_EVENT_CLOSED: 507da124e62SGerd Hoffmann if (s->dev.attached) { 508da124e62SGerd Hoffmann usb_device_detach(&s->dev); 509da124e62SGerd Hoffmann } 510f1ae32a1SGerd Hoffmann break; 511c263158eSPhilippe Mathieu-Daudé case CHR_EVENT_MUX_IN: 512c263158eSPhilippe Mathieu-Daudé case CHR_EVENT_MUX_OUT: 513c263158eSPhilippe Mathieu-Daudé /* Ignore */ 514c263158eSPhilippe Mathieu-Daudé break; 515f1ae32a1SGerd Hoffmann } 516f1ae32a1SGerd Hoffmann } 517f1ae32a1SGerd Hoffmann 51838fff2c9SGonglei static void usb_serial_realize(USBDevice *dev, Error **errp) 519f1ae32a1SGerd Hoffmann { 520*bdd5f27eSEduardo Habkost USBSerialState *s = USB_SERIAL(dev); 5217334d650SGonglei Error *local_err = NULL; 522f1ae32a1SGerd Hoffmann 5239d55d1adSGerd Hoffmann usb_desc_create_serial(dev); 524f1ae32a1SGerd Hoffmann usb_desc_init(dev); 525da124e62SGerd Hoffmann dev->auto_attach = 0; 526f1ae32a1SGerd Hoffmann 52730650701SAnton Nefedov if (!qemu_chr_fe_backend_connected(&s->cs)) { 52838fff2c9SGonglei error_setg(errp, "Property chardev is required"); 52938fff2c9SGonglei return; 530f1ae32a1SGerd Hoffmann } 531f1ae32a1SGerd Hoffmann 5327334d650SGonglei usb_check_attach(dev, &local_err); 5337334d650SGonglei if (local_err) { 5347334d650SGonglei error_propagate(errp, local_err); 5357334d650SGonglei return; 5367334d650SGonglei } 5377334d650SGonglei 5385345fdb4SMarc-André Lureau qemu_chr_fe_set_handlers(&s->cs, usb_serial_can_read, usb_serial_read, 53981517ba3SAnton Nefedov usb_serial_event, NULL, s, NULL, true); 540f1ae32a1SGerd Hoffmann usb_serial_handle_reset(dev); 541da124e62SGerd Hoffmann 54230650701SAnton Nefedov if (qemu_chr_fe_backend_open(&s->cs) && !dev->attached) { 5437334d650SGonglei usb_device_attach(dev, &error_abort); 5447d553f27SGonglei } 5455843b6b3SJason Andryuk s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1); 546da124e62SGerd Hoffmann } 547f1ae32a1SGerd Hoffmann 548590ce74aSMarkus Armbruster static USBDevice *usb_braille_init(const char *unused) 549f1ae32a1SGerd Hoffmann { 550f1ae32a1SGerd Hoffmann USBDevice *dev; 5510ec7b3e7SMarc-André Lureau Chardev *cdrv; 552f1ae32a1SGerd Hoffmann 5534ad6f6cbSPaolo Bonzini cdrv = qemu_chr_new("braille", "braille", NULL); 554f1ae32a1SGerd Hoffmann if (!cdrv) 555f1ae32a1SGerd Hoffmann return NULL; 556f1ae32a1SGerd Hoffmann 557590ce74aSMarkus Armbruster dev = usb_new("usb-braille"); 558f1ae32a1SGerd Hoffmann qdev_prop_set_chr(&dev->qdev, "chardev", cdrv); 559f1ae32a1SGerd Hoffmann return dev; 560f1ae32a1SGerd Hoffmann } 561f1ae32a1SGerd Hoffmann 562f1ae32a1SGerd Hoffmann static const VMStateDescription vmstate_usb_serial = { 563f1ae32a1SGerd Hoffmann .name = "usb-serial", 564f1ae32a1SGerd Hoffmann .unmigratable = 1, 565f1ae32a1SGerd Hoffmann }; 566f1ae32a1SGerd Hoffmann 567f1ae32a1SGerd Hoffmann static Property serial_properties[] = { 568f1ae32a1SGerd Hoffmann DEFINE_PROP_CHR("chardev", USBSerialState, cs), 569f1ae32a1SGerd Hoffmann DEFINE_PROP_END_OF_LIST(), 570f1ae32a1SGerd Hoffmann }; 571f1ae32a1SGerd Hoffmann 572cdf0d769SGonglei static void usb_serial_dev_class_init(ObjectClass *klass, void *data) 573f1ae32a1SGerd Hoffmann { 574f1ae32a1SGerd Hoffmann DeviceClass *dc = DEVICE_CLASS(klass); 575f1ae32a1SGerd Hoffmann USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 576f1ae32a1SGerd Hoffmann 57738fff2c9SGonglei uc->realize = usb_serial_realize; 578f1ae32a1SGerd Hoffmann uc->handle_reset = usb_serial_handle_reset; 579f1ae32a1SGerd Hoffmann uc->handle_control = usb_serial_handle_control; 580f1ae32a1SGerd Hoffmann uc->handle_data = usb_serial_handle_data; 581f1ae32a1SGerd Hoffmann dc->vmsd = &vmstate_usb_serial; 582125ee0edSMarcel Apfelbaum set_bit(DEVICE_CATEGORY_INPUT, dc->categories); 583f1ae32a1SGerd Hoffmann } 584f1ae32a1SGerd Hoffmann 585cdf0d769SGonglei static const TypeInfo usb_serial_dev_type_info = { 586cdf0d769SGonglei .name = TYPE_USB_SERIAL, 587cdf0d769SGonglei .parent = TYPE_USB_DEVICE, 588cdf0d769SGonglei .instance_size = sizeof(USBSerialState), 589cdf0d769SGonglei .abstract = true, 590cdf0d769SGonglei .class_init = usb_serial_dev_class_init, 591cdf0d769SGonglei }; 592cdf0d769SGonglei 593cdf0d769SGonglei static void usb_serial_class_initfn(ObjectClass *klass, void *data) 594cdf0d769SGonglei { 595cdf0d769SGonglei DeviceClass *dc = DEVICE_CLASS(klass); 596cdf0d769SGonglei USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 597cdf0d769SGonglei 598cdf0d769SGonglei uc->product_desc = "QEMU USB Serial"; 599cdf0d769SGonglei uc->usb_desc = &desc_serial; 6004f67d30bSMarc-André Lureau device_class_set_props(dc, serial_properties); 601cdf0d769SGonglei } 602cdf0d769SGonglei 6038c43a6f0SAndreas Färber static const TypeInfo serial_info = { 604f1ae32a1SGerd Hoffmann .name = "usb-serial", 605cdf0d769SGonglei .parent = TYPE_USB_SERIAL, 606f1ae32a1SGerd Hoffmann .class_init = usb_serial_class_initfn, 607f1ae32a1SGerd Hoffmann }; 608f1ae32a1SGerd Hoffmann 609f1ae32a1SGerd Hoffmann static Property braille_properties[] = { 610f1ae32a1SGerd Hoffmann DEFINE_PROP_CHR("chardev", USBSerialState, cs), 611f1ae32a1SGerd Hoffmann DEFINE_PROP_END_OF_LIST(), 612f1ae32a1SGerd Hoffmann }; 613f1ae32a1SGerd Hoffmann 614f1ae32a1SGerd Hoffmann static void usb_braille_class_initfn(ObjectClass *klass, void *data) 615f1ae32a1SGerd Hoffmann { 616f1ae32a1SGerd Hoffmann DeviceClass *dc = DEVICE_CLASS(klass); 617f1ae32a1SGerd Hoffmann USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 618f1ae32a1SGerd Hoffmann 619f1ae32a1SGerd Hoffmann uc->product_desc = "QEMU USB Braille"; 620f1ae32a1SGerd Hoffmann uc->usb_desc = &desc_braille; 6214f67d30bSMarc-André Lureau device_class_set_props(dc, braille_properties); 622f1ae32a1SGerd Hoffmann } 623f1ae32a1SGerd Hoffmann 6248c43a6f0SAndreas Färber static const TypeInfo braille_info = { 625f1ae32a1SGerd Hoffmann .name = "usb-braille", 626cdf0d769SGonglei .parent = TYPE_USB_SERIAL, 627f1ae32a1SGerd Hoffmann .class_init = usb_braille_class_initfn, 628f1ae32a1SGerd Hoffmann }; 629f1ae32a1SGerd Hoffmann 630f1ae32a1SGerd Hoffmann static void usb_serial_register_types(void) 631f1ae32a1SGerd Hoffmann { 632cdf0d769SGonglei type_register_static(&usb_serial_dev_type_info); 633f1ae32a1SGerd Hoffmann type_register_static(&serial_info); 634f1ae32a1SGerd Hoffmann type_register_static(&braille_info); 635f1ae32a1SGerd Hoffmann usb_legacy_register("usb-braille", "braille", usb_braille_init); 636f1ae32a1SGerd Hoffmann } 637f1ae32a1SGerd Hoffmann 638f1ae32a1SGerd Hoffmann type_init(usb_serial_register_types) 639