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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
/** @file
Header file for PchPlatform Lib.
Copyright (c) 2008 - 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 _PCH_PLATFORM_LIB_H_
#define _PCH_PLATFORM_LIB_H_
//
// Timeout value used when Sending / Receiving messages.
// NOTE: this must cover the longest possible wait time
// between message being sent and response being available.
// e.g. Virtual function readiness might take some time.
//
/**
Delay for at least the request number of microseconds.
This function would be called by runtime driver, please do not use any MMIO marco here.
@param[in] Microseconds Number of microseconds to delay.
**/
VOID
EFIAPI
PchPmTimerStall (
IN UINTN Microseconds
);
/**
Check whether SPI is in descriptor mode
@param[in] SpiBase The PCH Spi Base Address
@retval TRUE SPI is in descriptor mode
@retval FALSE SPI is not in descriptor mode
**/
BOOLEAN
EFIAPI
PchIsSpiDescriptorMode (
IN UINTN SpiBase
);
/**
Return SoC stepping type
@retval SOC_STEPPING SoC stepping type
**/
SOC_STEPPING
EFIAPI
SocStepping (
VOID
);
/**
Return SoC package type
@retval SOC_PACKAGE SoC package type
**/
SOC_PACKAGE
EFIAPI
GetSocPackageType (
VOID
);
/**
Determine if PCH is supported
@retval TRUE PCH is supported
@retval FALSE PCH is not supported
**/
BOOLEAN
IsPchSupported (
VOID
);
/**
This function can be called to enable/disable Alternate Access Mode
@param[in] IlbBase The PCH ILB Base Address
@param[in] AmeCtrl If TRUE, enable Alternate Access Mode.
If FALSE, disable Alternate Access Mode.
**/
VOID
EFIAPI
PchAlternateAccessMode (
IN UINTN IlbBase,
IN BOOLEAN AmeCtrl
);
/**
Write DWord data to extended IOSF-SB register block
@param[in] PortId Port ID of the target IOSF-SB block
@param[in] Register Register of the target IOSF-SB block
@param[in] Value Value to be written
@param[in] WriteOpCode Write Op Code
@param[in] Bar BAR
@param[in] Device Device Number
@param[in] Function Function Number
**/
VOID
PchMsgBusWriteEx32 (
IN UINT8 PortId,
IN UINT32 Register,
IN UINT32 Value,
IN UINT8 WriteOpCode,
IN UINT8 Bar, OPTIONAL
IN UINT8 Device, OPTIONAL
IN UINT8 Function OPTIONAL
);
/**
Write DWord data to IOSF-SB register block
@param[in] PortId Port ID of the target IOSF-SB block
@param[in] Register Register of the target IOSF-SB block
@param[in] Value Value to be written
@param[in] WriteOpCode Write Op Code
**/
VOID
PchMsgBusWrite32 (
IN UINT8 PortId,
IN UINT32 Register,
IN UINT32 Value,
IN UINT8 WriteOpCode
);
/**
Read DWord data from extended IOSF-SB register block
@param[in] PortId Port ID of the target IOSF-SB block
@param[in] Register Register of the target IOSF-SB block
@param[in] ReadOpCode Read Op Code
@param[in] Bar BAR
@param[in] Device Device Number
@param[in] Function Function Number
@retval Data32 Value to be read.
**/
UINT32
PchMsgBusReadEx32 (
IN UINT8 PortId,
IN UINT32 Register,
IN UINT8 ReadOpCode,
IN UINT8 Bar, OPTIONAL
IN UINT8 Device, OPTIONAL
IN UINT8 Function OPTIONAL
);
/**
Read DWord data from IOSF-SB register block
@param[in] PortId Port ID of the target IOSF-SB block
@param[in] Register Register of the target IOSF-SB block
@param[in] ReadOpCode Read Op Code
@retval Data32 Value to be read.
**/
UINT32
PchMsgBusRead32 (
IN UINT8 PortId,
IN UINT32 Register,
IN UINT8 ReadOpCode
);
/**
Read-modify-write DWord data from extended IOSF-SB register block
@param[in] PortId Port ID of the target IOSF-SB block
@param[in] Register Register of the target IOSF-SB block
@param[in] AndData Value to be ANDed
@param[in] OrData Value to be ORed
@param[in] ReadOpCode Read Op Code
@param[in] WriteOpCode Write Op Code
@param[in] Bar BAR
@param[in] Device Device Number
@param[in] Function Function Number
@retval EFI_SUCCESS Successfully completed.
**/
EFI_STATUS
EFIAPI
PchMsgBusAndThenOrEx32 (
IN UINT8 PortId,
IN UINT32 Register,
IN UINT32 AndData,
IN UINT32 OrData,
IN UINT8 ReadOpCode,
IN UINT8 WriteOpCode,
IN UINT8 Bar, OPTIONAL
IN UINT8 Device, OPTIONAL
IN UINT8 Function OPTIONAL
);
/**
Read-modify-write DWord data from IOSF-SB register block
@param[in] PortId Port ID of the target IOSF-SB block
@param[in] Register Register of the target IOSF-SB block
@param[in] AndData Value to be ANDed
@param[in] OrData Value to be ORed
@param[in] ReadOpCode Read Op Code
@param[in] WriteOpCode Write Op Code
@retval EFI_SUCCESS Successfully completed.
**/
EFI_STATUS
EFIAPI
PchMsgBusAndThenOr32 (
IN UINT8 PortId,
IN UINT32 Register,
IN UINT32 AndData,
IN UINT32 OrData,
IN UINT8 ReadOpCode,
IN UINT8 WriteOpCode
);
/**
This function can be called to poll for certain value within a time given.
@param[in] MmioAddress The Mmio Address.
@param[in] BitMask Bits to be masked.
@param[in] BitValue Value to be polled.
#param[in] DelayTime Delay time in terms of 100 micro seconds.
@retval EFI_SUCCESS Successfully polled the value.
@retval EFI_TIMEOUT Timeout while polling the value.
**/
EFI_STATUS
EFIAPI
PchMmioPoll32 (
IN UINTN MmioAddress,
IN UINT32 BitMask,
IN UINT32 BitValue,
IN UINT16 DelayTime
);
#endif
|
