EvtDeviceD0ExitPreInterruptsDisabled function

[Applies to KMDF and UMDF]

A driver's EvtDeviceD0ExitPreInterruptsDisabled event callback function performs device-specific operations that are required before the driver disables the device's hardware interrupts.

Syntax

C++


EVT_WDF_DEVICE_D0_EXIT_PRE_INTERRUPTS_DISABLED EvtDeviceD0ExitPreInterruptsDisabled;

NTSTATUS EvtDeviceD0ExitPreInterruptsDisabled(
  _In_  WDFDEVICE Device,
  _In_  WDF_POWER_DEVICE_STATE TargetState
)
{ ... }

Parameters

Device [in]: A handle to a framework device object.
TargetState [in]: A WDF_POWER_DEVICE_STATE-typed enumerator that identifies the device power state that the device is about to enter.

Return value

If the EvtDeviceD0ExitPreInterruptsDisabled callback function encounters 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.

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

Remarks

To register an EvtDeviceD0ExitPreInterruptsDisabled callback function, a driver must call WdfDeviceInitSetPnpPowerEventCallbacks.

The EvtDeviceD0ExitPreInterruptsDisabled callback function is called at IRQL = PASSIVE_LEVEL, before the framework calls the driver's EvtInterruptDisable callback function. A driver can provide this function if it must perform device-specific operations before disables an interrupt, if those operations should not be performed at IRQL = DIRQL in the EvtInterruptDisable callback function.

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

For more information about handling interrupts, see Handling Hardware Interrupts.

Examples

To define an EvtDeviceD0ExitPreInterruptsDisabled callback function, you must first provide a function declaration that identifies the type of callback function you’re defining. Windows provides a set of callback function types for drivers. Declaring a function using the callback function types helps Code Analysis for Drivers, Static Driver Verifier (SDV), and other verification tools find errors, and it’s a requirement for writing drivers for the Windows operating system.

For example, to define an EvtDeviceD0ExitPreInterruptsDisabled callback function that is named MyDeviceD0ExitPreInterruptsDisabled, use the EVT_WDF_DEVICE_D0_EXIT_PRE_INTERRUPTS_DISABLED type as shown in this code example:


EVT_WDF_DEVICE_D0_EXIT_PRE_INTERRUPTS_DISABLED  MyDeviceD0ExitPreInterruptsDisabled;

Then, implement your callback function as follows:


_Use_decl_annotations_
NTSTATUS
 MyDeviceD0ExitPreInterruptsDisabled (
    WDFDEVICE  Device,
    WDF_POWER_DEVICE_STATE  TargetState
    )
  {...}

The EVT_WDF_DEVICE_D0_EXIT_PRE_INTERRUPTS_DISABLED function type is defined in the Wdfdevice.h header file. To more accurately identify errors when you run the code analysis tools, be sure to add the _Use_decl_annotations_ annotation to your function definition. The _Use_decl_annotations_ annotation ensures that the annotations that are applied to the EVT_WDF_DEVICE_D0_EXIT_PRE_INTERRUPTS_DISABLED function type in the header file are used. For more information about the requirements for function declarations, see Declaring Functions by Using Function Role Types for KMDF Drivers. For information about _Use_decl_annotations_, see Annotating Function Behavior.

Requirements

Minimum KMDF version	1.0
Minimum UMDF version	2.0
Header	Wdfdevice.h (include Wdf.h)
IRQL	PASSIVE_LEVEL (see Remarks section)