2 * Copyright (c) 2015 Google, Inc
4 * SPDX-License-Identifier: GPL-2.0+
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 void 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);
117 void video_set_default_colors(struct video_priv *priv)
119 #ifdef CONFIG_SYS_WHITE_ON_BLACK
120 priv->colour_fg = vid_console_color(priv, VID_WHITE);
121 priv->colour_bg = vid_console_color(priv, VID_BLACK);
123 priv->colour_fg = vid_console_color(priv, VID_BLACK);
124 priv->colour_bg = vid_console_color(priv, VID_WHITE);
128 /* Flush video activity to the caches */
129 void video_sync(struct udevice *vid)
132 * flush_dcache_range() is declared in common.h but it seems that some
133 * architectures do not actually implement it. Is there a way to find
134 * out whether it exists? For now, ARM is safe.
136 #if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
137 struct video_priv *priv = dev_get_uclass_priv(vid);
139 if (priv->flush_dcache) {
140 flush_dcache_range((ulong)priv->fb,
141 ALIGN((ulong)priv->fb + priv->fb_size,
142 CONFIG_SYS_CACHELINE_SIZE));
144 #elif defined(CONFIG_VIDEO_SANDBOX_SDL)
145 struct video_priv *priv = dev_get_uclass_priv(vid);
146 static ulong last_sync;
148 if (get_timer(last_sync) > 10) {
149 sandbox_sdl_sync(priv->fb);
150 last_sync = get_timer(0);
155 void video_sync_all(void)
159 for (uclass_find_first_device(UCLASS_VIDEO, &dev);
161 uclass_find_next_device(&dev)) {
162 if (device_active(dev))
167 int video_get_xsize(struct udevice *dev)
169 struct video_priv *priv = dev_get_uclass_priv(dev);
174 int video_get_ysize(struct udevice *dev)
176 struct video_priv *priv = dev_get_uclass_priv(dev);
181 /* Set up the colour map */
182 static int video_pre_probe(struct udevice *dev)
184 struct video_priv *priv = dev_get_uclass_priv(dev);
186 priv->cmap = calloc(256, sizeof(ushort));
193 static int video_pre_remove(struct udevice *dev)
195 struct video_priv *priv = dev_get_uclass_priv(dev);
202 /* Set up the display ready for use */
203 static int video_post_probe(struct udevice *dev)
205 struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
206 struct video_priv *priv = dev_get_uclass_priv(dev);
207 char name[30], drv[15], *str;
208 const char *drv_name = drv;
209 struct udevice *cons;
212 /* Set up the line and display size */
213 priv->fb = map_sysmem(plat->base, plat->size);
214 priv->line_length = priv->xsize * VNBYTES(priv->bpix);
215 priv->fb_size = priv->line_length * priv->ysize;
218 video_set_default_colors(priv);
220 if (!CONFIG_IS_ENABLED(NO_FB_CLEAR))
224 * Create a text console device. For now we always do this, although
225 * it might be useful to support only bitmap drawing on the device
226 * for boards that don't need to display text. We create a TrueType
227 * console if enabled, a rotated console if the video driver requests
228 * it, otherwise a normal console.
230 * The console can be override by setting vidconsole_drv_name before
231 * probing this video driver, or in the probe() method.
233 * TrueType does not support rotation at present so fall back to the
234 * rotated console in that case.
236 if (!priv->rot && IS_ENABLED(CONFIG_CONSOLE_TRUETYPE)) {
237 snprintf(name, sizeof(name), "%s.vidconsole_tt", dev->name);
238 strcpy(drv, "vidconsole_tt");
240 snprintf(name, sizeof(name), "%s.vidconsole%d", dev->name,
242 snprintf(drv, sizeof(drv), "vidconsole%d", priv->rot);
248 if (priv->vidconsole_drv_name)
249 drv_name = priv->vidconsole_drv_name;
250 ret = device_bind_driver(dev, drv_name, str, &cons);
252 debug("%s: Cannot bind console driver\n", __func__);
256 ret = device_probe(cons);
258 debug("%s: Cannot probe console driver\n", __func__);
265 /* Post-relocation, allocate memory for the frame buffer */
266 static int video_post_bind(struct udevice *dev)
268 ulong addr = gd->video_top;
271 /* Before relocation there is nothing to do here */
272 if ((!gd->flags & GD_FLG_RELOC))
274 size = alloc_fb(dev, &addr);
275 if (addr < gd->video_bottom) {
276 /* Device tree node may need the 'u-boot,dm-pre-reloc' tag */
277 printf("Video device '%s' cannot allocate frame buffer memory -ensure the device is set up before relocation\n",
281 debug("%s: Claiming %lx bytes at %lx for video device '%s'\n",
282 __func__, size, addr, dev->name);
283 gd->video_bottom = addr;
288 UCLASS_DRIVER(video) = {
291 .flags = DM_UC_FLAG_SEQ_ALIAS,
292 .post_bind = video_post_bind,
293 .pre_probe = video_pre_probe,
294 .post_probe = video_post_probe,
295 .pre_remove = video_pre_remove,
296 .per_device_auto_alloc_size = sizeof(struct video_priv),
297 .per_device_platdata_auto_alloc_size = sizeof(struct video_uc_platdata),