qdev: don't access name through info
[qemu.git] / hw / usb.h
1 /*
2 * QEMU USB API
3 *
4 * Copyright (c) 2005 Fabrice Bellard
5 *
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 */
24
25 #include "block.h"
26 #include "qdev.h"
27 #include "qemu-queue.h"
28
29 /* Constants related to the USB / PCI interaction */
30 #define USB_SBRN 0x60 /* Serial Bus Release Number Register */
31 #define USB_RELEASE_1 0x10 /* USB 1.0 */
32 #define USB_RELEASE_2 0x20 /* USB 2.0 */
33 #define USB_RELEASE_3 0x30 /* USB 3.0 */
34
35 #define USB_TOKEN_SETUP 0x2d
36 #define USB_TOKEN_IN 0x69 /* device -> host */
37 #define USB_TOKEN_OUT 0xe1 /* host -> device */
38
39 /* specific usb messages, also sent in the 'pid' parameter */
40 #define USB_MSG_ATTACH 0x100
41 #define USB_MSG_DETACH 0x101
42 #define USB_MSG_RESET 0x102
43
44 #define USB_RET_NODEV (-1)
45 #define USB_RET_NAK (-2)
46 #define USB_RET_STALL (-3)
47 #define USB_RET_BABBLE (-4)
48 #define USB_RET_ASYNC (-5)
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_CS_INTERFACE 0x24
141 #define USB_DT_CS_ENDPOINT 0x25
142
143 #define USB_ENDPOINT_XFER_CONTROL 0
144 #define USB_ENDPOINT_XFER_ISOC 1
145 #define USB_ENDPOINT_XFER_BULK 2
146 #define USB_ENDPOINT_XFER_INT 3
147 #define USB_ENDPOINT_XFER_INVALID 255
148
149 typedef struct USBBus USBBus;
150 typedef struct USBBusOps USBBusOps;
151 typedef struct USBPort USBPort;
152 typedef struct USBDevice USBDevice;
153 typedef struct USBDeviceInfo USBDeviceInfo;
154 typedef struct USBPacket USBPacket;
155 typedef struct USBEndpoint USBEndpoint;
156
157 typedef struct USBDesc USBDesc;
158 typedef struct USBDescID USBDescID;
159 typedef struct USBDescDevice USBDescDevice;
160 typedef struct USBDescConfig USBDescConfig;
161 typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
162 typedef struct USBDescIface USBDescIface;
163 typedef struct USBDescEndpoint USBDescEndpoint;
164 typedef struct USBDescOther USBDescOther;
165 typedef struct USBDescString USBDescString;
166
167 struct USBDescString {
168 uint8_t index;
169 char *str;
170 QLIST_ENTRY(USBDescString) next;
171 };
172
173 #define USB_MAX_ENDPOINTS 15
174 #define USB_MAX_INTERFACES 16
175
176 struct USBEndpoint {
177 uint8_t type;
178 uint8_t ifnum;
179 int max_packet_size;
180 USBDevice *dev;
181 };
182
183 /* definition of a USB device */
184 struct USBDevice {
185 DeviceState qdev;
186 USBDeviceInfo *info;
187 USBPort *port;
188 char *port_path;
189 void *opaque;
190
191 /* Actual connected speed */
192 int speed;
193 /* Supported speeds, not in info because it may be variable (hostdevs) */
194 int speedmask;
195 uint8_t addr;
196 char product_desc[32];
197 int auto_attach;
198 int attached;
199
200 int32_t state;
201 uint8_t setup_buf[8];
202 uint8_t data_buf[4096];
203 int32_t remote_wakeup;
204 int32_t setup_state;
205 int32_t setup_len;
206 int32_t setup_index;
207
208 USBEndpoint ep_ctl;
209 USBEndpoint ep_in[USB_MAX_ENDPOINTS];
210 USBEndpoint ep_out[USB_MAX_ENDPOINTS];
211
212 QLIST_HEAD(, USBDescString) strings;
213 const USBDescDevice *device;
214
215 int configuration;
216 int ninterfaces;
217 int altsetting[USB_MAX_INTERFACES];
218 const USBDescConfig *config;
219 const USBDescIface *ifaces[USB_MAX_INTERFACES];
220 };
221
222 struct USBDeviceInfo {
223 DeviceInfo qdev;
224 int (*init)(USBDevice *dev);
225
226 /*
227 * Process USB packet.
228 * Called by the HC (Host Controller).
229 *
230 * Returns length of the transaction
231 * or one of the USB_RET_XXX codes.
232 */
233 int (*handle_packet)(USBDevice *dev, USBPacket *p);
234
235 /*
236 * Called when a packet is canceled.
237 */
238 void (*cancel_packet)(USBDevice *dev, USBPacket *p);
239
240 /*
241 * Called when device is destroyed.
242 */
243 void (*handle_destroy)(USBDevice *dev);
244
245 /*
246 * Attach the device
247 */
248 void (*handle_attach)(USBDevice *dev);
249
250 /*
251 * Reset the device
252 */
253 void (*handle_reset)(USBDevice *dev);
254
255 /*
256 * Process control request.
257 * Called from handle_packet().
258 *
259 * Returns length or one of the USB_RET_ codes.
260 */
261 int (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value,
262 int index, int length, uint8_t *data);
263
264 /*
265 * Process data transfers (both BULK and ISOC).
266 * Called from handle_packet().
267 *
268 * Returns length or one of the USB_RET_ codes.
269 */
270 int (*handle_data)(USBDevice *dev, USBPacket *p);
271
272 void (*set_interface)(USBDevice *dev, int interface,
273 int alt_old, int alt_new);
274
275 const char *product_desc;
276 const USBDesc *usb_desc;
277
278 /* handle legacy -usbdevice command line options */
279 const char *usbdevice_name;
280 USBDevice *(*usbdevice_init)(const char *params);
281 };
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, if you want the orginating
295 * device use p->owner
296 */
297 void (*complete)(USBPort *port, USBPacket *p);
298 } USBPortOps;
299
300 /* USB port on which a device can be connected */
301 struct USBPort {
302 USBDevice *dev;
303 int speedmask;
304 char path[16];
305 USBPortOps *ops;
306 void *opaque;
307 int index; /* internal port index, may be used with the opaque */
308 QTAILQ_ENTRY(USBPort) next;
309 };
310
311 typedef void USBCallback(USBPacket * packet, void *opaque);
312
313 /* Structure used to hold information about an active USB packet. */
314 struct USBPacket {
315 /* Data fields for use by the driver. */
316 int pid;
317 uint8_t devaddr;
318 uint8_t devep;
319 QEMUIOVector iov;
320 int result; /* transfer length or USB_RET_* status code */
321 /* Internal use by the USB layer. */
322 USBEndpoint *owner;
323 };
324
325 void usb_packet_init(USBPacket *p);
326 void usb_packet_setup(USBPacket *p, int pid, uint8_t addr, uint8_t ep);
327 void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len);
328 int usb_packet_map(USBPacket *p, QEMUSGList *sgl);
329 void usb_packet_unmap(USBPacket *p);
330 void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes);
331 void usb_packet_skip(USBPacket *p, size_t bytes);
332 void usb_packet_cleanup(USBPacket *p);
333
334 int usb_handle_packet(USBDevice *dev, USBPacket *p);
335 void usb_packet_complete(USBDevice *dev, USBPacket *p);
336 void usb_cancel_packet(USBPacket * p);
337
338 void usb_ep_init(USBDevice *dev);
339 void usb_ep_dump(USBDevice *dev);
340 struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep);
341 uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
342 uint8_t usb_ep_get_ifnum(USBDevice *dev, int pid, int ep);
343 void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
344 void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);
345 void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
346 uint16_t raw);
347 int usb_ep_get_max_packet_size(USBDevice *dev, int pid, int ep);
348
349 void usb_attach(USBPort *port);
350 void usb_detach(USBPort *port);
351 void usb_reset(USBPort *port);
352 void usb_wakeup(USBDevice *dev);
353 int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
354 void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
355 int set_usb_string(uint8_t *buf, const char *str);
356 void usb_send_msg(USBDevice *dev, int msg);
357
358 /* usb-linux.c */
359 USBDevice *usb_host_device_open(const char *devname);
360 int usb_host_device_close(const char *devname);
361 void usb_host_info(Monitor *mon);
362
363 /* usb-bt.c */
364 USBDevice *usb_bt_init(HCIInfo *hci);
365
366 /* usb ports of the VM */
367
368 #define VM_USB_HUB_SIZE 8
369
370 /* usb-musb.c */
371 enum musb_irq_source_e {
372 musb_irq_suspend = 0,
373 musb_irq_resume,
374 musb_irq_rst_babble,
375 musb_irq_sof,
376 musb_irq_connect,
377 musb_irq_disconnect,
378 musb_irq_vbus_request,
379 musb_irq_vbus_error,
380 musb_irq_rx,
381 musb_irq_tx,
382 musb_set_vbus,
383 musb_set_session,
384 /* Add new interrupts here */
385 musb_irq_max, /* total number of interrupts defined */
386 };
387
388 typedef struct MUSBState MUSBState;
389 MUSBState *musb_init(DeviceState *parent_device, int gpio_base);
390 void musb_reset(MUSBState *s);
391 uint32_t musb_core_intr_get(MUSBState *s);
392 void musb_core_intr_clear(MUSBState *s, uint32_t mask);
393 void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
394
395 /* usb-bus.c */
396
397 struct USBBus {
398 BusState qbus;
399 USBBusOps *ops;
400 int busnr;
401 int nfree;
402 int nused;
403 QTAILQ_HEAD(, USBPort) free;
404 QTAILQ_HEAD(, USBPort) used;
405 QTAILQ_ENTRY(USBBus) next;
406 };
407
408 struct USBBusOps {
409 int (*register_companion)(USBBus *bus, USBPort *ports[],
410 uint32_t portcount, uint32_t firstport);
411 };
412
413 void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host);
414 USBBus *usb_bus_find(int busnr);
415 void usb_qdev_register(USBDeviceInfo *info);
416 void usb_qdev_register_many(USBDeviceInfo *info);
417 USBDevice *usb_create(USBBus *bus, const char *name);
418 USBDevice *usb_create_simple(USBBus *bus, const char *name);
419 USBDevice *usbdevice_create(const char *cmdline);
420 void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
421 USBPortOps *ops, int speedmask);
422 int usb_register_companion(const char *masterbus, USBPort *ports[],
423 uint32_t portcount, uint32_t firstport,
424 void *opaque, USBPortOps *ops, int speedmask);
425 void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr);
426 void usb_unregister_port(USBBus *bus, USBPort *port);
427 int usb_claim_port(USBDevice *dev);
428 void usb_release_port(USBDevice *dev);
429 int usb_device_attach(USBDevice *dev);
430 int usb_device_detach(USBDevice *dev);
431 int usb_device_delete_addr(int busnr, int addr);
432
433 static inline USBBus *usb_bus_from_device(USBDevice *d)
434 {
435 return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
436 }
437
438 extern const VMStateDescription vmstate_usb_device;
439
440 #define VMSTATE_USB_DEVICE(_field, _state) { \
441 .name = (stringify(_field)), \
442 .size = sizeof(USBDevice), \
443 .vmsd = &vmstate_usb_device, \
444 .flags = VMS_STRUCT, \
445 .offset = vmstate_offset_value(_state, _field, USBDevice), \
446 }
447
448