1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2015 Google, Inc
10 #include <stdio_dev.h>
12 #include <video_console.h>
14 #include <dm/device-internal.h>
15 #include <dm/uclass-internal.h>
21 * Theory of operation:
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.
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.
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.
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.
43 DECLARE_GLOBAL_DATA_PTR;
45 void video_set_flush_dcache(struct udevice *dev, bool flush)
47 struct video_priv *priv = dev_get_uclass_priv(dev);
49 priv->flush_dcache = flush;
52 static ulong alloc_fb(struct udevice *dev, ulong *addrp)
54 struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
55 ulong base, align, size;
60 align = plat->align ? plat->align : 1 << 20;
61 base = *addrp - plat->size;
70 int video_reserve(ulong *addrp)
75 gd->video_top = *addrp;
76 for (uclass_find_first_device(UCLASS_VIDEO, &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);
83 gd->video_bottom = *addrp;
84 debug("Video frame buffers from %lx to %lx\n", gd->video_bottom,
90 int video_clear(struct udevice *dev)
92 struct video_priv *priv = dev_get_uclass_priv(dev);
97 u16 *end = priv->fb + priv->fb_size;
100 *ppix++ = priv->colour_bg;
104 u32 *ppix = priv->fb;
105 u32 *end = priv->fb + priv->fb_size;
108 *ppix++ = priv->colour_bg;
112 memset(priv->fb, priv->colour_bg, priv->fb_size);
119 void video_set_default_colors(struct udevice *dev, bool invert)
121 struct video_priv *priv = dev_get_uclass_priv(dev);
124 #ifdef CONFIG_SYS_WHITE_ON_BLACK
125 /* White is used when switching to bold, use light gray here */
126 fore = VID_LIGHT_GRAY;
139 priv->fg_col_idx = fore;
140 priv->bg_col_idx = back;
141 priv->colour_fg = vid_console_color(priv, fore);
142 priv->colour_bg = vid_console_color(priv, back);
145 /* Flush video activity to the caches */
146 void video_sync(struct udevice *vid, bool force)
149 * flush_dcache_range() is declared in common.h but it seems that some
150 * architectures do not actually implement it. Is there a way to find
151 * out whether it exists? For now, ARM is safe.
153 #if defined(CONFIG_ARM) && !CONFIG_IS_ENABLED(SYS_DCACHE_OFF)
154 struct video_priv *priv = dev_get_uclass_priv(vid);
156 if (priv->flush_dcache) {
157 flush_dcache_range((ulong)priv->fb,
158 ALIGN((ulong)priv->fb + priv->fb_size,
159 CONFIG_SYS_CACHELINE_SIZE));
161 #elif defined(CONFIG_VIDEO_SANDBOX_SDL)
162 struct video_priv *priv = dev_get_uclass_priv(vid);
163 static ulong last_sync;
165 if (force || get_timer(last_sync) > 10) {
166 sandbox_sdl_sync(priv->fb);
167 last_sync = get_timer(0);
172 void video_sync_all(void)
176 for (uclass_find_first_device(UCLASS_VIDEO, &dev);
178 uclass_find_next_device(&dev)) {
179 if (device_active(dev))
180 video_sync(dev, true);
184 int video_get_xsize(struct udevice *dev)
186 struct video_priv *priv = dev_get_uclass_priv(dev);
191 int video_get_ysize(struct udevice *dev)
193 struct video_priv *priv = dev_get_uclass_priv(dev);
198 /* Set up the colour map */
199 static int video_pre_probe(struct udevice *dev)
201 struct video_priv *priv = dev_get_uclass_priv(dev);
203 priv->cmap = calloc(256, sizeof(ushort));
210 static int video_pre_remove(struct udevice *dev)
212 struct video_priv *priv = dev_get_uclass_priv(dev);
219 /* Set up the display ready for use */
220 static int video_post_probe(struct udevice *dev)
222 struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
223 struct video_priv *priv = dev_get_uclass_priv(dev);
224 char name[30], drv[15], *str;
225 const char *drv_name = drv;
226 struct udevice *cons;
229 /* Set up the line and display size */
230 priv->fb = map_sysmem(plat->base, plat->size);
231 if (!priv->line_length)
232 priv->line_length = priv->xsize * VNBYTES(priv->bpix);
234 priv->fb_size = priv->line_length * priv->ysize;
237 video_set_default_colors(dev, false);
239 if (!CONFIG_IS_ENABLED(NO_FB_CLEAR))
243 * Create a text console device. For now we always do this, although
244 * it might be useful to support only bitmap drawing on the device
245 * for boards that don't need to display text. We create a TrueType
246 * console if enabled, a rotated console if the video driver requests
247 * it, otherwise a normal console.
249 * The console can be override by setting vidconsole_drv_name before
250 * probing this video driver, or in the probe() method.
252 * TrueType does not support rotation at present so fall back to the
253 * rotated console in that case.
255 if (!priv->rot && IS_ENABLED(CONFIG_CONSOLE_TRUETYPE)) {
256 snprintf(name, sizeof(name), "%s.vidconsole_tt", dev->name);
257 strcpy(drv, "vidconsole_tt");
259 snprintf(name, sizeof(name), "%s.vidconsole%d", dev->name,
261 snprintf(drv, sizeof(drv), "vidconsole%d", priv->rot);
267 if (priv->vidconsole_drv_name)
268 drv_name = priv->vidconsole_drv_name;
269 ret = device_bind_driver(dev, drv_name, str, &cons);
271 debug("%s: Cannot bind console driver\n", __func__);
275 ret = device_probe(cons);
277 debug("%s: Cannot probe console driver\n", __func__);
284 /* Post-relocation, allocate memory for the frame buffer */
285 static int video_post_bind(struct udevice *dev)
287 ulong addr = gd->video_top;
290 /* Before relocation there is nothing to do here */
291 if (!(gd->flags & GD_FLG_RELOC))
293 size = alloc_fb(dev, &addr);
294 if (addr < gd->video_bottom) {
295 /* Device tree node may need the 'u-boot,dm-pre-reloc' or
296 * 'u-boot,dm-pre-proper' tag
298 printf("Video device '%s' cannot allocate frame buffer memory -ensure the device is set up before relocation\n",
302 debug("%s: Claiming %lx bytes at %lx for video device '%s'\n",
303 __func__, size, addr, dev->name);
304 gd->video_bottom = addr;
309 UCLASS_DRIVER(video) = {
312 .flags = DM_UC_FLAG_SEQ_ALIAS,
313 .post_bind = video_post_bind,
314 .pre_probe = video_pre_probe,
315 .post_probe = video_post_probe,
316 .pre_remove = video_pre_remove,
317 .per_device_auto_alloc_size = sizeof(struct video_priv),
318 .per_device_platdata_auto_alloc_size = sizeof(struct video_uc_platdata),