NDIS_RESTART_GENERAL_ATTRIBUTES structure (ndis.h)

Article
04/12/2023

The NDIS_RESTART_GENERAL_ATTRIBUTES structure defines the general restart attributes that are associated with a miniport adapter.

Syntax

typedef struct _NDIS_RESTART_GENERAL_ATTRIBUTES {
  NDIS_OBJECT_HEADER               Header;
  ULONG                            MtuSize;
  ULONG64                          MaxXmitLinkSpeed;
  ULONG64                          MaxRcvLinkSpeed;
  ULONG                            LookaheadSize;
  ULONG                            MacOptions;
  ULONG                            SupportedPacketFilters;
  ULONG                            MaxMulticastListSize;
  PNDIS_RECEIVE_SCALE_CAPABILITIES RecvScaleCapabilities;
  NET_IF_ACCESS_TYPE               AccessType;
  ULONG                            Flags;
  NET_IF_CONNECTION_TYPE           ConnectionType;
  ULONG                            SupportedStatistics;
  ULONG                            DataBackFillSize;
  ULONG                            ContextBackFillSize;
  PNDIS_OID                        SupportedOidList;
  ULONG                            SupportedOidListLength;
  ULONG                            MaxLookaheadSizeAccessed;
} NDIS_RESTART_GENERAL_ATTRIBUTES, *PNDIS_RESTART_GENERAL_ATTRIBUTES;

Members

Header

The NDIS_OBJECT_HEADER structure for the NDIS_RESTART_GENERAL_ATTRIBUTES structure. NDIS sets the Type member of the structure that Header specifies to NDIS_OBJECT_TYPE_RESTART_GENERIC_ATTRIBUTES.

To indicate the version of the NDIS_RESTART_GENERAL_ATTRIBUTES structure, NDIS sets the Revision member to one of the following values:

NDIS_RESTART_GENERAL_ATTRIBUTES_REVISION_2

Added the MaxLookaheadSizeAccessed member for NDIS 6.2.

NDIS sets the Size member to NDIS_SIZEOF_RESTART_GENERAL_ATTRIBUTES_REVISION_2.

NDIS_RESTART_GENERAL_ATTRIBUTES_REVISION_1

Original version for NDIS 6.0 and NDIS 6.1.

NDIS sets the Size member to NDIS_SIZEOF_RESTART_GENERAL_ATTRIBUTES_REVISION_1.

MtuSize

The maximum transfer unit (MTU) size. For more information, see OID_GEN_MAXIMUM_FRAME_SIZE.

MaxXmitLinkSpeed

The maximum transmit link speed of the adapter in bits per second. For more information, see OID_GEN_MAX_LINK_SPEED.

MaxRcvLinkSpeed

The maximum receive link speed of the adapter in bits per second. For more information, see OID_GEN_MAX_LINK_SPEED.

LookaheadSize

The lookahead size for the miniport adapter. For more information, see OID_GEN_CURRENT_LOOKAHEAD.

MacOptions

The medium access control (MAC) options for the miniport adapter. For more information, see OID_GEN_MAC_OPTIONS.

SupportedPacketFilters

The packet filter flags for the miniport adapter.

MaxMulticastListSize

The maximum multicast address list size for the miniport adapter. For more information, see OID_802_3_MAXIMUM_LIST_SIZE.

RecvScaleCapabilities

The receive side scaling (RSS) capabilities of the NIC. If the miniport adapter does not support the RSS feature, NDIS sets RecvScaleCapabilities to a pointer to an NDIS_RECEIVE_SCALE_CAPABILITIES structure that is filled with zeros. For more information about RSS, see OID_GEN_RECEIVE_SCALE_CAPABILITIES.

AccessType

A NET_IF_ACCESS_TYPE NDIS network interface access type.

Flags

Reserved.

ConnectionType

A NET_IF_CONNECTION_TYPE NDIS network interface connection type.

SupportedStatistics

The supported statistics. For more information, see the SupportedStatistics member of the NDIS_MINIPORT_ADAPTER_GENERAL_ATTRIBUTES structure.

DataBackFillSize

The required data backfill size, in bytes, of the driver.

ContextBackFillSize

The required context backfill size, in bytes, of the driver.

SupportedOidList

A list of OIDs that the miniport driver supports. For more information, see OID_GEN_SUPPORTED_LIST.

SupportedOidListLength

The size, in bytes, of the OID list that is specified in the SupportedOidList member.

MaxLookaheadSizeAccessed

A ULONG value for the maximum size, in bytes, of the lookahead size requirement for receive queues. A miniport adapter that supports lookahead in VM queues splits a received packet at an offset equal to or greater than the requested lookahead size and DMAs the lookahead data and the post-lookahead data to separate shared memory segments.

Remarks

NDIS passes an NDIS_RESTART_GENERAL_ATTRIBUTES structure to drivers during restart operations. For example, when NDIS calls a miniport driver's MiniportRestart function, NDIS passes a pointer to an NDIS_RESTART_ATTRIBUTES structure to the miniport driver in the RestartAttributes member of the NDIS_MINIPORT_RESTART_PARAMETERS structure.

If the Oid member in the NDIS_RESTART_ATTRIBUTES structure is OID_GEN_MINIPORT_RESTART_ATTRIBUTES, the Data member of NDIS_RESTART_ATTRIBUTES contains an NDIS_RESTART_GENERAL_ATTRIBUTES structure.

Requirements

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