IntelFrameworkModulePkg: Clean up source files

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / VgaMiniPort.h

diff --git a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
index f8a73879a7cd9fae3a4c6987fac0fa10d9d7baa0..7e6906023caaa4bacf873f4c0251180897ad05e8 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
@@ -1,14 +1,14 @@
 /** @file\r
-  VGA Mini Port Protocol that is used to set the text display mode of a VGA controller.\r
+  The VGA Mini Port Protocol used to set the text display mode of a VGA controller.\r
 \r
-  Copyright (c) 2006 - 2009, 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 are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
+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
@@ -16,7 +16,7 @@
 #define __VGA_MINI_PORT_H_\r
 \r
 ///\r
-/// Global ID for the EFI_VGA_MINI_PORT_PROTOCOL\r
+/// Global ID for the EFI_VGA_MINI_PORT_PROTOCOL.\r
 ///\r
 #define EFI_VGA_MINI_PORT_PROTOCOL_GUID \\r
   { \\r
@@ -24,28 +24,28 @@
   }\r
 \r
 ///\r
-/// Forward declaration for the EFI_VGA_MINI_PORT_PROTOCOL\r
+/// Forward declaration for the EFI_VGA_MINI_PORT_PROTOCOL.\r
 ///\r
 typedef struct _EFI_VGA_MINI_PORT_PROTOCOL  EFI_VGA_MINI_PORT_PROTOCOL;\r
 \r
 /**\r
   Sets the text display mode of a VGA controller.\r
-  \r
-  Sets the text display mode of the VGA controller to the mode specified by \r
-  ModeNumber.  A ModeNumber of 0 is a request for an 80x25 text mode.  A \r
+\r
+  Sets the text display mode of the VGA controller to the mode specified by\r
+  ModeNumber.  A ModeNumber of 0 is a request for an 80x25 text mode.  A\r
   ModeNumber of 1 is a request for an 80x50 text mode.  If ModeNumber is greater\r
-  than MaxModeNumber, then EFI_UNSUPPORTED is returned.  If the VGA controller \r
+  than MaxModeNumber, then EFI_UNSUPPORTED is returned.  If the VGA controller\r
   is not functioning properly, then EFI_DEVICE_ERROR is returned.  If the VGA\r
-  controller is sucessfully set to the mode number specified by ModeNumber, then \r
+  controller is sucessfully set to the mode number specified by ModeNumber, then\r
   EFI_SUCCESS is returned.\r
-    \r
+\r
   @param[in] This         A pointer to the EFI_VGA_MINI_PORT_PROTOCOL instance.\r
   @param[in] ModeNumber   The requested mode number.  0 for 80x25.  1 for 80x5.\r
 \r
-  @retval EFI_SUCCESS        The mode number was set\r
+  @retval EFI_SUCCESS        The mode number was set.\r
   @retval EFI_UNSUPPORTED    The mode number specified by ModeNumber is not supported.\r
   @retval EFI_DEVICE_ERROR   The device is not functioning properly.\r
-  \r
+\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -61,7 +61,7 @@ struct _EFI_VGA_MINI_PORT_PROTOCOL {
   ///\r
   UINT64                      VgaMemoryOffset;\r
   ///\r
-  /// I/O Port address for the VGA CRTC address register  Typically set to 0x3D4.\r
+  /// I/O Port address for the VGA CRTC address register. Typically set to 0x3D4.\r
   ///\r
   UINT64                      CrtcAddressRegisterOffset;\r
   ///\r
@@ -69,17 +69,17 @@ struct _EFI_VGA_MINI_PORT_PROTOCOL {
   ///\r
   UINT64                      CrtcDataRegisterOffset;\r
   ///\r
-  /// PCI Controller MMIO BAR index of the VGA text mode frame buffer.  Typically \r
+  /// PCI Controller MMIO BAR index of the VGA text mode frame buffer.  Typically\r
   /// set to EFI_PCI_IO_PASS_THROUGH_BAR\r
   ///\r
   UINT8                       VgaMemoryBar;\r
   ///\r
-  /// PCI Controller I/O BAR index of the VGA CRTC address register.  Typically \r
+  /// PCI Controller I/O BAR index of the VGA CRTC address register.  Typically\r
   /// set to EFI_PCI_IO_PASS_THROUGH_BAR\r
   ///\r
   UINT8                       CrtcAddressRegisterBar;\r
   ///\r
-  /// PCI Controller I/O BAR index of the VGA CRTC data register.  Typically set \r
+  /// PCI Controller I/O BAR index of the VGA CRTC data register.  Typically set\r
   /// to EFI_PCI_IO_PASS_THROUGH_BAR\r
   ///\r
   UINT8                       CrtcDataRegisterBar;\r