OID_DOT11_HOPPING_PATTERN (Compact 2013)

  • Article

3/26/2014

When queried, this OID requests that the miniport driver return the list of hopping patterns currently used by the current PHY type on the 802.11 station.

Note

Support for OID_DOT11_HOPPING_PATTERN is mandatory if the network adapter supports the dot11_phy_type_fhss PHY type and more than one regulatory domain. For more information about how the miniport driver specifies its list of supported PHY types, see OID_DOT11_SUPPORTED_PHY_TYPES.

The data type for OID_DOT11_HOPPING_PATTERN is the DOT11_HOPPING_PATTERN_ENTRY_LIST structure.

The dot11HoppingPatternEntry MIB object is valid for the frequency-hopping spread spectrum (FHSS) PHY type only. If the current PHY type is not set to dot11_phy_type_fhss, the miniport driver must fail the query request by returning NDIS_STATUS_INVALID_DATA from its MiniportOidRequest function.

When OID_DOT11_HOPPING_PATTERN 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_HOPPING_PATTERN_ENTRY_LIST structure, including all entries in the dot11HoppingPatternEntry array. The value of the InformationBufferLength member of the OidRequest parameter determines what the miniport driver must do, for example:

  • If the value of the InformationBufferLength member is less than the length, in bytes, of the entire DOT11_HOPPING_PATTERN_ENTRY_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_HOPPING_PATTERN_ENTRY_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_HOPPING_PATTERN_ENTRY_LIST structure, the miniport driver must do the following to complete a successful query request:
    • For the DOT11_HOPPING_PATTERN_ENTRY_LIST structure, set the uNumOfEntries and uTotalNumOfEntries members to the total number of entries in the dot11HoppingPatternEntry array.
    • For the OidRequest parameter, set the BytesNeeded member to zero and the BytesWritten member to the length, in bytes, of the entire DOT11_HOPPING_PATTERN_ENTRY_LIST structure. The miniport driver must also copy the entire DOT11_RECV_SENSITIVITY_LIST structure to the InformationBuffer member and the entire DOT11_HOPPING_PATTERN_ENTRY_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.

Requirements

Header

windot11.h

See Also

Reference

NDIS 5.x Legacy Wireless LAN OIDs
DOT11_HOPPING_PATTERN_ENTRY_LIST
OID_DOT11_SUPPORTED_PHY_TYPES
MiniportOidRequest
OID_DOT11_CURRENT_PHY_ID
Native 802.11 MIB OIDs
NDIS 5.x Legacy Reference