[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / PciHotPlugRequest.h

/** @file\r
  Provides services to notify PCI bus driver that some events have happened in a hot-plug controller\r
  (for example, PC Card socket, or PHPC), and ask PCI bus driver to create or destroy handles for the\r
  PCI-like devices.\r
\r
Copyright (c) 2006 - 2009, 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
**/\r
\r
#ifndef __PCI_HOTPLUG_REQUEST_H_\r
#define __PCI_HOTPLUG_REQUEST_H_\r
\r
#define EFI_PCI_HOTPLUG_REQUEST_PROTOCOL_GUID \\r
  {0x19cb87ab,0x2cb9,{0x4665,0x83,0x60,0xdd,0xcf,0x60,0x54,0xf7,0x9d}}\r
\r
typedef enum {\r
  ///\r
  /// The PCI bus driver is requested to create handles for the specified devices. An array of\r
  /// EFI_HANDLE is returned, a NULL element marks the end of the array.\r
  ///\r
  EfiPciHotPlugRequestAdd,\r
\r
  ///\r
  /// The PCI bus driver is requested to destroy handles for the specified devices.\r
  ///\r
  EfiPciHotplugRequestRemove\r
} EFI_PCI_HOTPLUG_OPERATION;\r
\r
typedef struct _EFI_PCI_HOTPLUG_REQUEST_PROTOCOL  EFI_PCI_HOTPLUG_REQUEST_PROTOCOL;\r
\r
/**\r
  This function allows the PCI bus driver to be notified to act as requested when a hot-plug event has\r
  happened on the hot-plug controller. Currently, the operations include add operation and remove operation..\r
  \r
  @param This                 A pointer to the hot plug request protocol.\r
  @param Operation            The operation the PCI bus driver is requested to make.\r
  @param Controller           The handle of the hot-plug controller.\r
  @param RemainingDevicePath  The remaining device path for the PCI-like hot-plug device.\r
  @param NumberOfChildren     The number of child handles. \r
                              For a add operation, it is an output parameter. \r
Commit	Line	Data
	1	/** @file\r
	2	Provides services to notify PCI bus driver that some events have happened in a hot-plug controller\r
	3	(for example, PC Card socket, or PHPC), and ask PCI bus driver to create or destroy handles for the\r
	4	PCI-like devices.\r
	5	\r
	6	Copyright (c) 2006 - 2009, Intel Corporation \r
	7	All rights reserved. This program and the accompanying materials \r
	8	are licensed and made available under the terms and conditions of the BSD License \r
	9	which accompanies this distribution. The full text of the license may be found at \r
	10	http://opensource.org/licenses/bsd-license.php \r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	14	\r
	15	**/\r
	16	\r
	17	#ifndef __PCI_HOTPLUG_REQUEST_H_\r
	18	#define __PCI_HOTPLUG_REQUEST_H_\r
	19	\r
	20	#define EFI_PCI_HOTPLUG_REQUEST_PROTOCOL_GUID \\r
	21	{0x19cb87ab,0x2cb9,{0x4665,0x83,0x60,0xdd,0xcf,0x60,0x54,0xf7,0x9d}}\r
	22	\r
	23	typedef enum {\r
	24	///\r
	25	/// The PCI bus driver is requested to create handles for the specified devices. An array of\r
	26	/// EFI_HANDLE is returned, a NULL element marks the end of the array.\r
	27	///\r
	28	EfiPciHotPlugRequestAdd,\r
	29	\r
	30	///\r
	31	/// The PCI bus driver is requested to destroy handles for the specified devices.\r
	32	///\r
	33	EfiPciHotplugRequestRemove\r
	34	} EFI_PCI_HOTPLUG_OPERATION;\r
	35	\r
	36	typedef struct _EFI_PCI_HOTPLUG_REQUEST_PROTOCOL EFI_PCI_HOTPLUG_REQUEST_PROTOCOL;\r
	37	\r
	38	/**\r
	39	This function allows the PCI bus driver to be notified to act as requested when a hot-plug event has\r
	40	happened on the hot-plug controller. Currently, the operations include add operation and remove operation..\r
	41	\r
	42	@param This A pointer to the hot plug request protocol.\r
	43	@param Operation The operation the PCI bus driver is requested to make.\r
	44	@param Controller The handle of the hot-plug controller.\r
	45	@param RemainingDevicePath The remaining device path for the PCI-like hot-plug device.\r
	46	@param NumberOfChildren The number of child handles. \r
	47	For a add operation, it is an output parameter. \r
	48