2 * OF helpers for regulator framework
4 * Copyright (C) 2011 Texas Instruments, Inc.
5 * Rajendra Nayak <rnayak@ti.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
13 #include <linux/module.h>
14 #include <linux/slab.h>
16 #include <linux/regulator/machine.h>
17 #include <linux/regulator/driver.h>
18 #include <linux/regulator/of_regulator.h>
22 static const char *const regulator_states[PM_SUSPEND_MAX + 1] = {
23 [PM_SUSPEND_MEM] = "regulator-state-mem",
24 [PM_SUSPEND_MAX] = "regulator-state-disk",
27 static void of_get_regulation_constraints(struct device_node *np,
28 struct regulator_init_data **init_data)
30 const __be32 *min_uV, *max_uV;
31 struct regulation_constraints *constraints = &(*init_data)->constraints;
32 struct regulator_state *suspend_state;
33 struct device_node *suspend_np;
37 constraints->name = of_get_property(np, "regulator-name", NULL);
39 min_uV = of_get_property(np, "regulator-min-microvolt", NULL);
41 constraints->min_uV = be32_to_cpu(*min_uV);
42 max_uV = of_get_property(np, "regulator-max-microvolt", NULL);
44 constraints->max_uV = be32_to_cpu(*max_uV);
46 /* Voltage change possible? */
47 if (constraints->min_uV != constraints->max_uV)
48 constraints->valid_ops_mask |= REGULATOR_CHANGE_VOLTAGE;
49 /* Only one voltage? Then make sure it's set. */
50 if (min_uV && max_uV && constraints->min_uV == constraints->max_uV)
51 constraints->apply_uV = true;
53 if (!of_property_read_u32(np, "regulator-microvolt-offset", &pval))
54 constraints->uV_offset = pval;
55 if (!of_property_read_u32(np, "regulator-min-microamp", &pval))
56 constraints->min_uA = pval;
57 if (!of_property_read_u32(np, "regulator-max-microamp", &pval))
58 constraints->max_uA = pval;
60 /* Current change possible? */
61 if (constraints->min_uA != constraints->max_uA)
62 constraints->valid_ops_mask |= REGULATOR_CHANGE_CURRENT;
64 constraints->boot_on = of_property_read_bool(np, "regulator-boot-on");
65 constraints->always_on = of_property_read_bool(np, "regulator-always-on");
66 if (!constraints->always_on) /* status change should be possible. */
67 constraints->valid_ops_mask |= REGULATOR_CHANGE_STATUS;
69 if (of_property_read_bool(np, "regulator-allow-bypass"))
70 constraints->valid_ops_mask |= REGULATOR_CHANGE_BYPASS;
72 ret = of_property_read_u32(np, "regulator-ramp-delay", &pval);
75 constraints->ramp_delay = pval;
77 constraints->ramp_disable = true;
80 ret = of_property_read_u32(np, "regulator-enable-ramp-delay", &pval);
82 constraints->enable_time = pval;
84 for (i = 0; i < ARRAY_SIZE(regulator_states); i++) {
87 suspend_state = &constraints->state_mem;
90 suspend_state = &constraints->state_disk;
93 case PM_SUSPEND_FREEZE:
94 case PM_SUSPEND_STANDBY:
99 suspend_np = of_get_child_by_name(np, regulator_states[i]);
100 if (!suspend_np || !suspend_state)
103 if (of_property_read_bool(suspend_np,
104 "regulator-on-in-suspend"))
105 suspend_state->enabled = true;
106 else if (of_property_read_bool(suspend_np,
107 "regulator-off-in-suspend"))
108 suspend_state->disabled = true;
110 of_node_put(suspend_np);
111 suspend_state = NULL;
117 * of_get_regulator_init_data - extract regulator_init_data structure info
118 * @dev: device requesting for regulator_init_data
120 * Populates regulator_init_data structure by extracting data from device
121 * tree node, returns a pointer to the populated struture or NULL if memory
124 struct regulator_init_data *of_get_regulator_init_data(struct device *dev,
125 struct device_node *node)
127 struct regulator_init_data *init_data;
132 init_data = devm_kzalloc(dev, sizeof(*init_data), GFP_KERNEL);
134 return NULL; /* Out of memory? */
136 of_get_regulation_constraints(node, &init_data);
139 EXPORT_SYMBOL_GPL(of_get_regulator_init_data);
141 struct devm_of_regulator_matches {
142 struct of_regulator_match *matches;
143 unsigned int num_matches;
146 static void devm_of_regulator_put_matches(struct device *dev, void *res)
148 struct devm_of_regulator_matches *devm_matches = res;
151 for (i = 0; i < devm_matches->num_matches; i++)
152 of_node_put(devm_matches->matches[i].of_node);
156 * of_regulator_match - extract multiple regulator init data from device tree.
157 * @dev: device requesting the data
158 * @node: parent device node of the regulators
159 * @matches: match table for the regulators
160 * @num_matches: number of entries in match table
162 * This function uses a match table specified by the regulator driver to
163 * parse regulator init data from the device tree. @node is expected to
164 * contain a set of child nodes, each providing the init data for one
165 * regulator. The data parsed from a child node will be matched to a regulator
166 * based on either the deprecated property regulator-compatible if present,
167 * or otherwise the child node's name. Note that the match table is modified
168 * in place and an additional of_node reference is taken for each matched
171 * Returns the number of matches found or a negative error code on failure.
173 int of_regulator_match(struct device *dev, struct device_node *node,
174 struct of_regulator_match *matches,
175 unsigned int num_matches)
177 unsigned int count = 0;
180 struct device_node *child;
181 struct devm_of_regulator_matches *devm_matches;
186 devm_matches = devres_alloc(devm_of_regulator_put_matches,
187 sizeof(struct devm_of_regulator_matches),
192 devm_matches->matches = matches;
193 devm_matches->num_matches = num_matches;
195 devres_add(dev, devm_matches);
197 for (i = 0; i < num_matches; i++) {
198 struct of_regulator_match *match = &matches[i];
199 match->init_data = NULL;
200 match->of_node = NULL;
203 for_each_child_of_node(node, child) {
204 name = of_get_property(child,
205 "regulator-compatible", NULL);
208 for (i = 0; i < num_matches; i++) {
209 struct of_regulator_match *match = &matches[i];
213 if (strcmp(match->name, name))
217 of_get_regulator_init_data(dev, child);
218 if (!match->init_data) {
220 "failed to parse DT for regulator %s\n",
224 match->of_node = of_node_get(child);
232 EXPORT_SYMBOL_GPL(of_regulator_match);
234 struct regulator_init_data *regulator_of_get_init_data(struct device *dev,
235 const struct regulator_desc *desc,
236 struct device_node **node)
238 struct device_node *search, *child;
239 struct regulator_init_data *init_data = NULL;
242 if (!dev->of_node || !desc->of_match)
245 if (desc->regulators_node)
246 search = of_get_child_by_name(dev->of_node,
247 desc->regulators_node);
249 search = dev->of_node;
252 dev_err(dev, "Failed to find regulator container node\n");
256 for_each_child_of_node(search, child) {
257 name = of_get_property(child, "regulator-compatible", NULL);
261 if (strcmp(desc->of_match, name))
264 init_data = of_get_regulator_init_data(dev, child);
267 "failed to parse DT for regulator %s\n",