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" 13f1ae32a1SGerd Hoffmann #include "qemu-common.h" 14f348b6d1SVeronia Bahaa #include "qemu/cutils.h" 15d49b6836SMarkus Armbruster #include "qemu/error-report.h" 16f1ae32a1SGerd Hoffmann #include "hw/usb.h" 17f1ae32a1SGerd Hoffmann #include "hw/usb/desc.h" 18dccfcd0eSPaolo Bonzini #include "sysemu/char.h" 19f1ae32a1SGerd Hoffmann 20f1ae32a1SGerd Hoffmann //#define DEBUG_Serial 21f1ae32a1SGerd Hoffmann 22f1ae32a1SGerd Hoffmann #ifdef DEBUG_Serial 23f1ae32a1SGerd Hoffmann #define DPRINTF(fmt, ...) \ 24f1ae32a1SGerd Hoffmann do { printf("usb-serial: " fmt , ## __VA_ARGS__); } while (0) 25f1ae32a1SGerd Hoffmann #else 26f1ae32a1SGerd Hoffmann #define DPRINTF(fmt, ...) do {} while(0) 27f1ae32a1SGerd Hoffmann #endif 28f1ae32a1SGerd Hoffmann 29f1ae32a1SGerd Hoffmann #define RECV_BUF 384 30f1ae32a1SGerd Hoffmann 31f1ae32a1SGerd Hoffmann /* Commands */ 32f1ae32a1SGerd Hoffmann #define FTDI_RESET 0 33f1ae32a1SGerd Hoffmann #define FTDI_SET_MDM_CTRL 1 34f1ae32a1SGerd Hoffmann #define FTDI_SET_FLOW_CTRL 2 35f1ae32a1SGerd Hoffmann #define FTDI_SET_BAUD 3 36f1ae32a1SGerd Hoffmann #define FTDI_SET_DATA 4 37f1ae32a1SGerd Hoffmann #define FTDI_GET_MDM_ST 5 38f1ae32a1SGerd Hoffmann #define FTDI_SET_EVENT_CHR 6 39f1ae32a1SGerd Hoffmann #define FTDI_SET_ERROR_CHR 7 40f1ae32a1SGerd Hoffmann #define FTDI_SET_LATENCY 9 41f1ae32a1SGerd Hoffmann #define FTDI_GET_LATENCY 10 42f1ae32a1SGerd Hoffmann 43f1ae32a1SGerd Hoffmann #define DeviceOutVendor ((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8) 44f1ae32a1SGerd Hoffmann #define DeviceInVendor ((USB_DIR_IN |USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8) 45f1ae32a1SGerd Hoffmann 46f1ae32a1SGerd Hoffmann /* RESET */ 47f1ae32a1SGerd Hoffmann 48f1ae32a1SGerd Hoffmann #define FTDI_RESET_SIO 0 49f1ae32a1SGerd Hoffmann #define FTDI_RESET_RX 1 50f1ae32a1SGerd Hoffmann #define FTDI_RESET_TX 2 51f1ae32a1SGerd Hoffmann 52f1ae32a1SGerd Hoffmann /* SET_MDM_CTRL */ 53f1ae32a1SGerd Hoffmann 54f1ae32a1SGerd Hoffmann #define FTDI_DTR 1 55f1ae32a1SGerd Hoffmann #define FTDI_SET_DTR (FTDI_DTR << 8) 56f1ae32a1SGerd Hoffmann #define FTDI_RTS 2 57f1ae32a1SGerd Hoffmann #define FTDI_SET_RTS (FTDI_RTS << 8) 58f1ae32a1SGerd Hoffmann 59f1ae32a1SGerd Hoffmann /* SET_FLOW_CTRL */ 60f1ae32a1SGerd Hoffmann 61f1ae32a1SGerd Hoffmann #define FTDI_RTS_CTS_HS 1 62f1ae32a1SGerd Hoffmann #define FTDI_DTR_DSR_HS 2 63f1ae32a1SGerd Hoffmann #define FTDI_XON_XOFF_HS 4 64f1ae32a1SGerd Hoffmann 65f1ae32a1SGerd Hoffmann /* SET_DATA */ 66f1ae32a1SGerd Hoffmann 67f1ae32a1SGerd Hoffmann #define FTDI_PARITY (0x7 << 8) 68f1ae32a1SGerd Hoffmann #define FTDI_ODD (0x1 << 8) 69f1ae32a1SGerd Hoffmann #define FTDI_EVEN (0x2 << 8) 70f1ae32a1SGerd Hoffmann #define FTDI_MARK (0x3 << 8) 71f1ae32a1SGerd Hoffmann #define FTDI_SPACE (0x4 << 8) 72f1ae32a1SGerd Hoffmann 73f1ae32a1SGerd Hoffmann #define FTDI_STOP (0x3 << 11) 74f1ae32a1SGerd Hoffmann #define FTDI_STOP1 (0x0 << 11) 75f1ae32a1SGerd Hoffmann #define FTDI_STOP15 (0x1 << 11) 76f1ae32a1SGerd Hoffmann #define FTDI_STOP2 (0x2 << 11) 77f1ae32a1SGerd Hoffmann 78f1ae32a1SGerd Hoffmann /* GET_MDM_ST */ 79f1ae32a1SGerd Hoffmann /* TODO: should be sent every 40ms */ 80f1ae32a1SGerd Hoffmann #define FTDI_CTS (1<<4) // CTS line status 81f1ae32a1SGerd Hoffmann #define FTDI_DSR (1<<5) // DSR line status 82f1ae32a1SGerd Hoffmann #define FTDI_RI (1<<6) // RI line status 83f1ae32a1SGerd Hoffmann #define FTDI_RLSD (1<<7) // Receive Line Signal Detect 84f1ae32a1SGerd Hoffmann 85f1ae32a1SGerd Hoffmann /* Status */ 86f1ae32a1SGerd Hoffmann 87f1ae32a1SGerd Hoffmann #define FTDI_DR (1<<0) // Data Ready 88f1ae32a1SGerd Hoffmann #define FTDI_OE (1<<1) // Overrun Err 89f1ae32a1SGerd Hoffmann #define FTDI_PE (1<<2) // Parity Err 90f1ae32a1SGerd Hoffmann #define FTDI_FE (1<<3) // Framing Err 91f1ae32a1SGerd Hoffmann #define FTDI_BI (1<<4) // Break Interrupt 92f1ae32a1SGerd Hoffmann #define FTDI_THRE (1<<5) // Transmitter Holding Register 93f1ae32a1SGerd Hoffmann #define FTDI_TEMT (1<<6) // Transmitter Empty 94f1ae32a1SGerd Hoffmann #define FTDI_FIFO (1<<7) // Error in FIFO 95f1ae32a1SGerd Hoffmann 96f1ae32a1SGerd Hoffmann typedef struct { 97f1ae32a1SGerd Hoffmann USBDevice dev; 98f1ae32a1SGerd Hoffmann uint8_t recv_buf[RECV_BUF]; 99f1ae32a1SGerd Hoffmann uint16_t recv_ptr; 100f1ae32a1SGerd Hoffmann uint16_t recv_used; 101f1ae32a1SGerd Hoffmann uint8_t event_chr; 102f1ae32a1SGerd Hoffmann uint8_t error_chr; 103f1ae32a1SGerd Hoffmann uint8_t event_trigger; 104f1ae32a1SGerd Hoffmann QEMUSerialSetParams params; 105f1ae32a1SGerd Hoffmann int latency; /* ms */ 106*becdfa00SMarc-André Lureau CharBackend cs; 107f1ae32a1SGerd Hoffmann } USBSerialState; 108f1ae32a1SGerd Hoffmann 109cdf0d769SGonglei #define TYPE_USB_SERIAL "usb-serial-dev" 110cdf0d769SGonglei #define USB_SERIAL_DEV(obj) OBJECT_CHECK(USBSerialState, (obj), TYPE_USB_SERIAL) 111cdf0d769SGonglei 112f1ae32a1SGerd Hoffmann enum { 113f1ae32a1SGerd Hoffmann STR_MANUFACTURER = 1, 114f1ae32a1SGerd Hoffmann STR_PRODUCT_SERIAL, 115f1ae32a1SGerd Hoffmann STR_PRODUCT_BRAILLE, 116f1ae32a1SGerd Hoffmann STR_SERIALNUMBER, 117f1ae32a1SGerd Hoffmann }; 118f1ae32a1SGerd Hoffmann 119f1ae32a1SGerd Hoffmann static const USBDescStrings desc_strings = { 12093bfef4cSCrístian Viana [STR_MANUFACTURER] = "QEMU", 121f1ae32a1SGerd Hoffmann [STR_PRODUCT_SERIAL] = "QEMU USB SERIAL", 1222964cd9bSSamuel Thibault [STR_PRODUCT_BRAILLE] = "QEMU USB BAUM BRAILLE", 123f1ae32a1SGerd Hoffmann [STR_SERIALNUMBER] = "1", 124f1ae32a1SGerd Hoffmann }; 125f1ae32a1SGerd Hoffmann 126f1ae32a1SGerd Hoffmann static const USBDescIface desc_iface0 = { 127f1ae32a1SGerd Hoffmann .bInterfaceNumber = 0, 128f1ae32a1SGerd Hoffmann .bNumEndpoints = 2, 129f1ae32a1SGerd Hoffmann .bInterfaceClass = 0xff, 130f1ae32a1SGerd Hoffmann .bInterfaceSubClass = 0xff, 131f1ae32a1SGerd Hoffmann .bInterfaceProtocol = 0xff, 132f1ae32a1SGerd Hoffmann .eps = (USBDescEndpoint[]) { 133f1ae32a1SGerd Hoffmann { 134f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_IN | 0x01, 135f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_BULK, 136f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64, 137f1ae32a1SGerd Hoffmann },{ 138f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_OUT | 0x02, 139f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_BULK, 140f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64, 141f1ae32a1SGerd Hoffmann }, 142f1ae32a1SGerd Hoffmann } 143f1ae32a1SGerd Hoffmann }; 144f1ae32a1SGerd Hoffmann 145f1ae32a1SGerd Hoffmann static const USBDescDevice desc_device = { 146f1ae32a1SGerd Hoffmann .bcdUSB = 0x0200, 147f1ae32a1SGerd Hoffmann .bMaxPacketSize0 = 8, 148f1ae32a1SGerd Hoffmann .bNumConfigurations = 1, 149f1ae32a1SGerd Hoffmann .confs = (USBDescConfig[]) { 150f1ae32a1SGerd Hoffmann { 151f1ae32a1SGerd Hoffmann .bNumInterfaces = 1, 152f1ae32a1SGerd Hoffmann .bConfigurationValue = 1, 153bd93976aSPantelis Koukousoulas .bmAttributes = USB_CFG_ATT_ONE, 154f1ae32a1SGerd Hoffmann .bMaxPower = 50, 155f1ae32a1SGerd Hoffmann .nif = 1, 156f1ae32a1SGerd Hoffmann .ifs = &desc_iface0, 157f1ae32a1SGerd Hoffmann }, 158f1ae32a1SGerd Hoffmann }, 159f1ae32a1SGerd Hoffmann }; 160f1ae32a1SGerd Hoffmann 161f1ae32a1SGerd Hoffmann static const USBDesc desc_serial = { 162f1ae32a1SGerd Hoffmann .id = { 163f1ae32a1SGerd Hoffmann .idVendor = 0x0403, 164f1ae32a1SGerd Hoffmann .idProduct = 0x6001, 165f1ae32a1SGerd Hoffmann .bcdDevice = 0x0400, 166f1ae32a1SGerd Hoffmann .iManufacturer = STR_MANUFACTURER, 167f1ae32a1SGerd Hoffmann .iProduct = STR_PRODUCT_SERIAL, 168f1ae32a1SGerd Hoffmann .iSerialNumber = STR_SERIALNUMBER, 169f1ae32a1SGerd Hoffmann }, 170f1ae32a1SGerd Hoffmann .full = &desc_device, 171f1ae32a1SGerd Hoffmann .str = desc_strings, 172f1ae32a1SGerd Hoffmann }; 173f1ae32a1SGerd Hoffmann 174f1ae32a1SGerd Hoffmann static const USBDesc desc_braille = { 175f1ae32a1SGerd Hoffmann .id = { 176f1ae32a1SGerd Hoffmann .idVendor = 0x0403, 177f1ae32a1SGerd Hoffmann .idProduct = 0xfe72, 178f1ae32a1SGerd Hoffmann .bcdDevice = 0x0400, 179f1ae32a1SGerd Hoffmann .iManufacturer = STR_MANUFACTURER, 180f1ae32a1SGerd Hoffmann .iProduct = STR_PRODUCT_BRAILLE, 181f1ae32a1SGerd Hoffmann .iSerialNumber = STR_SERIALNUMBER, 182f1ae32a1SGerd Hoffmann }, 183f1ae32a1SGerd Hoffmann .full = &desc_device, 184f1ae32a1SGerd Hoffmann .str = desc_strings, 185f1ae32a1SGerd Hoffmann }; 186f1ae32a1SGerd Hoffmann 187f1ae32a1SGerd Hoffmann static void usb_serial_reset(USBSerialState *s) 188f1ae32a1SGerd Hoffmann { 189f1ae32a1SGerd Hoffmann /* TODO: Set flow control to none */ 190f1ae32a1SGerd Hoffmann s->event_chr = 0x0d; 191f1ae32a1SGerd Hoffmann s->event_trigger = 0; 192f1ae32a1SGerd Hoffmann s->recv_ptr = 0; 193f1ae32a1SGerd Hoffmann s->recv_used = 0; 194f1ae32a1SGerd Hoffmann /* TODO: purge in char driver */ 195f1ae32a1SGerd Hoffmann } 196f1ae32a1SGerd Hoffmann 197f1ae32a1SGerd Hoffmann static void usb_serial_handle_reset(USBDevice *dev) 198f1ae32a1SGerd Hoffmann { 199f1ae32a1SGerd Hoffmann USBSerialState *s = (USBSerialState *)dev; 200f1ae32a1SGerd Hoffmann 201f1ae32a1SGerd Hoffmann DPRINTF("Reset\n"); 202f1ae32a1SGerd Hoffmann 203f1ae32a1SGerd Hoffmann usb_serial_reset(s); 204f1ae32a1SGerd Hoffmann /* TODO: Reset char device, send BREAK? */ 205f1ae32a1SGerd Hoffmann } 206f1ae32a1SGerd Hoffmann 207f1ae32a1SGerd Hoffmann static uint8_t usb_get_modem_lines(USBSerialState *s) 208f1ae32a1SGerd Hoffmann { 209f1ae32a1SGerd Hoffmann int flags; 210f1ae32a1SGerd Hoffmann uint8_t ret; 211f1ae32a1SGerd Hoffmann 212*becdfa00SMarc-André Lureau if (qemu_chr_fe_ioctl(s->cs.chr, 213*becdfa00SMarc-André Lureau CHR_IOCTL_SERIAL_GET_TIOCM, &flags) == -ENOTSUP) { 214f1ae32a1SGerd Hoffmann return FTDI_CTS|FTDI_DSR|FTDI_RLSD; 215*becdfa00SMarc-André Lureau } 216f1ae32a1SGerd Hoffmann 217f1ae32a1SGerd Hoffmann ret = 0; 218f1ae32a1SGerd Hoffmann if (flags & CHR_TIOCM_CTS) 219f1ae32a1SGerd Hoffmann ret |= FTDI_CTS; 220f1ae32a1SGerd Hoffmann if (flags & CHR_TIOCM_DSR) 221f1ae32a1SGerd Hoffmann ret |= FTDI_DSR; 222f1ae32a1SGerd Hoffmann if (flags & CHR_TIOCM_RI) 223f1ae32a1SGerd Hoffmann ret |= FTDI_RI; 224f1ae32a1SGerd Hoffmann if (flags & CHR_TIOCM_CAR) 225f1ae32a1SGerd Hoffmann ret |= FTDI_RLSD; 226f1ae32a1SGerd Hoffmann 227f1ae32a1SGerd Hoffmann return ret; 228f1ae32a1SGerd Hoffmann } 229f1ae32a1SGerd Hoffmann 2309a77a0f5SHans de Goede static void usb_serial_handle_control(USBDevice *dev, USBPacket *p, 231f1ae32a1SGerd Hoffmann int request, int value, int index, int length, uint8_t *data) 232f1ae32a1SGerd Hoffmann { 233f1ae32a1SGerd Hoffmann USBSerialState *s = (USBSerialState *)dev; 234f1ae32a1SGerd Hoffmann int ret; 235f1ae32a1SGerd Hoffmann 236f1ae32a1SGerd Hoffmann DPRINTF("got control %x, value %x\n",request, value); 237f1ae32a1SGerd Hoffmann ret = usb_desc_handle_control(dev, p, request, value, index, length, data); 238f1ae32a1SGerd Hoffmann if (ret >= 0) { 2399a77a0f5SHans de Goede return; 240f1ae32a1SGerd Hoffmann } 241f1ae32a1SGerd Hoffmann 242f1ae32a1SGerd Hoffmann switch (request) { 243f1ae32a1SGerd Hoffmann case EndpointOutRequest | USB_REQ_CLEAR_FEATURE: 244f1ae32a1SGerd Hoffmann break; 245f1ae32a1SGerd Hoffmann 246f1ae32a1SGerd Hoffmann /* Class specific requests. */ 247f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_RESET: 248f1ae32a1SGerd Hoffmann switch (value) { 249f1ae32a1SGerd Hoffmann case FTDI_RESET_SIO: 250f1ae32a1SGerd Hoffmann usb_serial_reset(s); 251f1ae32a1SGerd Hoffmann break; 252f1ae32a1SGerd Hoffmann case FTDI_RESET_RX: 253f1ae32a1SGerd Hoffmann s->recv_ptr = 0; 254f1ae32a1SGerd Hoffmann s->recv_used = 0; 255f1ae32a1SGerd Hoffmann /* TODO: purge from char device */ 256f1ae32a1SGerd Hoffmann break; 257f1ae32a1SGerd Hoffmann case FTDI_RESET_TX: 258f1ae32a1SGerd Hoffmann /* TODO: purge from char device */ 259f1ae32a1SGerd Hoffmann break; 260f1ae32a1SGerd Hoffmann } 261f1ae32a1SGerd Hoffmann break; 262f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_MDM_CTRL: 263f1ae32a1SGerd Hoffmann { 264f1ae32a1SGerd Hoffmann static int flags; 265*becdfa00SMarc-André Lureau qemu_chr_fe_ioctl(s->cs.chr, CHR_IOCTL_SERIAL_GET_TIOCM, &flags); 266f1ae32a1SGerd Hoffmann if (value & FTDI_SET_RTS) { 267f1ae32a1SGerd Hoffmann if (value & FTDI_RTS) 268f1ae32a1SGerd Hoffmann flags |= CHR_TIOCM_RTS; 269f1ae32a1SGerd Hoffmann else 270f1ae32a1SGerd Hoffmann flags &= ~CHR_TIOCM_RTS; 271f1ae32a1SGerd Hoffmann } 272f1ae32a1SGerd Hoffmann if (value & FTDI_SET_DTR) { 273f1ae32a1SGerd Hoffmann if (value & FTDI_DTR) 274f1ae32a1SGerd Hoffmann flags |= CHR_TIOCM_DTR; 275f1ae32a1SGerd Hoffmann else 276f1ae32a1SGerd Hoffmann flags &= ~CHR_TIOCM_DTR; 277f1ae32a1SGerd Hoffmann } 278*becdfa00SMarc-André Lureau qemu_chr_fe_ioctl(s->cs.chr, CHR_IOCTL_SERIAL_SET_TIOCM, &flags); 279f1ae32a1SGerd Hoffmann break; 280f1ae32a1SGerd Hoffmann } 281f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_FLOW_CTRL: 282f1ae32a1SGerd Hoffmann /* TODO: ioctl */ 283f1ae32a1SGerd Hoffmann break; 284f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_BAUD: { 285f1ae32a1SGerd Hoffmann static const int subdivisors8[8] = { 0, 4, 2, 1, 3, 5, 6, 7 }; 286f1ae32a1SGerd Hoffmann int subdivisor8 = subdivisors8[((value & 0xc000) >> 14) 287f1ae32a1SGerd Hoffmann | ((index & 1) << 2)]; 288f1ae32a1SGerd Hoffmann int divisor = value & 0x3fff; 289f1ae32a1SGerd Hoffmann 290f1ae32a1SGerd Hoffmann /* chip special cases */ 291f1ae32a1SGerd Hoffmann if (divisor == 1 && subdivisor8 == 0) 292f1ae32a1SGerd Hoffmann subdivisor8 = 4; 293f1ae32a1SGerd Hoffmann if (divisor == 0 && subdivisor8 == 0) 294f1ae32a1SGerd Hoffmann divisor = 1; 295f1ae32a1SGerd Hoffmann 296f1ae32a1SGerd Hoffmann s->params.speed = (48000000 / 2) / (8 * divisor + subdivisor8); 297*becdfa00SMarc-André Lureau qemu_chr_fe_ioctl(s->cs.chr, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params); 298f1ae32a1SGerd Hoffmann break; 299f1ae32a1SGerd Hoffmann } 300f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_DATA: 301f1ae32a1SGerd Hoffmann switch (value & FTDI_PARITY) { 302f1ae32a1SGerd Hoffmann case 0: 303f1ae32a1SGerd Hoffmann s->params.parity = 'N'; 304f1ae32a1SGerd Hoffmann break; 305f1ae32a1SGerd Hoffmann case FTDI_ODD: 306f1ae32a1SGerd Hoffmann s->params.parity = 'O'; 307f1ae32a1SGerd Hoffmann break; 308f1ae32a1SGerd Hoffmann case FTDI_EVEN: 309f1ae32a1SGerd Hoffmann s->params.parity = 'E'; 310f1ae32a1SGerd Hoffmann break; 311f1ae32a1SGerd Hoffmann default: 312f1ae32a1SGerd Hoffmann DPRINTF("unsupported parity %d\n", value & FTDI_PARITY); 313f1ae32a1SGerd Hoffmann goto fail; 314f1ae32a1SGerd Hoffmann } 315f1ae32a1SGerd Hoffmann switch (value & FTDI_STOP) { 316f1ae32a1SGerd Hoffmann case FTDI_STOP1: 317f1ae32a1SGerd Hoffmann s->params.stop_bits = 1; 318f1ae32a1SGerd Hoffmann break; 319f1ae32a1SGerd Hoffmann case FTDI_STOP2: 320f1ae32a1SGerd Hoffmann s->params.stop_bits = 2; 321f1ae32a1SGerd Hoffmann break; 322f1ae32a1SGerd Hoffmann default: 323f1ae32a1SGerd Hoffmann DPRINTF("unsupported stop bits %d\n", value & FTDI_STOP); 324f1ae32a1SGerd Hoffmann goto fail; 325f1ae32a1SGerd Hoffmann } 326*becdfa00SMarc-André Lureau qemu_chr_fe_ioctl(s->cs.chr, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params); 327f1ae32a1SGerd Hoffmann /* TODO: TX ON/OFF */ 328f1ae32a1SGerd Hoffmann break; 329f1ae32a1SGerd Hoffmann case DeviceInVendor | FTDI_GET_MDM_ST: 330f1ae32a1SGerd Hoffmann data[0] = usb_get_modem_lines(s) | 1; 331f1ae32a1SGerd Hoffmann data[1] = 0; 3329a77a0f5SHans de Goede p->actual_length = 2; 333f1ae32a1SGerd Hoffmann break; 334f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_EVENT_CHR: 335f1ae32a1SGerd Hoffmann /* TODO: handle it */ 336f1ae32a1SGerd Hoffmann s->event_chr = value; 337f1ae32a1SGerd Hoffmann break; 338f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_ERROR_CHR: 339f1ae32a1SGerd Hoffmann /* TODO: handle it */ 340f1ae32a1SGerd Hoffmann s->error_chr = value; 341f1ae32a1SGerd Hoffmann break; 342f1ae32a1SGerd Hoffmann case DeviceOutVendor | FTDI_SET_LATENCY: 343f1ae32a1SGerd Hoffmann s->latency = value; 344f1ae32a1SGerd Hoffmann break; 345f1ae32a1SGerd Hoffmann case DeviceInVendor | FTDI_GET_LATENCY: 346f1ae32a1SGerd Hoffmann data[0] = s->latency; 3479a77a0f5SHans de Goede p->actual_length = 1; 348f1ae32a1SGerd Hoffmann break; 349f1ae32a1SGerd Hoffmann default: 350f1ae32a1SGerd Hoffmann fail: 351f1ae32a1SGerd Hoffmann DPRINTF("got unsupported/bogus control %x, value %x\n", request, value); 3529a77a0f5SHans de Goede p->status = USB_RET_STALL; 353f1ae32a1SGerd Hoffmann break; 354f1ae32a1SGerd Hoffmann } 355f1ae32a1SGerd Hoffmann } 356f1ae32a1SGerd Hoffmann 3579a77a0f5SHans de Goede static void usb_serial_handle_data(USBDevice *dev, USBPacket *p) 358f1ae32a1SGerd Hoffmann { 359f1ae32a1SGerd Hoffmann USBSerialState *s = (USBSerialState *)dev; 360f1ae32a1SGerd Hoffmann uint8_t devep = p->ep->nr; 361f1ae32a1SGerd Hoffmann struct iovec *iov; 362f1ae32a1SGerd Hoffmann uint8_t header[2]; 3639a77a0f5SHans de Goede int i, first_len, len; 364f1ae32a1SGerd Hoffmann 365f1ae32a1SGerd Hoffmann switch (p->pid) { 366f1ae32a1SGerd Hoffmann case USB_TOKEN_OUT: 367f1ae32a1SGerd Hoffmann if (devep != 2) 368f1ae32a1SGerd Hoffmann goto fail; 369f1ae32a1SGerd Hoffmann for (i = 0; i < p->iov.niov; i++) { 370f1ae32a1SGerd Hoffmann iov = p->iov.iov + i; 3716ab3fc32SDaniel P. Berrange /* XXX this blocks entire thread. Rewrite to use 3726ab3fc32SDaniel P. Berrange * qemu_chr_fe_write and background I/O callbacks */ 373*becdfa00SMarc-André Lureau qemu_chr_fe_write_all(s->cs.chr, iov->iov_base, iov->iov_len); 374f1ae32a1SGerd Hoffmann } 3759a77a0f5SHans de Goede p->actual_length = p->iov.size; 376f1ae32a1SGerd Hoffmann break; 377f1ae32a1SGerd Hoffmann 378f1ae32a1SGerd Hoffmann case USB_TOKEN_IN: 379f1ae32a1SGerd Hoffmann if (devep != 1) 380f1ae32a1SGerd Hoffmann goto fail; 381f1ae32a1SGerd Hoffmann first_len = RECV_BUF - s->recv_ptr; 382f1ae32a1SGerd Hoffmann len = p->iov.size; 383f1ae32a1SGerd Hoffmann if (len <= 2) { 3849a77a0f5SHans de Goede p->status = USB_RET_NAK; 385f1ae32a1SGerd Hoffmann break; 386f1ae32a1SGerd Hoffmann } 387f1ae32a1SGerd Hoffmann header[0] = usb_get_modem_lines(s) | 1; 388f1ae32a1SGerd Hoffmann /* We do not have the uart details */ 389f1ae32a1SGerd Hoffmann /* handle serial break */ 390f1ae32a1SGerd Hoffmann if (s->event_trigger && s->event_trigger & FTDI_BI) { 391f1ae32a1SGerd Hoffmann s->event_trigger &= ~FTDI_BI; 392f1ae32a1SGerd Hoffmann header[1] = FTDI_BI; 393f1ae32a1SGerd Hoffmann usb_packet_copy(p, header, 2); 394f1ae32a1SGerd Hoffmann break; 395f1ae32a1SGerd Hoffmann } else { 396f1ae32a1SGerd Hoffmann header[1] = 0; 397f1ae32a1SGerd Hoffmann } 398f1ae32a1SGerd Hoffmann len -= 2; 399f1ae32a1SGerd Hoffmann if (len > s->recv_used) 400f1ae32a1SGerd Hoffmann len = s->recv_used; 401f1ae32a1SGerd Hoffmann if (!len) { 4029a77a0f5SHans de Goede p->status = USB_RET_NAK; 403f1ae32a1SGerd Hoffmann break; 404f1ae32a1SGerd Hoffmann } 405f1ae32a1SGerd Hoffmann if (first_len > len) 406f1ae32a1SGerd Hoffmann first_len = len; 407f1ae32a1SGerd Hoffmann usb_packet_copy(p, header, 2); 408f1ae32a1SGerd Hoffmann usb_packet_copy(p, s->recv_buf + s->recv_ptr, first_len); 409f1ae32a1SGerd Hoffmann if (len > first_len) 410f1ae32a1SGerd Hoffmann usb_packet_copy(p, s->recv_buf, len - first_len); 411f1ae32a1SGerd Hoffmann s->recv_used -= len; 412f1ae32a1SGerd Hoffmann s->recv_ptr = (s->recv_ptr + len) % RECV_BUF; 413f1ae32a1SGerd Hoffmann break; 414f1ae32a1SGerd Hoffmann 415f1ae32a1SGerd Hoffmann default: 416f1ae32a1SGerd Hoffmann DPRINTF("Bad token\n"); 417f1ae32a1SGerd Hoffmann fail: 4189a77a0f5SHans de Goede p->status = USB_RET_STALL; 419f1ae32a1SGerd Hoffmann break; 420f1ae32a1SGerd Hoffmann } 421f1ae32a1SGerd Hoffmann } 422f1ae32a1SGerd Hoffmann 423f1ae32a1SGerd Hoffmann static int usb_serial_can_read(void *opaque) 424f1ae32a1SGerd Hoffmann { 425f1ae32a1SGerd Hoffmann USBSerialState *s = opaque; 426da124e62SGerd Hoffmann 427da124e62SGerd Hoffmann if (!s->dev.attached) { 428da124e62SGerd Hoffmann return 0; 429da124e62SGerd Hoffmann } 430f1ae32a1SGerd Hoffmann return RECV_BUF - s->recv_used; 431f1ae32a1SGerd Hoffmann } 432f1ae32a1SGerd Hoffmann 433f1ae32a1SGerd Hoffmann static void usb_serial_read(void *opaque, const uint8_t *buf, int size) 434f1ae32a1SGerd Hoffmann { 435f1ae32a1SGerd Hoffmann USBSerialState *s = opaque; 436f1ae32a1SGerd Hoffmann int first_size, start; 437f1ae32a1SGerd Hoffmann 438f1ae32a1SGerd Hoffmann /* room in the buffer? */ 439f1ae32a1SGerd Hoffmann if (size > (RECV_BUF - s->recv_used)) 440f1ae32a1SGerd Hoffmann size = RECV_BUF - s->recv_used; 441f1ae32a1SGerd Hoffmann 442f1ae32a1SGerd Hoffmann start = s->recv_ptr + s->recv_used; 443f1ae32a1SGerd Hoffmann if (start < RECV_BUF) { 444f1ae32a1SGerd Hoffmann /* copy data to end of buffer */ 445f1ae32a1SGerd Hoffmann first_size = RECV_BUF - start; 446f1ae32a1SGerd Hoffmann if (first_size > size) 447f1ae32a1SGerd Hoffmann first_size = size; 448f1ae32a1SGerd Hoffmann 449f1ae32a1SGerd Hoffmann memcpy(s->recv_buf + start, buf, first_size); 450f1ae32a1SGerd Hoffmann 451f1ae32a1SGerd Hoffmann /* wrap around to front if needed */ 452f1ae32a1SGerd Hoffmann if (size > first_size) 453f1ae32a1SGerd Hoffmann memcpy(s->recv_buf, buf + first_size, size - first_size); 454f1ae32a1SGerd Hoffmann } else { 455f1ae32a1SGerd Hoffmann start -= RECV_BUF; 456f1ae32a1SGerd Hoffmann memcpy(s->recv_buf + start, buf, size); 457f1ae32a1SGerd Hoffmann } 458f1ae32a1SGerd Hoffmann s->recv_used += size; 459f1ae32a1SGerd Hoffmann } 460f1ae32a1SGerd Hoffmann 461f1ae32a1SGerd Hoffmann static void usb_serial_event(void *opaque, int event) 462f1ae32a1SGerd Hoffmann { 463f1ae32a1SGerd Hoffmann USBSerialState *s = opaque; 464f1ae32a1SGerd Hoffmann 465f1ae32a1SGerd Hoffmann switch (event) { 466f1ae32a1SGerd Hoffmann case CHR_EVENT_BREAK: 467f1ae32a1SGerd Hoffmann s->event_trigger |= FTDI_BI; 468f1ae32a1SGerd Hoffmann break; 469f1ae32a1SGerd Hoffmann case CHR_EVENT_FOCUS: 470f1ae32a1SGerd Hoffmann break; 471f1ae32a1SGerd Hoffmann case CHR_EVENT_OPENED: 472da124e62SGerd Hoffmann if (!s->dev.attached) { 4737334d650SGonglei usb_device_attach(&s->dev, &error_abort); 474da124e62SGerd Hoffmann } 475da124e62SGerd Hoffmann break; 476da124e62SGerd Hoffmann case CHR_EVENT_CLOSED: 477da124e62SGerd Hoffmann if (s->dev.attached) { 478da124e62SGerd Hoffmann usb_device_detach(&s->dev); 479da124e62SGerd Hoffmann } 480f1ae32a1SGerd Hoffmann break; 481f1ae32a1SGerd Hoffmann } 482f1ae32a1SGerd Hoffmann } 483f1ae32a1SGerd Hoffmann 48438fff2c9SGonglei static void usb_serial_realize(USBDevice *dev, Error **errp) 485f1ae32a1SGerd Hoffmann { 486cdf0d769SGonglei USBSerialState *s = USB_SERIAL_DEV(dev); 4877334d650SGonglei Error *local_err = NULL; 488f1ae32a1SGerd Hoffmann 4899d55d1adSGerd Hoffmann usb_desc_create_serial(dev); 490f1ae32a1SGerd Hoffmann usb_desc_init(dev); 491da124e62SGerd Hoffmann dev->auto_attach = 0; 492f1ae32a1SGerd Hoffmann 493*becdfa00SMarc-André Lureau if (!s->cs.chr) { 49438fff2c9SGonglei error_setg(errp, "Property chardev is required"); 49538fff2c9SGonglei return; 496f1ae32a1SGerd Hoffmann } 497f1ae32a1SGerd Hoffmann 4987334d650SGonglei usb_check_attach(dev, &local_err); 4997334d650SGonglei if (local_err) { 5007334d650SGonglei error_propagate(errp, local_err); 5017334d650SGonglei return; 5027334d650SGonglei } 5037334d650SGonglei 504*becdfa00SMarc-André Lureau qemu_chr_add_handlers(s->cs.chr, usb_serial_can_read, usb_serial_read, 505f1ae32a1SGerd Hoffmann usb_serial_event, s); 506f1ae32a1SGerd Hoffmann usb_serial_handle_reset(dev); 507da124e62SGerd Hoffmann 508*becdfa00SMarc-André Lureau if (s->cs.chr->be_open && !dev->attached) { 5097334d650SGonglei usb_device_attach(dev, &error_abort); 5107d553f27SGonglei } 511da124e62SGerd Hoffmann } 512f1ae32a1SGerd Hoffmann 513f1ae32a1SGerd Hoffmann static USBDevice *usb_serial_init(USBBus *bus, const char *filename) 514f1ae32a1SGerd Hoffmann { 515f1ae32a1SGerd Hoffmann USBDevice *dev; 516f1ae32a1SGerd Hoffmann CharDriverState *cdrv; 517f1ae32a1SGerd Hoffmann uint32_t vendorid = 0, productid = 0; 518f1ae32a1SGerd Hoffmann char label[32]; 519f1ae32a1SGerd Hoffmann static int index; 520f1ae32a1SGerd Hoffmann 521f1ae32a1SGerd Hoffmann while (*filename && *filename != ':') { 522f1ae32a1SGerd Hoffmann const char *p; 523f1ae32a1SGerd Hoffmann char *e; 524f1ae32a1SGerd Hoffmann if (strstart(filename, "vendorid=", &p)) { 525f1ae32a1SGerd Hoffmann vendorid = strtol(p, &e, 16); 526f1ae32a1SGerd Hoffmann if (e == p || (*e && *e != ',' && *e != ':')) { 527f1ae32a1SGerd Hoffmann error_report("bogus vendor ID %s", p); 528f1ae32a1SGerd Hoffmann return NULL; 529f1ae32a1SGerd Hoffmann } 530f1ae32a1SGerd Hoffmann filename = e; 531f1ae32a1SGerd Hoffmann } else if (strstart(filename, "productid=", &p)) { 532f1ae32a1SGerd Hoffmann productid = strtol(p, &e, 16); 533f1ae32a1SGerd Hoffmann if (e == p || (*e && *e != ',' && *e != ':')) { 534f1ae32a1SGerd Hoffmann error_report("bogus product ID %s", p); 535f1ae32a1SGerd Hoffmann return NULL; 536f1ae32a1SGerd Hoffmann } 537f1ae32a1SGerd Hoffmann filename = e; 538f1ae32a1SGerd Hoffmann } else { 539f1ae32a1SGerd Hoffmann error_report("unrecognized serial USB option %s", filename); 540f1ae32a1SGerd Hoffmann return NULL; 541f1ae32a1SGerd Hoffmann } 542f1ae32a1SGerd Hoffmann while(*filename == ',') 543f1ae32a1SGerd Hoffmann filename++; 544f1ae32a1SGerd Hoffmann } 545f1ae32a1SGerd Hoffmann if (!*filename) { 546f1ae32a1SGerd Hoffmann error_report("character device specification needed"); 547f1ae32a1SGerd Hoffmann return NULL; 548f1ae32a1SGerd Hoffmann } 549f1ae32a1SGerd Hoffmann filename++; 550f1ae32a1SGerd Hoffmann 551f1ae32a1SGerd Hoffmann snprintf(label, sizeof(label), "usbserial%d", index++); 552b4948be9SMarc-André Lureau cdrv = qemu_chr_new(label, filename); 553f1ae32a1SGerd Hoffmann if (!cdrv) 554f1ae32a1SGerd Hoffmann return NULL; 555f1ae32a1SGerd Hoffmann 556f1ae32a1SGerd Hoffmann dev = usb_create(bus, "usb-serial"); 557f1ae32a1SGerd Hoffmann qdev_prop_set_chr(&dev->qdev, "chardev", cdrv); 558f1ae32a1SGerd Hoffmann if (vendorid) 559f1ae32a1SGerd Hoffmann qdev_prop_set_uint16(&dev->qdev, "vendorid", vendorid); 560f1ae32a1SGerd Hoffmann if (productid) 561f1ae32a1SGerd Hoffmann qdev_prop_set_uint16(&dev->qdev, "productid", productid); 562f1ae32a1SGerd Hoffmann return dev; 563f1ae32a1SGerd Hoffmann } 564f1ae32a1SGerd Hoffmann 565f1ae32a1SGerd Hoffmann static USBDevice *usb_braille_init(USBBus *bus, const char *unused) 566f1ae32a1SGerd Hoffmann { 567f1ae32a1SGerd Hoffmann USBDevice *dev; 568f1ae32a1SGerd Hoffmann CharDriverState *cdrv; 569f1ae32a1SGerd Hoffmann 570b4948be9SMarc-André Lureau cdrv = qemu_chr_new("braille", "braille"); 571f1ae32a1SGerd Hoffmann if (!cdrv) 572f1ae32a1SGerd Hoffmann return NULL; 573f1ae32a1SGerd Hoffmann 574f1ae32a1SGerd Hoffmann dev = usb_create(bus, "usb-braille"); 575f1ae32a1SGerd Hoffmann qdev_prop_set_chr(&dev->qdev, "chardev", cdrv); 576f1ae32a1SGerd Hoffmann return dev; 577f1ae32a1SGerd Hoffmann } 578f1ae32a1SGerd Hoffmann 579f1ae32a1SGerd Hoffmann static const VMStateDescription vmstate_usb_serial = { 580f1ae32a1SGerd Hoffmann .name = "usb-serial", 581f1ae32a1SGerd Hoffmann .unmigratable = 1, 582f1ae32a1SGerd Hoffmann }; 583f1ae32a1SGerd Hoffmann 584f1ae32a1SGerd Hoffmann static Property serial_properties[] = { 585f1ae32a1SGerd Hoffmann DEFINE_PROP_CHR("chardev", USBSerialState, cs), 586f1ae32a1SGerd Hoffmann DEFINE_PROP_END_OF_LIST(), 587f1ae32a1SGerd Hoffmann }; 588f1ae32a1SGerd Hoffmann 589cdf0d769SGonglei static void usb_serial_dev_class_init(ObjectClass *klass, void *data) 590f1ae32a1SGerd Hoffmann { 591f1ae32a1SGerd Hoffmann DeviceClass *dc = DEVICE_CLASS(klass); 592f1ae32a1SGerd Hoffmann USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 593f1ae32a1SGerd Hoffmann 59438fff2c9SGonglei uc->realize = usb_serial_realize; 595f1ae32a1SGerd Hoffmann uc->handle_reset = usb_serial_handle_reset; 596f1ae32a1SGerd Hoffmann uc->handle_control = usb_serial_handle_control; 597f1ae32a1SGerd Hoffmann uc->handle_data = usb_serial_handle_data; 598f1ae32a1SGerd Hoffmann dc->vmsd = &vmstate_usb_serial; 599125ee0edSMarcel Apfelbaum set_bit(DEVICE_CATEGORY_INPUT, dc->categories); 600f1ae32a1SGerd Hoffmann } 601f1ae32a1SGerd Hoffmann 602cdf0d769SGonglei static const TypeInfo usb_serial_dev_type_info = { 603cdf0d769SGonglei .name = TYPE_USB_SERIAL, 604cdf0d769SGonglei .parent = TYPE_USB_DEVICE, 605cdf0d769SGonglei .instance_size = sizeof(USBSerialState), 606cdf0d769SGonglei .abstract = true, 607cdf0d769SGonglei .class_init = usb_serial_dev_class_init, 608cdf0d769SGonglei }; 609cdf0d769SGonglei 610cdf0d769SGonglei static void usb_serial_class_initfn(ObjectClass *klass, void *data) 611cdf0d769SGonglei { 612cdf0d769SGonglei DeviceClass *dc = DEVICE_CLASS(klass); 613cdf0d769SGonglei USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 614cdf0d769SGonglei 615cdf0d769SGonglei uc->product_desc = "QEMU USB Serial"; 616cdf0d769SGonglei uc->usb_desc = &desc_serial; 617cdf0d769SGonglei dc->props = serial_properties; 618cdf0d769SGonglei } 619cdf0d769SGonglei 6208c43a6f0SAndreas Färber static const TypeInfo serial_info = { 621f1ae32a1SGerd Hoffmann .name = "usb-serial", 622cdf0d769SGonglei .parent = TYPE_USB_SERIAL, 623f1ae32a1SGerd Hoffmann .class_init = usb_serial_class_initfn, 624f1ae32a1SGerd Hoffmann }; 625f1ae32a1SGerd Hoffmann 626f1ae32a1SGerd Hoffmann static Property braille_properties[] = { 627f1ae32a1SGerd Hoffmann DEFINE_PROP_CHR("chardev", USBSerialState, cs), 628f1ae32a1SGerd Hoffmann DEFINE_PROP_END_OF_LIST(), 629f1ae32a1SGerd Hoffmann }; 630f1ae32a1SGerd Hoffmann 631f1ae32a1SGerd Hoffmann static void usb_braille_class_initfn(ObjectClass *klass, void *data) 632f1ae32a1SGerd Hoffmann { 633f1ae32a1SGerd Hoffmann DeviceClass *dc = DEVICE_CLASS(klass); 634f1ae32a1SGerd Hoffmann USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 635f1ae32a1SGerd Hoffmann 636f1ae32a1SGerd Hoffmann uc->product_desc = "QEMU USB Braille"; 637f1ae32a1SGerd Hoffmann uc->usb_desc = &desc_braille; 638f1ae32a1SGerd Hoffmann dc->props = braille_properties; 639f1ae32a1SGerd Hoffmann } 640f1ae32a1SGerd Hoffmann 6418c43a6f0SAndreas Färber static const TypeInfo braille_info = { 642f1ae32a1SGerd Hoffmann .name = "usb-braille", 643cdf0d769SGonglei .parent = TYPE_USB_SERIAL, 644f1ae32a1SGerd Hoffmann .class_init = usb_braille_class_initfn, 645f1ae32a1SGerd Hoffmann }; 646f1ae32a1SGerd Hoffmann 647f1ae32a1SGerd Hoffmann static void usb_serial_register_types(void) 648f1ae32a1SGerd Hoffmann { 649cdf0d769SGonglei type_register_static(&usb_serial_dev_type_info); 650f1ae32a1SGerd Hoffmann type_register_static(&serial_info); 651f1ae32a1SGerd Hoffmann usb_legacy_register("usb-serial", "serial", usb_serial_init); 652f1ae32a1SGerd Hoffmann type_register_static(&braille_info); 653f1ae32a1SGerd Hoffmann usb_legacy_register("usb-braille", "braille", usb_braille_init); 654f1ae32a1SGerd Hoffmann } 655f1ae32a1SGerd Hoffmann 656f1ae32a1SGerd Hoffmann type_init(usb_serial_register_types) 657