ArmPlatformPkg: introduce LcdHwLib library class

[mirror_edk2.git] / ArmPlatformPkg / Include / Library / LcdHwLib.h

diff --git a/ArmPlatformPkg/Include/Library/LcdHwLib.h b/ArmPlatformPkg/Include/Library/LcdHwLib.h
new file mode 100644 (file)
index 0000000..0c04808
--- /dev/null
+++ b/ArmPlatformPkg/Include/Library/LcdHwLib.h
@@ -0,0 +1,68 @@
+/** @file LcdHwLib.h\r
+\r
+  This file contains interface functions for LcdHwLib of ArmPlatformPkg\r
+\r
+  Copyright (c) 2017, ARM Ltd. All rights reserved.<BR>\r
+\r
+  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 LCD_HW_LIB_H_\r
+#define LCD_HW_LIB_H_\r
+\r
+#include <Uefi/UefiBaseType.h>\r
+\r
+/**\r
+  Check for presence of display\r
+\r
+  @retval EFI_SUCCESS            Platform implements display.\r
+  @retval EFI_NOT_FOUND          Display not found on the platform.\r
+\r
+**/\r
+EFI_STATUS\r
+LcdIdentify (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  Initialize display.\r
+\r
+  @param  FrameBaseAddress       Address of the frame buffer.\r
+  @retval EFI_SUCCESS            Display initialization success.\r
+  @retval !(EFI_SUCCESS)         Display initialization failure.\r
+\r
+**/\r
+EFI_STATUS\r
+LcdInitialize (\r
+  EFI_PHYSICAL_ADDRESS  FrameBaseAddress\r
+  );\r
+\r
+/**\r
+  Set requested mode of the display.\r
+\r
+  @param  ModeNumber             Display mode number.\r
+  @retval EFI_SUCCESS            Display set mode success.\r
+  @retval EFI_DEVICE_ERROR       If mode not found/supported.\r
+\r
+**/\r
+EFI_STATUS\r
+LcdSetMode (\r
+  IN UINT32  ModeNumber\r
+  );\r
+\r
+/**\r
+  De-initializes the display.\r
+**/\r
+VOID\r
+LcdShutdown (\r
+  VOID\r
+  );\r
+\r
+#endif /* LCD_HW_LIB_H_ */\r