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