1 // SPDX-License-Identifier: GPL-2.0+
5 * (C) Copyright 2001-2002
6 * Wolfgang Denk, DENX Software Engineering -- wd@denx.de
14 #include <env_callback.h>
16 #include <asm/cache.h>
18 #include <linux/types.h>
19 #include <stdio_dev.h>
23 #include <asm/unaligned.h>
26 #include <asm/unaligned.h>
27 #include <video_font.h>
29 #ifdef CONFIG_LCD_LOGO
31 #include <bmp_logo_data.h>
32 #if (CONSOLE_COLOR_WHITE >= BMP_LOGO_OFFSET) && (LCD_BPP != LCD_COLOR16)
33 #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) && !CONFIG_IS_ENABLED(SYS_DCACHE_OFF)
72 flush_dcache_range((ulong)lcd_base,
73 (ulong)(lcd_base + lcd_get_size(&line_length)));
77 void lcd_set_flush_dcache(int flush)
79 lcd_flush_dcache = (flush != 0);
82 static void lcd_stub_putc(struct stdio_dev *dev, const char c)
87 static void lcd_stub_puts(struct stdio_dev *dev, const char *s)
92 /* Small utility to check that you got the colours right */
93 #ifdef LCD_TEST_PATTERN
95 #if LCD_BPP == LCD_COLOR8
99 static int test_colors[N_BLK_HOR * N_BLK_VERT] = {
100 CONSOLE_COLOR_RED, CONSOLE_COLOR_GREEN, CONSOLE_COLOR_YELLOW,
101 CONSOLE_COLOR_BLUE, CONSOLE_COLOR_MAGENTA, CONSOLE_COLOR_CYAN,
102 }; /*LCD_BPP == LCD_COLOR8 */
104 #elif LCD_BPP == LCD_COLOR16
108 static int test_colors[N_BLK_HOR * N_BLK_VERT] = {
109 CONSOLE_COLOR_RED, CONSOLE_COLOR_GREEN, CONSOLE_COLOR_YELLOW, CONSOLE_COLOR_BLUE,
110 CONSOLE_COLOR_MAGENTA, CONSOLE_COLOR_CYAN, CONSOLE_COLOR_GREY, CONSOLE_COLOR_WHITE,
112 #endif /*LCD_BPP == LCD_COLOR16 */
114 static void test_pattern(void)
116 ushort v_max = panel_info.vl_row;
117 ushort h_max = panel_info.vl_col;
118 ushort v_step = (v_max + N_BLK_VERT - 1) / N_BLK_VERT;
119 ushort h_step = (h_max + N_BLK_HOR - 1) / N_BLK_HOR;
121 #if LCD_BPP == LCD_COLOR8
122 uchar *pix = (uchar *)lcd_base;
123 #elif LCD_BPP == LCD_COLOR16
124 ushort *pix = (ushort *)lcd_base;
127 printf("[LCD] Test Pattern: %d x %d [%d x %d]\n",
128 h_max, v_max, h_step, v_step);
130 for (v = 0; v < v_max; ++v) {
131 uchar iy = v / v_step;
132 for (h = 0; h < h_max; ++h) {
133 uchar ix = N_BLK_HOR * iy + h / h_step;
134 *pix++ = test_colors[ix];
138 #endif /* LCD_TEST_PATTERN */
141 * With most lcd drivers the line length is set up
142 * by calculating it from panel_info parameters. Some
143 * drivers need to calculate the line length differently,
144 * so make the function weak to allow overriding it.
146 __weak int lcd_get_size(int *line_length)
148 *line_length = (panel_info.vl_col * NBITS(panel_info.vl_bpix)) / 8;
149 return *line_length * panel_info.vl_row;
152 int drv_lcd_init(void)
154 struct stdio_dev lcddev;
157 lcd_base = map_sysmem(gd->fb_base, 0);
161 /* Device initialization */
162 memset(&lcddev, 0, sizeof(lcddev));
164 strcpy(lcddev.name, "lcd");
165 lcddev.ext = 0; /* No extensions */
166 lcddev.flags = DEV_FLAGS_OUTPUT; /* Output only */
167 lcddev.putc = lcd_stub_putc; /* 'putc' function */
168 lcddev.puts = lcd_stub_puts; /* 'puts' function */
170 rc = stdio_register(&lcddev);
172 return (rc == 0) ? 1 : rc;
178 __maybe_unused ulong addr;
179 static int do_splash = 1;
180 #if LCD_BPP == LCD_COLOR8
181 /* Setting the palette */
182 lcd_setcolreg(CONSOLE_COLOR_BLACK, 0, 0, 0);
183 lcd_setcolreg(CONSOLE_COLOR_RED, 0xFF, 0, 0);
184 lcd_setcolreg(CONSOLE_COLOR_GREEN, 0, 0xFF, 0);
185 lcd_setcolreg(CONSOLE_COLOR_YELLOW, 0xFF, 0xFF, 0);
186 lcd_setcolreg(CONSOLE_COLOR_BLUE, 0, 0, 0xFF);
187 lcd_setcolreg(CONSOLE_COLOR_MAGENTA, 0xFF, 0, 0xFF);
188 lcd_setcolreg(CONSOLE_COLOR_CYAN, 0, 0xFF, 0xFF);
189 lcd_setcolreg(CONSOLE_COLOR_GREY, 0xAA, 0xAA, 0xAA);
190 lcd_setcolreg(CONSOLE_COLOR_WHITE, 0xFF, 0xFF, 0xFF);
193 #ifndef CONFIG_SYS_WHITE_ON_BLACK
194 lcd_setfgcolor(CONSOLE_COLOR_BLACK);
195 lcd_setbgcolor(CONSOLE_COLOR_WHITE);
196 bg_color = CONSOLE_COLOR_WHITE;
198 lcd_setfgcolor(CONSOLE_COLOR_WHITE);
199 lcd_setbgcolor(CONSOLE_COLOR_BLACK);
200 bg_color = CONSOLE_COLOR_BLACK;
201 #endif /* CONFIG_SYS_WHITE_ON_BLACK */
203 #ifdef LCD_TEST_PATTERN
206 /* set framebuffer to background color */
207 #if (LCD_BPP != LCD_COLOR32)
208 memset((char *)lcd_base, bg_color, lcd_line_length * panel_info.vl_row);
210 u32 *ppix = lcd_base;
213 i < (lcd_line_length * panel_info.vl_row)/NBYTES(panel_info.vl_bpix);
219 /* setup text-console */
220 debug("[LCD] setting up console...\n");
221 lcd_init_console(lcd_base,
225 /* Paint the logo and retrieve LCD base address */
226 debug("[LCD] Drawing the logo...\n");
228 if (splash_display() == 0) {
236 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
237 addr = (ulong)lcd_base + BMP_LOGO_HEIGHT * lcd_line_length;
238 lcd_init_console((void *)addr, panel_info.vl_col,
239 panel_info.vl_row, panel_info.vl_rot);
244 static int lcd_init(void *lcdbase)
246 debug("[LCD] Initializing LCD frambuffer at %p\n", lcdbase);
247 lcd_ctrl_init(lcdbase);
250 * lcd_ctrl_init() of some drivers (i.e. bcm2835 on rpi) ignores
251 * the 'lcdbase' argument and uses custom lcd base address
252 * by setting up gd->fb_base. Check for this condition and fixup
253 * 'lcd_base' address.
255 if (map_to_sysmem(lcdbase) != gd->fb_base)
256 lcd_base = map_sysmem(gd->fb_base, 0);
258 debug("[LCD] Using LCD frambuffer at %p\n", lcd_base);
260 lcd_get_size(&lcd_line_length);
265 /* Initialize the console */
267 #ifdef CONFIG_LCD_INFO_BELOW_LOGO
268 lcd_set_row(7 + BMP_LOGO_HEIGHT / VIDEO_FONT_HEIGHT);
270 lcd_set_row(1); /* leave 1 blank line below logo */
277 * This is called early in the system initialization to grab memory
278 * for the LCD controller.
279 * Returns new address for monitor, after reserving LCD buffer memory
281 * Note that this is running from ROM, so no write access to global data.
283 ulong lcd_setmem(ulong addr)
288 debug("LCD panel info: %d x %d, %d bit/pix\n", panel_info.vl_col,
289 panel_info.vl_row, NBITS(panel_info.vl_bpix));
291 size = lcd_get_size(&line_length);
293 /* Round up to nearest full page, or MMU section if defined */
294 size = ALIGN(size, CONFIG_LCD_ALIGNMENT);
295 addr = ALIGN(addr - CONFIG_LCD_ALIGNMENT + 1, CONFIG_LCD_ALIGNMENT);
297 /* Allocate pages for the frame buffer. */
300 debug("Reserving %ldk for LCD Framebuffer at: %08lx\n",
306 static void lcd_setfgcolor(int color)
308 lcd_color_fg = color;
311 int lcd_getfgcolor(void)
316 static void lcd_setbgcolor(int color)
318 lcd_color_bg = color;
321 int lcd_getbgcolor(void)
326 #ifdef CONFIG_LCD_LOGO
327 __weak void lcd_logo_set_cmap(void)
330 ushort *cmap = configuration_get_cmap();
332 for (i = 0; i < ARRAY_SIZE(bmp_logo_palette); ++i)
333 *cmap++ = bmp_logo_palette[i];
336 void lcd_logo_plot(int x, int y)
339 uchar *bmap = &bmp_logo_bitmap[0];
340 unsigned bpix = NBITS(panel_info.vl_bpix);
341 uchar *fb = (uchar *)(lcd_base + y * lcd_line_length + x * bpix / 8);
344 debug("Logo: width %d height %d colors %d\n",
345 BMP_LOGO_WIDTH, BMP_LOGO_HEIGHT, BMP_LOGO_COLORS);
352 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
353 memcpy(fb, bmap, BMP_LOGO_WIDTH);
354 bmap += BMP_LOGO_WIDTH;
355 fb += panel_info.vl_col;
358 else { /* true color mode */
361 for (i = 0; i < BMP_LOGO_HEIGHT; ++i) {
362 for (j = 0; j < BMP_LOGO_WIDTH; j++) {
363 col16 = bmp_logo_palette[(bmap[j]-16)];
365 ((col16 & 0x000F) << 1) |
366 ((col16 & 0x00F0) << 3) |
367 ((col16 & 0x0F00) << 4);
369 bmap += BMP_LOGO_WIDTH;
370 fb16 += panel_info.vl_col;
378 static inline void lcd_logo_plot(int x, int y) {}
379 #endif /* CONFIG_LCD_LOGO */
381 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
382 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
384 static void splash_align_axis(int *axis, unsigned long panel_size,
385 unsigned long picture_size)
387 unsigned long panel_picture_delta = panel_size - picture_size;
388 unsigned long axis_alignment;
390 if (*axis == BMP_ALIGN_CENTER)
391 axis_alignment = panel_picture_delta / 2;
393 axis_alignment = panel_picture_delta + *axis + 1;
397 *axis = max(0, (int)axis_alignment);
401 #ifdef CONFIG_LCD_BMP_RLE8
402 #define BMP_RLE8_ESCAPE 0
403 #define BMP_RLE8_EOL 0
404 #define BMP_RLE8_EOBMP 1
405 #define BMP_RLE8_DELTA 2
407 static void draw_unencoded_bitmap(ushort **fbp, uchar *bmap, ushort *cmap,
411 *(*fbp)++ = cmap[*bmap++];
416 static void draw_encoded_bitmap(ushort **fbp, ushort c, int cnt)
419 int cnt_8copy = cnt >> 3;
421 cnt -= cnt_8copy << 3;
422 while (cnt_8copy > 0) {
441 * Do not call this function directly, must be called from lcd_display_bitmap.
443 static void lcd_display_rle8_bitmap(struct bmp_image *bmp, ushort *cmap,
444 uchar *fb, int x_off, int y_off)
452 width = get_unaligned_le32(&bmp->header.width);
453 height = get_unaligned_le32(&bmp->header.height);
454 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
460 if (bmap[0] == BMP_RLE8_ESCAPE) {
467 /* 16bpix, 2-byte per pixel, width should *2 */
468 fb -= (width * 2 + lcd_line_length);
478 /* 16bpix, 2-byte per pixel, x should *2 */
479 fb = (uchar *) (lcd_base + (y + y_off - 1)
480 * lcd_line_length + (x + x_off) * 2);
489 if (x + runlen > width)
493 draw_unencoded_bitmap(
508 /* aggregate the same code */
509 while (bmap[0] == 0xff &&
510 bmap[2] != BMP_RLE8_ESCAPE &&
511 bmap[1] == bmap[3]) {
515 if (x + runlen > width)
519 draw_encoded_bitmap((ushort **)&fb,
530 __weak void fb_put_byte(uchar **fb, uchar **from)
532 *(*fb)++ = *(*from)++;
535 #if defined(CONFIG_BMP_16BPP)
536 __weak void fb_put_word(uchar **fb, uchar **from)
538 *(*fb)++ = *(*from)++;
539 *(*fb)++ = *(*from)++;
541 #endif /* CONFIG_BMP_16BPP */
543 __weak void lcd_set_cmap(struct bmp_image *bmp, unsigned colors)
546 struct bmp_color_table_entry cte;
547 ushort *cmap = configuration_get_cmap();
549 for (i = 0; i < colors; ++i) {
550 cte = bmp->color_table[i];
551 *cmap = (((cte.red) << 8) & 0xf800) |
552 (((cte.green) << 3) & 0x07e0) |
553 (((cte.blue) >> 3) & 0x001f);
558 int lcd_display_bitmap(ulong bmp_image, int x, int y)
560 ushort *cmap_base = NULL;
563 struct bmp_image *bmp = (struct bmp_image *)map_sysmem(bmp_image, 0);
566 unsigned long width, height, byte_width;
567 unsigned long pwidth = panel_info.vl_col;
568 unsigned colors, bpix, bmp_bpix;
570 struct bmp_color_table_entry *palette;
572 if (!bmp || !(bmp->header.signature[0] == 'B' &&
573 bmp->header.signature[1] == 'M')) {
574 printf("Error: no valid bmp image at %lx\n", bmp_image);
579 palette = bmp->color_table;
580 width = get_unaligned_le32(&bmp->header.width);
581 height = get_unaligned_le32(&bmp->header.height);
582 bmp_bpix = get_unaligned_le16(&bmp->header.bit_count);
583 hdr_size = get_unaligned_le16(&bmp->header.size);
584 debug("hdr_size=%d, bmp_bpix=%d\n", hdr_size, bmp_bpix);
586 colors = 1 << bmp_bpix;
588 bpix = NBITS(panel_info.vl_bpix);
590 if (bpix != 1 && bpix != 8 && bpix != 16 && bpix != 32) {
591 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
598 * We support displaying 8bpp BMPs on 16bpp LCDs
599 * and displaying 24bpp BMPs on 32bpp LCDs
601 if (bpix != bmp_bpix &&
602 !(bmp_bpix == 8 && bpix == 16) &&
603 !(bmp_bpix == 24 && bpix == 32)) {
604 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
605 bpix, get_unaligned_le16(&bmp->header.bit_count));
609 debug("Display-bmp: %d x %d with %d colors, display %d\n",
610 (int)width, (int)height, (int)colors, 1 << bpix);
613 lcd_set_cmap(bmp, colors);
615 padded_width = (width & 0x3 ? (width & ~0x3) + 4 : width);
617 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
618 splash_align_axis(&x, pwidth, width);
619 splash_align_axis(&y, panel_info.vl_row, height);
620 #endif /* CONFIG_SPLASH_SCREEN_ALIGN */
622 if ((x + width) > pwidth)
624 if ((y + height) > panel_info.vl_row)
625 height = panel_info.vl_row - y;
627 bmap = (uchar *)bmp + get_unaligned_le32(&bmp->header.data_offset);
628 fb = (uchar *)(lcd_base +
629 (y + height - 1) * lcd_line_length + x * bpix / 8);
634 cmap_base = configuration_get_cmap();
635 #ifdef CONFIG_LCD_BMP_RLE8
636 u32 compression = get_unaligned_le32(&bmp->header.compression);
637 debug("compressed %d %d\n", compression, BMP_BI_RLE8);
638 if (compression == BMP_BI_RLE8) {
640 /* TODO implement render code for bpix != 16 */
641 printf("Error: only support 16 bpix");
644 lcd_display_rle8_bitmap(bmp, cmap_base, fb, x, y);
652 byte_width = width * 2;
654 for (i = 0; i < height; ++i) {
656 for (j = 0; j < width; j++) {
658 fb_put_byte(&fb, &bmap);
660 struct bmp_color_table_entry *entry;
664 val = cmap_base[*bmap];
666 entry = &palette[*bmap];
667 val = entry->blue >> 3 |
668 entry->green >> 2 << 5 |
669 entry->red >> 3 << 11;
671 *(uint16_t *)fb = val;
673 fb += sizeof(uint16_t) / sizeof(*fb);
676 bmap += (padded_width - width);
677 fb -= byte_width + lcd_line_length;
681 #if defined(CONFIG_BMP_16BPP)
683 for (i = 0; i < height; ++i) {
685 for (j = 0; j < width; j++)
686 fb_put_word(&fb, &bmap);
688 bmap += (padded_width - width) * 2;
689 fb -= width * 2 + lcd_line_length;
692 #endif /* CONFIG_BMP_16BPP */
693 #if defined(CONFIG_BMP_24BPP)
695 for (i = 0; i < height; ++i) {
696 for (j = 0; j < width; j++) {
702 fb -= lcd_line_length + width * (bpix / 8);
705 #endif /* CONFIG_BMP_24BPP */
706 #if defined(CONFIG_BMP_32BPP)
708 for (i = 0; i < height; ++i) {
709 for (j = 0; j < width; j++) {
715 fb -= lcd_line_length + width * (bpix / 8);
718 #endif /* CONFIG_BMP_32BPP */
728 static void lcd_logo(void)
732 #ifdef CONFIG_LCD_INFO
733 lcd_set_col(LCD_INFO_X / VIDEO_FONT_WIDTH);
734 lcd_set_row(LCD_INFO_Y / VIDEO_FONT_HEIGHT);
735 lcd_show_board_info();
736 #endif /* CONFIG_LCD_INFO */
739 #ifdef CONFIG_SPLASHIMAGE_GUARD
740 static int on_splashimage(const char *name, const char *value, enum env_op op,
746 if (op == env_op_delete)
749 addr = simple_strtoul(value, NULL, 16);
750 /* See README.displaying-bmps */
751 aligned = (addr % 4 == 2);
753 printf("Invalid splashimage value. Value must be 16 bit aligned, but not 32 bit aligned\n");
760 U_BOOT_ENV_CALLBACK(splashimage, on_splashimage);
763 int lcd_get_pixel_width(void)
765 return panel_info.vl_col;
768 int lcd_get_pixel_height(void)
770 return panel_info.vl_row;