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