MdeModulePkg: Clean up source files

[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / HiiDatabase.h

diff --git a/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h b/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
index 8336dd0f4fed7c9eece1908829adb98202cafb6a..4391625a9fa071baef9358457f670cd815f7e078 100644 (file)
--- a/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
+++ b/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
@@ -1,7 +1,7 @@
 /** @file\r
 Private structures definitions in HiiDatabase.\r
 \r
 /** @file\r
 Private structures definitions in HiiDatabase.\r
 \r

-Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r

 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
 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


@@ -390,10 +390,10 @@ typedef struct _HII_DATABASE_PRIVATE_DATA {
 \r
   @param  BufferLen              The length of the Buffer in bytes.\r
 \r
 \r
   @param  BufferLen              The length of the Buffer in bytes.\r
 \r

-  @param  Buffer                 Points to a buffer which will be converted to be the \r
+  @param  Buffer                 Points to a buffer which will be converted to be the\r

                                  content of the generated string.\r
 \r
                                  content of the generated string.\r
 \r

-  @param  Flag                   If 1, the buffer contains data for the value of GUID or PATH stored in \r
+  @param  Flag                   If 1, the buffer contains data for the value of GUID or PATH stored in\r

                                  UINT8 *; if 2, the buffer contains unicode string for the value of NAME;\r
                                  if 3, the buffer contains other data.\r
 \r
                                  UINT8 *; if 2, the buffer contains unicode string for the value of NAME;\r
                                  if 3, the buffer contains other data.\r
 \r


@@ -460,21 +460,21 @@ IsFontInfoExisted (
 /**\r
 \r
    This function invokes the matching registered function.\r
 /**\r
 \r
    This function invokes the matching registered function.\r

-    \r
+\r

    @param  Private           HII Database driver private structure.\r
    @param  NotifyType        The type of change concerning the database.\r
    @param  PackageInstance   Points to the package referred to by the notification.\r
    @param  PackageType       Package type\r
    @param  Handle            The handle of the package list which contains the specified package.\r
    @param  Private           HII Database driver private structure.\r
    @param  NotifyType        The type of change concerning the database.\r
    @param  PackageInstance   Points to the package referred to by the notification.\r
    @param  PackageType       Package type\r
    @param  Handle            The handle of the package list which contains the specified package.\r

-    \r
-   @retval EFI_SUCCESS            Already checked all registered function and invoked \r
+\r
+   @retval EFI_SUCCESS            Already checked all registered function and invoked\r

                                   if matched.\r
    @retval EFI_INVALID_PARAMETER  Any input parameter is not valid.\r
                                   if matched.\r
    @retval EFI_INVALID_PARAMETER  Any input parameter is not valid.\r

-     \r
+\r

 **/\r
 EFI_STATUS\r
 InvokeRegisteredFunction (\r
 **/\r
 EFI_STATUS\r
 InvokeRegisteredFunction (\r

-  IN HII_DATABASE_PRIVATE_DATA    *Private, \r
+  IN HII_DATABASE_PRIVATE_DATA    *Private,\r

   IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType,\r
   IN VOID                         *PackageInstance,\r
   IN UINT8                        PackageType,\r
   IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType,\r
   IN VOID                         *PackageInstance,\r
   IN UINT8                        PackageType,\r


@@ -508,7 +508,7 @@ GetSystemFont (
 /**\r
   Parse all string blocks to find a String block specified by StringId.\r
   If StringId = (EFI_STRING_ID) (-1), find out all EFI_HII_SIBT_FONT blocks\r
 /**\r
   Parse all string blocks to find a String block specified by StringId.\r
   If StringId = (EFI_STRING_ID) (-1), find out all EFI_HII_SIBT_FONT blocks\r

-  within this string package and backup its information. If LastStringId is \r
+  within this string package and backup its information. If LastStringId is\r

   specified, the string id of last string block will also be output.\r
   If StringId = 0, output the string id of last string block (EFI_HII_SIBT_STRING).\r
 \r
   specified, the string id of last string block will also be output.\r
   If StringId = 0, output the string id of last string block (EFI_HII_SIBT_STRING).\r
 \r


@@ -734,8 +734,8 @@ HiiStringToImage (
                                   RowInfoArray or Blt.\r
   @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.\r
   @retval EFI_INVALID_PARAMETER Flags were invalid combination.\r
                                   RowInfoArray or Blt.\r
   @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.\r
   @retval EFI_INVALID_PARAMETER Flags were invalid combination.\r

-  @retval EFI_NOT_FOUND         The specified PackageList is not in the Database or the stringid is not \r
-                          in the specified PackageList. \r
+  @retval EFI_NOT_FOUND         The specified PackageList is not in the Database or the stringid is not\r
+                          in the specified PackageList.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -806,7 +806,7 @@ HiiGetGlyph (
   @param  StringInfoOut           Upon return, contains the matching font's information.\r
                                   If NULL, then no information is returned. This buffer\r
                                   is allocated with a call to the Boot Service AllocatePool().\r
   @param  StringInfoOut           Upon return, contains the matching font's information.\r
                                   If NULL, then no information is returned. This buffer\r
                                   is allocated with a call to the Boot Service AllocatePool().\r

-                                  It is the caller's responsibility to call the Boot \r
+                                  It is the caller's responsibility to call the Boot\r

                                   Service FreePool() when the caller no longer requires\r
                                   the contents of StringInfoOut.\r
   @param  String                  Points to the string which will be tested to\r
                                   Service FreePool() when the caller no longer requires\r
                                   the contents of StringInfoOut.\r
   @param  String                  Points to the string which will be tested to\r


@@ -1067,7 +1067,7 @@ HiiDrawImage (
   @retval EFI_SUCCESS             The image was successfully drawn.\r
   @retval EFI_OUT_OF_RESOURCES    Unable to allocate an output buffer for Blt.\r
   @retval EFI_INVALID_PARAMETER  The Blt was NULL.\r
   @retval EFI_SUCCESS             The image was successfully drawn.\r
   @retval EFI_OUT_OF_RESOURCES    Unable to allocate an output buffer for Blt.\r
   @retval EFI_INVALID_PARAMETER  The Blt was NULL.\r

-  @retval EFI_NOT_FOUND          The image specified by ImageId is not in the database. \r
+  @retval EFI_NOT_FOUND          The image specified by ImageId is not in the database.\r

                            The specified PackageList is not in the database.\r
 \r
 **/\r
                            The specified PackageList is not in the database.\r
 \r
 **/\r


@@ -1654,7 +1654,7 @@ HiiListPackageLists (
   @retval EFI_NOT_FOUND           The specified Handle could not be found in the\r
                                   current database.\r
   @retval EFI_INVALID_PARAMETER   BufferSize was NULL.\r
   @retval EFI_NOT_FOUND           The specified Handle could not be found in the\r
                                   current database.\r
   @retval EFI_INVALID_PARAMETER   BufferSize was NULL.\r

-  @retval EFI_INVALID_PARAMETER   The value referenced by BufferSize was not zero \r
+  @retval EFI_INVALID_PARAMETER   The value referenced by BufferSize was not zero\r

                                   and Buffer was NULL.\r
 \r
 **/\r
                                   and Buffer was NULL.\r
 \r
 **/\r


@@ -1725,7 +1725,7 @@ HiiRegisterPackageNotify (
                                   unregistered.\r
 \r
   @retval EFI_SUCCESS             Notification is unregistered successfully.\r
                                   unregistered.\r
 \r
   @retval EFI_SUCCESS             Notification is unregistered successfully.\r

-  @retval EFI_NOT_FOUND          The incoming notification handle does not exist \r
+  @retval EFI_NOT_FOUND          The incoming notification handle does not exist\r

                            in current hii database.\r
 \r
 **/\r
                            in current hii database.\r
 \r
 **/\r


@@ -1912,8 +1912,8 @@ HiiConfigRoutingExtractConfig (
                                   instance.\r
   @param  Results                 Null-terminated Unicode string in\r
                                   <MultiConfigAltResp> format which has all values\r
                                   instance.\r
   @param  Results                 Null-terminated Unicode string in\r
                                   <MultiConfigAltResp> format which has all values\r

-                                  filled in for the entirety of the current HII \r
-                                  database. String to be allocated by the  called \r
+                                  filled in for the entirety of the current HII\r
+                                  database. String to be allocated by the  called\r

                                   function. De-allocation is up to the caller.\r
 \r
   @retval EFI_SUCCESS             The Results string is filled with the values\r
                                   function. De-allocation is up to the caller.\r
 \r
   @retval EFI_SUCCESS             The Results string is filled with the values\r


@@ -2064,7 +2064,7 @@ HiiBlockToConfig (
                                   value pair. Block is left updated and\r
                                   Progress points at the '&' preceding the first\r
                                   non-<BlockName>.\r
                                   value pair. Block is left updated and\r
                                   Progress points at the '&' preceding the first\r
                                   non-<BlockName>.\r

-  @retval EFI_BUFFER_TOO_SMALL    Block not large enough. Progress undefined. \r
+  @retval EFI_BUFFER_TOO_SMALL    Block not large enough. Progress undefined.\r

                                   BlockSize is updated with the required buffer size.\r
 \r
 **/\r
                                   BlockSize is updated with the required buffer size.\r
 \r
 **/\r


@@ -2136,18 +2136,18 @@ HiiGetAltCfg (
   This function accepts a <MultiKeywordResp> formatted string, finds the associated\r
   keyword owners, creates a <MultiConfigResp> string from it and forwards it to the\r
   EFI_HII_ROUTING_PROTOCOL.RouteConfig function.\r
   This function accepts a <MultiKeywordResp> formatted string, finds the associated\r
   keyword owners, creates a <MultiConfigResp> string from it and forwards it to the\r
   EFI_HII_ROUTING_PROTOCOL.RouteConfig function.\r

-  \r
-  If there is an issue in resolving the contents of the KeywordString, then the \r
-  function returns an error and also sets the Progress and ProgressErr with the \r
+\r
+  If there is an issue in resolving the contents of the KeywordString, then the\r
+  function returns an error and also sets the Progress and ProgressErr with the\r

   appropriate information about where the issue occurred and additional data about\r
   appropriate information about where the issue occurred and additional data about\r

-  the nature of the issue. \r
-  \r
+  the nature of the issue.\r
+\r

   In the case when KeywordString containing multiple keywords, when an EFI_NOT_FOUND\r
   error is generated during processing the second or later keyword element, the system\r
   In the case when KeywordString containing multiple keywords, when an EFI_NOT_FOUND\r
   error is generated during processing the second or later keyword element, the system\r

-  storage associated with earlier keywords is not modified. All elements of the \r
+  storage associated with earlier keywords is not modified. All elements of the\r

   KeywordString must successfully pass all tests for format and access prior to making\r
   any modifications to storage.\r
   KeywordString must successfully pass all tests for format and access prior to making\r
   any modifications to storage.\r

-  \r
+\r

   In the case when EFI_DEVICE_ERROR is returned from the processing of a KeywordString\r
   containing multiple keywords, the state of storage associated with earlier keywords\r
   is undefined.\r
   In the case when EFI_DEVICE_ERROR is returned from the processing of a KeywordString\r
   containing multiple keywords, the state of storage associated with earlier keywords\r
   is undefined.\r


@@ -2155,18 +2155,18 @@ HiiGetAltCfg (
 \r
   @param This             Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance.\r
 \r
 \r
   @param This             Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance.\r
 \r

-  @param KeywordString    A null-terminated string in <MultiKeywordResp> format. \r
+  @param KeywordString    A null-terminated string in <MultiKeywordResp> format.\r

 \r
 \r

-  @param Progress         On return, points to a character in the KeywordString. \r
-                          Points to the string's NULL terminator if the request \r
-                          was successful. Points to the most recent '&' before \r
+  @param Progress         On return, points to a character in the KeywordString.\r
+                          Points to the string's NULL terminator if the request\r
+                          was successful. Points to the most recent '&' before\r

                           the first failing name / value pair (or the beginning\r
                           of the string if the failure is in the first name / value\r
                           pair) if the request was not successful.\r
 \r
   @param ProgressErr      If during the processing of the KeywordString there was\r
                           the first failing name / value pair (or the beginning\r
                           of the string if the failure is in the first name / value\r
                           pair) if the request was not successful.\r
 \r
   @param ProgressErr      If during the processing of the KeywordString there was\r

-                          a failure, this parameter gives additional information \r
-                          about the possible source of the problem. The various \r
+                          a failure, this parameter gives additional information\r
+                          about the possible source of the problem. The various\r

                           errors are defined in "Related Definitions" below.\r
 \r
 \r
                           errors are defined in "Related Definitions" below.\r
 \r
 \r


@@ -2174,16 +2174,16 @@ HiiGetAltCfg (
 \r
   @retval EFI_INVALID_PARAMETER   One or more of the following are TRUE:\r
                                   1. KeywordString is NULL.\r
 \r
   @retval EFI_INVALID_PARAMETER   One or more of the following are TRUE:\r
                                   1. KeywordString is NULL.\r

-                                  2. Parsing of the KeywordString resulted in an \r
+                                  2. Parsing of the KeywordString resulted in an\r

                                      error. See Progress and ProgressErr for more data.\r
 \r
                                      error. See Progress and ProgressErr for more data.\r
 \r

-  @retval EFI_NOT_FOUND           An element of the KeywordString was not found. \r
+  @retval EFI_NOT_FOUND           An element of the KeywordString was not found.\r

                                   See ProgressErr for more data.\r
 \r
                                   See ProgressErr for more data.\r
 \r

-  @retval EFI_OUT_OF_RESOURCES    Required system resources could not be allocated.  \r
+  @retval EFI_OUT_OF_RESOURCES    Required system resources could not be allocated.\r

                                   See ProgressErr for more data.\r
                                   See ProgressErr for more data.\r

-                                  \r
-  @retval EFI_ACCESS_DENIED       The action violated system policy. See ProgressErr \r
+\r
+  @retval EFI_ACCESS_DENIED       The action violated system policy. See ProgressErr\r

                                   for more data.\r
 \r
   @retval EFI_DEVICE_ERROR        An unexpected system error occurred. See ProgressErr\r
                                   for more data.\r
 \r
   @retval EFI_DEVICE_ERROR        An unexpected system error occurred. See ProgressErr\r


@@ -2191,7 +2191,7 @@ HiiGetAltCfg (
 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r

-EFIAPI \r
+EFIAPI\r

 EfiConfigKeywordHandlerSetData (\r
   IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL *This,\r
   IN CONST EFI_STRING                    KeywordString,\r
 EfiConfigKeywordHandlerSetData (\r
   IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL *This,\r
   IN CONST EFI_STRING                    KeywordString,\r


@@ -2201,56 +2201,56 @@ EfiConfigKeywordHandlerSetData (
 \r
 /**\r
 \r
 \r
 /**\r
 \r

-  This function accepts a <MultiKeywordRequest> formatted string, finds the underlying \r
+  This function accepts a <MultiKeywordRequest> formatted string, finds the underlying\r

   keyword owners, creates a <MultiConfigRequest> string from it and forwards it to the\r
   EFI_HII_ROUTING_PROTOCOL.ExtractConfig function.\r
   keyword owners, creates a <MultiConfigRequest> string from it and forwards it to the\r
   EFI_HII_ROUTING_PROTOCOL.ExtractConfig function.\r

-  \r
+\r

   If there is an issue in resolving the contents of the KeywordString, then the function\r
   returns an EFI_INVALID_PARAMETER and also set the Progress and ProgressErr with the\r
   appropriate information about where the issue occurred and additional data about the\r
   nature of the issue.\r
   If there is an issue in resolving the contents of the KeywordString, then the function\r
   returns an EFI_INVALID_PARAMETER and also set the Progress and ProgressErr with the\r
   appropriate information about where the issue occurred and additional data about the\r
   nature of the issue.\r

-  \r
+\r

   In the case when KeywordString is NULL, or contains multiple keywords, or when\r
   EFI_NOT_FOUND is generated while processing the keyword elements, the Results string\r
   In the case when KeywordString is NULL, or contains multiple keywords, or when\r
   EFI_NOT_FOUND is generated while processing the keyword elements, the Results string\r

-  contains values returned for all keywords processed prior to the keyword generating the \r
+  contains values returned for all keywords processed prior to the keyword generating the\r

   error but no values for the keyword with error or any following keywords.\r
 \r
   error but no values for the keyword with error or any following keywords.\r
 \r

-  \r
+\r

   @param This           Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance.\r
   @param This           Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance.\r

-  \r
+\r

   @param NameSpaceId    A null-terminated string containing the platform configuration\r
                         language to search through in the system. If a NULL is passed\r
                         in, then it is assumed that any platform configuration language\r
                         with the prefix of "x-UEFI-" are searched.\r
   @param NameSpaceId    A null-terminated string containing the platform configuration\r
                         language to search through in the system. If a NULL is passed\r
                         in, then it is assumed that any platform configuration language\r
                         with the prefix of "x-UEFI-" are searched.\r

-                        \r
+\r

   @param KeywordString  A null-terminated string in <MultiKeywordRequest> format. If a\r
   @param KeywordString  A null-terminated string in <MultiKeywordRequest> format. If a\r

-                        NULL is passed in the KeywordString field, all of the known \r
-                        keywords in the system for the NameSpaceId specified are \r
+                        NULL is passed in the KeywordString field, all of the known\r
+                        keywords in the system for the NameSpaceId specified are\r

                         returned in the Results field.\r
                         returned in the Results field.\r

-  \r
+\r

   @param Progress       On return, points to a character in the KeywordString. Points\r
   @param Progress       On return, points to a character in the KeywordString. Points\r

-                        to the string's NULL terminator if the request was successful. \r
+                        to the string's NULL terminator if the request was successful.\r

                         Points to the most recent '&' before the first failing name / value\r
                         pair (or the beginning of the string if the failure is in the first\r
                         name / value pair) if the request was not successful.\r
                         Points to the most recent '&' before the first failing name / value\r
                         pair (or the beginning of the string if the failure is in the first\r
                         name / value pair) if the request was not successful.\r

-                        \r
+\r

   @param ProgressErr    If during the processing of the KeywordString there was a\r
   @param ProgressErr    If during the processing of the KeywordString there was a\r

-                        failure, this parameter gives additional information about the \r
+                        failure, this parameter gives additional information about the\r

                         possible source of the problem. See the definitions in SetData()\r
                         for valid value definitions.\r
                         possible source of the problem. See the definitions in SetData()\r
                         for valid value definitions.\r

-  \r
+\r

   @param Results        A null-terminated string in <MultiKeywordResp> format is returned\r
   @param Results        A null-terminated string in <MultiKeywordResp> format is returned\r

-                        which has all the values filled in for the keywords in the \r
+                        which has all the values filled in for the keywords in the\r

                         KeywordString. This is a callee-allocated field, and must be freed\r
                         KeywordString. This is a callee-allocated field, and must be freed\r

-                        by the caller after being used. \r
+                        by the caller after being used.\r

 \r
   @retval EFI_SUCCESS             The specified action was completed successfully.\r
 \r
   @retval EFI_SUCCESS             The specified action was completed successfully.\r

-  \r
+\r

   @retval EFI_INVALID_PARAMETER   One or more of the following are TRUE:\r
                                   1.Progress, ProgressErr, or Results is NULL.\r
                                   2.Parsing of the KeywordString resulted in an error. See\r
                                     Progress and ProgressErr for more data.\r
   @retval EFI_INVALID_PARAMETER   One or more of the following are TRUE:\r
                                   1.Progress, ProgressErr, or Results is NULL.\r
                                   2.Parsing of the KeywordString resulted in an error. See\r
                                     Progress and ProgressErr for more data.\r

-  \r
+\r

 \r
   @retval EFI_NOT_FOUND           An element of the KeywordString was not found. See\r
                                   ProgressErr for more data.\r
 \r
   @retval EFI_NOT_FOUND           An element of the KeywordString was not found. See\r
                                   ProgressErr for more data.\r


@@ -2260,7 +2260,7 @@ EfiConfigKeywordHandlerSetData (
 \r
   @retval EFI_OUT_OF_RESOURCES    Required system resources could not be allocated.  See\r
                                   ProgressErr for more data.\r
 \r
   @retval EFI_OUT_OF_RESOURCES    Required system resources could not be allocated.  See\r
                                   ProgressErr for more data.\r

-                                  \r
+\r

   @retval EFI_ACCESS_DENIED       The action violated system policy.  See ProgressErr for\r
                                   more data.\r
 \r
   @retval EFI_ACCESS_DENIED       The action violated system policy.  See ProgressErr for\r
                                   more data.\r
 \r


@@ -2269,12 +2269,12 @@ EfiConfigKeywordHandlerSetData (
 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r

-EFIAPI \r
+EFIAPI\r

 EfiConfigKeywordHandlerGetData (\r
   IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL  *This,\r
   IN CONST EFI_STRING                     NameSpaceId, OPTIONAL\r
   IN CONST EFI_STRING                     KeywordString, OPTIONAL\r
 EfiConfigKeywordHandlerGetData (\r
   IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL  *This,\r
   IN CONST EFI_STRING                     NameSpaceId, OPTIONAL\r
   IN CONST EFI_STRING                     KeywordString, OPTIONAL\r

-  OUT EFI_STRING                          *Progress, \r
+  OUT EFI_STRING                          *Progress,\r

   OUT UINT32                              *ProgressErr,\r
   OUT EFI_STRING                          *Results\r
   );\r
   OUT UINT32                              *ProgressErr,\r
   OUT EFI_STRING                          *Results\r
   );\r


@@ -2298,11 +2298,11 @@ HiiCompareLanguage (
 \r
 /**\r
   Retrieves a pointer to a Null-terminated ASCII string containing the list\r
 \r
 /**\r
   Retrieves a pointer to a Null-terminated ASCII string containing the list\r

-  of languages that an HII handle in the HII Database supports.  The returned \r
+  of languages that an HII handle in the HII Database supports.  The returned\r

   string is allocated using AllocatePool().  The caller is responsible for freeing\r
   the returned string using FreePool().  The format of the returned string follows\r
   the language format assumed the HII Database.\r
   string is allocated using AllocatePool().  The caller is responsible for freeing\r
   the returned string using FreePool().  The format of the returned string follows\r
   the language format assumed the HII Database.\r

-  \r
+\r

   If HiiHandle is NULL, then ASSERT().\r
 \r
   @param[in]  HiiHandle  A handle that was previously registered in the HII Database.\r
   If HiiHandle is NULL, then ASSERT().\r
 \r
   @param[in]  HiiHandle  A handle that was previously registered in the HII Database.\r