MdePkg: Clean up source files

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

diff --git a/MdePkg/Include/Protocol/EdidOverride.h b/MdePkg/Include/Protocol/EdidOverride.h
index 637d60e6ab81ed13872754fffcfa21985cb2947e..818311d5ede7c1daf69636043c012e92e69b581e 100644 (file)
--- a/MdePkg/Include/Protocol/EdidOverride.h
+++ b/MdePkg/Include/Protocol/EdidOverride.h
@@ -1,25 +1,23 @@
 /** @file\r
   EDID Override Protocol from the UEFI 2.0 specification.\r
 \r
-  Allow platform to provide EDID information to producer of the Graphics Output\r
+  Allow platform to provide EDID information to the producer of the Graphics Output\r
   protocol.\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
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  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
+  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
 **/\r
 \r
 #ifndef __EDID_OVERRIDE_H__\r
 #define __EDID_OVERRIDE_H__\r
 \r
-#include <PiDxe.h>\r
-\r
 #define EFI_EDID_OVERRIDE_PROTOCOL_GUID \\r
   { \\r
     0x48ecb431, 0xfb72, 0x45c0, {0xa9, 0x22, 0xf4, 0x58, 0xfe, 0x4, 0xb, 0xd5 } \\r
@@ -31,9 +29,9 @@ typedef struct _EFI_EDID_OVERRIDE_PROTOCOL EFI_EDID_OVERRIDE_PROTOCOL;
 #define EFI_EDID_OVERRIDE_ENABLE_HOT_PLUG 0x02\r
 \r
 /**\r
-  Return the current video mode information.\r
+  Returns policy information and potentially a replacement EDID for the specified video output device.\r
 \r
-  @param  This              Protocol instance pointer.\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
@@ -48,19 +46,22 @@ typedef struct _EFI_EDID_OVERRIDE_PROTOCOL EFI_EDID_OVERRIDE_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID) (\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
 \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
+\r
 extern EFI_GUID gEfiEdidOverrideProtocolGuid;\r
 \r
 #endif\r