QuarkPlatformPkg/Readme: add capsule/recovery related content.

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Kelly Steele <kelly.steele@intel.com>
Cc: Feng Tian <feng.tian@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Chao Zhang <chao.b.zhang@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiewen Yao <jiewen.yao@intel.com>
Reviewed-by: Michael Kinney <michael.d.kinney@intel.com>
Tested-by: Michael Kinney <michael.d.kinney@intel.com>

diff --git a/QuarkPlatformPkg/Readme.md b/QuarkPlatformPkg/Readme.md
index 8f5b898b6a112045351fbafdfb50a85a69b98939..f925f9ef2766811fe970bacfe9fa541ab018cdeb 100644 (file)
--- a/QuarkPlatformPkg/Readme.md
+++ b/QuarkPlatformPkg/Readme.md
@@ -146,6 +146,8 @@ features on the build command line using ```-D``` flags.
 | ```SECURE_BOOT_ENABLE```   |             FALSE | TRUE, FALSE          |\r
 | ```MEASURED_BOOT_ENABLE``` |             FALSE | TRUE, FALSE          |\r
 | ```TPM_12_HARDWARE```      |              NONE | NONE, LPC, ATMEL_I2C, INFINEON_I2C |\r
+| ```CAPSULE_ENABLE```       |             FALSE | TRUE, FALSE          |\r
+| ```RECOVERY_ENABLE```      |             FALSE | TRUE, FALSE          |\r
 \r
 * ```GALILEO``` - Used to specify the type of Intel(R) Galileo board type.  The\r
   default is ```GEN2``` for the [Intel(R) Galileo Gen 2 Development Board](\r
@@ -199,6 +201,22 @@ features on the build command line using ```-D``` flags.
   has been tested with the [CryptoShield](https://www.sparkfun.com/products/13183)\r
   available from [SparkFun](https://www.sparkfun.com/).\r
 \r
+* ```CAPSULE_ENABLE``` - Used to enable/disable capsule update features.\r
+  The default is FALSE for disabled.  Add ```-D CAPSULE_ENABLE``` to the\r
+  build command line to enable capsule update features.\r
+  The build process generate capsule update image - QUARKFIRMWAREUPDATECAPSULEFMPPKCS7.Cap.\r
+  The user need copy QUARKFIRMWAREUPDATECAPSULEFMPPKCS7.Cap and CapsuleApp.efi\r
+  to a storage media attached to the Quark Board.\r
+  Then the user can boot to shell and run ```CapsuleApp QUARKFIRMWAREUPDATECAPSULEFMPPKCS7.Cap```.\r
+  In next reboot, the system firmware is updated.\r
+\r
+* ```RECOVERY_ENABLE``` - Used to enable/disable recovery features.\r
+  The default is FALSE for disabled.  Add ```-D RECOVERY_ENABLE``` to the\r
+  build command line to enable recovery features.\r
+  The build process generates the recovery capsule image - QUARKREC.Cap.\r
+  Then the user need copy QUARKREC.Cap to a USB KEY, plug the USB KEY to the Quark Board.\r
+  In next boot, if a user runs ForceRecovery.efi in shell, or if a user presses the RESET button during power on, warm reset or REBOOT,\r
+  or if the FvMain is corrupted in flash, the system will boot into recovery mode.\r
 \r
 ### **Example Build Commands**\r
 \r