OID_DOT11_RECV_SENSITIVITY_LIST

  • Article

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_RECV_SENSITIVITY_LIST object identifier (OID) requests that the miniport driver return the list of receive sensitivity ranges for all data rates supported on a PHY. The miniport driver returns the receive sensitivity list for the PHY that is specified in the query request.

The data type for this OID is the DOT11_RECV_SENSITIVITY_LIST structure.

 typedef struct _DOT11_RECV_SENSITIVITY_LIST {
    union {
        DOT11_PHY_TYPE dot11PhyType;
        ULONG uPhyId;
    };
    ULONG uNumOfEntries;
    ULONG uTotalNumOfEntries;
    DOT11_RECV_SENSITIVITY dot11RecvSensitivity[1];
} DOT11_RECV_SENSITIVITY_LIST, * PDOT11_RECV_SENSITIVITY_LIST;

This structure includes the following members:

dot11PhyType
The PHY type queried for the receive sensitivity list. The PHY type is defined by the DOT11_PHY_TYPE enumeration.

If the 802.11 station does not support the specified PHY type, the miniport driver must fail the query request by returning NDIS_STATUS_BAD_VERSION from its MiniportOidRequest function.

Note  The miniport driver must not use this member if it is operating in Extensible Station (ExtSTA) mode.

 

uPhyId
The identifier (ID) of the PHY that is queried for the receive sensitivity list. The PHY ID is the index within the list of supported PHYs returned by the driver through a query of OID_DOT11_SUPPORTED_PHY_TYPES.

If the ID is invalid, the miniport driver must fail the query request by returning NDIS_STATUS_BAD_VERSION from its MiniportOidRequest function.

Note  The miniport driver must use this member if it is operating in ExtSTA mode.

 

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

uTotalNumOfEntries
Maximum number of entries that the dot11RecvSensitivity array requires.

dot11RecvSensitivity
The receive sensitivity list for the PHY that is specified by the dot11PhyType member.

The data type for the elements of the dot11RecvSensitivity array is the DOT11_RECV_SENSITIVITY structure.

typedef struct _DOT11_RECV_SENSITIVITY {         UCHAR ucDataRate;
         LONG lRSSIMin;
 LONG
 lRSSIMax; } DOT11_RECV_SENSITIVITY, *PDOT11_RECV_SENSITIVITY;

This structure includes the following members:

ucDataRate
A data rate supported by the PHY that is specified by the dot11PhyType member. The miniport driver must specify a data rate from 2 through 127 and in units of 500 kilobits per second (kbps).

lRSSIMin
The minimum receive signal strength indication (RSSI) value, in units of decibels referenced to 1.0 milliwatts (dBm), for the data rate specified by the ucDataRate member.

lRSSIMax
The maximum RSSI value, in units of dBm, for the data rate that is specified by the ucDataRate member.

When OID_DOT11_RECV_SENSITIVITY_LIST 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_RECV_SENSITIVITY_LIST structure, including all entries in the dot11RecvSensitivity array. The value of the InformationBufferLength member of the OidRequest parameter determines what the miniport driver must do, as shown in the following list:

  • If the value of the InformationBufferLength member is less than the length, in bytes, of the entire DOT11_RECV_SENSITIVITY_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_RECV_SENSITIVITY_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_RECV_SENSITIVITY_LIST structure, the miniport driver must do the following to complete a successful query request:

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

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

    • Return NDIS_STATUS_SUCCESS from its MiniportOidRequest function.

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

 Windot11.h (include Ndis.h)

See also

Native 802.11 Wireless LAN OIDs