[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"

#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_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;

    int speed;
    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);
    void (*wakeup)(USBDevice *dev);
    void (*complete)(USBDevice *dev, 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;
    uint8_t *data;
    int len;
    /* Internal use by the USB layer.  */
    USBDevice *owner;
};

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-hid.c */
void usb_hid_datain_cb(USBDevice *dev, void *opaque, void (*datain)(void *));

/* 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 {
    void (*device_destroy)(USBBus *bus, USBDevice *dev);
};

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);
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
bb36d470 FB	29	#define USB_TOKEN_SETUP 0x2d
	30	#define USB_TOKEN_IN 0x69 /* device -> host */
	31	#define USB_TOKEN_OUT 0xe1 /* host -> device */
	32
	33	/* specific usb messages, also sent in the 'pid' parameter */
	34	#define USB_MSG_ATTACH 0x100
	35	#define USB_MSG_DETACH 0x101
	36	#define USB_MSG_RESET 0x102
	37
5fafdf24	38	#define USB_RET_NODEV (-1)
bb36d470 FB	39	#define USB_RET_NAK (-2)
	40	#define USB_RET_STALL (-3)
	41	#define USB_RET_BABBLE (-4)
4d611c9a	42	#define USB_RET_ASYNC (-5)
bb36d470 FB	43
	44	#define USB_SPEED_LOW 0
	45	#define USB_SPEED_FULL 1
	46	#define USB_SPEED_HIGH 2
843d4e0c GH	47	#define USB_SPEED_SUPER 3
	48
	49	#define USB_SPEED_MASK_LOW (1 << USB_SPEED_LOW)
	50	#define USB_SPEED_MASK_FULL (1 << USB_SPEED_FULL)
	51	#define USB_SPEED_MASK_HIGH (1 << USB_SPEED_HIGH)
	52	#define USB_SPEED_MASK_SUPER (1 << USB_SPEED_SUPER)
bb36d470 FB	53
	54	#define USB_STATE_NOTATTACHED 0
	55	#define USB_STATE_ATTACHED 1
	56	//#define USB_STATE_POWERED 2
	57	#define USB_STATE_DEFAULT 3
	58	//#define USB_STATE_ADDRESS 4
	59	//#define USB_STATE_CONFIGURED 5
	60	#define USB_STATE_SUSPENDED 6
	61
a594cfbf FB	62	#define USB_CLASS_AUDIO 1
	63	#define USB_CLASS_COMM 2
	64	#define USB_CLASS_HID 3
	65	#define USB_CLASS_PHYSICAL 5
	66	#define USB_CLASS_STILL_IMAGE 6
	67	#define USB_CLASS_PRINTER 7
	68	#define USB_CLASS_MASS_STORAGE 8
	69	#define USB_CLASS_HUB 9
	70	#define USB_CLASS_CDC_DATA 0x0a
	71	#define USB_CLASS_CSCID 0x0b
	72	#define USB_CLASS_CONTENT_SEC 0x0d
	73	#define USB_CLASS_APP_SPEC 0xfe
	74	#define USB_CLASS_VENDOR_SPEC 0xff
	75
bb36d470 FB	76	#define USB_DIR_OUT 0
	77	#define USB_DIR_IN 0x80
	78
	79	#define USB_TYPE_MASK (0x03 << 5)
	80	#define USB_TYPE_STANDARD (0x00 << 5)
	81	#define USB_TYPE_CLASS (0x01 << 5)
	82	#define USB_TYPE_VENDOR (0x02 << 5)
	83	#define USB_TYPE_RESERVED (0x03 << 5)
	84
	85	#define USB_RECIP_MASK 0x1f
	86	#define USB_RECIP_DEVICE 0x00
	87	#define USB_RECIP_INTERFACE 0x01
	88	#define USB_RECIP_ENDPOINT 0x02
	89	#define USB_RECIP_OTHER 0x03
	90
	91	#define DeviceRequest ((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE)<<8)
	92	#define DeviceOutRequest ((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE)<<8)
59ae540c FB	93	#define InterfaceRequest \
	94	((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_INTERFACE)<<8)
	95	#define InterfaceOutRequest \
	96	((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_INTERFACE)<<8)
	97	#define EndpointRequest ((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_ENDPOINT)<<8)
	98	#define EndpointOutRequest \
	99	((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_ENDPOINT)<<8)
f3571b1a MR	100	#define ClassInterfaceRequest \
	101	((USB_DIR_IN\|USB_TYPE_CLASS\|USB_RECIP_INTERFACE)<<8)
	102	#define ClassInterfaceOutRequest \
	103	((USB_DIR_OUT\|USB_TYPE_CLASS\|USB_RECIP_INTERFACE)<<8)
bb36d470 FB	104
	105	#define USB_REQ_GET_STATUS 0x00
	106	#define USB_REQ_CLEAR_FEATURE 0x01
	107	#define USB_REQ_SET_FEATURE 0x03
	108	#define USB_REQ_SET_ADDRESS 0x05
	109	#define USB_REQ_GET_DESCRIPTOR 0x06
	110	#define USB_REQ_SET_DESCRIPTOR 0x07
	111	#define USB_REQ_GET_CONFIGURATION 0x08
	112	#define USB_REQ_SET_CONFIGURATION 0x09
	113	#define USB_REQ_GET_INTERFACE 0x0A
	114	#define USB_REQ_SET_INTERFACE 0x0B
	115	#define USB_REQ_SYNCH_FRAME 0x0C
	116
	117	#define USB_DEVICE_SELF_POWERED 0
	118	#define USB_DEVICE_REMOTE_WAKEUP 1
	119
	120	#define USB_DT_DEVICE 0x01
	121	#define USB_DT_CONFIG 0x02
	122	#define USB_DT_STRING 0x03
	123	#define USB_DT_INTERFACE 0x04
	124	#define USB_DT_ENDPOINT 0x05
25620cba GH	125	#define USB_DT_DEVICE_QUALIFIER 0x06
25620cba GH	126	#define USB_DT_OTHER_SPEED_CONFIG 0x07
c6d3ad0f	127	#define USB_DT_INTERFACE_ASSOC 0x0B
bb36d470	128
942ac052 AZ	129	#define USB_ENDPOINT_XFER_CONTROL 0
	130	#define USB_ENDPOINT_XFER_ISOC 1
	131	#define USB_ENDPOINT_XFER_BULK 2
	132	#define USB_ENDPOINT_XFER_INT 3
	133
806b6024	134	typedef struct USBBus USBBus;
07771f6f	135	typedef struct USBBusOps USBBusOps;
bb36d470 FB	136	typedef struct USBPort USBPort;
bb36d470 FB	137	typedef struct USBDevice USBDevice;
806b6024	138	typedef struct USBDeviceInfo USBDeviceInfo;
4d611c9a	139	typedef struct USBPacket USBPacket;
bb36d470	140
37fb59d3 GH	141	typedef struct USBDesc USBDesc;
	142	typedef struct USBDescID USBDescID;
	143	typedef struct USBDescDevice USBDescDevice;
	144	typedef struct USBDescConfig USBDescConfig;
6e625fc7	145	typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
37fb59d3 GH	146	typedef struct USBDescIface USBDescIface;
	147	typedef struct USBDescEndpoint USBDescEndpoint;
	148	typedef struct USBDescOther USBDescOther;
132a3f55 GH	149	typedef struct USBDescString USBDescString;
	150
	151	struct USBDescString {
	152	uint8_t index;
	153	char *str;
	154	QLIST_ENTRY(USBDescString) next;
	155	};
37fb59d3	156
bb36d470 FB	157	/* definition of a USB device */
bb36d470 FB	158	struct USBDevice {
806b6024 GH	159	DeviceState qdev;
806b6024 GH	160	USBDeviceInfo *info;
618c169b	161	USBPort *port;
5f69076b	162	char *port_path;
bb36d470	163	void *opaque;
89b9b79f	164
806b6024 GH	165	int speed;
806b6024 GH	166	uint8_t addr;
0fe6d12e	167	char product_desc[32];
61e094c0	168	int auto_attach;
a5d2f727	169	int attached;
806b6024	170
c1ecb40a	171	int32_t state;
806b6024	172	uint8_t setup_buf[8];
19f33223	173	uint8_t data_buf[4096];
c1ecb40a GH	174	int32_t remote_wakeup;
	175	int32_t setup_state;
	176	int32_t setup_len;
	177	int32_t setup_index;
132a3f55 GH	178
132a3f55 GH	179	QLIST_HEAD(, USBDescString) strings;
a980a065 GH	180	const USBDescDevice *device;
a980a065 GH	181	const USBDescConfig *config;
806b6024 GH	182	};
	183
	184	struct USBDeviceInfo {
	185	DeviceInfo qdev;
	186	int (init)(USBDevice dev);
	187
	188	/*
	189	* Process USB packet.
89b9b79f AL	190	* Called by the HC (Host Controller).
89b9b79f AL	191	*
806b6024	192	* Returns length of the transaction
89b9b79f	193	* or one of the USB_RET_XXX codes.
806b6024	194	*/
4d611c9a	195	int (handle_packet)(USBDevice dev, USBPacket *p);
89b9b79f	196
eb5e680a GH	197	/*
	198	* Called when a packet is canceled.
	199	*/
	200	void (cancel_packet)(USBDevice dev, USBPacket *p);
	201
806b6024	202	/*
89b9b79f AL	203	* Called when device is destroyed.
89b9b79f AL	204	*/
059809e4 FB	205	void (handle_destroy)(USBDevice dev);
059809e4 FB	206
b6f77fbe GH	207	/*
	208	* Attach the device
	209	*/
	210	void (handle_attach)(USBDevice dev);
	211
89b9b79f AL	212	/*
89b9b79f AL	213	* Reset the device
806b6024	214	*/
059809e4	215	void (handle_reset)(USBDevice dev);
89b9b79f AL	216
	217	/*
	218	* Process control request.
	219	* Called from handle_packet().
	220	*
	221	* Returns length or one of the USB_RET_ codes.
	222	*/
007fd62f	223	int (handle_control)(USBDevice dev, USBPacket *p, int request, int value,
bb36d470	224	int index, int length, uint8_t *data);
89b9b79f AL	225
	226	/*
	227	* Process data transfers (both BULK and ISOC).
	228	* Called from handle_packet().
	229	*
	230	* Returns length or one of the USB_RET_ codes.
	231	*/
4d611c9a	232	int (handle_data)(USBDevice dev, USBPacket *p);
0958b4cc	233
06384698	234	const char *product_desc;
37fb59d3	235	const USBDesc *usb_desc;
06384698	236
0958b4cc GH	237	/* handle legacy -usbdevice command line options */
	238	const char *usbdevice_name;
	239	USBDevice (usbdevice_init)(const char *params);
bb36d470 FB	240	};
bb36d470 FB	241
0d86d2be	242	typedef struct USBPortOps {
618c169b GH	243	void (attach)(USBPort port);
618c169b GH	244	void (detach)(USBPort port);
01eacab6	245	void (wakeup)(USBDevice dev);
13a9a0d3	246	void (complete)(USBDevice dev, USBPacket *p);
0d86d2be	247	} USBPortOps;
0d92ed30	248
bb36d470 FB	249	/* USB port on which a device can be connected */
bb36d470 FB	250	struct USBPort {
a594cfbf	251	USBDevice *dev;
843d4e0c	252	int speedmask;
c7a2196a	253	char path[16];
0d86d2be	254	USBPortOps *ops;
bb36d470 FB	255	void *opaque;
bb36d470 FB	256	int index; /* internal port index, may be used with the opaque */
72cf2d4f	257	QTAILQ_ENTRY(USBPort) next;
bb36d470 FB	258	};
bb36d470 FB	259
4d611c9a PB	260	typedef void USBCallback(USBPacket * packet, void *opaque);
	261
	262	/* Structure used to hold information about an active USB packet. */
	263	struct USBPacket {
	264	/* Data fields for use by the driver. */
	265	int pid;
	266	uint8_t devaddr;
	267	uint8_t devep;
	268	uint8_t *data;
	269	int len;
	270	/* Internal use by the USB layer. */
4ff658fb	271	USBDevice *owner;
4d611c9a PB	272	};
4d611c9a PB	273
53aa8c0e	274	int usb_handle_packet(USBDevice dev, USBPacket p);
4ff658fb GH	275	void usb_packet_complete(USBDevice dev, USBPacket p);
4ff658fb GH	276	void usb_cancel_packet(USBPacket * p);
53aa8c0e	277
bb36d470	278	void usb_attach(USBPort port, USBDevice dev);
01eacab6	279	void usb_wakeup(USBDevice *dev);
4d611c9a	280	int usb_generic_handle_packet(USBDevice s, USBPacket p);
50b7963e	281	void usb_generic_async_ctrl_complete(USBDevice s, USBPacket p);
bb36d470	282	int set_usb_string(uint8_t buf, const char str);
4d611c9a PB	283	void usb_send_msg(USBDevice *dev, int msg);
4d611c9a PB	284
bb36d470	285	/* usb-linux.c */
a594cfbf	286	USBDevice usb_host_device_open(const char devname);
5d0c5750	287	int usb_host_device_close(const char *devname);
376253ec	288	void usb_host_info(Monitor *mon);
59ae540c FB	289
59ae540c FB	290	/* usb-hid.c */
47e699dc	291	void usb_hid_datain_cb(USBDevice dev, void opaque, void (datain)(void ));
2e5d83bb	292
e6a6d5ab AZ	293	/* usb-bt.c */
	294	USBDevice usb_bt_init(HCIInfo hci);
	295
87ecb68b PB	296	/* usb ports of the VM */
87ecb68b PB	297
87ecb68b PB	298	#define VM_USB_HUB_SIZE 8
87ecb68b PB	299
942ac052 AZ	300	/* usb-musb.c */
	301	enum musb_irq_source_e {
	302	musb_irq_suspend = 0,
	303	musb_irq_resume,
	304	musb_irq_rst_babble,
	305	musb_irq_sof,
	306	musb_irq_connect,
	307	musb_irq_disconnect,
	308	musb_irq_vbus_request,
	309	musb_irq_vbus_error,
	310	musb_irq_rx,
	311	musb_irq_tx,
	312	musb_set_vbus,
	313	musb_set_session,
	314	__musb_irq_max,
	315	};
	316
bc24a225 PB	317	typedef struct MUSBState MUSBState;
	318	MUSBState musb_init(qemu_irq irqs);
	319	uint32_t musb_core_intr_get(MUSBState *s);
	320	void musb_core_intr_clear(MUSBState *s, uint32_t mask);
	321	void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
806b6024 GH	322
	323	/* usb-bus.c */
	324
	325	struct USBBus {
	326	BusState qbus;
07771f6f	327	USBBusOps *ops;
806b6024 GH	328	int busnr;
	329	int nfree;
	330	int nused;
72cf2d4f BS	331	QTAILQ_HEAD(, USBPort) free;
	332	QTAILQ_HEAD(, USBPort) used;
	333	QTAILQ_ENTRY(USBBus) next;
806b6024 GH	334	};
806b6024 GH	335
07771f6f GH	336	struct USBBusOps {
	337	void (device_destroy)(USBBus bus, USBDevice *dev);
	338	};
	339
	340	void usb_bus_new(USBBus bus, USBBusOps ops, DeviceState *host);
806b6024 GH	341	USBBus *usb_bus_find(int busnr);
	342	void usb_qdev_register(USBDeviceInfo *info);
	343	void usb_qdev_register_many(USBDeviceInfo *info);
a5d2f727	344	USBDevice usb_create(USBBus bus, const char *name);
806b6024	345	USBDevice usb_create_simple(USBBus bus, const char *name);
0958b4cc	346	USBDevice usbdevice_create(const char cmdline);
a5d2f727	347	void usb_register_port(USBBus bus, USBPort port, void *opaque, int index,
ace1318b	348	USBPortOps *ops, int speedmask);
c7a2196a	349	void usb_port_location(USBPort downstream, USBPort upstream, int portnr);
a8e662b5	350	void usb_unregister_port(USBBus bus, USBPort port);
a5d2f727	351	int usb_device_attach(USBDevice *dev);
a8e662b5	352	int usb_device_detach(USBDevice *dev);
a5d2f727 GH	353	int usb_device_delete_addr(int busnr, int addr);
	354
	355	static inline USBBus usb_bus_from_device(USBDevice d)
	356	{
	357	return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
	358	}