devlpm.cpp File Reference

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

Include dependency graph for devlpm.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	TIMEOUT_DISABLED   0x00
#define	TIMEOUT_SHORTEST   0x01
#define	U1_TIMEOUT_LONGEST   0x7F
#define	U2_TIMEOUT_LONGEST   0xFE
#define	TIMEOUT_ACCEPT_ONLY   0xFF
#define	LATENCY_TIMEOUT_FACTOR   5
#define	U2_TIMEOUT_UNIT   256
#define	INTERRUPT_USAGE_PERIODIC   0x00
#define	MICROFRAME_US   125
#define	TP_DELAY_5GBPS_NS   40
#define	MAX_PACKET_FORWARD_NS   2100
#define	PING_RESPONSE_NS   400
#define	NO_PING_FIRST_PERCENT   10
#define	NO_PING_LAST_PERCENT   160
#define	MIN_LINK_SPEED_BPS   50000000ULL
#define	TP_SYMBOL_NS_SCALE   200000000000ULL

Enumerations
enum class	HubU2Verdict { Computed , Off , AcceptOnly }

Functions
static BOOLEAN NTAPI	HubChildLpmBlocked (_In_ HubChild *Child)
static BOOLEAN NTAPI	HubChildHasPolicy (_In_ HubChild *Child, _In_ ULONG Bit)
static VOID NTAPI	HubChildSetLink (_In_ HubChild *Child, _In_ ULONG Bit, _In_ BOOLEAN Set)
static BOOLEAN NTAPI	HubChildHasNonControlPipe (_In_ HubConfiguration *Config)
static BOOLEAN NTAPI	HubChildPortKeepsU2Off (_In_ HubChild *Child)
BOOLEAN NTAPI	HubChildU2ForEnumerated (_In_ HubChild *Child)
static BOOLEAN NTAPI	HubChildU1FromPipes (_In_ HubChild *Child, _Out_ PUCHAR Timeout)
static HubU2Verdict NTAPI	HubChildU2FromPipes (_In_ HubChild *Child, _Out_ PUSHORT Longest, _Out_ PBOOLEAN PeriodicInterrupt)
static BOOLEAN NTAPI	HubLinkStateOff (_In_ UCHAR Timeout, _In_ BOOLEAN Target)
static DSM_FEATURE_CHANGE NTAPI	HubLinkChange (_In_ BOOLEAN Wanted, _In_ BOOLEAN Enabled)
static BOOLEAN NTAPI	HubTpDelayFromAttribute (_In_ const USB_DEVICE_CAPABILITY_SUPERSPEEDPLUS_SPEED *Attribute, _In_ ULONG LaneCount, _Out_ PUSHORT Delay)
static const USB_DEVICE_CAPABILITY_SUPERSPEEDPLUS_SPEED *NTAPI	HubPortFindSpeed (_In_ HubPort *Port, _In_ ULONG SpeedId, _In_ ULONG Direction)

Macro Definition Documentation

INTERRUPT_USAGE_PERIODIC

#define INTERRUPT_USAGE_PERIODIC   0x00

Definition at line 28 of file devlpm.cpp.

LATENCY_TIMEOUT_FACTOR

#define LATENCY_TIMEOUT_FACTOR   5

Definition at line 22 of file devlpm.cpp.

MAX_PACKET_FORWARD_NS

#define MAX_PACKET_FORWARD_NS   2100

Definition at line 35 of file devlpm.cpp.

MICROFRAME_US

#define MICROFRAME_US   125

Definition at line 31 of file devlpm.cpp.

MIN_LINK_SPEED_BPS

#define MIN_LINK_SPEED_BPS   50000000ULL

Definition at line 43 of file devlpm.cpp.

NDEBUG

#define NDEBUG

Definition at line 11 of file devlpm.cpp.

NO_PING_FIRST_PERCENT

#define NO_PING_FIRST_PERCENT   10

Definition at line 39 of file devlpm.cpp.

NO_PING_LAST_PERCENT

#define NO_PING_LAST_PERCENT   160

Definition at line 40 of file devlpm.cpp.

PING_RESPONSE_NS

#define PING_RESPONSE_NS   400

Definition at line 36 of file devlpm.cpp.

TIMEOUT_ACCEPT_ONLY

#define TIMEOUT_ACCEPT_ONLY   0xFF

Definition at line 19 of file devlpm.cpp.

TIMEOUT_DISABLED

#define TIMEOUT_DISABLED   0x00

Definition at line 15 of file devlpm.cpp.

TIMEOUT_SHORTEST

#define TIMEOUT_SHORTEST   0x01

Definition at line 16 of file devlpm.cpp.

TP_DELAY_5GBPS_NS

#define TP_DELAY_5GBPS_NS   40

Definition at line 34 of file devlpm.cpp.

TP_SYMBOL_NS_SCALE

#define TP_SYMBOL_NS_SCALE   200000000000ULL

Definition at line 46 of file devlpm.cpp.

U1_TIMEOUT_LONGEST

#define U1_TIMEOUT_LONGEST   0x7F

Definition at line 17 of file devlpm.cpp.

U2_TIMEOUT_LONGEST

#define U2_TIMEOUT_LONGEST   0xFE

Definition at line 18 of file devlpm.cpp.

U2_TIMEOUT_UNIT

#define U2_TIMEOUT_UNIT   256

Definition at line 25 of file devlpm.cpp.

Enumeration Type Documentation

HubU2Verdict

enum class HubU2Verdict

strong

Enumerator
Computed
Off
AcceptOnly

Definition at line 260 of file devlpm.cpp.

{
    Computed,
    Off,
    AcceptOnly
};

Function Documentation

HubChildHasNonControlPipe()

static BOOLEAN NTAPI HubChildHasNonControlPipe ( _In_ HubConfiguration *  Config )

static

Definition at line 85 of file devlpm.cpp.

{
    PLIST_ENTRY Entry;
    HubInterface* Interface;
    ULONG Index;
 
    for (Entry = Config->Interfaces.Flink; Entry != &Config->Interfaces; Entry = Entry->Flink)
    {
        Interface = CONTAINING_RECORD(Entry, HubInterface, Link);
 
        for (Index = 0; Index < Interface->PipeCount; Index++)
        {
            if ((Interface->Pipes[Index].Descriptor->bmAttributes & USB_ENDPOINT_TYPE_MASK) !=
                USB_ENDPOINT_TYPE_CONTROL)
            {
                return TRUE;
            }
        }
    }
 
    return FALSE;
}

Referenced by HubChildU1FromPipes(), and HubChildU2FromPipes().

HubChildHasPolicy()

static BOOLEAN NTAPI HubChildHasPolicy ( _In_ HubChild *  Child, _In_ ULONG  Bit  )

static

Definition at line 60 of file devlpm.cpp.

{
    return (Child->m_LpmPolicy & Bit) != 0;
}

Referenced by DeviceMachine::CalcU1Timeout(), DeviceMachine::CalcU2Timeout(), and HubChildU2ForEnumerated().

HubChildLpmBlocked()

static BOOLEAN NTAPI HubChildLpmBlocked ( _In_ HubChild *  Child )

static

Definition at line 51 of file devlpm.cpp.

{
    return Child->HasHack(ChildHack::DisableLpm) || Child->m_Hub->HasFlag(HubFlag::DisableLpm);
}

Referenced by DeviceMachine::CalcU1Timeout(), DeviceMachine::CalcU2Timeout(), and HubChildU2ForEnumerated().

HubChildPortKeepsU2Off()

static BOOLEAN NTAPI HubChildPortKeepsU2Off ( _In_ HubChild *  Child )

static

Definition at line 122 of file devlpm.cpp.

{
    HubPort* Port = Child->m_Port;
 
    if (!Port->HasFlag(PortFlag::AcpiNoU2))
        return FALSE;
 
    return !(Port->HasFlag(PortFlag::Usb4Host) && Child->m_TunnelState == HUB_TUNNEL_STATE_TUNNELED);
}

Referenced by HubChildU2ForEnumerated().

HubChildSetLink()

static VOID NTAPI HubChildSetLink ( _In_ HubChild *  Child, _In_ ULONG  Bit, _In_ BOOLEAN  Set  )

static

Definition at line 70 of file devlpm.cpp.

{
    if (Set)
        Child->m_LinkFlags |= Bit;
    else
        Child->m_LinkFlags &= ~Bit;
}

Referenced by DeviceMachine::CalcU1Timeout(), and DeviceMachine::CalcU2Timeout().

HubChildU1FromPipes()

static BOOLEAN NTAPI HubChildU1FromPipes ( _In_ HubChild *  Child, _Out_ PUCHAR  Timeout  )

static

Definition at line 163 of file devlpm.cpp.

{
    HubConfiguration* Config = Child->m_CurrentConfig;
    PUSB_ENDPOINT_DESCRIPTOR Endpoint;
    HubInterface* Interface;
    PLIST_ENTRY Entry;
    BOOLEAN NonControl;
    USHORT Latency;
    USHORT Value;
    USHORT Longest = 0;
    ULONG Index;
 
    *Timeout = TIMEOUT_DISABLED;
    if (Config == NULL)
        return TRUE;
 
    NonControl = HubChildHasNonControlPipe(Config);
 
    for (Entry = Config->Interfaces.Flink; Entry != &Config->Interfaces; Entry = Entry->Flink)
    {
        Interface = CONTAINING_RECORD(Entry, HubInterface, Link);
 
        for (Index = 0; Index < Interface->PipeCount; Index++)
        {
            Endpoint = Interface->Pipes[Index].Descriptor;
            Latency = USB_ENDPOINT_DIRECTION_IN(Endpoint->bEndpointAddress) ? Child->m_Sel.U1Sel
                                                                            : Child->m_HostU1ExitLatency;
 
            switch (Endpoint->bmAttributes & USB_ENDPOINT_TYPE_MASK)
            {
                case USB_ENDPOINT_TYPE_CONTROL:
                    Value = NonControl ? LATENCY_TIMEOUT_FACTOR : (USHORT)(LATENCY_TIMEOUT_FACTOR * Latency);
                    break;
 
                case USB_ENDPOINT_TYPE_ISOCHRONOUS:
                    if (Latency > Endpoint->bInterval * MICROFRAME_US)
                        return FALSE;
                    Value = TIMEOUT_SHORTEST;
                    break;
 
                default:
                    Value = (USHORT)(LATENCY_TIMEOUT_FACTOR * Latency);
                    break;
            }
 
            Longest = max(Longest, Value);
        }
    }
 
    /* Only the low byte is kept before capping: 0x105 gives 5 */
    *Timeout = min((UCHAR)Longest, U1_TIMEOUT_LONGEST);
    return TRUE;
}

Referenced by DeviceMachine::CalcU1Timeout().

HubChildU2ForEnumerated()

BOOLEAN NTAPI HubChildU2ForEnumerated

(

_In_ HubChild *

Child

)

TRUE when an enumerated, unconfigured device gets a U2 timeout; sets that timeout.

Definition at line 135 of file devlpm.cpp.

{
    if (!HubChildHasPolicy(Child, HUB_LPM_POLICY_U2_ACCEPT) ||
        HubChildLpmBlocked(Child) ||
        HubChildPortKeepsU2Off(Child))
    {
        return FALSE;
    }
 
    Child->m_U2Timeout = HubChildHasPolicy(Child, HUB_LPM_POLICY_U2_INITIATE) ? U2_TIMEOUT_LONGEST
                                                                              : TIMEOUT_ACCEPT_ONLY;
    return TRUE;
}

Referenced by DeviceMachine::U2NeededForEnumerated(), and DeviceMachine::UpdateDeviceInController().

HubChildU2FromPipes()

static HubU2Verdict NTAPI HubChildU2FromPipes ( _In_ HubChild *  Child, _Out_ PUSHORT  Longest, _Out_ PBOOLEAN  PeriodicInterrupt  )

static

Definition at line 270 of file devlpm.cpp.

{
    HubConfiguration* Config = Child->m_CurrentConfig;
    PUSB_ENDPOINT_DESCRIPTOR Endpoint;
    HubInterface* Interface;
    PLIST_ENTRY Entry;
    BOOLEAN NonControl;
    BOOLEAN NoHostInitiate = FALSE;
    USHORT Latency;
    USHORT Value;
    ULONG Index;
 
    *Longest = 0;
    *PeriodicInterrupt = FALSE;
    if (Config == NULL)
        return HubU2Verdict::Computed;
 
    NonControl = HubChildHasNonControlPipe(Config);
 
    for (Entry = Config->Interfaces.Flink; Entry != &Config->Interfaces; Entry = Entry->Flink)
    {
        Interface = CONTAINING_RECORD(Entry, HubInterface, Link);
 
        for (Index = 0; Index < Interface->PipeCount; Index++)
        {
            Endpoint = Interface->Pipes[Index].Descriptor;
            Latency = USB_ENDPOINT_DIRECTION_IN(Endpoint->bEndpointAddress) ? Child->m_Sel.U2Sel
                                                                            : Child->m_HostU2ExitLatency;
            Value = (USHORT)(LATENCY_TIMEOUT_FACTOR * Latency);
 
            switch (Endpoint->bmAttributes & USB_ENDPOINT_TYPE_MASK)
            {
                case USB_ENDPOINT_TYPE_CONTROL:
                    if (NonControl)
                        Value = TIMEOUT_SHORTEST;
                    break;
 
                case USB_ENDPOINT_TYPE_ISOCHRONOUS:
                    if (Latency > Endpoint->bInterval * MICROFRAME_US)
                        return HubU2Verdict::Off;
                    Value = TIMEOUT_SHORTEST;
                    break;
 
                case USB_ENDPOINT_TYPE_INTERRUPT:
                    if ((Endpoint->bmAttributes & USB_30_ENDPOINT_TYPE_INTERRUPT_USAGE_MASK) != INTERRUPT_USAGE_PERIODIC)
                        break;
 
                    *PeriodicInterrupt = TRUE;
                    if (Latency > Endpoint->bInterval * MICROFRAME_US)
                    {
                        NoHostInitiate = TRUE;
                        Value = TIMEOUT_ACCEPT_ONLY;
                    }
                    break;
 
                default:
                    break;
            }
 
            *Longest = max(*Longest, Value);
        }
    }
 
    return NoHostInitiate ? HubU2Verdict::AcceptOnly : HubU2Verdict::Computed;
}

Referenced by DeviceMachine::CalcU2Timeout().

HubLinkChange()

static DSM_FEATURE_CHANGE NTAPI HubLinkChange ( _In_ BOOLEAN  Wanted, _In_ BOOLEAN  Enabled  )

static

Definition at line 485 of file devlpm.cpp.

{
    if (Wanted == Enabled)
        return DsmFeatureKeep;
 
    return Wanted ? DsmFeatureEnable : DsmFeatureDisable;
}

Referenced by DeviceMachine::U1Change(), and DeviceMachine::U2Change().

HubLinkStateOff()

static BOOLEAN NTAPI HubLinkStateOff ( _In_ UCHAR  Timeout, _In_ BOOLEAN  Target  )

static

Definition at line 421 of file devlpm.cpp.

{
    return Timeout == TIMEOUT_DISABLED || (!Target && Timeout == TIMEOUT_ACCEPT_ONLY);
}

Referenced by DeviceMachine::ComputeExitLatency().

HubPortFindSpeed()

static const USB_DEVICE_CAPABILITY_SUPERSPEEDPLUS_SPEED *NTAPI HubPortFindSpeed ( _In_ HubPort *  Port, _In_ ULONG  SpeedId, _In_ ULONG  Direction  )

static

Definition at line 620 of file devlpm.cpp.

{
    const USB_DEVICE_CAPABILITY_SUPERSPEEDPLUS_SPEED* Attribute;
    ULONG Index;
 
    for (Index = 0; Index < Port->m_Info.SublinkSpeedAttrCount; Index++)
    {
        Attribute = &Port->m_Info.SublinkSpeedAttr[Index];
 
        if (Attribute->SublinkSpeedAttrID == SpeedId && Attribute->SublinkTypeDir == Direction)
            return Attribute;
    }
 
    return NULL;
}

Referenced by DeviceMachine::SetSpeedFor30().

HubTpDelayFromAttribute()

static BOOLEAN NTAPI HubTpDelayFromAttribute ( _In_ const USB_DEVICE_CAPABILITY_SUPERSPEEDPLUS_SPEED *  Attribute, _In_ ULONG  LaneCount, _Out_ PUSHORT  Delay  )

static

Definition at line 600 of file devlpm.cpp.

{
    static const ULONG64 Scale[] = { 1, 1000, 1000000, 1000000000 };
    ULONG64 Speed;
 
    Speed = Scale[Attribute->LaneSpeedExponent] * Attribute->LaneSpeedMantissa * (LaneCount + 1);
    if (Speed < MIN_LINK_SPEED_BPS)
        return FALSE;
 
    *Delay = (USHORT)(TP_SYMBOL_NS_SCALE / Speed);
    return TRUE;
}

Referenced by DeviceMachine::SetSpeedFor30().