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 SC Init SMM Handler
Copyright (c) 2012 - 2016, 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 _SC_INIT_SMM_H_
#define _SC_INIT_SMM_H_
#include <PiDxe.h>
#include <Library/DebugLib.h>
#include <Library/IoLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/SmmServicesTableLib.h>
#include <Library/DxeServicesTableLib.h>
#include <Library/BaseMemoryLib.h>
#include <Protocol/SmmSwDispatch2.h>
#include <Protocol/SmmSxDispatch2.h>
#include <Protocol/SmmIoTrapDispatch2.h>
#include <Library/S3BootScriptLib.h>
#include <Library/HobLib.h>
#include <Protocol/SmmCpu.h>
#include <IndustryStandard/Pci30.h>
#include <ScAccess.h>
#include <Library/ScPlatformLib.h>
#include <Library/MmPciLib.h>
#include <Private/Library/PeiDxeSmmScPciExpressHelpersLib.h>
#include <Private/Guid/ScPolicyHobGuid.h>
#include <Ppi/ScPcieDeviceTable.h>
#include <Protocol/ScPcieSmiDispatch.h>
#include <Protocol/ScSmmIoTrapControl.h>
#include <Private/Protocol/ScNvs.h>
#include <Private/Protocol/PcieIoTrap.h>
#include <Include/SiPolicyHob.h>
#include <Library/ConfigBlockLib.h>
extern EFI_SMM_SW_DISPATCH2_PROTOCOL *mSwDispatch;
extern EFI_SMM_SX_DISPATCH2_PROTOCOL *mSxDispatch;
extern SC_NVS_AREA *mScNvsArea;
extern UINT16 mAcpiBaseAddr;
extern SC_POLICY_HOB *mScPolicy;
extern SC_PCIE_CONFIG *mPcieRpConfig;
extern EFI_PHYSICAL_ADDRESS mResvMmioBaseAddr;
extern UINTN mResvMmioSize;
#define EFI_PCI_CAPABILITY_ID_PCIPM 0x01
#define DeviceD0 0x00
#define DeviceD3 0x03
#define ARRAY_SIZE (data) (sizeof (data) / sizeof (data[0]))
typedef enum {
PciCfg,
PciMmr
} SC_PCI_ACCESS_TYPE;
typedef enum {
Acpi,
Rcrb,
Tco
} SC_ACCESS_TYPE;
typedef struct {
SC_ACCESS_TYPE AccessType;
UINT32 Address;
UINT32 Data;
UINT32 Mask;
UINT8 Width;
} SC_SAVE_RESTORE_REG;
typedef struct {
SC_SAVE_RESTORE_REG* ScSaveRestoreReg;
UINT8 size;
} SC_SAVE_RESTORE_REG_WRAP;
struct _SC_SAVE_RESTORE_PCI;
typedef struct _SC_SAVE_RESTORE_PCI{
SC_PCI_ACCESS_TYPE AccessType;
UINT8 Device;
UINT8 Function;
UINT8 BarOffset;
UINT16 Offset;
UINT32 Data;
UINT32 Mask;
UINT8 Width;
VOID (*RestoreFunction) (struct _SC_SAVE_RESTORE_PCI *ScSaveRestorePci);
} SC_SAVE_RESTORE_PCI;
typedef struct {
SC_SAVE_RESTORE_PCI* ScSaveRestorePci;
UINT8 size;
} Sc_SAVE_RESTORE_PCI_WRAP;
typedef struct {
UINT8 Device;
UINT8 Function;
UINT8 PowerState;
} DEVICE_POWER_STATE;
/**
Register PCIE Hotplug SMI dispatch function to handle Hotplug enabling
@param[in] ImageHandle The image handle of this module
@param[in] SystemTable The EFI System Table
@retval EFI_SUCCESS The function completes successfully
**/
EFI_STATUS
EFIAPI
InitializeScPcieSmm (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
);
/**
Program Common Clock and ASPM of Downstream Devices
@param[in] PortIndex Pcie Root Port Number
@param[in] RpDevice Pcie Root Pci Device Number
@param[in] RpFunction Pcie Root Pci Function Number
@retval EFI_SUCCESS Root port complete successfully
@retval EFI_UNSUPPORTED PMC has invalid vendor ID
**/
EFI_STATUS
ScPcieSmi (
IN UINT8 PortIndex,
IN UINT8 RpDevice,
IN UINT8 RpFunction
);
/**
PCIE Link Active State Change Hotplug SMI call back function for all Root ports
@param[in] DispatchHandle Handle of this dispatch function
@param[in] RpContext Rootport context, which contains RootPort Index,
and RootPort PCI BDF.
@retval None
**/
VOID
EFIAPI
ScPcieLinkActiveStateChange (
IN EFI_HANDLE DispatchHandle,
IN SC_PCIE_SMI_RP_CONTEXT *RpContext
);
/**
PCIE Link Equalization Request SMI call back function for all Root ports
@param[in] DispatchHandle Handle of this dispatch function
@param[in] RpContext Rootport context, which contains RootPort Index,
and RootPort PCI BDF.
@retval None
**/
VOID
EFIAPI
ScPcieLinkEqHandlerFunction (
IN EFI_HANDLE DispatchHandle,
IN SC_PCIE_SMI_RP_CONTEXT *RpContext
);
/**
The SW SMI callback to config PCIE power management settings
@param[in] DispatchHandle The handle of this callback, obtained when registering
@param[in] CallbackContext Pointer to the EFI_SMM_SW_REGISTER_CONTEXT
@param[in, out] CommBuffer Point to the CommBuffer structure
@param[in, out] CommBufferSize Point to the Size of CommBuffer structure
**/
VOID
ScPciePmSwSmiCallback (
IN EFI_HANDLE DispatchHandle,
IN EFI_SMM_SW_REGISTER_CONTEXT *DispatchContext,
IN OUT VOID *CommBuffer,
IN OUT UINTN *CommBufferSize
);
/**
Initializes the PCH SMM handler for PCH save and restore
@param[in] ImageHandle Handle for the image of this driver
@param[in] SystemTable Pointer to the EFI System Table
@retval EFI_SUCCESS PCH SMM handler was installed
**/
EFI_STATUS
EFIAPI
ScInitLateSmm (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
);
/**
Locate required protocol and register the 61h IO trap
@param[in] ImageHandle Handle for the image of this driver
@param[in] SystemTable Pointer to the EFI System Table
@retval EFI_SUCCESS PCH SMM handler was installed
**/
EFI_STATUS
EFIAPI
InstallIoTrapPort61h (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
);
/**
Initialize PCH Sx entry SMI handler.
@param[in] ImageHandle Handle for the image of this driver
@retval None
**/
VOID
InitializeSxHandler (
IN EFI_HANDLE ImageHandle
);
/**
PCH Sx entry SMI handler.
@param[in] Handle Handle of the callback
@param[in] Context The dispatch context
@param[in, out] CommBuffer A pointer to a collection of data in memory that will
be conveyed from a non-SMM environment into an SMM environment.
@param[in, out] CommBufferSize The size of the CommBuffer.
@retval EFI_SUCCESS
**/
EFI_STATUS
EFIAPI
ScSxHandler (
IN EFI_HANDLE Handle,
IN CONST VOID *Context OPTIONAL,
IN OUT VOID *CommBuffer OPTIONAL,
IN OUT UINTN *CommBufferSize OPTIONAL
);
/**
GbE Sx entry handler.
@param[in] None
@retval None
**/
VOID
ScLanSxCallback (
VOID
);
/**
This function performs GPIO Sx Isolation steps.
@param[in] None
@retval None
**/
VOID
ScGpioSxIsolationCallBack (
VOID
);
/**
Register dispatch function to handle GPIO pads Sx isolation
@param[in] None
@retval None
**/
VOID
InitializeGpioSxIsolationSmm (
VOID
);
/**
Entry point for Sc Bios Write Protect driver.
@param[in] ImageHandle Image handle of this driver.
@param[in] SystemTable Global system service table.
@retval EFI_SUCCESS Initialization complete.
**/
EFI_STATUS
EFIAPI
InstallScBiosWriteProtect (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
);
#endif
|
