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