NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS structure (ntddndis.h)

Article
07/22/2022

The NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS structure specifies the receive filtering features that are enabled or disabled on a network adapter.

NDIS receive filters are used in the following NDIS interfaces:

NDIS Packet Coalescing. For more information about how to use receive filters in this interface, see Managing Packet Coalescing Receive Filters.
Single Root I/O Virtualization (SR-IOV). For more information about how to use receive filters in this interface, see Setting a Receive Filter on a Virtual Port.
Virtual Machine Queue (VMQ). For more information about how to use receive filters in this interface, see Setting and Clearing VMQ Filters.

Syntax

typedef struct _NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS {
  NDIS_OBJECT_HEADER Header;
  ULONG              Flags;
  ULONG              EnabledFilterTypes;
  ULONG              EnabledQueueTypes;
} NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS, *PNDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS;

Members

Header

The NDIS_OBJECT_HEADER structure for the NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS structure. The driver sets the Type member of the structure that Header specifies to NDIS_OBJECT_TYPE_DEFAULT.

To indicate the version of the NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS structure, the driver sets the Revision member to one of the following values:

NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS_REVISION_1

Original version for NDIS 6.20.

The driver sets the Size member to NDIS_SIZEOF_RECEIVE_FILTER_GLOBAL_PARAMETERS_REVISION_1.

Flags

A bitwise OR of flags. This member is reserved for NDIS.

EnabledFilterTypes

A bitwise OR of flags for types of enabled receive filters. The following filter type flag is valid.

NDIS_RECEIVE_FILTER_VMQ_FILTERS_ENABLED

Specifies that VMQ filters are enabled.

Note The miniport driver should set this flag if the miniport driver is enabled to use the SR-IOV interface. For more information on how these interfaces are enabled, see Handling SR-IOV, VMQ, and RSS Standardized INF Keywords.

NDIS_RECEIVE_FILTER_PACKET_COALESCING_FILTERS_ENABLED

Specifies that NDIS packet coalescing receive filters are enabled.

EnabledQueueTypes

A bitwise OR of flags for types of enabled receive queues. The following queue type flag is valid.

NDIS_RECEIVE_FILTER_VM_QUEUES_ENABLED

Specifies that virtual machine (VM) queues are enabled. VM queues are used in the VMQ and SR-IOV interface.

Remarks

The NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS structure is used in the OID_RECEIVE_FILTER_GLOBAL_PARAMETERS query OID to obtain the current global receive filter settings.

Note Many of the members and flag settings of the NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS structure are valid if the miniport driver is enabled to use the VMQ or SR-IOV interface. The miniport driver is enabled to use these interfaces through standardized INF keywords. For more information, see Handling SR-IOV, VMQ, and RSS Standardized INF Keywords.

Requirements

Requirement	Value
Minimum supported client	Supported in NDIS 6.20 and later.
Header	ntddndis.h (include Ndis.h)