drivers/core/syscon-uclass.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (C) 2015 Google, Inc
   4  * Written by Simon Glass <sjg@chromium.org>
   5  */
   6
   7 #include <common.h>
   8 #include <log.h>
   9 #include <syscon.h>
  10 #include <dm.h>
  11 #include <errno.h>
  12 #include <regmap.h>
  13 #include <dm/device-internal.h>
  14 #include <dm/device_compat.h>
  15 #include <dm/lists.h>
  16 #include <dm/root.h>
  17 #include <linux/err.h>
  18
  19 /*
  20  * Caution:
  21  * This API requires the given device has alerady been bound to syscon driver.
  22  * For example,
  23  *    compatible = "syscon", "simple-mfd";
  24  * works, but
  25  *    compatible = "simple-mfd", "syscon";
  26  * does not.  The behavior is different from Linux.
  27  */
  28 struct regmap *syscon_get_regmap(struct udevice *dev)
  29 {
  30         struct syscon_uc_info *priv;
  31
  32         if (device_get_uclass_id(dev) != UCLASS_SYSCON)
  33                 return ERR_PTR(-ENOEXEC);
  34         priv = dev_get_uclass_priv(dev);
  35         return priv->regmap;
  36 }
  37
  38 static int syscon_pre_probe(struct udevice *dev)
  39 {
  40         struct syscon_uc_info *priv = dev_get_uclass_priv(dev);
  41
  42         /* Special case for PCI devices, which don't have a regmap */
  43         if (device_get_uclass_id(dev->parent) == UCLASS_PCI)
  44                 return 0;
  45
  46         /*
  47          * With OF_PLATDATA we really have no way of knowing the format of
  48          * the device-specific platform data. So we assume that it starts with
  49          * a 'reg' member, and this holds a single address and size. Drivers
  50          * using OF_PLATDATA will need to ensure that this is true.
  51          */
  52 #if CONFIG_IS_ENABLED(OF_PLATDATA)
  53         struct syscon_base_platdata *plat = dev_get_platdata(dev);
  54
  55         return regmap_init_mem_platdata(dev, plat->reg, ARRAY_SIZE(plat->reg),
  56                                         &priv->regmap);
  57 #else
  58         return regmap_init_mem(dev_ofnode(dev), &priv->regmap);
  59 #endif
  60 }
  61
  62 static int syscon_probe_by_ofnode(ofnode node, struct udevice **devp)
  63 {
  64         struct udevice *dev, *parent;
  65         int ret;
  66
  67         /* found node with "syscon" compatible, not bounded to SYSCON UCLASS */
  68         if (!ofnode_device_is_compatible(node, "syscon")) {
  69                 dev_dbg(dev, "invalid compatible for syscon device\n");
  70                 return -EINVAL;
  71         }
  72
  73         /* bound to driver with same ofnode or to root if not found */
  74         if (device_find_global_by_ofnode(node, &parent))
  75                 parent = dm_root();
  76
  77         /* force bound to syscon class */
  78         ret = device_bind_driver_to_node(parent, "syscon",
  79                                          ofnode_get_name(node),
  80                                          node, &dev);
  81         if (ret) {
  82                 dev_dbg(dev, "unable to bound syscon device\n");
  83                 return ret;
  84         }
  85         ret = device_probe(dev);
  86         if (ret) {
  87                 dev_dbg(dev, "unable to probe syscon device\n");
  88                 return ret;
  89         }
  90
  91         *devp = dev;
  92         return 0;
  93 }
  94
  95 struct regmap *syscon_regmap_lookup_by_phandle(struct udevice *dev,
  96                                                const char *name)
  97 {
  98         struct udevice *syscon;
  99         struct regmap *r;
 100         u32 phandle;
 101         ofnode node;
 102         int err;
 103
 104         err = uclass_get_device_by_phandle(UCLASS_SYSCON, dev,
 105                                            name, &syscon);
 106         if (err) {
 107                 /* found node with "syscon" compatible, not bounded to SYSCON */
 108                 err = ofnode_read_u32(dev_ofnode(dev), name, &phandle);
 109                 if (err)
 110                         return ERR_PTR(err);
 111
 112                 node = ofnode_get_by_phandle(phandle);
 113                 if (!ofnode_valid(node)) {
 114                         dev_dbg(dev, "unable to find syscon device\n");
 115                         return ERR_PTR(-EINVAL);
 116                 }
 117                 err = syscon_probe_by_ofnode(node, &syscon);
 118                 if (err)
 119                         return ERR_PTR(-ENODEV);
 120         }
 121
 122         r = syscon_get_regmap(syscon);
 123         if (!r) {
 124                 dev_dbg(dev, "unable to find regmap\n");
 125                 return ERR_PTR(-ENODEV);
 126         }
 127
 128         return r;
 129 }
 130
 131 int syscon_get_by_driver_data(ulong driver_data, struct udevice **devp)
 132 {
 133         int ret;
 134
 135         *devp = NULL;
 136
 137         ret = uclass_first_device_drvdata(UCLASS_SYSCON, driver_data, devp);
 138         if (ret)
 139                 return log_msg_ret("find", ret);
 140
 141         return 0;
 142 }
 143
 144 struct regmap *syscon_get_regmap_by_driver_data(ulong driver_data)
 145 {
 146         struct syscon_uc_info *priv;
 147         struct udevice *dev;
 148         int ret;
 149
 150         ret = syscon_get_by_driver_data(driver_data, &dev);
 151         if (ret)
 152                 return ERR_PTR(ret);
 153         priv = dev_get_uclass_priv(dev);
 154
 155         return priv->regmap;
 156 }
 157
 158 void *syscon_get_first_range(ulong driver_data)
 159 {
 160         struct regmap *map;
 161
 162         map = syscon_get_regmap_by_driver_data(driver_data);
 163         if (IS_ERR(map))
 164                 return map;
 165         return regmap_get_range(map, 0);
 166 }
 167
 168 UCLASS_DRIVER(syscon) = {
 169         .id             = UCLASS_SYSCON,
 170         .name           = "syscon",
 171         .per_device_auto_alloc_size = sizeof(struct syscon_uc_info),
 172         .pre_probe = syscon_pre_probe,
 173 };
 174
 175 static const struct udevice_id generic_syscon_ids[] = {
 176         { .compatible = "syscon" },
 177         { }
 178 };
 179
 180 U_BOOT_DRIVER(generic_syscon) = {
 181         .name   = "syscon",
 182         .id     = UCLASS_SYSCON,
 183 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
 184         .bind           = dm_scan_fdt_dev,
 185 #endif
 186         .of_match = generic_syscon_ids,
 187 };
 188
 189 /*
 190  * Linux-compatible syscon-to-regmap
 191  * The syscon node can be bound to another driver, but still works
 192  * as a syscon provider.
 193  */
 194 struct regmap *syscon_node_to_regmap(ofnode node)
 195 {
 196         struct udevice *dev;
 197         struct regmap *r;
 198
 199         if (uclass_get_device_by_ofnode(UCLASS_SYSCON, node, &dev))
 200                 if (syscon_probe_by_ofnode(node, &dev))
 201                         return ERR_PTR(-ENODEV);
 202
 203         r = syscon_get_regmap(dev);
 204         if (!r) {
 205                 dev_dbg(dev, "unable to find regmap\n");
 206                 return ERR_PTR(-ENODEV);
 207         }
 208
 209         return r;
 210 }