blob: ead184c1c29dc916b74c39f1fd2e811b0a2a067c (
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/** @file
This driver is responsible for the registration of child drivers
and the abstraction of the PCH SMI sources.
@copyright
Copyright (c) 1999 - 2012 Intel Corporation. All rights reserved
This software and associated documentation (if any) is furnished
under a license and may only be used or copied in accordance
with the terms of the license. Except as permitted by such
license, no part of this software or documentation may be
reproduced, stored in a retrieval system, or transmitted in any
form or by any means without the express written consent of
Intel Corporation.
This file contains an 'Intel Peripheral Driver' and 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
**/
#ifndef _PCHX_SMM_HELPERS_H_
#define _PCHX_SMM_HELPERS_H_
#include "PchSmm.h"
#include "PchPlatformLib.h"
/**
Initialize bits that aren't necessarily related to an SMI source.
@param[in] None
@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.
@param[in] None
@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.
@param[in] None
@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.
@param[in] None
@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)
@param[in] None
@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
@retval None
**/
VOID
WriteBitDesc (
const PCH_SMM_BIT_DESC *BitDesc,
const BOOLEAN ValueToWrite,
const BOOLEAN WriteClear
);
#endif
|
