Merge branch 'master' of git://git.denx.de/u-boot
[oweals/u-boot.git] / include / lcd.h
1 /*
2  * MPC823 and PXA LCD Controller
3  *
4  * Modeled after video interface by Paolo Scaffardi
5  *
6  *
7  * (C) Copyright 2001
8  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
9  *
10  * SPDX-License-Identifier:     GPL-2.0+
11  */
12
13 #ifndef _LCD_H_
14 #define _LCD_H_
15 #include <lcd_console.h>
16 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
17 #include <bmp_layout.h>
18 #include <asm/byteorder.h>
19 #endif
20
21 extern char lcd_is_enabled;
22 extern int lcd_line_length;
23 extern struct vidinfo panel_info;
24
25 void lcd_ctrl_init(void *lcdbase);
26 void lcd_enable(void);
27 void lcd_setcolreg(ushort regno, ushort red, ushort green, ushort blue);
28
29 struct bmp_image *gunzip_bmp(unsigned long addr, unsigned long *lenp,
30                              void **alloc_addr);
31 int bmp_display(ulong addr, int x, int y);
32
33 /**
34  * Set whether we need to flush the dcache when changing the LCD image. This
35  * defaults to off.
36  *
37  * @param flush         non-zero to flush cache after update, 0 to skip
38  */
39 void lcd_set_flush_dcache(int flush);
40
41 #if defined CONFIG_MPC823
42 #include <mpc823_lcd.h>
43 #elif defined(CONFIG_CPU_PXA25X) || defined(CONFIG_CPU_PXA27X) || \
44         defined CONFIG_CPU_MONAHANS
45 #include <pxa_lcd.h>
46 #elif defined(CONFIG_ATMEL_LCD) || defined(CONFIG_ATMEL_HLCD)
47 #include <atmel_lcd.h>
48 #elif defined(CONFIG_EXYNOS_FB)
49 #include <exynos_lcd.h>
50 #else
51 typedef struct vidinfo {
52         ushort  vl_col;         /* Number of columns (i.e. 160) */
53         ushort  vl_row;         /* Number of rows (i.e. 100) */
54         u_char  vl_bpix;        /* Bits per pixel, 0 = 1 */
55         ushort  *cmap;          /* Pointer to the colormap */
56         void    *priv;          /* Pointer to driver-specific data */
57 } vidinfo_t;
58
59 static __maybe_unused ushort *configuration_get_cmap(void)
60 {
61         return panel_info.cmap;
62 }
63 #endif
64
65 ushort *configuration_get_cmap(void);
66
67 extern vidinfo_t panel_info;
68
69 void lcd_putc(const char c);
70 void lcd_puts(const char *s);
71 void lcd_printf(const char *fmt, ...);
72 void lcd_clear(void);
73 int lcd_display_bitmap(ulong bmp_image, int x, int y);
74
75 /**
76  * Get the width of the LCD in pixels
77  *
78  * @return width of LCD in pixels
79  */
80 int lcd_get_pixel_width(void);
81
82 /**
83  * Get the height of the LCD in pixels
84  *
85  * @return height of LCD in pixels
86  */
87 int lcd_get_pixel_height(void);
88
89 /**
90  * Get the number of text lines/rows on the LCD
91  *
92  * @return number of rows
93  */
94 int lcd_get_screen_rows(void);
95
96 /**
97  * Get the number of text columns on the LCD
98  *
99  * @return number of columns
100  */
101 int lcd_get_screen_columns(void);
102
103 /**
104  * Get the background color of the LCD
105  *
106  * @return background color value
107  */
108 int lcd_getbgcolor(void);
109
110 /**
111  * Get the foreground color of the LCD
112  *
113  * @return foreground color value
114  */
115 int lcd_getfgcolor(void);
116
117 /**
118  * Set the position of the text cursor
119  *
120  * @param col   Column to place cursor (0 = left side)
121  * @param row   Row to place cursor (0 = top line)
122  */
123 void lcd_position_cursor(unsigned col, unsigned row);
124
125 /* Allow boards to customize the information displayed */
126 void lcd_show_board_info(void);
127
128 /* Return the size of the LCD frame buffer, and the line length */
129 int lcd_get_size(int *line_length);
130
131 /* Update the LCD / flush the cache */
132 void lcd_sync(void);
133
134 /*
135  *  Information about displays we are using. This is for configuring
136  *  the LCD controller and memory allocation. Someone has to know what
137  *  is connected, as we can't autodetect anything.
138  */
139 #define CONFIG_SYS_HIGH 0       /* Pins are active high                 */
140 #define CONFIG_SYS_LOW  1       /* Pins are active low                  */
141
142 #define LCD_MONOCHROME  0
143 #define LCD_COLOR2      1
144 #define LCD_COLOR4      2
145 #define LCD_COLOR8      3
146 #define LCD_COLOR16     4
147 #define LCD_COLOR32     5
148
149 #if defined(CONFIG_LCD_INFO_BELOW_LOGO)
150 #define LCD_INFO_X              0
151 #define LCD_INFO_Y              (BMP_LOGO_HEIGHT + VIDEO_FONT_HEIGHT)
152 #elif defined(CONFIG_LCD_LOGO)
153 #define LCD_INFO_X              (BMP_LOGO_WIDTH + 4 * VIDEO_FONT_WIDTH)
154 #define LCD_INFO_Y              VIDEO_FONT_HEIGHT
155 #else
156 #define LCD_INFO_X              VIDEO_FONT_WIDTH
157 #define LCD_INFO_Y              VIDEO_FONT_HEIGHT
158 #endif
159
160 /* Default to 8bpp if bit depth not specified */
161 #ifndef LCD_BPP
162 #define LCD_BPP                 LCD_COLOR8
163 #endif
164
165 #ifndef LCD_DF
166 #define LCD_DF                  1
167 #endif
168
169 /* Calculate nr. of bits per pixel  and nr. of colors */
170 #define NBITS(bit_code)         (1 << (bit_code))
171 #define NCOLORS(bit_code)       (1 << NBITS(bit_code))
172
173 #if LCD_BPP == LCD_COLOR8
174 # define CONSOLE_COLOR_BLACK    0
175 # define CONSOLE_COLOR_RED      1
176 # define CONSOLE_COLOR_GREEN    2
177 # define CONSOLE_COLOR_YELLOW   3
178 # define CONSOLE_COLOR_BLUE     4
179 # define CONSOLE_COLOR_MAGENTA  5
180 # define CONSOLE_COLOR_CYAN     6
181 # define CONSOLE_COLOR_GREY     14
182 # define CONSOLE_COLOR_WHITE    15              /* Must remain last / highest */
183 #elif LCD_BPP == LCD_COLOR32
184 #define CONSOLE_COLOR_RED       0x00ff0000
185 #define CONSOLE_COLOR_GREEN     0x0000ff00
186 #define CONSOLE_COLOR_YELLOW    0x00ffff00
187 #define CONSOLE_COLOR_BLUE      0x000000ff
188 #define CONSOLE_COLOR_MAGENTA   0x00ff00ff
189 #define CONSOLE_COLOR_CYAN      0x0000ffff
190 #define CONSOLE_COLOR_GREY      0x00aaaaaa
191 #define CONSOLE_COLOR_BLACK     0x00000000
192 #define CONSOLE_COLOR_WHITE     0x00ffffff      /* Must remain last / highest */
193 #define NBYTES(bit_code)        (NBITS(bit_code) >> 3)
194 #else /* 16bpp color definitions */
195 #define CONSOLE_COLOR_BLACK     0x0000
196 #define CONSOLE_COLOR_WHITE     0xffff          /* Must remain last / highest */
197 #endif /* color definitions */
198
199 #ifndef PAGE_SIZE
200 #define PAGE_SIZE       4096
201 #endif
202
203 #endif  /* _LCD_H_ */