update the file header/function comments of DiskInfo/PciHotPlugRequest protocols to align with PI1.2 spec volume 5
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8836 6f19259b-4bc3-4df7-8a09-765794883524
diff --git a/IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h b/IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h
index 833072f..7f82a40 100644
--- a/IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h
@@ -30,7 +30,7 @@
This function is used by the IDE bus driver to get inquiry data.
Data format of Identify data is defined by the Interface GUID.
- @param This Protocol instance pointer.
+ @param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
@param InquiryData Pointer to a buffer for the inquiry data.
@param InquiryDataSize Pointer to the value for the inquiry data size.
@@ -43,7 +43,7 @@
typedef
EFI_STATUS
(EFIAPI *EFI_DISK_INFO_INQUIRY)(
- IN EFI_DISK_INFO_PROTOCOL * This,
+ IN EFI_DISK_INFO_PROTOCOL *This,
IN OUT VOID *InquiryData,
IN OUT UINT32 *InquiryDataSize
);
@@ -53,7 +53,7 @@
This function is used by the IDE bus driver to get identify data.
Data format of Identify data is defined by the Interface GUID.
- @param This Protocol instance pointer.
+ @param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
@param IdentifyData Pointer to a buffer for the identify data.
@param IdentifyDataSize Pointer to the value for the identify data size.
@@ -66,7 +66,7 @@
typedef
EFI_STATUS
(EFIAPI *EFI_DISK_INFO_IDENTIFY)(
- IN EFI_DISK_INFO_PROTOCOL * This,
+ IN EFI_DISK_INFO_PROTOCOL *This,
IN OUT VOID *IdentifyData,
IN OUT UINT32 *IdentifyDataSize
);
@@ -76,7 +76,7 @@
This function is used by the IDE bus driver to get sense data.
Data format of Sense data is defined by the Interface GUID.
- @param This Protocol instance pointer.
+ @param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
@param SenseData Pointer to the SenseData.
@param SenseDataSize Size of SenseData in bytes.
@param SenseDataNumber Pointer to the value for the identify data size.
@@ -90,7 +90,7 @@
typedef
EFI_STATUS
(EFIAPI *EFI_DISK_INFO_SENSE_DATA)(
- IN EFI_DISK_INFO_PROTOCOL * This,
+ IN EFI_DISK_INFO_PROTOCOL *This,
IN OUT VOID *SenseData,
IN OUT UINT32 *SenseDataSize,
OUT UINT8 *SenseDataNumber
@@ -99,7 +99,7 @@
/**
This function is used by the IDE bus driver to get controller information.
- @param This Protocol instance pointer.
+ @param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
@param IdeChannel Pointer to the Ide Channel number. Primary or secondary.
@param IdeDevice Pointer to the Ide Device number. Master or slave.
@@ -110,7 +110,7 @@
typedef
EFI_STATUS
(EFIAPI *EFI_DISK_INFO_WHICH_IDE)(
- IN EFI_DISK_INFO_PROTOCOL * This,
+ IN EFI_DISK_INFO_PROTOCOL *This,
OUT UINT32 *IdeChannel,
OUT UINT32 *IdeDevice
);
diff --git a/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h b/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h
index 89cca7b..d4a36ae 100644
--- a/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h
@@ -18,7 +18,9 @@
#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 @@
/**
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