136 lines
4.1 KiB
C
136 lines
4.1 KiB
C
/** @file
|
|
This driver is responsible for the registration of child drivers
|
|
and the abstraction of the PCH SMI sources.
|
|
|
|
@copyright
|
|
INTEL CONFIDENTIAL
|
|
Copyright 1999 - 2016 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 _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
|