dot11wdi.h header

This header is used by network. For more information, see:

• Network

dot11wdi.h contains the following programming interfaces:

Functions

NdisMDeregisterWdiMiniportDriver A miniport driver calls the NdisMDeregisterWdiMiniportDriver function to release resources that it allocated with a previous call to the NdisMRegisterWdiMiniportDriver function.
NdisMRegisterWdiMiniportDriver A miniport driver calls the NdisMRegisterWdiMiniportDriver function to register MiniportWdiXxx entry points with NDIS as the first step in initialization.

Callback functions

MINIPORT_WDI_ADAPTER_HANG_DIAGNOSE The MiniportWdiAdapterHangDiagnose handler function is used to collect hardware control register states and optionally full firmware state.
MINIPORT_WDI_ALLOCATE_ADAPTER The MiniportWdiAllocateAdapter handler function allocates a WDI miniport adapter.
MINIPORT_WDI_CANCEL_IDLE_NOTIFICATION NDIS calls the MiniportWdiCancelIdleNotification handler function to notify the WDI miniport driver that NDIS has detected activity on the suspended network adapter.
MINIPORT_WDI_CLOSE_ADAPTER The MiniportWdiCloseAdapter handler function is used by the Microsoft component to initiate the Close Task operation on the IHV driver.
MINIPORT_WDI_FREE_ADAPTER The MiniportWdiFreeAdapter handler function requests that the IHV driver deletes its software state.
MINIPORT_WDI_IDLE_NOTIFICATION NDIS calls the MiniportWdiIdleNotification handler function to start the NDIS selective suspend operation on an idle network adapter. Through this operation, the network adapter is suspended and transitioned to a low-power state.
MINIPORT_WDI_OPEN_ADAPTER The MiniportWdiOpenAdapter handler function is used by the Microsoft component to initiate the Open Task operation on the IHV driver.
MINIPORT_WDI_POST_ADAPTER_PAUSE The MiniportWdiPostAdapterPause handler function is called by the Microsoft component after it finishes the data path clean up as part of the NDIS MiniportPause requirements.
MINIPORT_WDI_POST_ADAPTER_RESTART The MiniportWdiPostAdapterRestart handler function is called by the Microsoft component after it finishes restarting the data path as part of the NDIS MiniportRestart requirements.
MINIPORT_WDI_RX_FLUSH The MiniportWdiRxFlush handler function is issued after the MiniportWdiRxStop operation is completed. Upon receiving the flush request, the target/RxEngine must discard all unindicated frames on the port/adapter before indicating RxFlushConfirm.
MINIPORT_WDI_RX_GET_MPDUS The MiniportWdiRxGetMpdus handler function returns a NET_BUFFER_LIST chain. Each NET_BUFFER_LIST represents one MPDU.
MINIPORT_WDI_RX_PPDU_RSSI The MiniportWdiRxPpduRssi handler function returns the absolute value of RSSI (in dB) for the PPDU. The RxMgr may request the RSSI only once per data indication using the PNET_BUFFER_LIST obtained from MiniportWdiRxGetMpdus.
MINIPORT_WDI_RX_RESTART The MiniportWdiRxRestart handler function configures the RxEngine to restart indicating data traffic. This is issued following a MiniportWdiRxStop.
MINIPORT_WDI_RX_RESUME The MiniportWdiRxResume handler function is issued by the RxMgr after it returns a pause status to a data indication.
MINIPORT_WDI_RX_RETURN_FRAMES The MiniportWdiRxReturnFrames handler function returns a NET_BUFFER_LIST structure (and associated data buffers) to the TAL.
MINIPORT_WDI_RX_STOP The MiniportWdiRxStop handler function stops RX on a given port and accepts the wildcard port ID to stop RX across the adapter.
MINIPORT_WDI_RX_THROTTLE The MiniportWdiRxThrottle handler function tells the TAL/target to enable mechanisms to reduce the rate of RX MSDUs.
MINIPORT_WDI_START_ADAPTER_OPERATION The MiniportWdiStartAdapterOperation handler function can be used by the IHV driver to perform any additional MiniportInitializeEx tasks.
MINIPORT_WDI_STOP_ADAPTER_OPERATION The MiniportWdiStopAdapterOperation handler function can be used by the IHV driver to undo the operations performed in MiniportWdiStartAdapterOperation.
MINIPORT_WDI_TAL_TXRX_ADD_PORT The MiniportWdiTalTxRxAddPort handler function notifies the datapath components of the creation of a new virtual port.
MINIPORT_WDI_TAL_TXRX_DEINITIALIZE The MiniportWdiTalTxRxDeinitialize handler function is invoked in the context of miniport halt. The functional components RXEngine and TxEngine have already been stopped and any pending data frames completed/returned.
MINIPORT_WDI_TAL_TXRX_DELETE_PORT The MiniportWdiTalTxRxDeletePort handler function notifies the datapath components of the deletion of a virtual port.
MINIPORT_WDI_TAL_TXRX_INITIALIZE The MiniportWdiTalTxRxInitialize handler function initializes data structures in the TAL and exchanges datapath component handles between the UE and TAL.
MINIPORT_WDI_TAL_TXRX_PEER_CONFIG The MiniportWdiTalTxRxPeerConfig handler function specifies the port ID, peer ID, and peer capabilities (for example, QoS capabilities). It is invoked after the peer has associated, which involves creation of the peer object in the TAL.
MINIPORT_WDI_TAL_TXRX_PEER_DELETE_CONFIRM The MiniportWdiTalTxRxPeerDeleteConfirm handler function is invoked after the completion of a PeerDeleteIndication call which did not return success.
MINIPORT_WDI_TAL_TXRX_RESET_PORT The MiniportWdiTalTxRxResetPort handler function is invoked before a dot11 reset task is issued to the target.
MINIPORT_WDI_TAL_TXRX_SET_PORT_OPMODE The MiniportWdiTalTxRxSetPortOpMode handler function specifies the opmode used for the port so that the TxEngine and RxEngine enable the corresponding functionality.
MINIPORT_WDI_TAL_TXRX_START The MiniportWdiTalTxRxStart handler function provides TXRX configuration parameters to the TAL.
MINIPORT_WDI_TAL_TXRX_STOP The MiniportWdiTalTxRxStop handler function stops TXRX communication between the TAL and the target.
MINIPORT_WDI_TX_ABORT The MiniportWdiTxAbort handler function aborts outstanding TX frames for a given port or peer, which includes initiating the completion of frames owned by the TAL/target.
MINIPORT_WDI_TX_DATA_SEND The MiniportWdiTxDataSend handler function specifies an RA-TID or port queue to transmit from. It is issued in the context of the TX thread from the operating system, resume indication, or a work item.
MINIPORT_WDI_TX_PEER_BACKLOG The MiniportWdiTxPeerBacklog handler function is issued when a paused peer has a change in backlog state.
MINIPORT_WDI_TX_SUSPECT_FRAME_LIST_ABORT The TxSuspectFrameListAbort callback function is implemented by the client driver to inform the TxEngine that the TxMgr has identified frames which are suspected of being hung or pending completion for a significant length of time.
MINIPORT_WDI_TX_TAL_QUEUE_IN_ORDER The MiniportWdiTxTalQueueInOrder handler function notifies the TAL target that one or more paused RA/TID queues (with WDI_TX_PAUSE_REASON_PS) is ready to transmit.
MINIPORT_WDI_TX_TAL_SEND The MiniportWdiTxTalSend handler function specifies an RA-TID or port queue to transmit from.
MINIPORT_WDI_TX_TAL_SEND_COMPLETE The MiniportWdiTxTalSendComplete handler function returns ownership of one or more TX frame injected by the TAL back to the TxEngine.
MINIPORT_WDI_TX_TARGET_DESC_DEINIT 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.
MINIPORT_WDI_TX_TARGET_DESC_INIT The MINIPORT_WDI_TX_TARGET_DESC_INIT callback function associates an opaque target TX descriptor with the NET_BUFFER_LIST (MiniportReserved[1] field) and (if applicable) populates the TX cost field (in credit units) in the WDI_FRAME_METADATA buffer of the NET_BUFFER_LIST (MiniportReserved[0]).
NDIS_WDI_ALLOCATE_WDI_FRAME_METADATA The NdisWdiAllocateWiFiFrameMetaData callback function allocates a frame metadata buffer.
NDIS_WDI_CLOSE_ADAPTER_COMPLETE The NdisWdiCloseAdapterComplete callback function is called by the IHV when a Close Task operation from MiniportWdiCloseAdapter has been successfully started.
NDIS_WDI_FREE_WDI_FRAME_METADATA The NdisWdiFreeWiFiFrameMetaData callback function frees a frame metadata buffer.
NDIS_WDI_IDLE_NOTIFICATION_COMPLETE Miniport drivers call NdisWdiIdleNotificationComplete callback function to complete a pending idle notification for an NDIS selective suspend operation. NDIS begins the operation when it calls the driver's MiniportWdiIdleNotification handler function.
NDIS_WDI_IDLE_NOTIFICATION_CONFIRM Miniport drivers call NdisWdiIdleNotificationConfirm callback function to notify NDIS that the idle network adapter can safely be suspended and transitioned to a low-power state.
NDIS_WDI_OPEN_ADAPTER_COMPLETE The NdisWdiOpenAdapterComplete callback function is called by the IHV when an Open Task operation from MiniportWdiOpenAdapter has been successfully started.
NDIS_WDI_PEER_CREATE_IND The NdisWdiPeerCreateIndication callback function specifies a peer ID to associate with a peer MAC address.
NDIS_WDI_PEER_DELETE_IND The NdisWdiPeerDeleteIndication callback function initiates the removal of the association of between a peer ID and a peer MAC address.
NDIS_WDI_RX_FLUSH_CONFIRM The NdisWdiRxFlushConfirm callback function indicates completion of a MiniportWdiRxFlush request. The RxEngine must complete the discard of all RX data frames that match the flush request prior to issuing NdisWdiRxFlushConfirm.
NDIS_WDI_RX_INORDER_DATA_IND The NdisWdiRxInorderDataIndication callback function informs the RxMgr that a list of specified RX frames in the correct order are present.
NDIS_WDI_RX_STOP_CONFIRM The NdisWdiRxStopConfirm callback function indicates completion of a MiniportWdiRxStop request.
NDIS_WDI_TX_ABORT_CONFIRM The NdisWdiTxAbortConfirm callback function indicates an asynchronous confirmation of a MiniportWdiTxAbort from WDI.
NDIS_WDI_TX_DEQUEUE_IND The NdisWdiTxDequeueIndication callback function is called in the context of a MiniportWdiTxDataSend or MiniportWdiTxTalSend by the IHV miniport to dequeue frames from WDI to the IHV miniport.
NDIS_WDI_TX_INJECT_FRAME_IND The NdisWdiTxInjectFrameIndication callback function allows the LE to inject frames through the regular datapath (for example, authentication/association requests/responses, Wi-Fi Direct action frames).
NDIS_WDI_TX_QUERY_RA_TID_STATE The NdisWdiTxQueryRATIDState callback function is used by the TxEngine to query the state of a RA/TID or Port queue.
NDIS_WDI_TX_QUERY_SUSPECT_FRAME_COMPLETE_STATUS The TxQuerySuspectFrameStatus callback function is implemented by the IHV miniport to query the status of a suspect frame.
NDIS_WDI_TX_RELEASE_FRAMES_IND 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.
NDIS_WDI_TX_SEND_COMPLETE_IND The NdisWdiTxSendCompleteIndication callback function specifies an array of frame IDs associated with the target's sent frames.
NDIS_WDI_TX_SEND_PAUSE_IND The NdisWdiTxSendPauseIndication callback function pauses transmissions on a given port to a given peer or peer-TID combination.
NDIS_WDI_TX_SEND_RESTART_IND The NdisWdiTxSendRestartIndication callback function resumes transmission on a given port to a given peer or peer-TID combination.
NDIS_WDI_TX_TRANSFER_COMPLETE_IND The NdisWdiTxTransferCompleteIndication callback function specifies a list of frame buffers that have been transferred to the target. Frames with different TX Status values are completed in separate indications.

Structures

NDIS_MINIPORT_DRIVER_WDI_CHARACTERISTICS The NDIS_MINIPORT_DRIVER_WDI_CHARACTERISTICS structure defines the set of handlers that a WDI miniport driver must implement.
NDIS_MINIPORT_WDI_DATA_HANDLERS The NDIS_MINIPORT_WDI_DATA_HANDLERS structure specifies the entry points for the IHV miniport datapath handlers.
NDIS_WDI_DATA_API The NDIS_WDI_DATA_API structure specifies the entry points for WDI data indications.
NDIS_WDI_INIT_PARAMETERS The NDIS_WDI_INIT_PARAMETERS structure specifies the WDI functions provided by the operating system and called by the IHV WDI driver.
TAL_TXRX_PARAMETERS The TAL_TXRX_PARAMETERS structure defines the TAL TXRX parameters.
WDI_FRAME_METADATA The WDI_FRAME_METADATA structure defines the frame metadata.
WDI_MAC_ADDRESS The WDI_MAC_ADDRESS structure defines an IEEE media access control (MAC) address.
WDI_MESSAGE_HEADER The WDI_MESSAGE_HEADER structure defines the WDI message header. All WDI command messages must start with this header.
WDI_P2P_SERVICE_NAME_HASH The WDI_P2P_SERVICE_NAME_HASH structure defines a hash of a WFDS Service Name.
WDI_RX_METADATA The WDI_RX_METADATA structure defines the RX metadata.
WDI_TX_COMPLETE_DATA The WDI_TX_COMPLETE_DATA structure defines TX completion data.
WDI_TX_METADATA The WDI_TX_METADATA structure defines the TX metadata.
WDI_TXRX_CAPABILITIES The WDI_TXRX_CAPABILITIES structure defines the target capabilities.
WDI_TXRX_MPDU_PN The WDI_TXRX_MPDU_PN union defines the parameters that are passed down to the TXRX component.
WDI_TXRX_PARAMETERS The WDI_TXRX_PARAMETERS structure defines the parameters that are passed down to the TXRX component.
WDI_TXRX_PEER_CFG The WDI_TXRX_PEER_CFG structure defines peer configuration.
WDI_TXRX_TARGET_CONFIGURATION The WDI_TXRX_TARGET_CONFIGURATION structure defines the target configuration.

Enumerations

eDiagnoseLevel The eDiagnoseLevel enumeration defines the diagnosis levels for adapter hang diagnosis.
WDI_EXEMPTION_ACTION_TYPE The WDI_EXEMPTION_ACTION_TYPE enumeration defines the exemption types.
WDI_FRAME_PAYLOAD_TYPE The WDI_FRAME_PAYLOAD_TYPE enumeration defines the frame payload type.
WDI_INTERCONNECT_TYPE The WDI_INTERCONNECT_TYPE enumeration defines the interconnect types.
WDI_OPERATION_MODE The WDI_OPERATION_MODE enumeration defines operation modes.
WDI_RX_INDICATION_LEVEL The WDI_RX_INDICATION_LEVEL enumeration defines the RX indication levels.
WDI_RX_THROTTLE_LEVEL The WDI_RX_THROTTLE_LEVEL enumeration defines the RX throttle level. The interpretation and implementation mechanisms of these throttle levels are defined by the independent hardware vendor (IHV).
WDI_TX_FRAME_STATUS The WDI_TX_FRAME_STATUS enumeration defines the TX frame status values.
WDI_TX_PAUSE_REASON The WDI_TX_PAUSE_REASON enumeration defines the reasons for a TX pause.
WDI_TXRX_PEER_QOS_CAPS The WDI_TXRX_PEER_QOS_CAPS enumeration defines the Quality of Service (QoS) capabilities.