4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPrivate structures definitions in HiiDatabase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define BITMAP_LEN_1_BIT(Width, Height) (((Width) + 7) / 8 * (Height))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define BITMAP_LEN_4_BIT(Width, Height) (((Width) + 1) / 2 * (Height))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define BITMAP_LEN_8_BIT(Width, Height) ((Width) * (Height))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define BITMAP_LEN_24_BIT(Width, Height) ((Width) * (Height) * 3)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// IFR data structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// BASE_CR (a, IFR_DEFAULT_VALUE_DATA, Entry) to get the whole structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LIST_ENTRY DefaultValueEntry; // Link to its default value array
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Get default value from IFR data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DefaultValueFromDefault = 0, // Get from the minimum or first one when not set default value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DefaultValueFromFlag, // Get default value from the defalut flag.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DefaultValueFromOpcode // Get default value from default opcode, highest priority.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // TRUE Cleaned, the value can't be used
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // FALSE Not cleaned, the value can be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Storage types
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('H', 'S', 'T', 'G')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Type; // EFI_HII_VARSTORE_BUFFER, EFI_HII_VARSTORE_NAME_VALUE, EFI_HII_VARSTORE_EFI_VARIABLE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// String Package definitions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_STRING_PACKAGE_SIGNATURE SIGNATURE_32 ('h','i','s','p')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Form Package definitions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_IFR_PACKAGE_SIGNATURE SIGNATURE_32 ('h','f','r','p')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Simple Font Package definitions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_S_FONT_PACKAGE_SIGNATURE SIGNATURE_32 ('h','s','f','p')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Font Package definitions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_FONT_PACKAGE_SIGNATURE SIGNATURE_32 ('h','i','f','p')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_GLYPH_INFO_SIGNATURE SIGNATURE_32 ('h','g','i','s')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_FONT_INFO_SIGNATURE SIGNATURE_32 ('h','l','f','i')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_GLOBAL_FONT_INFO_SIGNATURE SIGNATURE_32 ('h','g','f','i')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Image Package definitions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Keyboard Layout Pacakge definitions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_KB_LAYOUT_PACKAGE_SIGNATURE SIGNATURE_32 ('h','k','l','p')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _HII_KEYBOARD_LAYOUT_PACKAGE_INSTANCE {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Guid Package definitions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_GUID_PACKAGE_SIGNATURE SIGNATURE_32 ('h','i','g','p')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// A package list can contain only one or less than one device path package.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// This rule also applies to image package since ImageId can not be duplicate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _HII_DATABASE_PACKAGE_LIST_INSTANCE {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_HANDLE_SIGNATURE SIGNATURE_32 ('h','i','h','l')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_DATABASE_RECORD_SIGNATURE SIGNATURE_32 ('h','i','d','r')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_DATABASE_NOTIFY_SIGNATURE SIGNATURE_32 ('h','i','d','n')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_DATABASE_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('H', 'i', 'D', 'p')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS(a) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_IMAGE_DATABASE_PRIVATE_DATA_FROM_THIS(a) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_STRING_DATABASE_PRIVATE_DATA_FROM_THIS(a) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define HII_DATABASE_DATABASE_PRIVATE_DATA_FROM_THIS(a) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS(a) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Internal function prototypes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function checks whether a handle is a valid EFI_HII_HANDLE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle Pointer to a EFI_HII_HANDLE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE Valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE Invalid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function checks whether EFI_FONT_INFO exists in current database. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FontInfoMask is specified, check what options can be used to make a match.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note that the masks relate to where the system default should be supplied
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are ignored by this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Private Hii database private structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FontInfo Points to EFI_FONT_INFO structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FontInfoMask If not NULL, describes what options can be used
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to make a match between the font requested and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the font available. The caller must guarantee
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this mask is valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FontHandle On entry, Points to the font handle returned by a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync previous call to GetFontInfo() or NULL to start
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with the first font.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param GlobalFontInfo If not NULL, output the corresponding globa font
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE Existed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE Not existed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function invokes the matching registered function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Private HII Database driver private structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NotifyType The type of change concerning the database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageInstance Points to the package referred to by the notification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageType Package type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle The handle of the package list which contains the specified package.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Already checked all registered function and invoked
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if matched.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any input parameter is not valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieve system default font and color.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Private HII database driver private data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FontInfo Points to system default font output-related
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information. It's caller's responsibility to free
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FontInfoSize If not NULL, output the size of buffer FontInfo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Cell information is added to the GlyphInfoList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Parse all string blocks to find a String block specified by StringId.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If StringId = (EFI_STRING_ID) (-1), find out all EFI_HII_SIBT_FONT blocks
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync within this string package and backup its information. If LastStringId is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified, the string id of last string block will also be output.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If StringId = 0, output the string id of last string block (EFI_HII_SIBT_STRING).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Private Hii database private structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringPackage Hii string package instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringId The string's id, which is unique within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PackageList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BlockType Output the block type of found string block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringBlockAddr Output the block address of found string block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringTextOffset Offset, relative to the found block address, of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the string text information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param LastStringId Output the last string id when StringId = 0 or StringId = -1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StartStringId The first id in the skip block which StringId in the block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The string text and font is retrieved
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified text or font info can not be found
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Parse all glyph blocks to find a glyph block specified by CharValue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If CharValue = (CHAR16) (-1), collect all default character cell information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync within this font package and backup its information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FontPackage Hii string package instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CharValue Unicode character value, which identifies a glyph
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param GlyphBuffer Output the corresponding bitmap data of the found
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync block. It is the caller's responsiblity to free
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Cell Output cell information of the encoded bitmap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param GlyphBufferLen If not NULL, output the length of GlyphBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The bitmap data is retrieved successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified CharValue does not exist in current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function exports Form packages to a buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is a internal function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Private Hii database private structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle Identification of a package list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList Pointer to a package list which will be exported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param UsedSize The length of buffer be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferSize Length of the Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Allocated space for storing exported data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResultSize The size of the already exported content of this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync package list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Form Packages are exported successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageList,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI_HII_FONT_PROTOCOL protocol interfaces
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Renders a string to a bitmap or to the display.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Flags Describes how the string is to be drawn.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param String Points to the null-terminated string to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringInfo Points to the string output information,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync including the color and font. If NULL, then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string will be output in the default system font
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Blt If this points to a non-NULL on entry, this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync points to the image, which is Width pixels wide
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and Height pixels high. The string will be drawn
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync onto this image and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_OUT_FLAG_CLIP is implied. If this points
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to a NULL on entry, then a buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be allocated to hold the generated image and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the pointer updated on exit. It is the caller's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync responsibility to free this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BltX Together with BltX, Specifies the offset from the left and top edge
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the image of the first character cell in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BltY Together with BltY, Specifies the offset from the left and top edge
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the image of the first character cell in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RowInfoArray If this is non-NULL on entry, then on exit, this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will point to an allocated buffer containing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync row information and RowInfoArraySize will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync updated to contain the number of elements.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This array describes the characters which were at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync least partially drawn and the heights of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync rows. It is the caller's responsibility to free
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RowInfoArraySize If this is non-NULL on entry, then on exit it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contains the number of elements in RowInfoArray.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ColumnInfoArray If this is non-NULL, then on return it will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync filled with the horizontal offset for each
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync character in the string on the row where it is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync displayed. Non-printing characters will have
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the offset ~0. The caller is responsible to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocate a buffer large enough so that there
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is one entry for each character in the string,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not including the null-terminator. It is possible
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when character display is normalized that some
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync character cells overlap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The string was successfully rendered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RowInfoArray or Blt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The String or Blt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Flags were invalid combination..
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_FONT_DISPLAY_INFO *StringInfo OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Render a string to a bitmap or the screen containing the contents of the specified string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Flags Describes how the string is to be drawn.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList The package list in the HII database to search
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the specified string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringId The string's id, which is unique within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PackageList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Language Points to the language for the retrieved string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If NULL, then the current system language is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringInfo Points to the string output information,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync including the color and font. If NULL, then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string will be output in the default system font
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Blt If this points to a non-NULL on entry, this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync points to the image, which is Width pixels wide
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and Height pixels high. The string will be drawn
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync onto this image and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_OUT_FLAG_CLIP is implied. If this points
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to a NULL on entry, then a buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be allocated to hold the generated image and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the pointer updated on exit. It is the caller's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync responsibility to free this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BltX Together with BltX, Specifies the offset from the left and top edge
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the image of the first character cell in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BltY Together with BltY, Specifies the offset from the left and top edge
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the image of the first character cell in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RowInfoArray If this is non-NULL on entry, then on exit, this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will point to an allocated buffer containing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync row information and RowInfoArraySize will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync updated to contain the number of elements.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This array describes the characters which were at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync least partially drawn and the heights of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync rows. It is the caller's responsibility to free
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RowInfoArraySize If this is non-NULL on entry, then on exit it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contains the number of elements in RowInfoArray.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ColumnInfoArray If this is non-NULL, then on return it will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync filled with the horizontal offset for each
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync character in the string on the row where it is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync displayed. Non-printing characters will have
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the offset ~0. The caller is responsible to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocate a buffer large enough so that there
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is one entry for each character in the string,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not including the null-terminator. It is possible
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when character display is normalized that some
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync character cells overlap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The string was successfully rendered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RowInfoArray or Blt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Flags were invalid combination.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified PackageList is not in the Database or the stringid is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in the specified PackageList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_FONT_DISPLAY_INFO *StringInfo OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Convert the glyph for a single character into a bitmap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Char Character to retrieve.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringInfo Points to the string font and color information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or NULL if the string should use the default
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync system font and color.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Blt Thus must point to a NULL on entry. A buffer will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be allocated to hold the output and the pointer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync updated on exit. It is the caller's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync responsibility to free this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Baseline Number of pixels from the bottom of the bitmap to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the baseline.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Glyph bitmap created.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer Blt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WARN_UNKNOWN_GLYPH The glyph was unknown and was replaced with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync glyph for Unicode character 0xFFFD.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Blt is NULL or *Blt is not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function iterates through fonts which match the specified font, using
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the specified criteria. If String is non-NULL, then all of the characters in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the string must exist in order for a candidate font to be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FontHandle On entry, points to the font handle returned by a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync previous call to GetFontInfo() or NULL to start
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with the first font. On return, points to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned font handle or points to NULL if there
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are no more matching fonts.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringInfoIn Upon entry, points to the font to return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information about. If NULL, then the information about the system default
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync font will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringInfoOut Upon return, contains the matching font's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information. If NULL, then no information is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned. It's caller's responsibility to free
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param String Points to the string which will be tested to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync determine if all characters are available. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL, then any font is acceptable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Matching font returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No matching font was found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER StringInfoIn is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER StringInfoIn->FontInfoMask is an invalid combination.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_FONT_DISPLAY_INFO *StringInfoIn, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI_HII_IMAGE_PROTOCOL interfaces
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function adds the image Image to the group of images owned by PackageList, and returns
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a new image identifier (ImageId).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList Handle of the package list where this image will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageId On return, contains the new image id, which is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unique within PackageList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Image Points to the image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The new image was added successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified PackageList could not be found in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not add the image due to lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Image is NULL or ImageId is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function retrieves the image specified by ImageId which is associated with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the specified PackageList and copies it into the buffer specified by Image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList Handle of the package list where this image will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be searched.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageId The image's id,, which is unique within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PackageList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Image Points to the image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The new image was returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The image specified by ImageId is not available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The specified PackageList is not in the database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is too small to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync hold the image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The Image or ImageSize was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The bitmap could not be retrieved because there was not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync enough memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function updates the image specified by ImageId in the specified PackageListHandle to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the image specified by Image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList The package list containing the images.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageId The image's id,, which is unique within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PackageList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Image Points to the image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The new image was updated successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The image specified by ImageId is not in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync database. The specified PackageList is not in the database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The Image was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function renders an image to a bitmap or the screen using the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync color and options. It draws the image on an existing bitmap, allocates a new
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bitmap or uses the screen. The images can be clipped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Flags Describes how the image is to be drawn.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Image Points to the image to be displayed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Blt If this points to a non-NULL on entry, this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync points to the image, which is Width pixels wide
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and Height pixels high. The image will be drawn
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync onto this image and EFI_HII_DRAW_FLAG_CLIP is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync implied. If this points to a NULL on entry, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a buffer will be allocated to hold the generated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync image and the pointer updated on exit. It is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync caller's responsibility to free this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BltX Specifies the offset from the left and top edge
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the output image of the first pixel in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BltY Specifies the offset from the left and top edge
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the output image of the first pixel in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The image was successfully drawn.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for Blt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The Image or Blt was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any combination of Flags is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function renders an image to a bitmap or the screen using the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync color and options. It draws the image on an existing bitmap, allocates a new
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bitmap or uses the screen. The images can be clipped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Flags Describes how the image is to be drawn.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList The package list in the HII database to search
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the specified image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageId The image's id, which is unique within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PackageList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Blt If this points to a non-NULL on entry, this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync points to the image, which is Width pixels wide
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and Height pixels high. The image will be drawn
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync onto this image and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_DRAW_FLAG_CLIP is implied. If this points
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to a NULL on entry, then a buffer will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocated to hold the generated image and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pointer updated on exit. It is the caller's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync responsibility to free this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BltX Specifies the offset from the left and top edge
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the output image of the first pixel in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BltY Specifies the offset from the left and top edge
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the output image of the first pixel in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The image was successfully drawn.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for Blt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The Blt was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The image specified by ImageId is not in the database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The specified PackageList is not in the database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI_HII_STRING_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function adds the string String to the group of strings owned by PackageList, with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified font information StringFontInfo and returns a new string id.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_STRING_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList Handle of the package list where this string will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringId On return, contains the new strings id, which is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unique within PackageList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Language Points to the language for the new string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param LanguageName Points to the printable language name to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync associate with the passed in Language field.If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LanguageName is not NULL and the string package
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync header's LanguageName associated with a given
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Language is not zero, the LanguageName being
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync passed in will be ignored.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param String Points to the new null-terminated string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringFontInfo Points to the new string's font information or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL if the string should have the default system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync font, size and style.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The new string was added successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified PackageList could not be found in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER String is NULL or StringId is NULL or Language is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function retrieves the string specified by StringId which is associated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with the specified PackageList in the language Language and copies it into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the buffer specified by String.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_STRING_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Language Points to the language for the retrieved string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList The package list in the HII database to search
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the specified string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringId The string's id, which is unique within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PackageList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param String Points to the new null-terminated string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringSize On entry, points to the size of the buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pointed to by String, in bytes. On return,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync points to the length of the string, in bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringFontInfo If not NULL, points to the string's font
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information. It's caller's responsibility to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync free this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The string was returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The string specified by StringId is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The string specified by StringId is available but
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not in the specified language.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The specified PackageList is not in the database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_LANGUAGE - The string specified by StringId is available but
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The buffer specified by StringSize is too small
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to hold the string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The String or Language or StringSize was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function updates the string specified by StringId in the specified PackageList to the text
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by String and, optionally, the font information specified by StringFontInfo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_STRING_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList The package list containing the strings.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringId The string's id, which is unique within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PackageList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Language Points to the language for the updated string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param String Points to the new null-terminated string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StringFontInfo Points to the string's font information or NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if the string font information is not changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The string was updated successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The string specified by StringId is not in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The String or Language was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the list of supported languages, in the format specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in Appendix M of UEFI 2.1 spec.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_STRING_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList The package list to examine.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Languages Points to the buffer to hold the returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync null-terminated ASCII string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param LanguagesSize On entry, points to the size of the buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pointed to by Languages, in bytes. On return,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync points to the length of Languages, in bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The languages were returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The Languages or LanguagesSize was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The LanguagesSize is too small to hold the list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of supported languages. LanguageSize is updated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to contain the required size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Could not find string package in specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync packagelist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Each string package has associated with it a single primary language and zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or more secondary languages. This routine returns the secondary languages
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync associated with a package list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_STRING_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList The package list to examine.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PrimaryLanguage Points to the null-terminated ASCII string that specifies
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the primary language. Languages are specified in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync format specified in Appendix M of the UEFI 2.0 specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SecondaryLanguages Points to the buffer to hold the returned null-terminated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASCII string that describes the list of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync secondary languages for the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PrimaryLanguage. If there are no secondary
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync languages, the function returns successfully,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync but this is set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SecondaryLanguagesSize On entry, points to the size of the buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pointed to by SecondaryLanguages, in bytes. On
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return, points to the length of SecondaryLanguages
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Secondary languages were correctly returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER PrimaryLanguage or SecondaryLanguages or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SecondaryLanguagesSize was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The buffer specified by SecondaryLanguagesSize is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync too small to hold the returned information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SecondaryLanguageSize is updated to hold the size of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the buffer required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_LANGUAGE The language specified by PrimaryLanguage is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync present in the specified package list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified PackageList is not in the Database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI_HII_DATABASE_PROTOCOL protocol interfaces
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function adds the packages in the package list to the database and returns a handle. If there is a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DEVICE_PATH_PROTOCOL associated with the DriverHandle, then this function will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync create a package of type EFI_PACKAGE_TYPE_DEVICE_PATH and add it to the package list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList A pointer to an EFI_HII_PACKAGE_LIST_HEADER
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DriverHandle Associate the package list with this EFI handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If a NULL is specified, this data will not be associate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with any drivers and cannot have a callback induced.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle A pointer to the EFI_HII_HANDLE instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The package list associated with the Handle was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync added to the HII database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Unable to allocate necessary resources for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync new database contents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER PackageList is NULL or Handle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function removes the package list that is associated with a handle Handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from the HII database. Before removing the package, any registered functions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with the notification type REMOVE_PACK and the same package type will be called.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle The handle that was registered to the data that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is requested for removal.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The data associated with the Handle was removed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from the HII database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified Handle is not in database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function updates the existing package list (which has the specified Handle)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in the HII databases, using the new package list specified by PackageList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle The handle that was registered to the data that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is requested to be updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageList A pointer to an EFI_HII_PACKAGE_LIST_HEADER
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The HII database was successfully updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Unable to allocate enough memory for the updated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER PackageList was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified Handle is not in database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns a list of the package handles of the specified type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that are currently active in the database. The pseudo-type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_PACKAGE_TYPE_ALL will cause all package handles to be listed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageType Specifies the package type of the packages to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync list or EFI_HII_PACKAGE_TYPE_ALL for all packages
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to be listed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageGuid If PackageType is EFI_HII_PACKAGE_TYPE_GUID, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this is the pointer to the GUID which must match
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the Guid field of EFI_HII_GUID_PACKAGE_GUID_HDR.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Otherwise, it must be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HandleBufferLength On input, a pointer to the length of the handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer. On output, the length of the handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer that is required for the handles found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle An array of EFI_HII_HANDLE instances returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The matching handles are outputed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HandleBufferLength is updated with the actual length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TO_SMALL The HandleBufferLength parameter indicates that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Handle is too small to support the number of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handles. HandleBufferLength is updated with a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync value that will enable the data to fit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No matching handle could not be found in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Handle or HandleBufferLength was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PackageGuid is not NULL, PackageType is a EFI_HII_
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PACKAGE_TYPE_GUID but PackageGuid is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function will export one or all package lists in the database to a buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For each package list exported, this function will call functions registered
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with EXPORT_PACK and then copy the package list to the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle An EFI_HII_HANDLE that corresponds to the desired
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync package list in the HII database to export or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL to indicate all package lists should be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferSize On input, a pointer to the length of the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, the length of the buffer that is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync required for the exported data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer A pointer to a buffer that will contain the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync results of the export function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Package exported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TO_SMALL The HandleBufferLength parameter indicates that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Handle is too small to support the number of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handles. HandleBufferLength is updated with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a value that will enable the data to fit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specifiecd Handle could not be found in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Handle or Buffer or BufferSize was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function registers a function which will be called when specified actions related to packages of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the specified type occur in the HII database. By registering a function, other HII-related drivers are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync notified when specific package types are added, removed or updated in the HII database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Each driver or application which registers a notification should use
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify() before exiting.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageType Specifies the package type of the packages to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync list or EFI_HII_PACKAGE_TYPE_ALL for all packages
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to be listed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageGuid If PackageType is EFI_HII_PACKAGE_TYPE_GUID, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this is the pointer to the GUID which must match
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the Guid field of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_GUID_PACKAGE_GUID_HDR. Otherwise, it must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageNotifyFn Points to the function to be called when the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync event specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NotificationType occurs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NotifyType Describes the types of notification which this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function will be receiving.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NotifyHandle Points to the unique handle assigned to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registered notification. Can be used in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to stop notifications.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Notification registered successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Unable to allocate necessary data structures
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER NotifyHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER PackageGuid is not NULL when PackageType is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_PACKAGE_TYPE_GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER PackageGuid is NULL when PackageType is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_PACKAGE_TYPE_GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Removes the specified HII database package-related notification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NotificationHandle The handle of the notification function being
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unregistered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Notification is unregistered successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The incoming notification handle does not exist
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in current hii database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This routine retrieves an array of GUID values for each keyboard layout that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was previously registered in the system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param KeyGuidBufferLength On input, a pointer to the length of the keyboard
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GUID buffer. On output, the length of the handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer that is required for the handles found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param KeyGuidBuffer An array of keyboard layout GUID instances
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS KeyGuidBuffer was updated successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The KeyGuidBufferLength parameter indicates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that KeyGuidBuffer is too small to support the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number of GUIDs. KeyGuidBufferLength is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync updated with a value that will enable the data to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The KeyGuidBuffer or KeyGuidBufferLength was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND There was no keyboard layout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This routine retrieves the requested keyboard layout. The layout is a physical description of the keys
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on a keyboard and the character(s) that are associated with a particular set of key strokes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param KeyGuid A pointer to the unique ID associated with a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync given keyboard layout. If KeyGuid is NULL then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the current layout will be retrieved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param KeyboardLayoutLength On input, a pointer to the length of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync KeyboardLayout buffer. On output, the length of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the data placed into KeyboardLayout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param KeyboardLayout A pointer to a buffer containing the retrieved
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync keyboard layout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The keyboard layout was retrieved successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The requested keyboard layout was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The KeyboardLayout or KeyboardLayoutLength was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This routine sets the default keyboard layout to the one referenced by KeyGuid. When this routine
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is called, an event will be signaled of the EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync group type. This is so that agents which are sensitive to the current keyboard layout being changed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync can be notified of this change.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param KeyGuid A pointer to the unique ID associated with a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync given keyboard layout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The current keyboard layout was successfully set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The referenced keyboard layout was not found, so
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync action was taken.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The KeyGuid was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the EFI handle associated with a package list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PackageListHandle An EFI_HII_HANDLE that corresponds to the desired
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync package list in the HIIdatabase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DriverHandle On return, contains the EFI_HANDLE which was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registered with the package list in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NewPackageList().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The DriverHandle was returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PackageListHandle was not valid or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DriverHandle was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI_HII_CONFIG_ROUTING_PROTOCOL interfaces
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function allows a caller to extract the current configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for one or more named elements from one or more drivers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Request A null-terminated Unicode string in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <MultiConfigRequest> format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Progress On return, points to a character in the Request
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string. Points to the string's null terminator if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync request was successful. Points to the most recent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync & before the first failing name / value pair (or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the beginning of the string if the failure is in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the first name / value pair) if the request was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Results Null-terminated Unicode string in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <MultiConfigAltResp> format which has all values
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync filled in for the names in the Request string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync String to be allocated by the called function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The Results string is filled with the values
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync corresponding to all requested names.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync results that must be stored awaiting possible
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync future protocols.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Routing data doesn't match any known driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Progress set to the "G" in "GUID" of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync routing header that doesn't match. Note: There
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is no requirement that all routing data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be validated before any configuration extraction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER For example, passing in a NULL for the Request
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter would result in this type of error. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Progress parameter is set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set to most recent &
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync before the error or the beginning of the string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Unknown name. Progress points to the & before the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync name in question.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function allows the caller to request the current configuration for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync entirety of the current HII database and returns the data in a null-terminated Unicode string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Results Null-terminated Unicode string in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <MultiConfigAltResp> format which has all values
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync filled in for the names in the Request string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync String to be allocated by the called function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync De-allocation is up to the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The Results string is filled with the values
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync corresponding to all requested names.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync results that must be stored awaiting possible
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync future protocols.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER For example, passing in a NULL for the Results
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter would result in this type of error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function processes the results of processing forms and routes it to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync appropriate handlers or storage.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Configuration A null-terminated Unicode string in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <MulltiConfigResp> format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Progress A pointer to a string filled in with the offset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the most recent & before the first failing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync name / value pair (or the beginning of the string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if the failure is in the first name / value pair)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or the terminating NULL if all was successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The results have been distributed or are awaiting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync results that must be stored awaiting possible
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync future protocols.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Passing in a NULL for the Configuration parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync would result in this type of error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Target for the specified routing data was not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This helper function is to be called by drivers to map configuration data stored
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in byte array ("block") formats such as UEFI Variables into current configuration strings.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ConfigRequest A null-terminated Unicode string in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <ConfigRequest> format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Block Array of bytes defining the block's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BlockSize Length in bytes of Block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Config Filled-in configuration string. String allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the function. Returned only if call is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Progress A pointer to a string filled in with the offset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the most recent & before the first failing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync name/value pair (or the beginning of the string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if the failure is in the first name / value pair)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or the terminating NULL if all was successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The request succeeded. Progress points to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync null terminator at the end of the ConfigRequest
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Progress points to the first character of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ConfigRequest.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigRequest or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Block parameter would result in this type of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync error. Progress points to the first character of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ConfigRequest.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Target for the specified routing data was not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync found. Progress points to the "G" in "GUID" of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the errant routing data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Block not large enough. Progress undefined.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Block is left updated and Progress points at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the '&' preceding the first non-<BlockName>.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This helper function is to be called by drivers to map configuration strings
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to configurations stored in byte array ("block") formats such as UEFI Variables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ConfigResp A null-terminated Unicode string in <ConfigResp>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Block A possibly null array of bytes representing the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current block. Only bytes referenced in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ConfigResp string in the block are modified. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this parameter is null or if the *BlockSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter is (on input) shorter than required by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the Configuration string, only the BlockSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter is updated and an appropriate status
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (see below) is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BlockSize The length of the Block in units of UINT8. On
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync input, this is the size of the Block. On output,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if successful, contains the index of the last
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync modified byte in the Block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Progress On return, points to an element of the ConfigResp
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string filled in with the offset of the most
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync recent '&' before the first failing name / value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pair (or the beginning of the string if the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync failure is in the first name / value pair) or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the terminating NULL if all was successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The request succeeded. Progress points to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync null terminator at the end of the ConfigResp
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Progress points to the first character of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ConfigResp.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigResp or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Block parameter would result in this type of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync error. Progress points to the first character of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ConfigResp.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Target for the specified routing data was not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync found. Progress points to the "G" in "GUID" of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the errant routing data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted name /
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync value pair. Block is left updated and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Progress points at the '&' preceding the first
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync non-<BlockName>.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This helper function is to be called by drivers to extract portions of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a larger configuration string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Configuration A null-terminated Unicode string in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <MultiConfigAltResp> format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Guid A pointer to the GUID value to search for in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync routing portion of the ConfigResp string when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync retrieving the requested data. If Guid is NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then all GUID values will be searched for.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Name A pointer to the NAME value to search for in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync routing portion of the ConfigResp string when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync retrieving the requested data. If Name is NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then all Name values will be searched for.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DevicePath A pointer to the PATH value to search for in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync routing portion of the ConfigResp string when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync retrieving the requested data. If DevicePath is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL, then all DevicePath values will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync searched for.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param AltCfgId A pointer to the ALTCFG value to search for in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the routing portion of the ConfigResp string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when retrieving the requested data. If this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter is NULL, then the current setting will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be retrieved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param AltCfgResp A pointer to a buffer which will be allocated by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the function which contains the retrieved string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync as requested. This buffer is only allocated if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the call was successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The request succeeded. The requested data was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync extracted and placed in the newly allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AltCfgResp buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate AltCfgResp.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any parameter is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Target for the specified routing data was not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Compare whether two names of languages are identical.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Language1 Name of language 1 from StringPackage
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Language2 Name of language 2 to be compared with language 1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE same
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE not same
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Global variables