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