]>
Commit | Line | Data |
---|---|---|
9060e3ec | 1 | /** @file\r |
fcdfcdbf | 2 | PCI resources support functions declaration for PCI Bus module.\r |
9060e3ec | 3 | \r |
fcdfcdbf | 4 | Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r |
9d510e61 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
9060e3ec | 6 | \r |
7 | **/\r | |
8 | \r | |
9 | #ifndef _EFI_PCI_RESOURCE_SUPPORT_H_\r | |
10 | #define _EFI_PCI_RESOURCE_SUPPORT_H_\r | |
11 | \r | |
12 | typedef enum {\r | |
8db6a82c RN |
13 | PciResUsageTypical,\r |
14 | PciResUsagePadding\r | |
9060e3ec | 15 | } PCI_RESOURCE_USAGE;\r |
16 | \r | |
17 | #define PCI_RESOURCE_SIGNATURE SIGNATURE_32 ('p', 'c', 'r', 'c')\r | |
18 | \r | |
19 | typedef struct {\r | |
20 | UINT32 Signature;\r | |
21 | LIST_ENTRY Link;\r | |
22 | LIST_ENTRY ChildList;\r | |
23 | PCI_IO_DEVICE *PciDev;\r | |
24 | UINT64 Alignment;\r | |
25 | UINT64 Offset;\r | |
26 | UINT8 Bar;\r | |
27 | PCI_BAR_TYPE ResType;\r | |
28 | UINT64 Length;\r | |
29 | BOOLEAN Reserved;\r | |
30 | PCI_RESOURCE_USAGE ResourceUsage;\r | |
31 | BOOLEAN Virtual;\r | |
32 | } PCI_RESOURCE_NODE;\r | |
33 | \r | |
34 | #define RESOURCE_NODE_FROM_LINK(a) \\r | |
35 | CR (a, PCI_RESOURCE_NODE, Link, PCI_RESOURCE_SIGNATURE)\r | |
36 | \r | |
37 | /**\r | |
38 | The function is used to skip VGA range.\r | |
39 | \r | |
40 | @param Start Returned start address including VGA range.\r | |
41 | @param Length The length of VGA range.\r | |
42 | \r | |
43 | **/\r | |
44 | VOID\r | |
45 | SkipVGAAperture (\r | |
46 | OUT UINT64 *Start,\r | |
47 | IN UINT64 Length\r | |
48 | );\r | |
49 | \r | |
50 | /**\r | |
51 | This function is used to skip ISA aliasing aperture.\r | |
52 | \r | |
53 | @param Start Returned start address including ISA aliasing aperture.\r | |
54 | @param Length The length of ISA aliasing aperture.\r | |
55 | \r | |
56 | **/\r | |
57 | VOID\r | |
58 | SkipIsaAliasAperture (\r | |
59 | OUT UINT64 *Start,\r | |
60 | IN UINT64 Length\r | |
61 | );\r | |
62 | \r | |
63 | /**\r | |
64 | This function inserts a resource node into the resource list.\r | |
65 | The resource list is sorted in descend order.\r | |
66 | \r | |
67 | @param Bridge PCI resource node for bridge.\r | |
68 | @param ResNode Resource node want to be inserted.\r | |
69 | \r | |
70 | **/\r | |
71 | VOID\r | |
72 | InsertResourceNode (\r | |
73 | IN OUT PCI_RESOURCE_NODE *Bridge,\r | |
74 | IN PCI_RESOURCE_NODE *ResNode\r | |
75 | );\r | |
76 | \r | |
77 | /**\r | |
78 | This routine is used to merge two different resource trees in need of\r | |
fcdfcdbf | 79 | resource degradation.\r |
9060e3ec | 80 | \r |
81 | For example, if an upstream PPB doesn't support,\r | |
82 | prefetchable memory decoding, the PCI bus driver will choose to call this function\r | |
fcdfcdbf | 83 | to merge prefetchable memory resource list into normal memory list.\r |
9060e3ec | 84 | \r |
85 | If the TypeMerge is TRUE, Res resource type is changed to the type of destination resource\r | |
86 | type.\r | |
87 | If Dst is NULL or Res is NULL, ASSERT ().\r | |
88 | \r | |
89 | @param Dst Point to destination resource tree.\r | |
90 | @param Res Point to source resource tree.\r | |
91 | @param TypeMerge If the TypeMerge is TRUE, Res resource type is changed to the type of\r | |
92 | destination resource type.\r | |
93 | \r | |
94 | **/\r | |
95 | VOID\r | |
96 | MergeResourceTree (\r | |
97 | IN PCI_RESOURCE_NODE *Dst,\r | |
98 | IN PCI_RESOURCE_NODE *Res,\r | |
99 | IN BOOLEAN TypeMerge\r | |
100 | );\r | |
101 | \r | |
102 | /**\r | |
103 | This function is used to calculate the IO16 aperture\r | |
104 | for a bridge.\r | |
105 | \r | |
106 | @param Bridge PCI resource node for bridge.\r | |
107 | \r | |
108 | **/\r | |
109 | VOID\r | |
110 | CalculateApertureIo16 (\r | |
111 | IN PCI_RESOURCE_NODE *Bridge\r | |
112 | );\r | |
113 | \r | |
114 | /**\r | |
115 | This function is used to calculate the resource aperture\r | |
116 | for a given bridge device.\r | |
117 | \r | |
fcdfcdbf | 118 | @param Bridge PCI resource node for given bridge device.\r |
9060e3ec | 119 | \r |
120 | **/\r | |
121 | VOID\r | |
122 | CalculateResourceAperture (\r | |
123 | IN PCI_RESOURCE_NODE *Bridge\r | |
124 | );\r | |
125 | \r | |
126 | /**\r | |
fcdfcdbf | 127 | Get IO/Memory resource info for given PCI device.\r |
9060e3ec | 128 | \r |
129 | @param PciDev Pci device instance.\r | |
130 | @param IoNode Resource info node for IO .\r | |
131 | @param Mem32Node Resource info node for 32-bit memory.\r | |
132 | @param PMem32Node Resource info node for 32-bit Prefetchable Memory.\r | |
133 | @param Mem64Node Resource info node for 64-bit memory.\r | |
134 | @param PMem64Node Resource info node for 64-bit Prefetchable Memory.\r | |
135 | \r | |
136 | **/\r | |
137 | VOID\r | |
138 | GetResourceFromDevice (\r | |
139 | IN PCI_IO_DEVICE *PciDev,\r | |
140 | IN OUT PCI_RESOURCE_NODE *IoNode,\r | |
141 | IN OUT PCI_RESOURCE_NODE *Mem32Node,\r | |
142 | IN OUT PCI_RESOURCE_NODE *PMem32Node,\r | |
143 | IN OUT PCI_RESOURCE_NODE *Mem64Node,\r | |
144 | IN OUT PCI_RESOURCE_NODE *PMem64Node\r | |
145 | );\r | |
146 | \r | |
147 | /**\r | |
148 | This function is used to create a resource node.\r | |
149 | \r | |
150 | @param PciDev Pci device instance.\r | |
151 | @param Length Length of Io/Memory resource.\r | |
152 | @param Alignment Alignment of resource.\r | |
153 | @param Bar Bar index.\r | |
154 | @param ResType Type of resource: IO/Memory.\r | |
155 | @param ResUsage Resource usage.\r | |
156 | \r | |
157 | @return PCI resource node created for given PCI device.\r | |
158 | NULL means PCI resource node is not created.\r | |
159 | \r | |
160 | **/\r | |
161 | PCI_RESOURCE_NODE *\r | |
162 | CreateResourceNode (\r | |
163 | IN PCI_IO_DEVICE *PciDev,\r | |
164 | IN UINT64 Length,\r | |
165 | IN UINT64 Alignment,\r | |
166 | IN UINT8 Bar,\r | |
167 | IN PCI_BAR_TYPE ResType,\r | |
168 | IN PCI_RESOURCE_USAGE ResUsage\r | |
169 | );\r | |
170 | \r | |
171 | /**\r | |
fcdfcdbf | 172 | This function is used to create a IOV VF resource node.\r |
9060e3ec | 173 | \r |
aa75dfec | 174 | @param PciDev Pci device instance.\r |
175 | @param Length Length of Io/Memory resource.\r | |
176 | @param Alignment Alignment of resource.\r | |
177 | @param Bar Bar index.\r | |
178 | @param ResType Type of resource: IO/Memory.\r | |
179 | @param ResUsage Resource usage.\r | |
180 | \r | |
fcdfcdbf | 181 | @return PCI resource node created for given VF PCI device.\r |
aa75dfec | 182 | NULL means PCI resource node is not created.\r |
9060e3ec | 183 | \r |
184 | **/\r | |
185 | PCI_RESOURCE_NODE *\r | |
186 | CreateVfResourceNode (\r | |
187 | IN PCI_IO_DEVICE *PciDev,\r | |
188 | IN UINT64 Length,\r | |
189 | IN UINT64 Alignment,\r | |
190 | IN UINT8 Bar,\r | |
191 | IN PCI_BAR_TYPE ResType,\r | |
192 | IN PCI_RESOURCE_USAGE ResUsage\r | |
193 | );\r | |
194 | \r | |
195 | /**\r | |
196 | This function is used to extract resource request from\r | |
197 | device node list.\r | |
198 | \r | |
199 | @param Bridge Pci device instance.\r | |
200 | @param IoNode Resource info node for IO.\r | |
201 | @param Mem32Node Resource info node for 32-bit memory.\r | |
202 | @param PMem32Node Resource info node for 32-bit Prefetchable Memory.\r | |
203 | @param Mem64Node Resource info node for 64-bit memory.\r | |
204 | @param PMem64Node Resource info node for 64-bit Prefetchable Memory.\r | |
205 | \r | |
206 | **/\r | |
207 | VOID\r | |
208 | CreateResourceMap (\r | |
209 | IN PCI_IO_DEVICE *Bridge,\r | |
210 | IN OUT PCI_RESOURCE_NODE *IoNode,\r | |
211 | IN OUT PCI_RESOURCE_NODE *Mem32Node,\r | |
212 | IN OUT PCI_RESOURCE_NODE *PMem32Node,\r | |
213 | IN OUT PCI_RESOURCE_NODE *Mem64Node,\r | |
214 | IN OUT PCI_RESOURCE_NODE *PMem64Node\r | |
215 | );\r | |
216 | \r | |
217 | /**\r | |
218 | This function is used to do the resource padding for a specific platform.\r | |
219 | \r | |
220 | @param PciDev Pci device instance.\r | |
221 | @param IoNode Resource info node for IO.\r | |
222 | @param Mem32Node Resource info node for 32-bit memory.\r | |
223 | @param PMem32Node Resource info node for 32-bit Prefetchable Memory.\r | |
224 | @param Mem64Node Resource info node for 64-bit memory.\r | |
225 | @param PMem64Node Resource info node for 64-bit Prefetchable Memory.\r | |
226 | \r | |
227 | **/\r | |
228 | VOID\r | |
229 | ResourcePaddingPolicy (\r | |
230 | IN PCI_IO_DEVICE *PciDev,\r | |
231 | IN PCI_RESOURCE_NODE *IoNode,\r | |
232 | IN PCI_RESOURCE_NODE *Mem32Node,\r | |
233 | IN PCI_RESOURCE_NODE *PMem32Node,\r | |
234 | IN PCI_RESOURCE_NODE *Mem64Node,\r | |
235 | IN PCI_RESOURCE_NODE *PMem64Node\r | |
236 | );\r | |
237 | \r | |
238 | /**\r | |
239 | This function is used to degrade resource if the upstream bridge\r | |
240 | doesn't support certain resource. Degradation path is\r | |
241 | PMEM64 -> MEM64 -> MEM32\r | |
242 | PMEM64 -> PMEM32 -> MEM32\r | |
243 | IO32 -> IO16.\r | |
244 | \r | |
245 | @param Bridge Pci device instance.\r | |
246 | @param Mem32Node Resource info node for 32-bit memory.\r | |
247 | @param PMem32Node Resource info node for 32-bit Prefetchable Memory.\r | |
248 | @param Mem64Node Resource info node for 64-bit memory.\r | |
249 | @param PMem64Node Resource info node for 64-bit Prefetchable Memory.\r | |
250 | \r | |
251 | **/\r | |
252 | VOID\r | |
253 | DegradeResource (\r | |
254 | IN PCI_IO_DEVICE *Bridge,\r | |
255 | IN PCI_RESOURCE_NODE *Mem32Node,\r | |
256 | IN PCI_RESOURCE_NODE *PMem32Node,\r | |
257 | IN PCI_RESOURCE_NODE *Mem64Node,\r | |
258 | IN PCI_RESOURCE_NODE *PMem64Node\r | |
259 | );\r | |
260 | \r | |
261 | /**\r | |
262 | Test whether bridge device support decode resource.\r | |
263 | \r | |
264 | @param Bridge Bridge device instance.\r | |
265 | @param Decode Decode type according to resource type.\r | |
266 | \r | |
267 | @return TRUE The bridge device support decode resource.\r | |
268 | @return FALSE The bridge device don't support decode resource.\r | |
269 | \r | |
270 | **/\r | |
271 | BOOLEAN\r | |
272 | BridgeSupportResourceDecode (\r | |
273 | IN PCI_IO_DEVICE *Bridge,\r | |
274 | IN UINT32 Decode\r | |
275 | );\r | |
276 | \r | |
277 | /**\r | |
278 | This function is used to program the resource allocated\r | |
279 | for each resource node under specified bridge.\r | |
280 | \r | |
fcdfcdbf | 281 | @param Base Base address of resource to be programmed.\r |
9060e3ec | 282 | @param Bridge PCI resource node for the bridge device.\r |
283 | \r | |
fcdfcdbf | 284 | @retval EFI_SUCCESS Successfully to program all resources\r |
9060e3ec | 285 | on given PCI bridge device.\r |
286 | @retval EFI_OUT_OF_RESOURCES Base is all one.\r | |
287 | \r | |
288 | **/\r | |
289 | EFI_STATUS\r | |
290 | ProgramResource (\r | |
291 | IN UINT64 Base,\r | |
292 | IN PCI_RESOURCE_NODE *Bridge\r | |
293 | );\r | |
294 | \r | |
295 | /**\r | |
296 | Program Bar register for PCI device.\r | |
297 | \r | |
fcdfcdbf RN |
298 | @param Base Base address for PCI device resource to be programmed.\r |
299 | @param Node Point to resource node structure.\r | |
9060e3ec | 300 | \r |
301 | **/\r | |
302 | VOID\r | |
303 | ProgramBar (\r | |
304 | IN UINT64 Base,\r | |
305 | IN PCI_RESOURCE_NODE *Node\r | |
306 | );\r | |
307 | \r | |
308 | /**\r | |
309 | Program IOV VF Bar register for PCI device.\r | |
310 | \r | |
fcdfcdbf RN |
311 | @param Base Base address for PCI device resource to be programmed.\r |
312 | @param Node Point to resource node structure.\r | |
9060e3ec | 313 | \r |
314 | **/\r | |
315 | EFI_STATUS\r | |
316 | ProgramVfBar (\r | |
317 | IN UINT64 Base,\r | |
318 | IN PCI_RESOURCE_NODE *Node\r | |
319 | );\r | |
320 | \r | |
321 | /**\r | |
fcdfcdbf | 322 | Program PCI-PCI bridge aperture.\r |
9060e3ec | 323 | \r |
324 | @param Base Base address for resource.\r | |
fcdfcdbf | 325 | @param Node Point to resource node structure.\r |
9060e3ec | 326 | \r |
327 | **/\r | |
328 | VOID\r | |
329 | ProgramPpbApperture (\r | |
330 | IN UINT64 Base,\r | |
331 | IN PCI_RESOURCE_NODE *Node\r | |
332 | );\r | |
333 | \r | |
334 | /**\r | |
335 | Program parent bridge for Option Rom.\r | |
336 | \r | |
fcdfcdbf RN |
337 | @param PciDevice Pci device instance.\r |
338 | @param OptionRomBase Base address for Option Rom.\r | |
9060e3ec | 339 | @param Enable Enable or disable PCI memory.\r |
340 | \r | |
341 | **/\r | |
342 | VOID\r | |
fcdfcdbf | 343 | ProgramUpstreamBridgeForRom (\r |
9060e3ec | 344 | IN PCI_IO_DEVICE *PciDevice,\r |
345 | IN UINT32 OptionRomBase,\r | |
346 | IN BOOLEAN Enable\r | |
347 | );\r | |
348 | \r | |
349 | /**\r | |
350 | Test whether resource exists for a bridge.\r | |
351 | \r | |
352 | @param Bridge Point to resource node for a bridge.\r | |
353 | \r | |
354 | @retval TRUE There is resource on the given bridge.\r | |
355 | @retval FALSE There isn't resource on the given bridge.\r | |
356 | \r | |
357 | **/\r | |
358 | BOOLEAN\r | |
359 | ResourceRequestExisted (\r | |
360 | IN PCI_RESOURCE_NODE *Bridge\r | |
361 | );\r | |
362 | \r | |
363 | /**\r | |
364 | Initialize resource pool structure.\r | |
365 | \r | |
366 | @param ResourcePool Point to resource pool structure. This pool\r | |
367 | is reset to all zero when returned.\r | |
368 | @param ResourceType Type of resource.\r | |
369 | \r | |
370 | **/\r | |
371 | VOID\r | |
372 | InitializeResourcePool (\r | |
373 | IN OUT PCI_RESOURCE_NODE *ResourcePool,\r | |
374 | IN PCI_BAR_TYPE ResourceType\r | |
375 | );\r | |
376 | \r | |
9060e3ec | 377 | /**\r |
fcdfcdbf | 378 | Destroy given resource tree.\r |
9060e3ec | 379 | \r |
380 | @param Bridge PCI resource root node of resource tree.\r | |
381 | \r | |
382 | **/\r | |
383 | VOID\r | |
384 | DestroyResourceTree (\r | |
385 | IN PCI_RESOURCE_NODE *Bridge\r | |
386 | );\r | |
387 | \r | |
388 | /**\r | |
389 | Insert resource padding for P2C.\r | |
390 | \r | |
391 | @param PciDev Pci device instance.\r | |
392 | @param IoNode Resource info node for IO.\r | |
393 | @param Mem32Node Resource info node for 32-bit memory.\r | |
394 | @param PMem32Node Resource info node for 32-bit Prefetchable Memory.\r | |
395 | @param Mem64Node Resource info node for 64-bit memory.\r | |
396 | @param PMem64Node Resource info node for 64-bit Prefetchable Memory.\r | |
397 | \r | |
398 | **/\r | |
399 | VOID\r | |
400 | ResourcePaddingForCardBusBridge (\r | |
401 | IN PCI_IO_DEVICE *PciDev,\r | |
402 | IN PCI_RESOURCE_NODE *IoNode,\r | |
403 | IN PCI_RESOURCE_NODE *Mem32Node,\r | |
404 | IN PCI_RESOURCE_NODE *PMem32Node,\r | |
405 | IN PCI_RESOURCE_NODE *Mem64Node,\r | |
406 | IN PCI_RESOURCE_NODE *PMem64Node\r | |
407 | );\r | |
408 | \r | |
409 | /**\r | |
410 | Program PCI Card device register for given resource node.\r | |
411 | \r | |
412 | @param Base Base address of PCI Card device to be programmed.\r | |
413 | @param Node Given resource node.\r | |
414 | \r | |
415 | **/\r | |
416 | VOID\r | |
417 | ProgramP2C (\r | |
418 | IN UINT64 Base,\r | |
419 | IN PCI_RESOURCE_NODE *Node\r | |
420 | );\r | |
421 | \r | |
422 | /**\r | |
423 | Create padding resource node.\r | |
424 | \r | |
425 | @param PciDev Pci device instance.\r | |
426 | @param IoNode Resource info node for IO.\r | |
427 | @param Mem32Node Resource info node for 32-bit memory.\r | |
428 | @param PMem32Node Resource info node for 32-bit Prefetchable Memory.\r | |
429 | @param Mem64Node Resource info node for 64-bit memory.\r | |
430 | @param PMem64Node Resource info node for 64-bit Prefetchable Memory.\r | |
431 | \r | |
432 | **/\r | |
433 | VOID\r | |
434 | ApplyResourcePadding (\r | |
435 | IN PCI_IO_DEVICE *PciDev,\r | |
436 | IN PCI_RESOURCE_NODE *IoNode,\r | |
437 | IN PCI_RESOURCE_NODE *Mem32Node,\r | |
438 | IN PCI_RESOURCE_NODE *PMem32Node,\r | |
439 | IN PCI_RESOURCE_NODE *Mem64Node,\r | |
440 | IN PCI_RESOURCE_NODE *PMem64Node\r | |
441 | );\r | |
442 | \r | |
443 | /**\r | |
444 | Get padding resource for PCI-PCI bridge.\r | |
445 | \r | |
446 | @param PciIoDevice PCI-PCI bridge device instance.\r | |
447 | \r | |
448 | @note Feature flag PcdPciBusHotplugDeviceSupport determines\r | |
449 | whether need to pad resource for them.\r | |
450 | **/\r | |
451 | VOID\r | |
452 | GetResourcePaddingPpb (\r | |
453 | IN PCI_IO_DEVICE *PciIoDevice\r | |
454 | );\r | |
455 | \r | |
456 | #endif\r |