Add more comments for IntelFramework's header files.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
index 7ed3217134e5f19f568e8ea3387cdd954a9ed9be..2139d158bf1847c5189cf0092cf3e7ad2b068056 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