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