ctrlxfer.cpp File Reference

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

Include dependency graph for ctrlxfer.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG

Enumerations
enum class	XhciCtlStep : ULONG {   Setup , FirstData , MoreData , DataEventData ,   Status , StatusEventData , Done }

Functions
static XhciControlRing *NTAPI	XhciCtlOf (_In_ XhciTransferRing *Ring)
static XhciMapState NTAPI	XhciCtlMapState (_In_ const XhciTransferRing *Ring)
static VOID NTAPI	XhciCtlSetMapState (_Inout_ XhciTransferRing *Ring, _In_ XhciMapState State)
static ULONG NTAPI	XhciCtlTrbType (_In_ enum XhciTrbType Type)
static BOOLEAN NTAPI	XhciCtlIsHaltCode (_In_ ULONG Code)
static BOOLEAN NTAPI	XhciCtlIsStopCode (_In_ ULONG Code)
static USBD_STATUS NTAPI	XhciCtlUsbdStatusFromNt (_In_ NTSTATUS Status)
static VOID NTAPI	XhciCtlWrap (_Inout_ XhciTransferRing *Ring, _In_ BOOLEAN FirstOfTd, _In_ BOOLEAN InDataStage)
static VOID NTAPI	XhciCtlPut (_Inout_ XhciTransferRing *Ring, _Inout_ PXHCI_TRB Trb, _In_ BOOLEAN FirstOfTd)
	_Requires_lock_held_ (m_Ring->m_Lock) VOID XhciControlRing

Variables
static const ULONG_PTR	XhciCtlStatusStageFlag = 0x4
static const ULONG_PTR	XhciCtlValueFlagBits = 0x7
static const ULONG	XhciCtlTagSignature = 0x6C744358
static const ULONG	XhciCtlReasonBadTrbPointer = 0x101F
static const ULONG	XhciCtlReasonDuplicateEvent = 0x1020
static const ULONG	XhciCtlMaxTransfer = 0x10000
static const ULONG	XhciCtlMaxTrbLength = 0x10000
static const ULONG	XhciCtlShortDataStageTrb = 512
static const ULONG	XhciCtlImmediateBytes = 8
static const ULONG	XhciCtlSetupBytes = 8
static const ULONG	XhciCtlWorstCaseTd = 21

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file ctrlxfer.cpp.

Enumeration Type Documentation

XhciCtlStep

enum class XhciCtlStep : ULONG

strong

Enumerator
Setup
FirstData
MoreData
DataEventData
Status
StatusEventData
Done

Definition at line 32 of file ctrlxfer.cpp.

{
    Setup,
    FirstData,
    MoreData,
    DataEventData,
    Status,
    StatusEventData,
    Done
};

Function Documentation

_Requires_lock_held_()

_Requires_lock_held_

(

m_Ring->

m_Lock

)

Completes a request; the ring lock is dropped around the WDF call.

Completes the held request unless a cancel or timer callback still has to run.

Definition at line 881 of file ctrlxfer.cpp.

{
    if (Transfer->Mechanism == XhciControlMechanism::DoubleBuffer && Transfer->DataIn && Bytes != 0)
        RtlCopyMemory(Transfer->SystemBuffer, Transfer->DoubleBuffer->VirtualAddress, Bytes);
}

XhciCtlIsHaltCode()

static BOOLEAN NTAPI XhciCtlIsHaltCode ( _In_ ULONG  Code )

static

Codes after which the controller halts the endpoint.

Definition at line 84 of file ctrlxfer.cpp.

{
    switch (static_cast<XhciCompletionCode>(Code))
    {
        case XhciCompletionCode::DataBufferError:
        case XhciCompletionCode::BabbleDetected:
        case XhciCompletionCode::UsbTransactionError:
        case XhciCompletionCode::StallError:
        case XhciCompletionCode::InvalidStreamType:
        case XhciCompletionCode::EventLost:
        case XhciCompletionCode::InvalidStreamId:
        case XhciCompletionCode::SplitTransactionError:
            return TRUE;
        default:
            return FALSE;
    }
}

Referenced by XhciControlRing::OnEventDataEvent(), and XhciControlRing::OnTrbEvent().

XhciCtlIsStopCode()

static BOOLEAN NTAPI XhciCtlIsStopCode ( _In_ ULONG  Code )

static

Definition at line 106 of file ctrlxfer.cpp.

{
    return Code == static_cast<ULONG>(XhciCompletionCode::Stopped) ||
           Code == static_cast<ULONG>(XhciCompletionCode::StoppedLengthInvalid) ||
           Code == static_cast<ULONG>(XhciCompletionCode::StoppedShortPacket);
}

Referenced by XhciControlRing::OnEventDataEvent(), and XhciControlRing::OnTrbEvent().

XhciCtlMapState()

static XhciMapState NTAPI XhciCtlMapState ( _In_ const XhciTransferRing *  Ring )

static

Definition at line 55 of file ctrlxfer.cpp.

{
    return static_cast<XhciMapState>(Ring->m_MapState);
}

Referenced by XhciControlRing::BuildControlTd(), XhciControlRing::Disable(), XhciControlRing::DoorbellRungSinceFill(), XhciControlRing::ResumeRingFill(), XhciControlRing::SuspendRingFill(), and XhciControlRing::WriteTd().

XhciCtlOf()

static XhciControlRing *NTAPI XhciCtlOf ( _In_ XhciTransferRing *  Ring )

static

Definition at line 46 of file ctrlxfer.cpp.

{
    return &Ring->m_Type.Control;
}

Referenced by XhciControlRing::AllowReclaimOnCancel(), XhciControlRing::Cleanup(), XhciControlRing::ConsumePendingEvents(), XhciControlRing::Disable(), XhciControlRing::EnableForwardProgress(), XhciControlRing::Initialize(), XhciControlRing::OnTransferEvent(), XhciControlRing::RecoverTransfers(), XhciControlRing::ResumeRingFill(), and XhciControlRing::TagFromEvent().

XhciCtlPut()

static VOID NTAPI XhciCtlPut ( _Inout_ XhciTransferRing *  Ring, _Inout_ PXHCI_TRB  Trb, _In_ BOOLEAN  FirstOfTd  )

static

Stores a finished TRB; the first TRB of a TD stays invalid until the doorbell step.

Definition at line 160 of file ctrlxfer.cpp.

{
    ULONG Cycle = Ring->m_Cycle & XHCI_TRB_CYCLE;
 
    if (FirstOfTd)
        Cycle ^= XHCI_TRB_CYCLE;
 
    Trb->Dword[3] = (Trb->Dword[3] & ~XHCI_TRB_CYCLE) | Cycle;
    Ring->m_Trbs[Ring->m_EnqueueIndex] = *Trb;
    Ring->m_EnqueueIndex++;
}

Referenced by XhciControlRing::WriteTd().

XhciCtlSetMapState()

static VOID NTAPI XhciCtlSetMapState ( _Inout_ XhciTransferRing *  Ring, _In_ XhciMapState  State  )

static

Definition at line 64 of file ctrlxfer.cpp.

{
    InterlockedExchange(&Ring->m_MapState, static_cast<LONG>(State));
}

Referenced by XhciControlRing::BuildControlTd(), XhciControlRing::Disable(), XhciControlRing::ResumeRingFill(), XhciControlRing::SuspendRingFill(), and XhciControlRing::WriteTd().

XhciCtlTrbType()

static ULONG NTAPI XhciCtlTrbType ( _In_ enum XhciTrbType  Type )

static

Definition at line 74 of file ctrlxfer.cpp.

{
    return static_cast<ULONG>(Type) << XHCI_TRB_TYPE_SHIFT;
}

Referenced by XhciControlRing::WriteTd().

XhciCtlUsbdStatusFromNt()

static USBD_STATUS NTAPI XhciCtlUsbdStatusFromNt ( _In_ NTSTATUS  Status )

static

URB status for a request that finished without a hardware completion code.

Definition at line 118 of file ctrlxfer.cpp.

{
    switch (Status)
    {
        case STATUS_CANCELLED:
            return USBD_STATUS_CANCELED;
        case STATUS_INSUFFICIENT_RESOURCES:
            return USBD_STATUS_INSUFFICIENT_RESOURCES;
        case STATUS_NOT_SUPPORTED:
            return USBD_STATUS_NOT_SUPPORTED;
        default:
            return USBD_STATUS_INVALID_PARAMETER;
    }
}

XhciCtlWrap()

static VOID NTAPI XhciCtlWrap ( _Inout_ XhciTransferRing *  Ring, _In_ BOOLEAN  FirstOfTd, _In_ BOOLEAN  InDataStage  )

static

Writes a Link TRB back to the segment start at the enqueue index and wraps.

Definition at line 138 of file ctrlxfer.cpp.

{
    XHCI_TRB Link;
    ULONG64 Base = Ring->SegmentBase();
 
    Ring->BuildLinkTrb(&Link, FirstOfTd, InDataStage);
    Link.Dword[0] = static_cast<ULONG>(Base);
    Link.Dword[1] = static_cast<ULONG>(Base >> 32);
    Link.Dword[3] |= XHCI_LINK_TOGGLE_CYCLE;
 
    Ring->m_Trbs[Ring->m_EnqueueIndex] = Link;
    Ring->m_Cycle ^= XHCI_TRB_CYCLE;
    Ring->m_EnqueueIndex = 0;
}

Referenced by XhciControlRing::WriteTd().

Variable Documentation

XhciCtlImmediateBytes

const ULONG XhciCtlImmediateBytes = 8

static

Definition at line 26 of file ctrlxfer.cpp.

Referenced by XhciControlRing::Initialize().

XhciCtlMaxTransfer

const ULONG XhciCtlMaxTransfer = 0x10000

static

Definition at line 23 of file ctrlxfer.cpp.

Referenced by XhciControlRing::PrepareTransfer().

XhciCtlMaxTrbLength

const ULONG XhciCtlMaxTrbLength = 0x10000

static

Definition at line 24 of file ctrlxfer.cpp.

Referenced by XhciControlRing::WriteTd().

XhciCtlReasonBadTrbPointer

const ULONG XhciCtlReasonBadTrbPointer = 0x101F

static

Definition at line 20 of file ctrlxfer.cpp.

Referenced by XhciControlRing::OnTrbEvent().

XhciCtlReasonDuplicateEvent

const ULONG XhciCtlReasonDuplicateEvent = 0x1020

static

Definition at line 21 of file ctrlxfer.cpp.

Referenced by XhciControlRing::OnTrbEvent().

XhciCtlSetupBytes

const ULONG XhciCtlSetupBytes = 8

static

Definition at line 27 of file ctrlxfer.cpp.

Referenced by XhciControlRing::WriteTd().

XhciCtlShortDataStageTrb

const ULONG XhciCtlShortDataStageTrb = 512

static

Definition at line 25 of file ctrlxfer.cpp.

Referenced by XhciControlRing::WriteTd().

XhciCtlStatusStageFlag

const ULONG_PTR XhciCtlStatusStageFlag = 0x4

static

Definition at line 14 of file ctrlxfer.cpp.

Referenced by XhciControlRing::OnEventDataEvent(), and XhciControlRing::WriteTd().

XhciCtlTagSignature

const ULONG XhciCtlTagSignature = 0x6C744358

static

Definition at line 17 of file ctrlxfer.cpp.

Referenced by XhciControlRing::Initialize(), and XhciControlRing::TagFromEvent().

XhciCtlValueFlagBits

const ULONG_PTR XhciCtlValueFlagBits = 0x7

static

Definition at line 15 of file ctrlxfer.cpp.

Referenced by XhciControlRing::TagFromEvent(), and XhciControlRing::WriteTd().

XhciCtlWorstCaseTd

const ULONG XhciCtlWorstCaseTd = 21

static

Definition at line 30 of file ctrlxfer.cpp.

Referenced by XhciControlRing::WriteTd().