CAC97AdapterCommon Class Reference

#include <common.h>

Inheritance diagram for CAC97AdapterCommon:

Collaboration diagram for CAC97AdapterCommon:

Public Member Functions
	DECLARE_STD_UNKNOWN ()
	DEFINE_STD_CONSTRUCTOR (CAC97AdapterCommon)
	~CAC97AdapterCommon ()
	STDMETHODIMP_ (NTSTATUS) Init(IN PRESOURCELIST ResourceList
	STDMETHODIMP_ (BOOL) GetPinConfig(IN TopoPinConfig pin)
	STDMETHODIMP_ (void) SetPinConfig(IN TopoPinConfig pin
	STDMETHODIMP_ (BOOL) GetNodeConfig(IN TopoNodeConfig node)
	STDMETHODIMP_ (void) SetNodeConfig(IN TopoNodeConfig node
	STDMETHODIMP_ (AC97Register) GetNodeReg(IN TopoNodes node)
	STDMETHODIMP_ (WORD) GetNodeMask(IN TopoNodes node)
	STDMETHODIMP_ (NTSTATUS) ReadCodecRegister(_In_range_(0
	STDMETHODIMP_ (NTSTATUS) WriteCodecRegister(_In_range_(0
	STDMETHODIMP_ (UCHAR) ReadBMControlRegister8(IN ULONG ulOffset)
	STDMETHODIMP_ (USHORT) ReadBMControlRegister16(IN ULONG ulOffset)
	STDMETHODIMP_ (ULONG) ReadBMControlRegister32(IN ULONG ulOffset)
	STDMETHODIMP_ (void) WriteBMControlRegister(IN ULONG ulOffset
	STDMETHODIMP_ (void) WriteBMControlRegister(IN ULONG ulOffset
	STDMETHODIMP_ (void) WriteBMControlRegister(IN ULONG ulOffset
	STDMETHODIMP_ (NTSTATUS) RestoreCodecRegisters()
	STDMETHODIMP_ (NTSTATUS) ProgramSampleRate(IN AC97Register Register
	STDMETHODIMP_ (void) SetMiniportTopology(PAC97MINIPORTTOPOLOGY topo)
	STDMETHODIMP_ (PAC97MINIPORTTOPOLOGY) GetMiniportTopology(void)
	STDMETHODIMP_ (void) ReadChannelConfigDefault(PDWORD pdwChannelConfig
	STDMETHODIMP_ (void) WriteChannelConfigDefault(DWORD dwChannelConfig)

Public Attributes
	IMP_IAdapterPowerManagement
IN PDEVICE_OBJECT	DeviceObject
IN BOOL	config
AC97REG_INVALID AC97Register	Register
AC97REG_INVALID AC97Register _Out_ PWORD	wData
AC97REG_INVALID AC97Register _In_ WORD	wData
AC97REG_INVALID AC97Register _In_ WORD _In_ WORD	wMask
IN UCHAR	Value
IN USHORT	Value
IN ULONG	Value
IN DWORD	dwSampleRate
PWORD	pwChannels
Public Attributes inherited from CUnknown
union {
IUnknown   IUnknown
INonDelegatingUnknown   INonDelegatingUnknown
};
LONG	m_ref_count
PUNKNOWN	m_outer_unknown

Private Member Functions
NTSTATUS	InitAC97 (void)
NTSTATUS	ProbeHWConfig (void)
NTSTATUS	Check6thBitSupport (IN AC97Register, IN TopoNodeConfig)
BOOL	DisableAC97Pin (IN TopoPinConfig)
NTSTATUS	SetAC97Default (void)
NTSTATUS	AcquireCodecSemiphore (void)
NTSTATUS	PrimaryCodecReady (void)
NTSTATUS	PowerUpCodec (void)
NTSTATUS	ReadNABMCtrlRegs (void)
NTSTATUS	RestoreNABMCtrlRegs (void)

Private Attributes
PDEVICE_OBJECT	m_pDeviceObject
PWORD	m_pCodecBase
PUCHAR	m_pBusMasterBase
BOOL	m_bDirectRead
DEVICE_POWER_STATE	m_PowerState
PAC97MINIPORTTOPOLOGY	m_Topology

Static Private Attributes
static tAC97Registers	m_stAC97Registers [64]
static tHardwareConfig	m_stHardwareConfig

Friends
NTSTATUS	NewAdapterCommon (OUT PADAPTERCOMMON *OutAdapterCommon, IN PRESOURCELIST ResourceList)

Detailed Description

Definition at line 87 of file common.h.

Constructor & Destructor Documentation

~CAC97AdapterCommon()

CAC97AdapterCommon::~CAC97AdapterCommon

(

)

Definition at line 235 of file common.cpp.

{
    PAGED_CODE ();
 
    DOUT (DBG_PRINT, ("[CAC97AdapterCommon::~CAC97AdapterCommon]"));
}

Member Function Documentation

AcquireCodecSemiphore()

NTSTATUS CAC97AdapterCommon::AcquireCodecSemiphore ( void  )

private

Definition at line 1062 of file common.cpp.

{
    PAGED_CODE ();
 
    DOUT (DBG_PRINT, ("[CAC97AdapterCommon::AcquireCodecSemiphore]"));
 
    ULONG ulCount = 0;
    while (READ_PORT_UCHAR (m_pBusMasterBase + CAS) & CAS_CAS)
    {
        //
        // Do we want to give up??
        //
        if (ulCount++ > 100)
        {
            DOUT (DBG_ERROR, ("Cannot acquire semaphore."));
            return STATUS_IO_TIMEOUT;
        }
 
        //
        // Let's wait a little, 40us and then try again.
        //
        KeStallExecutionProcessor (40L);
    }
 
    return STATUS_SUCCESS;
}

Check6thBitSupport()

NTSTATUS CAC97AdapterCommon::Check6thBitSupport ( IN AC97Register  AC97Reg, IN TopoNodeConfig  Config  )

private

Definition at line 576 of file common.cpp.

{
    PAGED_CODE();
 
    NTSTATUS    ntStatus;
    WORD        wCodecReg;
    WORD        wOriginal;
 
    // Read the current value.
    ntStatus = ReadCodecRegister (AC97Reg, &wOriginal);
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    // Write the 6th bit; for mono controls we write 0x20, for stereo
    // controls 0x2020.
    ntStatus = WriteCodecRegister (AC97Reg,
                    (AC97Reg == AC97REG_MMONO_VOLUME) ? 0x0020 : 0x2020, 0xFFFF);
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    // And read back.
    ntStatus = ReadCodecRegister (AC97Reg, &wCodecReg);
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    // Check return. For mono 0x20 and for stereo 0x2020.
    if (((wCodecReg & 0x0020) && (AC97Reg == AC97REG_MMONO_VOLUME)) ||
        (wCodecReg & 0x2020))
    {
        SetNodeConfig (Config, TRUE);
    }
    else
    {
        SetNodeConfig (Config, FALSE);
    }
 
    // Restore original value.
    WriteCodecRegister (AC97Reg, wOriginal, 0xFFFF);
 
    return ntStatus;
}

Referenced by ProbeHWConfig().

DECLARE_STD_UNKNOWN()

CAC97AdapterCommon::DECLARE_STD_UNKNOWN

(

)

DEFINE_STD_CONSTRUCTOR()

CAC97AdapterCommon::DEFINE_STD_CONSTRUCTOR

(

CAC97AdapterCommon

)

DisableAC97Pin()

BOOL CAC97AdapterCommon::DisableAC97Pin ( IN TopoPinConfig  pin )

private

Definition at line 1879 of file common.cpp.

{
    PAGED_CODE ();
 
    PREGISTRYKEY    DriverKey;
    PREGISTRYKEY    SettingsKey;
    UNICODE_STRING  sKeyName;
    ULONG           ulDisposition;
    ULONG           ulResultLength;
    PVOID           KeyInfo = NULL;
    BOOL            bDisable = FALSE;
 
    DOUT (DBG_PRINT, ("[CAC97AdapterCommon::DisableAC97Pin]"));
 
    // open the driver registry key
    NTSTATUS ntStatus = PcNewRegistryKey (&DriverKey,        // IRegistryKey
                                          NULL,              // OuterUnknown
                                          DriverRegistryKey, // Registry key type
                                          KEY_READ,          // Access flags
                                          m_pDeviceObject,   // Device object
                                          NULL,              // Subdevice
                                          NULL,              // ObjectAttributes
                                          0,                 // Create options
                                          NULL);             // Disposition
    if (NT_SUCCESS (ntStatus))
    {
        // make a unicode string for the subkey name
        RtlInitUnicodeString (&sKeyName, L"Settings");
 
        // open the settings subkey
        ntStatus = DriverKey->NewSubKey (&SettingsKey,            // Subkey
                                         NULL,                    // OuterUnknown
                                         KEY_READ,                // Access flags
                                         &sKeyName,               // Subkey name
                                         REG_OPTION_NON_VOLATILE, // Create options
                                         &ulDisposition);
 
        if (NT_SUCCESS (ntStatus))
        {
            // allocate data to hold key info
            KeyInfo = ExAllocatePoolWithTag (PagedPool,
                                      sizeof(KEY_VALUE_PARTIAL_INFORMATION) +
                                      sizeof(BYTE), PoolTag);
            if (NULL != KeyInfo)
            {
                // init key name
                RtlInitUnicodeString (&sKeyName, m_stHardwareConfig.
                                            Pins[pin].sRegistryName);
 
                // query the value key
                ntStatus = SettingsKey->QueryValueKey (&sKeyName,
                                   KeyValuePartialInformation,
                                   KeyInfo,
                                   sizeof(KEY_VALUE_PARTIAL_INFORMATION) +
                                        sizeof(BYTE),
                                   &ulResultLength );
                if (NT_SUCCESS (ntStatus))
                {
                    PKEY_VALUE_PARTIAL_INFORMATION PartialInfo =
                                (PKEY_VALUE_PARTIAL_INFORMATION)KeyInfo;
 
                    if (PartialInfo->DataLength == sizeof(BYTE))
                    {
                        // store the value
                        if (*(PBYTE)PartialInfo->Data)
                            bDisable = TRUE;
                        else
                            bDisable = FALSE;
                    }
                }
 
                // free the key info
                ExFreePoolWithTag (KeyInfo,PoolTag);
            }
 
            // release the settings key
            SettingsKey->Release ();
        }
 
        // release the driver key
        DriverKey->Release ();
    }
 
    // if one of the stuff above fails we return the default, which is FALSE.
    return bDisable;
}

Referenced by ProbeHWConfig().

InitAC97()

NTSTATUS CAC97AdapterCommon::InitAC97 ( void  )

private

Definition at line 540 of file common.cpp.

{
    PAGED_CODE ();
 
    DOUT (DBG_PRINT, ("[CAC97AdapterCommon::InitAC97]"));
 
    //
    // First check if there is an AC link to the primary CoDec.
    //
    NTSTATUS ntStatus = PrimaryCodecReady ();
    if (NT_SUCCESS (ntStatus))
    {
        //
        // Second, reset this primary CoDec; If this is a AMC97 CoDec, only
        // the audio registers are reset. If this is a MC97 CoDec, the CoDec
        // should ignore the reset (according to the spec).
        //
        WriteCodecRegister (AC97REG_RESET, 0x00, 0xFFFF);
 
        ntStatus = PowerUpCodec ();
    }
    else
    {
        DOUT (DBG_ERROR, ("Initialization of AC97 CoDec failed."));
    }
 
    return ntStatus;
}

Referenced by STDMETHODIMP_().

PowerUpCodec()

NTSTATUS CAC97AdapterCommon::PowerUpCodec ( void  )

private

Definition at line 1331 of file common.cpp.

{
    PAGED_CODE ();
 
    WORD        wCodecReg;
    NTSTATUS    ntStatus;
 
    DOUT (DBG_PRINT, ("[CAC97AdapterCommon::PowerUpCodec]"));
 
    //
    // Power up the Codec.
    //
    WriteCodecRegister (AC97REG_POWERDOWN, 0x00, 0xFFFF);
 
    //
    // Wait for the Codec to be powered up.
    //
    ULONG           WaitCycles = 200;
    LARGE_INTEGER   WaitTime;
 
    WaitTime.QuadPart = (-50000);   // wait 5000us (5ms) relative
 
    do
    {
        //
        // Read the power management register.
        //
        ntStatus = ReadCodecRegister (AC97REG_POWERDOWN, &wCodecReg);
        if (!NT_SUCCESS (ntStatus))
        {
            wCodecReg = 0;      // Will cause an error.
            break;
        }
 
        //
        // Check the power state. Should be ready.
        //
        if ((wCodecReg & 0x0f) == 0x0f)
            break;
 
        //
        // Let's wait a little, 5ms and then try again.
        //
        KeDelayExecutionThread (KernelMode, FALSE, &WaitTime);
    } while (WaitCycles--);
 
    // Check if we timed out.
    if ((wCodecReg & 0x0f) != 0x0f)
    {
        DOUT (DBG_ERROR, ("PowerUpCodec timed out. CoDec not powered up."));
        ntStatus = STATUS_DEVICE_NOT_READY;
    }
 
    return ntStatus;
}

Referenced by InitAC97(), and STDMETHODIMP_().

PrimaryCodecReady()

NTSTATUS CAC97AdapterCommon::PrimaryCodecReady ( void  )

private

Definition at line 1284 of file common.cpp.

{
    PAGED_CODE ();
 
    DOUT (DBG_PRINT, ("[CAC97AdapterCommon::PrimaryCodecReady]"));
 
 
    //
    // Enable the AC link and raise the reset line.
    //
    DWORD dwRegValue = ReadBMControlRegister32 (GLOB_CNT);
 
    // If someone enabled GPI Interrupt Enable, then he hopefully handles that
    // too.
    dwRegValue = (dwRegValue | GLOB_CNT_COLD) & ~(GLOB_CNT_ACLOFF | GLOB_CNT_PRIE);
    WriteBMControlRegister (GLOB_CNT, dwRegValue);
 
    //
    // Wait for the Codec to be ready.
    //
    ULONG           WaitCycles = 200;
    LARGE_INTEGER   WaitTime;
 
    WaitTime.QuadPart = (-50000);   // wait 5000us (5ms) relative
 
    do
    {
        if (READ_PORT_ULONG ((PULONG)(m_pBusMasterBase + GLOB_STA)) &
            GLOB_STA_PCR)
        {
            return STATUS_SUCCESS;
        }
 
        KeDelayExecutionThread (KernelMode, FALSE, &WaitTime);
    } while (WaitCycles--);
 
    DOUT (DBG_ERROR, ("PrimaryCodecReady timed out!"));
    return STATUS_IO_TIMEOUT;
}

Referenced by InitAC97(), and ProbeHWConfig().

ProbeHWConfig()

NTSTATUS CAC97AdapterCommon::ProbeHWConfig ( void  )

private

Definition at line 636 of file common.cpp.

{
    PAGED_CODE ();
 
    NTSTATUS ntStatus = STATUS_SUCCESS;
    DWORD    dwGlobalStatus;
    WORD     wCodecID;
    WORD     wCodecReg;
 
    DOUT (DBG_PRINT, ("[CAC97AdapterCommon::ProbeHWConfig]"));
 
    //
    // Wait for the whatever 97 to complete reset and establish a link.
    //
    ntStatus = PrimaryCodecReady ();
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    //
    // Master volume is one of the supported registers on an AC97
    //
    ntStatus = ReadCodecRegister (AC97REG_MASTER_VOLUME, &wCodecReg);
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    // Default is x8000.
    if (wCodecReg != 0x8000)
        return STATUS_NO_SUCH_DEVICE;
 
    //
    // This gives us information about the AC97 CoDec
    //
    ntStatus = ReadCodecRegister (AC97REG_RESET, &wCodecID);
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    //
    // Fill out the configuration stuff.
    //
 
    SetPinConfig (PINC_MICIN_PRESENT, wCodecID & 0x0001);
 
    // Check if OEM wants to disable MIC record line.
    if (DisableAC97Pin (PINC_MICIN_PRESENT))
        SetPinConfig (PINC_MICIN_PRESENT, FALSE);
 
    // If we still have MIC record line, enable the DAC in ext. audio register.
    if (GetPinConfig (PINC_MICIN_PRESENT))
        // Enable ADC MIC.
        WriteCodecRegister (AC97REG_EXT_AUDIO_CTRL, 0, 0x4000);
    else
        // Disable ADC MIC.
        WriteCodecRegister (AC97REG_EXT_AUDIO_CTRL, 0x4000, 0x4000);
 
    //
    // Continue setting configuration information.
    //
 
    SetNodeConfig (NODEC_TONE_PRESENT, wCodecID & 0x0004);
    SetNodeConfig (NODEC_SIMUL_STEREO_PRESENT, wCodecID & 0x0008);
    SetPinConfig (PINC_HPOUT_PRESENT, wCodecID & 0x0010);
 
    // Check if OEM wants to disable headphone output.
    if (DisableAC97Pin (PINC_HPOUT_PRESENT))
        SetPinConfig (PINC_HPOUT_PRESENT, FALSE);
 
    SetNodeConfig (NODEC_LOUDNESS_PRESENT, wCodecID & 0x0020);
    SetNodeConfig (NODEC_3D_PRESENT, wCodecID & 0x7C00);
 
    //
    // Test for the input pins that are always there but could be disabled
    // by the HW vender
    //
 
    // Check if OEM wants to disable mic input.
    SetPinConfig (PINC_MIC_PRESENT, !DisableAC97Pin (PINC_MIC_PRESENT));
 
    // Check if OEM wants to disable line input.
    SetPinConfig (PINC_LINEIN_PRESENT, !DisableAC97Pin (PINC_LINEIN_PRESENT));
 
    // Check if OEM wants to disable CD input.
    SetPinConfig (PINC_CD_PRESENT, !DisableAC97Pin (PINC_CD_PRESENT));
 
 
    //
    // For the rest, we have to probe the registers.
    //
 
    //
    // Test for Mono out.
    //
    ntStatus = ReadCodecRegister (AC97REG_MMONO_VOLUME, &wCodecReg);
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    // Default is x8000.
    SetPinConfig (PINC_MONOOUT_PRESENT, (wCodecReg == 0x8000));
 
    // Check if OEM wants to disable mono output.
    if (DisableAC97Pin (PINC_MONOOUT_PRESENT))
        SetPinConfig (PINC_MONOOUT_PRESENT, FALSE);
 
    //
    // Test for PC beeper support.
    //
    ntStatus = ReadCodecRegister (AC97REG_BEEP_VOLUME, &wCodecReg);
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    // default is x0 or x8000. If it's 0x8000 then we know for sure that the
    // CoDec has a PcBeep, otherwise we have to check the register
    if (wCodecReg == 0x8000)
        SetPinConfig (PINC_PCBEEP_PRESENT, TRUE);
    else if (!wCodecReg)
    {
        // mute the pc beeper.
        ntStatus = WriteCodecRegister (AC97REG_BEEP_VOLUME, 0x8000, 0xFFFF);
        if (!NT_SUCCESS (ntStatus))
            return ntStatus;
 
        // read back
        ntStatus = ReadCodecRegister (AC97REG_BEEP_VOLUME, &wCodecReg);
        if (!NT_SUCCESS (ntStatus))
            return ntStatus;
 
        if (wCodecReg == 0x8000)
        {
            // yep, we have support.
            SetPinConfig (PINC_PCBEEP_PRESENT, TRUE);
            // reset to default value.
            WriteCodecRegister (AC97REG_BEEP_VOLUME, 0x0, 0xFFFF);
        }
        else
            // nope, not present
            SetPinConfig (PINC_PCBEEP_PRESENT, FALSE);
    }
    else
        // any other value then 0x0 and 0x8000.
        SetPinConfig (PINC_PCBEEP_PRESENT, FALSE);
 
    // Check if OEM wants to disable beeper support.
    if (DisableAC97Pin (PINC_PCBEEP_PRESENT))
        SetPinConfig (PINC_PCBEEP_PRESENT, FALSE);
 
    //
    // Test for phone support.
    //
    ntStatus = ReadCodecRegister (AC97REG_PHONE_VOLUME, &wCodecReg);
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    // Default is x8008.
    SetPinConfig (PINC_PHONE_PRESENT, (wCodecReg == 0x8008));
 
    // Check if OEM wants to disable phone input.
    if (DisableAC97Pin (PINC_PHONE_PRESENT))
        SetPinConfig (PINC_PHONE_PRESENT, FALSE);
 
    //
    // Test for video support.
    //
    ntStatus = ReadCodecRegister (AC97REG_VIDEO_VOLUME, &wCodecReg);
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    // Default is x8808.
    SetPinConfig (PINC_VIDEO_PRESENT, (wCodecReg == 0x8808));
 
    // Check if OEM wants to disable video input.
    if (DisableAC97Pin (PINC_VIDEO_PRESENT))
        SetPinConfig (PINC_VIDEO_PRESENT, FALSE);
 
    //
    // Test for Aux support.
    //
    ntStatus = ReadCodecRegister (AC97REG_AUX_VOLUME, &wCodecReg);
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    // Default is 0x8808.
    SetPinConfig (PINC_AUX_PRESENT, (wCodecReg == 0x8808));
 
    // Check if OEM wants to disable aux input.
    if (DisableAC97Pin (PINC_AUX_PRESENT))
        SetPinConfig (PINC_AUX_PRESENT, FALSE);
 
    //
    // Test for Mic2 source.
    //
    ntStatus = ReadCodecRegister (AC97REG_GENERAL, &wCodecReg);
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    // Test for Mic2 select bit.
    if (wCodecReg & 0x0100)
        SetPinConfig (PINC_MIC2_PRESENT, TRUE);
    else
    {
        // Select Mic2 as source.
        ntStatus = WriteCodecRegister (AC97REG_GENERAL, 0x0100, 0x0100);
        if (!NT_SUCCESS (ntStatus))
            return ntStatus;
 
        // Read back.
        ntStatus = ReadCodecRegister (AC97REG_GENERAL, &wCodecReg);
        if (!NT_SUCCESS (ntStatus))
            return ntStatus;
 
        if (wCodecReg & 0x0100)
        {
            // Yep, we have support so set it to the default value.
            SetPinConfig (PINC_MIC2_PRESENT, TRUE);
            // reset to default value.
            WriteCodecRegister (AC97REG_GENERAL, 0, 0x0100);
        }
        else
            SetPinConfig (PINC_MIC2_PRESENT, FALSE);
    }
 
    // Check if OEM wants to disable mic2 input.
    if (DisableAC97Pin (PINC_MIC2_PRESENT))
        SetPinConfig (PINC_MIC2_PRESENT, FALSE);
 
    //
    // Test the 3D controls.
    //
    if (GetNodeConfig (NODEC_3D_PRESENT))
    {
        //
        // First test for fixed 3D controls. Write default value ...
        //
        ntStatus = WriteCodecRegister (AC97REG_3D_CONTROL, 0, 0xFFFF);
        if (!NT_SUCCESS (ntStatus))
            return ntStatus;
 
        // Read 3D register. Default is 0 when adjustable, otherwise it is
        // a fixed value.
        ntStatus = ReadCodecRegister (AC97REG_3D_CONTROL, &wCodecReg);
        if (!NT_SUCCESS (ntStatus))
            return ntStatus;
 
        //
        // Check center and depth separately.
        //
 
        // For center
        SetNodeConfig (NODEC_3D_CENTER_ADJUSTABLE, !(wCodecReg & 0x0F00));
 
        // For depth
        SetNodeConfig (NODEC_3D_DEPTH_ADJUSTABLE, !(wCodecReg & 0x000F));
 
        //
        // Test for adjustable controls.
        //
        WriteCodecRegister (AC97REG_3D_CONTROL, 0x0A0A, 0xFFFF);
 
        // Read 3D register. Now it should be 0x0A0A for adjustable controls,
        // otherwise it is a fixed control or simply not there.
        ReadCodecRegister (AC97REG_3D_CONTROL, &wCodecReg);
 
        // Restore the default value
        WriteCodecRegister (AC97REG_3D_CONTROL, 0, 0xFFFF);
 
        // Check the center control for beeing adjustable
        if (GetNodeConfig (NODEC_3D_CENTER_ADJUSTABLE) &&
            (wCodecReg & 0x0F00) != 0x0A00)
        {
            SetNodeConfig (NODEC_3D_CENTER_ADJUSTABLE, FALSE);
        }
 
        // Check the depth control for beeing adjustable
        if (GetNodeConfig (NODEC_3D_DEPTH_ADJUSTABLE) &&
            (wCodecReg & 0x000F) != 0x000A)
        {
            SetNodeConfig (NODEC_3D_DEPTH_ADJUSTABLE, FALSE);
        }
    }
 
    //
    // Check for 6th bit support in volume controls.  To check the 6th bit,
    // we first have to write a value (with 6th bit set) and then read it
    // back.  After that, we should restore the register to its default value.
    //
 
    //
    // Start with the master volume.
    //
    Check6thBitSupport (AC97REG_MASTER_VOLUME, NODEC_6BIT_MASTER_VOLUME);
 
    //
    // Check for a headphone volume control.
    //
    if (GetPinConfig (PINC_HPOUT_PRESENT))
    {
        Check6thBitSupport (AC97REG_HPHONE_VOLUME, NODEC_6BIT_HPOUT_VOLUME);
    }
 
    //
    // Mono out there?
    //
    if (GetPinConfig (PINC_MONOOUT_PRESENT))
    {
        Check6thBitSupport (AC97REG_MMONO_VOLUME, NODEC_6BIT_MONOOUT_VOLUME);
    }
 
    //
    // Get extended AC97 V2.0 information
    //
    ntStatus = ReadCodecRegister (AC97REG_EXT_AUDIO_ID, &wCodecReg);
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    //
    // Store the information
    //
    SetNodeConfig (NODEC_PCM_VARIABLERATE_SUPPORTED, wCodecReg & 0x0001);
    SetNodeConfig (NODEC_PCM_DOUBLERATE_SUPPORTED, wCodecReg & 0x0002);
    SetNodeConfig (NODEC_MIC_VARIABLERATE_SUPPORTED, wCodecReg & 0x0008);
    SetNodeConfig (NODEC_CENTER_DAC_PRESENT, wCodecReg & 0x0040);
    SetNodeConfig (NODEC_SURROUND_DAC_PRESENT, wCodecReg & 0x0080);
    SetNodeConfig (NODEC_LFE_DAC_PRESENT, wCodecReg & 0x0100);
 
    //
    // In case we have some features get some more information and program
    // the codec.
    //
    if (wCodecReg)
    {
        //
        // Enable variable sample rate in the control register and disable
        // double rate. Also enable all DACs.
        //
        WriteCodecRegister (AC97REG_EXT_AUDIO_CTRL, wCodecReg & 0x0009, 0x380B);
 
        //
        // Check for codecs that have only one sample rate converter. These
        // codecs will stick registers AC97REG_FRONT_SAMPLERATE and
        // AC97REG_RECORD_SAMPLERATE together.
        //
        if (GetNodeConfig (NODEC_PCM_VARIABLERATE_SUPPORTED))
        {
            // The default of the sample rate registers should be 0xBB80.
            WriteCodecRegister (AC97REG_FRONT_SAMPLERATE, 0xBB80, 0xFFFF);
 
            // Write 44.1KHz into record VSR, then check playback again.
            WriteCodecRegister (AC97REG_RECORD_SAMPLERATE, 0xAC44, 0xFFFF);
            ntStatus = ReadCodecRegister (AC97REG_FRONT_SAMPLERATE, &wCodecReg);
            WriteCodecRegister (AC97REG_RECORD_SAMPLERATE, 0xBB80, 0xFFFF);
            if (!NT_SUCCESS (ntStatus))
                return ntStatus;
 
            //
            // Set the flag accordingly
            //
            SetNodeConfig (NODEC_PCM_VSR_INDEPENDENT_RATES, (wCodecReg == 0xBB80));
        }
 
        //
        // Check multichanel support on the AC97.
        //
        if (GetNodeConfig (NODEC_SURROUND_DAC_PRESENT))
        {
            dwGlobalStatus = ReadBMControlRegister32 (GLOB_STA);
 
            //
            // Codec supports >2 chanel, does AC97 too?
            //
            if ((GetNodeConfig (NODEC_CENTER_DAC_PRESENT) ||
                GetNodeConfig (NODEC_LFE_DAC_PRESENT)) &&
                (dwGlobalStatus & GLOB_STA_MC6))
            {
                SetPinConfig (PINC_CENTER_LFE_PRESENT, TRUE);
            }
            else
            {
                SetPinConfig (PINC_CENTER_LFE_PRESENT, FALSE);
            }
 
            //
            // Do we support at least 4 channels?
            //
            SetPinConfig (PINC_SURROUND_PRESENT, (dwGlobalStatus & GLOB_STA_MC4));
        }
        else
        {
            //
            // Only 2 channel (stereo) support.
            //
            SetPinConfig (PINC_CENTER_LFE_PRESENT, FALSE);
            SetPinConfig (PINC_SURROUND_PRESENT, FALSE);
        }
    }
 
    // Check if OEM wants to disable surround output.
    if (DisableAC97Pin (PINC_SURROUND_PRESENT))
        SetPinConfig (PINC_SURROUND_PRESENT, FALSE);
 
    // Check if OEM wants to disable center and LFE output.
    if (DisableAC97Pin (PINC_CENTER_LFE_PRESENT))
        SetPinConfig (PINC_CENTER_LFE_PRESENT, FALSE);
 
    //
    // Check the 6th bit support for the additional channels.
    //
    if (GetPinConfig (PINC_SURROUND_PRESENT))
        Check6thBitSupport (AC97REG_SURROUND_VOLUME, NODEC_6BIT_SURROUND_VOLUME);
 
    if (GetPinConfig (PINC_CENTER_LFE_PRESENT))
        Check6thBitSupport (AC97REG_CENTER_LFE_VOLUME, NODEC_6BIT_CENTER_LFE_VOLUME);
 
    //
    // We read these registers because they are dependent on the codec.
    //
    ReadCodecRegister (AC97REG_VENDOR_ID1, &wCodecReg);
    ReadCodecRegister (AC97REG_VENDOR_ID2, &wCodecReg);
 
    return STATUS_SUCCESS;
}

Referenced by STDMETHODIMP_().

ReadNABMCtrlRegs()

NTSTATUS CAC97AdapterCommon::ReadNABMCtrlRegs ( void  )

private

RestoreNABMCtrlRegs()

NTSTATUS CAC97AdapterCommon::RestoreNABMCtrlRegs ( void  )

private

SetAC97Default()

NTSTATUS CAC97AdapterCommon::SetAC97Default ( void  )

private

Definition at line 1742 of file common.cpp.

{
    PAGED_CODE ();
 
    PREGISTRYKEY    DriverKey;
    PREGISTRYKEY    SettingsKey;
    UNICODE_STRING  sKeyName;
    ULONG           ulDisposition;
    ULONG           ulResultLength;
    PVOID           KeyInfo = NULL;
 
    DOUT (DBG_PRINT, ("[CAC97AdapterCommon::SetAC97Default]"));
 
    // open the driver registry key
    NTSTATUS ntStatus = PcNewRegistryKey (&DriverKey,        // IRegistryKey
                                          NULL,              // OuterUnknown
                                          DriverRegistryKey, // Registry key type
                                          KEY_READ,          // Access flags
                                          m_pDeviceObject,   // Device object
                                          NULL,              // Subdevice
                                          NULL,              // ObjectAttributes
                                          0,                 // Create options
                                          NULL);             // Disposition
    if (NT_SUCCESS (ntStatus))
    {
        // make a unicode string for the subkey name
        RtlInitUnicodeString (&sKeyName, L"Settings");
 
        // open the settings subkey
        ntStatus = DriverKey->NewSubKey (&SettingsKey,            // Subkey
                                         NULL,                    // OuterUnknown
                                         KEY_READ,                // Access flags
                                         &sKeyName,               // Subkey name
                                         REG_OPTION_NON_VOLATILE, // Create options
                                         &ulDisposition);
 
        if (NT_SUCCESS (ntStatus))
        {
            // allocate data to hold key info
            KeyInfo = ExAllocatePoolWithTag (PagedPool,
                                      sizeof(KEY_VALUE_PARTIAL_INFORMATION) +
                                      sizeof(WORD), PoolTag);
            if (NULL != KeyInfo)
            {
                // loop through all mixer settings
                for (AC97Register i = AC97REG_RESET; i <= AC97REG_RESERVED2;
                    i = (AC97Register)(i + 1))
                {
                    if (m_stAC97Registers[i].wFlags & SHREG_INIT)
                    {
                        // init key name
                        RtlInitUnicodeString (&sKeyName,
                                              m_stAC97Registers[i].sRegistryName);
 
                        // query the value key
                        ntStatus = SettingsKey->QueryValueKey (&sKeyName,
                                        KeyValuePartialInformation,
                                        KeyInfo,
                                        sizeof(KEY_VALUE_PARTIAL_INFORMATION) +
                                            sizeof(WORD),
                                        &ulResultLength);
                        if (NT_SUCCESS (ntStatus))
                        {
                            PKEY_VALUE_PARTIAL_INFORMATION PartialInfo =
                                        (PKEY_VALUE_PARTIAL_INFORMATION)KeyInfo;
 
                            if (PartialInfo->DataLength == sizeof(WORD))
                            {
                                // set mixer register to registry value
                                WriteCodecRegister
                                    (i, *(PWORD)PartialInfo->Data, 0xFFFF);
                            }
                            else    // write the hard coded default
                            {
                                // if key access failed, set to default
                                WriteCodecRegister
                                    (i, m_stAC97Registers[i].wWantedDefault, 0xFFFF);
                            }
                        }
                        else  // write the hard coded default
                        {
                            // if key access failed, set to default
                            WriteCodecRegister
                                (i, m_stAC97Registers[i].wWantedDefault, 0xFFFF);
                        }
                    }
                }
 
                // we want to return status success even if the last QueryValueKey
                // failed.
                ntStatus = STATUS_SUCCESS;
 
                // free the key info
                ExFreePoolWithTag (KeyInfo,PoolTag);
            }
            else
            {
                ntStatus = STATUS_INSUFFICIENT_RESOURCES;
            }
 
            // release the settings key
            SettingsKey->Release ();
        }
 
        // release the driver key
        DriverKey->Release ();
    }
 
 
    // in case we did not query the registry (cause of lack of resources)
    // restore default values and return insufficient resources.
    if (!NT_SUCCESS (ntStatus))
    {
        // copy hard coded default settings
        for (AC97Register i = AC97REG_RESET; i < AC97REG_RESERVED2;
             i = (AC97Register)(i + 1))
        {
            if (m_stAC97Registers[i].wFlags & SHREG_INIT)
            {
                WriteCodecRegister (i, m_stAC97Registers[i].wWantedDefault, 0xFFFF);
            }
        }
    }
 
    return ntStatus;
}

Referenced by STDMETHODIMP_().

STDMETHODIMP_() [1/21]

CAC97AdapterCommon::STDMETHODIMP_ ( AC97Register  )

inline

Definition at line 240 of file common.h.

    {
        return stMapNodeToReg[node].reg;
    };

STDMETHODIMP_() [2/21]

CAC97AdapterCommon::STDMETHODIMP_ ( BOOL  )

inline

Definition at line 217 of file common.h.

    {
        return m_stHardwareConfig.Nodes[node].bNodeConfig;
    };

STDMETHODIMP_() [3/21]

CAC97AdapterCommon::STDMETHODIMP_ ( BOOL  )

inline

Definition at line 194 of file common.h.

    {
        return m_stHardwareConfig.Pins[pin].bPinConfig;
    };

STDMETHODIMP_() [4/21]

CAC97AdapterCommon::STDMETHODIMP_

(

NTSTATUS

)

STDMETHODIMP_() [5/21]

CAC97AdapterCommon::STDMETHODIMP_

(

NTSTATUS

)

STDMETHODIMP_() [6/21]

CAC97AdapterCommon::STDMETHODIMP_

(

NTSTATUS

)

STDMETHODIMP_() [7/21]

CAC97AdapterCommon::STDMETHODIMP_

(

NTSTATUS

)

STDMETHODIMP_() [8/21]

CAC97AdapterCommon::STDMETHODIMP_

(

NTSTATUS

)

STDMETHODIMP_() [9/21]

CAC97AdapterCommon::STDMETHODIMP_ ( PAC97MINIPORTTOPOLOGY  )

inline

Definition at line 351 of file common.h.

    {
        return m_Topology;
    };

STDMETHODIMP_() [10/21]

CAC97AdapterCommon::STDMETHODIMP_

(

UCHAR

)

STDMETHODIMP_() [11/21]

CAC97AdapterCommon::STDMETHODIMP_

(

ULONG

)

STDMETHODIMP_() [12/21]

CAC97AdapterCommon::STDMETHODIMP_

(

USHORT

)

STDMETHODIMP_() [13/21]

CAC97AdapterCommon::STDMETHODIMP_

(

void

)

STDMETHODIMP_() [14/21]

CAC97AdapterCommon::STDMETHODIMP_ ( void  )

inline

Definition at line 343 of file common.h.

    {
        m_Topology = topo;
    };

STDMETHODIMP_() [15/21]

CAC97AdapterCommon::STDMETHODIMP_

(

void

)

STDMETHODIMP_() [16/21]

CAC97AdapterCommon::STDMETHODIMP_

(

void

)

STDMETHODIMP_() [17/21]

CAC97AdapterCommon::STDMETHODIMP_

(

void

)

STDMETHODIMP_() [18/21]

CAC97AdapterCommon::STDMETHODIMP_

(

void

)

STDMETHODIMP_() [19/21]

CAC97AdapterCommon::STDMETHODIMP_

(

void

)

STDMETHODIMP_() [20/21]

CAC97AdapterCommon::STDMETHODIMP_

(

void

)

STDMETHODIMP_() [21/21]

CAC97AdapterCommon::STDMETHODIMP_ ( WORD  )

inline

Definition at line 250 of file common.h.

    {
        return stMapNodeToReg[node].mask;
    };

Friends And Related Function Documentation

NewAdapterCommon

NTSTATUS NewAdapterCommon ( OUT PADAPTERCOMMON *  OutAdapterCommon, IN PRESOURCELIST  ResourceList  )

friend

Member Data Documentation

config

IN BOOL CAC97AdapterCommon::config

Initial value:

{
        m_stHardwareConfig.Pins[pin].bPinConfig = config

Definition at line 208 of file common.h.

Referenced by STDMETHODIMP_().

DeviceObject

IN PDEVICE_OBJECT CAC97AdapterCommon::DeviceObject

Definition at line 188 of file common.h.

Referenced by STDMETHODIMP_().

dwSampleRate

IN DWORD CAC97AdapterCommon::dwSampleRate

Definition at line 337 of file common.h.

IMP_IAdapterPowerManagement

CAC97AdapterCommon::IMP_IAdapterPowerManagement

Definition at line 175 of file common.h.

m_bDirectRead

BOOL CAC97AdapterCommon::m_bDirectRead

private

Definition at line 97 of file common.h.

Referenced by STDMETHODIMP_().

m_pBusMasterBase

PUCHAR CAC97AdapterCommon::m_pBusMasterBase

private

Definition at line 96 of file common.h.

Referenced by AcquireCodecSemiphore(), PrimaryCodecReady(), and STDMETHODIMP_().

m_pCodecBase

PWORD CAC97AdapterCommon::m_pCodecBase

private

Definition at line 95 of file common.h.

Referenced by STDMETHODIMP_().

m_pDeviceObject

PDEVICE_OBJECT CAC97AdapterCommon::m_pDeviceObject

private

Definition at line 94 of file common.h.

Referenced by DisableAC97Pin(), SetAC97Default(), and STDMETHODIMP_().

m_PowerState

DEVICE_POWER_STATE CAC97AdapterCommon::m_PowerState

private

Definition at line 98 of file common.h.

Referenced by STDMETHODIMP_().

m_stAC97Registers

tAC97Registers CAC97AdapterCommon::m_stAC97Registers

staticprivate

Definition at line 92 of file common.h.

Referenced by SetAC97Default().

m_stHardwareConfig

tHardwareConfig CAC97AdapterCommon::m_stHardwareConfig

staticprivate

Initial value:

=
{
    
    {{FALSE}, {FALSE}, {FALSE}, {FALSE}, {FALSE}, {FALSE}, {FALSE}, {FALSE},
     {FALSE}, {FALSE}, {FALSE}, {FALSE}, {FALSE}, {FALSE}, {FALSE}, {FALSE},
     {FALSE}},
    
    {{FALSE, L"DisablePCBeep"},     
     {FALSE, L"DisablePhone"},      
     {FALSE, L"DisableMic2"},       
     {FALSE, L"DisableVideo"},      
     {FALSE, L"DisableAUX"},        
     {FALSE, L"DisableHeadphone"},  
     {FALSE, L"DisableMonoOut"},    
     {FALSE, L"DisableMicIn"},      
     {FALSE, L"DisableMic"},        
     {FALSE, L"DisableLineIn"},     
     {FALSE, L"DisableCD"},         
     {FALSE, L"DisableSurround"},   
     {FALSE, L"DisableCenterLFE"}}  
}

Definition at line 93 of file common.h.

Referenced by DisableAC97Pin(), and STDMETHODIMP_().

m_Topology

PAC97MINIPORTTOPOLOGY CAC97AdapterCommon::m_Topology

private

Definition at line 99 of file common.h.

Referenced by STDMETHODIMP_(), and STDMETHODIMP_().

pwChannels

PWORD CAC97AdapterCommon::pwChannels

Definition at line 363 of file common.h.

Register

AC97REG_INVALID AC97Register CAC97AdapterCommon::Register

Definition at line 263 of file common.h.

Value [1/3]

IN UCHAR CAC97AdapterCommon::Value

Definition at line 307 of file common.h.

Value [2/3]

IN USHORT CAC97AdapterCommon::Value

Definition at line 316 of file common.h.

Value [3/3]

IN ULONG CAC97AdapterCommon::Value

Definition at line 323 of file common.h.

wData [1/2]

AC97REG_INVALID AC97Register _Out_ PWORD CAC97AdapterCommon::wData

Definition at line 264 of file common.h.

wData [2/2]

AC97REG_INVALID AC97Register _In_ WORD CAC97AdapterCommon::wData

Definition at line 273 of file common.h.

wMask

AC97REG_INVALID AC97Register _In_ WORD _In_ WORD CAC97AdapterCommon::wMask

Definition at line 274 of file common.h.

---

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

• drivers/wdm/audio/drivers/ac97/common.h
• drivers/wdm/audio/drivers/ac97/common.cpp