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