]> git.proxmox.com Git - qemu.git/blame - hw/usb-desc.c
Bug #757654: UHCI fails to signal stall response patch
[qemu.git] / hw / usb-desc.c
CommitLineData
37fb59d3
GH
1#include "usb.h"
2#include "usb-desc.h"
3#include "trace.h"
4
5/* ------------------------------------------------------------------ */
6
7static uint8_t usb_lo(uint16_t val)
8{
9 return val & 0xff;
10}
11
12static uint8_t usb_hi(uint16_t val)
13{
14 return (val >> 8) & 0xff;
15}
16
17int 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
25620cba
GH
51int usb_desc_device_qualifier(const USBDescDevice *dev,
52 uint8_t *dest, size_t len)
53{
54 uint8_t bLength = 0x0a;
55
56 if (len < bLength) {
57 return -1;
58 }
59
60 dest[0x00] = bLength;
61 dest[0x01] = USB_DT_DEVICE_QUALIFIER;
62
63 dest[0x02] = usb_lo(dev->bcdUSB);
64 dest[0x03] = usb_hi(dev->bcdUSB);
65 dest[0x04] = dev->bDeviceClass;
66 dest[0x05] = dev->bDeviceSubClass;
67 dest[0x06] = dev->bDeviceProtocol;
68 dest[0x07] = dev->bMaxPacketSize0;
69 dest[0x08] = dev->bNumConfigurations;
70 dest[0x09] = 0; /* reserved */
71
72 return bLength;
73}
74
37fb59d3
GH
75int usb_desc_config(const USBDescConfig *conf, uint8_t *dest, size_t len)
76{
77 uint8_t bLength = 0x09;
78 uint16_t wTotalLength = 0;
fef13fa8 79 int i, rc;
37fb59d3
GH
80
81 if (len < bLength) {
82 return -1;
83 }
84
85 dest[0x00] = bLength;
86 dest[0x01] = USB_DT_CONFIG;
87 dest[0x04] = conf->bNumInterfaces;
88 dest[0x05] = conf->bConfigurationValue;
89 dest[0x06] = conf->iConfiguration;
90 dest[0x07] = conf->bmAttributes;
91 dest[0x08] = conf->bMaxPower;
92 wTotalLength += bLength;
93
6e625fc7
BH
94 /* handle grouped interfaces if any*/
95 for (i = 0; i < conf->nif_groups; i++) {
96 rc = usb_desc_iface_group(&(conf->if_groups[i]),
97 dest + wTotalLength,
98 len - wTotalLength);
99 if (rc < 0) {
100 return rc;
101 }
102 wTotalLength += rc;
103 }
104
105 /* handle normal (ungrouped / no IAD) interfaces if any */
fef13fa8 106 for (i = 0; i < conf->nif; i++) {
37fb59d3
GH
107 rc = usb_desc_iface(conf->ifs + i, dest + wTotalLength, len - wTotalLength);
108 if (rc < 0) {
109 return rc;
110 }
111 wTotalLength += rc;
112 }
113
114 dest[0x02] = usb_lo(wTotalLength);
115 dest[0x03] = usb_hi(wTotalLength);
116 return wTotalLength;
117}
118
6e625fc7
BH
119int usb_desc_iface_group(const USBDescIfaceAssoc *iad, uint8_t *dest,
120 size_t len)
121{
122 int pos = 0;
123 int i = 0;
124
125 /* handle interface association descriptor */
126 uint8_t bLength = 0x08;
127
128 if (len < bLength) {
129 return -1;
130 }
131
132 dest[0x00] = bLength;
133 dest[0x01] = USB_DT_INTERFACE_ASSOC;
134 dest[0x02] = iad->bFirstInterface;
135 dest[0x03] = iad->bInterfaceCount;
136 dest[0x04] = iad->bFunctionClass;
137 dest[0x05] = iad->bFunctionSubClass;
138 dest[0x06] = iad->bFunctionProtocol;
139 dest[0x07] = iad->iFunction;
140 pos += bLength;
141
142 /* handle associated interfaces in this group */
143 for (i = 0; i < iad->nif; i++) {
144 int rc = usb_desc_iface(&(iad->ifs[i]), dest + pos, len - pos);
145 if (rc < 0) {
146 return rc;
147 }
148 pos += rc;
149 }
150
151 return pos;
152}
153
37fb59d3
GH
154int usb_desc_iface(const USBDescIface *iface, uint8_t *dest, size_t len)
155{
156 uint8_t bLength = 0x09;
157 int i, rc, pos = 0;
158
159 if (len < bLength) {
160 return -1;
161 }
162
163 dest[0x00] = bLength;
164 dest[0x01] = USB_DT_INTERFACE;
165 dest[0x02] = iface->bInterfaceNumber;
166 dest[0x03] = iface->bAlternateSetting;
167 dest[0x04] = iface->bNumEndpoints;
168 dest[0x05] = iface->bInterfaceClass;
169 dest[0x06] = iface->bInterfaceSubClass;
170 dest[0x07] = iface->bInterfaceProtocol;
171 dest[0x08] = iface->iInterface;
172 pos += bLength;
173
174 for (i = 0; i < iface->ndesc; i++) {
175 rc = usb_desc_other(iface->descs + i, dest + pos, len - pos);
176 if (rc < 0) {
177 return rc;
178 }
179 pos += rc;
180 }
181
182 for (i = 0; i < iface->bNumEndpoints; i++) {
183 rc = usb_desc_endpoint(iface->eps + i, dest + pos, len - pos);
184 if (rc < 0) {
185 return rc;
186 }
187 pos += rc;
188 }
189
190 return pos;
191}
192
193int usb_desc_endpoint(const USBDescEndpoint *ep, uint8_t *dest, size_t len)
194{
195 uint8_t bLength = 0x07;
196
197 if (len < bLength) {
198 return -1;
199 }
200
201 dest[0x00] = bLength;
202 dest[0x01] = USB_DT_ENDPOINT;
203 dest[0x02] = ep->bEndpointAddress;
204 dest[0x03] = ep->bmAttributes;
205 dest[0x04] = usb_lo(ep->wMaxPacketSize);
206 dest[0x05] = usb_hi(ep->wMaxPacketSize);
207 dest[0x06] = ep->bInterval;
208
209 return bLength;
210}
211
212int usb_desc_other(const USBDescOther *desc, uint8_t *dest, size_t len)
213{
214 int bLength = desc->length ? desc->length : desc->data[0];
215
216 if (len < bLength) {
217 return -1;
218 }
219
220 memcpy(dest, desc->data, bLength);
221 return bLength;
222}
223
132a3f55
GH
224/* ------------------------------------------------------------------ */
225
32d41919 226static void usb_desc_setdefaults(USBDevice *dev)
a980a065
GH
227{
228 const USBDesc *desc = dev->info->usb_desc;
229
230 assert(desc != NULL);
32d41919
GH
231 switch (dev->speed) {
232 case USB_SPEED_LOW:
233 case USB_SPEED_FULL:
234 dev->device = desc->full;
235 break;
236 case USB_SPEED_HIGH:
237 dev->device = desc->high;
238 break;
239 }
a980a065
GH
240 dev->config = dev->device->confs;
241}
242
32d41919
GH
243void usb_desc_init(USBDevice *dev)
244{
245 dev->speed = USB_SPEED_FULL;
246 usb_desc_setdefaults(dev);
247}
248
249void usb_desc_attach(USBDevice *dev)
250{
251 const USBDesc *desc = dev->info->usb_desc;
252
253 assert(desc != NULL);
254 if (desc->high && (dev->port->speedmask & USB_SPEED_MASK_HIGH)) {
255 dev->speed = USB_SPEED_HIGH;
256 } else if (desc->full && (dev->port->speedmask & USB_SPEED_MASK_FULL)) {
257 dev->speed = USB_SPEED_FULL;
258 } else {
259 fprintf(stderr, "usb: port/device speed mismatch for \"%s\"\n",
260 dev->info->product_desc);
261 return;
262 }
263 usb_desc_setdefaults(dev);
264}
265
132a3f55
GH
266void usb_desc_set_string(USBDevice *dev, uint8_t index, const char *str)
267{
268 USBDescString *s;
269
270 QLIST_FOREACH(s, &dev->strings, next) {
271 if (s->index == index) {
272 break;
273 }
274 }
275 if (s == NULL) {
276 s = qemu_mallocz(sizeof(*s));
277 s->index = index;
278 QLIST_INSERT_HEAD(&dev->strings, s, next);
279 }
280 qemu_free(s->str);
281 s->str = qemu_strdup(str);
282}
283
284const char *usb_desc_get_string(USBDevice *dev, uint8_t index)
285{
286 USBDescString *s;
287
288 QLIST_FOREACH(s, &dev->strings, next) {
289 if (s->index == index) {
290 return s->str;
291 }
292 }
293 return NULL;
294}
295
296int usb_desc_string(USBDevice *dev, int index, uint8_t *dest, size_t len)
37fb59d3
GH
297{
298 uint8_t bLength, pos, i;
132a3f55 299 const char *str;
37fb59d3
GH
300
301 if (len < 4) {
302 return -1;
303 }
304
305 if (index == 0) {
306 /* language ids */
307 dest[0] = 4;
308 dest[1] = USB_DT_STRING;
309 dest[2] = 0x09;
310 dest[3] = 0x04;
311 return 4;
312 }
313
132a3f55
GH
314 str = usb_desc_get_string(dev, index);
315 if (str == NULL) {
316 str = dev->info->usb_desc->str[index];
317 if (str == NULL) {
318 return 0;
319 }
37fb59d3 320 }
132a3f55
GH
321
322 bLength = strlen(str) * 2 + 2;
37fb59d3
GH
323 dest[0] = bLength;
324 dest[1] = USB_DT_STRING;
325 i = 0; pos = 2;
326 while (pos+1 < bLength && pos+1 < len) {
132a3f55 327 dest[pos++] = str[i++];
37fb59d3
GH
328 dest[pos++] = 0;
329 }
330 return pos;
331}
332
37fb59d3
GH
333int usb_desc_get_descriptor(USBDevice *dev, int value, uint8_t *dest, size_t len)
334{
335 const USBDesc *desc = dev->info->usb_desc;
25620cba 336 const USBDescDevice *other_dev;
37fb59d3
GH
337 uint8_t buf[256];
338 uint8_t type = value >> 8;
339 uint8_t index = value & 0xff;
340 int ret = -1;
341
25620cba
GH
342 if (dev->speed == USB_SPEED_HIGH) {
343 other_dev = dev->info->usb_desc->full;
344 } else {
345 other_dev = dev->info->usb_desc->high;
346 }
347
37fb59d3
GH
348 switch(type) {
349 case USB_DT_DEVICE:
a980a065 350 ret = usb_desc_device(&desc->id, dev->device, buf, sizeof(buf));
37fb59d3
GH
351 trace_usb_desc_device(dev->addr, len, ret);
352 break;
353 case USB_DT_CONFIG:
a980a065
GH
354 if (index < dev->device->bNumConfigurations) {
355 ret = usb_desc_config(dev->device->confs + index, buf, sizeof(buf));
37fb59d3
GH
356 }
357 trace_usb_desc_config(dev->addr, index, len, ret);
358 break;
359 case USB_DT_STRING:
132a3f55 360 ret = usb_desc_string(dev, index, buf, sizeof(buf));
37fb59d3
GH
361 trace_usb_desc_string(dev->addr, index, len, ret);
362 break;
25620cba
GH
363
364 case USB_DT_DEVICE_QUALIFIER:
365 if (other_dev != NULL) {
366 ret = usb_desc_device_qualifier(other_dev, buf, sizeof(buf));
367 }
368 trace_usb_desc_device_qualifier(dev->addr, len, ret);
369 break;
370 case USB_DT_OTHER_SPEED_CONFIG:
371 if (other_dev != NULL && index < other_dev->bNumConfigurations) {
372 ret = usb_desc_config(other_dev->confs + index, buf, sizeof(buf));
373 buf[0x01] = USB_DT_OTHER_SPEED_CONFIG;
374 }
375 trace_usb_desc_other_speed_config(dev->addr, index, len, ret);
376 break;
377
37fb59d3
GH
378 default:
379 fprintf(stderr, "%s: %d unknown type %d (len %zd)\n", __FUNCTION__,
380 dev->addr, type, len);
381 break;
382 }
383
384 if (ret > 0) {
385 if (ret > len) {
386 ret = len;
387 }
388 memcpy(dest, buf, ret);
389 }
390 return ret;
391}
392
393int usb_desc_handle_control(USBDevice *dev, int request, int value,
394 int index, int length, uint8_t *data)
395{
396 const USBDesc *desc = dev->info->usb_desc;
a980a065 397 int i, ret = -1;
37fb59d3
GH
398
399 assert(desc != NULL);
400 switch(request) {
41c6abbd
GH
401 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
402 dev->addr = value;
403 trace_usb_set_addr(dev->addr);
404 ret = 0;
405 break;
406
37fb59d3
GH
407 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
408 ret = usb_desc_get_descriptor(dev, value, data, length);
409 break;
a980a065
GH
410
411 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
412 data[0] = dev->config->bConfigurationValue;
413 ret = 1;
414 break;
415 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
416 for (i = 0; i < dev->device->bNumConfigurations; i++) {
417 if (dev->device->confs[i].bConfigurationValue == value) {
418 dev->config = dev->device->confs + i;
419 ret = 0;
420 }
421 }
422 trace_usb_set_config(dev->addr, value, ret);
423 break;
ed5a83dd
GH
424
425 case DeviceRequest | USB_REQ_GET_STATUS:
426 data[0] = 0;
427 if (dev->config->bmAttributes & 0x40) {
428 data[0] |= 1 << USB_DEVICE_SELF_POWERED;
429 }
430 if (dev->remote_wakeup) {
431 data[0] |= 1 << USB_DEVICE_REMOTE_WAKEUP;
432 }
433 data[1] = 0x00;
434 ret = 2;
435 break;
436 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
437 if (value == USB_DEVICE_REMOTE_WAKEUP) {
438 dev->remote_wakeup = 0;
439 ret = 0;
440 }
441 trace_usb_clear_device_feature(dev->addr, value, ret);
442 break;
443 case DeviceOutRequest | USB_REQ_SET_FEATURE:
444 if (value == USB_DEVICE_REMOTE_WAKEUP) {
445 dev->remote_wakeup = 1;
446 ret = 0;
447 }
448 trace_usb_set_device_feature(dev->addr, value, ret);
449 break;
37fb59d3
GH
450 }
451 return ret;
452}