ArmPlatformPkg: Add support for PL111 Lcd driver

This driver implements the interface for the PL111 Lcd controller.
The LcdPlatformLib allows to set the platform specific requirements
needed by the platform for setting the LCD (oscillators, etc).

ArmPlatformPkg/ArmVExpressPkg: Implement LcdPlatformLib

This library exports the supported resolutions. It also allocates the
memory for the framebuffer and send the correct settings to the VExpress
motherboard microcontroller.



git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11786 6f19259b-4bc3-4df7-8a09-765794883524

2 files changed, 347 insertions, 0 deletions

diff --git a/ArmPlatformPkg/Include/Drivers/PL111Lcd.h b/ArmPlatformPkg/Include/Drivers/PL111Lcd.h
new file mode 100644
index 0000000000..80d563976d
--- /dev/null
+++ b/ArmPlatformPkg/Include/Drivers/PL111Lcd.h
@@ -0,0 +1,142 @@
+/** @file  PL111Lcd.h
+
+ Copyright (c) 2011, ARM Ltd. All rights reserved.<BR>
+ This program and the accompanying materials
+ are licensed and made available under the terms and conditions of the BSD License
+ which accompanies this distribution.  The full text of the license may be found at
+ http://opensource.org/licenses/bsd-license.php
+
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+ **/
+
+#ifndef _PL111LCD_H__
+#define _PL111LCD_H__
+
+#include <ArmPlatform.h>
+
+/**********************************************************************
+ *
+ *  This header file contains all the bits of the PL111 that are
+ *  platform independent.
+ *
+ **********************************************************************/
+
+// Controller Register Offsets
+#define PL111_REG_LCD_TIMING_0            (PL111_CLCD_BASE + 0x000)
+#define PL111_REG_LCD_TIMING_1            (PL111_CLCD_BASE + 0x004)
+#define PL111_REG_LCD_TIMING_2            (PL111_CLCD_BASE + 0x008)
+#define PL111_REG_LCD_TIMING_3            (PL111_CLCD_BASE + 0x00C)
+#define PL111_REG_LCD_UP_BASE             (PL111_CLCD_BASE + 0x010)
+#define PL111_REG_LCD_LP_BASE             (PL111_CLCD_BASE + 0x014)
+#define PL111_REG_LCD_CONTROL             (PL111_CLCD_BASE + 0x018)
+#define PL111_REG_LCD_IMSC                (PL111_CLCD_BASE + 0x01C)
+#define PL111_REG_LCD_RIS                 (PL111_CLCD_BASE + 0x020)
+#define PL111_REG_LCD_MIS                 (PL111_CLCD_BASE + 0x024)
+#define PL111_REG_LCD_ICR                 (PL111_CLCD_BASE + 0x028)
+#define PL111_REG_LCD_UP_CURR             (PL111_CLCD_BASE + 0x02C)
+#define PL111_REG_LCD_LP_CURR             (PL111_CLCD_BASE + 0x030)
+#define PL111_REG_LCD_PALETTE             (PL111_CLCD_BASE + 0x200)
+
+// Identification Register Offsets
+#define PL111_REG_CLCD_PERIPH_ID_0        (PL111_CLCD_BASE + 0xFE0)
+#define PL111_REG_CLCD_PERIPH_ID_1        (PL111_CLCD_BASE + 0xFE4)
+#define PL111_REG_CLCD_PERIPH_ID_2        (PL111_CLCD_BASE + 0xFE8)
+#define PL111_REG_CLCD_PERIPH_ID_3        (PL111_CLCD_BASE + 0xFEC)
+#define PL111_REG_CLCD_P_CELL_ID_0        (PL111_CLCD_BASE + 0xFF0)
+#define PL111_REG_CLCD_P_CELL_ID_1        (PL111_CLCD_BASE + 0xFF4)
+#define PL111_REG_CLCD_P_CELL_ID_2        (PL111_CLCD_BASE + 0xFF8)
+#define PL111_REG_CLCD_P_CELL_ID_3        (PL111_CLCD_BASE + 0xFFC)
+
+/**********************************************************************/
+
+// Register components (register bits)
+
+// This should make life easier to program specific settings in the different registers
+// by simplifying the setting up of the individual bits of each register
+// and then assembling the final register value.
+
+/**********************************************************************/
+
+// Register: PL111_REG_LCD_TIMING_0
+#define HOR_AXIS_PANEL(hbp,hfp,hsw,hor_res) (UINT32)(((UINT32)(hbp) << 24) | ((UINT32)(hfp) << 16) | ((UINT32)(hsw) << 8) | (((UINT32)((hor_res)/16)-1) << 2))
+
+// Register: PL111_REG_LCD_TIMING_1
+#define VER_AXIS_PANEL(vbp,vfp,vsw,ver_res) (UINT32)(((UINT32)(vbp) << 24) | ((UINT32)(vfp) << 16) | ((UINT32)(vsw) << 10) | ((ver_res)-1))
+
+// Register: PL111_REG_LCD_TIMING_2
+#define PL111_BIT_SHIFT_PCD_HI            27
+#define PL111_BIT_SHIFT_BCD               26
+#define PL111_BIT_SHIFT_CPL               16
+#define PL111_BIT_SHIFT_IOE               14
+#define PL111_BIT_SHIFT_IPC               13
+#define PL111_BIT_SHIFT_IHS               12
+#define PL111_BIT_SHIFT_IVS               11
+#define PL111_BIT_SHIFT_ACB               6
+#define PL111_BIT_SHIFT_CLKSEL            5
+#define PL111_BIT_SHIFT_PCD_LO            0
+
+#define PL111_BCD                         (1 << 26)
+#define PL111_IPC                         (1 << 13)
+#define PL111_IHS                         (1 << 12)
+#define PL111_IVS                         (1 << 11)
+
+#define CLK_SIG_POLARITY(hor_res)         (UINT32)(PL111_BCD | PL111_IPC | PL111_IHS | PL111_IVS | (((hor_res)-1) << 16))
+
+// Register: PL111_REG_LCD_TIMING_3
+#define PL111_BIT_SHIFT_LEE               16
+#define PL111_BIT_SHIFT_LED               0
+
+#define PL111_CTRL_WATERMARK              (1 << 16)
+#define PL111_CTRL_LCD_V_COMP             (1 << 12)
+#define PL111_CTRL_LCD_PWR                (1 << 11)
+#define PL111_CTRL_BEPO                   (1 << 10)
+#define PL111_CTRL_BEBO                   (1 << 9)
+#define PL111_CTRL_BGR                    (1 << 8)
+#define PL111_CTRL_LCD_DUAL               (1 << 7)
+#define PL111_CTRL_LCD_MONO_8             (1 << 6)
+#define PL111_CTRL_LCD_TFT                (1 << 5)
+#define PL111_CTRL_LCD_BW                 (1 << 4)
+#define PL111_CTRL_LCD_1BPP               (0 << 1)
+#define PL111_CTRL_LCD_2BPP               (1 << 1)
+#define PL111_CTRL_LCD_4BPP               (2 << 1)
+#define PL111_CTRL_LCD_8BPP               (3 << 1)
+#define PL111_CTRL_LCD_16BPP              (4 << 1)
+#define PL111_CTRL_LCD_24BPP              (5 << 1)
+#define PL111_CTRL_LCD_16BPP_565          (6 << 1)
+#define PL111_CTRL_LCD_12BPP_444          (7 << 1)
+#define PL111_CTRL_LCD_BPP(Bpp)           ((Bpp) << 1)
+#define PL111_CTRL_LCD_EN                 1
+
+/**********************************************************************/
+
+// Register: PL111_REG_LCD_TIMING_0
+#define PL111_LCD_TIMING_0_HBP(hbp)       (((hbp) & 0xFF) << 24)
+#define PL111_LCD_TIMING_0_HFP(hfp)       (((hfp) & 0xFF) << 16)
+#define PL111_LCD_TIMING_0_HSW(hsw)       (((hsw) & 0xFF) << 8)
+#define PL111_LCD_TIMING_0_PPL(ppl)       (((hsw) & 0x3F) << 2)
+
+// Register: PL111_REG_LCD_TIMING_1
+#define PL111_LCD_TIMING_1_VBP(vbp)       (((vbp) & 0xFF) << 24)
+#define PL111_LCD_TIMING_1_VFP(vfp)       (((vfp) & 0xFF) << 16)
+#define PL111_LCD_TIMING_1_VSW(vsw)       (((vsw) & 0x3F) << 10)
+#define PL111_LCD_TIMING_1_LPP(lpp)        ((lpp) & 0xFC)
+
+// Register: PL111_REG_LCD_TIMING_2
+#define PL111_BIT_MASK_PCD_HI             0xF8000000
+#define PL111_BIT_MASK_BCD                0x04000000
+#define PL111_BIT_MASK_CPL                0x03FF0000
+#define PL111_BIT_MASK_IOE                0x00004000
+#define PL111_BIT_MASK_IPC                0x00002000
+#define PL111_BIT_MASK_IHS                0x00001000
+#define PL111_BIT_MASK_IVS                0x00000800
+#define PL111_BIT_MASK_ACB                0x000007C0
+#define PL111_BIT_MASK_CLKSEL             0x00000020
+#define PL111_BIT_MASK_PCD_LO             0x0000001F
+
+// Register: PL111_REG_LCD_TIMING_3
+#define PL111_BIT_MASK_LEE                0x00010000
+#define PL111_BIT_MASK_LED                0x0000007F
+
+#endif /* _PL111LCD_H__ */
diff --git a/ArmPlatformPkg/Include/Library/LcdPlatformLib.h b/ArmPlatformPkg/Include/Library/LcdPlatformLib.h
new file mode 100644
index 0000000000..93afa6322e
--- /dev/null
+++ b/ArmPlatformPkg/Include/Library/LcdPlatformLib.h
@@ -0,0 +1,205 @@
+/** @file

+

+ Copyright (c) 2011, ARM Ltd. All rights reserved.<BR>

+ This program and the accompanying materials

+ are licensed and made available under the terms and conditions of the BSD License

+ which accompanies this distribution.  The full text of the license may be found at

+ http://opensource.org/licenses/bsd-license.php

+

+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+ **/

+

+#ifndef __LCDPLATFORMLIB_H

+#define __LCDPLATFORMLIB_H

+

+#include <Protocol/GraphicsOutput.h>

+

+#define LCD_VRAM_SIZE                     SIZE_8MB

+

+//

+// Modes definitions

+//

+#define VGA                               0

+#define SVGA                              1

+#define XGA                               2

+#define SXGA                              3

+#define UXGA                              4

+#define HD                                5

+

+//

+// VGA Mode: 640 x 480

+//

+#define VGA_H_RES_PIXELS                  640

+#define VGA_V_RES_PIXELS                  480

+#define VGA_OSC_FREQUENCY                 23750000  /* 0x016A6570 */

+

+#define VGA_H_SYNC                        ( 80 - 1)

+#define VGA_H_FRONT_PORCH                 ( 16 - 1)

+#define VGA_H_BACK_PORCH                  ( 64 - 1)

+

+#define VGA_V_SYNC                        (  4 - 1)

+#define VGA_V_FRONT_PORCH                 (  3 - 1)

+#define VGA_V_BACK_PORCH                  ( 13 - 1)

+

+//

+// SVGA Mode: 800 x 600

+//

+#define SVGA_H_RES_PIXELS                 800

+#define SVGA_V_RES_PIXELS                 600

+#define SVGA_OSC_FREQUENCY                38250000  /* 0x0247A610 */

+

+#define SVGA_H_SYNC                       ( 80 - 1)

+#define SVGA_H_FRONT_PORCH                ( 32 - 1)

+#define SVGA_H_BACK_PORCH                 (112 - 1)

+

+#define SVGA_V_SYNC                       (  4 - 1)

+#define SVGA_V_FRONT_PORCH                (  3 - 1)

+#define SVGA_V_BACK_PORCH                 ( 17 - 1)

+

+//

+// XGA Mode: 1024 x 768

+//

+#define XGA_H_RES_PIXELS                  1024

+#define XGA_V_RES_PIXELS                  768

+#define XGA_OSC_FREQUENCY                 63500000  /* 0x03C8EEE0 */

+

+#define XGA_H_SYNC                        (104 - 1)

+#define XGA_H_FRONT_PORCH                 ( 48 - 1)

+#define XGA_H_BACK_PORCH                  (152 - 1)

+

+#define XGA_V_SYNC                        (  4 - 1)

+#define XGA_V_FRONT_PORCH                 (  3 - 1)

+#define XGA_V_BACK_PORCH                  ( 23 - 1)

+

+//

+// SXGA Mode: 1280 x 1024

+//

+#define SXGA_H_RES_PIXELS                 1280

+#define SXGA_V_RES_PIXELS                 1024

+#define SXGA_OSC_FREQUENCY                109000000  /* 0x067F3540 */

+

+#define SXGA_H_SYNC                       (136 - 1)

+#define SXGA_H_FRONT_PORCH                ( 80 - 1)

+#define SXGA_H_BACK_PORCH                 (216 - 1)

+

+#define SXGA_V_SYNC                       (  7 - 1)

+#define SXGA_V_FRONT_PORCH                (  3 - 1)

+#define SXGA_V_BACK_PORCH                 ( 29 - 1)

+

+//

+// UXGA Mode: 1600 x 1200

+//

+#define UXGA_H_RES_PIXELS                 1600

+#define UXGA_V_RES_PIXELS                 1200

+#define UXGA_OSC_FREQUENCY                161000000  /* 0x0998AA40 */

+

+#define UXGA_H_SYNC                       (168 - 1)

+#define UXGA_H_FRONT_PORCH                (112 - 1)

+#define UXGA_H_BACK_PORCH                 (280 - 1)

+

+#define UXGA_V_SYNC                       (  4 - 1)

+#define UXGA_V_FRONT_PORCH                (  3 - 1)

+#define UXGA_V_BACK_PORCH                 ( 38 - 1)

+

+//

+// HD Mode: 1920 x 1080

+//

+#define HD_H_RES_PIXELS                   1920

+#define HD_V_RES_PIXELS                   1080

+#define HD_OSC_FREQUENCY                  173000000  /* 0x0A4FC540 */

+

+#define HD_H_SYNC                         (200 - 1)

+#define HD_H_FRONT_PORCH                  (128 - 1)

+#define HD_H_BACK_PORCH                   (328 - 1)

+

+#define HD_V_SYNC                         (  5 - 1)

+#define HD_V_FRONT_PORCH                  (  3 - 1)

+#define HD_V_BACK_PORCH                   ( 32 - 1)

+

+//

+// Colour Masks

+//

+

+#define LCD_24BPP_RED_MASK              0x00FF0000

+#define LCD_24BPP_GREEN_MASK            0x0000FF00

+#define LCD_24BPP_BLUE_MASK             0x000000FF

+#define LCD_24BPP_RESERVED_MASK         0xFF000000

+

+#define LCD_16BPP_555_RED_MASK          0x00007C00

+#define LCD_16BPP_555_GREEN_MASK        0x000003E0

+#define LCD_16BPP_555_BLUE_MASK         0x0000001F

+#define LCD_16BPP_555_RESERVED_MASK     0x00000000

+

+#define LCD_16BPP_565_RED_MASK          0x0000F800

+#define LCD_16BPP_565_GREEN_MASK        0x000007E0

+#define LCD_16BPP_565_BLUE_MASK         0x0000001F

+#define LCD_16BPP_565_RESERVED_MASK     0x00008000

+

+#define LCD_12BPP_444_RED_MASK          0x00000F00

+#define LCD_12BPP_444_GREEN_MASK        0x000000F0

+#define LCD_12BPP_444_BLUE_MASK         0x0000000F

+#define LCD_12BPP_444_RESERVED_MASK     0x0000F000

+

+

+// The enumeration indexes maps the PL111 LcdBpp values used in the LCD Control Register

+typedef enum {

+  LCD_BITS_PER_PIXEL_1 = 0,

+  LCD_BITS_PER_PIXEL_2,

+  LCD_BITS_PER_PIXEL_4,

+  LCD_BITS_PER_PIXEL_8,

+  LCD_BITS_PER_PIXEL_16_555,

+  LCD_BITS_PER_PIXEL_24,

+  LCD_BITS_PER_PIXEL_16_565,

+  LCD_BITS_PER_PIXEL_12_444

+} LCD_BPP;

+

+

+EFI_STATUS

+LcdPlatformInitializeDisplay (

+  VOID

+  );

+

+EFI_STATUS

+LcdPlatformGetVram (

+  OUT EFI_PHYSICAL_ADDRESS*                 VramBaseAddress,

+  OUT UINTN*                                VramSize

+  );

+

+UINT32

+LcdPlatformGetMaxMode (

+  VOID

+  );

+

+EFI_STATUS

+LcdPlatformSetMode (

+  IN UINT32                                 ModeNumber

+  );

+

+EFI_STATUS

+LcdPlatformQueryMode (

+  IN  UINT32                                ModeNumber,

+  OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION  *Info

+  );

+

+EFI_STATUS

+LcdPlatformGetTimings (

+  IN  UINT32                              ModeNumber,

+  OUT UINT32*                             HRes,

+  OUT UINT32*                             HSync,

+  OUT UINT32*                             HBackPorch,

+  OUT UINT32*                             HFrontPorch,

+  OUT UINT32*                             VRes,

+  OUT UINT32*                             VSync,

+  OUT UINT32*                             VBackPorch,

+  OUT UINT32*                             VFrontPorch

+  );

+

+EFI_STATUS

+LcdPlatformGetBpp (

+  IN  UINT32                                ModeNumber,

+  OUT LCD_BPP*                              Bpp

+  );

+

+#endif