/** @file\r
Header file for GraphicsConsole driver.\r
\r
-Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\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
\r
/**\r
Reset the text output device hardware and optionally run diagnostics.\r
- \r
+\r
Implements SIMPLE_TEXT_OUTPUT.Reset().\r
If ExtendeVerification is TRUE, then perform dependent Graphics Console\r
device reset, and set display mode to mode 0.\r
/**\r
Write a Unicode string to the output device.\r
\r
- Implements SIMPLE_TEXT_OUTPUT.OutputString(). \r
+ Implements SIMPLE_TEXT_OUTPUT.OutputString().\r
The Unicode string will be converted to Glyphs and will be\r
sent to the Graphics Console.\r
\r
);\r
\r
/**\r
- Verifies that all characters in a Unicode string can be output to the \r
+ Verifies that all characters in a Unicode string can be output to the\r
target device.\r
\r
Implements SIMPLE_TEXT_OUTPUT.TestString().\r
\r
/**\r
Sets the output device(s) to a specified mode.\r
- \r
+\r
Implements SIMPLE_TEXT_OUTPUT.SetMode().\r
Set the Graphics Console to a specified mode. In this driver, we only support mode 0.\r
\r
@param ModeNumber The text mode to set.\r
\r
@retval EFI_SUCCESS The requested text mode is set.\r
- @retval EFI_DEVICE_ERROR The requested text mode cannot be set because of \r
+ @retval EFI_DEVICE_ERROR The requested text mode cannot be set because of\r
Graphics Console device error.\r
@retval EFI_UNSUPPORTED The text mode number is not valid.\r
\r
\r
@param This Protocol instance pointer.\r
@param Attribute The attribute to set. Bits 0..3 are the foreground\r
- color, and bits 4..6 are the background color. \r
+ color, and bits 4..6 are the background color.\r
All other bits are undefined and must be zero.\r
\r
@retval EFI_SUCCESS The requested attribute is set.\r
);\r
\r
/**\r
- Clears the output device(s) display to the currently selected background \r
+ Clears the output device(s) display to the currently selected background\r
color.\r
\r
Implements SIMPLE_TEXT_OUTPUT.ClearScreen().\r
\r
\r
/**\r
- Start this driver on Controller by opening Graphics Output protocol or \r
+ Start this driver on Controller by opening Graphics Output protocol or\r
UGA Draw protocol, and installing Simple Text Out protocol on Controller.\r
(UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)\r
- \r
+\r
@param This Protocol instance pointer.\r
@param Controller Handle of device to bind driver to\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
);\r
\r
/**\r
- Stop this driver on Controller by removing Simple Text Out protocol \r
+ Stop this driver on Controller by removing Simple Text Out protocol\r
and closing the Graphics Output Protocol or UGA Draw protocol on Controller.\r
(UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)\r
- \r
+\r
\r
@param This Protocol instance pointer.\r
@param Controller Handle of device to stop driver on\r
@param ChildHandleBuffer List of Child Handles to Stop.\r
\r
@retval EFI_SUCCESS This driver is removed Controller.\r
- @retval EFI_NOT_STARTED Simple Text Out protocol could not be found the \r
+ @retval EFI_NOT_STARTED Simple Text Out protocol could not be found the\r
Controller.\r
@retval other This driver was not removed from this device.\r
\r
/**\r
Locate HII Database protocol and HII Font protocol.\r
\r
- @retval EFI_SUCCESS HII Database protocol and HII Font protocol \r
+ @retval EFI_SUCCESS HII Database protocol and HII Font protocol\r
are located successfully.\r
- @return other Failed to locate HII Database protocol or \r
+ @return other Failed to locate HII Database protocol or\r
HII Font protocol.\r
\r
**/\r
\r
/**\r
Flush the cursor on the screen.\r
- \r
+\r
If CursorVisible is FALSE, nothing to do and return directly.\r
- If CursorVisible is TRUE, \r
+ If CursorVisible is TRUE,\r
i) If the cursor shows on screen, it will be erased.\r
- ii) If the cursor does not show on screen, it will be shown. \r
+ ii) If the cursor does not show on screen, it will be shown.\r
\r
@param This Protocol instance pointer.\r
\r
for the Graphics Console device based on Graphics Output Protocol.\r
\r
If yes, set the graphic device's current mode to this specific mode.\r
- \r
+\r
@param GraphicsOutput Graphics Output Protocol instance pointer.\r
@param HorizontalResolution User defined horizontal resolution\r
@param VerticalResolution User defined vertical resolution.\r
@param CurrentModeNumber Current specific mode to be check.\r
\r
@retval EFI_SUCCESS The mode is supported.\r
- @retval EFI_UNSUPPORTED The specific mode is out of range of graphics \r
+ @retval EFI_UNSUPPORTED The specific mode is out of range of graphics\r
device supported.\r
- @retval other The specific mode does not support user defined \r
- resolution or failed to set the current mode to the \r
+ @retval other The specific mode does not support user defined\r
+ resolution or failed to set the current mode to the\r
specific mode on graphics device.\r
\r
**/\r
projects / mirror_edk2.git / blobdiff