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 #ifdef CONFIG_DM_VIDEO 17 18 #include <stdio_dev.h> 19 20 struct video_uc_platdata { 21 uint align; 22 uint size; 23 ulong base; 24 }; 25 26 enum video_polarity { 27 VIDEO_ACTIVE_HIGH, /* Pins are active high */ 28 VIDEO_ACTIVE_LOW, /* Pins are active low */ 29 }; 30 31 /* 32 * Bits per pixel selector. Each value n is such that the bits-per-pixel is 33 * 2 ^ n 34 */ 35 enum video_log2_bpp { 36 VIDEO_BPP1 = 0, 37 VIDEO_BPP2, 38 VIDEO_BPP4, 39 VIDEO_BPP8, 40 VIDEO_BPP16, 41 VIDEO_BPP32, 42 }; 43 44 /* 45 * Convert enum video_log2_bpp to bytes and bits. Note we omit the outer 46 * brackets to allow multiplication by fractional pixels. 47 */ 48 #define VNBYTES(bpix) (1 << (bpix)) / 8 49 50 #define VNBITS(bpix) (1 << (bpix)) 51 52 /** 53 * struct video_priv - Device information used by the video uclass 54 * 55 * @xsize: Number of pixel columns (e.g. 1366) 56 * @ysize: Number of pixels rows (e.g.. 768) 57 * @rot: Display rotation (0=none, 1=90 degrees clockwise, etc.) 58 * @bpix: Encoded bits per pixel (enum video_log2_bpp) 59 * @vidconsole_drv_name: Driver to use for the text console, NULL to 60 * select automatically 61 * @font_size: Font size in pixels (0 to use a default value) 62 * @fb: Frame buffer 63 * @fb_size: Frame buffer size 64 * @line_length: Length of each frame buffer line, in bytes. This can be 65 * set by the driver, but if not, the uclass will set it after 66 * probing 67 * @colour_fg: Foreground colour (pixel value) 68 * @colour_bg: Background colour (pixel value) 69 * @flush_dcache: true to enable flushing of the data cache after 70 * the LCD is updated 71 * @cmap: Colour map for 8-bit-per-pixel displays 72 * @fg_col_idx: Foreground color code (bit 3 = bold, bit 0-2 = color) 73 * @bg_col_idx: Background color code (bit 3 = bold, bit 0-2 = color) 74 */ 75 struct video_priv { 76 /* Things set up by the driver: */ 77 ushort xsize; 78 ushort ysize; 79 ushort rot; 80 enum video_log2_bpp bpix; 81 const char *vidconsole_drv_name; 82 int font_size; 83 84 /* 85 * Things that are private to the uclass: don't use these in the 86 * driver 87 */ 88 void *fb; 89 int fb_size; 90 int line_length; 91 u32 colour_fg; 92 u32 colour_bg; 93 bool flush_dcache; 94 ushort *cmap; 95 u8 fg_col_idx; 96 u8 bg_col_idx; 97 }; 98 99 /* Placeholder - there are no video operations at present */ 100 struct video_ops { 101 }; 102 103 #define video_get_ops(dev) ((struct video_ops *)(dev)->driver->ops) 104 105 /** 106 * video_reserve() - Reserve frame-buffer memory for video devices 107 * 108 * Note: This function is for internal use. 109 * 110 * This uses the uclass platdata's @size and @align members to figure out 111 * a size and position for each frame buffer as part of the pre-relocation 112 * process of determining the post-relocation memory layout. 113 * 114 * gd->video_top is set to the initial value of *@addrp and gd->video_bottom 115 * is set to the final value. 116 * 117 * @addrp: On entry, the top of available memory. On exit, the new top, 118 * after allocating the required memory. 119 * @return 0 120 */ 121 int video_reserve(ulong *addrp); 122 123 /** 124 * video_clear() - Clear a device's frame buffer to background color. 125 * 126 * @dev: Device to clear 127 * @return 0 128 */ 129 int video_clear(struct udevice *dev); 130 131 /** 132 * video_sync() - Sync a device's frame buffer with its hardware 133 * 134 * Some frame buffers are cached or have a secondary frame buffer. This 135 * function syncs these up so that the current contents of the U-Boot frame 136 * buffer are displayed to the user. 137 * 138 * @dev: Device to sync 139 * @force: True to force a sync even if there was one recently (this is 140 * very expensive on sandbox) 141 */ 142 void video_sync(struct udevice *vid, bool force); 143 144 /** 145 * video_sync_all() - Sync all devices' frame buffers with there hardware 146 * 147 * This calls video_sync() on all active video devices. 148 */ 149 void video_sync_all(void); 150 151 /** 152 * video_bmp_display() - Display a BMP file 153 * 154 * @dev: Device to display the bitmap on 155 * @bmp_image: Address of bitmap image to display 156 * @x: X position in pixels from the left 157 * @y: Y position in pixels from the top 158 * @align: true to adjust the coordinates to centre the image. If false 159 * the coordinates are used as is. If true: 160 * 161 * - if a coordinate is 0x7fff then the image will be centred in 162 * that direction 163 * - if a coordinate is -ve then it will be offset to the 164 * left/top of the centre by that many pixels 165 * - if a coordinate is positive it will be used unchnaged. 166 * @return 0 if OK, -ve on error 167 */ 168 int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y, 169 bool align); 170 171 /** 172 * video_get_xsize() - Get the width of the display in pixels 173 * 174 * @dev: Device to check 175 * @return device frame buffer width in pixels 176 */ 177 int video_get_xsize(struct udevice *dev); 178 179 /** 180 * video_get_ysize() - Get the height of the display in pixels 181 * 182 * @dev: Device to check 183 * @return device frame buffer height in pixels 184 */ 185 int video_get_ysize(struct udevice *dev); 186 187 /** 188 * Set whether we need to flush the dcache when changing the image. This 189 * defaults to off. 190 * 191 * @param flush non-zero to flush cache after update, 0 to skip 192 */ 193 void video_set_flush_dcache(struct udevice *dev, bool flush); 194 195 /** 196 * Set default colors and attributes 197 * 198 * @dev: video device 199 * @invert true to invert colours 200 */ 201 void video_set_default_colors(struct udevice *dev, bool invert); 202 203 #endif /* CONFIG_DM_VIDEO */ 204 205 #ifndef CONFIG_DM_VIDEO 206 207 /* Video functions */ 208 209 /** 210 * Display a BMP format bitmap on the screen 211 * 212 * @param bmp_image Address of BMP image 213 * @param x X position to draw image 214 * @param y Y position to draw image 215 */ 216 int video_display_bitmap(ulong bmp_image, int x, int y); 217 218 /** 219 * Get the width of the screen in pixels 220 * 221 * @return width of screen in pixels 222 */ 223 int video_get_pixel_width(void); 224 225 /** 226 * Get the height of the screen in pixels 227 * 228 * @return height of screen in pixels 229 */ 230 int video_get_pixel_height(void); 231 232 /** 233 * Get the number of text lines/rows on the screen 234 * 235 * @return number of rows 236 */ 237 int video_get_screen_rows(void); 238 239 /** 240 * Get the number of text columns on the screen 241 * 242 * @return number of columns 243 */ 244 int video_get_screen_columns(void); 245 246 /** 247 * Set the position of the text cursor 248 * 249 * @param col Column to place cursor (0 = left side) 250 * @param row Row to place cursor (0 = top line) 251 */ 252 void video_position_cursor(unsigned col, unsigned row); 253 254 /* Clear the display */ 255 void video_clear(void); 256 257 #if defined(CONFIG_FORMIKE) 258 int kwh043st20_f01_spi_startup(unsigned int bus, unsigned int cs, 259 unsigned int max_hz, unsigned int spi_mode); 260 #endif 261 #if defined(CONFIG_LG4573) 262 int lg4573_spi_startup(unsigned int bus, unsigned int cs, 263 unsigned int max_hz, unsigned int spi_mode); 264 #endif 265 266 /* 267 * video_get_info_str() - obtain a board string: type, speed, etc. 268 * 269 * This is called if CONFIG_CONSOLE_EXTRA_INFO is enabled. 270 * 271 * line_number: location to place info string beside logo 272 * info: buffer for info string (empty if nothing to display on this 273 * line) 274 */ 275 void video_get_info_str(int line_number, char *info); 276 277 #endif /* !CONFIG_DM_VIDEO */ 278 279 #endif 280