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 - 2010, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this 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
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
This protocol is defined in Framework for EFI Human Interface Infrastructure\r
//\r
#include <Protocol/GraphicsOutput.h>\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
+/// 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 spec because the spec changed part of HII interfaces but did not update the protocol\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
typedef struct _EFI_HII_PROTOCOL EFI_HII_PROTOCOL;\r
\r
///\r
-/// Note: Name difference between code and the Framework HII 0.92 spec.\r
-/// Add FRAMEWORK_ prefix to avoid name confict with EFI_HII_HANDLE defined in the\r
-/// UEFI 2.1d spec.\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
} EFI_HII_PACK_HEADER;\r
\r
///\r
-/// IFR package structure.\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
///\r
/// Header of the package.\r
///\r
- EFI_HII_PACK_HEADER Header; ///< Must be filled in\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
+ 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
+ /// 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_HANDLE COBExportHandle; ///< Optional.\r
} EFI_HII_HANDLE_PACK;\r
\r
///\r
-/// Variable package structure.\r
+/// The variable package structure.\r
///\r
typedef struct {\r
///\r
- /// Header of the package.\r
+ /// The header of the package.\r
///\r
EFI_HII_PACK_HEADER Header;\r
///\r
- /// GUID of the EFI variable\r
+ /// The GUID of the EFI variable.\r
///\r
EFI_GUID VariableGuid;\r
///\r
- /// Length in bytes of the EFI variable\r
+ /// The length in bytes of the EFI variable.\r
///\r
UINT32 VariableNameLength;\r
///\r
- /// The unique value for this variable\r
+ /// The unique value for this variable.\r
///\r
UINT16 VariableId;\r
//\r
} EFI_HII_VARIABLE_PACK;\r
\r
///\r
-/// Device path package structure.\r
+/// The device path package structure.\r
///\r
typedef struct {\r
///\r
- /// Header of the package.\r
+ /// The header of the package.\r
///\r
EFI_HII_PACK_HEADER Header;\r
//\r
\r
typedef struct {\r
///\r
- /// Unique value that correlates to the original HII handle.\r
+ /// A unique value that correlates to the original HII handle.\r
///\r
FRAMEWORK_EFI_HII_HANDLE HiiHandle;\r
///\r
///\r
EFI_GUID PackageGuid;\r
///\r
- /// Size of the EFI_HII_DATA_TABLE in bytes.\r
+ /// The size of the EFI_HII_DATA_TABLE in bytes.\r
///\r
UINT32 DataTableSize;\r
///\r
- /// Byte offset from the start of this structure to the IFR data.\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
- /// Byte offset from the start of this structure to the string data.\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
- /// Byte offset from the start of this structure to the variable data.\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
- /// Byte offset from the start of this structure to the device path data.\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
- /// Number of VariableData[] elements in the array.\r
+ /// The number of VariableData[] elements in the array.\r
///\r
UINT32 NumberOfVariableData;\r
///\r
} EFI_HII_DATA_TABLE;\r
\r
///\r
-/// Structure defining format for exporting data from the HII Database.\r
+/// The structure defining the format for exporting data from the HII Database.\r
///\r
typedef struct {\r
///\r
} EFI_HII_EXPORT_TABLE;\r
\r
///\r
-/// Structure used to pass data to update a form or form package\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
/// 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
+/// 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
- /// Header of the package.\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
+ /// The first designator indicates the primary language, while the others are secondary languages.\r
///\r
RELOFST LanguageNameString;\r
///\r
///\r
typedef struct {\r
///\r
- /// Header of the package.\r
+ /// The header of the package.\r
///\r
EFI_HII_PACK_HEADER Header;\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
+/// 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 spec.\r
+/// UEFI 2.1d specification.\r
///\r
typedef struct {\r
///\r
///\r
EFI_KEY Key;\r
///\r
- /// Unicode value for the Key.\r
+ /// The Unicode value for the Key.\r
CHAR16 Unicode;\r
///\r
- /// Unicode value for the key with the shift key being held down.\r
+ /// The Unicode value for the key with the shift key being held down.\r
///\r
CHAR16 ShiftedUnicode;\r
///\r
- /// Unicode value for the key with the Alt-GR being held down.\r
+ /// The Unicode value for the key with the Alt-GR being held down.\r
///\r
CHAR16 AltGrUnicode;\r
///\r
- /// Unicode value for the key with the Alt-GR and shift keys being held down.\r
+ /// The Unicode value for the key with the Alt-GR and shift keys being held down.\r
///\r
CHAR16 ShiftedAltGrUnicode;\r
///\r
///\r
typedef struct {\r
///\r
- /// Header of the package.\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
} EFI_HII_PACKAGES;\r
\r
///\r
-/// Packed link list that contains all the discernable defaults of variables\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
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 is requested\r
- for removal.\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
@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 to examine. On exit,\r
- the index of the first character encountered for which a glyph is unavailable.\r
- If all glyphs in the string are available, the index is the index of the\r
- terminator of the string.\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 memory that is required to\r
- store the string's glyph equivalent.\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
/**\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 spec\r
- to avoid name confict with EFI_HII_GET_GLYPH defined in the UEFI 2.1d spec.\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 fetch\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 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. GlyphBuffer is assumed\r
- to be wide enough to accept a wide glyph character.\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 pixels. It is unchanged\r
- if the call was unsuccessful.\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 first time for any string.\r
+ initialized to zero prior to invoking the call the \r
+ first time for any string.\r
\r
- @retval EFI_SUCCESS It worked.\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
@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 It worked.\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 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
+ 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
/**\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 spec\r
- to avoid name confict with EFI_HII_NEW_STRING defined in the UEFI 2.1d spec.\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 ISO 639-2\r
- language identifier, indicating the language in which the string is translated.\r
- @param Handle The handle of the language pack to which the string is to be added.\r
- @param Reference The identifier of the string to be added. If the reference\r
- value is zero, then the string will be assigned a new identifier on that\r
- handle for the language specified. Otherwise, the string will be updated\r
- with the NewString Value.\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
@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 on the handle.\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
@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 single\r
- ISO 639-2 language identifier, indicating the primary language.\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 registered on the handle.\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
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 spec\r
- to avoid name confict with EFI_HII_GET_STRING defined in the UEFI 2.1d spec.\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 internal\r
- storage format. If false, the string returned is edited\r
- by replacing <cr> with <space> and by removing special characters such\r
- as the <wide> prefix.\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 the language to print.\r
- If the LanguageString is empty (starts with a NULL), the default system\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
@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 line is to start.\r
- On output, the index is updated to point to beyond the last character returned\r
- in the call.\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 Pointer to a NULL-terminated string containing a\r
- single ISO 639-2 language identifier, indicating the language to print.\r
- @param BufferLength Pointer to the length of the StringBuffer.\r
- @param StringBuffer The buffer designed to receive the characters in the string.\r
-\r
- @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.\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
\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 override when extracting\r
- the default image data.\r
- @param VariablePackList An indirect pointer to the first entry of a link list with\r
- type EFI_HII_VARIABLE_PACK_LIST.\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
- contain invalid data.\r
+ contains invalid data.\r
\r
**/\r
typedef\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 spec\r
- to avoid name confict with EFI_HII_GET_KEYBOARD_LAYOUT defined in the UEFI 2.1d spec.\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 FRAMEWORK_EFI_KEY_DESCRIPTOR\r
- entries. Each entry will reflect the definition of a specific physical key.\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
EFI_HII_FIND_HANDLES FindHandles;\r
\r
///\r
- /// Export the entire contents of the database to a buffer.\r
+ /// Exports the entire contents of the database to a buffer.\r
///\r
EFI_HII_EXPORT ExportDatabase;\r
\r
FRAMEWORK_EFI_HII_GET_STRING GetString;\r
\r
///\r
- /// Remove any new strings that were added after the initial string export\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 spec.\r
+ /// Note this function is not defined in the Framework HII 0.92 specification.\r
///\r
EFI_HII_RESET_STRINGS ResetStrings;\r
\r
projects / mirror_edk2.git / blobdiff