// EFI_GRAPHICS_OUTPUT_BLT_PIXEL is defined in MdePkg/Protocol/GraphicsOutput.h\r
//\r
#include <Protocol/GraphicsOutput.h>\r
-////// In both EDK and EDK II, incompatbile change is done to Framework HII protocol. /// This change should cause a change of GUID in both of code and HII spec. But we /// update the GUID in code in EDK and EDK II. The 0.92 spec is not updated. This/// is a known issue.///////// Note that EFI_HII_PROTOCOL_GUID is different from that defined in the Framework HII/// 0.92 spec because the spec changed part of HII interfaces but did not update the protocol/// GUID.///#define EFI_HII_PROTOCOL_GUID \\r
+///\r
+/// In both EDK and EDK II, incompatbile change is done to Framework HII protocol.\r
+/// This change should cause a change of GUID in both of code and HII spec. But we\r
+/// update the GUID in code in EDK and EDK II. The 0.92 spec is not updated. This\r
+/// is a known issue.\r
+///\r
+///\r
+/// Note that EFI_HII_PROTOCOL_GUID is different from that defined in the Framework HII\r
+/// 0.92 spec because the spec changed part of HII interfaces but did not update the protocol\r
+/// GUID.\r
+///\r
+#define EFI_HII_PROTOCOL_GUID \\r
{ \\r
0xd7ad636e, 0xb997, 0x459b, {0xbf, 0x3f, 0x88, 0x46, 0x89, 0x79, 0x80, 0xe1} \\r
}\r
UINT16 Type; ///< The type of the package.\r
} EFI_HII_PACK_HEADER;\r
\r
-////// IFR package structure./// Immediately following the EFI_HII_IFR_PACK structure will be a series of IFR opcodes. ///typedef struct {\r
+///\r
+/// IFR package structure.\r
+/// Immediately following the EFI_HII_IFR_PACK structure will be a series of IFR opcodes.\r
+///\r
+typedef struct {\r
EFI_HII_PACK_HEADER Header; ///< Header of the IFR package.\r
} EFI_HII_IFR_PACK;\r
\r
///\r
/// HII Handle package structure.\r
-/// \r
+///\r
typedef struct {\r
- /// /// Header of the package. /// EFI_HII_PACK_HEADER Header; // Must be filled in /// /// The image handle of the driver to which the package is referring. /// EFI_HANDLE ImageHandle; // Must be filled in ///\r
+ ///\r
+ /// Header of the package.\r
+ ///\r
+ EFI_HII_PACK_HEADER Header; ///< Must be filled in\r
+ ///\r
+ /// The image handle of the driver to which the package is referring.\r
+ ///\r
+ EFI_HANDLE ImageHandle; ///< Must be filled in\r
+ ///\r
/// The handle of the device that is being described by this package.\r
///\r
- EFI_HANDLE DeviceHandle; // Optional\r
+ EFI_HANDLE DeviceHandle; ///< Optional\r
///\r
/// The handle of the parent of the device that is being described by this package.\r
///\r
- EFI_HANDLE ControllerHandle; // Optional\r
+ EFI_HANDLE ControllerHandle; ///< Optional\r
///\r
/// The handle that was registered to receive EFI_FORM_CALLBACK_PROTOCOL calls from other drivers.\r
///\r
- EFI_HANDLE CallbackHandle; // Optional\r
+ EFI_HANDLE CallbackHandle; ///< Optional\r
///\r
/// Note this field is not defined in the Framework HII 0.92 spec.\r
/// Unused. Reserved for source code compatibility.\r
///\r
- EFI_HANDLE COBExportHandle; // Optional\r
+ EFI_HANDLE COBExportHandle; ///< Optional\r
} EFI_HII_HANDLE_PACK;\r
\r
///\r
/// Variable package structure.\r
-/// \r
+///\r
typedef struct {\r
///\r
/// Header of the package.\r
\r
typedef struct {\r
///\r
- /// Unique value that correlates to the original HII handle. \r
+ /// Unique value that correlates to the original HII handle.\r
///\r
FRAMEWORK_EFI_HII_HANDLE HiiHandle;\r
///\r
/// If an IFR pack exists in a data table that does not contain strings,\r
- /// then the strings for that IFR pack are located in another data table \r
- /// that contains a string pack and has a matching HiiDataTable.PackageGuid. \r
+ /// then the strings for that IFR pack are located in another data table\r
+ /// that contains a string pack and has a matching HiiDataTable.PackageGuid.\r
///\r
EFI_GUID PackageGuid;\r
///\r
///\r
UINT32 IfrDataOffset;\r
///\r
- /// Byte offset from the start of this structure to the string data. \r
+ /// Byte offset from the start of this structure to the string data.\r
/// If the offset value is 0, then no string data is enclosed.\r
///\r
UINT32 StringDataOffset;\r
///\r
typedef struct {\r
///\r
- /// If TRUE, indicates that the FormCallbackHandle value will \r
+ /// If TRUE, indicates that the FormCallbackHandle value will\r
/// be used to update the contents of the CallBackHandle entry in the form set.\r
///\r
BOOLEAN FormSetUpdate;\r
///\r
/// This parameter is valid only when FormSetUpdate is TRUE.\r
- /// The value in this parameter will be used to update the contents \r
+ /// The value in this parameter will be used to update the contents\r
/// of the CallbackHandle entry in the form set.\r
///\r
EFI_PHYSICAL_ADDRESS FormCallbackHandle;\r
///\r
- /// If TRUE, indicates that the FormTitle contents will be \r
+ /// If TRUE, indicates that the FormTitle contents will be\r
/// used to update the FormValue's title.\r
///\r
BOOLEAN FormUpdate;\r
UINT16 FormValue;\r
///\r
/// This parameter is valid only when the FormUpdate parameter is TRUE.\r
- /// The value in this parameter will be used to update the contents of the form title. \r
+ /// The value in this parameter will be used to update the contents of the form title.\r
///\r
STRING_REF FormTitle;\r
///\r
//\r
#define LANG_RIGHT_TO_LEFT 0x00000001\r
\r
-////// A string package is used to localize strings to a particular/// language. The package is associated with a particular driver/// or set of drivers. Tools are used to associate tokens with/// string references in forms and in programs. These tokens are/// language agnostic. When paired with a language pack (directly/// or indirectly), the string token resolves into an actual/// UNICODE string. The NumStringPointers determines how many/// StringPointers (offset values) there are as well as the total/// number of Strings that are defined.///typedef struct {\r
+///\r
+/// A string package is used to localize strings to a particular\r
+/// language. The package is associated with a particular driver\r
+/// or set of drivers. Tools are used to associate tokens with\r
+/// string references in forms and in programs. These tokens are\r
+/// language agnostic. When paired with a language pack (directly\r
+/// or indirectly), the string token resolves into an actual\r
+/// UNICODE string. The NumStringPointers determines how many\r
+/// StringPointers (offset values) there are as well as the total\r
+/// number of Strings that are defined.\r
+///\r
+typedef struct {\r
///\r
/// Header of the package.\r
///\r
///\r
/// The string containing one or more ISO 639-2 three-character designator(s)\r
/// of the language or languages whose translations are contained in this language pack.\r
- /// The first designator indicates the primary language while the others are secondary languages. \r
+ /// The first designator indicates the primary language while the others are secondary languages.\r
///\r
RELOFST LanguageNameString;\r
///\r
//EFI_WIDE_GLYPH WideGlyphs[];\r
} EFI_HII_FONT_PACK;\r
\r
-////// The definition of a specific physical key////// Note: Name difference between code and the Framework HII 0.92 spec./// Add FRAMEWORK_ prefix to avoid name confict with EFI_KEY_DESCRIPTOR defined in the/// UEFI 2.1d spec.///typedef struct {\r
+///\r
+/// The definition of a specific physical key\r
+///\r
+/// Note: Name difference between code and the Framework HII 0.92 spec.\r
+/// Add FRAMEWORK_ prefix to avoid name confict with EFI_KEY_DESCRIPTOR defined in the\r
+/// UEFI 2.1d spec.\r
+///\r
+typedef struct {\r
///\r
/// Used to describe a physical key on a keyboard.\r
///\r
///\r
CHAR16 ShiftedAltGrUnicode;\r
///\r
- /// Modifier keys are defined to allow for special functionality that \r
- /// is not necessarily accomplished by a printable character. \r
+ /// Modifier keys are defined to allow for special functionality that\r
+ /// is not necessarily accomplished by a printable character.\r
///\r
UINT16 Modifier;\r
} FRAMEWORK_EFI_KEY_DESCRIPTOR;\r
\r
-////// This structure allows a sparse set of keys to be redefined/// or a complete redefinition of the keyboard layout. Most/// keyboards have a lot of commonality in their layouts, therefore/// only defining those keys that need to change from the default/// minimizes the passed in information.////// Additionally, when an update occurs, the active keyboard layout/// will be switched to the newly updated keyboard layout. This/// allows for situations that when a keyboard layout driver is/// loaded as part of system initialization, the system will default/// the keyboard behavior to the new layout.///typedef struct {\r
+///\r
+/// This structure allows a sparse set of keys to be redefined\r
+/// or a complete redefinition of the keyboard layout. Most\r
+/// keyboards have a lot of commonality in their layouts, therefore\r
+/// only defining those keys that need to change from the default\r
+/// minimizes the passed in information.\r
+///\r
+/// Additionally, when an update occurs, the active keyboard layout\r
+/// will be switched to the newly updated keyboard layout. This\r
+/// allows for situations that when a keyboard layout driver is\r
+/// loaded as part of system initialization, the system will default\r
+/// the keyboard behavior to the new layout.\r
+///\r
+typedef struct {\r
///\r
/// Header of the package.\r
EFI_HII_PACK_HEADER Header;\r
///\r
typedef struct _EFI_HII_VARIABLE_PACK_LIST {\r
///\r
- /// A pointer points to the next data structure of type \r
+ /// A pointer points to the next data structure of type\r
/// EFI_HII_VARIABLE_PACK_LIST in the packed link list.\r
///\r
struct _EFI_HII_VARIABLE_PACK_LIST *NextVariablePack;\r
/// Extracts the various packs from a package list.\r
///\r
EFI_HII_NEW_PACK NewPack;\r
- \r
+\r
///\r
/// Removes a package from the HII database.\r
///\r
EFI_HII_REMOVE_PACK RemovePack;\r
- \r
+\r
///\r
/// Determines the handles that are currently active in the database.\r
- /// \r
+ ///\r
EFI_HII_FIND_HANDLES FindHandles;\r
- \r
+\r
///\r
/// Export the entire contents of the database to a buffer.\r
///\r
/// Tests if all of the characters in a string have corresponding font characters.\r
///\r
EFI_HII_TEST_STRING TestString;\r
- \r
+\r
///\r
/// Translates a Unicode character into the corresponding font glyph.\r
///\r
FRAMEWORK_EFI_HII_GET_GLYPH GetGlyph;\r
- \r
+\r
///\r
/// Converts a glyph value into a format that is ready for a UGA BLT command.\r
///\r
/// Allows a new string to be added to an already existing string package.\r
///\r
FRAMEWORK_EFI_HII_NEW_STRING NewString;\r
- \r
+\r
///\r
/// Allows a program to determine the primary languages that are supported\r
- /// on a given handle. \r
+ /// on a given handle.\r
///\r
EFI_HII_GET_PRI_LANGUAGES GetPrimaryLanguages;\r
- \r
+\r
///\r
/// Allows a program to determine which secondary languages are supported\r
- /// on a given handle for a given primary language. \r
+ /// on a given handle for a given primary language.\r
///\r
EFI_HII_GET_SEC_LANGUAGES GetSecondaryLanguages;\r
- \r
+\r
///\r
/// Extracts a string from a package that is already registered with the\r
- /// EFI HII database. \r
+ /// EFI HII database.\r
///\r
FRAMEWORK_EFI_HII_GET_STRING GetString;\r
- \r
+\r
///\r
/// Remove any new strings that were added after the initial string export\r
- /// for this handle. \r
- /// \r
+ /// for this handle.\r
+ ///\r
/// Note this function is not defined in the Framework HII 0.92 spec.\r
///\r
EFI_HII_RESET_STRINGS ResetStrings;\r
- \r
+\r
///\r
/// Allows a program to extract a part of a string of not more than a given width.\r
///\r
EFI_HII_GET_LINE GetLine;\r
- \r
+\r
///\r
/// Allows a program to extract a form or form package that has been previously registered.\r
///\r
EFI_HII_GET_FORMS GetForms;\r
- \r
+\r
///\r
/// Allows a program to extract the nonvolatile image that represents the default storage image.\r
///\r
EFI_HII_GET_DEFAULT_IMAGE GetDefaultImage;\r
- \r
+\r
///\r
/// Allows a program to update a previously registered form.\r
///\r
projects / mirror_edk2.git / commitdiff