portxfer.cpp File Reference

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

Include dependency graph for portxfer.cpp:

Go to the source code of this file.

Classes
struct	PortChangeOrder

Macros
#define	NDEBUG
#define	PORT_OVER_CURRENT_LIMIT   5
#define	PORT_OVER_CURRENT_WINDOW   (3LL * 1000 * 1000 * 10)

Functions
static VOID NTAPI	PortTrackPendingOperation (_In_ HubPort *Port, _In_ USBD_STATUS UrbStatus)
static VOID NTAPI	PortCacheSetFeature (_In_ HubPort *Port)
static VOID NTAPI	PortControlComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
static VOID NTAPI	PortSendControl (_In_ HubPort *Port, _In_ UCHAR RequestType, _In_ UCHAR Request, _In_ USHORT Value, _In_ USHORT Index, _In_reads_bytes_opt_(Length) PVOID Buffer, _In_ USHORT Length)
static USHORT NTAPI	PortIndex (_In_ HubPort *Port, _In_ UCHAR High)
static VOID NTAPI	PortDropInitialConnectReference (_In_ HubPort *Port)
static PortEvent NTAPI	PortNextChange20 (_In_ HubPort *Port, _In_ USHORT Status, _In_ USHORT Previous, _In_ USHORT Change)
static PortEvent NTAPI	PortNextChange30 (_In_ HubPort *Port, _In_ USHORT Status, _In_ USHORT Previous, _In_ USHORT Change)
static VOID NTAPI	PortReportChange (_In_ HubPort *Port, _In_ PortEvent Result, _In_ USHORT Status, _In_ USHORT Previous, _In_ USHORT Change)

Variables
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	PortControlComplete
static const PortChangeOrder	PortChanges []

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file portxfer.cpp.

PORT_OVER_CURRENT_LIMIT

#define PORT_OVER_CURRENT_LIMIT   5

Definition at line 14 of file portxfer.cpp.

PORT_OVER_CURRENT_WINDOW

#define PORT_OVER_CURRENT_WINDOW   (3LL * 1000 * 1000 * 10)

Definition at line 15 of file portxfer.cpp.

Function Documentation

PortCacheSetFeature()

static VOID NTAPI PortCacheSetFeature ( _In_ HubPort *  Port )

static

Definition at line 52 of file portxfer.cpp.

{
    const UCHAR* Setup = Port->m_Control.Urb.SetupPacket;
    USHORT Feature = Setup[2] | (Setup[3] << 8);
    USHORT LinkState = Setup[5];
    USHORT* Current = &Port->m_Current.StatusChange.PortStatus.AsUshort16;
 
    if (Feature == PORT_F_SUSPEND)
    {
        Port->m_PreviousStatus |= PS_SUSPENDED;
        *Current |= PS_SUSPENDED;
    }
    else if (Feature == PORT_F_LINK_STATE && (LinkState == LINK_U3 || LinkState == LINK_SS_DISABLED))
    {
        Port->m_PreviousStatus = (Port->m_PreviousStatus & ~PS_LINK_MASK) | (LinkState << PS_LINK_SHIFT);
        *Current = (*Current & ~PS_LINK_MASK) | (LinkState << PS_LINK_SHIFT);
    }
}

Referenced by PortControlComplete().

PortControlComplete()

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

static

Definition at line 75 of file portxfer.cpp.

{
    HubPort* Port = (HubPort*)Context;
    NTSTATUS Status = Params->IoStatus.Status;
    UCHAR RequestCode = Port->m_Control.Urb.SetupPacket[1];
 
    UNREFERENCED_PARAMETER(Request);
    UNREFERENCED_PARAMETER(Target);
 
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Hub %p port %u control request 0x%x failed 0x%lx, URB status 0x%lx\n",
                Port->m_Hub, Port->Number(), RequestCode, Status, Port->m_Control.Urb.Hdr.Status);
        Port->m_Hub->m_FailureMessageId = HUB_MSG_CONTROL_TRANSFER_FAILED;
    }
    else if (RequestCode == HUB_REQUEST_GET_STATUS)
    {
        DPRINT("Hub %p port %u status 0x%x change 0x%x\n",
               Port->m_Hub, Port->Number(),
               Port->m_Current.StatusChange.PortStatus.AsUshort16, Port->m_Current.StatusChange.PortChange.AsUshort16);
        PortTrackPendingOperation(Port, Port->m_Control.Urb.Hdr.Status);
    }
    else if (RequestCode == HUB_REQUEST_SET_FEATURE)
    {
        PortCacheSetFeature(Port);
    }
 
    Port->m_Control.Reuse();
    Port->Post(NT_SUCCESS(Status) ? PortEvent::TransferDone : PortEvent::TransferFailed);
}

PortDropInitialConnectReference()

static VOID NTAPI PortDropInitialConnectReference ( _In_ HubPort *  Port )

static

Definition at line 337 of file portxfer.cpp.

{
    if (!Port->m_InitialConnectPowerReference)
        return;
 
    WdfDeviceResumeIdle(Port->m_Hub->m_Device);
    Port->m_InitialConnectPowerReference = FALSE;
}

Referenced by PortMachine::NextChange().

PortIndex()

static USHORT NTAPI PortIndex ( _In_ HubPort *  Port, _In_ UCHAR  High  )

static

Definition at line 144 of file portxfer.cpp.

{
    return (USHORT)((Port->Number() & 0xFF) | (High << 8));
}

Referenced by PortMachine::SendLinkDisable(), PortMachine::SendLinkRxDetect(), PortMachine::SendRemoteWake(), PortMachine::SendResume(), PortMachine::SendSuspend(), PortMachine::SendU1Timeout(), PortMachine::SendU2Timeout(), SvwSataParseResources(), and Via6421ParseResources().

PortNextChange20()

static PortEvent NTAPI PortNextChange20 ( _In_ HubPort *  Port, _In_ USHORT  Status, _In_ USHORT  Previous, _In_ USHORT  Change  )

static

Definition at line 351 of file portxfer.cpp.

{
    BOOLEAN Usable = (Status & PS_ENABLED) && !(Status & PS_SUSPENDED);
 
    if (Status & PS_OVER_CURRENT)
    {
        Port->m_ConnectionStatus = DeviceCausedOvercurrent;
        return PortEvent::ChangeOverCurrent;
    }
 
    if (Change & PC_OVER_CURRENT)
    {
        if (Previous & PS_OVER_CURRENT)
            return PortEvent::ChangeError;
 
        Port->m_ConnectionStatus = DeviceCausedOvercurrent;
        return PortEvent::ChangeOverCurrent;
    }
 
    if (!(Status & PS_POWER_20))
        return PortEvent::ChangeError;
 
    if ((Change & PC_CONNECT) || ((Status ^ Previous) & PS_CONNECTED))
        return PortEvent::ChangeConnect;
 
    if ((Status & PS_RESET) || !(Status & PS_CONNECTED))
        return PortEvent::ChangeError;
 
    if (Change & PC_RESET)
        return Usable ? PortEvent::ChangeResetDone : PortEvent::ChangeError;
 
    if (Change & PC_SUSPEND)
        return Usable ? PortEvent::ChangeResumed : PortEvent::ChangeError;
 
    return PortEvent::ChangeError;
}

Referenced by PortMachine::NextChange().

PortNextChange30()

static PortEvent NTAPI PortNextChange30 ( _In_ HubPort *  Port, _In_ USHORT  Status, _In_ USHORT  Previous, _In_ USHORT  Change  )

static

Definition at line 395 of file portxfer.cpp.

{
    HubFdo* Hub = Port->m_Hub;
    USHORT Link = HubLinkState(Status);
    USHORT PreviousLink = HubLinkState(Previous);
    BOOLEAN Connected = (Status & PS_CONNECTED) != 0;
    BOOLEAN ConnectChanged = (Change & PC_CONNECT) || ((Status ^ Previous) & PS_CONNECTED);
 
    if (Status & PS_OVER_CURRENT)
    {
        Port->m_ConnectionStatus = DeviceCausedOvercurrent;
        return PortEvent::ChangeOverCurrent;
    }
 
    if (Change & PC_OVER_CURRENT)
    {
        if (Previous & PS_OVER_CURRENT)
            return PortEvent::ChangeNone;
 
        Port->m_ConnectionStatus = DeviceCausedOvercurrent;
        return PortEvent::ChangeOverCurrent;
    }
 
    if (!(Status & PS_POWER_30))
        return PortEvent::ChangeNeedsHubReset;
 
    /* Caught in the middle of a reset */
    if (Status & PS_RESET)
    {
        if ((Status & PS_ENABLED) && !Hub->HasFlag(HubFlag::DiscardEnableDuringReset))
            return PortEvent::ChangeNeedsHubReset;
        if (Connected)
            return PortEvent::ChangeResetBusy;
        return ConnectChanged ? PortEvent::ChangeConnect : PortEvent::ChangeNone;
    }
 
    /* A disconnect can pass through Rx.Detect, or park in Polling on re-driver systems */
    if (!Connected && (Previous & PS_POWER_30))
    {
        if (Link == LINK_RX_DETECT && PreviousLink != LINK_RX_DETECT)
            return PortEvent::ChangeConnect;
        if (Link == LINK_POLLING && PreviousLink != LINK_POLLING)
            return PortEvent::ChangeConnect;
    }
 
    if (Link == LINK_LOOPBACK)
        return PortEvent::ChangeNeedsHubReset;
 
    if (Link == LINK_SS_DISABLED && PreviousLink != LINK_SS_DISABLED)
        return PortEvent::ChangeNeedsHubReset;
 
    if (Link == LINK_COMPLIANCE)
        return PortEvent::ChangeLinkError;
 
    /* The same SS.Inactive error is reported once until a reset */
    if (Link == LINK_SS_INACTIVE)
    {
        if (Change & PC_CONFIG_ERROR)
            return PortEvent::ChangeConnect;
        if (Port->m_LastChange == PortEvent::ChangeLinkError)
        {
            DPRINT1("Hub %p port %u still in SS.Inactive, already reported\n", Hub, Port->Number());
            return PortEvent::ChangeNone;
        }
        if ((Status & PS_ENABLED) && !Hub->HasFlag(HubFlag::IgnoreEnabledInSsInactive))
            return PortEvent::ChangeNeedsHubReset;
        return PortEvent::ChangeLinkError;
    }
 
    if (ConnectChanged)
        return PortEvent::ChangeConnect;
 
    if (!Connected)
    {
        if (Status & PS_ENABLED)
            return PortEvent::ChangeNeedsHubReset;
        if (Link <= LINK_U3)
            return Hub->HasFlag(HubFlag::ToleratesU0WhileDetached) ? PortEvent::ChangeNone : PortEvent::ChangeNeedsHubReset;
        return PortEvent::ChangeNone;
    }
 
    if (Link == LINK_RX_DETECT)
        return PortEvent::ChangeLinkError;
 
    if (!(Status & PS_ENABLED))
        return PortEvent::ChangeNeedsHubReset;
 
    if (Link > LINK_U3 && Link != LINK_RECOVERY)
        return PortEvent::ChangeNeedsHubReset;
 
    if (Change & PC_RESET)
        return (Link == LINK_U3) ? PortEvent::ChangeNeedsHubReset : PortEvent::ChangeResetDone;
 
    if (PreviousLink == LINK_U3 && Link != LINK_U3)
        return PortEvent::ChangeResumed;
 
    return PortEvent::ChangeNone;
}

Referenced by PortMachine::NextChange().

PortReportChange()

static VOID NTAPI PortReportChange ( _In_ HubPort *  Port, _In_ PortEvent  Result, _In_ USHORT  Status, _In_ USHORT  Previous, _In_ USHORT  Change  )

static

Definition at line 502 of file portxfer.cpp.

{
    const char* What;
 
    switch (Result)
    {
        case PortEvent::ChangeOverCurrent:
            What = "over current";
            break;
 
        case PortEvent::ChangeError:
            /* An empty 2.0 port with no change also answers ChangeError */
            if (!(Status & PS_CONNECTED) && Change == 0)
            {
                DPRINT("Hub %p port %u empty, no change\n", Port->m_Hub, Port->Number());
                return;
            }
 
            What = "invalid status";
            break;
 
        case PortEvent::ChangeNeedsHubReset:
            What = "invalid status, hub reset";
            break;
 
        case PortEvent::ChangeLinkError:
            What = "link error, port reset";
            break;
 
        case PortEvent::ChangeConnect:
            if (Status & PS_CONNECTED)
            {
                DPRINT("Hub %p port %u connect change\n", Port->m_Hub, Port->Number());
                return;
            }
 
            What = "disconnect";
            break;
 
        default:
            return;
    }
 
    DPRINT1("Hub %p port %u %s: status 0x%x previous 0x%x change 0x%x\n",
            Port->m_Hub, Port->Number(), What, Status, Previous, Change);
}

Referenced by PortMachine::LostChange(), and PortMachine::NextChange().

PortSendControl()

static VOID NTAPI PortSendControl ( _In_ HubPort *  Port, _In_ UCHAR  RequestType, _In_ UCHAR  Request, _In_ USHORT  Value, _In_ USHORT  Index, _In_reads_bytes_opt_(Length) PVOID  Buffer, _In_ USHORT  Length  )

static

Definition at line 113 of file portxfer.cpp.

{
    HubFdo* Hub = Port->m_Hub;
    NTSTATUS Status;
 
    Port->m_Control.SetSetup(RequestType, Request, Value, Index, Length);
    DPRINT("Hub %p port %u request 0x%x value %u index 0x%x\n", Hub, Port->Number(), Request, Value, Index);
 
    Status = Port->m_Control.Send(Hub->m_RootHubTarget,
                                  Hub->UsbDevice(),
                                  PortControlComplete,
                                  Port,
                                  Buffer,
                                  Length,
                                  FALSE,
                                  Hub->NeedsForwardProgress());
    if (!NT_SUCCESS(Status))
        Port->Post(PortEvent::TransferFailed);
}

Referenced by PortMachine::SendAckChange(), PortMachine::SendDisable(), PortMachine::SendGetStatus(), PortMachine::SendLinkDisable(), PortMachine::SendLinkRxDetect(), PortMachine::SendPortPower(), PortMachine::SendRemoteWake(), PortMachine::SendReset(), PortMachine::SendResume(), PortMachine::SendSuspend(), PortMachine::SendU1Timeout(), PortMachine::SendU2Timeout(), and PortMachine::SendWarmReset().

PortTrackPendingOperation()

static VOID NTAPI PortTrackPendingOperation ( _In_ HubPort *  Port, _In_ USBD_STATUS  UrbStatus  )

static

Definition at line 26 of file portxfer.cpp.

{
    HubFdo* Hub = Port->m_Hub;
 
    if (UrbStatus == USBD_STATUS_PORT_OPERATION_PENDING)
    {
        if (!Port->HasFlag(PortFlag::PendingHubPowerReference) &&
            NT_SUCCESS(WdfDeviceStopIdle(Hub->m_Device, FALSE)))
        {
            DPRINT("Hub %p port %u resume pending, hub kept awake\n", Hub, Port->Number());
            Port->SetFlag(PortFlag::PendingHubPowerReference);
        }
    }
    else if (Port->HasFlag(PortFlag::PendingHubPowerReference))
    {
        WdfDeviceResumeIdle(Hub->m_Device);
        Port->ClearFlag(PortFlag::PendingHubPowerReference);
    }
}

Referenced by PortControlComplete().

Variable Documentation

PortChanges

const PortChangeOrder PortChanges[]

static

Initial value:

=
{
    { PC_CONNECT, PORT_C_CONNECTION, PC_CONNECT, PORT_C_CONNECTION },
    { PC_OVER_CURRENT, PORT_C_OVER_CURRENT, PC_OVER_CURRENT, PORT_C_OVER_CURRENT },
    { PC_RESET, PORT_C_RESET, PC_RESET, PORT_C_RESET },
    { PC_SUSPEND, PORT_C_SUSPEND, PC_LINK_STATE, PORT_C_LINK_STATE },
    { PC_ENABLE, PORT_C_ENABLE, PC_BH_RESET, PORT_C_BH_RESET },
    { 0, 0, PC_CONFIG_ERROR, PORT_C_CONFIG_ERROR }
}

Definition at line 286 of file portxfer.cpp.

Referenced by PortMachine::PendingChange().

PortControlComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE PortControlComplete

static

Definition at line 17 of file portxfer.cpp.

Referenced by PortSendControl().