sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add comments for IntelFrameworkModulePkg Header file.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8539 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgao4
2009-06-12 09:02:15 +00:00
parent f423cbf1e9
commit 20774adc0f
4 changed files with 98 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h
View File

@ -1,5 +1,7 @@
/** @file
This protocol is used to add or remove all PCI child devices on the PCI root bridge.
Provides services to notify PCI bus driver that some events have happened in a hot-plug controller
(for example, PC Card socket, or PHPC), and ask PCI bus driver to create or destroy handles for the
PCI-like devices.
Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
@ -16,27 +18,45 @@ 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 {
///
/// The PCI bus driver is requested to create handles for the specified devices. An array of
/// EFI_HANDLE is returned, a NULL element marks the end of the array.
///
EfiPciHotPlugRequestAdd,
///
/// The PCI bus driver is requested to destroy handles for the specified devices.
///
EfiPciHotplugRequestRemove
} EFI_PCI_HOTPLUG_OPERATION;
typedef struct _EFI_PCI_HOTPLUG_REQUEST_PROTOCOL EFI_PCI_HOTPLUG_REQUEST_PROTOCOL;
/**
Hot plug request notify.
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..
@param This A pointer to the hot plug request protocol.
@param Operation The operation.
@param Controller A pointer to the controller.
@param RemainingDevicePath A pointer to the device path.
@param NumberOfChildren A the number of child handle in the ChildHandleBuffer.
@param ChildHandleBuffer A pointer to the array contain the child handle.
@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<69><74>s an input parameter.
@param ChildHandleBuffer The buffer which contains the child handles.
@retval EFI_NOT_FOUND Can not find bridge according to controller handle.
@retval EFI_SUCCESS Success operating.
@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.
**/
typedef
EFI_STATUS