Statistics
| Branch: | Revision:

root / hw / usb.h @ 079d0b7f

History | View | Annotate | Download (14.8 kB)

1
#ifndef QEMU_USB_H
2
#define QEMU_USB_H
3

    
4
/*
5
 * QEMU USB API
6
 *
7
 * Copyright (c) 2005 Fabrice Bellard
8
 *
9
 * Permission is hereby granted, free of charge, to any person obtaining a copy
10
 * of this software and associated documentation files (the "Software"), to deal
11
 * in the Software without restriction, including without limitation the rights
12
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
 * copies of the Software, and to permit persons to whom the Software is
14
 * furnished to do so, subject to the following conditions:
15
 *
16
 * The above copyright notice and this permission notice shall be included in
17
 * all copies or substantial portions of the Software.
18
 *
19
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25
 * THE SOFTWARE.
26
 */
27

    
28
#include "block.h"
29
#include "qdev.h"
30
#include "qemu-queue.h"
31

    
32
/* Constants related to the USB / PCI interaction */
33
#define USB_SBRN    0x60 /* Serial Bus Release Number Register */
34
#define USB_RELEASE_1  0x10 /* USB 1.0 */
35
#define USB_RELEASE_2  0x20 /* USB 2.0 */
36
#define USB_RELEASE_3  0x30 /* USB 3.0 */
37

    
38
#define USB_TOKEN_SETUP 0x2d
39
#define USB_TOKEN_IN    0x69 /* device -> host */
40
#define USB_TOKEN_OUT   0xe1 /* host -> device */
41

    
42
#define USB_RET_NODEV  (-1)
43
#define USB_RET_NAK    (-2)
44
#define USB_RET_STALL  (-3)
45
#define USB_RET_BABBLE (-4)
46
#define USB_RET_ASYNC  (-5)
47

    
48
#define USB_SPEED_LOW   0
49
#define USB_SPEED_FULL  1
50
#define USB_SPEED_HIGH  2
51
#define USB_SPEED_SUPER 3
52

    
53
#define USB_SPEED_MASK_LOW   (1 << USB_SPEED_LOW)
54
#define USB_SPEED_MASK_FULL  (1 << USB_SPEED_FULL)
55
#define USB_SPEED_MASK_HIGH  (1 << USB_SPEED_HIGH)
56
#define USB_SPEED_MASK_SUPER (1 << USB_SPEED_SUPER)
57

    
58
#define USB_STATE_NOTATTACHED 0
59
#define USB_STATE_ATTACHED    1
60
//#define USB_STATE_POWERED     2
61
#define USB_STATE_DEFAULT     3
62
//#define USB_STATE_ADDRESS     4
63
//#define        USB_STATE_CONFIGURED  5
64
#define USB_STATE_SUSPENDED   6
65

    
66
#define USB_CLASS_AUDIO                        1
67
#define USB_CLASS_COMM                        2
68
#define USB_CLASS_HID                        3
69
#define USB_CLASS_PHYSICAL                5
70
#define USB_CLASS_STILL_IMAGE                6
71
#define USB_CLASS_PRINTER                7
72
#define USB_CLASS_MASS_STORAGE                8
73
#define USB_CLASS_HUB                        9
74
#define USB_CLASS_CDC_DATA                0x0a
75
#define USB_CLASS_CSCID                        0x0b
76
#define USB_CLASS_CONTENT_SEC                0x0d
77
#define USB_CLASS_APP_SPEC                0xfe
78
#define USB_CLASS_VENDOR_SPEC                0xff
79

    
80
#define USB_SUBCLASS_UNDEFINED          0
81
#define USB_SUBCLASS_AUDIO_CONTROL      1
82
#define USB_SUBCLASS_AUDIO_STREAMING    2
83
#define USB_SUBCLASS_AUDIO_MIDISTREAMING 3
84

    
85
#define USB_DIR_OUT                        0
86
#define USB_DIR_IN                        0x80
87

    
88
#define USB_TYPE_MASK                        (0x03 << 5)
89
#define USB_TYPE_STANDARD                (0x00 << 5)
90
#define USB_TYPE_CLASS                        (0x01 << 5)
91
#define USB_TYPE_VENDOR                        (0x02 << 5)
92
#define USB_TYPE_RESERVED                (0x03 << 5)
93

    
94
#define USB_RECIP_MASK                        0x1f
95
#define USB_RECIP_DEVICE                0x00
96
#define USB_RECIP_INTERFACE                0x01
97
#define USB_RECIP_ENDPOINT                0x02
98
#define USB_RECIP_OTHER                        0x03
99

    
100
#define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
101
#define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
102
#define InterfaceRequest \
103
        ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
104
#define InterfaceOutRequest \
105
        ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
106
#define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
107
#define EndpointOutRequest \
108
        ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
109
#define ClassInterfaceRequest \
110
        ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
111
#define ClassInterfaceOutRequest \
112
        ((USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
113

    
114
#define USB_REQ_GET_STATUS                0x00
115
#define USB_REQ_CLEAR_FEATURE                0x01
116
#define USB_REQ_SET_FEATURE                0x03
117
#define USB_REQ_SET_ADDRESS                0x05
118
#define USB_REQ_GET_DESCRIPTOR                0x06
119
#define USB_REQ_SET_DESCRIPTOR                0x07
120
#define USB_REQ_GET_CONFIGURATION        0x08
121
#define USB_REQ_SET_CONFIGURATION        0x09
122
#define USB_REQ_GET_INTERFACE                0x0A
123
#define USB_REQ_SET_INTERFACE                0x0B
124
#define USB_REQ_SYNCH_FRAME                0x0C
125

    
126
#define USB_DEVICE_SELF_POWERED                0
127
#define USB_DEVICE_REMOTE_WAKEUP        1
128

    
129
#define USB_DT_DEVICE                        0x01
130
#define USB_DT_CONFIG                        0x02
131
#define USB_DT_STRING                        0x03
132
#define USB_DT_INTERFACE                0x04
133
#define USB_DT_ENDPOINT                        0x05
134
#define USB_DT_DEVICE_QUALIFIER         0x06
135
#define USB_DT_OTHER_SPEED_CONFIG       0x07
136
#define USB_DT_DEBUG                    0x0A
137
#define USB_DT_INTERFACE_ASSOC          0x0B
138
#define USB_DT_CS_INTERFACE             0x24
139
#define USB_DT_CS_ENDPOINT              0x25
140

    
141
#define USB_ENDPOINT_XFER_CONTROL        0
142
#define USB_ENDPOINT_XFER_ISOC                1
143
#define USB_ENDPOINT_XFER_BULK                2
144
#define USB_ENDPOINT_XFER_INT                3
145
#define USB_ENDPOINT_XFER_INVALID     255
146

    
147
typedef struct USBBus USBBus;
148
typedef struct USBBusOps USBBusOps;
149
typedef struct USBPort USBPort;
150
typedef struct USBDevice USBDevice;
151
typedef struct USBPacket USBPacket;
152
typedef struct USBEndpoint USBEndpoint;
153

    
154
typedef struct USBDesc USBDesc;
155
typedef struct USBDescID USBDescID;
156
typedef struct USBDescDevice USBDescDevice;
157
typedef struct USBDescConfig USBDescConfig;
158
typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
159
typedef struct USBDescIface USBDescIface;
160
typedef struct USBDescEndpoint USBDescEndpoint;
161
typedef struct USBDescOther USBDescOther;
162
typedef struct USBDescString USBDescString;
163

    
164
struct USBDescString {
165
    uint8_t index;
166
    char *str;
167
    QLIST_ENTRY(USBDescString) next;
168
};
169

    
170
#define USB_MAX_ENDPOINTS  15
171
#define USB_MAX_INTERFACES 16
172

    
173
struct USBEndpoint {
174
    uint8_t nr;
175
    uint8_t pid;
176
    uint8_t type;
177
    uint8_t ifnum;
178
    int max_packet_size;
179
    USBDevice *dev;
180
};
181

    
182
/* definition of a USB device */
183
struct USBDevice {
184
    DeviceState qdev;
185
    USBPort *port;
186
    char *port_path;
187
    void *opaque;
188

    
189
    /* Actual connected speed */
190
    int speed;
191
    /* Supported speeds, not in info because it may be variable (hostdevs) */
192
    int speedmask;
193
    uint8_t addr;
194
    char product_desc[32];
195
    int auto_attach;
196
    int attached;
197

    
198
    int32_t state;
199
    uint8_t setup_buf[8];
200
    uint8_t data_buf[4096];
201
    int32_t remote_wakeup;
202
    int32_t setup_state;
203
    int32_t setup_len;
204
    int32_t setup_index;
205

    
206
    USBEndpoint ep_ctl;
207
    USBEndpoint ep_in[USB_MAX_ENDPOINTS];
208
    USBEndpoint ep_out[USB_MAX_ENDPOINTS];
209

    
210
    QLIST_HEAD(, USBDescString) strings;
211
    const USBDescDevice *device;
212

    
213
    int configuration;
214
    int ninterfaces;
215
    int altsetting[USB_MAX_INTERFACES];
216
    const USBDescConfig *config;
217
    const USBDescIface  *ifaces[USB_MAX_INTERFACES];
218
};
219

    
220
#define TYPE_USB_DEVICE "usb-device"
221
#define USB_DEVICE(obj) \
222
     OBJECT_CHECK(USBDevice, (obj), TYPE_USB_DEVICE)
223
#define USB_DEVICE_CLASS(klass) \
224
     OBJECT_CLASS_CHECK(USBDeviceClass, (klass), TYPE_USB_DEVICE)
225
#define USB_DEVICE_GET_CLASS(obj) \
226
     OBJECT_GET_CLASS(USBDeviceClass, (obj), TYPE_USB_DEVICE)
227

    
228
typedef struct USBDeviceClass {
229
    DeviceClass parent_class;
230

    
231
    int (*init)(USBDevice *dev);
232

    
233
    /*
234
     * Walk (enabled) downstream ports, check for a matching device.
235
     * Only hubs implement this.
236
     */
237
    USBDevice *(*find_device)(USBDevice *dev, uint8_t addr);
238

    
239
    /*
240
     * Called when a packet is canceled.
241
     */
242
    void (*cancel_packet)(USBDevice *dev, USBPacket *p);
243

    
244
    /*
245
     * Called when device is destroyed.
246
     */
247
    void (*handle_destroy)(USBDevice *dev);
248

    
249
    /*
250
     * Attach the device
251
     */
252
    void (*handle_attach)(USBDevice *dev);
253

    
254
    /*
255
     * Reset the device
256
     */
257
    void (*handle_reset)(USBDevice *dev);
258

    
259
    /*
260
     * Process control request.
261
     * Called from handle_packet().
262
     *
263
     * Returns length or one of the USB_RET_ codes.
264
     */
265
    int (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value,
266
                          int index, int length, uint8_t *data);
267

    
268
    /*
269
     * Process data transfers (both BULK and ISOC).
270
     * Called from handle_packet().
271
     *
272
     * Returns length or one of the USB_RET_ codes.
273
     */
274
    int (*handle_data)(USBDevice *dev, USBPacket *p);
275

    
276
    void (*set_interface)(USBDevice *dev, int interface,
277
                          int alt_old, int alt_new);
278

    
279
    const char *product_desc;
280
    const USBDesc *usb_desc;
281
} USBDeviceClass;
282

    
283
typedef struct USBPortOps {
284
    void (*attach)(USBPort *port);
285
    void (*detach)(USBPort *port);
286
    /*
287
     * This gets called when a device downstream from the device attached to
288
     * the port (iow attached through a hub) gets detached.
289
     */
290
    void (*child_detach)(USBPort *port, USBDevice *child);
291
    void (*wakeup)(USBPort *port);
292
    /*
293
     * Note that port->dev will be different then the device from which
294
     * the packet originated when a hub is involved.
295
     */
296
    void (*complete)(USBPort *port, USBPacket *p);
297
} USBPortOps;
298

    
299
/* USB port on which a device can be connected */
300
struct USBPort {
301
    USBDevice *dev;
302
    int speedmask;
303
    char path[16];
304
    USBPortOps *ops;
305
    void *opaque;
306
    int index; /* internal port index, may be used with the opaque */
307
    QTAILQ_ENTRY(USBPort) next;
308
};
309

    
310
typedef void USBCallback(USBPacket * packet, void *opaque);
311

    
312
/* Structure used to hold information about an active USB packet.  */
313
typedef enum USBPacketState {
314
    USB_PACKET_UNDEFINED = 0,
315
    USB_PACKET_SETUP,
316
    USB_PACKET_ASYNC,
317
    USB_PACKET_COMPLETE,
318
    USB_PACKET_CANCELED,
319
} USBPacketState;
320

    
321
struct USBPacket {
322
    /* Data fields for use by the driver.  */
323
    int pid;
324
    USBEndpoint *ep;
325
    QEMUIOVector iov;
326
    int result; /* transfer length or USB_RET_* status code */
327
    /* Internal use by the USB layer.  */
328
    USBPacketState state;
329
};
330

    
331
void usb_packet_init(USBPacket *p);
332
void usb_packet_setup(USBPacket *p, int pid, USBEndpoint *ep);
333
void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len);
334
int usb_packet_map(USBPacket *p, QEMUSGList *sgl);
335
void usb_packet_unmap(USBPacket *p);
336
void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes);
337
void usb_packet_skip(USBPacket *p, size_t bytes);
338
void usb_packet_cleanup(USBPacket *p);
339

    
340
static inline bool usb_packet_is_inflight(USBPacket *p)
341
{
342
    return p->state == USB_PACKET_ASYNC;
343
}
344

    
345
USBDevice *usb_find_device(USBPort *port, uint8_t addr);
346

    
347
int usb_handle_packet(USBDevice *dev, USBPacket *p);
348
void usb_packet_complete(USBDevice *dev, USBPacket *p);
349
void usb_cancel_packet(USBPacket * p);
350

    
351
void usb_ep_init(USBDevice *dev);
352
void usb_ep_dump(USBDevice *dev);
353
struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep);
354
uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
355
uint8_t usb_ep_get_ifnum(USBDevice *dev, int pid, int ep);
356
void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
357
void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);
358
void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
359
                                uint16_t raw);
360
int usb_ep_get_max_packet_size(USBDevice *dev, int pid, int ep);
361

    
362
void usb_attach(USBPort *port);
363
void usb_detach(USBPort *port);
364
void usb_port_reset(USBPort *port);
365
void usb_device_reset(USBDevice *dev);
366
void usb_wakeup(USBDevice *dev);
367
void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
368
int set_usb_string(uint8_t *buf, const char *str);
369

    
370
/* usb-linux.c */
371
USBDevice *usb_host_device_open(const char *devname);
372
int usb_host_device_close(const char *devname);
373
void usb_host_info(Monitor *mon);
374

    
375
/* usb-bt.c */
376
USBDevice *usb_bt_init(HCIInfo *hci);
377

    
378
/* usb ports of the VM */
379

    
380
#define VM_USB_HUB_SIZE 8
381

    
382
/* usb-musb.c */
383
enum musb_irq_source_e {
384
    musb_irq_suspend = 0,
385
    musb_irq_resume,
386
    musb_irq_rst_babble,
387
    musb_irq_sof,
388
    musb_irq_connect,
389
    musb_irq_disconnect,
390
    musb_irq_vbus_request,
391
    musb_irq_vbus_error,
392
    musb_irq_rx,
393
    musb_irq_tx,
394
    musb_set_vbus,
395
    musb_set_session,
396
    /* Add new interrupts here */
397
    musb_irq_max, /* total number of interrupts defined */
398
};
399

    
400
typedef struct MUSBState MUSBState;
401
MUSBState *musb_init(DeviceState *parent_device, int gpio_base);
402
void musb_reset(MUSBState *s);
403
uint32_t musb_core_intr_get(MUSBState *s);
404
void musb_core_intr_clear(MUSBState *s, uint32_t mask);
405
void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
406

    
407
/* usb-bus.c */
408

    
409
struct USBBus {
410
    BusState qbus;
411
    USBBusOps *ops;
412
    int busnr;
413
    int nfree;
414
    int nused;
415
    QTAILQ_HEAD(, USBPort) free;
416
    QTAILQ_HEAD(, USBPort) used;
417
    QTAILQ_ENTRY(USBBus) next;
418
};
419

    
420
struct USBBusOps {
421
    int (*register_companion)(USBBus *bus, USBPort *ports[],
422
                              uint32_t portcount, uint32_t firstport);
423
};
424

    
425
void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host);
426
USBBus *usb_bus_find(int busnr);
427
void usb_legacy_register(const char *typename, const char *usbdevice_name,
428
                         USBDevice *(*usbdevice_init)(const char *params));
429
USBDevice *usb_create(USBBus *bus, const char *name);
430
USBDevice *usb_create_simple(USBBus *bus, const char *name);
431
USBDevice *usbdevice_create(const char *cmdline);
432
void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
433
                       USBPortOps *ops, int speedmask);
434
int usb_register_companion(const char *masterbus, USBPort *ports[],
435
                           uint32_t portcount, uint32_t firstport,
436
                           void *opaque, USBPortOps *ops, int speedmask);
437
void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr);
438
void usb_unregister_port(USBBus *bus, USBPort *port);
439
int usb_claim_port(USBDevice *dev);
440
void usb_release_port(USBDevice *dev);
441
int usb_device_attach(USBDevice *dev);
442
int usb_device_detach(USBDevice *dev);
443
int usb_device_delete_addr(int busnr, int addr);
444

    
445
static inline USBBus *usb_bus_from_device(USBDevice *d)
446
{
447
    return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
448
}
449

    
450
extern const VMStateDescription vmstate_usb_device;
451

    
452
#define VMSTATE_USB_DEVICE(_field, _state) {                         \
453
    .name       = (stringify(_field)),                               \
454
    .size       = sizeof(USBDevice),                                 \
455
    .vmsd       = &vmstate_usb_device,                               \
456
    .flags      = VMS_STRUCT,                                        \
457
    .offset     = vmstate_offset_value(_state, _field, USBDevice),   \
458
}
459

    
460
USBDevice *usb_device_find_device(USBDevice *dev, uint8_t addr);
461

    
462
void usb_device_cancel_packet(USBDevice *dev, USBPacket *p);
463

    
464
void usb_device_handle_attach(USBDevice *dev);
465

    
466
void usb_device_handle_reset(USBDevice *dev);
467

    
468
int usb_device_handle_control(USBDevice *dev, USBPacket *p, int request, int value,
469
                              int index, int length, uint8_t *data);
470

    
471
int usb_device_handle_data(USBDevice *dev, USBPacket *p);
472

    
473
void usb_device_set_interface(USBDevice *dev, int interface,
474
                              int alt_old, int alt_new);
475

    
476
const char *usb_device_get_product_desc(USBDevice *dev);
477

    
478
const USBDesc *usb_device_get_usb_desc(USBDevice *dev);
479

    
480
#endif
481