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

#ifndef QEMU_HW_USB_DESC_H
#define QEMU_HW_USB_DESC_H

#include <inttypes.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;
    } 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;
};

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

typedef const char *USBDescStrings[256];

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

/* generate usb packages from structs */
int usb_desc_device(const USBDescID *id, const USBDescDevice *dev,
                    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, uint8_t *dest, size_t len);
int usb_desc_iface_group(const USBDescIfaceAssoc *iad, uint8_t *dest,
                         size_t len);
int usb_desc_iface(const USBDescIface *iface, uint8_t *dest, size_t len);
int usb_desc_endpoint(const USBDescEndpoint *ep, uint8_t *dest, size_t len);
int usb_desc_other(const USBDescOther *desc, 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, 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>
	5
d3f904ea GH	6	/* binary representation */
	7	typedef struct USBDescriptor {
	8	uint8_t bLength;
	9	uint8_t bDescriptorType;
	10	union {
	11	struct {
	12	uint8_t bcdUSB_lo;
	13	uint8_t bcdUSB_hi;
	14	uint8_t bDeviceClass;
	15	uint8_t bDeviceSubClass;
	16	uint8_t bDeviceProtocol;
	17	uint8_t bMaxPacketSize0;
	18	uint8_t idVendor_lo;
	19	uint8_t idVendor_hi;
	20	uint8_t idProduct_lo;
	21	uint8_t idProduct_hi;
	22	uint8_t bcdDevice_lo;
	23	uint8_t bcdDevice_hi;
	24	uint8_t iManufacturer;
	25	uint8_t iProduct;
	26	uint8_t iSerialNumber;
	27	uint8_t bNumConfigurations;
	28	} device;
3cfeee61 GH	29	struct {
	30	uint8_t bcdUSB_lo;
	31	uint8_t bcdUSB_hi;
	32	uint8_t bDeviceClass;
	33	uint8_t bDeviceSubClass;
	34	uint8_t bDeviceProtocol;
	35	uint8_t bMaxPacketSize0;
	36	uint8_t bNumConfigurations;
	37	uint8_t bReserved;
	38	} device_qualifier;
0a263db1 GH	39	struct {
	40	uint8_t wTotalLength_lo;
	41	uint8_t wTotalLength_hi;
	42	uint8_t bNumInterfaces;
	43	uint8_t bConfigurationValue;
	44	uint8_t iConfiguration;
	45	uint8_t bmAttributes;
	46	uint8_t bMaxPower;
	47	} config;
feafd797 GH	48	struct {
	49	uint8_t bInterfaceNumber;
	50	uint8_t bAlternateSetting;
	51	uint8_t bNumEndpoints;
	52	uint8_t bInterfaceClass;
	53	uint8_t bInterfaceSubClass;
	54	uint8_t bInterfaceProtocol;
	55	uint8_t iInterface;
	56	} interface;
e36a20d3 GH	57	struct {
	58	uint8_t bEndpointAddress;
	59	uint8_t bmAttributes;
	60	uint8_t wMaxPacketSize_lo;
	61	uint8_t wMaxPacketSize_hi;
	62	uint8_t bInterval;
	63	uint8_t bRefresh; /* only audio ep */
	64	uint8_t bSynchAddress; /* only audio ep */
	65	} endpoint;
d3f904ea GH	66	} u;
	67	} QEMU_PACKED USBDescriptor;
	68
37fb59d3 GH	69	struct USBDescID {
	70	uint16_t idVendor;
	71	uint16_t idProduct;
	72	uint16_t bcdDevice;
	73	uint8_t iManufacturer;
	74	uint8_t iProduct;
	75	uint8_t iSerialNumber;
	76	};
	77
	78	struct USBDescDevice {
	79	uint16_t bcdUSB;
	80	uint8_t bDeviceClass;
	81	uint8_t bDeviceSubClass;
	82	uint8_t bDeviceProtocol;
	83	uint8_t bMaxPacketSize0;
	84	uint8_t bNumConfigurations;
	85
	86	const USBDescConfig *confs;
	87	};
	88
	89	struct USBDescConfig {
	90	uint8_t bNumInterfaces;
	91	uint8_t bConfigurationValue;
	92	uint8_t iConfiguration;
	93	uint8_t bmAttributes;
	94	uint8_t bMaxPower;
	95
6e625fc7 BH	96	/* grouped interfaces */
	97	uint8_t nif_groups;
	98	const USBDescIfaceAssoc *if_groups;
	99
	100	/* "normal" interfaces */
	101	uint8_t nif;
	102	const USBDescIface *ifs;
	103	};
	104
	105	/* conceptually an Interface Association Descriptor, and releated interfaces */
	106	struct USBDescIfaceAssoc {
	107	uint8_t bFirstInterface;
	108	uint8_t bInterfaceCount;
	109	uint8_t bFunctionClass;
	110	uint8_t bFunctionSubClass;
	111	uint8_t bFunctionProtocol;
	112	uint8_t iFunction;
	113
37fb59d3 GH	114	uint8_t nif;
	115	const USBDescIface *ifs;
	116	};
	117
	118	struct USBDescIface {
	119	uint8_t bInterfaceNumber;
	120	uint8_t bAlternateSetting;
	121	uint8_t bNumEndpoints;
	122	uint8_t bInterfaceClass;
	123	uint8_t bInterfaceSubClass;
	124	uint8_t bInterfaceProtocol;
	125	uint8_t iInterface;
	126
	127	uint8_t ndesc;
	128	USBDescOther *descs;
	129	USBDescEndpoint *eps;
	130	};
	131
	132	struct USBDescEndpoint {
	133	uint8_t bEndpointAddress;
	134	uint8_t bmAttributes;
	135	uint16_t wMaxPacketSize;
	136	uint8_t bInterval;
cc5f1395 GH	137	uint8_t bRefresh;
	138	uint8_t bSynchAddress;
	139
	140	uint8_t is_audio; /* has bRefresh + bSynchAddress */
	141	uint8_t *extra;
37fb59d3 GH	142	};
	143
	144	struct USBDescOther {
	145	uint8_t length;
97237e0a	146	const uint8_t *data;
37fb59d3 GH	147	};
	148
	149	typedef const char *USBDescStrings[256];
	150
	151	struct USBDesc {
	152	USBDescID id;
	153	const USBDescDevice *full;
	154	const USBDescDevice *high;
6d51b2bb	155	const USBDescDevice *super;
37fb59d3 GH	156	const char* const *str;
	157	};
	158
	159	/* generate usb packages from structs */
	160	int usb_desc_device(const USBDescID id, const USBDescDevice dev,
	161	uint8_t *dest, size_t len);
25620cba GH	162	int usb_desc_device_qualifier(const USBDescDevice *dev,
25620cba GH	163	uint8_t *dest, size_t len);
37fb59d3	164	int usb_desc_config(const USBDescConfig conf, uint8_t dest, size_t len);
6e625fc7 BH	165	int usb_desc_iface_group(const USBDescIfaceAssoc iad, uint8_t dest,
6e625fc7 BH	166	size_t len);
37fb59d3 GH	167	int usb_desc_iface(const USBDescIface iface, uint8_t dest, size_t len);
	168	int usb_desc_endpoint(const USBDescEndpoint ep, uint8_t dest, size_t len);
	169	int usb_desc_other(const USBDescOther desc, uint8_t dest, size_t len);
37fb59d3 GH	170
37fb59d3 GH	171	/* control message emulation helpers */
a980a065	172	void usb_desc_init(USBDevice *dev);
32d41919	173	void usb_desc_attach(USBDevice *dev);
132a3f55	174	void usb_desc_set_string(USBDevice dev, uint8_t index, const char str);
9d55d1ad	175	void usb_desc_create_serial(USBDevice *dev);
132a3f55 GH	176	const char usb_desc_get_string(USBDevice dev, uint8_t index);
132a3f55 GH	177	int usb_desc_string(USBDevice dev, int index, uint8_t dest, size_t len);
37fb59d3	178	int usb_desc_get_descriptor(USBDevice dev, int value, uint8_t dest, size_t len);
007fd62f HG	179	int usb_desc_handle_control(USBDevice dev, USBPacket p,
007fd62f HG	180	int request, int value, int index, int length, uint8_t *data);
37fb59d3 GH	181
37fb59d3 GH	182	#endif /* QEMU_HW_USB_DESC_H */