ConsoleControl.h File Reference

Go to the source code of this file.

Data Structures
struct	EFI_CONSOLE_CONTROL_PROTOCOL

Macros
#define	EFI_CONSOLE_CONTROL_PROTOCOL_GUID

Typedefs
typedef struct EFI_CONSOLE_CONTROL_PROTOCOL	EFI_CONSOLE_CONTROL_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE) (IN EFI_CONSOLE_CONTROL_PROTOCOL *This, OUT EFI_CONSOLE_CONTROL_SCREEN_MODE *Mode, OUT BOOLEAN *GopUgaExists OPTIONAL, OUT BOOLEAN *StdInLocked OPTIONAL)
typedef EFI_STATUS(EFIAPI *	EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE) (IN EFI_CONSOLE_CONTROL_PROTOCOL *This, IN EFI_CONSOLE_CONTROL_SCREEN_MODE Mode)
typedef EFI_STATUS(EFIAPI *	EFI_CONSOLE_CONTROL_PROTOCOL_LOCK_STD_IN) (IN EFI_CONSOLE_CONTROL_PROTOCOL *This, IN CHAR16 *Password)

Enumerations
enum	EFI_CONSOLE_CONTROL_SCREEN_MODE { EfiConsoleControlScreenText , EfiConsoleControlScreenGraphics , EfiConsoleControlScreenMaxValue }

Variables
EFI_GUID	gEfiConsoleControlProtocolGuid

Detailed Description

Abstraction of a Text mode or GOP/UGA screen

Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file ConsoleControl.h.

Macro Definition Documentation

EFI_CONSOLE_CONTROL_PROTOCOL_GUID

#define EFI_CONSOLE_CONTROL_PROTOCOL_GUID

Value:

  { 0xF42F7782, 0x012E, 0x4C12,            \
    { 0x99, 0x56, 0x49, 0xF9, 0x43, 0x04, 0xF7, 0x21 } }

Definition at line 17 of file ConsoleControl.h.

Typedef Documentation

EFI_CONSOLE_CONTROL_PROTOCOL

typedef struct EFI_CONSOLE_CONTROL_PROTOCOL EFI_CONSOLE_CONTROL_PROTOCOL

Definition at line 21 of file ConsoleControl.h.

EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE

typedef EFI_STATUS(EFIAPI * EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE) (IN EFI_CONSOLE_CONTROL_PROTOCOL *This, OUT EFI_CONSOLE_CONTROL_SCREEN_MODE *Mode, OUT BOOLEAN *GopUgaExists OPTIONAL, OUT BOOLEAN *StdInLocked OPTIONAL)

Return the current video mode information. Also returns info about existence of Graphics Output devices or UGA Draw devices in system, and if the Std In device is locked. All the arguments are optional and only returned if a non NULL pointer is passed in.

Parameters

[in]	This	Protocol instance pointer.
[out]	Mode	Are we in text of grahics mode.
[out]	GopUgaExists	TRUE if Console Spliter has found a GOP or UGA device
[out]	StdInLocked	TRUE if StdIn device is keyboard locked

Return values

EFI_SUCCESS

Mode information returned.

Definition at line 45 of file ConsoleControl.h.

EFI_CONSOLE_CONTROL_PROTOCOL_LOCK_STD_IN

typedef EFI_STATUS(EFIAPI * EFI_CONSOLE_CONTROL_PROTOCOL_LOCK_STD_IN) (IN EFI_CONSOLE_CONTROL_PROTOCOL *This, IN CHAR16 *Password)

Lock Std In devices until Password is typed.

Parameters

[in]	This	Protocol instance pointer.
[in]	Password	Password needed to unlock screen. NULL means unlock keyboard

Return values

EFI_SUCCESS	Mode information returned.
EFI_DEVICE_ERROR	Std In not locked

Definition at line 82 of file ConsoleControl.h.

EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE

typedef EFI_STATUS(EFIAPI * EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE) (IN EFI_CONSOLE_CONTROL_PROTOCOL *This, IN EFI_CONSOLE_CONTROL_SCREEN_MODE Mode)

Set the current mode to either text or graphics. Graphics is for Quiet Boot.

Parameters

[in]	This	Protocol instance pointer.
[in]	Mode	Mode to set the

Return values

EFI_SUCCESS

Mode information returned.

Definition at line 64 of file ConsoleControl.h.

Enumeration Type Documentation

EFI_CONSOLE_CONTROL_SCREEN_MODE

enum EFI_CONSOLE_CONTROL_SCREEN_MODE

Enumerator
EfiConsoleControlScreenText
EfiConsoleControlScreenGraphics
EfiConsoleControlScreenMaxValue

Definition at line 23 of file ConsoleControl.h.

Variable Documentation

gEfiConsoleControlProtocolGuid

EFI_GUID gEfiConsoleControlProtocolGuid

extern