]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Hii.h
Fixd EDKII r2594 build broken issue - MdePkg build failed with ICC.
[mirror_edk2.git] / MdePkg / Include / Protocol / Hii.h
index ceeba1c7fb2ee595881b50f1fb3fff1712551521..1fa0a2618c6baa78a30f31fed0c72137b18fc0e5 100644 (file)
@@ -3,7 +3,7 @@
   be used by resources which want to publish IFR/Font/String data and have it \r
   collected by the Configuration engine.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2007, 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
 #ifndef __HII_H__\r
 #define __HII_H__\r
 \r
+#include "GraphicsOutput.h"\r
 \r
 #define EFI_HII_PROTOCOL_GUID \\r
   { \\r
-    0xea816d2c, 0xcee5, 0x4f02, {0x99, 0xb5, 0xd3, 0x90, 0x5c, 0xbb, 0xd0, 0x77 } \\r
+    0xd7ad636e, 0xb997, 0x459b, {0xbf, 0x3f, 0x88, 0x46, 0x89, 0x79, 0x80, 0xe1} \\r
   }\r
 \r
 // BugBug:\r
@@ -412,16 +413,13 @@ typedef struct _EFI_HII_VARIABLE_PACK_LIST {
 /**\r
   Registers the various packs that are passed in via the Packages parameter. \r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Packages A pointer to an EFI_HII_PACKAGES package instance.\r
-  \r
-  @param  Handle A pointer to the EFI_HII_HANDLE instance.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Packages              A pointer to an EFI_HII_PACKAGES package instance.\r
+  @param  Handle                A pointer to the EFI_HII_HANDLE instance.\r
 \r
-  @retval EFI_SUCCESS Data was extracted from Packages, the database \r
-  was updated with the data, and Handle returned successfully.\r
-  \r
-  @retval EFI_INVALID_PARAMETER The content of Packages  was invalid. \r
+  @retval EFI_SUCCESS           Data was extracted from Packages, the database\r
+                                was updated with the data, and Handle returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The content of Packages was invalid.\r
 \r
 **/\r
 typedef\r
@@ -435,15 +433,13 @@ EFI_STATUS
 /**\r
   Removes a package from the HII database. \r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The handle that was registered to the data that is requested \r
-  for removal. \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The handle that was registered to the data that is requested\r
+                                for removal.\r
 \r
-  @retval EFI_SUCCESS The data associated with the Handle was removed \r
-  from the HII database.\r
-  \r
-  @retval EFI_INVALID_PARAMETER The Handle was not valid. \r
+  @retval EFI_SUCCESS           The data associated with the Handle was removed\r
+                                from the HII database.\r
+  @retval EFI_INVALID_PARAMETER The Handle was not valid.\r
 \r
 **/\r
 typedef\r
@@ -456,18 +452,15 @@ EFI_STATUS
 /**\r
   Determines the handles that are currently active in the database.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  HandleBufferLength On input, a pointer to the length of the handle \r
-  buffer. On output, the length of the handle buffer that is required \r
-  for the handles found.\r
-  \r
-  @param  Handle An array of EFI_HII_HANDLE instances returned.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  HandleBufferLength    On input, a pointer to the length of the handle\r
+                                buffer. On output, the length of the handle buffer that is required\r
+                                for the handles found.\r
+  @param  Handle                An array of EFI_HII_HANDLE instances returned.\r
 \r
-  @retval EFI_SUCCESS Handle was updated successfully.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates \r
-  that Handle is too small to support the number of handles.\r
+  @retval EFI_SUCCESS           Handle was updated successfully.\r
+  @retval EFI_BUFFER_TOO_SMALL  The HandleBufferLength parameter indicates\r
+                                that Handle is too small to support the number of handles.\r
 \r
 **/\r
 typedef\r
@@ -481,22 +474,18 @@ EFI_STATUS
 /**\r
   Exports the contents of the database into a buffer.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle An EFI_HII_HANDLE that corresponds to the desired \r
-  handle to export. If the value is 0, the entire database will be exported.\r
-  In either case, the data will be exported in a format described by the \r
-  structure definition of EFI_HII_EXPORT_TABLE.\r
-  \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                An EFI_HII_HANDLE that corresponds to the desired\r
+                                handle to export. If the value is 0, the entire database will be exported.\r
+                                In either case, the data will be exported in a format described by the\r
+                                structure definition of EFI_HII_EXPORT_TABLE.\r
   @param  BufferSize\r
   On input, a pointer to the length of the buffer. On output, the length \r
   of the buffer that is required for the export data.\r
-  \r
-  @param  Buffer A pointer to a buffer that will contain the results of the export function.\r
+  @param  Buffer                A pointer to a buffer that will contain the results of the export function.\r
 \r
-  @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.\r
+  @retval EFI_SUCCESS           The buffer was successfully filled with BufferSize amount of data.\r
+  @retval EFI_BUFFER_TOO_SMALL  The value in BufferSize was too small to contain the export data.\r
 \r
 **/\r
 typedef\r
@@ -512,12 +501,10 @@ EFI_STATUS
   Remove any new strings that were added after the initial string export \r
   for this handle.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The handle on which the string resides.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The handle on which the string resides.\r
 \r
-  @retval EFI_SUCCESS Remove strings from the handle successfully.\r
-  \r
+  @retval EFI_SUCCESS           Remove strings from the handle successfully.\r
   @retval EFI_INVALID_PARAMETER The Handle was unknown.\r
 \r
 **/\r
@@ -531,24 +518,20 @@ EFI_STATUS
 /**\r
   Tests if all of the characters in a string have corresponding font characters.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  StringToTest A pointer to a Unicode string.\r
-  \r
-  @param  FirstMissing A pointer to an index into the string. On input, \r
-  the index of the first character in the StringToTest to examine. On exit, \r
-  the index of the first character encountered for which a glyph is unavailable.\r
-  If all glyphs in the string are available, the index is the index of the \r
-  terminator of the string.\r
-  \r
-  @param  GlyphBufferSize A pointer to a value. On output, if the function \r
-  returns EFI_SUCCESS, it contains the amount of memory that is required to \r
-  store the string¡¯s glyph equivalent.\r
-\r
-  @retval EFI_SUCCESS All glyphs are available. Note that an empty string \r
-  always returns this value.\r
-  \r
-  @retval EFI_NOT_FOUND A glyph was not found for a character.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  StringToTest          A pointer to a Unicode string.\r
+  @param  FirstMissing          A pointer to an index into the string. On input,\r
+                                the index of the first character in the StringToTest to examine. On exit,\r
+                                the index of the first character encountered for which a glyph is unavailable.\r
+                                If all glyphs in the string are available, the index is the index of the\r
+                                terminator of the string.\r
+  @param  GlyphBufferSize       A pointer to a value. On output, if the function\r
+                                returns EFI_SUCCESS, it contains the amount of memory that is required to\r
+                                store the string's glyph equivalent.\r
+\r
+  @retval EFI_SUCCESS           All glyphs are available. Note that an empty string\r
+                                always returns this value.\r
+  @retval EFI_NOT_FOUND         A glyph was not found for a character.\r
 \r
 **/\r
 typedef\r
@@ -563,28 +546,22 @@ EFI_STATUS
 /**\r
   Translates a Unicode character into the corresponding font glyph.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Source A pointer to a Unicode string.\r
-  \r
-  @param  Index On input, the offset into the string from which to fetch \r
-  the character.On successful completion, the index is updated to the first \r
-  character past the character(s) making up the just extracted glyph. \r
-  \r
-  @param  GlyphBuffer Pointer to an array where the glyphs corresponding \r
-  to the characters in the source may be stored. GlyphBuffer is assumed \r
-  to be wide enough to accept a wide glyph character.\r
-  \r
-  @param  BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by \r
-  this value is filled with the length of the glyph in pixels. It is unchanged \r
-  if the call was unsuccessful.\r
-  \r
-  @param  InternalStatus The cell pointed to by this parameter must be \r
-  initialized to zero prior to invoking the call the first time for any string.\r
-\r
-  @retval EFI_SUCCESS It worked.\r
-  \r
-  @retval EFI_NOT_FOUND A glyph for a character was not found.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Source                A pointer to a Unicode string.\r
+  @param  Index                 On input, the offset into the string from which to fetch\r
+                                the character.On successful completion, the index is updated to the first\r
+                                character past the character(s) making up the just extracted glyph.\r
+  @param  GlyphBuffer           Pointer to an array where the glyphs corresponding\r
+                                to the characters in the source may be stored. GlyphBuffer is assumed\r
+                                to be wide enough to accept a wide glyph character.\r
+  @param  BitWidth              If EFI_SUCCESS was returned, the UINT16 pointed to by\r
+                                this value is filled with the length of the glyph in pixels. It is unchanged\r
+                                if the call was unsuccessful.\r
+  @param  InternalStatus        The cell pointed to by this parameter must be\r
+                                initialized to zero prior to invoking the call the first time for any string.\r
+\r
+  @retval EFI_SUCCESS           It worked.\r
+  @retval EFI_NOT_FOUND         A glyph for a character was not found.\r
 \r
 **/\r
 typedef\r
@@ -602,62 +579,49 @@ EFI_STATUS
   Translates a glyph into the format required for input to the Universal \r
   Graphics Adapter (UGA) Block Transfer (BLT) routines.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  GlyphBuffer A pointer to the buffer that contains glyph data.\r
-  \r
-  @param  Foreground The foreground setting requested to be used for the \r
-  generated BltBuffer data. \r
-  \r
-  @param  Background The background setting requested to be used for the \r
-  generated BltBuffer data.\r
-  \r
-  @param  Count The entry in the BltBuffer upon which to act.\r
-  \r
-  @param  Width The width in bits of the glyph being converted.\r
-  \r
-  @param  Height The height in bits of the glyph being converted\r
-  \r
-  @param  BltBuffer A pointer to the buffer that contains the data that is \r
-  ready to be used by the UGA BLT routines. \r
-\r
-  @retval EFI_SUCCESS It worked.\r
-  \r
-  @retval EFI_NOT_FOUND A glyph for a character was not found.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  GlyphBuffer           A pointer to the buffer that contains glyph data.\r
+  @param  Foreground            The foreground setting requested to be used for the\r
+                                generated BltBuffer data.\r
+  @param  Background            The background setting requested to be used for the\r
+                                generated BltBuffer data.\r
+  @param  Count                 The entry in the BltBuffer upon which to act.\r
+  @param  Width                 The width in bits of the glyph being converted.\r
+  @param  Height                The height in bits of the glyph being converted\r
+  @param  BltBuffer             A pointer to the buffer that contains the data that is\r
+                                ready to be used by the UGA BLT routines.\r
+\r
+  @retval EFI_SUCCESS           It worked.\r
+  @retval EFI_NOT_FOUND         A glyph for a character was not found.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_HII_GLYPH_TO_BLT) (\r
-  IN     EFI_HII_PROTOCOL   *This,\r
-  IN     UINT8              *GlyphBuffer,\r
-  IN     EFI_UGA_PIXEL      Foreground,\r
-  IN     EFI_UGA_PIXEL      Background,\r
-  IN     UINTN              Count,\r
-  IN     UINTN              Width,\r
-  IN     UINTN              Height,\r
-  IN OUT EFI_UGA_PIXEL      *BltBuffer\r
+  IN     EFI_HII_PROTOCOL             *This,\r
+  IN     UINT8                        *GlyphBuffer,\r
+  IN     EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,\r
+  IN     EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background,\r
+  IN     UINTN                         Count,\r
+  IN     UINTN                         Width,\r
+  IN     UINTN                         Height,\r
+  IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer\r
   );\r
 \r
 /**\r
   Allows a new string to be added to an already existing string package.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Pointer to a NULL-terminated string containing a single ISO 639-2 \r
-  language identifier, indicating the language in which the string is translated. \r
-  \r
-  @param  Handle The handle of the language pack to which the string is to be added.\r
-  \r
-  @param  Reference The identifier of the string to be added. If the reference \r
-  value is zero, then the string will be assigned a new identifier on that \r
-  handle for the language specified. Otherwise, the string will be updated \r
-  with the NewString Value. \r
-  \r
-  @param  NewString The string to be added.\r
-\r
-  @retval EFI_SUCCESS The string was effectively registered.\r
-  \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Pointer               to a NULL-terminated string containing a single ISO 639-2\r
+                                language identifier, indicating the language in which the string is translated.\r
+  @param  Handle                The handle of the language pack to which the string is to be added.\r
+  @param  Reference             The identifier of the string to be added. If the reference\r
+                                value is zero, then the string will be assigned a new identifier on that\r
+                                handle for the language specified. Otherwise, the string will be updated\r
+                                with the NewString Value.\r
+  @param  NewString             The string to be added.\r
+\r
+  @retval EFI_SUCCESS           The string was effectively registered.\r
   @retval EFI_INVALID_PARAMETER The Handle was unknown.\r
 \r
 **/\r
@@ -675,15 +639,12 @@ EFI_STATUS
   Allows a program to determine the primary languages that are supported \r
   on a given handle.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The handle on which the strings reside.\r
-  \r
-  @param  LanguageString A string allocated by GetPrimaryLanguages() that \r
-  contains a list of all primary languages registered on the handle. \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The handle on which the strings reside.\r
+  @param  LanguageString        A string allocated by GetPrimaryLanguages() that\r
+                                contains a list of all primary languages registered on the handle.\r
 \r
-  @retval EFI_SUCCESS LanguageString was correctly returned.\r
-  \r
+  @retval EFI_SUCCESS           LanguageString was correctly returned.\r
   @retval EFI_INVALID_PARAMETER The Handle was unknown.\r
 \r
 **/\r
@@ -699,18 +660,14 @@ EFI_STATUS
   Allows a program to determine which secondary languages are supported \r
   on a given handle for a given primary language.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The handle on which the strings reside.\r
-  \r
-  @param  PrimaryLanguage Pointer to a NULL-terminated string containing a single \r
-  ISO 639-2 language identifier, indicating the primary language.\r
-  \r
-  @param  LanguageString A string allocated by GetSecondaryLanguages() \r
-  containing a list of all secondary languages registered on the handle.\r
-\r
-  @retval EFI_SUCCESS LanguageString was correctly returned.\r
-  \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The handle on which the strings reside.\r
+  @param  PrimaryLanguage       Pointer to a NULL-terminated string containing a single\r
+                                ISO 639-2 language identifier, indicating the primary language.\r
+  @param  LanguageString        A string allocated by GetSecondaryLanguages()\r
+                                containing a list of all secondary languages registered on the handle.\r
+\r
+  @retval EFI_SUCCESS           LanguageString was correctly returned.\r
   @retval EFI_INVALID_PARAMETER The Handle was unknown.\r
 \r
 **/\r
@@ -726,32 +683,24 @@ EFI_STATUS
 /**\r
   Extracts a string from a package already registered with the EFI HII database.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The handle on which the string resides.\r
-  \r
-  @param  Token The string token assigned to the string.\r
-  \r
-  @param  Raw If TRUE, the string is returned unedited in the internal \r
-  storage format described above. If false, the string returned is edited \r
-  by replacing <cr> with <space> and by removing special characters such \r
-  as the <wide> prefix.\r
-  \r
-  @param  LanguageString Pointer to a NULL-terminated string containing a \r
-  single ISO 639-2 language identifier, indicating the language to print. \r
-  If the LanguageString is empty (starts with a NULL), the default system \r
-  language will be used to determine the language.\r
-  \r
-  @param  BufferLength Length of the StringBuffer.\r
-  \r
-  @param  StringBuffer The buffer designed to receive the characters in the string.\r
-\r
-  @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.\r
-  \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The handle on which the string resides.\r
+  @param  Token                 The string token assigned to the string.\r
+  @param  Raw                   If TRUE, the string is returned unedited in the internal\r
+                                storage format described above. If false, the string returned is edited\r
+                                by replacing <cr> with <space> and by removing special characters such\r
+                                as the <wide> prefix.\r
+  @param  LanguageString        Pointer to a NULL-terminated string containing a\r
+                                single ISO 639-2 language identifier, indicating the language to print.\r
+                                If the LanguageString is empty (starts with a NULL), the default system\r
+                                language will be used to determine the language.\r
+  @param  BufferLength          Length of the StringBuffer.\r
+  @param  StringBuffer          The buffer designed to receive the characters in the string.\r
+\r
+  @retval EFI_SUCCESS           StringBuffer is filled with a NULL-terminated string.\r
   @retval EFI_INVALID_PARAMETER The handle or string token is unknown.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to \r
-  allow the entire string to be stored. \r
+  @retval EFI_BUFFER_TOO_SMALL  The buffer provided was not large enough to\r
+                                allow the entire string to be stored.\r
 \r
 **/\r
 typedef\r
@@ -769,32 +718,23 @@ EFI_STATUS
 /**\r
   Allows a program to extract a part of a string of not more than a given width. \r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The handle on which the string resides.\r
-  \r
-  @param  Token The string token assigned to the string. \r
-  \r
-  @param  Index On input, the offset into the string where the line is to start.\r
-  On output, the index is updated to point to beyond the last character returned \r
-  in the call.\r
-  \r
-  @param  LineWidth The maximum width of the line in units of narrow glyphs.\r
-  \r
-  @param  LanguageString Pointer to a NULL-terminated string containing a \r
-  single ISO 639-2 language identifier, indicating the language to print.\r
-  \r
-  @param  BufferLength Pointer to the length of the StringBuffer. \r
-  \r
-  @param  StringBuffer The buffer designed to receive the characters in the string. \r
-\r
-  @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.\r
-  \r
-  @retval EFI_NOT_FOUND The font glyph for at least one of the characters in \r
-  the string is not in the font database.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough \r
-  to allow the entire string to be stored.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The handle on which the string resides.\r
+  @param  Token                 The string token assigned to the string.\r
+  @param  Index                 On input, the offset into the string where the line is to start.\r
+                                On output, the index is updated to point to beyond the last character returned\r
+                                in the call.\r
+  @param  LineWidth             The maximum width of the line in units of narrow glyphs.\r
+  @param  LanguageString        Pointer to a NULL-terminated string containing a\r
+                                single ISO 639-2 language identifier, indicating the language to print.\r
+  @param  BufferLength          Pointer to the length of the StringBuffer.\r
+  @param  StringBuffer          The buffer designed to receive the characters in the string.\r
+\r
+  @retval EFI_SUCCESS           StringBuffer filled with characters that will fit on the line.\r
+  @retval EFI_NOT_FOUND         The font glyph for at least one of the characters in\r
+                                the string is not in the font database.\r
+  @retval EFI_BUFFER_TOO_SMALL  The buffer provided was not large enough\r
+                                to allow the entire string to be stored.\r
 \r
 **/\r
 typedef\r
@@ -814,28 +754,21 @@ EFI_STATUS
   Allows a program to extract a form or form package that has previously \r
   been registered with the HII database.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle Handle on which the form resides.\r
-  \r
-  @param  FormId The ID of the form to return. If the ID is zero, \r
-  the entire form package is returned. \r
-  \r
-  @param  BufferLength On input, the length of the Buffer. On output, \r
-  the length of the returned buffer, \r
-  \r
-  @param  Buffer The buffer designed to receive the form(s).\r
-\r
-  @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength \r
-  was updated.\r
-  \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                Handle on which the form resides.\r
+  @param  FormId                The ID of the form to return. If the ID is zero,\r
+                                the entire form package is returned.\r
+  @param  BufferLength          On input, the length of the Buffer. On output,\r
+                                the length of the returned buffer,\r
+  @param  Buffer                The buffer designed to receive the form(s).\r
+\r
+  @retval EFI_SUCCESS           Buffer filled with the requested forms. BufferLength\r
+                                was updated.\r
   @retval EFI_INVALID_PARAMETER The handle is unknown.\r
-  \r
-  @retval EFI_NOT_FOUND A form on the requested handle cannot be found with \r
-  the requested FormId.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough \r
-  to allow the form to be stored. \r
+  @retval EFI_NOT_FOUND         A form on the requested handle cannot be found with\r
+                                the requested FormId.\r
+  @retval EFI_BUFFER_TOO_SMALL  The buffer provided was not large enough\r
+                                to allow the form to be stored.\r
 \r
 **/\r
 typedef\r
@@ -851,23 +784,18 @@ EFI_STATUS
 /**\r
   Extracts the defaults that are associated with a given handle in the HII database.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The HII handle from which will have default data retrieved.\r
-  \r
-  @param  DefaultMask The mask used to specify some type of default override when extracting \r
-  the default image data.\r
-  \r
-  @param  VariablePackList A indirect pointer to the first entry of a link list with \r
-  type EFI_HII_VARIABLE_PACK_LIST. \r
-\r
-  @retval EFI_SUCCESS The VariablePackList was populated with the appropriate \r
-  default setting data.\r
-  \r
-  @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).\r
-  \r
-  @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle \r
-  contain invalid data.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The HII handle from which will have default data retrieved.\r
+  @param  DefaultMask           The mask used to specify some type of default override when extracting\r
+                                the default image data.\r
+  @param  VariablePackList      A indirect pointer to the first entry of a link list with\r
+                                type EFI_HII_VARIABLE_PACK_LIST.\r
+\r
+  @retval EFI_SUCCESS           The VariablePackList was populated with the appropriate\r
+                                default setting data.\r
+  @retval EFI_NOT_FOUND         The IFR does not have any explicit or default map(s).\r
+  @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle\r
+                                contain invalid data.\r
 \r
 **/\r
 typedef\r
@@ -883,23 +811,17 @@ EFI_STATUS
   Allows the caller to update a form or form package that has previously been \r
   registered with the EFI HII database.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle Handle of the package where the form to be updated resides.\r
-  \r
-  @param  Label The label inside the form package where the update is to take place.\r
-  \r
-  @param  AddData If TRUE, adding data at a given Label; otherwise, \r
-  if FALSE, removing data at a given Label.\r
-  \r
-  @param  Data The buffer containing the new tags to insert after the Label\r
-\r
-  @retval EFI_SUCCESS The form was updated with the new tags.\r
-  \r
-  @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not \r
-  contain an integral number of tags.\r
-  \r
-  @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found. \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                Handle of the package where the form to be updated resides.\r
+  @param  Label                 The label inside the form package where the update is to take place.\r
+  @param  AddData               If TRUE, adding data at a given Label; otherwise,\r
+                                if FALSE, removing data at a given Label.\r
+  @param  Data                  The buffer containing the new tags to insert after the Label\r
+\r
+  @retval EFI_SUCCESS           The form was updated with the new tags.\r
+  @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not\r
+                                contain an integral number of tags.\r
+  @retval EFI_NOT_FOUND         The Handle, Label, or FormId was not found.\r
 \r
 **/\r
 typedef\r
@@ -915,15 +837,13 @@ EFI_STATUS
 /**\r
   Retrieves the current keyboard layout. \r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  DescriptorCount A pointer to the number of Descriptor entries being \r
-  described in the keyboard layout being retrieved.\r
-  \r
-  @param  Descriptor A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR \r
-  entries. Each entry will reflect the definition of a specific physical key.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  DescriptorCount       A pointer to the number of Descriptor entries being\r
+                                described in the keyboard layout being retrieved.\r
+  @param  Descriptor            A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR\r
+                                entries. Each entry will reflect the definition of a specific physical key.\r
 \r
-  @retval EFI_SUCCESS The keyboard layout was retrieved successfully.\r
+  @retval EFI_SUCCESS           The keyboard layout was retrieved successfully.\r
 \r
 **/\r
 typedef\r