diff options
Diffstat (limited to 'IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h')
| -rw-r--r-- | IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h | 40 |
1 files changed, 24 insertions, 16 deletions
diff --git a/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h b/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h index 89cca7be2e..d4a36aea0e 100644 --- a/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h +++ b/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h @@ -18,7 +18,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define __PCI_HOTPLUG_REQUEST_H_
#define EFI_PCI_HOTPLUG_REQUEST_PROTOCOL_GUID \
- {0x19cb87ab,0x2cb9,{0x4665,0x83,0x60,0xdd,0xcf,0x60,0x54,0xf7,0x9d}}
+ {
+ 0x19cb87ab, 0x2cb9, 0x4665, {0x83, 0x60, 0xdd, 0xcf, 0x60, 0x54, 0xf7, 0x9d} \
+ }
typedef enum {
///
@@ -37,26 +39,32 @@ typedef struct _EFI_PCI_HOTPLUG_REQUEST_PROTOCOL EFI_PCI_HOTPLUG_REQUEST_PROTOC /**
This function allows the PCI bus driver to be notified to act as requested when a hot-plug event has
- happened on the hot-plug controller. Currently, the operations include add operation and remove operation..
+ happened on the hot-plug controller. Currently, the operations include add operation and remove operation.
- @param This A pointer to the hot plug request protocol.
- @param Operation The operation the PCI bus driver is requested to make.
- @param Controller The handle of the hot-plug controller.
- @param RemainingDevicePath The remaining device path for the PCI-like hot-plug device.
- @param NumberOfChildren The number of child handles.
- For a add operation, it is an output parameter.
- For a remove operation, it¡¯s an input parameter.
- @param ChildHandleBuffer The buffer which contains the child handles.
+ @param This A pointer to the hot plug request protocol.
+ @param Operation The operation the PCI bus driver is requested to make.
+ @param Controller The handle of the hot-plug controller.
+ @param RemainingDevicePath The remaining device path for the PCI-like hot-plug device.
+ @param NumberOfChildren The number of child handles. For a add operation, it is an output parameter.
+ For a remove operation, it's an input parameter. When it contains a non-zero
+ value, children handles specified in ChildHandleBuffer are destroyed. Otherwise,
+ PCI bus driver is notified to stop managing the controller handle.
+ @param ChildHandleBuffer The buffer which contains the child handles. For a add operation, it is an output
+ parameter and contains all newly created child handles. For a remove operation, it
+ contains child handles to be destroyed when NumberOfChildren contains a non-
+ zero value. It can be NULL when NumberOfChildren is 0. It's the caller's
+ responsibility to allocate and free memory for this buffer.
- @retval EFI_INVALID_PARAMETER Operation is not a legal value.
- Controller is NULL or not a valid handle.
- NumberOfChildren is NULL.
- ChildHandleBuffer is NULL while Operation is add.
- @retval EFI_OUT_OF_RESOURCES There are no enough resources to start the devices.
- @retval EFI_NOT_FOUND Can not find bridge according to controller handle.
@retval EFI_SUCCESS The handles for the specified device have been created or destroyed
as requested, and for an add operation, the new handles are
returned in ChildHandleBuffer.
+ @retval EFI_INVALID_PARAMETER Operation is not a legal value.
+ @retval EFI_INVALID_PARAMETER Controller is NULL or not a valid handle.
+ @retval EFI_INVALID_PARAMETER NumberOfChildren is NULL.
+ @retval EFI_INVALID_PARAMETER ChildHandleBuffer is NULL while Operation is remove and
+ NumberOfChildren contains a non-zero value.
+ @retval EFI_INVALID_PARAMETER ChildHandleBuffer is NULL while Operation is add.
+ @retval EFI_OUT_OF_RESOURCES There are no enough resources to start the devices.
**/
typedef
EFI_STATUS
|