MdePkg/Include/Protocol/EdidOverride.h

   1 /** @file
   2   EDID Override Protocol from the UEFI 2.0 specification.
   3
   4   Allow platform to provide EDID information to producer of the Graphics Output
   5   protocol.
   6
   7   Copyright (c) 2006, Intel Corporation
   8   All rights reserved. This program and the accompanying materials
   9   are licensed and made available under the terms and conditions of the BSD License
  10   which accompanies this distribution.  The full text of the license may be found at
  11   http://opensource.org/licenses/bsd-license.php
  12
  13   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16 **/
  17
  18 #ifndef __EDID_OVERRIDE_H__
  19 #define __EDID_OVERRIDE_H__
  20
  21 #include <PiDxe.h>
  22
  23 #define EFI_EDID_OVERRIDE_PROTOCOL_GUID \
  24   { \
  25     0x48ecb431, 0xfb72, 0x45c0, {0xa9, 0x22, 0xf4, 0x58, 0xfe, 0x4, 0xb, 0xd5 } \
  26   }
  27
  28 typedef struct _EFI_EDID_OVERRIDE_PROTOCOL EFI_EDID_OVERRIDE_PROTOCOL;
  29
  30 #define EFI_EDID_OVERRIDE_DONT_OVERRIDE   0x01
  31 #define EFI_EDID_OVERRIDE_ENABLE_HOT_PLUG 0x02
  32
  33 /**
  34   Return the current video mode information.
  35
  36   @param  This              Protocol instance pointer.
  37   @param  ChildHandle       A child handle produced by the Graphics Output EFI
  38                             driver that represents a video output device.
  39   @param  Attributes        The attributes associated with ChildHandle video output device.
  40   @param  EdidSize          A pointer to the size, in bytes, of the Edid buffer.
  41   @param  Edid              A pointer to callee allocated buffer that contains the EDID that
  42                             should be used for ChildHandle. A value of NULL
  43                             represents no EDID override for ChildHandle.
  44
  45   @retval EFI_SUCCESS       Valid overrides returned for ChildHandle.
  46   @retval EFI_UNSUPPORTED   ChildHandle has no overrides.
  47
  48 **/
  49 typedef
  50 EFI_STATUS
  51 (EFIAPI *EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID)(
  52   IN  EFI_EDID_OVERRIDE_PROTOCOL          *This,
  53   IN  EFI_HANDLE                          *ChildHandle,
  54   OUT UINT32                              *Attributes,
  55   IN OUT UINTN                            *EdidSize,
  56   IN OUT UINT8                            **Edid
  57   )
  58 ;
  59
  60 struct _EFI_EDID_OVERRIDE_PROTOCOL {
  61   EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID   GetEdid;
  62 };
  63
  64 extern EFI_GUID gEfiEdidOverrideProtocolGuid;
  65
  66 #endif