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