2 * Linux host USB redirector
4 * Copyright (c) 2005 Fabrice Bellard
6 * Copyright (c) 2008 Max Krasnyansky
7 * Support for host device auto connect & disconnect
8 * Major rewrite to support fully async operation
10 * Copyright 2008 TJ <linux@tjworld.net>
11 * Added flexible support for /dev/bus/usb /sys/bus/usb/devices in addition
12 * to the legacy /proc/bus/usb USB device discovery and handling
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
33 #include "qemu-common.h"
34 #include "qemu-timer.h"
38 #include <sys/ioctl.h>
41 #include <linux/usbdevice_fs.h>
42 #include <linux/version.h>
45 /* We redefine it to avoid version problems */
46 struct usb_ctrltransfer
{
56 struct usb_ctrlrequest
{
64 typedef int USBScanFunc(void *opaque
, int bus_num
, int addr
, int class_id
,
65 int vendor_id
, int product_id
,
66 const char *product_name
, int speed
);
67 static int usb_host_find_device(int *pbus_num
, int *paddr
,
68 char *product_name
, int product_name_size
,
73 #define dprintf printf
78 #define USBDBG_DEVOPENED "husb: opened %s/devices\n"
80 #define USBPROCBUS_PATH "/proc/bus/usb"
81 #define PRODUCT_NAME_SZ 32
82 #define MAX_ENDPOINTS 16
83 #define USBDEVBUS_PATH "/dev/bus/usb"
84 #define USBSYSBUS_PATH "/sys/bus/usb"
86 static char *usb_host_device_path
;
93 static int usb_fs_type
;
95 /* endpoint association data */
109 * Control transfer state.
110 * Note that 'buffer' _must_ follow 'req' field because
111 * we need contigious buffer when we submit control URB.
117 struct usb_ctrlrequest req
;
118 uint8_t buffer
[2048];
121 typedef struct USBHostDevice
{
131 struct ctrl_struct ctrl
;
132 struct endp_data endp_table
[MAX_ENDPOINTS
];
134 /* Host side address */
138 struct USBHostDevice
*next
;
141 static int is_isoc(USBHostDevice
*s
, int ep
)
143 return s
->endp_table
[ep
- 1].type
== USBDEVFS_URB_TYPE_ISO
;
146 static int is_halted(USBHostDevice
*s
, int ep
)
148 return s
->endp_table
[ep
- 1].halted
;
151 static void clear_halt(USBHostDevice
*s
, int ep
)
153 s
->endp_table
[ep
- 1].halted
= 0;
156 static void set_halt(USBHostDevice
*s
, int ep
)
158 s
->endp_table
[ep
- 1].halted
= 1;
161 static USBHostDevice
*hostdev_list
;
163 static void hostdev_link(USBHostDevice
*dev
)
165 dev
->next
= hostdev_list
;
169 static void hostdev_unlink(USBHostDevice
*dev
)
171 USBHostDevice
*pdev
= hostdev_list
;
172 USBHostDevice
**prev
= &hostdev_list
;
185 static USBHostDevice
*hostdev_find(int bus_num
, int addr
)
187 USBHostDevice
*s
= hostdev_list
;
189 if (s
->bus_num
== bus_num
&& s
->addr
== addr
)
198 * We always allocate one isoc descriptor even for bulk transfers
199 * to simplify allocation and casts.
201 typedef struct AsyncURB
203 struct usbdevfs_urb urb
;
204 struct usbdevfs_iso_packet_desc isocpd
;
210 static AsyncURB
*async_alloc(void)
212 return (AsyncURB
*) qemu_mallocz(sizeof(AsyncURB
));
215 static void async_free(AsyncURB
*aurb
)
220 static void async_complete_ctrl(USBHostDevice
*s
, USBPacket
*p
)
222 switch(s
->ctrl
.state
) {
223 case CTRL_STATE_SETUP
:
224 if (p
->len
< s
->ctrl
.len
)
225 s
->ctrl
.len
= p
->len
;
226 s
->ctrl
.state
= CTRL_STATE_DATA
;
231 s
->ctrl
.state
= CTRL_STATE_IDLE
;
240 static void async_complete(void *opaque
)
242 USBHostDevice
*s
= opaque
;
248 int r
= ioctl(s
->fd
, USBDEVFS_REAPURBNDELAY
, &aurb
);
253 if (errno
== ENODEV
&& !s
->closing
) {
254 printf("husb: device %d.%d disconnected\n", s
->bus_num
, s
->addr
);
255 usb_device_delete_addr(s
->bus_num
, s
->dev
.addr
);
259 dprintf("husb: async. reap urb failed errno %d\n", errno
);
265 dprintf("husb: async completed. aurb %p status %d alen %d\n",
266 aurb
, aurb
->urb
.status
, aurb
->urb
.actual_length
);
269 switch (aurb
->urb
.status
) {
271 p
->len
= aurb
->urb
.actual_length
;
272 if (aurb
->urb
.type
== USBDEVFS_URB_TYPE_CONTROL
)
273 async_complete_ctrl(s
, p
);
277 set_halt(s
, p
->devep
);
280 p
->len
= USB_RET_NAK
;
284 usb_packet_complete(p
);
291 static void async_cancel(USBPacket
*unused
, void *opaque
)
293 AsyncURB
*aurb
= opaque
;
294 USBHostDevice
*s
= aurb
->hdev
;
296 dprintf("husb: async cancel. aurb %p\n", aurb
);
298 /* Mark it as dead (see async_complete above) */
301 int r
= ioctl(s
->fd
, USBDEVFS_DISCARDURB
, aurb
);
303 dprintf("husb: async. discard urb failed errno %d\n", errno
);
307 static int usb_host_claim_interfaces(USBHostDevice
*dev
, int configuration
)
309 int dev_descr_len
, config_descr_len
;
310 int interface
, nb_interfaces
, nb_configurations
;
313 if (configuration
== 0) /* address state - ignore */
316 dprintf("husb: claiming interfaces. config %d\n", configuration
);
319 dev_descr_len
= dev
->descr
[0];
320 if (dev_descr_len
> dev
->descr_len
)
322 nb_configurations
= dev
->descr
[17];
325 while (i
< dev
->descr_len
) {
326 dprintf("husb: i is %d, descr_len is %d, dl %d, dt %d\n", i
, dev
->descr_len
,
327 dev
->descr
[i
], dev
->descr
[i
+1]);
329 if (dev
->descr
[i
+1] != USB_DT_CONFIG
) {
333 config_descr_len
= dev
->descr
[i
];
335 printf("husb: config #%d need %d\n", dev
->descr
[i
+ 5], configuration
);
337 if (configuration
< 0 || configuration
== dev
->descr
[i
+ 5]) {
338 configuration
= dev
->descr
[i
+ 5];
342 i
+= config_descr_len
;
345 if (i
>= dev
->descr_len
) {
346 fprintf(stderr
, "husb: update iface failed. no matching configuration\n");
349 nb_interfaces
= dev
->descr
[i
+ 4];
351 #ifdef USBDEVFS_DISCONNECT
352 /* earlier Linux 2.4 do not support that */
354 struct usbdevfs_ioctl ctrl
;
355 for (interface
= 0; interface
< nb_interfaces
; interface
++) {
356 ctrl
.ioctl_code
= USBDEVFS_DISCONNECT
;
357 ctrl
.ifno
= interface
;
358 ret
= ioctl(dev
->fd
, USBDEVFS_IOCTL
, &ctrl
);
359 if (ret
< 0 && errno
!= ENODATA
) {
360 perror("USBDEVFS_DISCONNECT");
367 /* XXX: only grab if all interfaces are free */
368 for (interface
= 0; interface
< nb_interfaces
; interface
++) {
369 ret
= ioctl(dev
->fd
, USBDEVFS_CLAIMINTERFACE
, &interface
);
371 if (errno
== EBUSY
) {
372 printf("husb: update iface. device already grabbed\n");
374 perror("husb: failed to claim interface");
381 printf("husb: %d interfaces claimed for configuration %d\n",
382 nb_interfaces
, configuration
);
384 dev
->ninterfaces
= nb_interfaces
;
385 dev
->configuration
= configuration
;
389 static int usb_host_release_interfaces(USBHostDevice
*s
)
393 dprintf("husb: releasing interfaces\n");
395 for (i
= 0; i
< s
->ninterfaces
; i
++) {
396 ret
= ioctl(s
->fd
, USBDEVFS_RELEASEINTERFACE
, &i
);
398 perror("husb: failed to release interface");
406 static void usb_host_handle_reset(USBDevice
*dev
)
408 USBHostDevice
*s
= (USBHostDevice
*) dev
;
410 dprintf("husb: reset device %u.%u\n", s
->bus_num
, s
->addr
);
412 ioctl(s
->fd
, USBDEVFS_RESET
);
414 usb_host_claim_interfaces(s
, s
->configuration
);
417 static void usb_host_handle_destroy(USBDevice
*dev
)
419 USBHostDevice
*s
= (USBHostDevice
*)dev
;
423 qemu_set_fd_handler(s
->fd
, NULL
, NULL
, NULL
);
435 static int usb_linux_update_endp_table(USBHostDevice
*s
);
437 static int usb_host_handle_data(USBHostDevice
*s
, USBPacket
*p
)
439 struct usbdevfs_urb
*urb
;
443 aurb
= async_alloc();
449 if (p
->pid
== USB_TOKEN_IN
)
450 urb
->endpoint
= p
->devep
| 0x80;
452 urb
->endpoint
= p
->devep
;
454 if (is_halted(s
, p
->devep
)) {
455 ret
= ioctl(s
->fd
, USBDEVFS_CLEAR_HALT
, &urb
->endpoint
);
457 dprintf("husb: failed to clear halt. ep 0x%x errno %d\n",
458 urb
->endpoint
, errno
);
461 clear_halt(s
, p
->devep
);
464 urb
->buffer
= p
->data
;
465 urb
->buffer_length
= p
->len
;
467 if (is_isoc(s
, p
->devep
)) {
468 /* Setup ISOC transfer */
469 urb
->type
= USBDEVFS_URB_TYPE_ISO
;
470 urb
->flags
= USBDEVFS_URB_ISO_ASAP
;
471 urb
->number_of_packets
= 1;
472 urb
->iso_frame_desc
[0].length
= p
->len
;
474 /* Setup bulk transfer */
475 urb
->type
= USBDEVFS_URB_TYPE_BULK
;
478 urb
->usercontext
= s
;
480 ret
= ioctl(s
->fd
, USBDEVFS_SUBMITURB
, urb
);
482 dprintf("husb: data submit. ep 0x%x len %u aurb %p\n", urb
->endpoint
, p
->len
, aurb
);
485 dprintf("husb: submit failed. errno %d\n", errno
);
493 return USB_RET_STALL
;
497 usb_defer_packet(p
, async_cancel
, aurb
);
498 return USB_RET_ASYNC
;
501 static int ctrl_error(void)
503 if (errno
== ETIMEDOUT
)
506 return USB_RET_STALL
;
509 static int usb_host_set_address(USBHostDevice
*s
, int addr
)
511 dprintf("husb: ctrl set addr %u\n", addr
);
516 static int usb_host_set_config(USBHostDevice
*s
, int config
)
518 usb_host_release_interfaces(s
);
520 int ret
= ioctl(s
->fd
, USBDEVFS_SETCONFIGURATION
, &config
);
522 dprintf("husb: ctrl set config %d ret %d errno %d\n", config
, ret
, errno
);
527 usb_host_claim_interfaces(s
, config
);
531 static int usb_host_set_interface(USBHostDevice
*s
, int iface
, int alt
)
533 struct usbdevfs_setinterface si
;
536 si
.interface
= iface
;
538 ret
= ioctl(s
->fd
, USBDEVFS_SETINTERFACE
, &si
);
540 dprintf("husb: ctrl set iface %d altset %d ret %d errno %d\n",
541 iface
, alt
, ret
, errno
);
546 usb_linux_update_endp_table(s
);
550 static int usb_host_handle_control(USBHostDevice
*s
, USBPacket
*p
)
552 struct usbdevfs_urb
*urb
;
554 int ret
, value
, index
;
558 * Process certain standard device requests.
559 * These are infrequent and are processed synchronously.
561 value
= le16_to_cpu(s
->ctrl
.req
.wValue
);
562 index
= le16_to_cpu(s
->ctrl
.req
.wIndex
);
564 dprintf("husb: ctrl type 0x%x req 0x%x val 0x%x index %u len %u\n",
565 s
->ctrl
.req
.bRequestType
, s
->ctrl
.req
.bRequest
, value
, index
,
568 if (s
->ctrl
.req
.bRequestType
== 0) {
569 switch (s
->ctrl
.req
.bRequest
) {
570 case USB_REQ_SET_ADDRESS
:
571 return usb_host_set_address(s
, value
);
573 case USB_REQ_SET_CONFIGURATION
:
574 return usb_host_set_config(s
, value
& 0xff);
578 if (s
->ctrl
.req
.bRequestType
== 1 &&
579 s
->ctrl
.req
.bRequest
== USB_REQ_SET_INTERFACE
)
580 return usb_host_set_interface(s
, index
, value
);
582 /* The rest are asynchronous */
584 buffer_len
= 8 + s
->ctrl
.len
;
585 if (buffer_len
> sizeof(s
->ctrl
.buffer
)) {
586 fprintf(stderr
, "husb: ctrl buffer too small (%u > %zu)\n",
587 buffer_len
, sizeof(s
->ctrl
.buffer
));
588 return USB_RET_STALL
;
591 aurb
= async_alloc();
596 * Setup ctrl transfer.
598 * s->ctrl is layed out such that data buffer immediately follows
599 * 'req' struct which is exactly what usbdevfs expects.
603 urb
->type
= USBDEVFS_URB_TYPE_CONTROL
;
604 urb
->endpoint
= p
->devep
;
606 urb
->buffer
= &s
->ctrl
.req
;
607 urb
->buffer_length
= buffer_len
;
609 urb
->usercontext
= s
;
611 ret
= ioctl(s
->fd
, USBDEVFS_SUBMITURB
, urb
);
613 dprintf("husb: submit ctrl. len %u aurb %p\n", urb
->buffer_length
, aurb
);
616 dprintf("husb: submit failed. errno %d\n", errno
);
624 return USB_RET_STALL
;
628 usb_defer_packet(p
, async_cancel
, aurb
);
629 return USB_RET_ASYNC
;
632 static int do_token_setup(USBDevice
*dev
, USBPacket
*p
)
634 USBHostDevice
*s
= (USBHostDevice
*) dev
;
638 return USB_RET_STALL
;
640 memcpy(&s
->ctrl
.req
, p
->data
, 8);
641 s
->ctrl
.len
= le16_to_cpu(s
->ctrl
.req
.wLength
);
643 s
->ctrl
.state
= CTRL_STATE_SETUP
;
645 if (s
->ctrl
.req
.bRequestType
& USB_DIR_IN
) {
646 ret
= usb_host_handle_control(s
, p
);
650 if (ret
< s
->ctrl
.len
)
652 s
->ctrl
.state
= CTRL_STATE_DATA
;
654 if (s
->ctrl
.len
== 0)
655 s
->ctrl
.state
= CTRL_STATE_ACK
;
657 s
->ctrl
.state
= CTRL_STATE_DATA
;
663 static int do_token_in(USBDevice
*dev
, USBPacket
*p
)
665 USBHostDevice
*s
= (USBHostDevice
*) dev
;
669 return usb_host_handle_data(s
, p
);
671 switch(s
->ctrl
.state
) {
673 if (!(s
->ctrl
.req
.bRequestType
& USB_DIR_IN
)) {
674 ret
= usb_host_handle_control(s
, p
);
675 if (ret
== USB_RET_ASYNC
)
676 return USB_RET_ASYNC
;
678 s
->ctrl
.state
= CTRL_STATE_IDLE
;
679 return ret
> 0 ? 0 : ret
;
684 case CTRL_STATE_DATA
:
685 if (s
->ctrl
.req
.bRequestType
& USB_DIR_IN
) {
686 int len
= s
->ctrl
.len
- s
->ctrl
.offset
;
689 memcpy(p
->data
, s
->ctrl
.buffer
+ s
->ctrl
.offset
, len
);
690 s
->ctrl
.offset
+= len
;
691 if (s
->ctrl
.offset
>= s
->ctrl
.len
)
692 s
->ctrl
.state
= CTRL_STATE_ACK
;
696 s
->ctrl
.state
= CTRL_STATE_IDLE
;
697 return USB_RET_STALL
;
700 return USB_RET_STALL
;
704 static int do_token_out(USBDevice
*dev
, USBPacket
*p
)
706 USBHostDevice
*s
= (USBHostDevice
*) dev
;
709 return usb_host_handle_data(s
, p
);
711 switch(s
->ctrl
.state
) {
713 if (s
->ctrl
.req
.bRequestType
& USB_DIR_IN
) {
714 s
->ctrl
.state
= CTRL_STATE_IDLE
;
717 /* ignore additional output */
721 case CTRL_STATE_DATA
:
722 if (!(s
->ctrl
.req
.bRequestType
& USB_DIR_IN
)) {
723 int len
= s
->ctrl
.len
- s
->ctrl
.offset
;
726 memcpy(s
->ctrl
.buffer
+ s
->ctrl
.offset
, p
->data
, len
);
727 s
->ctrl
.offset
+= len
;
728 if (s
->ctrl
.offset
>= s
->ctrl
.len
)
729 s
->ctrl
.state
= CTRL_STATE_ACK
;
733 s
->ctrl
.state
= CTRL_STATE_IDLE
;
734 return USB_RET_STALL
;
737 return USB_RET_STALL
;
743 * Called by the HC (host controller).
745 * Returns length of the transaction or one of the USB_RET_XXX codes.
747 static int usb_host_handle_packet(USBDevice
*s
, USBPacket
*p
)
751 s
->state
= USB_STATE_ATTACHED
;
755 s
->state
= USB_STATE_NOTATTACHED
;
759 s
->remote_wakeup
= 0;
761 s
->state
= USB_STATE_DEFAULT
;
762 s
->info
->handle_reset(s
);
766 /* Rest of the PIDs must match our address */
767 if (s
->state
< USB_STATE_DEFAULT
|| p
->devaddr
!= s
->addr
)
768 return USB_RET_NODEV
;
771 case USB_TOKEN_SETUP
:
772 return do_token_setup(s
, p
);
775 return do_token_in(s
, p
);
778 return do_token_out(s
, p
);
781 return USB_RET_STALL
;
785 /* returns 1 on problem encountered or 0 for success */
786 static int usb_linux_update_endp_table(USBHostDevice
*s
)
788 uint8_t *descriptors
;
789 uint8_t devep
, type
, configuration
, alt_interface
;
790 struct usb_ctrltransfer ct
;
791 int interface
, ret
, length
, i
;
793 ct
.bRequestType
= USB_DIR_IN
;
794 ct
.bRequest
= USB_REQ_GET_CONFIGURATION
;
798 ct
.data
= &configuration
;
801 ret
= ioctl(s
->fd
, USBDEVFS_CONTROL
, &ct
);
803 perror("usb_linux_update_endp_table");
807 /* in address state */
808 if (configuration
== 0)
811 /* get the desired configuration, interface, and endpoint descriptors
812 * from device description */
813 descriptors
= &s
->descr
[18];
814 length
= s
->descr_len
- 18;
817 if (descriptors
[i
+ 1] != USB_DT_CONFIG
||
818 descriptors
[i
+ 5] != configuration
) {
819 dprintf("invalid descriptor data - configuration\n");
825 if (descriptors
[i
+ 1] != USB_DT_INTERFACE
||
826 (descriptors
[i
+ 1] == USB_DT_INTERFACE
&&
827 descriptors
[i
+ 4] == 0)) {
832 interface
= descriptors
[i
+ 2];
834 ct
.bRequestType
= USB_DIR_IN
| USB_RECIP_INTERFACE
;
835 ct
.bRequest
= USB_REQ_GET_INTERFACE
;
837 ct
.wIndex
= interface
;
839 ct
.data
= &alt_interface
;
842 ret
= ioctl(s
->fd
, USBDEVFS_CONTROL
, &ct
);
844 alt_interface
= interface
;
847 /* the current interface descriptor is the active interface
848 * and has endpoints */
849 if (descriptors
[i
+ 3] != alt_interface
) {
854 /* advance to the endpoints */
855 while (i
< length
&& descriptors
[i
+1] != USB_DT_ENDPOINT
)
862 if (descriptors
[i
+ 1] != USB_DT_ENDPOINT
)
865 devep
= descriptors
[i
+ 2];
866 switch (descriptors
[i
+ 3] & 0x3) {
868 type
= USBDEVFS_URB_TYPE_CONTROL
;
871 type
= USBDEVFS_URB_TYPE_ISO
;
874 type
= USBDEVFS_URB_TYPE_BULK
;
877 type
= USBDEVFS_URB_TYPE_INTERRUPT
;
880 dprintf("usb_host: malformed endpoint type\n");
881 type
= USBDEVFS_URB_TYPE_BULK
;
883 s
->endp_table
[(devep
& 0xf) - 1].type
= type
;
884 s
->endp_table
[(devep
& 0xf) - 1].halted
= 0;
892 static int usb_host_initfn(USBDevice
*dev
)
897 static USBDevice
*usb_host_device_open_addr(int bus_num
, int addr
, const char *prod_name
)
902 struct usbdevfs_connectinfo ci
;
905 printf("husb: open device %d.%d\n", bus_num
, addr
);
907 if (!usb_host_device_path
) {
908 perror("husb: USB Host Device Path not set");
911 snprintf(buf
, sizeof(buf
), "%s/%03d/%03d", usb_host_device_path
,
913 fd
= open(buf
, O_RDWR
| O_NONBLOCK
);
918 dprintf("husb: opened %s\n", buf
);
920 d
= usb_create(NULL
/* FIXME */, "USB Host Device");
921 dev
= DO_UPCAST(USBHostDevice
, dev
, d
);
923 dev
->bus_num
= bus_num
;
926 /* read the device description */
927 dev
->descr_len
= read(fd
, dev
->descr
, sizeof(dev
->descr
));
928 if (dev
->descr_len
<= 0) {
929 perror("husb: reading device data failed");
936 printf("=== begin dumping device descriptor data ===\n");
937 for (x
= 0; x
< dev
->descr_len
; x
++)
938 printf("%02x ", dev
->descr
[x
]);
939 printf("\n=== end dumping device descriptor data ===\n");
945 * Initial configuration is -1 which makes us claim first
946 * available config. We used to start with 1, which does not
947 * always work. I've seen devices where first config starts
950 if (!usb_host_claim_interfaces(dev
, -1))
953 ret
= ioctl(fd
, USBDEVFS_CONNECTINFO
, &ci
);
955 perror("usb_host_device_open: USBDEVFS_CONNECTINFO");
959 printf("husb: grabbed usb device %d.%d\n", bus_num
, addr
);
961 ret
= usb_linux_update_endp_table(dev
);
966 dev
->dev
.speed
= USB_SPEED_LOW
;
968 dev
->dev
.speed
= USB_SPEED_HIGH
;
970 if (!prod_name
|| prod_name
[0] == '\0')
971 snprintf(dev
->dev
.devname
, sizeof(dev
->dev
.devname
),
972 "host:%d.%d", bus_num
, addr
);
974 pstrcpy(dev
->dev
.devname
, sizeof(dev
->dev
.devname
),
977 /* USB devio uses 'write' flag to check for async completions */
978 qemu_set_fd_handler(dev
->fd
, NULL
, async_complete
, dev
);
982 return (USBDevice
*) dev
;
992 static struct USBDeviceInfo usb_host_dev_info
= {
993 .qdev
.name
= "USB Host Device",
994 .qdev
.size
= sizeof(USBHostDevice
),
995 .init
= usb_host_initfn
,
996 .handle_packet
= usb_host_handle_packet
,
997 .handle_reset
= usb_host_handle_reset
,
999 .handle_control
= usb_host_handle_control
,
1000 .handle_data
= usb_host_handle_data
,
1002 .handle_destroy
= usb_host_handle_destroy
,
1005 static void usb_host_register_devices(void)
1007 usb_qdev_register(&usb_host_dev_info
);
1009 device_init(usb_host_register_devices
)
1011 static int usb_host_auto_add(const char *spec
);
1012 static int usb_host_auto_del(const char *spec
);
1014 USBDevice
*usb_host_device_open(const char *devname
)
1016 Monitor
*mon
= cur_mon
;
1018 char product_name
[PRODUCT_NAME_SZ
];
1020 if (strstr(devname
, "auto:")) {
1021 usb_host_auto_add(devname
);
1025 if (usb_host_find_device(&bus_num
, &addr
, product_name
, sizeof(product_name
),
1029 if (hostdev_find(bus_num
, addr
)) {
1030 monitor_printf(mon
, "husb: host usb device %d.%d is already open\n",
1035 return usb_host_device_open_addr(bus_num
, addr
, product_name
);
1038 int usb_host_device_close(const char *devname
)
1040 char product_name
[PRODUCT_NAME_SZ
];
1044 if (strstr(devname
, "auto:"))
1045 return usb_host_auto_del(devname
);
1047 if (usb_host_find_device(&bus_num
, &addr
, product_name
, sizeof(product_name
),
1051 s
= hostdev_find(bus_num
, addr
);
1053 usb_device_delete_addr(s
->bus_num
, s
->dev
.addr
);
1060 static int get_tag_value(char *buf
, int buf_size
,
1061 const char *str
, const char *tag
,
1062 const char *stopchars
)
1066 p
= strstr(str
, tag
);
1070 while (qemu_isspace(*p
))
1073 while (*p
!= '\0' && !strchr(stopchars
, *p
)) {
1074 if ((q
- buf
) < (buf_size
- 1))
1083 * Use /proc/bus/usb/devices or /dev/bus/usb/devices file to determine
1084 * host's USB devices. This is legacy support since many distributions
1085 * are moving to /sys/bus/usb
1087 static int usb_host_scan_dev(void *opaque
, USBScanFunc
*func
)
1092 int bus_num
, addr
, speed
, device_count
, class_id
, product_id
, vendor_id
;
1093 char product_name
[512];
1096 if (!usb_host_device_path
) {
1097 perror("husb: USB Host Device Path not set");
1100 snprintf(line
, sizeof(line
), "%s/devices", usb_host_device_path
);
1101 f
= fopen(line
, "r");
1103 perror("husb: cannot open devices file");
1108 bus_num
= addr
= speed
= class_id
= product_id
= vendor_id
= 0;
1110 if (fgets(line
, sizeof(line
), f
) == NULL
)
1112 if (strlen(line
) > 0)
1113 line
[strlen(line
) - 1] = '\0';
1114 if (line
[0] == 'T' && line
[1] == ':') {
1115 if (device_count
&& (vendor_id
|| product_id
)) {
1116 /* New device. Add the previously discovered device. */
1117 ret
= func(opaque
, bus_num
, addr
, class_id
, vendor_id
,
1118 product_id
, product_name
, speed
);
1122 if (get_tag_value(buf
, sizeof(buf
), line
, "Bus=", " ") < 0)
1124 bus_num
= atoi(buf
);
1125 if (get_tag_value(buf
, sizeof(buf
), line
, "Dev#=", " ") < 0)
1128 if (get_tag_value(buf
, sizeof(buf
), line
, "Spd=", " ") < 0)
1130 if (!strcmp(buf
, "480"))
1131 speed
= USB_SPEED_HIGH
;
1132 else if (!strcmp(buf
, "1.5"))
1133 speed
= USB_SPEED_LOW
;
1135 speed
= USB_SPEED_FULL
;
1136 product_name
[0] = '\0';
1141 } else if (line
[0] == 'P' && line
[1] == ':') {
1142 if (get_tag_value(buf
, sizeof(buf
), line
, "Vendor=", " ") < 0)
1144 vendor_id
= strtoul(buf
, NULL
, 16);
1145 if (get_tag_value(buf
, sizeof(buf
), line
, "ProdID=", " ") < 0)
1147 product_id
= strtoul(buf
, NULL
, 16);
1148 } else if (line
[0] == 'S' && line
[1] == ':') {
1149 if (get_tag_value(buf
, sizeof(buf
), line
, "Product=", "") < 0)
1151 pstrcpy(product_name
, sizeof(product_name
), buf
);
1152 } else if (line
[0] == 'D' && line
[1] == ':') {
1153 if (get_tag_value(buf
, sizeof(buf
), line
, "Cls=", " (") < 0)
1155 class_id
= strtoul(buf
, NULL
, 16);
1159 if (device_count
&& (vendor_id
|| product_id
)) {
1160 /* Add the last device. */
1161 ret
= func(opaque
, bus_num
, addr
, class_id
, vendor_id
,
1162 product_id
, product_name
, speed
);
1171 * Read sys file-system device file
1173 * @line address of buffer to put file contents in
1174 * @line_size size of line
1175 * @device_file path to device file (printf format string)
1176 * @device_name device being opened (inserted into device_file)
1178 * @return 0 failed, 1 succeeded ('line' contains data)
1180 static int usb_host_read_file(char *line
, size_t line_size
, const char *device_file
, const char *device_name
)
1182 Monitor
*mon
= cur_mon
;
1185 char filename
[PATH_MAX
];
1187 snprintf(filename
, PATH_MAX
, USBSYSBUS_PATH
"/devices/%s/%s", device_name
,
1189 f
= fopen(filename
, "r");
1191 fgets(line
, line_size
, f
);
1195 monitor_printf(mon
, "husb: could not open %s\n", filename
);
1202 * Use /sys/bus/usb/devices/ directory to determine host's USB
1205 * This code is based on Robert Schiele's original patches posted to
1206 * the Novell bug-tracker https://bugzilla.novell.com/show_bug.cgi?id=241950
1208 static int usb_host_scan_sys(void *opaque
, USBScanFunc
*func
)
1212 int bus_num
, addr
, speed
, class_id
, product_id
, vendor_id
;
1214 char product_name
[512];
1217 dir
= opendir(USBSYSBUS_PATH
"/devices");
1219 perror("husb: cannot open devices directory");
1223 while ((de
= readdir(dir
))) {
1224 if (de
->d_name
[0] != '.' && !strchr(de
->d_name
, ':')) {
1225 char *tmpstr
= de
->d_name
;
1226 if (!strncmp(de
->d_name
, "usb", 3))
1228 bus_num
= atoi(tmpstr
);
1230 if (!usb_host_read_file(line
, sizeof(line
), "devnum", de
->d_name
))
1232 if (sscanf(line
, "%d", &addr
) != 1)
1235 if (!usb_host_read_file(line
, sizeof(line
), "bDeviceClass",
1238 if (sscanf(line
, "%x", &class_id
) != 1)
1241 if (!usb_host_read_file(line
, sizeof(line
), "idVendor", de
->d_name
))
1243 if (sscanf(line
, "%x", &vendor_id
) != 1)
1246 if (!usb_host_read_file(line
, sizeof(line
), "idProduct",
1249 if (sscanf(line
, "%x", &product_id
) != 1)
1252 if (!usb_host_read_file(line
, sizeof(line
), "product",
1256 if (strlen(line
) > 0)
1257 line
[strlen(line
) - 1] = '\0';
1258 pstrcpy(product_name
, sizeof(product_name
), line
);
1261 if (!usb_host_read_file(line
, sizeof(line
), "speed", de
->d_name
))
1263 if (!strcmp(line
, "480\n"))
1264 speed
= USB_SPEED_HIGH
;
1265 else if (!strcmp(line
, "1.5\n"))
1266 speed
= USB_SPEED_LOW
;
1268 speed
= USB_SPEED_FULL
;
1270 ret
= func(opaque
, bus_num
, addr
, class_id
, vendor_id
,
1271 product_id
, product_name
, speed
);
1283 * Determine how to access the host's USB devices and call the
1284 * specific support function.
1286 static int usb_host_scan(void *opaque
, USBScanFunc
*func
)
1288 Monitor
*mon
= cur_mon
;
1292 const char *fs_type
[] = {"unknown", "proc", "dev", "sys"};
1293 char devpath
[PATH_MAX
];
1295 /* only check the host once */
1297 dir
= opendir(USBSYSBUS_PATH
"/devices");
1299 /* devices found in /dev/bus/usb/ (yes - not a mistake!) */
1300 strcpy(devpath
, USBDEVBUS_PATH
);
1301 usb_fs_type
= USB_FS_SYS
;
1303 dprintf(USBDBG_DEVOPENED
, USBSYSBUS_PATH
);
1306 f
= fopen(USBPROCBUS_PATH
"/devices", "r");
1308 /* devices found in /proc/bus/usb/ */
1309 strcpy(devpath
, USBPROCBUS_PATH
);
1310 usb_fs_type
= USB_FS_PROC
;
1312 dprintf(USBDBG_DEVOPENED
, USBPROCBUS_PATH
);
1315 /* try additional methods if an access method hasn't been found yet */
1316 f
= fopen(USBDEVBUS_PATH
"/devices", "r");
1318 /* devices found in /dev/bus/usb/ */
1319 strcpy(devpath
, USBDEVBUS_PATH
);
1320 usb_fs_type
= USB_FS_DEV
;
1322 dprintf(USBDBG_DEVOPENED
, USBDEVBUS_PATH
);
1327 monitor_printf(mon
, "husb: unable to access USB devices\n");
1331 /* the module setting (used later for opening devices) */
1332 usb_host_device_path
= qemu_mallocz(strlen(devpath
)+1);
1333 strcpy(usb_host_device_path
, devpath
);
1334 monitor_printf(mon
, "husb: using %s file-system with %s\n",
1335 fs_type
[usb_fs_type
], usb_host_device_path
);
1338 switch (usb_fs_type
) {
1341 ret
= usb_host_scan_dev(opaque
, func
);
1344 ret
= usb_host_scan_sys(opaque
, func
);
1353 struct USBAutoFilter
{
1354 struct USBAutoFilter
*next
;
1361 static QEMUTimer
*usb_auto_timer
;
1362 static struct USBAutoFilter
*usb_auto_filter
;
1364 static int usb_host_auto_scan(void *opaque
, int bus_num
, int addr
,
1365 int class_id
, int vendor_id
, int product_id
,
1366 const char *product_name
, int speed
)
1368 struct USBAutoFilter
*f
;
1369 struct USBDevice
*dev
;
1375 for (f
= usb_auto_filter
; f
; f
= f
->next
) {
1376 if (f
->bus_num
>= 0 && f
->bus_num
!= bus_num
)
1379 if (f
->addr
>= 0 && f
->addr
!= addr
)
1382 if (f
->vendor_id
>= 0 && f
->vendor_id
!= vendor_id
)
1385 if (f
->product_id
>= 0 && f
->product_id
!= product_id
)
1388 /* We got a match */
1390 /* Allredy attached ? */
1391 if (hostdev_find(bus_num
, addr
))
1394 dprintf("husb: auto open: bus_num %d addr %d\n", bus_num
, addr
);
1396 dev
= usb_host_device_open_addr(bus_num
, addr
, product_name
);
1398 qdev_init(&dev
->qdev
);
1404 static void usb_host_auto_timer(void *unused
)
1406 usb_host_scan(NULL
, usb_host_auto_scan
);
1407 qemu_mod_timer(usb_auto_timer
, qemu_get_clock(rt_clock
) + 2000);
1411 * Autoconnect filter
1413 * auto:bus:dev[:vid:pid]
1414 * auto:bus.dev[:vid:pid]
1416 * bus - bus number (dec, * means any)
1417 * dev - device number (dec, * means any)
1418 * vid - vendor id (hex, * means any)
1419 * pid - product id (hex, * means any)
1421 * See 'lsusb' output.
1423 static int parse_filter(const char *spec
, struct USBAutoFilter
*f
)
1425 enum { BUS
, DEV
, VID
, PID
, DONE
};
1426 const char *p
= spec
;
1434 for (i
= BUS
; i
< DONE
; i
++) {
1435 p
= strpbrk(p
, ":.");
1443 case BUS
: f
->bus_num
= strtol(p
, NULL
, 10); break;
1444 case DEV
: f
->addr
= strtol(p
, NULL
, 10); break;
1445 case VID
: f
->vendor_id
= strtol(p
, NULL
, 16); break;
1446 case PID
: f
->product_id
= strtol(p
, NULL
, 16); break;
1451 fprintf(stderr
, "husb: invalid auto filter spec %s\n", spec
);
1458 static int match_filter(const struct USBAutoFilter
*f1
,
1459 const struct USBAutoFilter
*f2
)
1461 return f1
->bus_num
== f2
->bus_num
&&
1462 f1
->addr
== f2
->addr
&&
1463 f1
->vendor_id
== f2
->vendor_id
&&
1464 f1
->product_id
== f2
->product_id
;
1467 static int usb_host_auto_add(const char *spec
)
1469 struct USBAutoFilter filter
, *f
;
1471 if (parse_filter(spec
, &filter
) < 0)
1474 f
= qemu_mallocz(sizeof(*f
));
1478 if (!usb_auto_filter
) {
1480 * First entry. Init and start the monitor.
1481 * Right now we're using timer to check for new devices.
1482 * If this turns out to be too expensive we can move that into a
1485 usb_auto_timer
= qemu_new_timer(rt_clock
, usb_host_auto_timer
, NULL
);
1486 if (!usb_auto_timer
) {
1487 fprintf(stderr
, "husb: failed to allocate auto scan timer\n");
1492 /* Check for new devices every two seconds */
1493 qemu_mod_timer(usb_auto_timer
, qemu_get_clock(rt_clock
) + 2000);
1496 dprintf("husb: added auto filter: bus_num %d addr %d vid %d pid %d\n",
1497 f
->bus_num
, f
->addr
, f
->vendor_id
, f
->product_id
);
1499 f
->next
= usb_auto_filter
;
1500 usb_auto_filter
= f
;
1505 static int usb_host_auto_del(const char *spec
)
1507 struct USBAutoFilter
*pf
= usb_auto_filter
;
1508 struct USBAutoFilter
**prev
= &usb_auto_filter
;
1509 struct USBAutoFilter filter
;
1511 if (parse_filter(spec
, &filter
) < 0)
1515 if (match_filter(pf
, &filter
)) {
1516 dprintf("husb: removed auto filter: bus_num %d addr %d vid %d pid %d\n",
1517 pf
->bus_num
, pf
->addr
, pf
->vendor_id
, pf
->product_id
);
1521 if (!usb_auto_filter
) {
1522 /* No more filters. Stop scanning. */
1523 qemu_del_timer(usb_auto_timer
);
1524 qemu_free_timer(usb_auto_timer
);
1537 typedef struct FindDeviceState
{
1542 char product_name
[PRODUCT_NAME_SZ
];
1545 static int usb_host_find_device_scan(void *opaque
, int bus_num
, int addr
,
1547 int vendor_id
, int product_id
,
1548 const char *product_name
, int speed
)
1550 FindDeviceState
*s
= opaque
;
1551 if ((vendor_id
== s
->vendor_id
&&
1552 product_id
== s
->product_id
) ||
1553 (bus_num
== s
->bus_num
&&
1555 pstrcpy(s
->product_name
, PRODUCT_NAME_SZ
, product_name
);
1556 s
->bus_num
= bus_num
;
1565 'bus.addr' (decimal numbers) or
1566 'vendor_id:product_id' (hexa numbers) */
1567 static int usb_host_find_device(int *pbus_num
, int *paddr
,
1568 char *product_name
, int product_name_size
,
1569 const char *devname
)
1575 p
= strchr(devname
, '.');
1577 *pbus_num
= strtoul(devname
, NULL
, 0);
1578 *paddr
= strtoul(p
+ 1, NULL
, 0);
1579 fs
.bus_num
= *pbus_num
;
1581 ret
= usb_host_scan(&fs
, usb_host_find_device_scan
);
1583 pstrcpy(product_name
, product_name_size
, fs
.product_name
);
1587 p
= strchr(devname
, ':');
1589 fs
.vendor_id
= strtoul(devname
, NULL
, 16);
1590 fs
.product_id
= strtoul(p
+ 1, NULL
, 16);
1591 ret
= usb_host_scan(&fs
, usb_host_find_device_scan
);
1593 *pbus_num
= fs
.bus_num
;
1595 pstrcpy(product_name
, product_name_size
, fs
.product_name
);
1602 /**********************/
1603 /* USB host device info */
1605 struct usb_class_info
{
1607 const char *class_name
;
1610 static const struct usb_class_info usb_class_info
[] = {
1611 { USB_CLASS_AUDIO
, "Audio"},
1612 { USB_CLASS_COMM
, "Communication"},
1613 { USB_CLASS_HID
, "HID"},
1614 { USB_CLASS_HUB
, "Hub" },
1615 { USB_CLASS_PHYSICAL
, "Physical" },
1616 { USB_CLASS_PRINTER
, "Printer" },
1617 { USB_CLASS_MASS_STORAGE
, "Storage" },
1618 { USB_CLASS_CDC_DATA
, "Data" },
1619 { USB_CLASS_APP_SPEC
, "Application Specific" },
1620 { USB_CLASS_VENDOR_SPEC
, "Vendor Specific" },
1621 { USB_CLASS_STILL_IMAGE
, "Still Image" },
1622 { USB_CLASS_CSCID
, "Smart Card" },
1623 { USB_CLASS_CONTENT_SEC
, "Content Security" },
1627 static const char *usb_class_str(uint8_t class)
1629 const struct usb_class_info
*p
;
1630 for(p
= usb_class_info
; p
->class != -1; p
++) {
1631 if (p
->class == class)
1634 return p
->class_name
;
1637 static void usb_info_device(Monitor
*mon
, int bus_num
, int addr
, int class_id
,
1638 int vendor_id
, int product_id
,
1639 const char *product_name
,
1642 const char *class_str
, *speed_str
;
1648 case USB_SPEED_FULL
:
1651 case USB_SPEED_HIGH
:
1659 monitor_printf(mon
, " Device %d.%d, speed %s Mb/s\n",
1660 bus_num
, addr
, speed_str
);
1661 class_str
= usb_class_str(class_id
);
1663 monitor_printf(mon
, " %s:", class_str
);
1665 monitor_printf(mon
, " Class %02x:", class_id
);
1666 monitor_printf(mon
, " USB device %04x:%04x", vendor_id
, product_id
);
1667 if (product_name
[0] != '\0')
1668 monitor_printf(mon
, ", %s", product_name
);
1669 monitor_printf(mon
, "\n");
1672 static int usb_host_info_device(void *opaque
, int bus_num
, int addr
,
1674 int vendor_id
, int product_id
,
1675 const char *product_name
,
1678 Monitor
*mon
= opaque
;
1680 usb_info_device(mon
, bus_num
, addr
, class_id
, vendor_id
, product_id
,
1681 product_name
, speed
);
1685 static void dec2str(int val
, char *str
, size_t size
)
1688 snprintf(str
, size
, "*");
1690 snprintf(str
, size
, "%d", val
);
1693 static void hex2str(int val
, char *str
, size_t size
)
1696 snprintf(str
, size
, "*");
1698 snprintf(str
, size
, "%x", val
);
1701 void usb_host_info(Monitor
*mon
)
1703 struct USBAutoFilter
*f
;
1705 usb_host_scan(mon
, usb_host_info_device
);
1707 if (usb_auto_filter
)
1708 monitor_printf(mon
, " Auto filters:\n");
1709 for (f
= usb_auto_filter
; f
; f
= f
->next
) {
1710 char bus
[10], addr
[10], vid
[10], pid
[10];
1711 dec2str(f
->bus_num
, bus
, sizeof(bus
));
1712 dec2str(f
->addr
, addr
, sizeof(addr
));
1713 hex2str(f
->vendor_id
, vid
, sizeof(vid
));
1714 hex2str(f
->product_id
, pid
, sizeof(pid
));
1715 monitor_printf(mon
, " Device %s.%s ID %s:%s\n",
1716 bus
, addr
, vid
, pid
);