ArmPlatformPkg: Tidy Lcd code: Updated comments

[mirror_edk2.git] / ArmPlatformPkg / Library / PL111Lcd / PL111Lcd.c

diff --git a/ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c b/ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c
index 3f3f7019f1d252995eab6d8c3d49db8be8e09e40..ccd7a4d1d43ad5c2f495683ac68236e17f3b55a5 100644 (file)
--- a/ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c
+++ b/ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c
@@ -1,4 +1,5 @@
 /** @file\r
 /** @file\r

+  This file contains the platform independent parts of PL111Lcd\r

 \r
   Copyright (c) 2011-2018, ARM Ltd. All rights reserved.<BR>\r
 \r
 \r
   Copyright (c) 2011-2018, ARM Ltd. All rights reserved.<BR>\r
 \r


@@ -19,9 +20,12 @@
 \r
 #include "PL111Lcd.h"\r
 \r
 \r
 #include "PL111Lcd.h"\r
 \r

-/** This file contains all the bits of the PL111 that are\r
-  platform independent.\r
+/** Check for presence of PL111.\r

 \r
 \r

+  @retval EFI_SUCCESS          Returns success if platform implements a\r
+                               PL111 controller.\r
+\r
+  @retval EFI_NOT_FOUND        PL111 display controller not found the plaform.\r

 **/\r
 EFI_STATUS\r
 LcdIdentify (\r
 **/\r
 EFI_STATUS\r
 LcdIdentify (\r


@@ -45,6 +49,12 @@ LcdIdentify (
   return EFI_NOT_FOUND;\r
 }\r
 \r
   return EFI_NOT_FOUND;\r
 }\r
 \r

+/** Initialize display.\r
+\r
+  @param[in]  VramBaseAddress    Address of the framebuffer.\r
+\r
+  @retval EFI_SUCCESS            Initialization of display successful.\r
+**/\r

 EFI_STATUS\r
 LcdInitialize (\r
   IN EFI_PHYSICAL_ADDRESS   VramBaseAddress\r
 EFI_STATUS\r
 LcdInitialize (\r
   IN EFI_PHYSICAL_ADDRESS   VramBaseAddress\r


@@ -60,6 +70,14 @@ LcdInitialize (
   return EFI_SUCCESS;\r
 }\r
 \r
   return EFI_SUCCESS;\r
 }\r
 \r

+/** Set requested mode of the display.\r
+\r
+  @param[in] ModeNumbe           Display mode number.\r
+\r
+  @retval EFI_SUCCESS            Display mode set successfuly.\r
+  @retval EFI_DEVICE_ERROR       It returns an error if display timing\r
+                                 information is not available.\r
+**/\r

 EFI_STATUS\r
 LcdSetMode (\r
   IN UINT32  ModeNumber\r
 EFI_STATUS\r
 LcdSetMode (\r
   IN UINT32  ModeNumber\r


@@ -130,6 +148,8 @@ LcdSetMode (
   return EFI_SUCCESS;\r
 }\r
 \r
   return EFI_SUCCESS;\r
 }\r
 \r

+/** De-initializes the display.\r
+*/\r

 VOID\r
 LcdShutdown (\r
   VOID\r
 VOID\r
 LcdShutdown (\r
   VOID\r