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