OID_PNP_ENABLE_WAKE_UP (NDIS 5.x) (Compact 2013)
3/26/2014
This OID specifies which wake-up capabilities a miniport driver should enable in its network adapter. This OID can also be queried to determine which wake-up capabilities are enabled for a network adapter.
The InformationBuffer contains the following flags, which can be bitwise ORed together to enable a combination of wake-up events:
- NDIS_PNP_WAKE_UP_MAGIC_PACKET
When set, specifies that the miniport driver should enable the network adapter to signal a wake-up event 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.) When cleared, specifies that the miniport driver should disable the network adapter from signaling such a wake-up event.
- NDIS_PNP_WAKE_UP_PATTERN_MATCH
When set, specifies that the miniport driver should enable the network adapter to signal a wake-up event on receipt of a packet that contains a pattern specified by the protocol with OID_PNP_ADD_WAKE_UP_PATTERN. When cleared, specifies that the miniport driver should disable the network adapter from signaling such a wake-up event.
- NDIS_PNP_WAKE_UP_LINK_CHANGE
Reserved. NDIS ignores this flag.
After querying a miniport driver's wake-up capabilities with an OID_PNP_CAPABILITIES request, a protocol driver can use OID_PNP_ENABLE_WAKE_UP to enable one or more of the network adapter's wake-up capabilities. A protocol driver can also query this OID to determine which wake-up capabilities are enabled for a network adapter.
NDIS does not immediately enable the wake-up capabilities specified by a protocol. Instead, NDIS keeps track of the wake-up capabilities enabled by the protocol and, just before the miniport adapter transitions to a low-power state, sends an OID_PNP_ENABLE_WAKE_UP to the miniport driver to enable the appropriate wake-up events.
Before the miniport adapter transitions to a low-power state (that is, before NDIS sends the miniport driver an OID_PNP_SET_POWER request), NDIS sends the miniport driver an OID_PNP_ENABLE_WAKE_UP request to enable the appropriate wake-up capabilities.
The miniport driver must take the appropriate device-dependent steps to enable or disable wake-up events on the network adapter.
The miniport driver should clear the wake-up capabilities that NDIS set with OID_PNP_ENABLE_WAKE_UP when the system is resumed. The wake-up capabilities should not be persisted across resumes. If wake-up capabilities are enabled, NDIS explicitly sets OID_PNP_ENABLE_WAKE_UP before the miniport transitions to the low-power state.
An intermediate driver whose upper edge receives this OID request must always propagate the request to the underlying miniport driver by calling Ndis(Co)Request.
Requirements
Header |
ntddndis.h |