2 PCI resources support functions declaration for PCI Bus module.
4 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _EFI_PCI_RESOURCE_SUPPORT_H_
16 #define _EFI_PCI_RESOURCE_SUPPORT_H_
23 #define PCI_RESOURCE_SIGNATURE SIGNATURE_32 ('p', 'c', 'r', 'c')
29 PCI_IO_DEVICE
*PciDev
;
36 PCI_RESOURCE_USAGE ResourceUsage
;
40 #define RESOURCE_NODE_FROM_LINK(a) \
41 CR (a, PCI_RESOURCE_NODE, Link, PCI_RESOURCE_SIGNATURE)
44 The function is used to skip VGA range.
46 @param Start Returned start address including VGA range.
47 @param Length The length of VGA range.
57 This function is used to skip ISA aliasing aperture.
59 @param Start Returned start address including ISA aliasing aperture.
60 @param Length The length of ISA aliasing aperture.
64 SkipIsaAliasAperture (
70 This function inserts a resource node into the resource list.
71 The resource list is sorted in descend order.
73 @param Bridge PCI resource node for bridge.
74 @param ResNode Resource node want to be inserted.
79 IN OUT PCI_RESOURCE_NODE
*Bridge
,
80 IN PCI_RESOURCE_NODE
*ResNode
84 This routine is used to merge two different resource trees in need of
87 For example, if an upstream PPB doesn't support,
88 prefetchable memory decoding, the PCI bus driver will choose to call this function
89 to merge prefetchable memory resource list into normal memory list.
91 If the TypeMerge is TRUE, Res resource type is changed to the type of destination resource
93 If Dst is NULL or Res is NULL, ASSERT ().
95 @param Dst Point to destination resource tree.
96 @param Res Point to source resource tree.
97 @param TypeMerge If the TypeMerge is TRUE, Res resource type is changed to the type of
98 destination resource type.
103 IN PCI_RESOURCE_NODE
*Dst
,
104 IN PCI_RESOURCE_NODE
*Res
,
109 This function is used to calculate the IO16 aperture
112 @param Bridge PCI resource node for bridge.
116 CalculateApertureIo16 (
117 IN PCI_RESOURCE_NODE
*Bridge
121 This function is used to calculate the resource aperture
122 for a given bridge device.
124 @param Bridge PCI resource node for given bridge device.
128 CalculateResourceAperture (
129 IN PCI_RESOURCE_NODE
*Bridge
133 Get IO/Memory resource info for given PCI device.
135 @param PciDev Pci device instance.
136 @param IoNode Resource info node for IO .
137 @param Mem32Node Resource info node for 32-bit memory.
138 @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
139 @param Mem64Node Resource info node for 64-bit memory.
140 @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
144 GetResourceFromDevice (
145 IN PCI_IO_DEVICE
*PciDev
,
146 IN OUT PCI_RESOURCE_NODE
*IoNode
,
147 IN OUT PCI_RESOURCE_NODE
*Mem32Node
,
148 IN OUT PCI_RESOURCE_NODE
*PMem32Node
,
149 IN OUT PCI_RESOURCE_NODE
*Mem64Node
,
150 IN OUT PCI_RESOURCE_NODE
*PMem64Node
154 This function is used to create a resource node.
156 @param PciDev Pci device instance.
157 @param Length Length of Io/Memory resource.
158 @param Alignment Alignment of resource.
159 @param Bar Bar index.
160 @param ResType Type of resource: IO/Memory.
161 @param ResUsage Resource usage.
163 @return PCI resource node created for given PCI device.
164 NULL means PCI resource node is not created.
169 IN PCI_IO_DEVICE
*PciDev
,
173 IN PCI_BAR_TYPE ResType
,
174 IN PCI_RESOURCE_USAGE ResUsage
178 This function is used to create a IOV VF resource node.
180 @param PciDev Pci device instance.
181 @param Length Length of Io/Memory resource.
182 @param Alignment Alignment of resource.
183 @param Bar Bar index.
184 @param ResType Type of resource: IO/Memory.
185 @param ResUsage Resource usage.
187 @return PCI resource node created for given VF PCI device.
188 NULL means PCI resource node is not created.
192 CreateVfResourceNode (
193 IN PCI_IO_DEVICE
*PciDev
,
197 IN PCI_BAR_TYPE ResType
,
198 IN PCI_RESOURCE_USAGE ResUsage
202 This function is used to extract resource request from
205 @param Bridge Pci device instance.
206 @param IoNode Resource info node for IO.
207 @param Mem32Node Resource info node for 32-bit memory.
208 @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
209 @param Mem64Node Resource info node for 64-bit memory.
210 @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
215 IN PCI_IO_DEVICE
*Bridge
,
216 IN OUT PCI_RESOURCE_NODE
*IoNode
,
217 IN OUT PCI_RESOURCE_NODE
*Mem32Node
,
218 IN OUT PCI_RESOURCE_NODE
*PMem32Node
,
219 IN OUT PCI_RESOURCE_NODE
*Mem64Node
,
220 IN OUT PCI_RESOURCE_NODE
*PMem64Node
224 This function is used to do the resource padding for a specific platform.
226 @param PciDev Pci device instance.
227 @param IoNode Resource info node for IO.
228 @param Mem32Node Resource info node for 32-bit memory.
229 @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
230 @param Mem64Node Resource info node for 64-bit memory.
231 @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
235 ResourcePaddingPolicy (
236 IN PCI_IO_DEVICE
*PciDev
,
237 IN PCI_RESOURCE_NODE
*IoNode
,
238 IN PCI_RESOURCE_NODE
*Mem32Node
,
239 IN PCI_RESOURCE_NODE
*PMem32Node
,
240 IN PCI_RESOURCE_NODE
*Mem64Node
,
241 IN PCI_RESOURCE_NODE
*PMem64Node
245 This function is used to degrade resource if the upstream bridge
246 doesn't support certain resource. Degradation path is
247 PMEM64 -> MEM64 -> MEM32
248 PMEM64 -> PMEM32 -> MEM32
251 @param Bridge Pci device instance.
252 @param Mem32Node Resource info node for 32-bit memory.
253 @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
254 @param Mem64Node Resource info node for 64-bit memory.
255 @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
260 IN PCI_IO_DEVICE
*Bridge
,
261 IN PCI_RESOURCE_NODE
*Mem32Node
,
262 IN PCI_RESOURCE_NODE
*PMem32Node
,
263 IN PCI_RESOURCE_NODE
*Mem64Node
,
264 IN PCI_RESOURCE_NODE
*PMem64Node
268 Test whether bridge device support decode resource.
270 @param Bridge Bridge device instance.
271 @param Decode Decode type according to resource type.
273 @return TRUE The bridge device support decode resource.
274 @return FALSE The bridge device don't support decode resource.
278 BridgeSupportResourceDecode (
279 IN PCI_IO_DEVICE
*Bridge
,
284 This function is used to program the resource allocated
285 for each resource node under specified bridge.
287 @param Base Base address of resource to be programmed.
288 @param Bridge PCI resource node for the bridge device.
290 @retval EFI_SUCCESS Successfully to program all resources
291 on given PCI bridge device.
292 @retval EFI_OUT_OF_RESOURCES Base is all one.
298 IN PCI_RESOURCE_NODE
*Bridge
302 Program Bar register for PCI device.
304 @param Base Base address for PCI device resource to be programmed.
305 @param Node Point to resource node structure.
311 IN PCI_RESOURCE_NODE
*Node
315 Program IOV VF Bar register for PCI device.
317 @param Base Base address for PCI device resource to be programmed.
318 @param Node Point to resource node structure.
324 IN PCI_RESOURCE_NODE
*Node
328 Program PCI-PCI bridge aperture.
330 @param Base Base address for resource.
331 @param Node Point to resource node structure.
335 ProgramPpbApperture (
337 IN PCI_RESOURCE_NODE
*Node
341 Program parent bridge for Option Rom.
343 @param PciDevice Pci device instance.
344 @param OptionRomBase Base address for Option Rom.
345 @param Enable Enable or disable PCI memory.
349 ProgramUpstreamBridgeForRom (
350 IN PCI_IO_DEVICE
*PciDevice
,
351 IN UINT32 OptionRomBase
,
356 Test whether resource exists for a bridge.
358 @param Bridge Point to resource node for a bridge.
360 @retval TRUE There is resource on the given bridge.
361 @retval FALSE There isn't resource on the given bridge.
365 ResourceRequestExisted (
366 IN PCI_RESOURCE_NODE
*Bridge
370 Initialize resource pool structure.
372 @param ResourcePool Point to resource pool structure. This pool
373 is reset to all zero when returned.
374 @param ResourceType Type of resource.
378 InitializeResourcePool (
379 IN OUT PCI_RESOURCE_NODE
*ResourcePool
,
380 IN PCI_BAR_TYPE ResourceType
384 Destroy given resource tree.
386 @param Bridge PCI resource root node of resource tree.
390 DestroyResourceTree (
391 IN PCI_RESOURCE_NODE
*Bridge
395 Insert resource padding for P2C.
397 @param PciDev Pci device instance.
398 @param IoNode Resource info node for IO.
399 @param Mem32Node Resource info node for 32-bit memory.
400 @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
401 @param Mem64Node Resource info node for 64-bit memory.
402 @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
406 ResourcePaddingForCardBusBridge (
407 IN PCI_IO_DEVICE
*PciDev
,
408 IN PCI_RESOURCE_NODE
*IoNode
,
409 IN PCI_RESOURCE_NODE
*Mem32Node
,
410 IN PCI_RESOURCE_NODE
*PMem32Node
,
411 IN PCI_RESOURCE_NODE
*Mem64Node
,
412 IN PCI_RESOURCE_NODE
*PMem64Node
416 Program PCI Card device register for given resource node.
418 @param Base Base address of PCI Card device to be programmed.
419 @param Node Given resource node.
425 IN PCI_RESOURCE_NODE
*Node
429 Create padding resource node.
431 @param PciDev Pci device instance.
432 @param IoNode Resource info node for IO.
433 @param Mem32Node Resource info node for 32-bit memory.
434 @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
435 @param Mem64Node Resource info node for 64-bit memory.
436 @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
440 ApplyResourcePadding (
441 IN PCI_IO_DEVICE
*PciDev
,
442 IN PCI_RESOURCE_NODE
*IoNode
,
443 IN PCI_RESOURCE_NODE
*Mem32Node
,
444 IN PCI_RESOURCE_NODE
*PMem32Node
,
445 IN PCI_RESOURCE_NODE
*Mem64Node
,
446 IN PCI_RESOURCE_NODE
*PMem64Node
450 Get padding resource for PCI-PCI bridge.
452 @param PciIoDevice PCI-PCI bridge device instance.
454 @note Feature flag PcdPciBusHotplugDeviceSupport determines
455 whether need to pad resource for them.
458 GetResourcePaddingPpb (
459 IN PCI_IO_DEVICE
*PciIoDevice