/** @file
  Struct and GUID definitions for CpuInitDataHob.

@copyright
  INTEL CONFIDENTIAL
  Copyright 2013 - 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 _CPU_INIT_DATA_HOB_H_
#define _CPU_INIT_DATA_HOB_H_

#include <Ppi/SiPolicy.h>
#include <PowerMgmtNvsStruct.h>
#define TDP_MAX_LEVEL 3

extern EFI_GUID gCpuInitDataHobGuid;

///
/// This HOB is used to pass only the required information from PEI for DXE consumption.
///
typedef struct {
  UINT32                 PpmFlags;                                /// PPM Flags Values.
  UINT8                  CtdpLevelsSupported;                     /// ConfigTdp Number Of Levels.
  UINT8                  ApplyConfigTdp;                          /// Enable Configurable TDP
  UINT8                  LowestMaxPerf;                           /// Max ratio of the slowest core.
  UINT8                  ConfigurablePpc;                         /// Boot Mode vlues for _PPC
  UINT8                  ConfigTdpLevel;                          /// Configuration for boot TDP selection; <b>0: TDP Nominal</b>; 1: TDP Down; 2: TDP Up.
  UINT8                  CtdpTar[TDP_MAX_LEVEL];                  /// CTDP Levels TAR
  UINT8                  ConfigTdpBootModeIndex;                  /// CTDP Boot Mode Index
  UINT16                 CtdpPowerLimit1[TDP_MAX_LEVEL];          /// CTDP Levels Power Limit1
  UINT16                 CtdpPowerLimit2[TDP_MAX_LEVEL];          /// CTDP Levels Power Limit2
  UINT8                  CtdpPowerLimitWindow[TDP_MAX_LEVEL];     /// CTDP Levels Power Limit1 Time Window
  UINT8                  CtdpCtc[TDP_MAX_LEVEL];                  /// CTDP Levels CTC
  UINT8                  CtdpPpc[TDP_MAX_LEVEL];                  /// CTDP Levels PPC
  UINT8                  EnableItbm;                              /// Enable/Disable Intel Turbo Boost Max Technology 3.0.
  UINT8                  EnableItbmDriver;                        /// @Deprecated: Intel Turbo Boost Max Technology 3.0 Driver doesn't support for TGL.
  UINT8                  EnableAllThermalFunctions;
  UINT8                  PerCoreRatioOverride;                    /// Enable or disable Per Core PState OC supported.

  FVID_TABLE             FvidTable[TPSS_FVID_MAX_STATES+1];       /// FVID Table
  /**
  Number of supported Core Voltage & Frequency Point Offset.
  **/
  UINT8                  CoreVfPointCount;
  /**
  Array for the each selected Core VF Point to display the ration.
  **/
  UINT8                  CoreVfPointRatio[CPU_OC_MAX_VF_POINTS];
  /**
  Array used to specific max ratio applied to each selected Core.
  **/
  UINT8                  PerCoreRatio[CPU_MAX_BIG_CORES];
  /**
  Number of supported Ring Voltage & Frequency Point Offset.
  **/
  UINT8                  RingVfPointCount;
  /**
  Array for the each selected Ring VF Point to display the ration.
  **/
  UINT8                  RingVfPointRatio[CPU_OC_MAX_VF_POINTS];
  /**
  Array used to specific max ratio applied to each selected Atom Cluster.
  **/
  UINT8                  PerAtomClusterRatio[CPU_MAX_ATOM_CLUSTERS];
} CPU_INIT_DATA_HOB;
#endif