MINIPORT_WDI_ADAPTER_HANG_DIAGNOSE callback function (dot11wificxintf.h)

Important

This topic is part of the WiFiCx driver model. WiFiCx is the Wi-Fi driver model released in Windows 11. We recommend that you use WiFiCx to take advantage of the latest features. The previous Wi-Fi driver model WDI is in maintenance mode and will only receive high priority fixes.

The MiniportWdiAdapterHangDiagnose handler function is used to collect hardware control register states and optionally full firmware state.

This is a WDI miniport handler inside NDIS_MINIPORT_DRIVER_WDI_CHARACTERISTICS.

Note

You must declare the function by using the MINIPORT_WDI_ADAPTER_HANG_DIAGNOSE type.

Syntax

MINIPORT_WDI_ADAPTER_HANG_DIAGNOSE MiniportWdiAdapterHangDiagnose;

NDIS_STATUS MiniportWdiAdapterHangDiagnose(
  NDIS_HANDLE MiniportDriverContext,
  eDiagnoseLevel DiagnoseLevel,
  UINT32 BufferSize,
  UINT8 *FirmwareBlob,
  UINT32 *pOutputSize
)
{...}

Parameters

MiniportDriverContext

[in] The handle to a driver-allocated context area where the driver maintains state and configuration information. The miniport driver passed this context area to the NdisMRegisterWdiMiniportDriver function.

DiagnoseLevel

[in] The diagnose level, as defined in the eDiagnoseLevel enumeration. The default level is DiagnoseLevelHardwareRegisters, 1KB maximum in the output buffer.

BufferSize

[in] The size of FirmwareBlob, in bytes.

FirmwareBlob

[out] A pointer to the buffer that will contain the hardware control registry states, and optionally full firmware state.

pOutputSize

[out] A pointer to the number of bytes written to FirmwareBlob.

Return value

The return value is ignored.

Remarks

The default diagnose level is DiagnoseLevelHardwareRegisters, with 1KB maximum in the output buffer.

Requirements

Requirement Value
Minimum supported client Windows 11
Minimum supported server Windows Server 2022
Header dot11wificxintf.h

See also

WDI hang detection and recovery

NDIS_MINIPORT_DRIVER_WDI_CHARACTERISTICS

eDiagnoseLevel

NdisMRegisterWdiMiniportDriver