]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h
Add comments for IntelFrameworkModulePkg Header file.
[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / PciHotPlugRequest.h
CommitLineData
8ca67c46 1/** @file\r
20774adc
LG
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
a9102619 5\r
f4671790 6Copyright (c) 2006 - 2009, Intel Corporation \r
a9102619 7All rights reserved. This program and the accompanying materials \r
8are licensed and made available under the terms and conditions of the BSD License \r
9which accompanies this distribution. The full text of the license may be found at \r
10http://opensource.org/licenses/bsd-license.php \r
11 \r
12THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
13WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
14\r
3db51098 15**/\r
a9102619 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
20774adc 21 {0x19cb87ab,0x2cb9,{0x4665,0x83,0x60,0xdd,0xcf,0x60,0x54,0xf7,0x9d}}\r
a9102619 22\r
23typedef enum {\r
20774adc
LG
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
a9102619 28 EfiPciHotPlugRequestAdd,\r
20774adc
LG
29\r
30 ///\r
31 /// The PCI bus driver is requested to destroy handles for the specified devices.\r
32 ///\r
a9102619 33 EfiPciHotplugRequestRemove\r
34} EFI_PCI_HOTPLUG_OPERATION;\r
35\r
36typedef struct _EFI_PCI_HOTPLUG_REQUEST_PROTOCOL EFI_PCI_HOTPLUG_REQUEST_PROTOCOL;\r
37\r
f4671790 38/**\r
20774adc
LG
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
f4671790
LG
41 \r
42 @param This A pointer to the hot plug request protocol.\r
20774adc
LG
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