Statistics
| Branch: | Revision:

root / hw / usb-serial.c @ 31d0f80f

History | View | Annotate | Download (16.4 kB)

1
/*
2
 * FTDI FT232BM Device emulation
3
 *
4
 * Copyright (c) 2006 CodeSourcery.
5
 * Copyright (c) 2008 Samuel Thibault <samuel.thibault@ens-lyon.org>
6
 * Written by Paul Brook, reused for FTDI by Samuel Thibault
7
 *
8
 * This code is licenced under the LGPL.
9
 */
10

    
11
#include "qemu-common.h"
12
#include "qemu-error.h"
13
#include "usb.h"
14
#include "usb-desc.h"
15
#include "qemu-char.h"
16

    
17
//#define DEBUG_Serial
18

    
19
#ifdef DEBUG_Serial
20
#define DPRINTF(fmt, ...) \
21
do { printf("usb-serial: " fmt , ## __VA_ARGS__); } while (0)
22
#else
23
#define DPRINTF(fmt, ...) do {} while(0)
24
#endif
25

    
26
#define RECV_BUF 384
27

    
28
/* Commands */
29
#define FTDI_RESET                0
30
#define FTDI_SET_MDM_CTRL        1
31
#define FTDI_SET_FLOW_CTRL        2
32
#define FTDI_SET_BAUD                3
33
#define FTDI_SET_DATA                4
34
#define FTDI_GET_MDM_ST                5
35
#define FTDI_SET_EVENT_CHR        6
36
#define FTDI_SET_ERROR_CHR        7
37
#define FTDI_SET_LATENCY        9
38
#define FTDI_GET_LATENCY        10
39

    
40
#define DeviceOutVendor        ((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8)
41
#define DeviceInVendor        ((USB_DIR_IN |USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8)
42

    
43
/* RESET */
44

    
45
#define FTDI_RESET_SIO        0
46
#define FTDI_RESET_RX        1
47
#define FTDI_RESET_TX        2
48

    
49
/* SET_MDM_CTRL */
50

    
51
#define FTDI_DTR        1
52
#define FTDI_SET_DTR        (FTDI_DTR << 8)
53
#define FTDI_RTS        2
54
#define FTDI_SET_RTS        (FTDI_RTS << 8)
55

    
56
/* SET_FLOW_CTRL */
57

    
58
#define FTDI_RTS_CTS_HS                1
59
#define FTDI_DTR_DSR_HS                2
60
#define FTDI_XON_XOFF_HS        4
61

    
62
/* SET_DATA */
63

    
64
#define FTDI_PARITY        (0x7 << 8)
65
#define FTDI_ODD        (0x1 << 8)
66
#define FTDI_EVEN        (0x2 << 8)
67
#define FTDI_MARK        (0x3 << 8)
68
#define FTDI_SPACE        (0x4 << 8)
69

    
70
#define FTDI_STOP        (0x3 << 11)
71
#define FTDI_STOP1        (0x0 << 11)
72
#define FTDI_STOP15        (0x1 << 11)
73
#define FTDI_STOP2        (0x2 << 11)
74

    
75
/* GET_MDM_ST */
76
/* TODO: should be sent every 40ms */
77
#define FTDI_CTS  (1<<4)        // CTS line status
78
#define FTDI_DSR  (1<<5)        // DSR line status
79
#define FTDI_RI   (1<<6)        // RI line status
80
#define FTDI_RLSD (1<<7)        // Receive Line Signal Detect
81

    
82
/* Status */
83

    
84
#define FTDI_DR   (1<<0)        // Data Ready
85
#define FTDI_OE   (1<<1)        // Overrun Err
86
#define FTDI_PE   (1<<2)        // Parity Err
87
#define FTDI_FE   (1<<3)        // Framing Err
88
#define FTDI_BI   (1<<4)        // Break Interrupt
89
#define FTDI_THRE (1<<5)        // Transmitter Holding Register
90
#define FTDI_TEMT (1<<6)        // Transmitter Empty
91
#define FTDI_FIFO (1<<7)        // Error in FIFO
92

    
93
typedef struct {
94
    USBDevice dev;
95
    uint8_t recv_buf[RECV_BUF];
96
    uint16_t recv_ptr;
97
    uint16_t recv_used;
98
    uint8_t event_chr;
99
    uint8_t error_chr;
100
    uint8_t event_trigger;
101
    QEMUSerialSetParams params;
102
    int latency;        /* ms */
103
    CharDriverState *cs;
104
} USBSerialState;
105

    
106
enum {
107
    STR_MANUFACTURER = 1,
108
    STR_PRODUCT_SERIAL,
109
    STR_PRODUCT_BRAILLE,
110
    STR_SERIALNUMBER,
111
};
112

    
113
static const USBDescStrings desc_strings = {
114
    [STR_MANUFACTURER]    = "QEMU " QEMU_VERSION,
115
    [STR_PRODUCT_SERIAL]  = "QEMU USB SERIAL",
116
    [STR_PRODUCT_BRAILLE] = "QEMU USB BRAILLE",
117
    [STR_SERIALNUMBER]    = "1",
118
};
119

    
120
static const USBDescIface desc_iface0 = {
121
    .bInterfaceNumber              = 0,
122
    .bNumEndpoints                 = 2,
123
    .bInterfaceClass               = 0xff,
124
    .bInterfaceSubClass            = 0xff,
125
    .bInterfaceProtocol            = 0xff,
126
    .eps = (USBDescEndpoint[]) {
127
        {
128
            .bEndpointAddress      = USB_DIR_IN | 0x01,
129
            .bmAttributes          = USB_ENDPOINT_XFER_BULK,
130
            .wMaxPacketSize        = 64,
131
        },{
132
            .bEndpointAddress      = USB_DIR_OUT | 0x02,
133
            .bmAttributes          = USB_ENDPOINT_XFER_BULK,
134
            .wMaxPacketSize        = 64,
135
        },
136
    }
137
};
138

    
139
static const USBDescDevice desc_device = {
140
    .bcdUSB                        = 0x0200,
141
    .bMaxPacketSize0               = 8,
142
    .bNumConfigurations            = 1,
143
    .confs = (USBDescConfig[]) {
144
        {
145
            .bNumInterfaces        = 1,
146
            .bConfigurationValue   = 1,
147
            .bmAttributes          = 0x80,
148
            .bMaxPower             = 50,
149
            .ifs = &desc_iface0,
150
        },
151
    },
152
};
153

    
154
static const USBDesc desc_serial = {
155
    .id = {
156
        .idVendor          = 0x0403,
157
        .idProduct         = 0x6001,
158
        .bcdDevice         = 0x0400,
159
        .iManufacturer     = STR_MANUFACTURER,
160
        .iProduct          = STR_PRODUCT_SERIAL,
161
        .iSerialNumber     = STR_SERIALNUMBER,
162
    },
163
    .full = &desc_device,
164
    .str  = desc_strings,
165
};
166

    
167
static const USBDesc desc_braille = {
168
    .id = {
169
        .idVendor          = 0x0403,
170
        .idProduct         = 0xfe72,
171
        .bcdDevice         = 0x0400,
172
        .iManufacturer     = STR_MANUFACTURER,
173
        .iProduct          = STR_PRODUCT_BRAILLE,
174
        .iSerialNumber     = STR_SERIALNUMBER,
175
    },
176
    .full = &desc_device,
177
    .str  = desc_strings,
178
};
179

    
180
static void usb_serial_reset(USBSerialState *s)
181
{
182
    /* TODO: Set flow control to none */
183
    s->event_chr = 0x0d;
184
    s->event_trigger = 0;
185
    s->recv_ptr = 0;
186
    s->recv_used = 0;
187
    /* TODO: purge in char driver */
188
}
189

    
190
static void usb_serial_handle_reset(USBDevice *dev)
191
{
192
    USBSerialState *s = (USBSerialState *)dev;
193

    
194
    DPRINTF("Reset\n");
195

    
196
    usb_serial_reset(s);
197
    /* TODO: Reset char device, send BREAK? */
198
}
199

    
200
static uint8_t usb_get_modem_lines(USBSerialState *s)
201
{
202
    int flags;
203
    uint8_t ret;
204

    
205
    if (qemu_chr_ioctl(s->cs, CHR_IOCTL_SERIAL_GET_TIOCM, &flags) == -ENOTSUP)
206
        return FTDI_CTS|FTDI_DSR|FTDI_RLSD;
207

    
208
    ret = 0;
209
    if (flags & CHR_TIOCM_CTS)
210
        ret |= FTDI_CTS;
211
    if (flags & CHR_TIOCM_DSR)
212
        ret |= FTDI_DSR;
213
    if (flags & CHR_TIOCM_RI)
214
        ret |= FTDI_RI;
215
    if (flags & CHR_TIOCM_CAR)
216
        ret |= FTDI_RLSD;
217

    
218
    return ret;
219
}
220

    
221
static int usb_serial_handle_control(USBDevice *dev, int request, int value,
222
                                  int index, int length, uint8_t *data)
223
{
224
    USBSerialState *s = (USBSerialState *)dev;
225
    int ret;
226

    
227
    DPRINTF("got control %x, value %x\n",request, value);
228
    ret = usb_desc_handle_control(dev, request, value, index, length, data);
229
    if (ret >= 0) {
230
        return ret;
231
    }
232

    
233
    ret = 0;
234
    switch (request) {
235
    case DeviceRequest | USB_REQ_GET_INTERFACE:
236
        data[0] = 0;
237
        ret = 1;
238
        break;
239
    case InterfaceOutRequest | USB_REQ_SET_INTERFACE:
240
        ret = 0;
241
        break;
242
    case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
243
        ret = 0;
244
        break;
245

    
246
        /* Class specific requests.  */
247
    case DeviceOutVendor | FTDI_RESET:
248
        switch (value) {
249
        case FTDI_RESET_SIO:
250
            usb_serial_reset(s);
251
            break;
252
        case FTDI_RESET_RX:
253
            s->recv_ptr = 0;
254
            s->recv_used = 0;
255
            /* TODO: purge from char device */
256
            break;
257
        case FTDI_RESET_TX:
258
            /* TODO: purge from char device */
259
            break;
260
        }
261
        break;
262
    case DeviceOutVendor | FTDI_SET_MDM_CTRL:
263
    {
264
        static int flags;
265
        qemu_chr_ioctl(s->cs,CHR_IOCTL_SERIAL_GET_TIOCM, &flags);
266
        if (value & FTDI_SET_RTS) {
267
            if (value & FTDI_RTS)
268
                flags |= CHR_TIOCM_RTS;
269
            else
270
                flags &= ~CHR_TIOCM_RTS;
271
        }
272
        if (value & FTDI_SET_DTR) {
273
            if (value & FTDI_DTR)
274
                flags |= CHR_TIOCM_DTR;
275
            else
276
                flags &= ~CHR_TIOCM_DTR;
277
        }
278
        qemu_chr_ioctl(s->cs,CHR_IOCTL_SERIAL_SET_TIOCM, &flags);
279
        break;
280
    }
281
    case DeviceOutVendor | FTDI_SET_FLOW_CTRL:
282
        /* TODO: ioctl */
283
        break;
284
    case DeviceOutVendor | FTDI_SET_BAUD: {
285
        static const int subdivisors8[8] = { 0, 4, 2, 1, 3, 5, 6, 7 };
286
        int subdivisor8 = subdivisors8[((value & 0xc000) >> 14)
287
                                     | ((index & 1) << 2)];
288
        int divisor = value & 0x3fff;
289

    
290
        /* chip special cases */
291
        if (divisor == 1 && subdivisor8 == 0)
292
            subdivisor8 = 4;
293
        if (divisor == 0 && subdivisor8 == 0)
294
            divisor = 1;
295

    
296
        s->params.speed = (48000000 / 2) / (8 * divisor + subdivisor8);
297
        qemu_chr_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
298
        break;
299
    }
300
    case DeviceOutVendor | FTDI_SET_DATA:
301
        switch (value & FTDI_PARITY) {
302
            case 0:
303
                s->params.parity = 'N';
304
                break;
305
            case FTDI_ODD:
306
                s->params.parity = 'O';
307
                break;
308
            case FTDI_EVEN:
309
                s->params.parity = 'E';
310
                break;
311
            default:
312
                DPRINTF("unsupported parity %d\n", value & FTDI_PARITY);
313
                goto fail;
314
        }
315
        switch (value & FTDI_STOP) {
316
            case FTDI_STOP1:
317
                s->params.stop_bits = 1;
318
                break;
319
            case FTDI_STOP2:
320
                s->params.stop_bits = 2;
321
                break;
322
            default:
323
                DPRINTF("unsupported stop bits %d\n", value & FTDI_STOP);
324
                goto fail;
325
        }
326
        qemu_chr_ioctl(s->cs, CHR_IOCTL_SERIAL_SET_PARAMS, &s->params);
327
        /* TODO: TX ON/OFF */
328
        break;
329
    case DeviceInVendor | FTDI_GET_MDM_ST:
330
        data[0] = usb_get_modem_lines(s) | 1;
331
        data[1] = 0;
332
        ret = 2;
333
        break;
334
    case DeviceOutVendor | FTDI_SET_EVENT_CHR:
335
        /* TODO: handle it */
336
        s->event_chr = value;
337
        break;
338
    case DeviceOutVendor | FTDI_SET_ERROR_CHR:
339
        /* TODO: handle it */
340
        s->error_chr = value;
341
        break;
342
    case DeviceOutVendor | FTDI_SET_LATENCY:
343
        s->latency = value;
344
        break;
345
    case DeviceInVendor | FTDI_GET_LATENCY:
346
        data[0] = s->latency;
347
        ret = 1;
348
        break;
349
    default:
350
    fail:
351
        DPRINTF("got unsupported/bogus control %x, value %x\n", request, value);
352
        ret = USB_RET_STALL;
353
        break;
354
    }
355
    return ret;
356
}
357

    
358
static int usb_serial_handle_data(USBDevice *dev, USBPacket *p)
359
{
360
    USBSerialState *s = (USBSerialState *)dev;
361
    int ret = 0;
362
    uint8_t devep = p->devep;
363
    uint8_t *data = p->data;
364
    int len = p->len;
365
    int first_len;
366

    
367
    switch (p->pid) {
368
    case USB_TOKEN_OUT:
369
        if (devep != 2)
370
            goto fail;
371
        qemu_chr_write(s->cs, data, len);
372
        break;
373

    
374
    case USB_TOKEN_IN:
375
        if (devep != 1)
376
            goto fail;
377
        first_len = RECV_BUF - s->recv_ptr;
378
        if (len <= 2) {
379
            ret = USB_RET_NAK;
380
            break;
381
        }
382
        *data++ = usb_get_modem_lines(s) | 1;
383
        /* We do not have the uart details */
384
        /* handle serial break */
385
        if (s->event_trigger && s->event_trigger & FTDI_BI) {
386
            s->event_trigger &= ~FTDI_BI;
387
            *data = FTDI_BI;
388
            ret = 2;
389
            break;
390
        } else {
391
            *data++ = 0;
392
        }
393
        len -= 2;
394
        if (len > s->recv_used)
395
            len = s->recv_used;
396
        if (!len) {
397
            ret = USB_RET_NAK;
398
            break;
399
        }
400
        if (first_len > len)
401
            first_len = len;
402
        memcpy(data, s->recv_buf + s->recv_ptr, first_len);
403
        if (len > first_len)
404
            memcpy(data + first_len, s->recv_buf, len - first_len);
405
        s->recv_used -= len;
406
        s->recv_ptr = (s->recv_ptr + len) % RECV_BUF;
407
        ret = len + 2;
408
        break;
409

    
410
    default:
411
        DPRINTF("Bad token\n");
412
    fail:
413
        ret = USB_RET_STALL;
414
        break;
415
    }
416

    
417
    return ret;
418
}
419

    
420
static void usb_serial_handle_destroy(USBDevice *dev)
421
{
422
    USBSerialState *s = (USBSerialState *)dev;
423

    
424
    qemu_chr_close(s->cs);
425
}
426

    
427
static int usb_serial_can_read(void *opaque)
428
{
429
    USBSerialState *s = opaque;
430
    return RECV_BUF - s->recv_used;
431
}
432

    
433
static void usb_serial_read(void *opaque, const uint8_t *buf, int size)
434
{
435
    USBSerialState *s = opaque;
436
    int first_size, start;
437

    
438
    /* room in the buffer? */
439
    if (size > (RECV_BUF - s->recv_used))
440
        size = RECV_BUF - s->recv_used;
441

    
442
    start = s->recv_ptr + s->recv_used;
443
    if (start < RECV_BUF) {
444
        /* copy data to end of buffer */
445
        first_size = RECV_BUF - start;
446
        if (first_size > size)
447
            first_size = size;
448

    
449
        memcpy(s->recv_buf + start, buf, first_size);
450

    
451
        /* wrap around to front if needed */
452
        if (size > first_size)
453
            memcpy(s->recv_buf, buf + first_size, size - first_size);
454
    } else {
455
        start -= RECV_BUF;
456
        memcpy(s->recv_buf + start, buf, size);
457
    }
458
    s->recv_used += size;
459
}
460

    
461
static void usb_serial_event(void *opaque, int event)
462
{
463
    USBSerialState *s = opaque;
464

    
465
    switch (event) {
466
        case CHR_EVENT_BREAK:
467
            s->event_trigger |= FTDI_BI;
468
            break;
469
        case CHR_EVENT_FOCUS:
470
            break;
471
        case CHR_EVENT_OPENED:
472
            usb_serial_reset(s);
473
            /* TODO: Reset USB port */
474
            break;
475
    }
476
}
477

    
478
static int usb_serial_initfn(USBDevice *dev)
479
{
480
    USBSerialState *s = DO_UPCAST(USBSerialState, dev, dev);
481

    
482
    usb_desc_init(dev);
483

    
484
    if (!s->cs) {
485
        error_report("Property chardev is required");
486
        return -1;
487
    }
488

    
489
    qemu_chr_add_handlers(s->cs, usb_serial_can_read, usb_serial_read,
490
                          usb_serial_event, s);
491
    usb_serial_handle_reset(dev);
492
    return 0;
493
}
494

    
495
static USBDevice *usb_serial_init(const char *filename)
496
{
497
    USBDevice *dev;
498
    CharDriverState *cdrv;
499
    uint32_t vendorid = 0, productid = 0;
500
    char label[32];
501
    static int index;
502

    
503
    while (*filename && *filename != ':') {
504
        const char *p;
505
        char *e;
506
        if (strstart(filename, "vendorid=", &p)) {
507
            vendorid = strtol(p, &e, 16);
508
            if (e == p || (*e && *e != ',' && *e != ':')) {
509
                error_report("bogus vendor ID %s", p);
510
                return NULL;
511
            }
512
            filename = e;
513
        } else if (strstart(filename, "productid=", &p)) {
514
            productid = strtol(p, &e, 16);
515
            if (e == p || (*e && *e != ',' && *e != ':')) {
516
                error_report("bogus product ID %s", p);
517
                return NULL;
518
            }
519
            filename = e;
520
        } else {
521
            error_report("unrecognized serial USB option %s", filename);
522
            return NULL;
523
        }
524
        while(*filename == ',')
525
            filename++;
526
    }
527
    if (!*filename) {
528
        error_report("character device specification needed");
529
        return NULL;
530
    }
531
    filename++;
532

    
533
    snprintf(label, sizeof(label), "usbserial%d", index++);
534
    cdrv = qemu_chr_open(label, filename, NULL);
535
    if (!cdrv)
536
        return NULL;
537

    
538
    dev = usb_create(NULL /* FIXME */, "usb-serial");
539
    if (!dev) {
540
        return NULL;
541
    }
542
    qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
543
    if (vendorid)
544
        qdev_prop_set_uint16(&dev->qdev, "vendorid", vendorid);
545
    if (productid)
546
        qdev_prop_set_uint16(&dev->qdev, "productid", productid);
547
    qdev_init_nofail(&dev->qdev);
548

    
549
    return dev;
550
}
551

    
552
static USBDevice *usb_braille_init(const char *unused)
553
{
554
    USBDevice *dev;
555
    CharDriverState *cdrv;
556

    
557
    cdrv = qemu_chr_open("braille", "braille", NULL);
558
    if (!cdrv)
559
        return NULL;
560

    
561
    dev = usb_create(NULL /* FIXME */, "usb-braille");
562
    qdev_prop_set_chr(&dev->qdev, "chardev", cdrv);
563
    qdev_init_nofail(&dev->qdev);
564

    
565
    return dev;
566
}
567

    
568
static struct USBDeviceInfo serial_info = {
569
    .product_desc   = "QEMU USB Serial",
570
    .qdev.name      = "usb-serial",
571
    .qdev.size      = sizeof(USBSerialState),
572
    .usb_desc       = &desc_serial,
573
    .init           = usb_serial_initfn,
574
    .handle_packet  = usb_generic_handle_packet,
575
    .handle_reset   = usb_serial_handle_reset,
576
    .handle_control = usb_serial_handle_control,
577
    .handle_data    = usb_serial_handle_data,
578
    .handle_destroy = usb_serial_handle_destroy,
579
    .usbdevice_name = "serial",
580
    .usbdevice_init = usb_serial_init,
581
    .qdev.props     = (Property[]) {
582
        DEFINE_PROP_CHR("chardev", USBSerialState, cs),
583
        DEFINE_PROP_END_OF_LIST(),
584
    },
585
};
586

    
587
static struct USBDeviceInfo braille_info = {
588
    .product_desc   = "QEMU USB Braille",
589
    .qdev.name      = "usb-braille",
590
    .qdev.size      = sizeof(USBSerialState),
591
    .usb_desc       = &desc_braille,
592
    .init           = usb_serial_initfn,
593
    .handle_packet  = usb_generic_handle_packet,
594
    .handle_reset   = usb_serial_handle_reset,
595
    .handle_control = usb_serial_handle_control,
596
    .handle_data    = usb_serial_handle_data,
597
    .handle_destroy = usb_serial_handle_destroy,
598
    .usbdevice_name = "braille",
599
    .usbdevice_init = usb_braille_init,
600
    .qdev.props     = (Property[]) {
601
        DEFINE_PROP_CHR("chardev", USBSerialState, cs),
602
        DEFINE_PROP_END_OF_LIST(),
603
    },
604
};
605

    
606
static void usb_serial_register_devices(void)
607
{
608
    usb_qdev_register(&serial_info);
609
    usb_qdev_register(&braille_info);
610
}
611
device_init(usb_serial_register_devices)