THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
-\r
**/\r
\r
#include "IfrSupportLibInternal.h"\r
\r
/**\r
- Create a SubTitle opcode independent of string creation\r
+ Create a SubTitle opcode independent of string creation.\r
This is used primarily by users who need to create just one particular valid op-code and the string\r
data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label\r
location to pre-defined forms in HII)\r
\r
- @param StringToken StringToken of the subtitle\r
- @param FormBuffer Output of subtitle as a form\r
+ @param StringToken StringToken of the subtitle\r
+ @param FormBuffer Output of subtitle as a form\r
\r
- @retval EFI_SUCCESS Subtitle created to be a form\r
+ @retval EFI_SUCCESS Subtitle created to be a form\r
**/\r
EFI_STATUS\r
CreateSubTitleOpCode (\r
- IN STRING_REF StringToken,\r
- IN OUT VOID *FormBuffer\r
+ IN STRING_REF StringToken,\r
+ IN OUT VOID *FormBuffer\r
)\r
{\r
- FRAMEWORK_EFI_IFR_SUBTITLE Subtitle;\r
+ FRAMEWORK_EFI_IFR_SUBTITLE Subtitle;\r
\r
Subtitle.Header.OpCode = FRAMEWORK_EFI_IFR_SUBTITLE_OP;\r
Subtitle.Header.Length = sizeof (FRAMEWORK_EFI_IFR_SUBTITLE);\r
}\r
\r
/**\r
- Create a Text opcode independent of string creation\r
+ Create a Text opcode independent of string creation.\r
+ \r
This is used primarily by users who need to create just one particular valid op-code and the string\r
data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label\r
location to pre-defined forms in HII)\r
\r
- @param StringToken - First string token of the text\r
- @param StringTokenTwo - Second string token of the text\r
- @param StringTokenThree - Help string token of the text\r
- @param Flags - Flag of the text\r
- @param Key - Key of the text\r
- @param FormBuffer - Output of text as a form\r
+ @param StringToken First string token of the text\r
+ @param StringTokenTwo Second string token of the text\r
+ @param StringTokenThree Help string token of the text\r
+ @param Flags Flag of the text\r
+ @param Key Key of the text\r
+ @param FormBuffer Output of text as a form\r
\r
- @retval EFI_SUCCESS - Text created to be a form\r
+ @retval EFI_SUCCESS Text created to be a form\r
**/\r
EFI_STATUS\r
CreateTextOpCode (\r
- IN STRING_REF StringToken,\r
- IN STRING_REF StringTokenTwo,\r
- IN STRING_REF StringTokenThree,\r
- IN UINT8 Flags,\r
- IN UINT16 Key,\r
- IN OUT VOID *FormBuffer\r
+ IN STRING_REF StringToken,\r
+ IN STRING_REF StringTokenTwo,\r
+ IN STRING_REF StringTokenThree,\r
+ IN UINT8 Flags,\r
+ IN UINT16 Key,\r
+ IN OUT VOID *FormBuffer\r
)\r
{\r
- FRAMEWORK_EFI_IFR_TEXT Text;\r
+ FRAMEWORK_EFI_IFR_TEXT Text;\r
\r
Text.Header.OpCode = FRAMEWORK_EFI_IFR_TEXT_OP;\r
Text.Header.Length = sizeof (FRAMEWORK_EFI_IFR_TEXT);\r
}\r
\r
/**\r
- Create a hyperlink opcode independent of string creation\r
+ Create a hyperlink opcode independent of string creation.\r
+ \r
This is used primarily by users who need to create just one particular valid op-code and the string\r
data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label\r
location to pre-defined forms in HII)\r
\r
-\r
- @param FormId - Form ID of the hyperlink\r
- @param StringToken - Prompt string token of the hyperlink\r
- @param StringTokenTwo - Help string token of the hyperlink\r
- @param Flags - Flags of the hyperlink\r
- @param Key - Key of the hyperlink\r
- @param FormBuffer - Output of hyperlink as a form\r
- @retval EFI_SUCCESS - Hyperlink created to be a form\r
---*/\r
+ @param FormId Form ID of the hyperlink\r
+ @param StringToken Prompt string token of the hyperlink\r
+ @param StringTokenTwo Help string token of the hyperlink\r
+ @param Flags Flags of the hyperlink\r
+ @param Key Key of the hyperlink\r
+ @param FormBuffer Output of hyperlink as a form\r
+ \r
+ @retval EFI_SUCCESS Hyperlink created to be a form\r
+**/\r
EFI_STATUS\r
CreateGotoOpCode (\r
- IN UINT16 FormId,\r
- IN STRING_REF StringToken,\r
- IN STRING_REF StringTokenTwo,\r
- IN UINT8 Flags,\r
- IN UINT16 Key,\r
- IN OUT VOID *FormBuffer\r
+ IN UINT16 FormId,\r
+ IN STRING_REF StringToken,\r
+ IN STRING_REF StringTokenTwo,\r
+ IN UINT8 Flags,\r
+ IN UINT16 Key,\r
+ IN OUT VOID *FormBuffer\r
)\r
-\r
{\r
- FRAMEWORK_EFI_IFR_REF Hyperlink;\r
+ FRAMEWORK_EFI_IFR_REF Hyperlink;\r
\r
Hyperlink.Header.OpCode = FRAMEWORK_EFI_IFR_REF_OP;\r
Hyperlink.Header.Length = sizeof (FRAMEWORK_EFI_IFR_REF);\r
OptionsList is a pointer to a null-terminated list of option descriptions. Ensure that OptionsList[x].StringToken\r
has been filled in since this routine will not generate StringToken values.\r
\r
- @param QuestionId - Question ID of the one-of box\r
- @param DataWidth - DataWidth of the one-of box\r
- @param PromptToken - Prompt string token of the one-of box\r
- @param HelpToken - Help string token of the one-of box\r
- @param OptionsList - Each string in it is an option of the one-of box\r
- @param OptionCount - Option string count\r
- @param FormBuffer - Output of One-Of box as a form\r
+ @param QuestionId Question ID of the one-of box\r
+ @param DataWidth DataWidth of the one-of box\r
+ @param PromptToken Prompt string token of the one-of box\r
+ @param HelpToken Help string token of the one-of box\r
+ @param OptionsList Each string in it is an option of the one-of box\r
+ @param OptionCount Option string count\r
+ @param FormBuffer Output of One-Of box as a form\r
\r
\r
- @retval EFI_SUCCESS - One-Of box created to be a form\r
- @retval EFI_DEVICE_ERROR - DataWidth > 2\r
+ @retval EFI_SUCCESS One-Of box created to be a form\r
+ @retval EFI_DEVICE_ERROR DataWidth > 2\r
**/\r
EFI_STATUS\r
CreateOneOfOpCode (\r
- IN UINT16 QuestionId,\r
- IN UINT8 DataWidth,\r
- IN STRING_REF PromptToken,\r
- IN STRING_REF HelpToken,\r
- IN IFR_OPTION *OptionsList,\r
- IN UINTN OptionCount,\r
- IN OUT VOID *FormBuffer\r
+ IN UINT16 QuestionId,\r
+ IN UINT8 DataWidth,\r
+ IN STRING_REF PromptToken,\r
+ IN STRING_REF HelpToken,\r
+ IN IFR_OPTION *OptionsList,\r
+ IN UINTN OptionCount,\r
+ IN OUT VOID *FormBuffer\r
)\r
{\r
- UINTN Index;\r
- FRAMEWORK_EFI_IFR_ONE_OF OneOf;\r
- FRAMEWORK_EFI_IFR_ONE_OF_OPTION OneOfOption;\r
- FRAMEWORK_EFI_IFR_END_ONE_OF EndOneOf;\r
- UINT8 *LocalBuffer;\r
+ UINTN Index;\r
+ FRAMEWORK_EFI_IFR_ONE_OF OneOf;\r
+ FRAMEWORK_EFI_IFR_ONE_OF_OPTION OneOfOption;\r
+ FRAMEWORK_EFI_IFR_END_ONE_OF EndOneOf;\r
+ UINT8 *LocalBuffer;\r
\r
//\r
// We do not create op-code storage widths for one-of in excess of 16 bits for now\r
OneOf.QuestionId = QuestionId;\r
OneOf.Width = DataWidth;\r
OneOf.Prompt = PromptToken;\r
-\r
OneOf.Help = HelpToken;\r
-\r
LocalBuffer = (UINT8 *) FormBuffer;\r
\r
CopyMem (LocalBuffer, &OneOf, sizeof (FRAMEWORK_EFI_IFR_ONE_OF));\r
OptionsList is a pointer to a null-terminated list of option descriptions. Ensure that OptionsList[x].StringToken\r
has been filled in since this routine will not generate StringToken values.\r
\r
- @param QuestionId - Question ID of the ordered list\r
- @param MaxEntries - MaxEntries of the ordered list\r
- @param PromptToken - Prompt string token of the ordered list\r
- @param HelpToken - Help string token of the ordered list\r
- @param OptionsList - Each string in it is an option of the ordered list\r
- @param OptionCount - Option string count\r
- @param FormBuffer - Output of ordered list as a form\r
+ @param QuestionId Question ID of the ordered list\r
+ @param MaxEntries MaxEntries of the ordered list\r
+ @param PromptToken Prompt string token of the ordered list\r
+ @param HelpToken Help string token of the ordered list\r
+ @param OptionsList Each string in it is an option of the ordered list\r
+ @param OptionCount Option string count\r
+ @param FormBuffer Output of ordered list as a form\r
\r
- @retval EFI_SUCCESS - Ordered list created to be a form\r
+ @retval EFI_SUCCESS Ordered list created to be a form\r
**/\r
EFI_STATUS\r
CreateOrderedListOpCode (\r
- IN UINT16 QuestionId,\r
- IN UINT8 MaxEntries,\r
- IN STRING_REF PromptToken,\r
- IN STRING_REF HelpToken,\r
- IN IFR_OPTION *OptionsList,\r
- IN UINTN OptionCount,\r
- IN OUT VOID *FormBuffer\r
+ IN UINT16 QuestionId,\r
+ IN UINT8 MaxEntries,\r
+ IN STRING_REF PromptToken,\r
+ IN STRING_REF HelpToken,\r
+ IN IFR_OPTION *OptionsList,\r
+ IN UINTN OptionCount,\r
+ IN OUT VOID *FormBuffer\r
)\r
{\r
- UINTN Index;\r
- FRAMEWORK_EFI_IFR_ORDERED_LIST OrderedList;\r
- FRAMEWORK_EFI_IFR_ONE_OF_OPTION OrderedListOption;\r
- FRAMEWORK_EFI_IFR_END_ONE_OF EndOrderedList;\r
- UINT8 *LocalBuffer;\r
+ UINTN Index;\r
+ FRAMEWORK_EFI_IFR_ORDERED_LIST OrderedList;\r
+ FRAMEWORK_EFI_IFR_ONE_OF_OPTION OrderedListOption;\r
+ FRAMEWORK_EFI_IFR_END_ONE_OF EndOrderedList;\r
+ UINT8 *LocalBuffer;\r
\r
OrderedList.Header.OpCode = FRAMEWORK_EFI_IFR_ORDERED_LIST_OP;\r
OrderedList.Header.Length = sizeof (FRAMEWORK_EFI_IFR_ORDERED_LIST);\r
OrderedList.QuestionId = QuestionId;\r
OrderedList.MaxEntries = MaxEntries;\r
OrderedList.Prompt = PromptToken;\r
-\r
OrderedList.Help = HelpToken;\r
-\r
LocalBuffer = (UINT8 *) FormBuffer;\r
\r
CopyMem (LocalBuffer, &OrderedList, sizeof (FRAMEWORK_EFI_IFR_ORDERED_LIST));\r
}\r
\r
/**\r
- Create a checkbox opcode independent of string creation\r
+ Create a checkbox opcode independent of string creation.\r
This is used primarily by users who need to create just one particular valid op-code and the string\r
data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label\r
location to pre-defined forms in HII)\r
\r
- @param QuestionId - Question ID of the check box\r
- @param DataWidth - DataWidth of the check box\r
- @param PromptToken - Prompt string token of the check box\r
- @param HelpToken - Help string token of the check box\r
- @param Flags - Flags of the check box\r
- @param Key - Key of the check box\r
- @param FormBuffer - Output of the check box as a form\r
+ @param QuestionId Question ID of the check box\r
+ @param DataWidth DataWidth of the check box\r
+ @param PromptToken Prompt string token of the check box\r
+ @param HelpToken Help string token of the check box\r
+ @param Flags Flags of the check box\r
+ @param Key Key of the check box\r
+ @param FormBuffer Output of the check box as a form\r
\r
- @retval EFI_SUCCESS - Checkbox created to be a form\r
- @retval EFI_DEVICE_ERROR - DataWidth > 1\r
+ @retval EFI_SUCCESS Checkbox created to be a form\r
+ @retval EFI_DEVICE_ERROR DataWidth > 1\r
**/\r
EFI_STATUS\r
CreateCheckBoxOpCode (\r
- IN UINT16 QuestionId,\r
- IN UINT8 DataWidth,\r
- IN STRING_REF PromptToken,\r
- IN STRING_REF HelpToken,\r
- IN UINT8 Flags,\r
- IN UINT16 Key,\r
- IN OUT VOID *FormBuffer\r
+ IN UINT16 QuestionId,\r
+ IN UINT8 DataWidth,\r
+ IN STRING_REF PromptToken,\r
+ IN STRING_REF HelpToken,\r
+ IN UINT8 Flags,\r
+ IN UINT16 Key,\r
+ IN OUT VOID *FormBuffer\r
)\r
-\r
{\r
- FRAMEWORK_EFI_IFR_CHECKBOX CheckBox;\r
+ FRAMEWORK_EFI_IFR_CHECKBOX CheckBox;\r
\r
//\r
// We do not create op-code storage widths for checkbox in excess of 8 bits for now\r
CheckBox.QuestionId = QuestionId;\r
CheckBox.Width = DataWidth;\r
CheckBox.Prompt = PromptToken;\r
-\r
CheckBox.Help = HelpToken;\r
CheckBox.Flags = Flags;\r
CheckBox.Key = Key;\r
}\r
\r
/**\r
- Create a numeric opcode independent of string creation\r
+ Create a numeric opcode independent of string creation.\r
This is used primarily by users who need to create just one particular valid op-code and the string\r
data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label\r
location to pre-defined forms in HII)\r
\r
- @param QuestionId - Question ID of the numeric\r
- @param DataWidth - DataWidth of the numeric\r
- @param PromptToken - Prompt string token of the numeric\r
- @param HelpToken - Help string token of the numeric\r
- @param Minimum - Minumun boundary of the numeric\r
- @param Maximum - Maximum boundary of the numeric\r
- @param Step - Step of the numeric\r
- @param Default - Default value of the numeric\r
- @param Flags - Flags of the numeric\r
- @param Key - Key of the numeric\r
- @param FormBuffer - Output of the numeric as a form\r
+ @param QuestionId Question ID of the numeric\r
+ @param DataWidth DataWidth of the numeric\r
+ @param PromptToken Prompt string token of the numeric\r
+ @param HelpToken Help string token of the numeric\r
+ @param Minimum Minumun boundary of the numeric\r
+ @param Maximum Maximum boundary of the numeric\r
+ @param Step Step of the numeric\r
+ @param Default Default value of the numeric\r
+ @param Flags Flags of the numeric\r
+ @param Key Key of the numeric\r
+ @param FormBuffer Output of the numeric as a form\r
\r
\r
- @retval EFI_SUCCESS - The numeric created to be a form.\r
- @retval EFI_DEVICE_ERROR - DataWidth > 2\r
+ @retval EFI_SUCCESS The numeric created to be a form.\r
+ @retval EFI_DEVICE_ERROR DataWidth > 2\r
**/\r
EFI_STATUS\r
CreateNumericOpCode (\r
- IN UINT16 QuestionId,\r
- IN UINT8 DataWidth,\r
- IN STRING_REF PromptToken,\r
- IN STRING_REF HelpToken,\r
- IN UINT16 Minimum,\r
- IN UINT16 Maximum,\r
- IN UINT16 Step,\r
- IN UINT16 Default,\r
- IN UINT8 Flags,\r
- IN UINT16 Key,\r
- IN OUT VOID *FormBuffer\r
+ IN UINT16 QuestionId,\r
+ IN UINT8 DataWidth,\r
+ IN STRING_REF PromptToken,\r
+ IN STRING_REF HelpToken,\r
+ IN UINT16 Minimum,\r
+ IN UINT16 Maximum,\r
+ IN UINT16 Step,\r
+ IN UINT16 Default,\r
+ IN UINT8 Flags,\r
+ IN UINT16 Key,\r
+ IN OUT VOID *FormBuffer\r
)\r
-\r
{\r
- FRAMEWORK_EFI_IFR_NUMERIC Numeric;\r
+ FRAMEWORK_EFI_IFR_NUMERIC Numeric;\r
\r
//\r
// We do not create op-code storage widths for numerics in excess of 16 bits for now\r
Numeric.QuestionId = QuestionId;\r
Numeric.Width = DataWidth;\r
Numeric.Prompt = PromptToken;\r
-\r
Numeric.Help = HelpToken;\r
Numeric.Minimum = Minimum;\r
Numeric.Maximum = Maximum;\r
}\r
\r
/**\r
- Create a numeric opcode independent of string creation\r
+ Create a numeric opcode independent of string creation.\r
This is used primarily by users who need to create just one particular valid op-code and the string\r
data will be assumed to exist in the HiiDatabase already. (Useful when exporting op-codes at a label\r
location to pre-defined forms in HII)\r
\r
- @param QuestionId Question ID of the string\r
- @param DataWidth DataWidth of the string\r
- @param PromptToken Prompt token of the string\r
- @param HelpToken Help token of the string\r
- @param MinSize Min size boundary of the string\r
- @param MaxSize Max size boundary of the string\r
- @param Flags Flags of the string\r
- @param Key Key of the string\r
- @param FormBuffer Output of the string as a form\r
+ @param QuestionId Question ID of the string\r
+ @param DataWidth DataWidth of the string\r
+ @param PromptToken Prompt token of the string\r
+ @param HelpToken Help token of the string\r
+ @param MinSize Min size boundary of the string\r
+ @param MaxSize Max size boundary of the string\r
+ @param Flags Flags of the string\r
+ @param Key Key of the string\r
+ @param FormBuffer Output of the string as a form\r
\r
- @retval EFI_SUCCESS String created to be a form.\r
+ @retval EFI_SUCCESS String created to be a form.\r
**/\r
EFI_STATUS\r
CreateStringOpCode (\r
- IN UINT16 QuestionId,\r
- IN UINT8 DataWidth,\r
- IN STRING_REF PromptToken,\r
- IN STRING_REF HelpToken,\r
- IN UINT8 MinSize,\r
- IN UINT8 MaxSize,\r
- IN UINT8 Flags,\r
- IN UINT16 Key,\r
- IN OUT VOID *FormBuffer\r
+ IN UINT16 QuestionId,\r
+ IN UINT8 DataWidth,\r
+ IN STRING_REF PromptToken,\r
+ IN STRING_REF HelpToken,\r
+ IN UINT8 MinSize,\r
+ IN UINT8 MaxSize,\r
+ IN UINT8 Flags,\r
+ IN UINT16 Key,\r
+ IN OUT VOID *FormBuffer\r
)\r
-\r
{\r
- FRAMEWORK_EFI_IFR_STRING String;\r
+ FRAMEWORK_EFI_IFR_STRING String;\r
\r
String.Header.OpCode = FRAMEWORK_EFI_IFR_STRING_OP;\r
String.Header.Length = sizeof (FRAMEWORK_EFI_IFR_STRING);\r
String.QuestionId = QuestionId;\r
String.Width = DataWidth;\r
String.Prompt = PromptToken;\r
-\r
String.Help = HelpToken;\r
String.MinSize = MinSize;\r
String.MaxSize = MaxSize;\r
/**\r
Create a banner opcode. This is primarily used by the FrontPage implementation from BDS.\r
\r
- @param Title - Title of the banner\r
- @param LineNumber - LineNumber of the banner\r
- @param Alignment - Alignment of the banner\r
- @param FormBuffer - Output of banner as a form\r
+ @param Title Title of the banner\r
+ @param LineNumber LineNumber of the banner\r
+ @param Alignment Alignment of the banner\r
+ @param FormBuffer Output of banner as a form\r
\r
- @retval EFI_SUCCESS - Banner created to be a form.\r
+ @retval EFI_SUCCESS Banner created to be a form.\r
**/\r
EFI_STATUS\r
CreateBannerOpCode (\r
- IN UINT16 Title,\r
- IN UINT16 LineNumber,\r
- IN UINT8 Alignment,\r
- IN OUT VOID *FormBuffer\r
+ IN UINT16 Title,\r
+ IN UINT16 LineNumber,\r
+ IN UINT8 Alignment,\r
+ IN OUT VOID *FormBuffer\r
)\r
-\r
{\r
- FRAMEWORK_EFI_IFR_BANNER Banner;\r
+ FRAMEWORK_EFI_IFR_BANNER Banner;\r
\r
Banner.Header.OpCode = FRAMEWORK_EFI_IFR_BANNER_OP;\r
Banner.Header.Length = sizeof (FRAMEWORK_EFI_IFR_BANNER);\r
projects / mirror_edk2.git / blobdiff