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