NET_ADAPTER_WAKE_PATTERN_FLAGS Enumeration

Warning

Some information in this topic relates to prereleased product, which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

NetAdapterCx is preview only in Windows 10, version 1903.

Specifies wake patterns that an adapter supports.

Syntax

typedef enum _NET_ADAPTER_WAKE_PATTERN_FLAGS {
  NET_ADAPTER_WAKE_BITMAP_PATTERN,
  NET_ADAPTER_WAKE_MAGIC_PACKET,
  NET_ADAPTER_WAKE_IPV4_TCP_SYN,
  NET_ADAPTER_WAKE_IPV6_TCP_SYN,
  NET_ADAPTER_WAKE_IPV4_DEST_ADDR_WILDCARD,
  NET_ADAPTER_WAKE_IPV6_DEST_ADDR_WILDCARD,
  NET_ADAPTER_WAKE_EAPOL_REQUEST_ID_MESSAGE
} NET_ADAPTER_WAKE_PATTERN_FLAGS;

Constants

NET_ADAPTER_WAKE_BITMAP_PATTERN If this flag is set, the network adapter is enabled to generate a wake-up event when it receives a packet that matches a configured bitmap pattern.
NET_ADAPTER_WAKE_MAGIC_PACKET If this flag is set, the network adapter is enabled to generate a wake-up event when it receives a WOL magic packet. A *magic packet* contains within its payload a string of six bytes with a value of 0xFF, followed immediately by 16 contiguous copies of the receiving network adapter's media access control (MAC) address.
NET_ADAPTER_WAKE_IPV4_TCP_SYN If this flag is set, the network adapter is enabled to generate a wake-up event when it receives an IPv4 TCP SYN packet. Remote hosts send TCP SYN packets to initiate a TCP connection to the local computer.
NET_ADAPTER_WAKE_IPV6_TCP_SYN If this flag is set, the network adapter is enabled to generate a wake-up event when it receives an IPv6 TCP SYN packet.
NET_ADAPTER_WAKE_IPV4_DEST_ADDR_WILDCARD If this flag is set, the network adapter must treat as wildcard values any zero-filled, or unspecified, values for IPv4 addresses and TCP/UDP ports in a WOL pattern. In this way, the wildcard value matches any IPv4 address and any port value of the incoming packet in the location specified by the WOL pattern.

If this flag is set, the network adapter is enabled to generate a wake-up event if the following pattern-matching conditions are true:

  • Any value from the incoming packet in the location specified by the WOL pattern is a match, if the WOL pattern for that location contains a wildcard value.
  • A value from the incoming packet in the location specified by the WOL pattern is a match if the WOL pattern for that location contains a nonzero value that equals the packet's value.

Note

Wildcard values that are enabled by this flag can include unspecified IPv4 source and destination addresses, as well as unspecified source and destination ports.

NET_ADAPTER_WAKE_IPV6_DEST_ADDR_WILDCARD If this flag is set, the network adapter must treat as wildcard values any zero-filled, or unspecified, values for IPv6 addresses and TCP/UDP ports in a WOL pattern. In this way, the wildcard value matches any IPv6 address and any port value of the incoming packet in the location specified by the WOL pattern.

If this flag is set, the network adapter is enabled to generate a wake-up event if the following pattern-matching conditions are true:

  • Any value from the incoming packet in the location specified by the WOL pattern is a match, if the WOL pattern for that location contains a wildcard value.
  • A value from the incoming packet in the location specified by the WOL pattern is a match if the WOL pattern for that location contains a nonzero value that equals the packet's value.

Note

Wildcard values that are enabled by this flag can include unspecified IPv6 source and destination addresses, as well as unspecified source and destination ports.

NET_ADAPTER_WAKE_EAPOL_REQUEST_ID_MESSAGE If this flag is set, the network adapter is enabled to generate a wake-up event when it receives an EAPOL request identifier message.

Remarks

The NET_ADAPTER_WAKE_PATTERN_FLAGS enumeration is used to specify supported statistics in the NET_ADAPTER_POWER_CAPABILITIES structure.

The client driver passes an initialized NET_ADAPTER_POWER_CAPABILITIES structure as an input parameter value to NetAdapterSetPowerCapabilities.

Requirements

   
Minimum KMDF version 1.21
Header netadapter.h

See Also

NDIS_PM_PARAMETERS