4 * (C) Copyright 2001-2002
5 * Wolfgang Denk, DENX Software Engineering -- wd@denx.de
7 * SPDX-License-Identifier: GPL-2.0+
14 #include <env_callback.h>
15 #include <linux/types.h>
16 #include <stdio_dev.h>
19 #include <asm/unaligned.h>
22 #include <asm/unaligned.h>
23 #include <video_font.h>
25 #ifdef CONFIG_LCD_LOGO
27 #include <bmp_logo_data.h>
28 #if (CONSOLE_COLOR_WHITE >= BMP_LOGO_OFFSET) && (LCD_BPP != LCD_COLOR16)
29 #error Default Color Map overlaps with Logo Color Map
37 #ifndef CONFIG_LCD_ALIGNMENT
38 #define CONFIG_LCD_ALIGNMENT PAGE_SIZE
41 #if (LCD_BPP != LCD_COLOR8) && (LCD_BPP != LCD_COLOR16) && \
42 (LCD_BPP != LCD_COLOR32)
43 #error Unsupported LCD BPP.
46 DECLARE_GLOBAL_DATA_PTR;
48 static int lcd_init(void *lcdbase);
49 static void *lcd_logo(void);
50 static void lcd_setfgcolor(int color);
51 static void lcd_setbgcolor(int color);
53 static int lcd_color_fg;
54 static int lcd_color_bg;
56 char lcd_is_enabled = 0;
57 static void *lcd_base; /* Start of framebuffer memory */
58 static char lcd_flush_dcache; /* 1 to flush dcache after each lcd update */
60 /* Flush LCD activity to the caches */
64 * flush_dcache_range() is declared in common.h but it seems that some
65 * architectures do not actually implement it. Is there a way to find
66 * out whether it exists? For now, ARM is safe.
68 #if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
72 flush_dcache_range((u32)lcd_base,
73 (u32)(lcd_base + lcd_get_size(&line_length)));
74 #elif defined(CONFIG_SANDBOX) && defined(CONFIG_VIDEO_SANDBOX_SDL)
75 static ulong last_sync;
77 if (get_timer(last_sync) > 10) {
78 sandbox_sdl_sync(lcd_base);
79 last_sync = get_timer(0);
84 void lcd_set_flush_dcache(int flush)
86 lcd_flush_dcache = (flush != 0);
89 static void lcd_stub_putc(struct stdio_dev *dev, const char c)
94 static void lcd_stub_puts(struct stdio_dev *dev, const char *s)
99 /* Small utility to check that you got the colours right */
100 #ifdef LCD_TEST_PATTERN
105 static int test_colors[N_BLK_HOR * N_BLK_VERT] = {
106 CONSOLE_COLOR_RED, CONSOLE_COLOR_GREEN, CONSOLE_COLOR_YELLOW,
107 CONSOLE_COLOR_BLUE, CONSOLE_COLOR_MAGENTA, CONSOLE_COLOR_CYAN,
110 static void test_pattern(void)
112 ushort v_max = panel_info.vl_row;
113 ushort h_max = panel_info.vl_col;
114 ushort v_step = (v_max + N_BLK_VERT - 1) / N_BLK_VERT;
115 ushort h_step = (h_max + N_BLK_HOR - 1) / N_BLK_HOR;
117 uchar *pix = (uchar *)lcd_base;
119 printf("[LCD] Test Pattern: %d x %d [%d x %d]\n",
120 h_max, v_max, h_step, v_step);
122 /* WARNING: Code silently assumes 8bit/pixel */
123 for (v = 0; v < v_max; ++v) {
124 uchar iy = v / v_step;
125 for (h = 0; h < h_max; ++h) {
126 uchar ix = N_BLK_HOR * iy + h / h_step;
127 *pix++ = test_colors[ix];
131 #endif /* LCD_TEST_PATTERN */
134 * With most lcd drivers the line length is set up
135 * by calculating it from panel_info parameters. Some
136 * drivers need to calculate the line length differently,
137 * so make the function weak to allow overriding it.
139 __weak int lcd_get_size(int *line_length)
141 *line_length = (panel_info.vl_col * NBITS(panel_info.vl_bpix)) / 8;
142 return *line_length * panel_info.vl_row;
145 int drv_lcd_init(void)
147 struct stdio_dev lcddev;
150 lcd_base = map_sysmem(gd->fb_base, 0);
154 /* Device initialization */
155 memset(&lcddev, 0, sizeof(lcddev));
157 strcpy(lcddev.name, "lcd");
158 lcddev.ext = 0; /* No extensions */
159 lcddev.flags = DEV_FLAGS_OUTPUT; /* Output only */
160 lcddev.putc = lcd_stub_putc; /* 'putc' function */
161 lcddev.puts = lcd_stub_puts; /* 'puts' function */
163 rc = stdio_register(&lcddev);
165 return (rc == 0) ? 1 : rc;
170 short console_rows, console_cols;
172 #if LCD_BPP == LCD_COLOR8
173 /* Setting the palette */
174 lcd_setcolreg(CONSOLE_COLOR_BLACK, 0, 0, 0);
175 lcd_setcolreg(CONSOLE_COLOR_RED, 0xFF, 0, 0);
176 lcd_setcolreg(CONSOLE_COLOR_GREEN, 0, 0xFF, 0);
177 lcd_setcolreg(CONSOLE_COLOR_YELLOW, 0xFF, 0xFF, 0);
178 lcd_setcolreg(CONSOLE_COLOR_BLUE, 0, 0, 0xFF);
179 lcd_setcolreg(CONSOLE_COLOR_MAGENTA, 0xFF, 0, 0xFF);
180 lcd_setcolreg(CONSOLE_COLOR_CYAN, 0, 0xFF, 0xFF);
181 lcd_setcolreg(CONSOLE_COLOR_GREY, 0xAA, 0xAA, 0xAA);
182 lcd_setcolreg(CONSOLE_COLOR_WHITE, 0xFF, 0xFF, 0xFF);
185 #ifndef CONFIG_SYS_WHITE_ON_BLACK
186 lcd_setfgcolor(CONSOLE_COLOR_BLACK);
187 lcd_setbgcolor(CONSOLE_COLOR_WHITE);
188 bg_color = CONSOLE_COLOR_WHITE;
190 lcd_setfgcolor(CONSOLE_COLOR_WHITE);
191 lcd_setbgcolor(CONSOLE_COLOR_BLACK);
192 bg_color = CONSOLE_COLOR_BLACK;
193 #endif /* CONFIG_SYS_WHITE_ON_BLACK */
195 #ifdef LCD_TEST_PATTERN
198 /* set framebuffer to background color */
199 #if (LCD_BPP != LCD_COLOR32)
200 memset((char *)lcd_base, bg_color, lcd_line_length * panel_info.vl_row);
202 u32 *ppix = lcd_base;
205 i < (lcd_line_length * panel_info.vl_row)/NBYTES(panel_info.vl_bpix);
211 /* Paint the logo and retrieve LCD base address */
212 debug("[LCD] Drawing the logo...\n");
213 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
214 console_rows = (panel_info.vl_row - BMP_LOGO_HEIGHT);
215 console_rows /= VIDEO_FONT_HEIGHT;
217 console_rows = panel_info.vl_row / VIDEO_FONT_HEIGHT;
219 console_cols = panel_info.vl_col / VIDEO_FONT_WIDTH;
220 lcd_init_console(lcd_base, console_rows, console_cols);
221 lcd_init_console(lcd_logo(), console_rows, console_cols);
225 static int do_lcd_clear(cmd_tbl_t *cmdtp, int flag, int argc,
231 U_BOOT_CMD(cls, 1, 1, do_lcd_clear, "clear screen", "");
233 static int lcd_init(void *lcdbase)
235 debug("[LCD] Initializing LCD frambuffer at %p\n", lcdbase);
236 lcd_ctrl_init(lcdbase);
239 * lcd_ctrl_init() of some drivers (i.e. bcm2835 on rpi) ignores
240 * the 'lcdbase' argument and uses custom lcd base address
241 * by setting up gd->fb_base. Check for this condition and fixup
242 * 'lcd_base' address.
244 if (map_to_sysmem(lcdbase) != gd->fb_base)
245 lcd_base = map_sysmem(gd->fb_base, 0);
247 debug("[LCD] Using LCD frambuffer at %p\n", lcd_base);
249 lcd_get_size(&lcd_line_length);
254 /* Initialize the console */
256 #ifdef CONFIG_LCD_INFO_BELOW_LOGO
257 lcd_set_row(7 + BMP_LOGO_HEIGHT / VIDEO_FONT_HEIGHT);
259 lcd_set_row(1); /* leave 1 blank line below logo */
266 * This is called early in the system initialization to grab memory
267 * for the LCD controller.
268 * Returns new address for monitor, after reserving LCD buffer memory
270 * Note that this is running from ROM, so no write access to global data.
272 ulong lcd_setmem(ulong addr)
277 debug("LCD panel info: %d x %d, %d bit/pix\n", panel_info.vl_col,
278 panel_info.vl_row, NBITS(panel_info.vl_bpix));
280 size = lcd_get_size(&line_length);
282 /* Round up to nearest full page, or MMU section if defined */
283 size = ALIGN(size, CONFIG_LCD_ALIGNMENT);
284 addr = ALIGN(addr - CONFIG_LCD_ALIGNMENT + 1, CONFIG_LCD_ALIGNMENT);
286 /* Allocate pages for the frame buffer. */
289 debug("Reserving %ldk for LCD Framebuffer at: %08lx\n",
295 static void lcd_setfgcolor(int color)
297 lcd_color_fg = color;
300 int lcd_getfgcolor(void)
305 static void lcd_setbgcolor(int color)
307 lcd_color_bg = color;
310 int lcd_getbgcolor(void)
315 #ifdef CONFIG_LCD_LOGO
316 __weak void lcd_logo_set_cmap(void)
319 ushort *cmap = configuration_get_cmap();
321 for (i = 0; i < ARRAY_SIZE(bmp_logo_palette); ++i)
322 *cmap++ = bmp_logo_palette[i];
325 void lcd_logo_plot(int x, int y)
328 uchar *bmap = &bmp_logo_bitmap[0];
329 unsigned bpix = NBITS(panel_info.vl_bpix);
330 uchar *fb = (uchar *)(lcd_base + y * lcd_line_length + x * bpix / 8);
333 debug("Logo: width %d height %d colors %d\n",
334 BMP_LOGO_WIDTH, BMP_LOGO_HEIGHT, BMP_LOGO_COLORS);
341 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
342 memcpy(fb, bmap, BMP_LOGO_WIDTH);
343 bmap += BMP_LOGO_WIDTH;
344 fb += panel_info.vl_col;
347 else { /* true color mode */
350 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
351 for (j = 0; j < BMP_LOGO_WIDTH; j++) {
352 col16 = bmp_logo_palette[(bmap[j]-16)];
354 ((col16 & 0x000F) << 1) |
355 ((col16 & 0x00F0) << 3) |
356 ((col16 & 0x0F00) << 4);
358 bmap += BMP_LOGO_WIDTH;
359 fb16 += panel_info.vl_col;
367 static inline void lcd_logo_plot(int x, int y) {}
368 #endif /* CONFIG_LCD_LOGO */
370 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
371 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
372 #define BMP_ALIGN_CENTER 0x7FFF
374 static void splash_align_axis(int *axis, unsigned long panel_size,
375 unsigned long picture_size)
377 unsigned long panel_picture_delta = panel_size - picture_size;
378 unsigned long axis_alignment;
380 if (*axis == BMP_ALIGN_CENTER)
381 axis_alignment = panel_picture_delta / 2;
383 axis_alignment = panel_picture_delta + *axis + 1;
387 *axis = max(0, (int)axis_alignment);
391 #ifdef CONFIG_LCD_BMP_RLE8
392 #define BMP_RLE8_ESCAPE 0
393 #define BMP_RLE8_EOL 0
394 #define BMP_RLE8_EOBMP 1
395 #define BMP_RLE8_DELTA 2
397 static void draw_unencoded_bitmap(ushort **fbp, uchar *bmap, ushort *cmap,
401 *(*fbp)++ = cmap[*bmap++];
406 static void draw_encoded_bitmap(ushort **fbp, ushort c, int cnt)
409 int cnt_8copy = cnt >> 3;
411 cnt -= cnt_8copy << 3;
412 while (cnt_8copy > 0) {
431 * Do not call this function directly, must be called from lcd_display_bitmap.
433 static void lcd_display_rle8_bitmap(bmp_image_t *bmp, ushort *cmap, uchar *fb,
434 int x_off, int y_off)
442 width = get_unaligned_le32(&bmp->header.width);
443 height = get_unaligned_le32(&bmp->header.height);
444 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
450 if (bmap[0] == BMP_RLE8_ESCAPE) {
457 /* 16bpix, 2-byte per pixel, width should *2 */
458 fb -= (width * 2 + lcd_line_length);
468 /* 16bpix, 2-byte per pixel, x should *2 */
469 fb = (uchar *) (lcd_base + (y + y_off - 1)
470 * lcd_line_length + (x + x_off) * 2);
479 if (x + runlen > width)
483 draw_unencoded_bitmap(
498 /* aggregate the same code */
499 while (bmap[0] == 0xff &&
500 bmap[2] != BMP_RLE8_ESCAPE &&
501 bmap[1] == bmap[3]) {
505 if (x + runlen > width)
509 draw_encoded_bitmap((ushort **)&fb,
520 __weak void fb_put_byte(uchar **fb, uchar **from)
522 *(*fb)++ = *(*from)++;
525 #if defined(CONFIG_BMP_16BPP)
526 __weak void fb_put_word(uchar **fb, uchar **from)
528 *(*fb)++ = *(*from)++;
529 *(*fb)++ = *(*from)++;
531 #endif /* CONFIG_BMP_16BPP */
533 __weak void lcd_set_cmap(bmp_image_t *bmp, unsigned colors)
536 bmp_color_table_entry_t cte;
537 ushort *cmap = configuration_get_cmap();
539 for (i = 0; i < colors; ++i) {
540 cte = bmp->color_table[i];
541 *cmap = (((cte.red) << 8) & 0xf800) |
542 (((cte.green) << 3) & 0x07e0) |
543 (((cte.blue) >> 3) & 0x001f);
544 #if defined(CONFIG_MPC823)
552 int lcd_display_bitmap(ulong bmp_image, int x, int y)
554 ushort *cmap_base = NULL;
557 bmp_image_t *bmp = (bmp_image_t *)map_sysmem(bmp_image, 0);
560 unsigned long width, height, byte_width;
561 unsigned long pwidth = panel_info.vl_col;
562 unsigned colors, bpix, bmp_bpix;
564 if (!bmp || !(bmp->header.signature[0] == 'B' &&
565 bmp->header.signature[1] == 'M')) {
566 printf("Error: no valid bmp image at %lx\n", bmp_image);
571 width = get_unaligned_le32(&bmp->header.width);
572 height = get_unaligned_le32(&bmp->header.height);
573 bmp_bpix = get_unaligned_le16(&bmp->header.bit_count);
575 colors = 1 << bmp_bpix;
577 bpix = NBITS(panel_info.vl_bpix);
579 if (bpix != 1 && bpix != 8 && bpix != 16 && bpix != 32) {
580 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
587 * We support displaying 8bpp BMPs on 16bpp LCDs
588 * and displaying 24bpp BMPs on 32bpp LCDs
590 if (bpix != bmp_bpix &&
591 !(bmp_bpix == 8 && bpix == 16) &&
592 !(bmp_bpix == 24 && bpix == 32)) {
593 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
594 bpix, get_unaligned_le16(&bmp->header.bit_count));
598 debug("Display-bmp: %d x %d with %d colors\n",
599 (int)width, (int)height, (int)colors);
602 lcd_set_cmap(bmp, colors);
604 padded_width = (width & 0x3 ? (width & ~0x3) + 4 : width);
606 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
607 splash_align_axis(&x, pwidth, width);
608 splash_align_axis(&y, panel_info.vl_row, height);
609 #endif /* CONFIG_SPLASH_SCREEN_ALIGN */
611 if ((x + width) > pwidth)
613 if ((y + height) > panel_info.vl_row)
614 height = panel_info.vl_row - y;
616 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
617 fb = (uchar *)(lcd_base +
618 (y + height - 1) * lcd_line_length + x * bpix / 8);
623 cmap_base = configuration_get_cmap();
624 #ifdef CONFIG_LCD_BMP_RLE8
625 u32 compression = get_unaligned_le32(&bmp->header.compression);
626 if (compression == BMP_BI_RLE8) {
628 /* TODO implement render code for bpix != 16 */
629 printf("Error: only support 16 bpix");
632 lcd_display_rle8_bitmap(bmp, cmap_base, fb, x, y);
640 byte_width = width * 2;
642 for (i = 0; i < height; ++i) {
644 for (j = 0; j < width; j++) {
646 fb_put_byte(&fb, &bmap);
648 *(uint16_t *)fb = cmap_base[*(bmap++)];
649 fb += sizeof(uint16_t) / sizeof(*fb);
652 bmap += (padded_width - width);
653 fb -= byte_width + lcd_line_length;
657 #if defined(CONFIG_BMP_16BPP)
659 for (i = 0; i < height; ++i) {
661 for (j = 0; j < width; j++)
662 fb_put_word(&fb, &bmap);
664 bmap += (padded_width - width) * 2;
665 fb -= width * 2 + lcd_line_length;
668 #endif /* CONFIG_BMP_16BPP */
669 #if defined(CONFIG_BMP_24BMP)
671 for (i = 0; i < height; ++i) {
672 for (j = 0; j < width; j++) {
678 fb -= lcd_line_length + width * (bpix / 8);
681 #endif /* CONFIG_BMP_24BMP */
682 #if defined(CONFIG_BMP_32BPP)
684 for (i = 0; i < height; ++i) {
685 for (j = 0; j < width; j++) {
691 fb -= lcd_line_length + width * (bpix / 8);
694 #endif /* CONFIG_BMP_32BPP */
704 static void *lcd_logo(void)
706 #ifdef CONFIG_SPLASH_SCREEN
709 static int do_splash = 1;
711 if (do_splash && (s = getenv("splashimage")) != NULL) {
715 if (splash_screen_prepare())
716 return (void *)lcd_base;
718 addr = simple_strtoul (s, NULL, 16);
720 splash_get_pos(&x, &y);
722 if (bmp_display(addr, x, y) == 0)
723 return (void *)lcd_base;
725 #endif /* CONFIG_SPLASH_SCREEN */
729 #ifdef CONFIG_LCD_INFO
730 lcd_set_col(LCD_INFO_X / VIDEO_FONT_WIDTH);
731 lcd_set_row(LCD_INFO_Y / VIDEO_FONT_HEIGHT);
732 lcd_show_board_info();
733 #endif /* CONFIG_LCD_INFO */
735 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
736 return (void *)((ulong)lcd_base + BMP_LOGO_HEIGHT * lcd_line_length);
738 return (void *)lcd_base;
739 #endif /* CONFIG_LCD_LOGO && !defined(CONFIG_LCD_INFO_BELOW_LOGO) */
742 #ifdef CONFIG_SPLASHIMAGE_GUARD
743 static int on_splashimage(const char *name, const char *value, enum env_op op,
749 if (op == env_op_delete)
752 addr = simple_strtoul(value, NULL, 16);
753 /* See README.displaying-bmps */
754 aligned = (addr % 4 == 2);
756 printf("Invalid splashimage value. Value must be 16 bit aligned, but not 32 bit aligned\n");
763 U_BOOT_ENV_CALLBACK(splashimage, on_splashimage);
766 int lcd_get_pixel_width(void)
768 return panel_info.vl_col;
771 int lcd_get_pixel_height(void)
773 return panel_info.vl_row;