Add description for the added BootState guid.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10220 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/EdkCompatibilityPkg/Compatibility/Include/Guid/BootState.h b/EdkCompatibilityPkg/Compatibility/Include/Guid/BootState.h
index fef191b22e86777b274811f4b9c95a8caf2ba03c..8211328443bfadc7fb5267240753af6290b1bb59 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/Include/Guid/BootState.h
+++ b/EdkCompatibilityPkg/Compatibility/Include/Guid/BootState.h
@@ -1,6 +1,12 @@
 /** @file\r
-  GUID for use conveying the boot-state to PEI.\r
+  GUID and Name is used to configure PcdBootState to DynamicHii PCD, which can\r
+  make EDKII core work with EDK implementation.\r
 \r
+  EDK implementation may depend on this guid variable to check boot state. But \r
+  EDKII core uses the dynamic PcdBootState to save boot state. To be compatible to EDK implementation, \r
+  BootStateGuid and BootStateName will be used to configure PcdBootState to DynamicHii PCD to\r
+  save boot state as variable.\r
+  \r
   Copyright (c) 2010, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
@@ -14,6 +20,8 @@
 #ifndef _BOOT_STATE_H_\r
 #define _BOOT_STATE_H_\r
 \r
+#define BOOT_STATE_VARIABLE_NAME  L"BootState"\r
+\r
 #define  EFI_BOOT_STATE_VARIABLE_GUID  \\r
   { 0x60b5e939, 0xfcf, 0x4227, { 0xba, 0x83, 0x6b, 0xbe, 0xd4, 0x5b, 0xc0, 0xe3 } }\r
 \r