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
;
146 int drv_lcd_init(void)
148 struct stdio_dev lcddev
;
151 lcd_base
= map_sysmem(gd
->fb_base
, 0);
155 /* Device initialization */
156 memset(&lcddev
, 0, sizeof(lcddev
));
158 strcpy(lcddev
.name
, "lcd");
159 lcddev
.ext
= 0; /* No extensions */
160 lcddev
.flags
= DEV_FLAGS_OUTPUT
; /* Output only */
161 lcddev
.putc
= lcd_stub_putc
; /* 'putc' function */
162 lcddev
.puts
= lcd_stub_puts
; /* 'puts' function */
164 rc
= stdio_register(&lcddev
);
166 return (rc
== 0) ? 1 : rc
;
174 static int do_splash
= 1;
175 #if LCD_BPP == LCD_COLOR8
176 /* Setting the palette */
177 lcd_setcolreg(CONSOLE_COLOR_BLACK
, 0, 0, 0);
178 lcd_setcolreg(CONSOLE_COLOR_RED
, 0xFF, 0, 0);
179 lcd_setcolreg(CONSOLE_COLOR_GREEN
, 0, 0xFF, 0);
180 lcd_setcolreg(CONSOLE_COLOR_YELLOW
, 0xFF, 0xFF, 0);
181 lcd_setcolreg(CONSOLE_COLOR_BLUE
, 0, 0, 0xFF);
182 lcd_setcolreg(CONSOLE_COLOR_MAGENTA
, 0xFF, 0, 0xFF);
183 lcd_setcolreg(CONSOLE_COLOR_CYAN
, 0, 0xFF, 0xFF);
184 lcd_setcolreg(CONSOLE_COLOR_GREY
, 0xAA, 0xAA, 0xAA);
185 lcd_setcolreg(CONSOLE_COLOR_WHITE
, 0xFF, 0xFF, 0xFF);
188 #ifndef CONFIG_SYS_WHITE_ON_BLACK
189 lcd_setfgcolor(CONSOLE_COLOR_BLACK
);
190 lcd_setbgcolor(CONSOLE_COLOR_WHITE
);
191 bg_color
= CONSOLE_COLOR_WHITE
;
193 lcd_setfgcolor(CONSOLE_COLOR_WHITE
);
194 lcd_setbgcolor(CONSOLE_COLOR_BLACK
);
195 bg_color
= CONSOLE_COLOR_BLACK
;
196 #endif /* CONFIG_SYS_WHITE_ON_BLACK */
198 #ifdef LCD_TEST_PATTERN
201 /* set framebuffer to background color */
202 #if (LCD_BPP != LCD_COLOR32)
203 memset((char *)lcd_base
, bg_color
, lcd_line_length
* panel_info
.vl_row
);
205 u32
*ppix
= lcd_base
;
208 i
< (lcd_line_length
* panel_info
.vl_row
)/NBYTES(panel_info
.vl_bpix
);
214 /* setup text-console */
215 debug("[LCD] setting up console...\n");
216 lcd_init_console(lcd_base
,
220 /* Paint the logo and retrieve LCD base address */
221 debug("[LCD] Drawing the logo...\n");
223 s
= getenv("splashimage");
226 addr
= simple_strtoul(s
, NULL
, 16);
227 if (lcd_splash(addr
) == 0) {
235 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
236 addr
= (ulong
)lcd_base
+ BMP_LOGO_HEIGHT
* lcd_line_length
;
237 lcd_init_console((void *)addr
, panel_info
.vl_col
,
238 panel_info
.vl_row
, panel_info
.vl_rot
);
243 static int do_lcd_clear(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
249 U_BOOT_CMD(cls
, 1, 1, do_lcd_clear
, "clear screen", "");
251 static int lcd_init(void *lcdbase
)
253 debug("[LCD] Initializing LCD frambuffer at %p\n", lcdbase
);
254 lcd_ctrl_init(lcdbase
);
257 * lcd_ctrl_init() of some drivers (i.e. bcm2835 on rpi) ignores
258 * the 'lcdbase' argument and uses custom lcd base address
259 * by setting up gd->fb_base. Check for this condition and fixup
260 * 'lcd_base' address.
262 if (map_to_sysmem(lcdbase
) != gd
->fb_base
)
263 lcd_base
= map_sysmem(gd
->fb_base
, 0);
265 debug("[LCD] Using LCD frambuffer at %p\n", lcd_base
);
267 lcd_get_size(&lcd_line_length
);
272 /* Initialize the console */
274 #ifdef CONFIG_LCD_INFO_BELOW_LOGO
275 lcd_set_row(7 + BMP_LOGO_HEIGHT
/ VIDEO_FONT_HEIGHT
);
277 lcd_set_row(1); /* leave 1 blank line below logo */
284 * This is called early in the system initialization to grab memory
285 * for the LCD controller.
286 * Returns new address for monitor, after reserving LCD buffer memory
288 * Note that this is running from ROM, so no write access to global data.
290 ulong
lcd_setmem(ulong addr
)
295 debug("LCD panel info: %d x %d, %d bit/pix\n", panel_info
.vl_col
,
296 panel_info
.vl_row
, NBITS(panel_info
.vl_bpix
));
298 size
= lcd_get_size(&line_length
);
300 /* Round up to nearest full page, or MMU section if defined */
301 size
= ALIGN(size
, CONFIG_LCD_ALIGNMENT
);
302 addr
= ALIGN(addr
- CONFIG_LCD_ALIGNMENT
+ 1, CONFIG_LCD_ALIGNMENT
);
304 /* Allocate pages for the frame buffer. */
307 debug("Reserving %ldk for LCD Framebuffer at: %08lx\n",
313 static void lcd_setfgcolor(int color
)
315 lcd_color_fg
= color
;
318 int lcd_getfgcolor(void)
323 static void lcd_setbgcolor(int color
)
325 lcd_color_bg
= color
;
328 int lcd_getbgcolor(void)
333 #ifdef CONFIG_LCD_LOGO
334 __weak
void lcd_logo_set_cmap(void)
337 ushort
*cmap
= configuration_get_cmap();
339 for (i
= 0; i
< ARRAY_SIZE(bmp_logo_palette
); ++i
)
340 *cmap
++ = bmp_logo_palette
[i
];
343 void lcd_logo_plot(int x
, int y
)
346 uchar
*bmap
= &bmp_logo_bitmap
[0];
347 unsigned bpix
= NBITS(panel_info
.vl_bpix
);
348 uchar
*fb
= (uchar
*)(lcd_base
+ y
* lcd_line_length
+ x
* bpix
/ 8);
351 debug("Logo: width %d height %d colors %d\n",
352 BMP_LOGO_WIDTH
, BMP_LOGO_HEIGHT
, BMP_LOGO_COLORS
);
359 for (i
= 0; i
< BMP_LOGO_HEIGHT
; ++i
) {
360 memcpy(fb
, bmap
, BMP_LOGO_WIDTH
);
361 bmap
+= BMP_LOGO_WIDTH
;
362 fb
+= panel_info
.vl_col
;
365 else { /* true color mode */
368 for (i
= 0; i
< BMP_LOGO_HEIGHT
; ++i
) {
369 for (j
= 0; j
< BMP_LOGO_WIDTH
; j
++) {
370 col16
= bmp_logo_palette
[(bmap
[j
]-16)];
372 ((col16
& 0x000F) << 1) |
373 ((col16
& 0x00F0) << 3) |
374 ((col16
& 0x0F00) << 4);
376 bmap
+= BMP_LOGO_WIDTH
;
377 fb16
+= panel_info
.vl_col
;
385 static inline void lcd_logo_plot(int x
, int y
) {}
386 #endif /* CONFIG_LCD_LOGO */
388 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
389 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
390 #define BMP_ALIGN_CENTER 0x7FFF
392 static void splash_align_axis(int *axis
, unsigned long panel_size
,
393 unsigned long picture_size
)
395 unsigned long panel_picture_delta
= panel_size
- picture_size
;
396 unsigned long axis_alignment
;
398 if (*axis
== BMP_ALIGN_CENTER
)
399 axis_alignment
= panel_picture_delta
/ 2;
401 axis_alignment
= panel_picture_delta
+ *axis
+ 1;
405 *axis
= max(0, (int)axis_alignment
);
409 #ifdef CONFIG_LCD_BMP_RLE8
410 #define BMP_RLE8_ESCAPE 0
411 #define BMP_RLE8_EOL 0
412 #define BMP_RLE8_EOBMP 1
413 #define BMP_RLE8_DELTA 2
415 static void draw_unencoded_bitmap(ushort
**fbp
, uchar
*bmap
, ushort
*cmap
,
419 *(*fbp
)++ = cmap
[*bmap
++];
424 static void draw_encoded_bitmap(ushort
**fbp
, ushort c
, int cnt
)
427 int cnt_8copy
= cnt
>> 3;
429 cnt
-= cnt_8copy
<< 3;
430 while (cnt_8copy
> 0) {
449 * Do not call this function directly, must be called from lcd_display_bitmap.
451 static void lcd_display_rle8_bitmap(struct bmp_image
*bmp
, ushort
*cmap
,
452 uchar
*fb
, int x_off
, int y_off
)
460 width
= get_unaligned_le32(&bmp
->header
.width
);
461 height
= get_unaligned_le32(&bmp
->header
.height
);
462 bmap
= (uchar
*)bmp
+ get_unaligned_le32(&bmp
->header
.data_offset
);
468 if (bmap
[0] == BMP_RLE8_ESCAPE
) {
475 /* 16bpix, 2-byte per pixel, width should *2 */
476 fb
-= (width
* 2 + lcd_line_length
);
486 /* 16bpix, 2-byte per pixel, x should *2 */
487 fb
= (uchar
*) (lcd_base
+ (y
+ y_off
- 1)
488 * lcd_line_length
+ (x
+ x_off
) * 2);
497 if (x
+ runlen
> width
)
501 draw_unencoded_bitmap(
516 /* aggregate the same code */
517 while (bmap
[0] == 0xff &&
518 bmap
[2] != BMP_RLE8_ESCAPE
&&
519 bmap
[1] == bmap
[3]) {
523 if (x
+ runlen
> width
)
527 draw_encoded_bitmap((ushort
**)&fb
,
538 __weak
void fb_put_byte(uchar
**fb
, uchar
**from
)
540 *(*fb
)++ = *(*from
)++;
543 #if defined(CONFIG_BMP_16BPP)
544 __weak
void fb_put_word(uchar
**fb
, uchar
**from
)
546 *(*fb
)++ = *(*from
)++;
547 *(*fb
)++ = *(*from
)++;
549 #endif /* CONFIG_BMP_16BPP */
551 __weak
void lcd_set_cmap(struct bmp_image
*bmp
, unsigned colors
)
554 struct bmp_color_table_entry cte
;
555 ushort
*cmap
= configuration_get_cmap();
557 for (i
= 0; i
< colors
; ++i
) {
558 cte
= bmp
->color_table
[i
];
559 *cmap
= (((cte
.red
) << 8) & 0xf800) |
560 (((cte
.green
) << 3) & 0x07e0) |
561 (((cte
.blue
) >> 3) & 0x001f);
562 #if defined(CONFIG_MPC823)
570 int lcd_display_bitmap(ulong bmp_image
, int x
, int y
)
572 ushort
*cmap_base
= NULL
;
575 struct bmp_image
*bmp
= (struct bmp_image
*)map_sysmem(bmp_image
, 0);
578 unsigned long width
, height
, byte_width
;
579 unsigned long pwidth
= panel_info
.vl_col
;
580 unsigned colors
, bpix
, bmp_bpix
;
582 struct bmp_color_table_entry
*palette
= bmp
->color_table
;
584 if (!bmp
|| !(bmp
->header
.signature
[0] == 'B' &&
585 bmp
->header
.signature
[1] == 'M')) {
586 printf("Error: no valid bmp image at %lx\n", bmp_image
);
591 width
= get_unaligned_le32(&bmp
->header
.width
);
592 height
= get_unaligned_le32(&bmp
->header
.height
);
593 bmp_bpix
= get_unaligned_le16(&bmp
->header
.bit_count
);
594 hdr_size
= get_unaligned_le16(&bmp
->header
.size
);
595 debug("hdr_size=%d, bmp_bpix=%d\n", hdr_size
, bmp_bpix
);
597 colors
= 1 << bmp_bpix
;
599 bpix
= NBITS(panel_info
.vl_bpix
);
601 if (bpix
!= 1 && bpix
!= 8 && bpix
!= 16 && bpix
!= 32) {
602 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
609 * We support displaying 8bpp BMPs on 16bpp LCDs
610 * and displaying 24bpp BMPs on 32bpp LCDs
612 if (bpix
!= bmp_bpix
&&
613 !(bmp_bpix
== 8 && bpix
== 16) &&
614 !(bmp_bpix
== 24 && bpix
== 32)) {
615 printf ("Error: %d bit/pixel mode, but BMP has %d bit/pixel\n",
616 bpix
, get_unaligned_le16(&bmp
->header
.bit_count
));
620 debug("Display-bmp: %d x %d with %d colors, display %d\n",
621 (int)width
, (int)height
, (int)colors
, 1 << bpix
);
624 lcd_set_cmap(bmp
, colors
);
626 padded_width
= (width
& 0x3 ? (width
& ~0x3) + 4 : width
);
628 #ifdef CONFIG_SPLASH_SCREEN_ALIGN
629 splash_align_axis(&x
, pwidth
, width
);
630 splash_align_axis(&y
, panel_info
.vl_row
, height
);
631 #endif /* CONFIG_SPLASH_SCREEN_ALIGN */
633 if ((x
+ width
) > pwidth
)
635 if ((y
+ height
) > panel_info
.vl_row
)
636 height
= panel_info
.vl_row
- y
;
638 bmap
= (uchar
*)bmp
+ get_unaligned_le32(&bmp
->header
.data_offset
);
639 fb
= (uchar
*)(lcd_base
+
640 (y
+ height
- 1) * lcd_line_length
+ x
* bpix
/ 8);
645 cmap_base
= configuration_get_cmap();
646 #ifdef CONFIG_LCD_BMP_RLE8
647 u32 compression
= get_unaligned_le32(&bmp
->header
.compression
);
648 debug("compressed %d %d\n", compression
, BMP_BI_RLE8
);
649 if (compression
== BMP_BI_RLE8
) {
651 /* TODO implement render code for bpix != 16 */
652 printf("Error: only support 16 bpix");
655 lcd_display_rle8_bitmap(bmp
, cmap_base
, fb
, x
, y
);
663 byte_width
= width
* 2;
665 for (i
= 0; i
< height
; ++i
) {
667 for (j
= 0; j
< width
; j
++) {
669 fb_put_byte(&fb
, &bmap
);
671 struct bmp_color_table_entry
*entry
;
675 val
= cmap_base
[*bmap
];
677 entry
= &palette
[*bmap
];
678 val
= entry
->blue
>> 3 |
679 entry
->green
>> 2 << 5 |
680 entry
->red
>> 3 << 11;
682 *(uint16_t *)fb
= val
;
684 fb
+= sizeof(uint16_t) / sizeof(*fb
);
687 bmap
+= (padded_width
- width
);
688 fb
-= byte_width
+ lcd_line_length
;
692 #if defined(CONFIG_BMP_16BPP)
694 for (i
= 0; i
< height
; ++i
) {
696 for (j
= 0; j
< width
; j
++)
697 fb_put_word(&fb
, &bmap
);
699 bmap
+= (padded_width
- width
) * 2;
700 fb
-= width
* 2 + lcd_line_length
;
703 #endif /* CONFIG_BMP_16BPP */
704 #if defined(CONFIG_BMP_24BMP)
706 for (i
= 0; i
< height
; ++i
) {
707 for (j
= 0; j
< width
; j
++) {
713 fb
-= lcd_line_length
+ width
* (bpix
/ 8);
716 #endif /* CONFIG_BMP_24BMP */
717 #if defined(CONFIG_BMP_32BPP)
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_32BPP */
739 static void lcd_logo(void)
743 #ifdef CONFIG_LCD_INFO
744 lcd_set_col(LCD_INFO_X
/ VIDEO_FONT_WIDTH
);
745 lcd_set_row(LCD_INFO_Y
/ VIDEO_FONT_HEIGHT
);
746 lcd_show_board_info();
747 #endif /* CONFIG_LCD_INFO */
750 #ifdef CONFIG_SPLASHIMAGE_GUARD
751 static int on_splashimage(const char *name
, const char *value
, enum env_op op
,
757 if (op
== env_op_delete
)
760 addr
= simple_strtoul(value
, NULL
, 16);
761 /* See README.displaying-bmps */
762 aligned
= (addr
% 4 == 2);
764 printf("Invalid splashimage value. Value must be 16 bit aligned, but not 32 bit aligned\n");
771 U_BOOT_ENV_CALLBACK(splashimage
, on_splashimage
);
774 int lcd_get_pixel_width(void)
776 return panel_info
.vl_col
;
779 int lcd_get_pixel_height(void)
781 return panel_info
.vl_row
;