OID_DOT11_DIVERSITY_SELECTION_RX

Important  The Native 802.11 Wireless LAN interface is deprecated in Windows 10 and later. Please use the WLAN Device Driver Interface (WDI) instead. For more information about WDI, see WLAN Universal Windows driver model.

When queried, the OID_DOT11_DIVERSITY_SELECTION_RX object identifier (OID) requests that the miniport driver return the value of the IEEE 802.11 dot11DiversitySelectionRx management information base (MIB) object for the current PHY type on the 802.11 station.

This MIB object specifies the list of antennas on the current PHY type that are available for receive (RX) diversity operations.

The data type for OID_DOT11_DIVERSITY_SELECTION_RX is the DOT11_DIVERSITY_SELECTION_RX_LIST.

    typedef struct _DOT11_DIVERSITY_SELECTION_RX_LIST {
         ULONG uNumOfEntries;
         ULONG uTotalNumOfEntries;
         DOT11_DIVERSITY_SELECTION_RX dot11DiversitySelectionRx[1];
    } DOT11_DIVERSITY_SELECTION_RX_LIST, *PDOT11_DIVERSITY_SELECTION_RX_LIST;
  

This structure includes the following members:

uNumOfEntries
Number of entries in the dot11DiversitySelectionRx array. A zero value for this member indicates an empty list.

uTotalNumOfEntries
Maximum number of entries that the dot11DiversitySelectionRx array requires.

dot11DiversitySelectionRx
The list of receive (RX) antennas that may be used for RX diversity operations.

The data type for the elements of the dot11DiversitySelectionRx array is the DOT11_DIVERSITY_SELECTION_RX structure.

typedef struct _DOT11_DIVERSITY_SELECTION_RX {         ULONG uAntennaListIndex;
 BOOLEAN
 bDiversitySelectionRX; } DOT11_DIVERSITY_SELECTION_RX,*PDOT11_DIVERSITY_SELECTION_RX;

This structure includes the following members:

uAntennaListIndex
The antenna index. The value of uAntennaListIndex must be from 1 through 255.

The antenna index value must match the index of a supported RX antenna previously specified by the miniport driver when queried by OID_DOT11_SUPPORTED_RX_ANTENNA.

bDiversitySelectionRX
When set to TRUE, this indicates that the antenna represented by uAntennaListIndex can be used for receive diversity.

When OID_DOT11_DIVERSITY_SELECTION_RX is queried, the miniport driver must verify that the InformationBuffer member of the MiniportOidRequest function's OidRequest parameter is large enough to return the entire DOT11_DIVERSITY_SELECTION_RX_LIST structure, including all entries in the dot11DiversitySelectionRx array. The value of the InformationBufferLength member of the OidRequest parameter determines what the miniport driver must do, as the following list shows:

• If the value of the InformationBufferLength member is less than the length, in bytes, of the entire DOT11_DIVERSITY_SELECTION_RX_LIST structure, the miniport driver must do the following:

  • For the OidRequest parameter, set the BytesWritten member to zero and the BytesNeeded member to the length, in bytes, of the entire DOT11_DIVERSITY_SELECTION_RX_LIST structure.

  • Fail the query request by returning NDIS_STATUS_BUFFER_OVERFLOW from its MiniportOidRequest function.

• If the value of the InformationBufferLength member is greater than or equal to the length, in bytes, of the entire DOT11_DIVERSITY_SELECTION_RX_LIST structure, the miniport driver must do the following to complete a successful query request:

  • For the DOT11_DIVERSITY_SELECTION_RX_LIST structure, set the uNumOfEntries and uTotalNumOfEntries members to the total number of entries in the dot11DiversitySelectionRx array.

  • For the OidRequest parameter, set the BytesNeeded member to zero and the BytesWritten member to the length, in bytes, of the entire DOT11_DIVERSITY_SELECTION_RX_LIST structure. The miniport driver must also copy the entire DOT11_DIVERSITY_SELECTION_RX_LIST structure to the InformationBuffer member.

  • Return NDIS_STATUS_SUCCESS from its MiniportOidRequest function.

If the miniport driver is operating in Extensible Station (ExtSTA) mode, the current PHY type is determined through the ExtSTA msDot11CurrentPhyID MIB object. This MIB object specifies the index of the current PHY type within the 802.11 station's list of supported PHY types. For more information about msDot11CurrentPhyID, see OID_DOT11_CURRENT_PHY_ID.

Note  A Native 802.11 miniport driver that is designed to run on the Windows Vista or Windows Server 2008 operating systems must always reset this 802.11 MIB OID to its default value. This is the case regardless of the value of the bSetDefaultMIB member of the DOT11_RESET_REQUEST structure. This requirement applies to a miniport driver that, in a call to the NdisMSetMiniportAttributes function, sets MiniportAttributes -> Native_802_11_Attributes -> Header -> Revision to NDIS_MINIPORT_ADAPTER_802_11_ATTRIBUTES_REVISION_1.

Requirements

See also

Native 802.11 MIB OIDs

Native 802.11 Wireless LAN OIDs