Modify all file header to follow doxygen format

[mirror_edk2.git] / IntelFrameworkPkg / Library / FrameworkIfrSupportLib / IfrOnTheFly.c

diff --git a/IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrOnTheFly.c b/IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrOnTheFly.c
index ee99bfafe4e90f8dd67872bd1e5e54c727e46945..db4f52f73b89ea52e53ccd3d49ffa1acba3fe08c 100644 (file)
--- a/IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrOnTheFly.c
+++ b/IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrOnTheFly.c
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\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
@@ -17,12 +17,12 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 //\r
 // Include common header file for this module.\r
 //\r
-#include "CommonHeader.h"\r
+#include "IfrSupportLibInternal.h"\r
 \r
 EFI_STATUS\r
 CreateFormSet (\r
@@ -63,8 +63,8 @@ Returns:
 {\r
   EFI_STATUS            Status;\r
   EFI_HII_IFR_PACK      IfrPack;\r
-  EFI_IFR_FORM_SET      FormSet;\r
-  EFI_IFR_END_FORM_SET  EndFormSet;\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
@@ -103,14 +103,14 @@ Returns:
   //\r
   // Initialize the Ifr Package header data\r
   //\r
-  IfrPack.Header.Length = sizeof (EFI_HII_PACK_HEADER) + sizeof (EFI_IFR_FORM_SET) + sizeof (EFI_IFR_END_FORM_SET);\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 = EFI_IFR_FORM_SET_OP;\r
-  FormSet.Header.Length = sizeof (EFI_IFR_FORM_SET);\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
@@ -119,8 +119,8 @@ Returns:
   //\r
   // Initialize the end formset data\r
   //\r
-  EndFormSet.Header.Length  = sizeof (EFI_IFR_END_FORM_SET);\r
-  EndFormSet.Header.OpCode  = EFI_IFR_END_FORM_SET_OP;\r
+  EndFormSet.Header.Length  = sizeof (FRAMEWORK_EFI_IFR_END_FORM_SET);\r
+  EndFormSet.Header.OpCode  = FRAMEWORK_EFI_IFR_END_FORM_SET_OP;\r
 \r
   Destination               = (UINT8 *) *FormBuffer;\r
 \r
@@ -131,11 +131,11 @@ Returns:
 \r
   Destination = Destination + sizeof (EFI_HII_PACK_HEADER);\r
 \r
-  CopyMem (Destination, &FormSet, sizeof (EFI_IFR_FORM_SET));\r
+  CopyMem (Destination, &FormSet, sizeof (FRAMEWORK_EFI_IFR_FORM_SET));\r
 \r
-  Destination = Destination + sizeof (EFI_IFR_FORM_SET);\r
+  Destination = Destination + sizeof (FRAMEWORK_EFI_IFR_FORM_SET);\r
 \r
-  CopyMem (Destination, &EndFormSet, sizeof (EFI_IFR_END_FORM_SET));\r
+  CopyMem (Destination, &EndFormSet, sizeof (FRAMEWORK_EFI_IFR_END_FORM_SET));\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -170,8 +170,8 @@ Returns:
 --*/\r
 {\r
   EFI_STATUS        Status;\r
-  EFI_IFR_FORM      Form;\r
-  EFI_IFR_END_FORM  EndForm;\r
+  FRAMEWORK_EFI_IFR_FORM      Form;\r
+  FRAMEWORK_EFI_IFR_END_FORM  EndForm;\r
   CHAR16            CurrentLanguage[4];\r
   STRING_REF        StringToken;\r
 \r
@@ -186,8 +186,8 @@ Returns:
     return Status;\r
   }\r
 \r
-  Form.Header.OpCode  = EFI_IFR_FORM_OP;\r
-  Form.Header.Length  = sizeof (EFI_IFR_FORM);\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
@@ -197,8 +197,8 @@ Returns:
     return Status;\r
   }\r
 \r
-  EndForm.Header.OpCode = EFI_IFR_END_FORM_OP;\r
-  EndForm.Header.Length = sizeof (EFI_IFR_END_FORM);\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
@@ -237,7 +237,7 @@ Returns:
 --*/\r
 {\r
   EFI_STATUS        Status;\r
-  EFI_IFR_SUBTITLE  Subtitle;\r
+  FRAMEWORK_EFI_IFR_SUBTITLE  Subtitle;\r
   CHAR16            CurrentLanguage[4];\r
   STRING_REF        StringToken;\r
 \r
@@ -252,8 +252,8 @@ Returns:
     return Status;\r
   }\r
 \r
-  Subtitle.Header.OpCode  = EFI_IFR_SUBTITLE_OP;\r
-  Subtitle.Header.Length  = sizeof (EFI_IFR_SUBTITLE);\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
@@ -305,7 +305,7 @@ Returns:
 --*/\r
 {\r
   EFI_STATUS    Status;\r
-  EFI_IFR_TEXT  Text;\r
+  FRAMEWORK_EFI_IFR_TEXT  Text;\r
   CHAR16        CurrentLanguage[4];\r
   STRING_REF    StringToken;\r
 \r
@@ -323,8 +323,8 @@ Returns:
     return Status;\r
   }\r
 \r
-  Text.Header.OpCode  = EFI_IFR_TEXT_OP;\r
-  Text.Header.Length  = sizeof (EFI_IFR_TEXT);\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
@@ -338,7 +338,7 @@ Returns:
 \r
   Text.TextTwo  = StringToken;\r
 \r
-  Text.Flags    = (UINT8) (Flags | EFI_IFR_FLAG_CREATED);\r
+  Text.Flags    = (UINT8) (Flags | FRAMEWORK_EFI_IFR_FLAG_CREATED);\r
   Text.Key      = Key;\r
 \r
   //\r
@@ -392,7 +392,7 @@ Returns:
 --*/\r
 {\r
   EFI_STATUS  Status;\r
-  EFI_IFR_REF Hyperlink;\r
+  FRAMEWORK_EFI_IFR_REF Hyperlink;\r
   CHAR16      CurrentLanguage[4];\r
   STRING_REF  StringToken;\r
 \r
@@ -407,8 +407,8 @@ Returns:
     return Status;\r
   }\r
 \r
-  Hyperlink.Header.OpCode = EFI_IFR_REF_OP;\r
-  Hyperlink.Header.Length = sizeof (EFI_IFR_REF);\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
@@ -468,9 +468,9 @@ Returns:
 {\r
   EFI_STATUS            Status;\r
   UINTN                 Index;\r
-  EFI_IFR_ONE_OF        OneOf;\r
-  EFI_IFR_ONE_OF_OPTION OneOfOption;\r
-  EFI_IFR_END_ONE_OF    EndOneOf;\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
@@ -495,8 +495,8 @@ Returns:
     return Status;\r
   }\r
 \r
-  OneOf.Header.OpCode = EFI_IFR_ONE_OF_OP;\r
-  OneOf.Header.Length = sizeof (EFI_IFR_ONE_OF);\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
@@ -519,8 +519,8 @@ Returns:
   }\r
 \r
   for (Index = 0; Index < OptionCount; Index++) {\r
-    OneOfOption.Header.OpCode = EFI_IFR_ONE_OF_OPTION_OP;\r
-    OneOfOption.Header.Length = sizeof (EFI_IFR_ONE_OF_OPTION);\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 string and get token back\r
@@ -529,7 +529,7 @@ Returns:
 \r
     OneOfOption.Option  = StringToken;\r
     OneOfOption.Value   = OptionsList[Index].Value;\r
-    OneOfOption.Flags   = (UINT8) (OptionsList[Index].Flags | EFI_IFR_FLAG_CREATED);\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
@@ -539,8 +539,8 @@ Returns:
     }\r
   }\r
 \r
-  EndOneOf.Header.Length  = sizeof (EFI_IFR_END_ONE_OF);\r
-  EndOneOf.Header.OpCode  = EFI_IFR_END_ONE_OF_OP;\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
 \r
@@ -595,9 +595,9 @@ Returns:
 {\r
   EFI_STATUS            Status;\r
   UINTN                 Index;\r
-  EFI_IFR_ORDERED_LIST  OrderedList;\r
-  EFI_IFR_ONE_OF_OPTION OrderedListOption;\r
-  EFI_IFR_END_ONE_OF    EndOrderedList;\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
@@ -615,8 +615,8 @@ Returns:
     return Status;\r
   }\r
 \r
-  OrderedList.Header.OpCode = EFI_IFR_ORDERED_LIST_OP;\r
-  OrderedList.Header.Length = sizeof (EFI_IFR_ORDERED_LIST);\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
@@ -639,8 +639,8 @@ Returns:
   }\r
 \r
   for (Index = 0; Index < OptionCount; Index++) {\r
-    OrderedListOption.Header.OpCode = EFI_IFR_ONE_OF_OPTION_OP;\r
-    OrderedListOption.Header.Length = sizeof (EFI_IFR_ONE_OF_OPTION);\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 string and get token back\r
@@ -649,7 +649,7 @@ Returns:
 \r
     OrderedListOption.Option  = StringToken;\r
     OrderedListOption.Value   = OptionsList[Index].Value;\r
-    OrderedListOption.Flags   = (UINT8) (OptionsList[Index].Flags | EFI_IFR_FLAG_CREATED);\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
@@ -659,8 +659,8 @@ Returns:
     }\r
   }\r
 \r
-  EndOrderedList.Header.Length  = sizeof (EFI_IFR_END_ONE_OF);\r
-  EndOrderedList.Header.OpCode  = EFI_IFR_END_ONE_OF_OP;\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
@@ -713,7 +713,7 @@ Returns:
 --*/\r
 {\r
   EFI_STATUS        Status;\r
-  EFI_IFR_CHECKBOX  CheckBox;\r
+  FRAMEWORK_EFI_IFR_CHECKBOX  CheckBox;\r
   CHAR16            CurrentLanguage[4];\r
   STRING_REF        StringToken;\r
 \r
@@ -738,8 +738,8 @@ Returns:
     return Status;\r
   }\r
 \r
-  CheckBox.Header.OpCode  = EFI_IFR_CHECKBOX_OP;\r
-  CheckBox.Header.Length  = sizeof (EFI_IFR_CHECKBOX);\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
@@ -754,7 +754,7 @@ Returns:
   }\r
 \r
   CheckBox.Help   = StringToken;\r
-  CheckBox.Flags  = (UINT8) (Flags | EFI_IFR_FLAG_CREATED);\r
+  CheckBox.Flags  = (UINT8) (Flags | FRAMEWORK_EFI_IFR_FLAG_CREATED);\r
 \r
   Status          = AddOpCode (FormBuffer, &CheckBox);\r
 \r
@@ -822,7 +822,7 @@ Returns:
 --*/\r
 {\r
   EFI_STATUS      Status;\r
-  EFI_IFR_NUMERIC Numeric;\r
+  FRAMEWORK_EFI_IFR_NUMERIC Numeric;\r
   CHAR16          CurrentLanguage[4];\r
   STRING_REF      StringToken;\r
 \r
@@ -847,8 +847,8 @@ Returns:
     return Status;\r
   }\r
 \r
-  Numeric.Header.OpCode = EFI_IFR_NUMERIC_OP;\r
-  Numeric.Header.Length = sizeof (EFI_IFR_NUMERIC);\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
@@ -867,7 +867,7 @@ Returns:
   Numeric.Maximum = Maximum;\r
   Numeric.Step    = Step;\r
   Numeric.Default = Default;\r
-  Numeric.Flags   = (UINT8) (Flags | EFI_IFR_FLAG_CREATED);\r
+  Numeric.Flags   = (UINT8) (Flags | FRAMEWORK_EFI_IFR_FLAG_CREATED);\r
   Numeric.Key     = Key;\r
 \r
   Status          = AddOpCode (FormBuffer, &Numeric);\r
@@ -928,7 +928,7 @@ Returns:
 --*/\r
 {\r
   EFI_STATUS      Status;\r
-  EFI_IFR_STRING  String;\r
+  FRAMEWORK_EFI_IFR_STRING  String;\r
   CHAR16          CurrentLanguage[4];\r
   STRING_REF      StringToken;\r
 \r
@@ -946,8 +946,8 @@ Returns:
     return Status;\r
   }\r
 \r
-  String.Header.OpCode  = EFI_IFR_STRING_OP;\r
-  String.Header.Length  = sizeof (EFI_IFR_STRING);\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
@@ -964,7 +964,7 @@ Returns:
   String.Help     = StringToken;\r
   String.MinSize  = MinSize;\r
   String.MaxSize  = MaxSize;\r
-  String.Flags    = (UINT8) (Flags | EFI_IFR_FLAG_CREATED);\r
+  String.Flags    = (UINT8) (Flags | FRAMEWORK_EFI_IFR_FLAG_CREATED);\r
   String.Key      = Key;\r
 \r
   Status          = AddOpCode (FormBuffer, &String);\r