/** @file
|
This driver is responsible for the registration of child drivers
|
and the abstraction of the PCH SMI sources.
|
|
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
#ifndef _PCHX_SMM_HELPERS_H_
|
#define _PCHX_SMM_HELPERS_H_
|
|
#include "PchSmm.h"
|
|
/**
|
Initialize bits that aren't necessarily related to an SMI source.
|
|
|
@retval EFI_SUCCESS SMI source initialization completed.
|
@retval Asserts Global Smi Bit is not enabled successfully.
|
**/
|
EFI_STATUS
|
PchSmmInitHardware (
|
VOID
|
);
|
|
/**
|
Enables the PCH to generate SMIs. Note that no SMIs will be generated
|
if no SMI sources are enabled. Conversely, no enabled SMI source will
|
generate SMIs if SMIs are not globally enabled. This is the main
|
switchbox for SMI generation.
|
|
|
@retval EFI_SUCCESS Enable Global Smi Bit completed
|
**/
|
EFI_STATUS
|
PchSmmEnableGlobalSmiBit (
|
VOID
|
);
|
|
/**
|
Clears the SMI after all SMI source have been processed.
|
Note that this function will not work correctly (as it is
|
written) unless all SMI sources have been processed.
|
A revision of this function could manually clear all SMI
|
status bits to guarantee success.
|
|
|
@retval EFI_SUCCESS Clears the SMIs completed
|
@retval Asserts EOS was not set to a 1
|
**/
|
EFI_STATUS
|
PchSmmClearSmi (
|
VOID
|
);
|
|
/**
|
Set the SMI EOS bit after all SMI source have been processed.
|
|
|
@retval FALSE EOS was not set to a 1; this is an error
|
@retval TRUE EOS was correctly set to a 1
|
**/
|
BOOLEAN
|
PchSmmSetAndCheckEos (
|
VOID
|
);
|
|
/**
|
Determine whether an ACPI OS is present (via the SCI_EN bit)
|
|
|
@retval TRUE ACPI OS is present
|
@retval FALSE ACPI OS is not present
|
**/
|
BOOLEAN
|
PchSmmGetSciEn (
|
VOID
|
);
|
|
/**
|
Read a specifying bit with the register
|
|
@param[in] BitDesc The struct that includes register address, size in byte and bit number
|
|
@retval TRUE The bit is enabled
|
@retval FALSE The bit is disabled
|
**/
|
BOOLEAN
|
ReadBitDesc (
|
CONST PCH_SMM_BIT_DESC *BitDesc
|
);
|
|
/**
|
Write a specifying bit with the register
|
|
@param[in] BitDesc The struct that includes register address, size in byte and bit number
|
@param[in] ValueToWrite The value to be wrote
|
@param[in] WriteClear If the rest bits of the register is write clear
|
|
**/
|
VOID
|
WriteBitDesc (
|
CONST PCH_SMM_BIT_DESC *BitDesc,
|
CONST BOOLEAN ValueToWrite,
|
CONST BOOLEAN WriteClear
|
);
|
|
#endif
|
