]>
Commit | Line | Data |
---|---|---|
1e354c03 | 1 | /** @file\r |
346cf9ac LG |
2 | The OEM Badging Protocol defines the interface to get the OEM badging \r |
3 | image with the dispaly attribute. This protocol can be produced based on OEM badging images.\r | |
88f20127 | 4 | \r |
1e354c03 | 5 | Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r |
88f20127 | 6 | All rights reserved. This program and the accompanying materials\r |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. 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 | |
1e354c03 | 14 | **/\r |
88f20127 | 15 | \r |
16 | #ifndef __EFI_OEM_BADGING_H__\r | |
17 | #define __EFI_OEM_BADGING_H__\r | |
18 | \r | |
19 | //\r | |
20 | // GUID for EFI OEM Badging Protocol\r | |
21 | //\r | |
22 | #define EFI_OEM_BADGING_PROTOCOL_GUID \\r | |
23 | { 0x170e13c0, 0xbf1b, 0x4218, {0x87, 0x1d, 0x2a, 0xbd, 0xc6, 0xf8, 0x87, 0xbc } }\r | |
24 | \r | |
25 | \r | |
26 | typedef struct _EFI_OEM_BADGING_PROTOCOL EFI_OEM_BADGING_PROTOCOL;\r | |
27 | \r | |
28 | typedef enum {\r | |
29 | EfiBadgingFormatBMP,\r | |
30 | EfiBadgingFormatJPEG,\r | |
31 | EfiBadgingFormatTIFF,\r | |
32 | EfiBadgingFormatGIF,\r | |
33 | EfiBadgingFormatUnknown\r | |
34 | } EFI_BADGING_FORMAT;\r | |
35 | \r | |
36 | typedef enum {\r | |
37 | EfiBadgingDisplayAttributeLeftTop,\r | |
38 | EfiBadgingDisplayAttributeCenterTop,\r | |
39 | EfiBadgingDisplayAttributeRightTop,\r | |
40 | EfiBadgingDisplayAttributeCenterRight,\r | |
41 | EfiBadgingDisplayAttributeRightBottom,\r | |
42 | EfiBadgingDisplayAttributeCenterBottom,\r | |
43 | EfiBadgingDisplayAttributeLeftBottom,\r | |
44 | EfiBadgingDisplayAttributeCenterLeft,\r | |
45 | EfiBadgingDisplayAttributeCenter,\r | |
46 | EfiBadgingDisplayAttributeCustomized\r | |
47 | } EFI_BADGING_DISPLAY_ATTRIBUTE;\r | |
48 | \r | |
5f597758 | 49 | /**\r |
88f20127 | 50 | \r |
346cf9ac | 51 | Load an OEM badge image and return its data as well as attributes.\r |
5f597758 LG |
52 | \r |
53 | @param This Pointer to this protocol instance.\r | |
346cf9ac | 54 | @param Instance The visiable image instance is found.\r |
5f597758 LG |
55 | @param Format Format of the image such as BMP,JPEG,etc.\r |
56 | @param ImageData Image data returned.\r | |
57 | @param ImageSize Size of the image returned.\r | |
58 | @param Attribute Display attributes of the image returned.\r | |
59 | @param CoordinateX X coordinate of the image.\r | |
60 | @param CoordinateY Y coordinate of the image.\r | |
61 | \r | |
62 | @retval EFI_SUCCESS Image has been fetched successfully.\r | |
63 | @retval EFI_NOT_FOUND The specified image could not be found.\r | |
64 | \r | |
65 | **/\r | |
88f20127 | 66 | typedef\r |
67 | EFI_STATUS\r | |
7d839888 | 68 | (EFIAPI *EFI_BADGING_GET_IMAGE)(\r |
88f20127 | 69 | IN EFI_OEM_BADGING_PROTOCOL *This,\r |
70 | IN OUT UINT32 *Instance,\r | |
71 | OUT EFI_BADGING_FORMAT *Format,\r | |
72 | OUT UINT8 **ImageData,\r | |
73 | OUT UINTN *ImageSize,\r | |
74 | OUT EFI_BADGING_DISPLAY_ATTRIBUTE *Attribute,\r | |
75 | OUT UINTN *CoordinateX,\r | |
76 | OUT UINTN *CoordinateY\r | |
77 | );\r | |
78 | \r | |
79 | \r | |
80 | struct _EFI_OEM_BADGING_PROTOCOL {\r | |
81 | EFI_BADGING_GET_IMAGE GetImage;\r | |
82 | };\r | |
83 | \r | |
84 | \r | |
85 | extern EFI_GUID gEfiOEMBadgingProtocolGuid;\r | |
86 | \r | |
87 | #endif\r |