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 void 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
);
116 void video_set_default_colors(struct video_priv
*priv
)
118 #ifdef CONFIG_SYS_WHITE_ON_BLACK
119 /* White is used when switching to bold, use light gray here */
120 priv
->fg_col_idx
= VID_LIGHT_GRAY
;
121 priv
->colour_fg
= vid_console_color(priv
, VID_LIGHT_GRAY
);
122 priv
->colour_bg
= vid_console_color(priv
, VID_BLACK
);
124 priv
->fg_col_idx
= VID_BLACK
;
125 priv
->colour_fg
= vid_console_color(priv
, VID_BLACK
);
126 priv
->colour_bg
= vid_console_color(priv
, VID_WHITE
);
130 /* Flush video activity to the caches */
131 void video_sync(struct udevice
*vid
)
134 * flush_dcache_range() is declared in common.h but it seems that some
135 * architectures do not actually implement it. Is there a way to find
136 * out whether it exists? For now, ARM is safe.
138 #if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
139 struct video_priv
*priv
= dev_get_uclass_priv(vid
);
141 if (priv
->flush_dcache
) {
142 flush_dcache_range((ulong
)priv
->fb
,
143 ALIGN((ulong
)priv
->fb
+ priv
->fb_size
,
144 CONFIG_SYS_CACHELINE_SIZE
));
146 #elif defined(CONFIG_VIDEO_SANDBOX_SDL)
147 struct video_priv
*priv
= dev_get_uclass_priv(vid
);
148 static ulong last_sync
;
150 if (get_timer(last_sync
) > 10) {
151 sandbox_sdl_sync(priv
->fb
);
152 last_sync
= get_timer(0);
157 void video_sync_all(void)
161 for (uclass_find_first_device(UCLASS_VIDEO
, &dev
);
163 uclass_find_next_device(&dev
)) {
164 if (device_active(dev
))
169 int video_get_xsize(struct udevice
*dev
)
171 struct video_priv
*priv
= dev_get_uclass_priv(dev
);
176 int video_get_ysize(struct udevice
*dev
)
178 struct video_priv
*priv
= dev_get_uclass_priv(dev
);
183 /* Set up the colour map */
184 static int video_pre_probe(struct udevice
*dev
)
186 struct video_priv
*priv
= dev_get_uclass_priv(dev
);
188 priv
->cmap
= calloc(256, sizeof(ushort
));
195 static int video_pre_remove(struct udevice
*dev
)
197 struct video_priv
*priv
= dev_get_uclass_priv(dev
);
204 /* Set up the display ready for use */
205 static int video_post_probe(struct udevice
*dev
)
207 struct video_uc_platdata
*plat
= dev_get_uclass_platdata(dev
);
208 struct video_priv
*priv
= dev_get_uclass_priv(dev
);
209 char name
[30], drv
[15], *str
;
210 const char *drv_name
= drv
;
211 struct udevice
*cons
;
214 /* Set up the line and display size */
215 priv
->fb
= map_sysmem(plat
->base
, plat
->size
);
216 priv
->line_length
= priv
->xsize
* VNBYTES(priv
->bpix
);
217 priv
->fb_size
= priv
->line_length
* priv
->ysize
;
220 video_set_default_colors(priv
);
222 if (!CONFIG_IS_ENABLED(NO_FB_CLEAR
))
226 * Create a text console device. For now we always do this, although
227 * it might be useful to support only bitmap drawing on the device
228 * for boards that don't need to display text. We create a TrueType
229 * console if enabled, a rotated console if the video driver requests
230 * it, otherwise a normal console.
232 * The console can be override by setting vidconsole_drv_name before
233 * probing this video driver, or in the probe() method.
235 * TrueType does not support rotation at present so fall back to the
236 * rotated console in that case.
238 if (!priv
->rot
&& IS_ENABLED(CONFIG_CONSOLE_TRUETYPE
)) {
239 snprintf(name
, sizeof(name
), "%s.vidconsole_tt", dev
->name
);
240 strcpy(drv
, "vidconsole_tt");
242 snprintf(name
, sizeof(name
), "%s.vidconsole%d", dev
->name
,
244 snprintf(drv
, sizeof(drv
), "vidconsole%d", priv
->rot
);
250 if (priv
->vidconsole_drv_name
)
251 drv_name
= priv
->vidconsole_drv_name
;
252 ret
= device_bind_driver(dev
, drv_name
, str
, &cons
);
254 debug("%s: Cannot bind console driver\n", __func__
);
258 ret
= device_probe(cons
);
260 debug("%s: Cannot probe console driver\n", __func__
);
267 /* Post-relocation, allocate memory for the frame buffer */
268 static int video_post_bind(struct udevice
*dev
)
270 ulong addr
= gd
->video_top
;
273 /* Before relocation there is nothing to do here */
274 if (!(gd
->flags
& GD_FLG_RELOC
))
276 size
= alloc_fb(dev
, &addr
);
277 if (addr
< gd
->video_bottom
) {
278 /* Device tree node may need the 'u-boot,dm-pre-reloc' tag */
279 printf("Video device '%s' cannot allocate frame buffer memory -ensure the device is set up before relocation\n",
283 debug("%s: Claiming %lx bytes at %lx for video device '%s'\n",
284 __func__
, size
, addr
, dev
->name
);
285 gd
->video_bottom
= addr
;
290 UCLASS_DRIVER(video
) = {
293 .flags
= DM_UC_FLAG_SEQ_ALIAS
,
294 .post_bind
= video_post_bind
,
295 .pre_probe
= video_pre_probe
,
296 .post_probe
= video_post_probe
,
297 .pre_remove
= video_pre_remove
,
298 .per_device_auto_alloc_size
= sizeof(struct video_priv
),
299 .per_device_platdata_auto_alloc_size
= sizeof(struct video_uc_platdata
),