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