blob: a05697d337a55b881c675fa373e961a807feef7d (
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
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
|
/** @file
Header file for PCH Initialization Driver.
Copyright (c) 2017, 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 that 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_INITIALIZATION_DRIVER_H_
#define _PCH_INITIALIZATION_DRIVER_H_
typedef UINT16 STRING_REF;
#ifdef FSP_FLAG
#include <Library/PeiServicesLib.h>
#include <Uefi/UefiSpec.h>
#endif
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/IoLib.h>
#include <Library/TimerLib.h>
#include <Library/ConfigBlockLib.h>
#include <Protocol/DriverSupportedEfiVersion.h>
#include <Library/PchCycleDecodingLib.h>
#include <Library/PchPcieRpLib.h>
#include <Library/PchP2sbLib.h>
#include <Library/PchPcrLib.h>
#include <Library/PchEspiLib.h>
#include <Library/PchInfoLib.h>
#include <Library/TraceHubInitLib.h>
#include <Guid/EventGroup.h>
#include <Library/S3BootScriptLib.h>
#include <Protocol/PciIo.h>
#include <Protocol/PciPlatform.h>
#include <Protocol/PciEnumerationComplete.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/HobLib.h>
#include <Library/UefiLib.h>
#include <Library/MemoryAllocationLib.h>
#ifndef FSP_FLAG
#include <Library/DxeServicesTableLib.h>
#endif
#include <PchAccess.h>
#include <SiConfigHob.h>
#include <Protocol/PchInfo.h>
#include <IndustryStandard/Pci30.h>
#include <Library/AslUpdateLib.h>
#include <Library/MmPciLib.h>
#include <Library/CpuPlatformLib.h>
#include <Protocol/BlockIo.h>
#include <Protocol/PchEmmcTuning.h>
#include <Library/GpioLib.h>
#include <Library/GpioNativeLib.h>
#include <Protocol/PchNvs.h>
#include <Protocol/PcieIoTrap.h>
#include <Library/PchInitCommonLib.h>
#include <Library/PchPciExpressHelpersLib.h>
#include <Library/PchPsfLib.h>
#include <Library/PchPsfPrivateLib.h>
#include <PchConfigHob.h>
typedef struct {
PCH_INFO_PROTOCOL PchInfo;
} PCH_INSTANCE_PRIVATE_DATA;
//
// This struct is used to record the fields that is required to be saved and restored during RST PCIe Storage Remapping Configuration
//
typedef struct {
UINT8 PmCapPtr;
UINT8 PcieCapPtr;
UINT16 L1ssCapPtr;
UINT8 EndpointL1ssControl2;
UINT32 EndpointL1ssControl1;
UINT16 LtrCapPtr;
UINT32 EndpointLtrData;
UINT16 EndpointLctlData16;
UINT16 EndpointDctlData16;
UINT16 EndpointDctl2Data16;
UINT16 RootPortDctl2Data16;
} PCH_RST_PCIE_STORAGE_SAVE_RESTORE;
//
// This struct is used to record the result of RST PCIe Storage detection for each RST PCIe Storage Cycle Router supported on the platform
//
typedef struct {
BOOLEAN SupportRstPcieStoragRemapping; // Indicates if RST PCIe Storage Remapping is supported and PCIe storage device is found under a Cycle Router
UINT8 RootPortNum; // Indicates the root port number with RST PCIe Storage Remapping remapping supported and PCIe storage device plugged on, numbering is 0-based
UINT8 RootPortLane; // Indicates the root port lanes occupied by the PCIe storage device with 4-bit mask
UINT8 DeviceInterface; // Indicates the interface of the PCIe storage device (AHCI or NVMe)
UINT8 IsMsixSupported; // Indicates if the PCIe storage device support MSI-X cap
UINT16 MsixStartingVector; // Records the starting vector of PCIe storage device's MSI-X (if supported)
UINT16 MsixEndingVector; // Records the ending vector of PCIe storage device's MSI-X (if supported)
UINT32 EndPointBarSize; // Records the PCIe storage device's BAR size
UINT32 EndPointUniqueMsixTableBar; // Records the PCIe storage device's MSI-X Table BAR if it supports unique MSI-X Table BAR
UINT32 EndPointUniqueMsixTableBarValue; // Records the PCIe storage device's MSI-X Table BAR value if it supports unique MSI-X Table BAR
UINT32 EndPointUniqueMsixPbaBar; // Records the PCIe storage device's MSI-X PBA BAR if it supports unique MSI-X PBA BAR
UINT32 EndPointUniqueMsixPbaBarValue; // Records the PCIe storage device's MSI-X PBA BAR value if it supports unique MSI-X PBA BAR
UINT8 EndPointBcc; // Records the PCIe storage device's Base Class Code
UINT8 EndPointScc; // Records the PCIe storage device's Sub Class Code
UINT8 EndPointPi; // Records the PCIe storage device's Programming Interface
PCH_RST_PCIE_STORAGE_SAVE_RESTORE PchRstPcieStorageSaveRestore; // Records the fields that is required to be saved and restored
} PCH_RST_PCIE_STORAGE_DETECTION;
//
// Data definitions
//
extern EFI_HANDLE mImageHandle;
//
// Pch NVS area definition
//
extern PCH_NVS_AREA_PROTOCOL mPchNvsAreaProtocol;
extern PCH_CONFIG_HOB *mPchConfigHob;
extern SI_CONFIG_HOB *mSiConfigHob;
//
// Function Prototype
//
//
// Local function prototypes
//
/**
Initialize the PCH device according to the PCH Policy HOB
and install PCH info instance.
**/
VOID
InitializePchDevice (
VOID
);
/**
Common PchInit Module Entry Point
**/
VOID
PchInitEntryPointCommon (
VOID
);
/**
Common PCH initialization on PCI enumeration complete.
**/
VOID
PchOnPciEnumCompleteCommon (
VOID
);
/**
Configures Serial IO Controllers
**/
EFI_STATUS
ConfigureSerialIoAtBoot (
VOID
);
/**
Creates device handles for SerialIo devices in ACPI mode
**/
VOID
CreateSerialIoHandles (
VOID
);
/**
Mark memory used by SerialIo devices in ACPI mode as allocated
@retval EFI_SUCCESS The function completed successfully
**/
EFI_STATUS
AllocateSerialIoMemory (
VOID
);
/**
Update ASL definitions for SerialIo devices.
@retval EFI_SUCCESS The function completed successfully
**/
EFI_STATUS
UpdateSerialIoAcpiData (
VOID
);
/**
Initialize PCIE SRC clocks in ICC subsystem
@param[in] GbePortNumber Number of PCIE rootport assigned to GbE adapter
**/
VOID
ConfigurePchPcieClocks (
IN UINTN GbePortNumber
);
/**
Initialize Intel High Definition Audio ACPI Tables
@retval EFI_SUCCESS The function completed successfully
@retval EFI_LOAD_ERROR ACPI table cannot be installed
@retval EFI_UNSUPPORTED ACPI table not set because DSP is disabled
**/
EFI_STATUS
PchHdAudioAcpiInit (
VOID
);
/**
Configure eMMC in HS400 Mode
@param[in] This A pointer to PCH_EMMC_TUNING_PROTOCOL structure
@param[in] Revision Revision parameter used to verify the layout of EMMC_INFO and TUNINGDATA.
@param[in] EmmcInfo A pointer to EMMC_INFO structure
@param[out] EmmcTuningData A pointer to EMMC_TUNING_DATA structure
@retval EFI_SUCCESS The function completed successfully
@retval EFI_NOT_FOUND The item was not found
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_INVALID_PARAMETER A parameter was incorrect.
@retval EFI_DEVICE_ERROR Hardware Error
@retval EFI_NO_MEDIA No media
@retval EFI_MEDIA_CHANGED Media Change
@retval EFI_BAD_BUFFER_SIZE Buffer size is bad
@retval EFI_CRC_ERROR Command or Data CRC Error
**/
EFI_STATUS
EFIAPI
ConfigureEmmcHs400Mode (
IN PCH_EMMC_TUNING_PROTOCOL *This,
IN UINT8 Revision,
IN EMMC_INFO *EmmcInfo,
OUT EMMC_TUNING_DATA *EmmcTuningData
);
/**
Install PCH EMMC TUNING PROTOCOL
**/
VOID
InstallPchEmmcTuningProtocol (
VOID
);
/**
Perform the remaining configuration on PCH SATA to perform device detection,
then set the SATA SPD and PxE corresponding, and set the Register Lock on PCH SATA
@retval None
**/
VOID
ConfigurePchSataOnEndOfDxe (
VOID
);
/**
Update ASL data for CIO2 Device.
@retval EFI_SUCCESS The function completed successfully
**/
EFI_STATUS
UpdateCio2AcpiData (
VOID
);
/**
Initialize Pch acpi
@param[in] ImageHandle Handle for the image of this driver
@retval EFI_SUCCESS The function completed successfully
@retval EFI_OUT_OF_RESOURCES Do not have enough resources to initialize the driver
**/
EFI_STATUS
EFIAPI
PchAcpiInit (
IN EFI_HANDLE ImageHandle
);
/**
Update ASL object before Boot
@retval EFI_STATUS
@retval EFI_NOT_READY The Acpi protocols are not ready.
**/
EFI_STATUS
PchUpdateNvsArea (
VOID
);
/**
Initialize PCH Nvs Area opeartion region.
@retval EFI_SUCCESS initialized successfully
@retval EFI_NOT_FOUND Nvs Area operation region is not found
**/
EFI_STATUS
PatchPchNvsAreaAddress (
VOID
);
/**
PCH Update NvsArea ExitBootServicesFlag on ExitBootService. This event is used if only ExitBootService is used
and not in legacy boot
@retval None
**/
VOID
EFIAPI
PchUpdateNvsOnExitBootServices (
VOID
);
#endif // _PCH_INITIALIZATION_DRIVER_H_
|