ReactOS 0.4.15-dev-7907-g95bf896
pnppriv.hpp
Go to the documentation of this file.
1/*++
2
3Copyright (c) Microsoft Corporation
4
5Module Name:
6
7 pnppriv.hpp
8
9Abstract:
10
11 This module implements the pnp package for the driver frameworks.
12
13Author:
14
15
16
17Environment:
18
19 Both kernel and user mode
20
21Revision History:
22
23
24
25--*/
26
27#ifndef _PNPPRIV_H_
28#define _PNPPRIV_H_
29
30#if ((FX_CORE_MODE)==(FX_CORE_USER_MODE))
31#define FX_IS_USER_MODE (TRUE)
32#define FX_IS_KERNEL_MODE (FALSE)
33#elif ((FX_CORE_MODE)==(FX_CORE_KERNEL_MODE))
34#define FX_IS_USER_MODE (FALSE)
35#define FX_IS_KERNEL_MODE (TRUE)
36#endif
37
38//
39// common header file for all irphandler\* files
40//
42
43//
44// public headers
45//
46#include "wdfdevice.h"
47#include "wdfchildlist.h"
48#include "wdfpdo.h"
49#include "wdffdo.h"
50#include "wdfqueryinterface.h"
51#include "wdfmemory.h"
52#include "wdfwmi.h"
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72#ifndef _INTERRUPT_COMMON_H_
73#include "wdfinterrupt.h"
74#endif
75#ifndef _WUDFDDI_TYPES_PRIVATE_H_
76#include "wdfrequest.h"
77#include "wdfio.h"
78#endif
79
80//
81// private headers
82//
83#include "fxwaitlock.hpp"
86#include "fxcollection.hpp"
87
88// support
89#include "stringutil.hpp"
90#include "fxstring.hpp"
91#include "fxdevicetext.hpp"
92#include "fxcallback.hpp"
93#include "fxsystemthread.hpp"
94#include "fxresource.hpp"
95
96// io
97#include "fxpkgioshared.hpp"
98
99//
100// FxDeviceInitShared.hpp is new header with definition of PdoInit split from
101// FxDeviceInit.hpp
102//
103#include "fxdeviceinitshared.hpp"
104
105// bus
106#include "fxchildlist.hpp"
107
108// FxDevice To Shared interface header
110
111// mode specific headers
112#if FX_IS_KERNEL_MODE
113#include "pnpprivkm.hpp"
114#elif FX_IS_USER_MODE
115#include "pnpprivum.hpp"
116#endif
117
118#include "fxspinlock.hpp"
119
120#if FX_IS_KERNEL_MODE
121#include "fxinterruptkm.hpp"
122#elif FX_IS_USER_MODE
123#include "fxinterruptum.hpp"
124#endif
125
126#if FX_IS_KERNEL_MODE
127#include "fxperftracekm.hpp"
128#endif
129
130#include "fxtelemetry.hpp"
131
132// pnp
133#include "fxrelateddevice.hpp"
134#include "fxdeviceinterface.hpp"
135#include "fxqueryinterface.hpp"
136#include "fxpnpcallbacks.hpp"
137#include "fxpackage.hpp"
138#include "fxpkgpnp.hpp"
139#include "fxwatchdog.hpp"
140#include "fxpkgpdo.hpp"
141#include "fxpkgfdo.hpp"
142
143// wmi
144#include "fxwmiirphandler.hpp"
145#include "fxwmiprovider.hpp"
146#include "fxwmiinstance.hpp"
147
148
149VOID
153 __inout FxIrp* ForwardIrp
154 );
155
156VOID
158 __in PPOWER_THREAD_INTERFACE PowerThreadInterface,
159 __in FxIrp* Irp
160 );
161
165 __in MxDeviceObject* RelatedDevice,
166 __in FxIrp* RelatedIrp,
167 __in MxWorkItem* Workitem,
169 __in BOOLEAN Revert
170 );
171
176 __in MxDeviceObject* DeviceInStack,
177 __in_opt PD3COLD_SUPPORT_INTERFACE D3ColdInterface,
179 );
180
181VOID
184 __in MxDeviceObject* DeviceInStack,
185 __in PD3COLD_SUPPORT_INTERFACE D3ColdInterface,
186 __in BOOLEAN UseD3Cold
187 );
188
189#define SET_TRI_STATE_FROM_STATE_BITS(state, S, FieldName) \
190{ \
191 switch (state & (FxPnpState##FieldName##Mask)) { \
192 case FxPnpState##FieldName##False : \
193 S->FieldName = WdfFalse; \
194 break; \
195 case FxPnpState##FieldName##True: \
196 S->FieldName = WdfTrue; \
197 break; \
198 case FxPnpState##FieldName##UseDefault : \
199 default: \
200 S->FieldName = WdfUseDefault; \
201 break; \
202 } \
203}
204
205LONG
206__inline
209 __in LONG TrueValue,
210 __in LONG UseDefaultValue
211 )
212{
213 switch (State) {
214 case WdfFalse: return 0x0;
215 case WdfTrue: return TrueValue;
216 case WdfUseDefault:
217 default: return UseDefaultValue;
218 }
219}
220
221#define GET_PNP_STATE_BITS_FROM_STRUCT(S, FieldName)\
222 FxGetValueBits(S->FieldName, \
223 FxPnpState##FieldName##True, \
224 FxPnpState##FieldName##UseDefault)
225
226#define GET_PNP_CAP_BITS_FROM_STRUCT(S, FieldName) \
227 FxGetValueBits(S->FieldName, \
228 FxPnpCap##FieldName##True, \
229 FxPnpCap##FieldName##UseDefault)
230
231#define GET_POWER_CAP_BITS_FROM_STRUCT(S, FieldName)\
232 FxGetValueBits(S->FieldName, \
233 FxPowerCap##FieldName##True, \
234 FxPowerCap##FieldName##UseDefault)
235
236__inline
237VOID
239 __in PNP_DEVICE_STATE* PnpDeviceState,
240 __in LONG ExternalState,
241 __in LONG InternalState,
242 __in LONG BitMask,
243 __in LONG TrueValue
244 )
245{
246 LONG bits;
247
248 bits = InternalState & BitMask;
249
250 if (bits == TrueValue) {
251 *PnpDeviceState |= ExternalState;
252 }
253 else if (bits == 0) { // 0 is the always false for every bit-set
254 *PnpDeviceState &= ~ExternalState;
255 }
256}
257
258#define SET_PNP_DEVICE_STATE_BIT(State, ExternalState, value, Name) \
259 FxSetPnpDeviceStateBit(State, \
260 ExternalState, \
261 state, \
262 FxPnpState##Name##Mask, \
263 FxPnpState##Name##True)
264
265#define SET_PNP_CAP_IF_TRUE(caps, pCaps, FieldName) \
266{ \
267 if ((caps & FxPnpCap##FieldName##Mask) == FxPnpCap##FieldName##True) { \
268 pCaps->FieldName = TRUE; \
269 } \
270}
271
272#define SET_PNP_CAP_IF_FALSE(caps, pCaps, FieldName) \
273{ \
274 if ((caps & FxPnpCap##FieldName##Mask) == FxPnpCap##FieldName##False) { \
275 pCaps->FieldName = FALSE; \
276 } \
277}
278
279#define SET_PNP_CAP(caps, pCaps, FieldName) \
280{ \
281 if ((caps & FxPnpCap##FieldName##Mask) == FxPnpCap##FieldName##False) { \
282 pCaps->FieldName = FALSE; \
283 } \
284 else if ((caps & FxPnpCap##FieldName##Mask) == FxPnpCap##FieldName##True) { \
285 pCaps->FieldName = TRUE; \
286 } \
287}
288
289#define SET_POWER_CAP(caps, pCaps, FieldName) \
290{ \
291 if ((caps & FxPowerCap##FieldName##Mask) == FxPowerCap##FieldName##False) { \
292 pCaps->FieldName = FALSE; \
293 } \
294 else if ((caps & FxPowerCap##FieldName##Mask) == FxPowerCap##FieldName##True) { \
295 pCaps->FieldName = TRUE; \
296 } \
297}
298
300PVOID
302 VOID
303 );
304
305
306
307
308
309
310
312 //
313 // Size of this structure in bytes
314 //
315 ULONG Size;
316
317 //
318 // Indicates whether the device can wake itself up while the machine is in
319 // S0.
320 //
322
323 //
324 // The low power state in which the device will be placed when it is idled
325 // out while the machine is in S0.
326 //
328
329 //
330 // Amount of time the device must be idle before idling out. Timeout is in
331 // milliseconds.
332 //
334
335 //
336 // Inidcates whether a user can control the idle policy of the device.
337 // By default, a user is allowed to change the policy.
338 //
340
341 //
342 // If WdfTrue, idling out while the machine is in S0 will be enabled.
343 //
344 // If WdfFalse, idling out will be disabled.
345 //
346 // If WdfUseDefault, the idling out will be enabled. If
347 // UserControlOfIdleSettings is set to IdleAllowUserControl, the user's
348 // settings will override the default.
349 //
351
353
355 //
356 // Size of this structure in bytes
357 //
358 ULONG Size;
359
360 //
361 // Indicates whether the device can wake itself up while the machine is in
362 // S0.
363 //
365
366 //
367 // The low power state in which the device will be placed when it is idled
368 // out while the machine is in S0.
369 //
371
372 //
373 // Amount of time the device must be idle before idling out. Timeout is in
374 // milliseconds.
375 //
377
378 //
379 // Inidcates whether a user can control the idle policy of the device.
380 // By default, a user is allowed to change the policy.
381 //
383
384 //
385 // If WdfTrue, idling out while the machine is in S0 will be enabled.
386 //
387 // If WdfFalse, idling out will be disabled.
388 //
389 // If WdfUseDefault, the idling out will be enabled. If
390 // UserControlOfIdleSettings is set to IdleAllowUserControl, the user's
391 // settings will override the default.
392 //
394
395 //
396 // This field is applicable only when IdleCaps == IdleCannotWakeFromS0
397 // If WdfTrue,device is powered up on System Wake even if device is idle
398 // If WdfFalse, device is not powered up on system wake if it is idle
399 // If WdfUseDefault, the behavior is same as WdfFalse
400 //
402
405
406typedef struct _WDF_PDO_EVENT_CALLBACKS_V1_9 {
407 //
408 // The size of this structure in bytes
409 //
410 ULONG Size;
411
412 //
413 // Called in response to IRP_MN_QUERY_RESOURCES
414 //
416
417 //
418 // Called in response to IRP_MN_QUERY_RESOURCE_REQUIREMENTS
419 //
421
422 //
423 // Called in response to IRP_MN_EJECT
424 //
426
427 //
428 // Called in response to IRP_MN_SET_LOCK
429 //
431
432 //
433 // Called in response to the power policy owner sending a wait wake to the
434 // PDO. Bus generic arming shoulding occur here.
435 //
437
438 //
439 // Called in response to the power policy owner sending a wait wake to the
440 // PDO. Bus generic disarming shoulding occur here.
441 //
443
445
446
447
448
449
450typedef struct _WDF_INTERRUPT_INFO_V1_7 {
451 //
452 // Size of this structure in bytes
453 //
454 ULONG Size;
455
457
459
461
463
465
466 KIRQL Irql;
467
469
471
473
474 // CM_SHARE_DISPOSITION
476
478
481
482#endif // _PNPPRIV_H_
unsigned char BOOLEAN
LONG NTSTATUS
Definition: precomp.h:26
Definition: fxirp.hpp:28
_In_ PTRANSFER_PACKET _In_ ULONG _In_ PIRP OriginalIrp
Definition: classp.h:1757
_In_ PIRP Irp
Definition: csq.h:116
#define __in
Definition: dbghelp.h:35
#define __inout
Definition: dbghelp.h:50
#define __in_opt
Definition: dbghelp.h:38
#define __out
Definition: dbghelp.h:62
ULONG_PTR KAFFINITY
Definition: compat.h:85
UCHAR KIRQL
Definition: env_spec_w32.h:591
DriverGlobals
GLenum GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * bits
Definition: glext.h:10929
_Must_inspect_result_ typedef _Out_ PHIDP_CAPS Capabilities
Definition: hidclass.h:103
#define bits
Definition: infblock.c:15
unsigned __int64 ULONG64
Definition: imports.h:198
#define _Must_inspect_result_
Definition: ms_sal.h:558
enum _DEVICE_POWER_STATE DEVICE_POWER_STATE
long LONG
Definition: pedump.c:60
struct _WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7 WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7
__inline VOID FxSetPnpDeviceStateBit(__in PNP_DEVICE_STATE *PnpDeviceState, __in LONG ExternalState, __in LONG InternalState, __in LONG BitMask, __in LONG TrueValue)
Definition: pnppriv.hpp:238
VOID PnpPassThroughQIWorker(__in MxDeviceObject *Device, __inout FxIrp *Irp, __inout FxIrp *ForwardIrp)
Definition: fxpkgpnpkm.cpp:498
struct _WDF_INTERRUPT_INFO_V1_7 WDF_INTERRUPT_INFO_V1_7
struct _WDF_PDO_EVENT_CALLBACKS_V1_9 WDF_PDO_EVENT_CALLBACKS_V1_9
LONG __inline FxGetValueBits(__in WDF_TRI_STATE State, __in LONG TrueValue, __in LONG UseDefaultValue)
Definition: pnppriv.hpp:207
struct _WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9 WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9
const struct _WDF_INTERRUPT_INFO_V1_7 * PCWDF_INTERRUPT_INFO_V1_7
Definition: pnppriv.hpp:480
_Must_inspect_result_ NTSTATUS SendDeviceUsageNotification(__in MxDeviceObject *RelatedDevice, __in FxIrp *RelatedIrp, __in MxWorkItem *Workitem, __in FxIrp *OriginalIrp, __in BOOLEAN Revert)
_Must_inspect_result_ NTSTATUS GetStackCapabilities(__in PFX_DRIVER_GLOBALS DriverGlobals, __in MxDeviceObject *DeviceInStack, __in_opt PD3COLD_SUPPORT_INTERFACE D3ColdInterface, __out PSTACK_DEVICE_CAPABILITIES Capabilities)
Definition: supportkm.cpp:48
VOID CopyQueryInterfaceToIrpStack(__in PPOWER_THREAD_INTERFACE PowerThreadInterface, __in FxIrp *Irp)
Definition: supportkm.cpp:32
VOID SetD3ColdSupport(__in PFX_DRIVER_GLOBALS DriverGlobals, __in MxDeviceObject *DeviceInStack, __in PD3COLD_SUPPORT_INTERFACE D3ColdInterface, __in BOOLEAN UseD3Cold)
Definition: supportkm.cpp:172
struct _WDF_PDO_EVENT_CALLBACKS_V1_9 * PWDF_PDO_EVENT_CALLBACKS_V1_9
struct _WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7 * PWDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7
struct _WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9 * PWDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9
struct _WDF_INTERRUPT_INFO_V1_7 * PWDF_INTERRUPT_INFO_V1_7
Definition: pnppriv.hpp:479
enum _KINTERRUPT_MODE KINTERRUPT_MODE
WDF_POWER_POLICY_S0_IDLE_CAPABILITIES IdleCaps
Definition: wdf17.h:658
WDF_POWER_POLICY_S0_IDLE_USER_CONTROL UserControlOfIdleSettings
Definition: wdf17.h:676
WDF_POWER_POLICY_S0_IDLE_CAPABILITIES IdleCaps
Definition: wdf19.h:769
WDF_POWER_POLICY_S0_IDLE_USER_CONTROL UserControlOfIdleSettings
Definition: wdf19.h:787
WDF_INTERRUPT_POLARITY Polarity
Definition: wdf17.h:1100
KINTERRUPT_MODE Mode
Definition: wdf17.h:1098
KAFFINITY TargetProcessorSet
Definition: wdf17.h:1088
PFN_WDF_DEVICE_EJECT EvtDeviceEject
Definition: wdf19.h:1595
PFN_WDF_DEVICE_DISABLE_WAKE_AT_BUS EvtDeviceDisableWakeAtBus
Definition: wdf19.h:1612
PFN_WDF_DEVICE_SET_LOCK EvtDeviceSetLock
Definition: wdf19.h:1600
PFN_WDF_DEVICE_RESOURCES_QUERY EvtDeviceResourcesQuery
Definition: wdf19.h:1585
PFN_WDF_DEVICE_ENABLE_WAKE_AT_BUS EvtDeviceEnableWakeAtBus
Definition: wdf19.h:1606
PFN_WDF_DEVICE_RESOURCE_REQUIREMENTS_QUERY EvtDeviceResourceRequirementsQuery
Definition: wdf19.h:1590
PVOID GetIoMgrObjectForWorkItemAllocation(VOID)
Definition: supportum.cpp:98
uint32_t ULONG
Definition: typedefs.h:59
_Must_inspect_result_ _In_ WDFDEVICE Device
Definition: wdfchildlist.h:474
enum _WDF_POWER_POLICY_S0_IDLE_USER_CONTROL WDF_POWER_POLICY_S0_IDLE_USER_CONTROL
enum _WDF_POWER_POLICY_S0_IDLE_CAPABILITIES WDF_POWER_POLICY_S0_IDLE_CAPABILITIES
WDF_EXTERN_C_START enum _WDF_INTERRUPT_POLARITY WDF_INTERRUPT_POLARITY
EVT_WDF_DEVICE_SET_LOCK * PFN_WDF_DEVICE_SET_LOCK
Definition: wdfpdo.h:108
EVT_WDF_DEVICE_DISABLE_WAKE_AT_BUS * PFN_WDF_DEVICE_DISABLE_WAKE_AT_BUS
Definition: wdfpdo.h:136
EVT_WDF_DEVICE_RESOURCES_QUERY * PFN_WDF_DEVICE_RESOURCES_QUERY
Definition: wdfpdo.h:65
EVT_WDF_DEVICE_RESOURCE_REQUIREMENTS_QUERY * PFN_WDF_DEVICE_RESOURCE_REQUIREMENTS_QUERY
Definition: wdfpdo.h:80
EVT_WDF_DEVICE_EJECT * PFN_WDF_DEVICE_EJECT
Definition: wdfpdo.h:93
EVT_WDF_DEVICE_ENABLE_WAKE_AT_BUS * PFN_WDF_DEVICE_ENABLE_WAKE_AT_BUS
Definition: wdfpdo.h:123
@ WdfTrue
Definition: wdftypes.h:88
@ WdfUseDefault
Definition: wdftypes.h:89
@ WdfFalse
Definition: wdftypes.h:87
enum _WDF_TRI_STATE WDF_TRI_STATE
ULONG PNP_DEVICE_STATE
Definition: iotypes.h:997
unsigned char UCHAR
Definition: xmlstorage.h:181