Update comments for Protocol definitions to match UEFI spec.

And add the missing comments for the data structure.

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

1 files changed, 63 insertions, 0 deletions

diff --git a/MdePkg/Include/Protocol/GraphicsOutput.h b/MdePkg/Include/Protocol/GraphicsOutput.h
index 8e701c21ca..7782f5d7c3 100644
--- a/MdePkg/Include/Protocol/GraphicsOutput.h
+++ b/MdePkg/Include/Protocol/GraphicsOutput.h
@@ -32,19 +32,63 @@ typedef struct {
 } EFI_PIXEL_BITMASK;

 

 typedef enum {

+  ///

+  /// A pixel is 32-bits and byte zero represents red, byte one represents green, 

+  /// byte two represents blue, and byte three is reserved. This is the definition 

+  /// for the physical frame buffer. The byte values for the red, green, and blue 

+  /// components represent the color intensity. This color intensity value range 

+  /// from a minimum intensity of 0 to maximum intensity of 255.

+  ///

   PixelRedGreenBlueReserved8BitPerColor,

+  ///

+  /// A pixel is 32-bits and byte zero represents blue, byte one represents green, 

+  /// byte two represents red, and byte three is reserved. This is the definition 

+  /// for the physical frame buffer. The byte values for the red, green, and blue 

+  /// components represent the color intensity. This color intensity value range 

+  /// from a minimum intensity of 0 to maximum intensity of 255.

+  ///

   PixelBlueGreenRedReserved8BitPerColor,

+  ///

+  /// The Pixel definition of the physical frame buffer.

+  ///

   PixelBitMask,

+  ///

+  /// This mode does not support a physical frame buffer.

+  ///

   PixelBltOnly,

+  ///

+  /// Valid EFI_GRAPHICS_PIXEL_FORMAT enum values are less than this value.

+  ///

   PixelFormatMax

 } EFI_GRAPHICS_PIXEL_FORMAT;

 

 typedef struct {

+  ///

+  /// The version of this data structure. A value of zero represents the 

+  /// EFI_GRAPHICS_OUTPUT_MODE_INFORMATION structure as defined in this specification.

+  ///

   UINT32                     Version;

+  ///

+  /// The size of video screen in pixels in the X dimension.

+  ///

   UINT32                     HorizontalResolution;

+  ///

+  /// The size of video screen in pixels in the Y dimension.

+  ///

   UINT32                     VerticalResolution;

+  ///

+  /// Enumeration that defines the physical format of the pixel. A value of PixelBltOnly 

+  /// implies that a linear frame buffer is not available for this mode.

+  ///

   EFI_GRAPHICS_PIXEL_FORMAT  PixelFormat;

+  ///

+  /// This bit-mask is only valid if PixelFormat is set to PixelPixelBitMask. 

+  /// A bit being set defines what bits are used for what purpose such as Red, Green, Blue, or Reserved.

+  ///

   EFI_PIXEL_BITMASK          PixelInformation;

+  ///

+  /// Defines the number of pixel elements per video memory line.

+  /// 

   UINT32                     PixelsPerScanLine;

 } EFI_GRAPHICS_OUTPUT_MODE_INFORMATION;

 

@@ -182,11 +226,30 @@ EFI_STATUS
   );

 

 typedef struct {

+  ///

+  /// The number of modes supported by QueryMode() and SetMode().

+  ///

   UINT32                                 MaxMode;

+  ///

+  /// Current Mode of the graphics device. Valid mode numbers are 0 to MaxMode -1.

+  ///

   UINT32                                 Mode;

+  ///

+  /// Pointer to read-only EFI_GRAPHICS_OUTPUT_MODE_INFORMATION data.

+  ///

   EFI_GRAPHICS_OUTPUT_MODE_INFORMATION   *Info;

+  ///

+  /// Size of Info structure in bytes.

+  ///

   UINTN                                  SizeOfInfo;

+  ///

+  /// Base address of graphics linear frame buffer.

+  /// Offset zero in FrameBufferBase represents the upper left pixel of the display.

+  ///

   EFI_PHYSICAL_ADDRESS                   FrameBufferBase;

+  ///

+  /// Size of the frame buffer represented by FrameBufferBase in bytes.

+  ///

   UINTN                                  FrameBufferSize;

 } EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE;