update the file header/function comments of DiskInfo/PciHotPlugRequest protocols...
authoreric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 9 Jul 2009 09:31:41 +0000 (09:31 +0000)
committereric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 9 Jul 2009 09:31:41 +0000 (09:31 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8836 6f19259b-4bc3-4df7-8a09-765794883524

IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h
IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h

index 833072fc894bc323cbbd8372d09ddd065ff1086d..7f82a40aff61de256210969c602d4e81386fe7f5 100644 (file)
@@ -30,7 +30,7 @@ typedef struct _EFI_DISK_INFO_PROTOCOL  EFI_DISK_INFO_PROTOCOL;
   This function is used by the IDE bus driver to get inquiry data. \r
   Data format of Identify data is defined by the Interface GUID.\r
 \r
-  @param  This                  Protocol instance pointer. \r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
   @param  InquiryData           Pointer to a buffer for the inquiry data.\r
   @param  InquiryDataSize       Pointer to the value for the inquiry data size.\r
 \r
@@ -43,7 +43,7 @@ typedef struct _EFI_DISK_INFO_PROTOCOL  EFI_DISK_INFO_PROTOCOL;
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_DISK_INFO_INQUIRY)(\r
-  IN EFI_DISK_INFO_PROTOCOL           * This,\r
+  IN EFI_DISK_INFO_PROTOCOL           *This,\r
   IN OUT VOID                         *InquiryData,\r
   IN OUT UINT32                       *InquiryDataSize\r
   );\r
@@ -53,7 +53,7 @@ EFI_STATUS
   This function is used by the IDE bus driver to get identify data. \r
   Data format of Identify data is defined by the Interface GUID.\r
 \r
-  @param  This                  Protocol instance pointer. \r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
   @param  IdentifyData          Pointer to a buffer for the identify data.\r
   @param  IdentifyDataSize      Pointer to the value for the identify data size.\r
 \r
@@ -66,7 +66,7 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_DISK_INFO_IDENTIFY)(\r
-  IN EFI_DISK_INFO_PROTOCOL           * This,\r
+  IN EFI_DISK_INFO_PROTOCOL           *This,\r
   IN OUT VOID                         *IdentifyData,\r
   IN OUT UINT32                       *IdentifyDataSize\r
   );\r
@@ -76,7 +76,7 @@ EFI_STATUS
   This function is used by the IDE bus driver to get sense data. \r
   Data format of Sense data is defined by the Interface GUID.\r
 \r
-  @param  This                  Protocol instance pointer\r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance\r
   @param  SenseData             Pointer to the SenseData. \r
   @param  SenseDataSize         Size of SenseData in bytes. \r
   @param  SenseDataNumber       Pointer to the value for the identify data size.\r
@@ -90,7 +90,7 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_DISK_INFO_SENSE_DATA)(\r
-  IN EFI_DISK_INFO_PROTOCOL           * This,\r
+  IN EFI_DISK_INFO_PROTOCOL           *This,\r
   IN OUT VOID                         *SenseData,\r
   IN OUT UINT32                       *SenseDataSize,\r
   OUT UINT8                           *SenseDataNumber\r
@@ -99,7 +99,7 @@ EFI_STATUS
 /**\r
   This function is used by the IDE bus driver to get controller information.\r
 \r
-  @param  This                  Protocol instance pointer\r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance\r
   @param  IdeChannel            Pointer to the Ide Channel number. Primary or secondary.\r
   @param  IdeDevice             Pointer to the Ide Device number. Master or slave.\r
 \r
@@ -110,7 +110,7 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_DISK_INFO_WHICH_IDE)(\r
-  IN EFI_DISK_INFO_PROTOCOL           * This,\r
+  IN EFI_DISK_INFO_PROTOCOL           *This,\r
   OUT UINT32                          *IdeChannel,\r
   OUT UINT32                          *IdeDevice\r
   );\r
index 89cca7be2eced0a0f253289882a4fea1903369de..d4a36aea0e2463862e217e13f2f4abfa2aff8a1c 100644 (file)
@@ -18,7 +18,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __PCI_HOTPLUG_REQUEST_H_\r
 \r
 #define EFI_PCI_HOTPLUG_REQUEST_PROTOCOL_GUID \\r
-  {0x19cb87ab,0x2cb9,{0x4665,0x83,0x60,0xdd,0xcf,0x60,0x54,0xf7,0x9d}}\r
+  {\r
+    0x19cb87ab, 0x2cb9, 0x4665, {0x83, 0x60, 0xdd, 0xcf, 0x60, 0x54, 0xf7, 0x9d} \\r
+  }\r
 \r
 typedef enum {\r
   ///\r
@@ -37,26 +39,32 @@ typedef struct _EFI_PCI_HOTPLUG_REQUEST_PROTOCOL  EFI_PCI_HOTPLUG_REQUEST_PROTOC
 \r
 /**\r
   This function allows the PCI bus driver to be notified to act as requested when a hot-plug event has\r
-  happened on the hot-plug controller. Currently, the operations include add operation and remove operation..\r
+  happened on the hot-plug controller. Currently, the operations include add operation and remove operation.\r
   \r
-  @param This                 A pointer to the hot plug request protocol.\r
-  @param Operation            The operation the PCI bus driver is requested to make.\r
-  @param Controller           The handle of the hot-plug controller.\r
-  @param RemainingDevicePath  The remaining device path for the PCI-like hot-plug device.\r
-  @param NumberOfChildren     The number of child handles. \r
-                              For a add operation, it is an output parameter. \r
-                              For a remove operation, it¡¯s an input parameter.\r
-  @param ChildHandleBuffer    The buffer which contains the child handles.\r
+  @param This                    A pointer to the hot plug request protocol.\r
+  @param Operation               The operation the PCI bus driver is requested to make.\r
+  @param Controller              The handle of the hot-plug controller.\r
+  @param RemainingDevicePath     The remaining device path for the PCI-like hot-plug device.\r
+  @param NumberOfChildren        The number of child handles. For a add operation, it is an output parameter. \r
+                                 For a remove operation, it's an input parameter. When it contains a non-zero\r
+                                 value, children handles specified in ChildHandleBuffer are destroyed. Otherwise,\r
+                                 PCI bus driver is notified to stop managing the controller handle.\r
+  @param ChildHandleBuffer       The buffer which contains the child handles. For a add operation, it is an output \r
+                                 parameter and contains all newly created child handles. For a remove operation, it \r
+                                 contains child handles to be destroyed when NumberOfChildren contains a non-\r
+                                 zero value. It can be NULL when NumberOfChildren is 0. It's the caller's \r
+                                 responsibility to allocate and free memory for this buffer.\r
   \r
-  @retval EFI_INVALID_PARAMETER  Operation is not a legal value.\r
-                                 Controller is NULL or not a valid handle.\r
-                                 NumberOfChildren is NULL.\r
-                                 ChildHandleBuffer is NULL while Operation is add.\r
-  @retval EFI_OUT_OF_RESOURCES   There are no enough resources to start the devices.\r
-  @retval EFI_NOT_FOUND          Can not find bridge according to controller handle.\r
   @retval EFI_SUCCESS            The handles for the specified device have been created or destroyed\r
                                  as requested, and for an add operation, the new handles are\r
                                  returned in ChildHandleBuffer.\r
+  @retval EFI_INVALID_PARAMETER  Operation is not a legal value.\r
+  @retval EFI_INVALID_PARAMETER  Controller is NULL or not a valid handle.\r
+  @retval EFI_INVALID_PARAMETER  NumberOfChildren is NULL.\r
+  @retval EFI_INVALID_PARAMETER  ChildHandleBuffer is NULL while Operation is remove and \r
+                                 NumberOfChildren contains a non-zero value.\r
+  @retval EFI_INVALID_PARAMETER  ChildHandleBuffer is NULL while Operation is add.\r
+  @retval EFI_OUT_OF_RESOURCES   There are no enough resources to start the devices.\r
 **/\r
 typedef\r
 EFI_STATUS\r