1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2015 Google, Inc
11 #include <stdio_dev.h>
13 #include <video_console.h>
15 #include <dm/device-internal.h>
16 #include <dm/uclass-internal.h>
22 * Theory of operation:
24 * Before relocation each device is bound. The driver for each device must
25 * set the @align and @size values in struct video_uc_platdata. This
26 * information represents the requires size and alignment of the frame buffer
27 * for the device. The values can be an over-estimate but cannot be too
28 * small. The actual values will be suppled (in the same manner) by the bind()
29 * method after relocation.
31 * This information is then picked up by video_reserve() which works out how
32 * much memory is needed for all devices. This is allocated between
33 * gd->video_bottom and gd->video_top.
35 * After relocation the same process occurs. The driver supplies the same
36 * @size and @align information and this time video_post_bind() checks that
37 * the drivers does not overflow the allocated memory.
39 * The frame buffer address is actually set (to plat->base) in
40 * video_post_probe(). This function also clears the frame buffer and
41 * allocates a suitable text console device. This can then be used to write
42 * text to the video device.
44 DECLARE_GLOBAL_DATA_PTR;
46 void video_set_flush_dcache(struct udevice *dev, bool flush)
48 struct video_priv *priv = dev_get_uclass_priv(dev);
50 priv->flush_dcache = flush;
53 static ulong alloc_fb(struct udevice *dev, ulong *addrp)
55 struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
56 ulong base, align, size;
61 align = plat->align ? plat->align : 1 << 20;
62 base = *addrp - plat->size;
71 int video_reserve(ulong *addrp)
76 gd->video_top = *addrp;
77 for (uclass_find_first_device(UCLASS_VIDEO, &dev);
79 uclass_find_next_device(&dev)) {
80 size = alloc_fb(dev, addrp);
81 debug("%s: Reserving %lx bytes at %lx for video device '%s'\n",
82 __func__, size, *addrp, dev->name);
84 gd->video_bottom = *addrp;
85 debug("Video frame buffers from %lx to %lx\n", gd->video_bottom,
91 int video_clear(struct udevice *dev)
93 struct video_priv *priv = dev_get_uclass_priv(dev);
97 if (IS_ENABLED(CONFIG_VIDEO_BPP16)) {
99 u16 *end = priv->fb + priv->fb_size;
102 *ppix++ = priv->colour_bg;
106 if (IS_ENABLED(CONFIG_VIDEO_BPP32)) {
107 u32 *ppix = priv->fb;
108 u32 *end = priv->fb + priv->fb_size;
111 *ppix++ = priv->colour_bg;
115 memset(priv->fb, priv->colour_bg, priv->fb_size);
122 void video_set_default_colors(struct udevice *dev, bool invert)
124 struct video_priv *priv = dev_get_uclass_priv(dev);
127 if (CONFIG_IS_ENABLED(SYS_WHITE_ON_BLACK)) {
128 /* White is used when switching to bold, use light gray here */
129 fore = VID_LIGHT_GRAY;
142 priv->fg_col_idx = fore;
143 priv->bg_col_idx = back;
144 priv->colour_fg = vid_console_color(priv, fore);
145 priv->colour_bg = vid_console_color(priv, back);
148 /* Flush video activity to the caches */
149 void video_sync(struct udevice *vid, bool force)
152 * flush_dcache_range() is declared in common.h but it seems that some
153 * architectures do not actually implement it. Is there a way to find
154 * out whether it exists? For now, ARM is safe.
156 #if defined(CONFIG_ARM) && !CONFIG_IS_ENABLED(SYS_DCACHE_OFF)
157 struct video_priv *priv = dev_get_uclass_priv(vid);
159 if (priv->flush_dcache) {
160 flush_dcache_range((ulong)priv->fb,
161 ALIGN((ulong)priv->fb + priv->fb_size,
162 CONFIG_SYS_CACHELINE_SIZE));
164 #elif defined(CONFIG_VIDEO_SANDBOX_SDL)
165 struct video_priv *priv = dev_get_uclass_priv(vid);
166 static ulong last_sync;
168 if (force || get_timer(last_sync) > 10) {
169 sandbox_sdl_sync(priv->fb);
170 last_sync = get_timer(0);
175 void video_sync_all(void)
179 for (uclass_find_first_device(UCLASS_VIDEO, &dev);
181 uclass_find_next_device(&dev)) {
182 if (device_active(dev))
183 video_sync(dev, true);
187 int video_get_xsize(struct udevice *dev)
189 struct video_priv *priv = dev_get_uclass_priv(dev);
194 int video_get_ysize(struct udevice *dev)
196 struct video_priv *priv = dev_get_uclass_priv(dev);
201 /* Set up the colour map */
202 static int video_pre_probe(struct udevice *dev)
204 struct video_priv *priv = dev_get_uclass_priv(dev);
206 priv->cmap = calloc(256, sizeof(ushort));
213 static int video_pre_remove(struct udevice *dev)
215 struct video_priv *priv = dev_get_uclass_priv(dev);
222 /* Set up the display ready for use */
223 static int video_post_probe(struct udevice *dev)
225 struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
226 struct video_priv *priv = dev_get_uclass_priv(dev);
227 char name[30], drv[15], *str;
228 const char *drv_name = drv;
229 struct udevice *cons;
232 /* Set up the line and display size */
233 priv->fb = map_sysmem(plat->base, plat->size);
234 if (!priv->line_length)
235 priv->line_length = priv->xsize * VNBYTES(priv->bpix);
237 priv->fb_size = priv->line_length * priv->ysize;
240 video_set_default_colors(dev, false);
242 if (!CONFIG_IS_ENABLED(NO_FB_CLEAR))
246 * Create a text console device. For now we always do this, although
247 * it might be useful to support only bitmap drawing on the device
248 * for boards that don't need to display text. We create a TrueType
249 * console if enabled, a rotated console if the video driver requests
250 * it, otherwise a normal console.
252 * The console can be override by setting vidconsole_drv_name before
253 * probing this video driver, or in the probe() method.
255 * TrueType does not support rotation at present so fall back to the
256 * rotated console in that case.
258 if (!priv->rot && IS_ENABLED(CONFIG_CONSOLE_TRUETYPE)) {
259 snprintf(name, sizeof(name), "%s.vidconsole_tt", dev->name);
260 strcpy(drv, "vidconsole_tt");
262 snprintf(name, sizeof(name), "%s.vidconsole%d", dev->name,
264 snprintf(drv, sizeof(drv), "vidconsole%d", priv->rot);
270 if (priv->vidconsole_drv_name)
271 drv_name = priv->vidconsole_drv_name;
272 ret = device_bind_driver(dev, drv_name, str, &cons);
274 debug("%s: Cannot bind console driver\n", __func__);
278 ret = device_probe(cons);
280 debug("%s: Cannot probe console driver\n", __func__);
287 /* Post-relocation, allocate memory for the frame buffer */
288 static int video_post_bind(struct udevice *dev)
290 ulong addr = gd->video_top;
293 /* Before relocation there is nothing to do here */
294 if (!(gd->flags & GD_FLG_RELOC))
296 size = alloc_fb(dev, &addr);
297 if (addr < gd->video_bottom) {
298 /* Device tree node may need the 'u-boot,dm-pre-reloc' or
299 * 'u-boot,dm-pre-proper' tag
301 printf("Video device '%s' cannot allocate frame buffer memory -ensure the device is set up before relocation\n",
305 debug("%s: Claiming %lx bytes at %lx for video device '%s'\n",
306 __func__, size, addr, dev->name);
307 gd->video_bottom = addr;
312 UCLASS_DRIVER(video) = {
315 .flags = DM_UC_FLAG_SEQ_ALIAS,
316 .post_bind = video_post_bind,
317 .pre_probe = video_pre_probe,
318 .post_probe = video_post_probe,
319 .pre_remove = video_pre_remove,
320 .per_device_auto_alloc_size = sizeof(struct video_priv),
321 .per_device_platdata_auto_alloc_size = sizeof(struct video_uc_platdata),