ths
authored
17 years ago
1
/*
2
3
4
5
6
7
8
9
* USB Mass Storage Device emulation
*
* Copyright ( c ) 2006 CodeSourcery .
* Written by Paul Brook
*
* This code is licenced under the LGPL .
*/
10
11
12
13
# include "qemu-common.h"
# include "usb.h"
# include "block.h"
# include "scsi-disk.h"
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
// # define DEBUG_MSD
# ifdef DEBUG_MSD
# define DPRINTF ( fmt , args ...) \
do { printf ( "usb-msd: " fmt , ## args ); } while ( 0 )
# else
# define DPRINTF ( fmt , args ...) do {} while ( 0 )
# endif
/* USB requests. */
# define MassStorageReset 0xff
# define GetMaxLun 0xfe
enum USBMSDMode {
USB_MSDM_CBW , /* Command Block. */
USB_MSDM_DATAOUT , /* Tranfer data to device. */
USB_MSDM_DATAIN , /* Transfer data from device. */
USB_MSDM_CSW /* Command Status. */
};
typedef struct {
USBDevice dev ;
enum USBMSDMode mode ;
38
39
40
41
uint32_t scsi_len ;
uint8_t * scsi_buf ;
uint32_t usb_len ;
uint8_t * usb_buf ;
42
uint32_t data_len ;
43
uint32_t residue ;
44
uint32_t tag ;
45
BlockDriverState * bs ;
46
47
SCSIDevice * scsi_dev ;
int result ;
48
49
/* For async completion. */
USBPacket * packet ;
50
51
} MSDState ;
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
struct usb_msd_cbw {
uint32_t sig ;
uint32_t tag ;
uint32_t data_len ;
uint8_t flags ;
uint8_t lun ;
uint8_t cmd_len ;
uint8_t cmd [ 16 ];
};
struct usb_msd_csw {
uint32_t sig ;
uint32_t tag ;
uint32_t residue ;
uint8_t status ;
};
69
70
71
static const uint8_t qemu_msd_dev_descriptor [] = {
0x12 , /* u8 bLength; */
0x01 , /* u8 bDescriptorType; Device */
ths
authored
18 years ago
72
0x00 , 0x01 , /* u16 bcdUSB; v1.0 */
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
0x00 , /* u8 bDeviceClass; */
0x00 , /* u8 bDeviceSubClass; */
0x00 , /* u8 bDeviceProtocol; [ low/full speeds only ] */
0x08 , /* u8 bMaxPacketSize0; 8 Bytes */
/* Vendor and product id are arbitrary. */
0x00 , 0x00 , /* u16 idVendor; */
0x00 , 0x00 , /* u16 idProduct; */
0x00 , 0x00 , /* u16 bcdDevice */
0x01 , /* u8 iManufacturer; */
0x02 , /* u8 iProduct; */
0x03 , /* u8 iSerialNumber; */
0x01 /* u8 bNumConfigurations; */
};
static const uint8_t qemu_msd_config_descriptor [] = {
/* one configuration */
0x09 , /* u8 bLength; */
0x02 , /* u8 bDescriptorType; Configuration */
0x20 , 0x00 , /* u16 wTotalLength; */
0x01 , /* u8 bNumInterfaces; (1) */
0x01 , /* u8 bConfigurationValue; */
0x00 , /* u8 iConfiguration; */
ths
authored
17 years ago
99
0xc0 , /* u8 bmAttributes ;
100
101
102
103
104
Bit 7 : must be set ,
6 : Self - powered ,
5 : Remote wakeup ,
4 .. 0 : resvd */
0x00 , /* u8 MaxPower; */
ths
authored
17 years ago
105
106
107
108
109
110
111
112
113
114
115
/* one interface */
0x09 , /* u8 if_bLength; */
0x04 , /* u8 if_bDescriptorType; Interface */
0x00 , /* u8 if_bInterfaceNumber; */
0x00 , /* u8 if_bAlternateSetting; */
0x02 , /* u8 if_bNumEndpoints; */
0x08 , /* u8 if_bInterfaceClass; MASS STORAGE */
0x06 , /* u8 if_bInterfaceSubClass; SCSI */
0x50 , /* u8 if_bInterfaceProtocol; Bulk Only */
0x00 , /* u8 if_iInterface; */
ths
authored
17 years ago
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/* Bulk-In endpoint */
0x07 , /* u8 ep_bLength; */
0x05 , /* u8 ep_bDescriptorType; Endpoint */
0x81 , /* u8 ep_bEndpointAddress; IN Endpoint 1 */
0x02 , /* u8 ep_bmAttributes; Bulk */
0x40 , 0x00 , /* u16 ep_wMaxPacketSize; */
0x00 , /* u8 ep_bInterval; */
/* Bulk-Out endpoint */
0x07 , /* u8 ep_bLength; */
0x05 , /* u8 ep_bDescriptorType; Endpoint */
0x02 , /* u8 ep_bEndpointAddress; OUT Endpoint 2 */
0x02 , /* u8 ep_bmAttributes; Bulk */
0x40 , 0x00 , /* u16 ep_wMaxPacketSize; */
0x00 /* u8 ep_bInterval; */
};
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
static void usb_msd_copy_data ( MSDState * s )
{
uint32_t len ;
len = s -> usb_len ;
if ( len > s -> scsi_len )
len = s -> scsi_len ;
if ( s -> mode == USB_MSDM_DATAIN ) {
memcpy ( s -> usb_buf , s -> scsi_buf , len );
} else {
memcpy ( s -> scsi_buf , s -> usb_buf , len );
}
s -> usb_len -= len ;
s -> scsi_len -= len ;
s -> usb_buf += len ;
s -> scsi_buf += len ;
s -> data_len -= len ;
if ( s -> scsi_len == 0 ) {
if ( s -> mode == USB_MSDM_DATAIN ) {
ths
authored
17 years ago
152
s -> scsi_dev -> read_data ( s -> scsi_dev , s -> tag );
153
} else if ( s -> mode == USB_MSDM_DATAOUT ) {
ths
authored
17 years ago
154
s -> scsi_dev -> write_data ( s -> scsi_dev , s -> tag );
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
}
}
}
static void usb_msd_send_status ( MSDState * s )
{
struct usb_msd_csw csw ;
csw . sig = cpu_to_le32 ( 0x53425355 );
csw . tag = cpu_to_le32 ( s -> tag );
csw . residue = s -> residue ;
csw . status = s -> result ;
memcpy ( s -> usb_buf , & csw , 13 );
}
static void usb_msd_command_complete ( void * opaque , int reason , uint32_t tag ,
uint32_t arg )
172
173
{
MSDState * s = ( MSDState * ) opaque ;
174
USBPacket * p = s -> packet ;
175
176
177
178
if ( tag != s -> tag ) {
fprintf ( stderr , "usb-msd: Unexpected SCSI Tag 0x%x \n " , tag );
}
179
if ( reason == SCSI_REASON_DONE ) {
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
DPRINTF ( "Command complete %d \n " , arg );
s -> residue = s -> data_len ;
s -> result = arg != 0 ;
if ( s -> packet ) {
if ( s -> data_len == 0 && s -> mode == USB_MSDM_DATAOUT ) {
/* A deferred packet with no write data remaining must be
the status read packet . */
usb_msd_send_status ( s );
s -> mode = USB_MSDM_CBW ;
} else {
if ( s -> data_len ) {
s -> data_len -= s -> usb_len ;
if ( s -> mode == USB_MSDM_DATAIN )
memset ( s -> usb_buf , 0 , s -> usb_len );
s -> usb_len = 0 ;
}
if ( s -> data_len == 0 )
s -> mode = USB_MSDM_CSW ;
}
s -> packet = NULL ;
usb_packet_complete ( p );
} else if ( s -> data_len == 0 ) {
s -> mode = USB_MSDM_CSW ;
}
return ;
205
}
206
s -> scsi_len = arg ;
ths
authored
17 years ago
207
s -> scsi_buf = s -> scsi_dev -> get_buf ( s -> scsi_dev , tag );
208
209
210
211
212
213
214
215
216
217
if ( p ) {
usb_msd_copy_data ( s );
if ( s -> usb_len == 0 ) {
/* Set s -> packet to NULL before calling usb_packet_complete
because annother request may be issued before
usb_packet_complete returns . */
DPRINTF ( "Packet complete %p \n " , p );
s -> packet = NULL ;
usb_packet_complete ( p );
}
218
}
219
220
}
221
static void usb_msd_handle_reset ( USBDevice * dev )
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
{
MSDState * s = ( MSDState * ) dev ;
DPRINTF ( "Reset \n " );
s -> mode = USB_MSDM_CBW ;
}
static int usb_msd_handle_control ( USBDevice * dev , int request , int value ,
int index , int length , uint8_t * data )
{
MSDState * s = ( MSDState * ) dev ;
int ret = 0 ;
switch ( request ) {
case DeviceRequest | USB_REQ_GET_STATUS :
data [ 0 ] = ( 1 << USB_DEVICE_SELF_POWERED ) |
( dev -> remote_wakeup << USB_DEVICE_REMOTE_WAKEUP );
data [ 1 ] = 0x00 ;
ret = 2 ;
break ;
case DeviceOutRequest | USB_REQ_CLEAR_FEATURE :
if ( value == USB_DEVICE_REMOTE_WAKEUP ) {
dev -> remote_wakeup = 0 ;
} else {
goto fail ;
}
ret = 0 ;
break ;
case DeviceOutRequest | USB_REQ_SET_FEATURE :
if ( value == USB_DEVICE_REMOTE_WAKEUP ) {
dev -> remote_wakeup = 1 ;
} else {
goto fail ;
}
ret = 0 ;
break ;
case DeviceOutRequest | USB_REQ_SET_ADDRESS :
dev -> addr = value ;
ret = 0 ;
break ;
case DeviceRequest | USB_REQ_GET_DESCRIPTOR :
switch ( value >> 8 ) {
case USB_DT_DEVICE :
ths
authored
17 years ago
265
memcpy ( data , qemu_msd_dev_descriptor ,
266
267
268
269
sizeof ( qemu_msd_dev_descriptor ));
ret = sizeof ( qemu_msd_dev_descriptor );
break ;
case USB_DT_CONFIG :
ths
authored
17 years ago
270
memcpy ( data , qemu_msd_config_descriptor ,
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
sizeof ( qemu_msd_config_descriptor ));
ret = sizeof ( qemu_msd_config_descriptor );
break ;
case USB_DT_STRING :
switch ( value & 0xff ) {
case 0 :
/* language ids */
data [ 0 ] = 4 ;
data [ 1 ] = 3 ;
data [ 2 ] = 0x09 ;
data [ 3 ] = 0x04 ;
ret = 4 ;
break ;
case 1 :
/* vendor description */
ret = set_usb_string ( data , "QEMU " QEMU_VERSION );
break ;
case 2 :
/* product description */
ret = set_usb_string ( data , "QEMU USB HARDDRIVE" );
break ;
case 3 :
/* serial number */
ret = set_usb_string ( data , "1" );
break ;
default :
goto fail ;
}
break ;
default :
goto fail ;
}
break ;
case DeviceRequest | USB_REQ_GET_CONFIGURATION :
data [ 0 ] = 1 ;
ret = 1 ;
break ;
case DeviceOutRequest | USB_REQ_SET_CONFIGURATION :
ret = 0 ;
break ;
case DeviceRequest | USB_REQ_GET_INTERFACE :
data [ 0 ] = 0 ;
ret = 1 ;
break ;
case DeviceOutRequest | USB_REQ_SET_INTERFACE :
ret = 0 ;
break ;
case EndpointOutRequest | USB_REQ_CLEAR_FEATURE :
if ( value == 0 && index != 0x81 ) { /* clear ep halt */
goto fail ;
}
ret = 0 ;
break ;
/* Class specific requests. */
case MassStorageReset :
/* Reset state ready for the next CBW. */
s -> mode = USB_MSDM_CBW ;
ret = 0 ;
break ;
case GetMaxLun :
data [ 0 ] = 0 ;
ret = 1 ;
break ;
default :
fail :
ret = USB_RET_STALL ;
break ;
}
return ret ;
}
342
343
344
static void usb_msd_cancel_io ( USBPacket * p , void * opaque )
{
MSDState * s = opaque ;
ths
authored
17 years ago
345
s -> scsi_dev -> cancel_io ( s -> scsi_dev , s -> tag );
346
s -> packet = NULL ;
347
s -> scsi_len = 0 ;
348
349
350
}
static int usb_msd_handle_data ( USBDevice * dev , USBPacket * p )
351
352
353
354
{
MSDState * s = ( MSDState * ) dev ;
int ret = 0 ;
struct usb_msd_cbw cbw ;
355
356
357
uint8_t devep = p -> devep ;
uint8_t * data = p -> data ;
int len = p -> len ;
358
359
switch ( p -> pid ) {
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
case USB_TOKEN_OUT :
if ( devep != 2 )
goto fail ;
switch ( s -> mode ) {
case USB_MSDM_CBW :
if ( len != 31 ) {
fprintf ( stderr , "usb-msd: Bad CBW size" );
goto fail ;
}
memcpy ( & cbw , data , 31 );
if ( le32_to_cpu ( cbw . sig ) != 0x43425355 ) {
fprintf ( stderr , "usb-msd: Bad signature %08x \n " ,
le32_to_cpu ( cbw . sig ));
goto fail ;
}
DPRINTF ( "Command on LUN %d \n " , cbw . lun );
if ( cbw . lun != 0 ) {
fprintf ( stderr , "usb-msd: Bad LUN %d \n " , cbw . lun );
goto fail ;
}
s -> tag = le32_to_cpu ( cbw . tag );
s -> data_len = le32_to_cpu ( cbw . data_len );
if ( s -> data_len == 0 ) {
s -> mode = USB_MSDM_CSW ;
} else if ( cbw . flags & 0x80 ) {
s -> mode = USB_MSDM_DATAIN ;
} else {
s -> mode = USB_MSDM_DATAOUT ;
}
DPRINTF ( "Command tag 0x%x flags %08x len %d data %d \n " ,
s -> tag , cbw . flags , cbw . cmd_len , s -> data_len );
392
s -> residue = 0 ;
ths
authored
17 years ago
393
s -> scsi_dev -> send_command ( s -> scsi_dev , s -> tag , cbw . cmd , 0 );
394
395
396
397
/* ??? Should check that USB and SCSI data transfer
directions match . */
if ( s -> residue == 0 ) {
if ( s -> mode == USB_MSDM_DATAIN ) {
ths
authored
17 years ago
398
s -> scsi_dev -> read_data ( s -> scsi_dev , s -> tag );
399
} else if ( s -> mode == USB_MSDM_DATAOUT ) {
ths
authored
17 years ago
400
s -> scsi_dev -> write_data ( s -> scsi_dev , s -> tag );
401
402
}
}
403
404
405
406
407
408
409
410
ret = len ;
break ;
case USB_MSDM_DATAOUT :
DPRINTF ( "Data out %d/%d \n " , len , s -> data_len );
if ( len > s -> data_len )
goto fail ;
411
412
413
414
415
416
417
418
419
420
421
422
s -> usb_buf = data ;
s -> usb_len = len ;
if ( s -> scsi_len ) {
usb_msd_copy_data ( s );
}
if ( s -> residue && s -> usb_len ) {
s -> data_len -= s -> usb_len ;
if ( s -> data_len == 0 )
s -> mode = USB_MSDM_CSW ;
s -> usb_len = 0 ;
}
if ( s -> usb_len ) {
423
424
425
426
DPRINTF ( "Deferring packet %p \n " , p );
usb_defer_packet ( p , usb_msd_cancel_io , s );
s -> packet = p ;
ret = USB_RET_ASYNC ;
427
428
} else {
ret = len ;
429
}
430
431
432
433
434
435
436
437
438
439
440
441
442
break ;
default :
DPRINTF ( "Unexpected write (len %d) \n " , len );
goto fail ;
}
break ;
case USB_TOKEN_IN :
if ( devep != 1 )
goto fail ;
switch ( s -> mode ) {
443
444
445
446
447
448
449
450
451
case USB_MSDM_DATAOUT :
if ( s -> data_len != 0 || len < 13 )
goto fail ;
/* Waiting for SCSI write to complete. */
usb_defer_packet ( p , usb_msd_cancel_io , s );
s -> packet = p ;
ret = USB_RET_ASYNC ;
break ;
452
453
454
455
456
457
case USB_MSDM_CSW :
DPRINTF ( "Command status %d tag 0x%x, len %d \n " ,
s -> result , s -> tag , len );
if ( len < 13 )
goto fail ;
458
459
460
s -> usb_len = len ;
s -> usb_buf = data ;
usb_msd_send_status ( s );
461
s -> mode = USB_MSDM_CBW ;
462
ret = 13 ;
463
464
465
466
467
468
break ;
case USB_MSDM_DATAIN :
DPRINTF ( "Data in %d/%d \n " , len , s -> data_len );
if ( len > s -> data_len )
len = s -> data_len ;
469
470
471
472
473
474
475
476
477
478
479
480
481
s -> usb_buf = data ;
s -> usb_len = len ;
if ( s -> scsi_len ) {
usb_msd_copy_data ( s );
}
if ( s -> residue && s -> usb_len ) {
s -> data_len -= s -> usb_len ;
memset ( s -> usb_buf , 0 , s -> usb_len );
if ( s -> data_len == 0 )
s -> mode = USB_MSDM_CSW ;
s -> usb_len = 0 ;
}
if ( s -> usb_len ) {
482
483
484
485
DPRINTF ( "Deferring packet %p \n " , p );
usb_defer_packet ( p , usb_msd_cancel_io , s );
s -> packet = p ;
ret = USB_RET_ASYNC ;
486
487
} else {
ret = len ;
488
}
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
break ;
default :
DPRINTF ( "Unexpected read (len %d) \n " , len );
goto fail ;
}
break ;
default :
DPRINTF ( "Bad token \n " );
fail :
ret = USB_RET_STALL ;
break ;
}
return ret ;
}
507
508
509
510
static void usb_msd_handle_destroy ( USBDevice * dev )
{
MSDState * s = ( MSDState * ) dev ;
ths
authored
17 years ago
511
s -> scsi_dev -> destroy ( s -> scsi_dev );
512
bdrv_delete ( s -> bs );
513
514
qemu_free ( s );
}
515
516
517
518
519
USBDevice * usb_msd_init ( const char * filename )
{
MSDState * s ;
BlockDriverState * bdrv ;
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
BlockDriver * drv = NULL ;
const char * p1 ;
char fmt [ 32 ];
p1 = strchr ( filename , ':' );
if ( p1 ++ ) {
const char * p2 ;
if ( strstart ( filename , "format=" , & p2 )) {
int len = MIN ( p1 - p2 , sizeof ( fmt ));
pstrcpy ( fmt , len , p2 );
drv = bdrv_find_format ( fmt );
if ( ! drv ) {
printf ( "invalid format %s \n " , fmt );
return NULL ;
}
} else if ( * filename != ':' ) {
printf ( "unrecognized USB mass-storage option %s \n " , filename );
return NULL ;
}
filename = p1 ;
}
if ( !* filename ) {
printf ( "block device specification needed \n " );
return NULL ;
}
549
550
551
552
s = qemu_mallocz ( sizeof ( MSDState ));
bdrv = bdrv_new ( "usb" );
553
if ( bdrv_open2 ( bdrv , filename , 0 , drv ) < 0 )
554
goto fail ;
555
556
if ( qemu_key_check ( bdrv , filename ))
goto fail ;
557
s -> bs = bdrv ;
558
559
560
561
562
563
564
s -> dev . speed = USB_SPEED_FULL ;
s -> dev . handle_packet = usb_generic_handle_packet ;
s -> dev . handle_reset = usb_msd_handle_reset ;
s -> dev . handle_control = usb_msd_handle_control ;
s -> dev . handle_data = usb_msd_handle_data ;
565
s -> dev . handle_destroy = usb_msd_handle_destroy ;
566
567
568
569
snprintf ( s -> dev . devname , sizeof ( s -> dev . devname ), "QEMU USB MSD(%.16s)" ,
filename );
570
s -> scsi_dev = scsi_disk_init ( bdrv , 0 , usb_msd_command_complete , s );
571
usb_msd_handle_reset (( USBDevice * ) s );
572
return ( USBDevice * ) s ;
573
574
575
fail :
qemu_free ( s );
return NULL ;
576
}