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 - 2010, Intel Corporation All rights reserved.\r
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
\r
This program and the accompanying materials are licensed and made available\r
under the terms and conditions of the BSD License which accompanies this\r
- distribution. The full text of the license may be found at:\r
+ distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
- File Name: UefiInternalFormRepresentation.h\r
-\r
@par Revision Reference:\r
- These definitions are from UEFI2.1.\r
+ These definitions are from UEFI 2.6\r
\r
**/\r
\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
+\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
+\r
@param Type The package type. See EFI_HII_PACKAGE_TYPE_x,\r
below.\r
- \r
+\r
@param Data The package data, the format of which is\r
determined by Type.\r
- \r
+\r
**/\r
typedef struct {\r
UINT32 Length:24;\r
\r
//\r
// EFI_HII_PACKAGE_TYPE_x.\r
-// \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_GIBT_GLYPHS 0x11\r
#define EFI_HII_GIBT_GLYPH_DEFAULT 0x12\r
#define EFI_HII_GIBT_GLYPHS_DEFAULT 0x13\r
+#define EFI_HII_GIBT_GLYPH_VARIABILITY 0x14\r
#define EFI_HII_GIBT_DUPLICATE 0x20\r
#define EFI_HII_GIBT_SKIP2 0x21\r
#define EFI_HII_GIBT_SKIP1 0x22\r
typedef struct _EFI_HII_GIBT_GLYPHS_BLOCK {\r
EFI_HII_GLYPH_BLOCK Header;\r
EFI_HII_GLYPH_INFO Cell;\r
- UINT16 Count; \r
+ UINT16 Count;\r
UINT8 BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Cell.Width+7)/8)*Cell.Height\r
} EFI_HII_GIBT_GLYPHS_BLOCK;\r
\r
UINT8 BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Global.Cell.Width+7)/8)*Global.Cell.Height\r
} EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK;\r
\r
+typedef struct _EFI_HII_GIBT_VARIABILITY_BLOCK {\r
+ EFI_HII_GLYPH_BLOCK Header;\r
+ EFI_HII_GLYPH_INFO Cell;\r
+ UINT8 GlyphPackInBits;\r
+ UINT8 BitmapData [1];\r
+} EFI_HII_GIBT_VARIABILITY_BLOCK;\r
+\r
typedef struct _EFI_HII_GIBT_SKIP1_BLOCK {\r
EFI_HII_GLYPH_BLOCK Header;\r
UINT8 SkipCount;\r
#define EFI_HII_IIBT_IMAGE_24BIT 0x16\r
#define EFI_HII_IIBT_IMAGE_24BIT_TRANS 0x17\r
#define EFI_HII_IIBT_IMAGE_JPEG 0x18\r
+#define EFI_HII_IIBT_IMAGE_PNG 0x19\r
#define EFI_HII_IIBT_DUPLICATE 0x20\r
#define EFI_HII_IIBT_SKIP2 0x21\r
#define EFI_HII_IIBT_SKIP1 0x22\r
UINT8 Data[1];\r
} EFI_HII_IIBT_JPEG_BLOCK;\r
\r
+typedef struct _EFI_HII_IIBT_PNG_BLOCK {\r
+ EFI_HII_IMAGE_BLOCK Header;\r
+ UINT32 Size;\r
+ UINT8 Data[1];\r
+} EFI_HII_IIBT_PNG_BLOCK;\r
+\r
typedef struct _EFI_HII_IIBT_SKIP1_BLOCK {\r
EFI_HII_IMAGE_BLOCK Header;\r
UINT8 SkipCount;\r
UINT8 Day;\r
} EFI_HII_DATE;\r
\r
+typedef struct {\r
+ EFI_QUESTION_ID QuestionId;\r
+ EFI_FORM_ID FormId;\r
+ EFI_GUID FormSetGuid;\r
+ EFI_STRING_ID DevicePath;\r
+} EFI_HII_REF;\r
+\r
typedef union {\r
UINT8 u8;\r
UINT16 u16;\r
EFI_HII_TIME time;\r
EFI_HII_DATE date;\r
EFI_STRING_ID string;\r
+ EFI_HII_REF ref;\r
} EFI_IFR_TYPE_VALUE;\r
\r
#define EFI_IFR_FORM_OP 0x01\r
#define EFI_IFR_INCONSISTENT_IF_OP 0x11\r
#define EFI_IFR_EQ_ID_VAL_OP 0x12\r
#define EFI_IFR_EQ_ID_ID_OP 0x13\r
-#define EFI_IFR_EQ_ID_LIST_OP 0x14\r
+#define EFI_IFR_EQ_ID_VAL_LIST_OP 0x14\r
#define EFI_IFR_AND_OP 0x15\r
#define EFI_IFR_OR_OP 0x16\r
#define EFI_IFR_NOT_OP 0x17\r
#define EFI_IFR_CATENATE_OP 0x5E\r
#define EFI_IFR_GUID_OP 0x5F\r
#define EFI_IFR_SECURITY_OP 0x60\r
+#define EFI_IFR_MODAL_TAG_OP 0x61\r
+#define EFI_IFR_REFRESH_ID_OP 0x62\r
+#define EFI_IFR_WARNING_IF_OP 0x63\r
+#define EFI_IFR_MATCH2_OP 0x64\r
\r
\r
typedef struct _EFI_IFR_OP_HEADER {\r
UINT8 Flags;\r
} 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
+#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_RECONNECT_REQUIRED 0x40\r
+#define EFI_IFR_FLAG_OPTIONS_ONLY 0x80\r
\r
typedef struct _EFI_IFR_DEFAULTSTORE {\r
EFI_IFR_OP_HEADER Header;\r
EFI_VARSTORE_ID VarStoreId;\r
EFI_GUID Guid;\r
UINT32 Attributes;\r
+ UINT16 Size;\r
+ UINT8 Name[1];\r
} EFI_IFR_VARSTORE_EFI;\r
\r
typedef struct _EFI_IFR_VARSTORE_NAME_VALUE {\r
EFI_IMAGE_ID Id;\r
} EFI_IFR_IMAGE;\r
\r
+typedef struct _EFI_IFR_MODAL_TAG {\r
+ EFI_IFR_OP_HEADER Header;\r
+} EFI_IFR_MODAL_TAG;\r
+\r
typedef struct _EFI_IFR_LOCKED {\r
EFI_IFR_OP_HEADER Header;\r
} EFI_IFR_LOCKED;\r
EFI_IFR_TYPE_VALUE Value;\r
} EFI_IFR_DEFAULT;\r
\r
+typedef struct _EFI_IFR_DEFAULT_2 {\r
+ EFI_IFR_OP_HEADER Header;\r
+ UINT16 DefaultId;\r
+ UINT8 Type;\r
+} EFI_IFR_DEFAULT_2;\r
+\r
typedef struct _EFI_IFR_VALUE {\r
EFI_IFR_OP_HEADER Header;\r
} EFI_IFR_VALUE;\r
EFI_STRING_ID DevicePath;\r
} EFI_IFR_REF4;\r
\r
+typedef struct _EFI_IFR_REF5 {\r
+ EFI_IFR_OP_HEADER Header;\r
+ EFI_IFR_QUESTION_HEADER Question;\r
+} EFI_IFR_REF5;\r
+\r
typedef struct _EFI_IFR_RESET_BUTTON {\r
EFI_IFR_OP_HEADER Header;\r
EFI_IFR_STATEMENT_HEADER Statement;\r
EFI_STRING_ID Error;\r
} EFI_IFR_NO_SUBMIT_IF;\r
\r
+typedef struct _EFI_IFR_WARNING_IF {\r
+ EFI_IFR_OP_HEADER Header;\r
+ EFI_STRING_ID Warning;\r
+ UINT8 TimeOut;\r
+} EFI_IFR_WARNING_IF;\r
+\r
typedef struct _EFI_IFR_REFRESH {\r
EFI_IFR_OP_HEADER Header;\r
UINT8 RefreshInterval;\r
} EFI_IFR_REFRESH;\r
\r
+typedef struct _EFI_IFR_REFRESH_ID {\r
+ EFI_IFR_OP_HEADER Header;\r
+ EFI_GUID RefreshEventGroupId;\r
+} EFI_IFR_REFRESH_ID;\r
+\r
typedef struct _EFI_IFR_VARSTORE_DEVICE {\r
EFI_IFR_OP_HEADER Header;\r
EFI_STRING_ID DevicePath;\r
#define EFI_IFR_TYPE_UNDEFINED 0x09\r
#define EFI_IFR_TYPE_ACTION 0x0A\r
#define EFI_IFR_TYPE_BUFFER 0x0B\r
+#define EFI_IFR_TYPE_REF 0x0C\r
\r
#define EFI_IFR_OPTION_DEFAULT 0x10\r
#define EFI_IFR_OPTION_DEFAULT_MFG 0x20\r
EFI_IFR_OP_HEADER Header;\r
} EFI_IFR_MATCH;\r
\r
+typedef struct _EFI_IFR_MATCH2 {\r
+ EFI_IFR_OP_HEADER Header;\r
+ EFI_GUID SyntaxType;\r
+} EFI_IFR_MATCH2;\r
+\r
typedef struct _EFI_IFR_MULTIPLY {\r
EFI_IFR_OP_HEADER Header;\r
} EFI_IFR_MULTIPLY;\r
\r
typedef struct _EFI_IFR_FORM_MAP_METHOD {\r
///\r
- /// The string identifier which provides the human-readable name of \r
+ /// The string identifier which provides the human-readable name of\r
/// the configuration method for this standards map form.\r
///\r
EFI_STRING_ID MethodTitle;\r
///\r
- /// Identifier which uniquely specifies the configuration methods \r
+ /// Identifier which uniquely specifies the configuration methods\r
/// associated with this standards map form.\r
///\r
EFI_GUID MethodIdentifier;\r
\r
typedef struct _EFI_IFR_FORM_MAP {\r
///\r
- /// The sequence that defines the type of opcode as well as the length \r
- /// of the opcode being defined. Header.OpCode = EFI_IFR_FORM_MAP_OP. \r
+ /// The sequence that defines the type of opcode as well as the length\r
+ /// of the opcode being defined. Header.OpCode = EFI_IFR_FORM_MAP_OP.\r
///\r
EFI_IFR_OP_HEADER Header;\r
///\r
\r
typedef struct _EFI_IFR_SET {\r
///\r
- /// The sequence that defines the type of opcode as well as the length \r
- /// of the opcode being defined. Header.OpCode = EFI_IFR_SET_OP. \r
+ /// The sequence that defines the type of opcode as well as the length\r
+ /// of the opcode being defined. Header.OpCode = EFI_IFR_SET_OP.\r
///\r
EFI_IFR_OP_HEADER Header;\r
///\r
- /// Specifies the identifier of a previously declared variable store to \r
- /// use when storing the question's value. \r
+ /// Specifies the identifier of a previously declared variable store to\r
+ /// use when storing the question's value.\r
///\r
EFI_VARSTORE_ID VarStoreId;\r
union {\r
UINT16 VarOffset;\r
} VarStoreInfo;\r
///\r
- /// Specifies the type used for storage. \r
+ /// Specifies the type used for storage.\r
///\r
UINT8 VarStoreType;\r
} EFI_IFR_SET;\r
\r
typedef struct _EFI_IFR_GET {\r
///\r
- /// The sequence that defines the type of opcode as well as the length \r
- /// of the opcode being defined. Header.OpCode = EFI_IFR_GET_OP. \r
+ /// The sequence that defines the type of opcode as well as the length\r
+ /// of the opcode being defined. Header.OpCode = EFI_IFR_GET_OP.\r
///\r
EFI_IFR_OP_HEADER Header;\r
///\r
- /// Specifies the identifier of a previously declared variable store to \r
- /// use when retrieving the value. \r
+ /// Specifies the identifier of a previously declared variable store to\r
+ /// use when retrieving the value.\r
///\r
EFI_VARSTORE_ID VarStoreId;\r
union {\r
UINT16 VarOffset;\r
} VarStoreInfo;\r
///\r
- /// Specifies the type used for storage. \r
+ /// Specifies the type used for storage.\r
///\r
UINT8 VarStoreType;\r
} EFI_IFR_GET;\r
// Keyboard Package\r
//\r
\r
-typedef enum { \r
+typedef enum {\r
EfiKeyLCtrl,\r
- EfiKeyA0, \r
+ EfiKeyA0,\r
EfiKeyLAlt,\r
EfiKeySpaceBar,\r
EfiKeyA2,\r
} EFI_KEY_DESCRIPTOR;\r
\r
//\r
-// A key which is affected by all the standard shift modifiers. \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
// token usages.\r
//\r
//\r
-// STRING_TOKEN is not defined in UEFI specification. But it is placed \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