[qemu.git] / hw / usb.h

/*
 * QEMU USB API
 *
 * Copyright (c) 2005 Fabrice Bellard
 *
 * 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.
 */

#include "block.h"
#include "qdev.h"
#include "qemu-queue.h"

/* Constants related to the USB / PCI interaction */
#define USB_SBRN    0x60 /* Serial Bus Release Number Register */
#define USB_RELEASE_1  0x10 /* USB 1.0 */
#define USB_RELEASE_2  0x20 /* USB 2.0 */
#define USB_RELEASE_3  0x30 /* USB 3.0 */

#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

#define USB_RET_NODEV  (-1)
#define USB_RET_NAK    (-2)
#define USB_RET_STALL  (-3)
#define USB_RET_BABBLE (-4)
#define USB_RET_ASYNC  (-5)

#define USB_SPEED_LOW   0
#define USB_SPEED_FULL  1
#define USB_SPEED_HIGH  2
#define USB_SPEED_SUPER 3

#define USB_SPEED_MASK_LOW   (1 << USB_SPEED_LOW)
#define USB_SPEED_MASK_FULL  (1 << USB_SPEED_FULL)
#define USB_SPEED_MASK_HIGH  (1 << USB_SPEED_HIGH)
#define USB_SPEED_MASK_SUPER (1 << USB_SPEED_SUPER)

#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

#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

#define USB_SUBCLASS_UNDEFINED          0
#define USB_SUBCLASS_AUDIO_CONTROL      1
#define USB_SUBCLASS_AUDIO_STREAMING    2
#define USB_SUBCLASS_AUDIO_MIDISTREAMING 3

#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)
#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)
#define ClassInterfaceRequest \
        ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
#define ClassInterfaceOutRequest \
        ((USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)

#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
#define USB_DT_DEVICE_QUALIFIER         0x06
#define USB_DT_OTHER_SPEED_CONFIG       0x07
#define USB_DT_DEBUG                    0x0A
#define USB_DT_INTERFACE_ASSOC          0x0B
#define USB_DT_CS_INTERFACE             0x24
#define USB_DT_CS_ENDPOINT              0x25

#define USB_ENDPOINT_XFER_CONTROL	0
#define USB_ENDPOINT_XFER_ISOC		1
#define USB_ENDPOINT_XFER_BULK		2
#define USB_ENDPOINT_XFER_INT		3
#define USB_ENDPOINT_XFER_INVALID     255

typedef struct USBBus USBBus;
typedef struct USBBusOps USBBusOps;
typedef struct USBPort USBPort;
typedef struct USBDevice USBDevice;
typedef struct USBDeviceInfo USBDeviceInfo;
typedef struct USBPacket USBPacket;
typedef struct USBEndpoint USBEndpoint;

typedef struct USBDesc USBDesc;
typedef struct USBDescID USBDescID;
typedef struct USBDescDevice USBDescDevice;
typedef struct USBDescConfig USBDescConfig;
typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
typedef struct USBDescIface USBDescIface;
typedef struct USBDescEndpoint USBDescEndpoint;
typedef struct USBDescOther USBDescOther;
typedef struct USBDescString USBDescString;

struct USBDescString {
    uint8_t index;
    char *str;
    QLIST_ENTRY(USBDescString) next;
};

#define USB_MAX_ENDPOINTS  15
#define USB_MAX_INTERFACES 16

struct USBEndpoint {
    uint8_t type;
    uint8_t ifnum;
};

/* definition of a USB device */
struct USBDevice {
    DeviceState qdev;
    USBDeviceInfo *info;
    USBPort *port;
    char *port_path;
    void *opaque;

    /* Actual connected speed */
    int speed;
    /* Supported speeds, not in info because it may be variable (hostdevs) */
    int speedmask;
    uint8_t addr;
    char product_desc[32];
    int auto_attach;
    int attached;

    int32_t state;
    uint8_t setup_buf[8];
    uint8_t data_buf[4096];
    int32_t remote_wakeup;
    int32_t setup_state;
    int32_t setup_len;
    int32_t setup_index;

    USBEndpoint ep_in[USB_MAX_ENDPOINTS];
    USBEndpoint ep_out[USB_MAX_ENDPOINTS];

    QLIST_HEAD(, USBDescString) strings;
    const USBDescDevice *device;

    int configuration;
    int ninterfaces;
    int altsetting[USB_MAX_INTERFACES];
    const USBDescConfig *config;
    const USBDescIface  *ifaces[USB_MAX_INTERFACES];
};

struct USBDeviceInfo {
    DeviceInfo qdev;
    int (*init)(USBDevice *dev);

    /*
     * Process USB packet.
     * Called by the HC (Host Controller).
     *
     * Returns length of the transaction
     * or one of the USB_RET_XXX codes.
     */
    int (*handle_packet)(USBDevice *dev, USBPacket *p);

    /*
     * Called when a packet is canceled.
     */
    void (*cancel_packet)(USBDevice *dev, USBPacket *p);

    /*
     * Called when device is destroyed.
     */
    void (*handle_destroy)(USBDevice *dev);

    /*
     * Attach the device
     */
    void (*handle_attach)(USBDevice *dev);

    /*
     * Reset the device
     */
    void (*handle_reset)(USBDevice *dev);

    /*
     * Process control request.
     * Called from handle_packet().
     *
     * Returns length or one of the USB_RET_ codes.
     */
    int (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value,
                          int index, int length, uint8_t *data);

    /*
     * Process data transfers (both BULK and ISOC).
     * Called from handle_packet().
     *
     * Returns length or one of the USB_RET_ codes.
     */
    int (*handle_data)(USBDevice *dev, USBPacket *p);

    void (*set_interface)(USBDevice *dev, int interface,
                          int alt_old, int alt_new);

    const char *product_desc;
    const USBDesc *usb_desc;

    /* handle legacy -usbdevice command line options */
    const char *usbdevice_name;
    USBDevice *(*usbdevice_init)(const char *params);
};

typedef struct USBPortOps {
    void (*attach)(USBPort *port);
    void (*detach)(USBPort *port);
    /*
     * This gets called when a device downstream from the device attached to
     * the port (iow attached through a hub) gets detached.
     */
    void (*child_detach)(USBPort *port, USBDevice *child);
    void (*wakeup)(USBPort *port);
    /*
     * Note that port->dev will be different then the device from which
     * the packet originated when a hub is involved, if you want the orginating
     * device use p->owner
     */
    void (*complete)(USBPort *port, USBPacket *p);
} USBPortOps;

/* USB port on which a device can be connected */
struct USBPort {
    USBDevice *dev;
    int speedmask;
    char path[16];
    USBPortOps *ops;
    void *opaque;
    int index; /* internal port index, may be used with the opaque */
    QTAILQ_ENTRY(USBPort) next;
};

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;
    QEMUIOVector iov;
    int result; /* transfer length or USB_RET_* status code */
    /* Internal use by the USB layer.  */
    USBDevice *owner;
};

void usb_packet_init(USBPacket *p);
void usb_packet_setup(USBPacket *p, int pid, uint8_t addr, uint8_t ep);
void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len);
int usb_packet_map(USBPacket *p, QEMUSGList *sgl);
void usb_packet_unmap(USBPacket *p);
void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes);
void usb_packet_skip(USBPacket *p, size_t bytes);
void usb_packet_cleanup(USBPacket *p);

int usb_handle_packet(USBDevice *dev, USBPacket *p);
void usb_packet_complete(USBDevice *dev, USBPacket *p);
void usb_cancel_packet(USBPacket * p);

void usb_ep_init(USBDevice *dev);
struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep);
uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
uint8_t usb_ep_get_ifnum(USBDevice *dev, int pid, int ep);
void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);

void usb_attach(USBPort *port);
void usb_detach(USBPort *port);
void usb_reset(USBPort *port);
void usb_wakeup(USBDevice *dev);
int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
int set_usb_string(uint8_t *buf, const char *str);
void usb_send_msg(USBDevice *dev, int msg);

/* usb-linux.c */
USBDevice *usb_host_device_open(const char *devname);
int usb_host_device_close(const char *devname);
void usb_host_info(Monitor *mon);

/* usb-bt.c */
USBDevice *usb_bt_init(HCIInfo *hci);

/* usb ports of the VM */

#define VM_USB_HUB_SIZE 8

/* 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,
    /* Add new interrupts here */
    musb_irq_max, /* total number of interrupts defined */
};

typedef struct MUSBState MUSBState;
MUSBState *musb_init(DeviceState *parent_device, int gpio_base);
void musb_reset(MUSBState *s);
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);

/* usb-bus.c */

struct USBBus {
    BusState qbus;
    USBBusOps *ops;
    int busnr;
    int nfree;
    int nused;
    QTAILQ_HEAD(, USBPort) free;
    QTAILQ_HEAD(, USBPort) used;
    QTAILQ_ENTRY(USBBus) next;
};

struct USBBusOps {
    int (*register_companion)(USBBus *bus, USBPort *ports[],
                              uint32_t portcount, uint32_t firstport);
};

void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host);
USBBus *usb_bus_find(int busnr);
void usb_qdev_register(USBDeviceInfo *info);
void usb_qdev_register_many(USBDeviceInfo *info);
USBDevice *usb_create(USBBus *bus, const char *name);
USBDevice *usb_create_simple(USBBus *bus, const char *name);
USBDevice *usbdevice_create(const char *cmdline);
void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
                       USBPortOps *ops, int speedmask);
int usb_register_companion(const char *masterbus, USBPort *ports[],
                           uint32_t portcount, uint32_t firstport,
                           void *opaque, USBPortOps *ops, int speedmask);
void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr);
void usb_unregister_port(USBBus *bus, USBPort *port);
int usb_claim_port(USBDevice *dev);
void usb_release_port(USBDevice *dev);
int usb_device_attach(USBDevice *dev);
int usb_device_detach(USBDevice *dev);
int usb_device_delete_addr(int busnr, int addr);

static inline USBBus *usb_bus_from_device(USBDevice *d)
{
    return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
}
Commit	Line	Data
bb36d470 FB	1	/*
bb36d470 FB	2	* QEMU USB API
5fafdf24	3	*
bb36d470	4	* Copyright (c) 2005 Fabrice Bellard
5fafdf24	5	*
bb36d470 FB	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	*/
c0f4ce77 AL	24
c0f4ce77 AL	25	#include "block.h"
806b6024	26	#include "qdev.h"
72cf2d4f	27	#include "qemu-queue.h"
c0f4ce77	28
8e257816 BH	29	/* Constants related to the USB / PCI interaction */
	30	#define USB_SBRN 0x60 /* Serial Bus Release Number Register */
	31	#define USB_RELEASE_1 0x10 /* USB 1.0 */
	32	#define USB_RELEASE_2 0x20 /* USB 2.0 */
	33	#define USB_RELEASE_3 0x30 /* USB 3.0 */
	34
bb36d470 FB	35	#define USB_TOKEN_SETUP 0x2d
	36	#define USB_TOKEN_IN 0x69 /* device -> host */
	37	#define USB_TOKEN_OUT 0xe1 /* host -> device */
	38
	39	/* specific usb messages, also sent in the 'pid' parameter */
	40	#define USB_MSG_ATTACH 0x100
	41	#define USB_MSG_DETACH 0x101
	42	#define USB_MSG_RESET 0x102
	43
5fafdf24	44	#define USB_RET_NODEV (-1)
bb36d470 FB	45	#define USB_RET_NAK (-2)
	46	#define USB_RET_STALL (-3)
	47	#define USB_RET_BABBLE (-4)
4d611c9a	48	#define USB_RET_ASYNC (-5)
bb36d470 FB	49
	50	#define USB_SPEED_LOW 0
	51	#define USB_SPEED_FULL 1
	52	#define USB_SPEED_HIGH 2
843d4e0c GH	53	#define USB_SPEED_SUPER 3
	54
	55	#define USB_SPEED_MASK_LOW (1 << USB_SPEED_LOW)
	56	#define USB_SPEED_MASK_FULL (1 << USB_SPEED_FULL)
	57	#define USB_SPEED_MASK_HIGH (1 << USB_SPEED_HIGH)
	58	#define USB_SPEED_MASK_SUPER (1 << USB_SPEED_SUPER)
bb36d470 FB	59
	60	#define USB_STATE_NOTATTACHED 0
	61	#define USB_STATE_ATTACHED 1
	62	//#define USB_STATE_POWERED 2
	63	#define USB_STATE_DEFAULT 3
	64	//#define USB_STATE_ADDRESS 4
	65	//#define USB_STATE_CONFIGURED 5
	66	#define USB_STATE_SUSPENDED 6
	67
a594cfbf FB	68	#define USB_CLASS_AUDIO 1
	69	#define USB_CLASS_COMM 2
	70	#define USB_CLASS_HID 3
	71	#define USB_CLASS_PHYSICAL 5
	72	#define USB_CLASS_STILL_IMAGE 6
	73	#define USB_CLASS_PRINTER 7
	74	#define USB_CLASS_MASS_STORAGE 8
	75	#define USB_CLASS_HUB 9
	76	#define USB_CLASS_CDC_DATA 0x0a
	77	#define USB_CLASS_CSCID 0x0b
	78	#define USB_CLASS_CONTENT_SEC 0x0d
	79	#define USB_CLASS_APP_SPEC 0xfe
	80	#define USB_CLASS_VENDOR_SPEC 0xff
	81
b870472d PA	82	#define USB_SUBCLASS_UNDEFINED 0
	83	#define USB_SUBCLASS_AUDIO_CONTROL 1
	84	#define USB_SUBCLASS_AUDIO_STREAMING 2
	85	#define USB_SUBCLASS_AUDIO_MIDISTREAMING 3
	86
bb36d470 FB	87	#define USB_DIR_OUT 0
	88	#define USB_DIR_IN 0x80
	89
	90	#define USB_TYPE_MASK (0x03 << 5)
	91	#define USB_TYPE_STANDARD (0x00 << 5)
	92	#define USB_TYPE_CLASS (0x01 << 5)
	93	#define USB_TYPE_VENDOR (0x02 << 5)
	94	#define USB_TYPE_RESERVED (0x03 << 5)
	95
	96	#define USB_RECIP_MASK 0x1f
	97	#define USB_RECIP_DEVICE 0x00
	98	#define USB_RECIP_INTERFACE 0x01
	99	#define USB_RECIP_ENDPOINT 0x02
	100	#define USB_RECIP_OTHER 0x03
	101
	102	#define DeviceRequest ((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE)<<8)
	103	#define DeviceOutRequest ((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE)<<8)
59ae540c FB	104	#define InterfaceRequest \
	105	((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_INTERFACE)<<8)
	106	#define InterfaceOutRequest \
	107	((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_INTERFACE)<<8)
	108	#define EndpointRequest ((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_ENDPOINT)<<8)
	109	#define EndpointOutRequest \
	110	((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_ENDPOINT)<<8)
f3571b1a MR	111	#define ClassInterfaceRequest \
	112	((USB_DIR_IN\|USB_TYPE_CLASS\|USB_RECIP_INTERFACE)<<8)
	113	#define ClassInterfaceOutRequest \
	114	((USB_DIR_OUT\|USB_TYPE_CLASS\|USB_RECIP_INTERFACE)<<8)
bb36d470 FB	115
	116	#define USB_REQ_GET_STATUS 0x00
	117	#define USB_REQ_CLEAR_FEATURE 0x01
	118	#define USB_REQ_SET_FEATURE 0x03
	119	#define USB_REQ_SET_ADDRESS 0x05
	120	#define USB_REQ_GET_DESCRIPTOR 0x06
	121	#define USB_REQ_SET_DESCRIPTOR 0x07
	122	#define USB_REQ_GET_CONFIGURATION 0x08
	123	#define USB_REQ_SET_CONFIGURATION 0x09
	124	#define USB_REQ_GET_INTERFACE 0x0A
	125	#define USB_REQ_SET_INTERFACE 0x0B
	126	#define USB_REQ_SYNCH_FRAME 0x0C
	127
	128	#define USB_DEVICE_SELF_POWERED 0
	129	#define USB_DEVICE_REMOTE_WAKEUP 1
	130
	131	#define USB_DT_DEVICE 0x01
	132	#define USB_DT_CONFIG 0x02
	133	#define USB_DT_STRING 0x03
	134	#define USB_DT_INTERFACE 0x04
	135	#define USB_DT_ENDPOINT 0x05
25620cba GH	136	#define USB_DT_DEVICE_QUALIFIER 0x06
25620cba GH	137	#define USB_DT_OTHER_SPEED_CONFIG 0x07
a7fb71d1	138	#define USB_DT_DEBUG 0x0A
c6d3ad0f	139	#define USB_DT_INTERFACE_ASSOC 0x0B
b870472d PA	140	#define USB_DT_CS_INTERFACE 0x24
b870472d PA	141	#define USB_DT_CS_ENDPOINT 0x25
bb36d470	142
942ac052 AZ	143	#define USB_ENDPOINT_XFER_CONTROL 0
	144	#define USB_ENDPOINT_XFER_ISOC 1
	145	#define USB_ENDPOINT_XFER_BULK 2
	146	#define USB_ENDPOINT_XFER_INT 3
d8e17efd	147	#define USB_ENDPOINT_XFER_INVALID 255
942ac052	148
806b6024	149	typedef struct USBBus USBBus;
07771f6f	150	typedef struct USBBusOps USBBusOps;
bb36d470 FB	151	typedef struct USBPort USBPort;
bb36d470 FB	152	typedef struct USBDevice USBDevice;
806b6024	153	typedef struct USBDeviceInfo USBDeviceInfo;
4d611c9a	154	typedef struct USBPacket USBPacket;
d8e17efd	155	typedef struct USBEndpoint USBEndpoint;
bb36d470	156
37fb59d3 GH	157	typedef struct USBDesc USBDesc;
	158	typedef struct USBDescID USBDescID;
	159	typedef struct USBDescDevice USBDescDevice;
	160	typedef struct USBDescConfig USBDescConfig;
6e625fc7	161	typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
37fb59d3 GH	162	typedef struct USBDescIface USBDescIface;
	163	typedef struct USBDescEndpoint USBDescEndpoint;
	164	typedef struct USBDescOther USBDescOther;
132a3f55 GH	165	typedef struct USBDescString USBDescString;
	166
	167	struct USBDescString {
	168	uint8_t index;
	169	char *str;
	170	QLIST_ENTRY(USBDescString) next;
	171	};
37fb59d3	172
1de14d43 GH	173	#define USB_MAX_ENDPOINTS 15
	174	#define USB_MAX_INTERFACES 16
	175
d8e17efd GH	176	struct USBEndpoint {
d8e17efd GH	177	uint8_t type;
82f02fe9	178	uint8_t ifnum;
d8e17efd GH	179	};
d8e17efd GH	180
bb36d470 FB	181	/* definition of a USB device */
bb36d470 FB	182	struct USBDevice {
806b6024 GH	183	DeviceState qdev;
806b6024 GH	184	USBDeviceInfo *info;
618c169b	185	USBPort *port;
5f69076b	186	char *port_path;
bb36d470	187	void *opaque;
89b9b79f	188
ba3f9bfb	189	/* Actual connected speed */
806b6024	190	int speed;
ba3f9bfb HG	191	/* Supported speeds, not in info because it may be variable (hostdevs) */
ba3f9bfb HG	192	int speedmask;
806b6024	193	uint8_t addr;
0fe6d12e	194	char product_desc[32];
61e094c0	195	int auto_attach;
a5d2f727	196	int attached;
806b6024	197
c1ecb40a	198	int32_t state;
806b6024	199	uint8_t setup_buf[8];
19f33223	200	uint8_t data_buf[4096];
c1ecb40a GH	201	int32_t remote_wakeup;
	202	int32_t setup_state;
	203	int32_t setup_len;
	204	int32_t setup_index;
132a3f55	205
d8e17efd GH	206	USBEndpoint ep_in[USB_MAX_ENDPOINTS];
	207	USBEndpoint ep_out[USB_MAX_ENDPOINTS];
	208
132a3f55	209	QLIST_HEAD(, USBDescString) strings;
a980a065	210	const USBDescDevice *device;
65360511 GH	211
	212	int configuration;
	213	int ninterfaces;
1de14d43	214	int altsetting[USB_MAX_INTERFACES];
a980a065	215	const USBDescConfig *config;
1de14d43	216	const USBDescIface *ifaces[USB_MAX_INTERFACES];
806b6024 GH	217	};
	218
	219	struct USBDeviceInfo {
	220	DeviceInfo qdev;
	221	int (init)(USBDevice dev);
	222
	223	/*
	224	* Process USB packet.
89b9b79f AL	225	* Called by the HC (Host Controller).
89b9b79f AL	226	*
806b6024	227	* Returns length of the transaction
89b9b79f	228	* or one of the USB_RET_XXX codes.
806b6024	229	*/
4d611c9a	230	int (handle_packet)(USBDevice dev, USBPacket *p);
89b9b79f	231
eb5e680a GH	232	/*
	233	* Called when a packet is canceled.
	234	*/
	235	void (cancel_packet)(USBDevice dev, USBPacket *p);
	236
806b6024	237	/*
89b9b79f AL	238	* Called when device is destroyed.
89b9b79f AL	239	*/
059809e4 FB	240	void (handle_destroy)(USBDevice dev);
059809e4 FB	241
b6f77fbe GH	242	/*
	243	* Attach the device
	244	*/
	245	void (handle_attach)(USBDevice dev);
	246
89b9b79f AL	247	/*
89b9b79f AL	248	* Reset the device
806b6024	249	*/
059809e4	250	void (handle_reset)(USBDevice dev);
89b9b79f AL	251
	252	/*
	253	* Process control request.
	254	* Called from handle_packet().
	255	*
	256	* Returns length or one of the USB_RET_ codes.
	257	*/
007fd62f	258	int (handle_control)(USBDevice dev, USBPacket *p, int request, int value,
bb36d470	259	int index, int length, uint8_t *data);
89b9b79f AL	260
	261	/*
	262	* Process data transfers (both BULK and ISOC).
	263	* Called from handle_packet().
	264	*
	265	* Returns length or one of the USB_RET_ codes.
	266	*/
4d611c9a	267	int (handle_data)(USBDevice dev, USBPacket *p);
0958b4cc	268
1de14d43 GH	269	void (set_interface)(USBDevice dev, int interface,
	270	int alt_old, int alt_new);
	271
06384698	272	const char *product_desc;
37fb59d3	273	const USBDesc *usb_desc;
06384698	274
0958b4cc GH	275	/* handle legacy -usbdevice command line options */
	276	const char *usbdevice_name;
	277	USBDevice (usbdevice_init)(const char *params);
bb36d470 FB	278	};
bb36d470 FB	279
0d86d2be	280	typedef struct USBPortOps {
618c169b GH	281	void (attach)(USBPort port);
618c169b GH	282	void (detach)(USBPort port);
4706ab6c HG	283	/*
	284	* This gets called when a device downstream from the device attached to
	285	* the port (iow attached through a hub) gets detached.
	286	*/
	287	void (child_detach)(USBPort port, USBDevice *child);
d47e59b8 HG	288	void (wakeup)(USBPort port);
	289	/*
	290	* Note that port->dev will be different then the device from which
	291	* the packet originated when a hub is involved, if you want the orginating
	292	* device use p->owner
	293	*/
	294	void (complete)(USBPort port, USBPacket *p);
0d86d2be	295	} USBPortOps;
0d92ed30	296
bb36d470 FB	297	/* USB port on which a device can be connected */
bb36d470 FB	298	struct USBPort {
a594cfbf	299	USBDevice *dev;
843d4e0c	300	int speedmask;
c7a2196a	301	char path[16];
0d86d2be	302	USBPortOps *ops;
bb36d470 FB	303	void *opaque;
bb36d470 FB	304	int index; /* internal port index, may be used with the opaque */
72cf2d4f	305	QTAILQ_ENTRY(USBPort) next;
bb36d470 FB	306	};
bb36d470 FB	307
4d611c9a PB	308	typedef void USBCallback(USBPacket * packet, void *opaque);
	309
	310	/* Structure used to hold information about an active USB packet. */
	311	struct USBPacket {
	312	/* Data fields for use by the driver. */
	313	int pid;
	314	uint8_t devaddr;
	315	uint8_t devep;
4f4321c1 GH	316	QEMUIOVector iov;
4f4321c1 GH	317	int result; /* transfer length or USB_RET_* status code */
4d611c9a	318	/* Internal use by the USB layer. */
4ff658fb	319	USBDevice *owner;
4d611c9a PB	320	};
4d611c9a PB	321
4f4321c1 GH	322	void usb_packet_init(USBPacket *p);
	323	void usb_packet_setup(USBPacket *p, int pid, uint8_t addr, uint8_t ep);
	324	void usb_packet_addbuf(USBPacket p, void ptr, size_t len);
	325	int usb_packet_map(USBPacket p, QEMUSGList sgl);
	326	void usb_packet_unmap(USBPacket *p);
	327	void usb_packet_copy(USBPacket p, void ptr, size_t bytes);
	328	void usb_packet_skip(USBPacket *p, size_t bytes);
	329	void usb_packet_cleanup(USBPacket *p);
	330
53aa8c0e	331	int usb_handle_packet(USBDevice dev, USBPacket p);
4ff658fb GH	332	void usb_packet_complete(USBDevice dev, USBPacket p);
4ff658fb GH	333	void usb_cancel_packet(USBPacket * p);
53aa8c0e	334
d8e17efd GH	335	void usb_ep_init(USBDevice *dev);
	336	struct USBEndpoint usb_ep_get(USBDevice dev, int pid, int ep);
	337	uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
82f02fe9	338	uint8_t usb_ep_get_ifnum(USBDevice *dev, int pid, int ep);
d8e17efd	339	void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
82f02fe9	340	void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);
d8e17efd	341
891fb2cd GH	342	void usb_attach(USBPort *port);
891fb2cd GH	343	void usb_detach(USBPort *port);
e0b8e72d	344	void usb_reset(USBPort *port);
01eacab6	345	void usb_wakeup(USBDevice *dev);
4d611c9a	346	int usb_generic_handle_packet(USBDevice s, USBPacket p);
50b7963e	347	void usb_generic_async_ctrl_complete(USBDevice s, USBPacket p);
bb36d470	348	int set_usb_string(uint8_t buf, const char str);
4d611c9a PB	349	void usb_send_msg(USBDevice *dev, int msg);
4d611c9a PB	350
bb36d470	351	/* usb-linux.c */
a594cfbf	352	USBDevice usb_host_device_open(const char devname);
5d0c5750	353	int usb_host_device_close(const char *devname);
376253ec	354	void usb_host_info(Monitor *mon);
59ae540c	355
e6a6d5ab AZ	356	/* usb-bt.c */
	357	USBDevice usb_bt_init(HCIInfo hci);
	358
87ecb68b PB	359	/* usb ports of the VM */
87ecb68b PB	360
87ecb68b PB	361	#define VM_USB_HUB_SIZE 8
87ecb68b PB	362
942ac052 AZ	363	/* usb-musb.c */
	364	enum musb_irq_source_e {
	365	musb_irq_suspend = 0,
	366	musb_irq_resume,
	367	musb_irq_rst_babble,
	368	musb_irq_sof,
	369	musb_irq_connect,
	370	musb_irq_disconnect,
	371	musb_irq_vbus_request,
	372	musb_irq_vbus_error,
	373	musb_irq_rx,
	374	musb_irq_tx,
	375	musb_set_vbus,
	376	musb_set_session,
9147b752 PM	377	/* Add new interrupts here */
9147b752 PM	378	musb_irq_max, /* total number of interrupts defined */
942ac052 AZ	379	};
942ac052 AZ	380
bc24a225	381	typedef struct MUSBState MUSBState;
406c2075	382	MUSBState musb_init(DeviceState parent_device, int gpio_base);
5b1cdb4e	383	void musb_reset(MUSBState *s);
bc24a225 PB	384	uint32_t musb_core_intr_get(MUSBState *s);
	385	void musb_core_intr_clear(MUSBState *s, uint32_t mask);
	386	void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
806b6024 GH	387
	388	/* usb-bus.c */
	389
	390	struct USBBus {
	391	BusState qbus;
07771f6f	392	USBBusOps *ops;
806b6024 GH	393	int busnr;
	394	int nfree;
	395	int nused;
72cf2d4f BS	396	QTAILQ_HEAD(, USBPort) free;
	397	QTAILQ_HEAD(, USBPort) used;
	398	QTAILQ_ENTRY(USBBus) next;
806b6024 GH	399	};
806b6024 GH	400
07771f6f	401	struct USBBusOps {
ae60fea9 HG	402	int (register_companion)(USBBus bus, USBPort *ports[],
ae60fea9 HG	403	uint32_t portcount, uint32_t firstport);
07771f6f GH	404	};
	405
	406	void usb_bus_new(USBBus bus, USBBusOps ops, DeviceState *host);
806b6024 GH	407	USBBus *usb_bus_find(int busnr);
	408	void usb_qdev_register(USBDeviceInfo *info);
	409	void usb_qdev_register_many(USBDeviceInfo *info);
a5d2f727	410	USBDevice usb_create(USBBus bus, const char *name);
806b6024	411	USBDevice usb_create_simple(USBBus bus, const char *name);
0958b4cc	412	USBDevice usbdevice_create(const char cmdline);
a5d2f727	413	void usb_register_port(USBBus bus, USBPort port, void *opaque, int index,
ace1318b	414	USBPortOps *ops, int speedmask);
ae60fea9 HG	415	int usb_register_companion(const char masterbus, USBPort ports[],
	416	uint32_t portcount, uint32_t firstport,
	417	void opaque, USBPortOps ops, int speedmask);
c7a2196a	418	void usb_port_location(USBPort downstream, USBPort upstream, int portnr);
a8e662b5	419	void usb_unregister_port(USBBus bus, USBPort port);
891fb2cd GH	420	int usb_claim_port(USBDevice *dev);
891fb2cd GH	421	void usb_release_port(USBDevice *dev);
a5d2f727	422	int usb_device_attach(USBDevice *dev);
a8e662b5	423	int usb_device_detach(USBDevice *dev);
a5d2f727 GH	424	int usb_device_delete_addr(int busnr, int addr);
	425
	426	static inline USBBus usb_bus_from_device(USBDevice d)
	427	{
	428	return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
	429	}