diff options
| author | Girish Pathak <girish.pathak at arm.com> | 2017-09-26 21:15:12 +0100 |
|---|---|---|
| committer | Leif Lindholm <leif.lindholm@linaro.org> | 2018-04-23 12:00:23 +0100 |
| commit | 4257dfaa61b66115c52624ba1547de7bb1124aa0 (patch) | |
| tree | 94a1577b638fc46a1a6e3b88a909489d4dd7484a /ArmPlatformPkg/Library/PL111Lcd | |
| parent | b1b69d2606e8995d08bf25e3ed286c20034bfba3 (diff) | |
| download | edk2-4257dfaa61b66115c52624ba1547de7bb1124aa0.tar.gz edk2-4257dfaa61b66115c52624ba1547de7bb1124aa0.tar.bz2 edk2-4257dfaa61b66115c52624ba1547de7bb1124aa0.zip | |
ArmPlatformPkg: Tidy Lcd code: Updated comments
There is no functional modification in this change
some comments are modified and a few new comments are added.
This is to prevent mixing formatting changes with functional
changes.
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Girish Pathak <girish.pathak@arm.com>
Signed-off-by: Evan Lloyd <evan.lloyd@arm.com>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>
Diffstat (limited to 'ArmPlatformPkg/Library/PL111Lcd')
| -rw-r--r-- | ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c | 24 |
1 files changed, 22 insertions, 2 deletions
diff --git a/ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c b/ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c index 3f3f7019f1..ccd7a4d1d4 100644 --- a/ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c +++ b/ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c @@ -1,4 +1,5 @@ /** @file
+ This file contains the platform independent parts of PL111Lcd
Copyright (c) 2011-2018, ARM Ltd. All rights reserved.<BR>
@@ -19,9 +20,12 @@ #include "PL111Lcd.h"
-/** This file contains all the bits of the PL111 that are
- platform independent.
+/** Check for presence of PL111.
+ @retval EFI_SUCCESS Returns success if platform implements a
+ PL111 controller.
+
+ @retval EFI_NOT_FOUND PL111 display controller not found the plaform.
**/
EFI_STATUS
LcdIdentify (
@@ -45,6 +49,12 @@ LcdIdentify ( return EFI_NOT_FOUND;
}
+/** Initialize display.
+
+ @param[in] VramBaseAddress Address of the framebuffer.
+
+ @retval EFI_SUCCESS Initialization of display successful.
+**/
EFI_STATUS
LcdInitialize (
IN EFI_PHYSICAL_ADDRESS VramBaseAddress
@@ -60,6 +70,14 @@ LcdInitialize ( return EFI_SUCCESS;
}
+/** Set requested mode of the display.
+
+ @param[in] ModeNumbe Display mode number.
+
+ @retval EFI_SUCCESS Display mode set successfuly.
+ @retval EFI_DEVICE_ERROR It returns an error if display timing
+ information is not available.
+**/
EFI_STATUS
LcdSetMode (
IN UINT32 ModeNumber
@@ -130,6 +148,8 @@ LcdSetMode ( return EFI_SUCCESS;
}
+/** De-initializes the display.
+*/
VOID
LcdShutdown (
VOID
|