EvtDeviceSelfManagedIoRestart function

[Applies to KMDF and UMDF]

A driver's EvtDeviceSelfManagedIoRestart event callback function restarts a device's self-managed I/O operations.

Syntax


EVT_WDF_DEVICE_SELF_MANAGED_IO_RESTART EvtDeviceSelfManagedIoRestart;

NTSTATUS EvtDeviceSelfManagedIoRestart(
  _In_  WDFDEVICE Device
)
{ ... }

Parameters

Device [in]: A handle to a framework device object.

Return value

If the EvtDeviceSelfManagedIoRestart 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. If NT_SUCCESS(status) equals FALSE, the framework stops the device and unloads the device's drivers.

If NT_SUCCESS(status) equals FALSE, the framework calls the driver's EvtDeviceSelfManagedIoFlush and EvtDeviceSelfManagedIoCleanup callback functions.

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

Remarks

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

If the driver has registered an EvtDeviceSelfManagedIoRestart callback function, the framework calls it each time that the device returns from a low-power state to its working (D0) state. The framework calls the EvtDeviceSelfManagedIoRestart callback function only after calling the driver's EvtDeviceSelfManagedIoSuspend callback function.

The driver's EvtDeviceSelfManagedIoRestart callback function must do whatever is needed to resume the device's self-managed I/O operations.

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

For more information about drivers that provide this callback function, see Using Self-Managed I/O.

The EvtDeviceSelfManagedIoRestart callback function is called at IRQL = PASSIVE_LEVEL. You should not make this callback function pageable.

Examples

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


EVT_WDF_DEVICE_SELF_MANAGED_IO_RESTART  MyDeviceSelfManagedIoRestart;

Then, implement your callback function as follows:


_Use_decl_annotations_
NTSTATUS
 MyDeviceSelfManagedIoRestart (
    WDFDEVICE  Device
    )
  {...}

The EVT_WDF_DEVICE_SELF_MANAGED_IO_RESTART 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_SELF_MANAGED_IO_RESTART 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)