MINIPORT_WDI_TX_TARGET_DESC_DEINIT 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 MINIPORT_WDI_TX_TARGET_DESC_DEINIT callback function informs the TxEngine that the target TX descriptors associated with the NET_BUFFER_LIST (NBLs) in the NBL chain are no longer needed and can be freed.

This is a WDI miniport handler inside NDIS_MINIPORT_WDI_DATA_HANDLERS.

Note You must declare the function by using the MINIPORT_WDI_TX_TARGET_DESC_DEINIT type. For more information, see the following Examples section.

Syntax

MINIPORT_WDI_TX_TARGET_DESC_DEINIT MiniportWdiTxTargetDescDeinit;

void MiniportWdiTxTargetDescDeinit(
  [in] TAL_TXRX_HANDLE MiniportTalTxRxContext,
  [in] PNET_BUFFER_LIST pNBL
)
{...}

Parameters

[in] MiniportTalTxRxContext

TAL device handle returned by the IHV miniport in the MINIPORT_WDI_TAL_TXRX_INITIALIZE callback function.

[in] pNBL

Pointer to a NET_BUFFER_LIST chain.

Return value

None

Remarks

Important The IHV miniport is not permitted to make any indication in the context of this call. The TxMgr serializes calls to TxTargetDescDeInitHandler.

Examples

To define a MINIPORT_WDI_TX_TARGET_DESC_DEINIT callback function, you must first provide a function declaration that identifies the type of function you're defining. Windows provides a set of function types for drivers. Declaring a function using the function types helps Code Analysis for Drivers, Static Driver Verifier (SDV), and other verification tools find errors, and it's a requirement for writing drivers for the Windows operating system.

For example, to define a MINIPORT_WDI_TX_TARGET_DESC_DEINIT callback function that is named "MyTxTargetDescDeInit", use the MINIPORT_WDI_TX_TARGET_DESC_DEINIT type as shown in this code example:

MINIPORT_WDI_TX_TARGET_DESC_DEINIT MyTxTargetDescDeInit;

Then, implement your function as follows:

_Use_decl_annotations_
VOID
 MyTxTargetDescDeInit(
    TAL_TXRX_HANDLE MiniportTalTxRxContext,
    PNET_BUFFER_LIST pNBL
    )
  {...}

The MINIPORT_WDI_TX_TARGET_DESC_DEINIT function type is defined in the dot11wdi.h header file. To more accurately identify errors when you run the code analysis tools, be sure to add the Use_decl_annotations annotation to your function definition. The Use_decl_annotations annotation ensures that the annotations that are applied to the MINIPORT_WDI_TX_TARGET_DESC_DEINIT function type in the header file are used. For more information about the requirements for function declarations, see Declaring Functions by Using Function Role Types for NDIS Drivers.

For information about Use_decl_annotations, see Annotating Function Behavior.

Requirements

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