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