3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _EFI_PCI_BUS_H
16 #define _EFI_PCI_BUS_H
19 #include <FrameworkDxe.h>
22 #include <Protocol/LoadedImage.h>
23 #include <Protocol/PciHostBridgeResourceAllocation.h>
24 #include <Protocol/PciIo.h>
25 #include <Guid/PciHotplugDevice.h>
26 #include <Protocol/PciRootBridgeIo.h>
27 #include <Protocol/PciHotPlugRequest.h>
28 #include <Protocol/DevicePath.h>
29 #include <Protocol/PciPlatform.h>
30 #include <Protocol/PciHotPlugInit.h>
31 #include <Protocol/Decompress.h>
32 #include <Guid/PciOptionRomTable.h>
33 #include <Protocol/BusSpecificDriverOverride.h>
34 #include <Protocol/UgaIo.h>
36 #include <Library/DebugLib.h>
37 #include <Library/UefiDriverEntryPoint.h>
38 #include <Library/BaseLib.h>
39 #include <Library/UefiLib.h>
40 #include <Library/BaseMemoryLib.h>
41 #include <Library/ReportStatusCodeLib.h>
42 #include <Library/MemoryAllocationLib.h>
43 #include <Library/UefiBootServicesTableLib.h>
44 #include <Library/DevicePathLib.h>
45 #include <Library/PcdLib.h>
46 #include <Library/PciIncompatibleDeviceSupportLib.h>
48 #include <IndustryStandard/Pci23.h>
49 #include <IndustryStandard/PeImage.h>
50 #include <IndustryStandard/Acpi.h>
51 #include "ComponentName.h"
54 // Driver Produced Protocol Prototypes
57 #define VGABASE1 0x3B0
58 #define VGALIMIT1 0x3BB
60 #define VGABASE2 0x3C0
61 #define VGALIMIT2 0x3DF
64 #define ISALIMIT 0x3FF
67 PciBarTypeUnknown
= 0,
91 #define PPB_IO_RANGE 2
92 #define PPB_MEM32_RANGE 3
93 #define PPB_PMEM32_RANGE 4
94 #define PPB_PMEM64_RANGE 5
95 #define PPB_MEM64_RANGE 0xFF
103 #define PCI_IO_DEVICE_SIGNATURE EFI_SIGNATURE_32 ('p', 'c', 'i', 'o')
105 #define EFI_BRIDGE_IO32_DECODE_SUPPORTED 0x0001
106 #define EFI_BRIDGE_PMEM32_DECODE_SUPPORTED 0x0002
107 #define EFI_BRIDGE_PMEM64_DECODE_SUPPORTED 0x0004
108 #define EFI_BRIDGE_IO16_DECODE_SUPPORTED 0x0008
109 #define EFI_BRIDGE_PMEM_MEM_COMBINE_SUPPORTED 0x0010
110 #define EFI_BRIDGE_MEM64_DECODE_SUPPORTED 0x0020
111 #define EFI_BRIDGE_MEM32_DECODE_SUPPORTED 0x0040
113 #define PCI_MAX_HOST_BRIDGE_NUM 0x0010
115 // Define resource status constant
117 #define EFI_RESOURCE_NONEXISTENT 0xFFFFFFFFFFFFFFFFULL
118 #define EFI_RESOURCE_LESS 0xFFFFFFFFFFFFFFFEULL
119 #define EFI_RESOURCE_SATISFIED 0x0000000000000000ULL
122 // Define option for attribute
124 #define EFI_SET_SUPPORTS 0
125 #define EFI_SET_ATTRIBUTES 1
127 typedef struct _PCI_IO_DEVICE
{
130 EFI_PCI_IO_PROTOCOL PciIo
;
133 EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL PciDriverOverride
;
134 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
135 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*PciRootBridgeIo
;
138 // PCI configuration space header type
143 // Bus number, Device number, Function number
147 UINT8 FunctionNumber
;
150 // BAR for this PCI Device
152 PCI_BAR PciBar
[PCI_MAX_BAR
];
155 // The bridge device this pci device is subject to
157 struct _PCI_IO_DEVICE
*Parent
;
160 // A linked list for children Pci Device if it is bridge device
162 LIST_ENTRY ChildList
;
165 // TURE if the PCI bus driver creates the handle for this PCI device
170 // TRUE if the PCI bus driver successfully allocates the resource required by
176 // The attribute this PCI device currently set
181 // The attributes this PCI device actually supports
186 // The resource decode the bridge supports
191 // The OptionRom Size
196 // The OptionRom Size
201 // TRUE if all OpROM (in device or in platform specific position) have been processed
203 BOOLEAN AllOpRomProcessed
;
206 // TRUE if there is any EFI driver in the OptionRom
211 // A list tracking reserved resource on a bridge device
213 LIST_ENTRY ReservedResourceList
;
216 // A list tracking image handle of platform specific overriding driver
218 LIST_ENTRY OptionRomDriverList
;
220 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*ResourcePaddingDescriptors
;
221 EFI_HPC_PADDING_ATTRIBUTES PaddingAttributes
;
228 #define PCI_IO_DEVICE_FROM_PCI_IO_THIS(a) \
229 CR (a, PCI_IO_DEVICE, PciIo, PCI_IO_DEVICE_SIGNATURE)
231 #define PCI_IO_DEVICE_FROM_PCI_DRIVER_OVERRIDE_THIS(a) \
232 CR (a, PCI_IO_DEVICE, PciDriverOverride, PCI_IO_DEVICE_SIGNATURE)
234 #define PCI_IO_DEVICE_FROM_LINK(a) \
235 CR (a, PCI_IO_DEVICE, Link, PCI_IO_DEVICE_SIGNATURE)
240 extern EFI_DRIVER_BINDING_PROTOCOL gPciBusDriverBinding
;
241 extern EFI_COMPONENT_NAME_PROTOCOL gPciBusComponentName
;
242 extern EFI_COMPONENT_NAME2_PROTOCOL gPciBusComponentName2
;
243 extern LIST_ENTRY gPciDevicePool
;
244 extern BOOLEAN gFullEnumeration
;
245 extern UINTN gPciHostBridgeNumber
;
246 extern EFI_HANDLE gPciHostBrigeHandles
[PCI_MAX_HOST_BRIDGE_NUM
];
247 extern UINT64 gAllOne
;
248 extern UINT64 gAllZero
;
250 extern EFI_PCI_PLATFORM_PROTOCOL
*gPciPlatformProtocol
;
253 #include "PciCommand.h"
254 #include "PciDeviceSupport.h"
255 #include "PciEnumerator.h"
256 #include "PciEnumeratorSupport.h"
257 #include "PciDriverOverride.h"
258 #include "PciRomTable.h"
259 #include "PciOptionRomSupport.h"
260 #include "PciPowerManagement.h"
261 #include "PciHotPlugSupport.h"
265 // PCI Bus Support Function Prototypes
269 PciBusDriverBindingSupported (
270 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
271 IN EFI_HANDLE Controller
,
272 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
277 PciBusDriverBindingStart (
278 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
279 IN EFI_HANDLE Controller
,
280 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
285 PciBusDriverBindingStop (
286 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
287 IN EFI_HANDLE Controller
,
288 IN UINTN NumberOfChildren
,
289 IN EFI_HANDLE
*ChildHandleBuffer