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