Graphics.h File Reference

#include <Protocol/GraphicsOutput.h>

Go to the source code of this file.

Data Structures
struct	_EFI_PEI_GRAPHICS_PPI

Macros
#define	EFI_PEI_GRAPHICS_PPI_GUID

Typedefs
typedef struct _EFI_PEI_GRAPHICS_PPI	EFI_PEI_GRAPHICS_PPI
typedef EFI_STATUS(EFIAPI *	EFI_PEI_GRAPHICS_INIT) (IN VOID *GraphicsPolicyPtr)
typedef EFI_STATUS(EFIAPI *	EFI_PEI_GRAPHICS_GET_MODE) (IN OUT EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE *Mode)

Variables
EFI_GUID	gEfiPeiGraphicsPpiGuid

Detailed Description

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.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:

This PPI is introduced in PI Version 1.4.

Definition in file Graphics.h.

Macro Definition Documentation

EFI_PEI_GRAPHICS_PPI_GUID

#define EFI_PEI_GRAPHICS_PPI_GUID

Value:

  { \
    0x6ecd1463, 0x4a4a, 0x461b, { 0xaf, 0x5f, 0x5a, 0x33, 0xe3, 0xb2, 0x16, 0x2b } \
  }

Definition at line 19 of file Graphics.h.

Typedef Documentation

EFI_PEI_GRAPHICS_GET_MODE

typedef EFI_STATUS(EFIAPI * EFI_PEI_GRAPHICS_GET_MODE) (IN OUT EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE *Mode)

The GraphicsPpiGetMode returns the mode information supported by the Graphics PEI Module.

Parameters

[in,out]

Mode

Pointer to EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE data.

Return values

EFI_SUCCESS	Valid mode information was returned.
EFI_INVALID_PARAMETER	The Mode parameter is not valid.
EFI_DEVICE_ERROR	A hardware error occurred trying to retrieve the video mode.
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.

Definition at line 63 of file Graphics.h.

EFI_PEI_GRAPHICS_INIT

typedef EFI_STATUS(EFIAPI * EFI_PEI_GRAPHICS_INIT) (IN VOID *GraphicsPolicyPtr)

The GraphicsPpiInit initializes the graphics subsystem in phases.

Parameters

[in]

GraphicsPolicyPtr

GraphicsPolicyPtr points to a configuration data block of policy settings required by Graphics PEIM.

Return values

EFI_SUCCESS	The invocation was successful.
EFI_INVALID_PARAMETER	The phase parameter is not valid.
EFI_NOT_ABORTED	The stages was not called in the proper order.
EFI_NOT_FOUND	The PeiGraphicsPlatformPolicyPpi is not located.
EFI_DEVICE_ERROR	The initialization failed due to device error.
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.

Definition at line 42 of file Graphics.h.

EFI_PEI_GRAPHICS_PPI

typedef struct _EFI_PEI_GRAPHICS_PPI EFI_PEI_GRAPHICS_PPI

Definition at line 24 of file Graphics.h.