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 #if LCD_BPP == LCD_COLOR8
140 #elif LCD_BPP == LCD_COLOR16
141 typedef ushort pix_t;
142 #elif LCD_BPP == LCD_COLOR32
145 #error Unsupported pixelformat
148 static void test_pattern(void)
150 ushort v_max = panel_info.vl_row;
151 ushort h_max = panel_info.vl_col;
152 ushort v_step = (v_max + N_BLK_VERT - 1) / N_BLK_VERT;
153 ushort h_step = (h_max + N_BLK_HOR - 1) / N_BLK_HOR;
155 pix_t *pix = lcd_base;
157 printf("[LCD] Test Pattern: %d x %d [%d x %d]\n",
158 h_max, v_max, h_step, v_step);
160 /* WARNING: Code silently assumes 8bit/pixel */
161 for (v = 0; v < v_max; ++v) {
162 uchar iy = v / v_step;
163 for (h = 0; h < h_max; ++h) {
164 uchar ix = N_BLK_HOR * iy + h / h_step;
165 *pix++ = test_colors[ix];
169 #endif /* LCD_TEST_PATTERN */
172 /************************************************************************/
173 /* ** GENERIC Initialization Routines */
174 /************************************************************************/
176 * With most lcd drivers the line length is set up
177 * by calculating it from panel_info parameters. Some
178 * drivers need to calculate the line length differently,
179 * so make the function weak to allow overriding it.
181 __weak int lcd_get_size(int *line_length)
183 *line_length = (panel_info.vl_col * NBITS(panel_info.vl_bpix)) / 8;
184 return *line_length * panel_info.vl_row;
187 int drv_lcd_init(void)
189 struct stdio_dev lcddev;
192 lcd_base = map_sysmem(gd->fb_base, 0);
194 lcd_init(lcd_base); /* LCD initialization */
196 /* Device initialization */
197 memset(&lcddev, 0, sizeof(lcddev));
199 strcpy(lcddev.name, "lcd");
200 lcddev.ext = 0; /* No extensions */
201 lcddev.flags = DEV_FLAGS_OUTPUT; /* Output only */
202 lcddev.putc = lcd_stub_putc; /* 'putc' function */
203 lcddev.puts = lcd_stub_puts; /* 'puts' function */
205 rc = stdio_register(&lcddev);
207 return (rc == 0) ? 1 : rc;
210 /*----------------------------------------------------------------------*/
213 short console_rows, console_cols;
215 #if LCD_BPP == LCD_COLOR8
216 /* Setting the palette */
217 lcd_setcolreg(CONSOLE_COLOR_BLACK, 0, 0, 0);
218 lcd_setcolreg(CONSOLE_COLOR_RED, 0xFF, 0, 0);
219 lcd_setcolreg(CONSOLE_COLOR_GREEN, 0, 0xFF, 0);
220 lcd_setcolreg(CONSOLE_COLOR_YELLOW, 0xFF, 0xFF, 0);
221 lcd_setcolreg(CONSOLE_COLOR_BLUE, 0, 0, 0xFF);
222 lcd_setcolreg(CONSOLE_COLOR_MAGENTA, 0xFF, 0, 0xFF);
223 lcd_setcolreg(CONSOLE_COLOR_CYAN, 0, 0xFF, 0xFF);
224 lcd_setcolreg(CONSOLE_COLOR_GREY, 0xAA, 0xAA, 0xAA);
225 lcd_setcolreg(CONSOLE_COLOR_WHITE, 0xFF, 0xFF, 0xFF);
228 #ifndef CONFIG_SYS_WHITE_ON_BLACK
229 lcd_setfgcolor(CONSOLE_COLOR_BLACK);
230 lcd_setbgcolor(CONSOLE_COLOR_WHITE);
231 bg_color = CONSOLE_COLOR_WHITE;
233 lcd_setfgcolor(CONSOLE_COLOR_WHITE);
234 lcd_setbgcolor(CONSOLE_COLOR_BLACK);
235 bg_color = CONSOLE_COLOR_BLACK;
236 #endif /* CONFIG_SYS_WHITE_ON_BLACK */
238 #ifdef LCD_TEST_PATTERN
241 /* set framebuffer to background color */
242 #if (LCD_BPP != LCD_COLOR32)
243 memset((char *)lcd_base, bg_color, lcd_line_length * panel_info.vl_row);
245 u32 *ppix = lcd_base;
248 i < (lcd_line_length * panel_info.vl_row)/NBYTES(panel_info.vl_bpix);
254 /* Paint the logo and retrieve LCD base address */
255 debug("[LCD] Drawing the logo @ %p...\n", lcd_base);
256 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
257 console_rows = (panel_info.vl_row - BMP_LOGO_HEIGHT);
258 console_rows /= VIDEO_FONT_HEIGHT;
260 console_rows = panel_info.vl_row / VIDEO_FONT_HEIGHT;
262 console_cols = panel_info.vl_col / VIDEO_FONT_WIDTH;
263 lcd_init_console(lcd_base, console_rows, console_cols);
264 lcd_init_console(lcd_logo(), console_rows, console_cols);
268 static int do_lcd_clear(cmd_tbl_t *cmdtp, int flag, int argc,
276 cls, 1, 1, do_lcd_clear,
281 /*----------------------------------------------------------------------*/
283 static int lcd_init(void *lcdbase)
285 /* Initialize the lcd controller */
286 debug("[LCD] Initializing %ux%ux%u LCD framebuffer at %p\n",
287 panel_info.vl_col, panel_info.vl_row, NBITS(panel_info.vl_bpix),
290 lcd_ctrl_init(lcdbase);
293 * lcd_ctrl_init() of some drivers (i.e. bcm2835 on rpi) ignores
294 * the 'lcdbase' argument and uses custom lcd base address
295 * by setting up gd->fb_base. Check for this condition and fixup
296 * 'lcd_base' address.
298 if (map_to_sysmem(lcdbase) != gd->fb_base)
299 lcd_base = map_sysmem(gd->fb_base, 0);
301 debug("[LCD] Using LCD frambuffer at %p\n", lcd_base);
303 lcd_get_size(&lcd_line_length);
308 /* Initialize the console */
310 #ifdef CONFIG_LCD_INFO_BELOW_LOGO
311 lcd_set_row(7 + BMP_LOGO_HEIGHT / VIDEO_FONT_HEIGHT);
313 lcd_set_row(1); /* leave 1 blank line below logo */
320 /************************************************************************/
321 /* ** ROM capable initialization part - needed to reserve FB memory */
322 /************************************************************************/
324 * This is called early in the system initialization to grab memory
325 * for the LCD controller.
326 * Returns new address for monitor, after reserving LCD buffer memory
328 * Note that this is running from ROM, so no write access to global data.
330 ulong lcd_setmem(ulong addr)
335 debug("LCD panel info: %d x %d, %d bit/pix\n", panel_info.vl_col,
336 panel_info.vl_row, NBITS(panel_info.vl_bpix));
338 size = lcd_get_size(&line_length);
340 /* Round up to nearest full page, or MMU section if defined */
341 size = ALIGN(size, CONFIG_LCD_ALIGNMENT);
342 addr = ALIGN(addr - CONFIG_LCD_ALIGNMENT + 1, CONFIG_LCD_ALIGNMENT);
344 /* Allocate pages for the frame buffer. */
347 debug("Reserving %ldk for LCD Framebuffer at: %08lx\n",
353 /*----------------------------------------------------------------------*/
355 static void lcd_setfgcolor(int color)
357 lcd_color_fg = color;
360 int lcd_getfgcolor(void)
365 /*----------------------------------------------------------------------*/
367 static void lcd_setbgcolor(int color)
369 lcd_color_bg = color;
372 int lcd_getbgcolor(void)
377 /************************************************************************/
378 /* ** Chipset depending Bitmap / Logo stuff... */
379 /************************************************************************/
381 #ifdef CONFIG_LCD_LOGO
382 __weak void lcd_logo_set_cmap(void)
385 ushort *cmap = configuration_get_cmap();
387 for (i = 0; i < ARRAY_SIZE(bmp_logo_palette); ++i)
388 *cmap++ = bmp_logo_palette[i];
391 void bitmap_plot(int x, int y)
397 unsigned bpix = NBITS(panel_info.vl_bpix);
399 debug("Logo: width %d height %d colors %d\n",
400 BMP_LOGO_WIDTH, BMP_LOGO_HEIGHT, BMP_LOGO_COLORS);
402 bmap = &bmp_logo_bitmap[0];
403 fb = (uchar *)(lcd_base + y * lcd_line_length + x * bpix / 8);
410 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
411 memcpy(fb, bmap, BMP_LOGO_WIDTH);
412 bmap += BMP_LOGO_WIDTH;
413 fb += panel_info.vl_col;
415 } else if (NBITS(panel_info.vl_bpix) == 16) {
418 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
419 for (j = 0; j < BMP_LOGO_WIDTH; j++) {
420 col16 = bmp_logo_palette[(bmap[j]-16)];
422 ((col16 & 0x000F) << 1) |
423 ((col16 & 0x00F0) << 3) |
424 ((col16 & 0x0F00) << 4);
426 bmap += BMP_LOGO_WIDTH;
427 fb16 += panel_info.vl_col;
429 } else { /* true color mode */
431 u32 *fb32 = lcd_base + y * lcd_line_length + x;
433 for (i = 0; i < BMP_LOGO_HEIGHT; i++) {
434 for (j = 0; j < BMP_LOGO_WIDTH; j++) {
435 col16 = bmp_logo_palette[bmap[j] - 16];
437 ((col16 & 0x000F) << 4) |
438 ((col16 & 0x00F0) << 8) |
439 ((col16 & 0x0F00) << 12);
441 bmap += BMP_LOGO_WIDTH;
442 fb32 += panel_info.vl_col;
450 static inline void bitmap_plot(int x, int y) {}
451 #endif /* CONFIG_LCD_LOGO */
453 /*----------------------------------------------------------------------*/
454 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
456 * Display the BMP file located at address bmp_image.
460 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
461 #define BMP_ALIGN_CENTER 0x7FFF
463 static void splash_align_axis(int *axis, unsigned long panel_size,
464 unsigned long picture_size)
466 unsigned long panel_picture_delta = panel_size - picture_size;
467 unsigned long axis_alignment;
469 if (*axis == BMP_ALIGN_CENTER)
470 axis_alignment = panel_picture_delta / 2;
472 axis_alignment = panel_picture_delta + *axis + 1;
476 *axis = max(0, (int)axis_alignment);
481 #ifdef CONFIG_LCD_BMP_RLE8
483 #define BMP_RLE8_ESCAPE 0
484 #define BMP_RLE8_EOL 0
485 #define BMP_RLE8_EOBMP 1
486 #define BMP_RLE8_DELTA 2
488 static void draw_unencoded_bitmap(ushort **fbp, uchar *bmap, ushort *cmap,
492 *(*fbp)++ = cmap[*bmap++];
497 static void draw_encoded_bitmap(ushort **fbp, ushort c, int cnt)
500 int cnt_8copy = cnt >> 3;
502 cnt -= cnt_8copy << 3;
503 while (cnt_8copy > 0) {
522 * Do not call this function directly, must be called from lcd_display_bitmap.
524 static void lcd_display_rle8_bitmap(bmp_image_t *bmp, ushort *cmap, uchar *fb,
525 int x_off, int y_off)
533 width = get_unaligned_le32(&bmp->header.width);
534 height = get_unaligned_le32(&bmp->header.height);
535 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
541 if (bmap[0] == BMP_RLE8_ESCAPE) {
548 /* 16bpix, 2-byte per pixel, width should *2 */
549 fb -= (width * 2 + lcd_line_length);
559 /* 16bpix, 2-byte per pixel, x should *2 */
560 fb = (uchar *) (lcd_base + (y + y_off - 1)
561 * lcd_line_length + (x + x_off) * 2);
570 if (x + runlen > width)
574 draw_unencoded_bitmap(
589 /* aggregate the same code */
590 while (bmap[0] == 0xff &&
591 bmap[2] != BMP_RLE8_ESCAPE &&
592 bmap[1] == bmap[3]) {
596 if (x + runlen > width)
600 draw_encoded_bitmap((ushort **)&fb,
611 __weak void fb_put_byte(uchar **fb, uchar **from)
613 *(*fb)++ = *(*from)++;
616 #if defined(CONFIG_BMP_16BPP)
617 __weak void fb_put_word(uchar **fb, uchar **from)
619 *(*fb)++ = *(*from)++;
620 *(*fb)++ = *(*from)++;
622 #endif /* CONFIG_BMP_16BPP */
624 __weak void lcd_set_cmap(bmp_image_t *bmp, unsigned colors)
627 bmp_color_table_entry_t cte;
628 ushort *cmap = configuration_get_cmap();
630 for (i = 0; i < colors; ++i) {
631 cte = bmp->color_table[i];
632 *cmap = (((cte.red) << 8) & 0xf800) |
633 (((cte.green) << 3) & 0x07e0) |
634 (((cte.blue) >> 3) & 0x001f);
635 #if defined(CONFIG_MPC823)
643 int lcd_display_bitmap(ulong bmp_image, int x, int y)
645 ushort *cmap_base = NULL;
648 bmp_image_t *bmp = (bmp_image_t *)map_sysmem(bmp_image, 0);
651 unsigned long width, height;
652 unsigned long pwidth = panel_info.vl_col;
653 unsigned long long colors;
654 unsigned bpix, bmp_bpix;
655 bmp_color_table_entry_t *cte;
657 if (!bmp || !(bmp->header.signature[0] == 'B' &&
658 bmp->header.signature[1] == 'M')) {
659 printf("Error: no valid bmp image at %lx\n", bmp_image);
664 width = get_unaligned_le32(&bmp->header.width);
665 height = get_unaligned_le32(&bmp->header.height);
666 bmp_bpix = get_unaligned_le16(&bmp->header.bit_count);
668 colors = 1 << bmp_bpix;
670 bpix = NBITS(panel_info.vl_bpix);
672 if (bpix != 1 && bpix != 8 && bpix != 16 && bpix != 32) {
673 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
680 * We support displaying 8bpp BMPs on 16bpp LCDs
681 * and displaying 24bpp BMPs on 32bpp LCDs
683 if (bpix != bmp_bpix &&
684 !(bmp_bpix == 8 && bpix == 16) &&
685 !(bmp_bpix == 24 && bpix == 32)) {
686 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
687 bpix, get_unaligned_le16(&bmp->header.bit_count));
691 debug("Display-bmp: %lu x %lu with %llu colors\n",
692 width, height, colors);
695 lcd_set_cmap(bmp, colors);
697 padded_width = ALIGN(width, 4);
699 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
700 splash_align_axis(&x, pwidth, width);
701 splash_align_axis(&y, panel_info.vl_row, height);
702 #endif /* CONFIG_SPLASH_SCREEN_ALIGN */
703 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
705 if ((x + width) > pwidth)
707 if ((y + height) > panel_info.vl_row) {
708 height = panel_info.vl_row - y;
709 bmap += (panel_info.vl_row - y) * padded_width;
712 fb = (uchar *)(lcd_base +
713 (y + height - 1) * lcd_line_length + x * bpix / 8);
716 case 1: /* pass through */
718 cmap_base = configuration_get_cmap();
719 #ifdef CONFIG_LCD_BMP_RLE8
720 u32 compression = get_unaligned_le32(&bmp->header.compression);
721 if (compression == BMP_BI_RLE8) {
723 /* TODO implement render code for bpix != 16 */
724 printf("Error: only support 16 bpix");
727 lcd_display_rle8_bitmap(bmp, cmap_base, fb, x, y);
732 for (i = 0; i < height; ++i) {
734 for (j = 0; j < width; j++) {
740 fb[1] = cte[i].green;
742 fb += sizeof(uint32_t) / sizeof(*fb);
743 } else if (bpix == 16) {
744 *(uint16_t *)fb = cmap_base[*(bmap++)];
745 fb += sizeof(uint16_t) / sizeof(*fb);
747 FB_PUT_BYTE(fb, bmap);
751 bmap += padded_width - width;
752 fb -= width * bpix / 8 + lcd_line_length;
754 bmap += padded_width;
755 fb -= lcd_line_length;
760 #if defined(CONFIG_BMP_16BPP)
762 for (i = 0; i < height; ++i) {
764 for (j = 0; j < width; j++)
765 fb_put_word(&fb, &bmap);
767 bmap += (padded_width - width) * 2;
768 fb -= width * 2 + lcd_line_length;
771 #endif /* CONFIG_BMP_16BPP */
772 #if defined(CONFIG_BMP_24BMP)
774 for (i = 0; i < height; ++i) {
775 for (j = 0; j < width; j++) {
781 fb -= lcd_line_length + width * (bpix / 8);
784 #endif /* CONFIG_BMP_24BPP */
785 #if defined(CONFIG_BMP_32BPP)
787 for (i = 0; i < height; ++i) {
789 for (j = 0; j < width; j++) {
790 fb[3] = *bmap++; /* T */
791 fb[0] = *bmap++; /* B */
792 fb[1] = *bmap++; /* G */
793 fb[2] = *bmap++; /* R */
796 bmap += (padded_width - width) * 4;
797 fb -= lcd_line_length + width * (bpix / 8);
800 #endif /* CONFIG_BMP_32BPP */
807 static void *lcd_logo(void)
809 #ifdef CONFIG_SPLASH_SCREEN
812 static int do_splash = 1;
814 if (do_splash && (s = getenv("splashimage")) != NULL) {
820 if (splash_screen_prepare())
821 return (void *)lcd_base;
823 addr = simple_strtoul (s, &end, 16);
824 if (addr == 0 || *end != '\0')
827 splash_get_pos(&x, &y);
829 if (bmp_display(addr, x, y) == 0)
830 return (void *)lcd_base;
832 #endif /* CONFIG_SPLASH_SCREEN */
836 #ifdef CONFIG_LCD_INFO
837 lcd_set_col(LCD_INFO_X / VIDEO_FONT_WIDTH);
838 lcd_set_row(LCD_INFO_Y / VIDEO_FONT_HEIGHT);
839 lcd_show_board_info();
840 #endif /* CONFIG_LCD_INFO */
842 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
843 return lcd_base + BMP_LOGO_HEIGHT * lcd_line_length;
846 #endif /* CONFIG_LCD_LOGO && !CONFIG_LCD_INFO_BELOW_LOGO */
849 #ifdef CONFIG_SPLASHIMAGE_GUARD
850 static int on_splashimage(const char *name, const char *value, enum env_op op,
856 if (op == env_op_delete)
859 addr = simple_strtoul(value, NULL, 16);
860 /* See README.displaying-bmps */
861 aligned = (addr % 4 == 2);
863 printf("Invalid splashimage value. Value must be 16 bit aligned, but not 32 bit aligned\n");
870 U_BOOT_ENV_CALLBACK(splashimage, on_splashimage);
873 int lcd_get_pixel_width(void)
875 return panel_info.vl_col;
878 int lcd_get_pixel_height(void)
880 return panel_info.vl_row;
883 #if defined(CONFIG_LCD_DT_SIMPLEFB)
884 static int lcd_dt_simplefb_configure_node(void *blob, int off)
886 #if LCD_BPP == LCD_COLOR16
887 return fdt_setup_simplefb_node(blob, off, gd->fb_base,
888 panel_info.vl_col, panel_info.vl_row,
889 panel_info.vl_col * 2, "r5g6b5");
895 int lcd_dt_simplefb_add_node(void *blob)
897 static const char compat[] = "simple-framebuffer";
898 static const char disabled[] = "disabled";
901 off = fdt_add_subnode(blob, 0, "framebuffer");
905 ret = fdt_setprop(blob, off, "status", disabled, sizeof(disabled));
909 ret = fdt_setprop(blob, off, "compatible", compat, sizeof(compat));
913 return lcd_dt_simplefb_configure_node(blob, off);
916 int lcd_dt_simplefb_enable_existing_node(void *blob)
920 off = fdt_node_offset_by_compatible(blob, -1, "simple-framebuffer");
924 return lcd_dt_simplefb_configure_node(blob, off);