include/video.h

   1 /*
   2  * Video uclass and legacy implementation
   3  *
   4  * Copyright (c) 2015 Google, Inc
   5  *
   6  * MPC823 Video Controller
   7  * =======================
   8  * (C) 2000 by Paolo Scaffardi (arsenio@tin.it)
   9  * AIRVENT SAM s.p.a - RIMINI(ITALY)
  10  *
  11  */
  12
  13 #ifndef _VIDEO_H_
  14 #define _VIDEO_H_
  15
  16 #ifdef CONFIG_DM_VIDEO
  17
  18 #include <stdio_dev.h>
  19
  20 struct video_uc_platdata {
  21         uint align;
  22         uint size;
  23         ulong base;
  24 };
  25
  26 enum video_polarity {
  27         VIDEO_ACTIVE_HIGH,      /* Pins are active high */
  28         VIDEO_ACTIVE_LOW,       /* Pins are active low */
  29 };
  30
  31 /*
  32  * Bits per pixel selector. Each value n is such that the bits-per-pixel is
  33  * 2 ^ n
  34  */
  35 enum video_log2_bpp {
  36         VIDEO_BPP1      = 0,
  37         VIDEO_BPP2,
  38         VIDEO_BPP4,
  39         VIDEO_BPP8,
  40         VIDEO_BPP16,
  41         VIDEO_BPP32,
  42 };
  43
  44 /*
  45  * Convert enum video_log2_bpp to bytes and bits. Note we omit the outer
  46  * brackets to allow multiplication by fractional pixels.
  47  */
  48 #define VNBYTES(bpix)   (1 << (bpix)) / 8
  49
  50 #define VNBITS(bpix)    (1 << (bpix))
  51
  52 /**
  53  * struct video_priv - Device information used by the video uclass
  54  *
  55  * @xsize:      Number of pixel columns (e.g. 1366)
  56  * @ysize:      Number of pixels rows (e.g.. 768)
  57  * @rot:        Display rotation (0=none, 1=90 degrees clockwise, etc.)
  58  * @bpix:       Encoded bits per pixel (enum video_log2_bpp)
  59  * @vidconsole_drv_name:        Driver to use for the text console, NULL to
  60  *              select automatically
  61  * @font_size:  Font size in pixels (0 to use a default value)
  62  * @fb:         Frame buffer
  63  * @fb_size:    Frame buffer size
  64  * @line_length:        Length of each frame buffer line, in bytes. This can be
  65  *              set by the driver, but if not, the uclass will set it after
  66  *              probing
  67  * @colour_fg:  Foreground colour (pixel value)
  68  * @colour_bg:  Background colour (pixel value)
  69  * @flush_dcache:       true to enable flushing of the data cache after
  70  *              the LCD is updated
  71  * @cmap:       Colour map for 8-bit-per-pixel displays
  72  * @fg_col_idx: Foreground color code (bit 3 = bold, bit 0-2 = color)
  73  */
  74 struct video_priv {
  75         /* Things set up by the driver: */
  76         ushort xsize;
  77         ushort ysize;
  78         ushort rot;
  79         enum video_log2_bpp bpix;
  80         const char *vidconsole_drv_name;
  81         int font_size;
  82
  83         /*
  84          * Things that are private to the uclass: don't use these in the
  85          * driver
  86          */
  87         void *fb;
  88         int fb_size;
  89         int line_length;
  90         u32 colour_fg;
  91         u32 colour_bg;
  92         bool flush_dcache;
  93         ushort *cmap;
  94         u8 fg_col_idx;
  95 };
  96
  97 /* Placeholder - there are no video operations at present */
  98 struct video_ops {
  99 };
 100
 101 #define video_get_ops(dev)        ((struct video_ops *)(dev)->driver->ops)
 102
 103 /**
 104  * video_reserve() - Reserve frame-buffer memory for video devices
 105  *
 106  * Note: This function is for internal use.
 107  *
 108  * This uses the uclass platdata's @size and @align members to figure out
 109  * a size and position for each frame buffer as part of the pre-relocation
 110  * process of determining the post-relocation memory layout.
 111  *
 112  * gd->video_top is set to the initial value of *@addrp and gd->video_bottom
 113  * is set to the final value.
 114  *
 115  * @addrp:      On entry, the top of available memory. On exit, the new top,
 116  *              after allocating the required memory.
 117  * @return 0
 118  */
 119 int video_reserve(ulong *addrp);
 120
 121 /**
 122  * video_clear() - Clear a device's frame buffer to background color.
 123  *
 124  * @dev:        Device to clear
 125  * @return 0
 126  */
 127 int video_clear(struct udevice *dev);
 128
 129 /**
 130  * video_sync() - Sync a device's frame buffer with its hardware
 131  *
 132  * Some frame buffers are cached or have a secondary frame buffer. This
 133  * function syncs these up so that the current contents of the U-Boot frame
 134  * buffer are displayed to the user.
 135  *
 136  * @dev:        Device to sync
 137  * @force:      True to force a sync even if there was one recently (this is
 138  *              very expensive on sandbox)
 139  */
 140 void video_sync(struct udevice *vid, bool force);
 141
 142 /**
 143  * video_sync_all() - Sync all devices' frame buffers with there hardware
 144  *
 145  * This calls video_sync() on all active video devices.
 146  */
 147 void video_sync_all(void);
 148
 149 /**
 150  * video_bmp_display() - Display a BMP file
 151  *
 152  * @dev:        Device to display the bitmap on
 153  * @bmp_image:  Address of bitmap image to display
 154  * @x:          X position in pixels from the left
 155  * @y:          Y position in pixels from the top
 156  * @align:      true to adjust the coordinates to centre the image. If false
 157  *              the coordinates are used as is. If true:
 158  *
 159  *              - if a coordinate is 0x7fff then the image will be centred in
 160  *                that direction
 161  *              - if a coordinate is -ve then it will be offset to the
 162  *                left/top of the centre by that many pixels
 163  *              - if a coordinate is positive it will be used unchnaged.
 164  * @return 0 if OK, -ve on error
 165  */
 166 int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y,
 167                       bool align);
 168
 169 /**
 170  * video_get_xsize() - Get the width of the display in pixels
 171  *
 172  * @dev:        Device to check
 173  * @return device frame buffer width in pixels
 174  */
 175 int video_get_xsize(struct udevice *dev);
 176
 177 /**
 178  * video_get_ysize() - Get the height of the display in pixels
 179  *
 180  * @dev:        Device to check
 181  * @return device frame buffer height in pixels
 182  */
 183 int video_get_ysize(struct udevice *dev);
 184
 185 /**
 186  * Set whether we need to flush the dcache when changing the image. This
 187  * defaults to off.
 188  *
 189  * @param flush         non-zero to flush cache after update, 0 to skip
 190  */
 191 void video_set_flush_dcache(struct udevice *dev, bool flush);
 192
 193 /**
 194  * Set default colors and attributes
 195  *
 196  * @dev:        video device
 197  * @invert      true to invert colours
 198  */
 199 void video_set_default_colors(struct udevice *dev, bool invert);
 200
 201 #endif /* CONFIG_DM_VIDEO */
 202
 203 #ifndef CONFIG_DM_VIDEO
 204
 205 /* Video functions */
 206
 207 /**
 208  * Display a BMP format bitmap on the screen
 209  *
 210  * @param bmp_image     Address of BMP image
 211  * @param x             X position to draw image
 212  * @param y             Y position to draw image
 213  */
 214 int video_display_bitmap(ulong bmp_image, int x, int y);
 215
 216 /**
 217  * Get the width of the screen in pixels
 218  *
 219  * @return width of screen in pixels
 220  */
 221 int video_get_pixel_width(void);
 222
 223 /**
 224  * Get the height of the screen in pixels
 225  *
 226  * @return height of screen in pixels
 227  */
 228 int video_get_pixel_height(void);
 229
 230 /**
 231  * Get the number of text lines/rows on the screen
 232  *
 233  * @return number of rows
 234  */
 235 int video_get_screen_rows(void);
 236
 237 /**
 238  * Get the number of text columns on the screen
 239  *
 240  * @return number of columns
 241  */
 242 int video_get_screen_columns(void);
 243
 244 /**
 245  * Set the position of the text cursor
 246  *
 247  * @param col   Column to place cursor (0 = left side)
 248  * @param row   Row to place cursor (0 = top line)
 249  */
 250 void video_position_cursor(unsigned col, unsigned row);
 251
 252 /* Clear the display */
 253 void video_clear(void);
 254
 255 #if defined(CONFIG_FORMIKE)
 256 int kwh043st20_f01_spi_startup(unsigned int bus, unsigned int cs,
 257         unsigned int max_hz, unsigned int spi_mode);
 258 #endif
 259 #if defined(CONFIG_LG4573)
 260 int lg4573_spi_startup(unsigned int bus, unsigned int cs,
 261         unsigned int max_hz, unsigned int spi_mode);
 262 #endif
 263
 264 /*
 265  * video_get_info_str() - obtain a board string: type, speed, etc.
 266  *
 267  * This is called if CONFIG_CONSOLE_EXTRA_INFO is enabled.
 268  *
 269  * line_number: location to place info string beside logo
 270  * info:        buffer for info string (empty if nothing to display on this
 271  * line)
 272  */
 273 void video_get_info_str(int line_number, char *info);
 274
 275 #endif /* !CONFIG_DM_VIDEO */
 276
 277 #endif