OID_NIC_SWITCH_PARAMETERS

An overlying driver issues an object identifier (OID) method request of OID_NIC_SWITCH_PARAMETERS to obtain the current configuration parameters of a specified NIC switch on a network adapter. NDIS handles these OID method requests for the miniport driver.

Overlying drivers issue an OID set request of OID_NIC_SWITCH_PARAMETERS to set the configuration parameters of a specified NIC switch on a network adapter. These OID set requests are issued to the miniport driver of the network adapter's PCI Express (PCIe) Physical Function (PF). These OID set requests are required for PF miniport drivers that support the single root I/O virtualization (SR-IOV) interface.

The InformationBuffer member of the NDIS_OID_REQUEST structure contains a pointer to an NDIS_NIC_SWITCH_PARAMETERS structure.

The overlying driver specifies the NIC switch for the OID method or set request by setting the SwitchId member of the NDIS_NIC_SWITCH_PARAMETERS structure to the switch identifier. The overlying driver obtains the switch identifier through one of the following ways:

Note Starting with Windows Server 2012, Windows supports only the default NIC switch on the network adapter. The SwitchId member of the NDIS_NIC_SWITCH_PARAMETERS structure must be set to NDIS_DEFAULT_SWITCH_ID.

Remarks

The overlying driver issues OID_NIC_SWITCH_PARAMETERS requests in the following way:

  • The overlying driver issues an OID method request of OID_NIC_SWITCH_PARAMETERS to obtain the current parameters of a specified NIC switch. For more information, see Querying the Parameters of a NIC Switch.

    Note NDIS handles OID method requests of OID_NIC_SWITCH_PARAMETERS for the PF miniport driver.

  • The overlying driver issues an OID set request of OID_NIC_SWITCH_PARAMETERS to change the current parameters of a specified NIC switch. For more information, see Setting the Parameters of a NIC Switch.

    Note The PF miniport driver handles OID set requests of OID_NIC_SWITCH_PARAMETERS.

Return Status Codes

NDIS or the PF miniport driver returns the following status codes for set or method OID requests of OID_NIC_SWITCH_PARAMETERS.

Status Code Description

NDIS_STATUS_SUCCESS

The request completed successfully. The InformationBuffer points to an NDIS_NIC_SWITCH_CAPABILITIES structure.

NDIS_STATUS_NOT_SUPPORTED

The PF miniport driver either does not support the single root I/O virtualization (SR-IOV) interface or is not enabled to use the interface.

NDIS_STATUS_INVALID_PARAMETER

One or more of the members of the NDIS_NIC_SWITCH_PARAMETERS structure have invalid values.

NDIS_STATUS_INVALID_LENGTH

The information buffer was too short. NDIS or the PF miniport driver sets the DATA.METHOD_INFORMATION.BytesNeeded member (for OID method requests) or DATA.SET_INFORMATION.BytesNeeded member (for OID set requests) in the NDIS_OID_REQUEST structure to the minimum buffer size that is required.

NDIS_STATUS_REINIT_REQUIRED

The PF miniport driver requires a reinitialization of the network adapter to apply the changes to the NIC switch.

NDIS_STATUS_FAILURE

The request failed for other reasons.

Requirements

Version

Supported in NDIS 6.30 and later.

Header

Ntddndis.h (include Ndis.h)

See also


FilterAttach

NDIS_BIND_PARAMETERS

NDIS_FILTER_ATTACH_PARAMETERS

NDIS_NIC_SWITCH_PARAMETERS

NDIS_OID_REQUEST

OID_NIC_SWITCH_CREATE_SWITCH

OID_NIC_SWITCH_ENUM_SWITCHES

ProtocolBindAdapterEx


Send comments about this topic to Microsoft