EVT_WDF_DEVICE_ENABLE_WAKE_AT_BUS callback function (wdfpdo.h)

[Applies to KMDF only]

A bus driver's EvtDeviceEnableWakeAtBus event callback function performs bus-level operations that enable one of the bus's devices to trigger a wake-up signal on the bus.

Syntax

EVT_WDF_DEVICE_ENABLE_WAKE_AT_BUS EvtWdfDeviceEnableWakeAtBus;

NTSTATUS EvtWdfDeviceEnableWakeAtBus(
  [in] WDFDEVICE Device,
  [in] SYSTEM_POWER_STATE PowerState
)
{...}

Parameters

[in] Device

A handle to a framework device object.

[in] PowerState

A SYSTEM_POWER_STATE-typed enumerator that identifies the system power state that the system or device will wake from.

Return value

If the EvtDeviceEnableWakeAtBus callback function encountered no errors, it must return STATUS_SUCCESS or another status value for which NT_SUCCESS(status) equals TRUE. Otherwise it must return a status value for which NT_SUCCESS(status) equals FALSE.

If NT_SUCCESS(status) equals FALSE, the framework calls the driver's EvtDeviceDisableWakeAtBus callback function.

For more information about this callback function's return values, see Reporting Device Failures.

Remarks

To register this callback function, the bus driver must call WdfPdoInitSetEventCallbacks.

For more information about this callback function, see Supporting System Wake-Up.

Requirements

See also

WdfPdoInitSetEventCallbacks

EvtDeviceDisableWakeAtBus