DEVICE_RESET_HANDLER callback function (wdm.h)

Article
02/22/2024

The DeviceReset routine is used to reset and recover a malfunctioning device.

Syntax

DEVICE_RESET_HANDLER DeviceResetHandler;

NTSTATUS DeviceResetHandler(
  [in]           PVOID InterfaceContext,
  [in]           DEVICE_RESET_TYPE ResetType,
  [in]           ULONG Flags,
  [in, optional] PVOID ResetParameters
)
{...}

Parameters

[in] InterfaceContext

A pointer to interface-specific context information. The caller passes the value that is passed as the Context member of the DEVICE_RESET_INTERFACE_STANDARD structure for the interface.

[in] ResetType

The type of reset being requested. Set this parameter to one of the following DEVICE_RESET_TYPE enumeration values.

FunctionLevelDeviceReset. Specify this value to request a function-level reset, which is restricted to a specific device.
PlatformLevelDeviceReset. Specify this value to request a platform-level reset, which affects a specific device and all other devices that are connected to it via the same power rail or reset line.

For more information about how function-level and platform-level resets are implemented in the device stack, see Working with the GUID_DEVICE_RESET_INTERFACE_STANDARD.

[in] Flags

Set to 0. Currently, no flags are defined for this routine.

[in, optional] ResetParameters

If the caller is requesting a function-level device reset, this optional parameter can point to a FUNCTION_LEVEL_DEVICE_RESET_PARAMETERS structure that specifies a callback routine that is called when the reset is completed.

Return value

This routine returns STATUS_SUCCESS if the requested operation succeeds. Otherwise, it returns an appropriate an NTSTATUS error code.

Remarks

If a function driver detects that the device is not functioning correctly, it should first attempt a function-level reset. If a function-level reset does not fix the issue, then the driver can attempt a more invasive platform-level reset, but a platform-level reset should only be used as the final option.

A function-level reset or platform-level reset must be performed at PASSIVE_LEVEL.

For more information about function-level and platform-level resets, see Working with the GUID_DEVICE_RESET_INTERFACE_STANDARD.

Requirements

Requirement	Value
Minimum supported client	Windows 10
Target Platform	Desktop
Header	wdm.h (include Wdm.h)