Refine include file for Device Recovery Module PPI.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / DeviceRecoveryModule.h

diff --git a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
index 6dd525a859449022a1d4d120534d4ff32401ecb2..1c75509a7d5083f25e7aaad79282efdaca66a5e3 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
+++ b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
@@ -36,15 +36,17 @@
 typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODULE_PPI;\r
 \r
 /**\r
+  Returns the number of DXE capsules residing on the device.\r
+\r
   This function searches for DXE capsules from the associated device and returns the number\r
   and maximum size in bytes of the capsules discovered. Entry 1 is assumed to be the\r
   highest load priority and entry N is assumed to be the lowest priority.\r
 \r
-  @param  PeiServices            General-purpose services that are available to every PEIM\r
-  @param  This                   Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
-  @param  NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output,\r
-                                 *NumberRecoveryCapsules contains the number of recovery capsule\r
-                                 images available for retrieval from this PEIM instance.\r
+  @param[in]  PeiServices            General-purpose services that are available to every PEIM\r
+  @param[in]  This                   Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
+  @param[out] NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output,\r
+                                     *NumberRecoveryCapsules contains the number of recovery capsule\r
+                                     images available for retrieval from this PEIM instance.\r
 \r
   @retval EFI_SUCCESS           One or more capsules were discovered.\r
   @retval EFI_DEVICE_ERROR      A device error occurred.\r
@@ -60,15 +62,19 @@ EFI_STATUS
   );\r
 \r
 /**\r
+  Returns the size and type of the requested recovery capsule.\r
+\r
   This function gets the size and type of the requested recovery capsule.\r
 \r
-  @param  PeiServices     General-purpose services that are available to every PEIM\r
-  @param  This            Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
-  @param  CapsuleInstance Specifies for which capsule instance to retrieve the information.\r
-  @param  Size            A pointer to a caller-allocated UINTN in which the size of\r
-                          the requested recovery module is returned.\r
-  @param  CapsuleType     A pointer to a caller-allocated EFI_GUID in\r
-                          which the type of the requested recovery capsule is returned.\r
+  @param[in]  PeiServices     General-purpose services that are available to every PEIM\r
+  @param[in]  This            Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
+  @param[in]  CapsuleInstance Specifies for which capsule instance to retrieve the information.\r
+                              This parameter must be between one and the value returned by\r
+                              GetNumberRecoveryCapsules() in NumberRecoveryCapsules.\r
+  @param[out] Size            A pointer to a caller-allocated UINTN in which the size of\r
+                              the requested recovery module is returned.\r
+  @param[out] CapsuleType     A pointer to a caller-allocated EFI_GUID in\r
+                              which the type of the requested recovery capsule is returned.\r
 \r
   @retval EFI_SUCCESS           One or more capsules were discovered.\r
   @retval EFI_DEVICE_ERROR      A device error occurred.\r
@@ -86,14 +92,16 @@ EFI_STATUS
   );\r
 \r
 /**\r
+  Loads a DXE capsule from some media into memory.\r
+\r
   This function retrieves a DXE capsule from some device and loads it into memory.\r
   Note that the published interface is device neutral.\r
 \r
-  @param  PeiServices     General-purpose services that are available to every PEIM\r
-  @param  This            Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
-  @param  CapsuleInstance Specifies which capsule instance to retrieve.\r
-  @param  Buffer          Specifies a caller-allocated buffer in which the requested\r
-                          recovery capsule will be returned.\r
+  @param[in, out] PeiServices     General-purpose services that are available to every PEIM\r
+  @param[in]      This            Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
+  @param[in]      CapsuleInstance Specifies which capsule instance to retrieve.\r
+  @param[out]     Buffer          Specifies a caller-allocated buffer in which the requested\r
+                                  recovery capsule will be returned.\r
 \r
   @retval EFI_SUCCESS           One or more capsules were discovered.\r
   @retval EFI_DEVICE_ERROR      A device error occurred.\r
@@ -114,19 +122,8 @@ EFI_STATUS
 /// regardless of the underlying device(s).\r
 ///\r
 struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI {\r
-  ///\r
-  /// Returns the number of DXE capsules that were found.\r
-  ///\r
   EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE  GetNumberRecoveryCapsules;\r
-  \r
-  ///\r
-  /// Returns the capsule image type and the size of a given image.\r
-  ///\r
   EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO    GetRecoveryCapsuleInfo;\r
-  \r
-  ///\r
-  /// Loads a DXE capsule into memory\r
-  ///\r
   EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE        LoadRecoveryCapsule;\r
 };\r
 \r