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 #include <mpc823_lcd.h>
  47 #elif defined(CONFIG_CPU_PXA25X) || defined(CONFIG_CPU_PXA27X) || \
  48         defined CONFIG_CPU_MONAHANS
  49 #include <pxa_lcd.h>
  50 #elif defined(CONFIG_ATMEL_LCD) || defined(CONFIG_ATMEL_HLCD)
  51 #include <atmel_lcd.h>
  52 #elif defined(CONFIG_EXYNOS_FB)
  53 #include <exynos_lcd.h>
  54 #else
  55 typedef struct vidinfo {
  56         ushort  vl_col;         /* Number of columns (i.e. 160) */
  57         ushort  vl_row;         /* Number of rows (i.e. 100) */
  58
  59         u_char  vl_bpix;        /* Bits per pixel, 0 = 1 */
  60
  61         ushort  *cmap;          /* Pointer to the colormap */
  62
  63         void    *priv;          /* Pointer to driver-specific data */
  64 } vidinfo_t;
  65 #endif
  66
  67 extern vidinfo_t panel_info;
  68
  69 /* Video functions */
  70
  71 void    lcd_disable(void);
  72 void    lcd_panel_disable(void);
  73
  74 void    lcd_putc(const char c);
  75 void    lcd_puts(const char *s);
  76 void    lcd_printf(const char *fmt, ...);
  77 void    lcd_clear(void);
  78 int     lcd_display_bitmap(ulong bmp_image, int x, int y);
  79
  80 /**
  81  * Get the width of the LCD in pixels
  82  *
  83  * @return width of LCD in pixels
  84  */
  85 int lcd_get_pixel_width(void);
  86
  87 /**
  88  * Get the height of the LCD in pixels
  89  *
  90  * @return height of LCD in pixels
  91  */
  92 int lcd_get_pixel_height(void);
  93
  94 /**
  95  * Get the number of text lines/rows on the LCD
  96  *
  97  * @return number of rows
  98  */
  99 int lcd_get_screen_rows(void);
 100
 101 /**
 102  * Get the number of text columns on the LCD
 103  *
 104  * @return number of columns
 105  */
 106 int lcd_get_screen_columns(void);
 107
 108 /**
 109  * Get the background color of the LCD
 110  *
 111  * @return background color value
 112  */
 113 int lcd_getbgcolor(void);
 114
 115 /**
 116  * Get the foreground color of the LCD
 117  *
 118  * @return foreground color value
 119  */
 120 int lcd_getfgcolor(void);
 121
 122 /**
 123  * Set the position of the text cursor
 124  *
 125  * @param col   Column to place cursor (0 = left side)
 126  * @param row   Row to place cursor (0 = top line)
 127  */
 128 void lcd_position_cursor(unsigned col, unsigned row);
 129
 130 /* Allow boards to customize the information displayed */
 131 void lcd_show_board_info(void);
 132
 133 /* Return the size of the LCD frame buffer, and the line length */
 134 int lcd_get_size(int *line_length);
 135
 136 int lcd_dt_simplefb_add_node(void *blob);
 137 int lcd_dt_simplefb_enable_existing_node(void *blob);
 138
 139 /* Update the LCD / flush the cache */
 140 void lcd_sync(void);
 141
 142 /************************************************************************/
 143 /* ** BITMAP DISPLAY SUPPORT                                            */
 144 /************************************************************************/
 145 #if defined(CONFIG_CMD_BMP) || defined(CONFIG_SPLASH_SCREEN)
 146 # include <bmp_layout.h>
 147 # include <asm/byteorder.h>
 148 #endif
 149
 150 /*
 151  *  Information about displays we are using. This is for configuring
 152  *  the LCD controller and memory allocation. Someone has to know what
 153  *  is connected, as we can't autodetect anything.
 154  */
 155 #define CONFIG_SYS_HIGH 0       /* Pins are active high                 */
 156 #define CONFIG_SYS_LOW  1       /* Pins are active low                  */
 157
 158 #define LCD_MONOCHROME  0
 159 #define LCD_COLOR2      1
 160 #define LCD_COLOR4      2
 161 #define LCD_COLOR8      3
 162 #define LCD_COLOR16     4
 163 #define LCD_COLOR32     5
 164 /*----------------------------------------------------------------------*/
 165 #if defined(CONFIG_LCD_INFO_BELOW_LOGO)
 166 # define LCD_INFO_X             0
 167 # define LCD_INFO_Y             (BMP_LOGO_HEIGHT + VIDEO_FONT_HEIGHT)
 168 #elif defined(CONFIG_LCD_LOGO)
 169 # define LCD_INFO_X             (BMP_LOGO_WIDTH + 4 * VIDEO_FONT_WIDTH)
 170 # define LCD_INFO_Y             VIDEO_FONT_HEIGHT
 171 #else
 172 # define LCD_INFO_X             VIDEO_FONT_WIDTH
 173 # define LCD_INFO_Y             VIDEO_FONT_HEIGHT
 174 #endif
 175
 176 /* Default to 8bpp if bit depth not specified */
 177 #ifndef LCD_BPP
 178 # define LCD_BPP                        LCD_COLOR8
 179 #endif
 180 #ifndef LCD_DF
 181 # define LCD_DF                 1
 182 #endif
 183
 184 /* Calculate nr. of bits per pixel  and nr. of colors */
 185 #define NBITS(bit_code)         (1 << (bit_code))
 186 #define NCOLORS(bit_code)       (1 << NBITS(bit_code))
 187
 188 /************************************************************************/
 189 /* ** CONSOLE CONSTANTS                                                 */
 190 /************************************************************************/
 191 #if LCD_BPP == LCD_COLOR8
 192
 193 /*
 194  * 8bpp color definitions
 195  */
 196 # define CONSOLE_COLOR_BLACK    0
 197 # define CONSOLE_COLOR_RED      1
 198 # define CONSOLE_COLOR_GREEN    2
 199 # define CONSOLE_COLOR_YELLOW   3
 200 # define CONSOLE_COLOR_BLUE     4
 201 # define CONSOLE_COLOR_MAGENTA  5
 202 # define CONSOLE_COLOR_CYAN     6
 203 # define CONSOLE_COLOR_GREY     14
 204 # define CONSOLE_COLOR_WHITE    15      /* Must remain last / highest   */
 205
 206 #elif LCD_BPP == LCD_COLOR32
 207 /*
 208  * 32bpp color definitions
 209  */
 210 # define CONSOLE_COLOR_RED      0x00ff0000
 211 # define CONSOLE_COLOR_GREEN    0x0000ff00
 212 # define CONSOLE_COLOR_YELLOW   0x00ffff00
 213 # define CONSOLE_COLOR_BLUE     0x000000ff
 214 # define CONSOLE_COLOR_MAGENTA  0x00ff00ff
 215 # define CONSOLE_COLOR_CYAN     0x0000ffff
 216 # define CONSOLE_COLOR_GREY     0x00aaaaaa
 217 # define CONSOLE_COLOR_BLACK    0x00000000
 218 # define CONSOLE_COLOR_WHITE    0x00ffffff      /* Must remain last / highest*/
 219 # define NBYTES(bit_code)       (NBITS(bit_code) >> 3)
 220
 221 #elif LCD_BPP == LCD_COLOR16
 222
 223 /*
 224  * 16bpp color definitions
 225  */
 226 # define CONSOLE_COLOR_BLACK    0x0000
 227 # define CONSOLE_COLOR_RED      0xf800
 228 # define CONSOLE_COLOR_GREEN    0x07e0
 229 # define CONSOLE_COLOR_YELLOW   0xffe0
 230 # define CONSOLE_COLOR_BLUE     0x001f
 231 # define CONSOLE_COLOR_MAGENTA  0xf81f
 232 # define CONSOLE_COLOR_CYAN     0x07ff
 233 # define CONSOLE_COLOR_GREY     0xcccc
 234 # define CONSOLE_COLOR_WHITE    0xffff  /* Must remain last / highest   */
 235
 236 #else
 237 #error Invalid LCD_BPP setting
 238 #endif /* color definitions */
 239
 240 /************************************************************************/
 241 #ifndef PAGE_SIZE
 242 # define PAGE_SIZE      4096
 243 #endif
 244
 245 /************************************************************************/
 246
 247 #endif  /* _LCD_H_ */