upstream.cpp File Reference

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

Include dependency graph for upstream.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	HUB_CLASS_CODE   9
#define	HUB_PROTOCOL_SINGLE_TT   1
#define	HUB_PROTOCOL_MULTI_TT   2
#define	HUB_PROTOCOL_ANY   (-1)
#define	HUB_30_MAX_STATUS_PACKET   2

Functions
static BOOLEAN NTAPI	HubSendToParent (_In_ HubFdo *Hub, _In_ WDFREQUEST Request, _In_ ULONG IoControlCode, _In_ PVOID Payload, _In_ PFN_WDF_REQUEST_COMPLETION_ROUTINE Completion, _In_ WDFCONTEXT Context)
static NTSTATUS NTAPI	HubCreateParentRequest (_In_ HubFdo *Hub, _Out_ WDFREQUEST *Request)
static PUSB_INTERFACE_DESCRIPTOR NTAPI	HubFindHubInterface (_In_ HubFdo *Hub)
static VOID NTAPI	HubConfigurationComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
static VOID NTAPI	HubPipeResetComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
static VOID NTAPI	HubResetComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
static VOID NTAPI	HubParentInfoComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)

Variables
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubConfigurationComplete
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubPipeResetComplete
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubResetComplete
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubParentInfoComplete

Macro Definition Documentation

HUB_30_MAX_STATUS_PACKET

#define HUB_30_MAX_STATUS_PACKET   2

Definition at line 20 of file upstream.cpp.

HUB_CLASS_CODE

#define HUB_CLASS_CODE   9

Definition at line 14 of file upstream.cpp.

HUB_PROTOCOL_ANY

#define HUB_PROTOCOL_ANY   (-1)

Definition at line 17 of file upstream.cpp.

HUB_PROTOCOL_MULTI_TT

#define HUB_PROTOCOL_MULTI_TT   2

Definition at line 16 of file upstream.cpp.

HUB_PROTOCOL_SINGLE_TT

#define HUB_PROTOCOL_SINGLE_TT   1

Definition at line 15 of file upstream.cpp.

NDEBUG

#define NDEBUG

Definition at line 10 of file upstream.cpp.

Function Documentation

HubConfigurationComplete()

static VOID NTAPI HubConfigurationComplete ( _In_ WDFREQUEST  Request, _In_ WDFIOTARGET  Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS  Params, _In_ WDFCONTEXT  Context  )

static

Definition at line 176 of file upstream.cpp.

{
    PURB Urb = (PURB)Context;
    HubFdo* Hub = HubFdo::FromDevice(WdfIoTargetGetDevice(Target));
    NTSTATUS Status = Params->IoStatus.Status;
    PUSBD_PIPE_INFORMATION Pipe;
 
    if (NT_SUCCESS(Status))
    {
        Pipe = &Urb->UrbSelectConfiguration.Interface.Pipes[0];
 
        Hub->m_Interrupt.Pipe = Pipe->PipeHandle;
        Hub->m_ConfigurationHandle = Urb->UrbSelectConfiguration.ConfigurationHandle;
        Hub->m_InterruptMaxPacket = Pipe->MaximumPacketSize;
 
        if (Hub->m_ParentInfo.DeviceDescriptor.bcdUSB >= 0x0300 &&
            Pipe->MaximumPacketSize != HUB_30_MAX_STATUS_PACKET)
        {
            DPRINT1("Hub %p SuperSpeed status endpoint packet size %u\n", Hub, Pipe->MaximumPacketSize);
        }
 
        if (Hub->m_ParentInfo.DeviceDescriptor.bcdUSB >= 0x0300 &&
            Pipe->MaximumPacketSize > HUB_30_MAX_STATUS_PACKET)
        {
            Status = STATUS_INVALID_HW_PROFILE;
        }
    }
 
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Hub %p set configuration failed 0x%lx, URB status 0x%lx\n",
                Hub, Status, Urb->UrbHeader.Status);
    }
 
    WdfObjectDelete(Request);
    ExFreePool(Urb);
 
    Hub->Post(NT_SUCCESS(Status) ? HubEvent::ConfigurationSet : HubEvent::ConfigurationFailed);
}

HubCreateParentRequest()

static NTSTATUS NTAPI HubCreateParentRequest ( _In_ HubFdo *  Hub, _Out_ WDFREQUEST *  Request  )

static

Definition at line 64 of file upstream.cpp.

{
    WDF_OBJECT_ATTRIBUTES Attributes;
    NTSTATUS Status;
 
    WDF_OBJECT_ATTRIBUTES_INIT(&Attributes);
    Attributes.ParentObject = Hub->m_Device;
 
    *Request = NULL;
    Status = WdfRequestCreate(&Attributes, WdfDeviceGetIoTarget(Hub->m_Device), Request);
    if (!NT_SUCCESS(Status))
        DPRINT1("Hub %p parent request create failed 0x%lx\n", Hub, Status);
 
    return Status;
}

Referenced by HubMachine::GetParentInfo(), HubMachine::ResetHub(), and HubMachine::SelectHubConfiguration().

HubFindHubInterface()

static PUSB_INTERFACE_DESCRIPTOR NTAPI HubFindHubInterface ( _In_ HubFdo *  Hub )

static

Definition at line 88 of file upstream.cpp.

{
    static const LONG HighSpeedOrder[] = { HUB_PROTOCOL_MULTI_TT, HUB_PROTOCOL_SINGLE_TT, 0, HUB_PROTOCOL_ANY };
    static const LONG OtherOrder[] = { HUB_PROTOCOL_SINGLE_TT, 0, HUB_PROTOCOL_ANY };
    PUSB_CONFIGURATION_DESCRIPTOR Config = Hub->m_ConfigDescriptor;
    PUSB_INTERFACE_DESCRIPTOR Interface;
    const LONG* Order;
    ULONG Count;
    ULONG Index;
 
    switch (Hub->m_Parent.HubSpeed)
    {
        case UsbHighSpeed:
            Order = HighSpeedOrder;
            Count = RTL_NUMBER_OF(HighSpeedOrder);
            break;
 
        case UsbFullSpeed:
        case UsbSuperSpeed:
            Order = OtherOrder;
            Count = RTL_NUMBER_OF(OtherOrder);
            break;
 
        default:
            return NULL;
    }
 
    for (Index = 0; Index < Count; Index++)
    {
        Interface = USBD_ParseConfigurationDescriptorEx(Config, Config, -1, -1, HUB_CLASS_CODE, -1, Order[Index]);
        if (Interface != NULL)
            return Interface;
    }
 
    return NULL;
}

Referenced by HubMachine::SelectHubConfiguration().

HubParentInfoComplete()

static VOID NTAPI HubParentInfoComplete ( _In_ WDFREQUEST  Request, _In_ WDFIOTARGET  Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS  Params, _In_ WDFCONTEXT  Context  )

static

Definition at line 327 of file upstream.cpp.

{
    HubFdo* Hub = (HubFdo*)Context;
    NTSTATUS Status = Params->IoStatus.Status;
    WDF_IO_TARGET_OPEN_PARAMS Open;
    WDFIOTARGET RootTarget;
 
    UNREFERENCED_PARAMETER(Target);
 
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Hub %p parent hub info failed 0x%lx\n", Hub, Status);
    }
    else
    {
        Status = WdfIoTargetCreate(Hub->m_Device, WDF_NO_OBJECT_ATTRIBUTES, &RootTarget);
        if (!NT_SUCCESS(Status))
            DPRINT1("Hub %p root hub target create failed 0x%lx\n", Hub, Status);
    }
 
    if (NT_SUCCESS(Status))
    {
        WDF_IO_TARGET_OPEN_PARAMS_INIT_EXISTING_DEVICE(&Open, Hub->m_ParentInfo.RootHubPdo);
 
        Status = WdfIoTargetOpen(RootTarget, &Open);
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("Hub %p root hub target open on %p failed 0x%lx\n",
                    Hub, Hub->m_ParentInfo.RootHubPdo, Status);
            WdfObjectDelete(RootTarget);
        }
        else
        {
            if (Hub->m_RootHubTarget != NULL)
                WdfObjectDelete(Hub->m_RootHubTarget);
            Hub->m_RootHubTarget = RootTarget;
        }
    }
 
    if (NT_SUCCESS(Status) && (Hub->m_ParentInfo.Flags & HUB_PARENT_DISABLE_LPM))
        Hub->SetFlag(HubFlag::DisableLpm);
 
    WdfObjectDelete(Request);
    Hub->Post(NT_SUCCESS(Status) ? HubEvent::IoctlDone : HubEvent::IoctlFailed);
}

HubPipeResetComplete()

static VOID NTAPI HubPipeResetComplete ( _In_ WDFREQUEST  Request, _In_ WDFIOTARGET  Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS  Params, _In_ WDFCONTEXT  Context  )

static

Definition at line 225 of file upstream.cpp.

{
    HubFdo* Hub = (HubFdo*)Context;
 
    UNREFERENCED_PARAMETER(Request);
    UNREFERENCED_PARAMETER(Target);
 
    if (!NT_SUCCESS(Params->IoStatus.Status))
    {
        DPRINT1("Hub %p status change pipe reset failed 0x%lx, URB status 0x%lx\n",
                Hub, Params->IoStatus.Status, Hub->m_PipeUrb.Hdr.Status);
    }
 
    Hub->m_Control.Reuse();
    Hub->Post(NT_SUCCESS(Params->IoStatus.Status) ? HubEvent::PipeResetDone : HubEvent::PipeResetFailed);
}

HubResetComplete()

static VOID NTAPI HubResetComplete ( _In_ WDFREQUEST  Request, _In_ WDFIOTARGET  Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS  Params, _In_ WDFCONTEXT  Context  )

static

Definition at line 269 of file upstream.cpp.

{
    HubFdo* Hub = (HubFdo*)Context;
    NTSTATUS Status = Params->IoStatus.Status;
    UCXHUB_RESET_FLAGS Flags;
 
    UNREFERENCED_PARAMETER(Target);
 
    if (NT_SUCCESS(Status))
        DPRINT("Hub %p reset by parent, flags 0x%lx\n", Hub, Hub->m_ResetFlags);
    else
        DPRINT1("Hub %p reset by parent failed 0x%lx\n", Hub, Status);
 
    Flags.AsUlong = Hub->m_ResetFlags;
    if (NT_SUCCESS(Status) && Flags.HostContextLost)
        Hub->MarkDevicesProgrammingLost();
 
    WdfObjectDelete(Request);
 
    if (NT_SUCCESS(Status))
        Hub->Post(HubEvent::ResetDone);
    else if (Status == STATUS_NO_SUCH_DEVICE)
        Hub->Post(HubEvent::ResetFailedOnRemoval);
    else
        Hub->Post(HubEvent::ResetFailed);
}

HubSendToParent()

static BOOLEAN NTAPI HubSendToParent ( _In_ HubFdo *  Hub, _In_ WDFREQUEST  Request, _In_ ULONG  IoControlCode, _In_ PVOID  Payload, _In_ PFN_WDF_REQUEST_COMPLETION_ROUTINE  Completion, _In_ WDFCONTEXT  Context  )

static

Internal IOCTL to the hub's parent with Argument1 = Payload. FALSE when refused.

Definition at line 31 of file upstream.cpp.

{
    IO_STACK_LOCATION Stack;
    NTSTATUS Status;
 
    RtlZeroMemory(&Stack, sizeof(Stack));
    Stack.MajorFunction = IRP_MJ_INTERNAL_DEVICE_CONTROL;
    Stack.Parameters.DeviceIoControl.IoControlCode = IoControlCode;
    Stack.Parameters.Others.Argument1 = Payload;
    WdfRequestWdmFormatUsingStackLocation(Request, &Stack);
 
    WdfRequestSetCompletionRoutine(Request, Completion, Context);
 
    if (WdfRequestSend(Request, WdfDeviceGetIoTarget(Hub->m_Device), WDF_NO_SEND_OPTIONS))
        return TRUE;
 
    /* A refusal with a success status leaves nothing to report */
    Status = WdfRequestGetStatus(Request);
    if (!NT_SUCCESS(Status))
        DPRINT1("Hub %p parent request 0x%lx not sent 0x%lx\n", Hub, IoControlCode, Status);
 
    return NT_SUCCESS(Status);
}

Referenced by HubMachine::GetParentInfo(), HubMachine::ResetHub(), HubMachine::ResetStatusChangePipe(), and HubMachine::SelectHubConfiguration().

Variable Documentation

HubConfigurationComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubConfigurationComplete

static

Definition at line 22 of file upstream.cpp.

Referenced by HubMachine::SelectHubConfiguration().

HubParentInfoComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubParentInfoComplete

static

Definition at line 25 of file upstream.cpp.

Referenced by HubMachine::GetParentInfo().

HubPipeResetComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubPipeResetComplete

static

Definition at line 23 of file upstream.cpp.

Referenced by HubMachine::ResetStatusChangePipe().

HubResetComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubResetComplete

static

Definition at line 24 of file upstream.cpp.

Referenced by HubMachine::ResetHub().