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
34 #ifndef CONFIG_LCD_ALIGNMENT
35 #define CONFIG_LCD_ALIGNMENT PAGE_SIZE
38 #if (LCD_BPP != LCD_COLOR8) && (LCD_BPP != LCD_COLOR16) && \
39 (LCD_BPP != LCD_COLOR32)
40 #error Unsupported LCD BPP.
43 DECLARE_GLOBAL_DATA_PTR;
45 static int lcd_init(void *lcdbase);
46 static void lcd_logo(void);
47 static void lcd_setfgcolor(int color);
48 static void lcd_setbgcolor(int color);
50 static int lcd_color_fg;
51 static int lcd_color_bg;
53 char lcd_is_enabled = 0;
54 static void *lcd_base; /* Start of framebuffer memory */
55 static char lcd_flush_dcache; /* 1 to flush dcache after each lcd update */
57 /* Flush LCD activity to the caches */
61 * flush_dcache_range() is declared in common.h but it seems that some
62 * architectures do not actually implement it. Is there a way to find
63 * out whether it exists? For now, ARM is safe.
65 #if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
69 flush_dcache_range((ulong)lcd_base,
70 (ulong)(lcd_base + lcd_get_size(&line_length)));
74 void lcd_set_flush_dcache(int flush)
76 lcd_flush_dcache = (flush != 0);
79 static void lcd_stub_putc(struct stdio_dev *dev, const char c)
84 static void lcd_stub_puts(struct stdio_dev *dev, const char *s)
89 /* Small utility to check that you got the colours right */
90 #ifdef LCD_TEST_PATTERN
92 #if LCD_BPP == LCD_COLOR8
96 static int test_colors[N_BLK_HOR * N_BLK_VERT] = {
97 CONSOLE_COLOR_RED, CONSOLE_COLOR_GREEN, CONSOLE_COLOR_YELLOW,
98 CONSOLE_COLOR_BLUE, CONSOLE_COLOR_MAGENTA, CONSOLE_COLOR_CYAN,
99 }; /*LCD_BPP == LCD_COLOR8 */
101 #elif LCD_BPP == LCD_COLOR16
105 static int test_colors[N_BLK_HOR * N_BLK_VERT] = {
106 CONSOLE_COLOR_RED, CONSOLE_COLOR_GREEN, CONSOLE_COLOR_YELLOW, CONSOLE_COLOR_BLUE,
107 CONSOLE_COLOR_MAGENTA, CONSOLE_COLOR_CYAN, CONSOLE_COLOR_GREY, CONSOLE_COLOR_WHITE,
109 #endif /*LCD_BPP == LCD_COLOR16 */
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 #if LCD_BPP == LCD_COLOR8
119 uchar *pix = (uchar *)lcd_base;
120 #elif LCD_BPP == LCD_COLOR16
121 ushort *pix = (ushort *)lcd_base;
124 printf("[LCD] Test Pattern: %d x %d [%d x %d]\n",
125 h_max, v_max, h_step, v_step);
127 for (v = 0; v < v_max; ++v) {
128 uchar iy = v / v_step;
129 for (h = 0; h < h_max; ++h) {
130 uchar ix = N_BLK_HOR * iy + h / h_step;
131 *pix++ = test_colors[ix];
135 #endif /* LCD_TEST_PATTERN */
138 * With most lcd drivers the line length is set up
139 * by calculating it from panel_info parameters. Some
140 * drivers need to calculate the line length differently,
141 * so make the function weak to allow overriding it.
143 __weak int lcd_get_size(int *line_length)
145 *line_length = (panel_info.vl_col * NBITS(panel_info.vl_bpix)) / 8;
146 return *line_length * panel_info.vl_row;
149 int drv_lcd_init(void)
151 struct stdio_dev lcddev;
154 lcd_base = map_sysmem(gd->fb_base, 0);
158 /* Device initialization */
159 memset(&lcddev, 0, sizeof(lcddev));
161 strcpy(lcddev.name, "lcd");
162 lcddev.ext = 0; /* No extensions */
163 lcddev.flags = DEV_FLAGS_OUTPUT; /* Output only */
164 lcddev.putc = lcd_stub_putc; /* 'putc' function */
165 lcddev.puts = lcd_stub_puts; /* 'puts' function */
167 rc = stdio_register(&lcddev);
169 return (rc == 0) ? 1 : rc;
177 static int do_splash = 1;
178 #if LCD_BPP == LCD_COLOR8
179 /* Setting the palette */
180 lcd_setcolreg(CONSOLE_COLOR_BLACK, 0, 0, 0);
181 lcd_setcolreg(CONSOLE_COLOR_RED, 0xFF, 0, 0);
182 lcd_setcolreg(CONSOLE_COLOR_GREEN, 0, 0xFF, 0);
183 lcd_setcolreg(CONSOLE_COLOR_YELLOW, 0xFF, 0xFF, 0);
184 lcd_setcolreg(CONSOLE_COLOR_BLUE, 0, 0, 0xFF);
185 lcd_setcolreg(CONSOLE_COLOR_MAGENTA, 0xFF, 0, 0xFF);
186 lcd_setcolreg(CONSOLE_COLOR_CYAN, 0, 0xFF, 0xFF);
187 lcd_setcolreg(CONSOLE_COLOR_GREY, 0xAA, 0xAA, 0xAA);
188 lcd_setcolreg(CONSOLE_COLOR_WHITE, 0xFF, 0xFF, 0xFF);
191 #ifndef CONFIG_SYS_WHITE_ON_BLACK
192 lcd_setfgcolor(CONSOLE_COLOR_BLACK);
193 lcd_setbgcolor(CONSOLE_COLOR_WHITE);
194 bg_color = CONSOLE_COLOR_WHITE;
196 lcd_setfgcolor(CONSOLE_COLOR_WHITE);
197 lcd_setbgcolor(CONSOLE_COLOR_BLACK);
198 bg_color = CONSOLE_COLOR_BLACK;
199 #endif /* CONFIG_SYS_WHITE_ON_BLACK */
201 #ifdef LCD_TEST_PATTERN
204 /* set framebuffer to background color */
205 #if (LCD_BPP != LCD_COLOR32)
206 memset((char *)lcd_base, bg_color, lcd_line_length * panel_info.vl_row);
208 u32 *ppix = lcd_base;
211 i < (lcd_line_length * panel_info.vl_row)/NBYTES(panel_info.vl_bpix);
217 /* setup text-console */
218 debug("[LCD] setting up console...\n");
219 lcd_init_console(lcd_base,
223 /* Paint the logo and retrieve LCD base address */
224 debug("[LCD] Drawing the logo...\n");
226 s = env_get("splashimage");
229 addr = simple_strtoul(s, NULL, 16);
230 if (lcd_splash(addr) == 0) {
238 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
239 addr = (ulong)lcd_base + BMP_LOGO_HEIGHT * lcd_line_length;
240 lcd_init_console((void *)addr, panel_info.vl_col,
241 panel_info.vl_row, panel_info.vl_rot);
246 static int do_lcd_clear(cmd_tbl_t *cmdtp, int flag, int argc,
252 U_BOOT_CMD(cls, 1, 1, do_lcd_clear, "clear screen", "");
254 static int lcd_init(void *lcdbase)
256 debug("[LCD] Initializing LCD frambuffer at %p\n", lcdbase);
257 lcd_ctrl_init(lcdbase);
260 * lcd_ctrl_init() of some drivers (i.e. bcm2835 on rpi) ignores
261 * the 'lcdbase' argument and uses custom lcd base address
262 * by setting up gd->fb_base. Check for this condition and fixup
263 * 'lcd_base' address.
265 if (map_to_sysmem(lcdbase) != gd->fb_base)
266 lcd_base = map_sysmem(gd->fb_base, 0);
268 debug("[LCD] Using LCD frambuffer at %p\n", lcd_base);
270 lcd_get_size(&lcd_line_length);
275 /* Initialize the console */
277 #ifdef CONFIG_LCD_INFO_BELOW_LOGO
278 lcd_set_row(7 + BMP_LOGO_HEIGHT / VIDEO_FONT_HEIGHT);
280 lcd_set_row(1); /* leave 1 blank line below logo */
287 * This is called early in the system initialization to grab memory
288 * for the LCD controller.
289 * Returns new address for monitor, after reserving LCD buffer memory
291 * Note that this is running from ROM, so no write access to global data.
293 ulong lcd_setmem(ulong addr)
298 debug("LCD panel info: %d x %d, %d bit/pix\n", panel_info.vl_col,
299 panel_info.vl_row, NBITS(panel_info.vl_bpix));
301 size = lcd_get_size(&line_length);
303 /* Round up to nearest full page, or MMU section if defined */
304 size = ALIGN(size, CONFIG_LCD_ALIGNMENT);
305 addr = ALIGN(addr - CONFIG_LCD_ALIGNMENT + 1, CONFIG_LCD_ALIGNMENT);
307 /* Allocate pages for the frame buffer. */
310 debug("Reserving %ldk for LCD Framebuffer at: %08lx\n",
316 static void lcd_setfgcolor(int color)
318 lcd_color_fg = color;
321 int lcd_getfgcolor(void)
326 static void lcd_setbgcolor(int color)
328 lcd_color_bg = color;
331 int lcd_getbgcolor(void)
336 #ifdef CONFIG_LCD_LOGO
337 __weak void lcd_logo_set_cmap(void)
340 ushort *cmap = configuration_get_cmap();
342 for (i = 0; i < ARRAY_SIZE(bmp_logo_palette); ++i)
343 *cmap++ = bmp_logo_palette[i];
346 void lcd_logo_plot(int x, int y)
349 uchar *bmap = &bmp_logo_bitmap[0];
350 unsigned bpix = NBITS(panel_info.vl_bpix);
351 uchar *fb = (uchar *)(lcd_base + y * lcd_line_length + x * bpix / 8);
354 debug("Logo: width %d height %d colors %d\n",
355 BMP_LOGO_WIDTH, BMP_LOGO_HEIGHT, BMP_LOGO_COLORS);
362 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
363 memcpy(fb, bmap, BMP_LOGO_WIDTH);
364 bmap += BMP_LOGO_WIDTH;
365 fb += panel_info.vl_col;
368 else { /* true color mode */
371 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
372 for (j = 0; j < BMP_LOGO_WIDTH; j++) {
373 col16 = bmp_logo_palette[(bmap[j]-16)];
375 ((col16 & 0x000F) << 1) |
376 ((col16 & 0x00F0) << 3) |
377 ((col16 & 0x0F00) << 4);
379 bmap += BMP_LOGO_WIDTH;
380 fb16 += panel_info.vl_col;
388 static inline void lcd_logo_plot(int x, int y) {}
389 #endif /* CONFIG_LCD_LOGO */
391 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
392 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
393 #define BMP_ALIGN_CENTER 0x7FFF
395 static void splash_align_axis(int *axis, unsigned long panel_size,
396 unsigned long picture_size)
398 unsigned long panel_picture_delta = panel_size - picture_size;
399 unsigned long axis_alignment;
401 if (*axis == BMP_ALIGN_CENTER)
402 axis_alignment = panel_picture_delta / 2;
404 axis_alignment = panel_picture_delta + *axis + 1;
408 *axis = max(0, (int)axis_alignment);
412 #ifdef CONFIG_LCD_BMP_RLE8
413 #define BMP_RLE8_ESCAPE 0
414 #define BMP_RLE8_EOL 0
415 #define BMP_RLE8_EOBMP 1
416 #define BMP_RLE8_DELTA 2
418 static void draw_unencoded_bitmap(ushort **fbp, uchar *bmap, ushort *cmap,
422 *(*fbp)++ = cmap[*bmap++];
427 static void draw_encoded_bitmap(ushort **fbp, ushort c, int cnt)
430 int cnt_8copy = cnt >> 3;
432 cnt -= cnt_8copy << 3;
433 while (cnt_8copy > 0) {
452 * Do not call this function directly, must be called from lcd_display_bitmap.
454 static void lcd_display_rle8_bitmap(struct bmp_image *bmp, ushort *cmap,
455 uchar *fb, int x_off, int y_off)
463 width = get_unaligned_le32(&bmp->header.width);
464 height = get_unaligned_le32(&bmp->header.height);
465 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
471 if (bmap[0] == BMP_RLE8_ESCAPE) {
478 /* 16bpix, 2-byte per pixel, width should *2 */
479 fb -= (width * 2 + lcd_line_length);
489 /* 16bpix, 2-byte per pixel, x should *2 */
490 fb = (uchar *) (lcd_base + (y + y_off - 1)
491 * lcd_line_length + (x + x_off) * 2);
500 if (x + runlen > width)
504 draw_unencoded_bitmap(
519 /* aggregate the same code */
520 while (bmap[0] == 0xff &&
521 bmap[2] != BMP_RLE8_ESCAPE &&
522 bmap[1] == bmap[3]) {
526 if (x + runlen > width)
530 draw_encoded_bitmap((ushort **)&fb,
541 __weak void fb_put_byte(uchar **fb, uchar **from)
543 *(*fb)++ = *(*from)++;
546 #if defined(CONFIG_BMP_16BPP)
547 __weak void fb_put_word(uchar **fb, uchar **from)
549 *(*fb)++ = *(*from)++;
550 *(*fb)++ = *(*from)++;
552 #endif /* CONFIG_BMP_16BPP */
554 __weak void lcd_set_cmap(struct bmp_image *bmp, unsigned colors)
557 struct bmp_color_table_entry cte;
558 ushort *cmap = configuration_get_cmap();
560 for (i = 0; i < colors; ++i) {
561 cte = bmp->color_table[i];
562 *cmap = (((cte.red) << 8) & 0xf800) |
563 (((cte.green) << 3) & 0x07e0) |
564 (((cte.blue) >> 3) & 0x001f);
569 int lcd_display_bitmap(ulong bmp_image, int x, int y)
571 ushort *cmap_base = NULL;
574 struct bmp_image *bmp = (struct bmp_image *)map_sysmem(bmp_image, 0);
577 unsigned long width, height, byte_width;
578 unsigned long pwidth = panel_info.vl_col;
579 unsigned colors, bpix, bmp_bpix;
581 struct bmp_color_table_entry *palette = bmp->color_table;
583 if (!bmp || !(bmp->header.signature[0] == 'B' &&
584 bmp->header.signature[1] == 'M')) {
585 printf("Error: no valid bmp image at %lx\n", bmp_image);
590 width = get_unaligned_le32(&bmp->header.width);
591 height = get_unaligned_le32(&bmp->header.height);
592 bmp_bpix = get_unaligned_le16(&bmp->header.bit_count);
593 hdr_size = get_unaligned_le16(&bmp->header.size);
594 debug("hdr_size=%d, bmp_bpix=%d\n", hdr_size, bmp_bpix);
596 colors = 1 << bmp_bpix;
598 bpix = NBITS(panel_info.vl_bpix);
600 if (bpix != 1 && bpix != 8 && bpix != 16 && bpix != 32) {
601 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
608 * We support displaying 8bpp BMPs on 16bpp LCDs
609 * and displaying 24bpp BMPs on 32bpp LCDs
611 if (bpix != bmp_bpix &&
612 !(bmp_bpix == 8 && bpix == 16) &&
613 !(bmp_bpix == 24 && bpix == 32)) {
614 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
615 bpix, get_unaligned_le16(&bmp->header.bit_count));
619 debug("Display-bmp: %d x %d with %d colors, display %d\n",
620 (int)width, (int)height, (int)colors, 1 << bpix);
623 lcd_set_cmap(bmp, colors);
625 padded_width = (width & 0x3 ? (width & ~0x3) + 4 : width);
627 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
628 splash_align_axis(&x, pwidth, width);
629 splash_align_axis(&y, panel_info.vl_row, height);
630 #endif /* CONFIG_SPLASH_SCREEN_ALIGN */
632 if ((x + width) > pwidth)
634 if ((y + height) > panel_info.vl_row)
635 height = panel_info.vl_row - y;
637 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
638 fb = (uchar *)(lcd_base +
639 (y + height - 1) * lcd_line_length + x * bpix / 8);
644 cmap_base = configuration_get_cmap();
645 #ifdef CONFIG_LCD_BMP_RLE8
646 u32 compression = get_unaligned_le32(&bmp->header.compression);
647 debug("compressed %d %d\n", compression, BMP_BI_RLE8);
648 if (compression == BMP_BI_RLE8) {
650 /* TODO implement render code for bpix != 16 */
651 printf("Error: only support 16 bpix");
654 lcd_display_rle8_bitmap(bmp, cmap_base, fb, x, y);
662 byte_width = width * 2;
664 for (i = 0; i < height; ++i) {
666 for (j = 0; j < width; j++) {
668 fb_put_byte(&fb, &bmap);
670 struct bmp_color_table_entry *entry;
674 val = cmap_base[*bmap];
676 entry = &palette[*bmap];
677 val = entry->blue >> 3 |
678 entry->green >> 2 << 5 |
679 entry->red >> 3 << 11;
681 *(uint16_t *)fb = val;
683 fb += sizeof(uint16_t) / sizeof(*fb);
686 bmap += (padded_width - width);
687 fb -= byte_width + lcd_line_length;
691 #if defined(CONFIG_BMP_16BPP)
693 for (i = 0; i < height; ++i) {
695 for (j = 0; j < width; j++)
696 fb_put_word(&fb, &bmap);
698 bmap += (padded_width - width) * 2;
699 fb -= width * 2 + lcd_line_length;
702 #endif /* CONFIG_BMP_16BPP */
703 #if defined(CONFIG_BMP_24BPP)
705 for (i = 0; i < height; ++i) {
706 for (j = 0; j < width; j++) {
712 fb -= lcd_line_length + width * (bpix / 8);
715 #endif /* CONFIG_BMP_24BPP */
716 #if defined(CONFIG_BMP_32BPP)
718 for (i = 0; i < height; ++i) {
719 for (j = 0; j < width; j++) {
725 fb -= lcd_line_length + width * (bpix / 8);
728 #endif /* CONFIG_BMP_32BPP */
738 static void lcd_logo(void)
742 #ifdef CONFIG_LCD_INFO
743 lcd_set_col(LCD_INFO_X / VIDEO_FONT_WIDTH);
744 lcd_set_row(LCD_INFO_Y / VIDEO_FONT_HEIGHT);
745 lcd_show_board_info();
746 #endif /* CONFIG_LCD_INFO */
749 #ifdef CONFIG_SPLASHIMAGE_GUARD
750 static int on_splashimage(const char *name, const char *value, enum env_op op,
756 if (op == env_op_delete)
759 addr = simple_strtoul(value, NULL, 16);
760 /* See README.displaying-bmps */
761 aligned = (addr % 4 == 2);
763 printf("Invalid splashimage value. Value must be 16 bit aligned, but not 32 bit aligned\n");
770 U_BOOT_ENV_CALLBACK(splashimage, on_splashimage);
773 int lcd_get_pixel_width(void)
775 return panel_info.vl_col;
778 int lcd_get_pixel_height(void)
780 return panel_info.vl_row;