2 This file defines the Human Interface Infrastructure protocol which will
3 be used by resources which want to publish IFR/Font/String data and have it
4 collected by the Configuration engine.
6 Copyright (c) 2007, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 Module Name: FrameworkHii.h
17 @par Revision Reference:
18 This protocol is defined in HII spec 0.92.
22 #ifndef _FRAMEWORK_HII_H_
23 #define _FRAMEWORK_HII_H_
28 // To get EFI_GRAPHICS_OUTPUT_BLT_PIXEL,
29 // is defined in MdePkg/Protocol/GraphicsOutput.h
31 #include <Protocol/GraphicsOutput.h>
33 #define EFI_HII_PROTOCOL_GUID \
35 0xd7ad636e, 0xb997, 0x459b, {0xbf, 0x3f, 0x88, 0x46, 0x89, 0x79, 0x80, 0xe1} \
39 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
40 // If UGA goes away we need to put this some place. I'm not sure where?
49 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
52 typedef struct _EFI_HII_PROTOCOL EFI_HII_PROTOCOL
;
57 #define NARROW_CHAR 0xFFF0
58 #define WIDE_CHAR 0xFFF1
59 #define NON_BREAKING_CHAR 0xFFF2
61 #define GLYPH_HEIGHT 19
63 #define EFI_HII_FONT 1
64 #define EFI_HII_STRING 2
66 #define EFI_HII_KEYBOARD 4
67 #define EFI_HII_HANDLES 5
68 #define EFI_HII_VARIABLE 6
69 #define EFI_HII_DEVICE_PATH 7
72 // References to string tokens must use this macro to enable scanning for
75 #define STRING_TOKEN(t) t
78 // The following types are currently defined:
80 typedef UINT16 EFI_FORM_ID
;
81 typedef UINT16 EFI_FORM_LABEL
;
88 } EFI_HII_PACK_HEADER
;
91 // A form list consists of a large variety of structure
92 // possibilities so to represent the binary blob of data
93 // associated with a package of forms, we will assume a
94 // pointer to a self-describing data buffer.
97 EFI_HII_PACK_HEADER Header
;
101 EFI_HII_PACK_HEADER Header
; // Must be filled in
102 EFI_HANDLE ImageHandle
; // Must be filled in
103 EFI_HANDLE DeviceHandle
; // Optional
104 EFI_HANDLE ControllerHandle
; // Optional
105 EFI_HANDLE CallbackHandle
; // Optional
106 EFI_HANDLE COBExportHandle
; // Optional
107 } EFI_HII_HANDLE_PACK
;
110 // ********************************************************
111 // EFI_VARIABLE_CONTENTS
112 // ********************************************************
115 EFI_HII_PACK_HEADER Header
;
116 EFI_GUID VariableGuid
;
117 UINT32 VariableNameLength
;
120 // CHAR16 VariableName[]; //Null-terminated
122 } EFI_HII_VARIABLE_PACK
;
125 // ********************************************************
126 // EFI_DEVICE_PATH_PACK
127 // ********************************************************
130 EFI_HII_PACK_HEADER Header
;
132 // EFI_DEVICE_PATH DevicePath[];
134 } EFI_HII_DEVICE_PATH_PACK
;
137 // ********************************************************
138 // EFI_HII_DATA_TABLE
139 // ********************************************************
142 EFI_HII_HANDLE HiiHandle
;
143 EFI_GUID PackageGuid
;
144 UINT32 DataTableSize
;
145 UINT32 IfrDataOffset
;
146 UINT32 StringDataOffset
;
147 UINT32 VariableDataOffset
;
148 UINT32 DevicePathOffset
;
149 UINT32 NumberOfVariableData
;
150 UINT32 NumberOfLanguages
;
152 // EFI_HII_DEVICE_PATH_PACK DevicePath[];
153 // EFI_HII_VARIABLE_PACK VariableData[];
154 // EFI_HII_IFR_PACK IfrData;
155 // EFI_HII_STRING_PACK StringData[];
157 } EFI_HII_DATA_TABLE
;
160 // ********************************************************
161 // EFI_HII_EXPORT_TABLE
162 // ********************************************************
165 UINT32 NumberOfHiiDataTables
;
168 // EFI_HII_DATA_TABLE HiiDataTable[];
170 } EFI_HII_EXPORT_TABLE
;
173 BOOLEAN FormSetUpdate
; // If TRUE, next variable is significant
174 EFI_PHYSICAL_ADDRESS FormCallbackHandle
; // If not 0, will update Formset with this info
175 BOOLEAN FormUpdate
; // If TRUE, next variable is significant
176 UINT16 FormValue
; // specify which form is to be updated if FormUpdate value is TRUE.
177 STRING_REF FormTitle
; // If not 0, will update Form with this info
178 UINT16 DataCount
; // The number of Data entries in this structure
179 UINT8
*Data
; // An array of 1+ op-codes, specified by DataCount
180 } EFI_HII_UPDATE_DATA
;
185 #define LANG_RIGHT_TO_LEFT 0x00000001
188 // A string package is used to localize strings to a particular
189 // language. The package is associated with a particular driver
190 // or set of drivers. Tools are used to associate tokens with
191 // string references in forms and in programs. These tokens are
192 // language agnostic. When paired with a language pack (directly
193 // or indirectly), the string token resolves into an actual
194 // UNICODE string. The NumStringPointers determines how many
195 // StringPointers (offset values) there are as well as the total
196 // number of Strings that are defined.
199 EFI_HII_PACK_HEADER Header
;
200 RELOFST LanguageNameString
;
201 RELOFST PrintableLanguageName
;
202 UINT32 NumStringPointers
;
205 // RELOFST StringPointers[];
206 // EFI_STRING Strings[];
208 } EFI_HII_STRING_PACK
;
213 #define EFI_GLYPH_NON_SPACING 1
214 #define EFI_GLYPH_WIDE 2
217 CHAR16 UnicodeWeight
;
219 UINT8 GlyphCol1
[GLYPH_HEIGHT
];
223 CHAR16 UnicodeWeight
;
225 UINT8 GlyphCol1
[GLYPH_HEIGHT
];
226 UINT8 GlyphCol2
[GLYPH_HEIGHT
];
231 // A font list consists of a font header followed by a series
232 // of glyph structures. Note that fonts are not language specific.
235 EFI_HII_PACK_HEADER Header
;
236 UINT16 NumberOfNarrowGlyphs
;
237 UINT16 NumberOfWideGlyphs
;
241 // The IfrData in the EFI_HII_IFR_PACK structure definition
242 // is variable length, and not really part of the header. To
243 // simplify from code the size of the header, define an
244 // identical structure that does not include the IfrData field.
245 // Then use sizeof() this new structure to determine the
246 // actual size of the header.
249 EFI_HII_PACK_HEADER Header
;
250 } EFI_HII_IFR_PACK_HEADER
;
253 // pedef EFI_HII_PACK_HEADER EFI_HII_IFR_PACK_HEADER;
366 CHAR16 ShiftedUnicode
;
368 CHAR16 ShiftedAltGrUnicode
;
370 } EFI_KEY_DESCRIPTOR
;
373 // This structure allows a sparse set of keys to be redefined
374 // or a complete redefinition of the keyboard layout. Most
375 // keyboards have a lot of commonality in their layouts, therefore
376 // only defining those keys that need to change from the default
377 // minimizes the passed in information.
379 // Additionally, when an update occurs, the active keyboard layout
380 // will be switched to the newly updated keyboard layout. This
381 // allows for situations that when a keyboard layout driver is
382 // loaded as part of system initialization, the system will default
383 // the keyboard behavior to the new layout.
385 // Each call to update the keyboard mapping should contain the
386 // complete set of key descriptors to be updated, since every
387 // call to the HII which contains an EFI_HII_KEYBOARD_PACK will
388 // wipe the previous set of overrides. A call to
391 EFI_HII_PACK_HEADER Header
;
392 EFI_KEY_DESCRIPTOR
*Descriptor
;
393 UINT8 DescriptorCount
;
394 } EFI_HII_KEYBOARD_PACK
;
397 // The EFI_HII_PACKAGES can contain different types of packages just
398 // after the structure as inline data.
401 UINTN NumberOfPackages
;
404 // EFI_HII_HANDLE_PACK *HandlePack; // Only one pack.
405 // EFI_HII_IFR_PACK *IfrPack; // Only one pack.
406 // EFI_HII_FONT_PACK *FontPack[]; // Multiple packs ok
407 // EFI_HII_STRING_PACK *StringPack[]; // Multiple packs ok
408 // EFI_HII_KEYBOARD_PACK *KeyboardPack[]; // Multiple packs ok
412 typedef struct _EFI_HII_VARIABLE_PACK_LIST
{
413 struct _EFI_HII_VARIABLE_PACK_LIST
*NextVariablePack
;
414 EFI_HII_VARIABLE_PACK
*VariablePack
;
415 } EFI_HII_VARIABLE_PACK_LIST
;
420 Registers the various packs that are passed in via the Packages parameter.
422 @param This A pointer to the EFI_HII_PROTOCOL instance.
423 @param Packages A pointer to an EFI_HII_PACKAGES package instance.
424 @param Handle A pointer to the EFI_HII_HANDLE instance.
426 @retval EFI_SUCCESS Data was extracted from Packages, the database
427 was updated with the data, and Handle returned successfully.
428 @retval EFI_INVALID_PARAMETER The content of Packages was invalid.
433 (EFIAPI
*EFI_HII_NEW_PACK
) (
434 IN EFI_HII_PROTOCOL
*This
,
435 IN EFI_HII_PACKAGES
*Packages
,
436 OUT EFI_HII_HANDLE
*Handle
440 Removes a package from the HII database.
442 @param This A pointer to the EFI_HII_PROTOCOL instance.
443 @param Handle The handle that was registered to the data that is requested
446 @retval EFI_SUCCESS The data associated with the Handle was removed
447 from the HII database.
448 @retval EFI_INVALID_PARAMETER The Handle was not valid.
453 (EFIAPI
*EFI_HII_REMOVE_PACK
) (
454 IN EFI_HII_PROTOCOL
*This
,
455 IN EFI_HII_HANDLE Handle
459 Determines the handles that are currently active in the database.
461 @param This A pointer to the EFI_HII_PROTOCOL instance.
462 @param HandleBufferLength On input, a pointer to the length of the handle
463 buffer. On output, the length of the handle buffer that is required
464 for the handles found.
465 @param Handle An array of EFI_HII_HANDLE instances returned.
467 @retval EFI_SUCCESS Handle was updated successfully.
468 @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates
469 that Handle is too small to support the number of handles.
474 (EFIAPI
*EFI_HII_FIND_HANDLES
) (
475 IN EFI_HII_PROTOCOL
*This
,
476 IN OUT UINT16
*HandleBufferLength
,
477 OUT EFI_HII_HANDLE
*Handle
481 Exports the contents of the database into a buffer.
483 @param This A pointer to the EFI_HII_PROTOCOL instance.
484 @param Handle An EFI_HII_HANDLE that corresponds to the desired
485 handle to export. If the value is 0, the entire database will be exported.
486 In either case, the data will be exported in a format described by the
487 structure definition of EFI_HII_EXPORT_TABLE.
489 On input, a pointer to the length of the buffer. On output, the length
490 of the buffer that is required for the export data.
491 @param Buffer A pointer to a buffer that will contain the results of the export function.
493 @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.
494 @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.
499 (EFIAPI
*EFI_HII_EXPORT
) (
500 IN EFI_HII_PROTOCOL
*This
,
501 IN EFI_HII_HANDLE Handle
,
502 IN OUT UINTN
*BufferSize
,
507 Remove any new strings that were added after the initial string export
510 @param This A pointer to the EFI_HII_PROTOCOL instance.
511 @param Handle The handle on which the string resides.
513 @retval EFI_SUCCESS Remove strings from the handle successfully.
514 @retval EFI_INVALID_PARAMETER The Handle was unknown.
519 (EFIAPI
*EFI_HII_RESET_STRINGS
) (
520 IN EFI_HII_PROTOCOL
*This
,
521 IN EFI_HII_HANDLE Handle
525 Tests if all of the characters in a string have corresponding font characters.
527 @param This A pointer to the EFI_HII_PROTOCOL instance.
528 @param StringToTest A pointer to a Unicode string.
529 @param FirstMissing A pointer to an index into the string. On input,
530 the index of the first character in the StringToTest to examine. On exit,
531 the index of the first character encountered for which a glyph is unavailable.
532 If all glyphs in the string are available, the index is the index of the
533 terminator of the string.
534 @param GlyphBufferSize A pointer to a value. On output, if the function
535 returns EFI_SUCCESS, it contains the amount of memory that is required to
536 store the string's glyph equivalent.
538 @retval EFI_SUCCESS All glyphs are available. Note that an empty string
539 always returns this value.
540 @retval EFI_NOT_FOUND A glyph was not found for a character.
545 (EFIAPI
*EFI_HII_TEST_STRING
) (
546 IN EFI_HII_PROTOCOL
*This
,
547 IN CHAR16
*StringToTest
,
548 IN OUT UINT32
*FirstMissing
,
549 OUT UINT32
*GlyphBufferSize
553 Translates a Unicode character into the corresponding font glyph.
555 @param This A pointer to the EFI_HII_PROTOCOL instance.
556 @param Source A pointer to a Unicode string.
557 @param Index On input, the offset into the string from which to fetch
558 the character.On successful completion, the index is updated to the first
559 character past the character(s) making up the just extracted glyph.
560 @param GlyphBuffer Pointer to an array where the glyphs corresponding
561 to the characters in the source may be stored. GlyphBuffer is assumed
562 to be wide enough to accept a wide glyph character.
563 @param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by
564 this value is filled with the length of the glyph in pixels. It is unchanged
565 if the call was unsuccessful.
566 @param InternalStatus The cell pointed to by this parameter must be
567 initialized to zero prior to invoking the call the first time for any string.
569 @retval EFI_SUCCESS It worked.
570 @retval EFI_NOT_FOUND A glyph for a character was not found.
575 (EFIAPI
*EFI_HII_GET_GLYPH
) (
576 IN EFI_HII_PROTOCOL
*This
,
578 IN OUT UINT16
*Index
,
579 OUT UINT8
**GlyphBuffer
,
580 OUT UINT16
*BitWidth
,
581 IN OUT UINT32
*InternalStatus
585 Translates a glyph into the format required for input to the Universal
586 Graphics Adapter (UGA) Block Transfer (BLT) routines.
588 @param This A pointer to the EFI_HII_PROTOCOL instance.
589 @param GlyphBuffer A pointer to the buffer that contains glyph data.
590 @param Foreground The foreground setting requested to be used for the
591 generated BltBuffer data.
592 @param Background The background setting requested to be used for the
593 generated BltBuffer data.
594 @param Count The entry in the BltBuffer upon which to act.
595 @param Width The width in bits of the glyph being converted.
596 @param Height The height in bits of the glyph being converted
597 @param BltBuffer A pointer to the buffer that contains the data that is
598 ready to be used by the UGA BLT routines.
600 @retval EFI_SUCCESS It worked.
601 @retval EFI_NOT_FOUND A glyph for a character was not found.
606 (EFIAPI
*EFI_HII_GLYPH_TO_BLT
) (
607 IN EFI_HII_PROTOCOL
*This
,
608 IN UINT8
*GlyphBuffer
,
609 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
,
610 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
,
614 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
618 Allows a new string to be added to an already existing string package.
620 @param This A pointer to the EFI_HII_PROTOCOL instance.
621 @param Pointer to a NULL-terminated string containing a single ISO 639-2
622 language identifier, indicating the language in which the string is translated.
623 @param Handle The handle of the language pack to which the string is to be added.
624 @param Reference The identifier of the string to be added. If the reference
625 value is zero, then the string will be assigned a new identifier on that
626 handle for the language specified. Otherwise, the string will be updated
627 with the NewString Value.
628 @param NewString The string to be added.
630 @retval EFI_SUCCESS The string was effectively registered.
631 @retval EFI_INVALID_PARAMETER The Handle was unknown.
636 (EFIAPI
*EFI_HII_NEW_STRING
) (
637 IN EFI_HII_PROTOCOL
*This
,
639 IN EFI_HII_HANDLE Handle
,
640 IN OUT STRING_REF
*Reference
,
645 Allows a program to determine the primary languages that are supported
648 @param This A pointer to the EFI_HII_PROTOCOL instance.
649 @param Handle The handle on which the strings reside.
650 @param LanguageString A string allocated by GetPrimaryLanguages() that
651 contains a list of all primary languages registered on the handle.
653 @retval EFI_SUCCESS LanguageString was correctly returned.
654 @retval EFI_INVALID_PARAMETER The Handle was unknown.
659 (EFIAPI
*EFI_HII_GET_PRI_LANGUAGES
) (
660 IN EFI_HII_PROTOCOL
*This
,
661 IN EFI_HII_HANDLE Handle
,
662 OUT EFI_STRING
*LanguageString
666 Allows a program to determine which secondary languages are supported
667 on a given handle for a given primary language.
669 @param This A pointer to the EFI_HII_PROTOCOL instance.
670 @param Handle The handle on which the strings reside.
671 @param PrimaryLanguage Pointer to a NULL-terminated string containing a single
672 ISO 639-2 language identifier, indicating the primary language.
673 @param LanguageString A string allocated by GetSecondaryLanguages()
674 containing a list of all secondary languages registered on the handle.
676 @retval EFI_SUCCESS LanguageString was correctly returned.
677 @retval EFI_INVALID_PARAMETER The Handle was unknown.
682 (EFIAPI
*EFI_HII_GET_SEC_LANGUAGES
) (
683 IN EFI_HII_PROTOCOL
*This
,
684 IN EFI_HII_HANDLE Handle
,
685 IN CHAR16
*PrimaryLanguage
,
686 OUT EFI_STRING
*LanguageString
690 Extracts a string from a package already registered with the EFI HII database.
692 @param This A pointer to the EFI_HII_PROTOCOL instance.
693 @param Handle The handle on which the string resides.
694 @param Token The string token assigned to the string.
695 @param Raw If TRUE, the string is returned unedited in the internal
696 storage format described above. If false, the string returned is edited
697 by replacing <cr> with <space> and by removing special characters such
698 as the <wide> prefix.
699 @param LanguageString Pointer to a NULL-terminated string containing a
700 single ISO 639-2 language identifier, indicating the language to print.
701 If the LanguageString is empty (starts with a NULL), the default system
702 language will be used to determine the language.
703 @param BufferLength Length of the StringBuffer.
704 @param StringBuffer The buffer designed to receive the characters in the string.
706 @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.
707 @retval EFI_INVALID_PARAMETER The handle or string token is unknown.
708 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to
709 allow the entire string to be stored.
714 (EFIAPI
*EFI_HII_GET_STRING
) (
715 IN EFI_HII_PROTOCOL
*This
,
716 IN EFI_HII_HANDLE Handle
,
719 IN CHAR16
*LanguageString
,
720 IN OUT UINTN
*BufferLength
,
721 OUT EFI_STRING StringBuffer
725 Allows a program to extract a part of a string of not more than a given width.
727 @param This A pointer to the EFI_HII_PROTOCOL instance.
728 @param Handle The handle on which the string resides.
729 @param Token The string token assigned to the string.
730 @param Index On input, the offset into the string where the line is to start.
731 On output, the index is updated to point to beyond the last character returned
733 @param LineWidth The maximum width of the line in units of narrow glyphs.
734 @param LanguageString Pointer to a NULL-terminated string containing a
735 single ISO 639-2 language identifier, indicating the language to print.
736 @param BufferLength Pointer to the length of the StringBuffer.
737 @param StringBuffer The buffer designed to receive the characters in the string.
739 @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.
740 @retval EFI_NOT_FOUND The font glyph for at least one of the characters in
741 the string is not in the font database.
742 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
743 to allow the entire string to be stored.
748 (EFIAPI
*EFI_HII_GET_LINE
) (
749 IN EFI_HII_PROTOCOL
*This
,
750 IN EFI_HII_HANDLE Handle
,
752 IN OUT UINT16
*Index
,
754 IN CHAR16
*LanguageString
,
755 IN OUT UINT16
*BufferLength
,
756 OUT EFI_STRING StringBuffer
760 Allows a program to extract a form or form package that has previously
761 been registered with the HII database.
763 @param This A pointer to the EFI_HII_PROTOCOL instance.
764 @param Handle Handle on which the form resides.
765 @param FormId The ID of the form to return. If the ID is zero,
766 the entire form package is returned.
767 @param BufferLength On input, the length of the Buffer. On output,
768 the length of the returned buffer,
769 @param Buffer The buffer designed to receive the form(s).
771 @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength
773 @retval EFI_INVALID_PARAMETER The handle is unknown.
774 @retval EFI_NOT_FOUND A form on the requested handle cannot be found with
775 the requested FormId.
776 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
777 to allow the form to be stored.
782 (EFIAPI
*EFI_HII_GET_FORMS
) (
783 IN EFI_HII_PROTOCOL
*This
,
784 IN EFI_HII_HANDLE Handle
,
785 IN EFI_FORM_ID FormId
,
786 IN OUT UINTN
*BufferLength
,
791 Extracts the defaults that are associated with a given handle in the HII database.
793 @param This A pointer to the EFI_HII_PROTOCOL instance.
794 @param Handle The HII handle from which will have default data retrieved.
795 @param DefaultMask The mask used to specify some type of default override when extracting
796 the default image data.
797 @param VariablePackList A indirect pointer to the first entry of a link list with
798 type EFI_HII_VARIABLE_PACK_LIST.
800 @retval EFI_SUCCESS The VariablePackList was populated with the appropriate
801 default setting data.
802 @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).
803 @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle
804 contain invalid data.
809 (EFIAPI
*EFI_HII_GET_DEFAULT_IMAGE
) (
810 IN EFI_HII_PROTOCOL
*This
,
811 IN EFI_HII_HANDLE Handle
,
812 IN UINTN DefaultMask
,
813 OUT EFI_HII_VARIABLE_PACK_LIST
**VariablePackList
817 Allows the caller to update a form or form package that has previously been
818 registered with the EFI HII database.
820 @param This A pointer to the EFI_HII_PROTOCOL instance.
821 @param Handle Handle of the package where the form to be updated resides.
822 @param Label The label inside the form package where the update is to take place.
823 @param AddData If TRUE, adding data at a given Label; otherwise,
824 if FALSE, removing data at a given Label.
825 @param Data The buffer containing the new tags to insert after the Label
827 @retval EFI_SUCCESS The form was updated with the new tags.
828 @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not
829 contain an integral number of tags.
830 @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found.
835 (EFIAPI
*EFI_HII_UPDATE_FORM
) (
836 IN EFI_HII_PROTOCOL
*This
,
837 IN EFI_HII_HANDLE Handle
,
838 IN EFI_FORM_LABEL Label
,
840 IN EFI_HII_UPDATE_DATA
*Data
844 Retrieves the current keyboard layout.
846 @param This A pointer to the EFI_HII_PROTOCOL instance.
847 @param DescriptorCount A pointer to the number of Descriptor entries being
848 described in the keyboard layout being retrieved.
849 @param Descriptor A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR
850 entries. Each entry will reflect the definition of a specific physical key.
852 @retval EFI_SUCCESS The keyboard layout was retrieved successfully.
857 (EFIAPI
*EFI_HII_GET_KEYBOARD_LAYOUT
) (
858 IN EFI_HII_PROTOCOL
*This
,
859 OUT UINT16
*DescriptorCount
,
860 OUT EFI_KEY_DESCRIPTOR
*Descriptor
864 @par Protocol Description:
865 The HII Protocol manages the HII database, which is a repository for data
866 having to do with fonts, strings, forms, keyboards, and other future human
870 Extracts the various packs from a package list.
873 Removes a package from the HII database.
876 Determines the handles that are currently active in the database.
878 @param ExportDatabase
879 Export the entire contents of the database to a buffer.
882 Tests if all of the characters in a string have corresponding font characters.
885 Translates a Unicode character into the corresponding font glyph.
888 Converts a glyph value into a format that is ready for a UGA BLT command.
891 Allows a new string to be added to an already existing string package.
893 @param GetPrimaryLanguages
894 Allows a program to determine the primary languages that are supported
897 @param GetSecondaryLanguages
898 Allows a program to determine which secondary languages are supported
899 on a given handle for a given primary language.
902 Extracts a string from a package that is already registered with the
906 Remove any new strings that were added after the initial string export
910 Allows a program to extract a part of a string of not more than a given width.
913 Allows a program to extract a form or form package that has been previously registered.
915 @param GetDefaultImage
916 Allows a program to extract the nonvolatile image that represents the default storage image.
919 Allows a program to update a previously registered form.
921 @param GetKeyboardLayout
922 Allows a program to extract the current keyboard layout.
925 struct _EFI_HII_PROTOCOL
{
926 EFI_HII_NEW_PACK NewPack
;
927 EFI_HII_REMOVE_PACK RemovePack
;
928 EFI_HII_FIND_HANDLES FindHandles
;
929 EFI_HII_EXPORT ExportDatabase
;
931 EFI_HII_TEST_STRING TestString
;
932 EFI_HII_GET_GLYPH GetGlyph
;
933 EFI_HII_GLYPH_TO_BLT GlyphToBlt
;
935 EFI_HII_NEW_STRING NewString
;
936 EFI_HII_GET_PRI_LANGUAGES GetPrimaryLanguages
;
937 EFI_HII_GET_SEC_LANGUAGES GetSecondaryLanguages
;
938 EFI_HII_GET_STRING GetString
;
939 EFI_HII_RESET_STRINGS ResetStrings
;
940 EFI_HII_GET_LINE GetLine
;
941 EFI_HII_GET_FORMS GetForms
;
942 EFI_HII_GET_DEFAULT_IMAGE GetDefaultImage
;
943 EFI_HII_UPDATE_FORM UpdateForm
;
945 EFI_HII_GET_KEYBOARD_LAYOUT GetKeyboardLayout
;
948 extern EFI_GUID gEfiHiiProtocolGuid
;