summaryrefslogtreecommitdiff
path: root/audio/Acx/Samples/AudioCodec/Driver/Driver.cpp
blob: 452b0d99eaf24451d965bd1b0f3ef140417e6d98 (plain)
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
/*++

Copyright (c) Microsoft Corporation.  All rights reserved.

Module Name:

    Driver.cpp

Abstract:

    This file contains the driver entry points and callbacks.

Environment:

    Kernel-mode Driver Framework

--*/

#include "public.h"
#include "cpp_utils.h"

#ifndef __INTELLISENSE__
#include "driver.tmh"
#endif

_Use_decl_annotations_
void AudioCodecDriverUnload(
    _In_ WDFDRIVER Driver
)
{
    PAGED_CODE();

    if (!Driver)
    {
        ASSERT(FALSE);
        return;
    }

    WPP_CLEANUP(WdfDriverWdmGetDriverObject(Driver));

    if (g_RegistryPath.Buffer != nullptr)
    {
        ExFreePool(g_RegistryPath.Buffer);
        RtlZeroMemory(&g_RegistryPath, sizeof(g_RegistryPath));
    }

    return;
}

INIT_CODE_SEG
NTSTATUS
DriverEntry(
    _In_ PDRIVER_OBJECT  DriverObject,
    _In_ PUNICODE_STRING RegistryPath
)
/*++

Routine Description:
    DriverEntry initializes the driver and is the first routine called by the
    system after the driver is loaded. DriverEntry specifies the other entry
    points in the function driver, such as EvtDevice and DriverUnload.

Parameters Description:

    DriverObject - represents the instance of the function driver that is loaded
    into memory. DriverEntry must initialize members of DriverObject before it
    returns to the caller. DriverObject is allocated by the system before the
    driver is loaded, and it is released by the system after the system unloads
    the function driver from memory.

    RegistryPath - represents the driver specific path in the Registry.
    The function driver can use the path to store driver related data between
    reboots. The path does not store hardware instance specific data.

Return Value:

    STATUS_SUCCESS if successful,
    STATUS_UNSUCCESSFUL otherwise.

--*/
{
    WDF_DRIVER_CONFIG           wdfCfg;
    ACX_DRIVER_CONFIG           acxCfg;
    WDFDRIVER                   driver;
    NTSTATUS                    status = STATUS_SUCCESS;
    WDF_OBJECT_ATTRIBUTES       attributes;

    PAGED_CODE();
    WPP_INIT_TRACING(DriverObject, RegistryPath);

    auto exit = scope_exit([&status, &DriverObject]() {
        if (!NT_SUCCESS(status))
        {
            WPP_CLEANUP(DriverObject);

            if (g_RegistryPath.Buffer != nullptr)
            {
                ExFreePool(g_RegistryPath.Buffer);
                RtlZeroMemory(&g_RegistryPath, sizeof(g_RegistryPath));
            }
        }
        });

    RETURN_NTSTATUS_IF_FAILED(CopyRegistrySettingsPath(RegistryPath));

    WDF_OBJECT_ATTRIBUTES_INIT(&attributes);

    WDF_DRIVER_CONFIG_INIT(&wdfCfg, Codec_EvtBusDeviceAdd);
    wdfCfg.EvtDriverUnload = AudioCodecDriverUnload;

    //
    // Create a framework driver object to represent our driver.
    //
    RETURN_NTSTATUS_IF_FAILED(WdfDriverCreate(DriverObject, RegistryPath, &attributes, &wdfCfg, &driver));

    //
    // Initializing the ACX driver configuration struct which contains size and flags
    // elements. 
    //
    ACX_DRIVER_CONFIG_INIT(&acxCfg);

    // 
    // The driver calls this DDI in its DriverEntry callback after creating the WDF driver
    // object. ACX uses this call to apply any post driver settings.
    //
    RETURN_NTSTATUS_IF_FAILED(AcxDriverInitialize(driver, &acxCfg));

    return status;
}