]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Uefi/UefiInternalFormRepresentation.h
Second set of changes based on a review of the code comments in the Include directory...
[mirror_edk2.git] / MdePkg / Include / Uefi / UefiInternalFormRepresentation.h
index dd7247fe8d5d1c2ee529553a4b96c28d1a7a9414..942c2111353f0b89dd20b95bd3ba211d07b54c92 100644 (file)
@@ -1,10 +1,9 @@
-\r
 /** @file\r
   This file defines the encoding for the VFR (Visual Form Representation) language.\r
   IFR is primarily consumed by the EFI presentation engine, and produced by EFI\r
   internal application and drivers as well as all add-in card option-ROM drivers\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   which accompanies this distribution.  The full text of the license may be found at        \r
 #ifndef __UEFI_INTERNAL_FORMREPRESENTATION_H__\r
 #define __UEFI_INTERNAL_FORMREPRESENTATION_H__\r
 \r
-//\r
-// The following types are currently defined:\r
-//\r
-typedef UINT32  RELOFST;\r
-\r
+///\r
+/// The following types are currently defined:\r
+///\r
 typedef VOID*   EFI_HII_HANDLE;\r
 typedef CHAR16* EFI_STRING;\r
 typedef UINT16  EFI_IMAGE_ID;\r
@@ -33,45 +30,31 @@ typedef UINT16  EFI_QUESTION_ID;
 typedef UINT16  EFI_STRING_ID;\r
 typedef UINT16  EFI_FORM_ID;\r
 typedef UINT16  EFI_VARSTORE_ID;\r
+\r
 typedef UINT16  EFI_DEFAULT_ID;\r
+\r
 typedef UINT32  EFI_HII_FONT_STYLE;\r
 \r
 \r
 \r
 #pragma pack(1)\r
 \r
-\r
 //\r
-// HII package list\r
+// Definitions for Package Lists and Package Headers\r
+// Section 27.3.1\r
 //\r
+\r
+///\r
+/// The header found at the start of each package list.\r
+///\r
 typedef struct {\r
   EFI_GUID               PackageListGuid;\r
   UINT32                 PackageLength;\r
 } EFI_HII_PACKAGE_LIST_HEADER;\r
 \r
-/**\r
-    \r
-  Each package starts with a header, as defined above, which  \r
-  indicates the size and type of the package. When added to a  \r
-  pointer pointing to the start of the header, Length points at  \r
-  the next package. The package lists form a package list when  \r
-  concatenated together and terminated with an  \r
-  EFI_HII_PACKAGE_HEADER with a Type of EFI_HII_PACKAGE_END. The  \r
-  type EFI_HII_PACKAGE_TYPE_GUID is used for vendor-defined HII  \r
-  packages, whose contents are determined by the Guid. The range  \r
-  of package types starting with EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN  \r
-  through EFI_HII_PACKAGE_TYPE_SYSTEM_END are reserved for system  \r
-  firmware implementers.  \r
-  \r
-  @param Length The size of the package in bytes.\r
-  \r
-  @param Type   The package type. See EFI_HII_PACKAGE_TYPE_x,\r
-                below.\r
-  \r
-  @param Data   The package data, the format of which is\r
-                determined by Type.\r
-  \r
-**/\r
+///\r
+/// The header found at the start of each package.\r
+///\r
 typedef struct {\r
   UINT32  Length:24;\r
   UINT32  Type:8;\r
@@ -79,32 +62,33 @@ typedef struct {
 } EFI_HII_PACKAGE_HEADER;\r
 \r
 //\r
-// EFI_HII_PACKAGE_TYPE_x.\r
+// Value of HII package type\r
 // \r
 #define EFI_HII_PACKAGE_TYPE_ALL             0x00\r
 #define EFI_HII_PACKAGE_TYPE_GUID            0x01\r
-#define EFI_HII_PACKAGE_FORM                 0x02\r
-#define EFI_HII_PACKAGE_KEYBOARD_LAYOUT      0x03\r
+#define EFI_HII_PACKAGE_FORMS                0x02\r
 #define EFI_HII_PACKAGE_STRINGS              0x04\r
 #define EFI_HII_PACKAGE_FONTS                0x05\r
 #define EFI_HII_PACKAGE_IMAGES               0x06\r
 #define EFI_HII_PACKAGE_SIMPLE_FONTS         0x07\r
 #define EFI_HII_PACKAGE_DEVICE_PATH          0x08\r
+#define EFI_HII_PACKAGE_KEYBOARD_LAYOUT      0x09\r
 #define EFI_HII_PACKAGE_END                  0xDF\r
 #define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN    0xE0\r
 #define EFI_HII_PACKAGE_TYPE_SYSTEM_END      0xFF\r
 \r
 //\r
-// Simplified Font Package\r
+// Definitions for Simplified Font Package\r
+// Section 27.3.2\r
 //\r
 \r
-#define EFI_GLYPH_HEIGHT                     19\r
-#define EFI_GLYPH_WIDTH                      8\r
 //\r
 // Contents of EFI_NARROW_GLYPH.Attributes\r
 //\r
 #define EFI_GLYPH_NON_SPACING                0x01\r
 #define EFI_GLYPH_WIDE                       0x02\r
+#define EFI_GLYPH_HEIGHT                     19\r
+#define EFI_GLYPH_WIDTH                      8\r
 \r
 typedef struct {\r
   CHAR16                 UnicodeWeight;\r
@@ -120,7 +104,10 @@ typedef struct {
   UINT8                  Pad[3];\r
 } EFI_WIDE_GLYPH;\r
 \r
-\r
+///\r
+/// A simplified font package consists of a font header\r
+/// followed by a series of glyph structures.\r
+///\r
 typedef struct _EFI_HII_SIMPLE_FONT_PACKAGE_HDR {\r
   EFI_HII_PACKAGE_HEADER Header;\r
   UINT16                 NumberOfNarrowGlyphs;\r
@@ -130,9 +117,14 @@ typedef struct _EFI_HII_SIMPLE_FONT_PACKAGE_HDR {
 } EFI_HII_SIMPLE_FONT_PACKAGE_HDR;\r
 \r
 //\r
-// Font Package\r
+// Definitions for Font Package\r
+// Section 27.3.3\r
 //\r
 \r
+//\r
+// Value for font style\r
+//\r
+#define EFI_HII_FONT_STYLE_NORMAL            0x00000000\r
 #define EFI_HII_FONT_STYLE_BOLD              0x00000001\r
 #define EFI_HII_FONT_STYLE_ITALIC            0x00000002\r
 #define EFI_HII_FONT_STYLE_EMBOSS            0x00010000\r
@@ -149,6 +141,12 @@ typedef struct _EFI_HII_GLYPH_INFO {
   INT16                  AdvanceX;\r
 } EFI_HII_GLYPH_INFO;\r
 \r
+///\r
+/// The fixed header consists of a standard record header and\r
+/// then the character values in this section, the flags\r
+/// (including the encoding method) and the offsets of the glyph\r
+/// information, the glyph bitmaps and the character map.\r
+///\r
 typedef struct _EFI_HII_FONT_PACKAGE_HDR {\r
   EFI_HII_PACKAGE_HEADER Header;\r
   UINT32                 HdrSize;\r
@@ -158,6 +156,9 @@ typedef struct _EFI_HII_FONT_PACKAGE_HDR {
   CHAR16                 FontFamily[1];\r
 } EFI_HII_FONT_PACKAGE_HDR;\r
 \r
+//\r
+// Value of different glyph info block types\r
+//\r
 #define EFI_HII_GIBT_END                  0x00\r
 #define EFI_HII_GIBT_GLYPH                0x10\r
 #define EFI_HII_GIBT_GLYPHS               0x11\r
@@ -175,6 +176,10 @@ typedef struct _EFI_HII_GLYPH_BLOCK {
   UINT8                  BlockType;\r
 } EFI_HII_GLYPH_BLOCK;\r
 \r
+//\r
+// Definition of different glyph info block types\r
+//\r
+\r
 typedef struct _EFI_HII_GIBT_DEFAULTS_BLOCK {\r
   EFI_HII_GLYPH_BLOCK    Header;\r
   EFI_HII_GLYPH_INFO     Cell;\r
@@ -210,25 +215,25 @@ typedef struct _EFI_HII_GIBT_EXT4_BLOCK {
 typedef struct _EFI_HII_GIBT_GLYPH_BLOCK {\r
   EFI_HII_GLYPH_BLOCK    Header;\r
   EFI_HII_GLYPH_INFO     Cell;\r
-  UINT8                  BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Cell.Width+7)/8)*Cell.Height\r
+  UINT8                  BitmapData[1];\r
 } EFI_HII_GIBT_GLYPH_BLOCK;\r
 \r
 typedef struct _EFI_HII_GIBT_GLYPHS_BLOCK {\r
   EFI_HII_GLYPH_BLOCK    Header;\r
   EFI_HII_GLYPH_INFO     Cell;\r
   UINT16                 Count;  \r
-  UINT8                  BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Cell.Width+7)/8)*Cell.Height\r
+  UINT8                  BitmapData[1];\r
 } EFI_HII_GIBT_GLYPHS_BLOCK;\r
 \r
 typedef struct _EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK {\r
   EFI_HII_GLYPH_BLOCK    Header;\r
-  UINT8                  BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Global.Cell.Width+7)/8)*Global.Cell.Height\r
+  UINT8                  BitmapData[1];\r
 } EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK;\r
 \r
 typedef struct _EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK {\r
   EFI_HII_GLYPH_BLOCK    Header;\r
   UINT16                 Count;\r
-  UINT8                  BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Global.Cell.Width+7)/8)*Global.Cell.Height\r
+  UINT8                  BitmapData[1];\r
 } EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK;\r
 \r
 typedef struct _EFI_HII_GIBT_SKIP1_BLOCK {\r
@@ -242,16 +247,27 @@ typedef struct _EFI_HII_GIBT_SKIP2_BLOCK {
 } EFI_HII_GIBT_SKIP2_BLOCK;\r
 \r
 //\r
-// Device Path Package\r
+// Definitions for Device Path Package\r
+// Section 27.3.4\r
 //\r
+\r
+///\r
+/// The device path package is used to carry a device path\r
+/// associated with the package list.\r
+///\r
 typedef struct _EFI_HII_DEVICE_PATH_PACKAGE {\r
   EFI_HII_PACKAGE_HEADER   Header;\r
   // EFI_DEVICE_PATH_PROTOCOL DevicePath[];\r
 } EFI_HII_DEVICE_PATH_PACKAGE;\r
 \r
 //\r
-// GUID Package\r
+// Definitions for GUID Package\r
+// Section 27.3.5\r
 //\r
+\r
+///\r
+/// The GUID package is used to carry data where the format is defined by a GUID.\r
+///\r
 typedef struct _EFI_HII_GUID_PACKAGE_HDR {\r
   EFI_HII_PACKAGE_HEADER  Header;\r
   EFI_GUID                Guid;\r
@@ -259,12 +275,17 @@ typedef struct _EFI_HII_GUID_PACKAGE_HDR {
 } EFI_HII_GUID_PACKAGE_HDR;\r
 \r
 //\r
-// String Package\r
+// Definitions for String Package\r
+// Section 27.3.6\r
 //\r
 \r
 #define UEFI_CONFIG_LANG  L"x-UEFI"\r
-#define UEFI_CONFIG_LANG2 L"x-i-UEFI"     // BUGBUG, spec need to be updated.\r
+#define UEFI_CONFIG_LANG2 L"x-i-UEFI"\r
 \r
+///\r
+/// The fixed header consists of a standard record header and then the string identifiers\r
+/// contained in this section and the offsets of the string and language information.\r
+///\r
 typedef struct _EFI_HII_STRING_PACKAGE_HDR {\r
   EFI_HII_PACKAGE_HEADER  Header;\r
   UINT32                  HdrSize;\r
@@ -278,6 +299,9 @@ typedef struct {
   UINT8                   BlockType;\r
 } EFI_HII_STRING_BLOCK;\r
 \r
+//\r
+// Value of different string information block types\r
+//\r
 #define EFI_HII_SIBT_END                     0x00\r
 #define EFI_HII_SIBT_STRING_SCSU             0x10\r
 #define EFI_HII_SIBT_STRING_SCSU_FONT        0x11\r
@@ -295,6 +319,10 @@ typedef struct {
 #define EFI_HII_SIBT_EXT4                    0x32\r
 #define EFI_HII_SIBT_FONT                    0x40\r
 \r
+//\r
+// Definition of different string information block types\r
+//\r
+\r
 typedef struct _EFI_HII_SIBT_DUPLICATE_BLOCK {\r
   EFI_HII_STRING_BLOCK    Header;\r
   EFI_STRING_ID           StringId;\r
@@ -389,7 +417,8 @@ typedef struct _EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK {
 } EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK;\r
 \r
 //\r
-// Image Packages\r
+// Definitions for Image Package\r
+// Section 27.3.7\r
 //\r
 \r
 typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {\r
@@ -402,6 +431,9 @@ typedef struct _EFI_HII_IMAGE_BLOCK {
   UINT8                   BlockType;\r
 } EFI_HII_IMAGE_BLOCK;\r
 \r
+//\r
+// Value of different image information block types\r
+//\r
 #define EFI_HII_IIBT_END               0x00\r
 #define EFI_HII_IIBT_IMAGE_1BIT        0x10\r
 #define EFI_HII_IIBT_IMAGE_1BIT_TRANS  0x11\r
@@ -419,6 +451,10 @@ typedef struct _EFI_HII_IMAGE_BLOCK {
 #define EFI_HII_IIBT_EXT2              0x31\r
 #define EFI_HII_IIBT_EXT4              0x32\r
 \r
+//\r
+// Definition of different image information block types\r
+//\r
+\r
 typedef struct _EFI_HII_IIBT_END_BLOCK {\r
   EFI_HII_IMAGE_BLOCK          Header;\r
 } EFI_HII_IIBT_END_BLOCK;\r
@@ -538,6 +574,10 @@ typedef struct _EFI_HII_IIBT_SKIP2_BLOCK {
   UINT16                       SkipCount;\r
 } EFI_HII_IIBT_SKIP2_BLOCK;\r
 \r
+//\r
+// Definitions for Palette Information\r
+//\r
+\r
 typedef struct _EFI_HII_IMAGE_PALETTE_INFO_HEADER {\r
   UINT16                       PaletteCount;\r
 } EFI_HII_IMAGE_PALETTE_INFO_HEADER;\r
@@ -548,9 +588,13 @@ typedef struct _EFI_HII_IMAGE_PALETTE_INFO {
 } EFI_HII_IMAGE_PALETTE_INFO;\r
 \r
 //\r
-// Forms Package\r
+// Definitions for Forms Package\r
+// Section 27.3.8\r
 //\r
 \r
+///\r
+/// The Forms package is used to carry forms-based encoding data.\r
+///\r
 typedef struct _EFI_HII_FORM_PACKAGE {\r
   EFI_HII_PACKAGE_HEADER       Header;\r
   // EFI_IFR_OP_HEADER         OpCodeHeader;\r
@@ -580,6 +624,9 @@ typedef union {
   EFI_STRING_ID   string;\r
 } EFI_IFR_TYPE_VALUE;\r
 \r
+//\r
+// IFR Opcodes\r
+//\r
 #define EFI_IFR_FORM_OP                0x01\r
 #define EFI_IFR_SUBTITLE_OP            0x02\r
 #define EFI_IFR_TEXT_OP                0x03\r
@@ -669,6 +716,10 @@ typedef union {
 #define EFI_IFR_CATENATE_OP            0x5E\r
 #define EFI_IFR_GUID_OP                0x5F\r
 \r
+//\r
+// Definitions of IFR Standard Headers\r
+// Section 27.3.8.2\r
+//\r
 \r
 typedef struct _EFI_IFR_OP_HEADER {\r
   UINT8                    OpCode;\r
@@ -692,17 +743,27 @@ typedef struct _EFI_IFR_QUESTION_HEADER {
   UINT8                    Flags;\r
 } EFI_IFR_QUESTION_HEADER;\r
 \r
+//\r
+// Flag values of EFI_IFR_QUESTION_HEADER\r
+//\r
 #define EFI_IFR_FLAG_READ_ONLY         0x01\r
 #define EFI_IFR_FLAG_CALLBACK          0x04\r
 #define EFI_IFR_FLAG_RESET_REQUIRED    0x10\r
 #define EFI_IFR_FLAG_OPTIONS_ONLY      0x80\r
 \r
+//\r
+// Definition for Opcode Reference\r
+// Section 27.3.8.3\r
+//\r
 typedef struct _EFI_IFR_DEFAULTSTORE {\r
   EFI_IFR_OP_HEADER        Header;\r
   EFI_STRING_ID            DefaultName;\r
   UINT16                   DefaultId;\r
 } EFI_IFR_DEFAULTSTORE;\r
 \r
+//\r
+// Default Identifier of default store \r
+//\r
 #define EFI_HII_DEFAULT_CLASS_STANDARD       0x0000\r
 #define EFI_HII_DEFAULT_CLASS_MANUFACTURING  0x0001\r
 #define EFI_HII_DEFAULT_CLASS_SAFE           0x0002\r
@@ -723,14 +784,14 @@ typedef struct _EFI_IFR_VARSTORE {
 \r
 typedef struct _EFI_IFR_VARSTORE_EFI {\r
   EFI_IFR_OP_HEADER        Header;\r
-  UINT16                   VarStoreId;\r
+  EFI_VARSTORE_ID          VarStoreId;\r
   EFI_GUID                 Guid;\r
   UINT32                   Attributes;\r
 } EFI_IFR_VARSTORE_EFI;\r
 \r
 typedef struct _EFI_IFR_VARSTORE_NAME_VALUE {\r
   EFI_IFR_OP_HEADER        Header;\r
-  UINT16                   VarStoreId;\r
+  EFI_VARSTORE_ID          VarStoreId;\r
   EFI_GUID                 Guid;\r
 } EFI_IFR_VARSTORE_NAME_VALUE;\r
 \r
@@ -739,6 +800,8 @@ typedef struct _EFI_IFR_FORM_SET {
   EFI_GUID                 Guid;\r
   EFI_STRING_ID            FormSetTitle;\r
   EFI_STRING_ID            Help;\r
+  UINT8                    Flags;\r
+  // EFI_GUID              ClassGuid[];\r
 } EFI_IFR_FORM_SET;\r
 \r
 typedef struct _EFI_IFR_END {\r
@@ -852,6 +915,9 @@ typedef struct _EFI_IFR_DATE {
   UINT8                    Flags;\r
 } EFI_IFR_DATE;\r
 \r
+//\r
+// Flags that describe the behavior of the question.\r
+//\r
 #define EFI_QF_DATE_YEAR_SUPPRESS      0x01\r
 #define EFI_QF_DATE_MONTH_SUPPRESS     0x02\r
 #define EFI_QF_DATE_DAY_SUPPRESS       0x04\r
@@ -891,16 +957,19 @@ typedef struct _EFI_IFR_NUMERIC {
   MINMAXSTEP_DATA          data;\r
 } EFI_IFR_NUMERIC;\r
 \r
+//\r
+// Flags related to the numeric question\r
+//\r
 #define EFI_IFR_NUMERIC_SIZE           0x03\r
-#define EFI_IFR_NUMERIC_SIZE_1         0x00\r
-#define EFI_IFR_NUMERIC_SIZE_2         0x01\r
-#define EFI_IFR_NUMERIC_SIZE_4         0x02\r
-#define EFI_IFR_NUMERIC_SIZE_8         0x03\r
+#define   EFI_IFR_NUMERIC_SIZE_1       0x00\r
+#define   EFI_IFR_NUMERIC_SIZE_2       0x01\r
+#define   EFI_IFR_NUMERIC_SIZE_4       0x02\r
+#define   EFI_IFR_NUMERIC_SIZE_8       0x03\r
 \r
 #define EFI_IFR_DISPLAY                0x30\r
-#define EFI_IFR_DISPLAY_INT_DEC        0x00\r
-#define EFI_IFR_DISPLAY_UINT_DEC       0x10\r
-#define EFI_IFR_DISPLAY_UINT_HEX       0x20\r
+#define   EFI_IFR_DISPLAY_INT_DEC      0x00\r
+#define   EFI_IFR_DISPLAY_UINT_DEC     0x10\r
+#define   EFI_IFR_DISPLAY_UINT_HEX     0x20\r
 \r
 typedef struct _EFI_IFR_ONE_OF {\r
   EFI_IFR_OP_HEADER        Header;\r
@@ -942,14 +1011,17 @@ typedef struct _EFI_IFR_TIME {
   UINT8                    Flags;\r
 } EFI_IFR_TIME;\r
 \r
+//\r
+// A bit-mask that determines which unique settings are active for this opcode.\r
+//\r
 #define QF_TIME_HOUR_SUPPRESS          0x01\r
 #define QF_TIME_MINUTE_SUPPRESS        0x02\r
 #define QF_TIME_SECOND_SUPPRESS        0x04\r
 \r
 #define QF_TIME_STORAGE                0x30\r
-#define QF_TIME_STORAGE_NORMAL         0x00\r
-#define QF_TIME_STORAGE_TIME           0x10\r
-#define QF_TIME_STORAGE_WAKEUP         0x20\r
+#define   QF_TIME_STORAGE_NORMAL       0x00\r
+#define   QF_TIME_STORAGE_TIME         0x10\r
+#define   QF_TIME_STORAGE_WAKEUP       0x20\r
 \r
 typedef struct _EFI_IFR_DISABLE_IF {\r
   EFI_IFR_OP_HEADER        Header;\r
@@ -991,6 +1063,9 @@ typedef struct _EFI_IFR_ONE_OF_OPTION {
   EFI_IFR_TYPE_VALUE       Value;\r
 } EFI_IFR_ONE_OF_OPTION;\r
 \r
+//\r
+// Types of the option's value.\r
+//\r
 #define EFI_IFR_TYPE_NUM_SIZE_8        0x00\r
 #define EFI_IFR_TYPE_NUM_SIZE_16       0x01\r
 #define EFI_IFR_TYPE_NUM_SIZE_32       0x02\r
@@ -1033,11 +1108,6 @@ typedef struct _EFI_IFR_EQ_ID_LIST {
   UINT16                   ValueList[1];\r
 } EFI_IFR_EQ_ID_LIST;\r
 \r
-typedef struct _EFI_IFR_QUESTION_REF1 {\r
-  EFI_IFR_OP_HEADER        Header;\r
-  EFI_QUESTION_ID          QuestionId;\r
-} EFI_IFR_QUESTION_REF1;\r
-\r
 typedef struct _EFI_IFR_UINT8 {\r
   EFI_IFR_OP_HEADER        Header;\r
   UINT8 Value;\r
@@ -1048,10 +1118,6 @@ typedef struct _EFI_IFR_UINT16 {
   UINT16                   Value;\r
 } EFI_IFR_UINT16;\r
 \r
-typedef struct _EFI_IFR_QUESTION_REF2 {\r
-  EFI_IFR_OP_HEADER        Header;\r
-} EFI_IFR_QUESTION_REF2;\r
-\r
 typedef struct _EFI_IFR_UINT32 {\r
   EFI_IFR_OP_HEADER        Header;\r
   UINT32                   Value;\r
@@ -1062,6 +1128,15 @@ typedef struct _EFI_IFR_UINT64 {
   UINT64 Value;\r
 } EFI_IFR_UINT64;\r
 \r
+typedef struct _EFI_IFR_QUESTION_REF1 {\r
+  EFI_IFR_OP_HEADER        Header;\r
+  EFI_QUESTION_ID          QuestionId;\r
+} EFI_IFR_QUESTION_REF1;\r
+\r
+typedef struct _EFI_IFR_QUESTION_REF2 {\r
+  EFI_IFR_OP_HEADER        Header;\r
+} EFI_IFR_QUESTION_REF2;\r
+\r
 typedef struct _EFI_IFR_QUESTION_REF3 {\r
   EFI_IFR_OP_HEADER        Header;\r
 } EFI_IFR_QUESTION_REF3;\r
@@ -1139,11 +1214,23 @@ typedef struct _EFI_IFR_TO_BOOLEAN {
   EFI_IFR_OP_HEADER        Header;\r
 } EFI_IFR_TO_BOOLEAN;\r
 \r
+//\r
+// For EFI_IFR_TO_STRING, when converting from\r
+// unsigned integers, these flags control the format:\r
+// 0 = unsigned decimal\r
+// 1 = signed decimal\r
+// 2 = hexadecimal (lower-case alpha)\r
+// 3 = hexadecimal (upper-case alpha)\r
+//\r
 #define EFI_IFR_STRING_UNSIGNED_DEC      0\r
 #define EFI_IFR_STRING_SIGNED_DEC        1\r
 #define EFI_IFR_STRING_LOWERCASE_HEX     2\r
 #define EFI_IFR_STRING_UPPERCASE_HEX     3\r
-\r
+//\r
+// When converting from a buffer, these flags control the format:\r
+// 0 = ASCII\r
+// 8 = Unicode\r
+//\r
 #define EFI_IFR_STRING_ASCII             0\r
 #define EFI_IFR_STRING_UNICODE           8\r
 \r
@@ -1244,6 +1331,9 @@ typedef struct _EFI_IFR_CONDITIONAL {
   EFI_IFR_OP_HEADER        Header;\r
 } EFI_IFR_CONDITIONAL;\r
 \r
+//\r
+// Flags governing the matching criteria of EFI_IFR_FIND\r
+//\r
 #define EFI_IFR_FF_CASE_SENSITIVE    0x00\r
 #define EFI_IFR_FF_CASE_INSENSITIVE  0x01\r
 \r
@@ -1260,6 +1350,10 @@ typedef struct _EFI_IFR_TOKEN {
   EFI_IFR_OP_HEADER        Header;\r
 } EFI_IFR_TOKEN;\r
 \r
+//\r
+// Flags specifying whether to find the first matching string\r
+// or the first non-matching string.\r
+//\r
 #define EFI_IFR_FLAGS_FIRST_MATCHING     0x00\r
 #define EFI_IFR_FLAGS_FIRST_NON_MATCHING 0x01\r
 \r
@@ -1269,9 +1363,13 @@ typedef struct _EFI_IFR_SPAN {
 } EFI_IFR_SPAN;\r
 \r
 //\r
-// Keyboard Package\r
+// Definitions for Keyboard Package\r
+// Releated definitions are in Section of EFI_HII_DATABASE_PROTOCOL\r
 //\r
 \r
+///\r
+/// Each enumeration values maps a physical key on a keyboard.\r
+///\r
 typedef enum {    \r
   EfiKeyLCtrl,\r
   EfiKeyA0, \r
@@ -1299,7 +1397,7 @@ typedef enum {
   EfiKeyB8,\r
   EfiKeyB9,\r
   EfiKeyB10,\r
-  EfiKeyRshift,\r
+  EfiKeyRShift,\r
   EfiKeyUpArrow,\r
   EfiKeyOne,\r
   EfiKeyTwo,\r
@@ -1390,22 +1488,24 @@ typedef struct {
   UINT16                  AffectedAttribute;\r
 } EFI_KEY_DESCRIPTOR;\r
 \r
-//\r
-// A key which is affected by all the standard shift modifiers.  \r
-// Most keys would be expected to have this bit active.\r
-//\r
+///\r
+/// A key which is affected by all the standard shift modifiers.  \r
+/// Most keys would be expected to have this bit active.\r
+///\r
 #define EFI_AFFECTED_BY_STANDARD_SHIFT       0x0001\r
-//\r
-// This key is affected by the caps lock so that if a keyboard driver\r
-// would need to disambiguate between a key which had a ¡°1¡± defined\r
-// versus a ¡°a¡± character.  Having this bit turned on would tell\r
-// the keyboard driver to use the appropriate shifted state or not.\r
-//\r
+\r
+///\r
+/// This key is affected by the caps lock so that if a keyboard driver\r
+/// would need to disambiguate between a key which had a "1" defined\r
+/// versus an "a" character.  Having this bit turned on would tell\r
+/// the keyboard driver to use the appropriate shifted state or not.\r
+///\r
 #define EFI_AFFECTED_BY_CAPS_LOCK            0x0002\r
-//\r
-// Similar to the case of CAPS lock, if this bit is active, the key\r
-// is affected by the num lock being turned on.\r
-//\r
+\r
+///\r
+/// Similar to the case of CAPS lock, if this bit is active, the key\r
+/// is affected by the num lock being turned on.\r
+///\r
 #define EFI_AFFECTED_BY_NUM_LOCK             0x0004\r
 \r
 typedef struct {\r
@@ -1422,17 +1522,6 @@ typedef struct {
   // EFI_HII_KEYBOARD_LAYOUT Layout[];\r
 } EFI_HII_KEYBOARD_PACKAGE_HDR;\r
 \r
-typedef struct {\r
-  CHAR16                  Language[3];\r
-  CHAR16                  Space;\r
-  CHAR16                  DescriptionString[1];\r
-} EFI_DESCRIPTION_STRING;\r
-\r
-typedef struct {\r
-  UINT16                  DescriptionCount;\r
-  EFI_DESCRIPTION_STRING  DescriptionString[1];\r
-} EFI_DESCRIPTION_STRING_BUNDLE;\r
-\r
 //\r
 // Modifier values\r
 //\r
@@ -1451,7 +1540,7 @@ typedef struct {
 #define EFI_LEFT_SHIFT_MODIFIER          0x000C\r
 #define EFI_RIGHT_SHIFT_MODIFIER         0x000D\r
 #define EFI_CAPS_LOCK_MODIFIER           0x000E\r
-#define EFI_NUM_LOCK _MODIFIER           0x000F\r
+#define EFI_NUM_LOCK_MODIFIER            0x000F\r
 #define EFI_LEFT_ARROW_MODIFIER          0x0010\r
 #define EFI_RIGHT_ARROW_MODIFIER         0x0011\r
 #define EFI_DOWN_ARROW_MODIFIER          0x0012\r
@@ -1474,7 +1563,7 @@ typedef struct {
 //\r
 // Keys that have multiple control functions based on modifier\r
 // settings are handled in the keyboard driver implementation.\r
-// For instance PRINT_KEY might have a modifier held down and\r
+// For instance, PRINT_KEY might have a modifier held down and\r
 // is still a nonprinting character, but might have an alternate\r
 // control function like SYSREQUEST\r
 //\r
@@ -1484,18 +1573,22 @@ typedef struct {
 #define EFI_PAUSE_MODIFIER               0x0025\r
 #define EFI_BREAK_MODIFIER               0x0026\r
 \r
+#define EFI_LEFT_LOGO_MODIFIER           0x0027\r
+#define EFI_RIGHT_LOGO_MODIFIER          0x0028\r
+#define EFI_MENU_MODIFIER                0x0029\r
+\r
 #pragma pack()\r
 \r
 \r
 \r
-//\r
-// References to string tokens must use this macro to enable scanning for\r
-// token usages.\r
-//\r
-//\r
-// STRING_TOKEN is not defined in UEFI specification. But it is placed \r
-// here for the easy access by C files and VFR source files.\r
-//\r
+///\r
+/// References to string tokens must use this macro to enable scanning for\r
+/// token usages.\r
+///\r
+///\r
+/// STRING_TOKEN is not defined in UEFI specification. But it is placed \r
+/// here for the easy access by C files and VFR source files.\r
+///\r
 #define STRING_TOKEN(t) t\r
 \r
 #endif\r