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} \
38 #define EFI_HII_COMPATIBILITY_PROTOCOL_GUID \
40 0x5542cce1, 0xdf5c, 0x4d1b, { 0xab, 0xca, 0x36, 0x4f, 0x77, 0xd3, 0x99, 0xfb } \
44 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
45 // If UGA goes away we need to put this some place. I'm not sure where?
54 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
57 typedef struct _EFI_HII_PROTOCOL EFI_HII_PROTOCOL
;
59 typedef UINT16 FRAMEWORK_EFI_HII_HANDLE
;
61 typedef UINT16 STRING_REF
;
63 typedef UINT32 RELOFST
;
68 #define NARROW_CHAR 0xFFF0
69 #define WIDE_CHAR 0xFFF1
70 #define NON_BREAKING_CHAR 0xFFF2
72 #define GLYPH_HEIGHT 19
74 #define EFI_HII_FONT 1
75 #define EFI_HII_STRING 2
77 #define EFI_HII_KEYBOARD 4
78 #define EFI_HII_HANDLES 5
79 #define EFI_HII_VARIABLE 6
80 #define EFI_HII_DEVICE_PATH 7
83 // References to string tokens must use this macro to enable scanning for
86 #define STRING_TOKEN(t) t
89 // The following types are currently defined:
90 // EFI_FROM_ID has been defined in UEFI spec.
92 typedef UINT16 EFI_FORM_LABEL
;
99 } EFI_HII_PACK_HEADER
;
102 // A form list consists of a large variety of structure
103 // possibilities so to represent the binary blob of data
104 // associated with a package of forms, we will assume a
105 // pointer to a self-describing data buffer.
108 EFI_HII_PACK_HEADER Header
;
112 EFI_HII_PACK_HEADER Header
; // Must be filled in
113 EFI_HANDLE ImageHandle
; // Must be filled in
114 EFI_HANDLE DeviceHandle
; // Optional
115 EFI_HANDLE ControllerHandle
; // Optional
116 EFI_HANDLE CallbackHandle
; // Optional
117 EFI_HANDLE COBExportHandle
; // Optional
118 } EFI_HII_HANDLE_PACK
;
121 // ********************************************************
122 // EFI_VARIABLE_CONTENTS
123 // ********************************************************
126 EFI_HII_PACK_HEADER Header
;
127 EFI_GUID VariableGuid
;
128 UINT32 VariableNameLength
;
131 // CHAR16 VariableName[]; //Null-terminated
133 } EFI_HII_VARIABLE_PACK
;
136 // ********************************************************
137 // EFI_DEVICE_PATH_PACK
138 // ********************************************************
141 EFI_HII_PACK_HEADER Header
;
143 // EFI_DEVICE_PATH DevicePath[];
145 } EFI_HII_DEVICE_PATH_PACK
;
148 // ********************************************************
149 // EFI_HII_DATA_TABLE
150 // ********************************************************
153 FRAMEWORK_EFI_HII_HANDLE HiiHandle
;
154 EFI_GUID PackageGuid
;
155 UINT32 DataTableSize
;
156 UINT32 IfrDataOffset
;
157 UINT32 StringDataOffset
;
158 UINT32 VariableDataOffset
;
159 UINT32 DevicePathOffset
;
160 UINT32 NumberOfVariableData
;
161 UINT32 NumberOfLanguages
;
163 // EFI_HII_DEVICE_PATH_PACK DevicePath[];
164 // EFI_HII_VARIABLE_PACK VariableData[];
165 // EFI_HII_IFR_PACK IfrData;
166 // EFI_HII_STRING_PACK StringData[];
168 } EFI_HII_DATA_TABLE
;
171 // ********************************************************
172 // EFI_HII_EXPORT_TABLE
173 // ********************************************************
176 UINT32 NumberOfHiiDataTables
;
179 // EFI_HII_DATA_TABLE HiiDataTable[];
181 } EFI_HII_EXPORT_TABLE
;
184 BOOLEAN FormSetUpdate
; // If TRUE, next variable is significant
185 EFI_PHYSICAL_ADDRESS FormCallbackHandle
; // If not 0, will update Formset with this info
186 BOOLEAN FormUpdate
; // If TRUE, next variable is significant
187 UINT16 FormValue
; // specify which form is to be updated if FormUpdate value is TRUE.
188 STRING_REF FormTitle
; // If not 0, will update Form with this info
189 UINT16 DataCount
; // The number of Data entries in this structure
190 UINT8
*Data
; // An array of 1+ op-codes, specified by DataCount
191 } FRAMEWORK_EFI_HII_UPDATE_DATA
;
196 #define LANG_RIGHT_TO_LEFT 0x00000001
199 // A string package is used to localize strings to a particular
200 // language. The package is associated with a particular driver
201 // or set of drivers. Tools are used to associate tokens with
202 // string references in forms and in programs. These tokens are
203 // language agnostic. When paired with a language pack (directly
204 // or indirectly), the string token resolves into an actual
205 // UNICODE string. The NumStringPointers determines how many
206 // StringPointers (offset values) there are as well as the total
207 // number of Strings that are defined.
210 EFI_HII_PACK_HEADER Header
;
211 RELOFST LanguageNameString
;
212 RELOFST PrintableLanguageName
;
213 UINT32 NumStringPointers
;
216 // RELOFST StringPointers[];
217 // EFI_STRING Strings[];
219 } EFI_HII_STRING_PACK
;
223 // A font list consists of a font header followed by a series
224 // of glyph structures. Note that fonts are not language specific.
227 EFI_HII_PACK_HEADER Header
;
228 UINT16 NumberOfNarrowGlyphs
;
229 UINT16 NumberOfWideGlyphs
;
233 // The IfrData in the EFI_HII_IFR_PACK structure definition
234 // is variable length, and not really part of the header. To
235 // simplify from code the size of the header, define an
236 // identical structure that does not include the IfrData field.
237 // Then use sizeof() this new structure to determine the
238 // actual size of the header.
241 EFI_HII_PACK_HEADER Header
;
242 } EFI_HII_IFR_PACK_HEADER
;
247 CHAR16 ShiftedUnicode
;
249 CHAR16 ShiftedAltGrUnicode
;
251 } FRAMEWORK_EFI_KEY_DESCRIPTOR
;
254 // This structure allows a sparse set of keys to be redefined
255 // or a complete redefinition of the keyboard layout. Most
256 // keyboards have a lot of commonality in their layouts, therefore
257 // only defining those keys that need to change from the default
258 // minimizes the passed in information.
260 // Additionally, when an update occurs, the active keyboard layout
261 // will be switched to the newly updated keyboard layout. This
262 // allows for situations that when a keyboard layout driver is
263 // loaded as part of system initialization, the system will default
264 // the keyboard behavior to the new layout.
266 // Each call to update the keyboard mapping should contain the
267 // complete set of key descriptors to be updated, since every
268 // call to the HII which contains an EFI_HII_KEYBOARD_PACK will
269 // wipe the previous set of overrides. A call to
272 EFI_HII_PACK_HEADER Header
;
273 FRAMEWORK_EFI_KEY_DESCRIPTOR
*Descriptor
;
274 UINT8 DescriptorCount
;
275 } EFI_HII_KEYBOARD_PACK
;
278 // The EFI_HII_PACKAGES can contain different types of packages just
279 // after the structure as inline data.
282 UINTN NumberOfPackages
;
285 // EFI_HII_HANDLE_PACK *HandlePack; // Only one pack.
286 // EFI_HII_IFR_PACK *IfrPack; // Only one pack.
287 // EFI_HII_FONT_PACK *FontPack[]; // Multiple packs ok
288 // EFI_HII_STRING_PACK *StringPack[]; // Multiple packs ok
289 // EFI_HII_KEYBOARD_PACK *KeyboardPack[]; // Multiple packs ok
293 typedef struct _EFI_HII_VARIABLE_PACK_LIST
{
294 struct _EFI_HII_VARIABLE_PACK_LIST
*NextVariablePack
;
295 EFI_HII_VARIABLE_PACK
*VariablePack
;
296 } EFI_HII_VARIABLE_PACK_LIST
;
302 Registers the various packs that are passed in via the Packages parameter.
304 @param This A pointer to the EFI_HII_PROTOCOL instance.
305 @param Packages A pointer to an EFI_HII_PACKAGES package instance.
306 @param Handle A pointer to the FRAMEWORK_EFI_HII_HANDLE instance.
308 @retval EFI_SUCCESS Data was extracted from Packages, the database
309 was updated with the data, and Handle returned successfully.
310 @retval EFI_INVALID_PARAMETER The content of Packages was invalid.
315 (EFIAPI
*FRAMEWORK_EFI_HII_NEW_PACK
)(
316 IN EFI_HII_PROTOCOL
*This
,
317 IN EFI_HII_PACKAGES
*Packages
,
318 OUT FRAMEWORK_EFI_HII_HANDLE
*Handle
322 Removes a package from the HII database.
324 @param This A pointer to the EFI_HII_PROTOCOL instance.
325 @param Handle The handle that was registered to the data that is requested
328 @retval EFI_SUCCESS The data associated with the Handle was removed
329 from the HII database.
330 @retval EFI_INVALID_PARAMETER The Handle was not valid.
335 (EFIAPI
*FRAMEWORK_EFI_HII_REMOVE_PACK
)(
336 IN EFI_HII_PROTOCOL
*This
,
337 IN FRAMEWORK_EFI_HII_HANDLE Handle
341 Determines the handles that are currently active in the database.
343 @param This A pointer to the EFI_HII_PROTOCOL instance.
344 @param HandleBufferLength On input, a pointer to the length of the handle
345 buffer. On output, the length of the handle buffer that is required
346 for the handles found.
347 @param Handle An array of FRAMEWORK_EFI_HII_HANDLE instances returned.
349 @retval EFI_SUCCESS Handle was updated successfully.
350 @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates
351 that Handle is too small to support the number of handles.
356 (EFIAPI
*FRAMEWORK_EFI_HII_FIND_HANDLES
)(
357 IN EFI_HII_PROTOCOL
*This
,
358 IN OUT UINT16
*HandleBufferLength
,
359 OUT FRAMEWORK_EFI_HII_HANDLE
*Handle
363 Exports the contents of the database into a buffer.
365 @param This A pointer to the EFI_HII_PROTOCOL instance.
366 @param Handle An FRAMEWORK_EFI_HII_HANDLE that corresponds to the desired
367 handle to export. If the value is 0, the entire database will be exported.
368 In either case, the data will be exported in a format described by the
369 structure definition of EFI_HII_EXPORT_TABLE.
371 On input, a pointer to the length of the buffer. On output, the length
372 of the buffer that is required for the export data.
373 @param Buffer A pointer to a buffer that will contain the results of the export function.
375 @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.
376 @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.
381 (EFIAPI
*FRAMEWORK_EFI_HII_EXPORT
)(
382 IN EFI_HII_PROTOCOL
*This
,
383 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
384 IN OUT UINTN
*BufferSize
,
389 Remove any new strings that were added after the initial string export
392 @param This A pointer to the EFI_HII_PROTOCOL instance.
393 @param Handle The handle on which the string resides.
395 @retval EFI_SUCCESS Remove strings from the handle successfully.
396 @retval EFI_INVALID_PARAMETER The Handle was unknown.
401 (EFIAPI
*FRAMEWORK_EFI_HII_RESET_STRINGS
)(
402 IN EFI_HII_PROTOCOL
*This
,
403 IN FRAMEWORK_EFI_HII_HANDLE Handle
407 Tests if all of the characters in a string have corresponding font characters.
409 @param This A pointer to the EFI_HII_PROTOCOL instance.
410 @param StringToTest A pointer to a Unicode string.
411 @param FirstMissing A pointer to an index into the string. On input,
412 the index of the first character in the StringToTest to examine. On exit,
413 the index of the first character encountered for which a glyph is unavailable.
414 If all glyphs in the string are available, the index is the index of the
415 terminator of the string.
416 @param GlyphBufferSize A pointer to a value. On output, if the function
417 returns EFI_SUCCESS, it contains the amount of memory that is required to
418 store the string's glyph equivalent.
420 @retval EFI_SUCCESS All glyphs are available. Note that an empty string
421 always returns this value.
422 @retval EFI_NOT_FOUND A glyph was not found for a character.
427 (EFIAPI
*FRAMEWORK_EFI_HII_TEST_STRING
) (
428 IN EFI_HII_PROTOCOL
*This
,
429 IN CHAR16
*StringToTest
,
430 IN OUT UINT32
*FirstMissing
,
431 OUT UINT32
*GlyphBufferSize
435 Translates a Unicode character into the corresponding font glyph.
437 @param This A pointer to the EFI_HII_PROTOCOL instance.
438 @param Source A pointer to a Unicode string.
439 @param Index On input, the offset into the string from which to fetch
440 the character.On successful completion, the index is updated to the first
441 character past the character(s) making up the just extracted glyph.
442 @param GlyphBuffer Pointer to an array where the glyphs corresponding
443 to the characters in the source may be stored. GlyphBuffer is assumed
444 to be wide enough to accept a wide glyph character.
445 @param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by
446 this value is filled with the length of the glyph in pixels. It is unchanged
447 if the call was unsuccessful.
448 @param InternalStatus The cell pointed to by this parameter must be
449 initialized to zero prior to invoking the call the first time for any string.
451 @retval EFI_SUCCESS It worked.
452 @retval EFI_NOT_FOUND A glyph for a character was not found.
457 (EFIAPI
*FRAMEWORK_EFI_HII_GET_GLYPH
)(
458 IN EFI_HII_PROTOCOL
*This
,
460 IN OUT UINT16
*Index
,
461 OUT UINT8
**GlyphBuffer
,
462 OUT UINT16
*BitWidth
,
463 IN OUT UINT32
*InternalStatus
467 Translates a glyph into the format required for input to the Universal
468 Graphics Adapter (UGA) Block Transfer (BLT) routines.
470 @param This A pointer to the EFI_HII_PROTOCOL instance.
471 @param GlyphBuffer A pointer to the buffer that contains glyph data.
472 @param Foreground The foreground setting requested to be used for the
473 generated BltBuffer data.
474 @param Background The background setting requested to be used for the
475 generated BltBuffer data.
476 @param Count The entry in the BltBuffer upon which to act.
477 @param Width The width in bits of the glyph being converted.
478 @param Height The height in bits of the glyph being converted
479 @param BltBuffer A pointer to the buffer that contains the data that is
480 ready to be used by the UGA BLT routines.
482 @retval EFI_SUCCESS It worked.
483 @retval EFI_NOT_FOUND A glyph for a character was not found.
488 (EFIAPI
*FRAMEWORK_EFI_HII_GLYPH_TO_BLT
)(
489 IN EFI_HII_PROTOCOL
*This
,
490 IN UINT8
*GlyphBuffer
,
491 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
,
492 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
,
496 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
500 Allows a new string to be added to an already existing string package.
502 @param This A pointer to the EFI_HII_PROTOCOL instance.
503 @param Pointer to a NULL-terminated string containing a single ISO 639-2
504 language identifier, indicating the language in which the string is translated.
505 @param Handle The handle of the language pack to which the string is to be added.
506 @param Reference The identifier of the string to be added. If the reference
507 value is zero, then the string will be assigned a new identifier on that
508 handle for the language specified. Otherwise, the string will be updated
509 with the NewString Value.
510 @param NewString The string to be added.
512 @retval EFI_SUCCESS The string was effectively registered.
513 @retval EFI_INVALID_PARAMETER The Handle was unknown.
518 (EFIAPI
*FRAMEWORK_EFI_HII_NEW_STRING
)(
519 IN EFI_HII_PROTOCOL
*This
,
521 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
522 IN OUT STRING_REF
*Reference
,
527 Allows a program to determine the primary languages that are supported
530 @param This A pointer to the EFI_HII_PROTOCOL instance.
531 @param Handle The handle on which the strings reside.
532 @param LanguageString A string allocated by GetPrimaryLanguages() that
533 contains a list of all primary languages registered on the handle.
535 @retval EFI_SUCCESS LanguageString was correctly returned.
536 @retval EFI_INVALID_PARAMETER The Handle was unknown.
541 (EFIAPI
*FRAMEWORK_EFI_HII_GET_PRI_LANGUAGES
)(
542 IN EFI_HII_PROTOCOL
*This
,
543 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
544 OUT EFI_STRING
*LanguageString
548 Allows a program to determine which secondary languages are supported
549 on a given handle for a given primary language.
551 @param This A pointer to the EFI_HII_PROTOCOL instance.
552 @param Handle The handle on which the strings reside.
553 @param PrimaryLanguage Pointer to a NULL-terminated string containing a single
554 ISO 639-2 language identifier, indicating the primary language.
555 @param LanguageString A string allocated by GetSecondaryLanguages()
556 containing a list of all secondary languages registered on the handle.
558 @retval EFI_SUCCESS LanguageString was correctly returned.
559 @retval EFI_INVALID_PARAMETER The Handle was unknown.
564 (EFIAPI
*FRAMEWORK_EFI_HII_GET_SEC_LANGUAGES
)(
565 IN EFI_HII_PROTOCOL
*This
,
566 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
567 IN CHAR16
*PrimaryLanguage
,
568 OUT EFI_STRING
*LanguageString
572 Extracts a string from a package already registered with the EFI HII database.
574 @param This A pointer to the EFI_HII_PROTOCOL instance.
575 @param Handle The handle on which the string resides.
576 @param Token The string token assigned to the string.
577 @param Raw If TRUE, the string is returned unedited in the internal
578 storage format described above. If false, the string returned is edited
579 by replacing <cr> with <space> and by removing special characters such
580 as the <wide> prefix.
581 @param LanguageString Pointer to a NULL-terminated string containing a
582 single ISO 639-2 language identifier, indicating the language to print.
583 If the LanguageString is empty (starts with a NULL), the default system
584 language will be used to determine the language.
585 @param BufferLength Length of the StringBuffer.
586 @param StringBuffer The buffer designed to receive the characters in the string.
588 @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.
589 @retval EFI_INVALID_PARAMETER The handle or string token is unknown.
590 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to
591 allow the entire string to be stored.
596 (EFIAPI
*FRAMEWORK_EFI_HII_GET_STRING
)(
597 IN EFI_HII_PROTOCOL
*This
,
598 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
601 IN CHAR16
*LanguageString
,
602 IN OUT UINTN
*BufferLength
,
603 OUT EFI_STRING StringBuffer
607 Allows a program to extract a part of a string of not more than a given width.
609 @param This A pointer to the EFI_HII_PROTOCOL instance.
610 @param Handle The handle on which the string resides.
611 @param Token The string token assigned to the string.
612 @param Index On input, the offset into the string where the line is to start.
613 On output, the index is updated to point to beyond the last character returned
615 @param LineWidth The maximum width of the line in units of narrow glyphs.
616 @param LanguageString Pointer to a NULL-terminated string containing a
617 single ISO 639-2 language identifier, indicating the language to print.
618 @param BufferLength Pointer to the length of the StringBuffer.
619 @param StringBuffer The buffer designed to receive the characters in the string.
621 @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.
622 @retval EFI_NOT_FOUND The font glyph for at least one of the characters in
623 the string is not in the font database.
624 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
625 to allow the entire string to be stored.
630 (EFIAPI
*FRAMEWORK_EFI_HII_GET_LINE
)(
631 IN EFI_HII_PROTOCOL
*This
,
632 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
634 IN OUT UINT16
*Index
,
636 IN CHAR16
*LanguageString
,
637 IN OUT UINT16
*BufferLength
,
638 OUT EFI_STRING StringBuffer
642 Allows a program to extract a form or form package that has previously
643 been registered with the HII database.
645 @param This A pointer to the EFI_HII_PROTOCOL instance.
646 @param Handle Handle on which the form resides.
647 @param FormId The ID of the form to return. If the ID is zero,
648 the entire form package is returned.
649 @param BufferLength On input, the length of the Buffer. On output,
650 the length of the returned buffer,
651 @param Buffer The buffer designed to receive the form(s).
653 @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength
655 @retval EFI_INVALID_PARAMETER The handle is unknown.
656 @retval EFI_NOT_FOUND A form on the requested handle cannot be found with
657 the requested FormId.
658 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
659 to allow the form to be stored.
664 (EFIAPI
*FRAMEWORK_EFI_HII_GET_FORMS
)(
665 IN EFI_HII_PROTOCOL
*This
,
666 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
667 IN EFI_FORM_ID FormId
,
668 IN OUT UINTN
*BufferLength
,
673 Extracts the defaults that are associated with a given handle in the HII database.
675 @param This A pointer to the EFI_HII_PROTOCOL instance.
676 @param Handle The HII handle from which will have default data retrieved.
677 @param DefaultMask The mask used to specify some type of default override when extracting
678 the default image data.
679 @param VariablePackList A indirect pointer to the first entry of a link list with
680 type EFI_HII_VARIABLE_PACK_LIST.
682 @retval EFI_SUCCESS The VariablePackList was populated with the appropriate
683 default setting data.
684 @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).
685 @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle
686 contain invalid data.
691 (EFIAPI
*FRAMEWORK_EFI_HII_GET_DEFAULT_IMAGE
)(
692 IN EFI_HII_PROTOCOL
*This
,
693 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
694 IN UINTN DefaultMask
,
695 OUT EFI_HII_VARIABLE_PACK_LIST
**VariablePackList
699 Allows the caller to update a form or form package that has previously been
700 registered with the EFI HII database.
702 @param This A pointer to the EFI_HII_PROTOCOL instance.
703 @param Handle Handle of the package where the form to be updated resides.
704 @param Label The label inside the form package where the update is to take place.
705 @param AddData If TRUE, adding data at a given Label; otherwise,
706 if FALSE, removing data at a given Label.
707 @param Data The buffer containing the new tags to insert after the Label
709 @retval EFI_SUCCESS The form was updated with the new tags.
710 @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not
711 contain an integral number of tags.
712 @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found.
717 (EFIAPI
*FRAMEWORK_EFI_HII_UPDATE_FORM
)(
718 IN EFI_HII_PROTOCOL
*This
,
719 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
720 IN EFI_FORM_LABEL Label
,
722 IN FRAMEWORK_EFI_HII_UPDATE_DATA
*Data
726 Retrieves the current keyboard layout.
728 @param This A pointer to the EFI_HII_PROTOCOL instance.
729 @param DescriptorCount A pointer to the number of Descriptor entries being
730 described in the keyboard layout being retrieved.
731 @param Descriptor A pointer to a buffer containing an array of FRAMEWORK_EFI_KEY_DESCRIPTOR
732 entries. Each entry will reflect the definition of a specific physical key.
734 @retval EFI_SUCCESS The keyboard layout was retrieved successfully.
739 (EFIAPI
*FRAMEWORK_EFI_HII_GET_KEYBOARD_LAYOUT
)(
740 IN EFI_HII_PROTOCOL
*This
,
741 OUT UINT16
*DescriptorCount
,
742 OUT FRAMEWORK_EFI_KEY_DESCRIPTOR
*Descriptor
746 @par Protocol Description:
747 The HII Protocol manages the HII database, which is a repository for data
748 having to do with fonts, strings, forms, keyboards, and other future human
752 Extracts the various packs from a package list.
755 Removes a package from the HII database.
758 Determines the handles that are currently active in the database.
760 @param ExportDatabase
761 Export the entire contents of the database to a buffer.
764 Tests if all of the characters in a string have corresponding font characters.
767 Translates a Unicode character into the corresponding font glyph.
770 Converts a glyph value into a format that is ready for a UGA BLT command.
773 Allows a new string to be added to an already existing string package.
775 @param GetPrimaryLanguages
776 Allows a program to determine the primary languages that are supported
779 @param GetSecondaryLanguages
780 Allows a program to determine which secondary languages are supported
781 on a given handle for a given primary language.
784 Extracts a string from a package that is already registered with the
788 Remove any new strings that were added after the initial string export
792 Allows a program to extract a part of a string of not more than a given width.
795 Allows a program to extract a form or form package that has been previously registered.
797 @param GetDefaultImage
798 Allows a program to extract the nonvolatile image that represents the default storage image.
801 Allows a program to update a previously registered form.
803 @param GetKeyboardLayout
804 Allows a program to extract the current keyboard layout.
807 struct _EFI_HII_PROTOCOL
{
808 FRAMEWORK_EFI_HII_NEW_PACK NewPack
;
809 FRAMEWORK_EFI_HII_REMOVE_PACK RemovePack
;
810 FRAMEWORK_EFI_HII_FIND_HANDLES FindHandles
;
811 FRAMEWORK_EFI_HII_EXPORT ExportDatabase
;
813 FRAMEWORK_EFI_HII_TEST_STRING TestString
;
814 FRAMEWORK_EFI_HII_GET_GLYPH GetGlyph
;
815 FRAMEWORK_EFI_HII_GLYPH_TO_BLT GlyphToBlt
;
817 FRAMEWORK_EFI_HII_NEW_STRING NewString
;
818 FRAMEWORK_EFI_HII_GET_PRI_LANGUAGES GetPrimaryLanguages
;
819 FRAMEWORK_EFI_HII_GET_SEC_LANGUAGES GetSecondaryLanguages
;
820 FRAMEWORK_EFI_HII_GET_STRING GetString
;
821 FRAMEWORK_EFI_HII_RESET_STRINGS ResetStrings
;
822 FRAMEWORK_EFI_HII_GET_LINE GetLine
;
823 FRAMEWORK_EFI_HII_GET_FORMS GetForms
;
824 FRAMEWORK_EFI_HII_GET_DEFAULT_IMAGE GetDefaultImage
;
825 FRAMEWORK_EFI_HII_UPDATE_FORM UpdateForm
;
827 FRAMEWORK_EFI_HII_GET_KEYBOARD_LAYOUT GetKeyboardLayout
;
830 extern EFI_GUID gEfiHiiProtocolGuid
;
831 extern EFI_GUID gEfiHiiCompatibilityProtocolGuid
;