refine comments for EFI_CONSOLE_CONTROL_PROTOCOL

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

/** @file\r
\r
  This protocol provides the interfaces to Get/Set the current video mode for GOP/UGA screen\r
\r
Copyright (c) 2006 - 2008, 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
**/\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,     /// Text Mode\r
  EfiConsoleControlScreenGraphics, /// Graphics Mode\r
  EfiConsoleControlScreenMaxValue\r
} EFI_CONSOLE_CONTROL_SCREEN_MODE;\r
\r
/**\r
  Return the current video mode information. Also returns info about existence\r
  of Graphics Output devices or UGA Draw devices in system, and whether the Std\r
  In device is locked. GopUgaExists and StdInLocked parameters are optional.\r
\r
  @param  This                    Protocol instance pointer.\r
  @param  Mode                    Current video mode.\r
  @param  GopExists               TRUE if GOP Spliter has found a GOP/UGA device\r
  @param  StdInLocked             TRUE if StdIn device is keyboard locked\r
\r
  @retval EFI_SUCCESS             Video mode information is returned.\r
  @retval EFI_INVALID_PARAMETER   Invalid parameters if Mode == NULL.\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
  Set the current video mode to either text or graphics. Graphics is\r
  for Quiet Boot.\r
\r
  @param  This                    Protocol instance pointer.\r
  @param  Mode                    Video mode is to be set.\r
\r
  @retval EFI_SUCCESS             Mode is set successfully.\r
  @retval EFI_INVALID_PARAMETER   Mode is not the valid mode value.\r
  @retval EFI_UNSUPPORTED         Mode is unsupported by console device.\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
  If Password is NULL or the Password is too big, then return an error. If the \r
  Password is valid, then store the password, lock StdIn and arm the periodic timer.\r
\r
  @param  This                     Console Control protocol pointer.\r
  @param  Password                 The password input.\r
\r
  @retval EFI_SUCCESS              Lock the StdIn device\r
  @retval EFI_INVALID_PARAMETER    Password is NULL\r
  @retval EFI_OUT_OF_RESOURCES     Buffer allocation to store the password fails\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
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