/** @file\r
- This file defines the Human Interface Infrastructure protocol which will\r
- be used by resources which want to publish IFR/Font/String data and have it\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. This protocol is defined in the.\r
Intel Platform Innovation Framework for EFI Human Interface Infrastructure\r
Specification Version 0.92.\r
#define _FRAMEWORK_HII_H_\r
\r
//\r
-// To get EFI_GRAPHICS_OUTPUT_BLT_PIXEL,\r
-// is defined in MdePkg/Protocol/GraphicsOutput.h\r
+// EFI_GRAPHICS_OUTPUT_BLT_PIXEL is defined in MdePkg/Protocol/GraphicsOutput.h\r
//\r
#include <Protocol/GraphicsOutput.h>\r
-\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
+////// 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
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
-///\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
+////// IFR package structure./// Immediately following the EFI_HII_IFR_PACK structure will be a series of IFR opcodes. ///typedef struct {\r
EFI_HII_PACK_HEADER Header; ///< Header of the IFR package.\r
} EFI_HII_IFR_PACK;\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
+ /// /// 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
/// The handle of the device that is being described by this package.\r
///\r
EFI_HANDLE DeviceHandle; // Optional\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. 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
+////// 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
/// Header of the package.\r
///\r
//EFI_WIDE_GLYPH WideGlyphs[];\r
} EFI_HII_FONT_PACK;\r
\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
+////// 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
/// Used to describe a physical key on a keyboard.\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
+////// 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
/// Header of the package.\r
EFI_HII_PACK_HEADER Header;\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 An FRAMEWORK_EFI_HII_HANDLE that corresponds to the desired\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
- In either case, the data will be exported in a format described by the\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
@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 Remove strings from the handle successfully.\r
+ @retval EFI_SUCCESS Successfully removed strings from the handle.\r
@retval EFI_INVALID_PARAMETER The Handle was unknown.\r
\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 fetch\r
- the character.On successful completion, the index is updated to the first\r
+ the character. On successful completion, the index is updated to the first\r
character past the 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. GlyphBuffer is assumed\r
@retval EFI_SUCCESS It worked.\r
@retval EFI_NOT_FOUND A glyph for a character was not found.\r
@note: Inconsistent with specification here:\r
- In Framework Spec,HII spec 0.92. The type of 3rd, 4th and 8th parameter is EFI_UGA_PIXEL.\r
- Here the definition use the EFI_GRAPHICS_OUTPUT_BLT_PIXEL which defined in UEFI2.1 spec\r
+ In Framework Spec, HII spec 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 spec\r
**/\r
typedef\r
EFI_STATUS\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 override when extracting\r
the default image data.\r
- @param VariablePackList A indirect pointer to the first entry of a link list with\r
+ @param VariablePackList An indirect pointer to the first entry of a link list with\r
type EFI_HII_VARIABLE_PACK_LIST.\r
\r
@retval EFI_SUCCESS The VariablePackList was populated with the appropriate\r
projects / mirror_edk2.git / blobdiff