#include "xhcidrv.h"
#include <drivers/usb3/hubucx.h>
#include <debug.h>

Include dependency graph for rootports.cpp:

Classes
struct	_XHCI_ROOTHUB_CONTEXT

struct	_XHCI_SPEED_LIST

Macros
#define	NDEBUG

Typedefs
typedef struct _XHCI_ROOTHUB_CONTEXT	XHCI_ROOTHUB_CONTEXT

typedef struct _XHCI_ROOTHUB_CONTEXT *	PXHCI_ROOTHUB_CONTEXT

typedef struct _XHCI_SPEED_LIST	XHCI_SPEED_LIST

typedef struct _XHCI_SPEED_LIST *	PXHCI_SPEED_LIST

Enumerations
enum	: USHORT { FeatureHubLocalPowerChange = 0 , FeatureHubOverCurrentChange = 1 , FeaturePortEnable = 1 , FeaturePortSuspend = 2 , FeaturePortReset = 4 , FeaturePortLinkState = 5 , FeaturePortPower = 8 , FeatureConnectChange = 16 , FeatureEnableChange = 17 , FeatureSuspendChange = 18 , FeatureOverCurrentChange = 19 , FeatureResetChange = 20 , FeaturePortTest = 21 , FeaturePortIndicator = 22 , FeatureU1Timeout = 23 , FeatureU2Timeout = 24 , FeatureLinkStateChange = 25 , FeatureConfigErrorChange = 26 , FeatureRemoteWakeMask = 27 , FeatureWarmReset = 28 , FeatureWarmResetChange = 29 , FeatureForceLinkPmAccept = 30 }

Functions
	WDF_DECLARE_CONTEXT_TYPE_WITH_NAME (XHCI_ROOTHUB_CONTEXT, XhciGetRootHubContext)

FORCEINLINE ULONG NTAPI	XhciLinkState (_In_ ULONG PortSc)

FORCEINLINE ULONG NTAPI	XhciPortSpeed (_In_ ULONG PortSc)

FORCEINLINE ULONG NTAPI	XhciLinkWrite (_In_ ULONG State)

FORCEINLINE BOOLEAN NTAPI	XhciPortActive (_In_ ULONG PortSc)

static PVOID NTAPI	XhciRequestArgument (_In_ WDFREQUEST Request)

FORCEINLINE PUSB_DEFAULT_PIPE_SETUP_PACKET NTAPI	XhciSetupOf (_In_ PURB Urb)

static PVOID NTAPI	XhciTransferBuffer (_In_opt_ PVOID Buffer, _In_opt_ PMDL Mdl, _In_ ULONG Length, _In_ ULONG Needed)

static PVOID NTAPI	XhciHubRequestBuffer (_In_ PURB Urb, _In_ ULONG Needed)

static VOID NTAPI	XhciTraceBadRequest (_In_ PCSTR Callback, _In_ PURB Urb)

static VOID NTAPI	XhciAddSpeed (_Inout_ PXHCI_SPEED_LIST List, _In_ ULONG Id, _In_ ULONG Exponent, _In_ ULONG Mantissa, _In_ ULONG Mode, _In_ ULONG Direction)

Variables
static const UCHAR	HubRequestToHub = 0x20

static const UCHAR	HubRequestFromHub = 0xA0

static const UCHAR	HubRequestToPort = 0x23

static const UCHAR	HubRequestFromPort = 0xA3

static const ULONG	XhciResumeSignalMs = 50

static const ULONG	XhciU3WaitSteps = 2400

static const ULONG	XhciU0WaitSteps = 1200

static const ULONG	XhciResumeWaitSteps = 1200

static const ULONG	XhciPortGone = 0xFFFFFFFF

Macro Definition Documentation

◆ NDEBUG

#define NDEBUG

Definition at line 11 of file rootports.cpp.

Typedef Documentation

◆ PXHCI_ROOTHUB_CONTEXT

typedef struct _XHCI_ROOTHUB_CONTEXT * PXHCI_ROOTHUB_CONTEXT

◆ PXHCI_SPEED_LIST

typedef struct _XHCI_SPEED_LIST * PXHCI_SPEED_LIST

◆ XHCI_ROOTHUB_CONTEXT

typedef struct _XHCI_ROOTHUB_CONTEXT XHCI_ROOTHUB_CONTEXT

◆ XHCI_SPEED_LIST

typedef struct _XHCI_SPEED_LIST XHCI_SPEED_LIST

Enumeration Type Documentation

◆ anonymous enum

anonymous enum : USHORT

Enumerator
FeatureHubLocalPowerChange
FeatureHubOverCurrentChange
FeaturePortEnable
FeaturePortSuspend
FeaturePortReset
FeaturePortLinkState
FeaturePortPower
FeatureConnectChange
FeatureEnableChange
FeatureSuspendChange
FeatureOverCurrentChange
FeatureResetChange
FeaturePortTest
FeaturePortIndicator
FeatureU1Timeout
FeatureU2Timeout
FeatureLinkStateChange
FeatureConfigErrorChange
FeatureRemoteWakeMask
FeatureWarmReset
FeatureWarmResetChange
FeatureForceLinkPmAccept

Definition at line 20 of file rootports.cpp.

{
    FeatureHubLocalPowerChange = 0,
    FeatureHubOverCurrentChange = 1,
    FeaturePortEnable = 1,
    FeaturePortSuspend = 2,
    FeaturePortReset = 4,
    FeaturePortLinkState = 5,
    FeaturePortPower = 8,
    FeatureConnectChange = 16,
    FeatureEnableChange = 17,
    FeatureSuspendChange = 18,
    FeatureOverCurrentChange = 19,
    FeatureResetChange = 20,
    FeaturePortTest = 21,
    FeaturePortIndicator = 22,
    FeatureU1Timeout = 23,
    FeatureU2Timeout = 24,
    FeatureLinkStateChange = 25,
    FeatureConfigErrorChange = 26,
    FeatureRemoteWakeMask = 27,
    FeatureWarmReset = 28,
    FeatureWarmResetChange = 29,
    FeatureForceLinkPmAccept = 30
};

Function Documentation

◆ WDF_DECLARE_CONTEXT_TYPE_WITH_NAME()

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME	(	XHCI_ROOTHUB_CONTEXT	,
		XhciGetRootHubContext
	)

◆ XhciAddSpeed()

static VOID NTAPI XhciAddSpeed	(	_Inout_ PXHCI_SPEED_LIST	List,
		_In_ ULONG	Id,
		_In_ ULONG	Exponent,
		_In_ ULONG	Mantissa,
		_In_ ULONG	Mode,
		_In_ ULONG	Direction
	)

static

Appends one sublink speed (Mode 1 asymmetric, Direction 1 TX); counts past capacity.

Definition at line 1962 of file rootports.cpp.

{
    if (List->Count < List->Capacity)
    {
        PUSB_DEVICE_CAPABILITY_SUPERSPEEDPLUS_SPEED Speed = &List->Speeds[List->Count];
 
        Speed->AsUlong32 = 0;
        Speed->SublinkSpeedAttrID = Id;
        Speed->LaneSpeedExponent = Exponent;
        Speed->SublinkTypeMode = Mode;
        Speed->SublinkTypeDir = Direction;
        Speed->LinkProtocol = (List->Minor != 0 && Id > 4) ? 1 : 0;
        Speed->LaneSpeedMantissa = Mantissa;
    }
 
    List->Count++;
}

Referenced by XhciRootHub::FillSpeeds().

◆ XhciHubRequestBuffer()

static PVOID NTAPI XhciHubRequestBuffer	(	_In_ PURB	Urb,
		_In_ ULONG	Needed
	)

static

Definition at line 151 of file rootports.cpp.

{
    struct _URB_CONTROL_TRANSFER* Transfer = &Urb->UrbControlTransfer;
 
    return XhciTransferBuffer(Transfer->TransferBuffer,
                              Transfer->TransferBufferMDL,
                              Transfer->TransferBufferLength,
                              Needed);
}

Referenced by XhciRootHub::GetHubStatus(), XhciRootHub::GetPortErrorCount(), and XhciRootHub::GetPortStatus().

◆ XhciLinkState()

FORCEINLINE ULONG NTAPI XhciLinkState ( _In_ ULONG PortSc )

Definition at line 66 of file rootports.cpp.

{
    return (PortSc & XHCI_PORTSC_PLS_MASK) >> XHCI_PORTSC_PLS_SHIFT;
}

Referenced by XhciRootHub::AcknowledgeResume(), XhciRootHub::ClearUsb20PortFeature(), XhciRootHub::GetPortStatus(), XhciRootHub::InterruptTransfer(), XhciRootHub::IsPortConnected(), XhciRootHub::ResuspendResumedPorts(), XhciRootHub::SuspendPort(), XhciRootHub::WaitForU3(), XhciRootHub::WaitU0(), and XhciPortActive().

◆ XhciLinkWrite()

FORCEINLINE ULONG NTAPI XhciLinkWrite ( _In_ ULONG State )

PORTSC bits that move the link to State.

Definition at line 85 of file rootports.cpp.

{
    return (State << XHCI_PORTSC_PLS_SHIFT) | XHCI_PORTSC_LWS;
}

Referenced by XhciRootHub::AcknowledgeResume(), XhciRootHub::ClearUsb20PortFeature(), XhciRootHub::SetUsb30LinkState(), XhciRootHub::SuspendPort(), XhciRootHub::WaitForU3(), and XhciRootHub::WaitU0().

◆ XhciPortActive()

FORCEINLINE BOOLEAN NTAPI XhciPortActive ( _In_ ULONG PortSc )

Powered, connected, enabled, no pending connect change and not SS.Disabled.

Definition at line 95 of file rootports.cpp.

{
    const ULONG Needed = XHCI_PORTSC_PP | XHCI_PORTSC_CCS | XHCI_PORTSC_PED;
 
    if ((PortSc & Needed) != Needed || (PortSc & XHCI_PORTSC_CSC))
        return FALSE;
 
    return XhciLinkState(PortSc) != PORT_LINK_STATE_DISABLED;
}

Referenced by XhciRootHub::ResuspendResumedPorts(), XhciRootHub::WaitForU3(), and XhciRootHub::WaitU0().

◆ XhciPortSpeed()

FORCEINLINE ULONG NTAPI XhciPortSpeed ( _In_ ULONG PortSc )

Definition at line 75 of file rootports.cpp.

{
    return (PortSc & XHCI_PORTSC_SPEED_MASK) >> XHCI_PORTSC_SPEED_SHIFT;
}

Referenced by XhciRootHub::GetPortStatus().

◆ XhciRequestArgument()

static PVOID NTAPI XhciRequestArgument ( _In_ WDFREQUEST Request )

static

Definition at line 109 of file rootports.cpp.

{
    WDF_REQUEST_PARAMETERS Parameters;
 
    WDF_REQUEST_PARAMETERS_INIT(&Parameters);
    WdfRequestGetParameters(Request, &Parameters);
    return Parameters.Parameters.Others.Arg1;
}

◆ XhciSetupOf()

FORCEINLINE PUSB_DEFAULT_PIPE_SETUP_PACKET NTAPI XhciSetupOf ( _In_ PURB Urb )

Definition at line 122 of file rootports.cpp.

{
    /* Same offset in the plain and the _EX control transfer URBs */
    return (PUSB_DEFAULT_PIPE_SETUP_PACKET)Urb->UrbControlTransfer.SetupPacket;
}

Referenced by XhciRootHub::ClearHubFeature(), XhciRootHub::ClearPortFeature(), XhciRootHub::GetHubStatus(), XhciRootHub::GetPortErrorCount(), XhciRootHub::GetPortStatus(), XhciRootHub::SetPortFeature(), and XhciTraceBadRequest().

◆ XhciTraceBadRequest()

static VOID NTAPI XhciTraceBadRequest	(	_In_ PCSTR	Callback,
		_In_ PURB	Urb
	)

static

Definition at line 166 of file rootports.cpp.

{
    PUSB_DEFAULT_PIPE_SETUP_PACKET Setup = XhciSetupOf(Urb);
 
    DPRINT1("Root hub %s: rejecting setup %02x %02x %04x %04x %04x\n",
            Callback, Setup->bmRequestType.B, Setup->bRequest, Setup->wValue.W, Setup->wIndex.W, Setup->wLength);
}

Referenced by XhciRootHub::ClearHubFeature(), XhciRootHub::ClearPortFeature(), XhciRootHub::GetHubStatus(), XhciRootHub::GetPortErrorCount(), XhciRootHub::GetPortStatus(), and XhciRootHub::SetPortFeature().

◆ XhciTransferBuffer()

static PVOID NTAPI XhciTransferBuffer	(	_In_opt_ PVOID	Buffer,
		_In_opt_ PMDL	Mdl,
		_In_ ULONG	Length,
		_In_ ULONG	Needed
	)

static

Data buffer of a transfer with room for Needed bytes, or NULL.

Definition at line 133 of file rootports.cpp.

{
    if (Length < Needed)
        return NULL;
 
    if (Buffer == NULL && Mdl != NULL)
        Buffer = MmGetSystemAddressForMdlSafe(Mdl, NormalPagePriority);
 
    return Buffer;
}

Referenced by XhciRootHub::InterruptTransfer(), and XhciHubRequestBuffer().

Variable Documentation

◆ HubRequestFromHub

const UCHAR HubRequestFromHub = 0xA0

static

Definition at line 16 of file rootports.cpp.

Referenced by XhciRootHub::GetHubStatus().

◆ HubRequestFromPort

const UCHAR HubRequestFromPort = 0xA3

static

Definition at line 18 of file rootports.cpp.

Referenced by XhciRootHub::GetPortErrorCount(), and XhciRootHub::GetPortStatus().

◆ HubRequestToHub

const UCHAR HubRequestToHub = 0x20

static

Definition at line 15 of file rootports.cpp.

Referenced by XhciRootHub::ClearHubFeature().

◆ HubRequestToPort

const UCHAR HubRequestToPort = 0x23

static

Definition at line 17 of file rootports.cpp.

Referenced by XhciRootHub::ClearPortFeature(), and XhciRootHub::SetPortFeature().

◆ XhciPortGone

const ULONG XhciPortGone = 0xFFFFFFFF

static

Definition at line 54 of file rootports.cpp.

Referenced by XhciRootHub::AcknowledgeResume(), XhciRootHub::CheckRunning(), XhciRootHub::GetPortStatus(), XhciRootHub::InterruptTransfer(), XhciRootHub::ResuspendResumedPorts(), XhciRootHub::WaitForU3(), and XhciRootHub::WaitU0().

◆ XhciResumeSignalMs

const ULONG XhciResumeSignalMs = 50

static

Definition at line 47 of file rootports.cpp.

Referenced by XhciRootHub::StartResumeTimer().

◆ XhciResumeWaitSteps

const ULONG XhciResumeWaitSteps = 1200

static

Definition at line 52 of file rootports.cpp.

Referenced by XhciRootHub::ResuspendResumedPorts().

◆ XhciU0WaitSteps

const ULONG XhciU0WaitSteps = 1200

static

Definition at line 51 of file rootports.cpp.

Referenced by XhciRootHub::WaitU0().

◆ XhciU3WaitSteps

const ULONG XhciU3WaitSteps = 2400

static

Definition at line 50 of file rootports.cpp.

Referenced by XhciRootHub::WaitForU3().

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ NDEBUG

Typedef Documentation

◆ PXHCI_ROOTHUB_CONTEXT

◆ PXHCI_SPEED_LIST

◆ XHCI_ROOTHUB_CONTEXT

◆ XHCI_SPEED_LIST

Enumeration Type Documentation

◆ anonymous enum

Function Documentation

◆ WDF_DECLARE_CONTEXT_TYPE_WITH_NAME()

◆ XhciAddSpeed()

◆ XhciHubRequestBuffer()

◆ XhciLinkState()

◆ XhciLinkWrite()

◆ XhciPortActive()

◆ XhciPortSpeed()

◆ XhciRequestArgument()

◆ XhciSetupOf()

◆ XhciTraceBadRequest()

◆ XhciTransferBuffer()

Variable Documentation

◆ HubRequestFromHub

◆ HubRequestFromPort

◆ HubRequestToHub

◆ HubRequestToPort

◆ XhciPortGone

◆ XhciResumeSignalMs

◆ XhciResumeWaitSteps

◆ XhciU0WaitSteps

◆ XhciU3WaitSteps