From 3f17e6d73ed65485258eebb69ca2ab5fe292eba9 Mon Sep 17 00:00:00 2001
From: lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Wed, 8 Jul 2009 03:41:46 +0000
Subject: [PATCH] Add comments for the inconsistent definition with framework
 specification.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8798 6f19259b-4bc3-4df7-8a09-765794883524
---
 IntelFrameworkPkg/Include/Ppi/FindFv.h        |  4 +++
 .../Include/Ppi/RecoveryModule.h              |  4 +++
 .../Include/Protocol/FrameworkFormCallback.h  | 33 ++++++++++++++++++-
 3 files changed, 40 insertions(+), 1 deletion(-)

diff --git a/IntelFrameworkPkg/Include/Ppi/FindFv.h b/IntelFrameworkPkg/Include/Ppi/FindFv.h
index 4af010bdc9..f36580ed00 100644
--- a/IntelFrameworkPkg/Include/Ppi/FindFv.h
+++ b/IntelFrameworkPkg/Include/Ppi/FindFv.h
@@ -23,6 +23,10 @@
 
 #include <PiPei.h>
 
+///
+///  Inconsistent with specification here: 
+///  GUID value format has been changed to the standard guid format.
+///
 #define EFI_PEI_FIND_FV_PPI_GUID \
   { \
     0x36164812, 0xa023, 0x44e5, {0xbd, 0x85, 0x5, 0xbf, 0x3c, 0x77, 0x0, 0xaa } \
diff --git a/IntelFrameworkPkg/Include/Ppi/RecoveryModule.h b/IntelFrameworkPkg/Include/Ppi/RecoveryModule.h
index f4c7467fdd..7c993d494d 100644
--- a/IntelFrameworkPkg/Include/Ppi/RecoveryModule.h
+++ b/IntelFrameworkPkg/Include/Ppi/RecoveryModule.h
@@ -24,6 +24,10 @@
 
 #include <PiPei.h>
 
+///
+///  Inconsistent with specification here: 
+///  GUID marco name has been changed to the consistent PPI GUID macro name.
+///
 #define EFI_PEI_RECOVERY_MODULE_PPI_GUID \
   { \
     0xFB6D9542, 0x612D, 0x4f45, {0x87, 0x2F, 0x5C, 0xFF, 0x52, 0xE9, 0x3D, 0xCF } \
diff --git a/IntelFrameworkPkg/Include/Protocol/FrameworkFormCallback.h b/IntelFrameworkPkg/Include/Protocol/FrameworkFormCallback.h
index 77a096df63..575d0f6183 100644
--- a/IntelFrameworkPkg/Include/Protocol/FrameworkFormCallback.h
+++ b/IntelFrameworkPkg/Include/Protocol/FrameworkFormCallback.h
@@ -37,6 +37,34 @@
 //
 typedef struct _EFI_FORM_CALLBACK_PROTOCOL  EFI_FORM_CALLBACK_PROTOCOL;
 
+///
+///  Inconsistent with specification here: 
+///  EFI_IFR_DATA_ENTRY RESET_REQUIRED, EXIT_REQUIRED, SAVE_REQUIRED, NV_CHANGED 
+//// and NV_NOT_CHANGED are not defined in HII specification. These Flags of EFI_IFR_DATA_ENTRY 
+///  should be defined to describe the standard behavior of the browser after the callback.
+///
+
+///
+/// If this flag is set, the browser will exit and reset after processing callback results
+///
+#define RESET_REQUIRED  1 
+///
+/// If this flag is set, the browser will exit after processing callback results
+///
+#define EXIT_REQUIRED   2
+///
+/// If this flag is set, the browser will save the NV data after processing callback results
+///
+#define SAVE_REQUIRED   4
+///
+/// If this flag is set, the browser will turn the NV flag on after processing callback results
+///
+#define NV_CHANGED      8
+///
+/// If this flag is set, the browser will turn the NV flag off after processing callback results
+///
+#define NV_NOT_CHANGED  16
+
 #pragma pack(1)
 typedef struct {
   UINT8   OpCode;           ///< Likely a string, numeric, or one-of
@@ -122,6 +150,9 @@ EFI_STATUS
                                 name of the vendor's variable. Each VariableName is unique for each VendorGuid.
   @param  VendorGuid            A unique identifier for the vendor.
   @param  Attributes            Attributes bit-mask to set for the variable.
+                                Inconsistent with specification here: 
+                                Attributes data type has been changed from UINT32 * to UINT32,
+                                because the input paramter is not necessary to use pointer date type.
   @param  DataSize              The size in bytes of the Buffer. A size of zero causes
                                 the variable to be deleted.
   @param  Buffer                The buffer containing the contents of the variable.
@@ -177,7 +208,7 @@ EFI_STATUS
 /**
   The EFI_FORM_CALLBACK_PROTOCOL is the defined interface for access to
   custom NVS devices as well as communication of user selections in a more
-  interactive environment. This protocol should be published by hardware-specific
+  interactive environment. This protocol should be published by platform-specific
   drivers that want to export access to custom hardware storage or publish IFR
   that has a requirement to call back the original driver.
 **/
-- 
2.39.2