NDIS_NIC_SWITCH_VPORT_PARAMETERS structure (ntddndis.h)
The NDIS_NIC_SWITCH_VPORT_PARAMETERS structure specifies the configuration for a virtual port (VPort) on a network adapter switch of the network adapter.
Syntax
typedef struct _NDIS_NIC_SWITCH_VPORT_PARAMETERS {
NDIS_OBJECT_HEADER Header;
ULONG Flags;
NDIS_NIC_SWITCH_ID SwitchId;
NDIS_NIC_SWITCH_VPORT_ID VPortId;
NDIS_VPORT_NAME VPortName;
NDIS_SRIOV_FUNCTION_ID AttachedFunctionId;
ULONG NumQueuePairs;
NDIS_NIC_SWITCH_VPORT_INTERRUPT_MODERATION InterruptModeration;
NDIS_NIC_SWITCH_VPORT_STATE VPortState;
GROUP_AFFINITY ProcessorAffinity;
ULONG LookaheadSize;
NDIS_NDK_PARAMETERS NdkParams;
NDIS_QOS_SQ_ID QosSqId;
} NDIS_NIC_SWITCH_VPORT_PARAMETERS, *PNDIS_NIC_SWITCH_VPORT_PARAMETERS;
Members
Header
The type, revision, and size of the NDIS_NIC_SWITCH_VPORT_PARAMETERS structure. This member is formatted as an NDIS_OBJECT_HEADER structure.
The miniport driver must set the Type member of Header to NDIS_OBJECT_TYPE_DEFAULT.
To indicate the version of the NDIS_NIC_SWITCH_VPORT_PARAMETERS structure, set the Revision member of Header to one of the following values:
NDIS_NIC_SWITCH_VPORT_PARAMETERS_REVISION_2
Added the QosSqId field for NDIS 6.50.
Set the Size member to NDIS_SIZEOF_NIC_SWITCH_VPORT_PARAMETERS_REVISION_2.
NDIS_NIC_SWITCH_VPORT_PARAMETERS_REVISION_1
Original version for NDIS 6.30 and later.
Set the Size member to NDIS_SIZEOF_NIC_SWITCH_VPORT_PARAMETERS_REVISION_1.
Flags
A ULONG value that contains a bitwise OR of flags. The following flags are defined for this member.
NDIS_NIC_SWITCH_VPORT_PARAMS_LOOKAHEAD_SPLIT_ENABLED
This flag is reserved for future use. Miniport drivers must ignore this flag.
NDIS_NIC_SWITCH_VPORT_PARAMS_FLAGS_CHANGED
This flag specifies that the Flags member has been updated after the VPort has been created. These flags can be enabled or disabled after the VPort has been created by using an OID set request of OID_NIC_SWITCH_VPORT_PARAMETERS.
Note
This flag is valid only when this structure is used in OID set requests of OID_NIC_SWITCH_VPORT_PARAMETERS.
NDIS_NIC_SWITCH_VPORT_PARAMS_NAME_CHANGED
This flag specifies that the VPortName member has been updated after the VPort has been created. This member can be updated by using an OID set request of OID_NIC_SWITCH_VPORT_PARAMETERS.
Note
This flag is valid only when this structure is used in OID set requests of OID_NIC_SWITCH_VPORT_PARAMETERS.
NDIS_NIC_SWITCH_VPORT_PARAMS_INT_MOD_CHANGED
This flag specifies that the InterruptModeration member has been updated after the VPort has been created. This member can be updated by using an OID set request of OID_NIC_SWITCH_VPORT_PARAMETERS.
Note
This flag is valid only when this structure is used in OID set requests of OID_NIC_SWITCH_VPORT_PARAMETERS.
NDIS_NIC_SWITCH_VPORT_PARAMS_STATE_CHANGED
This flag specifies that the VPortState member has been updated after the VPort has been created. This member can be updated by using an OID set request of OID_NIC_SWITCH_VPORT_PARAMETERS.
Note
This flag is valid only when this structure is used in OID set requests of OID_NIC_SWITCH_VPORT_PARAMETERS.
NDIS_NIC_SWITCH_VPORT_PARAMS_PROCESSOR_AFFINITY_CHANGED
This flag specifies that the ProcessoryAffinity member has been updated after the VPort has been created. The processor affinity of a VPort can only be updated if the VPort is attached to the PF on the network adapter. The ProcessoryAffinity member can be updated by using an OID set request of OID_NIC_SWITCH_VPORT_PARAMETERS.
Note
This flag is valid only when this structure is used in OID set requests of OID_NIC_SWITCH_VPORT_PARAMETERS.
NDIS_NIC_SWITCH_VPORT_PARAMS_NUM_QUEUE_PAIRS_CHANGED
This flag specifies that the NumQueuePairs member has been updated after the VPort has been created. When Virtual Machine Multiple Queues (VMMQ) is enabled, the number of queues for default and non-default Vports can be updated. The NumQueuePairs member can be updated by using an OID set request of OID_NIC_SWITCH_VPORT_PARAMETERS.
SwitchId
An NDIS_NIC_SWITCH_ID value that specifies the identifier of the switch on which the VPort is to be created.
The switch identifier is an integer between zero and the number of switches that the network adapter supports. An NDIS_DEFAULT_SWITCH_ID value indicates the default network adapter switch.
Note
Starting with Windows Server 2012, the single root I/O virtualization (SR-IOV) interface only supports the default network adapter switch on the network adapter. The value of this member must be set to NDIS_DEFAULT_SWITCH_ID.
VPortId
An NDIS_NIC_SWITCH_VPORT_ID value that specifies the identifier of a VPort on the network adapter. The value is allocated by NDIS, and is unique across the network adapter.
The VPortId value is within the range from zero to (NumVPorts - 1), where NumVPorts is the number of VPorts that the miniport driver has configured on the network adapter. The driver specifies this number in the NumVPorts member of the NDIS_NIC_SWITCH_INFO structure. The driver returns this structure through an OID query request of OID_NIC_SWITCH_ENUM_SWITCHES.
Note
A VPort identifier of NDIS_DEFAULT_VPORT_ID is reserved for the default VPort that is attached to the PF on the default NIC switch.
VPortName
An NDIS_VPORT_NAME value that specifies the name of the VPort. This member contains a user-friendly description of the VPort.
AttachedFunctionId
An NDIS_SRIOV_FUNCTION_ID value that specifies the ID of the Physical Function (PF) or Virtual Function (VF) that the VPort is attached to. A value of NDIS_PF_FUNCTION_ID specifies that the VPort is attached to the PF. If the value is a valid VF identifier, the VPort is attached to the VF.
NumQueuePairs
A ULONG value that specifies the number of queue pairs configured for this VPort.
A queue pair consists of a transmit queue and receive queue. Queue pairs associated with the default VPort are configured at the time of switch creation through an OID method request of OID_NIC_SWITCH_CREATE_SWITCH. One or more queue pairs are configured on a nondefault VPort through an OID method request of OID_NIC_SWITCH_CREATE_VPORT.
InterruptModeration
An NDIS_NIC_SWITCH_VPORT_INTERRUPT_MODERATION value that specifies the interrupt moderation setting of the VPort.
VPortState
An NDIS_NIC_SWITCH_VPORT_STATE value that specifies the current state of the VPort.
ProcessorAffinity
A GROUP_AFFINITY value that specifies the group number and a bitmap of the CPUs that this VPort is associated with. This field is valid only for VPorts that are attached to the PF.
Note
For nondefault PF VPorts, a GROUP_AFFINITY value that specifies only one processor must be specified when the VPort is created. VPorts are created through an OID method request of OID_NIC_SWITCH_CREATE_VPORT.
The processor affinity associated with the nondefault VPort attached to the PF can be changed after VPort creation. The processor affinity associated with the default VPort can also be changed by using an OID set request of OID_NIC_SWITCH_VPORT_PARAMETERS.
LookaheadSize
This member is reserved for future use. This member must be set to zero.
NdkParams
QosSqId
Associates a vPort with a Scheduler Queue (SQ). Set this field to a valid SQ ID to associate the vPort to an SQ. Set this field to zero if there is no SQ association. For more information on NDIS_QOS_SQ_ID, see OID_QOS_OFFLOAD_CREATE_SQ.
Remarks
This structure is used in OID requests of OID_NIC_SWITCH_CREATE_VPORT and OID_NIC_SWITCH_VPORT_PARAMETERS.
For more information about the SR-IOV interface, see Overview of Single Root I/O Virtualization (SR-IOV).
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Supported in NDIS 6.30 and later. |
| Minimum supported server | Windows Server 2022 |
| Header | ntddndis.h (include Ndis.h) |