[qemu.git] / hw / usb / desc.h

#ifndef QEMU_HW_USB_DESC_H
#define QEMU_HW_USB_DESC_H

#include <inttypes.h>
#include <wchar.h>

/* binary representation */
typedef struct USBDescriptor {
    uint8_t                   bLength;
    uint8_t                   bDescriptorType;
    union {
        struct {
            uint8_t           bcdUSB_lo;
            uint8_t           bcdUSB_hi;
            uint8_t           bDeviceClass;
            uint8_t           bDeviceSubClass;
            uint8_t           bDeviceProtocol;
            uint8_t           bMaxPacketSize0;
            uint8_t           idVendor_lo;
            uint8_t           idVendor_hi;
            uint8_t           idProduct_lo;
            uint8_t           idProduct_hi;
            uint8_t           bcdDevice_lo;
            uint8_t           bcdDevice_hi;
            uint8_t           iManufacturer;
            uint8_t           iProduct;
            uint8_t           iSerialNumber;
            uint8_t           bNumConfigurations;
        } device;
        struct {
            uint8_t           bcdUSB_lo;
            uint8_t           bcdUSB_hi;
            uint8_t           bDeviceClass;
            uint8_t           bDeviceSubClass;
            uint8_t           bDeviceProtocol;
            uint8_t           bMaxPacketSize0;
            uint8_t           bNumConfigurations;
            uint8_t           bReserved;
        } device_qualifier;
        struct {
            uint8_t           wTotalLength_lo;
            uint8_t           wTotalLength_hi;
            uint8_t           bNumInterfaces;
            uint8_t           bConfigurationValue;
            uint8_t           iConfiguration;
            uint8_t           bmAttributes;
            uint8_t           bMaxPower;
        } config;
        struct {
            uint8_t           bInterfaceNumber;
            uint8_t           bAlternateSetting;
            uint8_t           bNumEndpoints;
            uint8_t           bInterfaceClass;
            uint8_t           bInterfaceSubClass;
            uint8_t           bInterfaceProtocol;
            uint8_t           iInterface;
        } interface;
        struct {
            uint8_t           bEndpointAddress;
            uint8_t           bmAttributes;
            uint8_t           wMaxPacketSize_lo;
            uint8_t           wMaxPacketSize_hi;
            uint8_t           bInterval;
            uint8_t           bRefresh;        /* only audio ep */
            uint8_t           bSynchAddress;   /* only audio ep */
        } endpoint;
        struct {
            uint8_t           bMaxBurst;
            uint8_t           bmAttributes;
            uint8_t           wBytesPerInterval_lo;
            uint8_t           wBytesPerInterval_hi;
        } super_endpoint;
        struct {
            uint8_t           wTotalLength_lo;
            uint8_t           wTotalLength_hi;
            uint8_t           bNumDeviceCaps;
        } bos;
        struct {
            uint8_t           bDevCapabilityType;
            union {
                struct {
                    uint8_t   bmAttributes_1;
                    uint8_t   bmAttributes_2;
                    uint8_t   bmAttributes_3;
                    uint8_t   bmAttributes_4;
                } usb2_ext;
                struct {
                    uint8_t   bmAttributes;
                    uint8_t   wSpeedsSupported_lo;
                    uint8_t   wSpeedsSupported_hi;
                    uint8_t   bFunctionalitySupport;
                    uint8_t   bU1DevExitLat;
                    uint8_t   wU2DevExitLat_lo;
                    uint8_t   wU2DevExitLat_hi;
                } super;
            } u;
        } cap;
    } u;
} QEMU_PACKED USBDescriptor;

struct USBDescID {
    uint16_t                  idVendor;
    uint16_t                  idProduct;
    uint16_t                  bcdDevice;
    uint8_t                   iManufacturer;
    uint8_t                   iProduct;
    uint8_t                   iSerialNumber;
};

struct USBDescDevice {
    uint16_t                  bcdUSB;
    uint8_t                   bDeviceClass;
    uint8_t                   bDeviceSubClass;
    uint8_t                   bDeviceProtocol;
    uint8_t                   bMaxPacketSize0;
    uint8_t                   bNumConfigurations;

    const USBDescConfig       *confs;
};

struct USBDescConfig {
    uint8_t                   bNumInterfaces;
    uint8_t                   bConfigurationValue;
    uint8_t                   iConfiguration;
    uint8_t                   bmAttributes;
    uint8_t                   bMaxPower;

    /* grouped interfaces */
    uint8_t                   nif_groups;
    const USBDescIfaceAssoc   *if_groups;

    /* "normal" interfaces */
    uint8_t                   nif;
    const USBDescIface        *ifs;
};

/* conceptually an Interface Association Descriptor, and releated interfaces */
struct USBDescIfaceAssoc {
    uint8_t                   bFirstInterface;
    uint8_t                   bInterfaceCount;
    uint8_t                   bFunctionClass;
    uint8_t                   bFunctionSubClass;
    uint8_t                   bFunctionProtocol;
    uint8_t                   iFunction;

    uint8_t                   nif;
    const USBDescIface        *ifs;
};

struct USBDescIface {
    uint8_t                   bInterfaceNumber;
    uint8_t                   bAlternateSetting;
    uint8_t                   bNumEndpoints;
    uint8_t                   bInterfaceClass;
    uint8_t                   bInterfaceSubClass;
    uint8_t                   bInterfaceProtocol;
    uint8_t                   iInterface;

    uint8_t                   ndesc;
    USBDescOther              *descs;
    USBDescEndpoint           *eps;
};

struct USBDescEndpoint {
    uint8_t                   bEndpointAddress;
    uint8_t                   bmAttributes;
    uint16_t                  wMaxPacketSize;
    uint8_t                   bInterval;
    uint8_t                   bRefresh;
    uint8_t                   bSynchAddress;

    uint8_t                   is_audio; /* has bRefresh + bSynchAddress */
    uint8_t                   *extra;

    /* superspeed endpoint companion */
    uint8_t                   bMaxBurst;
    uint8_t                   bmAttributes_super;
    uint16_t                  wBytesPerInterval;
};

struct USBDescOther {
    uint8_t                   length;
    const uint8_t             *data;
};

struct USBDescMSOS {
    const wchar_t             *Label;
    bool                      SelectiveSuspendEnabled;
};

typedef const char *USBDescStrings[256];

struct USBDesc {
    USBDescID                 id;
    const USBDescDevice       *full;
    const USBDescDevice       *high;
    const USBDescDevice       *super;
    const char* const         *str;
    const USBDescMSOS         *msos;
};

#define USB_DESC_FLAG_SUPER (1 << 1)

/* little helpers */
static inline uint8_t usb_lo(uint16_t val)
{
    return val & 0xff;
}

static inline uint8_t usb_hi(uint16_t val)
{
    return (val >> 8) & 0xff;
}

/* generate usb packages from structs */
int usb_desc_device(const USBDescID *id, const USBDescDevice *dev,
                    bool msos, uint8_t *dest, size_t len);
int usb_desc_device_qualifier(const USBDescDevice *dev,
                              uint8_t *dest, size_t len);
int usb_desc_config(const USBDescConfig *conf, int flags,
                    uint8_t *dest, size_t len);
int usb_desc_iface_group(const USBDescIfaceAssoc *iad, int flags,
                         uint8_t *dest, size_t len);
int usb_desc_iface(const USBDescIface *iface, int flags,
                   uint8_t *dest, size_t len);
int usb_desc_endpoint(const USBDescEndpoint *ep, int flags,
                      uint8_t *dest, size_t len);
int usb_desc_other(const USBDescOther *desc, uint8_t *dest, size_t len);
int usb_desc_msos(const USBDesc *desc, USBPacket *p,
                  int index, uint8_t *dest, size_t len);

/* control message emulation helpers */
void usb_desc_init(USBDevice *dev);
void usb_desc_attach(USBDevice *dev);
void usb_desc_set_string(USBDevice *dev, uint8_t index, const char *str);
void usb_desc_create_serial(USBDevice *dev);
const char *usb_desc_get_string(USBDevice *dev, uint8_t index);
int usb_desc_string(USBDevice *dev, int index, uint8_t *dest, size_t len);
int usb_desc_get_descriptor(USBDevice *dev, USBPacket *p,
        int value, uint8_t *dest, size_t len);
int usb_desc_handle_control(USBDevice *dev, USBPacket *p,
        int request, int value, int index, int length, uint8_t *data);

#endif /* QEMU_HW_USB_DESC_H */
Commit	Line	Data
37fb59d3 GH	1	#ifndef QEMU_HW_USB_DESC_H
	2	#define QEMU_HW_USB_DESC_H
	3
	4	#include <inttypes.h>
5319dc7b	5	#include <wchar.h>
37fb59d3	6
d3f904ea GH	7	/* binary representation */
	8	typedef struct USBDescriptor {
	9	uint8_t bLength;
	10	uint8_t bDescriptorType;
	11	union {
	12	struct {
	13	uint8_t bcdUSB_lo;
	14	uint8_t bcdUSB_hi;
	15	uint8_t bDeviceClass;
	16	uint8_t bDeviceSubClass;
	17	uint8_t bDeviceProtocol;
	18	uint8_t bMaxPacketSize0;
	19	uint8_t idVendor_lo;
	20	uint8_t idVendor_hi;
	21	uint8_t idProduct_lo;
	22	uint8_t idProduct_hi;
	23	uint8_t bcdDevice_lo;
	24	uint8_t bcdDevice_hi;
	25	uint8_t iManufacturer;
	26	uint8_t iProduct;
	27	uint8_t iSerialNumber;
	28	uint8_t bNumConfigurations;
	29	} device;
3cfeee61 GH	30	struct {
	31	uint8_t bcdUSB_lo;
	32	uint8_t bcdUSB_hi;
	33	uint8_t bDeviceClass;
	34	uint8_t bDeviceSubClass;
	35	uint8_t bDeviceProtocol;
	36	uint8_t bMaxPacketSize0;
	37	uint8_t bNumConfigurations;
	38	uint8_t bReserved;
	39	} device_qualifier;
0a263db1 GH	40	struct {
	41	uint8_t wTotalLength_lo;
	42	uint8_t wTotalLength_hi;
	43	uint8_t bNumInterfaces;
	44	uint8_t bConfigurationValue;
	45	uint8_t iConfiguration;
	46	uint8_t bmAttributes;
	47	uint8_t bMaxPower;
	48	} config;
feafd797 GH	49	struct {
	50	uint8_t bInterfaceNumber;
	51	uint8_t bAlternateSetting;
	52	uint8_t bNumEndpoints;
	53	uint8_t bInterfaceClass;
	54	uint8_t bInterfaceSubClass;
	55	uint8_t bInterfaceProtocol;
	56	uint8_t iInterface;
	57	} interface;
e36a20d3 GH	58	struct {
	59	uint8_t bEndpointAddress;
	60	uint8_t bmAttributes;
	61	uint8_t wMaxPacketSize_lo;
	62	uint8_t wMaxPacketSize_hi;
	63	uint8_t bInterval;
	64	uint8_t bRefresh; /* only audio ep */
	65	uint8_t bSynchAddress; /* only audio ep */
	66	} endpoint;
b43a2851 GH	67	struct {
	68	uint8_t bMaxBurst;
	69	uint8_t bmAttributes;
	70	uint8_t wBytesPerInterval_lo;
	71	uint8_t wBytesPerInterval_hi;
	72	} super_endpoint;
2077469b GH	73	struct {
	74	uint8_t wTotalLength_lo;
	75	uint8_t wTotalLength_hi;
	76	uint8_t bNumDeviceCaps;
	77	} bos;
	78	struct {
	79	uint8_t bDevCapabilityType;
	80	union {
	81	struct {
	82	uint8_t bmAttributes_1;
	83	uint8_t bmAttributes_2;
	84	uint8_t bmAttributes_3;
	85	uint8_t bmAttributes_4;
	86	} usb2_ext;
	87	struct {
	88	uint8_t bmAttributes;
	89	uint8_t wSpeedsSupported_lo;
	90	uint8_t wSpeedsSupported_hi;
	91	uint8_t bFunctionalitySupport;
	92	uint8_t bU1DevExitLat;
	93	uint8_t wU2DevExitLat_lo;
	94	uint8_t wU2DevExitLat_hi;
	95	} super;
	96	} u;
	97	} cap;
d3f904ea GH	98	} u;
	99	} QEMU_PACKED USBDescriptor;
	100
37fb59d3 GH	101	struct USBDescID {
	102	uint16_t idVendor;
	103	uint16_t idProduct;
	104	uint16_t bcdDevice;
	105	uint8_t iManufacturer;
	106	uint8_t iProduct;
	107	uint8_t iSerialNumber;
	108	};
	109
	110	struct USBDescDevice {
	111	uint16_t bcdUSB;
	112	uint8_t bDeviceClass;
	113	uint8_t bDeviceSubClass;
	114	uint8_t bDeviceProtocol;
	115	uint8_t bMaxPacketSize0;
	116	uint8_t bNumConfigurations;
	117
	118	const USBDescConfig *confs;
	119	};
	120
	121	struct USBDescConfig {
	122	uint8_t bNumInterfaces;
	123	uint8_t bConfigurationValue;
	124	uint8_t iConfiguration;
	125	uint8_t bmAttributes;
	126	uint8_t bMaxPower;
	127
6e625fc7 BH	128	/* grouped interfaces */
	129	uint8_t nif_groups;
	130	const USBDescIfaceAssoc *if_groups;
	131
	132	/* "normal" interfaces */
	133	uint8_t nif;
	134	const USBDescIface *ifs;
	135	};
	136
	137	/* conceptually an Interface Association Descriptor, and releated interfaces */
	138	struct USBDescIfaceAssoc {
	139	uint8_t bFirstInterface;
	140	uint8_t bInterfaceCount;
	141	uint8_t bFunctionClass;
	142	uint8_t bFunctionSubClass;
	143	uint8_t bFunctionProtocol;
	144	uint8_t iFunction;
	145
37fb59d3 GH	146	uint8_t nif;
	147	const USBDescIface *ifs;
	148	};
	149
	150	struct USBDescIface {
	151	uint8_t bInterfaceNumber;
	152	uint8_t bAlternateSetting;
	153	uint8_t bNumEndpoints;
	154	uint8_t bInterfaceClass;
	155	uint8_t bInterfaceSubClass;
	156	uint8_t bInterfaceProtocol;
	157	uint8_t iInterface;
	158
	159	uint8_t ndesc;
	160	USBDescOther *descs;
	161	USBDescEndpoint *eps;
	162	};
	163
	164	struct USBDescEndpoint {
	165	uint8_t bEndpointAddress;
	166	uint8_t bmAttributes;
	167	uint16_t wMaxPacketSize;
	168	uint8_t bInterval;
cc5f1395 GH	169	uint8_t bRefresh;
	170	uint8_t bSynchAddress;
	171
	172	uint8_t is_audio; /* has bRefresh + bSynchAddress */
	173	uint8_t *extra;
b43a2851 GH	174
	175	/* superspeed endpoint companion */
	176	uint8_t bMaxBurst;
	177	uint8_t bmAttributes_super;
	178	uint16_t wBytesPerInterval;
37fb59d3 GH	179	};
	180
	181	struct USBDescOther {
	182	uint8_t length;
97237e0a	183	const uint8_t *data;
37fb59d3 GH	184	};
37fb59d3 GH	185
5319dc7b GH	186	struct USBDescMSOS {
	187	const wchar_t *Label;
	188	bool SelectiveSuspendEnabled;
	189	};
	190
37fb59d3 GH	191	typedef const char *USBDescStrings[256];
	192
	193	struct USBDesc {
	194	USBDescID id;
	195	const USBDescDevice *full;
	196	const USBDescDevice *high;
6d51b2bb	197	const USBDescDevice *super;
37fb59d3	198	const char* const *str;
5319dc7b	199	const USBDescMSOS *msos;
37fb59d3 GH	200	};
37fb59d3 GH	201
b43a2851 GH	202	#define USB_DESC_FLAG_SUPER (1 << 1)
b43a2851 GH	203
0b1fa34e GH	204	/* little helpers */
	205	static inline uint8_t usb_lo(uint16_t val)
	206	{
	207	return val & 0xff;
	208	}
	209
	210	static inline uint8_t usb_hi(uint16_t val)
	211	{
	212	return (val >> 8) & 0xff;
	213	}
	214
37fb59d3 GH	215	/* generate usb packages from structs */
37fb59d3 GH	216	int usb_desc_device(const USBDescID id, const USBDescDevice dev,
5319dc7b	217	bool msos, uint8_t *dest, size_t len);
25620cba GH	218	int usb_desc_device_qualifier(const USBDescDevice *dev,
25620cba GH	219	uint8_t *dest, size_t len);
b43a2851 GH	220	int usb_desc_config(const USBDescConfig *conf, int flags,
	221	uint8_t *dest, size_t len);
	222	int usb_desc_iface_group(const USBDescIfaceAssoc *iad, int flags,
	223	uint8_t *dest, size_t len);
	224	int usb_desc_iface(const USBDescIface *iface, int flags,
	225	uint8_t *dest, size_t len);
	226	int usb_desc_endpoint(const USBDescEndpoint *ep, int flags,
	227	uint8_t *dest, size_t len);
37fb59d3	228	int usb_desc_other(const USBDescOther desc, uint8_t dest, size_t len);
5319dc7b GH	229	int usb_desc_msos(const USBDesc desc, USBPacket p,
5319dc7b GH	230	int index, uint8_t *dest, size_t len);
37fb59d3 GH	231
37fb59d3 GH	232	/* control message emulation helpers */
a980a065	233	void usb_desc_init(USBDevice *dev);
32d41919	234	void usb_desc_attach(USBDevice *dev);
132a3f55	235	void usb_desc_set_string(USBDevice dev, uint8_t index, const char str);
9d55d1ad	236	void usb_desc_create_serial(USBDevice *dev);
132a3f55 GH	237	const char usb_desc_get_string(USBDevice dev, uint8_t index);
132a3f55 GH	238	int usb_desc_string(USBDevice dev, int index, uint8_t dest, size_t len);
9a77a0f5 HG	239	int usb_desc_get_descriptor(USBDevice dev, USBPacket p,
9a77a0f5 HG	240	int value, uint8_t *dest, size_t len);
007fd62f HG	241	int usb_desc_handle_control(USBDevice dev, USBPacket p,
007fd62f HG	242	int request, int value, int index, int length, uint8_t *data);
37fb59d3 GH	243
37fb59d3 GH	244	#endif /* QEMU_HW_USB_DESC_H */