[qemu.git] / hw / usb.h

#ifndef QEMU_USB_H
#define QEMU_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 */

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

#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 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 nr;
    uint8_t pid;
    uint8_t type;
    uint8_t ifnum;
    int max_packet_size;
    bool pipeline;
    USBDevice *dev;
    QTAILQ_HEAD(, USBPacket) queue;
};

enum USBDeviceFlags {
    USB_DEV_FLAG_FULL_PATH,
};

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

    /* 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_ctl;
    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];
};

#define TYPE_USB_DEVICE "usb-device"
#define USB_DEVICE(obj) \
     OBJECT_CHECK(USBDevice, (obj), TYPE_USB_DEVICE)
#define USB_DEVICE_CLASS(klass) \
     OBJECT_CLASS_CHECK(USBDeviceClass, (klass), TYPE_USB_DEVICE)
#define USB_DEVICE_GET_CLASS(obj) \
     OBJECT_GET_CLASS(USBDeviceClass, (obj), TYPE_USB_DEVICE)

typedef struct USBDeviceClass {
    DeviceClass parent_class;

    int (*init)(USBDevice *dev);

    /*
     * Walk (enabled) downstream ports, check for a matching device.
     * Only hubs implement this.
     */
    USBDevice *(*find_device)(USBDevice *dev, uint8_t addr);

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

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

typedef enum USBPacketState {
    USB_PACKET_UNDEFINED = 0,
    USB_PACKET_SETUP,
    USB_PACKET_QUEUED,
    USB_PACKET_ASYNC,
    USB_PACKET_COMPLETE,
    USB_PACKET_CANCELED,
} USBPacketState;

/* Structure used to hold information about an active USB packet.  */
struct USBPacket {
    /* Data fields for use by the driver.  */
    int pid;
    USBEndpoint *ep;
    QEMUIOVector iov;
    uint64_t parameter; /* control transfers */
    int result; /* transfer length or USB_RET_* status code */
    /* Internal use by the USB layer.  */
    USBPacketState state;
    QTAILQ_ENTRY(USBPacket) queue;
};

void usb_packet_init(USBPacket *p);
void usb_packet_set_state(USBPacket *p, USBPacketState state);
void usb_packet_check_state(USBPacket *p, USBPacketState expected);
void usb_packet_setup(USBPacket *p, int pid, USBEndpoint *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, QEMUSGList *sgl);
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);

static inline bool usb_packet_is_inflight(USBPacket *p)
{
    return (p->state == USB_PACKET_QUEUED ||
            p->state == USB_PACKET_ASYNC);
}

USBDevice *usb_find_device(USBPort *port, uint8_t addr);

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);
void usb_ep_dump(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_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
                                uint16_t raw);
int usb_ep_get_max_packet_size(USBDevice *dev, int pid, int ep);
void usb_ep_set_pipeline(USBDevice *dev, int pid, int ep, bool enabled);

void usb_attach(USBPort *port);
void usb_detach(USBPort *port);
void usb_port_reset(USBPort *port);
void usb_device_reset(USBDevice *dev);
void usb_wakeup(USBEndpoint *ep);
void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
int set_usb_string(uint8_t *buf, const char *str);

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

/* usb-bt.c */
USBDevice *usb_bt_init(USBBus *bus, 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 */

#define TYPE_USB_BUS "usb-bus"
#define USB_BUS(obj) OBJECT_CHECK(USBBus, (obj), TYPE_USB_BUS)

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 (*wakeup_endpoint)(USBBus *bus, USBEndpoint *ep);
};

void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host);
USBBus *usb_bus_find(int busnr);
void usb_legacy_register(const char *typename, const char *usbdevice_name,
                         USBDevice *(*usbdevice_init)(USBBus *bus,
                                                      const char *params));
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);
}

extern const VMStateDescription vmstate_usb_device;

#define VMSTATE_USB_DEVICE(_field, _state) {                         \
    .name       = (stringify(_field)),                               \
    .size       = sizeof(USBDevice),                                 \
    .vmsd       = &vmstate_usb_device,                               \
    .flags      = VMS_STRUCT,                                        \
    .offset     = vmstate_offset_value(_state, _field, USBDevice),   \
}

USBDevice *usb_device_find_device(USBDevice *dev, uint8_t addr);

void usb_device_cancel_packet(USBDevice *dev, USBPacket *p);

void usb_device_handle_attach(USBDevice *dev);

void usb_device_handle_reset(USBDevice *dev);

int usb_device_handle_control(USBDevice *dev, USBPacket *p, int request, int value,
                              int index, int length, uint8_t *data);

int usb_device_handle_data(USBDevice *dev, USBPacket *p);

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

const char *usb_device_get_product_desc(USBDevice *dev);

const USBDesc *usb_device_get_usb_desc(USBDevice *dev);

#endif
Commit	Line	Data
62aed765 AL	1	#ifndef QEMU_USB_H
	2	#define QEMU_USB_H
	3
bb36d470 FB	4	/*
bb36d470 FB	5	* QEMU USB API
5fafdf24	6	*
bb36d470	7	* Copyright (c) 2005 Fabrice Bellard
5fafdf24	8	*
bb36d470 FB	9	* Permission is hereby granted, free of charge, to any person obtaining a copy
	10	* of this software and associated documentation files (the "Software"), to deal
	11	* in the Software without restriction, including without limitation the rights
	12	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	13	* copies of the Software, and to permit persons to whom the Software is
	14	* furnished to do so, subject to the following conditions:
	15	*
	16	* The above copyright notice and this permission notice shall be included in
	17	* all copies or substantial portions of the Software.
	18	*
	19	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	20	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	21	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	22	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	23	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	24	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	25	* THE SOFTWARE.
	26	*/
c0f4ce77 AL	27
c0f4ce77 AL	28	#include "block.h"
806b6024	29	#include "qdev.h"
72cf2d4f	30	#include "qemu-queue.h"
c0f4ce77	31
8e257816 BH	32	/* Constants related to the USB / PCI interaction */
	33	#define USB_SBRN 0x60 /* Serial Bus Release Number Register */
	34	#define USB_RELEASE_1 0x10 /* USB 1.0 */
	35	#define USB_RELEASE_2 0x20 /* USB 2.0 */
	36	#define USB_RELEASE_3 0x30 /* USB 3.0 */
	37
bb36d470 FB	38	#define USB_TOKEN_SETUP 0x2d
	39	#define USB_TOKEN_IN 0x69 /* device -> host */
	40	#define USB_TOKEN_OUT 0xe1 /* host -> device */
	41
d61000a8 HG	42	#define USB_RET_NODEV (-1)
	43	#define USB_RET_NAK (-2)
	44	#define USB_RET_STALL (-3)
	45	#define USB_RET_BABBLE (-4)
	46	#define USB_RET_IOERROR (-5)
	47	#define USB_RET_ASYNC (-6)
bb36d470 FB	48
	49	#define USB_SPEED_LOW 0
	50	#define USB_SPEED_FULL 1
	51	#define USB_SPEED_HIGH 2
843d4e0c GH	52	#define USB_SPEED_SUPER 3
	53
	54	#define USB_SPEED_MASK_LOW (1 << USB_SPEED_LOW)
	55	#define USB_SPEED_MASK_FULL (1 << USB_SPEED_FULL)
	56	#define USB_SPEED_MASK_HIGH (1 << USB_SPEED_HIGH)
	57	#define USB_SPEED_MASK_SUPER (1 << USB_SPEED_SUPER)
bb36d470 FB	58
	59	#define USB_STATE_NOTATTACHED 0
	60	#define USB_STATE_ATTACHED 1
	61	//#define USB_STATE_POWERED 2
	62	#define USB_STATE_DEFAULT 3
	63	//#define USB_STATE_ADDRESS 4
	64	//#define USB_STATE_CONFIGURED 5
	65	#define USB_STATE_SUSPENDED 6
	66
a594cfbf FB	67	#define USB_CLASS_AUDIO 1
	68	#define USB_CLASS_COMM 2
	69	#define USB_CLASS_HID 3
	70	#define USB_CLASS_PHYSICAL 5
	71	#define USB_CLASS_STILL_IMAGE 6
	72	#define USB_CLASS_PRINTER 7
	73	#define USB_CLASS_MASS_STORAGE 8
	74	#define USB_CLASS_HUB 9
	75	#define USB_CLASS_CDC_DATA 0x0a
	76	#define USB_CLASS_CSCID 0x0b
	77	#define USB_CLASS_CONTENT_SEC 0x0d
	78	#define USB_CLASS_APP_SPEC 0xfe
	79	#define USB_CLASS_VENDOR_SPEC 0xff
	80
b870472d PA	81	#define USB_SUBCLASS_UNDEFINED 0
	82	#define USB_SUBCLASS_AUDIO_CONTROL 1
	83	#define USB_SUBCLASS_AUDIO_STREAMING 2
	84	#define USB_SUBCLASS_AUDIO_MIDISTREAMING 3
	85
bb36d470 FB	86	#define USB_DIR_OUT 0
	87	#define USB_DIR_IN 0x80
	88
	89	#define USB_TYPE_MASK (0x03 << 5)
	90	#define USB_TYPE_STANDARD (0x00 << 5)
	91	#define USB_TYPE_CLASS (0x01 << 5)
	92	#define USB_TYPE_VENDOR (0x02 << 5)
	93	#define USB_TYPE_RESERVED (0x03 << 5)
	94
	95	#define USB_RECIP_MASK 0x1f
	96	#define USB_RECIP_DEVICE 0x00
	97	#define USB_RECIP_INTERFACE 0x01
	98	#define USB_RECIP_ENDPOINT 0x02
	99	#define USB_RECIP_OTHER 0x03
	100
	101	#define DeviceRequest ((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE)<<8)
	102	#define DeviceOutRequest ((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE)<<8)
59ae540c FB	103	#define InterfaceRequest \
	104	((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_INTERFACE)<<8)
	105	#define InterfaceOutRequest \
	106	((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_INTERFACE)<<8)
	107	#define EndpointRequest ((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_ENDPOINT)<<8)
	108	#define EndpointOutRequest \
	109	((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_ENDPOINT)<<8)
f3571b1a MR	110	#define ClassInterfaceRequest \
	111	((USB_DIR_IN\|USB_TYPE_CLASS\|USB_RECIP_INTERFACE)<<8)
	112	#define ClassInterfaceOutRequest \
	113	((USB_DIR_OUT\|USB_TYPE_CLASS\|USB_RECIP_INTERFACE)<<8)
bb36d470 FB	114
	115	#define USB_REQ_GET_STATUS 0x00
	116	#define USB_REQ_CLEAR_FEATURE 0x01
	117	#define USB_REQ_SET_FEATURE 0x03
	118	#define USB_REQ_SET_ADDRESS 0x05
	119	#define USB_REQ_GET_DESCRIPTOR 0x06
	120	#define USB_REQ_SET_DESCRIPTOR 0x07
	121	#define USB_REQ_GET_CONFIGURATION 0x08
	122	#define USB_REQ_SET_CONFIGURATION 0x09
	123	#define USB_REQ_GET_INTERFACE 0x0A
	124	#define USB_REQ_SET_INTERFACE 0x0B
	125	#define USB_REQ_SYNCH_FRAME 0x0C
	126
	127	#define USB_DEVICE_SELF_POWERED 0
	128	#define USB_DEVICE_REMOTE_WAKEUP 1
	129
	130	#define USB_DT_DEVICE 0x01
	131	#define USB_DT_CONFIG 0x02
	132	#define USB_DT_STRING 0x03
	133	#define USB_DT_INTERFACE 0x04
	134	#define USB_DT_ENDPOINT 0x05
25620cba GH	135	#define USB_DT_DEVICE_QUALIFIER 0x06
25620cba GH	136	#define USB_DT_OTHER_SPEED_CONFIG 0x07
a7fb71d1	137	#define USB_DT_DEBUG 0x0A
c6d3ad0f	138	#define USB_DT_INTERFACE_ASSOC 0x0B
b870472d PA	139	#define USB_DT_CS_INTERFACE 0x24
b870472d PA	140	#define USB_DT_CS_ENDPOINT 0x25
bb36d470	141
942ac052 AZ	142	#define USB_ENDPOINT_XFER_CONTROL 0
	143	#define USB_ENDPOINT_XFER_ISOC 1
	144	#define USB_ENDPOINT_XFER_BULK 2
	145	#define USB_ENDPOINT_XFER_INT 3
d8e17efd	146	#define USB_ENDPOINT_XFER_INVALID 255
942ac052	147
806b6024	148	typedef struct USBBus USBBus;
07771f6f	149	typedef struct USBBusOps USBBusOps;
bb36d470 FB	150	typedef struct USBPort USBPort;
bb36d470 FB	151	typedef struct USBDevice USBDevice;
4d611c9a	152	typedef struct USBPacket USBPacket;
d8e17efd	153	typedef struct USBEndpoint USBEndpoint;
bb36d470	154
37fb59d3 GH	155	typedef struct USBDesc USBDesc;
	156	typedef struct USBDescID USBDescID;
	157	typedef struct USBDescDevice USBDescDevice;
	158	typedef struct USBDescConfig USBDescConfig;
6e625fc7	159	typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
37fb59d3 GH	160	typedef struct USBDescIface USBDescIface;
	161	typedef struct USBDescEndpoint USBDescEndpoint;
	162	typedef struct USBDescOther USBDescOther;
132a3f55 GH	163	typedef struct USBDescString USBDescString;
	164
	165	struct USBDescString {
	166	uint8_t index;
	167	char *str;
	168	QLIST_ENTRY(USBDescString) next;
	169	};
37fb59d3	170
1de14d43 GH	171	#define USB_MAX_ENDPOINTS 15
	172	#define USB_MAX_INTERFACES 16
	173
d8e17efd	174	struct USBEndpoint {
63095ab5 GH	175	uint8_t nr;
63095ab5 GH	176	uint8_t pid;
d8e17efd	177	uint8_t type;
82f02fe9	178	uint8_t ifnum;
f003397c	179	int max_packet_size;
7936e0f0	180	bool pipeline;
25d5de7d	181	USBDevice *dev;
db4be873	182	QTAILQ_HEAD(, USBPacket) queue;
d8e17efd GH	183	};
d8e17efd GH	184
eeb0cf9a GH	185	enum USBDeviceFlags {
	186	USB_DEV_FLAG_FULL_PATH,
	187	};
	188
bb36d470 FB	189	/* definition of a USB device */
bb36d470 FB	190	struct USBDevice {
806b6024	191	DeviceState qdev;
618c169b	192	USBPort *port;
5f69076b	193	char *port_path;
bb36d470	194	void *opaque;
eeb0cf9a	195	uint32_t flags;
89b9b79f	196
ba3f9bfb	197	/* Actual connected speed */
806b6024	198	int speed;
ba3f9bfb HG	199	/* Supported speeds, not in info because it may be variable (hostdevs) */
ba3f9bfb HG	200	int speedmask;
806b6024	201	uint8_t addr;
0fe6d12e	202	char product_desc[32];
61e094c0	203	int auto_attach;
a5d2f727	204	int attached;
806b6024	205
c1ecb40a	206	int32_t state;
806b6024	207	uint8_t setup_buf[8];
19f33223	208	uint8_t data_buf[4096];
c1ecb40a GH	209	int32_t remote_wakeup;
	210	int32_t setup_state;
	211	int32_t setup_len;
	212	int32_t setup_index;
132a3f55	213
25d5de7d	214	USBEndpoint ep_ctl;
d8e17efd GH	215	USBEndpoint ep_in[USB_MAX_ENDPOINTS];
	216	USBEndpoint ep_out[USB_MAX_ENDPOINTS];
	217
132a3f55	218	QLIST_HEAD(, USBDescString) strings;
a980a065	219	const USBDescDevice *device;
65360511 GH	220
	221	int configuration;
	222	int ninterfaces;
1de14d43	223	int altsetting[USB_MAX_INTERFACES];
a980a065	224	const USBDescConfig *config;
1de14d43	225	const USBDescIface *ifaces[USB_MAX_INTERFACES];
806b6024 GH	226	};
806b6024 GH	227
62aed765 AL	228	#define TYPE_USB_DEVICE "usb-device"
	229	#define USB_DEVICE(obj) \
	230	OBJECT_CHECK(USBDevice, (obj), TYPE_USB_DEVICE)
	231	#define USB_DEVICE_CLASS(klass) \
	232	OBJECT_CLASS_CHECK(USBDeviceClass, (klass), TYPE_USB_DEVICE)
	233	#define USB_DEVICE_GET_CLASS(obj) \
	234	OBJECT_GET_CLASS(USBDeviceClass, (obj), TYPE_USB_DEVICE)
	235
	236	typedef struct USBDeviceClass {
	237	DeviceClass parent_class;
	238
806b6024 GH	239	int (init)(USBDevice dev);
806b6024 GH	240
73796fe6 GH	241	/*
	242	* Walk (enabled) downstream ports, check for a matching device.
	243	* Only hubs implement this.
	244	*/
	245	USBDevice (find_device)(USBDevice *dev, uint8_t addr);
	246
eb5e680a GH	247	/*
	248	* Called when a packet is canceled.
	249	*/
	250	void (cancel_packet)(USBDevice dev, USBPacket *p);
	251
806b6024	252	/*
89b9b79f AL	253	* Called when device is destroyed.
89b9b79f AL	254	*/
059809e4 FB	255	void (handle_destroy)(USBDevice dev);
059809e4 FB	256
b6f77fbe GH	257	/*
	258	* Attach the device
	259	*/
	260	void (handle_attach)(USBDevice dev);
	261
89b9b79f AL	262	/*
89b9b79f AL	263	* Reset the device
806b6024	264	*/
059809e4	265	void (handle_reset)(USBDevice dev);
89b9b79f AL	266
	267	/*
	268	* Process control request.
	269	* Called from handle_packet().
	270	*
	271	* Returns length or one of the USB_RET_ codes.
	272	*/
007fd62f	273	int (handle_control)(USBDevice dev, USBPacket *p, int request, int value,
bb36d470	274	int index, int length, uint8_t *data);
89b9b79f AL	275
	276	/*
	277	* Process data transfers (both BULK and ISOC).
	278	* Called from handle_packet().
	279	*
	280	* Returns length or one of the USB_RET_ codes.
	281	*/
4d611c9a	282	int (handle_data)(USBDevice dev, USBPacket *p);
0958b4cc	283
1de14d43 GH	284	void (set_interface)(USBDevice dev, int interface,
	285	int alt_old, int alt_new);
	286
06384698	287	const char *product_desc;
37fb59d3	288	const USBDesc *usb_desc;
62aed765	289	} USBDeviceClass;
bb36d470	290
0d86d2be	291	typedef struct USBPortOps {
618c169b GH	292	void (attach)(USBPort port);
618c169b GH	293	void (detach)(USBPort port);
4706ab6c HG	294	/*
	295	* This gets called when a device downstream from the device attached to
	296	* the port (iow attached through a hub) gets detached.
	297	*/
	298	void (child_detach)(USBPort port, USBDevice *child);
d47e59b8 HG	299	void (wakeup)(USBPort port);
	300	/*
	301	* Note that port->dev will be different then the device from which
f53c398a	302	* the packet originated when a hub is involved.
d47e59b8 HG	303	*/
d47e59b8 HG	304	void (complete)(USBPort port, USBPacket *p);
0d86d2be	305	} USBPortOps;
0d92ed30	306
bb36d470 FB	307	/* USB port on which a device can be connected */
bb36d470 FB	308	struct USBPort {
a594cfbf	309	USBDevice *dev;
843d4e0c	310	int speedmask;
c7a2196a	311	char path[16];
0d86d2be	312	USBPortOps *ops;
bb36d470 FB	313	void *opaque;
bb36d470 FB	314	int index; /* internal port index, may be used with the opaque */
72cf2d4f	315	QTAILQ_ENTRY(USBPort) next;
bb36d470 FB	316	};
bb36d470 FB	317
4d611c9a PB	318	typedef void USBCallback(USBPacket * packet, void *opaque);
4d611c9a PB	319
f53c398a GH	320	typedef enum USBPacketState {
	321	USB_PACKET_UNDEFINED = 0,
	322	USB_PACKET_SETUP,
db4be873	323	USB_PACKET_QUEUED,
f53c398a GH	324	USB_PACKET_ASYNC,
	325	USB_PACKET_COMPLETE,
	326	USB_PACKET_CANCELED,
	327	} USBPacketState;
	328
db4be873	329	/* Structure used to hold information about an active USB packet. */
4d611c9a PB	330	struct USBPacket {
	331	/* Data fields for use by the driver. */
	332	int pid;
f53c398a	333	USBEndpoint *ep;
4f4321c1	334	QEMUIOVector iov;
1b4b29a1	335	uint64_t parameter; /* control transfers */
4f4321c1	336	int result; /* transfer length or USB_RET_* status code */
4d611c9a	337	/* Internal use by the USB layer. */
f53c398a	338	USBPacketState state;
db4be873	339	QTAILQ_ENTRY(USBPacket) queue;
4d611c9a PB	340	};
4d611c9a PB	341
4f4321c1	342	void usb_packet_init(USBPacket *p);
db4be873	343	void usb_packet_set_state(USBPacket *p, USBPacketState state);
5ac2731c	344	void usb_packet_check_state(USBPacket *p, USBPacketState expected);
079d0b7f	345	void usb_packet_setup(USBPacket p, int pid, USBEndpoint ep);
4f4321c1 GH	346	void usb_packet_addbuf(USBPacket p, void ptr, size_t len);
4f4321c1 GH	347	int usb_packet_map(USBPacket p, QEMUSGList sgl);
e2f89926	348	void usb_packet_unmap(USBPacket p, QEMUSGList sgl);
4f4321c1 GH	349	void usb_packet_copy(USBPacket p, void ptr, size_t bytes);
	350	void usb_packet_skip(USBPacket *p, size_t bytes);
	351	void usb_packet_cleanup(USBPacket *p);
	352
f53c398a GH	353	static inline bool usb_packet_is_inflight(USBPacket *p)
f53c398a GH	354	{
db4be873 GH	355	return (p->state == USB_PACKET_QUEUED \|\|
db4be873 GH	356	p->state == USB_PACKET_ASYNC);
f53c398a GH	357	}
f53c398a GH	358
73796fe6 GH	359	USBDevice usb_find_device(USBPort port, uint8_t addr);
73796fe6 GH	360
53aa8c0e	361	int usb_handle_packet(USBDevice dev, USBPacket p);
4ff658fb GH	362	void usb_packet_complete(USBDevice dev, USBPacket p);
4ff658fb GH	363	void usb_cancel_packet(USBPacket * p);
53aa8c0e	364
d8e17efd	365	void usb_ep_init(USBDevice *dev);
5b6780d0	366	void usb_ep_dump(USBDevice *dev);
d8e17efd GH	367	struct USBEndpoint usb_ep_get(USBDevice dev, int pid, int ep);
d8e17efd GH	368	uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
82f02fe9	369	uint8_t usb_ep_get_ifnum(USBDevice *dev, int pid, int ep);
d8e17efd	370	void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
82f02fe9	371	void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);
f003397c GH	372	void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
	373	uint16_t raw);
	374	int usb_ep_get_max_packet_size(USBDevice *dev, int pid, int ep);
7936e0f0	375	void usb_ep_set_pipeline(USBDevice *dev, int pid, int ep, bool enabled);
d8e17efd	376
891fb2cd GH	377	void usb_attach(USBPort *port);
891fb2cd GH	378	void usb_detach(USBPort *port);
d28f4e2d GH	379	void usb_port_reset(USBPort *port);
d28f4e2d GH	380	void usb_device_reset(USBDevice *dev);
7567b51f	381	void usb_wakeup(USBEndpoint *ep);
50b7963e	382	void usb_generic_async_ctrl_complete(USBDevice s, USBPacket p);
bb36d470	383	int set_usb_string(uint8_t buf, const char str);
4d611c9a	384
bb36d470	385	/* usb-linux.c */
3741715c	386	USBDevice usb_host_device_open(USBBus bus, const char *devname);
5d0c5750	387	int usb_host_device_close(const char *devname);
376253ec	388	void usb_host_info(Monitor *mon);
59ae540c	389
e6a6d5ab	390	/* usb-bt.c */
3741715c	391	USBDevice usb_bt_init(USBBus bus, HCIInfo *hci);
e6a6d5ab	392
87ecb68b PB	393	/* usb ports of the VM */
87ecb68b PB	394
87ecb68b PB	395	#define VM_USB_HUB_SIZE 8
87ecb68b PB	396
942ac052 AZ	397	/* usb-musb.c */
	398	enum musb_irq_source_e {
	399	musb_irq_suspend = 0,
	400	musb_irq_resume,
	401	musb_irq_rst_babble,
	402	musb_irq_sof,
	403	musb_irq_connect,
	404	musb_irq_disconnect,
	405	musb_irq_vbus_request,
	406	musb_irq_vbus_error,
	407	musb_irq_rx,
	408	musb_irq_tx,
	409	musb_set_vbus,
	410	musb_set_session,
9147b752 PM	411	/* Add new interrupts here */
9147b752 PM	412	musb_irq_max, /* total number of interrupts defined */
942ac052 AZ	413	};
942ac052 AZ	414
bc24a225	415	typedef struct MUSBState MUSBState;
406c2075	416	MUSBState musb_init(DeviceState parent_device, int gpio_base);
5b1cdb4e	417	void musb_reset(MUSBState *s);
bc24a225 PB	418	uint32_t musb_core_intr_get(MUSBState *s);
	419	void musb_core_intr_clear(MUSBState *s, uint32_t mask);
	420	void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
806b6024 GH	421
	422	/* usb-bus.c */
	423
0d936928 AL	424	#define TYPE_USB_BUS "usb-bus"
	425	#define USB_BUS(obj) OBJECT_CHECK(USBBus, (obj), TYPE_USB_BUS)
	426
806b6024 GH	427	struct USBBus {
806b6024 GH	428	BusState qbus;
07771f6f	429	USBBusOps *ops;
806b6024 GH	430	int busnr;
	431	int nfree;
	432	int nused;
72cf2d4f BS	433	QTAILQ_HEAD(, USBPort) free;
	434	QTAILQ_HEAD(, USBPort) used;
	435	QTAILQ_ENTRY(USBBus) next;
806b6024 GH	436	};
806b6024 GH	437
07771f6f	438	struct USBBusOps {
ae60fea9 HG	439	int (register_companion)(USBBus bus, USBPort *ports[],
ae60fea9 HG	440	uint32_t portcount, uint32_t firstport);
37f32f0f	441	void (wakeup_endpoint)(USBBus bus, USBEndpoint *ep);
07771f6f GH	442	};
	443
	444	void usb_bus_new(USBBus bus, USBBusOps ops, DeviceState *host);
806b6024	445	USBBus *usb_bus_find(int busnr);
ba02430f	446	void usb_legacy_register(const char typename, const char usbdevice_name,
3741715c JK	447	USBDevice (usbdevice_init)(USBBus *bus,
3741715c JK	448	const char *params));
a5d2f727	449	USBDevice usb_create(USBBus bus, const char *name);
806b6024	450	USBDevice usb_create_simple(USBBus bus, const char *name);
0958b4cc	451	USBDevice usbdevice_create(const char cmdline);
a5d2f727	452	void usb_register_port(USBBus bus, USBPort port, void *opaque, int index,
ace1318b	453	USBPortOps *ops, int speedmask);
ae60fea9 HG	454	int usb_register_companion(const char masterbus, USBPort ports[],
	455	uint32_t portcount, uint32_t firstport,
	456	void opaque, USBPortOps ops, int speedmask);
c7a2196a	457	void usb_port_location(USBPort downstream, USBPort upstream, int portnr);
a8e662b5	458	void usb_unregister_port(USBBus bus, USBPort port);
891fb2cd GH	459	int usb_claim_port(USBDevice *dev);
891fb2cd GH	460	void usb_release_port(USBDevice *dev);
a5d2f727	461	int usb_device_attach(USBDevice *dev);
a8e662b5	462	int usb_device_detach(USBDevice *dev);
a5d2f727 GH	463	int usb_device_delete_addr(int busnr, int addr);
	464
	465	static inline USBBus usb_bus_from_device(USBDevice d)
	466	{
	467	return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
	468	}
701a8f76 PB	469
	470	extern const VMStateDescription vmstate_usb_device;
	471
	472	#define VMSTATE_USB_DEVICE(_field, _state) { \
	473	.name = (stringify(_field)), \
	474	.size = sizeof(USBDevice), \
	475	.vmsd = &vmstate_usb_device, \
	476	.flags = VMS_STRUCT, \
	477	.offset = vmstate_offset_value(_state, _field, USBDevice), \
	478	}
	479
73796fe6 GH	480	USBDevice usb_device_find_device(USBDevice dev, uint8_t addr);
73796fe6 GH	481
62aed765 AL	482	void usb_device_cancel_packet(USBDevice dev, USBPacket p);
	483
	484	void usb_device_handle_attach(USBDevice *dev);
	485
	486	void usb_device_handle_reset(USBDevice *dev);
	487
	488	int usb_device_handle_control(USBDevice dev, USBPacket p, int request, int value,
	489	int index, int length, uint8_t *data);
	490
	491	int usb_device_handle_data(USBDevice dev, USBPacket p);
	492
	493	void usb_device_set_interface(USBDevice *dev, int interface,
	494	int alt_old, int alt_new);
	495
	496	const char usb_device_get_product_desc(USBDevice dev);
	497
	498	const USBDesc usb_device_get_usb_desc(USBDevice dev);
	499
	500	#endif
701a8f76	501