alder_lake_bios/Intel/AlderLake/ClientOneSiliconPkg/Include/Library/MeFwStsLib.h

115 lines
3.1 KiB
C

/** @file
Definition for Me FWSTS Lib.
@copyright
INTEL CONFIDENTIAL
Copyright 2016 - 2020 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 _ME_FWSTS_LIB_H_
#define _ME_FWSTS_LIB_H_
#include <Uefi.h>
#include <Library/BaseLib.h>
#include <FwStsSmbiosTable.h>
#include <Register/HeciRegs.h>
extern CONST MEI_DEV_STRING gFwStsDeviceList[];
extern CONST UINT32 gFwStsOffsetTable[];
/**
Find the index of ME FwStsValue in gFwStsOffsetTable.
@param[in] FwStsValue FWSTS register value.
@retval UINT32 The index of FwStsValue in gFwStsOffsetTable
@retval 0xFF The index of FwStsValue is not found
**/
UINT32
EFIAPI
FindMeFwStsIndex (
IN UINT32 FwStsValue
);
/**
Get ME device count that needs to report FWSTS SMBIOS
@retval UINT8 Count of device list.
**/
UINT8
EFIAPI
GetMeFwStsDeviceCount (
VOID
);
/**
Get ME register offset count that needs to report FWSTS SMBIOS
@retval UINT8 Count of register offset.
**/
UINT8
EFIAPI
GetMeFwStsOffsetCount (
VOID
);
/**
Check if Debug CPU Disabled (DCD) bit is set from FIT CPU Debugging [Disabled].
If it is set, CPU probe is disabled.
@retval TRUE DCD is set
@retval FALSE DCD is clear
**/
BOOLEAN
IsCpuDebugDisabled (
VOID
);
/**
Get ME Firmware Status from FWSTS Hob.
@retval HECI_FWS_REGISTER ME firmware status value.
**/
HECI_FWS_REGISTER
GetMeStatusFromFwstsHob (
VOID
);
/**
Get ME operation mode from FWSTS Hob.
@retval UINT32 ME operation mode.
**/
UINT32
GetMeModeFromFwstsHob (
VOID
);
#endif