]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/UgaDraw.h
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / MdePkg / Include / Protocol / UgaDraw.h
index b29a620c534f58d8ca6d983719f34f879efb2151..8d33bf873cad5eff2e8481a81368b2f8a3520867 100644 (file)
@@ -3,21 +3,14 @@
 \r
   Abstraction of a very simple graphics device.\r
 \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
-  http://opensource.org/licenses/bsd-license.php\r
-\r
-  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
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
 #ifndef __UGA_DRAW_H__\r
 #define __UGA_DRAW_H__\r
 \r
-\r
 #define EFI_UGA_DRAW_PROTOCOL_GUID \\r
   { \\r
     0x982c298b, 0xf4fa, 0x41cb, {0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 } \\r
@@ -73,45 +66,45 @@ EFI_STATUS
   );\r
 \r
 typedef struct {\r
-  UINT8 Blue;\r
-  UINT8 Green;\r
-  UINT8 Red;\r
-  UINT8 Reserved;\r
+  UINT8    Blue;\r
+  UINT8    Green;\r
+  UINT8    Red;\r
+  UINT8    Reserved;\r
 } EFI_UGA_PIXEL;\r
 \r
 typedef union {\r
-  EFI_UGA_PIXEL Pixel;\r
-  UINT32        Raw;\r
+  EFI_UGA_PIXEL    Pixel;\r
+  UINT32           Raw;\r
 } EFI_UGA_PIXEL_UNION;\r
 \r
-/**\r
- Enumration value for actions of Blt operations.\r
- **/\r
+///\r
+/// Enumration value for actions of Blt operations.\r
+///\r
 typedef enum {\r
   EfiUgaVideoFill,          ///< Write data from the  BltBuffer pixel (SourceX, SourceY)\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
-                            \r
+\r
   EfiUgaVideoToBltBuffer,   ///< Read data from the video display rectangle\r
                             ///< (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in\r
                             ///< the BltBuffer rectangle (DestinationX, DestinationY )\r
                             ///< (DestinationX + Width, DestinationY + Height). If DestinationX or\r
                             ///< DestinationY is not zero then Delta must be set to the length in bytes\r
                             ///< of a row in the BltBuffer.\r
-                            \r
+\r
   EfiUgaBltBufferToVideo,   ///< 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
                             ///< not zero then Delta must be set to the length in bytes of a row in the\r
                             ///< BltBuffer.\r
-  \r
+\r
   EfiUgaVideoToVideo,       ///< Copy from the video display rectangle (SourceX, SourceY)\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
-                            \r
+\r
   EfiUgaBltMax              ///< Maxmimum value for enumration value of Blt operation. If a Blt operation\r
                             ///< larger or equal to this enumration value, it is invalid.\r
 } EFI_UGA_BLT_OPERATION;\r
@@ -133,14 +126,14 @@ typedef enum {
 \r
     @retval EFI_SUCCESS           - The Blt operation completed.\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      - A hardware error occurred writting to the video buffer.\r
 \r
---*/\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_UGA_DRAW_PROTOCOL_BLT)(\r
-  IN  EFI_UGA_DRAW_PROTOCOL                   * This,\r
-  IN  EFI_UGA_PIXEL                           * BltBuffer, OPTIONAL\r
+  IN  EFI_UGA_DRAW_PROTOCOL                   *This,\r
+  IN  EFI_UGA_PIXEL                           *BltBuffer  OPTIONAL,\r
   IN  EFI_UGA_BLT_OPERATION                   BltOperation,\r
   IN  UINTN                                   SourceX,\r
   IN  UINTN                                   SourceY,\r
@@ -152,15 +145,15 @@ EFI_STATUS
   );\r
 \r
 ///\r
-/// This protocol provides a basic abstraction to set video modes and \r
-/// copy pixels to and from the graphics controller's frame buffer. \r
+/// This protocol provides a basic abstraction to set video modes and\r
+/// copy pixels to and from the graphics controller's frame buffer.\r
 ///\r
 struct _EFI_UGA_DRAW_PROTOCOL {\r
-  EFI_UGA_DRAW_PROTOCOL_GET_MODE  GetMode;\r
-  EFI_UGA_DRAW_PROTOCOL_SET_MODE  SetMode;\r
-  EFI_UGA_DRAW_PROTOCOL_BLT       Blt;\r
+  EFI_UGA_DRAW_PROTOCOL_GET_MODE    GetMode;\r
+  EFI_UGA_DRAW_PROTOCOL_SET_MODE    SetMode;\r
+  EFI_UGA_DRAW_PROTOCOL_BLT         Blt;\r
 };\r
 \r
-extern EFI_GUID gEfiUgaDrawProtocolGuid;\r
+extern EFI_GUID  gEfiUgaDrawProtocolGuid;\r
 \r
 #endif\r