regulator: Add of_regulator_get_optional() for pure DT regulator lookup

The to-be-introduced I2C component prober needs to enable regulator
supplies (and toggle GPIO pins) for the various components it intends
to probe. To support this, a new "pure DT lookup" method for getting
regulator supplies is needed, since the device normally requesting
the supply won't get created until after the component is probed to
be available.

Add a new of_regulator_get_optional() function for this. This mirrors
the existing regulator_get_optional() function, but is OF-specific.
The underlying code that supports the existing regulator_get*()
functions has been reworked in previous patches to support this
specific case.

Also convert an existing usage of "dev && dev->of_node" to
"dev_of_node(dev)".

Link: https://lore.kernel.org/all/20231220203537.83479-2-jernej.skrabec@gmail.com/
Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
Link: https://patch.msgid.link/20240925093807.1026949-2-wenst@chromium.org
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Signed-off-by: Mark Brown <broonie@kernel.org>

diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index 1179766811f58365c32577ad4f6474fb3ac6362f..d0b3879f27469e90ba496a33c1157a7be4de757f 100644 (file)
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -1959,8 +1959,8 @@ static struct regulator_dev *regulator_dev_lookup(struct device *dev,
        regulator_supply_alias(&dev, &supply);
 
        /* first do a dt based lookup */
-       if (dev && dev->of_node) {
-               r = of_regulator_dev_lookup(dev, supply);
+       if (dev_of_node(dev)) {
+               r = of_regulator_dev_lookup(dev, dev_of_node(dev), supply);
                if (!IS_ERR(r))
                        return r;
                if (PTR_ERR(r) == -EPROBE_DEFER)

diff --git a/drivers/regulator/internal.h b/drivers/regulator/internal.h
index 5b43f802468ddbfae36660fc7dc545c28afd20c2..f62cacbbc7295e652e05ce4986b451758f123943 100644 (file)
--- a/drivers/regulator/internal.h
+++ b/drivers/regulator/internal.h
@@ -67,6 +67,7 @@ static inline struct regulator_dev *dev_to_rdev(struct device *dev)
 
 #ifdef CONFIG_OF
 struct regulator_dev *of_regulator_dev_lookup(struct device *dev,
+                                             struct device_node *np,
                                              const char *supply);
 struct regulator_init_data *regulator_of_get_init_data(struct device *dev,
                                 const struct regulator_desc *desc,
@@ -82,6 +83,7 @@ bool of_check_coupling_data(struct regulator_dev *rdev);
 
 #else
 static inline struct regulator_dev *of_regulator_dev_lookup(struct device *dev,
+                                                           struct device_node *np,
                                                            const char *supply)
 {
        return ERR_PTR(-ENODEV);

diff --git a/drivers/regulator/of_regulator.c b/drivers/regulator/of_regulator.c
index 3f490d81abc28fe9f6767afe850e0fc883eddb55..358c3ed791dbef80ce5d69908a373cd9bd82c169 100644 (file)
--- a/drivers/regulator/of_regulator.c
+++ b/drivers/regulator/of_regulator.c
@@ -588,7 +588,8 @@ err_node_put:
 
 /**
  * of_get_regulator - get a regulator device node based on supply name
- * @dev: Device pointer for the consumer (of regulator) device
+ * @dev: Device pointer for dev_printk() messages
+ * @node: Device node pointer for supply property lookup
  * @supply: regulator supply name
  *
  * Extract the regulator device node corresponding to the supply name.
@@ -596,15 +597,16 @@ err_node_put:
  * Return: Pointer to the &struct device_node corresponding to the regulator
  *        if found, or %NULL if not found.
  */
-static struct device_node *of_get_regulator(struct device *dev, const char *supply)
+static struct device_node *of_get_regulator(struct device *dev, struct device_node *node,
+                                           const char *supply)
 {
        struct device_node *regnode = NULL;
        char prop_name[64]; /* 64 is max size of property name */
 
-       dev_dbg(dev, "Looking up %s-supply from device tree\n", supply);
+       dev_dbg(dev, "Looking up %s-supply from device node %pOF\n", supply, node);
 
        snprintf(prop_name, 64, "%s-supply", supply);
-       regnode = of_parse_phandle(dev->of_node, prop_name, 0);
+       regnode = of_parse_phandle(node, prop_name, 0);
        if (regnode)
                return regnode;
 
@@ -628,6 +630,7 @@ static struct regulator_dev *of_find_regulator_by_node(struct device_node *np)
 /**
  * of_regulator_dev_lookup - lookup a regulator device with device tree only
  * @dev: Device pointer for regulator supply lookup.
+ * @np: Device node pointer for regulator supply lookup.
  * @supply: Supply name or regulator ID.
  *
  * Return: Pointer to the &struct regulator_dev on success, or ERR_PTR()
@@ -642,13 +645,13 @@ static struct regulator_dev *of_find_regulator_by_node(struct device_node *np)
  * * -%ENODEV if lookup fails permanently.
  * * -%EPROBE_DEFER if lookup could succeed in the future.
  */
-struct regulator_dev *of_regulator_dev_lookup(struct device *dev,
+struct regulator_dev *of_regulator_dev_lookup(struct device *dev, struct device_node *np,
                                              const char *supply)
 {
        struct regulator_dev *r;
        struct device_node *node;
 
-       node = of_get_regulator(dev, supply);
+       node = of_get_regulator(dev, np, supply);
        if (node) {
                r = of_find_regulator_by_node(node);
                of_node_put(node);
@@ -665,6 +668,42 @@ struct regulator_dev *of_regulator_dev_lookup(struct device *dev,
        return ERR_PTR(-ENODEV);
 }
 
+static struct regulator *_of_regulator_get(struct device *dev, struct device_node *node,
+                                          const char *id, enum regulator_get_type get_type)
+{
+       struct regulator_dev *r;
+       int ret;
+
+       ret = _regulator_get_common_check(dev, id, get_type);
+       if (ret)
+               return ERR_PTR(ret);
+
+       r = of_regulator_dev_lookup(dev, node, id);
+       return _regulator_get_common(r, dev, id, get_type);
+}
+
+/**
+ * of_regulator_get_optional - get optional regulator via device tree lookup
+ * @dev: device used for dev_printk() messages
+ * @node: device node for regulator "consumer"
+ * @id: Supply name
+ *
+ * Return: pointer to struct regulator corresponding to the regulator producer,
+ *        or PTR_ERR() encoded error number.
+ *
+ * This is intended for use by consumers that want to get a regulator
+ * supply directly from a device node, and can and want to deal with
+ * absence of such supplies. This will _not_ consider supply aliases.
+ * See regulator_dev_lookup().
+ */
+struct regulator *of_regulator_get_optional(struct device *dev,
+                                           struct device_node *node,
+                                           const char *id)
+{
+       return _of_regulator_get(dev, node, id, OPTIONAL_GET);
+}
+EXPORT_SYMBOL_GPL(of_regulator_get_optional);
+
 /*
  * Returns number of regulators coupled with rdev.
  */

diff --git a/include/linux/regulator/consumer.h b/include/linux/regulator/consumer.h
index b9ce521910a00293f19a7289d600a91c04311383..2b22f07e491c0f667b627b3f55dab8712ecb45b4 100644 (file)
--- a/include/linux/regulator/consumer.h
+++ b/include/linux/regulator/consumer.h
@@ -168,6 +168,19 @@ int devm_regulator_get_enable_read_voltage(struct device *dev, const char *id);
 void regulator_put(struct regulator *regulator);
 void devm_regulator_put(struct regulator *regulator);
 
+#if IS_ENABLED(CONFIG_OF)
+struct regulator *__must_check of_regulator_get_optional(struct device *dev,
+                                                        struct device_node *node,
+                                                        const char *id);
+#else
+static inline struct regulator *__must_check of_regulator_get_optional(struct device *dev,
+                                                                      struct device_node *node,
+                                                                      const char *id)
+{
+       return ERR_PTR(-ENODEV);
+}
+#endif
+
 int regulator_register_supply_alias(struct device *dev, const char *id,
                                    struct device *alias_dev,
                                    const char *alias_id);
@@ -350,6 +363,13 @@ devm_regulator_get_optional(struct device *dev, const char *id)
        return ERR_PTR(-ENODEV);
 }
 
+static inline struct regulator *__must_check of_regulator_get_optional(struct device *dev,
+                                                                      struct device_node *node,
+                                                                      const char *id)
+{
+       return ERR_PTR(-ENODEV);
+}
+
 static inline void regulator_put(struct regulator *regulator)
 {
 }