+++ /dev/null
-/** @file\r
- This file defines the Human Interface Infrastructure protocol, which is\r
- used by resources that want to publish IFR/Font/String data and have it\r
- collected by the Configuration engine.\r
-\r
-Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
-SPDX-License-Identifier: BSD-2-Clause-Patent\r
-\r
- @par Revision Reference:\r
- This protocol is defined in Framework for EFI Human Interface Infrastructure\r
- Specification Version 0.92.\r
-\r
-**/\r
-\r
-#ifndef _FRAMEWORK_HII_H_\r
-#define _FRAMEWORK_HII_H_\r
-\r
-//\r
-// EFI_GRAPHICS_OUTPUT_BLT_PIXEL is defined in MdePkg/Protocol/GraphicsOutput.h\r
-//\r
-#include <Protocol/GraphicsOutput.h>\r
-///\r
-/// In both EDK and EDK II, there is an incompatbile change in the Framework HII protocol.\r
-/// This change should cause a change of GUID in both of code and HII specification. But we\r
-/// updated the GUID in code in EDK and EDK II. The 0.92 specification 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 specification because the specification 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
-\r
-#define EFI_HII_COMPATIBILITY_PROTOCOL_GUID \\r
- { \\r
- 0x5542cce1, 0xdf5c, 0x4d1b, { 0xab, 0xca, 0x36, 0x4f, 0x77, 0xd3, 0x99, 0xfb } \\r
- }\r
-\r
-typedef UINT32 RELOFST;\r
-\r
-typedef struct _EFI_HII_PROTOCOL EFI_HII_PROTOCOL;\r
-\r
-///\r
-/// Note: Name difference between code and the Framework HII 0.92 specificaiton.\r
-/// Add FRAMEWORK_ prefix to avoid a name confict with EFI_HII_HANDLE, defined in the\r
-/// UEFI 2.1d specification.\r
-///\r
-typedef UINT16 FRAMEWORK_EFI_HII_HANDLE;\r
-\r
-///\r
-/// HII package type values\r
-///\r
-#define EFI_HII_FONT 1\r
-#define EFI_HII_STRING 2\r
-#define EFI_HII_IFR 3\r
-#define EFI_HII_KEYBOARD 4\r
-#define EFI_HII_HANDLES 5\r
-#define EFI_HII_VARIABLE 6\r
-#define EFI_HII_DEVICE_PATH 7\r
-\r
-//\r
-// References to string tokens must use this macro to enable scanning for\r
-// token usages.\r
-//\r
-#define STRING_TOKEN(t) t\r
-\r
-//\r
-// The following types are currently defined:\r
-// EFI_FORM_ID has been defined in UEFI spec.\r
-//\r
-typedef UINT16 EFI_FORM_LABEL;\r
-\r
-#pragma pack(1)\r
-\r
-///\r
-/// The header found at the start of each package.\r
-///\r
-typedef struct {\r
- UINT32 Length; ///< The size of the package in bytes.\r
- UINT16 Type; ///< The type of the package.\r
-} EFI_HII_PACK_HEADER;\r
-\r
-///\r
-/// The 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
-typedef struct {\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
- ///\r
- /// The handle of the parent of the device that is being described by this package.\r
- ///\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
- ///\r
- /// Note this field is not defined in the Framework HII 0.92 specificaiton.\r
- /// Unused. Reserved for source code compatibility.\r
- ///\r
- EFI_HANDLE COBExportHandle; ///< Optional.\r
-} EFI_HII_HANDLE_PACK;\r
-\r
-///\r
-/// The variable package structure.\r
-///\r
-typedef struct {\r
- ///\r
- /// The header of the package.\r
- ///\r
- EFI_HII_PACK_HEADER Header;\r
- ///\r
- /// The GUID of the EFI variable.\r
- ///\r
- EFI_GUID VariableGuid;\r
- ///\r
- /// The length in bytes of the EFI variable.\r
- ///\r
- UINT32 VariableNameLength;\r
- ///\r
- /// The unique value for this variable.\r
- ///\r
- UINT16 VariableId;\r
- //\r
- // CHAR16 VariableName[]; //Null-terminated\r
- //\r
-} EFI_HII_VARIABLE_PACK;\r
-\r
-///\r
-/// The device path package structure.\r
-///\r
-typedef struct {\r
- ///\r
- /// The header of the package.\r
- ///\r
- EFI_HII_PACK_HEADER Header;\r
- //\r
- // EFI_DEVICE_PATH DevicePath[];\r
- //\r
-} EFI_HII_DEVICE_PATH_PACK;\r
-\r
-typedef struct {\r
- ///\r
- /// A 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
- ///\r
- EFI_GUID PackageGuid;\r
- ///\r
- /// The size of the EFI_HII_DATA_TABLE in bytes.\r
- ///\r
- UINT32 DataTableSize;\r
- ///\r
- /// The byte offset from the start of this structure to the IFR data.\r
- /// If the offset value is 0, then no IFR data is enclosed.\r
- ///\r
- UINT32 IfrDataOffset;\r
- ///\r
- /// The 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
- /// The byte offset from the start of this structure to the variable data.\r
- /// If the offset value is 0, then no variable data is enclosed.\r
- ///\r
- UINT32 VariableDataOffset;\r
- ///\r
- /// The byte offset from the start of this structure to the device path data.\r
- /// If the offset value is 0, then no DevicePath data is enclosed.\r
- ///\r
- UINT32 DevicePathOffset;\r
- ///\r
- /// The number of VariableData[] elements in the array.\r
- ///\r
- UINT32 NumberOfVariableData;\r
- ///\r
- /// The number of language string packages.\r
- ///\r
- UINT32 NumberOfLanguages;\r
- //\r
- // EFI_HII_DEVICE_PATH_PACK DevicePath[];\r
- // EFI_HII_VARIABLE_PACK VariableData[];\r
- // EFI_HII_IFR_PACK IfrData;\r
- // EFI_HII_STRING_PACK StringData[];\r
- //\r
-} EFI_HII_DATA_TABLE;\r
-\r
-///\r
-/// The structure defining the format for exporting data from the HII Database.\r
-///\r
-typedef struct {\r
- ///\r
- /// Number of EFI_HII_DATA_TABLE entries.\r
- ///\r
- UINT32 NumberOfHiiDataTables;\r
- ///\r
- /// Defines the revision of the EFI_HII_DATA_TABLE structure.\r
- ///\r
- EFI_GUID Revision;\r
- //\r
- // EFI_HII_DATA_TABLE HiiDataTable[];\r
- //\r
-} EFI_HII_EXPORT_TABLE;\r
-\r
-///\r
-/// The structure used to pass data to update a form or form package\r
-/// that has previously been registered with the EFI HII database.\r
-///\r
-typedef struct {\r
- ///\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
- /// 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
- /// used to update the FormValue's title.\r
- ///\r
- BOOLEAN FormUpdate;\r
- ///\r
- /// Specifies which form is to be updated if the FormUpdate value is TRUE.\r
- ///\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
- ///\r
- STRING_REF FormTitle;\r
- ///\r
- /// The number of Data entries in this structure.\r
- UINT16 DataCount;\r
- ///\r
- /// An array of 1+ opcodes, specified by DataCount.\r
- ///\r
- UINT8 *Data;\r
-} EFI_HII_UPDATE_DATA;\r
-\r
-//\r
-// String attributes\r
-//\r
-#define LANG_RIGHT_TO_LEFT 0x00000001\r
-\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. 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
- /// The header of the package.\r
- ///\r
- EFI_HII_PACK_HEADER Header;\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
- ///\r
- RELOFST LanguageNameString;\r
- ///\r
- /// Contains the offset into this structure of a printable name of the language\r
- /// for use when prompting the user. The language printed is to be the primary language.\r
- ///\r
- RELOFST PrintableLanguageName;\r
- ///\r
- /// The number of Strings and StringPointers contained within the string package.\r
- ///\r
- UINT32 NumStringPointers;\r
- ///\r
- /// Indicates the direction the language is to be printed.\r
- ///\r
- UINT32 Attributes;\r
- //\r
- // RELOFST StringPointers[];\r
- // EFI_STRING Strings[];\r
- //\r
-} EFI_HII_STRING_PACK;\r
-\r
-\r
-///\r
-/// A font list consists of a font header followed by a series\r
-/// of glyph structures. Note that fonts are not language specific.\r
-///\r
-typedef struct {\r
- ///\r
- /// The header of the package.\r
- ///\r
- EFI_HII_PACK_HEADER Header;\r
- ///\r
- /// The number of NarrowGlyphs that are included in the font package.\r
- ///\r
- UINT16 NumberOfNarrowGlyphs;\r
- ///\r
- /// The number of WideGlyphs that are included in the font package.\r
- ///\r
- UINT16 NumberOfWideGlyphs;\r
- //EFI_NARROW_GLYPH NarrowGlyphs[];\r
- //EFI_WIDE_GLYPH WideGlyphs[];\r
-} EFI_HII_FONT_PACK;\r
-\r
-///\r
-/// The definition of a specific physical key\r
-///\r
-/// Note: The name difference between code and the Framework HII 0.92 specification.\r
-/// Add FRAMEWORK_ prefix to avoid name confict with EFI_KEY_DESCRIPTOR defined in the\r
-/// UEFI 2.1d specification.\r
-///\r
-typedef struct {\r
- ///\r
- /// Used to describe a physical key on a keyboard.\r
- ///\r
- EFI_KEY Key;\r
- ///\r
- /// The Unicode value for the Key.\r
- CHAR16 Unicode;\r
- ///\r
- /// The Unicode value for the key with the shift key being held down.\r
- ///\r
- CHAR16 ShiftedUnicode;\r
- ///\r
- /// The Unicode value for the key with the Alt-GR being held down.\r
- ///\r
- CHAR16 AltGrUnicode;\r
- ///\r
- /// The Unicode value for the key with the Alt-GR and shift keys being held down.\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
- ///\r
- UINT16 Modifier;\r
-} FRAMEWORK_EFI_KEY_DESCRIPTOR;\r
-\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
- /// The header of the package.\r
- EFI_HII_PACK_HEADER Header;\r
- ///\r
- /// A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR entries.\r
- /// Each entry will reflect the definition of a specific physical key.\r
- ///\r
- FRAMEWORK_EFI_KEY_DESCRIPTOR *Descriptor;\r
- ///\r
- /// The number of Descriptor entries being described.\r
- ///\r
- UINT8 DescriptorCount;\r
-} EFI_HII_KEYBOARD_PACK;\r
-\r
-///\r
-/// The packages structure that will be used to pass contents into the HII database.\r
-///\r
-/// The EFI_HII_PACKAGES can contain various number of packages of different types just\r
-/// after the structure as inline data.\r
-///\r
-typedef struct {\r
- ///\r
- /// The number of packages being defined in this structure.\r
- ///\r
- UINTN NumberOfPackages;\r
- ///\r
- /// The GUID to be used to identify this set of packages that are being exported\r
- /// to the HII database.\r
- ///\r
- EFI_GUID *GuidId;\r
- //\r
- // EFI_HII_HANDLE_PACK *HandlePack; // Only one pack.\r
- // EFI_HII_IFR_PACK *IfrPack; // Only one pack.\r
- // EFI_HII_FONT_PACK *FontPack[]; // Multiple packs ok\r
- // EFI_HII_STRING_PACK *StringPack[]; // Multiple packs ok\r
- // EFI_HII_KEYBOARD_PACK *KeyboardPack[]; // Multiple packs ok\r
- //\r
-} EFI_HII_PACKAGES;\r
-\r
-///\r
-/// The packed link list that contains all the discernable defaults of variables\r
-/// for the opcodes that are defined in this Handle's domain of data.\r
-///\r
-typedef struct _EFI_HII_VARIABLE_PACK_LIST {\r
- ///\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
- ///\r
- /// A pointer points to the content of the variable entry defined by GUID/name/data.\r
- ///\r
- EFI_HII_VARIABLE_PACK *VariablePack;\r
- //EFI_HII_VARIABLE_PACK Content\r
-} EFI_HII_VARIABLE_PACK_LIST;\r
-\r
-\r
-#pragma pack()\r
-\r
-/**\r
- Registers the various packs that are passed in via the Packages parameter.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Packages A pointer to an EFI_HII_PACKAGES package instance.\r
- @param Handle A pointer to the FRAMEWORK_EFI_HII_HANDLE instance.\r
-\r
- @retval EFI_SUCCESS Data was extracted from Packages, the database\r
- was updated with the data, and Handle returned successfully.\r
- @retval EFI_INVALID_PARAMETER The content of Packages was invalid.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_HII_NEW_PACK)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN EFI_HII_PACKAGES *Packages,\r
- OUT FRAMEWORK_EFI_HII_HANDLE *Handle\r
- );\r
-\r
-/**\r
- Removes a package from the HII database.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Handle The handle that was registered to the data that\r
- is requested for removal.\r
-\r
- @retval EFI_SUCCESS The data associated with the Handle was removed\r
- from the HII database.\r
- @retval EFI_INVALID_PARAMETER The Handle was not valid.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_HII_REMOVE_PACK)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN FRAMEWORK_EFI_HII_HANDLE Handle\r
- );\r
-\r
-/**\r
- Determines the handles that are currently active in the database.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param HandleBufferLength On input, a pointer to the length of the handle\r
- buffer. On output, the length of the handle buffer that is required\r
- for the handles found.\r
- @param Handle An array of FRAMEWORK_EFI_HII_HANDLE instances returned.\r
-\r
- @retval EFI_SUCCESS Handle was updated successfully.\r
- @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates\r
- that Handle is too small to support the number of handles.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_HII_FIND_HANDLES)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN OUT UINT16 *HandleBufferLength,\r
- OUT FRAMEWORK_EFI_HII_HANDLE *Handle\r
- );\r
-\r
-/**\r
- Exports the contents of the database into a buffer.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Handle A FRAMEWORK_EFI_HII_HANDLE that corresponds to the desired\r
- handle to export. If the value is 0, the entire database will be exported.\r
- The data is exported in a format described by the\r
- structure definition of EFI_HII_EXPORT_TABLE.\r
- @param BufferSize\r
- On input, a pointer to the length of the buffer. On output, the length\r
- of the buffer that is required for the export data.\r
- @param Buffer A pointer to a buffer that will contain the results of the export function.\r
-\r
- @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.\r
- @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_HII_EXPORT)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
- IN OUT UINTN *BufferSize,\r
- OUT VOID *Buffer\r
- );\r
-\r
-/**\r
- Remove any new strings that were added after the initial string export\r
- for this handle.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Handle The handle on which the string resides.\r
-\r
- @retval EFI_SUCCESS Successfully removed strings from the handle.\r
- @retval EFI_INVALID_PARAMETER The Handle was unknown.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_HII_RESET_STRINGS)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN FRAMEWORK_EFI_HII_HANDLE Handle\r
- );\r
-\r
-/**\r
- Tests if all of the characters in a string have corresponding font characters.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param StringToTest A pointer to a Unicode string.\r
- @param FirstMissing A pointer to an index into the string. On input,\r
- the index of the first character in the StringToTest\r
- to examine. On exit, the index of the first character\r
- encountered for which a glyph is unavailable.\r
- If all glyphs in the string are available, the\r
- index is the index of the terminator of the string.\r
- @param GlyphBufferSize A pointer to a value. On output, if the function\r
- returns EFI_SUCCESS, it contains the amount of\r
- memory that is required to store the string's\r
- glyph equivalent.\r
-\r
- @retval EFI_SUCCESS All glyphs are available. Note that an empty string\r
- always returns this value.\r
- @retval EFI_NOT_FOUND A glyph was not found for a character.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_HII_TEST_STRING)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN CHAR16 *StringToTest,\r
- IN OUT UINT32 *FirstMissing,\r
- OUT UINT32 *GlyphBufferSize\r
- );\r
-\r
-/**\r
- Translates a Unicode character into the corresponding font glyph.\r
-\r
- Note that this function prototype name is different from that in the Framework HII 0.92 specification\r
- to avoid name confict with EFI_HII_GET_GLYPH defined in the UEFI 2.1d specification.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Source A pointer to a Unicode string.\r
- @param Index On input, the offset into the string from which to\r
- fetch the character. On successful completion, the\r
- index is updated to the first character past the\r
- character(s) making up the just extracted glyph.\r
- @param GlyphBuffer Pointer to an array where the glyphs corresponding\r
- to the characters in the source may be stored.\r
- GlyphBuffer is assumed to be wide enough to accept\r
- a wide glyph character.\r
- @param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by\r
- this value is filled with the length of the glyph in\r
- pixels. It is unchanged if the call was unsuccessful.\r
- @param InternalStatus The cell pointed to by this parameter must be\r
- initialized to zero prior to invoking the call the\r
- first time for any string.\r
-\r
- @retval EFI_SUCCESS Found the corresponding font glyph for a Unicode\r
- character.\r
- @retval EFI_NOT_FOUND A glyph for a character was not found.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *FRAMEWORK_EFI_HII_GET_GLYPH)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN CHAR16 *Source,\r
- IN OUT UINT16 *Index,\r
- OUT UINT8 **GlyphBuffer,\r
- OUT UINT16 *BitWidth,\r
- IN OUT UINT32 *InternalStatus\r
- );\r
-\r
-/**\r
- Translates a glyph into the format required for input to the Universal\r
- Graphics Adapter (UGA) Block Transfer (BLT) routines.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param GlyphBuffer A pointer to the buffer that contains glyph data.\r
- @param Foreground The foreground setting requested to be used for the\r
- generated BltBuffer data.\r
- @param Background The background setting requested to be used for the\r
- generated BltBuffer data.\r
- @param Count The entry in the BltBuffer upon which to act.\r
- @param Width The width in bits of the glyph being converted.\r
- @param Height The height in bits of the glyph being converted\r
- @param BltBuffer A pointer to the buffer that contains the data that is\r
- ready to be used by the UGA BLT routines.\r
-\r
- @retval EFI_SUCCESS Successfully translated a glyph into the required\r
- format for input to UGA BLT routines.\r
- @retval EFI_NOT_FOUND A glyph for a character was not found.\r
- @note Inconsistent with specification here:\r
- In Framework Spec, HII specification 0.92. The type of 3rd, 4th and 8th parameter is EFI_UGA_PIXEL.\r
- Here the definition uses the EFI_GRAPHICS_OUTPUT_BLT_PIXEL, which is defined in UEFI 2.1 specification.\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_HII_GLYPH_TO_BLT)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN UINT8 *GlyphBuffer,\r
- IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,\r
- IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background,\r
- IN UINTN Count,\r
- IN UINTN Width,\r
- IN UINTN Height,\r
- IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer\r
- );\r
-\r
-/**\r
- Allows a new string to be added to an already existing string package.\r
-\r
- Note that this function prototype name is different from that in the Framework HII 0.92 specification\r
- to avoid name confict with EFI_HII_NEW_STRING defined in the UEFI 2.1d specification.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Pointer to a NULL-terminated string containing a single\r
- ISO 639-2 language identifier, indicating the language\r
- in which the string is translated.\r
- @param Handle The handle of the language pack to which the string\r
- is to be added.\r
- @param Reference The identifier of the string to be added. If the\r
- reference value is zero, then the string will be\r
- assigned a new identifier on that handle for\r
- the language specified. Otherwise, the string will\r
- be updated with the NewString Value.\r
- @param NewString The string to be added.\r
-\r
- @retval EFI_SUCCESS The string was effectively registered.\r
- @retval EFI_INVALID_PARAMETER The Handle was unknown.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *FRAMEWORK_EFI_HII_NEW_STRING)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN CHAR16 *Language,\r
- IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
- IN OUT STRING_REF *Reference,\r
- IN CHAR16 *NewString\r
- );\r
-\r
-/**\r
- Allows a program to determine the primary languages that are supported\r
- on a given handle.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Handle The handle on which the strings reside.\r
- @param LanguageString A string allocated by GetPrimaryLanguages() that\r
- contains a list of all primary languages registered\r
- on the handle.\r
-\r
- @retval EFI_SUCCESS LanguageString was correctly returned.\r
- @retval EFI_INVALID_PARAMETER The Handle was unknown.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_HII_GET_PRI_LANGUAGES)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
- OUT EFI_STRING *LanguageString\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
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Handle The handle on which the strings reside.\r
- @param PrimaryLanguage Pointer to a NULL-terminated string containing a\r
- single ISO 639-2 language identifier, indicating\r
- the primary language.\r
- @param LanguageString A string allocated by GetSecondaryLanguages()\r
- containing a list of all secondary languages\r
- registered on the handle.\r
-\r
- @retval EFI_SUCCESS LanguageString was correctly returned.\r
- @retval EFI_INVALID_PARAMETER The Handle was unknown.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_HII_GET_SEC_LANGUAGES)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
- IN CHAR16 *PrimaryLanguage,\r
- OUT EFI_STRING *LanguageString\r
- );\r
-\r
-/**\r
- Extracts a string from a package already registered with the EFI HII database.\r
-\r
- Note that this function prototype name is different from that in the Framework HII 0.92 specification\r
- to avoid name confict with EFI_HII_GET_STRING defined in the UEFI 2.1d specification.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Handle The handle on which the string resides.\r
- @param Token The string token assigned to the string.\r
- @param Raw If TRUE, the string is returned unedited in the\r
- internal storage format. If false, the string\r
- returned is edited by replacing <cr> with <space>\r
- and by removing special characters such as the\r
- <wide> prefix.\r
- @param LanguageString Pointer to a NULL-terminated string containing a\r
- single ISO 639-2 language identifier, indicating\r
- the language to print. If the LanguageString is\r
- empty (starts with a NULL), the default system\r
- language will be used to determine the language.\r
- @param BufferLength Length of the StringBuffer.\r
- @param StringBuffer The buffer designed to receive the characters in the string.\r
-\r
- @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.\r
- @retval EFI_INVALID_PARAMETER The handle or string token is unknown.\r
- @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to\r
- allow the entire string to be stored.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *FRAMEWORK_EFI_HII_GET_STRING)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
- IN STRING_REF Token,\r
- IN BOOLEAN Raw,\r
- IN CHAR16 *LanguageString,\r
- IN OUT UINTN *BufferLength,\r
- OUT EFI_STRING StringBuffer\r
- );\r
-\r
-/**\r
- Allows a program to extract a part of a string of not more than a given width.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Handle The handle on which the string resides.\r
- @param Token The string token assigned to the string.\r
- @param Index On input, the offset into the string where the\r
- line is to start. On output, the index is updated\r
- to point beyond the last character returned in\r
- the call.\r
- @param LineWidth The maximum width of the line in units of narrow glyphs.\r
- @param LanguageString The pointer to a NULL-terminated string containing a\r
- single ISO 639-2 language identifier, indicating\r
- the language to print.\r
- @param BufferLength The pointer to the length of the StringBuffer.\r
- @param StringBuffer The buffer designed to receive the characters in\r
- the string.\r
-\r
- @retval EFI_SUCCESS StringBuffer filled with characters that will fit\r
- on the line.\r
- @retval EFI_NOT_FOUND The font glyph for at least one of the characters in\r
- the string is not in the font database.\r
- @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough\r
- to allow the entire string to be stored.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_HII_GET_LINE)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
- IN STRING_REF Token,\r
- IN OUT UINT16 *Index,\r
- IN UINT16 LineWidth,\r
- IN CHAR16 *LanguageString,\r
- IN OUT UINT16 *BufferLength,\r
- OUT EFI_STRING StringBuffer\r
- );\r
-\r
-/**\r
- Allows a program to extract a form or form package that has previously\r
- been registered with the HII database.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Handle Handle on which the form resides.\r
- @param FormId The ID of the form to return. If the ID is zero,\r
- the entire form package is returned.\r
- @param BufferLength On input, the length of the Buffer. On output,\r
- the length of the returned buffer,\r
- @param Buffer The buffer designed to receive the form(s).\r
-\r
- @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength\r
- was updated.\r
- @retval EFI_INVALID_PARAMETER The handle is unknown.\r
- @retval EFI_NOT_FOUND A form on the requested handle cannot be found with\r
- the requested FormId.\r
- @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough\r
- to allow the form to be stored.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_HII_GET_FORMS)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
- IN EFI_FORM_ID FormId,\r
- IN OUT UINTN *BufferLength,\r
- OUT UINT8 *Buffer\r
- );\r
-\r
-/**\r
- Extracts the defaults that are associated with a given handle in the HII database.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Handle The HII handle from which will have default data retrieved.\r
- @param DefaultMask The mask used to specify some type of default\r
- override when extracting the default image data.\r
- @param VariablePackList An indirect pointer to the first entry of a link\r
- list with type EFI_HII_VARIABLE_PACK_LIST.\r
-\r
- @retval EFI_SUCCESS The VariablePackList was populated with the appropriate\r
- default setting data.\r
- @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).\r
- @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle\r
- contains invalid data.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_HII_GET_DEFAULT_IMAGE)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
- IN UINTN DefaultMask,\r
- OUT EFI_HII_VARIABLE_PACK_LIST **VariablePackList\r
- );\r
-\r
-/**\r
- Allows the caller to update a form or form package that has previously been\r
- registered with the EFI HII database.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Handle Handle of the package where the form to be updated resides.\r
- @param Label The label inside the form package where the update is to take place.\r
- @param AddData If TRUE, adding data at a given Label; otherwise,\r
- if FALSE, removing data at a given Label.\r
- @param Data The buffer containing the new tags to insert after the Label\r
-\r
- @retval EFI_SUCCESS The form was updated with the new tags.\r
- @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not\r
- contain an integral number of tags.\r
- @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_HII_UPDATE_FORM)(\r
- IN EFI_HII_PROTOCOL *This,\r
- IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
- IN EFI_FORM_LABEL Label,\r
- IN BOOLEAN AddData,\r
- IN EFI_HII_UPDATE_DATA *Data\r
- );\r
-\r
-/**\r
- Retrieves the current keyboard layout.\r
-\r
- Note that this function prototype name is different from that in the Framework HII 0.92 specification\r
- to avoid name confict with EFI_HII_GET_KEYBOARD_LAYOUT defined in the UEFI 2.1d specification.\r
-\r
- @param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param DescriptorCount A pointer to the number of Descriptor entries being\r
- described in the keyboard layout being retrieved.\r
- @param Descriptor A pointer to a buffer containing an array of\r
- FRAMEWORK_EFI_KEY_DESCRIPTOR entries. Each entry\r
- will reflect the definition of a specific physical key.\r
-\r
- @retval EFI_SUCCESS The keyboard layout was retrieved successfully.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *FRAMEWORK_EFI_HII_GET_KEYBOARD_LAYOUT)(\r
- IN EFI_HII_PROTOCOL *This,\r
- OUT UINT16 *DescriptorCount,\r
- OUT FRAMEWORK_EFI_KEY_DESCRIPTOR *Descriptor\r
- );\r
-\r
-///\r
-/// The HII Protocol manages the HII database, which is a repository for data\r
-/// having to do with fonts, strings, forms, keyboards, and other future human\r
-/// interface items.\r
-///\r
-struct _EFI_HII_PROTOCOL {\r
- ///\r
- /// Extracts the various packs from a package list.\r
- ///\r
- EFI_HII_NEW_PACK NewPack;\r
-\r
- ///\r
- /// Removes a package from the HII database.\r
- ///\r
- EFI_HII_REMOVE_PACK RemovePack;\r
-\r
- ///\r
- /// Determines the handles that are currently active in the database.\r
- ///\r
- EFI_HII_FIND_HANDLES FindHandles;\r
-\r
- ///\r
- /// Exports the entire contents of the database to a buffer.\r
- ///\r
- EFI_HII_EXPORT ExportDatabase;\r
-\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
- /// Translates a Unicode character into the corresponding font glyph.\r
- ///\r
- FRAMEWORK_EFI_HII_GET_GLYPH GetGlyph;\r
-\r
- ///\r
- /// Converts a glyph value into a format that is ready for a UGA BLT command.\r
- ///\r
- EFI_HII_GLYPH_TO_BLT GlyphToBlt;\r
-\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
- /// Allows a program to determine the primary languages that are supported\r
- /// on a given handle.\r
- ///\r
- EFI_HII_GET_PRI_LANGUAGES GetPrimaryLanguages;\r
-\r
- ///\r
- /// Allows a program to determine which secondary languages are supported\r
- /// on a given handle for a given primary language.\r
- ///\r
- EFI_HII_GET_SEC_LANGUAGES GetSecondaryLanguages;\r
-\r
- ///\r
- /// Extracts a string from a package that is already registered with the\r
- /// EFI HII database.\r
- ///\r
- FRAMEWORK_EFI_HII_GET_STRING GetString;\r
-\r
- ///\r
- /// Removes any new strings that were added after the initial string export\r
- /// for this handle.\r
- ///\r
- /// Note this function is not defined in the Framework HII 0.92 specification.\r
- ///\r
- EFI_HII_RESET_STRINGS ResetStrings;\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
- /// 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
- /// 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
- /// Allows a program to update a previously registered form.\r
- ///\r
- EFI_HII_UPDATE_FORM UpdateForm;\r
-\r
- ///\r
- /// Allows a program to extract the current keyboard layout.\r
- ///\r
- FRAMEWORK_EFI_HII_GET_KEYBOARD_LAYOUT GetKeyboardLayout;\r
-};\r
-\r
-extern EFI_GUID gEfiHiiProtocolGuid;\r
-extern EFI_GUID gEfiHiiCompatibilityProtocolGuid;\r
-\r
-#endif\r
-\r
projects / mirror_edk2.git / blobdiff