blob: fccd7bcc487a7f3a31765d74bcb93ed6fa92d839 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/** @file
This driver is responsible for the registration of child drivers
and the abstraction of the PCH SMI sources.
Copyright (c) 1999 - 2015, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _PCHX_SMM_HELPERS_H_
#define _PCHX_SMM_HELPERS_H_
#include "PchSmm.h"
#include <Library/PchPlatformLib.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
|
