1 /** @file 2 PCI resources support functions declaration for PCI Bus module. 3 4 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR> 5 SPDX-License-Identifier: BSD-2-Clause-Patent 6 7 **/ 8 9 #ifndef _EFI_PCI_RESOURCE_SUPPORT_H_ 10 #define _EFI_PCI_RESOURCE_SUPPORT_H_ 11 12 typedef enum { 13 PciResUsageTypical, 14 PciResUsagePadding 15 } PCI_RESOURCE_USAGE; 16 17 #define PCI_RESOURCE_SIGNATURE SIGNATURE_32 ('p', 'c', 'r', 'c') 18 19 typedef struct { 20 UINT32 Signature; 21 LIST_ENTRY Link; 22 LIST_ENTRY ChildList; 23 PCI_IO_DEVICE *PciDev; 24 UINT64 Alignment; 25 UINT64 Offset; 26 UINT8 Bar; 27 PCI_BAR_TYPE ResType; 28 UINT64 Length; 29 BOOLEAN Reserved; 30 PCI_RESOURCE_USAGE ResourceUsage; 31 BOOLEAN Virtual; 32 } PCI_RESOURCE_NODE; 33 34 #define RESOURCE_NODE_FROM_LINK(a) \ 35 CR (a, PCI_RESOURCE_NODE, Link, PCI_RESOURCE_SIGNATURE) 36 37 /** 38 The function is used to skip VGA range. 39 40 @param Start Returned start address including VGA range. 41 @param Length The length of VGA range. 42 43 **/ 44 VOID 45 SkipVGAAperture ( 46 OUT UINT64 *Start, 47 IN UINT64 Length 48 ); 49 50 /** 51 This function is used to skip ISA aliasing aperture. 52 53 @param Start Returned start address including ISA aliasing aperture. 54 @param Length The length of ISA aliasing aperture. 55 56 **/ 57 VOID 58 SkipIsaAliasAperture ( 59 OUT UINT64 *Start, 60 IN UINT64 Length 61 ); 62 63 /** 64 This function inserts a resource node into the resource list. 65 The resource list is sorted in descend order. 66 67 @param Bridge PCI resource node for bridge. 68 @param ResNode Resource node want to be inserted. 69 70 **/ 71 VOID 72 InsertResourceNode ( 73 IN OUT PCI_RESOURCE_NODE *Bridge, 74 IN PCI_RESOURCE_NODE *ResNode 75 ); 76 77 /** 78 This routine is used to merge two different resource trees in need of 79 resource degradation. 80 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. 84 85 If the TypeMerge is TRUE, Res resource type is changed to the type of destination resource 86 type. 87 If Dst is NULL or Res is NULL, ASSERT (). 88 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. 93 94 **/ 95 VOID 96 MergeResourceTree ( 97 IN PCI_RESOURCE_NODE *Dst, 98 IN PCI_RESOURCE_NODE *Res, 99 IN BOOLEAN TypeMerge 100 ); 101 102 /** 103 This function is used to calculate the IO16 aperture 104 for a bridge. 105 106 @param Bridge PCI resource node for bridge. 107 108 **/ 109 VOID 110 CalculateApertureIo16 ( 111 IN PCI_RESOURCE_NODE *Bridge 112 ); 113 114 /** 115 This function is used to calculate the resource aperture 116 for a given bridge device. 117 118 @param Bridge PCI resource node for given bridge device. 119 120 **/ 121 VOID 122 CalculateResourceAperture ( 123 IN PCI_RESOURCE_NODE *Bridge 124 ); 125 126 /** 127 Get IO/Memory resource info for given PCI device. 128 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. 135 136 **/ 137 VOID 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 145 ); 146 147 /** 148 This function is used to create a resource node. 149 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. 156 157 @return PCI resource node created for given PCI device. 158 NULL means PCI resource node is not created. 159 160 **/ 161 PCI_RESOURCE_NODE * 162 CreateResourceNode ( 163 IN PCI_IO_DEVICE *PciDev, 164 IN UINT64 Length, 165 IN UINT64 Alignment, 166 IN UINT8 Bar, 167 IN PCI_BAR_TYPE ResType, 168 IN PCI_RESOURCE_USAGE ResUsage 169 ); 170 171 /** 172 This function is used to create a IOV VF resource node. 173 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. 180 181 @return PCI resource node created for given VF PCI device. 182 NULL means PCI resource node is not created. 183 184 **/ 185 PCI_RESOURCE_NODE * 186 CreateVfResourceNode ( 187 IN PCI_IO_DEVICE *PciDev, 188 IN UINT64 Length, 189 IN UINT64 Alignment, 190 IN UINT8 Bar, 191 IN PCI_BAR_TYPE ResType, 192 IN PCI_RESOURCE_USAGE ResUsage 193 ); 194 195 /** 196 This function is used to extract resource request from 197 device node list. 198 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. 205 206 **/ 207 VOID 208 CreateResourceMap ( 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 215 ); 216 217 /** 218 This function is used to do the resource padding for a specific platform. 219 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. 226 227 **/ 228 VOID 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 236 ); 237 238 /** 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 243 IO32 -> IO16. 244 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. 250 251 **/ 252 VOID 253 DegradeResource ( 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 259 ); 260 261 /** 262 Test whether bridge device support decode resource. 263 264 @param Bridge Bridge device instance. 265 @param Decode Decode type according to resource type. 266 267 @return TRUE The bridge device support decode resource. 268 @return FALSE The bridge device don't support decode resource. 269 270 **/ 271 BOOLEAN 272 BridgeSupportResourceDecode ( 273 IN PCI_IO_DEVICE *Bridge, 274 IN UINT32 Decode 275 ); 276 277 /** 278 This function is used to program the resource allocated 279 for each resource node under specified bridge. 280 281 @param Base Base address of resource to be programmed. 282 @param Bridge PCI resource node for the bridge device. 283 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. 287 288 **/ 289 EFI_STATUS 290 ProgramResource ( 291 IN UINT64 Base, 292 IN PCI_RESOURCE_NODE *Bridge 293 ); 294 295 /** 296 Program Bar register for PCI device. 297 298 @param Base Base address for PCI device resource to be programmed. 299 @param Node Point to resource node structure. 300 301 **/ 302 VOID 303 ProgramBar ( 304 IN UINT64 Base, 305 IN PCI_RESOURCE_NODE *Node 306 ); 307 308 /** 309 Program IOV VF Bar register for PCI device. 310 311 @param Base Base address for PCI device resource to be programmed. 312 @param Node Point to resource node structure. 313 314 **/ 315 EFI_STATUS 316 ProgramVfBar ( 317 IN UINT64 Base, 318 IN PCI_RESOURCE_NODE *Node 319 ); 320 321 /** 322 Program PCI-PCI bridge aperture. 323 324 @param Base Base address for resource. 325 @param Node Point to resource node structure. 326 327 **/ 328 VOID 329 ProgramPpbApperture ( 330 IN UINT64 Base, 331 IN PCI_RESOURCE_NODE *Node 332 ); 333 334 /** 335 Program parent bridge for Option Rom. 336 337 @param PciDevice Pci device instance. 338 @param OptionRomBase Base address for Option Rom. 339 @param Enable Enable or disable PCI memory. 340 341 **/ 342 VOID 343 ProgramUpstreamBridgeForRom ( 344 IN PCI_IO_DEVICE *PciDevice, 345 IN UINT32 OptionRomBase, 346 IN BOOLEAN Enable 347 ); 348 349 /** 350 Test whether resource exists for a bridge. 351 352 @param Bridge Point to resource node for a bridge. 353 354 @retval TRUE There is resource on the given bridge. 355 @retval FALSE There isn't resource on the given bridge. 356 357 **/ 358 BOOLEAN 359 ResourceRequestExisted ( 360 IN PCI_RESOURCE_NODE *Bridge 361 ); 362 363 /** 364 Initialize resource pool structure. 365 366 @param ResourcePool Point to resource pool structure. This pool 367 is reset to all zero when returned. 368 @param ResourceType Type of resource. 369 370 **/ 371 VOID 372 InitializeResourcePool ( 373 IN OUT PCI_RESOURCE_NODE *ResourcePool, 374 IN PCI_BAR_TYPE ResourceType 375 ); 376 377 /** 378 Destroy given resource tree. 379 380 @param Bridge PCI resource root node of resource tree. 381 382 **/ 383 VOID 384 DestroyResourceTree ( 385 IN PCI_RESOURCE_NODE *Bridge 386 ); 387 388 /** 389 Insert resource padding for P2C. 390 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. 397 398 **/ 399 VOID 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 407 ); 408 409 /** 410 Program PCI Card device register for given resource node. 411 412 @param Base Base address of PCI Card device to be programmed. 413 @param Node Given resource node. 414 415 **/ 416 VOID 417 ProgramP2C ( 418 IN UINT64 Base, 419 IN PCI_RESOURCE_NODE *Node 420 ); 421 422 /** 423 Create padding resource node. 424 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. 431 432 **/ 433 VOID 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 441 ); 442 443 /** 444 Get padding resource for PCI-PCI bridge. 445 446 @param PciIoDevice PCI-PCI bridge device instance. 447 448 @note Feature flag PcdPciBusHotplugDeviceSupport determines 449 whether need to pad resource for them. 450 **/ 451 VOID 452 GetResourcePaddingPpb ( 453 IN PCI_IO_DEVICE *PciIoDevice 454 ); 455 456 #endif 457