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 */
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 /**
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_plat
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 /**
118 * struct video_ops - structure for keeping video operations
119 * @video_sync: Synchronize FB with device. Some device like SPI based LCD
120 * displays needs synchronization when data in an FB is available.
121 * For these devices implement video_sync hook to call a sync
122 * function. vid is pointer to video device udevice. Function
123 * should return 0 on success video_sync and error code otherwise
124 */
125 struct video_ops {
126 int (*video_sync)(struct udevice *vid);
127 };
128
129 #define video_get_ops(dev) ((struct video_ops *)(dev)->driver->ops)
130
131 /**
132 * video_reserve() - Reserve frame-buffer memory for video devices
133 *
134 * Note: This function is for internal use.
135 *
136 * This uses the uclass plat's @size and @align members to figure out
137 * a size and position for each frame buffer as part of the pre-relocation
138 * process of determining the post-relocation memory layout.
139 *
140 * gd->video_top is set to the initial value of *@addrp and gd->video_bottom
141 * is set to the final value.
142 *
143 * @addrp: On entry, the top of available memory. On exit, the new top,
144 * after allocating the required memory.
145 * @return 0
146 */
147 int video_reserve(ulong *addrp);
148
149 #ifdef CONFIG_DM_VIDEO
150 /**
151 * video_clear() - Clear a device's frame buffer to background color.
152 *
153 * @dev: Device to clear
154 * @return 0
155 */
156 int video_clear(struct udevice *dev);
157 #endif /* CONFIG_DM_VIDEO */
158
159 /**
160 * video_sync() - Sync a device's frame buffer with its hardware
161 *
162 * @vid: Device to sync
163 * @force: True to force a sync even if there was one recently (this is
164 * very expensive on sandbox)
165 *
166 * @return: 0 on success, error code otherwise
167 *
168 * Some frame buffers are cached or have a secondary frame buffer. This
169 * function syncs these up so that the current contents of the U-Boot frame
170 * buffer are displayed to the user.
171 */
172 int video_sync(struct udevice *vid, bool force);
173
174 /**
175 * video_sync_all() - Sync all devices' frame buffers with there hardware
176 *
177 * This calls video_sync() on all active video devices.
178 */
179 void video_sync_all(void);
180
181 /**
182 * video_bmp_display() - Display a BMP file
183 *
184 * @dev: Device to display the bitmap on
185 * @bmp_image: Address of bitmap image to display
186 * @x: X position in pixels from the left
187 * @y: Y position in pixels from the top
188 * @align: true to adjust the coordinates to centre the image. If false
189 * the coordinates are used as is. If true:
190 *
191 * - if a coordinate is 0x7fff then the image will be centred in
192 * that direction
193 * - if a coordinate is -ve then it will be offset to the
194 * left/top of the centre by that many pixels
195 * - if a coordinate is positive it will be used unchnaged.
196 * @return 0 if OK, -ve on error
197 */
198 int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y,
199 bool align);
200
201 /**
202 * video_get_xsize() - Get the width of the display in pixels
203 *
204 * @dev: Device to check
205 * @return device frame buffer width in pixels
206 */
207 int video_get_xsize(struct udevice *dev);
208
209 /**
210 * video_get_ysize() - Get the height of the display in pixels
211 *
212 * @dev: Device to check
213 * @return device frame buffer height in pixels
214 */
215 int video_get_ysize(struct udevice *dev);
216
217 /**
218 * Set whether we need to flush the dcache when changing the image. This
219 * defaults to off.
220 *
221 * @param flush non-zero to flush cache after update, 0 to skip
222 */
223 void video_set_flush_dcache(struct udevice *dev, bool flush);
224
225 /**
226 * Set default colors and attributes
227 *
228 * @dev: video device
229 * @invert true to invert colours
230 */
231 void video_set_default_colors(struct udevice *dev, bool invert);
232
233 #ifdef CONFIG_VIDEO_COPY
234 /**
235 * vidconsole_sync_copy() - Sync back to the copy framebuffer
236 *
237 * This ensures that the copy framebuffer has the same data as the framebuffer
238 * for a particular region. It should be called after the framebuffer is updated
239 *
240 * @from and @to can be in either order. The region between them is synced.
241 *
242 * @dev: Vidconsole device being updated
243 * @from: Start/end address within the framebuffer (->fb)
244 * @to: Other address within the frame buffer
245 * @return 0 if OK, -EFAULT if the start address is before the start of the
246 * frame buffer start
247 */
248 int video_sync_copy(struct udevice *dev, void *from, void *to);
249
250 /**
251 * video_sync_copy_all() - Sync the entire framebuffer to the copy
252 *
253 * @dev: Vidconsole device being updated
254 * @return 0 (always)
255 */
256 int video_sync_copy_all(struct udevice *dev);
257 #else
video_sync_copy(struct udevice * dev,void * from,void * to)258 static inline int video_sync_copy(struct udevice *dev, void *from, void *to)
259 {
260 return 0;
261 }
262
video_sync_copy_all(struct udevice * dev)263 static inline int video_sync_copy_all(struct udevice *dev)
264 {
265 return 0;
266 }
267
268 #endif
269
270 #ifndef CONFIG_DM_VIDEO
271
272 /* Video functions */
273
274 /**
275 * Display a BMP format bitmap on the screen
276 *
277 * @param bmp_image Address of BMP image
278 * @param x X position to draw image
279 * @param y Y position to draw image
280 */
281 int video_display_bitmap(ulong bmp_image, int x, int y);
282
283 /**
284 * Get the width of the screen in pixels
285 *
286 * @return width of screen in pixels
287 */
288 int video_get_pixel_width(void);
289
290 /**
291 * Get the height of the screen in pixels
292 *
293 * @return height of screen in pixels
294 */
295 int video_get_pixel_height(void);
296
297 /**
298 * Get the number of text lines/rows on the screen
299 *
300 * @return number of rows
301 */
302 int video_get_screen_rows(void);
303
304 /**
305 * Get the number of text columns on the screen
306 *
307 * @return number of columns
308 */
309 int video_get_screen_columns(void);
310
311 /**
312 * Set the position of the text cursor
313 *
314 * @param col Column to place cursor (0 = left side)
315 * @param row Row to place cursor (0 = top line)
316 */
317 void video_position_cursor(unsigned col, unsigned row);
318
319 /* Clear the display */
320 void video_clear(void);
321
322 #if defined(CONFIG_FORMIKE)
323 int kwh043st20_f01_spi_startup(unsigned int bus, unsigned int cs,
324 unsigned int max_hz, unsigned int spi_mode);
325 #endif
326 #if defined(CONFIG_LG4573)
327 int lg4573_spi_startup(unsigned int bus, unsigned int cs,
328 unsigned int max_hz, unsigned int spi_mode);
329 #endif
330
331 /*
332 * video_get_info_str() - obtain a board string: type, speed, etc.
333 *
334 * This is called if CONFIG_CONSOLE_EXTRA_INFO is enabled.
335 *
336 * line_number: location to place info string beside logo
337 * info: buffer for info string (empty if nothing to display on this
338 * line)
339 */
340 void video_get_info_str(int line_number, char *info);
341
342 #endif /* !CONFIG_DM_VIDEO */
343
344 #endif
345