Edit

Share via

UfxDeviceNotifyHardwareFailure function (ufxclient.h)

  • Article

Notifies UFX about a non-recoverable hardware failure in the controller.

Syntax

void UfxDeviceNotifyHardwareFailure(
  [in]           UFXDEVICE                     UfxDevice,
  [in, optional] PUFX_HARDWARE_FAILURE_CONTEXT HardwareFailureContext
);

Parameters

[in] UfxDevice

A handle to a UFX device object that the driver created by calling UfxDeviceCreate.

[in, optional] HardwareFailureContext

Optional pointer to a client driver-defined UFX_HARDWARE_FAILURE_CONTEXT structure containing controller-specific information about the hardware failure.

Return value

None

Remarks

The client driver calls UfxDeviceNotifyHardwareFailure when the controller has entered a non-recoverable hardware failure (such as PHY lockup). UFX can try resetting the controller to see if the controller can be recovered. The following example shows the syntax for the call:

    UfxDeviceNotifyHardwareFailure(
        ControllerContext->UfxDevice,
        (PUFX_HARDWARE_FAILURE_CONTEXT) HardwareFailureContext);

Requirements

Requirement Value
Minimum supported client Windows 10
Target Platform Windows
Header ufxclient.h
Library ufxstub.lib
IRQL DISPATCH_LEVEL