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.
416 @param Packages A pointer to an EFI_HII_PACKAGES package instance.
417 @param Handle A pointer to the EFI_HII_HANDLE instance.
419 @retval EFI_SUCCESS Data was extracted from Packages, the database
420 was updated with the data, and Handle returned successfully.
421 @retval EFI_INVALID_PARAMETER The content of Packages was invalid.
426 (EFIAPI
*EFI_HII_NEW_PACK
) (
427 IN EFI_HII_PROTOCOL
*This
,
428 IN EFI_HII_PACKAGES
*Packages
,
429 OUT EFI_HII_HANDLE
*Handle
433 Removes a package from the HII database.
435 @param This A pointer to the EFI_HII_PROTOCOL instance.
436 @param Handle The handle that was registered to the data that is requested
439 @retval EFI_SUCCESS The data associated with the Handle was removed
440 from the HII database.
441 @retval EFI_INVALID_PARAMETER The Handle was not valid.
446 (EFIAPI
*EFI_HII_REMOVE_PACK
) (
447 IN EFI_HII_PROTOCOL
*This
,
448 IN EFI_HII_HANDLE Handle
452 Determines the handles that are currently active in the database.
454 @param This A pointer to the EFI_HII_PROTOCOL instance.
455 @param HandleBufferLength On input, a pointer to the length of the handle
456 buffer. On output, the length of the handle buffer that is required
457 for the handles found.
458 @param Handle An array of EFI_HII_HANDLE instances returned.
460 @retval EFI_SUCCESS Handle was updated successfully.
461 @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates
462 that Handle is too small to support the number of handles.
467 (EFIAPI
*EFI_HII_FIND_HANDLES
) (
468 IN EFI_HII_PROTOCOL
*This
,
469 IN OUT UINT16
*HandleBufferLength
,
470 OUT EFI_HII_HANDLE
*Handle
474 Exports the contents of the database into a buffer.
476 @param This A pointer to the EFI_HII_PROTOCOL instance.
477 @param Handle An EFI_HII_HANDLE that corresponds to the desired
478 handle to export. If the value is 0, the entire database will be exported.
479 In either case, the data will be exported in a format described by the
480 structure definition of EFI_HII_EXPORT_TABLE.
482 On input, a pointer to the length of the buffer. On output, the length
483 of the buffer that is required for the export data.
484 @param Buffer A pointer to a buffer that will contain the results of the export function.
486 @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.
487 @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.
492 (EFIAPI
*EFI_HII_EXPORT
) (
493 IN EFI_HII_PROTOCOL
*This
,
494 IN EFI_HII_HANDLE Handle
,
495 IN OUT UINTN
*BufferSize
,
500 Remove any new strings that were added after the initial string export
503 @param This A pointer to the EFI_HII_PROTOCOL instance.
504 @param Handle The handle on which the string resides.
506 @retval EFI_SUCCESS Remove strings from the handle successfully.
507 @retval EFI_INVALID_PARAMETER The Handle was unknown.
512 (EFIAPI
*EFI_HII_RESET_STRINGS
) (
513 IN EFI_HII_PROTOCOL
*This
,
514 IN EFI_HII_HANDLE Handle
518 Tests if all of the characters in a string have corresponding font characters.
520 @param This A pointer to the EFI_HII_PROTOCOL instance.
521 @param StringToTest A pointer to a Unicode string.
522 @param FirstMissing A pointer to an index into the string. On input,
523 the index of the first character in the StringToTest to examine. On exit,
524 the index of the first character encountered for which a glyph is unavailable.
525 If all glyphs in the string are available, the index is the index of the
526 terminator of the string.
527 @param GlyphBufferSize A pointer to a value. On output, if the function
528 returns EFI_SUCCESS, it contains the amount of memory that is required to
529 store the string¡¯s glyph equivalent.
531 @retval EFI_SUCCESS All glyphs are available. Note that an empty string
532 always returns this value.
533 @retval EFI_NOT_FOUND A glyph was not found for a character.
538 (EFIAPI
*EFI_HII_TEST_STRING
) (
539 IN EFI_HII_PROTOCOL
*This
,
540 IN CHAR16
*StringToTest
,
541 IN OUT UINT32
*FirstMissing
,
542 OUT UINT32
*GlyphBufferSize
546 Translates a Unicode character into the corresponding font glyph.
548 @param This A pointer to the EFI_HII_PROTOCOL instance.
549 @param Source A pointer to a Unicode string.
550 @param Index On input, the offset into the string from which to fetch
551 the character.On successful completion, the index is updated to the first
552 character past the character(s) making up the just extracted glyph.
553 @param GlyphBuffer Pointer to an array where the glyphs corresponding
554 to the characters in the source may be stored. GlyphBuffer is assumed
555 to be wide enough to accept a wide glyph character.
556 @param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by
557 this value is filled with the length of the glyph in pixels. It is unchanged
558 if the call was unsuccessful.
559 @param InternalStatus The cell pointed to by this parameter must be
560 initialized to zero prior to invoking the call the first time for any string.
562 @retval EFI_SUCCESS It worked.
563 @retval EFI_NOT_FOUND A glyph for a character was not found.
568 (EFIAPI
*EFI_HII_GET_GLYPH
) (
569 IN EFI_HII_PROTOCOL
*This
,
571 IN OUT UINT16
*Index
,
572 OUT UINT8
**GlyphBuffer
,
573 OUT UINT16
*BitWidth
,
574 IN OUT UINT32
*InternalStatus
578 Translates a glyph into the format required for input to the Universal
579 Graphics Adapter (UGA) Block Transfer (BLT) routines.
581 @param This A pointer to the EFI_HII_PROTOCOL instance.
582 @param GlyphBuffer A pointer to the buffer that contains glyph data.
583 @param Foreground The foreground setting requested to be used for the
584 generated BltBuffer data.
585 @param Background The background setting requested to be used for the
586 generated BltBuffer data.
587 @param Count The entry in the BltBuffer upon which to act.
588 @param Width The width in bits of the glyph being converted.
589 @param Height The height in bits of the glyph being converted
590 @param BltBuffer A pointer to the buffer that contains the data that is
591 ready to be used by the UGA BLT routines.
593 @retval EFI_SUCCESS It worked.
594 @retval EFI_NOT_FOUND A glyph for a character was not found.
599 (EFIAPI
*EFI_HII_GLYPH_TO_BLT
) (
600 IN EFI_HII_PROTOCOL
*This
,
601 IN UINT8
*GlyphBuffer
,
602 IN EFI_UGA_PIXEL Foreground
,
603 IN EFI_UGA_PIXEL Background
,
607 IN OUT EFI_UGA_PIXEL
*BltBuffer
611 Allows a new string to be added to an already existing string package.
613 @param This A pointer to the EFI_HII_PROTOCOL instance.
614 @param Pointer to a NULL-terminated string containing a single ISO 639-2
615 language identifier, indicating the language in which the string is translated.
616 @param Handle The handle of the language pack to which the string is to be added.
617 @param Reference The identifier of the string to be added. If the reference
618 value is zero, then the string will be assigned a new identifier on that
619 handle for the language specified. Otherwise, the string will be updated
620 with the NewString Value.
621 @param NewString The string to be added.
623 @retval EFI_SUCCESS The string was effectively registered.
624 @retval EFI_INVALID_PARAMETER The Handle was unknown.
629 (EFIAPI
*EFI_HII_NEW_STRING
) (
630 IN EFI_HII_PROTOCOL
*This
,
632 IN EFI_HII_HANDLE Handle
,
633 IN OUT STRING_REF
*Reference
,
638 Allows a program to determine the primary languages that are supported
641 @param This A pointer to the EFI_HII_PROTOCOL instance.
642 @param Handle The handle on which the strings reside.
643 @param LanguageString A string allocated by GetPrimaryLanguages() that
644 contains a list of all primary languages registered on the handle.
646 @retval EFI_SUCCESS LanguageString was correctly returned.
647 @retval EFI_INVALID_PARAMETER The Handle was unknown.
652 (EFIAPI
*EFI_HII_GET_PRI_LANGUAGES
) (
653 IN EFI_HII_PROTOCOL
*This
,
654 IN EFI_HII_HANDLE Handle
,
655 OUT EFI_STRING
*LanguageString
659 Allows a program to determine which secondary languages are supported
660 on a given handle for a given primary language.
662 @param This A pointer to the EFI_HII_PROTOCOL instance.
663 @param Handle The handle on which the strings reside.
664 @param PrimaryLanguage Pointer to a NULL-terminated string containing a single
665 ISO 639-2 language identifier, indicating the primary language.
666 @param LanguageString A string allocated by GetSecondaryLanguages()
667 containing a list of all secondary languages registered on the handle.
669 @retval EFI_SUCCESS LanguageString was correctly returned.
670 @retval EFI_INVALID_PARAMETER The Handle was unknown.
675 (EFIAPI
*EFI_HII_GET_SEC_LANGUAGES
) (
676 IN EFI_HII_PROTOCOL
*This
,
677 IN EFI_HII_HANDLE Handle
,
678 IN CHAR16
*PrimaryLanguage
,
679 OUT EFI_STRING
*LanguageString
683 Extracts a string from a package already registered with the EFI HII database.
685 @param This A pointer to the EFI_HII_PROTOCOL instance.
686 @param Handle The handle on which the string resides.
687 @param Token The string token assigned to the string.
688 @param Raw If TRUE, the string is returned unedited in the internal
689 storage format described above. If false, the string returned is edited
690 by replacing <cr> with <space> and by removing special characters such
691 as the <wide> prefix.
692 @param LanguageString Pointer to a NULL-terminated string containing a
693 single ISO 639-2 language identifier, indicating the language to print.
694 If the LanguageString is empty (starts with a NULL), the default system
695 language will be used to determine the language.
696 @param BufferLength Length of the StringBuffer.
697 @param StringBuffer The buffer designed to receive the characters in the string.
699 @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.
700 @retval EFI_INVALID_PARAMETER The handle or string token is unknown.
701 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to
702 allow the entire string to be stored.
707 (EFIAPI
*EFI_HII_GET_STRING
) (
708 IN EFI_HII_PROTOCOL
*This
,
709 IN EFI_HII_HANDLE Handle
,
712 IN CHAR16
*LanguageString
,
713 IN OUT UINTN
*BufferLength
,
714 OUT EFI_STRING StringBuffer
718 Allows a program to extract a part of a string of not more than a given width.
720 @param This A pointer to the EFI_HII_PROTOCOL instance.
721 @param Handle The handle on which the string resides.
722 @param Token The string token assigned to the string.
723 @param Index On input, the offset into the string where the line is to start.
724 On output, the index is updated to point to beyond the last character returned
726 @param LineWidth The maximum width of the line in units of narrow glyphs.
727 @param LanguageString Pointer to a NULL-terminated string containing a
728 single ISO 639-2 language identifier, indicating the language to print.
729 @param BufferLength Pointer to the length of the StringBuffer.
730 @param StringBuffer The buffer designed to receive the characters in the string.
732 @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.
733 @retval EFI_NOT_FOUND The font glyph for at least one of the characters in
734 the string is not in the font database.
735 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
736 to allow the entire string to be stored.
741 (EFIAPI
*EFI_HII_GET_LINE
) (
742 IN EFI_HII_PROTOCOL
*This
,
743 IN EFI_HII_HANDLE Handle
,
745 IN OUT UINT16
*Index
,
747 IN CHAR16
*LanguageString
,
748 IN OUT UINT16
*BufferLength
,
749 OUT EFI_STRING StringBuffer
753 Allows a program to extract a form or form package that has previously
754 been registered with the HII database.
756 @param This A pointer to the EFI_HII_PROTOCOL instance.
757 @param Handle Handle on which the form resides.
758 @param FormId The ID of the form to return. If the ID is zero,
759 the entire form package is returned.
760 @param BufferLength On input, the length of the Buffer. On output,
761 the length of the returned buffer,
762 @param Buffer The buffer designed to receive the form(s).
764 @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength
766 @retval EFI_INVALID_PARAMETER The handle is unknown.
767 @retval EFI_NOT_FOUND A form on the requested handle cannot be found with
768 the requested FormId.
769 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
770 to allow the form to be stored.
775 (EFIAPI
*EFI_HII_GET_FORMS
) (
776 IN EFI_HII_PROTOCOL
*This
,
777 IN EFI_HII_HANDLE Handle
,
778 IN EFI_FORM_ID FormId
,
779 IN OUT UINTN
*BufferLength
,
784 Extracts the defaults that are associated with a given handle in the HII database.
786 @param This A pointer to the EFI_HII_PROTOCOL instance.
787 @param Handle The HII handle from which will have default data retrieved.
788 @param DefaultMask The mask used to specify some type of default override when extracting
789 the default image data.
790 @param VariablePackList A indirect pointer to the first entry of a link list with
791 type EFI_HII_VARIABLE_PACK_LIST.
793 @retval EFI_SUCCESS The VariablePackList was populated with the appropriate
794 default setting data.
795 @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).
796 @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle
797 contain invalid data.
802 (EFIAPI
*EFI_HII_GET_DEFAULT_IMAGE
) (
803 IN EFI_HII_PROTOCOL
*This
,
804 IN EFI_HII_HANDLE Handle
,
805 IN UINTN DefaultMask
,
806 OUT EFI_HII_VARIABLE_PACK_LIST
**VariablePackList
810 Allows the caller to update a form or form package that has previously been
811 registered with the EFI HII database.
813 @param This A pointer to the EFI_HII_PROTOCOL instance.
814 @param Handle Handle of the package where the form to be updated resides.
815 @param Label The label inside the form package where the update is to take place.
816 @param AddData If TRUE, adding data at a given Label; otherwise,
817 if FALSE, removing data at a given Label.
818 @param Data The buffer containing the new tags to insert after the Label
820 @retval EFI_SUCCESS The form was updated with the new tags.
821 @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not
822 contain an integral number of tags.
823 @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found.
828 (EFIAPI
*EFI_HII_UPDATE_FORM
) (
829 IN EFI_HII_PROTOCOL
*This
,
830 IN EFI_HII_HANDLE Handle
,
831 IN EFI_FORM_LABEL Label
,
833 IN EFI_HII_UPDATE_DATA
*Data
837 Retrieves the current keyboard layout.
839 @param This A pointer to the EFI_HII_PROTOCOL instance.
840 @param DescriptorCount A pointer to the number of Descriptor entries being
841 described in the keyboard layout being retrieved.
842 @param Descriptor A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR
843 entries. Each entry will reflect the definition of a specific physical key.
845 @retval EFI_SUCCESS The keyboard layout was retrieved successfully.
850 (EFIAPI
*EFI_HII_GET_KEYBOARD_LAYOUT
) (
851 IN EFI_HII_PROTOCOL
*This
,
852 OUT UINT16
*DescriptorCount
,
853 OUT EFI_KEY_DESCRIPTOR
*Descriptor
857 @par Protocol Description:
858 The HII Protocol manages the HII database, which is a repository for data
859 having to do with fonts, strings, forms, keyboards, and other future human
863 Extracts the various packs from a package list.
866 Removes a package from the HII database.
869 Determines the handles that are currently active in the database.
871 @param ExportDatabase
872 Export the entire contents of the database to a buffer.
875 Tests if all of the characters in a string have corresponding font characters.
878 Translates a Unicode character into the corresponding font glyph.
881 Converts a glyph value into a format that is ready for a UGA BLT command.
884 Allows a new string to be added to an already existing string package.
886 @param GetPrimaryLanguages
887 Allows a program to determine the primary languages that are supported
890 @param GetSecondaryLanguages
891 Allows a program to determine which secondary languages are supported
892 on a given handle for a given primary language.
895 Extracts a string from a package that is already registered with the
899 Remove any new strings that were added after the initial string export
903 Allows a program to extract a part of a string of not more than a given width.
906 Allows a program to extract a form or form package that has been previously registered.
908 @param GetDefaultImage
909 Allows a program to extract the nonvolatile image that represents the default storage image.
912 Allows a program to update a previously registered form.
914 @param GetKeyboardLayout
915 Allows a program to extract the current keyboard layout.
918 struct _EFI_HII_PROTOCOL
{
919 EFI_HII_NEW_PACK NewPack
;
920 EFI_HII_REMOVE_PACK RemovePack
;
921 EFI_HII_FIND_HANDLES FindHandles
;
922 EFI_HII_EXPORT ExportDatabase
;
924 EFI_HII_TEST_STRING TestString
;
925 EFI_HII_GET_GLYPH GetGlyph
;
926 EFI_HII_GLYPH_TO_BLT GlyphToBlt
;
928 EFI_HII_NEW_STRING NewString
;
929 EFI_HII_GET_PRI_LANGUAGES GetPrimaryLanguages
;
930 EFI_HII_GET_SEC_LANGUAGES GetSecondaryLanguages
;
931 EFI_HII_GET_STRING GetString
;
932 EFI_HII_RESET_STRINGS ResetStrings
;
933 EFI_HII_GET_LINE GetLine
;
934 EFI_HII_GET_FORMS GetForms
;
935 EFI_HII_GET_DEFAULT_IMAGE GetDefaultImage
;
936 EFI_HII_UPDATE_FORM UpdateForm
;
938 EFI_HII_GET_KEYBOARD_LAYOUT GetKeyboardLayout
;
941 extern EFI_GUID gEfiHiiProtocolGuid
;