EdkModulePkg/Include/Protocol/OEMBadging.h

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