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
);
94 if (priv
->bpix
== VIDEO_BPP32
) {
96 u32
*end
= priv
->fb
+ priv
->fb_size
;
99 *ppix
++ = priv
->colour_bg
;
101 memset(priv
->fb
, priv
->colour_bg
, priv
->fb_size
);
105 /* Flush video activity to the caches */
106 void video_sync(struct udevice
*vid
)
109 * flush_dcache_range() is declared in common.h but it seems that some
110 * architectures do not actually implement it. Is there a way to find
111 * out whether it exists? For now, ARM is safe.
113 #if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
114 struct video_priv
*priv
= dev_get_uclass_priv(vid
);
116 if (priv
->flush_dcache
) {
117 flush_dcache_range((ulong
)priv
->fb
,
118 ALIGN((ulong
)priv
->fb
+ priv
->fb_size
,
119 CONFIG_SYS_CACHELINE_SIZE
));
121 #elif defined(CONFIG_VIDEO_SANDBOX_SDL)
122 struct video_priv
*priv
= dev_get_uclass_priv(vid
);
123 static ulong last_sync
;
125 if (get_timer(last_sync
) > 10) {
126 sandbox_sdl_sync(priv
->fb
);
127 last_sync
= get_timer(0);
132 void video_sync_all(void)
136 for (uclass_find_first_device(UCLASS_VIDEO
, &dev
);
138 uclass_find_next_device(&dev
)) {
139 if (device_active(dev
))
144 int video_get_xsize(struct udevice
*dev
)
146 struct video_priv
*priv
= dev_get_uclass_priv(dev
);
151 int video_get_ysize(struct udevice
*dev
)
153 struct video_priv
*priv
= dev_get_uclass_priv(dev
);
158 /* Set up the colour map */
159 static int video_pre_probe(struct udevice
*dev
)
161 struct video_priv
*priv
= dev_get_uclass_priv(dev
);
163 priv
->cmap
= calloc(256, sizeof(ushort
));
170 static int video_pre_remove(struct udevice
*dev
)
172 struct video_priv
*priv
= dev_get_uclass_priv(dev
);
179 /* Set up the display ready for use */
180 static int video_post_probe(struct udevice
*dev
)
182 struct video_uc_platdata
*plat
= dev_get_uclass_platdata(dev
);
183 struct video_priv
*priv
= dev_get_uclass_priv(dev
);
184 char name
[30], drv
[15], *str
;
185 const char *drv_name
= drv
;
186 struct udevice
*cons
;
189 /* Set up the line and display size */
190 priv
->fb
= map_sysmem(plat
->base
, plat
->size
);
191 priv
->line_length
= priv
->xsize
* VNBYTES(priv
->bpix
);
192 priv
->fb_size
= priv
->line_length
* priv
->ysize
;
194 /* Set up colours - we could in future support other colours */
195 #ifdef CONFIG_SYS_WHITE_ON_BLACK
196 priv
->colour_fg
= 0xffffff;
198 priv
->colour_bg
= 0xffffff;
201 if (!CONFIG_IS_ENABLED(NO_FB_CLEAR
))
205 * Create a text console device. For now we always do this, although
206 * it might be useful to support only bitmap drawing on the device
207 * for boards that don't need to display text. We create a TrueType
208 * console if enabled, a rotated console if the video driver requests
209 * it, otherwise a normal console.
211 * The console can be override by setting vidconsole_drv_name before
212 * probing this video driver, or in the probe() method.
214 * TrueType does not support rotation at present so fall back to the
215 * rotated console in that case.
217 if (!priv
->rot
&& IS_ENABLED(CONFIG_CONSOLE_TRUETYPE
)) {
218 snprintf(name
, sizeof(name
), "%s.vidconsole_tt", dev
->name
);
219 strcpy(drv
, "vidconsole_tt");
221 snprintf(name
, sizeof(name
), "%s.vidconsole%d", dev
->name
,
223 snprintf(drv
, sizeof(drv
), "vidconsole%d", priv
->rot
);
229 if (priv
->vidconsole_drv_name
)
230 drv_name
= priv
->vidconsole_drv_name
;
231 ret
= device_bind_driver(dev
, drv_name
, str
, &cons
);
233 debug("%s: Cannot bind console driver\n", __func__
);
237 ret
= device_probe(cons
);
239 debug("%s: Cannot probe console driver\n", __func__
);
246 /* Post-relocation, allocate memory for the frame buffer */
247 static int video_post_bind(struct udevice
*dev
)
249 ulong addr
= gd
->video_top
;
252 /* Before relocation there is nothing to do here */
253 if ((!gd
->flags
& GD_FLG_RELOC
))
255 size
= alloc_fb(dev
, &addr
);
256 if (addr
< gd
->video_bottom
) {
257 /* Device tree node may need the 'u-boot,dm-pre-reloc' tag */
258 printf("Video device '%s' cannot allocate frame buffer memory -ensure the device is set up before relocation\n",
262 debug("%s: Claiming %lx bytes at %lx for video device '%s'\n",
263 __func__
, size
, addr
, dev
->name
);
264 gd
->video_bottom
= addr
;
269 UCLASS_DRIVER(video
) = {
272 .flags
= DM_UC_FLAG_SEQ_ALIAS
,
273 .post_bind
= video_post_bind
,
274 .pre_probe
= video_pre_probe
,
275 .post_probe
= video_post_probe
,
276 .pre_remove
= video_pre_remove
,
277 .per_device_auto_alloc_size
= sizeof(struct video_priv
),
278 .per_device_platdata_auto_alloc_size
= sizeof(struct video_uc_platdata
),