2 This library contains functions to do IFR opcode creation and utility functions
3 to help module to interact with a UEFI Form Browser.
5 Copyright (c) 2007 - 2008, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef _IFR_SUPPORT_LIBRARY_H_
17 #define _IFR_SUPPORT_LIBRARY_H_
20 #include <Protocol/HiiFont.h>
21 #include <Protocol/HiiImage.h>
22 #include <Protocol/HiiString.h>
23 #include <Protocol/HiiDatabase.h>
24 #include <Protocol/HiiConfigRouting.h>
25 #include <Protocol/HiiConfigAccess.h>
26 #include <Protocol/FormBrowser2.h>
27 #include <Protocol/SimpleTextOut.h>
29 #include <Guid/GlobalVariable.h>
32 // The architectural variable "Lang" and "LangCodes" are deprecated in UEFI
33 // specification. While, UEFI specification also states that these deprecated
34 // variables may be provided for backwards compatibility.
36 #define EFI_LANGUAGE_VARIABLE L"Lang"
37 #define EFI_LANGUAGE_CODES_VARIABLE L"LangCodes"
39 #define UEFI_LANGUAGE_VARIABLE L"PlatformLang"
40 #define UEFI_LANGUAGE_CODES_VARIABLE L"PlatformLangCodes"
42 #define INVALID_VARSTORE_ID 0
44 #define QUESTION_FLAGS (EFI_IFR_FLAG_READ_ONLY | EFI_IFR_FLAG_CALLBACK | EFI_IFR_FLAG_RESET_REQUIRED | EFI_IFR_FLAG_OPTIONS_ONLY)
45 #define QUESTION_FLAGS_MASK (~QUESTION_FLAGS)
49 EFI_STRING_ID StringToken
;
50 EFI_IFR_TYPE_VALUE Value
;
57 /// Buffer size allocated for Data.
62 /// Offset in Data to append the newly created opcode binary.
63 /// It will be adjusted automatically in Create***OpCode(), and should be
64 /// initialized to 0 before invocation of a serial of Create***OpCode()
69 /// The destination buffer for created op-codes
72 } EFI_HII_UPDATE_DATA
;
76 Create EFI_IFR_END_OP opcode.
78 If Data is NULL or Data->Data is NULL, then ASSERT.
80 @param Data Destination for the created opcode binary
82 @retval EFI_SUCCESS Opcode is created successfully.
83 @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
89 IN OUT EFI_HII_UPDATE_DATA
*Data
94 Create EFI_IFR_DEFAULT_OP opcode.
96 If Data is NULL or Data->Data is NULL, then ASSERT.
98 @param Value Value for the default
99 @param Type Type for the default
100 @param Data Destination for the created opcode binary
102 @retval EFI_SUCCESS Opcode is created successfully.
103 @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
104 @retval EFI_INVALID_PARAMETER The type is not valid.
109 CreateDefaultOpCode (
110 IN EFI_IFR_TYPE_VALUE
*Value
,
112 IN OUT EFI_HII_UPDATE_DATA
*Data
117 Create EFI_IFR_ACTION_OP opcode.
119 If Data is NULL or Data->Data is NULL, then ASSERT.
121 @param QuestionId Question ID
122 @param Prompt String ID for Prompt
123 @param Help String ID for Help
124 @param QuestionFlags Flags in Question Header
125 @param QuestionConfig String ID for configuration
126 @param Data Destination for the created opcode binary
128 @retval EFI_SUCCESS Opcode is created successfully.
129 @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
130 @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
136 IN EFI_QUESTION_ID QuestionId
,
137 IN EFI_STRING_ID Prompt
,
138 IN EFI_STRING_ID Help
,
139 IN UINT8 QuestionFlags
,
140 IN EFI_STRING_ID QuestionConfig
,
141 IN OUT EFI_HII_UPDATE_DATA
*Data
146 Create EFI_IFR_SUBTITLE_OP opcode.
148 If Data is NULL or Data->Data is NULL, then ASSERT.
150 @param Prompt String ID for Prompt
151 @param Help String ID for Help
152 @param Flags Subtitle opcode flags
153 @param Scope Subtitle Scope bit
154 @param Data Destination for the created opcode binary
156 @retval EFI_SUCCESS Opcode is created successfully.
157 @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
162 CreateSubTitleOpCode (
163 IN EFI_STRING_ID Prompt
,
164 IN EFI_STRING_ID Help
,
167 IN OUT EFI_HII_UPDATE_DATA
*Data
172 Create EFI_IFR_TEXT_OP opcode.
174 If Data is NULL or Data->Data is NULL, then ASSERT.
176 @param Prompt String ID for Prompt
177 @param Help String ID for Help
178 @param TextTwo String ID for text two
179 @param Data Destination for the created opcode binary
181 @retval EFI_SUCCESS Opcode is created successfully.
182 @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
188 IN EFI_STRING_ID Prompt
,
189 IN EFI_STRING_ID Help
,
190 IN EFI_STRING_ID TextTwo
,
191 IN OUT EFI_HII_UPDATE_DATA
*Data
196 Create EFI_IFR_REF_OP opcode.
198 If Data is NULL or Data->Data is NULL, then ASSERT.
200 @param FormId Destination Form ID
201 @param Prompt String ID for Prompt
202 @param Help String ID for Help
203 @param QuestionFlags Flags in Question Header
204 @param QuestionId Question ID
205 @param Data Destination for the created opcode binary
207 @retval EFI_SUCCESS Opcode is created successfully.
208 @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
209 @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
215 IN EFI_FORM_ID FormId
,
216 IN EFI_STRING_ID Prompt
,
217 IN EFI_STRING_ID Help
,
218 IN UINT8 QuestionFlags
,
219 IN EFI_QUESTION_ID QuestionId
,
220 IN OUT EFI_HII_UPDATE_DATA
*Data
225 Create EFI_IFR_ONE_OF_OPTION_OP opcode.
227 If Data is NULL or Data->Data is NULL, then ASSERT.
229 @param OptionCount The number of options.
230 @param OptionsList The list of Options.
231 @param Type The data type.
232 @param Data Destination for the created opcode binary
234 @retval EFI_SUCCESS Opcode is created successfully.
235 @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
236 @retval EFI_INVALID_PARAMETER If OptionCount is not zero but OptionsList is NULL.
241 CreateOneOfOptionOpCode (
242 IN UINTN OptionCount
,
243 IN IFR_OPTION
*OptionsList
,
245 IN OUT EFI_HII_UPDATE_DATA
*Data
250 Create EFI_IFR_ONE_OF_OP opcode.
252 If Data is NULL or Data->Data is NULL, then ASSERT.
254 @param QuestionId Question ID
255 @param VarStoreId Storage ID
256 @param VarOffset Offset in Storage
257 @param Prompt String ID for Prompt
258 @param Help String ID for Help
259 @param QuestionFlags Flags in Question Header
260 @param OneOfFlags Flags for oneof opcode
261 @param OptionsList List of options
262 @param OptionCount Number of options in option list
263 @param Data Destination for the created opcode binary
265 @retval EFI_SUCCESS Opcode is created successfully.
266 @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
267 @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
273 IN EFI_QUESTION_ID QuestionId
,
274 IN EFI_VARSTORE_ID VarStoreId
,
276 IN EFI_STRING_ID Prompt
,
277 IN EFI_STRING_ID Help
,
278 IN UINT8 QuestionFlags
,
280 IN IFR_OPTION
*OptionsList
,
281 IN UINTN OptionCount
,
282 IN OUT EFI_HII_UPDATE_DATA
*Data
287 Create EFI_IFR_ORDERED_LIST_OP opcode.
289 If Data is NULL or Data->Data is NULL, then ASSERT.
291 @param QuestionId Question ID
292 @param VarStoreId Storage ID
293 @param VarOffset Offset in Storage
294 @param Prompt String ID for Prompt
295 @param Help String ID for Help
296 @param QuestionFlags Flags in Question Header
297 @param OrderedListFlags Flags for ordered list opcode
298 @param DataType Type for option value
299 @param MaxContainers Maximum count for options in this ordered list
300 @param OptionsList List of options
301 @param OptionCount Number of options in option list
302 @param Data Destination for the created opcode binary
304 @retval EFI_SUCCESS Opcode is created successfully.
305 @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
306 @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
311 CreateOrderedListOpCode (
312 IN EFI_QUESTION_ID QuestionId
,
313 IN EFI_VARSTORE_ID VarStoreId
,
315 IN EFI_STRING_ID Prompt
,
316 IN EFI_STRING_ID Help
,
317 IN UINT8 QuestionFlags
,
318 IN UINT8 OrderedListFlags
,
320 IN UINT8 MaxContainers
,
321 IN IFR_OPTION
*OptionsList
,
322 IN UINTN OptionCount
,
323 IN OUT EFI_HII_UPDATE_DATA
*Data
328 Create EFI_IFR_CHECKBOX_OP opcode.
330 If Data is NULL or Data->Data is NULL, then ASSERT.
332 @param QuestionId Question ID
333 @param VarStoreId Storage ID
334 @param VarOffset Offset in Storage
335 @param Prompt String ID for Prompt
336 @param Help String ID for Help
337 @param QuestionFlags Flags in Question Header
338 @param CheckBoxFlags Flags for checkbox opcode
339 @param Data Destination for the created opcode binary
341 @retval EFI_SUCCESS Opcode is created successfully.
342 @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
343 @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
348 CreateCheckBoxOpCode (
349 IN EFI_QUESTION_ID QuestionId
,
350 IN EFI_VARSTORE_ID VarStoreId
,
352 IN EFI_STRING_ID Prompt
,
353 IN EFI_STRING_ID Help
,
354 IN UINT8 QuestionFlags
,
355 IN UINT8 CheckBoxFlags
,
356 IN OUT EFI_HII_UPDATE_DATA
*Data
361 Create EFI_IFR_NUMERIC_OP opcode.
363 If Data is NULL or Data->Data is NULL, then ASSERT.
365 @param QuestionId Question ID
366 @param VarStoreId Storage ID
367 @param VarOffset Offset in Storage
368 @param Prompt String ID for Prompt
369 @param Help String ID for Help
370 @param QuestionFlags Flags in Question Header
371 @param NumericFlags Flags for numeric opcode
372 @param Minimum Numeric minimum value
373 @param Maximum Numeric maximum value
374 @param Step Numeric step for edit
375 @param Default Numeric default value
376 @param Data Destination for the created opcode binary
378 @retval EFI_SUCCESS Opcode is created successfully.
379 @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
380 @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
385 CreateNumericOpCode (
386 IN EFI_QUESTION_ID QuestionId
,
387 IN EFI_VARSTORE_ID VarStoreId
,
389 IN EFI_STRING_ID Prompt
,
390 IN EFI_STRING_ID Help
,
391 IN UINT8 QuestionFlags
,
392 IN UINT8 NumericFlags
,
397 IN OUT EFI_HII_UPDATE_DATA
*Data
402 Create EFI_IFR_STRING_OP opcode.
404 If Data is NULL or Data->Data is NULL, then ASSERT.
406 @param QuestionId Question ID
407 @param VarStoreId Storage ID
408 @param VarOffset Offset in Storage
409 @param Prompt String ID for Prompt
410 @param Help String ID for Help
411 @param QuestionFlags Flags in Question Header
412 @param StringFlags Flags for string opcode
413 @param MinSize String minimum length
414 @param MaxSize String maximum length
415 @param Data Destination for the created opcode binary
417 @retval EFI_SUCCESS Opcode is created successfully.
418 @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
419 @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
425 IN EFI_QUESTION_ID QuestionId
,
426 IN EFI_VARSTORE_ID VarStoreId
,
428 IN EFI_STRING_ID Prompt
,
429 IN EFI_STRING_ID Help
,
430 IN UINT8 QuestionFlags
,
431 IN UINT8 StringFlags
,
434 IN OUT EFI_HII_UPDATE_DATA
*Data
439 Converts the unicode character of the string from uppercase to lowercase.
441 @param Str String to be converted
453 Converts binary buffer to a Unicode string. The byte buffer is in a reversed byte order
454 compared with the byte order defined in BufToHexString().
456 @param Str String for output
457 @param Buffer Binary buffer.
458 @param BufferSize Size of the buffer in bytes.
460 @retval EFI_SUCCESS The function completed successfully.
461 @retval EFI_OUT_OF_RESOURCES There is no enough available memory space.
466 BufInReverseOrderToHexString (
474 Converts Hex String to binary buffer in reversed byte order to HexStringToBuf().
476 @param Buffer Pointer to buffer that receives the data.
477 @param BufferSize Length in bytes of the buffer to hold converted
478 data. If routine return with EFI_SUCCESS,
479 containing length of converted data. If routine
480 return with EFI_BUFFER_TOO_SMALL, containg length
482 @param Str String to be converted from.
484 @retval EFI_SUCCESS The function completed successfully.
485 @retval RETURN_BUFFER_TOO_SMALL The input BufferSize is too small to hold the output. BufferSize
486 will be updated to the size required for the converstion.
491 HexStringToBufInReverseOrder (
492 IN OUT UINT8
*Buffer
,
493 IN OUT UINTN
*BufferSize
,
499 Convert binary representation Config string (e.g. "0041004200430044") to the
500 original string (e.g. "ABCD"). Config string appears in <ConfigHdr> (i.e.
501 "&NAME=<string>"), or Name/Value pair in <ConfigBody> (i.e. "label=<string>").
503 @param UnicodeString Original Unicode string.
504 @param StrBufferLen On input: Length in bytes of buffer to hold the Unicode string.
505 Includes tailing '\0' character.
507 containing length of Unicode string buffer when returning EFI_SUCCESS;
508 containg length of string buffer desired when returning EFI_BUFFER_TOO_SMALL.
509 @param ConfigString Binary representation of Unicode String, <string> := (<HexCh>4)+
511 @retval EFI_SUCCESS Operation completes successfully.
512 @retval EFI_BUFFER_TOO_SMALL The string buffer is too small.
517 ConfigStringToUnicode (
518 IN OUT CHAR16
*UnicodeString
,
519 IN OUT UINTN
*StrBufferLen
,
520 IN CHAR16
*ConfigString
525 Convert Unicode string to binary representation Config string, e.g.
526 "ABCD" => "0041004200430044". Config string appears in <ConfigHdr> (i.e.
527 "&NAME=<string>"), or Name/Value pair in <ConfigBody> (i.e. "label=<string>").
529 @param ConfigString Binary representation of Unicode String, <string> := (<HexCh>4)+
530 @param StrBufferLen On input: Length in bytes of buffer to hold the Unicode string.
531 Includes tailing '\0' character.
533 If return EFI_SUCCESS, containing length of Unicode string buffer.
534 If return EFI_BUFFER_TOO_SMALL, containg length of string buffer desired.
535 @param UnicodeString Original Unicode string.
537 @retval EFI_SUCCESS Operation completes successfully.
538 @retval EFI_BUFFER_TOO_SMALL The string buffer is too small.
543 UnicodeToConfigString (
544 IN OUT CHAR16
*ConfigString
,
545 IN OUT UINTN
*StrBufferLen
,
546 IN CHAR16
*UnicodeString
551 Construct <ConfigHdr> using routing information GUID/NAME/PATH.
553 @param ConfigHdr Pointer to the ConfigHdr string.
554 @param StrBufferLen On input: Length in bytes of buffer to hold the
555 ConfigHdr string. Includes tailing '\0' character.
556 On output: If return EFI_SUCCESS, containing
557 length of ConfigHdr string buffer. If return
558 EFI_BUFFER_TOO_SMALL, containg length of string
560 @param Guid Routing information: GUID.
561 @param Name Routing information: NAME.
562 @param DriverHandle Driver handle which contains the routing
565 @retval EFI_SUCCESS Operation completes successfully.
566 @retval EFI_BUFFER_TOO_SMALL The ConfigHdr string buffer is too small.
572 IN OUT CHAR16
*ConfigHdr
,
573 IN OUT UINTN
*StrBufferLen
,
574 IN CONST EFI_GUID
*Guid
,
575 IN CHAR16
*Name
, OPTIONAL
576 IN EFI_HANDLE
*DriverHandle
582 Search BlockName "&OFFSET=Offset&WIDTH=Width" in a string.
584 @param String The string to be searched in.
585 @param Offset Offset in BlockName.
586 @param Width Width in BlockName.
588 @retval TRUE Block name found.
589 @retval FALSE Block name not found.
595 IN OUT CHAR16
*String
,
602 This routine is invoked by ConfigAccess.Callback() to retrived uncommitted data from Form Browser.
604 @param VariableGuid An optional field to indicate the target variable
606 @param VariableName An optional field to indicate the target
607 human-readable variable name.
608 @param BufferSize On input: Length in bytes of buffer to hold
609 retrived data. On output: If return
610 EFI_BUFFER_TOO_SMALL, containg length of buffer
612 @param Buffer Buffer to hold retrived data.
614 @retval EFI_SUCCESS Operation completes successfully.
615 @retval EFI_BUFFER_TOO_SMALL The intput buffer is too small.
621 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
622 IN CONST CHAR16
*VariableName
, OPTIONAL
623 IN OUT UINTN
*BufferSize
,
629 This routine is invoked by ConfigAccess.Callback() to update uncommitted data of Form Browser.
631 @param VariableGuid An optional field to indicate the target variable
633 @param VariableName An optional field to indicate the target
634 human-readable variable name.
635 @param BufferSize Length in bytes of buffer to hold retrived data.
636 @param Buffer Buffer to hold retrived data.
637 @param RequestElement An optional field to specify which part of the
638 buffer data will be send back to Browser. If NULL,
639 the whole buffer of data will be committed to
640 Browser. <RequestElement> ::=
641 &OFFSET=<Number>&WIDTH=<Number>*
643 @retval EFI_SUCCESS Operation completes successfully.
644 @retval Other Updating Browser uncommitted data failed.
650 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
651 IN CONST CHAR16
*VariableName
, OPTIONAL
653 IN CONST UINT8
*Buffer
,
654 IN CONST CHAR16
*RequestElement OPTIONAL
659 Draw a dialog and return the selected key.
661 @param NumberOfLines The number of lines for the dialog box
662 @param KeyValue The EFI_KEY value returned if HotKey is TRUE..
663 @param String Pointer to the first string in the list
664 @param ... A series of (quantity == NumberOfLines - 1) text
665 strings which will be used to construct the dialog
668 @retval EFI_SUCCESS Displayed dialog and received user interaction
669 @retval EFI_INVALID_PARAMETER One of the parameters was invalid.
675 IN UINTN NumberOfLines
,
676 OUT EFI_INPUT_KEY
*KeyValue
,
683 Draw a dialog and return the selected key using Variable Argument List.
685 @param NumberOfLines The number of lines for the dialog box
686 @param KeyValue The EFI_KEY value returned if HotKey is TRUE..
687 @param Args VA_LIST marker for the variable argument list.
688 A series of (quantity == NumberOfLines - 1) text
689 strings which will be used to construct the dialog
692 @retval EFI_SUCCESS Displayed dialog and received user interaction
693 @retval EFI_INVALID_PARAMETER One of the parameters was invalid.
699 IN UINTN NumberOfLines
,
700 OUT EFI_INPUT_KEY
*KeyValue
,