projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 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 | |
| 7 | This program and the accompanying materials\r | |
| 8 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 9 | which accompanies this distribution. The full text of the license may be found at\r | |
| 10 | http://opensource.org/licenses/bsd-license.php\r | |
| 11 | \r | |
| 12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 14 | \r | |
| 15 | **/\r | |
| 16 | \r | |
| 17 | #ifndef LCD_HW_LIB_H_\r | |
| 18 | #define LCD_HW_LIB_H_\r | |
| 19 | \r | |
| 20 | #include <Uefi/UefiBaseType.h>\r | |
| 21 | \r | |
| 22 | /**\r | |
| 23 | Check for presence of display\r | |
| 24 | \r | |
| 25 | @retval EFI_SUCCESS Platform implements display.\r | |
| 26 | @retval EFI_NOT_FOUND Display not found on the platform.\r | |
| 27 | \r | |
| 28 | **/\r | |
| 29 | EFI_STATUS\r | |
| 30 | LcdIdentify (\r | |
| 31 | VOID\r | |
| 32 | );\r | |
| 33 | \r | |
| 34 | /**\r | |
| 35 | Initialize display.\r | |
| 36 | \r | |
| 37 | @param FrameBaseAddress Address of the frame buffer.\r | |
| 38 | @retval EFI_SUCCESS Display initialization success.\r | |
| 39 | @retval !(EFI_SUCCESS) Display initialization failure.\r | |
| 40 | \r | |
| 41 | **/\r | |
| 42 | EFI_STATUS\r | |
| 43 | LcdInitialize (\r | |
| 44 | EFI_PHYSICAL_ADDRESS FrameBaseAddress\r | |
| 45 | );\r | |
| 46 | \r | |
| 47 | /**\r | |
| 48 | Set requested mode of the display.\r | |
| 49 | \r | |
| 50 | @param ModeNumber Display mode number.\r | |
| 51 | @retval EFI_SUCCESS Display set mode success.\r | |
| 52 | @retval EFI_DEVICE_ERROR If mode not found/supported.\r | |
| 53 | \r | |
| 54 | **/\r | |
| 55 | EFI_STATUS\r | |
| 56 | LcdSetMode (\r | |
| 57 | IN UINT32 ModeNumber\r | |
| 58 | );\r | |
| 59 | \r | |
| 60 | /**\r | |
| 61 | De-initializes the display.\r | |
| 62 | **/\r | |
| 63 | VOID\r | |
| 64 | LcdShutdown (\r | |
| 65 | VOID\r | |
| 66 | );\r | |
| 67 | \r | |
| 68 | #endif /* LCD_HW_LIB_H_ */\r |