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   Return the graphics image file named FileNameGuid into Image and return it's
  22   size in ImageSize. All Firmware Volumes (FV) in the system are searched for the
  23   file name.
  24
  25   @param[in]  FileNameGuid  File Name of graphics file in the FV(s).
  26   @param[out] Image         Pointer to pointer to return graphics image.  If NULL, a
  27                             buffer will be allocated.
  28   @param[out] ImageSize     Size of the graphics Image in bytes. Zero if no image found.
  29
  30   @retval  EFI_SUCCESS          The image is found and data and size is returned.
  31   @retval  EFI_UNSUPPORTED      FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.
  32   @retval  EFI_NOT_FOUND        The image specified by NameGuid and SectionType can't be found.
  33   @retval  EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
  34   @retval  EFI_DEVICE_ERROR     A hardware error occurs during reading from the Firmware Volume.
  35   @retval  EFI_ACCESS_DENIED    The firmware volume containing the searched Firmware File is configured to disallow reads.
  36
  37 **/
  38 EFI_STATUS
  39 EFIAPI
  40 GetGraphicsBitMapFromFV (
  41   IN  EFI_GUID      *FileNameGuid,
  42   OUT VOID          **Image,
  43   OUT UINTN         *ImageSize
  44   );
  45
  46 /**
  47   Return the graphics image file named FileNameGuid into Image and return it's
  48   size in ImageSize. All Firmware Volumes (FV) in the system are searched for the
  49   file name.
  50
  51   @param[in]  ImageHandle   The driver image handle of the caller. The parameter is used to
  52                             optimize the loading of the image file so that the FV from which
  53                             the driver image is loaded will be tried first.
  54   @param[in]  FileNameGuid  File Name of graphics file in the FV(s).
  55   @param[out] Image         Pointer to pointer to return graphics image.  If NULL, a
  56                             buffer will be allocated.
  57   @param[out] ImageSize     Size of the graphics Image in bytes. Zero if no image found.
  58
  59   @retval  EFI_SUCCESS          The image is found and data and size is returned.
  60   @retval  EFI_UNSUPPORTED      FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.
  61   @retval  EFI_NOT_FOUND        The image specified by NameGuid and SectionType can't be found.
  62   @retval  EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
  63   @retval  EFI_DEVICE_ERROR     A hardware error occurs during reading from the Firmware Volume.
  64   @retval  EFI_ACCESS_DENIED    The firmware volume containing the searched Firmware File is configured to disallow reads.
  65
  66 **/
  67 EFI_STATUS
  68 EFIAPI
  69 GetGraphicsBitMapFromFVEx (
  70   IN  EFI_HANDLE    ImageHandle,
  71   IN  EFI_GUID      *FileNameGuid,
  72   OUT VOID          **Image,
  73   OUT UINTN         *ImageSize
  74   );
  75
  76
  77 /**
  78   Use Console Control to turn off UGA based Simple Text Out consoles from going
  79   to the UGA device. Put up LogoFile on every UGA device that is a console
  80
  81   @param[in]  LogoFile   File name of logo to display on the center of the screen.
  82
  83   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.
  84   @retval EFI_UNSUPPORTED Logo not found
  85
  86 **/
  87 EFI_STATUS
  88 EFIAPI
  89 EnableQuietBoot (
  90   IN  EFI_GUID  *LogoFile
  91   );
  92
  93 /**
  94   Use Console Control to turn off GOP/UGA based Simple Text Out consoles from going
  95   to the UGA device. Put up LogoFile on every UGA device that is a console
  96
  97   @param  LogoFile    File name of logo to display on the center of the screen.
  98   @param  ImageHandle The driver image handle of the caller. The parameter is used to
  99                       optimize the loading of the logo file so that the FV from which
 100                       the driver image is loaded will be tried first.
 101
 102   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.
 103   @retval EFI_UNSUPPORTED Logo not found
 104
 105 **/
 106 EFI_STATUS
 107 EFIAPI
 108 EnableQuietBootEx (
 109   IN  EFI_GUID    *LogoFile,
 110   IN  EFI_HANDLE  ImageHandle
 111   );
 112
 113
 114 /**
 115   Use Console Control to turn on UGA based Simple Text Out consoles. The UGA
 116   Simple Text Out screens will now be synced up with all non UGA output devices
 117
 118   @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.
 119
 120 **/
 121 EFI_STATUS
 122 EFIAPI
 123 DisableQuietBoot (
 124   VOID
 125   );
 126
 127
 128 /**
 129   Use Console Control Protocol to lock the Console In Spliter virtual handle.
 130   This is the ConInHandle and ConIn handle in the EFI system table. All key
 131   presses will be ignored until the Password is typed in. The only way to
 132   disable the password is to type it in to a ConIn device.
 133
 134   @param[in]  Password   Password used to lock ConIn device.
 135
 136   @retval EFI_SUCCESS     lock the Console In Spliter virtual handle successfully.
 137   @retval EFI_UNSUPPORTED Password not found
 138
 139 **/
 140 EFI_STATUS
 141 EFIAPI
 142 LockKeyboards (
 143   IN  CHAR16    *Password
 144   );
 145
 146 #endif