MdeModulePkg/Include/Protocol/OEMBadging.h

   1 /** @file
   2   EFI OEM Badging Protocol definition header file
   3
   4 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __EFI_OEM_BADGING_H__
  16 #define __EFI_OEM_BADGING_H__
  17
  18 //
  19 // GUID for EFI OEM Badging Protocol
  20 //
  21 #define EFI_OEM_BADGING_PROTOCOL_GUID \
  22   { 0x170e13c0, 0xbf1b, 0x4218, {0x87, 0x1d, 0x2a, 0xbd, 0xc6, 0xf8, 0x87, 0xbc } }
  23
  24
  25 typedef struct _EFI_OEM_BADGING_PROTOCOL EFI_OEM_BADGING_PROTOCOL;
  26
  27 typedef enum {
  28   EfiBadgingFormatBMP,
  29   EfiBadgingFormatJPEG,
  30   EfiBadgingFormatTIFF,
  31   EfiBadgingFormatGIF,
  32   EfiBadgingFormatUnknown
  33 } EFI_BADGING_FORMAT;
  34
  35 typedef enum {
  36   EfiBadgingDisplayAttributeLeftTop,
  37   EfiBadgingDisplayAttributeCenterTop,
  38   EfiBadgingDisplayAttributeRightTop,
  39   EfiBadgingDisplayAttributeCenterRight,
  40   EfiBadgingDisplayAttributeRightBottom,
  41   EfiBadgingDisplayAttributeCenterBottom,
  42   EfiBadgingDisplayAttributeLeftBottom,
  43   EfiBadgingDisplayAttributeCenterLeft,
  44   EfiBadgingDisplayAttributeCenter,
  45   EfiBadgingDisplayAttributeCustomized
  46 } EFI_BADGING_DISPLAY_ATTRIBUTE;
  47
  48
  49 typedef
  50 EFI_STATUS
  51 (EFIAPI *EFI_BADGING_GET_IMAGE) (
  52   IN     EFI_OEM_BADGING_PROTOCOL          *This,
  53   IN OUT UINT32                            *Instance,
  54      OUT EFI_BADGING_FORMAT                *Format,
  55      OUT UINT8                             **ImageData,
  56      OUT UINTN                             *ImageSize,
  57      OUT EFI_BADGING_DISPLAY_ATTRIBUTE     *Attribute,
  58      OUT UINTN                             *CoordinateX,
  59      OUT UINTN                             *CoordinateY
  60 );
  61
  62
  63 struct _EFI_OEM_BADGING_PROTOCOL {
  64   EFI_BADGING_GET_IMAGE       GetImage;
  65 };
  66
  67
  68 extern EFI_GUID gEfiOEMBadgingProtocolGuid;
  69
  70 #endif