include/lcd.h

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