NDIS_PM_WAKE_UP_CAPABILITIES (Compact 2013)

  • Article

3/26/2014

This structure specifies the wake-up capabilities for a network adapter. This structure is used by NDIS_PNP_CAPABILITIES.

Syntax

typedef struct _NDIS_PM_WAKE_UP_CAPABILITIES {
  NDIS_DEVICE_POWER_STATE MinMagicPacketWakeUp;
  NDIS_DEVICE_POWER_STATE MinPatternWakeUp;
  NDIS_DEVICE_POWER_STATE MinLinkChangeWakeUp;
} NDIS_PM_WAKE_UP_CAPABILITIES, *PNDIS_PM_WAKE_UP_CAPABILITIES;

Members

  • MinMagicPacketWakeUp
    Specifies the lowest device power state from which the miniport's network adapter can signal a wake-up on receipt of a Magic Packet. (A Magic Packet is a packet that contains 16 contiguous copies of the receiving network adapter's Ethernet address.)

    The following table shows NDIS_DEVICE_POWER_STATE values that are defined for device power state:

    Value

    Description

    NdisDeviceStateUnspecified

    The network adapter does not support magic-packet wake-ups.

    NdisDeviceStateD0

    The network adapter can signal a magic-packet wake-up from device power state D0. Because D0 is the fully powered state, this does not cause a wake-up but can be used as a runtime event.

    NdisDeviceStateD1

    The network adapter can signal a magic-packet wake-up from device power states D1 and D0.

    NdisDeviceStateD2

    The network adapter can signal a magic-packet wake-up from device states D2, D1, and D0.

    NdisDeviceStateD3

    The network adapter can signal a magic-packet wake-up from device power states D3, D2, D1, and D0.

  • MinPatternWakeUp
    Specifies the lowest device power state from which the miniport's network adapter can signal a wake-up event on receipt of a network frame that contains a pattern specified by the protocol driver.

    The following table shows NDIS_DEVICE_POWER_STATE values that are defined for lowest device power state.

    Value

    Description

    NdisDeviceStateUnspecified

    The network adapter does not support pattern-match wake-ups.

    NdisDeviceStateD0

    The network adapter can signal a pattern-match wake-up from device power state D0. Because D0 is the fully powered state, this does not cause a wake-up but can be used as a runtime event.

    NdisDeviceStateD1

    The network adapter can signal a pattern-match wake-up from device power states D1 and D0.

    NdisDeviceStateD2

    The network adapter can signal a pattern-match wake-up from device power states D2, D1, and D0.

    NdisDeviceStateD3

    The network adapter can signal a pattern-match wake-up from device power states D3, D2, D1, and D0.

  • MinLinkChangeWakeUp
    Specifies the lowest device power state from which the miniport's network adapter can signal a wake-up event in response to a link change (the connection or disconnection of the network adapter's network cable).

    The following table shows the NDIS_DEVICE_POWER_STATE values that signal a wake-up event:

    Value

    Description

    NdisDeviceStateUnspecified

    The network adapter does not support link-change wake-ups.

    NdisDeviceStateD0

    The network adapter can signal a link-change wake-up from device power state D0. Because D0 is the fully powered state, this does not cause a wake-up but can be used as a runtime event.

    NdisDeviceStateD1

    The network adapter can signal a link-change wake-up from device power states D1 and D0.

    NdisDeviceStateD2

    The network adapter can signal a link-change wake-up from device power states D2, D1, and D0.

    NdisDeviceStateD3

    The network adapter can signal a link-change wake-up from device power states D3, D2, D1, and D0.

Remarks

If a miniport's network adapter does not support a particular wake-up event, the miniport should indicate an NDIS_DEVICE_POWER_STATE of NdisDeviceStateUnspecified for the wake-up event in the NDIS_PM_WAKE_UP_CAPABILITIES structure.

OID_PNP_CAPABILITIES only indicates the wake-up capabilities of a miniport's network adapter. It does not enable such capabilities. OID_PNP_ENABLE_WAKE_UP is used to enable a network adapter's wake-up capabilities.

Requirements

Header

ntddndis.h

See Also

Reference

NDIS 5.x Legacy Structures
NDIS_PNP_CAPABILITIES
OID_PNP_CAPABILITIES
OID_PNP_ENABLE_WAKE_UP
NDIS 5.x Legacy Reference