HW_PROCESS_SERVICE_REQUEST callback function (storport.h)

Article
07/29/2021

The HwStorProcessServiceRequest callback routine receives the device control IRP that contains the IOCTL_MINIPORT_PROCESS_SERVICE_IRP request when a caller, such as a user-mode application or kernel-mode driver, requires a "reverse callback" operation. The I/O is completed by the miniport driver when it needs to tell the caller of something or needs the caller to do something.

Syntax

HW_PROCESS_SERVICE_REQUEST HwProcessServiceRequest;

void HwProcessServiceRequest(
  PVOID DeviceExtension,
  PVOID Irp
)
{...}

Parameters

DeviceExtension

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

Irp

A pointer to the I/O request.

Return value

None

Remarks

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

typedef
VOID
HW_PROCESS_SERVICE_REQUEST (
  _In_ PVOID  DeviceExtension,
  _In_ PVOID  Irp
  );

The port driver calls the Storport virtual miniport driver's HwStorProcessServiceRequest routine at PASSIVE_LEVEL. The virtual miniport driver completes the IRP by calling the StorPortCompleteServiceIrp routine.

Examples

To define an HwStorProcessServiceRequest 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 HwStorProcessServiceRequest callback routine that is named MyHwProcessServiceRequest, use the HW_PROCESS_SERVICE_REQUEST type as shown in this code example:

HW_PROCESS_SERVICE_REQUEST MyHwProcessServiceRequest;

Then, implement your callback routine as follows:

_Use_decl_annotations_
VOID
MyHwProcessServiceRequest (
  _In_ PVOID  DeviceExtension,
  _In_ PVOID  Irp
  );
  {
      ...
  }

The HW_PROCESS_SERVICE_REQUEST 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_PROCESS_SERVICE_REQUEST 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