EVT_WDF_DEVICE_DISARM_WAKE_FROM_S0 callback function (wdfdevice.h)

[Applies to KMDF and UMDF]

A driver's EvtDeviceDisarmWakeFromS0 event callback function disarms (that is, disables) a device's ability to trigger a wake signal while in a low-power device state, if the system remains in the system working state (S0).

Syntax

EVT_WDF_DEVICE_DISARM_WAKE_FROM_S0 EvtWdfDeviceDisarmWakeFromS0;

void EvtWdfDeviceDisarmWakeFromS0(
  WDFDEVICE Device
)
{...}

Parameters

Device

[in] A handle to a framework device object.

Return value

None

Remarks

To register an EvtDeviceDisarmWakeFromS0 callback function, a driver must call WdfDeviceInitSetPowerPolicyEventCallbacks. The driver must also set IdleCanWakeFromS0 in the IdleCaps member of its WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS structure.

If the driver has registered an EvtDeviceDisarmWakeFromS0 callback function, the framework calls it after the bus driver determines that an event has awakened the device, and after the bus driver subsequently completes the wait/wake IRP. Before calling the driver's EvtDeviceDisarmWakeFromS0EvtDeviceDisarmWakeFromS0 callback function, the framework calls the driver's EvtDeviceD0Entry, EvtInterruptEnable, and EvtDeviceWakeFromS0Triggered callback functions.

The EvtDeviceDisarmWakeFromS0 callback function must perform any hardware operations that are needed to disable the device's ability to trigger a wake signal after the power has been lowered.

For more information about when the framework calls this callback function, see PnP and Power Management Scenarios.

For more information about this callback function, see Supporting Idle Power-Down.

The EvtDeviceDisarmWakeFromS0 callback function is called at IRQL = PASSIVE_LEVEL. You should not make this callback function pageable.

Requirements

   
Target Platform Universal
Minimum KMDF version 1.0
Minimum UMDF version 2.0
Header wdfdevice.h (include Wdf.h)
IRQL PASSIVE_LEVEL (see Remarks section)

See also

EvtDeviceArmWakeFromS0

EvtDeviceDisarmWakeFromSx