]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h
Add comments for Include header files
[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / PciHotPlugRequest.h
CommitLineData
8ca67c46 1/** @file\r
f4671790 2 This protocol is used to add or remove all PCI child devices on the PCI root bridge.\r
a9102619 3\r
f4671790 4Copyright (c) 2006 - 2009, Intel Corporation \r
a9102619 5All rights reserved. This program and the accompanying materials \r
6are licensed and made available under the terms and conditions of the BSD License \r
7which accompanies this distribution. The full text of the license may be found at \r
8http://opensource.org/licenses/bsd-license.php \r
9 \r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
12\r
3db51098 13**/\r
a9102619 14\r
15#ifndef __PCI_HOTPLUG_REQUEST_H_\r
16#define __PCI_HOTPLUG_REQUEST_H_\r
17\r
18#define EFI_PCI_HOTPLUG_REQUEST_PROTOCOL_GUID \\r
19{0x19cb87ab,0x2cb9,{0x4665,0x83,0x60,0xdd,0xcf,0x60,0x54,0xf7,0x9d}}\r
20\r
21typedef enum {\r
22 EfiPciHotPlugRequestAdd,\r
23 EfiPciHotplugRequestRemove\r
24} EFI_PCI_HOTPLUG_OPERATION;\r
25\r
26typedef struct _EFI_PCI_HOTPLUG_REQUEST_PROTOCOL EFI_PCI_HOTPLUG_REQUEST_PROTOCOL;\r
27\r
f4671790
LG
28/**\r
29 Hot plug request notify.\r
30 \r
31 @param This A pointer to the hot plug request protocol.\r
32 @param Operation The operation.\r
33 @param Controller A pointer to the controller.\r
34 @param RemainingDevicePath A pointer to the device path.\r
35 @param NumberOfChildren A the number of child handle in the ChildHandleBuffer.\r
36 @param ChildHandleBuffer A pointer to the array contain the child handle.\r
37 \r
38 @retval EFI_NOT_FOUND Can not find bridge according to controller handle.\r
39 @retval EFI_SUCCESS Success operating.\r
40**/\r
a9102619 41typedef\r
42EFI_STATUS\r
43(EFIAPI *EFI_PCI_HOTPLUG_REQUEST_NOTIFY) (\r
44 IN EFI_PCI_HOTPLUG_REQUEST_PROTOCOL *This,\r
45 IN EFI_PCI_HOTPLUG_OPERATION Operation,\r
46 IN EFI_HANDLE Controller,\r
47 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL,\r
48 IN OUT UINT8 *NumberOfChildren,\r
49 IN OUT EFI_HANDLE *ChildHandleBuffer\r
50);\r
51\r
52\r
53\r
54struct _EFI_PCI_HOTPLUG_REQUEST_PROTOCOL {\r
55 EFI_PCI_HOTPLUG_REQUEST_NOTIFY Notify;\r
56};\r
57\r
58extern EFI_GUID gEfiPciHotPlugRequestProtocolGuid;\r
59\r
60#endif\r