Updated GraphicsOutput.h to follow UEFI 2.3.1 c spec.

Signed-off-by: Li Elvin <elvin.li@intel.com>
Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13598 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Protocol/GraphicsOutput.h b/MdePkg/Include/Protocol/GraphicsOutput.h
index 55cafb1b02b285b2f5a8c8c4d89bc72f5a1b4c43..741007c15b2436d77f4bdad165d00d3210d1e1d2 100644 (file)
--- a/MdePkg/Include/Protocol/GraphicsOutput.h
+++ b/MdePkg/Include/Protocol/GraphicsOutput.h
@@ -3,7 +3,7 @@
 \r
   Abstraction of a very simple graphics device.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2012, 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
@@ -101,11 +101,9 @@ typedef struct {
   @param  SizeOfInfo            A pointer to the size, in bytes, of the Info buffer.\r
   @param  Info                  A pointer to callee allocated buffer that returns information about ModeNumber.\r
 \r
-  @retval EFI_SUCCESS           Mode information returned.\r
-  @retval EFI_BUFFER_TOO_SMALL  The Info buffer was too small.\r
+  @retval EFI_SUCCESS           Valid mode information was returned.\r
   @retval EFI_DEVICE_ERROR      A hardware error occurred trying to retrieve the video mode.\r
-  @retval EFI_NOT_STARTED       Video display is not initialized. Call SetMode ()\r
-  @retval EFI_INVALID_PARAMETER One of the input args was NULL.\r
+  @retval EFI_INVALID_PARAMETER ModeNumber is not valid.\r
 \r
 **/\r
 typedef\r
@@ -153,7 +151,7 @@ typedef union {
 ///\r
 typedef enum {\r
   ///\r
-  /// Write data from the  BltBuffer pixel (SourceX, SourceY) \r
+  /// Write data from the BltBuffer pixel (0, 0) \r
   /// directly to every pixel of the video display rectangle \r
   /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). \r
   /// Only one pixel will be used from the BltBuffer. Delta is NOT used.  \r
@@ -171,7 +169,7 @@ typedef enum {
   EfiBltVideoToBltBuffer,\r
   \r
   ///\r
-  /// Write data from the  BltBuffer rectangle \r
+  /// Write data from the BltBuffer rectangle \r
   /// (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the \r
   /// video display rectangle (DestinationX, DestinationY) \r
   /// (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is \r
@@ -182,10 +180,9 @@ typedef enum {
   \r
   ///\r
   /// Copy from the video display rectangle (SourceX, SourceY)\r
-  /// (SourceX + Width, SourceY + Height) .to the video display rectangle \r
+  /// (SourceX + Width, SourceY + Height) to the video display rectangle \r
   /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). \r
-  /// The BltBuffer and Delta  are not used in this mode.\r
-  /// EfiBltVideoToVideo,\r
+  /// The BltBuffer and Delta are not used in this mode.\r
   ///\r
   EfiBltVideoToVideo,\r
   \r
@@ -196,20 +193,23 @@ typedef enum {
   Blt a rectangle of pixels on the graphics screen. Blt stands for BLock Transfer.\r
   \r
   @param  This         Protocol instance pointer.\r
-  @param  BltBuffer    Buffer containing data to blit into video buffer. This\r
-                       buffer has a size of Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
-  @param  BltOperation Operation to perform on BlitBuffer and video memory\r
-  @param  SourceX      X coordinate of source for the BltBuffer.\r
-  @param  SourceY      Y coordinate of source for the BltBuffer.\r
-  @param  DestinationX X coordinate of destination for the BltBuffer.\r
-  @param  DestinationY Y coordinate of destination for the BltBuffer.\r
-  @param  Width        Width of rectangle in BltBuffer in pixels.\r
-  @param  Height       Hight of rectangle in BltBuffer in pixels.\r
-  @param  Delta        OPTIONAL\r
+  @param  BltBuffer    The data to transfer to the graphics screen.\r
+                       Size is at least Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL).\r
+  @param  BltOperation The operation to perform when copying BltBuffer on to the graphics screen.\r
+  @param  SourceX      The X coordinate of source for the BltOperation.\r
+  @param  SourceY      The Y coordinate of source for the BltOperation.\r
+  @param  DestinationX The X coordinate of destination for the BltOperation.\r
+  @param  DestinationY The Y coordinate of destination for the BltOperation.\r
+  @param  Width        The width of a rectangle in the blt rectangle in pixels.\r
+  @param  Height       The height of a rectangle in the blt rectangle in pixels.\r
+  @param  Delta        Not used for EfiBltVideoFill or the EfiBltVideoToVideo operation.\r
+                       If a Delta of zero is used, the entire BltBuffer is being operated on.\r
+                       If a subrectangle of the BltBuffer is being used then Delta\r
+                       represents the number of bytes in a row of the BltBuffer.\r
 \r
-  @retval EFI_SUCCESS           The Blt operation completed.\r
+  @retval EFI_SUCCESS           BltBuffer was drawn to the graphics screen.\r
   @retval EFI_INVALID_PARAMETER BltOperation is not valid.\r
-  @retval EFI_DEVICE_ERROR      A hardware error occured writting to the video buffer.\r
+  @retval EFI_DEVICE_ERROR      The device had an error and could not complete the request.\r
 \r
 **/\r
 typedef\r
@@ -250,7 +250,8 @@ typedef struct {
   ///\r
   EFI_PHYSICAL_ADDRESS                   FrameBufferBase;\r
   ///\r
-  /// Size of the frame buffer represented by FrameBufferBase in bytes.\r
+  /// Amount of frame buffer needed to support the active mode as defined by \r
+  /// PixelsPerScanLine xVerticalResolution x PixelElementSize.\r
   ///\r
   UINTN                                  FrameBufferSize;\r
 } EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE;\r