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

#ifndef QEMU_HW_USB_DESC_H
#define QEMU_HW_USB_DESC_H

#include <inttypes.h>

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;

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

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

typedef const char *USBDescStrings[256];

struct USBDesc {
    USBDescID                 id;
    const USBDescDevice       *full;
    const USBDescDevice       *high;
    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_config(const USBDescConfig *conf, 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);
int usb_desc_string(const char* const *str, int index, uint8_t *dest, size_t len);

/* control message emulation helpers */
int usb_desc_get_descriptor(USBDevice *dev, int value, uint8_t *dest, size_t len);
int usb_desc_handle_control(USBDevice *dev, 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
	6	struct USBDescID {
	7	uint16_t idVendor;
	8	uint16_t idProduct;
	9	uint16_t bcdDevice;
	10	uint8_t iManufacturer;
	11	uint8_t iProduct;
	12	uint8_t iSerialNumber;
	13	};
	14
	15	struct USBDescDevice {
	16	uint16_t bcdUSB;
	17	uint8_t bDeviceClass;
	18	uint8_t bDeviceSubClass;
	19	uint8_t bDeviceProtocol;
	20	uint8_t bMaxPacketSize0;
	21	uint8_t bNumConfigurations;
	22
	23	const USBDescConfig *confs;
	24	};
	25
	26	struct USBDescConfig {
	27	uint8_t bNumInterfaces;
	28	uint8_t bConfigurationValue;
	29	uint8_t iConfiguration;
	30	uint8_t bmAttributes;
	31	uint8_t bMaxPower;
	32
	33	uint8_t nif;
	34	const USBDescIface *ifs;
	35	};
	36
	37	struct USBDescIface {
	38	uint8_t bInterfaceNumber;
	39	uint8_t bAlternateSetting;
	40	uint8_t bNumEndpoints;
	41	uint8_t bInterfaceClass;
	42	uint8_t bInterfaceSubClass;
	43	uint8_t bInterfaceProtocol;
	44	uint8_t iInterface;
	45
	46	uint8_t ndesc;
	47	USBDescOther *descs;
	48	USBDescEndpoint *eps;
	49	};
	50
	51	struct USBDescEndpoint {
	52	uint8_t bEndpointAddress;
	53	uint8_t bmAttributes;
	54	uint16_t wMaxPacketSize;
	55	uint8_t bInterval;
	56	};
	57
	58	struct USBDescOther {
	59	uint8_t length;
	60	uint8_t *data;
	61	};
	62
	63	typedef const char *USBDescStrings[256];
	64
65	struct USBDesc {
66	USBDescID id;
67	const USBDescDevice *full;
68	const USBDescDevice *high;
69	const char* const *str;
70	};
71
72	/* generate usb packages from structs */
73	int usb_desc_device(const USBDescID id, const USBDescDevice dev,
74	uint8_t *dest, size_t len);
75	int usb_desc_config(const USBDescConfig conf, uint8_t dest, size_t len);
76	int usb_desc_iface(const USBDescIface iface, uint8_t dest, size_t len);
77	int usb_desc_endpoint(const USBDescEndpoint ep, uint8_t dest, size_t len);
78	int usb_desc_other(const USBDescOther desc, uint8_t dest, size_t len);
79	int usb_desc_string(const char* const str, int index, uint8_t dest, size_t len);
80
81	/* control message emulation helpers */
82	int usb_desc_get_descriptor(USBDevice dev, int value, uint8_t dest, size_t len);
83	int usb_desc_handle_control(USBDevice *dev, int request, int value,
84	int index, int length, uint8_t *data);
85
86	#endif /* QEMU_HW_USB_DESC_H */