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
438 Construct <ConfigAltResp> for a buffer storage.
440 @param ConfigRequest The Config request string. If set to NULL, all the
441 configurable elements will be extracted from BlockNameArray.
442 @param ConfigAltResp The returned <ConfigAltResp>.
443 @param Progress On return, points to a character in the Request.
444 @param Guid GUID of the buffer storage.
445 @param Name Name of the buffer storage.
446 @param DriverHandle The DriverHandle which is used to invoke HiiDatabase
447 protocol interface NewPackageList().
448 @param BufferStorage Content of the buffer storage.
449 @param BufferStorageSize Length in bytes of the buffer storage.
450 @param BlockNameArray Array generated by VFR compiler.
451 @param NumberAltCfg Number of Default value array generated by VFR compiler.
452 The sequential input parameters will be number of
453 AltCfgId and DefaultValueArray pairs. When set to 0,
454 there will be no <AltResp>.
456 retval EFI_OUT_OF_RESOURCES Run out of memory resource.
457 retval EFI_INVALID_PARAMETER ConfigAltResp is NULL.
458 retval EFI_SUCCESS Operation successful.
462 ConstructConfigAltResp (
463 IN EFI_STRING ConfigRequest
, OPTIONAL
464 OUT EFI_STRING
*Progress
,
465 OUT EFI_STRING
*ConfigAltResp
,
468 IN EFI_HANDLE
*DriverHandle
,
469 IN VOID
*BufferStorage
,
470 IN UINTN BufferStorageSize
,
471 IN VOID
*BlockNameArray
, OPTIONAL
472 IN UINTN NumberAltCfg
,
474 //IN UINT16 AltCfgId,
475 //IN VOID *DefaultValueArray,
480 Converts the unicode character of the string from uppercase to lowercase.
482 @param Str String to be converted
494 Converts binary buffer to a Unicode string. The byte buffer is in a reversed byte order
495 compared with the byte order defined in BufToHexString().
497 @param Str String for output
498 @param Buffer Binary buffer.
499 @param BufferSize Size of the buffer in bytes.
501 @retval EFI_SUCCESS The function completed successfully.
502 @retval EFI_OUT_OF_RESOURCES There is no enough available memory space.
507 BufInReverseOrderToHexString (
515 Converts Hex String to binary buffer in reversed byte order to HexStringToBuf().
517 @param Buffer Pointer to buffer that receives the data.
518 @param BufferSize Length in bytes of the buffer to hold converted
519 data. If routine return with EFI_SUCCESS,
520 containing length of converted data. If routine
521 return with EFI_BUFFER_TOO_SMALL, containg length
523 @param Str String to be converted from.
525 @retval EFI_SUCCESS The function completed successfully.
526 @retval RETURN_BUFFER_TOO_SMALL The input BufferSize is too small to hold the output. BufferSize
527 will be updated to the size required for the converstion.
532 HexStringToBufInReverseOrder (
533 IN OUT UINT8
*Buffer
,
534 IN OUT UINTN
*BufferSize
,
540 Convert binary representation Config string (e.g. "0041004200430044") to the
541 original string (e.g. "ABCD"). Config string appears in <ConfigHdr> (i.e.
542 "&NAME=<string>"), or Name/Value pair in <ConfigBody> (i.e. "label=<string>").
544 @param UnicodeString Original Unicode string.
545 @param StrBufferLen On input: Length in bytes of buffer to hold the Unicode string.
546 Includes tailing '\0' character.
548 containing length of Unicode string buffer when returning EFI_SUCCESS;
549 containg length of string buffer desired when returning EFI_BUFFER_TOO_SMALL.
550 @param ConfigString Binary representation of Unicode String, <string> := (<HexCh>4)+
552 @retval EFI_SUCCESS Operation completes successfully.
553 @retval EFI_BUFFER_TOO_SMALL The string buffer is too small.
558 ConfigStringToUnicode (
559 IN OUT CHAR16
*UnicodeString
,
560 IN OUT UINTN
*StrBufferLen
,
561 IN CHAR16
*ConfigString
566 Convert Unicode string to binary representation Config string, e.g.
567 "ABCD" => "0041004200430044". Config string appears in <ConfigHdr> (i.e.
568 "&NAME=<string>"), or Name/Value pair in <ConfigBody> (i.e. "label=<string>").
570 @param ConfigString Binary representation of Unicode String, <string> := (<HexCh>4)+
571 @param StrBufferLen On input: Length in bytes of buffer to hold the Unicode string.
572 Includes tailing '\0' character.
574 If return EFI_SUCCESS, containing length of Unicode string buffer.
575 If return EFI_BUFFER_TOO_SMALL, containg length of string buffer desired.
576 @param UnicodeString Original Unicode string.
578 @retval EFI_SUCCESS Operation completes successfully.
579 @retval EFI_BUFFER_TOO_SMALL The string buffer is too small.
584 UnicodeToConfigString (
585 IN OUT CHAR16
*ConfigString
,
586 IN OUT UINTN
*StrBufferLen
,
587 IN CHAR16
*UnicodeString
592 Construct <ConfigHdr> using routing information GUID/NAME/PATH.
594 @param ConfigHdr Pointer to the ConfigHdr string.
595 @param StrBufferLen On input: Length in bytes of buffer to hold the
596 ConfigHdr string. Includes tailing '\0' character.
597 On output: If return EFI_SUCCESS, containing
598 length of ConfigHdr string buffer. If return
599 EFI_BUFFER_TOO_SMALL, containg length of string
601 @param Guid Routing information: GUID.
602 @param Name Routing information: NAME.
603 @param DriverHandle Driver handle which contains the routing
606 @retval EFI_SUCCESS Operation completes successfully.
607 @retval EFI_BUFFER_TOO_SMALL The ConfigHdr string buffer is too small.
613 IN OUT CHAR16
*ConfigHdr
,
614 IN OUT UINTN
*StrBufferLen
,
615 IN CONST EFI_GUID
*Guid
,
616 IN CHAR16
*Name
, OPTIONAL
617 IN EFI_HANDLE
*DriverHandle
623 Determines if the Routing data (Guid and Name) is correct in <ConfigHdr>.
625 @param ConfigString Either <ConfigRequest> or <ConfigResp>.
626 @param StorageGuid GUID of the storage.
627 @param StorageName Name of the stoarge.
629 @retval TRUE Routing information is correct in ConfigString.
630 @retval FALSE Routing information is incorrect in ConfigString.
635 IN EFI_STRING ConfigString
,
636 IN EFI_GUID
*StorageGuid
, OPTIONAL
637 IN CHAR16
*StorageName OPTIONAL
642 Search BlockName "&OFFSET=Offset&WIDTH=Width" in a string.
644 @param String The string to be searched in.
645 @param Offset Offset in BlockName.
646 @param Width Width in BlockName.
648 @retval TRUE Block name found.
649 @retval FALSE Block name not found.
655 IN OUT CHAR16
*String
,
662 This routine is invoked by ConfigAccess.Callback() to retrived uncommitted data from Form Browser.
664 @param VariableGuid An optional field to indicate the target variable
666 @param VariableName An optional field to indicate the target
667 human-readable variable name.
668 @param BufferSize On input: Length in bytes of buffer to hold
669 retrived data. On output: If return
670 EFI_BUFFER_TOO_SMALL, containg length of buffer
672 @param Buffer Buffer to hold retrived data.
674 @retval EFI_SUCCESS Operation completes successfully.
675 @retval EFI_BUFFER_TOO_SMALL The intput buffer is too small.
681 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
682 IN CONST CHAR16
*VariableName
, OPTIONAL
683 IN OUT UINTN
*BufferSize
,
689 This routine is invoked by ConfigAccess.Callback() to update uncommitted data of Form Browser.
691 @param VariableGuid An optional field to indicate the target variable
693 @param VariableName An optional field to indicate the target
694 human-readable variable name.
695 @param BufferSize Length in bytes of buffer to hold retrived data.
696 @param Buffer Buffer to hold retrived data.
697 @param RequestElement An optional field to specify which part of the
698 buffer data will be send back to Browser. If NULL,
699 the whole buffer of data will be committed to
700 Browser. <RequestElement> ::=
701 &OFFSET=<Number>&WIDTH=<Number>*
703 @retval EFI_SUCCESS Operation completes successfully.
704 @retval Other Updating Browser uncommitted data failed.
710 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
711 IN CONST CHAR16
*VariableName
, OPTIONAL
713 IN CONST UINT8
*Buffer
,
714 IN CONST CHAR16
*RequestElement OPTIONAL
719 Draw a dialog and return the selected key.
721 @param NumberOfLines The number of lines for the dialog box
722 @param KeyValue The EFI_KEY value returned if HotKey is TRUE..
723 @param String Pointer to the first string in the list
724 @param ... A series of (quantity == NumberOfLines - 1) text
725 strings which will be used to construct the dialog
728 @retval EFI_SUCCESS Displayed dialog and received user interaction
729 @retval EFI_INVALID_PARAMETER One of the parameters was invalid.
735 IN UINTN NumberOfLines
,
736 OUT EFI_INPUT_KEY
*KeyValue
,
743 Draw a dialog and return the selected key using Variable Argument List.
745 @param NumberOfLines The number of lines for the dialog box
746 @param KeyValue The EFI_KEY value returned if HotKey is TRUE..
747 @param String The first String to be displayed in the Pop-Up.
748 @param Args VA_LIST marker for the variable argument list.
749 A series of (quantity == NumberOfLines - 1) text
750 strings which will be used to construct the dialog
753 @retval EFI_SUCCESS Displayed dialog and received user interaction
754 @retval EFI_INVALID_PARAMETER One of the parameters was invalid.
760 IN UINTN NumberOfLines
,
761 OUT EFI_INPUT_KEY
*KeyValue
,
768 Test if a Unicode character is a hexadecimal digit. If true, the input
769 Unicode character is converted to a byte.
771 This function tests if a Unicode character is a hexadecimal digit. If true, the input
772 Unicode character is converted to a byte. For example, Unicode character
773 L'A' will be converted to 0x0A.
775 If Digit is NULL, then ASSERT.
777 @param Digit The output hexadecimal digit.
779 @param Char The input Unicode character.
781 @retval TRUE Char is in the range of Hexadecimal number. Digit is updated
782 to the byte value of the number.
783 @retval FALSE Char is not in the range of Hexadecimal number. Digit is keep
797 Convert binary buffer to a Unicode String in a specified sequence.
799 This function converts bytes in the memory block pointed by Buffer to a Unicode String Str.
800 Each byte will be represented by two Unicode characters. For example, byte 0xA1 will
801 be converted into two Unicode character L'A' and L'1'. In the output String, the Unicode Character
802 for the Most Significant Nibble will be put before the Unicode Character for the Least Significant
803 Nibble. The output string for the buffer containing a single byte 0xA1 will be L"A1".
804 For a buffer with multiple bytes, the Unicode character produced by the first byte will be put into the
805 the last character in the output string. The one next to first byte will be put into the
806 character before the last character. This rules applies to the rest of the bytes. The Unicode
807 character by the last byte will be put into the first character in the output string. For example,
808 the input buffer for a 64-bits unsigned integer 0x12345678abcdef1234 will be converted to
809 a Unicode string equal to L"12345678abcdef1234".
811 @param String On input, String is pointed to the buffer allocated for the convertion.
812 @param StringLen The Length of String buffer to hold the output String. The length must include the tailing '\0' character.
813 The StringLen required to convert a N bytes Buffer will be a least equal to or greater
815 @param Buffer The pointer to a input buffer.
816 @param BufferSizeInBytes Length in bytes of the input buffer.
819 @retval EFI_SUCCESS The convertion is successful. All bytes in Buffer has been convert to the corresponding
820 Unicode character and placed into the right place in String.
821 @retval EFI_BUFFER_TOO_SMALL StringSizeInBytes is smaller than 2 * N + 1the number of bytes required to
822 complete the convertion.
827 IN OUT CHAR16
*String
,
828 IN OUT UINTN
*StringLen
,
829 IN CONST UINT8
*Buffer
,
830 IN UINTN BufferSizeInBytes
836 Convert a Unicode string consisting of hexadecimal characters to a output byte buffer.
838 This function converts a Unicode string consisting of characters in the range of Hexadecimal
839 character (L'0' to L'9', L'A' to L'F' and L'a' to L'f') to a output byte buffer. The function will stop
840 at the first non-hexadecimal character or the NULL character. The convertion process can be
841 simply viewed as the reverse operations defined by BufToHexString. Two Unicode characters will be
842 converted into one byte. The first Unicode character represents the Most Significant Nibble and the
843 second Unicode character represents the Least Significant Nibble in the output byte.
844 The first pair of Unicode characters represents the last byte in the output buffer. The second pair of Unicode
845 characters represent the the byte preceding the last byte. This rule applies to the rest pairs of bytes.
846 The last pair represent the first byte in the output buffer.
848 For example, a Unciode String L"12345678" will be converted into a buffer wil the following bytes
849 (first byte is the byte in the lowest memory address): "0x78, 0x56, 0x34, 0x12".
851 If String has N valid hexadecimal characters for conversion, the caller must make sure Buffer is at least
852 N/2 (if N is even) or (N+1)/2 (if N if odd) bytes.
854 @param Buffer The output buffer allocated by the caller.
855 @param BufferSizeInBytes On input, the size in bytes of Buffer. On output, it is updated to
856 contain the size of the Buffer which is actually used for the converstion.
857 For Unicode string with 2*N hexadecimal characters (not including the
858 tailing NULL character), N bytes of Buffer will be used for the output.
859 @param String The input hexadecimal string.
860 @param ConvertedStrLen The number of hexadecimal characters used to produce content in output
863 @retval RETURN_BUFFER_TOO_SMALL The input BufferSizeInBytes is too small to hold the output. BufferSizeInBytes
864 will be updated to the size required for the converstion.
865 @retval RETURN_SUCCESS The convertion is successful or the first Unicode character from String
866 is hexadecimal. If ConvertedStrLen is not NULL, it is updated
867 to the number of hexadecimal character used for the converstion.
873 IN OUT UINTN
*BufferSizeInBytes
,
874 IN CONST CHAR16
*String
,
875 OUT UINTN
*ConvertedStrLen OPTIONAL