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
|
/** @file
Copyright (c) 2018, 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 PCI_PLATFORM_H_
#define PCI_PLATFORM_H_
#include <PiDxe.h>
#include <Register/PchRegsSata.h>
#include <Register/PchRegsEva.h>
#include <PchAccess.h>
#include <Platform.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/S3PciLib.h>
#include <Library/PciLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/HobLib.h>
#include <Library/PcdLib.h>
#include <Protocol/Runtime.h>
#include <Protocol/CpuIo2.h>
#include <Protocol/PciCallback.h>
#include <Protocol/PciPlatform.h>
#include <Protocol/PciIovPlatform.h>
#include <Protocol/PciIo.h>
#include <Protocol/FirmwareVolume2.h>
#include <Guid/SetupVariable.h>
#include <Guid/SocketVariable.h>
#include <IndustryStandard/Pci.h>
//
// Global variables for Option ROMs
//
#define INVALID 0xBD
#define PCI_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('P', 'c', 'i', 'c')
typedef struct {
UINT32 Signature;
LIST_ENTRY Link;
EFI_PCI_CALLBACK_FUNC Function;
EFI_PCI_ENUMERATION_PHASE Phase;
} PCI_CALLBACK_DATA;
typedef struct {
EFI_HANDLE PciPlatformHandle;
EFI_HANDLE RootBridgeHandle;
EFI_PCI_PLATFORM_PROTOCOL PciPlatform;
EFI_PCI_CALLBACK_PROTOCOL PciCallback;
#ifdef EFI_PCI_IOV_SUPPORT
EFI_PCI_IOV_PLATFORM_PROTOCOL PciIovPlatform;
#endif
EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo;
EFI_CPU_IO2_PROTOCOL *CpuIo;
EFI_LIST_ENTRY PciCallbackList;
EFI_PCI_CALLBACK_CONTEXT Context;
EFI_PCI_ENUMERATION_PHASE PciEnumerationPhase;
UINT8 BusAssignedTime;
} PCI_PLATFORM_PRIVATE_DATA;
#define PCI_CALLBACK_DATA_FROM_LINK(_node) \
CR ( \
_node, \
PCI_CALLBACK_DATA, \
Link, \
PCI_CALLBACK_DATA_SIGNATURE \
)
extern PCI_PLATFORM_PRIVATE_DATA mPciPrivateData;
extern EFI_GUID gPchSataEfiLoadProtocolGuid;
/**
Perform initialization by the phase indicated.
@param This - Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
@param HostBridge - The associated PCI host bridge handle.
@param Phase - The phase of the PCI controller enumeration.
@param ChipsetPhase - Defines the execution phase of the PCI chipset driver.
@retval EFI_SUCCESS - Must return with success.
**/
EFI_STATUS
EFIAPI
PhaseNotify (
IN EFI_PCI_PLATFORM_PROTOCOL *This,
IN EFI_HANDLE HostBridge,
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE Phase,
IN EFI_PCI_CHIPSET_EXECUTION_PHASE ChipsetPhase
)
;
/**
The PlatformPrepController() function can be used to notify the platform driver so that
it can perform platform-specific actions. No specific actions are required.
Several notification points are defined at this time. More synchronization points may be
added as required in the future. The PCI bus driver calls the platform driver twice for
every PCI controller-once before the PCI Host Bridge Resource Allocation Protocol driver
is notified, and once after the PCI Host Bridge Resource Allocation Protocol driver has
been notified.
This member function may not perform any error checking on the input parameters. It also
does not return any error codes. If this member function detects any error condition, it
needs to handle those errors on its own because there is no way to surface any errors to
the caller.
@param This - Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
@param HostBridge - The associated PCI host bridge handle.
@param RootBridge - The associated PCI root bridge handle.
@param PciAddress - The address of the PCI device on the PCI bus.
@param Phase - The phase of the PCI controller enumeration.
@param ChipsetPhase - Defines the execution phase of the PCI chipset driver.
@retval EFI_SUCCESS - The function completed successfully.
**/
EFI_STATUS
EFIAPI
PlatformPrepController (
IN EFI_PCI_PLATFORM_PROTOCOL *This,
IN EFI_HANDLE HostBridge,
IN EFI_HANDLE RootBridge,
IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS PciAddress,
IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase,
IN EFI_PCI_CHIPSET_EXECUTION_PHASE ChipsetPhase
)
;
/**
Set the PciPolicy as EFI_RESERVE_ISA_IO_NO_ALIAS | EFI_RESERVE_VGA_IO_NO_ALIAS.
@param This - The pointer to the Protocol itself.
PciPolicy - the returned Policy.
@retval EFI_UNSUPPORTED - Function not supported.
@retval EFI_INVALID_PARAMETER - Invalid PciPolicy value.
**/
EFI_STATUS
EFIAPI
GetPlatformPolicy (
IN CONST EFI_PCI_PLATFORM_PROTOCOL *This,
OUT EFI_PCI_PLATFORM_POLICY *PciPolicy
)
;
/**
Return a PCI ROM image for the onboard device represented by PciHandle.
@param This - Protocol instance pointer.
PciHandle - PCI device to return the ROM image for.
RomImage - PCI Rom Image for onboard device.
RomSize - Size of RomImage in bytes.
@retval EFI_SUCCESS - RomImage is valid.
@retval EFI_NOT_FOUND - No RomImage.
**/
EFI_STATUS
EFIAPI
GetPciRom (
IN CONST EFI_PCI_PLATFORM_PROTOCOL *This,
IN EFI_HANDLE PciHandle,
OUT VOID **RomImage,
OUT UINTN *RomSize
)
;
/**
Register a callback during PCI bus enumeration
@param This - Protocol instance pointer.
@param Function - Callback function pointer.
@param Phase - PCI enumeration phase.
@retval EFI_SUCCESS - Function has registed successfully
@retval EFI_UNSUPPORTED - The function has been regisered
@retval EFI_InVALID_PARAMETER - The parameter is incorrect
**/
EFI_STATUS
EFIAPI
RegisterPciCallback (
IN EFI_PCI_CALLBACK_PROTOCOL *This,
IN EFI_PCI_CALLBACK_FUNC Function,
IN EFI_PCI_ENUMERATION_PHASE Phase
)
;
#endif
|
