MdePkg/Include/Library/GraphicsLib.h

   1 /** @file
   2   Library supports displaying graphical splash screen,
   3   locking of keyboard input and printing character on
   4   screen.
   5
   6   Copyright (c) 2006 - 2008, Intel Corporation.<BR>
   7   All rights reserved. This program and the accompanying materials
   8   are licensed and made available under the terms and conditions of the BSD License
   9   which accompanies this distribution.  The full text of the license may be found at
  10   http://opensource.org/licenses/bsd-license.php
  11
  12   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef __EFI_GRAPHICS_LIB_H__
  18 #define __EFI_GRAPHICS_LIB_H__
  19
  20
  21 /**
  22   Use Console Control to turn off UGA based Simple Text Out consoles from going
  23   to the UGA device. Put up LogoFile on every UGA device that is a console
  24
  25   @param[in]  LogoFile   File name of logo to display on the center of the screen.
  26
  27   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.
  28   @retval EFI_UNSUPPORTED Logo not found
  29
  30 **/
  31 EFI_STATUS
  32 EFIAPI
  33 EnableQuietBoot (
  34   IN  EFI_GUID  *LogoFile
  35   );
  36
  37 /**
  38   Use Console Control to turn off GOP/UGA based Simple Text Out consoles from going
  39   to the UGA device. Put up LogoFile on every UGA device that is a console
  40
  41   @param  LogoFile    File name of logo to display on the center of the screen.
  42   @param  ImageHandle The driver image handle of the caller. The parameter is used to
  43                       optimize the loading of the logo file so that the FV from which
  44                       the driver image is loaded will be tried first.
  45
  46   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.
  47   @retval EFI_UNSUPPORTED Logo not found
  48
  49 **/
  50 EFI_STATUS
  51 EFIAPI
  52 EnableQuietBootEx (
  53   IN  EFI_GUID    *LogoFile,
  54   IN  EFI_HANDLE  ImageHandle
  55   );
  56
  57
  58 /**
  59   Use Console Control to turn on UGA based Simple Text Out consoles. The UGA
  60   Simple Text Out screens will now be synced up with all non UGA output devices
  61
  62   @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.
  63
  64 **/
  65 EFI_STATUS
  66 EFIAPI
  67 DisableQuietBoot (
  68   VOID
  69   );
  70
  71
  72 /**
  73   Use Console Control Protocol to lock the Console In Spliter virtual handle.
  74   This is the ConInHandle and ConIn handle in the EFI system table. All key
  75   presses will be ignored until the Password is typed in. The only way to
  76   disable the password is to type it in to a ConIn device.
  77
  78   @param[in]  Password   Password used to lock ConIn device.
  79
  80   @retval EFI_SUCCESS     lock the Console In Spliter virtual handle successfully.
  81   @retval EFI_UNSUPPORTED Password not found
  82
  83 **/
  84 EFI_STATUS
  85 EFIAPI
  86 LockKeyboards (
  87   IN  CHAR16    *Password
  88   );
  89
  90 #endif