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