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