[linux-2.6-block.git] / drivers / mfd / syscon.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * System Control Driver
 *
 * Copyright (C) 2012 Freescale Semiconductor, Inc.
 * Copyright (C) 2012 Linaro Ltd.
 *
 * Author: Dong Aisheng <dong.aisheng@linaro.org>
 */

#include <linux/clk.h>
#include <linux/err.h>
#include <linux/hwspinlock.h>
#include <linux/io.h>
#include <linux/init.h>
#include <linux/list.h>
#include <linux/of.h>
#include <linux/of_address.h>
#include <linux/of_platform.h>
#include <linux/platform_data/syscon.h>
#include <linux/platform_device.h>
#include <linux/regmap.h>
#include <linux/mfd/syscon.h>
#include <linux/slab.h>

static struct platform_driver syscon_driver;

static DEFINE_SPINLOCK(syscon_list_slock);
static LIST_HEAD(syscon_list);

struct syscon {
	struct device_node *np;
	struct regmap *regmap;
	struct list_head list;
};

static const struct regmap_config syscon_regmap_config = {
	.reg_bits = 32,
	.val_bits = 32,
	.reg_stride = 4,
};

static struct syscon *of_syscon_register(struct device_node *np)
{
	struct clk *clk;
	struct syscon *syscon;
	struct regmap *regmap;
	void __iomem *base;
	u32 reg_io_width;
	int ret;
	struct regmap_config syscon_config = syscon_regmap_config;
	struct resource res;

	if (!of_device_is_compatible(np, "syscon"))
		return ERR_PTR(-EINVAL);

	syscon = kzalloc(sizeof(*syscon), GFP_KERNEL);
	if (!syscon)
		return ERR_PTR(-ENOMEM);

	if (of_address_to_resource(np, 0, &res)) {
		ret = -ENOMEM;
		goto err_map;
	}

	base = ioremap(res.start, resource_size(&res));
	if (!base) {
		ret = -ENOMEM;
		goto err_map;
	}

	/* Parse the device's DT node for an endianness specification */
	if (of_property_read_bool(np, "big-endian"))
		syscon_config.val_format_endian = REGMAP_ENDIAN_BIG;
	else if (of_property_read_bool(np, "little-endian"))
		syscon_config.val_format_endian = REGMAP_ENDIAN_LITTLE;
	else if (of_property_read_bool(np, "native-endian"))
		syscon_config.val_format_endian = REGMAP_ENDIAN_NATIVE;

	/*
	 * search for reg-io-width property in DT. If it is not provided,
	 * default to 4 bytes. regmap_init_mmio will return an error if values
	 * are invalid so there is no need to check them here.
	 */
	ret = of_property_read_u32(np, "reg-io-width", &reg_io_width);
	if (ret)
		reg_io_width = 4;

	ret = of_hwspin_lock_get_id(np, 0);
	if (ret > 0 || (IS_ENABLED(CONFIG_HWSPINLOCK) && ret == 0)) {
		syscon_config.use_hwlock = true;
		syscon_config.hwlock_id = ret;
		syscon_config.hwlock_mode = HWLOCK_IRQSTATE;
	} else if (ret < 0) {
		switch (ret) {
		case -ENOENT:
			/* Ignore missing hwlock, it's optional. */
			break;
		default:
			pr_err("Failed to retrieve valid hwlock: %d\n", ret);
			/* fall-through */
		case -EPROBE_DEFER:
			goto err_regmap;
		}
	}

	syscon_config.name = of_node_full_name(np);
	syscon_config.reg_stride = reg_io_width;
	syscon_config.val_bits = reg_io_width * 8;
	syscon_config.max_register = resource_size(&res) - reg_io_width;
	syscon_config.name = of_node_full_name(np);

	regmap = regmap_init_mmio(NULL, base, &syscon_config);
	if (IS_ERR(regmap)) {
		pr_err("regmap init failed\n");
		ret = PTR_ERR(regmap);
		goto err_regmap;
	}

	clk = of_clk_get(np, 0);
	if (IS_ERR(clk)) {
		ret = PTR_ERR(clk);
		/* clock is optional */
		if (ret != -ENOENT)
			goto err_clk;
	} else {
		ret = regmap_mmio_attach_clk(regmap, clk);
		if (ret)
			goto err_attach;
	}

	syscon->regmap = regmap;
	syscon->np = np;

	spin_lock(&syscon_list_slock);
	list_add_tail(&syscon->list, &syscon_list);
	spin_unlock(&syscon_list_slock);

	return syscon;

err_attach:
	if (!IS_ERR(clk))
		clk_put(clk);
err_clk:
	regmap_exit(regmap);
err_regmap:
	iounmap(base);
err_map:
	kfree(syscon);
	return ERR_PTR(ret);
}

struct regmap *syscon_node_to_regmap(struct device_node *np)
{
	struct syscon *entry, *syscon = NULL;

	spin_lock(&syscon_list_slock);

	list_for_each_entry(entry, &syscon_list, list)
		if (entry->np == np) {
			syscon = entry;
			break;
		}

	spin_unlock(&syscon_list_slock);

	if (!syscon)
		syscon = of_syscon_register(np);

	if (IS_ERR(syscon))
		return ERR_CAST(syscon);

	return syscon->regmap;
}
EXPORT_SYMBOL_GPL(syscon_node_to_regmap);

struct regmap *syscon_regmap_lookup_by_compatible(const char *s)
{
	struct device_node *syscon_np;
	struct regmap *regmap;

	syscon_np = of_find_compatible_node(NULL, NULL, s);
	if (!syscon_np)
		return ERR_PTR(-ENODEV);

	regmap = syscon_node_to_regmap(syscon_np);
	of_node_put(syscon_np);

	return regmap;
}
EXPORT_SYMBOL_GPL(syscon_regmap_lookup_by_compatible);

struct regmap *syscon_regmap_lookup_by_phandle(struct device_node *np,
					const char *property)
{
	struct device_node *syscon_np;
	struct regmap *regmap;

	if (property)
		syscon_np = of_parse_phandle(np, property, 0);
	else
		syscon_np = np;

	if (!syscon_np)
		return ERR_PTR(-ENODEV);

	regmap = syscon_node_to_regmap(syscon_np);
	of_node_put(syscon_np);

	return regmap;
}
EXPORT_SYMBOL_GPL(syscon_regmap_lookup_by_phandle);

static int syscon_probe(struct platform_device *pdev)
{
	struct device *dev = &pdev->dev;
	struct syscon_platform_data *pdata = dev_get_platdata(dev);
	struct syscon *syscon;
	struct regmap_config syscon_config = syscon_regmap_config;
	struct resource *res;
	void __iomem *base;

	syscon = devm_kzalloc(dev, sizeof(*syscon), GFP_KERNEL);
	if (!syscon)
		return -ENOMEM;

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!res)
		return -ENOENT;

	base = devm_ioremap(dev, res->start, resource_size(res));
	if (!base)
		return -ENOMEM;

	syscon_config.max_register = res->end - res->start - 3;
	if (pdata)
		syscon_config.name = pdata->label;
	syscon->regmap = devm_regmap_init_mmio(dev, base, &syscon_config);
	if (IS_ERR(syscon->regmap)) {
		dev_err(dev, "regmap init failed\n");
		return PTR_ERR(syscon->regmap);
	}

	platform_set_drvdata(pdev, syscon);

	dev_dbg(dev, "regmap %pR registered\n", res);

	return 0;
}

static const struct platform_device_id syscon_ids[] = {
	{ "syscon", },
	{ }
};

static struct platform_driver syscon_driver = {
	.driver = {
		.name = "syscon",
	},
	.probe		= syscon_probe,
	.id_table	= syscon_ids,
};

static int __init syscon_init(void)
{
	return platform_driver_register(&syscon_driver);
}
postcore_initcall(syscon_init);
Commit	Line	Data
2874c5fd	1	// SPDX-License-Identifier: GPL-2.0-or-later
87d68730 DA	2	/*
	3	* System Control Driver
	4	*
	5	* Copyright (C) 2012 Freescale Semiconductor, Inc.
	6	* Copyright (C) 2012 Linaro Ltd.
	7	*
	8	* Author: Dong Aisheng <dong.aisheng@linaro.org>
87d68730 DA	9	*/
87d68730 DA	10
a00406b7	11	#include <linux/clk.h>
87d68730	12	#include <linux/err.h>
3bafc09e	13	#include <linux/hwspinlock.h>
87d68730	14	#include <linux/io.h>
1345da73	15	#include <linux/init.h>
bdb0066d	16	#include <linux/list.h>
87d68730 DA	17	#include <linux/of.h>
	18	#include <linux/of_address.h>
	19	#include <linux/of_platform.h>
29f9b6cf	20	#include <linux/platform_data/syscon.h>
87d68730 DA	21	#include <linux/platform_device.h>
87d68730 DA	22	#include <linux/regmap.h>
75177dee	23	#include <linux/mfd/syscon.h>
bdb0066d	24	#include <linux/slab.h>
87d68730 DA	25
	26	static struct platform_driver syscon_driver;
	27
bdb0066d PD	28	static DEFINE_SPINLOCK(syscon_list_slock);
	29	static LIST_HEAD(syscon_list);
	30
87d68730	31	struct syscon {
bdb0066d	32	struct device_node *np;
87d68730	33	struct regmap *regmap;
bdb0066d PD	34	struct list_head list;
	35	};
	36
c131045d	37	static const struct regmap_config syscon_regmap_config = {
bdb0066d PD	38	.reg_bits = 32,
	39	.val_bits = 32,
	40	.reg_stride = 4,
87d68730 DA	41	};
87d68730 DA	42
bdb0066d	43	static struct syscon of_syscon_register(struct device_node np)
87d68730	44	{
a00406b7	45	struct clk *clk;
bdb0066d PD	46	struct syscon *syscon;
	47	struct regmap *regmap;
	48	void __iomem *base;
db2fb60c	49	u32 reg_io_width;
bdb0066d PD	50	int ret;
bdb0066d PD	51	struct regmap_config syscon_config = syscon_regmap_config;
ca668f0e	52	struct resource res;
bdb0066d PD	53
	54	if (!of_device_is_compatible(np, "syscon"))
	55	return ERR_PTR(-EINVAL);
	56
	57	syscon = kzalloc(sizeof(*syscon), GFP_KERNEL);
	58	if (!syscon)
	59	return ERR_PTR(-ENOMEM);
	60
ca668f0e PZ	61	if (of_address_to_resource(np, 0, &res)) {
	62	ret = -ENOMEM;
	63	goto err_map;
	64	}
	65
	66	base = ioremap(res.start, resource_size(&res));
bdb0066d PD	67	if (!base) {
	68	ret = -ENOMEM;
	69	goto err_map;
	70	}
	71
	72	/* Parse the device's DT node for an endianness specification */
	73	if (of_property_read_bool(np, "big-endian"))
	74	syscon_config.val_format_endian = REGMAP_ENDIAN_BIG;
d29ccdb3	75	else if (of_property_read_bool(np, "little-endian"))
bdb0066d	76	syscon_config.val_format_endian = REGMAP_ENDIAN_LITTLE;
d29ccdb3 PB	77	else if (of_property_read_bool(np, "native-endian"))
d29ccdb3 PB	78	syscon_config.val_format_endian = REGMAP_ENDIAN_NATIVE;
bdb0066d	79
db2fb60c DR	80	/*
	81	* search for reg-io-width property in DT. If it is not provided,
	82	* default to 4 bytes. regmap_init_mmio will return an error if values
	83	* are invalid so there is no need to check them here.
	84	*/
	85	ret = of_property_read_u32(np, "reg-io-width", &reg_io_width);
	86	if (ret)
	87	reg_io_width = 4;
	88
3bafc09e BW	89	ret = of_hwspin_lock_get_id(np, 0);
	90	if (ret > 0 \|\| (IS_ENABLED(CONFIG_HWSPINLOCK) && ret == 0)) {
	91	syscon_config.use_hwlock = true;
	92	syscon_config.hwlock_id = ret;
	93	syscon_config.hwlock_mode = HWLOCK_IRQSTATE;
	94	} else if (ret < 0) {
	95	switch (ret) {
	96	case -ENOENT:
	97	/* Ignore missing hwlock, it's optional. */
	98	break;
	99	default:
	100	pr_err("Failed to retrieve valid hwlock: %d\n", ret);
	101	/* fall-through */
	102	case -EPROBE_DEFER:
	103	goto err_regmap;
	104	}
	105	}
	106
408d1d57	107	syscon_config.name = of_node_full_name(np);
db2fb60c DR	108	syscon_config.reg_stride = reg_io_width;
db2fb60c DR	109	syscon_config.val_bits = reg_io_width * 8;
ca668f0e	110	syscon_config.max_register = resource_size(&res) - reg_io_width;
500f9ff5	111	syscon_config.name = of_node_full_name(np);
db2fb60c	112
bdb0066d PD	113	regmap = regmap_init_mmio(NULL, base, &syscon_config);
	114	if (IS_ERR(regmap)) {
	115	pr_err("regmap init failed\n");
	116	ret = PTR_ERR(regmap);
	117	goto err_regmap;
	118	}
	119
a00406b7 FG	120	clk = of_clk_get(np, 0);
	121	if (IS_ERR(clk)) {
	122	ret = PTR_ERR(clk);
	123	/* clock is optional */
	124	if (ret != -ENOENT)
	125	goto err_clk;
	126	} else {
	127	ret = regmap_mmio_attach_clk(regmap, clk);
	128	if (ret)
	129	goto err_attach;
	130	}
	131
bdb0066d PD	132	syscon->regmap = regmap;
	133	syscon->np = np;
	134
	135	spin_lock(&syscon_list_slock);
	136	list_add_tail(&syscon->list, &syscon_list);
	137	spin_unlock(&syscon_list_slock);
87d68730	138
bdb0066d PD	139	return syscon;
bdb0066d PD	140
a00406b7 FG	141	err_attach:
	142	if (!IS_ERR(clk))
	143	clk_put(clk);
	144	err_clk:
	145	regmap_exit(regmap);
bdb0066d PD	146	err_regmap:
	147	iounmap(base);
	148	err_map:
	149	kfree(syscon);
	150	return ERR_PTR(ret);
87d68730 DA	151	}
	152
	153	struct regmap syscon_node_to_regmap(struct device_node np)
	154	{
bdb0066d	155	struct syscon entry, syscon = NULL;
87d68730	156
bdb0066d	157	spin_lock(&syscon_list_slock);
87d68730	158
bdb0066d PD	159	list_for_each_entry(entry, &syscon_list, list)
	160	if (entry->np == np) {
	161	syscon = entry;
	162	break;
	163	}
	164
	165	spin_unlock(&syscon_list_slock);
	166
	167	if (!syscon)
	168	syscon = of_syscon_register(np);
	169
	170	if (IS_ERR(syscon))
	171	return ERR_CAST(syscon);
87d68730 DA	172
	173	return syscon->regmap;
	174	}
	175	EXPORT_SYMBOL_GPL(syscon_node_to_regmap);
	176
	177	struct regmap syscon_regmap_lookup_by_compatible(const char s)
	178	{
	179	struct device_node *syscon_np;
	180	struct regmap *regmap;
	181
	182	syscon_np = of_find_compatible_node(NULL, NULL, s);
	183	if (!syscon_np)
	184	return ERR_PTR(-ENODEV);
	185
	186	regmap = syscon_node_to_regmap(syscon_np);
	187	of_node_put(syscon_np);
	188
	189	return regmap;
	190	}
	191	EXPORT_SYMBOL_GPL(syscon_regmap_lookup_by_compatible);
	192
	193	struct regmap syscon_regmap_lookup_by_phandle(struct device_node np,
	194	const char *property)
	195	{
	196	struct device_node *syscon_np;
	197	struct regmap *regmap;
	198
45330bb4 PD	199	if (property)
	200	syscon_np = of_parse_phandle(np, property, 0);
	201	else
	202	syscon_np = np;
	203
87d68730 DA	204	if (!syscon_np)
	205	return ERR_PTR(-ENODEV);
	206
	207	regmap = syscon_node_to_regmap(syscon_np);
	208	of_node_put(syscon_np);
	209
	210	return regmap;
	211	}
	212	EXPORT_SYMBOL_GPL(syscon_regmap_lookup_by_phandle);
	213
f791be49	214	static int syscon_probe(struct platform_device *pdev)
87d68730 DA	215	{
87d68730 DA	216	struct device *dev = &pdev->dev;
29f9b6cf	217	struct syscon_platform_data *pdata = dev_get_platdata(dev);
87d68730	218	struct syscon *syscon;
c131045d	219	struct regmap_config syscon_config = syscon_regmap_config;
5ab3a89a	220	struct resource *res;
f10111cc	221	void __iomem *base;
87d68730	222
5ab3a89a	223	syscon = devm_kzalloc(dev, sizeof(*syscon), GFP_KERNEL);
87d68730 DA	224	if (!syscon)
	225	return -ENOMEM;
	226
5ab3a89a AS	227	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	228	if (!res)
	229	return -ENOENT;
87d68730	230
f10111cc AS	231	base = devm_ioremap(dev, res->start, resource_size(res));
f10111cc AS	232	if (!base)
5ab3a89a	233	return -ENOMEM;
87d68730	234
c131045d	235	syscon_config.max_register = res->end - res->start - 3;
29f9b6cf	236	if (pdata)
c131045d PZ	237	syscon_config.name = pdata->label;
c131045d PZ	238	syscon->regmap = devm_regmap_init_mmio(dev, base, &syscon_config);
87d68730 DA	239	if (IS_ERR(syscon->regmap)) {
	240	dev_err(dev, "regmap init failed\n");
	241	return PTR_ERR(syscon->regmap);
	242	}
	243
87d68730 DA	244	platform_set_drvdata(pdev, syscon);
87d68730 DA	245
38d8974e	246	dev_dbg(dev, "regmap %pR registered\n", res);
87d68730 DA	247
	248	return 0;
	249	}
	250
5ab3a89a AS	251	static const struct platform_device_id syscon_ids[] = {
	252	{ "syscon", },
	253	{ }
	254	};
87d68730 DA	255
	256	static struct platform_driver syscon_driver = {
	257	.driver = {
	258	.name = "syscon",
87d68730 DA	259	},
87d68730 DA	260	.probe = syscon_probe,
5ab3a89a	261	.id_table = syscon_ids,
87d68730 DA	262	};
	263
	264	static int __init syscon_init(void)
	265	{
	266	return platform_driver_register(&syscon_driver);
	267	}
	268	postcore_initcall(syscon_init);