gen: omap: Add timer_get_us to OMAP boards
[chromiumos/third_party/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  * See file CREDITS for list of people who contributed to this
11  * project.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License as
15  * published by the Free Software Foundation; either version 2 of
16  * the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
26  * MA 02111-1307 USA
27  */
28
29 #ifndef _LCD_H_
30 #define _LCD_H_
31
32 extern char lcd_is_enabled;
33
34 extern int lcd_line_length;
35 extern int lcd_color_fg;
36 extern int lcd_color_bg;
37
38 /*
39  * Frame buffer memory information
40  */
41 extern void *lcd_base;          /* Start of framebuffer memory  */
42 extern void *lcd_console_address;       /* Start of console buffer      */
43
44 extern short console_col;
45 extern short console_row;
46 extern struct vidinfo panel_info;
47
48 extern void lcd_ctrl_init (void *lcdbase);
49 extern void lcd_enable (void);
50
51 /* setcolreg used in 8bpp/16bpp; initcolregs used in monochrome */
52 extern void lcd_setcolreg (ushort regno,
53                                 ushort red, ushort green, ushort blue);
54 extern void lcd_initcolregs (void);
55
56 /* gunzip_bmp used if CONFIG_VIDEO_BMP_GZIP */
57 extern struct bmp_image *gunzip_bmp(unsigned long addr, unsigned long *lenp);
58
59 /**
60  * Set whether we need to flush the dcache when changing the LCD image. This
61  * defaults to off.
62  *
63  * @param flush         non-zero to flush cache after update, 0 to skip
64  */
65 void lcd_set_flush_dcache(int flush);
66
67 #if defined CONFIG_MPC823
68 /*
69  * LCD controller stucture for MPC823 CPU
70  */
71 typedef struct vidinfo {
72         ushort  vl_col;         /* Number of columns (i.e. 640) */
73         ushort  vl_row;         /* Number of rows (i.e. 480) */
74         ushort  vl_width;       /* Width of display area in millimeters */
75         ushort  vl_height;      /* Height of display area in millimeters */
76
77         /* LCD configuration register */
78         u_char  vl_clkp;        /* Clock polarity */
79         u_char  vl_oep;         /* Output Enable polarity */
80         u_char  vl_hsp;         /* Horizontal Sync polarity */
81         u_char  vl_vsp;         /* Vertical Sync polarity */
82         u_char  vl_dp;          /* Data polarity */
83         u_char  vl_bpix;        /* Bits per pixel, 0 = 1, 1 = 2, 2 = 4, 3 = 8 */
84         u_char  vl_lbw;         /* LCD Bus width, 0 = 4, 1 = 8 */
85         u_char  vl_splt;        /* Split display, 0 = single-scan, 1 = dual-scan */
86         u_char  vl_clor;        /* Color, 0 = mono, 1 = color */
87         u_char  vl_tft;         /* 0 = passive, 1 = TFT */
88
89         /* Horizontal control register. Timing from data sheet */
90         ushort  vl_wbl;         /* Wait between lines */
91
92         /* Vertical control register */
93         u_char  vl_vpw;         /* Vertical sync pulse width */
94         u_char  vl_lcdac;       /* LCD AC timing */
95         u_char  vl_wbf;         /* Wait between frames */
96 } vidinfo_t;
97
98 #elif defined(CONFIG_CPU_PXA25X) || defined(CONFIG_CPU_PXA27X) || \
99         defined CONFIG_CPU_MONAHANS
100 /*
101  * PXA LCD DMA descriptor
102  */
103 struct pxafb_dma_descriptor {
104         u_long  fdadr;          /* Frame descriptor address register */
105         u_long  fsadr;          /* Frame source address register */
106         u_long  fidr;           /* Frame ID register */
107         u_long  ldcmd;          /* Command register */
108 };
109
110 /*
111  * PXA LCD info
112  */
113 struct pxafb_info {
114
115         /* Misc registers */
116         u_long  reg_lccr3;
117         u_long  reg_lccr2;
118         u_long  reg_lccr1;
119         u_long  reg_lccr0;
120         u_long  fdadr0;
121         u_long  fdadr1;
122
123         /* DMA descriptors */
124         struct  pxafb_dma_descriptor *  dmadesc_fblow;
125         struct  pxafb_dma_descriptor *  dmadesc_fbhigh;
126         struct  pxafb_dma_descriptor *  dmadesc_palette;
127
128         u_long  screen;         /* physical address of frame buffer */
129         u_long  palette;        /* physical address of palette memory */
130         u_int   palette_size;
131 };
132
133 /*
134  * LCD controller stucture for PXA CPU
135  */
136 typedef struct vidinfo {
137         ushort  vl_col;         /* Number of columns (i.e. 640) */
138         ushort  vl_row;         /* Number of rows (i.e. 480) */
139         ushort  vl_width;       /* Width of display area in millimeters */
140         ushort  vl_height;      /* Height of display area in millimeters */
141
142         /* LCD configuration register */
143         u_char  vl_clkp;        /* Clock polarity */
144         u_char  vl_oep;         /* Output Enable polarity */
145         u_char  vl_hsp;         /* Horizontal Sync polarity */
146         u_char  vl_vsp;         /* Vertical Sync polarity */
147         u_char  vl_dp;          /* Data polarity */
148         u_char  vl_bpix;        /* Bits per pixel, 0 = 1, 1 = 2, 2 = 4, 3 = 8, 4 = 16 */
149         u_char  vl_lbw;         /* LCD Bus width, 0 = 4, 1 = 8 */
150         u_char  vl_splt;        /* Split display, 0 = single-scan, 1 = dual-scan */
151         u_char  vl_clor;        /* Color, 0 = mono, 1 = color */
152         u_char  vl_tft;         /* 0 = passive, 1 = TFT */
153
154         /* Horizontal control register. Timing from data sheet */
155         ushort  vl_hpw;         /* Horz sync pulse width */
156         u_char  vl_blw;         /* Wait before of line */
157         u_char  vl_elw;         /* Wait end of line */
158
159         /* Vertical control register. */
160         u_char  vl_vpw;         /* Vertical sync pulse width */
161         u_char  vl_bfw;         /* Wait before of frame */
162         u_char  vl_efw;         /* Wait end of frame */
163
164         /* PXA LCD controller params */
165         struct  pxafb_info pxa;
166 } vidinfo_t;
167
168 #elif defined(CONFIG_ATMEL_LCD)
169
170 typedef struct vidinfo {
171         ushort vl_col;          /* Number of columns (i.e. 640) */
172         ushort vl_row;          /* Number of rows (i.e. 480) */
173         u_long vl_clk;  /* pixel clock in ps    */
174
175         /* LCD configuration register */
176         u_long vl_sync;         /* Horizontal / vertical sync */
177         u_long vl_bpix;         /* Bits per pixel, 0 = 1, 1 = 2, 2 = 4, 3 = 8, 4 = 16 */
178         u_long vl_tft;          /* 0 = passive, 1 = TFT */
179         u_long vl_cont_pol_low; /* contrast polarity is low */
180
181         /* Horizontal control register. */
182         u_long vl_hsync_len;    /* Length of horizontal sync */
183         u_long vl_left_margin;  /* Time from sync to picture */
184         u_long vl_right_margin; /* Time from picture to sync */
185
186         /* Vertical control register. */
187         u_long vl_vsync_len;    /* Length of vertical sync */
188         u_long vl_upper_margin; /* Time from sync to picture */
189         u_long vl_lower_margin; /* Time from picture to sync */
190
191         u_long  mmio;           /* Memory mapped registers */
192 } vidinfo_t;
193
194 #else
195
196 typedef struct vidinfo {
197         ushort  vl_col;         /* Number of columns (i.e. 160) */
198         ushort  vl_row;         /* Number of rows (i.e. 100) */
199
200         u_char  vl_bpix;        /* Bits per pixel, 0 = 1 */
201
202         ushort  *cmap;          /* Pointer to the colormap */
203
204         void    *priv;          /* Pointer to driver-specific data */
205 } vidinfo_t;
206
207 #endif /* CONFIG_MPC823, CONFIG_CPU_PXA25X, CONFIG_MCC200, CONFIG_ATMEL_LCD */
208
209 extern vidinfo_t panel_info;
210
211 /* Video functions */
212
213 #if defined(CONFIG_RBC823)
214 void    lcd_disable     (void);
215 #endif
216
217
218 /* int  lcd_init        (void *lcdbase); */
219 void    lcd_putc        (const char c);
220 void    lcd_puts        (const char *s);
221 void    lcd_printf      (const char *fmt, ...);
222 void    lcd_clear(void);
223 int     lcd_display_bitmap(ulong bmp_image, int x, int y);
224 int     lcd_get_pixel_width(void);
225 int     lcd_get_pixel_height(void);
226 int     lcd_get_screen_rows(void);
227 int     lcd_get_screen_columns(void);
228 void    lcd_position_cursor(unsigned col, unsigned row);
229
230 /* Allow boards to customize the information displayed */
231 void lcd_show_board_info(void);
232
233 /* Return the size of the LCD frame buffer, and the line length */
234 int lcd_get_size(int *line_length);
235
236 /************************************************************************/
237 /* ** BITMAP DISPLAY SUPPORT                                            */
238 /************************************************************************/
239 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
240 # include <bmp_layout.h>
241 # include <asm/byteorder.h>
242 #endif
243
244 /*
245  *  Information about displays we are using. This is for configuring
246  *  the LCD controller and memory allocation. Someone has to know what
247  *  is connected, as we can't autodetect anything.
248  */
249 #define CONFIG_SYS_HIGH 0       /* Pins are active high                 */
250 #define CONFIG_SYS_LOW          1       /* Pins are active low                  */
251
252 #define LCD_MONOCHROME  0
253 #define LCD_COLOR2      1
254 #define LCD_COLOR4      2
255 #define LCD_COLOR8      3
256 #define LCD_COLOR16     4
257
258 /*----------------------------------------------------------------------*/
259 #if defined(CONFIG_LCD_INFO_BELOW_LOGO)
260 # define LCD_INFO_X             0
261 # define LCD_INFO_Y             (BMP_LOGO_HEIGHT + VIDEO_FONT_HEIGHT)
262 #elif defined(CONFIG_LCD_LOGO)
263 # define LCD_INFO_X             (BMP_LOGO_WIDTH + 4 * VIDEO_FONT_WIDTH)
264 # define LCD_INFO_Y             (VIDEO_FONT_HEIGHT)
265 #else
266 # define LCD_INFO_X             (VIDEO_FONT_WIDTH)
267 # define LCD_INFO_Y             (VIDEO_FONT_HEIGHT)
268 #endif
269
270 /* Default to 8bpp if bit depth not specified */
271 #ifndef LCD_BPP
272 # define LCD_BPP                        LCD_COLOR8
273 #endif
274 #ifndef LCD_DF
275 # define LCD_DF                 1
276 #endif
277
278 /* Calculate nr. of bits per pixel  and nr. of colors */
279 #define NBITS(bit_code)         (1 << (bit_code))
280 #define NCOLORS(bit_code)       (1 << NBITS(bit_code))
281
282 /************************************************************************/
283 /* ** CONSOLE CONSTANTS                                                 */
284 /************************************************************************/
285 #if LCD_BPP == LCD_MONOCHROME
286
287 /*
288  * Simple black/white definitions
289  */
290 # define CONSOLE_COLOR_BLACK    0
291 # define CONSOLE_COLOR_WHITE    1       /* Must remain last / highest   */
292
293 #elif LCD_BPP == LCD_COLOR8
294
295 /*
296  * 8bpp color definitions
297  */
298 # define CONSOLE_COLOR_BLACK    0
299 # define CONSOLE_COLOR_RED      1
300 # define CONSOLE_COLOR_GREEN    2
301 # define CONSOLE_COLOR_YELLOW   3
302 # define CONSOLE_COLOR_BLUE     4
303 # define CONSOLE_COLOR_MAGENTA  5
304 # define CONSOLE_COLOR_CYAN     6
305 # define CONSOLE_COLOR_GREY     14
306 # define CONSOLE_COLOR_WHITE    15      /* Must remain last / highest   */
307
308 #else
309
310 /*
311  * 16bpp color definitions
312  */
313 # define CONSOLE_COLOR_BLACK    0x0000
314 # define CONSOLE_COLOR_WHITE    0xffff  /* Must remain last / highest   */
315
316 #endif /* color definitions */
317
318 /************************************************************************/
319 #ifndef PAGE_SIZE
320 # define PAGE_SIZE      4096
321 #endif
322
323 /************************************************************************/
324 /* ** CONSOLE DEFINITIONS & FUNCTIONS                                   */
325 /************************************************************************/
326 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
327 # define CONSOLE_ROWS           ((panel_info.vl_row-BMP_LOGO_HEIGHT) \
328                                         / VIDEO_FONT_HEIGHT)
329 #else
330 # define CONSOLE_ROWS           (panel_info.vl_row / VIDEO_FONT_HEIGHT)
331 #endif
332
333 #define CONSOLE_COLS            (panel_info.vl_col / VIDEO_FONT_WIDTH)
334 #define CONSOLE_ROW_SIZE        (VIDEO_FONT_HEIGHT * lcd_line_length)
335 #define CONSOLE_ROW_FIRST       (lcd_console_address)
336 #define CONSOLE_ROW_SECOND      (lcd_console_address + CONSOLE_ROW_SIZE)
337 #define CONSOLE_ROW_LAST        (lcd_console_address + CONSOLE_SIZE \
338                                         - CONSOLE_ROW_SIZE)
339 #define CONSOLE_SIZE            (CONSOLE_ROW_SIZE * CONSOLE_ROWS)
340 #define CONSOLE_SCROLL_SIZE     (CONSOLE_SIZE - CONSOLE_ROW_SIZE)
341
342 #if LCD_BPP == LCD_MONOCHROME
343 # define COLOR_MASK(c)          ((c)      | (c) << 1 | (c) << 2 | (c) << 3 | \
344                                  (c) << 4 | (c) << 5 | (c) << 6 | (c) << 7)
345 #elif (LCD_BPP == LCD_COLOR8) || (LCD_BPP == LCD_COLOR16)
346 # define COLOR_MASK(c)          (c)
347 #else
348 # error Unsupported LCD BPP.
349 #endif
350
351 /************************************************************************/
352
353 #endif  /* _LCD_H_ */