Commit | Line | Data |
---|---|---|
8f446e6f RN |
1 | /* |
2 | * OF helpers for regulator framework | |
3 | * | |
4 | * Copyright (C) 2011 Texas Instruments, Inc. | |
5 | * Rajendra Nayak <rnayak@ti.com> | |
6 | * | |
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. | |
11 | */ | |
12 | ||
e69af5e9 | 13 | #include <linux/module.h> |
8f446e6f RN |
14 | #include <linux/slab.h> |
15 | #include <linux/of.h> | |
16 | #include <linux/regulator/machine.h> | |
a0c7b164 | 17 | #include <linux/regulator/driver.h> |
1c8fa58f | 18 | #include <linux/regulator/of_regulator.h> |
8f446e6f | 19 | |
a0c7b164 MB |
20 | #include "internal.h" |
21 | ||
f32fa89c | 22 | static const char *const regulator_states[PM_SUSPEND_MAX + 1] = { |
40e20d68 CC |
23 | [PM_SUSPEND_MEM] = "regulator-state-mem", |
24 | [PM_SUSPEND_MAX] = "regulator-state-disk", | |
25 | }; | |
26 | ||
8f446e6f | 27 | static void of_get_regulation_constraints(struct device_node *np, |
5e5e3a42 JMC |
28 | struct regulator_init_data **init_data, |
29 | const struct regulator_desc *desc) | |
8f446e6f | 30 | { |
8f446e6f | 31 | struct regulation_constraints *constraints = &(*init_data)->constraints; |
40e20d68 CC |
32 | struct regulator_state *suspend_state; |
33 | struct device_node *suspend_np; | |
34 | int ret, i; | |
00c877c6 | 35 | u32 pval; |
8f446e6f RN |
36 | |
37 | constraints->name = of_get_property(np, "regulator-name", NULL); | |
38 | ||
a34785f1 LD |
39 | if (!of_property_read_u32(np, "regulator-min-microvolt", &pval)) |
40 | constraints->min_uV = pval; | |
41 | ||
42 | if (!of_property_read_u32(np, "regulator-max-microvolt", &pval)) | |
43 | constraints->max_uV = pval; | |
8f446e6f RN |
44 | |
45 | /* Voltage change possible? */ | |
45fa2038 | 46 | if (constraints->min_uV != constraints->max_uV) |
8f446e6f | 47 | constraints->valid_ops_mask |= REGULATOR_CHANGE_VOLTAGE; |
45fa2038 MB |
48 | |
49 | /* Do we have a voltage range, if so try to apply it? */ | |
50 | if (constraints->min_uV && constraints->max_uV) | |
ab62aa93 | 51 | constraints->apply_uV = true; |
8f446e6f | 52 | |
1e050eab SS |
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; | |
8f446e6f | 59 | |
36e4f839 SB |
60 | if (!of_property_read_u32(np, "regulator-input-current-limit-microamp", |
61 | &pval)) | |
62 | constraints->ilim_uA = pval; | |
63 | ||
8f446e6f RN |
64 | /* Current change possible? */ |
65 | if (constraints->min_uA != constraints->max_uA) | |
66 | constraints->valid_ops_mask |= REGULATOR_CHANGE_CURRENT; | |
67 | ||
1e050eab SS |
68 | constraints->boot_on = of_property_read_bool(np, "regulator-boot-on"); |
69 | constraints->always_on = of_property_read_bool(np, "regulator-always-on"); | |
70 | if (!constraints->always_on) /* status change should be possible. */ | |
8f446e6f | 71 | constraints->valid_ops_mask |= REGULATOR_CHANGE_STATUS; |
6f0b2c69 | 72 | |
23c779b9 SB |
73 | constraints->pull_down = of_property_read_bool(np, "regulator-pull-down"); |
74 | ||
93134c7b KVA |
75 | if (of_property_read_bool(np, "regulator-allow-bypass")) |
76 | constraints->valid_ops_mask |= REGULATOR_CHANGE_BYPASS; | |
77 | ||
b263d203 BA |
78 | if (of_property_read_bool(np, "regulator-allow-set-load")) |
79 | constraints->valid_ops_mask |= REGULATOR_CHANGE_DRMS; | |
80 | ||
1e050eab SS |
81 | ret = of_property_read_u32(np, "regulator-ramp-delay", &pval); |
82 | if (!ret) { | |
83 | if (pval) | |
84 | constraints->ramp_delay = pval; | |
1653ccf4 YSB |
85 | else |
86 | constraints->ramp_disable = true; | |
87 | } | |
00c877c6 | 88 | |
d6c1dc3f LD |
89 | ret = of_property_read_u32(np, "regulator-settling-time-us", &pval); |
90 | if (!ret) | |
91 | constraints->settling_time = pval; | |
92 | ||
00c877c6 LD |
93 | ret = of_property_read_u32(np, "regulator-enable-ramp-delay", &pval); |
94 | if (!ret) | |
95 | constraints->enable_time = pval; | |
40e20d68 | 96 | |
57f66b78 SB |
97 | constraints->soft_start = of_property_read_bool(np, |
98 | "regulator-soft-start"); | |
670666b9 LD |
99 | ret = of_property_read_u32(np, "regulator-active-discharge", &pval); |
100 | if (!ret) { | |
101 | constraints->active_discharge = | |
102 | (pval) ? REGULATOR_ACTIVE_DISCHARGE_ENABLE : | |
103 | REGULATOR_ACTIVE_DISCHARGE_DISABLE; | |
104 | } | |
57f66b78 | 105 | |
5e5e3a42 JMC |
106 | if (!of_property_read_u32(np, "regulator-initial-mode", &pval)) { |
107 | if (desc && desc->of_map_mode) { | |
108 | ret = desc->of_map_mode(pval); | |
109 | if (ret == -EINVAL) | |
110 | pr_err("%s: invalid mode %u\n", np->name, pval); | |
111 | else | |
112 | constraints->initial_mode = ret; | |
113 | } else { | |
114 | pr_warn("%s: mapping for mode %d not defined\n", | |
115 | np->name, pval); | |
116 | } | |
117 | } | |
118 | ||
22a10bca SB |
119 | if (!of_property_read_u32(np, "regulator-system-load", &pval)) |
120 | constraints->system_load = pval; | |
121 | ||
3a003bae SB |
122 | constraints->over_current_protection = of_property_read_bool(np, |
123 | "regulator-over-current-protection"); | |
124 | ||
40e20d68 CC |
125 | for (i = 0; i < ARRAY_SIZE(regulator_states); i++) { |
126 | switch (i) { | |
127 | case PM_SUSPEND_MEM: | |
128 | suspend_state = &constraints->state_mem; | |
129 | break; | |
130 | case PM_SUSPEND_MAX: | |
131 | suspend_state = &constraints->state_disk; | |
132 | break; | |
133 | case PM_SUSPEND_ON: | |
134 | case PM_SUSPEND_FREEZE: | |
135 | case PM_SUSPEND_STANDBY: | |
136 | default: | |
137 | continue; | |
7cf225b9 | 138 | } |
40e20d68 CC |
139 | |
140 | suspend_np = of_get_child_by_name(np, regulator_states[i]); | |
141 | if (!suspend_np || !suspend_state) | |
142 | continue; | |
143 | ||
5e5e3a42 JMC |
144 | if (!of_property_read_u32(suspend_np, "regulator-mode", |
145 | &pval)) { | |
146 | if (desc && desc->of_map_mode) { | |
147 | ret = desc->of_map_mode(pval); | |
148 | if (ret == -EINVAL) | |
149 | pr_err("%s: invalid mode %u\n", | |
150 | np->name, pval); | |
151 | else | |
152 | suspend_state->mode = ret; | |
153 | } else { | |
154 | pr_warn("%s: mapping for mode %d not defined\n", | |
155 | np->name, pval); | |
156 | } | |
157 | } | |
158 | ||
40e20d68 CC |
159 | if (of_property_read_bool(suspend_np, |
160 | "regulator-on-in-suspend")) | |
161 | suspend_state->enabled = true; | |
162 | else if (of_property_read_bool(suspend_np, | |
163 | "regulator-off-in-suspend")) | |
164 | suspend_state->disabled = true; | |
165 | ||
8cbcaea8 DA |
166 | if (!of_property_read_u32(suspend_np, |
167 | "regulator-suspend-microvolt", &pval)) | |
168 | suspend_state->uV = pval; | |
169 | ||
a0f78bc8 K |
170 | if (i == PM_SUSPEND_MEM) |
171 | constraints->initial_state = PM_SUSPEND_MEM; | |
172 | ||
4eafec83 | 173 | of_node_put(suspend_np); |
40e20d68 CC |
174 | suspend_state = NULL; |
175 | suspend_np = NULL; | |
176 | } | |
8f446e6f RN |
177 | } |
178 | ||
179 | /** | |
180 | * of_get_regulator_init_data - extract regulator_init_data structure info | |
181 | * @dev: device requesting for regulator_init_data | |
072e78b1 JMC |
182 | * @node: regulator device node |
183 | * @desc: regulator description | |
8f446e6f RN |
184 | * |
185 | * Populates regulator_init_data structure by extracting data from device | |
186 | * tree node, returns a pointer to the populated struture or NULL if memory | |
187 | * alloc fails. | |
188 | */ | |
d9a861cc | 189 | struct regulator_init_data *of_get_regulator_init_data(struct device *dev, |
072e78b1 JMC |
190 | struct device_node *node, |
191 | const struct regulator_desc *desc) | |
8f446e6f RN |
192 | { |
193 | struct regulator_init_data *init_data; | |
194 | ||
d9a861cc | 195 | if (!node) |
8f446e6f RN |
196 | return NULL; |
197 | ||
198 | init_data = devm_kzalloc(dev, sizeof(*init_data), GFP_KERNEL); | |
199 | if (!init_data) | |
200 | return NULL; /* Out of memory? */ | |
201 | ||
5e5e3a42 | 202 | of_get_regulation_constraints(node, &init_data, desc); |
8f446e6f RN |
203 | return init_data; |
204 | } | |
e69af5e9 | 205 | EXPORT_SYMBOL_GPL(of_get_regulator_init_data); |
1c8fa58f | 206 | |
13b3fde8 CK |
207 | struct devm_of_regulator_matches { |
208 | struct of_regulator_match *matches; | |
209 | unsigned int num_matches; | |
210 | }; | |
211 | ||
212 | static void devm_of_regulator_put_matches(struct device *dev, void *res) | |
213 | { | |
214 | struct devm_of_regulator_matches *devm_matches = res; | |
215 | int i; | |
216 | ||
217 | for (i = 0; i < devm_matches->num_matches; i++) | |
218 | of_node_put(devm_matches->matches[i].of_node); | |
219 | } | |
220 | ||
1c8fa58f | 221 | /** |
13511def | 222 | * of_regulator_match - extract multiple regulator init data from device tree. |
1c8fa58f TR |
223 | * @dev: device requesting the data |
224 | * @node: parent device node of the regulators | |
225 | * @matches: match table for the regulators | |
226 | * @num_matches: number of entries in match table | |
227 | * | |
13511def SW |
228 | * This function uses a match table specified by the regulator driver to |
229 | * parse regulator init data from the device tree. @node is expected to | |
230 | * contain a set of child nodes, each providing the init data for one | |
231 | * regulator. The data parsed from a child node will be matched to a regulator | |
232 | * based on either the deprecated property regulator-compatible if present, | |
233 | * or otherwise the child node's name. Note that the match table is modified | |
bd0dda74 CK |
234 | * in place and an additional of_node reference is taken for each matched |
235 | * regulator. | |
1c8fa58f TR |
236 | * |
237 | * Returns the number of matches found or a negative error code on failure. | |
238 | */ | |
239 | int of_regulator_match(struct device *dev, struct device_node *node, | |
240 | struct of_regulator_match *matches, | |
241 | unsigned int num_matches) | |
242 | { | |
243 | unsigned int count = 0; | |
244 | unsigned int i; | |
13511def | 245 | const char *name; |
5260cd2b | 246 | struct device_node *child; |
13b3fde8 | 247 | struct devm_of_regulator_matches *devm_matches; |
1c8fa58f TR |
248 | |
249 | if (!dev || !node) | |
250 | return -EINVAL; | |
251 | ||
13b3fde8 CK |
252 | devm_matches = devres_alloc(devm_of_regulator_put_matches, |
253 | sizeof(struct devm_of_regulator_matches), | |
254 | GFP_KERNEL); | |
255 | if (!devm_matches) | |
256 | return -ENOMEM; | |
257 | ||
258 | devm_matches->matches = matches; | |
259 | devm_matches->num_matches = num_matches; | |
260 | ||
261 | devres_add(dev, devm_matches); | |
262 | ||
a2f95c36 SW |
263 | for (i = 0; i < num_matches; i++) { |
264 | struct of_regulator_match *match = &matches[i]; | |
265 | match->init_data = NULL; | |
266 | match->of_node = NULL; | |
267 | } | |
268 | ||
5260cd2b | 269 | for_each_child_of_node(node, child) { |
13511def | 270 | name = of_get_property(child, |
5260cd2b | 271 | "regulator-compatible", NULL); |
13511def SW |
272 | if (!name) |
273 | name = child->name; | |
5260cd2b LD |
274 | for (i = 0; i < num_matches; i++) { |
275 | struct of_regulator_match *match = &matches[i]; | |
276 | if (match->of_node) | |
277 | continue; | |
278 | ||
13511def | 279 | if (strcmp(match->name, name)) |
5260cd2b LD |
280 | continue; |
281 | ||
282 | match->init_data = | |
75d6b2fa JMC |
283 | of_get_regulator_init_data(dev, child, |
284 | match->desc); | |
5260cd2b LD |
285 | if (!match->init_data) { |
286 | dev_err(dev, | |
287 | "failed to parse DT for regulator %s\n", | |
288 | child->name); | |
289 | return -EINVAL; | |
290 | } | |
bd0dda74 | 291 | match->of_node = of_node_get(child); |
5260cd2b LD |
292 | count++; |
293 | break; | |
1c8fa58f | 294 | } |
1c8fa58f TR |
295 | } |
296 | ||
297 | return count; | |
298 | } | |
299 | EXPORT_SYMBOL_GPL(of_regulator_match); | |
a0c7b164 MB |
300 | |
301 | struct regulator_init_data *regulator_of_get_init_data(struct device *dev, | |
302 | const struct regulator_desc *desc, | |
bfa21a0d | 303 | struct regulator_config *config, |
a0c7b164 MB |
304 | struct device_node **node) |
305 | { | |
306 | struct device_node *search, *child; | |
307 | struct regulator_init_data *init_data = NULL; | |
308 | const char *name; | |
309 | ||
310 | if (!dev->of_node || !desc->of_match) | |
311 | return NULL; | |
312 | ||
313 | if (desc->regulators_node) | |
314 | search = of_get_child_by_name(dev->of_node, | |
315 | desc->regulators_node); | |
316 | else | |
317 | search = dev->of_node; | |
318 | ||
319 | if (!search) { | |
7de79a1d MB |
320 | dev_dbg(dev, "Failed to find regulator container node '%s'\n", |
321 | desc->regulators_node); | |
a0c7b164 MB |
322 | return NULL; |
323 | } | |
324 | ||
130daa3f | 325 | for_each_available_child_of_node(search, child) { |
a0c7b164 MB |
326 | name = of_get_property(child, "regulator-compatible", NULL); |
327 | if (!name) | |
328 | name = child->name; | |
329 | ||
330 | if (strcmp(desc->of_match, name)) | |
331 | continue; | |
332 | ||
072e78b1 | 333 | init_data = of_get_regulator_init_data(dev, child, desc); |
a0c7b164 MB |
334 | if (!init_data) { |
335 | dev_err(dev, | |
336 | "failed to parse DT for regulator %s\n", | |
337 | child->name); | |
338 | break; | |
339 | } | |
340 | ||
bfa21a0d KK |
341 | if (desc->of_parse_cb) { |
342 | if (desc->of_parse_cb(child, desc, config)) { | |
343 | dev_err(dev, | |
344 | "driver callback failed to parse DT for regulator %s\n", | |
345 | child->name); | |
346 | init_data = NULL; | |
347 | break; | |
348 | } | |
349 | } | |
350 | ||
a0c7b164 MB |
351 | of_node_get(child); |
352 | *node = child; | |
353 | break; | |
354 | } | |
355 | ||
356 | of_node_put(search); | |
357 | ||
358 | return init_data; | |
359 | } |