1) Move RFC_3066_ENTRY_SIZE and ISO_639_2_ENTRY_SIZE to UefiBaseType.h.
2) Rename BufToHexString to BufInReverseOrderToHexString 3) Rename HexStringToBuf to HexStringToBufInReverseOrder 4) Update function comments in HiiLib.h and IfrSupportLib.h. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5989 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -359,7 +359,7 @@ ToLower (
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
BufferToHexString (
|
||||
BufInReverseOrderToHexString (
|
||||
IN OUT CHAR16 *Str,
|
||||
IN UINT8 *Buffer,
|
||||
IN UINTN BufferSize
|
||||
@@ -400,11 +400,13 @@ BufferToHexString (
|
||||
@param Str String to be converted from.
|
||||
|
||||
@retval EFI_SUCCESS The function completed successfully.
|
||||
@retval RETURN_BUFFER_TOO_SMALL The input BufferSize is too small to hold the output. BufferSize
|
||||
will be updated to the size required for the converstion.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
HexStringToBuffer (
|
||||
HexStringToBufInReverseOrder (
|
||||
IN OUT UINT8 *Buffer,
|
||||
IN OUT UINTN *BufferSize,
|
||||
IN CHAR16 *Str
|
||||
@@ -435,7 +437,7 @@ HexStringToBuffer (
|
||||
If return EFI_BUFFER_TOO_SMALL, containg length of string buffer desired.
|
||||
@param ConfigString Binary representation of Unicode String, <string> := (<HexCh>4)+
|
||||
|
||||
@retval EFI_SUCCESS Routine success.
|
||||
@retval EFI_SUCCESS Operation completes successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The string buffer is too small.
|
||||
|
||||
**/
|
||||
@@ -495,7 +497,7 @@ ConfigStringToUnicode (
|
||||
If return EFI_BUFFER_TOO_SMALL, containg length of string buffer desired.
|
||||
@param UnicodeString Original Unicode string.
|
||||
|
||||
@retval EFI_SUCCESS Routine success.
|
||||
@retval EFI_SUCCESS Operation completes successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The string buffer is too small.
|
||||
|
||||
**/
|
||||
@@ -557,7 +559,7 @@ UnicodeToConfigString (
|
||||
@param DriverHandle Driver handle which contains the routing
|
||||
information: PATH.
|
||||
|
||||
@retval EFI_SUCCESS Routine success.
|
||||
@retval EFI_SUCCESS Operation completes successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The ConfigHdr string buffer is too small.
|
||||
|
||||
**/
|
||||
@@ -620,7 +622,7 @@ ConstructConfigHdr (
|
||||
|
||||
StrCpy (StrPtr, L"GUID=");
|
||||
StrPtr += 5;
|
||||
BufferToHexString (StrPtr, (UINT8 *) Guid, sizeof (EFI_GUID));
|
||||
BufInReverseOrderToHexString (StrPtr, (UINT8 *) Guid, sizeof (EFI_GUID));
|
||||
StrPtr += 32;
|
||||
|
||||
//
|
||||
@@ -636,7 +638,7 @@ ConstructConfigHdr (
|
||||
|
||||
StrCpy (StrPtr, L"&PATH=");
|
||||
StrPtr += 6;
|
||||
BufferToHexString (StrPtr, (UINT8 *) DevicePath, DevicePathSize);
|
||||
BufInReverseOrderToHexString (StrPtr, (UINT8 *) DevicePath, DevicePathSize);
|
||||
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
@@ -719,7 +721,7 @@ FindBlockName (
|
||||
desired.
|
||||
@param Buffer Buffer to hold retrived data.
|
||||
|
||||
@retval EFI_SUCCESS Routine success.
|
||||
@retval EFI_SUCCESS Operation completes successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The intput buffer is too small.
|
||||
@retval EFI_OUT_OF_RESOURCES There is no enough available memory space.
|
||||
|
||||
@@ -836,7 +838,7 @@ GetBrowserData (
|
||||
Browser. <RequestElement> ::=
|
||||
&OFFSET=<Number>&WIDTH=<Number>*
|
||||
|
||||
@retval EFI_SUCCESS Routine success.
|
||||
@retval EFI_SUCCESS Operation completes successfully.
|
||||
@retval EFI_OUT_OF_RESOURCES There is no enough available memory space.
|
||||
@retval Other Updating Browser uncommitted data failed.
|
||||
|
||||
|
@@ -103,7 +103,7 @@ IsValidCheckboxFlags (
|
||||
|
||||
@param Data Destination for the created opcode binary
|
||||
|
||||
@retval EFI_SUCCESS Opcode create success
|
||||
@retval EFI_SUCCESS Opcode is created successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
|
||||
|
||||
**/
|
||||
@@ -139,11 +139,13 @@ CreateEndOpCode (
|
||||
/**
|
||||
Create EFI_IFR_DEFAULT_OP opcode.
|
||||
|
||||
If Data is NULL or Data->Data is NULL, then ASSERT.
|
||||
|
||||
@param Value Value for the default
|
||||
@param Type Type for the default
|
||||
@param Data Destination for the created opcode binary
|
||||
|
||||
@retval EFI_SUCCESS Opcode create success
|
||||
@retval EFI_SUCCESS Opcode is created successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
|
||||
@retval EFI_INVALID_PARAMETER The type is not valid.
|
||||
|
||||
@@ -189,6 +191,8 @@ CreateDefaultOpCode (
|
||||
/**
|
||||
Create EFI_IFR_ACTION_OP opcode.
|
||||
|
||||
If Data is NULL or Data->Data is NULL, then ASSERT.
|
||||
|
||||
@param QuestionId Question ID
|
||||
@param Prompt String ID for Prompt
|
||||
@param Help String ID for Help
|
||||
@@ -196,7 +200,7 @@ CreateDefaultOpCode (
|
||||
@param QuestionConfig String ID for configuration
|
||||
@param Data Destination for the created opcode binary
|
||||
|
||||
@retval EFI_SUCCESS Opcode create success
|
||||
@retval EFI_SUCCESS Opcode is created successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
|
||||
@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
|
||||
|
||||
@@ -248,13 +252,15 @@ CreateActionOpCode (
|
||||
/**
|
||||
Create EFI_IFR_SUBTITLE_OP opcode.
|
||||
|
||||
If Data is NULL or Data->Data is NULL, then ASSERT.
|
||||
|
||||
@param Prompt String ID for Prompt
|
||||
@param Help String ID for Help
|
||||
@param Flags Subtitle opcode flags
|
||||
@param Scope Subtitle Scope bit
|
||||
@param Data Destination for the created opcode binary
|
||||
|
||||
@retval EFI_SUCCESS Opcode create success
|
||||
@retval EFI_SUCCESS Opcode is created successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
|
||||
|
||||
**/
|
||||
@@ -298,12 +304,14 @@ CreateSubTitleOpCode (
|
||||
/**
|
||||
Create EFI_IFR_TEXT_OP opcode.
|
||||
|
||||
If Data is NULL or Data->Data is NULL, then ASSERT.
|
||||
|
||||
@param Prompt String ID for Prompt
|
||||
@param Help String ID for Help
|
||||
@param TextTwo String ID for text two
|
||||
@param Data Destination for the created opcode binary
|
||||
|
||||
@retval EFI_SUCCESS Opcode create success
|
||||
@retval EFI_SUCCESS Opcode is created successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
|
||||
|
||||
**/
|
||||
@@ -345,6 +353,8 @@ CreateTextOpCode (
|
||||
/**
|
||||
Create EFI_IFR_REF_OP opcode.
|
||||
|
||||
If Data is NULL or Data->Data is NULL, then ASSERT.
|
||||
|
||||
@param FormId Destination Form ID
|
||||
@param Prompt String ID for Prompt
|
||||
@param Help String ID for Help
|
||||
@@ -352,7 +362,7 @@ CreateTextOpCode (
|
||||
@param QuestionId Question ID
|
||||
@param Data Destination for the created opcode binary
|
||||
|
||||
@retval EFI_SUCCESS Opcode create success
|
||||
@retval EFI_SUCCESS Opcode is created successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
|
||||
@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
|
||||
|
||||
@@ -404,13 +414,16 @@ CreateGotoOpCode (
|
||||
/**
|
||||
Create EFI_IFR_ONE_OF_OPTION_OP opcode.
|
||||
|
||||
If Data is NULL or Data->Data is NULL, then ASSERT.
|
||||
|
||||
@param OptionCount The number of options.
|
||||
@param OptionsList The list of Options.
|
||||
@param Type The data type.
|
||||
@param Data Destination for the created opcode binary
|
||||
|
||||
@retval EFI_SUCCESS Opcode create success
|
||||
@retval EFI_SUCCESS Opcode is created successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
|
||||
@retval EFI_INVALID_PARAMETER If OptionCount is not zero but OptionsList is NULL.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
@@ -460,6 +473,8 @@ CreateOneOfOptionOpCode (
|
||||
/**
|
||||
Create EFI_IFR_ONE_OF_OP opcode.
|
||||
|
||||
If Data is NULL or Data->Data is NULL, then ASSERT.
|
||||
|
||||
@param QuestionId Question ID
|
||||
@param VarStoreId Storage ID
|
||||
@param VarOffset Offset in Storage
|
||||
@@ -471,7 +486,7 @@ CreateOneOfOptionOpCode (
|
||||
@param OptionCount Number of options in option list
|
||||
@param Data Destination for the created opcode binary
|
||||
|
||||
@retval EFI_SUCCESS Opcode create success
|
||||
@retval EFI_SUCCESS Opcode is created successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
|
||||
@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
|
||||
|
||||
@@ -537,6 +552,8 @@ CreateOneOfOpCode (
|
||||
/**
|
||||
Create EFI_IFR_ORDERED_LIST_OP opcode.
|
||||
|
||||
If Data is NULL or Data->Data is NULL, then ASSERT.
|
||||
|
||||
@param QuestionId Question ID
|
||||
@param VarStoreId Storage ID
|
||||
@param VarOffset Offset in Storage
|
||||
@@ -550,7 +567,7 @@ CreateOneOfOpCode (
|
||||
@param OptionCount Number of options in option list
|
||||
@param Data Destination for the created opcode binary
|
||||
|
||||
@retval EFI_SUCCESS Opcode create success
|
||||
@retval EFI_SUCCESS Opcode is created successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
|
||||
@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
|
||||
|
||||
@@ -623,6 +640,8 @@ CreateOrderedListOpCode (
|
||||
/**
|
||||
Create EFI_IFR_CHECKBOX_OP opcode.
|
||||
|
||||
If Data is NULL or Data->Data is NULL, then ASSERT.
|
||||
|
||||
@param QuestionId Question ID
|
||||
@param VarStoreId Storage ID
|
||||
@param VarOffset Offset in Storage
|
||||
@@ -632,7 +651,7 @@ CreateOrderedListOpCode (
|
||||
@param CheckBoxFlags Flags for checkbox opcode
|
||||
@param Data Destination for the created opcode binary
|
||||
|
||||
@retval EFI_SUCCESS Opcode create success
|
||||
@retval EFI_SUCCESS Opcode is created successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
|
||||
@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
|
||||
|
||||
@@ -687,6 +706,8 @@ CreateCheckBoxOpCode (
|
||||
/**
|
||||
Create EFI_IFR_NUMERIC_OP opcode.
|
||||
|
||||
If Data is NULL or Data->Data is NULL, then ASSERT.
|
||||
|
||||
@param QuestionId Question ID
|
||||
@param VarStoreId Storage ID
|
||||
@param VarOffset Offset in Storage
|
||||
@@ -700,7 +721,7 @@ CreateCheckBoxOpCode (
|
||||
@param Default Numeric default value
|
||||
@param Data Destination for the created opcode binary
|
||||
|
||||
@retval EFI_SUCCESS Opcode create success
|
||||
@retval EFI_SUCCESS Opcode is created successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
|
||||
@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
|
||||
|
||||
@@ -798,6 +819,8 @@ CreateNumericOpCode (
|
||||
/**
|
||||
Create EFI_IFR_STRING_OP opcode.
|
||||
|
||||
If Data is NULL or Data->Data is NULL, then ASSERT.
|
||||
|
||||
@param QuestionId Question ID
|
||||
@param VarStoreId Storage ID
|
||||
@param VarOffset Offset in Storage
|
||||
@@ -809,7 +832,7 @@ CreateNumericOpCode (
|
||||
@param MaxSize String maximum length
|
||||
@param Data Destination for the created opcode binary
|
||||
|
||||
@retval EFI_SUCCESS Opcode create success
|
||||
@retval EFI_SUCCESS Opcode is created successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
|
||||
@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.
|
||||
|
||||
|
Reference in New Issue
Block a user