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