xref: /openbmc/u-boot/include/video.h (revision 274bced8)
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
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
65  * @colour_fg:	Foreground colour (pixel value)
66  * @colour_bg:	Background colour (pixel value)
67  * @flush_dcache:	true to enable flushing of the data cache after
68  *		the LCD is updated
69  * @cmap:	Colour map for 8-bit-per-pixel displays
70  */
71 struct video_priv {
72 	/* Things set up by the driver: */
73 	ushort xsize;
74 	ushort ysize;
75 	ushort rot;
76 	enum video_log2_bpp bpix;
77 	const char *vidconsole_drv_name;
78 	int font_size;
79 
80 	/*
81 	 * Things that are private to the uclass: don't use these in the
82 	 * driver
83 	 */
84 	void *fb;
85 	int fb_size;
86 	int line_length;
87 	int colour_fg;
88 	int colour_bg;
89 	bool flush_dcache;
90 	ushort *cmap;
91 };
92 
93 /* Placeholder - there are no video operations at present */
94 struct video_ops {
95 };
96 
97 #define video_get_ops(dev)        ((struct video_ops *)(dev)->driver->ops)
98 
99 /**
100  * video_reserve() - Reserve frame-buffer memory for video devices
101  *
102  * Note: This function is for internal use.
103  *
104  * This uses the uclass platdata's @size and @align members to figure out
105  * a size and position for each frame buffer as part of the pre-relocation
106  * process of determining the post-relocation memory layout.
107  *
108  * gd->video_top is set to the initial value of *@addrp and gd->video_bottom
109  * is set to the final value.
110  *
111  * @addrp:	On entry, the top of available memory. On exit, the new top,
112  *		after allocating the required memory.
113  * @return 0
114  */
115 int video_reserve(ulong *addrp);
116 
117 /**
118  * video_sync() - Sync a device's frame buffer with its hardware
119  *
120  * Some frame buffers are cached or have a secondary frame buffer. This
121  * function syncs these up so that the current contents of the U-Boot frame
122  * buffer are displayed to the user.
123  *
124  * @dev:	Device to sync
125  */
126 void video_sync(struct udevice *vid);
127 
128 /**
129  * video_sync_all() - Sync all devices' frame buffers with there hardware
130  *
131  * This calls video_sync() on all active video devices.
132  */
133 void video_sync_all(void);
134 
135 /**
136  * video_bmp_display() - Display a BMP file
137  *
138  * @dev:	Device to display the bitmap on
139  * @bmp_image:	Address of bitmap image to display
140  * @x:		X position in pixels from the left
141  * @y:		Y position in pixels from the top
142  * @align:	true to adjust the coordinates to centre the image. If false
143  *		the coordinates are used as is. If true:
144  *
145  *		- if a coordinate is 0x7fff then the image will be centred in
146  *		  that direction
147  *		- if a coordinate is -ve then it will be offset to the
148  *		  left/top of the centre by that many pixels
149  *		- if a coordinate is positive it will be used unchnaged.
150  * @return 0 if OK, -ve on error
151  */
152 int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y,
153 		      bool align);
154 
155 /**
156  * video_get_xsize() - Get the width of the display in pixels
157  *
158  * @dev:	Device to check
159  * @return device frame buffer width in pixels
160  */
161 int video_get_xsize(struct udevice *dev);
162 
163 /**
164  * video_get_ysize() - Get the height of the display in pixels
165  *
166  * @dev:	Device to check
167  * @return device frame buffer height in pixels
168  */
169 int video_get_ysize(struct udevice *dev);
170 
171 /**
172  * Set whether we need to flush the dcache when changing the image. This
173  * defaults to off.
174  *
175  * @param flush		non-zero to flush cache after update, 0 to skip
176  */
177 void video_set_flush_dcache(struct udevice *dev, bool flush);
178 
179 #endif /* CONFIG_DM_VIDEO */
180 
181 #ifndef CONFIG_DM_VIDEO
182 
183 /* Video functions */
184 
185 struct stdio_dev;
186 
187 int	video_init(void *videobase);
188 void	video_putc(struct stdio_dev *dev, const char c);
189 void	video_puts(struct stdio_dev *dev, const char *s);
190 
191 /**
192  * Display a BMP format bitmap on the screen
193  *
194  * @param bmp_image	Address of BMP image
195  * @param x		X position to draw image
196  * @param y		Y position to draw image
197  */
198 int video_display_bitmap(ulong bmp_image, int x, int y);
199 
200 /**
201  * Get the width of the screen in pixels
202  *
203  * @return width of screen in pixels
204  */
205 int video_get_pixel_width(void);
206 
207 /**
208  * Get the height of the screen in pixels
209  *
210  * @return height of screen in pixels
211  */
212 int video_get_pixel_height(void);
213 
214 /**
215  * Get the number of text lines/rows on the screen
216  *
217  * @return number of rows
218  */
219 int video_get_screen_rows(void);
220 
221 /**
222  * Get the number of text columns on the screen
223  *
224  * @return number of columns
225  */
226 int video_get_screen_columns(void);
227 
228 /**
229  * Set the position of the text cursor
230  *
231  * @param col	Column to place cursor (0 = left side)
232  * @param row	Row to place cursor (0 = top line)
233  */
234 void video_position_cursor(unsigned col, unsigned row);
235 
236 /* Clear the display */
237 void video_clear(void);
238 
239 #if defined(CONFIG_FORMIKE)
240 int kwh043st20_f01_spi_startup(unsigned int bus, unsigned int cs,
241 	unsigned int max_hz, unsigned int spi_mode);
242 #endif
243 #if defined(CONFIG_LG4573)
244 int lg4573_spi_startup(unsigned int bus, unsigned int cs,
245 	unsigned int max_hz, unsigned int spi_mode);
246 #endif
247 
248 /*
249  * video_get_info_str() - obtain a board string: type, speed, etc.
250  *
251  * This is called if CONFIG_CONSOLE_EXTRA_INFO is enabled.
252  *
253  * line_number:	location to place info string beside logo
254  * info:	buffer for info string (empty if nothing to display on this
255  * line)
256  */
257 void video_get_info_str(int line_number, char *info);
258 
259 #endif /* CONFIG_DM_VIDEO */
260 
261 #endif
262