OID_DOT11_DESIRED_PHY_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 set, the OID_DOT11_DESIRED_PHY_LIST object identifier (OID) requests that the miniport driver set the value of the Extensible Station (ExtSTA) msDot11DesiredPhyList management information base (MIB) object to the specified data.

When queried, OID_DOT11_DESIRED_PHY_LIST requests that the miniport driver return the value of the msDot11DesiredPhyList MIB object.

The msDot11DesiredPhyList MIB object specifies the desired PHY list that the 802.11 station uses when connecting to and operating in a BSS network. Each entry in the msDot11DesiredPhyList MIB object is a PHY identifier (IDs), which can be one of the following:

  • An index into the table of supported PHYs as defined by the Native 802.11 Operational msDot11SupportedPhyTypes MIB object. For more information about PHY IDs and the msDot11SupportedPhyTypes MIB object, see OID_DOT11_SUPPORTED_PHY_TYPES.

  • A PHY ID with the value of DOT11_PHY_ID_ANY is the wildcard PHY ID. If the msDot11DesiredPhyList MIB object contains the wildcard PHY ID, the 802.11 station can use any supported PHY to connect to and operate in a BSS network.

The msDot11DesiredPhyList MIB object does not define the PHY IDs that can be used by the 802.11 station for scan operations. The PHY IDs that the 802.11 station uses for scanning are specified when OID_DOT11_SCAN_REQUEST is set.

The data type for OID_DOT11_DESIRED_PHY_LIST is the DOT11_PHY_ID_LIST structure.

When OID_DOT11_DESIRED_PHY_LIST is set, the miniport driver should ensure that the value of the InformationBufferLength member of the MiniportOidRequest function's OidRequest parameter is at least the value returned by the following formula:

 FIELD_OFFSET(DOT11_PHY_ID_LIST, dot11PhyId) + uNumOfEntries * sizeof(ULONG))

When OID_DOT11_DESIRED_PHY_LIST is set, the miniport driver must fail the set request if the members of the DOT11_PHY_ID_LIST structure meet the following conditions:

  • The desired PHY list must always contain at least one entry. If uNumOfEntries is set to zero, the miniport driver must fail the request by returning NDIS_STATUS_INVALID_DATA from its MiniportOidRequest function.

  • A desired PHY list containing a wildcard PHY ID cannot contain other PHY IDs. When OID_DOT11_DESIRED_PHY_LIST is set, the miniport driver must fail the request by returning NDIS_STATUS_INVALID_DATA from its MiniportOidRequest function if the dot11PhyIds array contains the wildcard PHY ID and uNumOfEntries is greater than one.

  • If the dot11PhyId array contains a PHY ID that is not the wildcard PHY ID and has a value greater than or equal to the number of entries defined by the msDot11SupportedPhyTypes MIB object, the miniport driver must fail the request by returning NDIS_STATUS_INVALID_DATA from its MiniportOidRequest function.

  • If the dot11PhyId array contains a PHY ID that is not supported on the 802.11 station, the miniport driver must fail the request by returning NDIS_STATUS_UNSUPPORTED_MEDIA from its MiniportOidRequest function.

  • If the dot11PhyId array contains a PHY ID that has been disabled on the 802.11 station through a proprietary mechanism implemented by the independent hardware vendor (IHV), the miniport driver must fail the request by returning NDIS_STATUS_UNSUPPORTED_MEDIA from its MiniportOidRequest function.

    Note  This condition does not apply to PHYs disabled through a set request of OID_DOT11_NIC_POWER_STATE.

     

When OID_DOT11_DESIRED_PHY_LIST is queried, the miniport driver must verify that the InformationBuffer member of its MiniportOidRequest function's OidRequest parameter is large enough to return the desired PHY ID list. For more information about this procedure, see DOT11_PHY_ID_LIST.

The default for the msDot11DesiredPhyList MIB object contains a single entry with the members of the DOT11_PHY_ID_LIST structure set as follows:

  • dot11PhyId[0] is set to DOT11_PHY_ID_ANY.

  • uNumEntries is set to one.

The miniport driver must set the msDot11DesiredPhyList MIB object to its default whenever the following occurs:

  • The miniport driver's MiniportInitializeEx function is called.

  • A method request of OID_DOT11_RESET_REQUEST is made to reset the media access control (MAC) layer of the 802.11 station and the bSetDefaultMIB member of the DOT11_RESET_REQUEST structure is TRUE.

Beginning in Windows 7, the default behavior of the ExtAP mode is to support only one desired PHY ID at a time. If multiple PHY IDs are present in a set request to this OID, the NIC should start a BSS using the first PHY ID in the list.

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