fxpowerpolicystatemachine.hpp File Reference

#include "fxpoweridlestatemachine.hpp"
#include "fxpoxinterface.hpp"

Include dependency graph for fxpowerpolicystatemachine.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
union	FxPwrPolStateInfo
struct	POWER_POLICY_EVENT_TARGET_STATE
struct	POWER_POLICY_STATE_TABLE
struct	NOT_POWER_POLICY_OWNER_STATE_TABLE
struct	PolicySettings
struct	_POX_SETTINGS
class	IdleTimeoutManagement
struct	IdlePolicySettings
struct	WakePolicySettings
struct	FxPowerPolicyOwnerSettings
union	FxPowerPolicyMachineStateHistory
struct	FxPowerPolicyMachine

Typedefs
typedef const POWER_POLICY_EVENT_TARGET_STATE *	CPPOWER_POLICY_EVENT_TARGET_STATE
typedef WDF_DEVICE_POWER_POLICY_STATE(*	PFN_POWER_POLICY_STATE_ENTRY_FUNCTION) (FxPkgPnp *This)
typedef struct POWER_POLICY_STATE_TABLE *	PPOWER_POLICY_STATE_TABLE
typedef const POWER_POLICY_STATE_TABLE *	CPPOWER_POLICY_STATE_TABLE
typedef WDF_DEVICE_POWER_POLICY_STATE(*	PFN_NOT_POWER_POLICY_OWNER_STATE_ENTRY_FUNCTION) (FxPkgPnp *This)
typedef struct NOT_POWER_POLICY_OWNER_STATE_TABLE *	PNOT_POWER_POLICY_OWNER_STATE_TABLE
typedef const NOT_POWER_POLICY_OWNER_STATE_TABLE *	CPNOT_POWER_POLICY_OWNER_STATE_TABLE
typedef struct _POX_SETTINGS	POX_SETTINGS
typedef struct _POX_SETTINGS *	PPOX_SETTINGS

Enumerations
enum	FxPowerPolicyEvent {   PwrPolInvalid = 0x00000000 , PwrPolStart = 0x00000001 , PwrPolStop = 0x00000002 , PwrPolSx = 0x00000004 ,   PwrPolS0 = 0x00000008 , PwrPolPowerDown = 0x00000010 , PwrPolPowerUp = 0x00000020 , PwrPolPowerDownIoStopped = 0x00000040 ,   PwrPolPowerUpHwStarted = 0x00000080 , PwrPolWakeArrived = 0x00000100 , PwrPolWakeSuccess = 0x00000200 , PwrPolWakeFailed = 0x00000400 ,   PwrPolIoPresent = 0x00000800 , PwrPolPowerTimeoutExpired = 0x00001000 , PwrPolS0IdlePolicyChanged = 0x00002000 , PwrPolSurpriseRemove = 0x00004000 ,   PwrPolUsbSelectiveSuspendCallback = 0x00008000 , PwrPolUsbSelectiveSuspendCompleted = 0x00010000 , PwrPolPowerDownFailed = 0x00020000 , PwrPolPowerUpFailed = 0x00040000 ,   PwrPolImplicitPowerDown = 0x00080000 , PwrPolImplicitPowerDownFailed = 0x00100000 , PwrPolPowerUpNotSeen = 0x00200000 , PwrPolDevicePowerNotRequired = 0x00400000 ,   PwrPolDevicePowerRequired = 0x00800000 , PwrPolRemove = 0x01000000 , PwrPolWakeInterruptFired = 0x02000000 , PwrPolPriorityEventsMask ,   PwrPolNotOwnerPriorityEventsMask , PowerPolSingularEventMask , PwrPolNull = 0xFFFFFFFF }
enum	FxPowerPolicyConstants { FxPowerPolicyNoTimeout = 0 , FxPowerPolicyDefaultTimeout = 5000 }
enum	CancelIrpCompletionOwnership { CancelOwnershipUnclaimed = 0 , CancelOwnershipClaimed = 1 }
enum	FxPowerPolicySxWakeSettingsFlags { FxPowerPolicySxWakeDeviceEnabledFlag = 0x1 , FxPowerPolicySxWakeChildrenArmedFlag = 0x2 }

Typedef Documentation

CPNOT_POWER_POLICY_OWNER_STATE_TABLE

typedef const NOT_POWER_POLICY_OWNER_STATE_TABLE* CPNOT_POWER_POLICY_OWNER_STATE_TABLE

Definition at line 215 of file fxpowerpolicystatemachine.hpp.

CPPOWER_POLICY_EVENT_TARGET_STATE

typedef const POWER_POLICY_EVENT_TARGET_STATE* CPPOWER_POLICY_EVENT_TARGET_STATE

Definition at line 149 of file fxpowerpolicystatemachine.hpp.

CPPOWER_POLICY_STATE_TABLE

typedef const POWER_POLICY_STATE_TABLE* CPPOWER_POLICY_STATE_TABLE

Definition at line 185 of file fxpowerpolicystatemachine.hpp.

PFN_NOT_POWER_POLICY_OWNER_STATE_ENTRY_FUNCTION

typedef WDF_DEVICE_POWER_POLICY_STATE(* PFN_NOT_POWER_POLICY_OWNER_STATE_ENTRY_FUNCTION) (FxPkgPnp *This)

Definition at line 188 of file fxpowerpolicystatemachine.hpp.

PFN_POWER_POLICY_STATE_ENTRY_FUNCTION

typedef WDF_DEVICE_POWER_POLICY_STATE(* PFN_POWER_POLICY_STATE_ENTRY_FUNCTION) (FxPkgPnp *This)

Definition at line 152 of file fxpowerpolicystatemachine.hpp.

PNOT_POWER_POLICY_OWNER_STATE_TABLE

typedef struct NOT_POWER_POLICY_OWNER_STATE_TABLE * PNOT_POWER_POLICY_OWNER_STATE_TABLE

POX_SETTINGS

typedef struct _POX_SETTINGS POX_SETTINGS

PPOWER_POLICY_STATE_TABLE

typedef struct POWER_POLICY_STATE_TABLE * PPOWER_POLICY_STATE_TABLE

PPOX_SETTINGS

typedef struct _POX_SETTINGS * PPOX_SETTINGS

Enumeration Type Documentation

CancelIrpCompletionOwnership

enum CancelIrpCompletionOwnership

Enumerator
CancelOwnershipUnclaimed
CancelOwnershipClaimed

Definition at line 256 of file fxpowerpolicystatemachine.hpp.

                                  {
    CancelOwnershipUnclaimed = 0,
    CancelOwnershipClaimed = 1,
};

FxPowerPolicyConstants

enum FxPowerPolicyConstants

Enumerator
FxPowerPolicyNoTimeout
FxPowerPolicyDefaultTimeout

Definition at line 250 of file fxpowerpolicystatemachine.hpp.

                            {
    FxPowerPolicyNoTimeout = 0,
 
    FxPowerPolicyDefaultTimeout = 5000,             // Timeout in milliseconds
};

FxPowerPolicyEvent

enum FxPowerPolicyEvent

Enumerator
PwrPolInvalid
PwrPolStart
PwrPolStop
PwrPolSx
PwrPolS0
PwrPolPowerDown
PwrPolPowerUp
PwrPolPowerDownIoStopped
PwrPolPowerUpHwStarted
PwrPolWakeArrived
PwrPolWakeSuccess
PwrPolWakeFailed
PwrPolIoPresent
PwrPolPowerTimeoutExpired
PwrPolS0IdlePolicyChanged
PwrPolSurpriseRemove
PwrPolUsbSelectiveSuspendCallback
PwrPolUsbSelectiveSuspendCompleted
PwrPolPowerDownFailed
PwrPolPowerUpFailed
PwrPolImplicitPowerDown
PwrPolImplicitPowerDownFailed
PwrPolPowerUpNotSeen
PwrPolDevicePowerNotRequired
PwrPolDevicePowerRequired
PwrPolRemove
PwrPolWakeInterruptFired
PwrPolPriorityEventsMask
PwrPolNotOwnerPriorityEventsMask
PowerPolSingularEventMask
PwrPolNull

Definition at line 16 of file fxpowerpolicystatemachine.hpp.

                        {
    PwrPolInvalid                       = 0x00000000,
    PwrPolStart                         = 0x00000001,
    PwrPolStop                          = 0x00000002,
    PwrPolSx                            = 0x00000004,
    PwrPolS0                            = 0x00000008,
    PwrPolPowerDown                     = 0x00000010,
    PwrPolPowerUp                       = 0x00000020,
    PwrPolPowerDownIoStopped            = 0x00000040,
    PwrPolPowerUpHwStarted              = 0x00000080,
    PwrPolWakeArrived                   = 0x00000100,
    PwrPolWakeSuccess                   = 0x00000200,
    PwrPolWakeFailed                    = 0x00000400,
    PwrPolIoPresent                     = 0x00000800,
    PwrPolPowerTimeoutExpired           = 0x00001000,
    PwrPolS0IdlePolicyChanged           = 0x00002000,
    PwrPolSurpriseRemove                = 0x00004000,
    PwrPolUsbSelectiveSuspendCallback   = 0x00008000,
    PwrPolUsbSelectiveSuspendCompleted  = 0x00010000,
    PwrPolPowerDownFailed               = 0x00020000,
    PwrPolPowerUpFailed                 = 0x00040000,
    PwrPolImplicitPowerDown             = 0x00080000,
    PwrPolImplicitPowerDownFailed       = 0x00100000,
    PwrPolPowerUpNotSeen                = 0x00200000,
    PwrPolDevicePowerNotRequired        = 0x00400000,
    PwrPolDevicePowerRequired           = 0x00800000,
    PwrPolRemove                        = 0x01000000,
    PwrPolWakeInterruptFired            = 0x02000000,
 
    //
    // Not a real event, just a value that indicates all of the events which
    // goto the head of the queue and are always processed, even if the state is
    // locked.  This applies to the power policy owner state machine.
    //
    PwrPolPriorityEventsMask            = PwrPolPowerUp |
                                          PwrPolPowerDown |
                                          PwrPolPowerUpFailed |
                                          PwrPolPowerDownFailed |
                                          PwrPolPowerDownIoStopped |
                                          PwrPolPowerUpHwStarted |
                                          PwrPolImplicitPowerDown |
                                          PwrPolImplicitPowerDownFailed |
                                          PwrPolWakeArrived |
                                          PwrPolWakeSuccess |
                                          PwrPolWakeFailed |
                                          PwrPolPowerUpNotSeen |
                                          PwrPolUsbSelectiveSuspendCompleted |
                                          PwrPolWakeInterruptFired,
 
    //
    // Not a real event, just a value that indicates all of the events which
    // goto the head of the queue and are always processed, even if the state is
    // locked.  This applies to the not power policy owner state machine.
    //
    PwrPolNotOwnerPriorityEventsMask    = PwrPolPowerUp |
                                          PwrPolPowerUpFailed |
                                          PwrPolPowerDown |
                                          PwrPolPowerDownFailed,
 
    //
    // Not a real event, just a value that indicate all of the events which
    // should not be in the queue, if a similar event is already enqueued.
    //
    PowerPolSingularEventMask           = PwrPolS0IdlePolicyChanged |
    //
    // A device could have multiple wake interrupts that could each fire
    // this event.
    //
                                          PwrPolWakeInterruptFired,
 
 
    PwrPolNull                          = 0xFFFFFFFF,
};

FxPowerPolicySxWakeSettingsFlags

enum FxPowerPolicySxWakeSettingsFlags

Enumerator
FxPowerPolicySxWakeDeviceEnabledFlag
FxPowerPolicySxWakeChildrenArmedFlag

Definition at line 261 of file fxpowerpolicystatemachine.hpp.

                                      {
    FxPowerPolicySxWakeDeviceEnabledFlag = 0x1,
    FxPowerPolicySxWakeChildrenArmedFlag = 0x2,
};