4a2237852fb7b4977741ff08f55e5383c1460f01
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / HiiFramework.h
1 /** @file
2 This file defines the Human Interface Infrastructure protocol which will
3 be used by resources which want to publish IFR/Font/String data and have it
4 collected by the Configuration engine.
5
6 Copyright (c) 2007, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
11
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14
15 Module Name: HiiFramework.h
16
17 @par Revision Reference:
18 This protocol is defined in HII spec 0.92.
19
20 **/
21
22 #ifndef _FRAMEWORK_HII_H_
23 #define _FRAMEWORK_HII_H_
24
25 #include <PiDxe.h>
26
27 //
28 // To get EFI_GRAPHICS_OUTPUT_BLT_PIXEL,
29 // is defined in MdePkg/Protocol/GraphicsOutput.h
30 //
31 #include <Protocol/GraphicsOutput.h>
32
33 #define EFI_HII_PROTOCOL_GUID \
34 { \
35 0xd7ad636e, 0xb997, 0x459b, {0xbf, 0x3f, 0x88, 0x46, 0x89, 0x79, 0x80, 0xe1} \
36 }
37
38 // BugBug:
39 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
40 // If UGA goes away we need to put this some place. I'm not sure where?
41 //
42 //typedef struct {
43 // UINT8 Blue;
44 // UINT8 Green;
45 // UINT8 Red;
46 // UINT8 Reserved;
47 //} EFI_UGA_PIXEL;
48
49 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
50 //
51
52 typedef struct _EFI_HII_PROTOCOL EFI_HII_PROTOCOL;
53
54 //
55 // Global definition
56 //
57 #define NARROW_CHAR 0xFFF0
58 #define WIDE_CHAR 0xFFF1
59 #define NON_BREAKING_CHAR 0xFFF2
60 #define GLYPH_WIDTH 8
61 #define GLYPH_HEIGHT 19
62
63 #define EFI_HII_FONT 1
64 #define EFI_HII_STRING 2
65 #define EFI_HII_IFR 3
66 #define EFI_HII_KEYBOARD 4
67 #define EFI_HII_HANDLES 5
68 #define EFI_HII_VARIABLE 6
69 #define EFI_HII_DEVICE_PATH 7
70
71
72 // References to string tokens must use this macro to enable scanning for
73 // token usages.
74 //
75 #define STRING_TOKEN(t) t
76
77 //
78 // The following types are currently defined:
79 //
80 typedef UINT16 EFI_FORM_ID;
81 typedef UINT16 EFI_FORM_LABEL;
82
83 #pragma pack(1)
84
85 typedef struct {
86 UINT32 Length;
87 UINT16 Type;
88 } EFI_HII_PACK_HEADER;
89
90 //
91 // A form list consists of a large variety of structure
92 // possibilities so to represent the binary blob of data
93 // associated with a package of forms, we will assume a
94 // pointer to a self-describing data buffer.
95 //
96 typedef struct {
97 EFI_HII_PACK_HEADER Header;
98 } EFI_HII_IFR_PACK;
99
100 typedef struct {
101 EFI_HII_PACK_HEADER Header; // Must be filled in
102 EFI_HANDLE ImageHandle; // Must be filled in
103 EFI_HANDLE DeviceHandle; // Optional
104 EFI_HANDLE ControllerHandle; // Optional
105 EFI_HANDLE CallbackHandle; // Optional
106 EFI_HANDLE COBExportHandle; // Optional
107 } EFI_HII_HANDLE_PACK;
108
109 //
110 // ********************************************************
111 // EFI_VARIABLE_CONTENTS
112 // ********************************************************
113 //
114 typedef struct {
115 EFI_HII_PACK_HEADER Header;
116 EFI_GUID VariableGuid;
117 UINT32 VariableNameLength;
118 UINT16 VariableId;
119 //
120 // CHAR16 VariableName[]; //Null-terminated
121 //
122 } EFI_HII_VARIABLE_PACK;
123
124 //
125 // ********************************************************
126 // EFI_DEVICE_PATH_PACK
127 // ********************************************************
128 //
129 typedef struct {
130 EFI_HII_PACK_HEADER Header;
131 //
132 // EFI_DEVICE_PATH DevicePath[];
133 //
134 } EFI_HII_DEVICE_PATH_PACK;
135
136 //
137 // ********************************************************
138 // EFI_HII_DATA_TABLE
139 // ********************************************************
140 //
141 typedef struct {
142 EFI_HII_HANDLE HiiHandle;
143 EFI_GUID PackageGuid;
144 UINT32 DataTableSize;
145 UINT32 IfrDataOffset;
146 UINT32 StringDataOffset;
147 UINT32 VariableDataOffset;
148 UINT32 DevicePathOffset;
149 UINT32 NumberOfVariableData;
150 UINT32 NumberOfLanguages;
151 //
152 // EFI_HII_DEVICE_PATH_PACK DevicePath[];
153 // EFI_HII_VARIABLE_PACK VariableData[];
154 // EFI_HII_IFR_PACK IfrData;
155 // EFI_HII_STRING_PACK StringData[];
156 //
157 } EFI_HII_DATA_TABLE;
158
159 //
160 // ********************************************************
161 // EFI_HII_EXPORT_TABLE
162 // ********************************************************
163 //
164 typedef struct {
165 UINT32 NumberOfHiiDataTables;
166 EFI_GUID Revision;
167 //
168 // EFI_HII_DATA_TABLE HiiDataTable[];
169 //
170 } EFI_HII_EXPORT_TABLE;
171
172 typedef struct {
173 BOOLEAN FormSetUpdate; // If TRUE, next variable is significant
174 EFI_PHYSICAL_ADDRESS FormCallbackHandle; // If not 0, will update Formset with this info
175 BOOLEAN FormUpdate; // If TRUE, next variable is significant
176 UINT16 FormValue; // specify which form is to be updated if FormUpdate value is TRUE.
177 STRING_REF FormTitle; // If not 0, will update Form with this info
178 UINT16 DataCount; // The number of Data entries in this structure
179 UINT8 *Data; // An array of 1+ op-codes, specified by DataCount
180 } EFI_HII_UPDATE_DATA;
181
182 //
183 // String attributes
184 //
185 #define LANG_RIGHT_TO_LEFT 0x00000001
186
187 //
188 // A string package is used to localize strings to a particular
189 // language. The package is associated with a particular driver
190 // or set of drivers. Tools are used to associate tokens with
191 // string references in forms and in programs. These tokens are
192 // language agnostic. When paired with a language pack (directly
193 // or indirectly), the string token resolves into an actual
194 // UNICODE string. The NumStringPointers determines how many
195 // StringPointers (offset values) there are as well as the total
196 // number of Strings that are defined.
197 //
198 typedef struct {
199 EFI_HII_PACK_HEADER Header;
200 RELOFST LanguageNameString;
201 RELOFST PrintableLanguageName;
202 UINT32 NumStringPointers;
203 UINT32 Attributes;
204 //
205 // RELOFST StringPointers[];
206 // EFI_STRING Strings[];
207 //
208 } EFI_HII_STRING_PACK;
209
210 //
211 // Glyph Attributes
212 //
213 #define EFI_GLYPH_NON_SPACING 1
214 #define EFI_GLYPH_WIDE 2
215
216 typedef struct {
217 CHAR16 UnicodeWeight;
218 UINT8 Attributes;
219 UINT8 GlyphCol1[GLYPH_HEIGHT];
220 } EFI_NARROW_GLYPH;
221
222 typedef struct {
223 CHAR16 UnicodeWeight;
224 UINT8 Attributes;
225 UINT8 GlyphCol1[GLYPH_HEIGHT];
226 UINT8 GlyphCol2[GLYPH_HEIGHT];
227 UINT8 Pad[3];
228 } EFI_WIDE_GLYPH;
229
230 //
231 // A font list consists of a font header followed by a series
232 // of glyph structures. Note that fonts are not language specific.
233 //
234 typedef struct {
235 EFI_HII_PACK_HEADER Header;
236 UINT16 NumberOfNarrowGlyphs;
237 UINT16 NumberOfWideGlyphs;
238 } EFI_HII_FONT_PACK;
239
240 //
241 // The IfrData in the EFI_HII_IFR_PACK structure definition
242 // is variable length, and not really part of the header. To
243 // simplify from code the size of the header, define an
244 // identical structure that does not include the IfrData field.
245 // Then use sizeof() this new structure to determine the
246 // actual size of the header.
247 //
248 typedef struct {
249 EFI_HII_PACK_HEADER Header;
250 } EFI_HII_IFR_PACK_HEADER;
251
252 //
253 // pedef EFI_HII_PACK_HEADER EFI_HII_IFR_PACK_HEADER;
254 //
255 typedef enum {
256 EfiKeyLCtrl,
257 EfiKeyA0,
258 EfiKeyLAlt,
259 EfiKeySpaceBar,
260 EfiKeyA2,
261 EfiKeyA3,
262 EfiKeyA4,
263 EfiKeyRCtrl,
264 EfiKeyLeftArrow,
265 EfiKeyDownArrow,
266 EfiKeyRightArrow,
267 EfiKeyZero,
268 EfiKeyPeriod,
269 EfiKeyEnter,
270 EfiKeyLShift,
271 EfiKeyB0,
272 EfiKeyB1,
273 EfiKeyB2,
274 EfiKeyB3,
275 EfiKeyB4,
276 EfiKeyB5,
277 EfiKeyB6,
278 EfiKeyB7,
279 EfiKeyB8,
280 EfiKeyB9,
281 EfiKeyB10,
282 EfiKeyRshift,
283 EfiKeyUpArrow,
284 EfiKeyOne,
285 EfiKeyTwo,
286 EfiKeyThree,
287 EfiKeyCapsLock,
288 EfiKeyC1,
289 EfiKeyC2,
290 EfiKeyC3,
291 EfiKeyC4,
292 EfiKeyC5,
293 EfiKeyC6,
294 EfiKeyC7,
295 EfiKeyC8,
296 EfiKeyC9,
297 EfiKeyC10,
298 EfiKeyC11,
299 EfiKeyC12,
300 EfiKeyFour,
301 EfiKeyFive,
302 EfiKeySix,
303 EfiKeyPlus,
304 EfiKeyTab,
305 EfiKeyD1,
306 EfiKeyD2,
307 EfiKeyD3,
308 EfiKeyD4,
309 EfiKeyD5,
310 EfiKeyD6,
311 EfiKeyD7,
312 EfiKeyD8,
313 EfiKeyD9,
314 EfiKeyD10,
315 EfiKeyD11,
316 EfiKeyD12,
317 EfiKeyD13,
318 EfiKeyDel,
319 EfiKeyEnd,
320 EfiKeyPgDn,
321 EfiKeySeven,
322 EfiKeyEight,
323 EfiKeyNine,
324 EfiKeyE0,
325 EfiKeyE1,
326 EfiKeyE2,
327 EfiKeyE3,
328 EfiKeyE4,
329 EfiKeyE5,
330 EfiKeyE6,
331 EfiKeyE7,
332 EfiKeyE8,
333 EfiKeyE9,
334 EfiKeyE10,
335 EfiKeyE11,
336 EfiKeyE12,
337 EfiKeyBackSpace,
338 EfiKeyIns,
339 EfiKeyHome,
340 EfiKeyPgUp,
341 EfiKeyNLck,
342 EfiKeySlash,
343 EfiKeyAsterisk,
344 EfiKeyMinus,
345 EfiKeyEsc,
346 EfiKeyF1,
347 EfiKeyF2,
348 EfiKeyF3,
349 EfiKeyF4,
350 EfiKeyF5,
351 EfiKeyF6,
352 EfiKeyF7,
353 EfiKeyF8,
354 EfiKeyF9,
355 EfiKeyF10,
356 EfiKeyF11,
357 EfiKeyF12,
358 EfiKeyPrint,
359 EfiKeySLck,
360 EfiKeyPause
361 } EFI_KEY;
362
363 typedef struct {
364 EFI_KEY Key;
365 CHAR16 Unicode;
366 CHAR16 ShiftedUnicode;
367 CHAR16 AltGrUnicode;
368 CHAR16 ShiftedAltGrUnicode;
369 UINT16 Modifier;
370 } EFI_KEY_DESCRIPTOR;
371
372 //
373 // This structure allows a sparse set of keys to be redefined
374 // or a complete redefinition of the keyboard layout. Most
375 // keyboards have a lot of commonality in their layouts, therefore
376 // only defining those keys that need to change from the default
377 // minimizes the passed in information.
378 //
379 // Additionally, when an update occurs, the active keyboard layout
380 // will be switched to the newly updated keyboard layout. This
381 // allows for situations that when a keyboard layout driver is
382 // loaded as part of system initialization, the system will default
383 // the keyboard behavior to the new layout.
384 //
385 // Each call to update the keyboard mapping should contain the
386 // complete set of key descriptors to be updated, since every
387 // call to the HII which contains an EFI_HII_KEYBOARD_PACK will
388 // wipe the previous set of overrides. A call to
389 //
390 typedef struct {
391 EFI_HII_PACK_HEADER Header;
392 EFI_KEY_DESCRIPTOR *Descriptor;
393 UINT8 DescriptorCount;
394 } EFI_HII_KEYBOARD_PACK;
395
396 //
397 // The EFI_HII_PACKAGES can contain different types of packages just
398 // after the structure as inline data.
399 //
400 typedef struct {
401 UINTN NumberOfPackages;
402 EFI_GUID *GuidId;
403 //
404 // EFI_HII_HANDLE_PACK *HandlePack; // Only one pack.
405 // EFI_HII_IFR_PACK *IfrPack; // Only one pack.
406 // EFI_HII_FONT_PACK *FontPack[]; // Multiple packs ok
407 // EFI_HII_STRING_PACK *StringPack[]; // Multiple packs ok
408 // EFI_HII_KEYBOARD_PACK *KeyboardPack[]; // Multiple packs ok
409 //
410 } EFI_HII_PACKAGES;
411
412 typedef struct _EFI_HII_VARIABLE_PACK_LIST {
413 struct _EFI_HII_VARIABLE_PACK_LIST *NextVariablePack;
414 EFI_HII_VARIABLE_PACK *VariablePack;
415 } EFI_HII_VARIABLE_PACK_LIST;
416
417
418 #pragma pack()
419
420 /**
421 Registers the various packs that are passed in via the Packages parameter.
422
423 @param This A pointer to the EFI_HII_PROTOCOL instance.
424 @param Packages A pointer to an EFI_HII_PACKAGES package instance.
425 @param Handle A pointer to the EFI_HII_HANDLE instance.
426
427 @retval EFI_SUCCESS Data was extracted from Packages, the database
428 was updated with the data, and Handle returned successfully.
429 @retval EFI_INVALID_PARAMETER The content of Packages was invalid.
430
431 **/
432 typedef
433 EFI_STATUS
434 (EFIAPI *EFI_HII_NEW_PACK) (
435 IN EFI_HII_PROTOCOL *This,
436 IN EFI_HII_PACKAGES *Packages,
437 OUT EFI_HII_HANDLE *Handle
438 );
439
440 /**
441 Removes a package from the HII database.
442
443 @param This A pointer to the EFI_HII_PROTOCOL instance.
444 @param Handle The handle that was registered to the data that is requested
445 for removal.
446
447 @retval EFI_SUCCESS The data associated with the Handle was removed
448 from the HII database.
449 @retval EFI_INVALID_PARAMETER The Handle was not valid.
450
451 **/
452 typedef
453 EFI_STATUS
454 (EFIAPI *EFI_HII_REMOVE_PACK) (
455 IN EFI_HII_PROTOCOL *This,
456 IN EFI_HII_HANDLE Handle
457 );
458
459 /**
460 Determines the handles that are currently active in the database.
461
462 @param This A pointer to the EFI_HII_PROTOCOL instance.
463 @param HandleBufferLength On input, a pointer to the length of the handle
464 buffer. On output, the length of the handle buffer that is required
465 for the handles found.
466 @param Handle An array of EFI_HII_HANDLE instances returned.
467
468 @retval EFI_SUCCESS Handle was updated successfully.
469 @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates
470 that Handle is too small to support the number of handles.
471
472 **/
473 typedef
474 EFI_STATUS
475 (EFIAPI *EFI_HII_FIND_HANDLES) (
476 IN EFI_HII_PROTOCOL *This,
477 IN OUT UINT16 *HandleBufferLength,
478 OUT EFI_HII_HANDLE *Handle
479 );
480
481 /**
482 Exports the contents of the database into a buffer.
483
484 @param This A pointer to the EFI_HII_PROTOCOL instance.
485 @param Handle An EFI_HII_HANDLE that corresponds to the desired
486 handle to export. If the value is 0, the entire database will be exported.
487 In either case, the data will be exported in a format described by the
488 structure definition of EFI_HII_EXPORT_TABLE.
489 @param BufferSize
490 On input, a pointer to the length of the buffer. On output, the length
491 of the buffer that is required for the export data.
492 @param Buffer A pointer to a buffer that will contain the results of the export function.
493
494 @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.
495 @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.
496
497 **/
498 typedef
499 EFI_STATUS
500 (EFIAPI *EFI_HII_EXPORT) (
501 IN EFI_HII_PROTOCOL *This,
502 IN EFI_HII_HANDLE Handle,
503 IN OUT UINTN *BufferSize,
504 OUT VOID *Buffer
505 );
506
507 /**
508 Remove any new strings that were added after the initial string export
509 for this handle.
510
511 @param This A pointer to the EFI_HII_PROTOCOL instance.
512 @param Handle The handle on which the string resides.
513
514 @retval EFI_SUCCESS Remove strings from the handle successfully.
515 @retval EFI_INVALID_PARAMETER The Handle was unknown.
516
517 **/
518 typedef
519 EFI_STATUS
520 (EFIAPI *EFI_HII_RESET_STRINGS) (
521 IN EFI_HII_PROTOCOL *This,
522 IN EFI_HII_HANDLE Handle
523 );
524
525 /**
526 Tests if all of the characters in a string have corresponding font characters.
527
528 @param This A pointer to the EFI_HII_PROTOCOL instance.
529 @param StringToTest A pointer to a Unicode string.
530 @param FirstMissing A pointer to an index into the string. On input,
531 the index of the first character in the StringToTest to examine. On exit,
532 the index of the first character encountered for which a glyph is unavailable.
533 If all glyphs in the string are available, the index is the index of the
534 terminator of the string.
535 @param GlyphBufferSize A pointer to a value. On output, if the function
536 returns EFI_SUCCESS, it contains the amount of memory that is required to
537 store the string's glyph equivalent.
538
539 @retval EFI_SUCCESS All glyphs are available. Note that an empty string
540 always returns this value.
541 @retval EFI_NOT_FOUND A glyph was not found for a character.
542
543 **/
544 typedef
545 EFI_STATUS
546 (EFIAPI *EFI_HII_TEST_STRING) (
547 IN EFI_HII_PROTOCOL *This,
548 IN CHAR16 *StringToTest,
549 IN OUT UINT32 *FirstMissing,
550 OUT UINT32 *GlyphBufferSize
551 );
552
553 /**
554 Translates a Unicode character into the corresponding font glyph.
555
556 @param This A pointer to the EFI_HII_PROTOCOL instance.
557 @param Source A pointer to a Unicode string.
558 @param Index On input, the offset into the string from which to fetch
559 the character.On successful completion, the index is updated to the first
560 character past the character(s) making up the just extracted glyph.
561 @param GlyphBuffer Pointer to an array where the glyphs corresponding
562 to the characters in the source may be stored. GlyphBuffer is assumed
563 to be wide enough to accept a wide glyph character.
564 @param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by
565 this value is filled with the length of the glyph in pixels. It is unchanged
566 if the call was unsuccessful.
567 @param InternalStatus The cell pointed to by this parameter must be
568 initialized to zero prior to invoking the call the first time for any string.
569
570 @retval EFI_SUCCESS It worked.
571 @retval EFI_NOT_FOUND A glyph for a character was not found.
572
573 **/
574 typedef
575 EFI_STATUS
576 (EFIAPI *EFI_HII_GET_GLYPH) (
577 IN EFI_HII_PROTOCOL *This,
578 IN CHAR16 *Source,
579 IN OUT UINT16 *Index,
580 OUT UINT8 **GlyphBuffer,
581 OUT UINT16 *BitWidth,
582 IN OUT UINT32 *InternalStatus
583 );
584
585 /**
586 Translates a glyph into the format required for input to the Universal
587 Graphics Adapter (UGA) Block Transfer (BLT) routines.
588
589 @param This A pointer to the EFI_HII_PROTOCOL instance.
590 @param GlyphBuffer A pointer to the buffer that contains glyph data.
591 @param Foreground The foreground setting requested to be used for the
592 generated BltBuffer data.
593 @param Background The background setting requested to be used for the
594 generated BltBuffer data.
595 @param Count The entry in the BltBuffer upon which to act.
596 @param Width The width in bits of the glyph being converted.
597 @param Height The height in bits of the glyph being converted
598 @param BltBuffer A pointer to the buffer that contains the data that is
599 ready to be used by the UGA BLT routines.
600
601 @retval EFI_SUCCESS It worked.
602 @retval EFI_NOT_FOUND A glyph for a character was not found.
603
604 **/
605 typedef
606 EFI_STATUS
607 (EFIAPI *EFI_HII_GLYPH_TO_BLT) (
608 IN EFI_HII_PROTOCOL *This,
609 IN UINT8 *GlyphBuffer,
610 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,
611 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background,
612 IN UINTN Count,
613 IN UINTN Width,
614 IN UINTN Height,
615 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer
616 );
617
618 /**
619 Allows a new string to be added to an already existing string package.
620
621 @param This A pointer to the EFI_HII_PROTOCOL instance.
622 @param Pointer to a NULL-terminated string containing a single ISO 639-2
623 language identifier, indicating the language in which the string is translated.
624 @param Handle The handle of the language pack to which the string is to be added.
625 @param Reference The identifier of the string to be added. If the reference
626 value is zero, then the string will be assigned a new identifier on that
627 handle for the language specified. Otherwise, the string will be updated
628 with the NewString Value.
629 @param NewString The string to be added.
630
631 @retval EFI_SUCCESS The string was effectively registered.
632 @retval EFI_INVALID_PARAMETER The Handle was unknown.
633
634 **/
635 typedef
636 EFI_STATUS
637 (EFIAPI *EFI_HII_NEW_STRING) (
638 IN EFI_HII_PROTOCOL *This,
639 IN CHAR16 *Language,
640 IN EFI_HII_HANDLE Handle,
641 IN OUT STRING_REF *Reference,
642 IN CHAR16 *NewString
643 );
644
645 /**
646 Allows a program to determine the primary languages that are supported
647 on a given handle.
648
649 @param This A pointer to the EFI_HII_PROTOCOL instance.
650 @param Handle The handle on which the strings reside.
651 @param LanguageString A string allocated by GetPrimaryLanguages() that
652 contains a list of all primary languages registered on the handle.
653
654 @retval EFI_SUCCESS LanguageString was correctly returned.
655 @retval EFI_INVALID_PARAMETER The Handle was unknown.
656
657 **/
658 typedef
659 EFI_STATUS
660 (EFIAPI *EFI_HII_GET_PRI_LANGUAGES) (
661 IN EFI_HII_PROTOCOL *This,
662 IN EFI_HII_HANDLE Handle,
663 OUT EFI_STRING *LanguageString
664 );
665
666 /**
667 Allows a program to determine which secondary languages are supported
668 on a given handle for a given primary language.
669
670 @param This A pointer to the EFI_HII_PROTOCOL instance.
671 @param Handle The handle on which the strings reside.
672 @param PrimaryLanguage Pointer to a NULL-terminated string containing a single
673 ISO 639-2 language identifier, indicating the primary language.
674 @param LanguageString A string allocated by GetSecondaryLanguages()
675 containing a list of all secondary languages registered on the handle.
676
677 @retval EFI_SUCCESS LanguageString was correctly returned.
678 @retval EFI_INVALID_PARAMETER The Handle was unknown.
679
680 **/
681 typedef
682 EFI_STATUS
683 (EFIAPI *EFI_HII_GET_SEC_LANGUAGES) (
684 IN EFI_HII_PROTOCOL *This,
685 IN EFI_HII_HANDLE Handle,
686 IN CHAR16 *PrimaryLanguage,
687 OUT EFI_STRING *LanguageString
688 );
689
690 /**
691 Extracts a string from a package already registered with the EFI HII database.
692
693 @param This A pointer to the EFI_HII_PROTOCOL instance.
694 @param Handle The handle on which the string resides.
695 @param Token The string token assigned to the string.
696 @param Raw If TRUE, the string is returned unedited in the internal
697 storage format described above. If false, the string returned is edited
698 by replacing <cr> with <space> and by removing special characters such
699 as the <wide> prefix.
700 @param LanguageString Pointer to a NULL-terminated string containing a
701 single ISO 639-2 language identifier, indicating the language to print.
702 If the LanguageString is empty (starts with a NULL), the default system
703 language will be used to determine the language.
704 @param BufferLength Length of the StringBuffer.
705 @param StringBuffer The buffer designed to receive the characters in the string.
706
707 @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.
708 @retval EFI_INVALID_PARAMETER The handle or string token is unknown.
709 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to
710 allow the entire string to be stored.
711
712 **/
713 typedef
714 EFI_STATUS
715 (EFIAPI *EFI_HII_GET_STRING) (
716 IN EFI_HII_PROTOCOL *This,
717 IN EFI_HII_HANDLE Handle,
718 IN STRING_REF Token,
719 IN BOOLEAN Raw,
720 IN CHAR16 *LanguageString,
721 IN OUT UINTN *BufferLength,
722 OUT EFI_STRING StringBuffer
723 );
724
725 /**
726 Allows a program to extract a part of a string of not more than a given width.
727
728 @param This A pointer to the EFI_HII_PROTOCOL instance.
729 @param Handle The handle on which the string resides.
730 @param Token The string token assigned to the string.
731 @param Index On input, the offset into the string where the line is to start.
732 On output, the index is updated to point to beyond the last character returned
733 in the call.
734 @param LineWidth The maximum width of the line in units of narrow glyphs.
735 @param LanguageString Pointer to a NULL-terminated string containing a
736 single ISO 639-2 language identifier, indicating the language to print.
737 @param BufferLength Pointer to the length of the StringBuffer.
738 @param StringBuffer The buffer designed to receive the characters in the string.
739
740 @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.
741 @retval EFI_NOT_FOUND The font glyph for at least one of the characters in
742 the string is not in the font database.
743 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
744 to allow the entire string to be stored.
745
746 **/
747 typedef
748 EFI_STATUS
749 (EFIAPI *EFI_HII_GET_LINE) (
750 IN EFI_HII_PROTOCOL *This,
751 IN EFI_HII_HANDLE Handle,
752 IN STRING_REF Token,
753 IN OUT UINT16 *Index,
754 IN UINT16 LineWidth,
755 IN CHAR16 *LanguageString,
756 IN OUT UINT16 *BufferLength,
757 OUT EFI_STRING StringBuffer
758 );
759
760 /**
761 Allows a program to extract a form or form package that has previously
762 been registered with the HII database.
763
764 @param This A pointer to the EFI_HII_PROTOCOL instance.
765 @param Handle Handle on which the form resides.
766 @param FormId The ID of the form to return. If the ID is zero,
767 the entire form package is returned.
768 @param BufferLength On input, the length of the Buffer. On output,
769 the length of the returned buffer,
770 @param Buffer The buffer designed to receive the form(s).
771
772 @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength
773 was updated.
774 @retval EFI_INVALID_PARAMETER The handle is unknown.
775 @retval EFI_NOT_FOUND A form on the requested handle cannot be found with
776 the requested FormId.
777 @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
778 to allow the form to be stored.
779
780 **/
781 typedef
782 EFI_STATUS
783 (EFIAPI *EFI_HII_GET_FORMS) (
784 IN EFI_HII_PROTOCOL *This,
785 IN EFI_HII_HANDLE Handle,
786 IN EFI_FORM_ID FormId,
787 IN OUT UINTN *BufferLength,
788 OUT UINT8 *Buffer
789 );
790
791 /**
792 Extracts the defaults that are associated with a given handle in the HII database.
793
794 @param This A pointer to the EFI_HII_PROTOCOL instance.
795 @param Handle The HII handle from which will have default data retrieved.
796 @param DefaultMask The mask used to specify some type of default override when extracting
797 the default image data.
798 @param VariablePackList A indirect pointer to the first entry of a link list with
799 type EFI_HII_VARIABLE_PACK_LIST.
800
801 @retval EFI_SUCCESS The VariablePackList was populated with the appropriate
802 default setting data.
803 @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).
804 @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle
805 contain invalid data.
806
807 **/
808 typedef
809 EFI_STATUS
810 (EFIAPI *EFI_HII_GET_DEFAULT_IMAGE) (
811 IN EFI_HII_PROTOCOL *This,
812 IN EFI_HII_HANDLE Handle,
813 IN UINTN DefaultMask,
814 OUT EFI_HII_VARIABLE_PACK_LIST **VariablePackList
815 );
816
817 /**
818 Allows the caller to update a form or form package that has previously been
819 registered with the EFI HII database.
820
821 @param This A pointer to the EFI_HII_PROTOCOL instance.
822 @param Handle Handle of the package where the form to be updated resides.
823 @param Label The label inside the form package where the update is to take place.
824 @param AddData If TRUE, adding data at a given Label; otherwise,
825 if FALSE, removing data at a given Label.
826 @param Data The buffer containing the new tags to insert after the Label
827
828 @retval EFI_SUCCESS The form was updated with the new tags.
829 @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not
830 contain an integral number of tags.
831 @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found.
832
833 **/
834 typedef
835 EFI_STATUS
836 (EFIAPI *EFI_HII_UPDATE_FORM) (
837 IN EFI_HII_PROTOCOL *This,
838 IN EFI_HII_HANDLE Handle,
839 IN EFI_FORM_LABEL Label,
840 IN BOOLEAN AddData,
841 IN EFI_HII_UPDATE_DATA *Data
842 );
843
844 /**
845 Retrieves the current keyboard layout.
846
847 @param This A pointer to the EFI_HII_PROTOCOL instance.
848 @param DescriptorCount A pointer to the number of Descriptor entries being
849 described in the keyboard layout being retrieved.
850 @param Descriptor A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR
851 entries. Each entry will reflect the definition of a specific physical key.
852
853 @retval EFI_SUCCESS The keyboard layout was retrieved successfully.
854
855 **/
856 typedef
857 EFI_STATUS
858 (EFIAPI *EFI_HII_GET_KEYBOARD_LAYOUT) (
859 IN EFI_HII_PROTOCOL *This,
860 OUT UINT16 *DescriptorCount,
861 OUT EFI_KEY_DESCRIPTOR *Descriptor
862 );
863
864 /**
865 @par Protocol Description:
866 The HII Protocol manages the HII database, which is a repository for data
867 having to do with fonts, strings, forms, keyboards, and other future human
868 interface items.
869
870 @param NewPack
871 Extracts the various packs from a package list.
872
873 @param RemovePack
874 Removes a package from the HII database.
875
876 @param FindHandles
877 Determines the handles that are currently active in the database.
878
879 @param ExportDatabase
880 Export the entire contents of the database to a buffer.
881
882 @param TestString
883 Tests if all of the characters in a string have corresponding font characters.
884
885 @param GetGlyph
886 Translates a Unicode character into the corresponding font glyph.
887
888 @param GlyphToBlt
889 Converts a glyph value into a format that is ready for a UGA BLT command.
890
891 @param NewString
892 Allows a new string to be added to an already existing string package.
893
894 @param GetPrimaryLanguages
895 Allows a program to determine the primary languages that are supported
896 on a given handle.
897
898 @param GetSecondaryLanguages
899 Allows a program to determine which secondary languages are supported
900 on a given handle for a given primary language.
901
902 @param GetString
903 Extracts a string from a package that is already registered with the
904 EFI HII database.
905
906 @param ResetString
907 Remove any new strings that were added after the initial string export
908 for this handle.
909
910 @param GetLine
911 Allows a program to extract a part of a string of not more than a given width.
912
913 @param GetForms
914 Allows a program to extract a form or form package that has been previously registered.
915
916 @param GetDefaultImage
917 Allows a program to extract the nonvolatile image that represents the default storage image.
918
919 @param UpdateForm
920 Allows a program to update a previously registered form.
921
922 @param GetKeyboardLayout
923 Allows a program to extract the current keyboard layout.
924
925 **/
926 struct _EFI_HII_PROTOCOL {
927 EFI_HII_NEW_PACK NewPack;
928 EFI_HII_REMOVE_PACK RemovePack;
929 EFI_HII_FIND_HANDLES FindHandles;
930 EFI_HII_EXPORT ExportDatabase;
931
932 EFI_HII_TEST_STRING TestString;
933 EFI_HII_GET_GLYPH GetGlyph;
934 EFI_HII_GLYPH_TO_BLT GlyphToBlt;
935
936 EFI_HII_NEW_STRING NewString;
937 EFI_HII_GET_PRI_LANGUAGES GetPrimaryLanguages;
938 EFI_HII_GET_SEC_LANGUAGES GetSecondaryLanguages;
939 EFI_HII_GET_STRING GetString;
940 EFI_HII_RESET_STRINGS ResetStrings;
941 EFI_HII_GET_LINE GetLine;
942 EFI_HII_GET_FORMS GetForms;
943 EFI_HII_GET_DEFAULT_IMAGE GetDefaultImage;
944 EFI_HII_UPDATE_FORM UpdateForm;
945
946 EFI_HII_GET_KEYBOARD_LAYOUT GetKeyboardLayout;
947 };
948
949 extern EFI_GUID gEfiHiiProtocolGuid;
950
951 #endif