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

// SPDX-License-Identifier: GPL-2.0+
/*
 * Copyright (c) 2013 Google, Inc
 *
 * (C) Copyright 2012
 * Pavel Herrmann <[email protected]>
 */

#define LOG_CATEGORY LOGC_DM

#include <common.h>
#include <dm.h>
#include <errno.h>
#include <log.h>
#include <malloc.h>
#include <asm/global_data.h>
#include <dm/device.h>
#include <dm/device-internal.h>
#include <dm/lists.h>
#include <dm/uclass.h>
#include <dm/uclass-internal.h>
#include <dm/util.h>

DECLARE_GLOBAL_DATA_PTR;

struct uclass *uclass_find(enum uclass_id key)
{
	struct uclass *uc;

	if (!gd->dm_root)
		return NULL;
	/*
	 * TODO([email protected]): Optimise this, perhaps moving the found
	 * node to the start of the list, or creating a linear array mapping
	 * id to node.
	 */
	list_for_each_entry(uc, gd->uclass_root, sibling_node) {
		if (uc->uc_drv->id == key)
			return uc;
	}

	return NULL;
}

/**
 * uclass_add() - Create new uclass in list
 * @id: Id number to create
 * @ucp: Returns pointer to uclass, or NULL on error
 * @return 0 on success, -ve on error
 *
 * The new uclass is added to the list. There must be only one uclass for
 * each id.
 */
static int uclass_add(enum uclass_id id, struct uclass **ucp)
{
	struct uclass_driver *uc_drv;
	struct uclass *uc;
	int ret;

	*ucp = NULL;
	uc_drv = lists_uclass_lookup(id);
	if (!uc_drv) {
		debug("Cannot find uclass for id %d: please add the UCLASS_DRIVER() declaration for this UCLASS_... id\n",
		      id);
		/*
		 * Use a strange error to make this case easier to find. When
		 * a uclass is not available it can prevent driver model from
		 * starting up and this failure is otherwise hard to debug.
		 */
		return -EPFNOSUPPORT;
	}
	uc = calloc(1, sizeof(*uc));
	if (!uc)
		return -ENOMEM;
	if (uc_drv->priv_auto) {
		void *ptr;

		ptr = calloc(1, uc_drv->priv_auto);
		if (!ptr) {
			ret = -ENOMEM;
			goto fail_mem;
		}
		uclass_set_priv(uc, ptr);
	}
	uc->uc_drv = uc_drv;
	INIT_LIST_HEAD(&uc->sibling_node);
	INIT_LIST_HEAD(&uc->dev_head);
	list_add(&uc->sibling_node, DM_UCLASS_ROOT_NON_CONST);

	if (uc_drv->init) {
		ret = uc_drv->init(uc);
		if (ret)
			goto fail;
	}

	*ucp = uc;

	return 0;
fail:
	if (uc_drv->priv_auto) {
		free(uclass_get_priv(uc));
		uclass_set_priv(uc, NULL);
	}
	list_del(&uc->sibling_node);
fail_mem:
	free(uc);

	return ret;
}

int uclass_destroy(struct uclass *uc)
{
	struct uclass_driver *uc_drv;
	struct udevice *dev;
	int ret;

	/*
	 * We cannot use list_for_each_entry_safe() here. If a device in this
	 * uclass has a child device also in this uclass, it will be also be
	 * unbound (by the recursion in the call to device_unbind() below).
	 * We can loop until the list is empty.
	 */
	while (!list_empty(&uc->dev_head)) {
		dev = list_first_entry(&uc->dev_head, struct udevice,
				       uclass_node);
		ret = device_remove(dev, DM_REMOVE_NORMAL | DM_REMOVE_NO_PD);
		if (ret)
			return log_msg_ret("remove", ret);
		ret = device_unbind(dev);
		if (ret)
			return log_msg_ret("unbind", ret);
	}

	uc_drv = uc->uc_drv;
	if (uc_drv->destroy)
		uc_drv->destroy(uc);
	list_del(&uc->sibling_node);
	if (uc_drv->priv_auto)
		free(uclass_get_priv(uc));
	free(uc);

	return 0;
}

int uclass_get(enum uclass_id id, struct uclass **ucp)
{
	struct uclass *uc;

	*ucp = NULL;
	uc = uclass_find(id);
	if (!uc) {
		if (CONFIG_IS_ENABLED(OF_PLATDATA_INST))
			return -ENOENT;
		return uclass_add(id, ucp);
	}
	*ucp = uc;

	return 0;
}

const char *uclass_get_name(enum uclass_id id)
{
	struct uclass *uc;

	if (uclass_get(id, &uc))
		return NULL;
	return uc->uc_drv->name;
}

void *uclass_get_priv(const struct uclass *uc)
{
	return uc->priv_;
}

void uclass_set_priv(struct uclass *uc, void *priv)
{
	uc->priv_ = priv;
}

enum uclass_id uclass_get_by_name(const char *name)
{
	int i;

	for (i = 0; i < UCLASS_COUNT; i++) {
		struct uclass_driver *uc_drv = lists_uclass_lookup(i);

		if (uc_drv && !strcmp(uc_drv->name, name))
			return i;
	}

	return UCLASS_INVALID;
}

int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp)
{
	struct udevice *iter;
	struct uclass *uc = dev->uclass;
	int i = 0;

	if (list_empty(&uc->dev_head))
		return -ENODEV;

	uclass_foreach_dev(iter, uc) {
		if (iter == dev) {
			if (ucp)
				*ucp = uc;
			return i;
		}
		i++;
	}

	return -ENODEV;
}

int uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
{
	struct uclass *uc;
	struct udevice *dev;
	int ret;

	*devp = NULL;
	ret = uclass_get(id, &uc);
	if (ret)
		return ret;
	if (list_empty(&uc->dev_head))
		return -ENODEV;

	uclass_foreach_dev(dev, uc) {
		if (!index--) {
			*devp = dev;
			return 0;
		}
	}

	return -ENODEV;
}

int uclass_find_first_device(enum uclass_id id, struct udevice **devp)
{
	struct uclass *uc;
	int ret;

	*devp = NULL;
	ret = uclass_get(id, &uc);
	if (ret)
		return ret;
	if (list_empty(&uc->dev_head))
		return 0;

	*devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node);

	return 0;
}

int uclass_find_next_device(struct udevice **devp)
{
	struct udevice *dev = *devp;

	*devp = NULL;
	if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head))
		return 0;

	*devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node);

	return 0;
}

int uclass_find_device_by_name(enum uclass_id id, const char *name,
			       struct udevice **devp)
{
	struct uclass *uc;
	struct udevice *dev;
	int ret;

	*devp = NULL;
	if (!name)
		return -EINVAL;
	ret = uclass_get(id, &uc);
	if (ret)
		return ret;

	uclass_foreach_dev(dev, uc) {
		if (!strcmp(dev->name, name)) {
			*devp = dev;
			return 0;
		}
	}

	return -ENODEV;
}

int uclass_find_next_free_seq(struct uclass *uc)
{
	struct udevice *dev;
	int max = -1;

	/* If using aliases, start with the highest alias value */
	if (CONFIG_IS_ENABLED(DM_SEQ_ALIAS) &&
	    (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS))
		max = dev_read_alias_highest_id(uc->uc_drv->name);

	/* Avoid conflict with existing devices */
	list_for_each_entry(dev, &uc->dev_head, uclass_node) {
		if (dev->seq_ > max)
			max = dev->seq_;
	}
	/*
	 * At this point, max will be -1 if there are no existing aliases or
	 * devices
	 */

	return max + 1;
}

int uclass_find_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
{
	struct uclass *uc;
	struct udevice *dev;
	int ret;

	*devp = NULL;
	log_debug("%d\n", seq);
	if (seq == -1)
		return -ENODEV;
	ret = uclass_get(id, &uc);
	if (ret)
		return ret;

	uclass_foreach_dev(dev, uc) {
		log_debug("   - %d '%s'\n", dev->seq_, dev->name);
		if (dev->seq_ == seq) {
			*devp = dev;
			log_debug("   - found\n");
			return 0;
		}
	}
	log_debug("   - not found\n");

	return -ENODEV;
}

int uclass_find_device_by_of_offset(enum uclass_id id, int node,
				    struct udevice **devp)
{
	struct uclass *uc;
	struct udevice *dev;
	int ret;

	*devp = NULL;
	if (node < 0)
		return -ENODEV;
	ret = uclass_get(id, &uc);
	if (ret)
		return ret;

	uclass_foreach_dev(dev, uc) {
		if (dev_of_offset(dev) == node) {
			*devp = dev;
			return 0;
		}
	}

	return -ENODEV;
}

int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
				 struct udevice **devp)
{
	struct uclass *uc;
	struct udevice *dev;
	int ret;

	log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
	*devp = NULL;
	if (!ofnode_valid(node))
		return -ENODEV;
	ret = uclass_get(id, &uc);
	if (ret)
		return ret;

	uclass_foreach_dev(dev, uc) {
		log(LOGC_DM, LOGL_DEBUG_CONTENT, "      - checking %s\n",
		    dev->name);
		if (ofnode_equal(dev_ofnode(dev), node)) {
			*devp = dev;
			goto done;
		}
	}
	ret = -ENODEV;

done:
	log(LOGC_DM, LOGL_DEBUG, "   - result for %s: %s (ret=%d)\n",
	    ofnode_get_name(node), *devp ? (*devp)->name : "(none)", ret);
	return ret;
}

#if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
int uclass_find_device_by_phandle(enum uclass_id id, struct udevice *parent,
				  const char *name, struct udevice **devp)
{
	struct udevice *dev;
	struct uclass *uc;
	int find_phandle;
	int ret;

	*devp = NULL;
	find_phandle = dev_read_u32_default(parent, name, -1);
	if (find_phandle <= 0)
		return -ENOENT;
	ret = uclass_get(id, &uc);
	if (ret)
		return ret;

	uclass_foreach_dev(dev, uc) {
		uint phandle;

		phandle = dev_read_phandle(dev);

		if (phandle == find_phandle) {
			*devp = dev;
			return 0;
		}
	}

	return -ENODEV;
}
#endif

int uclass_get_device_by_driver(enum uclass_id id,
				const struct driver *find_drv,
				struct udevice **devp)
{
	struct udevice *dev;
	struct uclass *uc;
	int ret;

	ret = uclass_get(id, &uc);
	if (ret)
		return ret;

	uclass_foreach_dev(dev, uc) {
		if (dev->driver == find_drv)
			return uclass_get_device_tail(dev, 0, devp);
	}

	return -ENODEV;
}

int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp)
{
	if (ret)
		return ret;

	assert(dev);
	ret = device_probe(dev);
	if (ret)
		return ret;

	*devp = dev;

	return 0;
}

int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
{
	struct udevice *dev;
	int ret;

	*devp = NULL;
	ret = uclass_find_device(id, index, &dev);
	return uclass_get_device_tail(dev, ret, devp);
}

int uclass_get_device_by_name(enum uclass_id id, const char *name,
			      struct udevice **devp)
{
	struct udevice *dev;
	int ret;

	*devp = NULL;
	ret = uclass_find_device_by_name(id, name, &dev);
	return uclass_get_device_tail(dev, ret, devp);
}

int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
{
	struct udevice *dev;
	int ret;

	*devp = NULL;
	ret = uclass_find_device_by_seq(id, seq, &dev);

	return uclass_get_device_tail(dev, ret, devp);
}

int uclass_get_device_by_of_offset(enum uclass_id id, int node,
				   struct udevice **devp)
{
	struct udevice *dev;
	int ret;

	*devp = NULL;
	ret = uclass_find_device_by_of_offset(id, node, &dev);
	return uclass_get_device_tail(dev, ret, devp);
}

int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
				struct udevice **devp)
{
	struct udevice *dev;
	int ret;

	log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
	*devp = NULL;
	ret = uclass_find_device_by_ofnode(id, node, &dev);
	log(LOGC_DM, LOGL_DEBUG, "   - result for %s: %s (ret=%d)\n",
	    ofnode_get_name(node), dev ? dev->name : "(none)", ret);

	return uclass_get_device_tail(dev, ret, devp);
}

#if CONFIG_IS_ENABLED(OF_CONTROL)
int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
				    struct udevice **devp)
{
	struct udevice *dev;
	struct uclass *uc;
	int ret;

	*devp = NULL;
	ret = uclass_get(id, &uc);
	if (ret)
		return ret;

	uclass_foreach_dev(dev, uc) {
		uint phandle;

		phandle = dev_read_phandle(dev);

		if (phandle == phandle_id) {
			*devp = dev;
			return uclass_get_device_tail(dev, ret, devp);
		}
	}

	return -ENODEV;
}

int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
				 const char *name, struct udevice **devp)
{
	struct udevice *dev;
	int ret;

	*devp = NULL;
	ret = uclass_find_device_by_phandle(id, parent, name, &dev);
	return uclass_get_device_tail(dev, ret, devp);
}
#endif

int uclass_first_device(enum uclass_id id, struct udevice **devp)
{
	struct udevice *dev;
	int ret;

	*devp = NULL;
	ret = uclass_find_first_device(id, &dev);
	if (!dev)
		return 0;
	return uclass_get_device_tail(dev, ret, devp);
}

int uclass_first_device_err(enum uclass_id id, struct udevice **devp)
{
	int ret;

	ret = uclass_first_device(id, devp);
	if (ret)
		return ret;
	else if (!*devp)
		return -ENODEV;

	return 0;
}

int uclass_next_device(struct udevice **devp)
{
	struct udevice *dev = *devp;
	int ret;

	*devp = NULL;
	ret = uclass_find_next_device(&dev);
	if (!dev)
		return 0;
	return uclass_get_device_tail(dev, ret, devp);
}

int uclass_next_device_err(struct udevice **devp)
{
	int ret;

	ret = uclass_next_device(devp);
	if (ret)
		return ret;
	else if (!*devp)
		return -ENODEV;

	return 0;
}

int uclass_first_device_check(enum uclass_id id, struct udevice **devp)
{
	int ret;

	*devp = NULL;
	ret = uclass_find_first_device(id, devp);
	if (ret)
		return ret;
	if (!*devp)
		return 0;

	return device_probe(*devp);
}

int uclass_next_device_check(struct udevice **devp)
{
	int ret;

	ret = uclass_find_next_device(devp);
	if (ret)
		return ret;
	if (!*devp)
		return 0;

	return device_probe(*devp);
}

int uclass_first_device_drvdata(enum uclass_id id, ulong driver_data,
				struct udevice **devp)
{
	struct udevice *dev;
	struct uclass *uc;

	uclass_id_foreach_dev(id, dev, uc) {
		if (dev_get_driver_data(dev) == driver_data) {
			*devp = dev;

			return device_probe(dev);
		}
	}

	return -ENODEV;
}

int uclass_bind_device(struct udevice *dev)
{
	struct uclass *uc;
	int ret;

	uc = dev->uclass;
	list_add_tail(&dev->uclass_node, &uc->dev_head);

	if (dev->parent) {
		struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;

		if (uc_drv->child_post_bind) {
			ret = uc_drv->child_post_bind(dev);
			if (ret)
				goto err;
		}
	}

	return 0;
err:
	/* There is no need to undo the parent's post_bind call */
	list_del(&dev->uclass_node);

	return ret;
}

#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
int uclass_unbind_device(struct udevice *dev)
{
	struct uclass *uc;
	int ret;

	uc = dev->uclass;
	if (uc->uc_drv->pre_unbind) {
		ret = uc->uc_drv->pre_unbind(dev);
		if (ret)
			return ret;
	}

	list_del(&dev->uclass_node);
	return 0;
}
#endif

int uclass_pre_probe_device(struct udevice *dev)
{
	struct uclass_driver *uc_drv;
	int ret;

	uc_drv = dev->uclass->uc_drv;
	if (uc_drv->pre_probe) {
		ret = uc_drv->pre_probe(dev);
		if (ret)
			return ret;
	}

	if (!dev->parent)
		return 0;
	uc_drv = dev->parent->uclass->uc_drv;
	if (uc_drv->child_pre_probe) {
		ret = uc_drv->child_pre_probe(dev);
		if (ret)
			return ret;
	}

	return 0;
}

int uclass_post_probe_device(struct udevice *dev)
{
	struct uclass_driver *uc_drv;
	int ret;

	if (dev->parent) {
		uc_drv = dev->parent->uclass->uc_drv;
		if (uc_drv->child_post_probe) {
			ret = uc_drv->child_post_probe(dev);
			if (ret)
				return ret;
		}
	}

	uc_drv = dev->uclass->uc_drv;
	if (uc_drv->post_probe) {
		ret = uc_drv->post_probe(dev);
		if (ret)
			return ret;
	}

	return 0;
}

#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
int uclass_pre_remove_device(struct udevice *dev)
{
	struct uclass *uc;
	int ret;

	uc = dev->uclass;
	if (uc->uc_drv->pre_remove) {
		ret = uc->uc_drv->pre_remove(dev);
		if (ret)
			return ret;
	}

	return 0;
}
#endif

int uclass_probe_all(enum uclass_id id)
{
	struct udevice *dev;
	int ret;

	ret = uclass_first_device(id, &dev);
	if (ret || !dev)
		return ret;

	/* Scanning uclass to probe all devices */
	while (dev) {
		ret = uclass_next_device(&dev);
		if (ret)
			return ret;
	}

	return 0;
}

UCLASS_DRIVER(nop) = {
	.id		= UCLASS_NOP,
	.name		= "nop",
};
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
6494d708 SG	2	/*
	3	* Copyright (c) 2013 Google, Inc
	4	*
	5	* (C) Copyright 2012
	6	* Pavel Herrmann <[email protected]>
6494d708 SG	7	*/
6494d708 SG	8
97b5f9d1 KY	9	#define LOG_CATEGORY LOGC_DM
97b5f9d1 KY	10
6494d708	11	#include <common.h>
40bb637d	12	#include <dm.h>
6494d708	13	#include <errno.h>
f7ae49fc	14	#include <log.h>
6494d708	15	#include <malloc.h>
401d1c4f	16	#include <asm/global_data.h>
6494d708 SG	17	#include <dm/device.h>
	18	#include <dm/device-internal.h>
	19	#include <dm/lists.h>
	20	#include <dm/uclass.h>
	21	#include <dm/uclass-internal.h>
	22	#include <dm/util.h>
	23
	24	DECLARE_GLOBAL_DATA_PTR;
	25
	26	struct uclass *uclass_find(enum uclass_id key)
	27	{
	28	struct uclass *uc;
	29
c910e2e2 SG	30	if (!gd->dm_root)
c910e2e2 SG	31	return NULL;
6494d708 SG	32	/*
	33	* TODO([email protected]): Optimise this, perhaps moving the found
	34	* node to the start of the list, or creating a linear array mapping
	35	* id to node.
	36	*/
8a715530	37	list_for_each_entry(uc, gd->uclass_root, sibling_node) {
6494d708 SG	38	if (uc->uc_drv->id == key)
	39	return uc;
	40	}
	41
	42	return NULL;
	43	}
	44
	45	/**
	46	* uclass_add() - Create new uclass in list
	47	* @id: Id number to create
	48	* @ucp: Returns pointer to uclass, or NULL on error
	49	* @return 0 on success, -ve on error
	50	*
	51	* The new uclass is added to the list. There must be only one uclass for
	52	* each id.
	53	*/
	54	static int uclass_add(enum uclass_id id, struct uclass **ucp)
	55	{
	56	struct uclass_driver *uc_drv;
	57	struct uclass *uc;
	58	int ret;
	59
	60	*ucp = NULL;
	61	uc_drv = lists_uclass_lookup(id);
	62	if (!uc_drv) {
643e6902 MY	63	debug("Cannot find uclass for id %d: please add the UCLASS_DRIVER() declaration for this UCLASS_... id\n",
643e6902 MY	64	id);
3346c876 SG	65	/*
	66	* Use a strange error to make this case easier to find. When
	67	* a uclass is not available it can prevent driver model from
	68	* starting up and this failure is otherwise hard to debug.
	69	*/
	70	return -EPFNOSUPPORT;
6494d708	71	}
6494d708 SG	72	uc = calloc(1, sizeof(*uc));
	73	if (!uc)
	74	return -ENOMEM;
41575d8e	75	if (uc_drv->priv_auto) {
89ba6d55 SG	76	void *ptr;
	77
	78	ptr = calloc(1, uc_drv->priv_auto);
	79	if (!ptr) {
6494d708 SG	80	ret = -ENOMEM;
	81	goto fail_mem;
	82	}
89ba6d55	83	uclass_set_priv(uc, ptr);
6494d708 SG	84	}
	85	uc->uc_drv = uc_drv;
	86	INIT_LIST_HEAD(&uc->sibling_node);
	87	INIT_LIST_HEAD(&uc->dev_head);
8a715530	88	list_add(&uc->sibling_node, DM_UCLASS_ROOT_NON_CONST);
6494d708 SG	89
	90	if (uc_drv->init) {
	91	ret = uc_drv->init(uc);
	92	if (ret)
	93	goto fail;
	94	}
	95
	96	*ucp = uc;
	97
	98	return 0;
	99	fail:
41575d8e	100	if (uc_drv->priv_auto) {
89ba6d55 SG	101	free(uclass_get_priv(uc));
89ba6d55 SG	102	uclass_set_priv(uc, NULL);
6494d708 SG	103	}
	104	list_del(&uc->sibling_node);
	105	fail_mem:
	106	free(uc);
	107
	108	return ret;
	109	}
	110
	111	int uclass_destroy(struct uclass *uc)
	112	{
	113	struct uclass_driver *uc_drv;
07d260e0	114	struct udevice *dev;
6494d708 SG	115	int ret;
6494d708 SG	116
07d260e0 SG	117	/*
	118	* We cannot use list_for_each_entry_safe() here. If a device in this
	119	* uclass has a child device also in this uclass, it will be also be
	120	* unbound (by the recursion in the call to device_unbind() below).
	121	* We can loop until the list is empty.
	122	*/
	123	while (!list_empty(&uc->dev_head)) {
	124	dev = list_first_entry(&uc->dev_head, struct udevice,
	125	uclass_node);
ced10804	126	ret = device_remove(dev, DM_REMOVE_NORMAL \| DM_REMOVE_NO_PD);
6494d708	127	if (ret)
8474da94	128	return log_msg_ret("remove", ret);
6494d708 SG	129	ret = device_unbind(dev);
6494d708 SG	130	if (ret)
8474da94	131	return log_msg_ret("unbind", ret);
6494d708 SG	132	}
	133
	134	uc_drv = uc->uc_drv;
	135	if (uc_drv->destroy)
	136	uc_drv->destroy(uc);
	137	list_del(&uc->sibling_node);
41575d8e	138	if (uc_drv->priv_auto)
89ba6d55	139	free(uclass_get_priv(uc));
6494d708 SG	140	free(uc);
	141
	142	return 0;
	143	}
	144
	145	int uclass_get(enum uclass_id id, struct uclass **ucp)
	146	{
	147	struct uclass *uc;
	148
	149	*ucp = NULL;
	150	uc = uclass_find(id);
91bcfdf0 SG	151	if (!uc) {
	152	if (CONFIG_IS_ENABLED(OF_PLATDATA_INST))
	153	return -ENOENT;
6494d708	154	return uclass_add(id, ucp);
91bcfdf0	155	}
6494d708 SG	156	*ucp = uc;
	157
	158	return 0;
	159	}
	160
0a5f6f86 SG	161	const char *uclass_get_name(enum uclass_id id)
	162	{
	163	struct uclass *uc;
	164
	165	if (uclass_get(id, &uc))
	166	return NULL;
	167	return uc->uc_drv->name;
	168	}
	169
80647393 SG	170	void uclass_get_priv(const struct uclass uc)
80647393 SG	171	{
fb8c9fb3	172	return uc->priv_;
80647393 SG	173	}
	174
	175	void uclass_set_priv(struct uclass uc, void priv)
	176	{
fb8c9fb3	177	uc->priv_ = priv;
80647393 SG	178	}
80647393 SG	179
6e43d1b1 SG	180	enum uclass_id uclass_get_by_name(const char *name)
	181	{
	182	int i;
	183
	184	for (i = 0; i < UCLASS_COUNT; i++) {
	185	struct uclass_driver *uc_drv = lists_uclass_lookup(i);
	186
	187	if (uc_drv && !strcmp(uc_drv->name, name))
	188	return i;
	189	}
	190
	191	return UCLASS_INVALID;
	192	}
	193
e7c86562 JJH	194	int dev_get_uclass_index(struct udevice dev, struct uclass *ucp)
	195	{
	196	struct udevice *iter;
	197	struct uclass *uc = dev->uclass;
	198	int i = 0;
	199
	200	if (list_empty(&uc->dev_head))
	201	return -ENODEV;
	202
81f351d6	203	uclass_foreach_dev(iter, uc) {
e7c86562 JJH	204	if (iter == dev) {
	205	if (ucp)
	206	*ucp = uc;
	207	return i;
	208	}
	209	i++;
	210	}
	211
	212	return -ENODEV;
	213	}
	214
54c5d08a	215	int uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
6494d708 SG	216	{
6494d708 SG	217	struct uclass *uc;
54c5d08a	218	struct udevice *dev;
6494d708 SG	219	int ret;
	220
	221	*devp = NULL;
	222	ret = uclass_get(id, &uc);
	223	if (ret)
	224	return ret;
2fda14ae SG	225	if (list_empty(&uc->dev_head))
2fda14ae SG	226	return -ENODEV;
6494d708	227
81f351d6	228	uclass_foreach_dev(dev, uc) {
6494d708 SG	229	if (!index--) {
	230	*devp = dev;
	231	return 0;
	232	}
	233	}
	234
	235	return -ENODEV;
	236	}
	237
c1d6f919 PM	238	int uclass_find_first_device(enum uclass_id id, struct udevice **devp)
	239	{
	240	struct uclass *uc;
	241	int ret;
	242
	243	*devp = NULL;
	244	ret = uclass_get(id, &uc);
	245	if (ret)
	246	return ret;
	247	if (list_empty(&uc->dev_head))
4805a7af	248	return 0;
c1d6f919 PM	249
	250	*devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node);
	251
	252	return 0;
	253	}
	254
	255	int uclass_find_next_device(struct udevice **devp)
	256	{
	257	struct udevice dev = devp;
	258
	259	*devp = NULL;
	260	if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head))
	261	return 0;
	262
	263	*devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node);
	264
	265	return 0;
	266	}
	267
e0735a4c PM	268	int uclass_find_device_by_name(enum uclass_id id, const char *name,
	269	struct udevice **devp)
	270	{
	271	struct uclass *uc;
	272	struct udevice *dev;
	273	int ret;
	274
	275	*devp = NULL;
	276	if (!name)
	277	return -EINVAL;
	278	ret = uclass_get(id, &uc);
	279	if (ret)
	280	return ret;
	281
81f351d6	282	uclass_foreach_dev(dev, uc) {
4213609c	283	if (!strcmp(dev->name, name)) {
e0735a4c PM	284	*devp = dev;
	285	return 0;
	286	}
	287	}
	288
	289	return -ENODEV;
	290	}
	291
a133e217	292	int uclass_find_next_free_seq(struct uclass *uc)
3542ff29	293	{
3542ff29	294	struct udevice *dev;
3542ff29 JJH	295	int max = -1;
3542ff29 JJH	296
a133e217 SG	297	/* If using aliases, start with the highest alias value */
	298	if (CONFIG_IS_ENABLED(DM_SEQ_ALIAS) &&
	299	(uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS))
	300	max = dev_read_alias_highest_id(uc->uc_drv->name);
	301
	302	/* Avoid conflict with existing devices */
3542ff29	303	list_for_each_entry(dev, &uc->dev_head, uclass_node) {
2462139f SG	304	if (dev->seq_ > max)
2462139f SG	305	max = dev->seq_;
3542ff29	306	}
a133e217 SG	307	/*
	308	* At this point, max will be -1 if there are no existing aliases or
	309	* devices
	310	*/
3542ff29 JJH	311
	312	return max + 1;
	313	}
3542ff29	314
99175919	315	int uclass_find_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
5a66a8ff SG	316	{
	317	struct uclass *uc;
	318	struct udevice *dev;
	319	int ret;
	320
	321	*devp = NULL;
99175919 SG	322	log_debug("%d\n", seq);
99175919 SG	323	if (seq == -1)
5a66a8ff SG	324	return -ENODEV;
	325	ret = uclass_get(id, &uc);
	326	if (ret)
	327	return ret;
	328
81f351d6	329	uclass_foreach_dev(dev, uc) {
2462139f SG	330	log_debug(" - %d '%s'\n", dev->seq_, dev->name);
2462139f SG	331	if (dev->seq_ == seq) {
5a66a8ff	332	*devp = dev;
97b5f9d1	333	log_debug(" - found\n");
5a66a8ff SG	334	return 0;
	335	}
	336	}
97b5f9d1	337	log_debug(" - not found\n");
5a66a8ff SG	338
	339	return -ENODEV;
	340	}
	341
1b30d61d SG	342	int uclass_find_device_by_of_offset(enum uclass_id id, int node,
1b30d61d SG	343	struct udevice **devp)
f4cdead2 SG	344	{
	345	struct uclass *uc;
	346	struct udevice *dev;
	347	int ret;
	348
	349	*devp = NULL;
	350	if (node < 0)
	351	return -ENODEV;
	352	ret = uclass_get(id, &uc);
	353	if (ret)
	354	return ret;
	355
81f351d6	356	uclass_foreach_dev(dev, uc) {
e160f7d4	357	if (dev_of_offset(dev) == node) {
f4cdead2 SG	358	*devp = dev;
	359	return 0;
	360	}
	361	}
	362
	363	return -ENODEV;
	364	}
	365
40bb637d SG	366	int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
	367	struct udevice **devp)
	368	{
	369	struct uclass *uc;
	370	struct udevice *dev;
	371	int ret;
	372
31e60ffa	373	log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
40bb637d SG	374	*devp = NULL;
	375	if (!ofnode_valid(node))
	376	return -ENODEV;
	377	ret = uclass_get(id, &uc);
	378	if (ret)
	379	return ret;
	380
81f351d6	381	uclass_foreach_dev(dev, uc) {
31e60ffa SG	382	log(LOGC_DM, LOGL_DEBUG_CONTENT, " - checking %s\n",
31e60ffa SG	383	dev->name);
40bb637d SG	384	if (ofnode_equal(dev_ofnode(dev), node)) {
40bb637d SG	385	*devp = dev;
31e60ffa	386	goto done;
40bb637d SG	387	}
40bb637d SG	388	}
31e60ffa	389	ret = -ENODEV;
40bb637d	390
31e60ffa SG	391	done:
	392	log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
	393	ofnode_get_name(node), devp ? (devp)->name : "(none)", ret);
	394	return ret;
40bb637d SG	395	}
40bb637d SG	396
168227a1	397	#if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
d0b4f68d SG	398	int uclass_find_device_by_phandle(enum uclass_id id, struct udevice *parent,
d0b4f68d SG	399	const char name, struct udevice *devp)
d82ba4c0 SG	400	{
	401	struct udevice *dev;
	402	struct uclass *uc;
	403	int find_phandle;
	404	int ret;
	405
	406	*devp = NULL;
a40cc8e1	407	find_phandle = dev_read_u32_default(parent, name, -1);
d82ba4c0 SG	408	if (find_phandle <= 0)
	409	return -ENOENT;
	410	ret = uclass_get(id, &uc);
	411	if (ret)
	412	return ret;
	413
81f351d6	414	uclass_foreach_dev(dev, uc) {
e160f7d4 SG	415	uint phandle;
e160f7d4 SG	416
a40cc8e1	417	phandle = dev_read_phandle(dev);
d82ba4c0 SG	418
	419	if (phandle == find_phandle) {
	420	*devp = dev;
	421	return 0;
	422	}
	423	}
	424
	425	return -ENODEV;
	426	}
c275dfef	427	#endif
d82ba4c0	428
c57f806b SG	429	int uclass_get_device_by_driver(enum uclass_id id,
	430	const struct driver *find_drv,
	431	struct udevice **devp)
	432	{
	433	struct udevice *dev;
	434	struct uclass *uc;
	435	int ret;
	436
	437	ret = uclass_get(id, &uc);
	438	if (ret)
	439	return ret;
	440
81f351d6	441	uclass_foreach_dev(dev, uc) {
c57f806b SG	442	if (dev->driver == find_drv)
	443	return uclass_get_device_tail(dev, 0, devp);
	444	}
	445
	446	return -ENODEV;
	447	}
	448
30a570a9	449	int uclass_get_device_tail(struct udevice dev, int ret, struct udevice *devp)
6494d708	450	{
6494d708 SG	451	if (ret)
	452	return ret;
	453
f66529f9	454	assert(dev);
6494d708 SG	455	ret = device_probe(dev);
	456	if (ret)
	457	return ret;
	458
	459	*devp = dev;
	460
	461	return 0;
	462	}
	463
9ca296a1 SG	464	int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
	465	{
	466	struct udevice *dev;
	467	int ret;
	468
	469	*devp = NULL;
	470	ret = uclass_find_device(id, index, &dev);
	471	return uclass_get_device_tail(dev, ret, devp);
	472	}
	473
b7af1a2d PM	474	int uclass_get_device_by_name(enum uclass_id id, const char *name,
	475	struct udevice **devp)
	476	{
	477	struct udevice *dev;
	478	int ret;
	479
	480	*devp = NULL;
	481	ret = uclass_find_device_by_name(id, name, &dev);
	482	return uclass_get_device_tail(dev, ret, devp);
	483	}
	484
5a66a8ff SG	485	int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
	486	{
	487	struct udevice *dev;
	488	int ret;
	489
	490	*devp = NULL;
99175919 SG	491	ret = uclass_find_device_by_seq(id, seq, &dev);
99175919 SG	492
5a66a8ff SG	493	return uclass_get_device_tail(dev, ret, devp);
	494	}
	495
f4cdead2 SG	496	int uclass_get_device_by_of_offset(enum uclass_id id, int node,
	497	struct udevice **devp)
	498	{
	499	struct udevice *dev;
	500	int ret;
	501
	502	*devp = NULL;
	503	ret = uclass_find_device_by_of_offset(id, node, &dev);
	504	return uclass_get_device_tail(dev, ret, devp);
	505	}
	506
40bb637d SG	507	int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
	508	struct udevice **devp)
	509	{
	510	struct udevice *dev;
	511	int ret;
	512
31e60ffa	513	log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
40bb637d SG	514	*devp = NULL;
40bb637d SG	515	ret = uclass_find_device_by_ofnode(id, node, &dev);
31e60ffa SG	516	log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
31e60ffa SG	517	ofnode_get_name(node), dev ? dev->name : "(none)", ret);
40bb637d SG	518
	519	return uclass_get_device_tail(dev, ret, devp);
	520	}
	521
c275dfef	522	#if CONFIG_IS_ENABLED(OF_CONTROL)
d255fade KY	523	int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
	524	struct udevice **devp)
	525	{
	526	struct udevice *dev;
	527	struct uclass *uc;
	528	int ret;
	529
	530	*devp = NULL;
	531	ret = uclass_get(id, &uc);
	532	if (ret)
	533	return ret;
	534
81f351d6	535	uclass_foreach_dev(dev, uc) {
d255fade KY	536	uint phandle;
	537
	538	phandle = dev_read_phandle(dev);
	539
	540	if (phandle == phandle_id) {
	541	*devp = dev;
	542	return uclass_get_device_tail(dev, ret, devp);
	543	}
	544	}
	545
	546	return -ENODEV;
	547	}
	548
d82ba4c0 SG	549	int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
	550	const char name, struct udevice *devp)
	551	{
	552	struct udevice *dev;
	553	int ret;
	554
	555	*devp = NULL;
	556	ret = uclass_find_device_by_phandle(id, parent, name, &dev);
	557	return uclass_get_device_tail(dev, ret, devp);
	558	}
c275dfef	559	#endif
d82ba4c0	560
54c5d08a	561	int uclass_first_device(enum uclass_id id, struct udevice **devp)
6494d708	562	{
54c5d08a	563	struct udevice *dev;
6494d708 SG	564	int ret;
	565
	566	*devp = NULL;
c1d6f919	567	ret = uclass_find_first_device(id, &dev);
f66529f9 SG	568	if (!dev)
f66529f9 SG	569	return 0;
c1d6f919	570	return uclass_get_device_tail(dev, ret, devp);
6494d708 SG	571	}
6494d708 SG	572
b0675050 SG	573	int uclass_first_device_err(enum uclass_id id, struct udevice **devp)
	574	{
	575	int ret;
	576
	577	ret = uclass_first_device(id, devp);
	578	if (ret)
	579	return ret;
	580	else if (!*devp)
	581	return -ENODEV;
	582
	583	return 0;
	584	}
	585
54c5d08a	586	int uclass_next_device(struct udevice **devp)
6494d708	587	{
54c5d08a	588	struct udevice dev = devp;
6494d708 SG	589	int ret;
	590
	591	*devp = NULL;
c1d6f919	592	ret = uclass_find_next_device(&dev);
f66529f9 SG	593	if (!dev)
f66529f9 SG	594	return 0;
c1d6f919	595	return uclass_get_device_tail(dev, ret, devp);
6494d708 SG	596	}
6494d708 SG	597
f6abd538 PC	598	int uclass_next_device_err(struct udevice **devp)
	599	{
	600	int ret;
	601
	602	ret = uclass_next_device(devp);
	603	if (ret)
	604	return ret;
	605	else if (!*devp)
	606	return -ENODEV;
	607
	608	return 0;
	609	}
	610
95ce385a SG	611	int uclass_first_device_check(enum uclass_id id, struct udevice **devp)
	612	{
	613	int ret;
	614
	615	*devp = NULL;
	616	ret = uclass_find_first_device(id, devp);
	617	if (ret)
	618	return ret;
	619	if (!*devp)
	620	return 0;
	621
	622	return device_probe(*devp);
	623	}
	624
	625	int uclass_next_device_check(struct udevice **devp)
	626	{
	627	int ret;
	628
	629	ret = uclass_find_next_device(devp);
	630	if (ret)
	631	return ret;
	632	if (!*devp)
	633	return 0;
	634
	635	return device_probe(*devp);
	636	}
	637
50162348 SG	638	int uclass_first_device_drvdata(enum uclass_id id, ulong driver_data,
	639	struct udevice **devp)
	640	{
	641	struct udevice *dev;
	642	struct uclass *uc;
	643
	644	uclass_id_foreach_dev(id, dev, uc) {
	645	if (dev_get_driver_data(dev) == driver_data) {
	646	*devp = dev;
	647
	648	return device_probe(dev);
	649	}
	650	}
	651
	652	return -ENODEV;
	653	}
	654
54c5d08a	655	int uclass_bind_device(struct udevice *dev)
6494d708 SG	656	{
	657	struct uclass *uc;
	658	int ret;
	659
	660	uc = dev->uclass;
6494d708 SG	661	list_add_tail(&dev->uclass_node, &uc->dev_head);
6494d708 SG	662
081f2fcb SG	663	if (dev->parent) {
	664	struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;
	665
	666	if (uc_drv->child_post_bind) {
	667	ret = uc_drv->child_post_bind(dev);
	668	if (ret)
	669	goto err;
	670	}
	671	}
6494d708 SG	672
6494d708 SG	673	return 0;
081f2fcb SG	674	err:
	675	/* There is no need to undo the parent's post_bind call */
	676	list_del(&dev->uclass_node);
	677
	678	return ret;
6494d708 SG	679	}
6494d708 SG	680
0a5804b5	681	#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
54c5d08a	682	int uclass_unbind_device(struct udevice *dev)
6494d708 SG	683	{
	684	struct uclass *uc;
	685	int ret;
	686
	687	uc = dev->uclass;
	688	if (uc->uc_drv->pre_unbind) {
	689	ret = uc->uc_drv->pre_unbind(dev);
	690	if (ret)
	691	return ret;
	692	}
	693
	694	list_del(&dev->uclass_node);
	695	return 0;
	696	}
7f9875e7	697	#endif
6494d708	698
02c07b37	699	int uclass_pre_probe_device(struct udevice *dev)
83c7e434 SG	700	{
83c7e434 SG	701	struct uclass_driver *uc_drv;
02c07b37 SG	702	int ret;
	703
	704	uc_drv = dev->uclass->uc_drv;
	705	if (uc_drv->pre_probe) {
	706	ret = uc_drv->pre_probe(dev);
	707	if (ret)
	708	return ret;
	709	}
83c7e434 SG	710
	711	if (!dev->parent)
	712	return 0;
	713	uc_drv = dev->parent->uclass->uc_drv;
c8b31cce SG	714	if (uc_drv->child_pre_probe) {
	715	ret = uc_drv->child_pre_probe(dev);
	716	if (ret)
	717	return ret;
	718	}
83c7e434 SG	719
	720	return 0;
	721	}
	722
54c5d08a	723	int uclass_post_probe_device(struct udevice *dev)
6494d708	724	{
651d0c01 BM	725	struct uclass_driver *uc_drv;
	726	int ret;
	727
	728	if (dev->parent) {
	729	uc_drv = dev->parent->uclass->uc_drv;
	730	if (uc_drv->child_post_probe) {
	731	ret = uc_drv->child_post_probe(dev);
	732	if (ret)
	733	return ret;
	734	}
	735	}
6494d708	736
651d0c01	737	uc_drv = dev->uclass->uc_drv;
c8b31cce SG	738	if (uc_drv->post_probe) {
	739	ret = uc_drv->post_probe(dev);
	740	if (ret)
	741	return ret;
	742	}
6494d708 SG	743
	744	return 0;
	745	}
	746
0a5804b5	747	#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
54c5d08a	748	int uclass_pre_remove_device(struct udevice *dev)
6494d708	749	{
6494d708 SG	750	struct uclass *uc;
	751	int ret;
	752
	753	uc = dev->uclass;
6494d708 SG	754	if (uc->uc_drv->pre_remove) {
	755	ret = uc->uc_drv->pre_remove(dev);
	756	if (ret)
	757	return ret;
	758	}
6494d708 SG	759
	760	return 0;
	761	}
7f9875e7	762	#endif
07e33711	763
a59153df VS	764	int uclass_probe_all(enum uclass_id id)
	765	{
	766	struct udevice *dev;
	767	int ret;
	768
	769	ret = uclass_first_device(id, &dev);
	770	if (ret \|\| !dev)
	771	return ret;
	772
	773	/* Scanning uclass to probe all devices */
	774	while (dev) {
	775	ret = uclass_next_device(&dev);
	776	if (ret)
	777	return ret;
	778	}
	779
	780	return 0;
	781	}
	782
07e33711 JJH	783	UCLASS_DRIVER(nop) = {
	784	.id = UCLASS_NOP,
	785	.name = "nop",
	786	};