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