NDIS_WDI_TX_SEND_PAUSE_IND callback function (dot11wdi.h)

Article
10/22/2021

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 NdisWdiTxSendPauseIndication callback function pauses transmissions on a given port to a given peer or peer-TID combination.

This is a callback inside NDIS_WDI_DATA_API.

Syntax

NDIS_WDI_TX_SEND_PAUSE_IND NdisWdiTxSendPauseInd;

void NdisWdiTxSendPauseInd(
  [in] NDIS_HANDLE NdisMiniportDataPathHandle,
  [in] WDI_PORT_ID PortId,
  [in] WDI_PEER_ID PeerId,
  [in] UINT32 ExTidBitmask,
  [in] WDI_TX_PAUSE_REASON TxPauseReason
)
{...}

Parameters

[in] NdisMiniportDataPathHandle

The NdisMiniportDataPathHandle passed to the IHV miniport in MiniportWdiTalTxRxInitialize.

[in] PortId

The port ID. Wildcards are accepted.

[in] PeerId

The peer ID. Wildcards are accepted.

[in] ExTidBitmask

The Extended TID bitmask. See Remarks section for more information.

[in] TxPauseReason

TX pause reason bitmask, specified as WDI_TX_PAUSE_REASON value(s). See Remarks section for more information.

Return value

None

Remarks

In the ExTidBitmask parameter, the i^th bit represents extended TID i (the least significant bit is bit 0) .

The WDI_TX_PAUSE_REASON bitmask may contain a set of pause reasons. The pauses reasons are cumulative, so an NdisWdiTxSendPauseIndication with a pause reason of WDI_TX_PAUSE_REASON_CREDIT followed by an NdisWdiTxSendPauseIndication with a pause reason of WDI_TX_PAUSE_REASON_IHV1 requires an NdisWdiTxSendRestartIndication with a pause reason of (WDI_TX_PAUSE_REASON_CREDIT | WDI_TX_PAUSE_REASON_IHV1) for the set of queues to be unpaused.

If the pause reason is WDI_TX_PAUSE_REASON_PS, the TAL/target does not issue an NdisWdiTxSendRestartIndication to any of the affected queues until it has received an MiniportWdiTxTalQueueInOrder notification for that queue

If TargetPriorityQueueing is true, WDI_PEER_ID must be a wildcard. Only port or adapter pauses are allowed in this mode.

Requirements

Requirement	Value
Minimum supported client	Windows 10
Minimum supported server	Windows Server 2016
Target Platform	Windows
Header	dot11wdi.h