include/video.h

   1 /*
   2  * Video uclass to support displays (see also vidconsole for text)
   3  *
   4  * Copyright (c) 2015 Google, Inc
   5  */
   6
   7 #ifndef _VIDEO_H_
   8 #define _VIDEO_H_
   9
  10 #include <stdio_dev.h>
  11
  12 struct udevice;
  13
  14 /**
  15  * struct video_uc_plat - uclass platform data for a video device
  16  *
  17  * This holds information that the uclass needs to know about each device. It
  18  * is accessed using dev_get_uclass_plat(dev). See 'Theory of operation' at
  19  * the top of video-uclass.c for details on how this information is set.
  20  *
  21  * @align: Frame-buffer alignment, indicating the memory boundary the frame
  22  *      buffer should start on. If 0, 1MB is assumed
  23  * @size: Frame-buffer size, in bytes
  24  * @base: Base address of frame buffer, 0 if not yet known
  25  * @copy_base: Base address of a hardware copy of the frame buffer. See
  26  *      CONFIG_VIDEO_COPY.
  27  * @hide_logo: Hide the logo (used for testing)
  28  */
  29 struct video_uc_plat {
  30         uint align;
  31         uint size;
  32         ulong base;
  33         ulong copy_base;
  34         bool hide_logo;
  35 };
  36
  37 enum video_polarity {
  38         VIDEO_ACTIVE_HIGH,      /* Pins are active high */
  39         VIDEO_ACTIVE_LOW,       /* Pins are active low */
  40 };
  41
  42 /*
  43  * Bits per pixel selector. Each value n is such that the bits-per-pixel is
  44  * 2 ^ n
  45  */
  46 enum video_log2_bpp {
  47         VIDEO_BPP1      = 0,
  48         VIDEO_BPP2,
  49         VIDEO_BPP4,
  50         VIDEO_BPP8,
  51         VIDEO_BPP16,
  52         VIDEO_BPP32,
  53 };
  54
  55 /*
  56  * Convert enum video_log2_bpp to bytes and bits. Note we omit the outer
  57  * brackets to allow multiplication by fractional pixels.
  58  */
  59 #define VNBYTES(bpix)   (1 << (bpix)) / 8
  60
  61 #define VNBITS(bpix)    (1 << (bpix))
  62
  63 enum video_format {
  64         VIDEO_UNKNOWN,
  65         VIDEO_X8B8G8R8,
  66         VIDEO_X8R8G8B8,
  67         VIDEO_X2R10G10B10,
  68 };
  69
  70 /**
  71  * struct video_priv - Device information used by the video uclass
  72  *
  73  * @xsize:      Number of pixel columns (e.g. 1366)
  74  * @ysize:      Number of pixels rows (e.g.. 768)
  75  * @rot:        Display rotation (0=none, 1=90 degrees clockwise, etc.)
  76  * @bpix:       Encoded bits per pixel (enum video_log2_bpp)
  77  * @format:     Pixel format (enum video_format)
  78  * @vidconsole_drv_name:        Driver to use for the text console, NULL to
  79  *              select automatically
  80  * @font_size:  Font size in pixels (0 to use a default value)
  81  * @fb:         Frame buffer
  82  * @fb_size:    Frame buffer size
  83  * @copy_fb:    Copy of the frame buffer to keep up to date; see struct
  84  *              video_uc_plat
  85  * @line_length:        Length of each frame buffer line, in bytes. This can be
  86  *              set by the driver, but if not, the uclass will set it after
  87  *              probing
  88  * @colour_fg:  Foreground colour (pixel value)
  89  * @colour_bg:  Background colour (pixel value)
  90  * @flush_dcache:       true to enable flushing of the data cache after
  91  *              the LCD is updated
  92  * @fg_col_idx: Foreground color code (bit 3 = bold, bit 0-2 = color)
  93  * @bg_col_idx: Background color code (bit 3 = bold, bit 0-2 = color)
  94  */
  95 struct video_priv {
  96         /* Things set up by the driver: */
  97         ushort xsize;
  98         ushort ysize;
  99         ushort rot;
 100         enum video_log2_bpp bpix;
 101         enum video_format format;
 102         const char *vidconsole_drv_name;
 103         int font_size;
 104
 105         /*
 106          * Things that are private to the uclass: don't use these in the
 107          * driver
 108          */
 109         void *fb;
 110         int fb_size;
 111         void *copy_fb;
 112         int line_length;
 113         u32 colour_fg;
 114         u32 colour_bg;
 115         bool flush_dcache;
 116         u8 fg_col_idx;
 117         u8 bg_col_idx;
 118 };
 119
 120 /**
 121  * struct video_ops - structure for keeping video operations
 122  * @video_sync: Synchronize FB with device. Some device like SPI based LCD
 123  *              displays needs synchronization when data in an FB is available.
 124  *              For these devices implement video_sync hook to call a sync
 125  *              function. vid is pointer to video device udevice. Function
 126  *              should return 0 on success video_sync and error code otherwise
 127  */
 128 struct video_ops {
 129         int (*video_sync)(struct udevice *vid);
 130 };
 131
 132 #define video_get_ops(dev)        ((struct video_ops *)(dev)->driver->ops)
 133
 134 /** enum colour_idx - the 16 colors supported by consoles */
 135 enum colour_idx {
 136         VID_BLACK = 0,
 137         VID_RED,
 138         VID_GREEN,
 139         VID_BROWN,
 140         VID_BLUE,
 141         VID_MAGENTA,
 142         VID_CYAN,
 143         VID_LIGHT_GRAY,
 144         VID_GRAY,
 145         VID_LIGHT_RED,
 146         VID_LIGHT_GREEN,
 147         VID_YELLOW,
 148         VID_LIGHT_BLUE,
 149         VID_LIGHT_MAGENTA,
 150         VID_LIGHT_CYAN,
 151         VID_WHITE,
 152
 153         VID_COLOUR_COUNT
 154 };
 155
 156 /**
 157  * video_index_to_colour() - convert a color code to a pixel's internal
 158  * representation
 159  *
 160  * The caller has to guarantee that the color index is less than
 161  * VID_COLOR_COUNT.
 162  *
 163  * @priv        private data of the console device
 164  * @idx         color index
 165  * Return:      color value
 166  */
 167 u32 video_index_to_colour(struct video_priv *priv, unsigned int idx);
 168
 169 /**
 170  * video_reserve() - Reserve frame-buffer memory for video devices
 171  *
 172  * Note: This function is for internal use.
 173  *
 174  * This uses the uclass plat's @size and @align members to figure out
 175  * a size and position for each frame buffer as part of the pre-relocation
 176  * process of determining the post-relocation memory layout.
 177  *
 178  * gd->video_top is set to the initial value of *@addrp and gd->video_bottom
 179  * is set to the final value.
 180  *
 181  * @addrp:      On entry, the top of available memory. On exit, the new top,
 182  *              after allocating the required memory.
 183  * Return: 0
 184  */
 185 int video_reserve(ulong *addrp);
 186
 187 /**
 188  * video_clear() - Clear a device's frame buffer to background colour.
 189  *
 190  * @dev:        Device to clear
 191  * Return: 0 on success
 192  */
 193 int video_clear(struct udevice *dev);
 194
 195 /**
 196  * video_fill() - Fill a device's frame buffer to a colour.
 197  *
 198  * @dev:        Device to fill
 199  * @colour:     Colour to use, in the frame buffer's format
 200  * Return: 0 on success
 201  */
 202 int video_fill(struct udevice *dev, u32 colour);
 203
 204 /**
 205  * video_sync() - Sync a device's frame buffer with its hardware
 206  *
 207  * @vid:        Device to sync
 208  * @force:      True to force a sync even if there was one recently (this is
 209  *              very expensive on sandbox)
 210  *
 211  * @return: 0 on success, error code otherwise
 212  *
 213  * Some frame buffers are cached or have a secondary frame buffer. This
 214  * function syncs these up so that the current contents of the U-Boot frame
 215  * buffer are displayed to the user.
 216  */
 217 int video_sync(struct udevice *vid, bool force);
 218
 219 /**
 220  * video_sync_all() - Sync all devices' frame buffers with there hardware
 221  *
 222  * This calls video_sync() on all active video devices.
 223  */
 224 void video_sync_all(void);
 225
 226 /**
 227  * video_bmp_get_info() - Get information about a bitmap image
 228  *
 229  * @bmp_image: Pointer to BMP image to check
 230  * @widthp: Returns width in pixels
 231  * @heightp: Returns height in pixels
 232  * @bpixp: Returns log2 of bits per pixel
 233  */
 234 void video_bmp_get_info(void *bmp_image, ulong *widthp, ulong *heightp,
 235                         uint *bpixp);
 236
 237 /**
 238  * video_bmp_display() - Display a BMP file
 239  *
 240  * @dev:        Device to display the bitmap on
 241  * @bmp_image:  Address of bitmap image to display
 242  * @x:          X position in pixels from the left
 243  * @y:          Y position in pixels from the top
 244  * @align:      true to adjust the coordinates to centre the image. If false
 245  *              the coordinates are used as is. If true:
 246  *
 247  *              - if a coordinate is 0x7fff then the image will be centred in
 248  *                that direction
 249  *              - if a coordinate is -ve then it will be offset to the
 250  *                left/top of the centre by that many pixels
 251  *              - if a coordinate is positive it will be used unchnaged.
 252  * Return: 0 if OK, -ve on error
 253  */
 254 int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y,
 255                       bool align);
 256
 257 /**
 258  * video_get_xsize() - Get the width of the display in pixels
 259  *
 260  * @dev:        Device to check
 261  * Return: device frame buffer width in pixels
 262  */
 263 int video_get_xsize(struct udevice *dev);
 264
 265 /**
 266  * video_get_ysize() - Get the height of the display in pixels
 267  *
 268  * @dev:        Device to check
 269  * Return: device frame buffer height in pixels
 270  */
 271 int video_get_ysize(struct udevice *dev);
 272
 273 /**
 274  * Set whether we need to flush the dcache when changing the image. This
 275  * defaults to off.
 276  *
 277  * @param flush         non-zero to flush cache after update, 0 to skip
 278  */
 279 void video_set_flush_dcache(struct udevice *dev, bool flush);
 280
 281 /**
 282  * Set default colors and attributes
 283  *
 284  * @dev:        video device
 285  * @invert      true to invert colours
 286  */
 287 void video_set_default_colors(struct udevice *dev, bool invert);
 288
 289 /**
 290  * video_default_font_height() - Get the default font height
 291  *
 292  * @dev:        video device
 293  * Returns: Default font height in pixels, which depends on which console driver
 294  * is in use
 295  */
 296 int video_default_font_height(struct udevice *dev);
 297
 298 #ifdef CONFIG_VIDEO_COPY
 299 /**
 300  * vidconsole_sync_copy() - Sync back to the copy framebuffer
 301  *
 302  * This ensures that the copy framebuffer has the same data as the framebuffer
 303  * for a particular region. It should be called after the framebuffer is updated
 304  *
 305  * @from and @to can be in either order. The region between them is synced.
 306  *
 307  * @dev: Vidconsole device being updated
 308  * @from: Start/end address within the framebuffer (->fb)
 309  * @to: Other address within the frame buffer
 310  * Return: 0 if OK, -EFAULT if the start address is before the start of the
 311  *      frame buffer start
 312  */
 313 int video_sync_copy(struct udevice *dev, void *from, void *to);
 314
 315 /**
 316  * video_sync_copy_all() - Sync the entire framebuffer to the copy
 317  *
 318  * @dev: Vidconsole device being updated
 319  * Return: 0 (always)
 320  */
 321 int video_sync_copy_all(struct udevice *dev);
 322 #else
 323 static inline int video_sync_copy(struct udevice *dev, void *from, void *to)
 324 {
 325         return 0;
 326 }
 327
 328 static inline int video_sync_copy_all(struct udevice *dev)
 329 {
 330         return 0;
 331 }
 332
 333 #endif
 334
 335 /**
 336  * video_is_active() - Test if one video device it active
 337  *
 338  * Return: true if at least one video device is active, else false.
 339  */
 340 bool video_is_active(void);
 341
 342 /**
 343  * video_get_u_boot_logo() - Get a pointer to the U-Boot logo
 344  *
 345  * Returns: Pointer to logo
 346  */
 347 void *video_get_u_boot_logo(void);
 348
 349 #endif