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>
20 #include <asm/unaligned.h>
23 #include <asm/unaligned.h>
24 #include <video_font.h>
26 #ifdef CONFIG_LCD_LOGO
28 #include <bmp_logo_data.h>
29 #if (CONSOLE_COLOR_WHITE >= BMP_LOGO_OFFSET) && (LCD_BPP != LCD_COLOR16)
30 #error Default Color Map overlaps with Logo Color Map
38 #ifndef CONFIG_LCD_ALIGNMENT
39 #define CONFIG_LCD_ALIGNMENT PAGE_SIZE
42 #if (LCD_BPP != LCD_COLOR8) && (LCD_BPP != LCD_COLOR16) && \
43 (LCD_BPP != LCD_COLOR32)
44 #error Unsupported LCD BPP.
47 DECLARE_GLOBAL_DATA_PTR;
49 static int lcd_init(void *lcdbase);
50 static void lcd_logo(void);
51 static void lcd_setfgcolor(int color);
52 static void lcd_setbgcolor(int color);
54 static int lcd_color_fg;
55 static int lcd_color_bg;
57 char lcd_is_enabled = 0;
58 static void *lcd_base; /* Start of framebuffer memory */
59 static char lcd_flush_dcache; /* 1 to flush dcache after each lcd update */
61 /* Flush LCD activity to the caches */
65 * flush_dcache_range() is declared in common.h but it seems that some
66 * architectures do not actually implement it. Is there a way to find
67 * out whether it exists? For now, ARM is safe.
69 #if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
73 flush_dcache_range((u32)lcd_base,
74 (u32)(lcd_base + lcd_get_size(&line_length)));
75 #elif defined(CONFIG_SANDBOX) && defined(CONFIG_VIDEO_SANDBOX_SDL)
76 static ulong last_sync;
78 if (get_timer(last_sync) > 10) {
79 sandbox_sdl_sync(lcd_base);
80 last_sync = get_timer(0);
85 void lcd_set_flush_dcache(int flush)
87 lcd_flush_dcache = (flush != 0);
90 static void lcd_stub_putc(struct stdio_dev *dev, const char c)
95 static void lcd_stub_puts(struct stdio_dev *dev, const char *s)
100 /* Small utility to check that you got the colours right */
101 #ifdef LCD_TEST_PATTERN
106 static int test_colors[N_BLK_HOR * N_BLK_VERT] = {
107 CONSOLE_COLOR_RED, CONSOLE_COLOR_GREEN, CONSOLE_COLOR_YELLOW,
108 CONSOLE_COLOR_BLUE, CONSOLE_COLOR_MAGENTA, CONSOLE_COLOR_CYAN,
111 static void test_pattern(void)
113 ushort v_max = panel_info.vl_row;
114 ushort h_max = panel_info.vl_col;
115 ushort v_step = (v_max + N_BLK_VERT - 1) / N_BLK_VERT;
116 ushort h_step = (h_max + N_BLK_HOR - 1) / N_BLK_HOR;
118 uchar *pix = (uchar *)lcd_base;
120 printf("[LCD] Test Pattern: %d x %d [%d x %d]\n",
121 h_max, v_max, h_step, v_step);
123 /* WARNING: Code silently assumes 8bit/pixel */
124 for (v = 0; v < v_max; ++v) {
125 uchar iy = v / v_step;
126 for (h = 0; h < h_max; ++h) {
127 uchar ix = N_BLK_HOR * iy + h / h_step;
128 *pix++ = test_colors[ix];
132 #endif /* LCD_TEST_PATTERN */
135 * With most lcd drivers the line length is set up
136 * by calculating it from panel_info parameters. Some
137 * drivers need to calculate the line length differently,
138 * so make the function weak to allow overriding it.
140 __weak int lcd_get_size(int *line_length)
142 *line_length = (panel_info.vl_col * NBITS(panel_info.vl_bpix)) / 8;
143 return *line_length * panel_info.vl_row;
147 * Implement a weak default function for boards that optionally
148 * need to skip the lcd console initialization.
150 __weak int board_lcd_console_skip(void)
152 /* As default, don't skip cfb init */
156 int drv_lcd_init(void)
158 struct stdio_dev lcddev;
161 lcd_base = map_sysmem(gd->fb_base, 0);
165 if (board_lcd_console_skip())
168 /* Device initialization */
169 memset(&lcddev, 0, sizeof(lcddev));
171 strcpy(lcddev.name, "lcd");
172 lcddev.ext = 0; /* No extensions */
173 lcddev.flags = DEV_FLAGS_OUTPUT; /* Output only */
174 lcddev.putc = lcd_stub_putc; /* 'putc' function */
175 lcddev.puts = lcd_stub_puts; /* 'puts' function */
177 rc = stdio_register(&lcddev);
179 return (rc == 0) ? 1 : rc;
187 static int do_splash = 1;
188 #if LCD_BPP == LCD_COLOR8
189 /* Setting the palette */
190 lcd_setcolreg(CONSOLE_COLOR_BLACK, 0, 0, 0);
191 lcd_setcolreg(CONSOLE_COLOR_RED, 0xFF, 0, 0);
192 lcd_setcolreg(CONSOLE_COLOR_GREEN, 0, 0xFF, 0);
193 lcd_setcolreg(CONSOLE_COLOR_YELLOW, 0xFF, 0xFF, 0);
194 lcd_setcolreg(CONSOLE_COLOR_BLUE, 0, 0, 0xFF);
195 lcd_setcolreg(CONSOLE_COLOR_MAGENTA, 0xFF, 0, 0xFF);
196 lcd_setcolreg(CONSOLE_COLOR_CYAN, 0, 0xFF, 0xFF);
197 lcd_setcolreg(CONSOLE_COLOR_GREY, 0xAA, 0xAA, 0xAA);
198 lcd_setcolreg(CONSOLE_COLOR_WHITE, 0xFF, 0xFF, 0xFF);
201 #ifndef CONFIG_SYS_WHITE_ON_BLACK
202 lcd_setfgcolor(CONSOLE_COLOR_BLACK);
203 lcd_setbgcolor(CONSOLE_COLOR_WHITE);
204 bg_color = CONSOLE_COLOR_WHITE;
206 lcd_setfgcolor(CONSOLE_COLOR_WHITE);
207 lcd_setbgcolor(CONSOLE_COLOR_BLACK);
208 bg_color = CONSOLE_COLOR_BLACK;
209 #endif /* CONFIG_SYS_WHITE_ON_BLACK */
211 #ifdef LCD_TEST_PATTERN
214 /* set framebuffer to background color */
215 #if (LCD_BPP != LCD_COLOR32)
216 memset((char *)lcd_base, bg_color, lcd_line_length * panel_info.vl_row);
218 u32 *ppix = lcd_base;
221 i < (lcd_line_length * panel_info.vl_row)/NBYTES(panel_info.vl_bpix);
227 /* setup text-console */
228 debug("[LCD] setting up console...\n");
229 lcd_init_console(lcd_base,
233 /* Paint the logo and retrieve LCD base address */
234 debug("[LCD] Drawing the logo...\n");
236 s = getenv("splashimage");
239 addr = simple_strtoul(s, NULL, 16);
240 if (lcd_splash(addr) == 0) {
248 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
249 addr = (ulong)lcd_base + BMP_LOGO_HEIGHT * lcd_line_length;
250 lcd_init_console((void *)addr, panel_info.vl_col,
251 panel_info.vl_row, panel_info.vl_rot);
256 static int do_lcd_clear(cmd_tbl_t *cmdtp, int flag, int argc,
262 U_BOOT_CMD(cls, 1, 1, do_lcd_clear, "clear screen", "");
264 static int lcd_init(void *lcdbase)
266 debug("[LCD] Initializing LCD frambuffer at %p\n", lcdbase);
267 lcd_ctrl_init(lcdbase);
270 * lcd_ctrl_init() of some drivers (i.e. bcm2835 on rpi) ignores
271 * the 'lcdbase' argument and uses custom lcd base address
272 * by setting up gd->fb_base. Check for this condition and fixup
273 * 'lcd_base' address.
275 if (map_to_sysmem(lcdbase) != gd->fb_base)
276 lcd_base = map_sysmem(gd->fb_base, 0);
278 debug("[LCD] Using LCD frambuffer at %p\n", lcd_base);
280 lcd_get_size(&lcd_line_length);
285 /* Initialize the console */
287 #ifdef CONFIG_LCD_INFO_BELOW_LOGO
288 lcd_set_row(7 + BMP_LOGO_HEIGHT / VIDEO_FONT_HEIGHT);
290 lcd_set_row(1); /* leave 1 blank line below logo */
297 * This is called early in the system initialization to grab memory
298 * for the LCD controller.
299 * Returns new address for monitor, after reserving LCD buffer memory
301 * Note that this is running from ROM, so no write access to global data.
303 ulong lcd_setmem(ulong addr)
308 debug("LCD panel info: %d x %d, %d bit/pix\n", panel_info.vl_col,
309 panel_info.vl_row, NBITS(panel_info.vl_bpix));
311 size = lcd_get_size(&line_length);
313 /* Round up to nearest full page, or MMU section if defined */
314 size = ALIGN(size, CONFIG_LCD_ALIGNMENT);
315 addr = ALIGN(addr - CONFIG_LCD_ALIGNMENT + 1, CONFIG_LCD_ALIGNMENT);
317 /* Allocate pages for the frame buffer. */
320 debug("Reserving %ldk for LCD Framebuffer at: %08lx\n",
326 static void lcd_setfgcolor(int color)
328 lcd_color_fg = color;
331 int lcd_getfgcolor(void)
336 static void lcd_setbgcolor(int color)
338 lcd_color_bg = color;
341 int lcd_getbgcolor(void)
346 #ifdef CONFIG_LCD_LOGO
347 __weak void lcd_logo_set_cmap(void)
350 ushort *cmap = configuration_get_cmap();
352 for (i = 0; i < ARRAY_SIZE(bmp_logo_palette); ++i)
353 *cmap++ = bmp_logo_palette[i];
356 void lcd_logo_plot(int x, int y)
359 uchar *bmap = &bmp_logo_bitmap[0];
360 unsigned bpix = NBITS(panel_info.vl_bpix);
361 uchar *fb = (uchar *)(lcd_base + y * lcd_line_length + x * bpix / 8);
364 debug("Logo: width %d height %d colors %d\n",
365 BMP_LOGO_WIDTH, BMP_LOGO_HEIGHT, BMP_LOGO_COLORS);
372 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
373 memcpy(fb, bmap, BMP_LOGO_WIDTH);
374 bmap += BMP_LOGO_WIDTH;
375 fb += panel_info.vl_col;
378 else { /* true color mode */
381 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
382 for (j = 0; j < BMP_LOGO_WIDTH; j++) {
383 col16 = bmp_logo_palette[(bmap[j]-16)];
385 ((col16 & 0x000F) << 1) |
386 ((col16 & 0x00F0) << 3) |
387 ((col16 & 0x0F00) << 4);
389 bmap += BMP_LOGO_WIDTH;
390 fb16 += panel_info.vl_col;
398 static inline void lcd_logo_plot(int x, int y) {}
399 #endif /* CONFIG_LCD_LOGO */
401 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
402 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
403 #define BMP_ALIGN_CENTER 0x7FFF
405 static void splash_align_axis(int *axis, unsigned long panel_size,
406 unsigned long picture_size)
408 unsigned long panel_picture_delta = panel_size - picture_size;
409 unsigned long axis_alignment;
411 if (*axis == BMP_ALIGN_CENTER)
412 axis_alignment = panel_picture_delta / 2;
414 axis_alignment = panel_picture_delta + *axis + 1;
418 *axis = max(0, (int)axis_alignment);
422 #ifdef CONFIG_LCD_BMP_RLE8
423 #define BMP_RLE8_ESCAPE 0
424 #define BMP_RLE8_EOL 0
425 #define BMP_RLE8_EOBMP 1
426 #define BMP_RLE8_DELTA 2
428 static void draw_unencoded_bitmap(ushort **fbp, uchar *bmap, ushort *cmap,
432 *(*fbp)++ = cmap[*bmap++];
437 static void draw_encoded_bitmap(ushort **fbp, ushort c, int cnt)
440 int cnt_8copy = cnt >> 3;
442 cnt -= cnt_8copy << 3;
443 while (cnt_8copy > 0) {
462 * Do not call this function directly, must be called from lcd_display_bitmap.
464 static void lcd_display_rle8_bitmap(struct bmp_image *bmp, ushort *cmap,
465 uchar *fb, int x_off, int y_off)
473 width = get_unaligned_le32(&bmp->header.width);
474 height = get_unaligned_le32(&bmp->header.height);
475 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
481 if (bmap[0] == BMP_RLE8_ESCAPE) {
488 /* 16bpix, 2-byte per pixel, width should *2 */
489 fb -= (width * 2 + lcd_line_length);
499 /* 16bpix, 2-byte per pixel, x should *2 */
500 fb = (uchar *) (lcd_base + (y + y_off - 1)
501 * lcd_line_length + (x + x_off) * 2);
510 if (x + runlen > width)
514 draw_unencoded_bitmap(
529 /* aggregate the same code */
530 while (bmap[0] == 0xff &&
531 bmap[2] != BMP_RLE8_ESCAPE &&
532 bmap[1] == bmap[3]) {
536 if (x + runlen > width)
540 draw_encoded_bitmap((ushort **)&fb,
551 __weak void fb_put_byte(uchar **fb, uchar **from)
553 *(*fb)++ = *(*from)++;
556 #if defined(CONFIG_BMP_16BPP)
557 __weak void fb_put_word(uchar **fb, uchar **from)
559 *(*fb)++ = *(*from)++;
560 *(*fb)++ = *(*from)++;
562 #endif /* CONFIG_BMP_16BPP */
564 __weak void lcd_set_cmap(struct bmp_image *bmp, unsigned colors)
567 struct bmp_color_table_entry cte;
568 ushort *cmap = configuration_get_cmap();
570 for (i = 0; i < colors; ++i) {
571 cte = bmp->color_table[i];
572 *cmap = (((cte.red) << 8) & 0xf800) |
573 (((cte.green) << 3) & 0x07e0) |
574 (((cte.blue) >> 3) & 0x001f);
575 #if defined(CONFIG_MPC823)
583 int lcd_display_bitmap(ulong bmp_image, int x, int y)
585 ushort *cmap_base = NULL;
588 struct bmp_image *bmp = (struct bmp_image *)map_sysmem(bmp_image, 0);
591 unsigned long width, height, byte_width;
592 unsigned long pwidth = panel_info.vl_col;
593 unsigned colors, bpix, bmp_bpix;
595 struct bmp_color_table_entry *palette = bmp->color_table;
597 if (!bmp || !(bmp->header.signature[0] == 'B' &&
598 bmp->header.signature[1] == 'M')) {
599 printf("Error: no valid bmp image at %lx\n", bmp_image);
604 width = get_unaligned_le32(&bmp->header.width);
605 height = get_unaligned_le32(&bmp->header.height);
606 bmp_bpix = get_unaligned_le16(&bmp->header.bit_count);
607 hdr_size = get_unaligned_le16(&bmp->header.size);
608 debug("hdr_size=%d, bmp_bpix=%d\n", hdr_size, bmp_bpix);
610 colors = 1 << bmp_bpix;
612 bpix = NBITS(panel_info.vl_bpix);
614 if (bpix != 1 && bpix != 8 && bpix != 16 && bpix != 32) {
615 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
622 * We support displaying 8bpp BMPs on 16bpp LCDs
623 * and displaying 24bpp BMPs on 32bpp LCDs
625 if (bpix != bmp_bpix &&
626 !(bmp_bpix == 8 && bpix == 16) &&
627 !(bmp_bpix == 24 && bpix == 32)) {
628 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
629 bpix, get_unaligned_le16(&bmp->header.bit_count));
633 debug("Display-bmp: %d x %d with %d colors, display %d\n",
634 (int)width, (int)height, (int)colors, 1 << bpix);
637 lcd_set_cmap(bmp, colors);
639 padded_width = (width & 0x3 ? (width & ~0x3) + 4 : width);
641 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
642 splash_align_axis(&x, pwidth, width);
643 splash_align_axis(&y, panel_info.vl_row, height);
644 #endif /* CONFIG_SPLASH_SCREEN_ALIGN */
646 if ((x + width) > pwidth)
648 if ((y + height) > panel_info.vl_row)
649 height = panel_info.vl_row - y;
651 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
652 fb = (uchar *)(lcd_base +
653 (y + height - 1) * lcd_line_length + x * bpix / 8);
658 cmap_base = configuration_get_cmap();
659 #ifdef CONFIG_LCD_BMP_RLE8
660 u32 compression = get_unaligned_le32(&bmp->header.compression);
661 debug("compressed %d %d\n", compression, BMP_BI_RLE8);
662 if (compression == BMP_BI_RLE8) {
664 /* TODO implement render code for bpix != 16 */
665 printf("Error: only support 16 bpix");
668 lcd_display_rle8_bitmap(bmp, cmap_base, fb, x, y);
676 byte_width = width * 2;
678 for (i = 0; i < height; ++i) {
680 for (j = 0; j < width; j++) {
682 fb_put_byte(&fb, &bmap);
684 struct bmp_color_table_entry *entry;
688 val = cmap_base[*bmap];
690 entry = &palette[*bmap];
691 val = entry->blue >> 3 |
692 entry->green >> 2 << 5 |
693 entry->red >> 3 << 11;
695 *(uint16_t *)fb = val;
697 fb += sizeof(uint16_t) / sizeof(*fb);
700 bmap += (padded_width - width);
701 fb -= byte_width + lcd_line_length;
705 #if defined(CONFIG_BMP_16BPP)
707 for (i = 0; i < height; ++i) {
709 for (j = 0; j < width; j++)
710 fb_put_word(&fb, &bmap);
712 bmap += (padded_width - width) * 2;
713 fb -= width * 2 + lcd_line_length;
716 #endif /* CONFIG_BMP_16BPP */
717 #if defined(CONFIG_BMP_24BMP)
719 for (i = 0; i < height; ++i) {
720 for (j = 0; j < width; j++) {
726 fb -= lcd_line_length + width * (bpix / 8);
729 #endif /* CONFIG_BMP_24BMP */
730 #if defined(CONFIG_BMP_32BPP)
732 for (i = 0; i < height; ++i) {
733 for (j = 0; j < width; j++) {
739 fb -= lcd_line_length + width * (bpix / 8);
742 #endif /* CONFIG_BMP_32BPP */
752 static void lcd_logo(void)
756 #ifdef CONFIG_LCD_INFO
757 lcd_set_col(LCD_INFO_X / VIDEO_FONT_WIDTH);
758 lcd_set_row(LCD_INFO_Y / VIDEO_FONT_HEIGHT);
759 lcd_show_board_info();
760 #endif /* CONFIG_LCD_INFO */
763 #ifdef CONFIG_SPLASHIMAGE_GUARD
764 static int on_splashimage(const char *name, const char *value, enum env_op op,
770 if (op == env_op_delete)
773 addr = simple_strtoul(value, NULL, 16);
774 /* See README.displaying-bmps */
775 aligned = (addr % 4 == 2);
777 printf("Invalid splashimage value. Value must be 16 bit aligned, but not 32 bit aligned\n");
784 U_BOOT_ENV_CALLBACK(splashimage, on_splashimage);
787 int lcd_get_pixel_width(void)
789 return panel_info.vl_col;
792 int lcd_get_pixel_height(void)
794 return panel_info.vl_row;