EVT_WDF_INTERRUPT_ENABLE callback function (wdfinterrupt.h)

[Applies to KMDF and UMDF]

A driver's EvtInterruptEnable event callback function enables a specified hardware interrupt.

Syntax

EVT_WDF_INTERRUPT_ENABLE EvtWdfInterruptEnable;

NTSTATUS EvtWdfInterruptEnable(
  [in] WDFINTERRUPT Interrupt,
  [in] WDFDEVICE AssociatedDevice
)
{...}

Parameters

[in] Interrupt

A handle to a framework interrupt object.

[in] AssociatedDevice

A handle to the framework device object that the driver passed to WdfInterruptCreate.

Return value

The EvtInterruptEnable callback function must return STATUS_SUCCESS or another status value for which NT_SUCCESS(status) equals TRUE if the function encounters no errors. Otherwise, this function must return a status value for which NT_SUCCESS(status) equals FALSE.

Remarks

To register an EvtInterruptEnable callback function, your driver must place the callback function's address in a WDF_INTERRUPT_CONFIG structure before calling WdfInterruptCreate.

The framework calls the driver's EvtInterruptEnable callback function each time the device enters its working (D0) state. Additionally, a driver can cause the framework to call the EvtInterruptEnable callback function by calling WdfInterruptEnable. Note that most framework-based drivers should not call WdfInterruptEnable, because the framework calls the driver's EvtInterruptEnable callback function each time the device enters its working (D0) state.

Before calling the EvtInterruptEnable callback function, the framework raises the processor's IRQL to the device's DIRQL and acquires the spin lock that the driver specified in the interrupt object's WDF_INTERRUPT_CONFIG structure.

Beginning with version 1.11 of KMDF, your driver can provide passive-level interrupt handling. If the driver has requested passive-level interrupt handling, then before calling the EvtInterruptEnable function at IRQL = PASSIVE_LEVEL, the framework acquires the passive-level interrupt lock that the driver configured in the interrupt object's WDF_INTERRUPT_CONFIG structure.

After the EvtInterruptEnable callback function returns, the framework calls the driver's EvtDeviceD0EntryPostInterruptsEnabled event callback function at IRQL = PASSIVE_LEVEL.

You must not assume that a device will use the same interrupt resources each time the framework calls your driver's EvtInterruptEnable callback function. Sometimes the PnP manager redistributes system resources, and it might assign new interrupt resources to your device. The driver can call WdfInterruptGetInfo to determine a device's interrupt resources.

For more information about handling interrupts in framework-based drivers, see Handling Hardware Interrupts.

Requirements

See also

EvtDeviceD0EntryPostInterruptsEnabled

EvtInterruptDisable

WDF_INTERRUPT_CONFIG

WdfInterruptCreate

WdfInterruptEnable

WdfInterruptGetInfo