xref: /openbmc/u-boot/drivers/video/video-uclass.c (revision 2d2811c2)
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 	align = plat->align ? plat->align : 1 << 20;
58 	base = *addrp - plat->size;
59 	base &= ~(align - 1);
60 	plat->base = base;
61 	size = *addrp - base;
62 	*addrp = base;
63 
64 	return size;
65 }
66 
67 int video_reserve(ulong *addrp)
68 {
69 	struct udevice *dev;
70 	ulong size;
71 
72 	gd->video_top = *addrp;
73 	for (uclass_find_first_device(UCLASS_VIDEO, &dev);
74 	     dev;
75 	     uclass_find_next_device(&dev)) {
76 		size = alloc_fb(dev, addrp);
77 		debug("%s: Reserving %lx bytes at %lx for video device '%s'\n",
78 		      __func__, size, *addrp, dev->name);
79 	}
80 	gd->video_bottom = *addrp;
81 	debug("Video frame buffers from %lx to %lx\n", gd->video_bottom,
82 	      gd->video_top);
83 
84 	return 0;
85 }
86 
87 static int video_clear(struct udevice *dev)
88 {
89 	struct video_priv *priv = dev_get_uclass_priv(dev);
90 
91 	if (priv->bpix == VIDEO_BPP32) {
92 		u32 *ppix = priv->fb;
93 		u32 *end = priv->fb + priv->fb_size;
94 
95 		while (ppix < end)
96 			*ppix++ = priv->colour_bg;
97 	} else {
98 		memset(priv->fb, priv->colour_bg, priv->fb_size);
99 	}
100 
101 	return 0;
102 }
103 
104 /* Flush video activity to the caches */
105 void video_sync(struct udevice *vid)
106 {
107 	/*
108 	 * flush_dcache_range() is declared in common.h but it seems that some
109 	 * architectures do not actually implement it. Is there a way to find
110 	 * out whether it exists? For now, ARM is safe.
111 	 */
112 #if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
113 	struct video_priv *priv = dev_get_uclass_priv(vid);
114 
115 	if (priv->flush_dcache) {
116 		flush_dcache_range((ulong)priv->fb,
117 				   (ulong)priv->fb + priv->fb_size);
118 	}
119 #elif defined(CONFIG_VIDEO_SANDBOX_SDL)
120 	struct video_priv *priv = dev_get_uclass_priv(vid);
121 	static ulong last_sync;
122 
123 	if (get_timer(last_sync) > 10) {
124 		sandbox_sdl_sync(priv->fb);
125 		last_sync = get_timer(0);
126 	}
127 #endif
128 }
129 
130 void video_sync_all(void)
131 {
132 	struct udevice *dev;
133 
134 	for (uclass_find_first_device(UCLASS_VIDEO, &dev);
135 	     dev;
136 	     uclass_find_next_device(&dev)) {
137 		if (device_active(dev))
138 			video_sync(dev);
139 	}
140 }
141 
142 int video_get_xsize(struct udevice *dev)
143 {
144 	struct video_priv *priv = dev_get_uclass_priv(dev);
145 
146 	return priv->xsize;
147 }
148 
149 int video_get_ysize(struct udevice *dev)
150 {
151 	struct video_priv *priv = dev_get_uclass_priv(dev);
152 
153 	return priv->ysize;
154 }
155 
156 /* Set up the colour map */
157 static int video_pre_probe(struct udevice *dev)
158 {
159 	struct video_priv *priv = dev_get_uclass_priv(dev);
160 
161 	priv->cmap = calloc(256, sizeof(ushort));
162 	if (!priv->cmap)
163 		return -ENOMEM;
164 
165 	return 0;
166 }
167 
168 static int video_pre_remove(struct udevice *dev)
169 {
170 	struct video_priv *priv = dev_get_uclass_priv(dev);
171 
172 	free(priv->cmap);
173 
174 	return 0;
175 }
176 
177 /* Set up the display ready for use */
178 static int video_post_probe(struct udevice *dev)
179 {
180 	struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
181 	struct video_priv *priv = dev_get_uclass_priv(dev);
182 	char name[30], drv[15], *str;
183 	const char *drv_name = drv;
184 	struct udevice *cons;
185 	int ret;
186 
187 	/* Set up the line and display size */
188 	priv->fb = map_sysmem(plat->base, plat->size);
189 	priv->line_length = priv->xsize * VNBYTES(priv->bpix);
190 	priv->fb_size = priv->line_length * priv->ysize;
191 
192 	/* Set up colours - we could in future support other colours */
193 #ifdef CONFIG_SYS_WHITE_ON_BLACK
194 	priv->colour_fg = 0xffffff;
195 #else
196 	priv->colour_bg = 0xffffff;
197 #endif
198 	video_clear(dev);
199 
200 	/*
201 	 * Create a text console device. For now we always do this, although
202 	 * it might be useful to support only bitmap drawing on the device
203 	 * for boards that don't need to display text. We create a TrueType
204 	 * console if enabled, a rotated console if the video driver requests
205 	 * it, otherwise a normal console.
206 	 *
207 	 * The console can be override by setting vidconsole_drv_name before
208 	 * probing this video driver, or in the probe() method.
209 	 *
210 	 * TrueType does not support rotation at present so fall back to the
211 	 * rotated console in that case.
212 	 */
213 	if (!priv->rot && IS_ENABLED(CONFIG_CONSOLE_TRUETYPE)) {
214 		snprintf(name, sizeof(name), "%s.vidconsole_tt", dev->name);
215 		strcpy(drv, "vidconsole_tt");
216 	} else {
217 		snprintf(name, sizeof(name), "%s.vidconsole%d", dev->name,
218 			 priv->rot);
219 		snprintf(drv, sizeof(drv), "vidconsole%d", priv->rot);
220 	}
221 
222 	str = strdup(name);
223 	if (!str)
224 		return -ENOMEM;
225 	if (priv->vidconsole_drv_name)
226 		drv_name = priv->vidconsole_drv_name;
227 	ret = device_bind_driver(dev, drv_name, str, &cons);
228 	if (ret) {
229 		debug("%s: Cannot bind console driver\n", __func__);
230 		return ret;
231 	}
232 
233 	ret = device_probe(cons);
234 	if (ret) {
235 		debug("%s: Cannot probe console driver\n", __func__);
236 		return ret;
237 	}
238 
239 	return 0;
240 };
241 
242 /* Post-relocation, allocate memory for the frame buffer */
243 static int video_post_bind(struct udevice *dev)
244 {
245 	ulong addr = gd->video_top;
246 	ulong size;
247 
248 	/* Before relocation there is nothing to do here */
249 	if ((!gd->flags & GD_FLG_RELOC))
250 		return 0;
251 	size = alloc_fb(dev, &addr);
252 	if (addr < gd->video_bottom) {
253 		/* Device tree node may need the 'u-boot,dm-pre-reloc' tag */
254 		printf("Video device '%s' cannot allocate frame buffer memory -ensure the device is set up before relocation\n",
255 		       dev->name);
256 		return -ENOSPC;
257 	}
258 	debug("%s: Claiming %lx bytes at %lx for video device '%s'\n",
259 	      __func__, size, addr, dev->name);
260 	gd->video_bottom = addr;
261 
262 	return 0;
263 }
264 
265 UCLASS_DRIVER(video) = {
266 	.id		= UCLASS_VIDEO,
267 	.name		= "video",
268 	.flags		= DM_UC_FLAG_SEQ_ALIAS,
269 	.post_bind	= video_post_bind,
270 	.pre_probe	= video_pre_probe,
271 	.post_probe	= video_post_probe,
272 	.pre_remove	= video_pre_remove,
273 	.per_device_auto_alloc_size	= sizeof(struct video_priv),
274 	.per_device_platdata_auto_alloc_size = sizeof(struct video_uc_platdata),
275 };
276