u-boot/drivers/core/syscon-uclass.c

175 lines
3.7 KiB
C
Raw Normal View History

// SPDX-License-Identifier: GPL-2.0+
/*
* Copyright (C) 2015 Google, Inc
* Written by Simon Glass <sjg@chromium.org>
*/
#include <common.h>
#include <syscon.h>
#include <dm.h>
#include <errno.h>
#include <regmap.h>
#include <dm/device-internal.h>
#include <dm/lists.h>
#include <dm/root.h>
#include <linux/err.h>
syscon: add Linux-compatible syscon API The syscon implementation in U-Boot is different from that in Linux. Thus, DT files imported from Linux do not work for U-Boot. In U-Boot driver model, each node is bound to a dedicated driver that is the most compatible to it. This design gets along with the concept of DT, and the syscon in Linux originally worked like that. However, Linux commit bdb0066df96e ("mfd: syscon: Decouple syscon interface from platform devices") changed the behavior because it is useful to let a device bind to another driver, but still work as a syscon provider. That change had happened before U-Boot initially supported the syscon driver by commit 6f98b7504f70 ("dm: Add support for generic system controllers (syscon)"). So, the U-Boot's syscon works differently from the beginning. I'd say this is mis-implementation given that DT is not oriented to a particular project, but Linux is the canon of DT in practice. The problem typically arises in the combination of "syscon" and "simple-mfd" compatibles. In Linux, they are orthogonal, i.e., the order between "syscon" and "simple-mfd" does not matter at all. Assume the following compatible. compatible = "foo,bar-syscon", "syscon", "simple-mfd"; In U-Boot, this device node is bound to the syscon driver (driver/core/syscon-uclass.c) since the "syscon" is found to be the most compatible. Then, syscon_get_regmap() succeeds. However, compatible = "foo,bar-syscon", "simple-mfd", "syscon"; does not work because this node is bound to the simple-bus driver (drivers/core/simple-bus.c) in favor of "simple-mfd" compatible. The compatible string "syscon" is just dismissed. Moreover, compatible = "foo,bar-syscon", "syscon"; works like the first case because the syscon driver populates the child devices. This is wrong because populating children is the job of "simple-mfd" (or "simple-bus"). This commit ports syscon_node_to_regmap() from Linux. This API does not require the given node to be bound to a driver in any way. Reported-by: Kunihiko Hayashi <hayashi.kunihiko@socionext.com> Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
2018-04-19 03:14:04 +00:00
/*
* Caution:
* This API requires the given device has alerady been bound to syscon driver.
* For example,
* compatible = "syscon", "simple-mfd";
* works, but
* compatible = "simple-mfd", "syscon";
* does not. The behavior is different from Linux.
*/
struct regmap *syscon_get_regmap(struct udevice *dev)
{
struct syscon_uc_info *priv;
if (device_get_uclass_id(dev) != UCLASS_SYSCON)
return ERR_PTR(-ENOEXEC);
priv = dev_get_uclass_priv(dev);
return priv->regmap;
}
static int syscon_pre_probe(struct udevice *dev)
{
struct syscon_uc_info *priv = dev_get_uclass_priv(dev);
/*
* With OF_PLATDATA we really have no way of knowing the format of
* the device-specific platform data. So we assume that it starts with
* a 'reg' member, and this holds a single address and size. Drivers
* using OF_PLATDATA will need to ensure that this is true.
*/
#if CONFIG_IS_ENABLED(OF_PLATDATA)
struct syscon_base_platdata *plat = dev_get_platdata(dev);
return regmap_init_mem_platdata(dev, plat->reg, ARRAY_SIZE(plat->reg),
&priv->regmap);
#else
return regmap_init_mem(dev_ofnode(dev), &priv->regmap);
#endif
}
int syscon_get_by_driver_data(ulong driver_data, struct udevice **devp)
{
struct udevice *dev;
struct uclass *uc;
int ret;
*devp = NULL;
ret = uclass_get(UCLASS_SYSCON, &uc);
if (ret)
return ret;
uclass_foreach_dev(dev, uc) {
if (dev->driver_data == driver_data) {
*devp = dev;
return device_probe(dev);
}
}
return -ENODEV;
}
struct regmap *syscon_get_regmap_by_driver_data(ulong driver_data)
{
struct syscon_uc_info *priv;
struct udevice *dev;
int ret;
ret = syscon_get_by_driver_data(driver_data, &dev);
if (ret)
return ERR_PTR(ret);
priv = dev_get_uclass_priv(dev);
return priv->regmap;
}
void *syscon_get_first_range(ulong driver_data)
{
struct regmap *map;
map = syscon_get_regmap_by_driver_data(driver_data);
if (IS_ERR(map))
return map;
return regmap_get_range(map, 0);
}
UCLASS_DRIVER(syscon) = {
.id = UCLASS_SYSCON,
.name = "syscon",
.per_device_auto_alloc_size = sizeof(struct syscon_uc_info),
.pre_probe = syscon_pre_probe,
};
static const struct udevice_id generic_syscon_ids[] = {
{ .compatible = "syscon" },
{ }
};
U_BOOT_DRIVER(generic_syscon) = {
.name = "syscon",
.id = UCLASS_SYSCON,
#if !CONFIG_IS_ENABLED(OF_PLATDATA)
.bind = dm_scan_fdt_dev,
#endif
.of_match = generic_syscon_ids,
};
syscon: add Linux-compatible syscon API The syscon implementation in U-Boot is different from that in Linux. Thus, DT files imported from Linux do not work for U-Boot. In U-Boot driver model, each node is bound to a dedicated driver that is the most compatible to it. This design gets along with the concept of DT, and the syscon in Linux originally worked like that. However, Linux commit bdb0066df96e ("mfd: syscon: Decouple syscon interface from platform devices") changed the behavior because it is useful to let a device bind to another driver, but still work as a syscon provider. That change had happened before U-Boot initially supported the syscon driver by commit 6f98b7504f70 ("dm: Add support for generic system controllers (syscon)"). So, the U-Boot's syscon works differently from the beginning. I'd say this is mis-implementation given that DT is not oriented to a particular project, but Linux is the canon of DT in practice. The problem typically arises in the combination of "syscon" and "simple-mfd" compatibles. In Linux, they are orthogonal, i.e., the order between "syscon" and "simple-mfd" does not matter at all. Assume the following compatible. compatible = "foo,bar-syscon", "syscon", "simple-mfd"; In U-Boot, this device node is bound to the syscon driver (driver/core/syscon-uclass.c) since the "syscon" is found to be the most compatible. Then, syscon_get_regmap() succeeds. However, compatible = "foo,bar-syscon", "simple-mfd", "syscon"; does not work because this node is bound to the simple-bus driver (drivers/core/simple-bus.c) in favor of "simple-mfd" compatible. The compatible string "syscon" is just dismissed. Moreover, compatible = "foo,bar-syscon", "syscon"; works like the first case because the syscon driver populates the child devices. This is wrong because populating children is the job of "simple-mfd" (or "simple-bus"). This commit ports syscon_node_to_regmap() from Linux. This API does not require the given node to be bound to a driver in any way. Reported-by: Kunihiko Hayashi <hayashi.kunihiko@socionext.com> Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
2018-04-19 03:14:04 +00:00
/*
* Linux-compatible syscon-to-regmap
* The syscon node can be bound to another driver, but still works
* as a syscon provider.
*/
static LIST_HEAD(syscon_list);
struct syscon {
ofnode node;
struct regmap *regmap;
struct list_head list;
};
static struct syscon *of_syscon_register(ofnode node)
{
struct syscon *syscon;
int ret;
if (!ofnode_device_is_compatible(node, "syscon"))
return ERR_PTR(-EINVAL);
syscon = malloc(sizeof(*syscon));
if (!syscon)
return ERR_PTR(-ENOMEM);
ret = regmap_init_mem(node, &syscon->regmap);
if (ret) {
free(syscon);
return ERR_PTR(ret);
}
list_add_tail(&syscon->list, &syscon_list);
return syscon;
}
struct regmap *syscon_node_to_regmap(ofnode node)
{
struct syscon *entry, *syscon = NULL;
list_for_each_entry(entry, &syscon_list, list)
if (ofnode_equal(entry->node, node)) {
syscon = entry;
break;
}
if (!syscon)
syscon = of_syscon_register(node);
if (IS_ERR(syscon))
return ERR_CAST(syscon);
return syscon->regmap;
}