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
|
/**@file
Hardware info library with types and accessors to parse information about
PCI host bridges.
Copyright 2021 - 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef __HARDWARE_INFO_PCI_HOST_BRIDGE_LIB_H__
#define __HARDWARE_INFO_PCI_HOST_BRIDGE_LIB_H__
#include <Uefi/UefiBaseType.h>
#include <Uefi/UefiSpec.h>
#include <Library/PciHostBridgeLib.h>
//
// Host Bridge resources information
//
#pragma pack(1)
typedef struct {
//
// Feature tracking, initially 0
//
UINT64 Version;
//
// Host bridge enabled attributes (EFI_PCI_ATTRIBUTE_*)
//
UINT64 Attributes;
union {
UINT32 Uint32;
struct {
UINT32 DmaAbove4G : 1;
UINT32 NoExtendedConfigSpace : 1;
UINT32 CombineMemPMem : 1;
UINT32 Reserved : 29;
} Bits;
} Flags;
//
// Bus number range
//
UINT8 BusNrStart;
UINT8 BusNrLast;
UINT8 Padding[2];
//
// IO aperture
//
UINT64 IoStart;
UINT64 IoSize;
//
// 32-bit MMIO aperture
//
UINT64 MemStart;
UINT64 MemSize;
//
// 32-bit prefetchable MMIO aperture
//
UINT64 PMemStart;
UINT64 PMemSize;
//
// 64-bit MMIO aperture
//
UINT64 MemAbove4GStart;
UINT64 MemAbove4GSize;
//
// 64-bit prefetchable MMIO aperture
//
UINT64 PMemAbove4GStart;
UINT64 PMemAbove4GSize;
//
// MMIO accessible PCIe config space (ECAM)
//
UINT64 PcieConfigStart;
UINT64 PcieConfigSize;
} HOST_BRIDGE_INFO;
#pragma pack()
/**
Extract the last MMIO address, either from high (64-bit) or low (32-bit)
memory used by the HostBridge's apertures.
@param[in] HostBridge Root bridge's resources specification
@param[in] DataSize Size in bytes of the actually filled
data available in the HostBridge object
@param[in] HighMem 64-bit (true) or 32-bit (false) MMIO
address
@param[out] LastMmioAddress Pointer to last MMIO address
@retval EFI_SUCCESS Operation succeeded
@retval EFI_INVALID_PARAMETER One or more pointer parameters are
invalid
@retval EFI_INCOMPATIBLE_VERSION HostBridge information belongs to
an unsupported version
**/
EFI_STATUS
HardwareInfoPciHostBridgeLastMmioAddress (
IN CONST HOST_BRIDGE_INFO *HostBridge,
IN UINTN DataSize,
IN BOOLEAN HighMem,
OUT UINT64 *LastMmioAddress
);
/**
Interpret the HostBridge resources and extact the bus number
range.
@param[in] HostBridge Root bridge's resources specification
@param[in] DataSize Size in bytes of the actually filled
data available in the HostBridge object
@param[out] BusNrStart Pointer to the Bus Number range start
@param[out] BusNrLast Pointer to the Bus Number range end
@retval EFI_SUCCESS Retrieved the bus number range
without any issues.
@retval EFI_INVALID_PARAMETER One of the parameters is invalid,
either NULL pointer or size 0
@retval EFI_INCOMPATIBLE_VERSION HostBridge data of unsupported
version
**/
EFI_STATUS
HardwareInfoPciHostBridgeGetBusNrRange (
IN CONST HOST_BRIDGE_INFO *HostBridge,
IN UINTN DataSize,
OUT UINTN *BusNrStart,
OUT UINTN *BusNrLast
);
/**
Interpret the MMIO resources in HostBridge and set the apertures
in 32-bit space (Mem), 64-bit space (MemAbove4G), PIO (IO) and
ECAM (PcieConfig) accordingly.
The 2 types of apertures in each MMIO space (prefetchable and
non-prefetchable) may be merged into a single window, hence if both
types of apertures are defined while the CombineMemPMem flag is set,
the ranges must be contiguous.
@param[in] HostBridge Root bridge's resources specification
@param[in] DataSize Size in bytes of the actually filled
data available in the HostBridge object
@param[out] Mem Pointer to 32-bit MMIO aperture
@param[out] MemAbove4G Pointer to 64-bit MMIO aperture
@param[out] PMem Pointer to the 32-bit prefetchable MMIO aperture
@param[out] PMemAbove4G Pointer to the 64-bit prefetchable MMIO aperture
@param[out] PcieConfig Pointer to MMIO mapped PCIe config aperture (ECAM)
@retval EFI_INVALID_PARAMETER HostBridge object is invalid
@retval EFI_INCOMPATIBLE_VERSION HostBridge information belongs to
an unsupported version
@retval EFI_WARN_STALE_DATA One or more valid aperture in the
HostBridge's resources were ignored
because corresponding aperture pointer
is NULL.
@retval EFI_SUCCESS Operation executed cleanly, all valid
ranges were parsed into the corresponding
aperture object.
**/
EFI_STATUS
HardwareInfoPciHostBridgeGetApertures (
IN CONST HOST_BRIDGE_INFO *HostBridge,
IN UINTN DataSize,
OUT PCI_ROOT_BRIDGE_APERTURE *Io,
OUT PCI_ROOT_BRIDGE_APERTURE *Mem,
OUT PCI_ROOT_BRIDGE_APERTURE *MemAbove4G,
OUT PCI_ROOT_BRIDGE_APERTURE *PMem,
OUT PCI_ROOT_BRIDGE_APERTURE *PMemAbove4G,
OUT PCI_ROOT_BRIDGE_APERTURE *PcieConfig
);
/**
Retrieve all flags and attributes of a host bridge describing the
resources and capabilities.
@param[in] HostBridge Host bridge information object
@param[in] DataSize Size in bytes of the actually filled
data available in the HostBridge object
@param[out] Attributes Pointer to the host bridge's attributes
@param[out] DmaAbove4G Pointer to the DMA Above 4G flag
@param[out] NoExtendedConfigSpace Pointer to the Extended Config Space flag
@param[out] CombineMemPMem Pointer to the Combine Mem and PMem flag
@retval EFI_INVALID_PARAMETER HostBridge object is invalid
@retval EFI_INCOMPATIBLE_VERSION HostBridge information belongs to
an unsupported version
@retval EFI_SUCCESS Operation executed cleanly
**/
EFI_STATUS
HardwareInfoPciHostBridgeGetFlags (
IN CONST HOST_BRIDGE_INFO *HostBridge,
IN UINTN DataSize,
OUT UINT64 *Attributes OPTIONAL,
OUT BOOLEAN *DmaAbove4G OPTIONAL,
OUT BOOLEAN *NoExtendedConfigSpace OPTIONAL,
OUT BOOLEAN *CombineMemPMem OPTIONAL
);
/**
Getter that parses information from a HOST_BRIDGE_INFO object
into smaller chunks of types handled by the PciHostBridgeLib.
@param[in] HostBridge Host bridge information object
@param[in] DataSize Size in bytes of the actually filled
data available in the HostBridge object
@param[out] BusNrStart Pointer to the Bus Number range start
@param[out] BusNrLast Pointer to the Bus Number range end
@param[out] Attributes Pointer to the host bridge's attributes
@param[out] DmaAbove4G Pointer to the DMA Above 4G flag
@param[out] NoExtendedConfigSpace Pointer to the Extended Config Space flag
@param[out] CombineMemPMem Pointer to the Combine Mem and PMem flag
@param[out] Io Pointer to the PIO aperture object
@param[out] Mem Pointer to the 32-bit MMIO aperture object
@param[out] MemAbove4G Pointer to the 64-bit MMIO aperture object
@param[out] PMem Pointer to the 32-bit prefetchable MMIO
aperture object
@param[out] PMemAbove4G Pointer to the 64-bit prefetchable MMIO
aperture object
@param[out] PcieConfig MMIO mapped PCIe config aperture (ECAM)
@retval EFI_SUCCESS Whole operation succeeded
@retval EFI_INVALID_PARAMETER HostBridge object and/or non-optional
output parameters are invalid
@retval EFI_INCOMPATIBLE_VERSION HostBridge information provided belongs to
and unsupported version
@retval EFI_WARN_STALE_DATA One or more apertures having valid ranges
in the HostBridge info were ignored because
the correspnding aperture pointer is NULL
**/
EFI_STATUS
HardwareInfoPciHostBridgeGet (
IN CONST HOST_BRIDGE_INFO *HostBridge,
IN UINTN DataSize,
OUT UINTN *BusNrStart,
OUT UINTN *BusNrLast,
OUT UINT64 *Attributes OPTIONAL,
OUT BOOLEAN *DmaAbove4G OPTIONAL,
OUT BOOLEAN *NoExtendedConfigSpace OPTIONAL,
OUT BOOLEAN *CombineMemPMem OPTIONAL,
OUT PCI_ROOT_BRIDGE_APERTURE *Io OPTIONAL,
OUT PCI_ROOT_BRIDGE_APERTURE *Mem OPTIONAL,
OUT PCI_ROOT_BRIDGE_APERTURE *MemAbove4G OPTIONAL,
OUT PCI_ROOT_BRIDGE_APERTURE *PMem OPTIONAL,
OUT PCI_ROOT_BRIDGE_APERTURE *PMemAbove4G OPTIONAL,
OUT PCI_ROOT_BRIDGE_APERTURE *PcieConfig OPTIONAL
);
#endif // __HARDWARE_INFO_PCI_HOST_BRIDGE_LIB_H__
|
