+++ /dev/null
-/** @file\r
- Library Routines to create IFR on-the-fly\r
- \r
-Copyright (c) 2006, Intel Corporation \r
-All rights reserved. This program and the accompanying materials \r
-are licensed and made available under the terms and conditions of the BSD License \r
-which accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \r
- \r
-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
-#include "IfrSupportLibInternal.h"\r
-\r
-/**\r
- Create a formset.\r
- \r
- The form package is a collection of forms that are intended to describe the pages that will be\r
- displayed to the user.\r
- \r
- @param FormSetTitle Title of formset\r
- @param Guid Guid of formset\r
- @param Class Class of formset\r
- @param SubClass Sub class of formset\r
- @param FormBuffer Pointer of the formset created\r
- @param StringBuffer Pointer of FormSetTitile string created\r
- \r
- @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate\r
- @retval EFI_SUCCESS Formset successfully created \r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CreateFormSet (\r
- IN CHAR16 *FormSetTitle,\r
- IN EFI_GUID *Guid,\r
- IN UINT8 Class,\r
- IN UINT8 SubClass,\r
- IN OUT VOID **FormBuffer,\r
- IN OUT VOID **StringBuffer\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EFI_HII_IFR_PACK IfrPack;\r
- FRAMEWORK_EFI_IFR_FORM_SET FormSet;\r
- FRAMEWORK_EFI_IFR_END_FORM_SET EndFormSet;\r
- UINT8 *Destination;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
-\r
- //\r
- // Pre-allocate a buffer sufficient for us to work from.\r
- //\r
- FormBuffer = AllocateZeroPool (DEFAULT_FORM_BUFFER_SIZE);\r
- if (FormBuffer == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- //\r
- // Pre-allocate a buffer sufficient for us to work from.\r
- //\r
- StringBuffer = AllocateZeroPool (DEFAULT_STRING_BUFFER_SIZE);\r
- if (StringBuffer == NULL) {\r
- FreePool (FormBuffer);\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- //\r
- // Add FormSetTitle to the StringBuffer, get FormSetTitle's token\r
- //\r
- GetCurrentLanguage (CurrentLanguage);\r
- Status = AddString (*StringBuffer, CurrentLanguage, FormSetTitle, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- FreePool (FormBuffer);\r
- FreePool (StringBuffer);\r
- return Status;\r
- }\r
-\r
- //\r
- // Initialize the Ifr Package header data\r
- //\r
- IfrPack.Header.Length = sizeof (EFI_HII_PACK_HEADER) + sizeof (FRAMEWORK_EFI_IFR_FORM_SET) + sizeof (FRAMEWORK_EFI_IFR_END_FORM_SET);\r
- IfrPack.Header.Type = EFI_HII_IFR;\r
-\r
- //\r
- // Initialize FormSet with the appropriate information\r
- //\r
- FormSet.Header.OpCode = FRAMEWORK_EFI_IFR_FORM_SET_OP;\r
- FormSet.Header.Length = sizeof (FRAMEWORK_EFI_IFR_FORM_SET);\r
- FormSet.FormSetTitle = StringToken;\r
- FormSet.Class = Class;\r
- FormSet.SubClass = SubClass;\r
- CopyGuid ((GUID *)(VOID *)&FormSet.Guid, Guid);\r
- \r
- //\r
- // Initialize the end formset data\r
- //\r
- EndFormSet.Header.Length = sizeof (FRAMEWORK_EFI_IFR_END_FORM_SET);\r
- EndFormSet.Header.OpCode = FRAMEWORK_EFI_IFR_END_FORM_SET_OP;\r
-\r
- //\r
- // Copy the formset/endformset data to the form buffer\r
- //\r
- Destination = (UINT8 *) *FormBuffer;\r
- CopyMem (Destination, &IfrPack, sizeof (EFI_HII_PACK_HEADER));\r
-\r
- Destination = Destination + sizeof (EFI_HII_PACK_HEADER);\r
- CopyMem (Destination, &FormSet, sizeof (FRAMEWORK_EFI_IFR_FORM_SET));\r
-\r
- Destination = Destination + sizeof (FRAMEWORK_EFI_IFR_FORM_SET);\r
- CopyMem (Destination, &EndFormSet, sizeof (FRAMEWORK_EFI_IFR_END_FORM_SET));\r
- \r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- Create a form.\r
- A form is the encapsulation of what amounts to a browser page. The header defines a FormId,\r
- which is referenced by the form package, among others. It also defines a FormTitle, which is a\r
- string to be used as the title for the form\r
- \r
- @param FormTitle Title of the form\r
- @param FormId Id of the form\r
- @param FormBuffer Pointer of the form created\r
- @param StringBuffer Pointer of FormTitil string created\r
- \r
- @retval EFI_SUCCESS Form successfully created\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CreateForm (\r
- IN CHAR16 *FormTitle,\r
- IN UINT16 FormId,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
- )\r
-{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_FORM Form;\r
- FRAMEWORK_EFI_IFR_END_FORM EndForm;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
-\r
- //\r
- // Add FormTitle to the StringBuffer, get FormTitle's token\r
- //\r
- GetCurrentLanguage (CurrentLanguage);\r
- Status = AddString (StringBuffer, CurrentLanguage, FormTitle, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- Form.Header.OpCode = FRAMEWORK_EFI_IFR_FORM_OP;\r
- Form.Header.Length = sizeof (FRAMEWORK_EFI_IFR_FORM);\r
- Form.FormId = FormId;\r
- Form.FormTitle = StringToken;\r
-\r
- Status = AddOpCode (FormBuffer, &Form);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- EndForm.Header.OpCode = FRAMEWORK_EFI_IFR_END_FORM_OP;\r
- EndForm.Header.Length = sizeof (FRAMEWORK_EFI_IFR_END_FORM);\r
-\r
- Status = AddOpCode (FormBuffer, &EndForm);\r
- \r
- return Status;\r
-}\r
-\r
-/**\r
- Create a SubTitle.\r
- \r
- Subtitle strings are intended to be used by authors to separate sections of questions into semantic\r
- groups.\r
- \r
- @param SubTitle Sub title to be created\r
- @param FormBuffer Where this subtitle to add to\r
- @param StringBuffer String buffer created for subtitle\r
- \r
- @retval EFI_SUCCESS Subtitle successfully created\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CreateSubTitle (\r
- IN CHAR16 *SubTitle,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
- )\r
-{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_SUBTITLE Subtitle;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
-\r
- //\r
- // Add SubTitle to the StringBuffer, get SubTitle's token\r
- //\r
- GetCurrentLanguage (CurrentLanguage);\r
- Status = AddString (StringBuffer, CurrentLanguage, SubTitle, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- Subtitle.Header.OpCode = FRAMEWORK_EFI_IFR_SUBTITLE_OP;\r
- Subtitle.Header.Length = sizeof (FRAMEWORK_EFI_IFR_SUBTITLE);\r
- Subtitle.SubTitle = StringToken;\r
-\r
- Status = AddOpCode (FormBuffer, &Subtitle);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Create a line of text.\r
- Unlike HTML, text is simply another tag. \r
- This tag type enables IFR to be more easily localized.\r
- \r
- @param String First string of the text\r
- @param String2 Second string of the text\r
- @param String3 Help string of the text\r
- @param Flags Flag of the text\r
- @param Key Key of the text\r
- @param FormBuffer The form where this text adds to\r
- @param StringBuffer String buffer created for String, String2 and String3\r
- \r
- @retval EFI_SUCCESS Text successfully created\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CreateText (\r
- IN CHAR16 *String,\r
- IN CHAR16 *String2,\r
- IN CHAR16 *String3,\r
- IN UINT8 Flags,\r
- IN UINT16 Key,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
- )\r
-{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_TEXT Text;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
-\r
- //\r
- // Add first string to the StringBuffer, get first string's token\r
- //\r
- GetCurrentLanguage (CurrentLanguage);\r
- Status = AddString (StringBuffer, CurrentLanguage, String, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- Text.Header.OpCode = FRAMEWORK_EFI_IFR_TEXT_OP;\r
- Text.Header.Length = sizeof (FRAMEWORK_EFI_IFR_TEXT);\r
- Text.Text = StringToken;\r
-\r
- //\r
- // Add second string, get first string's token\r
- //\r
- Status = AddString (StringBuffer, CurrentLanguage, String2, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- Text.TextTwo = StringToken;\r
- Text.Flags = (UINT8) (Flags | FRAMEWORK_EFI_IFR_FLAG_CREATED);\r
- Text.Key = Key;\r
-\r
- //\r
- // Add second string, get first string's token\r
- //\r
- Status = AddString (StringBuffer, CurrentLanguage, String3, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- Text.Help = StringToken;\r
-\r
- Status = AddOpCode (FormBuffer, &Text);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Create a hyperlink.\r
- \r
- @param FormId Form ID of the hyperlink\r
- @param Prompt Prompt of the hyperlink\r
- @param FormBuffer The form where this hyperlink adds to\r
- @param StringBuffer String buffer created for Prompt\r
- \r
- @retval EFI_SUCCESS Hyperlink successfully created \r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CreateGoto (\r
- IN UINT16 FormId,\r
- IN CHAR16 *Prompt,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
- )\r
-{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_REF Hyperlink;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
-\r
- //\r
- // Add Prompt string to the StringBuffer, get Prompt string's token\r
- //\r
- GetCurrentLanguage (CurrentLanguage);\r
- Status = AddString (StringBuffer, CurrentLanguage, Prompt, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- Hyperlink.Header.OpCode = FRAMEWORK_EFI_IFR_REF_OP;\r
- Hyperlink.Header.Length = sizeof (FRAMEWORK_EFI_IFR_REF);\r
- Hyperlink.FormId = FormId;\r
- Hyperlink.Prompt = StringToken;\r
-\r
- Status = AddOpCode (FormBuffer, &Hyperlink);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Create a one-of question with a set of options to choose from. The\r
- OptionsList is a pointer to a null-terminated list of option descriptions.\r
-\r
- @param QuestionId Question ID of the one-of box\r
- @param DataWidth DataWidth of the one-of box\r
- @param Prompt Prompt of the one-of box\r
- @param Help Help 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 The form where this one-of box adds to\r
- @param StringBuffer String buffer created for Prompt, Help and Option strings\r
- \r
- @retval EFI_DEVICE_ERROR DataWidth > 2\r
- @retval EFI_SUCCESS One-Of box successfully created.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CreateOneOf (\r
- IN UINT16 QuestionId,\r
- IN UINT8 DataWidth,\r
- IN CHAR16 *Prompt,\r
- IN CHAR16 *Help,\r
- IN IFR_OPTION *OptionsList,\r
- IN UINTN OptionCount,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
- )\r
-{\r
- EFI_STATUS Status;\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
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
-\r
- //\r
- // We do not create op-code storage widths for one-of in excess of 16 bits for now\r
- //\r
- if (DataWidth > 2) {\r
- return EFI_DEVICE_ERROR;\r
- }\r
-\r
- //\r
- // Add Prompt string to the StringBuffer, get Prompt string's token\r
- //\r
- GetCurrentLanguage (CurrentLanguage);\r
- Status = AddString (StringBuffer, CurrentLanguage, Prompt, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- OneOf.Header.OpCode = FRAMEWORK_EFI_IFR_ONE_OF_OP;\r
- OneOf.Header.Length = sizeof (FRAMEWORK_EFI_IFR_ONE_OF);\r
- OneOf.QuestionId = QuestionId;\r
- OneOf.Width = DataWidth;\r
- OneOf.Prompt = StringToken;\r
-\r
- //\r
- // Add Help string to the StringBuffer, get Help string's token\r
- //\r
- Status = AddString (StringBuffer, CurrentLanguage, Help, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- OneOf.Help = StringToken;\r
-\r
- Status = AddOpCode (FormBuffer, &OneOf);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- for (Index = 0; Index < OptionCount; Index++) {\r
- OneOfOption.Header.OpCode = FRAMEWORK_EFI_IFR_ONE_OF_OPTION_OP;\r
- OneOfOption.Header.Length = sizeof (FRAMEWORK_EFI_IFR_ONE_OF_OPTION);\r
-\r
- //\r
- // Add OptionString string to the StringBuffer, get OptionString string's token\r
- //\r
- Status = AddString (StringBuffer, CurrentLanguage, OptionsList[Index].OptionString, &StringToken);\r
-\r
- OneOfOption.Option = StringToken;\r
- OneOfOption.Value = OptionsList[Index].Value;\r
- OneOfOption.Flags = (UINT8) (OptionsList[Index].Flags | FRAMEWORK_EFI_IFR_FLAG_CREATED);\r
- OneOfOption.Key = OptionsList[Index].Key;\r
-\r
- Status = AddOpCode (FormBuffer, &OneOfOption);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
- }\r
-\r
- EndOneOf.Header.Length = sizeof (FRAMEWORK_EFI_IFR_END_ONE_OF);\r
- EndOneOf.Header.OpCode = FRAMEWORK_EFI_IFR_END_ONE_OF_OP;\r
-\r
- Status = AddOpCode (FormBuffer, &EndOneOf);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- Create a one-of question with a set of options to choose from. The\r
- OptionsList is a pointer to a null-terminated list of option descriptions.\r
- \r
- @param QuestionId Question ID of the ordered list\r
- @param MaxEntries MaxEntries of the ordered list\r
- @param Prompt Prompt of the ordered list\r
- @param Help Help 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 The form where this ordered list adds to\r
- @param StringBuffer String buffer created for Prompt, Help and Option strings\r
- \r
- @retval EFI_SUCCESS Ordered list successfully created.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CreateOrderedList (\r
- IN UINT16 QuestionId,\r
- IN UINT8 MaxEntries,\r
- IN CHAR16 *Prompt,\r
- IN CHAR16 *Help,\r
- IN IFR_OPTION *OptionsList,\r
- IN UINTN OptionCount,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
- )\r
-{\r
- EFI_STATUS Status;\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
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
-\r
- //\r
- // Add Prompt string to the StringBuffer, get Prompt string's token\r
- //\r
- GetCurrentLanguage (CurrentLanguage);\r
- Status = AddString (StringBuffer, CurrentLanguage, Prompt, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\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 = StringToken;\r
-\r
- //\r
- // Add Help string to the StringBuffer, get Help string's token\r
- //\r
- Status = AddString (StringBuffer, CurrentLanguage, Help, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- OrderedList.Help = StringToken;\r
-\r
- Status = AddOpCode (FormBuffer, &OrderedList);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- for (Index = 0; Index < OptionCount; Index++) {\r
- OrderedListOption.Header.OpCode = FRAMEWORK_EFI_IFR_ONE_OF_OPTION_OP;\r
- OrderedListOption.Header.Length = sizeof (FRAMEWORK_EFI_IFR_ONE_OF_OPTION);\r
-\r
- //\r
- // Add OptionString string to the StringBuffer, get OptionString string's token\r
- //\r
- Status = AddString (StringBuffer, CurrentLanguage, OptionsList[Index].OptionString, &StringToken);\r
-\r
- OrderedListOption.Option = StringToken;\r
- OrderedListOption.Value = OptionsList[Index].Value;\r
- OrderedListOption.Flags = (UINT8) (OptionsList[Index].Flags | FRAMEWORK_EFI_IFR_FLAG_CREATED);\r
- OrderedListOption.Key = OptionsList[Index].Key;\r
-\r
- Status = AddOpCode (FormBuffer, &OrderedListOption);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
- }\r
-\r
- EndOrderedList.Header.Length = sizeof (FRAMEWORK_EFI_IFR_END_ONE_OF);\r
- EndOrderedList.Header.OpCode = FRAMEWORK_EFI_IFR_END_ONE_OF_OP;\r
-\r
- Status = AddOpCode (FormBuffer, &EndOrderedList);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Create a checkbox.\r
- \r
- @param QuestionId Question ID of the check box\r
- @param DataWidth DataWidth of the check box\r
- @param Prompt Prompt of the check box\r
- @param Help Help of the check box \r
- @param Flags Flags of the check box\r
- @param FormBuffer The form where this check box adds to\r
- @param StringBuffer String buffer created for Prompt and Help.\r
- \r
- @retval EFI_DEVICE_ERROR DataWidth > 1\r
- @retval EFI_SUCCESS Check box successfully created\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CreateCheckBox (\r
- IN UINT16 QuestionId,\r
- IN UINT8 DataWidth,\r
- IN CHAR16 *Prompt,\r
- IN CHAR16 *Help,\r
- IN UINT8 Flags,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
- )\r
-{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_CHECKBOX CheckBox;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
-\r
- //\r
- // We do not create op-code storage widths for checkbox in excess of 8 bits for now\r
- //\r
- if (DataWidth > 1) {\r
- return EFI_DEVICE_ERROR;\r
- }\r
-\r
- //\r
- // Add Prompt string to the StringBuffer, get Prompt string's token\r
- //\r
- GetCurrentLanguage (CurrentLanguage);\r
- Status = AddString (StringBuffer, CurrentLanguage, Prompt, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- CheckBox.Header.OpCode = FRAMEWORK_EFI_IFR_CHECKBOX_OP;\r
- CheckBox.Header.Length = sizeof (FRAMEWORK_EFI_IFR_CHECKBOX);\r
- CheckBox.QuestionId = QuestionId;\r
- CheckBox.Width = DataWidth;\r
- CheckBox.Prompt = StringToken;\r
-\r
- //\r
- // Add Help string to the StringBuffer, get Help string's token\r
- //\r
- Status = AddString (StringBuffer, CurrentLanguage, Help, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- CheckBox.Help = StringToken;\r
- CheckBox.Flags = (UINT8) (Flags | FRAMEWORK_EFI_IFR_FLAG_CREATED);\r
-\r
- Status = AddOpCode (FormBuffer, &CheckBox);\r
- \r
- return Status;\r
-}\r
-\r
-/**\r
- Create a numeric.\r
- \r
- @param QuestionId Question ID of the numeric\r
- @param DataWidth DataWidth of the numeric\r
- @param Prompt Prompt of the numeric\r
- @param Help Help 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\r
- @param Flags Flags of the numeric\r
- @param Key Key of the numeric\r
- @param FormBuffer The form where this numeric adds to\r
- @param StringBuffer String buffer created for Prompt and Help.\r
-\r
- @retval EFI_DEVICE_ERROR DataWidth > 2\r
- @retval EFI_SUCCESS Numeric is successfully created \r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CreateNumeric (\r
- IN UINT16 QuestionId,\r
- IN UINT8 DataWidth,\r
- IN CHAR16 *Prompt,\r
- IN CHAR16 *Help,\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 OUT VOID *StringBuffer\r
- )\r
-{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_NUMERIC Numeric;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
-\r
- //\r
- // We do not create op-code storage widths for numerics in excess of 16 bits for now\r
- //\r
- if (DataWidth > 2) {\r
- return EFI_DEVICE_ERROR;\r
- }\r
-\r
- //\r
- // Add Prompt string to the StringBuffer, get Prompt string's token\r
- //\r
- GetCurrentLanguage (CurrentLanguage);\r
- Status = AddString (StringBuffer, CurrentLanguage, Prompt, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- Numeric.Header.OpCode = FRAMEWORK_EFI_IFR_NUMERIC_OP;\r
- Numeric.Header.Length = sizeof (FRAMEWORK_EFI_IFR_NUMERIC);\r
- Numeric.QuestionId = QuestionId;\r
- Numeric.Width = DataWidth;\r
- Numeric.Prompt = StringToken;\r
-\r
- //\r
- // Add Help string to the StringBuffer, get Help string's token\r
- //\r
- Status = AddString (StringBuffer, CurrentLanguage, Help, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- Numeric.Help = StringToken;\r
- Numeric.Minimum = Minimum;\r
- Numeric.Maximum = Maximum;\r
- Numeric.Step = Step;\r
- Numeric.Default = Default;\r
- Numeric.Flags = (UINT8) (Flags | FRAMEWORK_EFI_IFR_FLAG_CREATED);\r
- Numeric.Key = Key;\r
-\r
- Status = AddOpCode (FormBuffer, &Numeric);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Create a string.\r
- \r
- @param QuestionId Question ID of the string\r
- @param DataWidth DataWidth of the string\r
- @param Prompt Prompt of the string\r
- @param Help Help 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 The form where this string adds to\r
- @param StringBuffer String buffer created for Prompt and Help.\r
- \r
- @retval EFI_SUCCESS String successfully created. \r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CreateString (\r
- IN UINT16 QuestionId,\r
- IN UINT8 DataWidth,\r
- IN CHAR16 *Prompt,\r
- IN CHAR16 *Help,\r
- IN UINT8 MinSize,\r
- IN UINT8 MaxSize,\r
- IN UINT8 Flags,\r
- IN UINT16 Key,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
- )\r
-{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_STRING String;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
-\r
- //\r
- // Add Prompt string to the StringBuffer, get Prompt string's token\r
- //\r
- GetCurrentLanguage (CurrentLanguage);\r
- Status = AddString (StringBuffer, CurrentLanguage, Prompt, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\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 = StringToken;\r
-\r
- //\r
- // Add Help string to the StringBuffer, get Help string's token\r
- //\r
- Status = AddString (StringBuffer, CurrentLanguage, Help, &StringToken);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- String.Help = StringToken;\r
- String.MinSize = MinSize;\r
- String.MaxSize = MaxSize;\r
- String.Flags = (UINT8) (Flags | FRAMEWORK_EFI_IFR_FLAG_CREATED);\r
- String.Key = Key;\r
-\r
- Status = AddOpCode (FormBuffer, &String);\r
-\r
- return Status;\r
-}\r
-\r
projects / mirror_edk2.git / blobdiff