[linux-2.6-block.git] / drivers / base / soc.c

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (C) ST-Ericsson SA 2011
 *
 * Author: Lee Jones <lee.jones@linaro.org> for ST-Ericsson.
 */

#include <linux/sysfs.h>
#include <linux/init.h>
#include <linux/stat.h>
#include <linux/slab.h>
#include <linux/idr.h>
#include <linux/spinlock.h>
#include <linux/sys_soc.h>
#include <linux/err.h>
#include <linux/glob.h>

static DEFINE_IDA(soc_ida);

static ssize_t soc_info_get(struct device *dev,
			    struct device_attribute *attr,
			    char *buf);

struct soc_device {
	struct device dev;
	struct soc_device_attribute *attr;
	int soc_dev_num;
};

static struct bus_type soc_bus_type = {
	.name  = "soc",
};

static DEVICE_ATTR(machine,  S_IRUGO, soc_info_get,  NULL);
static DEVICE_ATTR(family,   S_IRUGO, soc_info_get,  NULL);
static DEVICE_ATTR(soc_id,   S_IRUGO, soc_info_get,  NULL);
static DEVICE_ATTR(revision, S_IRUGO, soc_info_get,  NULL);

struct device *soc_device_to_device(struct soc_device *soc_dev)
{
	return &soc_dev->dev;
}

static umode_t soc_attribute_mode(struct kobject *kobj,
				struct attribute *attr,
				int index)
{
	struct device *dev = container_of(kobj, struct device, kobj);
	struct soc_device *soc_dev = container_of(dev, struct soc_device, dev);

	if ((attr == &dev_attr_machine.attr)
	    && (soc_dev->attr->machine != NULL))
		return attr->mode;
	if ((attr == &dev_attr_family.attr)
	    && (soc_dev->attr->family != NULL))
		return attr->mode;
	if ((attr == &dev_attr_revision.attr)
	    && (soc_dev->attr->revision != NULL))
		return attr->mode;
	if ((attr == &dev_attr_soc_id.attr)
	    && (soc_dev->attr->soc_id != NULL))
		return attr->mode;

	/* Unknown or unfilled attribute. */
	return 0;
}

static ssize_t soc_info_get(struct device *dev,
			    struct device_attribute *attr,
			    char *buf)
{
	struct soc_device *soc_dev = container_of(dev, struct soc_device, dev);

	if (attr == &dev_attr_machine)
		return sprintf(buf, "%s\n", soc_dev->attr->machine);
	if (attr == &dev_attr_family)
		return sprintf(buf, "%s\n", soc_dev->attr->family);
	if (attr == &dev_attr_revision)
		return sprintf(buf, "%s\n", soc_dev->attr->revision);
	if (attr == &dev_attr_soc_id)
		return sprintf(buf, "%s\n", soc_dev->attr->soc_id);

	return -EINVAL;

}

static struct attribute *soc_attr[] = {
	&dev_attr_machine.attr,
	&dev_attr_family.attr,
	&dev_attr_soc_id.attr,
	&dev_attr_revision.attr,
	NULL,
};

static const struct attribute_group soc_attr_group = {
	.attrs = soc_attr,
	.is_visible = soc_attribute_mode,
};

static const struct attribute_group *soc_attr_groups[] = {
	&soc_attr_group,
	NULL,
};

static void soc_release(struct device *dev)
{
	struct soc_device *soc_dev = container_of(dev, struct soc_device, dev);

	kfree(soc_dev);
}

static struct soc_device_attribute *early_soc_dev_attr;

struct soc_device *soc_device_register(struct soc_device_attribute *soc_dev_attr)
{
	struct soc_device *soc_dev;
	int ret;

	if (!soc_bus_type.p) {
		if (early_soc_dev_attr)
			return ERR_PTR(-EBUSY);
		early_soc_dev_attr = soc_dev_attr;
		return NULL;
	}

	soc_dev = kzalloc(sizeof(*soc_dev), GFP_KERNEL);
	if (!soc_dev) {
		ret = -ENOMEM;
		goto out1;
	}

	/* Fetch a unique (reclaimable) SOC ID. */
	ret = ida_simple_get(&soc_ida, 0, 0, GFP_KERNEL);
	if (ret < 0)
		goto out2;
	soc_dev->soc_dev_num = ret;

	soc_dev->attr = soc_dev_attr;
	soc_dev->dev.bus = &soc_bus_type;
	soc_dev->dev.groups = soc_attr_groups;
	soc_dev->dev.release = soc_release;

	dev_set_name(&soc_dev->dev, "soc%d", soc_dev->soc_dev_num);

	ret = device_register(&soc_dev->dev);
	if (ret)
		goto out3;

	return soc_dev;

out3:
	ida_simple_remove(&soc_ida, soc_dev->soc_dev_num);
	put_device(&soc_dev->dev);
	soc_dev = NULL;
out2:
	kfree(soc_dev);
out1:
	return ERR_PTR(ret);
}

/* Ensure soc_dev->attr is freed prior to calling soc_device_unregister. */
void soc_device_unregister(struct soc_device *soc_dev)
{
	ida_simple_remove(&soc_ida, soc_dev->soc_dev_num);

	device_unregister(&soc_dev->dev);
	early_soc_dev_attr = NULL;
}

static int __init soc_bus_register(void)
{
	int ret;

	ret = bus_register(&soc_bus_type);
	if (ret)
		return ret;

	if (early_soc_dev_attr)
		return PTR_ERR(soc_device_register(early_soc_dev_attr));

	return 0;
}
core_initcall(soc_bus_register);

static int soc_device_match_attr(const struct soc_device_attribute *attr,
				 const struct soc_device_attribute *match)
{
	if (match->machine &&
	    (!attr->machine || !glob_match(match->machine, attr->machine)))
		return 0;

	if (match->family &&
	    (!attr->family || !glob_match(match->family, attr->family)))
		return 0;

	if (match->revision &&
	    (!attr->revision || !glob_match(match->revision, attr->revision)))
		return 0;

	if (match->soc_id &&
	    (!attr->soc_id || !glob_match(match->soc_id, attr->soc_id)))
		return 0;

	return 1;
}

static int soc_device_match_one(struct device *dev, void *arg)
{
	struct soc_device *soc_dev = container_of(dev, struct soc_device, dev);

	return soc_device_match_attr(soc_dev->attr, arg);
}

/*
 * soc_device_match - identify the SoC in the machine
 * @matches: zero-terminated array of possible matches
 *
 * returns the first matching entry of the argument array, or NULL
 * if none of them match.
 *
 * This function is meant as a helper in place of of_match_node()
 * in cases where either no device tree is available or the information
 * in a device node is insufficient to identify a particular variant
 * by its compatible strings or other properties. For new devices,
 * the DT binding should always provide unique compatible strings
 * that allow the use of of_match_node() instead.
 *
 * The calling function can use the .data entry of the
 * soc_device_attribute to pass a structure or function pointer for
 * each entry.
 */
const struct soc_device_attribute *soc_device_match(
	const struct soc_device_attribute *matches)
{
	int ret = 0;

	if (!matches)
		return NULL;

	while (!ret) {
		if (!(matches->machine || matches->family ||
		      matches->revision || matches->soc_id))
			break;
		ret = bus_for_each_dev(&soc_bus_type, NULL, (void *)matches,
				       soc_device_match_one);
		if (ret < 0 && early_soc_dev_attr)
			ret = soc_device_match_attr(early_soc_dev_attr,
						    matches);
		if (ret < 0)
			return NULL;
		if (!ret)
			matches++;
		else
			return matches;
	}
	return NULL;
}
EXPORT_SYMBOL_GPL(soc_device_match);
Commit	Line	Data
989d42e8	1	// SPDX-License-Identifier: GPL-2.0
74d1d82c LJ	2	/*
	3	* Copyright (C) ST-Ericsson SA 2011
	4	*
	5	* Author: Lee Jones <lee.jones@linaro.org> for ST-Ericsson.
74d1d82c LJ	6	*/
	7
	8	#include <linux/sysfs.h>
74d1d82c LJ	9	#include <linux/init.h>
	10	#include <linux/stat.h>
	11	#include <linux/slab.h>
	12	#include <linux/idr.h>
	13	#include <linux/spinlock.h>
	14	#include <linux/sys_soc.h>
	15	#include <linux/err.h>
c97db7cc	16	#include <linux/glob.h>
74d1d82c	17
3a4ffe93	18	static DEFINE_IDA(soc_ida);
74d1d82c LJ	19
	20	static ssize_t soc_info_get(struct device *dev,
	21	struct device_attribute *attr,
	22	char *buf);
	23
	24	struct soc_device {
	25	struct device dev;
	26	struct soc_device_attribute *attr;
	27	int soc_dev_num;
	28	};
	29
	30	static struct bus_type soc_bus_type = {
	31	.name = "soc",
	32	};
	33
	34	static DEVICE_ATTR(machine, S_IRUGO, soc_info_get, NULL);
	35	static DEVICE_ATTR(family, S_IRUGO, soc_info_get, NULL);
	36	static DEVICE_ATTR(soc_id, S_IRUGO, soc_info_get, NULL);
	37	static DEVICE_ATTR(revision, S_IRUGO, soc_info_get, NULL);
	38
	39	struct device soc_device_to_device(struct soc_device soc_dev)
	40	{
	41	return &soc_dev->dev;
	42	}
	43
726592a9	44	static umode_t soc_attribute_mode(struct kobject *kobj,
2071b950 LT	45	struct attribute *attr,
2071b950 LT	46	int index)
74d1d82c LJ	47	{
	48	struct device *dev = container_of(kobj, struct device, kobj);
	49	struct soc_device *soc_dev = container_of(dev, struct soc_device, dev);
	50
	51	if ((attr == &dev_attr_machine.attr)
	52	&& (soc_dev->attr->machine != NULL))
	53	return attr->mode;
	54	if ((attr == &dev_attr_family.attr)
	55	&& (soc_dev->attr->family != NULL))
	56	return attr->mode;
	57	if ((attr == &dev_attr_revision.attr)
	58	&& (soc_dev->attr->revision != NULL))
	59	return attr->mode;
	60	if ((attr == &dev_attr_soc_id.attr)
	61	&& (soc_dev->attr->soc_id != NULL))
2071b950	62	return attr->mode;
74d1d82c LJ	63
	64	/* Unknown or unfilled attribute. */
	65	return 0;
	66	}
	67
	68	static ssize_t soc_info_get(struct device *dev,
	69	struct device_attribute *attr,
	70	char *buf)
	71	{
	72	struct soc_device *soc_dev = container_of(dev, struct soc_device, dev);
	73
	74	if (attr == &dev_attr_machine)
	75	return sprintf(buf, "%s\n", soc_dev->attr->machine);
	76	if (attr == &dev_attr_family)
	77	return sprintf(buf, "%s\n", soc_dev->attr->family);
	78	if (attr == &dev_attr_revision)
	79	return sprintf(buf, "%s\n", soc_dev->attr->revision);
	80	if (attr == &dev_attr_soc_id)
	81	return sprintf(buf, "%s\n", soc_dev->attr->soc_id);
	82
	83	return -EINVAL;
	84
	85	}
	86
	87	static struct attribute *soc_attr[] = {
	88	&dev_attr_machine.attr,
	89	&dev_attr_family.attr,
	90	&dev_attr_soc_id.attr,
	91	&dev_attr_revision.attr,
	92	NULL,
	93	};
	94
	95	static const struct attribute_group soc_attr_group = {
	96	.attrs = soc_attr,
	97	.is_visible = soc_attribute_mode,
	98	};
	99
	100	static const struct attribute_group *soc_attr_groups[] = {
	101	&soc_attr_group,
	102	NULL,
	103	};
	104
	105	static void soc_release(struct device *dev)
	106	{
	107	struct soc_device *soc_dev = container_of(dev, struct soc_device, dev);
	108
	109	kfree(soc_dev);
	110	}
	111
6e12db37 GU	112	static struct soc_device_attribute *early_soc_dev_attr;
6e12db37 GU	113
74d1d82c LJ	114	struct soc_device soc_device_register(struct soc_device_attribute soc_dev_attr)
	115	{
	116	struct soc_device *soc_dev;
	117	int ret;
	118
1da1b362	119	if (!soc_bus_type.p) {
6e12db37 GU	120	if (early_soc_dev_attr)
	121	return ERR_PTR(-EBUSY);
	122	early_soc_dev_attr = soc_dev_attr;
	123	return NULL;
1da1b362 GU	124	}
1da1b362 GU	125
74d1d82c LJ	126	soc_dev = kzalloc(sizeof(*soc_dev), GFP_KERNEL);
74d1d82c LJ	127	if (!soc_dev) {
2071b950	128	ret = -ENOMEM;
74d1d82c LJ	129	goto out1;
	130	}
	131
	132	/* Fetch a unique (reclaimable) SOC ID. */
cfcf6a91 LD	133	ret = ida_simple_get(&soc_ida, 0, 0, GFP_KERNEL);
cfcf6a91 LD	134	if (ret < 0)
2071b950	135	goto out2;
cfcf6a91	136	soc_dev->soc_dev_num = ret;
74d1d82c LJ	137
	138	soc_dev->attr = soc_dev_attr;
	139	soc_dev->dev.bus = &soc_bus_type;
	140	soc_dev->dev.groups = soc_attr_groups;
	141	soc_dev->dev.release = soc_release;
	142
	143	dev_set_name(&soc_dev->dev, "soc%d", soc_dev->soc_dev_num);
	144
	145	ret = device_register(&soc_dev->dev);
	146	if (ret)
	147	goto out3;
	148
	149	return soc_dev;
	150
	151	out3:
cfcf6a91	152	ida_simple_remove(&soc_ida, soc_dev->soc_dev_num);
ef49ec1d AY	153	put_device(&soc_dev->dev);
ef49ec1d AY	154	soc_dev = NULL;
74d1d82c LJ	155	out2:
	156	kfree(soc_dev);
	157	out1:
	158	return ERR_PTR(ret);
	159	}
	160
	161	/* Ensure soc_dev->attr is freed prior to calling soc_device_unregister. */
	162	void soc_device_unregister(struct soc_device *soc_dev)
	163	{
cfcf6a91	164	ida_simple_remove(&soc_ida, soc_dev->soc_dev_num);
74d1d82c LJ	165
74d1d82c LJ	166	device_unregister(&soc_dev->dev);
6e12db37	167	early_soc_dev_attr = NULL;
74d1d82c LJ	168	}
	169
	170	static int __init soc_bus_register(void)
	171	{
6e12db37	172	int ret;
1da1b362	173
6e12db37 GU	174	ret = bus_register(&soc_bus_type);
	175	if (ret)
	176	return ret;
	177
	178	if (early_soc_dev_attr)
	179	return PTR_ERR(soc_device_register(early_soc_dev_attr));
	180
	181	return 0;
74d1d82c LJ	182	}
74d1d82c LJ	183	core_initcall(soc_bus_register);
c97db7cc	184
6e12db37 GU	185	static int soc_device_match_attr(const struct soc_device_attribute *attr,
6e12db37 GU	186	const struct soc_device_attribute *match)
c97db7cc	187	{
c97db7cc	188	if (match->machine &&
6e12db37	189	(!attr->machine \|\| !glob_match(match->machine, attr->machine)))
c97db7cc AB	190	return 0;
	191
	192	if (match->family &&
6e12db37	193	(!attr->family \|\| !glob_match(match->family, attr->family)))
c97db7cc AB	194	return 0;
	195
	196	if (match->revision &&
6e12db37	197	(!attr->revision \|\| !glob_match(match->revision, attr->revision)))
c97db7cc AB	198	return 0;
	199
	200	if (match->soc_id &&
6e12db37	201	(!attr->soc_id \|\| !glob_match(match->soc_id, attr->soc_id)))
c97db7cc AB	202	return 0;
	203
	204	return 1;
	205	}
	206
6e12db37 GU	207	static int soc_device_match_one(struct device dev, void arg)
	208	{
	209	struct soc_device *soc_dev = container_of(dev, struct soc_device, dev);
	210
	211	return soc_device_match_attr(soc_dev->attr, arg);
	212	}
	213
c97db7cc AB	214	/*
	215	* soc_device_match - identify the SoC in the machine
	216	* @matches: zero-terminated array of possible matches
	217	*
	218	* returns the first matching entry of the argument array, or NULL
	219	* if none of them match.
	220	*
	221	* This function is meant as a helper in place of of_match_node()
	222	* in cases where either no device tree is available or the information
	223	* in a device node is insufficient to identify a particular variant
	224	* by its compatible strings or other properties. For new devices,
	225	* the DT binding should always provide unique compatible strings
	226	* that allow the use of of_match_node() instead.
	227	*
	228	* The calling function can use the .data entry of the
	229	* soc_device_attribute to pass a structure or function pointer for
	230	* each entry.
	231	*/
	232	const struct soc_device_attribute *soc_device_match(
	233	const struct soc_device_attribute *matches)
	234	{
	235	int ret = 0;
	236
	237	if (!matches)
	238	return NULL;
	239
	240	while (!ret) {
	241	if (!(matches->machine \|\| matches->family \|\|
	242	matches->revision \|\| matches->soc_id))
	243	break;
	244	ret = bus_for_each_dev(&soc_bus_type, NULL, (void *)matches,
	245	soc_device_match_one);
6e12db37 GU	246	if (ret < 0 && early_soc_dev_attr)
	247	ret = soc_device_match_attr(early_soc_dev_attr,
	248	matches);
0656db9e GU	249	if (ret < 0)
0656db9e GU	250	return NULL;
c97db7cc AB	251	if (!ret)
	252	matches++;
	253	else
	254	return matches;
	255	}
	256	return NULL;
	257	}
	258	EXPORT_SYMBOL_GPL(soc_device_match);