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