sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

correct some coding style issues.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7112 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
gdong1
2008-12-24 02:42:57 +00:00
parent ef9273606b
commit 49a049e6d2
5 changed files with 606 additions and 621 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrCommon.c
View File

@ -69,7 +69,7 @@ GetCurrentLanguage (
} }
/** /**
Add a string to the incoming buffer and return the token and offset data Add a string to the incoming buffer and return the token and offset data.
@param StringBuffer The incoming buffer @param StringBuffer The incoming buffer
@param Language Currrent language @param Language Currrent language
@ -279,7 +279,7 @@ AddString (
} }
/** /**
Add op-code data to the FormBuffer Add op-code data to the FormBuffer.
@param FormBuffer Form buffer to be inserted to @param FormBuffer Form buffer to be inserted to
@param OpCodeData Op-code data to be inserted @param OpCodeData Op-code data to be inserted
@ -385,7 +385,7 @@ AddOpCode (
} }
/** /**
Get the HII protocol interface Get the HII protocol interface.
@param Hii HII protocol interface @param Hii HII protocol interface
@ -411,7 +411,7 @@ GetHiiInterface (
} }
/** /**
Extract information pertaining to the HiiHandle Extract information pertaining to the HiiHandle.
@param HiiHandle Hii handle @param HiiHandle Hii handle
@param ImageLength For input, length of DefaultImage; @param ImageLength For input, length of DefaultImage;
@ -446,7 +446,6 @@ ExtractDataFromHiiHandle (
CachedStart = 0; CachedStart = 0;
Status = GetHiiInterface (&Hii); Status = GetHiiInterface (&Hii);
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
return Status; return Status;
} }
@ -463,7 +462,6 @@ ExtractDataFromHiiHandle (
// Get all the forms associated with this HiiHandle // Get all the forms associated with this HiiHandle
// //
Status = Hii->GetForms (Hii, HiiHandle, 0, &DataLength, RawData); Status = Hii->GetForms (Hii, HiiHandle, 0, &DataLength, RawData);
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
gBS->FreePool (RawData); gBS->FreePool (RawData);
@ -490,6 +488,7 @@ ExtractDataFromHiiHandle (
for (Index = 0; RawData[Index] != FRAMEWORK_EFI_IFR_END_FORM_SET_OP;) { for (Index = 0; RawData[Index] != FRAMEWORK_EFI_IFR_END_FORM_SET_OP;) {
switch (RawData[Index]) { switch (RawData[Index]) {
case FRAMEWORK_EFI_IFR_FORM_SET_OP: case FRAMEWORK_EFI_IFR_FORM_SET_OP:
// //
// Copy the GUID information from this handle // Copy the GUID information from this handle
@ -538,6 +537,7 @@ ExtractDataFromHiiHandle (
// //
for (Index = 0; RawData[Index] != FRAMEWORK_EFI_IFR_END_FORM_SET_OP;) { for (Index = 0; RawData[Index] != FRAMEWORK_EFI_IFR_END_FORM_SET_OP;) {
switch (RawData[Index]) { switch (RawData[Index]) {
case FRAMEWORK_EFI_IFR_ONE_OF_OP: case FRAMEWORK_EFI_IFR_ONE_OF_OP:
CachedStart = ((FRAMEWORK_EFI_IFR_ONE_OF *) &RawData[Index])->QuestionId; CachedStart = ((FRAMEWORK_EFI_IFR_ONE_OF *) &RawData[Index])->QuestionId;
break; break;
@ -593,7 +593,6 @@ FindHiiHandle (
) )
{ {
EFI_STATUS Status; EFI_STATUS Status;
FRAMEWORK_EFI_HII_HANDLE *HiiHandleBuffer; FRAMEWORK_EFI_HII_HANDLE *HiiHandleBuffer;
FRAMEWORK_EFI_HII_HANDLE HiiHandle; FRAMEWORK_EFI_HII_HANDLE HiiHandle;
UINT16 HiiHandleBufferLength; UINT16 HiiHandleBufferLength;
@ -674,7 +673,6 @@ FindHiiHandle (
ExtractDataFromHiiHandle (HiiHandleBuffer[Index], &Length, NULL, &HiiGuid); ExtractDataFromHiiHandle (HiiHandleBuffer[Index], &Length, NULL, &HiiGuid);
if (CompareGuid (&HiiGuid, Guid)) { if (CompareGuid (&HiiGuid, Guid)) {
HiiHandle = HiiHandleBuffer[Index]; HiiHandle = HiiHandleBuffer[Index];
break; break;
} }
@ -691,10 +689,10 @@ lbl_exit:
are not verified due to their not having the equivalent of valid range settings. are not verified due to their not having the equivalent of valid range settings.
@param HiiHandle Handle of the HII database entry to query @param HiiHandle Handle of the HII database entry to query
@param Results If return Status is EFI_SUCCESS, Results provides valid data @param Results If return Status is EFI_SUCCESS, Results provides valid data
TRUE = NVRAM Data is within parameters TRUE = NVRAM Data is within parameters
FALSE = NVRAM Data is NOT within parameters FALSE = NVRAM Data is NOT within parameters
@retval EFI_OUT_OF_RESOURCES No enough buffer to allocate @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
@retval EFI_SUCCESS Data successfully validated @retval EFI_SUCCESS Data successfully validated
**/ **/
@ -724,7 +722,6 @@ ValidateDataFromHiiHandle (
*Results = TRUE; *Results = TRUE;
Status = GetHiiInterface (&Hii); Status = GetHiiInterface (&Hii);
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
return Status; return Status;
} }
@ -741,7 +738,6 @@ ValidateDataFromHiiHandle (
// Get all the forms associated with this HiiHandle // Get all the forms associated with this HiiHandle
// //
Status = Hii->GetForms (Hii, HiiHandle, 0, &RawDataLength, RawData); Status = Hii->GetForms (Hii, HiiHandle, 0, &RawDataLength, RawData);
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
gBS->FreePool (RawData); gBS->FreePool (RawData);
@ -777,6 +773,7 @@ ValidateDataFromHiiHandle (
for (Index = 0; RawData[Index] != FRAMEWORK_EFI_IFR_END_FORM_SET_OP;) { for (Index = 0; RawData[Index] != FRAMEWORK_EFI_IFR_END_FORM_SET_OP;) {
switch (RawData[Index]) { switch (RawData[Index]) {
case FRAMEWORK_EFI_IFR_FORM_SET_OP: case FRAMEWORK_EFI_IFR_FORM_SET_OP:
break; break;
@ -856,6 +853,7 @@ ValidateDataFromHiiHandle (
// //
for (Index = 0; RawData[Index] != FRAMEWORK_EFI_IFR_END_FORM_SET_OP;) { for (Index = 0; RawData[Index] != FRAMEWORK_EFI_IFR_END_FORM_SET_OP;) {
switch (RawData[Index]) { switch (RawData[Index]) {
case FRAMEWORK_EFI_IFR_ONE_OF_OP: case FRAMEWORK_EFI_IFR_ONE_OF_OP:
// //
// A one_of has no data, its the option that does - cache the storage Id // A one_of has no data, its the option that does - cache the storage Id

85
IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrOnTheFly.c
View File

@ -119,7 +119,7 @@ CreateFormSet (
} }
/** /**
Create a form Create a form.
A form is the encapsulation of what amounts to a browser page. The header defines a FormId, A form is the encapsulation of what amounts to a browser page. The header defines a FormId,
which is referenced by the form package, among others. It also defines a FormTitle, which is a which is referenced by the form package, among others. It also defines a FormTitle, which is a
string to be used as the title for the form string to be used as the title for the form
@ -224,15 +224,15 @@ CreateSubTitle (
Unlike HTML, text is simply another tag. Unlike HTML, text is simply another tag.
This tag type enables IFR to be more easily localized. This tag type enables IFR to be more easily localized.
@param String - First string of the text @param String First string of the text
@param String2 - Second string of the text @param String2 Second string of the text
@param String3 - Help string of the text @param String3 Help string of the text
@param Flags - Flag of the text @param Flags Flag of the text
@param Key - Key of the text @param Key Key of the text
@param FormBuffer - The form where this text adds to @param FormBuffer The form where this text adds to
@param StringBuffer - String buffer created for String, String2 and String3 @param StringBuffer String buffer created for String, String2 and String3
@retval EFI_SUCCESS - Text successfully created @retval EFI_SUCCESS Text successfully created
**/ **/
EFI_STATUS EFI_STATUS
CreateText ( CreateText (
@ -299,7 +299,7 @@ CreateText (
} }
/** /**
Create a hyperlink Create a hyperlink.
@param FormId Form ID of the hyperlink @param FormId Form ID of the hyperlink
@param Prompt Prompt of the hyperlink @param Prompt Prompt of the hyperlink
@ -346,17 +346,17 @@ CreateGoto (
Create a one-of question with a set of options to choose from. The Create a one-of question with a set of options to choose from. The
OptionsList is a pointer to a null-terminated list of option descriptions. OptionsList is a pointer to a null-terminated list of option descriptions.
@param QuestionId - Question ID of the one-of box @param QuestionId Question ID of the one-of box
@param DataWidth - DataWidth of the one-of box @param DataWidth DataWidth of the one-of box
@param Prompt - Prompt of the one-of box @param Prompt Prompt of the one-of box
@param Help - Help of the one-of box @param Help Help of the one-of box
@param OptionsList - Each string in it is an option of the one-of box @param OptionsList Each string in it is an option of the one-of box
@param OptionCount - Option string count @param OptionCount Option string count
@param FormBuffer - The form where this one-of box adds to @param FormBuffer The form where this one-of box adds to
@param StringBuffer - String buffer created for Prompt, Help and Option strings @param StringBuffer String buffer created for Prompt, Help and Option strings
@retval EFI_DEVICE_ERROR - DataWidth > 2 @retval EFI_DEVICE_ERROR DataWidth > 2
@retval EFI_SUCCESS - One-Of box successfully created. @retval EFI_SUCCESS One-Of box successfully created.
**/ **/
EFI_STATUS EFI_STATUS
CreateOneOf ( CreateOneOf (
@ -459,16 +459,16 @@ CreateOneOf (
Create a one-of question with a set of options to choose from. The Create a one-of question with a set of options to choose from. The
OptionsList is a pointer to a null-terminated list of option descriptions. OptionsList is a pointer to a null-terminated list of option descriptions.
@param QuestionId - Question ID of the ordered list @param QuestionId Question ID of the ordered list
@param MaxEntries - MaxEntries of the ordered list @param MaxEntries MaxEntries of the ordered list
@param Prompt - Prompt of the ordered list @param Prompt Prompt of the ordered list
@param Help - Help of the ordered list @param Help Help of the ordered list
@param OptionsList - Each string in it is an option of the ordered list @param OptionsList Each string in it is an option of the ordered list
@param OptionCount - Option string count @param OptionCount Option string count
@param FormBuffer - The form where this ordered list adds to @param FormBuffer The form where this ordered list adds to
@param StringBuffer - String buffer created for Prompt, Help and Option strings @param StringBuffer String buffer created for Prompt, Help and Option strings
@retval EFI_SUCCESS - Ordered list successfully created. @retval EFI_SUCCESS Ordered list successfully created.
**/ **/
EFI_STATUS EFI_STATUS
CreateOrderedList ( CreateOrderedList (
@ -557,7 +557,7 @@ CreateOrderedList (
} }
/** /**
Create a checkbox Create a checkbox.
@param QuestionId Question ID of the check box @param QuestionId Question ID of the check box
@param DataWidth DataWidth of the check box @param DataWidth DataWidth of the check box
@ -720,19 +720,20 @@ CreateNumeric (
} }
/** /**
Create a string Create a string.
@param QuestionId - Question ID of the string @param QuestionId Question ID of the string
@param DataWidth - DataWidth of the string @param DataWidth DataWidth of the string
@param Prompt - Prompt of the string @param Prompt Prompt of the string
@param Help - Help of the string @param Help Help of the string
@param MinSize - Min size boundary of the string @param MinSize Min size boundary of the string
@param MaxSize - Max size boundary of the string @param MaxSize Max size boundary of the string
@param Flags - Flags of the string @param Flags Flags of the string
@param Key - Key of the string @param Key Key of the string
@param FormBuffer - The form where this string adds to @param FormBuffer The form where this string adds to
@param StringBuffer - String buffer created for Prompt and Help. @param StringBuffer String buffer created for Prompt and Help.
@retval EFI_SUCCESS - String successfully created.
@retval EFI_SUCCESS String successfully created.
**/ **/
EFI_STATUS EFI_STATUS
CreateString ( CreateString (

145
IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrOpCodeCreation.c
View File

@ -11,13 +11,12 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/ **/
#include "IfrSupportLibInternal.h" #include "IfrSupportLibInternal.h"
/** /**
Create a SubTitle opcode independent of string creation Create a SubTitle opcode independent of string creation.
This is used primarily by users who need to create just one particular valid op-code and the string This is used primarily by users who need to create just one particular valid op-code and the string
data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label
location to pre-defined forms in HII) location to pre-defined forms in HII)
@ -44,19 +43,20 @@ CreateSubTitleOpCode (
} }
/** /**
Create a Text opcode independent of string creation Create a Text opcode independent of string creation.
This is used primarily by users who need to create just one particular valid op-code and the string This is used primarily by users who need to create just one particular valid op-code and the string
data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label
location to pre-defined forms in HII) location to pre-defined forms in HII)
@param StringToken - First string token of the text @param StringToken First string token of the text
@param StringTokenTwo - Second string token of the text @param StringTokenTwo Second string token of the text
@param StringTokenThree - Help string token of the text @param StringTokenThree Help string token of the text
@param Flags - Flag of the text @param Flags Flag of the text
@param Key - Key of the text @param Key Key of the text
@param FormBuffer - Output of text as a form @param FormBuffer Output of text as a form
@retval EFI_SUCCESS - Text created to be a form @retval EFI_SUCCESS Text created to be a form
**/ **/
EFI_STATUS EFI_STATUS
CreateTextOpCode ( CreateTextOpCode (
@ -85,20 +85,21 @@ CreateTextOpCode (
} }
/** /**
Create a hyperlink opcode independent of string creation Create a hyperlink opcode independent of string creation.
This is used primarily by users who need to create just one particular valid op-code and the string This is used primarily by users who need to create just one particular valid op-code and the string
data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label
location to pre-defined forms in HII) location to pre-defined forms in HII)
@param FormId Form ID of the hyperlink
@param StringToken Prompt string token of the hyperlink
@param StringTokenTwo Help string token of the hyperlink
@param Flags Flags of the hyperlink
@param Key Key of the hyperlink
@param FormBuffer Output of hyperlink as a form
@param FormId - Form ID of the hyperlink @retval EFI_SUCCESS Hyperlink created to be a form
@param StringToken - Prompt string token of the hyperlink **/
@param StringTokenTwo - Help string token of the hyperlink
@param Flags - Flags of the hyperlink
@param Key - Key of the hyperlink
@param FormBuffer - Output of hyperlink as a form
@retval EFI_SUCCESS - Hyperlink created to be a form
--*/
EFI_STATUS EFI_STATUS
CreateGotoOpCode ( CreateGotoOpCode (
IN UINT16 FormId, IN UINT16 FormId,
@ -108,7 +109,6 @@ CreateGotoOpCode (
IN UINT16 Key, IN UINT16 Key,
IN OUT VOID *FormBuffer IN OUT VOID *FormBuffer
) )
{ {
FRAMEWORK_EFI_IFR_REF Hyperlink; FRAMEWORK_EFI_IFR_REF Hyperlink;
@ -134,17 +134,17 @@ CreateGotoOpCode (
OptionsList is a pointer to a null-terminated list of option descriptions. Ensure that OptionsList[x].StringToken OptionsList is a pointer to a null-terminated list of option descriptions. Ensure that OptionsList[x].StringToken
has been filled in since this routine will not generate StringToken values. has been filled in since this routine will not generate StringToken values.
@param QuestionId - Question ID of the one-of box @param QuestionId Question ID of the one-of box
@param DataWidth - DataWidth of the one-of box @param DataWidth DataWidth of the one-of box
@param PromptToken - Prompt string token of the one-of box @param PromptToken Prompt string token of the one-of box
@param HelpToken - Help string token of the one-of box @param HelpToken Help string token of the one-of box
@param OptionsList - Each string in it is an option of the one-of box @param OptionsList Each string in it is an option of the one-of box
@param OptionCount - Option string count @param OptionCount Option string count
@param FormBuffer - Output of One-Of box as a form @param FormBuffer Output of One-Of box as a form
@retval EFI_SUCCESS - One-Of box created to be a form @retval EFI_SUCCESS One-Of box created to be a form
@retval EFI_DEVICE_ERROR - DataWidth > 2 @retval EFI_DEVICE_ERROR DataWidth > 2
**/ **/
EFI_STATUS EFI_STATUS
CreateOneOfOpCode ( CreateOneOfOpCode (
@ -175,9 +175,7 @@ CreateOneOfOpCode (
OneOf.QuestionId = QuestionId; OneOf.QuestionId = QuestionId;
OneOf.Width = DataWidth; OneOf.Width = DataWidth;
OneOf.Prompt = PromptToken; OneOf.Prompt = PromptToken;
OneOf.Help = HelpToken; OneOf.Help = HelpToken;
LocalBuffer = (UINT8 *) FormBuffer; LocalBuffer = (UINT8 *) FormBuffer;
CopyMem (LocalBuffer, &OneOf, sizeof (FRAMEWORK_EFI_IFR_ONE_OF)); CopyMem (LocalBuffer, &OneOf, sizeof (FRAMEWORK_EFI_IFR_ONE_OF));
@ -217,15 +215,15 @@ CreateOneOfOpCode (
OptionsList is a pointer to a null-terminated list of option descriptions. Ensure that OptionsList[x].StringToken OptionsList is a pointer to a null-terminated list of option descriptions. Ensure that OptionsList[x].StringToken
has been filled in since this routine will not generate StringToken values. has been filled in since this routine will not generate StringToken values.
@param QuestionId - Question ID of the ordered list @param QuestionId Question ID of the ordered list
@param MaxEntries - MaxEntries of the ordered list @param MaxEntries MaxEntries of the ordered list
@param PromptToken - Prompt string token of the ordered list @param PromptToken Prompt string token of the ordered list
@param HelpToken - Help string token of the ordered list @param HelpToken Help string token of the ordered list
@param OptionsList - Each string in it is an option of the ordered list @param OptionsList Each string in it is an option of the ordered list
@param OptionCount - Option string count @param OptionCount Option string count
@param FormBuffer - Output of ordered list as a form @param FormBuffer Output of ordered list as a form
@retval EFI_SUCCESS - Ordered list created to be a form @retval EFI_SUCCESS Ordered list created to be a form
**/ **/
EFI_STATUS EFI_STATUS
CreateOrderedListOpCode ( CreateOrderedListOpCode (
@ -249,9 +247,7 @@ CreateOrderedListOpCode (
OrderedList.QuestionId = QuestionId; OrderedList.QuestionId = QuestionId;
OrderedList.MaxEntries = MaxEntries; OrderedList.MaxEntries = MaxEntries;
OrderedList.Prompt = PromptToken; OrderedList.Prompt = PromptToken;
OrderedList.Help = HelpToken; OrderedList.Help = HelpToken;
LocalBuffer = (UINT8 *) FormBuffer; LocalBuffer = (UINT8 *) FormBuffer;
CopyMem (LocalBuffer, &OrderedList, sizeof (FRAMEWORK_EFI_IFR_ORDERED_LIST)); CopyMem (LocalBuffer, &OrderedList, sizeof (FRAMEWORK_EFI_IFR_ORDERED_LIST));
@ -283,21 +279,21 @@ CreateOrderedListOpCode (
} }
/** /**
Create a checkbox opcode independent of string creation Create a checkbox opcode independent of string creation.
This is used primarily by users who need to create just one particular valid op-code and the string This is used primarily by users who need to create just one particular valid op-code and the string
data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label
location to pre-defined forms in HII) location to pre-defined forms in HII)
@param QuestionId - Question ID of the check box @param QuestionId Question ID of the check box
@param DataWidth - DataWidth of the check box @param DataWidth DataWidth of the check box
@param PromptToken - Prompt string token of the check box @param PromptToken Prompt string token of the check box
@param HelpToken - Help string token of the check box @param HelpToken Help string token of the check box
@param Flags - Flags of the check box @param Flags Flags of the check box
@param Key - Key of the check box @param Key Key of the check box
@param FormBuffer - Output of the check box as a form @param FormBuffer Output of the check box as a form
@retval EFI_SUCCESS - Checkbox created to be a form @retval EFI_SUCCESS Checkbox created to be a form
@retval EFI_DEVICE_ERROR - DataWidth > 1 @retval EFI_DEVICE_ERROR DataWidth > 1
**/ **/
EFI_STATUS EFI_STATUS
CreateCheckBoxOpCode ( CreateCheckBoxOpCode (
@ -309,7 +305,6 @@ CreateCheckBoxOpCode (
IN UINT16 Key, IN UINT16 Key,
IN OUT VOID *FormBuffer IN OUT VOID *FormBuffer
) )
{ {
FRAMEWORK_EFI_IFR_CHECKBOX CheckBox; FRAMEWORK_EFI_IFR_CHECKBOX CheckBox;
@ -325,7 +320,6 @@ CreateCheckBoxOpCode (
CheckBox.QuestionId = QuestionId; CheckBox.QuestionId = QuestionId;
CheckBox.Width = DataWidth; CheckBox.Width = DataWidth;
CheckBox.Prompt = PromptToken; CheckBox.Prompt = PromptToken;
CheckBox.Help = HelpToken; CheckBox.Help = HelpToken;
CheckBox.Flags = Flags; CheckBox.Flags = Flags;
CheckBox.Key = Key; CheckBox.Key = Key;
@ -336,26 +330,26 @@ CreateCheckBoxOpCode (
} }
/** /**
Create a numeric opcode independent of string creation Create a numeric opcode independent of string creation.
This is used primarily by users who need to create just one particular valid op-code and the string This is used primarily by users who need to create just one particular valid op-code and the string
data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label
location to pre-defined forms in HII) location to pre-defined forms in HII)
@param QuestionId - Question ID of the numeric @param QuestionId Question ID of the numeric
@param DataWidth - DataWidth of the numeric @param DataWidth DataWidth of the numeric
@param PromptToken - Prompt string token of the numeric @param PromptToken Prompt string token of the numeric
@param HelpToken - Help string token of the numeric @param HelpToken Help string token of the numeric
@param Minimum - Minumun boundary of the numeric @param Minimum Minumun boundary of the numeric
@param Maximum - Maximum boundary of the numeric @param Maximum Maximum boundary of the numeric
@param Step - Step of the numeric @param Step Step of the numeric
@param Default - Default value of the numeric @param Default Default value of the numeric
@param Flags - Flags of the numeric @param Flags Flags of the numeric
@param Key - Key of the numeric @param Key Key of the numeric
@param FormBuffer - Output of the numeric as a form @param FormBuffer Output of the numeric as a form
@retval EFI_SUCCESS - The numeric created to be a form. @retval EFI_SUCCESS The numeric created to be a form.
@retval EFI_DEVICE_ERROR - DataWidth > 2 @retval EFI_DEVICE_ERROR DataWidth > 2
**/ **/
EFI_STATUS EFI_STATUS
CreateNumericOpCode ( CreateNumericOpCode (
@ -371,7 +365,6 @@ CreateNumericOpCode (
IN UINT16 Key, IN UINT16 Key,
IN OUT VOID *FormBuffer IN OUT VOID *FormBuffer
) )
{ {
FRAMEWORK_EFI_IFR_NUMERIC Numeric; FRAMEWORK_EFI_IFR_NUMERIC Numeric;
@ -387,7 +380,6 @@ CreateNumericOpCode (
Numeric.QuestionId = QuestionId; Numeric.QuestionId = QuestionId;
Numeric.Width = DataWidth; Numeric.Width = DataWidth;
Numeric.Prompt = PromptToken; Numeric.Prompt = PromptToken;
Numeric.Help = HelpToken; Numeric.Help = HelpToken;
Numeric.Minimum = Minimum; Numeric.Minimum = Minimum;
Numeric.Maximum = Maximum; Numeric.Maximum = Maximum;
@ -402,7 +394,7 @@ CreateNumericOpCode (
} }
/** /**
Create a numeric opcode independent of string creation Create a numeric opcode independent of string creation.
This is used primarily by users who need to create just one particular valid op-code and the string This is used primarily by users who need to create just one particular valid op-code and the string
data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label
location to pre-defined forms in HII) location to pre-defined forms in HII)
@ -431,7 +423,6 @@ CreateStringOpCode (
IN UINT16 Key, IN UINT16 Key,
IN OUT VOID *FormBuffer IN OUT VOID *FormBuffer
) )
{ {
FRAMEWORK_EFI_IFR_STRING String; FRAMEWORK_EFI_IFR_STRING String;
@ -440,7 +431,6 @@ CreateStringOpCode (
String.QuestionId = QuestionId; String.QuestionId = QuestionId;
String.Width = DataWidth; String.Width = DataWidth;
String.Prompt = PromptToken; String.Prompt = PromptToken;
String.Help = HelpToken; String.Help = HelpToken;
String.MinSize = MinSize; String.MinSize = MinSize;
String.MaxSize = MaxSize; String.MaxSize = MaxSize;
@ -455,12 +445,12 @@ CreateStringOpCode (
/** /**
Create a banner opcode. This is primarily used by the FrontPage implementation from BDS. Create a banner opcode. This is primarily used by the FrontPage implementation from BDS.
@param Title - Title of the banner @param Title Title of the banner
@param LineNumber - LineNumber of the banner @param LineNumber LineNumber of the banner
@param Alignment - Alignment of the banner @param Alignment Alignment of the banner
@param FormBuffer - Output of banner as a form @param FormBuffer Output of banner as a form
@retval EFI_SUCCESS - Banner created to be a form. @retval EFI_SUCCESS Banner created to be a form.
**/ **/
EFI_STATUS EFI_STATUS
CreateBannerOpCode ( CreateBannerOpCode (
@ -469,7 +459,6 @@ CreateBannerOpCode (
IN UINT8 Alignment, IN UINT8 Alignment,
IN OUT VOID *FormBuffer IN OUT VOID *FormBuffer
) )
{ {
FRAMEWORK_EFI_IFR_BANNER Banner; FRAMEWORK_EFI_IFR_BANNER Banner;

3
IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrSupportLibInternal.h
View File

@ -1,4 +1,4 @@
/**@file /** @file
Common header file shared by all source files. Common header file shared by all source files.
This file includes package header files, library classes and protocol, PPI & GUID definitions. This file includes package header files, library classes and protocol, PPI & GUID definitions.
@ -10,6 +10,7 @@
http://opensource.org/licenses/bsd-license.php http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/ **/
#ifndef __IFRSUPPORT_LIB_INTERNAL_H_ #ifndef __IFRSUPPORT_LIB_INTERNAL_H_

116
IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrVariable.c
View File

@ -17,12 +17,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/** /**
Extracts a variable form a Pack. Extracts a variable form a Pack.
@param Pack - List of variables @param Pack List of variables
@param Name - Name of the variable/map @param Name Name of the variable/map
@param Guid - GUID of the variable/map @param Guid GUID of the variable/map
@param Id - The index of the variable/map to retrieve @param Id The index of the variable/map to retrieve
@param Var - Pointer to the variable/map @param Var Pointer to the variable/map
@param Size - Size of the variable/map in bytes @param Size Size of the variable/map in bytes
**/ **/
VOID VOID
EfiLibHiiVariablePackGetMap ( EfiLibHiiVariablePackGetMap (
@ -33,7 +33,6 @@ EfiLibHiiVariablePackGetMap (
OUT VOID **Var, OPTIONAL OUT VOID **Var, OPTIONAL
OUT UINTN *Size OPTIONAL OUT UINTN *Size OPTIONAL
) )
{ {
if (NULL != Name) { if (NULL != Name) {
*Name = (VOID *) (Pack + 1); *Name = (VOID *) (Pack + 1);
@ -60,7 +59,7 @@ EfiLibHiiVariablePackGetMap (
/** /**
Finds a count of the variables/maps in the List. Finds a count of the variables/maps in the List.
@param List - List of variables @param List List of variables
@return The number of map count. @return The number of map count.
**/ **/
@ -69,7 +68,9 @@ EfiLibHiiVariablePackListGetMapCnt (
IN EFI_HII_VARIABLE_PACK_LIST *List IN EFI_HII_VARIABLE_PACK_LIST *List
) )
{ {
UINTN Cnt = 0; UINTN Cnt;
Cnt = 0;
while (NULL != List) { while (NULL != List) {
Cnt++; Cnt++;
List = List->NextVariablePack; List = List->NextVariablePack;
@ -81,17 +82,14 @@ EfiLibHiiVariablePackListGetMapCnt (
Will iterate all variable/maps as appearing Will iterate all variable/maps as appearing
in List and for each, it will call the Callback. in List and for each, it will call the Callback.
@param List - List of variables @param List List of variables
@param Callback - Routine to be called for each iterated variable. @param Callback Routine to be called for each iterated variable.
**/ **/
VOID VOID
EfiLibHiiVariablePackListForEachVar ( EfiLibHiiVariablePackListForEachVar (
IN EFI_HII_VARIABLE_PACK_LIST *List, IN EFI_HII_VARIABLE_PACK_LIST *List,
IN EFI_LIB_HII_VARIABLE_PACK_LIST_CALLBACK *Callback IN EFI_LIB_HII_VARIABLE_PACK_LIST_CALLBACK *Callback
) )
{ {
CHAR16 *MapName; CHAR16 *MapName;
EFI_GUID *MapGuid; EFI_GUID *MapGuid;
@ -113,16 +111,16 @@ EfiLibHiiVariablePackListForEachVar (
Finds a variable form List given Finds a variable form List given
the order number as appears in the List. the order number as appears in the List.
@param Idx - The index of the variable/map to retrieve @param Idx The index of the variable/map to retrieve
@param List - List of variables @param List List of variables
@param Name - Name of the variable/map @param Name Name of the variable/map
@param Guid - GUID of the variable/map @param Guid GUID of the variable/map
@param Id - Id of the variable/map @param Id Id of the variable/map
@param Var - Pointer to the variable/map @param Var Pointer to the variable/map
@param Size - Size of the variable/map in bytes @param Size Size of the variable/map in bytes
@return EFI_SUCCESS - Variable is found, OUT parameters are valid @return EFI_SUCCESS Variable is found, OUT parameters are valid
@return EFI_NOT_FOUND - Variable is not found, OUT parameters are not valid @return EFI_NOT_FOUND Variable is not found, OUT parameters are not valid
**/ **/
EFI_STATUS EFI_STATUS
EfiLibHiiVariablePackListGetMapByIdx ( EfiLibHiiVariablePackListGetMapByIdx (
@ -134,8 +132,6 @@ EfiLibHiiVariablePackListGetMapByIdx (
OUT VOID **Var, OUT VOID **Var,
OUT UINTN *Size OUT UINTN *Size
) )
{ {
CHAR16 *MapName; CHAR16 *MapName;
EFI_GUID *MapGuid; EFI_GUID *MapGuid;
@ -175,16 +171,15 @@ EfiLibHiiVariablePackListGetMapByIdx (
Finds a variable form List given the Finds a variable form List given the
order number as appears in the List. order number as appears in the List.
@param Id - The ID of the variable/map to retrieve @param Id The ID of the variable/map to retrieve
@param List - List of variables @param List List of variables
@param Name - Name of the variable/map @param Name Name of the variable/map
@param Guid - GUID of the variable/map @param Guid GUID of the variable/map
@param Var - Pointer to the variable/map @param Var Pointer to the variable/map
@param Size - Size of the variable/map in bytes @param Size Size of the variable/map in bytes
@retval EFI_SUCCESS - Variable is found, OUT parameters are valid
@retval EFI_NOT_FOUND - Variable is not found, OUT parameters are not valid
@retval EFI_SUCCESS Variable is found, OUT parameters are valid
@retval EFI_NOT_FOUND Variable is not found, OUT parameters are not valid
**/ **/
EFI_STATUS EFI_STATUS
EfiLibHiiVariablePackListGetMapById ( EfiLibHiiVariablePackListGetMapById (
@ -229,15 +224,15 @@ EfiLibHiiVariablePackListGetMapById (
/** /**
Finds a variable form EFI_HII_VARIABLE_PACK_LIST given name and GUID. Finds a variable form EFI_HII_VARIABLE_PACK_LIST given name and GUID.
@param List - List of variables @param List List of variables
@param Name - Name of the variable/map to be found @param Name Name of the variable/map to be found
@param Guid - GUID of the variable/map to be found @param Guid GUID of the variable/map to be found
@param Id - Id of the variable/map to be found @param Id Id of the variable/map to be found
@param Var - Pointer to the variable/map found @param Var Pointer to the variable/map found
@param Size - Size of the variable/map in bytes found @param Size Size of the variable/map in bytes found
@retval EFI_SUCCESS - variable is found, OUT parameters are valid @retval EFI_SUCCESS variable is found, OUT parameters are valid
@retval EFI_NOT_FOUND - variable is not found, OUT parameters are not valid @retval EFI_NOT_FOUND variable is not found, OUT parameters are not valid
**/ **/
EFI_STATUS EFI_STATUS
EfiLibHiiVariablePackListGetMap ( EfiLibHiiVariablePackListGetMap (
@ -279,12 +274,12 @@ EfiLibHiiVariablePackListGetMap (
@param Guid Parameters of the variable to retrieve. Must match exactly. @param Guid Parameters of the variable to retrieve. Must match exactly.
@param Size Parameters of the variable to retrieve. Must match exactly. @param Size Parameters of the variable to retrieve. Must match exactly.
@param Var Variable will be retrieved into buffer pointed by this pointer. @param Var Variable will be retrieved into buffer pointed by this pointer.
If pointing to NULL, the buffer will be allocated. Caller is responsible for releasing the buffer. If pointing to NULL, the buffer will be allocated.
Caller is responsible for releasing the buffer.
@retval EFI_SUCCESS - The variable of exact Name/Guid/Size parameters was retrieved and written to Var.
@retval EFI_NOT_FOUND - The variable of this Name/Guid was not found in the NV.
@retval EFI_LOAD_ERROR - The variable in the NV was of different size, or NV API returned error.
@retval EFI_SUCCESS The variable of exact Name/Guid/Size parameters was retrieved and written to Var.
@retval EFI_NOT_FOUND The variable of this Name/Guid was not found in the NV.
@retval EFI_LOAD_ERROR The variable in the NV was of different size, or NV API returned error.
**/ **/
EFI_STATUS EFI_STATUS
EfiLibHiiVariableRetrieveFromNv ( EfiLibHiiVariableRetrieveFromNv (
@ -293,7 +288,6 @@ EfiLibHiiVariableRetrieveFromNv (
IN UINTN Size, IN UINTN Size,
OUT VOID **Var OUT VOID **Var
) )
{ {
EFI_STATUS Status; EFI_STATUS Status;
UINTN SizeNv; UINTN SizeNv;
@ -339,14 +333,16 @@ EfiLibHiiVariableRetrieveFromNv (
provided the variable exists and the GUID and Size matches. provided the variable exists and the GUID and Size matches.
@param Suffix Suffix the Name should end with. @param Suffix Suffix the Name should end with.
@param Name, Guid, Size Parameters of the variable to retrieve. Must match exactly. @param Name Name of the variable to retrieve.
@Param Guid Guid of the variable to retrieve.
@Param Size Parameters of the variable to retrieve.
@param Var Variable will be retrieved into this buffer. @param Var Variable will be retrieved into this buffer.
Caller is responsible for providing storage of exactly Size size in bytes. Caller is responsible for providing storage of exactly Size size in bytes.
@retval EFI_SUCCESS - The variable was overriden with NV variable of same Name/Guid/Size. @retval EFI_SUCCESS The variable was overriden with NV variable of same Name/Guid/Size.
@retval EFI_INVALID_PARAMETER - The name of the variable does not end with <Suffix>. @retval EFI_INVALID_PARAMETER The name of the variable does not end with <Suffix>.
@retval EFI_NOT_FOUND - The variable of this Name/Guid was not found in the NV. @retval EFI_NOT_FOUND The variable of this Name/Guid was not found in the NV.
@retval EFI_LOAD_ERROR - The variable in the NV was of different size, or NV API returned error. @retval EFI_LOAD_ERROR The variable in the NV was of different size, or NV API returned error.
**/ **/
EFI_STATUS EFI_STATUS
EfiLibHiiVariableOverrideIfSuffix ( EfiLibHiiVariableOverrideIfSuffix (
@ -379,15 +375,16 @@ EfiLibHiiVariableOverrideIfSuffix (
will be loaded from NV provided the variable exists and the GUID and Size matches. will be loaded from NV provided the variable exists and the GUID and Size matches.
@param Suffix Suffix the variable will be appended with. @param Suffix Suffix the variable will be appended with.
@param Name, Guid, Size Parameters of the variable to retrieve. Must match exactly. @param Name Parameters of the Name variable to retrieve.
@param Guid Parameters of the Guid variable to retrieve.
@param Size Parameters of the Size variable to retrieve.
@param Var Variable will be retrieved into this buffer. @param Var Variable will be retrieved into this buffer.
Caller is responsible for providing storage of exactly Size size in bytes. Caller is responsible for providing storage of exactly Size size in bytes.
@retval EFI_SUCCESS - The variable was overriden with NV variable of same Name/Guid/Size. @retval EFI_SUCCESS The variable was overriden with NV variable of same Name/Guid/Size.
@retval EFI_NOT_FOUND - The variable of this Name/Guid was not found in the NV. @retval EFI_NOT_FOUND The variable of this Name/Guid was not found in the NV.
@retval EFI_LOAD_ERROR - The variable in the NV was of different size, or NV API returned error. @retval EFI_LOAD_ERROR The variable in the NV was of different size, or NV API returned error.
**/
--*/
EFI_STATUS EFI_STATUS
EfiLibHiiVariableOverrideBySuffix ( EfiLibHiiVariableOverrideBySuffix (
IN CHAR16 *Suffix, IN CHAR16 *Suffix,
@ -396,7 +393,6 @@ EfiLibHiiVariableOverrideBySuffix (
IN UINTN Size, IN UINTN Size,
OUT VOID *Var OUT VOID *Var
) )
{ {
EFI_STATUS Status; EFI_STATUS Status;
CHAR16 *NameSuffixed; CHAR16 *NameSuffixed;