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