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
252
253
|
/** @file
Header file for the PCH Init PEIM
@copyright
Copyright (c) 2004 - 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_INIT_PEIM_H_
#define _PCH_INIT_PEIM_H_
#if !defined(EDK_RELEASE_VERSION) || (EDK_RELEASE_VERSION < 0x00020000)
#include "EdkIIGluePeim.h"
#include "PchInitVar.h"
#include "PchAccess.h"
#include "PchPlatformLib.h"
#include "PchUsbCommon.h"
#include "IobpDefinitions.h"
#include "PchHsio.h"
#include EFI_PPI_PRODUCER (PchInit)
#include EFI_PPI_PRODUCER (PchDmiTcVcMap)
#include EFI_PPI_CONSUMER (MemoryDiscovered)
#include EFI_PPI_CONSUMER (PchUsbPolicy)
#include EFI_PPI_CONSUMER (PchPlatformPolicy)
#include EFI_PPI_CONSUMER (PchReset)
#include EFI_PPI_PRODUCER (PchPeiInitDone)
#endif
//
// ChipsetInit settings defines
//
#define H2M_HSIO_MESSAGE (0x7 << 28)///< Master type for all H2M Hsio messages
#define H2M_HSIO_CMD_GETHSIOVER 1 ///< Triggers Hsio version to be sent through ME/Host FW Status registers
#define H2M_HSIO_CMD_CLOSE 0 ///< Triggers H2M Hsio interface to close and revert FW Status registers
#define M2H_HSIO_MSG_ACK 0x7 ///< Ack sent in response to any H2M Hsio messages
#define MAX_ME_MSG_ACK_TIMEOUT 0x186A0 // Wait max of 100ms for FW to acknowledge.
/**
Internal function performing SATA init needed in PEI phase
@param[in] PeiServices General purpose services available to every PEIM.
@param[in] PchPlatformPolicyPpi The PCH Platform Policy PPI instance
@retval None
**/
EFI_STATUS
EFIAPI
PchSataInit (
IN EFI_PEI_SERVICES **PeiServices,
IN PCH_PLATFORM_POLICY_PPI *PchPlatformPolicyPpi
);
/**
This function may trigger platform reset depending on the current GbE status,
the intended GbE enabling, and current ME status. (When ME is enabled, this function
may trigger a Global reset.)
This function may not return if it triggers an platform reset and the BIOS boot flow
restarts.
If this function returns EFI_SUCCESS it indicates there is no need for platform
reset in this boot, and boot flow continues.
If this function returns EFI_DEVICE_ERROR, something error happens.
@param[in] PeiServices General purpose services available to every PEIM.
@param[in] PchPlatformPolicyPpi The PCH Platform Policy PPI instance
@retval EFI_SUCCESS No platform reset action is taken. System can continue boot flow.
@retval Others Won't return if platform reset action is taken
**/
EFI_STATUS
EFIAPI
PchGbeMandatedReset (
IN EFI_PEI_SERVICES **PeiServices,
IN PCH_PLATFORM_POLICY_PPI *PchPlatformPolicyPpi
);
/**
Perform Thermal Management Support initialization
@param[in] PchPlatformPolicyPpi The PCH Platform Policy PPI instance
@retval EFI_SUCCESS Succeeds.
@retval EFI_DEVICE_ERROR Device error, aborts abnormally.
**/
EFI_STATUS
PchThermalInit (
IN PCH_PLATFORM_POLICY_PPI *PchPlatformPolicyPpi
);
/**
Initialize IOAPIC according to IoApicConfig policy of the PCH
Platform Policy PPI
@param[in] PchPlatformPolicyPpi The PCH Platform Policy PPI instance
@retval EFI_SUCCESS Succeeds.
@retval EFI_DEVICE_ERROR Device error, aborts abnormally.
**/
EFI_STATUS
PchIoApicInit (
IN PCH_PLATFORM_POLICY_PPI *PchPlatformPolicyPpi
);
/**
This function performs basic initialization for PCH in PEI phase.
If any of the base address arguments is zero, this function will disable the corresponding
decoding, otherwise this function will enable the decoding.
This function locks down the PMBase.
@param[in] PeiServices General purpose services available to every PEIM.
@param[in] NotifyDescriptor The notification structure this PEIM registered on install.
@param[in] Ppi The memory discovered PPI. Not used.
@retval EFI_SUCCESS Succeeds.
@retval EFI_DEVICE_ERROR Device error, aborts abnormally.
**/
EFI_STATUS
EFIAPI
PchInitialize (
IN EFI_PEI_SERVICES **PeiServices,
IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,
IN VOID *Ppi
);
/**
The function performing USB init in PEI phase. This could be used by USB recovery
or debug features that need USB initialization during PEI phase.
Note: Before executing this function, please be sure that PCH_INIT_PPI.Initialize
has been done and PchUsbPolicyPpi has been installed.
@param[in] PeiServices General purpose services available to every PEIM
@retval EFI_SUCCESS The function completed successfully
@retval Others All other error conditions encountered result in an ASSERT.
**/
EFI_STATUS
EFIAPI
PchUsbInit (
IN EFI_PEI_SERVICES **PeiServices
);
/**
The function performing TC/VC mapping program, and poll all PCH Virtual Channel
until negotiation completion
@param[in] PeiServices General purpose services available to every PEIM.
@retval EFI_SUCCESS The function completed successfully
@retval Others All other error conditions encountered result in an ASSERT.
**/
EFI_STATUS
EFIAPI
PchDmiTcVcProgPoll (
IN EFI_PEI_SERVICES **PeiServices
);
/**
The function set the Target Link Speed in PCH to DMI GEN 2.
@param[in] PeiServices General purpose services available to every PEIM.
@retval None
**/
VOID
EFIAPI
PchDmiGen2Prog (
IN EFI_PEI_SERVICES **PeiServices
);
/**
The function program DMI miscellaneous registers.
@param[in] PeiServices General purpose services available to every PEIM
@param[in] PchPlatformPolicyPpi The PCH Platform Policy PPI instance
@retval EFI_SUCCESS The DMI required settings programmed correctly
**/
EFI_STATUS
EFIAPI
PchDmiMiscProg (
IN EFI_PEI_SERVICES **PeiServices,
IN PCH_PLATFORM_POLICY_PPI *PchPlatformPolicyPpi
);
/**
The function is used while doing CPU Only Reset, where PCH may be required
to initialize strap data before soft reset.
@param[in] PeiServices General purpose services available to every PEIM
@param[in] Operation Get/Set Cpu Strap Set Data
@param[in, out] CpuStrapSet Cpu Strap Set Data
@retval EFI_SUCCESS The function completed successfully.
@exception EFI_UNSUPPORTED The function is not supported.
**/
EFI_STATUS
EFIAPI
PchCpuStrapSet (
IN EFI_PEI_SERVICES **PeiServices,
IN CPU_STRAP_OPERATION Operation,
IN OUT UINT16 *CpuStrapSet
);
/**
The function performing USB init in PEI phase. This could be
used by USB recovery ,debug features or usb precondition
enabled case that need USB initialization during PEI phase.
Please be sure the function should not be executed in if the
boot mode is S3 resume.
@param[in] PeiServices General purpose services available to every PEIM
@retval EFI_SUCCESS The function completed successfully
@retval Others All other error conditions encountered result in an ASSERT.
**/
EFI_STATUS
PchStartUsbInit (
IN PCH_USB_CONFIG *UsbConfig,
IN UINT32 EhciMemBaseAddr,
IN UINT32 XhciMemBaseAddr,
IN UINT8 Revision
);
/**
This function handles Pch S3 resume task
@param[in] PeiServices - Pointer to PEI Services Table.
@param[in] NotifyDesc - Pointer to the descriptor for the Notification event that
caused this function to execute.
@param[in] Ppi - Pointer to the PPI data associated with this function.
@retval EFI_STATUS - Always return EFI_SUCCESS
**/
EFI_STATUS
PchS3ResumeAtEndOfPei (
IN EFI_PEI_SERVICES **PeiServices,
IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,
IN VOID *Ppi
);
#endif
|
