1 // SPDX-License-Identifier: GPL-2.0+
5 * (C) Copyright 2001-2002
6 * Wolfgang Denk, DENX Software Engineering -- wd@denx.de
13 #include <env_callback.h>
14 #include <linux/types.h>
15 #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
33 #ifndef CONFIG_LCD_ALIGNMENT
34 #define CONFIG_LCD_ALIGNMENT PAGE_SIZE
37 #if (LCD_BPP != LCD_COLOR8) && (LCD_BPP != LCD_COLOR16) && \
38 (LCD_BPP != LCD_COLOR32)
39 #error Unsupported LCD BPP.
42 DECLARE_GLOBAL_DATA_PTR
;
44 static int lcd_init(void *lcdbase
);
45 static void lcd_logo(void);
46 static void lcd_setfgcolor(int color
);
47 static void lcd_setbgcolor(int color
);
49 static int lcd_color_fg
;
50 static int lcd_color_bg
;
52 char lcd_is_enabled
= 0;
53 static void *lcd_base
; /* Start of framebuffer memory */
54 static char lcd_flush_dcache
; /* 1 to flush dcache after each lcd update */
56 /* Flush LCD activity to the caches */
60 * flush_dcache_range() is declared in common.h but it seems that some
61 * architectures do not actually implement it. Is there a way to find
62 * out whether it exists? For now, ARM is safe.
64 #if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
68 flush_dcache_range((ulong
)lcd_base
,
69 (ulong
)(lcd_base
+ lcd_get_size(&line_length
)));
73 void lcd_set_flush_dcache(int flush
)
75 lcd_flush_dcache
= (flush
!= 0);
78 static void lcd_stub_putc(struct stdio_dev
*dev
, const char c
)
83 static void lcd_stub_puts(struct stdio_dev
*dev
, const char *s
)
88 /* Small utility to check that you got the colours right */
89 #ifdef LCD_TEST_PATTERN
91 #if LCD_BPP == LCD_COLOR8
95 static int test_colors
[N_BLK_HOR
* N_BLK_VERT
] = {
96 CONSOLE_COLOR_RED
, CONSOLE_COLOR_GREEN
, CONSOLE_COLOR_YELLOW
,
97 CONSOLE_COLOR_BLUE
, CONSOLE_COLOR_MAGENTA
, CONSOLE_COLOR_CYAN
,
98 }; /*LCD_BPP == LCD_COLOR8 */
100 #elif LCD_BPP == LCD_COLOR16
104 static int test_colors
[N_BLK_HOR
* N_BLK_VERT
] = {
105 CONSOLE_COLOR_RED
, CONSOLE_COLOR_GREEN
, CONSOLE_COLOR_YELLOW
, CONSOLE_COLOR_BLUE
,
106 CONSOLE_COLOR_MAGENTA
, CONSOLE_COLOR_CYAN
, CONSOLE_COLOR_GREY
, CONSOLE_COLOR_WHITE
,
108 #endif /*LCD_BPP == LCD_COLOR16 */
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 #if LCD_BPP == LCD_COLOR8
118 uchar
*pix
= (uchar
*)lcd_base
;
119 #elif LCD_BPP == LCD_COLOR16
120 ushort
*pix
= (ushort
*)lcd_base
;
123 printf("[LCD] Test Pattern: %d x %d [%d x %d]\n",
124 h_max
, v_max
, h_step
, v_step
);
126 for (v
= 0; v
< v_max
; ++v
) {
127 uchar iy
= v
/ v_step
;
128 for (h
= 0; h
< h_max
; ++h
) {
129 uchar ix
= N_BLK_HOR
* iy
+ h
/ h_step
;
130 *pix
++ = test_colors
[ix
];
134 #endif /* LCD_TEST_PATTERN */
137 * With most lcd drivers the line length is set up
138 * by calculating it from panel_info parameters. Some
139 * drivers need to calculate the line length differently,
140 * so make the function weak to allow overriding it.
142 __weak
int lcd_get_size(int *line_length
)
144 *line_length
= (panel_info
.vl_col
* NBITS(panel_info
.vl_bpix
)) / 8;
145 return *line_length
* panel_info
.vl_row
;
148 int drv_lcd_init(void)
150 struct stdio_dev lcddev
;
153 lcd_base
= map_sysmem(gd
->fb_base
, 0);
157 /* Device initialization */
158 memset(&lcddev
, 0, sizeof(lcddev
));
160 strcpy(lcddev
.name
, "lcd");
161 lcddev
.ext
= 0; /* No extensions */
162 lcddev
.flags
= DEV_FLAGS_OUTPUT
; /* Output only */
163 lcddev
.putc
= lcd_stub_putc
; /* 'putc' function */
164 lcddev
.puts
= lcd_stub_puts
; /* 'puts' function */
166 rc
= stdio_register(&lcddev
);
168 return (rc
== 0) ? 1 : rc
;
176 static int do_splash
= 1;
177 #if LCD_BPP == LCD_COLOR8
178 /* Setting the palette */
179 lcd_setcolreg(CONSOLE_COLOR_BLACK
, 0, 0, 0);
180 lcd_setcolreg(CONSOLE_COLOR_RED
, 0xFF, 0, 0);
181 lcd_setcolreg(CONSOLE_COLOR_GREEN
, 0, 0xFF, 0);
182 lcd_setcolreg(CONSOLE_COLOR_YELLOW
, 0xFF, 0xFF, 0);
183 lcd_setcolreg(CONSOLE_COLOR_BLUE
, 0, 0, 0xFF);
184 lcd_setcolreg(CONSOLE_COLOR_MAGENTA
, 0xFF, 0, 0xFF);
185 lcd_setcolreg(CONSOLE_COLOR_CYAN
, 0, 0xFF, 0xFF);
186 lcd_setcolreg(CONSOLE_COLOR_GREY
, 0xAA, 0xAA, 0xAA);
187 lcd_setcolreg(CONSOLE_COLOR_WHITE
, 0xFF, 0xFF, 0xFF);
190 #ifndef CONFIG_SYS_WHITE_ON_BLACK
191 lcd_setfgcolor(CONSOLE_COLOR_BLACK
);
192 lcd_setbgcolor(CONSOLE_COLOR_WHITE
);
193 bg_color
= CONSOLE_COLOR_WHITE
;
195 lcd_setfgcolor(CONSOLE_COLOR_WHITE
);
196 lcd_setbgcolor(CONSOLE_COLOR_BLACK
);
197 bg_color
= CONSOLE_COLOR_BLACK
;
198 #endif /* CONFIG_SYS_WHITE_ON_BLACK */
200 #ifdef LCD_TEST_PATTERN
203 /* set framebuffer to background color */
204 #if (LCD_BPP != LCD_COLOR32)
205 memset((char *)lcd_base
, bg_color
, lcd_line_length
* panel_info
.vl_row
);
207 u32
*ppix
= lcd_base
;
210 i
< (lcd_line_length
* panel_info
.vl_row
)/NBYTES(panel_info
.vl_bpix
);
216 /* setup text-console */
217 debug("[LCD] setting up console...\n");
218 lcd_init_console(lcd_base
,
222 /* Paint the logo and retrieve LCD base address */
223 debug("[LCD] Drawing the logo...\n");
225 s
= env_get("splashimage");
228 addr
= simple_strtoul(s
, NULL
, 16);
229 if (lcd_splash(addr
) == 0) {
237 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
238 addr
= (ulong
)lcd_base
+ BMP_LOGO_HEIGHT
* lcd_line_length
;
239 lcd_init_console((void *)addr
, panel_info
.vl_col
,
240 panel_info
.vl_row
, panel_info
.vl_rot
);
245 static int lcd_init(void *lcdbase
)
247 debug("[LCD] Initializing LCD frambuffer at %p\n", lcdbase
);
248 lcd_ctrl_init(lcdbase
);
251 * lcd_ctrl_init() of some drivers (i.e. bcm2835 on rpi) ignores
252 * the 'lcdbase' argument and uses custom lcd base address
253 * by setting up gd->fb_base. Check for this condition and fixup
254 * 'lcd_base' address.
256 if (map_to_sysmem(lcdbase
) != gd
->fb_base
)
257 lcd_base
= map_sysmem(gd
->fb_base
, 0);
259 debug("[LCD] Using LCD frambuffer at %p\n", lcd_base
);
261 lcd_get_size(&lcd_line_length
);
266 /* Initialize the console */
268 #ifdef CONFIG_LCD_INFO_BELOW_LOGO
269 lcd_set_row(7 + BMP_LOGO_HEIGHT
/ VIDEO_FONT_HEIGHT
);
271 lcd_set_row(1); /* leave 1 blank line below logo */
278 * This is called early in the system initialization to grab memory
279 * for the LCD controller.
280 * Returns new address for monitor, after reserving LCD buffer memory
282 * Note that this is running from ROM, so no write access to global data.
284 ulong
lcd_setmem(ulong addr
)
289 debug("LCD panel info: %d x %d, %d bit/pix\n", panel_info
.vl_col
,
290 panel_info
.vl_row
, NBITS(panel_info
.vl_bpix
));
292 size
= lcd_get_size(&line_length
);
294 /* Round up to nearest full page, or MMU section if defined */
295 size
= ALIGN(size
, CONFIG_LCD_ALIGNMENT
);
296 addr
= ALIGN(addr
- CONFIG_LCD_ALIGNMENT
+ 1, CONFIG_LCD_ALIGNMENT
);
298 /* Allocate pages for the frame buffer. */
301 debug("Reserving %ldk for LCD Framebuffer at: %08lx\n",
307 static void lcd_setfgcolor(int color
)
309 lcd_color_fg
= color
;
312 int lcd_getfgcolor(void)
317 static void lcd_setbgcolor(int color
)
319 lcd_color_bg
= color
;
322 int lcd_getbgcolor(void)
327 #ifdef CONFIG_LCD_LOGO
328 __weak
void lcd_logo_set_cmap(void)
331 ushort
*cmap
= configuration_get_cmap();
333 for (i
= 0; i
< ARRAY_SIZE(bmp_logo_palette
); ++i
)
334 *cmap
++ = bmp_logo_palette
[i
];
337 void lcd_logo_plot(int x
, int y
)
340 uchar
*bmap
= &bmp_logo_bitmap
[0];
341 unsigned bpix
= NBITS(panel_info
.vl_bpix
);
342 uchar
*fb
= (uchar
*)(lcd_base
+ y
* lcd_line_length
+ x
* bpix
/ 8);
345 debug("Logo: width %d height %d colors %d\n",
346 BMP_LOGO_WIDTH
, BMP_LOGO_HEIGHT
, BMP_LOGO_COLORS
);
353 for (i
= 0; i
< BMP_LOGO_HEIGHT
; ++i
) {
354 memcpy(fb
, bmap
, BMP_LOGO_WIDTH
);
355 bmap
+= BMP_LOGO_WIDTH
;
356 fb
+= panel_info
.vl_col
;
359 else { /* true color mode */
362 for (i
= 0; i
< BMP_LOGO_HEIGHT
; ++i
) {
363 for (j
= 0; j
< BMP_LOGO_WIDTH
; j
++) {
364 col16
= bmp_logo_palette
[(bmap
[j
]-16)];
366 ((col16
& 0x000F) << 1) |
367 ((col16
& 0x00F0) << 3) |
368 ((col16
& 0x0F00) << 4);
370 bmap
+= BMP_LOGO_WIDTH
;
371 fb16
+= panel_info
.vl_col
;
379 static inline void lcd_logo_plot(int x
, int y
) {}
380 #endif /* CONFIG_LCD_LOGO */
382 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
383 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
385 static void splash_align_axis(int *axis
, unsigned long panel_size
,
386 unsigned long picture_size
)
388 unsigned long panel_picture_delta
= panel_size
- picture_size
;
389 unsigned long axis_alignment
;
391 if (*axis
== BMP_ALIGN_CENTER
)
392 axis_alignment
= panel_picture_delta
/ 2;
394 axis_alignment
= panel_picture_delta
+ *axis
+ 1;
398 *axis
= max(0, (int)axis_alignment
);
402 #ifdef CONFIG_LCD_BMP_RLE8
403 #define BMP_RLE8_ESCAPE 0
404 #define BMP_RLE8_EOL 0
405 #define BMP_RLE8_EOBMP 1
406 #define BMP_RLE8_DELTA 2
408 static void draw_unencoded_bitmap(ushort
**fbp
, uchar
*bmap
, ushort
*cmap
,
412 *(*fbp
)++ = cmap
[*bmap
++];
417 static void draw_encoded_bitmap(ushort
**fbp
, ushort c
, int cnt
)
420 int cnt_8copy
= cnt
>> 3;
422 cnt
-= cnt_8copy
<< 3;
423 while (cnt_8copy
> 0) {
442 * Do not call this function directly, must be called from lcd_display_bitmap.
444 static void lcd_display_rle8_bitmap(struct bmp_image
*bmp
, ushort
*cmap
,
445 uchar
*fb
, int x_off
, int y_off
)
453 width
= get_unaligned_le32(&bmp
->header
.width
);
454 height
= get_unaligned_le32(&bmp
->header
.height
);
455 bmap
= (uchar
*)bmp
+ get_unaligned_le32(&bmp
->header
.data_offset
);
461 if (bmap
[0] == BMP_RLE8_ESCAPE
) {
468 /* 16bpix, 2-byte per pixel, width should *2 */
469 fb
-= (width
* 2 + lcd_line_length
);
479 /* 16bpix, 2-byte per pixel, x should *2 */
480 fb
= (uchar
*) (lcd_base
+ (y
+ y_off
- 1)
481 * lcd_line_length
+ (x
+ x_off
) * 2);
490 if (x
+ runlen
> width
)
494 draw_unencoded_bitmap(
509 /* aggregate the same code */
510 while (bmap
[0] == 0xff &&
511 bmap
[2] != BMP_RLE8_ESCAPE
&&
512 bmap
[1] == bmap
[3]) {
516 if (x
+ runlen
> width
)
520 draw_encoded_bitmap((ushort
**)&fb
,
531 __weak
void fb_put_byte(uchar
**fb
, uchar
**from
)
533 *(*fb
)++ = *(*from
)++;
536 #if defined(CONFIG_BMP_16BPP)
537 __weak
void fb_put_word(uchar
**fb
, uchar
**from
)
539 *(*fb
)++ = *(*from
)++;
540 *(*fb
)++ = *(*from
)++;
542 #endif /* CONFIG_BMP_16BPP */
544 __weak
void lcd_set_cmap(struct bmp_image
*bmp
, unsigned colors
)
547 struct bmp_color_table_entry cte
;
548 ushort
*cmap
= configuration_get_cmap();
550 for (i
= 0; i
< colors
; ++i
) {
551 cte
= bmp
->color_table
[i
];
552 *cmap
= (((cte
.red
) << 8) & 0xf800) |
553 (((cte
.green
) << 3) & 0x07e0) |
554 (((cte
.blue
) >> 3) & 0x001f);
559 int lcd_display_bitmap(ulong bmp_image
, int x
, int y
)
561 ushort
*cmap_base
= NULL
;
564 struct bmp_image
*bmp
= (struct bmp_image
*)map_sysmem(bmp_image
, 0);
567 unsigned long width
, height
, byte_width
;
568 unsigned long pwidth
= panel_info
.vl_col
;
569 unsigned colors
, bpix
, bmp_bpix
;
571 struct bmp_color_table_entry
*palette
;
573 if (!bmp
|| !(bmp
->header
.signature
[0] == 'B' &&
574 bmp
->header
.signature
[1] == 'M')) {
575 printf("Error: no valid bmp image at %lx\n", bmp_image
);
580 palette
= bmp
->color_table
;
581 width
= get_unaligned_le32(&bmp
->header
.width
);
582 height
= get_unaligned_le32(&bmp
->header
.height
);
583 bmp_bpix
= get_unaligned_le16(&bmp
->header
.bit_count
);
584 hdr_size
= get_unaligned_le16(&bmp
->header
.size
);
585 debug("hdr_size=%d, bmp_bpix=%d\n", hdr_size
, bmp_bpix
);
587 colors
= 1 << bmp_bpix
;
589 bpix
= NBITS(panel_info
.vl_bpix
);
591 if (bpix
!= 1 && bpix
!= 8 && bpix
!= 16 && bpix
!= 32) {
592 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
599 * We support displaying 8bpp BMPs on 16bpp LCDs
600 * and displaying 24bpp BMPs on 32bpp LCDs
602 if (bpix
!= bmp_bpix
&&
603 !(bmp_bpix
== 8 && bpix
== 16) &&
604 !(bmp_bpix
== 24 && bpix
== 32)) {
605 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
606 bpix
, get_unaligned_le16(&bmp
->header
.bit_count
));
610 debug("Display-bmp: %d x %d with %d colors, display %d\n",
611 (int)width
, (int)height
, (int)colors
, 1 << bpix
);
614 lcd_set_cmap(bmp
, colors
);
616 padded_width
= (width
& 0x3 ? (width
& ~0x3) + 4 : width
);
618 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
619 splash_align_axis(&x
, pwidth
, width
);
620 splash_align_axis(&y
, panel_info
.vl_row
, height
);
621 #endif /* CONFIG_SPLASH_SCREEN_ALIGN */
623 if ((x
+ width
) > pwidth
)
625 if ((y
+ height
) > panel_info
.vl_row
)
626 height
= panel_info
.vl_row
- y
;
628 bmap
= (uchar
*)bmp
+ get_unaligned_le32(&bmp
->header
.data_offset
);
629 fb
= (uchar
*)(lcd_base
+
630 (y
+ height
- 1) * lcd_line_length
+ x
* bpix
/ 8);
635 cmap_base
= configuration_get_cmap();
636 #ifdef CONFIG_LCD_BMP_RLE8
637 u32 compression
= get_unaligned_le32(&bmp
->header
.compression
);
638 debug("compressed %d %d\n", compression
, BMP_BI_RLE8
);
639 if (compression
== BMP_BI_RLE8
) {
641 /* TODO implement render code for bpix != 16 */
642 printf("Error: only support 16 bpix");
645 lcd_display_rle8_bitmap(bmp
, cmap_base
, fb
, x
, y
);
653 byte_width
= width
* 2;
655 for (i
= 0; i
< height
; ++i
) {
657 for (j
= 0; j
< width
; j
++) {
659 fb_put_byte(&fb
, &bmap
);
661 struct bmp_color_table_entry
*entry
;
665 val
= cmap_base
[*bmap
];
667 entry
= &palette
[*bmap
];
668 val
= entry
->blue
>> 3 |
669 entry
->green
>> 2 << 5 |
670 entry
->red
>> 3 << 11;
672 *(uint16_t *)fb
= val
;
674 fb
+= sizeof(uint16_t) / sizeof(*fb
);
677 bmap
+= (padded_width
- width
);
678 fb
-= byte_width
+ lcd_line_length
;
682 #if defined(CONFIG_BMP_16BPP)
684 for (i
= 0; i
< height
; ++i
) {
686 for (j
= 0; j
< width
; j
++)
687 fb_put_word(&fb
, &bmap
);
689 bmap
+= (padded_width
- width
) * 2;
690 fb
-= width
* 2 + lcd_line_length
;
693 #endif /* CONFIG_BMP_16BPP */
694 #if defined(CONFIG_BMP_24BPP)
696 for (i
= 0; i
< height
; ++i
) {
697 for (j
= 0; j
< width
; j
++) {
703 fb
-= lcd_line_length
+ width
* (bpix
/ 8);
706 #endif /* CONFIG_BMP_24BPP */
707 #if defined(CONFIG_BMP_32BPP)
709 for (i
= 0; i
< height
; ++i
) {
710 for (j
= 0; j
< width
; j
++) {
716 fb
-= lcd_line_length
+ width
* (bpix
/ 8);
719 #endif /* CONFIG_BMP_32BPP */
729 static void lcd_logo(void)
733 #ifdef CONFIG_LCD_INFO
734 lcd_set_col(LCD_INFO_X
/ VIDEO_FONT_WIDTH
);
735 lcd_set_row(LCD_INFO_Y
/ VIDEO_FONT_HEIGHT
);
736 lcd_show_board_info();
737 #endif /* CONFIG_LCD_INFO */
740 #ifdef CONFIG_SPLASHIMAGE_GUARD
741 static int on_splashimage(const char *name
, const char *value
, enum env_op op
,
747 if (op
== env_op_delete
)
750 addr
= simple_strtoul(value
, NULL
, 16);
751 /* See README.displaying-bmps */
752 aligned
= (addr
% 4 == 2);
754 printf("Invalid splashimage value. Value must be 16 bit aligned, but not 32 bit aligned\n");
761 U_BOOT_ENV_CALLBACK(splashimage
, on_splashimage
);
764 int lcd_get_pixel_width(void)
766 return panel_info
.vl_col
;
769 int lcd_get_pixel_height(void)
771 return panel_info
.vl_row
;