xref: /openbmc/u-boot/drivers/video/video-uclass.c (revision 20c700f8)
1 /*
2  * Copyright (c) 2015 Google, Inc
3  *
4  * SPDX-License-Identifier:	GPL-2.0+
5  */
6 
7 #include <common.h>
8 #include <dm.h>
9 #include <mapmem.h>
10 #include <stdio_dev.h>
11 #include <video.h>
12 #include <video_console.h>
13 #include <dm/lists.h>
14 #include <dm/device-internal.h>
15 #include <dm/uclass-internal.h>
16 #ifdef CONFIG_SANDBOX
17 #include <asm/sdl.h>
18 #endif
19 
20 /*
21  * Theory of operation:
22  *
23  * Before relocation each device is bound. The driver for each device must
24  * set the @align and @size values in struct video_uc_platdata. This
25  * information represents the requires size and alignment of the frame buffer
26  * for the device. The values can be an over-estimate but cannot be too
27  * small. The actual values will be suppled (in the same manner) by the bind()
28  * method after relocation.
29  *
30  * This information is then picked up by video_reserve() which works out how
31  * much memory is needed for all devices. This is allocated between
32  * gd->video_bottom and gd->video_top.
33  *
34  * After relocation the same process occurs. The driver supplies the same
35  * @size and @align information and this time video_post_bind() checks that
36  * the drivers does not overflow the allocated memory.
37  *
38  * The frame buffer address is actually set (to plat->base) in
39  * video_post_probe(). This function also clears the frame buffer and
40  * allocates a suitable text console device. This can then be used to write
41  * text to the video device.
42  */
43 DECLARE_GLOBAL_DATA_PTR;
44 
45 void video_set_flush_dcache(struct udevice *dev, bool flush)
46 {
47 	struct video_priv *priv = dev_get_uclass_priv(dev);
48 
49 	priv->flush_dcache = flush;
50 }
51 
52 static ulong alloc_fb(struct udevice *dev, ulong *addrp)
53 {
54 	struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
55 	ulong base, align, size;
56 
57 	if (!plat->size)
58 		return 0;
59 
60 	align = plat->align ? plat->align : 1 << 20;
61 	base = *addrp - plat->size;
62 	base &= ~(align - 1);
63 	plat->base = base;
64 	size = *addrp - base;
65 	*addrp = base;
66 
67 	return size;
68 }
69 
70 int video_reserve(ulong *addrp)
71 {
72 	struct udevice *dev;
73 	ulong size;
74 
75 	gd->video_top = *addrp;
76 	for (uclass_find_first_device(UCLASS_VIDEO, &dev);
77 	     dev;
78 	     uclass_find_next_device(&dev)) {
79 		size = alloc_fb(dev, addrp);
80 		debug("%s: Reserving %lx bytes at %lx for video device '%s'\n",
81 		      __func__, size, *addrp, dev->name);
82 	}
83 	gd->video_bottom = *addrp;
84 	debug("Video frame buffers from %lx to %lx\n", gd->video_bottom,
85 	      gd->video_top);
86 
87 	return 0;
88 }
89 
90 static int video_clear(struct udevice *dev)
91 {
92 	struct video_priv *priv = dev_get_uclass_priv(dev);
93 
94 	if (priv->bpix == VIDEO_BPP32) {
95 		u32 *ppix = priv->fb;
96 		u32 *end = priv->fb + priv->fb_size;
97 
98 		while (ppix < end)
99 			*ppix++ = priv->colour_bg;
100 	} else {
101 		memset(priv->fb, priv->colour_bg, priv->fb_size);
102 	}
103 
104 	return 0;
105 }
106 
107 /* Flush video activity to the caches */
108 void video_sync(struct udevice *vid)
109 {
110 	/*
111 	 * flush_dcache_range() is declared in common.h but it seems that some
112 	 * architectures do not actually implement it. Is there a way to find
113 	 * out whether it exists? For now, ARM is safe.
114 	 */
115 #if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
116 	struct video_priv *priv = dev_get_uclass_priv(vid);
117 
118 	if (priv->flush_dcache) {
119 		flush_dcache_range((ulong)priv->fb,
120 				   (ulong)priv->fb + priv->fb_size);
121 	}
122 #elif defined(CONFIG_VIDEO_SANDBOX_SDL)
123 	struct video_priv *priv = dev_get_uclass_priv(vid);
124 	static ulong last_sync;
125 
126 	if (get_timer(last_sync) > 10) {
127 		sandbox_sdl_sync(priv->fb);
128 		last_sync = get_timer(0);
129 	}
130 #endif
131 }
132 
133 void video_sync_all(void)
134 {
135 	struct udevice *dev;
136 
137 	for (uclass_find_first_device(UCLASS_VIDEO, &dev);
138 	     dev;
139 	     uclass_find_next_device(&dev)) {
140 		if (device_active(dev))
141 			video_sync(dev);
142 	}
143 }
144 
145 int video_get_xsize(struct udevice *dev)
146 {
147 	struct video_priv *priv = dev_get_uclass_priv(dev);
148 
149 	return priv->xsize;
150 }
151 
152 int video_get_ysize(struct udevice *dev)
153 {
154 	struct video_priv *priv = dev_get_uclass_priv(dev);
155 
156 	return priv->ysize;
157 }
158 
159 /* Set up the colour map */
160 static int video_pre_probe(struct udevice *dev)
161 {
162 	struct video_priv *priv = dev_get_uclass_priv(dev);
163 
164 	priv->cmap = calloc(256, sizeof(ushort));
165 	if (!priv->cmap)
166 		return -ENOMEM;
167 
168 	return 0;
169 }
170 
171 static int video_pre_remove(struct udevice *dev)
172 {
173 	struct video_priv *priv = dev_get_uclass_priv(dev);
174 
175 	free(priv->cmap);
176 
177 	return 0;
178 }
179 
180 /* Set up the display ready for use */
181 static int video_post_probe(struct udevice *dev)
182 {
183 	struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
184 	struct video_priv *priv = dev_get_uclass_priv(dev);
185 	char name[30], drv[15], *str;
186 	const char *drv_name = drv;
187 	struct udevice *cons;
188 	int ret;
189 
190 	/* Set up the line and display size */
191 	priv->fb = map_sysmem(plat->base, plat->size);
192 	priv->line_length = priv->xsize * VNBYTES(priv->bpix);
193 	priv->fb_size = priv->line_length * priv->ysize;
194 
195 	/* Set up colours - we could in future support other colours */
196 #ifdef CONFIG_SYS_WHITE_ON_BLACK
197 	priv->colour_fg = 0xffffff;
198 #else
199 	priv->colour_bg = 0xffffff;
200 #endif
201 	video_clear(dev);
202 
203 	/*
204 	 * Create a text console device. For now we always do this, although
205 	 * it might be useful to support only bitmap drawing on the device
206 	 * for boards that don't need to display text. We create a TrueType
207 	 * console if enabled, a rotated console if the video driver requests
208 	 * it, otherwise a normal console.
209 	 *
210 	 * The console can be override by setting vidconsole_drv_name before
211 	 * probing this video driver, or in the probe() method.
212 	 *
213 	 * TrueType does not support rotation at present so fall back to the
214 	 * rotated console in that case.
215 	 */
216 	if (!priv->rot && IS_ENABLED(CONFIG_CONSOLE_TRUETYPE)) {
217 		snprintf(name, sizeof(name), "%s.vidconsole_tt", dev->name);
218 		strcpy(drv, "vidconsole_tt");
219 	} else {
220 		snprintf(name, sizeof(name), "%s.vidconsole%d", dev->name,
221 			 priv->rot);
222 		snprintf(drv, sizeof(drv), "vidconsole%d", priv->rot);
223 	}
224 
225 	str = strdup(name);
226 	if (!str)
227 		return -ENOMEM;
228 	if (priv->vidconsole_drv_name)
229 		drv_name = priv->vidconsole_drv_name;
230 	ret = device_bind_driver(dev, drv_name, str, &cons);
231 	if (ret) {
232 		debug("%s: Cannot bind console driver\n", __func__);
233 		return ret;
234 	}
235 
236 	ret = device_probe(cons);
237 	if (ret) {
238 		debug("%s: Cannot probe console driver\n", __func__);
239 		return ret;
240 	}
241 
242 	return 0;
243 };
244 
245 /* Post-relocation, allocate memory for the frame buffer */
246 static int video_post_bind(struct udevice *dev)
247 {
248 	ulong addr = gd->video_top;
249 	ulong size;
250 
251 	/* Before relocation there is nothing to do here */
252 	if ((!gd->flags & GD_FLG_RELOC))
253 		return 0;
254 	size = alloc_fb(dev, &addr);
255 	if (addr < gd->video_bottom) {
256 		/* Device tree node may need the 'u-boot,dm-pre-reloc' tag */
257 		printf("Video device '%s' cannot allocate frame buffer memory -ensure the device is set up before relocation\n",
258 		       dev->name);
259 		return -ENOSPC;
260 	}
261 	debug("%s: Claiming %lx bytes at %lx for video device '%s'\n",
262 	      __func__, size, addr, dev->name);
263 	gd->video_bottom = addr;
264 
265 	return 0;
266 }
267 
268 UCLASS_DRIVER(video) = {
269 	.id		= UCLASS_VIDEO,
270 	.name		= "video",
271 	.flags		= DM_UC_FLAG_SEQ_ALIAS,
272 	.post_bind	= video_post_bind,
273 	.pre_probe	= video_pre_probe,
274 	.post_probe	= video_post_probe,
275 	.pre_remove	= video_pre_remove,
276 	.per_device_auto_alloc_size	= sizeof(struct video_priv),
277 	.per_device_platdata_auto_alloc_size = sizeof(struct video_uc_platdata),
278 };
279