Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/GraphicsOutput.h b/MdePkg/Include/Protocol/GraphicsOutput.h
index 1b4e1fca06f97df04073e9fc2d15965da288a803..110691328e5d0e426eb24c5842e7f35a88436487 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, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. 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
@@ -12,13 +12,13 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  GraphicsOutput.h\r
-\r
 **/\r
 \r
 #ifndef __GRAPHICS_OUTPUT_H__\r
 #define __GRAPHICS_OUTPUT_H__\r
 \r
+#include <PiDxe.h>\r
+\r
 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \\r
   { \\r
     0x9042a9de, 0x23dc, 0x4a38, {0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a } \\r
@@ -67,7 +67,7 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE) (\r
+(EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE)(\r
   IN  EFI_GRAPHICS_OUTPUT_PROTOCOL          *This,\r
   IN  UINT32                                ModeNumber,\r
   OUT UINTN                                 *SizeOfInfo,\r
@@ -88,7 +88,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE) (\r
+(EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE)(\r
   IN  EFI_GRAPHICS_OUTPUT_PROTOCOL *This,\r
   IN  UINT32                       ModeNumber\r
   )\r
@@ -160,7 +160,7 @@ typedef enum {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT) (\r
+(EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT)(\r
   IN  EFI_GRAPHICS_OUTPUT_PROTOCOL            *This,\r
   IN  EFI_GRAPHICS_OUTPUT_BLT_PIXEL           *BltBuffer,   OPTIONAL\r
   IN  EFI_GRAPHICS_OUTPUT_BLT_OPERATION       BltOperation,\r
@@ -182,6 +182,27 @@ typedef struct {
   UINTN                                  FrameBufferSize;\r
 } EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE;\r
 \r
+/**\r
+  @par Protocol Description:\r
+  Provides a basic abstraction to set video modes and copy pixels to and from \r
+  the graphics controller's frame buffer. The linear address of the hardware \r
+  frame buffer is also exposed so software can write directly to the video hardware.\r
+\r
+  @param QueryMode\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 SetMode \r
+  Set the video device into the specified mode and clears the visible portions \r
+  of the output display to black.\r
+  \r
+  @param Blt\r
+  Software abstraction to draw on the video device's frame buffer.\r
+  \r
+  @param Mode\r
+  Pointer to EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE data.\r
+\r
+**/\r
 struct _EFI_GRAPHICS_OUTPUT_PROTOCOL {\r
   EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE  QueryMode;\r
   EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE    SetMode;\r