Synchronize GenericBdsLib library class's header file to library instance.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6925 6f19259b-4bc3-4df7-8a09-765794883524

4 files changed, 37 insertions, 49 deletions

diff --git a/MdeModulePkg/Library/GenericBdsLib/BdsBoot.c b/MdeModulePkg/Library/GenericBdsLib/BdsBoot.c
index f5960aa6e7..8f9d92881a 100644
--- a/MdeModulePkg/Library/GenericBdsLib/BdsBoot.c
+++ b/MdeModulePkg/Library/GenericBdsLib/BdsBoot.c
@@ -72,17 +72,17 @@ BdsLibDoLegacyBoot (
 

 

 /**

-  Process the boot option follow the EFI 1.1 specification and

+  Process the boot option follow the UEFI specification and

   special treat the legacy boot option with BBS_DEVICE_PATH.

 

   @param  Option                 The boot option need to be processed

   @param  DevicePath             The device path which describe where to load the

                                  boot image or the legcy BBS device path to boot

                                  the legacy OS

-  @param  ExitDataSize           Returned directly from gBS->StartImage ()

-  @param  ExitData               Returned directly from gBS->StartImage ()

+  @param  ExitDataSize           The size of exit data.

+  @param  ExitData               Data returned when Boot image failed.

 

-  @retval EFI_SUCCESS            Status from gBS->StartImage ()

+  @retval EFI_SUCCESS            Boot from the input boot option successfully.

   @retval EFI_NOT_FOUND          If the Device Path is not found in the system

 

 **/

@@ -510,8 +510,8 @@ BdsExpandPartitionPartialDevicePathToFull (
   @param  HardDriveDevicePath    A device path which starts with a hard drive media

                                  device path.

 

-  @retval TRUE                   There is a matched device path instance FALSE

-  @retval FALSE                  There is no matched device path instance

+  @retval TRUE                   There is a matched device path instance.

+  @retval FALSE                  There is no matched device path instance.

 

 **/

 BOOLEAN

@@ -1114,13 +1114,13 @@ BdsLibEnumerateAllBootOption (
 }

 

 /**

-  Build the boot option with the handle parsed in.

+  Build the boot option with the handle parsed in

 

   @param  Handle                 The handle which present the device path to create

                                  boot option

   @param  BdsBootOptionList      The header of the link list which indexed all

                                  current boot options

-  @param  String                 Boot option name.

+  @param  String                 The description of the boot option.

 

 **/

 VOID

@@ -1178,7 +1178,7 @@ BdsLibBuildOptionFromShell (
 }

 

 /**

-  Boot from the EFI1.1 spec defined "BootNext" variable

+  Boot from the UEFI spec defined "BootNext" variable.

 

 **/

 VOID

@@ -1238,7 +1238,6 @@ BdsLibBootNext (
 

   @param  DevicePath             Device Path to a  bootable device

 

-  @retval NULL                   The device path points to an EFI bootable Media

   @retval NULL                   The media on the DevicePath is not bootable

 

 **/

@@ -1558,11 +1557,11 @@ BdsGetBootTypeFromDevicePath (
   Check whether the Device path in a boot option point to a valide bootable device,

   And if CheckMedia is true, check the device is ready to boot now.

 

-  @param DevPath        the Device path in a boot option

-  @param CheckMedia     if true, check the device is ready to boot now.

+  @param  DevPath     the Device path in a boot option

+  @param  CheckMedia  if true, check the device is ready to boot now.

 

-  @retval TRUE          the Device path  is valide

-  @retval FALSE         the Device path  is invalide .

+  @retval TRUE        the Device path  is valide

+  @retval FALSE       the Device path  is invalide .

 

 **/

 BOOLEAN

@@ -1729,7 +1728,7 @@ EFI_STATUS
 EFIAPI

 BdsLibUpdateFvFileDevicePath (

   IN  OUT EFI_DEVICE_PATH_PROTOCOL      ** DevicePath,

-  IN      EFI_GUID                      *FileGuid

+  IN  EFI_GUID                          *FileGuid

   )

 {

   EFI_DEVICE_PATH_PROTOCOL      *TempDevicePath;

diff --git a/MdeModulePkg/Library/GenericBdsLib/BdsConsole.c b/MdeModulePkg/Library/GenericBdsLib/BdsConsole.c
index ff72aa0f08..d923804e3f 100644
--- a/MdeModulePkg/Library/GenericBdsLib/BdsConsole.c
+++ b/MdeModulePkg/Library/GenericBdsLib/BdsConsole.c
@@ -60,7 +60,7 @@ IsNvNeed (
                                    from the console variable ConVarName, this

                                    parameter can not be multi-instance.

 

-  @retval EFI_UNSUPPORTED          Add or remove the same device path.

+  @retval EFI_UNSUPPORTED          The added device path is same to the removed one.

   @retval EFI_SUCCESS              Success add or remove the device path from  the

                                    console variable.

 

@@ -184,7 +184,6 @@ BdsLibUpdateConsoleVariable (
   @param  ConVarName               Console related variable name, ConIn, ConOut,

                                    ErrOut.

 

-  @retval EFI_UNSUPPORTED          Request console variable does not exist.

   @retval EFI_NOT_FOUND            There is not any console devices connected

                                    success

   @retval EFI_SUCCESS              Success connect any one instance of the console

@@ -359,8 +358,7 @@ BdsLibConnectAllConsoles (
 

   @retval EFI_SUCCESS              At least one of the ConIn and ConOut device have

                                    been connected success.

-  @retval EFI_STATUS               Return the status of

-                                   BdsLibConnectConsoleVariable ().

+  @retval EFI_STATUS               Return the status of BdsLibConnectConsoleVariable ().

 

 **/

 EFI_STATUS

@@ -597,7 +595,7 @@ ConvertBmpToGopBlt (
   @param  Password        Password used to lock ConIn device.

 

   @retval EFI_SUCCESS     lock the Console In Spliter virtual handle successfully.

-  @retval EFI_UNSUPPORTED Password not found.

+  @retval EFI_UNSUPPORTED Password not found

 

 **/

 EFI_STATUS

@@ -621,21 +619,18 @@ LockKeyboards (
 

 /**

   Use Console Control to turn off UGA based Simple Text Out consoles from going

-  to the UGA device. Put up LogoFile on every UGA device that is a console.

+  to the UGA device. Put up LogoFile on every UGA device that is a console

 

-  @param  LogoFile        File name of logo to display on the center of the screen.

+  @param[in]  LogoFile   File name of logo to display on the center of the screen.

 

   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.

-  @retval EFI_UNSUPPORTED Logo not found.

-                          Fail to locate ConsoleControl protocol.

-                          Fail to get UgaDraw or Gop handle.

-                          Fail to switch grahic mode.

+  @retval EFI_UNSUPPORTED Logo not found

 

 **/

 EFI_STATUS

 EFIAPI

 EnableQuietBoot (

-  IN  EFI_GUID  *LogoFile   OPTIONAL

+  IN  EFI_GUID  *LogoFile

   )

 {

   EFI_STATUS                    Status;

@@ -877,8 +872,7 @@ EnableQuietBoot (
   Use Console Control to turn on UGA based Simple Text Out consoles. The UGA 

   Simple Text Out screens will now be synced up with all non UGA output devices

 

-  @retval EFI_SUCCESS          UGA devices are back in text mode and synced up.

-  @retval EFI_UNSUPPORTED      Fail to locate ConsoleControl Protocol.

+  @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.

 

 **/

 EFI_STATUS

diff --git a/MdeModulePkg/Library/GenericBdsLib/BdsMisc.c b/MdeModulePkg/Library/GenericBdsLib/BdsMisc.c
index 8b3dcd783b..9c426e5439 100644
--- a/MdeModulePkg/Library/GenericBdsLib/BdsMisc.c
+++ b/MdeModulePkg/Library/GenericBdsLib/BdsMisc.c
@@ -631,8 +631,8 @@ BdsLibGetBootMode (
   @param  VendorGuid            GUID part of EFI variable name

   @param  VariableSize          Returns the size of the EFI variable that was read

 

-  @return Dynamically allocated memory that contains a copy of the EFI variable.

-  @return Caller is responsible freeing the buffer.

+  @return                       Dynamically allocated memory that contains a copy of the EFI variable

+                                Caller is responsible freeing the buffer.

   @retval NULL                  Variable was not read

 

 **/

@@ -745,8 +745,8 @@ BdsLibDelPartMatchInstance (
   @param  Single                A pointer to a single-instance device path data

                                 structure.

 

-  @retval TRUE                  If the Single is contained within Multi

-  @retval FALSE                 The Single is not match within Multi

+  @retval TRUE                  If the Single device path is contained within Multi device path.

+  @retval FALSE                 The Single device path is not match within Multi device path.

 

 **/

 BOOLEAN

@@ -976,12 +976,12 @@ SetupResetReminder (
 }

 

 /**

-  Get the headers (dos, image, optional header) from an image.

+  Get the headers (dos, image, optional header) from an image

 

   @param  Device                SimpleFileSystem device handle

   @param  FileName              File name for the image

   @param  DosHeader             Pointer to dos header

-  @param  Hdr                   Pointer to optional header

+  @param  Hdr                   The buffer in which to return the PE32, PE32+, or TE header.

 

   @retval EFI_SUCCESS           Successfully get the machine type.

   @retval EFI_NOT_FOUND         The file is not found.

@@ -1229,8 +1229,8 @@ BdsSetMemoryTypeInformationVariable (
 }

 

 /**

-  This routine register a function to adjust the different type memory page number just before booting

-  and save the updated info into the variable for next boot to use.

+  This routine register a function to adjust the different type memory page number

+  just before booting and save the updated info into the variable for next boot to use.

 

 **/

 VOID

diff --git a/MdeModulePkg/Library/GenericBdsLib/DevicePath.c b/MdeModulePkg/Library/GenericBdsLib/DevicePath.c
index 478dfd81fa..1941372628 100644
--- a/MdeModulePkg/Library/GenericBdsLib/DevicePath.c
+++ b/MdeModulePkg/Library/GenericBdsLib/DevicePath.c
@@ -19,15 +19,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   Concatenates a formatted unicode string to allocated pool.

   The caller must free the resulting buffer.

 

-  @param  Str      Tracks the allocated pool, size in use, and  amount of pool

-                   allocated.

+  @param  Str      Tracks the allocated pool, size in use, and amount of pool allocated.

   @param  fmt      The format string

-

-  @param  ...      Variable argument list.

+  @param  ...      The data will be printed.

 

   @return Allocated buffer with the formatted string printed in it.

-          The caller must free the allocated buffer.   The buffer

-          allocation is not packed.

+          The caller must free the allocated buffer.

+          The buffer allocation is not packed.

 

 **/

 CHAR16 *

@@ -172,13 +170,10 @@ DevPathController (
 

 

 /**

-  Convert Device Path to a Unicode string for printing.

+  Convert Vendor device path to device name.

 

-  @param Str             The buffer holding the output string.

-                         This buffer contains the length of the

-                         string and the maixmum length reserved

-                         for the string buffer.

-  @param DevPath         The device path.

+  @param  Str      The buffer store device name

+  @param  DevPath  Pointer to vendor device path

 

 **/

 VOID