NDIS_NIC_SWITCH_VF_INFO structure (ntddndis.h)

The NDIS_NIC_SWITCH_VF_INFO structure specifies the information about a PCI Express (PCIe) Virtual Function (VF) that has been allocated on the network adapter.

Syntax

typedef struct _NDIS_NIC_SWITCH_VF_INFO {
  NDIS_OBJECT_HEADER     Header;
  ULONG                  Flags;
  NDIS_NIC_SWITCH_ID     SwitchId;
  NDIS_VM_NAME           VMName;
  NDIS_VM_FRIENDLYNAME   VMFriendlyName;
  NDIS_SWITCH_NIC_NAME   NicName;
  USHORT                 MacAddressLength;
  UCHAR                  PermanentMacAddress[NDIS_MAX_PHYS_ADDRESS_LENGTH];
  UCHAR                  CurrentMacAddress[NDIS_MAX_PHYS_ADDRESS_LENGTH];
  NDIS_SRIOV_FUNCTION_ID VFId;
  NDIS_VF_RID            RequestorId;
} NDIS_NIC_SWITCH_VF_INFO, *PNDIS_NIC_SWITCH_VF_INFO;

Members

Header

The type, revision, and size of the NDIS_NIC_SWITCH_VF_INFO 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 specify the version of the NDIS_NIC_SWITCH_VF_INFO structure, the driver must set the Revision member of Header to the following value:

NDIS_NIC_SWITCH_VF_INFO_REVISION_1

Original version for NDIS 6.30.

Set the Size member to NDIS_SIZEOF_NIC_SWITCH_VF_INFO_REVISION_1.

Flags

A ULONG value that contains a bitwise OR of flags. This member is reserved for NDIS.

SwitchId

An NDIS_NIC_SWITCH_ID value that specifies a switch identifier. 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.

VMName

An NDIS_VM_NAME value that specifies the name of the Hyper-V child partition that is attached to the VF. This member contains the user-friendly description of the partition.

VMFriendlyName

An NDIS_VM_FRIENDLYNAME value that specifies the external name of the Hyper-V child partition that is attached to the VF. This member contains the user-friendly description of the partition.

NicName

An NDIS_SWITCH_NIC_NAME value that specifies the name of the virtual machine (VM) network adapter. This member contains the user-friendly description of the network adapter.

The VM network adapter is a virtual device that is exposed in the guest operating system that runs in a Hyper-V child partition. The VM network adapter teams with the VF network adapter to provide the hardware-based VF data path over the SR-IOV interface.

For more information about the VF data path, see SR-IOV VF Data Path.

MacAddressLength

A USHORT value that specifies the length of the PermanentMacAddress and CurrentMacAddress members.

PermanentMacAddress[NDIS_MAX_PHYS_ADDRESS_LENGTH]

The permanent MAC address of the VF. This is the permanent MAC address for the VF network adapter that is exposed in the guest operating system.

CurrentMacAddress[NDIS_MAX_PHYS_ADDRESS_LENGTH]

The current MAC address of the VF. This is the current MAC address for the VF network adapter that is exposed in the guest operating system.

VFId

An NDIS_SRIOV_FUNCTION_ID value that specifies the unique identifier of the VF on the network adapter.

RequestorId

An NDIS_VF_RID that specifies the PCI Express (PCIe) Requestor ID (RID) of the VF.

Remarks

An NDIS_NIC_SWITCH_VF_INFO structure contains information about a VF that was previously created through an OID method request of OID_NIC_SWITCH_ALLOCATE_VF. When this OID request is issued, one or more NDIS_NIC_SWITCH_VF_INFO structures are returned within an NDIS_NIC_SWITCH_VF_INFO_ARRAY structure.

For more information about the SR-IOV interface, see Overview of Single Root I/O Virtualization (SR-IOV).

Requirements

See also

NDIS_NIC_SWITCH_VF_INFO_ARRAY

NDIS_OBJECT_HEADER

OID_NIC_SWITCH_ALLOCATE_VF