]> git.proxmox.com Git - qemu.git/blame - hw/usb.h
qdev/usb: add usb bus support to qdev, convert drivers.
[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"
c0f4ce77 27
bb36d470
FB
28#define USB_TOKEN_SETUP 0x2d
29#define USB_TOKEN_IN 0x69 /* device -> host */
30#define USB_TOKEN_OUT 0xe1 /* host -> device */
31
32/* specific usb messages, also sent in the 'pid' parameter */
33#define USB_MSG_ATTACH 0x100
34#define USB_MSG_DETACH 0x101
35#define USB_MSG_RESET 0x102
36
5fafdf24 37#define USB_RET_NODEV (-1)
bb36d470
FB
38#define USB_RET_NAK (-2)
39#define USB_RET_STALL (-3)
40#define USB_RET_BABBLE (-4)
4d611c9a 41#define USB_RET_ASYNC (-5)
bb36d470
FB
42
43#define USB_SPEED_LOW 0
44#define USB_SPEED_FULL 1
45#define USB_SPEED_HIGH 2
46
47#define USB_STATE_NOTATTACHED 0
48#define USB_STATE_ATTACHED 1
49//#define USB_STATE_POWERED 2
50#define USB_STATE_DEFAULT 3
51//#define USB_STATE_ADDRESS 4
52//#define USB_STATE_CONFIGURED 5
53#define USB_STATE_SUSPENDED 6
54
a594cfbf
FB
55#define USB_CLASS_AUDIO 1
56#define USB_CLASS_COMM 2
57#define USB_CLASS_HID 3
58#define USB_CLASS_PHYSICAL 5
59#define USB_CLASS_STILL_IMAGE 6
60#define USB_CLASS_PRINTER 7
61#define USB_CLASS_MASS_STORAGE 8
62#define USB_CLASS_HUB 9
63#define USB_CLASS_CDC_DATA 0x0a
64#define USB_CLASS_CSCID 0x0b
65#define USB_CLASS_CONTENT_SEC 0x0d
66#define USB_CLASS_APP_SPEC 0xfe
67#define USB_CLASS_VENDOR_SPEC 0xff
68
bb36d470
FB
69#define USB_DIR_OUT 0
70#define USB_DIR_IN 0x80
71
72#define USB_TYPE_MASK (0x03 << 5)
73#define USB_TYPE_STANDARD (0x00 << 5)
74#define USB_TYPE_CLASS (0x01 << 5)
75#define USB_TYPE_VENDOR (0x02 << 5)
76#define USB_TYPE_RESERVED (0x03 << 5)
77
78#define USB_RECIP_MASK 0x1f
79#define USB_RECIP_DEVICE 0x00
80#define USB_RECIP_INTERFACE 0x01
81#define USB_RECIP_ENDPOINT 0x02
82#define USB_RECIP_OTHER 0x03
83
84#define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
85#define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
59ae540c
FB
86#define InterfaceRequest \
87 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
88#define InterfaceOutRequest \
89 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
90#define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
91#define EndpointOutRequest \
92 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
bb36d470
FB
93
94#define USB_REQ_GET_STATUS 0x00
95#define USB_REQ_CLEAR_FEATURE 0x01
96#define USB_REQ_SET_FEATURE 0x03
97#define USB_REQ_SET_ADDRESS 0x05
98#define USB_REQ_GET_DESCRIPTOR 0x06
99#define USB_REQ_SET_DESCRIPTOR 0x07
100#define USB_REQ_GET_CONFIGURATION 0x08
101#define USB_REQ_SET_CONFIGURATION 0x09
102#define USB_REQ_GET_INTERFACE 0x0A
103#define USB_REQ_SET_INTERFACE 0x0B
104#define USB_REQ_SYNCH_FRAME 0x0C
105
106#define USB_DEVICE_SELF_POWERED 0
107#define USB_DEVICE_REMOTE_WAKEUP 1
108
109#define USB_DT_DEVICE 0x01
110#define USB_DT_CONFIG 0x02
111#define USB_DT_STRING 0x03
112#define USB_DT_INTERFACE 0x04
113#define USB_DT_ENDPOINT 0x05
114
942ac052
AZ
115#define USB_ENDPOINT_XFER_CONTROL 0
116#define USB_ENDPOINT_XFER_ISOC 1
117#define USB_ENDPOINT_XFER_BULK 2
118#define USB_ENDPOINT_XFER_INT 3
119
806b6024 120typedef struct USBBus USBBus;
bb36d470
FB
121typedef struct USBPort USBPort;
122typedef struct USBDevice USBDevice;
806b6024 123typedef struct USBDeviceInfo USBDeviceInfo;
4d611c9a 124typedef struct USBPacket USBPacket;
bb36d470
FB
125
126/* definition of a USB device */
127struct USBDevice {
806b6024
GH
128 DeviceState qdev;
129 USBDeviceInfo *info;
bb36d470 130 void *opaque;
89b9b79f 131
806b6024
GH
132 int speed;
133 uint8_t addr;
134 char devname[32];
135
136 int state;
137 uint8_t setup_buf[8];
138 uint8_t data_buf[1024];
139 int remote_wakeup;
140 int setup_state;
141 int setup_len;
142 int setup_index;
143};
144
145struct USBDeviceInfo {
146 DeviceInfo qdev;
147 int (*init)(USBDevice *dev);
148
149 /*
150 * Process USB packet.
89b9b79f
AL
151 * Called by the HC (Host Controller).
152 *
806b6024 153 * Returns length of the transaction
89b9b79f 154 * or one of the USB_RET_XXX codes.
806b6024 155 */
4d611c9a 156 int (*handle_packet)(USBDevice *dev, USBPacket *p);
89b9b79f 157
806b6024 158 /*
89b9b79f
AL
159 * Called when device is destroyed.
160 */
059809e4
FB
161 void (*handle_destroy)(USBDevice *dev);
162
89b9b79f
AL
163 /*
164 * Reset the device
806b6024 165 */
059809e4 166 void (*handle_reset)(USBDevice *dev);
89b9b79f
AL
167
168 /*
169 * Process control request.
170 * Called from handle_packet().
171 *
172 * Returns length or one of the USB_RET_ codes.
173 */
bb36d470
FB
174 int (*handle_control)(USBDevice *dev, int request, int value,
175 int index, int length, uint8_t *data);
89b9b79f
AL
176
177 /*
178 * Process data transfers (both BULK and ISOC).
179 * Called from handle_packet().
180 *
181 * Returns length or one of the USB_RET_ codes.
182 */
4d611c9a 183 int (*handle_data)(USBDevice *dev, USBPacket *p);
bb36d470
FB
184};
185
0d92ed30
PB
186typedef void (*usb_attachfn)(USBPort *port, USBDevice *dev);
187
bb36d470
FB
188/* USB port on which a device can be connected */
189struct USBPort {
a594cfbf 190 USBDevice *dev;
0d92ed30 191 usb_attachfn attach;
bb36d470
FB
192 void *opaque;
193 int index; /* internal port index, may be used with the opaque */
0d92ed30 194 struct USBPort *next; /* Used internally by qemu. */
bb36d470
FB
195};
196
4d611c9a
PB
197typedef void USBCallback(USBPacket * packet, void *opaque);
198
199/* Structure used to hold information about an active USB packet. */
200struct USBPacket {
201 /* Data fields for use by the driver. */
202 int pid;
203 uint8_t devaddr;
204 uint8_t devep;
205 uint8_t *data;
206 int len;
207 /* Internal use by the USB layer. */
208 USBCallback *complete_cb;
209 void *complete_opaque;
210 USBCallback *cancel_cb;
b63891a0 211 void *cancel_opaque;
4d611c9a
PB
212};
213
214/* Defer completion of a USB packet. The hadle_packet routine should then
215 return USB_RET_ASYNC. Packets that complete immediately (before
216 handle_packet returns) should not call this method. */
217static inline void usb_defer_packet(USBPacket *p, USBCallback *cancel,
218 void * opaque)
219{
220 p->cancel_cb = cancel;
221 p->cancel_opaque = opaque;
222}
223
224/* Notify the controller that an async packet is complete. This should only
225 be called for packets previously deferred with usb_defer_packet, and
226 should never be called from within handle_packet. */
227static inline void usb_packet_complete(USBPacket *p)
228{
229 p->complete_cb(p, p->complete_opaque);
230}
231
232/* Cancel an active packet. The packed must have been deferred with
233 usb_defer_packet, and not yet completed. */
234static inline void usb_cancel_packet(USBPacket * p)
235{
236 p->cancel_cb(p, p->cancel_opaque);
237}
238
4b096fc9 239int usb_device_add_dev(USBDevice *dev);
1f3870ab 240int usb_device_del_addr(int bus_num, int addr);
bb36d470 241void usb_attach(USBPort *port, USBDevice *dev);
4d611c9a 242int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
bb36d470 243int set_usb_string(uint8_t *buf, const char *str);
4d611c9a
PB
244void usb_send_msg(USBDevice *dev, int msg);
245
bb36d470 246/* usb hub */
0d92ed30 247USBDevice *usb_hub_init(int nb_ports);
bb36d470 248
bb36d470 249/* usb-linux.c */
a594cfbf 250USBDevice *usb_host_device_open(const char *devname);
5d0c5750 251int usb_host_device_close(const char *devname);
376253ec 252void usb_host_info(Monitor *mon);
59ae540c
FB
253
254/* usb-hid.c */
255USBDevice *usb_mouse_init(void);
09b26c5e 256USBDevice *usb_tablet_init(void);
47b2d338 257USBDevice *usb_keyboard_init(void);
47e699dc 258void usb_hid_datain_cb(USBDevice *dev, void *opaque, void (*datain)(void *));
2e5d83bb
PB
259
260/* usb-msd.c */
bb5fc20f
AL
261USBDevice *usb_msd_init(const char *filename);
262BlockDriverState *usb_msd_get_bdrv(USBDevice *dev);
f6d2a316 263
6c9f886c
AZ
264/* usb-net.c */
265USBDevice *usb_net_init(NICInfo *nd);
266
e6a6d5ab
AZ
267/* usb-bt.c */
268USBDevice *usb_bt_init(HCIInfo *hci);
269
f6d2a316
AZ
270/* usb-wacom.c */
271USBDevice *usb_wacom_init(void);
87ecb68b 272
a7954218
AZ
273/* usb-serial.c */
274USBDevice *usb_serial_init(const char *filename);
275
87ecb68b
PB
276/* usb ports of the VM */
277
278void qemu_register_usb_port(USBPort *port, void *opaque, int index,
279 usb_attachfn attach);
280
281#define VM_USB_HUB_SIZE 8
282
942ac052
AZ
283/* usb-musb.c */
284enum musb_irq_source_e {
285 musb_irq_suspend = 0,
286 musb_irq_resume,
287 musb_irq_rst_babble,
288 musb_irq_sof,
289 musb_irq_connect,
290 musb_irq_disconnect,
291 musb_irq_vbus_request,
292 musb_irq_vbus_error,
293 musb_irq_rx,
294 musb_irq_tx,
295 musb_set_vbus,
296 musb_set_session,
297 __musb_irq_max,
298};
299
bc24a225
PB
300typedef struct MUSBState MUSBState;
301MUSBState *musb_init(qemu_irq *irqs);
302uint32_t musb_core_intr_get(MUSBState *s);
303void musb_core_intr_clear(MUSBState *s, uint32_t mask);
304void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
806b6024
GH
305
306/* usb-bus.c */
307
308struct USBBus {
309 BusState qbus;
310 int busnr;
311 int nfree;
312 int nused;
313 TAILQ_HEAD(, USBPort) free;
314 TAILQ_HEAD(, USBPort) used;
315 TAILQ_ENTRY(USBBus) next;
316};
317
318USBBus *usb_bus_new(DeviceState *host);
319USBBus *usb_bus_find(int busnr);
320void usb_qdev_register(USBDeviceInfo *info);
321void usb_qdev_register_many(USBDeviceInfo *info);
322USBDevice *usb_create_simple(USBBus *bus, const char *name);