Clean up: update "EFI" to "UEFI" if applicable.

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / ConsoleControl.h

/*++ \r
\r
Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
All rights reserved. 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
Module Name:\r
\r
  ConsoleControl.h\r
\r
Abstract:\r
\r
  Abstraction of a Text mode or GOP/UGA screen\r
\r
--*/\r
\r
#ifndef __CONSOLE_CONTROL_H__\r
#define __CONSOLE_CONTROL_H__\r
\r
#define EFI_CONSOLE_CONTROL_PROTOCOL_GUID \\r
  { 0xf42f7782, 0x12e, 0x4c12, {0x99, 0x56, 0x49, 0xf9, 0x43, 0x4, 0xf7, 0x21 } }\r
\r
typedef struct _EFI_CONSOLE_CONTROL_PROTOCOL   EFI_CONSOLE_CONTROL_PROTOCOL;\r
\r
\r
typedef enum {\r
  EfiConsoleControlScreenText,\r
  EfiConsoleControlScreenGraphics,\r
  EfiConsoleControlScreenMaxValue\r
} EFI_CONSOLE_CONTROL_SCREEN_MODE;\r
\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE) (\r
  IN  EFI_CONSOLE_CONTROL_PROTOCOL      *This,\r
  OUT EFI_CONSOLE_CONTROL_SCREEN_MODE   *Mode,\r
  OUT BOOLEAN                           *GopUgaExists,  OPTIONAL  \r
  OUT BOOLEAN                           *StdInLocked    OPTIONAL\r
  )\r
/*++\r
\r
  Routine Description:\r
    Return the current video mode information. Also returns info about existence\r
    of Graphics Output devices or UGA Draw devices in system, and if the Std In\r
    device is locked. All the arguments are optional and only returned if a non\r
    NULL pointer is passed in.\r
\r
  Arguments:\r
    This - Protocol instance pointer.\r
    Mode        - Are we in text of grahics mode.\r
    GopUgaExists - TRUE if Console Spliter has found a GOP or UGA device\r
    StdInLocked - TRUE if StdIn device is keyboard locked\r
\r
  Returns:\r
    EFI_SUCCESS     - Mode information returned.\r
\r
--*/\r
;\r
\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE) (\r
  IN  EFI_CONSOLE_CONTROL_PROTOCOL      *This,\r
  OUT EFI_CONSOLE_CONTROL_SCREEN_MODE   Mode\r
  )\r
/*++\r
\r
  Routine Description:\r
    Set the current mode to either text or graphics. Graphics is\r
    for Quiet Boot.\r
\r
  Arguments:\r
    This  - Protocol instance pointer.\r
    Mode  - Mode to set the \r
\r
  Returns:\r
    EFI_SUCCESS     - Mode information returned.\r
\r
--*/\r
;\r
\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_LOCK_STD_IN) (\r
  IN  EFI_CONSOLE_CONTROL_PROTOCOL      *This,\r
  IN CHAR16                             *Password\r
  )\r
/*++\r
\r
  Routine Description:\r
    Lock Std In devices until Password is typed.\r
\r
  Arguments:\r
    This     - Protocol instance pointer.\r
    Password - Password needed to unlock screen. NULL means unlock keyboard\r
\r
  Returns:\r
    EFI_SUCCESS      - Mode information returned.\r
    EFI_DEVICE_ERROR - Std In not locked\r
\r
--*/\r
;\r
\r
\r
\r
struct _EFI_CONSOLE_CONTROL_PROTOCOL {\r
  EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE           GetMode;\r
  EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE           SetMode;\r
  EFI_CONSOLE_CONTROL_PROTOCOL_LOCK_STD_IN        LockStdIn;\r
};\r
\r
extern EFI_GUID gEfiConsoleControlProtocolGuid;\r
\r
#endif\r