EvtInterruptSynchronize function

[Applies to KMDF and UMDF]

A driver's EvtInterruptSynchronize event callback function performs operations that must be synchronized with an EvtInterruptIsr callback function.

Syntax


EVT_WDF_INTERRUPT_SYNCHRONIZE EvtInterruptSynchronize;

BOOLEAN EvtInterruptSynchronize(
  _In_  WDFINTERRUPT Interrupt,
  _In_  WDFCONTEXT Context
)
{ ... }

Parameters

Interrupt [in]

A handle to a framework interrupt object.

Context [in]

Driver-supplied information that the driver specifies when it calls WdfInterruptSynchronize.

Return value

The EvtInterruptSynchronize callback function must return TRUE if the operation succeeds. Otherwise, this function must return FALSE.

Remarks

To execute an EvtInterruptSynchronize callback function, the driver must call WdfInterruptSynchronize.

If the driver has configured the interrupt object for handling at the device's IRQL (DIRQL), then before calling the EvtInterruptSynchronize callback function, the framework raises the processor's interrupt request level to DIRQL and acquires the spin lock that the driver specified in the interrupt object's WDF_INTERRUPT_CONFIG structure.

As a result, while an EvtInterruptSynchronize callback function is executing, the interrupt object's EvtInterruptIsr callback function (and any other code that executes at DIRQL while holding the spin lock) cannot execute.

EvtInterruptSynchronize callback functions must be designed so that they execute for only a short period of time. They are typically used to access interrupt data that is also accessed by an interrupt object's other EvtInterruptSynchronize or EvtInterruptIsr callback functions.

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 EvtInterruptSynchronize 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.

For more information about the EvtInterruptSynchronize callback function, see Synchronizing Interrupt Code.

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

Examples

To define an EvtInterruptSynchronize 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 EvtInterruptSynchronize callback function that is named MyInterruptSynchronize, use the EVT_WDF_INTERRUPT_SYNCHRONIZE type as shown in this code example:


EVT_WDF_INTERRUPT_SYNCHRONIZE  MyInterruptSynchronize;

Then, implement your callback function as follows.


_Use_decl_annotations_
BOOLEAN
 MyInterruptSynchronize (
    WDFINTERRUPT  Interrupt,
    WDFCONTEXT  Context
    )
  {...}

The EVT_WDF_INTERRUPT_SYNCHRONIZE function type is defined in the Wdfinterrupt.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_INTERRUPT_SYNCHRONIZE 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

Wdfinterrupt.h (include Wdf.h)

IRQL

(See Remarks section.)

See also

WdfInterruptSynchronize
WDF_INTERRUPT_CONFIG
EvtInterruptIsr

 

 

Send comments about this topic to Microsoft

Показ:
© 2014 Microsoft