]> git.proxmox.com Git - qemu.git/blame - hw/usb.h
list MST as pci layer maintainer
[qemu.git] / hw / usb.h
CommitLineData
bb36d470
FB
1/*
2 * QEMU USB API
5fafdf24 3 *
bb36d470 4 * Copyright (c) 2005 Fabrice Bellard
5fafdf24 5 *
bb36d470
FB
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
c0f4ce77
AL
24
25#include "block.h"
806b6024 26#include "qdev.h"
72cf2d4f 27#include "qemu-queue.h"
c0f4ce77 28
bb36d470
FB
29#define USB_TOKEN_SETUP 0x2d
30#define USB_TOKEN_IN 0x69 /* device -> host */
31#define USB_TOKEN_OUT 0xe1 /* host -> device */
32
33/* specific usb messages, also sent in the 'pid' parameter */
34#define USB_MSG_ATTACH 0x100
35#define USB_MSG_DETACH 0x101
36#define USB_MSG_RESET 0x102
37
5fafdf24 38#define USB_RET_NODEV (-1)
bb36d470
FB
39#define USB_RET_NAK (-2)
40#define USB_RET_STALL (-3)
41#define USB_RET_BABBLE (-4)
4d611c9a 42#define USB_RET_ASYNC (-5)
bb36d470
FB
43
44#define USB_SPEED_LOW 0
45#define USB_SPEED_FULL 1
46#define USB_SPEED_HIGH 2
47
48#define USB_STATE_NOTATTACHED 0
49#define USB_STATE_ATTACHED 1
50//#define USB_STATE_POWERED 2
51#define USB_STATE_DEFAULT 3
52//#define USB_STATE_ADDRESS 4
53//#define USB_STATE_CONFIGURED 5
54#define USB_STATE_SUSPENDED 6
55
a594cfbf
FB
56#define USB_CLASS_AUDIO 1
57#define USB_CLASS_COMM 2
58#define USB_CLASS_HID 3
59#define USB_CLASS_PHYSICAL 5
60#define USB_CLASS_STILL_IMAGE 6
61#define USB_CLASS_PRINTER 7
62#define USB_CLASS_MASS_STORAGE 8
63#define USB_CLASS_HUB 9
64#define USB_CLASS_CDC_DATA 0x0a
65#define USB_CLASS_CSCID 0x0b
66#define USB_CLASS_CONTENT_SEC 0x0d
67#define USB_CLASS_APP_SPEC 0xfe
68#define USB_CLASS_VENDOR_SPEC 0xff
69
bb36d470
FB
70#define USB_DIR_OUT 0
71#define USB_DIR_IN 0x80
72
73#define USB_TYPE_MASK (0x03 << 5)
74#define USB_TYPE_STANDARD (0x00 << 5)
75#define USB_TYPE_CLASS (0x01 << 5)
76#define USB_TYPE_VENDOR (0x02 << 5)
77#define USB_TYPE_RESERVED (0x03 << 5)
78
79#define USB_RECIP_MASK 0x1f
80#define USB_RECIP_DEVICE 0x00
81#define USB_RECIP_INTERFACE 0x01
82#define USB_RECIP_ENDPOINT 0x02
83#define USB_RECIP_OTHER 0x03
84
85#define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
86#define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
59ae540c
FB
87#define InterfaceRequest \
88 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
89#define InterfaceOutRequest \
90 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
91#define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
92#define EndpointOutRequest \
93 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
bb36d470
FB
94
95#define USB_REQ_GET_STATUS 0x00
96#define USB_REQ_CLEAR_FEATURE 0x01
97#define USB_REQ_SET_FEATURE 0x03
98#define USB_REQ_SET_ADDRESS 0x05
99#define USB_REQ_GET_DESCRIPTOR 0x06
100#define USB_REQ_SET_DESCRIPTOR 0x07
101#define USB_REQ_GET_CONFIGURATION 0x08
102#define USB_REQ_SET_CONFIGURATION 0x09
103#define USB_REQ_GET_INTERFACE 0x0A
104#define USB_REQ_SET_INTERFACE 0x0B
105#define USB_REQ_SYNCH_FRAME 0x0C
106
107#define USB_DEVICE_SELF_POWERED 0
108#define USB_DEVICE_REMOTE_WAKEUP 1
109
110#define USB_DT_DEVICE 0x01
111#define USB_DT_CONFIG 0x02
112#define USB_DT_STRING 0x03
113#define USB_DT_INTERFACE 0x04
114#define USB_DT_ENDPOINT 0x05
115
942ac052
AZ
116#define USB_ENDPOINT_XFER_CONTROL 0
117#define USB_ENDPOINT_XFER_ISOC 1
118#define USB_ENDPOINT_XFER_BULK 2
119#define USB_ENDPOINT_XFER_INT 3
120
806b6024 121typedef struct USBBus USBBus;
bb36d470
FB
122typedef struct USBPort USBPort;
123typedef struct USBDevice USBDevice;
806b6024 124typedef struct USBDeviceInfo USBDeviceInfo;
4d611c9a 125typedef struct USBPacket USBPacket;
bb36d470
FB
126
127/* definition of a USB device */
128struct USBDevice {
806b6024
GH
129 DeviceState qdev;
130 USBDeviceInfo *info;
bb36d470 131 void *opaque;
89b9b79f 132
806b6024
GH
133 int speed;
134 uint8_t addr;
0fe6d12e 135 char product_desc[32];
61e094c0 136 int auto_attach;
a5d2f727 137 int attached;
806b6024
GH
138
139 int state;
140 uint8_t setup_buf[8];
141 uint8_t data_buf[1024];
142 int remote_wakeup;
143 int setup_state;
144 int setup_len;
145 int setup_index;
146};
147
148struct USBDeviceInfo {
149 DeviceInfo qdev;
150 int (*init)(USBDevice *dev);
151
152 /*
153 * Process USB packet.
89b9b79f
AL
154 * Called by the HC (Host Controller).
155 *
806b6024 156 * Returns length of the transaction
89b9b79f 157 * or one of the USB_RET_XXX codes.
806b6024 158 */
4d611c9a 159 int (*handle_packet)(USBDevice *dev, USBPacket *p);
89b9b79f 160
806b6024 161 /*
89b9b79f
AL
162 * Called when device is destroyed.
163 */
059809e4
FB
164 void (*handle_destroy)(USBDevice *dev);
165
89b9b79f
AL
166 /*
167 * Reset the device
806b6024 168 */
059809e4 169 void (*handle_reset)(USBDevice *dev);
89b9b79f
AL
170
171 /*
172 * Process control request.
173 * Called from handle_packet().
174 *
175 * Returns length or one of the USB_RET_ codes.
176 */
bb36d470
FB
177 int (*handle_control)(USBDevice *dev, int request, int value,
178 int index, int length, uint8_t *data);
89b9b79f
AL
179
180 /*
181 * Process data transfers (both BULK and ISOC).
182 * Called from handle_packet().
183 *
184 * Returns length or one of the USB_RET_ codes.
185 */
4d611c9a 186 int (*handle_data)(USBDevice *dev, USBPacket *p);
0958b4cc 187
06384698
MA
188 const char *product_desc;
189
0958b4cc
GH
190 /* handle legacy -usbdevice command line options */
191 const char *usbdevice_name;
192 USBDevice *(*usbdevice_init)(const char *params);
bb36d470
FB
193};
194
0d92ed30
PB
195typedef void (*usb_attachfn)(USBPort *port, USBDevice *dev);
196
bb36d470
FB
197/* USB port on which a device can be connected */
198struct USBPort {
a594cfbf 199 USBDevice *dev;
0d92ed30 200 usb_attachfn attach;
bb36d470
FB
201 void *opaque;
202 int index; /* internal port index, may be used with the opaque */
72cf2d4f 203 QTAILQ_ENTRY(USBPort) next;
bb36d470
FB
204};
205
4d611c9a
PB
206typedef void USBCallback(USBPacket * packet, void *opaque);
207
208/* Structure used to hold information about an active USB packet. */
209struct USBPacket {
210 /* Data fields for use by the driver. */
211 int pid;
212 uint8_t devaddr;
213 uint8_t devep;
214 uint8_t *data;
215 int len;
216 /* Internal use by the USB layer. */
217 USBCallback *complete_cb;
218 void *complete_opaque;
219 USBCallback *cancel_cb;
b63891a0 220 void *cancel_opaque;
4d611c9a
PB
221};
222
223/* Defer completion of a USB packet. The hadle_packet routine should then
224 return USB_RET_ASYNC. Packets that complete immediately (before
225 handle_packet returns) should not call this method. */
226static inline void usb_defer_packet(USBPacket *p, USBCallback *cancel,
227 void * opaque)
228{
229 p->cancel_cb = cancel;
230 p->cancel_opaque = opaque;
231}
232
233/* Notify the controller that an async packet is complete. This should only
234 be called for packets previously deferred with usb_defer_packet, and
235 should never be called from within handle_packet. */
236static inline void usb_packet_complete(USBPacket *p)
237{
238 p->complete_cb(p, p->complete_opaque);
239}
240
241/* Cancel an active packet. The packed must have been deferred with
242 usb_defer_packet, and not yet completed. */
243static inline void usb_cancel_packet(USBPacket * p)
244{
245 p->cancel_cb(p, p->cancel_opaque);
246}
247
bb36d470 248void usb_attach(USBPort *port, USBDevice *dev);
4d611c9a 249int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
bb36d470 250int set_usb_string(uint8_t *buf, const char *str);
4d611c9a
PB
251void usb_send_msg(USBDevice *dev, int msg);
252
bb36d470 253/* usb-linux.c */
a594cfbf 254USBDevice *usb_host_device_open(const char *devname);
5d0c5750 255int usb_host_device_close(const char *devname);
376253ec 256void usb_host_info(Monitor *mon);
59ae540c
FB
257
258/* usb-hid.c */
47e699dc 259void usb_hid_datain_cb(USBDevice *dev, void *opaque, void (*datain)(void *));
2e5d83bb 260
e6a6d5ab
AZ
261/* usb-bt.c */
262USBDevice *usb_bt_init(HCIInfo *hci);
263
87ecb68b
PB
264/* usb ports of the VM */
265
87ecb68b
PB
266#define VM_USB_HUB_SIZE 8
267
942ac052
AZ
268/* usb-musb.c */
269enum musb_irq_source_e {
270 musb_irq_suspend = 0,
271 musb_irq_resume,
272 musb_irq_rst_babble,
273 musb_irq_sof,
274 musb_irq_connect,
275 musb_irq_disconnect,
276 musb_irq_vbus_request,
277 musb_irq_vbus_error,
278 musb_irq_rx,
279 musb_irq_tx,
280 musb_set_vbus,
281 musb_set_session,
282 __musb_irq_max,
283};
284
bc24a225
PB
285typedef struct MUSBState MUSBState;
286MUSBState *musb_init(qemu_irq *irqs);
287uint32_t musb_core_intr_get(MUSBState *s);
288void musb_core_intr_clear(MUSBState *s, uint32_t mask);
289void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
806b6024
GH
290
291/* usb-bus.c */
292
293struct USBBus {
294 BusState qbus;
295 int busnr;
296 int nfree;
297 int nused;
72cf2d4f
BS
298 QTAILQ_HEAD(, USBPort) free;
299 QTAILQ_HEAD(, USBPort) used;
300 QTAILQ_ENTRY(USBBus) next;
806b6024
GH
301};
302
b2317837 303void usb_bus_new(USBBus *bus, DeviceState *host);
806b6024
GH
304USBBus *usb_bus_find(int busnr);
305void usb_qdev_register(USBDeviceInfo *info);
306void usb_qdev_register_many(USBDeviceInfo *info);
a5d2f727 307USBDevice *usb_create(USBBus *bus, const char *name);
806b6024 308USBDevice *usb_create_simple(USBBus *bus, const char *name);
0958b4cc 309USBDevice *usbdevice_create(const char *cmdline);
a5d2f727
GH
310void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
311 usb_attachfn attach);
a8e662b5 312void usb_unregister_port(USBBus *bus, USBPort *port);
a5d2f727 313int usb_device_attach(USBDevice *dev);
a8e662b5 314int usb_device_detach(USBDevice *dev);
a5d2f727
GH
315int usb_device_delete_addr(int busnr, int addr);
316
317static inline USBBus *usb_bus_from_device(USBDevice *d)
318{
319 return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
320}