devconfig.cpp File Reference

#include "usbhub3.h"
#include "desccheck.h"
#include "devhcd.h"
#include <debug.h>

Include dependency graph for devconfig.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	CLIENT_INTERVAL_CAP   6
#define	BCD_USB_25   0x0250
#define	COMPANION_LENGTH   6
#define	SSP_COMPANION_LENGTH   8

Functions
static PURB NTAPI	HubChildClientUrb (_In_ HubChild *Child)
static BOOLEAN NTAPI	HubChildSettingFiltered (_In_ HubChild *Child, _In_ UCHAR InterfaceNumber, _In_ UCHAR AlternateSetting)
static VOID NTAPI	HubChildFreeEndpointArrays (_In_ HubChild *Child)
static NTSTATUS NTAPI	HubChildSizeEndpointArrays (_In_ HubChild *Child, _In_ ULONG Count)
VOID NTAPI	HubChildCollectForDisable (_In_ HubChild *Child, _In_ HubInterface *Interface)
static NTSTATUS NTAPI	HubAllocateConfiguration (_In_ PUSB_CONFIGURATION_DESCRIPTOR Source, _Out_ HubConfiguration **Result)
static NTSTATUS NTAPI	HubAllocateInterface (_In_ PUSB_INTERFACE_DESCRIPTOR Descriptor, _In_ BOOLEAN HasAlternates, _Out_ HubInterface **Result)
static VOID NTAPI	HubFreeConfiguration (_In_ HubChild *Child, _In_ HubConfiguration *Config)
FORCEINLINE BOOLEAN NTAPI	HubTypeFits (_In_ PUCHAR Walk, _In_ PUCHAR End)
static VOID NTAPI	HubPickCompanions (_In_ HubPipe *Pipe, _Inout_ PUSBD_PIPE_INFORMATION Client, _In_ PUCHAR Walk, _In_ PUCHAR End)
static NTSTATUS NTAPI	HubChildInitPipes (_In_ HubChild *Child, _Inout_ PUSBD_INTERFACE_INFORMATION Info, _Inout_ HubInterface *Interface, _In_ PUCHAR Walk, _In_ PUCHAR End)
static BOOLEAN NTAPI	HubInterfaceHasEndpointZero (_In_ HubInterface *Interface)
static BOOLEAN NTAPI	HubConfigHasEndpointZero (_In_ HubConfiguration *Config)
static NTSTATUS NTAPI	HubConfigCheckDuplicates (_In_ HubConfiguration *Config)
static NTSTATUS NTAPI	HubInterfacesShareEndpoints (_In_ HubInterface *First, _In_ HubInterface *Second)
static VOID NTAPI	HubChildRecordFailure (_In_ HubChild *Child, _In_ NTSTATUS Status)
static USBD_PIPE_HANDLE NTAPI	HubChildExposePipe (_In_ HubChild *Child, _Inout_ HubPipe *Pipe)

Macro Definition Documentation

BCD_USB_25

#define BCD_USB_25   0x0250

Definition at line 19 of file devconfig.cpp.

CLIENT_INTERVAL_CAP

#define CLIENT_INTERVAL_CAP   6

Definition at line 16 of file devconfig.cpp.

COMPANION_LENGTH

#define COMPANION_LENGTH   6

Definition at line 22 of file devconfig.cpp.

NDEBUG

#define NDEBUG

Definition at line 12 of file devconfig.cpp.

SSP_COMPANION_LENGTH

#define SSP_COMPANION_LENGTH   8

Definition at line 23 of file devconfig.cpp.

Function Documentation

HubAllocateConfiguration()

static NTSTATUS NTAPI HubAllocateConfiguration ( _In_ PUSB_CONFIGURATION_DESCRIPTOR  Source, _Out_ HubConfiguration **  Result  )

static

Definition at line 170 of file devconfig.cpp.

{
    HubConfiguration* Config;
    WDFMEMORY Memory;
    ULONG Size;
    NTSTATUS Status;
 
    Size = FIELD_OFFSET(HubConfiguration, Descriptor) + Source->wTotalLength;
    Size = max(Size, (ULONG)sizeof(*Config));
 
    Status = WdfMemoryCreate(WDF_NO_OBJECT_ATTRIBUTES,
                             NonPagedPool,
                             HUB_TAG_DEVICE,
                             Size,
                             &Memory,
                             (PVOID*)&Config);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Configuration record of %lu bytes not allocated 0x%lx\n", Size, Status);
        *Result = NULL;
        return Status;
    }
 
    RtlZeroMemory(Config, Size);
    Config->Memory = Memory;
    InitializeListHead(&Config->Interfaces);
    RtlCopyMemory(&Config->Descriptor, Source, Source->wTotalLength);
 
    *Result = Config;
    return STATUS_SUCCESS;
}

Referenced by DeviceMachine::PrepareConfigLists().

HubAllocateInterface()

static NTSTATUS NTAPI HubAllocateInterface ( _In_ PUSB_INTERFACE_DESCRIPTOR  Descriptor, _In_ BOOLEAN  HasAlternates, _Out_ HubInterface **  Result  )

static

Definition at line 207 of file devconfig.cpp.

{
    HubInterface* Interface;
    WDFMEMORY Memory;
    ULONG Size;
    NTSTATUS Status;
 
    Size = FIELD_OFFSET(HubInterface, Pipes) + Descriptor->bNumEndpoints * sizeof(HubPipe);
    Size = max(Size, (ULONG)sizeof(*Interface));
 
    Status = WdfMemoryCreate(WDF_NO_OBJECT_ATTRIBUTES,
                             NonPagedPool,
                             HUB_TAG_DEVICE,
                             Size,
                             &Memory,
                             (PVOID*)&Interface);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Interface %u record not allocated 0x%lx\n", Descriptor->bInterfaceNumber, Status);
        *Result = NULL;
        return Status;
    }
 
    RtlZeroMemory(Interface, Size);
    Interface->Memory = Memory;
    Interface->Descriptor = Descriptor;
    Interface->PipeCount = Descriptor->bNumEndpoints;
    Interface->HasAlternateSettings = HasAlternates;
    Interface->NeedsSetInterface = HasAlternates;
 
    *Result = Interface;
    return STATUS_SUCCESS;
}

Referenced by DeviceMachine::PrepareConfigLists(), and DeviceMachine::PrepareInterfaceLists().

HubChildClientUrb()

static PURB NTAPI HubChildClientUrb ( _In_ HubChild *  Child )

static

The client URB of the request the device machine is serving.

Definition at line 29 of file devconfig.cpp.

{
    WDF_REQUEST_PARAMETERS Params;
 
    WDF_REQUEST_PARAMETERS_INIT(&Params);
    WdfRequestGetParameters(Child->m_ClientRequest, &Params);
    return (PURB)Params.Parameters.Others.Arg1;
}

Referenced by DeviceMachine::PrepareConfigLists(), DeviceMachine::PrepareInterfaceLists(), DeviceMachine::SetConfigInfoInRequest(), and DeviceMachine::SetInterfaceInfoInRequest().

HubChildCollectForDisable()

VOID NTAPI HubChildCollectForDisable	(	_In_ HubChild *	Child,
		_In_ HubInterface *	Interface
	)

Enabled pipes go to the disable list as PendingDisable, disabled ones stay unchanged.

Definition at line 132 of file devconfig.cpp.

{
    HubPipe* Pipe;
    ULONG Index;
 
    for (Index = 0; Index < Interface->PipeCount; Index++)
    {
        Pipe = &Interface->Pipes[Index];
 
        switch (Pipe->State)
        {
            case PipeState::Enabled:
                Pipe->State = PipeState::PendingDisable;
                Child->m_EndpointsToDisable[Child->m_DisableCount++] = Pipe->Endpoint;
                break;
 
            case PipeState::Disabled:
                Child->m_EndpointsUnchanged[Child->m_UnchangedCount++] = Pipe->Endpoint;
                break;
 
            case PipeState::NotCreated:
                break;
 
            default:
                DPRINT1("Device %p pipe %lu in unexpected state %u\n", Child, Index, (UCHAR)Pipe->State);
                ASSERT(FALSE);
                break;
        }
    }
}

Referenced by DeviceMachine::DisableAllEndpoints(), DeviceMachine::DisableNewInterfaceEndpoints(), DeviceMachine::PrepareConfigLists(), and DeviceMachine::PrepareInterfaceLists().

HubChildExposePipe()

static USBD_PIPE_HANDLE NTAPI HubChildExposePipe ( _In_ HubChild *  Child, _Inout_ HubPipe *  Pipe  )

static

Definition at line 923 of file devconfig.cpp.

{
    PUCXHUB_STACK_INTERFACE Stack = &Child->m_Hub->m_Stack;
 
    Pipe->PipeHandle = Stack->EndpointGetPipeHandle(Pipe->Endpoint);
    if (Pipe->PipeHandle == NULL)
        DPRINT1("Endpoint 0x%x has no pipe handle\n", Pipe->Descriptor->bEndpointAddress);
 
    Stack->MarkEndpointClientOwned(Pipe->Endpoint);
    return Pipe->PipeHandle;
}

Referenced by DeviceMachine::SetConfigInfoInRequest(), and DeviceMachine::SetInterfaceInfoInRequest().

HubChildFreeEndpointArrays()

static VOID NTAPI HubChildFreeEndpointArrays ( _In_ HubChild *  Child )

static

Definition at line 70 of file devconfig.cpp.

{
    UCXENDPOINT** Arrays[] = { &Child->m_EndpointsToEnable,
                               &Child->m_EndpointsUnchanged,
                               &Child->m_EndpointsToDisable };
    ULONG Index;
 
    Child->m_EndpointArrayCapacity = 0;
 
    for (Index = 0; Index < RTL_NUMBER_OF(Arrays); Index++)
    {
        if (*Arrays[Index] != NULL)
        {
            ExFreePoolWithTag(*Arrays[Index], HUB_TAG_DEVICE);
            *Arrays[Index] = NULL;
        }
    }
}

Referenced by HubChildSizeEndpointArrays().

HubChildInitPipes()

static NTSTATUS NTAPI HubChildInitPipes ( _In_ HubChild *  Child, _Inout_ PUSBD_INTERFACE_INFORMATION  Info, _Inout_ HubInterface *  Interface, _In_ PUCHAR  Walk, _In_ PUCHAR  End  )

static

Definition at line 328 of file devconfig.cpp.

{
    PUSBD_PIPE_INFORMATION Client;
    PUSB_ENDPOINT_DESCRIPTOR Endpoint;
    HubPipe* Pipe;
    USHORT Packet;
    ULONG Index;
 
    for (Index = 0; Index < Info->NumberOfPipes; Index++)
    {
        Client = &Info->Pipes[Index];
        Pipe = &Interface->Pipes[Index];
 
        if (Walk >= End)
        {
            DPRINT1("Device %p interface %u has fewer than %lu endpoint descriptors\n",
                    Child, Info->InterfaceNumber, Info->NumberOfPipes);
            return STATUS_UNSUCCESSFUL;
        }
 
        Pipe->PipeFlags = Client->PipeFlags;
        Pipe->State = PipeState::NotCreated;
 
        if (!HubTypeFits(Walk, End))
        {
            DPRINT1("Device %p interface %u descriptor runs past the configuration\n", Child, Info->InterfaceNumber);
            return STATUS_UNSUCCESSFUL;
        }
 
        while (((PUSB_COMMON_DESCRIPTOR)Walk)->bDescriptorType != USB_ENDPOINT_DESCRIPTOR_TYPE)
        {
            if (Walk[0] == 0)
            {
                DPRINT1("Device %p interface %u has a zero length descriptor\n", Child, Info->InterfaceNumber);
                return STATUS_UNSUCCESSFUL;
            }
 
            Walk += Walk[0];
            if (!HubTypeFits(Walk, End))
            {
                DPRINT1("Device %p interface %u has fewer than %lu endpoint descriptors\n",
                        Child, Info->InterfaceNumber, Info->NumberOfPipes);
                return STATUS_UNSUCCESSFUL;
            }
        }
 
        if (Walk + sizeof(USB_ENDPOINT_DESCRIPTOR) > End)
        {
            DPRINT1("Device %p interface %u endpoint descriptor runs past the configuration\n",
                    Child, Info->InterfaceNumber);
            return STATUS_UNSUCCESSFUL;
        }
 
        Endpoint = (PUSB_ENDPOINT_DESCRIPTOR)Walk;
 
        /* The cached copy is what UCX sees, so the override goes there */
        if (Pipe->PipeFlags & USBD_PF_CHANGE_MAX_PACKET)
            Endpoint->wMaxPacketSize = Client->MaximumPacketSize;
 
        Pipe->Descriptor = Endpoint;
        Pipe->BytesToEnd = (ULONG)(End - Walk);
 
        Packet = Endpoint->wMaxPacketSize;
        if (Child->m_DeviceDescriptor.bcdUSB < BCD_USB_25)
            Packet = (USHORT)((Packet & 0x7FF) * (((Packet >> 11) & 3) + 1));
 
        Client->MaximumPacketSize = Packet;
        Client->Interval = min(Endpoint->bInterval, CLIENT_INTERVAL_CAP);
        Client->EndpointAddress = Endpoint->bEndpointAddress;
        Client->PipeType = (USBD_PIPE_TYPE)(Endpoint->bmAttributes & USB_ENDPOINT_TYPE_MASK);
 
        if (Client->MaximumPacketSize == 0)
            Pipe->ZeroBandwidth = TRUE;
 
        if (Endpoint->bLength == 0)
        {
            DPRINT1("Device %p endpoint 0x%x has a zero length\n", Child, Endpoint->bEndpointAddress);
            return STATUS_UNSUCCESSFUL;
        }
 
        Walk += Endpoint->bLength;
        HubPickCompanions(Pipe, Client, Walk, End);
    }
 
    return STATUS_SUCCESS;
}

Referenced by DeviceMachine::PrepareConfigLists(), and DeviceMachine::PrepareInterfaceLists().

HubChildRecordFailure()

static VOID NTAPI HubChildRecordFailure ( _In_ HubChild *  Child, _In_ NTSTATUS  Status  )

static

Definition at line 544 of file devconfig.cpp.

{
    Child->m_LastNtStatus = Status;
    if (Child->m_LastUsbdStatus == 0)
        Child->m_LastUsbdStatus = HubNtStatusToUsbd(Status);
}

Referenced by DeviceMachine::PrepareConfigLists(), and DeviceMachine::PrepareInterfaceLists().

HubChildSettingFiltered()

static BOOLEAN NTAPI HubChildSettingFiltered ( _In_ HubChild *  Child, _In_ UCHAR  InterfaceNumber, _In_ UCHAR  AlternateSetting  )

static

Definition at line 43 of file devconfig.cpp.

{
    PULONG Filter = (PULONG)Child->m_AlternateSettingFilter;
    PUCHAR Pairs;
    ULONG Index;
 
    if (Filter == NULL)
        return FALSE;
 
    Pairs = (PUCHAR)(Filter + 1);
    for (Index = 0; Index < *Filter; Index++)
    {
        if (Pairs[Index * 2] == InterfaceNumber && Pairs[Index * 2 + 1] == AlternateSetting)
            return TRUE;
    }
 
    return FALSE;
}

Referenced by DeviceMachine::PrepareConfigLists(), and DeviceMachine::PrepareInterfaceLists().

HubChildSizeEndpointArrays()

static NTSTATUS NTAPI HubChildSizeEndpointArrays ( _In_ HubChild *  Child, _In_ ULONG  Count  )

static

Definition at line 94 of file devconfig.cpp.

{
    UCXENDPOINT* Fresh[3];
    ULONG Index;
 
    Child->m_EnableCount = 0;
    Child->m_DisableCount = 0;
    Child->m_UnchangedCount = 0;
 
    if (Count <= Child->m_EndpointArrayCapacity)
        return STATUS_SUCCESS;
 
    for (Index = 0; Index < RTL_NUMBER_OF(Fresh); Index++)
    {
        Fresh[Index] = (UCXENDPOINT*)ExAllocatePoolZero(NonPagedPool,
                                                        Count * sizeof(UCXENDPOINT),
                                                        HUB_TAG_DEVICE);
        if (Fresh[Index] == NULL)
        {
            DPRINT1("Device %p no memory for %lu endpoint handles\n", Child, Count);
            while (Index-- != 0)
                ExFreePoolWithTag(Fresh[Index], HUB_TAG_DEVICE);
            return STATUS_INSUFFICIENT_RESOURCES;
        }
    }
 
    HubChildFreeEndpointArrays(Child);
    Child->m_EndpointsToEnable = Fresh[0];
    Child->m_EndpointsUnchanged = Fresh[1];
    Child->m_EndpointsToDisable = Fresh[2];
    Child->m_EndpointArrayCapacity = Count;
    return STATUS_SUCCESS;
}

Referenced by DeviceMachine::PrepareConfigLists(), DeviceMachine::PrepareInterfaceLists(), and DeviceMachine::PrepareListsForReset().

HubConfigCheckDuplicates()

static NTSTATUS NTAPI HubConfigCheckDuplicates ( _In_ HubConfiguration *  Config )

static

Definition at line 463 of file devconfig.cpp.

{
    USHORT Seen[3] = { 0, 0, 0 };
    PUSB_ENDPOINT_DESCRIPTOR Endpoint;
    HubInterface* Interface;
    PLIST_ENTRY Entry;
    USHORT Bit;
    ULONG Map;
    ULONG Index;
 
    for (Entry = Config->Interfaces.Flink; Entry != &Config->Interfaces; Entry = Entry->Flink)
    {
        Interface = CONTAINING_RECORD(Entry, HubInterface, Link);
 
        for (Index = 0; Index < Interface->PipeCount; Index++)
        {
            if (Interface->Pipes[Index].ZeroBandwidth)
                continue;
 
            Endpoint = Interface->Pipes[Index].Descriptor;
            Bit = (USHORT)(1 << (Endpoint->bEndpointAddress & USB_ENDPOINT_ADDRESS_MASK));
 
            if ((Endpoint->bmAttributes & USB_ENDPOINT_TYPE_MASK) == USB_ENDPOINT_TYPE_CONTROL)
                Map = 0;
            else if (USB_ENDPOINT_DIRECTION_IN(Endpoint->bEndpointAddress))
                Map = 1;
            else
                Map = 2;
 
            if ((Seen[0] | Seen[Map]) & Bit)
            {
                DPRINT1("Configuration %p uses endpoint 0x%x twice\n", Config, Endpoint->bEndpointAddress);
                return STATUS_UNSUCCESSFUL;
            }
 
            Seen[Map] |= Bit;
        }
    }
 
    return STATUS_SUCCESS;
}

Referenced by DeviceMachine::PrepareConfigLists().

HubConfigHasEndpointZero()

static BOOLEAN NTAPI HubConfigHasEndpointZero ( _In_ HubConfiguration *  Config )

static

Definition at line 442 of file devconfig.cpp.

{
    PLIST_ENTRY Entry;
 
    for (Entry = Config->Interfaces.Flink; Entry != &Config->Interfaces; Entry = Entry->Flink)
    {
        if (HubInterfaceHasEndpointZero(CONTAINING_RECORD(Entry, HubInterface, Link)))
            return TRUE;
    }
 
    return FALSE;
}

Referenced by DeviceMachine::PrepareConfigLists().

HubFreeConfiguration()

static VOID NTAPI HubFreeConfiguration ( _In_ HubChild *  Child, _In_ HubConfiguration *  Config  )

static

Definition at line 248 of file devconfig.cpp.

{
    PLIST_ENTRY Entry;
 
    while (!IsListEmpty(&Config->Interfaces))
    {
        Entry = RemoveHeadList(&Config->Interfaces);
        HubChildDeleteInterface(Child, CONTAINING_RECORD(Entry, HubInterface, Link));
    }
 
    WdfObjectDelete(Config->Memory);
}

Referenced by DeviceMachine::PrepareConfigLists().

HubInterfaceHasEndpointZero()

static BOOLEAN NTAPI HubInterfaceHasEndpointZero ( _In_ HubInterface *  Interface )

static

Definition at line 425 of file devconfig.cpp.

{
    ULONG Index;
 
    for (Index = 0; Index < Interface->PipeCount; Index++)
    {
        if ((Interface->Pipes[Index].Descriptor->bEndpointAddress & USB_ENDPOINT_ADDRESS_MASK) == 0)
            return TRUE;
    }
 
    return FALSE;
}

Referenced by HubConfigHasEndpointZero(), and DeviceMachine::PrepareInterfaceLists().

HubInterfacesShareEndpoints()

static NTSTATUS NTAPI HubInterfacesShareEndpoints ( _In_ HubInterface *  First, _In_ HubInterface *  Second  )

static

Definition at line 509 of file devconfig.cpp.

{
    PUSB_ENDPOINT_DESCRIPTOR A;
    PUSB_ENDPOINT_DESCRIPTOR B;
    ULONG I, J;
 
    for (I = 0; I < First->PipeCount; I++)
    {
        A = First->Pipes[I].Descriptor;
 
        for (J = 0; J < Second->PipeCount; J++)
        {
            B = Second->Pipes[J].Descriptor;
 
            if (A->bEndpointAddress == B->bEndpointAddress &&
                A->wMaxPacketSize != 0 &&
                B->wMaxPacketSize != 0)
            {
                DPRINT1("Endpoint 0x%x shared by interface %u alternate %u and interface %u alternate %u\n",
                        A->bEndpointAddress,
                        First->Descriptor->bInterfaceNumber, First->Descriptor->bAlternateSetting,
                        Second->Descriptor->bInterfaceNumber, Second->Descriptor->bAlternateSetting);
                return STATUS_INVALID_PARAMETER;
            }
        }
    }
 
    return STATUS_SUCCESS;
}

Referenced by DeviceMachine::PrepareInterfaceLists().

HubPickCompanions()

static VOID NTAPI HubPickCompanions ( _In_ HubPipe *  Pipe, _Inout_ PUSBD_PIPE_INFORMATION  Client, _In_ PUCHAR  Walk, _In_ PUCHAR  End  )

static

Definition at line 280 of file devconfig.cpp.

{
    PUSB_SUPERSPEED_ENDPOINT_COMPANION_DESCRIPTOR Companion;
    PUSB_SUPERSPEEDPLUS_ISOCH_ENDPOINT_COMPANION_DESCRIPTOR SspCompanion;
 
    if (!HubTypeFits(Walk, End))
        return;
 
    Companion = (PUSB_SUPERSPEED_ENDPOINT_COMPANION_DESCRIPTOR)Walk;
    if (Companion->bDescriptorType != USB_SUPERSPEED_ENDPOINT_COMPANION_DESCRIPTOR_TYPE ||
        Companion->bLength == 0 ||
        Walk + COMPANION_LENGTH > End)
    {
        return;
    }
 
    Pipe->Companion = Companion;
 
    if ((Pipe->Descriptor->bmAttributes & USB_ENDPOINT_TYPE_MASK) != USB_ENDPOINT_TYPE_ISOCHRONOUS)
        return;
 
    if (!Pipe->ZeroBandwidth)
        Client->MaximumPacketSize = Companion->wBytesPerInterval;
 
    if (!Companion->bmAttributes.Isochronous.SspCompanion)
        return;
 
    Walk += Companion->bLength;
    if (!HubTypeFits(Walk, End))
        return;
 
    SspCompanion = (PUSB_SUPERSPEEDPLUS_ISOCH_ENDPOINT_COMPANION_DESCRIPTOR)Walk;
    if (SspCompanion->bDescriptorType == USB_SUPERSPEEDPLUS_ISOCH_ENDPOINT_COMPANION_DESCRIPTOR_TYPE &&
        SspCompanion->bLength != 0 &&
        Walk + SSP_COMPANION_LENGTH <= End)
    {
        Pipe->IsochCompanion = SspCompanion;
    }
}

Referenced by HubChildInitPipes().

HubTypeFits()

FORCEINLINE BOOLEAN NTAPI HubTypeFits	(	_In_ PUCHAR	Walk,
		_In_ PUCHAR	End
	)

Definition at line 269 of file devconfig.cpp.

{
    return Walk + 1 < End;
}

Referenced by HubChildInitPipes(), and HubPickCompanions().