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

#include "usb.h"
#include "usb-desc.h"
#include "trace.h"

/* ------------------------------------------------------------------ */

static uint8_t usb_lo(uint16_t val)
{
    return val & 0xff;
}

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

int usb_desc_device(const USBDescID *id, const USBDescDevice *dev,
                    uint8_t *dest, size_t len)
{
    uint8_t bLength = 0x12;

    if (len < bLength) {
        return -1;
    }

    dest[0x00] = bLength;
    dest[0x01] = USB_DT_DEVICE;

    dest[0x02] = usb_lo(dev->bcdUSB);
    dest[0x03] = usb_hi(dev->bcdUSB);
    dest[0x04] = dev->bDeviceClass;
    dest[0x05] = dev->bDeviceSubClass;
    dest[0x06] = dev->bDeviceProtocol;
    dest[0x07] = dev->bMaxPacketSize0;

    dest[0x08] = usb_lo(id->idVendor);
    dest[0x09] = usb_hi(id->idVendor);
    dest[0x0a] = usb_lo(id->idProduct);
    dest[0x0b] = usb_hi(id->idProduct);
    dest[0x0c] = usb_lo(id->bcdDevice);
    dest[0x0d] = usb_hi(id->bcdDevice);
    dest[0x0e] = id->iManufacturer;
    dest[0x0f] = id->iProduct;
    dest[0x10] = id->iSerialNumber;

    dest[0x11] = dev->bNumConfigurations;

    return bLength;
}

int usb_desc_config(const USBDescConfig *conf, uint8_t *dest, size_t len)
{
    uint8_t  bLength = 0x09;
    uint16_t wTotalLength = 0;
    int i, rc, count;

    if (len < bLength) {
        return -1;
    }

    dest[0x00] = bLength;
    dest[0x01] = USB_DT_CONFIG;
    dest[0x04] = conf->bNumInterfaces;
    dest[0x05] = conf->bConfigurationValue;
    dest[0x06] = conf->iConfiguration;
    dest[0x07] = conf->bmAttributes;
    dest[0x08] = conf->bMaxPower;
    wTotalLength += bLength;

    count = conf->nif ? conf->nif : conf->bNumInterfaces;
    for (i = 0; i < count; i++) {
        rc = usb_desc_iface(conf->ifs + i, dest + wTotalLength, len - wTotalLength);
        if (rc < 0) {
            return rc;
        }
        wTotalLength += rc;
    }

    dest[0x02] = usb_lo(wTotalLength);
    dest[0x03] = usb_hi(wTotalLength);
    return wTotalLength;
}

int usb_desc_iface(const USBDescIface *iface, uint8_t *dest, size_t len)
{
    uint8_t bLength = 0x09;
    int i, rc, pos = 0;

    if (len < bLength) {
        return -1;
    }

    dest[0x00] = bLength;
    dest[0x01] = USB_DT_INTERFACE;
    dest[0x02] = iface->bInterfaceNumber;
    dest[0x03] = iface->bAlternateSetting;
    dest[0x04] = iface->bNumEndpoints;
    dest[0x05] = iface->bInterfaceClass;
    dest[0x06] = iface->bInterfaceSubClass;
    dest[0x07] = iface->bInterfaceProtocol;
    dest[0x08] = iface->iInterface;
    pos += bLength;

    for (i = 0; i < iface->ndesc; i++) {
        rc = usb_desc_other(iface->descs + i, dest + pos, len - pos);
        if (rc < 0) {
            return rc;
        }
        pos += rc;
    }

    for (i = 0; i < iface->bNumEndpoints; i++) {
        rc = usb_desc_endpoint(iface->eps + i, dest + pos, len - pos);
        if (rc < 0) {
            return rc;
        }
        pos += rc;
    }

    return pos;
}

int usb_desc_endpoint(const USBDescEndpoint *ep, uint8_t *dest, size_t len)
{
    uint8_t bLength = 0x07;

    if (len < bLength) {
        return -1;
    }

    dest[0x00] = bLength;
    dest[0x01] = USB_DT_ENDPOINT;
    dest[0x02] = ep->bEndpointAddress;
    dest[0x03] = ep->bmAttributes;
    dest[0x04] = usb_lo(ep->wMaxPacketSize);
    dest[0x05] = usb_hi(ep->wMaxPacketSize);
    dest[0x06] = ep->bInterval;

    return bLength;
}

int usb_desc_other(const USBDescOther *desc, uint8_t *dest, size_t len)
{
    int bLength = desc->length ? desc->length : desc->data[0];

    if (len < bLength) {
        return -1;
    }

    memcpy(dest, desc->data, bLength);
    return bLength;
}

/* ------------------------------------------------------------------ */

void usb_desc_init(USBDevice *dev)
{
    const USBDesc *desc = dev->info->usb_desc;

    assert(desc != NULL);
    dev->speed  = USB_SPEED_FULL;
    dev->device = desc->full;
    dev->config = dev->device->confs;
}

void usb_desc_set_string(USBDevice *dev, uint8_t index, const char *str)
{
    USBDescString *s;

    QLIST_FOREACH(s, &dev->strings, next) {
        if (s->index == index) {
            break;
        }
    }
    if (s == NULL) {
        s = qemu_mallocz(sizeof(*s));
        s->index = index;
        QLIST_INSERT_HEAD(&dev->strings, s, next);
    }
    qemu_free(s->str);
    s->str = qemu_strdup(str);
}

const char *usb_desc_get_string(USBDevice *dev, uint8_t index)
{
    USBDescString *s;

    QLIST_FOREACH(s, &dev->strings, next) {
        if (s->index == index) {
            return s->str;
        }
    }
    return NULL;
}

int usb_desc_string(USBDevice *dev, int index, uint8_t *dest, size_t len)
{
    uint8_t bLength, pos, i;
    const char *str;

    if (len < 4) {
        return -1;
    }

    if (index == 0) {
        /* language ids */
        dest[0] = 4;
        dest[1] = USB_DT_STRING;
        dest[2] = 0x09;
        dest[3] = 0x04;
        return 4;
    }

    str = usb_desc_get_string(dev, index);
    if (str == NULL) {
        str = dev->info->usb_desc->str[index];
        if (str == NULL) {
            return 0;
        }
    }

    bLength = strlen(str) * 2 + 2;
    dest[0] = bLength;
    dest[1] = USB_DT_STRING;
    i = 0; pos = 2;
    while (pos+1 < bLength && pos+1 < len) {
        dest[pos++] = str[i++];
        dest[pos++] = 0;
    }
    return pos;
}

int usb_desc_get_descriptor(USBDevice *dev, int value, uint8_t *dest, size_t len)
{
    const USBDesc *desc = dev->info->usb_desc;
    uint8_t buf[256];
    uint8_t type = value >> 8;
    uint8_t index = value & 0xff;
    int ret = -1;

    switch(type) {
    case USB_DT_DEVICE:
        ret = usb_desc_device(&desc->id, dev->device, buf, sizeof(buf));
        trace_usb_desc_device(dev->addr, len, ret);
        break;
    case USB_DT_CONFIG:
        if (index < dev->device->bNumConfigurations) {
            ret = usb_desc_config(dev->device->confs + index, buf, sizeof(buf));
        }
        trace_usb_desc_config(dev->addr, index, len, ret);
        break;
    case USB_DT_STRING:
        ret = usb_desc_string(dev, index, buf, sizeof(buf));
        trace_usb_desc_string(dev->addr, index, len, ret);
        break;
    default:
        fprintf(stderr, "%s: %d unknown type %d (len %zd)\n", __FUNCTION__,
                dev->addr, type, len);
        break;
    }

    if (ret > 0) {
        if (ret > len) {
            ret = len;
        }
        memcpy(dest, buf, ret);
    }
    return ret;
}

int usb_desc_handle_control(USBDevice *dev, int request, int value,
                            int index, int length, uint8_t *data)
{
    const USBDesc *desc = dev->info->usb_desc;
    int i, ret = -1;

    assert(desc != NULL);
    switch(request) {
    case DeviceOutRequest | USB_REQ_SET_ADDRESS:
        dev->addr = value;
        trace_usb_set_addr(dev->addr);
        ret = 0;
        break;

    case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
        ret = usb_desc_get_descriptor(dev, value, data, length);
        break;

    case DeviceRequest | USB_REQ_GET_CONFIGURATION:
        data[0] = dev->config->bConfigurationValue;
        ret = 1;
        break;
    case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
        for (i = 0; i < dev->device->bNumConfigurations; i++) {
            if (dev->device->confs[i].bConfigurationValue == value) {
                dev->config = dev->device->confs + i;
                ret = 0;
            }
        }
        trace_usb_set_config(dev->addr, value, ret);
        break;

    case DeviceRequest | USB_REQ_GET_STATUS:
        data[0] = 0;
        if (dev->config->bmAttributes & 0x40) {
            data[0] |= 1 << USB_DEVICE_SELF_POWERED;
        }
        if (dev->remote_wakeup) {
            data[0] |= 1 << USB_DEVICE_REMOTE_WAKEUP;
        }
        data[1] = 0x00;
        ret = 2;
        break;
    case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
        if (value == USB_DEVICE_REMOTE_WAKEUP) {
            dev->remote_wakeup = 0;
            ret = 0;
        }
        trace_usb_clear_device_feature(dev->addr, value, ret);
        break;
    case DeviceOutRequest | USB_REQ_SET_FEATURE:
        if (value == USB_DEVICE_REMOTE_WAKEUP) {
            dev->remote_wakeup = 1;
            ret = 0;
        }
        trace_usb_set_device_feature(dev->addr, value, ret);
        break;
    }
    return ret;
}
Commit	Line	Data
37fb59d3 GH	1	#include "usb.h"
	2	#include "usb-desc.h"
	3	#include "trace.h"
	4
	5	/* ------------------------------------------------------------------ */
	6
	7	static uint8_t usb_lo(uint16_t val)
	8	{
	9	return val & 0xff;
	10	}
	11
	12	static uint8_t usb_hi(uint16_t val)
	13	{
	14	return (val >> 8) & 0xff;
	15	}
	16
	17	int usb_desc_device(const USBDescID id, const USBDescDevice dev,
	18	uint8_t *dest, size_t len)
	19	{
	20	uint8_t bLength = 0x12;
	21
	22	if (len < bLength) {
	23	return -1;
	24	}
	25
	26	dest[0x00] = bLength;
	27	dest[0x01] = USB_DT_DEVICE;
	28
	29	dest[0x02] = usb_lo(dev->bcdUSB);
	30	dest[0x03] = usb_hi(dev->bcdUSB);
	31	dest[0x04] = dev->bDeviceClass;
	32	dest[0x05] = dev->bDeviceSubClass;
	33	dest[0x06] = dev->bDeviceProtocol;
	34	dest[0x07] = dev->bMaxPacketSize0;
	35
	36	dest[0x08] = usb_lo(id->idVendor);
	37	dest[0x09] = usb_hi(id->idVendor);
	38	dest[0x0a] = usb_lo(id->idProduct);
	39	dest[0x0b] = usb_hi(id->idProduct);
	40	dest[0x0c] = usb_lo(id->bcdDevice);
	41	dest[0x0d] = usb_hi(id->bcdDevice);
	42	dest[0x0e] = id->iManufacturer;
	43	dest[0x0f] = id->iProduct;
	44	dest[0x10] = id->iSerialNumber;
	45
	46	dest[0x11] = dev->bNumConfigurations;
	47
	48	return bLength;
	49	}
	50
	51	int usb_desc_config(const USBDescConfig conf, uint8_t dest, size_t len)
	52	{
	53	uint8_t bLength = 0x09;
	54	uint16_t wTotalLength = 0;
	55	int i, rc, count;
	56
	57	if (len < bLength) {
	58	return -1;
	59	}
	60
	61	dest[0x00] = bLength;
	62	dest[0x01] = USB_DT_CONFIG;
	63	dest[0x04] = conf->bNumInterfaces;
	64	dest[0x05] = conf->bConfigurationValue;
65	dest[0x06] = conf->iConfiguration;
66	dest[0x07] = conf->bmAttributes;
67	dest[0x08] = conf->bMaxPower;
68	wTotalLength += bLength;
69
70	count = conf->nif ? conf->nif : conf->bNumInterfaces;
71	for (i = 0; i < count; i++) {
72	rc = usb_desc_iface(conf->ifs + i, dest + wTotalLength, len - wTotalLength);
73	if (rc < 0) {
74	return rc;
75	}
76	wTotalLength += rc;
77	}
78
79	dest[0x02] = usb_lo(wTotalLength);
80	dest[0x03] = usb_hi(wTotalLength);
81	return wTotalLength;
82	}
83
84	int usb_desc_iface(const USBDescIface iface, uint8_t dest, size_t len)
85	{
86	uint8_t bLength = 0x09;
87	int i, rc, pos = 0;
88
89	if (len < bLength) {
90	return -1;
91	}
92
93	dest[0x00] = bLength;
94	dest[0x01] = USB_DT_INTERFACE;
95	dest[0x02] = iface->bInterfaceNumber;
96	dest[0x03] = iface->bAlternateSetting;
97	dest[0x04] = iface->bNumEndpoints;
98	dest[0x05] = iface->bInterfaceClass;
99	dest[0x06] = iface->bInterfaceSubClass;
100	dest[0x07] = iface->bInterfaceProtocol;
101	dest[0x08] = iface->iInterface;
102	pos += bLength;
103
104	for (i = 0; i < iface->ndesc; i++) {
105	rc = usb_desc_other(iface->descs + i, dest + pos, len - pos);
106	if (rc < 0) {
107	return rc;
108	}
109	pos += rc;
110	}
111
112	for (i = 0; i < iface->bNumEndpoints; i++) {
113	rc = usb_desc_endpoint(iface->eps + i, dest + pos, len - pos);
114	if (rc < 0) {
115	return rc;
116	}
117	pos += rc;
118	}
119
120	return pos;
121	}
122
123	int usb_desc_endpoint(const USBDescEndpoint ep, uint8_t dest, size_t len)
124	{
125	uint8_t bLength = 0x07;
126
127	if (len < bLength) {
128	return -1;
129	}
130
131	dest[0x00] = bLength;
132	dest[0x01] = USB_DT_ENDPOINT;
133	dest[0x02] = ep->bEndpointAddress;
134	dest[0x03] = ep->bmAttributes;
135	dest[0x04] = usb_lo(ep->wMaxPacketSize);
136	dest[0x05] = usb_hi(ep->wMaxPacketSize);
137	dest[0x06] = ep->bInterval;
138
139	return bLength;
140	}
141
142	int usb_desc_other(const USBDescOther desc, uint8_t dest, size_t len)
143	{
144	int bLength = desc->length ? desc->length : desc->data[0];
145
146	if (len < bLength) {
147	return -1;
148	}
149
150	memcpy(dest, desc->data, bLength);
151	return bLength;
152	}
153
132a3f55 GH	154	/* ------------------------------------------------------------------ */
132a3f55 GH	155
a980a065 GH	156	void usb_desc_init(USBDevice *dev)
	157	{
	158	const USBDesc *desc = dev->info->usb_desc;
	159
	160	assert(desc != NULL);
	161	dev->speed = USB_SPEED_FULL;
	162	dev->device = desc->full;
	163	dev->config = dev->device->confs;
	164	}
	165
132a3f55 GH	166	void usb_desc_set_string(USBDevice dev, uint8_t index, const char str)
	167	{
	168	USBDescString *s;
	169
	170	QLIST_FOREACH(s, &dev->strings, next) {
	171	if (s->index == index) {
	172	break;
	173	}
	174	}
	175	if (s == NULL) {
	176	s = qemu_mallocz(sizeof(*s));
	177	s->index = index;
	178	QLIST_INSERT_HEAD(&dev->strings, s, next);
	179	}
	180	qemu_free(s->str);
	181	s->str = qemu_strdup(str);
	182	}
	183
	184	const char usb_desc_get_string(USBDevice dev, uint8_t index)
	185	{
	186	USBDescString *s;
	187
	188	QLIST_FOREACH(s, &dev->strings, next) {
	189	if (s->index == index) {
	190	return s->str;
	191	}
	192	}
	193	return NULL;
	194	}
	195
	196	int usb_desc_string(USBDevice dev, int index, uint8_t dest, size_t len)
37fb59d3 GH	197	{
37fb59d3 GH	198	uint8_t bLength, pos, i;
132a3f55	199	const char *str;
37fb59d3 GH	200
	201	if (len < 4) {
	202	return -1;
	203	}
	204
	205	if (index == 0) {
	206	/* language ids */
	207	dest[0] = 4;
	208	dest[1] = USB_DT_STRING;
	209	dest[2] = 0x09;
	210	dest[3] = 0x04;
	211	return 4;
	212	}
	213
132a3f55 GH	214	str = usb_desc_get_string(dev, index);
	215	if (str == NULL) {
	216	str = dev->info->usb_desc->str[index];
	217	if (str == NULL) {
	218	return 0;
	219	}
37fb59d3	220	}
132a3f55 GH	221
132a3f55 GH	222	bLength = strlen(str) * 2 + 2;
37fb59d3 GH	223	dest[0] = bLength;
	224	dest[1] = USB_DT_STRING;
	225	i = 0; pos = 2;
	226	while (pos+1 < bLength && pos+1 < len) {
132a3f55	227	dest[pos++] = str[i++];
37fb59d3 GH	228	dest[pos++] = 0;
	229	}
	230	return pos;
	231	}
	232
37fb59d3 GH	233	int usb_desc_get_descriptor(USBDevice dev, int value, uint8_t dest, size_t len)
	234	{
	235	const USBDesc *desc = dev->info->usb_desc;
	236	uint8_t buf[256];
	237	uint8_t type = value >> 8;
	238	uint8_t index = value & 0xff;
	239	int ret = -1;
	240
	241	switch(type) {
	242	case USB_DT_DEVICE:
a980a065	243	ret = usb_desc_device(&desc->id, dev->device, buf, sizeof(buf));
37fb59d3 GH	244	trace_usb_desc_device(dev->addr, len, ret);
	245	break;
	246	case USB_DT_CONFIG:
a980a065 GH	247	if (index < dev->device->bNumConfigurations) {
a980a065 GH	248	ret = usb_desc_config(dev->device->confs + index, buf, sizeof(buf));
37fb59d3 GH	249	}
	250	trace_usb_desc_config(dev->addr, index, len, ret);
	251	break;
	252	case USB_DT_STRING:
132a3f55	253	ret = usb_desc_string(dev, index, buf, sizeof(buf));
37fb59d3 GH	254	trace_usb_desc_string(dev->addr, index, len, ret);
	255	break;
	256	default:
	257	fprintf(stderr, "%s: %d unknown type %d (len %zd)\n", __FUNCTION__,
	258	dev->addr, type, len);
	259	break;
	260	}
	261
	262	if (ret > 0) {
	263	if (ret > len) {
	264	ret = len;
	265	}
	266	memcpy(dest, buf, ret);
	267	}
	268	return ret;
	269	}
	270
	271	int usb_desc_handle_control(USBDevice *dev, int request, int value,
	272	int index, int length, uint8_t *data)
	273	{
	274	const USBDesc *desc = dev->info->usb_desc;
a980a065	275	int i, ret = -1;
37fb59d3 GH	276
	277	assert(desc != NULL);
	278	switch(request) {
41c6abbd GH	279	case DeviceOutRequest \| USB_REQ_SET_ADDRESS:
	280	dev->addr = value;
	281	trace_usb_set_addr(dev->addr);
	282	ret = 0;
	283	break;
	284
37fb59d3 GH	285	case DeviceRequest \| USB_REQ_GET_DESCRIPTOR:
	286	ret = usb_desc_get_descriptor(dev, value, data, length);
	287	break;
a980a065 GH	288
	289	case DeviceRequest \| USB_REQ_GET_CONFIGURATION:
	290	data[0] = dev->config->bConfigurationValue;
	291	ret = 1;
	292	break;
	293	case DeviceOutRequest \| USB_REQ_SET_CONFIGURATION:
	294	for (i = 0; i < dev->device->bNumConfigurations; i++) {
	295	if (dev->device->confs[i].bConfigurationValue == value) {
	296	dev->config = dev->device->confs + i;
	297	ret = 0;
	298	}
	299	}
	300	trace_usb_set_config(dev->addr, value, ret);
	301	break;
ed5a83dd GH	302
	303	case DeviceRequest \| USB_REQ_GET_STATUS:
	304	data[0] = 0;
	305	if (dev->config->bmAttributes & 0x40) {
	306	data[0] \|= 1 << USB_DEVICE_SELF_POWERED;
	307	}
	308	if (dev->remote_wakeup) {
	309	data[0] \|= 1 << USB_DEVICE_REMOTE_WAKEUP;
	310	}
	311	data[1] = 0x00;
	312	ret = 2;
	313	break;
	314	case DeviceOutRequest \| USB_REQ_CLEAR_FEATURE:
	315	if (value == USB_DEVICE_REMOTE_WAKEUP) {
	316	dev->remote_wakeup = 0;
	317	ret = 0;
	318	}
	319	trace_usb_clear_device_feature(dev->addr, value, ret);
	320	break;
	321	case DeviceOutRequest \| USB_REQ_SET_FEATURE:
	322	if (value == USB_DEVICE_REMOTE_WAKEUP) {
	323	dev->remote_wakeup = 1;
	324	ret = 0;
	325	}
	326	trace_usb_set_device_feature(dev->addr, value, ret);
	327	break;
37fb59d3 GH	328	}
	329	return ret;
	330	}