]>
Commit | Line | Data |
---|---|---|
6313eb25 RN |
1 | /** @file\r |
2 | The Platform Logo Protocol defines the interface to get the Platform logo\r | |
3 | image with the display attribute.\r | |
4 | \r | |
de707b08 | 5 | Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r |
6313eb25 RN |
6 | This program and the accompanying materials are licensed and made available under \r |
7 | the terms and conditions of the BSD License that accompanies this distribution. \r | |
8 | The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php. \r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | #ifndef __PLATFORM_LOGO_H__\r | |
17 | #define __PLATFORM_LOGO_H__\r | |
18 | \r | |
e0ac9c8a RN |
19 | #include <Protocol/HiiImage.h>\r |
20 | \r | |
6313eb25 RN |
21 | //\r |
22 | // GUID for EDKII Platform Logo Protocol\r | |
23 | //\r | |
24 | #define EDKII_PLATFORM_LOGO_PROTOCOL_GUID \\r | |
e0ac9c8a | 25 | { 0x53cd299f, 0x2bc1, 0x40c0, { 0x8c, 0x07, 0x23, 0xf6, 0x4f, 0xdb, 0x30, 0xe0 } }\r |
6313eb25 RN |
26 | \r |
27 | typedef struct _EDKII_PLATFORM_LOGO_PROTOCOL EDKII_PLATFORM_LOGO_PROTOCOL;\r | |
28 | \r | |
6313eb25 RN |
29 | typedef enum {\r |
30 | EdkiiPlatformLogoDisplayAttributeLeftTop,\r | |
31 | EdkiiPlatformLogoDisplayAttributeCenterTop,\r | |
32 | EdkiiPlatformLogoDisplayAttributeRightTop,\r | |
33 | EdkiiPlatformLogoDisplayAttributeCenterRight,\r | |
34 | EdkiiPlatformLogoDisplayAttributeRightBottom,\r | |
35 | EdkiiPlatformLogoDisplayAttributeCenterBottom,\r | |
36 | EdkiiPlatformLogoDisplayAttributeLeftBottom,\r | |
37 | EdkiiPlatformLogoDisplayAttributeCenterLeft,\r | |
38 | EdkiiPlatformLogoDisplayAttributeCenter\r | |
39 | } EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE;\r | |
40 | \r | |
41 | /**\r | |
6313eb25 RN |
42 | Load a platform logo image and return its data and attributes.\r |
43 | \r | |
44 | @param This The pointer to this protocol instance.\r | |
45 | @param Instance The visible image instance is found.\r | |
de707b08 | 46 | @param Image Points to the image.\r |
6313eb25 | 47 | @param Attribute The display attributes of the image returned.\r |
c25be72e RN |
48 | @param OffsetX The X offset of the image regarding the Attribute.\r |
49 | @param OffsetY The Y offset of the image regarding the Attribute.\r | |
6313eb25 RN |
50 | \r |
51 | @retval EFI_SUCCESS The image was fetched successfully.\r | |
52 | @retval EFI_NOT_FOUND The specified image could not be found.\r | |
6313eb25 RN |
53 | **/\r |
54 | typedef\r | |
55 | EFI_STATUS\r | |
56 | (EFIAPI *EDKII_PLATFORM_LOGO_GET_IMAGE)(\r | |
57 | IN EDKII_PLATFORM_LOGO_PROTOCOL *This,\r | |
58 | IN OUT UINT32 *Instance,\r | |
e0ac9c8a | 59 | OUT EFI_IMAGE_INPUT *Image,\r |
6313eb25 | 60 | OUT EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE *Attribute,\r |
c25be72e RN |
61 | OUT INTN *OffsetX,\r |
62 | OUT INTN *OffsetY\r | |
e0ac9c8a | 63 | );\r |
6313eb25 RN |
64 | \r |
65 | \r | |
66 | struct _EDKII_PLATFORM_LOGO_PROTOCOL {\r | |
67 | EDKII_PLATFORM_LOGO_GET_IMAGE GetImage;\r | |
68 | };\r | |
69 | \r | |
70 | \r | |
71 | extern EFI_GUID gEdkiiPlatformLogoProtocolGuid;\r | |
72 | \r | |
73 | #endif\r |