NDIS_WDI_TX_RELEASE_FRAMES_IND 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 NdisWdiTxReleaseFrameIndication callback function releases up to a specified number or aggregate cost of frames queued to a given peer-TID combination when transmission is paused. If the specified queues are not paused, none of the NET_BUFFER_LISTs are released.

This is a callback inside NDIS_WDI_DATA_API.

Syntax

NDIS_WDI_TX_RELEASE_FRAMES_IND NdisWdiTxReleaseFramesInd;

void NdisWdiTxReleaseFramesInd(
  [in]  NDIS_HANDLE NdisMiniportDataPathHandle,
  [in]  WDI_PORT_ID PortId,
  [in]  WDI_PEER_ID PeerId,
  [in]  UINT32 ExTidBitmask,
  [in]  UINT8 MaxNumFrames,
  [in]  UINT16 Credit,
  [out] PNET_BUFFER_LIST *ppNBL
)
{...}

Parameters

[in] NdisMiniportDataPathHandle

The NdisMiniportDataPathHandle passed to the IHV miniport in MiniportWdiTalTxRxInitialize.

[in] PortId

The port ID. Must be a non-wildcard value.

[in] PeerId

The peer ID. Must be a non-wildcard value.

[in] ExTidBitmask

The Extended TID bitmask.

[in] MaxNumFrames

Maximum frame count. MaxNumFrames is ignored if it is set to WDI_TX_MAX_FRAME_COUNT_INVALID (0xFF).

[in] Credit

Credit. Credit is ignored if it is set to WDI_TX_CREDIT_INVALID (0xFFFF).

[out] ppNBL

Pointer to a pointer to a NET_BUFFER_LIST chain of released frames.

Return value

None

Remarks

if one of the specified queues is paused with WDI_TX_PAUSE_REASON_PS, the TAL/Target does not issue this indication until it has received a MiniportWdiTxTalQueueInOrder indication for that queue.

This indication is only allowed when TargetPriorityQueueing is false.

The TxMgr may return a list of NET_BUFFER_LIST that exceed the limit of the number of frames or frame cost. This only happens if the frames are being requeued after being send completed with status of Postponed and with identical sequence number, which indicates they were originally transmitted as part of a single A-MSDU.

Requirements

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