[mirror_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_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_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 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 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;
    void *opaque;

    int speed;
    uint8_t addr;
    char product_desc[32];
    int auto_attach;
    int attached;

    int state;
    uint8_t setup_buf[8];
    uint8_t data_buf[1024];
    int remote_wakeup;
    int setup_state;
    int setup_len;
    int 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 device is destroyed.
     */
    void (*handle_destroy)(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, 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, USBDevice *dev);
} USBPortOps;

/* USB port on which a device can be connected */
struct USBPort {
    USBDevice *dev;
    USBPortOps *ops;
    void *opaque;
    USBDevice *pdev;
    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.  */
    USBCallback *complete_cb;
    void *complete_opaque;
    USBCallback *cancel_cb;
    void *cancel_opaque;
};

/* Defer completion of a USB packet.  The hadle_packet routine should then
   return USB_RET_ASYNC.  Packets that complete immediately (before
   handle_packet returns) should not call this method.  */
static inline void usb_defer_packet(USBPacket *p, USBCallback *cancel,
                                    void * opaque)
{
    p->cancel_cb = cancel;
    p->cancel_opaque = opaque;
}

/* Notify the controller that an async packet is complete.  This should only
   be called for packets previously deferred with usb_defer_packet, and
   should never be called from within handle_packet.  */
static inline void usb_packet_complete(USBPacket *p)
{
    p->complete_cb(p, p->complete_opaque);
}

/* Cancel an active packet.  The packed must have been deferred with
   usb_defer_packet,  and not yet completed.  */
static inline void usb_cancel_packet(USBPacket * p)
{
    p->cancel_cb(p, p->cancel_opaque);
}

void usb_attach(USBPort *port, USBDevice *dev);
int usb_generic_handle_packet(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;
    int busnr;
    int nfree;
    int nused;
    QTAILQ_HEAD(, USBPort) free;
    QTAILQ_HEAD(, USBPort) used;
    QTAILQ_ENTRY(USBBus) next;
};

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