Correct typo in comments, clean IfrSupportLib.h

[mirror_edk2.git] / MdeModulePkg / Include / Library / ExtendedIfrSupportLib.h

diff --git a/MdeModulePkg/Include/Library/ExtendedIfrSupportLib.h b/MdeModulePkg/Include/Library/ExtendedIfrSupportLib.h
index 2d8db3b9e23e96160e776b09f44b9b160d3f3b1d..920d0f483c921e7db0dbd4b5f04fdfb1bbdfcfe9 100644 (file)
--- a/MdeModulePkg/Include/Library/ExtendedIfrSupportLib.h
+++ b/MdeModulePkg/Include/Library/ExtendedIfrSupportLib.h
@@ -39,6 +39,39 @@ CreateBannerOpCode (
   IN OUT  EFI_HII_UPDATE_DATA *Data\r
   );\r
 \r
+/**\r
+  This function initialize the data structure for dynamic opcode.\r
+\r
+  @param UpdateData     The adding data;\r
+  @param BufferSize     Length of the buffer to fill dynamic opcodes.\r
+\r
+  @retval EFI_SUCCESS           Update data is initialized.\r
+  @retval EFI_INVALID_PARAMETER UpdateData is NULL.\r
+  @retval EFI_OUT_OF_RESOURCES  No enough memory to allocate.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+IfrLibInitUpdateData (\r
+  IN OUT EFI_HII_UPDATE_DATA   *UpdateData,\r
+  IN UINT32                    BufferSize\r
+  )\r
+;\r
+\r
+/**\r
+\r
+  This function free the resource of update data.\r
+\r
+  @param UpdateData      The adding data;\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+IfrLibFreeUpdateData (\r
+  IN EFI_HII_UPDATE_DATA       *UpdateData\r
+  )\r
+;\r
+\r
 /**\r
   This function allows the caller to update a form that has\r
   previously been registered with the EFI HII database.\r
@@ -73,7 +106,7 @@ IfrLibUpdateForm (
   );\r
 \r
 /**\r
-  Extract formset class for given HII handle.\r
+  Extract EDKII extended formset class for a given HII handle.\r
 \r
   If Handle is not a valid EFI_HII_HANDLE in the default HII database, then\r
   ASSERT.\r
@@ -83,9 +116,9 @@ IfrLibUpdateForm (
   If FormSetHelp is NULL, then ASSERT.\r
 \r
   @param  HiiHandle              Hii handle\r
-  @param  Class                    On output, Class of the formset\r
-  @param  FormSetTitle          On output,  Formset title string\r
-  @param  FormSetHelp          On output,   Formset help string\r
+  @param  Class                  On output, Class of the formset\r
+  @param  FormSetTitle           On output,  Formset title string\r
+  @param  FormSetHelp            On output,   Formset help string\r
 \r
   @retval EFI_SUCCESS            Successfully extract Class for specified Hii\r
                                  handle.\r
@@ -103,6 +136,11 @@ IfrLibExtractClassFromHiiHandle (
 /**\r
   Configure the buffer accrording to ConfigBody strings in the format of\r
   <Length:4 bytes>, <Offset: 2 bytes>, <Width:2 bytes>, <Data:n bytes>.\r
+  This ConfigBody strings is generated by EDKII UEFI VfrCompiler for the default\r
+  values in a Form Set. The name of the ConfigBody strings is VfrMyIfrNVDataDefault0000\r
+  constructed following this rule: \r
+   "Vfr" + varstore.name + "Default" + defaultstore.attributes.\r
+  Check the generated C file in Output for details.\r
 \r
   @param  Buffer                 the start address of buffer.\r
   @param  BufferSize             the size of buffer.\r