alder_lake_bios/Intel/AlderLake/ClientOneSiliconPkg/Pch/IncludePrivate/Library/PchInitLib.h

122 lines
3.5 KiB
C

/** @file
Header file for Pch Init Lib Pei Phase
@copyright
INTEL CONFIDENTIAL
Copyright 2014 - 2021 Intel Corporation.
The source code contained or described herein and all documents related to the
source code ("Material") are owned by Intel Corporation or its suppliers or
licensors. Title to the Material remains with Intel Corporation or its suppliers
and licensors. The Material may contain trade secrets and proprietary and
confidential information of Intel Corporation and its suppliers and licensors,
and is protected by worldwide copyright and trade secret laws and treaty
provisions. No part of the Material may be used, copied, reproduced, modified,
published, uploaded, posted, transmitted, distributed, or disclosed in any way
without Intel's prior express written permission.
No license under any patent, copyright, trade secret or other intellectual
property right is granted to or conferred upon you by disclosure or delivery
of the Materials, either expressly, by implication, inducement, estoppel or
otherwise. Any license under such intellectual property rights must be
express and approved by Intel in writing.
Unless otherwise agreed by Intel in writing, you may not remove or alter
this notice or any other notice embedded in Materials by Intel or
Intel's suppliers or licensors in any way.
This file contains an 'Intel Peripheral Driver' and is uniquely identified as
"Intel Reference Module" and is licensed for Intel CPUs and chipsets under
the terms of your license agreement with Intel or your vendor. This file may
be modified by the user, subject to additional terms of the license agreement.
@par Specification Reference:
**/
#ifndef _PCH_INIT_LIB_H_
#define _PCH_INIT_LIB_H_
#include <Ppi/SiPolicy.h>
#include <PmcSocConfig.h>
/**
Describes the configuration and capabilities of the
upstream component to which PCH is connected.
**/
typedef struct {
PMC_ADR_SOC_CONFIG AdrConfig;
UINT16 SnoopLtrReqUs;
} PCH_UPSTREAM_COMPONENT_CONFIG;
/**
PCH Init Pre Policy Entry Point
Performing Pch init in before Poilcy init
**/
VOID
EFIAPI
PchInitPrePolicy (
VOID
);
/**
Check some PCH policies are valid for debugging unexpected problem if these
values are not initialized or assigned incorrect resource.
@param[in] SiPreMemPolicy The SI PreMem Policy PPI instance
**/
VOID
PchValidatePolicy (
IN SI_PREMEM_POLICY_PPI *SiPreMemPolicy
);
/**
This function performs basic initialization for PCH in PEI phase after Policy produced.
If any of the base address arguments is zero, this function will disable the corresponding
decoding, otherwise this function will enable the decoding.
This function locks down the AcpiBase.
@param[in] SiPreMemPolicyPpi The Silicon PreMem Policy PPI instance
**/
VOID
EFIAPI
PchOnPolicyInstalled (
IN SI_PREMEM_POLICY_PPI *SiPreMemPolicyPpi
);
/**
Pch init after memory PEI module
@param[in] SiPolicy The Silicon Policy PPI instance
@retval None
**/
VOID
EFIAPI
PchInit (
IN SI_POLICY_PPI *SiPolicy,
IN PCH_UPSTREAM_COMPONENT_CONFIG *PchUpstreamComponentConfig
);
/**
I/O Expander init after memory PEI module
@param[in] SiPolicy The Silicon Policy PPI instance
@retval None
**/
VOID
EFIAPI
IoExpanderInit (
IN SI_POLICY_PPI *SiPolicy
);
/**
Pch End of PEI callback function. This is the last change before entering DXE and OS when S3 resume.
**/
VOID
PchOnEndOfPei (
VOID
);
#endif // _PEI_PCH_INIT_LIB_H_