MINIPORT_WDI_ADAPTER_HANG_DIAGNOSE callback function (dot11wdi.h)

Article
02/22/2024

Important

This topic is part of the WDI driver model released in Windows 10. The WDI driver model is in maintenance mode and will only receive high priority fixes. 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 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. For more information, see the following Examples section.

Syntax

MINIPORT_WDI_ADAPTER_HANG_DIAGNOSE MiniportWdiAdapterHangDiagnose;

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

Parameters

[in] MiniportDriverContext

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.

[in] DiagnoseLevel

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

[in] BufferSize

The size of FirmwareBlob, in bytes.

[out] FirmwareBlob

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

[out] pOutputSize

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 10
Minimum supported server	Windows Server 2016
Target Platform	Windows
Header	dot11wdi.h