Share via

NDIS_OFFLOAD_PARAMETERS (Compact 2013)

  • Article

3/26/2014

This structure specifies the current task offload configuration settings in response to an OID_TCP_OFFLOAD_PARAMETERS OID set request.

Syntax

typedef struct _NDIS_OFFLOAD_PARAMETERS {
  NDIS_OBJECT_HEADER  Header;
  UCHAR  IPv4Checksum;
  UCHAR  TCPIPv4Checksum;
  UCHAR  UDPIPv4Checksum;
  UCHAR  TCPIPv6Checksum;
  UCHAR  UDPIPv6Checksum;
  UCHAR  LsoV1;
  UCHAR  IPsec;
  UCHAR  LsoV2IPv4;
  UCHAR  LsoV2IPv6;
  UCHAR  TcpConnectionIPv4;
  UCHAR  TcpConnectionIPv6;
  ULONG  Flags;

  UCHAR  IPsecV2IPv4;
  UCHAR  IPsecV2IPv6;
  UCHAR  Reserved1;
  UCHAR  Reserved2;

} NDIS_OFFLOAD_PARAMETERS, *PNDIS_OFFLOAD_PARAMETERS;

Members

  • Header
    The NDIS_OBJECT_HEADER structure for the NDIS_OFFLOAD_PARAMETERS structure. Set the Type member of the structure that Header specifies to NDIS_OBJECT_TYPE_DEFAULT.

    To indicate the version of the NDIS_OFFLOAD_PARAMETERS structure, set the Revision member to one of the following values:

    • NDIS_OFFLOAD_PARAMETERS_REVISION_2
      Added the IPsecV2IPv4, IPsecV2IPv6, Reserved1, and Reserved2 members.

      Set the Size member to NDIS_SIZEOF_OFFLOAD_PARAMETERS_REVISION_2.

    • NDIS_OFFLOAD_PARAMETERS_REVISION_1
      Original version.

      Set the Size member to NDIS_SIZEOF_OFFLOAD_PARAMETERS_REVISION_1.

  • IPv4Checksum
    The IPv4 checksum setting of the miniport adapter. For more information, see the following Remarks section.
  • TCPIPv4Checksum
    The IPv4 checksum setting of the miniport adapter for TCP packets. For more information, see the following Remarks section.
  • UDPIPv4Checksum
    The IPv4 checksum setting of the miniport adapter for UDP packets. For more information, see the following Remarks section.
  • TCPIPv6Checksum
    The IPv6 checksum setting of the miniport adapter for TCP packets. For more information, see the following Remarks section.
  • UDPIPv6Checksum
    The IPv6 checksum setting of the miniport adapter for UDP packets. For more information, see the following Remarks section.

  • LsoV1
    The large send offload version 1 (LSOV1) setting of the miniport adapter. This setting should be one of the following values:

    • NDIS_OFFLOAD_PARAMETERS_NO_CHANGE
      The miniport driver should not change the current setting.
    • NDIS_OFFLOAD_PARAMETERS_LSO_DISABLED
      LSOV1 is disabled.
    • NDIS_OFFLOAD_PARAMETERS_LSO_ENABLED
      LSOV1 is enabled.

  • IPsec
    The Internet protocol security (IPsec) offload setting of the miniport adapter. This setting should be one of the following values:

    • NDIS_OFFLOAD_PARAMETERS_NO_CHANGE
      The miniport driver should not change the current setting.
    • NDIS_OFFLOAD_PARAMETERS_IPSEC_DISABLED
      IPsec offload is disabled.
    • NDIS_OFFLOAD_PARAMETERS_IPSEC_AH_ENABLED
      The IPsec offload Authentication Header (AH) feature should be enabled for transmit and receive.
    • NDIS_OFFLOAD_PARAMETERS_IPSEC_ESP_ENABLED
      The IPsec offload Encapsulating Security Payload (ESP) feature should be enabled for transmit and receive.
    • NDIS_OFFLOAD_PARAMETERS_IPSEC_AH_AND_ESP_ENABLED
      The IPsec offload AH and ESP features areenabled for transmit and receive.

  • LsoV2IPv4
    The IPv4 large send offload version 2 (LSOV2) setting of the miniport adapter. This setting should be one of the following values:

    • NDIS_OFFLOAD_PARAMETERS_NO_CHANGE
      The miniport driver should not change the current setting.
    • NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED
      LSOV2 for IPv4 is disabled.
    • NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED
      LSOV2 for IPv4 is enabled.

  • LsoV2IPv6
    The IPv6 LSOV2 setting of the miniport adapter. These settings are specified as one of the following values:

    • NDIS_OFFLOAD_PARAMETERS_NO_CHANGE
      The miniport driver should not change the current setting.
    • NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED
      LSOV2 for IPv6 is disabled.
    • NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED
      LSOV2 for IPv6 is enabled.

  • TcpConnectionIPv4
    The IPv4 connection offload setting of the miniport adapter. These settings are specified as one of the following values:

    • NDIS_OFFLOAD_PARAMETERS_NO_CHANGE
      The miniport driver should not change the current setting.

  • TcpConnectionIPv6
    The IPv6 connection offload setting of the miniport adapter. These settings are specified as one of the following values:

    • NDIS_OFFLOAD_PARAMETERS_NO_CHANGE
      The miniport driver should not change the current setting.
  • Flags
    A set of flags that can be combined with a bitwise OR operation. Set this member to zero. There are currently no flags defined.

  • IPsecV2IPv4
    The Internet protocol security (IPsec) offload version 2 setting of the miniport adapter. This setting should be one of the following values:

    • NDIS_OFFLOAD_PARAMETERS_NO_CHANGE
      The miniport driver should not change the current setting.
    • NDIS_OFFLOAD_PARAMETERS_IPSEC_V2_DISABLED
      IPsec offload version 2 is disabled.
    • NDIS_OFFLOAD_PARAMETERS_IPSEC_V2_AH_ENABLED
      The IPsec offload version 2 Authentication Header (AH) feature should be enabled for transmit and receive.
    • NDIS_OFFLOAD_PARAMETERS_IPSEC_V2_ESP_ENABLED
      The IPsec offload version 2 Encapsulating Security Payload (ESP) feature should be enabled for transmit and receive.
    • NDIS_OFFLOAD_PARAMETERS_IPSEC_V2_AH_AND_ESP_ENABLED
      The IPsec offload version 2A H and ESP features are enabled for transmit and receive.

  • IPsecV2IPv6
    The Internet protocol security (IPsec) offload version 2 setting of the miniport adapter. This setting should be one of the following values:

    • NDIS_OFFLOAD_PARAMETERS_NO_CHANGE
      The miniport driver should not change the current setting.
    • NDIS_OFFLOAD_PARAMETERS_IPSEC_V2_DISABLED
      IPsec offload version 2 is disabled.
    • NDIS_OFFLOAD_PARAMETERS_IPSEC_V2_AH_ENABLED
      The IPsec offload version 2 Authentication Header (AH) feature should be enabled for transmit and receive.
    • NDIS_OFFLOAD_PARAMETERS_IPSEC_V2_ESP_ENABLED
      The IPsec offload version 2 Encapsulating Security Payload (ESP) feature should be enabled for transmit and receive.
    • NDIS_OFFLOAD_PARAMETERS_IPSEC_V2_AH_AND_ESP_ENABLED
      The IPsec offload version 2A H and ESP features are enabled for transmit and receive.
  • Reserved1
    Reserved for NDIS
  • Reserved2
    Reserved for NDIS.

Remarks

In response to an OID_TCP_OFFLOAD_PARAMETERS OID set request, a miniport driver uses the settings in the NDIS_OFFLOAD_PARAMETERS structure to set the current configuration of the miniport adapter.

NDIS keeps the requested settings in the registry in the offload standardized keywords. When NDIS restarts the miniport adapter, the miniport driver reads the offload standardized keywords and uses them to set the default offload configuration of the network adapter.

To access the checksum offload settings, use the following members of the NDIS_TCP_CONNECTION_OFFLOAD structure:

IPv4Checksum

TCPIPv4Checksum

UDPIPv4Checksum

TCPIPv6Checksum

UDPIPv6Checksum

The previous members can have one of the following values:

  • NDIS_OFFLOAD_PARAMETERS_NO_CHANGE
    The miniport driver should not change the current setting.
  • NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED
    The feature that the member specifies is disabled.
  • NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED
    The feature that the member specifies is enabled for transmit and disabled for receive.
  • NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED
    The feature that the member specifies is enabled for receive and disabled for transmit.
  • NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED
    The feature that the member specifies is enabled for transmit and receive.

Requirements

Header

ntddndis.h

See Also

Reference

NDIS TCP/IP Offload Structures
NDIS_OBJECT_HEADER
OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES
OID_TCP_OFFLOAD_PARAMETERS