]> Git Repo - qemu.git/blob - hw/usb.h
Merge branch 'trivial-patches' of git://github.com/stefanha/qemu
[qemu.git] / hw / usb.h
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 "qdev.h"
29 #include "qemu-queue.h"
30
31 /* Constants related to the USB / PCI interaction */
32 #define USB_SBRN    0x60 /* Serial Bus Release Number Register */
33 #define USB_RELEASE_1  0x10 /* USB 1.0 */
34 #define USB_RELEASE_2  0x20 /* USB 2.0 */
35 #define USB_RELEASE_3  0x30 /* USB 3.0 */
36
37 #define USB_TOKEN_SETUP 0x2d
38 #define USB_TOKEN_IN    0x69 /* device -> host */
39 #define USB_TOKEN_OUT   0xe1 /* host -> device */
40
41 #define USB_RET_NODEV             (-1)
42 #define USB_RET_NAK               (-2)
43 #define USB_RET_STALL             (-3)
44 #define USB_RET_BABBLE            (-4)
45 #define USB_RET_IOERROR           (-5)
46 #define USB_RET_ASYNC             (-6)
47 #define USB_RET_ADD_TO_QUEUE      (-7)
48 #define USB_RET_REMOVE_FROM_QUEUE (-8)
49
50 #define USB_SPEED_LOW   0
51 #define USB_SPEED_FULL  1
52 #define USB_SPEED_HIGH  2
53 #define USB_SPEED_SUPER 3
54
55 #define USB_SPEED_MASK_LOW   (1 << USB_SPEED_LOW)
56 #define USB_SPEED_MASK_FULL  (1 << USB_SPEED_FULL)
57 #define USB_SPEED_MASK_HIGH  (1 << USB_SPEED_HIGH)
58 #define USB_SPEED_MASK_SUPER (1 << USB_SPEED_SUPER)
59
60 #define USB_STATE_NOTATTACHED 0
61 #define USB_STATE_ATTACHED    1
62 //#define USB_STATE_POWERED     2
63 #define USB_STATE_DEFAULT     3
64 //#define USB_STATE_ADDRESS     4
65 //#define       USB_STATE_CONFIGURED  5
66 #define USB_STATE_SUSPENDED   6
67
68 #define USB_CLASS_AUDIO                 1
69 #define USB_CLASS_COMM                  2
70 #define USB_CLASS_HID                   3
71 #define USB_CLASS_PHYSICAL              5
72 #define USB_CLASS_STILL_IMAGE           6
73 #define USB_CLASS_PRINTER               7
74 #define USB_CLASS_MASS_STORAGE          8
75 #define USB_CLASS_HUB                   9
76 #define USB_CLASS_CDC_DATA              0x0a
77 #define USB_CLASS_CSCID                 0x0b
78 #define USB_CLASS_CONTENT_SEC           0x0d
79 #define USB_CLASS_APP_SPEC              0xfe
80 #define USB_CLASS_VENDOR_SPEC           0xff
81
82 #define USB_SUBCLASS_UNDEFINED          0
83 #define USB_SUBCLASS_AUDIO_CONTROL      1
84 #define USB_SUBCLASS_AUDIO_STREAMING    2
85 #define USB_SUBCLASS_AUDIO_MIDISTREAMING 3
86
87 #define USB_DIR_OUT                     0
88 #define USB_DIR_IN                      0x80
89
90 #define USB_TYPE_MASK                   (0x03 << 5)
91 #define USB_TYPE_STANDARD               (0x00 << 5)
92 #define USB_TYPE_CLASS                  (0x01 << 5)
93 #define USB_TYPE_VENDOR                 (0x02 << 5)
94 #define USB_TYPE_RESERVED               (0x03 << 5)
95
96 #define USB_RECIP_MASK                  0x1f
97 #define USB_RECIP_DEVICE                0x00
98 #define USB_RECIP_INTERFACE             0x01
99 #define USB_RECIP_ENDPOINT              0x02
100 #define USB_RECIP_OTHER                 0x03
101
102 #define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
103 #define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
104 #define InterfaceRequest \
105         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
106 #define InterfaceOutRequest \
107         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
108 #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
109 #define EndpointOutRequest \
110         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
111 #define ClassInterfaceRequest \
112         ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
113 #define ClassInterfaceOutRequest \
114         ((USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
115
116 #define USB_REQ_GET_STATUS              0x00
117 #define USB_REQ_CLEAR_FEATURE           0x01
118 #define USB_REQ_SET_FEATURE             0x03
119 #define USB_REQ_SET_ADDRESS             0x05
120 #define USB_REQ_GET_DESCRIPTOR          0x06
121 #define USB_REQ_SET_DESCRIPTOR          0x07
122 #define USB_REQ_GET_CONFIGURATION       0x08
123 #define USB_REQ_SET_CONFIGURATION       0x09
124 #define USB_REQ_GET_INTERFACE           0x0A
125 #define USB_REQ_SET_INTERFACE           0x0B
126 #define USB_REQ_SYNCH_FRAME             0x0C
127
128 #define USB_DEVICE_SELF_POWERED         0
129 #define USB_DEVICE_REMOTE_WAKEUP        1
130
131 #define USB_DT_DEVICE                   0x01
132 #define USB_DT_CONFIG                   0x02
133 #define USB_DT_STRING                   0x03
134 #define USB_DT_INTERFACE                0x04
135 #define USB_DT_ENDPOINT                 0x05
136 #define USB_DT_DEVICE_QUALIFIER         0x06
137 #define USB_DT_OTHER_SPEED_CONFIG       0x07
138 #define USB_DT_DEBUG                    0x0A
139 #define USB_DT_INTERFACE_ASSOC          0x0B
140 #define USB_DT_BOS                      0x0F
141 #define USB_DT_DEVICE_CAPABILITY        0x10
142 #define USB_DT_CS_INTERFACE             0x24
143 #define USB_DT_CS_ENDPOINT              0x25
144 #define USB_DT_ENDPOINT_COMPANION       0x30
145
146 #define USB_DEV_CAP_WIRELESS            0x01
147 #define USB_DEV_CAP_USB2_EXT            0x02
148 #define USB_DEV_CAP_SUPERSPEED          0x03
149
150 #define USB_ENDPOINT_XFER_CONTROL       0
151 #define USB_ENDPOINT_XFER_ISOC          1
152 #define USB_ENDPOINT_XFER_BULK          2
153 #define USB_ENDPOINT_XFER_INT           3
154 #define USB_ENDPOINT_XFER_INVALID     255
155
156 #define USB_INTERFACE_INVALID         255
157
158 typedef struct USBBus USBBus;
159 typedef struct USBBusOps USBBusOps;
160 typedef struct USBPort USBPort;
161 typedef struct USBDevice USBDevice;
162 typedef struct USBPacket USBPacket;
163 typedef struct USBCombinedPacket USBCombinedPacket;
164 typedef struct USBEndpoint USBEndpoint;
165
166 typedef struct USBDesc USBDesc;
167 typedef struct USBDescID USBDescID;
168 typedef struct USBDescDevice USBDescDevice;
169 typedef struct USBDescConfig USBDescConfig;
170 typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
171 typedef struct USBDescIface USBDescIface;
172 typedef struct USBDescEndpoint USBDescEndpoint;
173 typedef struct USBDescOther USBDescOther;
174 typedef struct USBDescString USBDescString;
175
176 struct USBDescString {
177     uint8_t index;
178     char *str;
179     QLIST_ENTRY(USBDescString) next;
180 };
181
182 #define USB_MAX_ENDPOINTS  15
183 #define USB_MAX_INTERFACES 16
184
185 struct USBEndpoint {
186     uint8_t nr;
187     uint8_t pid;
188     uint8_t type;
189     uint8_t ifnum;
190     int max_packet_size;
191     bool pipeline;
192     bool halted;
193     USBDevice *dev;
194     QTAILQ_HEAD(, USBPacket) queue;
195 };
196
197 enum USBDeviceFlags {
198     USB_DEV_FLAG_FULL_PATH,
199 };
200
201 /* definition of a USB device */
202 struct USBDevice {
203     DeviceState qdev;
204     USBPort *port;
205     char *port_path;
206     void *opaque;
207     uint32_t flags;
208
209     /* Actual connected speed */
210     int speed;
211     /* Supported speeds, not in info because it may be variable (hostdevs) */
212     int speedmask;
213     uint8_t addr;
214     char product_desc[32];
215     int auto_attach;
216     int attached;
217
218     int32_t state;
219     uint8_t setup_buf[8];
220     uint8_t data_buf[4096];
221     int32_t remote_wakeup;
222     int32_t setup_state;
223     int32_t setup_len;
224     int32_t setup_index;
225
226     USBEndpoint ep_ctl;
227     USBEndpoint ep_in[USB_MAX_ENDPOINTS];
228     USBEndpoint ep_out[USB_MAX_ENDPOINTS];
229
230     QLIST_HEAD(, USBDescString) strings;
231     const USBDescDevice *device;
232
233     int configuration;
234     int ninterfaces;
235     int altsetting[USB_MAX_INTERFACES];
236     const USBDescConfig *config;
237     const USBDescIface  *ifaces[USB_MAX_INTERFACES];
238 };
239
240 #define TYPE_USB_DEVICE "usb-device"
241 #define USB_DEVICE(obj) \
242      OBJECT_CHECK(USBDevice, (obj), TYPE_USB_DEVICE)
243 #define USB_DEVICE_CLASS(klass) \
244      OBJECT_CLASS_CHECK(USBDeviceClass, (klass), TYPE_USB_DEVICE)
245 #define USB_DEVICE_GET_CLASS(obj) \
246      OBJECT_GET_CLASS(USBDeviceClass, (obj), TYPE_USB_DEVICE)
247
248 typedef struct USBDeviceClass {
249     DeviceClass parent_class;
250
251     int (*init)(USBDevice *dev);
252
253     /*
254      * Walk (enabled) downstream ports, check for a matching device.
255      * Only hubs implement this.
256      */
257     USBDevice *(*find_device)(USBDevice *dev, uint8_t addr);
258
259     /*
260      * Called when a packet is canceled.
261      */
262     void (*cancel_packet)(USBDevice *dev, USBPacket *p);
263
264     /*
265      * Called when device is destroyed.
266      */
267     void (*handle_destroy)(USBDevice *dev);
268
269     /*
270      * Attach the device
271      */
272     void (*handle_attach)(USBDevice *dev);
273
274     /*
275      * Reset the device
276      */
277     void (*handle_reset)(USBDevice *dev);
278
279     /*
280      * Process control request.
281      * Called from handle_packet().
282      *
283      * Returns length or one of the USB_RET_ codes.
284      */
285     int (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value,
286                           int index, int length, uint8_t *data);
287
288     /*
289      * Process data transfers (both BULK and ISOC).
290      * Called from handle_packet().
291      *
292      * Returns length or one of the USB_RET_ codes.
293      */
294     int (*handle_data)(USBDevice *dev, USBPacket *p);
295
296     void (*set_interface)(USBDevice *dev, int interface,
297                           int alt_old, int alt_new);
298
299     /*
300      * Called when the hcd is done queuing packets for an endpoint, only
301      * necessary for devices which can return USB_RET_ADD_TO_QUEUE.
302      */
303     void (*flush_ep_queue)(USBDevice *dev, USBEndpoint *ep);
304
305     const char *product_desc;
306     const USBDesc *usb_desc;
307 } USBDeviceClass;
308
309 typedef struct USBPortOps {
310     void (*attach)(USBPort *port);
311     void (*detach)(USBPort *port);
312     /*
313      * This gets called when a device downstream from the device attached to
314      * the port (iow attached through a hub) gets detached.
315      */
316     void (*child_detach)(USBPort *port, USBDevice *child);
317     void (*wakeup)(USBPort *port);
318     /*
319      * Note that port->dev will be different then the device from which
320      * the packet originated when a hub is involved.
321      */
322     void (*complete)(USBPort *port, USBPacket *p);
323 } USBPortOps;
324
325 /* USB port on which a device can be connected */
326 struct USBPort {
327     USBDevice *dev;
328     int speedmask;
329     char path[16];
330     USBPortOps *ops;
331     void *opaque;
332     int index; /* internal port index, may be used with the opaque */
333     QTAILQ_ENTRY(USBPort) next;
334 };
335
336 typedef void USBCallback(USBPacket * packet, void *opaque);
337
338 typedef enum USBPacketState {
339     USB_PACKET_UNDEFINED = 0,
340     USB_PACKET_SETUP,
341     USB_PACKET_QUEUED,
342     USB_PACKET_ASYNC,
343     USB_PACKET_COMPLETE,
344     USB_PACKET_CANCELED,
345 } USBPacketState;
346
347 /* Structure used to hold information about an active USB packet.  */
348 struct USBPacket {
349     /* Data fields for use by the driver.  */
350     int pid;
351     uint64_t id;
352     USBEndpoint *ep;
353     QEMUIOVector iov;
354     uint64_t parameter; /* control transfers */
355     bool short_not_ok;
356     bool int_req;
357     int result; /* transfer length or USB_RET_* status code */
358     /* Internal use by the USB layer.  */
359     USBPacketState state;
360     USBCombinedPacket *combined;
361     QTAILQ_ENTRY(USBPacket) queue;
362     QTAILQ_ENTRY(USBPacket) combined_entry;
363 };
364
365 struct USBCombinedPacket {
366     USBPacket *first;
367     QTAILQ_HEAD(packets_head, USBPacket) packets;
368     QEMUIOVector iov;
369 };
370
371 void usb_packet_init(USBPacket *p);
372 void usb_packet_set_state(USBPacket *p, USBPacketState state);
373 void usb_packet_check_state(USBPacket *p, USBPacketState expected);
374 void usb_packet_setup(USBPacket *p, int pid, USBEndpoint *ep, uint64_t id,
375                       bool short_not_ok, bool int_req);
376 void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len);
377 int usb_packet_map(USBPacket *p, QEMUSGList *sgl);
378 void usb_packet_unmap(USBPacket *p, QEMUSGList *sgl);
379 void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes);
380 void usb_packet_skip(USBPacket *p, size_t bytes);
381 void usb_packet_cleanup(USBPacket *p);
382
383 static inline bool usb_packet_is_inflight(USBPacket *p)
384 {
385     return (p->state == USB_PACKET_QUEUED ||
386             p->state == USB_PACKET_ASYNC);
387 }
388
389 USBDevice *usb_find_device(USBPort *port, uint8_t addr);
390
391 int usb_handle_packet(USBDevice *dev, USBPacket *p);
392 void usb_packet_complete(USBDevice *dev, USBPacket *p);
393 void usb_packet_complete_one(USBDevice *dev, USBPacket *p);
394 void usb_cancel_packet(USBPacket * p);
395
396 void usb_ep_init(USBDevice *dev);
397 void usb_ep_reset(USBDevice *dev);
398 void usb_ep_dump(USBDevice *dev);
399 struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep);
400 uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
401 uint8_t usb_ep_get_ifnum(USBDevice *dev, int pid, int ep);
402 void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
403 void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);
404 void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
405                                 uint16_t raw);
406 int usb_ep_get_max_packet_size(USBDevice *dev, int pid, int ep);
407 void usb_ep_set_pipeline(USBDevice *dev, int pid, int ep, bool enabled);
408 USBPacket *usb_ep_find_packet_by_id(USBDevice *dev, int pid, int ep,
409                                     uint64_t id);
410
411 void usb_ep_combine_input_packets(USBEndpoint *ep);
412 void usb_combined_input_packet_complete(USBDevice *dev, USBPacket *p);
413 void usb_combined_packet_cancel(USBDevice *dev, USBPacket *p);
414
415 void usb_attach(USBPort *port);
416 void usb_detach(USBPort *port);
417 void usb_port_reset(USBPort *port);
418 void usb_device_reset(USBDevice *dev);
419 void usb_wakeup(USBEndpoint *ep);
420 void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
421 int set_usb_string(uint8_t *buf, const char *str);
422
423 /* usb-linux.c */
424 USBDevice *usb_host_device_open(USBBus *bus, const char *devname);
425 int usb_host_device_close(const char *devname);
426 void usb_host_info(Monitor *mon);
427
428 /* usb-bt.c */
429 USBDevice *usb_bt_init(USBBus *bus, HCIInfo *hci);
430
431 /* usb ports of the VM */
432
433 #define VM_USB_HUB_SIZE 8
434
435 /* usb-musb.c */
436 enum musb_irq_source_e {
437     musb_irq_suspend = 0,
438     musb_irq_resume,
439     musb_irq_rst_babble,
440     musb_irq_sof,
441     musb_irq_connect,
442     musb_irq_disconnect,
443     musb_irq_vbus_request,
444     musb_irq_vbus_error,
445     musb_irq_rx,
446     musb_irq_tx,
447     musb_set_vbus,
448     musb_set_session,
449     /* Add new interrupts here */
450     musb_irq_max, /* total number of interrupts defined */
451 };
452
453 typedef struct MUSBState MUSBState;
454 MUSBState *musb_init(DeviceState *parent_device, int gpio_base);
455 void musb_reset(MUSBState *s);
456 uint32_t musb_core_intr_get(MUSBState *s);
457 void musb_core_intr_clear(MUSBState *s, uint32_t mask);
458 void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
459
460 /* usb-bus.c */
461
462 #define TYPE_USB_BUS "usb-bus"
463 #define USB_BUS(obj) OBJECT_CHECK(USBBus, (obj), TYPE_USB_BUS)
464
465 struct USBBus {
466     BusState qbus;
467     USBBusOps *ops;
468     int busnr;
469     int nfree;
470     int nused;
471     QTAILQ_HEAD(, USBPort) free;
472     QTAILQ_HEAD(, USBPort) used;
473     QTAILQ_ENTRY(USBBus) next;
474 };
475
476 struct USBBusOps {
477     int (*register_companion)(USBBus *bus, USBPort *ports[],
478                               uint32_t portcount, uint32_t firstport);
479     void (*wakeup_endpoint)(USBBus *bus, USBEndpoint *ep);
480 };
481
482 void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host);
483 USBBus *usb_bus_find(int busnr);
484 void usb_legacy_register(const char *typename, const char *usbdevice_name,
485                          USBDevice *(*usbdevice_init)(USBBus *bus,
486                                                       const char *params));
487 USBDevice *usb_create(USBBus *bus, const char *name);
488 USBDevice *usb_create_simple(USBBus *bus, const char *name);
489 USBDevice *usbdevice_create(const char *cmdline);
490 void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
491                        USBPortOps *ops, int speedmask);
492 int usb_register_companion(const char *masterbus, USBPort *ports[],
493                            uint32_t portcount, uint32_t firstport,
494                            void *opaque, USBPortOps *ops, int speedmask);
495 void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr);
496 void usb_unregister_port(USBBus *bus, USBPort *port);
497 int usb_claim_port(USBDevice *dev);
498 void usb_release_port(USBDevice *dev);
499 int usb_device_attach(USBDevice *dev);
500 int usb_device_detach(USBDevice *dev);
501 int usb_device_delete_addr(int busnr, int addr);
502
503 static inline USBBus *usb_bus_from_device(USBDevice *d)
504 {
505     return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
506 }
507
508 extern const VMStateDescription vmstate_usb_device;
509
510 #define VMSTATE_USB_DEVICE(_field, _state) {                         \
511     .name       = (stringify(_field)),                               \
512     .size       = sizeof(USBDevice),                                 \
513     .vmsd       = &vmstate_usb_device,                               \
514     .flags      = VMS_STRUCT,                                        \
515     .offset     = vmstate_offset_value(_state, _field, USBDevice),   \
516 }
517
518 USBDevice *usb_device_find_device(USBDevice *dev, uint8_t addr);
519
520 void usb_device_cancel_packet(USBDevice *dev, USBPacket *p);
521
522 void usb_device_handle_attach(USBDevice *dev);
523
524 void usb_device_handle_reset(USBDevice *dev);
525
526 int usb_device_handle_control(USBDevice *dev, USBPacket *p, int request, int value,
527                               int index, int length, uint8_t *data);
528
529 int usb_device_handle_data(USBDevice *dev, USBPacket *p);
530
531 void usb_device_set_interface(USBDevice *dev, int interface,
532                               int alt_old, int alt_new);
533
534 void usb_device_flush_ep_queue(USBDevice *dev, USBEndpoint *ep);
535
536 const char *usb_device_get_product_desc(USBDevice *dev);
537
538 const USBDesc *usb_device_get_usb_desc(USBDevice *dev);
539
540 int ehci_create_ich9_with_companions(PCIBus *bus, int slot);
541
542 #endif
543
This page took 0.055563 seconds and 4 git commands to generate.