CMiniportWaveCMI Class Reference

#include <minwave.hpp>

Inheritance diagram for CMiniportWaveCMI:

Collaboration diagram for CMiniportWaveCMI:

Public Member Functions
	DECLARE_STD_UNKNOWN ()
	DEFINE_STD_CONSTRUCTOR (CMiniportWaveCMI)
	~CMiniportWaveCMI ()
	STDMETHODIMP_ (void) ServiceWaveISR(UInt32 streamIndex)
	STDMETHODIMP_ (void) powerUp()
	STDMETHODIMP_ (void) powerDown()

Public Attributes
	IMP_IMiniportWaveCyclic
Public Attributes inherited from CUnknown
union {
IUnknown   IUnknown
INonDelegatingUnknown   INonDelegatingUnknown
};
LONG	m_ref_count
PUNKNOWN	m_outer_unknown

Private Member Functions
NTSTATUS	processResources (PRESOURCELIST resourceList)
NTSTATUS	isFormatAllowed (UInt32 sampleRate, BOOLEAN multiChan, BOOLEAN AC3)
NTSTATUS	validateFormat (PKSDATAFORMAT format, ULONG PinID, BOOLEAN capture)
NTSTATUS	newDMAChannel (PDMACHANNEL *dmaChannel, UInt32 bufferLength)
NTSTATUS	loadChannelConfigFromRegistry ()
NTSTATUS	storeChannelConfigToRegistry ()

Private Attributes
PCMIADAPTER	CMIAdapter
PPORTWAVECYCLIC	Port
PDMACHANNEL	DMAChannel [3]
UInt32	notificationInterval
CMI8738Info *	cm
UInt32	requestedChannelCount
UInt32	requestedChannelMask
CMiniportWaveStreamCMI *	stream [3]
bool	isStreamRunning [3]
KMUTEX	mutex

Friends
class	CMiniportWaveStreamCMI
NTSTATUS NTAPI	PropertyHandler_ChannelConfig (PPCPROPERTY_REQUEST PropertyRequest)

Detailed Description

Definition at line 38 of file minwave.hpp.

Constructor & Destructor Documentation

~CMiniportWaveCMI()

CMiniportWaveCMI::~CMiniportWaveCMI

(

void

)

Definition at line 116 of file minwave.cpp.

{
    PAGED_CODE();
    DBGPRINT(("CMiniportWaveCMI[%p]::~CMiniportWaveCMI", this));
 
    storeChannelConfigToRegistry(); //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;
    }
}

Member Function Documentation

DECLARE_STD_UNKNOWN()

CMiniportWaveCMI::DECLARE_STD_UNKNOWN

(

)

DEFINE_STD_CONSTRUCTOR()

CMiniportWaveCMI::DEFINE_STD_CONSTRUCTOR

(

CMiniportWaveCMI

)

isFormatAllowed()

NTSTATUS CMiniportWaveCMI::isFormatAllowed ( UInt32  sampleRate, BOOLEAN  multiChan, BOOLEAN  AC3  )

private

Definition at line 380 of file minwave.cpp.

{
    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;
}

Referenced by validateFormat().

loadChannelConfigFromRegistry()

NTSTATUS CMiniportWaveCMI::loadChannelConfigFromRegistry ( )

private

Definition at line 232 of file minwave.cpp.

{
    PAGED_CODE();
    PREGISTRYKEY       DriverKey;
    PREGISTRYKEY       SettingsKey;
    UNICODE_STRING     KeyName;
    DWORD              ResultLength;
    PVOID              KeyInfo;
 
    DBGPRINT(("CMiniportWaveCMI::loadChannelConfigFromRegistry()"));
 
    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;
}

newDMAChannel()

NTSTATUS CMiniportWaveCMI::newDMAChannel ( PDMACHANNEL *  dmaChannel, UInt32  bufferLength  )

private

Definition at line 61 of file minwave.cpp.

{
    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;
}

processResources()

NTSTATUS CMiniportWaveCMI::processResources ( PRESOURCELIST  resourceList )

private

Definition at line 47 of file minwave.cpp.

{
    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;
}

STDMETHODIMP_() [1/3]

CMiniportWaveCMI::STDMETHODIMP_

(

void

)

STDMETHODIMP_() [2/3]

CMiniportWaveCMI::STDMETHODIMP_

(

void

)

STDMETHODIMP_() [3/3]

CMiniportWaveCMI::STDMETHODIMP_

(

void

)

storeChannelConfigToRegistry()

NTSTATUS CMiniportWaveCMI::storeChannelConfigToRegistry ( )

private

Definition at line 294 of file minwave.cpp.

{
    PAGED_CODE();
    PREGISTRYKEY       DriverKey;
    PREGISTRYKEY       SettingsKey;
    UNICODE_STRING     KeyName;
    DWORD              Value;
    DBGPRINT(("CMiniportWaveCMI::storeChannelConfigToRegistry()"));
 
    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;
}

Referenced by ~CMiniportWaveCMI().

validateFormat()

NTSTATUS CMiniportWaveCMI::validateFormat ( PKSDATAFORMAT  format, ULONG  PinID, BOOLEAN  capture  )

private

Definition at line 413 of file minwave.cpp.

{
    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 != ((ULONG)-1))) {
                    if ((PinID == PIN_WAVE_AC3_RENDER_SINK) && !IoIsWdmVersionAvailable(6,0)) {
                        return STATUS_INVALID_PARAMETER;
                    }
                }
 
                if ( ((waveFormat->wBitsPerSample == 16) || (waveFormat->wBitsPerSample == 32))
                  && ((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 == ((ULONG)-1))) {
                        return isFormatAllowed(waveFormat->nSamplesPerSec, TRUE, FALSE);
                    }
#else
                    return STATUS_INVALID_PARAMETER;
#endif
                }
                break;
            case WAVE_FORMAT_DOLBY_AC3_SPDIF:
                if ((PinID != PIN_WAVE_AC3_RENDER_SINK) && (PinID != ((ULONG)-1))) {
                    return STATUS_INVALID_PARAMETER;
                }
                if ( ((waveFormat->wBitsPerSample >= MIN_BITS_PER_SAMPLE_AC3) && (waveFormat->wBitsPerSample <= MAX_BITS_PER_SAMPLE_AC3))
                  && ((waveFormat->nSamplesPerSec >= MIN_SAMPLE_RATE_AC3) && (waveFormat->nSamplesPerSec <= MAX_SAMPLE_RATE_AC3))
                  && (waveFormat->nChannels == MAX_CHANNELS_AC3) ) {
                    return isFormatAllowed(waveFormat->nSamplesPerSec, FALSE, TRUE);
                }
                break;
            case WAVE_FORMAT_WMA_SPDIF:
                if ((PinID != PIN_WAVE_AC3_RENDER_SINK) && (PinID != ((ULONG)-1))) {
                    return STATUS_INVALID_PARAMETER;
                }
                if ( ((waveFormat->wBitsPerSample >= MIN_BITS_PER_SAMPLE_WMA) && (waveFormat->wBitsPerSample <= MAX_BITS_PER_SAMPLE_WMA))
                  && ((waveFormat->nSamplesPerSec >= MIN_SAMPLE_RATE_WMA) && (waveFormat->nSamplesPerSec <= MAX_SAMPLE_RATE_WMA))
                  && (waveFormat->nChannels == MAX_CHANNELS_WMA) ) {
                    return isFormatAllowed(waveFormat->nSamplesPerSec, FALSE, TRUE);
                }
                break;
        }
    }
 
    return STATUS_INVALID_PARAMETER;
}

Friends And Related Function Documentation

CMiniportWaveStreamCMI

friend class CMiniportWaveStreamCMI

friend

Definition at line 89 of file minwave.hpp.

PropertyHandler_ChannelConfig

NTSTATUS NTAPI PropertyHandler_ChannelConfig ( PPCPROPERTY_REQUEST  PropertyRequest )

friend

Definition at line 847 of file minwave.cpp.

{
    PAGED_CODE();
    ASSERT(PropertyRequest);
    DBGPRINT(("[PropertyHandler_ChannelConfig]"));
 
#ifdef WAVERT
    CMiniportWaveCMI *that = (CMiniportWaveCMI *) ((PMINIPORTWAVERT)PropertyRequest->MajorTarget);
#else
    CMiniportWaveCMI *that = (CMiniportWaveCMI *) ((PMINIPORTWAVECYCLIC)PropertyRequest->MajorTarget);
#endif
 
    if (PropertyRequest->Node == KSNODE_WAVE_DAC) {
 
        if (PropertyRequest->ValueSize == 0) {
            PropertyRequest->ValueSize = sizeof(LONG);
            return STATUS_BUFFER_OVERFLOW;
        } else if (PropertyRequest->ValueSize < sizeof (LONG)) {
            PropertyRequest->ValueSize = 0;
            return STATUS_BUFFER_TOO_SMALL;
        }
 
        if (PropertyRequest->Verb & KSPROPERTY_TYPE_GET) {
            *(PLONG)PropertyRequest->Value = that->requestedChannelMask;
            PropertyRequest->ValueSize = sizeof(ULONG);
            return STATUS_SUCCESS;
        } else if (PropertyRequest->Verb & KSPROPERTY_TYPE_SET) {
            if (*(PLONG)PropertyRequest->Value == KSAUDIO_SPEAKER_7POINT1) {
                that->requestedChannelMask =  *(PLONG)PropertyRequest->Value;
                that->requestedChannelCount = 8;
                return STATUS_SUCCESS;
            }
            if (*(PLONG)PropertyRequest->Value == KSAUDIO_SPEAKER_5POINT1) {
                that->requestedChannelMask =  *(PLONG)PropertyRequest->Value;
                that->requestedChannelCount = 6;
                return STATUS_SUCCESS;
            }
            if ((*(PLONG)PropertyRequest->Value == KSAUDIO_SPEAKER_QUAD) || (*(PLONG)PropertyRequest->Value == KSAUDIO_SPEAKER_SURROUND)) {
                that->requestedChannelMask =  *(PLONG)PropertyRequest->Value;
                that->requestedChannelCount = 4;
                return STATUS_SUCCESS;
            }
            if (*(PLONG)PropertyRequest->Value == KSAUDIO_SPEAKER_STEREO) {
                that->requestedChannelMask =  *(PLONG)PropertyRequest->Value;
                that->requestedChannelCount = 2;
                return STATUS_SUCCESS;
            }
        } else if (PropertyRequest->Verb & KSPROPERTY_TYPE_BASICSUPPORT) {
            PULONG AccessFlags = PULONG(PropertyRequest->Value);
            *AccessFlags = KSPROPERTY_TYPE_BASICSUPPORT | KSPROPERTY_TYPE_GET | KSPROPERTY_TYPE_SET;
            PropertyRequest->ValueSize = sizeof(ULONG);
            return STATUS_SUCCESS;
        }
    }
    return STATUS_INVALID_PARAMETER;
}

Member Data Documentation

cm

CMI8738Info* CMiniportWaveCMI::cm

private

Definition at line 56 of file minwave.hpp.

Referenced by isFormatAllowed(), CMiniportWaveStreamCMI::prepareStream(), CMiniportWaveStreamCMI::setDACChannels(), CMiniportWaveStreamCMI::setupAC3Passthru(), STDMETHODIMP_(), and validateFormat().

CMIAdapter

PCMIADAPTER CMiniportWaveCMI::CMIAdapter

private

Definition at line 48 of file minwave.hpp.

Referenced by loadChannelConfigFromRegistry(), CMiniportWaveStreamCMI::prepareStream(), CMiniportWaveStreamCMI::setDACChannels(), CMiniportWaveStreamCMI::setupAC3Passthru(), CMiniportWaveStreamCMI::setupSPDIFPlayback(), STDMETHODIMP_(), storeChannelConfigToRegistry(), and ~CMiniportWaveCMI().

DMAChannel

PDMACHANNEL CMiniportWaveCMI::DMAChannel[3]

private

Definition at line 53 of file minwave.hpp.

Referenced by ~CMiniportWaveCMI().

IMP_IMiniportWaveCyclic

CMiniportWaveCMI::IMP_IMiniportWaveCyclic

Definition at line 81 of file minwave.hpp.

isStreamRunning

bool CMiniportWaveCMI::isStreamRunning[3]

private

Definition at line 62 of file minwave.hpp.

Referenced by STDMETHODIMP_(), ~CMiniportWaveCMI(), and CMiniportWaveStreamCMI::~CMiniportWaveStreamCMI().

mutex

KMUTEX CMiniportWaveCMI::mutex

private

Definition at line 63 of file minwave.hpp.

Referenced by CMiniportWaveStreamCMI::prepareStream(), CMiniportWaveStreamCMI::setDACChannels(), CMiniportWaveStreamCMI::setupSPDIFPlayback(), and STDMETHODIMP_().

notificationInterval

UInt32 CMiniportWaveCMI::notificationInterval

private

Definition at line 54 of file minwave.hpp.

Referenced by STDMETHODIMP_().

Port

PPORTWAVECYCLIC CMiniportWaveCMI::Port

private

Definition at line 52 of file minwave.hpp.

Referenced by newDMAChannel(), and ~CMiniportWaveCMI().

requestedChannelCount

UInt32 CMiniportWaveCMI::requestedChannelCount

private

Definition at line 57 of file minwave.hpp.

Referenced by loadChannelConfigFromRegistry(), and storeChannelConfigToRegistry().

requestedChannelMask

UInt32 CMiniportWaveCMI::requestedChannelMask

private

Definition at line 58 of file minwave.hpp.

Referenced by loadChannelConfigFromRegistry(), and storeChannelConfigToRegistry().

stream

CMiniportWaveStreamCMI* CMiniportWaveCMI::stream[3]

private

Definition at line 61 of file minwave.hpp.

Referenced by CMiniportWaveStreamCMI::~CMiniportWaveStreamCMI().

---

The documentation for this class was generated from the following files:

• drivers/wdm/audio/drivers/CMIDriver/minwave.hpp
• drivers/wdm/audio/drivers/CMIDriver/minwave.cpp