Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / OEMBadging.h

/** @file\r
  The OEM Badging Protocol defines the interface to get the OEM badging \r
  image with the dispaly attribute. This protocol can be produced based on OEM badging images.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __EFI_OEM_BADGING_H__\r
#define __EFI_OEM_BADGING_H__\r
\r
//\r
// GUID for EFI OEM Badging Protocol\r
//\r
#define EFI_OEM_BADGING_PROTOCOL_GUID \\r
  { 0x170e13c0, 0xbf1b, 0x4218, {0x87, 0x1d, 0x2a, 0xbd, 0xc6, 0xf8, 0x87, 0xbc } }\r
\r
\r
typedef struct _EFI_OEM_BADGING_PROTOCOL EFI_OEM_BADGING_PROTOCOL;\r
\r
typedef enum {\r
  EfiBadgingFormatBMP,\r
  EfiBadgingFormatJPEG,\r
  EfiBadgingFormatTIFF,\r
  EfiBadgingFormatGIF,\r
  EfiBadgingFormatUnknown\r
} EFI_BADGING_FORMAT;\r
\r
typedef enum {\r
  EfiBadgingDisplayAttributeLeftTop,\r
  EfiBadgingDisplayAttributeCenterTop,\r
  EfiBadgingDisplayAttributeRightTop,\r
  EfiBadgingDisplayAttributeCenterRight,\r
  EfiBadgingDisplayAttributeRightBottom,\r
  EfiBadgingDisplayAttributeCenterBottom,\r
  EfiBadgingDisplayAttributeLeftBottom,\r
  EfiBadgingDisplayAttributeCenterLeft,\r
  EfiBadgingDisplayAttributeCenter,\r
  EfiBadgingDisplayAttributeCustomized\r
} EFI_BADGING_DISPLAY_ATTRIBUTE;\r
\r
/**\r
\r
  Load an OEM badge image and return its data as well as attributes.\r
\r
  @param This              Pointer to this protocol instance.\r
  @param Instance          The visiable image instance is found.\r
  @param Format            Format of the image such as BMP,JPEG,etc.\r
  @param ImageData         Image data returned.\r
  @param ImageSize         Size of the image returned.\r
  @param Attribute         Display attributes of the image returned.\r
  @param CoordinateX       X coordinate of the image.\r
  @param CoordinateY       Y coordinate of the image.\r
\r
  @retval EFI_SUCCESS      Image has been fetched successfully.\r
  @retval EFI_NOT_FOUND    The specified image could not be found.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_BADGING_GET_IMAGE)(\r
  IN     EFI_OEM_BADGING_PROTOCOL          *This,\r
  IN OUT UINT32                            *Instance,\r
     OUT EFI_BADGING_FORMAT                *Format,\r
     OUT UINT8                             **ImageData,\r
     OUT UINTN                             *ImageSize,\r
     OUT EFI_BADGING_DISPLAY_ATTRIBUTE     *Attribute,\r
     OUT UINTN                             *CoordinateX,\r
     OUT UINTN                             *CoordinateY\r
);\r
\r
\r
struct _EFI_OEM_BADGING_PROTOCOL {\r
  EFI_BADGING_GET_IMAGE       GetImage;\r
};\r
\r
\r
extern EFI_GUID gEfiOEMBadgingProtocolGuid;\r
\r
#endif\r