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 the producer of the Graphics Output
   5   protocol.
   6
   7   Copyright (c) 2006 - 2008, 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 #define EFI_EDID_OVERRIDE_PROTOCOL_GUID \
  22   { \
  23     0x48ecb431, 0xfb72, 0x45c0, {0xa9, 0x22, 0xf4, 0x58, 0xfe, 0x4, 0xb, 0xd5 } \
  24   }
  25
  26 typedef struct _EFI_EDID_OVERRIDE_PROTOCOL EFI_EDID_OVERRIDE_PROTOCOL;
  27
  28 #define EFI_EDID_OVERRIDE_DONT_OVERRIDE   0x01
  29 #define EFI_EDID_OVERRIDE_ENABLE_HOT_PLUG 0x02
  30
  31 /**
  32   Returns policy information and potentially a replacement EDID for the specified video output device.
  33
  34   @param  This              The EFI_EDID_OVERRIDE_PROTOCOL instance.
  35   @param  ChildHandle       A child handle produced by the Graphics Output EFI
  36                             driver that represents a video output device.
  37   @param  Attributes        The attributes associated with ChildHandle video output device.
  38   @param  EdidSize          A pointer to the size, in bytes, of the Edid buffer.
  39   @param  Edid              A pointer to callee allocated buffer that contains the EDID that
  40                             should be used for ChildHandle. A value of NULL
  41                             represents no EDID override for ChildHandle.
  42
  43   @retval EFI_SUCCESS       Valid overrides returned for ChildHandle.
  44   @retval EFI_UNSUPPORTED   ChildHandle has no overrides.
  45
  46 **/
  47 typedef
  48 EFI_STATUS
  49 (EFIAPI *EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID)(
  50   IN  EFI_EDID_OVERRIDE_PROTOCOL          *This,
  51   IN  EFI_HANDLE                          *ChildHandle,
  52   OUT UINT32                              *Attributes,
  53   IN OUT UINTN                            *EdidSize,
  54   IN OUT UINT8                            **Edid
  55   );
  56
  57 ///
  58 /// This protocol is produced by the platform to allow the platform to provide
  59 /// EDID information to the producer of the Graphics Output protocol.
  60 ///
  61 struct _EFI_EDID_OVERRIDE_PROTOCOL {
  62   EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID   GetEdid;
  63 };
  64
  65 extern EFI_GUID gEfiEdidOverrideProtocolGuid;
  66
  67 #endif