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 /************************************************************************/
21 #include <env_callback.h>
22 #include <linux/types.h>
23 #include <stdio_dev.h>
24 #if defined(CONFIG_POST)
29 #include <asm/unaligned.h>
32 #include <asm/unaligned.h>
33 #include <fdt_support.h>
35 #if defined(CONFIG_CPU_PXA25X) || defined(CONFIG_CPU_PXA27X) || \
36 defined(CONFIG_CPU_MONAHANS)
37 #include <asm/byteorder.h>
40 #if defined(CONFIG_MPC823)
44 #if defined(CONFIG_ATMEL_LCD)
45 #include <atmel_lcdc.h>
48 #if defined(CONFIG_LCD_DT_SIMPLEFB)
52 /************************************************************************/
54 /************************************************************************/
55 #include <video_font.h> /* Get font data, width and height */
57 /************************************************************************/
59 /************************************************************************/
60 #ifdef CONFIG_LCD_LOGO
61 # include <bmp_logo.h> /* Get logo data, width and height */
62 # include <bmp_logo_data.h>
63 # if (CONSOLE_COLOR_WHITE >= BMP_LOGO_OFFSET) && (LCD_BPP != LCD_COLOR16)
64 # error Default Color Map overlaps with Logo Color Map
72 #ifndef CONFIG_LCD_ALIGNMENT
73 #define CONFIG_LCD_ALIGNMENT PAGE_SIZE
76 #if (LCD_BPP != LCD_COLOR8) && (LCD_BPP != LCD_COLOR16) && \
77 (LCD_BPP != LCD_COLOR32)
78 # error Unsupported LCD BPP.
81 DECLARE_GLOBAL_DATA_PTR;
83 static int lcd_init(void *lcdbase);
85 static void *lcd_logo(void);
87 static void lcd_setfgcolor(int color);
88 static void lcd_setbgcolor(int color);
90 static int lcd_color_fg;
91 static int lcd_color_bg;
94 char lcd_is_enabled = 0;
96 static void *lcd_base; /* Start of framebuffer memory */
98 static char lcd_flush_dcache; /* 1 to flush dcache after each lcd update */
100 /************************************************************************/
102 /* Flush LCD activity to the caches */
106 * flush_dcache_range() is declared in common.h but it seems that some
107 * architectures do not actually implement it. Is there a way to find
108 * out whether it exists? For now, ARM is safe.
110 #if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
113 if (lcd_flush_dcache)
114 flush_dcache_range((u32)lcd_base,
115 (u32)(lcd_base + lcd_get_size(&line_length)));
116 #elif defined(CONFIG_SANDBOX) && defined(CONFIG_VIDEO_SANDBOX_SDL)
117 static ulong last_sync;
119 if (get_timer(last_sync) > 10) {
120 sandbox_sdl_sync(lcd_base);
121 last_sync = get_timer(0);
126 void lcd_set_flush_dcache(int flush)
128 lcd_flush_dcache = (flush != 0);
131 /*----------------------------------------------------------------------*/
133 static void lcd_stub_putc(struct stdio_dev *dev, const char c)
138 static void lcd_stub_puts(struct stdio_dev *dev, const char *s)
143 /************************************************************************/
144 /** Small utility to check that you got the colours right */
145 /************************************************************************/
146 #ifdef LCD_TEST_PATTERN
151 static int test_colors[N_BLK_HOR * N_BLK_VERT] = {
152 CONSOLE_COLOR_RED, CONSOLE_COLOR_GREEN, CONSOLE_COLOR_YELLOW,
153 CONSOLE_COLOR_BLUE, CONSOLE_COLOR_MAGENTA, CONSOLE_COLOR_CYAN,
156 static void test_pattern(void)
158 ushort v_max = panel_info.vl_row;
159 ushort h_max = panel_info.vl_col;
160 ushort v_step = (v_max + N_BLK_VERT - 1) / N_BLK_VERT;
161 ushort h_step = (h_max + N_BLK_HOR - 1) / N_BLK_HOR;
163 uchar *pix = (uchar *)lcd_base;
165 printf("[LCD] Test Pattern: %d x %d [%d x %d]\n",
166 h_max, v_max, h_step, v_step);
168 /* WARNING: Code silently assumes 8bit/pixel */
169 for (v = 0; v < v_max; ++v) {
170 uchar iy = v / v_step;
171 for (h = 0; h < h_max; ++h) {
172 uchar ix = N_BLK_HOR * iy + h / h_step;
173 *pix++ = test_colors[ix];
177 #endif /* LCD_TEST_PATTERN */
180 /************************************************************************/
181 /* ** GENERIC Initialization Routines */
182 /************************************************************************/
184 * With most lcd drivers the line length is set up
185 * by calculating it from panel_info parameters. Some
186 * drivers need to calculate the line length differently,
187 * so make the function weak to allow overriding it.
189 __weak int lcd_get_size(int *line_length)
191 *line_length = (panel_info.vl_col * NBITS(panel_info.vl_bpix)) / 8;
192 return *line_length * panel_info.vl_row;
195 int drv_lcd_init(void)
197 struct stdio_dev lcddev;
200 lcd_base = map_sysmem(gd->fb_base, 0);
202 lcd_init(lcd_base); /* LCD initialization */
204 /* Device initialization */
205 memset(&lcddev, 0, sizeof(lcddev));
207 strcpy(lcddev.name, "lcd");
208 lcddev.ext = 0; /* No extensions */
209 lcddev.flags = DEV_FLAGS_OUTPUT; /* Output only */
210 lcddev.putc = lcd_stub_putc; /* 'putc' function */
211 lcddev.puts = lcd_stub_puts; /* 'puts' function */
213 rc = stdio_register(&lcddev);
215 return (rc == 0) ? 1 : rc;
218 /*----------------------------------------------------------------------*/
221 short console_rows, console_cols;
223 #if LCD_BPP == LCD_COLOR8
224 /* Setting the palette */
225 lcd_setcolreg(CONSOLE_COLOR_BLACK, 0, 0, 0);
226 lcd_setcolreg(CONSOLE_COLOR_RED, 0xFF, 0, 0);
227 lcd_setcolreg(CONSOLE_COLOR_GREEN, 0, 0xFF, 0);
228 lcd_setcolreg(CONSOLE_COLOR_YELLOW, 0xFF, 0xFF, 0);
229 lcd_setcolreg(CONSOLE_COLOR_BLUE, 0, 0, 0xFF);
230 lcd_setcolreg(CONSOLE_COLOR_MAGENTA, 0xFF, 0, 0xFF);
231 lcd_setcolreg(CONSOLE_COLOR_CYAN, 0, 0xFF, 0xFF);
232 lcd_setcolreg(CONSOLE_COLOR_GREY, 0xAA, 0xAA, 0xAA);
233 lcd_setcolreg(CONSOLE_COLOR_WHITE, 0xFF, 0xFF, 0xFF);
236 #ifndef CONFIG_SYS_WHITE_ON_BLACK
237 lcd_setfgcolor(CONSOLE_COLOR_BLACK);
238 lcd_setbgcolor(CONSOLE_COLOR_WHITE);
239 bg_color = CONSOLE_COLOR_WHITE;
241 lcd_setfgcolor(CONSOLE_COLOR_WHITE);
242 lcd_setbgcolor(CONSOLE_COLOR_BLACK);
243 bg_color = CONSOLE_COLOR_BLACK;
244 #endif /* CONFIG_SYS_WHITE_ON_BLACK */
246 #ifdef LCD_TEST_PATTERN
249 /* set framebuffer to background color */
250 #if (LCD_BPP != LCD_COLOR32)
251 memset((char *)lcd_base, bg_color, lcd_line_length * panel_info.vl_row);
253 u32 *ppix = lcd_base;
256 i < (lcd_line_length * panel_info.vl_row)/NBYTES(panel_info.vl_bpix);
262 /* Paint the logo and retrieve LCD base address */
263 debug("[LCD] Drawing the logo...\n");
264 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
265 console_rows = (panel_info.vl_row - BMP_LOGO_HEIGHT);
266 console_rows /= VIDEO_FONT_HEIGHT;
268 console_rows = panel_info.vl_row / VIDEO_FONT_HEIGHT;
270 console_cols = panel_info.vl_col / VIDEO_FONT_WIDTH;
271 lcd_init_console(lcd_base, console_rows, console_cols);
272 lcd_init_console(lcd_logo(), console_rows, console_cols);
276 static int do_lcd_clear(cmd_tbl_t *cmdtp, int flag, int argc,
284 cls, 1, 1, do_lcd_clear,
289 /*----------------------------------------------------------------------*/
291 static int lcd_init(void *lcdbase)
293 /* Initialize the lcd controller */
294 debug("[LCD] Initializing LCD frambuffer at %p\n", lcdbase);
296 lcd_ctrl_init(lcdbase);
299 * lcd_ctrl_init() of some drivers (i.e. bcm2835 on rpi) ignores
300 * the 'lcdbase' argument and uses custom lcd base address
301 * by setting up gd->fb_base. Check for this condition and fixup
302 * 'lcd_base' address.
304 if (map_to_sysmem(lcdbase) != gd->fb_base)
305 lcd_base = map_sysmem(gd->fb_base, 0);
307 debug("[LCD] Using LCD frambuffer at %p\n", lcd_base);
309 lcd_get_size(&lcd_line_length);
314 /* Initialize the console */
316 #ifdef CONFIG_LCD_INFO_BELOW_LOGO
317 lcd_set_row(7 + BMP_LOGO_HEIGHT / VIDEO_FONT_HEIGHT);
319 lcd_set_row(1); /* leave 1 blank line below logo */
326 /************************************************************************/
327 /* ** ROM capable initialization part - needed to reserve FB memory */
328 /************************************************************************/
330 * This is called early in the system initialization to grab memory
331 * for the LCD controller.
332 * Returns new address for monitor, after reserving LCD buffer memory
334 * Note that this is running from ROM, so no write access to global data.
336 ulong lcd_setmem(ulong addr)
341 debug("LCD panel info: %d x %d, %d bit/pix\n", panel_info.vl_col,
342 panel_info.vl_row, NBITS(panel_info.vl_bpix));
344 size = lcd_get_size(&line_length);
346 /* Round up to nearest full page, or MMU section if defined */
347 size = ALIGN(size, CONFIG_LCD_ALIGNMENT);
348 addr = ALIGN(addr - CONFIG_LCD_ALIGNMENT + 1, CONFIG_LCD_ALIGNMENT);
350 /* Allocate pages for the frame buffer. */
353 debug("Reserving %ldk for LCD Framebuffer at: %08lx\n",
359 /*----------------------------------------------------------------------*/
361 static void lcd_setfgcolor(int color)
363 lcd_color_fg = color;
366 int lcd_getfgcolor(void)
371 /*----------------------------------------------------------------------*/
373 static void lcd_setbgcolor(int color)
375 lcd_color_bg = color;
378 int lcd_getbgcolor(void)
383 /************************************************************************/
384 /* ** Chipset depending Bitmap / Logo stuff... */
385 /************************************************************************/
387 #ifdef CONFIG_LCD_LOGO
388 __weak void lcd_logo_set_cmap(void)
392 void bitmap_plot(int x, int y)
394 ushort *cmap = (ushort *)bmp_logo_palette;
399 #if defined(CONFIG_MPC823)
400 immap_t *immr = (immap_t *) CONFIG_SYS_IMMR;
401 cpm8xx_t *cp = &(immr->im_cpm);
403 unsigned bpix = NBITS(panel_info.vl_bpix);
405 debug("Logo: width %d height %d colors %d cmap %d\n",
406 BMP_LOGO_WIDTH, BMP_LOGO_HEIGHT, BMP_LOGO_COLORS,
407 ARRAY_SIZE(bmp_logo_palette));
409 bmap = &bmp_logo_bitmap[0];
410 fb = (uchar *)(lcd_base + y * lcd_line_length + x * bpix / 8);
413 /* Leave room for default color map
414 * default case: generic system with no cmap (most likely 16bpp)
415 * cmap was set to the source palette, so no change is done.
416 * This avoids even more ifdefs in the next stanza
418 #if defined(CONFIG_MPC823)
419 cmap = (ushort *) &(cp->lcd_cmap[BMP_LOGO_OFFSET * sizeof(ushort)]);
421 cmap = configuration_get_cmap();
427 #ifdef CONFIG_ATMEL_LCD
430 for (i = 0; i < ARRAY_SIZE(bmp_logo_palette); ++i) {
431 ushort colreg = bmp_logo_palette[i];
438 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
439 memcpy(fb, bmap, BMP_LOGO_WIDTH);
440 bmap += BMP_LOGO_WIDTH;
441 fb += panel_info.vl_col;
444 else { /* true color mode */
447 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
448 for (j = 0; j < BMP_LOGO_WIDTH; j++) {
449 col16 = bmp_logo_palette[(bmap[j]-16)];
451 ((col16 & 0x000F) << 1) |
452 ((col16 & 0x00F0) << 3) |
453 ((col16 & 0x0F00) << 4);
455 bmap += BMP_LOGO_WIDTH;
456 fb16 += panel_info.vl_col;
464 static inline void bitmap_plot(int x, int y) {}
465 #endif /* CONFIG_LCD_LOGO */
467 /*----------------------------------------------------------------------*/
468 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
470 * Display the BMP file located at address bmp_image.
474 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
475 #define BMP_ALIGN_CENTER 0x7FFF
477 static void splash_align_axis(int *axis, unsigned long panel_size,
478 unsigned long picture_size)
480 unsigned long panel_picture_delta = panel_size - picture_size;
481 unsigned long axis_alignment;
483 if (*axis == BMP_ALIGN_CENTER)
484 axis_alignment = panel_picture_delta / 2;
486 axis_alignment = panel_picture_delta + *axis + 1;
490 *axis = max(0, (int)axis_alignment);
495 #ifdef CONFIG_LCD_BMP_RLE8
497 #define BMP_RLE8_ESCAPE 0
498 #define BMP_RLE8_EOL 0
499 #define BMP_RLE8_EOBMP 1
500 #define BMP_RLE8_DELTA 2
502 static void draw_unencoded_bitmap(ushort **fbp, uchar *bmap, ushort *cmap,
506 *(*fbp)++ = cmap[*bmap++];
511 static void draw_encoded_bitmap(ushort **fbp, ushort c, int cnt)
514 int cnt_8copy = cnt >> 3;
516 cnt -= cnt_8copy << 3;
517 while (cnt_8copy > 0) {
536 * Do not call this function directly, must be called from lcd_display_bitmap.
538 static void lcd_display_rle8_bitmap(bmp_image_t *bmp, ushort *cmap, uchar *fb,
539 int x_off, int y_off)
547 width = get_unaligned_le32(&bmp->header.width);
548 height = get_unaligned_le32(&bmp->header.height);
549 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
555 if (bmap[0] == BMP_RLE8_ESCAPE) {
562 /* 16bpix, 2-byte per pixel, width should *2 */
563 fb -= (width * 2 + lcd_line_length);
573 /* 16bpix, 2-byte per pixel, x should *2 */
574 fb = (uchar *) (lcd_base + (y + y_off - 1)
575 * lcd_line_length + (x + x_off) * 2);
584 if (x + runlen > width)
588 draw_unencoded_bitmap(
603 /* aggregate the same code */
604 while (bmap[0] == 0xff &&
605 bmap[2] != BMP_RLE8_ESCAPE &&
606 bmap[1] == bmap[3]) {
610 if (x + runlen > width)
614 draw_encoded_bitmap((ushort **)&fb,
625 __weak void fb_put_byte(uchar **fb, uchar **from)
627 *(*fb)++ = *(*from)++;
630 #if defined(CONFIG_BMP_16BPP)
631 __weak void fb_put_word(uchar **fb, uchar **from)
633 *(*fb)++ = *(*from)++;
634 *(*fb)++ = *(*from)++;
636 #endif /* CONFIG_BMP_16BPP */
638 int lcd_display_bitmap(ulong bmp_image, int x, int y)
641 ushort *cmap_base = NULL;
644 bmp_image_t *bmp = (bmp_image_t *)map_sysmem(bmp_image, 0);
647 unsigned long width, height, byte_width;
648 unsigned long pwidth = panel_info.vl_col;
649 unsigned colors, bpix, bmp_bpix;
651 if (!bmp || !(bmp->header.signature[0] == 'B' &&
652 bmp->header.signature[1] == 'M')) {
653 printf("Error: no valid bmp image at %lx\n", bmp_image);
658 width = get_unaligned_le32(&bmp->header.width);
659 height = get_unaligned_le32(&bmp->header.height);
660 bmp_bpix = get_unaligned_le16(&bmp->header.bit_count);
662 colors = 1 << bmp_bpix;
664 bpix = NBITS(panel_info.vl_bpix);
666 if (bpix != 1 && bpix != 8 && bpix != 16 && bpix != 32) {
667 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
674 * We support displaying 8bpp BMPs on 16bpp LCDs
675 * and displaying 24bpp BMPs on 32bpp LCDs
677 if (bpix != bmp_bpix &&
678 !(bmp_bpix == 8 && bpix == 16) &&
679 !(bmp_bpix == 24 && bpix == 32)) {
680 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
681 bpix, get_unaligned_le16(&bmp->header.bit_count));
685 debug("Display-bmp: %d x %d with %d colors\n",
686 (int)width, (int)height, (int)colors);
689 cmap = configuration_get_cmap();
693 for (i = 0; i < colors; ++i) {
694 bmp_color_table_entry_t cte = bmp->color_table[i];
695 #if !defined(CONFIG_ATMEL_LCD)
697 ( ((cte.red) << 8) & 0xf800) |
698 ( ((cte.green) << 3) & 0x07e0) |
699 ( ((cte.blue) >> 3) & 0x001f) ;
701 #if defined(CONFIG_MPC823)
706 #else /* CONFIG_ATMEL_LCD */
707 lcd_setcolreg(i, cte.red, cte.green, cte.blue);
712 padded_width = (width & 0x3 ? (width & ~0x3) + 4 : width);
714 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
715 splash_align_axis(&x, pwidth, width);
716 splash_align_axis(&y, panel_info.vl_row, height);
717 #endif /* CONFIG_SPLASH_SCREEN_ALIGN */
719 if ((x + width) > pwidth)
721 if ((y + height) > panel_info.vl_row)
722 height = panel_info.vl_row - y;
724 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
725 fb = (uchar *)(lcd_base +
726 (y + height - 1) * lcd_line_length + x * bpix / 8);
729 case 1: /* pass through */
731 #ifdef CONFIG_LCD_BMP_RLE8
732 u32 compression = get_unaligned_le32(&bmp->header.compression);
733 if (compression == BMP_BI_RLE8) {
735 /* TODO implement render code for bpix != 16 */
736 printf("Error: only support 16 bpix");
739 lcd_display_rle8_bitmap(bmp, cmap_base, fb, x, y);
747 byte_width = width * 2;
749 for (i = 0; i < height; ++i) {
751 for (j = 0; j < width; j++) {
753 fb_put_byte(&fb, &bmap);
755 *(uint16_t *)fb = cmap_base[*(bmap++)];
756 fb += sizeof(uint16_t) / sizeof(*fb);
759 bmap += (padded_width - width);
760 fb -= byte_width + lcd_line_length;
764 #if defined(CONFIG_BMP_16BPP)
766 for (i = 0; i < height; ++i) {
768 for (j = 0; j < width; j++)
769 fb_put_word(&fb, &bmap);
771 bmap += (padded_width - width) * 2;
772 fb -= width * 2 + lcd_line_length;
775 #endif /* CONFIG_BMP_16BPP */
776 #if defined(CONFIG_BMP_24BMP)
778 for (i = 0; i < height; ++i) {
779 for (j = 0; j < width; j++) {
785 fb -= lcd_line_length + width * (bpix / 8);
788 #endif /* CONFIG_BMP_24BMP */
789 #if defined(CONFIG_BMP_32BPP)
791 for (i = 0; i < height; ++i) {
792 for (j = 0; j < width; j++) {
798 fb -= lcd_line_length + width * (bpix / 8);
801 #endif /* CONFIG_BMP_32BPP */
811 static void *lcd_logo(void)
813 #ifdef CONFIG_SPLASH_SCREEN
816 static int do_splash = 1;
818 if (do_splash && (s = getenv("splashimage")) != NULL) {
822 if (splash_screen_prepare())
823 return (void *)lcd_base;
825 addr = simple_strtoul (s, NULL, 16);
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 (void *)((ulong)lcd_base + BMP_LOGO_HEIGHT * lcd_line_length);
845 return (void *)lcd_base;
846 #endif /* CONFIG_LCD_LOGO && !defined(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);