ArmPlatformPkg/Library/LcdPlatformNullLib/LcdPlatformNullLib.c

   1 /** @file
   2
   3   Copyright (c) 2017, Linaro, Ltd. All rights reserved.
   4   Copyright (c) 2018, Arm Limited. All rights reserved.
   5
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #include <Base.h>
  11 #include <Uefi/UefiBaseType.h>
  12 #include <Library/DebugLib.h>
  13 #include <Library/LcdPlatformLib.h>
  14
  15 /** Platform related initialization function.
  16
  17   @param[in] Handle              Handle to the LCD device instance.
  18
  19   @retval EFI_UNSUPPORTED        Interface is not supported.
  20 **/
  21 EFI_STATUS
  22 LcdPlatformInitializeDisplay (
  23   IN EFI_HANDLE  Handle
  24   )
  25 {
  26   ASSERT (FALSE);
  27   return EFI_UNSUPPORTED;
  28 }
  29
  30 /** Allocate VRAM memory in DRAM for the framebuffer
  31   (unless it is reserved already).
  32
  33   The allocated address can be used to set the framebuffer.
  34
  35   @param[out] VramBaseAddress      A pointer to the framebuffer address.
  36   @param[out] VramSize             A pointer to the size of the frame
  37                                    buffer in bytes
  38
  39   @retval EFI_UNSUPPORTED          Interface is not supported.
  40 **/
  41 EFI_STATUS
  42 LcdPlatformGetVram (
  43   OUT EFI_PHYSICAL_ADDRESS  *VramBaseAddress,
  44   OUT UINTN                 *VramSize
  45   )
  46 {
  47   ASSERT (FALSE);
  48   return EFI_UNSUPPORTED;
  49 }
  50
  51 /** Return total number of modes supported.
  52
  53   Note: Valid mode numbers are 0 to MaxMode - 1
  54   See Section 12.9 of the UEFI Specification 2.7
  55
  56   @retval UINT32             Zero number of modes supported
  57                              in a NULL library implementation.
  58 **/
  59 UINT32
  60 LcdPlatformGetMaxMode (
  61   VOID
  62   )
  63 {
  64   ASSERT (FALSE);
  65   return 0;
  66 }
  67
  68 /** Set the requested display mode.
  69
  70   @param[in] ModeNumber            Mode Number.
  71
  72   @retval EFI_UNSUPPORTED          Interface is not supported.
  73 **/
  74 EFI_STATUS
  75 LcdPlatformSetMode (
  76   IN UINT32  ModeNumber
  77   )
  78 {
  79   ASSERT (FALSE);
  80   return EFI_UNSUPPORTED;
  81 }
  82
  83 /** Return information for the requested mode number.
  84
  85   @param[in]  ModeNumber         Mode Number.
  86   @param[out] Info               Pointer for returned mode information
  87                                  (on success).
  88
  89   @retval EFI_UNSUPPORTED        Interface is not supported.
  90
  91 **/
  92 EFI_STATUS
  93 LcdPlatformQueryMode (
  94   IN  UINT32                                ModeNumber,
  95   OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION  *Info
  96   )
  97 {
  98   ASSERT (FALSE);
  99   return EFI_UNSUPPORTED;
 100 }
 101
 102 /** Return display timing information for the requested mode number.
 103
 104   @param[in]  ModeNumber          Mode Number.
 105
 106   @param[out] HRes                Pointer to horizontal resolution.
 107   @param[out] HSync               Pointer to horizontal sync width.
 108   @param[out] HBackPorch          Pointer to horizontal back porch.
 109   @param[out] HFrontPorch         Pointer to horizontal front porch.
 110   @param[out] VRes                Pointer to vertical resolution.
 111   @param[out] VSync               Pointer to vertical sync width.
 112   @param[out] VBackPorch          Pointer to vertical back porch.
 113   @param[out] VFrontPorch         Pointer to vertical front porch.
 114
 115   @retval EFI_UNSUPPORTED         Interface is not supported.
 116 **/
 117 EFI_STATUS
 118 LcdPlatformGetTimings (
 119   IN  UINT32        ModeNumber,
 120   OUT SCAN_TIMINGS  **Horizontal,
 121   OUT SCAN_TIMINGS  **Vertical
 122   )
 123 {
 124   ASSERT (FALSE);
 125   return EFI_UNSUPPORTED;
 126 }
 127
 128 /** Return bits per pixel information for a mode number.
 129
 130   @param[in]  ModeNumber          Mode Number.
 131
 132   @param[out] Bpp                 Pointer to value bits per pixel information.
 133
 134   @retval EFI_UNSUPPORTED         Interface is not supported.
 135
 136 **/
 137 EFI_STATUS
 138 LcdPlatformGetBpp (
 139   IN  UINT32   ModeNumber,
 140   OUT LCD_BPP  *Bpp
 141   )
 142 {
 143   ASSERT (FALSE);
 144   return EFI_UNSUPPORTED;
 145 }