MdePkg: Add new MM MP Protocol definition.

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

diff --git a/MdePkg/Include/Protocol/EdidActive.h b/MdePkg/Include/Protocol/EdidActive.h
index d1b1c06e2eeac0d7e0602d6adbfd5493925ca0c9..bfc21516f81b811c4f43ff7c14d52373c41dbe39 100644 (file)
--- a/MdePkg/Include/Protocol/EdidActive.h
+++ b/MdePkg/Include/Protocol/EdidActive.h
@@ -1,16 +1,10 @@
 /** @file\r
   EDID Active Protocol from the UEFI 2.0 specification.\r
 \r
-  Placed on the video output device child handle that are actively displaying output.\r
+  Placed on the video output device child handle that is actively displaying output.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -22,8 +16,28 @@
     0xbd8c1056, 0x9f36, 0x44ec, {0x92, 0xa8, 0xa6, 0x33, 0x7f, 0x81, 0x79, 0x86 } \\r
   }\r
 \r
+///\r
+/// This protocol contains the EDID information for an active video output device. This is either the\r
+/// EDID information retrieved from the EFI_EDID_OVERRIDE_PROTOCOL if an override is\r
+/// available, or an identical copy of the EDID information from the\r
+/// EFI_EDID_DISCOVERED_PROTOCOL if no overrides are available.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// The size, in bytes, of the Edid buffer. 0 if no EDID information\r
+  /// is available from the video output device. Otherwise, it must be a\r
+  /// minimum of 128 bytes.\r
+  ///\r
   UINT32   SizeOfEdid;\r
+\r
+  ///\r
+  /// A pointer to a read-only array of bytes that contains the EDID\r
+  /// information for an active video output device. This pointer is\r
+  /// NULL if no EDID information is available for the video output\r
+  /// device. The minimum size of a valid Edid buffer is 128 bytes.\r
+  /// EDID information is defined in the E-EDID EEPROM\r
+  /// specification published by VESA (www.vesa.org).\r
+  ///\r
   UINT8    *Edid;\r
 } EFI_EDID_ACTIVE_PROTOCOL;\r
 \r