NDIS_RECEIVE_QUEUE_PARAMETERS structure

The NDIS_RECEIVE_QUEUE_PARAMETERS structure contains the configuration parameters of a receive queue.

Syntax


typedef struct _NDIS_RECEIVE_QUEUE_PARAMETERS {
  NDIS_OBJECT_HEADER          Header;
  ULONG                       Flags;
  NDIS_RECEIVE_QUEUE_TYPE     QueueType;
  NDIS_RECEIVE_QUEUE_ID       QueueId;
  NDIS_RECEIVE_QUEUE_GROUP_ID QueueGroupId;
  GROUP_AFFINITY              ProcessorAffinity;
  ULONG                       NumSuggestedReceiveBuffers;
  ULONG                       MSIXTableEntry;
  ULONG                       LookaheadSize;
  NDIS_VM_NAME                VmName;
  NDIS_QUEUE_NAME             QueueName;
#if (NDIS_SUPPORT_NDIS630)
  ULONG                       PortId;
  ULONG                       InterruptCoalescingDomainId;
#endif 
} NDIS_RECEIVE_QUEUE_PARAMETERS, *PNDIS_RECEIVE_QUEUE_PARAMETERS;

Members

Header

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

NDIS_RECEIVE_QUEUE_PARAMETERS_REVISION_2

Added additional members for NDIS 6.30.

Set the Size member to NDIS_SIZEOF_RECEIVE_QUEUE_PARAMETERS_REVISION_2.

NDIS_RECEIVE_QUEUE_PARAMETERS_REVISION_1

Original version for NDIS 6.20.

Set the Size member to NDIS_SIZEOF_RECEIVE_QUEUE_PARAMETERS_REVISION_1.

Flags

A ULONG value that contains a bitwise OR of the following flags. The following flags are valid for the OID_RECEIVE_FILTER_ALLOCATE_QUEUE OID and the OID_RECEIVE_FILTER_QUEUE_PARAMETERS set and query OID:

NDIS_RECEIVE_QUEUE_PARAMETERS_PER_QUEUE_RECEIVE_INDICATION

The miniport driver must not mix network packets for other receive queues with the packets for this queue in a single call to the NdisMIndicateReceiveNetBufferLists function.

NDIS_RECEIVE_QUEUE_PARAMETERS_LOOKAHEAD_SPLIT_REQUIRED

The network adapter must split a received packet at an offset equal to or greater than the requested lookahead size and use DMA to transfer the lookahead data and the post-lookahead data to separate shared memory segments.

Note  Starting with NDIS 6.30, splitting packet data into separate lookahead buffers is no longer supported. Miniport drivers that support NDIS 6.30 or later versions must ignore this flag.
 

The following flags are valid for the OID_RECEIVE_FILTER_QUEUE_PARAMETERS set OID and NDIS_STATUS_RECEIVE_FILTER_QUEUE_PARAMETERS status indication:

NDIS_RECEIVE_QUEUE_PARAMETERS_FLAGS_CHANGED

The setting in the Flags member changed.

NDIS_RECEIVE_QUEUE_PARAMETERS_PROCESSOR_AFFINITY_CHANGED

The setting in the ProcessorAffinity member changed.

NDIS_RECEIVE_QUEUE_PARAMETERS_SUGGESTED_RECV_BUFFER_NUMBERS_CHANGED

The setting in the NumSuggestedReceiveBuffers member changed.

NDIS_RECEIVE_QUEUE_PARAMETERS_NAME_CHANGED

The setting in the QueueName member changed.

Note  A driver determines which receive queue parameters have been changed by executing a bitwise AND operation between the NDIS_RECEIVE_QUEUE_PARAMETERS_CHANGE_MASK definition and the value in the Flags member. If the result is zero, no receive queue parameters have been changed.
 
QueueType

An NDIS_RECEIVE_QUEUE_TYPE enumeration value that specifies the type of the receive queue.

QueueId

An NDIS_RECEIVE_QUEUE_ID type value that contains a receive queue identifier. This identifier is an integer value between zero and the number of queues that the network adapter supports. A value of NDIS_DEFAULT_RECEIVE_QUEUE_ID specifies the default receive queue.

QueueGroupId

This member is reserved for NDIS.

ProcessorAffinity

A GROUP_AFFINITY value that specifies the group number and a bitmap of the CPUs that this queue can be associated with. At least one processor must be specified. Therefore, the value must not be zero.

NumSuggestedReceiveBuffers

A ULONG value that contains a suggested value for the number of receive buffers that the network adapter should use to support the queue. This number can be adjusted relative to the resources that the miniport driver has available or in proportion to the number that the network adapter uses for other queues. For example, the actual number of receive buffers can be double or half of this suggested value.

MSIXTableEntry

This member is reserved for NDIS.

LookaheadSize

A ULONG value for the size, in bytes, of the lookahead size requirement for this queue. A network adapter that supports lookahead in VM queues splits a received packet at an offset equal to or greater than the requested lookahead size and uses DMA to transfer the lookahead data and the post-lookahead data to separate shared memory segments. If the LookaheadSize is zero, the miniport driver must not split the packet.

LookaheadSize is valid when NDIS sets the NDIS_RECEIVE_QUEUE_PARAMETERS_LOOKAHEAD_SPLIT_REQUIRED flag in the Flags member. That is, the miniport driver must split the packet at the specified lookahead size if the flag is also set. If the flag is clear, a nonzero value for LookaheadSize is invalid.

Note  Starting with NDIS 6.30, splitting packet data into separate lookahead buffers is no longer supported. The value of this member must be zero.
 
VmName

An NDIS_VM_NAME value that contains the description of the virtual machine that users read.

QueueName

An NDIS_QUEUE_NAME value that contains the description of the queue that users read.

PortId

A ULONG value that contains the unique identifier of a port on the Hyper-V extensible switch to which the VM queue is attached.

InterruptCoalescingDomainId

This member is reserved for NDIS.

Remarks

The NDIS_RECEIVE_QUEUE_PARAMETERS structure is used in the OID_RECEIVE_FILTER_ALLOCATE_QUEUE OID and the OID_RECEIVE_FILTER_QUEUE_PARAMETERS OID.

In NDIS 6.30, the NDIS_RECEIVE_QUEUE_PARAMETERS structure is also used in NDIS_STATUS_RECEIVE_FILTER_QUEUE_PARAMETERS status indications.

Requirements

Version

Supported in NDIS 6.20 and later.

Header

Ntddndis.h (include Ndis.h)

See also

NDIS_OBJECT_HEADER
NdisMIndicateReceiveNetBufferLists
OID_RECEIVE_FILTER_ALLOCATE_QUEUE
OID_RECEIVE_FILTER_QUEUE_PARAMETERS
NDIS_RECEIVE_QUEUE_TYPE
NDIS_STATUS_RECEIVE_FILTER_QUEUE_PARAMETERS

 

 

Send comments about this topic to Microsoft

Show: