0a6f48249a
1. Do not use tab characters 2. No trailing white space in one line 3. All files must end with CRLF Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Liming Gao <liming.gao@intel.com>
89 lines
3.0 KiB
C
89 lines
3.0 KiB
C
/** @file
|
|
The OEM Badging Protocol defines the interface to get the OEM badging
|
|
image with the display attribute. This protocol can be produced based on OEM badging images.
|
|
|
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
This program and the accompanying materials are licensed and made available under
|
|
the terms and conditions of the BSD License that accompanies this distribution.
|
|
The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php.
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#ifndef __EFI_OEM_BADGING_H__
|
|
#define __EFI_OEM_BADGING_H__
|
|
|
|
//
|
|
// GUID for EFI OEM Badging Protocol
|
|
//
|
|
#define EFI_OEM_BADGING_PROTOCOL_GUID \
|
|
{ 0x170e13c0, 0xbf1b, 0x4218, {0x87, 0x1d, 0x2a, 0xbd, 0xc6, 0xf8, 0x87, 0xbc } }
|
|
|
|
|
|
typedef struct _EFI_OEM_BADGING_PROTOCOL EFI_OEM_BADGING_PROTOCOL;
|
|
|
|
typedef enum {
|
|
EfiBadgingFormatBMP,
|
|
EfiBadgingFormatJPEG,
|
|
EfiBadgingFormatTIFF,
|
|
EfiBadgingFormatGIF,
|
|
EfiBadgingFormatUnknown
|
|
} EFI_BADGING_FORMAT;
|
|
|
|
typedef enum {
|
|
EfiBadgingDisplayAttributeLeftTop,
|
|
EfiBadgingDisplayAttributeCenterTop,
|
|
EfiBadgingDisplayAttributeRightTop,
|
|
EfiBadgingDisplayAttributeCenterRight,
|
|
EfiBadgingDisplayAttributeRightBottom,
|
|
EfiBadgingDisplayAttributeCenterBottom,
|
|
EfiBadgingDisplayAttributeLeftBottom,
|
|
EfiBadgingDisplayAttributeCenterLeft,
|
|
EfiBadgingDisplayAttributeCenter,
|
|
EfiBadgingDisplayAttributeCustomized
|
|
} EFI_BADGING_DISPLAY_ATTRIBUTE;
|
|
|
|
/**
|
|
|
|
Load an OEM badge image and return its data and attributes.
|
|
|
|
@param This The pointer to this protocol instance.
|
|
@param Instance The visible image instance is found.
|
|
@param Format The format of the image. Examples: BMP, JPEG.
|
|
@param ImageData The image data for the badge file. Currently only
|
|
supports the .bmp file format.
|
|
@param ImageSize The size of the image returned.
|
|
@param Attribute The display attributes of the image returned.
|
|
@param CoordinateX The X coordinate of the image.
|
|
@param CoordinateY The Y coordinate of the image.
|
|
|
|
@retval EFI_SUCCESS The image was fetched successfully.
|
|
@retval EFI_NOT_FOUND The specified image could not be found.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_BADGING_GET_IMAGE)(
|
|
IN EFI_OEM_BADGING_PROTOCOL *This,
|
|
IN OUT UINT32 *Instance,
|
|
OUT EFI_BADGING_FORMAT *Format,
|
|
OUT UINT8 **ImageData,
|
|
OUT UINTN *ImageSize,
|
|
OUT EFI_BADGING_DISPLAY_ATTRIBUTE *Attribute,
|
|
OUT UINTN *CoordinateX,
|
|
OUT UINTN *CoordinateY
|
|
);
|
|
|
|
|
|
struct _EFI_OEM_BADGING_PROTOCOL {
|
|
EFI_BADGING_GET_IMAGE GetImage;
|
|
};
|
|
|
|
|
|
extern EFI_GUID gEfiOEMBadgingProtocolGuid;
|
|
|
|
#endif
|