NTSTATUS abort_endpoint(libusb_device_t *dev, int endpoint, int timeout)
{
NTSTATUS status = STATUS_SUCCESS;
URB urb;
USBMSG("endpoint: 0x%02x timeout: %d\n", endpoint, timeout);
memset(&urb, 0, sizeof(struct _URB_PIPE_REQUEST));
if (!dev->config.value)
{
USBERR0("invalid configuration 0\n");
return STATUS_INVALID_DEVICE_STATE;
}
if (!get_pipe_handle(dev, endpoint, &urb.UrbPipeRequest.PipeHandle))
{
USBERR0("getting endpoint pipe failed\n");
return STATUS_INVALID_PARAMETER;
}
urb.UrbHeader.Length = (USHORT) sizeof(struct _URB_PIPE_REQUEST);
urb.UrbHeader.Function = URB_FUNCTION_ABORT_PIPE;
status = call_usbd(dev, &urb, IOCTL_INTERNAL_USB_SUBMIT_URB, timeout);
if (!NT_SUCCESS(status) || !USBD_SUCCESS(urb.UrbHeader.Status))
{
USBERR("request failed: status: 0x%x, urb-status: 0x%x\n", status, urb.UrbHeader.Status);
}
return status;
}
NTSTATUS get_status(libusb_device_t *dev, int recipient,
int index, char *status, int *ret, int timeout)
{
NTSTATUS _status = STATUS_SUCCESS;
URB urb;
DEBUG_PRINT_NL();
DEBUG_MESSAGE("get_status(): recipient %02d", recipient);
DEBUG_MESSAGE("get_status(): index %04d", index);
DEBUG_MESSAGE("get_status(): timeout %d", timeout);
memset(&urb, 0, sizeof(URB));
switch(recipient)
{
case USB_RECIP_DEVICE:
urb.UrbHeader.Function = URB_FUNCTION_GET_STATUS_FROM_DEVICE;
break;
case USB_RECIP_INTERFACE:
urb.UrbHeader.Function = URB_FUNCTION_GET_STATUS_FROM_INTERFACE;
break;
case USB_RECIP_ENDPOINT:
urb.UrbHeader.Function = URB_FUNCTION_GET_STATUS_FROM_ENDPOINT;
break;
case USB_RECIP_OTHER:
urb.UrbHeader.Function = URB_FUNCTION_GET_STATUS_FROM_OTHER;
break;
default:
DEBUG_ERROR("get_status(): invalid recipient");
return STATUS_INVALID_PARAMETER;
}
urb.UrbHeader.Length = sizeof(struct _URB_CONTROL_GET_STATUS_REQUEST);
urb.UrbControlGetStatusRequest.TransferBufferLength = 2;
urb.UrbControlGetStatusRequest.TransferBuffer = status;
urb.UrbControlGetStatusRequest.Index = (USHORT)index;
_status = call_usbd(dev, &urb, IOCTL_INTERNAL_USB_SUBMIT_URB, timeout);
if(!NT_SUCCESS(_status) || !USBD_SUCCESS(urb.UrbHeader.Status))
{
DEBUG_ERROR("get_status(): getting status failed: "
"status: 0x%x, urb-status: 0x%x",
_status, urb.UrbHeader.Status);
*ret = 0;
}
else
{
*ret = urb.UrbControlGetStatusRequest.TransferBufferLength;
}
return _status;
}
NTSTATUS get_interface(libusb_device_t *dev,
int interface, unsigned char *altsetting,
int *ret, int timeout)
{
NTSTATUS status = STATUS_SUCCESS;
URB urb;
DEBUG_PRINT_NL();
DEBUG_MESSAGE("get_interface(): interface %d", interface);
DEBUG_MESSAGE("get_interface(): timeout %d", timeout);
if(!dev->config.value)
{
DEBUG_ERROR("get_interface(): invalid configuration 0");
return STATUS_INVALID_DEVICE_STATE;
}
memset(&urb, 0, sizeof(URB));
urb.UrbHeader.Function = URB_FUNCTION_GET_INTERFACE;
urb.UrbHeader.Length = sizeof(struct _URB_CONTROL_GET_INTERFACE_REQUEST);
urb.UrbControlGetInterfaceRequest.TransferBufferLength = 1;
urb.UrbControlGetInterfaceRequest.TransferBuffer = altsetting;
urb.UrbControlGetInterfaceRequest.Interface = (USHORT)interface;
status = call_usbd(dev, &urb, IOCTL_INTERNAL_USB_SUBMIT_URB, timeout);
if(!NT_SUCCESS(status) || !USBD_SUCCESS(urb.UrbHeader.Status))
{
DEBUG_ERROR("get_interface(): getting interface "
"failed: status: 0x%x, urb-status: 0x%x",
status, urb.UrbHeader.Status);
*ret = 0;
}
else
{
*ret = urb.UrbControlGetInterfaceRequest.TransferBufferLength;
DEBUG_MESSAGE("get_interface(): current altsetting is %d", *altsetting);
}
return status;
}
NTSTATUS get_descriptor(libusb_device_t *dev,
void *buffer, int size, int type, int recipient,
int index, int language_id, int *received, int timeout)
{
NTSTATUS status = STATUS_SUCCESS;
URB urb;
USBMSG("buffer size: %d type: %04d recipient: %04d index: %04d language id: %04d timeout: %d\n",
size, type, recipient, index, language_id, timeout);
memset(&urb, 0, sizeof(struct _URB_CONTROL_DESCRIPTOR_REQUEST));
switch (recipient)
{
case USB_RECIP_DEVICE:
urb.UrbHeader.Function = URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE;
break;
case USB_RECIP_INTERFACE:
urb.UrbHeader.Function = URB_FUNCTION_GET_DESCRIPTOR_FROM_INTERFACE;
break;
case USB_RECIP_ENDPOINT:
urb.UrbHeader.Function = URB_FUNCTION_GET_DESCRIPTOR_FROM_ENDPOINT;
break;
default:
USBERR0("invalid recipient\n");
return STATUS_INVALID_PARAMETER;
}
urb.UrbHeader.Length = sizeof(struct _URB_CONTROL_DESCRIPTOR_REQUEST);
urb.UrbControlDescriptorRequest.TransferBufferLength = size;
urb.UrbControlDescriptorRequest.TransferBuffer = buffer;
urb.UrbControlDescriptorRequest.DescriptorType = (UCHAR)type;
urb.UrbControlDescriptorRequest.Index = (UCHAR)index;
urb.UrbControlDescriptorRequest.LanguageId = (USHORT)language_id;
// the device and active config descriptors are cached. If the request
// is for one of these and we have already retrieved it, then this is
// a non-blocking non-i/o call.
if (type == USB_DEVICE_DESCRIPTOR_TYPE &&
recipient == USB_RECIP_DEVICE &&
index == 0 &&
language_id == 0 &&
size >= sizeof(USB_DEVICE_DESCRIPTOR))
{
// this is a device descriptor request.
if (dev->device_descriptor.bLength == 0)
{
// this is the first request made for the device descriptor.
// Cache it now and forever
status = call_usbd(dev, &urb, IOCTL_INTERNAL_USB_SUBMIT_URB, timeout);
if (NT_SUCCESS(status) && urb.UrbControlDescriptorRequest.TransferBufferLength < sizeof(USB_DEVICE_DESCRIPTOR))
{
USBERR("Invalid device decriptor length %d\n", urb.UrbControlDescriptorRequest.TransferBufferLength);
status = STATUS_BAD_DEVICE_TYPE;
*received = 0;
goto Done;
}
if (!NT_SUCCESS(status) || !USBD_SUCCESS(urb.UrbHeader.Status))
{
USBERR("getting descriptor failed: status: 0x%x, urb-status: 0x%x\n", status, urb.UrbHeader.Status);
*received = 0;
goto Done;
}
// valid device descriptor
size = sizeof(USB_DEVICE_DESCRIPTOR);
RtlCopyMemory(&dev->device_descriptor, buffer, size);
*received = size;
}
else
{
// device descriptor is already cached.
size = sizeof(USB_DEVICE_DESCRIPTOR);
RtlCopyMemory(buffer, &dev->device_descriptor, size);
*received = size;
}
goto Done;
}
if (type == USB_CONFIGURATION_DESCRIPTOR_TYPE &&
recipient == USB_RECIP_DEVICE &&
language_id == 0 &&
size >= sizeof(USB_CONFIGURATION_DESCRIPTOR))
{
if (dev->device_descriptor.bLength != 0 && index >=dev->device_descriptor.bNumConfigurations)
{
USBWRN("config descriptor index %d out of range.\n", index);
status = STATUS_NO_MORE_ENTRIES;
*received = 0;
goto Done;
}
// this is a config descriptor request.
if (!dev->config.descriptor || dev->config.index != index)
{
// this is either:
// * The first request made for a config descriptor.
// * A request for a config descriptor other than the cached index.
status = call_usbd(dev, &urb, IOCTL_INTERNAL_USB_SUBMIT_URB, timeout);
if (!NT_SUCCESS(status) || !USBD_SUCCESS(urb.UrbHeader.Status))
{
USBERR("getting descriptor failed: status: 0x%x, urb-status: 0x%x\n", status, urb.UrbHeader.Status);
*received = 0;
goto Done;
}
if (!dev->config.descriptor &&
urb.UrbControlDescriptorRequest.TransferBufferLength >= ((PUSB_CONFIGURATION_DESCRIPTOR)buffer)->wTotalLength)
{
//
// This is a special case scenario where we cache the first
// config deescriptor requested when dev->config.descriptor == NULL
// and this was a request for the *entire* descriptor.
//
// Nearly all windows USB devices will only have one configuration.
// In the case a the filter driver, it does *not* auto configure the
// device which is where the *active* config descriptor caching occurs.
//
// This code ensures the first config descriptor requested is always cached
// even if the device is not configured yet.
//
PUSB_CONFIGURATION_DESCRIPTOR config_desc;
size = ((PUSB_CONFIGURATION_DESCRIPTOR)buffer)->wTotalLength;
if (!( config_desc = ExAllocatePool(NonPagedPool, size)))
{
USBERR0("memory allocation error\n");
status = STATUS_NO_MEMORY;
goto Done;
}
dev->config.descriptor=config_desc;
RtlCopyMemory(dev->config.descriptor,buffer,size);
dev->config.value=0;
dev->config.total_size=size;
dev->config.index=index;
*received = size;
}
else
{
*received = urb.UrbControlDescriptorRequest.TransferBufferLength;
}
goto Done;
}
else
{
// This is a request for the active configuration descriptor.
// This is only updated upon a successful set_configuration().
size = (size > dev->config.descriptor->wTotalLength) ? dev->config.descriptor->wTotalLength : size;
RtlCopyMemory(buffer, dev->config.descriptor, size);
*received = size;
goto Done;
}
}
// this is not a device or config descriptor reequest
status = call_usbd(dev, &urb, IOCTL_INTERNAL_USB_SUBMIT_URB, timeout);
if (!NT_SUCCESS(status) || !USBD_SUCCESS(urb.UrbHeader.Status))
{
USBERR("getting descriptor failed: status: 0x%x, urb-status: 0x%x\n", status, urb.UrbHeader.Status);
*received = 0;
}
else
{
*received = urb.UrbControlDescriptorRequest.TransferBufferLength;
}
Done:
return status;
}
NTSTATUS set_configuration(libusb_device_t *dev,
int configuration,
int timeout)
{
NTSTATUS status = STATUS_SUCCESS;
URB urb, *urb_ptr = NULL;
USB_CONFIGURATION_DESCRIPTOR *configuration_descriptor = NULL;
USB_INTERFACE_DESCRIPTOR *interface_descriptor = NULL;
USBD_INTERFACE_LIST_ENTRY *interfaces = NULL;
int i, j, interface_number, desc_size, config_index, ret;
// check if this config value is already set
if ((configuration > 0) && dev->config.value == configuration)
{
return STATUS_SUCCESS;
}
// check if this config index is already set
if ((configuration < 0) && dev->config.value && dev->config.index == (abs(configuration)-1))
{
return STATUS_SUCCESS;
}
memset(&urb, 0, sizeof(URB));
if (configuration == 0)
{
urb.UrbHeader.Function = URB_FUNCTION_SELECT_CONFIGURATION;
urb.UrbHeader.Length = sizeof(struct _URB_SELECT_CONFIGURATION);
status = call_usbd(dev, &urb, IOCTL_INTERNAL_USB_SUBMIT_URB, timeout);
if (!NT_SUCCESS(status) || !USBD_SUCCESS(urb.UrbHeader.Status))
{
USBERR("setting configuration %d failed: status: 0x%x, urb-status: 0x%x\n",
configuration, status, urb.UrbHeader.Status);
return status;
}
dev->config.handle = urb.UrbSelectConfiguration.ConfigurationHandle;
dev->config.value = 0;
clear_pipe_info(dev);
return status;
}
if (configuration <= SET_CONFIG_ACTIVE_CONFIG)
{
// note: as of v1.2.4.0, the active/default configuration is
// always the first configuration the device returns. (index 0)
configuration=-1;
}
USBMSG("setting configuration %s %d timeout=%d",
(configuration < 0) ? "index" : "value",
(configuration < 0) ? abs(configuration) - 1 : configuration,
timeout);
// If configuration is negative, it is retrieved by index.
//
configuration_descriptor = get_config_descriptor(dev, configuration,
&desc_size, &config_index);
if (!configuration_descriptor)
{
USBERR0("getting configuration descriptor failed");
return STATUS_INVALID_PARAMETER;
}
// if we passed an index in we can check here to see
// if the device is already configured with this value
if (dev->config.value == configuration_descriptor->bConfigurationValue)
{
UpdateContextConfigDescriptor(
dev,
configuration_descriptor,
desc_size,
configuration_descriptor->bConfigurationValue,
config_index);
status = STATUS_SUCCESS;
goto SetConfigurationDone;
}
// MEMORY ALLOCATION BEGINS
interfaces =
ExAllocatePool(NonPagedPool,(configuration_descriptor->bNumInterfaces + 1)
* sizeof(USBD_INTERFACE_LIST_ENTRY));
if (!interfaces)
{
USBERR0("memory allocation failed\n");
status = STATUS_NO_MEMORY;
ExFreePool(configuration_descriptor);
goto SetConfigurationDone;
}
memset(interfaces, 0, (configuration_descriptor->bNumInterfaces + 1)
* sizeof(USBD_INTERFACE_LIST_ENTRY));
interface_number = 0;
for (i = 0; i < configuration_descriptor->bNumInterfaces; i++)
{
for (j = interface_number; j < LIBUSB_MAX_NUMBER_OF_INTERFACES; j++)
{
interface_descriptor =
find_interface_desc(configuration_descriptor, desc_size, j, 0);
if (interface_descriptor)
{
interface_number = ++j;
break;
}
}
if (!interface_descriptor)
{
USBERR("unable to find interface descriptor at index %d\n", i);
status = STATUS_INVALID_PARAMETER;
ExFreePool(configuration_descriptor);
goto SetConfigurationDone;
}
else
{
USBMSG("found interface %d\n",
interface_descriptor->bInterfaceNumber);
interfaces[i].InterfaceDescriptor = interface_descriptor;
}
}
urb_ptr = USBD_CreateConfigurationRequestEx(configuration_descriptor, interfaces);
if (!urb_ptr)
{
USBERR0("memory allocation failed\n");
status = STATUS_NO_MEMORY;
ExFreePool(configuration_descriptor);
goto SetConfigurationDone;
}
for (i = 0; i < configuration_descriptor->bNumInterfaces; i++)
{
for (j = 0; j < (int)interfaces[i].Interface->NumberOfPipes; j++)
{
interfaces[i].Interface->Pipes[j].MaximumTransferSize = LIBUSB_MAX_READ_WRITE;
}
}
USBDBG("#%d %s passing configuration request to target-device.",
dev->id, dev->device_id);
status = call_usbd(dev, urb_ptr, IOCTL_INTERNAL_USB_SUBMIT_URB, timeout);
if (!NT_SUCCESS(status) || !USBD_SUCCESS(urb_ptr->UrbHeader.Status))
{
USBERR("setting configuration %d failed: status: 0x%x, urb-status: 0x%x\n",
configuration, status, urb_ptr->UrbHeader.Status);
if (NT_SUCCESS(status)) status = urb_ptr->UrbHeader.Status;
ExFreePool(configuration_descriptor);
goto SetConfigurationDone;
}
dev->config.handle = urb_ptr->UrbSelectConfiguration.ConfigurationHandle;
clear_pipe_info(dev);
for (i = 0; i < configuration_descriptor->bNumInterfaces; i++)
{
update_pipe_info(dev, interfaces[i].Interface);
}
UpdateContextConfigDescriptor(dev, configuration_descriptor, desc_size, configuration_descriptor->bConfigurationValue, config_index);
SetConfigurationDone:
if (interfaces)
ExFreePool(interfaces);
if (urb_ptr)
ExFreePool(urb_ptr);
return status;
}
NTSTATUS set_interface(libusb_device_t *dev,
int interface_number,
int alt_interface_number,
int timeout)
{
NTSTATUS status = STATUS_SUCCESS;
URB *urb;
int i, tmp_size;
USB_INTERFACE_DESCRIPTOR *interface_descriptor = NULL;
USBD_INTERFACE_INFORMATION *interface_information = NULL;
USBMSG("interface-number=%d alt-number=%d timeout=%d\n",
interface_number,alt_interface_number,timeout);
if (!dev->config.value || !dev->config.descriptor)
{
USBERR0("device is not configured\n");
return STATUS_INVALID_DEVICE_STATE;
}
interface_descriptor = find_interface_desc(dev->config.descriptor, dev->config.total_size, interface_number, alt_interface_number);
if (!interface_descriptor)
{
USBERR("interface-number=%d alt-number=%d does not exists.\n",
interface_number,alt_interface_number,timeout);
return STATUS_NO_MORE_ENTRIES;
}
tmp_size = sizeof(struct _URB_SELECT_INTERFACE) + interface_descriptor->bNumEndpoints * sizeof(USBD_PIPE_INFORMATION);
urb = ExAllocatePool(NonPagedPool, tmp_size);
if (!urb)
{
USBERR0("memory_allocation error\n");
return STATUS_NO_MEMORY;
}
memset(urb, 0, tmp_size);
urb->UrbHeader.Function = URB_FUNCTION_SELECT_INTERFACE;
urb->UrbHeader.Length = (USHORT)tmp_size;
urb->UrbSelectInterface.ConfigurationHandle = dev->config.handle;
urb->UrbSelectInterface.Interface.Length = sizeof(struct _USBD_INTERFACE_INFORMATION);
urb->UrbSelectInterface.Interface.NumberOfPipes = interface_descriptor->bNumEndpoints;
urb->UrbSelectInterface.Interface.Length += interface_descriptor->bNumEndpoints * sizeof(struct _USBD_PIPE_INFORMATION);
urb->UrbSelectInterface.Interface.InterfaceNumber = (UCHAR)interface_descriptor->bInterfaceNumber;
urb->UrbSelectInterface.Interface.AlternateSetting = (UCHAR)interface_descriptor->bAlternateSetting;
interface_information = &urb->UrbSelectInterface.Interface;
for (i = 0; i < interface_descriptor->bNumEndpoints; i++)
{
interface_information->Pipes[i].MaximumTransferSize = LIBUSB_MAX_READ_WRITE;
}
status = call_usbd(dev, urb, IOCTL_INTERNAL_USB_SUBMIT_URB, timeout);
if (!NT_SUCCESS(status) || !USBD_SUCCESS(urb->UrbHeader.Status))
{
USBERR("setting interface failed: status: 0x%x, urb-status: 0x%x\n", status, urb->UrbHeader.Status);
ExFreePool(urb);
return STATUS_UNSUCCESSFUL;
}
update_pipe_info(dev, interface_information);
ExFreePool(urb);
return status;
}
NTSTATUS set_interface(libusb_device_t *dev, int interface, int altsetting,
int timeout)
{
NTSTATUS status = STATUS_SUCCESS;
URB *urb;
int i, config_size, tmp_size;
USB_CONFIGURATION_DESCRIPTOR *configuration_descriptor = NULL;
USB_INTERFACE_DESCRIPTOR *interface_descriptor = NULL;
USBD_INTERFACE_INFORMATION *interface_information = NULL;
DEBUG_PRINT_NL();
DEBUG_MESSAGE("set_interface(): interface %d", interface);
DEBUG_MESSAGE("set_interface(): altsetting %d", altsetting);
DEBUG_MESSAGE("set_interface(): timeout %d", timeout);
if(!dev->config.value)
{
DEBUG_ERROR("release_interface(): device is not configured");
return STATUS_INVALID_DEVICE_STATE;
}
configuration_descriptor = get_config_descriptor(dev, dev->config.value,
&config_size);
if(!configuration_descriptor)
{
DEBUG_ERROR("set_interface(): memory_allocation error");
return STATUS_NO_MEMORY;
}
interface_descriptor =
find_interface_desc(configuration_descriptor, config_size,
interface, altsetting);
if(!interface_descriptor)
{
DEBUG_ERROR("set_interface(): interface %d or altsetting %d invalid",
interface, altsetting);
ExFreePool(configuration_descriptor);
return STATUS_UNSUCCESSFUL;
}
tmp_size = sizeof(struct _URB_SELECT_INTERFACE)
+ interface_descriptor->bNumEndpoints
* sizeof(USBD_PIPE_INFORMATION);
urb = ExAllocatePool(NonPagedPool, tmp_size);
if(!urb)
{
DEBUG_ERROR("set_interface(): memory_allocation error");
ExFreePool(configuration_descriptor);
return STATUS_NO_MEMORY;
}
memset(urb, 0, tmp_size);
urb->UrbHeader.Function = URB_FUNCTION_SELECT_INTERFACE;
urb->UrbHeader.Length = (USHORT)tmp_size;
urb->UrbSelectInterface.ConfigurationHandle = dev->config.handle;
urb->UrbSelectInterface.Interface.Length =
sizeof(struct _USBD_INTERFACE_INFORMATION);
urb->UrbSelectInterface.Interface.NumberOfPipes =
interface_descriptor->bNumEndpoints;
urb->UrbSelectInterface.Interface.Length +=
interface_descriptor->bNumEndpoints
* sizeof(struct _USBD_PIPE_INFORMATION);
urb->UrbSelectInterface.Interface.InterfaceNumber = (UCHAR)interface;
urb->UrbSelectInterface.Interface.AlternateSetting = (UCHAR)altsetting;
interface_information = &urb->UrbSelectInterface.Interface;
for(i = 0; i < interface_descriptor->bNumEndpoints; i++)
{
interface_information->Pipes[i].MaximumTransferSize
= LIBUSB_MAX_READ_WRITE;
}
status = call_usbd(dev, urb, IOCTL_INTERNAL_USB_SUBMIT_URB, timeout);
if(!NT_SUCCESS(status) || !USBD_SUCCESS(urb->UrbHeader.Status))
{
DEBUG_ERROR("set_interface(): setting interface failed: status: 0x%x, "
"urb-status: 0x%x", status, urb->UrbHeader.Status);
ExFreePool(configuration_descriptor);
ExFreePool(urb);
return STATUS_UNSUCCESSFUL;
}
update_pipe_info(dev, interface_information);
ExFreePool(configuration_descriptor);
ExFreePool(urb);
return status;
}
