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) && !CONFIG_IS_ENABLED(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
;
174 __maybe_unused ulong addr
;
175 static int do_splash
= 1;
176 #if LCD_BPP == LCD_COLOR8
177 /* Setting the palette */
178 lcd_setcolreg(CONSOLE_COLOR_BLACK
, 0, 0, 0);
179 lcd_setcolreg(CONSOLE_COLOR_RED
, 0xFF, 0, 0);
180 lcd_setcolreg(CONSOLE_COLOR_GREEN
, 0, 0xFF, 0);
181 lcd_setcolreg(CONSOLE_COLOR_YELLOW
, 0xFF, 0xFF, 0);
182 lcd_setcolreg(CONSOLE_COLOR_BLUE
, 0, 0, 0xFF);
183 lcd_setcolreg(CONSOLE_COLOR_MAGENTA
, 0xFF, 0, 0xFF);
184 lcd_setcolreg(CONSOLE_COLOR_CYAN
, 0, 0xFF, 0xFF);
185 lcd_setcolreg(CONSOLE_COLOR_GREY
, 0xAA, 0xAA, 0xAA);
186 lcd_setcolreg(CONSOLE_COLOR_WHITE
, 0xFF, 0xFF, 0xFF);
189 #ifndef CONFIG_SYS_WHITE_ON_BLACK
190 lcd_setfgcolor(CONSOLE_COLOR_BLACK
);
191 lcd_setbgcolor(CONSOLE_COLOR_WHITE
);
192 bg_color
= CONSOLE_COLOR_WHITE
;
194 lcd_setfgcolor(CONSOLE_COLOR_WHITE
);
195 lcd_setbgcolor(CONSOLE_COLOR_BLACK
);
196 bg_color
= CONSOLE_COLOR_BLACK
;
197 #endif /* CONFIG_SYS_WHITE_ON_BLACK */
199 #ifdef LCD_TEST_PATTERN
202 /* set framebuffer to background color */
203 #if (LCD_BPP != LCD_COLOR32)
204 memset((char *)lcd_base
, bg_color
, lcd_line_length
* panel_info
.vl_row
);
206 u32
*ppix
= lcd_base
;
209 i
< (lcd_line_length
* panel_info
.vl_row
)/NBYTES(panel_info
.vl_bpix
);
215 /* setup text-console */
216 debug("[LCD] setting up console...\n");
217 lcd_init_console(lcd_base
,
221 /* Paint the logo and retrieve LCD base address */
222 debug("[LCD] Drawing the logo...\n");
224 if (splash_display() == 0) {
232 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
233 addr
= (ulong
)lcd_base
+ BMP_LOGO_HEIGHT
* lcd_line_length
;
234 lcd_init_console((void *)addr
, panel_info
.vl_col
,
235 panel_info
.vl_row
, panel_info
.vl_rot
);
240 static int lcd_init(void *lcdbase
)
242 debug("[LCD] Initializing LCD frambuffer at %p\n", lcdbase
);
243 lcd_ctrl_init(lcdbase
);
246 * lcd_ctrl_init() of some drivers (i.e. bcm2835 on rpi) ignores
247 * the 'lcdbase' argument and uses custom lcd base address
248 * by setting up gd->fb_base. Check for this condition and fixup
249 * 'lcd_base' address.
251 if (map_to_sysmem(lcdbase
) != gd
->fb_base
)
252 lcd_base
= map_sysmem(gd
->fb_base
, 0);
254 debug("[LCD] Using LCD frambuffer at %p\n", lcd_base
);
256 lcd_get_size(&lcd_line_length
);
261 /* Initialize the console */
263 #ifdef CONFIG_LCD_INFO_BELOW_LOGO
264 lcd_set_row(7 + BMP_LOGO_HEIGHT
/ VIDEO_FONT_HEIGHT
);
266 lcd_set_row(1); /* leave 1 blank line below logo */
273 * This is called early in the system initialization to grab memory
274 * for the LCD controller.
275 * Returns new address for monitor, after reserving LCD buffer memory
277 * Note that this is running from ROM, so no write access to global data.
279 ulong
lcd_setmem(ulong addr
)
284 debug("LCD panel info: %d x %d, %d bit/pix\n", panel_info
.vl_col
,
285 panel_info
.vl_row
, NBITS(panel_info
.vl_bpix
));
287 size
= lcd_get_size(&line_length
);
289 /* Round up to nearest full page, or MMU section if defined */
290 size
= ALIGN(size
, CONFIG_LCD_ALIGNMENT
);
291 addr
= ALIGN(addr
- CONFIG_LCD_ALIGNMENT
+ 1, CONFIG_LCD_ALIGNMENT
);
293 /* Allocate pages for the frame buffer. */
296 debug("Reserving %ldk for LCD Framebuffer at: %08lx\n",
302 static void lcd_setfgcolor(int color
)
304 lcd_color_fg
= color
;
307 int lcd_getfgcolor(void)
312 static void lcd_setbgcolor(int color
)
314 lcd_color_bg
= color
;
317 int lcd_getbgcolor(void)
322 #ifdef CONFIG_LCD_LOGO
323 __weak
void lcd_logo_set_cmap(void)
326 ushort
*cmap
= configuration_get_cmap();
328 for (i
= 0; i
< ARRAY_SIZE(bmp_logo_palette
); ++i
)
329 *cmap
++ = bmp_logo_palette
[i
];
332 void lcd_logo_plot(int x
, int y
)
335 uchar
*bmap
= &bmp_logo_bitmap
[0];
336 unsigned bpix
= NBITS(panel_info
.vl_bpix
);
337 uchar
*fb
= (uchar
*)(lcd_base
+ y
* lcd_line_length
+ x
* bpix
/ 8);
340 debug("Logo: width %d height %d colors %d\n",
341 BMP_LOGO_WIDTH
, BMP_LOGO_HEIGHT
, BMP_LOGO_COLORS
);
348 for (i
= 0; i
< BMP_LOGO_HEIGHT
; ++i
) {
349 memcpy(fb
, bmap
, BMP_LOGO_WIDTH
);
350 bmap
+= BMP_LOGO_WIDTH
;
351 fb
+= panel_info
.vl_col
;
354 else { /* true color mode */
357 for (i
= 0; i
< BMP_LOGO_HEIGHT
; ++i
) {
358 for (j
= 0; j
< BMP_LOGO_WIDTH
; j
++) {
359 col16
= bmp_logo_palette
[(bmap
[j
]-16)];
361 ((col16
& 0x000F) << 1) |
362 ((col16
& 0x00F0) << 3) |
363 ((col16
& 0x0F00) << 4);
365 bmap
+= BMP_LOGO_WIDTH
;
366 fb16
+= panel_info
.vl_col
;
374 static inline void lcd_logo_plot(int x
, int y
) {}
375 #endif /* CONFIG_LCD_LOGO */
377 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
378 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
380 static void splash_align_axis(int *axis
, unsigned long panel_size
,
381 unsigned long picture_size
)
383 unsigned long panel_picture_delta
= panel_size
- picture_size
;
384 unsigned long axis_alignment
;
386 if (*axis
== BMP_ALIGN_CENTER
)
387 axis_alignment
= panel_picture_delta
/ 2;
389 axis_alignment
= panel_picture_delta
+ *axis
+ 1;
393 *axis
= max(0, (int)axis_alignment
);
397 #ifdef CONFIG_LCD_BMP_RLE8
398 #define BMP_RLE8_ESCAPE 0
399 #define BMP_RLE8_EOL 0
400 #define BMP_RLE8_EOBMP 1
401 #define BMP_RLE8_DELTA 2
403 static void draw_unencoded_bitmap(ushort
**fbp
, uchar
*bmap
, ushort
*cmap
,
407 *(*fbp
)++ = cmap
[*bmap
++];
412 static void draw_encoded_bitmap(ushort
**fbp
, ushort c
, int cnt
)
415 int cnt_8copy
= cnt
>> 3;
417 cnt
-= cnt_8copy
<< 3;
418 while (cnt_8copy
> 0) {
437 * Do not call this function directly, must be called from lcd_display_bitmap.
439 static void lcd_display_rle8_bitmap(struct bmp_image
*bmp
, ushort
*cmap
,
440 uchar
*fb
, int x_off
, int y_off
)
448 width
= get_unaligned_le32(&bmp
->header
.width
);
449 height
= get_unaligned_le32(&bmp
->header
.height
);
450 bmap
= (uchar
*)bmp
+ get_unaligned_le32(&bmp
->header
.data_offset
);
456 if (bmap
[0] == BMP_RLE8_ESCAPE
) {
463 /* 16bpix, 2-byte per pixel, width should *2 */
464 fb
-= (width
* 2 + lcd_line_length
);
474 /* 16bpix, 2-byte per pixel, x should *2 */
475 fb
= (uchar
*) (lcd_base
+ (y
+ y_off
- 1)
476 * lcd_line_length
+ (x
+ x_off
) * 2);
485 if (x
+ runlen
> width
)
489 draw_unencoded_bitmap(
504 /* aggregate the same code */
505 while (bmap
[0] == 0xff &&
506 bmap
[2] != BMP_RLE8_ESCAPE
&&
507 bmap
[1] == bmap
[3]) {
511 if (x
+ runlen
> width
)
515 draw_encoded_bitmap((ushort
**)&fb
,
526 __weak
void fb_put_byte(uchar
**fb
, uchar
**from
)
528 *(*fb
)++ = *(*from
)++;
531 #if defined(CONFIG_BMP_16BPP)
532 __weak
void fb_put_word(uchar
**fb
, uchar
**from
)
534 *(*fb
)++ = *(*from
)++;
535 *(*fb
)++ = *(*from
)++;
537 #endif /* CONFIG_BMP_16BPP */
539 __weak
void lcd_set_cmap(struct bmp_image
*bmp
, unsigned colors
)
542 struct bmp_color_table_entry cte
;
543 ushort
*cmap
= configuration_get_cmap();
545 for (i
= 0; i
< colors
; ++i
) {
546 cte
= bmp
->color_table
[i
];
547 *cmap
= (((cte
.red
) << 8) & 0xf800) |
548 (((cte
.green
) << 3) & 0x07e0) |
549 (((cte
.blue
) >> 3) & 0x001f);
554 int lcd_display_bitmap(ulong bmp_image
, int x
, int y
)
556 ushort
*cmap_base
= NULL
;
559 struct bmp_image
*bmp
= (struct bmp_image
*)map_sysmem(bmp_image
, 0);
562 unsigned long width
, height
, byte_width
;
563 unsigned long pwidth
= panel_info
.vl_col
;
564 unsigned colors
, bpix
, bmp_bpix
;
566 struct bmp_color_table_entry
*palette
;
568 if (!bmp
|| !(bmp
->header
.signature
[0] == 'B' &&
569 bmp
->header
.signature
[1] == 'M')) {
570 printf("Error: no valid bmp image at %lx\n", bmp_image
);
575 palette
= bmp
->color_table
;
576 width
= get_unaligned_le32(&bmp
->header
.width
);
577 height
= get_unaligned_le32(&bmp
->header
.height
);
578 bmp_bpix
= get_unaligned_le16(&bmp
->header
.bit_count
);
579 hdr_size
= get_unaligned_le16(&bmp
->header
.size
);
580 debug("hdr_size=%d, bmp_bpix=%d\n", hdr_size
, bmp_bpix
);
582 colors
= 1 << bmp_bpix
;
584 bpix
= NBITS(panel_info
.vl_bpix
);
586 if (bpix
!= 1 && bpix
!= 8 && bpix
!= 16 && bpix
!= 32) {
587 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
594 * We support displaying 8bpp BMPs on 16bpp LCDs
595 * and displaying 24bpp BMPs on 32bpp LCDs
597 if (bpix
!= bmp_bpix
&&
598 !(bmp_bpix
== 8 && bpix
== 16) &&
599 !(bmp_bpix
== 24 && bpix
== 32)) {
600 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
601 bpix
, get_unaligned_le16(&bmp
->header
.bit_count
));
605 debug("Display-bmp: %d x %d with %d colors, display %d\n",
606 (int)width
, (int)height
, (int)colors
, 1 << bpix
);
609 lcd_set_cmap(bmp
, colors
);
611 padded_width
= (width
& 0x3 ? (width
& ~0x3) + 4 : width
);
613 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
614 splash_align_axis(&x
, pwidth
, width
);
615 splash_align_axis(&y
, panel_info
.vl_row
, height
);
616 #endif /* CONFIG_SPLASH_SCREEN_ALIGN */
618 if ((x
+ width
) > pwidth
)
620 if ((y
+ height
) > panel_info
.vl_row
)
621 height
= panel_info
.vl_row
- y
;
623 bmap
= (uchar
*)bmp
+ get_unaligned_le32(&bmp
->header
.data_offset
);
624 fb
= (uchar
*)(lcd_base
+
625 (y
+ height
- 1) * lcd_line_length
+ x
* bpix
/ 8);
630 cmap_base
= configuration_get_cmap();
631 #ifdef CONFIG_LCD_BMP_RLE8
632 u32 compression
= get_unaligned_le32(&bmp
->header
.compression
);
633 debug("compressed %d %d\n", compression
, BMP_BI_RLE8
);
634 if (compression
== BMP_BI_RLE8
) {
636 /* TODO implement render code for bpix != 16 */
637 printf("Error: only support 16 bpix");
640 lcd_display_rle8_bitmap(bmp
, cmap_base
, fb
, x
, y
);
648 byte_width
= width
* 2;
650 for (i
= 0; i
< height
; ++i
) {
652 for (j
= 0; j
< width
; j
++) {
654 fb_put_byte(&fb
, &bmap
);
656 struct bmp_color_table_entry
*entry
;
660 val
= cmap_base
[*bmap
];
662 entry
= &palette
[*bmap
];
663 val
= entry
->blue
>> 3 |
664 entry
->green
>> 2 << 5 |
665 entry
->red
>> 3 << 11;
667 *(uint16_t *)fb
= val
;
669 fb
+= sizeof(uint16_t) / sizeof(*fb
);
672 bmap
+= (padded_width
- width
);
673 fb
-= byte_width
+ lcd_line_length
;
677 #if defined(CONFIG_BMP_16BPP)
679 for (i
= 0; i
< height
; ++i
) {
681 for (j
= 0; j
< width
; j
++)
682 fb_put_word(&fb
, &bmap
);
684 bmap
+= (padded_width
- width
) * 2;
685 fb
-= width
* 2 + lcd_line_length
;
688 #endif /* CONFIG_BMP_16BPP */
689 #if defined(CONFIG_BMP_24BPP)
691 for (i
= 0; i
< height
; ++i
) {
692 for (j
= 0; j
< width
; j
++) {
698 fb
-= lcd_line_length
+ width
* (bpix
/ 8);
701 #endif /* CONFIG_BMP_24BPP */
702 #if defined(CONFIG_BMP_32BPP)
704 for (i
= 0; i
< height
; ++i
) {
705 for (j
= 0; j
< width
; j
++) {
711 fb
-= lcd_line_length
+ width
* (bpix
/ 8);
714 #endif /* CONFIG_BMP_32BPP */
724 static void lcd_logo(void)
728 #ifdef CONFIG_LCD_INFO
729 lcd_set_col(LCD_INFO_X
/ VIDEO_FONT_WIDTH
);
730 lcd_set_row(LCD_INFO_Y
/ VIDEO_FONT_HEIGHT
);
731 lcd_show_board_info();
732 #endif /* CONFIG_LCD_INFO */
735 #ifdef CONFIG_SPLASHIMAGE_GUARD
736 static int on_splashimage(const char *name
, const char *value
, enum env_op op
,
742 if (op
== env_op_delete
)
745 addr
= simple_strtoul(value
, NULL
, 16);
746 /* See README.displaying-bmps */
747 aligned
= (addr
% 4 == 2);
749 printf("Invalid splashimage value. Value must be 16 bit aligned, but not 32 bit aligned\n");
756 U_BOOT_ENV_CALLBACK(splashimage
, on_splashimage
);
759 int lcd_get_pixel_width(void)
761 return panel_info
.vl_col
;
764 int lcd_get_pixel_height(void)
766 return panel_info
.vl_row
;