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 This function exports Form packages to a buffer.
489 This is a internal function.
491 @param Private Hii database private structure.
492 @param Handle Identification of a package list.
493 @param PackageList Pointer to a package list which will be exported.
494 @param UsedSize The length of buffer be used.
495 @param BufferSize Length of the Buffer.
496 @param Buffer Allocated space for storing exported data.
497 @param ResultSize The size of the already exported content of this
500 @retval EFI_SUCCESS Form Packages are exported successfully.
501 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
506 IN HII_DATABASE_PRIVATE_DATA
*Private
,
507 IN EFI_HII_HANDLE Handle
,
508 IN HII_DATABASE_PACKAGE_LIST_INSTANCE
*PackageList
,
512 IN OUT UINTN
*ResultSize
516 // EFI_HII_FONT_PROTOCOL protocol interfaces
521 Renders a string to a bitmap or to the display.
523 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
524 @param Flags Describes how the string is to be drawn.
525 @param String Points to the null-terminated string to be
527 @param StringInfo Points to the string output information,
528 including the color and font. If NULL, then the
529 string will be output in the default system font
531 @param Blt If this points to a non-NULL on entry, this
532 points to the image, which is Width pixels wide
533 and Height pixels high. The string will be drawn
535 EFI_HII_OUT_FLAG_CLIP is implied. If this points
536 to a NULL on entry, then a buffer
537 will be allocated to hold the generated image and
538 the pointer updated on exit. It is the caller's
539 responsibility to free this buffer.
540 @param BltX Together with BltX, Specifies the offset from the left and top edge
541 of the image of the first character cell in the
543 @param BltY Together with BltY, Specifies the offset from the left and top edge
544 of the image of the first character cell in the
546 @param RowInfoArray If this is non-NULL on entry, then on exit, this
547 will point to an allocated buffer containing
548 row information and RowInfoArraySize will be
549 updated to contain the number of elements.
550 This array describes the characters which were at
551 least partially drawn and the heights of the
552 rows. It is the caller's responsibility to free
554 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
555 contains the number of elements in RowInfoArray.
556 @param ColumnInfoArray If this is non-NULL, then on return it will be
557 filled with the horizontal offset for each
558 character in the string on the row where it is
559 displayed. Non-printing characters will have
560 the offset ~0. The caller is responsible to
561 allocate a buffer large enough so that there
562 is one entry for each character in the string,
563 not including the null-terminator. It is possible
564 when character display is normalized that some
565 character cells overlap.
567 @retval EFI_SUCCESS The string was successfully rendered.
568 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
570 @retval EFI_INVALID_PARAMETER The String or Blt.
571 @retval EFI_INVALID_PARAMETER Flags were invalid combination..
577 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
578 IN EFI_HII_OUT_FLAGS Flags
,
579 IN CONST EFI_STRING String
,
580 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo OPTIONAL
,
581 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
584 OUT EFI_HII_ROW_INFO
**RowInfoArray OPTIONAL
,
585 OUT UINTN
*RowInfoArraySize OPTIONAL
,
586 OUT UINTN
*ColumnInfoArray OPTIONAL
591 Render a string to a bitmap or the screen containing the contents of the specified string.
593 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
594 @param Flags Describes how the string is to be drawn.
595 @param PackageList The package list in the HII database to search
596 for the specified string.
597 @param StringId The string's id, which is unique within
599 @param Language Points to the language for the retrieved string.
600 If NULL, then the current system language is
602 @param StringInfo Points to the string output information,
603 including the color and font. If NULL, then the
604 string will be output in the default system font
606 @param Blt If this points to a non-NULL on entry, this
607 points to the image, which is Width pixels wide
608 and Height pixels high. The string will be drawn
610 EFI_HII_OUT_FLAG_CLIP is implied. If this points
611 to a NULL on entry, then a buffer
612 will be allocated to hold the generated image and
613 the pointer updated on exit. It is the caller's
614 responsibility to free this buffer.
615 @param BltX Together with BltX, Specifies the offset from the left and top edge
616 of the image of the first character cell in the
618 @param BltY Together with BltY, Specifies the offset from the left and top edge
619 of the image of the first character cell in the
621 @param RowInfoArray If this is non-NULL on entry, then on exit, this
622 will point to an allocated buffer containing
623 row information and RowInfoArraySize will be
624 updated to contain the number of elements.
625 This array describes the characters which were at
626 least partially drawn and the heights of the
627 rows. It is the caller's responsibility to free
629 @param RowInfoArraySize If this is non-NULL on entry, then on exit it
630 contains the number of elements in RowInfoArray.
631 @param ColumnInfoArray If this is non-NULL, then on return it will be
632 filled with the horizontal offset for each
633 character in the string on the row where it is
634 displayed. Non-printing characters will have
635 the offset ~0. The caller is responsible to
636 allocate a buffer large enough so that there
637 is one entry for each character in the string,
638 not including the null-terminator. It is possible
639 when character display is normalized that some
640 character cells overlap.
642 @retval EFI_SUCCESS The string was successfully rendered.
643 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for
645 @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.
646 @retval EFI_INVALID_PARAMETER Flags were invalid combination.
647 @retval EFI_NOT_FOUND The specified PackageList is not in the Database or the stringid is not
648 in the specified PackageList.
654 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
655 IN EFI_HII_OUT_FLAGS Flags
,
656 IN EFI_HII_HANDLE PackageList
,
657 IN EFI_STRING_ID StringId
,
658 IN CONST CHAR8
* Language
,
659 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo OPTIONAL
,
660 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
663 OUT EFI_HII_ROW_INFO
**RowInfoArray OPTIONAL
,
664 OUT UINTN
*RowInfoArraySize OPTIONAL
,
665 OUT UINTN
*ColumnInfoArray OPTIONAL
670 Convert the glyph for a single character into a bitmap.
672 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
673 @param Char Character to retrieve.
674 @param StringInfo Points to the string font and color information
675 or NULL if the string should use the default
676 system font and color.
677 @param Blt Thus must point to a NULL on entry. A buffer will
678 be allocated to hold the output and the pointer
679 updated on exit. It is the caller's
680 responsibility to free this buffer.
681 @param Baseline Number of pixels from the bottom of the bitmap to
684 @retval EFI_SUCCESS Glyph bitmap created.
685 @retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer Blt.
686 @retval EFI_WARN_UNKNOWN_GLYPH The glyph was unknown and was replaced with the
687 glyph for Unicode character 0xFFFD.
688 @retval EFI_INVALID_PARAMETER Blt is NULL or *Blt is not NULL.
694 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
696 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfo
,
697 OUT EFI_IMAGE_OUTPUT
**Blt
,
698 OUT UINTN
*Baseline OPTIONAL
703 This function iterates through fonts which match the specified font, using
704 the specified criteria. If String is non-NULL, then all of the characters in
705 the string must exist in order for a candidate font to be returned.
707 @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.
708 @param FontHandle On entry, points to the font handle returned by a
709 previous call to GetFontInfo() or NULL to start
710 with the first font. On return, points to the
711 returned font handle or points to NULL if there
712 are no more matching fonts.
713 @param StringInfoIn Upon entry, points to the font to return
714 information about. If NULL, then the information about the system default
715 font will be returned.
716 @param StringInfoOut Upon return, contains the matching font's
717 information. If NULL, then no information is
718 returned. It's caller's responsibility to free
720 @param String Points to the string which will be tested to
721 determine if all characters are available. If
722 NULL, then any font is acceptable.
724 @retval EFI_SUCCESS Matching font returned successfully.
725 @retval EFI_NOT_FOUND No matching font was found.
726 @retval EFI_INVALID_PARAMETER StringInfoIn is NULL.
727 @retval EFI_INVALID_PARAMETER StringInfoIn->FontInfoMask is an invalid combination.
728 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the
734 IN CONST EFI_HII_FONT_PROTOCOL
*This
,
735 IN OUT EFI_FONT_HANDLE
*FontHandle
,
736 IN CONST EFI_FONT_DISPLAY_INFO
*StringInfoIn
, OPTIONAL
737 OUT EFI_FONT_DISPLAY_INFO
**StringInfoOut
,
738 IN CONST EFI_STRING String OPTIONAL
742 // EFI_HII_IMAGE_PROTOCOL interfaces
747 This function adds the image Image to the group of images owned by PackageList, and returns
748 a new image identifier (ImageId).
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 On return, contains the new image id, which is
754 unique within PackageList.
755 @param Image Points to the image.
757 @retval EFI_SUCCESS The new image was added successfully.
758 @retval EFI_NOT_FOUND The specified PackageList could not be found in
760 @retval EFI_OUT_OF_RESOURCES Could not add the image due to lack of resources.
761 @retval EFI_INVALID_PARAMETER Image is NULL or ImageId is NULL.
767 IN CONST EFI_HII_IMAGE_PROTOCOL
*This
,
768 IN EFI_HII_HANDLE PackageList
,
769 OUT EFI_IMAGE_ID
*ImageId
,
770 IN CONST EFI_IMAGE_INPUT
*Image
775 This function retrieves the image specified by ImageId which is associated with
776 the specified PackageList and copies it into the buffer specified by Image.
778 @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
779 @param PackageList Handle of the package list where this image will
781 @param ImageId The image's id,, which is unique within
783 @param Image Points to the image.
785 @retval EFI_SUCCESS The new image was returned successfully.
786 @retval EFI_NOT_FOUND The image specified by ImageId is not available.
787 The specified PackageList is not in the database.
788 @retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is too small to
790 @retval EFI_INVALID_PARAMETER The Image or ImageSize was NULL.
791 @retval EFI_OUT_OF_RESOURCES The bitmap could not be retrieved because there was not
798 IN CONST EFI_HII_IMAGE_PROTOCOL
*This
,
799 IN EFI_HII_HANDLE PackageList
,
800 IN EFI_IMAGE_ID ImageId
,
801 OUT EFI_IMAGE_INPUT
*Image
806 This function updates the image specified by ImageId in the specified PackageListHandle to
807 the image specified by Image.
809 @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
810 @param PackageList The package list containing the images.
811 @param ImageId The image's id,, which is unique within
813 @param Image Points to the image.
815 @retval EFI_SUCCESS The new image was updated successfully.
816 @retval EFI_NOT_FOUND The image specified by ImageId is not in the
817 database. The specified PackageList is not in the database.
818 @retval EFI_INVALID_PARAMETER The Image was NULL.
824 IN CONST EFI_HII_IMAGE_PROTOCOL
*This
,
825 IN EFI_HII_HANDLE PackageList
,
826 IN EFI_IMAGE_ID ImageId
,
827 IN CONST EFI_IMAGE_INPUT
*Image
832 This function renders an image to a bitmap or the screen using the specified
833 color and options. It draws the image on an existing bitmap, allocates a new
834 bitmap or uses the screen. The images can be clipped.
836 @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
837 @param Flags Describes how the image is to be drawn.
838 @param Image Points to the image to be displayed.
839 @param Blt If this points to a non-NULL on entry, this
840 points to the image, which is Width pixels wide
841 and Height pixels high. The image will be drawn
842 onto this image and EFI_HII_DRAW_FLAG_CLIP is
843 implied. If this points to a NULL on entry, then
844 a buffer will be allocated to hold the generated
845 image and the pointer updated on exit. It is the
846 caller's responsibility to free this buffer.
847 @param BltX Specifies the offset from the left and top edge
848 of the output image of the first pixel in the
850 @param BltY Specifies the offset from the left and top edge
851 of the output image of the first pixel in the
854 @retval EFI_SUCCESS The image was successfully drawn.
855 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for Blt.
856 @retval EFI_INVALID_PARAMETER The Image or Blt was NULL.
857 @retval EFI_INVALID_PARAMETER Any combination of Flags is invalid.
863 IN CONST EFI_HII_IMAGE_PROTOCOL
*This
,
864 IN EFI_HII_DRAW_FLAGS Flags
,
865 IN CONST EFI_IMAGE_INPUT
*Image
,
866 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
873 This function renders an image to a bitmap or the screen using the specified
874 color and options. It draws the image on an existing bitmap, allocates a new
875 bitmap or uses the screen. The images can be clipped.
877 @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance.
878 @param Flags Describes how the image is to be drawn.
879 @param PackageList The package list in the HII database to search
880 for the specified image.
881 @param ImageId The image's id, which is unique within
883 @param Blt If this points to a non-NULL on entry, this
884 points to the image, which is Width pixels wide
885 and Height pixels high. The image will be drawn
887 EFI_HII_DRAW_FLAG_CLIP is implied. If this points
888 to a NULL on entry, then a buffer will be
889 allocated to hold the generated image and the
890 pointer updated on exit. It is the caller's
891 responsibility to free this buffer.
892 @param BltX Specifies the offset from the left and top edge
893 of the output image of the first pixel in the
895 @param BltY Specifies the offset from the left and top edge
896 of the output image of the first pixel in the
899 @retval EFI_SUCCESS The image was successfully drawn.
900 @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for Blt.
901 @retval EFI_INVALID_PARAMETER The Blt was NULL.
902 @retval EFI_NOT_FOUND The image specified by ImageId is not in the database.
903 The specified PackageList is not in the database.
909 IN CONST EFI_HII_IMAGE_PROTOCOL
*This
,
910 IN EFI_HII_DRAW_FLAGS Flags
,
911 IN EFI_HII_HANDLE PackageList
,
912 IN EFI_IMAGE_ID ImageId
,
913 IN OUT EFI_IMAGE_OUTPUT
**Blt
,
921 // EFI_HII_STRING_PROTOCOL
926 This function adds the string String to the group of strings owned by PackageList, with the
927 specified font information StringFontInfo and returns a new string id.
929 @param This A pointer to the EFI_HII_STRING_PROTOCOL
931 @param PackageList Handle of the package list where this string will
933 @param StringId On return, contains the new strings id, which is
934 unique within PackageList.
935 @param Language Points to the language for the new string.
936 @param LanguageName Points to the printable language name to
937 associate with the passed in Language field.If
938 LanguageName is not NULL and the string package
939 header's LanguageName associated with a given
940 Language is not zero, the LanguageName being
941 passed in will be ignored.
942 @param String Points to the new null-terminated string.
943 @param StringFontInfo Points to the new string's font information or
944 NULL if the string should have the default system
945 font, size and style.
947 @retval EFI_SUCCESS The new string was added successfully.
948 @retval EFI_NOT_FOUND The specified PackageList could not be found in
950 @retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of
952 @retval EFI_INVALID_PARAMETER String is NULL or StringId is NULL or Language is
959 IN CONST EFI_HII_STRING_PROTOCOL
*This
,
960 IN EFI_HII_HANDLE PackageList
,
961 OUT EFI_STRING_ID
*StringId
,
962 IN CONST CHAR8
*Language
,
963 IN CONST CHAR16
*LanguageName
, OPTIONAL
964 IN CONST EFI_STRING String
,
965 IN CONST EFI_FONT_INFO
*StringFontInfo OPTIONAL
970 This function retrieves the string specified by StringId which is associated
971 with the specified PackageList in the language Language and copies it into
972 the buffer specified by String.
974 @param This A pointer to the EFI_HII_STRING_PROTOCOL
976 @param Language Points to the language for the retrieved string.
977 @param PackageList The package list in the HII database to search
978 for the specified string.
979 @param StringId The string's id, which is unique within
981 @param String Points to the new null-terminated string.
982 @param StringSize On entry, points to the size of the buffer
983 pointed to by String, in bytes. On return,
984 points to the length of the string, in bytes.
985 @param StringFontInfo If not NULL, points to the string's font
986 information. It's caller's responsibility to
989 @retval EFI_SUCCESS The string was returned successfully.
990 @retval EFI_NOT_FOUND The string specified by StringId is not
992 @retval EFI_NOT_FOUND The string specified by StringId is available but
993 not in the specified language.
994 The specified PackageList is not in the database.
995 @retval EFI_INVALID_LANGUAGE - The string specified by StringId is available but
996 @retval EFI_BUFFER_TOO_SMALL The buffer specified by StringSize is too small
998 @retval EFI_INVALID_PARAMETER The String or Language or StringSize was NULL.
999 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the
1006 IN CONST EFI_HII_STRING_PROTOCOL
*This
,
1007 IN CONST CHAR8
*Language
,
1008 IN EFI_HII_HANDLE PackageList
,
1009 IN EFI_STRING_ID StringId
,
1010 OUT EFI_STRING String
,
1011 IN OUT UINTN
*StringSize
,
1012 OUT EFI_FONT_INFO
**StringFontInfo OPTIONAL
1017 This function updates the string specified by StringId in the specified PackageList to the text
1018 specified by String and, optionally, the font information specified by StringFontInfo.
1020 @param This A pointer to the EFI_HII_STRING_PROTOCOL
1022 @param PackageList The package list containing the strings.
1023 @param StringId The string's id, which is unique within
1025 @param Language Points to the language for the updated string.
1026 @param String Points to the new null-terminated string.
1027 @param StringFontInfo Points to the string's font information or NULL
1028 if the string font information is not changed.
1030 @retval EFI_SUCCESS The string was updated successfully.
1031 @retval EFI_NOT_FOUND The string specified by StringId is not in the
1033 @retval EFI_INVALID_PARAMETER The String or Language was NULL.
1034 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
1041 IN CONST EFI_HII_STRING_PROTOCOL
*This
,
1042 IN EFI_HII_HANDLE PackageList
,
1043 IN EFI_STRING_ID StringId
,
1044 IN CONST CHAR8
*Language
,
1045 IN CONST EFI_STRING String
,
1046 IN CONST EFI_FONT_INFO
*StringFontInfo OPTIONAL
1051 This function returns the list of supported languages, in the format specified
1052 in Appendix M of UEFI 2.1 spec.
1054 @param This A pointer to the EFI_HII_STRING_PROTOCOL
1056 @param PackageList The package list to examine.
1057 @param Languages Points to the buffer to hold the returned string.
1058 @param LanguagesSize On entry, points to the size of the buffer
1059 pointed to by Languages, in bytes. On return,
1060 points to the length of Languages, in bytes.
1062 @retval EFI_SUCCESS The languages were returned successfully.
1063 @retval EFI_INVALID_PARAMETER The Languages or LanguagesSize was NULL.
1064 @retval EFI_BUFFER_TOO_SMALL The LanguagesSize is too small to hold the list
1065 of supported languages. LanguageSize is updated
1066 to contain the required size.
1067 @retval EFI_NOT_FOUND Could not find string package in specified
1074 IN CONST EFI_HII_STRING_PROTOCOL
*This
,
1075 IN EFI_HII_HANDLE PackageList
,
1076 IN OUT CHAR8
*Languages
,
1077 IN OUT UINTN
*LanguagesSize
1082 Each string package has associated with it a single primary language and zero
1083 or more secondary languages. This routine returns the secondary languages
1084 associated with a package list.
1086 @param This A pointer to the EFI_HII_STRING_PROTOCOL
1088 @param PackageList The package list to examine.
1089 @param FirstLanguage Points to the primary language.
1090 @param SecondaryLanguages Points to the buffer to hold the returned list of
1091 secondary languages for the specified
1092 FirstLanguage. If there are no secondary
1093 languages, the function returns successfully,
1094 but this is set to NULL.
1095 @param SecondaryLanguagesSize On entry, points to the size of the buffer
1096 pointed to by SecondLanguages, in bytes. On
1097 return, points to the length of SecondLanguages
1100 @retval EFI_SUCCESS Secondary languages were correctly returned.
1101 @retval EFI_INVALID_PARAMETER FirstLanguage or SecondLanguages or
1102 SecondLanguagesSize was NULL.
1103 @retval EFI_BUFFER_TOO_SMALL The buffer specified by SecondLanguagesSize is
1104 too small to hold the returned information.
1105 SecondLanguageSize is updated to hold the size of
1106 the buffer required.
1107 @retval EFI_INVALID_LANGUAGE The language specified by FirstLanguage is not
1108 present in the specified package list.
1109 @retval EFI_NOT_FOUND The specified PackageList is not in the Database.
1114 HiiGetSecondaryLanguages (
1115 IN CONST EFI_HII_STRING_PROTOCOL
*This
,
1116 IN EFI_HII_HANDLE PackageList
,
1117 IN CONST CHAR8
*FirstLanguage
,
1118 IN OUT CHAR8
*SecondaryLanguages
,
1119 IN OUT UINTN
*SecondaryLanguagesSize
1123 // EFI_HII_DATABASE_PROTOCOL protocol interfaces
1128 This function adds the packages in the package list to the database and returns a handle. If there is a
1129 EFI_DEVICE_PATH_PROTOCOL associated with the DriverHandle, then this function will
1130 create a package of type EFI_PACKAGE_TYPE_DEVICE_PATH and add it to the package list.
1132 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1134 @param PackageList A pointer to an EFI_HII_PACKAGE_LIST_HEADER
1136 @param DriverHandle Associate the package list with this EFI handle.
1137 @param Handle A pointer to the EFI_HII_HANDLE instance.
1139 @retval EFI_SUCCESS The package list associated with the Handle was
1140 added to the HII database.
1141 @retval EFI_OUT_OF_RESOURCES Unable to allocate necessary resources for the
1142 new database contents.
1143 @retval EFI_INVALID_PARAMETER PackageList is NULL or Handle is NULL.
1149 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1150 IN CONST EFI_HII_PACKAGE_LIST_HEADER
*PackageList
,
1151 IN CONST EFI_HANDLE DriverHandle
,
1152 OUT EFI_HII_HANDLE
*Handle
1157 This function removes the package list that is associated with a handle Handle
1158 from the HII database. Before removing the package, any registered functions
1159 with the notification type REMOVE_PACK and the same package type will be called.
1161 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1163 @param Handle The handle that was registered to the data that
1164 is requested for removal.
1166 @retval EFI_SUCCESS The data associated with the Handle was removed
1167 from the HII database.
1168 @retval EFI_NOT_FOUND The specified Handle is not in database.
1173 HiiRemovePackageList (
1174 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1175 IN EFI_HII_HANDLE Handle
1180 This function updates the existing package list (which has the specified Handle)
1181 in the HII databases, using the new package list specified by PackageList.
1183 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1185 @param Handle The handle that was registered to the data that
1186 is requested to be updated.
1187 @param PackageList A pointer to an EFI_HII_PACKAGE_LIST_HEADER
1190 @retval EFI_SUCCESS The HII database was successfully updated.
1191 @retval EFI_OUT_OF_RESOURCES Unable to allocate enough memory for the updated
1193 @retval EFI_INVALID_PARAMETER PackageList was NULL.
1194 @retval EFI_NOT_FOUND The specified Handle is not in database.
1199 HiiUpdatePackageList (
1200 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1201 IN EFI_HII_HANDLE Handle
,
1202 IN CONST EFI_HII_PACKAGE_LIST_HEADER
*PackageList
1207 This function returns a list of the package handles of the specified type
1208 that are currently active in the database. The pseudo-type
1209 EFI_HII_PACKAGE_TYPE_ALL will cause all package handles to be listed.
1211 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1213 @param PackageType Specifies the package type of the packages to
1214 list or EFI_HII_PACKAGE_TYPE_ALL for all packages
1216 @param PackageGuid If PackageType is EFI_HII_PACKAGE_TYPE_GUID, then
1217 this is the pointer to the GUID which must match
1218 the Guid field of EFI_HII_GUID_PACKAGE_GUID_HDR.
1219 Otherwise, it must be NULL.
1220 @param HandleBufferLength On input, a pointer to the length of the handle
1221 buffer. On output, the length of the handle
1222 buffer that is required for the handles found.
1223 @param Handle An array of EFI_HII_HANDLE instances returned.
1225 @retval EFI_SUCCESS The matching handles are outputed successfully.
1226 HandleBufferLength is updated with the actual length.
1227 @retval EFI_BUFFER_TO_SMALL The HandleBufferLength parameter indicates that
1228 Handle is too small to support the number of
1229 handles. HandleBufferLength is updated with a
1230 value that will enable the data to fit.
1231 @retval EFI_NOT_FOUND No matching handle could not be found in
1233 @retval EFI_INVALID_PARAMETER Handle or HandleBufferLength was NULL.
1234 @retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but
1235 PackageGuid is not NULL, PackageType is a EFI_HII_
1236 PACKAGE_TYPE_GUID but PackageGuid is NULL.
1242 HiiListPackageLists (
1243 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1244 IN UINT8 PackageType
,
1245 IN CONST EFI_GUID
*PackageGuid
,
1246 IN OUT UINTN
*HandleBufferLength
,
1247 OUT EFI_HII_HANDLE
*Handle
1252 This function will export one or all package lists in the database to a buffer.
1253 For each package list exported, this function will call functions registered
1254 with EXPORT_PACK and then copy the package list to the buffer.
1256 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1258 @param Handle An EFI_HII_HANDLE that corresponds to the desired
1259 package list in the HII database to export or
1260 NULL to indicate all package lists should be
1262 @param BufferSize On input, a pointer to the length of the buffer.
1263 On output, the length of the buffer that is
1264 required for the exported data.
1265 @param Buffer A pointer to a buffer that will contain the
1266 results of the export function.
1268 @retval EFI_SUCCESS Package exported.
1269 @retval EFI_BUFFER_TO_SMALL The HandleBufferLength parameter indicates that
1270 Handle is too small to support the number of
1271 handles. HandleBufferLength is updated with
1272 a value that will enable the data to fit.
1273 @retval EFI_NOT_FOUND The specifiecd Handle could not be found in the
1275 @retval EFI_INVALID_PARAMETER Handle or Buffer or BufferSize was NULL.
1280 HiiExportPackageLists (
1281 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1282 IN EFI_HII_HANDLE Handle
,
1283 IN OUT UINTN
*BufferSize
,
1284 OUT EFI_HII_PACKAGE_LIST_HEADER
*Buffer
1289 This function registers a function which will be called when specified actions related to packages of
1290 the specified type occur in the HII database. By registering a function, other HII-related drivers are
1291 notified when specific package types are added, removed or updated in the HII database.
1292 Each driver or application which registers a notification should use
1293 EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify() before exiting.
1295 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1297 @param PackageType Specifies the package type of the packages to
1298 list or EFI_HII_PACKAGE_TYPE_ALL for all packages
1300 @param PackageGuid If PackageType is EFI_HII_PACKAGE_TYPE_GUID, then
1301 this is the pointer to the GUID which must match
1303 EFI_HII_GUID_PACKAGE_GUID_HDR. Otherwise, it must
1305 @param PackageNotifyFn Points to the function to be called when the
1307 NotificationType occurs.
1308 @param NotifyType Describes the types of notification which this
1309 function will be receiving.
1310 @param NotifyHandle Points to the unique handle assigned to the
1311 registered notification. Can be used in
1312 EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify()
1313 to stop notifications.
1315 @retval EFI_SUCCESS Notification registered successfully.
1316 @retval EFI_OUT_OF_RESOURCES Unable to allocate necessary data structures
1317 @retval EFI_INVALID_PARAMETER NotifyHandle is NULL.
1318 @retval EFI_INVALID_PARAMETER PackageGuid is not NULL when PackageType is not
1319 EFI_HII_PACKAGE_TYPE_GUID.
1320 @retval EFI_INVALID_PARAMETER PackageGuid is NULL when PackageType is
1321 EFI_HII_PACKAGE_TYPE_GUID.
1326 HiiRegisterPackageNotify (
1327 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1328 IN UINT8 PackageType
,
1329 IN CONST EFI_GUID
*PackageGuid
,
1330 IN CONST EFI_HII_DATABASE_NOTIFY PackageNotifyFn
,
1331 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
,
1332 OUT EFI_HANDLE
*NotifyHandle
1337 Removes the specified HII database package-related notification.
1339 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1341 @param NotificationHandle The handle of the notification function being
1344 @retval EFI_SUCCESS Notification is unregistered successfully.
1345 @retval EFI_NOT_FOUND The incoming notification handle does not exist
1346 in current hii database.
1351 HiiUnregisterPackageNotify (
1352 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1353 IN EFI_HANDLE NotificationHandle
1358 This routine retrieves an array of GUID values for each keyboard layout that
1359 was previously registered in the system.
1361 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1363 @param KeyGuidBufferLength On input, a pointer to the length of the keyboard
1364 GUID buffer. On output, the length of the handle
1365 buffer that is required for the handles found.
1366 @param KeyGuidBuffer An array of keyboard layout GUID instances
1369 @retval EFI_SUCCESS KeyGuidBuffer was updated successfully.
1370 @retval EFI_BUFFER_TOO_SMALL The KeyGuidBufferLength parameter indicates
1371 that KeyGuidBuffer is too small to support the
1372 number of GUIDs. KeyGuidBufferLength is
1373 updated with a value that will enable the data to
1375 @retval EFI_INVALID_PARAMETER The KeyGuidBuffer or KeyGuidBufferLength was
1377 @retval EFI_NOT_FOUND There was no keyboard layout.
1382 HiiFindKeyboardLayouts (
1383 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1384 IN OUT UINT16
*KeyGuidBufferLength
,
1385 OUT EFI_GUID
*KeyGuidBuffer
1390 This routine retrieves the requested keyboard layout. The layout is a physical description of the keys
1391 on a keyboard and the character(s) that are associated with a particular set of key strokes.
1393 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1395 @param KeyGuid A pointer to the unique ID associated with a
1396 given keyboard layout. If KeyGuid is NULL then
1397 the current layout will be retrieved.
1398 @param KeyboardLayoutLength On input, a pointer to the length of the
1399 KeyboardLayout buffer. On output, the length of
1400 the data placed into KeyboardLayout.
1401 @param KeyboardLayout A pointer to a buffer containing the retrieved
1404 @retval EFI_SUCCESS The keyboard layout was retrieved successfully.
1405 @retval EFI_NOT_FOUND The requested keyboard layout was not found.
1406 @retval EFI_INVALID_PARAMETER The KeyboardLayout or KeyboardLayoutLength was
1412 HiiGetKeyboardLayout (
1413 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1414 IN CONST EFI_GUID
*KeyGuid
,
1415 IN OUT UINT16
*KeyboardLayoutLength
,
1416 OUT EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
1421 This routine sets the default keyboard layout to the one referenced by KeyGuid. When this routine
1422 is called, an event will be signaled of the EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID
1423 group type. This is so that agents which are sensitive to the current keyboard layout being changed
1424 can be notified of this change.
1426 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1428 @param KeyGuid A pointer to the unique ID associated with a
1429 given keyboard layout.
1431 @retval EFI_SUCCESS The current keyboard layout was successfully set.
1432 @retval EFI_NOT_FOUND The referenced keyboard layout was not found, so
1434 @retval EFI_INVALID_PARAMETER The KeyGuid was NULL.
1439 HiiSetKeyboardLayout (
1440 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1441 IN CONST EFI_GUID
*KeyGuid
1446 Return the EFI handle associated with a package list.
1448 @param This A pointer to the EFI_HII_DATABASE_PROTOCOL
1450 @param PackageListHandle An EFI_HII_HANDLE that corresponds to the desired
1451 package list in the HIIdatabase.
1452 @param DriverHandle On return, contains the EFI_HANDLE which was
1453 registered with the package list in
1456 @retval EFI_SUCCESS The DriverHandle was returned successfully.
1457 @retval EFI_INVALID_PARAMETER The PackageListHandle was not valid or
1458 DriverHandle was NULL.
1463 HiiGetPackageListHandle (
1464 IN CONST EFI_HII_DATABASE_PROTOCOL
*This
,
1465 IN EFI_HII_HANDLE PackageListHandle
,
1466 OUT EFI_HANDLE
*DriverHandle
1470 // EFI_HII_CONFIG_ROUTING_PROTOCOL interfaces
1475 This function allows a caller to extract the current configuration
1476 for one or more named elements from one or more drivers.
1478 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
1480 @param Request A null-terminated Unicode string in
1481 <MultiConfigRequest> format.
1482 @param Progress On return, points to a character in the Request
1483 string. Points to the string's null terminator if
1484 request was successful. Points to the most recent
1485 & before the first failing name / value pair (or
1486 the beginning of the string if the failure is in
1487 the first name / value pair) if the request was
1489 @param Results Null-terminated Unicode string in
1490 <MultiConfigAltResp> format which has all values
1491 filled in for the names in the Request string.
1492 String to be allocated by the called function.
1494 @retval EFI_SUCCESS The Results string is filled with the values
1495 corresponding to all requested names.
1496 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
1497 results that must be stored awaiting possible
1499 @retval EFI_NOT_FOUND Routing data doesn't match any known driver.
1500 Progress set to the "G" in "GUID" of the
1501 routing header that doesn't match. Note: There
1502 is no requirement that all routing data
1503 be validated before any configuration extraction.
1504 @retval EFI_INVALID_PARAMETER For example, passing in a NULL for the Request
1505 parameter would result in this type of error. The
1506 Progress parameter is set to NULL.
1507 @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set to most recent &
1508 before the error or the beginning of the string.
1509 @retval EFI_INVALID_PARAMETER Unknown name. Progress points to the & before the
1515 HiiConfigRoutingExtractConfig (
1516 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
1517 IN CONST EFI_STRING Request
,
1518 OUT EFI_STRING
*Progress
,
1519 OUT EFI_STRING
*Results
1524 This function allows the caller to request the current configuration for the
1525 entirety of the current HII database and returns the data in a null-terminated Unicode string.
1527 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
1529 @param Results Null-terminated Unicode string in
1530 <MultiConfigAltResp> format which has all values
1531 filled in for the names in the Request string.
1532 String to be allocated by the called function.
1533 De-allocation is up to the caller.
1535 @retval EFI_SUCCESS The Results string is filled with the values
1536 corresponding to all requested names.
1537 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
1538 results that must be stored awaiting possible
1540 @retval EFI_INVALID_PARAMETER For example, passing in a NULL for the Results
1541 parameter would result in this type of error.
1546 HiiConfigRoutingExportConfig (
1547 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
1548 OUT EFI_STRING
*Results
1553 This function processes the results of processing forms and routes it to the
1554 appropriate handlers or storage.
1556 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
1558 @param Configuration A null-terminated Unicode string in
1559 <MulltiConfigResp> format.
1560 @param Progress A pointer to a string filled in with the offset
1561 of the most recent & before the first failing
1562 name / value pair (or the beginning of the string
1563 if the failure is in the first name / value pair)
1564 or the terminating NULL if all was successful.
1566 @retval EFI_SUCCESS The results have been distributed or are awaiting
1568 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
1569 results that must be stored awaiting possible
1571 @retval EFI_INVALID_PARAMETER Passing in a NULL for the Configuration parameter
1572 would result in this type of error.
1573 @retval EFI_NOT_FOUND Target for the specified routing data was not
1579 HiiConfigRoutingRouteConfig (
1580 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
1581 IN CONST EFI_STRING Configuration
,
1582 OUT EFI_STRING
*Progress
1588 This helper function is to be called by drivers to map configuration data stored
1589 in byte array ("block") formats such as UEFI Variables into current configuration strings.
1591 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
1593 @param ConfigRequest A null-terminated Unicode string in
1594 <ConfigRequest> format.
1595 @param Block Array of bytes defining the block's
1597 @param BlockSize Length in bytes of Block.
1598 @param Config Filled-in configuration string. String allocated
1599 by the function. Returned only if call is
1601 @param Progress A pointer to a string filled in with the offset
1602 of the most recent & before the first failing
1603 name/value pair (or the beginning of the string
1604 if the failure is in the first name / value pair)
1605 or the terminating NULL if all was successful.
1607 @retval EFI_SUCCESS The request succeeded. Progress points to the
1608 null terminator at the end of the ConfigRequest
1610 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config.
1611 Progress points to the first character of
1613 @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigRequest or
1614 Block parameter would result in this type of
1615 error. Progress points to the first character of
1617 @retval EFI_NOT_FOUND Target for the specified routing data was not
1618 found. Progress points to the "G" in "GUID" of
1619 the errant routing data.
1620 @retval EFI_DEVICE_ERROR Block not large enough. Progress undefined.
1621 @retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted string.
1622 Block is left updated and Progress points at
1623 the '&' preceding the first non-<BlockName>.
1629 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
1630 IN CONST EFI_STRING ConfigRequest
,
1631 IN CONST UINT8
*Block
,
1632 IN CONST UINTN BlockSize
,
1633 OUT EFI_STRING
*Config
,
1634 OUT EFI_STRING
*Progress
1639 This helper function is to be called by drivers to map configuration strings
1640 to configurations stored in byte array ("block") formats such as UEFI Variables.
1642 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
1644 @param ConfigResp A null-terminated Unicode string in <ConfigResp>
1646 @param Block A possibly null array of bytes representing the
1647 current block. Only bytes referenced in the
1648 ConfigResp string in the block are modified. If
1649 this parameter is null or if the *BlockSize
1650 parameter is (on input) shorter than required by
1651 the Configuration string, only the BlockSize
1652 parameter is updated and an appropriate status
1653 (see below) is returned.
1654 @param BlockSize The length of the Block in units of UINT8. On
1655 input, this is the size of the Block. On output,
1656 if successful, contains the index of the last
1657 modified byte in the Block.
1658 @param Progress On return, points to an element of the ConfigResp
1659 string filled in with the offset of the most
1660 recent '&' before the first failing name / value
1661 pair (or the beginning of the string if the
1662 failure is in the first name / value pair) or
1663 the terminating NULL if all was successful.
1665 @retval EFI_SUCCESS The request succeeded. Progress points to the
1666 null terminator at the end of the ConfigResp
1668 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config.
1669 Progress points to the first character of
1671 @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigResp or
1672 Block parameter would result in this type of
1673 error. Progress points to the first character of
1675 @retval EFI_NOT_FOUND Target for the specified routing data was not
1676 found. Progress points to the "G" in "GUID" of
1677 the errant routing data.
1678 @retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted name /
1679 value pair. Block is left updated and
1680 Progress points at the '&' preceding the first
1687 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
1688 IN CONST EFI_STRING ConfigResp
,
1689 IN OUT UINT8
*Block
,
1690 IN OUT UINTN
*BlockSize
,
1691 OUT EFI_STRING
*Progress
1696 This helper function is to be called by drivers to extract portions of
1697 a larger configuration string.
1699 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
1701 @param Configuration A null-terminated Unicode string in
1702 <MultiConfigAltResp> format.
1703 @param Guid A pointer to the GUID value to search for in the
1704 routing portion of the ConfigResp string when
1705 retrieving the requested data. If Guid is NULL,
1706 then all GUID values will be searched for.
1707 @param Name A pointer to the NAME value to search for in the
1708 routing portion of the ConfigResp string when
1709 retrieving the requested data. If Name is NULL,
1710 then all Name values will be searched for.
1711 @param DevicePath A pointer to the PATH value to search for in the
1712 routing portion of the ConfigResp string when
1713 retrieving the requested data. If DevicePath is
1714 NULL, then all DevicePath values will be
1716 @param AltCfgId A pointer to the ALTCFG value to search for in
1717 the routing portion of the ConfigResp string
1718 when retrieving the requested data. If this
1719 parameter is NULL, then the current setting will
1721 @param AltCfgResp A pointer to a buffer which will be allocated by
1722 the function which contains the retrieved string
1723 as requested. This buffer is only allocated if
1724 the call was successful.
1726 @retval EFI_SUCCESS The request succeeded. The requested data was
1727 extracted and placed in the newly allocated
1729 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate AltCfgResp.
1730 @retval EFI_INVALID_PARAMETER Any parameter is invalid.
1731 @retval EFI_NOT_FOUND Target for the specified routing data was not
1738 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
1739 IN CONST EFI_STRING Configuration
,
1740 IN CONST EFI_GUID
*Guid
,
1741 IN CONST EFI_STRING Name
,
1742 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1743 IN CONST UINT16
*AltCfgId
,
1744 OUT EFI_STRING
*AltCfgResp
1750 extern EFI_EVENT gHiiKeyboardLayoutChanged
;