3 * SPDX-License-Identifier: BSD-2-Clause
5 * Copyright (c) 2009 Sylvestre Gallon. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #ifdef LIBUSB_GLOBAL_INCLUDE_FILE
30 #include LIBUSB_GLOBAL_INCLUDE_FILE
36 #include <sys/queue.h>
39 #define libusb_device_handle libusb20_device
42 #include "libusb20_desc.h"
43 #include "libusb20_int.h"
47 #define N_ALIGN(n) (-((-(n)) & (-8UL)))
52 libusb_get_device_descriptor(libusb_device *dev,
53 struct libusb_device_descriptor *desc)
55 struct LIBUSB20_DEVICE_DESC_DECODED *pdesc;
56 struct libusb20_device *pdev;
58 if ((dev == NULL) || (desc == NULL))
59 return (LIBUSB_ERROR_INVALID_PARAM);
62 pdesc = libusb20_dev_get_device_desc(pdev);
64 desc->bLength = pdesc->bLength;
65 desc->bDescriptorType = pdesc->bDescriptorType;
66 desc->bcdUSB = pdesc->bcdUSB;
67 desc->bDeviceClass = pdesc->bDeviceClass;
68 desc->bDeviceSubClass = pdesc->bDeviceSubClass;
69 desc->bDeviceProtocol = pdesc->bDeviceProtocol;
70 desc->bMaxPacketSize0 = pdesc->bMaxPacketSize0;
71 desc->idVendor = pdesc->idVendor;
72 desc->idProduct = pdesc->idProduct;
73 desc->bcdDevice = pdesc->bcdDevice;
74 desc->iManufacturer = pdesc->iManufacturer;
75 desc->iProduct = pdesc->iProduct;
76 desc->iSerialNumber = pdesc->iSerialNumber;
77 desc->bNumConfigurations = pdesc->bNumConfigurations;
83 libusb_get_active_config_descriptor(libusb_device *dev,
84 struct libusb_config_descriptor **config)
86 struct libusb20_device *pdev;
90 config_index = libusb20_dev_get_config_index(pdev);
92 return (libusb_get_config_descriptor(dev, config_index, config));
96 libusb_get_config_descriptor(libusb_device *dev, uint8_t config_index,
97 struct libusb_config_descriptor **config)
99 struct libusb20_device *pdev;
100 struct libusb20_config *pconf;
101 struct libusb20_interface *pinf;
102 struct libusb20_endpoint *pend;
103 struct libusb_config_descriptor *pconfd;
104 struct libusb_interface_descriptor *ifd;
105 struct libusb_endpoint_descriptor *endd;
115 if (dev == NULL || config == NULL)
116 return (LIBUSB_ERROR_INVALID_PARAM);
121 pconf = libusb20_dev_alloc_config(pdev, config_index);
124 return (LIBUSB_ERROR_NOT_FOUND);
126 nalt = nif = pconf->num_interface;
128 nextra = N_ALIGN(pconf->extra.len);
130 for (i = 0; i < nif; i++) {
132 pinf = pconf->interface + i;
133 nextra += N_ALIGN(pinf->extra.len);
134 nep += pinf->num_endpoints;
135 k = pinf->num_endpoints;
136 pend = pinf->endpoints;
138 nextra += N_ALIGN(pend->extra.len);
142 j = pinf->num_altsetting;
143 nalt += pinf->num_altsetting;
144 pinf = pinf->altsetting;
146 nextra += N_ALIGN(pinf->extra.len);
147 nep += pinf->num_endpoints;
148 k = pinf->num_endpoints;
149 pend = pinf->endpoints;
151 nextra += N_ALIGN(pend->extra.len);
159 (1 * sizeof(libusb_config_descriptor)) +
160 (nif * sizeof(libusb_interface)) +
161 (nalt * sizeof(libusb_interface_descriptor)) +
162 (nep * sizeof(libusb_endpoint_descriptor));
164 nextra = N_ALIGN(nextra);
166 pconfd = malloc(nextra);
168 if (pconfd == NULL) {
170 return (LIBUSB_ERROR_NO_MEM);
172 /* make sure memory is initialised */
173 memset(pconfd, 0, nextra);
175 pconfd->interface = (libusb_interface *) (pconfd + 1);
177 ifd = (libusb_interface_descriptor *) (pconfd->interface + nif);
178 endd = (libusb_endpoint_descriptor *) (ifd + nalt);
179 pextra = (uint8_t *)(endd + nep);
181 /* fill in config descriptor */
183 pconfd->bLength = pconf->desc.bLength;
184 pconfd->bDescriptorType = pconf->desc.bDescriptorType;
185 pconfd->wTotalLength = pconf->desc.wTotalLength;
186 pconfd->bNumInterfaces = pconf->desc.bNumInterfaces;
187 pconfd->bConfigurationValue = pconf->desc.bConfigurationValue;
188 pconfd->iConfiguration = pconf->desc.iConfiguration;
189 pconfd->bmAttributes = pconf->desc.bmAttributes;
190 pconfd->MaxPower = pconf->desc.bMaxPower;
192 if (pconf->extra.len != 0) {
193 pconfd->extra_length = pconf->extra.len;
194 pconfd->extra = pextra;
195 memcpy(pextra, pconf->extra.ptr, pconfd->extra_length);
196 pextra += N_ALIGN(pconfd->extra_length);
198 /* setup all interface and endpoint pointers */
200 for (i = 0; i < nif; i++) {
202 pconfd->interface[i].altsetting = ifd;
203 ifd->endpoint = endd;
204 endd += pconf->interface[i].num_endpoints;
207 for (j = 0; j < pconf->interface[i].num_altsetting; j++) {
208 ifd->endpoint = endd;
209 endd += pconf->interface[i].altsetting[j].num_endpoints;
214 /* fill in all interface and endpoint data */
216 for (i = 0; i < nif; i++) {
217 pinf = &pconf->interface[i];
218 pconfd->interface[i].num_altsetting = pinf->num_altsetting + 1;
219 for (j = 0; j < pconfd->interface[i].num_altsetting; j++) {
221 pinf = &pconf->interface[i].altsetting[j - 1];
222 ifd = &pconfd->interface[i].altsetting[j];
223 ifd->bLength = pinf->desc.bLength;
224 ifd->bDescriptorType = pinf->desc.bDescriptorType;
225 ifd->bInterfaceNumber = pinf->desc.bInterfaceNumber;
226 ifd->bAlternateSetting = pinf->desc.bAlternateSetting;
227 ifd->bNumEndpoints = pinf->desc.bNumEndpoints;
228 ifd->bInterfaceClass = pinf->desc.bInterfaceClass;
229 ifd->bInterfaceSubClass = pinf->desc.bInterfaceSubClass;
230 ifd->bInterfaceProtocol = pinf->desc.bInterfaceProtocol;
231 ifd->iInterface = pinf->desc.iInterface;
232 if (pinf->extra.len != 0) {
233 ifd->extra_length = pinf->extra.len;
235 memcpy(pextra, pinf->extra.ptr, pinf->extra.len);
236 pextra += N_ALIGN(pinf->extra.len);
238 for (k = 0; k < pinf->num_endpoints; k++) {
239 pend = &pinf->endpoints[k];
240 endd = &ifd->endpoint[k];
241 endd->bLength = pend->desc.bLength;
242 endd->bDescriptorType = pend->desc.bDescriptorType;
243 endd->bEndpointAddress = pend->desc.bEndpointAddress;
244 endd->bmAttributes = pend->desc.bmAttributes;
245 endd->wMaxPacketSize = pend->desc.wMaxPacketSize;
246 endd->bInterval = pend->desc.bInterval;
247 endd->bRefresh = pend->desc.bRefresh;
248 endd->bSynchAddress = pend->desc.bSynchAddress;
249 if (pend->extra.len != 0) {
250 endd->extra_length = pend->extra.len;
251 endd->extra = pextra;
252 memcpy(pextra, pend->extra.ptr, pend->extra.len);
253 pextra += N_ALIGN(pend->extra.len);
263 return (0); /* success */
267 libusb_get_config_descriptor_by_value(libusb_device *dev,
268 uint8_t bConfigurationValue, struct libusb_config_descriptor **config)
270 struct LIBUSB20_DEVICE_DESC_DECODED *pdesc;
271 struct libusb20_device *pdev;
275 if (dev == NULL || config == NULL)
276 return (LIBUSB_ERROR_INVALID_PARAM);
279 pdesc = libusb20_dev_get_device_desc(pdev);
281 for (i = 0; i < pdesc->bNumConfigurations; i++) {
282 err = libusb_get_config_descriptor(dev, i, config);
286 if ((*config)->bConfigurationValue == bConfigurationValue)
287 return (0); /* success */
289 libusb_free_config_descriptor(*config);
294 return (LIBUSB_ERROR_NOT_FOUND);
298 libusb_free_config_descriptor(struct libusb_config_descriptor *config)
304 libusb_get_string_descriptor(libusb_device_handle *pdev,
305 uint8_t desc_index, uint16_t langid, unsigned char *data,
308 if (pdev == NULL || data == NULL || length < 1)
309 return (LIBUSB_ERROR_INVALID_PARAM);
314 /* put some default data into the destination buffer */
317 return (libusb_control_transfer(pdev, LIBUSB_ENDPOINT_IN,
318 LIBUSB_REQUEST_GET_DESCRIPTOR, (LIBUSB_DT_STRING << 8) | desc_index,
319 langid, data, length, 1000));
323 libusb_get_string_descriptor_ascii(libusb_device_handle *pdev,
324 uint8_t desc_index, unsigned char *data, int length)
326 if (pdev == NULL || data == NULL || length < 1)
327 return (LIBUSB_ERROR_INVALID_PARAM);
332 /* put some default data into the destination buffer */
335 if (libusb20_dev_req_string_simple_sync(pdev, desc_index,
337 return (strlen((char *)data));
339 return (LIBUSB_ERROR_OTHER);
343 libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type,
344 uint8_t desc_index, uint8_t *data, int length)
346 if (devh == NULL || data == NULL || length < 1)
347 return (LIBUSB_ERROR_INVALID_PARAM);
352 return (libusb_control_transfer(devh, LIBUSB_ENDPOINT_IN,
353 LIBUSB_REQUEST_GET_DESCRIPTOR, (desc_type << 8) | desc_index, 0, data,
358 libusb_parse_ss_endpoint_comp(const void *buf, int len,
359 struct libusb_ss_endpoint_companion_descriptor **ep_comp)
361 if (buf == NULL || ep_comp == NULL || len < 1)
362 return (LIBUSB_ERROR_INVALID_PARAM);
373 dlen = ((const uint8_t *)buf)[0];
374 dtype = ((const uint8_t *)buf)[1];
376 if (dlen < 2 || dlen > len)
379 if (dlen >= LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE &&
380 dtype == LIBUSB_DT_SS_ENDPOINT_COMPANION) {
381 struct libusb_ss_endpoint_companion_descriptor *ptr;
383 ptr = malloc(sizeof(*ptr));
385 return (LIBUSB_ERROR_NO_MEM);
387 ptr->bLength = LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE;
388 ptr->bDescriptorType = dtype;
389 ptr->bMaxBurst = ((const uint8_t *)buf)[2];
390 ptr->bmAttributes = ((const uint8_t *)buf)[3];
391 ptr->wBytesPerInterval = ((const uint8_t *)buf)[4] |
392 (((const uint8_t *)buf)[5] << 8);
396 return (0); /* success */
399 buf = ((const uint8_t *)buf) + dlen;
402 return (LIBUSB_ERROR_IO);
406 libusb_free_ss_endpoint_comp(struct libusb_ss_endpoint_companion_descriptor *ep_comp)
415 libusb_get_ss_endpoint_companion_descriptor(struct libusb_context *ctx,
416 const struct libusb_endpoint_descriptor *endpoint,
417 struct libusb_ss_endpoint_companion_descriptor **ep_comp)
419 if (endpoint == NULL)
420 return (LIBUSB_ERROR_INVALID_PARAM);
421 return (libusb_parse_ss_endpoint_comp(endpoint->extra, endpoint->extra_length, ep_comp));
425 libusb_free_ss_endpoint_companion_descriptor(struct libusb_ss_endpoint_companion_descriptor *ep_comp)
428 libusb_free_ss_endpoint_comp(ep_comp);
432 libusb_parse_bos_descriptor(const void *buf, int len,
433 struct libusb_bos_descriptor **bos)
435 struct libusb_bos_descriptor *ptr;
436 struct libusb_usb_2_0_device_capability_descriptor *dcap_20 = NULL;
437 struct libusb_ss_usb_device_capability_descriptor *ss_cap = NULL;
440 if (buf == NULL || bos == NULL || len < 1)
441 return (LIBUSB_ERROR_INVALID_PARAM);
452 dlen = ((const uint8_t *)buf)[0];
453 dtype = ((const uint8_t *)buf)[1];
455 if (dlen < 2 || dlen > len)
458 if (dlen >= LIBUSB_DT_BOS_SIZE &&
459 dtype == LIBUSB_DT_BOS &&
462 ptr = malloc(sizeof(*ptr) + sizeof(*dcap_20) +
466 return (LIBUSB_ERROR_NO_MEM);
470 ptr->bLength = LIBUSB_DT_BOS_SIZE;
471 ptr->bDescriptorType = dtype;
472 ptr->wTotalLength = ((const uint8_t *)buf)[2] |
473 (((const uint8_t *)buf)[3] << 8);
474 ptr->bNumDeviceCapabilities = ((const uint8_t *)buf)[4];
475 ptr->usb_2_0_ext_cap = NULL;
476 ptr->ss_usb_cap = NULL;
477 ptr->dev_capability = calloc(ptr->bNumDeviceCapabilities, sizeof(void *));
478 if (ptr->dev_capability == NULL) {
480 return (LIBUSB_ERROR_NO_MEM);
483 dcap_20 = (void *)(ptr + 1);
484 ss_cap = (void *)(dcap_20 + 1);
488 dtype == LIBUSB_DT_DEVICE_CAPABILITY) {
489 if (index != ptr->bNumDeviceCapabilities) {
490 ptr->dev_capability[index] = malloc(dlen);
491 if (ptr->dev_capability[index] == NULL) {
492 libusb_free_bos_descriptor(ptr);
493 return LIBUSB_ERROR_NO_MEM;
495 memcpy(ptr->dev_capability[index], buf, dlen);
498 switch (((const uint8_t *)buf)[2]) {
499 case LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY:
500 if (ptr->usb_2_0_ext_cap != NULL || dcap_20 == NULL)
502 if (dlen < LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE)
505 ptr->usb_2_0_ext_cap = dcap_20;
507 dcap_20->bLength = LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE;
508 dcap_20->bDescriptorType = dtype;
509 dcap_20->bDevCapabilityType = ((const uint8_t *)buf)[2];
510 dcap_20->bmAttributes = ((const uint8_t *)buf)[3] |
511 (((const uint8_t *)buf)[4] << 8) |
512 (((const uint8_t *)buf)[5] << 16) |
513 (((const uint8_t *)buf)[6] << 24);
516 case LIBUSB_SS_USB_DEVICE_CAPABILITY:
517 if (ptr->ss_usb_cap != NULL || ss_cap == NULL)
519 if (dlen < LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE)
522 ptr->ss_usb_cap = ss_cap;
524 ss_cap->bLength = LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE;
525 ss_cap->bDescriptorType = dtype;
526 ss_cap->bDevCapabilityType = ((const uint8_t *)buf)[2];
527 ss_cap->bmAttributes = ((const uint8_t *)buf)[3];
528 ss_cap->wSpeedSupported = ((const uint8_t *)buf)[4] |
529 (((const uint8_t *)buf)[5] << 8);
530 ss_cap->bFunctionalitySupport = ((const uint8_t *)buf)[6];
531 ss_cap->bU1DevExitLat = ((const uint8_t *)buf)[7];
532 ss_cap->wU2DevExitLat = ((const uint8_t *)buf)[8] |
533 (((const uint8_t *)buf)[9] << 8);
541 buf = ((const uint8_t *)buf) + dlen;
546 ptr->bNumDeviceCapabilities = index;
547 return (0); /* success */
550 return (LIBUSB_ERROR_IO);
554 libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos)
561 for (i = 0; i != bos->bNumDeviceCapabilities; i++)
562 free(bos->dev_capability[i]);
563 free(bos->dev_capability);
568 libusb_get_bos_descriptor(libusb_device_handle *handle,
569 struct libusb_bos_descriptor **bos)
571 uint8_t bos_header[LIBUSB_DT_BOS_SIZE] = {0};
572 uint16_t wTotalLength;
576 err = libusb_get_descriptor(handle, LIBUSB_DT_BOS, 0,
577 bos_header, sizeof(bos_header));
581 wTotalLength = bos_header[2] | (bos_header[3] << 8);
582 if (wTotalLength < LIBUSB_DT_BOS_SIZE)
583 return (LIBUSB_ERROR_INVALID_PARAM);
585 bos_data = calloc(wTotalLength, 1);
586 if (bos_data == NULL)
587 return (LIBUSB_ERROR_NO_MEM);
589 err = libusb_get_descriptor(handle, LIBUSB_DT_BOS, 0,
590 bos_data, wTotalLength);
594 /* avoid descriptor length mismatches */
595 bos_data[2] = (wTotalLength & 0xFF);
596 bos_data[3] = (wTotalLength >> 8);
598 err = libusb_parse_bos_descriptor(bos_data, wTotalLength, bos);
605 libusb_get_usb_2_0_extension_descriptor(struct libusb_context *ctx,
606 struct libusb_bos_dev_capability_descriptor *dev_cap,
607 struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension)
609 struct libusb_usb_2_0_extension_descriptor *desc;
611 if (dev_cap == NULL || usb_2_0_extension == NULL ||
612 dev_cap->bDevCapabilityType != LIBUSB_BT_USB_2_0_EXTENSION)
613 return (LIBUSB_ERROR_INVALID_PARAM);
614 if (dev_cap->bLength < LIBUSB_BT_USB_2_0_EXTENSION_SIZE)
615 return (LIBUSB_ERROR_IO);
617 desc = malloc(sizeof(*desc));
619 return (LIBUSB_ERROR_NO_MEM);
621 desc->bLength = LIBUSB_BT_USB_2_0_EXTENSION_SIZE;
622 desc->bDescriptorType = dev_cap->bDescriptorType;
623 desc->bDevCapabilityType = dev_cap->bDevCapabilityType;
625 (dev_cap->dev_capability_data[0]) |
626 (dev_cap->dev_capability_data[1] << 8) |
627 (dev_cap->dev_capability_data[2] << 16) |
628 (dev_cap->dev_capability_data[3] << 24);
630 *usb_2_0_extension = desc;
635 libusb_free_usb_2_0_extension_descriptor(
636 struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension)
639 free(usb_2_0_extension);
643 libusb_get_ss_usb_device_capability_descriptor(struct libusb_context *ctx,
644 struct libusb_bos_dev_capability_descriptor *dev_cap,
645 struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_capability)
647 struct libusb_ss_usb_device_capability_descriptor *desc;
649 if (dev_cap == NULL || ss_usb_device_capability == NULL ||
650 dev_cap->bDevCapabilityType != LIBUSB_BT_SS_USB_DEVICE_CAPABILITY)
651 return (LIBUSB_ERROR_INVALID_PARAM);
652 if (dev_cap->bLength < LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE)
653 return (LIBUSB_ERROR_IO);
655 desc = malloc(sizeof(*desc));
657 return (LIBUSB_ERROR_NO_MEM);
659 desc->bLength = LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE;
660 desc->bDescriptorType = dev_cap->bDescriptorType;
661 desc->bDevCapabilityType = dev_cap->bDevCapabilityType;
662 desc->bmAttributes = dev_cap->dev_capability_data[0];
663 desc->wSpeedSupported = dev_cap->dev_capability_data[1] |
664 (dev_cap->dev_capability_data[2] << 8);
665 desc->bFunctionalitySupport = dev_cap->dev_capability_data[3];
666 desc->bU1DevExitLat = dev_cap->dev_capability_data[4];
667 desc->wU2DevExitLat = dev_cap->dev_capability_data[5] |
668 (dev_cap->dev_capability_data[6] << 8);
670 *ss_usb_device_capability = desc;
675 libusb_free_ss_usb_device_capability_descriptor(
676 struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_capability)
679 free(ss_usb_device_capability);
683 libusb_get_container_id_descriptor(struct libusb_context *ctx,
684 struct libusb_bos_dev_capability_descriptor *dev_cap,
685 struct libusb_container_id_descriptor **container_id)
687 struct libusb_container_id_descriptor *desc;
689 if (dev_cap == NULL || container_id == NULL ||
690 dev_cap->bDevCapabilityType != LIBUSB_BT_CONTAINER_ID)
691 return (LIBUSB_ERROR_INVALID_PARAM);
692 if (dev_cap->bLength < LIBUSB_BT_CONTAINER_ID_SIZE)
693 return (LIBUSB_ERROR_IO);
695 desc = malloc(sizeof(*desc));
697 return (LIBUSB_ERROR_NO_MEM);
699 desc->bLength = LIBUSB_BT_CONTAINER_ID_SIZE;
700 desc->bDescriptorType = dev_cap->bDescriptorType;
701 desc->bDevCapabilityType = dev_cap->bDevCapabilityType;
702 desc->bReserved = dev_cap->dev_capability_data[0];
703 memcpy(desc->ContainerID, dev_cap->dev_capability_data + 1,
704 sizeof(desc->ContainerID));
706 *container_id = desc;
711 libusb_free_container_id_descriptor(
712 struct libusb_container_id_descriptor *container_id)