common.cpp File Reference

#include "common.h"

Include dependency graph for common.cpp:

Go to the source code of this file.

Macros
#define	STR_MODULENAME   "AC97 Common: "

Functions
NTSTATUS	NewAdapterCommon (OUT PUNKNOWN *Unknown, IN REFCLSID, IN PUNKNOWN UnknownOuter OPTIONAL, _When_((PoolType &NonPagedPoolMustSucceed) !=0, __drv_reportError("Must succeed pool allocations are forbidden. " "Allocation failures cause a system crash")) IN POOL_TYPE PoolType)
	STDMETHODIMP_ (NTSTATUS) CAC97AdapterCommon
	STDMETHODIMP_ (void) CAC97AdapterCommon
	STDMETHODIMP_ (UCHAR) CAC97AdapterCommon
	STDMETHODIMP_ (USHORT) CAC97AdapterCommon
	STDMETHODIMP_ (ULONG) CAC97AdapterCommon

Macro Definition Documentation

STR_MODULENAME

#define STR_MODULENAME   "AC97 Common: "

Definition at line 11 of file common.cpp.

Function Documentation

NewAdapterCommon()

NTSTATUS NewAdapterCommon	(	OUT PUNKNOWN *	Unknown,
		IN	REFCLSID,
		IN PUNKNOWN UnknownOuter	OPTIONAL,
		_When_((PoolType &NonPagedPoolMustSucceed) !=0, __drv_reportError("Must succeed pool allocations are forbidden. " "Allocation failures cause a system crash")) IN POOL_TYPE	PoolType
	)

Definition at line 116 of file common.cpp.

{
    PAGED_CODE ();
 
    ASSERT (Unknown);
 
    DOUT (DBG_PRINT, ("[NewAdapterCommon]"));
 
    STD_CREATE_BODY_WITH_TAG_(CAC97AdapterCommon,Unknown,UnknownOuter,PoolType,
                              PoolTag, PADAPTERCOMMON);
}

Referenced by StartDevice().

STDMETHODIMP_() [1/5]

STDMETHODIMP_

(

NTSTATUS

)

Definition at line 144 of file common.cpp.

{
    PAGED_CODE ();
 
    ASSERT (ResourceList);
    ASSERT (DeviceObject);
 
    NTSTATUS ntStatus = STATUS_SUCCESS;
 
    DOUT (DBG_PRINT, ("[CAC97AdapterCommon::Init]"));
 
    //
    // Set the topology pointer to NULL.
    //
    m_Topology = NULL;
 
    //
    // Save the device object
    //
    m_pDeviceObject = DeviceObject;
 
    //
    // Get the base address for the AC97 codec and bus master.
    //
    ASSERT (ResourceList->FindTranslatedPort (0));
    m_pCodecBase = (PUSHORT)ResourceList->FindTranslatedPort (0)->
                           u.Port.Start.QuadPart;
 
    ASSERT (ResourceList->FindTranslatedPort (1));
    m_pBusMasterBase = (PUCHAR)ResourceList->FindTranslatedPort (1)->
                              u.Port.Start.QuadPart;
 
    DOUT (DBG_SYSINFO, ("Configuration:\n"
                        "   Bus Master = 0x%p\n"
                        "   Codec      = 0x%p",
                        m_pBusMasterBase, m_pCodecBase));
 
    //
    // Set m_bDirectRead to TRUE so that all AC97 register read and
    // writes are going directly to the HW
    //
    m_bDirectRead = TRUE;
 
    //
    // Initialize the hardware.
    //
    ntStatus = InitAC97 ();
    if (!NT_SUCCESS (ntStatus))
        return ntStatus;
 
    //
    // Probe hardware configuration
    //
    ntStatus = ProbeHWConfig ();
    if (!NT_SUCCESS (ntStatus))
    {
        DOUT (DBG_ERROR, ("Probing of hardware configuration failed!"));
        return ntStatus;
    }
 
    //
    // Now, every AC97 read access goes to the cache.
    //
    m_bDirectRead = FALSE;
 
    //
    // Restore the AC97 registers now.
    //
#if (DBG)
    DumpConfig ();
#endif
    ntStatus = SetAC97Default ();
 
    //
    // Initialize the device state.
    //
    m_PowerState = PowerDeviceD0;
 
    return ntStatus;
}

STDMETHODIMP_() [2/5]

STDMETHODIMP_

(

UCHAR

)

Definition at line 2249 of file common.cpp.

{
    UCHAR ucValue = UCHAR(-1);
 
    DOUT (DBG_PRINT, ("[CAC97AdapterCommon::ReadBMControlRegister8]"));
 
    ucValue = READ_PORT_UCHAR ((PUCHAR)(m_pBusMasterBase + ulOffset));
 
    DOUT (DBG_REGS, ("ReadBMControlRegister read 0x%2x from 0x%4p.", ucValue,
                   m_pBusMasterBase + ulOffset));
 
    return ucValue;
}

STDMETHODIMP_() [3/5]

STDMETHODIMP_

(

ULONG

)

Definition at line 2293 of file common.cpp.

{
    ULONG ulValue = ULONG(-1);
 
    DOUT (DBG_PRINT, ("[CAC97AdapterCommon::ReadBMControlRegister32]"));
 
    ulValue = READ_PORT_ULONG ((PULONG)(m_pBusMasterBase + ulOffset));
 
    DOUT (DBG_REGS, ("ReadBMControlRegister read 0x%8x = 0x%4p", ulValue,
                   m_pBusMasterBase + ulOffset));
 
    return ulValue;
}

STDMETHODIMP_() [4/5]

STDMETHODIMP_

(

USHORT

)

Definition at line 2271 of file common.cpp.

{
    USHORT usValue = USHORT(-1);
 
    DOUT (DBG_PRINT, ("[CAC97AdapterCommon::ReadBMControlRegister16]"));
 
    usValue = READ_PORT_USHORT ((PUSHORT)(m_pBusMasterBase + ulOffset));
 
    DOUT (DBG_REGS, ("ReadBMControlRegister read 0x%4x = 0x%4p", usValue,
                   m_pBusMasterBase + ulOffset));
 
    return usValue;
}

STDMETHODIMP_() [5/5]

STDMETHODIMP_

(

void

)

Definition at line 1532 of file common.cpp.

{
    PAGED_CODE ();
 
    NTSTATUS ntStatus = STATUS_SUCCESS;
 
    DOUT (DBG_PRINT, ("[CAC97AdapterCommon::PowerChangeNotify]"));
 
    //
    // Check to see if this is the current power state.
    //
    if (NewState.DeviceState == m_PowerState)
    {
        DOUT (DBG_POWER, ("New device state equals old state."));
        return;
    }
 
    //
    // Check the new device state.
    //
    if ((NewState.DeviceState < PowerDeviceD0) ||
        (NewState.DeviceState > PowerDeviceD3))
    {
        DOUT (DBG_ERROR, ("Unknown device state: D%d.",
             (ULONG)NewState.DeviceState - (ULONG)PowerDeviceD0));
        return;
    }
 
    DOUT (DBG_POWER, ("Changing state to D%d.", (ULONG)NewState.DeviceState -
                    (ULONG)PowerDeviceD0));
 
    //
    // Switch on new state.
    //
    switch (NewState.DeviceState)
    {
        case PowerDeviceD0:
            //
            // If we are coming from D2 or D3 we have to restore the registers cause
            // there might have been a power loss.
            //
            if ((m_PowerState == PowerDeviceD3) || (m_PowerState == PowerDeviceD2))
            {
                //
                // Reset AD3 to indicate that we are now awake.
                // Because the system has only one power irp at a time, we are sure
                // that the modem driver doesn't get called while we are restoring
                // power.
                //
                WriteBMControlRegister (GLOB_STA,
                    ReadBMControlRegister32 (GLOB_STA) & ~GLOB_STA_AD3);
 
                //
                // Restore codec registers.
                //
                ntStatus = RestoreCodecRegisters ();
            }
            else        // We are coming from power state D1
            {
                ntStatus = PowerUpCodec ();
            }
 
            // Print error code.
            if (!NT_SUCCESS (ntStatus))
            {
                DOUT (DBG_ERROR, ("PowerChangeState failed to restore the codec."));
            }
            break;
 
        case PowerDeviceD1:
            //
            // This sleep state is the lowest latency sleep state with respect
            // to the latency time required to return to D0. If the
            // driver is not being used an inactivity timer in portcls will
            // place the driver in this state after a timeout period
            // controllable via the registry.
            //
 
            // Let's power down the DAC/ADC's and analog mixer.
            WriteCodecRegister (AC97REG_POWERDOWN, 0x0700, 0xFFFF);
            break;
 
        case PowerDeviceD2:
        case PowerDeviceD3:
            //
            // This is a full hibernation state and is the longest latency sleep
            // state. In this modes the power could be removed or reduced that
            // much that the AC97 controller looses information, so we save
            // whatever we have to save.
            //
 
            //
            // Powerdown ADC, DAC, Mixer, Vref, HP amp, and Exernal Amp but not
            // AC-link and Clk
            //
            WriteCodecRegister (AC97REG_POWERDOWN, 0xCF00, 0xFFFF);
 
            //
            // Only in D3 mode we set the AD3 bit and evtl. shut off the AC link.
            //
            if (NewState.DeviceState == PowerDeviceD3)
            {
                //
                // Set the AD3 bit.
                //
                ULONG ulReg = ReadBMControlRegister32 (GLOB_STA);
                WriteBMControlRegister (GLOB_STA, ulReg | GLOB_STA_AD3);
 
                //
                // We check if the modem is sleeping. If it is, we can shut off the
                // AC link also. We shut off the AC link also if the modem is not
                // there.
                //
                if ((ulReg & GLOB_STA_MD3) || !(ulReg & GLOB_STA_SCR))
                {
                    // Set Codec to super sleep
                    WriteCodecRegister (AC97REG_POWERDOWN, 0xFF00, 0xFFFF);
 
                    // Disable the AC-link signals
                    ulReg = ReadBMControlRegister32 (GLOB_CNT);
                    WriteBMControlRegister (GLOB_CNT, (ulReg | GLOB_CNT_ACLOFF) & ~GLOB_CNT_COLD);
                }
            }
            break;
    }
 
    //
    // Save the new state.  This local value is used to determine when to
    // cache property accesses and when to permit the driver from accessing
    // the hardware.
    //
    m_PowerState = NewState.DeviceState;
    DOUT (DBG_POWER, ("Entering D%d", (ULONG)m_PowerState -
                      (ULONG)PowerDeviceD0));
}