OID_PNP_ADD_WAKE_UP_PATTERN (Compact 2013)

  • Article

3/26/2014

A protocol driver sends this object to a miniport to specify a wake-up pattern. The wake-up pattern, together with its mask, is described by an NDIS_PM_PACKET_PATTERN structure.

A protocol that enables pattern-match wake-up for a miniport (see OID_PNP_ENABLE_WAKE_UP) uses OID_PNP_ADD_WAKE_UP_PATTERN to specify a wake-up pattern. The wake-up pattern can be stored in host memory or on the network adapter, depending on the capabilities of the network adapter.

The InformationBuffer of an associated NDIS_REQUEST structure contains the following:

  • An NDIS_PM_PACKET_PATTERN structure that provides information about the pattern and its mask.
  • A mask that indicates which bytes of an incoming packet should be compared with corresponding bytes in the pattern. The mask starts with the first byte of the packet, excluding token ring source routing information in a token ring packet. The mask immediately follows the NDIS_PM_PACKET_PATTERN structure in the InformationBuffer. For more information about how this mask works, see the Network Device Class Power Management Reference specification.
  • A wake-up pattern that begins PatternOffset bytes from the beginning of the InformationBuffer. For more information about wake-up patterns, see the Network Device Class Power Management Reference specification.

The number of wake-up patterns that the miniport can accept from a protocol may depend on the host memory that the miniport has allocated for such patterns or the available storage in the network adapter.

An intermediate driver whose upper edge receives this object request must always propagate the request to the underlying miniport by calling NdisRequest.

Requirements

Header

ntddndis.h

See Also

Reference

Operational OIDs
NDIS_REQUEST
NdisRequest
NDIS_PM_PACKET_PATTERN
OID_PNP_ENABLE_WAKE_UP
OID_PNP_REMOVE_WAKE_UP_PATTERN
OID_PNP_WAKE_UP_PATTERN_LIST