]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ArmPlatformPkg/Library/HdLcd/HdLcd.c
ArmPlatformPkg: Tidy Lcd code: Updated comments
[mirror_edk2.git] / ArmPlatformPkg / Library / HdLcd / HdLcd.c
index 2cd1be9d255dd5734176d752d60f06f11a047fcb..be4ccfdc1f421060faec792c8e8acfcfb3232014 100644 (file)
@@ -1,4 +1,5 @@
 /** @file\r
+  This file contains the platform independent parts of HdLcd\r
 \r
   Copyright (c) 2011-2018, ARM Ltd. All rights reserved.<BR>\r
 \r
 \r
 #include "HdLcd.h"\r
 \r
-/** This file contains all the bits of the Lcd that are\r
-  platform independent.\r
-**/\r
-\r
 STATIC\r
 UINTN\r
 GetBytesPerPixel (\r
@@ -51,6 +48,12 @@ GetBytesPerPixel (
   }\r
 }\r
 \r
+/** Initialize display.\r
+\r
+  @param[in]  VramBaseAddress    Address of the framebuffer.\r
+\r
+  @retval EFI_SUCCESS            Display initialization successful.\r
+**/\r
 EFI_STATUS\r
 LcdInitialize (\r
   IN EFI_PHYSICAL_ADDRESS   VramBaseAddress\r
@@ -82,6 +85,14 @@ LcdInitialize (
   return EFI_SUCCESS;\r
 }\r
 \r
+/** Set requested mode of the display.\r
+\r
+  @param[in] ModeNumber          Display mode number.\r
+\r
+  @retval EFI_SUCCESS            Display mode set successfully.\r
+  @retval EFI_DEVICE_ERROR       Reurns an error if display timing\r
+                                 information is not available.\r
+**/\r
 EFI_STATUS\r
 LcdSetMode (\r
   IN UINT32  ModeNumber\r
@@ -150,6 +161,8 @@ LcdSetMode (
   return EFI_SUCCESS;\r
 }\r
 \r
+/** De-initializes the display.\r
+**/\r
 VOID\r
 LcdShutdown (\r
   VOID\r
@@ -159,6 +172,11 @@ LcdShutdown (
   MmioWrite32 (HDLCD_REG_COMMAND, HDLCD_DISABLE);\r
 }\r
 \r
+/** Check for presence of HDLCD.\r
+\r
+  @retval EFI_SUCCESS            Returns success if platform implements a HDLCD\r
+                                 controller.\r
+**/\r
 EFI_STATUS\r
 LcdIdentify (\r
   VOID\r