[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 "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_RET_ADD_TO_QUEUE      (-7)
#define USB_RET_REMOVE_FROM_QUEUE (-8)

#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_BOS                      0x0F
#define USB_DT_DEVICE_CAPABILITY        0x10
#define USB_DT_CS_INTERFACE             0x24
#define USB_DT_CS_ENDPOINT              0x25
#define USB_DT_ENDPOINT_COMPANION       0x30

#define USB_DEV_CAP_WIRELESS            0x01
#define USB_DEV_CAP_USB2_EXT            0x02
#define USB_DEV_CAP_SUPERSPEED          0x03

#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

#define USB_INTERFACE_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;
    bool halted;
    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);

    /*
     * Called when the hcd is done queuing packets for an endpoint, only
     * necessary for devices which can return USB_RET_ADD_TO_QUEUE.
     */
    void (*flush_ep_queue)(USBDevice *dev, USBEndpoint *ep);

    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;
    uint64_t id;
    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, uint64_t id);
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_packet_complete_one(USBDevice *dev, USBPacket *p);
void usb_cancel_packet(USBPacket * p);

void usb_ep_init(USBDevice *dev);
void usb_ep_reset(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);
USBPacket *usb_ep_find_packet_by_id(USBDevice *dev, int pid, int ep,
                                    uint64_t id);

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

void usb_device_flush_ep_queue(USBDevice *dev, USBEndpoint *ep);

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