/** @file
|
PCH PMC Library.
|
All function in this library is available for PEI, DXE, and SMM,
|
But do not support UEFI RUNTIME environment call.
|
|
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
|
#include <Base.h>
|
#include <Uefi/UefiBaseType.h>
|
#include <Library/IoLib.h>
|
#include <Library/DebugLib.h>
|
#include <Library/BaseLib.h>
|
#include <Library/MmPciLib.h>
|
#include <PchAccess.h>
|
#include <Library/PchCycleDecodingLib.h>
|
#include <Library/PchPmcLib.h>
|
|
/**
|
Query PCH to determine the Pm Status
|
NOTE:
|
It's matter when did platform code use this library, since some status could be cleared by write one clear.
|
Therefore this funciton is not always return the same result in one boot.
|
It's suggested that platform code read this status in the beginning of post.
|
For the ColdBoot case, this function only returns one case of the cold boot. Some cold boot case might
|
depends on the power cycle scenario and should check with different condtion.
|
|
@param[in] PmStatus - The Pch Pm Status to be probed
|
|
@retval Return TRUE if Status querried is Valid or FALSE if otherwise
|
**/
|
BOOLEAN
|
GetPchPmStatus (
|
PCH_PM_STATUS PmStatus
|
)
|
{
|
UINTN PmcRegBase;
|
UINT32 PchPwrmBase;
|
UINT32 PmConA;
|
UINT32 PmConB;
|
UINT32 GblRst0;
|
|
PmcRegBase = MmPciBase (
|
DEFAULT_PCI_BUS_NUMBER_PCH,
|
PCI_DEVICE_NUMBER_PCH_PMC,
|
PCI_FUNCTION_NUMBER_PCH_PMC
|
);
|
PchPwrmBaseGet (&PchPwrmBase);
|
|
PmConA = MmioRead32 (PmcRegBase + R_PCH_PMC_GEN_PMCON_A);
|
PmConB = MmioRead32 (PmcRegBase + R_PCH_PMC_GEN_PMCON_B);
|
|
GblRst0 = MmioRead32 (PchPwrmBase + R_PCH_PWRM_124);
|
|
switch (PmStatus) {
|
case WarmBoot:
|
if (PmConA & B_PCH_PMC_GEN_PMCON_A_MEM_SR) {
|
return TRUE;
|
}
|
break;
|
|
case PwrFlr:
|
if (PmConB & B_PCH_PMC_GEN_PMCON_B_PWR_FLR) {
|
return TRUE;
|
}
|
break;
|
|
case PwrFlrSys:
|
if (GblRst0 & BIT12) {
|
return TRUE;
|
}
|
break;
|
|
case PwrFlrPch:
|
if (GblRst0 & BIT11) {
|
return TRUE;
|
}
|
break;
|
|
case ColdBoot:
|
///
|
/// Check following conditions for cold boot.
|
///
|
if ((GblRst0 & BIT11) && // PCHPWR_FLR
|
(GblRst0 & BIT12) && // SYSPWR_FLR
|
(!(PmConA & B_PCH_PMC_GEN_PMCON_A_MEM_SR))) {
|
return TRUE;
|
}
|
break;
|
|
default:
|
break;
|
}
|
|
return FALSE;
|
}
|
|
/**
|
Funtion to check if Battery lost or CMOS cleared.
|
|
@reval TRUE Battery is always present.
|
@reval FALSE CMOS is cleared.
|
**/
|
BOOLEAN
|
EFIAPI
|
PchIsRtcBatteryGood (
|
VOID
|
)
|
{
|
UINTN Data;
|
UINTN PmcBaseAddress;
|
|
//
|
// Check if the CMOS battery is present
|
// Checks RTC_PWR_STS bit in the GEN_PMCON_3 register
|
//
|
PmcBaseAddress = MmPciBase (
|
DEFAULT_PCI_BUS_NUMBER_PCH,
|
PCI_DEVICE_NUMBER_PCH_PMC,
|
PCI_FUNCTION_NUMBER_PCH_PMC
|
);
|
Data = MmioRead32 (PmcBaseAddress + R_PCH_PMC_GEN_PMCON_B);
|
|
if ((Data & B_PCH_PMC_GEN_PMCON_B_RTC_PWR_STS) == 0) {
|
return TRUE;
|
}
|
return FALSE;
|
}
|
|
/**
|
Returns the sleep type after system wakeup.
|
|
@param[out] SleepType Sleep type to be returned.
|
|
@retval TRUE A wake event occurred without power failure.
|
@retval FALSE Power failure occurred or not a wakeup.
|
|
**/
|
BOOLEAN
|
EFIAPI
|
GetSleepTypeAfterWakeup (
|
OUT UINT32 *SleepType
|
)
|
{
|
UINT16 Pm1Sts;
|
UINT32 Pm1Cnt;
|
UINTN PmcBaseAddress;
|
|
PmcBaseAddress = MmPciBase (
|
DEFAULT_PCI_BUS_NUMBER_PCH,
|
PCI_DEVICE_NUMBER_PCH_PMC,
|
PCI_FUNCTION_NUMBER_PCH_PMC
|
);
|
|
///
|
/// Read the ACPI registers
|
///
|
Pm1Sts = IoRead16 (PcdGet16 (PcdAcpiBaseAddress) + R_PCH_ACPI_PM1_STS);
|
Pm1Cnt = IoRead32 (PcdGet16 (PcdAcpiBaseAddress) + R_PCH_ACPI_PM1_CNT);
|
|
///
|
/// Get sleep type if a wake event occurred and there is no power failure and reset
|
///
|
if ((Pm1Sts & B_PCH_ACPI_PM1_STS_WAK) != 0) {
|
if ((MmioRead16 (PmcBaseAddress + R_PCH_PMC_GEN_PMCON_B) & (B_PCH_PMC_GEN_PMCON_B_RTC_PWR_STS | B_PCH_PMC_GEN_PMCON_B_PWR_FLR)) == 0) {
|
*SleepType = Pm1Cnt & B_PCH_ACPI_PM1_CNT_SLP_TYP;
|
|
return TRUE;
|
} else {
|
///
|
/// Clear Wake Status (WAK_STS) and Sleep Type (SLP_TYP)
|
///
|
IoWrite16 (PcdGet16 (PcdAcpiBaseAddress) + R_PCH_ACPI_PM1_STS, B_PCH_ACPI_PM1_STS_WAK);
|
Pm1Cnt &= ~B_PCH_ACPI_PM1_CNT_SLP_TYP;
|
IoWrite32 (PcdGet16 (PcdAcpiBaseAddress) + R_PCH_ACPI_PM1_CNT, Pm1Cnt);
|
|
return FALSE;
|
}
|
}
|
|
return FALSE;
|
}
|
