[mirror_ubuntu-bionic-kernel.git] / drivers / video / of_display_timing.c

/*
 * OF helpers for parsing display timings
 *
 * Copyright (c) 2012 Steffen Trumtrar <s.trumtrar@pengutronix.de>, Pengutronix
 *
 * based on of_videomode.c by Sascha Hauer <s.hauer@pengutronix.de>
 *
 * This file is released under the GPLv2
 */
#include <linux/export.h>
#include <linux/of.h>
#include <linux/slab.h>
#include <video/display_timing.h>
#include <video/of_display_timing.h>

/**
 * parse_timing_property - parse timing_entry from device_node
 * @np: device_node with the property
 * @name: name of the property
 * @result: will be set to the return value
 *
 * DESCRIPTION:
 * Every display_timing can be specified with either just the typical value or
 * a range consisting of min/typ/max. This function helps handling this
 **/
static int parse_timing_property(const struct device_node *np, const char *name,
			  struct timing_entry *result)
{
	struct property *prop;
	int length, cells, ret;

	prop = of_find_property(np, name, &length);
	if (!prop) {
		pr_err("%pOF: could not find property %s\n", np, name);
		return -EINVAL;
	}

	cells = length / sizeof(u32);
	if (cells == 1) {
		ret = of_property_read_u32(np, name, &result->typ);
		result->min = result->typ;
		result->max = result->typ;
	} else if (cells == 3) {
		ret = of_property_read_u32_array(np, name, &result->min, cells);
	} else {
		pr_err("%pOF: illegal timing specification in %s\n", np, name);
		return -EINVAL;
	}

	return ret;
}

/**
 * of_parse_display_timing - parse display_timing entry from device_node
 * @np: device_node with the properties
 **/
static int of_parse_display_timing(const struct device_node *np,
		struct display_timing *dt)
{
	u32 val = 0;
	int ret = 0;

	memset(dt, 0, sizeof(*dt));

	ret |= parse_timing_property(np, "hback-porch", &dt->hback_porch);
	ret |= parse_timing_property(np, "hfront-porch", &dt->hfront_porch);
	ret |= parse_timing_property(np, "hactive", &dt->hactive);
	ret |= parse_timing_property(np, "hsync-len", &dt->hsync_len);
	ret |= parse_timing_property(np, "vback-porch", &dt->vback_porch);
	ret |= parse_timing_property(np, "vfront-porch", &dt->vfront_porch);
	ret |= parse_timing_property(np, "vactive", &dt->vactive);
	ret |= parse_timing_property(np, "vsync-len", &dt->vsync_len);
	ret |= parse_timing_property(np, "clock-frequency", &dt->pixelclock);

	dt->flags = 0;
	if (!of_property_read_u32(np, "vsync-active", &val))
		dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
				DISPLAY_FLAGS_VSYNC_LOW;
	if (!of_property_read_u32(np, "hsync-active", &val))
		dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
				DISPLAY_FLAGS_HSYNC_LOW;
	if (!of_property_read_u32(np, "de-active", &val))
		dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
				DISPLAY_FLAGS_DE_LOW;
	if (!of_property_read_u32(np, "pixelclk-active", &val))
		dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
				DISPLAY_FLAGS_PIXDATA_NEGEDGE;

	if (!of_property_read_u32(np, "syncclk-active", &val))
		dt->flags |= val ? DISPLAY_FLAGS_SYNC_POSEDGE :
				DISPLAY_FLAGS_SYNC_NEGEDGE;
	else if (dt->flags & (DISPLAY_FLAGS_PIXDATA_POSEDGE |
			      DISPLAY_FLAGS_PIXDATA_NEGEDGE))
		dt->flags |= dt->flags & DISPLAY_FLAGS_PIXDATA_POSEDGE ?
				DISPLAY_FLAGS_SYNC_POSEDGE :
				DISPLAY_FLAGS_SYNC_NEGEDGE;

	if (of_property_read_bool(np, "interlaced"))
		dt->flags |= DISPLAY_FLAGS_INTERLACED;
	if (of_property_read_bool(np, "doublescan"))
		dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
	if (of_property_read_bool(np, "doubleclk"))
		dt->flags |= DISPLAY_FLAGS_DOUBLECLK;

	if (ret) {
		pr_err("%pOF: error reading timing properties\n", np);
		return -EINVAL;
	}

	return 0;
}

/**
 * of_get_display_timing - parse a display_timing entry
 * @np: device_node with the timing subnode
 * @name: name of the timing node
 * @dt: display_timing struct to fill
 **/
int of_get_display_timing(const struct device_node *np, const char *name,
		struct display_timing *dt)
{
	struct device_node *timing_np;

	if (!np)
		return -EINVAL;

	timing_np = of_get_child_by_name(np, name);
	if (!timing_np) {
		pr_err("%pOF: could not find node '%s'\n", np, name);
		return -ENOENT;
	}

	return of_parse_display_timing(timing_np, dt);
}
EXPORT_SYMBOL_GPL(of_get_display_timing);

/**
 * of_get_display_timings - parse all display_timing entries from a device_node
 * @np: device_node with the subnodes
 **/
struct display_timings *of_get_display_timings(const struct device_node *np)
{
	struct device_node *timings_np;
	struct device_node *entry;
	struct device_node *native_mode;
	struct display_timings *disp;

	if (!np)
		return NULL;

	timings_np = of_get_child_by_name(np, "display-timings");
	if (!timings_np) {
		pr_err("%pOF: could not find display-timings node\n", np);
		return NULL;
	}

	disp = kzalloc(sizeof(*disp), GFP_KERNEL);
	if (!disp) {
		pr_err("%pOF: could not allocate struct disp'\n", np);
		goto dispfail;
	}

	entry = of_parse_phandle(timings_np, "native-mode", 0);
	/* assume first child as native mode if none provided */
	if (!entry)
		entry = of_get_next_child(timings_np, NULL);
	/* if there is no child, it is useless to go on */
	if (!entry) {
		pr_err("%pOF: no timing specifications given\n", np);
		goto entryfail;
	}

	pr_debug("%pOF: using %s as default timing\n", np, entry->name);

	native_mode = entry;

	disp->num_timings = of_get_child_count(timings_np);
	if (disp->num_timings == 0) {
		/* should never happen, as entry was already found above */
		pr_err("%pOF: no timings specified\n", np);
		goto entryfail;
	}

	disp->timings = kzalloc(sizeof(struct display_timing *) *
				disp->num_timings, GFP_KERNEL);
	if (!disp->timings) {
		pr_err("%pOF: could not allocate timings array\n", np);
		goto entryfail;
	}

	disp->num_timings = 0;
	disp->native_mode = 0;

	for_each_child_of_node(timings_np, entry) {
		struct display_timing *dt;
		int r;

		dt = kzalloc(sizeof(*dt), GFP_KERNEL);
		if (!dt) {
			pr_err("%pOF: could not allocate display_timing struct\n",
				np);
			goto timingfail;
		}

		r = of_parse_display_timing(entry, dt);
		if (r) {
			/*
			 * to not encourage wrong devicetrees, fail in case of
			 * an error
			 */
			pr_err("%pOF: error in timing %d\n",
				np, disp->num_timings + 1);
			kfree(dt);
			goto timingfail;
		}

		if (native_mode == entry)
			disp->native_mode = disp->num_timings;

		disp->timings[disp->num_timings] = dt;
		disp->num_timings++;
	}
	of_node_put(timings_np);
	/*
	 * native_mode points to the device_node returned by of_parse_phandle
	 * therefore call of_node_put on it
	 */
	of_node_put(native_mode);

	pr_debug("%pOF: got %d timings. Using timing #%d as default\n",
		np, disp->num_timings,
		disp->native_mode + 1);

	return disp;

timingfail:
	of_node_put(native_mode);
	display_timings_release(disp);
	disp = NULL;
entryfail:
	kfree(disp);
dispfail:
	of_node_put(timings_np);
	return NULL;
}
EXPORT_SYMBOL_GPL(of_get_display_timings);

/**
 * of_display_timings_exist - check if a display-timings node is provided
 * @np: device_node with the timing
 **/
int of_display_timings_exist(const struct device_node *np)
{
	struct device_node *timings_np;

	if (!np)
		return -EINVAL;

	timings_np = of_parse_phandle(np, "display-timings", 0);
	if (!timings_np)
		return -EINVAL;

	of_node_put(timings_np);
	return 1;
}
EXPORT_SYMBOL_GPL(of_display_timings_exist);
Commit	Line	Data
cc3f414c ST	1	/*
	2	* OF helpers for parsing display timings
	3	*
	4	* Copyright (c) 2012 Steffen Trumtrar <s.trumtrar@pengutronix.de>, Pengutronix
	5	*
	6	* based on of_videomode.c by Sascha Hauer <s.hauer@pengutronix.de>
	7	*
	8	* This file is released under the GPLv2
	9	*/
	10	#include <linux/export.h>
	11	#include <linux/of.h>
	12	#include <linux/slab.h>
	13	#include <video/display_timing.h>
	14	#include <video/of_display_timing.h>
	15
	16	/**
	17	* parse_timing_property - parse timing_entry from device_node
	18	* @np: device_node with the property
	19	* @name: name of the property
	20	* @result: will be set to the return value
	21	*
	22	* DESCRIPTION:
	23	* Every display_timing can be specified with either just the typical value or
	24	* a range consisting of min/typ/max. This function helps handling this
	25	**/
f5836623	26	static int parse_timing_property(const struct device_node np, const char name,
cc3f414c ST	27	struct timing_entry *result)
	28	{
	29	struct property *prop;
	30	int length, cells, ret;
	31
	32	prop = of_find_property(np, name, &length);
	33	if (!prop) {
6d7e6533	34	pr_err("%pOF: could not find property %s\n", np, name);
cc3f414c ST	35	return -EINVAL;
	36	}
	37
	38	cells = length / sizeof(u32);
	39	if (cells == 1) {
	40	ret = of_property_read_u32(np, name, &result->typ);
	41	result->min = result->typ;
	42	result->max = result->typ;
	43	} else if (cells == 3) {
	44	ret = of_property_read_u32_array(np, name, &result->min, cells);
	45	} else {
6d7e6533	46	pr_err("%pOF: illegal timing specification in %s\n", np, name);
cc3f414c ST	47	return -EINVAL;
	48	}
	49
	50	return ret;
	51	}
	52
	53	/**
ffa3fd21	54	* of_parse_display_timing - parse display_timing entry from device_node
cc3f414c ST	55	* @np: device_node with the properties
cc3f414c ST	56	**/
2e17c5a9	57	static int of_parse_display_timing(const struct device_node *np,
fcf7e6e5	58	struct display_timing *dt)
cc3f414c	59	{
cc3f414c ST	60	u32 val = 0;
	61	int ret = 0;
	62
fcf7e6e5	63	memset(dt, 0, sizeof(*dt));
cc3f414c ST	64
	65	ret \|= parse_timing_property(np, "hback-porch", &dt->hback_porch);
	66	ret \|= parse_timing_property(np, "hfront-porch", &dt->hfront_porch);
	67	ret \|= parse_timing_property(np, "hactive", &dt->hactive);
	68	ret \|= parse_timing_property(np, "hsync-len", &dt->hsync_len);
	69	ret \|= parse_timing_property(np, "vback-porch", &dt->vback_porch);
	70	ret \|= parse_timing_property(np, "vfront-porch", &dt->vfront_porch);
	71	ret \|= parse_timing_property(np, "vactive", &dt->vactive);
	72	ret \|= parse_timing_property(np, "vsync-len", &dt->vsync_len);
	73	ret \|= parse_timing_property(np, "clock-frequency", &dt->pixelclock);
	74
06a33079	75	dt->flags = 0;
cc3f414c	76	if (!of_property_read_u32(np, "vsync-active", &val))
06a33079 TV	77	dt->flags \|= val ? DISPLAY_FLAGS_VSYNC_HIGH :
06a33079 TV	78	DISPLAY_FLAGS_VSYNC_LOW;
cc3f414c	79	if (!of_property_read_u32(np, "hsync-active", &val))
06a33079 TV	80	dt->flags \|= val ? DISPLAY_FLAGS_HSYNC_HIGH :
06a33079 TV	81	DISPLAY_FLAGS_HSYNC_LOW;
cc3f414c	82	if (!of_property_read_u32(np, "de-active", &val))
06a33079	83	dt->flags \|= val ? DISPLAY_FLAGS_DE_HIGH :
cc3f414c ST	84	DISPLAY_FLAGS_DE_LOW;
cc3f414c ST	85	if (!of_property_read_u32(np, "pixelclk-active", &val))
06a33079	86	dt->flags \|= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
cc3f414c ST	87	DISPLAY_FLAGS_PIXDATA_NEGEDGE;
cc3f414c ST	88
bd9642b9 PU	89	if (!of_property_read_u32(np, "syncclk-active", &val))
	90	dt->flags \|= val ? DISPLAY_FLAGS_SYNC_POSEDGE :
	91	DISPLAY_FLAGS_SYNC_NEGEDGE;
	92	else if (dt->flags & (DISPLAY_FLAGS_PIXDATA_POSEDGE \|
	93	DISPLAY_FLAGS_PIXDATA_NEGEDGE))
	94	dt->flags \|= dt->flags & DISPLAY_FLAGS_PIXDATA_POSEDGE ?
	95	DISPLAY_FLAGS_SYNC_POSEDGE :
	96	DISPLAY_FLAGS_SYNC_NEGEDGE;
	97
cc3f414c	98	if (of_property_read_bool(np, "interlaced"))
06a33079	99	dt->flags \|= DISPLAY_FLAGS_INTERLACED;
cc3f414c	100	if (of_property_read_bool(np, "doublescan"))
06a33079	101	dt->flags \|= DISPLAY_FLAGS_DOUBLESCAN;
2d178a4a ST	102	if (of_property_read_bool(np, "doubleclk"))
2d178a4a ST	103	dt->flags \|= DISPLAY_FLAGS_DOUBLECLK;
cc3f414c ST	104
cc3f414c ST	105	if (ret) {
6d7e6533	106	pr_err("%pOF: error reading timing properties\n", np);
fcf7e6e5	107	return -EINVAL;
cc3f414c ST	108	}
cc3f414c ST	109
fcf7e6e5	110	return 0;
cc3f414c ST	111	}
cc3f414c ST	112
ffa3fd21 TV	113	/**
	114	* of_get_display_timing - parse a display_timing entry
	115	* @np: device_node with the timing subnode
	116	* @name: name of the timing node
	117	* @dt: display_timing struct to fill
	118	**/
f5a000c9	119	int of_get_display_timing(const struct device_node np, const char name,
ffa3fd21 TV	120	struct display_timing *dt)
	121	{
	122	struct device_node *timing_np;
	123
dc42715f	124	if (!np)
ffa3fd21	125	return -EINVAL;
ffa3fd21	126
60119a1d	127	timing_np = of_get_child_by_name(np, name);
ffa3fd21	128	if (!timing_np) {
6d7e6533	129	pr_err("%pOF: could not find node '%s'\n", np, name);
ffa3fd21 TV	130	return -ENOENT;
	131	}
	132
	133	return of_parse_display_timing(timing_np, dt);
	134	}
	135	EXPORT_SYMBOL_GPL(of_get_display_timing);
	136
cc3f414c ST	137	/**
	138	* of_get_display_timings - parse all display_timing entries from a device_node
	139	* @np: device_node with the subnodes
	140	**/
f5a000c9	141	struct display_timings of_get_display_timings(const struct device_node np)
cc3f414c ST	142	{
	143	struct device_node *timings_np;
	144	struct device_node *entry;
	145	struct device_node *native_mode;
	146	struct display_timings *disp;
	147
dc42715f	148	if (!np)
cc3f414c	149	return NULL;
cc3f414c	150
60119a1d	151	timings_np = of_get_child_by_name(np, "display-timings");
cc3f414c	152	if (!timings_np) {
6d7e6533	153	pr_err("%pOF: could not find display-timings node\n", np);
cc3f414c ST	154	return NULL;
	155	}
	156
	157	disp = kzalloc(sizeof(*disp), GFP_KERNEL);
	158	if (!disp) {
6d7e6533	159	pr_err("%pOF: could not allocate struct disp'\n", np);
cc3f414c ST	160	goto dispfail;
	161	}
	162
	163	entry = of_parse_phandle(timings_np, "native-mode", 0);
	164	/* assume first child as native mode if none provided */
	165	if (!entry)
80c68c1e	166	entry = of_get_next_child(timings_np, NULL);
cc3f414c ST	167	/* if there is no child, it is useless to go on */
cc3f414c ST	168	if (!entry) {
6d7e6533	169	pr_err("%pOF: no timing specifications given\n", np);
cc3f414c ST	170	goto entryfail;
	171	}
	172
6d7e6533	173	pr_debug("%pOF: using %s as default timing\n", np, entry->name);
cc3f414c ST	174
	175	native_mode = entry;
	176
	177	disp->num_timings = of_get_child_count(timings_np);
	178	if (disp->num_timings == 0) {
	179	/* should never happen, as entry was already found above */
6d7e6533	180	pr_err("%pOF: no timings specified\n", np);
cc3f414c ST	181	goto entryfail;
	182	}
	183
	184	disp->timings = kzalloc(sizeof(struct display_timing )
	185	disp->num_timings, GFP_KERNEL);
	186	if (!disp->timings) {
6d7e6533	187	pr_err("%pOF: could not allocate timings array\n", np);
cc3f414c ST	188	goto entryfail;
	189	}
	190
	191	disp->num_timings = 0;
	192	disp->native_mode = 0;
	193
	194	for_each_child_of_node(timings_np, entry) {
	195	struct display_timing *dt;
fcf7e6e5	196	int r;
cc3f414c	197
fcf7e6e5	198	dt = kzalloc(sizeof(*dt), GFP_KERNEL);
cc3f414c	199	if (!dt) {
6d7e6533 RH	200	pr_err("%pOF: could not allocate display_timing struct\n",
6d7e6533 RH	201	np);
fcf7e6e5 TV	202	goto timingfail;
	203	}
	204
ffa3fd21	205	r = of_parse_display_timing(entry, dt);
fcf7e6e5	206	if (r) {
cc3f414c ST	207	/*
	208	* to not encourage wrong devicetrees, fail in case of
	209	* an error
	210	*/
6d7e6533 RH	211	pr_err("%pOF: error in timing %d\n",
6d7e6533 RH	212	np, disp->num_timings + 1);
d663baba	213	kfree(dt);
cc3f414c ST	214	goto timingfail;
	215	}
	216
	217	if (native_mode == entry)
	218	disp->native_mode = disp->num_timings;
	219
	220	disp->timings[disp->num_timings] = dt;
	221	disp->num_timings++;
	222	}
	223	of_node_put(timings_np);
	224	/*
	225	* native_mode points to the device_node returned by of_parse_phandle
	226	* therefore call of_node_put on it
	227	*/
	228	of_node_put(native_mode);
	229
6d7e6533 RH	230	pr_debug("%pOF: got %d timings. Using timing #%d as default\n",
6d7e6533 RH	231	np, disp->num_timings,
cc3f414c ST	232	disp->native_mode + 1);
	233
	234	return disp;
	235
	236	timingfail:
68ecfe2f	237	of_node_put(native_mode);
cc3f414c	238	display_timings_release(disp);
62795a0d	239	disp = NULL;
cc3f414c ST	240	entryfail:
	241	kfree(disp);
	242	dispfail:
	243	of_node_put(timings_np);
	244	return NULL;
	245	}
	246	EXPORT_SYMBOL_GPL(of_get_display_timings);
	247
	248	/**
	249	* of_display_timings_exist - check if a display-timings node is provided
	250	* @np: device_node with the timing
	251	**/
f5a000c9	252	int of_display_timings_exist(const struct device_node *np)
cc3f414c ST	253	{
	254	struct device_node *timings_np;
	255
	256	if (!np)
	257	return -EINVAL;
	258
	259	timings_np = of_parse_phandle(np, "display-timings", 0);
	260	if (!timings_np)
	261	return -EINVAL;
	262
	263	of_node_put(timings_np);
	264	return 1;
	265	}
	266	EXPORT_SYMBOL_GPL(of_display_timings_exist);