Update comment in SMM Library class include file.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
index 7ed3217134e5f19f568e8ea3387cdd954a9ed9be..74d12595c89f64f5c69351a2cdd3e5ec492a4461 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
+++ b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
@@ -1,5 +1,12 @@
 /** @file\r
   This file declares Device Recovery Module PPI.\r
+  The interface of this PPI does the following:\r
+    - Reports the number of recovery DXE capsules that exist on the associated device(s)\r
+    - Finds the requested firmware binary capsule\r
+    - Loads that capsule into memory\r
+  A device can be either a group of devices, such as a block device, or an individual device.T he\r
+  module determines the internal search order, with capsule number 1 as the highest load priority and\r
+  number N as the lowest priority.\r
 \r
   Copyright (c) 2007, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
@@ -49,7 +56,7 @@ typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODUL
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE) (\r
+(EFIAPI *EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE)(\r
   IN EFI_PEI_SERVICES                               **PeiServices,\r
   IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI             *This,\r
   OUT UINTN                                         *NumberRecoveryCapsules\r
@@ -73,7 +80,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO) (\r
+(EFIAPI *EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO)(\r
   IN  EFI_PEI_SERVICES                              **PeiServices,\r
   IN  EFI_PEI_DEVICE_RECOVERY_MODULE_PPI            *This,\r
   IN  UINTN                                         CapsuleInstance,\r
@@ -98,7 +105,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE) (\r
+(EFIAPI *EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE)(\r
   IN OUT EFI_PEI_SERVICES                         **PeiServices,\r
   IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI           *This,\r
   IN UINTN                                        CapsuleInstance,\r