]>
Commit | Line | Data |
---|---|---|
697c6cf3 HW |
1 | /** @file\r |
2 | This file declares Graphics PPI.\r | |
3 | This PPI is the main interface exposed by the Graphics PEIM to be used by the\r | |
4 | other firmware modules.\r | |
5 | \r | |
6 | Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r | |
9344f092 | 7 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
697c6cf3 HW |
8 | \r |
9 | @par Revision Reference:\r | |
10 | This PPI is introduced in PI Version 1.4.\r | |
11 | \r | |
12 | **/\r | |
13 | \r | |
14 | #ifndef __PEI_GRAPHICS_PPI_H__\r | |
15 | #define __PEI_GRAPHICS_PPI_H__\r | |
16 | \r | |
17 | #include <Protocol/GraphicsOutput.h>\r | |
18 | \r | |
19 | #define EFI_PEI_GRAPHICS_PPI_GUID \\r | |
20 | { \\r | |
21 | 0x6ecd1463, 0x4a4a, 0x461b, { 0xaf, 0x5f, 0x5a, 0x33, 0xe3, 0xb2, 0x16, 0x2b } \\r | |
22 | }\r | |
23 | \r | |
24 | typedef struct _EFI_PEI_GRAPHICS_PPI EFI_PEI_GRAPHICS_PPI;\r | |
25 | \r | |
26 | /**\r | |
27 | The GraphicsPpiInit initializes the graphics subsystem in phases.\r | |
28 | \r | |
29 | @param[in] GraphicsPolicyPtr GraphicsPolicyPtr points to a configuration data\r | |
30 | block of policy settings required by Graphics PEIM.\r | |
31 | \r | |
32 | @retval EFI_SUCCESS The invocation was successful.\r | |
33 | @retval EFI_INVALID_PARAMETER The phase parameter is not valid.\r | |
34 | @retval EFI_NOT_ABORTED The stages was not called in the proper order.\r | |
35 | @retval EFI_NOT_FOUND The PeiGraphicsPlatformPolicyPpi is not located.\r | |
36 | @retval EFI_DEVICE_ERROR The initialization failed due to device error.\r | |
37 | @retval EFI_NOT_READY The previous init stage is still in progress and not\r | |
38 | ready for the current initialization phase yet. The\r | |
39 | platform code should call this again sometime later.\r | |
40 | **/\r | |
41 | typedef\r | |
42 | EFI_STATUS\r | |
43 | (EFIAPI *EFI_PEI_GRAPHICS_INIT) (\r | |
44 | IN VOID *GraphicsPolicyPtr\r | |
45 | );\r | |
46 | \r | |
47 | /**\r | |
48 | The GraphicsPpiGetMode returns the mode information supported by the Graphics PEI\r | |
49 | Module.\r | |
50 | \r | |
51 | @param[in, out] Mode Pointer to EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE data.\r | |
52 | \r | |
53 | @retval EFI_SUCCESS Valid mode information was returned.\r | |
54 | @retval EFI_INVALID_PARAMETER The Mode parameter is not valid.\r | |
55 | @retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the video\r | |
56 | mode.\r | |
57 | @retval EFI_NOT_READY The Graphics Initialization is not competed and Mode\r | |
58 | information is not yet available.The platform code\r | |
59 | should call this again after the Graphics\r | |
60 | initialization is done.\r | |
61 | **/\r | |
62 | typedef\r | |
63 | EFI_STATUS\r | |
64 | (EFIAPI *EFI_PEI_GRAPHICS_GET_MODE) (\r | |
65 | IN OUT EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE *Mode\r | |
66 | );\r | |
67 | \r | |
68 | ///\r | |
69 | /// This PPI is the main interface exposed by the Graphics PEIM to be used by the other\r | |
70 | /// firmware modules.\r | |
71 | ///\r | |
72 | struct _EFI_PEI_GRAPHICS_PPI {\r | |
73 | EFI_PEI_GRAPHICS_INIT GraphicsPpiInit;\r | |
74 | EFI_PEI_GRAPHICS_GET_MODE GraphicsPpiGetMode;\r | |
75 | };\r | |
76 | \r | |
77 | extern EFI_GUID gEfiPeiGraphicsPpiGuid;\r | |
78 | \r | |
79 | #endif\r |