rhub.cpp File Reference

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

Include dependency graph for rhub.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	UCX_RECIPIENT(Type)   ((Type) & 0x03)
#define	UCX_REQUEST_TYPE(Type)   (((Type) >> 5) & 0x03)
#define	UCX_DIRECTION_IN(Type)   (((Type) & 0x80) != 0)
#define	UCX_RECIPIENT_DEVICE   0
#define	UCX_RECIPIENT_OTHER   3
#define	UCX_TYPE_STANDARD   0
#define	UCX_TYPE_CLASS   1

Functions
VOID NTAPI	UcxEvtRootHubHeldTransferCancel (_In_ WDFREQUEST Request)
VOID NTAPI	UcxEvtRootHubInterruptTransfer (_In_ WDFQUEUE Queue, _In_ WDFREQUEST Request, _In_ size_t OutputBufferLength, _In_ size_t InputBufferLength, _In_ ULONG IoControlCode)
static BOOLEAN NTAPI	UcxClassifyRootHubRequest (_In_ const UCX_ROOTHUB_CONFIG *Config, _In_ const USB_DEFAULT_PIPE_SETUP_PACKET *Setup, _Out_ PFN_UCX_ROOTHUB_CONTROL_URB *Callback)
VOID NTAPI	UcxEvtRootHubControlTransfer (_In_ WDFQUEUE Queue, _In_ WDFREQUEST Request, _In_ size_t OutputBufferLength, _In_ size_t InputBufferLength, _In_ ULONG IoControlCode)

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file rhub.cpp.

UCX_DIRECTION_IN

#define UCX_DIRECTION_IN

(

Type

)

(((Type) & 0x80) != 0)

Definition at line 365 of file rhub.cpp.

UCX_RECIPIENT

#define UCX_RECIPIENT

(

Type

)

((Type) & 0x03)

Definition at line 363 of file rhub.cpp.

UCX_RECIPIENT_DEVICE

#define UCX_RECIPIENT_DEVICE   0

Definition at line 367 of file rhub.cpp.

UCX_RECIPIENT_OTHER

#define UCX_RECIPIENT_OTHER   3

Definition at line 368 of file rhub.cpp.

UCX_REQUEST_TYPE

#define UCX_REQUEST_TYPE

(

Type

)

(((Type) >> 5) & 0x03)

Definition at line 364 of file rhub.cpp.

UCX_TYPE_CLASS

#define UCX_TYPE_CLASS   1

Definition at line 370 of file rhub.cpp.

UCX_TYPE_STANDARD

#define UCX_TYPE_STANDARD   0

Definition at line 369 of file rhub.cpp.

Function Documentation

UcxClassifyRootHubRequest()

static BOOLEAN NTAPI UcxClassifyRootHubRequest ( _In_ const UCX_ROOTHUB_CONFIG *  Config, _In_ const USB_DEFAULT_PIPE_SETUP_PACKET *  Setup, _Out_ PFN_UCX_ROOTHUB_CONTROL_URB *  Callback  )

static

TRUE for the seven hub requests with their own callback slot, even if empty.

Definition at line 376 of file rhub.cpp.

{
    UCHAR Recipient = UCX_RECIPIENT(Setup->bmRequestType.B);
    UCHAR Type = UCX_REQUEST_TYPE(Setup->bmRequestType.B);
    BOOLEAN In = UCX_DIRECTION_IN(Setup->bmRequestType.B);
    BOOLEAN ToDevice = (Recipient == UCX_RECIPIENT_DEVICE);
    BOOLEAN ToPort = (Recipient == UCX_RECIPIENT_OTHER);
 
    *Callback = NULL;
 
    if (Type == UCX_TYPE_CLASS && (ToDevice || ToPort))
    {
        switch (Setup->bRequest)
        {
            case USB_REQUEST_CLEAR_FEATURE:
                if (In)
                    break;
                *Callback = ToDevice ? Config->EvtRootHubClearHubFeature
                                     : Config->EvtRootHubClearPortFeature;
                return TRUE;
 
            case USB_REQUEST_GET_STATUS:
                if (!In)
                    break;
                *Callback = ToDevice ? Config->EvtRootHubGetHubStatus
                                     : Config->EvtRootHubGetPortStatus;
                return TRUE;
 
            case USB_REQUEST_SET_FEATURE:
                if (In)
                    break;
                *Callback = ToDevice ? Config->EvtRootHubSetHubFeature
                                     : Config->EvtRootHubSetPortFeature;
                return TRUE;
        }
    }
 
    /* Matched as a standard device request, not the hub class form */
    if (Type == UCX_TYPE_STANDARD && ToDevice && In &&
        Setup->bRequest == USB_REQUEST_GET_PORT_ERR_COUNT)
    {
        *Callback = Config->EvtRootHubGetPortErrorCount;
        return TRUE;
    }
 
    return FALSE;
}

Referenced by UcxEvtRootHubControlTransfer().

UcxEvtRootHubControlTransfer()

VOID NTAPI UcxEvtRootHubControlTransfer	(	_In_ WDFQUEUE	Queue,
		_In_ WDFREQUEST	Request,
		_In_ size_t	OutputBufferLength,
		_In_ size_t	InputBufferLength,
		_In_ ULONG	IoControlCode
	)

Definition at line 429 of file rhub.cpp.

{
    UcxRootHub* RootHub = UcxGetControlQueueContext(Queue)->RootHub;
    PURB Urb = (PURB)UcxRequestArgs(Request).Arg1;
    PUSB_DEFAULT_PIPE_SETUP_PACKET Setup;
    PFN_UCX_ROOTHUB_CONTROL_URB Callback;
 
    UNREFERENCED_PARAMETER(OutputBufferLength);
    UNREFERENCED_PARAMETER(InputBufferLength);
    UNREFERENCED_PARAMETER(IoControlCode);
 
    if (!RootHub->m_Controller->BlockReset())
    {
        DPRINT1("Root hub %p failing control transfer %p, controller resetting\n", RootHub, Request);
        WdfRequestComplete(Request, STATUS_NO_SUCH_DEVICE);
        return;
    }
 
    /* Same offset in the plain and the _EX control transfer URBs */
    Setup = (PUSB_DEFAULT_PIPE_SETUP_PACKET)Urb->UrbControlTransfer.SetupPacket;
 
    /* A recognized hub request with no callback is not offered to EvtRootHubControlUrb */
    if (!UcxClassifyRootHubRequest(&RootHub->m_Config, Setup, &Callback))
        Callback = RootHub->m_Config.EvtRootHubControlUrb;
 
    if (Callback != NULL)
        Callback(RootHub->m_Handle, Request);
 
    RootHub->m_Controller->UnblockReset();
 
    if (Callback == NULL)
    {
        DPRINT1("Root hub %p has no callback for request 0x%x type 0x%x\n",
                RootHub, Setup->bRequest, Setup->bmRequestType.B);
        NT_ASSERT(FALSE);
        WdfRequestComplete(Request, STATUS_NOT_SUPPORTED);
    }
}

UcxEvtRootHubHeldTransferCancel()

VOID NTAPI UcxEvtRootHubHeldTransferCancel

(

_In_ WDFREQUEST

Request

)

Definition at line 281 of file rhub.cpp.

{
    UcxInterruptQueueState* State = UcxGetInterruptQueueState(WdfRequestGetIoQueue(Request));
 
    {
        SpinLockGuard Guard(&State->PortChangeLock);
 
        State->HeldTransfer = NULL;
        State->LastTransferCanceled = TRUE;
    }
 
    DPRINT("Held status change transfer %p canceled\n", Request);
    WdfRequestComplete(Request, STATUS_CANCELLED);
}

UcxEvtRootHubInterruptTransfer()

VOID NTAPI UcxEvtRootHubInterruptTransfer	(	_In_ WDFQUEUE	Queue,
		_In_ WDFREQUEST	Request,
		_In_ size_t	OutputBufferLength,
		_In_ size_t	InputBufferLength,
		_In_ ULONG	IoControlCode
	)

Definition at line 300 of file rhub.cpp.

{
    UcxInterruptQueueState* State = UcxGetInterruptQueueState(Queue);
    UcxRootHub* RootHub = State->RootHub;
    PURB Urb = (PURB)UcxRequestArgs(Request).Arg1;
    NTSTATUS HoldStatus = STATUS_SUCCESS;
    BOOLEAN Hold;
 
    UNREFERENCED_PARAMETER(OutputBufferLength);
    UNREFERENCED_PARAMETER(InputBufferLength);
    UNREFERENCED_PARAMETER(IoControlCode);
 
    NT_ASSERT(Urb->UrbHeader.Function == URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER);
 
    {
        SpinLockGuard Guard(&State->PortChangeLock);
 
        State->LastTransferCanceled = FALSE;
 
        Hold = (Urb->UrbHeader.UsbdFlags & UCXHUB_URB_FLAG_PEND_INTERRUPT_TX) != 0 &&
               State->PortChangeGeneration == State->PortChangeGenerationProcessed;
 
        if (!Hold)
        {
            State->PortChangeGenerationProcessed = State->PortChangeGeneration;
        }
        else
        {
            HoldStatus = WdfRequestMarkCancelableEx(Request, UcxEvtRootHubHeldTransferCancel);
            if (NT_SUCCESS(HoldStatus))
                State->HeldTransfer = Request;
        }
    }
 
    if (!NT_SUCCESS(HoldStatus))
    {
        DPRINT1("Root hub %p could not hold status change transfer %p 0x%lx\n", RootHub, Request, HoldStatus);
        WdfRequestComplete(Request, HoldStatus);
        return;
    }
 
    if (Hold)
        return;
 
    if (!RootHub->m_Controller->BlockReset())
    {
        DPRINT1("Root hub %p failing status change transfer %p, controller resetting\n", RootHub, Request);
        WdfRequestComplete(Request, STATUS_NO_SUCH_DEVICE);
        return;
    }
 
    RootHub->m_Config.EvtRootHubInterruptTx(RootHub->m_Handle, Request);
    RootHub->m_Controller->UnblockReset();
}