]> git.proxmox.com Git - mirror_edk2.git/blame - ArmPlatformPkg/ArmVirtualizationPkg/PciHostBridgeDxe/PciHostBridge.c
OvmfPkg/XenBusDxe: Fix build issue with VS2010
[mirror_edk2.git] / ArmPlatformPkg / ArmVirtualizationPkg / PciHostBridgeDxe / PciHostBridge.c
CommitLineData
9595e3cd
LE
1/** @file\r
2 Provides the basic interfaces to abstract a PCI Host Bridge Resource Allocation\r
3\r
4Copyright (c) 2008 - 2013, Intel Corporation. All rights reserved.<BR>\r
5This program and the accompanying materials are\r
6licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/ \r
14\r
15#include "PciHostBridge.h"\r
16\r
17//\r
18// Hard code: Root Bridge Number within the host bridge\r
19// Root Bridge's attribute\r
20// Root Bridge's device path\r
21// Root Bridge's resource aperture\r
22//\r
23UINTN RootBridgeNumber[1] = { 1 };\r
24\r
25UINT64 RootBridgeAttribute[1][1] = { { EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM } };\r
26\r
27EFI_PCI_ROOT_BRIDGE_DEVICE_PATH mEfiPciRootBridgeDevicePath[1][1] = {\r
28 {\r
29 {\r
30 {\r
31 {\r
32 ACPI_DEVICE_PATH,\r
33 ACPI_DP,\r
34 {\r
35 (UINT8) (sizeof(ACPI_HID_DEVICE_PATH)),\r
36 (UINT8) ((sizeof(ACPI_HID_DEVICE_PATH)) >> 8)\r
37 }\r
38 },\r
39 EISA_PNP_ID(0x0A03),\r
40 0\r
41 },\r
42 \r
43 {\r
44 END_DEVICE_PATH_TYPE,\r
45 END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
46 {\r
47 END_DEVICE_PATH_LENGTH,\r
48 0\r
49 }\r
50 }\r
51 }\r
52 }\r
53};\r
54\r
aca7e8b6 55STATIC PCI_ROOT_BRIDGE_RESOURCE_APERTURE mResAperture[1][1];\r
9595e3cd
LE
56\r
57EFI_HANDLE mDriverImageHandle;\r
58\r
59PCI_HOST_BRIDGE_INSTANCE mPciHostBridgeInstanceTemplate = {\r
60 PCI_HOST_BRIDGE_SIGNATURE, // Signature\r
61 NULL, // HostBridgeHandle\r
62 0, // RootBridgeNumber\r
63 {NULL, NULL}, // Head\r
64 FALSE, // ResourceSubiteed\r
65 TRUE, // CanRestarted\r
66 {\r
67 NotifyPhase,\r
68 GetNextRootBridge,\r
69 GetAttributes,\r
70 StartBusEnumeration,\r
71 SetBusNumbers,\r
72 SubmitResources,\r
73 GetProposedResources,\r
74 PreprocessController\r
75 }\r
76};\r
77\r
78//\r
79// Implementation\r
80//\r
81\r
82/**\r
83 Entry point of this driver\r
84\r
85 @param ImageHandle Handle of driver image\r
86 @param SystemTable Point to EFI_SYSTEM_TABLE\r
87\r
120a25c2 88 @retval EFI_ABORTED PCI host bridge not present\r
9595e3cd
LE
89 @retval EFI_OUT_OF_RESOURCES Can not allocate memory resource\r
90 @retval EFI_DEVICE_ERROR Can not install the protocol instance\r
91 @retval EFI_SUCCESS Success to initialize the Pci host bridge.\r
92**/\r
93EFI_STATUS\r
94EFIAPI\r
95InitializePciHostBridge (\r
96 IN EFI_HANDLE ImageHandle,\r
97 IN EFI_SYSTEM_TABLE *SystemTable\r
98 )\r
99{\r
f9a8be42 100 UINT64 MmioAttributes;\r
9595e3cd
LE
101 EFI_STATUS Status;\r
102 UINTN Loop1;\r
103 UINTN Loop2;\r
104 PCI_HOST_BRIDGE_INSTANCE *HostBridge;\r
105 PCI_ROOT_BRIDGE_INSTANCE *PrivateData;\r
106 \r
120a25c2
LE
107 if (PcdGet64 (PcdPciExpressBaseAddress) == 0) {\r
108 DEBUG ((EFI_D_INFO, "%a: PCI host bridge not present\n", __FUNCTION__));\r
109 return EFI_ABORTED;\r
110 }\r
111\r
9595e3cd
LE
112 mDriverImageHandle = ImageHandle;\r
113 \r
aca7e8b6
LE
114 mResAperture[0][0].BusBase = PcdGet32 (PcdPciBusMin);\r
115 mResAperture[0][0].BusLimit = PcdGet32 (PcdPciBusMax);\r
116\r
117 mResAperture[0][0].MemBase = PcdGet32 (PcdPciMmio32Base);\r
118 mResAperture[0][0].MemLimit = (UINT64)PcdGet32 (PcdPciMmio32Base) +\r
119 PcdGet32 (PcdPciMmio32Size) - 1;\r
120\r
121 mResAperture[0][0].IoBase = PcdGet64 (PcdPciIoBase);\r
122 mResAperture[0][0].IoLimit = PcdGet64 (PcdPciIoBase) +\r
123 PcdGet64 (PcdPciIoSize) - 1;\r
124 mResAperture[0][0].IoTranslation = PcdGet64 (PcdPciIoTranslation);\r
125\r
807c26d3
LE
126 //\r
127 // Add IO and MMIO memory space, so that resources can be allocated in the\r
128 // EfiPciHostBridgeAllocateResources phase.\r
129 //\r
130 Status = gDS->AddIoSpace (\r
131 EfiGcdIoTypeIo,\r
132 PcdGet64 (PcdPciIoBase),\r
133 PcdGet64 (PcdPciIoSize)\r
134 );\r
135 ASSERT_EFI_ERROR (Status);\r
136\r
f9a8be42
LE
137 MmioAttributes = FeaturePcdGet (PcdKludgeMapPciMmioAsCached) ?\r
138 EFI_MEMORY_WB : EFI_MEMORY_UC;\r
139\r
807c26d3
LE
140 Status = gDS->AddMemorySpace (\r
141 EfiGcdMemoryTypeMemoryMappedIo,\r
142 PcdGet32 (PcdPciMmio32Base),\r
143 PcdGet32 (PcdPciMmio32Size),\r
f9a8be42 144 MmioAttributes\r
807c26d3
LE
145 );\r
146 if (EFI_ERROR (Status)) {\r
147 DEBUG ((EFI_D_ERROR, "%a: AddMemorySpace: %r\n", __FUNCTION__, Status));\r
148 return Status;\r
149 }\r
150\r
f9a8be42
LE
151 Status = gDS->SetMemorySpaceAttributes (\r
152 PcdGet32 (PcdPciMmio32Base),\r
153 PcdGet32 (PcdPciMmio32Size),\r
154 MmioAttributes\r
155 );\r
156 if (EFI_ERROR (Status)) {\r
157 DEBUG ((EFI_D_ERROR, "%a: SetMemorySpaceAttributes: %r\n", __FUNCTION__,\r
158 Status));\r
159 return Status;\r
160 }\r
161\r
9595e3cd
LE
162 //\r
163 // Create Host Bridge Device Handle\r
164 //\r
165 for (Loop1 = 0; Loop1 < HOST_BRIDGE_NUMBER; Loop1++) {\r
166 HostBridge = AllocateCopyPool (sizeof(PCI_HOST_BRIDGE_INSTANCE), &mPciHostBridgeInstanceTemplate);\r
167 if (HostBridge == NULL) {\r
168 return EFI_OUT_OF_RESOURCES;\r
169 }\r
170 \r
171 HostBridge->RootBridgeNumber = RootBridgeNumber[Loop1];\r
172 InitializeListHead (&HostBridge->Head);\r
173\r
174 Status = gBS->InstallMultipleProtocolInterfaces (\r
175 &HostBridge->HostBridgeHandle, \r
176 &gEfiPciHostBridgeResourceAllocationProtocolGuid, &HostBridge->ResAlloc,\r
177 NULL\r
178 );\r
179 if (EFI_ERROR (Status)) {\r
180 FreePool (HostBridge);\r
181 return EFI_DEVICE_ERROR;\r
182 }\r
183 \r
184 //\r
185 // Create Root Bridge Device Handle in this Host Bridge\r
186 //\r
187 \r
188 for (Loop2 = 0; Loop2 < HostBridge->RootBridgeNumber; Loop2++) {\r
189 PrivateData = AllocateZeroPool (sizeof(PCI_ROOT_BRIDGE_INSTANCE));\r
190 if (PrivateData == NULL) {\r
191 return EFI_OUT_OF_RESOURCES;\r
192 }\r
193\r
194 PrivateData->Signature = PCI_ROOT_BRIDGE_SIGNATURE;\r
195 PrivateData->DevicePath = (EFI_DEVICE_PATH_PROTOCOL *)&mEfiPciRootBridgeDevicePath[Loop1][Loop2];\r
196\r
197 RootBridgeConstructor (\r
198 &PrivateData->Io, \r
199 HostBridge->HostBridgeHandle, \r
200 RootBridgeAttribute[Loop1][Loop2], \r
201 &mResAperture[Loop1][Loop2]\r
202 );\r
203 \r
204 Status = gBS->InstallMultipleProtocolInterfaces(\r
205 &PrivateData->Handle, \r
206 &gEfiDevicePathProtocolGuid, PrivateData->DevicePath,\r
207 &gEfiPciRootBridgeIoProtocolGuid, &PrivateData->Io,\r
208 NULL\r
209 );\r
210 if (EFI_ERROR (Status)) {\r
211 FreePool(PrivateData);\r
212 return EFI_DEVICE_ERROR;\r
213 }\r
214 \r
215 InsertTailList (&HostBridge->Head, &PrivateData->Link);\r
216 }\r
217 } \r
218\r
219 return EFI_SUCCESS;\r
220}\r
221\r
222\r
223/**\r
224 These are the notifications from the PCI bus driver that it is about to enter a certain\r
225 phase of the PCI enumeration process.\r
226\r
227 This member function can be used to notify the host bridge driver to perform specific actions,\r
228 including any chipset-specific initialization, so that the chipset is ready to enter the next phase.\r
229 Eight notification points are defined at this time. See belows:\r
230 EfiPciHostBridgeBeginEnumeration Resets the host bridge PCI apertures and internal data\r
231 structures. The PCI enumerator should issue this notification\r
232 before starting a fresh enumeration process. Enumeration cannot\r
233 be restarted after sending any other notification such as\r
234 EfiPciHostBridgeBeginBusAllocation.\r
235 EfiPciHostBridgeBeginBusAllocation The bus allocation phase is about to begin. No specific action is\r
236 required here. This notification can be used to perform any\r
237 chipset-specific programming.\r
238 EfiPciHostBridgeEndBusAllocation The bus allocation and bus programming phase is complete. No\r
239 specific action is required here. This notification can be used to\r
240 perform any chipset-specific programming.\r
241 EfiPciHostBridgeBeginResourceAllocation\r
242 The resource allocation phase is about to begin. No specific\r
243 action is required here. This notification can be used to perform\r
244 any chipset-specific programming.\r
245 EfiPciHostBridgeAllocateResources Allocates resources per previously submitted requests for all the PCI\r
246 root bridges. These resource settings are returned on the next call to\r
247 GetProposedResources(). Before calling NotifyPhase() with a Phase of\r
248 EfiPciHostBridgeAllocateResource, the PCI bus enumerator is responsible\r
249 for gathering I/O and memory requests for\r
250 all the PCI root bridges and submitting these requests using\r
251 SubmitResources(). This function pads the resource amount\r
252 to suit the root bridge hardware, takes care of dependencies between\r
253 the PCI root bridges, and calls the Global Coherency Domain (GCD)\r
254 with the allocation request. In the case of padding, the allocated range\r
255 could be bigger than what was requested.\r
256 EfiPciHostBridgeSetResources Programs the host bridge hardware to decode previously allocated\r
257 resources (proposed resources) for all the PCI root bridges. After the\r
258 hardware is programmed, reassigning resources will not be supported.\r
259 The bus settings are not affected.\r
260 EfiPciHostBridgeFreeResources Deallocates resources that were previously allocated for all the PCI\r
261 root bridges and resets the I/O and memory apertures to their initial\r
262 state. The bus settings are not affected. If the request to allocate\r
263 resources fails, the PCI enumerator can use this notification to\r
264 deallocate previous resources, adjust the requests, and retry\r
265 allocation.\r
266 EfiPciHostBridgeEndResourceAllocation The resource allocation phase is completed. No specific action is\r
267 required here. This notification can be used to perform any chipsetspecific\r
268 programming.\r
269\r
270 @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
271 @param[in] Phase The phase during enumeration\r
272\r
273 @retval EFI_NOT_READY This phase cannot be entered at this time. For example, this error\r
274 is valid for a Phase of EfiPciHostBridgeAllocateResources if\r
275 SubmitResources() has not been called for one or more\r
276 PCI root bridges before this call\r
277 @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. This error is valid\r
278 for a Phase of EfiPciHostBridgeSetResources.\r
279 @retval EFI_INVALID_PARAMETER Invalid phase parameter\r
280 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
281 This error is valid for a Phase of EfiPciHostBridgeAllocateResources if the\r
282 previously submitted resource requests cannot be fulfilled or\r
283 were only partially fulfilled.\r
284 @retval EFI_SUCCESS The notification was accepted without any errors.\r
285\r
286**/\r
287EFI_STATUS\r
288EFIAPI\r
289NotifyPhase(\r
290 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
291 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE Phase\r
292 )\r
293{\r
294 PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;\r
295 PCI_ROOT_BRIDGE_INSTANCE *RootBridgeInstance;\r
296 PCI_RESOURCE_TYPE Index;\r
297 LIST_ENTRY *List;\r
298 EFI_PHYSICAL_ADDRESS BaseAddress;\r
299 UINT64 AddrLen;\r
300 UINTN BitsOfAlignment;\r
301 EFI_STATUS Status;\r
302 EFI_STATUS ReturnStatus;\r
303 \r
304 HostBridgeInstance = INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This);\r
305 \r
306 switch (Phase) {\r
307\r
308 case EfiPciHostBridgeBeginEnumeration:\r
309 if (HostBridgeInstance->CanRestarted) {\r
310 //\r
311 // Reset the Each Root Bridge \r
312 //\r
313 List = HostBridgeInstance->Head.ForwardLink;\r
314 \r
315 while (List != &HostBridgeInstance->Head) {\r
316 RootBridgeInstance = DRIVER_INSTANCE_FROM_LIST_ENTRY (List);\r
317 for (Index = TypeIo; Index < TypeMax; Index++) {\r
318 RootBridgeInstance->ResAllocNode[Index].Type = Index;\r
319 RootBridgeInstance->ResAllocNode[Index].Base = 0;\r
320 RootBridgeInstance->ResAllocNode[Index].Length = 0;\r
321 RootBridgeInstance->ResAllocNode[Index].Status = ResNone;\r
322 }\r
323 \r
324 List = List->ForwardLink;\r
325 }\r
326 \r
327 HostBridgeInstance->ResourceSubmited = FALSE;\r
328 HostBridgeInstance->CanRestarted = TRUE;\r
329 } else {\r
330 //\r
331 // Can not restart\r
332 // \r
333 return EFI_NOT_READY;\r
334 } \r
335 break;\r
336\r
337 case EfiPciHostBridgeEndEnumeration:\r
338 break;\r
339\r
340 case EfiPciHostBridgeBeginBusAllocation:\r
341 //\r
342 // No specific action is required here, can perform any chipset specific programing\r
343 //\r
344 HostBridgeInstance->CanRestarted = FALSE;\r
345 break;\r
346\r
347 case EfiPciHostBridgeEndBusAllocation:\r
348 //\r
349 // No specific action is required here, can perform any chipset specific programing\r
350 //\r
351 //HostBridgeInstance->CanRestarted = FALSE;\r
352 break;\r
353\r
354 case EfiPciHostBridgeBeginResourceAllocation:\r
355 //\r
356 // No specific action is required here, can perform any chipset specific programing\r
357 //\r
358 //HostBridgeInstance->CanRestarted = FALSE;\r
359 break;\r
360\r
361 case EfiPciHostBridgeAllocateResources:\r
362 ReturnStatus = EFI_SUCCESS;\r
363 if (HostBridgeInstance->ResourceSubmited) {\r
364 //\r
365 // Take care of the resource dependencies between the root bridges \r
366 //\r
367 List = HostBridgeInstance->Head.ForwardLink;\r
368\r
369 while (List != &HostBridgeInstance->Head) {\r
370 RootBridgeInstance = DRIVER_INSTANCE_FROM_LIST_ENTRY (List);\r
371 for (Index = TypeIo; Index < TypeBus; Index++) {\r
372 if (RootBridgeInstance->ResAllocNode[Index].Status != ResNone) {\r
373 \r
374 AddrLen = RootBridgeInstance->ResAllocNode[Index].Length;\r
375 \r
376 //\r
377 // Get the number of '1' in Alignment.\r
378 //\r
379 BitsOfAlignment = (UINTN) (HighBitSet64 (RootBridgeInstance->ResAllocNode[Index].Alignment) + 1);\r
380 \r
381 switch (Index) {\r
382\r
383 case TypeIo: \r
384 //\r
385 // It is impossible for this chipset to align 0xFFFF for IO16\r
386 // So clear it\r
387 //\r
388 if (BitsOfAlignment >= 16) {\r
389 BitsOfAlignment = 0;\r
390 }\r
391 \r
ef8dba7d 392 BaseAddress = mResAperture[0][0].IoLimit;\r
9595e3cd 393 Status = gDS->AllocateIoSpace (\r
ef8dba7d 394 EfiGcdAllocateMaxAddressSearchTopDown,\r
9595e3cd
LE
395 EfiGcdIoTypeIo, \r
396 BitsOfAlignment,\r
397 AddrLen,\r
398 &BaseAddress,\r
399 mDriverImageHandle,\r
400 NULL\r
401 );\r
402 \r
403 if (!EFI_ERROR (Status)) {\r
404 RootBridgeInstance->ResAllocNode[Index].Base = (UINTN)BaseAddress;\r
405 RootBridgeInstance->ResAllocNode[Index].Status = ResAllocated; \r
406 } else {\r
407 ReturnStatus = Status; \r
408 if (Status != EFI_OUT_OF_RESOURCES) {\r
409 RootBridgeInstance->ResAllocNode[Index].Length = 0;\r
410 }\r
411 }\r
412\r
413 break;\r
414\r
415\r
416 case TypeMem32:\r
417 //\r
418 // It is impossible for this chipset to align 0xFFFFFFFF for Mem32\r
419 // So clear it \r
420 //\r
421 \r
422 if (BitsOfAlignment >= 32) {\r
423 BitsOfAlignment = 0;\r
424 }\r
425 \r
b9a44dca 426 BaseAddress = mResAperture[0][0].MemLimit;\r
9595e3cd 427 Status = gDS->AllocateMemorySpace (\r
b9a44dca 428 EfiGcdAllocateMaxAddressSearchTopDown,\r
9595e3cd
LE
429 EfiGcdMemoryTypeMemoryMappedIo, \r
430 BitsOfAlignment,\r
431 AddrLen,\r
432 &BaseAddress,\r
433 mDriverImageHandle,\r
434 NULL\r
435 );\r
436 \r
437 if (!EFI_ERROR (Status)) {\r
438 // We were able to allocate the PCI memory\r
439 RootBridgeInstance->ResAllocNode[Index].Base = (UINTN)BaseAddress;\r
440 RootBridgeInstance->ResAllocNode[Index].Status = ResAllocated;\r
441 \r
442 } else {\r
443 // Not able to allocate enough PCI memory\r
444 ReturnStatus = Status; \r
445 \r
446 if (Status != EFI_OUT_OF_RESOURCES) {\r
447 RootBridgeInstance->ResAllocNode[Index].Length = 0;\r
448 } \r
449 ASSERT (FALSE);\r
450 }\r
451 break;\r
452 \r
453 case TypePMem32: \r
454 case TypeMem64: \r
455 case TypePMem64:\r
456 ReturnStatus = EFI_ABORTED;\r
457 break; \r
458 default:\r
459 ASSERT (FALSE);\r
460 break;\r
461 }; //end switch\r
462 }\r
463 }\r
464 \r
465 List = List->ForwardLink;\r
466 }\r
467 \r
468 return ReturnStatus;\r
469\r
470 } else {\r
471 return EFI_NOT_READY;\r
472 }\r
473 break;\r
474\r
475 case EfiPciHostBridgeSetResources:\r
476 break;\r
477\r
478 case EfiPciHostBridgeFreeResources:\r
479 ReturnStatus = EFI_SUCCESS;\r
480 List = HostBridgeInstance->Head.ForwardLink;\r
481 while (List != &HostBridgeInstance->Head) {\r
482 RootBridgeInstance = DRIVER_INSTANCE_FROM_LIST_ENTRY (List);\r
483 for (Index = TypeIo; Index < TypeBus; Index++) {\r
484 if (RootBridgeInstance->ResAllocNode[Index].Status == ResAllocated) {\r
485 AddrLen = RootBridgeInstance->ResAllocNode[Index].Length;\r
486 BaseAddress = RootBridgeInstance->ResAllocNode[Index].Base;\r
487 switch (Index) {\r
488\r
489 case TypeIo: \r
490 Status = gDS->FreeIoSpace (BaseAddress, AddrLen); \r
491 if (EFI_ERROR (Status)) {\r
492 ReturnStatus = Status;\r
493 }\r
494 break;\r
495\r
496 case TypeMem32:\r
497 Status = gDS->FreeMemorySpace (BaseAddress, AddrLen);\r
498 if (EFI_ERROR (Status)) {\r
499 ReturnStatus = Status;\r
500 }\r
501 break;\r
502\r
503 case TypePMem32:\r
504 break;\r
505\r
506 case TypeMem64:\r
507 break;\r
508\r
509 case TypePMem64:\r
510 break; \r
511\r
512 default:\r
513 ASSERT (FALSE);\r
514 break;\r
515\r
516 }; //end switch\r
517 RootBridgeInstance->ResAllocNode[Index].Type = Index;\r
518 RootBridgeInstance->ResAllocNode[Index].Base = 0;\r
519 RootBridgeInstance->ResAllocNode[Index].Length = 0;\r
520 RootBridgeInstance->ResAllocNode[Index].Status = ResNone;\r
521 }\r
522 }\r
523 \r
524 List = List->ForwardLink;\r
525 }\r
526 \r
527 HostBridgeInstance->ResourceSubmited = FALSE;\r
528 HostBridgeInstance->CanRestarted = TRUE; \r
529 return ReturnStatus;\r
530\r
531 case EfiPciHostBridgeEndResourceAllocation:\r
532 HostBridgeInstance->CanRestarted = FALSE;\r
533 break;\r
534\r
535 default:\r
536 return EFI_INVALID_PARAMETER;\r
537 }\r
538 \r
539 return EFI_SUCCESS; \r
540}\r
541\r
542/**\r
543 Return the device handle of the next PCI root bridge that is associated with this Host Bridge.\r
544\r
545 This function is called multiple times to retrieve the device handles of all the PCI root bridges that\r
546 are associated with this PCI host bridge. Each PCI host bridge is associated with one or more PCI\r
547 root bridges. On each call, the handle that was returned by the previous call is passed into the\r
548 interface, and on output the interface returns the device handle of the next PCI root bridge. The\r
549 caller can use the handle to obtain the instance of the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL\r
550 for that root bridge. When there are no more PCI root bridges to report, the interface returns\r
551 EFI_NOT_FOUND. A PCI enumerator must enumerate the PCI root bridges in the order that they\r
552 are returned by this function.\r
553 For D945 implementation, there is only one root bridge in PCI host bridge.\r
554\r
555 @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
556 @param[in, out] RootBridgeHandle Returns the device handle of the next PCI root bridge.\r
557 \r
558 @retval EFI_SUCCESS If parameter RootBridgeHandle = NULL, then return the first Rootbridge handle of the\r
559 specific Host bridge and return EFI_SUCCESS. \r
560 @retval EFI_NOT_FOUND Can not find the any more root bridge in specific host bridge.\r
561 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not an EFI_HANDLE that was\r
562 returned on a previous call to GetNextRootBridge().\r
563**/\r
564EFI_STATUS\r
565EFIAPI\r
566GetNextRootBridge(\r
567 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
568 IN OUT EFI_HANDLE *RootBridgeHandle\r
569 )\r
570{\r
571 BOOLEAN NoRootBridge; \r
572 LIST_ENTRY *List; \r
573 PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;\r
574 PCI_ROOT_BRIDGE_INSTANCE *RootBridgeInstance;\r
575 \r
576 NoRootBridge = TRUE;\r
577 HostBridgeInstance = INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This);\r
578 List = HostBridgeInstance->Head.ForwardLink;\r
579 \r
580 \r
581 while (List != &HostBridgeInstance->Head) {\r
582 NoRootBridge = FALSE;\r
583 RootBridgeInstance = DRIVER_INSTANCE_FROM_LIST_ENTRY (List);\r
584 if (*RootBridgeHandle == NULL) {\r
585 //\r
586 // Return the first Root Bridge Handle of the Host Bridge\r
587 //\r
588 *RootBridgeHandle = RootBridgeInstance->Handle;\r
589 return EFI_SUCCESS;\r
590 } else {\r
591 if (*RootBridgeHandle == RootBridgeInstance->Handle) {\r
592 //\r
593 // Get next if have\r
594 //\r
595 List = List->ForwardLink;\r
596 if (List!=&HostBridgeInstance->Head) {\r
597 RootBridgeInstance = DRIVER_INSTANCE_FROM_LIST_ENTRY (List);\r
598 *RootBridgeHandle = RootBridgeInstance->Handle;\r
599 return EFI_SUCCESS; \r
600 } else {\r
601 return EFI_NOT_FOUND;\r
602 }\r
603 }\r
604 }\r
605 \r
606 List = List->ForwardLink;\r
607 } //end while\r
608 \r
609 if (NoRootBridge) {\r
610 return EFI_NOT_FOUND;\r
611 } else {\r
612 return EFI_INVALID_PARAMETER;\r
613 }\r
614}\r
615\r
616/**\r
617 Returns the allocation attributes of a PCI root bridge.\r
618\r
619 The function returns the allocation attributes of a specific PCI root bridge. The attributes can vary\r
620 from one PCI root bridge to another. These attributes are different from the decode-related\r
621 attributes that are returned by the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.GetAttributes() member function. The\r
622 RootBridgeHandle parameter is used to specify the instance of the PCI root bridge. The device\r
623 handles of all the root bridges that are associated with this host bridge must be obtained by calling\r
624 GetNextRootBridge(). The attributes are static in the sense that they do not change during or\r
625 after the enumeration process. The hardware may provide mechanisms to change the attributes on\r
626 the fly, but such changes must be completed before EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL is \r
627 installed. The permitted values of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ATTRIBUTES are defined in\r
628 "Related Definitions" below. The caller uses these attributes to combine multiple resource requests.\r
629 For example, if the flag EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM is set, the PCI bus enumerator needs to \r
630 include requests for the prefetchable memory in the nonprefetchable memory pool and not request any \r
631 prefetchable memory.\r
632 Attribute Description\r
633 ------------------------------------ ----------------------------------------------------------------------\r
634 EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM If this bit is set, then the PCI root bridge does not support separate\r
635 windows for nonprefetchable and prefetchable memory. A PCI bus\r
636 driver needs to include requests for prefetchable memory in the\r
637 nonprefetchable memory pool.\r
638\r
639 EFI_PCI_HOST_BRIDGE_MEM64_DECODE If this bit is set, then the PCI root bridge supports 64-bit memory\r
640 windows. If this bit is not set, the PCI bus driver needs to include\r
641 requests for a 64-bit memory address in the corresponding 32-bit\r
642 memory pool.\r
643\r
644 @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
645 @param[in] RootBridgeHandle The device handle of the PCI root bridge in which the caller is interested. Type\r
646 EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.\r
647 @param[out] Attributes The pointer to attribte of root bridge, it is output parameter\r
648 \r
649 @retval EFI_INVALID_PARAMETER Attribute pointer is NULL\r
650 @retval EFI_INVALID_PARAMETER RootBridgehandle is invalid.\r
651 @retval EFI_SUCCESS Success to get attribute of interested root bridge.\r
652\r
653**/\r
654EFI_STATUS\r
655EFIAPI\r
656GetAttributes(\r
657 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
658 IN EFI_HANDLE RootBridgeHandle,\r
659 OUT UINT64 *Attributes\r
660 )\r
661{\r
662 LIST_ENTRY *List; \r
663 PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;\r
664 PCI_ROOT_BRIDGE_INSTANCE *RootBridgeInstance;\r
665 \r
666 if (Attributes == NULL) {\r
667 return EFI_INVALID_PARAMETER;\r
668 }\r
669 \r
670 HostBridgeInstance = INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This);\r
671 List = HostBridgeInstance->Head.ForwardLink;\r
672 \r
673 while (List != &HostBridgeInstance->Head) {\r
674 RootBridgeInstance = DRIVER_INSTANCE_FROM_LIST_ENTRY (List);\r
675 if (RootBridgeHandle == RootBridgeInstance->Handle) {\r
676 *Attributes = RootBridgeInstance->RootBridgeAttrib;\r
677 return EFI_SUCCESS;\r
678 }\r
679 List = List->ForwardLink;\r
680 }\r
681 \r
682 //\r
683 // RootBridgeHandle is not an EFI_HANDLE \r
684 // that was returned on a previous call to GetNextRootBridge()\r
685 //\r
686 return EFI_INVALID_PARAMETER;\r
687}\r
688\r
689/**\r
690 Sets up the specified PCI root bridge for the bus enumeration process.\r
691\r
692 This member function sets up the root bridge for bus enumeration and returns the PCI bus range\r
693 over which the search should be performed in ACPI 2.0 resource descriptor format.\r
694\r
695 @param[in] This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.\r
696 @param[in] RootBridgeHandle The PCI Root Bridge to be set up.\r
697 @param[out] Configuration Pointer to the pointer to the PCI bus resource descriptor.\r
698 \r
699 @retval EFI_INVALID_PARAMETER Invalid Root bridge's handle\r
700 @retval EFI_OUT_OF_RESOURCES Fail to allocate ACPI resource descriptor tag.\r
701 @retval EFI_SUCCESS Sucess to allocate ACPI resource descriptor.\r
702\r
703**/\r
704EFI_STATUS\r
705EFIAPI\r
706StartBusEnumeration(\r
707 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
708 IN EFI_HANDLE RootBridgeHandle,\r
709 OUT VOID **Configuration\r
710 )\r
711{\r
712 LIST_ENTRY *List; \r
713 PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;\r
714 PCI_ROOT_BRIDGE_INSTANCE *RootBridgeInstance;\r
715 VOID *Buffer;\r
716 UINT8 *Temp;\r
717 UINT64 BusStart;\r
718 UINT64 BusEnd;\r
719 \r
720 HostBridgeInstance = INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This);\r
721 List = HostBridgeInstance->Head.ForwardLink;\r
722 \r
723 while (List != &HostBridgeInstance->Head) {\r
724 RootBridgeInstance = DRIVER_INSTANCE_FROM_LIST_ENTRY (List);\r
725 if (RootBridgeHandle == RootBridgeInstance->Handle) {\r
726 //\r
727 // Set up the Root Bridge for Bus Enumeration\r
728 //\r
729 BusStart = RootBridgeInstance->BusBase;\r
730 BusEnd = RootBridgeInstance->BusLimit;\r
731 //\r
732 // Program the Hardware(if needed) if error return EFI_DEVICE_ERROR\r
733 //\r
734 \r
735 Buffer = AllocatePool (sizeof(EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR) + sizeof(EFI_ACPI_END_TAG_DESCRIPTOR));\r
736 if (Buffer == NULL) {\r
737 return EFI_OUT_OF_RESOURCES;\r
738 }\r
739 \r
740 Temp = (UINT8 *)Buffer;\r
741 \r
742 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *)Temp)->Desc = 0x8A;\r
743 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *)Temp)->Len = 0x2B;\r
744 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *)Temp)->ResType = 2;\r
745 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *)Temp)->GenFlag = 0; \r
746 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *)Temp)->SpecificFlag = 0;\r
747 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *)Temp)->AddrSpaceGranularity = 0;\r
748 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *)Temp)->AddrRangeMin = BusStart;\r
749 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *)Temp)->AddrRangeMax = 0;\r
750 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *)Temp)->AddrTranslationOffset = 0; \r
751 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *)Temp)->AddrLen = BusEnd - BusStart + 1;\r
752 \r
753 Temp = Temp + sizeof(EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR);\r
754 ((EFI_ACPI_END_TAG_DESCRIPTOR *)Temp)->Desc = 0x79; \r
755 ((EFI_ACPI_END_TAG_DESCRIPTOR *)Temp)->Checksum = 0x0;\r
756 \r
757 *Configuration = Buffer; \r
758 return EFI_SUCCESS;\r
759 }\r
760 List = List->ForwardLink;\r
761 }\r
762 \r
763 return EFI_INVALID_PARAMETER;\r
764}\r
765\r
766/**\r
767 Programs the PCI root bridge hardware so that it decodes the specified PCI bus range.\r
768\r
769 This member function programs the specified PCI root bridge to decode the bus range that is\r
770 specified by the input parameter Configuration.\r
771 The bus range information is specified in terms of the ACPI 2.0 resource descriptor format.\r
772\r
773 @param[in] This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
774 @param[in] RootBridgeHandle The PCI Root Bridge whose bus range is to be programmed\r
775 @param[in] Configuration The pointer to the PCI bus resource descriptor\r
776 \r
777 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.\r
778 @retval EFI_INVALID_PARAMETER Configuration is NULL.\r
779 @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI 2.0 resource descriptor.\r
780 @retval EFI_INVALID_PARAMETER Configuration does not include a valid ACPI 2.0 bus resource descriptor.\r
781 @retval EFI_INVALID_PARAMETER Configuration includes valid ACPI 2.0 resource descriptors other than \r
782 bus descriptors.\r
783 @retval EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptors.\r
784 @retval EFI_INVALID_PARAMETER "Address Range Minimum" is invalid for this root bridge.\r
785 @retval EFI_INVALID_PARAMETER "Address Range Length" is invalid for this root bridge.\r
786 @retval EFI_DEVICE_ERROR Programming failed due to a hardware error.\r
787 @retval EFI_SUCCESS The bus range for the PCI root bridge was programmed.\r
788\r
789**/\r
790EFI_STATUS\r
791EFIAPI\r
792SetBusNumbers(\r
793 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
794 IN EFI_HANDLE RootBridgeHandle,\r
795 IN VOID *Configuration\r
796 )\r
797{\r
798 LIST_ENTRY *List; \r
799 PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;\r
800 PCI_ROOT_BRIDGE_INSTANCE *RootBridgeInstance;\r
801 UINT8 *Ptr;\r
802 UINTN BusStart;\r
803 UINTN BusEnd;\r
804 UINTN BusLen;\r
805 \r
806 if (Configuration == NULL) {\r
807 return EFI_INVALID_PARAMETER;\r
808 }\r
809 \r
810 Ptr = Configuration;\r
811 \r
812 //\r
813 // Check the Configuration is valid\r
814 //\r
815 if(*Ptr != ACPI_ADDRESS_SPACE_DESCRIPTOR) {\r
816 return EFI_INVALID_PARAMETER;\r
817 }\r
818 \r
819 if (((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *)Ptr)->ResType != 2) {\r
820 return EFI_INVALID_PARAMETER;\r
821 }\r
822\r
823 Ptr += sizeof(EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR);\r
824 if (*Ptr != ACPI_END_TAG_DESCRIPTOR) {\r
825 return EFI_INVALID_PARAMETER;\r
826 }\r
827 \r
828 HostBridgeInstance = INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This);\r
829 List = HostBridgeInstance->Head.ForwardLink;\r
830 \r
831 Ptr = Configuration;\r
832 \r
833 while (List != &HostBridgeInstance->Head) {\r
834 RootBridgeInstance = DRIVER_INSTANCE_FROM_LIST_ENTRY (List);\r
835 if (RootBridgeHandle == RootBridgeInstance->Handle) {\r
836 BusStart = (UINTN)((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *)Ptr)->AddrRangeMin;\r
837 BusLen = (UINTN)((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *)Ptr)->AddrLen;\r
838 BusEnd = BusStart + BusLen - 1;\r
839 \r
840 if (BusStart > BusEnd) {\r
841 return EFI_INVALID_PARAMETER;\r
842 }\r
843 \r
844 if ((BusStart < RootBridgeInstance->BusBase) || (BusEnd > RootBridgeInstance->BusLimit)) {\r
845 return EFI_INVALID_PARAMETER;\r
846 }\r
847 \r
848 //\r
849 // Update the Bus Range\r
850 //\r
851 RootBridgeInstance->ResAllocNode[TypeBus].Base = BusStart;\r
852 RootBridgeInstance->ResAllocNode[TypeBus].Length = BusLen;\r
853 RootBridgeInstance->ResAllocNode[TypeBus].Status = ResAllocated;\r
854 \r
855 //\r
856 // Program the Root Bridge Hardware\r
857 //\r
858 \r
859 return EFI_SUCCESS;\r
860 }\r
861 \r
862 List = List->ForwardLink;\r
863 }\r
864 \r
865 return EFI_INVALID_PARAMETER;\r
866}\r
867\r
868\r
869/**\r
870 Submits the I/O and memory resource requirements for the specified PCI root bridge.\r
871\r
872 This function is used to submit all the I/O and memory resources that are required by the specified\r
873 PCI root bridge. The input parameter Configuration is used to specify the following:\r
874 - The various types of resources that are required\r
875 - The associated lengths in terms of ACPI 2.0 resource descriptor format\r
876\r
877 @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.\r
878 @param[in] RootBridgeHandle The PCI root bridge whose I/O and memory resource requirements are being submitted.\r
879 @param[in] Configuration The pointer to the PCI I/O and PCI memory resource descriptor.\r
880 \r
881 @retval EFI_SUCCESS The I/O and memory resource requests for a PCI root bridge were accepted.\r
882 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.\r
883 @retval EFI_INVALID_PARAMETER Configuration is NULL.\r
884 @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI 2.0 resource descriptor.\r
885 @retval EFI_INVALID_PARAMETER Configuration includes requests for one or more resource types that are \r
886 not supported by this PCI root bridge. This error will happen if the caller \r
887 did not combine resources according to Attributes that were returned by\r
888 GetAllocAttributes().\r
889 @retval EFI_INVALID_PARAMETER Address Range Maximum" is invalid.\r
890 @retval EFI_INVALID_PARAMETER "Address Range Length" is invalid for this PCI root bridge.\r
891 @retval EFI_INVALID_PARAMETER "Address Space Granularity" is invalid for this PCI root bridge.\r
892\r
893**/\r
894EFI_STATUS\r
895EFIAPI\r
896SubmitResources(\r
897 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
898 IN EFI_HANDLE RootBridgeHandle,\r
899 IN VOID *Configuration\r
900 )\r
901{\r
902 LIST_ENTRY *List; \r
903 PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;\r
904 PCI_ROOT_BRIDGE_INSTANCE *RootBridgeInstance;\r
905 UINT8 *Temp;\r
906 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *Ptr;\r
907 UINT64 AddrLen;\r
908 UINT64 Alignment;\r
909 \r
910 //\r
911 // Check the input parameter: Configuration\r
912 //\r
913 if (Configuration == NULL) {\r
914 return EFI_INVALID_PARAMETER;\r
915 }\r
916 \r
917 HostBridgeInstance = INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This);\r
918 List = HostBridgeInstance->Head.ForwardLink;\r
919 \r
920 Temp = (UINT8 *)Configuration;\r
921 while ( *Temp == 0x8A) { \r
922 Temp += sizeof (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR) ;\r
923 }\r
924 if (*Temp != 0x79) {\r
925 return EFI_INVALID_PARAMETER;\r
926 }\r
927 \r
928 Temp = (UINT8 *)Configuration;\r
929 while (List != &HostBridgeInstance->Head) {\r
930 RootBridgeInstance = DRIVER_INSTANCE_FROM_LIST_ENTRY (List);\r
931 if (RootBridgeHandle == RootBridgeInstance->Handle) {\r
1a1d6376
LE
932 for (;\r
933 *Temp == 0x8A;\r
934 Temp += sizeof (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR)\r
935 ) {\r
9595e3cd
LE
936 Ptr = (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *) Temp ;\r
937\r
938 //\r
939 // Check Address Length\r
940 //\r
1a1d6376
LE
941 if (Ptr->AddrLen == 0) {\r
942 HostBridgeInstance->ResourceSubmited = TRUE;\r
943 continue;\r
944 }\r
9595e3cd
LE
945 if (Ptr->AddrLen > 0xffffffff) {\r
946 return EFI_INVALID_PARAMETER;\r
947 }\r
948\r
949 //\r
950 // Check address range alignment\r
951 //\r
952 if (Ptr->AddrRangeMax >= 0xffffffff || Ptr->AddrRangeMax != (GetPowerOfTwo64 (Ptr->AddrRangeMax + 1) - 1)) {\r
953 return EFI_INVALID_PARAMETER;\r
954 }\r
955 \r
956 switch (Ptr->ResType) {\r
957\r
958 case 0:\r
959 \r
960 //\r
961 // Check invalid Address Sapce Granularity\r
962 //\r
963 if (Ptr->AddrSpaceGranularity != 32) {\r
964 return EFI_INVALID_PARAMETER;\r
965 }\r
966 \r
967 //\r
968 // check the memory resource request is supported by PCI root bridge\r
969 //\r
970 if (RootBridgeInstance->RootBridgeAttrib == EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM &&\r
971 Ptr->SpecificFlag == 0x06) {\r
972 return EFI_INVALID_PARAMETER;\r
973 }\r
974 \r
975 AddrLen = Ptr->AddrLen;\r
976 Alignment = Ptr->AddrRangeMax;\r
977 if (Ptr->AddrSpaceGranularity == 32) {\r
978 if (Ptr->SpecificFlag == 0x06) {\r
979 //\r
980 // Apply from GCD\r
981 //\r
982 RootBridgeInstance->ResAllocNode[TypePMem32].Status = ResSubmitted;\r
983 } else {\r
984 RootBridgeInstance->ResAllocNode[TypeMem32].Length = AddrLen;\r
985 RootBridgeInstance->ResAllocNode[TypeMem32].Alignment = Alignment;\r
986 RootBridgeInstance->ResAllocNode[TypeMem32].Status = ResRequested; \r
987 HostBridgeInstance->ResourceSubmited = TRUE;\r
988 }\r
989 }\r
990\r
991 if (Ptr->AddrSpaceGranularity == 64) {\r
992 if (Ptr->SpecificFlag == 0x06) {\r
993 RootBridgeInstance->ResAllocNode[TypePMem64].Status = ResSubmitted;\r
994 } else {\r
995 RootBridgeInstance->ResAllocNode[TypeMem64].Status = ResSubmitted;\r
996 }\r
997 }\r
998 break;\r
999\r
1000 case 1:\r
1001 AddrLen = (UINTN) Ptr->AddrLen;\r
1002 Alignment = (UINTN) Ptr->AddrRangeMax;\r
1003 RootBridgeInstance->ResAllocNode[TypeIo].Length = AddrLen;\r
1004 RootBridgeInstance->ResAllocNode[TypeIo].Alignment = Alignment;\r
1005 RootBridgeInstance->ResAllocNode[TypeIo].Status = ResRequested;\r
1006 HostBridgeInstance->ResourceSubmited = TRUE; \r
1007 break;\r
1008\r
1009 default:\r
1010 break;\r
1011 };\r
9595e3cd
LE
1012 } \r
1013 \r
1014 return EFI_SUCCESS;\r
1015 }\r
1016 \r
1017 List = List->ForwardLink;\r
1018 }\r
1019 \r
1020 return EFI_INVALID_PARAMETER;\r
1021}\r
1022\r
1023/**\r
1024 Returns the proposed resource settings for the specified PCI root bridge.\r
1025\r
1026 This member function returns the proposed resource settings for the specified PCI root bridge. The\r
1027 proposed resource settings are prepared when NotifyPhase() is called with a Phase of\r
1028 EfiPciHostBridgeAllocateResources. The output parameter Configuration\r
1029 specifies the following:\r
1030 - The various types of resources, excluding bus resources, that are allocated\r
1031 - The associated lengths in terms of ACPI 2.0 resource descriptor format\r
1032\r
1033 @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.\r
1034 @param[in] RootBridgeHandle The PCI root bridge handle. Type EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.\r
1035 @param[out] Configuration The pointer to the pointer to the PCI I/O and memory resource descriptor.\r
1036 \r
1037 @retval EFI_SUCCESS The requested parameters were returned.\r
1038 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.\r
1039 @retval EFI_DEVICE_ERROR Programming failed due to a hardware error.\r
1040 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
1041\r
1042**/\r
1043EFI_STATUS\r
1044EFIAPI\r
1045GetProposedResources(\r
1046 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
1047 IN EFI_HANDLE RootBridgeHandle,\r
1048 OUT VOID **Configuration\r
1049 )\r
1050{\r
1051 LIST_ENTRY *List; \r
1052 PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;\r
1053 PCI_ROOT_BRIDGE_INSTANCE *RootBridgeInstance;\r
1054 UINTN Index;\r
1055 UINTN Number; \r
1056 VOID *Buffer; \r
1057 UINT8 *Temp;\r
1058 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *Ptr;\r
1059 UINT64 ResStatus;\r
1060 \r
1061 Buffer = NULL;\r
1062 Number = 0;\r
1063 //\r
1064 // Get the Host Bridge Instance from the resource allocation protocol\r
1065 //\r
1066 HostBridgeInstance = INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This);\r
1067 List = HostBridgeInstance->Head.ForwardLink;\r
1068 \r
1069 //\r
1070 // Enumerate the root bridges in this host bridge\r
1071 //\r
1072 while (List != &HostBridgeInstance->Head) {\r
1073 RootBridgeInstance = DRIVER_INSTANCE_FROM_LIST_ENTRY (List);\r
1074 if (RootBridgeHandle == RootBridgeInstance->Handle) {\r
1075 for (Index = 0; Index < TypeBus; Index ++) {\r
1076 if (RootBridgeInstance->ResAllocNode[Index].Status != ResNone) {\r
1077 Number ++;\r
1078 } \r
1079 }\r
1080 \r
1081 if (Number == 0) {\r
e5ceb6c9
LE
1082 EFI_ACPI_END_TAG_DESCRIPTOR *End;\r
1083\r
1084 End = AllocateZeroPool (sizeof *End);\r
1085 if (End == NULL) {\r
1086 return EFI_OUT_OF_RESOURCES;\r
1087 }\r
1088 End->Desc = ACPI_END_TAG_DESCRIPTOR;\r
1089 *Configuration = End;\r
1090 return EFI_SUCCESS;\r
9595e3cd
LE
1091 }\r
1092\r
1093 Buffer = AllocateZeroPool (Number * sizeof(EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR) + sizeof(EFI_ACPI_END_TAG_DESCRIPTOR));\r
1094 if (Buffer == NULL) {\r
1095 return EFI_OUT_OF_RESOURCES;\r
1096 }\r
1097 \r
1098 Temp = Buffer;\r
1099 for (Index = 0; Index < TypeBus; Index ++) {\r
1100 if (RootBridgeInstance->ResAllocNode[Index].Status != ResNone) {\r
1101 Ptr = (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *) Temp ;\r
1102 ResStatus = RootBridgeInstance->ResAllocNode[Index].Status;\r
1103 \r
1104 switch (Index) {\r
1105\r
1106 case TypeIo:\r
1107 //\r
1108 // Io\r
1109 //\r
1110 Ptr->Desc = 0x8A;\r
1111 Ptr->Len = 0x2B;\r
1112 Ptr->ResType = 1;\r
1113 Ptr->GenFlag = 0; \r
1114 Ptr->SpecificFlag = 0;\r
1115 Ptr->AddrRangeMin = RootBridgeInstance->ResAllocNode[Index].Base;\r
1116 Ptr->AddrRangeMax = 0;\r
1117 Ptr->AddrTranslationOffset = \\r
1118 (ResStatus == ResAllocated) ? EFI_RESOURCE_SATISFIED : EFI_RESOURCE_LESS;\r
1119 Ptr->AddrLen = RootBridgeInstance->ResAllocNode[Index].Length;\r
1120 break;\r
1121\r
1122 case TypeMem32:\r
1123 //\r
1124 // Memory 32\r
1125 // \r
1126 Ptr->Desc = 0x8A;\r
1127 Ptr->Len = 0x2B;\r
1128 Ptr->ResType = 0;\r
1129 Ptr->GenFlag = 0; \r
1130 Ptr->SpecificFlag = 0;\r
1131 Ptr->AddrSpaceGranularity = 32;\r
1132 Ptr->AddrRangeMin = RootBridgeInstance->ResAllocNode[Index].Base;\r
1133 Ptr->AddrRangeMax = 0;\r
1134 Ptr->AddrTranslationOffset = \\r
1135 (ResStatus == ResAllocated) ? EFI_RESOURCE_SATISFIED : EFI_RESOURCE_LESS; \r
1136 Ptr->AddrLen = RootBridgeInstance->ResAllocNode[Index].Length;\r
1137 break;\r
1138\r
1139 case TypePMem32:\r
1140 //\r
1141 // Prefetch memory 32\r
1142 //\r
1143 Ptr->Desc = 0x8A;\r
1144 Ptr->Len = 0x2B;\r
1145 Ptr->ResType = 0;\r
1146 Ptr->GenFlag = 0; \r
1147 Ptr->SpecificFlag = 6;\r
1148 Ptr->AddrSpaceGranularity = 32;\r
1149 Ptr->AddrRangeMin = 0;\r
1150 Ptr->AddrRangeMax = 0;\r
1151 Ptr->AddrTranslationOffset = EFI_RESOURCE_NONEXISTENT; \r
1152 Ptr->AddrLen = 0;\r
1153 break;\r
1154\r
1155 case TypeMem64:\r
1156 //\r
1157 // Memory 64\r
1158 //\r
1159 Ptr->Desc = 0x8A;\r
1160 Ptr->Len = 0x2B;\r
1161 Ptr->ResType = 0;\r
1162 Ptr->GenFlag = 0; \r
1163 Ptr->SpecificFlag = 0;\r
1164 Ptr->AddrSpaceGranularity = 64;\r
1165 Ptr->AddrRangeMin = 0;\r
1166 Ptr->AddrRangeMax = 0;\r
1167 Ptr->AddrTranslationOffset = EFI_RESOURCE_NONEXISTENT; \r
1168 Ptr->AddrLen = 0;\r
1169 break;\r
1170\r
1171 case TypePMem64:\r
1172 //\r
1173 // Prefetch memory 64\r
1174 //\r
1175 Ptr->Desc = 0x8A;\r
1176 Ptr->Len = 0x2B;\r
1177 Ptr->ResType = 0;\r
1178 Ptr->GenFlag = 0; \r
1179 Ptr->SpecificFlag = 6;\r
1180 Ptr->AddrSpaceGranularity = 64;\r
1181 Ptr->AddrRangeMin = 0;\r
1182 Ptr->AddrRangeMax = 0;\r
1183 Ptr->AddrTranslationOffset = EFI_RESOURCE_NONEXISTENT; \r
1184 Ptr->AddrLen = 0;\r
1185 break;\r
1186 };\r
1187 \r
1188 Temp += sizeof (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR);\r
1189 } \r
1190 }\r
1191 \r
1192 ((EFI_ACPI_END_TAG_DESCRIPTOR *)Temp)->Desc = 0x79; \r
1193 ((EFI_ACPI_END_TAG_DESCRIPTOR *)Temp)->Checksum = 0x0;\r
1194 \r
1195 *Configuration = Buffer; \r
1196 \r
1197 return EFI_SUCCESS;\r
1198 }\r
1199 \r
1200 List = List->ForwardLink;\r
1201 }\r
1202 \r
1203 return EFI_INVALID_PARAMETER;\r
1204}\r
1205\r
1206/**\r
1207 Provides the hooks from the PCI bus driver to every PCI controller (device/function) at various\r
1208 stages of the PCI enumeration process that allow the host bridge driver to preinitialize individual\r
1209 PCI controllers before enumeration.\r
1210\r
1211 This function is called during the PCI enumeration process. No specific action is expected from this\r
1212 member function. It allows the host bridge driver to preinitialize individual PCI controllers before\r
1213 enumeration.\r
1214\r
1215 @param This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.\r
1216 @param RootBridgeHandle The associated PCI root bridge handle. Type EFI_HANDLE is defined in\r
1217 InstallProtocolInterface() in the UEFI 2.0 Specification.\r
1218 @param PciAddress The address of the PCI device on the PCI bus. This address can be passed to the\r
1219 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL member functions to access the PCI\r
1220 configuration space of the device. See Table 12-1 in the UEFI 2.0 Specification for\r
1221 the definition of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS.\r
1222 @param Phase The phase of the PCI device enumeration. \r
1223 \r
1224 @retval EFI_SUCCESS The requested parameters were returned.\r
1225 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.\r
1226 @retval EFI_INVALID_PARAMETER Phase is not a valid phase that is defined in\r
1227 EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE.\r
1228 @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. The PCI enumerator should\r
1229 not enumerate this device, including its child devices if it is a PCI-to-PCI\r
1230 bridge.\r
1231\r
1232**/\r
1233EFI_STATUS\r
1234EFIAPI\r
1235PreprocessController (\r
1236 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,\r
1237 IN EFI_HANDLE RootBridgeHandle,\r
1238 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS PciAddress,\r
1239 IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase\r
1240 )\r
1241{\r
1242 PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;\r
1243 PCI_ROOT_BRIDGE_INSTANCE *RootBridgeInstance;\r
1244 LIST_ENTRY *List; \r
1245\r
1246 HostBridgeInstance = INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This);\r
1247 List = HostBridgeInstance->Head.ForwardLink;\r
1248\r
1249 //\r
1250 // Enumerate the root bridges in this host bridge\r
1251 //\r
1252 while (List != &HostBridgeInstance->Head) {\r
1253 RootBridgeInstance = DRIVER_INSTANCE_FROM_LIST_ENTRY (List);\r
1254 if (RootBridgeHandle == RootBridgeInstance->Handle) {\r
1255 break;\r
1256 }\r
1257 List = List->ForwardLink;\r
1258 }\r
1259 if (List == &HostBridgeInstance->Head) {\r
1260 return EFI_INVALID_PARAMETER;\r
1261 }\r
1262\r
1263 if ((UINT32)Phase > EfiPciBeforeResourceCollection) {\r
1264 return EFI_INVALID_PARAMETER;\r
1265 }\r
1266\r
1267 return EFI_SUCCESS;\r
1268}\r