2 * Common LCD routines for supported CPUs
4 * (C) Copyright 2001-2002
5 * Wolfgang Denk, DENX Software Engineering -- wd@denx.de
7 * SPDX-License-Identifier: GPL-2.0+
10 /************************************************************************/
12 /************************************************************************/
19 #include <env_callback.h>
20 #include <linux/types.h>
21 #include <stdio_dev.h>
24 #include <asm/unaligned.h>
27 #include <asm/unaligned.h>
28 #include <fdt_support.h>
30 #if defined(CONFIG_LCD_DT_SIMPLEFB)
34 /************************************************************************/
36 /************************************************************************/
37 #include <video_font.h> /* Get font data, width and height */
39 /************************************************************************/
41 /************************************************************************/
42 #ifdef CONFIG_LCD_LOGO
43 # include <bmp_logo.h> /* Get logo data, width and height */
44 # include <bmp_logo_data.h>
45 # if (CONSOLE_COLOR_WHITE >= BMP_LOGO_OFFSET) && (LCD_BPP != LCD_COLOR16)
46 # error Default Color Map overlaps with Logo Color Map
54 #ifndef CONFIG_LCD_ALIGNMENT
55 #define CONFIG_LCD_ALIGNMENT PAGE_SIZE
58 #if (LCD_BPP != LCD_COLOR8) && (LCD_BPP != LCD_COLOR16) && \
59 (LCD_BPP != LCD_COLOR32)
60 # error Unsupported LCD BPP.
63 DECLARE_GLOBAL_DATA_PTR;
65 static int lcd_init(void *lcdbase);
67 static void *lcd_logo(void);
69 static void lcd_setfgcolor(int color);
70 static void lcd_setbgcolor(int color);
72 static int lcd_color_fg;
73 static int lcd_color_bg;
76 char lcd_is_enabled = 0;
78 static void *lcd_base; /* Start of framebuffer memory */
80 static char lcd_flush_dcache; /* 1 to flush dcache after each lcd update */
82 /************************************************************************/
84 /* Flush LCD activity to the caches */
88 * flush_dcache_range() is declared in common.h but it seems that some
89 * architectures do not actually implement it. Is there a way to find
90 * out whether it exists? For now, ARM is safe.
92 #if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
96 flush_dcache_range((u32)lcd_base,
97 (u32)(lcd_base + lcd_get_size(&line_length)));
98 #elif defined(CONFIG_SANDBOX) && defined(CONFIG_VIDEO_SANDBOX_SDL)
99 static ulong last_sync;
101 if (get_timer(last_sync) > 10) {
102 sandbox_sdl_sync(lcd_base);
103 last_sync = get_timer(0);
108 void lcd_set_flush_dcache(int flush)
110 lcd_flush_dcache = (flush != 0);
113 /*----------------------------------------------------------------------*/
115 static void lcd_stub_putc(struct stdio_dev *dev, const char c)
120 static void lcd_stub_puts(struct stdio_dev *dev, const char *s)
125 /************************************************************************/
126 /** Small utility to check that you got the colours right */
127 /************************************************************************/
128 #ifdef LCD_TEST_PATTERN
133 static int test_colors[N_BLK_HOR * N_BLK_VERT] = {
134 CONSOLE_COLOR_RED, CONSOLE_COLOR_GREEN, CONSOLE_COLOR_YELLOW,
135 CONSOLE_COLOR_BLUE, CONSOLE_COLOR_MAGENTA, CONSOLE_COLOR_CYAN,
138 static void test_pattern(void)
140 ushort v_max = panel_info.vl_row;
141 ushort h_max = panel_info.vl_col;
142 ushort v_step = (v_max + N_BLK_VERT - 1) / N_BLK_VERT;
143 ushort h_step = (h_max + N_BLK_HOR - 1) / N_BLK_HOR;
145 uchar *pix = (uchar *)lcd_base;
147 printf("[LCD] Test Pattern: %d x %d [%d x %d]\n",
148 h_max, v_max, h_step, v_step);
150 /* WARNING: Code silently assumes 8bit/pixel */
151 for (v = 0; v < v_max; ++v) {
152 uchar iy = v / v_step;
153 for (h = 0; h < h_max; ++h) {
154 uchar ix = N_BLK_HOR * iy + h / h_step;
155 *pix++ = test_colors[ix];
159 #endif /* LCD_TEST_PATTERN */
162 /************************************************************************/
163 /* ** GENERIC Initialization Routines */
164 /************************************************************************/
166 * With most lcd drivers the line length is set up
167 * by calculating it from panel_info parameters. Some
168 * drivers need to calculate the line length differently,
169 * so make the function weak to allow overriding it.
171 __weak int lcd_get_size(int *line_length)
173 *line_length = (panel_info.vl_col * NBITS(panel_info.vl_bpix)) / 8;
174 return *line_length * panel_info.vl_row;
177 int drv_lcd_init(void)
179 struct stdio_dev lcddev;
182 lcd_base = map_sysmem(gd->fb_base, 0);
184 lcd_init(lcd_base); /* LCD initialization */
186 /* Device initialization */
187 memset(&lcddev, 0, sizeof(lcddev));
189 strcpy(lcddev.name, "lcd");
190 lcddev.ext = 0; /* No extensions */
191 lcddev.flags = DEV_FLAGS_OUTPUT; /* Output only */
192 lcddev.putc = lcd_stub_putc; /* 'putc' function */
193 lcddev.puts = lcd_stub_puts; /* 'puts' function */
195 rc = stdio_register(&lcddev);
197 return (rc == 0) ? 1 : rc;
200 /*----------------------------------------------------------------------*/
203 short console_rows, console_cols;
205 #if LCD_BPP == LCD_COLOR8
206 /* Setting the palette */
207 lcd_setcolreg(CONSOLE_COLOR_BLACK, 0, 0, 0);
208 lcd_setcolreg(CONSOLE_COLOR_RED, 0xFF, 0, 0);
209 lcd_setcolreg(CONSOLE_COLOR_GREEN, 0, 0xFF, 0);
210 lcd_setcolreg(CONSOLE_COLOR_YELLOW, 0xFF, 0xFF, 0);
211 lcd_setcolreg(CONSOLE_COLOR_BLUE, 0, 0, 0xFF);
212 lcd_setcolreg(CONSOLE_COLOR_MAGENTA, 0xFF, 0, 0xFF);
213 lcd_setcolreg(CONSOLE_COLOR_CYAN, 0, 0xFF, 0xFF);
214 lcd_setcolreg(CONSOLE_COLOR_GREY, 0xAA, 0xAA, 0xAA);
215 lcd_setcolreg(CONSOLE_COLOR_WHITE, 0xFF, 0xFF, 0xFF);
218 #ifndef CONFIG_SYS_WHITE_ON_BLACK
219 lcd_setfgcolor(CONSOLE_COLOR_BLACK);
220 lcd_setbgcolor(CONSOLE_COLOR_WHITE);
221 bg_color = CONSOLE_COLOR_WHITE;
223 lcd_setfgcolor(CONSOLE_COLOR_WHITE);
224 lcd_setbgcolor(CONSOLE_COLOR_BLACK);
225 bg_color = CONSOLE_COLOR_BLACK;
226 #endif /* CONFIG_SYS_WHITE_ON_BLACK */
228 #ifdef LCD_TEST_PATTERN
231 /* set framebuffer to background color */
232 #if (LCD_BPP != LCD_COLOR32)
233 memset((char *)lcd_base, bg_color, lcd_line_length * panel_info.vl_row);
235 u32 *ppix = lcd_base;
238 i < (lcd_line_length * panel_info.vl_row)/NBYTES(panel_info.vl_bpix);
244 /* Paint the logo and retrieve LCD base address */
245 debug("[LCD] Drawing the logo...\n");
246 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
247 console_rows = (panel_info.vl_row - BMP_LOGO_HEIGHT);
248 console_rows /= VIDEO_FONT_HEIGHT;
250 console_rows = panel_info.vl_row / VIDEO_FONT_HEIGHT;
252 console_cols = panel_info.vl_col / VIDEO_FONT_WIDTH;
253 lcd_init_console(lcd_base, console_rows, console_cols);
254 lcd_init_console(lcd_logo(), console_rows, console_cols);
258 static int do_lcd_clear(cmd_tbl_t *cmdtp, int flag, int argc,
266 cls, 1, 1, do_lcd_clear,
271 /*----------------------------------------------------------------------*/
273 static int lcd_init(void *lcdbase)
275 /* Initialize the lcd controller */
276 debug("[LCD] Initializing LCD frambuffer at %p\n", lcdbase);
278 lcd_ctrl_init(lcdbase);
281 * lcd_ctrl_init() of some drivers (i.e. bcm2835 on rpi) ignores
282 * the 'lcdbase' argument and uses custom lcd base address
283 * by setting up gd->fb_base. Check for this condition and fixup
284 * 'lcd_base' address.
286 if (map_to_sysmem(lcdbase) != gd->fb_base)
287 lcd_base = map_sysmem(gd->fb_base, 0);
289 debug("[LCD] Using LCD frambuffer at %p\n", lcd_base);
291 lcd_get_size(&lcd_line_length);
296 /* Initialize the console */
298 #ifdef CONFIG_LCD_INFO_BELOW_LOGO
299 lcd_set_row(7 + BMP_LOGO_HEIGHT / VIDEO_FONT_HEIGHT);
301 lcd_set_row(1); /* leave 1 blank line below logo */
308 /************************************************************************/
309 /* ** ROM capable initialization part - needed to reserve FB memory */
310 /************************************************************************/
312 * This is called early in the system initialization to grab memory
313 * for the LCD controller.
314 * Returns new address for monitor, after reserving LCD buffer memory
316 * Note that this is running from ROM, so no write access to global data.
318 ulong lcd_setmem(ulong addr)
323 debug("LCD panel info: %d x %d, %d bit/pix\n", panel_info.vl_col,
324 panel_info.vl_row, NBITS(panel_info.vl_bpix));
326 size = lcd_get_size(&line_length);
328 /* Round up to nearest full page, or MMU section if defined */
329 size = ALIGN(size, CONFIG_LCD_ALIGNMENT);
330 addr = ALIGN(addr - CONFIG_LCD_ALIGNMENT + 1, CONFIG_LCD_ALIGNMENT);
332 /* Allocate pages for the frame buffer. */
335 debug("Reserving %ldk for LCD Framebuffer at: %08lx\n",
341 /*----------------------------------------------------------------------*/
343 static void lcd_setfgcolor(int color)
345 lcd_color_fg = color;
348 int lcd_getfgcolor(void)
353 /*----------------------------------------------------------------------*/
355 static void lcd_setbgcolor(int color)
357 lcd_color_bg = color;
360 int lcd_getbgcolor(void)
365 /************************************************************************/
366 /* ** Chipset depending Bitmap / Logo stuff... */
367 /************************************************************************/
369 #ifdef CONFIG_LCD_LOGO
370 __weak void lcd_logo_set_cmap(void)
373 ushort *cmap = configuration_get_cmap();
375 for (i = 0; i < ARRAY_SIZE(bmp_logo_palette); ++i)
376 *cmap++ = bmp_logo_palette[i];
379 void bitmap_plot(int x, int y)
385 unsigned bpix = NBITS(panel_info.vl_bpix);
387 debug("Logo: width %d height %d colors %d\n",
388 BMP_LOGO_WIDTH, BMP_LOGO_HEIGHT, BMP_LOGO_COLORS);
390 bmap = &bmp_logo_bitmap[0];
391 fb = (uchar *)(lcd_base + y * lcd_line_length + x * bpix / 8);
398 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
399 memcpy(fb, bmap, BMP_LOGO_WIDTH);
400 bmap += BMP_LOGO_WIDTH;
401 fb += panel_info.vl_col;
404 else { /* true color mode */
407 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
408 for (j = 0; j < BMP_LOGO_WIDTH; j++) {
409 col16 = bmp_logo_palette[(bmap[j]-16)];
411 ((col16 & 0x000F) << 1) |
412 ((col16 & 0x00F0) << 3) |
413 ((col16 & 0x0F00) << 4);
415 bmap += BMP_LOGO_WIDTH;
416 fb16 += panel_info.vl_col;
424 static inline void bitmap_plot(int x, int y) {}
425 #endif /* CONFIG_LCD_LOGO */
427 /*----------------------------------------------------------------------*/
428 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
430 * Display the BMP file located at address bmp_image.
434 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
435 #define BMP_ALIGN_CENTER 0x7FFF
437 static void splash_align_axis(int *axis, unsigned long panel_size,
438 unsigned long picture_size)
440 unsigned long panel_picture_delta = panel_size - picture_size;
441 unsigned long axis_alignment;
443 if (*axis == BMP_ALIGN_CENTER)
444 axis_alignment = panel_picture_delta / 2;
446 axis_alignment = panel_picture_delta + *axis + 1;
450 *axis = max(0, (int)axis_alignment);
455 #ifdef CONFIG_LCD_BMP_RLE8
457 #define BMP_RLE8_ESCAPE 0
458 #define BMP_RLE8_EOL 0
459 #define BMP_RLE8_EOBMP 1
460 #define BMP_RLE8_DELTA 2
462 static void draw_unencoded_bitmap(ushort **fbp, uchar *bmap, ushort *cmap,
466 *(*fbp)++ = cmap[*bmap++];
471 static void draw_encoded_bitmap(ushort **fbp, ushort c, int cnt)
474 int cnt_8copy = cnt >> 3;
476 cnt -= cnt_8copy << 3;
477 while (cnt_8copy > 0) {
496 * Do not call this function directly, must be called from lcd_display_bitmap.
498 static void lcd_display_rle8_bitmap(bmp_image_t *bmp, ushort *cmap, uchar *fb,
499 int x_off, int y_off)
507 width = get_unaligned_le32(&bmp->header.width);
508 height = get_unaligned_le32(&bmp->header.height);
509 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
515 if (bmap[0] == BMP_RLE8_ESCAPE) {
522 /* 16bpix, 2-byte per pixel, width should *2 */
523 fb -= (width * 2 + lcd_line_length);
533 /* 16bpix, 2-byte per pixel, x should *2 */
534 fb = (uchar *) (lcd_base + (y + y_off - 1)
535 * lcd_line_length + (x + x_off) * 2);
544 if (x + runlen > width)
548 draw_unencoded_bitmap(
563 /* aggregate the same code */
564 while (bmap[0] == 0xff &&
565 bmap[2] != BMP_RLE8_ESCAPE &&
566 bmap[1] == bmap[3]) {
570 if (x + runlen > width)
574 draw_encoded_bitmap((ushort **)&fb,
585 __weak void fb_put_byte(uchar **fb, uchar **from)
587 *(*fb)++ = *(*from)++;
590 #if defined(CONFIG_BMP_16BPP)
591 __weak void fb_put_word(uchar **fb, uchar **from)
593 *(*fb)++ = *(*from)++;
594 *(*fb)++ = *(*from)++;
596 #endif /* CONFIG_BMP_16BPP */
598 __weak void lcd_set_cmap(bmp_image_t *bmp, unsigned colors)
601 bmp_color_table_entry_t cte;
602 ushort *cmap = configuration_get_cmap();
604 for (i = 0; i < colors; ++i) {
605 cte = bmp->color_table[i];
606 *cmap = (((cte.red) << 8) & 0xf800) |
607 (((cte.green) << 3) & 0x07e0) |
608 (((cte.blue) >> 3) & 0x001f);
609 #if defined(CONFIG_MPC823)
617 int lcd_display_bitmap(ulong bmp_image, int x, int y)
619 ushort *cmap_base = NULL;
622 bmp_image_t *bmp = (bmp_image_t *)map_sysmem(bmp_image, 0);
625 unsigned long width, height, byte_width;
626 unsigned long pwidth = panel_info.vl_col;
627 unsigned colors, bpix, bmp_bpix;
629 if (!bmp || !(bmp->header.signature[0] == 'B' &&
630 bmp->header.signature[1] == 'M')) {
631 printf("Error: no valid bmp image at %lx\n", bmp_image);
636 width = get_unaligned_le32(&bmp->header.width);
637 height = get_unaligned_le32(&bmp->header.height);
638 bmp_bpix = get_unaligned_le16(&bmp->header.bit_count);
640 colors = 1 << bmp_bpix;
642 bpix = NBITS(panel_info.vl_bpix);
644 if (bpix != 1 && bpix != 8 && bpix != 16 && bpix != 32) {
645 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
652 * We support displaying 8bpp BMPs on 16bpp LCDs
653 * and displaying 24bpp BMPs on 32bpp LCDs
655 if (bpix != bmp_bpix &&
656 !(bmp_bpix == 8 && bpix == 16) &&
657 !(bmp_bpix == 24 && bpix == 32)) {
658 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
659 bpix, get_unaligned_le16(&bmp->header.bit_count));
663 debug("Display-bmp: %d x %d with %d colors\n",
664 (int)width, (int)height, (int)colors);
667 lcd_set_cmap(bmp, colors);
669 padded_width = (width & 0x3 ? (width & ~0x3) + 4 : width);
671 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
672 splash_align_axis(&x, pwidth, width);
673 splash_align_axis(&y, panel_info.vl_row, height);
674 #endif /* CONFIG_SPLASH_SCREEN_ALIGN */
676 if ((x + width) > pwidth)
678 if ((y + height) > panel_info.vl_row)
679 height = panel_info.vl_row - y;
681 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
682 fb = (uchar *)(lcd_base +
683 (y + height - 1) * lcd_line_length + x * bpix / 8);
686 case 1: /* pass through */
688 cmap_base = configuration_get_cmap();
689 #ifdef CONFIG_LCD_BMP_RLE8
690 u32 compression = get_unaligned_le32(&bmp->header.compression);
691 if (compression == BMP_BI_RLE8) {
693 /* TODO implement render code for bpix != 16 */
694 printf("Error: only support 16 bpix");
697 lcd_display_rle8_bitmap(bmp, cmap_base, fb, x, y);
705 byte_width = width * 2;
707 for (i = 0; i < height; ++i) {
709 for (j = 0; j < width; j++) {
711 fb_put_byte(&fb, &bmap);
713 *(uint16_t *)fb = cmap_base[*(bmap++)];
714 fb += sizeof(uint16_t) / sizeof(*fb);
717 bmap += (padded_width - width);
718 fb -= byte_width + lcd_line_length;
722 #if defined(CONFIG_BMP_16BPP)
724 for (i = 0; i < height; ++i) {
726 for (j = 0; j < width; j++)
727 fb_put_word(&fb, &bmap);
729 bmap += (padded_width - width) * 2;
730 fb -= width * 2 + lcd_line_length;
733 #endif /* CONFIG_BMP_16BPP */
734 #if defined(CONFIG_BMP_24BMP)
736 for (i = 0; i < height; ++i) {
737 for (j = 0; j < width; j++) {
743 fb -= lcd_line_length + width * (bpix / 8);
746 #endif /* CONFIG_BMP_24BMP */
747 #if defined(CONFIG_BMP_32BPP)
749 for (i = 0; i < height; ++i) {
750 for (j = 0; j < width; j++) {
756 fb -= lcd_line_length + width * (bpix / 8);
759 #endif /* CONFIG_BMP_32BPP */
769 static void *lcd_logo(void)
771 #ifdef CONFIG_SPLASH_SCREEN
774 static int do_splash = 1;
776 if (do_splash && (s = getenv("splashimage")) != NULL) {
780 if (splash_screen_prepare())
781 return (void *)lcd_base;
783 addr = simple_strtoul (s, NULL, 16);
785 splash_get_pos(&x, &y);
787 if (bmp_display(addr, x, y) == 0)
788 return (void *)lcd_base;
790 #endif /* CONFIG_SPLASH_SCREEN */
794 #ifdef CONFIG_LCD_INFO
795 lcd_set_col(LCD_INFO_X / VIDEO_FONT_WIDTH);
796 lcd_set_row(LCD_INFO_Y / VIDEO_FONT_HEIGHT);
797 lcd_show_board_info();
798 #endif /* CONFIG_LCD_INFO */
800 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
801 return (void *)((ulong)lcd_base + BMP_LOGO_HEIGHT * lcd_line_length);
803 return (void *)lcd_base;
804 #endif /* CONFIG_LCD_LOGO && !defined(CONFIG_LCD_INFO_BELOW_LOGO) */
807 #ifdef CONFIG_SPLASHIMAGE_GUARD
808 static int on_splashimage(const char *name, const char *value, enum env_op op,
814 if (op == env_op_delete)
817 addr = simple_strtoul(value, NULL, 16);
818 /* See README.displaying-bmps */
819 aligned = (addr % 4 == 2);
821 printf("Invalid splashimage value. Value must be 16 bit aligned, but not 32 bit aligned\n");
828 U_BOOT_ENV_CALLBACK(splashimage, on_splashimage);
831 int lcd_get_pixel_width(void)
833 return panel_info.vl_col;
836 int lcd_get_pixel_height(void)
838 return panel_info.vl_row;
841 #if defined(CONFIG_LCD_DT_SIMPLEFB)
842 static int lcd_dt_simplefb_configure_node(void *blob, int off)
844 #if LCD_BPP == LCD_COLOR16
845 return fdt_setup_simplefb_node(blob, off, gd->fb_base,
846 panel_info.vl_col, panel_info.vl_row,
847 panel_info.vl_col * 2, "r5g6b5");
853 int lcd_dt_simplefb_add_node(void *blob)
855 static const char compat[] = "simple-framebuffer";
856 static const char disabled[] = "disabled";
859 off = fdt_add_subnode(blob, 0, "framebuffer");
863 ret = fdt_setprop(blob, off, "status", disabled, sizeof(disabled));
867 ret = fdt_setprop(blob, off, "compatible", compat, sizeof(compat));
871 return lcd_dt_simplefb_configure_node(blob, off);
874 int lcd_dt_simplefb_enable_existing_node(void *blob)
878 off = fdt_node_offset_by_compatible(blob, -1, "simple-framebuffer");
882 return lcd_dt_simplefb_configure_node(blob, off);