HubTimer Class Reference

#include <hubutil.h>

Collaboration diagram for HubTimer:

Public Types
typedef VOID(NTAPI *	PFN_HUB_TIMER_FIRED) (_In_ PVOID Context)

Public Member Functions
VOID	Initialize (_In_ PFN_HUB_TIMER_FIRED Fired, _In_ PVOID Context)
VOID	Start (_In_ ULONG Milliseconds)
BOOLEAN	Cancel ()

Static Private Member Functions
static VOID NTAPI	DpcRoutine (_In_ PKDPC Dpc, _In_opt_ PVOID Context, _In_opt_ PVOID Argument1, _In_opt_ PVOID Argument2)

Private Attributes
KTIMER	m_Timer
KDPC	m_Dpc
PFN_HUB_TIMER_FIRED	m_Fired
PVOID	m_Context

Detailed Description

Definition at line 87 of file hubutil.h.

Member Typedef Documentation

PFN_HUB_TIMER_FIRED

typedef VOID(NTAPI * HubTimer::PFN_HUB_TIMER_FIRED) (_In_ PVOID Context)

Definition at line 90 of file hubutil.h.

Member Function Documentation

Cancel()

BOOLEAN HubTimer::Cancel ( )

inline

FALSE when the timer already fired and its callback is coming.

Definition at line 115 of file hubutil.h.

    {
        return KeCancelTimer(&m_Timer);
    }

Referenced by DeviceMachine::CancelStateTimer(), DeviceMachine::StopTimer(), and PortMachine::StopTimer().

DpcRoutine()

static VOID NTAPI HubTimer::DpcRoutine ( _In_ PKDPC  Dpc, _In_opt_ PVOID  Context, _In_opt_ PVOID  Argument1, _In_opt_ PVOID  Argument2  )

inlinestaticprivate

Definition at line 124 of file hubutil.h.

    {
        HubTimer* Self = (HubTimer*)Context;
 
        UNREFERENCED_PARAMETER(Dpc);
        UNREFERENCED_PARAMETER(Argument1);
        UNREFERENCED_PARAMETER(Argument2);
 
        Self->m_Fired(Self->m_Context);
    }

Referenced by Initialize().

Initialize()

VOID HubTimer::Initialize ( _In_ PFN_HUB_TIMER_FIRED  Fired, _In_ PVOID  Context  )

inline

Definition at line 93 of file hubutil.h.

    {
        m_Fired = Fired;
        m_Context = Context;
        KeInitializeTimer(&m_Timer);
        KeInitializeDpc(&m_Dpc, DpcRoutine, this);
    }

Start()

VOID HubTimer::Start ( _In_ ULONG  Milliseconds )

inline

Definition at line 104 of file hubutil.h.

    {
        LARGE_INTEGER DueTime;
 
        DueTime.QuadPart = -10000LL * Milliseconds;
        KeSetTimer(&m_Timer, DueTime, &m_Dpc);
    }

Referenced by DeviceMachine::ArmDuplicateDeviceTimer(), HubMachine::ArmOverCurrentTimer(), DeviceMachine::ArmPostAddressTimer(), HubMachine::ArmResetRetryTimer(), HubMachine::StartDescriptorRetryTimer(), DeviceMachine::StartDriverWaitTimer(), DeviceMachine::StartLongPostResetTimer(), DeviceMachine::StartPostResetTimer(), DeviceMachine::StartRetryTimer(), DeviceMachine::StartSuperSpeedPostResetTimer(), and PortMachine::StartTimer().

Member Data Documentation

m_Context

PVOID HubTimer::m_Context

private

Definition at line 142 of file hubutil.h.

Referenced by DpcRoutine(), and Initialize().

m_Dpc

KDPC HubTimer::m_Dpc

private

Definition at line 140 of file hubutil.h.

Referenced by Initialize(), and Start().

m_Fired

PFN_HUB_TIMER_FIRED HubTimer::m_Fired

private

Definition at line 141 of file hubutil.h.

Referenced by DpcRoutine(), and Initialize().

m_Timer

KTIMER HubTimer::m_Timer

private

Definition at line 139 of file hubutil.h.

Referenced by Cancel(), Initialize(), and Start().

---

The documentation for this class was generated from the following file:

• drivers/usb/usbhub3/hubutil.h