[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.
 */
#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 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

typedef struct USBPort USBPort;
typedef struct USBDevice USBDevice;
typedef struct USBPacket USBPacket;

/* definition of a USB device */
struct USBDevice {
    void *opaque;
    int (*handle_packet)(USBDevice *dev, USBPacket *p);
    void (*handle_destroy)(USBDevice *dev);

    int speed;

    /* The following fields are used by the generic USB device
       layer. They are here just to avoid creating a new structure for
       them. */
    void (*handle_reset)(USBDevice *dev);
    int (*handle_control)(USBDevice *dev, int request, int value,
                          int index, int length, uint8_t *data);
    int (*handle_data)(USBDevice *dev, USBPacket *p);
    uint8_t addr;
    char devname[32];

    int state;
    uint8_t setup_buf[8];
    uint8_t data_buf[1024];
    int remote_wakeup;
    int setup_state;
    int setup_len;
    int setup_index;
};

typedef void (*usb_attachfn)(USBPort *port, USBDevice *dev);

/* USB port on which a device can be connected */
struct USBPort {
    USBDevice *dev;
    usb_attachfn attach;
    void *opaque;
    int index; /* internal port index, may be used with the opaque */
    struct USBPort *next; /* Used internally by qemu.  */
};

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

void usb_packet_complete(USBPacket *p);

/* usb hub */
USBDevice *usb_hub_init(int nb_ports);

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

/* usb-hid.c */
USBDevice *usb_mouse_init(void);
USBDevice *usb_tablet_init(void);
USBDevice *usb_keyboard_init(void);

/* usb-msd.c */
USBDevice *usb_msd_init(const char *filename);

/* usb-wacom.c */
USBDevice *usb_wacom_init(void);

/* usb ports of the VM */

void qemu_register_usb_port(USBPort *port, void *opaque, int index,
                            usb_attachfn attach);

#define VM_USB_HUB_SIZE 8
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	*/
	24	#define USB_TOKEN_SETUP 0x2d
	25	#define USB_TOKEN_IN 0x69 /* device -> host */
	26	#define USB_TOKEN_OUT 0xe1 /* host -> device */
	27
	28	/* specific usb messages, also sent in the 'pid' parameter */
	29	#define USB_MSG_ATTACH 0x100
	30	#define USB_MSG_DETACH 0x101
	31	#define USB_MSG_RESET 0x102
	32
5fafdf24	33	#define USB_RET_NODEV (-1)
bb36d470 FB	34	#define USB_RET_NAK (-2)
	35	#define USB_RET_STALL (-3)
	36	#define USB_RET_BABBLE (-4)
4d611c9a	37	#define USB_RET_ASYNC (-5)
bb36d470 FB	38
	39	#define USB_SPEED_LOW 0
	40	#define USB_SPEED_FULL 1
	41	#define USB_SPEED_HIGH 2
	42
	43	#define USB_STATE_NOTATTACHED 0
	44	#define USB_STATE_ATTACHED 1
	45	//#define USB_STATE_POWERED 2
	46	#define USB_STATE_DEFAULT 3
	47	//#define USB_STATE_ADDRESS 4
	48	//#define USB_STATE_CONFIGURED 5
	49	#define USB_STATE_SUSPENDED 6
	50
a594cfbf FB	51	#define USB_CLASS_AUDIO 1
	52	#define USB_CLASS_COMM 2
	53	#define USB_CLASS_HID 3
	54	#define USB_CLASS_PHYSICAL 5
	55	#define USB_CLASS_STILL_IMAGE 6
	56	#define USB_CLASS_PRINTER 7
	57	#define USB_CLASS_MASS_STORAGE 8
	58	#define USB_CLASS_HUB 9
	59	#define USB_CLASS_CDC_DATA 0x0a
	60	#define USB_CLASS_CSCID 0x0b
	61	#define USB_CLASS_CONTENT_SEC 0x0d
	62	#define USB_CLASS_APP_SPEC 0xfe
	63	#define USB_CLASS_VENDOR_SPEC 0xff
	64
bb36d470 FB	65	#define USB_DIR_OUT 0
	66	#define USB_DIR_IN 0x80
	67
	68	#define USB_TYPE_MASK (0x03 << 5)
	69	#define USB_TYPE_STANDARD (0x00 << 5)
	70	#define USB_TYPE_CLASS (0x01 << 5)
	71	#define USB_TYPE_VENDOR (0x02 << 5)
	72	#define USB_TYPE_RESERVED (0x03 << 5)
	73
	74	#define USB_RECIP_MASK 0x1f
	75	#define USB_RECIP_DEVICE 0x00
	76	#define USB_RECIP_INTERFACE 0x01
	77	#define USB_RECIP_ENDPOINT 0x02
	78	#define USB_RECIP_OTHER 0x03
	79
	80	#define DeviceRequest ((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE)<<8)
	81	#define DeviceOutRequest ((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE)<<8)
59ae540c FB	82	#define InterfaceRequest \
	83	((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_INTERFACE)<<8)
	84	#define InterfaceOutRequest \
	85	((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_INTERFACE)<<8)
	86	#define EndpointRequest ((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_ENDPOINT)<<8)
	87	#define EndpointOutRequest \
	88	((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_ENDPOINT)<<8)
bb36d470 FB	89
	90	#define USB_REQ_GET_STATUS 0x00
	91	#define USB_REQ_CLEAR_FEATURE 0x01
	92	#define USB_REQ_SET_FEATURE 0x03
	93	#define USB_REQ_SET_ADDRESS 0x05
	94	#define USB_REQ_GET_DESCRIPTOR 0x06
	95	#define USB_REQ_SET_DESCRIPTOR 0x07
	96	#define USB_REQ_GET_CONFIGURATION 0x08
	97	#define USB_REQ_SET_CONFIGURATION 0x09
	98	#define USB_REQ_GET_INTERFACE 0x0A
	99	#define USB_REQ_SET_INTERFACE 0x0B
	100	#define USB_REQ_SYNCH_FRAME 0x0C
	101
	102	#define USB_DEVICE_SELF_POWERED 0
	103	#define USB_DEVICE_REMOTE_WAKEUP 1
	104
	105	#define USB_DT_DEVICE 0x01
	106	#define USB_DT_CONFIG 0x02
	107	#define USB_DT_STRING 0x03
	108	#define USB_DT_INTERFACE 0x04
	109	#define USB_DT_ENDPOINT 0x05
	110
	111	typedef struct USBPort USBPort;
	112	typedef struct USBDevice USBDevice;
4d611c9a	113	typedef struct USBPacket USBPacket;
bb36d470 FB	114
	115	/* definition of a USB device */
	116	struct USBDevice {
	117	void *opaque;
4d611c9a	118	int (handle_packet)(USBDevice dev, USBPacket *p);
059809e4 FB	119	void (handle_destroy)(USBDevice dev);
059809e4 FB	120
bb36d470	121	int speed;
3b46e624	122
bb36d470 FB	123	/* The following fields are used by the generic USB device
	124	layer. They are here just to avoid creating a new structure for
	125	them. */
059809e4	126	void (handle_reset)(USBDevice dev);
bb36d470 FB	127	int (handle_control)(USBDevice dev, int request, int value,
bb36d470 FB	128	int index, int length, uint8_t *data);
4d611c9a	129	int (handle_data)(USBDevice dev, USBPacket *p);
bb36d470	130	uint8_t addr;
1f6e24e7	131	char devname[32];
3b46e624	132
bb36d470 FB	133	int state;
	134	uint8_t setup_buf[8];
	135	uint8_t data_buf[1024];
	136	int remote_wakeup;
	137	int setup_state;
	138	int setup_len;
	139	int setup_index;
	140	};
	141
0d92ed30 PB	142	typedef void (usb_attachfn)(USBPort port, USBDevice *dev);
0d92ed30 PB	143
bb36d470 FB	144	/* USB port on which a device can be connected */
bb36d470 FB	145	struct USBPort {
a594cfbf	146	USBDevice *dev;
0d92ed30	147	usb_attachfn attach;
bb36d470 FB	148	void *opaque;
bb36d470 FB	149	int index; /* internal port index, may be used with the opaque */
0d92ed30	150	struct USBPort next; / Used internally by qemu. */
bb36d470 FB	151	};
bb36d470 FB	152
4d611c9a PB	153	typedef void USBCallback(USBPacket * packet, void *opaque);
	154
	155	/* Structure used to hold information about an active USB packet. */
	156	struct USBPacket {
	157	/* Data fields for use by the driver. */
	158	int pid;
	159	uint8_t devaddr;
	160	uint8_t devep;
	161	uint8_t *data;
	162	int len;
	163	/* Internal use by the USB layer. */
	164	USBCallback *complete_cb;
	165	void *complete_opaque;
	166	USBCallback *cancel_cb;
b63891a0	167	void *cancel_opaque;
4d611c9a PB	168	};
	169
	170	/* Defer completion of a USB packet. The hadle_packet routine should then
	171	return USB_RET_ASYNC. Packets that complete immediately (before
	172	handle_packet returns) should not call this method. */
	173	static inline void usb_defer_packet(USBPacket p, USBCallback cancel,
	174	void * opaque)
	175	{
	176	p->cancel_cb = cancel;
	177	p->cancel_opaque = opaque;
	178	}
	179
	180	/* Notify the controller that an async packet is complete. This should only
	181	be called for packets previously deferred with usb_defer_packet, and
	182	should never be called from within handle_packet. */
	183	static inline void usb_packet_complete(USBPacket *p)
	184	{
	185	p->complete_cb(p, p->complete_opaque);
	186	}
	187
	188	/* Cancel an active packet. The packed must have been deferred with
	189	usb_defer_packet, and not yet completed. */
	190	static inline void usb_cancel_packet(USBPacket * p)
	191	{
	192	p->cancel_cb(p, p->cancel_opaque);
	193	}
	194
bb36d470	195	void usb_attach(USBPort port, USBDevice dev);
4d611c9a	196	int usb_generic_handle_packet(USBDevice s, USBPacket p);
bb36d470	197	int set_usb_string(uint8_t buf, const char str);
4d611c9a PB	198	void usb_send_msg(USBDevice *dev, int msg);
	199
	200	void usb_packet_complete(USBPacket *p);
bb36d470 FB	201
bb36d470 FB	202	/* usb hub */
0d92ed30	203	USBDevice *usb_hub_init(int nb_ports);
bb36d470	204
bb36d470	205	/* usb-linux.c */
a594cfbf FB	206	USBDevice usb_host_device_open(const char devname);
a594cfbf FB	207	void usb_host_info(void);
59ae540c FB	208
	209	/* usb-hid.c */
	210	USBDevice *usb_mouse_init(void);
09b26c5e	211	USBDevice *usb_tablet_init(void);
47b2d338	212	USBDevice *usb_keyboard_init(void);
2e5d83bb PB	213
	214	/* usb-msd.c */
	215	USBDevice usb_msd_init(const char filename);
f6d2a316 AZ	216
	217	/* usb-wacom.c */
	218	USBDevice *usb_wacom_init(void);
87ecb68b PB	219
	220	/* usb ports of the VM */
	221
	222	void qemu_register_usb_port(USBPort port, void opaque, int index,
	223	usb_attachfn attach);
	224
	225	#define VM_USB_HUB_SIZE 8
	226