ArmPlatformPkg/Include/Library/LcdHwLib.h

   1 /** @file LcdHwLib.h
   2
   3   This file contains interface functions for LcdHwLib of ArmPlatformPkg
   4
   5   Copyright (c) 2017, ARM Ltd. All rights reserved.<BR>
   6
   7   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 LCD_HW_LIB_H_
  18 #define LCD_HW_LIB_H_
  19
  20 #include <Uefi/UefiBaseType.h>
  21
  22 /**
  23   Check for presence of display
  24
  25   @retval EFI_SUCCESS            Platform implements display.
  26   @retval EFI_NOT_FOUND          Display not found on the platform.
  27
  28 **/
  29 EFI_STATUS
  30 LcdIdentify (
  31   VOID
  32   );
  33
  34 /**
  35   Initialize display.
  36
  37   @param  FrameBaseAddress       Address of the frame buffer.
  38   @retval EFI_SUCCESS            Display initialization success.
  39   @retval !(EFI_SUCCESS)         Display initialization failure.
  40
  41 **/
  42 EFI_STATUS
  43 LcdInitialize (
  44   EFI_PHYSICAL_ADDRESS  FrameBaseAddress
  45   );
  46
  47 /**
  48   Set requested mode of the display.
  49
  50   @param  ModeNumber             Display mode number.
  51   @retval EFI_SUCCESS            Display set mode success.
  52   @retval EFI_DEVICE_ERROR       If mode not found/supported.
  53
  54 **/
  55 EFI_STATUS
  56 LcdSetMode (
  57   IN UINT32  ModeNumber
  58   );
  59
  60 /**
  61   De-initializes the display.
  62 **/
  63 VOID
  64 LcdShutdown (
  65   VOID
  66   );
  67
  68 #endif /* LCD_HW_LIB_H_ */