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 extern int bmp_display(ulong addr, int x, int y);
  61
  62 /**
  63  * Set whether we need to flush the dcache when changing the LCD image. This
  64  * defaults to off.
  65  *
  66  * @param flush         non-zero to flush cache after update, 0 to skip
  67  */
  68 void lcd_set_flush_dcache(int flush);
  69
  70 #if defined CONFIG_MPC823
  71 /*
  72  * LCD controller stucture for MPC823 CPU
  73  */
  74 typedef struct vidinfo {
  75         ushort  vl_col;         /* Number of columns (i.e. 640) */
  76         ushort  vl_row;         /* Number of rows (i.e. 480) */
  77         ushort  vl_width;       /* Width of display area in millimeters */
  78         ushort  vl_height;      /* Height of display area in millimeters */
  79
  80         /* LCD configuration register */
  81         u_char  vl_clkp;        /* Clock polarity */
  82         u_char  vl_oep;         /* Output Enable polarity */
  83         u_char  vl_hsp;         /* Horizontal Sync polarity */
  84         u_char  vl_vsp;         /* Vertical Sync polarity */
  85         u_char  vl_dp;          /* Data polarity */
  86         u_char  vl_bpix;        /* Bits per pixel, 0 = 1, 1 = 2, 2 = 4, 3 = 8 */
  87         u_char  vl_lbw;         /* LCD Bus width, 0 = 4, 1 = 8 */
  88         u_char  vl_splt;        /* Split display, 0 = single-scan, 1 = dual-scan */
  89         u_char  vl_clor;        /* Color, 0 = mono, 1 = color */
  90         u_char  vl_tft;         /* 0 = passive, 1 = TFT */
  91
  92         /* Horizontal control register. Timing from data sheet */
  93         ushort  vl_wbl;         /* Wait between lines */
  94
  95         /* Vertical control register */
  96         u_char  vl_vpw;         /* Vertical sync pulse width */
  97         u_char  vl_lcdac;       /* LCD AC timing */
  98         u_char  vl_wbf;         /* Wait between frames */
  99 } vidinfo_t;
 100
 101 #elif defined(CONFIG_CPU_PXA25X) || defined(CONFIG_CPU_PXA27X) || \
 102         defined CONFIG_CPU_MONAHANS
 103 /*
 104  * PXA LCD DMA descriptor
 105  */
 106 struct pxafb_dma_descriptor {
 107         u_long  fdadr;          /* Frame descriptor address register */
 108         u_long  fsadr;          /* Frame source address register */
 109         u_long  fidr;           /* Frame ID register */
 110         u_long  ldcmd;          /* Command register */
 111 };
 112
 113 /*
 114  * PXA LCD info
 115  */
 116 struct pxafb_info {
 117
 118         /* Misc registers */
 119         u_long  reg_lccr3;
 120         u_long  reg_lccr2;
 121         u_long  reg_lccr1;
 122         u_long  reg_lccr0;
 123         u_long  fdadr0;
 124         u_long  fdadr1;
 125
 126         /* DMA descriptors */
 127         struct  pxafb_dma_descriptor *  dmadesc_fblow;
 128         struct  pxafb_dma_descriptor *  dmadesc_fbhigh;
 129         struct  pxafb_dma_descriptor *  dmadesc_palette;
 130
 131         u_long  screen;         /* physical address of frame buffer */
 132         u_long  palette;        /* physical address of palette memory */
 133         u_int   palette_size;
 134 };
 135
 136 /*
 137  * LCD controller stucture for PXA CPU
 138  */
 139 typedef struct vidinfo {
 140         ushort  vl_col;         /* Number of columns (i.e. 640) */
 141         ushort  vl_row;         /* Number of rows (i.e. 480) */
 142         ushort  vl_width;       /* Width of display area in millimeters */
 143         ushort  vl_height;      /* Height of display area in millimeters */
 144
 145         /* LCD configuration register */
 146         u_char  vl_clkp;        /* Clock polarity */
 147         u_char  vl_oep;         /* Output Enable polarity */
 148         u_char  vl_hsp;         /* Horizontal Sync polarity */
 149         u_char  vl_vsp;         /* Vertical Sync polarity */
 150         u_char  vl_dp;          /* Data polarity */
 151         u_char  vl_bpix;        /* Bits per pixel, 0 = 1, 1 = 2, 2 = 4, 3 = 8, 4 = 16 */
 152         u_char  vl_lbw;         /* LCD Bus width, 0 = 4, 1 = 8 */
 153         u_char  vl_splt;        /* Split display, 0 = single-scan, 1 = dual-scan */
 154         u_char  vl_clor;        /* Color, 0 = mono, 1 = color */
 155         u_char  vl_tft;         /* 0 = passive, 1 = TFT */
 156
 157         /* Horizontal control register. Timing from data sheet */
 158         ushort  vl_hpw;         /* Horz sync pulse width */
 159         u_char  vl_blw;         /* Wait before of line */
 160         u_char  vl_elw;         /* Wait end of line */
 161
 162         /* Vertical control register. */
 163         u_char  vl_vpw;         /* Vertical sync pulse width */
 164         u_char  vl_bfw;         /* Wait before of frame */
 165         u_char  vl_efw;         /* Wait end of frame */
 166
 167         /* PXA LCD controller params */
 168         struct  pxafb_info pxa;
 169 } vidinfo_t;
 170
 171 #elif defined(CONFIG_ATMEL_LCD) || defined(CONFIG_ATMEL_HLCD)
 172
 173 typedef struct vidinfo {
 174         ushort vl_col;          /* Number of columns (i.e. 640) */
 175         ushort vl_row;          /* Number of rows (i.e. 480) */
 176         u_long vl_clk;  /* pixel clock in ps    */
 177
 178         /* LCD configuration register */
 179         u_long vl_sync;         /* Horizontal / vertical sync */
 180         u_long vl_bpix;         /* Bits per pixel, 0 = 1, 1 = 2, 2 = 4, 3 = 8, 4 = 16 */
 181         u_long vl_tft;          /* 0 = passive, 1 = TFT */
 182         u_long vl_cont_pol_low; /* contrast polarity is low */
 183         u_long vl_clk_pol;      /* clock polarity */
 184
 185         /* Horizontal control register. */
 186         u_long vl_hsync_len;    /* Length of horizontal sync */
 187         u_long vl_left_margin;  /* Time from sync to picture */
 188         u_long vl_right_margin; /* Time from picture to sync */
 189
 190         /* Vertical control register. */
 191         u_long vl_vsync_len;    /* Length of vertical sync */
 192         u_long vl_upper_margin; /* Time from sync to picture */
 193         u_long vl_lower_margin; /* Time from picture to sync */
 194
 195         u_long  mmio;           /* Memory mapped registers */
 196 } vidinfo_t;
 197
 198 #elif defined(CONFIG_EXYNOS_FB)
 199
 200 enum {
 201         FIMD_RGB_INTERFACE = 1,
 202         FIMD_CPU_INTERFACE = 2,
 203 };
 204
 205 enum exynos_fb_rgb_mode_t {
 206         MODE_RGB_P = 0,
 207         MODE_BGR_P = 1,
 208         MODE_RGB_S = 2,
 209         MODE_BGR_S = 3,
 210 };
 211
 212 typedef struct vidinfo {
 213         ushort vl_col;          /* Number of columns (i.e. 640) */
 214         ushort vl_row;          /* Number of rows (i.e. 480) */
 215         ushort vl_width;        /* Width of display area in millimeters */
 216         ushort vl_height;       /* Height of display area in millimeters */
 217
 218         /* LCD configuration register */
 219         u_char vl_freq;         /* Frequency */
 220         u_char vl_clkp;         /* Clock polarity */
 221         u_char vl_oep;          /* Output Enable polarity */
 222         u_char vl_hsp;          /* Horizontal Sync polarity */
 223         u_char vl_vsp;          /* Vertical Sync polarity */
 224         u_char vl_dp;           /* Data polarity */
 225         u_char vl_bpix;         /* Bits per pixel */
 226
 227         /* Horizontal control register. Timing from data sheet */
 228         u_char vl_hspw;         /* Horz sync pulse width */
 229         u_char vl_hfpd;         /* Wait before of line */
 230         u_char vl_hbpd;         /* Wait end of line */
 231
 232         /* Vertical control register. */
 233         u_char  vl_vspw;        /* Vertical sync pulse width */
 234         u_char  vl_vfpd;        /* Wait before of frame */
 235         u_char  vl_vbpd;        /* Wait end of frame */
 236         u_char  vl_cmd_allow_len; /* Wait end of frame */
 237
 238         void (*cfg_gpio)(void);
 239         void (*backlight_on)(unsigned int onoff);
 240         void (*reset_lcd)(void);
 241         void (*lcd_power_on)(void);
 242         void (*cfg_ldo)(void);
 243         void (*enable_ldo)(unsigned int onoff);
 244         void (*mipi_power)(void);
 245         void (*backlight_reset)(void);
 246
 247         unsigned int win_id;
 248         unsigned int init_delay;
 249         unsigned int power_on_delay;
 250         unsigned int reset_delay;
 251         unsigned int interface_mode;
 252         unsigned int mipi_enabled;
 253         unsigned int dp_enabled;
 254         unsigned int cs_setup;
 255         unsigned int wr_setup;
 256         unsigned int wr_act;
 257         unsigned int wr_hold;
 258         unsigned int logo_on;
 259         unsigned int logo_width;
 260         unsigned int logo_height;
 261         unsigned long logo_addr;
 262         unsigned int rgb_mode;
 263         unsigned int resolution;
 264
 265         /* parent clock name(MPLL, EPLL or VPLL) */
 266         unsigned int pclk_name;
 267         /* ratio value for source clock from parent clock. */
 268         unsigned int sclk_div;
 269
 270         unsigned int dual_lcd_enabled;
 271
 272 } vidinfo_t;
 273
 274 void init_panel_info(vidinfo_t *vid);
 275
 276 #else
 277
 278 typedef struct vidinfo {
 279         ushort  vl_col;         /* Number of columns (i.e. 160) */
 280         ushort  vl_row;         /* Number of rows (i.e. 100) */
 281
 282         u_char  vl_bpix;        /* Bits per pixel, 0 = 1 */
 283
 284         ushort  *cmap;          /* Pointer to the colormap */
 285
 286         void    *priv;          /* Pointer to driver-specific data */
 287 } vidinfo_t;
 288
 289 #endif /* CONFIG_MPC823, CONFIG_CPU_PXA25X, CONFIG_MCC200, CONFIG_ATMEL_LCD */
 290
 291 extern vidinfo_t panel_info;
 292
 293 /* Video functions */
 294
 295 void    lcd_disable     (void);
 296 void    lcd_panel_disable(void);
 297
 298 /* int  lcd_init        (void *lcdbase); */
 299 void    lcd_putc        (const char c);
 300 void    lcd_puts        (const char *s);
 301 void    lcd_printf      (const char *fmt, ...);
 302 void    lcd_clear(void);
 303 int     lcd_display_bitmap(ulong bmp_image, int x, int y);
 304
 305 /**
 306  * Get the width of the LCD in pixels
 307  *
 308  * @return width of LCD in pixels
 309  */
 310 int lcd_get_pixel_width(void);
 311
 312 /**
 313  * Get the height of the LCD in pixels
 314  *
 315  * @return height of LCD in pixels
 316  */
 317 int lcd_get_pixel_height(void);
 318
 319 /**
 320  * Get the number of text lines/rows on the LCD
 321  *
 322  * @return number of rows
 323  */
 324 int lcd_get_screen_rows(void);
 325
 326 /**
 327  * Get the number of text columns on the LCD
 328  *
 329  * @return number of columns
 330  */
 331 int lcd_get_screen_columns(void);
 332
 333 /**
 334  * Set the position of the text cursor
 335  *
 336  * @param col   Column to place cursor (0 = left side)
 337  * @param row   Row to place cursor (0 = top line)
 338  */
 339 void lcd_position_cursor(unsigned col, unsigned row);
 340
 341 /* Allow boards to customize the information displayed */
 342 void lcd_show_board_info(void);
 343
 344 /* Return the size of the LCD frame buffer, and the line length */
 345 int lcd_get_size(int *line_length);
 346
 347 /************************************************************************/
 348 /* ** BITMAP DISPLAY SUPPORT                                            */
 349 /************************************************************************/
 350 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
 351 # include <bmp_layout.h>
 352 # include <asm/byteorder.h>
 353 #endif
 354
 355 /*
 356  *  Information about displays we are using. This is for configuring
 357  *  the LCD controller and memory allocation. Someone has to know what
 358  *  is connected, as we can't autodetect anything.
 359  */
 360 #define CONFIG_SYS_HIGH 0       /* Pins are active high                 */
 361 #define CONFIG_SYS_LOW          1       /* Pins are active low                  */
 362
 363 #define LCD_MONOCHROME  0
 364 #define LCD_COLOR2      1
 365 #define LCD_COLOR4      2
 366 #define LCD_COLOR8      3
 367 #define LCD_COLOR16     4
 368 #define LCD_COLOR24     5
 369
 370 /*----------------------------------------------------------------------*/
 371 #if defined(CONFIG_LCD_INFO_BELOW_LOGO)
 372 # define LCD_INFO_X             0
 373 # define LCD_INFO_Y             (BMP_LOGO_HEIGHT + VIDEO_FONT_HEIGHT)
 374 #elif defined(CONFIG_LCD_LOGO)
 375 # define LCD_INFO_X             (BMP_LOGO_WIDTH + 4 * VIDEO_FONT_WIDTH)
 376 # define LCD_INFO_Y             (VIDEO_FONT_HEIGHT)
 377 #else
 378 # define LCD_INFO_X             (VIDEO_FONT_WIDTH)
 379 # define LCD_INFO_Y             (VIDEO_FONT_HEIGHT)
 380 #endif
 381
 382 /* Default to 8bpp if bit depth not specified */
 383 #ifndef LCD_BPP
 384 # define LCD_BPP                        LCD_COLOR8
 385 #endif
 386 #ifndef LCD_DF
 387 # define LCD_DF                 1
 388 #endif
 389
 390 /* Calculate nr. of bits per pixel  and nr. of colors */
 391 #define NBITS(bit_code)         (1 << (bit_code))
 392 #define NCOLORS(bit_code)       (1 << NBITS(bit_code))
 393
 394 /************************************************************************/
 395 /* ** CONSOLE CONSTANTS                                                 */
 396 /************************************************************************/
 397 #if LCD_BPP == LCD_MONOCHROME
 398
 399 /*
 400  * Simple black/white definitions
 401  */
 402 # define CONSOLE_COLOR_BLACK    0
 403 # define CONSOLE_COLOR_WHITE    1       /* Must remain last / highest   */
 404
 405 #elif LCD_BPP == LCD_COLOR8
 406
 407 /*
 408  * 8bpp color definitions
 409  */
 410 # define CONSOLE_COLOR_BLACK    0
 411 # define CONSOLE_COLOR_RED      1
 412 # define CONSOLE_COLOR_GREEN    2
 413 # define CONSOLE_COLOR_YELLOW   3
 414 # define CONSOLE_COLOR_BLUE     4
 415 # define CONSOLE_COLOR_MAGENTA  5
 416 # define CONSOLE_COLOR_CYAN     6
 417 # define CONSOLE_COLOR_GREY     14
 418 # define CONSOLE_COLOR_WHITE    15      /* Must remain last / highest   */
 419
 420 #elif LCD_BPP == LCD_COLOR16
 421
 422 /*
 423  * 16bpp color definitions
 424  */
 425 # define CONSOLE_COLOR_BLACK    0x0000
 426 # define CONSOLE_COLOR_RED      0xf800
 427 # define CONSOLE_COLOR_GREEN    0x07e0
 428 # define CONSOLE_COLOR_YELLOW   0xffe0
 429 # define CONSOLE_COLOR_BLUE     0x001f
 430 # define CONSOLE_COLOR_MAGENTA  0xf81f
 431 # define CONSOLE_COLOR_CYAN     0x07ff
 432 # define CONSOLE_COLOR_GREY     0xcccc
 433 # define CONSOLE_COLOR_WHITE    0xffff  /* Must remain last / highest   */
 434
 435 #elif LCD_BPP == LCD_COLOR24
 436 /*
 437  * 16bpp color definitions
 438  */
 439 # define CONSOLE_COLOR_BLACK    0x00000000
 440 # define CONSOLE_COLOR_RED      0x00ff0000
 441 # define CONSOLE_COLOR_GREEN    0x0000ff00
 442 # define CONSOLE_COLOR_YELLOW   0x00ffff00
 443 # define CONSOLE_COLOR_BLUE     0x000000ff
 444 # define CONSOLE_COLOR_MAGENTA  0x00ff00ff
 445 # define CONSOLE_COLOR_CYAN     0x0000ffff
 446 # define CONSOLE_COLOR_GREY     0x00cccccc
 447 # define CONSOLE_COLOR_WHITE    0x00ffffff      /* Must remain last / highest   */
 448 #else
 449 #error Invalid LCD_BPP setting
 450 #endif /* color definitions */
 451
 452 /************************************************************************/
 453 #ifndef PAGE_SIZE
 454 # define PAGE_SIZE      4096
 455 #endif
 456
 457 /************************************************************************/
 458 /* ** CONSOLE DEFINITIONS & FUNCTIONS                                   */
 459 /************************************************************************/
 460 #if defined(CONFIG_LCD_LOGO) && !defined(CONFIG_LCD_INFO_BELOW_LOGO)
 461 # define CONSOLE_ROWS           ((panel_info.vl_row-BMP_LOGO_HEIGHT) \
 462                                         / VIDEO_FONT_HEIGHT)
 463 #else
 464 # define CONSOLE_ROWS           (panel_info.vl_row / VIDEO_FONT_HEIGHT)
 465 #endif
 466
 467 #define CONSOLE_COLS            (panel_info.vl_col / VIDEO_FONT_WIDTH)
 468 #define CONSOLE_ROW_SIZE        (VIDEO_FONT_HEIGHT * lcd_line_length)
 469 #define CONSOLE_ROW_FIRST       (lcd_console_address)
 470 #define CONSOLE_ROW_SECOND      (lcd_console_address + CONSOLE_ROW_SIZE)
 471 #define CONSOLE_ROW_LAST        (lcd_console_address + CONSOLE_SIZE \
 472                                         - CONSOLE_ROW_SIZE)
 473 #define CONSOLE_SIZE            (CONSOLE_ROW_SIZE * CONSOLE_ROWS)
 474 #define CONSOLE_SCROLL_SIZE     (CONSOLE_SIZE - CONSOLE_ROW_SIZE)
 475
 476 #if LCD_BPP == LCD_MONOCHROME
 477 # define COLOR_MASK(c)          ((c)      | (c) << 1 | (c) << 2 | (c) << 3 | \
 478                                  (c) << 4 | (c) << 5 | (c) << 6 | (c) << 7)
 479 #elif (LCD_BPP == LCD_COLOR8) || (LCD_BPP == LCD_COLOR16) || (LCD_BPP == LCD_COLOR24)
 480 # define COLOR_MASK(c)          (c)
 481 #else
 482 # error Unsupported LCD BPP.
 483 #endif
 484
 485 /************************************************************************/
 486
 487 #endif  /* _LCD_H_ */