TianoCore EDK2 master
|
#include "Shell.h"
Go to the source code of this file.
Data Structures | |
struct | _CONSOLE_LOGGER_PRIVATE_DATA |
Macros | |
#define | CONSOLE_LOGGER_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('c', 'o', 'P', 'D') |
#define | CONSOLE_LOGGER_PRIVATE_DATA_FROM_THIS(a) CR (a, CONSOLE_LOGGER_PRIVATE_DATA, OurConOut, CONSOLE_LOGGER_PRIVATE_DATA_SIGNATURE) |
Typedefs | |
typedef struct _CONSOLE_LOGGER_PRIVATE_DATA | CONSOLE_LOGGER_PRIVATE_DATA |
Provides interface to shell console logger.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file ConsoleLogger.h.
#define CONSOLE_LOGGER_PRIVATE_DATA_FROM_THIS | ( | a | ) | CR (a, CONSOLE_LOGGER_PRIVATE_DATA, OurConOut, CONSOLE_LOGGER_PRIVATE_DATA_SIGNATURE) |
Definition at line 39 of file ConsoleLogger.h.
#define CONSOLE_LOGGER_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('c', 'o', 'P', 'D') |
Definition at line 13 of file ConsoleLogger.h.
EFI_STATUS EFIAPI ConsoleLoggerClearScreen | ( | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL * | This | ) |
Clears the output device(s) display to the currently selected background color.
[in] | This | Protocol instance pointer. |
EFI_SUCCESS | The operation completed successfully. |
EFI_DEVICE_ERROR | The device had an error and could not complete the request. |
EFI_UNSUPPORTED | The output device is not in a valid text mode. |
Definition at line 1081 of file ConsoleLogger.c.
EFI_STATUS ConsoleLoggerDisplayHistory | ( | IN CONST BOOLEAN | Forward, |
IN CONST UINTN | Rows, | ||
IN CONSOLE_LOGGER_PRIVATE_DATA * | ConsoleInfo | ||
) |
Displays previously logged output back to the screen.
This will scroll the screen forwards and backwards through the log of previous output. If Rows is 0 then the size of 1/2 the screen will be scrolled. If Rows is (UINTN)(-1) then the size of the screen will be scrolled.
[in] | Forward | If TRUE then the log will be displayed forwards (scroll to newer). If FALSE then the log will be displayed backwards (scroll to older). |
[in] | Rows | Determines how many rows the log should scroll. |
[in] | ConsoleInfo | The pointer to the instance of the console logger information. |
Definition at line 167 of file ConsoleLogger.c.
EFI_STATUS EFIAPI ConsoleLoggerEnableCursor | ( | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL * | This, |
IN BOOLEAN | Visible | ||
) |
Makes the cursor visible or invisible
[in] | This | Protocol instance pointer. |
[in] | Visible | If TRUE, the cursor is set to be visible. If FALSE, the cursor is set to be invisible. |
EFI_SUCCESS | The operation completed successfully. |
EFI_DEVICE_ERROR | The device had an error and could not complete the request, or the device does not support changing the cursor mode. |
EFI_UNSUPPORTED | The output device is not in a valid text mode. |
Definition at line 1202 of file ConsoleLogger.c.
EFI_STATUS ConsoleLoggerInstall | ( | IN CONST UINTN | ScreensToSave, |
OUT CONSOLE_LOGGER_PRIVATE_DATA ** | ConsoleInfo | ||
) |
Install our intermediate ConOut into the system table to keep a log of all the info that is displayed to the user.
[in] | ScreensToSave | Sets how many screen-worths of data to save. |
[out] | ConsoleInfo | The object to pass into later functions. |
EFI_SUCCESS | The operation was successful. |
Definition at line 26 of file ConsoleLogger.c.
EFI_STATUS EFIAPI ConsoleLoggerOutputString | ( | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL * | This, |
IN CHAR16 * | WString | ||
) |
Write a Unicode string to the output device.
[in] | This | Protocol instance pointer. |
[in] | WString | The NULL-terminated Unicode string to be displayed on the output device(s). All output devices must also support the Unicode drawing defined in this file. |
EFI_SUCCESS | The string was output to the device. |
EFI_DEVICE_ERROR | The device reported an error while attempting to output the text. |
EFI_UNSUPPORTED | The output device's mode is not currently in a defined text mode. |
EFI_WARN_UNKNOWN_GLYPH | This warning code indicates that some of the characters in the Unicode string could not be rendered and were skipped. |
Definition at line 862 of file ConsoleLogger.c.
EFI_STATUS EFIAPI ConsoleLoggerQueryMode | ( | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL * | This, |
IN UINTN | ModeNumber, | ||
OUT UINTN * | Columns, | ||
OUT UINTN * | Rows | ||
) |
Returns information for an available text mode that the output device(s) supports.
[in] | This | Protocol instance pointer. |
[in] | ModeNumber | The mode number to return information on. |
[out] | Columns | Upon return, the number of columns in the selected geometry |
[out] | Rows | Upon return, the number of rows in the selected geometry |
EFI_SUCCESS | The requested mode information was returned. |
EFI_DEVICE_ERROR | The device had an error and could not complete the request. |
EFI_UNSUPPORTED | The mode number was not valid. |
Definition at line 960 of file ConsoleLogger.c.
EFI_STATUS EFIAPI ConsoleLoggerReset | ( | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL * | This, |
IN BOOLEAN | ExtendedVerification | ||
) |
Reset the text output device hardware and optionally run diagnostics
This | Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL |
ExtendedVerification | Indicates that a more extensive test may be performed |
EFI_SUCCESS | The text output device was reset. |
EFI_DEVICE_ERROR | The text output device is not functioning correctly and could not be reset. |
Reset the text output device hardware and optionally run diagnostics
This | pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL |
ExtendedVerification | Indicates that a more extensive test may be performed |
EFI_SUCCESS | The text output device was reset. |
EFI_DEVICE_ERROR | The text output device is not functioning correctly and could not be reset. |
Definition at line 422 of file ConsoleLogger.c.
EFI_STATUS ConsoleLoggerResetBuffers | ( | IN CONSOLE_LOGGER_PRIVATE_DATA * | ConsoleInfo | ) |
Function to update and verify that the current buffers are correct.
[in] | ConsoleInfo | The pointer to the instance of the console logger information. |
This will be used when a mode has changed or a reset occurred to verify all history buffers.
Definition at line 1236 of file ConsoleLogger.c.
EFI_STATUS EFIAPI ConsoleLoggerSetAttribute | ( | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL * | This, |
IN UINTN | Attribute | ||
) |
Sets the background and foreground colors for the OutputString () and ClearScreen () functions.
[in] | This | Protocol instance pointer. |
[in] | Attribute | The attribute to set. Bits 0..3 are the foreground color, and bits 4..6 are the background color. All other bits are undefined and must be zero. The valid Attributes are defined in this file. |
EFI_SUCCESS | The attribute was set. |
EFI_DEVICE_ERROR | The device had an error and could not complete the request. |
EFI_UNSUPPORTED | The attribute requested is not defined. |
Definition at line 1042 of file ConsoleLogger.c.
EFI_STATUS EFIAPI ConsoleLoggerSetCursorPosition | ( | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL * | This, |
IN UINTN | Column, | ||
IN UINTN | Row | ||
) |
Sets the current coordinates of the cursor position.
[in] | This | Protocol instance pointer. |
[in] | Column | Column to put the cursor in. Must be between zero and Column returned from QueryMode |
[in] | Row | Row to put the cursor in. Must be between zero and Row returned from QueryMode |
EFI_SUCCESS | The operation completed successfully. |
EFI_DEVICE_ERROR | The device had an error and could not complete the request. |
EFI_UNSUPPORTED | The output device is not in a valid text mode, or the cursor position is invalid for the current mode. |
Sets the current coordinates of the cursor position
[in] | This | Protocol instance pointer. |
[in] | Column | Column to put the cursor in. Must be between zero and Column returned from QueryMode |
[in] | Row | Row to put the cursor in. Must be between zero and Row returned from QueryMode |
EFI_SUCCESS | The operation completed successfully. |
EFI_DEVICE_ERROR | The device had an error and could not complete the request. |
EFI_UNSUPPORTED | The output device is not in a valid text mode, or the cursor position is invalid for the current mode. |
Definition at line 1153 of file ConsoleLogger.c.
EFI_STATUS EFIAPI ConsoleLoggerSetMode | ( | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL * | This, |
IN UINTN | ModeNumber | ||
) |
Sets the output device(s) to a specified mode.
[in] | This | Protocol instance pointer. |
[in] | ModeNumber | The mode number to set. |
EFI_SUCCESS | The requested text mode was set. |
EFI_DEVICE_ERROR | The device had an error and could not complete the request. |
EFI_UNSUPPORTED | The mode number was not valid. |
Definition at line 995 of file ConsoleLogger.c.
EFI_STATUS ConsoleLoggerStopHistory | ( | IN CONSOLE_LOGGER_PRIVATE_DATA * | ConsoleInfo | ) |
Function to return to normal output whent he scrolling is complete.
[in] | ConsoleInfo | The pointer to the instance of the console logger information. |
EFI_SUCCESS | The operation was successful. |
Definition at line 242 of file ConsoleLogger.c.
EFI_STATUS EFIAPI ConsoleLoggerTestString | ( | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL * | This, |
IN CHAR16 * | WString | ||
) |
Verifies that all characters in a Unicode string can be output to the target device.
[in] | This | Protocol instance pointer. |
[in] | WString | The NULL-terminated Unicode string to be examined for the output device(s). |
EFI_SUCCESS | The device(s) are capable of rendering the output string. |
EFI_UNSUPPORTED | Some of the characters in the Unicode string cannot be rendered by one or more of the output devices mapped by the EFI handle. |
Definition at line 930 of file ConsoleLogger.c.
EFI_STATUS ConsoleLoggerUninstall | ( | IN OUT CONSOLE_LOGGER_PRIVATE_DATA * | ConsoleInfo | ) |
Return the system to the state it was before InstallConsoleLogger was installed.
[in,out] | ConsoleInfo | The object from the install function. |
EFI_SUCCESS | The operation was successful |
EFI_STATUS UpdateDisplayFromHistory | ( | IN CONSOLE_LOGGER_PRIVATE_DATA * | ConsoleInfo | ) |
Updates the hidden ConOut to be displaying the correct stuff.
[in] | ConsoleInfo | The pointer to the instance of the console logger information. |
EFI_SUCCESS | The operation was successful. |
Definition at line 268 of file ConsoleLogger.c.