1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2015 Google, Inc
11 #include <video_console.h>
13 #include <dm/device-internal.h>
14 #include <dm/uclass-internal.h>
20 * Theory of operation:
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.
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.
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.
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.
42 DECLARE_GLOBAL_DATA_PTR;
44 void video_set_flush_dcache(struct udevice *dev, bool flush)
46 struct video_priv *priv = dev_get_uclass_priv(dev);
48 priv->flush_dcache = flush;
51 static ulong alloc_fb(struct udevice *dev, ulong *addrp)
53 struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
54 ulong base, align, size;
59 align = plat->align ? plat->align : 1 << 20;
60 base = *addrp - plat->size;
69 int video_reserve(ulong *addrp)
74 gd->video_top = *addrp;
75 for (uclass_find_first_device(UCLASS_VIDEO, &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);
82 gd->video_bottom = *addrp;
83 debug("Video frame buffers from %lx to %lx\n", gd->video_bottom,
89 int video_clear(struct udevice *dev)
91 struct video_priv *priv = dev_get_uclass_priv(dev);
96 u16 *end = priv->fb + priv->fb_size;
99 *ppix++ = priv->colour_bg;
103 u32 *ppix = priv->fb;
104 u32 *end = priv->fb + priv->fb_size;
107 *ppix++ = priv->colour_bg;
111 memset(priv->fb, priv->colour_bg, priv->fb_size);
118 void video_set_default_colors(struct video_priv *priv)
120 #ifdef CONFIG_SYS_WHITE_ON_BLACK
121 /* White is used when switching to bold, use light gray here */
122 priv->fg_col_idx = VID_LIGHT_GRAY;
123 priv->colour_fg = vid_console_color(priv, VID_LIGHT_GRAY);
124 priv->colour_bg = vid_console_color(priv, VID_BLACK);
126 priv->fg_col_idx = VID_BLACK;
127 priv->colour_fg = vid_console_color(priv, VID_BLACK);
128 priv->colour_bg = vid_console_color(priv, VID_WHITE);
132 /* Flush video activity to the caches */
133 void video_sync(struct udevice *vid, bool force)
136 * flush_dcache_range() is declared in common.h but it seems that some
137 * architectures do not actually implement it. Is there a way to find
138 * out whether it exists? For now, ARM is safe.
140 #if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
141 struct video_priv *priv = dev_get_uclass_priv(vid);
143 if (priv->flush_dcache) {
144 flush_dcache_range((ulong)priv->fb,
145 ALIGN((ulong)priv->fb + priv->fb_size,
146 CONFIG_SYS_CACHELINE_SIZE));
148 #elif defined(CONFIG_VIDEO_SANDBOX_SDL)
149 struct video_priv *priv = dev_get_uclass_priv(vid);
150 static ulong last_sync;
152 if (force || get_timer(last_sync) > 10) {
153 sandbox_sdl_sync(priv->fb);
154 last_sync = get_timer(0);
159 void video_sync_all(void)
163 for (uclass_find_first_device(UCLASS_VIDEO, &dev);
165 uclass_find_next_device(&dev)) {
166 if (device_active(dev))
167 video_sync(dev, true);
171 int video_get_xsize(struct udevice *dev)
173 struct video_priv *priv = dev_get_uclass_priv(dev);
178 int video_get_ysize(struct udevice *dev)
180 struct video_priv *priv = dev_get_uclass_priv(dev);
185 /* Set up the colour map */
186 static int video_pre_probe(struct udevice *dev)
188 struct video_priv *priv = dev_get_uclass_priv(dev);
190 priv->cmap = calloc(256, sizeof(ushort));
197 static int video_pre_remove(struct udevice *dev)
199 struct video_priv *priv = dev_get_uclass_priv(dev);
206 /* Set up the display ready for use */
207 static int video_post_probe(struct udevice *dev)
209 struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
210 struct video_priv *priv = dev_get_uclass_priv(dev);
211 char name[30], drv[15], *str;
212 const char *drv_name = drv;
213 struct udevice *cons;
216 /* Set up the line and display size */
217 priv->fb = map_sysmem(plat->base, plat->size);
218 priv->line_length = priv->xsize * VNBYTES(priv->bpix);
219 priv->fb_size = priv->line_length * priv->ysize;
222 video_set_default_colors(priv);
224 if (!CONFIG_IS_ENABLED(NO_FB_CLEAR))
228 * Create a text console device. For now we always do this, although
229 * it might be useful to support only bitmap drawing on the device
230 * for boards that don't need to display text. We create a TrueType
231 * console if enabled, a rotated console if the video driver requests
232 * it, otherwise a normal console.
234 * The console can be override by setting vidconsole_drv_name before
235 * probing this video driver, or in the probe() method.
237 * TrueType does not support rotation at present so fall back to the
238 * rotated console in that case.
240 if (!priv->rot && IS_ENABLED(CONFIG_CONSOLE_TRUETYPE)) {
241 snprintf(name, sizeof(name), "%s.vidconsole_tt", dev->name);
242 strcpy(drv, "vidconsole_tt");
244 snprintf(name, sizeof(name), "%s.vidconsole%d", dev->name,
246 snprintf(drv, sizeof(drv), "vidconsole%d", priv->rot);
252 if (priv->vidconsole_drv_name)
253 drv_name = priv->vidconsole_drv_name;
254 ret = device_bind_driver(dev, drv_name, str, &cons);
256 debug("%s: Cannot bind console driver\n", __func__);
260 ret = device_probe(cons);
262 debug("%s: Cannot probe console driver\n", __func__);
269 /* Post-relocation, allocate memory for the frame buffer */
270 static int video_post_bind(struct udevice *dev)
272 ulong addr = gd->video_top;
275 /* Before relocation there is nothing to do here */
276 if (!(gd->flags & GD_FLG_RELOC))
278 size = alloc_fb(dev, &addr);
279 if (addr < gd->video_bottom) {
280 /* Device tree node may need the 'u-boot,dm-pre-reloc' tag */
281 printf("Video device '%s' cannot allocate frame buffer memory -ensure the device is set up before relocation\n",
285 debug("%s: Claiming %lx bytes at %lx for video device '%s'\n",
286 __func__, size, addr, dev->name);
287 gd->video_bottom = addr;
292 UCLASS_DRIVER(video) = {
295 .flags = DM_UC_FLAG_SEQ_ALIAS,
296 .post_bind = video_post_bind,
297 .pre_probe = video_pre_probe,
298 .post_probe = video_post_probe,
299 .pre_remove = video_pre_remove,
300 .per_device_auto_alloc_size = sizeof(struct video_priv),
301 .per_device_platdata_auto_alloc_size = sizeof(struct video_uc_platdata),