hubreq.cpp File Reference

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

Include dependency graph for hubreq.cpp:

Go to the source code of this file.

Classes
struct	HubTtClear

Macros
#define	NDEBUG
#define	USB3_URB_RESERVED_RESOURCES   0x00000010
#define	HUB_USER_PORT_STATUS_OFFSET   4
#define	HUB_USER_PORT_STATUS_SIZE   8

Functions
static NTSTATUS NTAPI	HubTtClearValue (_In_ HubChild *Child, _In_ UCXENDPOINT Endpoint, _In_ ULONG EndpointAddress, _Out_ PUSHORT Value)
static VOID NTAPI	HubTtClearComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
VOID NTAPI	HubClearTtBuffer (_In_ UCXHUB_HUB_CONTEXT HubContext, _In_ UCXHUB_DEVICE_CONTEXT DeviceContext, _In_ UCXENDPOINT Endpoint, _In_ ULONG EndpointNumber, _In_ ULONG TtPortNumber)
static VOID NTAPI	HubControlComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
static VOID NTAPI	HubSendControl (_In_ HubFdo *Hub, _In_reads_bytes_opt_(Length) PVOID Buffer, _In_ ULONG Length, _In_ BOOLEAN ShortOk)
static VOID NTAPI	HubInterruptComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
static WDFREQUEST NTAPI	HubTakePortStatusRequest (_In_ HubFdo *Hub, _Out_ PWDF_REQUEST_PARAMETERS Params)

Variables
static const char	HubTagClearTt [] = "hub TT clear"
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubControlComplete
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubInterruptComplete

Macro Definition Documentation

HUB_USER_PORT_STATUS_OFFSET

#define HUB_USER_PORT_STATUS_OFFSET   4

Definition at line 286 of file hubreq.cpp.

HUB_USER_PORT_STATUS_SIZE

#define HUB_USER_PORT_STATUS_SIZE   8

Definition at line 287 of file hubreq.cpp.

NDEBUG

#define NDEBUG

Definition at line 10 of file hubreq.cpp.

USB3_URB_RESERVED_RESOURCES

#define USB3_URB_RESERVED_RESOURCES   0x00000010

Definition at line 15 of file hubreq.cpp.

Function Documentation

HubClearTtBuffer()

VOID NTAPI HubClearTtBuffer	(	_In_ UCXHUB_HUB_CONTEXT	HubContext,
		_In_ UCXHUB_DEVICE_CONTEXT	DeviceContext,
		_In_ UCXENDPOINT	Endpoint,
		_In_ ULONG	EndpointNumber,
		_In_ ULONG	TtPortNumber
	)

Definition at line 220 of file hubreq.cpp.

{
    HubFdo* Hub = HubFdo::FromContext(HubContext);
    HubChild* Child = (HubChild*)DeviceContext;
    HubTtClear* Clear = NULL;
    WDFREQUEST Request = NULL;
    BOOLEAN ResetTt = Hub->HasFlag(HubFlag::ResetTtOnCancel);
    USHORT Value;
    NTSTATUS Status;
 
    if (!Hub->HasFlag(HubFlag::TtHub) || Child == NULL || Hub->HasFlag(HubFlag::NoClearTtOnCancel))
        goto Done;
 
    /* Computed even for RESET_TT, which does not use it */
    WdfObjectReferenceWithTag(Child->m_Object, (PVOID)HubTagClearTt);
    Status = HubTtClearValue(Child, Endpoint, EndpointNumber, &Value);
    WdfObjectDereferenceWithTag(Child->m_Object, (PVOID)HubTagClearTt);
    if (!NT_SUCCESS(Status))
        goto Done;
 
    Clear = (HubTtClear*)ExAllocatePoolZero(NonPagedPool, sizeof(*Clear), HUB_TAG_HUB);
    if (Clear == NULL)
    {
        DPRINT1("Hub %p no memory for a TT clear\n", Hub);
        goto Done;
    }
 
    Clear->Hub = Hub;
    Clear->Endpoint = Endpoint;
 
    if (!NT_SUCCESS(Clear->Control.Create(Hub->m_Device, WdfDeviceGetIoTarget(Hub->m_Device))))
        goto Done;
    Request = Clear->Control.Request;
 
    Clear->Control.SetSetup(0x23,
                            ResetTt ? HUB_REQUEST_RESET_TT : HUB_REQUEST_CLEAR_TT_BUFFER,
                            ResetTt ? 0 : Value,
                            Hub->HasFlag(HubFlag::MultiTtHub) ? (USHORT)TtPortNumber : 1,
                            0);
 
    Status = Clear->Control.Send(Hub->m_RootHubTarget,
                                 Hub->UsbDevice(),
                                 HubTtClearComplete,
                                 Clear,
                                 NULL,
                                 0,
                                 FALSE,
                                 Hub->NeedsForwardProgress());
    if (NT_SUCCESS(Status))
        return;
 
Done:
    if (Request != NULL)
        WdfObjectDelete(Request);
    if (Clear != NULL)
        ExFreePoolWithTag(Clear, HUB_TAG_HUB);
 
    Hub->m_Stack.ClearTtBufferComplete(Hub->m_Stack.Hub, Endpoint);
}

HubControlComplete()

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

static

Definition at line 297 of file hubreq.cpp.

{
    HubFdo* Hub = (HubFdo*)Context;
    NTSTATUS Status = Params->IoStatus.Status;
 
    UNREFERENCED_PARAMETER(Request);
    UNREFERENCED_PARAMETER(Target);
 
    Hub->m_Control.Reuse();
 
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Hub %p control request 0x%x failed 0x%lx, URB status 0x%lx\n",
                Hub, Hub->m_Control.Urb.SetupPacket[1], Status, Hub->m_Control.Urb.Hdr.Status);
        Hub->m_FailureMessageId = HUB_MSG_CONTROL_TRANSFER_FAILED;
        Hub->Post(HubEvent::TransferFailed);
        return;
    }
 
    Hub->Post(HubEvent::TransferDone);
}

HubInterruptComplete()

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

static

Definition at line 661 of file hubreq.cpp.

{
    HubFdo* Hub = (HubFdo*)Context;
    HubInterruptRequest* Interrupt = &Hub->m_Interrupt;
    NTSTATUS Status = Params->IoStatus.Status;
 
    UNREFERENCED_PARAMETER(Request);
    UNREFERENCED_PARAMETER(Target);
 
    /* Built by hand; the bitmap helper that initializes it is pageable */
    Interrupt->BitmapBytes = (USHORT)Interrupt->Urb.TransferBufferLength;
    Interrupt->Bitmap.SizeOfBitMap = Interrupt->BitmapBytes * 8;
    Interrupt->Bitmap.Buffer = (PULONG)Interrupt->BitmapBuffer;
 
    if (!NT_SUCCESS(Status))
    {
        /* The hub cancels its own read when it powers down */
        if (Status == STATUS_CANCELLED)
        {
            DPRINT("Hub %p status change read canceled\n", Hub);
        }
        else
        {
            DPRINT1("Hub %p status change read failed 0x%lx, URB status 0x%lx\n",
                    Hub, Status, Interrupt->Urb.Hdr.Status);
            Hub->m_FailureMessageId = HUB_MSG_INTERRUPT_FAILED;
        }
 
        Hub->Post(HubEvent::InterruptFailed);
        return;
    }
 
    Hub->Post(HubEvent::InterruptDone);
}

HubSendControl()

static VOID NTAPI HubSendControl ( _In_ HubFdo *  Hub, _In_reads_bytes_opt_(Length) PVOID  Buffer, _In_ ULONG  Length, _In_ BOOLEAN  ShortOk  )

static

Definition at line 327 of file hubreq.cpp.

{
    NTSTATUS Status;
 
    Status = Hub->m_Control.Send(Hub->m_RootHubTarget,
                                 Hub->UsbDevice(),
                                 HubControlComplete,
                                 Hub,
                                 Buffer,
                                 Length,
                                 ShortOk,
                                 Hub->NeedsForwardProgress());
    if (!NT_SUCCESS(Status))
        Hub->Post(HubEvent::TransferFailed);
}

Referenced by HubMachine::AckHubChange(), HubMachine::GetHubDescriptor(), HubMachine::GetHubStatus(), HubMachine::GetPortStatus(), HubMachine::GetStandardStatus(), and HubMachine::SetHubDepth().

HubTakePortStatusRequest()

static WDFREQUEST NTAPI HubTakePortStatusRequest ( _In_ HubFdo *  Hub, _Out_ PWDF_REQUEST_PARAMETERS  Params  )

static

Definition at line 803 of file hubreq.cpp.

{
    WDFREQUEST Request = Hub->m_PortStatusRequest;
 
    Hub->m_PortStatusRequest = NULL;
 
    WDF_REQUEST_PARAMETERS_INIT(Params);
    WdfRequestGetParameters(Request, Params);
    return Request;
}

Referenced by HubMachine::FailPortStatus(), and HubMachine::ReplyPortStatus().

HubTtClearComplete()

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

static

Definition at line 194 of file hubreq.cpp.

{
    HubTtClear* Clear = (HubTtClear*)Context;
    HubFdo* Hub = Clear->Hub;
 
    UNREFERENCED_PARAMETER(Target);
 
    if (!NT_SUCCESS(Params->IoStatus.Status))
    {
        DPRINT1("Hub %p TT clear for endpoint %p failed 0x%lx, URB status 0x%lx\n",
                Hub, Clear->Endpoint, Params->IoStatus.Status, Clear->Control.Urb.Hdr.Status);
    }
 
    Hub->m_Stack.ClearTtBufferComplete(Hub->m_Stack.Hub, Clear->Endpoint);
 
    WdfObjectDelete(Request);
    ExFreePoolWithTag(Clear, HUB_TAG_HUB);
}

Referenced by HubClearTtBuffer().

HubTtClearValue()

static NTSTATUS NTAPI HubTtClearValue ( _In_ HubChild *  Child, _In_ UCXENDPOINT  Endpoint, _In_ ULONG  EndpointAddress, _Out_ PUSHORT  Value  )

static

Definition at line 130 of file hubreq.cpp.

{
    HubConfiguration* Config = Child->m_CurrentConfig;
    PLIST_ENTRY Entry;
    HubInterface* Interface;
    HubPipe* Pipe;
    ULONG Index;
    USHORT Type;
 
    *Value = 0;
 
    if (Child->Speed() != UsbLowSpeed && Child->Speed() != UsbFullSpeed)
        return STATUS_UNSUCCESSFUL;
 
    if (Endpoint == Child->m_DefaultEndpoint)
    {
        *Value = (USHORT)((EndpointAddress & 0x0F) | ((Child->m_Address & 0x7F) << 4));
        return STATUS_SUCCESS;
    }
 
    if (Config == NULL)
        return STATUS_UNSUCCESSFUL;
 
    for (Entry = Config->Interfaces.Flink; Entry != &Config->Interfaces; Entry = Entry->Flink)
    {
        Interface = CONTAINING_RECORD(Entry, HubInterface, Link);
 
        for (Index = 0; Index < Interface->PipeCount; Index++)
        {
            Pipe = &Interface->Pipes[Index];
            if (Pipe->Endpoint != Endpoint)
                continue;
 
            switch (Pipe->Descriptor->bmAttributes & USB_ENDPOINT_TYPE_MASK)
            {
                case USB_ENDPOINT_TYPE_BULK:
                    Type = 2;
                    break;
 
                case USB_ENDPOINT_TYPE_CONTROL:
                    Type = 0;
                    break;
 
                default:
                    return STATUS_UNSUCCESSFUL;
            }
 
            *Value = (USHORT)((EndpointAddress & 0x0F) | ((Child->m_Address & 0x7F) << 4) | (Type << 11));
            if (EndpointAddress & USB_ENDPOINT_DIRECTION_MASK)
                *Value |= 0x8000;
            return STATUS_SUCCESS;
        }
    }
 
    return STATUS_UNSUCCESSFUL;
}

Referenced by HubClearTtBuffer().

Variable Documentation

HubControlComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubControlComplete

static

Definition at line 289 of file hubreq.cpp.

Referenced by HubMachine::GetConfigDescriptor(), and HubSendControl().

HubInterruptComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubInterruptComplete

static

Definition at line 290 of file hubreq.cpp.

Referenced by HubMachine::StartStatusChangeRead().

HubTagClearTt

const char HubTagClearTt[] = "hub TT clear"

static

Definition at line 116 of file hubreq.cpp.

Referenced by HubClearTtBuffer().