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