2 Public include file for the HII Library
4 Copyright (c) 2007 - 2008, 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.
18 ////////////////////////////////////////////////////////
19 ////////////////////////////////////////////////////////
21 ////////////////////////////////////////////////////////
22 ////////////////////////////////////////////////////////
25 Registers a list of packages in the HII Database and returns the HII Handle
26 associated with that registration. If an HII Handle has already been registered
27 with the same PackageListGuid, then NULL is returned. If there are not enough
28 resources to perform the registration, then NULL is returned. If an empty list
29 of packages is passed in, then NULL is returned. If the size of the list of
30 package is 0, then NULL is returned.
32 The variable arguments are pointers which point to package header that defined
33 by UEFI VFR compiler and StringGather tool.
35 #pragma pack (push, 1)
38 EFI_HII_PACKAGE_HEADER PackageHeader;
39 } EDKII_AUTOGEN_PACKAGES_HEADER;
42 @param[in] PackageListGuid The GUID of the package list.
43 @param[in] DeviceHandle If not NULL, the Device Handle on which
44 an instance of DEVICE_PATH_PROTOCOL is installed.
45 This Device Handle uniquely defines the device that
46 the added packages are associated with.
47 @param[in] ... The variable argument list that contains pointers
48 to packages terminated by a NULL.
50 @retval NULL A HII Handle has already been registered in the HII Database with
51 the same PackageListGuid.
52 @retval NULL The HII Handle could not be created.
53 @retval NULL An empty list of packages was passed in.
54 @retval NULL All packages are empty.
55 @retval Other The HII Handle associated with the newly registered package list.
61 IN CONST EFI_GUID
*PackageListGuid
,
62 IN EFI_HANDLE DeviceHandle OPTIONAL
,
68 Removes a package list from the HII database.
70 If HiiHandle is NULL, then ASSERT.
71 If HiiHandle is not a valid EFI_HII_HANDLE in the HII database, then ASSERT.
73 @param[in] HiiHandle The handle that was previously registered in the HII database
79 IN EFI_HII_HANDLE HiiHandle
84 This function create a new string in String Package or updates an existing
85 string in a String Package. If StringId is 0, then a new string is added to
86 a String Package. If StringId is not zero, then a string in String Package is
87 updated. If SupportedLanguages is NULL, then the string is added or updated
88 for all the languages that the String Package supports. If SupportedLanguages
89 is not NULL, then the string is added or updated for the set of languages
90 specified by SupportedLanguages.
92 If HiiHandle is NULL, then ASSERT().
93 If String is NULL, then ASSERT().
95 @param[in] HiiHandle A handle that was previously registered in the
97 @param[in] StringId If zero, then a new string is created in the
98 String Package associated with HiiHandle. If
99 non-zero, then the string specified by StringId
100 is updated in the String Package associated
102 @param[in] String A pointer to the Null-terminated Unicode string
103 to add or update in the String Package associated
105 @param[in] SupportedLanguages A pointer to a Null-terminated ASCII string of
106 language codes. If this parameter is NULL, then
107 String is added or updated in the String Package
108 associated with HiiHandle for all the languages
109 that the String Package supports. If this
110 parameter is not NULL, then then String is added
111 or updated in the String Package associated with
112 HiiHandle for the set oflanguages specified by
113 SupportedLanguages. The format of
114 SupportedLanguages must follow the language
115 format assumed the HII Database.
117 @retval 0 The string could not be added or updated in the String Package.
118 @retval Other The EFI_STRING_ID of the newly added or updated string.
124 IN EFI_HII_HANDLE HiiHandle
,
125 IN EFI_STRING_ID StringId
, OPTIONAL
126 IN CONST EFI_STRING String
,
127 IN CONST CHAR8
*SupportedLanguages OPTIONAL
132 Retrieves a string from a string package in a specific language. If the language
133 is not specified, then a string from a string package in the current platform
134 language is retrieved. If the string can not be retrieved using the specified
135 language or the current platform language, then the string is retrieved from
136 the string package in the first language the string package supports. The
137 returned string is allocated using AllocatePool(). The caller is responsible
138 for freeing the allocated buffer using FreePool().
140 If HiiHandle is NULL, then ASSERT().
141 If StringId is 0, then ASSET.
143 @param[in] HiiHandle A handle that was previously registered in the HII Database.
144 @param[in] StringId The identifier of the string to retrieved from the string
145 package associated with HiiHandle.
146 @param[in] Language The language of the string to retrieve. If this parameter
147 is NULL, then the current platform language is used. The
148 format of Language must follow the language format assumed
151 @retval NULL The string specified by StringId is not present in the string package.
152 @retval Other The string was returned.
158 IN EFI_HII_HANDLE HiiHandle
,
159 IN EFI_STRING_ID StringId
,
160 IN CONST CHAR8
*Language OPTIONAL
165 Retrieves a string from a string package names by GUID in a specific language.
166 If the language is not specified, then a string from a string package in the
167 current platform language is retrieved. If the string can not be retrieved
168 using the specified language or the current platform language, then the string
169 is retrieved from the string package in the first language the string package
170 supports. The returned string is allocated using AllocatePool(). The caller
171 is responsible for freeing the allocated buffer using FreePool().
173 If PackageListGuid is NULL, then ASSERT().
174 If StringId is 0, then ASSERT.
176 @param[in] PackageListGuid The GUID of a package list that was previously
177 registered in the HII Database.
178 @param[in] StringId The identifier of the string to retrieved from the
179 string package associated with PackageListGuid.
180 @param[in] Language The language of the string to retrieve. If this
181 parameter is NULL, then the current platform
182 language is used. The format of Language must
183 follow the language format assumed the HII Database.
185 @retval NULL The package list specified by PackageListGuid is not present in the
187 @retval NULL The string specified by StringId is not present in the string package.
188 @retval Other The string was returned.
193 HiiGetPackageString (
194 IN CONST EFI_GUID
*PackageListGuid
,
195 IN EFI_STRING_ID StringId
,
196 IN CONST CHAR8
*Language OPTIONAL
201 Retrieves the array of all the HII Handles or the HII handle of a specific
202 package list in the HII Database.
203 This array is terminated with a NULL HII Handle.
204 This function allocates the returned array using AllocatePool().
205 The caller is responsible for freeing the array with FreePool().
207 @param[in] PackageListGuid An optional parameter that is used to request
208 an HII Handle that is associatd with a specific
209 Package List GUID. If this parameter is NULL
210 then all the HII Handles in the HII Database
211 are returned. If this parameter is not NULL
212 then at most 1 HII Handle is returned.
214 @retval NULL No HII handles were found in the HII database
215 @retval NULL The array of HII Handles could not be retrieved
216 @retval Other A pointer to the NULL terminated array of HII Handles
222 IN CONST EFI_GUID
*PackageListGuid OPTIONAL
227 Get next language from language code list (with separator ';').
229 If LangCode is NULL, then ASSERT.
230 If Lang is NULL, then ASSERT.
232 @param LangCode On input: point to first language in the list. On
233 output: point to next language in the list, or
234 NULL if no more language in the list.
235 @param Lang The first language in the list.
240 HiiLibGetNextLanguage (
241 IN OUT CHAR8
**LangCode
,
247 Retrieves a pointer to the a Null-terminated ASCII string containing the list
248 of languages that an HII handle in the HII Database supports. The returned
249 string is allocated using AllocatePool(). The caller is responsible for freeing
250 the returned string using FreePool(). The format of the returned string follows
251 the language format assumed the HII Database.
253 If HiiHandle is NULL, then ASSERT().
255 @param[in] HiiHandle A handle that was previously registered in the HII Database.
257 @retval NULL HiiHandle is not registered in the HII database
258 @retval NULL There are not enough resources available to retrieve the suported
260 @retval NULL The list of suported languages could not be retrieved.
261 @retval Other A pointer to the Null-terminated ASCII string of supported languages.
266 HiiGetSupportedLanguages (
267 IN EFI_HII_HANDLE HiiHandle
272 Convert language code from RFC3066 to ISO639-2.
274 LanguageRfc3066 contain a single RFC 3066 code such as
277 The LanguageRfc3066 must be a buffer large enough
278 for ISO_639_2_ENTRY_SIZE characters.
280 If LanguageRfc3066 is NULL, then ASSERT.
281 If LanguageIso639 is NULL, then ASSERT.
283 @param LanguageRfc3066 RFC3066 language code.
284 @param LanguageIso639 ISO639-2 language code.
286 @retval EFI_SUCCESS Language code converted.
287 @retval EFI_NOT_FOUND Language code not found.
292 ConvertRfc3066LanguageToIso639Language (
293 IN CHAR8
*LanguageRfc3066
,
294 OUT CHAR8
*LanguageIso639
299 Convert language code from ISO639-2 to RFC3066 and return the converted language.
300 Caller is responsible for freeing the allocated buffer.
302 LanguageIso639 contain a single ISO639-2 code such as
305 If LanguageIso639 is NULL, then ASSERT.
306 If LanguageRfc3066 is NULL, then ASSERT.
308 @param LanguageIso639 ISO639-2 language code.
310 @return the allocated buffer or NULL, if the language is not found.
315 ConvertIso639LanguageToRfc3066Language (
316 IN CONST CHAR8
*LanguageIso639
321 Convert language code list from RFC3066 to ISO639-2, e.g. "en-US;fr-FR" will
322 be converted to "engfra".
324 If SupportedLanguages is NULL, then ASSERT.
326 @param SupportedLanguages The RFC3066 language list.
328 @return The ISO639-2 language list.
334 CHAR8
*SupportedLanguages
339 Allocates and returns a Null-terminated Unicode <ConfigHdr> string using routing
340 information that includes a GUID, an optional Unicode string name, and a device
341 path. The string returned is allocated with AllocatePool(). The caller is
342 responsible for freeing the allocated string with FreePool().
344 The format of a <ConfigHdr> is as follows:
346 GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize<Null>
348 @param[in] Guid Pointer to an EFI_GUID that is the routing information
349 GUID. Each of the 16 bytes in Guid is converted to
350 a 2 Unicode character hexidecimal string. This is
351 an optional parameter that may be NULL.
352 @param[in] Name Pointer to a Null-terminated Unicode string that is
353 the routing information NAME. This is an optional
354 parameter that may be NULL. Each 16-bit Unicode
355 character in Name is converted to a 4 character Unicode
357 @param[in] DriverHandle The driver handle which supports a Device Path Protocol
358 that is the routing information PATH. Each byte of
359 the Device Path associated with DriverHandle is converted
360 to a 2 Unicode character hexidecimal string.
362 @retval NULL DriverHandle does not support the Device Path Protocol.
363 @retval NULL DriverHandle does not support the Device Path Protocol.
364 @retval Other A pointer to the Null-terminate Unicode <ConfigHdr> string
369 HiiConstructConfigHdr (
370 IN CONST EFI_GUID
*Guid
, OPTIONAL
371 IN CONST CHAR16
*Name
, OPTIONAL
372 IN EFI_HANDLE DriverHandle
376 Allocates and returns a Null-terminated Unicode <ConfigAltResp> string.
378 If Guid is NULL, then ASSERT().
379 If Name is NULL, then ASSERT().
380 If BlockNameArray is NULL, then ASSERT().
382 @param[in] Guid GUID of the buffer storage.
383 @param[in] Name Name of the buffer storage.
384 @param[in] DriverHandle The DriverHandle that support a Device Path
386 @param[in] BufferStorage Content of the buffer storage.
387 @param[in] BufferStorageSize Length in bytes of the buffer storage.
388 @param[in] BlockNameArray Array generated by VFR compiler. This array
389 contains a UINT32 value that is the length
390 of BlockNameArray in bytes, followed by pairs
391 of 16-bit values that are the offset and length
392 values used to contruct a <ConfigRequest> string.
393 @param[in] ... A variable argument list that contains pairs of 16-bit
394 ALTCFG identifiers and pointers to DefaultValueArrays.
395 The variable argument list is terminated by a NULL
396 DefaultValueArray pointer. A DefaultValueArray
397 contains a UINT32 value that is the length, in bytes,
398 of the DefaultValueArray. The UINT32 length value
399 is followed by a series of records that contain
400 a 16-bit WIDTH value followed by a byte array with
401 WIDTH entries. The records must be parsed from
402 beginning to end until the UINT32 length limit
405 @retval NULL There are not enough resources to process the request.
406 @retval NULL A <ConfigResp> could not be retrieved from the Config
408 @retval Other A pointer to the Null-terminate Unicode <ConfigAltResp>
414 HiiConstructConfigAltResp (
415 IN CONST EFI_GUID
*Guid
,
416 IN CONST CHAR16
*Name
,
417 IN EFI_HANDLE DriverHandle
,
418 IN CONST VOID
*BufferStorage
,
419 IN UINTN BufferStorageSize
,
420 IN CONST VOID
*BlockNameArray
,
425 Determines if the routing data specified by GUID and NAME match a <ConfigHdr>.
427 If ConfigHdr is NULL, then ASSERT().
429 @param[in] ConfigHdr Either <ConfigRequest> or <ConfigResp>.
430 @param[in] Guid GUID of the storage.
431 @param[in] Name NAME of the storage.
433 @retval TRUE Routing information matches <ConfigHdr>.
434 @retval FALSE Routing information does not match <ConfigHdr>.
439 HiiIsConfigHdrMatch (
440 IN CONST EFI_STRING ConfigHdr
,
441 IN CONST EFI_GUID
*Guid
, OPTIONAL
442 IN CONST CHAR16
*Name OPTIONAL
446 Retrieves uncommited data from the Form Browser and converts it to a binary
447 buffer. The returned buffer is allocated using AllocatePool(). The caller
448 is responsible for freeing the returned buffer using FreePool().
450 @param[in] VariableName Pointer to a Null-terminated Unicode string. This
451 is an optional parameter that may be NULL.
452 @param[in] VariableGuid Pointer to an EFI_GUID structure. This is an optional
453 parameter that may be NULL.
454 @param[in] BufferSize Length in bytes of buffer to hold retrived data.
456 @retval NULL The uncommitted data could not be retrieved.
457 @retval Other A pointer to a buffer containing the uncommitted data.
463 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
464 IN CONST CHAR16
*VariableName
, OPTIONAL
469 Updates uncommitted data in the Form Browser.
471 If Buffer is NULL, then ASSERT().
473 @param[in] VariableName Pointer to a Null-terminated Unicode string. This
474 is an optional parameter that may be NULL.
475 @param[in] VariableGuid Pointer to an EFI_GUID structure. This is an optional
476 parameter that may be NULL.
477 @param[in] BufferSize Length, in bytes, of Buffer.
478 @param[in] Buffer Buffer of data to commit.
479 @param[in] RequestElement An optional field to specify which part of the
480 buffer data will be send back to Browser. If NULL,
481 the whole buffer of data will be committed to
483 <RequestElement> ::= &OFFSET=<Number>&WIDTH=<Number>*
485 @retval FALSE The uncommitted data could not be updated.
486 @retval TRUE The uncommitted data was updated.
492 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
493 IN CONST CHAR16
*VariableName
, OPTIONAL
495 IN CONST UINT8
*Buffer
,
496 IN CONST CHAR16
*RequestElement OPTIONAL
499 /////////////////////////////////////////
500 /////////////////////////////////////////
502 /////////////////////////////////////////
503 /////////////////////////////////////////
506 Returns a UINT64 value that contains bitfields for Hour, Minute, and Second.
507 The lower 8-bits of Hour are placed in bits 0..7. The lower 8-bits of Minute
508 are placed in bits 8..15, and the lower 8-bits of Second are placed in bits
509 16..23. This format is selected because it can be easily translated to
510 an EFI_HII_TIME structure in an EFI_IFR_TYPE_VALUE union.
512 @param Hour The hour value to be encoded.
513 @param Minute The miniute value to be encoded.
514 @param Second The second value to be encoded.
516 @return A 64-bit containing Hour, Minute, and Second.
518 #define EFI_HII_TIME_UINT64(Hour, Minute, Second) \
519 (UINT64)((Hour & 0xff) | ((Minute & 0xff) << 8) | ((Second & 0xff) << 16))
522 Returns a UINT64 value that contains bitfields for Year, Month, and Day.
523 The lower 16-bits of Year are placed in bits 0..15. The lower 8-bits of Month
524 are placed in bits 16..23, and the lower 8-bits of Day are placed in bits
525 24..31. This format is selected because it can be easily translated to
526 an EFI_HII_DATE structure in an EFI_IFR_TYPE_VALUE union.
528 @param Year The year value to be encoded.
529 @param Month The month value to be encoded.
530 @param Day The day value to be encoded.
532 @return A 64-bit containing Year, Month, and Day.
534 #define EFI_HII_DATE_UINT64(Year, Month, Day) \
535 (UINT64)((Year & 0xffff) | ((Month & 0xff) << 16) | ((Day & 0xff) << 24))
538 Allocates and returns a new OpCode Handle. OpCode Handles must be freed with
539 HiiFreeOpCodeHandle().
541 @retval NULL There are not enough resources to allocate a new OpCode Handle.
542 @retval Other A new OpCode handle.
547 HiiAllocateOpCodeHandle (
552 Frees an OpCode Handle that was peviously allocated with HiiAllocateOpCodeHandle().
553 When an OpCode Handle is freed, all of the opcodes associated with the OpCode
554 Handle are also freed.
556 If OpCodeHandle is NULL, then ASSERT().
561 HiiFreeOpCodeHandle (
566 Create EFI_IFR_END_OP opcode.
568 If OpCodeHandle is NULL, then ASSERT().
570 @param[in] OpCodeHandle Handle to the buffer of opcodes.
572 @retval NULL There is not enough space left in Buffer to add the opcode.
573 @retval Other A pointer to the created opcode.
579 IN VOID
*OpCodeHandle
583 Create EFI_IFR_ONE_OF_OPTION_OP opcode.
585 If OpCodeHandle is NULL, then ASSERT().
586 If Type is invalid, then ASSERT().
587 If Flags is invalid, then ASSERT().
589 @param[in] OpCodeHandle Handle to the buffer of opcodes.
590 @param[in] StringId StringId for the option
591 @param[in] Flags Flags for the option
592 @param[in] Type Type for the option
593 @param[in] Value Value for the option
595 @retval NULL There is not enough space left in Buffer to add the opcode.
596 @retval Other A pointer to the created opcode.
601 HiiCreateOneOfOptionOpCode (
602 IN VOID
*OpCodeHandle
,
610 Create EFI_IFR_DEFAULT_OP opcode.
612 If OpCodeHandle is NULL, then ASSERT().
613 If Type is invalid, then ASSERT().
615 @param[in] OpCodeHandle Handle to the buffer of opcodes.
616 @param[in] DefaultId DefaultId for the default
617 @param[in] Type Type for the default
618 @param[in] Value Value for the default
620 @retval NULL There is not enough space left in Buffer to add the opcode.
621 @retval Other A pointer to the created opcode.
626 HiiCreateDefaultOpCode (
627 IN VOID
*OpCodeHandle
,
634 Create EFI_IFR_GUID opcode.
636 If OpCodeHandle is NULL, then ASSERT().
637 If Guid is NULL, then ASSERT().
638 If OpCodeSize < sizeof (EFI_IFR_GUID), then ASSERT().
640 @param[in] OpCodeHandle Handle to the buffer of opcodes.
641 @param[in] Guid Pointer to EFI_GUID of this guided opcode.
642 @param[in] GuidOpCode Pointer to an EFI_IFR_GUID opcode. This is an
643 optional parameter that may be NULL. If this
644 parameter is NULL, then the GUID extension
645 region of the created opcode is filled with zeros.
646 If this parameter is not NULL, then the GUID
647 extension region of GuidData will be copied to
648 the GUID extension region of the created opcode.
649 @param[in] OpCodeSize The size, in bytes, of created opcode. This value
650 must be >= sizeof(EFI_IFR_GUID).
652 @retval NULL There is not enough space left in Buffer to add the opcode.
653 @retval Other A pointer to the created opcode.
658 HiiCreateGuidOpCode (
659 IN VOID
*OpCodeHandle
,
660 IN CONST EFI_GUID
*Guid
,
661 IN CONST VOID
*GuidOpCode
, OPTIONAL
666 Create EFI_IFR_ACTION_OP opcode.
668 If OpCodeHandle is NULL, then ASSERT().
669 If any reserved bits are set in QuestionFlags, then ASSERT().
671 @param[in] OpCodeHandle Handle to the buffer of opcodes.
672 @param[in] QuestionId Question ID
673 @param[in] Prompt String ID for Prompt
674 @param[in] Help String ID for Help
675 @param[in] QuestionFlags Flags in Question Header
676 @param[in] QuestionConfig String ID for configuration
678 @retval NULL There is not enough space left in Buffer to add the opcode.
679 @retval Other A pointer to the created opcode.
684 HiiCreateActionOpCode (
685 IN VOID
*OpCodeHandle
,
686 IN EFI_QUESTION_ID QuestionId
,
687 IN EFI_STRING_ID Prompt
,
688 IN EFI_STRING_ID Help
,
689 IN UINT8 QuestionFlags
,
690 IN EFI_STRING_ID QuestionConfig
694 Create EFI_IFR_SUBTITLE_OP opcode.
696 If OpCodeHandle is NULL, then ASSERT().
697 If any reserved bits are set in Flags, then ASSERT().
698 If Scope > 1, then ASSERT().
700 @param[in] OpCodeHandle Handle to the buffer of opcodes.
701 @param[in] Prompt String ID for Prompt
702 @param[in] Help String ID for Help
703 @param[in] Flags Subtitle opcode flags
704 @param[in] Scope 1 if this opcpde is the beginning of a new scope.
705 0 if this opcode is within the current scope.
707 @retval NULL There is not enough space left in Buffer to add the opcode.
708 @retval Other A pointer to the created opcode.
713 HiiCreateSubTitleOpCode (
714 IN VOID
*OpCodeHandle
,
715 IN EFI_STRING_ID Prompt
,
716 IN EFI_STRING_ID Help
,
722 Create EFI_IFR_REF_OP opcode.
724 If OpCodeHandle is NULL, then ASSERT().
725 If any reserved bits are set in QuestionFlags, then ASSERT().
727 @param[in] OpCodeHandle Handle to the buffer of opcodes.
728 @param[in] FormId Destination Form ID
729 @param[in] Prompt String ID for Prompt
730 @param[in] Help String ID for Help
731 @param[in] QuestionFlags Flags in Question Header
732 @param[in] QuestionId Question ID
734 @retval NULL There is not enough space left in Buffer to add the opcode.
735 @retval Other A pointer to the created opcode.
740 HiiCreateGotoOpCode (
741 IN VOID
*OpCodeHandle
,
742 IN EFI_FORM_ID FormId
,
743 IN EFI_STRING_ID Prompt
,
744 IN EFI_STRING_ID Help
,
745 IN UINT8 QuestionFlags
,
746 IN EFI_QUESTION_ID QuestionId
750 Create EFI_IFR_CHECKBOX_OP opcode.
752 If OpCodeHandle is NULL, then ASSERT().
753 If any reserved bits are set in QuestionFlags, then ASSERT().
754 If any reserved bits are set in CheckBoxFlags, then ASSERT().
756 @param[in] OpCodeHandle Handle to the buffer of opcodes.
757 @param[in] QuestionId Question ID
758 @param[in] VarStoreId Storage ID
759 @param[in] VarOffset Offset in Storage
760 @param[in] Prompt String ID for Prompt
761 @param[in] Help String ID for Help
762 @param[in] QuestionFlags Flags in Question Header
763 @param[in] CheckBoxFlags Flags for checkbox opcode
764 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
765 is an optional parameter that may be NULL.
767 @retval NULL There is not enough space left in Buffer to add the opcode.
768 @retval Other A pointer to the created opcode.
773 HiiCreateCheckBoxOpCode (
774 IN VOID
*OpCodeHandle
,
775 IN EFI_QUESTION_ID QuestionId
,
776 IN EFI_VARSTORE_ID VarStoreId
,
778 IN EFI_STRING_ID Prompt
,
779 IN EFI_STRING_ID Help
,
780 IN UINT8 QuestionFlags
,
781 IN UINT8 CheckBoxFlags
,
782 IN VOID
*DefaultsOpCodeHandle OPTIONAL
786 Create EFI_IFR_NUMERIC_OP opcode.
788 If OpCodeHandle is NULL, then ASSERT().
789 If any reserved bits are set in QuestionFlags, then ASSERT().
790 If any reserved bits are set in NumericFlags, then ASSERT().
792 @param[in] OpCodeHandle Handle to the buffer of opcodes.
793 @param[in] QuestionId Question ID
794 @param[in] VarStoreId Storage ID
795 @param[in] VarOffset Offset in Storage
796 @param[in] Prompt String ID for Prompt
797 @param[in] Help String ID for Help
798 @param[in] QuestionFlags Flags in Question Header
799 @param[in] NumericFlags Flags for numeric opcode
800 @param[in] Minimum Numeric minimum value
801 @param[in] Maximum Numeric maximum value
802 @param[in] Step Numeric step for edit
803 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
804 is an optional parameter that may be NULL.
806 @retval NULL There is not enough space left in Buffer to add the opcode.
807 @retval Other A pointer to the created opcode.
812 HiiCreateNumericOpCode (
813 IN VOID
*OpCodeHandle
,
814 IN EFI_QUESTION_ID QuestionId
,
815 IN EFI_VARSTORE_ID VarStoreId
,
817 IN EFI_STRING_ID Prompt
,
818 IN EFI_STRING_ID Help
,
819 IN UINT8 QuestionFlags
,
820 IN UINT8 NumericFlags
,
824 IN VOID
*DefaultsOpCodeHandle OPTIONAL
828 Create EFI_IFR_STRING_OP opcode.
830 If OpCodeHandle is NULL, then ASSERT().
831 If any reserved bits are set in QuestionFlags, then ASSERT().
832 If any reserved bits are set in StringFlags, then ASSERT().
834 @param[in] OpCodeHandle Handle to the buffer of opcodes.
835 @param[in] QuestionId Question ID
836 @param[in] VarStoreId Storage ID
837 @param[in] VarOffset Offset in Storage
838 @param[in] Prompt String ID for Prompt
839 @param[in] Help String ID for Help
840 @param[in] QuestionFlags Flags in Question Header
841 @param[in] StringFlags Flags for string opcode
842 @param[in] MinSize String minimum length
843 @param[in] MaxSize String maximum length
844 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
845 is an optional parameter that may be NULL.
847 @retval NULL There is not enough space left in Buffer to add the opcode.
848 @retval Other A pointer to the created opcode.
853 HiiCreateStringOpCode (
854 IN VOID
*OpCodeHandle
,
855 IN EFI_QUESTION_ID QuestionId
,
856 IN EFI_VARSTORE_ID VarStoreId
,
858 IN EFI_STRING_ID Prompt
,
859 IN EFI_STRING_ID Help
,
860 IN UINT8 QuestionFlags
,
861 IN UINT8 StringFlags
,
864 IN VOID
*DefaultsOpCodeHandle OPTIONAL
868 Create EFI_IFR_ONE_OF_OP opcode.
870 If OpCodeHandle is NULL, then ASSERT().
871 If any reserved bits are set in QuestionFlags, then ASSERT().
872 If any reserved bits are set in OneOfFlags, then ASSERT().
874 @param[in] OpCodeHandle Handle to the buffer of opcodes.
875 @param[in] QuestionId Question ID
876 @param[in] VarStoreId Storage ID
877 @param[in] VarOffset Offset in Storage
878 @param[in] Prompt String ID for Prompt
879 @param[in] Help String ID for Help
880 @param[in] QuestionFlags Flags in Question Header
881 @param[in] OneOfFlags Flags for oneof opcode
882 @param[in] OptionsOpCodeHandle Handle for a buffer of ONE_OF_OPTION opcodes.
883 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
884 is an optional parameter that may be NULL.
886 @retval NULL There is not enough space left in Buffer to add the opcode.
887 @retval Other A pointer to the created opcode.
892 HiiCreateOneOfOpCode (
893 IN VOID
*OpCodeHandle
,
894 IN EFI_QUESTION_ID QuestionId
,
895 IN EFI_VARSTORE_ID VarStoreId
,
897 IN EFI_STRING_ID Prompt
,
898 IN EFI_STRING_ID Help
,
899 IN UINT8 QuestionFlags
,
901 IN VOID
*OptionsOpCodeHandle
,
902 IN VOID
*DefaultsOpCodeHandle OPTIONAL
906 Create EFI_IFR_ORDERED_LIST_OP opcode.
908 If OpCodeHandle is NULL, then ASSERT().
909 If any reserved bits are set in QuestionFlags, then ASSERT().
910 If any reserved bits are set in OrderedListFlags, then ASSERT().
912 @param[in] OpCodeHandle Handle to the buffer of opcodes.
913 @param[in] QuestionId Question ID
914 @param[in] VarStoreId Storage ID
915 @param[in] VarOffset Offset in Storage
916 @param[in] Prompt String ID for Prompt
917 @param[in] Help String ID for Help
918 @param[in] QuestionFlags Flags in Question Header
919 @param[in] OrderedListFlags Flags for ordered list opcode
920 @param[in] DataType Type for option value
921 @param[in] MaxContainers Maximum count for options in this ordered list
922 @param[in] OptionsOpCodeHandle Handle for a buffer of ONE_OF_OPTION opcodes.
923 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
924 is an optional parameter that may be NULL.
926 @retval NULL There is not enough space left in Buffer to add the opcode.
927 @retval Other A pointer to the created opcode.
932 HiiCreateOrderedListOpCode (
933 IN VOID
*OpCodeHandle
,
934 IN EFI_QUESTION_ID QuestionId
,
935 IN EFI_VARSTORE_ID VarStoreId
,
937 IN EFI_STRING_ID Prompt
,
938 IN EFI_STRING_ID Help
,
939 IN UINT8 QuestionFlags
,
940 IN UINT8 OrderedListFlags
,
942 IN UINT8 MaxContainers
,
943 IN VOID
*OptionsOpCodeHandle
,
944 IN VOID
*DefaultsOpCodeHandle OPTIONAL
948 This function updates a form that has previously been registered with the HII
949 Database. This function will perform at most one update operation.
951 The form to update is specified by Handle, FormSetGuid, and FormId. Binary
952 comparisons of IFR opcodes are performed from the beginning of the form being
953 updated until an IFR opcode is found that exactly matches the first IFR opcode
954 specifed by StartOpCodeHandle. The following rules are used to determine if
955 an insert, replace, or delete operation is performed.
957 1) If no matches are found, then NULL is returned.
958 2) If a match is found, and EndOpCodeHandle is NULL, then all of the IFR opcodes
959 from StartOpcodeHandle except the first opcode are inserted immediately after
960 the matching IFR opcode in the form beng updated.
961 3) If a match is found, and EndOpCodeHandle is not NULL, then a search is made
962 from the matching IFR opcode until an IFR opcode exatly matches the first
963 IFR opcode specified by EndOpCodeHandle. If no match is found for the first
964 IFR opcode specified by EndOpCodeHandle, then NULL is returned. If a match
965 is found, then all of the IFR opcodes between the start match and the end
966 match are deleted from the form being updated and all of the IFR opcodes
967 from StartOpcodeHandle except the first opcode are inserted immediately after
968 the matching start IFR opcode. If StartOpCcodeHandle only contains one
969 IFR instruction, then the result of ths operation will delete all of the IFR
970 opcodes between the start end matches.
972 If HiiHandle is NULL, then ASSERT().
973 If StartOpCodeHandle is NULL, then ASSERT().
975 @param[in] HiiHandle The HII Handle of the form to update.
976 @param[in] FormSetGuid The Formset GUID of the form to update. This
977 is an optional parameter that may be NULL.
978 If it is NULL, all FormSet will be updated.
979 @param[in] FormId The ID of the form to update.
980 @param[in] StartOpCodeHandle An OpCode Handle that contains the set of IFR
981 opcodes to be inserted or replaced in the form.
982 The first IFR instruction in StartOpCodeHandle
983 is used to find matching IFR opcode in the
985 @param[in] EndOpCodeHandle An OpCcode Handle that contains the IFR opcode
986 that marks the end of a replace operation in
987 the form. This is an optional parameter that
988 may be NULL. If it is NULL, then an the IFR
989 opcodes specified by StartOpCodeHandle are
990 inserted into the form.
992 @retval EFI_OUT_OF_RESOURCES No enough memory resource is allocated.
993 @retval EFI_NOT_FOUND The following cases will return EFI_NOT_FOUND.
994 1) The form specified by HiiHandle, FormSetGuid,
995 and FormId could not be found in the HII Database.
996 2) No IFR opcodes in the target form match the first
997 IFR opcode in StartOpCodeHandle.
998 3) EndOpCOde is not NULL, and no IFR opcodes in the
999 target form following a matching start opcode match
1000 the first IFR opcode in EndOpCodeHandle.
1001 @retval EFI_SUCCESS The matched form is updated by StartOpcode.
1007 IN EFI_HII_HANDLE HiiHandle
,
1008 IN EFI_GUID
*FormSetGuid
, OPTIONAL
1009 IN EFI_FORM_ID FormId
,
1010 IN VOID
*StartOpcodeHandle
,
1011 IN VOID
*EndOpcodeHandle OPTIONAL
1015 Configure the buffer accrording to ConfigBody strings in the format of
1016 <Length:4 bytes>, <Offset: 2 bytes>, <Width:2 bytes>, <Data:n bytes>.
1017 This ConfigBody strings is generated by EDKII UEFI VfrCompiler for the default
1018 values in a Form Set. The name of the ConfigBody strings is VfrMyIfrNVDataDefault0000
1019 constructed following this rule:
1020 "Vfr" + varstore.name + "Default" + defaultstore.attributes.
1021 Check the generated C file in Output for details.
1023 @param Buffer the start address of buffer.
1024 @param BufferSize the size of buffer.
1025 @param Number the number of the ConfigBody strings.
1026 @param ... the ConfigBody strings
1028 @retval EFI_BUFFER_TOO_SMALL the BufferSize is too small to operate.
1029 @retval EFI_INVALID_PARAMETER Buffer is NULL or BufferSize is 0.
1030 @retval EFI_SUCCESS Operation successful.
1035 HiiIfrLibExtractDefault(
1037 IN UINTN
*BufferSize
,