/** \ingroup desc * Get the USB configuration descriptor for the currently active configuration. * This is a non-blocking function which does not involve any requests being * sent to the device. * * \param dev a device * \param config output location for the USB configuration descriptor. Only * valid if 0 was returned. Must be freed with libusb_free_config_descriptor() * after use. * \returns 0 on success * \returns LIBUSB_ERROR_NOT_FOUND if the device is in unconfigured state * \returns another LIBUSB_ERROR code on error * \see libusb_get_config_descriptor */ int API_EXPORTED libusb_get_active_config_descriptor(libusb_device *dev, struct libusb_config_descriptor **config) { struct libusb_config_descriptor _config; unsigned char tmp[LIBUSB_DT_CONFIG_SIZE]; unsigned char *buf = NULL; int host_endian = 0; int r; r = usbi_backend->get_active_config_descriptor(dev, tmp, LIBUSB_DT_CONFIG_SIZE, &host_endian); if (r < 0) return r; if (r < LIBUSB_DT_CONFIG_SIZE) { usbi_err(dev->ctx, "short config descriptor read %d/%d", r, LIBUSB_DT_CONFIG_SIZE); return LIBUSB_ERROR_IO; } usbi_parse_descriptor(tmp, "bbw", &_config, host_endian); buf = malloc(_config.wTotalLength); if (!buf) return LIBUSB_ERROR_NO_MEM; r = usbi_backend->get_active_config_descriptor(dev, buf, _config.wTotalLength, &host_endian); if (r >= 0) r = raw_desc_to_config(dev->ctx, buf, r, host_endian, config); free(buf); return r; }
/** \ingroup desc * Get an USB 2.0 Extension descriptor * * \param ctx the context to operate on, or NULL for the default context * \param dev_cap Device Capability descriptor with a bDevCapabilityType of * \ref libusb_capability_type::LIBUSB_BT_USB_2_0_EXTENSION * LIBUSB_BT_USB_2_0_EXTENSION * \param usb_2_0_extension output location for the USB 2.0 Extension * descriptor. Only valid if 0 was returned. Must be freed with * libusb_free_usb_2_0_extension_descriptor() after use. * \returns 0 on success * \returns a LIBUSB_ERROR code on error */ int API_EXPORTED 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 *_usb_2_0_extension; const int host_endian = 0; if (dev_cap->bDevCapabilityType != LIBUSB_BT_USB_2_0_EXTENSION) { usbi_err(ctx, "unexpected bDevCapabilityType %x (expected %x)", 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) { usbi_err(ctx, "short dev-cap descriptor read %d/%d", dev_cap->bLength, LIBUSB_BT_USB_2_0_EXTENSION_SIZE); return LIBUSB_ERROR_IO; } _usb_2_0_extension = malloc(sizeof(*_usb_2_0_extension)); if (!_usb_2_0_extension) return LIBUSB_ERROR_NO_MEM; usbi_parse_descriptor((unsigned char *)dev_cap, "bbbd", _usb_2_0_extension, host_endian); *usb_2_0_extension = _usb_2_0_extension; return LIBUSB_SUCCESS; }
/** \ingroup desc * Get a Container ID descriptor * * \param ctx the context to operate on, or NULL for the default context * \param dev_cap Device Capability descriptor with a bDevCapabilityType of * \ref libusb_capability_type::LIBUSB_BT_CONTAINER_ID * LIBUSB_BT_CONTAINER_ID * \param container_id output location for the Container ID descriptor. * Only valid if 0 was returned. Must be freed with * libusb_free_container_id_descriptor() after use. * \returns 0 on success * \returns a LIBUSB_ERROR code on error */ int API_EXPORTED 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 *_container_id; const int host_endian = 0; if (dev_cap->bDevCapabilityType != LIBUSB_BT_CONTAINER_ID) { usbi_err(ctx, "unexpected bDevCapabilityType %x (expected %x)", dev_cap->bDevCapabilityType, LIBUSB_BT_CONTAINER_ID); return LIBUSB_ERROR_INVALID_PARAM; } if (dev_cap->bLength < LIBUSB_BT_CONTAINER_ID_SIZE) { usbi_err(ctx, "short dev-cap descriptor read %d/%d", dev_cap->bLength, LIBUSB_BT_CONTAINER_ID_SIZE); return LIBUSB_ERROR_IO; } _container_id = malloc(sizeof(*_container_id)); if (!_container_id) return LIBUSB_ERROR_NO_MEM; usbi_parse_descriptor((unsigned char *)dev_cap, "bbbbu", _container_id, host_endian); *container_id = _container_id; return LIBUSB_SUCCESS; }
/** \ingroup desc * Get a SuperSpeed USB Device Capability descriptor * * \param ctx the context to operate on, or NULL for the default context * \param dev_cap Device Capability descriptor with a bDevCapabilityType of * \ref libusb_capability_type::LIBUSB_BT_SS_USB_DEVICE_CAPABILITY * LIBUSB_BT_SS_USB_DEVICE_CAPABILITY * \param ss_usb_device_cap output location for the SuperSpeed USB Device * Capability descriptor. Only valid if 0 was returned. Must be freed with * libusb_free_ss_usb_device_capability_descriptor() after use. * \returns 0 on success * \returns a LIBUSB_ERROR code on error */ int API_EXPORTED 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_cap) { struct libusb_ss_usb_device_capability_descriptor *_ss_usb_device_cap; const int host_endian = 0; if (dev_cap->bDevCapabilityType != LIBUSB_BT_SS_USB_DEVICE_CAPABILITY) { usbi_err(ctx, "unexpected bDevCapabilityType %x (expected %x)", 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) { usbi_err(ctx, "short dev-cap descriptor read %d/%d", dev_cap->bLength, LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE); return LIBUSB_ERROR_IO; } _ss_usb_device_cap = malloc(sizeof(*_ss_usb_device_cap)); if (!_ss_usb_device_cap) return LIBUSB_ERROR_NO_MEM; usbi_parse_descriptor((unsigned char *)dev_cap, "bbbbwbbw", _ss_usb_device_cap, host_endian); *ss_usb_device_cap = _ss_usb_device_cap; return LIBUSB_SUCCESS; }
/** \ingroup desc * Get a USB configuration descriptor based on its index. * This is a non-blocking function which does not involve any requests being * sent to the device. * * \param dev a device * \param config_index the index of the configuration you wish to retrieve * \param config output location for the USB configuration descriptor. Only * valid if 0 was returned. Must be freed with libusb_free_config_descriptor() * after use. * \returns 0 on success * \returns LIBUSB_ERROR_NOT_FOUND if the configuration does not exist * \returns another LIBUSB_ERROR code on error * \see libusb_get_active_config_descriptor() * \see libusb_get_config_descriptor_by_value() */ int API_EXPORTED libusb_get_config_descriptor(libusb_device *dev, uint8_t config_index, struct libusb_config_descriptor **config) { struct libusb_config_descriptor *_config; unsigned char tmp[8]; unsigned char *buf = NULL; int host_endian = 0; int r; usbi_dbg("index %d", config_index); if (config_index >= dev->num_configurations) return LIBUSB_ERROR_NOT_FOUND; _config = malloc(sizeof(*_config)); if (!_config) return LIBUSB_ERROR_NO_MEM; r = usbi_backend->get_config_descriptor(dev, config_index, tmp, sizeof(tmp), &host_endian); if (r < 0) goto err; usbi_parse_descriptor(tmp, "bbw", _config, host_endian); buf = malloc(_config->wTotalLength); if (!buf) { r = LIBUSB_ERROR_NO_MEM; goto err; } host_endian = 0; r = usbi_backend->get_config_descriptor(dev, config_index, buf, _config->wTotalLength, &host_endian); if (r < 0) goto err; r = parse_configuration(dev->ctx, _config, buf, host_endian); if (r < 0) { usbi_err(dev->ctx, "parse_configuration failed with error %d", r); goto err; } else if (r > 0) { usbi_warn(dev->ctx, "descriptor data still left"); } free(buf); *config = _config; return 0; err: free(_config); if (buf) free(buf); return r; }
/** \ingroup desc * Get an endpoints superspeed endpoint companion descriptor (if any) * * \param ctx the context to operate on, or NULL for the default context * \param endpoint endpoint descriptor from which to get the superspeed * endpoint companion descriptor * \param ep_comp output location for the superspeed endpoint companion * descriptor. Only valid if 0 was returned. Must be freed with * libusb_free_ss_endpoint_companion_descriptor() after use. * \returns 0 on success * \returns LIBUSB_ERROR_NOT_FOUND if the configuration does not exist * \returns another LIBUSB_ERROR code on error */ int API_EXPORTED libusb_get_ss_endpoint_companion_descriptor( struct libusb_context *ctx, const struct libusb_endpoint_descriptor *endpoint, struct libusb_ss_endpoint_companion_descriptor **ep_comp) { struct usb_descriptor_header header; int size = endpoint->extra_length; const unsigned char *buffer = endpoint->extra; *ep_comp = NULL; while (size >= DESC_HEADER_LENGTH) { usbi_parse_descriptor(buffer, "bb", &header, 0); if (header.bLength < 2 || header.bLength > size) { usbi_err(ctx, "invalid descriptor length %d", header.bLength); return LIBUSB_ERROR_IO; } if (header.bDescriptorType != LIBUSB_DT_SS_ENDPOINT_COMPANION) { buffer += header.bLength; size -= header.bLength; continue; } if (header.bLength < LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE) { usbi_err(ctx, "invalid ss-ep-comp-desc length %d", header.bLength); return LIBUSB_ERROR_IO; } *ep_comp = malloc(sizeof(**ep_comp)); if (*ep_comp == NULL) return LIBUSB_ERROR_NO_MEM; usbi_parse_descriptor(buffer, "bbbbw", *ep_comp, 0); return LIBUSB_SUCCESS; } return LIBUSB_ERROR_NOT_FOUND; }
/** \ingroup desc * Get a Binary Object Store (BOS) descriptor * This is a BLOCKING function, which will send requests to the device. * * \param handle the handle of an open libusb device * \param bos output location for the BOS descriptor. Only valid if 0 was returned. * Must be freed with \ref libusb_free_bos_descriptor() after use. * \returns 0 on success * \returns LIBUSB_ERROR_NOT_FOUND if the device doesn't have a BOS descriptor * \returns another LIBUSB_ERROR code on error */ int API_EXPORTED libusb_get_bos_descriptor(libusb_device_handle *handle, struct libusb_bos_descriptor **bos) { struct libusb_bos_descriptor _bos; uint8_t bos_header[LIBUSB_DT_BOS_SIZE] = {0}; unsigned char *bos_data = NULL; const int host_endian = 0; int r; /* Read the BOS. This generates 2 requests on the bus, * one for the header, and one for the full BOS */ r = libusb_get_descriptor(handle, LIBUSB_DT_BOS, 0, bos_header, LIBUSB_DT_BOS_SIZE); if (r < 0) { if (r != LIBUSB_ERROR_PIPE) usbi_err(handle->dev->ctx, "failed to read BOS (%d)", r); return r; } if (r < LIBUSB_DT_BOS_SIZE) { usbi_err(handle->dev->ctx, "short BOS read %d/%d", r, LIBUSB_DT_BOS_SIZE); return LIBUSB_ERROR_IO; } usbi_parse_descriptor(bos_header, "bbwb", &_bos, host_endian); usbi_dbg("found BOS descriptor: size %d bytes, %d capabilities", _bos.wTotalLength, _bos.bNumDeviceCaps); bos_data = calloc(_bos.wTotalLength, 1); if (bos_data == NULL) return LIBUSB_ERROR_NO_MEM; r = libusb_get_descriptor(handle, LIBUSB_DT_BOS, 0, bos_data, _bos.wTotalLength); if (r >= 0) r = parse_bos(handle->dev->ctx, bos, bos_data, r, host_endian); else usbi_err(handle->dev->ctx, "failed to read BOS (%d)", r); free(bos_data); return r; }
static int parse_endpoint(struct libusb_context *ctx, struct libusb_endpoint_descriptor *endpoint, unsigned char *buffer, int size, int host_endian) { struct usb_descriptor_header header; unsigned char *extra; unsigned char *begin; int parsed = 0; int len; usbi_parse_descriptor(buffer, "bb", &header, 0); /* Everything should be fine being passed into here, but we sanity */ /* check JIC */ if (header.bLength > size) { usbi_err(ctx, "ran out of descriptors parsing"); return -1; } if (header.bDescriptorType != LIBUSB_DT_ENDPOINT) { usbi_err(ctx, "unexpected descriptor %x (expected %x)", header.bDescriptorType, LIBUSB_DT_ENDPOINT); return parsed; } if (header.bLength >= ENDPOINT_AUDIO_DESC_LENGTH) usbi_parse_descriptor(buffer, "bbbbwbbb", endpoint, host_endian); else if (header.bLength >= ENDPOINT_DESC_LENGTH) usbi_parse_descriptor(buffer, "bbbbwb", endpoint, host_endian); buffer += header.bLength; size -= header.bLength; parsed += header.bLength; /* Skip over the rest of the Class Specific or Vendor Specific */ /* descriptors */ begin = buffer; while (size >= DESC_HEADER_LENGTH) { usbi_parse_descriptor(buffer, "bb", &header, 0); if (header.bLength < 2) { usbi_err(ctx, "invalid descriptor length %d", header.bLength); return -1; } /* If we find another "proper" descriptor then we're done */ if ((header.bDescriptorType == LIBUSB_DT_ENDPOINT) || (header.bDescriptorType == LIBUSB_DT_INTERFACE) || (header.bDescriptorType == LIBUSB_DT_CONFIG) || (header.bDescriptorType == LIBUSB_DT_DEVICE)) break; usbi_dbg("skipping descriptor %x", header.bDescriptorType); buffer += header.bLength; size -= header.bLength; parsed += header.bLength; } /* Copy any unknown descriptors into a storage area for drivers */ /* to later parse */ len = (int)(buffer - begin); if (!len) { endpoint->extra = NULL; endpoint->extra_length = 0; return parsed; } extra = malloc(len); endpoint->extra = extra; if (!extra) { endpoint->extra_length = 0; return LIBUSB_ERROR_NO_MEM; } memcpy(extra, begin, len); endpoint->extra_length = len; return parsed; }
static int parse_configuration(struct libusb_context *ctx, struct libusb_config_descriptor *config, unsigned char *buffer, int host_endian) { int i; int r; int size; int tmp; struct usb_descriptor_header header; struct libusb_interface *usb_interface; usbi_parse_descriptor(buffer, "bbwbbbbb", config, host_endian); size = config->wTotalLength; if (config->bNumInterfaces > USB_MAXINTERFACES) { usbi_err(ctx, "too many interfaces (%d)", config->bNumInterfaces); return LIBUSB_ERROR_IO; } tmp = config->bNumInterfaces * sizeof(struct libusb_interface); usb_interface = malloc(tmp); config->interface = usb_interface; if (!config->interface) return LIBUSB_ERROR_NO_MEM; memset(usb_interface, 0, tmp); buffer += config->bLength; size -= config->bLength; config->extra = NULL; config->extra_length = 0; for (i = 0; i < config->bNumInterfaces; i++) { int len; unsigned char *begin; /* Skip over the rest of the Class Specific or Vendor */ /* Specific descriptors */ begin = buffer; while (size >= DESC_HEADER_LENGTH) { usbi_parse_descriptor(buffer, "bb", &header, 0); if ((header.bLength > size) || (header.bLength < DESC_HEADER_LENGTH)) { usbi_err(ctx, "invalid descriptor length of %d", header.bLength); r = LIBUSB_ERROR_IO; goto err; } /* If we find another "proper" descriptor then we're done */ if ((header.bDescriptorType == LIBUSB_DT_ENDPOINT) || (header.bDescriptorType == LIBUSB_DT_INTERFACE) || (header.bDescriptorType == LIBUSB_DT_CONFIG) || (header.bDescriptorType == LIBUSB_DT_DEVICE)) break; usbi_dbg("skipping descriptor 0x%x\n", header.bDescriptorType); buffer += header.bLength; size -= header.bLength; } /* Copy any unknown descriptors into a storage area for */ /* drivers to later parse */ len = (int)(buffer - begin); if (len) { /* FIXME: We should realloc and append here */ if (!config->extra_length) { config->extra = malloc(len); if (!config->extra) { r = LIBUSB_ERROR_NO_MEM; goto err; } memcpy((unsigned char *) config->extra, begin, len); config->extra_length = len; } } r = parse_interface(ctx, usb_interface + i, buffer, size, host_endian); if (r < 0) goto err; buffer += r; size -= r; } return size; err: clear_configuration(config); return r; }
static int parse_interface(libusb_context *ctx, struct libusb_interface *usb_interface, unsigned char *buffer, int size, int host_endian) { int i; int len; int r; int parsed = 0; int tmp; struct usb_descriptor_header header; struct libusb_interface_descriptor *ifp; unsigned char *begin; usb_interface->num_altsetting = 0; while (size >= INTERFACE_DESC_LENGTH) { struct libusb_interface_descriptor *altsetting = (struct libusb_interface_descriptor *) usb_interface->altsetting; altsetting = realloc(altsetting, sizeof(struct libusb_interface_descriptor) * (usb_interface->num_altsetting + 1)); if (!altsetting) { r = LIBUSB_ERROR_NO_MEM; goto err; } usb_interface->altsetting = altsetting; ifp = altsetting + usb_interface->num_altsetting; usb_interface->num_altsetting++; usbi_parse_descriptor(buffer, "bbbbbbbbb", ifp, 0); ifp->extra = NULL; ifp->extra_length = 0; ifp->endpoint = NULL; /* Skip over the interface */ buffer += ifp->bLength; parsed += ifp->bLength; size -= ifp->bLength; begin = buffer; /* Skip over any interface, class or vendor descriptors */ while (size >= DESC_HEADER_LENGTH) { usbi_parse_descriptor(buffer, "bb", &header, 0); if (header.bLength < 2) { usbi_err(ctx, "invalid descriptor of length %d", header.bLength); r = LIBUSB_ERROR_IO; goto err; } /* If we find another "proper" descriptor then we're done */ if ((header.bDescriptorType == LIBUSB_DT_INTERFACE) || (header.bDescriptorType == LIBUSB_DT_ENDPOINT) || (header.bDescriptorType == LIBUSB_DT_CONFIG) || (header.bDescriptorType == LIBUSB_DT_DEVICE)) break; buffer += header.bLength; parsed += header.bLength; size -= header.bLength; } /* Copy any unknown descriptors into a storage area for */ /* drivers to later parse */ len = (int)(buffer - begin); if (len) { ifp->extra = malloc(len); if (!ifp->extra) { r = LIBUSB_ERROR_NO_MEM; goto err; } memcpy((unsigned char *) ifp->extra, begin, len); ifp->extra_length = len; } /* Did we hit an unexpected descriptor? */ usbi_parse_descriptor(buffer, "bb", &header, 0); if ((size >= DESC_HEADER_LENGTH) && ((header.bDescriptorType == LIBUSB_DT_CONFIG) || (header.bDescriptorType == LIBUSB_DT_DEVICE))) return parsed; if (ifp->bNumEndpoints > USB_MAXENDPOINTS) { usbi_err(ctx, "too many endpoints (%d)", ifp->bNumEndpoints); r = LIBUSB_ERROR_IO; goto err; } if (ifp->bNumEndpoints > 0) { struct libusb_endpoint_descriptor *endpoint; tmp = ifp->bNumEndpoints * sizeof(struct libusb_endpoint_descriptor); endpoint = malloc(tmp); ifp->endpoint = endpoint; if (!endpoint) { r = LIBUSB_ERROR_NO_MEM; goto err; } memset(endpoint, 0, tmp); for (i = 0; i < ifp->bNumEndpoints; i++) { usbi_parse_descriptor(buffer, "bb", &header, 0); if (header.bLength > size) { usbi_err(ctx, "ran out of descriptors parsing"); r = LIBUSB_ERROR_IO; goto err; } r = parse_endpoint(ctx, endpoint + i, buffer, size, host_endian); if (r < 0) goto err; buffer += r; parsed += r; size -= r; } } /* We check to see if it's an alternate to this one */ ifp = (struct libusb_interface_descriptor *) buffer; if (size < LIBUSB_DT_INTERFACE_SIZE || ifp->bDescriptorType != LIBUSB_DT_INTERFACE || !ifp->bAlternateSetting) return parsed; } return parsed; err: clear_interface(usb_interface); return r; }
static int parse_bos(struct libusb_context *ctx, struct libusb_bos_descriptor **bos, unsigned char *buffer, int size, int host_endian) { struct libusb_bos_descriptor bos_header, *_bos; struct libusb_bos_dev_capability_descriptor dev_cap; int i; if (size < LIBUSB_DT_BOS_SIZE) { usbi_err(ctx, "short bos descriptor read %d/%d", size, LIBUSB_DT_BOS_SIZE); return LIBUSB_ERROR_IO; } usbi_parse_descriptor(buffer, "bbwb", &bos_header, host_endian); if (bos_header.bDescriptorType != LIBUSB_DT_BOS) { usbi_err(ctx, "unexpected descriptor %x (expected %x)", bos_header.bDescriptorType, LIBUSB_DT_BOS); return LIBUSB_ERROR_IO; } if (bos_header.bLength < LIBUSB_DT_BOS_SIZE) { usbi_err(ctx, "invalid bos bLength (%d)", bos_header.bLength); return LIBUSB_ERROR_IO; } if (bos_header.bLength > size) { usbi_err(ctx, "short bos descriptor read %d/%d", size, bos_header.bLength); return LIBUSB_ERROR_IO; } _bos = calloc (1, sizeof(*_bos) + bos_header.bNumDeviceCaps * sizeof(void *)); if (!_bos) return LIBUSB_ERROR_NO_MEM; usbi_parse_descriptor(buffer, "bbwb", _bos, host_endian); buffer += bos_header.bLength; size -= bos_header.bLength; /* Get the device capability descriptors */ for (i = 0; i < bos_header.bNumDeviceCaps; i++) { if (size < LIBUSB_DT_DEVICE_CAPABILITY_SIZE) { usbi_warn(ctx, "short dev-cap descriptor read %d/%d", size, LIBUSB_DT_DEVICE_CAPABILITY_SIZE); break; } usbi_parse_descriptor(buffer, "bbb", &dev_cap, host_endian); if (dev_cap.bDescriptorType != LIBUSB_DT_DEVICE_CAPABILITY) { usbi_warn(ctx, "unexpected descriptor %x (expected %x)", dev_cap.bDescriptorType, LIBUSB_DT_DEVICE_CAPABILITY); break; } if (dev_cap.bLength < LIBUSB_DT_DEVICE_CAPABILITY_SIZE) { usbi_err(ctx, "invalid dev-cap bLength (%d)", dev_cap.bLength); libusb_free_bos_descriptor(_bos); return LIBUSB_ERROR_IO; } if (dev_cap.bLength > size) { usbi_warn(ctx, "short dev-cap descriptor read %d/%d", size, dev_cap.bLength); break; } _bos->dev_capability[i] = malloc(dev_cap.bLength); if (!_bos->dev_capability[i]) { libusb_free_bos_descriptor(_bos); return LIBUSB_ERROR_NO_MEM; } memcpy(_bos->dev_capability[i], buffer, dev_cap.bLength); buffer += dev_cap.bLength; size -= dev_cap.bLength; } _bos->bNumDeviceCaps = (uint8_t)i; *bos = _bos; return LIBUSB_SUCCESS; }