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) 2006, 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.
17 @par Revision Reference:
18 This protocol is defined in HII spec 0.92.
26 #define EFI_HII_PROTOCOL_GUID \
28 0xea816d2c, 0xcee5, 0x4f02, {0x99, 0xb5, 0xd3, 0x90, 0x5c, 0xbb, 0xd0, 0x77 } \
32 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
33 // If UGA goes away we need to put this some place. I'm not sure where?
42 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
45 typedef struct _EFI_HII_PROTOCOL EFI_HII_PROTOCOL
;
50 #define NARROW_CHAR 0xFFF0
51 #define WIDE_CHAR 0xFFF1
52 #define NON_BREAKING_CHAR 0xFFF2
54 #define GLYPH_HEIGHT 19
56 #define EFI_HII_FONT 1
57 #define EFI_HII_STRING 2
59 #define EFI_HII_KEYBOARD 4
60 #define EFI_HII_HANDLES 5
61 #define EFI_HII_VARIABLE 6
62 #define EFI_HII_DEVICE_PATH 7
65 // References to string tokens must use this macro to enable scanning for
68 #define STRING_TOKEN(t) t
71 // The following types are currently defined:
73 typedef UINT16 EFI_FORM_ID
;
74 typedef UINT16 EFI_FORM_LABEL
;
81 } EFI_HII_PACK_HEADER
;
84 // A form list consists of a large variety of structure
85 // possibilities so to represent the binary blob of data
86 // associated with a package of forms, we will assume a
87 // pointer to a self-describing data buffer.
90 EFI_HII_PACK_HEADER Header
;
94 EFI_HII_PACK_HEADER Header
; // Must be filled in
95 EFI_HANDLE ImageHandle
; // Must be filled in
96 EFI_HANDLE DeviceHandle
; // Optional
97 EFI_HANDLE ControllerHandle
; // Optional
98 EFI_HANDLE CallbackHandle
; // Optional
99 EFI_HANDLE COBExportHandle
; // Optional
100 } EFI_HII_HANDLE_PACK
;
103 // ********************************************************
104 // EFI_VARIABLE_CONTENTS
105 // ********************************************************
108 EFI_HII_PACK_HEADER Header
;
109 EFI_GUID VariableGuid
;
110 UINT32 VariableNameLength
;
113 // CHAR16 VariableName[]; //Null-terminated
115 } EFI_HII_VARIABLE_PACK
;
118 // ********************************************************
119 // EFI_DEVICE_PATH_PACK
120 // ********************************************************
123 EFI_HII_PACK_HEADER Header
;
125 // EFI_DEVICE_PATH DevicePath[];
127 } EFI_HII_DEVICE_PATH_PACK
;
130 // ********************************************************
131 // EFI_HII_DATA_TABLE
132 // ********************************************************
135 EFI_HII_HANDLE HiiHandle
;
136 EFI_GUID PackageGuid
;
137 UINT32 DataTableSize
;
138 UINT32 IfrDataOffset
;
139 UINT32 StringDataOffset
;
140 UINT32 VariableDataOffset
;
141 UINT32 DevicePathOffset
;
142 UINT32 NumberOfVariableData
;
143 UINT32 NumberOfLanguages
;
145 // EFI_HII_DEVICE_PATH_PACK DevicePath[];
146 // EFI_HII_VARIABLE_PACK VariableData[];
147 // EFI_HII_IFR_PACK IfrData;
148 // EFI_HII_STRING_PACK StringData[];
150 } EFI_HII_DATA_TABLE
;
153 // ********************************************************
154 // EFI_HII_EXPORT_TABLE
155 // ********************************************************
158 UINT32 NumberOfHiiDataTables
;
161 // EFI_HII_DATA_TABLE HiiDataTable[];
163 } EFI_HII_EXPORT_TABLE
;
166 BOOLEAN FormSetUpdate
; // If TRUE, next variable is significant
167 EFI_PHYSICAL_ADDRESS FormCallbackHandle
; // If not 0, will update Formset with this info
168 BOOLEAN FormUpdate
; // If TRUE, next variable is significant
169 UINT16 FormValue
; // specify which form is to be updated if FormUpdate value is TRUE.
170 STRING_REF FormTitle
; // If not 0, will update Form with this info
171 UINT16 DataCount
; // The number of Data entries in this structure
172 UINT8
*Data
; // An array of 1+ op-codes, specified by DataCount
173 } EFI_HII_UPDATE_DATA
;
178 #define LANG_RIGHT_TO_LEFT 0x00000001
181 // A string package is used to localize strings to a particular
182 // language. The package is associated with a particular driver
183 // or set of drivers. Tools are used to associate tokens with
184 // string references in forms and in programs. These tokens are
185 // language agnostic. When paired with a language pack (directly
186 // or indirectly), the string token resolves into an actual
187 // UNICODE string. The NumStringPointers determines how many
188 // StringPointers (offset values) there are as well as the total
189 // number of Strings that are defined.
192 EFI_HII_PACK_HEADER Header
;
193 RELOFST LanguageNameString
;
194 RELOFST PrintableLanguageName
;
195 UINT32 NumStringPointers
;
198 // RELOFST StringPointers[];
199 // EFI_STRING Strings[];
201 } EFI_HII_STRING_PACK
;
206 #define EFI_GLYPH_NON_SPACING 1
207 #define EFI_GLYPH_WIDE 2
210 CHAR16 UnicodeWeight
;
212 UINT8 GlyphCol1
[GLYPH_HEIGHT
];
216 CHAR16 UnicodeWeight
;
218 UINT8 GlyphCol1
[GLYPH_HEIGHT
];
219 UINT8 GlyphCol2
[GLYPH_HEIGHT
];
224 // A font list consists of a font header followed by a series
225 // of glyph structures. Note that fonts are not language specific.
228 EFI_HII_PACK_HEADER Header
;
229 UINT16 NumberOfNarrowGlyphs
;
230 UINT16 NumberOfWideGlyphs
;
234 // The IfrData in the EFI_HII_IFR_PACK structure definition
235 // is variable length, and not really part of the header. To
236 // simplify from code the size of the header, define an
237 // identical structure that does not include the IfrData field.
238 // Then use sizeof() this new structure to determine the
239 // actual size of the header.
242 EFI_HII_PACK_HEADER Header
;
243 } EFI_HII_IFR_PACK_HEADER
;
246 // pedef EFI_HII_PACK_HEADER EFI_HII_IFR_PACK_HEADER;
359 CHAR16 ShiftedUnicode
;
361 CHAR16 ShiftedAltGrUnicode
;
363 } EFI_KEY_DESCRIPTOR
;
366 // This structure allows a sparse set of keys to be redefined
367 // or a complete redefinition of the keyboard layout. Most
368 // keyboards have a lot of commonality in their layouts, therefore
369 // only defining those keys that need to change from the default
370 // minimizes the passed in information.
372 // Additionally, when an update occurs, the active keyboard layout
373 // will be switched to the newly updated keyboard layout. This
374 // allows for situations that when a keyboard layout driver is
375 // loaded as part of system initialization, the system will default
376 // the keyboard behavior to the new layout.
378 // Each call to update the keyboard mapping should contain the
379 // complete set of key descriptors to be updated, since every
380 // call to the HII which contains an EFI_HII_KEYBOARD_PACK will
381 // wipe the previous set of overrides. A call to
384 EFI_HII_PACK_HEADER Header
;
385 EFI_KEY_DESCRIPTOR
*Descriptor
;
386 UINT8 DescriptorCount
;
387 } EFI_HII_KEYBOARD_PACK
;
390 // The EFI_HII_PACKAGES can contain different types of packages just
391 // after the structure as inline data.
394 UINTN NumberOfPackages
;
397 // EFI_HII_HANDLE_PACK *HandlePack; // Only one pack.
398 // EFI_HII_IFR_PACK *IfrPack; // Only one pack.
399 // EFI_HII_FONT_PACK *FontPack[]; // Multiple packs ok
400 // EFI_HII_STRING_PACK *StringPack[]; // Multiple packs ok
401 // EFI_HII_KEYBOARD_PACK *KeyboardPack[]; // Multiple packs ok
405 typedef struct _EFI_HII_VARIABLE_PACK_LIST
{
406 struct _EFI_HII_VARIABLE_PACK_LIST
*NextVariablePack
;
407 EFI_HII_VARIABLE_PACK
*VariablePack
;
408 } EFI_HII_VARIABLE_PACK_LIST
;
413 Registers the various packs that are passed in via the Packages parameter.
415 @param This A pointer to the EFI_HII_PROTOCOL instance.
417 @param Packages A pointer to an EFI_HII_PACKAGES package instance.
419 @param Handle A pointer to the EFI_HII_HANDLE instance.
421 @retval EFI_SUCCESS Data was extracted from Packages, the database
422 was updated with the data, and Handle returned successfully.
424 @retval EFI_INVALID_PARAMETER The content of Packages was invalid.
429 (EFIAPI
*EFI_HII_NEW_PACK
) (
430 IN EFI_HII_PROTOCOL
*This
,
431 IN EFI_HII_PACKAGES
*Packages
,
432 OUT EFI_HII_HANDLE
*Handle
436 Removes a package from the HII database.
438 @param This A pointer to the EFI_HII_PROTOCOL instance.
440 @param Handle The handle that was registered to the data that is requested
443 @retval EFI_SUCCESS The data associated with the Handle was removed
444 from the HII database.
446 @retval EFI_INVALID_PARAMETER The Handle was not valid.
451 (EFIAPI
*EFI_HII_REMOVE_PACK
) (
452 IN EFI_HII_PROTOCOL
*This
,
453 IN EFI_HII_HANDLE Handle
457 Determines the handles that are currently active in the database.
459 @param This A pointer to the EFI_HII_PROTOCOL instance.
461 @param HandleBufferLength On input, a pointer to the length of the handle
462 buffer. On output, the length of the handle buffer that is required
463 for the handles found.
465 @param Handle An array of EFI_HII_HANDLE instances returned.
467 @retval EFI_SUCCESS Handle was updated successfully.
469 @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates
470 that Handle is too small to support the number of handles.
475 (EFIAPI
*EFI_HII_FIND_HANDLES
) (
476 IN EFI_HII_PROTOCOL
*This
,
477 IN OUT UINT16
*HandleBufferLength
,
478 OUT EFI_HII_HANDLE
*Handle
482 Exports the contents of the database into a buffer.
484 @param This A pointer to the EFI_HII_PROTOCOL instance.
486 @param Handle An EFI_HII_HANDLE that corresponds to the desired
487 handle to export. If the value is 0, the entire database will be exported.
488 In either case, the data will be exported in a format described by the
489 structure definition of EFI_HII_EXPORT_TABLE.
492 On input, a pointer to the length of the buffer. On output, the length
493 of the buffer that is required for the export data.
495 @param Buffer A pointer to a buffer that will contain the results of the export function.
497 @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.
499 @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.
504 (EFIAPI
*EFI_HII_EXPORT
) (
505 IN EFI_HII_PROTOCOL
*This
,
506 IN EFI_HII_HANDLE Handle
,
507 IN OUT UINTN
*BufferSize
,
512 Remove any new strings that were added after the initial string export
515 @param This A pointer to the EFI_HII_PROTOCOL instance.
517 @param Handle The handle on which the string resides.
519 @retval EFI_SUCCESS Remove strings from the handle successfully.
521 @retval EFI_INVALID_PARAMETER The Handle was unknown.
526 (EFIAPI
*EFI_HII_RESET_STRINGS
) (
527 IN EFI_HII_PROTOCOL
*This
,
528 IN EFI_HII_HANDLE Handle
532 Tests if all of the characters in a string have corresponding font characters.
534 @param This A pointer to the EFI_HII_PROTOCOL instance.
536 @param StringToTest A pointer to a Unicode string.
538 @param FirstMissing A pointer to an index into the string. On input,
539 the index of the first character in the StringToTest to examine. On exit,
540 the index of the first character encountered for which a glyph is unavailable.
541 If all glyphs in the string are available, the index is the index of the
542 terminator of the string.
544 @param GlyphBufferSize A pointer to a value. On output, if the function
545 returns EFI_SUCCESS, it contains the amount of memory that is required to
546 store the string¡¯s glyph equivalent.
548 @retval EFI_SUCCESS All glyphs are available. Note that an empty string
549 always returns this value.
551 @retval EFI_NOT_FOUND A glyph was not found for a character.
556 (EFIAPI
*EFI_HII_TEST_STRING
) (
557 IN EFI_HII_PROTOCOL
*This
,
558 IN CHAR16
*StringToTest
,
559 IN OUT UINT32
*FirstMissing
,
560 OUT UINT32
*GlyphBufferSize
564 Translates a Unicode character into the corresponding font glyph.
566 @param This A pointer to the EFI_HII_PROTOCOL instance.
568 @param Source A pointer to a Unicode string.
570 @param Index On input, the offset into the string from which to fetch
571 the character.On successful completion, the index is updated to the first
572 character past the character(s) making up the just extracted glyph.
574 @param GlyphBuffer Pointer to an array where the glyphs corresponding
575 to the characters in the source may be stored. GlyphBuffer is assumed
576 to be wide enough to accept a wide glyph character.
578 @param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by
579 this value is filled with the length of the glyph in pixels. It is unchanged
580 if the call was unsuccessful.
582 @param InternalStatus The cell pointed to by this parameter must be
583 initialized to zero prior to invoking the call the first time for any string.
585 @retval EFI_SUCCESS It worked.
587 @retval EFI_NOT_FOUND A glyph for a character was not found.
592 (EFIAPI
*EFI_HII_GET_GLYPH
) (
593 IN EFI_HII_PROTOCOL
*This
,
595 IN OUT UINT16
*Index
,
596 OUT UINT8
**GlyphBuffer
,
597 OUT UINT16
*BitWidth
,
598 IN OUT UINT32
*InternalStatus
602 Translates a glyph into the format required for input to the Universal
603 Graphics Adapter (UGA) Block Transfer (BLT) routines.
605 @param This A pointer to the EFI_HII_PROTOCOL instance.
607 @param GlyphBuffer A pointer to the buffer that contains glyph data.
609 @param Foreground The foreground setting requested to be used for the
610 generated BltBuffer data.
612 @param Background The background setting requested to be used for the
613 generated BltBuffer data.
615 @param Count The entry in the BltBuffer upon which to act.
617 @param Width The width in bits of the glyph being converted.
619 @param Height The height in bits of the glyph being converted
621 @param BltBuffer A pointer to the buffer that contains the data that is
622 ready to be used by the UGA BLT routines.
624 @retval EFI_SUCCESS It worked.
626 @retval EFI_NOT_FOUND A glyph for a character was not found.
631 (EFIAPI
*EFI_HII_GLYPH_TO_BLT
) (
632 IN EFI_HII_PROTOCOL
*This
,
633 IN UINT8
*GlyphBuffer
,
634 IN EFI_UGA_PIXEL Foreground
,
635 IN EFI_UGA_PIXEL Background
,
639 IN OUT EFI_UGA_PIXEL
*BltBuffer
643 Allows a new string to be added to an already existing string package.
645 @param This A pointer to the EFI_HII_PROTOCOL instance.
647 @param Pointer to a NULL-terminated string containing a single ISO 639-2
648 language identifier, indicating the language in which the string is translated.
650 @param Handle The handle of the language pack to which the string is to be added.
652 @param Reference The identifier of the string to be added. If the reference
653 value is zero, then the string will be assigned a new identifier on that
654 handle for the language specified. Otherwise, the string will be updated
655 with the NewString Value.
657 @param NewString The string to be added.
659 @retval EFI_SUCCESS The string was effectively registered.
661 @retval EFI_INVALID_PARAMETER The Handle was unknown.
666 (EFIAPI
*EFI_HII_NEW_STRING
) (
667 IN EFI_HII_PROTOCOL
*This
,
669 IN EFI_HII_HANDLE Handle
,
670 IN OUT STRING_REF
*Reference
,
675 Allows a program to determine the primary languages that are supported
678 @param This A pointer to the EFI_HII_PROTOCOL instance.
680 @param Handle The handle on which the strings reside.
682 @param LanguageString A string allocated by GetPrimaryLanguages() that
683 contains a list of all primary languages registered on the handle.
685 @retval EFI_SUCCESS LanguageString was correctly returned.
687 @retval EFI_INVALID_PARAMETER The Handle was unknown.
692 (EFIAPI
*EFI_HII_GET_PRI_LANGUAGES
) (
693 IN EFI_HII_PROTOCOL
*This
,
694 IN EFI_HII_HANDLE Handle
,
695 OUT EFI_STRING
*LanguageString
699 Allows a program to determine which secondary languages are supported
700 on a given handle for a given primary language.
702 @param This A pointer to the EFI_HII_PROTOCOL instance.
704 @param Handle The handle on which the strings reside.
706 @param PrimaryLanguage Pointer to a NULL-terminated string containing a single
707 ISO 639-2 language identifier, indicating the primary language.
709 @param LanguageString A string allocated by GetSecondaryLanguages()
710 containing a list of all secondary languages registered on the handle.
712 @retval EFI_SUCCESS LanguageString was correctly returned.
714 @retval EFI_INVALID_PARAMETER The Handle was unknown.
719 (EFIAPI
*EFI_HII_GET_SEC_LANGUAGES
) (
720 IN EFI_HII_PROTOCOL
*This
,
721 IN EFI_HII_HANDLE Handle
,
722 IN CHAR16
*PrimaryLanguage
,
723 OUT EFI_STRING
*LanguageString
727 Extracts a string from a package already registered with the EFI HII database.
729 @param This A pointer to the EFI_HII_PROTOCOL instance.
731 @param Handle The handle on which the string resides.
733 @param Token The string token assigned to the string.
735 @param Raw If TRUE, the string is returned unedited in the internal
736 storage format described above. If false, the string returned is edited
737 by replacing <cr> with <space> and by removing special characters such
738 as the <wide> prefix.
740 @param LanguageString Pointer to a NULL-terminated string containing a
741 single ISO 639-2 language identifier, indicating the language to print.
742 If the LanguageString is empty (starts with a NULL), the default system
743 language will be used to determine the language.
745 @param BufferLength Length of the StringBuffer.
747 @param StringBuffer The buffer designed to receive the characters in the string.
749 @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.
751 @retval EFI_INVALID_PARAMETER The handle or string token is unknown.
753 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to
754 allow the entire string to be stored.
759 (EFIAPI
*EFI_HII_GET_STRING
) (
760 IN EFI_HII_PROTOCOL
*This
,
761 IN EFI_HII_HANDLE Handle
,
764 IN CHAR16
*LanguageString
,
765 IN OUT UINTN
*BufferLength
,
766 OUT EFI_STRING StringBuffer
770 Allows a program to extract a part of a string of not more than a given width.
772 @param This A pointer to the EFI_HII_PROTOCOL instance.
774 @param Handle The handle on which the string resides.
776 @param Token The string token assigned to the string.
778 @param Index On input, the offset into the string where the line is to start.
779 On output, the index is updated to point to beyond the last character returned
782 @param LineWidth The maximum width of the line in units of narrow glyphs.
784 @param LanguageString Pointer to a NULL-terminated string containing a
785 single ISO 639-2 language identifier, indicating the language to print.
787 @param BufferLength Pointer to the length of the StringBuffer.
789 @param StringBuffer The buffer designed to receive the characters in the string.
791 @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.
793 @retval EFI_NOT_FOUND The font glyph for at least one of the characters in
794 the string is not in the font database.
796 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
797 to allow the entire string to be stored.
802 (EFIAPI
*EFI_HII_GET_LINE
) (
803 IN EFI_HII_PROTOCOL
*This
,
804 IN EFI_HII_HANDLE Handle
,
806 IN OUT UINT16
*Index
,
808 IN CHAR16
*LanguageString
,
809 IN OUT UINT16
*BufferLength
,
810 OUT EFI_STRING StringBuffer
814 Allows a program to extract a form or form package that has previously
815 been registered with the HII database.
817 @param This A pointer to the EFI_HII_PROTOCOL instance.
819 @param Handle Handle on which the form resides.
821 @param FormId The ID of the form to return. If the ID is zero,
822 the entire form package is returned.
824 @param BufferLength On input, the length of the Buffer. On output,
825 the length of the returned buffer,
827 @param Buffer The buffer designed to receive the form(s).
829 @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength
832 @retval EFI_INVALID_PARAMETER The handle is unknown.
834 @retval EFI_NOT_FOUND A form on the requested handle cannot be found with
835 the requested FormId.
837 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
838 to allow the form to be stored.
843 (EFIAPI
*EFI_HII_GET_FORMS
) (
844 IN EFI_HII_PROTOCOL
*This
,
845 IN EFI_HII_HANDLE Handle
,
846 IN EFI_FORM_ID FormId
,
847 IN OUT UINTN
*BufferLength
,
852 Extracts the defaults that are associated with a given handle in the HII database.
854 @param This A pointer to the EFI_HII_PROTOCOL instance.
856 @param Handle The HII handle from which will have default data retrieved.
858 @param DefaultMask The mask used to specify some type of default override when extracting
859 the default image data.
861 @param VariablePackList A indirect pointer to the first entry of a link list with
862 type EFI_HII_VARIABLE_PACK_LIST.
864 @retval EFI_SUCCESS The VariablePackList was populated with the appropriate
865 default setting data.
867 @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).
869 @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle
870 contain invalid data.
875 (EFIAPI
*EFI_HII_GET_DEFAULT_IMAGE
) (
876 IN EFI_HII_PROTOCOL
*This
,
877 IN EFI_HII_HANDLE Handle
,
878 IN UINTN DefaultMask
,
879 OUT EFI_HII_VARIABLE_PACK_LIST
**VariablePackList
883 Allows the caller to update a form or form package that has previously been
884 registered with the EFI HII database.
886 @param This A pointer to the EFI_HII_PROTOCOL instance.
888 @param Handle Handle of the package where the form to be updated resides.
890 @param Label The label inside the form package where the update is to take place.
892 @param AddData If TRUE, adding data at a given Label; otherwise,
893 if FALSE, removing data at a given Label.
895 @param Data The buffer containing the new tags to insert after the Label
897 @retval EFI_SUCCESS The form was updated with the new tags.
899 @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not
900 contain an integral number of tags.
902 @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found.
907 (EFIAPI
*EFI_HII_UPDATE_FORM
) (
908 IN EFI_HII_PROTOCOL
*This
,
909 IN EFI_HII_HANDLE Handle
,
910 IN EFI_FORM_LABEL Label
,
912 IN EFI_HII_UPDATE_DATA
*Data
916 Retrieves the current keyboard layout.
918 @param This A pointer to the EFI_HII_PROTOCOL instance.
920 @param DescriptorCount A pointer to the number of Descriptor entries being
921 described in the keyboard layout being retrieved.
923 @param Descriptor A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR
924 entries. Each entry will reflect the definition of a specific physical key.
926 @retval EFI_SUCCESS The keyboard layout was retrieved successfully.
931 (EFIAPI
*EFI_HII_GET_KEYBOARD_LAYOUT
) (
932 IN EFI_HII_PROTOCOL
*This
,
933 OUT UINT16
*DescriptorCount
,
934 OUT EFI_KEY_DESCRIPTOR
*Descriptor
938 @par Protocol Description:
939 The HII Protocol manages the HII database, which is a repository for data
940 having to do with fonts, strings, forms, keyboards, and other future human
944 Extracts the various packs from a package list.
947 Removes a package from the HII database.
950 Determines the handles that are currently active in the database.
952 @param ExportDatabase
953 Export the entire contents of the database to a buffer.
956 Tests if all of the characters in a string have corresponding font characters.
959 Translates a Unicode character into the corresponding font glyph.
962 Converts a glyph value into a format that is ready for a UGA BLT command.
965 Allows a new string to be added to an already existing string package.
967 @param GetPrimaryLanguages
968 Allows a program to determine the primary languages that are supported
971 @param GetSecondaryLanguages
972 Allows a program to determine which secondary languages are supported
973 on a given handle for a given primary language.
976 Extracts a string from a package that is already registered with the
980 Remove any new strings that were added after the initial string export
984 Allows a program to extract a part of a string of not more than a given width.
987 Allows a program to extract a form or form package that has been previously registered.
989 @param GetDefaultImage
990 Allows a program to extract the nonvolatile image that represents the default storage image.
993 Allows a program to update a previously registered form.
995 @param GetKeyboardLayout
996 Allows a program to extract the current keyboard layout.
999 struct _EFI_HII_PROTOCOL
{
1000 EFI_HII_NEW_PACK NewPack
;
1001 EFI_HII_REMOVE_PACK RemovePack
;
1002 EFI_HII_FIND_HANDLES FindHandles
;
1003 EFI_HII_EXPORT ExportDatabase
;
1005 EFI_HII_TEST_STRING TestString
;
1006 EFI_HII_GET_GLYPH GetGlyph
;
1007 EFI_HII_GLYPH_TO_BLT GlyphToBlt
;
1009 EFI_HII_NEW_STRING NewString
;
1010 EFI_HII_GET_PRI_LANGUAGES GetPrimaryLanguages
;
1011 EFI_HII_GET_SEC_LANGUAGES GetSecondaryLanguages
;
1012 EFI_HII_GET_STRING GetString
;
1013 EFI_HII_RESET_STRINGS ResetStrings
;
1014 EFI_HII_GET_LINE GetLine
;
1015 EFI_HII_GET_FORMS GetForms
;
1016 EFI_HII_GET_DEFAULT_IMAGE GetDefaultImage
;
1017 EFI_HII_UPDATE_FORM UpdateForm
;
1019 EFI_HII_GET_KEYBOARD_LAYOUT GetKeyboardLayout
;
1022 extern EFI_GUID gEfiHiiProtocolGuid
;