2 PCI resources support functions declaration for PCI Bus module.
4 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
9 #ifndef _EFI_PCI_RESOURCE_SUPPORT_H_
10 #define _EFI_PCI_RESOURCE_SUPPORT_H_
17 #define PCI_RESOURCE_SIGNATURE SIGNATURE_32 ('p', 'c', 'r', 'c')
23 PCI_IO_DEVICE
*PciDev
;
30 PCI_RESOURCE_USAGE ResourceUsage
;
34 #define RESOURCE_NODE_FROM_LINK(a) \
35 CR (a, PCI_RESOURCE_NODE, Link, PCI_RESOURCE_SIGNATURE)
38 The function is used to skip VGA range.
40 @param Start Returned start address including VGA range.
41 @param Length The length of VGA range.
51 This function is used to skip ISA aliasing aperture.
53 @param Start Returned start address including ISA aliasing aperture.
54 @param Length The length of ISA aliasing aperture.
58 SkipIsaAliasAperture (
64 This function inserts a resource node into the resource list.
65 The resource list is sorted in descend order.
67 @param Bridge PCI resource node for bridge.
68 @param ResNode Resource node want to be inserted.
73 IN OUT PCI_RESOURCE_NODE
*Bridge
,
74 IN PCI_RESOURCE_NODE
*ResNode
78 This routine is used to merge two different resource trees in need of
81 For example, if an upstream PPB doesn't support,
82 prefetchable memory decoding, the PCI bus driver will choose to call this function
83 to merge prefetchable memory resource list into normal memory list.
85 If the TypeMerge is TRUE, Res resource type is changed to the type of destination resource
87 If Dst is NULL or Res is NULL, ASSERT ().
89 @param Dst Point to destination resource tree.
90 @param Res Point to source resource tree.
91 @param TypeMerge If the TypeMerge is TRUE, Res resource type is changed to the type of
92 destination resource type.
97 IN PCI_RESOURCE_NODE
*Dst
,
98 IN PCI_RESOURCE_NODE
*Res
,
103 This function is used to calculate the IO16 aperture
106 @param Bridge PCI resource node for bridge.
110 CalculateApertureIo16 (
111 IN PCI_RESOURCE_NODE
*Bridge
115 This function is used to calculate the resource aperture
116 for a given bridge device.
118 @param Bridge PCI resource node for given bridge device.
122 CalculateResourceAperture (
123 IN PCI_RESOURCE_NODE
*Bridge
127 Get IO/Memory resource info for given PCI device.
129 @param PciDev Pci device instance.
130 @param IoNode Resource info node for IO .
131 @param Mem32Node Resource info node for 32-bit memory.
132 @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
133 @param Mem64Node Resource info node for 64-bit memory.
134 @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
138 GetResourceFromDevice (
139 IN PCI_IO_DEVICE
*PciDev
,
140 IN OUT PCI_RESOURCE_NODE
*IoNode
,
141 IN OUT PCI_RESOURCE_NODE
*Mem32Node
,
142 IN OUT PCI_RESOURCE_NODE
*PMem32Node
,
143 IN OUT PCI_RESOURCE_NODE
*Mem64Node
,
144 IN OUT PCI_RESOURCE_NODE
*PMem64Node
148 This function is used to create a resource node.
150 @param PciDev Pci device instance.
151 @param Length Length of Io/Memory resource.
152 @param Alignment Alignment of resource.
153 @param Bar Bar index.
154 @param ResType Type of resource: IO/Memory.
155 @param ResUsage Resource usage.
157 @return PCI resource node created for given PCI device.
158 NULL means PCI resource node is not created.
163 IN PCI_IO_DEVICE
*PciDev
,
167 IN PCI_BAR_TYPE ResType
,
168 IN PCI_RESOURCE_USAGE ResUsage
172 This function is used to create a IOV VF resource node.
174 @param PciDev Pci device instance.
175 @param Length Length of Io/Memory resource.
176 @param Alignment Alignment of resource.
177 @param Bar Bar index.
178 @param ResType Type of resource: IO/Memory.
179 @param ResUsage Resource usage.
181 @return PCI resource node created for given VF PCI device.
182 NULL means PCI resource node is not created.
186 CreateVfResourceNode (
187 IN PCI_IO_DEVICE
*PciDev
,
191 IN PCI_BAR_TYPE ResType
,
192 IN PCI_RESOURCE_USAGE ResUsage
196 This function is used to extract resource request from
199 @param Bridge Pci device instance.
200 @param IoNode Resource info node for IO.
201 @param Mem32Node Resource info node for 32-bit memory.
202 @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
203 @param Mem64Node Resource info node for 64-bit memory.
204 @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
209 IN PCI_IO_DEVICE
*Bridge
,
210 IN OUT PCI_RESOURCE_NODE
*IoNode
,
211 IN OUT PCI_RESOURCE_NODE
*Mem32Node
,
212 IN OUT PCI_RESOURCE_NODE
*PMem32Node
,
213 IN OUT PCI_RESOURCE_NODE
*Mem64Node
,
214 IN OUT PCI_RESOURCE_NODE
*PMem64Node
218 This function is used to do the resource padding for a specific platform.
220 @param PciDev Pci device instance.
221 @param IoNode Resource info node for IO.
222 @param Mem32Node Resource info node for 32-bit memory.
223 @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
224 @param Mem64Node Resource info node for 64-bit memory.
225 @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
229 ResourcePaddingPolicy (
230 IN PCI_IO_DEVICE
*PciDev
,
231 IN PCI_RESOURCE_NODE
*IoNode
,
232 IN PCI_RESOURCE_NODE
*Mem32Node
,
233 IN PCI_RESOURCE_NODE
*PMem32Node
,
234 IN PCI_RESOURCE_NODE
*Mem64Node
,
235 IN PCI_RESOURCE_NODE
*PMem64Node
239 This function is used to degrade resource if the upstream bridge
240 doesn't support certain resource. Degradation path is
241 PMEM64 -> MEM64 -> MEM32
242 PMEM64 -> PMEM32 -> MEM32
245 @param Bridge Pci device instance.
246 @param Mem32Node Resource info node for 32-bit memory.
247 @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
248 @param Mem64Node Resource info node for 64-bit memory.
249 @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
254 IN PCI_IO_DEVICE
*Bridge
,
255 IN PCI_RESOURCE_NODE
*Mem32Node
,
256 IN PCI_RESOURCE_NODE
*PMem32Node
,
257 IN PCI_RESOURCE_NODE
*Mem64Node
,
258 IN PCI_RESOURCE_NODE
*PMem64Node
262 Test whether bridge device support decode resource.
264 @param Bridge Bridge device instance.
265 @param Decode Decode type according to resource type.
267 @return TRUE The bridge device support decode resource.
268 @return FALSE The bridge device don't support decode resource.
272 BridgeSupportResourceDecode (
273 IN PCI_IO_DEVICE
*Bridge
,
278 This function is used to program the resource allocated
279 for each resource node under specified bridge.
281 @param Base Base address of resource to be programmed.
282 @param Bridge PCI resource node for the bridge device.
284 @retval EFI_SUCCESS Successfully to program all resources
285 on given PCI bridge device.
286 @retval EFI_OUT_OF_RESOURCES Base is all one.
292 IN PCI_RESOURCE_NODE
*Bridge
296 Program Bar register for PCI device.
298 @param Base Base address for PCI device resource to be programmed.
299 @param Node Point to resource node structure.
305 IN PCI_RESOURCE_NODE
*Node
309 Program IOV VF Bar register for PCI device.
311 @param Base Base address for PCI device resource to be programmed.
312 @param Node Point to resource node structure.
318 IN PCI_RESOURCE_NODE
*Node
322 Program PCI-PCI bridge aperture.
324 @param Base Base address for resource.
325 @param Node Point to resource node structure.
329 ProgramPpbApperture (
331 IN PCI_RESOURCE_NODE
*Node
335 Program parent bridge for Option Rom.
337 @param PciDevice Pci device instance.
338 @param OptionRomBase Base address for Option Rom.
339 @param Enable Enable or disable PCI memory.
343 ProgramUpstreamBridgeForRom (
344 IN PCI_IO_DEVICE
*PciDevice
,
345 IN UINT32 OptionRomBase
,
350 Test whether resource exists for a bridge.
352 @param Bridge Point to resource node for a bridge.
354 @retval TRUE There is resource on the given bridge.
355 @retval FALSE There isn't resource on the given bridge.
359 ResourceRequestExisted (
360 IN PCI_RESOURCE_NODE
*Bridge
364 Initialize resource pool structure.
366 @param ResourcePool Point to resource pool structure. This pool
367 is reset to all zero when returned.
368 @param ResourceType Type of resource.
372 InitializeResourcePool (
373 IN OUT PCI_RESOURCE_NODE
*ResourcePool
,
374 IN PCI_BAR_TYPE ResourceType
378 Destroy given resource tree.
380 @param Bridge PCI resource root node of resource tree.
384 DestroyResourceTree (
385 IN PCI_RESOURCE_NODE
*Bridge
389 Insert resource padding for P2C.
391 @param PciDev Pci device instance.
392 @param IoNode Resource info node for IO.
393 @param Mem32Node Resource info node for 32-bit memory.
394 @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
395 @param Mem64Node Resource info node for 64-bit memory.
396 @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
400 ResourcePaddingForCardBusBridge (
401 IN PCI_IO_DEVICE
*PciDev
,
402 IN PCI_RESOURCE_NODE
*IoNode
,
403 IN PCI_RESOURCE_NODE
*Mem32Node
,
404 IN PCI_RESOURCE_NODE
*PMem32Node
,
405 IN PCI_RESOURCE_NODE
*Mem64Node
,
406 IN PCI_RESOURCE_NODE
*PMem64Node
410 Program PCI Card device register for given resource node.
412 @param Base Base address of PCI Card device to be programmed.
413 @param Node Given resource node.
419 IN PCI_RESOURCE_NODE
*Node
423 Create padding resource node.
425 @param PciDev Pci device instance.
426 @param IoNode Resource info node for IO.
427 @param Mem32Node Resource info node for 32-bit memory.
428 @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
429 @param Mem64Node Resource info node for 64-bit memory.
430 @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
434 ApplyResourcePadding (
435 IN PCI_IO_DEVICE
*PciDev
,
436 IN PCI_RESOURCE_NODE
*IoNode
,
437 IN PCI_RESOURCE_NODE
*Mem32Node
,
438 IN PCI_RESOURCE_NODE
*PMem32Node
,
439 IN PCI_RESOURCE_NODE
*Mem64Node
,
440 IN PCI_RESOURCE_NODE
*PMem64Node
444 Get padding resource for PCI-PCI bridge.
446 @param PciIoDevice PCI-PCI bridge device instance.
448 @note Feature flag PcdPciBusHotplugDeviceSupport determines
449 whether need to pad resource for them.
452 GetResourcePaddingPpb (
453 IN PCI_IO_DEVICE
*PciIoDevice