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   SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #ifndef LCD_HW_LIB_H_
  12 #define LCD_HW_LIB_H_
  13
  14 #include <Uefi/UefiBaseType.h>
  15
  16 /**
  17   Check for presence of display
  18
  19   @retval EFI_SUCCESS            Platform implements display.
  20   @retval EFI_NOT_FOUND          Display not found on the platform.
  21
  22 **/
  23 EFI_STATUS
  24 LcdIdentify (
  25   VOID
  26   );
  27
  28 /**
  29   Initialize display.
  30
  31   @param  FrameBaseAddress       Address of the frame buffer.
  32   @retval EFI_SUCCESS            Display initialization success.
  33   @retval !(EFI_SUCCESS)         Display initialization failure.
  34
  35 **/
  36 EFI_STATUS
  37 LcdInitialize (
  38   EFI_PHYSICAL_ADDRESS  FrameBaseAddress
  39   );
  40
  41 /**
  42   Set requested mode of the display.
  43
  44   @param  ModeNumber             Display mode number.
  45   @retval EFI_SUCCESS            Display set mode success.
  46   @retval EFI_DEVICE_ERROR       If mode not found/supported.
  47
  48 **/
  49 EFI_STATUS
  50 LcdSetMode (
  51   IN UINT32  ModeNumber
  52   );
  53
  54 /**
  55   De-initializes the display.
  56 **/
  57 VOID
  58 LcdShutdown (
  59   VOID
  60   );
  61
  62 #endif /* LCD_HW_LIB_H_ */