HW_COMPLETE_SERVICE_IRP callback function (storport.h)

Article
02/22/2024

The HwStorCompleteServiceIrp routine is called when the virtual adapter is being removed. When this happens, the Storport virtual miniport can complete any reverse-callback IRPs received in HwStorCompleteServiceIrp.

Syntax

HW_COMPLETE_SERVICE_IRP HwCompleteServiceIrp;

void HwCompleteServiceIrp(
  PVOID DeviceExtension
)
{...}

Parameters

DeviceExtension

A pointer to the virtual miniport driver's per-adapter storage area.

Return value

None

Remarks

The name HwStorCompleteServiceIrp is placeholder text for the actual routine name. The actual prototype of this routine is defined in Storport.h as follows:

typedef
VOID
HW_COMPLETE_SERVICE_IRP (
  _In_ PVOID  DeviceExtension
  );

The port driver calls the Storport virtual miniport driver's HwStorCompleteServiceIrproutine at PASSIVE_LEVEL without holding any spin locks. The virtual miniport driver completes the IRP by calling the HwStorCompleteServiceIrp routine.

Examples

To define an HwStorCompleteServiceIrp 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 a HwStorCompleteServiceIrp callback routine that is named *&MyHwCompleteServiceIrp, use the HW_COMPLETE_SERVICE_IRP type as shown in this code example:

HW_COMPLETE_SERVICE_IRP MyHwCompleteServiceIrp;

Then, implement your callback routine as follows:

_Use_decl_annotations_
VOID
MyHwCompleteServiceIrp (
  _In_ PVOID  DeviceExtension
  );
  {
      ...
  }

The HW_COMPLETE_SERVICE_IRP function type is defined in the Storport.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 HW_COMPLETE_SERVICE_IRP function type in the header file are used. For more information about the requirements for function declarations, see Declaring Functions Using Function Role Types for Storport Drivers. For information about Use_decl_annotations, see Annotating Function Behavior.

Requirements

Requirement	Value
Target Platform	Universal
Header	storport.h (include Storport.h)

Share via