[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_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_ENDPOINT_XFER_CONTROL	0
#define USB_ENDPOINT_XFER_ISOC		1
#define USB_ENDPOINT_XFER_BULK		2
#define USB_ENDPOINT_XFER_INT		3

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 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;
};

/* 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;

    QLIST_HEAD(, USBDescString) strings;
    const USBDescDevice *device;
    const USBDescConfig *config;
};

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);

    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_attach(USBPort *port, USBDevice *dev);
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,
    __musb_irq_max,
};

typedef struct MUSBState MUSBState;
MUSBState *musb_init(qemu_irq *irqs);
uint32_t musb_core_intr_get(MUSBState *s);
void musb_core_intr_clear(MUSBState *s, uint32_t mask);
void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);

/* 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_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
bb36d470 FB	82	#define USB_DIR_OUT 0
	83	#define USB_DIR_IN 0x80
	84
	85	#define USB_TYPE_MASK (0x03 << 5)
	86	#define USB_TYPE_STANDARD (0x00 << 5)
	87	#define USB_TYPE_CLASS (0x01 << 5)
	88	#define USB_TYPE_VENDOR (0x02 << 5)
	89	#define USB_TYPE_RESERVED (0x03 << 5)
	90
	91	#define USB_RECIP_MASK 0x1f
	92	#define USB_RECIP_DEVICE 0x00
	93	#define USB_RECIP_INTERFACE 0x01
	94	#define USB_RECIP_ENDPOINT 0x02
	95	#define USB_RECIP_OTHER 0x03
	96
	97	#define DeviceRequest ((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE)<<8)
	98	#define DeviceOutRequest ((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE)<<8)
59ae540c FB	99	#define InterfaceRequest \
	100	((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_INTERFACE)<<8)
	101	#define InterfaceOutRequest \
	102	((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_INTERFACE)<<8)
	103	#define EndpointRequest ((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_ENDPOINT)<<8)
	104	#define EndpointOutRequest \
	105	((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_ENDPOINT)<<8)
f3571b1a MR	106	#define ClassInterfaceRequest \
	107	((USB_DIR_IN\|USB_TYPE_CLASS\|USB_RECIP_INTERFACE)<<8)
	108	#define ClassInterfaceOutRequest \
	109	((USB_DIR_OUT\|USB_TYPE_CLASS\|USB_RECIP_INTERFACE)<<8)
bb36d470 FB	110
	111	#define USB_REQ_GET_STATUS 0x00
	112	#define USB_REQ_CLEAR_FEATURE 0x01
	113	#define USB_REQ_SET_FEATURE 0x03
	114	#define USB_REQ_SET_ADDRESS 0x05
	115	#define USB_REQ_GET_DESCRIPTOR 0x06
	116	#define USB_REQ_SET_DESCRIPTOR 0x07
	117	#define USB_REQ_GET_CONFIGURATION 0x08
	118	#define USB_REQ_SET_CONFIGURATION 0x09
	119	#define USB_REQ_GET_INTERFACE 0x0A
	120	#define USB_REQ_SET_INTERFACE 0x0B
	121	#define USB_REQ_SYNCH_FRAME 0x0C
	122
	123	#define USB_DEVICE_SELF_POWERED 0
	124	#define USB_DEVICE_REMOTE_WAKEUP 1
	125
	126	#define USB_DT_DEVICE 0x01
	127	#define USB_DT_CONFIG 0x02
	128	#define USB_DT_STRING 0x03
	129	#define USB_DT_INTERFACE 0x04
	130	#define USB_DT_ENDPOINT 0x05
25620cba GH	131	#define USB_DT_DEVICE_QUALIFIER 0x06
25620cba GH	132	#define USB_DT_OTHER_SPEED_CONFIG 0x07
a7fb71d1	133	#define USB_DT_DEBUG 0x0A
c6d3ad0f	134	#define USB_DT_INTERFACE_ASSOC 0x0B
bb36d470	135
942ac052 AZ	136	#define USB_ENDPOINT_XFER_CONTROL 0
	137	#define USB_ENDPOINT_XFER_ISOC 1
	138	#define USB_ENDPOINT_XFER_BULK 2
	139	#define USB_ENDPOINT_XFER_INT 3
	140
806b6024	141	typedef struct USBBus USBBus;
07771f6f	142	typedef struct USBBusOps USBBusOps;
bb36d470 FB	143	typedef struct USBPort USBPort;
bb36d470 FB	144	typedef struct USBDevice USBDevice;
806b6024	145	typedef struct USBDeviceInfo USBDeviceInfo;
4d611c9a	146	typedef struct USBPacket USBPacket;
bb36d470	147
37fb59d3 GH	148	typedef struct USBDesc USBDesc;
	149	typedef struct USBDescID USBDescID;
	150	typedef struct USBDescDevice USBDescDevice;
	151	typedef struct USBDescConfig USBDescConfig;
6e625fc7	152	typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
37fb59d3 GH	153	typedef struct USBDescIface USBDescIface;
	154	typedef struct USBDescEndpoint USBDescEndpoint;
	155	typedef struct USBDescOther USBDescOther;
132a3f55 GH	156	typedef struct USBDescString USBDescString;
	157
	158	struct USBDescString {
	159	uint8_t index;
	160	char *str;
	161	QLIST_ENTRY(USBDescString) next;
	162	};
37fb59d3	163
bb36d470 FB	164	/* definition of a USB device */
bb36d470 FB	165	struct USBDevice {
806b6024 GH	166	DeviceState qdev;
806b6024 GH	167	USBDeviceInfo *info;
618c169b	168	USBPort *port;
5f69076b	169	char *port_path;
bb36d470	170	void *opaque;
89b9b79f	171
ba3f9bfb	172	/* Actual connected speed */
806b6024	173	int speed;
ba3f9bfb HG	174	/* Supported speeds, not in info because it may be variable (hostdevs) */
ba3f9bfb HG	175	int speedmask;
806b6024	176	uint8_t addr;
0fe6d12e	177	char product_desc[32];
61e094c0	178	int auto_attach;
a5d2f727	179	int attached;
806b6024	180
c1ecb40a	181	int32_t state;
806b6024	182	uint8_t setup_buf[8];
19f33223	183	uint8_t data_buf[4096];
c1ecb40a GH	184	int32_t remote_wakeup;
	185	int32_t setup_state;
	186	int32_t setup_len;
	187	int32_t setup_index;
132a3f55 GH	188
132a3f55 GH	189	QLIST_HEAD(, USBDescString) strings;
a980a065 GH	190	const USBDescDevice *device;
a980a065 GH	191	const USBDescConfig *config;
806b6024 GH	192	};
	193
	194	struct USBDeviceInfo {
	195	DeviceInfo qdev;
	196	int (init)(USBDevice dev);
	197
	198	/*
	199	* Process USB packet.
89b9b79f AL	200	* Called by the HC (Host Controller).
89b9b79f AL	201	*
806b6024	202	* Returns length of the transaction
89b9b79f	203	* or one of the USB_RET_XXX codes.
806b6024	204	*/
4d611c9a	205	int (handle_packet)(USBDevice dev, USBPacket *p);
89b9b79f	206
eb5e680a GH	207	/*
	208	* Called when a packet is canceled.
	209	*/
	210	void (cancel_packet)(USBDevice dev, USBPacket *p);
	211
806b6024	212	/*
89b9b79f AL	213	* Called when device is destroyed.
89b9b79f AL	214	*/
059809e4 FB	215	void (handle_destroy)(USBDevice dev);
059809e4 FB	216
b6f77fbe GH	217	/*
	218	* Attach the device
	219	*/
	220	void (handle_attach)(USBDevice dev);
	221
89b9b79f AL	222	/*
89b9b79f AL	223	* Reset the device
806b6024	224	*/
059809e4	225	void (handle_reset)(USBDevice dev);
89b9b79f AL	226
	227	/*
	228	* Process control request.
	229	* Called from handle_packet().
	230	*
	231	* Returns length or one of the USB_RET_ codes.
	232	*/
007fd62f	233	int (handle_control)(USBDevice dev, USBPacket *p, int request, int value,
bb36d470	234	int index, int length, uint8_t *data);
89b9b79f AL	235
	236	/*
	237	* Process data transfers (both BULK and ISOC).
	238	* Called from handle_packet().
	239	*
	240	* Returns length or one of the USB_RET_ codes.
	241	*/
4d611c9a	242	int (handle_data)(USBDevice dev, USBPacket *p);
0958b4cc	243
06384698	244	const char *product_desc;
37fb59d3	245	const USBDesc *usb_desc;
06384698	246
0958b4cc GH	247	/* handle legacy -usbdevice command line options */
	248	const char *usbdevice_name;
	249	USBDevice (usbdevice_init)(const char *params);
bb36d470 FB	250	};
bb36d470 FB	251
0d86d2be	252	typedef struct USBPortOps {
618c169b GH	253	void (attach)(USBPort port);
618c169b GH	254	void (detach)(USBPort port);
4706ab6c HG	255	/*
	256	* This gets called when a device downstream from the device attached to
	257	* the port (iow attached through a hub) gets detached.
	258	*/
	259	void (child_detach)(USBPort port, USBDevice *child);
d47e59b8 HG	260	void (wakeup)(USBPort port);
	261	/*
	262	* Note that port->dev will be different then the device from which
	263	* the packet originated when a hub is involved, if you want the orginating
	264	* device use p->owner
	265	*/
	266	void (complete)(USBPort port, USBPacket *p);
0d86d2be	267	} USBPortOps;
0d92ed30	268
bb36d470 FB	269	/* USB port on which a device can be connected */
bb36d470 FB	270	struct USBPort {
a594cfbf	271	USBDevice *dev;
843d4e0c	272	int speedmask;
c7a2196a	273	char path[16];
0d86d2be	274	USBPortOps *ops;
bb36d470 FB	275	void *opaque;
bb36d470 FB	276	int index; /* internal port index, may be used with the opaque */
72cf2d4f	277	QTAILQ_ENTRY(USBPort) next;
bb36d470 FB	278	};
bb36d470 FB	279
4d611c9a PB	280	typedef void USBCallback(USBPacket * packet, void *opaque);
	281
	282	/* Structure used to hold information about an active USB packet. */
	283	struct USBPacket {
	284	/* Data fields for use by the driver. */
	285	int pid;
	286	uint8_t devaddr;
	287	uint8_t devep;
4f4321c1 GH	288	QEMUIOVector iov;
4f4321c1 GH	289	int result; /* transfer length or USB_RET_* status code */
4d611c9a	290	/* Internal use by the USB layer. */
4ff658fb	291	USBDevice *owner;
4d611c9a PB	292	};
4d611c9a PB	293
4f4321c1 GH	294	void usb_packet_init(USBPacket *p);
	295	void usb_packet_setup(USBPacket *p, int pid, uint8_t addr, uint8_t ep);
	296	void usb_packet_addbuf(USBPacket p, void ptr, size_t len);
	297	int usb_packet_map(USBPacket p, QEMUSGList sgl);
	298	void usb_packet_unmap(USBPacket *p);
	299	void usb_packet_copy(USBPacket p, void ptr, size_t bytes);
	300	void usb_packet_skip(USBPacket *p, size_t bytes);
	301	void usb_packet_cleanup(USBPacket *p);
	302
53aa8c0e	303	int usb_handle_packet(USBDevice dev, USBPacket p);
4ff658fb GH	304	void usb_packet_complete(USBDevice dev, USBPacket p);
4ff658fb GH	305	void usb_cancel_packet(USBPacket * p);
53aa8c0e	306
bb36d470	307	void usb_attach(USBPort port, USBDevice dev);
01eacab6	308	void usb_wakeup(USBDevice *dev);
4d611c9a	309	int usb_generic_handle_packet(USBDevice s, USBPacket p);
50b7963e	310	void usb_generic_async_ctrl_complete(USBDevice s, USBPacket p);
bb36d470	311	int set_usb_string(uint8_t buf, const char str);
4d611c9a PB	312	void usb_send_msg(USBDevice *dev, int msg);
4d611c9a PB	313
bb36d470	314	/* usb-linux.c */
a594cfbf	315	USBDevice usb_host_device_open(const char devname);
5d0c5750	316	int usb_host_device_close(const char *devname);
376253ec	317	void usb_host_info(Monitor *mon);
59ae540c	318
e6a6d5ab AZ	319	/* usb-bt.c */
	320	USBDevice usb_bt_init(HCIInfo hci);
	321
87ecb68b PB	322	/* usb ports of the VM */
87ecb68b PB	323
87ecb68b PB	324	#define VM_USB_HUB_SIZE 8
87ecb68b PB	325
942ac052 AZ	326	/* usb-musb.c */
	327	enum musb_irq_source_e {
	328	musb_irq_suspend = 0,
	329	musb_irq_resume,
	330	musb_irq_rst_babble,
	331	musb_irq_sof,
	332	musb_irq_connect,
	333	musb_irq_disconnect,
	334	musb_irq_vbus_request,
	335	musb_irq_vbus_error,
	336	musb_irq_rx,
	337	musb_irq_tx,
	338	musb_set_vbus,
	339	musb_set_session,
	340	__musb_irq_max,
	341	};
	342
bc24a225 PB	343	typedef struct MUSBState MUSBState;
	344	MUSBState musb_init(qemu_irq irqs);
	345	uint32_t musb_core_intr_get(MUSBState *s);
	346	void musb_core_intr_clear(MUSBState *s, uint32_t mask);
	347	void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
806b6024 GH	348
	349	/* usb-bus.c */
	350
	351	struct USBBus {
	352	BusState qbus;
07771f6f	353	USBBusOps *ops;
806b6024 GH	354	int busnr;
	355	int nfree;
	356	int nused;
72cf2d4f BS	357	QTAILQ_HEAD(, USBPort) free;
	358	QTAILQ_HEAD(, USBPort) used;
	359	QTAILQ_ENTRY(USBBus) next;
806b6024 GH	360	};
806b6024 GH	361
07771f6f	362	struct USBBusOps {
ae60fea9 HG	363	int (register_companion)(USBBus bus, USBPort *ports[],
ae60fea9 HG	364	uint32_t portcount, uint32_t firstport);
07771f6f GH	365	};
	366
	367	void usb_bus_new(USBBus bus, USBBusOps ops, DeviceState *host);
806b6024 GH	368	USBBus *usb_bus_find(int busnr);
	369	void usb_qdev_register(USBDeviceInfo *info);
	370	void usb_qdev_register_many(USBDeviceInfo *info);
a5d2f727	371	USBDevice usb_create(USBBus bus, const char *name);
806b6024	372	USBDevice usb_create_simple(USBBus bus, const char *name);
0958b4cc	373	USBDevice usbdevice_create(const char cmdline);
a5d2f727	374	void usb_register_port(USBBus bus, USBPort port, void *opaque, int index,
ace1318b	375	USBPortOps *ops, int speedmask);
ae60fea9 HG	376	int usb_register_companion(const char masterbus, USBPort ports[],
	377	uint32_t portcount, uint32_t firstport,
	378	void opaque, USBPortOps ops, int speedmask);
c7a2196a	379	void usb_port_location(USBPort downstream, USBPort upstream, int portnr);
a8e662b5	380	void usb_unregister_port(USBBus bus, USBPort port);
a5d2f727	381	int usb_device_attach(USBDevice *dev);
a8e662b5	382	int usb_device_detach(USBDevice *dev);
a5d2f727 GH	383	int usb_device_delete_addr(int busnr, int addr);
	384
	385	static inline USBBus usb_bus_from_device(USBDevice d)
	386	{
	387	return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
	388	}