diff options
| author | Hao Wu <hao.a.wu@intel.com> | 2015-04-28 07:18:15 +0000 |
|---|---|---|
| committer | hwu1225 <hwu1225@Edk2> | 2015-04-28 07:18:15 +0000 |
| commit | 697c6cf32693afe91e86ef2a498f57d9fbfe047c (patch) | |
| tree | ee55e3e1b5a62177008ebff6b5cc09cb1bae3421 /MdePkg/Include/Ppi | |
| parent | b9459211df1f11c62908d73188ca9573aa6720f8 (diff) | |
| download | edk2-697c6cf32693afe91e86ef2a498f57d9fbfe047c.tar.gz edk2-697c6cf32693afe91e86ef2a498f57d9fbfe047c.tar.bz2 edk2-697c6cf32693afe91e86ef2a498f57d9fbfe047c.zip | |
MdePkg: Add PI 1.4 Graphics HOB and PPI header files
The PeiGraphicsPpi is the main interface exposed by the Graphics PEIM to
be used by the other firmware modules.
When graphics capability is included in PEI, it produces a
EFI_PEI_GRAPHICS_INFO_HOB which provides information about the graphics
mode and the framebuffer.
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17233 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Ppi')
| -rw-r--r-- | MdePkg/Include/Ppi/Graphics.h | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/MdePkg/Include/Ppi/Graphics.h b/MdePkg/Include/Ppi/Graphics.h new file mode 100644 index 0000000000..5181892c27 --- /dev/null +++ b/MdePkg/Include/Ppi/Graphics.h @@ -0,0 +1,85 @@ +/** @file
+ This file declares Graphics PPI.
+ This PPI is the main interface exposed by the Graphics PEIM to be used by the
+ other firmware modules.
+
+ Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
+ This program and the accompanying materials
+ are licensed and made available under the terms and conditions of the BSD License
+ which accompanies this distribution. The full text of the license may be found at
+ http://opensource.org/licenses/bsd-license.php
+
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+ @par Revision Reference:
+ This PPI is introduced in PI Version 1.4.
+
+**/
+
+#ifndef __PEI_GRAPHICS_PPI_H__
+#define __PEI_GRAPHICS_PPI_H__
+
+#include <Protocol/GraphicsOutput.h>
+
+#define EFI_PEI_GRAPHICS_PPI_GUID \
+ { \
+ 0x6ecd1463, 0x4a4a, 0x461b, { 0xaf, 0x5f, 0x5a, 0x33, 0xe3, 0xb2, 0x16, 0x2b } \
+ }
+
+typedef struct _EFI_PEI_GRAPHICS_PPI EFI_PEI_GRAPHICS_PPI;
+
+/**
+ The GraphicsPpiInit initializes the graphics subsystem in phases.
+
+ @param[in] GraphicsPolicyPtr GraphicsPolicyPtr points to a configuration data
+ block of policy settings required by Graphics PEIM.
+
+ @retval EFI_SUCCESS The invocation was successful.
+ @retval EFI_INVALID_PARAMETER The phase parameter is not valid.
+ @retval EFI_NOT_ABORTED The stages was not called in the proper order.
+ @retval EFI_NOT_FOUND The PeiGraphicsPlatformPolicyPpi is not located.
+ @retval EFI_DEVICE_ERROR The initialization failed due to device error.
+ @retval EFI_NOT_READY The previous init stage is still in progress and not
+ ready for the current initialization phase yet. The
+ platform code should call this again sometime later.
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_PEI_GRAPHICS_INIT) (
+ IN VOID *GraphicsPolicyPtr
+ );
+
+/**
+ The GraphicsPpiGetMode returns the mode information supported by the Graphics PEI
+ Module.
+
+ @param[in, out] Mode Pointer to EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE data.
+
+ @retval EFI_SUCCESS Valid mode information was returned.
+ @retval EFI_INVALID_PARAMETER The Mode parameter is not valid.
+ @retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the video
+ mode.
+ @retval EFI_NOT_READY The Graphics Initialization is not competed and Mode
+ information is not yet available.The platform code
+ should call this again after the Graphics
+ initialization is done.
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_PEI_GRAPHICS_GET_MODE) (
+ IN OUT EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE *Mode
+ );
+
+///
+/// This PPI is the main interface exposed by the Graphics PEIM to be used by the other
+/// firmware modules.
+///
+struct _EFI_PEI_GRAPHICS_PPI {
+ EFI_PEI_GRAPHICS_INIT GraphicsPpiInit;
+ EFI_PEI_GRAPHICS_GET_MODE GraphicsPpiGetMode;
+};
+
+extern EFI_GUID gEfiPeiGraphicsPpiGuid;
+
+#endif
|