/* $FreeBSD$ */ /*- * SPDX-License-Identifier: BSD-2-Clause-FreeBSD * * Copyright (c) 2009 Sylvestre Gallon. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #ifdef LIBUSB_GLOBAL_INCLUDE_FILE #include LIBUSB_GLOBAL_INCLUDE_FILE #else #include #include #include #include #include #endif #define libusb_device_handle libusb20_device #include "libusb20.h" #include "libusb20_desc.h" #include "libusb20_int.h" #include "libusb.h" #include "libusb10.h" #define N_ALIGN(n) (-((-(n)) & (-8UL))) /* USB descriptors */ int libusb_get_device_descriptor(libusb_device *dev, struct libusb_device_descriptor *desc) { struct LIBUSB20_DEVICE_DESC_DECODED *pdesc; struct libusb20_device *pdev; if ((dev == NULL) || (desc == NULL)) return (LIBUSB_ERROR_INVALID_PARAM); pdev = dev->os_priv; pdesc = libusb20_dev_get_device_desc(pdev); desc->bLength = pdesc->bLength; desc->bDescriptorType = pdesc->bDescriptorType; desc->bcdUSB = pdesc->bcdUSB; desc->bDeviceClass = pdesc->bDeviceClass; desc->bDeviceSubClass = pdesc->bDeviceSubClass; desc->bDeviceProtocol = pdesc->bDeviceProtocol; desc->bMaxPacketSize0 = pdesc->bMaxPacketSize0; desc->idVendor = pdesc->idVendor; desc->idProduct = pdesc->idProduct; desc->bcdDevice = pdesc->bcdDevice; desc->iManufacturer = pdesc->iManufacturer; desc->iProduct = pdesc->iProduct; desc->iSerialNumber = pdesc->iSerialNumber; desc->bNumConfigurations = pdesc->bNumConfigurations; return (0); } int libusb_get_active_config_descriptor(libusb_device *dev, struct libusb_config_descriptor **config) { struct libusb20_device *pdev; uint8_t config_index; pdev = dev->os_priv; config_index = libusb20_dev_get_config_index(pdev); return (libusb_get_config_descriptor(dev, config_index, config)); } int libusb_get_config_descriptor(libusb_device *dev, uint8_t config_index, struct libusb_config_descriptor **config) { struct libusb20_device *pdev; struct libusb20_config *pconf; struct libusb20_interface *pinf; struct libusb20_endpoint *pend; struct libusb_config_descriptor *pconfd; struct libusb_interface_descriptor *ifd; struct libusb_endpoint_descriptor *endd; uint8_t *pextra; uint16_t nextra; uint8_t nif; uint8_t nep; uint8_t nalt; uint8_t i; uint8_t j; uint8_t k; if (dev == NULL || config == NULL) return (LIBUSB_ERROR_INVALID_PARAM); *config = NULL; pdev = dev->os_priv; pconf = libusb20_dev_alloc_config(pdev, config_index); if (pconf == NULL) return (LIBUSB_ERROR_NOT_FOUND); nalt = nif = pconf->num_interface; nep = 0; nextra = N_ALIGN(pconf->extra.len); for (i = 0; i < nif; i++) { pinf = pconf->interface + i; nextra += N_ALIGN(pinf->extra.len); nep += pinf->num_endpoints; k = pinf->num_endpoints; pend = pinf->endpoints; while (k--) { nextra += N_ALIGN(pend->extra.len); pend++; } j = pinf->num_altsetting; nalt += pinf->num_altsetting; pinf = pinf->altsetting; while (j--) { nextra += N_ALIGN(pinf->extra.len); nep += pinf->num_endpoints; k = pinf->num_endpoints; pend = pinf->endpoints; while (k--) { nextra += N_ALIGN(pend->extra.len); pend++; } pinf++; } } nextra = nextra + (1 * sizeof(libusb_config_descriptor)) + (nif * sizeof(libusb_interface)) + (nalt * sizeof(libusb_interface_descriptor)) + (nep * sizeof(libusb_endpoint_descriptor)); nextra = N_ALIGN(nextra); pconfd = malloc(nextra); if (pconfd == NULL) { free(pconf); return (LIBUSB_ERROR_NO_MEM); } /* make sure memory is initialised */ memset(pconfd, 0, nextra); pconfd->interface = (libusb_interface *) (pconfd + 1); ifd = (libusb_interface_descriptor *) (pconfd->interface + nif); endd = (libusb_endpoint_descriptor *) (ifd + nalt); pextra = (uint8_t *)(endd + nep); /* fill in config descriptor */ pconfd->bLength = pconf->desc.bLength; pconfd->bDescriptorType = pconf->desc.bDescriptorType; pconfd->wTotalLength = pconf->desc.wTotalLength; pconfd->bNumInterfaces = pconf->desc.bNumInterfaces; pconfd->bConfigurationValue = pconf->desc.bConfigurationValue; pconfd->iConfiguration = pconf->desc.iConfiguration; pconfd->bmAttributes = pconf->desc.bmAttributes; pconfd->MaxPower = pconf->desc.bMaxPower; if (pconf->extra.len != 0) { pconfd->extra_length = pconf->extra.len; pconfd->extra = pextra; memcpy(pextra, pconf->extra.ptr, pconfd->extra_length); pextra += N_ALIGN(pconfd->extra_length); } /* setup all interface and endpoint pointers */ for (i = 0; i < nif; i++) { pconfd->interface[i].altsetting = ifd; ifd->endpoint = endd; endd += pconf->interface[i].num_endpoints; ifd++; for (j = 0; j < pconf->interface[i].num_altsetting; j++) { ifd->endpoint = endd; endd += pconf->interface[i].altsetting[j].num_endpoints; ifd++; } } /* fill in all interface and endpoint data */ for (i = 0; i < nif; i++) { pinf = &pconf->interface[i]; pconfd->interface[i].num_altsetting = pinf->num_altsetting + 1; for (j = 0; j < pconfd->interface[i].num_altsetting; j++) { if (j != 0) pinf = &pconf->interface[i].altsetting[j - 1]; ifd = &pconfd->interface[i].altsetting[j]; ifd->bLength = pinf->desc.bLength; ifd->bDescriptorType = pinf->desc.bDescriptorType; ifd->bInterfaceNumber = pinf->desc.bInterfaceNumber; ifd->bAlternateSetting = pinf->desc.bAlternateSetting; ifd->bNumEndpoints = pinf->desc.bNumEndpoints; ifd->bInterfaceClass = pinf->desc.bInterfaceClass; ifd->bInterfaceSubClass = pinf->desc.bInterfaceSubClass; ifd->bInterfaceProtocol = pinf->desc.bInterfaceProtocol; ifd->iInterface = pinf->desc.iInterface; if (pinf->extra.len != 0) { ifd->extra_length = pinf->extra.len; ifd->extra = pextra; memcpy(pextra, pinf->extra.ptr, pinf->extra.len); pextra += N_ALIGN(pinf->extra.len); } for (k = 0; k < pinf->num_endpoints; k++) { pend = &pinf->endpoints[k]; endd = &ifd->endpoint[k]; endd->bLength = pend->desc.bLength; endd->bDescriptorType = pend->desc.bDescriptorType; endd->bEndpointAddress = pend->desc.bEndpointAddress; endd->bmAttributes = pend->desc.bmAttributes; endd->wMaxPacketSize = pend->desc.wMaxPacketSize; endd->bInterval = pend->desc.bInterval; endd->bRefresh = pend->desc.bRefresh; endd->bSynchAddress = pend->desc.bSynchAddress; if (pend->extra.len != 0) { endd->extra_length = pend->extra.len; endd->extra = pextra; memcpy(pextra, pend->extra.ptr, pend->extra.len); pextra += N_ALIGN(pend->extra.len); } } } } free(pconf); *config = pconfd; return (0); /* success */ } int libusb_get_config_descriptor_by_value(libusb_device *dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config) { struct LIBUSB20_DEVICE_DESC_DECODED *pdesc; struct libusb20_device *pdev; int i; int err; if (dev == NULL || config == NULL) return (LIBUSB_ERROR_INVALID_PARAM); pdev = dev->os_priv; pdesc = libusb20_dev_get_device_desc(pdev); for (i = 0; i < pdesc->bNumConfigurations; i++) { err = libusb_get_config_descriptor(dev, i, config); if (err) return (err); if ((*config)->bConfigurationValue == bConfigurationValue) return (0); /* success */ libusb_free_config_descriptor(*config); } *config = NULL; return (LIBUSB_ERROR_NOT_FOUND); } void libusb_free_config_descriptor(struct libusb_config_descriptor *config) { free(config); } int libusb_get_string_descriptor(libusb_device_handle *pdev, uint8_t desc_index, uint16_t langid, unsigned char *data, int length) { if (pdev == NULL || data == NULL || length < 1) return (LIBUSB_ERROR_INVALID_PARAM); if (length > 65535) length = 65535; /* put some default data into the destination buffer */ data[0] = 0; return (libusb_control_transfer(pdev, LIBUSB_ENDPOINT_IN, LIBUSB_REQUEST_GET_DESCRIPTOR, (LIBUSB_DT_STRING << 8) | desc_index, langid, data, length, 1000)); } int libusb_get_string_descriptor_ascii(libusb_device_handle *pdev, uint8_t desc_index, unsigned char *data, int length) { if (pdev == NULL || data == NULL || length < 1) return (LIBUSB_ERROR_INVALID_PARAM); if (length > 65535) length = 65535; /* put some default data into the destination buffer */ data[0] = 0; if (libusb20_dev_req_string_simple_sync(pdev, desc_index, data, length) == 0) return (strlen((char *)data)); return (LIBUSB_ERROR_OTHER); } int libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type, uint8_t desc_index, uint8_t *data, int length) { if (devh == NULL || data == NULL || length < 1) return (LIBUSB_ERROR_INVALID_PARAM); if (length > 65535) length = 65535; return (libusb_control_transfer(devh, LIBUSB_ENDPOINT_IN, LIBUSB_REQUEST_GET_DESCRIPTOR, (desc_type << 8) | desc_index, 0, data, length, 1000)); } int libusb_parse_ss_endpoint_comp(const void *buf, int len, struct libusb_ss_endpoint_companion_descriptor **ep_comp) { if (buf == NULL || ep_comp == NULL || len < 1) return (LIBUSB_ERROR_INVALID_PARAM); if (len > 65535) len = 65535; *ep_comp = NULL; while (len != 0) { uint8_t dlen; uint8_t dtype; dlen = ((const uint8_t *)buf)[0]; dtype = ((const uint8_t *)buf)[1]; if (dlen < 2 || dlen > len) break; if (dlen >= LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE && dtype == LIBUSB_DT_SS_ENDPOINT_COMPANION) { struct libusb_ss_endpoint_companion_descriptor *ptr; ptr = malloc(sizeof(*ptr)); if (ptr == NULL) return (LIBUSB_ERROR_NO_MEM); ptr->bLength = LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE; ptr->bDescriptorType = dtype; ptr->bMaxBurst = ((const uint8_t *)buf)[2]; ptr->bmAttributes = ((const uint8_t *)buf)[3]; ptr->wBytesPerInterval = ((const uint8_t *)buf)[4] | (((const uint8_t *)buf)[5] << 8); *ep_comp = ptr; return (0); /* success */ } buf = ((const uint8_t *)buf) + dlen; len -= dlen; } return (LIBUSB_ERROR_IO); } void libusb_free_ss_endpoint_comp(struct libusb_ss_endpoint_companion_descriptor *ep_comp) { if (ep_comp == NULL) return; free(ep_comp); } int libusb_get_ss_endpoint_companion_descriptor(struct libusb_context *ctx, const struct libusb_endpoint_descriptor *endpoint, struct libusb_ss_endpoint_companion_descriptor **ep_comp) { (void)ctx; if (endpoint == NULL) return (LIBUSB_ERROR_INVALID_PARAM); return (libusb_parse_ss_endpoint_comp(endpoint->extra, endpoint->extra_length, ep_comp)); } void libusb_free_ss_endpoint_companion_descriptor(struct libusb_ss_endpoint_companion_descriptor *ep_comp) { libusb_free_ss_endpoint_comp(ep_comp); } int libusb_parse_bos_descriptor(const void *buf, int len, struct libusb_bos_descriptor **bos) { struct libusb_bos_descriptor *ptr; struct libusb_usb_2_0_device_capability_descriptor *dcap_20 = NULL; struct libusb_ss_usb_device_capability_descriptor *ss_cap = NULL; uint8_t index = 0; if (buf == NULL || bos == NULL || len < 1) return (LIBUSB_ERROR_INVALID_PARAM); if (len > 65535) len = 65535; *bos = ptr = NULL; while (len != 0) { uint8_t dlen; uint8_t dtype; dlen = ((const uint8_t *)buf)[0]; dtype = ((const uint8_t *)buf)[1]; if (dlen < 2 || dlen > len) break; if (dlen >= LIBUSB_DT_BOS_SIZE && dtype == LIBUSB_DT_BOS && ptr == NULL) { ptr = malloc(sizeof(*ptr) + sizeof(*dcap_20) + sizeof(*ss_cap)); if (ptr == NULL) return (LIBUSB_ERROR_NO_MEM); *bos = ptr; ptr->bLength = LIBUSB_DT_BOS_SIZE; ptr->bDescriptorType = dtype; ptr->wTotalLength = ((const uint8_t *)buf)[2] | (((const uint8_t *)buf)[3] << 8); ptr->bNumDeviceCapabilities = ((const uint8_t *)buf)[4]; ptr->usb_2_0_ext_cap = NULL; ptr->ss_usb_cap = NULL; ptr->dev_capability = calloc(ptr->bNumDeviceCapabilities, sizeof(void *)); if (ptr->dev_capability == NULL) { free(ptr); return (LIBUSB_ERROR_NO_MEM); } dcap_20 = (void *)(ptr + 1); ss_cap = (void *)(dcap_20 + 1); } if (dlen >= 3 && ptr != NULL && dtype == LIBUSB_DT_DEVICE_CAPABILITY) { if (index != ptr->bNumDeviceCapabilities) { ptr->dev_capability[index] = malloc(dlen); if (ptr->dev_capability[index] == NULL) { libusb_free_bos_descriptor(ptr); return LIBUSB_ERROR_NO_MEM; } memcpy(ptr->dev_capability[index], buf, dlen); index++; } switch (((const uint8_t *)buf)[2]) { case LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY: if (ptr->usb_2_0_ext_cap != NULL || dcap_20 == NULL) break; if (dlen < LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE) break; ptr->usb_2_0_ext_cap = dcap_20; dcap_20->bLength = LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE; dcap_20->bDescriptorType = dtype; dcap_20->bDevCapabilityType = ((const uint8_t *)buf)[2]; dcap_20->bmAttributes = ((const uint8_t *)buf)[3] | (((const uint8_t *)buf)[4] << 8) | (((const uint8_t *)buf)[5] << 16) | (((const uint8_t *)buf)[6] << 24); break; case LIBUSB_SS_USB_DEVICE_CAPABILITY: if (ptr->ss_usb_cap != NULL || ss_cap == NULL) break; if (dlen < LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE) break; ptr->ss_usb_cap = ss_cap; ss_cap->bLength = LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE; ss_cap->bDescriptorType = dtype; ss_cap->bDevCapabilityType = ((const uint8_t *)buf)[2]; ss_cap->bmAttributes = ((const uint8_t *)buf)[3]; ss_cap->wSpeedSupported = ((const uint8_t *)buf)[4] | (((const uint8_t *)buf)[5] << 8); ss_cap->bFunctionalitySupport = ((const uint8_t *)buf)[6]; ss_cap->bU1DevExitLat = ((const uint8_t *)buf)[7]; ss_cap->wU2DevExitLat = ((const uint8_t *)buf)[8] | (((const uint8_t *)buf)[9] << 8); break; default: break; } } buf = ((const uint8_t *)buf) + dlen; len -= dlen; } if (ptr != NULL) { ptr->bNumDeviceCapabilities = index; return (0); /* success */ } return (LIBUSB_ERROR_IO); } void libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos) { uint8_t i; if (bos == NULL) return; for (i = 0; i != bos->bNumDeviceCapabilities; i++) free(bos->dev_capability[i]); free(bos->dev_capability); free(bos); } int libusb_get_bos_descriptor(libusb_device_handle *handle, struct libusb_bos_descriptor **bos) { uint8_t bos_header[LIBUSB_DT_BOS_SIZE] = {0}; uint16_t wTotalLength; uint8_t *bos_data; int err; err = libusb_get_descriptor(handle, LIBUSB_DT_BOS, 0, bos_header, sizeof(bos_header)); if (err < 0) return (err); wTotalLength = bos_header[2] | (bos_header[3] << 8); if (wTotalLength < LIBUSB_DT_BOS_SIZE) return (LIBUSB_ERROR_INVALID_PARAM); bos_data = calloc(wTotalLength, 1); if (bos_data == NULL) return (LIBUSB_ERROR_NO_MEM); err = libusb_get_descriptor(handle, LIBUSB_DT_BOS, 0, bos_data, wTotalLength); if (err < 0) goto done; /* avoid descriptor length mismatches */ bos_data[2] = (wTotalLength & 0xFF); bos_data[3] = (wTotalLength >> 8); err = libusb_parse_bos_descriptor(bos_data, wTotalLength, bos); done: free(bos_data); return (err); } int libusb_get_usb_2_0_extension_descriptor(struct libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension) { struct libusb_usb_2_0_extension_descriptor *desc; (void)ctx; if (dev_cap == NULL || usb_2_0_extension == NULL || dev_cap->bDevCapabilityType != LIBUSB_BT_USB_2_0_EXTENSION) return (LIBUSB_ERROR_INVALID_PARAM); if (dev_cap->bLength < LIBUSB_BT_USB_2_0_EXTENSION_SIZE) return (LIBUSB_ERROR_IO); desc = malloc(sizeof(*desc)); if (desc == NULL) return (LIBUSB_ERROR_NO_MEM); desc->bLength = LIBUSB_BT_USB_2_0_EXTENSION_SIZE; desc->bDescriptorType = dev_cap->bDescriptorType; desc->bDevCapabilityType = dev_cap->bDevCapabilityType; desc->bmAttributes = (dev_cap->dev_capability_data[0]) | (dev_cap->dev_capability_data[1] << 8) | (dev_cap->dev_capability_data[2] << 16) | (dev_cap->dev_capability_data[3] << 24); *usb_2_0_extension = desc; return (0); } void libusb_free_usb_2_0_extension_descriptor( struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension) { free(usb_2_0_extension); } int libusb_get_ss_usb_device_capability_descriptor(struct libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_capability) { struct libusb_ss_usb_device_capability_descriptor *desc; (void)ctx; if (dev_cap == NULL || ss_usb_device_capability == NULL || dev_cap->bDevCapabilityType != LIBUSB_BT_SS_USB_DEVICE_CAPABILITY) return (LIBUSB_ERROR_INVALID_PARAM); if (dev_cap->bLength < LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE) return (LIBUSB_ERROR_IO); desc = malloc(sizeof(*desc)); if (desc == NULL) return (LIBUSB_ERROR_NO_MEM); desc->bLength = LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE; desc->bDescriptorType = dev_cap->bDescriptorType; desc->bDevCapabilityType = dev_cap->bDevCapabilityType; desc->bmAttributes = dev_cap->dev_capability_data[0]; desc->wSpeedSupported = dev_cap->dev_capability_data[1] | (dev_cap->dev_capability_data[2] << 8); desc->bFunctionalitySupport = dev_cap->dev_capability_data[3]; desc->bU1DevExitLat = dev_cap->dev_capability_data[4]; desc->wU2DevExitLat = dev_cap->dev_capability_data[5] | (dev_cap->dev_capability_data[6] << 8); *ss_usb_device_capability = desc; return (0); } void libusb_free_ss_usb_device_capability_descriptor( struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_capability) { free(ss_usb_device_capability); } int libusb_get_container_id_descriptor(struct libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_container_id_descriptor **container_id) { struct libusb_container_id_descriptor *desc; (void)ctx; if (dev_cap == NULL || container_id == NULL || dev_cap->bDevCapabilityType != LIBUSB_BT_CONTAINER_ID) return (LIBUSB_ERROR_INVALID_PARAM); if (dev_cap->bLength < LIBUSB_BT_CONTAINER_ID_SIZE) return (LIBUSB_ERROR_IO); desc = malloc(sizeof(*desc)); if (desc == NULL) return (LIBUSB_ERROR_NO_MEM); desc->bLength = LIBUSB_BT_CONTAINER_ID_SIZE; desc->bDescriptorType = dev_cap->bDescriptorType; desc->bDevCapabilityType = dev_cap->bDevCapabilityType; desc->bReserved = dev_cap->dev_capability_data[0]; memcpy(desc->ContainerID, dev_cap->dev_capability_data + 1, sizeof(desc->ContainerID)); *container_id = desc; return (0); } void libusb_free_container_id_descriptor( struct libusb_container_id_descriptor *container_id) { free(container_id); }