According to the latest UEFI 2.3 errata B, the following changes are made:

[mirror_edk2.git] / MdePkg / Include / Protocol / GraphicsOutput.h

diff --git a/MdePkg/Include/Protocol/GraphicsOutput.h b/MdePkg/Include/Protocol/GraphicsOutput.h
index 8e701c21ca89a674a519f7c217c7cc4573b04fbd..8d63f9787e952a67b903c23395a12b1a58bc0fc9 100644 (file)
--- a/MdePkg/Include/Protocol/GraphicsOutput.h
+++ b/MdePkg/Include/Protocol/GraphicsOutput.h
@@ -32,29 +32,74 @@ typedef struct {
 } EFI_PIXEL_BITMASK;\r
 \r
 typedef enum {\r
+  ///\r
+  /// A pixel is 32-bits and byte zero represents red, byte one represents green, \r
+  /// byte two represents blue, and byte three is reserved. This is the definition \r
+  /// for the physical frame buffer. The byte values for the red, green, and blue \r
+  /// components represent the color intensity. This color intensity value range \r
+  /// from a minimum intensity of 0 to maximum intensity of 255.\r
+  ///\r
   PixelRedGreenBlueReserved8BitPerColor,\r
+  ///\r
+  /// A pixel is 32-bits and byte zero represents blue, byte one represents green, \r
+  /// byte two represents red, and byte three is reserved. This is the definition \r
+  /// for the physical frame buffer. The byte values for the red, green, and blue \r
+  /// components represent the color intensity. This color intensity value range \r
+  /// from a minimum intensity of 0 to maximum intensity of 255.\r
+  ///\r
   PixelBlueGreenRedReserved8BitPerColor,\r
+  ///\r
+  /// The Pixel definition of the physical frame buffer.\r
+  ///\r
   PixelBitMask,\r
+  ///\r
+  /// This mode does not support a physical frame buffer.\r
+  ///\r
   PixelBltOnly,\r
+  ///\r
+  /// Valid EFI_GRAPHICS_PIXEL_FORMAT enum values are less than this value.\r
+  ///\r
   PixelFormatMax\r
 } EFI_GRAPHICS_PIXEL_FORMAT;\r
 \r
 typedef struct {\r
+  ///\r
+  /// The version of this data structure. A value of zero represents the \r
+  /// EFI_GRAPHICS_OUTPUT_MODE_INFORMATION structure as defined in this specification.\r
+  ///\r
   UINT32                     Version;\r
+  ///\r
+  /// The size of video screen in pixels in the X dimension.\r
+  ///\r
   UINT32                     HorizontalResolution;\r
+  ///\r
+  /// The size of video screen in pixels in the Y dimension.\r
+  ///\r
   UINT32                     VerticalResolution;\r
+  ///\r
+  /// Enumeration that defines the physical format of the pixel. A value of PixelBltOnly \r
+  /// implies that a linear frame buffer is not available for this mode.\r
+  ///\r
   EFI_GRAPHICS_PIXEL_FORMAT  PixelFormat;\r
+  ///\r
+  /// This bit-mask is only valid if PixelFormat is set to PixelPixelBitMask. \r
+  /// A bit being set defines what bits are used for what purpose such as Red, Green, Blue, or Reserved.\r
+  ///\r
   EFI_PIXEL_BITMASK          PixelInformation;\r
+  ///\r
+  /// Defines the number of pixel elements per video memory line.\r
+  /// \r
   UINT32                     PixelsPerScanLine;\r
 } EFI_GRAPHICS_OUTPUT_MODE_INFORMATION;\r
 \r
 /**\r
-  Return the current video mode information.\r
+  Returns information for an available graphics mode that the graphics device\r
+  and the set of active video output devices supports.\r
 \r
-  @param  This       Protocol instance pointer.\r
-  @param  ModeNumber The mode number to return information on.\r
-  @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
+  @param  This                  The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.\r
+  @param  ModeNumber            The mode number to return information on.\r
+  @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
@@ -73,12 +118,13 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Return the current video mode information.\r
+  Set the video device into the specified mode and clears the visible portions of \r
+  the output display to black.\r
 \r
-  @param  This              Protocol instance pointer.\r
-  @param  ModeNumber        The mode number to be set.\r
+  @param  This              The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.\r
+  @param  ModeNumber        Abstraction that defines the current video mode.\r
 \r
-  @retval EFI_SUCCESS       Graphics mode was changed.\r
+  @retval EFI_SUCCESS       The graphics mode specified by ModeNumber was selected.\r
   @retval EFI_DEVICE_ERROR  The device had an error and could not complete the request.\r
   @retval EFI_UNSUPPORTED   ModeNumber is not supported by this device.\r
 \r
@@ -182,11 +228,30 @@ EFI_STATUS
   );\r
 \r
 typedef struct {\r
+  ///\r
+  /// The number of modes supported by QueryMode() and SetMode().\r
+  ///\r
   UINT32                                 MaxMode;\r
+  ///\r
+  /// Current Mode of the graphics device. Valid mode numbers are 0 to MaxMode -1.\r
+  ///\r
   UINT32                                 Mode;\r
+  ///\r
+  /// Pointer to read-only EFI_GRAPHICS_OUTPUT_MODE_INFORMATION data.\r
+  ///\r
   EFI_GRAPHICS_OUTPUT_MODE_INFORMATION   *Info;\r
+  ///\r
+  /// Size of Info structure in bytes.\r
+  ///\r
   UINTN                                  SizeOfInfo;\r
+  ///\r
+  /// Base address of graphics linear frame buffer.\r
+  /// Offset zero in FrameBufferBase represents the upper left pixel of the display.\r
+  ///\r
   EFI_PHYSICAL_ADDRESS                   FrameBufferBase;\r
+  ///\r
+  /// Size of the frame buffer represented by FrameBufferBase in bytes.\r
+  ///\r
   UINTN                                  FrameBufferSize;\r
 } EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE;\r
 \r