]>
Commit | Line | Data |
---|---|---|
da4483cd | 1 | /** @file\r |
2 | The OEM Badging Protocol defines the interface to get the OEM badging \r | |
7b6b7746 | 3 | image with the display attribute. This protocol can be produced based on OEM badging images.\r |
da4483cd | 4 | \r |
180a5a35 | 5 | Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r |
49fd8a35 | 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 | |
da4483cd | 12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
13 | \r | |
14 | **/\r | |
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 | |
49 | /**\r | |
50 | \r | |
7b6b7746 | 51 | Load an OEM badge image and return its data and attributes.\r |
da4483cd | 52 | \r |
49fd8a35 | 53 | @param This The pointer to this protocol instance.\r |
7b6b7746 | 54 | @param Instance The visible image instance is found.\r |
49fd8a35 | 55 | @param Format The format of the image. Examples: BMP, JPEG.\r |
56 | @param ImageData The image data for the badge file. Currently only \r | |
57 | supports the .bmp file format. \r | |
58 | @param ImageSize The size of the image returned.\r | |
59 | @param Attribute The display attributes of the image returned.\r | |
60 | @param CoordinateX The X coordinate of the image.\r | |
61 | @param CoordinateY The Y coordinate of the image.\r | |
62 | \r | |
63 | @retval EFI_SUCCESS The image was fetched successfully.\r | |
da4483cd | 64 | @retval EFI_NOT_FOUND The specified image could not be found.\r |
65 | \r | |
66 | **/\r | |
67 | typedef\r | |
68 | EFI_STATUS\r | |
69 | (EFIAPI *EFI_BADGING_GET_IMAGE)(\r | |
70 | IN EFI_OEM_BADGING_PROTOCOL *This,\r | |
71 | IN OUT UINT32 *Instance,\r | |
72 | OUT EFI_BADGING_FORMAT *Format,\r | |
73 | OUT UINT8 **ImageData,\r | |
74 | OUT UINTN *ImageSize,\r | |
75 | OUT EFI_BADGING_DISPLAY_ATTRIBUTE *Attribute,\r | |
76 | OUT UINTN *CoordinateX,\r | |
77 | OUT UINTN *CoordinateY\r | |
78 | );\r | |
79 | \r | |
80 | \r | |
81 | struct _EFI_OEM_BADGING_PROTOCOL {\r | |
82 | EFI_BADGING_GET_IMAGE GetImage;\r | |
83 | };\r | |
84 | \r | |
85 | \r | |
86 | extern EFI_GUID gEfiOEMBadgingProtocolGuid;\r | |
87 | \r | |
88 | #endif\r |