[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBus / Dxe / pcibus.h

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