]> git.proxmox.com Git - mirror_edk2.git/blame - ArmPlatformPkg/Include/Library/LcdPlatformLib.h
ArmPlatformPkg: Tidy Lcd code: Updated comments
[mirror_edk2.git] / ArmPlatformPkg / Include / Library / LcdPlatformLib.h
CommitLineData
7d0f2f23 1/** @file\r
2\r
b1b69d26 3 Copyright (c) 2011-2018, ARM Ltd. All rights reserved.<BR>\r
7d0f2f23 4 This program and the accompanying materials\r
5 are licensed and made available under the terms and conditions of the BSD License\r
6 which accompanies this distribution. The full text of the license may be found at\r
7 http://opensource.org/licenses/bsd-license.php\r
8\r
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
11\r
12 **/\r
13\r
b1b69d26
GP
14#ifndef LCD_PLATFORM_LIB_H_\r
15#define LCD_PLATFORM_LIB_H_\r
7d0f2f23 16\r
17#include <Protocol/GraphicsOutput.h>\r
18\r
19#define LCD_VRAM_SIZE SIZE_8MB\r
20\r
7d0f2f23 21// Modes definitions\r
7d0f2f23 22#define VGA 0\r
23#define SVGA 1\r
24#define XGA 2\r
25#define SXGA 3\r
beeb44f4 26#define WSXGA 4\r
27#define UXGA 5\r
28#define HD 6\r
7d0f2f23 29\r
7d0f2f23 30// VGA Mode: 640 x 480\r
7d0f2f23 31#define VGA_H_RES_PIXELS 640\r
32#define VGA_V_RES_PIXELS 480\r
33#define VGA_OSC_FREQUENCY 23750000 /* 0x016A6570 */\r
34\r
35#define VGA_H_SYNC ( 80 - 1)\r
36#define VGA_H_FRONT_PORCH ( 16 - 1)\r
37#define VGA_H_BACK_PORCH ( 64 - 1)\r
38\r
39#define VGA_V_SYNC ( 4 - 1)\r
40#define VGA_V_FRONT_PORCH ( 3 - 1)\r
41#define VGA_V_BACK_PORCH ( 13 - 1)\r
42\r
7d0f2f23 43// SVGA Mode: 800 x 600\r
7d0f2f23 44#define SVGA_H_RES_PIXELS 800\r
45#define SVGA_V_RES_PIXELS 600\r
46#define SVGA_OSC_FREQUENCY 38250000 /* 0x0247A610 */\r
47\r
48#define SVGA_H_SYNC ( 80 - 1)\r
49#define SVGA_H_FRONT_PORCH ( 32 - 1)\r
50#define SVGA_H_BACK_PORCH (112 - 1)\r
51\r
52#define SVGA_V_SYNC ( 4 - 1)\r
53#define SVGA_V_FRONT_PORCH ( 3 - 1)\r
54#define SVGA_V_BACK_PORCH ( 17 - 1)\r
55\r
7d0f2f23 56// XGA Mode: 1024 x 768\r
7d0f2f23 57#define XGA_H_RES_PIXELS 1024\r
58#define XGA_V_RES_PIXELS 768\r
59#define XGA_OSC_FREQUENCY 63500000 /* 0x03C8EEE0 */\r
60\r
61#define XGA_H_SYNC (104 - 1)\r
62#define XGA_H_FRONT_PORCH ( 48 - 1)\r
63#define XGA_H_BACK_PORCH (152 - 1)\r
64\r
65#define XGA_V_SYNC ( 4 - 1)\r
66#define XGA_V_FRONT_PORCH ( 3 - 1)\r
67#define XGA_V_BACK_PORCH ( 23 - 1)\r
68\r
7d0f2f23 69// SXGA Mode: 1280 x 1024\r
7d0f2f23 70#define SXGA_H_RES_PIXELS 1280\r
71#define SXGA_V_RES_PIXELS 1024\r
72#define SXGA_OSC_FREQUENCY 109000000 /* 0x067F3540 */\r
73\r
74#define SXGA_H_SYNC (136 - 1)\r
75#define SXGA_H_FRONT_PORCH ( 80 - 1)\r
76#define SXGA_H_BACK_PORCH (216 - 1)\r
77\r
78#define SXGA_V_SYNC ( 7 - 1)\r
79#define SXGA_V_FRONT_PORCH ( 3 - 1)\r
80#define SXGA_V_BACK_PORCH ( 29 - 1)\r
81\r
beeb44f4 82// WSXGA+ Mode: 1680 x 1050\r
beeb44f4 83#define WSXGA_H_RES_PIXELS 1680\r
84#define WSXGA_V_RES_PIXELS 1050\r
85#define WSXGA_OSC_FREQUENCY 147000000 /* 0x08C30AC0 */\r
86\r
87#define WSXGA_H_SYNC (170 - 1)\r
88#define WSXGA_H_FRONT_PORCH (104 - 1)\r
89#define WSXGA_H_BACK_PORCH (274 - 1)\r
90\r
91#define WSXGA_V_SYNC ( 5 - 1)\r
92#define WSXGA_V_FRONT_PORCH ( 4 - 1)\r
93#define WSXGA_V_BACK_PORCH ( 41 - 1)\r
94\r
7d0f2f23 95// UXGA Mode: 1600 x 1200\r
7d0f2f23 96#define UXGA_H_RES_PIXELS 1600\r
97#define UXGA_V_RES_PIXELS 1200\r
98#define UXGA_OSC_FREQUENCY 161000000 /* 0x0998AA40 */\r
99\r
100#define UXGA_H_SYNC (168 - 1)\r
101#define UXGA_H_FRONT_PORCH (112 - 1)\r
102#define UXGA_H_BACK_PORCH (280 - 1)\r
103\r
104#define UXGA_V_SYNC ( 4 - 1)\r
105#define UXGA_V_FRONT_PORCH ( 3 - 1)\r
106#define UXGA_V_BACK_PORCH ( 38 - 1)\r
107\r
7d0f2f23 108// HD Mode: 1920 x 1080\r
7d0f2f23 109#define HD_H_RES_PIXELS 1920\r
110#define HD_V_RES_PIXELS 1080\r
deb8a061 111#define HD_OSC_FREQUENCY 165000000 /* 0x09D5B340 */\r
7d0f2f23 112\r
deb8a061 113#define HD_H_SYNC ( 79 - 1)\r
7d0f2f23 114#define HD_H_FRONT_PORCH (128 - 1)\r
115#define HD_H_BACK_PORCH (328 - 1)\r
116\r
117#define HD_V_SYNC ( 5 - 1)\r
118#define HD_V_FRONT_PORCH ( 3 - 1)\r
119#define HD_V_BACK_PORCH ( 32 - 1)\r
120\r
7d0f2f23 121// Colour Masks\r
7d0f2f23 122#define LCD_24BPP_RED_MASK 0x00FF0000\r
123#define LCD_24BPP_GREEN_MASK 0x0000FF00\r
124#define LCD_24BPP_BLUE_MASK 0x000000FF\r
125#define LCD_24BPP_RESERVED_MASK 0xFF000000\r
126\r
127#define LCD_16BPP_555_RED_MASK 0x00007C00\r
128#define LCD_16BPP_555_GREEN_MASK 0x000003E0\r
129#define LCD_16BPP_555_BLUE_MASK 0x0000001F\r
130#define LCD_16BPP_555_RESERVED_MASK 0x00000000\r
131\r
132#define LCD_16BPP_565_RED_MASK 0x0000F800\r
133#define LCD_16BPP_565_GREEN_MASK 0x000007E0\r
134#define LCD_16BPP_565_BLUE_MASK 0x0000001F\r
135#define LCD_16BPP_565_RESERVED_MASK 0x00008000\r
136\r
137#define LCD_12BPP_444_RED_MASK 0x00000F00\r
138#define LCD_12BPP_444_GREEN_MASK 0x000000F0\r
139#define LCD_12BPP_444_BLUE_MASK 0x0000000F\r
140#define LCD_12BPP_444_RESERVED_MASK 0x0000F000\r
141\r
4257dfaa 142/** The enumeration maps the PL111 LcdBpp values used in the LCD Control\r
b1b69d26
GP
143 Register\r
144**/\r
7d0f2f23 145typedef enum {\r
146 LCD_BITS_PER_PIXEL_1 = 0,\r
147 LCD_BITS_PER_PIXEL_2,\r
148 LCD_BITS_PER_PIXEL_4,\r
149 LCD_BITS_PER_PIXEL_8,\r
150 LCD_BITS_PER_PIXEL_16_555,\r
151 LCD_BITS_PER_PIXEL_24,\r
152 LCD_BITS_PER_PIXEL_16_565,\r
153 LCD_BITS_PER_PIXEL_12_444\r
154} LCD_BPP;\r
155\r
4257dfaa
GP
156/** Platform related initialization function.\r
157\r
158 @param[in] Handle Handle to the LCD device instance.\r
159\r
160 @retval EFI_SUCCESS Plaform library initialized successfully.\r
161 @retval !(EFI_SUCCESS) Other errors.\r
162**/\r
7d0f2f23 163EFI_STATUS\r
164LcdPlatformInitializeDisplay (\r
6d8d7363 165 IN EFI_HANDLE Handle\r
7d0f2f23 166 );\r
167\r
4257dfaa
GP
168/** Allocate VRAM memory in DRAM for the framebuffer\r
169 (unless it is reserved already).\r
170\r
171 The allocated address can be used to set the framebuffer.\r
172\r
173 @param[out] VramBaseAddress A pointer to the framebuffer address.\r
174 @param[out] VramSize A pointer to the size of the frame\r
175 buffer in bytes\r
176\r
177 @retval EFI_SUCCESS Frame buffer memory allocated successfully.\r
178 @retval !(EFI_SUCCESS) Other errors.\r
179**/\r
7d0f2f23 180EFI_STATUS\r
181LcdPlatformGetVram (\r
182 OUT EFI_PHYSICAL_ADDRESS* VramBaseAddress,\r
183 OUT UINTN* VramSize\r
184 );\r
185\r
4257dfaa
GP
186/** Return total number of modes supported.\r
187\r
188 Note: Valid mode numbers are 0 to MaxMode - 1\r
189 See Section 12.9 of the UEFI Specification 2.7\r
190\r
191 @retval UINT32 Mode Number.\r
192**/\r
7d0f2f23 193UINT32\r
194LcdPlatformGetMaxMode (\r
195 VOID\r
196 );\r
197\r
4257dfaa
GP
198/** Set the requested display mode.\r
199\r
200 @param[in] ModeNumber Mode Number.\r
201\r
202 @retval EFI_SUCCESS Mode set successfully.\r
203 @retval EFI_INVALID_PARAMETER Requested mode not found.\r
204 @retval !(EFI_SUCCESS) Other errors.\r
205**/\r
7d0f2f23 206EFI_STATUS\r
207LcdPlatformSetMode (\r
208 IN UINT32 ModeNumber\r
209 );\r
210\r
4257dfaa
GP
211/** Return information for the requested mode number.\r
212\r
213 @param[in] ModeNumber Mode Number.\r
214 @param[out] Info Pointer for returned mode information\r
215 (on success).\r
216\r
217 @retval EFI_SUCCESS Mode information for the requested mode\r
218 returned successfully.\r
219 @retval EFI_INVALID_PARAMETER Requested mode not found.\r
220**/\r
7d0f2f23 221EFI_STATUS\r
222LcdPlatformQueryMode (\r
223 IN UINT32 ModeNumber,\r
224 OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info\r
225 );\r
226\r
4257dfaa
GP
227/** Return display timing information for the requested mode number.\r
228\r
229 @param[in] ModeNumber Mode Number.\r
230\r
231 @param[out] HRes Pointer to horizontal resolution.\r
232 @param[out] HSync Pointer to horizontal sync width.\r
233 @param[out] HBackPorch Pointer to horizontal back porch.\r
234 @param[out] HFrontPorch Pointer to horizontal front porch.\r
235 @param[out] VRes Pointer to vertical resolution.\r
236 @param[out] VSync Pointer to vertical sync width.\r
237 @param[out] VBackPorch Pointer to vertical back porch.\r
238 @param[out] VFrontPorch Pointer to vertical front porch.\r
239\r
240 @retval EFI_SUCCESS Display timing information for the requested\r
241 mode returned successfully.\r
242 @retval EFI_INVALID_PARAMETER Requested mode not found.\r
243**/\r
7d0f2f23 244EFI_STATUS\r
245LcdPlatformGetTimings (\r
246 IN UINT32 ModeNumber,\r
247 OUT UINT32* HRes,\r
248 OUT UINT32* HSync,\r
249 OUT UINT32* HBackPorch,\r
250 OUT UINT32* HFrontPorch,\r
251 OUT UINT32* VRes,\r
252 OUT UINT32* VSync,\r
253 OUT UINT32* VBackPorch,\r
254 OUT UINT32* VFrontPorch\r
255 );\r
256\r
4257dfaa
GP
257/** Return bits per pixel information for a mode number.\r
258\r
259 @param[in] ModeNumber Mode Number.\r
260\r
261 @param[out] Bpp Pointer to value bits per pixel information.\r
262\r
263 @retval EFI_SUCCESS Bit per pixel information for the requested\r
264 mode returned successfully.\r
265 @retval EFI_INVALID_PARAMETER Requested mode not found.\r
266**/\r
7d0f2f23 267EFI_STATUS\r
268LcdPlatformGetBpp (\r
269 IN UINT32 ModeNumber,\r
270 OUT LCD_BPP* Bpp\r
271 );\r
272\r
b1b69d26 273#endif /* LCD_PLATFORM_LIB_H_ */\r