projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| da4483cd | 1 | /** @file\r |
| 0a6f4824 | 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 |
| 0a6f4824 | 5 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
| c0a00b14 | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| da4483cd | 7 | \r |
| 8 | **/\r | |
| 9 | \r | |
| 10 | #ifndef __EFI_OEM_BADGING_H__\r | |
| 11 | #define __EFI_OEM_BADGING_H__\r | |
| 12 | \r | |
| 13 | //\r | |
| 14 | // GUID for EFI OEM Badging Protocol\r | |
| 15 | //\r | |
| 16 | #define EFI_OEM_BADGING_PROTOCOL_GUID \\r | |
| 17 | { 0x170e13c0, 0xbf1b, 0x4218, {0x87, 0x1d, 0x2a, 0xbd, 0xc6, 0xf8, 0x87, 0xbc } }\r | |
| 18 | \r | |
| 19 | \r | |
| 20 | typedef struct _EFI_OEM_BADGING_PROTOCOL EFI_OEM_BADGING_PROTOCOL;\r | |
| 21 | \r | |
| 22 | typedef enum {\r | |
| 23 | EfiBadgingFormatBMP,\r | |
| 24 | EfiBadgingFormatJPEG,\r | |
| 25 | EfiBadgingFormatTIFF,\r | |
| 26 | EfiBadgingFormatGIF,\r | |
| 27 | EfiBadgingFormatUnknown\r | |
| 28 | } EFI_BADGING_FORMAT;\r | |
| 29 | \r | |
| 30 | typedef enum {\r | |
| 31 | EfiBadgingDisplayAttributeLeftTop,\r | |
| 32 | EfiBadgingDisplayAttributeCenterTop,\r | |
| 33 | EfiBadgingDisplayAttributeRightTop,\r | |
| 34 | EfiBadgingDisplayAttributeCenterRight,\r | |
| 35 | EfiBadgingDisplayAttributeRightBottom,\r | |
| 36 | EfiBadgingDisplayAttributeCenterBottom,\r | |
| 37 | EfiBadgingDisplayAttributeLeftBottom,\r | |
| 38 | EfiBadgingDisplayAttributeCenterLeft,\r | |
| 39 | EfiBadgingDisplayAttributeCenter,\r | |
| 40 | EfiBadgingDisplayAttributeCustomized\r | |
| 41 | } EFI_BADGING_DISPLAY_ATTRIBUTE;\r | |
| 42 | \r | |
| 43 | /**\r | |
| 44 | \r | |
| 7b6b7746 | 45 | Load an OEM badge image and return its data and attributes.\r |
| da4483cd | 46 | \r |
| 49fd8a35 | 47 | @param This The pointer to this protocol instance.\r |
| 7b6b7746 | 48 | @param Instance The visible image instance is found.\r |
| 49fd8a35 | 49 | @param Format The format of the image. Examples: BMP, JPEG.\r |
| 0a6f4824 LG |
50 | @param ImageData The image data for the badge file. Currently only\r |
| 51 | supports the .bmp file format.\r | |
| 49fd8a35 | 52 | @param ImageSize The size of the image returned.\r |
| 53 | @param Attribute The display attributes of the image returned.\r | |
| 54 | @param CoordinateX The X coordinate of the image.\r | |
| 55 | @param CoordinateY The Y coordinate of the image.\r | |
| 56 | \r | |
| 57 | @retval EFI_SUCCESS The image was fetched successfully.\r | |
| da4483cd | 58 | @retval EFI_NOT_FOUND The specified image could not be found.\r |
| 59 | \r | |
| 60 | **/\r | |
| 61 | typedef\r | |
| 62 | EFI_STATUS\r | |
| 63 | (EFIAPI *EFI_BADGING_GET_IMAGE)(\r | |
| 64 | IN EFI_OEM_BADGING_PROTOCOL *This,\r | |
| 65 | IN OUT UINT32 *Instance,\r | |
| 66 | OUT EFI_BADGING_FORMAT *Format,\r | |
| 67 | OUT UINT8 **ImageData,\r | |
| 68 | OUT UINTN *ImageSize,\r | |
| 69 | OUT EFI_BADGING_DISPLAY_ATTRIBUTE *Attribute,\r | |
| 70 | OUT UINTN *CoordinateX,\r | |
| 71 | OUT UINTN *CoordinateY\r | |
| 72 | );\r | |
| 73 | \r | |
| 74 | \r | |
| 75 | struct _EFI_OEM_BADGING_PROTOCOL {\r | |
| 76 | EFI_BADGING_GET_IMAGE GetImage;\r | |
| 77 | };\r | |
| 78 | \r | |
| 79 | \r | |
| 80 | extern EFI_GUID gEfiOEMBadgingProtocolGuid;\r | |
| 81 | \r | |
| 82 | #endif\r |