Simple_text_output.reset() – Intel Extensible Firmware Interface User Manual

Page 305

Advertising
background image

Protocols

— Console Support

Version 1.10

12/01/02

10-11

SIMPLE_TEXT_OUTPUT.Reset()

Summary

Resets the text output device hardware.

Prototype

EFI_STATUS

(EFIAPI *EFI_TEXT_RESET) (

IN

SIMPLE_TEXT_OUTPUT_INTERFACE

*This,

IN

BOOLEAN

ExtendedVerification

);

Parameters

This

A pointer to the

SIMPLE_TEXT_OUTPUT_INTERFACE

instance. Type

SIMPLE_TEXT_OUTPUT_INTERFACE

is

defined in the “Related Definitions” section of Section 10.3.

ExtendedVerification

Indicates that the driver may perform a more exhaustive
verification operation of the device during reset.

Description

The

Reset()

function resets the text output device hardware. The cursor position is set to (0, 0),

and the screen is cleared to the default background color for the output device.

As part of initialization process, the firmware/device will make a quick but reasonable attempt to
verify that the device is functioning. If the

ExtendedVerification

flag is

TRUE

the

firmware may take an extended amount of time to verify the device is operating on reset.
Otherwise the reset operation is to occur as quickly as possible.

The hardware verification process is not defined by this specification and is left up to the platform
firmware and/or EFI driver to implement.

Status Codes Returned

EFI_SUCCESS

The text output device was reset.

EFI_DEVICE_ERROR

The text output device is not functioning correctly and could not be reset.

Advertising