2 Private structures definitions in HiiDatabase.
4 Copyright (c) 2007 - 2009, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef __HII_DATABASE_PRIVATE_H__
16 #define __HII_DATABASE_PRIVATE_H__
20 #include <Protocol/DevicePath.h>
21 #include <Protocol/HiiFont.h>
22 #include <Protocol/HiiImage.h>
23 #include <Protocol/HiiString.h>
24 #include <Protocol/HiiDatabase.h>
25 #include <Protocol/HiiConfigRouting.h>
26 #include <Protocol/HiiConfigAccess.h>
27 #include <Protocol/SimpleTextOut.h>
29 #include <Guid/HiiKeyBoardLayout.h>
30 #include <Guid/GlobalVariable.h>
33 #include <Library/DebugLib.h>
34 #include <Library/BaseMemoryLib.h>
35 #include <Library/UefiDriverEntryPoint.h>
36 #include <Library/UefiBootServicesTableLib.h>
37 #include <Library/BaseLib.h>
38 #include <Library/DevicePathLib.h>
39 #include <Library/MemoryAllocationLib.h>
40 #include <Library/UefiLib.h>
41 #include <Library/PcdLib.h>
42 #include <Library/UefiRuntimeServicesTableLib.h>
43 #include <Library/PrintLib.h>
46 #define HII_DATABASE_NOTIFY_GUID \
48 0xc1c76, 0xd79e, 0x42fe, {0x86, 0xb, 0x8b, 0xe8, 0x7b, 0x3e, 0x7a, 0x78} \
51 #define MAX_STRING_LENGTH 1024
52 #define MAX_FONT_NAME_LEN 256
53 #define NARROW_BASELINE 15
54 #define WIDE_BASELINE 14
55 #define SYS_FONT_INFO_MASK 0x37
56 #define REPLACE_UNKNOWN_GLYPH 0xFFFD
57 #define PROPORTIONAL_GLYPH 0x80
58 #define NARROW_GLYPH 0x40
60 #define BITMAP_LEN_1_BIT(Width, Height) (((Width) + 7) / 8 * (Height))
61 #define BITMAP_LEN_4_BIT(Width, Height) (((Width) + 1) / 2 * (Height))
62 #define BITMAP_LEN_8_BIT(Width, Height) ((Width) * (Height))
63 #define BITMAP_LEN_24_BIT(Width, Height) ((Width) * (Height) * 3)
68 // BASE_CR (a, IFR_DEFAULT_VALUE_DATA, Entry) to get the whole structure.
71 LIST_ENTRY Entry
; // Link to VarStorage
74 EFI_VARSTORE_ID VarStoreId
;
76 LIST_ENTRY BlockEntry
; // Link to its Block array
77 } IFR_VARSTORAGE_DATA
;
80 LIST_ENTRY Entry
; // Link to Block array
83 EFI_QUESTION_ID QuestionId
;
86 LIST_ENTRY DefaultValueEntry
; // Link to its default value array
91 EFI_STRING_ID DefaultName
;
99 #define EFI_HII_VARSTORE_BUFFER 0
100 #define EFI_HII_VARSTORE_NAME_VALUE 1
101 #define EFI_HII_VARSTORE_EFI_VARIABLE 2
103 #define HII_FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('H', 'S', 'T', 'G')
108 EFI_HII_HANDLE HiiHandle
;
109 EFI_HANDLE DriverHandle
;
111 UINT8 Type
; // EFI_HII_VARSTORE_BUFFER, EFI_HII_VARSTORE_NAME_VALUE, EFI_HII_VARSTORE_EFI_VARIABLE
115 } HII_FORMSET_STORAGE
;
119 // String Package definitions
121 #define HII_STRING_PACKAGE_SIGNATURE SIGNATURE_32 ('h','i','s','p')
122 typedef struct _HII_STRING_PACKAGE_INSTANCE
{
124 EFI_HII_STRING_PACKAGE_HDR
*StringPkgHdr
;
126 LIST_ENTRY StringEntry
;
127 LIST_ENTRY FontInfoList
; // local font info list
129 } HII_STRING_PACKAGE_INSTANCE
;
132 // Form Package definitions
134 #define HII_IFR_PACKAGE_SIGNATURE SIGNATURE_32 ('h','f','r','p')
135 typedef struct _HII_IFR_PACKAGE_INSTANCE
{
137 EFI_HII_PACKAGE_HEADER FormPkgHdr
;
140 } HII_IFR_PACKAGE_INSTANCE
;
143 // Simple Font Package definitions
145 #define HII_S_FONT_PACKAGE_SIGNATURE SIGNATURE_32 ('h','s','f','p')
146 typedef struct _HII_SIMPLE_FONT_PACKAGE_INSTANCE
{
148 EFI_HII_SIMPLE_FONT_PACKAGE_HDR
*SimpleFontPkgHdr
;
149 LIST_ENTRY SimpleFontEntry
;
150 } HII_SIMPLE_FONT_PACKAGE_INSTANCE
;
153 // Font Package definitions
155 #define HII_FONT_PACKAGE_SIGNATURE SIGNATURE_32 ('h','i','f','p')
156 typedef struct _HII_FONT_PACKAGE_INSTANCE
{
158 EFI_HII_FONT_PACKAGE_HDR
*FontPkgHdr
;
160 LIST_ENTRY FontEntry
;
161 LIST_ENTRY GlyphInfoList
;
162 } HII_FONT_PACKAGE_INSTANCE
;
164 #define HII_GLYPH_INFO_SIGNATURE SIGNATURE_32 ('h','g','i','s')
165 typedef struct _HII_GLYPH_INFO
{
169 EFI_HII_GLYPH_INFO Cell
;
172 #define HII_FONT_INFO_SIGNATURE SIGNATURE_32 ('h','l','f','i')
173 typedef struct _HII_FONT_INFO
{
176 LIST_ENTRY
*GlobalEntry
;
180 #define HII_GLOBAL_FONT_INFO_SIGNATURE SIGNATURE_32 ('h','g','f','i')
181 typedef struct _HII_GLOBAL_FONT_INFO
{
184 HII_FONT_PACKAGE_INSTANCE
*FontPackage
;
186 EFI_FONT_INFO
*FontInfo
;
187 } HII_GLOBAL_FONT_INFO
;
190 // Image Package definitions
193 #define HII_PIXEL_MASK 0x80
195 typedef struct _HII_IMAGE_PACKAGE_INSTANCE
{
196 EFI_HII_IMAGE_PACKAGE_HDR ImagePkgHdr
;
197 UINT32 ImageBlockSize
;
198 UINT32 PaletteInfoSize
;
201 } HII_IMAGE_PACKAGE_INSTANCE
;
204 // Keyboard Layout Pacakge definitions
206 #define HII_KB_LAYOUT_PACKAGE_SIGNATURE SIGNATURE_32 ('h','k','l','p')
207 typedef struct _HII_KEYBOARD_LAYOUT_PACKAGE_INSTANCE
{
210 LIST_ENTRY KeyboardEntry
;
211 } HII_KEYBOARD_LAYOUT_PACKAGE_INSTANCE
;
214 // Guid Package definitions
216 #define HII_GUID_PACKAGE_SIGNATURE SIGNATURE_32 ('h','i','g','p')
217 typedef struct _HII_GUID_PACKAGE_INSTANCE
{
220 LIST_ENTRY GuidEntry
;
221 } HII_GUID_PACKAGE_INSTANCE
;
224 // A package list can contain only one or less than one device path package.
225 // This rule also applies to image package since ImageId can not be duplicate.
227 typedef struct _HII_DATABASE_PACKAGE_LIST_INSTANCE
{
228 EFI_HII_PACKAGE_LIST_HEADER PackageListHdr
;
229 LIST_ENTRY GuidPkgHdr
;
230 LIST_ENTRY FormPkgHdr
;
231 LIST_ENTRY KeyboardLayoutHdr
;
232 LIST_ENTRY StringPkgHdr
;
233 LIST_ENTRY FontPkgHdr
;
234 HII_IMAGE_PACKAGE_INSTANCE
*ImagePkg
;
235 LIST_ENTRY SimpleFontPkgHdr
;
236 UINT8
*DevicePathPkg
;
237 } HII_DATABASE_PACKAGE_LIST_INSTANCE
;
239 #define HII_HANDLE_SIGNATURE SIGNATURE_32 ('h','i','h','l')
247 #define HII_DATABASE_RECORD_SIGNATURE SIGNATURE_32 ('h','i','d','r')
249 typedef struct _HII_DATABASE_RECORD
{
251 HII_DATABASE_PACKAGE_LIST_INSTANCE
*PackageList
;
252 EFI_HANDLE DriverHandle
;
253 EFI_HII_HANDLE Handle
;
254 LIST_ENTRY DatabaseEntry
;
255 } HII_DATABASE_RECORD
;
257 #define HII_DATABASE_NOTIFY_SIGNATURE SIGNATURE_32 ('h','i','d','n')
259 typedef struct _HII_DATABASE_NOTIFY
{
261 EFI_HANDLE NotifyHandle
;
263 EFI_GUID
*PackageGuid
;
264 EFI_HII_DATABASE_NOTIFY PackageNotifyFn
;
265 EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
;
266 LIST_ENTRY DatabaseNotifyEntry
;
267 } HII_DATABASE_NOTIFY
;
269 #define HII_DATABASE_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('H', 'i', 'D', 'p')
271 typedef struct _HII_DATABASE_PRIVATE_DATA
{
273 LIST_ENTRY DatabaseList
;
274 LIST_ENTRY DatabaseNotifyList
;
275 EFI_HII_FONT_PROTOCOL HiiFont
;
276 EFI_HII_IMAGE_PROTOCOL HiiImage
;
277 EFI_HII_STRING_PROTOCOL HiiString
;
278 EFI_HII_DATABASE_PROTOCOL HiiDatabase
;
279 EFI_HII_CONFIG_ROUTING_PROTOCOL ConfigRouting
;
280 LIST_ENTRY HiiHandleList
;
282 LIST_ENTRY FontInfoList
; // global font info list
283 UINTN Attribute
; // default system color
284 EFI_GUID CurrentLayoutGuid
;
285 EFI_HII_KEYBOARD_LAYOUT
*CurrentLayout
;
286 } HII_DATABASE_PRIVATE_DATA
;
288 #define HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS(a) \
290 HII_DATABASE_PRIVATE_DATA, \
292 HII_DATABASE_PRIVATE_DATA_SIGNATURE \
295 #define HII_IMAGE_DATABASE_PRIVATE_DATA_FROM_THIS(a) \
297 HII_DATABASE_PRIVATE_DATA, \
299 HII_DATABASE_PRIVATE_DATA_SIGNATURE \
302 #define HII_STRING_DATABASE_PRIVATE_DATA_FROM_THIS(a) \
304 HII_DATABASE_PRIVATE_DATA, \
306 HII_DATABASE_PRIVATE_DATA_SIGNATURE \
309 #define HII_DATABASE_DATABASE_PRIVATE_DATA_FROM_THIS(a) \
311 HII_DATABASE_PRIVATE_DATA, \
313 HII_DATABASE_PRIVATE_DATA_SIGNATURE \
316 #define CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS(a) \
318 HII_DATABASE_PRIVATE_DATA, \
320 HII_DATABASE_PRIVATE_DATA_SIGNATURE \
324 // Internal function prototypes.
328 This function checks whether a handle is a valid EFI_HII_HANDLE.
330 @param Handle Pointer to a EFI_HII_HANDLE
333 @retval FALSE Invalid
338 EFI_HII_HANDLE Handle
343 This function checks whether EFI_FONT_INFO exists in current database. If
344 FontInfoMask is specified, check what options can be used to make a match.
345 Note that the masks relate to where the system default should be supplied
346 are ignored by this function.
348 @param Private Hii database private structure.
349 @param FontInfo Points to EFI_FONT_INFO structure.
350 @param FontInfoMask If not NULL, describes what options can be used
351 to make a match between the font requested and
352 the font available. The caller must guarantee
354 @param FontHandle On entry, Points to the font handle returned by a
355 previous call to GetFontInfo() or NULL to start
357 @param GlobalFontInfo If not NULL, output the corresponding globa font
361 @retval FALSE Not existed
366 IN HII_DATABASE_PRIVATE_DATA
*Private
,
367 IN EFI_FONT_INFO
*FontInfo
,
368 IN EFI_FONT_INFO_MASK
*FontInfoMask
, OPTIONAL
369 IN EFI_FONT_HANDLE FontHandle
, OPTIONAL
370 OUT HII_GLOBAL_FONT_INFO
**GlobalFontInfo OPTIONAL
375 This function invokes the matching registered function.
377 @param Private HII Database driver private structure.
378 @param NotifyType The type of change concerning the database.
379 @param PackageInstance Points to the package referred to by the notification.
380 @param PackageType Package type
381 @param Handle The handle of the package list which contains the specified package.
383 @retval EFI_SUCCESS Already checked all registered function and invoked
385 @retval EFI_INVALID_PARAMETER Any input parameter is not valid.
389 InvokeRegisteredFunction (
390 IN HII_DATABASE_PRIVATE_DATA
*Private
,
391 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
,
392 IN VOID
*PackageInstance
,
393 IN UINT8 PackageType
,
394 IN EFI_HII_HANDLE Handle
399 Retrieve system default font and color.
401 @param Private HII database driver private data.
402 @param FontInfo Points to system default font output-related
403 information. It's caller's responsibility to free
405 @param FontInfoSize If not NULL, output the size of buffer FontInfo.
407 @retval EFI_SUCCESS Cell information is added to the GlyphInfoList.
408 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
410 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
415 IN HII_DATABASE_PRIVATE_DATA
*Private
,
416 OUT EFI_FONT_DISPLAY_INFO
**FontInfo
,
417 OUT UINTN
*FontInfoSize OPTIONAL
422 Parse all string blocks to find a String block specified by StringId.
423 If StringId = (EFI_STRING_ID) (-1), find out all EFI_HII_SIBT_FONT blocks
424 within this string package and backup its information.
425 If StringId = 0, output the string id of last string block (EFI_HII_SIBT_END).
427 @param Private Hii database private structure.
428 @param StringPackage Hii string package instance.
429 @param StringId The string's id, which is unique within
431 @param BlockType Output the block type of found string block.
432 @param StringBlockAddr Output the block address of found string block.
433 @param StringTextOffset Offset, relative to the found block address, of
434 the string text information.
435 @param LastStringId Output the last string id when StringId = 0.
437 @retval EFI_SUCCESS The string text and font is retrieved
439 @retval EFI_NOT_FOUND The specified text or font info can not be found
441 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
447 IN HII_DATABASE_PRIVATE_DATA
*Private
,
448 IN HII_STRING_PACKAGE_INSTANCE
*StringPackage
,
449 IN EFI_STRING_ID StringId
,
450 OUT UINT8
*BlockType
, OPTIONAL
451 OUT UINT8
**StringBlockAddr
, OPTIONAL
452 OUT UINTN
*StringTextOffset
, OPTIONAL
453 OUT EFI_STRING_ID
*LastStringId OPTIONAL
458 Parse all glyph blocks to find a glyph block specified by CharValue.
459 If CharValue = (CHAR16) (-1), collect all default character cell information
460 within this font package and backup its information.
462 @param FontPackage Hii string package instance.
463 @param CharValue Unicode character value, which identifies a glyph
465 @param GlyphBuffer Output the corresponding bitmap data of the found
466 block. It is the caller's responsiblity to free
468 @param Cell Output cell information of the encoded bitmap.
469 @param GlyphBufferLen If not NULL, output the length of GlyphBuffer.
471 @retval EFI_SUCCESS The bitmap data is retrieved successfully.
472 @retval EFI_NOT_FOUND The specified CharValue does not exist in current
474 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
480 IN HII_FONT_PACKAGE_INSTANCE
*FontPackage
,
482 OUT UINT8
**GlyphBuffer
, OPTIONAL
483 OUT EFI_HII_GLYPH_INFO
*Cell
, OPTIONAL
484 OUT UINTN
*GlyphBufferLen OPTIONAL
488 // EFI_HII_FONT_PROTOCOL protocol interfaces
493 Renders a string to a bitmap or to the display.
495 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
496 @param Flags Describes how the string is to be drawn.
497 @param String Points to the null-terminated string to be
499 @param StringInfo Points to the string output information,
500 including the color and font. If NULL, then the
501 string will be output in the default system font
503 @param Blt If this points to a non-NULL on entry, this
504 points to the image, which is Width pixels wide
505 and Height pixels high. The string will be drawn
507 EFI_HII_OUT_FLAG_CLIP is implied. If this points
508 to a NULL on entry, then a buffer
509 will be allocated to hold the generated image and
510 the pointer updated on exit. It is the caller's
511 responsibility to free this buffer.
512 @param BltX Together with BltX, Specifies the offset from the left and top edge
513 of the image of the first character cell in the
515 @param BltY Together with BltY, Specifies the offset from the left and top edge
516 of the image of the first character cell in the
518 @param RowInfoArray If this is non-NULL on entry, then on exit, this
519 will point to an allocated buffer containing
520 row information and RowInfoArraySize will be
521 updated to contain the number of elements.
522 This array describes the characters which were at
523 least partially drawn and the heights of the
524 rows. It is the caller's responsibility to free
526 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
527 contains the number of elements in RowInfoArray.
528 @param ColumnInfoArray If this is non-NULL, then on return it will be
529 filled with the horizontal offset for each
530 character in the string on the row where it is
531 displayed. Non-printing characters will have
532 the offset ~0. The caller is responsible to
533 allocate a buffer large enough so that there
534 is one entry for each character in the string,
535 not including the null-terminator. It is possible
536 when character display is normalized that some
537 character cells overlap.
539 @retval EFI_SUCCESS The string was successfully rendered.
540 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
542 @retval EFI_INVALID_PARAMETER The String or Blt.
543 @retval EFI_INVALID_PARAMETER Flags were invalid combination..
549 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
550 IN EFI_HII_OUT_FLAGS Flags
,
551 IN CONST EFI_STRING String
,
552 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo OPTIONAL
,
553 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
556 OUT EFI_HII_ROW_INFO
**RowInfoArray OPTIONAL
,
557 OUT UINTN
*RowInfoArraySize OPTIONAL
,
558 OUT UINTN
*ColumnInfoArray OPTIONAL
563 Render a string to a bitmap or the screen containing the contents of the specified string.
565 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
566 @param Flags Describes how the string is to be drawn.
567 @param PackageList The package list in the HII database to search
568 for the specified string.
569 @param StringId The string's id, which is unique within
571 @param Language Points to the language for the retrieved string.
572 If NULL, then the current system language is
574 @param StringInfo Points to the string output information,
575 including the color and font. If NULL, then the
576 string will be output in the default system font
578 @param Blt If this points to a non-NULL on entry, this
579 points to the image, which is Width pixels wide
580 and Height pixels high. The string will be drawn
582 EFI_HII_OUT_FLAG_CLIP is implied. If this points
583 to a NULL on entry, then a buffer
584 will be allocated to hold the generated image and
585 the pointer updated on exit. It is the caller's
586 responsibility to free this buffer.
587 @param BltX Together with BltX, Specifies the offset from the left and top edge
588 of the image of the first character cell in the
590 @param BltY Together with BltY, Specifies the offset from the left and top edge
591 of the image of the first character cell in the
593 @param RowInfoArray If this is non-NULL on entry, then on exit, this
594 will point to an allocated buffer containing
595 row information and RowInfoArraySize will be
596 updated to contain the number of elements.
597 This array describes the characters which were at
598 least partially drawn and the heights of the
599 rows. It is the caller's responsibility to free
601 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
602 contains the number of elements in RowInfoArray.
603 @param ColumnInfoArray If this is non-NULL, then on return it will be
604 filled with the horizontal offset for each
605 character in the string on the row where it is
606 displayed. Non-printing characters will have
607 the offset ~0. The caller is responsible to
608 allocate a buffer large enough so that there
609 is one entry for each character in the string,
610 not including the null-terminator. It is possible
611 when character display is normalized that some
612 character cells overlap.
614 @retval EFI_SUCCESS The string was successfully rendered.
615 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
617 @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.
618 @retval EFI_INVALID_PARAMETER Flags were invalid combination.
619 @retval EFI_NOT_FOUND The specified PackageList is not in the Database or the stringid is not
620 in the specified PackageList.
626 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
627 IN EFI_HII_OUT_FLAGS Flags
,
628 IN EFI_HII_HANDLE PackageList
,
629 IN EFI_STRING_ID StringId
,
630 IN CONST CHAR8
* Language
,
631 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo OPTIONAL
,
632 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
635 OUT EFI_HII_ROW_INFO
**RowInfoArray OPTIONAL
,
636 OUT UINTN
*RowInfoArraySize OPTIONAL
,
637 OUT UINTN
*ColumnInfoArray OPTIONAL
642 Convert the glyph for a single character into a bitmap.
644 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
645 @param Char Character to retrieve.
646 @param StringInfo Points to the string font and color information
647 or NULL if the string should use the default
648 system font and color.
649 @param Blt Thus must point to a NULL on entry. A buffer will
650 be allocated to hold the output and the pointer
651 updated on exit. It is the caller's
652 responsibility to free this buffer.
653 @param Baseline Number of pixels from the bottom of the bitmap to
656 @retval EFI_SUCCESS Glyph bitmap created.
657 @retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer Blt.
658 @retval EFI_WARN_UNKNOWN_GLYPH The glyph was unknown and was replaced with the
659 glyph for Unicode character 0xFFFD.
660 @retval EFI_INVALID_PARAMETER Blt is NULL or *Blt is not NULL.
666 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
668 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo
,
669 OUT EFI_IMAGE_OUTPUT
**Blt
,
670 OUT UINTN
*Baseline OPTIONAL
675 This function iterates through fonts which match the specified font, using
676 the specified criteria. If String is non-NULL, then all of the characters in
677 the string must exist in order for a candidate font to be returned.
679 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
680 @param FontHandle On entry, points to the font handle returned by a
681 previous call to GetFontInfo() or NULL to start
682 with the first font. On return, points to the
683 returned font handle or points to NULL if there
684 are no more matching fonts.
685 @param StringInfoIn Upon entry, points to the font to return
686 information about. If NULL, then the information about the system default
687 font will be returned.
688 @param StringInfoOut Upon return, contains the matching font's
689 information. If NULL, then no information is
690 returned. It's caller's responsibility to free
692 @param String Points to the string which will be tested to
693 determine if all characters are available. If
694 NULL, then any font is acceptable.
696 @retval EFI_SUCCESS Matching font returned successfully.
697 @retval EFI_NOT_FOUND No matching font was found.
698 @retval EFI_INVALID_PARAMETER StringInfoIn is NULL.
699 @retval EFI_INVALID_PARAMETER StringInfoIn->FontInfoMask is an invalid combination.
700 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the
706 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
707 IN OUT EFI_FONT_HANDLE
*FontHandle
,
708 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfoIn
, OPTIONAL
709 OUT EFI_FONT_DISPLAY_INFO
**StringInfoOut
,
710 IN CONST EFI_STRING String OPTIONAL
714 // EFI_HII_IMAGE_PROTOCOL interfaces
719 This function adds the image Image to the group of images owned by PackageList, and returns
720 a new image identifier (ImageId).
722 @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
723 @param PackageList Handle of the package list where this image will
725 @param ImageId On return, contains the new image id, which is
726 unique within PackageList.
727 @param Image Points to the image.
729 @retval EFI_SUCCESS The new image was added successfully.
730 @retval EFI_NOT_FOUND The specified PackageList could not be found in
732 @retval EFI_OUT_OF_RESOURCES Could not add the image due to lack of resources.
733 @retval EFI_INVALID_PARAMETER Image is NULL or ImageId is NULL.
739 IN CONST EFI_HII_IMAGE_PROTOCOL
*This
,
740 IN EFI_HII_HANDLE PackageList
,
741 OUT EFI_IMAGE_ID
*ImageId
,
742 IN CONST EFI_IMAGE_INPUT
*Image
747 This function retrieves the image specified by ImageId which is associated with
748 the specified PackageList and copies it into the buffer specified by Image.
750 @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
751 @param PackageList Handle of the package list where this image will
753 @param ImageId The image's id,, which is unique within
755 @param Image Points to the image.
757 @retval EFI_SUCCESS The new image was returned successfully.
758 @retval EFI_NOT_FOUND The image specified by ImageId is not available.
759 The specified PackageList is not in the database.
760 @retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is too small to
762 @retval EFI_INVALID_PARAMETER The Image or ImageSize was NULL.
763 @retval EFI_OUT_OF_RESOURCES The bitmap could not be retrieved because there was not
770 IN CONST EFI_HII_IMAGE_PROTOCOL
*This
,
771 IN EFI_HII_HANDLE PackageList
,
772 IN EFI_IMAGE_ID ImageId
,
773 OUT EFI_IMAGE_INPUT
*Image
778 This function updates the image specified by ImageId in the specified PackageListHandle to
779 the image specified by Image.
781 @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
782 @param PackageList The package list containing the images.
783 @param ImageId The image's id,, which is unique within
785 @param Image Points to the image.
787 @retval EFI_SUCCESS The new image was updated successfully.
788 @retval EFI_NOT_FOUND The image specified by ImageId is not in the
789 database. The specified PackageList is not in the database.
790 @retval EFI_INVALID_PARAMETER The Image was NULL.
796 IN CONST EFI_HII_IMAGE_PROTOCOL
*This
,
797 IN EFI_HII_HANDLE PackageList
,
798 IN EFI_IMAGE_ID ImageId
,
799 IN CONST EFI_IMAGE_INPUT
*Image
804 This function renders an image to a bitmap or the screen using the specified
805 color and options. It draws the image on an existing bitmap, allocates a new
806 bitmap or uses the screen. The images can be clipped.
808 @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
809 @param Flags Describes how the image is to be drawn.
810 @param Image Points to the image to be displayed.
811 @param Blt If this points to a non-NULL on entry, this
812 points to the image, which is Width pixels wide
813 and Height pixels high. The image will be drawn
814 onto this image and EFI_HII_DRAW_FLAG_CLIP is
815 implied. If this points to a NULL on entry, then
816 a buffer will be allocated to hold the generated
817 image and the pointer updated on exit. It is the
818 caller's responsibility to free this buffer.
819 @param BltX Specifies the offset from the left and top edge
820 of the output image of the first pixel in the
822 @param BltY Specifies the offset from the left and top edge
823 of the output image of the first pixel in the
826 @retval EFI_SUCCESS The image was successfully drawn.
827 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for Blt.
828 @retval EFI_INVALID_PARAMETER The Image or Blt was NULL.
829 @retval EFI_INVALID_PARAMETER Any combination of Flags is invalid.
835 IN CONST EFI_HII_IMAGE_PROTOCOL
*This
,
836 IN EFI_HII_DRAW_FLAGS Flags
,
837 IN CONST EFI_IMAGE_INPUT
*Image
,
838 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
845 This function renders an image to a bitmap or the screen using the specified
846 color and options. It draws the image on an existing bitmap, allocates a new
847 bitmap or uses the screen. The images can be clipped.
849 @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
850 @param Flags Describes how the image is to be drawn.
851 @param PackageList The package list in the HII database to search
852 for the specified image.
853 @param ImageId The image's id, which is unique within
855 @param Blt If this points to a non-NULL on entry, this
856 points to the image, which is Width pixels wide
857 and Height pixels high. The image will be drawn
859 EFI_HII_DRAW_FLAG_CLIP is implied. If this points
860 to a NULL on entry, then a buffer will be
861 allocated to hold the generated image and the
862 pointer updated on exit. It is the caller's
863 responsibility to free this buffer.
864 @param BltX Specifies the offset from the left and top edge
865 of the output image of the first pixel in the
867 @param BltY Specifies the offset from the left and top edge
868 of the output image of the first pixel in the
871 @retval EFI_SUCCESS The image was successfully drawn.
872 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for Blt.
873 @retval EFI_INVALID_PARAMETER The Blt was NULL.
874 @retval EFI_NOT_FOUND The image specified by ImageId is not in the database.
875 The specified PackageList is not in the database.
881 IN CONST EFI_HII_IMAGE_PROTOCOL
*This
,
882 IN EFI_HII_DRAW_FLAGS Flags
,
883 IN EFI_HII_HANDLE PackageList
,
884 IN EFI_IMAGE_ID ImageId
,
885 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
893 // EFI_HII_STRING_PROTOCOL
898 This function adds the string String to the group of strings owned by PackageList, with the
899 specified font information StringFontInfo and returns a new string id.
901 @param This A pointer to the EFI_HII_STRING_PROTOCOL
903 @param PackageList Handle of the package list where this string will
905 @param StringId On return, contains the new strings id, which is
906 unique within PackageList.
907 @param Language Points to the language for the new string.
908 @param LanguageName Points to the printable language name to
909 associate with the passed in Language field.If
910 LanguageName is not NULL and the string package
911 header's LanguageName associated with a given
912 Language is not zero, the LanguageName being
913 passed in will be ignored.
914 @param String Points to the new null-terminated string.
915 @param StringFontInfo Points to the new string's font information or
916 NULL if the string should have the default system
917 font, size and style.
919 @retval EFI_SUCCESS The new string was added successfully.
920 @retval EFI_NOT_FOUND The specified PackageList could not be found in
922 @retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of
924 @retval EFI_INVALID_PARAMETER String is NULL or StringId is NULL or Language is
931 IN CONST EFI_HII_STRING_PROTOCOL
*This
,
932 IN EFI_HII_HANDLE PackageList
,
933 OUT EFI_STRING_ID
*StringId
,
934 IN CONST CHAR8
*Language
,
935 IN CONST CHAR16
*LanguageName
, OPTIONAL
936 IN CONST EFI_STRING String
,
937 IN CONST EFI_FONT_INFO
*StringFontInfo OPTIONAL
942 This function retrieves the string specified by StringId which is associated
943 with the specified PackageList in the language Language and copies it into
944 the buffer specified by String.
946 @param This A pointer to the EFI_HII_STRING_PROTOCOL
948 @param Language Points to the language for the retrieved string.
949 @param PackageList The package list in the HII database to search
950 for the specified string.
951 @param StringId The string's id, which is unique within
953 @param String Points to the new null-terminated string.
954 @param StringSize On entry, points to the size of the buffer
955 pointed to by String, in bytes. On return,
956 points to the length of the string, in bytes.
957 @param StringFontInfo If not NULL, points to the string's font
958 information. It's caller's responsibility to
961 @retval EFI_SUCCESS The string was returned successfully.
962 @retval EFI_NOT_FOUND The string specified by StringId is not
964 @retval EFI_NOT_FOUND The string specified by StringId is available but
965 not in the specified language.
966 The specified PackageList is not in the database.
967 @retval EFI_INVALID_LANGUAGE - The string specified by StringId is available but
968 @retval EFI_BUFFER_TOO_SMALL The buffer specified by StringSize is too small
970 @retval EFI_INVALID_PARAMETER The String or Language or StringSize was NULL.
971 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the
978 IN CONST EFI_HII_STRING_PROTOCOL
*This
,
979 IN CONST CHAR8
*Language
,
980 IN EFI_HII_HANDLE PackageList
,
981 IN EFI_STRING_ID StringId
,
982 OUT EFI_STRING String
,
983 IN OUT UINTN
*StringSize
,
984 OUT EFI_FONT_INFO
**StringFontInfo OPTIONAL
989 This function updates the string specified by StringId in the specified PackageList to the text
990 specified by String and, optionally, the font information specified by StringFontInfo.
992 @param This A pointer to the EFI_HII_STRING_PROTOCOL
994 @param PackageList The package list containing the strings.
995 @param StringId The string's id, which is unique within
997 @param Language Points to the language for the updated string.
998 @param String Points to the new null-terminated string.
999 @param StringFontInfo Points to the string's font information or NULL
1000 if the string font information is not changed.
1002 @retval EFI_SUCCESS The string was updated successfully.
1003 @retval EFI_NOT_FOUND The string specified by StringId is not in the
1005 @retval EFI_INVALID_PARAMETER The String or Language was NULL.
1006 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
1013 IN CONST EFI_HII_STRING_PROTOCOL
*This
,
1014 IN EFI_HII_HANDLE PackageList
,
1015 IN EFI_STRING_ID StringId
,
1016 IN CONST CHAR8
*Language
,
1017 IN CONST EFI_STRING String
,
1018 IN CONST EFI_FONT_INFO
*StringFontInfo OPTIONAL
1023 This function returns the list of supported languages, in the format specified
1024 in Appendix M of UEFI 2.1 spec.
1026 @param This A pointer to the EFI_HII_STRING_PROTOCOL
1028 @param PackageList The package list to examine.
1029 @param Languages Points to the buffer to hold the returned string.
1030 @param LanguagesSize On entry, points to the size of the buffer
1031 pointed to by Languages, in bytes. On return,
1032 points to the length of Languages, in bytes.
1034 @retval EFI_SUCCESS The languages were returned successfully.
1035 @retval EFI_INVALID_PARAMETER The Languages or LanguagesSize was NULL.
1036 @retval EFI_BUFFER_TOO_SMALL The LanguagesSize is too small to hold the list
1037 of supported languages. LanguageSize is updated
1038 to contain the required size.
1039 @retval EFI_NOT_FOUND Could not find string package in specified
1046 IN CONST EFI_HII_STRING_PROTOCOL
*This
,
1047 IN EFI_HII_HANDLE PackageList
,
1048 IN OUT CHAR8
*Languages
,
1049 IN OUT UINTN
*LanguagesSize
1054 Each string package has associated with it a single primary language and zero
1055 or more secondary languages. This routine returns the secondary languages
1056 associated with a package list.
1058 @param This A pointer to the EFI_HII_STRING_PROTOCOL
1060 @param PackageList The package list to examine.
1061 @param FirstLanguage Points to the primary language.
1062 @param SecondaryLanguages Points to the buffer to hold the returned list of
1063 secondary languages for the specified
1064 FirstLanguage. If there are no secondary
1065 languages, the function returns successfully,
1066 but this is set to NULL.
1067 @param SecondaryLanguagesSize On entry, points to the size of the buffer
1068 pointed to by SecondLanguages, in bytes. On
1069 return, points to the length of SecondLanguages
1072 @retval EFI_SUCCESS Secondary languages were correctly returned.
1073 @retval EFI_INVALID_PARAMETER FirstLanguage or SecondLanguages or
1074 SecondLanguagesSize was NULL.
1075 @retval EFI_BUFFER_TOO_SMALL The buffer specified by SecondLanguagesSize is
1076 too small to hold the returned information.
1077 SecondLanguageSize is updated to hold the size of
1078 the buffer required.
1079 @retval EFI_INVALID_LANGUAGE The language specified by FirstLanguage is not
1080 present in the specified package list.
1081 @retval EFI_NOT_FOUND The specified PackageList is not in the Database.
1086 HiiGetSecondaryLanguages (
1087 IN CONST EFI_HII_STRING_PROTOCOL
*This
,
1088 IN EFI_HII_HANDLE PackageList
,
1089 IN CONST CHAR8
*FirstLanguage
,
1090 IN OUT CHAR8
*SecondaryLanguages
,
1091 IN OUT UINTN
*SecondaryLanguagesSize
1095 // EFI_HII_DATABASE_PROTOCOL protocol interfaces
1100 This function adds the packages in the package list to the database and returns a handle. If there is a
1101 EFI_DEVICE_PATH_PROTOCOL associated with the DriverHandle, then this function will
1102 create a package of type EFI_PACKAGE_TYPE_DEVICE_PATH and add it to the package list.
1104 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1106 @param PackageList A pointer to an EFI_HII_PACKAGE_LIST_HEADER
1108 @param DriverHandle Associate the package list with this EFI handle.
1109 @param Handle A pointer to the EFI_HII_HANDLE instance.
1111 @retval EFI_SUCCESS The package list associated with the Handle was
1112 added to the HII database.
1113 @retval EFI_OUT_OF_RESOURCES Unable to allocate necessary resources for the
1114 new database contents.
1115 @retval EFI_INVALID_PARAMETER PackageList is NULL or Handle is NULL.
1121 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1122 IN CONST EFI_HII_PACKAGE_LIST_HEADER
*PackageList
,
1123 IN CONST EFI_HANDLE DriverHandle
,
1124 OUT EFI_HII_HANDLE
*Handle
1129 This function removes the package list that is associated with a handle Handle
1130 from the HII database. Before removing the package, any registered functions
1131 with the notification type REMOVE_PACK and the same package type will be called.
1133 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1135 @param Handle The handle that was registered to the data that
1136 is requested for removal.
1138 @retval EFI_SUCCESS The data associated with the Handle was removed
1139 from the HII database.
1140 @retval EFI_NOT_FOUND The specified Handle is not in database.
1145 HiiRemovePackageList (
1146 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1147 IN EFI_HII_HANDLE Handle
1152 This function updates the existing package list (which has the specified Handle)
1153 in the HII databases, using the new package list specified by PackageList.
1155 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1157 @param Handle The handle that was registered to the data that
1158 is requested to be updated.
1159 @param PackageList A pointer to an EFI_HII_PACKAGE_LIST_HEADER
1162 @retval EFI_SUCCESS The HII database was successfully updated.
1163 @retval EFI_OUT_OF_RESOURCES Unable to allocate enough memory for the updated
1165 @retval EFI_INVALID_PARAMETER PackageList was NULL.
1166 @retval EFI_NOT_FOUND The specified Handle is not in database.
1171 HiiUpdatePackageList (
1172 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1173 IN EFI_HII_HANDLE Handle
,
1174 IN CONST EFI_HII_PACKAGE_LIST_HEADER
*PackageList
1179 This function returns a list of the package handles of the specified type
1180 that are currently active in the database. The pseudo-type
1181 EFI_HII_PACKAGE_TYPE_ALL will cause all package handles to be listed.
1183 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1185 @param PackageType Specifies the package type of the packages to
1186 list or EFI_HII_PACKAGE_TYPE_ALL for all packages
1188 @param PackageGuid If PackageType is EFI_HII_PACKAGE_TYPE_GUID, then
1189 this is the pointer to the GUID which must match
1190 the Guid field of EFI_HII_GUID_PACKAGE_GUID_HDR.
1191 Otherwise, it must be NULL.
1192 @param HandleBufferLength On input, a pointer to the length of the handle
1193 buffer. On output, the length of the handle
1194 buffer that is required for the handles found.
1195 @param Handle An array of EFI_HII_HANDLE instances returned.
1197 @retval EFI_SUCCESS The matching handles are outputed successfully.
1198 HandleBufferLength is updated with the actual length.
1199 @retval EFI_BUFFER_TO_SMALL The HandleBufferLength parameter indicates that
1200 Handle is too small to support the number of
1201 handles. HandleBufferLength is updated with a
1202 value that will enable the data to fit.
1203 @retval EFI_NOT_FOUND No matching handle could not be found in
1205 @retval EFI_INVALID_PARAMETER Handle or HandleBufferLength was NULL.
1206 @retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but
1207 PackageGuid is not NULL, PackageType is a EFI_HII_
1208 PACKAGE_TYPE_GUID but PackageGuid is NULL.
1214 HiiListPackageLists (
1215 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1216 IN UINT8 PackageType
,
1217 IN CONST EFI_GUID
*PackageGuid
,
1218 IN OUT UINTN
*HandleBufferLength
,
1219 OUT EFI_HII_HANDLE
*Handle
1224 This function will export one or all package lists in the database to a buffer.
1225 For each package list exported, this function will call functions registered
1226 with EXPORT_PACK and then copy the package list to the buffer.
1228 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1230 @param Handle An EFI_HII_HANDLE that corresponds to the desired
1231 package list in the HII database to export or
1232 NULL to indicate all package lists should be
1234 @param BufferSize On input, a pointer to the length of the buffer.
1235 On output, the length of the buffer that is
1236 required for the exported data.
1237 @param Buffer A pointer to a buffer that will contain the
1238 results of the export function.
1240 @retval EFI_SUCCESS Package exported.
1241 @retval EFI_BUFFER_TO_SMALL The HandleBufferLength parameter indicates that
1242 Handle is too small to support the number of
1243 handles. HandleBufferLength is updated with
1244 a value that will enable the data to fit.
1245 @retval EFI_NOT_FOUND The specifiecd Handle could not be found in the
1247 @retval EFI_INVALID_PARAMETER Handle or Buffer or BufferSize was NULL.
1252 HiiExportPackageLists (
1253 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1254 IN EFI_HII_HANDLE Handle
,
1255 IN OUT UINTN
*BufferSize
,
1256 OUT EFI_HII_PACKAGE_LIST_HEADER
*Buffer
1261 This function registers a function which will be called when specified actions related to packages of
1262 the specified type occur in the HII database. By registering a function, other HII-related drivers are
1263 notified when specific package types are added, removed or updated in the HII database.
1264 Each driver or application which registers a notification should use
1265 EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify() before exiting.
1267 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1269 @param PackageType Specifies the package type of the packages to
1270 list or EFI_HII_PACKAGE_TYPE_ALL for all packages
1272 @param PackageGuid If PackageType is EFI_HII_PACKAGE_TYPE_GUID, then
1273 this is the pointer to the GUID which must match
1275 EFI_HII_GUID_PACKAGE_GUID_HDR. Otherwise, it must
1277 @param PackageNotifyFn Points to the function to be called when the
1279 NotificationType occurs.
1280 @param NotifyType Describes the types of notification which this
1281 function will be receiving.
1282 @param NotifyHandle Points to the unique handle assigned to the
1283 registered notification. Can be used in
1284 EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify()
1285 to stop notifications.
1287 @retval EFI_SUCCESS Notification registered successfully.
1288 @retval EFI_OUT_OF_RESOURCES Unable to allocate necessary data structures
1289 @retval EFI_INVALID_PARAMETER NotifyHandle is NULL.
1290 @retval EFI_INVALID_PARAMETER PackageGuid is not NULL when PackageType is not
1291 EFI_HII_PACKAGE_TYPE_GUID.
1292 @retval EFI_INVALID_PARAMETER PackageGuid is NULL when PackageType is
1293 EFI_HII_PACKAGE_TYPE_GUID.
1298 HiiRegisterPackageNotify (
1299 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1300 IN UINT8 PackageType
,
1301 IN CONST EFI_GUID
*PackageGuid
,
1302 IN CONST EFI_HII_DATABASE_NOTIFY PackageNotifyFn
,
1303 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
,
1304 OUT EFI_HANDLE
*NotifyHandle
1309 Removes the specified HII database package-related notification.
1311 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1313 @param NotificationHandle The handle of the notification function being
1316 @retval EFI_SUCCESS Notification is unregistered successfully.
1317 @retval EFI_NOT_FOUND The incoming notification handle does not exist
1318 in current hii database.
1323 HiiUnregisterPackageNotify (
1324 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1325 IN EFI_HANDLE NotificationHandle
1330 This routine retrieves an array of GUID values for each keyboard layout that
1331 was previously registered in the system.
1333 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1335 @param KeyGuidBufferLength On input, a pointer to the length of the keyboard
1336 GUID buffer. On output, the length of the handle
1337 buffer that is required for the handles found.
1338 @param KeyGuidBuffer An array of keyboard layout GUID instances
1341 @retval EFI_SUCCESS KeyGuidBuffer was updated successfully.
1342 @retval EFI_BUFFER_TOO_SMALL The KeyGuidBufferLength parameter indicates
1343 that KeyGuidBuffer is too small to support the
1344 number of GUIDs. KeyGuidBufferLength is
1345 updated with a value that will enable the data to
1347 @retval EFI_INVALID_PARAMETER The KeyGuidBuffer or KeyGuidBufferLength was
1349 @retval EFI_NOT_FOUND There was no keyboard layout.
1354 HiiFindKeyboardLayouts (
1355 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1356 IN OUT UINT16
*KeyGuidBufferLength
,
1357 OUT EFI_GUID
*KeyGuidBuffer
1362 This routine retrieves the requested keyboard layout. The layout is a physical description of the keys
1363 on a keyboard and the character(s) that are associated with a particular set of key strokes.
1365 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1367 @param KeyGuid A pointer to the unique ID associated with a
1368 given keyboard layout. If KeyGuid is NULL then
1369 the current layout will be retrieved.
1370 @param KeyboardLayoutLength On input, a pointer to the length of the
1371 KeyboardLayout buffer. On output, the length of
1372 the data placed into KeyboardLayout.
1373 @param KeyboardLayout A pointer to a buffer containing the retrieved
1376 @retval EFI_SUCCESS The keyboard layout was retrieved successfully.
1377 @retval EFI_NOT_FOUND The requested keyboard layout was not found.
1378 @retval EFI_INVALID_PARAMETER The KeyboardLayout or KeyboardLayoutLength was
1384 HiiGetKeyboardLayout (
1385 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1386 IN CONST EFI_GUID
*KeyGuid
,
1387 IN OUT UINT16
*KeyboardLayoutLength
,
1388 OUT EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
1393 This routine sets the default keyboard layout to the one referenced by KeyGuid. When this routine
1394 is called, an event will be signaled of the EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID
1395 group type. This is so that agents which are sensitive to the current keyboard layout being changed
1396 can be notified of this change.
1398 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1400 @param KeyGuid A pointer to the unique ID associated with a
1401 given keyboard layout.
1403 @retval EFI_SUCCESS The current keyboard layout was successfully set.
1404 @retval EFI_NOT_FOUND The referenced keyboard layout was not found, so
1406 @retval EFI_INVALID_PARAMETER The KeyGuid was NULL.
1411 HiiSetKeyboardLayout (
1412 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1413 IN CONST EFI_GUID
*KeyGuid
1418 Return the EFI handle associated with a package list.
1420 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1422 @param PackageListHandle An EFI_HII_HANDLE that corresponds to the desired
1423 package list in the HIIdatabase.
1424 @param DriverHandle On return, contains the EFI_HANDLE which was
1425 registered with the package list in
1428 @retval EFI_SUCCESS The DriverHandle was returned successfully.
1429 @retval EFI_INVALID_PARAMETER The PackageListHandle was not valid or
1430 DriverHandle was NULL.
1435 HiiGetPackageListHandle (
1436 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1437 IN EFI_HII_HANDLE PackageListHandle
,
1438 OUT EFI_HANDLE
*DriverHandle
1442 // EFI_HII_CONFIG_ROUTING_PROTOCOL interfaces
1447 This function allows a caller to extract the current configuration
1448 for one or more named elements from one or more drivers.
1450 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
1452 @param Request A null-terminated Unicode string in
1453 <MultiConfigRequest> format.
1454 @param Progress On return, points to a character in the Request
1455 string. Points to the string's null terminator if
1456 request was successful. Points to the most recent
1457 & before the first failing name / value pair (or
1458 the beginning of the string if the failure is in
1459 the first name / value pair) if the request was
1461 @param Results Null-terminated Unicode string in
1462 <MultiConfigAltResp> format which has all values
1463 filled in for the names in the Request string.
1464 String to be allocated by the called function.
1466 @retval EFI_SUCCESS The Results string is filled with the values
1467 corresponding to all requested names.
1468 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
1469 results that must be stored awaiting possible
1471 @retval EFI_NOT_FOUND Routing data doesn't match any known driver.
1472 Progress set to the "G" in "GUID" of the
1473 routing header that doesn't match. Note: There
1474 is no requirement that all routing data
1475 be validated before any configuration extraction.
1476 @retval EFI_INVALID_PARAMETER For example, passing in a NULL for the Request
1477 parameter would result in this type of error. The
1478 Progress parameter is set to NULL.
1479 @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set to most recent &
1480 before the error or the beginning of the string.
1481 @retval EFI_INVALID_PARAMETER Unknown name. Progress points to the & before the
1487 HiiConfigRoutingExtractConfig (
1488 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
1489 IN CONST EFI_STRING Request
,
1490 OUT EFI_STRING
*Progress
,
1491 OUT EFI_STRING
*Results
1496 This function allows the caller to request the current configuration for the
1497 entirety of the current HII database and returns the data in a null-terminated Unicode string.
1499 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
1501 @param Results Null-terminated Unicode string in
1502 <MultiConfigAltResp> format which has all values
1503 filled in for the names in the Request string.
1504 String to be allocated by the called function.
1505 De-allocation is up to the caller.
1507 @retval EFI_SUCCESS The Results string is filled with the values
1508 corresponding to all requested names.
1509 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
1510 results that must be stored awaiting possible
1512 @retval EFI_INVALID_PARAMETER For example, passing in a NULL for the Results
1513 parameter would result in this type of error.
1518 HiiConfigRoutingExportConfig (
1519 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
1520 OUT EFI_STRING
*Results
1525 This function processes the results of processing forms and routes it to the
1526 appropriate handlers or storage.
1528 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
1530 @param Configuration A null-terminated Unicode string in
1531 <MulltiConfigResp> format.
1532 @param Progress A pointer to a string filled in with the offset
1533 of the most recent & before the first failing
1534 name / value pair (or the beginning of the string
1535 if the failure is in the first name / value pair)
1536 or the terminating NULL if all was successful.
1538 @retval EFI_SUCCESS The results have been distributed or are awaiting
1540 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
1541 results that must be stored awaiting possible
1543 @retval EFI_INVALID_PARAMETER Passing in a NULL for the Configuration parameter
1544 would result in this type of error.
1545 @retval EFI_NOT_FOUND Target for the specified routing data was not
1551 HiiConfigRoutingRouteConfig (
1552 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
1553 IN CONST EFI_STRING Configuration
,
1554 OUT EFI_STRING
*Progress
1560 This helper function is to be called by drivers to map configuration data stored
1561 in byte array ("block") formats such as UEFI Variables into current configuration strings.
1563 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
1565 @param ConfigRequest A null-terminated Unicode string in
1566 <ConfigRequest> format.
1567 @param Block Array of bytes defining the block's
1569 @param BlockSize Length in bytes of Block.
1570 @param Config Filled-in configuration string. String allocated
1571 by the function. Returned only if call is
1573 @param Progress A pointer to a string filled in with the offset
1574 of the most recent & before the first failing
1575 name/value pair (or the beginning of the string
1576 if the failure is in the first name / value pair)
1577 or the terminating NULL if all was successful.
1579 @retval EFI_SUCCESS The request succeeded. Progress points to the
1580 null terminator at the end of the ConfigRequest
1582 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config.
1583 Progress points to the first character of
1585 @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigRequest or
1586 Block parameter would result in this type of
1587 error. Progress points to the first character of
1589 @retval EFI_NOT_FOUND Target for the specified routing data was not
1590 found. Progress points to the "G" in "GUID" of
1591 the errant routing data.
1592 @retval EFI_DEVICE_ERROR Block not large enough. Progress undefined.
1593 @retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted string.
1594 Block is left updated and Progress points at
1595 the '&' preceding the first non-<BlockName>.
1601 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
1602 IN CONST EFI_STRING ConfigRequest
,
1603 IN CONST UINT8
*Block
,
1604 IN CONST UINTN BlockSize
,
1605 OUT EFI_STRING
*Config
,
1606 OUT EFI_STRING
*Progress
1611 This helper function is to be called by drivers to map configuration strings
1612 to configurations stored in byte array ("block") formats such as UEFI Variables.
1614 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
1616 @param ConfigResp A null-terminated Unicode string in <ConfigResp>
1618 @param Block A possibly null array of bytes representing the
1619 current block. Only bytes referenced in the
1620 ConfigResp string in the block are modified. If
1621 this parameter is null or if the *BlockSize
1622 parameter is (on input) shorter than required by
1623 the Configuration string, only the BlockSize
1624 parameter is updated and an appropriate status
1625 (see below) is returned.
1626 @param BlockSize The length of the Block in units of UINT8. On
1627 input, this is the size of the Block. On output,
1628 if successful, contains the index of the last
1629 modified byte in the Block.
1630 @param Progress On return, points to an element of the ConfigResp
1631 string filled in with the offset of the most
1632 recent '&' before the first failing name / value
1633 pair (or the beginning of the string if the
1634 failure is in the first name / value pair) or
1635 the terminating NULL if all was successful.
1637 @retval EFI_SUCCESS The request succeeded. Progress points to the
1638 null terminator at the end of the ConfigResp
1640 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config.
1641 Progress points to the first character of
1643 @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigResp or
1644 Block parameter would result in this type of
1645 error. Progress points to the first character of
1647 @retval EFI_NOT_FOUND Target for the specified routing data was not
1648 found. Progress points to the "G" in "GUID" of
1649 the errant routing data.
1650 @retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted name /
1651 value pair. Block is left updated and
1652 Progress points at the '&' preceding the first
1659 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
1660 IN CONST EFI_STRING ConfigResp
,
1661 IN OUT UINT8
*Block
,
1662 IN OUT UINTN
*BlockSize
,
1663 OUT EFI_STRING
*Progress
1668 This helper function is to be called by drivers to extract portions of
1669 a larger configuration string.
1671 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
1673 @param Configuration A null-terminated Unicode string in
1674 <MultiConfigAltResp> format.
1675 @param Guid A pointer to the GUID value to search for in the
1676 routing portion of the ConfigResp string when
1677 retrieving the requested data. If Guid is NULL,
1678 then all GUID values will be searched for.
1679 @param Name A pointer to the NAME value to search for in the
1680 routing portion of the ConfigResp string when
1681 retrieving the requested data. If Name is NULL,
1682 then all Name values will be searched for.
1683 @param DevicePath A pointer to the PATH value to search for in the
1684 routing portion of the ConfigResp string when
1685 retrieving the requested data. If DevicePath is
1686 NULL, then all DevicePath values will be
1688 @param AltCfgId A pointer to the ALTCFG value to search for in
1689 the routing portion of the ConfigResp string
1690 when retrieving the requested data. If this
1691 parameter is NULL, then the current setting will
1693 @param AltCfgResp A pointer to a buffer which will be allocated by
1694 the function which contains the retrieved string
1695 as requested. This buffer is only allocated if
1696 the call was successful.
1698 @retval EFI_SUCCESS The request succeeded. The requested data was
1699 extracted and placed in the newly allocated
1701 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate AltCfgResp.
1702 @retval EFI_INVALID_PARAMETER Any parameter is invalid.
1703 @retval EFI_NOT_FOUND Target for the specified routing data was not
1710 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
1711 IN CONST EFI_STRING Configuration
,
1712 IN CONST EFI_GUID
*Guid
,
1713 IN CONST EFI_STRING Name
,
1714 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1715 IN CONST UINT16
*AltCfgId
,
1716 OUT EFI_STRING
*AltCfgResp
1722 extern EFI_EVENT gHiiKeyboardLayoutChanged
;