MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Include / Protocol / EdidOverride.h

/** @file\r
  EDID Override Protocol from the UEFI 2.0 specification.\r
\r
  Allow platform to provide EDID information to the producer of the Graphics Output\r
  protocol.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __EDID_OVERRIDE_H__\r
#define __EDID_OVERRIDE_H__\r
\r
#define EFI_EDID_OVERRIDE_PROTOCOL_GUID \\r
  { \\r
    0x48ecb431, 0xfb72, 0x45c0, {0xa9, 0x22, 0xf4, 0x58, 0xfe, 0x4, 0xb, 0xd5 } \\r
  }\r
\r
typedef struct _EFI_EDID_OVERRIDE_PROTOCOL EFI_EDID_OVERRIDE_PROTOCOL;\r
\r
#define EFI_EDID_OVERRIDE_DONT_OVERRIDE   0x01\r
#define EFI_EDID_OVERRIDE_ENABLE_HOT_PLUG 0x02\r
\r
/**\r
  Returns policy information and potentially a replacement EDID for the specified video output device.\r
\r
  @param  This              The EFI_EDID_OVERRIDE_PROTOCOL instance.\r
  @param  ChildHandle       A child handle produced by the Graphics Output EFI\r
                            driver that represents a video output device.\r
  @param  Attributes        The attributes associated with ChildHandle video output device.\r
  @param  EdidSize          A pointer to the size, in bytes, of the Edid buffer.\r
  @param  Edid              A pointer to callee allocated buffer that contains the EDID that\r
                            should be used for ChildHandle. A value of NULL\r
                            represents no EDID override for ChildHandle.\r
\r
  @retval EFI_SUCCESS       Valid overrides returned for ChildHandle.\r
  @retval EFI_UNSUPPORTED   ChildHandle has no overrides.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID)(\r
  IN  EFI_EDID_OVERRIDE_PROTOCOL          *This,\r
  IN  EFI_HANDLE                          *ChildHandle,\r
  OUT UINT32                              *Attributes,\r
  IN OUT UINTN                            *EdidSize,\r
  IN OUT UINT8                            **Edid\r
  );\r
\r
///\r
/// This protocol is produced by the platform to allow the platform to provide\r
/// EDID information to the producer of the Graphics Output protocol.\r
///\r
struct _EFI_EDID_OVERRIDE_PROTOCOL {\r
  EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID   GetEdid;\r
};\r
\r
extern EFI_GUID gEfiEdidOverrideProtocolGuid;\r
\r
#endif\r