IntelFrameworkModulePkg: Clean up source files

[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / Console / VgaClassDxe / VgaClass.h

diff --git a/IntelFrameworkModulePkg/Universal/Console/VgaClassDxe/VgaClass.h b/IntelFrameworkModulePkg/Universal/Console/VgaClassDxe/VgaClass.h
index 7284f906848bd89c33ed05f8692eec3c3e295887..84a8b1797862b9b8a0bacc80ecbc49efa46c0fbd 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/Console/VgaClassDxe/VgaClass.h
+++ b/IntelFrameworkModulePkg/Universal/Console/VgaClassDxe/VgaClass.h
@@ -1,14 +1,14 @@
 /** @file\r
   Internal include file of the VGA Class Driver.\r
 \r
 /** @file\r
   Internal include file of the VGA Class Driver.\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
-                                                                                          \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
+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

 \r
 **/\r
 \r
 \r
 **/\r
 \r


@@ -16,7 +16,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef _VGA_CLASS_H__\r
 #define _VGA_CLASS_H__\r
 \r
 #ifndef _VGA_CLASS_H__\r
 #define _VGA_CLASS_H__\r
 \r

-#include <PiDxe.h>\r

 #include <FrameworkDxe.h>\r
 \r
 #include <Protocol/SimpleTextOut.h>\r
 #include <FrameworkDxe.h>\r
 \r
 #include <Protocol/SimpleTextOut.h>\r


@@ -31,7 +30,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/ReportStatusCodeLib.h>\r
 \r
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/ReportStatusCodeLib.h>\r
 \r

-#include <IndustryStandard/Pci22.h>\r
+#include <IndustryStandard/Pci.h>\r

 \r
 //\r
 // Global Variables\r
 \r
 //\r
 // Global Variables\r


@@ -133,9 +132,9 @@ VgaClassDriverBindingStart (
 \r
 /**\r
   Starts the device controller.\r
 \r
 /**\r
   Starts the device controller.\r

-  \r
+\r

   This function implments EFI_DRIVER_BINDING_PROTOCOL.Stop().\r
   This function implments EFI_DRIVER_BINDING_PROTOCOL.Stop().\r

-  It stops this driver on Controller. Support stoping any child handles\r
+  It stops this driver on Controller. Support stopping any child handles\r

   created by this driver.\r
 \r
   @param  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
   created by this driver.\r
 \r
   @param  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r


@@ -179,7 +178,7 @@ VgaClassDriverBindingStop (
                                 languages specified in SupportedLanguages. The\r
                                 number of languages supported by a driver is up\r
                                 to the driver writer. Language is specified\r
                                 languages specified in SupportedLanguages. The\r
                                 number of languages supported by a driver is up\r
                                 to the driver writer. Language is specified\r

-                                in RFC 3066 or ISO 639-2 language code format.\r
+                                in RFC 4646 or ISO 639-2 language code format.\r

   @param  DriverName            A pointer to the Unicode string to return.\r
                                 This Unicode string is the name of the\r
                                 driver specified by This in the language\r
   @param  DriverName            A pointer to the Unicode string to return.\r
                                 This Unicode string is the name of the\r
                                 driver specified by This in the language\r


@@ -236,7 +235,7 @@ VgaClassComponentNameGetDriverName (
                                 languages specified in SupportedLanguages. The\r
                                 number of languages supported by a driver is up\r
                                 to the driver writer. Language is specified in\r
                                 languages specified in SupportedLanguages. The\r
                                 number of languages supported by a driver is up\r
                                 to the driver writer. Language is specified in\r

-                                RFC 3066 or ISO 639-2 language code format.\r
+                                RFC 4646 or ISO 639-2 language code format.\r

   @param  ControllerName        A pointer to the Unicode string to return.\r
                                 This Unicode string is the name of the\r
                                 controller specified by ControllerHandle and\r
   @param  ControllerName        A pointer to the Unicode string to return.\r
                                 This Unicode string is the name of the\r
                                 controller specified by ControllerHandle and\r


@@ -248,7 +247,7 @@ VgaClassComponentNameGetDriverName (
                                 the language specified by Language for the\r
                                 driver specified by This was returned in\r
                                 DriverName.\r
                                 the language specified by Language for the\r
                                 driver specified by This was returned in\r
                                 DriverName.\r

-  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r

   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                 EFI_HANDLE.\r
   @retval EFI_INVALID_PARAMETER Language is NULL.\r
   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                 EFI_HANDLE.\r
   @retval EFI_INVALID_PARAMETER Language is NULL.\r


@@ -279,7 +278,7 @@ VgaClassComponentNameGetControllerName (
   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.Reset().\r
   It resets the text output device hardware. The cursor position is set to (0, 0),\r
   and the screen is cleared to the default background color for the output device.\r
   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.Reset().\r
   It resets the text output device hardware. The cursor position is set to (0, 0),\r
   and the screen is cleared to the default background color for the output device.\r

-  \r
+\r

   @param  This                 Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.\r
   @param  ExtendedVerification Indicates that the driver may perform a more exhaustive\r
                                verification operation of the device during reset.\r
   @param  This                 Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.\r
   @param  ExtendedVerification Indicates that the driver may perform a more exhaustive\r
                                verification operation of the device during reset.\r


@@ -297,7 +296,7 @@ VgaClassReset (
 \r
 /**\r
   Writes a Unicode string to the output device.\r
 \r
 /**\r
   Writes a Unicode string to the output device.\r

-  \r
+\r

   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.OutputString().\r
   It writes a Unicode string to the output device. This is the most basic output mechanism\r
   on an output device.\r
   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.OutputString().\r
   It writes a Unicode string to the output device. This is the most basic output mechanism\r
   on an output device.\r


@@ -307,7 +306,7 @@ VgaClassReset (
 \r
   @retval EFI_SUCCESS            The string was output to the device.\r
   @retval EFI_DEVICE_ERROR       The device reported an error while attempting to output the text.\r
 \r
   @retval EFI_SUCCESS            The string was output to the device.\r
   @retval EFI_DEVICE_ERROR       The device reported an error while attempting to output the text.\r

-  @retval EFI_UNSUPPORTED        The output device\92s mode is not currently in a defined text mode.\r
+  @retval EFI_UNSUPPORTED        The output device's mode is not currently in a defined text mode.\r

   @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the characters in\r
                                  the Unicode string could not be rendered and were skipped.\r
 **/\r
   @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the characters in\r
                                  the Unicode string could not be rendered and were skipped.\r
 **/\r


@@ -320,7 +319,7 @@ VgaClassOutputString (
 \r
 /**\r
   Verifies that all characters in a Unicode string can be output to the target device.\r
 \r
 /**\r
   Verifies that all characters in a Unicode string can be output to the target device.\r

-  \r
+\r

   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.TestString().\r
   It verifies that all characters in a Unicode string can be output to the target device.\r
 \r
   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.TestString().\r
   It verifies that all characters in a Unicode string can be output to the target device.\r
 \r


@@ -341,13 +340,13 @@ VgaClassTestString (
 \r
 /**\r
   Clears the output device(s) display to the currently selected background color.\r
 \r
 /**\r
   Clears the output device(s) display to the currently selected background color.\r

-  \r
+\r

   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.ClearScreen().\r
   The ClearScreen() function clears the output device(s) display to the currently\r
   selected background color. The cursor position is set to (0, 0).\r
 \r
   @param  This                   Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.\r
   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.ClearScreen().\r
   The ClearScreen() function clears the output device(s) display to the currently\r
   selected background color. The cursor position is set to (0, 0).\r
 \r
   @param  This                   Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.\r

-  \r
+\r

   @retval EFI_SUCESS             The operation completed successfully.\r
   @retval EFI_DEVICE_ERROR       The device had an error and could not complete the request.\r
   @retval EFI_UNSUPPORTED        The output device is not in a valid text mode.\r
   @retval EFI_SUCESS             The operation completed successfully.\r
   @retval EFI_DEVICE_ERROR       The device had an error and could not complete the request.\r
   @retval EFI_UNSUPPORTED        The output device is not in a valid text mode.\r


@@ -361,18 +360,18 @@ VgaClassClearScreen (
 \r
 /**\r
   Sets the background and foreground colors for theOutputString() and ClearScreen() functions.\r
 \r
 /**\r
   Sets the background and foreground colors for theOutputString() and ClearScreen() functions.\r

-  \r
+\r

   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute().\r
   It sets the background and foreground colors for the OutputString() and ClearScreen() functions.\r
   The color mask can be set even when the device is in an invalid text mode.\r
   Devices supporting a different number of text colors are required to emulate the above colors\r
   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute().\r
   It sets the background and foreground colors for the OutputString() and ClearScreen() functions.\r
   The color mask can be set even when the device is in an invalid text mode.\r
   Devices supporting a different number of text colors are required to emulate the above colors\r

-  to the best of the device\92s capabilities.\r
+  to the best of the device's capabilities.\r

 \r
   @param  This                   Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.\r
   @param  Attribute              The attribute to set.\r
                                  Bits 0..3 are the foreground color,\r
                                  and bits 4..6 are the background color.\r
 \r
   @param  This                   Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.\r
   @param  Attribute              The attribute to set.\r
                                  Bits 0..3 are the foreground color,\r
                                  and bits 4..6 are the background color.\r

-  \r
+\r

   @retval EFI_SUCCESS            The requested attributes were set.\r
   @retval EFI_DEVICE_ERROR       The device had an error and could not complete the request.\r
 \r
   @retval EFI_SUCCESS            The requested attributes were set.\r
   @retval EFI_DEVICE_ERROR       The device had an error and could not complete the request.\r
 \r


@@ -386,15 +385,15 @@ VgaClassSetAttribute (
 \r
 /**\r
   Sets the current coordinates of the cursor position.\r
 \r
 /**\r
   Sets the current coordinates of the cursor position.\r

-  \r
+\r

   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetCursorPosition().\r
   It sets the current coordinates of the cursor position.\r
   The upper left corner of the screen is defined as coordinate (0, 0).\r
   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetCursorPosition().\r
   It sets the current coordinates of the cursor position.\r
   The upper left corner of the screen is defined as coordinate (0, 0).\r

-  \r
+\r

   @param  This                   Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.\r
   @param  Column                 Column of position to set the cursor to.\r
   @param  Row                    Row of position to set the cursor to.\r
   @param  This                   Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.\r
   @param  Column                 Column of position to set the cursor to.\r
   @param  Row                    Row of position to set the cursor to.\r

-  \r
+\r

   @retval EFI_SUCCESS            The operation completed successfully.\r
   @retval EFI_DEVICE_ERROR       The device had an error and could not complete the request.\r
   @retval EFI_UNSUPPORTED        The output device is not in a valid text mode, or the cursor\r
   @retval EFI_SUCCESS            The operation completed successfully.\r
   @retval EFI_DEVICE_ERROR       The device had an error and could not complete the request.\r
   @retval EFI_UNSUPPORTED        The output device is not in a valid text mode, or the cursor\r


@@ -411,14 +410,14 @@ VgaClassSetCursorPosition (
 \r
 /**\r
   Makes the cursor visible or invisible.\r
 \r
 /**\r
   Makes the cursor visible or invisible.\r

-  \r
+\r

   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.EnableCursor().\r
   It makes the cursor visible or invisible.\r
 \r
   @param  This                   Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.\r
   @param  Visible                If TRUE, the cursor is set to be visible.\r
                                  If FALSE, the cursor is set to be invisible.\r
   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.EnableCursor().\r
   It makes the cursor visible or invisible.\r
 \r
   @param  This                   Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.\r
   @param  Visible                If TRUE, the cursor is set to be visible.\r
                                  If FALSE, the cursor is set to be invisible.\r

-  \r
+\r

   @retval EFI_SUCESS             The operation completed successfully.\r
   @retval EFI_DEVICE_ERROR       The device had an error and could not complete the request or the\r
                                  device does not support changing the cursor mode.\r
   @retval EFI_SUCESS             The operation completed successfully.\r
   @retval EFI_DEVICE_ERROR       The device had an error and could not complete the request or the\r
                                  device does not support changing the cursor mode.\r


@@ -444,7 +443,7 @@ VgaClassEnableCursor (
   @param  ModeNumber             The mode number to return information on.\r
   @param  Columns                Columen in current mode number\r
   @param  Rows                   Row in current mode number.\r
   @param  ModeNumber             The mode number to return information on.\r
   @param  Columns                Columen in current mode number\r
   @param  Rows                   Row in current mode number.\r

-  \r
+\r

   @retval EFI_SUCCESS            The requested mode information was returned.\r
   @retval EFI_DEVICE_ERROR       The device had an error and could not complete the request.\r
   @retval EFI_UNSUPPORTED        The mode number was not valid.\r
   @retval EFI_SUCCESS            The requested mode information was returned.\r
   @retval EFI_DEVICE_ERROR       The device had an error and could not complete the request.\r
   @retval EFI_UNSUPPORTED        The mode number was not valid.\r


@@ -461,7 +460,7 @@ VgaClassQueryMode (
 \r
 /**\r
   Sets the output device(s) to a specified mode.\r
 \r
 /**\r
   Sets the output device(s) to a specified mode.\r

-  \r
+\r

   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.QueryMode().\r
   It sets the output device(s) to the requested mode.\r
   On success the device is in the geometry for the requested mode,\r
   This function implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.QueryMode().\r
   It sets the output device(s) to the requested mode.\r
   On success the device is in the geometry for the requested mode,\r


@@ -469,7 +468,7 @@ VgaClassQueryMode (
 \r
   @param  This                   Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.\r
   @param  ModeNumber             The text mode to set.\r
 \r
   @param  This                   Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.\r
   @param  ModeNumber             The text mode to set.\r

-  \r
+\r

   @retval EFI_SUCCESS            The requested text mode was set.\r
   @retval EFI_DEVICE_ERROR       The device had an error and could not complete the request.\r
   @retval EFI_UNSUPPORTED        The mode number was not valid.\r
   @retval EFI_SUCCESS            The requested text mode was set.\r
   @retval EFI_DEVICE_ERROR       The device had an error and could not complete the request.\r
   @retval EFI_UNSUPPORTED        The mode number was not valid.\r