minwave.cpp

C-Media8738/8768声卡驱动开发源码

/*
Copyright (c) 2006-2007 dogbert <[e-mail]>
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products
   derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#include "minwave.hpp"
#include "minwavetables.hpp"
#include "ntddk.h"

#pragma code_seg("PAGE")

NTSTATUS CreateMiniportWaveCMI(PUNKNOWN *Unknown, REFCLSID, PUNKNOWN UnknownOuter, POOL_TYPE PoolType)
{
	PAGED_CODE();
	ASSERT(Unknown);
#ifdef WAVERT
	STD_CREATE_BODY_(CMiniportWaveCMI,Unknown,UnknownOuter,PoolType,PMINIPORTWAVERT);
#else
	STD_CREATE_BODY_(CMiniportWaveCMI,Unknown,UnknownOuter,PoolType,PMINIPORTWAVECYCLIC);
#endif
}

NTSTATUS CMiniportWaveCMI::processResources(PRESOURCELIST resourceList)
{
	PAGED_CODE();
	ASSERT (resourceList);
	DBGPRINT(("CMiniportWaveCMI[%p]::ProcessResources(%p)", this, resourceList));

	if (resourceList->NumberOfInterrupts() < 1) {
		DBGPRINT(("Unknown configuration for wave miniport"));
		return STATUS_DEVICE_CONFIGURATION_ERROR;
	}
	return STATUS_SUCCESS;
}

#ifndef WAVERT
NTSTATUS CMiniportWaveCMI::newDMAChannel(PDMACHANNEL *dmaChannel, UInt32 bufferLength)
{
	PAGED_CODE();
	ASSERT(dmaChannel);
	DBGPRINT(("CMiniportWaveCMI[%p]::newDMAChannel(%p)", this, dmaChannel));

	NTSTATUS ntStatus;

	ntStatus = Port->NewMasterDmaChannel(dmaChannel, NULL, NULL, bufferLength, TRUE, FALSE, (DMA_WIDTH)(-1), (DMA_SPEED)(-1));
	if (NT_SUCCESS(ntStatus)) {
		ULONG  lDMABufferLength = bufferLength;
		do {
			ntStatus = (*dmaChannel)->AllocateBuffer(lDMABufferLength,NULL);
			lDMABufferLength >>= 1;
		} while (!NT_SUCCESS(ntStatus) && (lDMABufferLength > (PAGE_SIZE / 2)));
	}
	return ntStatus;
}
#endif

//generic crap
STDMETHODIMP CMiniportWaveCMI::NonDelegatingQueryInterface(REFIID Interface, PVOID *Object)
{
	PAGED_CODE();
	ASSERT(Object);
	DBGPRINT(("CMiniportWaveCMI[%p]::NonDelegatingQueryInterface"));

	if (IsEqualGUIDAligned(Interface,IID_IUnknown)) {
#ifdef WAVERT
		*Object = PVOID(PUNKNOWN(PMINIPORTWAVERT(this)));
#else
		*Object = PVOID(PUNKNOWN(PMINIPORTWAVECYCLIC(this)));
#endif
	} else if (IsEqualGUIDAligned(Interface,IID_IMiniport)) {
		*Object = PVOID(PMINIPORT(this));
#ifdef WAVERT
	} else if (IsEqualGUIDAligned(Interface,IID_IMiniportWaveRT)) {
		*Object = PVOID(PMINIPORTWAVERT(this));
#else
	} else if (IsEqualGUIDAligned(Interface,IID_IMiniportWaveCyclic)) {
		*Object = PVOID(PMINIPORTWAVECYCLIC(this));
#endif
	} else {
		*Object = NULL;
	}

	if (*Object) {
		// We reference the interface for the caller.
		PUNKNOWN(*Object)->AddRef();
		return STATUS_SUCCESS;
	}

	return STATUS_INVALID_PARAMETER;
}

CMiniportWaveCMI::~CMiniportWaveCMI(void)
{
	PAGED_CODE();
	DBGPRINT(("CMiniportWaveCMI[%p]::~CMiniportWaveCMI", this));

	SaveChannelConfig(); //or not. during system shutdown, this doesn't seem to work.

	if (CMIAdapter) {
		CMIAdapter->Release();
		CMIAdapter = NULL;
	}

	for (int i=0;i<3;i++) {
#ifndef WAVERT
		if (DMAChannel[i]) {
			DMAChannel[i]->Release();
			DMAChannel[i] = NULL;
		}
#endif
    	if (isStreamRunning[i]) {
			isStreamRunning[i] = false;
			stream[i]->Release();
			stream[i] = NULL;
		}
	}

	if (Port) {
		Port->Release();
		Port = NULL;
	}
}

#ifdef WAVERT
STDMETHODIMP CMiniportWaveCMI::Init(PUNKNOWN UnknownAdapter, PRESOURCELIST ResourceList, PPORTWAVERT Port_)
#else
STDMETHODIMP CMiniportWaveCMI::Init(PUNKNOWN UnknownAdapter, PRESOURCELIST ResourceList, PPORTWAVECYCLIC Port_)
#endif
{
	PAGED_CODE();

	ASSERT(UnknownAdapter);
	ASSERT(ResourceList);
	ASSERT(Port_);

	DBGPRINT(("CMiniportWaveCMI[%p]::Init(%p, %p, %p)", this, UnknownAdapter, ResourceList, Port_));

	Port = Port_;
	Port->AddRef();

	NTSTATUS ntStatus = UnknownAdapter->QueryInterface(IID_ICMIAdapter, (PVOID *) &CMIAdapter);
    if (!NT_SUCCESS(ntStatus)) {
	    DBGPRINT(("QueryInterface(CMIAdapter) failed"));
		return ntStatus;
	}

	//check for Vista, set the AC3 stuff accordingly
	if (IoIsWdmVersionAvailable(0x06,0x00)) {
		WavePinDataRangesAC3Stream[1].MinimumSampleFrequency = MIN_SAMPLE_RATE;
		WavePinDataRangesAC3Stream[1].MaximumSampleFrequency = MAX_SAMPLE_RATE;
		WavePinDataRangesAC3Stream[1].DataRange.SubFormat    = KSDATAFORMAT_SUBTYPE_PCM;
		WavePinDataRangesAC3Stream[1].DataRange.Specifier    = KSDATAFORMAT_SPECIFIER_WAVEFORMATEX;
	}

	cm = CMIAdapter->getCMI8738Info();
	cm->regFUNCTRL0  = 0;
	cm->WaveMiniport = this;

	LoadChannelConfig();

	for (int i=0;i<3;i++)
	{
		isStreamRunning[i] = false;

#ifndef WAVERT
		ntStatus = newDMAChannel(&DMAChannel[i], MAXLEN_DMA_BUFFER);
		if (!NT_SUCCESS(ntStatus)) {
			DBGPRINT(("NewDmaChannel() failed"));
			return ntStatus;
		}
#endif
	}

	KeInitializeMutex(&mutex, 1);

	return processResources(ResourceList);
}

#ifdef WAVERT
STDMETHODIMP_(NTSTATUS) CMiniportWaveCMI::GetDeviceDescription(PDEVICE_DESCRIPTION OutDeviceDescriptor)
{
	PAGED_CODE();
	ASSERT(OutDeviceDescriptor);
	DBGPRINT(("CMiniportWaveCMI[%p]::GetDeviceDescription(%p)", this, OutDeviceDescriptor));

	RtlZeroMemory(OutDeviceDescriptor, sizeof(DEVICE_DESCRIPTION));
	OutDeviceDescriptor->ScatterGather     = false;
	OutDeviceDescriptor->Master            = true;
	OutDeviceDescriptor->Dma32BitAddresses = true;
	OutDeviceDescriptor->InterfaceType     = PCIBus;
	OutDeviceDescriptor->MaximumLength     = MAXLEN_DMA_BUFFER-2;

	return STATUS_SUCCESS;
}
#endif

STDMETHODIMP CMiniportWaveCMI::GetDescription(PPCFILTER_DESCRIPTOR *OutFilterDescriptor)
{
    PAGED_CODE();
    ASSERT(OutFilterDescriptor);
    DBGPRINT(("CMiniportWaveCMI[%p]::GetDescription(%p)", this, OutFilterDescriptor));

    *OutFilterDescriptor = &WaveMiniportFilterDescriptor;

    return STATUS_SUCCESS;
}

NTSTATUS CMiniportWaveCMI::LoadChannelConfig()
{
	PREGISTRYKEY       DriverKey;
	PREGISTRYKEY       SettingsKey;
    UNICODE_STRING     KeyName;
    DWORD              Value, ResultLength;
	PVOID              KeyInfo;

    DBGPRINT(("CMiniportWaveCMI::LoadChannelConfig"));

	if ((!CMIAdapter) || (!(CMIAdapter->getDeviceObject()))) {
		return STATUS_UNSUCCESSFUL;
	}

	NTSTATUS ntStatus = PcNewRegistryKey(&DriverKey, NULL, DriverRegistryKey, KEY_ALL_ACCESS, CMIAdapter->getDeviceObject(), NULL, NULL, 0, NULL);

	if(!NT_SUCCESS(ntStatus)) {
		DBGPRINT(("PcNewRegistryKey() failed"));
		return STATUS_UNSUCCESSFUL;
	}

	RtlInitUnicodeString(&KeyName, L"Settings");

	ntStatus = DriverKey->NewSubKey(&SettingsKey, NULL, KEY_ALL_ACCESS, &KeyName, REG_OPTION_NON_VOLATILE, NULL);
	if(!NT_SUCCESS(ntStatus)) {
		DBGPRINT(("DriverKey->NewSubKey() failed"));
		return STATUS_UNSUCCESSFUL;
	}

	KeyInfo = ExAllocatePoolWithTag(PagedPool, sizeof(KEY_VALUE_PARTIAL_INFORMATION) + sizeof(DWORD), 'gnaa');
	if (KeyInfo) {
		RtlInitUnicodeString(&KeyName, L"ChannelCount");
		ntStatus = SettingsKey->QueryValueKey(&KeyName, KeyValuePartialInformation, KeyInfo, sizeof(KEY_VALUE_PARTIAL_INFORMATION) + sizeof(DWORD), &ResultLength);
		if (NT_SUCCESS (ntStatus)) {
        	PKEY_VALUE_PARTIAL_INFORMATION PartialInfo = (PKEY_VALUE_PARTIAL_INFORMATION)KeyInfo;
			if (PartialInfo->DataLength == sizeof(DWORD)) {
				requestedChannelCount = (*(PLONG)PartialInfo->Data);
			}
		} else {
			requestedChannelCount = 2;
		}

		RtlInitUnicodeString(&KeyName, L"ChannelMask");
		ntStatus = SettingsKey->QueryValueKey(&KeyName, KeyValuePartialInformation, KeyInfo, sizeof(KEY_VALUE_PARTIAL_INFORMATION) + sizeof(DWORD), &ResultLength);
		if (NT_SUCCESS (ntStatus)) {
        	PKEY_VALUE_PARTIAL_INFORMATION PartialInfo = (PKEY_VALUE_PARTIAL_INFORMATION)KeyInfo;
			if (PartialInfo->DataLength == sizeof(DWORD)) {
				requestedChannelMask = (*(PLONG)PartialInfo->Data);
			}
		} else {
			requestedChannelMask = KSAUDIO_SPEAKER_STEREO;
		}
	}
	ExFreePoolWithTag(KeyInfo,'gnaa');

	SettingsKey->Release();
	DriverKey->Release();

	return STATUS_SUCCESS;
}

NTSTATUS CMiniportWaveCMI::SaveChannelConfig()
{
	PREGISTRYKEY       DriverKey;
	PREGISTRYKEY       SettingsKey;
    UNICODE_STRING     KeyName;
    DWORD              Value;
    DBGPRINT(("CMiniportWaveCMI::SaveChannelConfig"));

	if ((!CMIAdapter) || (!(CMIAdapter->getDeviceObject()))) {
		return STATUS_UNSUCCESSFUL;
	}

	NTSTATUS ntStatus = PcNewRegistryKey(&DriverKey, NULL, DriverRegistryKey, KEY_ALL_ACCESS, CMIAdapter->getDeviceObject(), NULL, NULL, 0, NULL);

	if(!NT_SUCCESS(ntStatus)) {
		DBGPRINT(("PcNewRegistryKey() failed"));
		return STATUS_UNSUCCESSFUL;
	}

	RtlInitUnicodeString(&KeyName, L"Settings");

	ntStatus = DriverKey->NewSubKey(&SettingsKey, NULL, KEY_ALL_ACCESS, &KeyName, REG_OPTION_NON_VOLATILE, NULL);
	if(!NT_SUCCESS(ntStatus)) {
		DBGPRINT(("DriverKey->NewSubKey() failed"));
		return STATUS_UNSUCCESSFUL;
	}

	Value = requestedChannelCount;
	RtlInitUnicodeString(&KeyName, L"ChannelCount");
	ntStatus = SettingsKey->SetValueKey(&KeyName, REG_DWORD, PVOID(&Value), sizeof(DWORD));
	if (!NT_SUCCESS(ntStatus)) {
		DBGPRINT(("SetValueKey() failed"));
	}
	Value = requestedChannelMask;
	RtlInitUnicodeString(&KeyName, L"ChannelMask");
	ntStatus = SettingsKey->SetValueKey(&KeyName, REG_DWORD, PVOID(&Value), sizeof(DWORD));
	if (!NT_SUCCESS(ntStatus)) {
		DBGPRINT(("SetValueKey() failed"));
	}

	SettingsKey->Release();
	DriverKey->Release();

	return STATUS_SUCCESS;
}

NTSTATUS CMiniportWaveCMI::isFormatAllowed(UInt32 sampleRate, BOOLEAN multiChan, BOOLEAN AC3)
{
	PAGED_CODE();
	ASSERT(sampleRate);
	DBGPRINT(("CMiniportWaveCMI[%p]::isFormatAllowed(%d, %d, %d)", this, sampleRate, multiChan, AC3));

	if (multiChan) {
		switch (sampleRate) {
			case 44100: if (cm->formatMask & FMT_441_MULTI_PCM) return STATUS_SUCCESS; break;
			case 48000: if (cm->formatMask & FMT_480_MULTI_PCM) return STATUS_SUCCESS; break;
			case 88200: if (cm->formatMask & FMT_882_MULTI_PCM) return STATUS_SUCCESS; break;
			case 96000: if (cm->formatMask & FMT_960_MULTI_PCM) return STATUS_SUCCESS; break;
		}
		return STATUS_INVALID_PARAMETER;
	}
	if (AC3) {
		switch (sampleRate) {
			case 44100: if (cm->formatMask & FMT_441_DOLBY) return STATUS_SUCCESS; break;
			case 48000: if (cm->formatMask & FMT_480_DOLBY) return STATUS_SUCCESS; break;
			case 88200: if (cm->formatMask & FMT_882_DOLBY) return STATUS_SUCCESS; break;
			case 96000: if (cm->formatMask & FMT_960_DOLBY) return STATUS_SUCCESS; break;
		}
		return STATUS_INVALID_PARAMETER;
	}
	switch (sampleRate) {
		case 44100: if (cm->formatMask & FMT_441_PCM) return STATUS_SUCCESS; break;
		case 48000: if (cm->formatMask & FMT_480_PCM) return STATUS_SUCCESS; break;
		case 88200: if (cm->formatMask & FMT_882_PCM) return STATUS_SUCCESS; break;
		case 96000: if (cm->formatMask & FMT_960_PCM) return STATUS_SUCCESS; break;
	}
	return STATUS_INVALID_PARAMETER;
}

NTSTATUS CMiniportWaveCMI::validateFormat(PKSDATAFORMAT format, ULONG PinID, BOOLEAN capture)
{
	PAGED_CODE();
	ASSERT(format);
	DBGPRINT(("CMiniportWaveCMI[%p]::validateFormat(%p, %d, %d)", this, format, PinID, capture));

	PWAVEFORMATEX waveFormat = PWAVEFORMATEX(format + 1);
	DBGPRINT(("---channels: %d, resolution: %d, sample rate: %d, pin: %d, formatMask: %x", waveFormat->nChannels, waveFormat->wBitsPerSample, waveFormat->nSamplesPerSec, PinID, cm->formatMask));

//WaveFormatEx
	if  ( ( format->FormatSize >= sizeof(KSDATAFORMAT_WAVEFORMATEX))
	  && IsEqualGUIDAligned(format->MajorFormat,KSDATAFORMAT_TYPE_AUDIO)
	  && IsEqualGUIDAligned(format->Specifier,KSDATAFORMAT_SPECIFIER_WAVEFORMATEX) ) {
		switch (EXTRACT_WAVEFORMATEX_ID(&format->SubFormat)) {
			case WAVE_FORMAT_PCM:
				if ((PinID != PIN_WAVE_RENDER_SINK) && (PinID != PIN_WAVE_CAPTURE_SOURCE) && (PinID != -1)) {
					if ((PinID == PIN_WAVE_AC3_RENDER_SINK) && !IoIsWdmVersionAvailable(6,0)) {
						return STATUS_INVALID_PARAMETER;
					}
				}

				if ( ((waveFormat->wBitsPerSample == 16) || (waveFormat->wBitsPerSample == 24))
				  && ((waveFormat->nSamplesPerSec == 44100) || (waveFormat->nSamplesPerSec == 48000) || (waveFormat->nSamplesPerSec == 88200) ||  (waveFormat->nSamplesPerSec == 96000))
				  && (waveFormat->nChannels == 2) ) {
					if ((capture) && (waveFormat->nSamplesPerSec > 48000) ) {
						return STATUS_INVALID_PARAMETER;
					}
					return isFormatAllowed(waveFormat->nSamplesPerSec, FALSE, FALSE);
				}
				if ( (waveFormat->wBitsPerSample == 16)
				  && ((waveFormat->nChannels >= 4) && (waveFormat->nChannels <= cm->maxChannels))
				  && ((waveFormat->nSamplesPerSec == 44100) || (waveFormat->nSamplesPerSec == 48000)) ) {
#if OUT_CHANNEL == 1
					if ((PinID == PIN_WAVE_RENDER_SINK) || (PinID == -1)) {
						return isFormatAllowed(waveFormat->nSamplesPerSec, TRUE, FALSE);
					}
#else
					return STATUS_INVALID_PARAMETER;