]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumeratorSupport.h
Correct all header files for doxygen format and correct the license issue for VgaClas...
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciEnumeratorSupport.h
CommitLineData
3db51098 1/**@file\r
ead42efc 2\r
3Copyright (c) 2006, Intel Corporation \r
4All rights reserved. This program and the accompanying materials \r
5are licensed and made available under the terms and conditions of the BSD License \r
6which accompanies this distribution. The full text of the license may be found at \r
7http://opensource.org/licenses/bsd-license.php \r
8 \r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
11\r
3db51098 12**/\r
ead42efc 13\r
ead42efc 14\r
15#ifndef _EFI_PCI_ENUMERATOR_SUPPORT_H\r
16#define _EFI_PCI_ENUMERATOR_SUPPORT_H\r
17\r
18EFI_STATUS\r
19PciDevicePresent (\r
20 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo,\r
21 PCI_TYPE00 *Pci,\r
22 UINT8 Bus,\r
23 UINT8 Device,\r
24 UINT8 Func\r
25 )\r
26/*++\r
27\r
28Routine Description:\r
29\r
30 TODO: Add function description\r
31\r
32Arguments:\r
33\r
34 PciRootBridgeIo - TODO: add argument description\r
35 Pci - TODO: add argument description\r
36 Bus - TODO: add argument description\r
37 Device - TODO: add argument description\r
38 Func - TODO: add argument description\r
39\r
40Returns:\r
41\r
42 TODO: add return values\r
43\r
44--*/\r
45;\r
46\r
47EFI_STATUS\r
48PciPciDeviceInfoCollector (\r
49 IN PCI_IO_DEVICE *Bridge,\r
50 UINT8 StartBusNumber\r
51 )\r
52/*++\r
53\r
54Routine Description:\r
55\r
56 TODO: Add function description\r
57\r
58Arguments:\r
59\r
60 Bridge - TODO: add argument description\r
61 StartBusNumber - TODO: add argument description\r
62\r
63Returns:\r
64\r
65 TODO: add return values\r
66\r
67--*/\r
68;\r
69\r
70EFI_STATUS\r
71PciSearchDevice (\r
72 IN PCI_IO_DEVICE *Bridge,\r
73 PCI_TYPE00 *Pci,\r
74 UINT8 Bus,\r
75 UINT8 Device,\r
76 UINT8 Func,\r
77 PCI_IO_DEVICE **PciDevice\r
78 )\r
79/*++\r
80\r
81Routine Description:\r
82\r
83 TODO: Add function description\r
84\r
85Arguments:\r
86\r
87 Bridge - TODO: add argument description\r
88 Pci - TODO: add argument description\r
89 Bus - TODO: add argument description\r
90 Device - TODO: add argument description\r
91 Func - TODO: add argument description\r
92 PciDevice - TODO: add argument description\r
93\r
94Returns:\r
95\r
96 TODO: add return values\r
97\r
98--*/\r
99;\r
100\r
101PCI_IO_DEVICE *\r
102GatherDeviceInfo (\r
103 IN PCI_IO_DEVICE *Bridge,\r
104 IN PCI_TYPE00 *Pci,\r
105 UINT8 Bus,\r
106 UINT8 Device,\r
107 UINT8 Func\r
108 )\r
109/*++\r
110\r
111Routine Description:\r
112\r
113 TODO: Add function description\r
114\r
115Arguments:\r
116\r
117 Bridge - TODO: add argument description\r
118 Pci - TODO: add argument description\r
119 Bus - TODO: add argument description\r
120 Device - TODO: add argument description\r
121 Func - TODO: add argument description\r
122\r
123Returns:\r
124\r
125 TODO: add return values\r
126\r
127--*/\r
128;\r
129\r
130PCI_IO_DEVICE *\r
131GatherPpbInfo (\r
132 IN PCI_IO_DEVICE *Bridge,\r
133 IN PCI_TYPE00 *Pci,\r
134 UINT8 Bus,\r
135 UINT8 Device,\r
136 UINT8 Func\r
137 )\r
138/*++\r
139\r
140Routine Description:\r
141\r
142 TODO: Add function description\r
143\r
144Arguments:\r
145\r
146 Bridge - TODO: add argument description\r
147 Pci - TODO: add argument description\r
148 Bus - TODO: add argument description\r
149 Device - TODO: add argument description\r
150 Func - TODO: add argument description\r
151\r
152Returns:\r
153\r
154 TODO: add return values\r
155\r
156--*/\r
157;\r
158\r
159PCI_IO_DEVICE *\r
160GatherP2CInfo (\r
161 IN PCI_IO_DEVICE *Bridge,\r
162 IN PCI_TYPE00 *Pci,\r
163 UINT8 Bus,\r
164 UINT8 Device,\r
165 UINT8 Func\r
166 )\r
167/*++\r
168\r
169Routine Description:\r
170\r
171 TODO: Add function description\r
172\r
173Arguments:\r
174\r
175 Bridge - TODO: add argument description\r
176 Pci - TODO: add argument description\r
177 Bus - TODO: add argument description\r
178 Device - TODO: add argument description\r
179 Func - TODO: add argument description\r
180\r
181Returns:\r
182\r
183 TODO: add return values\r
184\r
185--*/\r
186;\r
187\r
188EFI_DEVICE_PATH_PROTOCOL *\r
189CreatePciDevicePath (\r
190 IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath,\r
191 IN PCI_IO_DEVICE *PciIoDevice\r
192 )\r
193/*++\r
194\r
195Routine Description:\r
196\r
197 TODO: Add function description\r
198\r
199Arguments:\r
200\r
201 ParentDevicePath - TODO: add argument description\r
202 PciIoDevice - TODO: add argument description\r
203\r
204Returns:\r
205\r
206 TODO: add return values\r
207\r
208--*/\r
209;\r
210\r
211EFI_STATUS\r
212BarExisted (\r
213 IN PCI_IO_DEVICE *PciIoDevice,\r
214 IN UINTN Offset,\r
215 OUT UINT32 *BarLengthValue,\r
216 OUT UINT32 *OriginalBarValue\r
217 )\r
218/*++\r
219\r
220Routine Description:\r
221\r
222 TODO: Add function description\r
223\r
224Arguments:\r
225\r
226 PciIoDevice - TODO: add argument description\r
227 Offset - TODO: add argument description\r
228 BarLengthValue - TODO: add argument description\r
229 OriginalBarValue - TODO: add argument description\r
230\r
231Returns:\r
232\r
233 TODO: add return values\r
234\r
235--*/\r
236;\r
237\r
238EFI_STATUS\r
239PciTestSupportedAttribute (\r
240 IN PCI_IO_DEVICE *PciIoDevice,\r
241 IN UINT16 *Command,\r
242 IN UINT16 *BridgeControl,\r
243 IN UINT16 *OldCommand,\r
244 IN UINT16 *OldBridgeControl\r
245 )\r
246/*++\r
247\r
248Routine Description:\r
249\r
250 TODO: Add function description\r
251\r
252Arguments:\r
253\r
254 PciIoDevice - TODO: add argument description\r
255 Command - TODO: add argument description\r
256 BridgeControl - TODO: add argument description\r
257 OldCommand - TODO: add argument description\r
258 OldBridgeControl - TODO: add argument description\r
259\r
260Returns:\r
261\r
262 TODO: add return values\r
263\r
264--*/\r
265;\r
266\r
267EFI_STATUS\r
268PciSetDeviceAttribute (\r
269 IN PCI_IO_DEVICE *PciIoDevice,\r
270 IN UINT16 Command,\r
271 IN UINT16 BridgeControl,\r
272 IN UINTN Option\r
273 )\r
274/*++\r
275\r
276Routine Description:\r
277\r
278 TODO: Add function description\r
279\r
280Arguments:\r
281\r
282 PciIoDevice - TODO: add argument description\r
283 Command - TODO: add argument description\r
284 BridgeControl - TODO: add argument description\r
285 Option - TODO: add argument description\r
286\r
287Returns:\r
288\r
289 TODO: add return values\r
290\r
291--*/\r
292;\r
293\r
294EFI_STATUS\r
295GetFastBackToBackSupport (\r
296 IN PCI_IO_DEVICE *PciIoDevice,\r
297 IN UINT8 StatusIndex\r
298 )\r
299/*++\r
300\r
301Routine Description:\r
302\r
303 TODO: Add function description\r
304\r
305Arguments:\r
306\r
307 PciIoDevice - TODO: add argument description\r
308 StatusIndex - TODO: add argument description\r
309\r
310Returns:\r
311\r
312 TODO: add return values\r
313\r
314--*/\r
315;\r
316\r
317EFI_STATUS\r
318DetermineDeviceAttribute (\r
319 IN PCI_IO_DEVICE *PciIoDevice\r
320 )\r
321/*++\r
322\r
323Routine Description:\r
324\r
325 TODO: Add function description\r
326\r
327Arguments:\r
328\r
329 PciIoDevice - TODO: add argument description\r
330\r
331Returns:\r
332\r
333 TODO: add return values\r
334\r
335--*/\r
336;\r
337\r
338EFI_STATUS\r
339UpdatePciInfo (\r
340 IN PCI_IO_DEVICE *PciIoDevice\r
341 )\r
342/*++\r
343\r
344Routine Description:\r
345\r
346 TODO: Add function description\r
347\r
348Arguments:\r
349\r
350 PciIoDevice - TODO: add argument description\r
351\r
352Returns:\r
353\r
354 TODO: add return values\r
355\r
356--*/\r
357;\r
358\r
359VOID\r
360SetNewAlign (\r
361 IN UINT64 *Alignment,\r
362 IN UINT64 NewAlignment\r
363 )\r
364/*++\r
365\r
366Routine Description:\r
367\r
368 TODO: Add function description\r
369\r
370Arguments:\r
371\r
372 Alignment - TODO: add argument description\r
373 NewAlignment - TODO: add argument description\r
374\r
375Returns:\r
376\r
377 TODO: add return values\r
378\r
379--*/\r
380;\r
381\r
382UINTN\r
383PciParseBar (\r
384 IN PCI_IO_DEVICE *PciIoDevice,\r
385 IN UINTN Offset,\r
386 IN UINTN BarIndex\r
387 )\r
388/*++\r
389\r
390Routine Description:\r
391\r
392 TODO: Add function description\r
393\r
394Arguments:\r
395\r
396 PciIoDevice - TODO: add argument description\r
397 Offset - TODO: add argument description\r
398 BarIndex - TODO: add argument description\r
399\r
400Returns:\r
401\r
402 TODO: add return values\r
403\r
404--*/\r
405;\r
406\r
407EFI_STATUS\r
408InitializePciDevice (\r
409 IN PCI_IO_DEVICE *PciIoDevice\r
410 )\r
411/*++\r
412\r
413Routine Description:\r
414\r
415 TODO: Add function description\r
416\r
417Arguments:\r
418\r
419 PciIoDevice - TODO: add argument description\r
420\r
421Returns:\r
422\r
423 TODO: add return values\r
424\r
425--*/\r
426;\r
427\r
428EFI_STATUS\r
429InitializePpb (\r
430 IN PCI_IO_DEVICE *PciIoDevice\r
431 )\r
432/*++\r
433\r
434Routine Description:\r
435\r
436 TODO: Add function description\r
437\r
438Arguments:\r
439\r
440 PciIoDevice - TODO: add argument description\r
441\r
442Returns:\r
443\r
444 TODO: add return values\r
445\r
446--*/\r
447;\r
448\r
449EFI_STATUS\r
450InitializeP2C (\r
451 IN PCI_IO_DEVICE *PciIoDevice\r
452 )\r
453/*++\r
454\r
455Routine Description:\r
456\r
457 TODO: Add function description\r
458\r
459Arguments:\r
460\r
461 PciIoDevice - TODO: add argument description\r
462\r
463Returns:\r
464\r
465 TODO: add return values\r
466\r
467--*/\r
468;\r
469\r
470PCI_IO_DEVICE *\r
471CreatePciIoDevice (\r
472 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo,\r
473 IN PCI_TYPE00 *Pci,\r
474 UINT8 Bus,\r
475 UINT8 Device,\r
476 UINT8 Func\r
477 )\r
478/*++\r
479\r
480Routine Description:\r
481\r
482 TODO: Add function description\r
483\r
484Arguments:\r
485\r
486 PciRootBridgeIo - TODO: add argument description\r
487 Pci - TODO: add argument description\r
488 Bus - TODO: add argument description\r
489 Device - TODO: add argument description\r
490 Func - TODO: add argument description\r
491\r
492Returns:\r
493\r
494 TODO: add return values\r
495\r
496--*/\r
497;\r
498\r
499EFI_STATUS\r
500PciEnumeratorLight (\r
501 IN EFI_HANDLE Controller\r
502 )\r
503/*++\r
504\r
505Routine Description:\r
506\r
507 TODO: Add function description\r
508\r
509Arguments:\r
510\r
511 Controller - TODO: add argument description\r
512\r
513Returns:\r
514\r
515 TODO: add return values\r
516\r
517--*/\r
518;\r
519\r
520EFI_STATUS\r
521PciGetBusRange (\r
522 IN EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR **Descriptors,\r
523 OUT UINT16 *MinBus,\r
524 OUT UINT16 *MaxBus,\r
525 OUT UINT16 *BusRange\r
526 )\r
527/*++\r
528\r
529Routine Description:\r
530\r
531 TODO: Add function description\r
532\r
533Arguments:\r
534\r
535 Descriptors - TODO: add argument description\r
536 MinBus - TODO: add argument description\r
537 MaxBus - TODO: add argument description\r
538 BusRange - TODO: add argument description\r
539\r
540Returns:\r
541\r
542 TODO: add return values\r
543\r
544--*/\r
545;\r
546\r
547EFI_STATUS\r
548StartManagingRootBridge (\r
549 IN PCI_IO_DEVICE *RootBridgeDev\r
550 )\r
551/*++\r
552\r
553Routine Description:\r
554\r
555 TODO: Add function description\r
556\r
557Arguments:\r
558\r
559 RootBridgeDev - TODO: add argument description\r
560\r
561Returns:\r
562\r
563 TODO: add return values\r
564\r
565--*/\r
566;\r
567\r
568BOOLEAN\r
569IsPciDeviceRejected (\r
570 IN PCI_IO_DEVICE *PciIoDevice\r
571 )\r
572/*++\r
573\r
574Routine Description:\r
575\r
576 TODO: Add function description\r
577\r
578Arguments:\r
579\r
580 PciIoDevice - TODO: add argument description\r
581\r
582Returns:\r
583\r
584 TODO: add return values\r
585\r
586--*/\r
587;\r
588\r
589#endif\r