/** @file\r
VGA Class Driver that managers VGA devices and produces Simple Text Output Protocol.\r
\r
-Copyright (c) 2006 - 2009, 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
+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
@param ImageHandle The firmware allocated handle for the EFI image.\r
@param SystemTable A pointer to the EFI System Table.\r
- \r
+\r
@retval EFI_SUCCESS The entry point is executed successfully.\r
\r
**/\r
\r
/**\r
Internal worker function to program CRTC register via PCI I/O Protocol.\r
- \r
+\r
@param VgaClassDev device instance object\r
@param Address Address of register to write\r
@param Data Data to write to register.\r
\r
/**\r
Internal worker function to set cursor's position to VgaClass device\r
- \r
+\r
@param VgaClassDev Private data structure for device instance.\r
@param Column Colomn of position to set cursor to.\r
@param Row Row of position to set cursor to.\r
@param MaxColumn Max value of column.\r
- \r
+\r
**/\r
VOID\r
SetVideoCursorPosition (\r
\r
/**\r
Internal worker function to check whether input value is an ASCII char.\r
- \r
+\r
@param Char Character to check.\r
\r
@retval TRUE Input value is an ASCII char.\r
\r
/**\r
Internal worker function to check whether input value is a unicode control char.\r
- \r
+\r
@param Char Character to check.\r
\r
@retval TRUE Input value is a unicode control char.\r
\r
/**\r
Starts the device controller.\r
- \r
+\r
This function implments EFI_DRIVER_BINDING_PROTOCOL.Stop().\r
It stops this driver on Controller. Support stopping any child handles\r
created by this driver.\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
\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
\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
\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
- \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
\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
@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
\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
- \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
- \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
\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
- \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
@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
\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
\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
projects / mirror_edk2.git / blobdiff