]> git.proxmox.com Git - mirror_edk2.git/blame - ArmPlatformPkg/Include/Library/LcdHwLib.h
ArmPlatformPkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / ArmPlatformPkg / Include / Library / LcdHwLib.h
CommitLineData
99cfb43a
AB
1/** @file LcdHwLib.h\r
2\r
3 This file contains interface functions for LcdHwLib of ArmPlatformPkg\r
4\r
5 Copyright (c) 2017, ARM Ltd. All rights reserved.<BR>\r
6\r
f4dfad05 7 SPDX-License-Identifier: BSD-2-Clause-Patent\r
99cfb43a
AB
8\r
9**/\r
10\r
11#ifndef LCD_HW_LIB_H_\r
12#define LCD_HW_LIB_H_\r
13\r
14#include <Uefi/UefiBaseType.h>\r
15\r
16/**\r
17 Check for presence of display\r
18\r
19 @retval EFI_SUCCESS Platform implements display.\r
20 @retval EFI_NOT_FOUND Display not found on the platform.\r
21\r
22**/\r
23EFI_STATUS\r
24LcdIdentify (\r
25 VOID\r
26 );\r
27\r
28/**\r
29 Initialize display.\r
30\r
31 @param FrameBaseAddress Address of the frame buffer.\r
32 @retval EFI_SUCCESS Display initialization success.\r
33 @retval !(EFI_SUCCESS) Display initialization failure.\r
34\r
35**/\r
36EFI_STATUS\r
37LcdInitialize (\r
38 EFI_PHYSICAL_ADDRESS FrameBaseAddress\r
39 );\r
40\r
41/**\r
42 Set requested mode of the display.\r
43\r
44 @param ModeNumber Display mode number.\r
45 @retval EFI_SUCCESS Display set mode success.\r
46 @retval EFI_DEVICE_ERROR If mode not found/supported.\r
47\r
48**/\r
49EFI_STATUS\r
50LcdSetMode (\r
51 IN UINT32 ModeNumber\r
52 );\r
53\r
54/**\r
55 De-initializes the display.\r
56**/\r
57VOID\r
58LcdShutdown (\r
59 VOID\r
60 );\r
61\r
62#endif /* LCD_HW_LIB_H_ */\r