3 * Copyright (c) 2009 Sylvestre Gallon. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/queue.h>
32 #define libusb_device_handle libusb20_device
35 #include "libusb20_desc.h"
36 #include "libusb20_int.h"
40 #define N_ALIGN(n) (-((-(n)) & (-8UL)))
45 libusb_get_device_descriptor(libusb_device *dev,
46 struct libusb_device_descriptor *desc)
48 struct LIBUSB20_DEVICE_DESC_DECODED *pdesc;
49 struct libusb20_device *pdev;
51 if ((dev == NULL) || (desc == NULL))
52 return (LIBUSB_ERROR_INVALID_PARAM);
55 pdesc = libusb20_dev_get_device_desc(pdev);
57 desc->bLength = pdesc->bLength;
58 desc->bDescriptorType = pdesc->bDescriptorType;
59 desc->bcdUSB = pdesc->bcdUSB;
60 desc->bDeviceClass = pdesc->bDeviceClass;
61 desc->bDeviceSubClass = pdesc->bDeviceSubClass;
62 desc->bDeviceProtocol = pdesc->bDeviceProtocol;
63 desc->bMaxPacketSize0 = pdesc->bMaxPacketSize0;
64 desc->idVendor = pdesc->idVendor;
65 desc->idProduct = pdesc->idProduct;
66 desc->bcdDevice = pdesc->bcdDevice;
67 desc->iManufacturer = pdesc->iManufacturer;
68 desc->iProduct = pdesc->iProduct;
69 desc->iSerialNumber = pdesc->iSerialNumber;
70 desc->bNumConfigurations = pdesc->bNumConfigurations;
76 libusb_get_active_config_descriptor(libusb_device *dev,
77 struct libusb_config_descriptor **config)
79 struct libusb20_device *pdev;
83 config_index = libusb20_dev_get_config_index(pdev);
85 return (libusb_get_config_descriptor(dev, config_index, config));
89 libusb_get_config_descriptor(libusb_device *dev, uint8_t config_index,
90 struct libusb_config_descriptor **config)
92 struct libusb20_device *pdev;
93 struct libusb20_config *pconf;
94 struct libusb20_interface *pinf;
95 struct libusb20_endpoint *pend;
96 struct libusb_config_descriptor *pconfd;
97 struct libusb_interface_descriptor *ifd;
98 struct libusb_endpoint_descriptor *endd;
108 if (dev == NULL || config == NULL)
109 return (LIBUSB_ERROR_INVALID_PARAM);
114 pconf = libusb20_dev_alloc_config(pdev, config_index);
117 return (LIBUSB_ERROR_NOT_FOUND);
119 nalt = nif = pconf->num_interface;
121 nextra = N_ALIGN(pconf->extra.len);
123 for (i = 0; i < nif; i++) {
125 pinf = pconf->interface + i;
126 nextra += N_ALIGN(pinf->extra.len);
127 nep += pinf->num_endpoints;
128 k = pinf->num_endpoints;
129 pend = pinf->endpoints;
131 nextra += N_ALIGN(pend->extra.len);
135 j = pinf->num_altsetting;
136 nalt += pinf->num_altsetting;
137 pinf = pinf->altsetting;
139 nextra += N_ALIGN(pinf->extra.len);
140 nep += pinf->num_endpoints;
141 k = pinf->num_endpoints;
142 pend = pinf->endpoints;
144 nextra += N_ALIGN(pend->extra.len);
152 (1 * sizeof(libusb_config_descriptor)) +
153 (nif * sizeof(libusb_interface)) +
154 (nalt * sizeof(libusb_interface_descriptor)) +
155 (nep * sizeof(libusb_endpoint_descriptor));
157 nextra = N_ALIGN(nextra);
159 pconfd = malloc(nextra);
161 if (pconfd == NULL) {
163 return (LIBUSB_ERROR_NO_MEM);
165 /* make sure memory is initialised */
166 memset(pconfd, 0, nextra);
168 pconfd->interface = (libusb_interface *) (pconfd + 1);
170 ifd = (libusb_interface_descriptor *) (pconfd->interface + nif);
171 endd = (libusb_endpoint_descriptor *) (ifd + nalt);
172 pextra = (uint8_t *)(endd + nep);
174 /* fill in config descriptor */
176 pconfd->bLength = pconf->desc.bLength;
177 pconfd->bDescriptorType = pconf->desc.bDescriptorType;
178 pconfd->wTotalLength = pconf->desc.wTotalLength;
179 pconfd->bNumInterfaces = pconf->desc.bNumInterfaces;
180 pconfd->bConfigurationValue = pconf->desc.bConfigurationValue;
181 pconfd->iConfiguration = pconf->desc.iConfiguration;
182 pconfd->bmAttributes = pconf->desc.bmAttributes;
183 pconfd->MaxPower = pconf->desc.bMaxPower;
185 if (pconf->extra.len != 0) {
186 pconfd->extra_length = pconf->extra.len;
187 pconfd->extra = pextra;
188 memcpy(pextra, pconf->extra.ptr, pconfd->extra_length);
189 pextra += N_ALIGN(pconfd->extra_length);
191 /* setup all interface and endpoint pointers */
193 for (i = 0; i < nif; i++) {
195 pconfd->interface[i].altsetting = ifd;
196 ifd->endpoint = endd;
197 endd += pconf->interface[i].num_endpoints;
200 for (j = 0; j < pconf->interface[i].num_altsetting; j++) {
201 ifd->endpoint = endd;
202 endd += pconf->interface[i].altsetting[j].num_endpoints;
207 /* fill in all interface and endpoint data */
209 for (i = 0; i < nif; i++) {
210 pinf = &pconf->interface[i];
211 pconfd->interface[i].num_altsetting = pinf->num_altsetting + 1;
212 for (j = 0; j < pconfd->interface[i].num_altsetting; j++) {
214 pinf = &pconf->interface[i].altsetting[j - 1];
215 ifd = &pconfd->interface[i].altsetting[j];
216 ifd->bLength = pinf->desc.bLength;
217 ifd->bDescriptorType = pinf->desc.bDescriptorType;
218 ifd->bInterfaceNumber = pinf->desc.bInterfaceNumber;
219 ifd->bAlternateSetting = pinf->desc.bAlternateSetting;
220 ifd->bNumEndpoints = pinf->desc.bNumEndpoints;
221 ifd->bInterfaceClass = pinf->desc.bInterfaceClass;
222 ifd->bInterfaceSubClass = pinf->desc.bInterfaceSubClass;
223 ifd->bInterfaceProtocol = pinf->desc.bInterfaceProtocol;
224 ifd->iInterface = pinf->desc.iInterface;
225 if (pinf->extra.len != 0) {
226 ifd->extra_length = pinf->extra.len;
228 memcpy(pextra, pinf->extra.ptr, pinf->extra.len);
229 pextra += N_ALIGN(pinf->extra.len);
231 for (k = 0; k < pinf->num_endpoints; k++) {
232 pend = &pinf->endpoints[k];
233 endd = &ifd->endpoint[k];
234 endd->bLength = pend->desc.bLength;
235 endd->bDescriptorType = pend->desc.bDescriptorType;
236 endd->bEndpointAddress = pend->desc.bEndpointAddress;
237 endd->bmAttributes = pend->desc.bmAttributes;
238 endd->wMaxPacketSize = pend->desc.wMaxPacketSize;
239 endd->bInterval = pend->desc.bInterval;
240 endd->bRefresh = pend->desc.bRefresh;
241 endd->bSynchAddress = pend->desc.bSynchAddress;
242 if (pend->extra.len != 0) {
243 endd->extra_length = pend->extra.len;
244 endd->extra = pextra;
245 memcpy(pextra, pend->extra.ptr, pend->extra.len);
246 pextra += N_ALIGN(pend->extra.len);
256 return (0); /* success */
260 libusb_get_config_descriptor_by_value(libusb_device *dev,
261 uint8_t bConfigurationValue, struct libusb_config_descriptor **config)
263 struct LIBUSB20_DEVICE_DESC_DECODED *pdesc;
264 struct libusb20_device *pdev;
268 if (dev == NULL || config == NULL)
269 return (LIBUSB_ERROR_INVALID_PARAM);
272 pdesc = libusb20_dev_get_device_desc(pdev);
274 for (i = 0; i < pdesc->bNumConfigurations; i++) {
275 err = libusb_get_config_descriptor(dev, i, config);
279 if ((*config)->bConfigurationValue == bConfigurationValue)
280 return (0); /* success */
282 libusb_free_config_descriptor(*config);
287 return (LIBUSB_ERROR_NOT_FOUND);
291 libusb_free_config_descriptor(struct libusb_config_descriptor *config)
297 libusb_get_string_descriptor(libusb_device_handle *pdev,
298 uint8_t desc_index, uint16_t langid, unsigned char *data,
301 if (pdev == NULL || data == NULL || length < 1)
302 return (LIBUSB_ERROR_INVALID_PARAM);
307 /* put some default data into the destination buffer */
310 return (libusb_control_transfer(pdev, LIBUSB_ENDPOINT_IN,
311 LIBUSB_REQUEST_GET_DESCRIPTOR, (LIBUSB_DT_STRING << 8) | desc_index,
312 langid, data, length, 1000));
316 libusb_get_string_descriptor_ascii(libusb_device_handle *pdev,
317 uint8_t desc_index, unsigned char *data, int length)
319 if (pdev == NULL || data == NULL || length < 1)
320 return (LIBUSB_ERROR_INVALID_PARAM);
325 /* put some default data into the destination buffer */
328 if (libusb20_dev_req_string_simple_sync(pdev, desc_index,
330 return (strlen(data));
332 return (LIBUSB_ERROR_OTHER);
336 libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type,
337 uint8_t desc_index, uint8_t *data, int length)
339 if (devh == NULL || data == NULL || length < 1)
340 return (LIBUSB_ERROR_INVALID_PARAM);
345 return (libusb_control_transfer(devh, LIBUSB_ENDPOINT_IN,
346 LIBUSB_REQUEST_GET_DESCRIPTOR, (desc_type << 8) | desc_index, 0, data,
351 libusb_parse_ss_endpoint_comp(const void *buf, int len,
352 struct libusb_ss_endpoint_companion_descriptor **ep_comp)
354 if (buf == NULL || ep_comp == NULL || len < 1)
355 return (LIBUSB_ERROR_INVALID_PARAM);
366 dlen = ((const uint8_t *)buf)[0];
367 dtype = ((const uint8_t *)buf)[1];
369 if (dlen < 2 || dlen > len)
372 if (dlen >= LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE &&
373 dtype == LIBUSB_DT_SS_ENDPOINT_COMPANION) {
374 struct libusb_ss_endpoint_companion_descriptor *ptr;
376 ptr = malloc(sizeof(*ptr));
378 return (LIBUSB_ERROR_NO_MEM);
380 ptr->bLength = LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE;
381 ptr->bDescriptorType = dtype;
382 ptr->bMaxBurst = ((const uint8_t *)buf)[2];
383 ptr->bmAttributes = ((const uint8_t *)buf)[3];
384 ptr->wBytesPerInterval = ((const uint8_t *)buf)[4] |
385 (((const uint8_t *)buf)[5] << 8);
389 return (0); /* success */
392 buf = ((const uint8_t *)buf) + dlen;
395 return (LIBUSB_ERROR_IO);
399 libusb_free_ss_endpoint_comp(struct libusb_ss_endpoint_companion_descriptor *ep_comp)
408 libusb_get_ss_endpoint_companion_descriptor(struct libusb_context *ctx,
409 const struct libusb_endpoint_descriptor *endpoint,
410 struct libusb_ss_endpoint_companion_descriptor **ep_comp)
412 if (endpoint == NULL)
413 return (LIBUSB_ERROR_INVALID_PARAM);
414 return (libusb_parse_ss_endpoint_comp(endpoint->extra, endpoint->extra_length, ep_comp));
418 libusb_free_ss_endpoint_companion_descriptor(struct libusb_ss_endpoint_companion_descriptor *ep_comp)
421 libusb_free_ss_endpoint_comp(ep_comp);
425 libusb_parse_bos_descriptor(const void *buf, int len,
426 struct libusb_bos_descriptor **bos)
428 struct libusb_bos_descriptor *ptr;
429 struct libusb_usb_2_0_device_capability_descriptor *dcap_20 = NULL;
430 struct libusb_ss_usb_device_capability_descriptor *ss_cap = NULL;
432 if (buf == NULL || bos == NULL || len < 1)
433 return (LIBUSB_ERROR_INVALID_PARAM);
444 dlen = ((const uint8_t *)buf)[0];
445 dtype = ((const uint8_t *)buf)[1];
447 if (dlen < 2 || dlen > len)
450 if (dlen >= LIBUSB_DT_BOS_SIZE &&
451 dtype == LIBUSB_DT_BOS) {
453 ptr = malloc(sizeof(*ptr) + sizeof(*dcap_20) +
457 return (LIBUSB_ERROR_NO_MEM);
461 ptr->bLength = LIBUSB_DT_BOS_SIZE;
462 ptr->bDescriptorType = dtype;
463 ptr->wTotalLength = ((const uint8_t *)buf)[2] |
464 (((const uint8_t *)buf)[3] << 8);
465 ptr->bNumDeviceCapabilities = ((const uint8_t *)buf)[4];
466 ptr->usb_2_0_ext_cap = NULL;
467 ptr->ss_usb_cap = NULL;
469 dcap_20 = (void *)(ptr + 1);
470 ss_cap = (void *)(dcap_20 + 1);
474 dtype == LIBUSB_DT_DEVICE_CAPABILITY) {
475 switch (((const uint8_t *)buf)[2]) {
476 case LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY:
477 if (ptr->usb_2_0_ext_cap != NULL || dcap_20 == NULL)
479 if (dlen < LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE)
482 ptr->usb_2_0_ext_cap = dcap_20;
484 dcap_20->bLength = LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE;
485 dcap_20->bDescriptorType = dtype;
486 dcap_20->bDevCapabilityType = ((const uint8_t *)buf)[2];
487 dcap_20->bmAttributes = ((const uint8_t *)buf)[3] |
488 (((const uint8_t *)buf)[4] << 8) |
489 (((const uint8_t *)buf)[5] << 16) |
490 (((const uint8_t *)buf)[6] << 24);
493 case LIBUSB_SS_USB_DEVICE_CAPABILITY:
494 if (ptr->ss_usb_cap != NULL || ss_cap == NULL)
496 if (dlen < LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE)
499 ptr->ss_usb_cap = ss_cap;
501 ss_cap->bLength = LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE;
502 ss_cap->bDescriptorType = dtype;
503 ss_cap->bDevCapabilityType = ((const uint8_t *)buf)[2];
504 ss_cap->bmAttributes = ((const uint8_t *)buf)[3];
505 ss_cap->wSpeedSupported = ((const uint8_t *)buf)[4] |
506 (((const uint8_t *)buf)[5] << 8);
507 ss_cap->bFunctionalitySupport = ((const uint8_t *)buf)[6];
508 ss_cap->bU1DevExitLat = ((const uint8_t *)buf)[7];
509 ss_cap->wU2DevExitLat = ((const uint8_t *)buf)[8] |
510 (((const uint8_t *)buf)[9] << 8);
518 buf = ((const uint8_t *)buf) + dlen;
522 return (0); /* success */
524 return (LIBUSB_ERROR_IO);
528 libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos)
537 libusb_get_bos_descriptor(libusb_device_handle *handle,
538 struct libusb_bos_descriptor **bos)
540 uint8_t bos_header[LIBUSB_DT_BOS_SIZE] = {0};
541 uint16_t wTotalLength;
545 err = libusb_get_descriptor(handle, LIBUSB_DT_BOS, 0,
546 bos_header, sizeof(bos_header));
550 wTotalLength = bos_header[2] | (bos_header[3] << 8);
551 if (wTotalLength < LIBUSB_DT_BOS_SIZE)
552 return (LIBUSB_ERROR_INVALID_PARAM);
554 bos_data = calloc(wTotalLength, 1);
555 if (bos_data == NULL)
556 return (LIBUSB_ERROR_NO_MEM);
558 err = libusb_get_descriptor(handle, LIBUSB_DT_BOS, 0,
559 bos_data, wTotalLength);
563 /* avoid descriptor length mismatches */
564 bos_data[2] = (wTotalLength & 0xFF);
565 bos_data[3] = (wTotalLength >> 8);
567 err = libusb_parse_bos_descriptor(bos_data, wTotalLength, bos);
574 libusb_get_usb_2_0_extension_descriptor(struct libusb_context *ctx,
575 struct libusb_bos_dev_capability_descriptor *dev_cap,
576 struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension)
578 struct libusb_usb_2_0_extension_descriptor *desc;
580 if (dev_cap == NULL || usb_2_0_extension == NULL ||
581 dev_cap->bDevCapabilityType != LIBUSB_BT_USB_2_0_EXTENSION)
582 return (LIBUSB_ERROR_INVALID_PARAM);
583 if (dev_cap->bLength < LIBUSB_BT_USB_2_0_EXTENSION_SIZE)
584 return (LIBUSB_ERROR_IO);
586 desc = malloc(sizeof(*desc));
588 return (LIBUSB_ERROR_NO_MEM);
590 desc->bLength = LIBUSB_BT_USB_2_0_EXTENSION_SIZE;
591 desc->bDescriptorType = dev_cap->bDescriptorType;
592 desc->bDevCapabilityType = dev_cap->bDevCapabilityType;
594 (dev_cap->dev_capability_data[0]) |
595 (dev_cap->dev_capability_data[1] << 8) |
596 (dev_cap->dev_capability_data[2] << 16) |
597 (dev_cap->dev_capability_data[3] << 24);
599 *usb_2_0_extension = desc;
604 libusb_free_usb_2_0_extension_descriptor(
605 struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension)
608 free(usb_2_0_extension);
612 libusb_get_ss_usb_device_capability_descriptor(struct libusb_context *ctx,
613 struct libusb_bos_dev_capability_descriptor *dev_cap,
614 struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_capability)
616 struct libusb_ss_usb_device_capability_descriptor *desc;
618 if (dev_cap == NULL || ss_usb_device_capability == NULL ||
619 dev_cap->bDevCapabilityType != LIBUSB_BT_SS_USB_DEVICE_CAPABILITY)
620 return (LIBUSB_ERROR_INVALID_PARAM);
621 if (dev_cap->bLength < LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE)
622 return (LIBUSB_ERROR_IO);
624 desc = malloc(sizeof(*desc));
626 return (LIBUSB_ERROR_NO_MEM);
628 desc->bLength = LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE;
629 desc->bDescriptorType = dev_cap->bDescriptorType;
630 desc->bDevCapabilityType = dev_cap->bDevCapabilityType;
631 desc->bmAttributes = dev_cap->dev_capability_data[0];
632 desc->wSpeedSupported = dev_cap->dev_capability_data[1] |
633 (dev_cap->dev_capability_data[2] << 8);
634 desc->bFunctionalitySupport = dev_cap->dev_capability_data[3];
635 desc->bU1DevExitLat = dev_cap->dev_capability_data[4];
636 desc->wU2DevExitLat = dev_cap->dev_capability_data[5] |
637 (dev_cap->dev_capability_data[6] << 8);
639 *ss_usb_device_capability = desc;
644 libusb_free_ss_usb_device_capability_descriptor(
645 struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_capability)
648 free(ss_usb_device_capability);
652 libusb_get_container_id_descriptor(struct libusb_context *ctx,
653 struct libusb_bos_dev_capability_descriptor *dev_cap,
654 struct libusb_container_id_descriptor **container_id)
656 struct libusb_container_id_descriptor *desc;
658 if (dev_cap == NULL || container_id == NULL ||
659 dev_cap->bDevCapabilityType != LIBUSB_BT_CONTAINER_ID)
660 return (LIBUSB_ERROR_INVALID_PARAM);
661 if (dev_cap->bLength < LIBUSB_BT_CONTAINER_ID_SIZE)
662 return (LIBUSB_ERROR_IO);
664 desc = malloc(sizeof(*desc));
666 return (LIBUSB_ERROR_NO_MEM);
668 desc->bLength = LIBUSB_BT_CONTAINER_ID_SIZE;
669 desc->bDescriptorType = dev_cap->bDescriptorType;
670 desc->bDevCapabilityType = dev_cap->bDevCapabilityType;
671 desc->bReserved = dev_cap->dev_capability_data[0];
672 memcpy(desc->ContainerID, dev_cap->dev_capability_data + 1,
673 sizeof(desc->ContainerID));
675 *container_id = desc;
680 libusb_free_container_id_descriptor(
681 struct libusb_container_id_descriptor *container_id)