ReactOS 0.4.15-dev-8413-gc1c91f2
main.c
Go to the documentation of this file.
1/*
2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS Kernel Streaming
4 * FILE: drivers/wdm/audio/sysaudio/main.c
5 * PURPOSE: System Audio graph builder
6 * PROGRAMMER: Andrew Greenwood
7 * Johannes Anderwald
8 * HISTORY:
9 * 8 Jul 07 Started basic implementation
10 */
11
12#include "sysaudio.h"
13
14#define NDEBUG
15#include <debug.h>
16
17#define TAG_SYSAUDIO 'AsyS'
18
19const GUID KSCATEGORY_SYSAUDIO = {0xA7C7A5B1L, 0x5AF3, 0x11D1, {0x9C, 0xED, 0x00, 0xA0, 0x24, 0xBF, 0x04, 0x07}};
20const GUID KSCATEGORY_AUDIO_DEVICE = {0xFBF6F530L, 0x07B9, 0x11D2, {0xA7, 0x1E, 0x00, 0x00, 0xF8, 0x00, 0x47, 0x88}};
21const GUID KSCATEGORY_PREFERRED_WAVEOUT_DEVICE = {0xD6C5066EL, 0x72C1, 0x11D2, {0x97, 0x55, 0x00, 0x00, 0xF8, 0x00, 0x47, 0x88}};
22const GUID KSCATEGORY_PREFERRED_WAVEIN_DEVICE = {0xD6C50671L, 0x72C1, 0x11D2, {0x97, 0x55, 0x00, 0x00, 0xF8, 0x00, 0x47, 0x88}};
23const GUID KSCATEGORY_PREFERRED_MIDIOUT_DEVICE = {0xD6C50674L, 0x72C1, 0x11D2, {0x97, 0x55, 0x00, 0x00, 0xF8, 0x00, 0x47, 0x88}};
24
29{
30 return ExAllocatePoolZero(PoolType, NumberOfBytes, TAG_SYSAUDIO);
31}
32
33VOID
36{
38}
39
40VOID
43{
44 DPRINT("SysAudio_Unload called\n");
45}
46
51 IN PIRP Irp)
52{
53 PKSAUDIO_DEVICE_ENTRY DeviceEntry;
54 PSYSAUDIODEVEXT DeviceExtension;
56
57 DPRINT("SysAudio_Shutdown called\n");
58
59 DeviceExtension = (PSYSAUDIODEVEXT)DeviceObject->DeviceExtension;
60
61 while(!IsListEmpty(&DeviceExtension->KsAudioDeviceList))
62 {
63 Entry = RemoveHeadList(&DeviceExtension->KsAudioDeviceList);
65
66 DPRINT("Freeing item %wZ\n", &DeviceEntry->DeviceName);
67
68 /* dereference audio device file object */
69 ObDereferenceObject(DeviceEntry->FileObject);
70
71 /* close audio device handle */
72 ZwClose(DeviceEntry->Handle);
73
74 /* free device string */
75 RtlFreeUnicodeString(&DeviceEntry->DeviceName);
76
77 /* free audio device entry */
78 FreeItem(DeviceEntry);
79 }
80
81 Irp->IoStatus.Information = 0;
82 Irp->IoStatus.Status = STATUS_SUCCESS;
84 return STATUS_SUCCESS;
85}
86
91 IN PIRP Irp)
92{
93 PIO_STACK_LOCATION IrpStack;
94 UNICODE_STRING SymlinkName = RTL_CONSTANT_STRING(L"\\DosDevices\\sysaudio");
95 SYSAUDIODEVEXT *DeviceExtension;
96
97 /* Get current irp stack */
99
100 /* Fetch the device extension */
101 DeviceExtension = (SYSAUDIODEVEXT*)DeviceObject->DeviceExtension;
102 ASSERT(DeviceExtension);
103
104 if (IrpStack->MinorFunction == IRP_MN_REMOVE_DEVICE)
105 {
106 /* Unregister the echo cancel hook */
107 if (DeviceExtension->EchoCancelNotificationEntry)
109
110 /* Unregister the ks audio hook */
111 if (DeviceExtension->KsAudioNotificationEntry)
113
114 /* Destroy our symbolic link */
115 IoDeleteSymbolicLink(&SymlinkName);
116 }
117 else if (IrpStack->MinorFunction == IRP_MN_QUERY_PNP_DEVICE_STATE)
118 {
119 /* Sysaudio can not be disabled */
120 Irp->IoStatus.Information |= PNP_DEVICE_NOT_DISABLEABLE;
121 }
122
123 /* Perform default pnp actions */
125}
126
128NTAPI
132{
134 UNICODE_STRING DeviceName = RTL_CONSTANT_STRING(L"\\Device\\sysaudio");
135 UNICODE_STRING SymlinkName = RTL_CONSTANT_STRING(L"\\DosDevices\\sysaudio");
137 SYSAUDIODEVEXT *DeviceExtension;
138
139 DPRINT("SysAudio_AddDevice called\n");
140
141 /* Create the device */
143 sizeof(SYSAUDIODEVEXT),
144 &DeviceName,
146 0,
147 FALSE,
148 &DeviceObject);
149
150 /* Check for success */
151 if (!NT_SUCCESS(Status))
152 {
153 DPRINT("Failed to create \\Device\\sysaudio !\n");
154 return Status;
155 }
156
157 /* Register device interfaces */
159 if (!NT_SUCCESS(Status))
160 {
161 /* Failed to register
162 * Create a hack interface
163 */
164 Status = IoCreateSymbolicLink(&SymlinkName, &DeviceName);
165 if (!NT_SUCCESS(Status))
166 {
168 DPRINT1("Failed to create sysaudio symlink!\n");
169 return Status;
170 }
171 }
172 /* Acquire device extension */
173 DeviceExtension = (SYSAUDIODEVEXT*)DeviceObject->DeviceExtension;
174 /* Initialize device extension */
175 RtlZeroMemory(DeviceExtension, sizeof(SYSAUDIODEVEXT));
176
177 /* Initialize the mutex */
178 KeInitializeSpinLock(&DeviceExtension->Lock);
179
180 /* Initialize the ks audio device list */
181 InitializeListHead(&DeviceExtension->KsAudioDeviceList);
182
183 /* Allocate kernel streaming device header */
184 Status = SysAudioAllocateDeviceHeader(DeviceExtension);
185 if (!NT_SUCCESS(Status))
186 {
187 DPRINT1("KsAllocateDeviceHeader failed with %x\n", Status);
188 goto cleanup;
189 }
190
191 /* Register device notification hooks */
194 if (!NT_SUCCESS(Status))
195 {
196 DPRINT1("Failed to register device notifications\n");
197 goto cleanup;
198 }
199
200 /* Load kmixer */
201 Status = SysAudioOpenKMixer(DeviceExtension);
202 if (!NT_SUCCESS(Status))
203 {
204 DPRINT1("SysAudioOpenKMixer failed with %x\n", Status);
205 goto cleanup;
206 }
207
208 /* set io flags */
210 /* clear initializing flag */
211 DeviceObject->Flags &= ~ DO_DEVICE_INITIALIZING;
212
213 /* atttach to device stack */
216
217 /* register shutdown notification */
219
220 /* Done */
221 return STATUS_SUCCESS;
222
223cleanup:
224
225 if (DeviceExtension->KsAudioNotificationEntry)
227
228 if (DeviceExtension->EchoCancelNotificationEntry)
230
231 IoDeleteSymbolicLink(&SymlinkName);
233 return Status;
234}
235
237NTAPI
241{
242 DPRINT("System audio graph builder (sysaudio) started\n");
243
244 /* Let ks handle these */
249
250 /* Let ks handle these */
253
254 /* Use provided ks unload function */
255 DriverObject->DriverUnload = KsNullDriverUnload;
256
257 /* Sysaudio needs to do work on pnp, so handle it */
258 DriverObject->MajorFunction[IRP_MJ_PNP] = SysAudio_Pnp;
260 DriverObject->DriverExtension->AddDevice = SysAudio_AddDevice;
261
262 /* done */
263 return STATUS_SUCCESS;
264}
static PIO_STACK_LOCATION IoGetCurrentIrpStackLocation(PIRP Irp)
LONG NTSTATUS
Definition: precomp.h:26
#define DPRINT1
Definition: precomp.h:8
PDEVICE_OBJECT PhysicalDeviceObject
Definition: btrfs_drv.h:1157
#define IRP_MJ_PNP
Definition: cdrw_usr.h:52
_In_ PIRP Irp
Definition: csq.h:116
#define FALSE
Definition: types.h:117
#define NT_SUCCESS(StatCode)
Definition: apphelp.c:33
static void cleanup(void)
Definition: main.c:1335
DRIVER_INITIALIZE DriverEntry
Definition: main.c:9
KSDDKAPI NTSTATUS NTAPI KsDefaultDispatchPnp(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
Definition: api.c:110
KSDDKAPI VOID NTAPI KsSetDevicePnpAndBaseObject(IN KSDEVICE_HEADER Header, IN PDEVICE_OBJECT PnpDeviceObject, IN PDEVICE_OBJECT BaseDevice)
Definition: api.c:257
KSDDKAPI NTSTATUS NTAPI KsDefaultForwardIrp(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
Definition: api.c:227
KSDDKAPI NTSTATUS NTAPI KsDefaultDispatchPower(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
Definition: api.c:166
KSDDKAPI NTSTATUS NTAPI KsSetMajorFunctionHandler(IN PDRIVER_OBJECT DriverObject, IN ULONG MajorFunction)
Definition: irp.c:2050
KSDDKAPI VOID NTAPI KsNullDriverUnload(IN PDRIVER_OBJECT DriverObject)
Definition: irp.c:1178
NTSTATUS SysAudioRegisterNotifications(IN PDRIVER_OBJECT DriverObject, IN PDEVICE_OBJECT DeviceObject)
Definition: deviface.c:172
NTSTATUS SysAudioRegisterDeviceInterfaces(IN PDEVICE_OBJECT DeviceObject)
Definition: deviface.c:214
NTSTATUS SysAudioAllocateDeviceHeader(IN SYSAUDIODEVEXT *DeviceExtension)
Definition: dispatcher.c:104
NTSTATUS SysAudioOpenKMixer(IN SYSAUDIODEVEXT *DeviceExtension)
Definition: dispatcher.c:132
PVOID AllocateItem(IN POOL_TYPE PoolType, IN SIZE_T NumberOfBytes)
Definition: main.c:26
const GUID KSCATEGORY_PREFERRED_WAVEOUT_DEVICE
Definition: main.c:21
const GUID KSCATEGORY_PREFERRED_WAVEIN_DEVICE
Definition: main.c:22
VOID NTAPI SysAudio_Unload(IN PDRIVER_OBJECT DriverObject)
Definition: main.c:42
const GUID KSCATEGORY_SYSAUDIO
Definition: main.c:19
NTSTATUS NTAPI SysAudio_AddDevice(IN PDRIVER_OBJECT DriverObject, IN PDEVICE_OBJECT PhysicalDeviceObject)
Definition: main.c:129
const GUID KSCATEGORY_AUDIO_DEVICE
Definition: main.c:20
NTSTATUS NTAPI SysAudio_Shutdown(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
Definition: main.c:49
#define TAG_SYSAUDIO
Definition: main.c:17
NTSTATUS NTAPI SysAudio_Pnp(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
Definition: main.c:89
const GUID KSCATEGORY_PREFERRED_MIDIOUT_DEVICE
Definition: main.c:23
VOID FreeItem(IN PVOID Item)
Definition: main.c:34
#define IsListEmpty(ListHead)
Definition: env_spec_w32.h:954
#define DO_DIRECT_IO
Definition: env_spec_w32.h:396
#define RemoveHeadList(ListHead)
Definition: env_spec_w32.h:964
#define InitializeListHead(ListHead)
Definition: env_spec_w32.h:944
#define KeInitializeSpinLock(sl)
Definition: env_spec_w32.h:604
Status
Definition: gdiplustypes.h:25
#define ASSERT(a)
Definition: mode.c:44
#define ExFreePoolWithTag(_P, _T)
Definition: module.h:1109
_Inout_opt_ PDEVICE_OBJECT _Inout_opt_ PDEVICE_OBJECT _Inout_opt_ PDEVICE_OBJECT * NextDeviceObject
Definition: ndis.h:4642
NTSYSAPI NTSTATUS NTAPI ZwClose(_In_ HANDLE Handle)
NTSYSAPI VOID NTAPI RtlFreeUnicodeString(PUNICODE_STRING UnicodeString)
PDEVICE_OBJECT NTAPI IoAttachDeviceToDeviceStack(IN PDEVICE_OBJECT SourceDevice, IN PDEVICE_OBJECT TargetDevice)
Definition: device.c:966
NTSTATUS NTAPI IoCreateDevice(IN PDRIVER_OBJECT DriverObject, IN ULONG DeviceExtensionSize, IN PUNICODE_STRING DeviceName, IN DEVICE_TYPE DeviceType, IN ULONG DeviceCharacteristics, IN BOOLEAN Exclusive, OUT PDEVICE_OBJECT *DeviceObject)
Definition: device.c:1031
NTSTATUS NTAPI IoRegisterShutdownNotification(PDEVICE_OBJECT DeviceObject)
Definition: device.c:1694
VOID NTAPI IoDeleteDevice(IN PDEVICE_OBJECT DeviceObject)
Definition: device.c:1251
#define IoCompleteRequest
Definition: irp.c:1240
#define L(x)
Definition: ntvdm.h:50
NTSTATUS NTAPI IoUnregisterPlugPlayNotification(_In_ PVOID NotificationEntry)
Definition: pnpnotify.c:479
#define FILE_DEVICE_KS
Definition: winioctl.h:92
#define IRP_MJ_CLOSE
Definition: rdpdr.c:45
#define IRP_MJ_DEVICE_CONTROL
Definition: rdpdr.c:52
#define IRP_MJ_WRITE
Definition: rdpdr.c:47
#define IRP_MJ_CREATE
Definition: rdpdr.c:44
#define STATUS_SUCCESS
Definition: shellext.h:65
#define DPRINT
Definition: sndvol32.h:73
base of all file and directory entries
Definition: entries.h:83
Definition: sysaudio.h:13
PFILE_OBJECT FileObject
Definition: sysaudio.h:18
HANDLE Handle
Definition: sysaudio.h:17
UNICODE_STRING DeviceName
Definition: sysaudio.h:15
KSDEVICE_HEADER KsDeviceHeader
Definition: sysaudio.h:25
PVOID EchoCancelNotificationEntry
Definition: sysaudio.h:32
PVOID KsAudioNotificationEntry
Definition: sysaudio.h:31
LIST_ENTRY KsAudioDeviceList
Definition: sysaudio.h:30
KSPIN_LOCK Lock
Definition: sysaudio.h:33
Definition: typedefs.h:120
struct SYSAUDIODEVEXT * PSYSAUDIODEVEXT
struct KSAUDIO_DEVICE_ENTRY * PKSAUDIO_DEVICE_ENTRY
#define RTL_CONSTANT_STRING(s)
Definition: tunneltest.c:14
INT POOL_TYPE
Definition: typedefs.h:78
#define NTAPI
Definition: typedefs.h:36
ULONG_PTR SIZE_T
Definition: typedefs.h:80
#define RtlZeroMemory(Destination, Length)
Definition: typedefs.h:262
#define IN
Definition: typedefs.h:39
#define CONTAINING_RECORD(address, type, field)
Definition: typedefs.h:260
_In_ WDFCOLLECTION _In_ WDFOBJECT Item
_In_ PDEVICE_OBJECT DeviceObject
Definition: wdfdevice.h:2055
_Must_inspect_result_ _In_ WDFDEVICE _In_ DEVICE_REGISTRY_PROPERTY _In_ _Strict_type_match_ POOL_TYPE PoolType
Definition: wdfdevice.h:3815
_Must_inspect_result_ _In_ PWDFDEVICE_INIT _In_opt_ PCUNICODE_STRING DeviceName
Definition: wdfdevice.h:3275
_Must_inspect_result_ _In_ PDRIVER_OBJECT _In_ PCUNICODE_STRING RegistryPath
Definition: wdfdriver.h:215
_Must_inspect_result_ _In_ PDRIVER_OBJECT DriverObject
Definition: wdfdriver.h:213
#define IRP_MN_QUERY_PNP_DEVICE_STATE
#define PNP_DEVICE_NOT_DISABLEABLE
Definition: iotypes.h:1006
#define IO_NO_INCREMENT
Definition: iotypes.h:598
#define IRP_MN_REMOVE_DEVICE
#define DO_POWER_PAGABLE
#define IRP_MJ_SYSTEM_CONTROL
#define IRP_MJ_SHUTDOWN
#define IRP_MJ_POWER
_Must_inspect_result_ typedef _In_ PHYSICAL_ADDRESS _Inout_ PLARGE_INTEGER NumberOfBytes
Definition: iotypes.h:1036
#define ObDereferenceObject
Definition: obfuncs.h:203