[mirror_edk2.git] / EdkModulePkg / Bus / Pci / PciBus / Dxe / PciLib.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
  PciLib.h\r
  \r
Abstract:\r
\r
  PCI Bus Driver Lib header file.\r
  Please use PCD feature flag PcdPciBusHotplugDeviceSupport to enable\r
  support hot plug.\r
\r
Revision History\r
\r
--*/\r
\r
#ifndef _EFI_PCI_LIB_H\r
#define _EFI_PCI_LIB_H\r
\r
VOID\r
InstallHotPlugRequestProtocol (\r
  IN  EFI_STATUS                    *Status\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Status  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
VOID\r
InstallPciHotplugGuid (\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
VOID\r
UninstallPciHotplugGuid (\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
VOID\r
GetBackPcCardBar (\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
EFI_STATUS\r
RemoveRejectedPciDevices (\r
  EFI_HANDLE        RootBridgeHandle,\r
  IN 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
PciHostBridgeResourceAllocator (\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciResAlloc - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
PciHostBridgeResourceAllocator_WithoutHotPlugDeviceSupport (\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
  )\r
;\r
\r
EFI_STATUS\r
PciHostBridgeResourceAllocator_WithHotPlugDeviceSupport (\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
  )\r
;\r
\r
EFI_STATUS\r
PciScanBus (\r
  IN PCI_IO_DEVICE                      *Bridge,\r
  IN UINT8                              StartBusNumber,\r
  OUT UINT8                             *SubBusNumber,\r
  OUT UINT8                             *PaddedBusRange\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Bridge          - TODO: add argument description\r
  StartBusNumber  - TODO: add argument description\r
  SubBusNumber    - TODO: add argument description\r
  PaddedBusRange  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
PciScanBus_WithHotPlugDeviceSupport (\r
  IN PCI_IO_DEVICE                      *Bridge,\r
  IN UINT8                              StartBusNumber,\r
  OUT UINT8                             *SubBusNumber,\r
  OUT UINT8                             *PaddedBusRange\r
  )\r
;\r
\r
EFI_STATUS\r
PciScanBus_WithoutHotPlugDeviceSupport (\r
  IN PCI_IO_DEVICE                      *Bridge,\r
  IN UINT8                              StartBusNumber,\r
  OUT UINT8                             *SubBusNumber,\r
  OUT UINT8                             *PaddedBusRange\r
  )\r
;\r
\r
EFI_STATUS\r
PciRootBridgeP2CProcess (\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
PciHostBridgeP2CProcess (\r
  IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciResAlloc - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
PciHostBridgeEnumerator (\r
  EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL  *PciResAlloc\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  PciResAlloc - 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	PciLib.h\r
	15	\r
	16	Abstract:\r
	17	\r
6874dbd0	18	PCI Bus Driver Lib header file.\r
	19	Please use PCD feature flag PcdPciBusHotplugDeviceSupport to enable\r
	20	support hot plug.\r
878ddf1f	21	\r
	22	Revision History\r
	23	\r
	24	--*/\r
	25	\r
	26	#ifndef _EFI_PCI_LIB_H\r
	27	#define _EFI_PCI_LIB_H\r
	28	\r
	29	VOID\r
	30	InstallHotPlugRequestProtocol (\r
	31	IN EFI_STATUS *Status\r
	32	)\r
	33	/*++\r
	34	\r
	35	Routine Description:\r
	36	\r
	37	TODO: Add function description\r
	38	\r
	39	Arguments:\r
	40	\r
	41	Status - TODO: add argument description\r
	42	\r
	43	Returns:\r
	44	\r
	45	TODO: add return values\r
	46	\r
	47	--*/\r
	48	;\r
	49	\r
	50	VOID\r
	51	InstallPciHotplugGuid (\r
	52	IN PCI_IO_DEVICE *PciIoDevice\r
	53	)\r
	54	/*++\r
	55	\r
	56	Routine Description:\r
	57	\r
	58	TODO: Add function description\r
	59	\r
	60	Arguments:\r
	61	\r
	62	PciIoDevice - TODO: add argument description\r
	63	\r
	64	Returns:\r
	65	\r
	66	TODO: add return values\r
	67	\r
	68	--*/\r
	69	;\r
	70	\r
	71	VOID\r
	72	UninstallPciHotplugGuid (\r
	73	IN PCI_IO_DEVICE *PciIoDevice\r
	74	)\r
	75	/*++\r
	76	\r
	77	Routine Description:\r
	78	\r
	79	TODO: Add function description\r
	80	\r
	81	Arguments:\r
	82	\r
	83	PciIoDevice - 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	VOID\r
93	GetBackPcCardBar (\r
94	IN PCI_IO_DEVICE *PciIoDevice\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	PciIoDevice - 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	RemoveRejectedPciDevices (\r
115	EFI_HANDLE RootBridgeHandle,\r
116	IN PCI_IO_DEVICE *Bridge\r
117	)\r
118	/*++\r
119	\r
120	Routine Description:\r
121	\r
122	TODO: Add function description\r
123	\r
124	Arguments:\r
125	\r
126	RootBridgeHandle - TODO: add argument description\r
127	Bridge - TODO: add argument description\r
128	\r
129	Returns:\r
130	\r
131	TODO: add return values\r
132	\r
133	--*/\r
134	;\r
135	\r
136	EFI_STATUS\r
137	PciHostBridgeResourceAllocator (\r
138	IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
139	)\r
140	/*++\r
141	\r
142	Routine Description:\r
143	\r
144	TODO: Add function description\r
145	\r
146	Arguments:\r
147	\r
148	PciResAlloc - TODO: add argument description\r
149	\r
150	Returns:\r
151	\r
152	TODO: add return values\r
153	\r
154	--*/\r
155	;\r
156	\r
6874dbd0	157	EFI_STATUS\r
	158	PciHostBridgeResourceAllocator_WithoutHotPlugDeviceSupport (\r
	159	IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
	160	)\r
	161	;\r
	162	\r
	163	EFI_STATUS\r
	164	PciHostBridgeResourceAllocator_WithHotPlugDeviceSupport (\r
	165	IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
	166	)\r
	167	;\r
	168	\r
878ddf1f	169	EFI_STATUS\r
	170	PciScanBus (\r
	171	IN PCI_IO_DEVICE *Bridge,\r
	172	IN UINT8 StartBusNumber,\r
	173	OUT UINT8 *SubBusNumber,\r
	174	OUT UINT8 *PaddedBusRange\r
	175	)\r
	176	/*++\r
	177	\r
	178	Routine Description:\r
	179	\r
	180	TODO: Add function description\r
	181	\r
	182	Arguments:\r
	183	\r
	184	Bridge - TODO: add argument description\r
	185	StartBusNumber - TODO: add argument description\r
	186	SubBusNumber - TODO: add argument description\r
	187	PaddedBusRange - TODO: add argument description\r
	188	\r
	189	Returns:\r
	190	\r
	191	TODO: add return values\r
	192	\r
	193	--*/\r
	194	;\r
	195	\r
6874dbd0	196	EFI_STATUS\r
	197	PciScanBus_WithHotPlugDeviceSupport (\r
	198	IN PCI_IO_DEVICE *Bridge,\r
	199	IN UINT8 StartBusNumber,\r
	200	OUT UINT8 *SubBusNumber,\r
	201	OUT UINT8 *PaddedBusRange\r
	202	)\r
	203	;\r
	204	\r
	205	EFI_STATUS\r
	206	PciScanBus_WithoutHotPlugDeviceSupport (\r
	207	IN PCI_IO_DEVICE *Bridge,\r
	208	IN UINT8 StartBusNumber,\r
	209	OUT UINT8 *SubBusNumber,\r
	210	OUT UINT8 *PaddedBusRange\r
	211	)\r
	212	;\r
	213	\r
878ddf1f	214	EFI_STATUS\r
	215	PciRootBridgeP2CProcess (\r
	216	IN PCI_IO_DEVICE *Bridge\r
	217	)\r
	218	/*++\r
	219	\r
	220	Routine Description:\r
	221	\r
	222	TODO: Add function description\r
	223	\r
	224	Arguments:\r
	225	\r
	226	Bridge - TODO: add argument description\r
	227	\r
	228	Returns:\r
	229	\r
	230	TODO: add return values\r
	231	\r
	232	--*/\r
	233	;\r
	234	\r
	235	EFI_STATUS\r
	236	PciHostBridgeP2CProcess (\r
	237	IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
	238	)\r
	239	/*++\r
	240	\r
	241	Routine Description:\r
	242	\r
	243	TODO: Add function description\r
	244	\r
	245	Arguments:\r
	246	\r
	247	PciResAlloc - TODO: add argument description\r
	248	\r
	249	Returns:\r
	250	\r
	251	TODO: add return values\r
	252	\r
	253	--*/\r
	254	;\r
	255	\r
	256	EFI_STATUS\r
	257	PciHostBridgeEnumerator (\r
	258	EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\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	PciResAlloc - TODO: add argument description\r
	269	\r
	270	Returns:\r
	271	\r
	272	TODO: add return values\r
	273	\r
	274	--*/\r
	275	;\r
	276	\r
	277	#endif\r