blob: 24ef5f82a1421c59f7196f6bea50e1d7d44819f7 (
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
/** @file
Helper functions for PCH SMM
@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 PCH_SMM_HELPERS_H
#define PCH_SMM_HELPERS_H
#include "PchSmm.h"
#include "PchxSmmHelpers.h"
//
// ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// SUPPORT / HELPER FUNCTIONS (PCH version-independent)
//
/**
Publish SMI Dispatch protocols.
@param[in] None
@retval None
**/
VOID
PchSmmPublishDispatchProtocols (
VOID
);
/**
Compare 2 SMM source descriptors' enable settings.
@param[in] Src1 Pointer to the PCH SMI source description table 1
@param[in] Src2 Pointer to the PCH SMI source description table 2
@retval TRUE The enable settings of the 2 SMM source descriptors are identical.
@retval FALSE The enable settings of the 2 SMM source descriptors are not identical.
**/
BOOLEAN
CompareEnables (
const IN PCH_SMM_SOURCE_DESC *Src1,
const IN PCH_SMM_SOURCE_DESC *Src2
);
/**
Compare 2 SMM source descriptors' statuses.
@param[in] Src1 Pointer to the PCH SMI source description table 1
@param[in] Src2 Pointer to the PCH SMI source description table 2
@retval TRUE The statuses of the 2 SMM source descriptors are identical.
@retval FALSE The statuses of the 2 SMM source descriptors are not identical.
**/
BOOLEAN
CompareStatuses (
const IN PCH_SMM_SOURCE_DESC *Src1,
const IN PCH_SMM_SOURCE_DESC *Src2
);
/**
Compare 2 SMM source descriptors, based on Enable settings and Status settings of them.
@param[in] Src1 Pointer to the PCH SMI source description table 1
@param[in] Src2 Pointer to the PCH SMI source description table 2
@retval TRUE The 2 SMM source descriptors are identical.
@retval FALSE The 2 SMM source descriptors are not identical.
**/
BOOLEAN
CompareSources (
const IN PCH_SMM_SOURCE_DESC *Src1,
const IN PCH_SMM_SOURCE_DESC *Src2
);
/**
Check if an SMM source is active.
@param[in] Src Pointer to the PCH SMI source description table
@retval TRUE It is active.
@retval FALSE It is inactive.
**/
BOOLEAN
SourceIsActive (
const IN PCH_SMM_SOURCE_DESC *Src
);
/**
Enable the SMI source event by set the SMI enable bit, this function would also clear SMI
status bit to make initial state is correct
@param[in] SrcDesc Pointer to the PCH SMI source description table
@retval None
**/
VOID
PchSmmEnableSource (
const PCH_SMM_SOURCE_DESC *SrcDesc
);
/**
Disable the SMI source event by clear the SMI enable bit
@param[in] SrcDesc Pointer to the PCH SMI source description table
@retval None
**/
VOID
PchSmmDisableSource (
const PCH_SMM_SOURCE_DESC *SrcDesc
);
/**
Clear the SMI status bit by set the source bit of SMI status register
@param[in] SrcDesc Pointer to the PCH SMI source description table
@retval None
**/
VOID
PchSmmClearSource (
const PCH_SMM_SOURCE_DESC *SrcDesc
);
/**
Sets the source to a 1 and then waits for it to clear.
Be very careful when calling this function -- it will not
ASSERT. An acceptable case to call the function is when
waiting for the NEWCENTURY_STS bit to clear (which takes
3 RTCCLKs).
@param[in] SrcDesc Pointer to the PCH SMI source description table
@retval None
**/
VOID
PchSmmClearSourceAndBlock (
const PCH_SMM_SOURCE_DESC *SrcDesc
);
#endif
|
