]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciBus.h
fixed ECC and Klocwork issues.
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciBus.h
CommitLineData
eeefcb9d 1/** @file\r
ead42efc 2\r
c72216a6 3Copyright (c) 2006 - 2009, Intel Corporation\r
ea5632e5 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
ead42efc 11\r
3db51098 12**/\r
ead42efc 13\r
ead42efc 14\r
eeefcb9d 15#ifndef _EFI_PCI_BUS_H_\r
16#define _EFI_PCI_BUS_H_\r
ead42efc 17\r
ed7748fe 18\r
694b922c 19#include <FrameworkDxe.h>\r
20\r
ed7748fe 21\r
ead42efc 22#include <Protocol/LoadedImage.h>\r
23#include <Protocol/PciHostBridgeResourceAllocation.h>\r
24#include <Protocol/PciIo.h>\r
8e6b0dcb 25#include <Protocol/LoadFile2.h>\r
ead42efc 26#include <Protocol/PciRootBridgeIo.h>\r
27#include <Protocol/PciHotPlugRequest.h>\r
28#include <Protocol/DevicePath.h>\r
29#include <Protocol/PciPlatform.h>\r
30#include <Protocol/PciHotPlugInit.h>\r
31#include <Protocol/Decompress.h>\r
ead42efc 32#include <Protocol/BusSpecificDriverOverride.h>\r
33#include <Protocol/UgaIo.h>\r
ea5632e5 34#include <Protocol/IncompatiblePciDeviceSupport.h>\r
ed7748fe 35\r
ead42efc 36#include <Library/DebugLib.h>\r
37#include <Library/UefiDriverEntryPoint.h>\r
38#include <Library/BaseLib.h>\r
39#include <Library/UefiLib.h>\r
40#include <Library/BaseMemoryLib.h>\r
41#include <Library/ReportStatusCodeLib.h>\r
42#include <Library/MemoryAllocationLib.h>\r
43#include <Library/UefiBootServicesTableLib.h>\r
44#include <Library/DevicePathLib.h>\r
45#include <Library/PcdLib.h>\r
46#include <Library/PciIncompatibleDeviceSupportLib.h>\r
2fb718b0 47#include <Library/PeCoffLib.h>\r
ead42efc 48\r
bc14bdb3 49#include <IndustryStandard/Pci.h>\r
b1ef4015 50#include <IndustryStandard/PeImage.h>\r
ead42efc 51#include <IndustryStandard/Acpi.h>\r
52#include "ComponentName.h"\r
53\r
9f6531d1 54\r
55//\r
56// Global Variables\r
57//\r
58extern EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL *gEfiIncompatiblePciDeviceSupport;\r
59extern EFI_DRIVER_BINDING_PROTOCOL gPciBusDriverBinding;\r
60extern EFI_COMPONENT_NAME_PROTOCOL gPciBusComponentName;\r
61extern EFI_COMPONENT_NAME2_PROTOCOL gPciBusComponentName2;\r
62\r
ead42efc 63//\r
64// Driver Produced Protocol Prototypes\r
65//\r
66\r
67#define VGABASE1 0x3B0\r
68#define VGALIMIT1 0x3BB\r
69\r
70#define VGABASE2 0x3C0\r
71#define VGALIMIT2 0x3DF\r
72\r
73#define ISABASE 0x100\r
74#define ISALIMIT 0x3FF\r
75\r
76typedef enum {\r
77 PciBarTypeUnknown = 0,\r
78 PciBarTypeIo16,\r
79 PciBarTypeIo32,\r
80 PciBarTypeMem32,\r
81 PciBarTypePMem32,\r
82 PciBarTypeMem64,\r
83 PciBarTypePMem64,\r
84 PciBarTypeIo,\r
85 PciBarTypeMem,\r
86 PciBarTypeMaxType\r
87} PCI_BAR_TYPE;\r
88\r
89typedef struct {\r
90 UINT64 BaseAddress;\r
91 UINT64 Length;\r
92 UINT64 Alignment;\r
93 PCI_BAR_TYPE BarType;\r
94 BOOLEAN Prefetchable;\r
95 UINT8 MemType;\r
96 UINT8 Offset;\r
97} PCI_BAR;\r
98\r
99#define PPB_BAR_0 0\r
100#define PPB_BAR_1 1\r
101#define PPB_IO_RANGE 2\r
102#define PPB_MEM32_RANGE 3\r
103#define PPB_PMEM32_RANGE 4\r
104#define PPB_PMEM64_RANGE 5\r
105#define PPB_MEM64_RANGE 0xFF\r
106\r
107#define P2C_BAR_0 0\r
108#define P2C_MEM_1 1\r
109#define P2C_MEM_2 2\r
110#define P2C_IO_1 3\r
111#define P2C_IO_2 4\r
112\r
f02bd376 113#define PCI_IO_DEVICE_SIGNATURE SIGNATURE_32 ('p', 'c', 'i', 'o')\r
ead42efc 114\r
115#define EFI_BRIDGE_IO32_DECODE_SUPPORTED 0x0001\r
116#define EFI_BRIDGE_PMEM32_DECODE_SUPPORTED 0x0002\r
117#define EFI_BRIDGE_PMEM64_DECODE_SUPPORTED 0x0004\r
118#define EFI_BRIDGE_IO16_DECODE_SUPPORTED 0x0008\r
119#define EFI_BRIDGE_PMEM_MEM_COMBINE_SUPPORTED 0x0010\r
120#define EFI_BRIDGE_MEM64_DECODE_SUPPORTED 0x0020\r
121#define EFI_BRIDGE_MEM32_DECODE_SUPPORTED 0x0040\r
122\r
123#define PCI_MAX_HOST_BRIDGE_NUM 0x0010\r
ead42efc 124\r
125//\r
126// Define option for attribute\r
127//\r
128#define EFI_SET_SUPPORTS 0\r
129#define EFI_SET_ATTRIBUTES 1\r
130\r
c72216a6 131typedef struct _PCI_IO_DEVICE PCI_IO_DEVICE;\r
132\r
133struct _PCI_IO_DEVICE {\r
ead42efc 134 UINT32 Signature;\r
135 EFI_HANDLE Handle;\r
136 EFI_PCI_IO_PROTOCOL PciIo;\r
137 LIST_ENTRY Link;\r
138\r
139 EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL PciDriverOverride;\r
140 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
141 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo;\r
8e6b0dcb 142 EFI_LOAD_FILE2_PROTOCOL LoadFile2;\r
ead42efc 143\r
144 //\r
145 // PCI configuration space header type\r
146 //\r
147 PCI_TYPE00 Pci;\r
148\r
149 //\r
150 // Bus number, Device number, Function number\r
151 //\r
152 UINT8 BusNumber;\r
153 UINT8 DeviceNumber;\r
154 UINT8 FunctionNumber;\r
155\r
156 //\r
157 // BAR for this PCI Device\r
158 //\r
159 PCI_BAR PciBar[PCI_MAX_BAR];\r
160\r
161 //\r
162 // The bridge device this pci device is subject to\r
163 //\r
c72216a6 164 PCI_IO_DEVICE *Parent;\r
ead42efc 165\r
166 //\r
167 // A linked list for children Pci Device if it is bridge device\r
168 //\r
169 LIST_ENTRY ChildList;\r
170\r
171 //\r
172 // TURE if the PCI bus driver creates the handle for this PCI device\r
173 //\r
174 BOOLEAN Registered;\r
175\r
176 //\r
177 // TRUE if the PCI bus driver successfully allocates the resource required by\r
178 // this PCI device\r
179 //\r
180 BOOLEAN Allocated;\r
181\r
182 //\r
183 // The attribute this PCI device currently set\r
184 //\r
185 UINT64 Attributes;\r
186\r
187 //\r
188 // The attributes this PCI device actually supports\r
189 //\r
190 UINT64 Supports;\r
191\r
192 //\r
193 // The resource decode the bridge supports\r
194 //\r
195 UINT32 Decodes;\r
196\r
197 //\r
198 // The OptionRom Size\r
199 //\r
200 UINT64 RomSize;\r
201\r
202 //\r
203 // The OptionRom Size\r
204 //\r
205 UINT64 RomBase;\r
206\r
207 //\r
208 // TRUE if all OpROM (in device or in platform specific position) have been processed\r
209 //\r
210 BOOLEAN AllOpRomProcessed;\r
211\r
212 //\r
213 // TRUE if there is any EFI driver in the OptionRom\r
214 //\r
215 BOOLEAN BusOverride;\r
216\r
217 //\r
218 // A list tracking reserved resource on a bridge device\r
219 //\r
220 LIST_ENTRY ReservedResourceList;\r
221\r
222 //\r
223 // A list tracking image handle of platform specific overriding driver\r
224 //\r
225 LIST_ENTRY OptionRomDriverList;\r
226\r
227 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *ResourcePaddingDescriptors;\r
228 EFI_HPC_PADDING_ATTRIBUTES PaddingAttributes;\r
229\r
230 BOOLEAN IsPciExp;\r
231\r
c72216a6 232};\r
ead42efc 233\r
234\r
235#define PCI_IO_DEVICE_FROM_PCI_IO_THIS(a) \\r
236 CR (a, PCI_IO_DEVICE, PciIo, PCI_IO_DEVICE_SIGNATURE)\r
237\r
238#define PCI_IO_DEVICE_FROM_PCI_DRIVER_OVERRIDE_THIS(a) \\r
239 CR (a, PCI_IO_DEVICE, PciDriverOverride, PCI_IO_DEVICE_SIGNATURE)\r
240\r
241#define PCI_IO_DEVICE_FROM_LINK(a) \\r
242 CR (a, PCI_IO_DEVICE, Link, PCI_IO_DEVICE_SIGNATURE)\r
243\r
8e6b0dcb 244#define PCI_IO_DEVICE_FROM_LOAD_FILE2_THIS(a) \\r
245 CR (a, PCI_IO_DEVICE, LoadFile2, PCI_IO_DEVICE_SIGNATURE)\r
246\r
ead42efc 247//\r
248// Global Variables\r
249//\r
ead42efc 250extern LIST_ENTRY gPciDevicePool;\r
251extern BOOLEAN gFullEnumeration;\r
252extern UINTN gPciHostBridgeNumber;\r
253extern EFI_HANDLE gPciHostBrigeHandles[PCI_MAX_HOST_BRIDGE_NUM];\r
254extern UINT64 gAllOne;\r
255extern UINT64 gAllZero;\r
256\r
257extern EFI_PCI_PLATFORM_PROTOCOL *gPciPlatformProtocol;\r
258\r
259#include "PciIo.h"\r
260#include "PciCommand.h"\r
261#include "PciDeviceSupport.h"\r
262#include "PciEnumerator.h"\r
263#include "PciEnumeratorSupport.h"\r
264#include "PciDriverOverride.h"\r
265#include "PciRomTable.h"\r
266#include "PciOptionRomSupport.h"\r
267#include "PciPowerManagement.h"\r
268#include "PciHotPlugSupport.h"\r
269#include "PciLib.h"\r
270\r
271//\r
272// PCI Bus Support Function Prototypes\r
273//\r
eeefcb9d 274/**\r
275 Test to see if this driver supports ControllerHandle. Any ControllerHandle\r
276 than contains a gEfiPciRootBridgeIoProtocolGuid protocol can be supported.\r
277\r
278 @param This Protocol instance pointer.\r
279 @param ControllerHandle Handle of device to test.\r
280 @param RemainingDevicePath Optional parameter use to pick a specific child.\r
281 device to start.\r
282\r
283 @retval EFI_SUCCESS This driver supports this device.\r
284 @retval EFI_ALREADY_STARTED This driver is already running on this device.\r
285 @retval other This driver does not support this device.\r
286\r
287**/\r
ead42efc 288EFI_STATUS\r
289EFIAPI\r
290PciBusDriverBindingSupported (\r
291 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
292 IN EFI_HANDLE Controller,\r
293 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
294 );\r
295\r
eeefcb9d 296/**\r
297 Start this driver on ControllerHandle and enumerate Pci bus and start\r
298 all device under PCI bus.\r
299\r
300 @param This Protocol instance pointer.\r
301 @param ControllerHandle Handle of device to bind driver to.\r
302 @param RemainingDevicePath Optional parameter use to pick a specific child.\r
303 device to start.\r
304\r
305 @retval EFI_SUCCESS This driver is added to ControllerHandle.\r
306 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle.\r
307 @retval other This driver does not support this device.\r
308\r
309**/\r
ead42efc 310EFI_STATUS\r
311EFIAPI\r
312PciBusDriverBindingStart (\r
313 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
314 IN EFI_HANDLE Controller,\r
315 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
316 );\r
317\r
eeefcb9d 318/**\r
319 Stop this driver on ControllerHandle. Support stoping any child handles\r
320 created by this driver.\r
321\r
322 @param This Protocol instance pointer.\r
323 @param ControllerHandle Handle of device to stop driver on.\r
324 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
325 children is zero stop the entire bus driver.\r
326 @param ChildHandleBuffer List of Child Handles to Stop.\r
327\r
328 @retval EFI_SUCCESS This driver is removed ControllerHandle.\r
329 @retval other This driver was not removed from this device.\r
330\r
331**/\r
ead42efc 332EFI_STATUS\r
333EFIAPI\r
334PciBusDriverBindingStop (\r
335 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
336 IN EFI_HANDLE Controller,\r
337 IN UINTN NumberOfChildren,\r
338 IN EFI_HANDLE *ChildHandleBuffer\r
339 );\r
340\r
1833218d 341#define IS_PCI_GFX(_p) IS_CLASS2 (_p, PCI_CLASS_DISPLAY, PCI_CLASS_DISPLAY_OTHER)\r
342\r
ead42efc 343#endif\r