sup.c File Reference

#include "wdmaud.h"
#include <stdio.h>
#include <debug.h>

Include dependency graph for sup.c:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	TAG_WDMAUD   'DMDW'

Functions
PVOID	AllocateItem (IN POOL_TYPE PoolType, IN SIZE_T NumberOfBytes)
VOID	FreeItem (IN PVOID Item)
ULONG	GetSysAudioDeviceCount (IN PDEVICE_OBJECT DeviceObject)
NTSTATUS	SetIrpIoStatus (IN PIRP Irp, IN NTSTATUS Status, IN ULONG Length)
ULONG	ClosePin (IN PWDMAUD_CLIENT ClientInfo, IN ULONG FilterId, IN ULONG PinId, IN SOUND_DEVICE_TYPE DeviceType)
NTSTATUS	InsertPinHandle (IN PWDMAUD_CLIENT ClientInfo, IN ULONG FilterId, IN ULONG PinId, IN SOUND_DEVICE_TYPE DeviceType, IN HANDLE PinHandle, IN ULONG FreeIndex)
PKEY_VALUE_PARTIAL_INFORMATION	ReadKeyValue (IN HANDLE hSubKey, IN PUNICODE_STRING KeyName)
NTSTATUS	CompareProductName (IN HANDLE hSubKey, IN LPWSTR PnpName, IN ULONG ProductNameSize, OUT LPWSTR ProductName)
NTSTATUS	FindProductName (IN LPWSTR PnpName, IN ULONG ProductNameSize, OUT LPWSTR ProductName)
NTSTATUS	GetSysAudioDevicePnpName (IN PDEVICE_OBJECT DeviceObject, IN ULONG DeviceIndex, OUT LPWSTR *Device)
NTSTATUS	OpenDevice (IN LPWSTR Device, OUT PHANDLE DeviceHandle, OUT PFILE_OBJECT *FileObject)

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 14 of file sup.c.

TAG_WDMAUD

#define TAG_WDMAUD   'DMDW'

Definition at line 17 of file sup.c.

Function Documentation

AllocateItem()

PVOID AllocateItem	(	IN POOL_TYPE	PoolType,
		IN SIZE_T	NumberOfBytes
	)

Definition at line 20 of file sup.c.

{
    PVOID Item = ExAllocatePoolWithTag(PoolType, NumberOfBytes, TAG_WDMAUD);
    if (!Item)
        return Item;
 
    RtlZeroMemory(Item, NumberOfBytes);
    return Item;
}

Referenced by FindProductName(), GetSysAudioDevicePnpName(), InsertPinHandle(), and ReadKeyValue().

ClosePin()

ULONG ClosePin	(	IN PWDMAUD_CLIENT	ClientInfo,
		IN ULONG	FilterId,
		IN ULONG	PinId,
		IN SOUND_DEVICE_TYPE	DeviceType
	)

Definition at line 80 of file sup.c.

{
    ULONG Index;
 
    for(Index = 0; Index < ClientInfo->NumPins; Index++)
    {
        if (ClientInfo->hPins[Index].FilterId == FilterId && ClientInfo->hPins[Index].PinId == PinId && ClientInfo->hPins[Index].Handle && ClientInfo->hPins[Index].Type == DeviceType)
        {
            if (ClientInfo->hPins[Index].Type != MIXER_DEVICE_TYPE)
            {
                ZwClose(ClientInfo->hPins[Index].Handle);
            }
            ClientInfo->hPins[Index].Handle = NULL;
            return Index;
        }
    }
    return MAXULONG;
}

Referenced by CreatePinCallback().

CompareProductName()

NTSTATUS CompareProductName	(	IN HANDLE	hSubKey,
		IN LPWSTR	PnpName,
		IN ULONG	ProductNameSize,
		OUT LPWSTR	ProductName
	)

Definition at line 191 of file sup.c.

{
    PKEY_VALUE_PARTIAL_INFORMATION PartialInformation;
    UNICODE_STRING DriverDescName = RTL_CONSTANT_STRING(L"DriverDesc");
    UNICODE_STRING MatchingDeviceIdName = RTL_CONSTANT_STRING(L"MatchingDeviceId");
    ULONG Length;
    LPWSTR DeviceName;
 
    /* read MatchingDeviceId value */
    PartialInformation = ReadKeyValue(hSubKey, &MatchingDeviceIdName);
 
    if (!PartialInformation)
        return STATUS_UNSUCCESSFUL;
 
 
    /* extract last '&' */
    DeviceName = wcsrchr((LPWSTR)PartialInformation->Data, L'&');
    ASSERT(DeviceName);
    /* terminate it */
    DeviceName[0] = L'\0';
 
    Length = wcslen((LPWSTR)PartialInformation->Data);
 
    DPRINT("DeviceName %S PnpName %S Length %u\n", (LPWSTR)PartialInformation->Data, PnpName, Length);
 
    if (_wcsnicmp((LPWSTR)PartialInformation->Data, &PnpName[4], Length))
    {
        FreeItem(PartialInformation);
        return STATUS_NO_MATCH;
    }
 
    /* free buffer */
    FreeItem(PartialInformation);
 
    /* read DriverDescName value */
    PartialInformation = ReadKeyValue(hSubKey, &DriverDescName);
 
    if (!PartialInformation)
    {
        /* failed to read driver desc key */
        return STATUS_UNSUCCESSFUL;
    }
 
    /* copy key name */
    Length = min(ProductNameSize * sizeof(WCHAR), PartialInformation->DataLength);
    RtlMoveMemory(ProductName, (PVOID)PartialInformation->Data, Length);
 
    /* zero terminate it */
    ProductName[ProductNameSize-1] = L'\0';
 
    /* free buffer */
    FreeItem(PartialInformation);
 
    return STATUS_SUCCESS;
}

Referenced by FindProductName().

FindProductName()

NTSTATUS FindProductName	(	IN LPWSTR	PnpName,
		IN ULONG	ProductNameSize,
		OUT LPWSTR	ProductName
	)

Definition at line 254 of file sup.c.

{
    UNICODE_STRING KeyName = RTL_CONSTANT_STRING(L"\\Registry\\Machine\\System\\CurrentControlSet\\Control\\Class\\{4D36E96C-E325-11CE-BFC1-08002BE10318}");
 
    UNICODE_STRING SubKeyName;
    WCHAR SubKey[20];
    OBJECT_ATTRIBUTES ObjectAttributes;
    HANDLE hKey, hSubKey;
    NTSTATUS Status;
    ULONG Length, Index;
    PKEY_FULL_INFORMATION KeyInformation;
 
    for(Index = 0; Index < wcslen(PnpName); Index++)
    {
        if (PnpName[Index] == '#')
            PnpName[Index] = L'\\';
    }
 
 
    /* initialize key attributes */
    InitializeObjectAttributes(&ObjectAttributes, &KeyName, OBJ_CASE_INSENSITIVE | OBJ_KERNEL_HANDLE | OBJ_OPENIF, NULL, NULL);
 
    /* open the key */
    Status = ZwOpenKey(&hKey, GENERIC_READ, &ObjectAttributes);
 
    /* check for success */
    if (!NT_SUCCESS(Status))
        return Status;
 
    /* query num of subkeys */
    Status = ZwQueryKey(hKey, KeyFullInformation, NULL, 0, &Length);
 
    if (Status != STATUS_BUFFER_TOO_SMALL)
    {
        DPRINT1("ZwQueryKey failed with %x\n", Status);
        /* failed */
        ZwClose(hKey);
        return Status;
    }
 
    /* allocate key information struct */
    KeyInformation = AllocateItem(NonPagedPool, Length);
    if (!KeyInformation)
    {
        /* no memory */
        ZwClose(hKey);
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    /* query num of subkeys */
    Status = ZwQueryKey(hKey, KeyFullInformation, (PVOID)KeyInformation, Length, &Length);
 
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("ZwQueryKey failed with %x\n", Status);
        FreeItem(KeyInformation);
        ZwClose(hKey);
        return Status;
    }
 
    /* now iterate through all subkeys */
    for(Index = 0; Index < KeyInformation->SubKeys; Index++)
    {
        /* subkeys are always in the format 0000-XXXX */
        swprintf(SubKey, L"%04u", Index);
 
        /* initialize subkey name */
        RtlInitUnicodeString(&SubKeyName, SubKey);
 
        /* initialize key attributes */
        InitializeObjectAttributes(&ObjectAttributes, &SubKeyName, OBJ_CASE_INSENSITIVE | OBJ_KERNEL_HANDLE | OBJ_OPENIF, hKey, NULL);
 
        /* open the sub key */
        Status = ZwOpenKey(&hSubKey, GENERIC_READ, &ObjectAttributes);
 
        /* check for success */
        if (NT_SUCCESS(Status))
        {
            /* compare product name */
            Status = CompareProductName(hSubKey, PnpName, ProductNameSize, ProductName);
 
            /* close subkey */
            ZwClose(hSubKey);
 
            if (NT_SUCCESS(Status))
                break;
        }
    }
 
    /* free buffer */
    FreeItem(KeyInformation);
 
    /* close key */
    ZwClose(hKey);
 
    /* no matching key found */
    return Status;
}

FreeItem()

VOID FreeItem

(

IN PVOID

Item

)

Definition at line 33 of file sup.c.

{
    ExFreePool(Item);
}

Referenced by CompareProductName(), FindProductName(), GetSysAudioDevicePnpName(), InsertPinHandle(), and ReadKeyValue().

GetSysAudioDeviceCount()

ULONG GetSysAudioDeviceCount

(

IN PDEVICE_OBJECT

DeviceObject

)

Definition at line 42 of file sup.c.

{
    PWDMAUD_DEVICE_EXTENSION DeviceExtension;
    KSPROPERTY Pin;
    ULONG Count, BytesReturned;
    NTSTATUS Status;
 
    /* setup the query request */
    Pin.Set = KSPROPSETID_Sysaudio;
    Pin.Id = KSPROPERTY_SYSAUDIO_DEVICE_COUNT;
    Pin.Flags = KSPROPERTY_TYPE_GET;
 
    DeviceExtension = (PWDMAUD_DEVICE_EXTENSION)DeviceObject->DeviceExtension;
 
    /* query sysaudio for the device count */
    Status = KsSynchronousIoControlDevice(DeviceExtension->FileObject, KernelMode, IOCTL_KS_PROPERTY, (PVOID)&Pin, sizeof(KSPROPERTY), (PVOID)&Count, sizeof(ULONG), &BytesReturned);
    if (!NT_SUCCESS(Status))
        return 0;
 
    return Count;
}

Referenced by Enum(), GetSysAudioDevicePnpName(), WdmAudCloseAllMixers(), and WdmAudInitWorkerRoutine().

GetSysAudioDevicePnpName()

NTSTATUS GetSysAudioDevicePnpName	(	IN PDEVICE_OBJECT	DeviceObject,
		IN ULONG	DeviceIndex,
		OUT LPWSTR *	Device
	)

Definition at line 357 of file sup.c.

{
    ULONG BytesReturned;
    KSP_PIN Pin;
    NTSTATUS Status;
    PWDMAUD_DEVICE_EXTENSION DeviceExtension;
 
   /* first check if the device index is within bounds */
   if (DeviceIndex >= GetSysAudioDeviceCount(DeviceObject))
       return STATUS_INVALID_PARAMETER;
 
    /* setup the query request */
    Pin.Property.Set = KSPROPSETID_Sysaudio;
    Pin.Property.Id = KSPROPERTY_SYSAUDIO_DEVICE_INTERFACE_NAME;
    Pin.Property.Flags = KSPROPERTY_TYPE_GET;
    Pin.PinId = DeviceIndex;
 
    DeviceExtension = (PWDMAUD_DEVICE_EXTENSION)DeviceObject->DeviceExtension;
 
    /* query sysaudio for the device path */
    Status = KsSynchronousIoControlDevice(DeviceExtension->FileObject, KernelMode, IOCTL_KS_PROPERTY, (PVOID)&Pin, sizeof(KSPROPERTY) + sizeof(ULONG), NULL, 0, &BytesReturned);
 
    /* check if the request failed */
    if (Status != STATUS_BUFFER_TOO_SMALL || BytesReturned == 0)
        return STATUS_UNSUCCESSFUL;
 
    /* allocate buffer for the device */
    *Device = AllocateItem(NonPagedPool, BytesReturned);
    if (!Device)
        return STATUS_INSUFFICIENT_RESOURCES;
 
    /* query sysaudio again for the device path */
    Status = KsSynchronousIoControlDevice(DeviceExtension->FileObject, KernelMode, IOCTL_KS_PROPERTY, (PVOID)&Pin, sizeof(KSPROPERTY) + sizeof(ULONG), (PVOID)*Device, BytesReturned, &BytesReturned);
 
    if (!NT_SUCCESS(Status))
    {
        /* failed */
        FreeItem(*Device);
        return Status;
    }
 
    return Status;
}

Referenced by Enum().

InsertPinHandle()

NTSTATUS InsertPinHandle	(	IN PWDMAUD_CLIENT	ClientInfo,
		IN ULONG	FilterId,
		IN ULONG	PinId,
		IN SOUND_DEVICE_TYPE	DeviceType,
		IN HANDLE	PinHandle,
		IN ULONG	FreeIndex
	)

Definition at line 104 of file sup.c.

{
    PWDMAUD_HANDLE Handles;
 
    if (FreeIndex != MAXULONG)
    {
        /* re-use a free index */
        ClientInfo->hPins[FreeIndex].Handle = PinHandle;
        ClientInfo->hPins[FreeIndex].FilterId = FilterId;
        ClientInfo->hPins[FreeIndex].PinId = PinId;
        ClientInfo->hPins[FreeIndex].Type = DeviceType;
 
        return STATUS_SUCCESS;
    }
 
    Handles = AllocateItem(NonPagedPool, sizeof(WDMAUD_HANDLE) * (ClientInfo->NumPins+1));
 
    if (!Handles)
        return STATUS_INSUFFICIENT_RESOURCES;
 
    if (ClientInfo->NumPins)
    {
        RtlMoveMemory(Handles, ClientInfo->hPins, sizeof(WDMAUD_HANDLE) * ClientInfo->NumPins);
        FreeItem(ClientInfo->hPins);
    }
 
    ClientInfo->hPins = Handles;
    ClientInfo->hPins[ClientInfo->NumPins].Handle = PinHandle;
    ClientInfo->hPins[ClientInfo->NumPins].Type = DeviceType;
    ClientInfo->hPins[ClientInfo->NumPins].FilterId = FilterId;
    ClientInfo->hPins[ClientInfo->NumPins].PinId = PinId;
    ClientInfo->NumPins++;
 
    return STATUS_SUCCESS;
}

Referenced by CreatePinCallback().

OpenDevice()

NTSTATUS OpenDevice	(	IN LPWSTR	Device,
		OUT PHANDLE	DeviceHandle,
		OUT PFILE_OBJECT *	FileObject
	)

Definition at line 405 of file sup.c.

{
    NTSTATUS Status;
    HANDLE hDevice;
 
    /* now open the device */
    Status = WdmAudOpenSysAudioDevice(Device, &hDevice);
 
    if (!NT_SUCCESS(Status))
    {
        return Status;
    }
 
    *DeviceHandle = hDevice;
 
    if (FileObject)
    {
        Status = ObReferenceObjectByHandle(hDevice, FILE_READ_DATA | FILE_WRITE_DATA, *IoFileObjectType, KernelMode, (PVOID*)FileObject, NULL);
 
        if (!NT_SUCCESS(Status))
        {
            ZwClose(hDevice);
        }
    }
 
    return Status;
 
}

ReadKeyValue()

PKEY_VALUE_PARTIAL_INFORMATION ReadKeyValue	(	IN HANDLE	hSubKey,
		IN PUNICODE_STRING	KeyName
	)

Definition at line 147 of file sup.c.

{
    NTSTATUS Status;
    ULONG Length;
    PKEY_VALUE_PARTIAL_INFORMATION PartialInformation;
 
    /* now query MatchingDeviceId key */
    Status = ZwQueryValueKey(hSubKey, KeyName, KeyValuePartialInformation, NULL, 0, &Length);
 
    /* check for success */
    if (Status != STATUS_BUFFER_TOO_SMALL)
        return NULL;
 
    /* allocate a buffer for key data */
    PartialInformation = AllocateItem(NonPagedPool, Length);
 
    if (!PartialInformation)
        return NULL;
 
 
    /* now query MatchingDeviceId key */
    Status = ZwQueryValueKey(hSubKey, KeyName, KeyValuePartialInformation, PartialInformation, Length, &Length);
 
    /* check for success */
    if (!NT_SUCCESS(Status))
    {
        FreeItem(PartialInformation);
        return NULL;
    }
 
    if (PartialInformation->Type != REG_SZ)
    {
        /* invalid key type */
        FreeItem(PartialInformation);
        return NULL;
    }
 
    return PartialInformation;
}

Referenced by CompareProductName().

SetIrpIoStatus()

NTSTATUS SetIrpIoStatus	(	IN PIRP	Irp,
		IN NTSTATUS	Status,
		IN ULONG	Length
	)

Definition at line 67 of file sup.c.

{
    Irp->IoStatus.Information = Length;
    Irp->IoStatus.Status = Status;
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
    return Status;
 
}

Referenced by HandleSysAudioFilterPinProperties(), SysAudioHandleProperty(), SysAudioOpenVirtualDevice(), WdmAudCapabilities(), WdmAudControlCloseMixer(), WdmAudControlDeviceState(), WdmAudControlDeviceType(), WdmAudControlOpen(), WdmAudControlOpenMidi(), WdmAudControlOpenMixer(), WdmAudControlOpenWave(), WdmAudDeviceControl(), WdmAudFrameSize(), WdmAudGetControlDetails(), WdmAudGetDeviceInterface(), WdmAudGetLineControls(), WdmAudGetLineInfo(), WdmAudGetMixerEvent(), WdmAudIoctlClose(), WdmAudReadWrite(), WdmAudResetStream(), and WdmAudSetControlDetails().