[J-u-boot.git] / drivers / video / video-uclass.c

/*
 * Copyright (c) 2015 Google, Inc
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include <common.h>
#include <dm.h>
#include <mapmem.h>
#include <stdio_dev.h>
#include <video.h>
#include <video_console.h>
#include <dm/lists.h>
#include <dm/device-internal.h>
#include <dm/uclass-internal.h>
#ifdef CONFIG_SANDBOX
#include <asm/sdl.h>
#endif

/*
 * Theory of operation:
 *
 * Before relocation each device is bound. The driver for each device must
 * set the @align and @size values in struct video_uc_platdata. This
 * information represents the requires size and alignment of the frame buffer
 * for the device. The values can be an over-estimate but cannot be too
 * small. The actual values will be suppled (in the same manner) by the bind()
 * method after relocation.
 *
 * This information is then picked up by video_reserve() which works out how
 * much memory is needed for all devices. This is allocated between
 * gd->video_bottom and gd->video_top.
 *
 * After relocation the same process occurs. The driver supplies the same
 * @size and @align information and this time video_post_bind() checks that
 * the drivers does not overflow the allocated memory.
 *
 * The frame buffer address is actually set (to plat->base) in
 * video_post_probe(). This function also clears the frame buffer and
 * allocates a suitable text console device. This can then be used to write
 * text to the video device.
 */
DECLARE_GLOBAL_DATA_PTR;

void video_set_flush_dcache(struct udevice *dev, bool flush)
{
	struct video_priv *priv = dev_get_uclass_priv(dev);

	priv->flush_dcache = flush;
}

static ulong alloc_fb(struct udevice *dev, ulong *addrp)
{
	struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
	ulong base, align, size;

	align = plat->align ? plat->align : 1 << 20;
	base = *addrp - plat->size;
	base &= ~(align - 1);
	plat->base = base;
	size = *addrp - base;
	*addrp = base;

	return size;
}

int video_reserve(ulong *addrp)
{
	struct udevice *dev;
	ulong size;

	gd->video_top = *addrp;
	for (uclass_find_first_device(UCLASS_VIDEO, &dev);
	     dev;
	     uclass_find_next_device(&dev)) {
		size = alloc_fb(dev, addrp);
		debug("%s: Reserving %lx bytes at %lx for video device '%s'\n",
		      __func__, size, *addrp, dev->name);
	}
	gd->video_bottom = *addrp;
	debug("Video frame buffers from %lx to %lx\n", gd->video_bottom,
	      gd->video_top);

	return 0;
}

static int video_clear(struct udevice *dev)
{
	struct video_priv *priv = dev_get_uclass_priv(dev);

	if (priv->bpix == VIDEO_BPP32) {
		u32 *ppix = priv->fb;
		u32 *end = priv->fb + priv->fb_size;

		while (ppix < end)
			*ppix++ = priv->colour_bg;
	} else {
		memset(priv->fb, priv->colour_bg, priv->fb_size);
	}

	return 0;
}

/* Flush video activity to the caches */
void video_sync(struct udevice *vid)
{
	/*
	 * flush_dcache_range() is declared in common.h but it seems that some
	 * architectures do not actually implement it. Is there a way to find
	 * out whether it exists? For now, ARM is safe.
	 */
#if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
	struct video_priv *priv = dev_get_uclass_priv(vid);

	if (priv->flush_dcache) {
		flush_dcache_range((ulong)priv->fb,
				   (ulong)priv->fb + priv->fb_size);
	}
#elif defined(CONFIG_VIDEO_SANDBOX_SDL)
	struct video_priv *priv = dev_get_uclass_priv(vid);
	static ulong last_sync;

	if (get_timer(last_sync) > 10) {
		sandbox_sdl_sync(priv->fb);
		last_sync = get_timer(0);
	}
#endif
}

void video_sync_all(void)
{
	struct udevice *dev;

	for (uclass_find_first_device(UCLASS_VIDEO, &dev);
	     dev;
	     uclass_find_next_device(&dev)) {
		if (device_active(dev))
			video_sync(dev);
	}
}

int video_get_xsize(struct udevice *dev)
{
	struct video_priv *priv = dev_get_uclass_priv(dev);

	return priv->xsize;
}

int video_get_ysize(struct udevice *dev)
{
	struct video_priv *priv = dev_get_uclass_priv(dev);

	return priv->ysize;
}

/* Set up the colour map */
static int video_pre_probe(struct udevice *dev)
{
	struct video_priv *priv = dev_get_uclass_priv(dev);

	priv->cmap = calloc(256, sizeof(ushort));
	if (!priv->cmap)
		return -ENOMEM;

	return 0;
}

static int video_pre_remove(struct udevice *dev)
{
	struct video_priv *priv = dev_get_uclass_priv(dev);

	free(priv->cmap);

	return 0;
}

/* Set up the display ready for use */
static int video_post_probe(struct udevice *dev)
{
	struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
	struct video_priv *priv = dev_get_uclass_priv(dev);
	char name[30], drv[15], *str;
	struct udevice *cons;
	int ret;

	/* Set up the line and display size */
	priv->fb = map_sysmem(plat->base, plat->size);
	priv->line_length = priv->xsize * VNBYTES(priv->bpix);
	priv->fb_size = priv->line_length * priv->ysize;

	/* Set up colours - we could in future support other colours */
#ifdef CONFIG_SYS_WHITE_ON_BLACK
	priv->colour_fg = 0xffffff;
#else
	priv->colour_bg = 0xffffff;
#endif
	video_clear(dev);

	/*
	 * Create a text console devices. For now we always do this, although
	 * it might be useful to support only bitmap drawing on the device
	 * for boards that don't need to display text.
	 */
	snprintf(name, sizeof(name), "%s.vidconsole", dev->name);
	str = strdup(name);
	if (!str)
		return -ENOMEM;
	snprintf(drv, sizeof(drv), "vidconsole%d", priv->rot);
	ret = device_bind_driver(dev, drv, str, &cons);
	if (ret) {
		debug("%s: Cannot bind console driver\n", __func__);
		return ret;
	}
	ret = device_probe(cons);
	if (ret) {
		debug("%s: Cannot probe console driver\n", __func__);
		return ret;
	}

	return 0;
};

/* Post-relocation, allocate memory for the frame buffer */
static int video_post_bind(struct udevice *dev)
{
	ulong addr = gd->video_top;
	ulong size;

	/* Before relocation there is nothing to do here */
	if ((!gd->flags & GD_FLG_RELOC))
		return 0;
	size = alloc_fb(dev, &addr);
	if (addr < gd->video_bottom) {
		/* Device tree node may need the 'u-boot,dm-pre-reloc' tag */
		printf("Video device '%s' cannot allocate frame buffer memory -ensure the device is set up before relocation\n",
		       dev->name);
		return -ENOSPC;
	}
	debug("%s: Claiming %lx bytes at %lx for video device '%s'\n",
	      __func__, size, addr, dev->name);
	gd->video_bottom = addr;

	return 0;
}

UCLASS_DRIVER(video) = {
	.id		= UCLASS_VIDEO,
	.name		= "video",
	.flags		= DM_UC_FLAG_SEQ_ALIAS,
	.post_bind	= video_post_bind,
	.pre_probe	= video_pre_probe,
	.post_probe	= video_post_probe,
	.pre_remove	= video_pre_remove,
	.per_device_auto_alloc_size	= sizeof(struct video_priv),
	.per_device_platdata_auto_alloc_size = sizeof(struct video_uc_platdata),
};
Commit	Line	Data
1acafc73 SG	1	/*
	2	* Copyright (c) 2015 Google, Inc
	3	*
	4	* SPDX-License-Identifier: GPL-2.0+
	5	*/
	6
	7	#include <common.h>
	8	#include <dm.h>
	9	#include <mapmem.h>
	10	#include <stdio_dev.h>
	11	#include <video.h>
	12	#include <video_console.h>
	13	#include <dm/lists.h>
	14	#include <dm/device-internal.h>
	15	#include <dm/uclass-internal.h>
	16	#ifdef CONFIG_SANDBOX
	17	#include <asm/sdl.h>
	18	#endif
	19
	20	/*
	21	* Theory of operation:
	22	*
	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.
	29	*
	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.
	33	*
	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.
	37	*
	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.
	42	*/
	43	DECLARE_GLOBAL_DATA_PTR;
	44
68dcdc99 SG	45	void video_set_flush_dcache(struct udevice *dev, bool flush)
	46	{
	47	struct video_priv *priv = dev_get_uclass_priv(dev);
	48
	49	priv->flush_dcache = flush;
	50	}
	51
1acafc73 SG	52	static ulong alloc_fb(struct udevice dev, ulong addrp)
	53	{
	54	struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
	55	ulong base, align, size;
	56
	57	align = plat->align ? plat->align : 1 << 20;
	58	base = *addrp - plat->size;
	59	base &= ~(align - 1);
	60	plat->base = base;
	61	size = *addrp - base;
	62	*addrp = base;
	63
	64	return size;
	65	}
	66
	67	int video_reserve(ulong *addrp)
	68	{
	69	struct udevice *dev;
	70	ulong size;
	71
	72	gd->video_top = *addrp;
	73	for (uclass_find_first_device(UCLASS_VIDEO, &dev);
	74	dev;
	75	uclass_find_next_device(&dev)) {
	76	size = alloc_fb(dev, addrp);
	77	debug("%s: Reserving %lx bytes at %lx for video device '%s'\n",
	78	__func__, size, *addrp, dev->name);
	79	}
	80	gd->video_bottom = *addrp;
	81	debug("Video frame buffers from %lx to %lx\n", gd->video_bottom,
	82	gd->video_top);
	83
	84	return 0;
	85	}
	86
	87	static int video_clear(struct udevice *dev)
	88	{
	89	struct video_priv *priv = dev_get_uclass_priv(dev);
	90
	91	if (priv->bpix == VIDEO_BPP32) {
	92	u32 *ppix = priv->fb;
	93	u32 *end = priv->fb + priv->fb_size;
	94
	95	while (ppix < end)
	96	*ppix++ = priv->colour_bg;
	97	} else {
	98	memset(priv->fb, priv->colour_bg, priv->fb_size);
	99	}
	100
	101	return 0;
	102	}
	103
	104	/* Flush video activity to the caches */
	105	void video_sync(struct udevice *vid)
	106	{
	107	/*
	108	* flush_dcache_range() is declared in common.h but it seems that some
	109	* architectures do not actually implement it. Is there a way to find
	110	* out whether it exists? For now, ARM is safe.
	111	*/
	112	#if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
	113	struct video_priv *priv = dev_get_uclass_priv(vid);
	114
	115	if (priv->flush_dcache) {
116	flush_dcache_range((ulong)priv->fb,
117	(ulong)priv->fb + priv->fb_size);
118	}
119	#elif defined(CONFIG_VIDEO_SANDBOX_SDL)
120	struct video_priv *priv = dev_get_uclass_priv(vid);
121	static ulong last_sync;
122
123	if (get_timer(last_sync) > 10) {
124	sandbox_sdl_sync(priv->fb);
125	last_sync = get_timer(0);
126	}
127	#endif
128	}
129
130	void video_sync_all(void)
131	{
132	struct udevice *dev;
133
134	for (uclass_find_first_device(UCLASS_VIDEO, &dev);
135	dev;
136	uclass_find_next_device(&dev)) {
137	if (device_active(dev))
138	video_sync(dev);
139	}
140	}
141
142	int video_get_xsize(struct udevice *dev)
143	{
144	struct video_priv *priv = dev_get_uclass_priv(dev);
145
146	return priv->xsize;
147	}
148
149	int video_get_ysize(struct udevice *dev)
150	{
151	struct video_priv *priv = dev_get_uclass_priv(dev);
152
153	return priv->ysize;
154	}
155
156	/* Set up the colour map */
157	static int video_pre_probe(struct udevice *dev)
158	{
159	struct video_priv *priv = dev_get_uclass_priv(dev);
160
161	priv->cmap = calloc(256, sizeof(ushort));
162	if (!priv->cmap)
163	return -ENOMEM;
164
165	return 0;
166	}
167
168	static int video_pre_remove(struct udevice *dev)
169	{
170	struct video_priv *priv = dev_get_uclass_priv(dev);
171
172	free(priv->cmap);
173
174	return 0;
175	}
176
177	/* Set up the display ready for use */
178	static int video_post_probe(struct udevice *dev)
179	{
180	struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
181	struct video_priv *priv = dev_get_uclass_priv(dev);
182	char name[30], drv[15], *str;
183	struct udevice *cons;
184	int ret;
185
186	/* Set up the line and display size */
187	priv->fb = map_sysmem(plat->base, plat->size);
188	priv->line_length = priv->xsize * VNBYTES(priv->bpix);
189	priv->fb_size = priv->line_length * priv->ysize;
190
191	/* Set up colours - we could in future support other colours */
192	#ifdef CONFIG_SYS_WHITE_ON_BLACK
193	priv->colour_fg = 0xffffff;
194	#else
195	priv->colour_bg = 0xffffff;
196	#endif
197	video_clear(dev);
198
83510766 SG	199	/*
	200	* Create a text console devices. For now we always do this, although
	201	* it might be useful to support only bitmap drawing on the device
	202	* for boards that don't need to display text.
	203	*/
	204	snprintf(name, sizeof(name), "%s.vidconsole", dev->name);
	205	str = strdup(name);
	206	if (!str)
	207	return -ENOMEM;
	208	snprintf(drv, sizeof(drv), "vidconsole%d", priv->rot);
	209	ret = device_bind_driver(dev, drv, str, &cons);
	210	if (ret) {
	211	debug("%s: Cannot bind console driver\n", __func__);
	212	return ret;
	213	}
	214	ret = device_probe(cons);
	215	if (ret) {
	216	debug("%s: Cannot probe console driver\n", __func__);
	217	return ret;
	218	}
	219
1acafc73 SG	220	return 0;
	221	};
	222
	223	/* Post-relocation, allocate memory for the frame buffer */
	224	static int video_post_bind(struct udevice *dev)
	225	{
	226	ulong addr = gd->video_top;
	227	ulong size;
	228
	229	/* Before relocation there is nothing to do here */
	230	if ((!gd->flags & GD_FLG_RELOC))
	231	return 0;
	232	size = alloc_fb(dev, &addr);
	233	if (addr < gd->video_bottom) {
	234	/* Device tree node may need the 'u-boot,dm-pre-reloc' tag */
	235	printf("Video device '%s' cannot allocate frame buffer memory -ensure the device is set up before relocation\n",
	236	dev->name);
	237	return -ENOSPC;
	238	}
	239	debug("%s: Claiming %lx bytes at %lx for video device '%s'\n",
	240	__func__, size, addr, dev->name);
	241	gd->video_bottom = addr;
	242
	243	return 0;
	244	}
	245
	246	UCLASS_DRIVER(video) = {
	247	.id = UCLASS_VIDEO,
	248	.name = "video",
	249	.flags = DM_UC_FLAG_SEQ_ALIAS,
	250	.post_bind = video_post_bind,
	251	.pre_probe = video_pre_probe,
	252	.post_probe = video_post_probe,
	253	.pre_remove = video_pre_remove,
	254	.per_device_auto_alloc_size = sizeof(struct video_priv),
	255	.per_device_platdata_auto_alloc_size = sizeof(struct video_uc_platdata),
	256	};