2 * Linux host USB redirector
4 * Copyright (c) 2005 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
26 #if defined(__linux__)
28 #include <sys/ioctl.h>
29 #include <linux/usbdevice_fs.h>
30 #include <linux/version.h>
33 /* We redefine it to avoid version problems */
34 struct usb_ctrltransfer
{
44 typedef int USBScanFunc(void *opaque
, int bus_num
, int addr
, int class_id
,
45 int vendor_id
, int product_id
,
46 const char *product_name
, int speed
);
47 static int usb_host_find_device(int *pbus_num
, int *paddr
,
48 char *product_name
, int product_name_size
,
55 #define USBDEVFS_PATH "/proc/bus/usb"
56 #define PRODUCT_NAME_SZ 32
57 #define SIG_ISOCOMPLETE (SIGRTMIN+7)
58 #define MAX_ENDPOINTS 16
60 struct sigaction sigact
;
62 /* endpoint association data */
67 /* FIXME: move USBPacket to PendingURB */
68 typedef struct USBHostDevice
{
72 struct endp_data endp_table
[MAX_ENDPOINTS
];
79 typedef struct PendingURB
{
80 struct usbdevfs_urb
*urb
;
84 struct PendingURB
*next
;
87 static PendingURB
*pending_urbs
= NULL
;
89 static int add_pending_urb(struct usbdevfs_urb
*urb
)
91 PendingURB
*purb
= qemu_mallocz(sizeof(PendingURB
));
97 purb
->next
= pending_urbs
;
104 static int del_pending_urb(struct usbdevfs_urb
*urb
)
106 PendingURB
*purb
= pending_urbs
;
107 PendingURB
*prev
= NULL
;
109 while (purb
&& purb
->urb
!= urb
) {
114 if (purb
&& purb
->urb
== urb
) {
116 prev
->next
= purb
->next
;
118 pending_urbs
= purb
->next
;
127 static PendingURB
*get_pending_urb(struct usbdevfs_urb
*urb
)
129 PendingURB
*purb
= pending_urbs
;
131 while (purb
&& purb
->urb
!= urb
) {
135 if (purb
&& purb
->urb
== urb
) {
142 static int usb_host_update_interfaces(USBHostDevice
*dev
, int configuration
)
144 int dev_descr_len
, config_descr_len
;
145 int interface
, nb_interfaces
, nb_configurations
;
148 if (configuration
== 0) /* address state - ignore */
152 dev_descr_len
= dev
->descr
[0];
153 if (dev_descr_len
> dev
->descr_len
)
155 nb_configurations
= dev
->descr
[17];
158 while (i
< dev
->descr_len
) {
160 printf("i is %d, descr_len is %d, dl %d, dt %d\n", i
, dev
->descr_len
,
161 dev
->descr
[i
], dev
->descr
[i
+1]);
163 if (dev
->descr
[i
+1] != USB_DT_CONFIG
) {
167 config_descr_len
= dev
->descr
[i
];
169 if (configuration
== dev
->descr
[i
+ 5])
172 i
+= config_descr_len
;
175 if (i
>= dev
->descr_len
) {
176 printf("usb_host: error - device has no matching configuration\n");
179 nb_interfaces
= dev
->descr
[i
+ 4];
181 #ifdef USBDEVFS_DISCONNECT
182 /* earlier Linux 2.4 do not support that */
184 struct usbdevfs_ioctl ctrl
;
185 for (interface
= 0; interface
< nb_interfaces
; interface
++) {
186 ctrl
.ioctl_code
= USBDEVFS_DISCONNECT
;
187 ctrl
.ifno
= interface
;
188 ret
= ioctl(dev
->fd
, USBDEVFS_IOCTL
, &ctrl
);
189 if (ret
< 0 && errno
!= ENODATA
) {
190 perror("USBDEVFS_DISCONNECT");
197 /* XXX: only grab if all interfaces are free */
198 for (interface
= 0; interface
< nb_interfaces
; interface
++) {
199 ret
= ioctl(dev
->fd
, USBDEVFS_CLAIMINTERFACE
, &interface
);
201 if (errno
== EBUSY
) {
203 "usb_host: warning - device already grabbed\n");
205 perror("USBDEVFS_CLAIMINTERFACE");
213 printf("usb_host: %d interfaces claimed for configuration %d\n",
214 nb_interfaces
, configuration
);
220 static void usb_host_handle_reset(USBDevice
*dev
)
223 USBHostDevice
*s
= (USBHostDevice
*)dev
;
224 /* USBDEVFS_RESET, but not the first time as it has already be
225 done by the host OS */
226 ioctl(s
->fd
, USBDEVFS_RESET
);
230 static void usb_host_handle_destroy(USBDevice
*dev
)
232 USBHostDevice
*s
= (USBHostDevice
*)dev
;
239 static int usb_linux_update_endp_table(USBHostDevice
*s
);
241 static int usb_host_handle_control(USBDevice
*dev
,
248 USBHostDevice
*s
= (USBHostDevice
*)dev
;
249 struct usb_ctrltransfer ct
;
250 struct usbdevfs_setinterface si
;
251 int intf_update_required
= 0;
254 if (request
== (DeviceOutRequest
| USB_REQ_SET_ADDRESS
)) {
255 /* specific SET_ADDRESS support */
258 } else if (request
== ((USB_RECIP_INTERFACE
<< 8) |
259 USB_REQ_SET_INTERFACE
)) {
260 /* set alternate setting for the interface */
261 si
.interface
= index
;
262 si
.altsetting
= value
;
263 ret
= ioctl(s
->fd
, USBDEVFS_SETINTERFACE
, &si
);
264 usb_linux_update_endp_table(s
);
265 } else if (request
== (DeviceOutRequest
| USB_REQ_SET_CONFIGURATION
)) {
267 printf("usb_host_handle_control: SET_CONFIGURATION request - "
268 "config %d\n", value
& 0xff);
270 if (s
->configuration
!= (value
& 0xff)) {
271 s
->configuration
= (value
& 0xff);
272 intf_update_required
= 1;
277 ct
.bRequestType
= request
>> 8;
278 ct
.bRequest
= request
;
284 ret
= ioctl(s
->fd
, USBDEVFS_CONTROL
, &ct
);
292 return USB_RET_STALL
;
295 if (intf_update_required
) {
297 printf("usb_host_handle_control: updating interfaces\n");
299 usb_host_update_interfaces(s
, value
& 0xff);
305 static int usb_host_handle_isoch(USBDevice
*dev
, USBPacket
*p
);
307 static int usb_host_handle_data(USBDevice
*dev
, USBPacket
*p
)
309 USBHostDevice
*s
= (USBHostDevice
*)dev
;
310 struct usbdevfs_bulktransfer bt
;
312 uint8_t devep
= p
->devep
;
314 if (s
->endp_table
[p
->devep
- 1].type
== USBDEVFS_URB_TYPE_ISO
) {
315 return usb_host_handle_isoch(dev
, p
);
318 /* XXX: optimize and handle all data types by looking at the
320 if (p
->pid
== USB_TOKEN_IN
)
326 ret
= ioctl(s
->fd
, USBDEVFS_BULK
, &bt
);
334 printf("handle_data: errno=%d\n", errno
);
336 return USB_RET_STALL
;
344 static void usb_linux_bh_cb(void *opaque
)
346 PendingURB
*pending_urb
= (PendingURB
*)opaque
;
347 USBHostDevice
*s
= pending_urb
->dev
;
348 struct usbdevfs_urb
*purb
= NULL
;
349 USBPacket
*p
= s
->packet
;
352 /* FIXME: handle purb->status */
353 qemu_free(pending_urb
->bh
);
354 del_pending_urb(pending_urb
->urb
);
361 ret
= ioctl(s
->fd
, USBDEVFS_REAPURBNDELAY
, &purb
);
363 printf("usb_linux_bh_cb: REAPURBNDELAY ioctl=%d errno=%d\n",
369 if (purb
== pending_urb
->urb
) {
370 printf("usb_linux_bh_cb: urb mismatch reaped=%p pending=%p\n",
375 p
->len
= purb
->actual_length
;
376 usb_packet_complete(p
);
381 static void isoch_done(int signum
, siginfo_t
*info
, void *context
)
383 struct usbdevfs_urb
*urb
= (struct usbdevfs_urb
*)info
->si_addr
;
384 USBHostDevice
*s
= (USBHostDevice
*)urb
->usercontext
;
387 if (info
->si_code
!= SI_ASYNCIO
||
388 info
->si_signo
!= SIG_ISOCOMPLETE
) {
392 purb
= get_pending_urb(urb
);
394 purb
->bh
= qemu_bh_new(usb_linux_bh_cb
, purb
);
397 purb
->status
= info
->si_errno
;
398 qemu_bh_schedule(purb
->bh
);
404 static int usb_host_handle_isoch(USBDevice
*dev
, USBPacket
*p
)
406 USBHostDevice
*s
= (USBHostDevice
*)dev
;
407 struct usbdevfs_urb
*urb
, *purb
= NULL
;
409 uint8_t devep
= p
->devep
;
411 if (p
->pid
== USB_TOKEN_IN
)
414 urb
= qemu_mallocz(sizeof(struct usbdevfs_urb
) +
415 sizeof(struct usbdevfs_iso_packet_desc
));
417 printf("usb_host_handle_isoch: malloc failed\n");
421 urb
->type
= USBDEVFS_URB_TYPE_ISO
;
422 urb
->endpoint
= devep
;
424 urb
->flags
= USBDEVFS_URB_ISO_ASAP
;
425 urb
->buffer
= p
->data
;
426 urb
->buffer_length
= p
->len
;
427 urb
->actual_length
= 0;
428 urb
->start_frame
= 0;
429 urb
->error_count
= 0;
431 urb
->signr
= SIG_ISOCOMPLETE
;
435 urb
->usercontext
= s
;
436 urb
->number_of_packets
= 1;
437 urb
->iso_frame_desc
[0].length
= p
->len
;
438 urb
->iso_frame_desc
[0].actual_length
= 0;
439 urb
->iso_frame_desc
[0].status
= 0;
440 ret
= ioctl(s
->fd
, USBDEVFS_SUBMITURB
, urb
);
442 if (!add_pending_urb(urb
)) {
443 printf("usb_host_handle_isoch: add_pending_urb failed %p\n", urb
);
446 printf("usb_host_handle_isoch: SUBMITURB ioctl=%d errno=%d\n",
454 return USB_RET_STALL
;
458 /* FIXME: handle urbs_ready together with sync io
459 * workaround for injecting the signaled urbs into current frame */
460 if (s
->urbs_ready
> 0) {
461 ret
= ioctl(s
->fd
, USBDEVFS_REAPURBNDELAY
, &purb
);
463 ret
= purb
->actual_length
;
470 return USB_RET_ASYNC
;
472 ret
= ioctl(s
->fd
, USBDEVFS_REAPURBNDELAY
, &purb
);
474 if (del_pending_urb(purb
)) {
475 ret
= purb
->actual_length
;
478 printf("usb_host_handle_isoch: del_pending_urb failed %p\n", purb
);
482 printf("usb_host_handle_isoch: REAPURBNDELAY ioctl=%d errno=%d\n",
490 /* returns 1 on problem encountered or 0 for success */
491 static int usb_linux_update_endp_table(USBHostDevice
*s
)
493 uint8_t *descriptors
;
494 uint8_t devep
, type
, configuration
, alt_interface
;
495 struct usb_ctrltransfer ct
;
496 int interface
, ret
, length
, i
;
498 ct
.bRequestType
= USB_DIR_IN
;
499 ct
.bRequest
= USB_REQ_GET_CONFIGURATION
;
503 ct
.data
= &configuration
;
506 ret
= ioctl(s
->fd
, USBDEVFS_CONTROL
, &ct
);
508 perror("usb_linux_update_endp_table");
512 /* in address state */
513 if (configuration
== 0)
516 /* get the desired configuration, interface, and endpoint descriptors
517 * from device description */
518 descriptors
= &s
->descr
[18];
519 length
= s
->descr_len
- 18;
522 if (descriptors
[i
+ 1] != USB_DT_CONFIG
||
523 descriptors
[i
+ 5] != configuration
) {
524 printf("invalid descriptor data - configuration\n");
530 if (descriptors
[i
+ 1] != USB_DT_INTERFACE
||
531 (descriptors
[i
+ 1] == USB_DT_INTERFACE
&&
532 descriptors
[i
+ 4] == 0)) {
537 interface
= descriptors
[i
+ 2];
539 ct
.bRequestType
= USB_DIR_IN
| USB_RECIP_INTERFACE
;
540 ct
.bRequest
= USB_REQ_GET_INTERFACE
;
542 ct
.wIndex
= interface
;
544 ct
.data
= &alt_interface
;
547 ret
= ioctl(s
->fd
, USBDEVFS_CONTROL
, &ct
);
549 perror("usb_linux_update_endp_table");
553 /* the current interface descriptor is the active interface
554 * and has endpoints */
555 if (descriptors
[i
+ 3] != alt_interface
) {
560 /* advance to the endpoints */
561 while (i
< length
&& descriptors
[i
+1] != USB_DT_ENDPOINT
)
568 if (descriptors
[i
+ 1] != USB_DT_ENDPOINT
)
571 devep
= descriptors
[i
+ 2];
572 switch (descriptors
[i
+ 3] & 0x3) {
574 type
= USBDEVFS_URB_TYPE_CONTROL
;
577 type
= USBDEVFS_URB_TYPE_ISO
;
580 type
= USBDEVFS_URB_TYPE_BULK
;
583 type
= USBDEVFS_URB_TYPE_INTERRUPT
;
586 printf("usb_host: malformed endpoint type\n");
587 type
= USBDEVFS_URB_TYPE_BULK
;
589 s
->endp_table
[(devep
& 0xf) - 1].type
= type
;
597 /* XXX: exclude high speed devices or implement EHCI */
598 USBDevice
*usb_host_device_open(const char *devname
)
601 USBHostDevice
*dev
= NULL
;
602 struct usbdevfs_connectinfo ci
;
605 char product_name
[PRODUCT_NAME_SZ
];
607 dev
= qemu_mallocz(sizeof(USBHostDevice
));
612 printf("usb_host_device_open %s\n", devname
);
614 if (usb_host_find_device(&bus_num
, &addr
,
615 product_name
, sizeof(product_name
),
619 snprintf(buf
, sizeof(buf
), USBDEVFS_PATH
"/%03d/%03d",
621 fd
= open(buf
, O_RDWR
| O_NONBLOCK
);
627 /* read the device description */
628 dev
->descr_len
= read(fd
, dev
->descr
, sizeof(dev
->descr
));
629 if (dev
->descr_len
<= 0) {
630 perror("usb_host_update_interfaces: reading device data failed");
637 printf("=== begin dumping device descriptor data ===\n");
638 for (x
= 0; x
< dev
->descr_len
; x
++)
639 printf("%02x ", dev
->descr
[x
]);
640 printf("\n=== end dumping device descriptor data ===\n");
645 dev
->configuration
= 1;
647 /* XXX - do something about initial configuration */
648 if (!usb_host_update_interfaces(dev
, 1))
651 ret
= ioctl(fd
, USBDEVFS_CONNECTINFO
, &ci
);
653 perror("USBDEVFS_CONNECTINFO");
658 printf("host USB device %d.%d grabbed\n", bus_num
, addr
);
661 ret
= usb_linux_update_endp_table(dev
);
666 dev
->dev
.speed
= USB_SPEED_LOW
;
668 dev
->dev
.speed
= USB_SPEED_HIGH
;
669 dev
->dev
.handle_packet
= usb_generic_handle_packet
;
671 dev
->dev
.handle_reset
= usb_host_handle_reset
;
672 dev
->dev
.handle_control
= usb_host_handle_control
;
673 dev
->dev
.handle_data
= usb_host_handle_data
;
674 dev
->dev
.handle_destroy
= usb_host_handle_destroy
;
676 if (product_name
[0] == '\0')
677 snprintf(dev
->dev
.devname
, sizeof(dev
->dev
.devname
),
680 pstrcpy(dev
->dev
.devname
, sizeof(dev
->dev
.devname
),
684 /* set up the signal handlers */
685 sigemptyset(&sigact
.sa_mask
);
686 sigact
.sa_sigaction
= isoch_done
;
687 sigact
.sa_flags
= SA_SIGINFO
;
688 sigact
.sa_restorer
= 0;
689 ret
= sigaction(SIG_ISOCOMPLETE
, &sigact
, NULL
);
691 printf("sigaction SIG_ISOCOMPLETE=%d errno=%d\n", ret
, errno
);
695 return (USBDevice
*)dev
;
703 static int get_tag_value(char *buf
, int buf_size
,
704 const char *str
, const char *tag
,
705 const char *stopchars
)
709 p
= strstr(str
, tag
);
716 while (*p
!= '\0' && !strchr(stopchars
, *p
)) {
717 if ((q
- buf
) < (buf_size
- 1))
725 static int usb_host_scan(void *opaque
, USBScanFunc
*func
)
730 int bus_num
, addr
, speed
, device_count
, class_id
, product_id
, vendor_id
;
732 char product_name
[512];
734 f
= fopen(USBDEVFS_PATH
"/devices", "r");
736 term_printf("Could not open %s\n", USBDEVFS_PATH
"/devices");
740 bus_num
= addr
= speed
= class_id
= product_id
= vendor_id
= 0;
743 if (fgets(line
, sizeof(line
), f
) == NULL
)
745 if (strlen(line
) > 0)
746 line
[strlen(line
) - 1] = '\0';
747 if (line
[0] == 'T' && line
[1] == ':') {
748 if (device_count
&& (vendor_id
|| product_id
)) {
749 /* New device. Add the previously discovered device. */
750 ret
= func(opaque
, bus_num
, addr
, class_id
, vendor_id
,
751 product_id
, product_name
, speed
);
755 if (get_tag_value(buf
, sizeof(buf
), line
, "Bus=", " ") < 0)
758 if (get_tag_value(buf
, sizeof(buf
), line
, "Dev#=", " ") < 0)
761 if (get_tag_value(buf
, sizeof(buf
), line
, "Spd=", " ") < 0)
763 if (!strcmp(buf
, "480"))
764 speed
= USB_SPEED_HIGH
;
765 else if (!strcmp(buf
, "1.5"))
766 speed
= USB_SPEED_LOW
;
768 speed
= USB_SPEED_FULL
;
769 product_name
[0] = '\0';
774 } else if (line
[0] == 'P' && line
[1] == ':') {
775 if (get_tag_value(buf
, sizeof(buf
), line
, "Vendor=", " ") < 0)
777 vendor_id
= strtoul(buf
, NULL
, 16);
778 if (get_tag_value(buf
, sizeof(buf
), line
, "ProdID=", " ") < 0)
780 product_id
= strtoul(buf
, NULL
, 16);
781 } else if (line
[0] == 'S' && line
[1] == ':') {
782 if (get_tag_value(buf
, sizeof(buf
), line
, "Product=", "") < 0)
784 pstrcpy(product_name
, sizeof(product_name
), buf
);
785 } else if (line
[0] == 'D' && line
[1] == ':') {
786 if (get_tag_value(buf
, sizeof(buf
), line
, "Cls=", " (") < 0)
788 class_id
= strtoul(buf
, NULL
, 16);
792 if (device_count
&& (vendor_id
|| product_id
)) {
793 /* Add the last device. */
794 ret
= func(opaque
, bus_num
, addr
, class_id
, vendor_id
,
795 product_id
, product_name
, speed
);
802 typedef struct FindDeviceState
{
807 char product_name
[PRODUCT_NAME_SZ
];
810 static int usb_host_find_device_scan(void *opaque
, int bus_num
, int addr
,
812 int vendor_id
, int product_id
,
813 const char *product_name
, int speed
)
815 FindDeviceState
*s
= opaque
;
816 if ((vendor_id
== s
->vendor_id
&&
817 product_id
== s
->product_id
) ||
818 (bus_num
== s
->bus_num
&&
820 pstrcpy(s
->product_name
, PRODUCT_NAME_SZ
, product_name
);
821 s
->bus_num
= bus_num
;
830 'bus.addr' (decimal numbers) or
831 'vendor_id:product_id' (hexa numbers) */
832 static int usb_host_find_device(int *pbus_num
, int *paddr
,
833 char *product_name
, int product_name_size
,
840 p
= strchr(devname
, '.');
842 *pbus_num
= strtoul(devname
, NULL
, 0);
843 *paddr
= strtoul(p
+ 1, NULL
, 0);
844 fs
.bus_num
= *pbus_num
;
846 ret
= usb_host_scan(&fs
, usb_host_find_device_scan
);
848 pstrcpy(product_name
, product_name_size
, fs
.product_name
);
851 p
= strchr(devname
, ':');
853 fs
.vendor_id
= strtoul(devname
, NULL
, 16);
854 fs
.product_id
= strtoul(p
+ 1, NULL
, 16);
855 ret
= usb_host_scan(&fs
, usb_host_find_device_scan
);
857 *pbus_num
= fs
.bus_num
;
859 pstrcpy(product_name
, product_name_size
, fs
.product_name
);
866 /**********************/
867 /* USB host device info */
869 struct usb_class_info
{
871 const char *class_name
;
874 static const struct usb_class_info usb_class_info
[] = {
875 { USB_CLASS_AUDIO
, "Audio"},
876 { USB_CLASS_COMM
, "Communication"},
877 { USB_CLASS_HID
, "HID"},
878 { USB_CLASS_HUB
, "Hub" },
879 { USB_CLASS_PHYSICAL
, "Physical" },
880 { USB_CLASS_PRINTER
, "Printer" },
881 { USB_CLASS_MASS_STORAGE
, "Storage" },
882 { USB_CLASS_CDC_DATA
, "Data" },
883 { USB_CLASS_APP_SPEC
, "Application Specific" },
884 { USB_CLASS_VENDOR_SPEC
, "Vendor Specific" },
885 { USB_CLASS_STILL_IMAGE
, "Still Image" },
886 { USB_CLASS_CSCID
, "Smart Card" },
887 { USB_CLASS_CONTENT_SEC
, "Content Security" },
891 static const char *usb_class_str(uint8_t class)
893 const struct usb_class_info
*p
;
894 for(p
= usb_class_info
; p
->class != -1; p
++) {
895 if (p
->class == class)
898 return p
->class_name
;
901 void usb_info_device(int bus_num
, int addr
, int class_id
,
902 int vendor_id
, int product_id
,
903 const char *product_name
,
906 const char *class_str
, *speed_str
;
923 term_printf(" Device %d.%d, speed %s Mb/s\n",
924 bus_num
, addr
, speed_str
);
925 class_str
= usb_class_str(class_id
);
927 term_printf(" %s:", class_str
);
929 term_printf(" Class %02x:", class_id
);
930 term_printf(" USB device %04x:%04x", vendor_id
, product_id
);
931 if (product_name
[0] != '\0')
932 term_printf(", %s", product_name
);
936 static int usb_host_info_device(void *opaque
, int bus_num
, int addr
,
938 int vendor_id
, int product_id
,
939 const char *product_name
,
942 usb_info_device(bus_num
, addr
, class_id
, vendor_id
, product_id
,
943 product_name
, speed
);
947 void usb_host_info(void)
949 usb_host_scan(NULL
, usb_host_info_device
);
954 void usb_host_info(void)
956 term_printf("USB host devices not supported\n");
959 /* XXX: modify configure to compile the right host driver */
960 USBDevice
*usb_host_device_open(const char *devname
)