[mirror_edk2.git] / EdkModulePkg / Bus / Pci / PciBus / Dxe / PciDeviceSupport.h

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
  PciDeviceSupport.h\r
  \r
Abstract:\r
\r
  \r
\r
Revision History\r
\r
--*/\r
\r
#ifndef _EFI_PCI_DEVICE_SUPPORT_H\r
#define _EFI_PCI_DEVICE_SUPPORT_H\r
\r
EFI_STATUS\r
InitializePciDevicePool (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
InsertRootBridge (\r
  PCI_IO_DEVICE *RootBridge\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootBridge  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
InsertPciDevice (\r
  PCI_IO_DEVICE *Bridge,\r
  PCI_IO_DEVICE *PciDeviceNode\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Bridge        - TODO: add argument description\r
  PciDeviceNode - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
DestroyRootBridge (\r
  IN PCI_IO_DEVICE *RootBridge\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootBridge  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
DestroyPciDeviceTree (\r
  IN PCI_IO_DEVICE *Bridge\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Bridge  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
DestroyRootBridgeByHandle (\r
  EFI_HANDLE Controller\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Controller  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
RegisterPciDevice (\r
  IN  EFI_HANDLE                     Controller,\r
  IN  PCI_IO_DEVICE                  *PciIoDevice,\r
  OUT EFI_HANDLE                     *Handle OPTIONAL\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Controller  - TODO: add argument description\r
  PciIoDevice - TODO: add argument description\r
  Handle      - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
RemoveAllPciDeviceOnBridge (\r
  EFI_HANDLE               RootBridgeHandle,\r
  PCI_IO_DEVICE            *Bridge\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootBridgeHandle  - TODO: add argument description\r
  Bridge            - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
DeRegisterPciDevice (\r
  IN  EFI_HANDLE                     Controller,\r
  IN  EFI_HANDLE                     Handle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Controller  - TODO: add argument description\r
  Handle      - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
StartPciDevicesOnBridge (\r
  IN EFI_HANDLE                          Controller,\r
  IN PCI_IO_DEVICE                       *RootBridge,\r
  IN EFI_DEVICE_PATH_PROTOCOL            *RemainingDevicePath,\r
  IN OUT UINT8                           *NumberOfChildren,\r
  IN OUT EFI_HANDLE                      *ChildHandleBuffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Controller          - TODO: add argument description\r
  RootBridge          - TODO: add argument description\r
  RemainingDevicePath - TODO: add argument description\r
  NumberOfChildren    - TODO: add argument description\r
  ChildHandleBuffer   - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
StartPciDevices (\r
  IN EFI_HANDLE                         Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL           *RemainingDevicePath\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Controller          - TODO: add argument description\r
  RemainingDevicePath - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
PCI_IO_DEVICE *\r
CreateRootBridge (\r
  IN EFI_HANDLE RootBridgeHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootBridgeHandle  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
PCI_IO_DEVICE *\r
GetRootBridgeByHandle (\r
  EFI_HANDLE RootBridgeHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootBridgeHandle  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
BOOLEAN\r
RootBridgeExisted (\r
  IN EFI_HANDLE RootBridgeHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootBridgeHandle  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
BOOLEAN\r
PciDeviceExisted (\r
  IN PCI_IO_DEVICE    *Bridge,\r
  IN PCI_IO_DEVICE    *PciIoDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Bridge      - TODO: add argument description\r
  PciIoDevice - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
PCI_IO_DEVICE *\r
ActiveVGADeviceOnTheSameSegment (\r
  IN PCI_IO_DEVICE        *VgaDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  VgaDevice - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
PCI_IO_DEVICE *\r
ActiveVGADeviceOnTheRootBridge (\r
  IN PCI_IO_DEVICE        *RootBridge\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootBridge  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
GetHpcPciAddress (\r
  IN  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo,\r
  IN  EFI_DEVICE_PATH_PROTOCOL         *HpcDevicePath,\r
  OUT UINT64                           *PciAddress\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciRootBridgeIo - TODO: add argument description\r
  HpcDevicePath   - TODO: add argument description\r
  PciAddress      - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
GetHpcPciAddressFromRootBridge (\r
  IN  PCI_IO_DEVICE                    *RootBridge,\r
  IN  EFI_DEVICE_PATH_PROTOCOL         *RemainingDevicePath,\r
  OUT UINT64                           *PciAddress\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootBridge          - TODO: add argument description\r
  RemainingDevicePath - TODO: add argument description\r
  PciAddress          - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
FreePciDevice (\r
  IN PCI_IO_DEVICE *PciIoDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciIoDevice - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
#endif\r
Commit	Line	Data
878ddf1f	1	/*++\r
	2	\r
	3	Copyright (c) 2006, Intel Corporation \r
	4	All rights reserved. This program and the accompanying materials \r
	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	11	\r
	12	Module Name:\r
	13	\r
	14	PciDeviceSupport.h\r
	15	\r
	16	Abstract:\r
	17	\r
	18	\r
	19	\r
	20	Revision History\r
	21	\r
	22	--*/\r
	23	\r
	24	#ifndef _EFI_PCI_DEVICE_SUPPORT_H\r
	25	#define _EFI_PCI_DEVICE_SUPPORT_H\r
	26	\r
	27	EFI_STATUS\r
	28	InitializePciDevicePool (\r
	29	VOID\r
	30	)\r
	31	/*++\r
	32	\r
	33	Routine Description:\r
	34	\r
	35	TODO: Add function description\r
	36	\r
	37	Arguments:\r
	38	\r
	39	None\r
	40	\r
	41	Returns:\r
	42	\r
	43	TODO: add return values\r
	44	\r
	45	--*/\r
	46	;\r
	47	\r
	48	EFI_STATUS\r
	49	InsertRootBridge (\r
	50	PCI_IO_DEVICE *RootBridge\r
	51	)\r
	52	/*++\r
	53	\r
	54	Routine Description:\r
	55	\r
	56	TODO: Add function description\r
	57	\r
	58	Arguments:\r
	59	\r
	60	RootBridge - TODO: add argument description\r
	61	\r
	62	Returns:\r
	63	\r
	64	TODO: add return values\r
65	\r
66	--*/\r
67	;\r
68	\r
69	EFI_STATUS\r
70	InsertPciDevice (\r
71	PCI_IO_DEVICE *Bridge,\r
72	PCI_IO_DEVICE *PciDeviceNode\r
73	)\r
74	/*++\r
75	\r
76	Routine Description:\r
77	\r
78	TODO: Add function description\r
79	\r
80	Arguments:\r
81	\r
82	Bridge - TODO: add argument description\r
83	PciDeviceNode - TODO: add argument description\r
84	\r
85	Returns:\r
86	\r
87	TODO: add return values\r
88	\r
89	--*/\r
90	;\r
91	\r
92	EFI_STATUS\r
93	DestroyRootBridge (\r
94	IN PCI_IO_DEVICE *RootBridge\r
95	)\r
96	/*++\r
97	\r
98	Routine Description:\r
99	\r
100	TODO: Add function description\r
101	\r
102	Arguments:\r
103	\r
104	RootBridge - TODO: add argument description\r
105	\r
106	Returns:\r
107	\r
108	TODO: add return values\r
109	\r
110	--*/\r
111	;\r
112	\r
113	EFI_STATUS\r
114	DestroyPciDeviceTree (\r
115	IN PCI_IO_DEVICE *Bridge\r
116	)\r
117	/*++\r
118	\r
119	Routine Description:\r
120	\r
121	TODO: Add function description\r
122	\r
123	Arguments:\r
124	\r
125	Bridge - TODO: add argument description\r
126	\r
127	Returns:\r
128	\r
129	TODO: add return values\r
130	\r
131	--*/\r
132	;\r
133	\r
134	EFI_STATUS\r
135	DestroyRootBridgeByHandle (\r
136	EFI_HANDLE Controller\r
137	)\r
138	/*++\r
139	\r
140	Routine Description:\r
141	\r
142	TODO: Add function description\r
143	\r
144	Arguments:\r
145	\r
146	Controller - TODO: add argument description\r
147	\r
148	Returns:\r
149	\r
150	TODO: add return values\r
151	\r
152	--*/\r
153	;\r
154	\r
155	EFI_STATUS\r
156	RegisterPciDevice (\r
157	IN EFI_HANDLE Controller,\r
158	IN PCI_IO_DEVICE *PciIoDevice,\r
159	OUT EFI_HANDLE *Handle OPTIONAL\r
160	)\r
161	/*++\r
162	\r
163	Routine Description:\r
164	\r
165	TODO: Add function description\r
166	\r
167	Arguments:\r
168	\r
169	Controller - TODO: add argument description\r
170	PciIoDevice - TODO: add argument description\r
171	Handle - TODO: add argument description\r
172	\r
173	Returns:\r
174	\r
175	TODO: add return values\r
176	\r
177	--*/\r
178	;\r
179	\r
180	EFI_STATUS\r
181	RemoveAllPciDeviceOnBridge (\r
182	EFI_HANDLE RootBridgeHandle,\r
183	PCI_IO_DEVICE *Bridge\r
184	)\r
185	/*++\r
186	\r
187	Routine Description:\r
188	\r
189	TODO: Add function description\r
190	\r
191	Arguments:\r
192	\r
193	RootBridgeHandle - TODO: add argument description\r
194	Bridge - TODO: add argument description\r
195	\r
196	Returns:\r
197	\r
198	TODO: add return values\r
199	\r
200	--*/\r
201	;\r
202	\r
203	EFI_STATUS\r
204	DeRegisterPciDevice (\r
205	IN EFI_HANDLE Controller,\r
206	IN EFI_HANDLE Handle\r
207	)\r
208	/*++\r
209	\r
210	Routine Description:\r
211	\r
212	TODO: Add function description\r
213	\r
214	Arguments:\r
215	\r
216	Controller - TODO: add argument description\r
217	Handle - TODO: add argument description\r
218	\r
219	Returns:\r
220	\r
221	TODO: add return values\r
222	\r
223	--*/\r
224	;\r
225	\r
226	EFI_STATUS\r
227	StartPciDevicesOnBridge (\r
228	IN EFI_HANDLE Controller,\r
229	IN PCI_IO_DEVICE *RootBridge,\r
230	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath,\r
231	IN OUT UINT8 *NumberOfChildren,\r
232	IN OUT EFI_HANDLE *ChildHandleBuffer\r
233	)\r
234	/*++\r
235	\r
236	Routine Description:\r
237	\r
238	TODO: Add function description\r
239	\r
240	Arguments:\r
241	\r
242	Controller - TODO: add argument description\r
243	RootBridge - TODO: add argument description\r
244	RemainingDevicePath - TODO: add argument description\r
245	NumberOfChildren - TODO: add argument description\r
246	ChildHandleBuffer - TODO: add argument description\r
247	\r
248	Returns:\r
249	\r
250	TODO: add return values\r
251	\r
252	--*/\r
253	;\r
254	\r
255	EFI_STATUS\r
256	StartPciDevices (\r
257	IN EFI_HANDLE Controller,\r
258	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
259	)\r
260	/*++\r
261	\r
262	Routine Description:\r
263	\r
264	TODO: Add function description\r
265	\r
266	Arguments:\r
267	\r
268	Controller - TODO: add argument description\r
269	RemainingDevicePath - TODO: add argument description\r
270	\r
271	Returns:\r
272	\r
273	TODO: add return values\r
274	\r
275	--*/\r
276	;\r
277	\r
278	PCI_IO_DEVICE *\r
279	CreateRootBridge (\r
280	IN EFI_HANDLE RootBridgeHandle\r
281	)\r
282	/*++\r
283	\r
284	Routine Description:\r
285	\r
286	TODO: Add function description\r
287	\r
288	Arguments:\r
289	\r
290	RootBridgeHandle - TODO: add argument description\r
291	\r
292	Returns:\r
293	\r
294	TODO: add return values\r
295	\r
296	--*/\r
297	;\r
298	\r
299	PCI_IO_DEVICE *\r
300	GetRootBridgeByHandle (\r
301	EFI_HANDLE RootBridgeHandle\r
302	)\r
303	/*++\r
304	\r
305	Routine Description:\r
306	\r
307	TODO: Add function description\r
308	\r
309	Arguments:\r
310	\r
311	RootBridgeHandle - TODO: add argument description\r
312	\r
313	Returns:\r
314	\r
315	TODO: add return values\r
316	\r
317	--*/\r
318	;\r
319	\r
320	BOOLEAN\r
321	RootBridgeExisted (\r
322	IN EFI_HANDLE RootBridgeHandle\r
323	)\r
324	/*++\r
325	\r
326	Routine Description:\r
327	\r
328	TODO: Add function description\r
329	\r
330	Arguments:\r
331	\r
332	RootBridgeHandle - TODO: add argument description\r
333	\r
334	Returns:\r
335	\r
336	TODO: add return values\r
337	\r
338	--*/\r
339	;\r
340	\r
341	BOOLEAN\r
342	PciDeviceExisted (\r
343	IN PCI_IO_DEVICE *Bridge,\r
344	IN PCI_IO_DEVICE *PciIoDevice\r
345	)\r
346	/*++\r
347	\r
348	Routine Description:\r
349	\r
350	TODO: Add function description\r
351	\r
352	Arguments:\r
353	\r
354	Bridge - TODO: add argument description\r
355	PciIoDevice - TODO: add argument description\r
356	\r
357	Returns:\r
358	\r
359	TODO: add return values\r
360	\r
361	--*/\r
362	;\r
363	\r
364	PCI_IO_DEVICE *\r
365	ActiveVGADeviceOnTheSameSegment (\r
366	IN PCI_IO_DEVICE *VgaDevice\r
367	)\r
368	/*++\r
369	\r
370	Routine Description:\r
371	\r
372	TODO: Add function description\r
373	\r
374	Arguments:\r
375	\r
376	VgaDevice - TODO: add argument description\r
377	\r
378	Returns:\r
379	\r
380	TODO: add return values\r
381	\r
382	--*/\r
383	;\r
384	\r
385	PCI_IO_DEVICE *\r
386	ActiveVGADeviceOnTheRootBridge (\r
387	IN PCI_IO_DEVICE *RootBridge\r
388	)\r
389	/*++\r
390	\r
391	Routine Description:\r
392	\r
393	TODO: Add function description\r
394	\r
395	Arguments:\r
396	\r
397	RootBridge - TODO: add argument description\r
398	\r
399	Returns:\r
400	\r
401	TODO: add return values\r
402	\r
403	--*/\r
404	;\r
405	\r
406	EFI_STATUS\r
407	GetHpcPciAddress (\r
408	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo,\r
409	IN EFI_DEVICE_PATH_PROTOCOL *HpcDevicePath,\r
410	OUT UINT64 *PciAddress\r
411	)\r
412	/*++\r
413	\r
414	Routine Description:\r
415	\r
416	TODO: Add function description\r
417	\r
418	Arguments:\r
419	\r
420	PciRootBridgeIo - TODO: add argument description\r
421	HpcDevicePath - TODO: add argument description\r
422	PciAddress - TODO: add argument description\r
423	\r
424	Returns:\r
425	\r
426	TODO: add return values\r
427	\r
428	--*/\r
429	;\r
430	\r
431	EFI_STATUS\r
432	GetHpcPciAddressFromRootBridge (\r
433	IN PCI_IO_DEVICE *RootBridge,\r
434	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath,\r
435	OUT UINT64 *PciAddress\r
436	)\r
437	/*++\r
438	\r
439	Routine Description:\r
440	\r
441	TODO: Add function description\r
442	\r
443	Arguments:\r
444	\r
445	RootBridge - TODO: add argument description\r
446	RemainingDevicePath - TODO: add argument description\r
447	PciAddress - TODO: add argument description\r
448	\r
449	Returns:\r
450	\r
451	TODO: add return values\r
452	\r
453	--*/\r
454	;\r
455	\r
456	EFI_STATUS\r
457	FreePciDevice (\r
458	IN PCI_IO_DEVICE *PciIoDevice\r
459	)\r
460	/*++\r
461	\r
462	Routine Description:\r
463	\r
464	TODO: Add function description\r
465	\r
466	Arguments:\r
467	\r
468	PciIoDevice - TODO: add argument description\r
469	\r
470	Returns:\r
471	\r
472	TODO: add return values\r
473	\r
474	--*/\r
475	;\r
476	\r
477	#endif\r