1. Add new HII IFR opcode introduced in UEFI2.2 and UEFI2.3

They are EFI_IFR_FORM_MAP, EFI_IFR_READ, EFI_IFR_WRITE,  EFI_IFR_GET, EFI_IFR_SET, EFI_IFR_MAP, EFI_IFR_SECURITY.
2. Add new data type introduced in UEFI2.2 and UEFI2.3
EFI_IFR_TYPE_ACTION, EFI_IFR_TYPE_UNDEFINED, 
EFI_IFR_TYPE_BUFFER.


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

6 files changed, 170 insertions, 9 deletions

diff --git a/MdePkg/Include/Guid/HiiFormMapMethodGuid.h b/MdePkg/Include/Guid/HiiFormMapMethodGuid.h
new file mode 100644
index 0000000000..b298b1bd28
--- /dev/null
+++ b/MdePkg/Include/Guid/HiiFormMapMethodGuid.h
@@ -0,0 +1,25 @@
+/** @file

+  Guid used to identify HII FormMap configuration method.

+

+  Copyright (c) 2009, Intel Corporation                                                         

+  All rights reserved. This program and the accompanying materials                          

+  are licensed and made available under the terms and conditions of the BSD License         

+  which accompanies this distribution.  The full text of the license may be found at        

+  http://opensource.org/licenses/bsd-license.php                                            

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+

+  @par Revision Reference:

+  GUID defined in UEFI 2.2 spec.

+**/

+

+#ifndef __EFI_HII_FORMMAP_GUID_H__

+#define __EFI_HII_FORMMAP_GUID_H__

+

+#define EFI_HII_STANDARD_FORM_GUID \

+  { 0x3bd2f4ec, 0xe524, 0x46e4, { 0xa9, 0xd8, 0x51, 0x1, 0x17, 0x42, 0x55, 0x62 } }

+

+extern EFI_GUID gEfiHiiStandardFormGuid;

+

+#endif

diff --git a/MdePkg/Include/Guid/HiiPlatformSetupFormset.h b/MdePkg/Include/Guid/HiiPlatformSetupFormset.h
index 261756b52b..eed9a85f06 100644
--- a/MdePkg/Include/Guid/HiiPlatformSetupFormset.h
+++ b/MdePkg/Include/Guid/HiiPlatformSetupFormset.h
@@ -22,6 +22,14 @@
 #define EFI_HII_PLATFORM_SETUP_FORMSET_GUID \

   { 0x93039971, 0x8545, 0x4b04, { 0xb4, 0x5e, 0x32, 0xeb, 0x83, 0x26, 0x4, 0xe } }

 

+#define EFI_HII_DRIVER_HEALTH_FORMSET_GUID \

+  { 0xf22fc20c, 0x8cf4, 0x45eb, { 0x8e, 0x6, 0xad, 0x4e, 0x50, 0xb9, 0x5d, 0xd3 } }

+

+#define EFI_HII_USER_CREDENTIAL_FORMSET_GUID \

+  { 0x337f4407, 0x5aee, 0x4b83, { 0xb2, 0xa7, 0x4e, 0xad, 0xca, 0x30, 0x88, 0xcd } }

+

 extern EFI_GUID gEfiHiiPlatformSetupFormsetGuid;

+extern EFI_GUID gEfiHiiDriverHealthFormsetGuid;

+extern EFI_GUID gEfiHiiUserCredentialFormsetGuid;

 

 #endif

diff --git a/MdePkg/Include/Protocol/FormBrowser2.h b/MdePkg/Include/Protocol/FormBrowser2.h
index 9cb3f9657c..4d4d753bff 100644
--- a/MdePkg/Include/Protocol/FormBrowser2.h
+++ b/MdePkg/Include/Protocol/FormBrowser2.h
@@ -18,6 +18,8 @@
 #ifndef __EFI_FORM_BROWSER2_H__

 #define __EFI_FORM_BROWSER2_H__

 

+#include <Guid/HiiPlatformSetupFormset.h>

+

 #define EFI_FORM_BROWSER2_PROTOCOL_GUID \

   {0xb9d4c360, 0xbcfb, 0x4f9b, {0x92, 0x98, 0x53, 0xc1, 0x36, 0x98, 0x22, 0x58 }}

 

diff --git a/MdePkg/Include/Protocol/HiiConfigAccess.h b/MdePkg/Include/Protocol/HiiConfigAccess.h
index 46a4362713..28bacdeb0f 100644
--- a/MdePkg/Include/Protocol/HiiConfigAccess.h
+++ b/MdePkg/Include/Protocol/HiiConfigAccess.h
@@ -29,8 +29,11 @@ typedef struct _EFI_HII_CONFIG_ACCESS_PROTOCOL  EFI_HII_CONFIG_ACCESS_PROTOCOL;
 

 typedef UINTN EFI_BROWSER_ACTION;

 

-#define EFI_BROWSER_ACTION_CHANGING 0

-#define EFI_BROWSER_ACTION_CHANGED  1

+#define EFI_BROWSER_ACTION_CHANGING   0

+#define EFI_BROWSER_ACTION_CHANGED    1

+#define EFI_BROWSER_ACTION_RETRIEVE   2

+#define EFI_BROWSER_ACTION_FORM_OPEN  3

+#define EFI_BROWSER_ACTION_FORM_CLOSE 4

 

 /**

    

@@ -190,12 +193,12 @@ EFI_STATUS
 typedef

 EFI_STATUS

 (EFIAPI *EFI_HII_ACCESS_FORM_CALLBACK)(

-  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,

-  IN  EFI_BROWSER_ACTION                     Action,

-  IN  EFI_QUESTION_ID                        QuestionId,

-  IN  UINT8                                  Type,

-  IN  EFI_IFR_TYPE_VALUE                     *Value,

-  OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest

+  IN     CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,

+  IN     EFI_BROWSER_ACTION                     Action,

+  IN     EFI_QUESTION_ID                        QuestionId,

+  IN     UINT8                                  Type,

+  IN OUT EFI_IFR_TYPE_VALUE                     *Value,

+  OUT    EFI_BROWSER_ACTION_REQUEST             *ActionRequest

   )

   ;

   

diff --git a/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h b/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h
index fd677f7c15..391ea540cf 100644
--- a/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h
+++ b/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h
@@ -20,6 +20,8 @@
 #ifndef __UEFI_INTERNAL_FORMREPRESENTATION_H__

 #define __UEFI_INTERNAL_FORMREPRESENTATION_H__

 

+#include <Guid/HiiFormMapMethodGuid.h>

+

 ///

 /// The following types are currently defined:

 ///

@@ -621,7 +623,8 @@ typedef union {
   BOOLEAN         b;

   EFI_HII_TIME    time;

   EFI_HII_DATE    date;

-  EFI_STRING_ID   string;

+  EFI_STRING_ID   string; ///< EFI_IFR_TYPE_STRING, EFI_IFR_TYPE_ACTION

+  // UINT8 buffer[];      ///< EFI_IFR_TYPE_ORDERED_LIST

 } EFI_IFR_TYPE_VALUE;

 

 //

@@ -659,6 +662,7 @@ typedef union {
 #define EFI_IFR_DISABLE_IF_OP          0x1E

 #define EFI_IFR_TO_LOWER_OP            0x20

 #define EFI_IFR_TO_UPPER_OP            0x21

+#define EFI_IFR_MAP_OP                 0x22

 #define EFI_IFR_ORDERED_LIST_OP        0x23

 #define EFI_IFR_VARSTORE_OP            0x24

 #define EFI_IFR_VARSTORE_NAME_VALUE_OP 0x25

@@ -667,6 +671,10 @@ typedef union {
 #define EFI_IFR_VERSION_OP             0x28

 #define EFI_IFR_END_OP                 0x29

 #define EFI_IFR_MATCH_OP               0x2A

+#define EFI_IFR_SET_OP                 0x2C

+#define EFI_IFR_GET_OP                 0x2B

+#define EFI_IFR_READ_OP                0x2D

+#define EFI_IFR_WRITE_OP               0x2E

 #define EFI_IFR_EQUAL_OP               0x2F

 #define EFI_IFR_NOT_EQUAL_OP           0x30

 #define EFI_IFR_GREATER_THAN_OP        0x31

@@ -713,8 +721,10 @@ typedef union {
 #define EFI_IFR_VALUE_OP               0x5A

 #define EFI_IFR_DEFAULT_OP             0x5B

 #define EFI_IFR_DEFAULTSTORE_OP        0x5C

+#define EFI_IFR_FORM_MAP_OP            0x5D

 #define EFI_IFR_CATENATE_OP            0x5E

 #define EFI_IFR_GUID_OP                0x5F

+#define EFI_IFR_SECURITY_OP            0x60

 

 //

 // Definitions of IFR Standard Headers

@@ -1075,6 +1085,9 @@ typedef struct _EFI_IFR_ONE_OF_OPTION {
 #define EFI_IFR_TYPE_DATE              0x06

 #define EFI_IFR_TYPE_STRING            0x07

 #define EFI_IFR_TYPE_OTHER             0x08

+#define EFI_IFR_TYPE_UNDEFINED         0x09

+#define EFI_IFR_TYPE_ACTION            0x0A

+#define EFI_IFR_TYPE_BUFFER            0x0B

 

 #define EFI_IFR_OPTION_DEFAULT         0x10

 #define EFI_IFR_OPTION_DEFAULT_MFG     0x20

@@ -1362,6 +1375,107 @@ typedef struct _EFI_IFR_SPAN {
   UINT8                    Flags;

 } EFI_IFR_SPAN;

 

+typedef struct _EFI_IFR_SECURITY {

+  ///

+  /// Standard opcode header, where Header.Op = EFI_IFR_SECURITY_OP.

+  ///

+  EFI_IFR_OP_HEADER        Header;

+  ///

+  /// Security permission level.

+  ///

+  EFI_GUID                 Permissions;

+} EFI_IFR_SECURITY;

+

+typedef struct _EFI_IFR_FORM_MAP_METHOD {

+  ///

+  /// The string identifier which provides the human-readable name of 

+  /// the configuration method for this standards map form.

+  ///

+  EFI_STRING_ID            MethodTitle;

+  ///

+  /// Identifier which uniquely specifies the configuration methods 

+  /// associated with this standards map form.

+  ///

+  EFI_GUID                 MethodIdentifier;

+} EFI_IFR_FORM_MAP_METHOD;

+

+typedef struct _EFI_IFR_FORM_MAP {

+  ///

+  /// The sequence that defines the type of opcode as well as the length 

+  /// of the opcode being defined. Header.OpCode = EFI_IFR_FORM_MAP_OP. 

+  ///

+  EFI_IFR_OP_HEADER        Header;

+  ///

+  /// The unique identifier for this particular form.

+  ///

+  EFI_FORM_ID              FormId;

+  ///

+  /// One or more configuration method's name and unique identifier.

+  ///

+  EFI_IFR_FORM_MAP_METHOD  Methods[1];

+} EFI_IFR_FORM_MAP;

+

+typedef struct _EFI_IFR_SET {

+  ///

+  /// The sequence that defines the type of opcode as well as the length 

+  /// of the opcode being defined. Header.OpCode = EFI_IFR_SET_OP. 

+  ///

+  EFI_IFR_OP_HEADER  Header;

+  ///

+  /// Specifies the identifier of a previously declared variable store to 

+  /// use when storing the question's value. 

+  ///

+  EFI_VARSTORE_ID    VarStoreId;

+  union {

+    ///

+    /// A 16-bit Buffer Storage offset.

+    ///

+    EFI_STRING_ID    VarName;

+    ///

+    /// A Name Value or EFI Variable name (VarName).

+    ///

+    UINT16           VarOffset;

+  }                  VarStoreInfo;

+} EFI_IFR_SET;

+

+typedef struct _EFI_IFR_GET {

+  ///

+  /// The sequence that defines the type of opcode as well as the length 

+  /// of the opcode being defined. Header.OpCode = EFI_IFR_GET_OP. 

+  ///

+  EFI_IFR_OP_HEADER  Header;

+  ///

+  /// Specifies the identifier of a previously declared variable store to 

+  /// use when retrieving the value. 

+  ///

+  EFI_VARSTORE_ID    VarStoreId;

+  union {

+    ///

+    /// A 16-bit Buffer Storage offset.

+    ///

+    EFI_STRING_ID    VarName;

+    ///

+    /// A Name Value or EFI Variable name (VarName).

+    ///

+    UINT16           VarOffset;

+  }                  VarStoreInfo;

+  ///

+  /// Specifies the type used for storage. 

+  ///

+  UINT8              VarStoreType;

+} EFI_IFR_GET;

+

+typedef struct _EFI_IFR_READ {

+  EFI_IFR_OP_HEADER       Header;

+} EFI_IFR_READ;

+

+typedef struct _EFI_IFR_WRITE {

+  EFI_IFR_OP_HEADER      Header;

+} EFI_IFR_WRITE;

+

+typedef struct _EFI_IFR_MAP {

+  EFI_IFR_OP_HEADER      Header;

+} EFI_IFR_MAP;

 //

 // Definitions for Keyboard Package

 // Releated definitions are in Section of EFI_HII_DATABASE_PROTOCOL

diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index 5922788edb..9ea4b407b6 100644
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -317,6 +317,15 @@
   ## Include/Guid/HiiPlatformSetupFormset.h

   gEfiHiiPlatformSetupFormsetGuid = { 0x93039971, 0x8545, 0x4b04, { 0xb4, 0x5e, 0x32, 0xeb, 0x83, 0x26, 0x04, 0x0e }}

 

+  ## Include/Guid/HiiPlatformSetupFormset.h

+  gEfiHiiDriverHealthFormsetGuid = { 0xf22fc20c, 0x8cf4, 0x45eb, { 0x8e, 0x6, 0xad, 0x4e, 0x50, 0xb9, 0x5d, 0xd3 }}

+

+  ## Include/Guid/HiiPlatformSetupFormset.h

+  gEfiHiiUserCredentialFormsetGuid = { 0x337f4407, 0x5aee, 0x4b83, { 0xb2, 0xa7, 0x4e, 0xad, 0xca, 0x30, 0x88, 0xcd }}

+  

+  ## Include/Guid/HiiFormMapMethodGuid.h

+  gEfiHiiStandardFormGuid = { 0x3bd2f4ec, 0xe524, 0x46e4, { 0xa9, 0xd8, 0x51, 0x1, 0x17, 0x42, 0x55, 0x62 }}

+

   ## Include/Guid/MemoryOverwriteControl.h

   gEfiMemoryOverwriteControlDataGuid = { 0xe20939be, 0x32d4, 0x41be, {0xa1, 0x50, 0x89, 0x7f, 0x85, 0xd4, 0x98, 0x29 }}