]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Bus/Pci/PciBus/Dxe/pcibus.h
Use the "PAY_LOAD" StatusCode definitions defined in IntelFrameworkPkg.
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBus / Dxe / pcibus.h
CommitLineData
ead42efc 1/*++\r
2\r
3Copyright (c) 2006 - 2007, Intel Corporation\r
4All rights reserved. This program and the accompanying materials\r
5are licensed and made available under the terms and conditions of the BSD License\r
6which accompanies this distribution. The full text of the license may be found at\r
7http://opensource.org/licenses/bsd-license.php\r
8\r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
11\r
12Module Name:\r
13\r
14 pcibus.h\r
15\r
16Abstract:\r
17\r
18 PCI Bus Driver\r
19\r
20Revision History\r
21\r
22--*/\r
23\r
24#ifndef _EFI_PCI_BUS_H\r
25#define _EFI_PCI_BUS_H\r
26\r
27//\r
28// The package level header files this module uses\r
29//\r
30#include <PiDxe.h>\r
31#include <Common/FrameworkStatusCode.h>\r
938f2b4f 32#include <Common/FrameworkStatusCodeDataTypeId.h>\r
ead42efc 33//\r
34// The protocols, PPI and GUID defintions for this module\r
35//\r
36#include <Protocol/LoadedImage.h>\r
37#include <Protocol/PciHostBridgeResourceAllocation.h>\r
38#include <Protocol/PciIo.h>\r
39#include <Guid/PciHotplugDevice.h>\r
40#include <Protocol/PciRootBridgeIo.h>\r
41#include <Protocol/PciHotPlugRequest.h>\r
42#include <Protocol/DevicePath.h>\r
43#include <Protocol/PciPlatform.h>\r
44#include <Protocol/PciHotPlugInit.h>\r
45#include <Protocol/Decompress.h>\r
46#include <Guid/PciOptionRomTable.h>\r
47#include <Protocol/BusSpecificDriverOverride.h>\r
48#include <Protocol/UgaIo.h>\r
49//\r
50// The Library classes this module consumes\r
51//\r
52#include <Library/DebugLib.h>\r
53#include <Library/UefiDriverEntryPoint.h>\r
54#include <Library/BaseLib.h>\r
55#include <Library/UefiLib.h>\r
56#include <Library/BaseMemoryLib.h>\r
57#include <Library/ReportStatusCodeLib.h>\r
58#include <Library/MemoryAllocationLib.h>\r
59#include <Library/UefiBootServicesTableLib.h>\r
60#include <Library/DevicePathLib.h>\r
61#include <Library/PcdLib.h>\r
62#include <Library/PciIncompatibleDeviceSupportLib.h>\r
63\r
b1ef4015 64#include <IndustryStandard/Pci23.h>\r
65#include <IndustryStandard/PeImage.h>\r
ead42efc 66#include <IndustryStandard/Acpi.h>\r
67#include "ComponentName.h"\r
68\r
69//\r
70// Driver Produced Protocol Prototypes\r
71//\r
72\r
73#define VGABASE1 0x3B0\r
74#define VGALIMIT1 0x3BB\r
75\r
76#define VGABASE2 0x3C0\r
77#define VGALIMIT2 0x3DF\r
78\r
79#define ISABASE 0x100\r
80#define ISALIMIT 0x3FF\r
81\r
82typedef enum {\r
83 PciBarTypeUnknown = 0,\r
84 PciBarTypeIo16,\r
85 PciBarTypeIo32,\r
86 PciBarTypeMem32,\r
87 PciBarTypePMem32,\r
88 PciBarTypeMem64,\r
89 PciBarTypePMem64,\r
90 PciBarTypeIo,\r
91 PciBarTypeMem,\r
92 PciBarTypeMaxType\r
93} PCI_BAR_TYPE;\r
94\r
95typedef struct {\r
96 UINT64 BaseAddress;\r
97 UINT64 Length;\r
98 UINT64 Alignment;\r
99 PCI_BAR_TYPE BarType;\r
100 BOOLEAN Prefetchable;\r
101 UINT8 MemType;\r
102 UINT8 Offset;\r
103} PCI_BAR;\r
104\r
105#define PPB_BAR_0 0\r
106#define PPB_BAR_1 1\r
107#define PPB_IO_RANGE 2\r
108#define PPB_MEM32_RANGE 3\r
109#define PPB_PMEM32_RANGE 4\r
110#define PPB_PMEM64_RANGE 5\r
111#define PPB_MEM64_RANGE 0xFF\r
112\r
113#define P2C_BAR_0 0\r
114#define P2C_MEM_1 1\r
115#define P2C_MEM_2 2\r
116#define P2C_IO_1 3\r
117#define P2C_IO_2 4\r
118\r
119#define PCI_IO_DEVICE_SIGNATURE EFI_SIGNATURE_32 ('p', 'c', 'i', 'o')\r
120\r
121#define EFI_BRIDGE_IO32_DECODE_SUPPORTED 0x0001\r
122#define EFI_BRIDGE_PMEM32_DECODE_SUPPORTED 0x0002\r
123#define EFI_BRIDGE_PMEM64_DECODE_SUPPORTED 0x0004\r
124#define EFI_BRIDGE_IO16_DECODE_SUPPORTED 0x0008\r
125#define EFI_BRIDGE_PMEM_MEM_COMBINE_SUPPORTED 0x0010\r
126#define EFI_BRIDGE_MEM64_DECODE_SUPPORTED 0x0020\r
127#define EFI_BRIDGE_MEM32_DECODE_SUPPORTED 0x0040\r
128\r
129#define PCI_MAX_HOST_BRIDGE_NUM 0x0010\r
130//\r
131// Define resource status constant\r
132//\r
133#define EFI_RESOURCE_NONEXISTENT 0xFFFFFFFFFFFFFFFFULL\r
134#define EFI_RESOURCE_LESS 0xFFFFFFFFFFFFFFFEULL\r
135#define EFI_RESOURCE_SATISFIED 0x0000000000000000ULL\r
136\r
137//\r
138// Define option for attribute\r
139//\r
140#define EFI_SET_SUPPORTS 0\r
141#define EFI_SET_ATTRIBUTES 1\r
142\r
143typedef struct _PCI_IO_DEVICE {\r
144 UINT32 Signature;\r
145 EFI_HANDLE Handle;\r
146 EFI_PCI_IO_PROTOCOL PciIo;\r
147 LIST_ENTRY Link;\r
148\r
149 EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL PciDriverOverride;\r
150 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
151 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo;\r
152\r
153 //\r
154 // PCI configuration space header type\r
155 //\r
156 PCI_TYPE00 Pci;\r
157\r
158 //\r
159 // Bus number, Device number, Function number\r
160 //\r
161 UINT8 BusNumber;\r
162 UINT8 DeviceNumber;\r
163 UINT8 FunctionNumber;\r
164\r
165 //\r
166 // BAR for this PCI Device\r
167 //\r
168 PCI_BAR PciBar[PCI_MAX_BAR];\r
169\r
170 //\r
171 // The bridge device this pci device is subject to\r
172 //\r
173 struct _PCI_IO_DEVICE *Parent;\r
174\r
175 //\r
176 // A linked list for children Pci Device if it is bridge device\r
177 //\r
178 LIST_ENTRY ChildList;\r
179\r
180 //\r
181 // TURE if the PCI bus driver creates the handle for this PCI device\r
182 //\r
183 BOOLEAN Registered;\r
184\r
185 //\r
186 // TRUE if the PCI bus driver successfully allocates the resource required by\r
187 // this PCI device\r
188 //\r
189 BOOLEAN Allocated;\r
190\r
191 //\r
192 // The attribute this PCI device currently set\r
193 //\r
194 UINT64 Attributes;\r
195\r
196 //\r
197 // The attributes this PCI device actually supports\r
198 //\r
199 UINT64 Supports;\r
200\r
201 //\r
202 // The resource decode the bridge supports\r
203 //\r
204 UINT32 Decodes;\r
205\r
206 //\r
207 // The OptionRom Size\r
208 //\r
209 UINT64 RomSize;\r
210\r
211 //\r
212 // The OptionRom Size\r
213 //\r
214 UINT64 RomBase;\r
215\r
216 //\r
217 // TRUE if all OpROM (in device or in platform specific position) have been processed\r
218 //\r
219 BOOLEAN AllOpRomProcessed;\r
220\r
221 //\r
222 // TRUE if there is any EFI driver in the OptionRom\r
223 //\r
224 BOOLEAN BusOverride;\r
225\r
226 //\r
227 // A list tracking reserved resource on a bridge device\r
228 //\r
229 LIST_ENTRY ReservedResourceList;\r
230\r
231 //\r
232 // A list tracking image handle of platform specific overriding driver\r
233 //\r
234 LIST_ENTRY OptionRomDriverList;\r
235\r
236 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *ResourcePaddingDescriptors;\r
237 EFI_HPC_PADDING_ATTRIBUTES PaddingAttributes;\r
238\r
239 BOOLEAN IsPciExp;\r
240\r
241} PCI_IO_DEVICE;\r
242\r
243\r
244#define PCI_IO_DEVICE_FROM_PCI_IO_THIS(a) \\r
245 CR (a, PCI_IO_DEVICE, PciIo, PCI_IO_DEVICE_SIGNATURE)\r
246\r
247#define PCI_IO_DEVICE_FROM_PCI_DRIVER_OVERRIDE_THIS(a) \\r
248 CR (a, PCI_IO_DEVICE, PciDriverOverride, PCI_IO_DEVICE_SIGNATURE)\r
249\r
250#define PCI_IO_DEVICE_FROM_LINK(a) \\r
251 CR (a, PCI_IO_DEVICE, Link, PCI_IO_DEVICE_SIGNATURE)\r
252\r
253//\r
254// Global Variables\r
255//\r
256extern EFI_DRIVER_BINDING_PROTOCOL gPciBusDriverBinding;\r
257extern EFI_COMPONENT_NAME_PROTOCOL gPciBusComponentName;\r
258extern LIST_ENTRY gPciDevicePool;\r
259extern BOOLEAN gFullEnumeration;\r
260extern UINTN gPciHostBridgeNumber;\r
261extern EFI_HANDLE gPciHostBrigeHandles[PCI_MAX_HOST_BRIDGE_NUM];\r
262extern UINT64 gAllOne;\r
263extern UINT64 gAllZero;\r
264\r
265extern EFI_PCI_PLATFORM_PROTOCOL *gPciPlatformProtocol;\r
266\r
267#include "PciIo.h"\r
268#include "PciCommand.h"\r
269#include "PciDeviceSupport.h"\r
270#include "PciEnumerator.h"\r
271#include "PciEnumeratorSupport.h"\r
272#include "PciDriverOverride.h"\r
273#include "PciRomTable.h"\r
274#include "PciOptionRomSupport.h"\r
275#include "PciPowerManagement.h"\r
276#include "PciHotPlugSupport.h"\r
277#include "PciLib.h"\r
278\r
279//\r
280// PCI Bus Support Function Prototypes\r
281//\r
282EFI_STATUS\r
283EFIAPI\r
284PciBusDriverBindingSupported (\r
285 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
286 IN EFI_HANDLE Controller,\r
287 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
288 );\r
289\r
290EFI_STATUS\r
291EFIAPI\r
292PciBusDriverBindingStart (\r
293 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
294 IN EFI_HANDLE Controller,\r
295 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
296 );\r
297\r
298EFI_STATUS\r
299EFIAPI\r
300PciBusDriverBindingStop (\r
301 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
302 IN EFI_HANDLE Controller,\r
303 IN UINTN NumberOfChildren,\r
304 IN EFI_HANDLE *ChildHandleBuffer\r
305 );\r
306\r
307#endif\r