Sample Code

Windows Driver Samples/ KMDF Power Framework (PoFx) Sample/ C++/ Driver/ MultiComp/ lib/ init.c/

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
/*++
 
Copyright (c) Microsoft Corporation.  All rights reserved.
 
    THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
    KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR
    PURPOSE.
 
Module Name:
 
    init.c
 
Abstract:
    This module contains routines that are used to initialize the power
    framework helper library
 
Environment:
 
    Kernel mode
 
--*/
 
#include "WdfPoFxPriv.h"
#include "init.tmh"
 
#ifdef ALLOC_PRAGMA
#pragma alloc_text(PAGE, GetDeviceInitSettings)
#pragma alloc_text(PAGE, PfhInitializerCreate)
#pragma alloc_text(PAGE, CopyAndUpdateMinorFunctionsArray)
#pragma alloc_text(PAGE, PfhAssignWdmPowerIrpPreProcessCallback)
#pragma alloc_text(PAGE, PfhInterceptWdfPnpPowerEventCallbacks)
#pragma alloc_text(PAGE, PfhSetPoHandleAvailabilityCallbacks)
#pragma alloc_text(PAGE, CopyMinorFunctionsArray)
#pragma alloc_text(PAGE, PfhInitializeDeviceSettings)
#pragma alloc_text(PAGE, PfhInitializePowerFrameworkSettings)
#endif
 
PHELPER_DEVICE_INIT
GetDeviceInitSettings(
    _In_ WDFOBJECT Initializer
    )
/*++
Routine description:
    This routine gets a pointer to the location in the initializer object's
    context space where we store the driver layer's device object settings.
 
Arguments:
    Initializer - Handle to the initializer object that is being used to
        initialize our device object settings.
 
Return value:
    Pointer to a HELPER_DEVICE_INIT structure where the driver layer's device
    object settings are stored.
--*/
{
    PHELPER_INIT initContext = NULL;
 
    PAGED_CODE();
 
    initContext = HelperGetInitContext(Initializer);
 
    if ((initContext->InitType != HelperInitTypeNone) &&
        (initContext->InitType != HelperInitTypeDevice)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Cannot get device initialization settings for "
              "initializer object %p because it is currently being used to "
              "initialize a different object.",
              Initializer);
        WdfVerifierDbgBreakPoint();
        return NULL;
    }
 
    if (initContext->InitType == HelperInitTypeNone) {
        initContext->InitType = HelperInitTypeDevice;
    }
 
    return &(initContext->u.DeviceInit);
}
 
PHELPER_QUEUE_INIT
GetQueueInitSettings(
    _In_ WDFOBJECT Initializer
    )
/*++
Routine description:
    This routine gets a pointer to the location in the initializer object's
    context space where we store the driver layer's queue object settings.
 
Arguments:
    Initializer - Handle to the initializer object that is being used to
        initialize our queue object settings.
 
Return value:
    Pointer to a HELPER_QUEUE_INIT structure where the driver layer's queue
    object settings are stored.
--*/
{
    PHELPER_INIT initContext = NULL;
     
    initContext = HelperGetInitContext(Initializer);
 
    if ((initContext->InitType != HelperInitTypeNone) &&
        (initContext->InitType != HelperInitTypeQueue)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Cannot get queue initialization settings for "
              "initializer object %p because it is currently being used to "
              "initialize a different object.",
              Initializer);
        WdfVerifierDbgBreakPoint();
        return NULL;
    }
 
    if (initContext->InitType == HelperInitTypeNone) {
        initContext->InitType = HelperInitTypeQueue;
    }
 
    return &(initContext->u.QueueInit);
}
 
BOOLEAN
IsDeviceInitialized(
    _In_ WDFDEVICE Device
    )
/*++
Routine description:
    This routine determines whether we have initialized our settings for the
    given device object.
 
Arguments:
    Device - Handle to the KMDF device object
 
Return value:
    TRUE if we have initialized our settings for the device object, FALSE
    otherwise.
--*/
{
    PPOFX_DEVICE_CONTEXT devCtx;
    devCtx = HelperGetDeviceContext(Device);
    return (NULL != devCtx);
}
 
BOOLEAN
ArePowerFrameworkSettingsAvailable(
    _In_ WDFDEVICE Device
    )
/*++
Routine description:
    This routine determines whether the driver layer has provided us with its
    power framework settings for the given device object.
 
Arguments:
    Device - Handle to the KMDF device object
 
Return value:
    TRUE if we the driver layer has provided us with its power framework
    settings for the device object, FALSE otherwise.
--*/
{
    PPOFX_DEVICE_CONTEXT devCtx;
    devCtx = HelperGetDeviceContext(Device);
    return ((NULL != devCtx) && (NULL != devCtx->PoFxDeviceInfo));
}
 
BOOLEAN
IsQueueInitialized(
    _In_ WDFQUEUE Queue
    )
/*++
Routine description:
    This routine determines whether we have initialized our settings for the
    given queue object.
 
Arguments:
    Queue - Handle to the KMDF queue object
 
Return value:
    TRUE if we have initialized our settings for the queue object, FALSE
    otherwise.
--*/
{
    PPOFX_QUEUE_CONTEXT qCtx;
    qCtx = HelperGetQueueContext(Queue);
    return (NULL != qCtx);
}
 
VOID
ResetInitializer(
    _In_ WDFOBJECT Initializer
    )
/*++
Routine description:
    This routine prepares the given initializer object for initializing a new
    KMDF object.
 
Arguments:
    Initializer - Handle to the initializer object
 
Return value:
    None
--*/
{
    PHELPER_INIT initContext = NULL;
     
    //
    // We want to make sure that when the initializer context is zeroed, the
    // default S0-idle power management configuration for the device is
    // PfhS0IdleNotSupported.
    //
    C_ASSERT(0 == PfhS0IdleNotSupported);
     
    //
    // Reset the initializer context
    //
    initContext = HelperGetInitContext(Initializer);
    RtlZeroMemory(initContext, sizeof(*initContext));
    initContext->InitType = HelperInitTypeNone;
 
    return;
}
 
_IRQL_requires_max_(PASSIVE_LEVEL)
NTSTATUS
PfhInitializerCreate(
    _Out_ WDFOBJECT * Initializer
    )
// See comments in WdfPoFx.h
{
    NTSTATUS status;
    WDFOBJECT initializer = NULL;
    WDF_OBJECT_ATTRIBUTES objectAttributes;
 
    PAGED_CODE();
     
    //
    // Create an initializer object
    //
    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&objectAttributes, HELPER_INIT);
    status = WdfObjectCreate(&objectAttributes, &initializer);
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - WdfObjectCreate failed with %!status!.",
              status);
        goto exit;
    }
 
    //
    // Initialize context
    //
    ResetInitializer(initializer);
 
    *Initializer = initializer;
 
    status = STATUS_SUCCESS;
     
exit:
    return status;
}
 
NTSTATUS
CopyAndUpdateMinorFunctionsArray(
    _In_ WDFOBJECT Initializer,
    _In_reads_opt_(NumMinorFunctions) PUCHAR MinorFunctions,
    _In_ ULONG NumMinorFunctions,
    _Out_ WDFMEMORY * MinorFunctionsMemory,
    _Outptr_result_buffer_(*UpdatedNumMinorFunctions) PUCHAR *UpdatedMinorFunctions,
    _Out_ PULONG UpdatedNumMinorFunctions
    )
/*++
Routine description:
    This routine takes an array of power IRP minor functions and makes a copy of
    it. If the input array does not include IRP_MN_SET_POWER as one of the minor
    functions, the copy of the array made by this routine is expanded to include
    IRP_MN_SET_POWER too. This enables us to register a WDM pre-process callback
    for IRP_MN_SET_POWER, regardless of whether the driver layer is interested
    in that minor function.
 
Arguments:
    Initializer - Handle to the initializer object
 
    MinorFunctions - Caller-initialized array of minor functions that the driver
        layer is interested in for the IRP_MJ_POWER major function.
 
    NumMinorFunctions - The number of minor functions in the MinorFunctions
        array
 
    MinorFunctionsMemory - Pointer to a location that receives a handle to the
        memory object created by this routine to store a copy of the minor
        functions
 
    UpdatedMinorFunctions - Pointer to a location that receives an array of
        minor functions that the driver layer is interested in, plus
        IRP_MN_SET_POWER if it was not present in the original array
 
    UpdatedNumMinorFunctions - Pointer to a location that receives the number of
        minor functions in the UpdatedMinorFunctions array
 
Return value:
    An NTSTATUS value representing success or failure of the function.
--*/
{
    NTSTATUS status;
    BOOLEAN driverLayerPreprocessesSetPower = FALSE;
    UCHAR setPowerMinorFunction;
    ULONG i;
    ULONG driverLayerMinorFunctions = 0;
    ULONG extraMinorFunctions = 0;
    ULONG totalMinorFunctions = 0;
    ULONG totalMinorFunctionsSize = 0;
    ULONG memorySize = 0;
    WDF_OBJECT_ATTRIBUTES objectAttributes;
    WDFMEMORY memory = NULL;
    PPOFX_DRIVER_LAYER_POWER_IRP_PREPROCESS_INFO memoryBuffer = NULL;
    ULONG minorFunctionsOffset;
    ULONG minorFunctionsSize;
    ULONG extraMinorFunctionOffset;
 
    PAGED_CODE();
 
    //
    // Check if the driver layer needs to preprocess IRP_MN_SET_POWER
    //
    if ((NULL != MinorFunctions) && (0 != NumMinorFunctions)) {
     
        driverLayerMinorFunctions = NumMinorFunctions;
         
        for (i=0; i < NumMinorFunctions; i++) {
            if (IRP_MN_SET_POWER == MinorFunctions[i]) {
                driverLayerPreprocessesSetPower = TRUE;
                break;
            }
        }
    }
 
    //
    // If the driver layer does not preprocess IRP_MN_SET_POWER, then we need to
    // update the minor functions array with an extra entry for IRP_MN_SET_POWER
    //
    extraMinorFunctions = driverLayerPreprocessesSetPower ? 0 : 1;
 
    //
    // Allocate memory to store a copy of the minor functions array
    //
    status = RtlULongAdd(driverLayerMinorFunctions,
                         extraMinorFunctions,
                         &totalMinorFunctions);
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to compute total minor functions count for "
              "power IRP preprocessing. RtlUlongAdd failed with %!status!.",
              status);
        goto exit;
    }
 
    ASSERT(totalMinorFunctions > 0);
 
    status = RtlULongMult(sizeof(MinorFunctions[0]),
                          totalMinorFunctions,
                          &totalMinorFunctionsSize);
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to compute buffer size needed to store the "
              "functions array. RtlULongMult failed with %!status!.",
              status);
        goto exit;
    }
    status = RtlULongAdd(sizeof(POFX_DRIVER_LAYER_POWER_IRP_PREPROCESS_INFO),
                         totalMinorFunctionsSize,
                         &memorySize);
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to compute buffer size needed to store the "
              "minor functions array and count. RtlUlongAdd failed with "
              "%!status!.",
              status);
        goto exit;
    }
    if (0 == memorySize) {
        status = STATUS_INVALID_BUFFER_SIZE;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to set memorySize. Failed with %!status!.",
              status);
        goto exit;
    }
    WDF_OBJECT_ATTRIBUTES_INIT(&objectAttributes);
    objectAttributes.ParentObject = Initializer; // auto-delete when parent
                                                 // deleted
    #pragma prefast(suppress:28160, "memorySize > 0")
    status = WdfMemoryCreate(&objectAttributes,
                             NonPagedPool,
                             0, // PoolTag
                             memorySize,
                             &memory,
                             (PVOID*) &memoryBuffer);
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to allocate memory to store the minor functions"
              " array and count. WdfMemoryCreate failed with %!status!.",
              status);
        goto exit;
    }
 
    //
    // We'll remember only the minor functions that the driver layer is
    // interested in. If we add IRP_MN_SET_POWER to that list, we won't need to
    // remember that beyond initialization time.
    //
    memoryBuffer->NumMinorFunctions = driverLayerMinorFunctions;
 
    //
    // Copy the minor functions array
    //
    minorFunctionsOffset =
      FIELD_OFFSET(POFX_DRIVER_LAYER_POWER_IRP_PREPROCESS_INFO, MinorFunctions);
    minorFunctionsSize = driverLayerMinorFunctions *
                                sizeof(MinorFunctions[0]); // already performed
                                                           // intsafe math above
                                                           // won't overflow
    if (driverLayerMinorFunctions > 0) {
        if (0 == minorFunctionsSize) {
            status = STATUS_INVALID_BUFFER_SIZE;
            Trace(TRACE_LEVEL_ERROR,
                  "%!FUNC! - Unable to set minorFunctionsSize. Failed with %!status!.",
                  status);
            goto exit;
        }
        #pragma prefast(suppress:28160, "minorFunctionsSize > 0")
        status = WdfMemoryCopyFromBuffer(memory,
                                         minorFunctionsOffset,
                                         memoryBuffer->MinorFunctions,
                                         minorFunctionsSize);
        if (FALSE == NT_SUCCESS(status)) {
            Trace(TRACE_LEVEL_ERROR,
                  "%!FUNC! - Unable to copy driver layer's minor functions "
                  "array. WdfMemoryCopyFromBuffer failed with %!status!.",
                  status);
            goto exit;
        }
    }
 
    if (extraMinorFunctions > 0) {
 
        ASSERT(extraMinorFunctions == 1);
         
        //
        // Add an extra minor function for IRP_MN_SET_POWER since it was not in
        // the driver layer's list.
        // NOTE: This minor function is added at the end and is not reflected in
        // memoryBuffer.NumMinorFunctions.
        //
        extraMinorFunctionOffset =
          minorFunctionsOffset + minorFunctionsSize;// already performed intsafe
                                                    // math above so this won't
                                                    // overflow
        setPowerMinorFunction = IRP_MN_SET_POWER;
        status = WdfMemoryCopyFromBuffer(memory,
                                         extraMinorFunctionOffset,
                                         &setPowerMinorFunction,
                                         sizeof(setPowerMinorFunction));
        if (FALSE == NT_SUCCESS(status)) {
            Trace(TRACE_LEVEL_ERROR,
                  "%!FUNC! - Unable to add an extra minor function "
                  "(IRP_MN_SET_POWER) to the minor functions array. "
                  "WdfMemoryCopyFromBuffer failed with %!status!.",
                  status);
            goto exit;
        }
    }
 
    *MinorFunctionsMemory = memory;
    *UpdatedMinorFunctions = memoryBuffer->MinorFunctions;
    *UpdatedNumMinorFunctions =
               totalMinorFunctions;// Do not use memoryBuffer.NumMinorFunctions
                                   // here because it does not include the extra
                                   // minor function that we might have added.
 
    //
    // If we added an extra minor function, it is present in the buffer but not
    // reflected in memoryBuffer.NumMinorFunctions
    //
    ASSERT((memoryBuffer->NumMinorFunctions + extraMinorFunctions) ==
                totalMinorFunctions);
 
    status = STATUS_SUCCESS;
 
exit:
    if (FALSE == NT_SUCCESS(status)) {
        if (NULL != memory) {
            WdfObjectDelete(memory);
        }
    }
 
    return status;
}
 
_IRQL_requires_max_(PASSIVE_LEVEL)
NTSTATUS
PfhAssignWdmPowerIrpPreProcessCallback(
    _In_ WDFOBJECT Initializer,
    _In_  PWDFDEVICE_INIT DeviceInit,
    _In_opt_ PFN_WDFDEVICE_WDM_IRP_PREPROCESS EvtDeviceWdmPowerIrpPreprocess,
    _In_reads_opt_(NumMinorFunctions) PUCHAR MinorFunctions,
    _In_ ULONG NumMinorFunctions
    )
// See comments in WdfPoFx.h
{
    NTSTATUS status;
    WDFMEMORY minorFunctionsMemory = NULL;
    ULONG numMinorFunctions = 0;
    PUCHAR minorFunctions = NULL;
    PHELPER_DEVICE_INIT deviceInitSettings = NULL;
 
    PAGED_CODE();
 
    deviceInitSettings = GetDeviceInitSettings(Initializer);
 
    if (deviceInitSettings->PowerIrpPreprocessCallbackAssigned) {
        status = STATUS_INVALID_DEVICE_REQUEST;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhAssignWdmPowerIrpPreProcessCallback has already"
              " been called on initialier %p.  It should not be called again "
              "before the initializer has been used to initialize a KMDF device"
              " object. %!status!.",
              Initializer,
              status);
        WdfVerifierDbgBreakPoint();
        goto exit;
    }
     
    //
    // Copy the minor functions array and, if needed, update it to include
    // IRP_MN_SET_POWER.
    //
    status = CopyAndUpdateMinorFunctionsArray(Initializer,
                                              MinorFunctions,
                                              NumMinorFunctions,
                                              &minorFunctionsMemory,
                                              &minorFunctions,
                                              &numMinorFunctions);
    if (FALSE == NT_SUCCESS(status)) {
        goto exit;
    }
 
    //
    // Assign the WDM preprocess callback
    //
    status = WdfDeviceInitAssignWdmIrpPreprocessCallback(
                DeviceInit,
                _PfhEvtWdmPowerIrpPreprocess,
                IRP_MJ_POWER,
                minorFunctions,
                numMinorFunctions
                );
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - WdfDeviceInitAssignWdmIrpPreprocessCallback failed "
              "with %!status!.",
              status);
        goto exit;
    }
 
    deviceInitSettings->PowerIrpPreprocessMinorFunctions = minorFunctionsMemory;
    deviceInitSettings->EvtDeviceWdmPowerIrpPreprocess =
                                EvtDeviceWdmPowerIrpPreprocess;
    deviceInitSettings->PowerIrpPreprocessCallbackAssigned = TRUE;
                                 
    status = STATUS_SUCCESS;
     
exit:
    if (FALSE == NT_SUCCESS(status)) {
        if (NULL != minorFunctionsMemory) {
            WdfObjectDelete(minorFunctionsMemory);
        }
    }
    return status;
}
 
_IRQL_requires_max_(PASSIVE_LEVEL)
VOID
PfhInterceptWdfPnpPowerEventCallbacks(
    _In_ WDFOBJECT Initializer,
    _Inout_ PWDF_PNPPOWER_EVENT_CALLBACKS DriverLayerPnpPowerCallbacks
    )
// See comments in WdfPoFx.h
{
    PHELPER_DEVICE_INIT deviceInitSettings = NULL;
 
    PAGED_CODE();
 
    deviceInitSettings = GetDeviceInitSettings(Initializer);
 
    if (deviceInitSettings->PnpPowerEventCallbacksIntercepted) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhInterceptWdfPnpPowerEventCallbacks has already been"
              " called on initialier %p.  It should not be called again before "
              "the initializer has been used to initialize a KMDF device "
              "object.",
              Initializer);
        WdfVerifierDbgBreakPoint();
    }
     
    //
    // Save the driver layer's callbacks that we are going to replace
    //
    deviceInitSettings->EvtDeviceSelfManagedIoInit =
                    DriverLayerPnpPowerCallbacks->EvtDeviceSelfManagedIoInit;
    deviceInitSettings->EvtDeviceSelfManagedIoFlush =
                    DriverLayerPnpPowerCallbacks->EvtDeviceSelfManagedIoFlush;
    deviceInitSettings->EvtDeviceSelfManagedIoRestart =
                    DriverLayerPnpPowerCallbacks->EvtDeviceSelfManagedIoRestart;
    deviceInitSettings->EvtDeviceD0Entry =
                    DriverLayerPnpPowerCallbacks->EvtDeviceD0Entry;
 
    //
    // Replace the driver layer's callbacks with our own
    //
    DriverLayerPnpPowerCallbacks->EvtDeviceSelfManagedIoInit =
                                        _PfhEvtSelfManagedIoInit;
    DriverLayerPnpPowerCallbacks->EvtDeviceSelfManagedIoFlush =
                                        _PfhEvtSelfManagedIoFlush;
    DriverLayerPnpPowerCallbacks->EvtDeviceSelfManagedIoRestart =
                                        _PfhEvtSelfManagedIoRestart;
    DriverLayerPnpPowerCallbacks->EvtDeviceD0Entry =
                                        _PfhEvtD0Entry;
 
    deviceInitSettings->PnpPowerEventCallbacksIntercepted = TRUE;
     
    return;
}
     
_IRQL_requires_max_(PASSIVE_LEVEL)
VOID
PfhSetPoHandleAvailabilityCallbacks(
    _In_ WDFOBJECT Initializer,
    _In_ PPFH_CALLBACK_POHANDLE_AVAILABLE PfhCallbackPoHandleAvailable,
    _In_ PPFH_CALLBACK_POHANDLE_UNAVAILABLE PfhCallbackPoHandleUnavailable
    )
// See comments in WdfPoFx.h
{
    PHELPER_DEVICE_INIT deviceInitSettings = NULL;
 
    PAGED_CODE();
 
    deviceInitSettings = GetDeviceInitSettings(Initializer);
 
    if (deviceInitSettings->PoHandleAvailabilityCallbacksSet) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhSetPoHandleAvailabilityCallbacks has already been "
              "called on initialier %p.  It should not be called again before "
              "the initializer has been used to initialize a KMDF device "
              "object.",
              Initializer);
        WdfVerifierDbgBreakPoint();
    }
 
    //
    // Save the driver layer's callbacks
    //
    deviceInitSettings->PfhCallbackPoHandleAvailable =
                                PfhCallbackPoHandleAvailable;
    deviceInitSettings->PfhCallbackPoHandleUnavailable =
                                PfhCallbackPoHandleUnavailable;
 
    deviceInitSettings->PoHandleAvailabilityCallbacksSet = TRUE;
    return;
}
 
NTSTATUS
CopyMinorFunctionsArray(
    _In_ WDFDEVICE Device,
    _In_ WDFMEMORY SourceMemory,
    _Out_ WDFMEMORY * DestinationMemory
    )
/*++
Routine description:
    This routine creates a new memory object to store the array of power IRP
    minor functions that the driver layer is interested in. The array is
    currently stored in a memory object that we had created as a child of the
    initializer object that was being used to initialize the device object. Now
    that the initialization of the device object is about to complete, we need
    to make a copy of the contents of that memory object. Once the device object
    initialization is complete, the driver layer is free to delete the
    initializer object, which will result in the original memory object also
    getting delete. That is why we copy the contents to a new memory object.
 
Arguments:
    Device - Handle to the KMDF device object
 
    SourceMemory - Handle to the memory object that contains the array of power
        IRP minor functions that the driver layer is interested in
 
    DestinationMemory - Pointer to a location that receives a handle to a new
        memory object created by this routine. The new memory object contains a
        copy of the a
 
Return value:
    An NTSTATUS value representing success or failure of the function.
--*/
{
    NTSTATUS status;
    PPOFX_DRIVER_LAYER_POWER_IRP_PREPROCESS_INFO powerIrpPreprocessInfo = NULL;
    size_t powerIrpPreprocessInfoSize;
    WDF_OBJECT_ATTRIBUTES objectAttributes;
    WDFMEMORY memory = NULL;
 
    PAGED_CODE();
 
    //
    // Get the source memory buffer
    //
    powerIrpPreprocessInfo = WdfMemoryGetBuffer(SourceMemory,
                                                &powerIrpPreprocessInfoSize);
    if (0 == powerIrpPreprocessInfoSize) {
        status = STATUS_INVALID_BUFFER_SIZE;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to get powerIrpPreprocessInfoSize. Failed with %!status!.",
              status);
        goto exit;
    }
                                                 
    //
    // Create a new memory object to hold a copy of the buffer
    //
    WDF_OBJECT_ATTRIBUTES_INIT(&objectAttributes);
    objectAttributes.ParentObject = Device; // auto-delete when parent deleted
    status = WdfMemoryCreate(&objectAttributes,
                             NonPagedPool,
                             0, // PoolTag
                             powerIrpPreprocessInfoSize,
                             &memory,
                             NULL // Buffer
                             );
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to allocate memory for the driver layer's minor"
              " functions array. WdfMemoryCreate failed with %!status!.",
              status);
        goto exit;
    }
 
    //
    // Copy the buffer into the new memory object
    //
    status = WdfMemoryCopyFromBuffer(memory,
                                     0, // DestinationOffset
                                     powerIrpPreprocessInfo,
                                     powerIrpPreprocessInfoSize);
    if (FALSE == NT_SUCCESS(status)) {
        goto exit;
    }
 
    *DestinationMemory = memory;
 
    status = STATUS_SUCCESS;
     
exit:
    return status;
}
 
_IRQL_requires_max_(PASSIVE_LEVEL)
NTSTATUS
PfhInitializeDeviceSettings(
    _In_ WDFDEVICE Device,
    _In_ WDFOBJECT Initializer
    )
// See comments in WdfPoFx.h
{
    NTSTATUS status;
    WDF_OBJECT_ATTRIBUTES objectAttributes;
    PPOFX_DEVICE_CONTEXT devCtx;
    PHELPER_DEVICE_INIT deviceInitSettings = NULL;
    WDFMEMORY memory = NULL;
 
    PAGED_CODE();
 
    deviceInitSettings = GetDeviceInitSettings(Initializer);
 
    if (IsDeviceInitialized(Device)) {
        status = STATUS_INVALID_DEVICE_REQUEST;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhInitializeDeviceSettings has already been called "
              "for WDFDEVICE %p. It should not be called again. %!status!.",
              Device,
              status);
        WdfVerifierDbgBreakPoint();
        goto exit;
    }
 
    if (FALSE == deviceInitSettings->PowerIrpPreprocessCallbackAssigned) {
        status = STATUS_INVALID_DEVICE_REQUEST;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhAssignWdmPowerIrpPreProcessCallback has not yet "
              "been called for WDFDEVICE %p. %!status!.",
              Device,
              status);
        WdfVerifierDbgBreakPoint();
        goto exit;
    }
 
    if (FALSE == deviceInitSettings->PnpPowerEventCallbacksIntercepted) {
        status = STATUS_INVALID_DEVICE_REQUEST;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhInterceptWdfPnpPowerEventCallbacks has not yet been"
              " called for WDFDEVICE %p. %!status!.",
              Device,
              status);
        WdfVerifierDbgBreakPoint();
        goto exit;
    }
 
    //
    // Allocate our context for this device
    //
    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&objectAttributes,
                                            POFX_DEVICE_CONTEXT);
    status = WdfObjectAllocateContext((WDFOBJECT) Device,
                                      &objectAttributes,
                                      (PVOID*) &devCtx);
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - WdfObjectAllocateContext failed with %!status!",
              status);
        goto exit;
    }
 
    //
    // Copy the device init settings
    //
    devCtx->DeviceInitSettings = *deviceInitSettings;
 
    //
    // Copy the minor functions array into a new memory object that is a child
    // of the device object. The array is currently in a memory object that is
    // a child of the initializer object. The initializer object can be deleted
    // by the driver layer any time after initialization is complete, so we need
    // to make a copy now.
    //
    status = CopyMinorFunctionsArray(
                Device,
                devCtx->DeviceInitSettings.PowerIrpPreprocessMinorFunctions,
                &memory
                );
    if (FALSE == NT_SUCCESS(status)) {
        goto exit;
    }
 
    //
    // Perform initialization specific to S0-idle support (if enabled)
    //
    INITIALIZE_DEVICE_SETTINGS_FOR_S0_IDLE(Device, devCtx);
     
    //
    // In our device context, replace the pointer to the initializer's memory
    // object with a pointer to the new memory object that we just created.
    //
    devCtx->DeviceInitSettings.PowerIrpPreprocessMinorFunctions = memory;
 
    //
    // For convenient access, also save the memory object's buffer in our device
    // context.
    //
    devCtx->DriverLayerPowerIrpPreprocessInfo = WdfMemoryGetBuffer(
                                                            memory,
                                                            NULL // BufferSize
                                                            );
 
    //
    // By default, we do not need to call PoFxReportDevicePoweredOn from our
    // EvtDeviceD0Entry callback. We only need to call it in the
    // EvtDeviceD0Entry callback that is invoked right after we receive an S0
    // IRP.
    //
    devCtx->ShouldReportDevicePoweredOn = FALSE;
 
    //
    // The initializer can now be used to initialize some other object
    //
    ResetInitializer(Initializer);
 
    status = STATUS_SUCCESS;
 
exit:
    return status;
}
 
_IRQL_requires_max_(PASSIVE_LEVEL)
NTSTATUS
PfhInitializePowerFrameworkSettings(
    _In_ WDFDEVICE Device,
    _In_ PPO_FX_DEVICE PoFxDeviceInfo
    )
// See comments in WdfPoFx.h
{
    NTSTATUS status;
    WDF_OBJECT_ATTRIBUTES objectAttributes;
    PPOFX_DEVICE_CONTEXT devCtx;
    ULONG i;
    ULONG pofxExtraComponentsSize;
    ULONG pofxDeviceInfoSize;
    WDFMEMORY memory = NULL;
    ULONG idleStatesSize;
    PVOID idleStates = NULL;
    PPO_FX_DEVICE poFxDeviceInfo = NULL;
    PPOFX_COMPONENT_INFO componentInfo = NULL;
    ULONG componentInfoSize;
 
    PAGED_CODE();
 
    if (FALSE == IsDeviceInitialized(Device)) {
        status = STATUS_INVALID_DEVICE_REQUEST;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhInitializeDeviceSettings has not yet been called "
              "for WDFDEVICE %p. %!status!.",
              Device,
              status);
        WdfVerifierDbgBreakPoint();
        goto exit;
    }
 
    if (ArePowerFrameworkSettingsAvailable(Device)) {
        status = STATUS_INVALID_DEVICE_REQUEST;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhInitializePowerFrameworkSettings has already been "
              "called for WDFDEVICE %p. It should not be called again. "
              "%!status!.",
              Device,
              status);
        WdfVerifierDbgBreakPoint();
        goto exit;
    }
     
    //
    // Get the device context
    //
    devCtx = HelperGetDeviceContext(Device);
 
    //
    // Allocate memory to store power framework settings
    //
    status = RtlULongMult(sizeof(PO_FX_COMPONENT),
                          (PoFxDeviceInfo->ComponentCount - 1),
                          &pofxExtraComponentsSize);
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to compute buffer size needed for extra "
              "components. RtlULongMult failed with %!status!.",
              status);
        goto exit;
    }
    status = RtlULongAdd(sizeof(PO_FX_DEVICE),
                         pofxExtraComponentsSize,
                         &pofxDeviceInfoSize);
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to compute buffer size needed for power "
              "framework settings. RtlUlongAdd failed with %!status!.",
              status);
        goto exit;
    }
    if (0 == pofxDeviceInfoSize) {
        status = STATUS_INVALID_BUFFER_SIZE;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to set pofxDeviceInfoSize. Failed with %!status!.",
              status);
        goto exit;
    }
     
    WDF_OBJECT_ATTRIBUTES_INIT(&objectAttributes);
    objectAttributes.ParentObject = Device; // auto-delete when parent deleted
    status = WdfMemoryCreate(&objectAttributes,
                             NonPagedPool,
                             0, // PoolTag
                             pofxDeviceInfoSize,
                             &memory,
                             (PVOID*) &poFxDeviceInfo);
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to allocate memory for power framework "
              "settings. WdfMemoryCreate failed with %!status!.",
              status);
        goto exit;
    }
 
    devCtx->PoFxDeviceInfo = poFxDeviceInfo;
     
    //
    // Copy power framework settings
    //
    status = WdfMemoryCopyFromBuffer(memory,
                                     0, // DestinationOffset
                                     PoFxDeviceInfo,
                                     pofxDeviceInfoSize);
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to copy power framework settings. "
              "WdfMemoryCopyFromBuffer failed with %!status!.",
              status);
        goto exit;
    }
                              
    //
    // Save the driver layer's callbacks and replace them with our own
    //
    devCtx->DriverLayerPoFxCallbacks.ComponentIdleStateCallback =
                 devCtx->PoFxDeviceInfo->ComponentIdleStateCallback;
    devCtx->DriverLayerPoFxCallbacks.ComponentActiveConditionCallback =
                 devCtx->PoFxDeviceInfo->ComponentActiveConditionCallback;
    devCtx->DriverLayerPoFxCallbacks.ComponentIdleConditionCallback =
                 devCtx->PoFxDeviceInfo->ComponentIdleConditionCallback;
    devCtx->DriverLayerPoFxCallbacks.DevicePowerRequiredCallback =
                 devCtx->PoFxDeviceInfo->DevicePowerRequiredCallback;
    devCtx->DriverLayerPoFxCallbacks.DevicePowerNotRequiredCallback =
                 devCtx->PoFxDeviceInfo->DevicePowerNotRequiredCallback;
    devCtx->PoFxDeviceInfo->ComponentIdleStateCallback =
                             _PfhComponentIdleStateCallback;
    devCtx->PoFxDeviceInfo->ComponentActiveConditionCallback =
                             _PfhComponentActiveConditionCallback;
    devCtx->PoFxDeviceInfo->ComponentIdleConditionCallback =
                             _PfhComponentIdleConditionCallback;
    devCtx->PoFxDeviceInfo->DevicePowerRequiredCallback =
                             _PfhDevicePowerRequiredCallback;
    devCtx->PoFxDeviceInfo->DevicePowerNotRequiredCallback =
                             _PfhDevicePowerNotRequiredCallback;
 
    //
    // Save the driver layer's context and replace it with our own
    //
    devCtx->DriverLayerPoFxContext = devCtx->PoFxDeviceInfo->DeviceContext;
    devCtx->PoFxDeviceInfo->DeviceContext = (PVOID) Device;
 
    //
    // Store the idle states for each component
    //
    for (i=0; i < devCtx->PoFxDeviceInfo->ComponentCount; i++) {
         
        status = RtlULongMult(sizeof(PO_FX_COMPONENT_IDLE_STATE),
                              PoFxDeviceInfo->Components[i].IdleStateCount,
                              &idleStatesSize);
        if (FALSE == NT_SUCCESS(status)) {
            Trace(TRACE_LEVEL_ERROR,
                  "%!FUNC! - Unable to compute buffer size needed for idle "
                  "states for component %d. RtlUlongMult failed with "
                  "%!status!.",
                  i,
                  status);
            goto exit;
        }
        if (0 == idleStatesSize) {
            status = STATUS_INVALID_BUFFER_SIZE;
            Trace(TRACE_LEVEL_ERROR,
                  "%!FUNC! - Unable to set idleStatesSize. Failed with %!status!.",
                  status);
            goto exit;
        }
 
        WDF_OBJECT_ATTRIBUTES_INIT(&objectAttributes);
        objectAttributes.ParentObject = Device;//auto-delete when parent deleted
        status = WdfMemoryCreate(&objectAttributes,
                                 NonPagedPool,
                                 0, // PoolTag
                                 idleStatesSize,
                                 &memory,
                                 &idleStates);
        if (FALSE == NT_SUCCESS(status)) {
            Trace(TRACE_LEVEL_ERROR,
                  "%!FUNC! - Unable to allocate memory for idle states for "
                  "component %d. WdfMemoryCreate failed with %!status!.",
                  i,
                  status);
            goto exit;
        }
 
        status = WdfMemoryCopyFromBuffer(
                            memory,
                            0, // DestinationOffset
                            devCtx->PoFxDeviceInfo->Components[i].IdleStates,
                            idleStatesSize
                            );
        if (FALSE == NT_SUCCESS(status)) {
            Trace(TRACE_LEVEL_ERROR,
                  "%!FUNC! - Unable to copy idle states for component %d. "
                  "WdfMemoryCopyFromBuffer failed with %!status!.",
                  i,
                  status);
            goto exit;
        }
        devCtx->PoFxDeviceInfo->Components[i].IdleStates = idleStates;
    }
 
    //
    // Allocate memory to store our private, per-component information
    //
    status = RtlULongMult(sizeof(POFX_COMPONENT_INFO),
                          devCtx->PoFxDeviceInfo->ComponentCount,
                          &componentInfoSize);
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to compute buffer size needed for storing "
              "private, per-component information. RtlULongMult failed with "
              "%!status!.",
              status);
        goto exit;
    }
    if (0 == componentInfoSize) {
        status = STATUS_INVALID_BUFFER_SIZE;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to set componentInfoSize. Failed with %!status!.",
              status);
        goto exit;
    }
     
    WDF_OBJECT_ATTRIBUTES_INIT(&objectAttributes);
    objectAttributes.ParentObject = Device; // auto-delete when parent deleted
    status = WdfMemoryCreate(&objectAttributes,
                             NonPagedPool,
                             0, // PoolTag
                             componentInfoSize,
                             &memory,
                             (PVOID*) &componentInfo);
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Unable to allocate memory for storing private, per-"
              "component information. WdfMemoryCreate failed with %!status!.",
              status);
        goto exit;
    }
    RtlZeroMemory(componentInfo, componentInfoSize);
    devCtx->ComponentInfo = componentInfo;
 
    status = STATUS_SUCCESS;
 
exit:
    return status;
}
 
_IRQL_requires_max_(DISPATCH_LEVEL)
VOID
PfhInterceptComponentQueueConfig(
    _In_ WDFOBJECT Initializer,
    _Inout_ PWDF_IO_QUEUE_CONFIG DriverLayerQueueConfig
    )
// See comments in WdfPoFx.h
{
    PHELPER_QUEUE_INIT queueInitSettings = NULL;
 
    queueInitSettings = GetQueueInitSettings(Initializer);
 
    if (queueInitSettings->ComponentQueueConfigIntercepted) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhInterceptComponentQueueConfig has already been "
              "called on initialier %p.  It should not be called again before "
              "the initializer has been used to initialize a KMDF queue "
              "object.",
              Initializer);
        WdfVerifierDbgBreakPoint();
    }
 
    //
    // Save the driver layer's callbacks that we are going to replace
    //
    queueInitSettings->EvtIoCanceledOnQueue =
                            DriverLayerQueueConfig->EvtIoCanceledOnQueue;
 
    //
    // Replace the driver layer's callbacks with our own
    //
    DriverLayerQueueConfig->EvtIoCanceledOnQueue =
                            _PfhEvtRequestCanceledOnComponentQueue;
 
    queueInitSettings->ComponentQueueConfigIntercepted = TRUE;                           
                             
    return;
}
 
_IRQL_requires_max_(DISPATCH_LEVEL)
VOID
PfhSetComponentForComponentQueue(
    _In_ WDFOBJECT Initializer,
    _In_ ULONG Component
    )
// See comments in WdfPoFx.h
{
    PHELPER_QUEUE_INIT queueInitSettings = NULL;
 
    queueInitSettings = GetQueueInitSettings(Initializer);
 
    if (queueInitSettings->ComponentSet) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhSetComponentForComponentQueue has already been "
              "called on initialier %p.  It should not be called again before "
              "the initializer has been used to initialize a KMDF queue "
              "object.",
              Initializer);
        WdfVerifierDbgBreakPoint();
    }
 
    queueInitSettings->Component = Component;
     
    queueInitSettings->ComponentSet = TRUE;                           
 
    return;
}
 
_IRQL_requires_max_(DISPATCH_LEVEL)
NTSTATUS
PfhInitializeComponentQueueSettings(
    _In_ WDFQUEUE Queue,
    _In_ WDFOBJECT Initializer
    )
// See comments in WdfPoFx.h
{
    NTSTATUS status;
    WDFDEVICE device = NULL;
    ULONG component;
    WDF_OBJECT_ATTRIBUTES objectAttributes;
    PPOFX_DEVICE_CONTEXT devCtx;
    PPOFX_QUEUE_CONTEXT qCtx;
    PHELPER_QUEUE_INIT queueInitSettings = NULL;
 
    queueInitSettings = GetQueueInitSettings(Initializer);
 
    if (IsQueueInitialized(Queue)) {
        status = STATUS_INVALID_DEVICE_REQUEST;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhInitializeComponentQueueSettings has already been "
              "called for WDFQUEUE %p. It should not be called again. "
              "%!status!.",
              Queue,
              status);
        WdfVerifierDbgBreakPoint();
        goto exit;
    }
 
    device = WdfIoQueueGetDevice(Queue);
    if (FALSE == ArePowerFrameworkSettingsAvailable(device)) {
        status = STATUS_INVALID_DEVICE_REQUEST;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhInitializePowerFrameworkSettings has not yet been "
              "called for WDFDEVICE %p. %!status!.",
              device,
              status);
        WdfVerifierDbgBreakPoint();
        goto exit;
    }
 
    if (FALSE == queueInitSettings->ComponentQueueConfigIntercepted) {
        status = STATUS_INVALID_DEVICE_REQUEST;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhInterceptComponentQueueConfig has not yet been "
              "called for WDFQUEUE %p. %!status!.",
              Queue,
              status);
        WdfVerifierDbgBreakPoint();
        goto exit;
    }
 
    if (FALSE == queueInitSettings->ComponentSet) {
        status = STATUS_INVALID_DEVICE_REQUEST;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - PfhSetComponentForComponentQueue has not yet been "
              "called for WDFQUEUE %p. %!status!.",
              Queue,
              status);
        WdfVerifierDbgBreakPoint();
        goto exit;
    }
 
    //
    // Get the device context
    //
    devCtx = HelperGetDeviceContext(device);
     
    //
    // Validate the component number
    //
    component = queueInitSettings->Component;
    if (component >= devCtx->PoFxDeviceInfo->ComponentCount) {
        status = STATUS_INVALID_PARAMETER;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Component number %d is invalid. Component count is %d."
              " %!status!.",
              component,
              devCtx->PoFxDeviceInfo->ComponentCount,
              status);
        WdfVerifierDbgBreakPoint();
        goto exit;
    }
 
    //
    // Allocate our context for this queue
    //
    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&objectAttributes,
                                            POFX_QUEUE_CONTEXT);
    status = WdfObjectAllocateContext((WDFOBJECT) Queue,
                                      &objectAttributes,
                                      (PVOID*) &qCtx);
    if (FALSE == NT_SUCCESS(status)) {
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - WdfObjectAllocateContext failed with %!status!",
              status);
        goto exit;
    }
 
    if (NULL != devCtx->ComponentInfo[component].Queue) {
        status = STATUS_INVALID_DEVICE_REQUEST;
        Trace(TRACE_LEVEL_ERROR,
              "%!FUNC! - Component %d has already been associated with WDFQUEUE"
              " %p. Associating a component with more than one queue is not "
              "supported. %!status!.",
              component,
              devCtx->ComponentInfo[component].Queue,
              status);
        WdfVerifierDbgBreakPoint();
        goto exit;
    }
 
    //
    // Copy the queue init settings
    //
    qCtx->QueueInitSettings = *queueInitSettings;
 
    //
    // The initializer can now be used to initialize some other object
    //
    ResetInitializer(Initializer);
 
    //
    // Save the queue handle in our private component information
    //
    devCtx->ComponentInfo[component].Queue = Queue;
 
    status = STATUS_SUCCESS;
     
exit:
    return status;
}

Our Services

  • What our customers say about us?

© 2011-2025 All Rights Reserved. Joya Systems. 4425 South Mopac Building II Suite 101 Austin, TX 78735 Tel: 800-DEV-KERNEL

Privacy Policy. Terms of use. Valid XHTML & CSS