2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS Kernel Streaming
4 * FILE: drivers/wdm/audio/legacy/wdmaud/deviface.c
5 * PURPOSE: System Audio graph builder
6 * PROGRAMMER: Andrew Greenwood
15 const GUID KSPROPSETID_Sysaudio
= {0xCBE3FAA0L
, 0xCC75, 0x11D0, {0xB4, 0x65, 0x00, 0x00, 0x1A, 0x18, 0x18, 0xE6}};
19 IN PDEVICE_OBJECT DeviceObject
,
21 IN PWDMAUD_DEVICE_INFO DeviceInfo
,
22 IN PWDMAUD_CLIENT ClientInfo
)
24 if (DeviceInfo
->DeviceType
== MIXER_DEVICE_TYPE
)
26 return WdmAudControlOpenMixer(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
29 if (DeviceInfo
->DeviceType
== WAVE_OUT_DEVICE_TYPE
|| DeviceInfo
->DeviceType
== WAVE_IN_DEVICE_TYPE
)
31 return WdmAudControlOpenWave(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
34 if (DeviceInfo
->DeviceType
== MIDI_OUT_DEVICE_TYPE
|| DeviceInfo
->DeviceType
== MIDI_IN_DEVICE_TYPE
)
36 return WdmAudControlOpenMidi(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
40 return SetIrpIoStatus(Irp
, STATUS_NOT_SUPPORTED
, sizeof(WDMAUD_DEVICE_INFO
));
44 WdmAudControlDeviceType(
45 IN PDEVICE_OBJECT DeviceObject
,
47 IN PWDMAUD_DEVICE_INFO DeviceInfo
,
48 IN PWDMAUD_CLIENT ClientInfo
)
52 if (DeviceInfo
->DeviceType
== MIXER_DEVICE_TYPE
)
54 Result
= WdmAudGetMixerDeviceCount();
56 else if (DeviceInfo
->DeviceType
== WAVE_OUT_DEVICE_TYPE
)
58 Result
= WdmAudGetWaveOutDeviceCount();
60 else if (DeviceInfo
->DeviceType
== WAVE_IN_DEVICE_TYPE
)
62 Result
= WdmAudGetWaveInDeviceCount();
64 else if (DeviceInfo
->DeviceType
== MIDI_IN_DEVICE_TYPE
)
66 Result
= WdmAudGetMidiInDeviceCount();
68 else if (DeviceInfo
->DeviceType
== MIDI_OUT_DEVICE_TYPE
)
70 Result
= WdmAudGetMidiOutDeviceCount();
74 /* store result count */
75 DeviceInfo
->DeviceCount
= Result
;
77 DPRINT("WdmAudControlDeviceType Devices %u\n", DeviceInfo
->DeviceCount
);
78 return SetIrpIoStatus(Irp
, STATUS_SUCCESS
, sizeof(WDMAUD_DEVICE_INFO
));
82 WdmAudControlDeviceState(
83 IN PDEVICE_OBJECT DeviceObject
,
85 IN PWDMAUD_DEVICE_INFO DeviceInfo
,
86 IN PWDMAUD_CLIENT ClientInfo
)
92 PFILE_OBJECT FileObject
;
94 DPRINT("WdmAudControlDeviceState\n");
96 Status
= ObReferenceObjectByHandle(DeviceInfo
->hDevice
, GENERIC_READ
| GENERIC_WRITE
, *IoFileObjectType
, KernelMode
, (PVOID
*)&FileObject
, NULL
);
97 if (!NT_SUCCESS(Status
))
99 DPRINT1("Error: invalid device handle provided %p Type %x\n", DeviceInfo
->hDevice
, DeviceInfo
->DeviceType
);
100 return SetIrpIoStatus(Irp
, STATUS_UNSUCCESSFUL
, 0);
103 Property
.Set
= KSPROPSETID_Connection
;
104 Property
.Id
= KSPROPERTY_CONNECTION_STATE
;
105 Property
.Flags
= KSPROPERTY_TYPE_SET
;
107 State
= DeviceInfo
->u
.State
;
109 Status
= KsSynchronousIoControlDevice(FileObject
, KernelMode
, IOCTL_KS_PROPERTY
, (PVOID
)&Property
, sizeof(KSPROPERTY
), (PVOID
)&State
, sizeof(KSSTATE
), &BytesReturned
);
111 ObDereferenceObject(FileObject
);
113 DPRINT("WdmAudControlDeviceState Status %x\n", Status
);
114 return SetIrpIoStatus(Irp
, Status
, sizeof(WDMAUD_DEVICE_INFO
));
119 IN PDEVICE_OBJECT DeviceObject
,
121 IN PWDMAUD_DEVICE_INFO DeviceInfo
,
122 IN PWDMAUD_CLIENT ClientInfo
)
124 PWDMAUD_DEVICE_EXTENSION DeviceExtension
;
125 NTSTATUS Status
= STATUS_UNSUCCESSFUL
;
127 DPRINT("WdmAudCapabilities entered\n");
129 DeviceExtension
= (PWDMAUD_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
;
131 if (DeviceInfo
->DeviceType
== MIXER_DEVICE_TYPE
)
133 Status
= WdmAudMixerCapabilities(DeviceObject
, DeviceInfo
, ClientInfo
, DeviceExtension
);
135 else if (DeviceInfo
->DeviceType
== WAVE_IN_DEVICE_TYPE
|| DeviceInfo
->DeviceType
== WAVE_OUT_DEVICE_TYPE
)
137 Status
= WdmAudWaveCapabilities(DeviceObject
, DeviceInfo
, ClientInfo
, DeviceExtension
);
139 else if (DeviceInfo
->DeviceType
== MIDI_IN_DEVICE_TYPE
|| DeviceInfo
->DeviceType
== MIDI_OUT_DEVICE_TYPE
)
141 Status
= WdmAudMidiCapabilities(DeviceObject
, DeviceInfo
, ClientInfo
, DeviceExtension
);
144 return SetIrpIoStatus(Irp
, Status
, sizeof(WDMAUD_DEVICE_INFO
));
150 IN PDEVICE_OBJECT DeviceObject
,
152 IN PWDMAUD_DEVICE_INFO DeviceInfo
,
153 IN PWDMAUD_CLIENT ClientInfo
)
157 for(Index
= 0; Index
< ClientInfo
->NumPins
; Index
++)
159 if (ClientInfo
->hPins
[Index
].Handle
== DeviceInfo
->hDevice
&& ClientInfo
->hPins
[Index
].Type
!= MIXER_DEVICE_TYPE
)
161 DPRINT1("Closing device %p\n", DeviceInfo
->hDevice
);
162 ZwClose(DeviceInfo
->hDevice
);
163 ClientInfo
->hPins
[Index
].Handle
= NULL
;
164 SetIrpIoStatus(Irp
, STATUS_SUCCESS
, sizeof(WDMAUD_DEVICE_INFO
));
165 return STATUS_SUCCESS
;
167 else if (ClientInfo
->hPins
[Index
].Handle
== DeviceInfo
->hDevice
&& ClientInfo
->hPins
[Index
].Type
== MIXER_DEVICE_TYPE
)
169 DPRINT1("Closing mixer %p\n", DeviceInfo
->hDevice
);
170 return WdmAudControlCloseMixer(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
, Index
);
174 SetIrpIoStatus(Irp
, STATUS_INVALID_PARAMETER
, sizeof(WDMAUD_DEVICE_INFO
));
175 return STATUS_INVALID_PARAMETER
;
181 IN PDEVICE_OBJECT DeviceObject
,
183 IN PWDMAUD_DEVICE_INFO DeviceInfo
,
184 IN PWDMAUD_CLIENT ClientInfo
)
186 PFILE_OBJECT FileObject
;
189 KSALLOCATOR_FRAMING Framing
;
192 /* Get sysaudio pin file object */
193 Status
= ObReferenceObjectByHandle(DeviceInfo
->hDevice
, GENERIC_WRITE
, *IoFileObjectType
, KernelMode
, (PVOID
*)&FileObject
, NULL
);
194 if (!NT_SUCCESS(Status
))
196 DPRINT1("Invalid buffer handle %p\n", DeviceInfo
->hDevice
);
197 return SetIrpIoStatus(Irp
, Status
, 0);
200 /* Setup get framing request */
201 Property
.Id
= KSPROPERTY_CONNECTION_ALLOCATORFRAMING
;
202 Property
.Flags
= KSPROPERTY_TYPE_GET
;
203 Property
.Set
= KSPROPSETID_Connection
;
205 Status
= KsSynchronousIoControlDevice(FileObject
, KernelMode
, IOCTL_KS_PROPERTY
, (PVOID
)&Property
, sizeof(KSPROPERTY
), (PVOID
)&Framing
, sizeof(KSALLOCATOR_FRAMING
), &BytesReturned
);
207 if (NT_SUCCESS(Status
))
209 /* Store framesize */
210 DeviceInfo
->u
.FrameSize
= Framing
.FrameSize
;
213 /* Release file object */
214 ObDereferenceObject(FileObject
);
216 return SetIrpIoStatus(Irp
, Status
, sizeof(WDMAUD_DEVICE_INFO
));
222 WdmAudGetDeviceInterface(
223 IN PDEVICE_OBJECT DeviceObject
,
225 IN PWDMAUD_DEVICE_INFO DeviceInfo
)
231 /* get device interface string input length */
232 Size
= DeviceInfo
->u
.Interface
.DeviceInterfaceStringSize
;
235 Status
= WdmAudGetPnpNameByIndexAndType(DeviceInfo
->DeviceIndex
, DeviceInfo
->DeviceType
, &Device
);
237 /* check for success */
238 if (!NT_SUCCESS(Status
))
240 /* invalid device id */
241 return SetIrpIoStatus(Irp
, Status
, sizeof(WDMAUD_DEVICE_INFO
));
244 /* calculate length */
245 Length
= (wcslen(Device
)+1) * sizeof(WCHAR
);
249 /* store device interface size */
250 DeviceInfo
->u
.Interface
.DeviceInterfaceStringSize
= Length
;
252 else if (Size
< Length
)
254 /* buffer too small */
255 DeviceInfo
->u
.Interface
.DeviceInterfaceStringSize
= Length
;
256 return SetIrpIoStatus(Irp
, STATUS_BUFFER_OVERFLOW
, sizeof(WDMAUD_DEVICE_INFO
));
261 RtlMoveMemory(DeviceInfo
->u
.Interface
.DeviceInterfaceString
, Device
, Length
);
265 return SetIrpIoStatus(Irp
, STATUS_SUCCESS
, sizeof(WDMAUD_DEVICE_INFO
));
271 IN PDEVICE_OBJECT DeviceObject
,
273 IN PWDMAUD_DEVICE_INFO DeviceInfo
)
278 PFILE_OBJECT FileObject
;
280 DPRINT("WdmAudResetStream\n");
282 Status
= ObReferenceObjectByHandle(DeviceInfo
->hDevice
, GENERIC_READ
| GENERIC_WRITE
, *IoFileObjectType
, KernelMode
, (PVOID
*)&FileObject
, NULL
);
283 if (!NT_SUCCESS(Status
))
285 DPRINT1("Error: invalid device handle provided %p Type %x\n", DeviceInfo
->hDevice
, DeviceInfo
->DeviceType
);
286 return SetIrpIoStatus(Irp
, STATUS_UNSUCCESSFUL
, 0);
289 ResetStream
= DeviceInfo
->u
.ResetStream
;
290 ASSERT(ResetStream
== KSRESET_BEGIN
|| ResetStream
== KSRESET_END
);
292 Status
= KsSynchronousIoControlDevice(FileObject
, KernelMode
, IOCTL_KS_RESET_STATE
, (PVOID
)&ResetStream
, sizeof(KSRESET
), NULL
, 0, &BytesReturned
);
294 ObDereferenceObject(FileObject
);
296 DPRINT("WdmAudResetStream Status %x\n", Status
);
297 return SetIrpIoStatus(Irp
, Status
, sizeof(WDMAUD_DEVICE_INFO
));
303 IN PDEVICE_OBJECT DeviceObject
,
306 PIO_STACK_LOCATION IoStack
;
307 PWDMAUD_DEVICE_INFO DeviceInfo
;
308 PWDMAUD_CLIENT ClientInfo
;
310 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
312 DPRINT("WdmAudDeviceControl entered\n");
314 if (IoStack
->Parameters
.DeviceIoControl
.InputBufferLength
< sizeof(WDMAUD_DEVICE_INFO
))
316 /* invalid parameter */
317 DPRINT1("Input buffer too small size %u expected %u\n", IoStack
->Parameters
.DeviceIoControl
.InputBufferLength
, sizeof(WDMAUD_DEVICE_INFO
));
318 return SetIrpIoStatus(Irp
, STATUS_INVALID_PARAMETER
, 0);
321 DeviceInfo
= (PWDMAUD_DEVICE_INFO
)Irp
->AssociatedIrp
.SystemBuffer
;
323 if (DeviceInfo
->DeviceType
< MIN_SOUND_DEVICE_TYPE
|| DeviceInfo
->DeviceType
> MAX_SOUND_DEVICE_TYPE
)
325 /* invalid parameter */
326 DPRINT1("Error: device type not set\n");
327 return SetIrpIoStatus(Irp
, STATUS_INVALID_PARAMETER
, 0);
330 if (!IoStack
->FileObject
|| !IoStack
->FileObject
->FsContext
)
332 /* file object parameter */
333 DPRINT1("Error: file object is not attached\n");
334 return SetIrpIoStatus(Irp
, STATUS_UNSUCCESSFUL
, 0);
336 ClientInfo
= (PWDMAUD_CLIENT
)IoStack
->FileObject
->FsContext
;
338 DPRINT("WdmAudDeviceControl entered\n");
340 switch(IoStack
->Parameters
.DeviceIoControl
.IoControlCode
)
342 case IOCTL_OPEN_WDMAUD
:
343 return WdmAudControlOpen(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
344 case IOCTL_GETNUMDEVS_TYPE
:
345 return WdmAudControlDeviceType(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
346 case IOCTL_SETDEVICE_STATE
:
347 return WdmAudControlDeviceState(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
348 case IOCTL_GETCAPABILITIES
:
349 return WdmAudCapabilities(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
350 case IOCTL_CLOSE_WDMAUD
:
351 return WdmAudIoctlClose(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
352 case IOCTL_GETFRAMESIZE
:
353 return WdmAudFrameSize(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
354 case IOCTL_GETLINEINFO
:
355 return WdmAudGetLineInfo(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
356 case IOCTL_GETLINECONTROLS
:
357 return WdmAudGetLineControls(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
358 case IOCTL_SETCONTROLDETAILS
:
359 return WdmAudSetControlDetails(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
360 case IOCTL_GETCONTROLDETAILS
:
361 return WdmAudGetControlDetails(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
362 case IOCTL_QUERYDEVICEINTERFACESTRING
:
363 return WdmAudGetDeviceInterface(DeviceObject
, Irp
, DeviceInfo
);
364 case IOCTL_GET_MIXER_EVENT
:
365 return WdmAudGetMixerEvent(DeviceObject
, Irp
, DeviceInfo
, ClientInfo
);
366 case IOCTL_RESET_STREAM
:
367 return WdmAudResetStream(DeviceObject
, Irp
, DeviceInfo
);
370 case IOCTL_GETVOLUME
:
371 case IOCTL_SETVOLUME
:
373 DPRINT1("Unhandled %x\n", IoStack
->Parameters
.DeviceIoControl
.IoControlCode
);
377 return SetIrpIoStatus(Irp
, STATUS_NOT_IMPLEMENTED
, 0);
383 PDEVICE_OBJECT DeviceObject
,
387 PKSSTREAM_HEADER Header
;
389 PWDMAUD_COMPLETION_CONTEXT Context
= (PWDMAUD_COMPLETION_CONTEXT
)Ctx
;
391 /* get stream header */
392 Header
= (PKSSTREAM_HEADER
)Irp
->AssociatedIrp
.SystemBuffer
;
397 /* time to free all allocated mdls */
398 Mdl
= Irp
->MdlAddress
;
413 Irp
->MdlAddress
= Context
->Mdl
;
417 DPRINT("IoCompletion Irp %p IoStatus %lx Information %lx\n", Irp
, Irp
->IoStatus
.Status
, Irp
->IoStatus
.Information
);
419 if (!NT_SUCCESS(Irp
->IoStatus
.Status
))
422 Irp
->IoStatus
.Information
= 0;
425 /* dereference file object */
426 ObDereferenceObject(Context
->FileObject
);
431 return STATUS_SUCCESS
;
437 IN PDEVICE_OBJECT DeviceObject
,
441 PWDMAUD_DEVICE_INFO DeviceInfo
;
442 PFILE_OBJECT FileObject
;
443 PIO_STACK_LOCATION IoStack
;
447 PWDMAUD_COMPLETION_CONTEXT Context
;
449 /* allocate completion context */
450 Context
= AllocateItem(NonPagedPool
, sizeof(WDMAUD_COMPLETION_CONTEXT
));
454 /* not enough memory */
455 Irp
->IoStatus
.Status
= STATUS_INSUFFICIENT_RESOURCES
;
456 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
459 return STATUS_INSUFFICIENT_RESOURCES
;
462 /* get current irp stack location */
463 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
465 /* store the input buffer in UserBuffer - as KsProbeStreamIrp operates on IRP_MJ_DEVICE_CONTROL */
466 Irp
->UserBuffer
= MmGetMdlVirtualAddress(Irp
->MdlAddress
);
469 ASSERT(Irp
->UserBuffer
);
471 /* get the length of the request length */
472 Length
= IoStack
->Parameters
.Write
.Length
;
474 /* store outputbuffer length */
475 IoStack
->Parameters
.DeviceIoControl
.OutputBufferLength
= Length
;
478 Context
->Length
= Length
;
479 Context
->Function
= (IoStack
->MajorFunction
== IRP_MJ_WRITE
? IOCTL_KS_WRITE_STREAM
: IOCTL_KS_READ_STREAM
);
480 Context
->Mdl
= Irp
->MdlAddress
;
482 /* store mdl address */
483 Mdl
= Irp
->MdlAddress
;
485 /* remove mdladdress as KsProbeStreamIrp will interpret it as an already probed audio buffer */
486 Irp
->MdlAddress
= NULL
;
488 if (IoStack
->MajorFunction
== IRP_MJ_WRITE
)
490 /* probe the write stream irp */
492 Status
= KsProbeStreamIrp(Irp
, KSPROBE_STREAMWRITE
| KSPROBE_ALLOCATEMDL
| KSPROBE_PROBEANDLOCK
, Length
);
496 /* probe the read stream irp */
497 Status
= KsProbeStreamIrp(Irp
, KSPROBE_STREAMREAD
| KSPROBE_ALLOCATEMDL
| KSPROBE_PROBEANDLOCK
, Length
);
500 if (!NT_SUCCESS(Status
))
502 DPRINT1("KsProbeStreamIrp failed with Status %x Cancel %u\n", Status
, Irp
->Cancel
);
503 Irp
->MdlAddress
= Mdl
;
505 return SetIrpIoStatus(Irp
, Status
, 0);
508 /* get device info */
509 DeviceInfo
= (PWDMAUD_DEVICE_INFO
)Irp
->AssociatedIrp
.SystemBuffer
;
512 /* now get sysaudio file object */
513 Status
= ObReferenceObjectByHandle(DeviceInfo
->hDevice
, GENERIC_WRITE
, *IoFileObjectType
, KernelMode
, (PVOID
*)&FileObject
, NULL
);
514 if (!NT_SUCCESS(Status
))
516 DPRINT1("Invalid pin handle %p\n", DeviceInfo
->hDevice
);
517 Irp
->MdlAddress
= Mdl
;
519 return SetIrpIoStatus(Irp
, Status
, 0);
522 /* store file object whose reference is released in the completion callback */
523 Context
->FileObject
= FileObject
;
525 /* skip current irp stack location */
526 IoSkipCurrentIrpStackLocation(Irp
);
528 /* get next stack location */
529 IoStack
= IoGetNextIrpStackLocation(Irp
);
531 /* prepare stack location */
532 IoStack
->FileObject
= FileObject
;
533 IoStack
->Parameters
.Write
.Length
= Length
;
534 IoStack
->MajorFunction
= IRP_MJ_WRITE
;
535 IoStack
->Parameters
.DeviceIoControl
.IoControlCode
= (Read
? IOCTL_KS_READ_STREAM
: IOCTL_KS_WRITE_STREAM
);
536 IoSetCompletionRoutine(Irp
, IoCompletion
, (PVOID
)Context
, TRUE
, TRUE
, TRUE
);
538 /* mark irp as pending */
539 // IoMarkIrpPending(Irp);
540 /* call the driver */
541 Status
= IoCallDriver(IoGetRelatedDeviceObject(FileObject
), Irp
);