]>
Commit | Line | Data |
---|---|---|
9060e3ec | 1 | /** @file\r |
2 | Header files and data structures needed by PCI Bus module.\r | |
3 | \r | |
1f6785c4 | 4 | Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r |
9d510e61 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
9060e3ec | 6 | \r |
7 | **/\r | |
8 | \r | |
9 | \r | |
10 | #ifndef _EFI_PCI_BUS_H_\r | |
11 | #define _EFI_PCI_BUS_H_\r | |
12 | \r | |
13 | #include <PiDxe.h>\r | |
14 | \r | |
15 | #include <Protocol/LoadedImage.h>\r | |
16 | #include <Protocol/PciHostBridgeResourceAllocation.h>\r | |
17 | #include <Protocol/PciIo.h>\r | |
18 | #include <Protocol/LoadFile2.h>\r | |
19 | #include <Protocol/PciRootBridgeIo.h>\r | |
20 | #include <Protocol/PciHotPlugRequest.h>\r | |
21 | #include <Protocol/DevicePath.h>\r | |
22 | #include <Protocol/PciPlatform.h>\r | |
23 | #include <Protocol/PciHotPlugInit.h>\r | |
24 | #include <Protocol/Decompress.h>\r | |
25 | #include <Protocol/BusSpecificDriverOverride.h>\r | |
26 | #include <Protocol/IncompatiblePciDeviceSupport.h>\r | |
27 | #include <Protocol/PciOverride.h>\r | |
28 | #include <Protocol/PciEnumerationComplete.h>\r | |
11a6cc5b | 29 | #include <Protocol/IoMmu.h>\r |
9060e3ec | 30 | \r |
31 | #include <Library/DebugLib.h>\r | |
32 | #include <Library/UefiDriverEntryPoint.h>\r | |
33 | #include <Library/BaseLib.h>\r | |
34 | #include <Library/UefiLib.h>\r | |
35 | #include <Library/BaseMemoryLib.h>\r | |
36 | #include <Library/ReportStatusCodeLib.h>\r | |
37 | #include <Library/MemoryAllocationLib.h>\r | |
38 | #include <Library/UefiBootServicesTableLib.h>\r | |
39 | #include <Library/DevicePathLib.h>\r | |
40 | #include <Library/PcdLib.h>\r | |
9060e3ec | 41 | \r |
42 | #include <IndustryStandard/Pci.h>\r | |
43 | #include <IndustryStandard/PeImage.h>\r | |
44 | #include <IndustryStandard/Acpi.h>\r | |
45 | \r | |
46 | typedef struct _PCI_IO_DEVICE PCI_IO_DEVICE;\r | |
47 | typedef struct _PCI_BAR PCI_BAR;\r | |
48 | \r | |
49 | #define EFI_PCI_RID(Bus, Device, Function) (((UINT32)Bus << 8) + ((UINT32)Device << 3) + (UINT32)Function)\r | |
50 | #define EFI_PCI_BUS_OF_RID(RID) ((UINT32)RID >> 8)\r | |
51 | \r | |
52 | #define EFI_PCI_IOV_POLICY_ARI 0x0001\r | |
53 | #define EFI_PCI_IOV_POLICY_SRIOV 0x0002\r | |
54 | #define EFI_PCI_IOV_POLICY_MRIOV 0x0004\r | |
55 | \r | |
56 | typedef enum {\r | |
57 | PciBarTypeUnknown = 0,\r | |
58 | PciBarTypeIo16,\r | |
59 | PciBarTypeIo32,\r | |
60 | PciBarTypeMem32,\r | |
61 | PciBarTypePMem32,\r | |
62 | PciBarTypeMem64,\r | |
63 | PciBarTypePMem64,\r | |
0176af14 | 64 | PciBarTypeOpRom,\r |
9060e3ec | 65 | PciBarTypeIo,\r |
66 | PciBarTypeMem,\r | |
67 | PciBarTypeMaxType\r | |
68 | } PCI_BAR_TYPE;\r | |
69 | \r | |
70 | #include "ComponentName.h"\r | |
71 | #include "PciIo.h"\r | |
72 | #include "PciCommand.h"\r | |
73 | #include "PciDeviceSupport.h"\r | |
74 | #include "PciEnumerator.h"\r | |
75 | #include "PciEnumeratorSupport.h"\r | |
76 | #include "PciDriverOverride.h"\r | |
77 | #include "PciRomTable.h"\r | |
78 | #include "PciOptionRomSupport.h"\r | |
79 | #include "PciPowerManagement.h"\r | |
80 | #include "PciHotPlugSupport.h"\r | |
81 | #include "PciLib.h"\r | |
82 | \r | |
83 | #define VGABASE1 0x3B0\r | |
84 | #define VGALIMIT1 0x3BB\r | |
85 | \r | |
86 | #define VGABASE2 0x3C0\r | |
87 | #define VGALIMIT2 0x3DF\r | |
88 | \r | |
89 | #define ISABASE 0x100\r | |
90 | #define ISALIMIT 0x3FF\r | |
91 | \r | |
92 | //\r | |
93 | // PCI BAR parameters\r | |
94 | //\r | |
95 | struct _PCI_BAR {\r | |
96 | UINT64 BaseAddress;\r | |
97 | UINT64 Length;\r | |
98 | UINT64 Alignment;\r | |
99 | PCI_BAR_TYPE BarType;\r | |
05070c1b | 100 | BOOLEAN BarTypeFixed;\r |
d4048391 | 101 | UINT16 Offset;\r |
9060e3ec | 102 | };\r |
103 | \r | |
104 | //\r | |
105 | // defined in PCI Card Specification, 8.0\r | |
106 | //\r | |
107 | #define PCI_CARD_MEMORY_BASE_0 0x1C\r | |
108 | #define PCI_CARD_MEMORY_LIMIT_0 0x20\r | |
109 | #define PCI_CARD_MEMORY_BASE_1 0x24\r | |
110 | #define PCI_CARD_MEMORY_LIMIT_1 0x28\r | |
111 | #define PCI_CARD_IO_BASE_0_LOWER 0x2C\r | |
112 | #define PCI_CARD_IO_BASE_0_UPPER 0x2E\r | |
113 | #define PCI_CARD_IO_LIMIT_0_LOWER 0x30\r | |
114 | #define PCI_CARD_IO_LIMIT_0_UPPER 0x32\r | |
115 | #define PCI_CARD_IO_BASE_1_LOWER 0x34\r | |
116 | #define PCI_CARD_IO_BASE_1_UPPER 0x36\r | |
117 | #define PCI_CARD_IO_LIMIT_1_LOWER 0x38\r | |
118 | #define PCI_CARD_IO_LIMIT_1_UPPER 0x3A\r | |
119 | #define PCI_CARD_BRIDGE_CONTROL 0x3E\r | |
120 | \r | |
121 | #define PCI_CARD_PREFETCHABLE_MEMORY_0_ENABLE BIT8\r | |
122 | #define PCI_CARD_PREFETCHABLE_MEMORY_1_ENABLE BIT9\r | |
123 | \r | |
8db6a82c RN |
124 | #define RB_IO_RANGE 1\r |
125 | #define RB_MEM32_RANGE 2\r | |
126 | #define RB_PMEM32_RANGE 3\r | |
127 | #define RB_MEM64_RANGE 4\r | |
128 | #define RB_PMEM64_RANGE 5\r | |
129 | \r | |
9060e3ec | 130 | #define PPB_BAR_0 0\r |
131 | #define PPB_BAR_1 1\r | |
132 | #define PPB_IO_RANGE 2\r | |
133 | #define PPB_MEM32_RANGE 3\r | |
134 | #define PPB_PMEM32_RANGE 4\r | |
135 | #define PPB_PMEM64_RANGE 5\r | |
136 | #define PPB_MEM64_RANGE 0xFF\r | |
137 | \r | |
138 | #define P2C_BAR_0 0\r | |
139 | #define P2C_MEM_1 1\r | |
140 | #define P2C_MEM_2 2\r | |
141 | #define P2C_IO_1 3\r | |
142 | #define P2C_IO_2 4\r | |
143 | \r | |
144 | #define EFI_BRIDGE_IO32_DECODE_SUPPORTED 0x0001\r | |
145 | #define EFI_BRIDGE_PMEM32_DECODE_SUPPORTED 0x0002\r | |
146 | #define EFI_BRIDGE_PMEM64_DECODE_SUPPORTED 0x0004\r | |
147 | #define EFI_BRIDGE_IO16_DECODE_SUPPORTED 0x0008\r | |
148 | #define EFI_BRIDGE_PMEM_MEM_COMBINE_SUPPORTED 0x0010\r | |
149 | #define EFI_BRIDGE_MEM64_DECODE_SUPPORTED 0x0020\r | |
150 | #define EFI_BRIDGE_MEM32_DECODE_SUPPORTED 0x0040\r | |
151 | \r | |
152 | #define PCI_MAX_HOST_BRIDGE_NUM 0x0010\r | |
153 | \r | |
154 | //\r | |
155 | // Define option for attribute\r | |
156 | //\r | |
157 | #define EFI_SET_SUPPORTS 0\r | |
158 | #define EFI_SET_ATTRIBUTES 1\r | |
159 | \r | |
160 | #define PCI_IO_DEVICE_SIGNATURE SIGNATURE_32 ('p', 'c', 'i', 'o')\r | |
161 | \r | |
162 | struct _PCI_IO_DEVICE {\r | |
163 | UINT32 Signature;\r | |
164 | EFI_HANDLE Handle;\r | |
165 | EFI_PCI_IO_PROTOCOL PciIo;\r | |
166 | LIST_ENTRY Link;\r | |
167 | \r | |
168 | EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL PciDriverOverride;\r | |
169 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
170 | EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo;\r | |
171 | EFI_LOAD_FILE2_PROTOCOL LoadFile2;\r | |
172 | \r | |
173 | //\r | |
174 | // PCI configuration space header type\r | |
175 | //\r | |
176 | PCI_TYPE00 Pci;\r | |
177 | \r | |
178 | //\r | |
179 | // Bus number, Device number, Function number\r | |
180 | //\r | |
181 | UINT8 BusNumber;\r | |
182 | UINT8 DeviceNumber;\r | |
183 | UINT8 FunctionNumber;\r | |
184 | \r | |
185 | //\r | |
186 | // BAR for this PCI Device\r | |
187 | //\r | |
188 | PCI_BAR PciBar[PCI_MAX_BAR];\r | |
189 | \r | |
190 | //\r | |
191 | // The bridge device this pci device is subject to\r | |
192 | //\r | |
193 | PCI_IO_DEVICE *Parent;\r | |
194 | \r | |
195 | //\r | |
196 | // A linked list for children Pci Device if it is bridge device\r | |
197 | //\r | |
198 | LIST_ENTRY ChildList;\r | |
199 | \r | |
200 | //\r | |
ed356b9e | 201 | // TRUE if the PCI bus driver creates the handle for this PCI device\r |
9060e3ec | 202 | //\r |
203 | BOOLEAN Registered;\r | |
204 | \r | |
205 | //\r | |
206 | // TRUE if the PCI bus driver successfully allocates the resource required by\r | |
207 | // this PCI device\r | |
208 | //\r | |
209 | BOOLEAN Allocated;\r | |
210 | \r | |
211 | //\r | |
212 | // The attribute this PCI device currently set\r | |
213 | //\r | |
214 | UINT64 Attributes;\r | |
215 | \r | |
216 | //\r | |
217 | // The attributes this PCI device actually supports\r | |
218 | //\r | |
219 | UINT64 Supports;\r | |
220 | \r | |
221 | //\r | |
222 | // The resource decode the bridge supports\r | |
223 | //\r | |
224 | UINT32 Decodes;\r | |
225 | \r | |
4ed4e19c | 226 | //\r |
227 | // TRUE if the ROM image is from the PCI Option ROM BAR\r | |
228 | //\r | |
229 | BOOLEAN EmbeddedRom;\r | |
230 | \r | |
9060e3ec | 231 | //\r |
232 | // The OptionRom Size\r | |
233 | //\r | |
1f6785c4 | 234 | UINT32 RomSize;\r |
9060e3ec | 235 | \r |
9060e3ec | 236 | //\r |
237 | // TRUE if all OpROM (in device or in platform specific position) have been processed\r | |
238 | //\r | |
239 | BOOLEAN AllOpRomProcessed;\r | |
240 | \r | |
241 | //\r | |
242 | // TRUE if there is any EFI driver in the OptionRom\r | |
243 | //\r | |
244 | BOOLEAN BusOverride;\r | |
245 | \r | |
246 | //\r | |
247 | // A list tracking reserved resource on a bridge device\r | |
248 | //\r | |
249 | LIST_ENTRY ReservedResourceList;\r | |
250 | \r | |
251 | //\r | |
252 | // A list tracking image handle of platform specific overriding driver\r | |
253 | //\r | |
254 | LIST_ENTRY OptionRomDriverList;\r | |
255 | \r | |
256 | EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *ResourcePaddingDescriptors;\r | |
257 | EFI_HPC_PADDING_ATTRIBUTES PaddingAttributes;\r | |
258 | \r | |
306bbe82 | 259 | //\r |
260 | // Bus number ranges for a PCI Root Bridge device\r | |
261 | //\r | |
262 | EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *BusNumberRanges;\r | |
263 | \r | |
9060e3ec | 264 | BOOLEAN IsPciExp;\r |
265 | //\r | |
266 | // For SR-IOV\r | |
267 | //\r | |
268 | UINT8 PciExpressCapabilityOffset;\r | |
269 | UINT32 AriCapabilityOffset;\r | |
270 | UINT32 SrIovCapabilityOffset;\r | |
271 | UINT32 MrIovCapabilityOffset;\r | |
272 | PCI_BAR VfPciBar[PCI_MAX_BAR];\r | |
273 | UINT32 SystemPageSize;\r | |
274 | UINT16 InitialVFs;\r | |
275 | UINT16 ReservedBusNum;\r | |
1ef26783 | 276 | //\r |
277 | // Per PCI to PCI Bridge spec, I/O window is 4K aligned,\r | |
ed356b9e | 278 | // but some chipsets support non-standard I/O window alignments less than 4K.\r |
1ef26783 | 279 | // This field is used to support this case.\r |
280 | //\r | |
281 | UINT16 BridgeIoAlignment;\r | |
9060e3ec | 282 | };\r |
283 | \r | |
284 | #define PCI_IO_DEVICE_FROM_PCI_IO_THIS(a) \\r | |
285 | CR (a, PCI_IO_DEVICE, PciIo, PCI_IO_DEVICE_SIGNATURE)\r | |
286 | \r | |
287 | #define PCI_IO_DEVICE_FROM_PCI_DRIVER_OVERRIDE_THIS(a) \\r | |
288 | CR (a, PCI_IO_DEVICE, PciDriverOverride, PCI_IO_DEVICE_SIGNATURE)\r | |
289 | \r | |
290 | #define PCI_IO_DEVICE_FROM_LINK(a) \\r | |
291 | CR (a, PCI_IO_DEVICE, Link, PCI_IO_DEVICE_SIGNATURE)\r | |
292 | \r | |
293 | #define PCI_IO_DEVICE_FROM_LOAD_FILE2_THIS(a) \\r | |
294 | CR (a, PCI_IO_DEVICE, LoadFile2, PCI_IO_DEVICE_SIGNATURE)\r | |
295 | \r | |
296 | \r | |
297 | \r | |
298 | //\r | |
299 | // Global Variables\r | |
300 | //\r | |
ea669c1b | 301 | extern EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL *gIncompatiblePciDeviceSupport;\r |
9060e3ec | 302 | extern EFI_DRIVER_BINDING_PROTOCOL gPciBusDriverBinding;\r |
303 | extern EFI_COMPONENT_NAME_PROTOCOL gPciBusComponentName;\r | |
304 | extern EFI_COMPONENT_NAME2_PROTOCOL gPciBusComponentName2;\r | |
305 | extern BOOLEAN gFullEnumeration;\r | |
306 | extern UINTN gPciHostBridgeNumber;\r | |
307 | extern EFI_HANDLE gPciHostBrigeHandles[PCI_MAX_HOST_BRIDGE_NUM];\r | |
308 | extern UINT64 gAllOne;\r | |
309 | extern UINT64 gAllZero;\r | |
310 | extern EFI_PCI_PLATFORM_PROTOCOL *gPciPlatformProtocol;\r | |
311 | extern EFI_PCI_OVERRIDE_PROTOCOL *gPciOverrideProtocol;\r | |
e0ee9d93 | 312 | extern BOOLEAN mReserveIsaAliases;\r |
313 | extern BOOLEAN mReserveVgaAliases;\r | |
9060e3ec | 314 | \r |
315 | /**\r | |
316 | Macro that checks whether device is a GFX device.\r | |
317 | \r | |
318 | @param _p Specified device.\r | |
319 | \r | |
ed356b9e GL |
320 | @retval TRUE Device is a GFX device.\r |
321 | @retval FALSE Device is not a GFX device.\r | |
9060e3ec | 322 | \r |
323 | **/\r | |
324 | #define IS_PCI_GFX(_p) IS_CLASS2 (_p, PCI_CLASS_DISPLAY, PCI_CLASS_DISPLAY_OTHER)\r | |
325 | \r | |
326 | /**\r | |
327 | Test to see if this driver supports ControllerHandle. Any ControllerHandle\r | |
328 | than contains a gEfiPciRootBridgeIoProtocolGuid protocol can be supported.\r | |
329 | \r | |
330 | @param This Protocol instance pointer.\r | |
331 | @param Controller Handle of device to test.\r | |
ed356b9e | 332 | @param RemainingDevicePath Optional parameter use to pick a specific child\r |
9060e3ec | 333 | device to start.\r |
334 | \r | |
335 | @retval EFI_SUCCESS This driver supports this device.\r | |
336 | @retval EFI_ALREADY_STARTED This driver is already running on this device.\r | |
337 | @retval other This driver does not support this device.\r | |
338 | \r | |
339 | **/\r | |
340 | EFI_STATUS\r | |
341 | EFIAPI\r | |
342 | PciBusDriverBindingSupported (\r | |
343 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
344 | IN EFI_HANDLE Controller,\r | |
345 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
346 | );\r | |
347 | \r | |
348 | /**\r | |
349 | Start this driver on ControllerHandle and enumerate Pci bus and start\r | |
350 | all device under PCI bus.\r | |
351 | \r | |
352 | @param This Protocol instance pointer.\r | |
353 | @param Controller Handle of device to bind driver to.\r | |
ed356b9e | 354 | @param RemainingDevicePath Optional parameter use to pick a specific child\r |
9060e3ec | 355 | device to start.\r |
356 | \r | |
357 | @retval EFI_SUCCESS This driver is added to ControllerHandle.\r | |
358 | @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle.\r | |
359 | @retval other This driver does not support this device.\r | |
360 | \r | |
361 | **/\r | |
362 | EFI_STATUS\r | |
363 | EFIAPI\r | |
364 | PciBusDriverBindingStart (\r | |
365 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
366 | IN EFI_HANDLE Controller,\r | |
367 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
368 | );\r | |
369 | \r | |
370 | /**\r | |
ed356b9e | 371 | Stop this driver on ControllerHandle. Support stopping any child handles\r |
9060e3ec | 372 | created by this driver.\r |
373 | \r | |
374 | @param This Protocol instance pointer.\r | |
375 | @param Controller Handle of device to stop driver on.\r | |
376 | @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r | |
377 | children is zero stop the entire bus driver.\r | |
378 | @param ChildHandleBuffer List of Child Handles to Stop.\r | |
379 | \r | |
380 | @retval EFI_SUCCESS This driver is removed ControllerHandle.\r | |
381 | @retval other This driver was not removed from this device.\r | |
382 | \r | |
383 | **/\r | |
384 | EFI_STATUS\r | |
385 | EFIAPI\r | |
386 | PciBusDriverBindingStop (\r | |
387 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
388 | IN EFI_HANDLE Controller,\r | |
389 | IN UINTN NumberOfChildren,\r | |
390 | IN EFI_HANDLE *ChildHandleBuffer\r | |
391 | );\r | |
392 | \r | |
393 | #endif\r |