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