[mirror_edk2.git] / QuarkPlatformPkg / Pci / Dxe / PciHostBridge / PciHostBridge.h

/** @file\r
The Header file of the Pci Host Bridge Driver.\r
\r
Copyright (c) 2013-2015 Intel Corporation.\r
\r
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
\r
**/\r
\r
#ifndef _PCI_HOST_BRIDGE_H_\r
#define _PCI_HOST_BRIDGE_H_\r
\r
\r
#include <PiDxe.h>\r
#include <IndustryStandard/Acpi.h>\r
#include <IndustryStandard/Pci.h>\r
#include <PciRootBridge.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <IndustryStandard/Pci22.h>\r
#include <Library/UefiLib.h>\r
#include <Guid/HobList.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Protocol/PciHostBridgeResourceAllocation.h>\r
\r
#define PCI_HOST_BRIDGE_SIGNATURE SIGNATURE_32 ('e', 'h', 's', 't')\r
typedef struct {\r
  UINTN                                             Signature;\r
  EFI_HANDLE                                        HostBridgeHandle;\r
  UINTN                                             RootBridgeCount;\r
  EFI_LIST_ENTRY                                    Head;\r
  BOOLEAN                                           ResourceSubmited;\r
  BOOLEAN                                           CanRestarted;\r
  EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL  ResAlloc;\r
} PCI_HOST_BRIDGE_INSTANCE;\r
\r
#define INSTANCE_FROM_RESOURCE_ALLOCATION_THIS(a) CR (a, PCI_HOST_BRIDGE_INSTANCE, ResAlloc, PCI_HOST_BRIDGE_SIGNATURE)\r
\r
typedef enum {\r
  SocketResourceRatioChanged,\r
  SocketResourceRatioNotChanged,\r
  SocketResourceAdjustMax\r
} SOCKET_RESOURCE_ADJUSTMENT_RESULT;\r
\r
//\r
// Driver Entry Point\r
//\r
EFI_STATUS\r
EFIAPI\r
InitializePciHostBridge (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Entry point of this driver.\r
\r
Arguments:\r
\r
  ImageHandle  -  Image handle of this driver.\r
  SystemTable  -  Pointer to standard EFI system table.\r
\r
Returns:\r
\r
  EFI_SUCCESS       -  Succeed.\r
  EFI_DEVICE_ERROR  -  Fail to install PCI_ROOT_BRIDGE_IO protocol.\r
\r
--*/\r
;\r
\r
//\r
//  HostBridge Resource Allocation interface\r
//\r
EFI_STATUS\r
EFIAPI\r
NotifyPhase (\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL   *This,\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE      Phase\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Enter a certain phase of the PCI enumeration process.\r
\r
Arguments:\r
\r
  This   -  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.\r
  Phase  -  The phase during enumeration.\r
\r
Returns:\r
\r
  EFI_SUCCESS            -  Succeed.\r
  EFI_INVALID_PARAMETER  -  Wrong phase parameter passed in.\r
  EFI_NOT_READY          -  Resources have not been submitted yet.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
GetNextRootBridge (\r
  IN     EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
  IN OUT EFI_HANDLE                                       *RootBridgeHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Return the device handle of the next PCI root bridge that is associated with\r
  this Host Bridge.\r
\r
Arguments:\r
\r
  This              - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.\r
  RootBridgeHandle  -  Returns the device handle of the next PCI Root Bridge.\r
                       On input, it holds the RootBridgeHandle returned by the most\r
                       recent call to GetNextRootBridge().The handle for the first\r
                       PCI Root Bridge is returned if RootBridgeHandle is NULL on input.\r
\r
Returns:\r
\r
  EFI_SUCCESS            -  Succeed.\r
  EFI_NOT_FOUND          -  Next PCI root bridge not found.\r
  EFI_INVALID_PARAMETER  -  Wrong parameter passed in.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
GetAttributes (\r
  IN  EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
  IN  EFI_HANDLE                                       RootBridgeHandle,\r
  OUT UINT64                                           *Attributes\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Returns the attributes of a PCI Root Bridge.\r
\r
Arguments:\r
\r
  This              -  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
  RootBridgeHandle  -  The device handle of the PCI Root Bridge\r
                       that the caller is interested in\r
  Attributes        -  The pointer to attributes of the PCI Root Bridge\r
\r
Returns:\r
\r
  EFI_SUCCESS            -  Succeed.\r
  EFI_INVALID_PARAMETER  -  Attributes parameter passed in is NULL or\r
                            RootBridgeHandle is not an EFI_HANDLE\r
                            that was returned on a previous call to\r
                            GetNextRootBridge().\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
StartBusEnumeration (\r
  IN  EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
  IN  EFI_HANDLE                                       RootBridgeHandle,\r
  OUT VOID                                             **Configuration\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This is the request from the PCI enumerator to set up\r
  the specified PCI Root Bridge for bus enumeration process.\r
\r
Arguments:\r
\r
  This              -  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.\r
  RootBridgeHandle  -  The PCI Root Bridge to be set up.\r
  Configuration     -  Pointer to the pointer to the PCI bus resource descriptor.\r
\r
Returns:\r
\r
  EFI_SUCCESS            -  Succeed.\r
  EFI_OUT_OF_RESOURCES   -  Not enough pool to be allocated.\r
  EFI_INVALID_PARAMETER  -  RootBridgeHandle is not a valid handle.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
SetBusNumbers (\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
  IN EFI_HANDLE                                       RootBridgeHandle,\r
  IN VOID                                             *Configuration\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function programs the PCI Root Bridge hardware so that\r
  it decodes the specified PCI bus range.\r
\r
Arguments:\r
\r
  This              -  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.\r
  RootBridgeHandle  -  The PCI Root Bridge whose bus range is to be programmed.\r
  Configuration     -  The pointer to the PCI bus resource descriptor.\r
\r
Returns:\r
\r
  EFI_SUCCESS            -  Succeed.\r
  EFI_INVALID_PARAMETER  -  Wrong parameters passed in.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
SubmitResources (\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
  IN EFI_HANDLE                                       RootBridgeHandle,\r
  IN VOID                                             *Configuration\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Submits the I/O and memory resource requirements for the specified PCI Root Bridge.\r
\r
Arguments:\r
\r
  This              -  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
  RootBridgeHandle  -  The PCI Root Bridge whose I/O and memory resource requirements\r
                       are being submitted\r
  Configuration     -  The pointer to the PCI I/O and PCI memory resource descriptor\r
\r
Returns:\r
\r
  EFI_SUCCESS            -  Succeed.\r
  EFI_INVALID_PARAMETER  -  Wrong parameters passed in.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
GetProposedResources (\r
  IN  EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
  IN  EFI_HANDLE                                       RootBridgeHandle,\r
  OUT VOID                                             **Configuration\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function returns the proposed resource settings for the specified\r
  PCI Root Bridge.\r
\r
Arguments:\r
\r
  This              -  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.\r
  RootBridgeHandle  -  The PCI Root Bridge handle.\r
  Configuration     -  The pointer to the pointer to the PCI I/O\r
                       and memory resource descriptor.\r
\r
Returns:\r
\r
  EFI_SUCCESS            -  Succeed.\r
  EFI_OUT_OF_RESOURCES   -  Not enough pool to be allocated.\r
  EFI_INVALID_PARAMETER  -  RootBridgeHandle is not a valid handle.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
PreprocessController (\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL          *This,\r
  IN EFI_HANDLE                                                RootBridgeHandle,\r
  IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS               PciAddress,\r
  IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE              Phase\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function is called for all the PCI controllers that the PCI\r
  bus driver finds. Can be used to Preprogram the controller.\r
\r
Arguments:\r
\r
  This              -  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.\r
  RootBridgeHandle  -  The PCI Root Bridge handle.\r
  PciAddress        -  Address of the controller on the PCI bus.\r
  Phase             -  The Phase during resource allocation.\r
\r
Returns:\r
\r
  EFI_SUCCESS            -  Succeed.\r
  EFI_INVALID_PARAMETER  -  RootBridgeHandle is not a valid handle.\r
\r
--*/\r
;\r
\r
//\r
// Host Bridge Silicon specific hooks\r
//\r
UINT64\r
GetAllocAttributes (\r
  IN  UINTN        RootBridgeIndex\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Returns the Allocation attributes for the BNB Root Bridge.\r
\r
Arguments:\r
\r
  RootBridgeIndex  -  The root bridge number. 0 based.\r
\r
Returns:\r
\r
  EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM | EFI_PCI_HOST_BRIDGE_MEM64_DECODE\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
GetHostBridgeMemApertures (\r
  IN  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL               *PciRootBridgeIo,\r
  OUT UINT32                                        *Mem32Base,\r
  OUT UINT32                                        *Mem32Limit,\r
  OUT UINT64                                        *Mem64Base,\r
  OUT UINT64                                        *Mem64Limit\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Returns memory apertures for the BNB Root Bridge.\r
\r
Arguments:\r
\r
  PciRootBridgeIo  -  Pointer to Efi Pci root bridge Io protocol interface instance.\r
  Mem32Base        -  Pointer to 32 bit memory base. This is the lowest 32 bit memory address\r
                      that is decoded by the Host Bridge.\r
  Mem32Limit       -  Pointer to 32 bit memory limit.This is the highest 32 bit memory address\r
                      that is decoded by the Host Bridge. The size of the 32 bit window is\r
                      (Mem32Limit - Mem32base + 1).\r
  Mem64Base        -  Pointer to 64 bit memory base. This is the lowest 64 bit memory address\r
                      that is decoded by the Host Bridge.\r
  Mem64Limit       -  Pointer to 64 bit memory limit.This is the highest 64 bit memory address\r
                      that is decoded by the Host Bridge. The size of the 64 bit window is\r
                      (Mem64Limit - Mem64base + 1). Set Mem64Limit < Mem64Base if the host bridge\r
                      does not support 64 bit memory addresses.\r
\r
Returns:\r
\r
  EFI_SUCCESS  -  Success.\r
\r
--*/\r
;\r
\r
UINT64\r
Power2MaxMemory (\r
  IN UINT64         MemoryLength\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Calculate maximum memory length that can be fit to a mtrr.\r
\r
Arguments:\r
\r
  MemoryLength  -  Input memory length.\r
\r
Returns:\r
\r
  Returned Maximum length.\r
\r
--*/\r
;\r
\r
#endif\r
Commit	Line	Data
b303605e MK	1	/** @file\r
	2	The Header file of the Pci Host Bridge Driver.\r
	3	\r
	4	Copyright (c) 2013-2015 Intel Corporation.\r
	5	\r
	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	\r
	15	**/\r
	16	\r
	17	#ifndef _PCI_HOST_BRIDGE_H_\r
	18	#define _PCI_HOST_BRIDGE_H_\r
	19	\r
	20	\r
	21	#include <PiDxe.h>\r
	22	#include <IndustryStandard/Acpi.h>\r
	23	#include <IndustryStandard/Pci.h>\r
	24	#include <PciRootBridge.h>\r
	25	#include <Library/UefiDriverEntryPoint.h>\r
	26	#include <IndustryStandard/Pci22.h>\r
	27	#include <Library/UefiLib.h>\r
	28	#include <Guid/HobList.h>\r
	29	#include <Library/UefiRuntimeServicesTableLib.h>\r
	30	#include <Protocol/PciHostBridgeResourceAllocation.h>\r
	31	\r
	32	#define PCI_HOST_BRIDGE_SIGNATURE SIGNATURE_32 ('e', 'h', 's', 't')\r
	33	typedef struct {\r
	34	UINTN Signature;\r
	35	EFI_HANDLE HostBridgeHandle;\r
	36	UINTN RootBridgeCount;\r
	37	EFI_LIST_ENTRY Head;\r
	38	BOOLEAN ResourceSubmited;\r
	39	BOOLEAN CanRestarted;\r
	40	EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL ResAlloc;\r
	41	} PCI_HOST_BRIDGE_INSTANCE;\r
	42	\r
	43	#define INSTANCE_FROM_RESOURCE_ALLOCATION_THIS(a) CR (a, PCI_HOST_BRIDGE_INSTANCE, ResAlloc, PCI_HOST_BRIDGE_SIGNATURE)\r
	44	\r
	45	typedef enum {\r
	46	SocketResourceRatioChanged,\r
	47	SocketResourceRatioNotChanged,\r
	48	SocketResourceAdjustMax\r
	49	} SOCKET_RESOURCE_ADJUSTMENT_RESULT;\r
	50	\r
	51	//\r
	52	// Driver Entry Point\r
	53	//\r
	54	EFI_STATUS\r
	55	EFIAPI\r
	56	InitializePciHostBridge (\r
	57	IN EFI_HANDLE ImageHandle,\r
	58	IN EFI_SYSTEM_TABLE *SystemTable\r
	59	)\r
	60	/*++\r
	61	\r
	62	Routine Description:\r
	63	\r
	64	Entry point of this driver.\r
65	\r
66	Arguments:\r
67	\r
68	ImageHandle - Image handle of this driver.\r
69	SystemTable - Pointer to standard EFI system table.\r
70	\r
71	Returns:\r
72	\r
73	EFI_SUCCESS - Succeed.\r
74	EFI_DEVICE_ERROR - Fail to install PCI_ROOT_BRIDGE_IO protocol.\r
75	\r
76	--*/\r
77	;\r
78	\r
79	//\r
80	// HostBridge Resource Allocation interface\r
81	//\r
82	EFI_STATUS\r
83	EFIAPI\r
84	NotifyPhase (\r
85	IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
86	IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE Phase\r
87	)\r
88	/*++\r
89	\r
90	Routine Description:\r
91	\r
92	Enter a certain phase of the PCI enumeration process.\r
93	\r
94	Arguments:\r
95	\r
96	This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.\r
97	Phase - The phase during enumeration.\r
98	\r
99	Returns:\r
100	\r
101	EFI_SUCCESS - Succeed.\r
102	EFI_INVALID_PARAMETER - Wrong phase parameter passed in.\r
103	EFI_NOT_READY - Resources have not been submitted yet.\r
104	\r
105	--*/\r
106	;\r
107	\r
108	EFI_STATUS\r
109	EFIAPI\r
110	GetNextRootBridge (\r
111	IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
112	IN OUT EFI_HANDLE *RootBridgeHandle\r
113	)\r
114	/*++\r
115	\r
116	Routine Description:\r
117	\r
118	Return the device handle of the next PCI root bridge that is associated with\r
119	this Host Bridge.\r
120	\r
121	Arguments:\r
122	\r
123	This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.\r
124	RootBridgeHandle - Returns the device handle of the next PCI Root Bridge.\r
125	On input, it holds the RootBridgeHandle returned by the most\r
126	recent call to GetNextRootBridge().The handle for the first\r
127	PCI Root Bridge is returned if RootBridgeHandle is NULL on input.\r
128	\r
129	Returns:\r
130	\r
131	EFI_SUCCESS - Succeed.\r
132	EFI_NOT_FOUND - Next PCI root bridge not found.\r
133	EFI_INVALID_PARAMETER - Wrong parameter passed in.\r
134	\r
135	--*/\r
136	;\r
137	\r
138	EFI_STATUS\r
139	EFIAPI\r
140	GetAttributes (\r
141	IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
142	IN EFI_HANDLE RootBridgeHandle,\r
143	OUT UINT64 *Attributes\r
144	)\r
145	/*++\r
146	\r
147	Routine Description:\r
148	\r
149	Returns the attributes of a PCI Root Bridge.\r
150	\r
151	Arguments:\r
152	\r
153	This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
154	RootBridgeHandle - The device handle of the PCI Root Bridge\r
155	that the caller is interested in\r
156	Attributes - The pointer to attributes of the PCI Root Bridge\r
157	\r
158	Returns:\r
159	\r
160	EFI_SUCCESS - Succeed.\r
161	EFI_INVALID_PARAMETER - Attributes parameter passed in is NULL or\r
162	RootBridgeHandle is not an EFI_HANDLE\r
163	that was returned on a previous call to\r
164	GetNextRootBridge().\r
165	\r
166	--*/\r
167	;\r
168	\r
169	EFI_STATUS\r
170	EFIAPI\r
171	StartBusEnumeration (\r
172	IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
173	IN EFI_HANDLE RootBridgeHandle,\r
174	OUT VOID **Configuration\r
175	)\r
176	/*++\r
177	\r
178	Routine Description:\r
179	\r
180	This is the request from the PCI enumerator to set up\r
181	the specified PCI Root Bridge for bus enumeration process.\r
182	\r
183	Arguments:\r
184	\r
185	This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.\r
186	RootBridgeHandle - The PCI Root Bridge to be set up.\r
187	Configuration - Pointer to the pointer to the PCI bus resource descriptor.\r
188	\r
189	Returns:\r
190	\r
191	EFI_SUCCESS - Succeed.\r
192	EFI_OUT_OF_RESOURCES - Not enough pool to be allocated.\r
193	EFI_INVALID_PARAMETER - RootBridgeHandle is not a valid handle.\r
194	\r
195	--*/\r
196	;\r
197	\r
198	EFI_STATUS\r
199	EFIAPI\r
200	SetBusNumbers (\r
201	IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
202	IN EFI_HANDLE RootBridgeHandle,\r
203	IN VOID *Configuration\r
204	)\r
205	/*++\r
206	\r
207	Routine Description:\r
208	\r
209	This function programs the PCI Root Bridge hardware so that\r
210	it decodes the specified PCI bus range.\r
211	\r
212	Arguments:\r
213	\r
214	This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.\r
215	RootBridgeHandle - The PCI Root Bridge whose bus range is to be programmed.\r
216	Configuration - The pointer to the PCI bus resource descriptor.\r
217	\r
218	Returns:\r
219	\r
220	EFI_SUCCESS - Succeed.\r
221	EFI_INVALID_PARAMETER - Wrong parameters passed in.\r
222	\r
223	--*/\r
224	;\r
225	\r
226	EFI_STATUS\r
227	EFIAPI\r
228	SubmitResources (\r
229	IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
230	IN EFI_HANDLE RootBridgeHandle,\r
231	IN VOID *Configuration\r
232	)\r
233	/*++\r
234	\r
235	Routine Description:\r
236	\r
237	Submits the I/O and memory resource requirements for the specified PCI Root Bridge.\r
238	\r
239	Arguments:\r
240	\r
241	This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
242	RootBridgeHandle - The PCI Root Bridge whose I/O and memory resource requirements\r
243	are being submitted\r
244	Configuration - The pointer to the PCI I/O and PCI memory resource descriptor\r
245	\r
246	Returns:\r
247	\r
248	EFI_SUCCESS - Succeed.\r
249	EFI_INVALID_PARAMETER - Wrong parameters passed in.\r
250	\r
251	--*/\r
252	;\r
253	\r
254	EFI_STATUS\r
255	EFIAPI\r
256	GetProposedResources (\r
257	IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
258	IN EFI_HANDLE RootBridgeHandle,\r
259	OUT VOID **Configuration\r
260	)\r
261	/*++\r
262	\r
263	Routine Description:\r
264	\r
265	This function returns the proposed resource settings for the specified\r
266	PCI Root Bridge.\r
267	\r
268	Arguments:\r
269	\r
270	This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.\r
271	RootBridgeHandle - The PCI Root Bridge handle.\r
272	Configuration - The pointer to the pointer to the PCI I/O\r
273	and memory resource descriptor.\r
274	\r
275	Returns:\r
276	\r
277	EFI_SUCCESS - Succeed.\r
278	EFI_OUT_OF_RESOURCES - Not enough pool to be allocated.\r
279	EFI_INVALID_PARAMETER - RootBridgeHandle is not a valid handle.\r
280	\r
281	--*/\r
282	;\r
283	\r
284	EFI_STATUS\r
285	EFIAPI\r
286	PreprocessController (\r
287	IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
288	IN EFI_HANDLE RootBridgeHandle,\r
289	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS PciAddress,\r
290	IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase\r
291	)\r
292	/*++\r
293	\r
294	Routine Description:\r
295	\r
296	This function is called for all the PCI controllers that the PCI\r
297	bus driver finds. Can be used to Preprogram the controller.\r
298	\r
299	Arguments:\r
300	\r
301	This - The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.\r
302	RootBridgeHandle - The PCI Root Bridge handle.\r
303	PciAddress - Address of the controller on the PCI bus.\r
304	Phase - The Phase during resource allocation.\r
305	\r
306	Returns:\r
307	\r
308	EFI_SUCCESS - Succeed.\r
309	EFI_INVALID_PARAMETER - RootBridgeHandle is not a valid handle.\r
310	\r
311	--*/\r
312	;\r
313	\r
314	//\r
315	// Host Bridge Silicon specific hooks\r
316	//\r
317	UINT64\r
318	GetAllocAttributes (\r
319	IN UINTN RootBridgeIndex\r
320	)\r
321	/*++\r
322	\r
323	Routine Description:\r
324	\r
325	Returns the Allocation attributes for the BNB Root Bridge.\r
326	\r
327	Arguments:\r
328	\r
329	RootBridgeIndex - The root bridge number. 0 based.\r
330	\r
331	Returns:\r
332	\r
333	EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM \| EFI_PCI_HOST_BRIDGE_MEM64_DECODE\r
334	\r
335	--*/\r
336	;\r
337	\r
338	EFI_STATUS\r
339	GetHostBridgeMemApertures (\r
340	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo,\r
341	OUT UINT32 *Mem32Base,\r
342	OUT UINT32 *Mem32Limit,\r
343	OUT UINT64 *Mem64Base,\r
344	OUT UINT64 *Mem64Limit\r
345	)\r
346	/*++\r
347	\r
348	Routine Description:\r
349	\r
350	Returns memory apertures for the BNB Root Bridge.\r
351	\r
352	Arguments:\r
353	\r
354	PciRootBridgeIo - Pointer to Efi Pci root bridge Io protocol interface instance.\r
355	Mem32Base - Pointer to 32 bit memory base. This is the lowest 32 bit memory address\r
356	that is decoded by the Host Bridge.\r
357	Mem32Limit - Pointer to 32 bit memory limit.This is the highest 32 bit memory address\r
358	that is decoded by the Host Bridge. The size of the 32 bit window is\r
359	(Mem32Limit - Mem32base + 1).\r
360	Mem64Base - Pointer to 64 bit memory base. This is the lowest 64 bit memory address\r
361	that is decoded by the Host Bridge.\r
362	Mem64Limit - Pointer to 64 bit memory limit.This is the highest 64 bit memory address\r
363	that is decoded by the Host Bridge. The size of the 64 bit window is\r
364	(Mem64Limit - Mem64base + 1). Set Mem64Limit < Mem64Base if the host bridge\r
365	does not support 64 bit memory addresses.\r
366	\r
367	Returns:\r
368	\r
369	EFI_SUCCESS - Success.\r
370	\r
371	--*/\r
372	;\r
373	\r
374	UINT64\r
375	Power2MaxMemory (\r
376	IN UINT64 MemoryLength\r
377	)\r
378	/*++\r
379	\r
380	Routine Description:\r
381	\r
382	Calculate maximum memory length that can be fit to a mtrr.\r
383	\r
384	Arguments:\r
385	\r
386	MemoryLength - Input memory length.\r
387	\r
388	Returns:\r
389	\r
390	Returned Maximum length.\r
391	\r
392	--*/\r
393	;\r
394	\r
395	#endif\r