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_LABEL
;
87 } EFI_HII_PACK_HEADER
;
90 // A form list consists of a large variety of structure
91 // possibilities so to represent the binary blob of data
92 // associated with a package of forms, we will assume a
93 // pointer to a self-describing data buffer.
96 EFI_HII_PACK_HEADER Header
;
100 EFI_HII_PACK_HEADER Header
; // Must be filled in
101 EFI_HANDLE ImageHandle
; // Must be filled in
102 EFI_HANDLE DeviceHandle
; // Optional
103 EFI_HANDLE ControllerHandle
; // Optional
104 EFI_HANDLE CallbackHandle
; // Optional
105 EFI_HANDLE COBExportHandle
; // Optional
106 } EFI_HII_HANDLE_PACK
;
109 // ********************************************************
110 // EFI_VARIABLE_CONTENTS
111 // ********************************************************
114 EFI_HII_PACK_HEADER Header
;
115 EFI_GUID VariableGuid
;
116 UINT32 VariableNameLength
;
119 // CHAR16 VariableName[]; //Null-terminated
121 } EFI_HII_VARIABLE_PACK
;
124 // ********************************************************
125 // EFI_DEVICE_PATH_PACK
126 // ********************************************************
129 EFI_HII_PACK_HEADER Header
;
131 // EFI_DEVICE_PATH DevicePath[];
133 } EFI_HII_DEVICE_PATH_PACK
;
136 // ********************************************************
137 // EFI_HII_DATA_TABLE
138 // ********************************************************
141 EFI_HII_HANDLE HiiHandle
;
142 EFI_GUID PackageGuid
;
143 UINT32 DataTableSize
;
144 UINT32 IfrDataOffset
;
145 UINT32 StringDataOffset
;
146 UINT32 VariableDataOffset
;
147 UINT32 DevicePathOffset
;
148 UINT32 NumberOfVariableData
;
149 UINT32 NumberOfLanguages
;
151 // EFI_HII_DEVICE_PATH_PACK DevicePath[];
152 // EFI_HII_VARIABLE_PACK VariableData[];
153 // EFI_HII_IFR_PACK IfrData;
154 // EFI_HII_STRING_PACK StringData[];
156 } EFI_HII_DATA_TABLE
;
159 // ********************************************************
160 // EFI_HII_EXPORT_TABLE
161 // ********************************************************
164 UINT32 NumberOfHiiDataTables
;
167 // EFI_HII_DATA_TABLE HiiDataTable[];
169 } EFI_HII_EXPORT_TABLE
;
172 BOOLEAN FormSetUpdate
; // If TRUE, next variable is significant
173 EFI_PHYSICAL_ADDRESS FormCallbackHandle
; // If not 0, will update Formset with this info
174 BOOLEAN FormUpdate
; // If TRUE, next variable is significant
175 UINT16 FormValue
; // specify which form is to be updated if FormUpdate value is TRUE.
176 STRING_REF FormTitle
; // If not 0, will update Form with this info
177 UINT16 DataCount
; // The number of Data entries in this structure
178 UINT8
*Data
; // An array of 1+ op-codes, specified by DataCount
179 } EFI_HII_UPDATE_DATA
;
184 #define LANG_RIGHT_TO_LEFT 0x00000001
187 // A string package is used to localize strings to a particular
188 // language. The package is associated with a particular driver
189 // or set of drivers. Tools are used to associate tokens with
190 // string references in forms and in programs. These tokens are
191 // language agnostic. When paired with a language pack (directly
192 // or indirectly), the string token resolves into an actual
193 // UNICODE string. The NumStringPointers determines how many
194 // StringPointers (offset values) there are as well as the total
195 // number of Strings that are defined.
198 EFI_HII_PACK_HEADER Header
;
199 RELOFST LanguageNameString
;
200 RELOFST PrintableLanguageName
;
201 UINT32 NumStringPointers
;
204 // RELOFST StringPointers[];
205 // EFI_STRING Strings[];
207 } EFI_HII_STRING_PACK
;
212 #define EFI_GLYPH_NON_SPACING 1
213 #define EFI_GLYPH_WIDE 2
216 CHAR16 UnicodeWeight
;
218 UINT8 GlyphCol1
[GLYPH_HEIGHT
];
222 CHAR16 UnicodeWeight
;
224 UINT8 GlyphCol1
[GLYPH_HEIGHT
];
225 UINT8 GlyphCol2
[GLYPH_HEIGHT
];
230 // A font list consists of a font header followed by a series
231 // of glyph structures. Note that fonts are not language specific.
234 EFI_HII_PACK_HEADER Header
;
235 UINT16 NumberOfNarrowGlyphs
;
236 UINT16 NumberOfWideGlyphs
;
240 // The IfrData in the EFI_HII_IFR_PACK structure definition
241 // is variable length, and not really part of the header. To
242 // simplify from code the size of the header, define an
243 // identical structure that does not include the IfrData field.
244 // Then use sizeof() this new structure to determine the
245 // actual size of the header.
248 EFI_HII_PACK_HEADER Header
;
249 } EFI_HII_IFR_PACK_HEADER
;
252 // pedef EFI_HII_PACK_HEADER EFI_HII_IFR_PACK_HEADER;
365 CHAR16 ShiftedUnicode
;
367 CHAR16 ShiftedAltGrUnicode
;
369 } EFI_KEY_DESCRIPTOR
;
372 // This structure allows a sparse set of keys to be redefined
373 // or a complete redefinition of the keyboard layout. Most
374 // keyboards have a lot of commonality in their layouts, therefore
375 // only defining those keys that need to change from the default
376 // minimizes the passed in information.
378 // Additionally, when an update occurs, the active keyboard layout
379 // will be switched to the newly updated keyboard layout. This
380 // allows for situations that when a keyboard layout driver is
381 // loaded as part of system initialization, the system will default
382 // the keyboard behavior to the new layout.
384 // Each call to update the keyboard mapping should contain the
385 // complete set of key descriptors to be updated, since every
386 // call to the HII which contains an EFI_HII_KEYBOARD_PACK will
387 // wipe the previous set of overrides. A call to
390 EFI_HII_PACK_HEADER Header
;
391 EFI_KEY_DESCRIPTOR
*Descriptor
;
392 UINT8 DescriptorCount
;
393 } EFI_HII_KEYBOARD_PACK
;
396 // The EFI_HII_PACKAGES can contain different types of packages just
397 // after the structure as inline data.
400 UINTN NumberOfPackages
;
403 // EFI_HII_HANDLE_PACK *HandlePack; // Only one pack.
404 // EFI_HII_IFR_PACK *IfrPack; // Only one pack.
405 // EFI_HII_FONT_PACK *FontPack[]; // Multiple packs ok
406 // EFI_HII_STRING_PACK *StringPack[]; // Multiple packs ok
407 // EFI_HII_KEYBOARD_PACK *KeyboardPack[]; // Multiple packs ok
411 typedef struct _EFI_HII_VARIABLE_PACK_LIST
{
412 struct _EFI_HII_VARIABLE_PACK_LIST
*NextVariablePack
;
413 EFI_HII_VARIABLE_PACK
*VariablePack
;
414 } EFI_HII_VARIABLE_PACK_LIST
;
419 Registers the various packs that are passed in via the Packages parameter.
421 @param This A pointer to the EFI_HII_PROTOCOL instance.
422 @param Packages A pointer to an EFI_HII_PACKAGES package instance.
423 @param Handle A pointer to the EFI_HII_HANDLE instance.
425 @retval EFI_SUCCESS Data was extracted from Packages, the database
426 was updated with the data, and Handle returned successfully.
427 @retval EFI_INVALID_PARAMETER The content of Packages was invalid.
432 (EFIAPI
*EFI_HII_NEW_PACK
) (
433 IN EFI_HII_PROTOCOL
*This
,
434 IN EFI_HII_PACKAGES
*Packages
,
435 OUT EFI_HII_HANDLE
*Handle
439 Removes a package from the HII database.
441 @param This A pointer to the EFI_HII_PROTOCOL instance.
442 @param Handle The handle that was registered to the data that is requested
445 @retval EFI_SUCCESS The data associated with the Handle was removed
446 from the HII database.
447 @retval EFI_INVALID_PARAMETER The Handle was not valid.
452 (EFIAPI
*EFI_HII_REMOVE_PACK
) (
453 IN EFI_HII_PROTOCOL
*This
,
454 IN EFI_HII_HANDLE Handle
458 Determines the handles that are currently active in the database.
460 @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.
464 @param Handle An array of EFI_HII_HANDLE instances returned.
466 @retval EFI_SUCCESS Handle was updated successfully.
467 @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates
468 that Handle is too small to support the number of handles.
473 (EFIAPI
*EFI_HII_FIND_HANDLES
) (
474 IN EFI_HII_PROTOCOL
*This
,
475 IN OUT UINT16
*HandleBufferLength
,
476 OUT EFI_HII_HANDLE
*Handle
480 Exports the contents of the database into a buffer.
482 @param This A pointer to the EFI_HII_PROTOCOL instance.
483 @param Handle An EFI_HII_HANDLE that corresponds to the desired
484 handle to export. If the value is 0, the entire database will be exported.
485 In either case, the data will be exported in a format described by the
486 structure definition of EFI_HII_EXPORT_TABLE.
488 On input, a pointer to the length of the buffer. On output, the length
489 of the buffer that is required for the export data.
490 @param Buffer A pointer to a buffer that will contain the results of the export function.
492 @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.
493 @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.
498 (EFIAPI
*EFI_HII_EXPORT
) (
499 IN EFI_HII_PROTOCOL
*This
,
500 IN EFI_HII_HANDLE Handle
,
501 IN OUT UINTN
*BufferSize
,
506 Remove any new strings that were added after the initial string export
509 @param This A pointer to the EFI_HII_PROTOCOL instance.
510 @param Handle The handle on which the string resides.
512 @retval EFI_SUCCESS Remove strings from the handle successfully.
513 @retval EFI_INVALID_PARAMETER The Handle was unknown.
518 (EFIAPI
*EFI_HII_RESET_STRINGS
) (
519 IN EFI_HII_PROTOCOL
*This
,
520 IN EFI_HII_HANDLE Handle
524 Tests if all of the characters in a string have corresponding font characters.
526 @param This A pointer to the EFI_HII_PROTOCOL instance.
527 @param StringToTest A pointer to a Unicode string.
528 @param FirstMissing A pointer to an index into the string. On input,
529 the index of the first character in the StringToTest to examine. On exit,
530 the index of the first character encountered for which a glyph is unavailable.
531 If all glyphs in the string are available, the index is the index of the
532 terminator of the string.
533 @param GlyphBufferSize A pointer to a value. On output, if the function
534 returns EFI_SUCCESS, it contains the amount of memory that is required to
535 store the string's glyph equivalent.
537 @retval EFI_SUCCESS All glyphs are available. Note that an empty string
538 always returns this value.
539 @retval EFI_NOT_FOUND A glyph was not found for a character.
544 (EFIAPI
*EFI_HII_TEST_STRING
) (
545 IN EFI_HII_PROTOCOL
*This
,
546 IN CHAR16
*StringToTest
,
547 IN OUT UINT32
*FirstMissing
,
548 OUT UINT32
*GlyphBufferSize
552 Translates a Unicode character into the corresponding font glyph.
554 @param This A pointer to the EFI_HII_PROTOCOL instance.
555 @param Source A pointer to a Unicode string.
556 @param Index On input, the offset into the string from which to fetch
557 the character.On successful completion, the index is updated to the first
558 character past the character(s) making up the just extracted glyph.
559 @param GlyphBuffer Pointer to an array where the glyphs corresponding
560 to the characters in the source may be stored. GlyphBuffer is assumed
561 to be wide enough to accept a wide glyph character.
562 @param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by
563 this value is filled with the length of the glyph in pixels. It is unchanged
564 if the call was unsuccessful.
565 @param InternalStatus The cell pointed to by this parameter must be
566 initialized to zero prior to invoking the call the first time for any string.
568 @retval EFI_SUCCESS It worked.
569 @retval EFI_NOT_FOUND A glyph for a character was not found.
574 (EFIAPI
*EFI_HII_GET_GLYPH
) (
575 IN EFI_HII_PROTOCOL
*This
,
577 IN OUT UINT16
*Index
,
578 OUT UINT8
**GlyphBuffer
,
579 OUT UINT16
*BitWidth
,
580 IN OUT UINT32
*InternalStatus
584 Translates a glyph into the format required for input to the Universal
585 Graphics Adapter (UGA) Block Transfer (BLT) routines.
587 @param This A pointer to the EFI_HII_PROTOCOL instance.
588 @param GlyphBuffer A pointer to the buffer that contains glyph data.
589 @param Foreground The foreground setting requested to be used for the
590 generated BltBuffer data.
591 @param Background The background setting requested to be used for the
592 generated BltBuffer data.
593 @param Count The entry in the BltBuffer upon which to act.
594 @param Width The width in bits of the glyph being converted.
595 @param Height The height in bits of the glyph being converted
596 @param BltBuffer A pointer to the buffer that contains the data that is
597 ready to be used by the UGA BLT routines.
599 @retval EFI_SUCCESS It worked.
600 @retval EFI_NOT_FOUND A glyph for a character was not found.
605 (EFIAPI
*EFI_HII_GLYPH_TO_BLT
) (
606 IN EFI_HII_PROTOCOL
*This
,
607 IN UINT8
*GlyphBuffer
,
608 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
,
609 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
,
613 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
617 Allows a new string to be added to an already existing string package.
619 @param This A pointer to the EFI_HII_PROTOCOL instance.
620 @param Pointer to a NULL-terminated string containing a single ISO 639-2
621 language identifier, indicating the language in which the string is translated.
622 @param Handle The handle of the language pack to which the string is to be added.
623 @param Reference The identifier of the string to be added. If the reference
624 value is zero, then the string will be assigned a new identifier on that
625 handle for the language specified. Otherwise, the string will be updated
626 with the NewString Value.
627 @param NewString The string to be added.
629 @retval EFI_SUCCESS The string was effectively registered.
630 @retval EFI_INVALID_PARAMETER The Handle was unknown.
635 (EFIAPI
*EFI_HII_NEW_STRING
) (
636 IN EFI_HII_PROTOCOL
*This
,
638 IN EFI_HII_HANDLE Handle
,
639 IN OUT STRING_REF
*Reference
,
644 Allows a program to determine the primary languages that are supported
647 @param This A pointer to the EFI_HII_PROTOCOL instance.
648 @param Handle The handle on which the strings reside.
649 @param LanguageString A string allocated by GetPrimaryLanguages() that
650 contains a list of all primary languages registered on the handle.
652 @retval EFI_SUCCESS LanguageString was correctly returned.
653 @retval EFI_INVALID_PARAMETER The Handle was unknown.
658 (EFIAPI
*EFI_HII_GET_PRI_LANGUAGES
) (
659 IN EFI_HII_PROTOCOL
*This
,
660 IN EFI_HII_HANDLE Handle
,
661 OUT EFI_STRING
*LanguageString
665 Allows a program to determine which secondary languages are supported
666 on a given handle for a given primary language.
668 @param This A pointer to the EFI_HII_PROTOCOL instance.
669 @param Handle The handle on which the strings reside.
670 @param PrimaryLanguage Pointer to a NULL-terminated string containing a single
671 ISO 639-2 language identifier, indicating the primary language.
672 @param LanguageString A string allocated by GetSecondaryLanguages()
673 containing a list of all secondary languages registered on the handle.
675 @retval EFI_SUCCESS LanguageString was correctly returned.
676 @retval EFI_INVALID_PARAMETER The Handle was unknown.
681 (EFIAPI
*EFI_HII_GET_SEC_LANGUAGES
) (
682 IN EFI_HII_PROTOCOL
*This
,
683 IN EFI_HII_HANDLE Handle
,
684 IN CHAR16
*PrimaryLanguage
,
685 OUT EFI_STRING
*LanguageString
689 Extracts a string from a package already registered with the EFI HII database.
691 @param This A pointer to the EFI_HII_PROTOCOL instance.
692 @param Handle The handle on which the string resides.
693 @param Token The string token assigned to the string.
694 @param Raw If TRUE, the string is returned unedited in the internal
695 storage format described above. If false, the string returned is edited
696 by replacing <cr> with <space> and by removing special characters such
697 as the <wide> prefix.
698 @param LanguageString Pointer to a NULL-terminated string containing a
699 single ISO 639-2 language identifier, indicating the language to print.
700 If the LanguageString is empty (starts with a NULL), the default system
701 language will be used to determine the language.
702 @param BufferLength Length of the StringBuffer.
703 @param StringBuffer The buffer designed to receive the characters in the string.
705 @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.
706 @retval EFI_INVALID_PARAMETER The handle or string token is unknown.
707 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to
708 allow the entire string to be stored.
713 (EFIAPI
*EFI_HII_GET_STRING
) (
714 IN EFI_HII_PROTOCOL
*This
,
715 IN EFI_HII_HANDLE Handle
,
718 IN CHAR16
*LanguageString
,
719 IN OUT UINTN
*BufferLength
,
720 OUT EFI_STRING StringBuffer
724 Allows a program to extract a part of a string of not more than a given width.
726 @param This A pointer to the EFI_HII_PROTOCOL instance.
727 @param Handle The handle on which the string resides.
728 @param Token The string token assigned to the string.
729 @param Index On input, the offset into the string where the line is to start.
730 On output, the index is updated to point to beyond the last character returned
732 @param LineWidth The maximum width of the line in units of narrow glyphs.
733 @param LanguageString Pointer to a NULL-terminated string containing a
734 single ISO 639-2 language identifier, indicating the language to print.
735 @param BufferLength Pointer to the length of the StringBuffer.
736 @param StringBuffer The buffer designed to receive the characters in the string.
738 @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.
739 @retval EFI_NOT_FOUND The font glyph for at least one of the characters in
740 the string is not in the font database.
741 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
742 to allow the entire string to be stored.
747 (EFIAPI
*EFI_HII_GET_LINE
) (
748 IN EFI_HII_PROTOCOL
*This
,
749 IN EFI_HII_HANDLE Handle
,
751 IN OUT UINT16
*Index
,
753 IN CHAR16
*LanguageString
,
754 IN OUT UINT16
*BufferLength
,
755 OUT EFI_STRING StringBuffer
759 Allows a program to extract a form or form package that has previously
760 been registered with the HII database.
762 @param This A pointer to the EFI_HII_PROTOCOL instance.
763 @param Handle Handle on which the form resides.
764 @param FormId The ID of the form to return. If the ID is zero,
765 the entire form package is returned.
766 @param BufferLength On input, the length of the Buffer. On output,
767 the length of the returned buffer,
768 @param Buffer The buffer designed to receive the form(s).
770 @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength
772 @retval EFI_INVALID_PARAMETER The handle is unknown.
773 @retval EFI_NOT_FOUND A form on the requested handle cannot be found with
774 the requested FormId.
775 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
776 to allow the form to be stored.
781 (EFIAPI
*EFI_HII_GET_FORMS
) (
782 IN EFI_HII_PROTOCOL
*This
,
783 IN EFI_HII_HANDLE Handle
,
784 IN EFI_FORM_ID FormId
,
785 IN OUT UINTN
*BufferLength
,
790 Extracts the defaults that are associated with a given handle in the HII database.
792 @param This A pointer to the EFI_HII_PROTOCOL instance.
793 @param Handle The HII handle from which will have default data retrieved.
794 @param DefaultMask The mask used to specify some type of default override when extracting
795 the default image data.
796 @param VariablePackList A indirect pointer to the first entry of a link list with
797 type EFI_HII_VARIABLE_PACK_LIST.
799 @retval EFI_SUCCESS The VariablePackList was populated with the appropriate
800 default setting data.
801 @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).
802 @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle
803 contain invalid data.
808 (EFIAPI
*EFI_HII_GET_DEFAULT_IMAGE
) (
809 IN EFI_HII_PROTOCOL
*This
,
810 IN EFI_HII_HANDLE Handle
,
811 IN UINTN DefaultMask
,
812 OUT EFI_HII_VARIABLE_PACK_LIST
**VariablePackList
816 Allows the caller to update a form or form package that has previously been
817 registered with the EFI HII database.
819 @param This A pointer to the EFI_HII_PROTOCOL instance.
820 @param Handle Handle of the package where the form to be updated resides.
821 @param Label The label inside the form package where the update is to take place.
822 @param AddData If TRUE, adding data at a given Label; otherwise,
823 if FALSE, removing data at a given Label.
824 @param Data The buffer containing the new tags to insert after the Label
826 @retval EFI_SUCCESS The form was updated with the new tags.
827 @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not
828 contain an integral number of tags.
829 @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found.
834 (EFIAPI
*EFI_HII_UPDATE_FORM
) (
835 IN EFI_HII_PROTOCOL
*This
,
836 IN EFI_HII_HANDLE Handle
,
837 IN EFI_FORM_LABEL Label
,
839 IN EFI_HII_UPDATE_DATA
*Data
843 Retrieves the current keyboard layout.
845 @param This A pointer to the EFI_HII_PROTOCOL instance.
846 @param DescriptorCount A pointer to the number of Descriptor entries being
847 described in the keyboard layout being retrieved.
848 @param Descriptor A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR
849 entries. Each entry will reflect the definition of a specific physical key.
851 @retval EFI_SUCCESS The keyboard layout was retrieved successfully.
856 (EFIAPI
*EFI_HII_GET_KEYBOARD_LAYOUT
) (
857 IN EFI_HII_PROTOCOL
*This
,
858 OUT UINT16
*DescriptorCount
,
859 OUT EFI_KEY_DESCRIPTOR
*Descriptor
863 @par Protocol Description:
864 The HII Protocol manages the HII database, which is a repository for data
865 having to do with fonts, strings, forms, keyboards, and other future human
869 Extracts the various packs from a package list.
872 Removes a package from the HII database.
875 Determines the handles that are currently active in the database.
877 @param ExportDatabase
878 Export the entire contents of the database to a buffer.
881 Tests if all of the characters in a string have corresponding font characters.
884 Translates a Unicode character into the corresponding font glyph.
887 Converts a glyph value into a format that is ready for a UGA BLT command.
890 Allows a new string to be added to an already existing string package.
892 @param GetPrimaryLanguages
893 Allows a program to determine the primary languages that are supported
896 @param GetSecondaryLanguages
897 Allows a program to determine which secondary languages are supported
898 on a given handle for a given primary language.
901 Extracts a string from a package that is already registered with the
905 Remove any new strings that were added after the initial string export
909 Allows a program to extract a part of a string of not more than a given width.
912 Allows a program to extract a form or form package that has been previously registered.
914 @param GetDefaultImage
915 Allows a program to extract the nonvolatile image that represents the default storage image.
918 Allows a program to update a previously registered form.
920 @param GetKeyboardLayout
921 Allows a program to extract the current keyboard layout.
924 struct _EFI_HII_PROTOCOL
{
925 EFI_HII_NEW_PACK NewPack
;
926 EFI_HII_REMOVE_PACK RemovePack
;
927 EFI_HII_FIND_HANDLES FindHandles
;
928 EFI_HII_EXPORT ExportDatabase
;
930 EFI_HII_TEST_STRING TestString
;
931 EFI_HII_GET_GLYPH GetGlyph
;
932 EFI_HII_GLYPH_TO_BLT GlyphToBlt
;
934 EFI_HII_NEW_STRING NewString
;
935 EFI_HII_GET_PRI_LANGUAGES GetPrimaryLanguages
;
936 EFI_HII_GET_SEC_LANGUAGES GetSecondaryLanguages
;
937 EFI_HII_GET_STRING GetString
;
938 EFI_HII_RESET_STRINGS ResetStrings
;
939 EFI_HII_GET_LINE GetLine
;
940 EFI_HII_GET_FORMS GetForms
;
941 EFI_HII_GET_DEFAULT_IMAGE GetDefaultImage
;
942 EFI_HII_UPDATE_FORM UpdateForm
;
944 EFI_HII_GET_KEYBOARD_LAYOUT GetKeyboardLayout
;
947 extern EFI_GUID gEfiHiiProtocolGuid
;