X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FFramework%2FFrameworkInternalFormRepresentation.h;h=04cbae1ef5aefc49eeaba82d38ac89b380f60d18;hb=aa7fc1c11c3d57d82842dbede50d064639671a98;hp=a5579c4db2a26f0e04ca826993aa8ba3e5488fdc;hpb=33d228aa027bd0944f6a23dbb3c7778fb861e49c;p=mirror_edk2.git diff --git a/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h b/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h index a5579c4db2..04cbae1ef5 100644 --- a/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h +++ b/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h @@ -3,17 +3,11 @@ Framework IFR is primarily consumed by the EFI presentation engine, and produced by EFI internal application and drivers as well as all add-in card option-ROM drivers - Copyright (c) 2007 - 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. +Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent @par Revision Reference: - These definitions are from Framework Specification HII 0.92. + These definitions are from the Framework Specification HII 0.92. **/ @@ -33,7 +27,7 @@ typedef UINT16 STRING_REF; #define FRAMEWORK_EFI_IFR_CHECKBOX_OP 0x06 #define FRAMEWORK_EFI_IFR_NUMERIC_OP 0x07 #define FRAMEWORK_EFI_IFR_PASSWORD_OP 0x08 -#define FRAMEWORK_EFI_IFR_ONE_OF_OPTION_OP 0x09 ///< ONEOF OPTION field +#define FRAMEWORK_EFI_IFR_ONE_OF_OPTION_OP 0x09 ///< ONEOF OPTION field. #define FRAMEWORK_EFI_IFR_SUPPRESS_IF_OP 0x0A #define EFI_IFR_END_FORM_OP 0x0B #define EFI_IFR_HIDDEN_OP 0x0C @@ -49,7 +43,7 @@ typedef UINT16 STRING_REF; #define FRAMEWORK_EFI_IFR_AND_OP 0x15 #define FRAMEWORK_EFI_IFR_OR_OP 0x16 #define FRAMEWORK_EFI_IFR_NOT_OP 0x17 -#define EFI_IFR_END_IF_OP 0x18 ///< for endif of inconsistentif, suppressif, grayoutif +#define EFI_IFR_END_IF_OP 0x18 ///< For endif of inconsistentif, suppressif, grayoutif. #define EFI_IFR_GRAYOUT_IF_OP 0x19 #define FRAMEWORK_EFI_IFR_DATE_OP 0x1A #define FRAMEWORK_EFI_IFR_TIME_OP 0x1B @@ -79,7 +73,7 @@ typedef UINT16 STRING_REF; #define EFI_IFR_FLAG_RESET_REQUIRED 0x10 #define EFI_IFR_FLAG_LATE_CHECK 0x20 -#define EFI_NON_DEVICE_CLASS 0x00 ///< Useful when you do not want something in the Device Manager +#define EFI_NON_DEVICE_CLASS 0x00 ///< Useful when you do not want something in the Device Manager. #define EFI_DISK_DEVICE_CLASS 0x01 #define EFI_VIDEO_DEVICE_CLASS 0x02 #define EFI_NETWORK_DEVICE_CLASS 0x04 @@ -90,11 +84,11 @@ typedef UINT16 STRING_REF; #define EFI_SETUP_APPLICATION_SUBCLASS 0x00 #define EFI_GENERAL_APPLICATION_SUBCLASS 0x01 #define EFI_FRONT_PAGE_SUBCLASS 0x02 -#define EFI_SINGLE_USE_SUBCLASS 0x03 ///< Used to display a single entity and then exit +#define EFI_SINGLE_USE_SUBCLASS 0x03 ///< Used to display a single entity ,and then exit. /// /// Used to flag dynamically created op-codes. This is meaningful to the IFR Library set -/// and the browser since we need to distinguish between compiled NV map data and created data. +/// and the browser because we need to distinguish between compiled NV map data and created data. /// We do not allow new entries to be created in the NV map dynamically, but we do need /// to display this information correctly. To dynamically create op-codes and assume that their /// data will be saved, ensure that the NV starting location they refer to is pre-defined in the @@ -120,7 +114,7 @@ typedef struct { EFI_PHYSICAL_ADDRESS CallbackHandle; UINT16 Class; UINT16 SubClass; - UINT16 NvDataSize; ///< set once, size of the NV data as defined in the script + UINT16 NvDataSize; ///< Set once; the size of the NV data as defined in the script. } FRAMEWORK_EFI_IFR_FORM_SET; typedef struct { @@ -145,7 +139,7 @@ typedef struct { STRING_REF Text; STRING_REF TextTwo; UINT8 Flags; ///< This is included solely for purposes of interactive/dynamic support. - UINT16 Key; ///< Value to be passed to caller to identify this particular op-code + UINT16 Key; ///< The value to be passed to the caller to identify this particular op-code. } FRAMEWORK_EFI_IFR_TEXT; // @@ -155,9 +149,9 @@ typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; UINT16 FormId; STRING_REF Prompt; - STRING_REF Help; ///< The string Token for the context-help + STRING_REF Help; ///< The string Token for the context-help. UINT8 Flags; ///< This is included solely for purposes of interactive/dynamic support. - UINT16 Key; ///< Value to be passed to caller to identify this particular op-code + UINT16 Key; ///< The value to be passed to the caller to identify this particular op-code. } FRAMEWORK_EFI_IFR_REF; typedef struct { @@ -175,55 +169,55 @@ typedef struct { typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; UINT16 QuestionId; ///< The ID designating what the question is about... - UINT8 Width; ///< The Size of the Data being saved - STRING_REF Prompt; ///< The String Token for the Prompt - STRING_REF Help; ///< The string Token for the context-help + UINT8 Width; ///< The Size of the Data being saved. + STRING_REF Prompt; ///< The String Token for the Prompt. + STRING_REF Help; ///< The string Token for the context-help. } FRAMEWORK_EFI_IFR_ONE_OF; typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; - UINT16 QuestionId; ///< The offset in NV for storage of the data - UINT8 MaxEntries; ///< The maximum number of options in the ordered list (=size of NVStore) - STRING_REF Prompt; ///< The string token for the prompt - STRING_REF Help; ///< The string token for the context-help + UINT16 QuestionId; ///< The offset in NV for storage of the data. + UINT8 MaxEntries; ///< The maximum number of options in the ordered list (=size of NVStore). + STRING_REF Prompt; ///< The string token for the prompt. + STRING_REF Help; ///< The string token for the context-help. } FRAMEWORK_EFI_IFR_ORDERED_LIST; typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; UINT16 QuestionId; ///< The ID designating what the question is about... - UINT8 Width; ///< The Size of the Data being saved - STRING_REF Prompt; ///< The String Token for the Prompt - STRING_REF Help; ///< The string Token for the context-help - UINT8 Flags; ///< If non-zero, means that it is the default option - UINT16 Key; ///< Value to be passed to caller to identify this particular op-code + UINT8 Width; ///< The Size of the Data being saved. + STRING_REF Prompt; ///< The String Token for the Prompt. + STRING_REF Help; ///< The string Token for the context-help. + UINT8 Flags; ///< If non-zero, it means that it is the default option. + UINT16 Key; ///< Value to be passed to caller to identify this particular op-code. } FRAMEWORK_EFI_IFR_CHECKBOX, EFI_IFR_CHECK_BOX; typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; - STRING_REF Option; ///< The string token describing the option - UINT16 Value; ///< The value associated with this option that is stored in the NVRAM - UINT8 Flags; ///< If non-zero, means that it is the default option - UINT16 Key; ///< Value to be passed to caller to identify this particular op-code + STRING_REF Option; ///< The string token describing the option. + UINT16 Value; ///< The value associated with this option that is stored in the NVRAM. + UINT8 Flags; ///< If non-zero, it means that it is the default option. + UINT16 Key; ///< Value to be passed to caller to identify this particular op-code. } FRAMEWORK_EFI_IFR_ONE_OF_OPTION; typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; UINT16 QuestionId; ///< The ID designating what the question is about... - UINT8 Width; ///< The Size of the Data being saved - STRING_REF Prompt; ///< The String Token for the Prompt - STRING_REF Help; ///< The string Token for the context-help + UINT8 Width; ///< The Size of the Data being saved. + STRING_REF Prompt; ///< The String Token for the Prompt. + STRING_REF Help; ///< The string Token for the context-help. UINT8 Flags; ///< This is included solely for purposes of interactive/dynamic support. - UINT16 Key; ///< Value to be passed to caller to identify this particular op-code + UINT16 Key; ///< The value to be passed to caller to identify this particular op-code. UINT16 Minimum; UINT16 Maximum; - UINT16 Step; ///< Zero means manual input, otherwise, arrow selection is called for + UINT16 Step; ///< Zero means manual input. Otherwise, arrow selection is called for. UINT16 Default; } FRAMEWORK_EFI_IFR_NUMERIC; // // There is an interesting twist with regards to Time and Date. This is one of the few items which can accept input -// from a user, and may or may not need to use storage in the NVRAM space. The decided method for determining -// if NVRAM space will be used (only for a TimeOp or DateOp) is: If .QuestionId == 0 && .Width == 0 (normally an +// from a user, and may or may not need to use storage in the NVRAM space. The decided method for determining +// if NVRAM space will be used (only for a TimeOp or DateOp) is: If .QuestionId == 0 && .Width == 0 (normally an // impossibility) then use system resources to store the data away and not NV resources. In other words, the setup // engine will call gRT->SetTime, and gRT->SetDate for the saving of data, and the values displayed will be from the // gRT->GetXXXX series of calls. @@ -243,26 +237,26 @@ typedef struct { typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; UINT16 QuestionId;///< The ID designating what the question is about... - UINT8 Width; ///< The Size of the Data being saved - STRING_REF Prompt; ///< The String Token for the Prompt - STRING_REF Help; ///< The string Token for the context-help + UINT8 Width; ///< The Size of the Data being saved. + STRING_REF Prompt; ///< The String Token for the Prompt. + STRING_REF Help; ///< The string Token for the context-help. UINT8 Flags; ///< This is included solely for purposes of interactive/dynamic support. - UINT16 Key; ///< Value to be passed to caller to identify this particular op-code - UINT8 MinSize; ///< Minimum allowable sized password - UINT8 MaxSize; ///< Maximum allowable sized password + UINT16 Key; ///< The value to be passed to caller to identify this particular op-code. + UINT8 MinSize; ///< Minimum allowable sized password. + UINT8 MaxSize; ///< Maximum allowable sized password. UINT16 Encoding; } FRAMEWORK_EFI_IFR_PASSWORD; typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; UINT16 QuestionId; ///< The ID designating what the question is about... - UINT8 Width; ///< The Size of the Data being saved - STRING_REF Prompt; ///< The String Token for the Prompt - STRING_REF Help; ///< The string Token for the context-help + UINT8 Width; ///< The Size of the Data being saved. + STRING_REF Prompt; ///< The String Token for the Prompt. + STRING_REF Help; ///< The string Token for the context-help. UINT8 Flags; ///< This is included solely for purposes of interactive/dynamic support. - UINT16 Key; ///< Value to be passed to caller to identify this particular op-code - UINT8 MinSize; ///< Minimum allowable sized password - UINT8 MaxSize; ///< Maximum allowable sized password + UINT16 Key; ///< The value to be passed to caller to identify this particular op-code. + UINT8 MinSize; ///< Minimum allowable sized password. + UINT8 MaxSize; ///< Maximum allowable sized password. } FRAMEWORK_EFI_IFR_STRING; typedef struct { @@ -277,7 +271,7 @@ typedef struct { /// /// Inconsistent with specification here: -/// Following defintion may not comply with Framework Specification HII 0.92. To +/// The following defintion may not comply with Framework Specification HII 0.92. To /// keep the inconsistant is for implementation needed. ///@{ typedef struct { @@ -298,30 +292,30 @@ typedef struct { typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; - UINT16 QuestionId; ///< offset into variable storage - UINT8 Width; ///< size of variable storage - UINT16 Value; ///< value to compare against + UINT16 QuestionId; ///< The offset into variable storage. + UINT8 Width; ///< The size of variable storage. + UINT16 Value; ///< The value to compare against. } FRAMEWORK_EFI_IFR_EQ_ID_VAL; typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; - UINT16 QuestionId; ///< offset into variable storage - UINT8 Width; ///< size of variable storage + UINT16 QuestionId; ///< The offset into variable storage. + UINT8 Width; ///< The size of variable storage. UINT16 ListLength; UINT16 ValueList[1]; } FRAMEWORK_EFI_IFR_EQ_ID_LIST; typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; - UINT16 QuestionId1; ///< offset into variable storage for first value to compare - UINT8 Width; ///< size of variable storage (must be same for both) - UINT16 QuestionId2; ///< offset into variable storage for second value to compare + UINT16 QuestionId1; ///< The offset into variable storage for first value to compare. + UINT8 Width; ///< The size of variable storage (must be same for both). + UINT16 QuestionId2; ///< The offset into variable storage for second value to compare. } FRAMEWORK_EFI_IFR_EQ_ID_ID; typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; - UINT16 VariableId; ///< offset into variable storage - UINT16 Value; ///< value to compare against + UINT16 VariableId; ///< The offset into variable storage. + UINT16 Value; ///< The value to compare against. } EFI_IFR_EQ_VAR_VAL; ///@} @@ -354,19 +348,19 @@ typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; STRING_REF Help; STRING_REF Text; - STRING_REF TextTwo; ///< optional text + STRING_REF TextTwo; ///< Optional text. } EFI_IFR_INVENTORY; typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; - EFI_GUID Guid; ///< GUID for the variable - UINT16 VarId; ///< variable store ID, as referenced elsewhere in the form - UINT16 Size; ///< size of the variable storage + EFI_GUID Guid; ///< GUID for the variable. + UINT16 VarId; ///< The variable store ID, as referenced elsewhere in the form. + UINT16 Size; ///< The size of the variable storage. } FRAMEWORK_EFI_IFR_VARSTORE; typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; - UINT16 VarId; ///< variable store ID, as referenced elsewhere in the form + UINT16 VarId; ///< The variable store ID, as referenced elsewhere in the form. } EFI_IFR_VARSTORE_SELECT; /// @@ -377,20 +371,20 @@ typedef struct { /// typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; - UINT16 VarId; ///< variable store ID, as referenced elsewhere in the form - UINT16 SecondaryVarId; ///< variable store ID, as referenced elsewhere in the form + UINT16 VarId; ///< The variable store ID, as referenced elsewhere in the form. + UINT16 SecondaryVarId; ///< The variable store ID, as referenced elsewhere in the form. } EFI_IFR_VARSTORE_SELECT_PAIR; /// -/// Save defaults and restore defaults have same structure +/// Save defaults and restore defaults have same structure. /// #define EFI_IFR_RESTORE_DEFAULTS EFI_IFR_SAVE_DEFAULTS typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; - STRING_REF Title; ///< The string token for the banner title - UINT16 LineNumber; ///< 1-based line number - UINT8 Alignment; ///< left, center, or right-aligned + STRING_REF Title; ///< The string token for the banner title. + UINT16 LineNumber; ///< 1-based line number. + UINT8 Alignment; ///< Left, center, or right-aligned. } EFI_IFR_BANNER; #define EFI_IFR_BANNER_ALIGN_LEFT 0