Code have been checked with spec

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

diff --git a/MdePkg/Include/Protocol/EdidDiscovered.h b/MdePkg/Include/Protocol/EdidDiscovered.h
index 6790666b67df0e2871da279d28bcf15e3d7c9685..dedefa0762acc524bdf715ee69acf4b70a902685 100644 (file)
--- a/MdePkg/Include/Protocol/EdidDiscovered.h
+++ b/MdePkg/Include/Protocol/EdidDiscovered.h
@@ -4,7 +4,7 @@
   This protocol is placed on the video output device child handle and it represents\r
   the EDID information being used for output device represented by the child handle.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
@@ -13,8 +13,6 @@
   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
 \r
-  Module Name:  EdidDiscovered.h\r
-\r
 **/\r
 \r
 #ifndef __EDID_DISCOVERED_H__\r
@@ -25,8 +23,25 @@
     0x1c0c34f6, 0xd380, 0x41fa, {0xa0, 0x49, 0x8a, 0xd0, 0x6c, 0x1a, 0x66, 0xaa } \\r
   }\r
 \r
+///\r
+/// This protocol contains the EDID information retrieved from a video output device.\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-DID EEPROM\r
+  /// specification published by VESA (www.vesa.org).\r
+  ///  \r
   UINT8    *Edid;\r
 } EFI_EDID_DISCOVERED_PROTOCOL;\r
 \r