Sample Code

Windows Driver Samples/ SpbTestTool/ C++/ sys/ driver.cpp/

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
/*++
 
Copyright (c) Microsoft Corporation.  All rights reserved.
 
Module Name:
 
    driver.cpp
 
Abstract:
 
    This module contains the WDF driver initialization
    functions for the peripheral driver.
 
Environment:
 
    kernel-mode only
 
Revision History:
 
--*/
 
#include "internal.h"
#include "driver.h"
#include "device.h"
#include "ntstrsafe.h"
 
#include "driver.tmh"
 
NTSTATUS
#pragma prefast(suppress:__WARNING_DRIVER_FUNCTION_TYPE, "thanks, i know this already")
DriverEntry(
    _In_ PDRIVER_OBJECT  DriverObject,
    _In_ PUNICODE_STRING RegistryPath
    )
{
    WDF_DRIVER_CONFIG driverConfig;
    WDF_OBJECT_ATTRIBUTES driverAttributes;
 
    WDFDRIVER fxDriver;
 
    NTSTATUS status;
 
    WPP_INIT_TRACING(DriverObject, RegistryPath);
 
    FuncEntry(TRACE_FLAG_WDFLOADING);
 
    WDF_DRIVER_CONFIG_INIT(&driverConfig, OnDeviceAdd);
    driverConfig.DriverPoolTag = SPBT_POOL_TAG;
 
    WDF_OBJECT_ATTRIBUTES_INIT(&driverAttributes);
    driverAttributes.EvtCleanupCallback = OnDriverCleanup;
 
    status = WdfDriverCreate(
        DriverObject,
        RegistryPath,
        &driverAttributes,
        &driverConfig,
        &fxDriver);
 
    if (!NT_SUCCESS(status))
    {
        Trace(
            TRACE_LEVEL_ERROR,
            TRACE_FLAG_WDFLOADING,
            "Error creating WDF driver object - %!STATUS!",
            status);
 
        goto exit;
    }
 
    Trace(
        TRACE_LEVEL_VERBOSE,
        TRACE_FLAG_WDFLOADING,
        "Created WDF driver object");
 
exit:
 
    FuncExit(TRACE_FLAG_WDFLOADING);
 
    return status;
}
 
VOID
OnDriverCleanup(
    _In_ WDFOBJECT Object
    )
{
    FuncEntry(TRACE_FLAG_WDFLOADING);
 
    UNREFERENCED_PARAMETER(Object);
 
    WPP_CLEANUP(nullptr);
 
    FuncExit(TRACE_FLAG_WDFLOADING);
}
 
NTSTATUS
OnDeviceAdd(
    _In_    WDFDRIVER       FxDriver,
    _Inout_ PWDFDEVICE_INIT FxDeviceInit
    )
/*++
  
  Routine Description:
 
    This routine creates the device object for an SPB
    controller and the device's child objects.
 
  Arguments:
 
    FxDriver - the WDF driver object handle
    FxDeviceInit - information about the PDO that we are loading on
 
  Return Value:
 
    Status
 
--*/
{
    FuncEntry(TRACE_FLAG_WDFLOADING);
 
    PDEVICE_CONTEXT pDevice;
    NTSTATUS status;
     
    UNREFERENCED_PARAMETER(FxDriver);
 
    //
    // Setup PNP/Power callbacks.
    //
 
    {
        WDF_PNPPOWER_EVENT_CALLBACKS pnpCallbacks;
        WDF_PNPPOWER_EVENT_CALLBACKS_INIT(&pnpCallbacks);
 
        pnpCallbacks.EvtDevicePrepareHardware = OnPrepareHardware;
        pnpCallbacks.EvtDeviceReleaseHardware = OnReleaseHardware;
        pnpCallbacks.EvtDeviceD0Entry = OnD0Entry;
        pnpCallbacks.EvtDeviceD0Exit = OnD0Exit;
 
        WdfDeviceInitSetPnpPowerEventCallbacks(FxDeviceInit, &pnpCallbacks);
    }
 
    //
    // Prepare for file object handling.
    //
 
    {
        WDF_FILEOBJECT_CONFIG fileObjectConfig;
 
        WDF_FILEOBJECT_CONFIG_INIT(
            &fileObjectConfig,
            nullptr,
            nullptr,
            OnFileCleanup);
 
        WDF_OBJECT_ATTRIBUTES fileObjectAttributes;
        WDF_OBJECT_ATTRIBUTES_INIT(&fileObjectAttributes);
 
        WdfDeviceInitSetFileObjectConfig(
            FxDeviceInit,
            &fileObjectConfig,
            &fileObjectAttributes);
    }
 
    //
    // Set request attributes.
    //
 
    {
        WDF_OBJECT_ATTRIBUTES attributes;
        WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(
            &attributes,
            REQUEST_CONTEXT);
 
        WdfDeviceInitSetRequestAttributes(FxDeviceInit, &attributes);
    }
 
    //
    // Create the device.
    //
 
    {
        WDFDEVICE fxDevice;
        WDF_OBJECT_ATTRIBUTES deviceAttributes;
        WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&deviceAttributes, DEVICE_CONTEXT);
 
        status = WdfDeviceCreate(
            &FxDeviceInit,
            &deviceAttributes,
            &fxDevice);
 
        if (!NT_SUCCESS(status))
        {
            Trace(
                TRACE_LEVEL_ERROR,
                TRACE_FLAG_WDFLOADING,
                "Error creating WDFDEVICE - %!STATUS!",
                status);
 
            goto exit;
        }
 
        pDevice = GetDeviceContext(fxDevice);
        NT_ASSERT(pDevice != nullptr);
 
        pDevice->FxDevice = fxDevice;
    }
 
    //
    // Ensure device is disable-able
    //
     
    {
        WDF_DEVICE_STATE deviceState;
        WDF_DEVICE_STATE_INIT(&deviceState);
         
        deviceState.NotDisableable = WdfFalse;
        WdfDeviceSetDeviceState(pDevice->FxDevice, &deviceState);
    }
 
    //
    // Create queues to handle IO
    //
 
    {
        WDF_IO_QUEUE_CONFIG queueConfig;
        WDFQUEUE queue;
 
        //
        // Top-level queue
        //
 
        WDF_IO_QUEUE_CONFIG_INIT_DEFAULT_QUEUE(
            &queueConfig,
            WdfIoQueueDispatchParallel);
 
        queueConfig.EvtIoDefault = OnTopLevelIoDefault;
        queueConfig.PowerManaged = WdfFalse;
 
        status = WdfIoQueueCreate(
            pDevice->FxDevice,
            &queueConfig,
            WDF_NO_OBJECT_ATTRIBUTES,
            &queue
            );
 
        if (!NT_SUCCESS(status))
        {
            Trace(
                TRACE_LEVEL_ERROR,
                TRACE_FLAG_WDFLOADING,
                "Error creating top-level IO queue - %!STATUS!",
                status);
 
            goto exit;
        }
 
        //
        // Sequential SPB queue
        //
 
        WDF_IO_QUEUE_CONFIG_INIT(
            &queueConfig,
            WdfIoQueueDispatchSequential);
 
        queueConfig.EvtIoRead = OnIoRead;
        queueConfig.EvtIoWrite = OnIoWrite;
        queueConfig.EvtIoDeviceControl = OnIoDeviceControl;
        queueConfig.PowerManaged = WdfFalse;
 
        status = WdfIoQueueCreate(
            pDevice->FxDevice,
            &queueConfig,
            WDF_NO_OBJECT_ATTRIBUTES,
            &pDevice->SpbQueue
            );
 
        if (!NT_SUCCESS(status))
        {
            Trace(
                TRACE_LEVEL_ERROR,
                TRACE_FLAG_WDFLOADING,
                "Error creating SPB IO queue - %!STATUS!",
                status);
 
            goto exit;
        }
    }
 
    //
    // Create a symbolic link.
    //
 
    {
        DECLARE_UNICODE_STRING_SIZE(symbolicLinkName, 128);
 
        status = RtlUnicodeStringPrintf(
            &symbolicLinkName, L"%ws",
            SPBTESTTOOL_SYMBOLIC_NAME);
 
        if (!NT_SUCCESS(status))
        {
            Trace(
                TRACE_LEVEL_ERROR,
                TRACE_FLAG_WDFLOADING,
                "Error creating symbolic link string for device "
                "- %!STATUS!",
                status);
 
            goto exit;
        }
 
        status = WdfDeviceCreateSymbolicLink(
            pDevice->FxDevice,
            &symbolicLinkName);
 
        if (!NT_SUCCESS(status))
        {
            Trace(
                TRACE_LEVEL_ERROR,
                TRACE_FLAG_WDFLOADING,
                "Error creating symbolic link for device "
                "- %!STATUS!",
                status);
 
            goto exit;
        }
    }
 
    //
    // Retrieve registry settings.
    //
 
    {
        WDFKEY key = NULL;
        WDFKEY subkey = NULL;
        ULONG connectInterrupt = 0;
        NTSTATUS settingStatus;
     
        DECLARE_CONST_UNICODE_STRING(subkeyName, L"Settings");
        DECLARE_CONST_UNICODE_STRING(connectInterruptName, L"ConnectInterrupt");
 
        settingStatus = WdfDeviceOpenRegistryKey(
            pDevice->FxDevice,
            PLUGPLAY_REGKEY_DEVICE,
            KEY_READ,
            WDF_NO_OBJECT_ATTRIBUTES,
            &key);
 
        if (!NT_SUCCESS(settingStatus))
        {
            Trace(
                TRACE_LEVEL_WARNING,
                TRACE_FLAG_WDFLOADING,
                "Error opening device registry key - %!STATUS!",
                settingStatus);
        }
 
        if (NT_SUCCESS(settingStatus))
        {
            settingStatus = WdfRegistryOpenKey(
                key,
                &subkeyName,
                KEY_READ,
                WDF_NO_OBJECT_ATTRIBUTES,
                &subkey);
 
            if (!NT_SUCCESS(settingStatus))
            {
                Trace(
                    TRACE_LEVEL_WARNING,
                    TRACE_FLAG_WDFLOADING,
                    "Error opening registry subkey for 'Settings' - %!STATUS!",
                    settingStatus);
            }
        }
 
        if (NT_SUCCESS(settingStatus))
        {
 
            settingStatus = WdfRegistryQueryULong(
                subkey,
                &connectInterruptName,
                &connectInterrupt);
 
            if (!NT_SUCCESS(settingStatus))
            {
                Trace(
                    TRACE_LEVEL_WARNING,
                    TRACE_FLAG_WDFLOADING,
                    "Error querying registry value for 'ConnectInterrupt' - %!STATUS!",
                    settingStatus);
            }
        }
 
        if (key != NULL)
        {
            WdfRegistryClose(key);
        }
 
        if (subkey != NULL)
        {
            WdfRegistryClose(subkey);
        }
 
        pDevice->ConnectInterrupt = (connectInterrupt == 1);
    }
 
exit:
 
    FuncExit(TRACE_FLAG_WDFLOADING);
 
    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