sync GraphicsLib.h with Mde Library Spec.

[mirror_edk2.git] / MdePkg / Include / Library / GraphicsLib.h

diff --git a/MdePkg/Include/Library/GraphicsLib.h b/MdePkg/Include/Library/GraphicsLib.h
index 915c306ee15d3c87f35164da606870eeababee2c..50cb42137081478a45221e1155dee8da64804766 100644 (file)
--- a/MdePkg/Include/Library/GraphicsLib.h
+++ b/MdePkg/Include/Library/GraphicsLib.h
@@ -1,5 +1,5 @@
 /** @file\r
-  Library supports diplaying graphical splash screen,\r
+  Library supports displaying graphical splash screen,\r
   locking of keyboard input and printing character on\r
   screen.\r
 \r
@@ -30,11 +30,12 @@
                             buffer will be allocated.\r
   @param[out] ImageSize     Size of the graphics Image in bytes. Zero if no image found.\r
 \r
-  @retval   EFI_INVALID_PARAMETER  invalid parameter\r
-  @retval   EFI_UNSUPPORTED        Range can not be erased\r
-  @retval   EFI_SUCCESS            Image and ImageSize are valid. \r
-  @retval   EFI_BUFFER_TOO_SMALL   Image not big enough. ImageSize has required size\r
-  @retval   EFI_NOT_FOUND          FileNameGuid not found\r
+  @retval  EFI_SUCCESS          The image is found and data and size is returned.\r
+  @retval  EFI_UNSUPPORTED      FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
+  @retval  EFI_NOT_FOUND        The image specified by NameGuid and SectionType can't be found.\r
+  @retval  EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
+  @retval  EFI_DEVICE_ERROR        A hardware error occurs during reading from the Firmware Volume.\r
+  @retval  EFI_ACCESS_DENIED    The firmware volume containing the searched Firmware File is configured to disallow reads.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -58,11 +59,12 @@ GetGraphicsBitMapFromFV (
                             buffer will be allocated.\r
   @param[out] ImageSize     Size of the graphics Image in bytes. Zero if no image found.\r
 \r
-  @retval   EFI_INVALID_PARAMETER  invalid parameter\r
-  @retval   EFI_UNSUPPORTED        Range can not be erased\r
-  @retval   EFI_SUCCESS            Image and ImageSize are valid. \r
-  @retval   EFI_BUFFER_TOO_SMALL   Image not big enough. ImageSize has required size\r
-  @retval   EFI_NOT_FOUND          FileNameGuid not found\r
+  @retval  EFI_SUCCESS          The image is found and data and size is returned.\r
+  @retval  EFI_UNSUPPORTED      FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
+  @retval  EFI_NOT_FOUND        The image specified by NameGuid and SectionType can't be found.\r
+  @retval  EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
+  @retval  EFI_DEVICE_ERROR        A hardware error occurs during reading from the Firmware Volume.\r
+  @retval  EFI_ACCESS_DENIED    The firmware volume containing the searched Firmware File is configured to disallow reads.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -134,8 +136,7 @@ DisableQuietBoot (
 \r
   @param[in]  Password   Password used to lock ConIn device.\r
 \r
-  @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo\r
-                          displayed.\r
+  @retval EFI_SUCCESS     lock the Console In Spliter virtual handle successfully.\r
   @retval EFI_UNSUPPORTED Password not found\r
 \r
 **/\r
@@ -147,7 +148,7 @@ LockKeyboards (
 \r
 \r
 /**\r
-  Print to graphics screen at the given X,Y coordinates of the graphics screen.\r
+  Print Unicode string to graphics screen at the given X,Y coordinates of the graphics screen.\r
   see definition of Print to find rules for constructing Fmt.\r
 \r
   @param[in]  X            Row to start printing at\r