IRP_MN_WAIT_WAKE

This IRP enables a driver to awaken a sleeping system or to awaken a sleeping device.

Major Code

IRP_MJ_POWER

When Sent

A driver that owns power policy targets this IRP to its PDO to enable its device to awaken in response to an external event, such as an incoming phone call. A driver must call PoRequestPowerIrp to send this IRP.

As a general rule, a driver should send this IRP as soon as it determines that its device should be enabled for wake-up. Consequently, drivers for most such devices send this IRP after powering on their devices and before completing the IRP_MN_START_DEVICE request.

However, a driver can send the IRP any time the device is in the working state (PowerDeviceD0). The device stack must not be in transition; that is, a driver should not send an IRP_MN_WAIT_WAKE while any other power IRP is active in its device stack.

A wait/wake IRP does not change the power state of the device or of the system. It simply enables a wake-up signal from the device. When the wake-up signal arrives, the policy owner must call PoRequestPowerIrp to send a set-power IRP to return its device to D0.

The driver must be running at IRQL = PASSIVE_LEVEL to send this IRP. However, the IRP can be completed at IRQL = DISPATCH_LEVEL.

Input Parameters

Parameters.WaitWake.PowerState contains the lowest (least-powered) system power state from which the device should be allowed to awaken the system.

Output Parameters

None.

I/O Status Block

A driver sets Irp->IoStatus.Status to one of the following:

STATUS_PENDING
The driver received the IRP and is waiting for the device to signal wake-up.

STATUS_INVALID_DEVICE_STATE
The device is in a less-powered state than the DeviceWake state specified in the DEVICE_CAPABILITIES structure for the device, or the device cannot awaken the system from the SystemWake state passed in the IRP.

STATUS_NOT_SUPPORTED
The device does not support wake-up.

STATUS_DEVICE_BUSY
An IRP_MN_WAIT_WAKE request is already pending and must be completed or canceled before another IRP_MN_WAIT_WAKE request can be issued.

STATUS_SUCCESS
The device has signaled a wake event.

STATUS_CANCELLED
The IRP has been canceled.

If a driver must fail this IRP, it completes the IRP immediately and does not pass the IRP to the next-lower driver.

Operation

A driver sends IRP_MN_WAIT_WAKE for either of two reasons:

1. To enable its device to awaken a sleeping system in response to an external wake-up signal.

2. To enable its device to awaken from a device sleep state in response to an external wake-up signal.

The IRP must be passed down the device stack to the bus driver for the device, which calls IoMarkIrpPending and returns STATUS_PENDING from its DispatchPower routine. The IRP remains pending until a wake-up signal occurs or until the driver that sent the IRP cancels it.

Only one wait/wake IRP can be held pending for a PDO at any given time. If a driver already holds a wait/wake IRP for a PDO, it must fail any additional such IRPs with STATUS_DEVICE_BUSY. A driver that enumerates more than one child PDO can have a wait/wake IRP pending for each such PDO.

Each driver sets an IoCompletion routine as the IRP travels down the device stack. When the device signals a wake-up event, the bus driver services the wake-up signal and completes the IRP, returning STATUS_SUCCESS. The I/O manager then calls the IoCompletion routine of the next higher driver, and so on up the device stack.

When a driver sends a wait/wake IRP, it should specify a callback routine in the PoRequestPowerIrp call. In the callback routine, the driver typically services the device. For example, the power policy owner for the device must call PoRequestPowerIrp to send an IRP_MN_SET_POWER for device state D0.

A driver that acts as the bus driver for one device and the policy owner for a parent device requests an IRP_MN_WAIT_WAKE IRP for the parent's device stack when it receives a IRP_MN_WAIT_WAKE request from a child PDO. If the driver enumerates more than one child PDO, it should request only one wait/wake IRP for the parent's device stack no matter how many child PDOs send wait/wake requests. Instead, such a driver should keep an internal count of wait/wake IRPs, incrementing the count each time it receives a request and decrementing the count each time it completes a request. If the count is nonzero after it has completed a wait/wake IRP, the driver should send another wait/wake IRP to its device stack to "rearm" itself for wake-up. For more information, see Understanding the Path of Wait/Wake IRPs through a Device Tree.

To cancel an IRP_MN_WAIT_WAKE, a driver calls IoCancelIrp. Only the driver that originated the IRP can cancel it. A driver cancels a pending IRP_MN_WAIT_WAKE when any of the following occurs:

• The driver receives a PnP IRP that stops or removes the device.

• The system is going to sleep and the device wake signal must not awaken it.

Requirements

See also

PoRequestPowerIrp